Adjusted export-import to work with entity type in custom fields.
[timetracker.git] / WEB-INF / lib / ttOrgImportHelper.class.php
index 099cb58..20dd417 100644 (file)
 class ttOrgImportHelper {
   var $errors               = null; // Errors go here. Set in constructor by reference.
   var $schema_version       = null; // Database schema version from XML file we import from.
+  var $num_users            = 0;    // A number of active and inactive users we are importing.
   var $conflicting_logins   = null; // A comma-separated list of logins we cannot import.
   var $canImport      = true;    // False if we cannot import data due to a conflict such as login collision.
   var $firstPass      = true;    // True during first pass through the file.
   var $org_id         = null;    // Organization id (same as top group_id).
-  var $current_group_id        = null; // Current group id during parsing.
+  var $current_group_id     = null; // Current group id during parsing.
   var $parents        = array(); // A stack of parent group ids for current group all the way to the root including self.
   var $top_role_id    = 0;       // Top role id.
 
@@ -45,6 +46,7 @@ class ttOrgImportHelper {
   var $currentGroupProjectMap = array();
   var $currentGroupClientMap  = array();
   var $currentGroupUserMap    = array();
+  var $currentGroupTimesheetMap = array();
   var $currentGroupInvoiceMap = array();
   var $currentGroupLogMap     = array();
   var $currentGroupCustomFieldMap = array();
@@ -81,6 +83,7 @@ class ttOrgImportHelper {
       // In first pass we check user logins for potential collisions with existing.
       if ($name == 'USER' && $this->canImport) {
         $login = $attrs['LOGIN'];
+        if ('' != $attrs['STATUS']) $this->num_users++;
         if ('' != $attrs['STATUS'] && $this->loginExists($login)) {
           // We have a login collision. Append colliding login to a list of things we cannot import.
           $this->conflicting_logins .= ($this->conflicting_logins ? ", $login" : $login);
@@ -99,6 +102,7 @@ class ttOrgImportHelper {
         $this->current_group_id = $this->createGroup(array(
           'parent_id' => $this->current_group_id, // Note: after insert current_group_id changes.
           'org_id' => $this->org_id,
+          'group_key' => $attrs['GROUP_KEY'],
           'name' => $attrs['NAME'],
           'description' => $attrs['DESCRIPTION'],
           'currency' => $attrs['CURRENCY'],
@@ -136,6 +140,7 @@ class ttOrgImportHelper {
         unset($this->currentGroupProjectMap); $this->currentGroupProjectMap = array();
         unset($this->currentGroupClientMap); $this->currentGroupClientMap = array();
         unset($this->currentGroupUserMap); $this->currentGroupUserMap = array();
+        unset($this->currentGroupTimesheetMap); $this->currentGroupTimesheetMap = array();
         unset($this->currentGroupInvoiceMap); $this->currentGroupInvoiceMap = array();
         unset($this->currentGroupLogMap); $this->currentGroupLogMap = array();
         unset($this->currentGroupCustomFieldMap); $this->currentGroupCustomFieldMap = array();
@@ -247,6 +252,7 @@ class ttOrgImportHelper {
           'login' => $attrs['LOGIN'],
           'password' => $attrs['PASSWORD'],
           'rate' => $attrs['RATE'],
+          'quota_percent' => $attrs['QUOTA_PERCENT'],
           'email' => $attrs['EMAIL'],
           'status' => $attrs['STATUS']), false);
         if ($user_id) {
@@ -271,6 +277,31 @@ class ttOrgImportHelper {
         return;
       }
 
+      if ($name == 'TIMESHEET') {
+        // We get here when processing <timesheet> tags for the current group.
+        $timesheet_id = $this->insertTimesheet(array(
+          'user_id' => $this->currentGroupUserMap[$attrs['USER_ID']],
+          'group_id' => $this->current_group_id,
+          'org_id' => $this->org_id,
+          'client_id' => $this->currentGroupClientMap[$attrs['CLIENT_ID']],
+          'project_id' => $this->currentGroupProjectMap[$attrs['PROJECT_ID']],
+          'name' => $attrs['NAME'],
+          'comment' => $attrs['COMMENT'],
+          'start_date' => $attrs['START_DATE'],
+          'end_date' => $attrs['END_DATE'],
+          'submit_status' => $attrs['SUBMIT_STATUS'],
+          'approve_status' => $attrs['APPROVE_STATUS'],
+          'approve_comment' => $attrs['APPROVE_COMMENT'],
+          'status' => $attrs['STATUS']));
+        if ($timesheet_id) {
+          // Add a mapping.
+          $this->currentGroupTimesheetMap[$attrs['ID']] = $timesheet_id;
+        } else {
+          $this->errors->add($i18n->get('error.db'));
+        }
+        return;
+      }
+
       if ($name == 'INVOICE') {
         // We get here when processing <invoice> tags for the current group.
         $invoice_id = $this->insertInvoice(array(
@@ -302,9 +333,11 @@ class ttOrgImportHelper {
           'client_id' => $this->currentGroupClientMap[$attrs['CLIENT_ID']],
           'project_id' => $this->currentGroupProjectMap[$attrs['PROJECT_ID']],
           'task_id' => $this->currentGroupTaskMap[$attrs['TASK_ID']],
+          'timesheet_id' => $this->currentGroupTimesheetMap[$attrs['TIMESHEET_ID']],
           'invoice_id' => $this->currentGroupInvoiceMap[$attrs['INVOICE_ID']],
           'comment' => (isset($attrs['COMMENT']) ? $attrs['COMMENT'] : ''),
           'billable' => $attrs['BILLABLE'],
+          'approved' => $attrs['APPROVED'],
           'paid' => $attrs['PAID'],
           'status' => $attrs['STATUS']));
         if ($log_item_id) {
@@ -319,6 +352,7 @@ class ttOrgImportHelper {
         $custom_field_id = $this->insertCustomField(array(
           'group_id' => $this->current_group_id,
           'org_id' => $this->org_id,
+          'entity_type' => $attrs['ENTITY_TYPE'],
           'type' => $attrs['TYPE'],
           'label' => $attrs['LABEL'],
           'required' => $attrs['REQUIRED'],
@@ -368,9 +402,11 @@ class ttOrgImportHelper {
           'org_id' => $this->org_id,
           'client_id' => $this->currentGroupClientMap[$attrs['CLIENT_ID']],
           'project_id' => $this->currentGroupProjectMap[$attrs['PROJECT_ID']],
+          'timesheet_id' => $this->currentGroupTimesheetMap[$attrs['TIMESHEET_ID']],
           'name' => $attrs['NAME'],
           'cost' => $attrs['COST'],
           'invoice_id' => $this->currentGroupInvoiceMap[$attrs['INVOICE_ID']],
+          'approved' => $attrs['APPROVED'],
           'paid' => $attrs['PAID'],
           'status' => $attrs['STATUS']));
         if (!$expense_item_id) $this->errors->add($i18n->get('error.db'));
@@ -388,6 +424,19 @@ class ttOrgImportHelper {
         return;
       }
 
+      if ($name == 'TEMPLATE') {
+        if (!$this->insertTemplate(array(
+          'group_id' => $this->current_group_id,
+          'org_id' => $this->org_id,
+          'name' => $attrs['NAME'],
+          'description' => $attrs['DESCRIPTION'],
+          'content' => $attrs['CONTENT'],
+          'status' => $attrs['STATUS']))) {
+          $this->errors->add($i18n->get('error.db'));
+        }
+        return;
+      }
+
       if ($name == 'MONTHLY_QUOTA') {
         if (!$this->insertMonthlyQuota(array(
           'group_id' => $this->current_group_id,
@@ -417,6 +466,10 @@ class ttOrgImportHelper {
           'project' => $this->currentGroupProjectMap[$attrs['PROJECT_ID']],
           'task' => $this->currentGroupTaskMap[$attrs['TASK_ID']],
           'billable' => $attrs['BILLABLE'],
+          'approved' => $attrs['APPROVED'],
+          'invoice' => $attrs['INVOICE'],
+          'timesheet' => $attrs['TIMESHEET'],
+          'paid_status' => $attrs['PAID_STATUS'],
           'users' => $user_list,
           'period' => $attrs['PERIOD'],
           'from' => $attrs['PERIOD_START'],
@@ -426,12 +479,14 @@ class ttOrgImportHelper {
           'chpaid' => (int) $attrs['SHOW_PAID'],
           'chip' => (int) $attrs['SHOW_IP'],
           'chproject' => (int) $attrs['SHOW_PROJECT'],
+          'chtimesheet' => (int) $attrs['SHOW_TIMESHEET'],
           'chstart' => (int) $attrs['SHOW_START'],
           'chduration' => (int) $attrs['SHOW_DURATION'],
           'chcost' => (int) $attrs['SHOW_COST'],
           'chtask' => (int) $attrs['SHOW_TASK'],
           'chfinish' => (int) $attrs['SHOW_END'],
           'chnote' => (int) $attrs['SHOW_NOTE'],
+          'chapproved' => (int) $attrs['SHOW_APPROVED'],
           'chcf_1' => (int) $attrs['SHOW_CUSTOM_FIELD_1'],
           'chunits' => (int) $attrs['SHOW_WORK_UNITS'],
           'group_by1' => $attrs['GROUP_BY1'],
@@ -568,6 +623,10 @@ class ttOrgImportHelper {
       $this->errors->add($i18n->get('error.user_exists'));
       $this->errors->add(sprintf($i18n->get('error.cannot_import'), $this->conflicting_logins));
     }
+    if (!ttUserHelper::canAdd($this->num_users)) {
+      $this->canImport = false;
+      $this->errors->add($i18n->get('error.user_count'));
+    }
 
     $this->firstPass = false; // We are done with 1st pass.
     xml_parser_free($parser);
@@ -629,14 +688,15 @@ class ttOrgImportHelper {
     global $i18n;
     $mdb2 = getConnection();
 
-    $columns = '(parent_id, org_id, name, description, currency, decimal_mark, lang, date_format, time_format'.
-      ', week_start, tracking_mode, project_required, task_required, record_type, bcc_email'.
-      ', allow_ip, password_complexity, plugins, lock_spec'.
-      ', workday_minutes, config, created, created_ip, created_by)';
+    $columns = '(parent_id, org_id, group_key, name, description, currency, decimal_mark, lang, date_format, time_format,'.
+      ' week_start, tracking_mode, project_required, task_required, record_type, bcc_email,'.
+      ' allow_ip, password_complexity, plugins, lock_spec,'.
+      ' workday_minutes, config, created, created_ip, created_by)';
 
     $values = ' values (';
     $values .= $mdb2->quote($fields['parent_id']);
     $values .= ', '.$mdb2->quote($fields['org_id']);
+    $values .= ', '.$mdb2->quote(trim($fields['group_key']));
     $values .= ', '.$mdb2->quote(trim($fields['name']));
     $values .= ', '.$mdb2->quote(trim($fields['description']));
     $values .= ', '.$mdb2->quote(trim($fields['currency']));
@@ -701,6 +761,23 @@ class ttOrgImportHelper {
     return (!is_a($affected, 'PEAR_Error'));
   }
 
+  // insertTemplate - a helper function to insert a template.
+  private function insertTemplate($fields) {
+    $mdb2 = getConnection();
+
+    $group_id = (int) $fields['group_id'];
+    $org_id = (int) $fields['org_id'];
+    $name = $mdb2->quote($fields['name']);
+    $description = $mdb2->quote($fields['description']);
+    $content = $mdb2->quote($fields['content']);
+    $status = $mdb2->quote($fields['status']);
+
+    $sql = "INSERT INTO tt_templates (group_id, org_id, name, description, content, status)".
+      " values ($group_id, $org_id, $name, $description, $content, $status)";
+    $affected = $mdb2->exec($sql);
+    return (!is_a($affected, 'PEAR_Error'));
+  }
+
   // insertExpense - a helper function to insert an expense item.
   private function insertExpense($fields) {
     global $user;
@@ -716,13 +793,16 @@ class ttOrgImportHelper {
     $cost = str_replace(',', '.', $fields['cost']);
     $invoice_id = $fields['invoice_id'];
     $status = $fields['status'];
+    $approved = (int) $fields['approved'];
     $paid = (int) $fields['paid'];
     $created = ', now(), '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', '.$user->id;
 
     $sql = "insert into tt_expense_items".
-      " (date, user_id, group_id, org_id, client_id, project_id, name, cost, invoice_id, paid, created, created_ip, created_by, status)".
+      " (date, user_id, group_id, org_id, client_id, project_id, name,".
+      " cost, invoice_id, approved, paid, created, created_ip, created_by, status)".
       " values (".$mdb2->quote($date).", $user_id, $group_id, $org_id, ".$mdb2->quote($client_id).", ".$mdb2->quote($project_id).
-      ", ".$mdb2->quote($name).", ".$mdb2->quote($cost).", ".$mdb2->quote($invoice_id).", $paid $created, ".$mdb2->quote($status).")";
+      ", ".$mdb2->quote($name).", ".$mdb2->quote($cost).", ".$mdb2->quote($invoice_id).
+      ", $approved, $paid $created, ".$mdb2->quote($status).")";
     $affected = $mdb2->exec($sql);
     return (!is_a($affected, 'PEAR_Error'));
   }
@@ -775,7 +855,7 @@ class ttOrgImportHelper {
     $group_id = (int) $fields['group_id'];
     $org_id = (int) $fields['org_id'];
 
-    $columns = '(login, password, name, group_id, org_id, role_id, client_id, rate, email, created, created_ip, created_by, status)';
+    $columns = '(login, password, name, group_id, org_id, role_id, client_id, rate, quota_percent, email, created, created_ip, created_by, status)';
 
     $values = 'values (';
     $values .= $mdb2->quote($fields['login']);
@@ -786,6 +866,7 @@ class ttOrgImportHelper {
     $values .= ', '.(int)$fields['role_id'];
     $values .= ', '.$mdb2->quote($fields['client_id']);
     $values .= ', '.$mdb2->quote($fields['rate']);
+    $values .= ', '.$mdb2->quote($fields['quota_percent']);
     $values .= ', '.$mdb2->quote($fields['email']);
     $values .= ', now(), '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', '.$user->id;
     $values .= ', '.$mdb2->quote($fields['status']);
@@ -857,6 +938,39 @@ class ttOrgImportHelper {
     return $last_id;
   }
 
+  // insertTimesheet - inserts a timesheet in database.
+  private function insertTimesheet($fields)
+  {
+    $mdb2 = getConnection();
+
+    $user_id = (int) $fields['user_id'];
+    $group_id = (int) $fields['group_id'];
+    $org_id = (int) $fields['org_id'];
+    $client_id = $fields['client_id'];
+    $project_id = $fields['project_id'];
+    $name = $fields['name'];
+    $comment = $fields['comment'];
+    $start_date = $fields['start_date'];
+    $end_date = $fields['end_date'];
+    $submit_status = $fields['submit_status'];
+    $approve_status = $fields['approve_status'];
+    $approve_comment = $fields['approve_comment'];
+    $status = $fields['status'];
+
+    // Insert a new timesheet record.
+    $sql = "insert into tt_timesheets (user_id, group_id, org_id, client_id, project_id, name,".
+      " comment, start_date, end_date, submit_status, approve_status, approve_comment, status)".
+      " values($user_id, $group_id, $org_id, ".$mdb2->quote($client_id).", ".$mdb2->quote($project_id).", ".$mdb2->quote($name).", ".
+      $mdb2->quote($comment).", ".$mdb2->quote($start_date).", ".$mdb2->quote($end_date).", ".
+      $mdb2->quote($submit_status).", ".$mdb2->quote($approve_status).", ".
+      $mdb2->quote($approve_comment).", ".$mdb2->quote($status).")";
+    $affected = $mdb2->exec($sql);
+    if (is_a($affected, 'PEAR_Error')) return false;
+
+    $last_id = $mdb2->lastInsertID('tt_timesheets', 'id');
+    return $last_id;
+  }
+
   // insertInvoice - inserts an invoice in database.
   private function insertInvoice($fields)
   {
@@ -926,22 +1040,24 @@ class ttOrgImportHelper {
 
     $sql = "insert into tt_fav_reports".
       " (name, user_id, group_id, org_id, client_id, cf_1_option_id, project_id, task_id,".
-      " billable, invoice, paid_status, users, period, period_start, period_end,".
+      " billable, approved, invoice, timesheet, paid_status, users, period, period_start, period_end,".
       " show_client, show_invoice, show_paid, show_ip,".
-      " show_project, show_start, show_duration, show_cost,".
-      " show_task, show_end, show_note, show_custom_field_1, show_work_units,".
+      " show_project, show_timesheet, show_start, show_duration, show_cost,".
+      " show_task, show_end, show_note, show_approved, show_custom_field_1, show_work_units,".
       " group_by1, group_by2, group_by3, show_totals_only)".
       " values(".
       $mdb2->quote($fields['name']).", ".$fields['user_id'].", $group_id, $org_id, ".
       $mdb2->quote($fields['client']).", ".$mdb2->quote($fields['option']).", ".
       $mdb2->quote($fields['project']).", ".$mdb2->quote($fields['task']).", ".
-      $mdb2->quote($fields['billable']).", ".$mdb2->quote($fields['invoice']).", ".
+      $mdb2->quote($fields['billable']).", ".$mdb2->quote($fields['approved']).", ".
+      $mdb2->quote($fields['invoice']).", ".$mdb2->quote($fields['timesheet']).", ".
       $mdb2->quote($fields['paid_status']).", ".
       $mdb2->quote($fields['users']).", ".$mdb2->quote($fields['period']).", ".
       $mdb2->quote($fields['from']).", ".$mdb2->quote($fields['to']).", ".
       $fields['chclient'].", ".$fields['chinvoice'].", ".$fields['chpaid'].", ".$fields['chip'].", ".
-      $fields['chproject'].", ".$fields['chstart'].", ".$fields['chduration'].", ".$fields['chcost'].", ".
-      $fields['chtask'].", ".$fields['chfinish'].", ".$fields['chnote'].", ".$fields['chcf_1'].", ".$fields['chunits'].", ".
+      $fields['chproject'].", ".$fields['chtimesheet'].", ".$fields['chstart'].", ".$fields['chduration'].", ".
+      $fields['chcost'].", ".$fields['chtask'].", ".$fields['chfinish'].", ".$fields['chnote'].", ".
+      $fields['chapproved'].", ".$fields['chcf_1'].", ".$fields['chunits'].", ".
       $mdb2->quote($fields['group_by1']).", ".$mdb2->quote($fields['group_by2']).", ".
       $mdb2->quote($fields['group_by3']).", ".$fields['chtotalsonly'].")";
     $affected = $mdb2->exec($sql);
@@ -999,14 +1115,15 @@ class ttOrgImportHelper {
 
     $group_id = (int) $fields['group_id'];
     $org_id = (int) $fields['org_id'];
+    $entity_type = (int) $fields['entity_type'];
     $type = (int) $fields['type'];
     $label = $fields['label'];
     $required = (int) $fields['required'];
     $status = $fields['status'];
 
     $sql = "insert into tt_custom_fields".
-      " (group_id, org_id, type, label, required, status)".
-      " values($group_id, $org_id, $type, ".$mdb2->quote($label).", $required, ".$mdb2->quote($status).")";
+      " (group_id, org_id, entity_type, type, label, required, status)".
+      " values($group_id, $org_id, $entity_type, $type, ".$mdb2->quote($label).", $required, ".$mdb2->quote($status).")";
     $affected = $mdb2->exec($sql);
     if (is_a($affected, 'PEAR_Error'))
       return false;
@@ -1048,15 +1165,17 @@ class ttOrgImportHelper {
     $client_id = $fields['client_id'];
     $project_id = $fields['project_id'];
     $task_id = $fields['task_id'];
+    $timesheet_id = $fields['timesheet_id'];
     $invoice_id = $fields['invoice_id'];
     $comment = $fields['comment'];
     $billable = (int) $fields['billable'];
+    $approved = (int) $fields['approved'];
     $paid = (int) $fields['paid'];
     $status = $fields['status'];
 
     $sql = "insert into tt_log".
-      " (user_id, group_id, org_id, date, start, duration, client_id, project_id, task_id, invoice_id, comment".
-      ", billable, paid, created, created_ip, created_by, status)".
+      " (user_id, group_id, org_id, date, start, duration, client_id, project_id, task_id, timesheet_id, invoice_id, comment".
+      ", billable, approved, paid, created, created_ip, created_by, status)".
       " values ($user_id, $group_id, $org_id".
       ", ".$mdb2->quote($date).
       ", ".$mdb2->quote($start).
@@ -1064,9 +1183,10 @@ class ttOrgImportHelper {
       ", ".$mdb2->quote($client_id).
       ", ".$mdb2->quote($project_id).
       ", ".$mdb2->quote($task_id).
+      ", ".$mdb2->quote($timesheet_id).
       ", ".$mdb2->quote($invoice_id).
       ", ".$mdb2->quote($comment).
-      ", $billable, $paid".
+      ", $billable, $approved, $paid".
       ", now(), ".$mdb2->quote($_SERVER['REMOTE_ADDR']).", ".$user->id.
       ", ". $mdb2->quote($status).")";
     $affected = $mdb2->exec($sql);