mkdru.module

   1 <?php
   2 // $Id$
   3
   4
   5
   6 // Module metainfo
   7 /**
   8 * Implements hook_node_info()
   9 */
  10 function mkdru_node_info() {
  11   return array(
  12     'mkdru' => array(
  13       'name' => t("Pazpar2 metasearch interface"),
  14       'module' => 'mkdru',
  15       'description' => t("Metasearch interface for Z39.50/SRU and other targets via a Pazpar2/Service Proxy backend"),
  16     )
  17   );
  18 }
  19
  20 function mkdru_ting_search_tab($keys) {
  21   error_log("TING SEARCH TAB invoked");
  22    $path = drupal_get_path('module', 'mkdru');
  23   // Include client library.
  24   drupal_add_js(variable_get('pz2_js_path', 'pazpar2/js')
  25     . '/pz2.js', 'module', 'footer');
  26   drupal_add_js($path . '/jquery.ba-bbq.js', 'module', 'footer');
  27   drupal_add_js($path . '/recipe.js', 'module', 'footer');
  28   drupal_add_js($path . '/mkdru.theme.js', 'module', 'footer');
  29   drupal_add_js($path . '/mkdru.client.js', 'module', 'footer');
  30   $html = theme('mkdru_results');
  31   drupal_add_js(array('mkdru' =>
  32     array(
  33       'settings' => json_encode(variable_get('mkdru_ding', NULL)),
  34       'pz2_path' => variable_get('pz2_path', '/pazpar2/search.pz2'),
  35       'query' => $keys
  36     )
  37   ), 'setting');
  38   return array("content" => $html, "title" => "Meta Search");
  39 }
  40
  41 /**
  42 * Implements hook_perm()
  43 */
  44 function mkdru_perm() {
  45   return array('create metasearch interface', 'edit any metasearch interface', 'edit own metasearch interface');
  46 }
  47
  48 /**
  49 * Implements hook_access()
  50 */
  51 function mkdru_access($op, $node, $account) {
  52
  53   if ($op == 'create') {
  54     // Only users with permission to do so may create this node type.
  55     return user_access('create metasearch interface', $account);
  56   }
  57
  58   // Users who create a node may edit or delete it later, assuming they have the
  59   // necessary permissions.
  60   if ($op == 'update' || $op == 'delete') {
  61     if (user_access('edit own metasearch interface', $account) && ($account->uid == $node->uid)) {
  62       return TRUE;
  63     }
  64     elseif (user_access('edit any metasearch interface', $account)) {
  65       return TRUE;
  66     }
  67   }
  68 }
  69
  70 /**
  71 * Implements hook_menu()
  72 */
  73 function mkdru_menu() {
  74   $items['admin/settings/mkdru'] = array(
  75     'title' => 'Pazpar2 Metasearch Settings',
  76     'description' => 'Settings for mkdru.',
  77     'page callback' => 'drupal_get_form',
  78     'page arguments' => array('mkdru_admin_settings'),
  79     'access arguments' => array('administer site configuration'),
  80     'type' => MENU_NORMAL_ITEM,
  81     'file' => 'mkdru.admin.inc',
  82   );
  83   $items['admin/settings/mkdru-ding'] = array(
  84     'title' => 'Pazpar2 Metasearch Ding Integration',
  85     'description' => 'Search settings for mkdru instance integrated into Ding.',
  86     'page callback' => 'drupal_get_form',
  87     'page arguments' => array('mkdru_ding_settings'),
  88     'access arguments' => array('administer site configuration'),
  89     'type' => MENU_NORMAL_ITEM,
  90   );
  91   return $items;
  92 }
  93
  94 /**
  95 * Implements hook_init()
  96 */
  97 function mkdru_init() {
  98   // Applies our module specific CSS to all pages. This works best because
  99   // all CSS is aggregated and cached so we reduce the number of HTTP
 100   // requests and the size is negligible.
 101   drupal_add_css(drupal_get_path('module', 'mkdru') .'/mkdru.css');
 102 }
 103
 104
 105 // Config form common to node and settings
 106 // function mkdru_settings_form($form, &$form_state) {
 107 function mkdru_settings_form(&$form_state) {
 108   if (isset($form_state['values']['settings'])) {
 109     $settings = $form_state['build_info']['args']['settings'];
 110   }
 111   else if (isset($form_state['build_info']['args']['settings'])) {
 112     $settings = $form_state['build_info']['args']['settings'];
 113   }
 114   else {
 115     $settings = variable_get('mkdru_defaults', NULL);
 116   }
 117
 118   $form['settings'] = array(
 119     '#tree' => TRUE,
 120   );
 121
 122   $form['settings']['pz2_path'] = array(
 123     '#type' => 'textfield',
 124     '#title' => t('Pazpar2/Service Proxy path'),
 125     '#description' => t('Path that takes Pazpar2 commands via HTTP'),
 126     '#required' => TRUE,
 127     '#default_value' => $settings['pz2_path'],
 128   );
 129   $form['settings']['use_sessions'] = array(
 130     '#type' => 'checkbox',
 131     '#title' => t('Session handling'),
 132     '#description' => t('Disable for use with Service Proxy'),
 133     '#default_value' => $settings['use_sessions'],
 134   );
 135
 136   $form['settings']['sp']  = array(
 137     '#type' => 'fieldset',
 138     '#title' => t('Service Proxy specific settings'),
 139     '#collapsible' => TRUE,
 140     '#collapsed' => FALSE
 141   );
 142   $form['settings']['sp']['user'] = array(
 143     '#type' => 'textfield',
 144     '#title' => t('Service Proxy username'),
 145     '#description' => t('Service Proxy username'),
 146     '#required' => FALSE,
 147     '#default_value' => $settings['sp']['user'],
 148   );
 149   $form['settings']['sp']['pass'] = array(
 150     '#type' => 'password',
 151     '#title' => t('Service Proxy password'),
 152     '#description' => t('Service Proxy password'),
 153     '#required' => FALSE,
 154     '#default_value' => $settings['sp']['pass'],
 155   );
 156
 157   $form['settings']['facets']  = array(
 158     '#type' => 'fieldset',
 159     '#title' => t('Facet settings'),
 160     // Set up the wrapper so that AJAX will be able to replace the fieldset.
 161     '#prefix' => '<div id="mkdru-facets-form-wrapper">',
 162     '#suffix' => '</div>',
 163     '#collapsible' => TRUE,
 164     '#collapsed' => FALSE
 165   );
 166   if (empty($form_state['facet_names'])) {
 167     $form_state['facet_names'] = array('source', 'author', 'subject');
 168   }
 169   foreach ($form_state['facet_names'] as $facet) {
 170     $form['settings']['facets'][$facet]  = array(
 171       '#type' => 'fieldset',
 172       '#title' => $facet . ' ' . t('facet'),
 173       '#collapsible' => TRUE,
 174       '#collapsed' => FALSE
 175     );
 176     $form['settings']['facets'][$facet]['displayName'] = array(
 177       '#type' => 'textfield',
 178       '#title' => t('Facet name to display in UI'),
 179       '#required' => TRUE,
 180       '#default_value' => $settings['facets'][$facet]['displayName'],
 181     );
 182     $form['settings']['facets'][$facet]['pz2Name'] = array(
 183       '#type' => 'textfield',
 184       '#title' => t('Name of termlist in Pazpar2'),
 185       '#required' => TRUE,
 186       '#default_value' => $settings['facets'][$facet]['pz2Name'],
 187     );
 188     $form['settings']['facets'][$facet]['limiter'] = array(
 189       '#type' => 'textfield',
 190       '#title' => t('Query limiter string'),
 191       '#default_value' => $settings['facets'][$facet]['limiter'],
 192       '#size' => 5,
 193     );
 194     $form['settings']['facets'][$facet]['max'] = array(
 195       '#type' => 'textfield',
 196       '#title' => t('Number of terms to display'),
 197       '#required' => TRUE,
 198       '#default_value' => $settings['facets'][$facet]['max'],
 199       '#size' => 3,
 200       '#maxlength' => 3,
 201     );
 202     $form['settings']['facets'][$facet]['orderWeight'] = array(
 203       '#type' => 'textfield',
 204       '#title' => t('Facet weight'),
 205       '#default_value' => $settings['facets'][$facet]['orderWeight'],
 206       '#size' => 3,
 207       '#maxlength' => 3,
 208     );
 209   }
 210 //   $form['new_facet']  = array(
 211 //     '#type' => 'fieldset',
 212 //     '#title' => t('Add new facet...'),
 213 //     '#tree' => TRUE,
 214 //     '#collapsible' => TRUE,
 215 //     '#collapsed' => FALSE
 216 //   );
 217 //   $form['new_facet']['canonical'] = array(
 218 //     '#type' => 'textfield',
 219 //     '#title' => t('Canonical name of new facet'),
 220 //   );
 221 //   $form['new_facet']['button'] = array(
 222 //     '#type' => 'submit',
 223 //     '#value' => t('Add facet'),
 224 //     '#description' => t('Configure additional facets based on Pazpar2/SP termlists'),
 225 //     '#weight' => 1,
 226 //     '#submit' => array('mkdru_add_facet_form'),
 227 //     '#ajax' => array(
 228 //       'callback' => 'mkdru_add_facet_callback',
 229 //       'wrapper' => 'mkdru-facets-form-wrapper',
 230 //     ),
 231 //   );
 232   return $form;
 233 }
 234
 235
 236
 237 // Ding config
 238 function mkdru_ding_settings(&$form_state) {
 239   $form_state['build_info']['args']['settings'] = variable_get('mkdru_ding', NULL);
 240   $form = drupal_retrieve_form('mkdru_settings_form', &$form_state);
 241   $form['settings']['#title'] = t('Default search settings');
 242   $form['submit'] = array(
 243     '#type' => 'submit',
 244     '#value' => 'Save configuration',
 245   );
 246   return $form;
 247 }
 248 function mkdru_ding_settings_submit($form, &$form_state) {
 249   variable_set('mkdru_ding', $form_state[values][settings]);
 250   drupal_set_message(t('The configuration options have been saved.'));
 251 }
 252
 253
 254
 255 // Node config
 256 /**
 257 * Implements hook_form()
 258 */
 259 function mkdru_form(&$node, &$form_state) {
 260   if (isset($node->settings)) {
 261     // Second decode parameter indicates associative array
 262     $form_state['build_info']['args']['settings'] = json_decode($node->settings, TRUE);
 263   }
 264
 265   $form = drupal_retrieve_form('mkdru_settings_form', &$form_state);
 266
 267   $type = node_get_types('type', $node);
 268   $form['title'] = array(
 269     '#type' => 'textfield',
 270     '#title' => check_plain($type->title_label),
 271     '#required' => FALSE,
 272     '#default_value' => $node->title,
 273     '#weight' => -5
 274   );
 275   return $form;
 276 }
 277
 278
 279 /**
 280 * Implements hook_validate()
 281 */
 282 function mkdru_validate($node) {
 283   // TODO: validation
 284 }
 285
 286 /**
 287 * Implements hook_insert().
 288 */
 289 function mkdru_insert($node) {
 290   $record['nid'] =  $node->nid;
 291   $record['vid'] =  $node->vid;
 292   $record['settings'] =  json_encode($node->settings);
 293   drupal_write_record('mkdru', &$record);
 294 }
 295
 296 /**
 297 * Implements hook_update().
 298 */
 299 function mkdru_update($node) {
 300   if ($node->revision) {
 301     // New revision; treat it as a new record.
 302     mkdru_insert($node);
 303   }
 304   else {
 305     $record['nid'] =  $node->nid;
 306     $record['vid'] =  $node->vid;
 307     $record['settings'] =  json_encode($node->settings);
 308     drupal_write_record('mkdru', &$record, 'vid');
 309   }
 310 }
 311
 312 /**
 313  * Implements hook_nodeapi().
 314  *
 315  * When a node revision is deleted, we need to remove the corresponding record
 316  * from our table. The only way to handle revision deletion is by implementing
 317  * hook_nodeapi().
 318  */
 319 function mkdru_nodeapi(&$node, $op, $teaser, $page) {
 320   switch ($op) {
 321     case 'delete revision':
 322       db_query('DELETE FROM {mkdru} WHERE vid = %d', $node->vid);
 323       break;
 324   }
 325 }
 326
 327 /**
 328  * Implements hook_delete().
 329  */
 330 function mkdru_delete($node) {
 331   // Deleting by nid covers all revisions.
 332   db_query('DELETE FROM {mkdru} WHERE nid = %d', $node->nid);
 333 }
 334
 335
 336
 337 // Node rendering
 338 /**
 339 * Implements hook_load()
 340 */
 341 function mkdru_load($node) {
 342   return db_fetch_object(db_query('SELECT * FROM {mkdru} WHERE vid = %d', $node->vid));
 343 }
 344
 345 /**
 346 * Implements hook_theme().
 347 */
 348 function mkdru_theme() {
 349   return array(
 350     'mkdru_form' => array(
 351       'template' => 'mkdru-form',
 352       'arguments' => array(),
 353     ),
 354     'mkdru_results' => array(
 355       'template' => 'mkdru-results',
 356       'arguments' => array(),
 357     ),
 358     'mkdru_js' => array(
 359       'arguments' => array('node' => NULL),
 360     ),
 361     'mkdru_block_search' => array(
 362       'template' => 'mkdru-block-search',
 363       'arguments' => array('nid' => NULL, 'path' => NULL),
 364     ),
 365     'mkdru_block_facet' => array(
 366       'template' => 'mkdru-block-facet',
 367       'arguments' => array('class' => NULL)
 368     )
 369   );
 370 }
 371
 372 /**
 373 * Theme function to include Javascript search client and deps
 374 */
 375 function theme_mkdru_js($node) {
 376   $path = drupal_get_path('module', 'mkdru');
 377   // Pazpar2 client library.
 378   drupal_add_js(variable_get('pz2_js_path', 'pazpar2/js') . '/pz2.js', 'module', 'footer', TRUE, TRUE, FALSE);
 379   // jQuery plugin for query string/history manipulation.
 380   drupal_add_js($path . '/jquery.ba-bbq.js', 'module', 'footer', TRUE, TRUE, FALSE);
 381   drupal_add_js($path . '/mkdru.theme.js', 'module', 'footer', TRUE, TRUE, FALSE);
 382   drupal_add_js($path . '/mkdru.client.js', 'module', 'footer', TRUE, TRUE, FALSE);
 383   drupal_add_js(array('mkdru' => $node->mkdru), 'setting');
 384   drupal_add_js(array('mkdru' =>
 385     array(
 386       'settings' => $node->settings,
 387     )
 388   ), 'setting');
 389 }
 390
 391 /**
 392 * Implements hook_view()
 393 */
 394 function mkdru_view($node, $teaser = FALSE, $page = FALSE) {
 395   $node->content['mkdru_js'] = array(
 396     '#value' => theme('mkdru_js', $node),
 397     '#weight' => 0,
 398   );
 399   $node->content['mkdru_form'] = array(
 400     '#value' => theme('mkdru_form'),
 401     '#weight' => 1,
 402   );
 403   $node->content['mkdru_results'] = array(
 404     '#value' => theme('mkdru_results'),
 405     '#weight' => 2,
 406   );
 407   return $node;
 408 }
 409
 410 /**
 411 * Implements hook_block()
 412 */
 413 function mkdru_block($op='list', $delta='sources', $edit=array()) {
 414   switch ($op) {
 415     case 'list':
 416       // facet blocks
 417       // D6 has no setting for note type visibility, set
 418       // the default to limit facet display to this type
 419       $visPHP = '<?php
 420   if (arg(0) == "node" && is_numeric(arg(1))) {
 421     $node = node_load(array("nid" => arg(1)));
 422     return $node->type == "mkdru";
 423   }
 424 ?>';
 425
 426       // NB: block caching is redundant for static content
 427       $blocks['mkdru_sources']['info'] = t('mkdru - source facets');
 428       $blocks['mkdru_sources']['cache'] = BLOCK_NO_CACHE;
 429       $blocks['mkdru_sources']['visibility'] = 2;
 430       $blocks['mkdru_sources']['pages'] = $visPHP;
 431       $blocks['mkdru_subjects']['info'] = t('mkdru - subject facets');
 432       $blocks['mkdru_subjects']['cache'] = BLOCK_NO_CACHE;
 433       $blocks['mkdru_subjects']['visibility'] = 2;
 434       $blocks['mkdru_subjects']['pages'] = $visPHP;
 435       $blocks['mkdru_authors']['info'] = t('mkdru - author facets');
 436       $blocks['mkdru_authors']['cache'] = BLOCK_NO_CACHE;
 437       $blocks['mkdru_authors']['visibility'] = 2;
 438       $blocks['mkdru_authors']['pages'] = $visPHP;
 439       // search blocks
 440       $result = db_query("SELECT title, nid FROM {node} WHERE type = 'mkdru';");
 441       while ($node = db_fetch_object($result)) {
 442         $blocks['mkdru_search_' . $node->nid]['info'] =
 443            t('mkdru - search box for "' . $node->title . '"');
 444         $blocks['mkdru_sources']['cache'] = BLOCK_NO_CACHE;
 445       };
 446       return $blocks;
 447
 448     case 'view':
 449       switch ($delta) {
 450         case 'mkdru_sources':
 451           $block['subject'] = t('Source');
 452           $block['content'] = theme('mkdru_block_facet', 'mkdru-facet-source');
 453           return $block;
 454         case 'mkdru_subjects':
 455           $block['subject'] = t('Subject');
 456           $block['content'] = theme('mkdru_block_facet', 'mkdru-facet-subject');
 457           return $block;
 458         case 'mkdru_authors':
 459           $block['subject'] = t('Author');
 460           $block['content'] = theme('mkdru_block_facet', 'mkdru-facet-author');
 461           return $block;
 462     }
 463     if (substr($delta, 0, 13) == 'mkdru_search_') {
 464       $nid = substr($delta, 13);
 465       $block['content'] = theme('mkdru_block_search', $nid, '/node/' . $nid);
 466       return $block;
 467     }
 468   }
 469 }