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
  40 // ttImportHelper - this class is used to import team data from a file.
  41 class ttImportHelper {
  42   var $errors         = null;    // Errors go here. Set in constructor by reference.
  43
  44   var $currentElement = array(); // Current element of the XML file we are parsing.
  45   var $currentTag     = '';      // XML tag of the current element.
  46
  47   var $canImport      = true;    // False if we cannot import data due to a login collision.
  48   var $teamData       = array(); // Array of team data such as team name, etc.
  49   var $team_id        = null;    // New team id we are importing. It is created during the import operation.
  50   var $users          = array(); // Array of arrays of user properties.
  51
  52   // The following arrays are maps between entity ids in the file versus the database.
  53   // In the file they are sequential (1,2,3...) while in the database the entities have different ids.
  54   var $userMap       = array(); // User ids.
  55   var $projectMap    = array(); // Project ids.
  56   var $taskMap       = array(); // Task ids.
  57   var $clientMap     = array(); // Client ids.
  58   var $invoiceMap    = array(); // Invoice ids.
  59
  60   var $customFieldMap       = array(); // Custom field ids.
  61   var $customFieldOptionMap = array(); // Custop field option ids.
  62   var $logMap        = array(); // Time log ids.
  63
  64   // Constructor.
  65   function ttImportHelper(&$errors) {
  66     $this->errors = &$errors;
  67   }
  68
  69   // startElement - callback handler for opening tag of an XML element.
  70   // In this function we assign passed in attributes to currentElement.
  71   function startElement($parser, $name, $attrs) {
  72     if ($name == 'TEAM'
  73       || $name == 'USER'
  74       || $name == 'TASK'
  75       || $name == 'PROJECT'
  76       || $name == 'CLIENT'
  77       || $name == 'INVOICE'
  78       || $name == 'MONTHLY_QUOTA'
  79       || $name == 'LOG_ITEM'
  80       || $name == 'CUSTOM_FIELD'
  81       || $name == 'CUSTOM_FIELD_OPTION'
  82       || $name == 'CUSTOM_FIELD_LOG_ENTRY'
  83       || $name == 'INVOICE_HEADER'
  84       || $name == 'USER_PROJECT_BIND'
  85       || $name == 'EXPENSE_ITEM'
  86       || $name == 'FAV_REPORT') {
  87       $this->currentElement = $attrs;
  88     }
  89     $this->currentTag = $name;
  90   }
  91
  92   // endElement - callback handler for the closing tag of an XML element.
  93   // When we are here, currentElement is an array of the element attributes (as set in startElement).
  94   // Here we do the actual import of data into the database.
  95   function endElement($parser, $name) {
  96     if ($name == 'TEAM') {
  97       $this->teamData = $this->currentElement;
  98       // Now teamData is an array of team properties. We'll use it later to create a team.
  99       // Cannot create the team here. Need to determine whether logins collide with existing logins.
 100       $this->currentElement = array();
 101     }
 102     if ($name == 'USER') {
 103       $this->users[$this->currentElement['ID']] = $this->currentElement;
 104       $this->currentElement = array();
 105     }
 106     if ($name == 'USERS') {
 107       foreach ($this->users as $user_item) {
 108         if (('' != $user_item['STATUS']) && ttUserHelper::getUserByLogin($user_item['LOGIN'])) {
 109           // We have a login collision, cannot import any data.
 110           $this->canImport = false;
 111           break;
 112         }
 113       }
 114
 115       // Now we can create a team.
 116       if ($this->canImport) {
 117         $team_id = ttTeamHelper::insert(array(
 118           'name' => $this->teamData['NAME'],
 119           'address' => $this->teamData['ADDRESS'],
 120           'currency' => $this->teamData['CURRENCY'],
 121           'lock_spec' => $this->teamData['LOCK_SPEC'],
 122           'workday_hours' => $this->teamData['WORKDAY_HOURS'],
 123           'lang' => $this->teamData['LANG'],
 124           'decimal_mark' => $this->teamData['DECIMAL_MARK'],
 125           'date_format' => $this->teamData['DATE_FORMAT'],
 126           'time_format' => $this->teamData['TIME_FORMAT'],
 127           'week_start' => $this->teamData['WEEK_START'],
 128           'plugins' => $this->teamData['PLUGINS'],
 129           'tracking_mode' => $this->teamData['TRACKING_MODE'],
 130           'record_type' => $this->teamData['RECORD_TYPE']));
 131         if ($team_id) {
 132           $this->team_id = $team_id;
 133           foreach ($this->users as $key=>$user_item) {
 134             $user_id = ttUserHelper::insert(array(
 135               'team_id' => $this->team_id,
 136               'role' => $user_item['ROLE'],
 137               'client_id' => $user_item['CLIENT_ID'], // Note: NOT mapped value, replaced in CLIENT handler.
 138               'name' => $user_item['NAME'],
 139               'login' => $user_item['LOGIN'],
 140               'password' => $user_item['PASSWORD'],
 141               'rate' => $user_item['RATE'],
 142               'email' => $user_item['EMAIL'],
 143               'status' => $user_item['STATUS']), false);
 144             $this->userMap[$key] = $user_id;
 145           }
 146         }
 147       }
 148     }
 149
 150     if ($name == 'TASK' && $this->canImport) {
 151       $this->taskMap[$this->currentElement['ID']] =
 152         ttTaskHelper::insert(array(
 153           'team_id' => $this->team_id,
 154           'name' => $this->currentElement['NAME'],
 155           'description' => $this->currentElement['DESCRIPTION'],
 156           'status' => $this->currentElement['STATUS']));
 157     }
 158     if ($name == 'PROJECT' && $this->canImport) {
 159       // Prepare a list of task ids.
 160       $tasks = explode(',', $this->currentElement['TASKS']);
 161       foreach ($tasks as $id)
 162         $mapped_tasks[] = $this->taskMap[$id];
 163
 164       // Add a new project.
 165       $this->projectMap[$this->currentElement['ID']] =
 166         ttProjectHelper::insert(array(
 167           'team_id' => $this->team_id,
 168           'name' => $this->currentElement['NAME'],
 169           'description' => $this->currentElement['DESCRIPTION'],
 170           'tasks' => $mapped_tasks,
 171           'status' => $this->currentElement['STATUS']));
 172     }
 173     if ($name == 'USER_PROJECT_BIND' && $this->canImport) {
 174       ttUserHelper::insertBind(
 175         $this->userMap[$this->currentElement['USER_ID']],
 176         $this->projectMap[$this->currentElement['PROJECT_ID']],
 177         $this->currentElement['RATE'],
 178         $this->currentElement['STATUS']);
 179     }
 180
 181     if ($name == 'CLIENT' && $this->canImport) {
 182       // Prepare a list of project ids.
 183       if ($this->currentElement['PROJECTS']) {
 184         $projects = explode(',', $this->currentElement['PROJECTS']);
 185         foreach ($projects as $id)
 186           $mapped_projects[] = $this->projectMap[$id];
 187       }
 188
 189       $this->clientMap[$this->currentElement['ID']] =
 190         ttClientHelper::insert(array(
 191           'team_id' => $this->team_id,
 192           'name' => $this->currentElement['NAME'],
 193           'address' => $this->currentElement['ADDRESS'],
 194           'tax' => $this->currentElement['TAX'],
 195           'projects' => $mapped_projects,
 196           'status' => $this->currentElement['STATUS']));
 197
 198         // Update client_id for tt_users to a mapped value.
 199         // We did not do it during user insertion because clientMap was not ready then.
 200         if ($this->currentElement['ID'] != $this->clientMap[$this->currentElement['ID']])
 201           ttClientHelper::setMappedClient($this->team_id, $this->currentElement['ID'], $this->clientMap[$this->currentElement['ID']]);
 202     }
 203
 204     if ($name == 'INVOICE' && $this->canImport) {
 205       $this->invoiceMap[$this->currentElement['ID']] =
 206         ttInvoiceHelper::insert(array(
 207           'team_id' => $this->team_id,
 208           'name' => $this->currentElement['NAME'],
 209           'date' => $this->currentElement['DATE'],
 210           'client_id' => $this->clientMap[$this->currentElement['CLIENT_ID']],
 211           'discount' => $this->currentElement['DISCOUNT'],
 212           'status' => $this->currentElement['STATUS']));
 213     }
 214
 215     if ($name == 'MONTHLY_QUOTA' && $this->canImport) {
 216       $this->insertMonthlyQuota($this->team_id, $this->currentElement['YEAR'], $this->currentElement['MONTH'], $this->currentElement['QUOTA']);
 217     }
 218
 219     if ($name == 'LOG_ITEM' && $this->canImport) {
 220       $this->logMap[$this->currentElement['ID']] =
 221         ttTimeHelper::insert(array(
 222           'timestamp' => $this->currentElement['TIMESTAMP'],
 223           'user_id' => $this->userMap[$this->currentElement['USER_ID']],
 224           'date' => $this->currentElement['DATE'],
 225           'start' => $this->currentElement['START'],
 226           'finish' => $this->currentElement['FINISH'],
 227           'duration' => $this->currentElement['DURATION'],
 228           'client' => $this->clientMap[$this->currentElement['CLIENT_ID']],
 229           'project' => $this->projectMap[$this->currentElement['PROJECT_ID']],
 230           'task' => $this->taskMap[$this->currentElement['TASK_ID']],
 231           'invoice' => $this->invoiceMap[$this->currentElement['INVOICE_ID']],
 232           'note' => (isset($this->currentElement['COMMENT']) ? $this->currentElement['COMMENT'] : ''),
 233           'billable' => $this->currentElement['BILLABLE'],
 234           'status' => $this->currentElement['STATUS']));
 235     }
 236
 237     if ($name == 'CUSTOM_FIELD' && $this->canImport) {
 238       $this->customFieldMap[$this->currentElement['ID']] =
 239         ttCustomFieldHelper::insertField(array(
 240           'team_id' => $this->team_id,
 241           'type' => $this->currentElement['TYPE'],
 242           'label' => $this->currentElement['LABEL'],
 243           'required' => $this->currentElement['REQUIRED'],
 244           'status' => $this->currentElement['STATUS']));
 245     }
 246
 247     if ($name == 'CUSTOM_FIELD_OPTION' && $this->canImport) {
 248       $this->customFieldOptionMap[$this->currentElement['ID']] =
 249         ttCustomFieldHelper::insertOption(array(
 250           'field_id' => $this->customFieldMap[$this->currentElement['FIELD_ID']],
 251           'value' => $this->currentElement['VALUE']));
 252     }
 253
 254     if ($name == 'CUSTOM_FIELD_LOG_ENTRY' && $this->canImport) {
 255       ttCustomFieldHelper::insertLogEntry(array(
 256         'log_id' => $this->logMap[$this->currentElement['LOG_ID']],
 257         'field_id' => $this->customFieldMap[$this->currentElement['FIELD_ID']],
 258         'option_id' => $this->customFieldOptionMap[$this->currentElement['OPTION_ID']],
 259         'value' => $this->currentElement['VALUE'],
 260         'status' => $this->currentElement['STATUS']));
 261     }
 262
 263     if ($name == 'EXPENSE_ITEM' && $this->canImport) {
 264       ttExpenseHelper::insert(array(
 265         'date' => $this->currentElement['DATE'],
 266         'user_id' => $this->userMap[$this->currentElement['USER_ID']],
 267         'client_id' => $this->clientMap[$this->currentElement['CLIENT_ID']],
 268         'project_id' => $this->projectMap[$this->currentElement['PROJECT_ID']],
 269         'name' => $this->currentElement['NAME'],
 270         'cost' => $this->currentElement['COST'],
 271         'invoice_id' => $this->invoiceMap[$this->currentElement['INVOICE_ID']],
 272         'status' => $this->currentElement['STATUS']));
 273     }
 274
 275     if ($name == 'FAV_REPORT' && $this->canImport) {
 276       $user_list = '';
 277       if (strlen($this->currentElement['USERS']) > 0) {
 278         $arr = explode(',', $this->currentElement['USERS']);
 279         foreach ($arr as $v)
 280           $user_list .= (strlen($user_list) == 0 ? '' : ',').$this->userMap[$v];
 281       }
 282       ttFavReportHelper::insertReport(array(
 283         'name' => $this->currentElement['NAME'],
 284         'user_id' => $this->userMap[$this->currentElement['USER_ID']],
 285         'client' => $this->clientMap[$this->currentElement['CLIENT_ID']],
 286         'option' => $this->customFieldOptionMap[$this->currentElement['CF_1_OPTION_ID']],
 287         'project' => $this->projectMap[$this->currentElement['PROJECT_ID']],
 288         'task' => $this->taskMap[$this->currentElement['TASK_ID']],
 289         'billable' => $this->currentElement['BILLABLE'],
 290         'users' => $user_list,
 291         'period' => $this->currentElement['PERIOD'],
 292         'from' => $this->currentElement['PERIOD_START'],
 293         'to' => $this->currentElement['PERIOD_END'],
 294         'chclient' => $this->currentElement['SHOW_CLIENT'],
 295         'chinvoice' => $this->currentElement['SHOW_INVOICE'],
 296         'chproject' => $this->currentElement['SHOW_PROJECT'],
 297         'chstart' => $this->currentElement['SHOW_START'],
 298         'chduration' => $this->currentElement['SHOW_DURATION'],
 299         'chcost' => $this->currentElement['SHOW_COST'],
 300         'chtask' => $this->currentElement['SHOW_TASK'],
 301         'chfinish' => $this->currentElement['SHOW_END'],
 302         'chnote' => $this->currentElement['SHOW_NOTE'],
 303         'chcf_1' => $this->currentElement['SHOW_CUSTOM_FIELD_1'],
 304         'group_by' => $this->currentElement['GROUP_BY'],
 305         'chtotalsonly' => $this->currentElement['SHOW_TOTALS_ONLY']));
 306     }
 307     $this->currentTag = '';
 308   }
 309
 310   // dataElement - callback handler for text data fragments. It builds up currentElement array with text pieces from XML.
 311   function dataElement($parser, $data) {
 312     if ($this->currentTag == 'NAME'
 313       || $this->currentTag == 'DESCRIPTION'
 314       || $this->currentTag == 'LABEL'
 315       || $this->currentTag == 'VALUE'
 316       || $this->currentTag == 'COMMENT'
 317       || $this->currentTag == 'ADDRESS'
 318       || $this->currentTag == 'CLIENT_NAME'
 319       || $this->currentTag == 'CLIENT_ADDRESS') {
 320       if (isset($this->currentElement[$this->currentTag]))
 321         $this->currentElement[$this->currentTag] .= trim($data);
 322       else
 323         $this->currentElement[$this->currentTag] = trim($data);
 324     }
 325   }
 326
 327   // importXml - uncompresses the file, reads and parses its content. During parsing,
 328   // startElement, endElement, and dataElement functions are called as many times as necessary.
 329   // Actual import occurs in the endElement handler.
 330   function importXml() {
 331     // Do we have a compressed file?
 332     $compressed = false;
 333     $file_ext = substr($_FILES['xmlfile']['name'], strrpos($_FILES['xmlfile']['name'], '.') + 1);
 334     if (in_array($file_ext, array('bz','tbz','bz2','tbz2'))) {
 335       $compressed = true;
 336     }
 337
 338     // Create a temporary file.
 339     $dirName = dirname(TEMPLATE_DIR . '_c/.');
 340     $filename = tempnam($dirName, 'import_');
 341
 342     // If the file is compressed - uncompress it.
 343     if ($compressed) {
 344       if (!$this->uncompress($_FILES['xmlfile']['tmp_name'], $filename)) {
 345         $this->errors->add($GLOBALS['I18N']->getKey('error.sys'));
 346         return;
 347       }
 348       unlink($_FILES['xmlfile']['tmp_name']);
 349     } else {
 350       if (!move_uploaded_file($_FILES['xmlfile']['tmp_name'], $filename)) {
 351         $this->errors->add($GLOBALS['I18N']->getKey('error.upload'));
 352         return;
 353       }
 354     }
 355
 356     // Initialize XML parser.
 357     $parser = xml_parser_create();
 358     xml_set_object($parser, $this);
 359     xml_set_element_handler($parser, 'startElement', 'endElement');
 360     xml_set_character_data_handler($parser, 'dataElement');
 361
 362     // Read and parse the content of the file. During parsing, startElement, endElement, and dataElement functions are called.
 363     $file = fopen($filename, 'r');
 364     while ($data = fread($file, 4096)) {
 365       if (!xml_parse($parser, $data, feof($file))) {
 366         $this->errors->add(sprintf("XML error: %s at line %d",
 367           xml_error_string(xml_get_error_code($parser)),
 368           xml_get_current_line_number($parser)));
 369       }
 370       if (!$this->canImport) {
 371         $this->errors->add($GLOBALS['I18N']->getKey('error.user_exists'));
 372         break;
 373       }
 374     }
 375     xml_parser_free($parser);
 376     if ($file) fclose($file);
 377     unlink($filename);
 378   }
 379
 380   // uncompress - uncompresses the content of the $in file into the $out file.
 381   function uncompress($in, $out) {
 382     // Do we have the uncompress function?
 383     if (!function_exists('bzopen'))
 384       return false;
 385
 386     // Initial checks of file names and permissions.
 387     if (!file_exists($in) || !is_readable ($in))
 388       return false;
 389     if ((!file_exists($out) && !is_writable(dirname($out))) || (file_exists($out) && !is_writable($out)))
 390       return false;
 391
 392     if (!$out_file = fopen($out, 'wb'))
 393       return false;
 394     if (!$in_file = bzopen ($in, 'r'))
 395       return false;
 396
 397     while (!feof($in_file)) {
 398       $buffer = bzread($in_file, 4096);
 399       fwrite($out_file, $buffer, 4096);
 400     }
 401     bzclose($in_file);
 402     fclose ($out_file);
 403     return true;
 404   }
 405
 406   // insertMonthlyQuota - a helper function to insert a monthly quota.
 407   private function insertMonthlyQuota($team_id, $year, $month, $quota) {
 408     $mdb2 = getConnection();
 409     $sql = "INSERT INTO tt_monthly_quotas (team_id, year, month, quota) values ($team_id, $year, $month, $quota)";
 410     $affected = $mdb2->exec($sql);
 411     return (!is_a($affected, 'PEAR_Error'));
 412   }
 413 }