8 * Implements hook_node_info()
10 function mkdru_node_info() {
13 'name' => t("Pazpar2 metasearch interface"),
15 'description' => t("Metasearch interface for Z39.50/SRU and other targets via a Pazpar2/Service Proxy backend"),
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' =>
33 'settings' => json_encode(variable_get('mkdru_ding', NULL)),
34 'pz2_path' => variable_get('pz2_path', '/pazpar2/search.pz2'),
38 return array("content" => $html, "title" => "Meta Search");
42 * Implements hook_perm()
44 function mkdru_perm() {
45 return array('create metasearch interface', 'edit any metasearch interface', 'edit own metasearch interface');
49 * Implements hook_access()
51 function mkdru_access($op, $node, $account) {
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);
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)) {
64 elseif (user_access('edit any metasearch interface', $account)) {
71 * Implements hook_menu()
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',
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,
95 * Implements hook_init()
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');
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'];
111 else if (isset($form_state['build_info']['args']['settings'])) {
112 $settings = $form_state['build_info']['args']['settings'];
115 $settings = variable_get('mkdru_defaults', NULL);
118 $form['settings'] = array(
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'),
127 '#default_value' => $settings['pz2_path'],
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'],
136 $form['settings']['sp'] = array(
137 '#type' => 'fieldset',
138 '#title' => t('Service Proxy specific settings'),
139 '#collapsible' => TRUE,
140 '#collapsed' => FALSE
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'],
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'],
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
166 if (empty($form_state['facet_names'])) {
167 $form_state['facet_names'] = array('source', 'author', 'subject');
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
176 $form['settings']['facets'][$facet]['displayName'] = array(
177 '#type' => 'textfield',
178 '#title' => t('Facet name to display in UI'),
180 '#default_value' => $settings['facets'][$facet]['displayName'],
182 $form['settings']['facets'][$facet]['pz2Name'] = array(
183 '#type' => 'textfield',
184 '#title' => t('Name of termlist in Pazpar2'),
186 '#default_value' => $settings['facets'][$facet]['pz2Name'],
188 $form['settings']['facets'][$facet]['limiter'] = array(
189 '#type' => 'textfield',
190 '#title' => t('Query limiter string'),
191 '#default_value' => $settings['facets'][$facet]['limiter'],
194 $form['settings']['facets'][$facet]['max'] = array(
195 '#type' => 'textfield',
196 '#title' => t('Number of terms to display'),
198 '#default_value' => $settings['facets'][$facet]['max'],
202 $form['settings']['facets'][$facet]['orderWeight'] = array(
203 '#type' => 'textfield',
204 '#title' => t('Facet weight'),
205 '#default_value' => $settings['facets'][$facet]['orderWeight'],
210 // $form['new_facet'] = array(
211 // '#type' => 'fieldset',
212 // '#title' => t('Add new facet...'),
214 // '#collapsible' => TRUE,
215 // '#collapsed' => FALSE
217 // $form['new_facet']['canonical'] = array(
218 // '#type' => 'textfield',
219 // '#title' => t('Canonical name of new facet'),
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'),
226 // '#submit' => array('mkdru_add_facet_form'),
228 // 'callback' => 'mkdru_add_facet_callback',
229 // 'wrapper' => 'mkdru-facets-form-wrapper',
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(
244 '#value' => 'Save configuration',
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.'));
257 * Implements hook_form()
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);
265 $form = drupal_retrieve_form('mkdru_settings_form', &$form_state);
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,
280 * Implements hook_validate()
282 function mkdru_validate($node) {
287 * Implements hook_insert().
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);
297 * Implements hook_update().
299 function mkdru_update($node) {
300 if ($node->revision) {
301 // New revision; treat it as a new record.
305 $record['nid'] = $node->nid;
306 $record['vid'] = $node->vid;
307 $record['settings'] = json_encode($node->settings);
308 drupal_write_record('mkdru', &$record, 'vid');
313 * Implements hook_nodeapi().
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
319 function mkdru_nodeapi(&$node, $op, $teaser, $page) {
321 case 'delete revision':
322 db_query('DELETE FROM {mkdru} WHERE vid = %d', $node->vid);
328 * Implements hook_delete().
330 function mkdru_delete($node) {
331 // Deleting by nid covers all revisions.
332 db_query('DELETE FROM {mkdru} WHERE nid = %d', $node->nid);
339 * Implements hook_load()
341 function mkdru_load($node) {
342 return db_fetch_object(db_query('SELECT * FROM {mkdru} WHERE vid = %d', $node->vid));
346 * Implements hook_theme().
348 function mkdru_theme() {
350 'mkdru_form' => array(
351 'template' => 'mkdru-form',
352 'arguments' => array(),
354 'mkdru_results' => array(
355 'template' => 'mkdru-results',
356 'arguments' => array(),
359 'arguments' => array('node' => NULL),
361 'mkdru_block_search' => array(
362 'template' => 'mkdru-block-search',
363 'arguments' => array('nid' => NULL, 'path' => NULL),
365 'mkdru_block_facet' => array(
366 'template' => 'mkdru-block-facet',
367 'arguments' => array('class' => NULL)
373 * Theme function to include Javascript search client and deps
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' =>
386 'settings' => $node->settings,
392 * Implements hook_view()
394 function mkdru_view($node, $teaser = FALSE, $page = FALSE) {
395 $node->content['mkdru_js'] = array(
396 '#value' => theme('mkdru_js', $node),
399 $node->content['mkdru_form'] = array(
400 '#value' => theme('mkdru_form'),
403 $node->content['mkdru_results'] = array(
404 '#value' => theme('mkdru_results'),
411 * Implements hook_block()
413 function mkdru_block($op='list', $delta='sources', $edit=array()) {
417 // D6 has no setting for note type visibility, set
418 // the default to limit facet display to this type
420 if (arg(0) == "node" && is_numeric(arg(1))) {
421 $node = node_load(array("nid" => arg(1)));
422 return $node->type == "mkdru";
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;
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;
450 case 'mkdru_sources':
451 $block['subject'] = t('Source');
452 $block['content'] = theme('mkdru_block_facet', 'mkdru-facet-source');
454 case 'mkdru_subjects':
455 $block['subject'] = t('Subject');
456 $block['content'] = theme('mkdru_block_facet', 'mkdru-facet-subject');
458 case 'mkdru_authors':
459 $block['subject'] = t('Author');
460 $block['content'] = theme('mkdru_block_facet', 'mkdru-facet-author');
463 if (substr($delta, 0, 13) == 'mkdru_search_') {
464 $nid = substr($delta, 13);
465 $block['content'] = theme('mkdru_block_search', $nid, '/node/' . $nid);