Imporved error handling in new import.

[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 ba1b120febc1584ff0d5d1432b11976aad42922a..991424e610bfe597dd2b6be080d44aba170c4925 100644 (file)
--- a/WEB-INF/lib/ttOrgImportHelper.class.php
+++ b/WEB-INF/lib/ttOrgImportHelper.class.php
@@ -27,6 +27,7 @@
 // +----------------------------------------------------------------------+
 
 import('ttUserHelper');
 // +----------------------------------------------------------------------+
 
 import('ttUserHelper');

+import('ttRoleHelper');

 
 // ttOrgImportHelper - this class is a future replacement for ttImportHelper.
 // Currently, it is work in progress.
 
 // ttOrgImportHelper - this class is a future replacement for ttImportHelper.
 // Currently, it is work in progress.


@@ -37,10 +38,11 @@ class ttOrgImportHelper {
   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 $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.
+  var $current_group_id        = null; // Current group id during parsing.
+  var $current_parent_group_id = null; // Current parent group id during parsing.

                                        // Set when we create a new group.
                                        // Set when we create a new group.

-  // Entities for current group.
-  var $currentGroupRoles = array(); // Array of arrays of role properties.
+  // Entities for current group. -- Looks like they are not needed as we insert right away...
+  // 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 $currentGroupUsers = array(); // Array of arrays of user properties.
 
   // Entity maps for current group. They map XML ids with database ids.


@@ -58,6 +60,7 @@ class ttOrgImportHelper {
 
   // startElement - callback handler for opening tag of an XML element in the file.
   function startElement($parser, $name, $attrs) {
 
   // startElement - callback handler for opening tag of an XML element in the file.
   function startElement($parser, $name, $attrs) {

+    global $i18n;

 
     // First pass. We only check user logins for potential collisions with existing.
     if ($this->firstPass) {
 
     // First pass. We only check user logins for potential collisions with existing.
     if ($this->firstPass) {


@@ -71,13 +74,13 @@ class ttOrgImportHelper {
     }
 
     // Second pass processing. We import data here, one tag at a time.
     }
 
     // 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.
       $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'],
           'parent_id' => $this->current_parent_group_id,
           'org_id' => $this->org_id,
           'name' => $attrs['NAME'],


@@ -86,30 +89,36 @@ class ttOrgImportHelper {
         // We only have 3 properties at the moment, while work is ongoing...
 
         // Special handling for top group.
         // We only have 3 properties at the moment, while work is ongoing...
 
         // 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);
           $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;

       }
 
       if ($name == 'ROLES') {
       }
 
       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);
         unset($this->currentGroupRoleMap);

-        $this->currentGroupRoles = array();

         $this->currentGroupRoleMap = 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.

       }
 
       if ($name == 'ROLE') {
       }
 
       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'));

       }
     }
   }
       }
     }
   }


@@ -161,9 +170,9 @@ class ttOrgImportHelper {
     $file = fopen($filename, 'r');
     while ($data = fread($file, 4096)) {
       if (!xml_parse($parser, $data, feof($file))) {
     $file = fopen($filename, 'r');
     while ($data = fread($file, 4096)) {
       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->conflicting_entities) {
       }
     }
     if ($this->conflicting_entities) {


@@ -179,6 +188,7 @@ class ttOrgImportHelper {
       unlink($filename);
       return;
     }
       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();
 
     // Now we can do a second pass, where real work is done.
     $parser = xml_parser_create();


@@ -189,9 +199,9 @@ class ttOrgImportHelper {
     $file = fopen($filename, 'r');
     while ($data = fread($file, 4096)) {
       if (!xml_parse($parser, $data, feof($file))) {
     $file = fopen($filename, 'r');
     while ($data = fread($file, 4096)) {
       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);
       }
     }
     xml_parser_free($parser);


@@ -228,7 +238,7 @@ class ttOrgImportHelper {
   // createGroup function creates a new group.
   private function createGroup($fields) {
 
   // createGroup function creates a new group.
   private function createGroup($fields) {
 

-    global $user;
+    global $i18n;

     $mdb2 = getConnection();
 
     $columns = '(parent_id, org_id, name, currency, lang)';
     $mdb2 = getConnection();
 
     $columns = '(parent_id, org_id, name, currency, lang)';


@@ -264,7 +274,10 @@ class ttOrgImportHelper {
 
     $sql = 'insert into tt_groups '.$columns.$values;
     $affected = $mdb2->exec($sql);
 
     $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;
 
     $group_id = $mdb2->lastInsertID('tt_groups', 'id');
     return $group_id;