tripal/tripal_core/tripal_core.module

<?php
/**
 * @file
 * The Tripal Core module
 */

 /**
 * @defgroup tripal_modules Tripal Modules
 * @{
 * All documented functions for the various Tripal Modules excluding API functions and Views Integration functions. 
 * @}
 */

/**
 * @defgroup tripal_api Tripal API
 * @{
 * Provides an application programming interface (API) for Tripal
 *
 * The Tripal API currently provides generic insert/update/select functions for all chado content as 
 * well as some module specific functions that insert/update/delete/select specific chado content. 
 *
 * This API is currently in its infancy and some necessary functions might be missing. If you find
 * a missing function that you think should be included go to the sourceforge feature request 
 * page and request it's inclusion in the API. Such feature requests with a working function 
 * definition will be given priority.
 * @}
 */

 /**
 * @defgroup tripal_core_api Core Module API
 * @ingroup tripal_api
 */

/**
 * @defgroup tripal_core Tripal Core Module
 * @ingroup tripal_modules
 */



require_once "api/tripal_core_chado.api.inc";
require_once "api/tripal_core_files.api.inc";
require_once "api/tripal_core_ahah.api.inc";
require_once "api/tripal_core_custom_tables.api.inc";
require_once "api/tripal_core_jobs.api.inc";
require_once "api/tripal_core_mviews.api.inc";
require_once "includes/jobs.php";
require_once "includes/mviews.php";
require_once "includes/custom_tables.php";
require_once "includes/chado_install.php";

/**
 * Implements hook_init().
 * Used to set the search_path, create default content and set default variables.
 *
 * @ingroup tripal_core
 */
function tripal_core_init() {
  global $base_url;     
  
  // we need to declare here the persistent_chado global variable
  global $persistent_chado;
  global $prepared_statements;
  $persistent_chado = NULL;
  $prepared_statements = array();
  
  // add javascript files 
  drupal_add_js(drupal_get_path('theme', 'tripal') . '/js/tripal.ahah.js');
  
  // create the 'tripal' controlled volcabulary in chado but only if it doesn't already exist, and
  // only if the chado database is present.
  if (tripal_core_is_chado_installed()) {
  
    // make sure the current version of chado is set
    tripal_core_set_chado_version();  
  
    if (!db_fetch_object(chado_query("SELECT * FROM {cv} WHERE name = 'tripal'"))) {
      $results = chado_query(
        "INSERT INTO {cv} (name,definition) ".
        "VALUES ('tripal', 'Terms used by Tripal for modules to manage data such as that stored in property tables like featureprop, analysisprop, etc')");
    }
    if (!db_fetch_object(chado_query("SELECT * FROM {db} WHERE name = 'tripal'"))) {
      $results = chado_query(
        "INSERT INTO {db} (name,description) ".
        "VALUES ('tripal', 'Used as a database placeholder for tripal defined objects such as tripal cvterms')");
    }
  }

  // add some variables for all javasript to use for building URLs
  global $base_url;
  $theme_dir = drupal_get_path('theme', 'tripal');
  $clean_urls = variable_get('clean_url', 0);
  drupal_add_js(
    " var baseurl  = '$base_url';
      var themedir = '$theme_dir';
      var isClean  =  $clean_urls;",
    'inline', 'header');

  // make sure the date time settings are the way Tripal will insert them
  // otherwise PostgreSQL version that may have a different datestyle setting
  // will fail when inserting or updating a date column in a table.
  db_query("SET DATESTYLE TO '%s'", 'MDY'); 

  // in the event that an errant Tripal or extension function fails to
  // set the postgres search_path back to noraml we do it here on 
  // init of the core
  tripal_db_set_default_search_path(); 
  
  // create a persistent connection
  $connection = tripal_db_persistent_chado();
}

/**
 * Implements hook_menu().
 * Defines all menu items needed by Tripal Core
 *
 * @ingroup tripal_core
 */
function tripal_core_menu() {
  $items = array();

  // Triapl setting groups
  $items['admin/tripal'] = array(
    'title' => 'Tripal Management',
    'description' => "Manage the behavior or Tripal and its various modules.",
    'position' => 'right',
    'weight' => -5,
    'page callback' => 'system_admin_menu_block_page',
    'access arguments' => array('administer site configuration'),
    'file' => 'system.admin.inc',
    'file path' => drupal_get_path('module', 'system'),
  );
  $items['admin/tripal/customize'] = array(
    'title' => 'Customize Tripal',
    'position' => 'right',
    'page callback' => 'theme',
    'page arguments' => array('tripal_core_customize'),
    'access arguments' => array('administer site configuration'),
  );
  $items['tripal_toggle_box_menu/%/%/%'] = array(
    'title' => 'Toggle Box',
    'page callback' => 'tripal_toggle_box_menu',
    'page arguments' => array(1, 2, 3),
    'access arguments' => array('access administration pages'),
    'type' => MENU_CALLBACK | MENU_LINKS_TO_PARENT
  );
  $items['admin/tripal/chado_install'] = array(
    'title' => 'Install Chado Schema',
    'description' => 'Installs the Chado database tables, views, etc., inside the current Drupal database',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('tripal_core_chado_load_form'),
    'access arguments' => array('install chado'),
    'type' => MENU_NORMAL_ITEM,
  );

  // Jobs Management
  $items['admin/tripal/tripal_jobs'] = array(
    'title' => 'Jobs',
    'description' => 'Jobs managed by Tripal',
    'page callback' => 'tripal_jobs_report',
    'access arguments' => array('access administration pages'),
    'type' => MENU_NORMAL_ITEM,
  );
  $items['admin/tripal/tripal_jobs/cancel/%'] = array(
    'title' => 'Jobs',
    'description' => 'Cancel a pending job',
    'page callback' => 'tripal_jobs_cancel',
    'page arguments' => array(4),
    'access arguments' => array('access administration pages'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/tripal/tripal_jobs/rerun/%'] = array(
    'title' => 'Jobs',
    'description' => 'Re-run an existing job.',
    'page callback' => 'tripal_jobs_rerun',
    'page arguments' => array(4),
    'access arguments' => array('access administration pages'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/tripal/tripal_jobs/view/%'] = array(
    'title' => 'Jobs Details',
    'description' => 'View job details.',
    'page callback' => 'tripal_jobs_view',
    'page arguments' => array(4),
    'access arguments' => array('access administration pages'),
    'type' => MENU_CALLBACK,
  );

  // Materialized Views
  $items['admin/tripal/mviews'] = array(
    'title' => 'MViews',
    'description' => 'Materialized views are used to improve speed of large or complex queries.',
    'page callback' => 'tripal_mviews_report',
    'access arguments' => array('access administration pages'),
    'type' => MENU_NORMAL_ITEM,
  );
  $items['admin/tripal/mviews/report/%'] = array(
    'title' => 'Materialized View',
    'description' => 'Materialized views are used to improve speed of large or complex queries.',
    'page callback' => 'tripal_mview_report',
    'page arguments' => array(4),
    'access arguments' => array('access administration pages'),
    'type' => MENU_NORMAL_ITEM,
  );
  $items['admin/tripal/mviews/new'] = array(
    'title' => 'Create MView',
    'description' => 'Materialized views are used to improve speed of large or complex queries.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('tripal_mviews_form'),
    'access arguments' => array('access administration pages'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/tripal/mviews/edit/%'] = array(
    'title' => 'Edit MView',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('tripal_mviews_form', 4),
    'access arguments' => array('access administration pages'),
    'type' => MENU_NORMAL_ITEM,
  );
  $items['admin/tripal/mviews/action/%/%'] = array(
    'title' => 'Create MView',
    'description' => 'Materialized views are used to improve speed of large or complex queries.',
    'page callback' => 'tripal_mviews_action',
    'page arguments' => array(4, 5, "1"),
    'access arguments' => array('access administration pages'),
    'type' => MENU_CALLBACK,
  );
  
  // Custom Tables
  $items['admin/tripal/custom_tables'] = array(
    'title' => 'Custom Tables',
    'description' => 'Custom tables are added to Chado.',
    'page callback' => 'tripal_custom_tables_list',
    'access arguments' => array('access administration pages'),
    'type' => MENU_NORMAL_ITEM,
  );
  $items['admin/tripal/custom_tables/view/%'] = array(
    'title' => 'Custom Tables',
    'description' => 'Custom tables are added to Chado.',
    'page callback' => 'tripal_custom_table_view',
    'page arguments' => array(4),
    'access arguments' => array('access administration pages'),
    'type' => MENU_NORMAL_ITEM,
  );
  $items['admin/tripal/custom_tables/new'] = array(
    'title' => 'Create Custom Table',
    'description' => 'Custom tables are added to Chado.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('tripal_custom_tables_form'),
    'access arguments' => array('access administration pages'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/tripal/custom_tables/edit/%'] = array(
    'title' => 'Edit Custom Table',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('tripal_custom_tables_form', 4),
    'access arguments' => array('access administration pages'),
    'type' => MENU_NORMAL_ITEM,
  );
  $items['admin/tripal/custom_tables/action/%/%'] = array(
    'title' => 'Create Custom TAble',
    'description' => 'Custom tables are added to Chado.',
    'page callback' => 'tripal_custom_tables_action',
    'page arguments' => array(4, 5, "1"),
    'access arguments' => array('access administration pages'),
    'type' => MENU_CALLBACK,
  );

  return $items;
}

/**
 *  Set the permission types that the chado module uses.  Essentially we
 *  want permissionis that protect creation, editing and deleting of chado
 *  data objects
 *
 * @ingroup tripal_core
 */
function tripal_core_perm() {
  return array('install chado');
}

/**
 * Implements hook_theme().
 * Registers template files/functions used by this module.
 *
 * @ingroup tripal_core
 */
function tripal_core_theme() {
  return array(
    'tripal_core_job_view' => array(
      'arguments' => array('job_id' => NULL),
      'template' => 'tripal_core_job_view',
    ),
    'tripal_core_customize' => array(
      'arguments' => array('job_id' => NULL),
      'template' => 'tripal_core_customize',
      'path' => drupal_get_path('module', 'tripal_core') . '/theme'
    ),
  );
}

/**
 * Implements hook_job_describe_args().
 * Describes the arguements for the tripal_update_mview job to allow for greater
 * readability in the jobs details pages.
 *
 * @param $callback
 *   The callback of the current tripal job (this is the function that will be executed
 *   when tripal_launch_jobs.php is run.
 * @param $args
 *   An array of arguments passed in when the job was registered.
 *
 * @return
 *   A more readable $args array
 *
 * @ingroup tripal_core
 */
function tripal_core_job_describe_args($callback, $args) {
  $new_args = array();
  if ($callback == 'tripal_update_mview') {
    // get this mview details
    $sql = "SELECT * FROM {tripal_mviews} WHERE mview_id = %d ";
    $mview = db_fetch_object(db_query($sql, $args[0]));
    $new_args['View Name'] = $mview->name;
  }

  elseif ($callback == 'tripal_core_install_chado') {
     $new_args['Action'] = $args[0];
  }
  return $new_args;
}

/**
 * this is just a wrapper for backwards compatibility with a naming mistake.
 * it can go away in the future as it only is useful for jobs created by v0.3b
 *
 * @todo remove this function
 */
function tripal_core_load_gff3($gff_file, $organism_id, $analysis_id, $add_only = 0,
  $update = 0, $refresh = 0, $remove = 0, $job = NULL) {

  tripal_feature_load_gff3($gff_file, $organism_id, $analysis_id, $add_only,
    $update, $refresh, $remove, $job);
}

/**
 * Implements hook_coder_ignore().
 * Defines the path to the file (tripal_core.coder_ignores.txt) where ignore rules for coder are stored
 */
function tripal_core_coder_ignore() {
  return array(
    'path' => drupal_get_path('module', 'tripal_core'),
    'line prefix' => drupal_get_path('module', 'tripal_core'),
  );
}