Adds new feature to write documents easier

Author: LordHepipud

doc/100-General/10-Changelog.md

@@ -39,6 +39,7 @@ Released closed milestones can be found on [GitHub](https://github.com/Icinga/ic
 * [#643](https://github.com/Icinga/icinga-powershell-framework/pull/643) Adds support for `-RebuildCache` flag on `icinga` cmd to rebuild component cache as well
 * [#644](https://github.com/Icinga/icinga-powershell-framework/pull/644) Adds progress bar output to repository interaction (sync, update, new) instead of plain text output
 * [#655](https://github.com/Icinga/icinga-powershell-framework/pull/655) Adds [IWKB](https://icinga.com/docs/icinga-for-windows/latest/doc/knowledgebase/IWKB000016/) and test/manage Cmdlets for SCOM intercept counters
+* [#656](https://github.com/Icinga/icinga-powershell-framework/pull/656) Adds new feature to write document content easier by storing it in memory first and then allowing to write it to disk at once with proper UTF8 encoding
 
 ### Enhancements
 

lib/core/docs/Add-IcingaDocumentContent.psm1

@@ -0,0 +1,24 @@
+function Add-IcingaDocumentContent()
+{
+    param (
+        [string]$Name      = $null,
+        [string]$Content   = '',
+        [switch]$NoNewLine = $FALSE
+    );
+
+    if ([string]::IsNullOrEmpty($Name)) {
+        Write-IcingaConsoleError 'You have to specify an internal name for the documentation object';
+        return;
+    }
+
+    if ($Global:Icinga.Private.Documentation.ContainsKey($Name) -eq $false) {
+        Write-IcingaConsoleError 'A documentation object with the name "{0}" does not exist' -Objects $Name;
+        return;
+    }
+
+    if ($NoNewLine) {
+        $Global:Icinga.Private.Documentation[$Name]['Content'].Append($Content) | Out-Null;
+    } else {
+        $Global:Icinga.Private.Documentation[$Name]['Content'].AppendLine($Content) | Out-Null;
+    }
+}

lib/core/docs/New-IcingaDocumentObject.psm1

@@ -0,0 +1,38 @@
+function New-IcingaDocumentObject()
+{
+    param (
+        [string]$Name  = $null,
+        [string]$Path  = $null,
+        [switch]$Force = $FALSE
+    );
+
+    if ([string]::IsNullOrEmpty($Name)) {
+        Write-IcingaConsoleError 'You have to specify an internal name for the documentation object';
+        return;
+    }
+
+    if ([string]::IsNullOrEmpty($Path)) {
+        Write-IcingaConsoleError 'You have to specify a path on where the document should be written to';
+        return;
+    }
+
+    if ($Global:Icinga.Private.Documentation.ContainsKey($Name)) {
+        if ($Force -eq $FALSE) {
+            Write-IcingaConsoleError 'A documentation object with the name "{0}" does already exist in memory. Use -Force to overwrite it' -Objects $Name;
+            return;
+        }
+
+        $Global:Icinga.Private.Documentation[$Name] = @{
+            'Path'    = $Path;
+            'Content' = (New-Object -TypeName 'System.Text.StringBuilder');
+        }
+    } else {
+        $Global:Icinga.Private.Documentation.Add(
+            $Name,
+            @{
+                'Path'    = $Path;
+                'Content' = (New-Object -TypeName 'System.Text.StringBuilder');
+            }
+        );
+    }
+}

lib/core/docs/Write-IcingaDocumentFile.psm1

@@ -0,0 +1,18 @@
+function Write-IcingaDocumentFile()
+{
+    param (
+        [string]$Name       = $null,
+        [switch]$ClearCache = $FALSE
+    );
+
+    if ([string]::IsNullOrEmpty($Name)) {
+        Write-IcingaConsoleError 'You have to specify an internal name for the documentation object';
+        return;
+    }
+
+    Write-IcingaFileSecure -File $Global:Icinga.Private.Documentation[$Name]['Path'] -Value $Global:Icinga.Private.Documentation[$Name]['Content'].ToString();
+
+    if ($ClearCache) {
+        $Global:Icinga.Private.Documentation.Remove($Name);
+    }
+}

lib/core/framework/New-IcingaEnvironmentVariable.psm1

@@ -24,6 +24,7 @@ function New-IcingaEnvironmentVariable()
         $Global:Icinga.Add('Private', @{ });
 
         $Global:Icinga.Private.Add('Daemons', @{ });
+        $Global:Icinga.Private.Add('Documentation', @{ });
         $Global:Icinga.Private.Add('Timers', @{ });
         $Global:Icinga.Private.Add('ProgressStatus', @{ });