Psr12

.pre-commit-config.yaml

@@ -19,7 +19,7 @@ repos:
         entry: phpcbf
         language: system
         files: \.php$
-        args: [--standard=PSR2, --colors]
+        args: [--standard=PSR12, --colors]
 
   # linters (work required) ########################################################################
   # - repo: https://github.com/pre-commit/pre-commit-hooks
@@ -41,7 +41,7 @@ repos:
         entry: phpcs
         language: system
         files: \.php$
-        args: [--standard=PSR2, --colors]
+        args: [--standard=PSR12, --colors]
       - id: php-l
         name: php -l
         entry: php

resources/lib/UnityGroup.php

@@ -24,9 +24,9 @@ class UnityGroup
     /**
      * Constructor for the object
      *
-     * @param string $gid PI UID in the format <PI_PREFIX><OWNER_UID>
-     * @param LDAP $LDAP LDAP Connection
-     * @param SQL $SQL SQL Connection
+     * @param string $gid  PI UID in the format <PI_PREFIX><OWNER_UID>
+     * @param LDAP   $LDAP LDAP Connection
+     * @param SQL    $SQL  SQL Connection
      */
     public function __construct($gid, $LDAP, $SQL, $MAILER, $REDIS, $WEBHOOK)
     {

resources/lib/UnityLDAP.php

@@ -10,7 +10,7 @@
  */
 class UnityLDAP extends ldapConn
 {
-  // User Specific Constants
+    // User Specific Constants
     private const RDN = "cn";  // The defauls RDN for LDAP entries is set to "common name"
 
     public const POSIX_ACCOUNT_CLASS = array(
@@ -25,15 +25,15 @@ class UnityLDAP extends ldapConn
     "top"
     );
 
-  // string vars for OUs
+    // string vars for OUs
     private $STR_BASEOU;
     private $STR_USEROU;
     private $STR_GROUPOU;
     private $STR_PIGROUPOU;
     private $STR_ORGGROUPOU;
     private $STR_ADMINGROUP;
 
-  // Instance vars for various ldapEntry objects
+    // Instance vars for various ldapEntry objects
     private $baseOU;
     private $userOU;
     private $groupOU;
@@ -69,7 +69,7 @@ public function __construct(
         $this->STR_ORGGROUPOU = $orggroup_ou;
         $this->STR_ADMINGROUP = $admin_group;
 
-      // Get Global Entries
+        // Get Global Entries
         $this->baseOU = $this->getEntry($base_ou);
         $this->userOU = $this->getEntry($user_ou);
         $this->groupOU = $this->getEntry($group_ou);
@@ -83,9 +83,9 @@ public function __construct(
         $this->def_user_shell = $def_user_shell;
     }
 
-  //
-  // Get methods for OU
-  //
+    //
+    // Get methods for OU
+    //
     public function getUserOU()
     {
         return $this->userOU;
@@ -121,9 +121,9 @@ public function getDefUserShell()
         return $this->def_user_shell;
     }
 
-  //
-  // ID Number selection functions
-  //
+    //
+    // ID Number selection functions
+    //
     public function getNextUIDNumber($UnitySQL)
     {
         $max_uid = $UnitySQL->getSiteVar('MAX_UID');
@@ -198,7 +198,7 @@ private function IDNumInUse($id)
     public function getUnassignedID($uid, $UnitySQL)
     {
         $netid = strtok($uid, "_");  // extract netid
-      // scrape all files in custom folder
+        // scrape all files in custom folder
         $dir = new \DirectoryIterator($this->custom_mappings_path);
         foreach ($dir as $fileinfo) {
             if ($fileinfo->getExtension() == "csv") {
@@ -218,7 +218,7 @@ public function getUnassignedID($uid, $UnitySQL)
             }
         }
 
-      // didn't find anything from existing mappings, use next available
+        // didn't find anything from existing mappings, use next available
         $next_uid = $this->getNextUIDNumber($UnitySQL);
 
         return $next_uid;
@@ -231,9 +231,9 @@ public function getAllUsersUIDs()
         return $this->userGroup->getAttribute("memberuid");
     }
 
-  //
-  // Functions that return user/group objects
-  //
+    //
+    // Functions that return user/group objects
+    //
     public function getAllUsers($UnitySQL, $UnityMailer, $UnityRedis, $UnityWebhook, $ignorecache = false)
     {
         $out = array();
@@ -292,14 +292,17 @@ public function getAllPIGroups($UnitySQL, $UnityMailer, $UnityRedis, $UnityWebho
         $pi_groups = $this->pi_groupOU->getChildren(true);
 
         foreach ($pi_groups as $pi_group) {
-            array_push($out, new UnityGroup(
-                $pi_group->getAttribute("cn")[0],
-                $this,
-                $UnitySQL,
-                $UnityMailer,
-                $UnityRedis,
-                $UnityWebhook
-            ));
+            array_push(
+                $out,
+                new UnityGroup(
+                    $pi_group->getAttribute("cn")[0],
+                    $this,
+                    $UnitySQL,
+                    $UnityMailer,
+                    $UnityRedis,
+                    $UnityWebhook
+                )
+            );
         }
 
         return $out;
@@ -341,7 +344,9 @@ public function getAllPIGroupOwnerAttributes($attributes)
         return $owner_attributes;
     }
 
-    /** Returns an associative array where keys are UIDs and values are arrays of PI GIDs */
+    /**
+     * Returns an associative array where keys are UIDs and values are arrays of PI GIDs
+     */
     public function getAllUID2PIGIDs()
     {
         // initialize output so each UID is a key with an empty array as its value
@@ -375,14 +380,17 @@ public function getAllOrgGroups($UnitySQL, $UnityMailer, $UnityRedis, $UnityWebh
         $org_groups = $this->org_groupOU->getChildren(true);
 
         foreach ($org_groups as $org_group) {
-            array_push($out, new UnityOrg(
-                $org_group->getAttribute("cn")[0],
-                $this,
-                $UnitySQL,
-                $UnityMailer,
-                $UnityRedis,
-                $UnityWebhook
-            ));
+            array_push(
+                $out,
+                new UnityOrg(
+                    $org_group->getAttribute("cn")[0],
+                    $this,
+                    $UnitySQL,
+                    $UnityMailer,
+                    $UnityRedis,
+                    $UnityWebhook
+                )
+            );
         }
 
         return $out;

resources/lib/UnitySite.php

@@ -105,9 +105,9 @@ public static function testValidSSHKey($key_str)
         try {
             PublicKeyLoader::load($key_str);
             return true;
-        // phpseclib should throw only NoKeyLoadedException but that is not the case
-        // https://github.com/phpseclib/phpseclib/pull/2078
-        // } catch (\phpseclib3\Exception\NoKeyLoadedException $e) {
+            // phpseclib should throw only NoKeyLoadedException but that is not the case
+            // https://github.com/phpseclib/phpseclib/pull/2078
+            // } catch (\phpseclib3\Exception\NoKeyLoadedException $e) {
         } catch (\Throwable $e) {
             return false;
         }

resources/lib/UnityUser.php

@@ -49,11 +49,11 @@ public function __toString()
     /**
      * This is the method that is run when a new account is created
      *
-     * @param string $firstname First name of new account
-     * @param string $lastname Last name of new account
-     * @param string $email email of new account
-     * @param string $org organization name of new account
-     * @param bool $isPI boolean value for if the user checked the "I am a PI box"
+     * @param  string $firstname First name of new account
+     * @param  string $lastname  Last name of new account
+     * @param  string $email     email of new account
+     * @param  string $org       organization name of new account
+     * @param  bool   $isPI      boolean value for if the user checked the "I am a PI box"
      * @return void
      */
     public function init($firstname, $lastname, $email, $org, $send_mail = true)
@@ -575,6 +575,7 @@ public function getOrgGroup()
 
     /**
      * Gets the groups this user is assigned to, can be more than one
+     *
      * @return string[]
      */
     public function getPIGroupGIDs($ignorecache = false)
@@ -621,11 +622,11 @@ public function hasRequestedAccountDeletion()
 
     /**
      * Checks whether a user is in a group or not
-     * @param  string  $uid   uid of the user
+     *
+     * @param  string            $uid   uid of the user
      * @param  string  or object $group group to check
      * @return boolean true if user is in group, false if not
      */
-
     public function isInGroup($uid, $group)
     {
         if (gettype($group) == "string") {

resources/lib/exceptions/PhpUnitNoDieException.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace UnityWebPortal\lib\exceptions;
 
 class PhpUnitNoDieException extends \Exception

resources/lib/exceptions/SSOException.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace UnityWebPortal\lib\exceptions;
 
 class SSOException extends \Exception

resources/templates/header.php

@@ -3,7 +3,8 @@
 use UnityWebPortal\lib\UnitySite;
 
 if ($_SERVER["REQUEST_METHOD"] == "POST") {
-    if ((@$_SESSION["is_admin"] ?? false) == true
+    if (
+        (@$_SESSION["is_admin"] ?? false) == true
         && (@$_POST["form_type"] ?? null) == "clearView"
     ) {
         unset($_SESSION["viewUser"]);
@@ -78,27 +79,27 @@
     }
 
     if (isset($_SESSION["user_exists"]) && $_SESSION["user_exists"]) {
-      // Menu Items for Present Users
+        // Menu Items for Present Users
         echo "<a href='" . $CONFIG["site"]["prefix"] . "/panel/support.php'>Support</a>";
         echo "<a href='" . $CONFIG["site"]["prefix"] . "/panel/account.php'>Account Settings</a>";
         echo "<a href='" . $CONFIG["site"]["prefix"] . "/panel/groups.php'>My PIs</a>";
 
         if (isset($_SESSION["is_pi"]) && $_SESSION["is_pi"]) {
-          // PI only pages
+            // PI only pages
             echo "<a href='" . $CONFIG["site"]["prefix"] . "/panel/pi.php'>My Users</a>";
         }
 
-      // additional branding items
+        // additional branding items
         $num_additional_items = count($CONFIG["menuitems_secure"]["labels"]);
         for ($i = 0; $i < $num_additional_items; $i++) {
             echo "<a target='_blank' href='" . $CONFIG["menuitems_secure"]["links"][$i] . "'>" .
             $CONFIG["menuitems_secure"]["labels"][$i] . "</a>";
         }
 
-      // admin pages
+        // admin pages
         if (isset($_SESSION["is_admin"]) && $_SESSION["is_admin"] && !isset($_SESSION["viewUser"])) {
             echo "<hr class='navHR'>";
-          // Admin only pages
+            // Admin only pages
             echo "<a href='" . $CONFIG["site"]["prefix"] . "/admin/user-mgmt.php'>User Management</a>";
             echo "<a href='" . $CONFIG["site"]["prefix"] . "/admin/pi-mgmt.php'>PI Management</a>";
             echo "<a href='" . $CONFIG["site"]["prefix"] . "/admin/notices.php'>Cluster Notices</a>";
@@ -132,7 +133,8 @@
   <main>
 
   <?php
-    if (isset($_SESSION["is_admin"])
+    if (
+        isset($_SESSION["is_admin"])
         && $_SESSION["is_admin"]
         && isset($_SESSION["viewUser"])
     ) {

webroot/admin/content.php

@@ -14,7 +14,7 @@
     }
 }
 
-include $LOC_HEADER;
+require $LOC_HEADER;
 ?>
 
 <h1>Page Content Management</h1>
@@ -67,4 +67,4 @@
 </script>
 
 <?php
-include $LOC_FOOTER;
+require $LOC_FOOTER;

webroot/admin/notices.php

@@ -25,7 +25,7 @@
     }
 }
 
-include $LOC_HEADER;
+require $LOC_HEADER;
 ?>
 
 <h1>Cluster Notice Management</h1>
@@ -153,4 +153,4 @@
 </script>
 
 <?php
-include $LOC_FOOTER;
+require $LOC_FOOTER;

webroot/admin/pi-mgmt.php

@@ -47,7 +47,7 @@
     }
 }
 
-include $LOC_HEADER;
+require $LOC_HEADER;
 ?>
 
 <h1>PI Management</h1>
@@ -136,4 +136,4 @@
 </script>
 
 <?php
-include $LOC_FOOTER;
+require $LOC_FOOTER;

webroot/admin/user-mgmt.php

@@ -17,7 +17,7 @@
     }
 }
 
-include $LOC_HEADER;
+require $LOC_HEADER;
 ?>
 
 <h1>User Management</h1>
@@ -74,4 +74,4 @@
 </table>
 
 <?php
-include $LOC_FOOTER;
+require $LOC_FOOTER;

webroot/index.php

@@ -2,7 +2,7 @@
 
 require_once __DIR__ . "/../resources/autoload.php";
 
-include $LOC_HEADER;
+require $LOC_HEADER;
 ?>
 
 

webroot/panel/account.php

@@ -90,7 +90,7 @@
     }
 }
 
-include $LOC_HEADER;
+require $LOC_HEADER;
 
 $uid = $USER->uid;
 $org = $USER->getOrg();

webroot/panel/groups.php

@@ -56,7 +56,7 @@
     }
 }
 
-include $LOC_HEADER;
+require $LOC_HEADER;
 ?>
 
 <h1>My Principal Investigators</h1>
@@ -192,4 +192,4 @@
 </style>
 
 <?php
-include $LOC_FOOTER;
+require $LOC_FOOTER;