BurningFlipside / CommonCode

Auth/class.LDAPUser.php

Doc Comments +3 added lines

@@ -50,6 +50,9 @@
         return $res;
     }
 
+    /**
+     * @param string $listName
+     */
     private function isInListOrChild($listName, $group, $dn)
     {
         if(!isset($group[$listName]))

Spacing +40 added lines, -40 removed lines

@@ -8,15 +8,15 @@ 
     private $ldapObj;
     private $server;
 
-    public function __construct($data=false)
+    public function __construct($data = false)
     {
         $this->server = \LDAP\LDAPServer::getInstance();
-        if($data !== false && !isset($data['dn']) && !isset($data['extended']))
+        if ($data !== false && !isset($data['dn']) && !isset($data['extended']))
         {
             //Generic user object
             $filter = new \Data\Filter('mail eq '.$data['mail']);
             $users = $this->server->read($this->server->user_base, $filter);
-            if($users === false || !isset($users[0]))
+            if ($users === false || !isset($users[0]))
             {
                 throw new \Exception('No such LDAP User!');
             }
@@ -24,7 +24,7 @@ 
         }
         else
         {
-            if(isset($data['extended']))
+            if (isset($data['extended']))
             {
                 $this->ldapObj = $data['extended'];
             }
@@ -38,13 +38,13 @@ 
     private function check_child_group($array)
     {
         $res = false;
-        for($i = 0; $i < $array['count']; $i++)
+        for ($i = 0; $i < $array['count']; $i++)
         {
-            if(strpos($array[$i], $this->server->group_base) !== false)
+            if (strpos($array[$i], $this->server->group_base) !== false)
             {
                 $dn = explode(',', $array[$i]);
                 $res = $this->isInGroupNamed(substr($dn[0], 3));
-                if($res) return $res;
+                if ($res) return $res;
             }
         }
         return $res;
@@ -52,11 +52,11 @@ 
 
     private function isInListOrChild($listName, $group, $dn)
     {
-        if(!isset($group[$listName]))
+        if (!isset($group[$listName]))
         {
             return false;
         }
-        if(in_array($dn, $group[$listName]))
+        if (in_array($dn, $group[$listName]))
         {
             return true;
         }
@@ -67,17 +67,17 @@ 
     {
         $filter = new \Data\Filter('cn eq '.$name);
         $group = $this->server->read($this->server->group_base, $filter);
-        if(!empty($group))
+        if (!empty($group))
         {
             $group = $group[0];
             $dn  = $this->ldapObj->dn;
             $uid = $this->ldapObj->uid[0];
             $ret = $this->isInListOrChild('member', $group, $dn);
-            if($ret === false)
+            if ($ret === false)
             {
                 $ret = $this->isInListOrChild('uniquemember', $group, $dn);
             }
-            if($ret === false && isset($group['memberUid']) && in_array($uid, $group['memberUid']))
+            if ($ret === false && isset($group['memberUid']) && in_array($uid, $group['memberUid']))
             {
                 return true;
             }
@@ -119,7 +119,7 @@ 
     public function getOrganization()
     {
         $org = $this->getFieldSingleValue('o');
-        if($org === false)
+        if ($org === false)
         {
             return 'Volunteer';
         }
@@ -129,7 +129,7 @@ 
     public function getTitles()
     {
         $titles = $this->getField('title');
-        if(isset($titles['count']))
+        if (isset($titles['count']))
         {
             unset($titles['count']);
         }
@@ -174,7 +174,7 @@ 
     public function getOrganizationUnits()
     {
         $units = $this->getField('ou');
-        if(isset($units['count']))
+        if (isset($units['count']))
         {
             unset($units['count']);
         }
@@ -184,7 +184,7 @@ 
     public function getLoginProviders()
     {
         $hosts = $this->getField('host');
-        if(isset($hosts['count']))
+        if (isset($hosts['count']))
         {
             unset($hosts['count']);
         }
@@ -195,12 +195,12 @@ 
     {
         $res = array();
         $groups = $this->server->read($this->server->group_base);
-        if(!empty($groups))
+        if (!empty($groups))
         {
             $count = count($groups);
-            for($i = 0; $i < $count; $i++)
+            for ($i = 0; $i < $count; $i++)
             {
-                if($this->isInGroupNamed($groups[$i]['cn'][0]))
+                if ($this->isInGroupNamed($groups[$i]['cn'][0]))
                 {
                     array_push($res, new LDAPGroup($groups[$i]));
                 }
@@ -220,23 +220,23 @@ 
 
     private function generateLDAPPass($pass)
     {
-        mt_srand((double)microtime()*1000000);
+        mt_srand((double)microtime() * 1000000);
         $salt = pack("CCCC", mt_rand(), mt_rand(), mt_rand(), mt_rand());
-        $hash = base64_encode(pack('H*',sha1($pass.$salt)).$salt);
+        $hash = base64_encode(pack('H*', sha1($pass.$salt)).$salt);
         return '{SSHA}'.$hash;
     }
 
     public function setPass($password)
     {
-        if(!is_object($this->ldapObj))
+        if (!is_object($this->ldapObj))
         {
-            return $this->setFieldLocal('userPassword',  $this->generateLDAPPass($password));
+            return $this->setFieldLocal('userPassword', $this->generateLDAPPass($password));
         }
         else
         {
             $obj = array('dn'=>$this->ldapObj->dn);
             $obj['userPassword'] = $this->generateLDAPPass($password);
-            if(isset($this->ldapObj->uniqueidentifier))
+            if (isset($this->ldapObj->uniqueidentifier))
             {
                $obj['uniqueIdentifier'] = null;
             }
@@ -250,7 +250,7 @@ 
 
     public function validate_password($password)
     {
-        if($this->server->bind($this->ldapObj->dn, $password))
+        if ($this->server->bind($this->ldapObj->dn, $password))
         {
             return true;
         }
@@ -259,37 +259,37 @@ 
 
     public function validate_reset_hash($hash)
     {
-        if(isset($this->ldapObj->uniqueidentifier) && strcmp($this->ldapObj->uniqueidentifier[0], $hash) === 0)
+        if (isset($this->ldapObj->uniqueidentifier) && strcmp($this->ldapObj->uniqueidentifier[0], $hash) === 0)
         {
             return true;
         }
         return false;
     }
 
-    static function from_name($name, $data=false)
+    static function from_name($name, $data = false)
     {
-        if($data === false)
+        if ($data === false)
         {
             throw new \Exception('data must be set for LDAPUser');
         }
         $filter = new \Data\Filter("uid eq $name");
         $user = $data->read($data->user_base, $filter);
-        if($user === false || !isset($user[0]))
+        if ($user === false || !isset($user[0]))
         {
             return false;
         }
         return new static($user[0]);
     }
 
-    static function from_dn($dn, $data=false)
+    static function from_dn($dn, $data = false)
     {
-        if($data === false)
+        if ($data === false)
         {
             throw new \Exception('data must be set for LDAPUser');
         }
         $filter = new \Data\Filter("dn eq $dn");
         $user = $data->read($data->user_base, $filter);
-        if($user === false || !isset($user[0]))
+        if ($user === false || !isset($user[0]))
         {
             return false;
         }
@@ -318,7 +318,7 @@ 
 
     public function setUid($uid)
     {
-        if(!is_object($this->ldapObj))
+        if (!is_object($this->ldapObj))
         {
             return $this->setFieldLocal('uid', $uid);
         }
@@ -366,7 +366,7 @@ 
 
     public function setTitles($titles)
     {
-        if(!is_array($titles))
+        if (!is_array($titles))
         {
             $titles = array($titles);
         }
@@ -375,7 +375,7 @@ 
 
     public function setOrganizationUnits($ous)
     {
-        if(!is_array($ous))
+        if (!is_array($ous))
         {
             $ous = array($ous);
         }
@@ -384,7 +384,7 @@ 
 
     public function flushUser()
     {
-        if(is_object($this->ldapObj))
+        if (is_object($this->ldapObj))
         {
             //In this mode we are always up to date
             return true;
@@ -392,11 +392,11 @@ 
         $obj = $this->ldapObj;
         $obj['objectClass'] = array('top', 'inetOrgPerson', 'extensibleObject');
         $obj['dn'] = 'uid='.$this->ldapObj['uid'].','.$this->server->user_base;
-        if(!isset($obj['sn']))
+        if (!isset($obj['sn']))
         {
             $obj['sn'] = $obj['uid'];
         }
-        if(!isset($obj['cn']))
+        if (!isset($obj['cn']))
         {
             $obj['cn'] = $obj['uid'];
         }
@@ -413,7 +413,7 @@ 
         $ldapObj = $this->server->read($ldap->user_base, new \Data\Filter('uid eq '.$this->getUid()));
         $ldapObj = $ldapObj[0];
         $hash = false;
-        if(isset($ldapObj->userpassword))
+        if (isset($ldapObj->userpassword))
         {
             $hash = hash('sha512', $ldapObj->dn.';'.$ldapObj->userpassword[0].';'.$ldapObj->mail[0]);
         }
@@ -423,7 +423,7 @@ 
         }
         $obj = array('dn'=>$this->ldapObj->dn);
         $obj['uniqueIdentifier'] = $hash;
-        if($this->server->update($obj) === false)
+        if ($this->server->update($obj) === false)
         {
             throw new \Exception('Unable to create hash in LDAP object!');
         }

Braces +9 added lines, -13 removed lines

@@ -21,14 +21,12 @@ 
                 throw new \Exception('No such LDAP User!');
             }
             $this->ldapObj = $users[0];
-        }
-        else
+        } else
         {
             if(isset($data['extended']))
             {
                 $this->ldapObj = $data['extended'];
-            }
-            else
+            } else
             {
                 $this->ldapObj = $data;
             }
@@ -44,7 +42,9 @@ 
             {
                 $dn = explode(',', $array[$i]);
                 $res = $this->isInGroupNamed(substr($dn[0], 3));
-                if($res) return $res;
+                if($res) {
+                    return $res;
+                }
             }
         }
         return $res;
@@ -206,8 +206,7 @@ 
                 }
             }
             return $res;
-        }
-        else
+        } else
         {
             return false;
         }
@@ -231,8 +230,7 @@ 
         if(!is_object($this->ldapObj))
         {
             return $this->setFieldLocal('userPassword',  $this->generateLDAPPass($password));
-        }
-        else
+        } else
         {
             $obj = array('dn'=>$this->ldapObj->dn);
             $obj['userPassword'] = $this->generateLDAPPass($password);
@@ -321,8 +319,7 @@ 
         if(!is_object($this->ldapObj))
         {
             return $this->setFieldLocal('uid', $uid);
-        }
-        else
+        } else
         {
             throw new \Exception('Unsupported!');
         }
@@ -416,8 +413,7 @@ 
         if(isset($ldapObj->userpassword))
         {
             $hash = hash('sha512', $ldapObj->dn.';'.$ldapObj->userpassword[0].';'.$ldapObj->mail[0]);
-        }
-        else
+        } else
         {
             $hash = hash('sha512', $ldapObj->dn.';'.openssl_random_pseudo_bytes(10).';'.$ldapObj->mail[0]);
         }

Auth/class.User.php

Doc Comments +43 added lines, -43 removed lines

@@ -31,7 +31,7 @@ 
      *
      * @param string $name The name of the group to check if the user is in
      *
-     * @return true|false True if the user is in the group, false otherwise
+     * @return boolean True if the user is in the group, false otherwise
      */
     function isInGroupNamed($name)
     {
@@ -41,7 +41,7 @@ 
     /**
      * The name the user should be displayed as
      *
-     * @return string The name the user should be displayed as
+     * @return boolean The name the user should be displayed as
      */
     function getDisplayName()
     {
@@ -51,7 +51,7 @@ 
     /**
      * The given (or first) name for the user
      *
-     * @return string The user's first name
+     * @return boolean The user's first name
      */
     function getGivenName()
     {
@@ -61,7 +61,7 @@ 
     /**
      * The email address for the user
      *
-     * @return string The user's email address
+     * @return boolean The user's email address
      */
     function getEmail()
     {
@@ -71,7 +71,7 @@ 
     /**
      * The user ID for the user
      *
-     * @return string The user's ID or username
+     * @return boolean The user's ID or username
      */
     function getUid()
     {
@@ -81,7 +81,7 @@ 
     /**
      * The photo for the user
      *
-     * @return string The user's photo as a binary string
+     * @return boolean The user's photo as a binary string
      */ 
     function getPhoto()
     {
@@ -91,7 +91,7 @@ 
     /**
      * The phone number for the user
      *
-     * @return false|string The user's phone number
+     * @return boolean The user's phone number
      */
     function getPhoneNumber()
     {
@@ -101,7 +101,7 @@ 
     /**
      * The organziation for the user
      *
-     * @return false|string The user's organization
+     * @return boolean The user's organization
      */
     function getOrganization()
     {
@@ -111,7 +111,7 @@ 
     /**
      * The list of titles for the user
      *
-     * @return array The user's title(s) in short format
+     * @return boolean The user's title(s) in short format
      */
     function getTitles()
     {
@@ -121,7 +121,7 @@ 
     /**
      * The list of titles for the user
      *
-     * @return array The user's title(s) in user friendly strings
+     * @return boolean The user's title(s) in user friendly strings
      *
      * @SuppressWarnings("StaticAccess")
      */
@@ -159,7 +159,7 @@ 
     /**
      * The state the user's mailing address is in
      *
-     * @return string The user's state from their mailing address
+     * @return boolean The user's state from their mailing address
      */
     function getState()
     {
@@ -169,7 +169,7 @@ 
     /**
      * The city the user's mailing address is in
      *
-     * @return string The user's city from their mailing address
+     * @return boolean The user's city from their mailing address
      */
     function getCity()
     {
@@ -179,7 +179,7 @@ 
     /**
      * The last name for the user
      *
-     * @return string The user's last name
+     * @return boolean The user's last name
      */
     function getLastName()
     {
@@ -189,7 +189,7 @@ 
     /**
      * The nick name for the user
      *
-     * @return string The user's nick name
+     * @return boolean The user's nick name
      */
     function getNickName()
     {
@@ -199,7 +199,7 @@ 
     /**
      * The street address for the user
      *
-     * @return string The user's street address
+     * @return boolean The user's street address
      */
     function getAddress()
     {
@@ -209,7 +209,7 @@ 
     /**
      * The postal (zip) code for the user's mailing address
      *
-     * @return string The user's postal code
+     * @return boolean The user's postal code
      */
     function getPostalCode()
     {
@@ -219,7 +219,7 @@ 
     /**
      * The country the user's mailing address is in
      *
-     * @return string The user's country from their mailing address
+     * @return boolean The user's country from their mailing address
      */
     function getCountry()
     {
@@ -231,7 +231,7 @@ 
      *
      * This is the same as Areas in Flipside speak. 
      *
-     * @return array The user's orgnaiational units
+     * @return boolean The user's orgnaiational units
      */
     function getOrganizationUnits()
     {
@@ -241,7 +241,7 @@ 
     /**
      * The supplemental login types that the user can use to login
      *
-     * @return array The user's login providers
+     * @return boolean The user's login providers
      */
     function getLoginProviders()
     {
@@ -251,7 +251,7 @@ 
     /**
      * The groups the user is a part of
      *
-     * @return false|array The user's Auth\Group structures
+     * @return boolean The user's Auth\Group structures
      */
     function getGroups()
     {
@@ -275,7 +275,7 @@ 
      *
      * @param string $provider The hostname for the provider
      *
-     * @return true|false true if they can login with the provider, false otherwise
+     * @return boolean true if they can login with the provider, false otherwise
      */
     function canLoginWith($provider)
     {
@@ -294,7 +294,7 @@ 
      *
      * @param string $password The new user password
      *
-     * @return true|false true if the user's password was changed, false otherwise
+     * @return boolean true if the user's password was changed, false otherwise
      */
     protected function setPass($password)
     {
@@ -304,7 +304,7 @@ 
     /**
      * Has the user completely filled out their user profile?
      *
-     * @return true|false true if the user's profile is complete, false otherwise
+     * @return boolean true if the user's profile is complete, false otherwise
      */
     function isProfileComplete()
     {
@@ -322,7 +322,7 @@ 
      *
      * @param string $password The user's current password
      *
-     * @return true|false true if the user's password is correct, false otherwise
+     * @return boolean true if the user's password is correct, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -336,7 +336,7 @@ 
      *
      * @param string $hash The user's reset hash
      *
-     * @return true|false true if the user's hash is correct, false otherwise
+     * @return boolean true if the user's hash is correct, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -352,7 +352,7 @@ 
      * @param string $newpass The user's new password
      * @param boolean $isHash Is $old_pass a password or a hash
      *
-     * @return true|false true if the user's password was changed, false otherwise
+     * @return boolean true if the user's password was changed, false otherwise
      */
     function change_pass($oldpass, $newpass, $isHash=false)
     {
@@ -376,7 +376,7 @@ 
      *
      * @param string $name The user's new display name
      *
-     * @return true|false true if the user's display name was changed, false otherwise
+     * @return boolean true if the user's display name was changed, false otherwise
      */
     function setDisplayName($name)
     {
@@ -388,7 +388,7 @@ 
      *
      * @param string $name The user's new given name
      *
-     * @return true|false true if the user's given name was changed, false otherwise
+     * @return boolean true if the user's given name was changed, false otherwise
      */
     function setGivenName($name)
     {
@@ -400,7 +400,7 @@ 
      *
      * @param string $email The user's new email address
      *
-     * @return true|false true if the user's email address was changed, false otherwise
+     * @return boolean true if the user's email address was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -414,7 +414,7 @@ 
      *
      * @param string $uid The user's new user ID
      *
-     * @return true|false true if the user's ID was changed, false otherwise
+     * @return boolean true if the user's ID was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -428,7 +428,7 @@ 
      *
      * @param string $photo The user's new photo as a binary string
      *
-     * @return true|false true if the user's photo was changed, false otherwise
+     * @return boolean true if the user's photo was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -442,7 +442,7 @@ 
      *
      * @param string $phone The user's new phonew number
      *
-     * @return true|false true if the user's phone number was changed, false otherwise
+     * @return boolean true if the user's phone number was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -456,7 +456,7 @@ 
      *
      * @param string $org The user's new organization
      *
-     * @return true|false true if the user's organization was changed, false otherwise
+     * @return boolean true if the user's organization was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -470,7 +470,7 @@ 
      *
      * @param string $titles The user's new titles
      *
-     * @return true|false true if the user's titles were changed, false otherwise
+     * @return boolean true if the user's titles were changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -484,7 +484,7 @@ 
      *
      * @param string $state The user's new state
      *
-     * @return true|false true if the user's state was changed, false otherwise
+     * @return boolean true if the user's state was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -498,7 +498,7 @@ 
      *
      * @param string $city The user's new city
      *
-     * @return true|false true if the user's city was changed, false otherwise
+     * @return boolean true if the user's city was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -512,7 +512,7 @@ 
      *
      * @param string $sn The user's new last name
      *
-     * @return true|false true if the user's last name was changed, false otherwise
+     * @return boolean true if the user's last name was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -526,7 +526,7 @@ 
      *
      * @param string $displayName The user's new nick name
      *
-     * @return true|false true if the user's nick name was changed, false otherwise
+     * @return boolean true if the user's nick name was changed, false otherwise
      */
     function setNickName($displayName)
     {
@@ -538,7 +538,7 @@ 
      *
      * @param string $address The user's new mailing address
      *
-     * @return true|false true if the user's mailing address was changed, false otherwise
+     * @return boolean true if the user's mailing address was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -552,7 +552,7 @@ 
      *
      * @param string $postalcode The user's new postal code
      *
-     * @return true|false true if the user's postal code was changed, false otherwise
+     * @return boolean true if the user's postal code was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -566,7 +566,7 @@ 
      *
      * @param string $country The user's new country
      *
-     * @return true|false true if the user's country was changed, false otherwise
+     * @return boolean true if the user's country was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -580,7 +580,7 @@ 
      *
      * @param string $ous The user's new organizations
      *
-     * @return true|false true if the user's organizations was changed, false otherwise
+     * @return boolean true if the user's organizations was changed, false otherwise
      *
      * @SuppressWarnings("UnusedFormalParameter")
      */
@@ -704,7 +704,7 @@ 
     /**
      * Obtain the user's password reset hash
      *
-     * @return string|false A hash if available, false otherwise
+     * @return boolean A hash if available, false otherwise
      */
     public function getPasswordResetHash()
     {