// | https://www.anuko.com/time_tracker/credits.htm
// +----------------------------------------------------------------------+
-import('ttUserHelper');
-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 $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.
// Constructor.
function __construct(&$errors) {
$this->errors = &$errors;
- $this->top_role_id = ttRoleHelper::getRoleByRank(512, 0);
+ $this->top_role_id = $this->getTopRole();
}
// startElement - callback handler for opening tags in XML.
// 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.
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,
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;
}
}
}
- // 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']);
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'];
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'];
+ $last_id = $mdb2->lastInsertID('tt_projects', 'id');
// Insert binds into tt_project_task_binds table.
if (is_array($tasks)) {
if (is_a($affected, 'PEAR_Error'))
return false;
- $sql = "SELECT LAST_INSERT_ID() AS last_id";
- $res = $mdb2->query($sql);
- $val = $res->fetchRow();
- $last_id = $val['last_id'];
+ $last_id = $mdb2->lastInsertID('tt_roles', '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;
}
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'];
+ $last_id = $mdb2->lastInsertID('tt_clients', 'id');
if (count($projects) > 0)
foreach ($projects as $p_id) {
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'];
+ $last_id = $mdb2->lastInsertID('tt_fav_reports', 'id');
+ return $last_id;
}
// insertNotification function inserts a new notification into database.
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'];
+ $last_id = $mdb2->lastInsertID('tt_custom_fields', 'id');
return $last_id;
}
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'];
+ $last_id = $mdb2->lastInsertID('tt_custom_field_options', 'id');
return $last_id;
}
$affected = $mdb2->exec($sql);
return (!is_a($affected, 'PEAR_Error'));
}
+
+ // getTopRole returns top role id.
+ private function getTopRole() {
+ $mdb2 = getConnection();
+
+ $sql = "select id from tt_roles where group_id = 0 and rank = ".MAX_RANK." and status = 1";
+ $res = $mdb2->query($sql);
+
+ if (!is_a($res, 'PEAR_Error')) {
+ $val = $res->fetchRow();
+ if ($val['id'])
+ return $val['id'];
+ }
+ 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;
+ }
}