]> wagnertech.de Git - timetracker.git/blobdiff - WEB-INF/lib/ttAdmin.class.php
Refactored admin_group_editp.php.
[timetracker.git] / WEB-INF / lib / ttAdmin.class.php
index 50bffb6fbc30675038ff04fb729762fc1c602a0a..6a16034e3bd8d5265d551f405844267b168bf024 100644 (file)
@@ -41,7 +41,17 @@ class ttAdmin {
 
   // 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.
@@ -105,76 +115,71 @@ class ttAdmin {
     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($group_id);
+    $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);
-
-    // Iterate through group users and mark them as deleted.
-    foreach ($users as $one_user) {
-      if (!$this->markUserDeleted($one_user['id']))
-          return false;
+    // Now do actual work with all entities.
+
+    // 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();
-
-    // Mark roles deleted.
-    $sql = "update tt_roles set status = NULL where group_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 group_id = $group_id";
-    $affected = $mdb2->exec($sql);
-    if (is_a($affected, 'PEAR_Error')) return false;
-
-    // Mark clients deleted.
-    $sql = "update tt_clients set status = NULL where group_id = $group_id";
-    $affected = $mdb2->exec($sql);
-    if (is_a($affected, 'PEAR_Error')) return false;
-
-    // Mark invoices deleted.
-    $sql = "update tt_invoices set status = NULL where group_id = $group_id";
-    $affected = $mdb2->exec($sql);
-    if (is_a($affected, 'PEAR_Error')) return false;
-
-    // Mark custom fields deleted.
-    $sql = "update tt_custom_fields set status = NULL where group_id = $group_id";
-    $affected = $mdb2->exec($sql);
-    if (is_a($affected, 'PEAR_Error')) return false;
-
-    // Mark notifications deleted.
-    $sql = "update tt_cron set status = NULL where group_id = $group_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.
+    // 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 deleted by user.
+    // as we'll lose track of what was accidentally deleted by user.
     //
-    // 2) DB maintenance script (Clean up DB from inactive teams) should
+    // 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 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";
+    $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;
 
@@ -188,7 +193,7 @@ class ttAdmin {
 
     $result = true;
 
-    if (!ttValidString($fields['group_name'], true)) {
+    if (!ttValidString($fields['new_group_name'])) {
       $this->err->add($i18n->get('error.field'), $i18n->get('label.group_name'));
       $result = false;
     }
@@ -231,17 +236,18 @@ class ttAdmin {
     return $result;
   }
 
-  // updateGroup validates user input and updates the group with new information.
-  function updateGroup($group_id, $fields) {
-    if (!$this->validateGroupInfo($fields)) return false; // Can't continue as user input is invalid.
+  // 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.
 
-    global $user;
     $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']);
-      $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($user->id);
       $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;
@@ -254,7 +260,6 @@ class ttAdmin {
       $password_part = ', password = md5('.$mdb2->quote($fields['password1']).')';
     $name_part = ', name = '.$mdb2->quote($fields['user_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_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;
@@ -334,7 +339,7 @@ class ttAdmin {
   }
 
   // getGroupDetails obtains group name and its top manager details.
-  function getGroupDetails($group_id) {
+  static function getGroupDetails($group_id) {
     $result = array();
     $mdb2 = getConnection();
 
@@ -352,4 +357,30 @@ class ttAdmin {
 
     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'));
+  }
 }