var $firstPass = true; // True during first pass through the file.
var $org_id = null; // Organization id (same as top group_id).
var $current_group_id = null; // Current group id during parsing.
- var $current_parent_group_id = null; // Current parent group id during parsing.
+ var $parents = array(); // A stack of parent group ids for current group all the way to the root including self.
var $top_role_id = 0; // Top role id.
// Entity maps for current group. They map XML ids with database ids.
if ($name == 'GROUP') {
// Create a new group.
$this->current_group_id = $this->createGroup(array(
- 'parent_id' => $this->current_parent_group_id,
+ 'parent_id' => $this->current_group_id, // Note: after insert current_group_id changes.
'org_id' => $this->org_id,
'name' => $attrs['NAME'],
'description' => $attrs['DESCRIPTION'],
$sql = "update tt_groups set org_id = $this->current_group_id where org_id is NULL and id = $this->current_group_id";
$affected = $mdb2->exec($sql);
}
- // Set parent group to create subgroups with this group as parent at next entry here.
- $this->current_parent_group_id = $this->current_group_id;
- return;
- }
-
- if ($name == 'ROLES') {
- // If we get here, we have to recycle $currentGroupRoleMap.
- unset($this->currentGroupRoleMap);
- $this->currentGroupRoleMap = array();
- // Role map is reconstructed after processing <role> elements in XML. See below.
+ // Add self to parent stack.
+ array_push($this->parents, $this->current_group_id);
+
+ // Recycle all maps as we are starting to work on new group.
+ // Note that for this to work properly all nested groups must be last entries in xml for each group.
+ unset($this->currentGroupRoleMap); $this->currentGroupRoleMap = array();
+ unset($this->currentGroupTaskMap); $this->currentGroupTaskMap = array();
+ unset($this->currentGroupProjectMap); $this->currentGroupProjectMap = array();
+ unset($this->currentGroupClientMap); $this->currentGroupClientMap = array();
+ unset($this->currentGroupUserMap); $this->currentGroupUserMap = array();
+ unset($this->currentGroupInvoiceMap); $this->currentGroupInvoiceMap = array();
+ unset($this->currentGroupLogMap); $this->currentGroupLogMap = array();
+ unset($this->currentGroupCustomFieldMap); $this->currentGroupCustomFieldMap = array();
+ unset($this->currentGroupCustomFieldOptionMap); $this->currentGroupCustomFieldOptionMap = array();
+ unset($this->currentGroupFavReportMap); $this->currentGroupCustomFavReportMap = array();
return;
}
return;
}
- if ($name == 'TASKS') {
- // If we get here, we have to recycle $currentGroupTaskMap.
- unset($this->currentGroupTaskMap);
- $this->currentGroupTaskMap = array();
- // Task map is reconstructed after processing <task> elements in XML. See below.
- return;
- }
-
if ($name == 'TASK') {
// We get here when processing <task> tags for the current group.
$task_id = ttTaskHelper::insert(array(
if ($task_id) {
// Add a mapping.
$this->currentGroupTaskMap[$attrs['ID']] = $task_id;
- } else $this->errors->add($i18n->get('error.db'));
- return;
- }
-
- if ($name == 'PROJECTS') {
- // If we get here, we have to recycle $currentGroupProjectMap.
- unset($this->currentGroupProjectMap);
- $this->currentGroupProjectMap = array();
- // Project map is reconstructed after processing <project> elements in XML. See below.
+ } else {
+ $this->errors->add($i18n->get('error.db'));
+ }
return;
}
if ($project_id) {
// Add a mapping.
$this->currentGroupProjectMap[$attrs['ID']] = $project_id;
- } else $this->errors->add($i18n->get('error.db'));
- return;
- }
-
- if ($name == 'CLIENTS') {
- // If we get here, we have to recycle $currentGroupClientMap.
- unset($this->currentGroupClientMap);
- $this->currentGroupClientMap = array();
- // Client map is reconstructed after processing <client> elements in XML. See below.
+ } else {
+ $this->errors->add($i18n->get('error.db'));
+ }
return;
}
return;
}
- if ($name == 'USERS') {
- // If we get here, we have to recycle $currentGroupUserMap.
- unset($this->currentGroupUserMap);
- $this->currentGroupUserMap = array();
- // User map is reconstructed after processing <user> elements in XML. See below.
- return;
- }
-
if ($name == 'USER') {
// We get here when processing <user> tags for the current group.
return;
}
- if ($name == 'INVOICES') {
- // If we get here, we have to recycle $currentGroupInvoiceMap.
- unset($this->currentGroupInvoiceMap);
- $this->currentGroupInvoiceMap = array();
- // Invoice map is reconstructed after processing <invoice> elements in XML. See below.
- return;
- }
-
if ($name == 'INVOICE') {
// We get here when processing <invoice> tags for the current group.
$invoice_id = ttInvoiceHelper::insert(array(
return;
}
- if ($name == 'LOG') {
- // If we get here, we have to recycle $currentGroupLogMap.
- unset($this->currentGroupLogMap);
- $this->currentGroupLogMap = array();
- // Log map is reconstructed after processing <log_item> elements in XML. See below.
- return;
- }
-
if ($name == 'LOG_ITEM') {
// We get here when processing <log_item> tags for the current group.
- $log_item_id = ttTimeHelper::insert(array(
+ $log_item_id = $this->insertLogEntry(array(
'user_id' => $this->currentGroupUserMap[$attrs['USER_ID']],
'group_id' => $this->current_group_id,
'org_id' => $this->org_id,
'start' => $attrs['START'],
'finish' => $attrs['FINISH'],
'duration' => $attrs['DURATION'],
- 'client' => $this->currentGroupClientMap[$attrs['CLIENT_ID']],
- 'project' => $this->currentGroupProjectMap[$attrs['PROJECT_ID']],
- 'task' => $this->currentGroupTaskMap[$attrs['TASK_ID']],
- 'invoice' => $this->currentGroupInvoiceMap[$attrs['INVOICE_ID']],
- 'note' => (isset($attrs['COMMENT']) ? $attrs['COMMENT'] : ''),
+ 'client_id' => $this->currentGroupClientMap[$attrs['CLIENT_ID']],
+ 'project_id' => $this->currentGroupProjectMap[$attrs['PROJECT_ID']],
+ 'task_id' => $this->currentGroupTaskMap[$attrs['TASK_ID']],
+ 'invoice_id' => $this->currentGroupInvoiceMap[$attrs['INVOICE_ID']],
+ 'comment' => (isset($attrs['COMMENT']) ? $attrs['COMMENT'] : ''),
'billable' => $attrs['BILLABLE'],
'paid' => $attrs['PAID'],
'status' => $attrs['STATUS']));
return;
}
- if ($name == 'CUSTOM_FIELDS') {
- // If we get here, we have to recycle $currentGroupCustomFieldMap.
- unset($this->currentGroupCustomFieldMap);
- $this->currentGroupCustomFieldMap = array();
- // Custom field map is reconstructed after processing <custom_field> elements in XML. See below.
- return;
- }
-
if ($name == 'CUSTOM_FIELD') {
// We get here when processing <custom_field> tags for the current group.
$custom_field_id = $this->insertCustomField(array(
return;
}
- if ($name == 'CUSTOM_FIELD_OPTIONS') {
- // If we get here, we have to recycle $currentGroupCustomFieldOptionMap.
- unset($this->currentGroupCustomFieldOptionMap);
- $this->currentGroupCustomFieldOptionMap = array();
- // Custom field option map is reconstructed after processing <custom_field_option> elements in XML. See below.
- return;
- }
-
if ($name == 'CUSTOM_FIELD_OPTION') {
// We get here when processing <custom_field_option> tags for the current group.
$custom_field_option_id = $this->insertCustomFieldOption(array(
return;
}
- if ($name == 'FAV_REPORTS') {
- // If we get here, we have to recycle $currentGroupFavReportMap.
- unset($this->currentGroupFavReportMap);
- $this->currentGroupFavReportMap = array();
- // Favorite report map is reconstructed after processing <fav_report> elements in XML. See below.
- return;
- }
-
if ($name == 'FAV_REPORT') {
$user_list = '';
if (strlen($attrs['USERS']) > 0) {
}
}
+ // endElement - callback handler for ending tags in XML.
+ // We use this only for process </group> element endings and
+ // set current_group_id to an immediate parent.
+ // This is required to import group hierarchy correctly.
+ function endElement($parser, $name) {
+ // No need to care about first or second pass, as this is used only in second pass.
+ // See 2nd xml_set_element_handler, where this handler is set.
+ if ($name == 'GROUP') {
+ // Remove self from the parent stack.
+ $self = array_pop($this->parents);
+ // Set current group id to an immediate parent.
+ $len = count($this->parents);
+ $this->current_group_id = $len ? $this->parents[$len-1] : null;
+ }
+ }
+
// importXml - uncompresses the file, reads and parses its content. During parsing,
// startElement, endElement, and dataElement functions are called as many times as necessary.
// Actual import occurs in the endElement handler.
// Initialize XML parser.
$parser = xml_parser_create();
xml_set_object($parser, $this);
- xml_set_element_handler($parser, 'startElement', false);
+ xml_set_element_handler($parser, 'startElement', false); // No need to process end tags in 1st pass.
// We need to parse the file 2 times:
// 1) First pass: determine if import is possible.
// Now we can do a second pass, where real work is done.
$parser = xml_parser_create();
xml_set_object($parser, $this);
- xml_set_element_handler($parser, 'startElement', false);
+ xml_set_element_handler($parser, 'startElement', 'endElement'); // Need to process ending tags too.
- // Read and parse the content of the file. During parsing, startElement is called back for each tag.
+ // Read and parse the content of the file. During parsing, startElement and endElement are called back for each tag.
$file = fopen($filename, 'r');
while (($data = fread($file, 4096)) && $this->errors->no()) {
if (!xml_parse($parser, $data, feof($file))) {
return $last_id;
}
+ // insertLogEntry - a helper function to insert a time log entry.
+ private function insertLogEntry($fields) {
+ global $user;
+ $mdb2 = getConnection();
+
+ $group_id = (int) $fields['group_id'];
+ $org_id = (int) $fields['org_id'];
+ $user_id = (int) $fields['user_id'];
+ $date = $fields['date'];
+ $start = $fields['start'];
+ $duration = $fields['duration'];
+ $client_id = $fields['client_id'];
+ $project_id = $fields['project_id'];
+ $task_id = $fields['task_id'];
+ $invoice_id = $fields['invoice_id'];
+ $comment = $fields['comment'];
+ $billable = (int) $fields['billable'];
+ $paid = (int) $fields['paid'];
+ $status = $fields['status'];
+
+ $sql = "insert into tt_log".
+ " (user_id, group_id, org_id, date, start, duration, client_id, project_id, task_id, invoice_id, comment".
+ ", billable, paid, created, created_ip, created_by, status)".
+ " values ($user_id, $group_id, $org_id".
+ ", ".$mdb2->quote($date).
+ ", ".$mdb2->quote($start).
+ ", ".$mdb2->quote($duration).
+ ", ".$mdb2->quote($client_id).
+ ", ".$mdb2->quote($project_id).
+ ", ".$mdb2->quote($task_id).
+ ", ".$mdb2->quote($invoice_id).
+ ", ".$mdb2->quote($comment).
+ ", $billable, $paid".
+ ", now(), ".$mdb2->quote($_SERVER['REMOTE_ADDR']).", ".$mdb2->quote($user->id).
+ ", ". $mdb2->quote($status).")";
+ $affected = $mdb2->exec($sql);
+ if (is_a($affected, 'PEAR_Error')) {
+ $this->errors->add($i18n->get('error.db')); // TODO: review whether or not to add error here in all insert calls.
+ return false;
+ }
+
+ $log_id = $mdb2->lastInsertID('tt_log', 'id');
+ return $log_id;
+ }
+
// insertCustomFieldLogEntry - a helper function to insert a custom field log entry.
private function insertCustomFieldLogEntry($fields) {
$mdb2 = getConnection();