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