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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301
  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. _defaultTypeReaders[type] = PrimitiveTypeReader.Create(type);
  53. var entityTypeReaders = ImmutableList.CreateBuilder<Tuple<Type, Type>>();
  54. entityTypeReaders.Add(new Tuple<Type, Type>(typeof(IMessage), typeof(MessageTypeReader<>)));
  55. entityTypeReaders.Add(new Tuple<Type, Type>(typeof(IChannel), typeof(ChannelTypeReader<>)));
  56. entityTypeReaders.Add(new Tuple<Type, Type>(typeof(IRole), typeof(RoleTypeReader<>)));
  57. entityTypeReaders.Add(new Tuple<Type, Type>(typeof(IUser), typeof(UserTypeReader<>)));
  58. _entityTypeReaders = entityTypeReaders.ToImmutable();
  59. }
  60. //Modules
  61. public async Task<ModuleInfo> CreateModuleAsync(string primaryAlias, Action<ModuleBuilder> buildFunc)
  62. {
  63. await _moduleLock.WaitAsync().ConfigureAwait(false);
  64. try
  65. {
  66. var builder = new ModuleBuilder(this, null, primaryAlias);
  67. buildFunc(builder);
  68. var module = builder.Build(this);
  69. return LoadModuleInternal(module);
  70. }
  71. finally
  72. {
  73. _moduleLock.Release();
  74. }
  75. }
  76. public Task<ModuleInfo> AddModuleAsync<T>() => AddModuleAsync(typeof(T));
  77. public async Task<ModuleInfo> AddModuleAsync(Type type)
  78. {
  79. await _moduleLock.WaitAsync().ConfigureAwait(false);
  80. try
  81. {
  82. var typeInfo = type.GetTypeInfo();
  83. if (_typedModuleDefs.ContainsKey(type))
  84. throw new ArgumentException($"This module has already been added.");
  85. var module = (await ModuleClassBuilder.BuildAsync(this, typeInfo).ConfigureAwait(false)).FirstOrDefault();
  86. if (module.Value == default(ModuleInfo))
  87. throw new InvalidOperationException($"Could not build the module {type.FullName}, did you pass an invalid type?");
  88. _typedModuleDefs[module.Key] = module.Value;
  89. return LoadModuleInternal(module.Value);
  90. }
  91. finally
  92. {
  93. _moduleLock.Release();
  94. }
  95. }
  96. public async Task<IEnumerable<ModuleInfo>> AddModulesAsync(Assembly assembly)
  97. {
  98. await _moduleLock.WaitAsync().ConfigureAwait(false);
  99. try
  100. {
  101. var types = await ModuleClassBuilder.SearchAsync(assembly, this).ConfigureAwait(false);
  102. var moduleDefs = await ModuleClassBuilder.BuildAsync(types, this).ConfigureAwait(false);
  103. foreach (var info in moduleDefs)
  104. {
  105. _typedModuleDefs[info.Key] = info.Value;
  106. LoadModuleInternal(info.Value);
  107. }
  108. return moduleDefs.Select(x => x.Value).ToImmutableArray();
  109. }
  110. finally
  111. {
  112. _moduleLock.Release();
  113. }
  114. }
  115. private ModuleInfo LoadModuleInternal(ModuleInfo module)
  116. {
  117. _moduleDefs.Add(module);
  118. foreach (var command in module.Commands)
  119. _map.AddCommand(command);
  120. foreach (var submodule in module.Submodules)
  121. LoadModuleInternal(submodule);
  122. return module;
  123. }
  124. public async Task<bool> RemoveModuleAsync(ModuleInfo module)
  125. {
  126. await _moduleLock.WaitAsync().ConfigureAwait(false);
  127. try
  128. {
  129. return RemoveModuleInternal(module);
  130. }
  131. finally
  132. {
  133. _moduleLock.Release();
  134. }
  135. }
  136. public Task<bool> RemoveModuleAsync<T>() => RemoveModuleAsync(typeof(T));
  137. public async Task<bool> RemoveModuleAsync(Type type)
  138. {
  139. await _moduleLock.WaitAsync().ConfigureAwait(false);
  140. try
  141. {
  142. if (!_typedModuleDefs.TryRemove(type, out var module))
  143. return false;
  144. return RemoveModuleInternal(module);
  145. }
  146. finally
  147. {
  148. _moduleLock.Release();
  149. }
  150. }
  151. private bool RemoveModuleInternal(ModuleInfo module)
  152. {
  153. if (!_moduleDefs.Remove(module))
  154. return false;
  155. foreach (var cmd in module.Commands)
  156. _map.RemoveCommand(cmd);
  157. foreach (var submodule in module.Submodules)
  158. {
  159. RemoveModuleInternal(submodule);
  160. }
  161. return true;
  162. }
  163. //Type Readers
  164. public void AddTypeReader<T>(TypeReader reader)
  165. {
  166. var readers = _typeReaders.GetOrAdd(typeof(T), x => new ConcurrentDictionary<Type, TypeReader>());
  167. readers[reader.GetType()] = reader;
  168. }
  169. public void AddTypeReader(Type type, TypeReader reader)
  170. {
  171. var readers = _typeReaders.GetOrAdd(type, x=> new ConcurrentDictionary<Type, TypeReader>());
  172. readers[reader.GetType()] = reader;
  173. }
  174. internal IDictionary<Type, TypeReader> GetTypeReaders(Type type)
  175. {
  176. if (_typeReaders.TryGetValue(type, out var definedTypeReaders))
  177. return definedTypeReaders;
  178. return null;
  179. }
  180. internal TypeReader GetDefaultTypeReader(Type type)
  181. {
  182. if (_defaultTypeReaders.TryGetValue(type, out var reader))
  183. return reader;
  184. var typeInfo = type.GetTypeInfo();
  185. //Is this an enum?
  186. if (typeInfo.IsEnum)
  187. {
  188. reader = EnumTypeReader.GetReader(type);
  189. _defaultTypeReaders[type] = reader;
  190. return reader;
  191. }
  192. //Is this an entity?
  193. for (int i = 0; i < _entityTypeReaders.Count; i++)
  194. {
  195. if (type == _entityTypeReaders[i].Item1 || typeInfo.ImplementedInterfaces.Contains(_entityTypeReaders[i].Item1))
  196. {
  197. reader = Activator.CreateInstance(_entityTypeReaders[i].Item2.MakeGenericType(type)) as TypeReader;
  198. _defaultTypeReaders[type] = reader;
  199. return reader;
  200. }
  201. }
  202. return null;
  203. }
  204. //Execution
  205. public SearchResult Search(ICommandContext context, int argPos)
  206. => Search(context, context.Message.Content.Substring(argPos));
  207. public SearchResult Search(ICommandContext context, string input)
  208. {
  209. string searchInput = _caseSensitive ? input : input.ToLowerInvariant();
  210. var matches = _map.GetCommands(searchInput).OrderByDescending(x => x.Command.Priority).ToImmutableArray();
  211. if (matches.Length > 0)
  212. return SearchResult.FromSuccess(input, matches);
  213. else
  214. return SearchResult.FromError(CommandError.UnknownCommand, "Unknown command.");
  215. }
  216. public Task<IResult> ExecuteAsync(ICommandContext context, int argPos, IServiceProvider services = null, MultiMatchHandling multiMatchHandling = MultiMatchHandling.Exception)
  217. => ExecuteAsync(context, context.Message.Content.Substring(argPos), services, multiMatchHandling);
  218. public async Task<IResult> ExecuteAsync(ICommandContext context, string input, IServiceProvider services = null, MultiMatchHandling multiMatchHandling = MultiMatchHandling.Exception)
  219. {
  220. services = services ?? EmptyServiceProvider.Instance;
  221. var searchResult = Search(context, input);
  222. if (!searchResult.IsSuccess)
  223. return searchResult;
  224. var commands = searchResult.Commands;
  225. for (int i = 0; i < commands.Count; i++)
  226. {
  227. var preconditionResult = await commands[i].CheckPreconditionsAsync(context, services).ConfigureAwait(false);
  228. if (!preconditionResult.IsSuccess)
  229. {
  230. if (commands.Count == 1)
  231. return preconditionResult;
  232. else
  233. continue;
  234. }
  235. var parseResult = await commands[i].ParseAsync(context, searchResult, preconditionResult).ConfigureAwait(false);
  236. if (!parseResult.IsSuccess)
  237. {
  238. if (parseResult.Error == CommandError.MultipleMatches)
  239. {
  240. IReadOnlyList<TypeReaderValue> argList, paramList;
  241. switch (multiMatchHandling)
  242. {
  243. case MultiMatchHandling.Best:
  244. argList = parseResult.ArgValues.Select(x => x.Values.OrderByDescending(y => y.Score).First()).ToImmutableArray();
  245. paramList = parseResult.ParamValues.Select(x => x.Values.OrderByDescending(y => y.Score).First()).ToImmutableArray();
  246. parseResult = ParseResult.FromSuccess(argList, paramList);
  247. break;
  248. }
  249. }
  250. if (!parseResult.IsSuccess)
  251. {
  252. if (commands.Count == 1)
  253. return parseResult;
  254. else
  255. continue;
  256. }
  257. }
  258. return await commands[i].ExecuteAsync(context, parseResult, services).ConfigureAwait(false);
  259. }
  260. return SearchResult.FromError(CommandError.UnknownCommand, "This input does not match any overload.");
  261. }
  262. }
  263. }