';
$navigation .= '
';
if ($prev) {
$navigation .= advanced_help_l('<< '. $topics[$prev[0]][$prev[1]]['title'], "help/$prev[0]/$prev[1]");
}
$navigation .= '
';
$navigation .= '
';
if ($next) {
$navigation .= advanced_help_l($topics[$next[0]][$next[1]]['title'] .' >>', "help/$next[0]/$next[1]");
}
$navigation .= '
';
$navigation .= '
'. $output .'
';
}
}
/**
* Get the information for a single help topic.
*/
function advanced_help_get_topic($module, $topic) {
$topics = advanced_help_get_topics();
if (!empty($topics[$module][$topic])) {
return $topics[$module][$topic];
}
}
/**
* Search the system for all available help topics.
*/
function advanced_help_get_topics() {
static $topics = NULL;
if (!isset($topics)) {
$topics = array();
$help_path = drupal_get_path('module', 'advanced_help') .'/modules';
foreach (module_list() as $module) {
$module_path = drupal_get_path('module', $module);
$info = array();
if (file_exists("$module_path/help/$module.help.ini")) {
$path = "$module_path/help";
$info = parse_ini_file("./$module_path/help/$module.help.ini", TRUE);
}
else if (file_exists("$help_path/$module/$module.help.ini")) {
$path = "$help_path/$module";
$info = parse_ini_file("./$help_path/$module/$module.help.ini", TRUE);
}
if (!empty($info)) {
// Get translated titles:
global $language;
if (file_exists("$module_path/translations/help/$language->language/$module.help.ini")) {
$translation = parse_ini_file("$module_path/translations/help/$language->language/$module.help.ini", TRUE);
}
$settings = array();
if (!empty($info['advanced help settings'])) {
$settings = $info['advanced help settings'];
unset($info['advanced help settings']);
}
foreach ($info as $name => $topic) {
// Each topic should have a name, a title, a file and of course the path.
$file = !empty($topic['file']) ? $topic['file'] : $name;
$topics[$module][$name] = array(
'name' => $name,
'title' => !empty($translation[$name]['title']) ? $translation[$name]['title'] : $topic['title'],
'weight' => isset($topic['weight']) ? $topic['weight'] : 0,
'parent' => isset($topic['parent']) ? $topic['parent'] : 0,
'file' => $file .'.html', // require extension
'path' => $path, // not in .ini file
'line break' => isset($topic['line break']) ? $topic['line break'] : (isset($settings['line break']) ? $settings['line break'] : FALSE),
'navigation' => isset($topic['navigation']) ? $topic['navigation'] : (isset($settings['navigation']) ? $settings['navigation'] : TRUE),
'css' => isset($topic['css']) ? $topic['css'] : (isset($settings['css']) ? $settings['css'] : NULL),
);
}
}
}
}
return $topics;
}
/**
* Implementation of hook_search()
*/
function advanced_help_search($op = 'search', $keys = null) {
switch ($op) {
case 'name':
return t('Help');
case 'reset':
variable_del('advanced_help_last_cron');
return;
case 'search':
$topics = advanced_help_get_topics();
$find = do_search($keys, 'help');
if (!$find) {
return;
}
$results = array();
$placeholders = implode(', ', array_fill(0, count($find), '%d'));
foreach ($find as $item) {
$sids[] = $item->sid;
}
$result = db_query("SELECT * FROM {advanced_help_index} WHERE sid IN ($placeholders)", $sids);
while ($sid = db_fetch_object($result)) {
// Guard against removed help topics that are still indexed.
if (empty($topics[$sid->module][$sid->topic])) {
continue;
}
$info = $topics[$sid->module][$sid->topic];
$text = advanced_help_view_topic($sid->module, $sid->topic);
$results[] = array('link' => advanced_help_url("help/$sid->module/$sid->topic"),
'title' => $info['title'],
'snippet' => search_excerpt($keys, $text));
}
return $results;
}
}
/**
* Get or create an sid (search id) that correllates to each topic for
* the search system.
*/
function advanced_help_get_sids(&$topics) {
global $language;
$result = db_query("SELECT * FROM {advanced_help_index} WHERE language = '%s'", $language->language);
while ($sid = db_fetch_object($result)) {
if (empty($topics[$sid->module][$sid->topic])) {
db_query("DELETE FROM {advanced_help_index} WHERE sid = %d", $sid->sid);
}
else {
$topics[$sid->module][$sid->topic]['sid'] = $sid->sid;
}
}
}
/**
* Implementation of hook_update_index().
*/
function advanced_help_update_index() {
global $language;
// If we got interrupted by limit, this will contain the last module
// and topic we looked at.
$last = variable_get('advanced_help_last_cron', array('time' => 0));
$limit = intval(variable_get('search_cron_limit', 100));
$topics = advanced_help_get_topics();
advanced_help_get_sids($topics);
$count = 0;
foreach ($topics as $module => $module_topics) {
// Fast forward if necessary.
if (!empty($last['module']) && $last['module'] != $module) {
continue;
}
foreach ($module_topics as $topic => $info) {
// Fast forward if necessary.
if (!empty($last['topic']) && $last['topic'] != $topic) {
continue;
}
// If we've been looking to catch up, and we have, reset so we
// stop fast forwarding.
if (!empty($last['module'])) {
unset($last['topic']);
unset($last['module']);
}
$file = advanced_help_get_topic_filename($module, $topic);
if ($file && (empty($info['sid']) || filemtime($file) > $last['time'])) {
if (empty($info['sid'])) {
$info['sid'] = db_next_id('{advanced_help_index}_sid');
db_query("INSERT INTO {advanced_help_index} (sid, module, topic, language) VALUES (%d, '%s', '%s', '%s')", $info['sid'], $module, $topic, $language->language);
}
search_index($info['sid'], 'help', '