// | https://www.anuko.com/time_tracker/credits.htm
// +----------------------------------------------------------------------+
-import('ttUserHelper');
-import('ttTaskHelper');
-import('ttInvoiceHelper');
-
// 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 $schema_version = null; // Database schema version from XML file we import from.
+ var $num_users = 0; // A number of active and inactive users we are importing.
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_group_id = null; // Current group id during parsing.
+ var $current_group_id = null; // Current 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.
var $currentGroupProjectMap = array();
var $currentGroupClientMap = array();
var $currentGroupUserMap = array();
+ var $currentGroupTimesheetMap = array();
var $currentGroupInvoiceMap = array();
var $currentGroupLogMap = array();
var $currentGroupCustomFieldMap = array();
// 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)) {
+ if ('' != $attrs['STATUS']) $this->num_users++;
+ if ('' != $attrs['STATUS'] && $this->loginExists($login)) {
// We have a login collision. Append colliding login to a list of things we cannot import.
$this->conflicting_logins .= ($this->conflicting_logins ? ", $login" : $login);
// The above is printed in error message with all found colliding logins.
unset($this->currentGroupProjectMap); $this->currentGroupProjectMap = array();
unset($this->currentGroupClientMap); $this->currentGroupClientMap = array();
unset($this->currentGroupUserMap); $this->currentGroupUserMap = array();
+ unset($this->currentGroupTimesheetMap); $this->currentGroupTimesheetMap = array();
unset($this->currentGroupInvoiceMap); $this->currentGroupInvoiceMap = array();
unset($this->currentGroupLogMap); $this->currentGroupLogMap = array();
unset($this->currentGroupCustomFieldMap); $this->currentGroupCustomFieldMap = array();
if ($role_id) {
// Add a mapping.
$this->currentGroupRoleMap[$attrs['ID']] = $role_id;
- } else $this->errors->add($i18n->get('error.db'));
+ } else {
+ $this->errors->add($i18n->get('error.db'));
+ }
return;
}
if ($name == 'TASK') {
// We get here when processing <task> tags for the current group.
- $task_id = ttTaskHelper::insert(array(
+ $task_id = $this->insertTask(array(
'group_id' => $this->current_group_id,
'org_id' => $this->org_id,
'name' => $attrs['NAME'],
if ($client_id) {
// Add a mapping.
$this->currentGroupClientMap[$attrs['ID']] = $client_id;
- } else $this->errors->add($i18n->get('error.db'));
+ } else {
+ $this->errors->add($i18n->get('error.db'));
+ }
return;
}
$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(
+ $user_id = $this->insertUser(array(
'group_id' => $this->current_group_id,
'org_id' => $this->org_id,
'role_id' => $role_id,
'login' => $attrs['LOGIN'],
'password' => $attrs['PASSWORD'],
'rate' => $attrs['RATE'],
+ 'quota_percent' => $attrs['QUOTA_PERCENT'],
'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'));
+ } else {
+ $this->errors->add($i18n->get('error.db'));
+ }
return;
}
if ($name == 'USER_PROJECT_BIND') {
- if (!ttUserHelper::insertBind(array(
+ if (!$this->insertUserProjectBind(array(
'user_id' => $this->currentGroupUserMap[$attrs['USER_ID']],
'project_id' => $this->currentGroupProjectMap[$attrs['PROJECT_ID']],
'group_id' => $this->current_group_id,
return;
}
+ if ($name == 'TIMESHEET') {
+ // We get here when processing <timesheet> tags for the current group.
+ $timesheet_id = $this->insertTimesheet(array(
+ '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'],
+ 'comment' => $attrs['COMMENT'],
+ 'start_date' => $attrs['START_DATE'],
+ 'end_date' => $attrs['END_DATE'],
+ 'submit_status' => $attrs['SUBMIT_STATUS'],
+ 'approve_status' => $attrs['APPROVE_STATUS'],
+ 'approve_comment' => $attrs['APPROVE_COMMENT'],
+ 'status' => $attrs['STATUS']));
+ if ($timesheet_id) {
+ // Add a mapping.
+ $this->currentGroupTimesheetMap[$attrs['ID']] = $timesheet_id;
+ } else {
+ $this->errors->add($i18n->get('error.db'));
+ }
+ return;
+ }
+
if ($name == 'INVOICE') {
// We get here when processing <invoice> tags for the current group.
- $invoice_id = ttInvoiceHelper::insert(array(
+ $invoice_id = $this->insertInvoice(array(
'group_id' => $this->current_group_id,
'org_id' => $this->org_id,
'name' => $attrs['NAME'],
if ($invoice_id) {
// Add a mapping.
$this->currentGroupInvoiceMap[$attrs['ID']] = $invoice_id;
- } else $this->errors->add($i18n->get('error.db'));
+ } else {
+ $this->errors->add($i18n->get('error.db'));
+ }
return;
}
'client_id' => $this->currentGroupClientMap[$attrs['CLIENT_ID']],
'project_id' => $this->currentGroupProjectMap[$attrs['PROJECT_ID']],
'task_id' => $this->currentGroupTaskMap[$attrs['TASK_ID']],
+ 'timesheet_id' => $this->currentGroupTimesheetMap[$attrs['TIMESHEET_ID']],
'invoice_id' => $this->currentGroupInvoiceMap[$attrs['INVOICE_ID']],
'comment' => (isset($attrs['COMMENT']) ? $attrs['COMMENT'] : ''),
'billable' => $attrs['BILLABLE'],
+ 'approved' => $attrs['APPROVED'],
'paid' => $attrs['PAID'],
'status' => $attrs['STATUS']));
if ($log_item_id) {
'org_id' => $this->org_id,
'client_id' => $this->currentGroupClientMap[$attrs['CLIENT_ID']],
'project_id' => $this->currentGroupProjectMap[$attrs['PROJECT_ID']],
+ 'timesheet_id' => $this->currentGroupTimesheetMap[$attrs['TIMESHEET_ID']],
'name' => $attrs['NAME'],
'cost' => $attrs['COST'],
'invoice_id' => $this->currentGroupInvoiceMap[$attrs['INVOICE_ID']],
+ 'approved' => $attrs['APPROVED'],
'paid' => $attrs['PAID'],
'status' => $attrs['STATUS']));
if (!$expense_item_id) $this->errors->add($i18n->get('error.db'));
'project' => $this->currentGroupProjectMap[$attrs['PROJECT_ID']],
'task' => $this->currentGroupTaskMap[$attrs['TASK_ID']],
'billable' => $attrs['BILLABLE'],
+ 'approved' => $attrs['APPROVED'],
+ 'invoice' => $attrs['INVOICE'],
+ 'timesheet' => $attrs['TIMESHEET'],
+ 'paid_status' => $attrs['PAID_STATUS'],
'users' => $user_list,
'period' => $attrs['PERIOD'],
'from' => $attrs['PERIOD_START'],
'chpaid' => (int) $attrs['SHOW_PAID'],
'chip' => (int) $attrs['SHOW_IP'],
'chproject' => (int) $attrs['SHOW_PROJECT'],
+ 'chtimesheet' => (int) $attrs['SHOW_TIMESHEET'],
'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'],
+ 'chapproved' => (int) $attrs['SHOW_APPROVED'],
'chcf_1' => (int) $attrs['SHOW_CUSTOM_FIELD_1'],
'chunits' => (int) $attrs['SHOW_WORK_UNITS'],
'group_by1' => $attrs['GROUP_BY1'],
}
}
- // 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.
+ // importXml - uncompresses the file, reads and parses its content.
+ // It goes through the file 2 times.
+ //
+ // During 1st pass, it determines whether we can import data.
+ // In 1st pass, startElement function is called as many times as necessary.
+ //
+ // Actual import occurs during 2nd pass.
+ // In 2nd pass, startElement and endElement are called many times.
+ // We only use endElement to finish current group processing.
+ //
+ // The above allows us to export/import complex orgs with nested groups,
+ // while by design all data are in attributes of the elements (no CDATA).
+ //
+ // There is currently at least one problem with keeping all data in attributes:
+ // a vertical tab character 0xB anywhere breaks parsing, making import impossible.
+ // See https://github.com/sparklemotion/nokogiri/issues/1581 - looks like
+ // an XML standard thing. Apparently, other invalid characters break parsing too.
+ // This problem needs to be addressed at some point but how exactly without
+ // complicating export-import too much with CDATA and dataElement processing?
function importXml() {
global $i18n;
+ if (!$_FILES['xmlfile']['name']) {
+ $this->errors->add($i18n->get('error.upload'));
+ return; // There is nothing to do if we don't have a file.
+ }
+
// Do we have a compressed file?
$compressed = false;
$file_ext = substr($_FILES['xmlfile']['name'], strrpos($_FILES['xmlfile']['name'], '.') + 1);
$this->errors->add($i18n->get('error.user_exists'));
$this->errors->add(sprintf($i18n->get('error.cannot_import'), $this->conflicting_logins));
}
+ if (!ttUserHelper::canAdd($this->num_users)) {
+ $this->canImport = false;
+ $this->errors->add($i18n->get('error.user_count'));
+ }
$this->firstPass = false; // We are done with 1st pass.
xml_parser_free($parser);
if ($file) fclose($file);
- if (!$this->canImport) {
+ if ($this->errors->yes()) {
+ // Remove the file and exit if we have errors.
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();
// 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'];
// 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 = str_replace(',', '.', $fields['cost']);
$invoice_id = $fields['invoice_id'];
$status = $fields['status'];
+ $approved = (int) $fields['approved'];
$paid = (int) $fields['paid'];
$created = ', now(), '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', '.$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)".
+ " (date, user_id, group_id, org_id, client_id, project_id, name,".
+ " cost, invoice_id, approved, 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).")";
+ ", ".$mdb2->quote($name).", ".$mdb2->quote($cost).", ".$mdb2->quote($invoice_id).
+ ", $approved, $paid $created, ".$mdb2->quote($status).")";
$affected = $mdb2->exec($sql);
return (!is_a($affected, 'PEAR_Error'));
}
+ // insertTask function inserts a new task into database.
+ private function insertTask($fields)
+ {
+ $mdb2 = getConnection();
+
+ $group_id = (int) $fields['group_id'];
+ $org_id = (int) $fields['org_id'];
+ $name = $fields['name'];
+ $description = $fields['description'];
+ $projects = $fields['projects'];
+ $status = $fields['status'];
+
+ $sql = "insert into tt_tasks (group_id, org_id, name, description, status)
+ values ($group_id, $org_id, ".$mdb2->quote($name).", ".$mdb2->quote($description).", ".$mdb2->quote($status).")";
+ $affected = $mdb2->exec($sql);
+ $last_id = 0;
+ if (is_a($affected, 'PEAR_Error'))
+ return false;
+
+ $last_id = $mdb2->lastInsertID('tt_tasks', 'id');
+ return $last_id;
+ }
+
+ // insertUserProjectBind - inserts a user to project bind into tt_user_project_binds table.
+ private function insertUserProjectBind($fields) {
+ $mdb2 = getConnection();
+
+ $group_id = (int) $fields['group_id'];
+ $org_id = (int) $fields['org_id'];
+ $user_id = (int) $fields['user_id'];
+ $project_id = (int) $fields['project_id'];
+ $rate = $mdb2->quote($fields['rate']);
+ $status = $mdb2->quote($fields['status']);
+
+ $sql = "insert into tt_user_project_binds (user_id, project_id, group_id, org_id, rate, status)".
+ " values($user_id, $project_id, $group_id, $org_id, $rate, $status)";
+ $affected = $mdb2->exec($sql);
+ return (!is_a($affected, 'PEAR_Error'));
+ }
+
+ // insertUser - inserts a user into database.
+ private function insertUser($fields) {
+ global $user;
+ $mdb2 = getConnection();
+
+ $group_id = (int) $fields['group_id'];
+ $org_id = (int) $fields['org_id'];
+
+ $columns = '(login, password, name, group_id, org_id, role_id, client_id, rate, quota_percent, email, created, created_ip, created_by, status)';
+
+ $values = 'values (';
+ $values .= $mdb2->quote($fields['login']);
+ $values .= ', '.$mdb2->quote($fields['password']);
+ $values .= ', '.$mdb2->quote($fields['name']);
+ $values .= ', '.$group_id;
+ $values .= ', '.$org_id;
+ $values .= ', '.(int)$fields['role_id'];
+ $values .= ', '.$mdb2->quote($fields['client_id']);
+ $values .= ', '.$mdb2->quote($fields['rate']);
+ $values .= ', '.$mdb2->quote($fields['quota_percent']);
+ $values .= ', '.$mdb2->quote($fields['email']);
+ $values .= ', now(), '.$mdb2->quote($_SERVER['REMOTE_ADDR']).', '.$user->id;
+ $values .= ', '.$mdb2->quote($fields['status']);
+ $values .= ')';
+
+ $sql = "insert into tt_users $columns $values";
+ $affected = $mdb2->exec($sql);
+ if (is_a($affected, 'PEAR_Error')) return false;
+
+ $last_id = $mdb2->lastInsertID('tt_users', 'id');
+ return $last_id;
+ }
+
// insertProject - a helper function to insert a project as well as project to task binds.
private function insertProject($fields)
{
$group_id = (int) $fields['group_id'];
$org_id = (int) $fields['org_id'];
-
$name = $fields['name'];
$description = $fields['description'];
$tasks = $fields['tasks'];
return $last_id;
}
+ // insertTimesheet - inserts a timesheet in database.
+ private function insertTimesheet($fields)
+ {
+ $mdb2 = getConnection();
+
+ $user_id = (int) $fields['user_id'];
+ $group_id = (int) $fields['group_id'];
+ $org_id = (int) $fields['org_id'];
+ $client_id = $fields['client_id'];
+ $project_id = $fields['project_id'];
+ $name = $fields['name'];
+ $comment = $fields['comment'];
+ $start_date = $fields['start_date'];
+ $end_date = $fields['end_date'];
+ $submit_status = $fields['submit_status'];
+ $approve_status = $fields['approve_status'];
+ $approve_comment = $fields['approve_comment'];
+ $status = $fields['status'];
+
+ // Insert a new timesheet record.
+ $sql = "insert into tt_timesheets (user_id, group_id, org_id, client_id, project_id, name,".
+ " comment, start_date, end_date, submit_status, approve_status, approve_comment, status)".
+ " values($user_id, $group_id, $org_id, ".$mdb2->quote($client_id).", ".$mdb2->quote($project_id).", ".$mdb2->quote($name).", ".
+ $mdb2->quote($comment).", ".$mdb2->quote($start_date).", ".$mdb2->quote($end_date).", ".
+ $mdb2->quote($submit_status).", ".$mdb2->quote($approve_status).", ".
+ $mdb2->quote($approve_comment).", ".$mdb2->quote($status).")";
+ $affected = $mdb2->exec($sql);
+ if (is_a($affected, 'PEAR_Error')) return false;
+
+ $last_id = $mdb2->lastInsertID('tt_timesheets', 'id');
+ return $last_id;
+ }
+
+ // insertInvoice - inserts an invoice in database.
+ private function insertInvoice($fields)
+ {
+ $mdb2 = getConnection();
+
+ $group_id = (int) $fields['group_id'];
+ $org_id = (int) $fields['org_id'];
+ $name = $fields['name'];
+ $client_id = (int) $fields['client_id'];
+ $date = $fields['date'];
+ $status = $fields['status'];
+
+ // Insert a new invoice record.
+ $sql = "insert into tt_invoices (group_id, org_id, name, date, client_id, status)".
+ " values($group_id, $org_id, ".$mdb2->quote($name).", ".$mdb2->quote($date).", $client_id, ".$mdb2->quote($fields['status']).")";
+ $affected = $mdb2->exec($sql);
+ if (is_a($affected, 'PEAR_Error')) return false;
+
+ $last_id = $mdb2->lastInsertID('tt_invoices', 'id');
+ return $last_id;
+ }
+
// The insertClient function inserts a new client as well as client to project binds.
private function insertClient($fields)
{
$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,".
+ " billable, approved, invoice, timesheet, 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,".
+ " show_project, show_timesheet, show_start, show_duration, show_cost,".
+ " show_task, show_end, show_note, show_approved, 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['billable']).", ".$mdb2->quote($fields['approved']).", ".
+ $mdb2->quote($fields['invoice']).", ".$mdb2->quote($fields['timesheet']).", ".
$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'].", ".
+ $fields['chproject'].", ".$fields['chtimesheet'].", ".$fields['chstart'].", ".$fields['chduration'].", ".
+ $fields['chcost'].", ".$fields['chtask'].", ".$fields['chfinish'].", ".$fields['chnote'].", ".
+ $fields['chapproved'].", ".$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);
$client_id = $fields['client_id'];
$project_id = $fields['project_id'];
$task_id = $fields['task_id'];
+ $timesheet_id = $fields['timesheet_id'];
$invoice_id = $fields['invoice_id'];
$comment = $fields['comment'];
$billable = (int) $fields['billable'];
+ $approved = (int) $fields['approved'];
$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)".
+ " (user_id, group_id, org_id, date, start, duration, client_id, project_id, task_id, timesheet_id, invoice_id, comment".
+ ", billable, approved, paid, created, created_ip, created_by, status)".
" values ($user_id, $group_id, $org_id".
", ".$mdb2->quote($date).
", ".$mdb2->quote($start).
", ".$mdb2->quote($client_id).
", ".$mdb2->quote($project_id).
", ".$mdb2->quote($task_id).
+ ", ".$mdb2->quote($timesheet_id).
", ".$mdb2->quote($invoice_id).
", ".$mdb2->quote($comment).
- ", $billable, $paid".
+ ", $billable, $approved, $paid".
", now(), ".$mdb2->quote($_SERVER['REMOTE_ADDR']).", ".$user->id.
", ". $mdb2->quote($status).")";
$affected = $mdb2->exec($sql);
}
return false;
}
+
+ // The loginExists function detrmines if a login already exists.
+ private function loginExists($login) {
+ $mdb2 = getConnection();
+
+ $sql = "select id from tt_users where login = ".$mdb2->quote($login)." and (status = 1 or status = 0)";
+ $res = $mdb2->query($sql);
+ if (!is_a($res, 'PEAR_Error')) {
+ if ($val = $res->fetchRow()) {
+ return true;
+ }
+ }
+ return false;
+ }
}