X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=mkdru.module;h=24e36c29aa92567485482a1a033b1518988fa673;hb=2d59c2185252e78c28eee2f778e5893e5fc78c57;hp=b5718cc91a8c596268b2d48254f51aa7b4762957;hpb=2706489442d1d5182dc9d3ef30522bbae1ae7a28;p=mkdru-moved-to-drupal.org.git
diff --git a/mkdru.module b/mkdru.module
index b5718cc..24e36c2 100644
--- a/mkdru.module
+++ b/mkdru.module
@@ -5,31 +5,48 @@
// 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"),
+ '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) {
- return array("content" => "You have searched for '".$params['keys']."'.");
+function mkdru_ting_search_tab($keys) {
+ error_log("TING SEARCH TAB invoked");
+ $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 . '/recipe.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(
+ 'settings' => json_encode(variable_get('mkdru_ding', NULL)),
+ 'pz2_path' => variable_get('pz2_path', '/pazpar2/search.pz2'),
+ 'query' => $keys
+ )
+ ), 'setting');
+ return array("content" => $html, "title" => "Meta Search");
}
/**
-* Implementation of hook_perm()
+* Implements hook_perm()
*/
function mkdru_perm() {
return array('create metasearch interface', 'edit any metasearch interface', 'edit own metasearch interface');
}
/**
-* Implementation of hook_access()
+* Implements hook_access()
*/
function mkdru_access($op, $node, $account) {
@@ -51,11 +68,11 @@ function mkdru_access($op, $node, $account) {
}
/**
-* Implementation of hook_menu()
+* Implements hook_menu()
*/
function mkdru_menu() {
$items['admin/settings/mkdru'] = array(
- 'title' => 'mkdru Settings',
+ 'title' => 'Pazpar2 Metasearch Settings',
'description' => 'Settings for mkdru.',
'page callback' => 'drupal_get_form',
'page arguments' => array('mkdru_admin_settings'),
@@ -63,13 +80,21 @@ function mkdru_menu() {
'type' => MENU_NORMAL_ITEM,
'file' => 'mkdru.admin.inc',
);
+ $items['admin/settings/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;
}
/**
-* Implementation of hook_init()
+* Implements hook_init()
*/
-function mkdru_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.
@@ -77,101 +102,199 @@ function mkdru_init(){
}
+// Config form common to node and settings
+// function mkdru_settings_form($form, &$form_state) {
+function mkdru_settings_form(&$form_state) {
+ if (isset($form_state['values']['settings'])) {
+ $settings = $form_state['build_info']['args']['settings'];
+ }
+ else if (isset($form_state['build_info']['args']['settings'])) {
+ $settings = $form_state['build_info']['args']['settings'];
+ }
+ else {
+ $settings = variable_get('mkdru_defaults', NULL);
+ }
-// Node config
-/**
-* Implementation of hook_form()
-*/
-function mkdru_form(&$node, $form_state) {
- $type = node_get_types('type', $node);
-
- $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['display_settings'] = array(
+ $form['settings']['sp'] = array(
'#type' => 'fieldset',
- '#title' => t('Display settings'),
+ '#title' => t('Service Proxy specific settings'),
'#collapsible' => TRUE,
'#collapsed' => FALSE
);
- $form['display_settings']['source_max'] = array(
+ $form['settings']['sp']['user'] = 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,
+ '#title' => t('Service Proxy username'),
+ '#description' => t('Service Proxy username'),
+ '#required' => FALSE,
+ '#default_value' => $settings['sp']['user'],
);
- $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['settings']['sp']['pass'] = array(
+ '#type' => 'password',
+ '#title' => t('Service Proxy password'),
+ '#description' => t('Service Proxy password'),
+ '#required' => FALSE,
+ '#default_value' => $settings['sp']['pass'],
+ );
+
+ $form['settings']['facets'] = array(
+ '#type' => 'fieldset',
+ '#title' => t('Facet settings'),
+ // Set up the wrapper so that AJAX will be able to replace the fieldset.
+ '#prefix' => '
',
+ '#suffix' => '
',
+ '#collapsible' => TRUE,
+ '#collapsed' => FALSE
+ );
+ if (empty($form_state['facet_names'])) {
+ $form_state['facet_names'] = array('source', 'author', 'subject');
+ }
+ foreach ($form_state['facet_names'] 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]['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['new_facet'] = array(
+// '#type' => 'fieldset',
+// '#title' => t('Add new facet...'),
+// '#tree' => TRUE,
+// '#collapsible' => TRUE,
+// '#collapsed' => FALSE
+// );
+// $form['new_facet']['canonical'] = array(
+// '#type' => 'textfield',
+// '#title' => t('Canonical name of new facet'),
+// );
+// $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_add_facet_callback',
+// 'wrapper' => 'mkdru-facets-form-wrapper',
+// ),
+// );
+ return $form;
+}
+
+
+
+// Ding config
+function mkdru_ding_settings(&$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('Default search settings');
+ $form['submit'] = array(
+ '#type' => 'submit',
+ '#value' => 'Save configuration',
);
- $form['display_settings']['subject_max'] = array(
+ 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->settings)) {
+ // Second decode parameter indicates associative array
+ $form_state['build_info']['args']['settings'] = json_decode($node->settings, TRUE);
+ }
+
+ $form = drupal_retrieve_form('mkdru_settings_form', &$form_state);
+
+ $type = node_get_types('type', $node);
+ $form['title'] = 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,
+ '#title' => check_plain($type->title_label),
+ '#required' => FALSE,
+ '#default_value' => $node->title,
+ '#weight' => -5
);
return $form;
}
/**
-* Implementation of hook_validate()
+* 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
}
/**
-* Implementation of hook_insert().
+* Implements 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);
+ $record['nid'] = $node->nid;
+ $record['vid'] = $node->vid;
+ $record['settings'] = json_encode($node->settings);
+ drupal_write_record('mkdru', &$record);
}
/**
-* Implementation of hook_update().
+* Implements hook_update().
*/
function mkdru_update($node) {
if ($node->revision) {
@@ -179,12 +302,15 @@ function mkdru_update($node) {
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);
+ $record['nid'] = $node->nid;
+ $record['vid'] = $node->vid;
+ $record['settings'] = json_encode($node->settings);
+ drupal_write_record('mkdru', &$record, 'vid');
}
}
/**
- * Implementation of hook_nodeapi().
+ * Implements 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
@@ -199,7 +325,7 @@ function mkdru_nodeapi(&$node, $op, $teaser, $page) {
}
/**
- * Implementation of hook_delete().
+ * Implements hook_delete().
*/
function mkdru_delete($node) {
// Deleting by nid covers all revisions.
@@ -210,15 +336,14 @@ function mkdru_delete($node) {
// Node rendering
/**
-* Implementation of hook_load()
+* Implements hook_load()
*/
function mkdru_load($node) {
- return array('mkdru' => db_fetch_object(db_query(
- 'SELECT * FROM {mkdru} WHERE vid = %d', $node->vid)));
+ return db_fetch_object(db_query('SELECT * FROM {mkdru} WHERE vid = %d', $node->vid));
}
/**
-* Implementation of hook_theme().
+* Implements hook_theme().
*/
function mkdru_theme() {
return array(
@@ -233,10 +358,14 @@ function mkdru_theme() {
'mkdru_js' => array(
'arguments' => array('node' => NULL),
),
-// 'mkdru_block_facet' => array(
-// 'template' => 'mkdru-block-facet',
-// 'arguments' => array('divId' => 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('class' => NULL)
+ )
);
}
@@ -245,15 +374,22 @@ function mkdru_theme() {
*/
function theme_mkdru_js($node) {
$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 . '/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');
+ drupal_add_js(array('mkdru' =>
+ array(
+ 'settings' => $node->settings,
+ )
+ ), 'setting');
}
/**
-* Implementation of hook_view()
+* Implements hook_view()
*/
function mkdru_view($node, $teaser = FALSE, $page = FALSE) {
$node->content['mkdru_js'] = array(
@@ -272,46 +408,62 @@ function mkdru_view($node, $teaser = FALSE, $page = FALSE) {
}
/**
-* Implementation of hook_block()
+* Implements hook_block()
*/
function mkdru_block($op='list', $delta='sources', $edit=array()) {
switch ($op) {
case 'list':
+ // facet blocks
+ // D6 has no setting for note type visibility, set
+ // the default to limit facet display to this type
+ $visPHP = ' arg(1)));
+ return $node->type == "mkdru";
+ }
+?>';
+
+ // 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_sources']['visibility'] = 2;
+ $blocks['mkdru_sources']['pages'] = $visPHP;
$blocks['mkdru_subjects']['info'] = t('mkdru - subject facets');
$blocks['mkdru_subjects']['cache'] = BLOCK_NO_CACHE;
+ $blocks['mkdru_subjects']['visibility'] = 2;
+ $blocks['mkdru_subjects']['pages'] = $visPHP;
$blocks['mkdru_authors']['info'] = t('mkdru - author facets');
$blocks['mkdru_authors']['cache'] = BLOCK_NO_CACHE;
+ $blocks['mkdru_authors']['visibility'] = 2;
+ $blocks['mkdru_authors']['pages'] = $visPHP;
+ // 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':
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'] = '
';
+ $block['content'] = theme('mkdru_block_facet', 'mkdru-facet-source');
return $block;
case 'mkdru_subjects':
$block['subject'] = t('Subject');
- $block['content'] = '
';
+ $block['content'] = theme('mkdru_block_facet', 'mkdru-facet-subject');
return $block;
case 'mkdru_authors':
$block['subject'] = t('Author');
- $block['content'] = '
';
+ $block['content'] = theme('mkdru_block_facet', 'mkdru-facet-author');
return $block;
}
+ if (substr($delta, 0, 13) == 'mkdru_search_') {
+ $nid = substr($delta, 13);
+ $block['content'] = theme('mkdru_block_search', $nid, '/node/' . $nid);
+ return $block;
+ }
}
}