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