Index: api.module =================================================================== RCS file: /cvs/drupal-contrib/contributions/modules/api/api.module,v retrieving revision 1.88.2.4 diff -u -p -r1.88.2.4 api.module --- api.module 29 Jan 2009 06:00:05 -0000 1.88.2.4 +++ api.module 7 Jun 2009 14:49:48 -0000 @@ -179,12 +179,28 @@ function api_menu() { 'access arguments' => $access_arguments, 'type' => MENU_CALLBACK, ); - $items['api/autocomplete'] = array( + $items['api/autocomplete/%/%'] = array( 'page callback' => 'api_autocomplete', + 'page arguments' => array(2, 3), 'access callback' => $access_callback, 'access arguments' => $access_arguments, 'type' => MENU_CALLBACK, ); + $items['api/opensearch/%'] = array( + 'page callback' => 'api_opensearch', + 'page arguments' => array(2), + 'access callback' => $access_callback, + 'access arguments' => $access_arguments, + 'type' => MENU_CALLBACK, + ); + $items['api/suggest/%/%'] = array( + 'page callback' => 'api_suggest', + 'page arguments' => array(2, 3), + 'access callback' => $access_callback, + 'access arguments' => $access_arguments, + 'type' => MENU_CALLBACK, + ); + $items['admin/settings/api'] = array( 'title' => 'API reference', 'description' => 'Configure branches for documentation.', @@ -574,6 +590,13 @@ function api_theme() { function api_init() { drupal_add_css(drupal_get_path('module', 'api') .'/api.css'); drupal_add_js(drupal_get_path('module', 'api') .'/api.js'); + + // Add OpenSearch autodiscovery links. + foreach (array_keys(api_get_branches()) as $branch_name) { + $title = t('Drupal API @branch', array('@branch' => $branch_name)); + $url = url('api/opensearch/'. $branch_name, array('absolute' => TRUE)); + drupal_set_html_head(''); + } } function api_block($op, $delta = NULL, $edit = array()) { @@ -794,7 +817,7 @@ function api_search_listing($branch_name */ function api_autocomplete($branch_name, $search = '') { $matches = array(); - $result = db_query_range("SELECT title FROM {api_documentation} WHERE title LIKE '%%%s%%' AND branch_name = '%s' ORDER BY LENGTH(title)", $search, $branch_name, 0, 20); + $result = _api_fuzzy_search($branch_name, $search, 20); while ($r = db_fetch_object($result)) { $matches[$r->title] = check_plain($r->title); } @@ -802,6 +825,63 @@ function api_autocomplete($branch_name, } /** + * Create an OpenSearch plugin for a branch. + * + * @see https://developer.mozilla.org/en/Creating_OpenSearch_plugins_for_Firefox + */ +function api_opensearch($branch_name) { + $valid = api_get_branches(); + if (!isset($valid[$branch_name])) { + return drupal_not_found(); + } + + drupal_set_header('Content-Type: text/xml; charset=utf-8'); + + $short_name = t('Drupal API @branch', array('@branch' => $branch_name)); + $description = t('Drupal @branch API documentation', array('@branch' => $branch_name)); + $image = url('misc/favicon.ico', array('absolute' => TRUE)); + $search_url = url('api/search/'. $branch_name, array('absolute' => TRUE)) .'/{searchTerms}'; + $suggest_url = url('api/suggest/'. $branch_name, array('absolute' => TRUE)) .'/{searchTerms}'; + $search_form_url = url('api', array('absolute' => TRUE)); + $self_url = url($_GET['q'], array('absolute' => TRUE)); + + print << +$short_name +$description +UTF-8 +$image + + + +$search_form_url + +EOD; +} + +/** + * Prepare a listing of potential documentation matches for a branch for + * OpenSearch. + * + * @see http://www.opensearch.org/Specifications/OpenSearch/Extensions/Suggestions/1.0 + */ +function api_suggest($branch_name, $search = '') { + $matches = array(); + $result = _api_fuzzy_search($branch_name, $search, 10); + while ($r = db_fetch_object($result)) { + $matches[] = $r->title; + } + print drupal_json(array($search, $matches)); +} + +function _api_fuzzy_search($branch_name, $search, $limit) { + // Escape underscore to produce more accurate results. + $search = str_replace('_', '\_', $search); + return db_query_range("SELECT title FROM {api_documentation} WHERE title LIKE '%%%s%%' AND branch_name = '%s' ORDER BY LENGTH(title)", $search, $branch_name, 0, $limit); +} + +/** * Menu callback; displays the main documentation page. */ function api_page_branch($branch_name) {