X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;ds=inline;f=WEB-INF%2Flib%2FttUser.class.php;h=5e359cd213c1dd954f22f35b2f09f06e4fc06925;hb=f5d19e5d5fd205d81367ab2c82d41c154cad50ff;hp=003cf0fe3f738667225d9d35e6435818b5efb8a5;hpb=0bf91be4d6ee52adaf09a74d729c7a34cf012de7;p=timetracker.git
diff --git a/WEB-INF/lib/ttUser.class.php b/WEB-INF/lib/ttUser.class.php
index 003cf0fe..5e359cd2 100644
--- a/WEB-INF/lib/ttUser.class.php
+++ b/WEB-INF/lib/ttUser.class.php
@@ -27,6 +27,8 @@
// +----------------------------------------------------------------------+
import('ttConfigHelper');
+import('ttGroupHelper');
+import('ttGroup');
class ttUser {
var $login = null; // User login.
@@ -57,7 +59,6 @@ class ttUser {
var $punch_mode = 0; // Whether punch mode is enabled for user.
var $allow_overlap = 0; // Whether to allow overlapping time entries.
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 $password_complexity = null; // Password complexity example.
@@ -73,6 +74,8 @@ class ttUser {
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.
+ var $behalfGroup = null; // A ttGroup instance with on behalf group attributes.
+
// Constructor.
function __construct($login, $id = null) {
if (!$login && !$id) {
@@ -138,7 +141,6 @@ class ttUser {
$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;
@@ -149,25 +151,61 @@ class ttUser {
// Set "on behalf" id and name (user).
if (isset($_SESSION['behalf_id'])) {
- $this->behalf_id = $_SESSION['behalf_id'];
- $this->behalf_name = $_SESSION['behalf_name'];
+ $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'];
+ $this->behalf_group_id = $_SESSION['behalf_group_id'];
+ $this->behalf_group_name = $_SESSION['behalf_group_name'];
+
+ $this->behalfGroup = new ttGroup($this->behalf_group_id, $this->org_id);
}
}
}
- // The getActiveUser returns user id on behalf of whom the current user is operating.
- function getActiveUser() {
+ // The getUser returns user id on behalf of whom the current user is operating.
+ function getUser() {
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);
+ // The getGroup returns group id on behalf of which the current user is operating.
+ function getGroup() {
+ return ($this->behalfGroup ? $this->behalfGroup->id : $this->group_id);
+ }
+
+ // getDecimalMark returns decimal mark for active group.
+ function getDecimalMark() {
+ return ($this->behalfGroup ? $this->behalfGroup->decimal_mark : $this->decimal_mark);
+ }
+
+ // getTrackingMode returns tracking mode for active group.
+ function getTrackingMode() {
+ return ($this->behalfGroup ? $this->behalfGroup->tracking_mode : $this->tracking_mode);
+ }
+
+ // getRecordType returns record type for active group.
+ function getRecordType() {
+ return ($this->behalfGroup ? $this->behalfGroup->record_type : $this->record_type);
+ }
+
+ // getPlugins returns plugins string for active group.
+ function getPlugins() {
+ return ($this->behalfGroup ? $this->behalfGroup->plugins : $this->plugins);
+ }
+
+ // getConfig returns config string for active group.
+ function getConfig() {
+ return ($this->behalfGroup ? $this->behalfGroup->config : $this->config);
+ }
+
+ // getConfigOption returns true if an option is defined for group.
+ // This helps us keeping a set of user attributes smaller.
+ // We determine whether the option is set only on pages that need to know.
+ // For example: confirm_save is used only on time and expense edit pages.
+ function getConfigOption($name) {
+ $config = new ttConfigHelper($this->getConfig());
+ return $config->getDefinedValue($name);
}
// can - determines whether user has a right to do something.
@@ -183,7 +221,7 @@ class ttUser {
// isPluginEnabled checks whether a plugin is enabled for user.
function isPluginEnabled($plugin)
{
- return in_array($plugin, explode(',', $this->plugins));
+ return in_array($plugin, explode(',', $this->getPlugins()));
}
// getAssignedProjects - returns an array of assigned projects.
@@ -192,10 +230,14 @@ class ttUser {
$result = array();
$mdb2 = getConnection();
+ $group_id = $this->getGroup();
+ $org_id = $this->org_id;
+ $user_id = $this->getUser();
+
// 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";
+ $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 = $user_id and upb.project_id = p.id and upb.status = 1)".
+ " where p.group_id = $group_id and p.org_id = $org_id and p.status = 1 order by p.name";
$res = $mdb2->query($sql);
if (!is_a($res, 'PEAR_Error')) {
while ($val = $res->fetchRow()) {
@@ -249,9 +291,12 @@ class ttUser {
$mdb2 = getConnection();
+ $group_id = $this->getGroup();
+ $org_id = $this->org_id;
+
// 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";
+ $sql = "select id, name, address, projects from tt_clients where group_id = $group_id and org_id = $org_id and status = 1";
$res = $mdb2->query($sql);
if (!is_a($res, 'PEAR_Error')) {
while ($val = $res->fetchRow()) {
@@ -304,14 +349,15 @@ class ttUser {
// getUsers obtains users in a group, as specififed by options.
function getUsers($options) {
-
$mdb2 = getConnection();
+ $group_id = $this->getGroup();
+ $org_id = $this->org_id;
+
$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';
+ $select_part = 'select u.id, u.group_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';
@@ -322,7 +368,7 @@ class ttUser {
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.org_id = $this->org_id and u.group_id = $group_id";
+ $where_part = " where u.org_id = $org_id and u.group_id = $group_id";
if (isset($options['status']))
$where_part .= ' and u.status = '.(int)$options['status'];
else
@@ -364,62 +410,105 @@ class ttUser {
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() {
+ // getGroupsForDropdown obtains an array of groups to populate "Group" dropdown.
+ // It consists of:
+ // - User home group.
+ // - The entire stack of groups all the way down to current on behalf group.
+ // - All immediate children of the current on behalf group.
+ // This allows user to navigate easily to home group, anything in between, and 1 level below.
+ //
+ // Note 1: group dropdown is, by design, to be placed on all pages where "relevant",
+ // such as users.php, projects.php, tasks.php, etc. But some features may be disabled
+ // in some groups. We should check for feature availability on group change
+ // in post and redirect to feature_disabled.php when this happens.
+ // This will allow us to keep dropdown content consistent on all pages.
+ // Filtering content of the dropdown does not seem right.
+ //
+ // Note 2: Menu should display according to $user home group settings.
+ // Pages, should look according to $user->behalfGroup settings (if set).
+ // For example, if home group allows tasks, menu should display Tasks,
+ // even when we are on behalf of a subgroup without tasks.
+ //
+ // Note 3: Language of all pages should be as in $user home group even when
+ // subgroups have a different language.
+ function getGroupsForDropdown() {
$mdb2 = getConnection();
+ // Start with subgroups.
+ $groups = array();
+ $group_id = $this->getGroup();
+ $sql = "select id, name from tt_groups where org_id = $this->org_id and parent_id = $group_id and status = 1";
+ $res = $mdb2->query($sql);
+ if (!is_a($res, 'PEAR_Error')) {
+ while ($val = $res->fetchRow()) {
+ $groups[] = $val;
+ }
+ }
+
+ // Add current on behalf group to the beginning of array.
$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);
+ array_unshift($groups, array('id'=>$selected_group_id,'name'=>$selected_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";
+ // Iterate all the way to the home group, starting with selected ("on behalf") group.
+ $current_group_id = $selected_group_id;
+ while ($current_group_id != $this->group_id) {
+ $sql = "select parent_id from tt_groups where org_id = $this->org_id and id = $current_group_id and status = 1";
$res = $mdb2->query($sql);
- if (!is_a($res, 'PEAR_Error')) {
+ if (is_a($res, 'PEAR_Error')) return false;
+
+ $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 and status = 1";
+ $res = $mdb2->query($sql);
+ if (is_a($res, 'PEAR_Error')) return false;
$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']);
- }
- }
+ if (!$val) return false;
+ array_unshift($groups, array('id'=>$parent_id,'name'=>$val['name']));
+ $current_group_id = $parent_id;
+ } else {
+ return false;
}
}
+ return $groups;
+ }
+
+ // getSubgroups obtains a list of immediate subgroups.
+ function getSubgroups($group_id = null) {
+ $mdb2 = getConnection();
- // Add current group.
- $groups[] = array('id'=>$selected_group_id,'name'=>$selected_group_name);
+ if (!$group_id) $group_id = $this->getGroup();
- // Add subgroups.
- $sql = "select id, name from tt_groups where org_id = $this->org_id and parent_id = $selected_group_id";
+ $sql = "select id, name, description from tt_groups where org_id = $this->org_id".
+ " and parent_id = $group_id and status is not null order by upper(name)";
$res = $mdb2->query($sql);
if (!is_a($res, 'PEAR_Error')) {
while ($val = $res->fetchRow()) {
- $groups[] = array('id'=>$val['id'],'name'=>$val['name']);
+ $groups[] = $val;
}
}
return $groups;
}
- // getUser function is used to manage users in group and returns user details.
+ // getUserDetails 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) {
+ function getUserDetails($user_id) {
if (!$this->can('manage_users')) return false;
$mdb2 = getConnection();
+ $group_id = $this->getGroup();
+ $org_id = $this->org_id;
+
+ // Determine max rank. If we are searching in on behalf group
+ // then rank restriction does not apply.
+ $max_rank = $this->behalfGroup ? MAX_RANK : $this->rank;
$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.
+ " left join tt_roles r on (u.role_id = r.id)".
+ " where u.id = $user_id and u.group_id = $group_id and u.org_id = $org_id and u.status is not null".
+ " and (r.rank < $max_rank or (r.rank = $max_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();
@@ -429,13 +518,32 @@ class ttUser {
}
// 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->behalfGroup) {
+ // 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->behalfGroup->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;
}
@@ -446,8 +554,12 @@ class ttUser {
// 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);
+ $rank = $this->getMaxRankForGroup($this->getGroup());
+
+ // Adjust to first found user in group.
+ $options = array('status'=>ACTIVE,'max_rank'=>$rank);
$users = $this->getUsers($options);
foreach($users as $one_user) {
// Fake loop to access first element.
@@ -465,10 +577,16 @@ class ttUser {
if (!($this->can('manage_basic_settings') ||
$this->can('manage_advanced_settings') ||
$this->can('manage_features'))) return false;
+ // TODO: update the above for subgroup updates.
+
+ $group_id = $fields['group_id'];
+ if ($group_id && !$this->isGroupValid($group_id)) return false;
$mdb2 = getConnection();
+ if (!$group_id) $group_id = $this->getGroup();
if (isset($fields['name'])) $name_part = ', name = '.$mdb2->quote($fields['name']);
+ if (isset($fields['description'])) $description_part = ', description = '.$mdb2->quote($fields['description']);
if (isset($fields['currency'])) $currency_part = ', currency = '.$mdb2->quote($fields['currency']);
if (isset($fields['lang'])) $lang_part = ', lang = '.$mdb2->quote($fields['lang']);
if (isset($fields['decimal_mark'])) $decimal_mark_part = ', decimal_mark = '.$mdb2->quote($fields['decimal_mark']);
@@ -489,11 +607,11 @@ class ttUser {
if (isset($fields['workday_minutes'])) $workday_minutes_part = ', workday_minutes = '.$mdb2->quote($fields['workday_minutes']);
$modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($this->id);
- $parts = trim($name_part.$currency_part.$lang_part.$decimal_mark_part.$date_format_part.
+ $parts = trim($name_part.$description_part.$currency_part.$lang_part.$decimal_mark_part.$date_format_part.
$time_format_part.$week_start_part.$tracking_mode_part.$task_required_part.$project_required_part.$record_type_part.
$bcc_email_part.$allow_ip_part.$plugins_part.$config_part.$lock_spec_part.$workday_minutes_part.$modified_part, ',');
- $sql = "update tt_groups set $parts where id = $this->group_id";
+ $sql = "update tt_groups set $parts where id = $group_id and org_id = $this->org_id";
$affected = $mdb2->exec($sql);
if (is_a($affected, 'PEAR_Error')) return false;
@@ -506,25 +624,30 @@ class ttUser {
return false;
// Make sure we operate on a legit user.
- $user_details = $this->getUser($user_id);
+ $user_details = $this->getUserDetails($user_id);
if (!$user_details) return false;
$mdb2 = getConnection();
+ $group_id = $this->getGroup();
+ $org_id = $this->org_id;
// Mark user to project binds as deleted.
- $sql = "update tt_user_project_binds set status = NULL where user_id = $user_id";
+ $sql = "update tt_user_project_binds set status = NULL where user_id = $user_id".
+ " and group_id = $group_id and org_id = $org_id";
$affected = $mdb2->exec($sql);
if (is_a($affected, 'PEAR_Error'))
return false;
// Mark user favorite reports as deleted.
- $sql = "update tt_fav_reports set status = NULL where user_id = $user_id";
+ $sql = "update tt_fav_reports set status = NULL where user_id = $user_id".
+ " and group_id = $group_id and org_id = $org_id";
$affected = $mdb2->exec($sql);
if (is_a($affected, 'PEAR_Error'))
return false;
// Mark user as deleted.
- $sql = "update tt_users set status = NULL where id = $user_id and group_id = ".$this->group_id;
+ $sql = "update tt_users set status = NULL where id = $user_id".
+ " and group_id = $group_id and org_id = $org_id";
$affected = $mdb2->exec($sql);
if (is_a($affected, 'PEAR_Error'))
return false;
@@ -559,4 +682,135 @@ class ttUser {
return true;
}
+
+ // isUserValid determines if a user is valid for on behalf work.
+ function isUserValid($user_id) {
+ if ($user_id == $this->id)
+ return true;
+ return ($this->getUserDetails($user_id) != null);
+ }
+
+ // isGroupValid determines if a group is valid for user.
+ function isGroupValid($group_id) {
+ if ($group_id == $this->group_id)
+ return true;
+ else
+ return $this->isSubgroupValid($group_id);
+ }
+
+ // 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;
+ }
+
+ // getUserPartForHeader constructs a string for user to display on pages header.
+ // It changes with "on behalf" attributes for both user and group.
+ function getUserPartForHeader() {
+ global $i18n;
+ if (!$this->id) return null;
+
+ $user_part = htmlspecialchars($this->name);
+ $user_part .= ' - '.htmlspecialchars($this->role_name);
+ if ($this->behalf_id) {
+ $user_part .= ' '.$i18n->get('label.on_behalf').' '.htmlspecialchars($this->behalf_name).'';
+ }
+ if ($this->behalf_group_id) {
+ $user_part .= ', '.htmlspecialchars($this->behalf_group_name).'';
+ } else {
+ if ($this->group_name) // Note: we did not require group names in the past.
+ $user_part .= ', '.$this->group_name;
+ }
+ return $user_part;
+ }
+
+ // setOnBehalfGroup sets on behalf group for the user in both the object and the session.
+ function setOnBehalfGroup($group_id) {
+
+ // Unset things first.
+ $this->behalf_group_id = null;
+ $this->behalf_group_name = null;
+ $this->behalf_id = null;
+ $this->behalf_name = null;
+ unset($this->behalfGroup);
+ unset($_SESSION['behalf_group_id']);
+ unset($_SESSION['behalf_group_name']);
+ unset($_SESSION['behalf_id']);
+ unset($_SESSION['behalf_name']);
+
+ // Do not do anything if we don't have rights.
+ if (!$this->can('manage_subgroups')) return;
+
+ // No need to set if group is our home group.
+ if ($group_id == $this->group_id) return;
+
+ // No need to set if subgroup is not valid.
+ if (!$this->isSubgroupValid($group_id)) return;
+
+ // We are good to set on behalf group.
+ $onBehalfGroupName = ttGroupHelper::getGroupName($group_id);
+ $_SESSION['behalf_group_id'] = $group_id;
+ $_SESSION['behalf_group_name'] = $onBehalfGroupName;
+ $this->behalf_group_id = $group_id;
+ $this->behalf_group_name = $onBehalfGroupName;
+
+ $this->behalfGroup = new ttGroup($this->behalf_group_id, $this->org_id);
+
+ // Adjust on behalf user to first found user in subgroup.
+ $this->adjustBehalfId();
+ return;
+ }
+
+ // setOnBehalfUser sets on behalf user both the object and the session.
+ function setOnBehalfUser($user_id) {
+
+ // Unset things first.
+ $this->behalf_id = null;
+ $this->behalf_name = null;
+ unset($_SESSION['behalf_id']);
+ unset($_SESSION['behalf_name']);
+
+ // No need to set if user is us.
+ if ($user_id == $this->id) return;
+
+ // No need to set if user id is not valid.
+ if (!$this->isUserValid($user_id)) return;
+
+ // We are good to set on behalf user.
+ $onBehalfUserName = ttUserHelper::getUserName($user_id);
+ $_SESSION['behalf_id'] = $user_id;
+ $_SESSION['behalf_name'] = $onBehalfUserName;
+ $this->behalf_id = $user_id;
+ $this->behalf_name = $onBehalfUserName;
+ return;
+ }
}