Merge pull request #80 from nigelgbanks/fix-for-incorrect-logging

Fix for incorrect logging & Fedora exceptions

CollectionClass.inc

@@ -45,11 +45,12 @@ class CollectionClass {
    * @return type 
    */
   function getRelatedObjects($pid, $limit, $offset, $itqlquery=NULL) {
-    module_load_include('inc', 'fedora_repository', 'ObjectHelper');
-    $objectHelper = new ObjectHelper();
     if (!isset($itqlquery)) {
-      // $query_string = $objectHelper->getStream($pid, 'QUERY', 0);
+      module_load_include('inc', 'fedora_repository', 'api/fedora_item');
-      $itqlquery = $objectHelper->getStream($pid, 'QUERY', 0);
+      $item = new Fedora_Item($pid);
+      if ($item->exists() && array_key_exists('QUERY', $item->datastreams)) {
+        $itqlquery = $item->get_datastream_dissemination('QUERY');
+      }
     }
     return $this->getRelatedItems($pid, $itqlquery, $limit, $offset);
   }
@@ -78,7 +79,11 @@ class CollectionClass {
     $objectHelper = new ObjectHelper();
     $query_string = $itqlquery;
     if (!isset($query_string)) {
-      $query_string = $objectHelper->getStream($pid, 'QUERY', 0);
+      $query_string = NULL;
+      $item = new Fedora_Item($pid);
+      if ($item->exists() && array_key_exists('QUERY', $item->datastreams)) {
+        $query_string = $item->get_datastream_dissemination('QUERY');
+      }
       if ($query_string == NULL) {
         $query_string = 'select $object $title $content from <#ri>
                              where ($object <fedora-model:label> $title
@@ -445,7 +450,7 @@ class CollectionClass {
         'pidNamespace' => $pidNameSpace
       );
       $object = $soapClient->__soapCall('getNextPID', array(
-            $params
+        $params
           ));
     } catch (exception $e) {
       drupal_set_message(t('Error getting Next PID: @e', array('@e' => check_plain($e->getMessage()))), 'error');
@@ -498,11 +503,10 @@ class CollectionClass {
     module_load_include('inc', 'fedora_repository', 'CollectionManagement');
     module_load_include('inc', 'fedora_repository', 'BatchIngest');
     global $base_url;
-    $tabset = array();
     global $user;
-    $objectHelper = new ObjectHelper();
+    $tabset = array();
-    $item = new Fedora_Item($this->pid);
     $query = NULL;
+    $item = new Fedora_Item($this->pid);
     if ($item->exists() && array_key_exists('QUERY', $item->datastreams)) {
       $query = $item->get_datastream_dissemination('QUERY');
     }
@@ -517,7 +521,7 @@ class CollectionClass {
     $show_batch_tab = FALSE;
     $policy = CollectionPolicy::loadFromCollection($this->pid, TRUE);
 
-    if(!empty($policy)){
+    if (!empty($policy)) {
       $content_models = $policy->getContentModels();
     }
     if (count($content_models) == 1 && $content_models[0]->pid == "islandora:collectionCModel") {

ObjectHelper.inc

@@ -383,8 +383,8 @@ class ObjectHelper {
       $xsl->load($path . '/xsl/convertQDC.xsl');
       $input = new DomDocument();
       $input->loadXML(trim($xmlstr));
-    } catch (exception $e) {
+    } catch (Exception $e) {
-      watchdog(t("Fedora_Repository"), "Problem loading XSL file: @e", array('@e' => $e), NULL, WATCHDOG_ERROR);
+      watchdog('fedora_repository', "Problem loading XSL file: @e", array('@e' => $e->getMessage()), NULL, WATCHDOG_ERROR);
     }
     $xsl = $proc->importStylesheet($xsl);
     $newdom = $proc->transformToDoc($input);

api/fedora_item.inc

@@ -18,6 +18,22 @@ class Fedora_Item {
   public $datastreams = NULL;
   private static $connection_helper = NULL;
   private static $instantiated_pids = array();
+  private static $SoapManagedFunctions = array(
+    'ingest',
+    'addDataStream',
+    'addRelationship',
+    'export',
+    'getDatastream',
+    'getDatastreamHistory',
+    'getNextPID',
+    'getRelationships',
+    'modifyDatastreamByValue',
+    'modifyDatastreamByReference',
+    'purgeDatastream',
+    'purgeObject',
+    'modifyObject',
+    'setDatastreamState'
+  );
 
   /**
    * Create an object to represent an item in the Fedora repository.
@@ -164,7 +180,6 @@ class Fedora_Item {
     return $returnvalue;
   }
 
-  
   /**
    * Wrapper to add new or modify existing datastream
    * @global url $base_url
@@ -662,11 +677,9 @@ class Fedora_Item {
   /**
    * Set the object to a deleted state
    */
-  function move_to_trash($log_message = 'Flagged deleted using Islandora API.')
+  function move_to_trash($log_message = 'Flagged deleted using Islandora API.') {
-  {
     // Loop through the datastreams and mark them deleted
-    foreach($this->get_datastreams_list_as_array() as $dsid) 
+    foreach ($this->get_datastreams_list_as_array() as $dsid) {
-    {
       $this->set_datastream_state($dsid, 'D');
     }
 
@@ -899,74 +912,46 @@ class Fedora_Item {
   }
 
   /**
-   * Soap call
+   * Make a soap call to the fedora API.
-   * @param type $function_name
+   *
-   * @param type $params_array
+   * @param string $function
-   * @param type $quiet
+   *   The name of the soap function to call.
-   * @return type 
+   * @param array $parameters
+   *   Paramters to pass onto the soap call
+   * @param boolean $quiet
+   *   If TRUE suppress drupal messages.
+   *
+   * @return mixed
+   *   The return value from the soap function if successful, NULL otherwise.
    */
-  static function soap_call($function_name, $params_array, $quiet = FALSE) {
+  static function soap_call($function, $parameters, $quiet = FALSE) {
     if (!self::$connection_helper) {
       module_load_include('inc', 'fedora_repository', 'ConnectionHelper');
       self::$connection_helper = new ConnectionHelper();
     }
-    switch ($function_name) {
+    $url = (array_search($function, self::$SoapManagedFunctions) !== FALSE) ?
-      case 'ingest':
+        variable_get('fedora_soap_manage_url', 'http://localhost:8080/fedora/services/management?wsdl') :
-      case 'addDataStream':
+        variable_get('fedora_soap_url', 'http://localhost:8080/fedora/services/access?wsdl');
-      case 'addRelationship':
+    try {
-      case 'export':
+      $soap_client = self::$connection_helper->getSoapClient($url);
-      case 'getDatastream':
+      if (isset($soap_client)) {
-      case 'getDatastreamHistory':
+        $result = $soap_client->__soapCall($function, array('parameters' => $parameters));
-      case 'getNextPID':
+      }
-      case 'getRelationships':
+      else {
-      case 'modifyDatastreamByValue':
+        if (!$quiet) {
-      case 'modifyDatastreamByReference':
+          drupal_set_message(t('Error trying to get SOAP client connection'));
-      case 'purgeDatastream':
-      case 'purgeObject':
-      case 'modifyObject':
-      case 'setDatastreamState':
-        $soap_client = self::$connection_helper->getSoapClient(variable_get('fedora_soap_manage_url', 'http://localhost:8080/fedora/services/management?wsdl'));
-        try {
-          if (!empty($soap_client)) {
-            $result = $soap_client->__soapCall($function_name, array('parameters' => $params_array));
-          }
-          else {
-            watchdog(t("FEDORA_REPOSITORY"), "Error trying to get SOAP client connection.");
-            return NULL;
-          }
-        } catch (exception $e) {
-          if (!$quiet) {
-
-            if (preg_match('/org\.fcrepo\.server\.security\.xacml\.pep\.AuthzDeniedException/', $e->getMessage())) {
-              drupal_set_message(t('Error:  Insufficient permissions to call SOAP function !fn.', array('!fn' => $function_name)), 'error');
-            }
-            else {
-              drupal_set_message(t("Error trying to call SOAP function $function_name. Check watchdog logs for more information."), 'error');
-            }
-
-            watchdog(t("FEDORA_REPOSITORY"), "Error Trying to call SOAP function @fn: @e", array('@fn' => $function_name, '@e' => $e), NULL, WATCHDOG_ERROR);
-          }
-          return NULL;
-        }
-        break;
-
-      default:
-        try {
-          $soap_client = self::$connection_helper->getSoapClient(variable_get('fedora_soap_url', 'http://localhost:8080/fedora/services/access?wsdl'));
-          if (!empty($soap_client)) {
-            $result = $soap_client->__soapCall($function_name, array('parameters' => $params_array));
-          }
-          else {
-            watchdog(t("FEDORA_REPOSITORY"), "Error trying to get SOAP client connection.");
-            return NULL;
-          }
-        } catch (exception $e) {
-
-          if (!$quiet) {
-            watchdog(t("FEDORA_REPOSITORY"), "Error trying to call SOAP function @fn: @e", array('@fn' => $function_name, '@e' => $e), NULL, WATCHDOG_ERROR);
-          }
-          return NULL;
         }
+        watchdog('fedora_repository', 'Error trying to get SOAP client connection.');
+        return NULL;
+      }
+    } catch (Exception $e) {
+      if (!$quiet) {
+        preg_match('/org\.fcrepo\.server\.security\.xacml\.pep\.AuthzDeniedException/', $e->getMessage()) ?
+                drupal_set_message(t('Insufficient permissions to call SOAP function "%func".', array('%func' => $function)), 'error') :
+                drupal_set_message(t('Error trying to call SOAP function "%func". Check watchdog logs for more information.', array('%func' => $function)), 'error');
+      }
+      watchdog('fedora_repository', 'Error Trying to call SOAP function "%func". Exception: @e in @f(@l)\n@t', array('%func' => $function, '@e' => $e->getMessage(), '@f' => $e->getFile(), '@l' => $e->getLine(), '@t' => $e->getTraceAsString()), NULL, WATCHDOG_ERROR);
+      return NULL;
     }
     return $result;
   }