You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

CommandService.cs 13 kB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308
  1. using Discord.Commands.Builders;
  2. using Discord.Logging;
  3. using System;
  4. using System.Collections.Concurrent;
  5. using System.Collections.Generic;
  6. using System.Collections.Immutable;
  7. using System.Linq;
  8. using System.Reflection;
  9. using System.Threading;
  10. using System.Threading.Tasks;
  11. using Microsoft.Extensions.DependencyInjection;
  12. namespace Discord.Commands
  13. {
  14. public class CommandService
  15. {
  16. public event Func<LogMessage, Task> Log { add { _logEvent.Add(value); } remove { _logEvent.Remove(value); } }
  17. internal readonly AsyncEvent<Func<LogMessage, Task>> _logEvent = new AsyncEvent<Func<LogMessage, Task>>();
  18. private readonly SemaphoreSlim _moduleLock;
  19. private readonly ConcurrentDictionary<Type, ModuleInfo> _typedModuleDefs;
  20. private readonly ConcurrentDictionary<Type, ConcurrentDictionary<Type, TypeReader>> _typeReaders;
  21. private readonly ConcurrentDictionary<Type, TypeReader> _defaultTypeReaders;
  22. private readonly ImmutableList<Tuple<Type, Type>> _entityTypeReaders; //TODO: Candidate for C#7 Tuple
  23. private readonly HashSet<ModuleInfo> _moduleDefs;
  24. private readonly CommandMap _map;
  25. internal readonly bool _caseSensitive, _throwOnError;
  26. internal readonly char _separatorChar;
  27. internal readonly RunMode _defaultRunMode;
  28. internal readonly Logger _cmdLogger;
  29. internal readonly LogManager _logManager;
  30. public IEnumerable<ModuleInfo> Modules => _moduleDefs.Select(x => x);
  31. public IEnumerable<CommandInfo> Commands => _moduleDefs.SelectMany(x => x.Commands);
  32. public ILookup<Type, TypeReader> TypeReaders => _typeReaders.SelectMany(x => x.Value.Select(y => new {y.Key, y.Value})).ToLookup(x => x.Key, x => x.Value);
  33. public CommandService() : this(new CommandServiceConfig()) { }
  34. public CommandService(CommandServiceConfig config)
  35. {
  36. _caseSensitive = config.CaseSensitiveCommands;
  37. _throwOnError = config.ThrowOnError;
  38. _separatorChar = config.SeparatorChar;
  39. _defaultRunMode = config.DefaultRunMode;
  40. if (_defaultRunMode == RunMode.Default)
  41. throw new InvalidOperationException("The default run mode cannot be set to Default.");
  42. _logManager = new LogManager(config.LogLevel);
  43. _logManager.Message += async msg => await _logEvent.InvokeAsync(msg).ConfigureAwait(false);
  44. _cmdLogger = _logManager.CreateLogger("Command");
  45. _moduleLock = new SemaphoreSlim(1, 1);
  46. _typedModuleDefs = new ConcurrentDictionary<Type, ModuleInfo>();
  47. _moduleDefs = new HashSet<ModuleInfo>();
  48. _map = new CommandMap(this);
  49. _typeReaders = new ConcurrentDictionary<Type, ConcurrentDictionary<Type, TypeReader>>();
  50. _defaultTypeReaders = new ConcurrentDictionary<Type, TypeReader>();
  51. foreach (var type in PrimitiveParsers.SupportedTypes)
  52. {
  53. _defaultTypeReaders[type] = PrimitiveTypeReader.Create(type);
  54. if (type.GetTypeInfo().IsValueType)
  55. _defaultTypeReaders[typeof(Nullable<>).MakeGenericType(type)] = NullableTypeReader.Create(type);
  56. }
  57. var entityTypeReaders = ImmutableList.CreateBuilder<Tuple<Type, Type>>();
  58. entityTypeReaders.Add(new Tuple<Type, Type>(typeof(IMessage), typeof(MessageTypeReader<>)));
  59. entityTypeReaders.Add(new Tuple<Type, Type>(typeof(IChannel), typeof(ChannelTypeReader<>)));
  60. entityTypeReaders.Add(new Tuple<Type, Type>(typeof(IRole), typeof(RoleTypeReader<>)));
  61. entityTypeReaders.Add(new Tuple<Type, Type>(typeof(IUser), typeof(UserTypeReader<>)));
  62. _entityTypeReaders = entityTypeReaders.ToImmutable();
  63. }
  64. //Modules
  65. public async Task<ModuleInfo> CreateModuleAsync(string primaryAlias, Action<ModuleBuilder> buildFunc)
  66. {
  67. await _moduleLock.WaitAsync().ConfigureAwait(false);
  68. try
  69. {
  70. var builder = new ModuleBuilder(this, null, primaryAlias);
  71. buildFunc(builder);
  72. var module = builder.Build(this);
  73. return LoadModuleInternal(module);
  74. }
  75. finally
  76. {
  77. _moduleLock.Release();
  78. }
  79. }
  80. public Task<ModuleInfo> AddModuleAsync<T>() => AddModuleAsync(typeof(T));
  81. public async Task<ModuleInfo> AddModuleAsync(Type type)
  82. {
  83. await _moduleLock.WaitAsync().ConfigureAwait(false);
  84. try
  85. {
  86. var typeInfo = type.GetTypeInfo();
  87. if (_typedModuleDefs.ContainsKey(type))
  88. throw new ArgumentException($"This module has already been added.");
  89. var module = ModuleClassBuilder.Build(this, typeInfo).FirstOrDefault();
  90. if (module.Value == default(ModuleInfo))
  91. throw new InvalidOperationException($"Could not build the module {type.FullName}, did you pass an invalid type?");
  92. _typedModuleDefs[module.Key] = module.Value;
  93. return LoadModuleInternal(module.Value);
  94. }
  95. finally
  96. {
  97. _moduleLock.Release();
  98. }
  99. }
  100. public async Task<IEnumerable<ModuleInfo>> AddModulesAsync(Assembly assembly)
  101. {
  102. await _moduleLock.WaitAsync().ConfigureAwait(false);
  103. try
  104. {
  105. var types = ModuleClassBuilder.Search(assembly).ToArray();
  106. var moduleDefs = ModuleClassBuilder.Build(types, this);
  107. foreach (var info in moduleDefs)
  108. {
  109. _typedModuleDefs[info.Key] = info.Value;
  110. LoadModuleInternal(info.Value);
  111. }
  112. return moduleDefs.Select(x => x.Value).ToImmutableArray();
  113. }
  114. finally
  115. {
  116. _moduleLock.Release();
  117. }
  118. }
  119. private ModuleInfo LoadModuleInternal(ModuleInfo module)
  120. {
  121. _moduleDefs.Add(module);
  122. foreach (var command in module.Commands)
  123. _map.AddCommand(command);
  124. foreach (var submodule in module.Submodules)
  125. LoadModuleInternal(submodule);
  126. return module;
  127. }
  128. public async Task<bool> RemoveModuleAsync(ModuleInfo module)
  129. {
  130. await _moduleLock.WaitAsync().ConfigureAwait(false);
  131. try
  132. {
  133. return RemoveModuleInternal(module);
  134. }
  135. finally
  136. {
  137. _moduleLock.Release();
  138. }
  139. }
  140. public Task<bool> RemoveModuleAsync<T>() => RemoveModuleAsync(typeof(T));
  141. public async Task<bool> RemoveModuleAsync(Type type)
  142. {
  143. await _moduleLock.WaitAsync().ConfigureAwait(false);
  144. try
  145. {
  146. ModuleInfo module;
  147. if (!_typedModuleDefs.TryRemove(type, out module))
  148. return false;
  149. return RemoveModuleInternal(module);
  150. }
  151. finally
  152. {
  153. _moduleLock.Release();
  154. }
  155. }
  156. private bool RemoveModuleInternal(ModuleInfo module)
  157. {
  158. if (!_moduleDefs.Remove(module))
  159. return false;
  160. foreach (var cmd in module.Commands)
  161. _map.RemoveCommand(cmd);
  162. foreach (var submodule in module.Submodules)
  163. {
  164. RemoveModuleInternal(submodule);
  165. }
  166. return true;
  167. }
  168. //Type Readers
  169. public void AddTypeReader<T>(TypeReader reader)
  170. {
  171. var readers = _typeReaders.GetOrAdd(typeof(T), x => new ConcurrentDictionary<Type, TypeReader>());
  172. readers[reader.GetType()] = reader;
  173. }
  174. public void AddTypeReader(Type type, TypeReader reader)
  175. {
  176. var readers = _typeReaders.GetOrAdd(type, x=> new ConcurrentDictionary<Type, TypeReader>());
  177. readers[reader.GetType()] = reader;
  178. }
  179. internal IDictionary<Type, TypeReader> GetTypeReaders(Type type)
  180. {
  181. ConcurrentDictionary<Type, TypeReader> definedTypeReaders;
  182. if (_typeReaders.TryGetValue(type, out definedTypeReaders))
  183. return definedTypeReaders;
  184. return null;
  185. }
  186. internal TypeReader GetDefaultTypeReader(Type type)
  187. {
  188. TypeReader reader;
  189. if (_defaultTypeReaders.TryGetValue(type, out reader))
  190. return reader;
  191. var typeInfo = type.GetTypeInfo();
  192. //Is this an enum?
  193. if (typeInfo.IsEnum)
  194. {
  195. reader = EnumTypeReader.GetReader(type);
  196. _defaultTypeReaders[type] = reader;
  197. return reader;
  198. }
  199. //Is this an entity?
  200. for (int i = 0; i < _entityTypeReaders.Count; i++)
  201. {
  202. if (type == _entityTypeReaders[i].Item1 || typeInfo.ImplementedInterfaces.Contains(_entityTypeReaders[i].Item1))
  203. {
  204. reader = Activator.CreateInstance(_entityTypeReaders[i].Item2.MakeGenericType(type)) as TypeReader;
  205. _defaultTypeReaders[type] = reader;
  206. return reader;
  207. }
  208. }
  209. return null;
  210. }
  211. //Execution
  212. public SearchResult Search(ICommandContext context, int argPos)
  213. => Search(context, context.Message.Content.Substring(argPos));
  214. public SearchResult Search(ICommandContext context, string input)
  215. {
  216. string searchInput = _caseSensitive ? input : input.ToLowerInvariant();
  217. var matches = _map.GetCommands(searchInput).OrderByDescending(x => x.Command.Priority).ToImmutableArray();
  218. if (matches.Length > 0)
  219. return SearchResult.FromSuccess(input, matches);
  220. else
  221. return SearchResult.FromError(CommandError.UnknownCommand, "Unknown command.");
  222. }
  223. public Task<IResult> ExecuteAsync(ICommandContext context, int argPos, IServiceProvider services = null, MultiMatchHandling multiMatchHandling = MultiMatchHandling.Exception)
  224. => ExecuteAsync(context, context.Message.Content.Substring(argPos), services, multiMatchHandling);
  225. public async Task<IResult> ExecuteAsync(ICommandContext context, string input, IServiceProvider services = null, MultiMatchHandling multiMatchHandling = MultiMatchHandling.Exception)
  226. {
  227. services = services ?? EmptyServiceProvider.Instance;
  228. var searchResult = Search(context, input);
  229. if (!searchResult.IsSuccess)
  230. return searchResult;
  231. var commands = searchResult.Commands;
  232. for (int i = 0; i < commands.Count; i++)
  233. {
  234. var preconditionResult = await commands[i].CheckPreconditionsAsync(context, services).ConfigureAwait(false);
  235. if (!preconditionResult.IsSuccess)
  236. {
  237. if (commands.Count == 1)
  238. return preconditionResult;
  239. else
  240. continue;
  241. }
  242. var parseResult = await commands[i].ParseAsync(context, searchResult, preconditionResult).ConfigureAwait(false);
  243. if (!parseResult.IsSuccess)
  244. {
  245. if (parseResult.Error == CommandError.MultipleMatches)
  246. {
  247. IReadOnlyList<TypeReaderValue> argList, paramList;
  248. switch (multiMatchHandling)
  249. {
  250. case MultiMatchHandling.Best:
  251. argList = parseResult.ArgValues.Select(x => x.Values.OrderByDescending(y => y.Score).First()).ToImmutableArray();
  252. paramList = parseResult.ParamValues.Select(x => x.Values.OrderByDescending(y => y.Score).First()).ToImmutableArray();
  253. parseResult = ParseResult.FromSuccess(argList, paramList);
  254. break;
  255. }
  256. }
  257. if (!parseResult.IsSuccess)
  258. {
  259. if (commands.Count == 1)
  260. return parseResult;
  261. else
  262. continue;
  263. }
  264. }
  265. return await commands[i].ExecuteAsync(context, parseResult, services).ConfigureAwait(false);
  266. }
  267. return SearchResult.FromError(CommandError.UnknownCommand, "This input does not match any overload.");
  268. }
  269. }
  270. }