Files
Piwigo/include/functions_user.inc.php
rub 5046b3c210 Feature Issue ID 0000601: Filter all public pages with only recent elements
Last draft before final development.
There a icon for global mode and one other for local mode.

Counters are not good, filter on images are not everywhere applied, moment to update cache are not optimized, ...

Go to http://forum.phpwebgallery.net/viewtopic.php?id=9490


git-svn-id: http://piwigo.org/svn/trunk@1651 68402e56-0260-453c-a942-63ccdbb3a9ee
2006-12-13 00:05:16 +00:00

1018 lines
24 KiB
PHP

<?php
// +-----------------------------------------------------------------------+
// | PhpWebGallery - a PHP based picture gallery |
// | Copyright (C) 2002-2003 Pierrick LE GALL - pierrick@phpwebgallery.net |
// | Copyright (C) 2003-2006 PhpWebGallery Team - http://phpwebgallery.net |
// +-----------------------------------------------------------------------+
// | branch : BSF (Best So Far)
// | file : $Id$
// | last update : $Date$
// | last modifier : $Author$
// | revision : $Revision$
// +-----------------------------------------------------------------------+
// | This program is free software; you can redistribute it and/or modify |
// | it under the terms of the GNU General Public License as published by |
// | the Free Software Foundation |
// | |
// | This program is distributed in the hope that it will be useful, but |
// | WITHOUT ANY WARRANTY; without even the implied warranty of |
// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
// | General Public License for more details. |
// | |
// | You should have received a copy of the GNU General Public License |
// | along with this program; if not, write to the Free Software |
// | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
// | USA. |
// +-----------------------------------------------------------------------+
// validate_mail_address 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.
// If the mail address doesn't correspond, an error message is returned.
function validate_mail_address( $mail_address )
{
global $lang;
if ( $mail_address == '' )
{
return '';
}
$regex = '/^[\w-]+(\.[\w-]+)*@[\w-]+(\.[\w-]+)*\.[a-z]+$/';
if ( !preg_match( $regex, $mail_address ) )
{
return $lang['reg_err_mail_address'];
}
}
function register_user($login, $password, $mail_address)
{
global $lang, $conf;
$errors = array();
if ($login == '')
{
array_push($errors, $lang['reg_err_login1']);
}
if (ereg("^.* $", $login))
{
array_push($errors, $lang['reg_err_login2']);
}
if (ereg("^ .*$", $login))
{
array_push($errors, $lang['reg_err_login3']);
}
if (get_userid($login))
{
array_push($errors, $lang['reg_err_login5']);
}
$mail_error = validate_mail_address($mail_address);
if ('' != $mail_error)
{
array_push($errors, $mail_error);
}
// 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) = mysql_fetch_array(pwg_query($query));
$insert =
array(
$conf['user_fields']['id'] => $next_id,
$conf['user_fields']['username'] => mysql_escape_string($login),
$conf['user_fields']['password'] => $conf['pass_convert']($password),
$conf['user_fields']['email'] => $mail_address
);
include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
mass_inserts(USERS_TABLE, array_keys($insert), array($insert));
// Assign by default groups
{
$query = '
SELECT id
FROM '.GROUPS_TABLE.'
WHERE is_default = \''.boolean_to_string(true).'\'
ORDER BY id ASC
;';
$result = pwg_query($query);
$inserts = array();
while ($row = mysql_fetch_array($result))
{
array_push
(
$inserts,
array
(
'user_id' => $next_id,
'group_id' => $row['id']
)
);
}
if (count($inserts) != 0)
{
include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
mass_inserts(USER_GROUP_TABLE, array('user_id', 'group_id'), $inserts);
}
}
create_user_infos($next_id);
trigger_action('register_user',
array(
'id'=>$next_id,
'username'=>$login,
'email'=>$mail_address,
)
);
}
return $errors;
}
function setup_style($style)
{
return new Template(PHPWG_ROOT_PATH.'template/'.$style);
}
function build_user( $user_id, $use_cache, $filter_global_mode = false )
{
global $conf;
$user['id'] = $user_id;
$user = array_merge( $user, getuserdata($user_id, $use_cache, $filter_global_mode) );
if ( $user['id'] == $conf['guest_id'])
{
$user['is_the_guest']=true;
$user['template'] = $conf['default_template'];
$user['nb_image_line'] = $conf['nb_image_line'];
$user['nb_line_page'] = $conf['nb_line_page'];
$user['language'] = $conf['default_language'];
$user['maxwidth'] = $conf['default_maxwidth'];
$user['maxheight'] = $conf['default_maxheight'];
$user['recent_period'] = $conf['recent_period'];
$user['expand'] = $conf['auto_expand'];
$user['show_nb_comments'] = $conf['show_nb_comments'];
$user['enabled_high'] = $conf['newuser_default_enabled_high'];
}
else
{
$user['is_the_guest']=false;
}
// calculation of the number of picture to display per page
$user['nb_image_page'] = $user['nb_image_line'] * $user['nb_line_page'];
// include template/theme configuration
if (defined('IN_ADMIN') and IN_ADMIN)
{
list($user['template'], $user['theme']) =
explode
(
'/',
isset($conf['default_admin_layout']) ? $conf['default_admin_layout']
: $user['template']
);
// TODO : replace $conf['admin_layout'] by $user['admin_layout']
}
else
{
list($user['template'], $user['theme']) = explode('/', $user['template']);
}
return $user;
}
/**
* find informations related to the user identifier
*
* @param int user identifier
* @param boolean use_cache
* @param array
*/
function getuserdata($user_id, $use_cache, $filter_global_mode = false )
{
global $conf;
$userdata = array();
$query = '
SELECT ';
$is_first = true;
foreach ($conf['user_fields'] as $pwgfield => $dbfield)
{
if ($is_first)
{
$is_first = false;
}
else
{
$query.= '
, ';
}
$query.= $dbfield.' AS '.$pwgfield;
}
$query.= '
FROM '.USERS_TABLE.'
WHERE '.$conf['user_fields']['id'].' = \''.$user_id.'\'
;';
$row = mysql_fetch_array(pwg_query($query));
while (true)
{
$query = '
SELECT ui.*, uc.*
FROM '.USER_INFOS_TABLE.' AS ui LEFT JOIN '.USER_CACHE_TABLE.' AS uc
ON ui.user_id = uc.user_id
WHERE ui.user_id = \''.$user_id.'\'
;';
$result = pwg_query($query);
if (mysql_num_rows($result) > 0)
{
break;
}
else
{
create_user_infos($user_id);
}
}
$row = array_merge($row, mysql_fetch_array($result));
foreach ($row as $key => $value)
{
if (!is_numeric($key))
{
// If the field is true or false, the variable is transformed into a
// boolean value.
if ($value == 'true' or $value == 'false')
{
$userdata[$key] = get_boolean($value);
}
else
{
$userdata[$key] = $value;
}
}
}
if ($use_cache)
{
$userdata['filter_global_mode'] = $filter_global_mode;
if (!isset($userdata['need_update'])
or !is_bool($userdata['need_update'])
or $userdata['need_update'] == true
or $filter_global_mode // not optimize condition RubTag
)
{
$userdata['forbidden_categories'] =
calculate_permissions($userdata['id'], $userdata['status']);
update_user_cache_categories($userdata);
// Set need update are done
$userdata['need_update'] = $userdata['filter_global_mode']; // for draft always update RubTag
$query = '
SELECT COUNT(DISTINCT(image_id)) as total
FROM '.IMAGE_CATEGORY_TABLE.'
WHERE category_id NOT IN ('.$userdata['forbidden_categories'].')
;';
list($userdata['nb_total_images']) = mysql_fetch_array(pwg_query($query));
// update user cache
$query = '
DELETE FROM '.USER_CACHE_TABLE.'
WHERE user_id = '.$userdata['id'].'
;';
pwg_query($query);
$query = '
INSERT INTO '.USER_CACHE_TABLE.'
(user_id, need_update, forbidden_categories, nb_total_images)
VALUES
('.$userdata['id'].',\''.boolean_to_string($userdata['need_update']).'\',\''
.$userdata['forbidden_categories'].'\','.$userdata['nb_total_images'].')
;';
pwg_query($query);
}
{
}
}
return $userdata;
}
/*
* deletes favorites of the current user if he's not allowed to see them
*
* @return void
*/
function check_user_favorites()
{
global $user;
if ($user['forbidden_categories'] == '')
{
return;
}
// retrieving images allowed : belonging to at least one authorized
// category
$query = '
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'].'
AND ic.category_id NOT IN ('.$user['forbidden_categories'].')
;';
$result = pwg_query($query);
$authorizeds = array();
while ($row = mysql_fetch_array($result))
{
array_push($authorizeds, $row['image_id']);
}
$query = '
SELECT image_id
FROM '.FAVORITES_TABLE.'
WHERE user_id = '.$user['id'].'
;';
$result = pwg_query($query);
$favorites = array();
while ($row = mysql_fetch_array($result))
{
array_push($favorites, $row['image_id']);
}
$to_deletes = array_diff($favorites, $authorizeds);
if (count($to_deletes) > 0)
{
$query = '
DELETE FROM '.FAVORITES_TABLE.'
WHERE image_id IN ('.implode(',', $to_deletes).')
AND user_id = '.$user['id'].'
;';
pwg_query($query);
}
}
/**
* 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
* such as "WHERE category_id NOT IN ($forbidden_categories)"
*
* @param int user_id
* @param string user_status
* @return string forbidden_categories
*/
function calculate_permissions($user_id, $user_status)
{
global $user;
$private_array = array();
$authorized_array = array();
$query = '
SELECT id
FROM '.CATEGORIES_TABLE.'
WHERE status = \'private\'
;';
$result = pwg_query($query);
while ($row = mysql_fetch_array($result))
{
array_push($private_array, $row['id']);
}
// retrieve category ids directly authorized to the user
$query = '
SELECT cat_id
FROM '.USER_ACCESS_TABLE.'
WHERE user_id = '.$user_id.'
;';
$authorized_array = array_from_query($query, 'cat_id');
// retrieve category ids authorized to the groups the user belongs to
$query = '
SELECT cat_id
FROM '.USER_GROUP_TABLE.' AS ug INNER JOIN '.GROUP_ACCESS_TABLE.' AS ga
ON ug.group_id = ga.group_id
WHERE ug.user_id = '.$user_id.'
;';
$authorized_array =
array_merge(
$authorized_array,
array_from_query($query, 'cat_id')
);
// uniquify ids : some private categories might be authorized for the
// groups and for the user
$authorized_array = array_unique($authorized_array);
// only unauthorized private categories are forbidden
$forbidden_array = array_diff($private_array, $authorized_array);
// if user is not an admin, locked categories are forbidden
if (!is_admin($user_status))
{
$query = '
SELECT id
FROM '.CATEGORIES_TABLE.'
WHERE visible = \'false\'
;';
$result = pwg_query($query);
while ($row = mysql_fetch_array($result))
{
array_push($forbidden_array, $row['id']);
}
$forbidden_array = array_unique($forbidden_array);
}
if ( empty($forbidden_array) )
{// at least, the list contains 0 value. This category does not exists so
// where clauses such as "WHERE category_id NOT IN(0)" will always be
// true.
array_push($forbidden_array, 0);
}
return implode(',', $forbidden_array);
}
/**
* compute data of categories branches
*/
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)
{
array_push($list_cat_id, $cat_id);
}
}
/**
* update data of user_cache_categories
*
* @param array userdata
* @return null
*/
function update_user_cache_categories(&$userdata)
{
// delete user cache
$query = '
DELETE FROM '.USER_CACHE_CATEGORIES_TABLE.'
WHERE user_id = '.$userdata['id'].'
;';
pwg_query($query);
/*$query = '
SELECT id cat_id, date_last max_date_last, nb_images count_images, global_rank
FROM '.CATEGORIES_TABLE;
if ($userdata['forbidden_categories'] != '')
{
$query.= '
WHERE id NOT IN ('.$userdata['forbidden_categories'].')';
}
$query.= ';';*/
$query = '
SELECT c.id cat_id, date_last max_date_last, nb_images count_images, global_rank';
if (!$userdata['filter_global_mode'])
{
$query.= '
FROM '.CATEGORIES_TABLE.' as C';
}
else
{
// Count by date_available to avoid count null
$query.= ', count(date_available) filtered_count_images, max(date_available) max_date_available
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.date_available > SUBDATE(
CURRENT_DATE,INTERVAL '.$userdata['recent_period'].' DAY)';
}
if ($userdata['forbidden_categories'] != '')
{
$query.= '
WHERE C.id NOT IN ('.$userdata['forbidden_categories'].')';
}
if ($userdata['filter_global_mode'])
{
$query.= '
GROUP BY c.id';
}
$query.= ';';
$result = pwg_query($query);
$cats = array();
while ($row = mysql_fetch_assoc($result))
{
$row['user_id'] = $userdata['id'];
$row['count_categories'] = 0;
if ($userdata['filter_global_mode'])
{
$row['count_images'] = $row['filtered_count_images'];
$row['max_date_last'] = $row['max_date_available'];
}
$cats += array($row['cat_id'] => $row);
}
usort($cats, 'global_rank_compare');
$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)
{
array_push($list_cat_id, $id);
}
else
{
compute_branch_cat_data($cats, $list_cat_id, $level, $ref_level);
array_push($list_cat_id, $id);
}
$ref_level = $level;
}
$level = 1;
compute_branch_cat_data($cats, $list_cat_id, $level, $ref_level);
if ($userdata['filter_global_mode'])
{
$forbidden_cats = array();
$forbidden_cats = explode(',', $userdata['forbidden_categories']);
$cat_tmp = $cats;
$cats = array();
foreach ($cat_tmp as $cat_id => $category)
{
if (empty($category['max_date_last']))
{
array_push($forbidden_cats, $category['cat_id']);
}
else
{
array_push($cats, $category);
}
}
$userdata['forbidden_categories'] = implode(',', array_unique($forbidden_cats));
}
include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
mass_inserts
(
USER_CACHE_CATEGORIES_TABLE,
array
(
'user_id', 'cat_id',
'max_date_last', 'count_images', 'count_categories'
),
$cats
);
}
/**
* returns the username corresponding to the given user identifier if exists
*
* @param int user_id
* @return mixed
*/
function get_username($user_id)
{
global $conf;
$query = '
SELECT '.$conf['user_fields']['username'].'
FROM '.USERS_TABLE.'
WHERE '.$conf['user_fields']['id'].' = '.intval($user_id).'
;';
$result = pwg_query($query);
if (mysql_num_rows($result) > 0)
{
list($username) = mysql_fetch_row($result);
}
else
{
return false;
}
return $username;
}
/**
* returns user identifier thanks to his name, false if not found
*
* @param string username
* @param int user identifier
*/
function get_userid($username)
{
global $conf;
$username = mysql_escape_string($username);
$query = '
SELECT '.$conf['user_fields']['id'].'
FROM '.USERS_TABLE.'
WHERE '.$conf['user_fields']['username'].' = \''.$username.'\'
;';
$result = pwg_query($query);
if (mysql_num_rows($result) == 0)
{
return false;
}
else
{
list($user_id) = mysql_fetch_row($result);
return $user_id;
}
}
/**
* search an available feed_id
*
* @return string feed identifier
*/
function find_available_feed_id()
{
while (true)
{
$key = generate_key(50);
$query = '
SELECT COUNT(*)
FROM '.USER_FEED_TABLE.'
WHERE id = \''.$key.'\'
;';
list($count) = mysql_fetch_row(pwg_query($query));
if (0 == $count)
{
return $key;
}
}
}
/**
* add user informations based on default values
*
* @param int user_id
*/
function create_user_infos($user_id)
{
global $conf;
list($dbnow) = mysql_fetch_row(pwg_query('SELECT NOW();'));
if ($user_id == $conf['webmaster_id'])
{
$status = 'webmaster';
}
else if ($user_id == $conf['guest_id'])
{
$status = 'guest';
}
else
{
$status = 'normal';
}
$insert =
array(
'user_id' => $user_id,
'status' => $status,
'template' => $conf['default_template'],
'nb_image_line' => $conf['nb_image_line'],
'nb_line_page' => $conf['nb_line_page'],
'language' => $conf['default_language'],
'recent_period' => $conf['recent_period'],
'expand' => boolean_to_string($conf['auto_expand']),
'show_nb_comments' => boolean_to_string($conf['show_nb_comments']),
'maxwidth' => $conf['default_maxwidth'],
'maxheight' => $conf['default_maxheight'],
'registration_date' => $dbnow,
'enabled_high' =>
boolean_to_string($conf['newuser_default_enabled_high']),
);
include_once(PHPWG_ROOT_PATH.'admin/include/functions.php');
mass_inserts(USER_INFOS_TABLE, array_keys($insert), array($insert));
}
/**
* returns the groupname corresponding to the given group identifier if
* exists
*
* @param int group_id
* @return mixed
*/
function get_groupname($group_id)
{
$query = '
SELECT name
FROM '.GROUPS_TABLE.'
WHERE id = '.intval($group_id).'
;';
$result = pwg_query($query);
if (mysql_num_rows($result) > 0)
{
list($groupname) = mysql_fetch_row($result);
}
else
{
return false;
}
return $groupname;
}
/**
* return the file path of the given language filename, depending on the
* availability of the file
*
* in descending order of preference: user language, default language,
* PhpWebGallery default language.
*
* @param string filename
* @return string filepath
*/
function get_language_filepath($filename)
{
global $user, $conf;
$directories = array();
if ( isset($user['language']) )
{
$directories[] = PHPWG_ROOT_PATH.'language/'.$user['language'];
}
$directories[] = PHPWG_ROOT_PATH.'language/'.$conf['default_language'];
$directories[] = PHPWG_ROOT_PATH.'language/'.PHPWG_DEFAULT_LANGUAGE;
foreach ($directories as $directory)
{
$filepath = $directory.'/'.$filename;
if (file_exists($filepath))
{
return $filepath;
}
}
return false;
}
/**
* returns the auto login key or false on error
* @param int user_id
*/
function calculate_auto_login_key($user_id)
{
global $conf;
$query = '
SELECT '.$conf['user_fields']['username'].' AS username
, '.$conf['user_fields']['password'].' AS password
FROM '.USERS_TABLE.'
WHERE '.$conf['user_fields']['id'].' = '.$user_id;
$result = pwg_query($query);
if (mysql_num_rows($result) > 0)
{
$row = mysql_fetch_assoc($result);
$key = sha1( $row['username'].$row['password'] );
return $key;
}
return false;
}
/*
* Performs all required actions for user login
* @param int user_id
* @param bool remember_me
* @return void
*/
function log_user($user_id, $remember_me)
{
global $conf, $user;
if ($remember_me and $conf['authorize_remembering'])
{
$key = calculate_auto_login_key($user_id);
if ($key!==false)
{
$cookie = array('id' => (int)$user_id, 'key' => $key);
setcookie($conf['remember_me_name'],
serialize($cookie),
time()+$conf['remember_me_length'],
cookie_path()
);
}
}
else
{ // make sure we clean any remember me ...
setcookie($conf['remember_me_name'], '', 0, cookie_path());
}
if ( session_id()!="" )
{ // we regenerate the session for security reasons
// see http://www.acros.si/papers/session_fixation.pdf
session_regenerate_id();
}
else
{
session_start();
}
$_SESSION['pwg_uid'] = (int)$user_id;
$user['id'] = $_SESSION['pwg_uid'];
}
/*
* Performs auto-connexion when cookie remember_me exists
* @return true/false
*/
function auto_login() {
global $conf;
if ( isset( $_COOKIE[$conf['remember_me_name']] ) )
{
$cookie = unserialize(stripslashes($_COOKIE[$conf['remember_me_name']]));
if ($cookie!==false)
{
$key = calculate_auto_login_key($cookie['id']);
if ($key!==false and $key===$cookie['key'])
{
log_user($cookie['id'], true);
return true;
}
}
setcookie($conf['remember_me_name'], '', 0, cookie_path());
}
return false;
}
/*
* Return access_type definition of uuser
* Test does with user status
* @return bool
*/
function get_access_type_status($user_status = '')
{
global $user;
if (($user_status == '') and isset($user['status']))
{
$user_status = $user['status'];
}
$access_type_status = ACCESS_NONE;
switch ($user_status)
{
case 'guest':
case 'generic':
{
$access_type_status = ACCESS_GUEST;
break;
}
case 'normal':
{
$access_type_status = ACCESS_CLASSIC;
break;
}
case 'admin':
{
$access_type_status = ACCESS_ADMINISTRATOR;
break;
}
case 'webmaster':
{
$access_type_status = ACCESS_WEBMASTER;
break;
}
}
return $access_type_status;
}
/*
* Return if user have access to access_type definition
* Test does with user status
* @return bool
*/
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 = '')
{
if (!is_autorize_status($access_type, $user_status))
{
access_denied();
}
}
/*
* Return if user is an administrator
* @return bool
*/
function is_admin($user_status = '')
{
return is_autorize_status(ACCESS_ADMINISTRATOR, $user_status);
}
/*
* Return if current user is an adviser
* @return bool
*/
function is_adviser()
{
global $user;
return ($user['adviser'] == 'true');
}
/*
* 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
{
if (is_adviser())
{
return 'adviser.mode@'.$_SERVER['SERVER_NAME'];
}
else
{
return $email_address;
}
}
}
?>