modules/autopilot/autopilot.module

<?php
define('AUTOPILOT_OSTYPE_WINDOWS', 1);
define('AUTOPILOT_OSTYPE_LINUX', 2);

define('AUTOPILOT_OWNERSHIP_NORMAL', 1);
define('AUTOPILOT_OWNERSHIP_GLOBAL', 2);
define('AUTOPILOT_OWNERSHIP_TEMPLATE', 3);

define('AUTOPILOT_DEBUG_MODE', true);

define('AUTOPILOT_MAIL_KEY', 'autopilot');

/**
 * Implementation of hook_help
 * Since our help section is rather large,
 * it is delegated to a seperate file.
 * The file is included, and the function is passed off
 * to this helper function/file.
 */
function autopilot_help($section) {
  require_once(drupal_get_path('module', 'autopilot') . '/autopilot_help.inc');
  return _autopilot_help($section);
}

function autopilot_menu($maycache = false) {
  _autopilot_init();
  _autopilot_get_autopilot();
  $items = array();
  
  $maycache = true; // For debugging
  $user_edit_autopilots = user_access('autopilot admin');
  $user_view_autopilots = user_access('autopilot view') | user_access('autopilot build user');
  $items[] = array(
    'path' => 'admin/autopilot',
    'title' => t('Autopilot'),
    'callback' => 'admin_autopilot_page',
    'access' => user_access('autopilot admin'),
  );
  if($maycache) {
    # Main AutoPilot overview
    
    $items[] = array(
      'path' => 'autopilot',
      'title' => t('Autopilots'),
      'type' => MENU_NORMAL_ITEM,
      'callback' => 'autopilot_page',
      'access' => $user_view_autopilots,
    );
    $items[] = array(
      'path' => 'autopilot/select',
      'title' => t('Selects an autopilot.'),
      'type' => MENU_CALLBACK,
      'callback' => '_autopilot_select_autopilot',
      'access' => $user_view_autopilots,
    );
    
    # Overview
    $items[] = array(
      'path' => 'autopilot/overview',
      'title' => t('Home'),
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'callback' => 'autopilot_page',
      'access' => $user_view_autopilots,
      'weight' => -1,
    );
  }
    
  // Autopilot/Home Section
// For buildplan
  $items[] = array(
    'path' => 'autopilot/buildplans',
    'title' => t('Build Plans'),
    'type' => MENU_LOCAL_TASK,
    'callback' => 'buildplan_overview_page',
    'callback arguments' => array(arg(2), arg(4)),
    'access' => $user_view_autopilots,
    'weight' => -1,
  );
  if(arg(1) == 'buildplans' && is_numeric(arg(2))) {
    $items[] = array(
      'path' => 'autopilot/buildplans/' . arg(2) ,
      'title' => t('Overview'),
      'type' => MENU_LOCAL_TASK,
      'callback' => 'buildplan_view_page',
      'callback arguments' => array(arg(2)),
      'access' => $user_view_autopilots,
      'weight' => -1,
    );
    $items[] = array(
      'path' => 'autopilot/buildplans/' . arg(2) . '/buildrun_log',
      'title' => t('Build Run Logs'),
      'type' => MENU_LOCAL_TASK,
      'callback' => 'buildrun_log',
      'callback arguments' => array(arg(3)),
      'access' => $user_view_autopilots,
    );
    $items[] = array(
      'path' => 'autopilot/buildplans/' . arg(2) . '/buildrun_log/' . arg(4),
      'title' => t('Run Log'),
      'type' => MENU_LOCAL_TASK,
      'callback' => 'buildrun_log_view',
      'callback arguments' => array(arg(4)),
      'access' => $user_edit_autopilots,
    );
    $items[] = array(
      'path' => 'autopilot/buildplans/' . arg(2) . '/maintinance',
      'title' => t('Maintianance'),
      'type' => MENU_LOCAL_TASK,
      'callback' => 'buildplan_maintianance',
      'callback arguments' => array(arg(2)),
      'access' => $user_edit_autopilots,
    );
  }

  // Setup Section
  $items[] = array(
    'path' => 'autopilot/setup',
    'title' => t('Setup'),
    'type' => MENU_LOCAL_TASK,
    'callback' => 'autopilot_setup_overview',
    'access' => user_access('autopilot admin'),
  );
  # Database Section
  $items[] = array(
    'path' => 'autopilot/database',
    'title' => t('Database'),
    'type' => MENU_LOCAL_TASK,
    'callback' => 'autopilot_database_overview',
    'access' => user_access('autopilot database admin') | user_access('autopilot admin'),
  );
  $items[] = array(
    'path' => 'autopilot/database/tx',
    'title' => t('Transfer Database'),
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'callback' => 'drupal_get_form',
    'callback arguments' => array('autopilot_database_transfer_form'),
    'access' => user_access('autopilot database admin') | user_access('autopilot admin'),
  );
  # Build Plans
  $items[] = array(
    'path' => 'autopilot/setup/buildplans',
    'title' => t('Build Plans'),
    'type' => MENU_LOCAL_TASK,
    'callback' => 'buildplan_overview_page',
    'callback arguments' => array(arg(3), arg(4)),
    'access' => $user_view_autopilots,
  );
  
  # Builds
  $items[] = array(
    'path' => 'autopilot/setup/builds',
    'title' => t('Builds'),
    'type' => MENU_LOCAL_TASK,
    'callback' => 'builds_page',
    'callback arguments' => array(arg(3), arg(4)),
    'access' => $user_edit_autopilots,
  );
  $items[] = array(
    'path' => 'autopilot/setup/builds/add',
    'type' => MENU_CALLBACK,
    'title' => t('Add a build to a BuildPlan'),
    'access' => $user_edit_autopilots,
    'callback' => 'ap_build_edit_page',
  );
  $items[] = array(
    'path' => 'autopilot/setup/targets',
    'title' => t('Targets'),
    'type' => MENU_LOCAL_TASK,
    'callback' => 'targets_page',
    'callback arguments' => array(arg(3), arg(4)),
    'access' => $user_edit_autopilots,
  );
    
    
  /*
  $items[] = array(
    'path' => 'autopilot/commands',
    'title' => t('Commands'),
    'type' => MENU_LOCAL_TASK,
    'callback' => 'commands_page',
    'callback arguments' => array(arg(2), arg(3)),
    'access' => user_access('autopilot view'),
  );
  
  $items[] = array(
    'path' => 'autopilot/channels',
    'title' => t('Channels'),
    'type' => MENU_LOCAL_TASK,
    'callback' => 'channels_page',      
    'callback arguments' => array(arg(2), arg(3)),
    'access' => user_access('autopilot view'),
  );
    
  */
  
  
  $items[] = array(
    'path' => 'admin/settings/autopilot',
    'title' => t('Autopilot'),
    'callback' => 'drupal_get_form',
    'description' => t('Global and general settings (cipher keys, path locations, etc.) for the Autopilot system.'),
    'callback arguments' => 'autopilot_settings',
    'access' => user_access('autopilot admin'));
  # Label Settings
  $items[] = array(
    'path' => 'admin/autopilot/labels',
    'title' => t('Label Settings'),
    'callback' => 'autopilot_label_settings',
    'access' => user_access('autopilot admin'),
  );
  $items[] = array(
    'path' => 'admin/autopilot/labels/add',
    'title' => t('Create Labels'),
    'callback' => 'drupal_get_form',
    'callback arguments' => array('autopilot_label_types_form'),
    'type' => MENU_CALLBACK,
    'access' => user_access('autopilot admin'),
  );
  
  $ajax_menu = _autopilot_ajax_menu();
  
  $items = array_merge($items, $ajax_menu);
  return $items;
}

function autopilot_settings() {
  $form = array();
  $form['autopilot_tmp_path'] = array(
    '#type' => 'textfield',
    '#title' => t('Temp Directory'),
    '#description' => t('This is the directory that is used during builds.'),
    '#default_value' => variable_get('autopilot_tmp_path', file_directory_temp()));
  $form['autopilot_custom_navigation'] = array(
    '#type' => 'checkbox',
    '#title' => t('Use a custom navigation scheme'),
    '#description' => t('This takes away the default setup of tabs, links, etc. and allows one
                        to setup their own navigation scheme.'),
    '#default_value' => variable_get('autopilot_custom_navigation', false),
  );
  $form['autopilot_cipher_key'] = array(
    '#type' => 'textfield',
    '#title' => t('Cipher Key'),
    '#description' => t('This is the key that will be used to encrypt your information.'),
    '#default_value' => variable_get('autopilot_cipher_key', variable_get('drupal_private_key', null)),
  );
  return system_settings_form($form);
}

function autopilot_label_settings() {
  if(is_numeric(arg(3))) {
    return autopilot_label_page(arg(3), arg(4));
  }
  $page = '<h2>' . t('Current Label Types') . '</h2>';
  $page .= l( theme('image',
                drupal_get_path('module', 'autopilot') . '/media/images/bookmark-new.png'
              ),
             'admin/autopilot/labels/add',
             array(),
             NULL,
             NULL,
             FALSE,
             TRUE
  ) . ' - ' . t('Add New Label');
  $rs = db_query("SELECT * FROM {ap_label_types}");
  $row = array();
  $rows = array();
  while($type = db_fetch_object($rs)) {
    $row = array();
    $links = array();
    $links[] = array(
      'href' => 'admin/autopilot/labels/' . $type->lid . '/edit',
      'title' => t('edit'),
    );
    $row[] = $type->short_title;
    $row[] = $type->title;
    $row[] = theme('links', $links);
    $rows[] = $row;
  }
  if(count($rows) > 0) {
    $header = array(t('Short Title'), t('Title'), ' ');
    $page .= theme('table', $header, $rows);
  }
  else {
    $page .= t('You have no label types defined. Define some new target
               types !new_type_link.',
               array('!new_type_link' => l(t('here'), 'admin/autopilot/labels/add'))
              );
  }
  return $page;
}

function autopilot_label_page($lid = null, $action = null) {
  if($action == 'edit') {
    return drupal_get_form('autopilot_label_types_form', $lid);
  }
  else {
    $type = db_fetch_object(db_query("SELECT * FROM {ap_label_types} WHERE lid = %d", $lid));
    $page .= '<h2>' . t('Items Tagged as %tag_name', array('%tag_name' => $type->title)) . '</h2>';
  }
}

/**
 * Form to create/edit a label type
 * @param int $tid ID of a type to edit
 * @return
 */
function autopilot_label_types_form($lid = null) {
  $type = db_fetch_array(db_query("SELECT * FROM {ap_label_types} WHERE lid = %d", $lid));
  $form = array();
  $form['title'] = array(
    '#type' => 'textfield',
    '#title' => t('Type Title/Name'),
    '#default_value' => $type['title'],
  );
  $form['short_title'] = array(
    '#type' => 'textfield',
    '#title' => t('Short Title'),
    '#description' => t('A short title, no longer than 10 letters, to descirption the type. E.g. "DEV", or "PROD".'),
    '#default_value' => $type['short_title'],
    '#size' => 10,
  );
  $form['description'] = array(
    '#type' => 'textarea',
    '#title' => t('Description'),
    '#default_value' => $type['description'],
  );
  if($lid != null) {
    $form['lid'] = array('#type' => 'hidden', '#value' => $lid);
    $form['update'] = array(
      '#type' => 'submit',
      '#value' => t('Update'),
    );
    $form['cancel'] = array(
      '#value' => l(t('Cancel'), 'admin/autopilot/labels')
    );
  }
  else {
    $form['go'] = array(
      '#type' => 'submit',
      '#value' => t('Submit'),
    );
    $form['cancel'] = array(
      '#value' => l(t('Cancel'), 'admin/autopilot/labels')
    );
  }

  return $form;
}
/**
 * Implementation of hook_submit for the target types form
 * autopilot_target_types_form
 * @param String $form_id ID of rhe form
 * @param mixed $form_values Submission values
 * @return URL Path to go to after submission
 */
function autopilot_label_types_form_submit($form_id, $form_values) {
  if(isset($form_values['lid'])) {
    db_query("UPDATE {ap_label_types}
             SET title = '%s', short_title = '%s', 
             description = '%s' WHERE lid = %d",
             $form_values['title'], $form_values['short_title'],
             $form_values['description'], $form_values['lid']);
    drupal_set_message(t('Updated label type %type.',
      array('%type' => $form_values['title'])));
  }
  else {
    $lid = db_next_id('{ap_label_types}_lid');
    drupal_set_message(t('Created the new label %type.',
      array('%type' => $form_values['title'])));
    db_query("INSERT INTO {ap_label_types}(lid, title, short_title, description)
             VALUES(%d, '%s', '%s', '%s')",
             $lid, $form_values['title'], $form_values['short_title'],
             $form_values['description']);
  }
  return 'admin/autopilot/labels';
}

function admin_autopilot_page() {
  $page = '';
  
  // Diagnostics
  $stats = variable_get('autopilot_system_diagnostics', serialize(array()));
  $stats = unserialize($stats);
  $page .= '<p>' . t('Diagnostics last run') . ': <strong>';
  $page .= $stats['last_run'] > 0 ? format_date($stats['last_run'], 'large') : t('Never');
  $page .= '</strong></p>';
  $page .= drupal_get_form('autopilot_diagnostics_form', 'system');
  return $page;
}

// Function runs the diagnostics for the system.
function autopilot_diagnostics_form($type = 'system')  {
  $stats = variable_get('autopilot_system_diagnostics', serialize(array()));
  $stats = unserialize($stats);
  $form = '';
  $form['log4php_stats'] = array(
    '#type' => 'fieldset',
    '#title' => t('Log4PHP Status'),
    '#collapsible' => true,
    '#collapsed' => true,
  );
  $form['log4php_stats']['#theme'] = 'diagnostics_status_table';
  $form['log4php_stats']['log_db_check'] = array(
    '#type' => 'markup',
    '#title' => t('Write to DB Log Check'),
    '#value' => '<p><strong>' . ($stats['log_db_check'] >= 1) ? 'OK' : 'FAILED' . '</strong></p>'
  );
  $form['run'] = array(
    '#type' => 'submit',
    '#value' => t('Run Diagnostics'),
  );
  return $form;
}
// Runs the diagnostics
function autopilot_diagnostics_form_submit($form_id, $form_values) {
  $stats = array();
  $stats['last_run'] = time();
  // Run the Log4PHP Check
  $logger = 'diagnostics';
  $log = LoggerManager::getLogger($logger);
  db_query("DELETE FROM {autopilot_logger} WHERE logger = '%s'", $logger);
  $log->info('Running log Diagnostics');
  $stats['log_db_check'] = db_result(db_query("SELECT COUNT(*) FROM {autopilot_logger} WHERE logger = '%s'", $logger));
  db_query("DELETE FROM {autopilot_logger} WHERE logger = '%s'", $logger);
  variable_set('autopilot_system_diagnostics', serialize($stats));
  return;
}
function theme_diagnostics_status_table($form_values) {
  $i = 0;
  $header = array(t('Variable'), t('Status'));
  $rows = array();
  $row = array();
  // TODO Make prettier
  foreach(element_children($form_values) as $key) {
    // Render to the row
    $row = array();
    $row[] = $form_values[$key]['#title'];
    unset($form_values[$key]['#title']);
    $row[] = drupal_render($form_values[$key]);
    $rows[] = $row;
  }
  return theme('table', $header, $rows);
}


function autopilot_setup_overview() {
  $page = '';
  $page .= 'This page will have a description/overview of the current setup,
  number of users, etc. and links to "help" items.';
  
  return $page;
}

/**
 * Implementation of hook_link
 */
function autopilot_link($type, $node = NULL, $teaser = FALSE) {
  $links = array();
  if($node->type == 'autopilot') {  
    $link['href'] = 'autopilot/select/' . $node->nid;
    $link['title'] = t('View AutoPilot');
    $links[] = $link;
  }
  return $links;
}

/**
 * Function selects an autopilot, and applies it to the session
 * programatically.
 */
function _autopilot_select_autopilot() {
  $apid = arg(2);
  _autopilot_get_apid($apid);
  drupal_goto('autopilot');
}

function autopilot_perm() {
  return array('autopilot admin',
               'autopilot database admin',
               'autopilot view',
               'autopilot create autopilot',
               'autopilot edit autopilot',
               'autopilot create buildplan global',
               'autopilot create buildplan user',
               'autopilot build user',
               'autopliot build global');
}

/**
 *Implementation of hook_node_info
 */
function autopilot_node_info() {
  return array(
    'autopilot' => array(
      'name' => t('AutoPilot'),
      'module' => 'autopilot',
      'description' => t('This an AutoPilot which allows you to create a build,
                         and push that build to a target.'),
    ),
  );
}

/**
 *Implementation of hook_block
 */
function autopilot_block($op = 'list', $delta = 0) {
  if($op == 'list') {
    $block[0]['info'] = t('My AutoPilots');
    return $block;
  }
  else {
    if($delta == 0) {
      $block_content = '';
      $nodes = node_load(array('type' => 'autopilot'));

      $block['subject'] = t('My AutoPilots');
      $block['content'] = $block_content ;
    }
    
    return $block;
  }
  
  
}

/**
 *Implementation of hook_node_access
 */
function autopilot_node_access($op, $node) {
  global $user;
  
  if($op == 'create') {
    return user_access('autopilot create autopilot');
  }
  
  if($op == 'update' || $op == 'delete') {
    return user_access('autopilot edit autopilot');
  }
}

/**
 *Implementation of hook_form
 */
function autopilot_form(&$node) {
  $type = node_get_types('type', $node);

  // We need to define form elements for the node's title and body.
  $form['title'] = array(
    '#type' => 'textfield',
    '#title' => t('AutoPilot Name'),
    '#required' => TRUE,
    '#description' => t('A general title for this AutoPilot'),
    '#default_value' => $node->title,
    '#weight' => -5
  );

  $form['body_filter']['body'] = array(
    '#type' => 'textarea',
    '#title' => t('Description'),
    '#default_value' => $node->body,
    '#required' => FALSE,
    '#description' => t('User this area to descripe what this AutoPilot is used for.'),
  );
  $form['body_filter']['filter'] = filter_form($node->format);

  return $form;
}

/**
 * Implementation of hook_insert
 */
function autopilot_insert($node) {
  db_query("INSERT INTO {autopilot}(apid, name, description)
           VALUES(%d, '%s', '%s');", $node->nid, $node->title,
           $node->body);
  return;
}

/**
 * Implementation of hook_delete
 */
function autopilot_delete($node) {
  db_query("DELETE FROM {autopilot} WHERE apid = %d", $node->nid);
  return;
}

/**
 * Implementation of hook_update
 */
function autopilot_update($node) {
  db_query("UPDATE {autopilot}
           SET name = '%s', description = '%s'
           WHERE apid = %d", $node->title, $node->body,
           $node->nid);
  return;
}

/**
 *Implentation of hook_load
 *We want to load ALL information about an autopilot.
 *We may also want to look at options to do 'partial-loads'.
 *e.g. AP_LOAD_FULL, AP_LOAD_BASE, AP_LOAD_LIGHT, etc. Because
 *there could be a LOT of information to load.
 */
function autopilot_load($node, $args = null) {
  _autopilot_init(); // Load the neccessary files and/or classes.
  $info = new stdClass();
  return;
  return $info;
}

/**
 *Implementation of hook_view
 */
function autopilot_view($node, $teaser = FALSE, $page = FALSE) {
  $output = '';
  
  $node = node_prepare($node, $teaser);
  return $node;
}


function autopilot_page($view = 'overview') {
  $page = '';
  $apid = _autopilot_get_apid();
  if(is_numeric($apid)) {
    $autopilot = node_load($apid);  
  }
  else {
    $autopilot = new stdClass();
    $autopilot->title = t('NONE SELECTED');
  }
  $page .= '<div class="info-box">' .
  t('!ap_name is the currently selected autopilot.',
    array('!ap_name' => '<strong>' . $autopilot->title . '</strong>'))
  . drupal_get_form('autopilot_select_autopilot_form')
  . "</div>\n";
  
  // Step out if there is not an APID set.
  if($apid == null) {
    $page .= t('Please select an AutoPilot or create a new one !here', array(
      '!here' => l('here', 'node/add/autopilot')) );
    return $page;
  }
  
  // Lets build the main page
  /**
   * Repository overview
   * The Repository overview aggregates ALL the build plans that are
   * used by this autopilot and shows what changes have been made lately
   * via the log, and what BuildPlan that change will effect.
   */
  
  /**
   * Build Plan Overview
   */
  
  return $page;
}

function autopilot_select_autopilot_form($encapsulate = true) {
  global $user;
  $form = array();

  $ars = db_query("SELECT nid, title FROM {node} WHERE type = '%s'", 'autopilot', $user->uid);
  $aps = array();
  while($row = db_fetch_object($ars)) {
    $aps[$row->nid] = $row->title;
  }
  // Don't build a full form if we don't have any autopilots.
  if(count($aps) == 0) {
    $form['nothing'] = array('#value' => t('No Autopilots found.'));
    return $form;
  }
  
  // Form
  $form['apid'] = array(
    '#type' => 'select',
    '#title' => t('Select an AutoPilot'),
    '#options' => $aps,
  );
  
  $form['submit_ap'] = array(
    '#type' => 'submit',
    '#value' => t('Select AutoPilot'),
  );
  
  if($encapsulate) {
    $form_sub = $form;
    $form = array();
    $form['select_ap_sec'] = array('#type' => 'fieldset',
                  '#title' => t('Select an AutoPilot'),
                  '#collapsed' => true,
                  '#collapsible' => true,
                 );
    foreach($form_sub as $k => $v) {
      $form['select_ap_sec'][$k] = $v;
    }
  }
  
  return $form;
  
}

/**
 * @abstract Implementation of hook_submit for ap form.
 * This sets the apid for the session to work with.
 */
function autopilot_select_autopilot_form_submit($form_id, $form_values) {
  _autopilot_get_apid($form_values['apid']);
  drupal_set_message(t('Working AutoPilot has been changed.'));
  return 'autopilot';
}

function _autopilot_get_autopilot($set_apid = null) {
  static $autopilot;
  if($set_apid != null) {
    $autopilot = new AutoPilot($set_apid);
    _autopilot_get_apid($set_apid);
    AutoPilot::setCurrentAutoPilot($set_apid);
  }
  else if($autopilot == null || $autopilot == '') {
    $autopilot = AutoPilot::setCurrentAutoPilot(_autopilot_get_apid());
  }
  
  return $autopilot;
}
function _autopilot_get_apid($set_apid = null) {
  static $apid;
  if($set_apid != null) {
    $apid = $set_apid;
    $_SESSION['autopilot_apid'] = $apid;
  }
  else if($apid == '') {
    $apid = $_SESSION['autopilot_apid'];
  }
  
  return $apid;
}


// ===========================================================================
/**
 *
 * Misc function and helper functions/classes
 *
 */
// ===========================================================================

/**
 * @abstract Initializes the files needed to
 * work with an AutoPilot.
 *
 *  Default log4php setup
 *  log4php.appender.default = LoggerAppenderDailyFile
    log4php.appender.default.layout = LoggerPatternLayout
    log4php.appender.default.layout.conversionPattern="%d{Y-m-d H:i:s} %-5p %c(%L): %m%n"
    log4php.appender.default.fileName = /tmp/test.log
    
    log4php.appender.stdout = LoggerAppenderEcho
    log4php.appender.stdout.layout = LoggerPatternLayout
    log4php.appender.stdout.layout.conversionPattern="%d{Y-m-d H:i:s} %-5p %c: %m at line %L%n<br/>"
    
    log4php.rootLogger = DEBUG, default
    
    
    ;log4php.logger.ActionResolver=ERROR
    ;log4php.logger.ArtifactResolver=ERROR
 *
 * @return void
 */
function _autopilot_init() {
  static $loaded;
  // Check for the security key
  
  if($loaded === true) {
    return;
  }
  // TODO: You need to do a PEAR check here!!
  _autopilot_setup_validation();

  define('LOG4PHP_CONFIGURATION', drupal_get_path('module', 'autopilot') . '/log4php/DrupalLoggerConfig.xml');
  define('LOG4PHP_DIR', drupal_get_path('module', 'autopilot') . '/log4php');
  require_once( LOG4PHP_DIR . '/LoggerManager.php' );
  // Look in the includes folder for files
  // that we MUST include. These will have
  // the extension .inc.
  $dir_path = drupal_get_path('module', 'autopilot') . '/includes';
  // Interfaces first
  _autopilot_include_files($dir_path, false, 'Interface');
  // All others next
  _autopilot_include_files($dir_path);
  // File the hook
  // TODO
  // Do we need this?
  module_invoke_all('autopilot_classload');

  // Media init
  _autopilot_media_init();
  $loaded = true;
  return;
}

function _autopilot_init_js() {
  drupal_add_js(drupal_get_path('module', 'autopilot') . '/autopilot.js', 'module','header', FALSE, FALSE);
  return;
}

function _autopilot_media_init() {
  // Add the CSS
  $module_path = drupal_get_path('module', 'autopilot');
  drupal_add_css("$module_path/media/autopilot.css");
  return;
}

function _autopilot_setup_validation() {
  // Check for the key
  $msg_args = array();
  $setup_ok = true;
  // check for pear dependencies
  //
  include_once('DB.php');
  if (!class_exists('DB')) {
    $admin_msg = t('AutoPilot requires the PEAR DB library.  Either it is not installed or PEAR is not in your include path.');
    $setup_ok = false;
  }

  if(variable_get('autopilot_cipher_key', null) == null) {
    $setup_ok = false;
    $admin_msg = t('The Autopilot cipher key has not been set. Please set it here.');
  }
  // Check for mcrypt
  if(!function_exists('mcrypt_encrypt')) {
    $setup_ok = false;
    $admin_msg = t('The mcrypt php library is required for Autopilot.');
  }
  // Check for SSH2
  
  
  if($setup_ok == false) {
    drupal_set_message(t('There is a problem with your autopilot setup. Please contact your adminitrator.'), 'error');
    if(arg(0) == 'admin') {
      drupal_set_message($admin_msg);      
    }
    watchdog('autopilot', $admin_msg, WATCHDOG_ERROR);
    return $setup_ok;
  }
  return true;
}

function _autopilot_include_files($dir, $absolute = false, $filter = null) {
  $osinfo = _autopilot_detect_os();
  $sep = $osinfo['path_sep'];
  
  // Handles .svn and other misc files that we don't want to load
  if(strpos(basename($dir),'.') === 0) {
    return;
  }
  
  if(!$absolute) {
    $cwd = getcwd();
    $dir_path = $cwd . '/' . $dir;
    $dir_path = str_replace('/', $sep, $dir_path);
  }
  else {
    $dir_path = str_replace('/', $sep, $dir);
  }

  $files = @scandir($dir_path);
  if(!$files) {
    return;
  }
  
  foreach($files as $k => $filename) {
    $filter_out = false;
    $current_path = ($absolute) ? "$dir_path/$filename" : "$cwd/$dir/$filename";
    $current_path = str_replace('/', $sep, $current_path);
    
    if($filename != '.' && $filename != '..' && substr($filename, 0, 1) != '.') {
      if($filter !== null) {
        if(!ereg($filter, basename($filename))) {
          $filter_out = true;
        }
      }
      
      if( !is_dir($current_path) && !$filter_out) {
        include_once($current_path);
      }
      else {
        _autopilot_include_files($current_path, true, $filter);
      }
    }
    
  }
  return;
}

function _autopilot_detect_os() {
  static $ostype;
  if($ostype != '') {
    return $ostype;
  }
  
  $winos = eregi("windows", strtolower(php_uname()));
  if($winos) {
    $ostype['type'] = AUTOPILOT_OSTYPE_WINDOWS;
    $ostype['path_sep'] = '\\';
  }
  else {
    $ostype['type'] = AUTOPILOT_OSTYPE_LINUX;
    $ostype['path_sep'] = '/';
  }
  return $ostype;
}

function _autopilot_sanitize_path($path) {
  if( _autopilot_detect_os == AUTOPILOT_OSTYPE_WINDOWS ) {
    return str_replace('/', '\\', $path);
  }
  else {
    return str_replace('\\','/', $path);
  }
}

function _autopilot_get_owernships($type = 'full') {
  $os = array();
  $os[AUTOPILOT_OWNERSHIP_NORMAL] = t('Normal');
  $os[AUTOPILOT_OWNERSHIP_GLOBAL] = t('Global');
  $os[AUTOPILOT_OWNERSHIP_TEMPLATE] = t('Template');
  
  return $os;
}

function autopilot_exit() {
  @LoggerManager::shutdown();
  
}


/**
 * Modified from http://us3.php.net/time
 */
function _autopilot_time_diff($time, $opt = array()) {
    if($time == 0) {
      return t('N/A');
    }
    // The default values
    $defOptions = array(
        'to' => 0,
        'parts' => 1,
        'precision' => 'second',
        'distance' => TRUE,
        'separator' => ', '
    );
    $opt = array_merge($defOptions, $opt);
    // Default to current time if no to point is given
    (!$opt['to']) && ($opt['to'] = time());
    // Init an empty string
    $str = '';
    // To or From computation
    $diff = ($opt['to'] > $time) ? $opt['to']-$time : $time-$opt['to'];
    // An array of label => periods of seconds;
    $periods = array(
        'decade' => 315569260,
        'year' => 31556926,
        'month' => 2629744,
        'week' => 604800,
        'day' => 86400,
        'hour' => 3600,
        'minute' => 60,
        'second' => 1
    );
    // Round to precision
    if ($opt['precision'] != 'second')
        $diff = round(($diff/$periods[$opt['precision']])) * $periods[$opt['precision']];
    // Report the value is 'less than 1 ' precision period away
    (0 == $diff) && ($str = 'less than 1 '.$opt['precision']);
    // Loop over each period
    foreach ($periods as $label => $value) {
        // Stitch together the time difference string
        (($x=floor($diff/$value))&&$opt['parts']--) && $str.=($str?$opt['separator']:'').($x.' '.$label.($x>1?'s':''));
        // Stop processing if no more parts are going to be reported.
        if ($opt['parts'] == 0 || $label == $opt['precision']) break;
        // Get ready for the next pass
        $diff -= $x*$value;
    }
    $opt['distance'] && $str.=($str&&$opt['to']>$time)?' ago':' away';
    return $str;
}

// ===========================================================================
/**
 *
 * Autopilot XML-RPC Section
 *
 */
// ===========================================================================
function _autopilot_ajax_menu() {
  $items = array();
  $items[] = array(
    'path' => 'autopilot/jquery/get_buildrun_log',
    'type' => MENU_CALLBACK,
    'callback' => '_autopilot_get_buildrun_logs',
    'access' => TRUE,
    'callback arguments' => array($_REQUEST),
  );
  $items[] = array(
    'path' => 'autopilot/jquery/buildrun_init',
    'type' => MENU_CALLBACK,
    'callback' => '_autopilot_buildrun_init',
    'access' => TRUE,
    'callback arguments' => array($_REQUEST),
  );
  $items[] = array(
    'path' => 'autopilot/jquery/buildrun_start',
    'type' => MENU_CALLBACK,
    'access' => TRUE,
    'callback' => '_autopilot_buildrun_start_run',
    'callback arguments' => array($_REQUEST),
  );
  return $items;
}

/**
 * Returns a portion of the buildrun log
 *
 * @param $buildrun_id The id of the BuildRun
 * @param $log_id The id of the log to return
 * @param $log_batch The maxinum number of logs to return
 *
 * @return mixed An array of log entries
 */
function _autopilot_get_buildrun_logs($data) {
    if($data['run_id'] == '') {
      return;
    }
    
    $log_page = $data['log_id'];
    $log_length = isset($data['log_length']) ? $data['log_length'] : null;
    $info = new stdClass();
    
    $run = BuildRun::buildRunFactory($run_id);
    $info->logs = $run->getLogs($log_page, $log_length);
    //$info = drupal_to_js($info);
    //error_log("Sending back: " . print_r($info,1));
    ob_end_clean();
    print drupal_to_js($info);
    exit();
}

function _autopilot_get_buildrun_info($data) {
    if($data['run_id'] == '') {
      return;
    }
    $log_page = $data['log_id'];
    $log_length = isset($data['log_length']) ? $data['log_length'] : 10;
    $info = new stdClass();
    $run = new BuildRun();
    //$run = BuildRun::buildRunFactory($run_id);
    $info->logs = $run->getLogs($log_page, $log_length);
    //$info = drupal_to_js($info);
    ob_end_clean();
    echo $info->view;
    exit();
}

/**
 * This is used to setup/prepare a new
 * build run.
 *
 * @return int A new buildrun_id
 */
function _autopilot_buildrun_init($data) {
  
  $bpid = $data['bpid'];
  
  $bp = new SimpleBuildPlan($bpid);
  
  # Set the code revisions
  $bp->setCodeRevision($data['code_rev']);
  $bp->setSQLRevision($data['sql_rev']);
  
  $run = BuildRun::buildRunFactory($bp);
  $run->init();
  $run->update();
  $id = $run->getID();
  
  $json = new stdClass();
  $json->run_id = $id;
  
  
  unset($run);
  print drupal_to_js($json);
  exit();
}

/**
 * This starts a build run. Now the build run is transmitted
 * as a serialized array of the information needed
 * to make the run. We need to create a build BuidPlan
 * object from this information and run the build.
 *
 * @return void
 */
function _autopilot_buildrun_start_run($data) {
  set_time_limit(300);
  $run_id = $data['run_id'];

  $json = new stdClass();
  if(!is_numeric($run_id)) {
    $json->errors = true;
    $json->error_msg = "Invalid run id.";
    print drupal_to_js($json);
    exit();
  }
  $json = new stdClass();
  
  $bp = new SimpleBuildPlan($data['bpid']);
  # Set the code revisions
  $bp->setCodeRevision($data['code_rev']);
  $bp->setSQLRevision($data['sql_rev']);
  
  if($run_id == '') {
    $json->error = true;
    $json->error_msg = t('Invalid run id given.');
    return drupal_to_js($json);
  }
  
  $run = new BuildRun($run_id);
  if(!is_a($run->getBuildPlan(), 'BuildPlan')) {
    $run = null;
  }
  
  if(!$run) {
    $json->errors = true;
    $json->error_msg = "Unable to locate build.";
    print drupal_to_js($json);
    exit();
  }
  $run->setBuildPlan($bp);
  $run->runBuild();
  $json->errors = false;
  $json->error_msg = "Run Complete";
  print drupal_to_js($json);
  exit();
}

/*******************************
 * Database Section
 */
/**
 * @author Earnest Berry III <earnest at workhabit dot com>
 * Generates a page showing the databases that are associated with
 * this autopilot.
 */
function autopilot_database_overview() {
  $page = "";
  $page .= '<h2>' . t('This section allows one to do simple database maintianance tasks.') . '</h2>';
  $page .= '<p>' . t('Please select one of the following database options:') . '</p>';
  $links[] = array('href' => 'autopilot/database/tx', 'title' => t('Transfer Databases'), 'name' => 'he');
  $page .= theme('links', $links);
  return $page;
}

/**
 * Database Transfer Staction
 */
/**
 * @abstract Pushes database. User can select a
 * LIVE source database, and then have that database
 * pushed into the repository location of their choice.
 */
function autopilot_database_transfer_form() {
  _autopilot_init_js();
  $form = array();
  
  # Source Sectoin
  $form['source_info'] = array(
    '#type' => 'fieldset',
    '#title' => t('Source Inforamtion'),
    '#collapsible' => true,
    '#collapsed' => false,
  );
  
  /**
   * Get a listing of the databases from the different build plans
   * for this autopilot
   */
  $rs = db_query("SELECT apt.tid
    FROM {ap_target} apt
    INNER JOIN {ap_targets} apts ON (apt.tid = apts.tid) 
    WHERE apid = %d", _autopilot_get_apid());
  # Grab the tids
  $dbs = array();
  $avail_dbs = array('0' => '-');
  while($row = db_fetch_object($rs)) {
    $t =  Target::targetFactory($row->tid);
    $avail_dbs[$row->tid] = $t->getName();
    $dbs[] = $t;
  }
  
  $form['source_info']['source_tid'] = array(
    '#title' => t('Source Database'),
    '#description'