ting.module

<?php
/**
 * @file
 * Module to integrate the Ting search engine with a Drupal site.
 */

/**
 * Implementation of hook_menu().
 */
function ting_menu() {
  $path = drupal_get_path('module', 'ting') . '/includes';
  $items = array();

  $items['ting/object/redirect'] = array(
    'title' => 'Redirect to object based on local ID (links from bibliotek.dk).',
    'page callback' => 'ting_search_pages_object_redirect',
    'access arguments' => array('search content'),
    'type' => MENU_CALLBACK,
    'file' => 'ting.pages.inc',
    'file path' => $path,
  );

  $items['admin/settings/ting'] = array(
    'title' => 'Ting search',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('ting_admin_settings_form'),
    'access arguments' => array('administer site configuration'),
    'file' => 'ting.admin.inc',
    'file path' => $path,
  );

  $items['admin/settings/ting/access'] = array(
    'title' => 'Ting access',
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );

  $items['admin/settings/ting/ranking'] = array(
    'title' => 'Ranking',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('ting_admin_ranking_form'),
    'access arguments' => array('administer site configuration'),
    'file' => 'ting.admin.inc',
    'file path' => $path,
    'type' => MENU_LOCAL_TASK,
  );

  $items['ting/ranking_field/ahah'] = array(
    'title' => 'Ting ranking field AHAH callback',
    'title callback' => FALSE,
    'page callback' => 'ting_admin_ranking_add_field_ahah',
    'access arguments' => array('administer site configuration'),
    'file' => 'ting.admin.inc',
    'file path' => $path,
    'type' => MENU_CALLBACK,
  );

  return $items;
}

/**
 * Implementation of hook_elements().
 *
 * Define a new form element named ting_ranking_field.
 *
 * It calls the theme function theme_ting_ranking_field, if not defined
 * no elements will be displayed.
 */
function ting_elements() {
  return array(
    'ting_ranking_field' => array(
      '#input' => TRUE,
      '#process' => array('ting_ranking_field_element_process'),
    ),
  );
}

/**
 * Implementation of hook_theme().
 */
function ting_theme() {
  return array(
    'ting_thing' => array(
      'arguments' => array('type' => 'object', 'object' => NULL, 'query_args' => NULL),
    ),
    'ting_list' => array(
      'arguments' => array('ting_list' => NULL, 'sorted' => FALSE),
      'template' => 'ting-list',
    ),
    'ting_list_item' => array(
      'arguments' => array('object' => NULL),
      'template' => 'ting-list-item',
    ),
    'ting_tabs' => array(
      'arguments' => array('tabs' => NULL, 'wrapper_id' => NULL),
      'template' => 'ting-tabs',
    ),
    'ting_collection' => array(
      'arguments' => array('collection' => NULL, 'query_args' => NULL),
      'template' => 'ting_collection',
    ),
    'ting_object' => array(
      'arguments' => array('object' => NULL),
      'template' => 'ting_object',
    ),
    'ting_object_title' => array(
      'arguments' => array('object' => NULL, 'display_image' => NULL),
      'template' => 'ting-object-title',
    ),
    'ting_ranking_field' => array(
      'arguments' => array('element' => NULL),
    ),
  );
}

/**
 * Implementation of hook_ctools_plugin_api().
 */
function ting_ctools_plugin_api($module, $api) {
  if ($module == 'page_manager' && $api == 'pages_default') {
    return array('version' => 1);
  }
}

/**
 * Implementation of hook_ctools_plugin_directory().
 *
 * Tells CTools (and thus Panels) where to look for plugin code.
 */
function ting_ctools_plugin_directory($module, $plugin) {
  if ($module == 'ctools' || $module == 'panels') {
    return 'plugins/' . $plugin;
  }
}

/**
 * Implementation of hook_imagecache_default_presets()
 */
function ting_imagecache_default_presets() {
  $presets = array();

  $presets['180_x'] = array (
    'presetname' => '180_x',
    'actions' =>
    array (
      0 =>
      array (
        'weight' => '0',
        'module' => 'imagecache',
        'action' => 'imagecache_scale',
        'data' =>
        array (
          'width' => '180',
          'height' => '',
          'upscale' => 0,
        ),
      ),
    ),
  );

  $presets['80_x'] = array (
    'presetname' => '80_x',
    'actions' =>
    array (
      0 =>
      array (
        'weight' => '0',
        'module' => 'imagecache',
        'action' => 'imagecache_scale',
        'data' =>
        array (
          'width' => '80',
          'height' => '',
          'upscale' => 1,
        ),
      ),
    )
  );

  return $presets;
}

/**
 * Implementation of hook_ting_add_js().
 */
function ting_ting_add_js($type) {
  // Add button helper on collection and object views if the required jQuery UI modules are loaded
  // These are not requirements to avoid unecessary dependencies in ting module
  if (in_array($type, array('ting_collection_view', 'ting_object_view'))) {
    if (module_exists('jquery_ui') && module_exists('jquery_ui_theme')) {
      jquery_ui_add('ui.dialog');
      jquery_ui_theme_load();
      drupal_add_js(drupal_get_path('module', 'ting') . '/js/ting.buttons.js');
    }
  }
}

/**
 * Implementation of hook_ting_object_buttons().
 */
function ting_ting_object_buttons($object) {
  if (!empty($object->localId)) {
    if (!empty($object->online_url) &&
      ting_object_is($object, 'online')) {
      if (in_array(drupal_strtolower($object->type), array('lydbog (online)', 'netmusik (album)'))) {
        $text = t('Hear online');
      }
      else {
        $text = t('See online');
      }
      return array(
        array(
          'data' => l($text, $object->online_url),
          'class' => 'view-online',
        )
      );
    }
  }
}

/**
 * Implementation of hook_trampoline_variables().
 */
function ting_trampoline_variables() {
  return array(
    'ting_agency',
    'ting_search_url',
    'ting_scan_url',
    'ting_spell_url',
    'ting_recommendation_server',
  );
}

/**
 * Menu loader function.
 */
function ting_id_load($id) {
  module_load_include('client.inc', 'ting');
  return ting_get_object_by_id($id);
}

/**
 * Menu loader function.
 */
function ting_local_id_load($id) {
  module_load_include('client.inc', 'ting');
  return ting_get_object_by_local_id($id);
}

/**
 * Add additional information to a ting object.
 */
function ting_enrich_object(&$object) {
  $object = array_shift(ting_add_additional_info(array($object)));
}

/**
 * Theme something from Ting.
 */
function theme_ting_thing($type, $object, $query_args = NULL) {
  static $displayed_relation_types = array(
    'isAuthorDescriptionOf',
    'hasAuthorDescription',
    'hasReview',
    'isReviewOf',
    'hasAnalysis',
    'isAnalysisOf',
    'isSubjectDescriptionOf',
    'hasSubjectDescription',
    'hasFulltext',
  );
  module_invoke_all('ting_add_js', "ting_${type}_view");

  $tabs = array();
  $tabs['main'] = array(
    'title' => t('Materials'),
    'content' => theme("ting_$type", $object, $query_args),
  );

  if (sizeof($object->relations)) {
    $relations = array();
    foreach ($object->relations as $relation) {
      // Remove relations that's not from the local agency.
      if ($relation->ownerId != $object->ownerId) {
        continue;
      }

      if (in_array($relation->relationType, $displayed_relation_types)) {
        $relations[] = $relation;
      }
    }
    if ($relations) {
      $tabs['related'] = array(
        'title' => t('Related'),
        'content' => theme('ting_list', $object->relations),
      );
    }
  }

  drupal_alter('ting_tabs', $tabs, $type, $object);

  return theme('ting_tabs', $tabs, $type == 'collection' ? 'ting-collection' : 'ting-object');
}

/**
 * Template preprocessor for ting-list.
 */
function template_preprocess_ting_list(&$vars) {
  if (!$vars['sorted']) {
    $sorted = array();
    foreach ($vars['ting_list'] as $object) {
      $sorted[$object->type][] = $object;
    }
    ksort($sorted);
    $vars['ting_list'] = $sorted;
  }
  foreach ($vars['ting_list'] as $type => $object_list) {
    $vars['ting_list'][$type] = "";
    foreach ($object_list as $object) {
      $vars['ting_list'][$type] .= theme('ting_list_item', $object);
    }
  }
}

/**
 * Template preprocessor for ting-list-item.
 */
function template_preprocess_ting_list_item(&$vars) {
  $object = $vars['object'];
  $vars['local_id'] = check_plain($object->localId);

  $image_url = ting_covers_object_url($object, '80_x');
  if ($image_url) {
    $vars['image'] = theme('image', $image_url, '', '', null, false);
  }

  $vars['date'] = check_plain($object->record['dc:date'][''][0]);
  $vars['title'] = l($object->title, $object->url, array('attributes' => array('class' => 'alternative')));
  $creators = $object->creators;
  $first_creator = array_shift($creators);
  $vars['creator'] = l($first_creator, 'ting/search/'. $first_creator, array('attributes' => array('class' => 'author alternative')));
  $vars['additional_creators'] = array_filter($creators);
  $vars['language'] = check_plain($object->language);

  $vars['more_link'] = l(t('More information'), $object->url, array('attributes' => array('class' => 'more-link')));
  $vars['type'] = check_plain($object->type);

  // Let other modules add buttons.
  $vars['buttons'] = module_invoke_all('ting_object_buttons', $object);
}

/**
 * Template preprocessor for ting tabs.
 */
function template_preprocess_ting_tabs(&$vars) {
  // jQuery UI tabs
  jquery_ui_add('ui.tabs');
  jquery_ui_theme_load();

  drupal_add_js(drupal_get_path('module', 'ting') . '/js/ting.js', 'module');

  $tab_labels = array();
  $tab_content = array();
  foreach ($vars['tabs'] as $id => $tab) {
    $id = form_clean_id($id);
    // Cannot use l/url, they can't generate a link with only a fragment. Also
    // we don't want any 'active' classes.
    $tab_labels[] = array(
      'data' => "<a href='#$id'>" . check_plain($tab['title']) . "</a>",
    );
    $tab_content[$id] = $tab['content'];
  }

  $vars['tabs_labels'] = theme('item_list', $tab_labels);
  $vars['tabs_content'] = $tab_content;
}

/**
 * Template preprocessor for collections of ting objects.
 */
function template_preprocess_ting_collection(&$variables) {
  // Preprocess the collection object here!

  $collection = $variables["collection"];

  // Allow modules to add action buttons to collection objects
  $variables['buttons'] = array();
  foreach ($collection->objects as $object) {
    $variables['buttons'][$object->id] = module_invoke_all('ting_object_buttons', $object);
  }

  $sorted = array();
  $object_list = array();

  // If we know what query lead to the collection then we can use this for sorting
  if ($query_args = $variables['query_args']) {
    if ($entry = $query_args['entry']) {
      // Build the query for the collection in the search result
      $query = '';

      //Wrap base query
      $query .= (isset($query_args['query'])) ? '('.$query_args['query'].')' : '';

      //Extend query with selected facets
      if (isset($query_args['facets'])) {
        foreach ($query_args['facets'] as $name => $value) {
          $facetArray[] = $name.'="'.$value.'"';
        }
        $query .= ' AND '.implode(' AND ', $facetArray);
      }

      // Get the corresponding entry in the search result
      $result = ting_do_search($query, $entry, 1, array('facets' => array()));

      //Determine the order of object types based on the order of objects
      //in the search result
      if ($search_collection = array_shift($result->collections)) {
        foreach ($search_collection->objects as $object) {
          $sorted[$object->type] = array();
        }
      }

      //Put all objects from original collection into the ordered object type buckets.
      //Types not referenced in the search result placed last
      foreach ($collection->objects as $object) {
        $sorted[$object->type][] = $object;
      }
    }
  }

  //Default to standard sorting
  if (sizeof($sorted) == 0) {
    foreach ($collection->objects as $object) {
      $sorted[$object->type][] = $object;
    }
    // By coincidence, the default type, "Bog", appears alphabetically first.
    ksort($sorted);
  }

  $variables["sorted_collection"] = $sorted;
  $variables['ting_list'] = theme('ting_list', $sorted, TRUE);
}

/**
 * Template preprocessor for ting objects.
 */
function template_preprocess_ting_object(&$variables) {
  $object = $variables['object'];
  // Allow modules to add action buttons to objects
  $variables['buttons'] = module_invoke_all('ting_object_buttons', $object);

  $image_url = ting_covers_object_url($object, '180_x');
  if ($image_url) {
    $variables['image'] = theme('image', $image_url, '', '', NULL, FALSE);
  }

  $variables['title'] = check_plain($object->record['dc:title'][''][0]);

  $titles = $object->record['dc:title'];
  unset($titles['']);
  $titles = array_values(array_map('array_shift', $titles));

  $variables['other_titles'] = check_plain(implode(', ', $titles));
  $variables['alternative_titles'] = array();
  if ($object->record['dcterms:alternative']['']) {
    $titles = array_values($object->record['dcterms:alternative']['']);
    $variables['alternative_titles'] = array_map('check_plain', $titles);
  }

  $creators = array();
  foreach ($object->creators as $i => $creator) {
    $creators[] = l($creator, 'ting/search/' . $creator, array('attributes' => array('class' => 'author')));
  }
  $variables['creators'] = implode(', ', $creators);

  if (!empty($object->date)) {
    $variables['date'] = check_plain($object->date);
  }

  $variables['abstract'] = check_plain($object->record['dcterms:abstract'][''][0]);
}

/**
 * Parse a string containing search query arguments into an array
 * @return array Array of search query arguments
 */
function _ting_search_parse_query_args($query_string) {
  $query_args = array();

  $query_elements = explode(';', $query_string);
  foreach ($query_elements as &$e) {
    $e = explode(':', $e, 2);
    if (strpos($e[1], ':') !== FALSE) {
      $query_args[$e[0]] = array();
      $e_args = explode(':', $e[1], 2);
      $query_args[$e[0]][$e_args[0]] = $e_args[1];
    } else {
      $query_args[$e[0]] = $e[1];
    }
  }

  return $query_args;
}

/**
 * Return whether an object is of a given pseudo-class.
 *
 * Modules can add their own pseudo-classes by implementing
 * hook_ting_object_is(). This function will call all implementations and
 * return the overall result.
 *
 * Modules may return TRUE, FALSE or NULL from the hook. If any modules
 * returned FALSE, the result is FALSE, else the result is TRUE if anyone
 * returned TRUE, FALSE otherwise.
 */
function ting_object_is($object, $class) {
  $result = module_invoke_all('ting_object_is', $object, $class);
  // Return true if anyone returned true, and nobody returned false.
  if (!in_array(FALSE, $result) && in_array(TRUE, $result)) {
    return TRUE;
  }
  return FALSE;
}

/**
 * Implementation of hook_ting_object_is().
 */
function ting_ting_object_is($object, $class) {
  // Known online types.
  if ($class == 'online' and in_array(drupal_strtolower($object->type), array('lydbog (online)', 'netmusik (album)', 'netdokument'))) {
    return TRUE;
  }
}

/**
 * Processor for the ting_ranking_field form element.
 */
function ting_ranking_field_element_process($element, $form_state) {
  $element['#tree'] = TRUE;
  
  $element['field_type'] = array(
    '#title' => t('Type'),
    '#type' => 'select',
    '#options' => array(
      'phrase' => t('Phrase'),
      'word' => t('Word'),
    ),
    '#default_value' => $element['#value']['field_type'],
  );

  $element['field_name'] = array(
    '#title' => t('Field name'),
    '#type' => 'select',
    '#options' => array(
      '' => '- ' . t('Choose') . ' -',
      'dc.source' => t('Source'),
      'dc.title' => t('Title'),
      'dc.creator' => t('Author'),
      'dc.subject' => t('Subject'),
      'dc.date' => t('Year of publish'),
      'dc.type' => t('Material type'),
    ),
    '#default_value' => $element['#value']['field_name'],
    '#attributes' => array('class' => 'field-name'),
  );

  $element['weight'] = array(
    '#title' => t('Weight'),
    '#type' => 'select',
    '#options' => drupal_map_assoc(range(1, 10)),
    '#default_value' => $element['#value']['weight'],
  );

  return $element;
}

/**
 * Theme function to format the custom form element ting_ranking_field.
 */
function theme_ting_ranking_field($element) {
  return theme('form_element', $element, '<div class="ranking-field-instance clear-block">'. $element['#children'] .'</div>');
}