X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=mkdru.module;h=ac0609755469b25d84c865423b148c54c67f9305;hb=4b3873f962312d06553eb7ffe4e7dd1d0e56d058;hp=1ffb195ffba7a8e94e62acb9cdb0cec60301111b;hpb=e4a8cff5ea6f81be77a9431ac7e7aa98b20b0248;p=mkdru-moved-to-drupal.org.git diff --git a/mkdru.module b/mkdru.module index 1ffb195..ac06097 100644 --- a/mkdru.module +++ b/mkdru.module @@ -1,28 +1,46 @@ array( - 'name' => t("Z39.50/SRU metasearch interface"), + 'name' => t("Pazpar2 metasearch interface"), 'module' => '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', 'module', 'footer'); + drupal_add_js($path . '/jquery.ba-bbq.js', 'module', 'footer'); + drupal_add_js($path . '/mkdru.theme.js', 'module', 'footer'); + drupal_add_js($path . '/mkdru.client.js', 'module', '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(). +* Implementation of hook_perm() */ function mkdru_perm() { return array('create metasearch interface', 'edit any metasearch interface', 'edit own metasearch interface'); } /** -* Implementation of hook_access(). +* Implementation of hook_access() */ function mkdru_access($op, $node, $account) { @@ -36,14 +54,44 @@ 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(). +* Implementation of 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 +/** +* Implementation of hook_form() */ function mkdru_form(&$node, $form_state) { $type = node_get_types('type', $node); @@ -51,26 +99,155 @@ function mkdru_form(&$node, $form_state) { $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['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; } + +/** +* Implementation of 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.')); + } +} + +/** +* Implementation of hook_insert(). +*/ +function mkdru_insert($node) { + db_query("INSERT INTO {mkdru} (nid, vid, pz2_path, use_sessions, source_max, author_max, subject_max) VALUES (%d, %d, '%s', %d, %d, %d, %d)", + $node->nid, $node->vid, $node->pz2_path, $node->use_sessions, $node->source_max, $node->author_max, $node->subject_max); +} + +/** +* Implementation of hook_update(). +*/ +function mkdru_update($node) { + if ($node->revision) { + // New revision; treat it as a new record. + mkdru_insert($node); + } + else { + db_query("UPDATE {mkdru} SET pz2_path = '%s', use_sessions = %d, source_max = %d, author_max = %d, subject_max = %d WHERE vid = %d", $node->pz2_path, $node->use_sessions, $node->source_max, $node->author_max, $node->subject_max, $node->vid); + } +} + +/** + * Implementation of hook_nodeapi(). + * + * When a node revision is deleted, we need to remove the corresponding record + * from our table. The only way to handle revision deletion is by implementing + * hook_nodeapi(). + */ +function mkdru_nodeapi(&$node, $op, $teaser, $page) { + switch ($op) { + case 'delete revision': + db_query('DELETE FROM {mkdru} WHERE vid = %d', $node->vid); + break; + } +} + +/** + * Implementation of hook_delete(). + */ +function mkdru_delete($node) { + // Deleting by nid covers all revisions. + db_query('DELETE FROM {mkdru} WHERE nid = %d', $node->nid); +} + + + +// Node rendering +/** +* Implementation of hook_load() +*/ +function mkdru_load($node) { + return array('mkdru' => db_fetch_object(db_query( + 'SELECT * FROM {mkdru} WHERE vid = %d', $node->vid))); +} + /** * Implementation of hook_theme(). */ function mkdru_theme() { return array( - 'mkdru_page' => array( - 'template' => 'mkdru-page', + 'mkdru_form' => array( + 'template' => 'mkdru-form', 'arguments' => array(), ), - 'mkdru_page_js' => array( + 'mkdru_results' => array( + 'template' => 'mkdru-results', 'arguments' => array(), ), + 'mkdru_js' => array( + 'arguments' => array('node' => NULL), + ), + 'mkdru_block_search' => array( + 'template' => 'mkdru-block-search', + 'arguments' => array('nid' => null, 'path' => NULL), + ), // 'mkdru_block_facet' => array( // 'template' => 'mkdru-block-facet', // 'arguments' => array('divId' => NULL), @@ -81,25 +258,33 @@ function mkdru_theme() { /** * Theme function to include Javascript search client and deps */ -function theme_mkdru_page_js() { +function theme_mkdru_js($node) { $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', 'module', 'footer', TRUE, TRUE, FALSE); + // jQuery plugin for query string/history manipulation. + drupal_add_js($path . '/jquery.ba-bbq.js', 'module', 'footer', TRUE, TRUE, FALSE); + drupal_add_js($path . '/mkdru.theme.js', 'module', 'footer', TRUE, TRUE, FALSE); + drupal_add_js($path . '/mkdru.client.js', 'module', 'footer', TRUE, TRUE, FALSE); + drupal_add_js(array('mkdru' => $node->mkdru), 'setting'); } /** * Implementation of hook_view() */ function mkdru_view($node, $teaser = FALSE, $page = FALSE) { - $node->content['mkdru_page_js'] = array( - '#value' => theme('mkdru_page_js'), + $node->content['mkdru_js'] = array( + '#value' => theme('mkdru_js', $node), '#weight' => 0, ); - $node->content['mkdru_page'] = array( - '#value' => theme('mkdru_page'), + $node->content['mkdru_form'] = array( + '#value' => theme('mkdru_form'), '#weight' => 1, ); + $node->content['mkdru_results'] = array( + '#value' => theme('mkdru_results'), + '#weight' => 2, + ); return $node; } @@ -109,12 +294,21 @@ function mkdru_view($node, $teaser = FALSE, $page = FALSE) { function mkdru_block($op='list', $delta='sources', $edit=array()) { switch ($op) { case 'list': + // facet blocks + // NB: block caching is redundant for static content $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; + // search blocks + $result = db_query("SELECT title, nid FROM {node} WHERE type = 'mkdru';"); + while ($node = db_fetch_object($result)) { + $blocks['mkdru_search_' . $node->nid]['info'] = + t('mkdru - search box for "' . $node->title . '"'); + $blocks['mkdru_sources']['cache'] = BLOCK_NO_CACHE; + }; return $blocks; case 'view': @@ -134,16 +328,21 @@ function mkdru_block($op='list', $delta='sources', $edit=array()) { // return $block; case 'mkdru_sources': $block['subject'] = t('Source'); - $block['content'] = '
'; + $block['content'] = '
'; return $block; case 'mkdru_subjects': $block['subject'] = t('Subject'); - $block['content'] = '
'; + $block['content'] = '
'; return $block; case 'mkdru_authors': $block['subject'] = t('Author'); - $block['content'] = '
'; + $block['content'] = '
'; return $block; } + if (substr($delta, 0, 13) == 'mkdru_search_') { + $nid = substr($delta, 13); + $block['content'] = theme('mkdru_block_search', $nid, '/node/' . $nid); + return $block; + } } -} \ No newline at end of file +}