add StagingServerSummary (#211)

KenticoInspector.Actions/GlobalAdminSummary/Action.cs

@@ -11,7 +11,7 @@
 
 namespace KenticoInspector.Actions.GlobalAdminSummary
 {
-    public class Action : AbstractAction<Terms,Options>
+    public class Action : AbstractAction<Terms, Options>
     {
         private readonly IDatabaseService databaseService;
 
@@ -31,7 +31,9 @@ public override ActionResults Execute(Options options)
         {
             databaseService.ExecuteSqlFromFileGeneric(Scripts.ResetAndEnableUser, new { UserID = options.UserId });
             var result = ExecuteListing();
-            result.Summary = Metadata.Terms.UserReset.With(new {
+            result.Status = ResultsStatus.Good;
+            result.Summary = Metadata.Terms.UserReset.With(new
+            {
                 userId = options.UserId
             });
 
@@ -78,4 +80,4 @@ public override bool ValidateOptions(Options options)
             return options.UserId > 0 && administratorUsers.Any(u => u.UserID == options.UserId);
         }
     }
-}
+}

KenticoInspector.Actions/KenticoInspector.Actions.csproj

@@ -31,6 +31,15 @@
     <None Update="SiteStatusSummary\Scripts\GetSiteSummary.sql">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
+    <None Update="StagingServerSummary\Metadata\en-US.yaml">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
+    <None Update="StagingServerSummary\Scripts\GetStagingServerSummary.sql">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
+    <None Update="StagingServerSummary\Scripts\DisableServer.sql">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
     <None Update="WebFarmServerSummary\Metadata\en-US.yaml">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>

KenticoInspector.Actions/SiteStatusSummary/Action.cs

@@ -11,7 +11,7 @@
 
 namespace KenticoInspector.Actions.SiteStatusSummary
 {
-    public class Action : AbstractAction<Terms,Options>
+    public class Action : AbstractAction<Terms, Options>
     {
         private readonly IDatabaseService databaseService;
 
@@ -31,6 +31,7 @@ public override ActionResults Execute(Options options)
         {
             databaseService.ExecuteSqlFromFileGeneric(Scripts.StopSite, new { SiteID = options.SiteId });
             var result = ExecuteListing();
+            result.Status = ResultsStatus.Good;
             result.Summary = Metadata.Terms.SiteStopped.With(new
             {
                 siteId = options.SiteId
@@ -79,4 +80,4 @@ public override bool ValidateOptions(Options options)
             return options.SiteId > 0 && sites.Any(s => s.ID == options.SiteId);
         }
     }
-}
+}

KenticoInspector.Actions/SiteStatusSummary/Models/Results/CmsSite.cs

@@ -2,16 +2,16 @@
 {
     public class CmsSite
     {
-        public int ID { get; internal set; }
+        public int ID { get; set; }
 
-        public string DisplayName { get; internal set; }
+        public string DisplayName { get; set; }
 
-        public string Description { get; internal set; }
+        public string Description { get; set; }
 
-        public string AdministrationDomain { get; internal set; }
+        public string AdministrationDomain { get; set; }
 
-        public string PresentationUrl { get; internal set; }
+        public string PresentationUrl { get; set; }
 
-        public bool Running { get; internal set; }
+        public bool Running { get; set; }
     }
 }

KenticoInspector.Actions/StagingServerSummary/Action.cs

@@ -0,0 +1,85 @@
+using KenticoInspector.Actions.StagingServerSummary.Models;
+using KenticoInspector.Core;
+using KenticoInspector.Core.Constants;
+using KenticoInspector.Core.Helpers;
+using KenticoInspector.Core.Models;
+using KenticoInspector.Core.Services.Interfaces;
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace KenticoInspector.Actions.StagingServerSummary
+{
+    public class Action : AbstractAction<Terms, Options>
+    {
+        private readonly IDatabaseService databaseService;
+
+        public override IList<Version> CompatibleVersions => VersionHelper.GetVersionList("12", "13");
+
+        public override IList<string> Tags => new List<string> {
+            ModuleTags.Configuration,
+            ModuleTags.Staging
+        };
+
+        public Action(IDatabaseService databaseService, IModuleMetadataService moduleMetadataService) : base(moduleMetadataService)
+        {
+            this.databaseService = databaseService;
+        }
+
+        public override ActionResults Execute(Options options)
+        {
+            databaseService.ExecuteSqlFromFileGeneric(Scripts.DisableServer, new { ServerID = options.ServerId });
+            var result = ExecuteListing();
+            result.Status = ResultsStatus.Good;
+            result.Summary = Metadata.Terms.ServerDisabled.With(new
+            {
+                serverId = options.ServerId
+            });
+
+            return result;
+        }
+
+        public override ActionResults ExecutePartial(Options options)
+        {
+            // All options are required for this action
+            throw new NotImplementedException();
+        }
+
+        public override ActionResults ExecuteListing()
+        {
+            var servers = databaseService.ExecuteSqlFromFile<StagingServer>(Scripts.GetStagingServerSummary);
+            var data = new TableResult<StagingServer>()
+            {
+                Name = Metadata.Terms.TableTitle,
+                Rows = servers
+            };
+
+            return new ActionResults
+            {
+                Type = ResultsType.Table,
+                Status = ResultsStatus.Information,
+                Summary = Metadata.Terms.ListSummary,
+                Data = data
+            };
+        }
+
+        public override ActionResults GetInvalidOptionsResult()
+        {
+            var result = ExecuteListing();
+            result.Status = ResultsStatus.Error;
+            result.Summary = Metadata.Terms.InvalidOptions;
+
+            return result;
+        }
+
+        public override bool ValidateOptions(Options options)
+        {
+            var servers = databaseService.ExecuteSqlFromFile<StagingServer>(Scripts.GetStagingServerSummary);
+
+            return options.ServerId > 0 &&
+                servers.Any(s => s.ID == options.ServerId) &&
+                servers.FirstOrDefault(s => s.ID == options.ServerId).Enabled;
+        }
+    }
+}

KenticoInspector.Actions/StagingServerSummary/Metadata/en-US.yaml

@@ -0,0 +1,12 @@
+details:
+  name: Content Staging Server Summary
+  shortDescription: Review and disable staging servers.
+  longDescription: |
+    Displays all staging servers, and allows you to disable them.
+
+    Run the action without options to view the staging servers. To disable a server, re-run the action with the server ID below. Servers disabled by this action have the *.disabled* prefix applied to their name, so you can identify which servers were disabled by this action and which were disabled manually.
+terms:
+  tableTitle: Content staging servers
+  invalidOptions: Invalid server ID provided. Ensure that the server ID is listed in the results below, and the server is enabled.
+  listSummary: Set the server ID you wish to disable and re-run
+  serverDisabled: Server ID <serverId> was disabled

KenticoInspector.Actions/StagingServerSummary/Models/Options.cs

@@ -0,0 +1,7 @@
+namespace KenticoInspector.Actions.StagingServerSummary.Models
+{
+    public class Options
+    {
+        public int? ServerId { get; set; }
+    }
+}

KenticoInspector.Actions/StagingServerSummary/Models/Results/StagingServer.cs

@@ -0,0 +1,15 @@
+namespace KenticoInspector.Actions.StagingServerSummary.Models
+{
+    public class StagingServer
+    {
+        public int ID { get; set; }
+
+        public string Name { get; set; }
+
+        public string Site { get; set; }
+
+        public string Url { get; set; }
+
+        public bool Enabled { get; set; }
+    }
+}

KenticoInspector.Actions/StagingServerSummary/Models/Terms.cs

@@ -0,0 +1,15 @@
+using KenticoInspector.Core.Models;
+
+namespace KenticoInspector.Actions.StagingServerSummary.Models
+{
+    public class Terms
+    {
+        public Term InvalidOptions { get; internal set; }
+
+        public Term TableTitle { get; internal set; }
+
+        public Term ListSummary { get; internal set; }
+
+        public Term ServerDisabled { get; internal set; }
+    }
+}

KenticoInspector.Actions/StagingServerSummary/Scripts.cs

@@ -0,0 +1,11 @@
+namespace KenticoInspector.Actions.StagingServerSummary
+{
+    public static class Scripts
+    {
+        public static string BaseDirectory => $"{nameof(StagingServerSummary)}/Scripts";
+
+        public static string GetStagingServerSummary => $"{BaseDirectory}/{nameof(GetStagingServerSummary)}.sql";
+
+        public static string DisableServer => $"{BaseDirectory}/{nameof(DisableServer)}.sql";
+    }
+}

KenticoInspector.Actions/StagingServerSummary/Scripts/DisableServer.sql

@@ -0,0 +1,2 @@
+UPDATE Staging_Server SET ServerDisplayName = ServerDisplayName + N'.disabled', ServerEnabled = 0
+WHERE ServerID = @ServerID

KenticoInspector.Actions/StagingServerSummary/Scripts/GetStagingServerSummary.sql

@@ -0,0 +1,3 @@
+SELECT C.ServerID AS 'ID', C.ServerDisplayName AS 'Name', C.ServerEnabled AS 'Enabled', C.ServerURL AS 'Url', S.SiteDisplayName AS 'Site'
+FROM Staging_Server AS C
+JOIN CMS_Site AS S ON S.SiteID = C.ServerSiteID

KenticoInspector.Actions/WebFarmServerSummary/Metadata/en-US.yaml

@@ -4,7 +4,7 @@
   longDescription: |
     Displays all web farm servers, and allows you to disable them.
 
-    Run the action without options to view the web farm server. To disable a server, re-run the action with the server ID below. Servers disabled by this action have the *.disabled* prefix applied to their name, so you can identify which servers were disabled by this action and which were disabled manually.
+    Run the action without options to view the web farm servers. To disable a server, re-run the action with the server ID below. Servers disabled by this action have the *.disabled* prefix applied to their name, so you can identify which servers were disabled by this action and which were disabled manually.
 terms:
   tableTitle: Web farm servers
   invalidOptions: Invalid server ID provided. Ensure that the server ID is listed in the results below, and the server is enabled.

KenticoInspector.Actions/WebFarmServerSummary/Models/Results/WebFarmServer.cs

@@ -2,10 +2,10 @@
 {
     public class WebFarmServer
     {
-        public int ID { get; internal set; }
+        public int ID { get; set; }
 
-        public string Name { get; internal set; }
+        public string Name { get; set; }
 
-        public bool Enabled { get; internal set; }
+        public bool Enabled { get; set; }
     }
 }

KenticoInspector.Core/Constants/ModuleTags.cs

@@ -18,5 +18,6 @@ public static class ModuleTags
         public const string User = "User";
         public const string Site = "Site";
         public const string WebFarms = "Web farms";
+        public const string Staging = "Content staging";
     }
 }