From 60cbb36f67468e16adad80eaa55f436798eb56ea Mon Sep 17 00:00:00 2001 From: Jason Skomorowski Date: Thu, 17 Mar 2011 07:08:19 +0100 Subject: [PATCH] AJAX facets w/JSON serialised settings. --- mkdru.admin.inc | 8 +-- mkdru.info | 1 + mkdru.install | 75 ++++++++------------ mkdru.module | 207 ++++++++++++++++++++++++++++++++++++++----------------- 4 files changed, 175 insertions(+), 116 deletions(-) diff --git a/mkdru.admin.inc b/mkdru.admin.inc index 085c7a5..78ebf65 100644 --- a/mkdru.admin.inc +++ b/mkdru.admin.inc @@ -1,11 +1,5 @@ -// $Id$ - -/** - * @file - * Module config. - */ 'textfield', '#title' => t('Path to Pazpar2 client library'), diff --git a/mkdru.info b/mkdru.info index 6725d4b..c03c0dc 100644 --- a/mkdru.info +++ b/mkdru.info @@ -2,3 +2,4 @@ name = Pazpar2 metasearch integration description = Metasearching of Z39.50, SRU and SOLR targets via Index Data's Pazpar2 and associated tool stack. core = 7.x dependencies[] = block +configure = admin/config/search/mkdru \ No newline at end of file diff --git a/mkdru.install b/mkdru.install index 56b8d4b..9bdf3a5 100644 --- a/mkdru.install +++ b/mkdru.install @@ -26,44 +26,10 @@ function mkdru_schema() { 'not null' => TRUE, 'default' => 0 ), - 'pz2_path' => array( + 'settings' => array( 'type' => 'text', 'not null' => TRUE, - 'description' => 'Path to Pazpar2 or Service Proxy.', - ), - 'use_sessions' => array( - 'description' => 'Session handling toggle.', - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => TRUE, - ), - 'source_max' => array( - 'description' => 'Number of sources to display', - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => TRUE, - ), - 'author_max' => array( - 'description' => 'Number of authors to display', - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => TRUE, - ), - 'subject_max' => array( - 'description' => 'Number of subjects to display', - 'type' => 'int', - 'unsigned' => TRUE, - 'not null' => TRUE, - ), - 'sp_user' => array( - 'type' => 'text', - 'not null' => FALSE, - 'description' => 'Service Proxy username' - ), - 'sp_pass' => array( - 'type' => 'text', - 'not null' => FALSE, - 'description' => 'Service Proxy password' + 'description' => 'Metasearch settings', ), ), 'primary key' => array('nid', 'vid'), @@ -79,17 +45,32 @@ function mkdru_schema() { function mkdru_install() { // Disable comments by default variable_set('comment_mkdru', COMMENT_NODE_HIDDEN); - // Facets - $facets = array('source', 'subject', 'author'); - variable_set('mkdru_facets', $facets); - // Restrict facet block visibility - foreach ($facets as $facet) { - db_insert('block_node_type') - ->fields(array( - 'module' => 'mkdru', - 'delta' => 'mkdru_facet_' . $facet, - 'type' => 'mkdru'))->execute(); - } + + // Default settings + $settings['title'] = ""; + $settings['pz2_path'] = "/pazpar2/search.pz2"; + $settings['use_sessions'] = 1; + $settings['sp']['user'] = ""; + $settings['sp']['pass'] = ""; + $settings['facets']['source']['displayName'] = "Source"; + $settings['facets']['source']['pz2Name'] = "xtargets"; + $settings['facets']['source']['limiter'] = NULL; + $settings['facets']['source']['multiLimit'] = NULL; + $settings['facets']['source']['max'] = 10; + $settings['facets']['source']['orderWeight'] = 1; + $settings['facets']['subject']['displayName'] = "Subject"; + $settings['facets']['subject']['pz2Name'] = "subject"; + $settings['facets']['subject']['limiter'] = "su"; + $settings['facets']['subject']['multiLimit'] = TRUE; + $settings['facets']['subject']['max'] = 10; + $settings['facets']['subject']['orderWeight'] = 2; + $settings['facets']['author']['displayName'] = "Author"; + $settings['facets']['author']['pz2Name'] = "author"; + $settings['facets']['author']['limiter'] = "au"; + $settings['facets']['author']['multiLimit'] = FALSE; + $settings['facets']['author']['max'] = 10; + $settings['facets']['author']['orderWeight'] = 3; + variable_set('mkdru_defaults', $settings); } /** diff --git a/mkdru.module b/mkdru.module index 0e4daf1..f1dcfc6 100644 --- a/mkdru.module +++ b/mkdru.module @@ -125,8 +125,8 @@ function mkdru_node_access($node, $op, $account) { * Implements hook_menu() */ function mkdru_menu() { - $items['admin/settings/mkdru'] = array( - 'title' => 'mkdru Settings', + $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'), @@ -134,6 +134,15 @@ function mkdru_menu() { '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; } @@ -149,118 +158,189 @@ function mkdru_init() { -// Node config -/** -* Implements hook_form() -*/ -function mkdru_form(&$node, $form_state) { - $type = node_type_get_type($node); +// 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['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'); + } + + $form['settings'] = array( + '#tree' => TRUE, + ); - $form['title'] = array( + $form['settings']['title'] = array( '#type' => 'textfield', - '#title' => check_plain($type->title_label), + '#title' => t('Search title'), '#required' => FALSE, - '#default_value' => $node->title, + '#default_value' => $settings['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( + $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['sp_settings'] = array( + $form['settings']['sp'] = array( '#type' => 'fieldset', '#title' => t('Service Proxy specific settings'), '#collapsible' => TRUE, '#collapsed' => TRUE ); - $form['sp_settings']['sp_user'] = array( - '#type' => 'textfield', + $form['settings']['sp']['user'] = array( + '#type' => 'password', '#title' => t('Service Proxy username'), '#description' => t('Service Proxy username'), '#required' => FALSE, - '#default_value' => isset($node->mkdru->sp_user) ? - $node->mkdru->sp_user : '', + '#default_value' => $settings['sp']['user'], ); - $form['sp_settings']['sp_pass'] = array( + $form['settings']['sp']['pass'] = array( '#type' => 'textfield', '#title' => t('Service Proxy password'), '#description' => t('Service Proxy password'), '#required' => FALSE, - '#default_value' => isset($node->mkdru->sp_pass) ? - $node->mkdru->sp_pass : '', + '#default_value' => $settings['sp']['pass'], ); - $form['display_settings'] = array( + $form['settings']['facets'] = array( '#type' => 'fieldset', - '#title' => t('Display settings'), + '#title' => t('Facet settings'), + // Set up the wrapper so that AJAX will be able to replace the fieldset. + '#prefix' => '
', + '#suffix' => '
', '#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, + 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['display_settings']['author_max'] = array( + $form['new_facet']['canonical'] = 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, + '#title' => t('Canonical name of new facet'), ); - $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, + $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) { +// Can't use the node type's title since +// merging AJAX forms is currently beyond me. +// $type = node_type_get_type($node); +// Title would be: check_plain($type->title_label); + if (isset($node->mkdru->settings)) { + // Second decode parameter indicates associative array + $form_state['build_info']['args']['settings'] = json_decode($node->mkdru->settings, TRUE); + } + return drupal_retrieve_form('mkdru_settings_form', $form_state); +} + +function mkdru_add_facet_form($form, &$form_state) { + $form_state['facet_names'][] = $form_state['values']['new_facet']['canonical']; + $form_state['rebuild'] = TRUE; +} + +function mkdru_add_facet_callback($form, $form_state) { + return $form['settings']['facets']; +} + /** * 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 +// if (!is_numeric($node->source_max)) { +// form_set_error('source_max', t('Please enter a number.')); +// } } /** * Implements hook_insert(). */ function mkdru_insert($node) { - drupal_write_record('mkdru', $node); + $fields = array('nid' => $node->nid, 'vid' => $node->vid, + 'settings' => json_encode($node->settings)); + db_insert('mkdru')->fields($fields)->execute(); } /** @@ -272,7 +352,10 @@ function mkdru_update($node) { mkdru_insert($node); } else { - drupal_write_record('mkdru', $node, 'vid'); + db_update('mkdru') + ->condition('vid', $node->vid) + ->fields(array('settings' => json_encode($node->settings))) + ->execute(); } } -- 1.7.10.4