├── .gitignore ├── Kagami.Test ├── Kagami.Test.csproj ├── TestCommands.cs └── TestReplRuntime.cs ├── Kagami.sln ├── Kagami ├── Command.cs ├── Kagami.csproj ├── Program.cs ├── SandBox │ ├── ReplEnvironment.cs │ └── ReplRuntime.cs └── Utils │ ├── Build.cs │ └── Util.cs ├── LICENSE ├── README.md └── ScriptExample ├── chess.cs ├── hello.cs └── ic.cs /.gitignore: -------------------------------------------------------------------------------- 1 | .vs/ 2 | .idea/ 3 | bin/ 4 | obj/ 5 | *.user 6 | -------------------------------------------------------------------------------- /Kagami.Test/Kagami.Test.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | net7.0 5 | enable 6 | false 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | all 15 | runtime; build; native; contentfiles; analyzers; buildtransitive 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /Kagami.Test/TestCommands.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Threading.Tasks; 3 | using NUnit.Framework; 4 | using Konata.Core.Message.Model; 5 | 6 | namespace Kagami.Test; 7 | 8 | public class Tests 9 | { 10 | [SetUp] 11 | public void Setup() 12 | { 13 | } 14 | 15 | [Test] 16 | public async Task OnCommandGithubParser() 17 | { 18 | var textChain = TextChain.Create 19 | ("https://github.com/KonataDev/Kagami"); 20 | { 21 | // Get result 22 | var result = await Command 23 | .OnCommandGithubParser(textChain); 24 | 25 | Console.WriteLine(result.Build()); 26 | } 27 | Assert.Pass(); 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /Kagami.Test/TestReplRuntime.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Threading; 3 | using System.Threading.Tasks; 4 | using Kagami.SandBox; 5 | using NUnit.Framework; 6 | 7 | namespace Kagami.Test; 8 | 9 | public class TestReplRuntime 10 | { 11 | private static ReplRuntime? _repl; 12 | private const string StringExploitOk = "ExploitOK"; 13 | private const string StringProtected = "Protected"; 14 | 15 | [SetUp] 16 | public void Setup() 17 | { 18 | _repl = new ReplRuntime( 19 | // Additional references 20 | new[] 21 | { 22 | "System.Diagnostics", 23 | "Konata.Core", 24 | "Paraparty.JsonChan" 25 | }, 26 | 27 | // Additional usings 28 | new[] 29 | { 30 | "System.Runtime", 31 | "System.Threading", 32 | "System.Threading.Tasks", 33 | "Konata.Core", 34 | "Konata.Core.Common", 35 | "Konata.Core.Interfaces", 36 | "Konata.Core.Interfaces.Api", 37 | "Konata.Core.Events", 38 | "Konata.Core.Events.Model", 39 | "Konata.Core.Message", 40 | "Konata.Core.Message.Model", 41 | "Paraparty.JsonChan" 42 | }, 43 | 44 | // Initial script 45 | null, 46 | 47 | // Enable checks 48 | true, 49 | 50 | // Execution timeout 51 | 5000 52 | ); 53 | } 54 | 55 | private static async Task RunAsync(string code, Action? cb = null) 56 | { 57 | var result = await _repl!.RunAsync(code, cb); 58 | if (result == null) return null; 59 | return result.ToString(); 60 | } 61 | 62 | private static async Task RunAsyncAsObject(string code, Action? cb = null) 63 | { 64 | var result = await _repl!.RunAsync(code, cb); 65 | if (result == null) return null; 66 | return result; 67 | } 68 | 69 | [Test(ExpectedResult = "Hello World!")] 70 | public async Task HelloWorld() 71 | => await RunAsync("\"Hello World!\"") ?? string.Empty; 72 | 73 | [Test] 74 | public void CreateBot() 75 | { 76 | var result = RunAsync("BotFather.Create(\"233\",\"testtest\", out _, out _, out _) != null").Result; 77 | Assert.AreEqual("True", result); 78 | } 79 | 80 | [Test] 81 | public void RunInMultiThreaded() 82 | { 83 | async Task Run(uint number) 84 | { 85 | var result = await RunAsyncAsObject("CurrentMember", 86 | env => { env.CurrentMember = number; }) as uint? ?? 0; 87 | return result == number; 88 | } 89 | 90 | for (var i = 0U; i < 20; ++i) 91 | { 92 | var i1 = i; 93 | new Thread(() => 94 | { 95 | if (!Run(i1).Result) throw new Exception("Not equal"); 96 | }).Start(); 97 | } 98 | 99 | Assert.Pass(); 100 | } 101 | 102 | [Test(ExpectedResult = StringProtected)] 103 | public async Task ExpProcessStart() 104 | => await RunAsync($"System.Diagnostics.Process.Start(\"calc.exe\"); " + 105 | $"return \"{StringExploitOk}\";") ?? StringProtected; 106 | 107 | [Test] 108 | public void ExpUsingRenameProcessStart() 109 | { 110 | RunAsync("using Diag = System.Diagnostics;").Wait(); 111 | var result = RunAsync("Diag.Process.Start(\"calc.exe\"); " + 112 | "return \"Exploit OK\";").Result ?? StringProtected; 113 | Assert.AreEqual(StringProtected, result); 114 | } 115 | 116 | [Test] 117 | public void ExpThreadDomainPayloadRce() 118 | { 119 | RunAsync("using s = System;").Wait(); 120 | RunAsync("var domain = Thread.GetDomain();").Wait(); 121 | RunAsync("var payload = domain.Load(typeof(s.Activator).Assembly.Location);").Wait(); 122 | var result = RunAsync($"return payload == null ? \"{StringExploitOk}\" : \"{StringExploitOk}\";").Result ?? StringProtected; 123 | Assert.AreEqual(StringProtected, result); 124 | } 125 | 126 | [Test] 127 | public void ExpLoadDll() 128 | { 129 | RunAsync("using System.Runtime.InteropServices;").Wait(); 130 | RunAsync("[DllImport(\"kernel32.dll\", CharSet = CharSet.Auto, SetLastError = true)]\n" + 131 | "static extern IntPtr LoadLibraryA(string libname);").Wait(); 132 | RunAsync("var payload = LoadLibraryA(\"{kernel32.dll}\");").Wait(); 133 | var result = RunAsync($"return payload != null ? \"{StringExploitOk}\" : \"{StringExploitOk}\";").Result ?? StringProtected; 134 | Assert.AreEqual(StringProtected, result); 135 | } 136 | 137 | [Test] 138 | public void ExpGetType() 139 | { 140 | var result = RunAsync("var s = 1.GetType().FullName;" 141 | + $"return \"{StringExploitOk}\";").Result ?? StringProtected; 142 | Assert.AreEqual(StringProtected, result); 143 | } 144 | 145 | [Test] 146 | public void ExpThreadBasedLongLoop() 147 | { 148 | RunAsync("Thread.Sleep(int.MaxValue);").Wait(); 149 | RunAsync("Thread.SpinWait(int.MaxValue);").Wait(); 150 | Assert.Pass(); 151 | } 152 | 153 | [Test] 154 | public void ExpSimpleDeadLoop() 155 | { 156 | // Too many deadloop tricks, woaaaa... 157 | RunAsync("while(true);").Wait(); 158 | RunAsync("while(!false);").Wait(); 159 | RunAsync("var a = 1; while(a == 1);").Wait(); 160 | RunAsync("for(;;);").Wait(); 161 | RunAsync("for(var i = 0; i <= 0; --i);").Wait(); 162 | RunAsync("for(var i = 0; i >= 0; ++i);").Wait(); 163 | RunAsync("for(;true;);").Wait(); 164 | RunAsync("for(;!false;);").Wait(); 165 | RunAsync("Here: goto Here;").Wait(); 166 | Assert.Pass(); 167 | } 168 | 169 | [Test] 170 | public void NormalCodeAfterDeadLoop() 171 | { 172 | try 173 | { 174 | RunAsync("while (true);").Wait(); 175 | Assert.AreEqual("2", RunAsync("1 + 1").Result); 176 | } 177 | 178 | catch (Exception e) 179 | { 180 | // ignore exception 181 | } 182 | } 183 | 184 | [Test] 185 | public void AssertPass() 186 | { 187 | if (_repl != null) Assert.Pass(); 188 | Assert.Fail(); 189 | } 190 | } 191 | -------------------------------------------------------------------------------- /Kagami.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 16 4 | VisualStudioVersion = 16.0.31410.357 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kagami", "Kagami/Kagami.csproj", "{B10F8933-2FDC-4CAE-9A14-E503DACBB029}" 7 | EndProject 8 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kagami.Test", "Kagami.Test/Kagami.Test.csproj", "{737693C2-CF77-4E1E-8996-83D7F3771E37}" 9 | EndProject 10 | Global 11 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 12 | Debug|Any CPU = Debug|Any CPU 13 | Release|Any CPU = Release|Any CPU 14 | EndGlobalSection 15 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 16 | {B10F8933-2FDC-4CAE-9A14-E503DACBB029}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 17 | {B10F8933-2FDC-4CAE-9A14-E503DACBB029}.Debug|Any CPU.Build.0 = Debug|Any CPU 18 | {B10F8933-2FDC-4CAE-9A14-E503DACBB029}.Release|Any CPU.ActiveCfg = Release|Any CPU 19 | {B10F8933-2FDC-4CAE-9A14-E503DACBB029}.Release|Any CPU.Build.0 = Release|Any CPU 20 | {737693C2-CF77-4E1E-8996-83D7F3771E37}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 21 | {737693C2-CF77-4E1E-8996-83D7F3771E37}.Debug|Any CPU.Build.0 = Debug|Any CPU 22 | {737693C2-CF77-4E1E-8996-83D7F3771E37}.Release|Any CPU.ActiveCfg = Release|Any CPU 23 | {737693C2-CF77-4E1E-8996-83D7F3771E37}.Release|Any CPU.Build.0 = Release|Any CPU 24 | EndGlobalSection 25 | GlobalSection(SolutionProperties) = preSolution 26 | HideSolutionNode = FALSE 27 | EndGlobalSection 28 | GlobalSection(ExtensibilityGlobals) = postSolution 29 | SolutionGuid = {76C5EF2C-6AA1-4009-A2BF-16E19DA2E537} 30 | EndGlobalSection 31 | EndGlobal 32 | -------------------------------------------------------------------------------- /Kagami/Command.cs: -------------------------------------------------------------------------------- 1 | using Kagami.Utils; 2 | using Konata.Core.Message; 3 | using Konata.Core.Message.Model; 4 | using System; 5 | using System.Diagnostics; 6 | using System.Text; 7 | using System.Threading.Tasks; 8 | 9 | // ReSharper disable MemberCanBePrivate.Global 10 | // ReSharper disable UnusedParameter.Local 11 | 12 | namespace Kagami; 13 | 14 | public static class Command 15 | { 16 | 17 | /// 18 | /// On status 19 | /// 20 | /// 21 | public static MessageBuilder OnCommandStatus() 22 | => new MessageBuilder() 23 | // Core descriptions 24 | .Text($"[Kagami]\n") 25 | .Text($"[branch:{BuildStamp.Branch}]\n") 26 | .Text($"[commit:{BuildStamp.CommitHash[..12]}]\n") 27 | .Text($"[version:{BuildStamp.Version}]\n") 28 | .Text($"[{BuildStamp.BuildTime}]\n\n") 29 | 30 | // System status 31 | .Text($"GC Memory {GC.GetTotalAllocatedBytes().Bytes2MiB(2)} MiB \n") 32 | .Text($"Total Memory {Process.GetCurrentProcess().WorkingSet64.Bytes2MiB(2)} MiB\n\n") 33 | 34 | // Copyrights 35 | .Text($"Konata Project (C) {DateTime.Now.Year}"); 36 | 37 | /// 38 | /// Github repo parser 39 | /// 40 | /// 41 | /// 42 | public static async Task OnCommandGithubParser(TextChain chain) 43 | { 44 | // UrlDownload the page 45 | try 46 | { 47 | var bytes = await $"{chain.Content.TrimEnd('/')}.git".UrlDownload(); 48 | 49 | var html = Encoding.UTF8.GetString(bytes); 50 | 51 | // Get meta data 52 | var metaData = html.GetMetaData("property"); 53 | var imageMeta = metaData["og:image"]; 54 | 55 | // Build message 56 | var image = await imageMeta.UrlDownload(); 57 | return new MessageBuilder().Image(image); 58 | } 59 | catch (Exception e) 60 | { 61 | Console.WriteLine($"Not a repository link. \n" + 62 | $"{e.Message}"); 63 | return Text("Not a repository link."); 64 | } 65 | } 66 | 67 | private static MessageBuilder Text(string text) 68 | => new MessageBuilder().Text(text); 69 | } -------------------------------------------------------------------------------- /Kagami/Kagami.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Exe 5 | net7.0 6 | latest 7 | enable 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | .gitignore 20 | 21 | 22 | LICENSE 23 | 24 | 25 | README.md 26 | 27 | 28 | 29 | 30 | -------------------------------------------------------------------------------- /Kagami/Program.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.IO; 3 | using System.Runtime.CompilerServices; 4 | using System.Text.Json; 5 | using System.Text.RegularExpressions; 6 | using System.Threading.Tasks; 7 | using Konata.Core; 8 | using Konata.Core.Common; 9 | using Konata.Core.Events.Model; 10 | using Konata.Core.Interfaces; 11 | using Konata.Core.Interfaces.Api; 12 | using Konata.Core.Message; 13 | using Konata.Core.Message.Model; 14 | using Kagami.SandBox; 15 | 16 | [assembly: InternalsVisibleTo("Kagami.Test")] 17 | 18 | namespace Kagami; 19 | 20 | public static class Program 21 | { 22 | private static Bot _bot = null!; 23 | private static ReplRuntime _sandbox = null!; 24 | 25 | private static readonly Regex[] SandBoxFilter = 26 | { 27 | new(@"^(true|false)$", RegexOptions.IgnoreCase | RegexOptions.Multiline), 28 | new(@"^(\+|-)?[0-9.]*(U|L|UL|F|D|M)?$", RegexOptions.IgnoreCase | RegexOptions.Multiline), 29 | }; 30 | 31 | public static async Task Main() 32 | { 33 | // Create sandbox 34 | _sandbox = new ReplRuntime( 35 | // Additional references 36 | new[] 37 | { 38 | "Konata.Core", 39 | "Paraparty.JsonChan" 40 | }, 41 | 42 | // Additional usings 43 | new[] 44 | { 45 | "System.Runtime", 46 | "System.Threading", 47 | "System.Threading.Tasks", 48 | "Konata.Core", 49 | "Konata.Core.Common", 50 | "Konata.Core.Interfaces", 51 | "Konata.Core.Interfaces.Api", 52 | "Konata.Core.Events.Model", 53 | "Paraparty.JsonChan" 54 | }, 55 | 56 | // Initial script 57 | null, 58 | 59 | // Enable checks 60 | true, 61 | 62 | // Execution timeout 63 | 5000 64 | ); 65 | 66 | // Compile commands 67 | await _sandbox.ScanScriptsAndLoad(); 68 | 69 | // Create bot 70 | _bot = BotFather.Create(GetConfig(), GetDevice(), GetKeyStore()); 71 | { 72 | // Print the log 73 | _bot.OnLog += (_, e) => 74 | Console.WriteLine($"[{DateTime.Now:yyyy-MM-dd HH:mm:ss.fff}] " + 75 | $"[{e.Level}] [{e.Tag}] {e.EventMessage}"); 76 | 77 | // Handle the captcha 78 | _bot.OnCaptcha += (s, e) => 79 | { 80 | switch (e.Type) 81 | { 82 | case CaptchaEvent.CaptchaType.Sms: 83 | Console.WriteLine(e.Phone); 84 | s.SubmitSmsCode(Console.ReadLine()); 85 | break; 86 | 87 | case CaptchaEvent.CaptchaType.Slider: 88 | Console.WriteLine(e.SliderUrl); 89 | s.SubmitSliderTicket(Console.ReadLine()); 90 | break; 91 | 92 | default: 93 | case CaptchaEvent.CaptchaType.Unknown: 94 | break; 95 | } 96 | }; 97 | 98 | // Handle group messages 99 | _bot.OnGroupMessage += GroupMessageHandler; 100 | 101 | // Update the keystore 102 | _bot.OnBotOnline += (bot, _) => 103 | { 104 | UpdateKeystore(bot.KeyStore); 105 | Console.WriteLine("Bot keystore updated."); 106 | }; 107 | 108 | // Login the bot 109 | if (!await _bot.Login()) 110 | { 111 | Console.WriteLine("Oops... Login failed."); 112 | return; 113 | } 114 | 115 | // cli 116 | while (true) 117 | { 118 | try 119 | { 120 | switch (Console.ReadLine()) 121 | { 122 | case "/stop": 123 | await _bot.Logout(); 124 | _bot.Dispose(); 125 | return; 126 | 127 | case "/login": 128 | await _bot.Login(); 129 | break; 130 | 131 | case "/reload": 132 | await _sandbox.ScanScriptsAndLoad(); 133 | break; 134 | } 135 | } 136 | catch (Exception e) 137 | { 138 | Console.WriteLine($"{e.Message}\n{e.StackTrace}"); 139 | } 140 | } 141 | } 142 | } 143 | 144 | /// 145 | /// Scan scripts and load 146 | /// 147 | /// 148 | private static async Task ScanScriptsAndLoad(this ReplRuntime sandbox) 149 | { 150 | // If directory does not exist 151 | if (!Directory.Exists("scripts")) 152 | { 153 | Console.WriteLine($"[ !!! ] The 'scripts' directory does not exist, return."); 154 | return; 155 | } 156 | 157 | // Compile scripts and load 158 | foreach (var i in Directory.EnumerateFiles 159 | ("scripts/", "*.cs", SearchOption.AllDirectories)) 160 | { 161 | try 162 | { 163 | Console.WriteLine($"[ *** ] REPL compiling script => {i}"); 164 | await sandbox.AddScript(await File.ReadAllTextAsync(i)); 165 | } 166 | catch (Exception e) 167 | { 168 | Console.WriteLine($"[ !!! ] Failed to add script {i}, ignoring."); 169 | Console.WriteLine($"[ ] {e.Message}"); 170 | } 171 | } 172 | 173 | Console.WriteLine("[ *** ] REPL scripts load finished."); 174 | } 175 | 176 | /// 177 | /// Load or create device 178 | /// 179 | /// 180 | private static BotDevice? GetDevice() 181 | { 182 | // Read the device from config 183 | if (File.Exists("device.json")) 184 | { 185 | return JsonSerializer.Deserialize 186 | (File.ReadAllText("device.json")); 187 | } 188 | 189 | // Create new one 190 | var device = BotDevice.Default(); 191 | { 192 | var deviceJson = JsonSerializer.Serialize(device, 193 | new JsonSerializerOptions {WriteIndented = true}); 194 | File.WriteAllText("device.json", deviceJson); 195 | } 196 | 197 | return device; 198 | } 199 | 200 | /// 201 | /// Load or create configuration 202 | /// 203 | /// 204 | private static BotConfig? GetConfig() 205 | { 206 | // Read the device from config 207 | if (File.Exists("config.json")) 208 | { 209 | return JsonSerializer.Deserialize 210 | (File.ReadAllText("config.json")); 211 | } 212 | 213 | // Create new one 214 | var config = new BotConfig 215 | { 216 | EnableAudio = true, 217 | TryReconnect = true, 218 | HighwayChunkSize = 8192, 219 | DefaultTimeout = 6000, 220 | Protocol = OicqProtocol.AndroidPhone 221 | }; 222 | 223 | // Write to file 224 | var configJson = JsonSerializer.Serialize(config, 225 | new JsonSerializerOptions {WriteIndented = true}); 226 | File.WriteAllText("config.json", configJson); 227 | 228 | return config; 229 | } 230 | 231 | /// 232 | /// Load or create keystore 233 | /// 234 | /// 235 | private static BotKeyStore? GetKeyStore() 236 | { 237 | // Read the device from config 238 | if (File.Exists("keystore.json")) 239 | { 240 | return JsonSerializer.Deserialize 241 | (File.ReadAllText("keystore.json")); 242 | } 243 | 244 | Console.WriteLine("For first running, please " + 245 | "type your account and password."); 246 | 247 | Console.Write("Account: "); 248 | var account = Console.ReadLine(); 249 | 250 | Console.Write("Password: "); 251 | var password = Console.ReadLine(); 252 | 253 | // Create new one 254 | Console.WriteLine("Bot created."); 255 | return UpdateKeystore(new BotKeyStore(account, password)); 256 | } 257 | 258 | /// 259 | /// Update keystore 260 | /// 261 | /// 262 | /// 263 | private static BotKeyStore UpdateKeystore(BotKeyStore keystore) 264 | { 265 | var keystoreJson = JsonSerializer.Serialize(keystore, 266 | new JsonSerializerOptions {WriteIndented = true}); 267 | File.WriteAllText("keystore.json", keystoreJson); 268 | return keystore; 269 | } 270 | 271 | private static async void GroupMessageHandler(Bot bot, GroupMessageEvent group) 272 | { 273 | // Ignore messages from bot itself 274 | if (group.MemberUin == bot.Uin) return; 275 | 276 | // Takeout text chain for below processing 277 | var textChain = group.Chain.GetChain(); 278 | if (textChain is null) return; 279 | 280 | MessageBuilder? reply = null; 281 | 282 | try 283 | { 284 | var debugging = false; 285 | var content = textChain.Content; 286 | 287 | if (content.StartsWith("/status")) 288 | reply = Command.OnCommandStatus(); 289 | else if (content.StartsWith("https://github.com/")) 290 | reply = await Command.OnCommandGithubParser(textChain); 291 | 292 | // User-defined function in REPL 293 | else if (content.StartsWith("/") && !content.StartsWith("/dbg")) 294 | { 295 | // Teardown command into an array 296 | var cmdArray = content[1..].Split(" "); 297 | if (cmdArray.Length == 0) return; 298 | 299 | // if user-defined function exist 300 | object? funcResult = null; 301 | if (_sandbox.GetReplFuncion(cmdArray[0], out var func)) 302 | { 303 | funcResult = _sandbox.CallReplDelegate(func, env => 304 | { 305 | env.Bot = bot; 306 | env.CurrentGroup = group.GroupUin; 307 | env.CurrentMember = group.MemberUin; 308 | }, cmdArray[1..]); 309 | } 310 | 311 | // Call and convert to result 312 | if (funcResult != null) 313 | reply = MessageBuilder.Eval(funcResult.ToString()); 314 | } 315 | else 316 | { 317 | // Enable repl debug echo 318 | if (content.StartsWith("/dbg")) 319 | { 320 | content = content[4..]; 321 | debugging = true; 322 | } 323 | 324 | // Ignore immediate expressions 325 | foreach (var filter in SandBoxFilter) 326 | { 327 | if (filter.IsMatch(content)) return; 328 | } 329 | 330 | try 331 | { 332 | // Run REPL code with environment 333 | var result = await _sandbox.RunAsync(content, env => 334 | { 335 | env.Bot = bot; 336 | env.CurrentGroup = group.GroupUin; 337 | env.CurrentMember = group.MemberUin; 338 | }); 339 | 340 | if (result == null) return; 341 | 342 | // Then error check 343 | if (result is Exception e) 344 | { 345 | // Normal runtime error 346 | if (e is ReplRuntimeException rre) 347 | result = $"{rre.InnerException!.Message}\n{rre.InnerException!.StackTrace}"; 348 | 349 | // Silent compilation errors if not debugging 350 | else result = debugging ? e.Message : null; 351 | } 352 | 353 | // No errors return 354 | if (result != null) 355 | reply = MessageBuilder.Eval(result.ToString()); 356 | } 357 | catch (Exception e) 358 | { 359 | Console.WriteLine(e.Message); 360 | Console.WriteLine(e.StackTrace); 361 | } 362 | } 363 | 364 | // Send reply message 365 | if (reply is not null) await bot.SendGroupMessage(group.GroupUin, reply); 366 | } 367 | catch (Exception e) 368 | { 369 | Console.WriteLine(e.Message); 370 | Console.WriteLine(e.StackTrace); 371 | } 372 | } 373 | } 374 | -------------------------------------------------------------------------------- /Kagami/SandBox/ReplEnvironment.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections; 3 | using System.Collections.Generic; 4 | using System.Threading.Tasks; 5 | using Kagami.Utils; 6 | using Konata.Core; 7 | using Konata.Core.Interfaces.Api; 8 | using Konata.Core.Message; 9 | using Paraparty.JsonChan; 10 | 11 | // ReSharper disable InconsistentNaming 12 | // ReSharper disable UnusedMember.Global 13 | // ReSharper disable UnusedType.Global 14 | // ReSharper disable MemberCanBePrivate.Global 15 | // ReSharper disable UnusedAutoPropertyAccessor.Global 16 | 17 | namespace Kagami.SandBox; 18 | 19 | public class ReplEnvironment 20 | { 21 | /// 22 | /// Bot instance 23 | /// 24 | public Bot? Bot { get; internal set; } 25 | 26 | /// 27 | /// Current group 28 | /// 29 | public uint CurrentGroup { get; internal set; } 30 | 31 | /// 32 | /// Message source uin 33 | /// 34 | public uint CurrentMember { get; internal set; } 35 | 36 | /// 37 | /// Shared Random 38 | /// 39 | public Random Random => Random.Shared; 40 | 41 | #region Pre-defined classes 42 | 43 | public static class JSON 44 | { 45 | public static dynamic Parse(string s) => Json.Parse(s); 46 | } 47 | 48 | #endregion 49 | 50 | #region Pre-defined functions 51 | 52 | /// 53 | /// Print messages 54 | /// 55 | /// 56 | public void Print(string message) 57 | => Bot.SendGroupMessage(CurrentGroup, MessageBuilder.Eval(message)); 58 | 59 | /// 60 | /// Random a selection from an object array 61 | /// 62 | /// 63 | /// 64 | public object Roll(params object[] selections) 65 | => selections[Random.Next(0, selections.Length)]; 66 | 67 | /// 68 | /// Can I do 69 | /// 70 | /// 71 | /// 72 | public bool CanIDo(double p = 0.5f) 73 | => Random.NextDouble() > (1.0 - p); 74 | 75 | /// 76 | /// Http download 77 | /// 78 | /// 79 | /// 80 | public Task Wget(string url) 81 | => url.UrlDownload(); 82 | 83 | /// 84 | /// Repeat string 85 | /// 86 | /// 87 | /// 88 | /// 89 | public string Repeat(string str, uint count) 90 | { 91 | var arr = new string[count]; 92 | Array.Fill(arr, str); 93 | return string.Join("", arr); 94 | } 95 | 96 | #endregion 97 | } 98 | -------------------------------------------------------------------------------- /Kagami/SandBox/ReplRuntime.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Text.RegularExpressions; 4 | using System.Threading; 5 | using System.Threading.Tasks; 6 | using Microsoft.CodeAnalysis.CSharp; 7 | using Microsoft.CodeAnalysis.Scripting; 8 | using Microsoft.CodeAnalysis.CSharp.Scripting; 9 | using Microsoft.CodeAnalysis.CSharp.Syntax; 10 | 11 | // ReSharper disable StaticMemberInGenericType 12 | 13 | namespace Kagami.SandBox; 14 | 15 | public class ReplRuntime where T : new() 16 | { 17 | private static readonly RegexOptions FilterOption 18 | = RegexOptions.IgnoreCase | RegexOptions.Singleline; 19 | 20 | private static readonly Regex[] FilterKeywords = 21 | { 22 | new(@"^(Type|TypeInfo|Console|Reflection|Activator)$", FilterOption), 23 | new(@"^(Environment|Process|Directory|Socket|File|Http|Net)$", FilterOption), 24 | new(@"^(Domain|Assemblies|Assembly|Modules|AppDomain|Win32|AppContext|Microsoft|OperatingSystem)$", FilterOption), 25 | new(@"^(InteropServices|Marshal|DllImport)$", FilterOption), 26 | new(@"^(GetType|GetDomain)$", FilterOption), 27 | }; 28 | 29 | private static readonly Regex[] FilterNamespaces = 30 | { 31 | new(@"(System\.IO)", FilterOption), 32 | new(@"(System\.Net)", FilterOption), 33 | new(@"(System\.Web)", FilterOption), 34 | new(@"(System\.Reflection)", FilterOption), 35 | new(@"(System\.Diagnostics)", FilterOption), 36 | new(@"(System\.Runtime)", FilterOption), 37 | new(@"(System\.Windows)", FilterOption), 38 | new(@"(System\.Resources)", FilterOption), 39 | new(@"(System\.CodeDom)", FilterOption), 40 | new(@"(System\.Activator)", FilterOption), 41 | }; 42 | 43 | private readonly object _globalObject; 44 | private ScriptState _globalState; 45 | private readonly ScriptOptions _globalOptions; 46 | private readonly bool _enableChecks; 47 | private readonly int _execTimeout; 48 | 49 | public T Global => (T) _globalObject; 50 | 51 | /// 52 | /// Repl runtime ctor 53 | /// 54 | /// additional references 55 | /// additional usings 56 | /// initial script 57 | /// enable code rule check 58 | /// timeout of script execution 59 | public ReplRuntime(string[]? additionalReferences, string[]? additionalUsings, 60 | string? initialScript, bool enableChecks, int execTimeout) 61 | { 62 | // Create script options 63 | _globalOptions = ScriptOptions.Default 64 | .AddReferences("Microsoft.CSharp") 65 | .AddReferences("System") 66 | .AddReferences(typeof(System.Text.Json.JsonSerializer).Assembly) 67 | .AddImports("System") 68 | .AddImports("System.Linq") 69 | .AddImports("System.Collections.Generic") 70 | .AddImports("System.Text") 71 | .AddImports("System.Text.Json") 72 | .AddImports("System.Text.Encoding") 73 | .WithCheckOverflow(true); 74 | { 75 | if (additionalReferences != null) 76 | { 77 | foreach (var i in additionalReferences) 78 | _globalOptions = _globalOptions.AddReferences(i); 79 | } 80 | 81 | if (additionalUsings != null) 82 | { 83 | foreach (var i in additionalUsings) 84 | _globalOptions = _globalOptions.AddImports(i); 85 | } 86 | } 87 | 88 | // Create initial script 89 | _globalObject = new T(); 90 | var script = CSharpScript.Create(initialScript ?? "", 91 | _globalOptions, typeof(T)); 92 | { 93 | // Create a empty state 94 | _globalState = script.RunAsync 95 | (_globalObject, _ => true).GetAwaiter().GetResult(); 96 | } 97 | 98 | _enableChecks = enableChecks; 99 | _execTimeout = execTimeout; 100 | } 101 | 102 | /// 103 | /// Run code async 104 | /// 105 | /// c# code 106 | /// environment update callback 107 | /// 108 | public async Task RunAsync(string code, Action? updateEnv = null) 109 | { 110 | // Run semantic check 111 | if (_enableChecks) 112 | { 113 | var syntax = CSharpSyntaxTree.ParseText(code); 114 | foreach (var node in (await syntax.GetRootAsync()).DescendantNodes()) 115 | { 116 | // Not allow typeof expression 117 | if (node is TypeOfExpressionSyntax) return null; 118 | 119 | // Not allow using directive expression 120 | else if (node is UsingDirectiveSyntax) return null; 121 | 122 | // Check namespaces 123 | else if (node is MemberAccessExpressionSyntax) 124 | { 125 | // Match keywords 126 | var name = node.ToString(); 127 | foreach (var rules in FilterNamespaces) 128 | { 129 | if (rules.IsMatch(name)) 130 | return null; 131 | } 132 | } 133 | 134 | // Check identifiers 135 | else if (node is IdentifierNameSyntax || node is QualifiedNameSyntax) 136 | { 137 | // Match keywords 138 | var name = node.ToString(); 139 | foreach (var rules in FilterKeywords) 140 | { 141 | if (rules.IsMatch(name)) 142 | return null; 143 | } 144 | } 145 | } 146 | 147 | // Checks are all passed, here we go~ = w = 148 | } 149 | 150 | // Analysis context 151 | (Exception? compileErr, Exception? runtimeErr, bool hasCompileErr, 152 | Thread thread, ScriptState newState, bool finish) analysisCtx = new(); 153 | { 154 | void Analysis() 155 | { 156 | try 157 | { 158 | // Update environment 159 | if (updateEnv != null) updateEnv((T) _globalObject); 160 | 161 | // Append the code to the last session and execute 162 | analysisCtx.newState = _globalState.Script 163 | .ContinueWith(code, _globalOptions) 164 | .RunFromAsync(_globalState, e => 165 | { 166 | analysisCtx.runtimeErr = e; 167 | return true; 168 | }).GetAwaiter().GetResult(); 169 | } 170 | 171 | // Compile-time errors 172 | catch (Exception e) 173 | { 174 | // Ignore CS0103 175 | analysisCtx.compileErr = e.Message.Contains("error CS0103") ? null : e; 176 | analysisCtx.hasCompileErr = true; 177 | } 178 | 179 | finally 180 | { 181 | analysisCtx.finish = true; 182 | } 183 | } 184 | 185 | // Configure thread an run 186 | lock (_globalState) 187 | { 188 | analysisCtx.thread = new Thread(Analysis); 189 | analysisCtx.thread.IsBackground = true; 190 | analysisCtx.thread.Priority = ThreadPriority.Lowest; 191 | analysisCtx.thread.Start(); 192 | analysisCtx.thread.Join(_execTimeout); 193 | 194 | // If execution timeout 195 | if (!analysisCtx.finish) 196 | { 197 | analysisCtx.thread.Interrupt(); 198 | analysisCtx.runtimeErr = new TimeoutException("Script execution timeout, exceed 5000ms."); 199 | } 200 | 201 | // Update state if script is executed successfully 202 | else if (analysisCtx.newState != null) 203 | _globalState = analysisCtx.newState; 204 | 205 | // Return results 206 | if (analysisCtx.hasCompileErr) return analysisCtx.compileErr; 207 | else if (analysisCtx.runtimeErr != null) return new ReplRuntimeException(analysisCtx.runtimeErr); 208 | else return _globalState.ReturnValue; 209 | } 210 | } 211 | } 212 | 213 | /// 214 | /// Trusted use only, no security checks 215 | /// 216 | /// 217 | public async Task AddScript(string code) 218 | { 219 | // Analysis context 220 | Exception? runtimeErr = null; 221 | 222 | // Execute script 223 | _globalState = await _globalState.Script 224 | .ContinueWith(code, _globalOptions) 225 | .RunFromAsync(_globalState, e => 226 | { 227 | runtimeErr = e; 228 | return true; 229 | }); 230 | 231 | // Throw all errors 232 | if (runtimeErr != null) throw runtimeErr; 233 | } 234 | 235 | /// 236 | /// Get REPL function 237 | /// 238 | /// function name 239 | /// delegate function 240 | /// 241 | public bool GetReplFuncion(string funcName, out Delegate? funcDelegate) 242 | { 243 | funcDelegate = null; 244 | 245 | // Check the name 246 | for (var i = _globalState.Variables.Length - 1; i >= 0; --i) 247 | { 248 | if (_globalState.Variables[i].Name != funcName) continue; 249 | 250 | try 251 | { 252 | // Create a delegate 253 | var method = _globalState.Variables[i].Value; 254 | var invoke = Delegate.CreateDelegate(method.GetType(), 255 | method, method.GetType().GetMethod("Invoke")!, true); 256 | 257 | // Ready to use 258 | if (invoke != null) 259 | { 260 | funcDelegate = invoke; 261 | return true; 262 | } 263 | } 264 | catch (Exception) 265 | { 266 | return false; 267 | } 268 | 269 | return false; 270 | } 271 | 272 | return false; 273 | } 274 | 275 | /// 276 | /// Call REPL function delegates 277 | /// 278 | /// delegate function 279 | /// environment update callback 280 | /// function parameters 281 | /// 282 | public object? CallReplDelegate(Delegate? funcDelegate, Action updateEnv, params string[] funcParameters) 283 | { 284 | if (funcDelegate == null) return null; 285 | 286 | var parameters = funcDelegate.Method.GetParameters(); 287 | // Process parameter conventions 288 | var args = new List(parameters.Length); 289 | var argindex = 0; 290 | 291 | foreach (var arg in parameters) 292 | { 293 | if (argindex >= funcParameters.Length) 294 | { 295 | if (!arg.IsOptional) 296 | { 297 | return null; // Required parameter was not found 298 | } 299 | args.Add(arg.DefaultValue); 300 | } 301 | else 302 | { 303 | // Only supports c# standard types 304 | args.Add(arg.ParameterType.Name switch 305 | { 306 | nameof(String) => funcParameters[argindex], 307 | nameof(Boolean) => Convert.ToBoolean(funcParameters[argindex]), 308 | 309 | nameof(Byte) => Convert.ToByte(funcParameters[argindex]), 310 | nameof(UInt16) => Convert.ToUInt16(funcParameters[argindex]), 311 | nameof(UInt32) => Convert.ToUInt32(funcParameters[argindex]), 312 | nameof(UInt64) => Convert.ToUInt64(funcParameters[argindex]), 313 | 314 | nameof(SByte) => Convert.ToSByte(funcParameters[argindex]), 315 | nameof(Int16) => Convert.ToInt16(funcParameters[argindex]), 316 | nameof(Int32) => Convert.ToInt32(funcParameters[argindex]), 317 | nameof(Int64) => Convert.ToInt64(funcParameters[argindex]), 318 | 319 | nameof(Single) => Convert.ToSingle(funcParameters[argindex]), 320 | nameof(Double) => Convert.ToDouble(funcParameters[argindex]), 321 | nameof(Decimal) => Convert.ToDecimal(funcParameters[argindex]), 322 | nameof(DateTime) => Convert.ToDateTime(funcParameters[argindex]), 323 | nameof(Char) => Convert.ToChar(funcParameters[argindex]), 324 | 325 | // any as object 326 | _ => funcParameters[argindex] 327 | }); 328 | } 329 | 330 | ++argindex; 331 | } 332 | 333 | lock (_globalState) 334 | { 335 | updateEnv((T) _globalObject); 336 | return funcDelegate.DynamicInvoke(args.ToArray()); 337 | } 338 | } 339 | } 340 | 341 | public class ReplRuntimeException : Exception 342 | { 343 | public ReplRuntimeException(Exception e) : base(e.Message, e) 344 | { 345 | } 346 | } 347 | -------------------------------------------------------------------------------- /Kagami/Utils/Build.cs: -------------------------------------------------------------------------------- 1 | using Konata.Core; 2 | using System.Linq; 3 | using System.Reflection; 4 | 5 | // ReSharper disable ConvertToAutoProperty 6 | 7 | namespace Kagami.Utils; 8 | 9 | public static class BuildStamp 10 | { 11 | public static string Branch 12 | => Stamp[0]; 13 | 14 | public static string CommitHash 15 | => Stamp[1][..16]; 16 | 17 | public static string BuildTime 18 | => Stamp[2]; 19 | 20 | public static string Version 21 | => InformationalVersion; 22 | 23 | private static readonly string[] Stamp 24 | = typeof(Bot).Assembly.GetCustomAttributes() 25 | .First(x => x.Key is "BuildStamp").Value!.Split(";"); 26 | 27 | private static readonly string InformationalVersion 28 | = typeof(Bot).Assembly.GetCustomAttribute()!.InformationalVersion; 29 | } -------------------------------------------------------------------------------- /Kagami/Utils/Util.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Net; 4 | using System.Net.Http; 5 | using System.Text.RegularExpressions; 6 | using System.Threading.Tasks; 7 | 8 | namespace Kagami.Utils; 9 | 10 | public static class Util 11 | { 12 | public static double Bytes2MiB(this long bytes, int round) 13 | => Math.Round(bytes / 1048576.0, round); 14 | 15 | /// 16 | /// UrlDownload file 17 | /// 18 | /// 19 | /// 20 | /// 21 | /// default 2 gigabytes 22 | /// 23 | public static async Task UrlDownload(this string url, 24 | Dictionary? header = null, 25 | int timeout = 8000, long limitLen = ((long) 2 << 30) - 1) 26 | { 27 | // Create request 28 | var request = new HttpClient(new HttpClientHandler {AutomaticDecompression = DecompressionMethods.All}) 29 | { 30 | Timeout = new TimeSpan(0, 0, 0, timeout), 31 | MaxResponseContentBufferSize = limitLen 32 | }; 33 | 34 | // Default useragent 35 | request.DefaultRequestHeaders.Add("User-Agent", new[] 36 | { 37 | "Mozilla/5.0 (Windows NT 10.0; Win64; x64)", 38 | "AppleWebKit/537.36 (KHTML, like Gecko)", 39 | "Chrome/100.0.4896.127 Safari/537.36 Edg/100.0.1185.50", 40 | "Kagami/1.0.0 (Konata Project)" 41 | }); 42 | 43 | // Append request header 44 | if (header is not null) 45 | foreach (var (k, v) in header) 46 | request.DefaultRequestHeaders.Add(k, v); 47 | 48 | // Open response stream 49 | var response = await request.GetByteArrayAsync(url); 50 | 51 | // Receive the response data 52 | return response; 53 | } 54 | 55 | /// 56 | /// Get meta data 57 | /// 58 | /// 59 | /// 60 | /// 61 | public static Dictionary GetMetaData(this string html, params string[] keys) 62 | { 63 | var metaDict = new Dictionary(); 64 | 65 | foreach (var i in keys) 66 | { 67 | var pattern = i + @"=""(.*?)""(.|\s)*?content=""(.*?)"".*?>"; 68 | 69 | // Match results 70 | foreach (Match j in Regex.Matches(html, pattern, RegexOptions.Multiline)) 71 | { 72 | metaDict.TryAdd(j.Groups[1].Value, j.Groups[3].Value); 73 | } 74 | } 75 | 76 | return metaDict; 77 | } 78 | 79 | /// 80 | /// Can I do 81 | /// 82 | /// Probability scale 83 | /// 84 | public static bool CanIDo(double factor = 0.5f) 85 | => new Random().NextDouble() >= (1 - factor); 86 | } 87 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Kagami 2 | 3 | [![C#](https://img.shields.io/badge/C%23-latest-green)](#) 4 | [![License](https://img.shields.io/static/v1?label=LICENSE&message=GNU%20GPLv3&color=lightrey)](./blob/main/LICENSE) 5 | 6 | 7 | 8 | 9 | 10 | A demo bot that can lead you to create your 11 | own bot with [Konata.Core](https://github.com/KonataDev/Konata.Core) quickly. 12 | 13 | ### Commands 14 | 15 | | Command | Description | 16 | |-----------------------------------------|------------------------------------------------------------| 17 | | /status | Print the status such as build, version, memory usage..etc | 18 | | /dbg \ | Enable the debug output of your REPL expression | 19 | | any user-defined command start with '/' | / | 20 | 21 | ### Triggers 22 | 23 | | Trigger | Example | Description | 24 | | ------- | ------- | ----------- | 25 | | Github | https://github.com/KonataDev/Kagami | Parse the GitHub repo image. | 26 | 27 | ### REPL Feature 28 | Kagami offers a modern C# (Currently C# 11) interactive terminal, 29 | type any valid C# expressions in the group then run the code. 30 | 31 | #### Example 32 | Benefited from the REPL feature, Kagami supports user-defined commands. 33 | You can define your command like the example below: 34 | ```C# 35 | // define a command named 'example' 36 | // it has 3 argument inputs a, b and c. 37 | var example = string (int a, bool b, string c) 38 | => $"a is {a}, b is {b}, c is \"{c}\""; 39 | ``` 40 | After defined the command, you can send '/example 1 false Hello' in your group, 41 | then Kagami will prints a "a is 1, b is False, c is Hello" string. 42 | 43 | #### Script Presets 44 | The script presets are stored in 'scripts' directory, 45 | write down your code and save with '.cs' suffix name here and restart Kagami to take effect. 46 | 47 | The normal output while Kagami starting: 48 | ``` 49 | [ *** ] REPL compiling script => scripts/ic.cs 50 | [ *** ] REPL compiling script => scripts/help.cs 51 | [ *** ] REPL compiling script => scripts/echo.cs 52 | [ *** ] REPL compiling script => scripts/ping.cs 53 | [ *** ] REPL compiling script => scripts/mute.cs 54 | [ *** ] REPL scripts load finished. 55 | ``` 56 | 57 | See more examples in [ScriptExample](./ScriptExample). 58 | 59 | #### Sandbox Environment 60 | 61 | Sandbox environment are defined in [ReplEnvironment.cs](./Kagami/SandBox/ReplEnvironment.cs), 62 | Contains fields, classes and methods as the script runtime context. 63 | 64 | | Name | Description | 65 | |---------------|----------------------------------------------| 66 | | Bot | The Kagami bot instance, full access in REPL | 67 | | CurrentGroup | Current group uin | 68 | | CurrentMember | Current member uin | 69 | | JSON | The dynamic JSON parser, use JSON.Parse() | 70 | | Print | Print a string | 71 | | CanIDo | Bot do something with a probability | 72 | | Wget | Http request | 73 | | Random | Shared random | 74 | 75 | ### Known Issues 76 | 77 | - [x] Sometimes offline. 78 | - [x] Sometimes stuck on some internal tasks. 79 | - [x] Stuck while the bot exit. 80 | - [x] Bot can trigger the command which sends by itself. (LMFAO) 81 | 82 | ### License 83 | 84 | Licensed in GNU GPLv3 with ❤. 85 | -------------------------------------------------------------------------------- /ScriptExample/chess.cs: -------------------------------------------------------------------------------- 1 | var chess_current_board = new string[12][] { 2 | new string[]{"１","２","３","４","５","６","７","８","９"}, 3 | new string[]{"車","馬","象","士","將","士","象","馬","車"}, 4 | new string[]{"　","　","　","　","　","　","　","　","　"}, 5 | new string[]{"　","炮","　","　","　","　","　","炮","　"}, 6 | new string[]{"卒","　","卒","　","卒","　","卒","　","卒"}, 7 | new string[]{"　","　","　","　","　","　","　","　","　"}, 8 | new string[]{"　","　","　","　","　","　","　","　","　"}, 9 | new string[]{"兵","　","兵","　","兵","　","兵","　","兵"}, 10 | new string[]{"　","砲","　","　","　","　","　","砲","　"}, 11 | new string[]{"　","　","　","　","　","　","　","　","　"}, 12 | new string[]{"俥","傌","相","仕","帥","仕","相","傌","俥"}, 13 | new string[]{"九","八","七","六","五","四","三","二","一"} 14 | }; 15 | var chess_current_step = 1; 16 | 17 | var chess_reset = () => { 18 | chess_current_board = new string[12][] { 19 | new string[]{"１","２","３","４","５","６","７","８","９"}, 20 | new string[]{"車","馬","象","士","將","士","象","馬","車"}, 21 | new string[]{"　","　","　","　","　","　","　","　","　"}, 22 | new string[]{"　","炮","　","　","　","　","　","炮","　"}, 23 | new string[]{"卒","　","卒","　","卒","　","卒","　","卒"}, 24 | new string[]{"　","　","　","　","　","　","　","　","　"}, 25 | new string[]{"　","　","　","　","　","　","　","　","　"}, 26 | new string[]{"兵","　","兵","　","兵","　","兵","　","兵"}, 27 | new string[]{"　","砲","　","　","　","　","　","砲","　"}, 28 | new string[]{"　","　","　","　","　","　","　","　","　"}, 29 | new string[]{"俥","傌","相","仕","帥","仕","相","傌","俥"}, 30 | new string[]{"九","八","七","六","五","四","三","二","一"} 31 | }; 32 | chess_current_step = 1; 33 | }; 34 | var chess_current_board_string = string() => { 35 | var str = ""; 36 | var ccb = chess_current_board; 37 | for (int i = 0; i < ccb.Length; i++) { 38 | for (int j = 0; j < ccb[i].Length; j++) 39 | str += ccb[i][j]; 40 | str += "\n"; 41 | } 42 | return str; 43 | }; 44 | 45 | var chess_play = string(string input) => { 46 | var ccb = chess_current_board; 47 | var step = chess_current_step; 48 | var str = ""; 49 | var red = "俥傌相仕帥仕相傌俥砲兵"; 50 | var black = "車馬象士將士象馬車炮卒"; 51 | var a = input[0].ToString(); 52 | var b = input[1].ToString(); 53 | var c = input[2].ToString(); 54 | var d = int.Parse(input[3].ToString()); 55 | int m = -1, n = -1, dm = 0, dn = 0; 56 | var koma = ""; 57 | var e = new Exception("违反棋规，不能下这一步"); 58 | try { 59 | if("前后".Contains(a)){ 60 | for(var i=1;i<=10;i++) { 61 | if(Array.IndexOf(ccb[i],b) > -1) { 62 | m=Array.IndexOf(ccb[i],b); 63 | n=i; 64 | if(a=="后"&&step%2==0) 65 | break; 66 | if(a=="前"&&step%2==1) 67 | break; 68 | } 69 | } 70 | koma=b; 71 | } else{ 72 | for(var i=1;1<=10;i++) { 73 | var j=step%2 > 0 ? 9-int.Parse(b) : int.Parse(b)-1; 74 | if(ccb[i][j]==a){ 75 | m=j; 76 | n=i; 77 | break; 78 | } 79 | } 80 | koma=a; 81 | } 82 | if(m<0||n<0)throw e; 83 | if("將帥兵卒".Contains(koma)&&d!= 1&&c!="平")throw e;//这些最多走一步 84 | if(c=="平"){ 85 | if("傌馬象士相仕".Contains(koma))throw e;//这些不能平 86 | if("兵卒".Contains(koma)) {//兵过河前不能平 87 | if(step%2>0&&n>6)throw e; 88 | if(step%2==0&&n<=6)throw e; 89 | } 90 | dm=step%2>0?9-d:d-1; 91 | dn=n; 92 | if("將帥兵卒".Contains(koma)&&Math.Abs(dm-m)!=1)throw e; 93 | } else if(c=="进"){ 94 | if ("象相".Contains(koma)) { 95 | dm = step%2 > 0 ? 9-d : d-1; 96 | dn = step%2 > 0 ? n-2 : n+2; 97 | var minus = Math.Abs(dm-m); 98 | if (minus != 2) throw e; 99 | } 100 | if ("士仕".Contains(koma)) { 101 | dm = step%2 > 0 ? 9-d : d-1; 102 | dn = step%2 > 0 ? n-1 : n+1; 103 | var minus = Math.Abs(dm-m); 104 | if (minus != 1) throw e; 105 | } 106 | if ("傌馬".Contains(koma)) { 107 | dm = step%2 > 0 ? 9-d : d-1; 108 | var minus = Math.Abs(dm-m); 109 | if (minus == 0 || minus > 2) throw e; 110 | if (minus == 1) { 111 | dn = step%2 > 0 ? n-2 : n+2; 112 | } else { 113 | dn = step%2 > 0 ? n-1 : n+1; 114 | } 115 | } 116 | if ("車俥炮砲將帥兵卒".Contains(koma)) { 117 | dm = m; 118 | dn = step%2 > 0 ? n-d : n+d; 119 | } 120 | } else if (c == "退") { 121 | if ("兵卒".Contains(koma)) throw e;//兵不能退 122 | if ("象相".Contains(koma)) { 123 | dm = step%2 > 0 ? 9-d : d-1; 124 | dn = step%2 == 0 ? n-2 : n+2; 125 | var minus = Math.Abs(dm-m); 126 | if (minus != 2) throw e; 127 | } 128 | if ("士仕".Contains(koma)) { 129 | dm = step%2 > 0 ? 9-d : d-1; 130 | dn = step%2 == 0 ? n-1 : n+1; 131 | var minus = Math.Abs(dm-m); 132 | if (minus != 1) throw e; 133 | } 134 | if ("傌馬".Contains(koma)) { 135 | dm = step%2 > 0 ? 9-d : d-1; 136 | var minus = Math.Abs(dm-m); 137 | if (minus == 0 || minus > 2) throw e; 138 | if (minus == 1) { 139 | dn = step%2 == 0 ? n-2 : n+2; 140 | } else { 141 | dn = step%2 == 0 ? n-1 : n+1; 142 | } 143 | } 144 | if ("車俥炮砲將帥兵卒".Contains(koma)) { 145 | dm = m; 146 | dn = step%2 == 0 ? n-d : n+d; 147 | } 148 | }else throw e; 149 | if(dm<0||dm>=9)throw e;//不能走到棋盘外 150 | if(dn<1||dn>=11)throw e; 151 | if(ccb[dn][dm]!="　") {//不能吃自己子 152 | if(step%2>0&&red.Contains(ccb[dn][dm]))throw e; 153 | if(step%2==0&&black.Contains(ccb[dn][dm]))throw e; 154 | } 155 | if("將帥士仕".Contains(koma)){//将士不出九宫 156 | if (dm < 3 || dm > 5 || (dn > 4 && dn < 8))throw e; 157 | } 158 | if("象相".Contains(koma)) {//象不能过河 159 | if(step%2>0&&dn<6)throw e; 160 | if(step%2==0&&dn>=6)throw e; 161 | int midm=(dm+m)/2,midn=(dn+n)/2;//象眼 162 | if(ccb[midn][midm]!="　")throw e; 163 | } 164 | if("傌馬".Contains(koma)) {//马脚 165 | int midm=0,midn=0; 166 | if(Math.Abs(dm-m)==1){ 167 | midn=(dn+n)/2; 168 | midm=m; 169 | }else{ 170 | midm=(dm+m)/2; 171 | midn=n; 172 | } 173 | if(ccb[midn][midm]!="　")throw e; 174 | } 175 | if("車俥".Contains(koma)){ 176 | if(dn==n) {//平 177 | var i=Math.Min(m,dm)+1; 178 | while (i=2||(j>0&&ccb[dn][dm]=="　")||(j==0&&ccb[dn][dm]!="　"))throw e; 198 | }else{//进退 199 | int j=0,i=Math.Min(n,dn)+1; 200 | while(i=2||(j>0&&ccb[dn][dm]=="　")||(j==0&&ccb[dn][dm]!="　"))throw e; 205 | } 206 | } 207 | if(ccb[dn][dm]=="帥") 208 | return "游戏结束，黑(將)方胜"; 209 | if(ccb[dn][dm]=="將") 210 | return "游戏结束，红(帥)方胜"; 211 | ccb[n][m]="　"; 212 | ccb[dn][dm]=koma; 213 | } catch (Exception err) { 214 | return err.Message; 215 | } 216 | var cur = step % 2 > 0 ? "红" : "黑"; 217 | var next = step % 2 == 0 ? "红" : "黑"; 218 | chess_current_step++; 219 | str += cur + input + "，轮到" + next + "方。查看棋局输入: /chess help"; 220 | return str; 221 | }; 222 | 223 | var chess = string(string input) => { 224 | var help = "象棋相关指令>>\n开局：/chess reset\n下棋：/chess 炮2平5\n查看：/chess help"; 225 | var ccb = chess_current_board; 226 | var step = chess_current_step; 227 | var str = ""; 228 | if (input == "help") { 229 | var cur = step % 2 > 0 ? "红" : "黑"; 230 | str += $"当前棋局(轮到{cur}方)>>\n" + chess_current_board_string(); 231 | str += "\n" + help; 232 | } else if (input == "reset") { 233 | chess_reset(); 234 | str += "新的棋局开始了！红先>>\n" + chess_current_board_string(); 235 | str += "\n" + help; 236 | } else { 237 | input = input.Trim(); 238 | if (input == "仙人指路") input = "兵3进1"; 239 | input = input.Replace("進", "进").Replace("後", "后") 240 | .Replace("一", "1").Replace("二", "2").Replace("三", "3") 241 | .Replace("四", "4").Replace("五", "5").Replace("六", "6") 242 | .Replace("七", "7").Replace("八", "8").Replace("九", "9"); 243 | if (step % 2 > 0) { 244 | input = input.Replace("車", "俥").Replace("馬", "傌") 245 | .Replace("车", "俥").Replace("马", "傌").Replace("炮", "砲") 246 | .Replace("將", "帥").Replace("将", "帥").Replace("帅", "帥") 247 | .Replace("士", "仕").Replace("象", "相").Replace("卒", "兵"); 248 | } else { 249 | input = input.Replace("俥", "車").Replace("傌", "馬") 250 | .Replace("车", "車").Replace("马", "馬").Replace("砲", "炮") 251 | .Replace("將", "將").Replace("将", "將").Replace("帅", "將") 252 | .Replace("仕", "士").Replace("相", "象").Replace("兵", "卒"); 253 | } 254 | str += chess_play(input); 255 | } 256 | return str; 257 | }; 258 | -------------------------------------------------------------------------------- /ScriptExample/hello.cs: -------------------------------------------------------------------------------- 1 | var hello = () => { 2 | return "Hello world!"; 3 | }; 4 | 5 | // or simpler code in one line 6 | // var hello = () => "Hello world!"; 7 | -------------------------------------------------------------------------------- /ScriptExample/ic.cs: -------------------------------------------------------------------------------- 1 | var ic = string(string str) => { 2 | var queryStr = str.TrimStart(' '); 3 | if (string.IsNullOrEmpty(queryStr)) return "查询错误, 参数为空"; 4 | 5 | var redirectMsg = string.Empty; 6 | 7 | try { 8 | followRedirect: 9 | 10 | // request api 11 | var bytes = Wget("https://www.semiee.com/bdxx-api/chip/v3/" + 12 | $"rich/search?&model={queryStr}").Result; 13 | 14 | // results 15 | var json = JSON.Parse(Encoding.UTF8.GetString(bytes)); 16 | if (json.code != 0) return "查询错误, 未知错误。代码1"; 17 | 18 | // no result 19 | if (json.total == 0) { 20 | bytes = Wget("https://www.semiee.com/bdxx-api/chip/v3/" + 21 | $"rich/search/recommend?model={queryStr}").Result; 22 | 23 | json = JSON.Parse(Encoding.UTF8.GetString(bytes)); 24 | if (json.code != 0) return "查询错误, 未知错误。代码2"; { 25 | json = JSON.Parse(Encoding.UTF8.GetString(bytes)); 26 | 27 | // follow the result 28 | queryStr = json.result.content; 29 | redirectMsg = $"未搜索到结果, 使用相似型号 '{json.result.content}' 进行搜索。\n"; 30 | goto followRedirect; 31 | } 32 | } 33 | 34 | var total = 0; 35 | var result = ""; 36 | if (json.total > 5) { 37 | total = 5; 38 | result = $"{redirectMsg}" + 39 | $"搜索结果数量太多 ({json.total}+), 仅显示前 5 条结果。请点击下方链接查看完整列表。\n" + 40 | $"https://www.semiee.com/search?searchModel={queryStr}\n\n"; 41 | } else { 42 | total = (int) json.total; 43 | result = $"{redirectMsg}" + 44 | $"半导小芯查询返回 {total} 条结果\n\n"; 45 | } 46 | 47 | // generate result 48 | for (var i = 0; i < total; ++i) { 49 | result += $"{json.result[i].name} [{json.result[i].brand_name}]\n"; 50 | result += $"{json.result[i].descri}\n"; 51 | 52 | try { 53 | bytes = Wget($"https://www.semiee.com/bdxx-api/chip/detail/{json.result[i].id}").Result; 54 | var pdfjson = JSON.Parse(Encoding.UTF8.GetString(bytes)); 55 | if (pdfjson.code != 0) throw new Exception("catchme"); 56 | 57 | result += pdfjson.result.dsFile.path.Replace(" ", "%20"); 58 | } catch { 59 | result += $"https://www.semiee.com/{json.result[i].id}.html"; 60 | } 61 | 62 | result += "\n\n"; 63 | } 64 | 65 | return result.TrimEnd('\n'); 66 | } 67 | catch (Exception e) { 68 | return "内部错误, 可能是服务器不可用。"; 69 | } 70 | }; 71 | --------------------------------------------------------------------------------