Merge pull request #6142 from NaturalHistoryMuseum/paul/gbif-description

Add a description field to GBIF submissions

Author: jrdh

sites/all/modules/custom/gbif_registry/classes/Registry.class.inc

@@ -186,22 +186,48 @@ class Registry
     }
 
     /**
-     * http put
+     * Make an HTTP PUT request with JSON
      *
-     * FIXME - Need to add authentication to this.
-     * FIXME - Should this be data, or a filename?
+     * @param string $path The path to PUT to
+     * @param resource|string $data The request body
+     * @return string|true  False if failed, true if successful but
+     *                      empty resposnse, otherwise the response body
      */
-    public function put($path, $file_handle)
+    public function put($path, $data)
     {
-        $ch = curl_init($this->registryURL . $path);
-        curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
-        curl_setopt($ch, CURLOPT_HEADER, 0);
-        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
-        curl_setopt($ch, CURLOPT_PUT, true);
-        curl_setopt($ch, CURLOPT_INFILE, $file_handle);
-    //curl_setopt($ch, CURLOPT_INFILESIZE, filesize($filename));
-        $response = curl_exec($ch);
+        if(is_resource($data)) {
+            $data = stream_get_contents($data);
+        }
 
+        $response = drupal_http_request(
+            $this->registryURL . $path,
+            [
+                'method' => 'PUT',
+                'headers' => [
+                    'Authorization' => 'Basic ' . base64_encode("{$this->user}:{$this->password}"),
+                    'Content-Type' => 'application/json',
+                    'Accept' => 'application/json'
+                ],
+                'data' => $data
+            ]
+        );
+
+        $httpcode = $response->code;
+        $http_is_successful = $httpcode >= 200 && $httpcode < 400;
+        $error = $response->error;
+
+        if ($error || !$http_is_successful) {
+            watchdog(
+                'GBIF',
+                'Could not save GBIF registry object - Error: %error HTTP status: %httpcode',
+                array('%error' => $error, '%httpcode' => $httpcode),
+                WATCHDOG_ERROR
+            );
+            return false;
+        } else {
+            // Make sure we don't return a falsy value if response is empty (e.g. a 204)
+            return $response->data ?: true;
+        }
     }
 
     /**

sites/all/modules/custom/gbif_registry/classes/RegistryObject.class.inc

@@ -211,11 +211,9 @@ class RegistryObject extends RegistryChild
             foreach ($this->getAsArray() as $key => $value) {
                 $current_data[$key] = $value;
             }
-            $f = tmpfile();
-            fwrite($f, json_encode($current_data));
-            fseek($f, 0);
+
+            $f = json_encode($current_data);
             Registry::singleton()->put($this->getURLPrefix() . "/{$this->key}", $f);
-            unlink($filename);
         } else {
       // No key, we simply need to create a new object, and save the key.
 

sites/all/modules/custom/scratchpads/scratchpads_gbif_registry_client/scratchpads_gbif_registry_client.pages.inc

@@ -32,6 +32,11 @@ function scratchpads_gbif_registry_client_admin_settings()
 
   $nonBio = !variable_get('biological_vids');
 
+  $default_description = implode(' | ', array_filter([
+    variable_get('site_slogan', ''),
+    strip_tags(variable_get('front_page_welcome_message', ['value'=>''])['value'])
+  ]));
+
   $form += array(
     'scratchpads_gbif_registry_client_registration_enabled' => array(
       '#type' => 'checkbox',
@@ -40,6 +45,12 @@ function scratchpads_gbif_registry_client_admin_settings()
       '#description' => t("Whether to register this scratchpad with GBIF."),
       '#disabled' => $nonBio
     ),
+    'scratchpads_gbif_registry_client_description' => array(
+      '#type' => 'textarea',
+      '#title' => t('Dataset description'),
+      '#default_value' => variable_get('scratchpads_gbif_registry_client_description', $default_description),
+      '#description' => t('A summary of the dataset. This will appear on the GBIF web page for your dataset and in GBIF search results.')
+    ),
     'scratchpads_gbif_registry_client_registration_licence' => array(
       '#type' => 'select',
       '#options' => $licence_options,
@@ -61,18 +72,43 @@ function scratchpads_gbif_registry_client_admin_settings()
   }
 
   $form['#submit'][] = 'scratchpads_gbif_registry_client_admin_settings_form_submit';
+  $form['#validate'][] = 'scratchpads_gbif_registry_client_admin_settings_form_validate';
 
   // use the system_settings_form function so that we don't have to implement our own submit function
   return system_settings_form($form);
 }
 
+/**
+ * Validation handler for settings form
+ */
+function scratchpads_gbif_registry_client_admin_settings_form_validate($form, &$form_state) {
+  $enabled = $form_state['values']['scratchpads_gbif_registry_client_registration_enabled'];
+  $description = $form_state['values']['scratchpads_gbif_registry_client_description'];
+
+  if($enabled && !$description) {
+    form_set_error('scratchpads_gbif_registry_client_description', t('You must proide a description to submit your dataset to GBIF.'));
+  }
+}
+
 /**
  * Submit handler for the scratchpads_gbif_registry_client_admin_settings form.
  */
 function scratchpads_gbif_registry_client_admin_settings_form_submit($form, &$form_state)
 {
   variable_del('scratchpads_gbif_registry_client_last_update');
 
+  $new_desc = $form_state['values']['scratchpads_gbif_registry_client_description'];
+
+  if($form['scratchpads_gbif_registry_client_description']['#default_value'] !== $new_desc) {
+    $uuid = variable_get('scratchpads_gbif_registry_client_uuid', false);
+    if($uuid) {
+      GBIFRegistry::singleton();
+      $dataset = new GBIF\Dataset($uuid);
+      $dataset->setDescription($new_desc);
+      $dataset->save();
+    }
+  }
+
   if(module_exists('dwcarchiver')) {
     dwcarchiver_rebuild('gbif-dwca', false);
     menu_rebuild();