modules/semantic_search/semantic_search.module

<?php
/*
 * Copyright (C) May 2006 Jonathan Hendler
 * 
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 * 
 * The authors can be contacted at: 
 *  - jonathan [at] civicactions (dot) com
 * 
 * @license http://www.affero.org/oagpl.html
 * @link    http://drupal.org/project/semantic_search
 */

/*
 * notes for mirgration 
 * http://drupal.org/node/64279
 * http://drupal.org/node/64279#drupal-get-form   most major
 * http://drupal.org/node/64279#form-building
 * themes
 * http://drupal.org/node/64292
 * 
 * cool 
 * http://drupal.org/node/64279#hook-forms
 * http://www.nicklewis.org/node/905 category
 * http://drupal.org/node/69981
 * http://www.lullabot.com/articles/an_introduction_to_the_content_construction_kit
 * 
 * 
 * */
/**
 * include files
 * */
require 'semantic_search.includes.inc';

//now check that configs are properly set
$fs_temp_val = variable_get('ARC_DB_NAME',null);
if (empty($fs_temp_val) && user_access("administer semantic_search") ){
  drupal_set_message(t('Please <a href="'.url(SEMANTIC_SEARCH_ADMIN_HOME.'/config',null,null,true).'">configure SemanticSearch</a>'),'error');
}

/**
 * The SEMANTIC_SEARCH module provides a facted search tool for many types of 
 * faceted data which exist in some RDF form. 
 * 
 * Be sure to have these blocks display only on the SEMANTIC_SEARCH page.
 * Usually the search form and "your search" are in a left column, and the
 * search results show in the content area. 
 * 
 * 
 * INSTALLATION:
 * You must configure as well as SEMANTIC_SEARCH with semantic_search.conf.inc[.sample]
 * Also, you must configure SONIA with sonia.conf.inc[.sample]
 * 
 * The RDF must contain Object and their properties, and Classes (Categories)
 * and their subclasses. After the import, the UI needs some tweaking in the search...
 * 
 * @author Jonathan Hendler <jonathan@civicactions.com>
 * @author Dan Robinson <dan@civicactions.com>
 * 
 * @todo fquery
 * @todo panels for dynamic forms
 * 
 * @package SEMANTIC_SEARCH
 * @see SONIA
 * @see ARC
 * @see http://www.fsearch.org/trac/wiki/InstallingSEMANTIC_SEARCH
 * 
 * */

/**
 * catch this settings form and do synchronization  
 * */
//function semantic_search_settings_form_submit($form_id, $form_values) {
//  system_settings_form_submit($form_id, $form_values);
//  if (isset ($form_values['CCK_SYNC']) && ($form_values['CCK_SYNC'] == 1)) {
//    drupal_set_message('SEMANTIC_SEARCH: synchronizing with CCK');
//    _semantic_search_node_sync($form_values);
//  }
//  return 'admin/settings/semantic_search';
//}

//function semantic_search_settings_form_confirm(){
//$form['nid'] = array('#type' => 'value', '#value' => $node->nid);
//
// return confirm_form($form,
//   t('Are you sure you want to delete %title?', array('%title' => $node->title)),
//   $_GET['destination'] ? $_GET['destination'] : 'node/'. $node->nid,
//   t('This action cannot be undone.'),
//   t('Delete'), t('Cancel')); 
//}

/**
 *                                                                  
 * */
function _semantic_search_build_cache_link() {

}

/**
* settings hook 
* */
//function semantic_search_settings_form() {
//  if (!user_access("administer semantic_search")) {
//    return message_admin_access();
//  }
//  _semantic_search_load_js_and_css();
//  _semantic_search_node_index_check();
//  
//  $path = drupal_get_path('module', 'semantic_search');
//  $js_path = $path . '/js';
//  drupal_add_js($js_path . '/semantic_search.admin.js');
//
//  global $_semantic_search_search;
//  if (empty ($_semantic_search_search))
//    _SEMANTIC_SEARCH_INIT();
//
//  $form['semantic_search_settings'] = array (
//    '#type' => 'fieldset',
//    '#title' => 'Nina Settings'
//  );
//
//  //  $the_type = 'SEMANTIC_SEARCH Javascript Enabled';
//  //  if (module_exist('semantic_search_rpc')) {
//  //    $form['semantic_search_settings'][$the_type] = array (
//  //      '#type' => 'checkbox',
//  //      '#title' => t('Enable AJAX on forms'
//  //    ), '#description' => t('Nina search forms will use Javascript Remoting. You can also turn this off' .
//  //    ' by disabling the semantic_search_rpc.module.'), '#return_value' => 1, '#default_value' => variable_get($the_type, '1'),);
//  //  } else {
//  //    $form['semantic_search_settings'][$the_type] = array (
//  //      '#value' => "You may want to <a href=\"" .
//  //      url('admin/modules'
//  //    ) . "\" title=\"\">enable the SEMANTIC_SEARCH rpc module for ajax</a>",);
//  //  }
//
//  //  $the_type = 'Display preview data';
//  //
//  //  $form['semantic_search_settings'][$the_type] = array (
//  //    '#type' => 'checkbox',
//  //    '#title' => t('Display preview data of parameters in search results.'
//  //  ), '#description' => t('On rollover of parameters, should a preview of all available data be displayed?'), '#return_value' => 1, '#default_value' => variable_get($the_type, '0'),);
//  //  
//
//  //CACHE BUILDER
//  $cttitle = t('Clicking here will build up the index/cache.');
//  $cttitle2 = t('Clicking here will erase all items in the cached index. ');
//  $cttitle3 = t('Clicking here simply stop the cache from running. You can continue later.');
//  $ctext = t('Build Search Index.');
//  $ctext2 = t('Clear Search Index.');
//  $ctext3 = t('Stop Building Index.');
//  $description = t('The above buttons provide management for the indexing of ' .
//  'searches. Indexing will speed up the most common searches and remove load' .
//  ' from the database. The size of the index is produced using a simple formula ' .
//  'based on the search form\'s choices.');
//
//  $cache_builder = '<div id="cacheManager"><button id="cacheBuilder" title="' . $cttitle . '">';
//  $cache_builder .= $ctext;
//  $cache_builder .= '</button>';
//  $cache_builder .= '<button id="cacheClearer" title="' . $cttitle2 . '">';
//  $cache_builder .= $ctext2;
//  $cache_builder .= '</button>';
//  $cache_builder .= ' <button id="cacheStop" disabled="disabled" title="' . $cttitle3 . '">';
//  $cache_builder .= $ctext3;
//  $cache_builder .= '</button>';
//  $cache_builder .= '</div>';
//  $cache_builder .= '<div id="cacheBuilderStatus"></div>';
//  $cache_builder .= '<div class="description">' . $description . '</div><br /><br />';
//  $form['semantic_search_settings']['cache_builder'] = array (
//    '#value' => $cache_builder,
//    
//  );
//
//  //  $the_type = 'Search Form Unset';
//  //
//  //  $form['semantic_search_settings'][$the_type] = array (
//  //    '#type' => 'checkbox',
//  //    '#title' => t('Search Form Unset'
//  //  ), '#description' => t('When this is turned off, you must use the "my search"/breadcrumb block to ' .
//  //  'remove search items. When it is selected, the search form rebuilds the search every time submit is sent.'), '#return_value' => 1, '#default_value' => variable_get($the_type, '1'),);
//
//  $the_type = 'semantic_search_search_title';
//  $form['semantic_search_settings'][$the_type] = array (
//    '#type' => 'textfield',
//    '#title' => t('Search Title'
//  ), '#description' => t('What will the title of the search results be?'),
//    //'#return_value' => 1, 
//  '#default_value' => variable_get($the_type, 'SEMANTIC_SEARCH Search'),);
//
//  $the_type = 'semantic_search_search_form_title';
//  $form['semantic_search_settings'][$the_type] = array (
//    '#type' => 'textfield',
//    '#title' => t('Search Form Title'
//  ), '#description' => t('What will the title of the search form be?'),
//    //'#return_value' => 1, 
//  '#default_value' => variable_get($the_type, 'SEMANTIC_SEARCH Search'),);
//
//  $the_type = 'semantic_search_help_title';
//  $form['semantic_search_settings'][$the_type] = array (
//    '#type' => 'textfield',
//    '#title' => t('Help Text Title'
//  ), '#description' => t('This text is the title for retrieving help from the tooltip.'),
//    //'#return_value' => 1, 
//  '#default_value' => variable_get($the_type, '[help]'),);
//
//  $the_type = 'semantic_search_help_text';
//  $form['semantic_search_settings'][$the_type] = array (
//    '#type' => 'textarea',
//    '#title' => t('Help Text'
//  ), '#description' => t('This text displays in a tooltip near "your search terms" area. '),
//    //'#return_value' => 1, 
//  '#default_value' => variable_get($the_type, t('You can add new terms to narrow the search' .
//  ' by going to the search form or you can ' .
//  'remove search terms to expand the search.')),);
//  
//  
//  
//  $form['semantic_search_settings']['CCK_SYNC'] = array (
//    '#type' => 'checkbox',
//    '#title' => t('<strong>CCK SYNC</strong>'
//  ), '#description' => t('When you select a CCK type below - all CCK data and related taxonomy terms will' .
//  'will be imported and indexed in SEMANTIC_SEARCH.  This could take a VERY long time. You DO NOT need to sync if you change the order of field display under "field options".'), '#return_value' => 1, '#default_value' => 0,);
//  
//  $form['semantic_search_settings']['CCK_RESET'] = array (
//    '#type' => 'checkbox',
//    '#title' => t('<strong>RESET DATA</strong>'
//  ), '#description' => t('Also, clear ALL the data in SEMANTIC_SEARCH - only use this when starting over!!!'), '#return_value' => 1, '#default_value' => 0,
//    '#attributes'=>array('disabled'=>'disabled'));
//  
//  
//  $index_size = _semantic_search_node_index_count();
//  $total_node_count = _semantic_search_node_total_count();
//  $the_type = 'SEMANTIC_SEARCH_IMPORT_BATCH_SIZE';
//  $form['semantic_search_settings'][$the_type] = array (
//    '#type' => 'textfield',
//    '#title' => t('Batch Size'
//  ), '#description' => t('There are currently %size of %total total nodes imported into SEMANTIC_SEARCH.<br>It takes a long time to build RDF. This lets you build in batches.',
//     array('%size'=>$index_size,'%total'=>$total_node_count)),
//    //'#return_value' => 1, 
//  '#default_value' => variable_get($the_type, 1000),
//   '#attributes'=>array('disabled'=>'disabled'));
//
//  $type_options = _content_type_info();
//  //dbg($type_options,'$type_options');
//
//  $form['semantic_search_settings']['div_begin_a']['#value'] = '<div id="cck-options">';
//
//  $form['semantic_search_settings']['CCK Sync'] = array (
//    '#type' => 'fieldset',
//    '#title' => 'CCK Type Syncronization options ',
//
//    
//  );
//
//  foreach ($type_options['content types'] as $id => $data) {
//    $pref_name = 'display_' . $id;
//    $label = $data['name']; 
//    $description = $data['description'];
//    $fields = $data['fields'];
//
//    $form['semantic_search_settings']['CCK Sync'][$pref_name] = array (
//      '#type' => 'checkbox',
//      '#title' => t('Store CCK type <strong>' . $label . '</strong> in SEMANTIC_SEARCH.'
//    ), '#description' => t('Should CCK type <em>' . $label . ' (' . $description . ')</em> be stored in SEMANTIC_SEARCH to be available for RDF search and export"?'), '#return_value' => 1, '#default_value' => variable_get($pref_name, '0'),);
//
//    if (!empty ($fields)) {
//
//      $form['semantic_search_settings']['CCK Sync'][$pref_name . '_f'] = array (
//        '#type' => 'fieldset',
//        '#title' => '<em>"' . $label . '"</em> Field Options ',
//        '#collapsible' => 1,
//        '#collapsed' => 1
//      );
//
//      foreach ($fields as $fid => $field_data) {
//        $pref_name2 = 'display_result_' . $fid;
//
//        $field_label = $field_data['widget']['label'];
//        $field_id = $fid;
//
//        $form['semantic_search_settings']['CCK Sync'][$pref_name . '_f'][$pref_name2] = array (
//          '#type' => 'select',
//          '#title' => t('Display field <em>"' . $field_label . '"</em> in SEMANTIC_SEARCH search results.'
//        ), '#description' => t('Should CCK field <em>' . $field_label . ' </em> display in the search results?' .
//        '<br /> Note: 0 means do not display.'), '#options' => array (
//          -5,
//          -4,
//          -3,
//          -2,
//          -1,
//          0,
//          1,
//          2,
//          3,
//          4,
//          5
//        ), '#default_value' => variable_get($pref_name2, '4'),);
//
//        //file settings
//        $furi = SONIA_PROPERTY_ID_URI . $fid;
//        $is_file_type = $_semantic_search_search->sonia->isFileType($furi);
//        if ($is_file_type) {
//          $file_pref_name = 'display_image_' . $fid;
//          $form['semantic_search_settings']['CCK Sync'][$pref_name . '_f'][$file_pref_name] = array (
//            '#type' => 'checkbox',
//            '#title' => t('Display field <em>"' . $field_label . '"</em> in SEMANTIC_SEARCH search results as image.'
//          ), '#description' => t('Should CCK field <em>' . $field_label . ' </em> display in the search results as an image?'), '#return_value' => 1, '#default_value' => variable_get($file_pref_name, '0'),);
//        }
//
//      }
//    }
//    //get cck fields and have a setting for 
//    //show in search results
//  } //end cck types foreach
//  $form['semantic_search_settings']['div_end_a']['#value'] = '</div>';
//  //dbg($form,'$form');
//  return system_settings_form( $form);
//} //end settings

/**
 * Basic permissions and permisions dynamically generated from search
 * */
function semantic_search_perm() {
  $perms = array (
    'access semantic_search',
    'administer semantic_search',
    'search semantic_search',
    'configure semantic_search',
    'new search',
    'delete search'
  );
  
  //get dynamic 
  //'SemanticSearch of '.$search_name
  $searches = _semantic_search_get_all_search_form_vars();
  
  foreach ($searches as $key => $search) {
      $search_name = $search['name'];
      $perms [] = $search_name . ': configure search';
      $perms [] = $search_name . ': access search';
  }
  
  return $perms;
} // function semantic_search_perm

/**
 * Basic help function
 * */
function semantic_search_help($section = '') {
  $output = '';

  switch ($section) {
    case "admin/modules#description" :
      $output = t('<strong>Semantic Search:</strong> Provides various faceted search functionality with ');
      $output .= t('National Information Network for Artists (SEMANTIC_SEARCH)');
      break;
    case 'admin/help#modulename' :
      $output = t('<strong>Semantic Search:</strong> Provides various faceted search functionality with ');
      $output .= t('National Information Network for Artists (SEMANTIC_SEARCH)');
      break;
  }

  return $output;
} //END semantic_search_help

/**
 * menu callback
 * */
function semantic_search_menu($may_cache) {
  

  $items = array ();
  
  //TODO generate dynamic searches here
  $the_type = 'semantic_search_search_title';
  $title_of_search = variable_get($the_type, 'SEMANTIC_SEARCH Search');
  
  if (!$may_cache){
    //////////////////////
    // Default search
    //init the search object
    $items[] = array (
        'path' => 'semantic_search',
        'title' => t($title_of_search
      ), 'callback' => '_semantic_search_search', 
      'access' => user_access('search semantic_search'), 
      'type' => MENU_CALLBACK
    );
  
  ///configuration and administration
  $items[] = array (
    'path' => SEMANTIC_SEARCH_ADMIN_HOME,
    'title' => t('Semantic Search'), 
     'callback' => '_semantic_search_admin_semantic_search', 
     'access' => user_access('admin semantic_search'), 
     'type' => MENU_NORMAL_ITEM,
     
  );
  
  $searches = _semantic_search_get_all_search_form_vars();
  // now generate the list of search urls
  _semantic_search_get_menus($items,$searches,$may_cache);
  
  if (empty($searches)){
    
    $items[] = array (
      'path' => SEMANTIC_SEARCH_ADMIN_HOME.'/searches',
      'title' => t('New Search Configuration'), 
      'description' => t('Create a new search page.'), 
       'callback' => 'drupal_get_form',
       'callback arguments' => array('semantic_search_search_form'), 
       'access' => user_access('admin semantic_search'), 
       'weight' => 0,
       'type' => MENU_LOCAL_TASK  
    );
    
  } else {
     //the export to RDF page
    $items[] = array (
      'path' => SEMANTIC_SEARCH_ADMIN_HOME.'/searches',
      'title' => t('Search Configurations'), 
       'callback' => '_semantic_search_admin_semantic_search', 
       'access' => user_access('admin semantic_search'), 
       'weight' => 0,
       'type' => MENU_LOCAL_TASK  
    );
    
    $items[] = array (
      'path' => SEMANTIC_SEARCH_ADMIN_HOME.'/searches/new',
      'title' => t('New Search Configuration'), 
      'description' => t('Create a new search page.'), 
       'callback' => 'drupal_get_form',
       'callback arguments' => array('semantic_search_search_form'), 
       'access' => user_access('admin semantic_search'), 
       'weight' => 0,
       'type' => MENU_LOCAL_TASK  
    );
    
  }
  
  if (!empty($searches)){
  
    foreach($searches as $key=>$search){
       $search_name = $search['name'];
       
       $items[] = array (
        'path' => SEMANTIC_SEARCH_ADMIN_HOME.'/searches/'.$search_name,
        'title' =>   t($search['title']) , 
        'description' => t($search['description']), 
         'callback' => 'drupal_get_form',
         'callback arguments' => array('semantic_search_search_form',$search_name), 
         'access' => user_access('admin semantic_search') || user_access($search_name . ': configure search' ), 
         'weight' => $key+1,
         'type' => MENU_LOCAL_TASK  
      );
      
      
      $items[] = array (
        'path' => SEMANTIC_SEARCH_ADMIN_HOME.'/searches/'.$search_name.'/add',
        'title' =>   t($search['title']) , 
        'description' => t($search['description']), 
         'callback' => 'drupal_get_form',
         'callback arguments' => array('semantic_search_search_field_form',$search_name), 
         'access' => user_access('admin semantic_search') || user_access($search_name . ': configure search' ), 
         'weight' => $key+1,
         'type' => MENU_CALLBACK  
      );
      
      //get all fields for this search
      $fields = _semantic_search_get_all_search_field_vars($search_name);
      foreach($fields as $field) {
        $items[] = array (
          'path' => SEMANTIC_SEARCH_ADMIN_HOME.'/searches/'.$search_name.'/edit/'.$field['id'],
          'title' =>   t($search['title']).': '.$field['title'] , 
          'description' => t('Edit ').t($search['description']), 
           'callback' => 'drupal_get_form',
           'callback arguments' => array('semantic_search_search_field_form',$search_name,$field['id'],true), 
           'access' => user_access('admin semantic_search') || user_access($search_name . ': configure search' ), 
           'weight' => $key+1,
           'type' => MENU_CALLBACK  
        );
      }
    }
  }  
  
  //the export to RDF page
  $items[] = array (
    'path' => SEMANTIC_SEARCH_ADMIN_HOME.'/export',
    'title' => t('Export'), 
     'callback' => '_semantic_search_export', 
     'access' => user_access('admin semantic_search'), 
     'weight' => 1,
     'type' => MENU_LOCAL_TASK  
  );
  
  //the export to RDF page
  $items[] = array (
    'path' => SEMANTIC_SEARCH_ADMIN_HOME.'/import',
    'title' => t('Import'), 
     'callback' => '_semantic_search_export', 
     'access' => user_access('admin semantic_search'), 
     'weight' => 2,
     'type' => MENU_LOCAL_TASK  
  );
  
    //the export to RDF page
  $items[] = array (
    'path' => SEMANTIC_SEARCH_ADMIN_HOME.'/import/csv',
    'title' => t('CSV'), 
     'callback' => '_semantic_search_export', 
     'access' => user_access('admin semantic_search'), 
     'weight' => 3,
     'type' => MENU_LOCAL_TASK  
  );
  
  $items[] = array (
    'path' => SEMANTIC_SEARCH_ADMIN_HOME.'/import/microformats',
    'title' => t('Micro Formats'), 
     'callback' => '_semantic_search_export', 
     'access' => user_access('admin semantic_search'), 
     'weight' => 4,
     'type' => MENU_LOCAL_TASK  
  );
  
    $items[] = array (
    'path' => SEMANTIC_SEARCH_ADMIN_HOME.'/import/rdf',
    'title' => t('RDF Files'), 
     'callback' => '_semantic_search_export', 
     'access' => user_access('admin semantic_search'), 
     'weight' => 5,
     'type' => MENU_LOCAL_TASK  
  );
  
  
  $items[] = array (
    'path' => SEMANTIC_SEARCH_ADMIN_HOME.'/config',
    'title' => t('Settings'), 
    'callback' => 'drupal_get_form',
    'callback arguments'=> array('semantic_search_settings_form'), 
    'access' => user_access('admin semantic_search'), 
    'type' => MENU_LOCAL_TASK
    );
  //__nsp('semantic_search_menu() end');
  //
  
  } // !$may_cache
  
  
  return $items;
}

/**
 * SEMANTIC_SEARCH checks for a variable set via javascript
 * */
function _semantic_search_check_redirect() {
  if (!empty ($_COOKIE['SEMANTIC_SEARCH_REDIRECT']) && empty ($_SESSION['SEMANTIC_SEARCH_REDIRECTED'])) {
    $url = $_COOKIE['SEMANTIC_SEARCH_REDIRECT'];
    unset ($_COOKIE['SEMANTIC_SEARCH_REDIRECT']);
    $_SESSION['SEMANTIC_SEARCH_REDIRECTED'] = true;

    $this_uri = url($_SERVER['REQUEST_URI'], null, null, true);
    if ($url != $this_uri) {
      unset ($_COOKIE['SEMANTIC_SEARCH_REDIRECT']);
      unset ($_SESSION['SEMANTIC_SEARCH_REDIRECTED']);
      drupal_set_header('Location: ' . $url . "\n");
    } else {
      unset ($_COOKIE['SEMANTIC_SEARCH_REDIRECT']);
      unset ($_SESSION['SEMANTIC_SEARCH_REDIRECTED']);
    }
  } else {
    unset ($_COOKIE['SEMANTIC_SEARCH_REDIRECT']);
    unset ($_SESSION['SEMANTIC_SEARCH_REDIRECTED']);
  }

}

/**
* add semantic_search javascript libraries to Drupal
* */
function _semantic_search_load_js_and_css() {
  global $semantic_search_css_loaded;
  if (empty ($semantic_search_css_loaded)) {
    $path = drupal_get_path('module', 'semantic_search');
    $js_path = $path . '/js';
    $css_path = $path . '/css';
    /**
    * add css  
    * */
    $css = $css_path . '/semantic_search.css';
    drupal_add_css($css);
    $css = $css_path . '/semantic_search_ajax.css';
    drupal_add_css($css);

    //see http://drupal.org/node/88979 
    // DO NOT USE IN COMBINATION WITH AUTOCOMPLETE.JS
    // detect if Drupal 5 ?
    //drupal_add_js($js_path . '/jquery.js');
    drupal_add_js($js_path . '/jquery_ajax.js');

    //todo dynamically or statically combine these into one file
    drupal_add_js($js_path . '/semantic_search.contrib.js');
    drupal_add_js($js_path . '/jquery.history.js');
    drupal_add_js($js_path . '/jquery.cache.js');
    drupal_add_js($js_path . '/jquery.hook.js');
    drupal_add_js($js_path . '/sha1.js');
    drupal_add_js($js_path . '/semantic_search.helpers.js');
    drupal_add_js($js_path . '/semantic_search.js');
    
    if (user_access("administer semantic_search")) {
      drupal_add_js($js_path . '/semantic_search.admin.js');
    }

    // now add some constants and configurations set by the server,
    // but used in the javascript
    $constants = ' var SEMANTIC_SEARCH_JSRPC_ADMIN_PATH = "' . SEMANTIC_SEARCH_JSRPC_ADMIN_PATH . '"; ';
    $js_constants = "\n" . '<script type="text/javascript">' . $constants . '</script>' . "\n";
    drupal_add_js($js_constants,'inline', false, false, false);
    $semantic_search_css_loaded = true;
  }
}

/**
 * provides web based configuration for search facets
 * */
function semantic_search_settings_form() {
  global $base_url;
  
  if (!user_access("administer semantic_search")) {
    return message_admin_access();
  }
  _semantic_search_load_js_and_css();
  _semantic_search_node_index_check();

  $path = drupal_get_path('module', 'semantic_search');
  
  global $_semantic_search_search;
  if (empty ($_semantic_search_search))
    _SEMANTIC_SEARCH_INIT();
  
  $_semantic_search_search->getAllBaseOptions();
  
  $form = array();
  
  $form['install'] = array (
    '#type' => 'checkbox',
    '#title' => t('Install SemanticSearch database tables.'), 
    '#description' => t('You may need to install the tables for indexes, caches, and RDF data. <br/> (It is safe to run this after the initial install.)'), 
    '#return_value' => 1, 
    '#default_value' => 0,
    //TODO detect '#attributes'=>array('disabled'=>'disabled')
  );
  
  $form['module_settings'] = array (
    '#type' => 'fieldset',
    '#title' => 'Basic Settings',
    '#description' => t('Settings for All Searches'),
    '#collapsible' => 1,
    '#collapsed' => 1
  );

  /**
   * base URL should match waht is in settings.php
   * */
  $form['module_settings']['_BASE_URL'] = _semantic_search_form_element(
    '_BASE_URL', 
    'Base Url',
    'For this site it should be <code >$base_url = '. $base_url.'</code>',
    $base_url);

  /**
   * base URI for data specific to the site
   * */
  $form['module_settings']['_BASE_NAMESPACE_URL'] = _semantic_search_form_element(
    '_BASE_NAMESPACE_URL', 
    'Base RDF namespace URI',
    'The base URI used for the data on this site.',
    'http://www.ahirc.org');
 
 
 $form['store'] = array (
    '#type' => 'fieldset',
    '#title' => t('<strong>RDF Store Settings</strong>'),
    '#description' => t('SemanticSearch uses SONIA (Simple Ontology and Inference' .
        ' Algorithms) as an abstraction layer for for various RDF stores.' .
        '<br /> There is planned support for RDF stores running remotely, locally, or aggregated from accross sites.'),
  );
 
//   $form['store']['default'] = array (
//    '#type' => 'checkbox',
//    '#title' => t('Use ARC as defualt store'), 
//    '#return_value' => 1, 
//    '#default_value' => 0,
//    //TODO detect '#attributes'=>array('disabled'=>'disabled')
//  );
//   
   
  $form['store']['arc_settings'] = array (
    '#type' => 'fieldset',
    '#title' => t('ARC Local Settings'),
    '#description' => t('ARC settings for running ARC locally. <br />' .
        'ARC is a PHP based RDF store by Benjamin Nowack.'),
    '#collapsible' => 1,
    '#collapsed' => 1
  );
  
  
  //define('SONIA_DEBUG', true);
  /* location of an error log */
  //define('SONIA_ERROR_LOG','/Temp/SONIAERROR.txt');
  //define('SONIA_WRITE_ARC_LOG', true);
  //define('SONIA_ARC_LOG_PATH', SONIA_LOCAL_ARC_TOOLS.'/logs/');

  /**
   * datatabase that ARC uses
   * */
  $form['store']['arc_settings']['ARC_DB_NAME'] = _semantic_search_form_element(
    'ARC_DB_NAME', 
    'DB name',
    'Name of the Database',
    '');

  /**
   * ARC DB username
   * */
  $form['store']['arc_settings']['ARC_DB_USER'] = _semantic_search_form_element(
    'ARC_DB_USER', 
    'DB username',
    'Database username for establishing a connection',
    '');

  /**
   * ARC DB password
   * */
  $form['store']['arc_settings']['ARC_DB_PW'] = _semantic_search_form_element(
    'ARC_DB_PW', 
    'DB Password',
    'Database password',
    '');

  /**
   * ARC DB host
   * */
  $form['store']['arc_settings']['ARC_DB_HOST'] = _semantic_search_form_element(
    'ARC_DB_HOST', 
    'DB host',
    'Host for the ARC database',
    'localhost');

  /**
   * ARC DB port... should be 3306 in most cases
   * */
  $form['store']['arc_settings']['ARC_DB_PORT'] = _semantic_search_form_element(
    'ARC_DB_PORT', 
    'DB Port',
    'Database Port Number',
    3306);

  /**
   * table name prefix to use in case using the same DB which has non - arc tables
   * */
  $form['store']['arc_settings']['ARC_DB_PREFIX_NAME'] = _semantic_search_form_element(
    'ARC_DB_PREFIX_NAME', 
    'ARC Database prefix',
    'ARC prefixes table names to prevent tablename collision',
    'semantic_search');
    
  return  system_settings_form($form);
}

/**
 * catch this settings form and do synchronization  
 * */
function semantic_search_settings_form_submit($form_id, $form_values) {
  system_settings_form_submit($form_id, $form_values);
  //try to install
  if ($form_values['install']){
    require SEMANTIC_SEARCH_LOCATION.'semantic_search.install';
    semantic_search_install();
  }
  return SEMANTIC_SEARCH_ADMIN_HOME.'/config';
}


/**
 * @todo convert to theming function
 * move this to semantic_search.module as main menu item
 */
function _semantic_search_search($search_form = null) {
  ////__nsp(' semantic_search.module _semantic_search_search() start');
  //check to see if this is the url the user intends
  //only if not RPC
  _semantic_search_check_redirect();
  //__nsp('  _semantic_search_search  start');
  global $_semantic_search_search;
  if (empty ($_semantic_search_search))
    _SEMANTIC_SEARCH_INIT();
   
  //dbg($_semantic_search_search->sonia->io->startBuildingCache($_semantic_search_search),'huh?');

  ////__nsp(' semantic_search.module (css start');
  _semantic_search_load_js_and_css();
  ////__nsp(' semantic_search.module (css end');
  $_semantic_search_search_hash = 'all' . $_semantic_search_search->search_hash;
  //__nsp(' semantic_search.module (cache start');
  $result = (SONIA_USE_CACHE) ? $_semantic_search_search->sonia->io->getCache($_semantic_search_search_hash) : null;
  //__nsp(' semantic_search.module theme("cache end');
  if (SONIA_USE_CACHE && $result !== null) {
    return $result;
  } else {
    //__nsp(' semantic_search.module enter iff');
    $vars['$do_search$'] = $_semantic_search_search->doSearch();
    $_semantic_search_search_result_found = $_semantic_search_search->searchResultsFound();
     
    $pag = $_semantic_search_search->searchPaginaton();
    $vars['$pagination$'] = theme("semantic_search_search_results_pagination", $pag);
    
    $vars['$search_results$'] = _semantic_search_SearchResults($_semantic_search_search);
    //__nsp(' semantic_search.module _semantic_search_search() _semantic_search_SearchResults( end');
    $vars['$search_jellybean$'] = _semantic_search_SearchNavigation($_semantic_search_search);
    //__nsp(' semantic_search.module _semantic_search_search() semantic_search_search begin');
    $vars['$search_form$'] = theme("semantic_search_search", $_semantic_search_search,$search_form);
    //__nsp(' semantic_search.module theme("semantic_search_search" end');
    $vars['$search_title$'] = (true) ? t('Search CCK nodes') : '';
    $vars['$search_results_title$'] = (!$vars['$do_search$']) ? t('Search Results') : $vars['$pagination$'];
    //dbg($_semantic_search_search_result_found,'$_semantic_search_search_result_found');
    $vars['$search_results_lower_nav$'] = (!$pag['search_results_success'] && $pag['do_search']) ? '' : $vars['$pagination$'];
    ////__nsp(' semantic_search.module theme("semantic_search" start');
    $result = theme("semantic_search", $vars);
    ////__nsp(' semantic_search.module  theme("semantic_search" end');

    if (SONIA_USE_CACHE)
      $_semantic_search_search->sonia->io->putCache($_semantic_search_search_hash, $result);
    ////__nsp(' semantic_search.module _semantic_search_search() end');
    return $result;
  }

}

/** 
 * WARNING
 * Until this page is only accessed by the proper path this will cause an error on every page
 * 
 * */
function _SEMANTIC_SEARCH_INIT() {
  //the search object
  global $_semantic_search_search;
  //a setting
  global $use_search_cache;
  $use_search_cache = variable_get('semantic_search_search_unset', '1');

  db_set_active('arc');
  $_semantic_search_search = new NinaSearch(); //from semantic_search.inc
  db_set_active('default');
  return '';
}

/**
 * function for constructing search navigation display
 * */
function _semantic_search_SearchNavigation(& $_semantic_search_search, $not_rpc = true, $toggle = true, $extra = null) {
  $html = '';

  if (is_object($_semantic_search_search)) {
    db_set_active('arc');
    $data = $_semantic_search_search->jellyBean($not_rpc, $toggle, $extra);
    db_set_active('default');
  }
  return theme("semantic_search_navigation", $data);
}

/**
 * wrapper for the drupal function
 * adds some extra fields
 * */
function _semantic_search_form_render($form) {
  
  return drupal_get_form('_semantic_search_form_render_form', $form);
}

function _semantic_search_form_render_form($form){
  global $_semantic_search_search;
  if (empty ($_semantic_search_search))
    _SEMANTIC_SEARCH_INIT();
   
  $form['#action'] = $_semantic_search_search->makefullURLforRedirect();
  return $form;
}


/**
 * displays search results
 * */
function _semantic_search_SearchResults(& $_semantic_search_search, $not_rpc = true) {
  $html = '';
 // dbg($_semantic_search_search->searchResults($not_rpc));
  if (is_object($_semantic_search_search)) {
    db_set_active('arc');
    $html .= theme("semantic_search_search_results", $_semantic_search_search->searchResults($not_rpc));
    db_set_active('default');
    return $html;
  }
} // _SearchResults();

/**
 * @todo drupal specific configurations
 * */
function semantic_search_configure() {
  if (!user_access("configure semantic_search")) {
    return message_admin_access();
  }

  return system_settings_form('menu_configure', $form);
}

/**
 * any form based validation to do 
 * */
function _SEMANTIC_SEARCHSearch_validate($form_id, $form_values) {

}

/**
 * catch this form and prevent a redirect
 * 
 * @return false don't redirect
 * 
 * */
function _SEMANTIC_SEARCHSearch_submit($form_id, $form_values) {
  return false;
}

/**
 * default admin function
 * */
function _semantic_search_admin_semantic_search(){
  $output = t('');
  
  return $output;
}

function _semantic_search_check() {
  global $_semantic_search_search;
  if (empty ($_semantic_search_search))
    _SEMANTIC_SEARCH_INIT();
  return $_semantic_search_search;
}