diff options
Diffstat (limited to 'include/functions_user.inc.php')
| -rw-r--r-- | include/functions_user.inc.php | 761 |
1 files changed, 347 insertions, 414 deletions
diff --git a/include/functions_user.inc.php b/include/functions_user.inc.php index d6250c582..896c175f0 100644 --- a/include/functions_user.inc.php +++ b/include/functions_user.inc.php @@ -2,7 +2,7 @@ // +-----------------------------------------------------------------------+ // | Piwigo - a PHP based photo gallery | // +-----------------------------------------------------------------------+ -// | Copyright(C) 2008-2013 Piwigo Team http://piwigo.org | +// | Copyright(C) 2008-2014 Piwigo Team http://piwigo.org | // | Copyright(C) 2003-2008 PhpWebGallery Team http://phpwebgallery.net | // | Copyright(C) 2002-2003 Pierrick LE GALL http://le-gall.net/pierrick | // +-----------------------------------------------------------------------+ @@ -21,15 +21,18 @@ // | USA. | // +-----------------------------------------------------------------------+ -// validate_mail_address: -// o verifies whether the given mail address has the -// right format. ie someone@domain.com "someone" can contain ".", "-" or -// even "_". Exactly as "domain". The extension doesn't have to be -// "com". The mail address can also be empty. -// o check if address could be empty -// o check if address is not used by a other user -// If the mail address doesn't correspond, an error message is returned. -// +/** + * @package functions\user + */ + + +/** + * Checks if an email is well formed and not already in use. + * + * @param int $user_id + * @param string $mail_address + * @return string|void error message or nothing + */ function validate_mail_address($user_id, $mail_address) { global $conf; @@ -62,10 +65,13 @@ WHERE upper('.$conf['user_fields']['email'].') = upper(\''.$mail_address.'\') } } -// validate_login_case: -// o check if login is not used by a other user -// If the login doesn't correspond, an error message is returned. -// +/** + * Checks if a login is not already in use. + * Comparision is case insensitive. + * + * @param string $login + * @return string|void error message or nothing + */ function validate_login_case($login) { global $conf; @@ -87,12 +93,10 @@ WHERE LOWER(".stripslashes($conf['user_fields']['username']).") = '".strtolower( } } /** - * For test on username case sensitivity - * - * @param : $username typed in by user for identification - * - * @return : $username found in database + * Searches for user with the same username in different case. * + * @param string $username typically typed in by user for identification + * @return string $username found in database */ function search_case_username($username) { @@ -119,8 +123,19 @@ function search_case_username($username) else return $users_found[0]; } -function register_user($login, $password, $mail_address, - $with_notification = true, $errors = array()) + +/** + * Creates a new user. + * + * @param string $login + * @param string $password + * @param string $mail_adress + * @param bool $notify_admin + * @param array &$errors populated with error messages + * @param bool $notify_user + * @return int|false user id or false + */ +function register_user($login, $password, $mail_address, $notify_admin=true, &$errors = array(), $notify_user=false) { global $conf; @@ -159,53 +174,44 @@ function register_user($login, $password, $mail_address, } } - $errors = trigger_event('register_user_check', - $errors, - array( - 'username'=>$login, - 'password'=>$password, - 'email'=>$mail_address, - ) - ); + $errors = trigger_event( + 'register_user_check', + $errors, + array( + 'username'=>$login, + 'password'=>$password, + 'email'=>$mail_address, + ) + ); // if no error until here, registration of the user if (count($errors) == 0) { - // what will be the inserted id ? - $query = ' -SELECT MAX('.$conf['user_fields']['id'].') + 1 - FROM '.USERS_TABLE.' -;'; - list($next_id) = pwg_db_fetch_row(pwg_query($query)); - - $insert = - array( - $conf['user_fields']['id'] => $next_id, - $conf['user_fields']['username'] => pwg_db_real_escape_string($login), - $conf['user_fields']['password'] => $conf['password_hash']($password), - $conf['user_fields']['email'] => $mail_address - ); + $insert = array( + $conf['user_fields']['username'] => pwg_db_real_escape_string($login), + $conf['user_fields']['password'] => $conf['password_hash']($password), + $conf['user_fields']['email'] => $mail_address + ); - mass_inserts(USERS_TABLE, array_keys($insert), array($insert)); + single_insert(USERS_TABLE, $insert); + $user_id = pwg_db_insert_id(); // Assign by default groups - { - $query = ' + $query = ' SELECT id FROM '.GROUPS_TABLE.' WHERE is_default = \''.boolean_to_string(true).'\' ORDER BY id ASC ;'; - $result = pwg_query($query); + $result = pwg_query($query); - $inserts = array(); - while ($row = pwg_db_fetch_assoc($result)) - { - $inserts[] = array( - 'user_id' => $next_id, - 'group_id' => $row['id'] - ); - } + $inserts = array(); + while ($row = pwg_db_fetch_assoc($result)) + { + $inserts[] = array( + 'user_id' => $user_id, + 'group_id' => $row['id'] + ); } if (count($inserts) != 0) @@ -214,47 +220,85 @@ SELECT id } $override = null; - if ($with_notification and $conf['browser_language']) + if ($notify_admin and $conf['browser_language']) { - if ( !get_browser_language($override['language']) ) + if (!get_browser_language($override['language'])) + { $override=null; + } } - create_user_infos($next_id, $override); + create_user_infos($user_id, $override); - if ($with_notification and $conf['email_admin_on_new_user']) + if ($notify_admin and $conf['email_admin_on_new_user']) { include_once(PHPWG_ROOT_PATH.'include/functions_mail.inc.php'); - $admin_url = get_absolute_root_url() - .'admin.php?page=user_list&username='.$login; + $admin_url = get_absolute_root_url().'admin.php?page=user_list&username='.$login; - $keyargs_content = array - ( - get_l10n_args('User: %s', stripslashes($login)), + $keyargs_content = array( + get_l10n_args('User: %s', stripslashes($login) ), get_l10n_args('Email: %s', $_POST['mail_address']), - get_l10n_args('', ''), - get_l10n_args('Admin: %s', $admin_url) - ); + get_l10n_args(''), + get_l10n_args('Admin: %s', $admin_url), + ); - pwg_mail_notification_admins - ( - get_l10n_args('Registration of %s', stripslashes($login)), + pwg_mail_notification_admins( + get_l10n_args('Registration of %s', stripslashes($login) ), $keyargs_content - ); + ); + } + + if ($notify_user and email_check_format($mail_address)) + { + include_once(PHPWG_ROOT_PATH.'include/functions_mail.inc.php'); + + $keyargs_content = array( + get_l10n_args('Hello %s,', stripslashes($login)), + get_l10n_args('Thank you for registering at %s!', $conf['gallery_title']), + get_l10n_args('', ''), + get_l10n_args('Here are your connection settings', ''), + get_l10n_args('Username: %s', stripslashes($login)), + get_l10n_args('Password: %s', stripslashes($password)), + get_l10n_args('Email: %s', $mail_address), + get_l10n_args('', ''), + get_l10n_args('If you think you\'ve received this email in error, please contact us at %s', get_webmaster_mail_address()), + ); + + pwg_mail( + $mail_address, + array( + 'subject' => '['.$conf['gallery_title'].'] '.l10n('Registration'), + 'content' => l10n_args($keyargs_content), + 'content_format' => 'text/plain', + ) + ); } - trigger_action('register_user', + trigger_action( + 'register_user', array( - 'id'=>$next_id, + 'id'=>$user_id, 'username'=>$login, 'email'=>$mail_address, - ) + ) ); + + return $user_id; + } + else + { + return false; } - - return $errors; } -function build_user( $user_id, $use_cache ) +/** + * Fetches user data from database. + * Same that getuserdata() but with additional tests for guest. + * + * @param int $user_id + * @param boolean $user_cache + * @return array + */ +function build_user($user_id, $use_cache=true) { global $conf; @@ -277,13 +321,13 @@ function build_user( $user_id, $use_cache ) } /** - * find informations related to the user identifier + * Finds informations related to the user identifier. * - * @param int user identifier - * @param boolean use_cache - * @param array + * @param int $user_id + * @param boolean $use_cache + * @return array */ -function getuserdata($user_id, $use_cache) +function getuserdata($user_id, $use_cache=false) { global $conf; @@ -410,7 +454,7 @@ SELECT COUNT(DISTINCT(image_id)) as total if ($cat['count_images']==0) { $forbidden_ids[] = $cat['cat_id']; - unset( $user_cache_cats[$cat['cat_id']] ); + remove_computed_category($user_cache_cats, $cat); } } if ( !empty($forbidden_ids) ) @@ -435,14 +479,12 @@ DELETE FROM '.USER_CACHE_CATEGORIES_TABLE.' // Due to concurrency issues, we ask MySQL to ignore errors on // insert. This may happen when cache needs refresh and that Piwigo is // called "very simultaneously". - mass_inserts - ( + mass_inserts( USER_CACHE_CATEGORIES_TABLE, - array - ( + array( 'user_id', 'cat_id', - 'date_last', 'max_date_last', 'nb_images', 'count_images', 'count_categories' - ), + 'date_last', 'max_date_last', 'nb_images', 'count_images', 'nb_categories', 'count_categories' + ), $user_cache_cats, array('ignore' => true) ); @@ -459,12 +501,14 @@ DELETE FROM '.USER_CACHE_TABLE.' $query = ' INSERT IGNORE INTO '.USER_CACHE_TABLE.' (user_id, need_update, cache_update_time, forbidden_categories, nb_total_images, + last_photo_date, image_access_type, image_access_list) VALUES ('.$userdata['id'].',\''.boolean_to_string($userdata['need_update']).'\',' .$userdata['cache_update_time'].',\'' - .$userdata['forbidden_categories'].'\','.$userdata['nb_total_images'].',\'' - .$userdata['image_access_type'].'\',\''.$userdata['image_access_list'].'\')'; + .$userdata['forbidden_categories'].'\','.$userdata['nb_total_images'].','. + (empty($userdata['last_photo_date']) ? 'NULL': '\''.$userdata['last_photo_date'].'\''). + ',\''.$userdata['image_access_type'].'\',\''.$userdata['image_access_list'].'\')'; pwg_query($query); } } @@ -472,10 +516,8 @@ INSERT IGNORE INTO '.USER_CACHE_TABLE.' return $userdata; } -/* - * deletes favorites of the current user if he's not allowed to see them - * - * @return void +/** + * Deletes favorites of the current user if he's not allowed to see them. */ function check_user_favorites() { @@ -495,14 +537,12 @@ SELECT DISTINCT f.image_id FROM '.FAVORITES_TABLE.' AS f INNER JOIN '.IMAGE_CATEGORY_TABLE.' AS ic ON f.image_id = ic.image_id WHERE f.user_id = '.$user['id'].' -'.get_sql_condition_FandF - ( - array - ( + '.get_sql_condition_FandF( + array( 'forbidden_categories' => 'ic.category_id', - ), - 'AND' - ).' + ), + 'AND' + ).' ;'; $authorizeds = array_from_query($query, 'image_id'); @@ -526,16 +566,16 @@ DELETE FROM '.FAVORITES_TABLE.' } /** - * calculates the list of forbidden categories for a given user + * Calculates the list of forbidden categories for a given user. * * Calculation is based on private categories minus categories authorized to * the groups the user belongs to minus the categories directly authorized - * to the user. The list contains at least -1 to be compliant with queries + * to the user. The list contains at least 0 to be compliant with queries * such as "WHERE category_id NOT IN ($forbidden_categories)" * - * @param int user_id - * @param string user_status - * @return string forbidden_categories + * @param int $user_id + * @param string $user_status + * @return string comma separated ids */ function calculate_permissions($user_id, $user_status) { @@ -601,152 +641,10 @@ SELECT id } /** - * compute data of categories branches (one branch only) - */ -function compute_branch_cat_data(&$cats, &$list_cat_id, &$level, &$ref_level) -{ - $date = ''; - $count_images = 0; - $count_categories = 0; - do - { - $cat_id = array_pop($list_cat_id); - if (!is_null($cat_id)) - { - // Count images and categories - $cats[$cat_id]['count_images'] += $count_images; - $cats[$cat_id]['count_categories'] += $count_categories; - $count_images = $cats[$cat_id]['count_images']; - $count_categories = $cats[$cat_id]['count_categories'] + 1; - - if ((empty($cats[$cat_id]['max_date_last'])) or ($cats[$cat_id]['max_date_last'] < $date)) - { - $cats[$cat_id]['max_date_last'] = $date; - } - else - { - $date = $cats[$cat_id]['max_date_last']; - } - $ref_level = substr_count($cats[$cat_id]['global_rank'], '.') + 1; - } - else - { - $ref_level = 0; - } - } while ($level <= $ref_level); - - // Last cat updating must be added to list for next branch - if ($ref_level <> 0) - { - $list_cat_id[] = $cat_id; - } -} - -/** - * compute data of categories branches - */ -function compute_categories_data(&$cats) -{ - $ref_level = 0; - $level = 0; - $list_cat_id = array(); - - foreach ($cats as $id => $category) - { - // Compute - $level = substr_count($category['global_rank'], '.') + 1; - if ($level > $ref_level) - { - $list_cat_id[] = $id; - } - else - { - compute_branch_cat_data($cats, $list_cat_id, $level, $ref_level); - $list_cat_id[] = $id; - } - $ref_level = $level; - } - - $level = 1; - compute_branch_cat_data($cats, $list_cat_id, $level, $ref_level); -} - -/** - * get computed array of categories + * Returns user identifier thanks to his name. * - * @param array userdata - * @param int filter_days number of recent days to filter on or null - * @return array - */ -function get_computed_categories($userdata, $filter_days=null) -{ - $query = 'SELECT c.id AS cat_id, global_rank'; - // Count by date_available to avoid count null - $query .= ', - MAX(date_available) AS date_last, COUNT(date_available) AS nb_images -FROM '.CATEGORIES_TABLE.' as c - LEFT JOIN '.IMAGE_CATEGORY_TABLE.' AS ic ON ic.category_id = c.id - LEFT JOIN '.IMAGES_TABLE.' AS i - ON ic.image_id = i.id - AND i.level<='.$userdata['level']; - - if ( isset($filter_days) ) - { - $query .= ' AND i.date_available > '.pwg_db_get_recent_period_expression($filter_days); - } - - if ( !empty($userdata['forbidden_categories']) ) - { - $query.= ' - WHERE c.id NOT IN ('.$userdata['forbidden_categories'].')'; - } - - $query.= ' - GROUP BY c.id, c.global_rank'; - - $result = pwg_query($query); - - $cats = array(); - while ($row = pwg_db_fetch_assoc($result)) - { - $row['user_id'] = $userdata['id']; - $row['count_categories'] = 0; - $row['count_images'] = (int)$row['nb_images']; - $row['max_date_last'] = $row['date_last']; - - $cats += array($row['cat_id'] => $row); - } - uasort($cats, 'global_rank_compare'); - - compute_categories_data($cats); - - if ( isset($filter_days) ) - { - $cat_tmp = $cats; - $cats = array(); - - foreach ($cat_tmp as $category) - { - if (!empty($category['max_date_last'])) - { - // Re-init counters - $category['count_categories'] = 0; - $category['count_images'] = (int)$category['nb_images']; - // Keep category - $cats[$category['cat_id']] = $category; - } - } - // Compute a second time - compute_categories_data($cats); - } - return $cats; -} - -/** - * returns user identifier thanks to his name, false if not found - * - * @param string username - * @param int user identifier + * @param string $username + * @param int|false */ function get_userid($username) { @@ -772,6 +670,12 @@ SELECT '.$conf['user_fields']['id'].' } } +/** + * Returns user identifier thanks to his email. + * + * @param string $email + * @param int|false + */ function get_userid_by_email($email) { global $conf; @@ -797,12 +701,13 @@ SELECT } } -/* - * Returns a array with default user value +/** + * Returns a array with default user valuees. * - * @param convert_str allows to convert string value if necessary + * @param convert_str ceonferts 'true' and 'false' into booleans + * @return array */ -function get_default_user_info($convert_str = true) +function get_default_user_info($convert_str=true) { global $cache, $conf; @@ -819,7 +724,7 @@ SELECT * if (pwg_db_num_rows($result) > 0) { $cache['default_user'] = pwg_db_fetch_assoc($result); - + unset($cache['default_user']['user_id']); unset($cache['default_user']['status']); unset($cache['default_user']['registration_date']); @@ -853,18 +758,19 @@ SELECT * } } -/* - * Returns a default user value +/** + * Returns a default user value. * - * @param value_name: name of value - * @param sos_value: value used if don't exist value + * @param string $value_name + * @param mixed $default + * @return mixed */ -function get_default_user_value($value_name, $sos_value) +function get_default_user_value($value_name, $default) { $default_user = get_default_user_info(true); if ($default_user === false or empty($default_user[$value_name])) { - return $sos_value; + return $default; } else { @@ -872,9 +778,11 @@ function get_default_user_value($value_name, $sos_value) } } -/* - * Returns the default template value +/** + * Returns the default theme. + * If the default theme is not available it returns the first available one. * + * @return string */ function get_default_theme() { @@ -885,16 +793,14 @@ function get_default_theme() } // let's find the first available theme - $active_themes = get_pwg_themes(); - foreach (array_keys(get_pwg_themes()) as $theme_id) - { - return $theme_id; - } + $active_themes = array_keys(get_pwg_themes()); + return $active_themes[0]; } -/* - * Returns the default language value +/** + * Returns the default language. * + * @return string */ function get_default_language() { @@ -902,9 +808,12 @@ function get_default_language() } /** - * Returns true if the browser language value is set into param $lang - * - */ + * Tries to find the browser language among available languages. + * @todo : try to match 'fr_CA' before 'fr' + * + * @param string &$lang + * @return bool + */ function get_browser_language(&$lang) { $browser_language = substr(@$_SERVER["HTTP_ACCEPT_LANGUAGE"], 0, 2); @@ -920,26 +829,18 @@ function get_browser_language(&$lang) } /** - * add user informations based on default values + * Creates user informations based on default values. * - * @param int user_id / array of user_if - * @param array of values used to override default user values + * @param int|int[] $user_ids + * @param array $override_values values used to override default user values */ -function create_user_infos($arg_id, $override_values = null) +function create_user_infos($user_ids, $override_values=null) { global $conf; - if (is_array($arg_id)) + if (!is_array($user_ids)) { - $user_ids = $arg_id; - } - else - { - $user_ids = array(); - if (is_numeric($arg_id)) - { - $user_ids[] = $arg_id; - } + $user_ids = array($user_ids); } if (!empty($user_ids)) @@ -994,11 +895,13 @@ function create_user_infos($arg_id, $override_values = null) } /** - * returns the auto login key or false on error - * @param int user_id - * @param time_t time - * @param string [out] username -*/ + * Returns the auto login key for an user or false if the user is not found. + * + * @param int $user_id + * @param int $time + * @param string &$username fille with corresponding username + * @return string|false + */ function calculate_auto_login_key($user_id, $time, &$username) { global $conf; @@ -1019,12 +922,12 @@ WHERE '.$conf['user_fields']['id'].' = '.$user_id; return false; } -/* - * Performs all required actions for user login - * @param int user_id - * @param bool remember_me - * @return void -*/ +/** + * Performs all required actions for user login. + * + * @param int $user_id + * @param bool $remember_me + */ function log_user($user_id, $remember_me) { global $conf, $user; @@ -1074,11 +977,13 @@ function log_user($user_id, $remember_me) trigger_action('user_login', $user['id']); } -/* - * Performs auto-connexion when cookie remember_me exists - * @return true/false -*/ -function auto_login() { +/** + * Performs auto-connection when cookie remember_me exists. + * + * @return bool + */ +function auto_login() +{ global $conf; if ( isset( $_COOKIE[$conf['remember_me_name']] ) ) @@ -1104,12 +1009,11 @@ function auto_login() { } /** - * hashes a password, with the PasswordHash class from phpass security - * library. We use an "pwg_" prefix because function password_hash is - * planned for PHP 5.5. Code inspired from Wordpress. + * Hashes a password with the PasswordHash class from phpass security library. + * @since 2.5 * - * @param string $password Plain text user password to hash - * @return string The hash string of the password + * @param string $password plain text + * @return string */ function pwg_password_hash($password) { @@ -1118,32 +1022,33 @@ function pwg_password_hash($password) if (empty($pwg_hasher)) { require_once(PHPWG_ROOT_PATH.'include/passwordhash.class.php'); - + // We use the portable hash feature from phpass because we can't be sure // Piwigo runs on PHP 5.3+ (and won't run on an older version in the // future) $pwg_hasher = new PasswordHash(13, true); } - + return $pwg_hasher->HashPassword($password); } /** - * Verifies a password, with the PasswordHash class from phpass security - * library. We use an "pwg_" prefix because function password_verify is - * planned for PHP 5.5. Code inspired from Wordpress. + * Verifies a password, with the PasswordHash class from phpass security library. + * If the hash is 'old' (assumed MD5) the hash is updated in database, used for + * migration from Piwigo 2.4. + * @since 2.5 * - * @param string $password Plain text user password to hash + * @param string $password plain text * @param string $hash may be md5 or phpass hashed password - * @param integer $account_id only useful to update password hash from md5 to phpass - * @return string The hash string of the password + * @param integer $user_id only useful to update password hash from md5 to phpass + * @return bool */ function pwg_password_verify($password, $hash, $user_id=null) { global $conf, $pwg_hasher; // If the password has not been hashed with the current algorithm. - if (strpos('$P', $hash) !== 0) + if (strpos($hash, '$P') !== 0) { if (!empty($conf['pass_convert'])) { @@ -1153,9 +1058,14 @@ function pwg_password_verify($password, $hash, $user_id=null) { $check = ($hash == md5($password)); } - - if ($check and isset($user_id) and !$conf['external_authentification']) + + if ($check) { + if (!isset($user_id) or $conf['external_authentification']) + { + return true; + } + // Rehash using new hash. $hash = pwg_password_hash($password); @@ -1172,7 +1082,7 @@ function pwg_password_verify($password, $hash, $user_id=null) if (empty($pwg_hasher)) { require_once(PHPWG_ROOT_PATH.'include/passwordhash.class.php'); - + // We use the portable hash feature $pwg_hasher = new PasswordHash(13, true); } @@ -1181,8 +1091,12 @@ function pwg_password_verify($password, $hash, $user_id=null) } /** - * Tries to login a user given username and password (must be MySql escaped) - * return true on success + * Tries to login a user given username and password (must be MySql escaped). + * + * @param string $username + * @param string $password + * @param bool $remember_me + * @return bool */ function try_log_user($username, $password, $remember_me) { @@ -1191,13 +1105,22 @@ function try_log_user($username, $password, $remember_me) add_event_handler('try_log_user', 'pwg_login', EVENT_HANDLER_PRIORITY_NEUTRAL, 4); +/** + * Default method for user login, can be overwritten with 'try_log_user' trigger. + * @see try_log_user() + * + * @param string $username + * @param string $password + * @param bool $remember_me + * @return bool + */ function pwg_login($success, $username, $password, $remember_me) { - if ($success===true) + if ($success===true) { return true; } - + // we force the session table to be clean pwg_session_gc(); @@ -1220,13 +1143,15 @@ SELECT '.$conf['user_fields']['id'].' AS id, return false; } -/** Performs all the cleanup on user logout */ +/** + * Performs all the cleanup on user logout. + */ function logout_user() { global $conf; - + trigger_action('user_logout', @$_SESSION['pwg_uid']); - + $_SESSION = array(); session_unset(); session_destroy(); @@ -1237,11 +1162,13 @@ function logout_user() setcookie($conf['remember_me_name'], '', 0, cookie_path(),ini_get('session.cookie_domain')); } -/* - * Return user status used in this library +/** + * Return user status. + * + * @param string $user_status used if $user not initialized * @return string -*/ -function get_user_status($user_status) + */ +function get_user_status($user_status='') { global $user; @@ -1260,11 +1187,12 @@ function get_user_status($user_status) return $user_status; } -/* - * Return access_type definition of user - * Test does with user status - * @return bool -*/ +/** + * Return ACCESS_* value for a given $status. + * + * @param string $user_status used if $user not initialized + * @return int one of ACCESS_* constants + */ function get_access_type_status($user_status='') { global $conf; @@ -1307,23 +1235,25 @@ function get_access_type_status($user_status='') return $access_type_status; } -/* - * Return if user have access to access_type definition - * Test does with user status +/** + * Returns if user has access to a particular ACCESS_* + * + * @return int $access_type one of ACCESS_* constants + * @param string $user_status used if $user not initialized * @return bool -*/ -function is_autorize_status($access_type, $user_status = '') + */ +function is_autorize_status($access_type, $user_status='') { return (get_access_type_status($user_status) >= $access_type); } -/* - * Check if user have access to access_type definition - * Stop action if there are not access - * Test does with user status - * @return none -*/ -function check_status($access_type, $user_status = '') +/** + * Abord script if user has no access to a particular ACCESS_* + * + * @return int $access_type one of ACCESS_* constants + * @param string $user_status used if $user not initialized + */ +function check_status($access_type, $user_status='') { if (!is_autorize_status($access_type, $user_status)) { @@ -1331,66 +1261,66 @@ function check_status($access_type, $user_status = '') } } -/* - * Return if user is generic +/** + * Returns if user is generic. + * + * @param string $user_status used if $user not initialized * @return bool -*/ - function is_generic($user_status = '') + */ +function is_generic($user_status='') { return get_user_status($user_status) == 'generic'; } -/* - * Return if user is only a guest +/** + * Returns if user is a guest. + * + * @param string $user_status used if $user not initialized * @return bool -*/ - function is_a_guest($user_status = '') + */ +function is_a_guest($user_status='') { return get_user_status($user_status) == 'guest'; } -/* - * Return if user is, at least, a classic user +/** + * Returns if user is, at least, a classic user. + * + * @param string $user_status used if $user not initialized * @return bool -*/ - function is_classic_user($user_status = '') + */ +function is_classic_user($user_status='') { return is_autorize_status(ACCESS_CLASSIC, $user_status); } -/* - * Return if user is, at least, an administrator +/** + * Returns if user is, at least, an administrator. + * + * @param string $user_status used if $user not initialized * @return bool -*/ - function is_admin($user_status = '') + */ +function is_admin($user_status='') { return is_autorize_status(ACCESS_ADMINISTRATOR, $user_status); } -/* - * Return if user is, at least, a webmaster +/** + * Returns if user is a webmaster. + * + * @param string $user_status used if $user not initialized * @return bool -*/ - function is_webmaster($user_status = '') + */ +function is_webmaster($user_status='') { return is_autorize_status(ACCESS_WEBMASTER, $user_status); } -/* - * Adviser status is depreciated from piwigo 2.2 - * @return false -*/ -function is_adviser() -{ - // TODO for Piwigo 2.4 : trigger a warning. We don't do it on Piwigo 2.3 - // to avoid changes for plugin contributors - // trigger_error('call to obsolete function is_adviser', E_USER_WARNING); - return false; -} - -/* - * Return if current user can edit/delete/validate a comment - * @param action edit/delete/validate +/** + * Returns if current user can edit/delete/validate a comment. + * + * @param string $action edit/delete/validate + * @param int $comment_author_id * @return bool */ function can_manage_comment($action, $comment_author_id) @@ -1429,33 +1359,18 @@ function can_manage_comment($action, $comment_author_id) return false; } -/* - * Return mail address as display text - * @return string -*/ -function get_email_address_as_display_text($email_address) -{ - global $conf; - - if (!isset($email_address) or (trim($email_address) == '')) - { - return ''; - } - else - { - return $email_address; - } -} - -/* - * Compute sql where condition with restrict and filter data. "FandF" means - * Forbidden and Filters. - * - * @param array condition_fields: read function body - * @param string prefix_condition: prefixes sql if condition is not empty - * @param boolean force_one_condition: use at least "1 = 1" +/** + * Compute sql WHERE condition with restrict and filter data. + * "FandF" means Forbidden and Filters. * - * @return string sql where/conditions + * @param array $condition_fields one witch fields apply each filter + * - forbidden_categories + * - visible_categories + * - forbidden_images + * - visible_images + * @param string $prefix_condition prefixes query if condition is not empty + * @param boolean $force_one_condition use at least "1 = 1" + * @return string */ function get_sql_condition_FandF( $condition_fields, @@ -1515,7 +1430,7 @@ function get_sql_condition_FandF( { $sql_list[]=$table_prefix.'level<='.$user['level']; } - else if ( !empty($user['image_access_list']) and !empty($user['image_access_type']) ) + elseif ( !empty($user['image_access_list']) and !empty($user['image_access_type']) ) { $sql_list[]=$field_name.' '.$user['image_access_type'] .' ('.$user['image_access_list'].')'; @@ -1547,8 +1462,26 @@ function get_sql_condition_FandF( return $sql; } +/** + * Returns sql WHERE condition for recent photos/albums for current user. + * + * @param string $db_field + * @return string + */ +function get_recent_photos_sql($db_field) +{ + global $user; + if (!isset($user['last_photo_date'])) + { + return '0=1'; + } + return $db_field.'>=LEAST(' + .pwg_db_get_recent_period_expression($user['recent_period']) + .','.pwg_db_get_recent_period_expression(1,$user['last_photo_date']).')'; +} + /** - * search an available activation_key + * Returns a unique activation key. * * @return string */ @@ -1570,4 +1503,4 @@ SELECT COUNT(*) } } -?> +?>
\ No newline at end of file |