modules/sitedoc/sitedoc.module

<?php
// $Id: sitedoc.module,v 1.47 2008/03/10 04:13:31 nancyw Exp $

/**
 * Implementation of hook_help().
 */
function sitedoc_help($path, $arg=array()) {
  switch ($path) {
    case 'admin/help#sitedoc':
      $output = '<p>'. t('The sitedoc module allows a site admin to gather extensive information about their site. It may be printed or archived for configuration/change management purposes. It may also be used to add "fancy" and up-to-date information to other site documentation, such as a succession plan.') .'</p>';
      break;
      
    case 'admin/settings/sitedoc/archive':
      $output = '<p>'. t('The Site Documentation module may be run via Cron and the output HTML file archived to disk for future review. The options chosen on the main settings page will govern the data collected and reported.') .'</p>';
      break;
      
    case 'admin/settings/sitedoc':
      $output = '<p>'. t("The Site Documentation module's data collection and output is governed by these settings. Indented options are in effect only if the parent item is selected.") .'</p>';
  }
  return $output;
}

/**
 * Implementation of hook_perm().
 */
function sitedoc_perm() {
  return array('view site documentation');
}

/**
 * Implementation of hook_menu().
 *
 * Add a menu item to the Administer >> Site building menu for displaying the sitedoc.
 * Add a menu item to the Administer >> Site configuration menu for the sitedoc settings.
 * Add a menu callback item to the Administer >> Site building menu for displaying node access lists.
 * Add a menu callback item to the menu for displaying taxonomy term counts.
 * Add a menu callback item to the menu for displaying phpinfo.
 */
function sitedoc_menu($may_cache) {
  $items = array();

  if ($may_cache) {
    drupal_add_css(drupal_get_path('module', 'sitedoc') .'/sitedoc.css');
    $items[] = array(
      'path' => 'admin/build/sitedoc',
      'title' => t('Site documentation'),
      'description' => t('Show site documentation'),
      'callback' => 'sitedoc_list',
      'access' => user_access('view site documentation'),
      );
    $items[] = array(
      'path' => 'admin/settings/sitedoc',
      'title' => t('Site documentation'),
      'description' => t('Set how Site Documentation works'),
      'callback' => 'sitedoc_settings_page',
      'access' => user_access('view site documentation'),
      );  
    $items[] = array(
      'path' => 'admin/settings/sitedoc/report',
      'title' => t('Report'),
      'description' => t('Report settings'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('sitedoc_settings_form'),
      'access' => user_access('view site documentation'),
      'type' => MENU_DEFAULT_LOCAL_TASK,
      );  
    $items[] = array(
      'path' => 'admin/settings/sitedoc/archive',
      'title' => t('Archive'),
      'access' => user_access('view site documentation'),
      'callback' => 'drupal_get_form',
      'callback arguments' => array('sitedoc_archive_form'),
      'description' => t('Set how Site Documentation archive works'),
      'weight' => 2,
      'type' => MENU_LOCAL_TASK,
    );
  }
  else {
    $items[] = array(
      'path' => 'admin/build/sitedoc_node_access_view',
      'title' => t('Site documentation node access list'),
      'description' => t('Do not use'),
      'callback' => 'sitedoc_node_access_view',
      'callback arguments' => array(arg(3)),
      'access' => user_access('view site documentation'),
      'type' => MENU_CALLBACK,
      );
    $items[] = array('path' => 'sitedoc/vocabulary',
      'title' => t('Site Documentation Term Count by Type'),
      'callback' => 'sitedoc_term_count_by_type',
//      'callback arguments' => array(arg(2)),
      'access' => user_access('access content'),
      'type' => MENU_CALLBACK
      );
    $items[] = array('path' => 'sitedoc/phpinfo',
      'title' => t('Site Documentation PHP Information'),
      'callback' => 'sitedoc_phpinfo',
      'access' => user_access('view site documentation'),
      'type' => MENU_CALLBACK
      );
    $items[] = array('path' => 'sitedoc/table',
      'title' => t('Table Contents'),
      'callback' => 'sitedoc_show_table',
      'access' => user_access('access content'),
      'type' => MENU_CALLBACK
      );
  }
  return $items; 
}

/**
 * Implementation of hook_enable().
 *
 * Set the default parameters. This is an easy way to reset the deaults - disable and re-enable.
 *
 *  Parameters: None.
 *
 *  Return: None.
 */
function sitedoc_enable() {
  $sitedoc_settings = array(
    'drupal_section' => TRUE,
    'kill_cron' => 0,                     /* kill long-running cron */
    'table_section' => TRUE,
    'show_indexes' => FALSE,              /* use SHOW INDEX on the tables */
    'optimize_tables' => FALSE,           /* use OPTIMIZE to release overhead */
    'sequences_section' => FALSE,         /* not on because not much interest */
    'node_section' => FALSE,              /* not on because of expense */
    'include_comment_count' => FALSE,     /* comment count on nodes */
    'include_node_access' => FALSE,       /* node access summary */
    'node_show_size' => 99999,            /* show nodes exceeding x KB */
    'node_max_size' => 50,                /* warn if nodes exceeding x KB */
    'module_section' => TRUE,
    'module_suppress' => FALSE,           /* exclude disabled modules */
    'module_sort_order' => 0,             /* package, project, module */
    'content_section' => TRUE,
    'vocabulary_section' => TRUE,
    'orphan_term_node' => FALSE,          /* not on to allow control */
    'delete_orphan_term_nodes' => FALSE,  /* do not delete orphans  */
    'theme_section' => TRUE,
    'variables_section' => FALSE,         /* not on because of expense */
    'block_section' => TRUE,
    'block_warn' => TRUE,                 /* warn on missing theme */
    'block_delete' => FALSE,              /* delete those orphan blocks */
    'roles_section' => TRUE,
    'role_users' => TRUE,                 /* list users in roles */
    'role_perms_list' => FALSE,           /* do role permissions as stream */
    'contacts_section' => TRUE,
    'profile_fields_section' => FALSE,    /* not on because of interest */
    'url_alias_section' => FALSE,         /* not on because of expense */
    'input_format_section' => FALSE,      /* not on because probably not wanted */
    // Archive options
    'archive_frequency' => 0,             /* don't run */
    'archive_directory' => 'sitedoc',     /* archive directory within file setting */ 
    );
  variable_set('sitedoc_settings', $sitedoc_settings);
}

/********************************/
/**   Main settings function   **/
/********************************/
function sitedoc_settings_page() {
  return drupal_get_form('sitedoc_settings_form');
}  

function sitedoc_settings_form() {
  drupal_add_css(drupal_get_path('module', 'sitedoc') .'/sitedoc.css');
  $sitedoc_settings = variable_get('sitedoc_settings', array());

// Sections Fieldset 
  $form['sections'] = array(
    '#type' => 'fieldset', 
    '#title' => t('Show Sections'), 
    '#weight' => -5,
    '#collapsible' => FALSE,
    '#collapsed' => FALSE,
    '#prefix' => '<div class="sitedoc_sections_block">',
    '#suffix' => '',
  );

  $form['sections']['drupal_section'] = array(
    '#type' => 'checkbox',
    '#title' => t('Include Basic Drupal information?'),
    '#prefix' => '<div class="sitedoc_sections">',
//    '#suffix' => '</div>',
    '#default_value' => $sitedoc_settings['drupal_section'],
  );

  $kill_time = drupal_map_assoc(array(0, 1800, 3600, 7200, 10800, 14400, 18000, 21600, 32400, 43200, 86400, 172800), 'format_interval');
  $kill_time['0'] = t('Never');
  $form['sections']['kill_cron'] = array(
    '#type' => 'select',
    '#options' => $kill_time,
    '#title' => t('Delete Cron variables after'),
    '#prefix' => '<div class="sitedoc_options">',
    '#suffix' => '</div></div>',
    '#default_value' => $sitedoc_settings['kill_cron'],
  ); 

  $form['sections']['table_section'] = array(
    '#type' => 'checkbox',
    '#title' => t('Include Table Summary?'),
    '#prefix' => '<div class="sitedoc_sections">',
//    '#suffix' => '</div>',
    '#default_value' => $sitedoc_settings['table_section'],
  );

  $form['sections']['show_indexes'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show indexes?'),
    '#prefix' => '<div class="sitedoc_options">',
    '#suffix' => '</div>',
    '#default_value' => $sitedoc_settings['show_indexes'],
  );

  $form['sections']['optimize_tables'] = array(
    '#type' => 'checkbox',
    '#title' => t('Release overhead?'),
    '#prefix' => '<div class="sitedoc_options">',
    '#suffix' => '</div></div>',
    '#description' => t('(SQL intensive - uses OPTIMIZE)'),
    '#default_value' => $sitedoc_settings['optimize_tables'],
  );

// Postgres databases don't use the sequences table (and D6 probably won't either)
  if ($GLOBALS['db_type'] == 'postgres') {
    // Force it off and skip the form field
    $sitedoc_settings['sequences_section'] = FALSE;
  }
  else {  
    $form['sections']['sequences_section'] = array(
      '#type' => 'checkbox',
      '#title' => t('Include Sequences Summary?'),
      '#prefix' => '<div class="sitedoc_sections">',
      '#suffix' => '</div>',
      '#default_value' => $sitedoc_settings['sequences_section'],
      );
  }

  $form['sections']['node_section'] = array(
    '#type' => 'checkbox',
    '#title' => t('Include Node Summary?'),
    '#prefix' => '<div class="sitedoc_sections">',
//    '#suffix' => '</div>',
    '#description' => t('(SQL intensive)'),
    '#default_value' => $sitedoc_settings['node_section'],
    );

  $form['sections']['node_show_size'] = array(
    '#type' => 'textfield',
    '#title' => t('Show nodes exceeding (KB)'),
    '#prefix' => '<div class="sitedoc_options">',
    '#suffix' => '</div>',
    '#default_value' => $sitedoc_settings['node_show_size'],
    '#size' => 8,
    '#maxlength' => 7,
    );

  $form['sections']['node_max_size'] = array(
    '#type' => 'textfield',
    '#title' => t('Warn if nodes exceed (KB)'),
    '#prefix' => '<div class="sitedoc_options">',
    '#suffix' => '</div>',
    '#default_value' => $sitedoc_settings['node_max_size'],
    '#size' => 8,
    '#maxlength' => 7,
    );

  $form['sections']['include_node_access'] = array(
    '#type' => 'checkbox',
    '#title' => t('Include node access summary?'),
    '#prefix' => '<div class="sitedoc_options">',
    '#suffix' => '</div>',
    '#default_value' => $sitedoc_settings['include_node_access'],
    );

  $form['sections']['include_comment_count'] = array(
    '#type' => 'checkbox',
    '#title' => t('Include comment count on nodes?'),
    '#prefix' => '<div class="sitedoc_options">',
    '#suffix' => '</div></div>',
    '#default_value' => $sitedoc_settings['include_comment_count'],
    );

  $form['sections']['variables_section'] = array(
    '#type' => 'checkbox',
    '#title' => t('Include System Variables?'),
    '#prefix' => '<div class="sitedoc_sections">',
    '#suffix' => '</div>',
    '#description' => t('(CPU intensive)'),
    '#default_value' => $sitedoc_settings['variables_section'],
    );

  $form['sections']['module_section'] = array(
    '#type' => 'checkbox',
    '#title' => t('Include Module summary?'),
    '#prefix' => '<div class="sitedoc_sections">',
//    '#suffix' => '</div>',
    '#default_value' => $sitedoc_settings['module_section'],
    );

  $form['sections']['module_suppress'] = array(
    '#type' => 'checkbox',
    '#title' => t('Exclude disabled modules?'),
    '#prefix' => '<div class="sitedoc_options">',
    '#suffix' => '</div>',
    '#default_value' => $sitedoc_settings['module_suppress'],
    );

  $module_sort_order = array(
    0 => 'package, project, module',
    1 => 'path, module',
    );

  $form['sections']['module_sort_order'] = array(
    '#type' => 'radios',
    '#title' => t('List sort order'),
    '#options' => $module_sort_order,
    '#prefix' => '<div class="sitedoc_options">',
    '#suffix' => '</div></div>',
    '#default_value' => $sitedoc_settings['module_sort_order'],
    );

  $form['sections']['content_section'] = array(
    '#type' => 'checkbox',
    '#title' => t('Include Content Type summary?'),
    '#prefix' => '<div class="sitedoc_sections">',
    '#suffix' => '</div>',
    '#default_value' => $sitedoc_settings['content_section'],
    );

  if (module_exists('taxonomy')) {
    $form['sections']['vocabulary_section'] = array(
      '#type' => 'checkbox',
      '#title' => t('Include Vocabulary summary?'),
      '#prefix' => '<div class="sitedoc_sections">',
      '#description' => t('(may be CPU and SQL intensive)'),
      '#default_value' => $sitedoc_settings['vocabulary_section'],
      );

  $form['sections']['orphan_term_node'] = array(
    '#type' => 'checkbox',
    '#title' => t('Check for orphan Term_nodes?'),
    '#prefix' => '<div class="sitedoc_options">',
    '#suffix' => '</div>',
    '#description' => t('(may be SQL intensive)'),
    '#default_value' => $sitedoc_settings['orphan_term_node'],
    );

  $form['sections']['delete_orphan_term_nodes'] = array(
    '#type' => 'checkbox',
    '#title' => t('Delete orphan term nodes?'),
    '#prefix' => '<div class="sitedoc_options">',
    '#suffix' => '</div></div>',
    '#default_value' => $sitedoc_settings['delete_orphan_term_nodes'],
    );
  }  /* end if taxo exists */

  $form['sections']['theme_section'] = array(
    '#type' => 'checkbox',
    '#title' => t('Include Themes and Theme Engines?'),
    '#prefix' => '<div class="sitedoc_sections">',
    '#suffix' => '</div>',
    '#default_value' => $sitedoc_settings['theme_section'],
    );

  $form['sections']['block_section'] = array(
    '#type' => 'checkbox',
    '#title' => t('Include Blocks and Boxes?'),
    '#prefix' => '<div class="sitedoc_sections">',
    '#default_value' => $sitedoc_settings['block_section'],
    );

  $form['sections']['block_warn'] = array(
    '#type' => 'checkbox',
    '#title' => t('Warn on missing theme for blocks?'),
    '#prefix' => '<div class="sitedoc_options">',
    '#suffix' => '</div>',
    '#description' => t('This allows the module to display a warning message if a block exists for a missing theme.'),
    '#default_value' => $sitedoc_settings['block_warn'],
    );

  $form['sections']['block_delete'] = array(
    '#type' => 'checkbox',
    '#title' => t('Delete the orphan blocks?'),
    '#prefix' => '<div class="sitedoc_options">',
    '#suffix' => '</div></div>',
    '#description' => t('Delete the blocks with a missing theme.'),
    '#default_value' => $sitedoc_settings['block_delete'],
    );

  $form['sections']['roles_section'] = array(
    '#type' => 'checkbox',
    '#title' => t('Include Roles and Permissions?'),
    '#prefix' => '<div class="sitedoc_sections">',
    '#default_value' => $sitedoc_settings['roles_section'],
    );

  $form['sections']['role_users'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show list of users for each role?'),
    '#prefix' => '<div class="sitedoc_options">',
    '#suffix' => '</div>',
    '#description' => t('Displays the list of users assigned the role.'),
    '#default_value' => $sitedoc_settings['role_users'],
    );

  $form['sections']['role_perms_list'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show role permissions as a list?'),
    '#prefix' => '<div class="sitedoc_options">',
    '#suffix' => '</div></div>',
    '#description' => t('If not chosen, the roles will be shown as a stream.'),
    '#default_value' => $sitedoc_settings['role_perms_list'],
    );

  if (module_exists('contact')) {
    $form['sections']['contacts_section'] = array(
      '#type' => 'checkbox',
      '#title' => t('Include Contacts?'),
      '#prefix' => '<div class="sitedoc_sections">',
      '#suffix' => '</div>',
      '#default_value' => $sitedoc_settings['contacts_section'],
      );
  }

  if (module_exists('profile')) {
    $form['sections']['profile_fields_section'] = array(
      '#type' => 'checkbox',
      '#title' => t('Include Profile Fields?'),
      '#prefix' => '<div class="sitedoc_sections">',
      '#suffix' => '</div>',
      '#default_value' => $sitedoc_settings['profile_fields_section'],
      );
  }

  if (module_exists('path')) {
    $form['sections']['url_alias_section'] = array(
      '#type' => 'checkbox',
      '#title' => t('Include URL Aliases?'),
      '#prefix' => '<div class="sitedoc_sections">',
      '#suffix' => '</div>',
      '#description' => t('(SQL intensive)'),
      '#default_value' => $sitedoc_settings['url_alias_section'],
      );
  }

  $form['sections']['input_format_section'] = array(
    '#type' => 'checkbox',
    '#title' => t('Include Input Formats and Filters?'),
    '#prefix' => '<div class="sitedoc_sections">',
    '#suffix' => '</div>',
    '#default_value' => $sitedoc_settings['input_format_section'],
    );

  // Update Button
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save configuration'),
    '#weight' => 5,
    '#prefix' => '</div><div class="clear-block"></div>'
    );

  return $form;
}

/**
 * Save the settings values.
 */
function sitedoc_settings_form_submit($form_id, $form_values) {
// update the settings array and save it
  $settings = variable_get('sitedoc_settings', array());

  $settings['drupal_section'] = $form_values['drupal_section'];
  $settings['kill_cron'] = $form_values['kill_cron'];
  $settings['table_section'] = $form_values['table_section'];
  $settings['show_indexes'] = $form_values['show_indexes'];
  $settings['optimize_tables'] = $form_values['optimize_tables'];
  $settings['sequences_section'] = $form_values['sequences_section'];
  $settings['node_section'] = $form_values['node_section'];
  $settings['include_comment_count'] = $form_values['include_comment_count'];
  $settings['include_node_access'] = $form_values['include_node_access'];
  $settings['node_show_size'] = $form_values['node_show_size'];
  $settings['node_max_size'] = $form_values['node_max_size'];
  $settings['module_section'] = $form_values['module_section'];
  $settings['module_suppress'] = $form_values['module_suppress'];
  $settings['module_sort_order'] = $form_values['module_sort_order'];
  $settings['content_section'] = $form_values['content_section'];
  $settings['vocabulary_section'] = $form_values['vocabulary_section'];
  $settings['orphan_term_node'] = $form_values['orphan_term_node'];
  $settings['delete_orphan_term_nodes'] = $form_values['delete_orphan_term_nodes'];
  $settings['theme_section'] = $form_values['theme_section'];
  $settings['variables_section'] = $form_values['variables_section'];
  $settings['block_section'] = $form_values['block_section'];
  $settings['block_warn'] = $form_values['block_warn'];
  $settings['block_delete'] = $form_values['block_delete'];
  $settings['roles_section'] = $form_values['roles_section'];
  $settings['role_users'] = $form_values['role_users'];
  $settings['role_perms_list'] = $form_values['role_perms_list'];
  $settings['contacts_section'] = $form_values['contacts_section'];
  $settings['profile_fields_section'] = $form_values['profile_fields_section'];
  $settings['url_alias_section'] = $form_values['url_alias_section'];
  $settings['input_format_section'] = $form_values['input_format_section'];

  variable_set('sitedoc_settings', $settings);

  drupal_set_message(t('Configuration has been updated. ') . l(t('Run now'), 'admin/build/sitedoc'), 'status'); 
}

function sitedoc_archive_form($form_values=NULL) {
  drupal_add_css(drupal_get_path('module', 'sitedoc') .'/sitedoc.css');
  $sitedoc_settings = variable_get('sitedoc_settings', array());

  $save_time = drupal_map_assoc(array(0, 3600, 7200, 14400, 21600, 43200, 86400, 172800, 259200, 604800), 'format_interval');
  $save_time['0'] = t('Never');
  $save_time['999999'] = t('Always');

  $form['archive_frequency'] = array(
    '#type' => 'select',
    '#options' => $save_time,
    '#title' => t('Archive frequency'),
    '#prefix' => '<div class="sitedoc_archive">',
    '#suffix' => '</div>',
    '#default_value' => $sitedoc_settings['archive_frequency'],
    '#description' => t('The Site Documentation module will run at the next scheduled Cron run after this period has elapsed. A zero value suppresses creation of an archive. "Always" means a file will be created every time Cron runs.'),
  );

  $form['archive_directory'] = array(
    '#type' => 'textfield',
    '#title' => t('Archive directory'),
    '#prefix' => '<div class="sitedoc_archive">',
    '#suffix' => '</div>',
    '#default_value' => $sitedoc_settings['archive_directory'],
    '#description' => t('This is directory within \'!filepath\' where the Site Documentation module will place the archive file. The current date will be appended to the file name.', array('!filepath' => variable_get('file_directory_path', 'files'))),
  );

// Add the Buttons
  $form['save'] = array(
    '#type' => 'submit',
    '#value' => t('Save configuration'),
    '#weight' => 5,
    '#prefix' => '</div><div class="clear-block"></div>'
  );

  // If $form_values exists, then we've been here before (submitted), so now add a "run cron" button.
  if (isset($form_values)) {
    $form['cron'] = array(
      '#type' => 'submit',
      '#value' => t('Run Cron Now'),
      '#weight' => 6,
    );
  }

  // These allow us to add on the Cron button.
  $form['#multistep'] = TRUE;
  $form['#redirect'] = FALSE;

  return $form;
}

/**
 * Validate the submission.
 */
function sitedoc_archive_form_validate($form_id, $form_values) {
  $archive_path = variable_get('file_directory_path', 'files') .'/'. $form_values['archive_directory'];
  if (!file_check_directory($archive_path, TRUE, 'archive_directory')) {
    form_set_error('archive_directory', t('The archive path could not be found or could not be created.'));
  }  // end path not found 
}

/**
 * Save the settings values.
 */
function sitedoc_archive_form_submit($form_id, $form_values) {
  switch ($form_values['op']) {
    case t('Run Cron Now'):
      drupal_goto('admin/logs/status/run-cron');
      break;

    case t('Save configuration'):
      // update the settings array and save it
      $sitedoc_settings = variable_get('sitedoc_settings', array());
      $sitedoc_settings['archive_frequency'] = $form_values['archive_frequency'];
      $sitedoc_settings['archive_directory'] = $form_values['archive_directory'];

      variable_set('sitedoc_settings', $sitedoc_settings);

      drupal_set_message(t('Configuration has been updated. ') . l(t('Run now'), 'admin/build/sitedoc'), 'status');
  }
}

/***********************/
/**   main function   **/
/***********************/
function sitedoc_list() {
  // Retrieve the settings and check if they have been settings page.
  $sitedoc_settings = variable_get('sitedoc_settings', array());
  if ($sitedoc_settings == array()) {
    return t('It appears that you have not been to "administer >> site configuration" to set the Site Documentation settings. ') . l(t('Click here to do so.'), 'admin/settings/sitedoc');
  }

  // Insert a wrapper division and a link back to the settings page. 
  $output = '<div class="site-documentation">'. l(t('Change settings.'), 'admin/settings/sitedoc') .'<br/><br/>';

  // Get basic Drupal info.
  if ($sitedoc_settings['drupal_section']) {
    $output .= '<div class="sitedoc_drupal">';
    $fieldset = array(
      '#title' => t('Drupal Section'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#value' => sitedoc_drupal($sitedoc_settings['kill_cron']),
      );  
    $output .=  theme('fieldset', $fieldset);
    $output .= "</div>\n";
  }

  // Get database info.
  if ($sitedoc_settings['table_section']) {
    $output .= '<div class="sitedoc_database_overview">';
    $fieldset = array(
      '#title' => t('Table Section'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#value' => sitedoc_database_overview($sitedoc_settings['optimize_tables'], $sitedoc_settings['show_indexes']),
      );  
    $output .=  theme('fieldset', $fieldset);
    $output .= "</div>\n";
  }
 
   // Get info from the sequences table (last used item number).
  if ($sitedoc_settings['sequences_section']) {
    $output .= '<div class="sitedoc_sequences">';
    $fieldset = array(
      '#title' => t('Sequences Section'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#value' => sitedoc_sequences(),
      );  
    $output .=  theme('fieldset', $fieldset);
    $output .= "</div>\n";
  }
 
  // Get summary of all nodes (this is VERY expensive!).
  if ($sitedoc_settings['node_section']) {
    $output .= '<div class="sitedoc_node_summary">';
    $fieldset = array(
      '#title' => t('Node Summary'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#value' => sitedoc_node_summary($sitedoc_settings['include_comment_count'], $sitedoc_settings['node_show_size'], $sitedoc_settings['node_max_size']),
      );
    $output .=  theme('fieldset', $fieldset);
    $output .= "</div>\n";
 
    // Get node access summary (this is expensive!).
    // Runs only if the node summary section is selected.
    if ($sitedoc_settings['include_node_access']) {
      $output .= '<div class="sitedoc_node_access">';
      $fieldset = array(
        '#title' => t('Node Access'),
        '#collapsible' => TRUE,
        '#collapsed' => FALSE,
        '#value' => sitedoc_node_access(),
      );  
      $output .=  theme('fieldset', $fieldset);
      $output .= "</div>\n";
    } // end access summary 
  }  // end node summary 

  // Get content type info from node module along with workflow options from system variables.
  if ($sitedoc_settings['content_section']) {
    $output .= '<div class="sitedoc_content_types">';
    $fieldset = array(
      '#title' => t('Content Types'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#value' => sitedoc_content_types(),
      );  
    $output .=  theme('fieldset', $fieldset);
    $output .= "</div>\n";
  }

  // Get modules from the System module functions.
  if ($sitedoc_settings['module_section']) {
    $output .= '<div class="sitedoc_modules">';
    $fieldset = array(
      '#title' => t('Modules'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#value' => sitedoc_get_modules($sitedoc_settings['module_suppress'], $sitedoc_settings['module_sort_order']),
      );  
    $output .=  theme('fieldset', $fieldset);
    $output .= "</div>\n";
  }

  // Get themes and theme_engines from the System table.
  if ($sitedoc_settings['theme_section']) {  /* controls themes and theme engines */
    $output .= '<div class="sitedoc_themes">';
    $fieldset = array(
      '#title' => t('Themes'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#value' => sitedoc_get_system('theme'),
      );  
    $output .=  theme('fieldset', $fieldset);
    $output .= "</div>\n";

    $output .= '<div class="sitedoc_theme_engines">';
    $fieldset = array(
      '#title' => t('Theme Engines'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
      '#value' => sitedoc_get_system('theme_engine'),
    );  
    $output .=  theme('fieldset', $fieldset);
    $output .= "</div>\n";
  }

  // Get vocabularies and their definitions.
  if ($sitedoc_settings['vocabulary_section']) {
    $output .= '<div class="sitedoc_vocabularies">';
    $fieldset = array(
      '#title' => t('Vocabularies'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#value' => sitedoc_get_vocabularies(),
      );  
    $output .=  theme('fieldset', $fieldset);

     // do we want to check for orphans in the Term_node table?
    if ($sitedoc_settings['orphan_term_node']) {
      $orphans = sitedoc_check_orphan_term_node($sitedoc_settings['delete_orphan_term_nodes']);
      $fieldset = array(
        '#title' => t('Orphan Term_nodes'),
        '#collapsible' => TRUE,
        '#collapsed' => ($orphans == '<p>'. t('No orphan term_nodes found.') .'</p>'),
        '#value' => $orphans,
      );  
    $output .=  theme('fieldset', $fieldset);
    }
    $output .= "</div>\n";
  }

  // Get system variable info from cache.
  if ($sitedoc_settings['variables_section']) {
    $output .= '<div class="sitedoc_variables">';
    $fieldset = array(
      '#title' => t('Variables'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#value' => sitedoc_get_variables(),
      );  
    $output .=  theme('fieldset', $fieldset);
    $output .= "</div>\n";
  }

  // Get blocks info from Blocks table.
  if ($sitedoc_settings['block_section']) {  /* controls block and boxes */
    $output .= '<div class="sitedoc_blocks">';
      // use the setting to decide on a warning for missing themes
    $fieldset = array(
      '#title' => t('Blocks'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#value' => sitedoc_get_blocks($sitedoc_settings['block_warn'], $sitedoc_settings['block_delete']),
    );  
    $output .=  theme('fieldset', $fieldset);
    $output .= "</div>\n";

    // Get boxes (custom blocks) info from Boxes table.
    // Runs only if the blocks section is selected.
    $output .= '<div class="sitedoc_boxes">';
    $boxes = sitedoc_get_boxes($sitedoc_settings['block_warn'], $sitedoc_settings['block_delete']);
    $fieldset = array(
      '#title' => t('Custom Blocks (Boxes)'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#value' => $boxes ? $boxes : ('<p>'. t('No boxes found.') .'</p>'),
      );
    $output .=  theme('fieldset', $fieldset);
    $output .= "</div>\n";
  }

  // Get roles info from Roles table  (how can we get a description of the roles?).
  if ($sitedoc_settings['roles_section']) {
    $output .= '<div class="sitedoc_roles">';
    $rpt .= sitedoc_get_roles($sitedoc_settings['role_perms_list'], $sitedoc_settings['role_users']);
    $fieldset = array(
      '#title' => t('Roles'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#value' => $rpt ? $rpt : (t('No roles found.') .' <img src="/misc/watchdog-error.png" width="17" height="17">'),
      );
    $output .=  theme('fieldset', $fieldset);
    $output .= "</div>\n";
  }

  // Get contacts info from Contacts table.
  if ($sitedoc_settings['contacts_section']) {
    $output .= '<div class="sitedoc_contacts">';
    $rpt = sitedoc_get_contacts();
    $fieldset = array(
      '#title' => t('Contacts'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#value' => $rpt ? $rpt : t('No contacts found.'),
      );
    $output .=  theme('fieldset', $fieldset);
    $output .= "</div>\n";
  }

  // Get info from Profile_fields table.
  if ($sitedoc_settings['profile_fields_section']) {
    $output .= '<div class="sitedoc_profile_fields">';
    $rpt = sitedoc_profile_fields();
    $fieldset = array(
      '#title' => t('Profile Fields'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#value' => $rpt ? $rpt : ('<p>'. t('No profile fields found.') .'</p>'),
      );
    $output .=  theme('fieldset', $fieldset);
    $output .= "</div>\n";
  }

  // Get info from URL Alias table and cross-check it.
  if ($sitedoc_settings['url_alias_section']) {
    $output .= '<div class="sitedoc_url_alias">';
    $rpt = sitedoc_url_alias();
    $fieldset = array(
      '#title' => t('URL Aliases'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#value' => $rpt ? $rpt : t('No aliases found.'),
      );
    $output .=  theme('fieldset', $fieldset);
    $output .= "</div>\n";
  }

  $output .= "</div>\n";

  // Get info from Filter and Filter_format tables.
  if ($sitedoc_settings['input_format_section']) {
    $output .= '<div class="sitedoc_input_format">';
    $fieldset = array(
      '#title' => t('Input Formats and Filters'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
      '#value' => sitedoc_filters(),
      );
    $output .=  theme('fieldset', $fieldset);
    $output .= "</div>\n";
  }

  $output .= "</div>\n";
  return $output;

}
/**
 *  Implementation of hook_cron
 *
 *  Runs the report and saves it to disk.
 */
function sitedoc_cron() {
  // Get the module settings and verify they've been set.
  $sitedoc_settings = variable_get('sitedoc_settings', array());
  if ($sitedoc_settings == array()) {
    watchdog('Site Doc', t('It appears that you have not been to "administer >> site configuration" to set the Site Documentation settings.'), WATCHDOG_ERROR);
  }

  // If set up for manual run, then just quit now.
  $frequency = $sitedoc_settings['archive_frequency'];
  if ($frequency == 0) {
    return;
  }

  // If set up for debugging, then -1 will let us run every time.
  if ($frequency == '999999') {
    $frequency = -1;
  }

  // Determine if it's time to make another run.
  $how_long = time() - $sitedoc_settings['archive_last_run'];

  if ($how_long > $frequency) { /* longer than how long between saves? */
    // Get the file path and append a file name.
    $filename = variable_get('file_directory_path', 'files') .'/' 
      . $sitedoc_settings['archive_directory'] .'/sitedoc_'. date('Ymd_Hi') .'.html';
    $path = $filename;
    // make sure we can write to it        
    $writable = fopen($path, 'w');
    if ($writable == FALSE) {
      watchdog('Site Doc', t('Cannot write "!file" to archive directory.', array('!file' => $filename)), WATCHDOG_ERROR);
      return;
    }

    // Call the main list, format the output as a full page (without blocks),
    //  change all the relative paths to full paths, fix the page title.
    $output = theme('page', sitedoc_list(), FALSE);
    global $base_url;
    $output = str_replace('@import "/', '@import "'. $base_url .'/', $output);
    $output = str_replace('src="/', 'src="'. $base_url .'/', $output);
    $output = str_replace('<title>Run cron', '<title>Site Documentation', $output);

    // Save the file and write a message indicating whether it worked.
    $saved_as = fwrite($writable, $output);
    if ($saved_as === 0) {
      watchdog('Site Doc', t('Documentation file save failed.'), WATCHDOG_ERROR);
    }
    else {
      watchdog('Site Doc', t('Documentation file saved as !name', array('!name' => $filename)), WATCHDOG_NOTICE);
    }
    fclose($writable);

    // update last run time
    $sitedoc_settings['archive_last_run'] = time();
    variable_set('sitedoc_settings', $sitedoc_settings); 

  } /* end if how long */
}

/****************************/
/**   Callable functions   **/
/****************************/

/**
 *   Produce the basic system overview.
 *
 *  Parameters:
 *    TRUE/FALSE - whether to fix Cron stall problem if detected.
 *
 *  Return: HTML string.
 */
function sitedoc_drupal($kill_cron=0) {
  global $base_url;
  $dest = drupal_get_destination();
  $_abled = array(t('Disabled'), t('Enabled'));
  $_bool = array(t('False'), t('True'));
  $_noyes = array(t('No'), t('Yes'));

  $header = array(t('Item'), t('Value'), t('Operation'));
  $setting = t('Settings');
  $rows = array();

  $rows[] = array(t('Site Name'), variable_get('site_name', 'none'), l($setting, 'admin/settings/site-information', array(), $dest));
  $rows[] = array(t('Version'), VERSION, NULL);
  $rows[] = array(t('Configuration file'), conf_path() .'/settings.php', NULL);
  $rows[] = array(t('Install profile'), variable_get('install_profile', 'default'), NULL);
  $rows[] = array(t('Base URL'), $base_url, NULL);

  $cache = variable_get('cache', 0);
  $cache_type = array(t('Disabled'), t('Normal'), t('Agressive'));
  $rows[] = array(t('Cache'), $cache_type[$cache], l($setting, 'admin/settings/performance', array(), $dest));
  $rows[] = array(t('Minimum cache lifetime'), format_interval(variable_get('cache_lifetme', 0), 1), l($setting, 'admin/settings/performance', array(), $dest));
  $rows[] = array(t('CSS preprocess'), variable_get('preprocess_css', FALSE) ? t('Enabled') : t('Disabled'), l($setting, 'admin/settings/performance', array(), $dest));

  $clean_urls = variable_get('clean_url', FALSE);
  $rows[] = array(t('Clean URLS'), $_abled[$clean_urls], l($setting, 'admin/settings/clean-urls', array(), $dest));

  $cron_last = variable_get('cron_last', NULL);
  $cron_when = isset($cron_last) ? t('Last run !time ago', array('!time' => format_interval(time() - $cron_last))) : t('Not run yet');
  // If it last ran more than an hour ago, add "Run now" link.
  if (time() - $cron_last > 3600) {
    $cron_op .= l(t('Run now'), 'admin/logs/status/run-cron', array(), $dest);
  }
  else {
    $cron_op = NULL;
  } 
  $cron_semaphore = variable_get('cron_semaphore', NULL);  /* is it running now? */
  if (isset($cron_semaphore)) { 
    $how_long = time() - $cron_semaphore;  /* how long it's been running (secs) */
    $cron_when .= ' - '. t('Running for !time', array('!time' => format_interval($how_long)))
                  .'<img src="/misc/watchdog-warning.png" width="17" height="17">';
    if ($kill_cron) {
      if ($kill_cron <= $how_long) {
        variable_del('cron_semaphore');  /* turn off "cron started" flag */
        variable_del('cron_last');       /** I don't think this is actually needed **/
      } /* end if how long */
    }  /* end if kill_cron */
  }  /* end if semaphore */
  $rows[] = array(t('Cron'), $cron_when, $cron_op);

  if (module_exists('search')) {
    $rows[] = array(t('Search Cron limit'), variable_get("search_cron_limit", null), l($setting, 'admin/settings/search', array(), $dest));
    $remaining = 0;
    $total = 0;
    foreach (module_list() as $module) {
      if (module_hook($module, 'search')) {
        $status = module_invoke($module, 'search', 'status');
        $remaining += $status['remaining'];
        $total += $status['total'];
      }
    }
    $count = format_plural($remaining, 'There is 1 item left to index.', 'There are @count items left to index.');
    $percentage = ((int)min(100, 100 * ($total - $remaining) / max(1, $total))) .'%';
    $status = t('%percentage of the site has been indexed.', array('%percentage' => $percentage)) .' '. $count;
    $link = l($setting, 'admin/settings/search', array(), $dest);
    if ($remaining) {
      $link .= ', '. l(t('Run Cron'), 'admin/logs/status/run-cron', array(), $dest);
    }
    $rows[] = array(t('Search status'), $status, $link);
  }

  $rows[] = array(t('Anonymous'), variable_get('anonymous', 'anonymous'), l($setting, 'admin/settings/site-information', array(), $dest)); 
  $rows[] = array(t('File directory'), variable_get('file_directory_path', 'files/'), l($setting, 'admin/settings/file-system', array(), $dest));

  if (variable_get('file_downloads', FILE_DOWNLOADS_PUBLIC) == FILE_DOWNLOADS_PUBLIC) {
    $downloads = t('Public'); 
    $download_op = NULL;
  }
  else {
    $downloads = t('Private') .'<img src="/misc/watchdog-warning.png" width="17" height="17">'; 
    $download_op = l($setting, 'admin/settings/file-system', array(), $dest);
  }  

  $rows[] = array(t('Download method'), $downloads, $download_op);

  // Is the menu choice restricted?
  $menu_restrict = variable_get('menu_parent_items', NULL);  
  // "Show all menus" is Zero. Unless the setting has been changed it won't be present (NULL)
  if ($menu_restrict) {
    $menu_msg = t('Restricted') .' ('. $menu_restrict .') <img src="/misc/watchdog-warning.png" width="17" height="17">';
  }
  else {
    $menu_msg = t('Show all menus') .'<img src="/misc/watchdog-ok.png" width="17" height="17">';
  }
  $rows[] = array(t('Content menu links'), $menu_msg, l($setting, 'admin/build/menu/settings', array(), $dest));

  $rows[] = array(t('Default theme'), variable_get('theme_default', 'standard'), l($setting, 'admin/build/themes', array(), $dest));
  
  $teaser_len = variable_get('teaser_length', 300);
  $rows[] = array(t('Teaser length'), $teaser_len ? $teaser_len : t('unlimited'), l($setting, 'admin/content/node-settings', array(), $dest));
  
  // Get default filter and then look up its name.
  $filter = $filter_default = variable_get('filter_default_format', 0);
  if ($filter_default == 0) {
    $filter = 1;
  }
  $filter_name = db_fetch_object(db_query_range("SELECT f.name FROM {filter_formats} f WHERE f.format='%d'", $filter, 0, 1));
  if ($filter_default == 1) {
    $filter_warn = NULL;
    $filter_op = NULL;
  }
  else {
    $filter_warn = ' <em>('. t('not set') .')</em><img src="/misc/watchdog-warning.png" width="17" height="17"> ';
    $filter_op = l($setting, 'admin/settings/filters', array(), $dest);
  }  
  $rows[] = array(t('Default filter format'), $filter_name->name . $filter_warn, $filter_op);

  $rows[] = array(t('Operating system'), php_uname