islandora_xquery.module

<?php

/**
 * @file
 * Defines all the hooks this module implements.
 * @todo
 *   Handle "the i18n_string integration fun".
 */

define('ISLANDORA_XQUERY_ZORBA_REQUIRED_VERSION', '3.0.0');
define('ISLANDORA_XQUERY_ZORBA_DEFAULT_LOCATION', '/usr/bin/zorba');
define('ISLANDORA_XQUERY_BASEX_DEFAULT_LOCATION', '/usr/bin/basex');

define('ISLANDORA_XQUERY_STATUS_PENDING', 'PENDING');
define('ISLANDORA_XQUERY_STATUS_OBJECT_LOAD_FAIL', 'OBJECT LOAD FAIL');
define('ISLANDORA_XQUERY_STATUS_DATASTREAM_LOAD_FAIL', 'DATASTREAM LOAD FAIL');
define('ISLANDORA_XQUERY_STATUS_PATCH_FAIL', 'PATCH FAIL');
define('ISLANDORA_XQUERY_STATUS_DATSTREAM_UPDATE_FAIL', 'DATSTREAM UPDATE FAIL');
define('ISLANDORA_XQUERY_STATUS_APPLIED', 'APPLIED');

/**
 * Implements hook_menu().
 */
function islandora_xquery_menu() {
  $items = array();
  $items['admin/islandora/tools/xquery/manage'] = array(
    'title' => 'XQuery',
    'description' => 'Configure Islandora XQuery',
    'access arguments' => array('administer islandora_xquery'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('islandora_xquery_admin_form'),
    'file' => 'includes/admin.form.inc',
    'type' => MENU_NORMAL_ITEM,
  );
  $items['admin/islandora/tools/xquery/manage/template'] = array(
    'title' => 'Templates',
    'description' => 'Configure templates for Islandora XQuery',
    'access arguments' => array('administer islandora_xquery'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('islandora_xquery_admin_form'),
    'file' => 'includes/admin.form.inc',
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -1,
  );
  $items['admin/islandora/tools/xquery/manage/general'] = array(
    'title' => 'General',
    'description' => 'General configuration Islandora XQuery',
    'access arguments' => array('administer islandora_xquery'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('islandora_xquery_general_admin_form'),
    'file' => 'includes/general_admin.form.inc',
    'type' => MENU_LOCAL_TASK,
  );
  $items['admin/islandora/tools/xquery/manage/processor'] = array(
    'title' => 'Processors',
    'description' => 'Configure Islandora XQuery processor',
    'access arguments' => array('administer islandora_xquery'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('islandora_xquery_processor_admin_form'),
    'file' => 'includes/processor_admin.form.inc',
    'type' => MENU_LOCAL_TASK,
  );
  $items['admin/islandora/tools/xquery/manage/template/%'] = array(
    'title' => 'Manage Template',
    'description' => 'Manages a specific template for use in Islandora XQuery',
    'access callback' => 'islandora_xquery_access',
    'access arguments' => array(6),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('islandora_xquery_template_management_form', 6),
    'file' => 'includes/manage.inc',
  );
  $items['admin/islandora/tools/xquery/manage/template/%/delete'] = array(
    'title' => 'Delete Template',
    'description' => 'Deletes a specific template from Islandora XQuery',
    'access callback' => 'islandora_xquery_access',
    'access arguments' => array(6),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('islandora_xquery_template_delete_confirm_form', 6),
    'file' => 'includes/delete.inc',
  );
  $items['islandora/xquery/preview/%'] = array(
    'title' => 'Query Preview',
    'description' => "Provides a preview of xquery results before commiting them to Fedora.",
    'access callback' => 'user_access',
    'access arguments' => array('search and replace with xquery'),
    'page callback' => 'islandora_xquery_preview_results',
    'page arguments' => array(3),
    'file' => 'includes/preview.inc',
  );
  $items['islandora/xquery/preview/%/apply'] = array(
    'title' => 'Apply Query',
    'description' => "Applies results of an xquery and commits them to Fedora.",
    'access callback' => 'user_access',
    'access arguments' => array('search and replace with xquery'),
    'page callback' => 'islandora_xquery_apply_results',
    'page arguments' => array(3),
    'file' => 'includes/apply.inc',
  );
  $items['islandora/xquery/preview/%/cancel'] = array(
    'title' => 'Apply Query',
    'description' => "Cancels an xquery find/replace operation.",
    'access callback' => 'user_access',
    'access arguments' => array('search and replace with xquery'),
    'page callback' => 'islandora_xquery_cancel_results',
    'page arguments' => array(3),
    'file' => 'includes/cancel.inc',
  );
  return $items;
}

/**
 * Implements hook_theme().
 */
function islandora_xquery_theme($existing, $type, $theme, $path) {
  $items = array();
  $items['islandora_xquery_preview'] = array(
    'path' => $path . '/theme',
    'file' => 'theme.inc',
    'template' => 'islandora-xquery-preview',
    'variables' => array(
      'results' => NULL,
      'batch_id' => "",
      'apply_link' => "",
      'cancel_link' => "",
    ),
  );
  return $items;
}

/**
 * Implements hook_libraries_info().
 */
function islandora_xquery_libraries_info() {
  return array(
    'geshi' => array(
      'title' => 'GeSHi - Generic Syntax Highlighter for PHP',
      'vendor url' => 'http://sourceforge.net/projects/geshi',
      'download url' => 'http://sourceforge.net/projects/geshi/files/geshi',
      'version arguments' => array(
        'file' => 'geshi.php',
        'pattern' => "/define\('GESHI_VERSION', '(.*)'\);/",
        'lines' => 50,
      ),
      'files' => array(
        'php' => array(
          'geshi.php',
        ),
      ),
    ),
  );
}

/**
 * Implements hook_permission().
 */
function islandora_xquery_permission() {
  return array(
    'administer islandora_xquery' => array(
      'title' => 'Create and manage XQuery templates',
    ),
    'search and replace with xquery' => array(
      'title' => 'Search and replace with XQuery',
    ),
  );
}

/**
 * Access callback for accessing a association based upon ID.
 *
 * @param int $association_id
 *   The configuration ID of the list we are accessing.
 *
 * @return bool
 *   TRUE if the user has permission and the list exists, FALSE otherwise.
 */
function islandora_xquery_access($association_id) {
  module_load_include('inc', 'islandora_xquery', 'includes/db');
  return islandora_xquery_association_exists($association_id) && user_access('administer islandora_xquery');
}

/**
 * Implements hook_islandora_solr_primary_display().
 */
function islandora_xquery_islandora_solr_primary_display() {
  return array(
    'xquery' => array(
      'name' => t('XQuery'),
      'module' => 'islandora_xquery',
      'file' => 'includes/solr_results.inc',
      'class' => 'IslandoraSolrResultsXquery',
      'function' => 'displayResults',
      'description' => t('Search results for performing an XQuery find/replace operation.'),
    ),
  );
}

/**
 * Implements hook_form_alter().
 */
function islandora_xquery_form_islandora_solr_advanced_search_form_alter(&$form, &$form_state, $form_id) {
  // Filter out to just the enabled profile and see if XQuery is one of them.
  if (user_access('search and replace with xquery')) {
    $primary_display_array = variable_get('islandora_solr_primary_display_table', array());
    if (!empty($primary_display_array)) {
      $display = array_filter($primary_display_array['enabled']);
      if (isset($display['xquery'])) {
        $form['xquery'] = array(
          '#type' => 'checkbox',
          '#title' => t('XQuery search and replace?'),
        );
        $form['#submit'][] = 'islandora_xquery_solr_advanced_search_form_submit';
      }
    }
  }
}

/**
 * Implements hook_form_alter().
 */
function islandora_xquery_form_islandora_solr_simple_search_form_alter(&$form, &$form_state, $form_id) {
  // Filter out to just the enabled profile and see if XQuery is one of them.
  if (user_access('search and replace with xquery')) {
    $primary_display_array = variable_get('islandora_solr_primary_display_table', array());
    if (!empty($primary_display_array)) {
      $display = array_filter($primary_display_array['enabled']);
      if (isset($display['xquery'])) {
        $form['xquery'] = array(
          '#type' => 'checkbox',
          '#title' => t('XQuery search and replace?'),
        );
        $form['#submit'][] = 'islandora_xquery_solr_search_form_submit';
      }
    }
  }
}

/**
 * Altered Islandora Solr advanced search form submit callback.
 *
 * @param array $form
 *   An associative array containing form structure.
 * @param array $form_state
 *   An associative array containing form state.
 *
 * @see islandora_solr_advanced_search_form()
 */
function islandora_xquery_solr_advanced_search_form_submit($form, &$form_state) {
  if ($form_state['values']['xquery']) {
    $form_state['redirect'][1]['query']['display'] = 'xquery';
  }
}

/**
 * Islandora Solr simple search form submit callback.
 *
 * @param array $form
 *   An associative array containing form structure.
 * @param array $form_state
 *   An associative array containing form state.
 */
function islandora_xquery_solr_search_form_submit($form, &$form_state) {
  if ($form_state['values']['xquery']) {
    $form_state['redirect'][1]['query']['display'] = 'xquery';
  }
}