documenting security roles in markdown

modery · Feb 4, 2023 · 624dded · 624dded
1 parent 010db1c
commit 624dded
Show file tree

Hide file tree

Showing 6 changed files with 84 additions and 10 deletions.
diff --git a/PowerDocu.SolutionDocumenter/Resources/security-role-access-level-basic.png b/PowerDocu.SolutionDocumenter/Resources/security-role-access-level-basic.png
diff --git a/PowerDocu.SolutionDocumenter/Resources/security-role-access-level-deep.png b/PowerDocu.SolutionDocumenter/Resources/security-role-access-level-deep.png
diff --git a/PowerDocu.SolutionDocumenter/Resources/security-role-access-level-global.png b/PowerDocu.SolutionDocumenter/Resources/security-role-access-level-global.png
diff --git a/PowerDocu.SolutionDocumenter/Resources/security-role-access-level-local.png b/PowerDocu.SolutionDocumenter/Resources/security-role-access-level-local.png
diff --git a/PowerDocu.SolutionDocumenter/Resources/security-role-access-level-none.png b/PowerDocu.SolutionDocumenter/Resources/security-role-access-level-none.png
diff --git a/PowerDocu.SolutionDocumenter/SolutionMarkdownBuilder.cs b/PowerDocu.SolutionDocumenter/SolutionMarkdownBuilder.cs
@@ -149,17 +149,25 @@ private void addSolutionComponents()
             solutionDoc.Root.Add(new MdParagraph(new MdTextSpan("This solution contains the following components")));
             foreach (string componentType in content.solution.GetComponentTypes())
             {
-                solutionDoc.Root.Add(new MdHeading(componentType, 3));
-                List<SolutionComponent> components = content.solution.Components.Where(c => c.Type == componentType).OrderBy(c => c.reqdepDisplayName).ToList();
-                List<MdTableRow> componentTableRows = new List<MdTableRow>();
-                foreach (SolutionComponent component in components)
-                {
-                    //todo add link to documentation
-                    componentTableRows.Add(new MdTableRow(new MdTextSpan(content.solution.GetDisplayNameForComponent(component))));
-                }
-                if (componentTableRows.Count > 0)
+                switch (componentType)
                 {
-                    solutionDoc.Root.Add(new MdTable(new MdTableRow(componentType), componentTableRows));
+                    case "Role":
+                        renderSecurityRoles();
+                        break;
+                    default:
+                        solutionDoc.Root.Add(new MdHeading(componentType, 3));
+                        List<SolutionComponent> components = content.solution.Components.Where(c => c.Type == componentType).OrderBy(c => c.reqdepDisplayName).ToList();
+                        List<MdTableRow> componentTableRows = new List<MdTableRow>();
+                        foreach (SolutionComponent component in components)
+                        {
+                            //todo add link to documentation
+                            componentTableRows.Add(new MdTableRow(new MdTextSpan(content.solution.GetDisplayNameForComponent(component))));
+                        }
+                        if (componentTableRows.Count > 0)
+                        {
+                            solutionDoc.Root.Add(new MdTable(new MdTableRow(componentType), componentTableRows));
+                        }
+                        break;
                 }
             }
 
@@ -209,5 +217,71 @@ private void addSolutionComponents()
                 solutionDoc.Root.Add(new MdParagraph(new MdTextSpan("This solution has no dependencies.")));
             }
         }
+
+        private void renderSecurityRoles()
+        {
+            solutionDoc.Root.Add(new MdHeading("Security Roles", 3));
+            foreach (RoleEntity role in content.solution.Customizations.getRoles())
+            {
+                solutionDoc.Root.Add(new MdHeading(role.Name + " (" + role.ID + ")", 4));
+                List<MdTableRow> componentTableRows = new List<MdTableRow>();
+                foreach (TableAccess tableAccess in role.Tables.OrderBy(o => o.Name))
+                {
+                    MdTableRow row = new MdTableRow(tableAccess.Name,
+                                           getAccessLevelIcon(tableAccess.Create),
+                                           getAccessLevelIcon(tableAccess.Read),
+                                           getAccessLevelIcon(tableAccess.Write),
+                                           getAccessLevelIcon(tableAccess.Delete),
+                                           getAccessLevelIcon(tableAccess.Append),
+                                           getAccessLevelIcon(tableAccess.AppendTo),
+                                           getAccessLevelIcon(tableAccess.Assign),
+                                           getAccessLevelIcon(tableAccess.Share)
+                    );
+                    componentTableRows.Add(row);
+                }
+                solutionDoc.Root.Add(new MdTable(new MdTableRow("Table", "Create", "Read", "Write", "Delete", "Append", "Append To", "Assign", "Share"), componentTableRows));
+
+                if (role.miscellaneousPrivileges.Count > 0)
+                {
+                    solutionDoc.Root.Add(new MdParagraph(new MdTextSpan("Miscellaneous Privileges associated with this role:")));
+                    List<MdTableRow> miscPrivTableRows = new List<MdTableRow>();
+                    foreach (KeyValuePair<string, string> miscPrivilege in role.miscellaneousPrivileges)
+                    {
+                        miscPrivTableRows.Add(new MdTableRow(miscPrivilege.Key, getAccessLevelIcon(miscPrivilege.Value)));
+                    }
+                    solutionDoc.Root.Add(new MdTable(new MdTableRow("Miscellaneous Privilege", "Level"), miscPrivTableRows));
+                }
+            }
+        }
+
+        private MdImageSpan getAccessLevelIcon(AccessLevel accessLevel)
+        {
+            Directory.CreateDirectory(content.folderPath + "Resources");
+            string iconFile = @"Resources\security-role-access-level-";
+            iconFile += accessLevel switch
+            {
+                AccessLevel.Global => "global.png",
+                AccessLevel.Deep => "deep.png",
+                AccessLevel.Local => "local.png",
+                AccessLevel.Basic => "basic.png",
+                _ => "none.png",
+            };
+            if (!File.Exists(content.folderPath + iconFile))
+                File.Copy(AssemblyHelper.GetExecutablePath() + iconFile, content.folderPath + iconFile);
+            return new MdImageSpan(accessLevel.ToString(), iconFile.Replace(@"\","/"));
+        }
+
+        private MdImageSpan getAccessLevelIcon(string accessLevel)
+        {
+            AccessLevel level = accessLevel switch
+            {
+                "Global" => AccessLevel.Global,
+                "Deep" => AccessLevel.Deep,
+                "Loca" => AccessLevel.Local,
+                "Basic" => AccessLevel.Basic,
+                _ => AccessLevel.None
+            };
+            return getAccessLevelIcon(level);
+        }
     }
 }