diff --git a/inc/User/backend.php b/inc/User/backend.php index a036f06144..b830859566 100755 --- a/inc/User/backend.php +++ b/inc/User/backend.php @@ -26,13 +26,11 @@ /** * Base class for user management * - * @author Aldo "xoen" Giambelluca - * @author fabian */ abstract class OC_USER_BACKEND { /** - * Check if the login button is pressed and logg the user in + * Check if the login button is pressed and log the user in * */ abstract public static function loginLisener(); @@ -40,12 +38,16 @@ abstract class OC_USER_BACKEND { /** * Try to create a new user * + * @param string $username The username of the user to create + * @param string $password The password of the new user */ abstract public static function createUser($username, $password); /** * Try to login a user * + * @param string $username The username of the user to log in + * @param string $password The password of the user */ abstract public static function login($username, $password); @@ -56,7 +58,7 @@ abstract class OC_USER_BACKEND { abstract public static function logoutLisener(); /** - * Check if a user is logged in + * Check if some user is logged in * */ abstract public static function isLoggedIn(); @@ -64,36 +66,47 @@ abstract class OC_USER_BACKEND { /** * Try to create a new group * + * @param string $groupName The name of the group to create */ abstract public static function createGroup($groupName); /** * Get the ID of a user * + * @param string $username Name of the user to find the ID + * @param boolean $noCache If false the cache is used to find the ID */ abstract public static function getUserId($username, $noCache=false); /** * Get the ID of a group * + * @param string $groupName Name of the group to find the ID + * @param boolean $noCache If false the cache is used to find the ID */ abstract public static function getGroupId($groupName, $noCache=false); /** * Get the name of a group * + * @param string $groupId ID of the group + * @param boolean $noCache If false the cache is used to find the name of the group */ abstract public static function getGroupName($groupId, $noCache=false); /** * Check if a user belongs to a group * + * @param string $username Name of the user to check + * @param string $groupName Name of the group */ abstract public static function inGroup($username, $groupName); /** * Add a user to a group * + * @param string $username Name of the user to add to group + * @param string $groupName Name of the group in which add the user */ abstract public static function addToGroup($username, $groupName); @@ -105,18 +118,23 @@ abstract class OC_USER_BACKEND { /** * Get all groups the user belongs to * + * @param string $username Name of the user */ abstract public static function getUserGroups($username); /** * Set the password of a user * + * @param string $username User who password will be changed + * @param string $password The new password for the user */ abstract public static function setPassword($username, $password); /** - * Check the password of a user + * Check if the password of the user is correct * + * @param string $username Name of the user + * @param string $password Password of the user */ abstract public static function checkPassword($username, $password); diff --git a/inc/User/database.php b/inc/User/database.php index 13880f1f66..3fed76d7b0 100755 --- a/inc/User/database.php +++ b/inc/User/database.php @@ -32,281 +32,320 @@ oc_require_once('inc/User/backend.php'); class OC_USER_DATABASE extends OC_USER_BACKEND { /** - * check if the login button is pressed and logg the user in - * - */ + * Check if the login button is pressed and log the user in + * + */ public static function loginLisener(){ - if(isset($_POST['loginbutton']) and isset($_POST['password']) and isset($_POST['login'])){ - if(OC_USER::login($_POST['login'],$_POST['password'])){ + if ( isset($_POST['loginbutton']) AND isset($_POST['password']) AND isset($_POST['login']) ) { + if ( OC_USER::login($_POST['login'], $_POST['password']) ) { echo 1; - OC_LOG::event($_SESSION['username'],1,''); + OC_LOG::event($_SESSION['username'], 1, ''); echo 2; - if((isset($CONFIG_HTTPFORCESSL) and $CONFIG_HTTPFORCESSL) or isset($_SERVER['HTTPS']) and $_SERVER['HTTPS'] == 'on') { - $url = "https://". $_SERVER['SERVER_NAME'] . $_SERVER['REQUEST_URI']; - }else{ - $url = "http://". $_SERVER['SERVER_NAME'] . $_SERVER['REQUEST_URI']; + if ( (isset($CONFIG_HTTPFORCESSL) AND $CONFIG_HTTPFORCESSL) + OR (isset($_SERVER['HTTPS']) AND ('on' == $_SERVER['HTTPS'])) ) { + $url = 'https://' . $_SERVER['SERVER_NAME'] . $_SERVER['REQUEST_URI']; + } else { + $url = 'http://' . $_SERVER['SERVER_NAME'] . $_SERVER['REQUEST_URI']; } header("Location: $url"); die(); - }else{ + } else { return('error'); - } + } } return(''); } /** - * try to create a new user - * - */ - public static function createUser($username,$password){ + * Try to create a new user + * + * @param string $username The username of the user to create + * @param string $password The password of the new user + */ + public static function createUser($username, $password) { global $CONFIG_DBTABLEPREFIX; - if(OC_USER::getuserid($username,true)!=0){ - return false; - }else{ - $usernameclean=strtolower($username); - $password=sha1($password); - $username=OC_DB::escape($username); - $usernameclean=OC_DB::escape($usernameclean); - $query="INSERT INTO `{$CONFIG_DBTABLEPREFIX}users` (`user_name` ,`user_name_clean` ,`user_password`) VALUES ('$username', '$usernameclean', '$password')"; - $result=OC_DB::query($query); - return ($result)?true:false; - } + // Check if the user already exists + if ( 0 != OC_USER::getUserId($username, true) ) { + return false; + } else { + $usernameClean = strToLower($username); + $password = sha1($password); + $username = OC_DB::escape($username); + $usernameClean = OC_DB::escape($usernameClean); + $query = "INSERT INTO `{$CONFIG_DBTABLEPREFIX}users` (`user_name` ,`user_name_clean` ,`user_password`) " + . "VALUES ('$username', '$usernameClean', '$password')"; + $result = OC_DB::query($query); + return $result ? true : false; + } } - + /** - * try to login a user - * - */ + * Try to login a user + * + * @param string $username The username of the user to log in + * @param string $password The password of the user + */ public static function login($username,$password){ global $CONFIG_DBTABLEPREFIX; - $password=sha1($password); - $usernameclean=strtolower($username); - $username=OC_DB::escape($username); - $usernameclean=OC_DB::escape($usernameclean); - $query = "SELECT user_id FROM {$CONFIG_DBTABLEPREFIX}users WHERE user_name_clean = '$usernameclean' AND user_password = '$password' LIMIT 1"; - $result=OC_DB::select($query); - if(isset($result[0]) && isset($result[0]['user_id'])){ - $_SESSION['user_id']=$result[0]['user_id']; - $_SESSION['username']=$username; - $_SESSION['username_clean']=$usernameclean; + $password = sha1($password); + $usernameClean = strtolower($username); + $username = OC_DB::escape($username); + $usernameClean = OC_DB::escape($usernameClean); + $query = "SELECT user_id FROM {$CONFIG_DBTABLEPREFIX}users " + . "WHERE user_name_clean = '$usernameClean' AND user_password = '$password' LIMIT 1"; + $result = OC_DB::select($query); + if ( isset($result[0]) AND isset($result[0]['user_id']) ) { + $_SESSION['user_id'] = $result[0]['user_id']; + $_SESSION['username'] = $username; + $_SESSION['username_clean'] = $usernameClean; return true; - }else{ + } else { return false; } } - + /** - * check if the logout button is pressed and logout the user - * - */ - public static function logoutLisener(){ - if(isset($_GET['logoutbutton']) && isset($_SESSION['username'])){ - OC_LOG::event($_SESSION['username'],2,''); - $_SESSION['user_id']=false; - $_SESSION['username']=''; - $_SESSION['username_clean']=''; + * Check if the logout button is pressed and logout the user + * + */ + public static function logoutLisener() { + if ( isset($_GET['logoutbutton']) AND isset($_SESSION['username']) ) { + OC_LOG::event($_SESSION['username'], 2, ''); + $_SESSION['user_id'] = false; + $_SESSION['username'] = ''; + $_SESSION['username_clean'] = ''; } } - + /** - * check if a user is logged in - * - */ - public static function isLoggedIn(){ - return (isset($_SESSION['user_id']) && $_SESSION['user_id'])?true:false; - } - - /** - * try to create a new group - * - */ - public static function createGroup($groupname){ - global $CONFIG_DBTABLEPREFIX; - if(OC_USER::getgroupid($groupname,true)==0){ - $groupname=OC_DB::escape($groupname); - $query="INSERT INTO `{$CONFIG_DBTABLEPREFIX}groups` (`group_name`) VALUES ('$groupname')"; - $result=OC_DB::query($query); - return ($result)?true:false; - }else{ + * Check if the user is logged in + * + */ + public static function isLoggedIn() { + if ( isset($_SESSION['user_id']) AND $_SESSION['user_id'] ) { + return true; + } else { return false; } } - + /** - * get the id of a user - * - */ - public static function getUserId($username,$nocache=false){ + * Try to create a new group + * + * @param string $groupName The name of the group to create + */ + public static function createGroup($groupName) { global $CONFIG_DBTABLEPREFIX; - $usernameclean=strtolower($username); - if(!$nocache and isset($_SESSION['user_id_cache'][$usernameclean])){//try to use cached value to save an sql query - return $_SESSION['user_id_cache'][$usernameclean]; + + if ( 0 == OC_USER::getGroupId($groupName, true) ) { + $groupName = OC_DB::escape($groupName); + $query = "INSERT INTO `{$CONFIG_DBTABLEPREFIX}groups` (`group_name`) VALUES ('$groupName')"; + $result = OC_DB::query($query); + return $result ? true : false; + } else { + return false; } - $usernameclean=OC_DB::escape($usernameclean); - $query="SELECT user_id FROM {$CONFIG_DBTABLEPREFIX}users WHERE user_name_clean = '$usernameclean'"; - $result=OC_DB::select($query); - if(!is_array($result)){ + } + + /** + * Get the ID of a user + * + * @param string $username Name of the user to find the ID + * @param boolean $noCache If false the cache is used to find the ID + */ + public static function getUserId($username, $noCache=false) { + global $CONFIG_DBTABLEPREFIX; + + $usernameClean = strToLower($username); + // Try to use cached value to avoid an SQL query + if ( !$noCache AND isset($_SESSION['user_id_cache'][$usernameClean]) ) { + return $_SESSION['user_id_cache'][$usernameClean]; + } + $usernameClean = OC_DB::escape($usernameClean); + $query = "SELECT user_id FROM {$CONFIG_DBTABLEPREFIX}users WHERE user_name_clean = '$usernameClean'"; + $result = OC_DB::select($query); + if ( !is_array($result) ) { return 0; } - if(isset($result[0]) && isset($result[0]['user_id'])){ - $_SESSION['user_id_cache'][$usernameclean]=$result[0]['user_id']; + if ( isset($result[0]) AND isset($result[0]['user_id']) ) { + $_SESSION['user_id_cache'][$usernameClean] = $result[0]['user_id']; return $result[0]['user_id']; - }else{ + } else { return 0; } } - + /** - * get the id of a group - * - */ - public static function getGroupId($groupname,$nocache=false){ + * Get the ID of a group + * + * @param string $groupName Name of the group to find the ID + * @param boolean $noCache If false the cache is used to find the ID + */ + public static function getGroupId($groupName, $noCache=false) { global $CONFIG_DBTABLEPREFIX; - if(!$nocache and isset($_SESSION['group_id_cache'][$groupname])){//try to use cached value to save an sql query - return $_SESSION['group_id_cache'][$groupname]; + + // Try to use cached value to avoid an SQL query + if ( !$noCache AND isset($_SESSION['group_id_cache'][$groupName]) ) { + return $_SESSION['group_id_cache'][$groupName]; } - $groupname=OC_DB::escape($groupname); - $query="SELECT group_id FROM {$CONFIG_DBTABLEPREFIX}groups WHERE group_name = '$groupname'"; - $result=OC_DB::select($query); - if(!is_array($result)){ + $groupName = OC_DB::escape($groupName); + $query = "SELECT group_id FROM {$CONFIG_DBTABLEPREFIX}groups WHERE group_name = '$groupName'"; + $result = OC_DB::select($query); + if ( !is_array($result) ) { return 0; } - if(isset($result[0]) && isset($result[0]['group_id'])){ - $_SESSION['group_id_cache'][$groupname]=$result[0]['group_id']; + if ( isset($result[0]) AND isset($result[0]['group_id']) ){ + $_SESSION['group_id_cache'][$groupName] = $result[0]['group_id']; return $result[0]['group_id']; - }else{ + } else { return 0; } } - + /** - * get the name of a group - * - */ - public static function getGroupName($groupid,$nocache=false){ + * Get the name of a group + * + * @param string $groupId ID of the group + * @param boolean $noCache If false the cache is used to find the name of the group + */ + public static function getGroupName($groupId, $noCache=false) { global $CONFIG_DBTABLEPREFIX; - if($nocache and $name=array_search($groupid,$_SESSION['group_id_cache'])){//try to use cached value to save an sql query + + // Try to use cached value to avoid an sql query + if ( !$noCache AND ($name = array_search($groupId, $_SESSION['group_id_cache'])) ) { return $name; } - $groupid=(integer)$groupid; - $query="SELECT group_name FROM {$CONFIG_DBTABLEPREFIX}groups WHERE group_id = '$groupid' LIMIT 1"; - $result=OC_DB::select($query); - if(isset($result[0]) && isset($result[0]['group_name'])){ + $groupId = (integer)$groupId; + $query = "SELECT group_name FROM {$CONFIG_DBTABLEPREFIX}groups WHERE group_id = '$groupId' LIMIT 1"; + $result = OC_DB::select($query); + if ( isset($result[0]) AND isset($result[0]['group_name']) ) { return $result[0]['group_name']; - }else{ + } else { return 0; } } - + /** - * check if a user belongs to a group - * - */ - public static function inGroup($username,$groupname){ + * Check if a user belongs to a group + * + * @param string $username Name of the user to check + * @param string $groupName Name of the group + */ + public static function inGroup($username,$groupName) { global $CONFIG_DBTABLEPREFIX; - $userid=OC_USER::getuserid($username); - $groupid=OC_USER::getgroupid($groupname); - if($groupid>0 and $userid>0){ - $query="SELECT * FROM {$CONFIG_DBTABLEPREFIX}user_group WHERE group_id = '$groupid' AND user_id = '$userid';"; - $result=OC_DB::select($query); - if(isset($result[0]) && isset($result[0]['user_group_id'])){ + $userId = OC_USER::getuserid($username); + $groupId = OC_USER::getgroupid($groupName); + if ( ($groupId > 0) AND ($userId > 0) ) { + $query = "SELECT * FROM {$CONFIG_DBTABLEPREFIX}user_group WHERE group_id = '$groupId' AND user_id = '$userId';"; + $result = OC_DB::select($query); + if ( isset($result[0]) AND isset($result[0]['user_group_id']) ) { return true; - }else{ + } else { return false; } - }else{ + } else { return false; } } - + /** - * add a user to a group - * - */ - public static function addToGroup($username,$groupname){ + * Add a user to a group + * + * @param string $username Name of the user to add to group + * @param string $groupName Name of the group in which add the user + */ + public static function addToGroup($username, $groupName) { global $CONFIG_DBTABLEPREFIX; - if(!OC_USER::ingroup($username,$groupname)){ - $userid=OC_USER::getuserid($username); - $groupid=OC_USER::getgroupid($groupname); - if($groupid!=0 and $userid!=0){ - $query="INSERT INTO `{$CONFIG_DBTABLEPREFIX}user_group` (`user_id` ,`group_id`) VALUES ('$userid', '$groupid');"; - $result=OC_DB::query($query); - if($result){ + if ( !OC_USER::inGroup($username, $groupName) ) { + $userId = OC_USER::getUserId($username); + $groupId = OC_USER::getGroupId($groupName); + if ( (0 != $groupId) AND (0 != $userId) ) { + $query = "INSERT INTO `{$CONFIG_DBTABLEPREFIX}user_group` (`user_id` ,`group_id`) VALUES ('$userId', '$groupId');"; + $result = OC_DB::query($query); + if ( $result ) { return true; - }else{ + } else { return false; } - }else{ + } else { return false; } - }else{ + } else { return true; } } - + + /** + * Generate a random password + */ public static function generatePassword(){ - return uniqid(); + return uniqId(); } /** - * get all groups the user belongs to - * - */ - public static function getUserGroups($username){ + * Get all groups the user belongs to + * + * @param string $username Name of the user + */ + public static function getUserGroups($username) { global $CONFIG_DBTABLEPREFIX; - $userid=OC_USER::getuserid($username); - $query = "SELECT group_id FROM {$CONFIG_DBTABLEPREFIX}user_group WHERE user_id = '$userid'"; - $result=OC_DB::select($query); - $groups=array(); - if(is_array($result)){ - foreach($result as $group){ - $groupid=$group['group_id']; - $groups[]=OC_USER::getgroupname($groupid); + $userId = OC_USER::getUserId($username); + $query = "SELECT group_id FROM {$CONFIG_DBTABLEPREFIX}user_group WHERE user_id = '$userId'"; + $result = OC_DB::select($query); + $groups = array(); + if ( is_array($result) ) { + foreach ( $result as $group ) { + $groupId = $group['group_id']; + $groups[] = OC_USER::getGroupName($groupId); } } return $groups; } - + /** - * set the password of a user - * - */ - public static function setPassword($username,$password){ + * Set the password of a user + * + * @param string $username User who password will be changed + * @param string $password The new password for the user + */ + public static function setPassword($username, $password) { global $CONFIG_DBTABLEPREFIX; - $password=sha1($password); - $userid=OC_USER::getuserid($username); - $query = "UPDATE {$CONFIG_DBTABLEPREFIX}users SET user_password = '$password' WHERE user_id ='$userid'"; - $result=OC_DB::query($query); - if($result){ + $password = sha1($password); + $userId = OC_USER::getUserId($username); + $query = "UPDATE {$CONFIG_DBTABLEPREFIX}users SET user_password = '$password' WHERE user_id ='$userId'"; + $result = OC_DB::query($query); + if ( $result ) { return true; - }else{ + } else { return false; } } /** - * check the password of a user - * - */ - public static function checkPassword($username,$password){ + * Check if the password of the user is correct + * + * @param string $username Name of the user + * @param string $password Password of the user + */ + public static function checkPassword($username, $password) { global $CONFIG_DBTABLEPREFIX; - $password=sha1($password); - $usernameclean=strtolower($username); - $username=OC_DB::escape($username); - $usernameclean=OC_DB::escape($usernameclean); - $query = "SELECT user_id FROM '{$CONFIG_DBTABLEPREFIX}users' WHERE user_name_clean = '$usernameclean' AND user_password = '$password' LIMIT 1"; - $result=OC_DB::select($query); - if(isset($result[0]) && isset($result[0]['user_id']) && $result[0]['user_id']>0){ + $password = sha1($password); + $usernameClean = strToLower($username); + $usernameClean = OC_DB::escape($usernameClean); + $username = OC_DB::escape($username); + $query = "SELECT user_id FROM '{$CONFIG_DBTABLEPREFIX}users' " + . "WHERE user_name_clean = '$usernameClean' AND user_password = '$password' LIMIT 1"; + $result = OC_DB::select($query); + if ( isset($result[0]) AND isset($result[0]['user_id']) AND ($result[0]['user_id'] > 0) ) { return true; - }else{ + } else { return false; } } diff --git a/inc/User/mod_auth.php b/inc/User/mod_auth.php index 0595e74024..a037d8abf2 100755 --- a/inc/User/mod_auth.php +++ b/inc/User/mod_auth.php @@ -32,147 +32,169 @@ oc_require_once('inc/User/backend.php'); class OC_USER_MOD_AUTH extends OC_USER_BACKEND { /** - * check if the login button is pressed and logg the user in - * - */ - public static function loginLisener(){ + * Check if the login button is pressed and log the user in + * + */ + public static function loginLisener() { return(''); } /** - * try to create a new user - * - */ - public static function createUser($username,$password){ + * Try to create a new user + * + * @param string $username The username of the user to create + * @param string $password The password of the new user + */ + public static function createUser($username, $password) { return false; } /** - * try to login a user - * - */ - public static function login($username,$password){ - if (isset($_SERVER["PHP_AUTH_USER"]) && $_SERVER["PHP_AUTH_USER"] != "") { - $_SESSION['user_id']= $_SERVER["PHP_AUTH_USER"]; - $_SESSION['username']= $_SERVER["PHP_AUTH_USER"]; - $_SESSION['username_clean']= $_SERVER["PHP_AUTH_USER"]; + * Try to login a user + * + * @param string $username The username of the user to log in + * @param string $password The password of the user + */ + public static function login($username, $password) { + if ( isset($_SERVER['PHP_AUTH_USER']) AND ('' != $_SERVER['PHP_AUTH_USER']) ) { + $_SESSION['user_id'] = $_SERVER['PHP_AUTH_USER']; + $_SESSION['username'] = $_SERVER['PHP_AUTH_USER']; + $_SESSION['username_clean'] = $_SERVER['PHP_AUTH_USER']; return true; } return false; } - + /** - * check if the logout button is pressed and logout the user - * - */ - public static function logoutLisener(){ - if(isset($_GET['logoutbutton']) && isset($_SESSION['username'])){ + * Check if the logout button is pressed and logout the user + * + */ + public static function logoutLisener() { + if ( isset($_GET['logoutbutton']) AND isset($_SESSION['username']) ) { header('WWW-Authenticate: Basic realm="ownCloud"'); header('HTTP/1.0 401 Unauthorized'); die('401 Unauthorized'); } } - + /** - * check if a user is logged in - * - */ + * Check if the user is logged in + * + */ public static function isLoggedIn(){ - if (isset($_SESSION['user_id']) && $_SESSION['user_id']) { + if ( isset($_SESSION['user_id']) AND $_SESSION['user_id'] ) { return true; - } - else { - if (isset($_SERVER["PHP_AUTH_USER"]) && $_SERVER["PHP_AUTH_USER"] != "") { - $_SESSION['user_id']= $_SERVER["PHP_AUTH_USER"]; - $_SESSION['username']= $_SERVER["PHP_AUTH_USER"]; - $_SESSION['username_clean']= $_SERVER["PHP_AUTH_USER"]; + } else { + if ( isset($_SERVER['PHP_AUTH_USER']) AND ('' != $_SERVER["PHP_AUTH_USER"]) ) { + $_SESSION['user_id'] = $_SERVER['PHP_AUTH_USER']; + $_SESSION['username'] = $_SERVER['PHP_AUTH_USER']; + $_SESSION['username_clean'] = $_SERVER['PHP_AUTH_USER']; return true; } } return false; } - + /** - * try to create a new group - * - */ - public static function createGroup($groupname){ + * Try to create a new group + * + * @param string $groupName The name of the group to create + */ + public static function createGroup($groupName) { // does not work with MOD_AUTH (only or some modules) return false; } - + /** - * get the id of a user - * - */ - public static function getUserId($username,$nocache=false){ + * Get the ID of a user + * + * @param string $username Name of the user to find the ID + * @param boolean $noCache If false the cache is used to find the ID + */ + public static function getUserId($username, $noCache=false) { // does not work with MOD_AUTH (only or some modules) return 0; } - + /** - * get the id of a group - * - */ - public static function getGroupId($groupname,$nocache=false){ + * Get the ID of a group + * + * @param string $groupName Name of the group to find the ID + * @param boolean $noCache If false the cache is used to find the ID + */ + public static function getGroupId($groupName, $noCache=false) { // does not work with MOD_AUTH (only or some modules) return 0; } - + /** - * get the name of a group - * - */ - public static function getGroupName($groupid,$nocache=false){ + * Get the name of a group + * + * @param string $groupId ID of the group + * @param boolean $noCache If false the cache is used to find the name of the group + */ + public static function getGroupName($groupId, $noCache=false) { // does not work with MOD_AUTH (only or some modules) return 0; } - + /** - * check if a user belongs to a group - * - */ - public static function inGroup($username,$groupname){ + * Check if a user belongs to a group + * + * @param string $username Name of the user to check + * @param string $groupName Name of the group + */ + public static function inGroup($username, $groupName) { // does not work with MOD_AUTH (only or some modules) return false; } - + /** - * add a user to a group - * - */ - public static function addToGroup($username,$groupname){ + * Add a user to a group + * + * @param string $username Name of the user to add to group + * @param string $groupName Name of the group in which add the user + */ + public static function addToGroup($username, $groupName) { // does not work with MOD_AUTH (only or some modules) return false; } - - public static function generatePassword(){ - return uniqid(); - } - + /** - * get all groups the user belongs to - * - */ - public static function getUserGroups($username){ + * Generate a random password + */ + public static function generatePassword() { + return uniqId(); + } + + /** + * Get all groups the user belongs to + * + * @param string $username Name of the user + */ + public static function getUserGroups($username) { // does not work with MOD_AUTH (only or some modules) $groups=array(); return $groups; } - + /** - * set the password of a user - * - */ - public static function setPassword($username,$password){ + * Set the password of a user + * + * @param string $username User who password will be changed + * @param string $password The new password for the user + */ + public static function setPassword($username, $password) { return false; } - + /** - * check the password of a user - * - */ - public static function checkPassword($username,$password){ + * Check if the password of the user is correct + * + * @param string $username Name of the user + * @param string $password Password of the user + */ + public static function checkPassword($username, $password) { // does not work with MOD_AUTH (only or some modules) return false; } diff --git a/inc/lib_user.php b/inc/lib_user.php index e20c5624f1..0f7c01b381 100755 --- a/inc/lib_user.php +++ b/inc/lib_user.php @@ -53,8 +53,10 @@ class OC_USER { private static $_backend; /** - * Set the User Authentication Module - */ + * Set the User Authentication Module + * + * @param string $backend The backend to use for user managment + */ public static function setBackend($backend='database') { if ( (null === $backend) OR (!is_string($backend)) ) { $backend = 'database'; @@ -78,117 +80,140 @@ class OC_USER { } /** - * check if the login button is pressed and logg the user in - * - */ + * Check if the login button is pressed and log the user in + * + */ public static function loginLisener() { return self::$_backend->loginLisener(); } /** - * try to create a new user - * - */ + * Try to create a new user + * + * @param string $username The username of the user to create + * @param string $password The password of the new user + */ public static function createUser($username, $password) { return self::$_backend->createUser($username, $password); } /** - * try to login a user - * - */ + * Try to login a user + * + * @param string $username The username of the user to log in + * @param string $password The password of the user + */ public static function login($username, $password) { return self::$_backend->login($username, $password); } /** - * check if the logout button is pressed and logout the user - * - */ + * Check if the logout button is pressed and logout the user + * + */ public static function logoutLisener() { return self::$_backend->logoutLisener(); } /** - * check if a user is logged in - * - */ + * Check if the user is logged in + * + */ public static function isLoggedIn() { return self::$_backend->isLoggedIn(); } /** - * try to create a new group - * - */ + * Try to create a new group + * + * @param string $groupName The name of the group to create + */ public static function createGroup($groupName) { return self::$_backend->createGroup($groupName); } /** - * get the id of a user - * - */ + * Get the ID of a user + * + * @param string $username Name of the user to find the ID + * @param boolean $noCache If false the cache is used to find the ID + */ public static function getUserId($username, $noCache=false) { return self::$_backend->getUserId($username, $noCache=false); } /** - * get the id of a group - * - */ + * Get the ID of a group + * + * @param string $groupName Name of the group to find the ID + * @param boolean $noCache If false the cache is used to find the ID + */ public static function getGroupId($groupName, $noCache=false) { return self::$_backend->getGroupId($groupName, $noCache=false); } /** - * get the name of a group - * - */ + * Get the name of a group + * + * @param string $groupId ID of the group + * @param boolean $noCache If false the cache is used to find the name of the group + */ public static function getGroupName($groupId, $noCache=false) { return self::$_backend->getGroupName($groupId, $noCache=false); } /** - * check if a user belongs to a group - * - */ + * Check if a user belongs to a group + * + * @param string $username Name of the user to check + * @param string $groupName Name of the group + */ public static function inGroup($username, $groupName) { return self::$_backend->inGroup($username, $groupName); } /** - * add a user to a group - * - */ + * Add a user to a group + * + * @param string $username Name of the user to add to group + * @param string $groupName Name of the group in which add the user + */ public static function addToGroup($username, $groupName) { return self::$_backend->addToGroup($username, $groupName); } + /** + * Generate a random password + */ public static function generatePassword() { return uniqId(); } /** - * get all groups the user belongs to - * - */ + * Get all groups the user belongs to + * + * @param string $username Name of the user + */ public static function getUserGroups($username) { return self::$_backend->getUserGroups($username); } /** - * set the password of a user - * - */ + * Set the password of a user + * + * @param string $username User who password will be changed + * @param string $password The new password for the user + */ public static function setPassword($username, $password) { return self::$_backend->setPassword($username, $password); } /** - * check the password of a user - * - */ + * Check if the password of the user is correct + * + * @param string $username Name of the user + * @param string $password Password of the user + */ public static function checkPassword($username, $password) { return self::$_backend->checkPassword($username, $password); }