7fa1e28309b549b6fe7b531fb97ae627079d0de5
[timetracker.git] / 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               'description' => $role_item['DESCRIPTION'],
158               'rank' => $role_item['RANK'],
159               'rights' => $role_item['RIGHTS'],
160               'status' => $role_item['STATUS']));
161             $this->roleMap[$role_item['ID']] = $role_id;
162           }
163
164           foreach ($this->users as $key=>$user_item) {
165             $role_id = $user_item['ROLE_ID'] === '0' ? $this->top_role_id :  $this->roleMap[$user_item['ROLE_ID']]; // 0 (not null) means top manager role.
166             $user_id = ttUserHelper::insert(array(
167               'group_id' => $this->group_id,
168               'org_id' => $this->org_id,
169               'role_id' => $role_id,
170               'client_id' => $user_item['CLIENT_ID'], // Note: NOT mapped value, replaced in CLIENT handler.
171               'name' => $user_item['NAME'],
172               'login' => $user_item['LOGIN'],
173               'password' => $user_item['PASSWORD'],
174               'rate' => $user_item['RATE'],
175               'email' => $user_item['EMAIL'],
176               'status' => $user_item['STATUS']), false);
177             $this->userMap[$key] = $user_id;
178           }
179         }
180       }
181     }
182
183     if ($name == 'TASK' && $this->canImport) {
184       $this->taskMap[$this->currentElement['ID']] =
185         ttTaskHelper::insert(array(
186           'group_id' => $this->group_id,
187           'org_id' => $this->org_id,
188           'name' => $this->currentElement['NAME'],
189           'description' => $this->currentElement['DESCRIPTION'],
190           'status' => $this->currentElement['STATUS']));
191     }
192     if ($name == 'PROJECT' && $this->canImport) {
193       // Prepare a list of task ids.
194       $tasks = explode(',', $this->currentElement['TASKS']);
195       foreach ($tasks as $id)
196         $mapped_tasks[] = $this->taskMap[$id];
197
198       // Add a new project.
199       $this->projectMap[$this->currentElement['ID']] =
200         ttProjectHelper::insert(array(
201           'group_id' => $this->group_id,
202           'org_id' => $this->org_id,
203           'name' => $this->currentElement['NAME'],
204           'description' => $this->currentElement['DESCRIPTION'],
205           'tasks' => $mapped_tasks,
206           'status' => $this->currentElement['STATUS']));
207     }
208     if ($name == 'USER_PROJECT_BIND' && $this->canImport) {
209       ttUserHelper::insertBind(array(
210         'user_id' => $this->userMap[$this->currentElement['USER_ID']],
211         'project_id' => $this->projectMap[$this->currentElement['PROJECT_ID']],
212         'group_id' => $this->group_id,
213         'org_id' => $this->org_id,
214         'rate' => $this->currentElement['RATE'],
215         'status' => $this->currentElement['STATUS']));
216     }
217
218     if ($name == 'CLIENT' && $this->canImport) {
219       // Prepare a list of project ids.
220       if ($this->currentElement['PROJECTS']) {
221         $projects = explode(',', $this->currentElement['PROJECTS']);
222         foreach ($projects as $id)
223           $mapped_projects[] = $this->projectMap[$id];
224       }
225
226       $this->clientMap[$this->currentElement['ID']] =
227         ttClientHelper::insert(array(
228           'group_id' => $this->group_id,
229           'org_id' => $this->org_id,
230           'name' => $this->currentElement['NAME'],
231           'address' => $this->currentElement['ADDRESS'],
232           'tax' => $this->currentElement['TAX'],
233           'projects' => $mapped_projects,
234           'status' => $this->currentElement['STATUS']));
235
236         // Update client_id for tt_users to a mapped value.
237         // We did not do it during user insertion because clientMap was not ready then.
238         if ($this->currentElement['ID'] != $this->clientMap[$this->currentElement['ID']])
239           ttClientHelper::setMappedClient($this->group_id, $this->currentElement['ID'], $this->clientMap[$this->currentElement['ID']]);
240     }
241
242     if ($name == 'INVOICE' && $this->canImport) {
243       $this->invoiceMap[$this->currentElement['ID']] =
244         ttInvoiceHelper::insert(array(
245           'group_id' => $this->group_id,
246           'org_id' => $this->org_id,
247           'name' => $this->currentElement['NAME'],
248           'date' => $this->currentElement['DATE'],
249           'client_id' => $this->clientMap[$this->currentElement['CLIENT_ID']],
250           'status' => $this->currentElement['STATUS']));
251     }
252
253     if ($name == 'MONTHLY_QUOTA' && $this->canImport) {
254       $this->insertMonthlyQuota($this->group_id, $this->currentElement['YEAR'], $this->currentElement['MONTH'], $this->currentElement['MINUTES']);
255     }
256
257     if ($name == 'LOG_ITEM' && $this->canImport) {
258       $this->logMap[$this->currentElement['ID']] =
259         ttTimeHelper::insert(array(
260           'user_id' => $this->userMap[$this->currentElement['USER_ID']],
261           'group_id' => $this->group_id,
262           'org_id' => $this->org_id,
263           'date' => $this->currentElement['DATE'],
264           'start' => $this->currentElement['START'],
265           'finish' => $this->currentElement['FINISH'],
266           'duration' => $this->currentElement['DURATION'],
267           'client' => $this->clientMap[$this->currentElement['CLIENT_ID']],
268           'project' => $this->projectMap[$this->currentElement['PROJECT_ID']],
269           'task' => $this->taskMap[$this->currentElement['TASK_ID']],
270           'invoice' => $this->invoiceMap[$this->currentElement['INVOICE_ID']],
271           'note' => (isset($this->currentElement['COMMENT']) ? $this->currentElement['COMMENT'] : ''),
272           'billable' => $this->currentElement['BILLABLE'],
273           'paid' => $this->currentElement['PAID'],
274           'status' => $this->currentElement['STATUS']));
275     }
276
277     if ($name == 'CUSTOM_FIELD' && $this->canImport) {
278       $this->customFieldMap[$this->currentElement['ID']] =
279         ttCustomFieldHelper::insertField(array(
280           'group_id' => $this->group_id,
281           'type' => $this->currentElement['TYPE'],
282           'label' => $this->currentElement['LABEL'],
283           'required' => $this->currentElement['REQUIRED'],
284           'status' => $this->currentElement['STATUS']));
285     }
286
287     if ($name == 'CUSTOM_FIELD_OPTION' && $this->canImport) {
288       $this->customFieldOptionMap[$this->currentElement['ID']] =
289         ttCustomFieldHelper::insertOption(array(
290           'field_id' => $this->customFieldMap[$this->currentElement['FIELD_ID']],
291           'value' => $this->currentElement['VALUE']));
292     }
293
294     if ($name == 'CUSTOM_FIELD_LOG_ENTRY' && $this->canImport) {
295       ttCustomFieldHelper::insertLogEntry(array(
296         'log_id' => $this->logMap[$this->currentElement['LOG_ID']],
297         'field_id' => $this->customFieldMap[$this->currentElement['FIELD_ID']],
298         'option_id' => $this->customFieldOptionMap[$this->currentElement['OPTION_ID']],
299         'value' => $this->currentElement['VALUE'],
300         'status' => $this->currentElement['STATUS']));
301     }
302
303     if ($name == 'EXPENSE_ITEM' && $this->canImport) {
304       ttExpenseHelper::insert(array(
305         'date' => $this->currentElement['DATE'],
306         'user_id' => $this->userMap[$this->currentElement['USER_ID']],
307         'group_id' => $this->group_id,
308         'client_id' => $this->clientMap[$this->currentElement['CLIENT_ID']],
309         'project_id' => $this->projectMap[$this->currentElement['PROJECT_ID']],
310         'name' => $this->currentElement['NAME'],
311         'cost' => $this->currentElement['COST'],
312         'invoice_id' => $this->invoiceMap[$this->currentElement['INVOICE_ID']],
313         'paid' => $this->currentElement['PAID'],
314         'status' => $this->currentElement['STATUS']));
315     }
316
317     if ($name == 'FAV_REPORT' && $this->canImport) {
318       $user_list = '';
319       if (strlen($this->currentElement['USERS']) > 0) {
320         $arr = explode(',', $this->currentElement['USERS']);
321         foreach ($arr as $v)
322           $user_list .= (strlen($user_list) == 0 ? '' : ',').$this->userMap[$v];
323       }
324       ttFavReportHelper::insertReport(array(
325         'name' => $this->currentElement['NAME'],
326         'user_id' => $this->userMap[$this->currentElement['USER_ID']],
327         'client' => $this->clientMap[$this->currentElement['CLIENT_ID']],
328         'option' => $this->customFieldOptionMap[$this->currentElement['CF_1_OPTION_ID']],
329         'project' => $this->projectMap[$this->currentElement['PROJECT_ID']],
330         'task' => $this->taskMap[$this->currentElement['TASK_ID']],
331         'billable' => $this->currentElement['BILLABLE'],
332         'users' => $user_list,
333         'period' => $this->currentElement['PERIOD'],
334         'from' => $this->currentElement['PERIOD_START'],
335         'to' => $this->currentElement['PERIOD_END'],
336         'chclient' => (int) $this->currentElement['SHOW_CLIENT'],
337         'chinvoice' => (int) $this->currentElement['SHOW_INVOICE'],
338         'chpaid' => (int) $this->currentElement['SHOW_PAID'],
339         'chip' => (int) $this->currentElement['SHOW_IP'],
340         'chproject' => (int) $this->currentElement['SHOW_PROJECT'],
341         'chstart' => (int) $this->currentElement['SHOW_START'],
342         'chduration' => (int) $this->currentElement['SHOW_DURATION'],
343         'chcost' => (int) $this->currentElement['SHOW_COST'],
344         'chtask' => (int) $this->currentElement['SHOW_TASK'],
345         'chfinish' => (int) $this->currentElement['SHOW_END'],
346         'chnote' => (int) $this->currentElement['SHOW_NOTE'],
347         'chcf_1' => (int) $this->currentElement['SHOW_CUSTOM_FIELD_1'],
348         'chunits' => (int) $this->currentElement['SHOW_WORK_UNITS'],
349         'group_by1' => $this->currentElement['GROUP_BY1'],
350         'group_by2' => $this->currentElement['GROUP_BY2'],
351         'group_by3' => $this->currentElement['GROUP_BY3'],
352         'chtotalsonly' => (int) $this->currentElement['SHOW_TOTALS_ONLY']));
353     }
354     $this->currentTag = '';
355   }
356
357   // dataElement - callback handler for text data fragments. It builds up currentElement array with text pieces from XML.
358   function dataElement($parser, $data) {
359     if ($this->currentTag == 'NAME'
360       || $this->currentTag == 'DESCRIPTION'
361       || $this->currentTag == 'LABEL'
362       || $this->currentTag == 'VALUE'
363       || $this->currentTag == 'COMMENT'
364       || $this->currentTag == 'ADDRESS'
365       || $this->currentTag == 'ALLOW_IP'
366       || $this->currentTag == 'PASSWORD_COMPLEXITY') {
367       if (isset($this->currentElement[$this->currentTag]))
368         $this->currentElement[$this->currentTag] .= trim($data);
369       else
370         $this->currentElement[$this->currentTag] = trim($data);
371     }
372   }
373
374   // importXml - uncompresses the file, reads and parses its content. During parsing,
375   // startElement, endElement, and dataElement functions are called as many times as necessary.
376   // Actual import occurs in the endElement handler.
377   function importXml() {
378     global $i18n;
379
380     // Do we have a compressed file?
381     $compressed = false;
382     $file_ext = substr($_FILES['xmlfile']['name'], strrpos($_FILES['xmlfile']['name'], '.') + 1);
383     if (in_array($file_ext, array('bz','tbz','bz2','tbz2'))) {
384       $compressed = true;
385     }
386
387     // Create a temporary file.
388     $dirName = dirname(TEMPLATE_DIR . '_c/.');
389     $filename = tempnam($dirName, 'import_');
390
391     // If the file is compressed - uncompress it.
392     if ($compressed) {
393       if (!$this->uncompress($_FILES['xmlfile']['tmp_name'], $filename)) {
394         $this->errors->add($i18n->get('error.sys'));
395         return;
396       }
397       unlink($_FILES['xmlfile']['tmp_name']);
398     } else {
399       if (!move_uploaded_file($_FILES['xmlfile']['tmp_name'], $filename)) {
400         $this->errors->add($i18n->get('error.upload'));
401         return;
402       }
403     }
404
405     // Initialize XML parser.
406     $parser = xml_parser_create();
407     xml_set_object($parser, $this);
408     xml_set_element_handler($parser, 'startElement', 'endElement');
409     xml_set_character_data_handler($parser, 'dataElement');
410
411     // Read and parse the content of the file. During parsing, startElement, endElement, and dataElement functions are called.
412     $file = fopen($filename, 'r');
413     while ($data = fread($file, 4096)) {
414       if (!xml_parse($parser, $data, feof($file))) {
415         $this->errors->add(sprintf("XML error: %s at line %d",
416           xml_error_string(xml_get_error_code($parser)),
417           xml_get_current_line_number($parser)));
418       }
419       if (!$this->canImport) {
420         $this->errors->add($i18n->get('error.user_exists'));
421         break;
422       }
423     }
424     xml_parser_free($parser);
425     if ($file) fclose($file);
426     unlink($filename);
427   }
428
429   // uncompress - uncompresses the content of the $in file into the $out file.
430   function uncompress($in, $out) {
431     // Do we have the uncompress function?
432     if (!function_exists('bzopen'))
433       return false;
434
435     // Initial checks of file names and permissions.
436     if (!file_exists($in) || !is_readable ($in))
437       return false;
438     if ((!file_exists($out) && !is_writable(dirname($out))) || (file_exists($out) && !is_writable($out)))
439       return false;
440
441     if (!$out_file = fopen($out, 'wb'))
442       return false;
443     if (!$in_file = bzopen ($in, 'r'))
444       return false;
445
446     while (!feof($in_file)) {
447       $buffer = bzread($in_file, 4096);
448       fwrite($out_file, $buffer, 4096);
449     }
450     bzclose($in_file);
451     fclose ($out_file);
452     return true;
453   }
454
455   // createGroup function creates a new group.
456   private function createGroup($fields) {
457
458     global $user;
459     $mdb2 = getConnection();
460
461     $columns = '(name, currency, decimal_mark, lang, date_format, time_format, week_start, tracking_mode'.
462       ', project_required, task_required, record_type, bcc_email, allow_ip, password_complexity, plugins'.
463       ', lock_spec, workday_minutes, config, created, created_ip, created_by)';
464
465     $values = ' values ('.$mdb2->quote(trim($fields['name']));
466     $values .= ', '.$mdb2->quote(trim($fields['currency']));
467     $values .= ', '.$mdb2->quote($fields['decimal_mark']);
468     $values .= ', '.$mdb2->quote($fields['lang']);
469     $values .= ', '.$mdb2->quote($fields['date_format']);
470     $values .= ', '.$mdb2->quote($fields['time_format']);
471     $values .= ', '.(int)$fields['week_start'];
472     $values .= ', '.(int)$fields['tracking_mode'];
473     $values .= ', '.(int)$fields['project_required'];
474     $values .= ', '.(int)$fields['task_required'];
475     $values .= ', '.(int)$fields['record_type'];
476     $values .= ', '.$mdb2->quote($fields['bcc_email']);
477     $values .= ', '.$mdb2->quote($fields['allow_ip']);
478     $values .= ', '.$mdb2->quote($fields['password_complexity']);
479     $values .= ', '.$mdb2->quote($fields['plugins']);
480     $values .= ', '.$mdb2->quote($fields['lock_spec']);
481     $values .= ', '.(int)$fields['workday_minutes'];
482     $values .= ', '.$mdb2->quote($fields['config']);
483     $values .= ', now(), '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', '.$mdb2->quote($user->id);
484     $values .= ')';
485
486     $sql = 'insert into tt_groups '.$columns.$values;
487     $affected = $mdb2->exec($sql);
488     if (is_a($affected, 'PEAR_Error')) return false;
489
490     $group_id = $mdb2->lastInsertID('tt_groups', 'id');
491
492     // Update org_id with group_id.
493     // NOTE: Both export and import need an additional effort to properly operate on subgroups.
494     // Currently we are importing one group only, which becomes a top level group.
495     $sql = "update tt_groups set org_id = $group_id where org_id is NULL and id = $group_id";
496     $affected = $mdb2->exec($sql);
497     if (is_a($affected, 'PEAR_Error')) return false;
498
499     return $group_id;
500   }
501
502   // insertMonthlyQuota - a helper function to insert a monthly quota.
503   private function insertMonthlyQuota($group_id, $year, $month, $minutes) {
504     $mdb2 = getConnection();
505     $sql = "INSERT INTO tt_monthly_quotas (group_id, year, month, minutes) values ($group_id, $year, $month, $minutes)";
506     $affected = $mdb2->exec($sql);
507     return (!is_a($affected, 'PEAR_Error'));
508   }
509 }