// | https://www.anuko.com/time_tracker/credits.htm
// +----------------------------------------------------------------------+
+import('ttConfigHelper');
+
class ttUser {
var $login = null; // User login.
var $name = null; // User name.
var $id = null; // User id.
+ var $org_id = null; // Organization id.
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_group_id = null; // Group id, on behalf of which we are working.
var $behalf_name = null; // User name, on behalf of whom we are working.
+ var $group_name = null; // Group name.
+ var $behalf_group_name = null;// Group name, on behalf of which we are working.
var $email = null; // User email.
var $lang = null; // Language.
var $decimal_mark = null; // Decimal separator.
var $currency = null; // Currency.
var $plugins = null; // Comma-separated list of enabled plugins.
var $config = null; // Comma-separated list of miscellaneous config options.
- var $group = null; // Group name.
var $custom_logo = 0; // Whether to use a custom logo for group.
var $lock_spec = null; // Cron specification for record locking.
var $workday_minutes = 480; // Number of work minutes in a regular day.
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.
+ var $minutes_in_unit = 15; // Number of minutes in unit for Work units plugin.
+ var $first_unit_threshold = 0;// Threshold for 1st unit for Work units plugin.
+ var $unit_totals_only = 0; // Totals only option for the Work units plugin.
// Constructor.
function __construct($login, $id = null) {
$mdb2 = getConnection();
- $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,
+ $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.org_id, 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.password_complexity, 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 ";
$this->login = $val['login'];
$this->name = $val['name'];
$this->id = $val['id'];
+ $this->org_id = $val['org_id'];
$this->group_id = $val['group_id'];
$this->role_id = $val['role_id'];
$this->role_name = $val['role_name'];
$this->bcc_email = $val['bcc_email'];
$this->allow_ip = $val['allow_ip'];
$this->password_complexity = $val['password_complexity'];
- $this->group = $val['group_name'];
+ $this->group_name = $val['group_name'];
$this->currency = $val['currency'];
$this->plugins = $val['plugins'];
$this->lock_spec = $val['lock_spec'];
$this->custom_logo = $val['custom_logo'];
$this->config = $val['config'];
- $config_array = explode(',', $this->config);
-
+ $config = new ttConfigHelper($this->config);
// Set user config options.
- $this->show_holidays = in_array('show_holidays', $config_array);
- $this->punch_mode = in_array('punch_mode', $config_array);
- $this->allow_overlap = in_array('allow_overlap', $config_array);
- $this->future_entries = in_array('future_entries', $config_array);
- $this->uncompleted_indicators = in_array('uncompleted_indicators', $config_array);
-
- // Set "on behalf" id and name.
+ $this->show_holidays = $config->getDefinedValue('show_holidays');
+ $this->punch_mode = $config->getDefinedValue('punch_mode');
+ $this->allow_overlap = $config->getDefinedValue('allow_overlap');
+ $this->future_entries = $config->getDefinedValue('future_entries');
+ $this->uncompleted_indicators = $config->getDefinedValue('uncompleted_indicators');
+ if ($this->isPluginEnabled('wu')) {
+ $minutes_in_unit = $config->getIntValue('minutes_in_unit');
+ if ($minutes_in_unit) $this->minutes_in_unit = $minutes_in_unit;
+ $first_unit_threshold = $config->getIntValue('1st_unit_threshold');
+ if ($first_unit_threshold) $this->first_unit_threshold = $first_unit_threshold;
+ $this->unit_totals_only = $config->getDefinedValue('unit_totals_only');
+ }
+
+ // Set "on behalf" id and name (user).
if (isset($_SESSION['behalf_id'])) {
$this->behalf_id = $_SESSION['behalf_id'];
$this->behalf_name = $_SESSION['behalf_name'];
}
+ // Set "on behalf" id and name (group).
+ if (isset($_SESSION['behalf_group_id'])) {
+ $this->behalf_group_id = $_SESSION['behalf_group_id'];
+ $this->behalf_group_name = $_SESSION['behalf_group_name'];
+ }
}
}
return ($this->behalf_id ? $this->behalf_id : $this->id);
}
+ // The getActiveGroup returns group id on behalf of which the current user is operating.
+ function getActiveGroup() {
+ return ($this->behalf_group_id ? $this->behalf_group_id : $this->group_id);
+ }
+
// can - determines whether user has a right to do something.
function can($do_something) {
return in_array($do_something, $this->rights);
}
- // isManager - determines whether current user is group manager.
- // This is a legacy function that we are getting rid of by replacing with rights check.
- function isManager() {
- 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.
- }
-
// isClient - determines whether current user is a client.
function isClient() {
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 $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.
function isPluginEnabled($plugin)
{
$result = array();
$mdb2 = getConnection();
+ $group_id = $this->behalf_group_id ? $this->behalf_group_id : $this->group_id;
// 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.group_id = $this->group_id and p.status = 1 order by p.name";
+ where p.group_id = $group_id and p.status = 1 order by p.name";
$res = $mdb2->query($sql);
if (!is_a($res, 'PEAR_Error')) {
while ($val = $res->fetchRow()) {
$skipClients = !isset($options['include_clients']);
$includeSelf = isset($options['include_self']);
+ $group_id = isset($options['group_id']) ? $options['group_id'] : $this->group_id;
$select_part = 'select u.id, u.name';
if (isset($options['include_login'])) $select_part .= ', u.login';
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";
+ $where_part = " where u.org_id = $this->org_id and u.group_id = $group_id";
if (isset($options['status']))
$where_part .= ' and u.status = '.(int)$options['status'];
else
return $user_list;
}
+ // getGroups obtains an array consisting of:
+ // - A parent group (..) of a currently selected group, if available.
+ // - A currently selected group (.) represented by $behalf_group_id.
+ // - All subgroups (only immediate children) of a currently selected group.
+ function getGroups() {
+ $mdb2 = getConnection();
+
+ $selected_group_id = ($this->behalf_group_id ? $this->behalf_group_id : $this->group_id);
+ $selected_group_name = ($this->behalf_group_id ? $this->behalf_group_name : $this->group_name);
+
+ // Start with parent group.
+ if ($selected_group_id != $this->group_id) {
+ // We are in one of subgroups, and a parent exists.
+ // Get parent group info.
+ $sql = "select parent_id from tt_groups where org_id = $this->org_id and id = $selected_group_id";
+ $res = $mdb2->query($sql);
+ if (!is_a($res, 'PEAR_Error')) {
+ $val = $res->fetchRow();
+ $parent_id = $val['parent_id'];
+ if ($parent_id) {
+ // Get parent group name.
+ $sql = "select name from tt_groups where org_id = $this->org_id and id = $parent_id";
+ $res = $mdb2->query($sql);
+ if (!is_a($res, 'PEAR_Error')) {
+ $val = $res->fetchRow();
+ $groups[] = array('id'=>$parent_id,'name'=>$val['name']);
+ }
+ }
+ }
+ }
+
+ // Add current group.
+ $groups[] = array('id'=>$selected_group_id,'name'=>$selected_group_name);
+
+ // Add subgroups.
+ $sql = "select id, name from tt_groups where org_id = $this->org_id and parent_id = $selected_group_id";
+ $res = $mdb2->query($sql);
+ if (!is_a($res, 'PEAR_Error')) {
+ while ($val = $res->fetchRow()) {
+ $groups[] = array('id'=>$val['id'],'name'=>$val['name']);
+ }
+ }
+ return $groups;
+ }
+
// 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) {
$mdb2 = getConnection();
- $sql = "select u.id, u.name, u.login, u.role_id, u.status, u.rate, u.email from tt_users u".
+ $sql = "select u.id, u.name, u.login, u.role_id, u.client_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.
}
// checkBehalfId checks whether behalf_id is appropriate.
- // On behalf user must be active and have lower rank.
+ // On behalf user must be active and have lower rank if the user is from home group,
+ // otherwise:
+ // - subgroup must ve valid;
+ // - user should be a member of it.
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;
+ if (!$this->behalf_group_id) {
+ // Checking user from home group.
+ $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;
+ }
+ } else {
+ // Checking user from a subgroup.
+ $group_id = $this->behalf_group_id;
+ if (!$this->isSubgroupValid($group_id))
+ return false;
+
+ // So far, so good. Check user now.
+ $options = array('group_id'=>$group_id,'status'=>ACTIVE,'max_rank'=>MAX_RANK);
+ $users = $this->getUsers($options);
+ foreach($users as $one_user) {
+ if ($one_user['id'] == $this->behalf_id)
+ return true;
+ }
}
return false;
}
// 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.
+ // Another example: working in a subgroup on behalf of someone else.
function adjustBehalfId() {
- $options = array('status'=>ACTIVE,'max_rank'=>$this->rank-1);
+ $group_id = $this->behalf_group_id ? $this->behalf_group_id : $this->group_id;
+ $rank = $this->getMaxRankForGroup($group_id);
+
+ // Adjust to first found user in group.
+ $options = array('group_id'=>$group_id,'status'=>ACTIVE,'max_rank'=>$rank);
$users = $this->getUsers($options);
foreach($users as $one_user) {
// Fake loop to access first element.
return true;
}
+
+ // isSubgroupValid determines if a subgroup is valid for user.
+ // A subgroup is valid if:
+ // - user can manage_subgroups;
+ // - subgroup is either a direct child of user group, or "on the path"
+ // to it (grand-child, etc.).
+ function isSubgroupValid($subgroup_id) {
+ if (!$this->can('manage_subgroups')) return false; // User cannot manage subgroups.
+
+ $current_group_id = $subgroup_id;
+ while ($parent_group_id = ttGroupHelper::getParentGroup($current_group_id)) {
+ if ($parent_group_id == $this->group_id) {
+ return true; // Found it.
+ }
+ $current_group_id = $parent_group_id;
+ }
+ return false;
+ }
+
+ // getMaxRankForGroup determines effective user rank for a user in a given group.
+ // For home group it is the existing user rank (as per role) minus 1.
+ // For subgroups, if user can "manage_subgroups", it is MAX_RANK.
+ function getMaxRankForGroup($group_id) {
+
+ $max_rank = 0; // Start safely.
+ if ($this->group_id == $group_id) {
+ $max_rank = $this->rank - 1;
+ return $max_rank;
+ }
+
+ if ($this->isSubgroupValid($group_id))
+ $max_rank = MAX_RANK;
+
+ return $max_rank;
+ }
}