WEB-INF/lib/ttImportHelper.class.php

   1 <?php
   2 // +----------------------------------------------------------------------+
   3 // | Anuko Time Tracker
   4 // +----------------------------------------------------------------------+
   5 // | Copyright (c) Anuko International Ltd. (https://www.anuko.com)
   6 // +----------------------------------------------------------------------+
   7 // | LIBERAL FREEWARE LICENSE: This source code document may be used
   8 // | by anyone for any purpose, and freely redistributed alone or in
   9 // | combination with other software, provided that the license is obeyed.
  10 // |
  11 // | There are only two ways to violate the license:
  12 // |
  13 // | 1. To redistribute this code in source form, with the copyright
  14 // |    notice or license removed or altered. (Distributing in compiled
  15 // |    forms without embedded copyright notices is permitted).
  16 // |
  17 // | 2. To redistribute modified versions of this code in *any* form
  18 // |    that bears insufficient indications that the modifications are
  19 // |    not the work of the original author(s).
  20 // |
  21 // | This license applies to this document only, not any other software
  22 // | that it may be combined with.
  23 // |
  24 // +----------------------------------------------------------------------+
  25 // | Contributors:
  26 // | https://www.anuko.com/time_tracker/credits.htm
  27 // +----------------------------------------------------------------------+
  28
  29 import('ttTeamHelper');
  30 import('ttUserHelper');
  31 import('ttProjectHelper');
  32 import('ttTaskHelper');
  33 import('ttInvoiceHelper');
  34 import('ttTimeHelper');
  35 import('ttClientHelper');
  36 import('ttCustomFieldHelper');
  37 import('ttFavReportHelper');
  38 import('ttExpenseHelper');
  39 import('ttRoleHelper');
  40
  41 // ttImportHelper - this class is used to import group data from a file.
  42 class ttImportHelper {
  43   var $errors         = null;    // Errors go here. Set in constructor by reference.
  44
  45   var $currentElement = array(); // Current element of the XML file we are parsing.
  46   var $currentTag     = '';      // XML tag of the current element.
  47
  48   var $canImport      = true;    // False if we cannot import data due to a login collision.
  49   var $groupData      = array(); // Array of group data such as group name, etc.
  50   var $org_id         = null;    // New organization id we are importing. It is created during the import operation.
  51   var $group_id       = null;    // New group id we are importing. It is created during the import operation.
  52   var $roles          = array(); // Array of arrays of role properties.
  53   var $users          = array(); // Array of arrays of user properties.
  54   var $top_role_id    = null;    // Top manager role id on the new server.
  55
  56   // The following arrays are maps between entity ids in the file versus the database.
  57   // In the file they are sequential (1,2,3...) while in the database the entities have different ids.
  58   var $roleMap       = array(); // Role ids.
  59   var $userMap       = array(); // User ids.
  60   var $projectMap    = array(); // Project ids.
  61   var $taskMap       = array(); // Task ids.
  62   var $clientMap     = array(); // Client ids.
  63   var $invoiceMap    = array(); // Invoice ids.
  64
  65   var $customFieldMap       = array(); // Custom field ids.
  66   var $customFieldOptionMap = array(); // Custop field option ids.
  67   var $logMap        = array(); // Time log ids.
  68
  69   // Constructor.
  70   function __construct(&$errors) {
  71     $this->errors = &$errors;
  72   }
  73
  74   // startElement - callback handler for opening tag of an XML element.
  75   // In this function we assign passed in attributes to currentElement.
  76   function startElement($parser, $name, $attrs) {
  77     if ($name == 'GROUP'
  78       || $name == 'USER'
  79       || $name == 'TASK'
  80       || $name == 'PROJECT'
  81       || $name == 'CLIENT'
  82       || $name == 'INVOICE'
  83       || $name == 'MONTHLY_QUOTA'
  84       || $name == 'LOG_ITEM'
  85       || $name == 'CUSTOM_FIELD'
  86       || $name == 'CUSTOM_FIELD_OPTION'
  87       || $name == 'CUSTOM_FIELD_LOG_ENTRY'
  88       || $name == 'INVOICE_HEADER'
  89       || $name == 'USER_PROJECT_BIND'
  90       || $name == 'EXPENSE_ITEM'
  91       || $name == 'FAV_REPORT'
  92       || $name == 'ROLE') {
  93       $this->currentElement = $attrs;
  94     }
  95     $this->currentTag = $name;
  96   }
  97
  98   // endElement - callback handler for the closing tag of an XML element.
  99   // When we are here, currentElement is an array of the element attributes (as set in startElement).
 100   // Here we do the actual import of data into the database.
 101   function endElement($parser, $name) {
 102     if ($name == 'GROUP') {
 103       $this->groupData = $this->currentElement;
 104       // Now groupData is an array of group properties. We'll use it later to create a group.
 105       // Cannot create the group here. Need to determine whether logins collide with existing logins.
 106       $this->currentElement = array();
 107     }
 108     if ($name == 'ROLE') {
 109       $this->roles[$this->currentElement['ID']] = $this->currentElement;
 110       $this->currentElement = array();
 111     }
 112     if ($name == 'USER') {
 113       $this->users[$this->currentElement['ID']] = $this->currentElement;
 114       $this->currentElement = array();
 115     }
 116     if ($name == 'USERS') {
 117       foreach ($this->users as $user_item) {
 118         if (('' != $user_item['STATUS']) && ttUserHelper::getUserByLogin($user_item['LOGIN'])) {
 119           // We have a login collision, cannot import any data.
 120           $this->canImport = false;
 121           break;
 122         }
 123       }
 124
 125       // Now we can create a group.
 126       if ($this->canImport) {
 127         $this->top_role_id = ttRoleHelper::getRoleByRank(512, 0);
 128         $group_id = $this->createGroup(array(
 129           'name' => $this->groupData['NAME'],
 130           'currency' => $this->groupData['CURRENCY'],
 131           'decimal_mark' => $this->groupData['DECIMAL_MARK'],
 132           'lang' => $this->groupData['LANG'],
 133           'date_format' => $this->groupData['DATE_FORMAT'],
 134           'time_format' => $this->groupData['TIME_FORMAT'],
 135           'week_start' => $this->groupData['WEEK_START'],
 136           'tracking_mode' => $this->groupData['TRACKING_MODE'],
 137           'project_required' => $this->groupData['PROJECT_REQUIRED'],
 138           'task_required' => $this->groupData['TASK_REQUIRED'],
 139           'record_type' => $this->groupData['RECORD_TYPE'],
 140           'bcc_email' => $this->groupData['BCC_EMAIL'],
 141           'allow_ip' => $this->groupData['ALLOW_IP'],
 142           'password_complexity' => $this->groupData['PASSWORD_COMPLEXITY'],
 143           'plugins' => $this->groupData['PLUGINS'],
 144           'lock_spec' => $this->groupData['LOCK_SPEC'],
 145           'workday_minutes' => $this->groupData['WORKDAY_MINUTES'],
 146           'config' => $this->groupData['CONFIG']));
 147         if ($group_id) {
 148           $this->org_id = $group_id;
 149           $this->group_id = $group_id;
 150
 151           // Create roles.
 152           foreach ($this->roles as $key=>$role_item) {
 153             $role_id = ttRoleHelper::insert(array(
 154               'group_id' => $this->group_id,
 155               'org_id' => $this->org_id,
 156               'name' => $role_item['NAME'],
 157               'rank' => $role_item['RANK'],
 158               'rights' => $role_item['RIGHTS'],
 159               'status' => $role_item['STATUS']));
 160             $this->roleMap[$role_item['ID']] = $role_id;
 161           }
 162
 163           foreach ($this->users as $key=>$user_item) {
 164             $role_id = $user_item['ROLE_ID'] === '0' ? $this->top_role_id :  $this->roleMap[$user_item['ROLE_ID']]; // 0 (not null) means top manager role.
 165             $user_id = ttUserHelper::insert(array(
 166               'group_id' => $this->group_id,
 167               'org_id' => $this->org_id,
 168               'role_id' => $role_id,
 169               'client_id' => $user_item['CLIENT_ID'], // Note: NOT mapped value, replaced in CLIENT handler.
 170               'name' => $user_item['NAME'],
 171               'login' => $user_item['LOGIN'],
 172               'password' => $user_item['PASSWORD'],
 173               'rate' => $user_item['RATE'],
 174               'email' => $user_item['EMAIL'],
 175               'status' => $user_item['STATUS']), false);
 176             $this->userMap[$key] = $user_id;
 177           }
 178         }
 179       }
 180     }
 181
 182     if ($name == 'TASK' && $this->canImport) {
 183       $this->taskMap[$this->currentElement['ID']] =
 184         ttTaskHelper::insert(array(
 185           'group_id' => $this->group_id,
 186           'name' => $this->currentElement['NAME'],
 187           'description' => $this->currentElement['DESCRIPTION'],
 188           'status' => $this->currentElement['STATUS']));
 189     }
 190     if ($name == 'PROJECT' && $this->canImport) {
 191       // Prepare a list of task ids.
 192       $tasks = explode(',', $this->currentElement['TASKS']);
 193       foreach ($tasks as $id)
 194         $mapped_tasks[] = $this->taskMap[$id];
 195
 196       // Add a new project.
 197       $this->projectMap[$this->currentElement['ID']] =
 198         ttProjectHelper::insert(array(
 199           'group_id' => $this->group_id,
 200           'name' => $this->currentElement['NAME'],
 201           'description' => $this->currentElement['DESCRIPTION'],
 202           'tasks' => $mapped_tasks,
 203           'status' => $this->currentElement['STATUS']));
 204     }
 205     if ($name == 'USER_PROJECT_BIND' && $this->canImport) {
 206       ttUserHelper::insertBind(
 207         $this->userMap[$this->currentElement['USER_ID']],
 208         $this->projectMap[$this->currentElement['PROJECT_ID']],
 209         $this->currentElement['RATE'],
 210         $this->currentElement['STATUS']);
 211     }
 212
 213     if ($name == 'CLIENT' && $this->canImport) {
 214       // Prepare a list of project ids.
 215       if ($this->currentElement['PROJECTS']) {
 216         $projects = explode(',', $this->currentElement['PROJECTS']);
 217         foreach ($projects as $id)
 218           $mapped_projects[] = $this->projectMap[$id];
 219       }
 220
 221       $this->clientMap[$this->currentElement['ID']] =
 222         ttClientHelper::insert(array(
 223           'group_id' => $this->group_id,
 224           'name' => $this->currentElement['NAME'],
 225           'address' => $this->currentElement['ADDRESS'],
 226           'tax' => $this->currentElement['TAX'],
 227           'projects' => $mapped_projects,
 228           'status' => $this->currentElement['STATUS']));
 229
 230         // Update client_id for tt_users to a mapped value.
 231         // We did not do it during user insertion because clientMap was not ready then.
 232         if ($this->currentElement['ID'] != $this->clientMap[$this->currentElement['ID']])
 233           ttClientHelper::setMappedClient($this->group_id, $this->currentElement['ID'], $this->clientMap[$this->currentElement['ID']]);
 234     }
 235
 236     if ($name == 'INVOICE' && $this->canImport) {
 237       $this->invoiceMap[$this->currentElement['ID']] =
 238         ttInvoiceHelper::insert(array(
 239           'group_id' => $this->group_id,
 240           'name' => $this->currentElement['NAME'],
 241           'date' => $this->currentElement['DATE'],
 242           'client_id' => $this->clientMap[$this->currentElement['CLIENT_ID']],
 243           'discount' => $this->currentElement['DISCOUNT'],
 244           'status' => $this->currentElement['STATUS']));
 245     }
 246
 247     if ($name == 'MONTHLY_QUOTA' && $this->canImport) {
 248       $this->insertMonthlyQuota($this->group_id, $this->currentElement['YEAR'], $this->currentElement['MONTH'], $this->currentElement['MINUTES']);
 249     }
 250
 251     if ($name == 'LOG_ITEM' && $this->canImport) {
 252       $this->logMap[$this->currentElement['ID']] =
 253         ttTimeHelper::insert(array(
 254           'user_id' => $this->userMap[$this->currentElement['USER_ID']],
 255           'group_id' => $this->group_id,
 256           'date' => $this->currentElement['DATE'],
 257           'start' => $this->currentElement['START'],
 258           'finish' => $this->currentElement['FINISH'],
 259           'duration' => $this->currentElement['DURATION'],
 260           'client' => $this->clientMap[$this->currentElement['CLIENT_ID']],
 261           'project' => $this->projectMap[$this->currentElement['PROJECT_ID']],
 262           'task' => $this->taskMap[$this->currentElement['TASK_ID']],
 263           'invoice' => $this->invoiceMap[$this->currentElement['INVOICE_ID']],
 264           'note' => (isset($this->currentElement['COMMENT']) ? $this->currentElement['COMMENT'] : ''),
 265           'billable' => $this->currentElement['BILLABLE'],
 266           'paid' => $this->currentElement['PAID'],
 267           'status' => $this->currentElement['STATUS']));
 268     }
 269
 270     if ($name == 'CUSTOM_FIELD' && $this->canImport) {
 271       $this->customFieldMap[$this->currentElement['ID']] =
 272         ttCustomFieldHelper::insertField(array(
 273           'group_id' => $this->group_id,
 274           'type' => $this->currentElement['TYPE'],
 275           'label' => $this->currentElement['LABEL'],
 276           'required' => $this->currentElement['REQUIRED'],
 277           'status' => $this->currentElement['STATUS']));
 278     }
 279
 280     if ($name == 'CUSTOM_FIELD_OPTION' && $this->canImport) {
 281       $this->customFieldOptionMap[$this->currentElement['ID']] =
 282         ttCustomFieldHelper::insertOption(array(
 283           'field_id' => $this->customFieldMap[$this->currentElement['FIELD_ID']],
 284           'value' => $this->currentElement['VALUE']));
 285     }
 286
 287     if ($name == 'CUSTOM_FIELD_LOG_ENTRY' && $this->canImport) {
 288       ttCustomFieldHelper::insertLogEntry(array(
 289         'log_id' => $this->logMap[$this->currentElement['LOG_ID']],
 290         'field_id' => $this->customFieldMap[$this->currentElement['FIELD_ID']],
 291         'option_id' => $this->customFieldOptionMap[$this->currentElement['OPTION_ID']],
 292         'value' => $this->currentElement['VALUE'],
 293         'status' => $this->currentElement['STATUS']));
 294     }
 295
 296     if ($name == 'EXPENSE_ITEM' && $this->canImport) {
 297       ttExpenseHelper::insert(array(
 298         'date' => $this->currentElement['DATE'],
 299         'user_id' => $this->userMap[$this->currentElement['USER_ID']],
 300         'group_id' => $this->group_id,
 301         'client_id' => $this->clientMap[$this->currentElement['CLIENT_ID']],
 302         'project_id' => $this->projectMap[$this->currentElement['PROJECT_ID']],
 303         'name' => $this->currentElement['NAME'],
 304         'cost' => $this->currentElement['COST'],
 305         'invoice_id' => $this->invoiceMap[$this->currentElement['INVOICE_ID']],
 306         'paid' => $this->currentElement['PAID'],
 307         'status' => $this->currentElement['STATUS']));
 308     }
 309
 310     if ($name == 'FAV_REPORT' && $this->canImport) {
 311       $user_list = '';
 312       if (strlen($this->currentElement['USERS']) > 0) {
 313         $arr = explode(',', $this->currentElement['USERS']);
 314         foreach ($arr as $v)
 315           $user_list .= (strlen($user_list) == 0 ? '' : ',').$this->userMap[$v];
 316       }
 317       ttFavReportHelper::insertReport(array(
 318         'name' => $this->currentElement['NAME'],
 319         'user_id' => $this->userMap[$this->currentElement['USER_ID']],
 320         'client' => $this->clientMap[$this->currentElement['CLIENT_ID']],
 321         'option' => $this->customFieldOptionMap[$this->currentElement['CF_1_OPTION_ID']],
 322         'project' => $this->projectMap[$this->currentElement['PROJECT_ID']],
 323         'task' => $this->taskMap[$this->currentElement['TASK_ID']],
 324         'billable' => $this->currentElement['BILLABLE'],
 325         'users' => $user_list,
 326         'period' => $this->currentElement['PERIOD'],
 327         'from' => $this->currentElement['PERIOD_START'],
 328         'to' => $this->currentElement['PERIOD_END'],
 329         'chclient' => (int) $this->currentElement['SHOW_CLIENT'],
 330         'chinvoice' => (int) $this->currentElement['SHOW_INVOICE'],
 331         'chpaid' => (int) $this->currentElement['SHOW_PAID'],
 332         'chip' => (int) $this->currentElement['SHOW_IP'],
 333         'chproject' => (int) $this->currentElement['SHOW_PROJECT'],
 334         'chstart' => (int) $this->currentElement['SHOW_START'],
 335         'chduration' => (int) $this->currentElement['SHOW_DURATION'],
 336         'chcost' => (int) $this->currentElement['SHOW_COST'],
 337         'chtask' => (int) $this->currentElement['SHOW_TASK'],
 338         'chfinish' => (int) $this->currentElement['SHOW_END'],
 339         'chnote' => (int) $this->currentElement['SHOW_NOTE'],
 340         'chcf_1' => (int) $this->currentElement['SHOW_CUSTOM_FIELD_1'],
 341         'chunits' => (int) $this->currentElement['SHOW_WORK_UNITS'],
 342         'group_by1' => $this->currentElement['GROUP_BY1'],
 343         'group_by2' => $this->currentElement['GROUP_BY2'],
 344         'group_by3' => $this->currentElement['GROUP_BY3'],
 345         'chtotalsonly' => (int) $this->currentElement['SHOW_TOTALS_ONLY']));
 346     }
 347     $this->currentTag = '';
 348   }
 349
 350   // dataElement - callback handler for text data fragments. It builds up currentElement array with text pieces from XML.
 351   function dataElement($parser, $data) {
 352     if ($this->currentTag == 'NAME'
 353       || $this->currentTag == 'DESCRIPTION'
 354       || $this->currentTag == 'LABEL'
 355       || $this->currentTag == 'VALUE'
 356       || $this->currentTag == 'COMMENT'
 357       || $this->currentTag == 'ADDRESS'
 358       || $this->currentTag == 'ALLOW_IP'
 359       || $this->currentTag == 'PASSWORD_COMPLEXITY') {
 360       if (isset($this->currentElement[$this->currentTag]))
 361         $this->currentElement[$this->currentTag] .= trim($data);
 362       else
 363         $this->currentElement[$this->currentTag] = trim($data);
 364     }
 365   }
 366
 367   // importXml - uncompresses the file, reads and parses its content. During parsing,
 368   // startElement, endElement, and dataElement functions are called as many times as necessary.
 369   // Actual import occurs in the endElement handler.
 370   function importXml() {
 371     global $i18n;
 372
 373     // Do we have a compressed file?
 374     $compressed = false;
 375     $file_ext = substr($_FILES['xmlfile']['name'], strrpos($_FILES['xmlfile']['name'], '.') + 1);
 376     if (in_array($file_ext, array('bz','tbz','bz2','tbz2'))) {
 377       $compressed = true;
 378     }
 379
 380     // Create a temporary file.
 381     $dirName = dirname(TEMPLATE_DIR . '_c/.');
 382     $filename = tempnam($dirName, 'import_');
 383
 384     // If the file is compressed - uncompress it.
 385     if ($compressed) {
 386       if (!$this->uncompress($_FILES['xmlfile']['tmp_name'], $filename)) {
 387         $this->errors->add($i18n->get('error.sys'));
 388         return;
 389       }
 390       unlink($_FILES['xmlfile']['tmp_name']);
 391     } else {
 392       if (!move_uploaded_file($_FILES['xmlfile']['tmp_name'], $filename)) {
 393         $this->errors->add($i18n->get('error.upload'));
 394         return;
 395       }
 396     }
 397
 398     // Initialize XML parser.
 399     $parser = xml_parser_create();
 400     xml_set_object($parser, $this);
 401     xml_set_element_handler($parser, 'startElement', 'endElement');
 402     xml_set_character_data_handler($parser, 'dataElement');
 403
 404     // Read and parse the content of the file. During parsing, startElement, endElement, and dataElement functions are called.
 405     $file = fopen($filename, 'r');
 406     while ($data = fread($file, 4096)) {
 407       if (!xml_parse($parser, $data, feof($file))) {
 408         $this->errors->add(sprintf("XML error: %s at line %d",
 409           xml_error_string(xml_get_error_code($parser)),
 410           xml_get_current_line_number($parser)));
 411       }
 412       if (!$this->canImport) {
 413         $this->errors->add($i18n->get('error.user_exists'));
 414         break;
 415       }
 416     }
 417     xml_parser_free($parser);
 418     if ($file) fclose($file);
 419     unlink($filename);
 420   }
 421
 422   // uncompress - uncompresses the content of the $in file into the $out file.
 423   function uncompress($in, $out) {
 424     // Do we have the uncompress function?
 425     if (!function_exists('bzopen'))
 426       return false;
 427
 428     // Initial checks of file names and permissions.
 429     if (!file_exists($in) || !is_readable ($in))
 430       return false;
 431     if ((!file_exists($out) && !is_writable(dirname($out))) || (file_exists($out) && !is_writable($out)))
 432       return false;
 433
 434     if (!$out_file = fopen($out, 'wb'))
 435       return false;
 436     if (!$in_file = bzopen ($in, 'r'))
 437       return false;
 438
 439     while (!feof($in_file)) {
 440       $buffer = bzread($in_file, 4096);
 441       fwrite($out_file, $buffer, 4096);
 442     }
 443     bzclose($in_file);
 444     fclose ($out_file);
 445     return true;
 446   }
 447
 448   // createGroup function creates a new group.
 449   private function createGroup($fields) {
 450
 451     global $user;
 452     $mdb2 = getConnection();
 453
 454     $columns = '(name, currency, decimal_mark, lang, date_format, time_format, week_start, tracking_mode'.
 455       ', project_required, task_required, record_type, bcc_email, allow_ip, password_complexity, plugins'.
 456       ', lock_spec, workday_minutes, config, created, created_ip, created_by)';
 457
 458     $values = ' values ('.$mdb2->quote(trim($fields['name']));
 459     $values .= ', '.$mdb2->quote(trim($fields['currency']));
 460     $values .= ', '.$mdb2->quote($fields['decimal_mark']);
 461     $values .= ', '.$mdb2->quote($fields['lang']);
 462     $values .= ', '.$mdb2->quote($fields['date_format']);
 463     $values .= ', '.$mdb2->quote($fields['time_format']);
 464     $values .= ', '.(int)$fields['week_start'];
 465     $values .= ', '.(int)$fields['tracking_mode'];
 466     $values .= ', '.(int)$fields['project_required'];
 467     $values .= ', '.(int)$fields['task_required'];
 468     $values .= ', '.(int)$fields['record_type'];
 469     $values .= ', '.$mdb2->quote($fields['bcc_email']);
 470     $values .= ', '.$mdb2->quote($fields['allow_ip']);
 471     $values .= ', '.$mdb2->quote($fields['password_complexity']);
 472     $values .= ', '.$mdb2->quote($fields['plugins']);
 473     $values .= ', '.$mdb2->quote($fields['lock_spec']);
 474     $values .= ', '.(int)$fields['workday_minutes'];
 475     $values .= ', '.$mdb2->quote($fields['config']);
 476     $values .= ', now(), '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', '.$mdb2->quote($user->id);
 477     $values .= ')';
 478
 479     $sql = 'insert into tt_groups '.$columns.$values;
 480     $affected = $mdb2->exec($sql);
 481     if (is_a($affected, 'PEAR_Error')) return false;
 482
 483     $group_id = $mdb2->lastInsertID('tt_groups', 'id');
 484
 485     // Update org_id with group_id.
 486     // NOTE: Both export and import need an additional effort to properly operate on subgroups.
 487     // Currently we are importing one group only, which becomes a top level group.
 488     $sql = "update tt_groups set org_id = $group_id where org_id is NULL and id = $group_id";
 489     $affected = $mdb2->exec($sql);
 490     if (is_a($affected, 'PEAR_Error')) return false;
 491
 492     return $group_id;
 493   }
 494
 495   // insertMonthlyQuota - a helper function to insert a monthly quota.
 496   private function insertMonthlyQuota($group_id, $year, $month, $minutes) {
 497     $mdb2 = getConnection();
 498     $sql = "INSERT INTO tt_monthly_quotas (group_id, year, month, minutes) values ($group_id, $year, $month, $minutes)";
 499     $affected = $mdb2->exec($sql);
 500     return (!is_a($affected, 'PEAR_Error'));
 501   }
 502 }