Introduced DEFAULT_PLUGINS config constant.
[timetracker.git] / WEB-INF / lib / ttAdmin.class.php
index d0a1b8d..16ff3b5 100644 (file)
 // | https://www.anuko.com/time_tracker/credits.htm
 // +----------------------------------------------------------------------+
 
-import('ttUser');
 import('ttRoleHelper');
 
 // ttAdmin class is used to perform admin tasks.
+// Used as namespace, as it is a collection of static functions that we call
+// from admin pages to administer the site as a whole.
 class ttAdmin {
 
-  var $err = null; // Error object, passed to us as reference.
-                   // We use it to communicate errors to caller.
-
-  // Constructor.
-  function __construct(&$err = null) {
-    $this->err = $err;
-  }
-
   // getSubgroups rerurns an array of subgroups for a group.
   static function getSubgroups($group_id) {
     $mdb2 = getConnection();
@@ -72,6 +65,9 @@ class ttAdmin {
 
     // Now do actual work with all entities.
 
+    // Delete group files.
+    ttAdmin::deleteGroupFiles($group_id);
+
     // 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(
@@ -118,7 +114,7 @@ class ttAdmin {
 
     // Mark group deleted.
     global $user;
-    $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($user->id);
+    $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$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;
@@ -133,7 +129,7 @@ class ttAdmin {
 
     $mdb2 = getConnection();
     global $user;
-    $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$mdb2->quote($user->id);
+    $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$user->id;
 
     // Update group name if it changed.
     if ($fields['old_group_name'] != $fields['new_group_name']) {
@@ -150,64 +146,16 @@ 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']);
-    $sql = 'update tt_users set '.$login_part.$password_part.$name_part.$email_part.$modified_part.'where id = '.$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;
 
     return true;
   }
 
-  // validateUserInfo validates account information entered by user.
-  function validateUserInfo($fields) {
-    global $i18n;
+  // updateSelf updates admin account with new information.
+  static function updateSelf($fields) {
     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.
@@ -217,15 +165,10 @@ class ttAdmin {
       $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_users set '.$login_part.$password_part.$name_part.$email_part.$modified_part.'where id = '.$user_id;
+    $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$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')) {
-      $this->err->add($i18n->get('error.db'));
-      return false;
-    }
-
-    return true;
+    return (!is_a($affected, 'PEAR_Error'));
   }
 
   // getGroupName obtains group name.
@@ -246,13 +189,21 @@ class ttAdmin {
 
   // getOrgDetails obtains group name and its top manager details.
   static function getOrgDetails($group_id) {
-    $result = array();
     $mdb2 = getConnection();
 
+    // Note: current code works with properly set top manager (rank 512).
+    // However, we now allow export and import of subgroups, which seems to work well.
+    // In this situation, imported role is no longer "Top manager", and this call fails.
+    // Setting role id manually in database for top user to Top manager resolves the issue.
+    //
+    // TODO: assess whether it is safe / reasonable to promote role during export or import.
+    // The problem is that user having 'export_data' right is not necessarily top user.
+    // And if we do it by rank, what to do for multiple managers situation? First found?
+    // Leaving to manual fixing for now.
     $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)".
+      " inner join tt_roles r on (r.id = u.role_id and r.rank = 512)". // Fails for partially imported org. See comment above.
       " where g.id = $group_id";
 
     $res = $mdb2->query($sql);
@@ -264,6 +215,20 @@ class ttAdmin {
     return false;
   }
 
+ // getOrg obtains org_id for group.
+  static function getOrg($group_id) {
+    $mdb2 = getConnection();
+
+    $sql = "select org_id from tt_groups where 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) {
@@ -282,7 +247,7 @@ class ttAdmin {
     // 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);
+      $modified_part = ', modified = now(), modified_ip = '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', modified_by = '.$user->id;
     }
 
     $sql = "update $table_name set status = null $modified_part where group_id = $group_id";
@@ -296,6 +261,7 @@ class ttAdmin {
     global $user;
     $mdb2 = getConnection();
 
+    $group_key = $mdb2->quote(ttRandomString());
     $name = $mdb2->quote($fields['group_name']);
     $currency = $mdb2->quote($fields['currency']);
     $lang = $mdb2->quote($fields['lang']);
@@ -303,8 +269,8 @@ class ttAdmin {
     $created_ip = $mdb2->quote($_SERVER['REMOTE_ADDR']);
     $created_by = $user->id;
 
-    $sql = "insert into tt_groups (name, currency, lang, created, created_ip, created_by)".
-      " values($name, $currency, $lang, $created, $created_ip, $created_by)";
+    $sql = "insert into tt_groups (group_key, name, currency, lang, created, created_ip, created_by)".
+      " values($group_key, $name, $currency, $lang, $created, $created_ip, $created_by)";
     $affected = $mdb2->exec($sql);
     if (is_a($affected, 'PEAR_Error')) return false;
 
@@ -365,4 +331,84 @@ class ttAdmin {
 
     return true;
   }
+
+  // deleteGroupFiles deletes files attached to all entities in the entire group.
+  // Note that it is a permanent delete, not "mark deleted" by design.
+  static function deleteGroupFiles($group_id) {
+
+    $org = ttAdmin::getOrg($group_id);
+    $org_id = $org['org_id'];
+
+    // Delete all group files from the database.
+    $mdb2 = getConnection();
+    $sql = "delete from tt_files where org_id = $org_id and group_id = $group_id";
+    $affected = $mdb2->exec($sql);
+    if (is_a($affected, 'PEAR_Error'))
+      return false;
+
+    if ($affected == 0) return true; // Do not call file storage utility.
+
+    // Try to make a call to file storage facility.
+    if (!defined('FILE_STORAGE_URI')) return true; // Nothing to do.
+
+    $deletegroupfiles_uri = FILE_STORAGE_URI.'deletegroupfiles';
+
+    // Obtain site id.
+    $sql = "select param_value as site_id from tt_site_config where param_name = 'locker_id'";
+    $res = $mdb2->query($sql);
+    $val = $res->fetchRow();
+    $site_id = $val['site_id'];
+    if (!$site_id) return true; // Nothing to do.
+
+    // Obtain site key.
+    $sql = "select param_value as site_key from tt_site_config where param_name = 'locker_key'";
+    $res = $mdb2->query($sql);
+    $val = $res->fetchRow();
+    $site_key = $val['site_key'];
+    if (!$site_key) return true; // Can't continue without site key.
+
+    // Obtain org key.
+    $sql = "select group_key as org_key from tt_groups where id = $org_id";
+    $res = $mdb2->query($sql);
+    $val = $res->fetchRow();
+    $org_key = $val['org_key'];
+    if (!$org_key) return true; // Can't continue without org key.
+
+    // Obtain group key.
+    $sql = "select group_key as group_key from tt_groups where id = $group_id";
+    $res = $mdb2->query($sql);
+    $val = $res->fetchRow();
+    $group_key = $val['group_key'];
+    if (!$group_key) return true; // Can't continue without group key.
+
+    $curl_fields = array('site_id' => $site_id,
+      'site_key' => $site_key,
+      'org_id' => $org_id,
+      'org_key' => $org_key,
+      'group_id' => $group_id,
+      'group_key' => $group_key);
+
+    // url-ify the data for the POST.
+    foreach($curl_fields as $key=>$value) { $fields_string .= $key.'='.$value.'&'; }
+    $fields_string = rtrim($fields_string, '&');
+
+    // Open connection.
+    $ch = curl_init();
+
+    // Set the url, number of POST vars, POST data.
+    curl_setopt($ch, CURLOPT_URL, $deletegroupfiles_uri);
+    curl_setopt($ch, CURLOPT_POST, true);
+    curl_setopt($ch, CURLOPT_POSTFIELDS, $fields_string);
+    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+
+    // Execute a post request.
+    $result = curl_exec($ch);
+
+    // Close connection.
+    curl_close($ch);
+
+    // Many things can go wrong with a remote call to file storage facility.
+    // By design, we ignore such errors.
+    return true;
+  }
 }