array(
'name' => t("Pazpar2 metasearch interface"),
'base' => 'mkdru',
'description' => t("Metasearch interface for Z39.50/SRU and other targets via a Pazpar2/Service Proxy backend"),
)
);
}
/**
* Implements hook_search_info()
*/
function mkdru_search_info() {
return array(
'title' => 'Meta search',
'path' => 'meta',
'conditions_callback' => 'mkdru_search_conditions_callback',
);
}
/**
* Implements hook_search_page()
*/
function mkdru_search_page($results) {
$output['prefix']['#markup'] = theme('mkdru_results');
$output['suffix']['#markup'] = '';
return $output;
}
/**
* Implements hook_ding_facetbrowser()
*/
function mkdru_ding_facetbrowser() {
$results = new stdClass();
$results->facets = array();
$results->show_empty = TRUE; # Show an empty facetbrowser block, even if search didn't return any results
return $results;
}
/**
* Search callback function that is invoked by search_view()
*/
function mkdru_search_conditions_callback($keys) {}
/**
* Implement hook_search_execute()
*/
function mkdru_search_execute($keys = NULL, $conditions = NULL) {
$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 . '/recipe.js',
array('type' => 'file', 'scope' => 'footer'));
drupal_add_js($path . '/mkdru.theme.js',
array('type' => 'file', 'scope' => 'footer'));
drupal_add_js($path . '/mkdru.client.js',
array('type' => 'file', 'scope' => 'footer'));
drupal_add_js(array('mkdru' =>
array(
'use_sessions' => variable_get('use_sessions', '1'),
'pz2_path' => variable_get('pz2_path', '/pazpar2/search.pz2'),
'sp_user' => variable_get('sp_user', ''),
'sp_pass' => variable_get('sp_pass', ''),
'query' => $keys,
)
), 'setting');
return array();
}
/**
* Implements hook_permission()
*/
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'),
),
);
}
/**
* Implements hook_node_access()
*/
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);
}
// Users who create a node may edit or delete it later, assuming they have the
// necessary permissions.
if ($op == 'update' || $op == 'delete') {
if (user_access('edit own metasearch interface', $account) && ($account->uid == $node->uid)) {
return TRUE;
}
elseif (user_access('edit any metasearch interface', $account)) {
return TRUE;
}
}
}
/**
* Implements hook_menu()
*/
function mkdru_menu() {
$items['admin/config/search/mkdru'] = array(
'title' => 'Configure Pazpar2 metasearch integration',
'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',
);
$items['admin/config/search/mkdru/defaults'] = array(
'title' => 'Default settings for Pazpar2 metasearch integration',
'description' => 'Settings for mkdru.',
'page callback' => 'drupal_get_form',
'page arguments' => array('mkdru_admin_settings'),
'access arguments' => array('administer site configuration'),
'type' => MENU_LOCAL_TASK,
'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');
}
// Config form common to node and settings
function mkdru_settings_form($form, &$form_state) {
// dpm($form);
dpm($form_state);
// dpm($settings);
if (isset($form_state['values']['settings'])) {
$settings = $form_state['values']['settings'];
}
else if (isset($form_state['build_info']['args']['settings'])) {
$settings = $form_state['build_info']['args']['settings'];
}
else {
$settings = variable_get('mkdru_defaults');
}
$form['settings'] = array(
'#tree' => TRUE,
);
$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' => $settings['pz2_path'],
);
$form['settings']['use_sessions'] = array(
'#type' => 'checkbox',
'#title' => t('Session handling'),
'#description' => t('Disable for use with Service Proxy'),
'#default_value' => $settings['use_sessions'],
);
$form['settings']['sp'] = array(
'#type' => 'fieldset',
'#title' => t('Service Proxy specific settings'),
'#collapsible' => TRUE,
'#collapsed' => TRUE
);
$form['settings']['sp']['user'] = array(
'#type' => 'password',
'#title' => t('Service Proxy username'),
'#description' => t('Service Proxy username'),
'#required' => FALSE,
'#default_value' => $settings['sp']['user'],
);
$form['settings']['sp']['pass'] = array(
'#type' => 'textfield',
'#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
);
foreach (array_keys($settings['facets']) 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;
}
// Node config
/**
* Implements hook_form()
*/
function mkdru_form(&$node, &$form_state) {
if (isset($node->mkdru->settings)) {
// Second decode parameter indicates associative array
$form_state['build_info']['args']['settings'] = json_decode($node->mkdru->settings, TRUE);
}
$form = drupal_retrieve_form('mkdru_settings_form', $form_state);
$type = node_type_get_type($node);
$form['title'] = array(
'#type' => 'textfield',
'#title' => check_plain($type->title_label),
'#required' => FALSE,
'#default_value' => $node->title,
'#weight' => -5
);
return $form;
}
function mkdru_add_facet_form($form, &$form_state) {
// TODO: validation
$newfacet = $form_state['values']['new_facet']['canonical'];
$form_state['values']['settings']['facets'][$newfacet] = NULL;
$form_state['rebuild'] = TRUE;
}
function mkdru_add_facet_callback($form, $form_state) {
return $form['settings']['facets'];
}
/**
* Implements hook_validate()
*/
function mkdru_validate($node) {
// TODO: validation
// if (!is_numeric($node->source_max)) {
// form_set_error('source_max', t('Please enter a number.'));
// }
}
/**
* Implements hook_insert().
*/
function mkdru_insert($node) {
$fields = array('nid' => $node->nid, 'vid' => $node->vid,
'settings' => json_encode($node->settings));
db_insert('mkdru')->fields($fields)->execute();
}
/**
* Implements hook_update().
*/
function mkdru_update($node) {
if ($node->revision) {
// New revision; treat it as a new record.
mkdru_insert($node);
}
else {
db_update('mkdru')
->condition('vid', $node->vid)
->fields(array('settings' => json_encode($node->settings)))
->execute();
}
}
/**
* 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;
}
}
/**
* Implements hook_theme().
*/
function mkdru_theme() {
return array(
'mkdru_form' => array(
'template' => 'mkdru-form',
'variables' => array(),
),
'mkdru_results' => array(
'template' => 'mkdru-results',
'variables' => array(),
),
'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_js(&$variables) {
$path = drupal_get_path('module', 'mkdru');
// 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');
}
/**
* Implements hook_view()
*/
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
/**
* Implements hook_block_info()
*/
function mkdru_block_info() {
// facet blocks
$blocks = array();
$facets = variable_get('mkdru_facets', array());
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;
}
}