X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=WEB-INF%2Flib%2FttUser.class.php;h=a40a5fda1eedc4a8ef41e9ba17ae16333460dde4;hb=040c6516659e15f360159859b783e3722e86f370;hp=60f4f984b40c5f61a374e2ca35f4a7ab13dd8c2c;hpb=91f127aa192430faa62c59530f42ee5d82b9f7e3;p=timetracker.git diff --git a/WEB-INF/lib/ttUser.class.php b/WEB-INF/lib/ttUser.class.php index 60f4f984..a40a5fda 100644 --- a/WEB-INF/lib/ttUser.class.php +++ b/WEB-INF/lib/ttUser.class.php @@ -28,7 +28,10 @@ import('ttConfigHelper'); import('ttGroupHelper'); +import('ttBehalfUser'); import('ttGroup'); +import('form.Form'); +import('form.ActionForm'); class ttUser { var $login = null; // User login. @@ -40,6 +43,7 @@ class ttUser { var $role_name = null; // Role name. var $rank = null; // User role rank. var $client_id = null; // Client id for client user role. + var $quota_percent = 100.0; // Time quota percent for quotas plugin. 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. @@ -59,22 +63,24 @@ 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. var $currency = null; // Currency. var $plugins = null; // Comma-separated list of enabled plugins. + + // Refactoring ongoing. Towards using helper instead of config string? var $config = null; // Comma-separated list of miscellaneous config options. + var $configHelper = null; // An instance of ttConfigHelper class. + var $custom_logo = 0; // Whether to use a custom logo for group. var $lock_spec = null; // Cron specification for record locking. + var $holidays = null; // Holidays specification. 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. + var $behalfUser = null; // A ttBehalfUser instance with on behalf user attributes. var $behalfGroup = null; // A ttGroup instance with on behalf group attributes. // Constructor. @@ -86,11 +92,11 @@ class ttUser { $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.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 "; + $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.quota_percent, 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.holidays, 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 @@ -112,9 +118,10 @@ class ttUser { $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); + if ($val['quota_percent']) $this->quota_percent = $val['quota_percent']; $this->email = $val['email']; $this->lang = $val['lang']; $this->decimal_mark = $val['decimal_mark']; @@ -132,29 +139,26 @@ class ttUser { $this->currency = $val['currency']; $this->plugins = $val['plugins']; $this->lock_spec = $val['lock_spec']; + $this->holidays = $val['holidays']; $this->workday_minutes = $val['workday_minutes']; $this->custom_logo = $val['custom_logo']; + // TODO: refactor this. $this->config = $val['config']; - $config = new ttConfigHelper($this->config); + $this->configHelper = new ttConfigHelper($val['config']); + // Set user config options. - $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'); - } + $this->show_holidays = $this->configHelper->getDefinedValue('show_holidays'); + $this->punch_mode = $this->configHelper->getDefinedValue('punch_mode'); + $this->allow_overlap = $this->configHelper->getDefinedValue('allow_overlap'); + $this->future_entries = $this->configHelper->getDefinedValue('future_entries'); // 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->behalfUser = new ttBehalfUser($this->behalf_id, $this->org_id); } // Set "on behalf" id and name (group). if (isset($_SESSION['behalf_group_id'])) { @@ -166,9 +170,19 @@ class ttUser { } } - // The getUser returns user id on behalf of whom the current user is operating. + // getUser returns user id on behalf of whom the current user is operating. function getUser() { - return ($this->behalf_id ? $this->behalf_id : $this->id); + return ($this->behalfUser ? $this->behalfUser->id : $this->id); + } + + // getName returns user name on behalf of whom the current user is operating. + function getName() { + return ($this->behalfUser ? $this->behalfUser->name : $this->name); + } + + // getQuotaPercent returns quota percent for active user. + function getQuotaPercent() { + return ($this->behalfUser ? $this->behalfUser->quota_percent : $this->quota_percent); } // The getGroup returns group id on behalf of which the current user is operating. @@ -181,6 +195,21 @@ class ttUser { 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); + } + + // getWeekStart returns week start day for active group. + function getWeekStart() { + return ($this->behalfGroup ? $this->behalfGroup->week_start : $this->week_start); + } + // getTrackingMode returns tracking mode for active group. function getTrackingMode() { return ($this->behalfGroup ? $this->behalfGroup->tracking_mode : $this->tracking_mode); @@ -191,14 +220,34 @@ class ttUser { 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); + } + + // getHolidays returns holidays specification for active group. + function getHolidays() { + return ($this->behalfGroup ? $this->behalfGroup->holidays : $this->holidays); + } + + // 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); + return ($this->behalfGroup ? $this->behalfGroup->configHelper->getConfig() : $this->configHelper->getConfig()); } // getConfigOption returns true if an option is defined for group. @@ -210,6 +259,12 @@ class ttUser { return $config->getDefinedValue($name); } + // getConfigInt retruns an integer value defined in a group, or false. + function getConfigInt($name, $defaultVal) { + $config = new ttConfigHelper($this->getConfig()); + return $config->getIntValue($name, $defaultVal); + } + // can - determines whether user has a right to do something. function can($do_something) { return in_array($do_something, $this->rights); @@ -226,17 +281,40 @@ class ttUser { return in_array($plugin, explode(',', $this->getPlugins())); } + // isOptionEnabled checks whether a config option is enabled for user. + function isOptionEnabled($option) + { + return $this->behalfGroup ? $this->behalfGroup->configHelper->getDefinedValue($option) : $this->configHelper->getDefinedValue($option); + } + + // setOption sets an option inside of ttConfigHelper instance. + // Note that it does not write to the database. + function setOption($option, $enable = true) + { + return $this->behalfGroup ? $this->behalfGroup->configHelper->setDefinedValue($option, $enable) : $this->configHelper->setDefinedValue($option, $enable); + } + // getAssignedProjects - returns an array of assigned projects. - function getAssignedProjects() + function getAssignedProjects($includeFiles = false) { $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; + + if ($includeFiles) { + $filePart = ', if(Sub1.entity_id is null, 0, 1) as has_files'; + $fileJoin = " left join (select distinct entity_id from tt_files". + " where entity_type = 'project' and group_id = $group_id and org_id = $org_id and status = 1) Sub1". + " on (p.id = Sub1.entity_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->getUser()." 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 $filePart from tt_projects p $fileJoin". + " 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()) { @@ -266,8 +344,11 @@ class ttUser { $mdb2 = getConnection(); $tasks = implode(',', $task_ids); // This is a comma-separated list of task ids. + $group_id = $this->getGroup(); + $org_id = $this->org_id; + $sql = "select id, name, description from tt_tasks". - " where group_id = $this->group_id and status = 1 and id in ($tasks) order by name"; + " where group_id = $group_id and org_id = $org_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()) { @@ -290,9 +371,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()) { @@ -310,7 +394,7 @@ class ttUser { 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')) @@ -323,7 +407,7 @@ class ttUser { 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; @@ -354,7 +438,16 @@ class ttUser { $includeSelf = isset($options['include_self']); $select_part = 'select u.id, u.group_id, u.name'; - if (isset($options['include_login'])) $select_part .= ', u.login'; + if (isset($options['include_login'])) { + $select_part .= ', u.login'; + // Piggy-back on include_login to see if we must also include quota_percent. + $include_quota = $this->isPluginEnabled('mq'); + if ($include_quota) { + $decimal_mark = $this->getDecimalMark(); + $replaceDecimalMark = ('.' != $decimal_mark); + $select_part .= ', u.quota_percent'; + } + } if (!isset($options['include_clients'])) $select_part .= ', r.rights'; if (isset($options['include_role'])) $select_part .= ', r.name as role_name, r.rank'; @@ -362,7 +455,7 @@ class ttUser { $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)'; + $left_joins .= ' left join tt_roles r on (u.role_id = r.id)'; $where_part = " where u.org_id = $org_id and u.group_id = $group_id"; if (isset($options['status'])) @@ -389,6 +482,14 @@ class ttUser { if ($isClient) continue; // Skip adding clients. } + if ($include_quota) { + $quota = $val['quota_percent']; + if (ttEndsWith($quota, '.00')) + $quota = substr($quota, 0, strlen($quota)-3); // Trim trailing ".00"; + elseif ($replaceDecimalMark) + $quota = str_replace('.', $decimal_mark, $quota); + $val['quota_percent'] = $quota.'%'; + } $user_list[] = $val; } @@ -412,21 +513,6 @@ class ttUser { // - 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(); @@ -501,7 +587,7 @@ class ttUser { // 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". + $sql = "select u.id, u.name, u.login, u.role_id, u.client_id, u.status, u.rate, u.quota_percent, 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 < $max_rank or (r.rank = $max_rank and u.id = $this->id))"; // Users with lesser roles or self. @@ -519,7 +605,7 @@ class ttUser { // - 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); @@ -529,12 +615,12 @@ class ttUser { } } else { // Checking user from a subgroup. - $group_id = $this->behalf_group_id; + $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); + $options = array('status'=>ACTIVE,'max_rank'=>MAX_RANK); $users = $this->getUsers($options); foreach($users as $one_user) { if ($one_user['id'] == $this->behalf_id) @@ -552,11 +638,10 @@ class ttUser { // 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. @@ -571,15 +656,10 @@ class ttUser { // 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->getGroup(); if (isset($fields['name'])) $name_part = ', name = '.$mdb2->quote($fields['name']); @@ -601,12 +681,13 @@ class ttUser { if (isset($fields['plugins'])) $plugins_part = ', plugins = '.$mdb2->quote($fields['plugins']); if (isset($fields['config'])) $config_part = ', config = '.$mdb2->quote($fields['config']); if (isset($fields['lock_spec'])) $lock_spec_part = ', lock_spec = '.$mdb2->quote($fields['lock_spec']); + if (isset($fields['holidays'])) $holidays_part = ', holidays = '.$mdb2->quote($fields['holidays']); 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.$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, ','); + $bcc_email_part.$allow_ip_part.$plugins_part.$config_part.$lock_spec_part.$holidays_part.$workday_minutes_part.$modified_part, ','); $sql = "update tt_groups set $parts where id = $group_id and org_id = $this->org_id"; $affected = $mdb2->exec($sql); @@ -643,7 +724,8 @@ class ttUser { return false; // Mark user as deleted. - $sql = "update tt_users set status = NULL where id = $user_id". + $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($this->id); + $sql = "update tt_users set status = null $modified_part where id = $user_id". " and group_id = $group_id and org_id = $org_id"; $affected = $mdb2->exec($sql); if (is_a($affected, 'PEAR_Error')) @@ -742,7 +824,7 @@ class ttUser { $user_part .= ' '.$i18n->get('label.on_behalf').' '.htmlspecialchars($this->behalf_name).''; } if ($this->behalf_group_id) { - $user_part .= ', '.$i18n->get('label.on_behalf').' '.htmlspecialchars($this->behalf_group_name).''; + $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; @@ -764,6 +846,13 @@ class ttUser { 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; @@ -782,17 +871,18 @@ class ttUser { $this->behalfGroup = new ttGroup($this->behalf_group_id, $this->org_id); - // Adjust on behalf user. + // Adjust on behalf user to first found user in subgroup. $this->adjustBehalfId(); return; } - // setOnBehalfUser sets on behalf user both the object and the session. + // 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($this->behalfUser); unset($_SESSION['behalf_id']); unset($_SESSION['behalf_name']); @@ -808,6 +898,21 @@ class ttUser { $_SESSION['behalf_name'] = $onBehalfUserName; $this->behalf_id = $user_id; $this->behalf_name = $onBehalfUserName; + + $this->behalfUser = new ttBehalfUser($this->behalf_id, $this->org_id); 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; + } }