'. 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.') .'
';
break;
case 'admin/settings/sitedoc':
$output = ''. 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.") .'
';
}
return $output;
}
/**
* Implementation of hook_perm().
*/
function sitedoc_perm() {
return array('view site documentation');
}
/**
* Implementation of hook_menu().
*/
function sitedoc_menu() {
$items = array();
$items['admin/build/sitedoc'] = array(
'title' => 'Site documentation',
'description' => 'Show site documentation',
'page callback' => 'sitedoc_list',
'access arguments' => array('view site documentation'),
);
$items['admin/settings/sitedoc'] = array(
'title' => 'Site documentation',
'description' => 'Set how Site Documentation works',
'page callback' => 'sitedoc_settings_page',
'access arguments' => array('view site documentation'),
'file' => 'sitedoc.admin.inc',
);
$items['admin/settings/sitedoc/report'] = array(
'title' => 'Report',
'description' => 'Report settings',
'page callback' => 'drupal_get_form',
'page arguments' => array('sitedoc_settings_form'),
'access arguments' => array('view site documentation'),
'type' => MENU_DEFAULT_LOCAL_TASK,
'file' => 'sitedoc.admin.inc',
);
$items['admin/settings/sitedoc/archive'] = array(
'title' => 'Archive',
'access arguments' => array('view site documentation'),
'page callback' => 'drupal_get_form',
'page arguments' => array('sitedoc_archive_form'),
'description' => 'Set how Site Documentation archive works',
'weight' => 2,
'type' => MENU_LOCAL_TASK,
'file' => 'sitedoc.admin.inc',
);
$items['admin/build/sitedoc_node_access_view'] = array(
'title' => 'Site documentation node access list',
'page callback' => 'sitedoc_node_access_view',
'page arguments' => array(arg(3)),
'access arguments' => array('view site documentation'),
'type' => MENU_CALLBACK,
);
$items['sitedoc/vocabulary'] = array(
'title' => 'Site Documentation Term Count by Type',
'page callback' => 'sitedoc_term_count_by_type',
'access arguments' => array('access content'),
'type' => MENU_CALLBACK
);
$items['sitedoc/phpinfo'] = array(
'title' => 'Site Documentation PHP Information',
'page callback' => 'sitedoc_phpinfo',
'access arguments' => array('view site documentation'),
'type' => MENU_CALLBACK
);
$items['sitedoc/table'] = array(
'title' => 'Table Contents',
'page callback' => 'sitedoc_show_table',
'access arguments' => array('view site documentation'),
'type' => MENU_CALLBACK
);
return $items;
}
/**
* Implementation of hook_init().
*/
function sitedoc_init() {
drupal_add_css(drupal_get_path('module', 'sitedoc') .'/sitedoc.css');
}
/**
* 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 */
'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 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 = ''. l(t('Change settings.'), 'admin/settings/sitedoc') .'
';
// Get basic Drupal info.
if ($sitedoc_settings['drupal_section']) {
$output .= '
';
$fieldset = array(
'#title' => t('Drupal Section'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
'#value' => sitedoc_drupal($sitedoc_settings['kill_cron']),
);
$output .= theme('fieldset', $fieldset);
$output .= "
\n";
}
// Get database info.
if ($sitedoc_settings['table_section']) {
$output .= '
';
$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 .= "
\n";
}
// Get summary of all nodes (this is VERY expensive!).
if ($sitedoc_settings['node_section']) {
$output .= '
';
$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 .= "
\n";
// Get node access summary (this is expensive!).
// Runs only if the node summary section is selected.
if ($sitedoc_settings['include_node_access']) {
$output .= '
';
$fieldset = array(
'#title' => t('Node Access'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
'#value' => sitedoc_node_access(),
);
$output .= theme('fieldset', $fieldset);
$output .= "
\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 .= '
';
$fieldset = array(
'#title' => t('Content Types'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
'#value' => sitedoc_content_types(),
);
$output .= theme('fieldset', $fieldset);
$output .= "
\n";
}
// Get modules from the System module functions.
if ($sitedoc_settings['module_section']) {
$output .= '
';
$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 .= "
\n";
}
// Get themes from the System table.
if ($sitedoc_settings['theme_section']) { /* controls themes */
$output .= '
';
$fieldset = array(
'#title' => t('Themes'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
'#value' => sitedoc_get_system('theme'),
);
$output .= theme('fieldset', $fieldset);
$output .= "
\n";
}
// Get vocabularies and their definitions.
if ($sitedoc_settings['vocabulary_section']) {
$output .= '
';
$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 == '
'. t('No orphan term_nodes found.') .'
'),
'#value' => $orphans,
);
$output .= theme('fieldset', $fieldset);
}
$output .= "
\n";
}
// Get system variable info from cache.
if ($sitedoc_settings['variables_section']) {
$output .= '
';
$fieldset = array(
'#title' => t('Variables'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
'#value' => sitedoc_get_variables(),
);
$output .= theme('fieldset', $fieldset);
$output .= "
\n";
}
// Get blocks info from Blocks table.
if ($sitedoc_settings['block_section']) { /* controls block and boxes */
$output .= '
';
// 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 .= "
\n";
// Get boxes (custom blocks) info from Boxes table.
// Runs only if the blocks section is selected.
$output .= '
';
$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 : ('
'. t('No boxes found.') .'
'),
);
$output .= theme('fieldset', $fieldset);
$output .= "
\n";
}
// Get roles info from Roles table (how can we get a description of the roles?).
if ($sitedoc_settings['roles_section']) {
$output .= '
';
$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.') .' '. _sitedoc_img_error()),
);
$output .= theme('fieldset', $fieldset);
$output .= "
\n";
}
// Get contacts info from Contacts table.
if ($sitedoc_settings['contacts_section']) {
$output .= '
';
$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 .= "
\n";
}
// Get info from Profile_fields table.
if ($sitedoc_settings['profile_fields_section']) {
$output .= '
';
$rpt = sitedoc_profile_fields();
$fieldset = array(
'#title' => t('Profile Fields'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
'#value' => $rpt ? $rpt : ('
'. t('No profile fields found.') .'
'),
);
$output .= theme('fieldset', $fieldset);
$output .= "
\n";
}
// Get info from URL Alias table and cross-check it.
if ($sitedoc_settings['url_alias_section']) {
$output .= '
';
$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 .= "
\n";
}
// Get info from Filter and Filter_format tables.
if ($sitedoc_settings['input_format_section']) {
$output .= '
';
$fieldset = array(
'#title' => t('Input Formats and Filters'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
'#value' => sitedoc_filters(),
);
$output .= theme('fieldset', $fieldset);
$output .= "
\n";
}
$output .= "