import('ttConfigHelper');
import('ttGroupHelper');
+import('ttGroup');
+import('form.Form');
+import('form.ActionForm');
class ttUser {
var $login = null; // User login.
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.
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) {
$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->is_client = $this->client_id && !in_array('track_own_time', $this->rights);
$this->email = $val['email'];
$this->lang = $val['lang'];
$this->decimal_mark = $val['decimal_mark'];
$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;
// 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);
+ }
+
+ // getDateFormat returns date format for active group.
+ function getDateFormat() {
+ return ($this->behalfGroup ? $this->behalfGroup->date_format : $this->date_format);
+ }
+
+ // getTimeFormat returns time format for active group.
+ function getTimeFormat() {
+ return ($this->behalfGroup ? $this->behalfGroup->time_format : $this->time_format);
+ }
+
+ // 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);
+ }
+
+ // getCurrency returns currency string for active group.
+ function getCurrency() {
+ return ($this->behalfGroup ? $this->behalfGroup->currency : $this->currency);
+ }
+
+ // getPlugins returns plugins string for active group.
+ function getPlugins() {
+ return ($this->behalfGroup ? $this->behalfGroup->plugins : $this->plugins);
+ }
+
+ // getLockSpec returns lock specification for active group.
+ function getLockSpec() {
+ return ($this->behalfGroup ? $this->behalfGroup->lock_spec : $this->lock_spec);
+ }
+
+ // getWorkdayMinutes returns workday_minutes for active group.
+ function getWorkdayMinutes() {
+ return ($this->behalfGroup ? $this->behalfGroup->workday_minutes : $this->workday_minutes);
+ }
+
+ // 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.
// 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.
$result = array();
$mdb2 = getConnection();
- $group_id = $this->behalf_group_id ? $this->behalf_group_id : $this->group_id;
+ $user_id = $this->getUser();
+ $group_id = $this->getGroup();
+ $org_id = $this->org_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 = $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()) {
$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()) {
if (!$this->isPluginEnabled('lk'))
return false; // Locking feature is disabled.
- if (!$this->lock_spec)
+ if (!$this->getLockSpec())
return false; // There is no lock specification.
if (!$this->behalf_id && $this->can('override_own_date_lock'))
require_once(LIBRARY_DIR.'/tdcron/class.tdcron.entry.php');
// Calculate the last occurrence of a lock.
- $last = tdCron::getLastOccurrence($this->lock_spec, time());
+ $last = tdCron::getLastOccurrence($this->getLockSpec(), time());
$lockdate = new DateAndTime(DB_DATEFORMAT, strftime('%Y-%m-%d', $last));
if ($date->before($lockdate))
return true;
function getUsers($options) {
$mdb2 = getConnection();
- $group_id = $this->getActiveGroup();
+ $group_id = $this->getGroup();
$org_id = $this->org_id;
$skipClients = !isset($options['include_clients']);
$includeSelf = isset($options['include_self']);
- $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';
// - 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->getActiveGroup();
+ $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')) {
function getSubgroups($group_id = null) {
$mdb2 = getConnection();
- if (!$group_id) $group_id = $this->getActiveGroup();
+ if (!$group_id) $group_id = $this->getGroup();
$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)";
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->getActiveGroup();
+ $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 = $group_id and u.org_id = $org_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.
+ " 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();
// - subgroup must ve valid;
// - user should be a member of it.
function checkBehalfId() {
- if (!$this->behalf_group_id) {
+ if (!$this->behalfGroup) {
// Checking user from home group.
$options = array('status'=>ACTIVE,'max_rank'=>$this->rank-1);
$users = $this->getUsers($options);
}
} else {
// Checking user from a subgroup.
- $group_id = $this->behalf_group_id;
+ $group_id = $this->behalfGroup->id;
if (!$this->isSubgroupValid($group_id))
return false;
// 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() {
- $group_id = $this->behalf_group_id ? $this->behalf_group_id : $this->group_id;
- $rank = $this->getMaxRankForGroup($group_id);
+ $rank = $this->getMaxRankForGroup($this->getGroup());
// Adjust to first found user in group.
- $options = array('group_id'=>$group_id,'status'=>ACTIVE,'max_rank'=>$rank);
+ $options = array('status'=>ACTIVE,'max_rank'=>$rank);
$users = $this->getUsers($options);
foreach($users as $one_user) {
// Fake loop to access first element.
// updateGroup updates group information with new data.
function updateGroup($fields) {
- if (!($this->can('manage_basic_settings') ||
- $this->can('manage_advanced_settings') ||
- $this->can('manage_features'))) return false;
- // TODO: update the above for subgroup updates.
+ $mdb2 = getConnection();
$group_id = $fields['group_id'];
if ($group_id && !$this->isGroupValid($group_id)) return false;
-
- $mdb2 = getConnection();
- if (!$group_id) $group_id = $this->getActiveGroup();
+ 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']);
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->getActiveGroup();
+ $group_id = $this->getGroup();
$org_id = $this->org_id;
// Mark user to project binds as deleted.
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)
$user_part .= ' <span class="onBehalf">'.$i18n->get('label.on_behalf').' '.htmlspecialchars($this->behalf_name).'</span>';
}
if ($this->behalf_group_id) {
- $user_part .= ', <span class="onBehalf">'.$i18n->get('label.on_behalf').' '.htmlspecialchars($this->behalf_group_name).'</span>';
+ $user_part .= ', <span class="onBehalf">'.htmlspecialchars($this->behalf_group_name).'</span>';
} else {
if ($this->group_name) // Note: we did not require group names in the past.
$user_part .= ', '.$this->group_name;
$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']);
+ // Destroy report bean if it was set in session.
+ $form = new Form('dummyForm');
+ $bean = new ActionForm('reportBean', $form, $request);
+ if ($bean->isSaved()) {
+ $bean->destroyBean();
+ }
+
// Do not do anything if we don't have rights.
if (!$this->can('manage_subgroups')) return;
- // No need to set if the group is our home group.
+ // No need to set if group is our home group.
if ($group_id == $this->group_id) return;
- // No need to set if the subgroup is not valid.
+ // No need to set if subgroup is not valid.
if (!$this->isSubgroupValid($group_id)) return;
// We are good to set on behalf group.
$this->behalf_group_id = $group_id;
$this->behalf_group_name = $onBehalfGroupName;
- // Adjust on behalf user.
+ $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;
+ }
+
+ // The exists() function determines if an active user exists in context of a page.
+ // If we are working as self, true.
+ // If we are working in a subgroup with active users, true.
+ // If we are working in a subgroup without active users, false.
+ function exists() {
+ if (!$this->behalfGroup)
+ return true; // Working as self.
+ else if ($this->behalfGroup->active_users)
+ return true; // Subgroup has users.
+
+ return false;
+ }
}