Improved isTrue() function and its usage to streamline code.
[timetracker.git] / WEB-INF / lib / ttOrgImportHelper.class.php
index 73f1f09..a14d971 100644 (file)
 import('ttUserHelper');
 import('ttRoleHelper');
 import('ttTaskHelper');
-import('ttProjectHelper');
 import('ttClientHelper');
 import('ttInvoiceHelper');
-import('ttCustomFieldHelper');
+import('ttTimeHelper');
 import('ttExpenseHelper');
 import('ttFavReportHelper');
 
@@ -59,6 +58,7 @@ class ttOrgImportHelper {
   var $currentGroupLogMap     = array();
   var $currentGroupCustomFieldMap = array();
   var $currentGroupCustomFieldOptionMap = array();
+  var $currentGroupFavReportMap = array();
 
   // Constructor.
   function __construct(&$errors) {
@@ -199,11 +199,13 @@ class ttOrgImportHelper {
         // We get here when processing <project> tags for the current group.
 
         // Prepare a list of task ids.
-        $tasks = explode(',', $attrs['TASKS']);
-        foreach ($tasks as $id)
-          $mapped_tasks[] = $this->currentGroupTaskMap[$id];
+        if ($attrs['TASKS']) {
+          $tasks = explode(',', $attrs['TASKS']);
+          foreach ($tasks as $id)
+            $mapped_tasks[] = $this->currentGroupTaskMap[$id];
+        }
 
-        $project_id = ttProjectHelper::insert(array(
+        $project_id = $this->insertProject(array(
           'group_id' => $this->current_group_id,
           'org_id' => $this->org_id,
           'name' => $attrs['NAME'],
@@ -229,11 +231,13 @@ class ttOrgImportHelper {
         // We get here when processing <client> tags for the current group.
 
         // Prepare a list of project ids.
-        $projects = explode(',', $attrs['PROJECTS']);
-        foreach ($projects as $id)
-          $mapped_projects[] = $this->currentGroupProjectMap[$id];
+        if ($attrs['PROJECTS']) {
+          $projects = explode(',', $attrs['PROJECTS']);
+          foreach ($projects as $id)
+            $mapped_projects[] = $this->currentGroupProjectMap[$id];
+        }
 
-        $client_id = ttClientHelper::insert(array(
+        $client_id = $this->insertClient(array(
           'group_id' => $this->current_group_id,
           'org_id' => $this->org_id,
           'name' => $attrs['NAME'],
@@ -359,9 +363,9 @@ class ttOrgImportHelper {
 
       if ($name == 'CUSTOM_FIELD') {
         // We get here when processing <custom_field> tags for the current group.
-        $custom_field_id = ttCustomFieldHelper::insertField(array(
+        $custom_field_id = $this->insertCustomField(array(
           'group_id' => $this->current_group_id,
-          // 'org_id' => $this->org_id, TODO: add this when org_id field is added to the table.
+          'org_id' => $this->org_id,
           'type' => $attrs['TYPE'],
           'label' => $attrs['LABEL'],
           'required' => $attrs['REQUIRED'],
@@ -383,9 +387,9 @@ class ttOrgImportHelper {
 
       if ($name == 'CUSTOM_FIELD_OPTION') {
         // We get here when processing <custom_field_option> tags for the current group.
-        $custom_field_option_id = ttCustomFieldHelper::insertOption(array(
-          // 'group_id' => $this->current_group_id, TODO: add this when group_id field is added to the table.
-          // 'org_id' => $this->org_id, TODO: add this when org_id field is added to the table.
+        $custom_field_option_id = $this->insertCustomFieldOption(array(
+          'group_id' => $this->current_group_id,
+          'org_id' => $this->org_id,
           'field_id' => $this->currentGroupCustomFieldMap[$attrs['FIELD_ID']],
           'value' => $attrs['VALUE']));
         if ($custom_field_option_id) {
@@ -397,9 +401,9 @@ class ttOrgImportHelper {
 
       if ($name == 'CUSTOM_FIELD_LOG_ENTRY') {
         // We get here when processing <custom_field_log_entry> tags for the current group.
-        if (!ttCustomFieldHelper::insertLogEntry(array(
-          // 'group_id' => $this->current_group_id, TODO: add this when group_id field is added to the table.
-          // 'org_id' => $this->org_id, TODO: add this when org_id field is added to the table.
+        if (!$this->insertCustomFieldLogEntry(array(
+          'group_id' => $this->current_group_id,
+          'org_id' => $this->org_id,
           'log_id' => $this->currentGroupLogMap[$attrs['LOG_ID']],
           'field_id' => $this->currentGroupCustomFieldMap[$attrs['FIELD_ID']],
           'option_id' => $this->currentGroupCustomFieldOptionMap[$attrs['OPTION_ID']],
@@ -412,11 +416,11 @@ class ttOrgImportHelper {
 
       if ($name == 'EXPENSE_ITEM') {
         // We get here when processing <expense_item> tags for the current group.
-        $expense_item_id = ttExpenseHelper::insert(array(
+        $expense_item_id = $this->insertExpense(array(
           'date' => $attrs['DATE'],
           'user_id' => $this->currentGroupUserMap[$attrs['USER_ID']],
           'group_id' => $this->current_group_id,
-          // 'org_id' => $this->org_id, TODO: add this when org_id field is added to the table.
+          'org_id' => $this->org_id,
           'client_id' => $this->currentGroupClientMap[$attrs['CLIENT_ID']],
           'project_id' => $this->currentGroupProjectMap[$attrs['PROJECT_ID']],
           'name' => $attrs['NAME'],
@@ -428,17 +432,37 @@ class ttOrgImportHelper {
         return;
       }
 
+      if ($name == 'PREDEFINED_EXPENSE') {
+        if (!$this->insertPredefinedExpense(array(
+          'group_id' => $this->current_group_id,
+          'org_id' => $this->org_id,
+          'name' => $attrs['NAME'],
+          'cost' => $attrs['COST']))) {
+          $this->errors->add($i18n->get('error.db'));
+        }
+        return;
+      }
+
       if ($name == 'MONTHLY_QUOTA') {
-        if (!$this->insertMonthlyQuota($this->current_group_id,
-          // 'org_id' => $this->org_id, TODO: add this when org_id field is added to the table.
-          $attrs['YEAR'],
-          $attrs['MONTH'],
-          $attrs['MINUTES'])) {
+        if (!$this->insertMonthlyQuota(array(
+          'group_id' => $this->current_group_id,
+          'org_id' => $this->org_id,
+          'year' => $attrs['YEAR'],
+          'month' => $attrs['MONTH'],
+          'minutes' => $attrs['MINUTES']))) {
           $this->errors->add($i18n->get('error.db'));
         }
         return;
       }
 
+      if ($name == 'FAV_REPORTS') {
+        // If we get here, we have to recycle $currentGroupFavReportMap.
+        unset($this->currentGroupFavReportMap);
+        $this->currentGroupFavReportMap = array();
+        // Favorite report map is reconstructed after processing <fav_report> elements in XML. See below.
+        return;
+      }
+
       if ($name == 'FAV_REPORT') {
         $user_list = '';
         if (strlen($attrs['USERS']) > 0) {
@@ -446,9 +470,11 @@ class ttOrgImportHelper {
           foreach ($arr as $v)
             $user_list .= (strlen($user_list) == 0 ? '' : ',').$this->currentGroupUserMap[$v];
         }
-        $fav_report_id = ttFavReportHelper::insertReport(array(
+        $fav_report_id = $this->insertFavReport(array(
           'name' => $attrs['NAME'],
           'user_id' => $this->currentGroupUserMap[$attrs['USER_ID']],
+          'group_id' => $this->current_group_id,
+          'org_id' => $this->org_id,
           'client' => $this->currentGroupClientMap[$attrs['CLIENT_ID']],
           'option' => $this->currentGroupCustomFieldOptionMap[$attrs['CF_1_OPTION_ID']],
           'project' => $this->currentGroupProjectMap[$attrs['PROJECT_ID']],
@@ -475,8 +501,41 @@ class ttOrgImportHelper {
           'group_by2' => $attrs['GROUP_BY2'],
           'group_by3' => $attrs['GROUP_BY3'],
           'chtotalsonly' => (int) $attrs['SHOW_TOTALS_ONLY']));
-         if (!$fav_report_id) $this->errors->add($i18n->get('error.db'));
-         return;
+        if ($fav_report_id) {
+          // Add a mapping.
+          $this->currentGroupFavReportMap[$attrs['ID']] = $fav_report_id;
+          } else $this->errors->add($i18n->get('error.db'));
+        return;
+      }
+
+      if ($name == 'NOTIFICATION') {
+        if (!$this->insertNotification(array(
+          'group_id' => $this->current_group_id,
+          'org_id' => $this->org_id,
+          'cron_spec' => $attrs['CRON_SPEC'],
+          'last' => $attrs['LAST'],
+          'next' => $attrs['NEXT'],
+          'report_id' => $this->currentGroupFavReportMap[$attrs['REPORT_ID']],
+          'email' => $attrs['EMAIL'],
+          'cc' => $attrs['CC'],
+          'subject' => $attrs['SUBJECT'],
+          'report_condition' => $attrs['REPORT_CONDITION'],
+          'status' => $attrs['STATUS']))) {
+          $this->errors->add($i18n->get('error.db'));
+        }
+        return;
+      }
+
+      if ($name == 'USER_PARAM') {
+        if (!$this->insertUserParam(array(
+          'group_id' => $this->current_group_id,
+          'org_id' => $this->org_id,
+          'user_id' => $this->currentGroupUserMap[$attrs['USER_ID']],
+          'param_name' => $attrs['PARAM_NAME'],
+          'param_value' => $attrs['PARAM_VALUE']))) {
+          $this->errors->add($i18n->get('error.db'));
+        }
+        return;
       }
     }
   }
@@ -523,7 +582,7 @@ class ttOrgImportHelper {
 
     // Read and parse the content of the file. During parsing, startElement is called back for each tag.
     $file = fopen($filename, 'r');
-    while ($data = fread($file, 4096)) {
+    while (($data = fread($file, 4096)) && $this->errors->no()) {
       if (!xml_parse($parser, $data, feof($file))) {
         $this->errors->add(sprintf($i18n->get('error.xml'),
           xml_get_current_line_number($parser),
@@ -552,7 +611,7 @@ class ttOrgImportHelper {
 
     // Read and parse the content of the file. During parsing, startElement is called back for each tag.
     $file = fopen($filename, 'r');
-    while ($data = fread($file, 4096)) {
+    while (($data = fread($file, 4096)) && $this->errors->no()) {
       if (!xml_parse($parser, $data, feof($file))) {
         $this->errors->add(sprintf($i18n->get('error.xml'),
           xml_get_current_line_number($parser),
@@ -637,9 +696,286 @@ class ttOrgImportHelper {
   }
 
   // insertMonthlyQuota - a helper function to insert a monthly quota.
-  private function insertMonthlyQuota($group_id, $year, $month, $minutes) {
+  private function insertMonthlyQuota($fields) {
+    $mdb2 = getConnection();
+    $group_id = (int) $fields['group_id'];
+    $org_id = (int) $fields['org_id'];
+    $year = (int) $fields['year'];
+    $month = (int) $fields['month'];
+    $minutes = (int) $fields['minutes'];
+
+    $sql = "INSERT INTO tt_monthly_quotas (group_id, org_id, year, month, minutes)".
+      " values ($group_id, $org_id, $year, $month, $minutes)";
+    $affected = $mdb2->exec($sql);
+    return (!is_a($affected, 'PEAR_Error'));
+  }
+
+  // insertPredefinedExpense - a helper function to insert a predefined expense.
+  private function insertPredefinedExpense($fields) {
+    $mdb2 = getConnection();
+    $group_id = (int) $fields['group_id'];
+    $org_id = (int) $fields['org_id'];
+    $name = $mdb2->quote($fields['name']);
+    $cost = $mdb2->quote($fields['cost']);
+
+    $sql = "INSERT INTO tt_predefined_expenses (group_id, org_id, name, cost)".
+      " values ($group_id, $org_id, $name, $cost)";
+    $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;
+    $mdb2 = getConnection();
+
+    $group_id = (int) $fields['group_id'];
+    $org_id = (int) $fields['org_id'];
+    $date = $fields['date'];
+    $user_id = (int) $fields['user_id'];
+    $client_id = $fields['client_id'];
+    $project_id = $fields['project_id'];
+    $name = $fields['name'];
+    $cost = str_replace(',', '.', $fields['cost']);
+    $invoice_id = $fields['invoice_id'];
+    $status = $fields['status'];
+    $paid = (int) $fields['paid'];
+    $created = ', now(), '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', '.$mdb2->quote($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)".
+      " 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).")";
+    $affected = $mdb2->exec($sql);
+    return (!is_a($affected, 'PEAR_Error'));
+  }
+
+  // insertProject - a helper function to insert a project as well as project to task binds.
+  private function insertProject($fields)
+  {
+    $mdb2 = getConnection();
+
+    $group_id = (int) $fields['group_id'];
+    $org_id = (int) $fields['org_id'];
+
+    $name = $fields['name'];
+    $description = $fields['description'];
+    $tasks = $fields['tasks'];
+    $comma_separated = implode(',', $tasks); // This is a comma-separated list of associated task ids.
+    $status = $fields['status'];
+
+    $sql = "insert into tt_projects (group_id, org_id, name, description, tasks, status)
+      values ($group_id, $org_id, ".$mdb2->quote($name).", ".$mdb2->quote($description).", ".$mdb2->quote($comma_separated).", ".$mdb2->quote($status).")";
+    $affected = $mdb2->exec($sql);
+    if (is_a($affected, 'PEAR_Error'))
+      return false;
+
+    $last_id = 0;
+    $sql = "select last_insert_id() as last_insert_id";
+    $res = $mdb2->query($sql);
+    $val = $res->fetchRow();
+    $last_id = $val['last_insert_id'];
+
+    // Insert binds into tt_project_task_binds table.
+    if (is_array($tasks)) {
+      foreach ($tasks as $task_id) {
+        $sql = "insert into tt_project_task_binds (project_id, task_id, group_id, org_id)".
+          " values($last_id, $task_id, $group_id, $org_id)";
+        $affected = $mdb2->exec($sql);
+        if (is_a($affected, 'PEAR_Error'))
+          return false;
+      }
+    }
+
+    return $last_id;
+  }
+
+  // The insertClient function inserts a new client as well as client to project binds.
+  private function insertClient($fields)
+  {
+    $mdb2 = getConnection();
+
+    $group_id = (int) $fields['group_id'];
+    $org_id = (int) $fields['org_id'];
+    $name = $fields['name'];
+    $address = $fields['address'];
+    $tax = $fields['tax'];
+    $projects = $fields['projects'];
+    if ($projects)
+      $comma_separated = implode(',', $projects); // This is a comma-separated list of associated projects ids.
+    $status = $fields['status'];
+
+    $tax = str_replace(',', '.', $tax);
+    if ($tax == '') $tax = 0;
+
+    $sql = "insert into tt_clients (group_id, org_id, name, address, tax, projects, status)".
+      " values ($group_id, $org_id, ".$mdb2->quote($name).", ".$mdb2->quote($address).", $tax, ".$mdb2->quote($comma_separated).", ".$mdb2->quote($status).")";
+
+    $affected = $mdb2->exec($sql);
+    if (is_a($affected, 'PEAR_Error'))
+      return false;
+
+    $last_id = 0;
+    $sql = "select last_insert_id() as last_insert_id";
+    $res = $mdb2->query($sql);
+    $val = $res->fetchRow();
+    $last_id = $val['last_insert_id'];
+
+    if (count($projects) > 0)
+      foreach ($projects as $p_id) {
+        $sql = "insert into tt_client_project_binds (client_id, project_id, group_id, org_id) values($last_id, $p_id, $group_id, $org_id)";
+        $affected = $mdb2->exec($sql);
+        if (is_a($affected, 'PEAR_Error'))
+          return false;
+      }
+
+    return $last_id;
+  }
+
+  // insertFavReport - inserts a favorite report in database.
+  private function insertFavReport($fields) {
+    $mdb2 = getConnection();
+
+    $group_id = (int) $fields['group_id'];
+    $org_id = (int) $fields['org_id'];
+
+    $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,".
+      " 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,".
+      " 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['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'].", ".
+      $mdb2->quote($fields['group_by1']).", ".$mdb2->quote($fields['group_by2']).", ".
+      $mdb2->quote($fields['group_by3']).", ".$fields['chtotalsonly'].")";
+    $affected = $mdb2->exec($sql);
+    if (is_a($affected, 'PEAR_Error'))
+      return false;
+
+    $sql = "select last_insert_id() as last_id";
+    $res = $mdb2->query($sql);
+    if (is_a($res, 'PEAR_Error'))
+      return false;
+
+    $val = $res->fetchRow();
+    return $val['last_id'];
+  }
+
+  // insertNotification function inserts a new notification into database.
+  private function insertNotification($fields)
+  {
     $mdb2 = getConnection();
-    $sql = "INSERT INTO tt_monthly_quotas (group_id, year, month, minutes) values ($group_id, $year, $month, $minutes)";
+
+    $group_id = (int) $fields['group_id'];
+    $org_id = (int) $fields['org_id'];
+    $cron_spec = $fields['cron_spec'];
+    $last = (int) $fields['last'];
+    $next = (int) $fields['next'];
+    $report_id = (int) $fields['report_id'];
+    $email = $fields['email'];
+    $cc = $fields['cc'];
+    $subject = $fields['subject'];
+    $report_condition = $fields['report_condition'];
+    $status = $fields['status'];
+
+    $sql = "insert into tt_cron".
+      " (group_id, org_id, cron_spec, last, next, report_id, email, cc, subject, report_condition, status)".
+      " values ($group_id, $org_id, ".$mdb2->quote($cron_spec).", $last, $next, $report_id, ".$mdb2->quote($email).", ".$mdb2->quote($cc).", ".$mdb2->quote($subject).", ".$mdb2->quote($report_condition).", ".$mdb2->quote($status).")";
+    $affected = $mdb2->exec($sql);
+    return (!is_a($affected, 'PEAR_Error'));
+  }
+
+  // insertUserParam - a helper function to insert a user parameter.
+  private function insertUserParam($fields) {
+    $mdb2 = getConnection();
+
+    $group_id = (int) $fields['group_id'];
+    $org_id = (int) $fields['org_id'];
+    $user_id = (int) $fields['user_id'];
+    $param_name = $fields['param_name'];
+    $param_value = $fields['param_value'];
+
+    $sql = "insert into tt_config".
+      " (user_id, group_id, org_id, param_name, param_value)".
+      " values ($user_id, $group_id, $org_id, ".$mdb2->quote($param_name).", ".$mdb2->quote($param_value).")";
+    $affected = $mdb2->exec($sql);
+    return (!is_a($affected, 'PEAR_Error'));
+  }
+
+  // insertCustomField - a helper function to insert a custom field.
+  private function insertCustomField($fields) {
+    $mdb2 = getConnection();
+
+    $group_id = (int) $fields['group_id'];
+    $org_id = (int) $fields['org_id'];
+    $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).")";
+    $affected = $mdb2->exec($sql);
+    if (is_a($affected, 'PEAR_Error'))
+      return false;
+
+    $last_id = 0;
+    $sql = "select last_insert_id() as last_insert_id";
+    $res = $mdb2->query($sql);
+    $val = $res->fetchRow();
+    $last_id = $val['last_insert_id'];
+    return $last_id;
+  }
+
+  // insertCustomFieldOption - a helper function to insert a custom field option.
+  private function insertCustomFieldOption($fields) {
+    $mdb2 = getConnection();
+
+    $group_id = (int) $fields['group_id'];
+    $org_id = (int) $fields['org_id'];
+    $field_id = (int) $fields['field_id'];
+    $value = $fields['value'];
+
+    $sql = "insert into tt_custom_field_options (group_id, org_id, field_id, value)".
+      " values ($group_id, $org_id, $field_id, ".$mdb2->quote($value).")";
+    $affected = $mdb2->exec($sql);
+    if (is_a($affected, 'PEAR_Error'))
+      return false;
+
+    $last_id = 0;
+    $sql = "select last_insert_id() as last_insert_id";
+    $res = $mdb2->query($sql);
+    $val = $res->fetchRow();
+    $last_id = $val['last_insert_id'];
+    return $last_id;
+  }
+
+  // insertCustomFieldLogEntry - a helper function to insert a custom field log entry.
+  private function insertCustomFieldLogEntry($fields) {
+    $mdb2 = getConnection();
+
+    $group_id = (int) $fields['group_id'];
+    $org_id = (int) $fields['org_id'];
+    $log_id = (int) $fields['log_id'];
+    $field_id = (int) $fields['field_id'];
+    $option_id = $fields['option_id'];
+    $value = $fields['value'];
+    $status = $fields['status'];
+
+    $sql = "insert into tt_custom_field_log (group_id, org_id, log_id, field_id, option_id, value, status)".
+      " values ($group_id, $org_id, $log_id, $field_id, ".$mdb2->quote($option_id).", ".$mdb2->quote($value).", ".$mdb2->quote($status).")";
     $affected = $mdb2->exec($sql);
     return (!is_a($affected, 'PEAR_Error'));
   }