var $login = null; // User login.
var $name = null; // User name.
var $id = null; // User id.
- var $team_id = null; // Team id.
- var $role = null; // User role (user, client, comanager, manager, admin).
+ var $group_id = null; // Group id.
+ var $role_id = null; // Role id.
+ var $role_name = null; // Role name.
+ var $rank = null; // User role rank.
var $client_id = null; // Client id for client user role.
var $behalf_id = null; // User id, on behalf of whom we are working.
var $behalf_name = null; // User name, on behalf of whom we are working.
var $future_entries = 0; // Whether to allow creating future entries.
var $uncompleted_indicators = 0; // Uncompleted time entry indicators (show nowhere or on users page).
var $bcc_email = null; // Bcc email.
+ var $allow_ip = null; // Specification from where user is allowed access.
var $currency = null; // Currency.
var $plugins = null; // Comma-separated list of enabled plugins.
var $config = null; // Comma-separated list of miscellaneous config options.
var $custom_logo = 0; // Whether to use a custom logo for team.
var $lock_spec = null; // Cron specification for record locking.
var $workday_minutes = 480; // Number of work minutes in a regular day.
- var $rights = 0; // A mask of user rights.
- var $rights_array = array(); // An array of user rights, planned replacement of array mask.
+ var $rights = array(); // An array of user rights such as 'track_own_time', etc.
+ var $is_client = false; // Whether user is a client as determined by missing 'track_own_time' right.
// Constructor.
function __construct($login, $id = null) {
$mdb2 = getConnection();
- $sql = "SELECT u.id, u.login, u.name, u.team_id, u.role, u.client_id, u.email, t.name as team_name,
- t.currency, t.lang, t.decimal_mark, t.date_format, t.time_format, t.week_start,
- t.tracking_mode, t.project_required, t.task_required, t.record_type,
- t.bcc_email, t.plugins, t.config, t.lock_spec, t.workday_minutes, t.custom_logo
- FROM tt_users u LEFT JOIN tt_teams t ON (u.team_id = t.id) WHERE ";
+ $sql = "SELECT u.id, u.login, u.name, u.group_id, u.role_id, r.rank, r.name as role_name, r.rights, u.client_id, u.email, g.name as group_name,
+ g.currency, g.lang, g.decimal_mark, g.date_format, g.time_format, g.week_start,
+ g.tracking_mode, g.project_required, g.task_required, g.record_type,
+ g.bcc_email, g.allow_ip, g.plugins, g.config, g.lock_spec, g.workday_minutes, g.custom_logo
+ FROM tt_users u LEFT JOIN tt_groups g ON (u.group_id = g.id) LEFT JOIN tt_roles r on (r.id = u.role_id) WHERE ";
if ($id)
$sql .= "u.id = $id";
else
$this->login = $val['login'];
$this->name = $val['name'];
$this->id = $val['id'];
- $this->team_id = $val['team_id'];
- $this->role = $val['role'];
+ $this->group_id = $val['group_id'];
+ $this->role_id = $val['role_id'];
+ $this->role_name = $val['role_name'];
+ $this->rights = explode(',', $val['rights']);
+ $this->is_client = !in_array('track_own_time', $this->rights);
+ $this->rank = $val['rank'];
$this->client_id = $val['client_id'];
$this->email = $val['email'];
$this->lang = $val['lang'];
$this->task_required = $val['task_required'];
$this->record_type = $val['record_type'];
$this->bcc_email = $val['bcc_email'];
- $this->team = $val['team_name'];
+ $this->allow_ip = $val['allow_ip'];
+ $this->team = $val['group_name'];
$this->currency = $val['currency'];
$this->plugins = $val['plugins'];
$this->lock_spec = $val['lock_spec'];
$this->behalf_id = $_SESSION['behalf_id'];
$this->behalf_name = $_SESSION['behalf_name'];
}
-
- // Set user rights.
- if ($this->role == ROLE_USER) {
- $this->rights = right_data_entry|right_view_charts|right_view_reports;
- // TODO: get customized rights from the database instead.
- // $this->rights_array[] = "data_entry"; // Enter time and expense records into Time Tracker.
- // $this->rights_array[] = "view_own_data"; // View own reports and charts.
- // $this->rights_array[] = "manage_own_settings"; // Edit own settings.
- // $this->rights_array[] = "view_users"; // View user names and roles in a group.
- } elseif ($this->role == ROLE_CLIENT) {
- $this->rights = right_view_reports|right_view_invoices; // TODO: how about right_view_charts, too?
- // $this->rights_array[] = "view_own_data"; // View own reports, charts, and invoices.
- // $this->rights_array[] = "manage_own_settings"; // Edit own settings.
- } elseif ($this->role == ROLE_COMANAGER) {
- $this->rights = right_data_entry|right_view_charts|right_view_reports|right_view_invoices|right_manage_team;
- // $this->rights_array[] = "data_entry"; // Enter time and expense records into Time Tracker.
- // $this->rights_array[] = "view_own_data"; // View own reports and charts.
- // $this->rights_array[] = "manage_own_settings"; // Edit own settings.
- // $this->rights_array[] = "view_users"; // View user names and roles in a group.
- // $this->rights_array[] = "on_behalf_data_entry";// Can enter data on behalf of lower roles.
- // $this->rights_array[] = "view_data"; // Can view data for lower roles.
- $this->rights_array[] = "override_punch_mode"; // Can input any start and finish times for self and lower roles.
- // TODO: get rights from the database instead.
- } elseif ($this->role == ROLE_MANAGER) {
- $this->rights = right_data_entry|right_view_charts|right_view_reports|right_view_invoices|right_manage_team|right_assign_roles|right_export_team;
- $this->rights_array[] = "override_punch_mode"; // Can input any start and finish times for self and lower roles.
- } elseif ($this->role == ROLE_SITE_ADMIN) {
- $this->rights = right_administer_site;
- }
-
-/*
-// TODO: redesign of user rights and roles is currently ongoing.
-// As we run our of bits for sure at some point, rights should be strings instead,
-// for example: "data_entry".
-// Also, we need rights editor page and team-customized roles.
-// Move this stuff from here to ttUser class.
-//
-// User access rights - bits that collectively define an access mask to the system (a role).
-// We'll have some bits here (1,2, etc...) reserved for future use.
-define('right_data_entry', 4); // Right to enter work hours and expenses.
-define('right_view_charts', 8); // Right to view charts.
-define('right_view_reports', 16); // Right to view reports.
-define('right_view_invoices', 32); // Right to view invoices.
-define('right_manage_team', 64); // Right to manage team. Note that this is not full access to team.
-define('right_assign_roles', 128); // Right to assign user roles.
-define('right_export_team', 256); // Right to export team data to a file.
-define('right_administer_site', 1024); // Admin account right to manage the application as a whole.
-
-// User roles.
-define('ROLE_USER', 4); // Regular user.
-define('ROLE_CLIENT', 16); // Client (to view reports and invoices).
-define('ROLE_COMANAGER', 68); // Team co-manager. Can do many things but not as much as team manager.
-define('ROLE_MANAGER', 324); // Team manager. Can do everything for a team.
-define('ROLE_SITE_ADMIN', 1024); // Site administrator.
-*/
}
}
- // The getActiveUser returns user id on behalf of whom current user is operating.
+ // The getActiveUser returns user id on behalf of whom the current user is operating.
function getActiveUser() {
return ($this->behalf_id ? $this->behalf_id : $this->id);
}
+ // can - determines whether user has a right to do something.
+ function can($do_something) {
+ return in_array($do_something, $this->rights);
+ }
+
// isAdmin - determines whether current user is admin (has right_administer_site).
function isAdmin() {
- return (right_administer_site & $this->role);
+ return $this->can('administer_site');
}
// isManager - determines whether current user is team manager.
+ // This is a legacy function that we are getting rid of by replacing with rights check.
function isManager() {
- return (ROLE_MANAGER == $this->role);
+ return $this->can('export_data'); // By default this is assigned to managers but not co-managers.
+ // Which is sufficient for now until we refactor all calls
+ // to this function and then remove it.
}
// isCoManager - determines whether current user is team comanager.
+ // This is a legacy function that we are getting rid of by replacing with rights check.
function isCoManager() {
- return (ROLE_COMANAGER == $this->role);
+ return ($this->can('manage_users') && !$this->can('export_data'));
}
// isClient - determines whether current user is a client.
function isClient() {
- return (ROLE_CLIENT == $this->role);
+ return $this->is_client;
}
// canManageTeam - determines whether current user is manager or co-manager.
+ // This is a legacy function that we are getting rid of by replacing with rights check.
function canManageTeam() {
- return (right_manage_team & $this->role);
+ return $this->can('manage_users'); // By default this is assigned to co-managers (an managers).
+ // Which is sufficient for now until we refactor all calls
+ // to this function and then remove it.
}
// isPluginEnabled checks whether a plugin is enabled for user.
// Do a query with inner join to get assigned projects.
$sql = "select p.id, p.name, p.description, p.tasks, upb.rate from tt_projects p
inner join tt_user_project_binds upb on (upb.user_id = ".$this->getActiveUser()." and upb.project_id = p.id and upb.status = 1)
- where p.team_id = $this->team_id and p.status = 1 order by p.name";
+ where p.group_id = $this->group_id and p.status = 1 order by p.name";
+ $res = $mdb2->query($sql);
+ if (!is_a($res, 'PEAR_Error')) {
+ while ($val = $res->fetchRow()) {
+ $result[] = $val;
+ }
+ }
+ return $result;
+ }
+
+ // getAssignedTasks - returns an array of assigned tasks.
+ function getAssignedTasks()
+ {
+ // Start with projects;
+ $projects = $this->getAssignedProjects();
+ if (!$projects) return false;
+
+ // Build an array of task ids.
+ $task_ids = array();
+ foreach($projects as $project) {
+ $one_project_tasks = $project['tasks'] ? explode(',', $project['tasks']) : array();
+ $task_ids = array_unique(array_merge($task_ids, $one_project_tasks));
+ }
+ if (!$task_ids) return false;
+
+ // Get task descriptions.
+ $result = array();
+ $mdb2 = getConnection();
+ $tasks = implode(',', $task_ids); // This is a comma-separated list of task ids.
+
+ $sql = "select id, name, description from tt_tasks".
+ " where group_id = $this->group_id and status = 1 and id in ($tasks) order by name";
$res = $mdb2->query($sql);
if (!is_a($res, 'PEAR_Error')) {
while ($val = $res->fetchRow()) {
return $result;
}
+ // getAssignedClients - returns an array of clients assigned to own projects.
+ function getAssignedClients()
+ {
+ // Start with projects;
+ $projects = $this->getAssignedProjects();
+ if (!$projects) return false;
+ $assigned_project_ids = array();
+ foreach($projects as $project) {
+ $assigned_project_ids[] = $project['id'];
+ }
+
+ $mdb2 = getConnection();
+
+ // Get active clients for group.
+ $clients = array();
+ $sql = "select id, name, address, projects from tt_clients where group_id = $this->group_id and status = 1";
+ $res = $mdb2->query($sql);
+ if (!is_a($res, 'PEAR_Error')) {
+ while ($val = $res->fetchRow()) {
+ $client_project_ids = $val['projects'] ? explode(',', $val['projects']) : array();
+ if (array_intersect($assigned_project_ids, $client_project_ids))
+ $clients[] = $val; // Add client if one of user projects is a client project, too.
+ }
+ }
+ return $clients;
+ }
+
// isDateLocked checks whether a specifc date is locked for modifications.
function isDateLocked($date)
{
- if ($this->isPluginEnabled('lk') && $this->lock_spec) {
- // Override for managers.
- if ($this->canManageTeam()) return false;
+ if (!$this->isPluginEnabled('lk'))
+ return false; // Locking feature is disabled.
- require_once(LIBRARY_DIR.'/tdcron/class.tdcron.php');
- require_once(LIBRARY_DIR.'/tdcron/class.tdcron.entry.php');
+ if (!$this->lock_spec)
+ return false; // There is no lock specification.
- // Calculate the last occurrence of a lock.
- $last = tdCron::getLastOccurrence($this->lock_spec, time());
- $lockdate = new DateAndTime(DB_DATEFORMAT, strftime('%Y-%m-%d', $last));
- if ($date->before($lockdate)) {
- return true;
+ if (!$this->behalf_id && $this->can('override_own_date_lock'))
+ return false; // User is working as self and can override own date lock.
+
+ if ($this->behalf_id && $this->can('override_date_lock'))
+ return false; // User is working on behalf of someone else and can override date lock.
+
+ require_once(LIBRARY_DIR.'/tdcron/class.tdcron.php');
+ require_once(LIBRARY_DIR.'/tdcron/class.tdcron.entry.php');
+
+ // Calculate the last occurrence of a lock.
+ $last = tdCron::getLastOccurrence($this->lock_spec, time());
+ $lockdate = new DateAndTime(DB_DATEFORMAT, strftime('%Y-%m-%d', $last));
+ if ($date->before($lockdate))
+ return true;
+
+ return false;
+ }
+
+ // canOverridePunchMode checks whether a user can override punch mode in a situation.
+ function canOverridePunchMode()
+ {
+ if (!$this->behalf_id && !$this->can('override_own_punch_mode'))
+ return false; // User is working as self and cannot override for self.
+
+ if ($this->behalf_id && !$this->can('override_punch_mode'))
+ return false; // User is working on behalf of someone else and cannot override.
+
+ return true;
+ }
+
+ // getUsers obtains users in a group, as specififed by options.
+ function getUsers($options) {
+
+ $mdb2 = getConnection();
+
+ $skipClients = !isset($options['include_clients']);
+ $includeSelf = isset($options['include_self']);
+
+ $select_part = 'select u.id, u.name';
+ if (isset($options['include_login'])) $select_part .= ', u.login';
+ if (!isset($options['include_clients'])) $select_part .= ', r.rights';
+ if (isset($options['include_role'])) $select_part .= ', r.name as role_name, r.rank';
+
+ $from_part = ' from tt_users u';
+
+ $left_joins = null;
+ if (isset($options['max_rank']) || $skipClients || isset($options['include_role']))
+ $left_joins .= ' left join tt_roles r on (u.role_id = r.id)';
+
+ $where_part = " where u.group_id = $this->group_id";
+ if (isset($options['status']))
+ $where_part .= ' and u.status = '.(int)$options['status'];
+ else
+ $where_part .= ' and u.status is not null';
+ if ($includeSelf) {
+ $where_part .= " and (u.id = $this->id || r.rank <= ".(int)$options['max_rank'].')';
+ } else {
+ if (isset($options['max_rank'])) $where_part .= ' and r.rank <= '.(int)$options['max_rank'];
+ }
+
+ $order_part = " order by upper(u.name)";
+
+ $sql = $select_part.$from_part.$left_joins.$where_part.$order_part;
+ $res = $mdb2->query($sql);
+ $user_list = array();
+ if (is_a($res, 'PEAR_Error'))
+ return false;
+
+ while ($val = $res->fetchRow()) {
+ if ($skipClients) {
+ $isClient = in_array('track_own_time', explode(',', $val['rights'])) ? 0 : 1; // Clients do not have track_own_time right.
+ if ($isClient)
+ continue; // Skip adding clients.
}
+ $user_list[] = $val;
+ }
+
+ if (isset($options['self_first'])) {
+ // Put own entry at the front.
+ $cnt = count($user_list);
+ for($i = 0; $i < $cnt; $i++) {
+ if ($user_list[$i]['id'] == $this->id) {
+ $self = $user_list[$i]; // Found self.
+ array_unshift($user_list, $self); // Put own entry at the front.
+ array_splice($user_list, $i+1, 1); // Remove duplicate.
+ }
+ }
+ }
+ return $user_list;
+ }
+
+ // getUser function is used to manage users in group and returns user details.
+ // At the moment, the function is used for user edits and deletes.
+ function getUser($user_id) {
+ if (!$this->can('manage_users')) return false;
+
+ $mdb2 = getConnection();
+
+ $sql = "select u.id, u.name, u.login, u.role_id, u.status, u.rate, u.email from tt_users u".
+ " left join tt_roles r on (u.role_id = r.id)".
+ " where u.id = $user_id and u.group_id = $this->group_id and u.status is not null".
+ " and (r.rank < $this->rank or (r.rank = $this->rank and u.id = $this->id))"; // Users with lesser roles or self.
+ $res = $mdb2->query($sql);
+ if (!is_a($res, 'PEAR_Error')) {
+ $val = $res->fetchRow();
+ return $val;
+ }
+ return false;
+ }
+
+ // checkBehalfId checks whether behalf_id is appropriate.
+ // On behalf user must be active and have lower rank.
+ function checkBehalfId() {
+ $options = array('status'=>ACTIVE,'max_rank'=>$this->rank-1);
+ $users = $this->getUsers($options);
+ foreach($users as $one_user) {
+ if ($one_user['id'] == $this->behalf_id)
+ return true;
+ }
+ return false;
+ }
+
+ // adjustBehalfId attempts to adjust behalf_id and behalf_name to a first found
+ // apropriate user.
+ //
+ // Needed for situations when user does not have do_own_something right.
+ // Example: has view_charts but does not have view_own_charts.
+ // In this case we still allow access to charts, but set behalf_id to someone else.
+ function adjustBehalfId() {
+ $options = array('status'=>ACTIVE,'max_rank'=>$this->rank-1);
+ $users = $this->getUsers($options);
+ foreach($users as $one_user) {
+ // Fake loop to access first element.
+ $this->behalf_id = $one_user['id'];
+ $this->behalf_name = $one_user['name'];
+ $_SESSION['behalf_id'] = $this->behalf_id;
+ $_SESSION['behalf_name'] = $this->behalf_name;
+ return true;
}
return false;
}
projects / timetracker.git / blobdiff