Found out where the jQuery BBQ library is actually kept.
[mkdru-moved-to-drupal.org.git] / mkdru.module
index 1ffb195..9bc03b4 100644 (file)
@@ -1,31 +1,63 @@
 <?php
+// $Id$
 
+
+
+// Module metainfo
 /**
-* Implementation of hook_node_info().
+* Implements hook_node_info()
 */
 function mkdru_node_info() {
   return array(
     'mkdru' => array(
-      'name' => t("Z39.50/SRU metasearch interface"),
-      'module' => '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);
+}
+
 /**
-* Implementation of hook_perm().
+* Implements hook_permission()
 */
-function mkdru_perm() {
-  return array('create metasearch interface', 'edit any metasearch interface', 'edit own metasearch interface');
+function mkdru_permission() {
+  return array(
+    'administer metasearch interfaces' => array(
+      'title' => t('Administer Pazpar2 metasearch integration'),
+    ),
+    'create metasearch interface' => array(
+      'title' => t('Create metasearch interface'),
+    ),
+    'edit any metasearch interface' => array(
+      'title' => t('Edit any metasearch interface'),
+    ),
+    'edit own metasearch interface' => array(
+      'title' => t('Edit own metasearch interface'),
+    ),
+  );
 }
 
 /**
-* Implementation of hook_access().
+* Implements hook_node_access()
 */
-function mkdru_access($op, $node, $account) {
-
+function mkdru_node_access($node, $op, $account) {
   if ($op == 'create') {
     // Only users with permission to do so may create this node type.
     return user_access('create metasearch interface', $account);
@@ -36,114 +68,306 @@ function mkdru_access($op, $node, $account) {
   if ($op == 'update' || $op == 'delete') {
     if (user_access('edit own metasearch interface', $account) && ($account->uid == $node->uid)) {
       return TRUE;
-    } else if (user_access('edit any metasearch interface', $account)) {
+    }
+    elseif (user_access('edit any metasearch interface', $account)) {
       return TRUE;
     }
   }
 }
 
 /**
-* Implementation of hook_form().
+* Implements hook_menu()
+*/
+function mkdru_menu() {
+  $items['admin/settings/mkdru'] = array(
+    'title' => 'mkdru Settings',
+    'description' => 'Settings for mkdru.',
+    'page callback' => 'drupal_get_form',
+    'page arguments' => array('mkdru_admin_settings'),
+    'access arguments' => array('administer site configuration'),
+    'type' => MENU_NORMAL_ITEM,
+    'file' => 'mkdru.admin.inc',
+  );
+  return $items;
+}
+
+/**
+* Implementation of hook_init()
+*/
+function mkdru_init() {
+  // Applies our module specific CSS to all pages. This works best because
+  // all CSS is aggregated and cached so we reduce the number of HTTP 
+  // requests and the size is negligible.
+  drupal_add_css(drupal_get_path('module', 'mkdru') .'/mkdru.css');
+}
+
+
+
+// Node config
+/**
+* Implements hook_form()
 */
 function mkdru_form(&$node, $form_state) {
-  $type = node_get_types('type', $node);
+  $type = node_type_get_type($node);
 
   $form['title'] = array(
     '#type' => 'textfield',
     '#title' => check_plain($type->title_label),
-    '#required' => TRUE,
+    '#required' => FALSE,
     '#default_value' => $node->title,
     '#weight' => -5
   );
 
+  $form['search_settings']  = array(
+    '#type' => 'fieldset',
+    '#title' => t('Pazpar2/Service Proxy search settings'),
+    '#collapsible' => TRUE,
+    '#collapsed' => FALSE
+  );
+  $form['search_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',
+  );
+  $form['search_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,
+  );
+
+  $form['sp_settings']  = array(
+    '#type' => 'fieldset',
+    '#title' => t('Service Proxy specific settings'),
+    '#collapsible' => TRUE,
+    '#collapsed' => TRUE
+  );
+  $form['sp_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 : '',
+  );
+  $form['sp_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 : '',
+  );
+
+  $form['display_settings']  = array(
+    '#type' => 'fieldset',
+    '#title' => t('Display settings'),
+    '#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,
+  );
+  $form['display_settings']['author_max'] = 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,
+  );
+  $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,
+  );
   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.'));
+  }
+}
+
+/**
+* Implements hook_insert().
+*/
+function mkdru_insert($node) {
+  drupal_write_record('mkdru', $node);
+}
+
+/**
+* Implements hook_update().
+*/
+function mkdru_update($node) {
+  if ($node->revision) {
+    // New revision; treat it as a new record.
+    mkdru_insert($node);
+  }
+  else {
+    drupal_write_record('mkdru', $node, 'vid');
+  }
+}
+
+/**
+ * Implements hook_node_revision_delete()
+ */
+function mkdru_node_revision_delete($node) {
+  db_delete('mkdru')
+    ->condition('vid', $node->vid)
+    ->execute();
+}
+
+/**
+ * Implements hook_delete()
+ */
+function mkdru_delete($node) {
+  // Deleting by nid covers all revisions.
+  db_delete('mkdru')
+    ->condition('nid', $node->nid)
+    ->execute();
+}
+
+
+
+// Node rendering
+/**
+* Implements hook_load()
+*/
+function mkdru_load($nodes) {
+  $result = db_query('SELECT * FROM {mkdru} WHERE nid IN (:nids)', array(':nids' => array_keys($nodes)));
+  foreach ($result as $record) {
+    $nodes[$record->nid]->mkdru = $record;
+  }
+}
+
 /**
-* Implementation of hook_theme().
+* Implements hook_theme().
 */
 function mkdru_theme() {
   return array(
-    'mkdru_page' => array(
-      'template' => 'mkdru-page',
-      'arguments' => array(),
+    'mkdru_form' => array(
+      'template' => 'mkdru-form',
+      'variables' => array(),
     ),
-    'mkdru_page_js' => array(
-      'arguments' => array(),
+    'mkdru_results' => array(
+      'template' => 'mkdru-results',
+      'variables' => array(),
     ),
-//     'mkdru_block_facet' => array(
-//       'template' => 'mkdru-block-facet',
-//       'arguments' => array('divId' => NULL),
-//     ),
+    'mkdru_js' => array(
+      'variables' => array('node' => NULL),
+    ),
+    'mkdru_block_search' => array(
+      'template' => 'mkdru-block-search',
+      'variables' => array('nid' => NULL, 'path' => NULL),
+    ),
+    'mkdru_block_facet' => array(
+      'template' => 'mkdru-block-facet',
+      'variables' => array('class' => NULL)
+    )
   );
 }
 
 /**
 * Theme function to include Javascript search client and deps
 */
-function theme_mkdru_page_js() {
+function theme_mkdru_js(&$variables) {
   $path = drupal_get_path('module', 'mkdru');
-  drupal_add_js('pazpar2/js/pz2.js', 'module', 'footer');
-  drupal_add_js($path . '/mkdru.theme.js', 'module', 'footer');
-  drupal_add_js($path . '/mkdru.client.js', 'module', 'footer');
+  // Pazpar2 client library
+  drupal_add_js(variable_get('pz2_js_path', 'pazpar2/js') . '/pz2.js', array(
+    'type' => 'file', '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');
 }
 
 /** 
-* Implementation of hook_view()
+* Implements hook_view()
 */
-function mkdru_view($node, $teaser = FALSE, $page = FALSE) {
-  $node->content['mkdru_page_js'] = array(
-    '#value' => theme('mkdru_page_js'), 
-    '#weight' => 0,
-  );
-  $node->content['mkdru_page'] = array(
-    '#value' => theme('mkdru_page'), 
-    '#weight' => 1,
-  );
+function mkdru_view($node, $view_mode) {
+  if ($view_mode == 'full') {
+    $node->content['mkdru_js'] = array(
+      '#markup' => theme('mkdru_js', array('node' => $node)), 
+      '#weight' => 0,
+    );
+    $node->content['mkdru_form'] = array(
+      '#markup' => theme('mkdru_form'), 
+      '#weight' => 1,
+    );
+    $node->content['mkdru_results'] = array(
+      '#markup' => theme('mkdru_results'), 
+      '#weight' => 2,
+    );
+  }
   return $node;
 }
 
+
+
+// Blocks
 /** 
-* Implementation of hook_block()
+* Implements hook_block_info()
 */
-function mkdru_block($op='list', $delta='sources', $edit=array()) {
-  switch ($op) {
-    case 'list':
-      $blocks['mkdru_sources']['info'] = t('mkdru - source facets');
-      $blocks['mkdru_sources']['cache'] = BLOCK_NO_CACHE;
-      $blocks['mkdru_subjects']['info'] = t('mkdru - subject facets');
-      $blocks['mkdru_subjects']['cache'] = BLOCK_NO_CACHE;
-      $blocks['mkdru_authors']['info'] = t('mkdru - author facets');
-      $blocks['mkdru_authors']['cache'] = BLOCK_NO_CACHE;
-      return $blocks;
-
-    case 'view':
-      switch ($delta) {
-        // TODO: make the facet themable, I have no clue why this won't work
-//         case 'mkdru_sources':
-//           $block['subject'] = t('Source');
-//           $block['content'] = theme('mkdru_block_facet', 'mkdru-sources');
-//           return $block;
-//         case 'mkdru_subjects':
-//           $block['subject'] = t('Subject');
-//           $block['content'] = theme('mkdru_block_facet', 'mkdru-subjects');
-//           return $block;
-//         case 'mkdru_authors':
-//           $block['subject'] = t('Author');
-//           $block['content'] = theme('mkdru_block_facet', 'mkdru-authors');
-//           return $block;
-        case 'mkdru_sources':
-          $block['subject'] = t('Source');
-          $block['content'] = '<div id="mkdru-sources"> </div>';
-          return $block;
-        case 'mkdru_subjects':
-          $block['subject'] = t('Subject');
-          $block['content'] = '<div id="mkdru-subjects"> </div>';
-          return $block;
-        case 'mkdru_authors':
-          $block['subject'] = t('Author');
-          $block['content'] = '<div id="mkdru-authors"> </div>';
-          return $block;
-    }
+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';");
+  foreach($result as $node) {
+    $blocks['mkdru_search_' . $node->nid]['info'] = 
+        t('mkdru - search box for "' . $node->title . '"');
+    $blocks['mkdru_sources']['cache'] = DRUPAL_NO_CACHE;
+  };
+
+  return $blocks;
+}
+
+/** 
+* 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_') {
+    $nid = substr($delta, 13);
+    $block['content'] = theme('mkdru_block_search',
+        array('nid' => $nid, 'path' => '/node/' . $nid));
+    return $block;
   }
-}
\ No newline at end of file
+}