X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=mkdru.module;h=40bc0c461abb7abb30e1aa5bb19ddd995c8c3711;hb=refs%2Fheads%2F7.x;hp=9bc03b4afcafca38f782fb1fedb0aa6ea5dbe388;hpb=e3b03d604b74604d2a67cb4d765f5d8d18a3d057;p=mkdru-moved-to-drupal.org.git

diff --git a/mkdru.module b/mkdru.module
index 9bc03b4..40bc0c4 100644
--- a/mkdru.module
+++ b/mkdru.module
@@ -10,28 +10,56 @@
 function mkdru_node_info() {
   return array(
     'mkdru' => array(
-      'name' => t("Pazpar2 metasearch interface"),
-      'base' => 'mkdru',
+      'name'        => t("Pazpar2 metasearch interface"),
+      'base'        => 'mkdru',
       'description' => t("Metasearch interface for Z39.50/SRU and other targets via a Pazpar2/Service Proxy backend"),
     )
   );
 }
 
-function mkdru_ting_search_show($params) {
-   $path = drupal_get_path('module', 'mkdru');
-  // Include client library.
-  drupal_add_js(variable_get('pz2_js_path', 'pazpar2/js') . '/pz2.js',
-    array('type' => 'file', 'scope' => 'footer'));
-  drupal_add_library('overlay', 'jquery-bbq');
-  drupal_add_js($path . '/mkdru.theme.js',
-    array('type' => 'file', 'scope' => 'footer'));
-  drupal_add_js($path . '/mkdru.client.js',
-    array('type' => 'file', 'scope' => 'footer'));
-  $html = theme('mkdru_results');
-  drupal_add_js(array('mkdru' => 
-    array('use_sessions' => '1', 'query' => $params['keys']
-    )), 'setting');
-  return array("content" => $html);
+/**
+ * Implements hook_search_info()
+ */
+function mkdru_search_info() {
+  return array(
+    'title'               => 'Meta search',
+    'path'                => 'meta',
+    'conditions_callback' => 'mkdru_search_conditions_callback',
+  );
+}
+
+/**
+ * Implements hook_search_page()
+ */
+function mkdru_search_page($results) {
+  $output['prefix']['#markup'] = theme('mkdru_results');
+  $output['suffix']['#markup'] = '';
+  return $output;
+}
+
+/**
+ * Implements hook_ding_facetbrowser()
+ */
+function mkdru_ding_facetbrowser() {
+	$results             = new stdClass();
+  $results->facets     = array();
+  $results->show_empty = TRUE; # Show an empty facetbrowser block, even if search didn't return any results
+  return $results;
+}
+
+/**
+ * Search callback function that is invoked by search_view()
+ */
+function mkdru_search_conditions_callback($keys) {}
+
+/**
+ * Implement hook_search_execute()
+ */
+function mkdru_search_execute($keys = NULL, $conditions = NULL) {
+  theme('mkdru_js', array('setting' => array('mkdru' => array(
+    'settings' => json_encode(variable_get('mkdru_ding', NULL)),
+    'query' => $keys))));
+  return array();
 }
 
 /**
@@ -79,8 +107,8 @@ function mkdru_node_access($node, $op, $account) {
 * Implements hook_menu()
 */
 function mkdru_menu() {
-  $items['admin/settings/mkdru'] = array(
-    'title' => 'mkdru Settings',
+  $items['admin/config/search/mkdru'] = array(
+    'title' => 'Configure Pazpar2 metasearch integration',
     'description' => 'Settings for mkdru.',
     'page callback' => 'drupal_get_form',
     'page arguments' => array('mkdru_admin_settings'),
@@ -88,6 +116,14 @@ function mkdru_menu() {
     'type' => MENU_NORMAL_ITEM,
     'file' => 'mkdru.admin.inc',
   );
+  $items['admin/config/search/mkdru_ding'] = array(
+    'title' => 'Pazpar2 Metasearch Ding Integration',
+    'description' => 'Search settings for mkdru instance integrated into Ding.',
+    'page callback' => 'drupal_get_form',
+    'page arguments' => array('mkdru_ding_settings'),
+    'access arguments' => array('administer site configuration'),
+    'type' => MENU_NORMAL_ITEM,
+  );
   return $items;
 }
 
@@ -103,118 +139,232 @@ function mkdru_init() {
 
 
 
-// Node config
-/**
-* Implements hook_form()
-*/
-function mkdru_form(&$node, $form_state) {
-  $type = node_type_get_type($node);
+// Config form common to node and settings
+function mkdru_settings_form($form, &$form_state) {
+  if (isset($form_state['values']['settings'])) {
+    $settings = $form_state['values']['settings'];
+  }
+  else if (isset($form_state['build_info']['args']['settings'])) {
+    $settings = $form_state['build_info']['args']['settings'];
+  }
+  else {
+    $settings = variable_get('mkdru_defaults');
+  }
 
-  $form['title'] = array(
-    '#type' => 'textfield',
-    '#title' => check_plain($type->title_label),
-    '#required' => FALSE,
-    '#default_value' => $node->title,
-    '#weight' => -5
+  $form['settings'] = array(
+    '#tree' => TRUE,
   );
 
-  $form['search_settings']  = array(
-    '#type' => 'fieldset',
-    '#title' => t('Pazpar2/Service Proxy search settings'),
-    '#collapsible' => TRUE,
-    '#collapsed' => FALSE
-  );
-  $form['search_settings']['pz2_path'] = array(
+  $form['settings']['pz2_path'] = array(
     '#type' => 'textfield',
     '#title' => t('Pazpar2/Service Proxy path'),
     '#description' => t('Path that takes Pazpar2 commands via HTTP'),
     '#required' => TRUE,
-    '#default_value' => isset($node->mkdru->pz2_path) ? $node->mkdru->pz2_path : '/pazpar2/search.pz2',
+    '#default_value' => $settings['pz2_path'],
   );
-  $form['search_settings']['use_sessions'] = array(
+  $form['settings']['use_sessions'] = array(
     '#type' => 'checkbox',
     '#title' => t('Session handling'),
     '#description' => t('Disable for use with Service Proxy'),
-    '#default_value' => isset($node->mkdru->use_sessions) ? $node->mkdru->use_sessions : 1,
+    '#default_value' => $settings['use_sessions'],
   );
 
-  $form['sp_settings']  = array(
+  $form['settings']['sp']  = array(
     '#type' => 'fieldset',
     '#title' => t('Service Proxy specific settings'),
     '#collapsible' => TRUE,
     '#collapsed' => TRUE
   );
-  $form['sp_settings']['sp_user'] = array(
+  $form['settings']['sp']['user'] = array(
     '#type' => 'textfield',
     '#title' => t('Service Proxy username'),
     '#description' => t('Service Proxy username'),
     '#required' => FALSE,
-    '#default_value' => isset($node->mkdru->sp_user) ? 
-      $node->mkdru->sp_user : '',
+    '#default_value' => $settings['sp']['user'],
   );
-  $form['sp_settings']['sp_pass'] = array(
+  $form['settings']['sp']['pass'] = array(
     '#type' => 'textfield',
     '#title' => t('Service Proxy password'),
     '#description' => t('Service Proxy password'),
     '#required' => FALSE,
-    '#default_value' => isset($node->mkdru->sp_pass) ? 
-      $node->mkdru->sp_pass : '',
+    '#default_value' => $settings['sp']['pass'],
   );
 
-  $form['display_settings']  = array(
+  $form['settings']['facets']  = array(
     '#type' => 'fieldset',
-    '#title' => t('Display settings'),
+    '#title' => t('Facet settings'),
+    // Set up the wrapper so that AJAX will be able to replace the fieldset.
+    '#prefix' => '<div id="mkdru-facets-form-wrapper">', 
+    '#suffix' => '</div>',
     '#collapsible' => TRUE,
     '#collapsed' => FALSE
   );
-  $form['display_settings']['source_max'] = array(
-    '#type' => 'textfield',
-    '#title' => t('Number of sources to display'),
-    '#required' => TRUE,
-    '#default_value' => isset($node->mkdru->source_max) ? $node->mkdru->source_max : 10,
-    '#size' => 3,
-    '#maxlength' => 3,
+
+  foreach (array_keys($settings['facets']) as $facet) {
+    $form['settings']['facets'][$facet]  = array(
+      '#type' => 'fieldset',
+      '#title' => $facet . ' ' . t('facet'),
+      '#collapsible' => TRUE,
+      '#collapsed' => FALSE
+    );
+    $form['settings']['facets'][$facet]['displayName'] = array(
+      '#type' => 'textfield',
+      '#title' => t('Facet name to display in UI'),
+      '#required' => TRUE,
+      '#default_value' => $settings['facets'][$facet]['displayName'],
+    );
+    $form['settings']['facets'][$facet]['pz2Name'] = array(
+      '#type' => 'textfield',
+      '#title' => t('Name of termlist in Pazpar2'),
+      '#required' => TRUE,
+      '#default_value' => $settings['facets'][$facet]['pz2Name'],
+    );
+    $form['settings']['facets'][$facet]['limiter'] = array(
+      '#type' => 'textfield',
+      '#title' => t('Query limiter string'),
+      '#default_value' => $settings['facets'][$facet]['limiter'],
+      '#size' => 5,
+    );
+    $form['settings']['facets'][$facet]['multiLimit'] = array(
+      '#type' => 'checkbox',
+      '#title' => t('Allow multiple limits?'),
+      '#default_value' => $settings['facets'][$facet]['multiLimit'],
+    );
+    $form['settings']['facets'][$facet]['max'] = array(
+      '#type' => 'textfield',
+      '#title' => t('Number of terms to display'),
+      '#required' => TRUE,
+      '#default_value' => $settings['facets'][$facet]['max'],
+      '#size' => 3,
+      '#maxlength' => 3,
+    );
+    $form['settings']['facets'][$facet]['orderWeight'] = array(
+      '#type' => 'textfield',
+      '#title' => t('Facet weight'),
+      '#default_value' => $settings['facets'][$facet]['orderWeight'],
+      '#size' => 3,
+      '#maxlength' => 3,
+    );
+    $form['settings']['facets'][$facet]['remove'] = array(
+      '#type' => 'submit',
+      '#value' => t('Remove ') . $facet . t(' facet'),
+      '#mkdru facet' => $facet,
+      '#submit' => array('mkdru_remove_facet'),
+      '#ajax' => array(
+        'callback' => 'mkdru_ajax_facet_callback',
+        'wrapper' => 'mkdru-facets-form-wrapper',
+      ),
+    );
+  }
+
+  $form['new_facet']  = array(
+    '#type' => 'fieldset',
+    '#title' => t('Add new facet...'),
+    '#tree' => TRUE,
+    '#collapsible' => TRUE,
+    '#collapsed' => FALSE
   );
-  $form['display_settings']['author_max'] = array(
+  $form['new_facet']['canonical'] = array(
     '#type' => 'textfield',
-    '#title' => t('Number of authors to display'),
-    '#required' => TRUE,
-    '#default_value' => isset($node->mkdru->author_max) ? $node->mkdru->author_max : 10,
-    '#size' => 3,
-    '#maxlength' => 3,
+    '#title' => t('Canonical name of new facet'),
   );
-  $form['display_settings']['subject_max'] = array(
-    '#type' => 'textfield',
-    '#title' => t('Number of subjects to display'),
-    '#required' => TRUE,
-    '#default_value' => isset($node->mkdru->subject_max) ? $node->mkdru->subject_max : 10,
-    '#size' => 3,
-    '#maxlength' => 3,
+  $form['new_facet']['button'] = array(
+    '#type' => 'submit',
+    '#value' => t('Add facet'),
+    '#description' => t('Configure additional facets based on Pazpar2/SP termlists'),
+    '#weight' => 1,
+    '#submit' => array('mkdru_add_facet_form'),
+    '#ajax' => array(
+      'callback' => 'mkdru_ajax_facet_callback', 
+      'wrapper' => 'mkdru-facets-form-wrapper',
+    ),
+  );
+  return $form;
+}
+
+function mkdru_add_facet_form($form, &$form_state) {
+  // TODO: validation
+  $newfacet = $form_state['values']['new_facet']['canonical'];
+  $form_state['values']['settings']['facets'][$newfacet] = NULL;
+  $form_state['rebuild'] = TRUE;
+}
+
+function mkdru_remove_facet($form, &$form_state) {
+  $delfacet = $form_state['clicked_button']['#mkdru facet'];
+  if ($delfacet)
+    unset($form_state['values']['settings']['facets'][$delfacet]);
+  // Block table is not rebuilt like in D6 so we need to remove blocks explicitly
+  // This is a bit preemptive but the block still reappears in block_list if you
+  // decide not to save the facet deletion.
+  db_delete('block')->condition(db_and()
+    ->condition('module', 'mkdru')
+    ->condition('delta', 'mkdru_facet_' . $delfacet . '_' . $form_state['values']['nid'])
+    )->execute();
+  $form_state['rebuild'] = TRUE;
+}
+
+function mkdru_ajax_facet_callback($form, &$form_state) {
+  return $form['settings']['facets'];
+}
+
+
+
+// Ding config
+function mkdru_ding_settings($form, &$form_state) {
+  $form_state['build_info']['args']['settings'] = variable_get('mkdru_ding', NULL);
+  $form = drupal_retrieve_form('mkdru_settings_form', $form_state);
+  $form['settings']['#title'] = t('Search settings for DING integration');
+  $form['submit'] = array(
+    '#type' => 'submit',
+    '#value' => 'Save configuration',
   );
   return $form;
 }
 
+function mkdru_ding_settings_submit($form, &$form_state) {
+  variable_set('mkdru_ding', $form_state['values']['settings']);
+  drupal_set_message(t('The configuration options have been saved.'));
+}
+
+
+// Node config
+/**
+* Implements hook_form()
+*/
+function mkdru_form(&$node, &$form_state) {
+  if (isset($node->mkdru->settings)) {
+    // Second decode parameter indicates associative array
+    $form_state['build_info']['args']['settings'] = json_decode($node->mkdru->settings, TRUE);
+  }
+  $form = drupal_retrieve_form('mkdru_settings_form', $form_state);
+  $type = node_type_get_type($node);
+  $form['title'] = array(
+    '#type' => 'textfield',
+    '#title' => check_plain($type->title_label),
+    '#required' => FALSE,
+    '#default_value' => $node->title,
+    '#weight' => -5
+  );
+  return $form;
+}
 
 /**
 * Implements hook_validate()
 */
 function mkdru_validate($node) {
-  if (!is_numeric($node->source_max)) {
-    form_set_error('source_max', t('Please enter a number.'));
-  }
-  if (!is_numeric($node->author_max)) {
-    form_set_error('author_max', t('Please enter a number.'));
-  }
-  if (!is_numeric($node->subject_max)) {
-    form_set_error('subject_max', t('Please enter a number.'));
-  }
+// TODO: validation
+//   if (!is_numeric($node->source_max)) {
+//     form_set_error('source_max', t('Please enter a number.'));
+//   }
 }
 
 /**
 * Implements hook_insert().
 */
 function mkdru_insert($node) {
-  drupal_write_record('mkdru', $node);
+  $fields = array('nid' => $node->nid, 'vid' => $node->vid,
+            'settings' => json_encode($node->settings));
+  db_insert('mkdru')->fields($fields)->execute();
 }
 
 /**
@@ -226,7 +376,11 @@ function mkdru_update($node) {
     mkdru_insert($node);
   }
   else {
-    drupal_write_record('mkdru', $node, 'vid');
+    db_update('mkdru')
+      ->condition('vid', $node->vid)
+      ->fields(array('settings' => json_encode($node->settings)))
+      ->execute();
+    block_flush_caches();
   }
 }
 
@@ -247,6 +401,11 @@ function mkdru_delete($node) {
   db_delete('mkdru')
     ->condition('nid', $node->nid)
     ->execute();
+  // Block table is not rebuilt like in D6 so we need to remove blocks explicitly
+  db_delete('block')->condition(db_and()
+    ->condition('module', 'mkdru')
+    ->condition('delta', '%\_' . $node->nid, 'like')
+    )->execute();
 }
 
 
@@ -276,7 +435,7 @@ function mkdru_theme() {
       'variables' => array(),
     ),
     'mkdru_js' => array(
-      'variables' => array('node' => NULL),
+      'variables' => array('setting' => NULL),
     ),
     'mkdru_block_search' => array(
       'template' => 'mkdru-block-search',
@@ -296,14 +455,14 @@ function theme_mkdru_js(&$variables) {
   $path = drupal_get_path('module', 'mkdru');
   // Pazpar2 client library
   drupal_add_js(variable_get('pz2_js_path', 'pazpar2/js') . '/pz2.js', array(
-    'type' => 'file', 'scope' => 'footer', 'defer' => TRUE, 'preprocess' => FALSE));
+    'type' => 'external', 'scope' => 'footer', 'defer' => TRUE, 'preprocess' => FALSE));
   // jQuery plugin for query string/history manipulation.
   drupal_add_library('system', 'jquery.bbq');
   drupal_add_js($path . '/mkdru.theme.js', array(
     'type' => 'file', 'scope' => 'footer', 'defer' => TRUE, 'preprocess' => FALSE));
   drupal_add_js($path . '/mkdru.client.js', array(
     'type' => 'file', 'scope' => 'footer', 'defer' => TRUE, 'preprocess' => FALSE));
-  drupal_add_js(array('mkdru' => $variables['node']->mkdru), 'setting');
+  drupal_add_js($variables['setting'], 'setting');
 }
 
 /** 
@@ -312,7 +471,8 @@ function theme_mkdru_js(&$variables) {
 function mkdru_view($node, $view_mode) {
   if ($view_mode == 'full') {
     $node->content['mkdru_js'] = array(
-      '#markup' => theme('mkdru_js', array('node' => $node)), 
+      '#markup' => theme('mkdru_js', array('setting' 
+        => array('mkdru' => array('settings' => $node->mkdru->settings)))),
       '#weight' => 0,
     );
     $node->content['mkdru_form'] = array(
@@ -334,22 +494,24 @@ function mkdru_view($node, $view_mode) {
 * Implements hook_block_info()
 */
 function mkdru_block_info() {
-  // facet blocks
-  $facets = variable_get('mkdru_facets');
-  foreach ($facets as $facet) {
-    // NB: block caching is redundant for static content
-    $blocks['mkdru_facet_' . $facet]['info'] = "mkdru - $facet " . t('facet');
-    $blocks['mkdru_facet_' . $facet]['cache'] = DRUPAL_NO_CACHE;
-  }
-
-  // search blocks
-  $result = db_query("SELECT title, nid FROM {node} WHERE type = 'mkdru';");
+  $blocks = array();
+  $result = db_query("SELECT title, {mkdru}.nid as nid, settings FROM {node},{mkdru} WHERE {mkdru}.nid = {node}.nid;");
   foreach($result as $node) {
+    // search blocks
     $blocks['mkdru_search_' . $node->nid]['info'] = 
         t('mkdru - search box for "' . $node->title . '"');
-    $blocks['mkdru_sources']['cache'] = DRUPAL_NO_CACHE;
+    $blocks['mkdru_search_' . $node->nid]['cache'] = DRUPAL_NO_CACHE;
+    // facet blocks
+    $settings = json_decode($node->settings, TRUE);
+    foreach ($settings['facets'] as $facet_name => $facet) {
+      $key = 'mkdru_facet_' . $facet_name . '_' . $node->nid;
+      $blocks[$key]['info'] = 'mkdru - ' . $facet_name
+        . t(' facet for "') . $node->title . '"';
+      $blocks[$key]['visibility'] = 1;
+      $blocks[$key]['pages'] = 'node/' . $node->nid;
+      $blocks[$key]['cache'] = DRUPAL_CACHE_GLOBAL;
+    }
   };
-
   return $blocks;
 }
 
@@ -357,17 +519,22 @@ function mkdru_block_info() {
 * Implements hook_block_view()
 */
 function mkdru_block_view($delta) {
-  if (substr($delta, 0, 12) == 'mkdru_facet_') {
-    $facet = substr($delta, 12);
-    $block['subject'] = t(ucwords($facet));
-    $block['content'] = theme('mkdru_block_facet',
-                               array('class' => 'mkdru-facet-' . $facet));
-    return $block;
-  }
-  elseif (substr($delta, 0, 13) == 'mkdru_search_') {
+  if (substr($delta, 0, 13) == 'mkdru_search_') {
     $nid = substr($delta, 13);
     $block['content'] = theme('mkdru_block_search',
-        array('nid' => $nid, 'path' => '/node/' . $nid));
+      array('nid' => $nid, 'path' => '/node/' . $nid));
+    return $block;
+  }
+  else if (preg_match('/^mkdru_facet_(.*)_(\d+)$/', $delta, $matches) > 0) {
+    $facet = $matches[1];
+    $nid = $matches[2];
+    $result = db_query("SELECT settings FROM {mkdru} WHERE nid = :nid;", array(':nid' => $nid));
+    $settingsjson = $result->fetchObject()->settings;
+    $settings = json_decode($settingsjson, TRUE);
+    if (isset($settings['facets'][$facet]['displayName'])) {
+      $block['subject'] = $settings['facets'][$facet]['displayName'];
+    }
+    $block['content'] = theme('mkdru_block_facet', array('class' => 'mkdru-facet-' . $facet));
     return $block;
   }
 }