// +----------------------------------------------------------------------+
import('ttUserHelper');
-
-// ttOrgImportHelper - this class is a future replacement for ttImportHelper.
-// Currently, it is work in progress.
-// When done, it should handle import of complex groups consisting of other groups.
+import('ttRoleHelper');
+import('ttTaskHelper');
+import('ttClientHelper');
+import('ttInvoiceHelper');
+import('ttTimeHelper');
+import('ttExpenseHelper');
+import('ttFavReportHelper');
+
+// ttOrgImportHelper class is used to import organization data from an XML file
+// prepared by ttOrgExportHelper and consisting of nested groups with their info.
class ttOrgImportHelper {
- var $errors = null; // Errors go here. Set in constructor by reference.
- var $cannotImport = null; // A comma-separated string of entity names that we cannot import.
- // TODO: rename the above to something better.
-
- var $canImport = true; // False if we cannot import data due to a login collision.
+ var $errors = null; // Errors go here. Set in constructor by reference.
+ var $schema_version = null; // Database schema version from XML file we import from.
+ var $conflicting_logins = null; // A comma-separated list of logins we cannot import.
+ var $canImport = true; // False if we cannot import data due to a conflict such as login collision.
var $firstPass = true; // True during first pass through the file.
var $org_id = null; // Organization id (same as top group_id).
- var $current_parent_group_id = null; // Current parent group id as we parse the file.
- // Set when we create a new group.
- // Entities for current group.
- var $currentGroupRoles = array(); // Array of arrays of role properties.
- // var $currentGroupUsers = array(); // Array of arrays of user properties.
+ var $current_group_id = null; // Current group id during parsing.
+ var $current_parent_group_id = null; // Current parent group id during parsing.
+ var $top_role_id = 0; // Top role id.
// Entity maps for current group. They map XML ids with database ids.
- var $currentGroupRoleMap = array(); // Maps role ids from XML to their database ids.
- //var $userMap = array(); // User ids.
- //var $projectMap = array(); // Project ids.
- //var $taskMap = array(); // Task ids.
- //var $clientMap = array(); // Client ids.
- //var $invoiceMap = array(); // Invoice ids.
+ var $currentGroupRoleMap = array();
+ var $currentGroupTaskMap = array();
+ var $currentGroupProjectMap = array();
+ var $currentGroupClientMap = array();
+ var $currentGroupUserMap = array();
+ var $currentGroupInvoiceMap = array();
+ var $currentGroupLogMap = array();
+ var $currentGroupCustomFieldMap = array();
+ var $currentGroupCustomFieldOptionMap = array();
+ var $currentGroupFavReportMap = array();
// Constructor.
function __construct(&$errors) {
$this->errors = &$errors;
+ $this->top_role_id = ttRoleHelper::getRoleByRank(512, 0);
}
- // startElement - callback handler for opening tag of an XML element in the file.
+ // startElement - callback handler for opening tags in XML.
function startElement($parser, $name, $attrs) {
+ global $i18n;
- // First pass. We only check user logins for potential collisions with existing.
+ // First pass through the file determines if we can import data.
+ // We require 2 things:
+ // 1) Database schema version must be set. This ensures we have a compatible file.
+ // 2) No login coillisions are allowed.
if ($this->firstPass) {
+ if ($name == 'ORG' && $this->canImport) {
+ if ($attrs['SCHEMA'] == null) {
+ // We need (database) schema attribute to be available for import to work.
+ // Old Time Tracker export files don't have this.
+ // Current import code does not work with old format because we had to
+ // restructure data in export files for subgroup support.
+ $this->canImport = false;
+ $this->errors->add($i18n->get('error.format'));
+ return;
+ }
+ }
+
+ // In first pass we check user logins for potential collisions with existing.
if ($name == 'USER' && $this->canImport) {
$login = $attrs['LOGIN'];
if ('' != $attrs['STATUS'] && ttUserHelper::getUserByLogin($login)) {
// We have a login collision. Append colliding login to a list of things we cannot import.
- $this->cannotImport .= ($this->cannotImport ? ", $login" : $login);
+ $this->conflicting_logins .= ($this->conflicting_logins ? ", $login" : $login);
+ // The above is printed in error message with all found colliding logins.
}
}
}
// Second pass processing. We import data here, one tag at a time.
- if (!$this->firstPass && $this->canImport) {
+ if (!$this->firstPass && $this->canImport && $this->errors->no()) {
$mdb2 = getConnection();
// We are in second pass and can import data.
if ($name == 'GROUP') {
// Create a new group.
- $group_id = $this->createGroup(array(
+ $this->current_group_id = $this->createGroup(array(
'parent_id' => $this->current_parent_group_id,
'org_id' => $this->org_id,
'name' => $attrs['NAME'],
'currency' => $attrs['CURRENCY'],
- 'lang' => $attrs['LANG']));
- // We only have 3 properties at the moment, while work is ongoing...
+ 'decimal_mark' => $attrs['DECIMAL_MARK'],
+ 'lang' => $attrs['LANG'],
+ 'date_format' => $attrs['DATE_FORMAT'],
+ 'time_format' => $attrs['TIME_FORMAT'],
+ 'week_start' => $attrs['WEEK_START'],
+ 'tracking_mode' => $attrs['TRACKING_MODE'],
+ 'project_required' => $attrs['PROJECT_REQUIRED'],
+ 'task_required' => $attrs['TASK_REQUIRED'],
+ 'record_type' => $attrs['RECORD_TYPE'],
+ 'bcc_email' => $attrs['BCC_EMAIL'],
+ 'allow_ip' => $attrs['ALLOW_IP'],
+ 'password_complexity' => $attrs['PASSWORD_COMPLEXITY'],
+ 'plugins' => $attrs['PLUGINS'],
+ 'lock_spec' => $attrs['LOCK_SPEC'],
+ 'workday_minutes' => $attrs['WORKDAY_MINUTES'],
+ 'custom_logo' => $attrs['CUSTOM_LOGO'],
+ 'config' => $attrs['CONFIG']));
// Special handling for top group.
- if (!$this->org_id) {
- $this->org_id = $group_id;
- $sql = "update tt_groups set org_id = $group_id where org_id is NULL and id = $group_id";
+ if (!$this->org_id && $this->current_group_id) {
+ $this->org_id = $this->current_group_id;
+ $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);
- // TODO: design a better error handling approach for the entire import process.
}
- // Set current parent group.
- $this->current_parent_group_id = $group_id;
+ // 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 both $currentGroupRoles and $currentGroupRoleMap.
- unset($this->currentGroupRoles);
+ // If we get here, we have to recycle $currentGroupRoleMap.
unset($this->currentGroupRoleMap);
- $this->currentGroupRoles = array();
$this->currentGroupRoleMap = array();
- // Both arrays are now empty.
- // They will get reconstructed after processing of <role> elements in XML. See below.
+ // Role map is reconstructed after processing <role> elements in XML. See below.
+ return;
}
if ($name == 'ROLE') {
- // We get here when processing a <role> tag for the current group.
- // Add new role to $this->currentGroupRoles and a mapping to $this->currentGroupRoleMap.
- $this->currentGroupRoles[$attrs['ID']] = $attrs;
+ // We get here when processing <role> tags for the current group.
+ $role_id = ttRoleHelper::insert(array(
+ 'group_id' => $this->current_group_id,
+ 'org_id' => $this->org_id,
+ 'name' => $attrs['NAME'],
+ 'description' => $attrs['DESCRIPTION'],
+ 'rank' => $attrs['RANK'],
+ 'rights' => $attrs['RIGHTS'],
+ 'status' => $attrs['STATUS']));
+ if ($role_id) {
+ // Add a mapping.
+ $this->currentGroupRoleMap[$attrs['ID']] = $role_id;
+ } else $this->errors->add($i18n->get('error.db'));
+ 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(
+ 'group_id' => $this->current_group_id,
+ 'org_id' => $this->org_id,
+ 'name' => $attrs['NAME'],
+ 'description' => $attrs['DESCRIPTION'],
+ 'status' => $attrs['STATUS']));
+ 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.
+ return;
+ }
+
+ if ($name == 'PROJECT') {
+ // We get here when processing <project> tags for the current group.
+
+ // Prepare a list of task ids.
+ if ($attrs['TASKS']) {
+ $tasks = explode(',', $attrs['TASKS']);
+ foreach ($tasks as $id)
+ $mapped_tasks[] = $this->currentGroupTaskMap[$id];
+ }
+
+ $project_id = $this->insertProject(array(
+ 'group_id' => $this->current_group_id,
+ 'org_id' => $this->org_id,
+ 'name' => $attrs['NAME'],
+ 'description' => $attrs['DESCRIPTION'],
+ 'tasks' => $mapped_tasks,
+ 'status' => $attrs['STATUS']));
+ 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.
+ return;
+ }
+
+ if ($name == 'CLIENT') {
+ // We get here when processing <client> tags for the current group.
+
+ // Prepare a list of project ids.
+ if ($attrs['PROJECTS']) {
+ $projects = explode(',', $attrs['PROJECTS']);
+ foreach ($projects as $id)
+ $mapped_projects[] = $this->currentGroupProjectMap[$id];
+ }
+
+ $client_id = $this->insertClient(array(
+ 'group_id' => $this->current_group_id,
+ 'org_id' => $this->org_id,
+ 'name' => $attrs['NAME'],
+ 'address' => $attrs['ADDRESS'],
+ 'tax' => $attrs['TAX'],
+ 'projects' => $mapped_projects,
+ 'status' => $attrs['STATUS']));
+ if ($client_id) {
+ // Add a mapping.
+ $this->currentGroupClientMap[$attrs['ID']] = $client_id;
+ } else $this->errors->add($i18n->get('error.db'));
+ 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.
+
+ $role_id = $attrs['ROLE_ID'] === '0' ? $this->top_role_id : $this->currentGroupRoleMap[$attrs['ROLE_ID']]; // 0 (not null) means top manager role.
+
+ $user_id = ttUserHelper::insert(array(
+ 'group_id' => $this->current_group_id,
+ 'org_id' => $this->org_id,
+ 'role_id' => $role_id,
+ 'client_id' => $this->currentGroupClientMap[$attrs['CLIENT_ID']],
+ 'name' => $attrs['NAME'],
+ 'login' => $attrs['LOGIN'],
+ 'password' => $attrs['PASSWORD'],
+ 'rate' => $attrs['RATE'],
+ 'email' => $attrs['EMAIL'],
+ 'status' => $attrs['STATUS']), false);
+ if ($user_id) {
+ // Add a mapping.
+ $this->currentGroupUserMap[$attrs['ID']] = $user_id;
+ } else $this->errors->add($i18n->get('error.db'));
+ return;
+ }
+
+ if ($name == 'USER_PROJECT_BIND') {
+ if (!ttUserHelper::insertBind(array(
+ 'user_id' => $this->currentGroupUserMap[$attrs['USER_ID']],
+ 'project_id' => $this->currentGroupProjectMap[$attrs['PROJECT_ID']],
+ 'group_id' => $this->current_group_id,
+ 'org_id' => $this->org_id,
+ 'rate' => $attrs['RATE'],
+ 'status' => $attrs['STATUS']))) {
+ $this->errors->add($i18n->get('error.db'));
+ }
+ 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(
+ 'group_id' => $this->current_group_id,
+ 'org_id' => $this->org_id,
+ 'name' => $attrs['NAME'],
+ 'date' => $attrs['DATE'],
+ 'client_id' => $this->currentGroupClientMap[$attrs['CLIENT_ID']],
+ 'status' => $attrs['STATUS']));
+ if ($invoice_id) {
+ // Add a mapping.
+ $this->currentGroupInvoiceMap[$attrs['ID']] = $invoice_id;
+ } else $this->errors->add($i18n->get('error.db'));
+ 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(
+ 'user_id' => $this->currentGroupUserMap[$attrs['USER_ID']],
+ 'group_id' => $this->current_group_id,
+ 'org_id' => $this->org_id,
+ 'date' => $attrs['DATE'],
+ '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'] : ''),
+ 'billable' => $attrs['BILLABLE'],
+ 'paid' => $attrs['PAID'],
+ 'status' => $attrs['STATUS']));
+ if ($log_item_id) {
+ // Add a mapping.
+ $this->currentGroupLogMap[$attrs['ID']] = $log_item_id;
+ } else $this->errors->add($i18n->get('error.db'));
+ 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(
+ 'group_id' => $this->current_group_id,
+ 'org_id' => $this->org_id,
+ 'type' => $attrs['TYPE'],
+ 'label' => $attrs['LABEL'],
+ 'required' => $attrs['REQUIRED'],
+ 'status' => $attrs['STATUS']));
+ if ($custom_field_id) {
+ // Add a mapping.
+ $this->currentGroupCustomFieldMap[$attrs['ID']] = $custom_field_id;
+ } else $this->errors->add($i18n->get('error.db'));
+ 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(
+ 'group_id' => $this->current_group_id,
+ 'org_id' => $this->org_id,
+ 'field_id' => $this->currentGroupCustomFieldMap[$attrs['FIELD_ID']],
+ 'value' => $attrs['VALUE']));
+ if ($custom_field_option_id) {
+ // Add a mapping.
+ $this->currentGroupCustomFieldOptionMap[$attrs['ID']] = $custom_field_option_id;
+ } else $this->errors->add($i18n->get('error.db'));
+ return;
+ }
+
+ if ($name == 'CUSTOM_FIELD_LOG_ENTRY') {
+ // We get here when processing <custom_field_log_entry> tags for the current group.
+ if (!$this->insertCustomFieldLogEntry(array(
+ 'group_id' => $this->current_group_id,
+ 'org_id' => $this->org_id,
+ 'log_id' => $this->currentGroupLogMap[$attrs['LOG_ID']],
+ 'field_id' => $this->currentGroupCustomFieldMap[$attrs['FIELD_ID']],
+ 'option_id' => $this->currentGroupCustomFieldOptionMap[$attrs['OPTION_ID']],
+ 'value' => $attrs['VALUE'],
+ 'status' => $attrs['STATUS']))) {
+ $this->errors->add($i18n->get('error.db'));
+ }
+ return;
+ }
+
+ if ($name == 'EXPENSE_ITEM') {
+ // We get here when processing <expense_item> tags for the current group.
+ $expense_item_id = $this->insertExpense(array(
+ 'date' => $attrs['DATE'],
+ 'user_id' => $this->currentGroupUserMap[$attrs['USER_ID']],
+ 'group_id' => $this->current_group_id,
+ 'org_id' => $this->org_id,
+ 'client_id' => $this->currentGroupClientMap[$attrs['CLIENT_ID']],
+ 'project_id' => $this->currentGroupProjectMap[$attrs['PROJECT_ID']],
+ 'name' => $attrs['NAME'],
+ 'cost' => $attrs['COST'],
+ 'invoice_id' => $this->currentGroupInvoiceMap[$attrs['INVOICE_ID']],
+ 'paid' => $attrs['PAID'],
+ 'status' => $attrs['STATUS']));
+ if (!$expense_item_id) $this->errors->add($i18n->get('error.db'));
+ return;
+ }
+
+ if ($name == 'PREDEFINED_EXPENSE') {
+ if (!$this->insertPredefinedExpense(array(
+ 'group_id' => $this->current_group_id,
+ 'org_id' => $this->org_id,
+ 'name' => $attrs['NAME'],
+ 'cost' => $attrs['COST']))) {
+ $this->errors->add($i18n->get('error.db'));
+ }
+ return;
+ }
+
+ if ($name == 'MONTHLY_QUOTA') {
+ if (!$this->insertMonthlyQuota(array(
+ 'group_id' => $this->current_group_id,
+ 'org_id' => $this->org_id,
+ 'year' => $attrs['YEAR'],
+ 'month' => $attrs['MONTH'],
+ 'minutes' => $attrs['MINUTES']))) {
+ $this->errors->add($i18n->get('error.db'));
+ }
+ 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) {
+ $arr = explode(',', $attrs['USERS']);
+ foreach ($arr as $v)
+ $user_list .= (strlen($user_list) == 0 ? '' : ',').$this->currentGroupUserMap[$v];
+ }
+ $fav_report_id = $this->insertFavReport(array(
+ 'name' => $attrs['NAME'],
+ 'user_id' => $this->currentGroupUserMap[$attrs['USER_ID']],
+ 'group_id' => $this->current_group_id,
+ 'org_id' => $this->org_id,
+ 'client' => $this->currentGroupClientMap[$attrs['CLIENT_ID']],
+ 'option' => $this->currentGroupCustomFieldOptionMap[$attrs['CF_1_OPTION_ID']],
+ 'project' => $this->currentGroupProjectMap[$attrs['PROJECT_ID']],
+ 'task' => $this->currentGroupTaskMap[$attrs['TASK_ID']],
+ 'billable' => $attrs['BILLABLE'],
+ 'users' => $user_list,
+ 'period' => $attrs['PERIOD'],
+ 'from' => $attrs['PERIOD_START'],
+ 'to' => $attrs['PERIOD_END'],
+ 'chclient' => (int) $attrs['SHOW_CLIENT'],
+ 'chinvoice' => (int) $attrs['SHOW_INVOICE'],
+ 'chpaid' => (int) $attrs['SHOW_PAID'],
+ 'chip' => (int) $attrs['SHOW_IP'],
+ 'chproject' => (int) $attrs['SHOW_PROJECT'],
+ 'chstart' => (int) $attrs['SHOW_START'],
+ 'chduration' => (int) $attrs['SHOW_DURATION'],
+ 'chcost' => (int) $attrs['SHOW_COST'],
+ 'chtask' => (int) $attrs['SHOW_TASK'],
+ 'chfinish' => (int) $attrs['SHOW_END'],
+ 'chnote' => (int) $attrs['SHOW_NOTE'],
+ 'chcf_1' => (int) $attrs['SHOW_CUSTOM_FIELD_1'],
+ 'chunits' => (int) $attrs['SHOW_WORK_UNITS'],
+ 'group_by1' => $attrs['GROUP_BY1'],
+ 'group_by2' => $attrs['GROUP_BY2'],
+ 'group_by3' => $attrs['GROUP_BY3'],
+ 'chtotalsonly' => (int) $attrs['SHOW_TOTALS_ONLY']));
+ if ($fav_report_id) {
+ // Add a mapping.
+ $this->currentGroupFavReportMap[$attrs['ID']] = $fav_report_id;
+ } else $this->errors->add($i18n->get('error.db'));
+ return;
+ }
+
+ if ($name == 'NOTIFICATION') {
+ if (!$this->insertNotification(array(
+ 'group_id' => $this->current_group_id,
+ 'org_id' => $this->org_id,
+ 'cron_spec' => $attrs['CRON_SPEC'],
+ 'last' => $attrs['LAST'],
+ 'next' => $attrs['NEXT'],
+ 'report_id' => $this->currentGroupFavReportMap[$attrs['REPORT_ID']],
+ 'email' => $attrs['EMAIL'],
+ 'cc' => $attrs['CC'],
+ 'subject' => $attrs['SUBJECT'],
+ 'report_condition' => $attrs['REPORT_CONDITION'],
+ 'status' => $attrs['STATUS']))) {
+ $this->errors->add($i18n->get('error.db'));
+ }
+ return;
+ }
+
+ if ($name == 'USER_PARAM') {
+ if (!$this->insertUserParam(array(
+ 'group_id' => $this->current_group_id,
+ 'org_id' => $this->org_id,
+ 'user_id' => $this->currentGroupUserMap[$attrs['USER_ID']],
+ 'param_name' => $attrs['PARAM_NAME'],
+ 'param_value' => $attrs['PARAM_VALUE']))) {
+ $this->errors->add($i18n->get('error.db'));
+ }
+ return;
}
}
}
xml_set_element_handler($parser, 'startElement', false);
// We need to parse the file 2 times:
- // 1) First pass: determine if import is possible - there must be no login collisions.
- // 2) Second pass: if we can import, then do import in a second pass.
- // This is different from earlier approach for single group import, where we could
- // do both things in one pass because user info was in the beginning of XML file.
- // Now, with subgroups, users can be located anywhere in the file.
+ // 1) First pass: determine if import is possible.
+ // 2) Second pass: import data, one tag at a time.
- // Read and parse the content of the file. During parsing, startElement, endElement, and dataElement functions are called.
+ // Read and parse the content of the file. During parsing, startElement is called back for each tag.
$file = fopen($filename, 'r');
- while ($data = fread($file, 4096)) {
+ while (($data = fread($file, 4096)) && $this->errors->no()) {
if (!xml_parse($parser, $data, feof($file))) {
- $this->errors->add(sprintf("XML error: %s at line %d",
- xml_error_string(xml_get_error_code($parser)),
- xml_get_current_line_number($parser)));
+ $this->errors->add(sprintf($i18n->get('error.xml'),
+ xml_get_current_line_number($parser),
+ xml_error_string(xml_get_error_code($parser))));
}
}
- if ($this->cannotImport) {
+ if ($this->conflicting_logins) {
$this->canImport = false;
$this->errors->add($i18n->get('error.user_exists'));
- $this->errors->add(sprintf($i18n->get('error.cannot_import'), $this->cannotImport));
+ $this->errors->add(sprintf($i18n->get('error.cannot_import'), $this->conflicting_logins));
}
$this->firstPass = false; // We are done with 1st pass.
unlink($filename);
return;
}
+ if ($this->errors->yes()) return; // Exit if we have errors.
// 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);
- // Read and parse the content of the file. During parsing, startElement, endElement, and dataElement functions are called.
+ // Read and parse the content of the file. During parsing, startElement is called back for each tag.
$file = fopen($filename, 'r');
- while ($data = fread($file, 4096)) {
+ while (($data = fread($file, 4096)) && $this->errors->no()) {
if (!xml_parse($parser, $data, feof($file))) {
- $this->errors->add(sprintf("XML error: %s at line %d",
- xml_error_string(xml_get_error_code($parser)),
- xml_get_current_line_number($parser)));
+ $this->errors->add(sprintf($i18n->get('error.xml'),
+ xml_get_current_line_number($parser),
+ xml_error_string(xml_get_error_code($parser))));
}
}
xml_parser_free($parser);
// createGroup function creates a new group.
private function createGroup($fields) {
-
global $user;
+ global $i18n;
$mdb2 = getConnection();
- $columns = '(parent_id, org_id, name, currency, lang)';
-
-// $columns = '(name, currency, decimal_mark, lang, date_format, time_format, week_start, tracking_mode'.
-// ', project_required, task_required, record_type, bcc_email, allow_ip, password_complexity, plugins'.
-// ', lock_spec, workday_minutes, config, created, created_ip, created_by)';
+ $columns = '(parent_id, org_id, name, currency, decimal_mark, lang, date_format, time_format'.
+ ', week_start, tracking_mode, project_required, task_required, record_type, bcc_email'.
+ ', allow_ip, password_complexity, plugins, lock_spec'.
+ ', workday_minutes, config, created, created_ip, created_by)';
$values = ' values (';
$values .= $mdb2->quote($fields['parent_id']);
$values .= ', '.$mdb2->quote($fields['org_id']);
$values .= ', '.$mdb2->quote(trim($fields['name']));
$values .= ', '.$mdb2->quote(trim($fields['currency']));
- //$values .= ', '.$mdb2->quote($fields['decimal_mark']);
+ $values .= ', '.$mdb2->quote($fields['decimal_mark']);
$values .= ', '.$mdb2->quote($fields['lang']);
-/*
$values .= ', '.$mdb2->quote($fields['date_format']);
$values .= ', '.$mdb2->quote($fields['time_format']);
$values .= ', '.(int)$fields['week_start'];
$values .= ', '.$mdb2->quote($fields['lock_spec']);
$values .= ', '.(int)$fields['workday_minutes'];
$values .= ', '.$mdb2->quote($fields['config']);
- $values .= ', now(), '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', '.$mdb2->quote($user->id); */
+ $values .= ', now(), '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', '.$mdb2->quote($user->id);
$values .= ')';
$sql = 'insert into tt_groups '.$columns.$values;
$affected = $mdb2->exec($sql);
- if (is_a($affected, 'PEAR_Error')) return false;
+ if (is_a($affected, 'PEAR_Error')) {
+ $this->errors->add($i18n->get('error.db'));
+ return false;
+ }
$group_id = $mdb2->lastInsertID('tt_groups', 'id');
return $group_id;
}
+
+ // insertMonthlyQuota - a helper function to insert a monthly quota.
+ private function insertMonthlyQuota($fields) {
+ $mdb2 = getConnection();
+ $group_id = (int) $fields['group_id'];
+ $org_id = (int) $fields['org_id'];
+ $year = (int) $fields['year'];
+ $month = (int) $fields['month'];
+ $minutes = (int) $fields['minutes'];
+
+ $sql = "INSERT INTO tt_monthly_quotas (group_id, org_id, year, month, minutes)".
+ " values ($group_id, $org_id, $year, $month, $minutes)";
+ $affected = $mdb2->exec($sql);
+ return (!is_a($affected, 'PEAR_Error'));
+ }
+
+ // insertPredefinedExpense - a helper function to insert a predefined expense.
+ private function insertPredefinedExpense($fields) {
+ $mdb2 = getConnection();
+ $group_id = (int) $fields['group_id'];
+ $org_id = (int) $fields['org_id'];
+ $name = $mdb2->quote($fields['name']);
+ $cost = $mdb2->quote($fields['cost']);
+
+ $sql = "INSERT INTO tt_predefined_expenses (group_id, org_id, name, cost)".
+ " values ($group_id, $org_id, $name, $cost)";
+ $affected = $mdb2->exec($sql);
+ return (!is_a($affected, 'PEAR_Error'));
+ }
+
+ // insertExpense - a helper function to insert an expense item.
+ private function insertExpense($fields) {
+ global $user;
+ $mdb2 = getConnection();
+
+ $group_id = (int) $fields['group_id'];
+ $org_id = (int) $fields['org_id'];
+ $date = $fields['date'];
+ $user_id = (int) $fields['user_id'];
+ $client_id = $fields['client_id'];
+ $project_id = $fields['project_id'];
+ $name = $fields['name'];
+ $cost = str_replace(',', '.', $fields['cost']);
+ $invoice_id = $fields['invoice_id'];
+ $status = $fields['status'];
+ $paid = (int) $fields['paid'];
+ $created = ', now(), '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', '.$mdb2->quote($user->id);
+
+ $sql = "insert into tt_expense_items".
+ " (date, user_id, group_id, org_id, client_id, project_id, name, cost, invoice_id, paid, created, created_ip, created_by, status)".
+ " values (".$mdb2->quote($date).", $user_id, $group_id, $org_id, ".$mdb2->quote($client_id).", ".$mdb2->quote($project_id).
+ ", ".$mdb2->quote($name).", ".$mdb2->quote($cost).", ".$mdb2->quote($invoice_id).", $paid $created, ".$mdb2->quote($status).")";
+ $affected = $mdb2->exec($sql);
+ return (!is_a($affected, 'PEAR_Error'));
+ }
+
+ // insertProject - a helper function to insert a project as well as project to task binds.
+ private function insertProject($fields)
+ {
+ $mdb2 = getConnection();
+
+ $group_id = (int) $fields['group_id'];
+ $org_id = (int) $fields['org_id'];
+
+ $name = $fields['name'];
+ $description = $fields['description'];
+ $tasks = $fields['tasks'];
+ $comma_separated = implode(',', $tasks); // This is a comma-separated list of associated task ids.
+ $status = $fields['status'];
+
+ $sql = "insert into tt_projects (group_id, org_id, name, description, tasks, status)
+ values ($group_id, $org_id, ".$mdb2->quote($name).", ".$mdb2->quote($description).", ".$mdb2->quote($comma_separated).", ".$mdb2->quote($status).")";
+ $affected = $mdb2->exec($sql);
+ if (is_a($affected, 'PEAR_Error'))
+ return false;
+
+ $last_id = 0;
+ $sql = "select last_insert_id() as last_insert_id";
+ $res = $mdb2->query($sql);
+ $val = $res->fetchRow();
+ $last_id = $val['last_insert_id'];
+
+ // Insert binds into tt_project_task_binds table.
+ if (is_array($tasks)) {
+ foreach ($tasks as $task_id) {
+ $sql = "insert into tt_project_task_binds (project_id, task_id, group_id, org_id)".
+ " values($last_id, $task_id, $group_id, $org_id)";
+ $affected = $mdb2->exec($sql);
+ if (is_a($affected, 'PEAR_Error'))
+ return false;
+ }
+ }
+
+ return $last_id;
+ }
+
+ // The insertClient function inserts a new client as well as client to project binds.
+ private function insertClient($fields)
+ {
+ $mdb2 = getConnection();
+
+ $group_id = (int) $fields['group_id'];
+ $org_id = (int) $fields['org_id'];
+ $name = $fields['name'];
+ $address = $fields['address'];
+ $tax = $fields['tax'];
+ $projects = $fields['projects'];
+ if ($projects)
+ $comma_separated = implode(',', $projects); // This is a comma-separated list of associated projects ids.
+ $status = $fields['status'];
+
+ $tax = str_replace(',', '.', $tax);
+ if ($tax == '') $tax = 0;
+
+ $sql = "insert into tt_clients (group_id, org_id, name, address, tax, projects, status)".
+ " values ($group_id, $org_id, ".$mdb2->quote($name).", ".$mdb2->quote($address).", $tax, ".$mdb2->quote($comma_separated).", ".$mdb2->quote($status).")";
+
+ $affected = $mdb2->exec($sql);
+ if (is_a($affected, 'PEAR_Error'))
+ return false;
+
+ $last_id = 0;
+ $sql = "select last_insert_id() as last_insert_id";
+ $res = $mdb2->query($sql);
+ $val = $res->fetchRow();
+ $last_id = $val['last_insert_id'];
+
+ if (count($projects) > 0)
+ foreach ($projects as $p_id) {
+ $sql = "insert into tt_client_project_binds (client_id, project_id, group_id, org_id) values($last_id, $p_id, $group_id, $org_id)";
+ $affected = $mdb2->exec($sql);
+ if (is_a($affected, 'PEAR_Error'))
+ return false;
+ }
+
+ return $last_id;
+ }
+
+ // insertFavReport - inserts a favorite report in database.
+ private function insertFavReport($fields) {
+ $mdb2 = getConnection();
+
+ $group_id = (int) $fields['group_id'];
+ $org_id = (int) $fields['org_id'];
+
+ $sql = "insert into tt_fav_reports".
+ " (name, user_id, group_id, org_id, client_id, cf_1_option_id, project_id, task_id,".
+ " billable, invoice, paid_status, users, period, period_start, period_end,".
+ " show_client, show_invoice, show_paid, show_ip,".
+ " show_project, show_start, show_duration, show_cost,".
+ " show_task, show_end, show_note, show_custom_field_1, show_work_units,".
+ " group_by1, group_by2, group_by3, show_totals_only)".
+ " values(".
+ $mdb2->quote($fields['name']).", ".$fields['user_id'].", $group_id, $org_id, ".
+ $mdb2->quote($fields['client']).", ".$mdb2->quote($fields['option']).", ".
+ $mdb2->quote($fields['project']).", ".$mdb2->quote($fields['task']).", ".
+ $mdb2->quote($fields['billable']).", ".$mdb2->quote($fields['invoice']).", ".
+ $mdb2->quote($fields['paid_status']).", ".
+ $mdb2->quote($fields['users']).", ".$mdb2->quote($fields['period']).", ".
+ $mdb2->quote($fields['from']).", ".$mdb2->quote($fields['to']).", ".
+ $fields['chclient'].", ".$fields['chinvoice'].", ".$fields['chpaid'].", ".$fields['chip'].", ".
+ $fields['chproject'].", ".$fields['chstart'].", ".$fields['chduration'].", ".$fields['chcost'].", ".
+ $fields['chtask'].", ".$fields['chfinish'].", ".$fields['chnote'].", ".$fields['chcf_1'].", ".$fields['chunits'].", ".
+ $mdb2->quote($fields['group_by1']).", ".$mdb2->quote($fields['group_by2']).", ".
+ $mdb2->quote($fields['group_by3']).", ".$fields['chtotalsonly'].")";
+ $affected = $mdb2->exec($sql);
+ if (is_a($affected, 'PEAR_Error'))
+ return false;
+
+ $sql = "select last_insert_id() as last_id";
+ $res = $mdb2->query($sql);
+ if (is_a($res, 'PEAR_Error'))
+ return false;
+
+ $val = $res->fetchRow();
+ return $val['last_id'];
+ }
+
+ // insertNotification function inserts a new notification into database.
+ private function insertNotification($fields)
+ {
+ $mdb2 = getConnection();
+
+ $group_id = (int) $fields['group_id'];
+ $org_id = (int) $fields['org_id'];
+ $cron_spec = $fields['cron_spec'];
+ $last = (int) $fields['last'];
+ $next = (int) $fields['next'];
+ $report_id = (int) $fields['report_id'];
+ $email = $fields['email'];
+ $cc = $fields['cc'];
+ $subject = $fields['subject'];
+ $report_condition = $fields['report_condition'];
+ $status = $fields['status'];
+
+ $sql = "insert into tt_cron".
+ " (group_id, org_id, cron_spec, last, next, report_id, email, cc, subject, report_condition, status)".
+ " values ($group_id, $org_id, ".$mdb2->quote($cron_spec).", $last, $next, $report_id, ".$mdb2->quote($email).", ".$mdb2->quote($cc).", ".$mdb2->quote($subject).", ".$mdb2->quote($report_condition).", ".$mdb2->quote($status).")";
+ $affected = $mdb2->exec($sql);
+ return (!is_a($affected, 'PEAR_Error'));
+ }
+
+ // insertUserParam - a helper function to insert a user parameter.
+ private function insertUserParam($fields) {
+ $mdb2 = getConnection();
+
+ $group_id = (int) $fields['group_id'];
+ $org_id = (int) $fields['org_id'];
+ $user_id = (int) $fields['user_id'];
+ $param_name = $fields['param_name'];
+ $param_value = $fields['param_value'];
+
+ $sql = "insert into tt_config".
+ " (user_id, group_id, org_id, param_name, param_value)".
+ " values ($user_id, $group_id, $org_id, ".$mdb2->quote($param_name).", ".$mdb2->quote($param_value).")";
+ $affected = $mdb2->exec($sql);
+ return (!is_a($affected, 'PEAR_Error'));
+ }
+
+ // insertCustomField - a helper function to insert a custom field.
+ private function insertCustomField($fields) {
+ $mdb2 = getConnection();
+
+ $group_id = (int) $fields['group_id'];
+ $org_id = (int) $fields['org_id'];
+ $type = (int) $fields['type'];
+ $label = $fields['label'];
+ $required = (int) $fields['required'];
+ $status = $fields['status'];
+
+ $sql = "insert into tt_custom_fields".
+ " (group_id, org_id, type, label, required, status)".
+ " values($group_id, $org_id, $type, ".$mdb2->quote($label).", $required, ".$mdb2->quote($status).")";
+ $affected = $mdb2->exec($sql);
+ if (is_a($affected, 'PEAR_Error'))
+ return false;
+
+ $last_id = 0;
+ $sql = "select last_insert_id() as last_insert_id";
+ $res = $mdb2->query($sql);
+ $val = $res->fetchRow();
+ $last_id = $val['last_insert_id'];
+ return $last_id;
+ }
+
+ // insertCustomFieldOption - a helper function to insert a custom field option.
+ private function insertCustomFieldOption($fields) {
+ $mdb2 = getConnection();
+
+ $group_id = (int) $fields['group_id'];
+ $org_id = (int) $fields['org_id'];
+ $field_id = (int) $fields['field_id'];
+ $value = $fields['value'];
+
+ $sql = "insert into tt_custom_field_options (group_id, org_id, field_id, value)".
+ " values ($group_id, $org_id, $field_id, ".$mdb2->quote($value).")";
+ $affected = $mdb2->exec($sql);
+ if (is_a($affected, 'PEAR_Error'))
+ return false;
+
+ $last_id = 0;
+ $sql = "select last_insert_id() as last_insert_id";
+ $res = $mdb2->query($sql);
+ $val = $res->fetchRow();
+ $last_id = $val['last_insert_id'];
+ return $last_id;
+ }
+
+ // insertCustomFieldLogEntry - a helper function to insert a custom field log entry.
+ private function insertCustomFieldLogEntry($fields) {
+ $mdb2 = getConnection();
+
+ $group_id = (int) $fields['group_id'];
+ $org_id = (int) $fields['org_id'];
+ $log_id = (int) $fields['log_id'];
+ $field_id = (int) $fields['field_id'];
+ $option_id = $fields['option_id'];
+ $value = $fields['value'];
+ $status = $fields['status'];
+
+ $sql = "insert into tt_custom_field_log (group_id, org_id, log_id, field_id, option_id, value, status)".
+ " values ($group_id, $org_id, $log_id, $field_id, ".$mdb2->quote($option_id).", ".$mdb2->quote($value).", ".$mdb2->quote($status).")";
+ $affected = $mdb2->exec($sql);
+ return (!is_a($affected, 'PEAR_Error'));
+ }
}