// | https://www.anuko.com/time_tracker/credits.htm
// +----------------------------------------------------------------------+
+import('ttUser');
+
// ttAdmin class is used to perform admin tasks.
class ttAdmin {
+ var $err = null; // Error object, passed to us as reference.
+ // We use it to communicate errors to caller.
+
// Constructor.
- function __construct() {
+ function __construct(&$err = null) {
+ $this->err = $err;
}
// getSubgroups rerurns an array of subgroups for a group.
function getSubgroups($group_id) {
- return array(); // TODO: not yet implemented.
+ $mdb2 = getConnection();
+
+ $subgroups = array();
+ $sql = "select id from tt_groups where parent_id = $group_id";
+ $res = $mdb2->query($sql);
+ if (!is_a($res, 'PEAR_Error')) {
+ while ($val = $res->fetchRow()) {
+ $subgroups[] = $val;
+ }
+ }
+ return $subgroups;
}
// getUsers obtains user ids in a group.
function getUsers($group_id) {
$mdb2 = getConnection();
- $sql = "select id from tt_users where team_id = $group_id";
+ $sql = "select id from tt_users where group_id = $group_id";
$res = $mdb2->query($sql);
$users = array();
if (!is_a($res, 'PEAR_Error')) {
// Mark user binds as deleted.
$sql = "update tt_user_project_binds set status = NULL where user_id = $user_id";
$affected = $mdb2->exec($sql);
- if (is_a($affected, 'PEAR_Error'))
- return false;
+ if (is_a($affected, 'PEAR_Error')) return false;
// Mark favorite reports as deleted.
$sql = "update tt_fav_reports set status = NULL where user_id = $user_id";
$affected = $mdb2->exec($sql);
- if (is_a($affected, 'PEAR_Error'))
- return false;
+ if (is_a($affected, 'PEAR_Error')) return false;
// Mark user as deleted.
global $user;
$modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($user->id);
$sql = "update tt_users set status = NULL $modified_part where id = $user_id";
$affected = $mdb2->exec($sql);
- if (is_a($affected, 'PEAR_Error'))
- return false;
+ if (is_a($affected, 'PEAR_Error')) return false;
return true;
}
// The markTasksDeleted deletes task binds and marks the tasks as deleted for a group.
function markTasksDeleted($group_id) {
$mdb2 = getConnection();
- $sql = "select id from tt_tasks where team_id = $group_id";
+ $sql = "select id from tt_tasks where group_id = $group_id";
$res = $mdb2->query($sql);
if (is_a($res, 'PEAR_Error')) return false;
$affected = $mdb2->exec($sql);
if (is_a($affected, 'PEAR_Error')) return false;
}
+
return true;
}
- // markGroupDeleted marks the group and everything in it as deleted.
- function markGroupDeleted($group_id) {
+ // markGroupDeleted marks a group and everything in it as deleted.
+ // This function is called in context of a logged on admin who may
+ // operate on any group.
+ static function markGroupDeleted($group_id) {
+ $mdb2 = getConnection();
// Keep the logic simple by returning false on first error.
// Obtain subgroups and call self recursively on them.
- $subgroups = $this->getSubgroups();
+ $subgroups = ttAdmin::getSubgroups($group_id);
foreach($subgroups as $subgroup) {
- if (!$this->markGroupDeleted($subgroup['id']))
+ if (!ttAdmin::markGroupDeleted($subgroup['id']))
return false;
}
- // Now that we are done with subgroups, handle this group.
- $users = $this->getUsers($group_id);
+ // Now do actual work with all entities.
- // Iterate through team users and mark them as deleted.
- foreach ($users as $one_user) {
- if (!$this->markUserDeleted($one_user['id']))
- return false;
+ // Some things cannot be marked deleted as we don't have the status field for them.
+ // Just delete such things (until we have a better way to deal with them).
+ $tables_to_delete_from = array(
+ 'tt_config',
+ 'tt_predefined_expenses',
+ 'tt_client_project_binds',
+ 'tt_project_task_binds'
+ );
+ foreach($tables_to_delete_from as $table) {
+ if (!ttAdmin::deleteGroupEntriesFromTable($group_id, $table))
+ return false;
}
- // Mark tasks deleted.
- if (!$this->markTasksDeleted($group_id)) return false;
-
- $mdb2 = getConnection();
+ // Now mark status deleted where we can.
+ // Note: we don't mark tt_log, tt_custom_field_lod, or tt_expense_items deleted here.
+ // Reasoning is:
+ //
+ // 1) Users may mark some of them deleted during their work.
+ // If we mark all of them deleted here, we can't recover nicely
+ // as we'll lose track of what was accidentally deleted by user.
+ //
+ // 2) DB maintenance script (Clean up DB from inactive groups) should
+ // get rid of these items permanently eventually.
+ $tables_to_mark_deleted_in = array(
+ 'tt_cron',
+ 'tt_fav_reports',
+ // 'tt_expense_items',
+ // 'tt_custom_field_log',
+ 'tt_custom_field_options',
+ 'tt_custom_fields',
+ // 'tt_log',
+ 'tt_invoices',
+ 'tt_user_project_binds',
+ 'tt_users',
+ 'tt_clients',
+ 'tt_projects',
+ 'tt_tasks',
+ 'tt_roles'
+ );
+ foreach($tables_to_mark_deleted_in as $table) {
+ if (!ttAdmin::markGroupDeletedInTable($group_id, $table))
+ return false;
+ }
- // Mark roles deleted.
- $sql = "update tt_roles set status = NULL where team_id = $group_id";
+ // Mark group deleted.
+ global $user;
+ $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($user->id);
+ $sql = "update tt_groups set status = null $modified_part where id = $group_id";
$affected = $mdb2->exec($sql);
if (is_a($affected, 'PEAR_Error')) return false;
- // Mark projects deleted.
- $sql = "update tt_projects set status = NULL where team_id = $group_id";
- $affected = $mdb2->exec($sql);
- if (is_a($affected, 'PEAR_Error')) return false;
+ return true;
+ }
- // Mark clients deleted.
- $sql = "update tt_clients set status = NULL where team_id = $group_id";
- $affected = $mdb2->exec($sql);
- if (is_a($affected, 'PEAR_Error')) return false;
+ // validateGroupInfo validates group information entered by user.
+ function validateGroupInfo($fields) {
+ global $i18n;
+ global $auth;
- // Mark invoices deleted.
- $sql = "update tt_invoices set status = NULL where team_id = $group_id";
- $affected = $mdb2->exec($sql);
- if (is_a($affected, 'PEAR_Error')) return false;
+ $result = true;
- // Mark custom fields deleted.
- $sql = "update tt_custom_fields set status = NULL where team_id = $group_id";
- $affected = $mdb2->exec($sql);
- if (is_a($affected, 'PEAR_Error')) return false;
+ if (!ttValidString($fields['new_group_name'])) {
+ $this->err->add($i18n->get('error.field'), $i18n->get('label.group_name'));
+ $result = false;
+ }
+ if (!ttValidString($fields['user_name'])) {
+ $this->err->add($i18n->get('error.field'), $i18n->get('label.manager_name'));
+ $result = false;
+ }
+ if (!ttValidString($fields['new_login'])) {
+ $this->err->add($i18n->get('error.field'), $i18n->get('label.manager_login'));
+ $result = false;
+ }
- // Mark notifications deleted.
- $sql = "update tt_cron set status = NULL where team_id = $group_id";
+ // If we change login, it must be unique.
+ if ($fields['new_login'] != $fields['old_login']) {
+ if (ttUserHelper::getUserByLogin($fields['new_login'])) {
+ $this->err->add($i18n->get('error.user_exists'));
+ $result = false;
+ }
+ }
+
+ if (!$auth->isPasswordExternal() && ($fields['password1'] || $fields['password2'])) {
+ if (!ttValidString($fields['password1'])) {
+ $this->err->add($i18n->get('error.field'), $i18n->get('label.password'));
+ $result = false;
+ }
+ if (!ttValidString($fields['password2'])) {
+ $this->err->add($i18n->get('error.field'), $i18n->get('label.confirm_password'));
+ $result = false;
+ }
+ if ($fields['password1'] !== $fields['password2']) {
+ $this->err->add($i18n->get('error.not_equal'), $i18n->get('label.password'), $i18n->get('label.confirm_password'));
+ $result = false;
+ }
+ }
+ if (!ttValidEmail($fields['email'], true)) {
+ $this->err->add($i18n->get('error.field'), $i18n->get('label.email'));
+ $result = false;
+ }
+
+ return $result;
+ }
+
+ // updateGroup updates a (top) group with new information.
+ static function updateGroup($fields) {
+ $group_id = (int)$fields['group_id'];
+ if (!$group_id) return false; // Nothing to update.
+
+ $mdb2 = getConnection();
+ global $user;
+ $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($user->id);
+
+ // Update group name if it changed.
+ if ($fields['old_group_name'] != $fields['new_group_name']) {
+ $name_part = 'name = '.$mdb2->quote($fields['new_group_name']);
+ $sql = 'update tt_groups set '.$name_part.$modified_part.' where id = '.$group_id;
+ $affected = $mdb2->exec($sql);
+ if (is_a($affected, 'PEAR_Error')) return false;
+ }
+
+ // Update group manager.
+ $user_id = $fields['user_id'];
+ $login_part = 'login = '.$mdb2->quote($fields['new_login']);
+ if ($fields['password1'])
+ $password_part = ', password = md5('.$mdb2->quote($fields['password1']).')';
+ $name_part = ', name = '.$mdb2->quote($fields['user_name']);
+ $email_part = ', email = '.$mdb2->quote($fields['email']);
+ $sql = 'update tt_users set '.$login_part.$password_part.$name_part.$email_part.$modified_part.'where id = '.$user_id;
$affected = $mdb2->exec($sql);
if (is_a($affected, 'PEAR_Error')) return false;
- // Note: we don't mark tt_log or tt_expense_items deleted here.
- // Reasoning is:
- //
- // 1) Users may mark some of them deleted during their work.
- // If we mark all of them deleted here, we can't recover nicely
- // as we'll lose track of what was deleted by user.
- //
- // 2) DB maintenance script (Clean up DB from inactive teams) should
- // get rid of these items permanently eventually.
+ return true;
+ }
- // Mark group deleted.
+ // validateUserInfo validates account information entered by user.
+ function validateUserInfo($fields) {
+ global $i18n;
global $user;
+ global $auth;
+
+ $result = true;
+
+ if (!ttValidString($fields['name'])) {
+ $this->err->add($i18n->get('error.field'), $i18n->get('label.person_name'));
+ $result = false;
+ }
+ if (!ttValidString($fields['login'])) {
+ $this->err->add($i18n->get('error.field'), $i18n->get('label.login'));
+ $result = false;
+ }
+ // If we change login, it must be unique.
+ if ($fields['login'] != $user->login) {
+ if (ttUserHelper::getUserByLogin($fields['login'])) {
+ $this->err->add($i18n->get('error.user_exists'));
+ $result = false;
+ }
+ }
+ if (!$auth->isPasswordExternal() && ($fields['password1'] || $fields['password2'])) {
+ if (!ttValidString($fields['password1'])) {
+ $this->err->add($i18n->get('error.field'), $i18n->get('label.password'));
+ $result = false;
+ }
+ if (!ttValidString($fields['password2'])) {
+ $this->err->add($i18n->get('error.field'), $i18n->get('label.confirm_password'));
+ $result = false;
+ }
+ if ($fields['password1'] !== $fields['password2']) {
+ $this->err->add($i18n->get('error.not_equal'), $i18n->get('label.password'), $i18n->get('label.confirm_password'));
+ $result = false;
+ }
+ }
+ if (!ttValidEmail($fields['email'], true)) {
+ $this->err->add($i18n->get('error.field'), $i18n->get('label.email'));
+ $result = false;
+ }
+
+ return $result;
+ }
+
+ // updateSelf validates user input and updates admin account with new information.
+ function updateSelf($fields) {
+ if (!$this->validateUserInfo($fields)) return false; // Can't continue as user input is invalid.
+
+ global $user;
+ global $i18n;
+ $mdb2 = getConnection();
+
+ // Update self.
+ $user_id = $user->id;
+ $login_part = 'login = '.$mdb2->quote($fields['login']);
+ if ($fields['password1'])
+ $password_part = ', password = md5('.$mdb2->quote($fields['password1']).')';
+ $name_part = ', name = '.$mdb2->quote($fields['name']);
+ $email_part = ', email = '.$mdb2->quote($fields['email']);
$modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($user->id);
- $sql = "update tt_teams set status = NULL $modified_part where id = $group_id";
+ $sql = 'update tt_users set '.$login_part.$password_part.$name_part.$email_part.$modified_part.'where id = '.$user_id;
$affected = $mdb2->exec($sql);
- if (is_a($affected, 'PEAR_Error')) return false;
+ if (is_a($affected, 'PEAR_Error')) {
+ $this->err->add($i18n->get('error.db'));
+ return false;
+ }
return true;
}
+
+ // getGroupDetails obtains group name and its top manager details.
+ static function getGroupDetails($group_id) {
+ $result = array();
+ $mdb2 = getConnection();
+
+ $sql = "select g.name as group_name, u.id as manager_id, u.name as manager_name, u.login as manager_login, u.email as manager_email".
+ " from tt_groups g".
+ " inner join tt_users u on (u.group_id = g.id)".
+ " inner join tt_roles r on (r.id = u.role_id and r.rank = 512)".
+ " where g.id = $group_id";
+
+ $res = $mdb2->query($sql);
+ if (!is_a($res, 'PEAR_Error')) {
+ $val = $res->fetchRow();
+ return $val;
+ }
+
+ return false;
+ }
+
+ // deleteGroupEntriesFromTable is a generic helper function for markGroupDeleted.
+ // It deletes entries in ONE table belonging to a given group.
+ static function deleteGroupEntriesFromTable($group_id, $table_name) {
+ $mdb2 = getConnection();
+
+ $sql = "delete from $table_name where group_id = $group_id";
+ $affected = $mdb2->exec($sql);
+ return (!is_a($affected, 'PEAR_Error'));
+ }
+
+ // markGroupDeletedInTable is a generic helper function for markGroupDeleted.
+ // It updates ONE table by setting status to NULL for all records belonging to a group.
+ static function markGroupDeletedInTable($group_id, $table_name) {
+ $mdb2 = getConnection();
+
+ // Add modified info to sql for some tables, depending on table name.
+ if ($table_name == 'tt_users') {
+ global $user;
+ $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($user->id);
+ }
+
+ $sql = "update $table_name set status = null $modified_part where group_id = $group_id";
+ $affected = $mdb2->exec($sql);
+ return (!is_a($affected, 'PEAR_Error'));
+ }
}
projects / timetracker.git / blobdiff