ttOrgImportHelper class impoved to output conflicting login names.

[timetracker.git] / WEB-INF / lib / ttOrgImportHelper.class.php

diff --git a/WEB-INF/lib/ttOrgImportHelper.class.php b/WEB-INF/lib/ttOrgImportHelper.class.php
index e64019154f6b6d73e0c21b181b213c24f786db77..b22c4fe3d5387f610639bb98d42d79c80583c45b 100644 (file)
--- a/WEB-INF/lib/ttOrgImportHelper.class.php
+++ b/WEB-INF/lib/ttOrgImportHelper.class.php
@@ -26,61 +26,66 @@
 // | https://www.anuko.com/time_tracker/credits.htm
 // +----------------------------------------------------------------------+
 
 // | https://www.anuko.com/time_tracker/credits.htm
 // +----------------------------------------------------------------------+
 

-import('ttTeamHelper');

 import('ttUserHelper');
 import('ttUserHelper');

-import('ttProjectHelper');
-import('ttTaskHelper');
-import('ttInvoiceHelper');
-import('ttTimeHelper');
-import('ttClientHelper');
-import('ttCustomFieldHelper');
-import('ttFavReportHelper');
-import('ttExpenseHelper');
-import('ttRoleHelper');

 
 // 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.
 class ttOrgImportHelper {
   var $errors         = null;    // Errors go here. Set in constructor by reference.
 
 // 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.
 class ttOrgImportHelper {
   var $errors         = null;    // Errors go here. Set in constructor by reference.

-
-  var $currentElement = array(); // Current element of the XML file we are parsing.
-  var $currentTag     = '';      // XML tag of the current element.
+  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 $firstPass      = true;    // True during first pass through the file.
 
   var $canImport      = true;    // False if we cannot import data due to a 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.
   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.
+
+  // 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.

 
   // Constructor.
   function __construct(&$errors) {
     $this->errors = &$errors;
   }
 
 
   // Constructor.
   function __construct(&$errors) {
     $this->errors = &$errors;
   }
 

-  // startElement - callback handler for opening tag of an XML element.
-  // In this function we assign passed in attributes to currentElement.
+  // startElement - callback handler for opening tag of an XML element in the file.

   function startElement($parser, $name, $attrs) {
   function startElement($parser, $name, $attrs) {

-    if ($name == 'GROUP'
-      || $name == 'USER') {
-      $this->currentElement = $attrs;
+
+    // First pass. We only check user logins for potential collisions with existing.
+    if ($this->firstPass) {
+      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->currentTag = $name;

 
 

+    // Second pass processing. We import data here, one tag at a time.

     if (!$this->firstPass && $this->canImport) {
       $mdb2 = getConnection();
 
     if (!$this->firstPass && $this->canImport) {
       $mdb2 = getConnection();
 

-      // We are in second pass through the XML file and can import data.
+      // We are in second pass and can import data.

       if ($name == 'GROUP') {
         // Create a new group.
         $group_id = $this->createGroup(array(
           'parent_id' => $this->current_parent_group_id,
           'org_id' => $this->org_id,
       if ($name == 'GROUP') {
         // Create a new group.
         $group_id = $this->createGroup(array(
           'parent_id' => $this->current_parent_group_id,
           'org_id' => $this->org_id,

-          'name' => $this->currentElement['NAME'],
-          'currency' => $this->currentElement['CURRENCY'],
-          'lang' => $this->currentElement['LANG']));
-        // We only have 3 properties in export at the moment, while work is ongoing...
+          'name' => $attrs['NAME'],
+          'currency' => $attrs['CURRENCY'],
+          'lang' => $attrs['LANG']));
+        // We only have 3 properties at the moment, while work is ongoing...

 
         // Special handling for top group.
         if (!$this->org_id) {
 
         // Special handling for top group.
         if (!$this->org_id) {


@@ -92,44 +97,22 @@ class ttOrgImportHelper {
         // Set current parent group.
         $this->current_parent_group_id = $group_id;
       }
         // Set current parent group.
         $this->current_parent_group_id = $group_id;
       }

-    }
-  }

 
 

-  // endElement - callback handler for the closing tag of an XML element.
-  // When we are here, currentElement is an array of the element attributes (as set in startElement).
-  // Here we do the actual import of data into the database.
-  function endElement($parser, $name) {
-    // During first pass we only check user logins.
-    if ($this->firstPass) {
-      if ($name == 'USER' && $this->canImport) {
-        if ('' != $this->currentElement['STATUS'] && ttUserHelper::getUserByLogin($this->currentElement['LOGIN'])) {
-          // We have a login collision, cannot import any data.
-          $this->canImport = false;
-        }
+      if ($name == 'ROLES') {
+        // If we get here, we have to recycle both $currentGroupRoles and $currentGroupRoleMap.
+        unset($this->currentGroupRoles);
+        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.

       }
       }

-      $this->currentTag = '';
-    }
-
-    // During second pass we import data.
-    if (!$this->firstPass && $this->canImport) {
-      // Nothing is done here, see startElement for second pass.
-    }
-  }

 
 

-  // dataElement - callback handler for text data fragments. It builds up currentElement array with text pieces from XML.
-  function dataElement($parser, $data) {
-    if ($this->currentTag == 'NAME'
-      || $this->currentTag == 'DESCRIPTION'
-      || $this->currentTag == 'LABEL'
-      || $this->currentTag == 'VALUE'
-      || $this->currentTag == 'COMMENT'
-      || $this->currentTag == 'ADDRESS'
-      || $this->currentTag == 'ALLOW_IP'
-      || $this->currentTag == 'PASSWORD_COMPLEXITY') {
-      if (isset($this->currentElement[$this->currentTag]))
-        $this->currentElement[$this->currentTag] .= trim($data);
-      else
-        $this->currentElement[$this->currentTag] = trim($data);
+      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;
+      }

     }
   }
 
     }
   }
 


@@ -167,8 +150,7 @@ class ttOrgImportHelper {
     // Initialize XML parser.
     $parser = xml_parser_create();
     xml_set_object($parser, $this);
     // Initialize XML parser.
     $parser = xml_parser_create();
     xml_set_object($parser, $this);

-    xml_set_element_handler($parser, 'startElement', 'endElement');
-    xml_set_character_data_handler($parser, 'dataElement');
+    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.
 
     // We need to parse the file 2 times:
     //   1) First pass: determine if import is possible - there must be no login collisions.


@@ -185,11 +167,13 @@ class ttOrgImportHelper {
           xml_error_string(xml_get_error_code($parser)),
           xml_get_current_line_number($parser)));
       }
           xml_error_string(xml_get_error_code($parser)),
           xml_get_current_line_number($parser)));
       }

-      if (!$this->canImport) {
-        $this->errors->add($i18n->get('error.user_exists'));
-        break;
-      }

     }
     }

+    if ($this->cannotImport) {
+      $this->canImport = false;
+      $this->errors->add($i18n->get('error.user_exists'));
+      $this->errors->add(sprintf($i18n->get('error.cannot_import'), $this->cannotImport));
+    }
+

     $this->firstPass = false; // We are done with 1st pass.
     xml_parser_free($parser);
     if ($file) fclose($file);
     $this->firstPass = false; // We are done with 1st pass.
     xml_parser_free($parser);
     if ($file) fclose($file);


@@ -201,8 +185,7 @@ class ttOrgImportHelper {
     // Now we can do a second pass, where real work is done.
     $parser = xml_parser_create();
     xml_set_object($parser, $this);
     // 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', 'endElement');
-    xml_set_character_data_handler($parser, 'dataElement');
+    xml_set_element_handler($parser, 'startElement', false);

 
     // Read and parse the content of the file. During parsing, startElement, endElement, and dataElement functions are called.
     $file = fopen($filename, 'r');
 
     // Read and parse the content of the file. During parsing, startElement, endElement, and dataElement functions are called.
     $file = fopen($filename, 'r');