refactor: changed permission strings to permission enums

thorsten · Jan 17, 2024 · 8827b52 · 8827b52
1 parent b0bcda5
commit 8827b52
Show file tree

Hide file tree

Showing 9 changed files with 92 additions and 40 deletions.
diff --git a/phpmyfaq/admin/header.php b/phpmyfaq/admin/header.php
@@ -16,6 +16,7 @@
  */
 
 use phpMyFAQ\Configuration;
+use phpMyFAQ\Enums\PermissionType;
 use phpMyFAQ\Helper\AdministrationHelper;
 use phpMyFAQ\Helper\LanguageHelper;
 use phpMyFAQ\Services\Gravatar;
@@ -63,15 +64,25 @@
     'ad_menu_categ_edit',
     $action
 );
-$secLevelEntries['content'] .= $adminHelper->addMenuEntry('add_faq', 'editentry', 'ad_entry_add', $action);
+$secLevelEntries['content'] .= $adminHelper->addMenuEntry(
+    PermissionType::FAQ_ADD->value,
+    'editentry',
+    'ad_entry_add',
+    $action
+);
 $secLevelEntries['content'] .= $adminHelper->addMenuEntry(
     'edit_faq+delete_faq',
     'faqs-overview',
     'ad_menu_entry_edit',
     $action
 );
 
-$secLevelEntries['content'] .= $adminHelper->addMenuEntry('edit_faq', 'stickyfaqs', 'stickyRecordsHeader', $action);
+$secLevelEntries['content'] .= $adminHelper->addMenuEntry(
+    PermissionType::FAQ_EDIT->value,
+    'stickyfaqs',
+    'stickyRecordsHeader',
+    $action
+);
 $secLevelEntries['content'] .= $adminHelper->addMenuEntry('delcomment', 'comments', 'ad_menu_comments', $action);
 $secLevelEntries['content'] .= $adminHelper->addMenuEntry('delquestion', 'question', 'ad_menu_open', $action);
 $secLevelEntries['content'] .= $adminHelper->addMenuEntry(
@@ -92,15 +103,45 @@
     'ad_menu_attachments',
     $action
 );
-$secLevelEntries['content'] .= $adminHelper->addMenuEntry('edit_faq', 'tags', 'ad_entry_tags', $action);
+$secLevelEntries['content'] .= $adminHelper->addMenuEntry(
+    PermissionType::FAQ_EDIT->value,
+    'tags',
+    'ad_entry_tags',
+    $action
+);
 
-$secLevelEntries['statistics'] = $adminHelper->addMenuEntry('viewlog', 'statistics', 'ad_menu_stat', $action);
-$secLevelEntries['statistics'] .= $adminHelper->addMenuEntry('viewlog', 'viewsessions', 'ad_menu_session', $action);
-$secLevelEntries['statistics'] .= $adminHelper->addMenuEntry('adminlog', 'adminlog', 'ad_menu_adminlog', $action);
-$secLevelEntries['statistics'] .= $adminHelper->addMenuEntry('viewlog', 'searchstats', 'ad_menu_searchstats', $action);
+$secLevelEntries['statistics'] = $adminHelper->addMenuEntry(
+    PermissionType::STATISTICS_VIEWLOGS->value,
+    'statistics',
+    'ad_menu_stat',
+    $action
+);
+$secLevelEntries['statistics'] .= $adminHelper->addMenuEntry(
+    PermissionType::STATISTICS_VIEWLOGS->value,
+    'viewsessions',
+    'ad_menu_session',
+    $action
+);
+$secLevelEntries['statistics'] .= $adminHelper->addMenuEntry(
+    PermissionType::STATISTICS_ADMINLOG->value,
+    'adminlog',
+    'ad_menu_adminlog',
+    $action
+);
+$secLevelEntries['statistics'] .= $adminHelper->addMenuEntry(
+    PermissionType::STATISTICS_VIEWLOGS->value,
+    'searchstats',
+    'ad_menu_searchstats',
+    $action
+);
 $secLevelEntries['statistics'] .= $adminHelper->addMenuEntry('reports', 'reports', 'ad_menu_reports', $action);
 
-$secLevelEntries['imports_exports'] = $adminHelper->addMenuEntry('add_faq', 'importcsv', 'msgImportRecords', $action);
+$secLevelEntries['imports_exports'] = $adminHelper->addMenuEntry(
+    PermissionType::FAQ_ADD->value,
+    'importcsv',
+    'msgImportRecords',
+    $action
+);
 $secLevelEntries['imports_exports'] .= $adminHelper->addMenuEntry('export', 'export', 'ad_menu_export', $action);
 
 $secLevelEntries['backup'] = $adminHelper->addMenuEntry('editconfig', 'backup', 'ad_menu_backup', $action);

diff --git a/phpmyfaq/admin/record.edit.php b/phpmyfaq/admin/record.edit.php
@@ -947,8 +947,14 @@ function setRecordDate(how) {
         }
     </script>
     <?php
-} elseif ($user->perm->hasPermission($currentUserId, 'edit_faq') && !Database::checkOnEmptyTable('faqcategories')) {
+} elseif (
+    $user->perm->hasPermission($currentUserId, PermissionType::FAQ_EDIT->value) &&
+    !Database::checkOnEmptyTable('faqcategories')
+) {
     require 'no-permission.php';
-} elseif ($user->perm->hasPermission($currentUserId, 'edit_faq') && Database::checkOnEmptyTable('faqcategories')) {
+} elseif (
+    $user->perm->hasPermission($currentUserId, PermissionType::FAQ_EDIT->value) &&
+    Database::checkOnEmptyTable('faqcategories')
+) {
     echo Translation::get('no_cats');
 }
diff --git a/phpmyfaq/admin/stat.adminlog.php b/phpmyfaq/admin/stat.adminlog.php
@@ -146,7 +146,11 @@
     </table>
 
     <?php
-} elseif ($user->perm->hasPermission($user->getUserId(), 'adminlog') && 'deleteadminlog' === $action && $deleteLog) {
+} elseif (
+    $user->perm->hasPermission($user->getUserId(), PermissionType::STATISTICS_ADMINLOG->value) &&
+    'deleteadminlog' === $action &&
+    $deleteLog
+) {
     if ($logging->delete()) {
         echo Alert::success('ad_adminlog_delete_success');
     } else {

diff --git a/phpmyfaq/admin/tags.php b/phpmyfaq/admin/tags.php
@@ -16,6 +16,7 @@
  */
 
 use phpMyFAQ\Configuration;
+use phpMyFAQ\Enums\PermissionType;
 use phpMyFAQ\Filter;
 use phpMyFAQ\Session\Token;
 use phpMyFAQ\Tags;
@@ -65,7 +66,7 @@
 
 echo $template->render($templateVars);
 
-if (!$user->perm->hasPermission($user->getUserId(), 'edit_faq')) {
+if (!$user->perm->hasPermission($user->getUserId(), PermissionType::FAQ_EDIT->value)) {
     require 'no-permission.php';
 }
 
diff --git a/phpmyfaq/admin/user.php b/phpmyfaq/admin/user.php
@@ -279,15 +279,15 @@ class="d-flex justify-content-between flex-wrap flex-md-nowrap align-items-cente
             <div class="btn-toolbar mb-2 mb-md-0">
                 <div class="btn-group mr-2">
                     <?php
-                    if ($currentUser->perm->hasPermission($user->getUserId(), 'add_user')) : ?>
+                    if ($currentUser->perm->hasPermission($user->getUserId(), PermissionType::USER_ADD->value)) : ?>
                         <button type="button" class="btn btn-outline-primary" data-bs-toggle="modal"
                                 data-bs-target="#addUserModal">
                             <i class="bi bi-person-add" aria-label="true"></i> <?= Translation::get('ad_user_add') ?>
                         </button>
                         <?php
                     endif ?>
                     <?php
-                    if ($currentUser->perm->hasPermission($user->getUserId(), 'edit_user')) : ?>
+                    if ($currentUser->perm->hasPermission($user->getUserId(), PermissionType::USER_EDIT->value)) : ?>
                         <a class="btn btn-outline-info" href="?action=user&amp;user_action=listallusers">
                             <i class="bi bi-people" aria-label="true"></i> <?= Translation::get('list_all_users') ?>
                         </a>

diff --git a/phpmyfaq/faq.php b/phpmyfaq/faq.php
@@ -25,6 +25,7 @@
 use phpMyFAQ\Comments;
 use phpMyFAQ\Date;
 use phpMyFAQ\Entity\CommentType;
+use phpMyFAQ\Enums\PermissionType;
 use phpMyFAQ\Faq\FaqPermission;
 use phpMyFAQ\Filter;
 use phpMyFAQ\Glossary;
@@ -194,7 +195,7 @@
 
 // Show link to edit the faq?
 $editThisEntry = '';
-if ($user->perm->hasPermission($user->getUserId(), 'edit_faq')) {
+if ($user->perm->hasPermission($user->getUserId(), PermissionType::FAQ_EDIT->value)) {
     $editThisEntry = sprintf(
         '<i aria-hidden="true" class="bi bi-pencil"></i> ' .
         '<a class="text-decoration-none" href="./admin/index.php?action=editentry&id=%d&lang=%s">%s</a>',
@@ -243,7 +244,10 @@
     );
 }
 
-if ($user->perm->hasPermission($user->getUserId(), 'edit_faq') && !empty($faq->faqRecord['notes'])) {
+if (
+    $user->perm->hasPermission($user->getUserId(), PermissionType::FAQ_EDIT->value) &&
+    !empty($faq->faqRecord['notes'])
+) {
     $template->parseBlock(
         'mainPageContent',
         'privateNotes',

diff --git a/phpmyfaq/src/phpMyFAQ/Controller/AbstractController.php b/phpmyfaq/src/phpMyFAQ/Controller/AbstractController.php
@@ -18,6 +18,7 @@
 namespace phpMyFAQ\Controller;
 
 use phpMyFAQ\Configuration;
+use phpMyFAQ\Enums\PermissionType;
 use phpMyFAQ\Template\TemplateException;
 use phpMyFAQ\Template\TwigWrapper;
 use phpMyFAQ\User\CurrentUser;
@@ -90,10 +91,10 @@ protected function userHasGroupPermission(): void
         $configuration = Configuration::getConfigurationInstance();
         $user = CurrentUser::getCurrentUser($configuration);
         if (
-            !$user->perm->hasPermission($user->getUserId(), 'add_user') ||
-            !$user->perm->hasPermission($user->getUserId(), 'edit_user') ||
-            !$user->perm->hasPermission($user->getUserId(), 'delete_user') ||
-            !$user->perm->hasPermission($user->getUserId(), 'editgroup')
+            !$user->perm->hasPermission($user->getUserId(), PermissionType::USER_ADD->value) ||
+            !$user->perm->hasPermission($user->getUserId(), PermissionType::USER_EDIT->value) ||
+            !$user->perm->hasPermission($user->getUserId(), PermissionType::USER_DELETE->value) ||
+            !$user->perm->hasPermission($user->getUserId(), PermissionType::GROUP_EDIT->value)
         ) {
             throw new UnauthorizedHttpException('User has no group permission.');
         }
@@ -107,9 +108,9 @@ protected function userHasUserPermission(): void
         $configuration = Configuration::getConfigurationInstance();
         $user = CurrentUser::getCurrentUser($configuration);
         if (
-            !$user->perm->hasPermission($user->getUserId(), 'add_user') ||
-            !$user->perm->hasPermission($user->getUserId(), 'edit_user') ||
-            !$user->perm->hasPermission($user->getUserId(), 'delete_user')
+            !$user->perm->hasPermission($user->getUserId(), PermissionType::USER_ADD->value) ||
+            !$user->perm->hasPermission($user->getUserId(), PermissionType::USER_EDIT->value) ||
+            !$user->perm->hasPermission($user->getUserId(), PermissionType::USER_DELETE->value)
         ) {
             throw new UnauthorizedHttpException('User has no user permission.');
         }
@@ -118,12 +119,12 @@ protected function userHasUserPermission(): void
     /**
      * @throws UnauthorizedHttpException
      */
-    protected function userHasPermission(string $permission): void
+    protected function userHasPermission(PermissionType $permission): void
     {
         $configuration = Configuration::getConfigurationInstance();
         $user = CurrentUser::getCurrentUser($configuration);
         if (!$user->perm->hasPermission($user->getUserId(), $permission)) {
-            throw new UnauthorizedHttpException(sprintf('User has no "%s" permission.', $permission));
+            throw new UnauthorizedHttpException(sprintf('User has no "%s" permission.', $permission->value));
         }
     }
 }
diff --git a/phpmyfaq/src/phpMyFAQ/Controller/Administration/TagController.php b/phpmyfaq/src/phpMyFAQ/Controller/Administration/TagController.php
@@ -91,7 +91,7 @@ public function search(Request $request): JsonResponse
             $tags = $tag->getAllTags();
         }
 
-        if ($user->perm->hasPermission($user->getUserId(), 'edit_faq')) {
+        if ($user->perm->hasPermission($user->getUserId(), PermissionType::FAQ_EDIT->value)) {
             $i = 0;
             $tagNames = [];
             foreach ($tags as $tagName) {

diff --git a/phpmyfaq/src/phpMyFAQ/Setup/Installer.php b/phpmyfaq/src/phpMyFAQ/Setup/Installer.php
@@ -54,40 +54,35 @@ class Installer extends Setup
      */
     protected array $mainRights = [
         [
-            'name' => 'add_user',
+            'name' => PermissionType::USER_ADD->value,
             'description' => 'Right to add user accounts',
         ],
         [
-            'name' => 'edit_user',
+            'name' => PermissionType::USER_EDIT->value,
             'description' => 'Right to edit user accounts',
         ],
         [
-            'name' => 'delete_user',
+            'name' => PermissionType::USER_DELETE->value,
             'description' => 'Right to delete user accounts',
         ],
-        //4 => "add_faq",
         [
-            'name' => 'add_faq',
+            'name' => PermissionType::FAQ_ADD->value,
             'description' => 'Right to add faq entries',
         ],
-        //5 => "edit_faq",
         [
-            'name' => 'edit_faq',
+            'name' => PermissionType::FAQ_EDIT->value,
             'description' => 'Right to edit faq entries',
         ],
-        //6 => "delete_faq",
         [
-            'name' => 'delete_faq',
+            'name' => PermissionType::FAQ_DELETE->value,
             'description' => 'Right to delete faq entries',
         ],
-        //7 => "viewlog",
         [
-            'name' => 'viewlog',
+            'name' => PermissionType::STATISTICS_VIEWLOGS->value,
             'description' => 'Right to view logfiles',
         ],
-        //8 => "adminlog",
         [
-            'name' => 'adminlog',
+            'name' => PermissionType::STATISTICS_ADMINLOG->value,
             'description' => 'Right to view admin log',
         ],
         //9 => "delcomment",
@@ -210,7 +205,7 @@ class Installer extends Setup
         ],
         // 34 => 'addattachment'
         [
-            'name' => 'addattachment',
+            'name' => PermissionType::ATTACHMENT_ADD->value,
             'description' => 'Right to add attachments',
         ],
         // 35 => 'editattachment'