From 29a3fe820569e48a46c1e81afb7bfa19f96f6241 Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Fri, 13 Oct 2017 12:06:41 -0400 Subject: [PATCH 01/75] Adds CPU and memory tracking log files --- TGServerService/DreamDaemon.cs | 72 ++++++++++++++++++++++++++++++++-- TGServerService/Interop.cs | 1 + 2 files changed, 69 insertions(+), 4 deletions(-) diff --git a/TGServerService/DreamDaemon.cs b/TGServerService/DreamDaemon.cs index 8242cfe74f..cdd6de3004 100644 --- a/TGServerService/DreamDaemon.cs +++ b/TGServerService/DreamDaemon.cs @@ -3,6 +3,7 @@ using System.Diagnostics; using System.IO; using System.Reflection; using System.Threading; +using System.Timers; using TGServiceInterface; namespace TGServerService @@ -18,14 +19,17 @@ namespace TGServerService Pinged, } + const string DDDiagnosticsDir = "Diagnostics"; const int DDHangStartTime = 60; const int DDBadStartTime = 10; Process Proc; + PerformanceCounter pcpu; object watchdogLock = new object(); Thread DDWatchdog; TGDreamDaemonStatus currentStatus; + string CurrentDDLog; ushort currentPort = 0; object restartLock = new object(); @@ -38,6 +42,7 @@ namespace TGServerService //Only need 1 proc instance void InitDreamDaemon() { + Directory.CreateDirectory(DDDiagnosticsDir); var Reattach = Properties.Settings.Default.ReattachToDD; if (Reattach) try @@ -94,6 +99,7 @@ namespace TGServerService void DisposeDreamDaemon() { var Detach = Properties.Settings.Default.ReattachToDD; + bool RenameLog = false; if (DaemonStatus() == TGDreamDaemonStatus.Online) { if (!Detach) @@ -102,13 +108,23 @@ namespace TGServerService Thread.Sleep(1000); } else + { + RenameLog = CurrentDDLog != null; SendMessage("DD: Detaching watch dog for update!", ChatMessageType.WatchdogInfo); + WriteCurrentDDLog("Service updating! Splitting diagnostics..."); + } } else if (Detach) - { Properties.Settings.Default.ReattachToDD = false; - } Stop(); + if(pcpu != null) + pcpu.Dispose(); + if (RenameLog) + try + { + File.Move(Path.Combine(DDDiagnosticsDir, CurrentDDLog), Path.Combine(DDDiagnosticsDir, "SU-" + CurrentDDLog)); + } + catch { } } //public api @@ -206,6 +222,16 @@ namespace TGServerService return res; } + void WriteCurrentDDLog(string message) + { + lock (watchdogLock) + { + if (currentStatus != TGDreamDaemonStatus.Online || CurrentDDLog == null) + return; + File.AppendAllText(Path.Combine(DDDiagnosticsDir, CurrentDDLog), String.Format("[{0}]: {1}\n", DateTime.Now.ToLongTimeString(), message)); + } + } + //loop that keeps the server running void Watchdog() { @@ -225,6 +251,13 @@ namespace TGServerService } } var retries = 0; + + var MemTrackTimer = new System.Timers.Timer + { + AutoReset = true, + Interval = 5000 //every 5 seconds + }; + MemTrackTimer.Elapsed += MemTrackTimer_Elapsed; while (true) { var starttime = DateTime.Now; @@ -235,8 +268,23 @@ namespace TGServerService SendCommand(SCGracefulShutdown); } + //all good to go, let's start monitoring + var Now = DateTime.Now; + lock (watchdogLock) + { + CurrentDDLog = String.Format("{0} {1} Diagnostics.txt", Now.ToLongDateString(), Now.ToLongTimeString()).Replace(':', '-'); + WriteCurrentDDLog("Starting monitoring..."); + pcpu = new PerformanceCounter("Process", "% Processor Time", Proc.ProcessName, true); + } + MemTrackTimer.Start(); Proc.WaitForExit(); + lock (watchdogLock) //synchronize + { + MemTrackTimer.Stop(); + pcpu.Dispose(); + } + bool BadStart; lock (watchdogLock) { currentStatus = TGDreamDaemonStatus.HardRebooting; @@ -245,8 +293,8 @@ namespace TGServerService if (AwaitingShutdown == ShutdownRequestPhase.Pinged) return; - - if ((DateTime.Now - starttime).TotalSeconds < DDBadStartTime) + BadStart = (DateTime.Now - starttime).TotalSeconds < DDBadStartTime; + if (BadStart) { ++retries; var sleep_time = (int)Math.Min(Math.Pow(2, retries), 3600); //max of one hour @@ -261,6 +309,8 @@ namespace TGServerService TGServerService.WriteWarning(msg, TGServerService.EventID.DDWatchdogRebootingServer); } } + if (BadStart) + WriteCurrentDDLog("Crash detected!"); var res = StartImpl(true); if (res != null) @@ -313,6 +363,20 @@ namespace TGServerService } } + private void MemTrackTimer_Elapsed(object sender, ElapsedEventArgs e) + { + ulong megamem; + float cputime; + lock (watchdogLock) + { + cputime = pcpu.NextValue(); + using (var pcm = new PerformanceCounter("Process", "Working Set - Private", Proc.ProcessName, true)) + megamem = Convert.ToUInt64(pcm.NextValue()) / 1024; + } + var PercentCpuTime = (int)Math.Round((Decimal)cputime); + WriteCurrentDDLog(String.Format("CPU: {1}% Memory: {0}MB", megamem, PercentCpuTime.ToString("D3"))); + } + //public api public string CanStart() { diff --git a/TGServerService/Interop.cs b/TGServerService/Interop.cs index 5c8040162c..42ea994f50 100644 --- a/TGServerService/Interop.cs +++ b/TGServerService/Interop.cs @@ -89,6 +89,7 @@ namespace TGServerService break; case SRWorldReboot: TGServerService.WriteInfo("World Rebooted", TGServerService.EventID.WorldReboot); + WriteCurrentDDLog("World rebooted"); ServerChatCommands = null; ChatConnectivityCheck(); lock (CompilerLock) From 39857330202508d91bf572256952b49d636fa2d1 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Mon, 16 Oct 2017 12:03:39 -0400 Subject: [PATCH 02/75] RepoKey dir will be created by service --- TGServerService/Repository.cs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/TGServerService/Repository.cs b/TGServerService/Repository.cs index 89cb815326..09e867b57c 100644 --- a/TGServerService/Repository.cs +++ b/TGServerService/Repository.cs @@ -18,8 +18,9 @@ namespace TGServerService const string CachedTGS3SettingsPath = "TGS3.json"; const string RepoErrorUpToDate = "Already up to date!"; const string SSHPushRemote = "ssh_push_target"; - const string PrivateKeyPath = "RepoKey/private_key.txt"; - const string PublicKeyPath = "RepoKey/public_key.txt"; + const string RepoKeyDir = "RepoKey/" + const string PrivateKeyPath = RepoKeyDir + "private_key.txt"; + const string PublicKeyPath = RepoKeyDir + "public_key.txt"; const string PRJobFile = "prtestjob.json"; const string LiveTrackingBranch = "___TGSLiveCommitTrackingBranch"; const string CommitMessage = "Automatic changelog compile, [ci skip]"; @@ -145,6 +146,7 @@ namespace TGServerService void InitRepo() { + Directory.CreateDirectory(RepoKeyDir) if(Exists()) UpdateInterfaceDll(false); if(LoadRepo() == null) From 60b6c21f15ee90bcaa56ffc8f312217d7671b1e5 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Mon, 16 Oct 2017 12:10:30 -0400 Subject: [PATCH 03/75] Add missing semicolons --- TGServerService/Repository.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/TGServerService/Repository.cs b/TGServerService/Repository.cs index 09e867b57c..1165777e83 100644 --- a/TGServerService/Repository.cs +++ b/TGServerService/Repository.cs @@ -18,7 +18,7 @@ namespace TGServerService const string CachedTGS3SettingsPath = "TGS3.json"; const string RepoErrorUpToDate = "Already up to date!"; const string SSHPushRemote = "ssh_push_target"; - const string RepoKeyDir = "RepoKey/" + const string RepoKeyDir = "RepoKey/"; const string PrivateKeyPath = RepoKeyDir + "private_key.txt"; const string PublicKeyPath = RepoKeyDir + "public_key.txt"; const string PRJobFile = "prtestjob.json"; @@ -146,7 +146,7 @@ namespace TGServerService void InitRepo() { - Directory.CreateDirectory(RepoKeyDir) + Directory.CreateDirectory(RepoKeyDir); if(Exists()) UpdateInterfaceDll(false); if(LoadRepo() == null) From 65aad1d28cfb401b88f49e3b76b577f0770cf38a Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Mon, 16 Oct 2017 12:25:55 -0400 Subject: [PATCH 04/75] Fixes parsing of synchronize directories in TGS3.json --- TGServerService/Repository.cs | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/TGServerService/Repository.cs b/TGServerService/Repository.cs index 89cb815326..3f2a6cc469 100644 --- a/TGServerService/Repository.cs +++ b/TGServerService/Repository.cs @@ -46,7 +46,7 @@ namespace TGServerService public readonly string PathToChangelogPy; public readonly string ChangelogPyArguments; public readonly IList PipDependancies = new List(); - public readonly IList ChangelogPathsToStage = new List(); + public readonly IList PathsToStage = new List(); public readonly IList StaticDirectoryPaths = new List(); public readonly IList DLLPaths = new List(); @@ -69,16 +69,16 @@ namespace TGServerService PipDependancies = LoadArray(details["pip_dependancies"]); } catch { } - try - { - ChangelogPathsToStage = LoadArray(details["synchronize_paths"]); - } - catch { } } catch { ChangelogSupport = false; } try + { + PathsToStage = LoadArray(json["synchronize_paths"]); + } + catch { } + try { StaticDirectoryPaths = LoadArray(json["static_directories"]); } @@ -114,7 +114,7 @@ namespace TGServerService && PathToChangelogPy == other.PathToChangelogPy && ChangelogPyArguments == other.ChangelogPyArguments && ListEquals(PipDependancies, other.PipDependancies) - && ListEquals(ChangelogPathsToStage, other.ChangelogPathsToStage) + && ListEquals(PathsToStage, other.PathsToStage) && ListEquals(StaticDirectoryPaths, other.StaticDirectoryPaths) && ListEquals(DLLPaths, other.DLLPaths); } @@ -126,7 +126,7 @@ namespace TGServerService hashCode = hashCode * -1521134295 + EqualityComparer.Default.GetHashCode(PathToChangelogPy); hashCode = hashCode * -1521134295 + EqualityComparer.Default.GetHashCode(ChangelogPyArguments); hashCode = hashCode * -1521134295 + EqualityComparer>.Default.GetHashCode(PipDependancies); - hashCode = hashCode * -1521134295 + EqualityComparer>.Default.GetHashCode(ChangelogPathsToStage); + hashCode = hashCode * -1521134295 + EqualityComparer>.Default.GetHashCode(PathsToStage); hashCode = hashCode * -1521134295 + EqualityComparer>.Default.GetHashCode(StaticDirectoryPaths); hashCode = hashCode * -1521134295 + EqualityComparer>.Default.GetHashCode(DLLPaths); return hashCode; @@ -1010,7 +1010,7 @@ namespace TGServerService try { // Stage the file - foreach(var I in Config.ChangelogPathsToStage) + foreach(var I in Config.PathsToStage) Commands.Stage(Repo, I); if (Repo.RetrieveStatus().Staged.Count() == 0) //nothing to commit From f402c864e07ff331e0c79f86a583bcb4b9a859d5 Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Mon, 16 Oct 2017 13:33:47 -0400 Subject: [PATCH 05/75] Server releases are now packaged as a single exe --- TGInstallerWrapper/FodyWeavers.xml | 4 ++++ TGInstallerWrapper/TGInstallerWrapper.csproj | 17 +++++++++++++++++ TGInstallerWrapper/packages.config | 5 +++++ TGS3Release.ps1 | 11 ++--------- appveyor.yml | 2 +- 5 files changed, 29 insertions(+), 10 deletions(-) create mode 100644 TGInstallerWrapper/FodyWeavers.xml create mode 100644 TGInstallerWrapper/packages.config diff --git a/TGInstallerWrapper/FodyWeavers.xml b/TGInstallerWrapper/FodyWeavers.xml new file mode 100644 index 0000000000..c6e1b7c8af --- /dev/null +++ b/TGInstallerWrapper/FodyWeavers.xml @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/TGInstallerWrapper/TGInstallerWrapper.csproj b/TGInstallerWrapper/TGInstallerWrapper.csproj index e94ed50a6c..9685dbe6d6 100644 --- a/TGInstallerWrapper/TGInstallerWrapper.csproj +++ b/TGInstallerWrapper/TGInstallerWrapper.csproj @@ -11,6 +11,8 @@ v4.5.2 512 true + + AnyCPU @@ -38,6 +40,10 @@ tgs.ico + + ..\packages\Costura.Fody.1.6.2\lib\dotnet\Costura.dll + False + @@ -70,6 +76,7 @@ + @@ -78,7 +85,17 @@ + + + + + This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them. For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}. + + + + + \ No newline at end of file diff --git a/TGInstallerWrapper/packages.config b/TGInstallerWrapper/packages.config new file mode 100644 index 0000000000..b4d46b584a --- /dev/null +++ b/TGInstallerWrapper/packages.config @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/TGS3Release.ps1 b/TGS3Release.ps1 index 0749e410db..ea5884c247 100644 --- a/TGS3Release.ps1 +++ b/TGS3Release.ps1 @@ -2,19 +2,12 @@ $bf = $Env:APPVEYOR_BUILD_FOLDER $src = "$bf\TGInstallerWrapper\bin\Release" $version = [System.Diagnostics.FileVersionInfo]::GetVersionInfo("$src\TG Station Server Installer.exe").FileVersion -Remove-Item "$src\Microsoft.Deployment.WindowsInstaller.xml" -Remove-Item "$src\TG Station Server Installer.exe.config" -Remove-Item "$src\TG Station Server Installer.pdb" -Rename-Item -Path "$src\TG Station Server Installer.exe" -NewName "$src\TG Station Server Installer v$version.exe" +$destination = "$bf\TGS3-Server-v$version.exe" -$destination = "$bf\TGS3-Server-v$version.zip" - -If(Test-path $destination) {Remove-item $destination} +Move-Item -Path "$src\TG Station Server Installer.exe" -Destination "$destination" Add-Type -assembly "system.io.compression.filesystem" -[io.compression.zipfile]::CreateFromDirectory($src, $destination) - $destination_md5sha = $Env:APPVEYOR_BUILD_FOLDER + "\MD5-SHA1-Server-v$version.txt" $src2 = $Env:APPVEYOR_BUILD_FOLDER + "\ClientApps" diff --git a/appveyor.yml b/appveyor.yml index cd29c86075..0bbbd54080 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -5,7 +5,7 @@ image: Visual Studio 2017 configuration: Release shallow_clone: true artifacts: -- path: TGS3-Server-v*.zip +- path: TGS3-Server-v*.exe name: TGS3Server - path: MD5-SHA1-Server-v*.txt name: MD5SHA1Server From f2d6eb2ae33772d1b9272d8395749123a249066e Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Mon, 16 Oct 2017 16:15:33 -0400 Subject: [PATCH 06/75] Rewrite the installer using reflection Since the installer uses embedded native code for DD to be able to call it, we can't directly embed it in the installer exe. Let's just use the method we used for the .msi + reflection instead. --- TGInstallerWrapper/Main.Designer.cs | 11 +- TGInstallerWrapper/Main.cs | 138 +++++++++++++----- TGInstallerWrapper/Program.cs | 3 - .../Properties/Resources.Designer.cs | 12 +- TGInstallerWrapper/Properties/Resources.resx | 5 +- TGInstallerWrapper/TGInstallerWrapper.csproj | 7 +- 6 files changed, 126 insertions(+), 50 deletions(-) diff --git a/TGInstallerWrapper/Main.Designer.cs b/TGInstallerWrapper/Main.Designer.cs index 42842a7c05..88b82a06a3 100644 --- a/TGInstallerWrapper/Main.Designer.cs +++ b/TGInstallerWrapper/Main.Designer.cs @@ -1,4 +1,8 @@ -namespace TGInstallerWrapper +using System; +using System.Diagnostics; +using System.Reflection; + +namespace TGInstallerWrapper { partial class Main { @@ -127,7 +131,7 @@ this.VersionLabel.Name = "VersionLabel"; this.VersionLabel.Size = new System.Drawing.Size(228, 18); this.VersionLabel.TabIndex = 8; - this.VersionLabel.Text = "None (No Service Running)"; + this.VersionLabel.Text = "Unknown (No service running)"; // // InstallButton // @@ -160,7 +164,7 @@ this.TargetVersionLabel.Name = "TargetVersionLabel"; this.TargetVersionLabel.Size = new System.Drawing.Size(132, 18); this.TargetVersionLabel.TabIndex = 11; - this.TargetVersionLabel.Text = "Target Version:"; + this.TargetVersionLabel.Text = "Target Version: v" + FileVersionInfo.GetVersionInfo(Assembly.GetExecutingAssembly().Location).FileVersion; // // InstallCancelButton // @@ -179,6 +183,7 @@ this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font; this.BackColor = System.Drawing.Color.FromArgb(((int)(((byte)(39)))), ((int)(((byte)(40)))), ((int)(((byte)(34))))); this.ClientSize = new System.Drawing.Size(537, 153); + this.FormClosing += Main_FormClosing; this.Controls.Add(this.InstallCancelButton); this.Controls.Add(this.TargetVersionLabel); this.Controls.Add(this.ShowLogCheckbox); diff --git a/TGInstallerWrapper/Main.cs b/TGInstallerWrapper/Main.cs index 43045bb0cc..e8fbd719d2 100644 --- a/TGInstallerWrapper/Main.cs +++ b/TGInstallerWrapper/Main.cs @@ -3,36 +3,122 @@ using System; using System.Collections.Generic; using System.Diagnostics; using System.IO; -using System.Linq; +using System.Reflection; using System.Threading; using System.Threading.Tasks; using System.Windows.Forms; -using TGServiceInterface; namespace TGInstallerWrapper { public partial class Main : Form { - const string InstallDir = "TG Station Server"; //keep this in sync with the msi installer + const string DefaultInstallDir = "TG Station Server"; //keep this in sync with the msi installer + + //reflection shit, make sure it matches + const string InterfaceDLL = "TGServiceInterface.dll"; + const string InterfaceNamespace = "TGServiceInterface"; + const string InterfaceClass = InterfaceNamespace + ".Server"; + const string InterfaceServiceInterface = InterfaceNamespace + ".ITGSService"; //fuck this typo + const string InterfaceClassVerifyConnection = "VerifyConnection"; + const string InterfaceClassGetComponent = "GetComponent"; + const string InterfaceServiceInterfaceVersion = "Version"; + const string InterfaceServiceInterfacePrepareForUpdate = "PrepareForUpdate"; + + Assembly InterfaceAssembly; + Type Server, ITGSService; + MethodInfo VerifyConnection, GetComponentITGSService, Version, PrepareForUpdate; + + string tempDir; bool installing = false; bool cancelled = false; bool pathIsDefault = true; + public Main() { InitializeComponent(); - FormClosing += Main_FormClosing; - PathTextBox.Text = Environment.GetFolderPath(Environment.SpecialFolder.ProgramFilesX86) + Path.DirectorySeparatorChar + InstallDir; - var verifiedConnection = Server.VerifyConnection() == null; + SetupTempDir(); + LoadInterfaceFromReflection(); + CheckForExistingVersion(); + PathTextBox.Text = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ProgramFilesX86), DefaultInstallDir); + } + + void SetupTempDir() + { + tempDir = Path.Combine(Path.GetTempPath(), "TGS3InstallerTempDir"); try { - VersionLabel.Text = Server.GetComponent().Version(); + if (File.Exists(tempDir)) + File.Delete(tempDir); + else if (Directory.Exists(tempDir)) + Directory.Delete(tempDir); + } + catch { } + if (File.Exists(tempDir) || Directory.Exists(tempDir)) + { + tempDir = Path.GetTempFileName(); + File.Delete(tempDir); //we want a dir not a file + } + Directory.CreateDirectory(tempDir); + } + + void LoadInterfaceFromReflection() + { + //so this is where we expect to find the interface dll + try + { + var tmppath = Path.Combine(tempDir, InterfaceDLL); + File.WriteAllBytes(tmppath, Properties.Resources.TGServiceInterface); + InterfaceAssembly = Assembly.LoadFrom(tmppath); //we can't link to it, or load the bytes directly because the thing will complain about mixing the DLLExport code and IL code + Server = InterfaceAssembly.GetType(InterfaceClass); + ITGSService = InterfaceAssembly.GetType(InterfaceServiceInterface); + VerifyConnection = Server.GetMethod(InterfaceClassVerifyConnection); + GetComponentITGSService = Server.GetMethod(InterfaceClassGetComponent).MakeGenericMethod(ITGSService); + Version = ITGSService.GetMethod(InterfaceServiceInterfaceVersion); + PrepareForUpdate = ITGSService.GetMethod(InterfaceServiceInterfacePrepareForUpdate); } catch { - if(verifiedConnection) + InterfaceAssembly = null; + VersionLabel.Text = "Error: (Could not load interface dll)"; + return; + } + } + + void CheckForExistingVersion() { + if (InterfaceAssembly == null) + return; + var verifiedConnection = VerifyConnection.Invoke(null, null) == null; + try + { + VersionLabel.Text = (string)Version.Invoke(GetComponentITGSService.Invoke(null, null), null); + } + catch + { + if (verifiedConnection) VersionLabel.Text = "< v3.0.85.0 (Missing ITGService.Version())"; } - TargetVersionLabel.Text += " v" + FileVersionInfo.GetVersionInfo(System.Reflection.Assembly.GetExecutingAssembly().Location).FileVersion; + } + + bool ConfirmDangerousUpgrade() + { + return MessageBox.Show("Unable connect to service! Existing DreamDaemon instances will be terminated. Continue?", "Warning", MessageBoxButtons.YesNo) == DialogResult.Yes; + } + + bool TellServiceWereComingForThem() + { + if (InterfaceAssembly == null) + return ConfirmDangerousUpgrade(); + var connectionVerified = VerifyConnection.Invoke(null, null) == null; + try + { + PrepareForUpdate.Invoke(GetComponentITGSService.Invoke(null, null), null); + Thread.Sleep(3000); //chat messages + return true; + } + catch + { + return ConfirmDangerousUpgrade(); + } } private void Main_FormClosing(object sender, FormClosingEventArgs e) @@ -71,7 +157,6 @@ namespace TGInstallerWrapper async void DoInstall() { - string path = null; string logfile = null; try { @@ -90,6 +175,9 @@ namespace TGInstallerWrapper break; } + if (!TellServiceWereComingForThem()) + return; + var args = new List(); if (!pathIsDefault) args.Add(String.Format("INSTALLFOLDER=\"{0}\"", PathTextBox.Text)); @@ -108,32 +196,16 @@ namespace TGInstallerWrapper ShowLogCheckbox.Enabled = false; InstallButton.Text = "Installing..."; - path = Path.GetTempFileName(); - File.Delete(path); //we want a dir not a file - Directory.CreateDirectory(path); - var msipath = path + Path.DirectorySeparatorChar + "TGServiceInstaller.msi"; + var msipath = Path.Combine(tempDir, "TGServiceInstaller.msi"); File.WriteAllBytes(msipath, Properties.Resources.TGServiceInstaller); - File.WriteAllBytes(path + Path.DirectorySeparatorChar + "cab1.cab", Properties.Resources.cab1); + File.WriteAllBytes(Path.Combine(tempDir, "cab1.cab"), Properties.Resources.cab1); ProgressBar.Style = ProgressBarStyle.Marquee; - - var connectionVerified = Server.VerifyConnection() == null; - try - { - Server.GetComponent().PrepareForUpdate(); - Thread.Sleep(3000); //chat messages - } - catch - { - if (connectionVerified && MessageBox.Show("ITGSService.PrepareForUpdate() threw an exception! Existing DreamDaemon instances will be terminated. Continue?", "Warning", MessageBoxButtons.YesNo) != DialogResult.Yes) - return; - } - InstallCancelButton.Enabled = true; if (ShowLogCheckbox.Checked) { - logfile = path + Path.DirectorySeparatorChar + "tgsinstall.log"; + logfile = Path.Combine(tempDir, "tgsinstall.log"); Installer.EnableLog(InstallLogModes.Verbose | InstallLogModes.PropertyDump, logfile); } var cl = String.Join(" ", args); @@ -172,12 +244,6 @@ namespace TGInstallerWrapper Process.Start(logfile).WaitForInputIdle(); } catch { } - if (path != null) - try - { - Directory.Delete(path, true); - } - catch { } } MessageBox.Show("Success!"); Application.Exit(); @@ -208,7 +274,7 @@ namespace TGInstallerWrapper if (fbd.ShowDialog() != DialogResult.OK) return; pathIsDefault = false; - PathTextBox.Text = fbd.SelectedPath + Path.DirectorySeparatorChar + InstallDir; + PathTextBox.Text = fbd.SelectedPath + Path.DirectorySeparatorChar + DefaultInstallDir; } private void CancelButton_Click(object sender, EventArgs e) diff --git a/TGInstallerWrapper/Program.cs b/TGInstallerWrapper/Program.cs index c9669327d9..96dc421f86 100644 --- a/TGInstallerWrapper/Program.cs +++ b/TGInstallerWrapper/Program.cs @@ -1,7 +1,4 @@ using System; -using System.Collections.Generic; -using System.Linq; -using System.Threading.Tasks; using System.Windows.Forms; namespace TGInstallerWrapper diff --git a/TGInstallerWrapper/Properties/Resources.Designer.cs b/TGInstallerWrapper/Properties/Resources.Designer.cs index 9365443396..e3858daec9 100644 --- a/TGInstallerWrapper/Properties/Resources.Designer.cs +++ b/TGInstallerWrapper/Properties/Resources.Designer.cs @@ -19,7 +19,7 @@ namespace TGInstallerWrapper.Properties { // class via a tool like ResGen or Visual Studio. // To add or remove a member, edit your .ResX file then rerun ResGen // with the /str option, or rebuild your VS project. - [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "4.0.0.0")] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "15.0.0.0")] [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] internal class Resources { @@ -79,5 +79,15 @@ namespace TGInstallerWrapper.Properties { return ((byte[])(obj)); } } + + /// + /// Looks up a localized resource of type System.Byte[]. + /// + internal static byte[] TGServiceInterface { + get { + object obj = ResourceManager.GetObject("TGServiceInterface", resourceCulture); + return ((byte[])(obj)); + } + } } } diff --git a/TGInstallerWrapper/Properties/Resources.resx b/TGInstallerWrapper/Properties/Resources.resx index b29efcb08f..daa2b3cb0c 100644 --- a/TGInstallerWrapper/Properties/Resources.resx +++ b/TGInstallerWrapper/Properties/Resources.resx @@ -122,6 +122,9 @@ ..\..\TGServiceInstaller\bin\Release\cab1.cab;System.Byte[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 - ...\..\TGServiceInstaller\bin\Release\TGServiceInstaller.msi;System.Byte[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + ..\..\TGServiceInstaller\bin\Release\TGServiceInstaller.msi;System.Byte[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + ..\..\TGServiceInterface\bin\x86\Release\TGServiceInterface.dll;System.Byte[], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 \ No newline at end of file diff --git a/TGInstallerWrapper/TGInstallerWrapper.csproj b/TGInstallerWrapper/TGInstallerWrapper.csproj index 9685dbe6d6..7e1bf4045e 100644 --- a/TGInstallerWrapper/TGInstallerWrapper.csproj +++ b/TGInstallerWrapper/TGInstallerWrapper.csproj @@ -78,14 +78,9 @@ - - - {ac4e7e8b-f83a-481c-a8b0-8fa4e8ae59ab} - TGServiceInterface - - + From 9c49ffcd65337996a5915eeaf2fe259d41863f78 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Mon, 16 Oct 2017 17:13:04 -0400 Subject: [PATCH 07/75] Version bump to 3.1.4.1 [TGSDeploy] --- Version.cs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Version.cs b/Version.cs index 7b79200049..966f876961 100644 --- a/Version.cs +++ b/Version.cs @@ -12,6 +12,6 @@ using System.Reflection; // [assembly: AssemblyVersion("1.0.*")] //It's impossible to make these a define, don't say I didn't warn you -[assembly: AssemblyVersion("3.1.4.0")] -[assembly: AssemblyFileVersion("3.1.4.0")] -[assembly: AssemblyInformationalVersion("3.1.4.0")] +[assembly: AssemblyVersion("3.1.4.1")] +[assembly: AssemblyFileVersion("3.1.4.1")] +[assembly: AssemblyInformationalVersion("3.1.4.1")] From c46deb97db447623d3adff7ee91b95ea8c351e16 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Mon, 16 Oct 2017 20:08:05 -0400 Subject: [PATCH 08/75] Fixes IRC PMs not working --- TGServerService/IRC.cs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/TGServerService/IRC.cs b/TGServerService/IRC.cs index 7194be267c..a04dfc2d36 100644 --- a/TGServerService/IRC.cs +++ b/TGServerService/IRC.cs @@ -88,6 +88,8 @@ namespace TGServerService { if (IRCConfig.AdminsAreSpecial) { + if (e.Channel == null) + return false; var user = (NonRfcChannelUser)irc.GetChannelUser(e.Channel, e.Nick); if (user != null) switch (IRCConfig.AuthLevel) From 0e0fef1e562a9c5c352240987535ff89410c653d Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Tue, 17 Oct 2017 14:07:40 -0400 Subject: [PATCH 09/75] Move it into a Resources subdir --- TGServerService/DreamDaemon.cs | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/TGServerService/DreamDaemon.cs b/TGServerService/DreamDaemon.cs index cdd6de3004..d7d5226721 100644 --- a/TGServerService/DreamDaemon.cs +++ b/TGServerService/DreamDaemon.cs @@ -19,7 +19,8 @@ namespace TGServerService Pinged, } - const string DDDiagnosticsDir = "Diagnostics"; + const string DiagnosticsDir = "Diagnostics"; + const string ResourceDiagnosticsDir = DiagnosticsDir + "/Resources"; const int DDHangStartTime = 60; const int DDBadStartTime = 10; @@ -42,7 +43,8 @@ namespace TGServerService //Only need 1 proc instance void InitDreamDaemon() { - Directory.CreateDirectory(DDDiagnosticsDir); + Directory.CreateDirectory(DiagnosticsDir); + Directory.CreateDirectory(ResourceDiagnosticsDir); var Reattach = Properties.Settings.Default.ReattachToDD; if (Reattach) try @@ -122,7 +124,7 @@ namespace TGServerService if (RenameLog) try { - File.Move(Path.Combine(DDDiagnosticsDir, CurrentDDLog), Path.Combine(DDDiagnosticsDir, "SU-" + CurrentDDLog)); + File.Move(Path.Combine(ResourceDiagnosticsDir, CurrentDDLog), Path.Combine(ResourceDiagnosticsDir, "SU-" + CurrentDDLog)); } catch { } } @@ -228,7 +230,7 @@ namespace TGServerService { if (currentStatus != TGDreamDaemonStatus.Online || CurrentDDLog == null) return; - File.AppendAllText(Path.Combine(DDDiagnosticsDir, CurrentDDLog), String.Format("[{0}]: {1}\n", DateTime.Now.ToLongTimeString(), message)); + File.AppendAllText(Path.Combine(ResourceDiagnosticsDir, CurrentDDLog), String.Format("[{0}]: {1}\n", DateTime.Now.ToLongTimeString(), message)); } } From 3cdb8aa6b931eac8d440e4fcbef268e7973a7385 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Tue, 17 Oct 2017 16:07:10 -0400 Subject: [PATCH 10/75] Fixes RepoPush event being logged as an error --- TGServerService/Repository.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TGServerService/Repository.cs b/TGServerService/Repository.cs index 7267e5de8c..9bfafeeebf 100644 --- a/TGServerService/Repository.cs +++ b/TGServerService/Repository.cs @@ -1054,7 +1054,7 @@ namespace TGServerService CredentialsProvider = GenerateGitCredentials, }; Repo.Network.Push(Repo.Network.Remotes[SSHPushRemote], Repo.Head.CanonicalName, options); - TGServerService.WriteError("Repo pushed up to commit: " + Repo.Head.Tip.Sha, TGServerService.EventID.RepoPush); + TGServerService.WriteInfo("Repo pushed up to commit: " + Repo.Head.Tip.Sha, TGServerService.EventID.RepoPush); return null; } catch (Exception e) From 14a41113f63cc1ba19073adc06865317f8495fbf Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Tue, 17 Oct 2017 16:36:06 -0400 Subject: [PATCH 11/75] Version bump to 3.1.5.0 [TGSDeploy] --- Version.cs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Version.cs b/Version.cs index 966f876961..4ee176030a 100644 --- a/Version.cs +++ b/Version.cs @@ -12,6 +12,6 @@ using System.Reflection; // [assembly: AssemblyVersion("1.0.*")] //It's impossible to make these a define, don't say I didn't warn you -[assembly: AssemblyVersion("3.1.4.1")] -[assembly: AssemblyFileVersion("3.1.4.1")] -[assembly: AssemblyInformationalVersion("3.1.4.1")] +[assembly: AssemblyVersion("3.1.5.0")] +[assembly: AssemblyFileVersion("3.1.5.0")] +[assembly: AssemblyInformationalVersion("3.1.5.0")] From e67911aba1d36364a8727edf926a2c9c9a1f8cec Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Tue, 17 Oct 2017 16:56:20 -0400 Subject: [PATCH 12/75] Fixes TGInstallerWrapper missing TGServiceInterface as a dependency --- TGStationServer3.sln | 1 + 1 file changed, 1 insertion(+) diff --git a/TGStationServer3.sln b/TGStationServer3.sln index 48358be2aa..f8e8dfddb6 100644 --- a/TGStationServer3.sln +++ b/TGStationServer3.sln @@ -32,6 +32,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TGInstallerWrapper", "TGInstallerWrapper\TGInstallerWrapper.csproj", "{8956D4C3-BFB9-448E-BF5F-EE7E6F9996F9}" ProjectSection(ProjectDependencies) = postProject + {AC4E7E8B-F83A-481C-A8B0-8FA4E8AE59AB} = {AC4E7E8B-F83A-481C-A8B0-8FA4E8AE59AB} {154435F6-0890-42D4-9AEC-B743D4FBC1CB} = {154435F6-0890-42D4-9AEC-B743D4FBC1CB} EndProjectSection EndProject From 075a9adfefeaff7eb5ab33c894f9f59dce077b3b Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Wed, 18 Oct 2017 09:50:49 -0400 Subject: [PATCH 13/75] Fixes TGInstallerWrapper project looking for invalid Resource file --- TGInstallerWrapper/TGInstallerWrapper.csproj | 1 - 1 file changed, 1 deletion(-) diff --git a/TGInstallerWrapper/TGInstallerWrapper.csproj b/TGInstallerWrapper/TGInstallerWrapper.csproj index 7e1bf4045e..4a7e9bf37d 100644 --- a/TGInstallerWrapper/TGInstallerWrapper.csproj +++ b/TGInstallerWrapper/TGInstallerWrapper.csproj @@ -80,7 +80,6 @@ - From 981748b1f1d5e5b9dc08fb719bc9bc74f555ecb6 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Wed, 18 Oct 2017 10:05:39 -0400 Subject: [PATCH 14/75] Fixes crashes not being written to the resource diagnostics file --- TGServerService/DreamDaemon.cs | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/TGServerService/DreamDaemon.cs b/TGServerService/DreamDaemon.cs index d7d5226721..ff6fac5c66 100644 --- a/TGServerService/DreamDaemon.cs +++ b/TGServerService/DreamDaemon.cs @@ -286,7 +286,8 @@ namespace TGServerService pcpu.Dispose(); } - bool BadStart; + WriteCurrentDDLog("Crash detected!"); + lock (watchdogLock) { currentStatus = TGDreamDaemonStatus.HardRebooting; @@ -295,7 +296,7 @@ namespace TGServerService if (AwaitingShutdown == ShutdownRequestPhase.Pinged) return; - BadStart = (DateTime.Now - starttime).TotalSeconds < DDBadStartTime; + var BadStart = (DateTime.Now - starttime).TotalSeconds < DDBadStartTime; if (BadStart) { ++retries; @@ -311,8 +312,6 @@ namespace TGServerService TGServerService.WriteWarning(msg, TGServerService.EventID.DDWatchdogRebootingServer); } } - if (BadStart) - WriteCurrentDDLog("Crash detected!"); var res = StartImpl(true); if (res != null) From 83c95403f9ec1fa8d4f9e462addd53e18646300f Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Wed, 18 Oct 2017 10:38:58 -0400 Subject: [PATCH 15/75] Finishes converting the project to x86 --- TGCommandLine/TGCommandLine.csproj | 40 +++++++-------- TGControlPanel/TGControlPanel.csproj | 40 +++++++-------- TGInstallerWrapper/TGInstallerWrapper.csproj | 39 +++++++------- TGS3Release.ps1 | 4 +- TGServerService/TGServerService.csproj | 40 +++++++-------- TGStationServer3.sln | 54 ++++++++++---------- 6 files changed, 109 insertions(+), 108 deletions(-) diff --git a/TGCommandLine/TGCommandLine.csproj b/TGCommandLine/TGCommandLine.csproj index cf32e3fcf0..e86a0d0795 100644 --- a/TGCommandLine/TGCommandLine.csproj +++ b/TGCommandLine/TGCommandLine.csproj @@ -12,32 +12,32 @@ 512 true - - AnyCPU - true - full - false - bin\Debug\ - DEBUG;TRACE - prompt - 4 - true - - - AnyCPU - pdbonly - true - bin\Release\ - TRACE - prompt - 4 - tgs.ico + + true + bin\x86\Debug\ + DEBUG;TRACE + full + x86 + prompt + MinimumRecommendedRules.ruleset + true + + + bin\x86\Release\ + TRACE + true + pdbonly + x86 + prompt + MinimumRecommendedRules.ruleset + true + diff --git a/TGControlPanel/TGControlPanel.csproj b/TGControlPanel/TGControlPanel.csproj index 976c556e7d..3259048c4a 100644 --- a/TGControlPanel/TGControlPanel.csproj +++ b/TGControlPanel/TGControlPanel.csproj @@ -14,29 +14,29 @@ - - AnyCPU - true - full - false - bin\Debug\ - DEBUG;TRACE - prompt - 4 - true - - - AnyCPU - pdbonly - true - bin\Release\ - TRACE - prompt - 4 - tgs.ico + + true + bin\x86\Debug\ + DEBUG;TRACE + full + x86 + prompt + MinimumRecommendedRules.ruleset + true + + + bin\x86\Release\ + TRACE + true + pdbonly + x86 + prompt + MinimumRecommendedRules.ruleset + true + diff --git a/TGInstallerWrapper/TGInstallerWrapper.csproj b/TGInstallerWrapper/TGInstallerWrapper.csproj index 7e1bf4045e..7d29bf56fb 100644 --- a/TGInstallerWrapper/TGInstallerWrapper.csproj +++ b/TGInstallerWrapper/TGInstallerWrapper.csproj @@ -14,31 +14,32 @@ - - AnyCPU - true - full - false - bin\Debug\ - DEBUG;TRACE - prompt - 4 - - - AnyCPU - pdbonly - true - bin\Release\ - TRACE - prompt - 4 - app.manifest tgs.ico + + true + bin\x86\Debug\ + DEBUG;TRACE + full + x86 + prompt + MinimumRecommendedRules.ruleset + true + + + bin\x86\Release\ + TRACE + true + pdbonly + x86 + prompt + MinimumRecommendedRules.ruleset + true + ..\packages\Costura.Fody.1.6.2\lib\dotnet\Costura.dll diff --git a/TGS3Release.ps1 b/TGS3Release.ps1 index ea5884c247..45b9e45737 100644 --- a/TGS3Release.ps1 +++ b/TGS3Release.ps1 @@ -12,8 +12,8 @@ $destination_md5sha = $Env:APPVEYOR_BUILD_FOLDER + "\MD5-SHA1-Server-v$version.t $src2 = $Env:APPVEYOR_BUILD_FOLDER + "\ClientApps" [system.io.directory]::CreateDirectory($src2) -Copy-Item "$bf\TGCommandLine\bin\Release\TGCommandLine.exe" "$src2\TGCommandLine.exe" -Copy-Item "$bf\TGControlPanel\bin\Release\TGControlPanel.exe" "$src2\TGControlPanel.exe" +Copy-Item "$bf\TGCommandLine\bin\x86\Release\TGCommandLine.exe" "$src2\TGCommandLine.exe" +Copy-Item "$bf\TGControlPanel\bin\x86\Release\TGControlPanel.exe" "$src2\TGControlPanel.exe" Copy-Item "$bf\TGServiceInterface\bin\x86\Release\TGServiceInterface.dll" "$src2\TGServiceInterface.dll" $dest2 = "$bf\TGS3-Client-v$version.zip" diff --git a/TGServerService/TGServerService.csproj b/TGServerService/TGServerService.csproj index c4c6aa7583..657a87a11b 100644 --- a/TGServerService/TGServerService.csproj +++ b/TGServerService/TGServerService.csproj @@ -16,29 +16,29 @@ - - AnyCPU - true - full - false - bin\Debug\ - DEBUG;TRACE - prompt - 4 - true - - - AnyCPU - pdbonly - true - bin\Release\ - TRACE - prompt - 4 - tgs.ico + + true + bin\x86\Debug\ + DEBUG;TRACE + full + x86 + prompt + MinimumRecommendedRules.ruleset + true + + + bin\x86\Release\ + TRACE + true + pdbonly + x86 + prompt + MinimumRecommendedRules.ruleset + true + ..\packages\Discord.Net.Core.1.0.2\lib\net45\Discord.Net.Core.dll diff --git a/TGStationServer3.sln b/TGStationServer3.sln index f8e8dfddb6..f3c278f6d4 100644 --- a/TGStationServer3.sln +++ b/TGStationServer3.sln @@ -1,7 +1,7 @@  Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio 15 -VisualStudioVersion = 15.0.26730.3 +VisualStudioVersion = 15.0.26730.16 MinimumVisualStudioVersion = 10.0.40219.1 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TGServerService", "TGServerService\TGServerService.csproj", "{F32EDA25-0855-411C-AF5E-F0D042917E2D}" EndProject @@ -79,34 +79,34 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "DMAPI", "DMAPI", "{9032B448 EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Any CPU = Debug|Any CPU - Release|Any CPU = Release|Any CPU + Debug|x86 = Debug|x86 + Release|x86 = Release|x86 EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution - {F32EDA25-0855-411C-AF5E-F0D042917E2D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {F32EDA25-0855-411C-AF5E-F0D042917E2D}.Debug|Any CPU.Build.0 = Debug|Any CPU - {F32EDA25-0855-411C-AF5E-F0D042917E2D}.Release|Any CPU.ActiveCfg = Release|Any CPU - {F32EDA25-0855-411C-AF5E-F0D042917E2D}.Release|Any CPU.Build.0 = Release|Any CPU - {394E7643-6B8C-416F-AB18-95AC12648CDC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {394E7643-6B8C-416F-AB18-95AC12648CDC}.Debug|Any CPU.Build.0 = Debug|Any CPU - {394E7643-6B8C-416F-AB18-95AC12648CDC}.Release|Any CPU.ActiveCfg = Release|Any CPU - {394E7643-6B8C-416F-AB18-95AC12648CDC}.Release|Any CPU.Build.0 = Release|Any CPU - {89191F69-B18E-4B59-B72E-E12F9B6811A0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {89191F69-B18E-4B59-B72E-E12F9B6811A0}.Debug|Any CPU.Build.0 = Debug|Any CPU - {89191F69-B18E-4B59-B72E-E12F9B6811A0}.Release|Any CPU.ActiveCfg = Release|Any CPU - {89191F69-B18E-4B59-B72E-E12F9B6811A0}.Release|Any CPU.Build.0 = Release|Any CPU - {AC4E7E8B-F83A-481C-A8B0-8FA4E8AE59AB}.Debug|Any CPU.ActiveCfg = Debug|x86 - {AC4E7E8B-F83A-481C-A8B0-8FA4E8AE59AB}.Debug|Any CPU.Build.0 = Debug|x86 - {AC4E7E8B-F83A-481C-A8B0-8FA4E8AE59AB}.Release|Any CPU.ActiveCfg = Release|x86 - {AC4E7E8B-F83A-481C-A8B0-8FA4E8AE59AB}.Release|Any CPU.Build.0 = Release|x86 - {154435F6-0890-42D4-9AEC-B743D4FBC1CB}.Debug|Any CPU.ActiveCfg = Debug|x86 - {154435F6-0890-42D4-9AEC-B743D4FBC1CB}.Debug|Any CPU.Build.0 = Debug|x86 - {154435F6-0890-42D4-9AEC-B743D4FBC1CB}.Release|Any CPU.ActiveCfg = Release|x86 - {154435F6-0890-42D4-9AEC-B743D4FBC1CB}.Release|Any CPU.Build.0 = Release|x86 - {8956D4C3-BFB9-448E-BF5F-EE7E6F9996F9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {8956D4C3-BFB9-448E-BF5F-EE7E6F9996F9}.Debug|Any CPU.Build.0 = Debug|Any CPU - {8956D4C3-BFB9-448E-BF5F-EE7E6F9996F9}.Release|Any CPU.ActiveCfg = Release|Any CPU - {8956D4C3-BFB9-448E-BF5F-EE7E6F9996F9}.Release|Any CPU.Build.0 = Release|Any CPU + {F32EDA25-0855-411C-AF5E-F0D042917E2D}.Debug|x86.ActiveCfg = Debug|x86 + {F32EDA25-0855-411C-AF5E-F0D042917E2D}.Debug|x86.Build.0 = Debug|x86 + {F32EDA25-0855-411C-AF5E-F0D042917E2D}.Release|x86.ActiveCfg = Release|x86 + {F32EDA25-0855-411C-AF5E-F0D042917E2D}.Release|x86.Build.0 = Release|x86 + {394E7643-6B8C-416F-AB18-95AC12648CDC}.Debug|x86.ActiveCfg = Debug|x86 + {394E7643-6B8C-416F-AB18-95AC12648CDC}.Debug|x86.Build.0 = Debug|x86 + {394E7643-6B8C-416F-AB18-95AC12648CDC}.Release|x86.ActiveCfg = Release|x86 + {394E7643-6B8C-416F-AB18-95AC12648CDC}.Release|x86.Build.0 = Release|x86 + {89191F69-B18E-4B59-B72E-E12F9B6811A0}.Debug|x86.ActiveCfg = Debug|x86 + {89191F69-B18E-4B59-B72E-E12F9B6811A0}.Debug|x86.Build.0 = Debug|x86 + {89191F69-B18E-4B59-B72E-E12F9B6811A0}.Release|x86.ActiveCfg = Release|x86 + {89191F69-B18E-4B59-B72E-E12F9B6811A0}.Release|x86.Build.0 = Release|x86 + {AC4E7E8B-F83A-481C-A8B0-8FA4E8AE59AB}.Debug|x86.ActiveCfg = Debug|x86 + {AC4E7E8B-F83A-481C-A8B0-8FA4E8AE59AB}.Debug|x86.Build.0 = Debug|x86 + {AC4E7E8B-F83A-481C-A8B0-8FA4E8AE59AB}.Release|x86.ActiveCfg = Release|x86 + {AC4E7E8B-F83A-481C-A8B0-8FA4E8AE59AB}.Release|x86.Build.0 = Release|x86 + {154435F6-0890-42D4-9AEC-B743D4FBC1CB}.Debug|x86.ActiveCfg = Debug|x86 + {154435F6-0890-42D4-9AEC-B743D4FBC1CB}.Debug|x86.Build.0 = Debug|x86 + {154435F6-0890-42D4-9AEC-B743D4FBC1CB}.Release|x86.ActiveCfg = Release|x86 + {154435F6-0890-42D4-9AEC-B743D4FBC1CB}.Release|x86.Build.0 = Release|x86 + {8956D4C3-BFB9-448E-BF5F-EE7E6F9996F9}.Debug|x86.ActiveCfg = Debug|x86 + {8956D4C3-BFB9-448E-BF5F-EE7E6F9996F9}.Debug|x86.Build.0 = Debug|x86 + {8956D4C3-BFB9-448E-BF5F-EE7E6F9996F9}.Release|x86.ActiveCfg = Release|x86 + {8956D4C3-BFB9-448E-BF5F-EE7E6F9996F9}.Release|x86.Build.0 = Release|x86 EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE From 63e9a2d1701df3e1df8e3bf394edbb773579f48c Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Wed, 18 Oct 2017 10:52:54 -0400 Subject: [PATCH 16/75] Fixes installer warnings about components in the same feature --- TGServiceInstaller/Product.wxs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/TGServiceInstaller/Product.wxs b/TGServiceInstaller/Product.wxs index ed5c40da2e..a43f25374b 100644 --- a/TGServiceInstaller/Product.wxs +++ b/TGServiceInstaller/Product.wxs @@ -47,11 +47,11 @@ INSTALLSHORTCUTSTART = 1 INSTALLSHORTCUTDESK = 1 From 52953455ee7f6a74097c159efdbf68ba9c449718 Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Wed, 18 Oct 2017 11:03:17 -0400 Subject: [PATCH 17/75] Fixes deploy script --- TGS3Release.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TGS3Release.ps1 b/TGS3Release.ps1 index 45b9e45737..658cbe4f99 100644 --- a/TGS3Release.ps1 +++ b/TGS3Release.ps1 @@ -1,5 +1,5 @@ $bf = $Env:APPVEYOR_BUILD_FOLDER -$src = "$bf\TGInstallerWrapper\bin\Release" +$src = "$bf\TGInstallerWrapper\bin\x86\Release" $version = [System.Diagnostics.FileVersionInfo]::GetVersionInfo("$src\TG Station Server Installer.exe").FileVersion $destination = "$bf\TGS3-Server-v$version.exe" From 2bae1975df363cbc2fef57de7486869be54a669a Mon Sep 17 00:00:00 2001 From: Jordan Brown Date: Wed, 18 Oct 2017 11:16:45 -0400 Subject: [PATCH 18/75] Fix release script --- appveyor.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/appveyor.yml b/appveyor.yml index 0bbbd54080..0768ab4f4d 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -24,7 +24,7 @@ build: after_build: - ps: .\TGS3Release.ps1 - ps: if($env:APPVEYOR_REPO_COMMIT_MESSAGE -match "\[TGSDeploy\]"){$env:TGSDeploy = "Do it."} - - ps: $env:TGSVersion = [System.Diagnostics.FileVersionInfo]::GetVersionInfo("$env:APPVEYOR_BUILD_FOLDER/TGServerService/bin/Release/TGServerService.exe").FileVersion + - ps: $env:TGSVersion = [System.Diagnostics.FileVersionInfo]::GetVersionInfo("$env:APPVEYOR_BUILD_FOLDER/TGServerService/bin/x86/Release/TGServerService.exe").FileVersion deploy: release: "tgstation-server-v$(TGSVersion)" description: 'The /tg/station server suite' From 8eef42293612857916bb29ded0493bd32daa1ac5 Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Wed, 18 Oct 2017 11:26:56 -0400 Subject: [PATCH 19/75] Fail release builds if there are warnings --- TGCommandLine/TGCommandLine.csproj | 1 + TGControlPanel/TGControlPanel.csproj | 1 + TGInstallerWrapper/TGInstallerWrapper.csproj | 1 + TGServerService/TGServerService.csproj | 1 + TGServiceInstaller/TGServiceInstaller.wixproj | 1 + TGServiceInterface/TGServiceInterface.csproj | 1 + 6 files changed, 6 insertions(+) diff --git a/TGCommandLine/TGCommandLine.csproj b/TGCommandLine/TGCommandLine.csproj index e86a0d0795..ade06b830f 100644 --- a/TGCommandLine/TGCommandLine.csproj +++ b/TGCommandLine/TGCommandLine.csproj @@ -37,6 +37,7 @@ prompt MinimumRecommendedRules.ruleset true + true diff --git a/TGControlPanel/TGControlPanel.csproj b/TGControlPanel/TGControlPanel.csproj index 3259048c4a..fdc57c2356 100644 --- a/TGControlPanel/TGControlPanel.csproj +++ b/TGControlPanel/TGControlPanel.csproj @@ -36,6 +36,7 @@ prompt MinimumRecommendedRules.ruleset true + true diff --git a/TGInstallerWrapper/TGInstallerWrapper.csproj b/TGInstallerWrapper/TGInstallerWrapper.csproj index 04e9983dcc..3d42338e3e 100644 --- a/TGInstallerWrapper/TGInstallerWrapper.csproj +++ b/TGInstallerWrapper/TGInstallerWrapper.csproj @@ -39,6 +39,7 @@ prompt MinimumRecommendedRules.ruleset true + true diff --git a/TGServerService/TGServerService.csproj b/TGServerService/TGServerService.csproj index 657a87a11b..3b0988a6a0 100644 --- a/TGServerService/TGServerService.csproj +++ b/TGServerService/TGServerService.csproj @@ -38,6 +38,7 @@ prompt MinimumRecommendedRules.ruleset true + true diff --git a/TGServiceInstaller/TGServiceInstaller.wixproj b/TGServiceInstaller/TGServiceInstaller.wixproj index d57b13bb7d..fd47e7c7f5 100644 --- a/TGServiceInstaller/TGServiceInstaller.wixproj +++ b/TGServiceInstaller/TGServiceInstaller.wixproj @@ -18,6 +18,7 @@ bin\$(Configuration)\ obj\$(Configuration)\ True + True diff --git a/TGServiceInterface/TGServiceInterface.csproj b/TGServiceInterface/TGServiceInterface.csproj index a098c77c14..d1903e5e56 100644 --- a/TGServiceInterface/TGServiceInterface.csproj +++ b/TGServiceInterface/TGServiceInterface.csproj @@ -32,6 +32,7 @@ x86 prompt MinimumRecommendedRules.ruleset + true From 1e6c34bdac4c7d139148bcbf044c5e067f619f39 Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Wed, 18 Oct 2017 11:29:05 -0400 Subject: [PATCH 20/75] Enable missing XMLdoc warnings on release builds --- TGCommandLine/TGCommandLine.csproj | 1 + TGControlPanel/TGControlPanel.csproj | 1 + TGInstallerWrapper/TGInstallerWrapper.csproj | 1 + TGServerService/TGServerService.csproj | 1 + TGServiceInterface/TGServiceInterface.csproj | 1 + 5 files changed, 5 insertions(+) diff --git a/TGCommandLine/TGCommandLine.csproj b/TGCommandLine/TGCommandLine.csproj index ade06b830f..528c4e11fd 100644 --- a/TGCommandLine/TGCommandLine.csproj +++ b/TGCommandLine/TGCommandLine.csproj @@ -38,6 +38,7 @@ MinimumRecommendedRules.ruleset true true + bin\x86\Release\TGCommandLine.xml diff --git a/TGControlPanel/TGControlPanel.csproj b/TGControlPanel/TGControlPanel.csproj index fdc57c2356..87c59e1792 100644 --- a/TGControlPanel/TGControlPanel.csproj +++ b/TGControlPanel/TGControlPanel.csproj @@ -37,6 +37,7 @@ MinimumRecommendedRules.ruleset true true + bin\x86\Release\TGControlPanel.xml diff --git a/TGInstallerWrapper/TGInstallerWrapper.csproj b/TGInstallerWrapper/TGInstallerWrapper.csproj index 3d42338e3e..7b9fa7692a 100644 --- a/TGInstallerWrapper/TGInstallerWrapper.csproj +++ b/TGInstallerWrapper/TGInstallerWrapper.csproj @@ -40,6 +40,7 @@ MinimumRecommendedRules.ruleset true true + bin\x86\Release\TG Station Server Installer.xml diff --git a/TGServerService/TGServerService.csproj b/TGServerService/TGServerService.csproj index 3b0988a6a0..48c8a5632a 100644 --- a/TGServerService/TGServerService.csproj +++ b/TGServerService/TGServerService.csproj @@ -39,6 +39,7 @@ MinimumRecommendedRules.ruleset true true + bin\x86\Release\TGServerService.xml diff --git a/TGServiceInterface/TGServiceInterface.csproj b/TGServiceInterface/TGServiceInterface.csproj index d1903e5e56..411df41cfd 100644 --- a/TGServiceInterface/TGServiceInterface.csproj +++ b/TGServiceInterface/TGServiceInterface.csproj @@ -33,6 +33,7 @@ prompt MinimumRecommendedRules.ruleset true + bin\x86\Release\TGServiceInterface.xml From c70f4bbc32dcdbd1dc0531a314d25ffcb46817dd Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Wed, 18 Oct 2017 11:52:18 -0400 Subject: [PATCH 21/75] Split up Command.cs to RootCommand.cs. Move Children definition to RootCommand. Add docs to Command --- TGServiceInterface/Command.cs | 136 ++++++++----------- TGServiceInterface/TGServiceInterface.csproj | 1 + 2 files changed, 55 insertions(+), 82 deletions(-) diff --git a/TGServiceInterface/Command.cs b/TGServiceInterface/Command.cs index ebdcefac50..7354451202 100644 --- a/TGServiceInterface/Command.cs +++ b/TGServiceInterface/Command.cs @@ -4,118 +4,90 @@ using System.Threading; namespace TGServiceInterface { + /// + /// Exit codes for s + /// public enum ExitCode { + /// + /// The ran successfully + /// Normal = 0, + /// + /// The connection to the service was interrupted during the + /// ConnectionError = 1, + /// + /// Invalid parameters for + /// BadCommand = 2, + /// + /// The command failed due to conditions on the service + /// ServerError = 3, } + + /// + /// Helper for creating a text tree + /// public abstract class Command { + /// + /// Proc that will show a message to the invoker. Do not call directly, use instead + /// public static ThreadLocal> OutputProcVar = new ThreadLocal>(); + /// + /// Write output to the invoker + /// + /// The output to display protected static void OutputProc(string message) { OutputProcVar.Value(message); } + /// + /// The text that invokes this . Set in constructor + /// public string Keyword { get; protected set; } - public Command[] Children { get; protected set; } = { }; + /// + /// The number of parameters this requires. Set in Constructor + /// public int RequiredParameters { get; protected set; } + /// + /// Caller of , can be used to modify the root behaviour of the + /// + /// List of parameters passed to the + /// public virtual ExitCode DoRun(IList parameters) { return Run(parameters); } + /// + /// Override to do the actions of the + /// + /// List of parameters passed to the . Guaranteed to have at least non-empty/whitespace entries + /// An describing the execution of the protected abstract ExitCode Run(IList parameters); + /// + /// Prints usage text of the to the invoker + /// public virtual void PrintHelp() { var argstr = GetArgumentString(); OutputProc(String.Format("{0} {1}- {2}", Keyword, argstr.Length > 0 ? argstr + " " : "", GetHelpText())); } + /// + /// Override to add argument text to the + /// Format is <required> <arguments> [optional] [arguments] + /// + /// Formatted argument text for the public virtual string GetArgumentString() { return ""; } + /// + /// Override to add usage text to the + /// + /// Formatted usage text for the public abstract string GetHelpText(); } - - public class RootCommand : Command - { - public static bool PrintHelpList = false; - protected override ExitCode Run(IList parameters) - { - if (parameters.Count > 0) - { - var LocalKeyword = parameters[0].Trim().ToLower(); - parameters.RemoveAt(0); - switch (LocalKeyword) - { - case "help": - case "?": - PrintHelp(); - return ExitCode.Normal; - default: - foreach (var c in Children) - if (c.Keyword == LocalKeyword) - { - if(parameters.Count> 0) - { - var possibleHelp = parameters[0].ToLower(); - if (possibleHelp == "help" || possibleHelp == "?") - { - c.PrintHelp(); - return ExitCode.Normal; - } - } - if (parameters.Count < c.RequiredParameters) - { - OutputProc("Not enough parameters!"); - return ExitCode.BadCommand; - } - return c.DoRun(parameters); - } - parameters.Insert(0, LocalKeyword); - break; - } - } - OutputProc(String.Format("Invalid command! Type '{0}?' or '{0}help' for available commands.", Keyword != null ? Keyword + " " : "")); - return ExitCode.BadCommand; - } - public override void PrintHelp() - { - var Final = new List(); - if (PrintHelpList) - { - foreach (var c in Children) - Final.Add(c.Keyword); - OutputProc("Available commands (type '?' or 'help' after command for more info): " + String.Join(", ", Final)); - } - else - { - var Prefixes = new List(); - var Postfixes = new List(); - int MaxPrefixLen = 0; - foreach (var c in Children) - { - var ns = c.Keyword + " " + c.GetArgumentString(); - MaxPrefixLen = Math.Max(MaxPrefixLen, ns.Length); - Prefixes.Add(ns); - Postfixes.Add(c.GetHelpText()); - } - - for (var I = 0; I < Prefixes.Count; ++I) - { - var lp = Prefixes[I]; - for (; lp.Length < MaxPrefixLen + 1; lp += " ") ; - Final.Add(lp + "- " + Postfixes[I]); - } - Final.Sort(); - Final.ForEach(OutputProc); - } - } - - public override string GetHelpText() - { - throw new NotImplementedException(); - } - } } diff --git a/TGServiceInterface/TGServiceInterface.csproj b/TGServiceInterface/TGServiceInterface.csproj index 411df41cfd..25feb1ec2d 100644 --- a/TGServiceInterface/TGServiceInterface.csproj +++ b/TGServiceInterface/TGServiceInterface.csproj @@ -58,6 +58,7 @@ + From 667292313ad6de18245a577d25dd46ef459ff356 Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Wed, 18 Oct 2017 12:04:16 -0400 Subject: [PATCH 22/75] Document RootCommand.cs --- TGServiceInterface/Command.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TGServiceInterface/Command.cs b/TGServiceInterface/Command.cs index 7354451202..48282a1ffb 100644 --- a/TGServiceInterface/Command.cs +++ b/TGServiceInterface/Command.cs @@ -56,7 +56,7 @@ namespace TGServiceInterface /// Caller of , can be used to modify the root behaviour of the /// /// List of parameters passed to the - /// + /// An describing the execution of the public virtual ExitCode DoRun(IList parameters) { return Run(parameters); From 7a4a90d8243d4e4c17119873fb52b531ffd62329 Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Wed, 18 Oct 2017 12:14:17 -0400 Subject: [PATCH 23/75] Documents Helpers.cs --- TGServiceInterface/Helpers.cs | 29 ++++++++++++++++++++++------- 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/TGServiceInterface/Helpers.cs b/TGServiceInterface/Helpers.cs index 6d8e3e0f70..c5435c70a4 100644 --- a/TGServiceInterface/Helpers.cs +++ b/TGServiceInterface/Helpers.cs @@ -4,26 +4,41 @@ using System.Text; namespace TGServiceInterface { + /// + /// Helper functions used across the server suite + /// public static class Helpers { - public static string EncryptData(string data, out string sentropy) + /// + /// Takes some and returns an encrypted version along with the required to decrypt it + /// + /// The to encrypt + /// The entropy required the decrypt the ciphertext + /// Ciphertext for the + public static string EncryptData(string cleartext, out string entropy) { // Generate additional entropy (will be used as the Initialization vector) - byte[] entropy = new byte[20]; + byte[] bentropy = new byte[20]; using (var rng = new RNGCryptoServiceProvider()) - rng.GetBytes(entropy); + rng.GetBytes(bentropy); - byte[] ciphertext = ProtectedData.Protect(Encoding.UTF8.GetBytes(data), entropy, DataProtectionScope.CurrentUser); + byte[] ciphertext = ProtectedData.Protect(Encoding.UTF8.GetBytes(data), bentropy, DataProtectionScope.CurrentUser); - sentropy = Convert.ToBase64String(entropy, 0, entropy.Length); + entropy = Convert.ToBase64String(bentropy, 0, bentropy.Length); return Convert.ToBase64String(ciphertext, 0, ciphertext.Length); } - public static string DecryptData(string data, string entropy) + /// + /// Takes ciphertext and entropy from and returns the cleartext. Note that this only works if the OS user of the program is the same one that called + /// + /// A return value from a previous call to + /// The entropy parameter from the previous call to that returned + /// The decrypted on sucess or on failure + public static string DecryptData(string ciphertext, string entropy) { try { - return Encoding.UTF8.GetString(ProtectedData.Unprotect(Convert.FromBase64String(data), Convert.FromBase64String(entropy), DataProtectionScope.CurrentUser)); + return Encoding.UTF8.GetString(ProtectedData.Unprotect(Convert.FromBase64String(ciphertext), Convert.FromBase64String(entropy), DataProtectionScope.CurrentUser)); } catch { From 38f30945824cb20f2193410009abb1bdabc10ef8 Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Wed, 18 Oct 2017 12:49:33 -0400 Subject: [PATCH 24/75] Document Server.cs --- TGControlPanel/Login.cs | 3 ++ TGControlPanel/Main.cs | 6 +++ TGControlPanel/Program.cs | 1 - TGInstallerWrapper/Main.cs | 3 ++ TGServerService/ProcessExtension.cs | 13 +++++- TGServerService/Program.cs | 2 +- TGServerService/ProjectInstaller.cs | 3 +- TGServiceInterface/Helpers.cs | 2 +- TGServiceInterface/Server.cs | 66 ++++++++++++++++++++--------- 9 files changed, 74 insertions(+), 25 deletions(-) diff --git a/TGControlPanel/Login.cs b/TGControlPanel/Login.cs index 557d484924..c09f9ac8aa 100644 --- a/TGControlPanel/Login.cs +++ b/TGControlPanel/Login.cs @@ -6,6 +6,9 @@ namespace TGControlPanel { public partial class Login : Form { + /// + /// Create a + /// public Login() { InitializeComponent(); diff --git a/TGControlPanel/Main.cs b/TGControlPanel/Main.cs index 969e926771..07e62f8b0a 100644 --- a/TGControlPanel/Main.cs +++ b/TGControlPanel/Main.cs @@ -5,8 +5,14 @@ using TGServiceInterface; namespace TGControlPanel { + /// + /// The main form + /// public partial class Main : Form { + /// + /// Create the control panel. Requires the has had it's connection info setup + /// public Main() { InitializeComponent(); diff --git a/TGControlPanel/Program.cs b/TGControlPanel/Program.cs index d5c1ee1988..12753f1962 100644 --- a/TGControlPanel/Program.cs +++ b/TGControlPanel/Program.cs @@ -1,5 +1,4 @@ using System; -using System.Runtime.InteropServices; using System.Windows.Forms; using TGServiceInterface; diff --git a/TGInstallerWrapper/Main.cs b/TGInstallerWrapper/Main.cs index e8fbd719d2..de713fcfb1 100644 --- a/TGInstallerWrapper/Main.cs +++ b/TGInstallerWrapper/Main.cs @@ -33,6 +33,9 @@ namespace TGInstallerWrapper bool cancelled = false; bool pathIsDefault = true; + /// + /// Construct an installer form + /// public Main() { InitializeComponent(); diff --git a/TGServerService/ProcessExtension.cs b/TGServerService/ProcessExtension.cs index 3fc590b89b..cae8cb43f3 100644 --- a/TGServerService/ProcessExtension.cs +++ b/TGServerService/ProcessExtension.cs @@ -4,7 +4,9 @@ using System.Runtime.InteropServices; namespace TGServerService { - //lightly massaged code from https://stackoverflow.com/a/13109774 + /// + /// Helpers to ing and a . Lightly massaged code from https://stackoverflow.com/a/13109774 + /// public static class ProcessExtension { enum ThreadAccess : int @@ -29,6 +31,10 @@ namespace TGServerService [DllImport("kernel32.dll")] static extern int ResumeThread(IntPtr hThread); + /// + /// Suspends all threads for a running + /// + /// The to suspend public static void Suspend(this Process process) { foreach (ProcessThread thread in process.Threads) @@ -40,6 +46,11 @@ namespace TGServerService CloseHandle(pOpenThread); } } + + /// + /// Resumes all threads for a running + /// + /// The to suspend public static void Resume(this Process process) { foreach (ProcessThread thread in process.Threads) diff --git a/TGServerService/Program.cs b/TGServerService/Program.cs index ef6ab4bfc1..3a03de02f0 100644 --- a/TGServerService/Program.cs +++ b/TGServerService/Program.cs @@ -4,7 +4,7 @@ using System.IO; namespace TGServerService { - public static class Program + static class Program { static void Main() => new TGServerService(); //wondows diff --git a/TGServerService/ProjectInstaller.cs b/TGServerService/ProjectInstaller.cs index 3c405c0328..0580a2c6b7 100644 --- a/TGServerService/ProjectInstaller.cs +++ b/TGServerService/ProjectInstaller.cs @@ -1,11 +1,10 @@ using System.ComponentModel; using System.Configuration.Install; -using System.ServiceProcess; namespace ServerService { [RunInstaller(true)] - public partial class ProjectInstaller : Installer + partial class ProjectInstaller : Installer { public ProjectInstaller() { diff --git a/TGServiceInterface/Helpers.cs b/TGServiceInterface/Helpers.cs index c5435c70a4..471d84ccfd 100644 --- a/TGServiceInterface/Helpers.cs +++ b/TGServiceInterface/Helpers.cs @@ -22,7 +22,7 @@ namespace TGServiceInterface using (var rng = new RNGCryptoServiceProvider()) rng.GetBytes(bentropy); - byte[] ciphertext = ProtectedData.Protect(Encoding.UTF8.GetBytes(data), bentropy, DataProtectionScope.CurrentUser); + byte[] ciphertext = ProtectedData.Protect(Encoding.UTF8.GetBytes(cleartext), bentropy, DataProtectionScope.CurrentUser); entropy = Convert.ToBase64String(bentropy, 0, bentropy.Length); return Convert.ToBase64String(ciphertext, 0, ciphertext.Length); diff --git a/TGServiceInterface/Server.cs b/TGServiceInterface/Server.cs index a0bf48284b..5a656e5e3e 100644 --- a/TGServiceInterface/Server.cs +++ b/TGServiceInterface/Server.cs @@ -7,10 +7,13 @@ using System.Security.Principal; using System.ServiceModel; namespace TGServiceInterface { + /// + /// Main inteface class for the service + /// public class Server { /// - /// List of types that can be used with GetComponen + /// List of s that can be used with GetComponen /// public static readonly IList ValidInterfaces = new List { typeof(ITGByond), typeof(ITGChat), typeof(ITGCompiler), typeof(ITGConfig), typeof(ITGDreamDaemon), typeof(ITGRepository), typeof(ITGSService), typeof(ITGConnectivity), typeof(ITGAdministration), typeof(ITGInterop) }; @@ -50,7 +53,15 @@ namespace TGServiceInterface /// static string HTTPSPassword; + /// + /// Associated list of open s keyed by type. A in this list may close or fault at any time. Must be locked before being accessed + /// static Dictionary ChannelFactoryCache = new Dictionary(); + + /// + /// Sets the function called when a remote login fails due to the server having an invalid SSL cert + /// + /// The to be called when a remote login is attempted while the server posesses a bad certificate. Passed a of error information about the and should return if it the connection should be made anyway public static void SetBadCertificateHandler(Func handler) { ServicePointManager.ServerCertificateValidationCallback = (sender, cert, chain, error) => @@ -88,17 +99,28 @@ namespace TGServiceInterface ClearCachedChannels(); } + /// + /// Closes all s stored in and clears it + /// static void ClearCachedChannels() { - foreach (var I in ChannelFactoryCache) - CloseChannel(I.Value); - ChannelFactoryCache.Clear(); + lock (ChannelFactoryCache) + { + foreach (var I in ChannelFactoryCache) + CloseChannel(I.Value); + ChannelFactoryCache.Clear(); + } } + /// + /// Returns if the interface being used to connect to a service does not have the same release version as the service + /// + /// An error message to display to the user should this function return + /// if the interface being used to connect to a service does not have the same release version as the service public static bool VersionMismatch(out string errorMessage) { - var splits = Server.GetComponent().Version().Split(' '); - var theirs = new Version(splits[splits.Length - 1].Substring(1)); + var splits = Server.GetComponent().Version().Split(' '); + var theirs = new Version(splits[splits.Length - 1].Substring(1)); var ours = new Version(FileVersionInfo.GetVersionInfo(System.Reflection.Assembly.GetExecutingAssembly().Location).FileVersion); if(theirs != ours) { @@ -123,6 +145,10 @@ namespace TGServiceInterface ClearCachedChannels(); } + /// + /// Safely shuts down a single + /// + /// public static void CloseChannel(ChannelFactory cf) { try @@ -136,10 +162,10 @@ namespace TGServiceInterface } /// - /// Returns the requested server component interface. This does not guarantee a successful connection + /// Returns the requested component . This does not guarantee a successful connection. s created this way are recycled for minimum latency and bandwidth usage /// - /// The type of the component to retrieve - /// The correct component + /// The component to retrieve + /// The correct component public static T GetComponent() { var tot = typeof(T); @@ -166,6 +192,12 @@ namespace TGServiceInterface return cf.CreateChannel(); } + /// + /// Directly creates a for without caching. This should be eventually closed by the caller + /// + /// The component of the channel to be created + /// The correct + /// Thrown if isn't a valid component public static ChannelFactory CreateChannel() { var ToT = typeof(T); @@ -201,11 +233,9 @@ namespace TGServiceInterface } /// - /// Used to test if the service is avaiable on the machine - /// Note that state can technically change at any time - /// and any call to the service may throw an exception because it failed + /// Used to test if the service is avaiable on the machine. Note that state can technically change at any time and any call to the service may throw an exception because it failed /// - /// null on successful connection, error message on failure + /// on successful connection, error message on failure public static string VerifyConnection() { try @@ -220,10 +250,9 @@ namespace TGServiceInterface } /// - /// As opposed to VerifyConnection(), this check user credentials - /// Requires a prior call to + /// Checks if the supplied user's credentials have permission to use the service. Requires a successful prior call to /// - /// true if credentials are valid, false otherwise + /// if credentials are valid, otherwise public static bool Authenticate() { try @@ -238,10 +267,9 @@ namespace TGServiceInterface } /// - /// As opposed to Authentication() this returns true if the current login can use the interface. - /// Requires a prior call to + /// Checks if the current login can use . Requires a successful prior call to /// - /// true if the connection may use the interface, false otherwise + /// if the connection may use , otherwise public static bool AuthenticateAdmin() { try From d72dde6886bb6e3087631711dffa6a3983d441fd Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Wed, 18 Oct 2017 13:00:31 -0400 Subject: [PATCH 25/75] Reflection method for determining valid interfaces --- TGServiceInterface/Server.cs | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/TGServiceInterface/Server.cs b/TGServiceInterface/Server.cs index a0bf48284b..0a09c88ed1 100644 --- a/TGServiceInterface/Server.cs +++ b/TGServiceInterface/Server.cs @@ -1,10 +1,13 @@ using System; using System.Collections.Generic; using System.Diagnostics; +using System.Linq; using System.Net; using System.Net.Security; +using System.Reflection; using System.Security.Principal; using System.ServiceModel; + namespace TGServiceInterface { public class Server @@ -12,7 +15,7 @@ namespace TGServiceInterface /// /// List of types that can be used with GetComponen /// - public static readonly IList ValidInterfaces = new List { typeof(ITGByond), typeof(ITGChat), typeof(ITGCompiler), typeof(ITGConfig), typeof(ITGDreamDaemon), typeof(ITGRepository), typeof(ITGSService), typeof(ITGConnectivity), typeof(ITGAdministration), typeof(ITGInterop) }; + public static readonly IList ValidInterfaces = CollectComponents(); /// /// The maximum message size to and from a local server @@ -51,6 +54,22 @@ namespace TGServiceInterface static string HTTPSPassword; static Dictionary ChannelFactoryCache = new Dictionary(); + + /// + /// Returns a of s that can be used with the service + /// + /// A of s that can be used with the service + static IList CollectComponents() + { + //find all interfaces in this assembly in this namespace that have the service contract attribute + var query = from t in Assembly.GetExecutingAssembly().GetTypes() + where t.IsInterface + && t.Namespace == typeof(Server).Namespace + && t.GetCustomAttribute(typeof(ServiceContractAttribute)) != null + select t; + return query.ToList(); + } + public static void SetBadCertificateHandler(Func handler) { ServicePointManager.ServerCertificateValidationCallback = (sender, cert, chain, error) => @@ -97,8 +116,8 @@ namespace TGServiceInterface public static bool VersionMismatch(out string errorMessage) { - var splits = Server.GetComponent().Version().Split(' '); - var theirs = new Version(splits[splits.Length - 1].Substring(1)); + var splits = Server.GetComponent().Version().Split(' '); + var theirs = new Version(splits[splits.Length - 1].Substring(1)); var ours = new Version(FileVersionInfo.GetVersionInfo(System.Reflection.Assembly.GetExecutingAssembly().Location).FileVersion); if(theirs != ours) { From 351dfd830cea4fb62d05bcd3907281574127ccd4 Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Wed, 18 Oct 2017 13:26:54 -0400 Subject: [PATCH 26/75] Documents and splits up Chat.cs into ChatProvider.cs --- TGServiceInterface/Chat.cs | 364 +----------------- TGServiceInterface/ChatProvider.cs | 367 +++++++++++++++++++ TGServiceInterface/RootCommand.cs | 105 ++++++ TGServiceInterface/TGServiceInterface.csproj | 1 + 4 files changed, 480 insertions(+), 357 deletions(-) create mode 100644 TGServiceInterface/ChatProvider.cs create mode 100644 TGServiceInterface/RootCommand.cs diff --git a/TGServiceInterface/Chat.cs b/TGServiceInterface/Chat.cs index cfdab6d228..0868f56999 100644 --- a/TGServiceInterface/Chat.cs +++ b/TGServiceInterface/Chat.cs @@ -1,357 +1,8 @@ -using System; -using System.Collections.Generic; -using System.Runtime.Serialization; +using System.Collections.Generic; using System.ServiceModel; -using System.Web.Script.Serialization; namespace TGServiceInterface { - /// - /// The type of chat provider - /// - public enum TGChatProvider : int - { - /// - /// IRC chat provider - /// - IRC = 0, - /// - /// Discord chat provider - /// - Discord = 1, - } - - /// - /// Supported irc permission modes - /// - public enum IRCMode : int - { - /// - /// + - /// - Voice, - /// - /// % - /// - Halfop, - /// - /// @ - /// - Op, - /// - /// ~ - /// - Owner, - } - - /// - /// For setting up authentication no matter the chat provider - /// - [DataContract] - [KnownType(typeof(TGIRCSetupInfo))] - [KnownType(typeof(TGDiscordSetupInfo))] - public class TGChatSetupInfo - { - const int AdminListIndex = 0; - const int AdminModeIndex = 1; - const int AdminChannelIndex = 2; - const int DevChannelIndex = 3; - const int WDChannelIndex = 4; - const int GameChannelIndex = 5; - const int ProviderIndex = 6; - const int EnabledIndex = 7; - protected const int BaseIndex = 8; - protected readonly bool InitializeFields; - /// - /// Constructs a TGChatSetupInfo from optional past data - /// - /// Optional past data - /// The number of fields in this chat provider - protected TGChatSetupInfo(TGChatSetupInfo baseInfo, int numFields) - { - numFields += BaseIndex; - InitializeFields = baseInfo == null || baseInfo.DataFields.Count != numFields; - - if (InitializeFields) - { - DataFields = new List(numFields); - for (var I = 0; I < numFields; ++I) - DataFields.Add(null); - - AdminList = new List(); - AdminChannels = new List(); - DevChannels = new List(); - GameChannels = new List(); - WatchdogChannels = new List(); - AdminsAreSpecial = false; - Enabled = false; - } - else - DataFields = baseInfo.DataFields; - } - - TGChatSetupInfo Specialize() - { - switch (Provider) - { - case TGChatProvider.IRC: - return new TGIRCSetupInfo(this); - case TGChatProvider.Discord: - return new TGDiscordSetupInfo(this); - default: - throw new Exception("Invalid provider!"); - } - } - - //trims and adds the leading # - protected virtual string SanitizeChannelName(string working) - { - return Specialize().SanitizeChannelName(working); - } - void SanitizeChannelNames(IList working) - { - for (var I = 0; I < working.Count; ++I) - - if (String.IsNullOrWhiteSpace(working[I])) - { - working.RemoveAt(I); - --I; - } - else - working[I] = SanitizeChannelName(working[I].Trim()); - } - - /// - /// Constructs a TGChatSetupInfo from a data list - /// - /// The data - /// The chat provider - public TGChatSetupInfo(IList DeserializedData) - { - DataFields = DeserializedData; - } - /// - /// The list of admin entries - /// - public IList AdminList - { - get { return new JavaScriptSerializer().Deserialize>(DataFields[AdminListIndex]); } - set { DataFields[AdminListIndex] = new JavaScriptSerializer().Serialize(value); } - } - /// - /// If AdminList corresponds to a Provider specific recognization method - /// - public bool AdminsAreSpecial - { - get { return Convert.ToBoolean(DataFields[AdminModeIndex]); } - set { DataFields[AdminModeIndex] = Convert.ToString(value); } - } - /// - /// The channels from which admin commands/messages can be sent/received - /// - public IList AdminChannels - { - get { return new JavaScriptSerializer().Deserialize>(DataFields[AdminChannelIndex]); } - set - { - SanitizeChannelNames(value); - DataFields[AdminChannelIndex] = new JavaScriptSerializer().Serialize(value); - } - } - /// - /// The channels to which repo and compile messages are sent - /// - public IList DevChannels - { - get { return new JavaScriptSerializer().Deserialize>(DataFields[DevChannelIndex]); } - set - { - SanitizeChannelNames(value); - DataFields[DevChannelIndex] = new JavaScriptSerializer().Serialize(value); - } - } - /// - /// The channels to which watchdog messages are sent - /// - public IList WatchdogChannels - { - get { return new JavaScriptSerializer().Deserialize>(DataFields[WDChannelIndex]); } - set - { - SanitizeChannelNames(value); - DataFields[WDChannelIndex] = new JavaScriptSerializer().Serialize(value); - } - } - /// - /// The channels to which game messages are sent - /// - public IList GameChannels - { - get { return new JavaScriptSerializer().Deserialize>(DataFields[GameChannelIndex]); } - set - { - SanitizeChannelNames(value); - DataFields[GameChannelIndex] = new JavaScriptSerializer().Serialize(value); - } - } - /// - /// If this chat provider is enabled - /// - public bool Enabled - { - get { return Convert.ToBoolean(DataFields[EnabledIndex]); } - set { DataFields[EnabledIndex] = Convert.ToString(value); } - } - - /// - /// The type of provider - /// - public TGChatProvider Provider - { - get { return (TGChatProvider)Convert.ToInt32(DataFields[ProviderIndex]); } - set { DataFields[ProviderIndex] = Convert.ToString((int)value); } - } - - /// - /// Raw access to the underlying data - /// - [DataMember] - public IList DataFields { get; protected set; } - } - - /// - /// Chat provider for IRC - /// Admin entries should be user nicknames in normal mode or required flags in special mode - /// - [DataContract] - public class TGIRCSetupInfo : TGChatSetupInfo - { - const int URLIndex = 0; - const int PortIndex = 1; - const int NickIndex = 2; - const int AuthTargetIndex = 3; - const int AuthMessageIndex = 4; - const int AuthLevelIndex = 5; - const int FieldsLen = 6; - - /// - /// Construct IRC setup info from optional generic info. Defaults to TGS3 on rizons IRC server - /// - /// Optional generic info - public TGIRCSetupInfo(TGChatSetupInfo baseInfo = null) : base(baseInfo, FieldsLen) - { - Provider = TGChatProvider.IRC; - if (InitializeFields) - { - Nickname = "TGS3"; - URL = "irc.rizon.net"; - Port = 6667; - AuthTarget = ""; - AuthMessage = ""; - AdminsAreSpecial = true; - AuthLevel = IRCMode.Op; - } - } - - protected override string SanitizeChannelName(string working) - { - if (working[0] != '#') - return "#" + working; - return working; - } - - /// - /// The port of the IRC server - /// - public ushort Port { - get { return Convert.ToUInt16(DataFields[BaseIndex + PortIndex]); } - set { DataFields[BaseIndex + PortIndex] = value.ToString(); } - } - /// - /// The URL of the IRC server - /// - public string URL - { - get { return DataFields[BaseIndex + URLIndex]; } - set { DataFields[BaseIndex + URLIndex] = value; } - } - /// - /// The nickname of the IRC bot - /// - public string Nickname - { - get { return DataFields[BaseIndex + NickIndex]; } - set { DataFields[BaseIndex + NickIndex] = value; } - } - /// - /// The target for sending authentication messages - /// - public string AuthTarget - { - get { return DataFields[BaseIndex + AuthTargetIndex]; } - set { DataFields[BaseIndex + AuthTargetIndex] = value; } - } - /// - /// The authentication message - /// - public string AuthMessage - { - get { return DataFields[BaseIndex + AuthMessageIndex]; } - set { DataFields[BaseIndex + AuthMessageIndex] = value; } - } - /// - /// The minimum mode required to use admin bot commands when in special auth mode - /// - public IRCMode AuthLevel - { - get { return (IRCMode)Convert.ToInt32(DataFields[BaseIndex + AuthLevelIndex]); } - set { DataFields[BaseIndex + AuthLevelIndex] = Convert.ToString((int)value); } - } - } - - /// - /// Chat provider for Discord - /// Admin entires should be user ids in normal mode or group ids in special mode - /// - [DataContract] - public class TGDiscordSetupInfo : TGChatSetupInfo - { - const int BotTokenIndex = 0; - const int FieldsLen = 1; - /// - /// Construct Discord setup info from optional generic info. Default is not a valid discord bot tokent - /// - /// Optional generic info - public TGDiscordSetupInfo(TGChatSetupInfo baseInfo = null) : base(baseInfo, FieldsLen) - { - Provider = TGChatProvider.Discord; - if (InitializeFields) - BotToken = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"; //needless to say, this is fake - } - protected override string SanitizeChannelName(string working) - { - working = working.Replace("<", "").Replace(">", "").Replace("&", ""); //filter out some stuff that can come in the copypasta - try - { - Convert.ToUInt64(working); - } - catch - { - throw new Exception("Invalid Discord channel ID!"); - } - return working; - } - - /// - /// The Discord bot token to use. See https://discordapp.com/developers/applications/me for registering bot accounts - /// - public string BotToken - { - get { return DataFields[BaseIndex + BotTokenIndex]; } - set { DataFields[BaseIndex + BotTokenIndex] = value; } - } - } - /// /// Interface for handling chat bot /// @@ -359,16 +10,15 @@ namespace TGServiceInterface public interface ITGChat { /// - /// Set the chat provider info + /// Sets a chat provider /// /// The info to set [OperationContract] string SetProviderInfo(TGChatSetupInfo info); /// - /// Returns the chat provider info + /// Returns for all s /// - /// The type of provider to get info for - /// The chat provider info for the selected provider + /// A list of all s [OperationContract] IList ProviderInfos(); @@ -376,15 +26,15 @@ namespace TGServiceInterface /// Checks connection status /// /// The type of provider to check if connected - /// true if connected, false otherwise + /// if connected, otherwise [OperationContract] bool Connected(TGChatProvider providerType); /// - /// Reconnect to the chat service + /// Reconnect a specific to it's chat service /// /// The type of provider to reconnect - /// null on success, error message on failure + /// on success, error message on failure [OperationContract] string Reconnect(TGChatProvider providerType); } diff --git a/TGServiceInterface/ChatProvider.cs b/TGServiceInterface/ChatProvider.cs new file mode 100644 index 0000000000..5c28f5b1c8 --- /dev/null +++ b/TGServiceInterface/ChatProvider.cs @@ -0,0 +1,367 @@ +using System; +using System.Collections.Generic; +using System.Runtime.Serialization; +using System.Web.Script.Serialization; + +namespace TGServiceInterface +{ + /// + /// The type of chat provider + /// + public enum TGChatProvider : int + { + /// + /// IRC chat provider + /// + IRC = 0, + /// + /// Discord chat provider + /// + Discord = 1, + } + + /// + /// Supported irc permission modes + /// + public enum IRCMode : int + { + /// + /// + + /// + Voice, + /// + /// % + /// + Halfop, + /// + /// @ + /// + Op, + /// + /// ~ + /// + Owner, + } + + /// + /// For setting up authentication no matter the chat provider + /// + [DataContract] + [KnownType(typeof(TGIRCSetupInfo))] + [KnownType(typeof(TGDiscordSetupInfo))] + public class TGChatSetupInfo + { + const int AdminListIndex = 0; + const int AdminModeIndex = 1; + const int AdminChannelIndex = 2; + const int DevChannelIndex = 3; + const int WDChannelIndex = 4; + const int GameChannelIndex = 5; + const int ProviderIndex = 6; + const int EnabledIndex = 7; + protected const int BaseIndex = 8; + protected readonly bool InitializeFields; + /// + /// Constructs a from optional + /// + /// Optional past data + /// The number of fields in this chat provider + protected TGChatSetupInfo(TGChatSetupInfo baseInfo, int numFields) + { + numFields += BaseIndex; + InitializeFields = baseInfo == null || baseInfo.DataFields.Count != numFields; + + if (InitializeFields) + { + DataFields = new List(numFields); + for (var I = 0; I < numFields; ++I) + DataFields.Add(null); + + AdminList = new List(); + AdminChannels = new List(); + DevChannels = new List(); + GameChannels = new List(); + WatchdogChannels = new List(); + AdminsAreSpecial = false; + Enabled = false; + } + else + DataFields = baseInfo.DataFields; + } + + /// + /// Recreates as the correct child + /// + /// A new based on the type + TGChatSetupInfo Specialize() + { + switch (Provider) + { + case TGChatProvider.IRC: + return new TGIRCSetupInfo(this); + case TGChatProvider.Discord: + return new TGDiscordSetupInfo(this); + default: + throw new Exception("Invalid provider!"); + } + } + + /// + /// Properly formats a name for the + /// + /// The to format + /// The formatted + protected virtual string SanitizeChannelName(string channel) + { + return Specialize().SanitizeChannelName(channel); + } + + /// + /// Sanitizes a list of + /// + /// An of strings + void SanitizeChannelNames(IList channelnames) + { + for (var I = 0; I < channelnames.Count; ++I) + + if (String.IsNullOrWhiteSpace(channelnames[I])) + { + channelnames.RemoveAt(I); + --I; + } + else + channelnames[I] = SanitizeChannelName(channelnames[I].Trim()); + } + + /// + /// Constructs a from a data list + /// + /// The data + /// The chat provider + public TGChatSetupInfo(IList DeserializedData) + { + DataFields = DeserializedData; + } + /// + /// The list of admin entries + /// + public IList AdminList + { + get { return new JavaScriptSerializer().Deserialize>(DataFields[AdminListIndex]); } + set { DataFields[AdminListIndex] = new JavaScriptSerializer().Serialize(value); } + } + /// + /// If AdminList corresponds to a Provider specific recognization method + /// + public bool AdminsAreSpecial + { + get { return Convert.ToBoolean(DataFields[AdminModeIndex]); } + set { DataFields[AdminModeIndex] = Convert.ToString(value); } + } + /// + /// The channels from which admin commands/messages can be sent/received + /// + public IList AdminChannels + { + get { return new JavaScriptSerializer().Deserialize>(DataFields[AdminChannelIndex]); } + set + { + SanitizeChannelNames(value); + DataFields[AdminChannelIndex] = new JavaScriptSerializer().Serialize(value); + } + } + /// + /// The channels to which repo and compile messages are sent + /// + public IList DevChannels + { + get { return new JavaScriptSerializer().Deserialize>(DataFields[DevChannelIndex]); } + set + { + SanitizeChannelNames(value); + DataFields[DevChannelIndex] = new JavaScriptSerializer().Serialize(value); + } + } + /// + /// The channels to which watchdog messages are sent + /// + public IList WatchdogChannels + { + get { return new JavaScriptSerializer().Deserialize>(DataFields[WDChannelIndex]); } + set + { + SanitizeChannelNames(value); + DataFields[WDChannelIndex] = new JavaScriptSerializer().Serialize(value); + } + } + /// + /// The channels to which game messages are sent + /// + public IList GameChannels + { + get { return new JavaScriptSerializer().Deserialize>(DataFields[GameChannelIndex]); } + set + { + SanitizeChannelNames(value); + DataFields[GameChannelIndex] = new JavaScriptSerializer().Serialize(value); + } + } + /// + /// If this chat provider is enabled + /// + public bool Enabled + { + get { return Convert.ToBoolean(DataFields[EnabledIndex]); } + set { DataFields[EnabledIndex] = Convert.ToString(value); } + } + + /// + /// The type of provider + /// + public TGChatProvider Provider + { + get { return (TGChatProvider)Convert.ToInt32(DataFields[ProviderIndex]); } + set { DataFields[ProviderIndex] = Convert.ToString((int)value); } + } + + /// + /// Raw access to the underlying data + /// + [DataMember] + public IList DataFields { get; protected set; } + } + + /// + /// Chat provider for IRC. Admin entries should be user nicknames in normal mode or required channel flags in special mode + /// + [DataContract] + public sealed class TGIRCSetupInfo : TGChatSetupInfo + { + const int URLIndex = 0; + const int PortIndex = 1; + const int NickIndex = 2; + const int AuthTargetIndex = 3; + const int AuthMessageIndex = 4; + const int AuthLevelIndex = 5; + const int FieldsLen = 6; + + /// + /// Construct IRC setup info from optional generic info. Defaults to TGS3 on rizons IRC server + /// + /// Optional generic info + public TGIRCSetupInfo(TGChatSetupInfo baseInfo = null) : base(baseInfo, FieldsLen) + { + Provider = TGChatProvider.IRC; + if (InitializeFields) + { + Nickname = "TGS3"; + URL = "irc.rizon.net"; + Port = 6667; + AuthTarget = ""; + AuthMessage = ""; + AdminsAreSpecial = true; + AuthLevel = IRCMode.Op; + } + } + + /// + protected override string SanitizeChannelName(string working) + { + if (working[0] != '#') + return "#" + working; + return working; + } + + /// + /// The port of the IRC server + /// + public ushort Port + { + get { return Convert.ToUInt16(DataFields[BaseIndex + PortIndex]); } + set { DataFields[BaseIndex + PortIndex] = value.ToString(); } + } + /// + /// The URL of the IRC server + /// + public string URL + { + get { return DataFields[BaseIndex + URLIndex]; } + set { DataFields[BaseIndex + URLIndex] = value; } + } + /// + /// The nickname of the IRC bot + /// + public string Nickname + { + get { return DataFields[BaseIndex + NickIndex]; } + set { DataFields[BaseIndex + NickIndex] = value; } + } + /// + /// The target for sending authentication messages + /// + public string AuthTarget + { + get { return DataFields[BaseIndex + AuthTargetIndex]; } + set { DataFields[BaseIndex + AuthTargetIndex] = value; } + } + /// + /// The authentication message + /// + public string AuthMessage + { + get { return DataFields[BaseIndex + AuthMessageIndex]; } + set { DataFields[BaseIndex + AuthMessageIndex] = value; } + } + /// + /// The minimum mode required to use admin bot commands when in special auth mode + /// + public IRCMode AuthLevel + { + get { return (IRCMode)Convert.ToInt32(DataFields[BaseIndex + AuthLevelIndex]); } + set { DataFields[BaseIndex + AuthLevelIndex] = Convert.ToString((int)value); } + } + } + + /// + /// Chat provider for Discord. Admin entires should be user ids in normal mode or group ids in special mode + /// + [DataContract] + public sealed class TGDiscordSetupInfo : TGChatSetupInfo + { + const int BotTokenIndex = 0; + const int FieldsLen = 1; + /// + /// Construct Discord setup info from optional generic info. Default is not a valid discord bot tokent + /// + /// Optional generic info + public TGDiscordSetupInfo(TGChatSetupInfo baseInfo = null) : base(baseInfo, FieldsLen) + { + Provider = TGChatProvider.Discord; + if (InitializeFields) + BotToken = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"; //needless to say, this is fake + } + /// + protected override string SanitizeChannelName(string working) + { + working = working.Replace("<", "").Replace(">", "").Replace("&", ""); //filter out some stuff that can come in the copypasta + try + { + Convert.ToUInt64(working); + } + catch + { + throw new Exception("Invalid Discord channel ID!"); + } + return working; + } + + /// + /// The Discord bot token to use. See https://discordapp.com/developers/applications/me for registering bot accounts + /// + public string BotToken + { + get { return DataFields[BaseIndex + BotTokenIndex]; } + set { DataFields[BaseIndex + BotTokenIndex] = value; } + } + } +} diff --git a/TGServiceInterface/RootCommand.cs b/TGServiceInterface/RootCommand.cs new file mode 100644 index 0000000000..ac179e7fed --- /dev/null +++ b/TGServiceInterface/RootCommand.cs @@ -0,0 +1,105 @@ +using System; +using System.Collections.Generic; + +namespace TGServiceInterface +{ + /// + /// Helper for creating commands that contain sub commands + /// + public class RootCommand : Command + { + /// + /// s further down the tree from this one. Set in Constructor + /// + public Command[] Children { get; protected set; } = { }; + /// + /// If set to a multiline, detailed list of s will be printed. Otherwise a singleline list of s will be printed + /// + public static bool PrintHelpList = false; + + /// + /// Forward parameters to commands further down the tree + /// + /// List of parameters passed to the + /// The result of a sub or an appropriate if the handled it + protected override ExitCode Run(IList parameters) + { + if (parameters.Count > 0) + { + var LocalKeyword = parameters[0].Trim().ToLower(); + parameters.RemoveAt(0); + switch (LocalKeyword) + { + case "help": + case "?": + PrintHelp(); + return ExitCode.Normal; + default: + foreach (var c in Children) + if (c.Keyword == LocalKeyword) + { + if (parameters.Count > 0) + { + var possibleHelp = parameters[0].ToLower(); + if (possibleHelp == "help" || possibleHelp == "?") + { + c.PrintHelp(); + return ExitCode.Normal; + } + } + if (parameters.Count < c.RequiredParameters) + { + OutputProc("Not enough parameters!"); + return ExitCode.BadCommand; + } + return c.DoRun(parameters); + } + parameters.Insert(0, LocalKeyword); + break; + } + } + OutputProc(String.Format("Invalid command! Type '{0}?' or '{0}help' for available commands.", Keyword != null ? Keyword + " " : "")); + return ExitCode.BadCommand; + } + + /// + public override void PrintHelp() + { + var Final = new List(); + if (PrintHelpList) + { + foreach (var c in Children) + Final.Add(c.Keyword); + OutputProc("Available commands (type '?' or 'help' after command for more info): " + String.Join(", ", Final)); + } + else + { + var Prefixes = new List(); + var Postfixes = new List(); + int MaxPrefixLen = 0; + foreach (var c in Children) + { + var ns = c.Keyword + " " + c.GetArgumentString(); + MaxPrefixLen = Math.Max(MaxPrefixLen, ns.Length); + Prefixes.Add(ns); + Postfixes.Add(c.GetHelpText()); + } + + for (var I = 0; I < Prefixes.Count; ++I) + { + var lp = Prefixes[I]; + for (; lp.Length < MaxPrefixLen + 1; lp += " ") ; + Final.Add(lp + "- " + Postfixes[I]); + } + Final.Sort(); + Final.ForEach(OutputProc); + } + } + + /// + public override string GetHelpText() + { + throw new NotImplementedException(); + } + } +} diff --git a/TGServiceInterface/TGServiceInterface.csproj b/TGServiceInterface/TGServiceInterface.csproj index 25feb1ec2d..d20d665cb1 100644 --- a/TGServiceInterface/TGServiceInterface.csproj +++ b/TGServiceInterface/TGServiceInterface.csproj @@ -49,6 +49,7 @@ + From d0b5177daf4a9c04e766b1e8e2b4c1c2f23b612b Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Wed, 18 Oct 2017 16:11:13 -0400 Subject: [PATCH 27/75] Documentation for Compiler.cs and Byond.cs --- TGServiceInterface/Administration.cs | 10 +++++----- TGServiceInterface/Byond.cs | 18 +++++++----------- TGServiceInterface/Compiler.cs | 25 ++++++++----------------- 3 files changed, 20 insertions(+), 33 deletions(-) diff --git a/TGServiceInterface/Administration.cs b/TGServiceInterface/Administration.cs index fbb7964003..00b66b2267 100644 --- a/TGServiceInterface/Administration.cs +++ b/TGServiceInterface/Administration.cs @@ -20,14 +20,14 @@ namespace TGServiceInterface /// Requires a service restart to take effect /// /// The new port to use for remote operation - /// null on success, error message on failure + /// on success, error message on failure [OperationContract] string SetRemoteAccessPort(ushort port); /// /// Returns the name of the windows group allowed to use the service other than administrator /// - /// The name of the windows group allowed to use the service other than administrator, "ADMIN" if it's unset, null on failure + /// The name of the windows group allowed to use the service other than administrator, "ADMIN" if it's unset, on failure [OperationContract] string GetCurrentAuthorizedGroup(); @@ -35,7 +35,7 @@ namespace TGServiceInterface /// Searches the windows machine for the group named , sets it as the authorized group if it's found /// /// The name of the windows group to search for or null to clear the setting - /// The name of the windows group that is now authorized to use the service on success, null on failure, "ADMIN" on clearing + /// The name of the windows group that is now authorized to use the service on success, on failure, "ADMIN" on clearing [OperationContract] string SetAuthorizedGroup(string groupName); @@ -43,14 +43,14 @@ namespace TGServiceInterface /// Moves the entire server installation, requires no operations to be running /// /// The new path to place the server - /// null on success, error message on failure + /// on success, error message on failure [OperationContract] string MoveServer(string new_location); /// /// Renames the current static folder to a backup name and recreates is from the current repo using TGS3.json /// - /// null on success, error message on failure + /// on success, error message on failure [OperationContract] string RecreateStaticFolder(); } diff --git a/TGServiceInterface/Byond.cs b/TGServiceInterface/Byond.cs index 4da1105271..8b87b7dd2e 100644 --- a/TGServiceInterface/Byond.cs +++ b/TGServiceInterface/Byond.cs @@ -61,27 +61,23 @@ namespace TGServiceInterface /// /// Gets the current status of any BYOND updates /// - /// A TGByondStatus + /// The current status of the byond updater [OperationContract] TGByondStatus CurrentStatus(); - + /// - /// updates the used byond version to that of version major.minor - /// The change won't take place until dream daemon reboots - /// the latest parameter overrides the other two and forces an update to the latest (beta?) version - /// runs asyncronously, use CurrentStatus to see progress + /// updates the used byond version to that of version .. The change won't take place until DD reboots. Calls after completion. Runs asyncronously, use to check progress /// /// Major BYOND version. E.g. 511 /// Minor BYOND version. E.g. 1381 - /// True if the update started, false if another operation was in progress + /// if the update started, if another operation was in progress or DreamDaemon is running [OperationContract] bool UpdateToVersion(int major, int minor); /// - /// Check the last update error - /// Checking this will clear the value + /// Check the last update error. Checking this will clear the value /// - /// The last update error, if any + /// The last update error, if any. otherwise. [OperationContract] string GetError(); @@ -89,7 +85,7 @@ namespace TGServiceInterface /// Get the currently installed version as a string formatted as Major.Minor /// /// The type of version to retrieve - /// null if no version is detected, the version string otherwise + /// if no version is detected, the version string otherwise [OperationContract] string GetVersion(TGByondVersion type); } diff --git a/TGServiceInterface/Compiler.cs b/TGServiceInterface/Compiler.cs index 75684245fb..dbf825268a 100644 --- a/TGServiceInterface/Compiler.cs +++ b/TGServiceInterface/Compiler.cs @@ -32,32 +32,24 @@ namespace TGServiceInterface public interface ITGCompiler { /// - /// Sets up the symlinks for hotswapping game code - /// this will reset everything (except the static directories) - /// this will not reset the static directories - /// requires the repository to be set up and locks it for the duration of the operation - /// does not compile the game - /// runs asyncronously + /// Sets up the symlinks for hotswapping game code. This will reset everything in the Game folder. Requires the repository to be set up and locks it once the compilation stage starts. Runs asyncronously from this call /// - /// true if the operation began, false if it could not start + /// [OperationContract] bool Initialize(); /// - /// Does all the necessary actions to take the revision currently in the repository - /// and compile it to be run on the next server reboot - /// requires byond to be set up and the compiler to be initialized - /// runs asyncronously + /// Does all the necessary actions to take the revision currently in the repository and compile it to be run on the next server reboot. Requires BYOND to be set up and the to return . Runs asyncronously /// - /// If true no message for compilation start will be printed - /// true if the operation began, false if it could not start + /// If no message for compilation start will be printed + /// if the operation began, if it could not start [OperationContract] bool Compile(bool silent = false); /// /// Cancels the current compilation /// - /// null on success, error message on failure + /// on success, error message on failure [OperationContract] string Cancel(); @@ -69,10 +61,9 @@ namespace TGServiceInterface TGCompilerStatus GetStatus(); /// - /// Returns the error message of the last operation - /// Reading this will clear the stored value + /// Returns the error message of the last operation. Reading this will clear the stored value /// - /// the error message of the last operation if it failed or null if it succeeded + /// the error message of the last operation if it failed or if it succeeded [OperationContract] string CompileError(); From 02c8580aee8b13303a94340e1ced014537030a72 Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Wed, 18 Oct 2017 16:23:29 -0400 Subject: [PATCH 28/75] Documentation for DreamDaemon.cs --- TGServiceInterface/Byond.cs | 2 +- TGServiceInterface/DreamDaemon.cs | 52 ++++++++++++++----------------- 2 files changed, 24 insertions(+), 30 deletions(-) diff --git a/TGServiceInterface/Byond.cs b/TGServiceInterface/Byond.cs index 8b87b7dd2e..83aa851441 100644 --- a/TGServiceInterface/Byond.cs +++ b/TGServiceInterface/Byond.cs @@ -66,7 +66,7 @@ namespace TGServiceInterface TGByondStatus CurrentStatus(); /// - /// updates the used byond version to that of version .. The change won't take place until DD reboots. Calls after completion. Runs asyncronously, use to check progress + /// updates the used byond version to that of version .. The change won't take place until DD reboots. Calls if blocked by a running DD instance. Runs asyncronously, use to check progress /// /// Major BYOND version. E.g. 511 /// Minor BYOND version. E.g. 1381 diff --git a/TGServiceInterface/DreamDaemon.cs b/TGServiceInterface/DreamDaemon.cs index 6162ad3ae8..0d17090081 100644 --- a/TGServiceInterface/DreamDaemon.cs +++ b/TGServiceInterface/DreamDaemon.cs @@ -49,75 +49,70 @@ namespace TGServiceInterface /// /// Gets the status of DreamDaemon /// - /// The appropriate TGDreamDaemonStatus + /// The appropriate [OperationContract] TGDreamDaemonStatus DaemonStatus(); /// /// Returns a human readable string of the current server status /// - /// If true, the status will include the server's current visibility and security levels - /// A human readable string of the current server status + /// If , the status will include the server's current visibility and security levels + /// A human readable of the current server status [OperationContract] string StatusString(bool includeMetaInfo); /// - /// Check if a call to Start will fail - /// Of course, be aware of race conditions with other control panels + /// Check if a call to will fail. Of course, be aware of race conditions with other interfaces /// - /// returns the error that would occur, null otherwise + /// The error that would occur, otherwise [OperationContract] string CanStart(); /// /// Starts the server if it isn't running /// - /// null on success or error message on failure + /// on success or error message on failure [OperationContract] string Start(); /// /// Immediately kills the server /// - /// null on success or error message on failure + /// on success or error message on failure [OperationContract] string Stop(); /// /// Immediately kills and restarts the server /// - /// null on success or error message on failure + /// on success or error message on failure [OperationContract] string Restart(); /// - /// Restart the server after the currently running round ends - /// Has no effect if the server isn't running + /// Restart the server after the currently running world reboots. Has no effect if the server isn't running /// [OperationContract] void RequestRestart(); /// - /// Stop the server after the currently running round ends - /// Has no effect if the server isn't running + /// Stop the server after the currently running world reboots. Has no effect if the server isn't running /// [OperationContract] void RequestStop(); /// - /// Get the configured (not running) security level + /// Get the configured (not necessarily running) security level /// - /// The configured (not running) security level + /// The configured (not necessarily running) [OperationContract] TGDreamDaemonSecurity SecurityLevel(); /// - /// Sets the security level of the server. Requires reboot to apply - /// Implies a call to RequestRestart() - /// note that anything higher than Trusted will disable interop from DD + /// Sets the security level of the server. Requires server reboot to apply. Calls . Note that anything higher than Trusted will disable interop from DD /// /// The new security level - /// True if the change was immediately applied, false if a graceful restart was queued + /// if the change was immediately applied, otherwise and a call to was made [OperationContract] bool SetSecurityLevel(TGDreamDaemonSecurity level); @@ -129,8 +124,7 @@ namespace TGServiceInterface ushort Port(); /// - /// Set the port to host DD on. Requires reboot to apply - /// Implies a call to RequestRestart() + /// Set the port to host DD on. Requires reboot to apply. Calls . /// /// The new port [OperationContract] @@ -139,35 +133,35 @@ namespace TGServiceInterface /// /// Check if the watchdog will start when the service starts /// - /// true if autostart is enabled, false otherwise + /// if autostart is enabled, otherwise [OperationContract] bool Autostart(); /// /// Set the autostart config /// - /// true to start the watchdog with the service, false otherwise + /// to start the watchdog with the service, to disable that functionality [OperationContract] void SetAutostart(bool on); /// - /// Check if the byond webclient is currently enabled for the server + /// Check if the BYOND webclient is currently enabled for the server /// - /// true if the webclient is enabled, false otherwise + /// if the webclient is enabled, otherwise [OperationContract] bool Webclient(); /// /// Set the webclient config. Calls /// - /// true to enable the byond webclient for the server, false otherwise + /// to enable the byond webclient for the server, otherwise [OperationContract] void SetWebclient(bool on); /// - /// Checks if a server stop has bee requested + /// Checks if a server stop has been requested /// - /// true if RequestStop has been called since the last server start, false otherwise + /// if has been called since the last server start, otherwise [OperationContract] bool ShutdownInProgress(); @@ -175,7 +169,7 @@ namespace TGServiceInterface /// Sends a message to everyone on the server /// /// The message to send - /// null on success, error message on failure + /// on success, error message on failure [OperationContract] string WorldAnnounce(string msg); From 6706ef94b0284af4a9088e54e30eb67521e59303 Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Wed, 18 Oct 2017 16:40:24 -0400 Subject: [PATCH 29/75] Documents Repository.cs and Interop.cs --- TGServiceInterface/Interop.cs | 7 ++- TGServiceInterface/Repository.cs | 78 +++++++++++++++----------------- 2 files changed, 39 insertions(+), 46 deletions(-) diff --git a/TGServiceInterface/Interop.cs b/TGServiceInterface/Interop.cs index e98a947acf..81672fe241 100644 --- a/TGServiceInterface/Interop.cs +++ b/TGServiceInterface/Interop.cs @@ -16,18 +16,18 @@ namespace TGServiceInterface /// Called from /world/ExportService(command) /// /// The command to run - /// true on success, false on failure + /// on success, on failure [OperationContract] bool InteropMessage(string command); } /// - /// Holds the proc that DD calls to access + /// Holds the proc that DD calls to access /// public class DDInteropCallHolder { /// - /// The proc that DD calls to access + /// The proc that DD calls to access /// /// The arguments passed /// 0 @@ -43,7 +43,6 @@ namespace TGServiceInterface } catch { } Server.CloseChannel(channel); - } catch { } return 0; diff --git a/TGServiceInterface/Repository.cs b/TGServiceInterface/Repository.cs index eab2a89a8d..ed84a700d4 100644 --- a/TGServiceInterface/Repository.cs +++ b/TGServiceInterface/Repository.cs @@ -11,7 +11,7 @@ namespace TGServiceInterface public class PullRequestInfo { /// - /// Construct a PullRequestInfo + /// Construct a /// /// The PR number /// The PR's author @@ -55,32 +55,30 @@ namespace TGServiceInterface /// /// If the repo is currently undergoing an operation /// - /// true if the repo is busy, false otherwise + /// if the repo is busy, otherwise [OperationContract] bool OperationInProgress(); /// /// Gets the progress of repository operations, not all operations are supported /// - /// A value between 0 and 100 representing the progress of the current operation or -1 if the operation cannot be monitored + /// A value between 0 and 100 inclusive representing the progress of the current operation or -1 if the operation cannot be monitored [OperationContract] int CheckoutProgress(); /// - /// Check if the repository is valid, if not Setup must be called + /// Check if the repository is valid, if not must be called /// - /// true if the repository is valid, false otherwise + /// if the repository is valid, otherwise [OperationContract] bool Exists(); /// - /// Deletes whatever may be left over and clones the repo at remote and checks out branch master - /// Will move config and data dirs to a backup location if they exist - /// runs asyncronously + /// Deletes whatever may be left over and clones the repo at and checks out . Will move config and data dirs to a backup location if they exist. Runs asyncronously /// - /// The address of the repo to clone. If ssh protocol is used, repository_private_key.txt must exist in the server directory. + /// The address of the repo to clone. If ssh protocol is used, private_key.txt and public_key.txt must exist in the server RepoKey directory. /// The branch of the repo to checkout - /// null on success, error message on failure + /// on success, error message on failure [OperationContract] string Setup(string remote, string branch = "master"); @@ -88,24 +86,24 @@ namespace TGServiceInterface /// Gets the sha of the current HEAD /// /// If set to true and HEAD is currently a branch, will instead return the sha of the tracked remote branch if it exists - /// null on success, error message on failure - /// The sha of the current HEAD on success, null on failure + /// on success, error message on failure + /// The sha of the current HEAD on success, on failure [OperationContract] string GetHead(bool useTracked, out string error); /// /// Gets the name of the current branch /// - /// null on success, error message on failure - /// The name of the current branch on success, null on failure + /// on success, error message on failure + /// The name of the current branch on success, on failure [OperationContract] string GetBranch(out string error); /// /// Gets the url of the current origin /// - /// null on success, error message on failure - /// The url of the current origin on success, null on failure + /// on success, error message on failure + /// The url of the current origin on success, on failure [OperationContract] string GetRemote(out string error); @@ -113,23 +111,23 @@ namespace TGServiceInterface /// Hard checks out the passed object name /// /// The branch, commit, or tag to checkout - /// null on success, error message on failure + /// on success, error message on failure [OperationContract] string Checkout(string objectName); /// /// Fetches the origin and merges it into the current branch /// - /// If true, the operation will perform a hard reset instead of a merge - /// null on success, error message on failure + /// If , the operation will perform a hard reset instead of a merge + /// on success, error message on failure [OperationContract] string Update(bool reset); /// /// Runs git reset --hard /// - /// Changes command to git reset --hard origin/branch_name if true - /// null on success, error message on failure + /// Changes command to git reset --hard origin/branch_name if + /// on success, error message on failure [OperationContract] string Reset(bool tracked); @@ -137,18 +135,15 @@ namespace TGServiceInterface /// Merges the target pull request into the current branch if the remote is a github repository /// /// The github pull request number in the remote repository - /// null on success, error message on failure + /// on success, error message on failure [OperationContract] string MergePullRequest(int PRnumber); - //Returns a list of PR# -> Sha of the currently merged pull requests - //returns null on failure and error will be set - /// /// Get the currently merged pull requests. Note that switching branches will delete this list and switching back won't restore it /// - /// null on success, error message on failure - /// A list of PullRequestInfo + /// on success, error message on failure + /// A of [OperationContract] IList MergedPullRequests(out string error); @@ -183,23 +178,23 @@ namespace TGServiceInterface /// /// Updates the html changelog /// - /// null on success, error on failure + /// on success, error on failure /// The output of the python script [OperationContract] string GenerateChangelog(out string error); - /// - /// Pushes the changelog to the currently git, this operation will only run if the changelog is the only difference to be pushed (i.e. no PRs merged) - /// - /// null on success, error on failure - [OperationContract] - string PushChangelog(); + /// + /// Pushes the paths listed in TGS3.json to the currentl git remote. No other commit differences may exist for this function to succeed + /// + /// on success, error on failure + [OperationContract] + string SynchronizePush(); /// /// Sets the path to the python 2.7 installation /// /// The new path - /// true if the path exists, false otherwise + /// if the path exists, otherwise [OperationContract] bool SetPythonPath(string path); @@ -213,30 +208,29 @@ namespace TGServiceInterface /// /// List the tagged commits of the repo at which compiles took place /// - /// null on success, error message on failure - /// A dictionary of tag name -> commit on success, null on failure + /// on success, error message on failure + /// A of tag name -> commit on success, on failure [OperationContract] IDictionary ListBackups(out string error); /// - /// Updates the cached TGS3.json to the repo's version - /// Compiles will not succeed if these two to not match + /// Updates the cached TGS3.json to the repo's version. Compiles will not succeed if these two to not match /// - /// null on success, error message on failure + /// on success, error message on failure [OperationContract] string UpdateTGS3Json(); /// /// (De)Activate and set the interval for the automatic server updater /// - /// Interval to check for updates in minutes, disables if zero + /// Interval to check for updates in minutes, disables if 0 [OperationContract] void SetAutoUpdateInterval(ulong newInterval); /// /// Get the current autoupdate interval /// - /// The current auto update interval or zero if it's disabled + /// The current auto update interval or 0 if it's disabled [OperationContract] ulong AutoUpdateInterval(); } From 74ec82f78d849e45ac3441175b01dac750504cc5 Mon Sep 17 00:00:00 2001 From: Cyberboss Date: Thu, 19 Oct 2017 11:00:06 -0400 Subject: [PATCH 30/75] Starting doxygen stuff --- Doxyfile | 2493 ++++++++++++++++++++++++++++++ TGS3Release.ps1 => TGS3Build.ps1 | 7 + TGStationServer3.sln | 3 +- appveyor.yml | 9 +- 4 files changed, 2509 insertions(+), 3 deletions(-) create mode 100644 Doxyfile rename TGS3Release.ps1 => TGS3Build.ps1 (83%) diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000000..d9c76da705 --- /dev/null +++ b/Doxyfile @@ -0,0 +1,2493 @@ +# Doxyfile 1.8.13 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = tgstation-server + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +# Generated in appveyor + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "The /tg/station 13 server suite" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +# Generated in appveyor + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +# Generated in appveyor + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = YES + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = NO + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = YES + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = YES + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +# Generated by appveyor + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +#We want the main .md +EXCLUDE = legacy/README.md + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = README.md + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = YES + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse-libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /