system.module

<?php
// $Id$

/**
 * @file
 * Configuration system that lets administrators modify the workings of the site.
 */

/**
 * Implementation of hook_help().
 */
function system_help($section) {
  global $base_url;

  switch ($section) {
    case 'admin':
      return t('<p>Welcome to the administration section. Below are the most recent system events.</p>');
    case 'admin/settings':
      return t('<p>General configuration options for your site. Set up the name of the site, e-mail address used in mail-outs, clean URL options, caching, etc.</p>');
    case 'admin/themes':
      return t('<p>Select which themes are available to your users and specify the default theme. To configure site-wide display settings, click the "configure" task above. Alternately, to override these settings in a specific theme, click the "configure" link for the corresponding theme.  Note that different themes may have different regions available for rendering content like blocks.  If you want consistency in what your users see, you may wish to enable only one theme.</p>');
    case 'admin/themes/settings':
      return t('<p>These options control the default display settings for your entire site, across all themes. Unless they have been overridden by a specific theme, these settings will be used.</p>');
    case 'admin/themes/settings/'. arg(3):
      $reference = explode('.', arg(3), 2);
      $theme = array_pop($reference);
      return t('<p>These options control the display settings for the <code>%template</code> theme. When your site is displayed using this theme, these settings will be used. By clicking "Reset to defaults," you can choose to use the <a href="%global">global settings</a> for this theme.</p>', array('%template' => $theme, '%global' => url('admin/themes/settings')));
    case 'admin/modules':
      return t('<p>Modules are plugins for Drupal that extend its core functionality. Here you can select which modules are enabled. Click on the name of the module in the navigation menu for their individual configuration pages. Once a module is enabled, new <a href="%permissions">permissions</a> might be made available. Modules can automatically be temporarily disabled to reduce server load when your site becomes extremely busy by enabling the throttle.module and checking throttle. The auto-throttle functionality must be enabled on the <a href="%throttle">throttle configuration page</a> after having enabled the throttle module.</p>', array('%permissions' => url('admin/access/permissions'), '%throttle' => url('admin/settings/throttle')));
    case 'admin/help#system':
      return t("
      <p>Drupal comes with system-wide defaults but the setting-module provides control over many Drupal preferences, behaviours including visual and operational settings.</p>
      <h3><a id=\"cron\">Cron</a></h3>
      <p>Some modules require regularly scheduled actions, such as cleaning up logfiles.  Cron, which stands for chronograph, is a periodic command scheduler executing commands at intervals specified in seconds.  It can be used to control the execution of daily, weekly and monthly jobs (or anything with a period measured in seconds).   Automating tasks is one of the best ways to keep a system running smoothly, and if most of your administration does not require your direct involvement, cron is an ideal solution.</p>
      <p>The recommended way to set up your cron system is to set up a Unix/Linux crontab entry (see \"man crontab\") that frequently visits %cron-link.  Note that cron does not guarantee the commands will be executed at the specified interval.  However, Drupal will try its best to run the tasks as close to the specified intervals as possible.  The more you visit cron.php, the more accurate cron will be.</p>
      <p>If your hosting company does not allow you to set up crontab entries, you can always ask someone else to set up an entry for you. After all, virtually any Unix/Linux machine with access to the internet can set up a crontab entry to frequently visit %cron-link.</p>
      <p>For the Unix/Linux crontab itself, use a browser like <a href=\"%lynx\">lynx</a> or <a href=\"%wget\">wget</a> but make sure the process terminates: either use <code>/usr/bin/lynx -source %base_url/cron.php</code> or <code>/usr/bin/wget -o /dev/null -O /dev/null %cron-link</code>.  Take a look at the example scripts in the <code>scripts</code>-directory. Make sure to adjust them to fit your needs.  A good crontab line to run the cron script once every hour would be:
      <pre>     00 * * * * /home/www/drupal/scripts/cron-lynx.sh</pre>
      Note that it is essential to access <code>cron.php</code> using a browser on the web site's domain; do not run it using command line PHP and avoid using <code>localhost</code> or <code>127.0.0.1</code> or some of the environment variables will not be set correctly and features may not work as expected.</p>", array('%base_url' => $base_url, '%cron-link' => "<a href=\"$base_url/cron.php\">$base_url/cron.php</a>", '%lynx' => 'http://lynx.browser.org', '%wget' => 'http://www.gnu.org/software/wget/wget.html' ));
    case 'admin/modules#description':
      return t('Handles general site configuration for administrators.');
  }
}

/**
 * Implementation of hook_perm().
 */
function system_perm() {
  return array('administer site configuration', 'access administration pages', 'bypass input data check');
}

/**
 * Implementation of hook_menu().
 */
function system_menu($may_cache) {
  $items = array();

  if ($may_cache) {
    $items[] = array('path' => 'system/files', 'title' => t('file download'),
      'callback' => 'file_download',
      'access' => TRUE,
      'type' => MENU_CALLBACK);

    // Clean URL tester
    $items[] = array('path' => 'system/test',
      'callback' => 'system_test',
      'access' => TRUE,
      'type' => MENU_CALLBACK);

    $access = user_access('administer site configuration');

    $items[] = array('path' => 'admin', 'title' => t('administer'),
      'access' => user_access('access administration pages'),
      'callback' => 'watchdog_overview',
      'weight' => 9);

    // Themes:
    $items[] = array('path' => 'admin/themes', 'title' => t('themes'),
      'callback' => 'system_themes', 'access' => $access);

    $items[] = array('path' => 'admin/themes/select', 'title' => t('list'),
      'callback' => 'system_themes', 'access' => $access,
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -1);

    $items[] = array('path' => 'admin/themes/settings', 'title' => t('configure'),
      'callback' => 'system_theme_settings', 'access' => $access,
      'type' => MENU_LOCAL_TASK);

    // Theme configuration subtabs
    $items[] = array('path' => 'admin/themes/settings/global', 'title' => t('global settings'),
      'callback' => 'system_theme_settings', 'access' => $access,
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -1);

    foreach (list_themes() as $theme) {
       $items[] = array('path' => 'admin/themes/settings/'. $theme->name, 'title' => $theme->name,
       'callback' => 'system_theme_settings', 'callback arguments' => array($theme->name), 'access' => $access,
       'type' => MENU_LOCAL_TASK);
    }

    // Modules:
    $items[] = array('path' => 'admin/settings', 'title' => t('settings'),
      'callback' => 'system_site_settings', 'access' => $access);
    foreach (module_list() as $name) {
      if (module_hook($name, 'settings')) {
        $items[] = array('path' => 'admin/settings/'. $name, 'title' => t($name));
      }
    }
    $items[] = array('path' => 'admin/modules', 'title' => t('modules'),
      'callback' => 'system_modules', 'access' => $access);
  }

  return $items;
}

/**
 * Menu callback: dummy clean URL tester.
 */
function system_test() {
  variable_set('clean_url_ok', 1);
  exit;
}

/**
 * Implementation of hook_user().
 *
 * Allows users to individually set their theme and time zone.
 */
function system_user($type, $edit, &$user, $category = NULL) {
  if ($type == 'form' && $category == 'account') {
    $themes = list_themes();
    ksort($themes);

    if (count($themes) > 1) {
      $rows = array();
      foreach ($themes as $key => $value) {
        $row = array();

        // Screenshot column.
        $screenshot = dirname($value->filename) .'/screenshot.png';
        $row[] = file_exists($screenshot) ? theme('image', $screenshot, t('Screenshot for %theme theme', array('%theme' => $value->name)), '', array('class' => 'screenshot')) : t('no screenshot');

        // Information field.
        $row[] = '<strong>'. $value->name .'</strong>';

        // Reset to follow site default theme if user selects the site default
        if ($key == variable_get('theme_default', 'bluemarine')) {
          $key = '';
          if ($edit['theme'] == variable_get('theme_default', 'bluemarine')) {
            $edit['theme'] = '';
          }
        }

        // Selected column.
        $row[] = array('data' => form_radio('', 'theme', $key, ($edit['theme'] == $key) ? 1 : 0), 'align' => 'center');

        $rows[] = $row;
      }
      $header = array(t('Screenshot'), t('Name'), t('Selected'));
      $data[] = array('title' => t('Theme settings'), 'data' => form_item('', theme('table', $header, $rows), t('Selecting a different theme will change the look and feel of the site.')), 'weight' => 2);
    }

    if (variable_get('configurable_timezones', 1)) {
      $zones = _system_zonelist();
      $data[] = array('title' => t('Locale settings'), 'data' => form_select(t('Time zone'), 'timezone', strlen($edit['timezone']) ? $edit['timezone'] : variable_get('date_default_timezone', 0), $zones, t('Select your current local time. Dates and times throughout this site will be displayed using this time zone.')), 'weight' => 2);
    }
    return $data;
  }
}

function _system_zonelist() {
  $timestamp = time();
  $zonelist = array(-11, -10, -9.5, -9, -8, -7, -6, -5, -4, -3.5, -3, -2, -1, 0, 1, 2, 3, 3.5, 4, 5, 5.5, 5.75, 6, 6.5, 7, 8, 9, 9.5, 10, 10.5, 11, 11.5, 12, 12.75, 13, 14);
  $zones = array();
  foreach ($zonelist as $offset) {
    $zone = $offset * 3600;
    $zones[$zone] = format_date($timestamp, 'custom', variable_get('date_format_long', 'l, F j, Y - H:i') . ' O', $zone);
  }
  return $zones;
}

function system_view_general() {
  // General settings:
  $group  = form_textfield(t('Name'), 'site_name', variable_get('site_name', 'drupal'), 60, 70, t('The name of this web site.'));
  $group .= form_textfield(t('E-mail address'), 'site_mail', variable_get('site_mail', ini_get('sendmail_from')), 60, 128, t('A valid e-mail address for this website, used by the auto-mailer during registration, new password requests, notifications, etc.'));
  $group .= form_textfield(t('Slogan'), 'site_slogan', variable_get('site_slogan', ''), 60, 128, t('The slogan of this website. Some themes display a slogan when available.'));
  $group .= form_textarea(t('Mission'), 'site_mission', variable_get('site_mission', ''), 60, 5, t('Your site\'s mission statement or focus.'));
  $group .= form_textarea(t('Footer message'), 'site_footer', variable_get('site_footer', ''), 60, 5, t('This text will be displayed at the bottom of each page.  Useful for adding a copyright notice to your pages.'));
  $group .= form_textfield(t('Anonymous user'), 'anonymous', variable_get('anonymous', 'Anonymous'), 60, 70, t('The name used to indicate anonymous users.'));
  $group .= form_textfield(t('Default front page'), 'site_frontpage', variable_get('site_frontpage', 'node'), 60, 70, t('The home page displays content from this relative URL.  If you are not using clean URLs, specify the part after "?q=".  If unsure, specify "node".'));

  // We check for clean URL support using an image on the client side.
  $group .= form_radios(t('Clean URLs'), 'clean_url', variable_get('clean_url', 0), array(t('Disabled'), t('Enabled')), t('This option makes Drupal emit clean URLs (i.e. without <code>?q=</code> in the URL). You\'ll need <code>ModRewrite</code> support for this to work. See the <code>.htaccess</code> file in Drupal\'s top-level directory for more information.'));
  variable_set('clean_url_ok', 0);
  global $base_url;
  // We will use a random URL so there is no way a proxy or a browser could cache the "no such image" answer.
  $group .= '<img style="position: relative; left: -1000em;" src="'. $base_url. '/system/test/'. user_password(20) .'.png" alt="" />';

  $output = form_group_collapsible(t('General settings'), $group, TRUE);

  // Error handling:
  $period = drupal_map_assoc(array(3600, 10800, 21600, 32400, 43200, 86400, 172800, 259200, 604800, 1209600, 2419200), 'format_interval');
  $period['1000000000'] = t('Never');
  $group = form_textfield(t('Default 403 (access denied) page'), 'site_403', variable_get('site_403', ''), 60, 70, t('This page is displayed when the requested document is denied to the current user.  If you are not using clean URLs, specify the part after "?q=". If unsure, specify nothing.'));
  $group .= form_textfield(t('Default 404 (not found) page'), 'site_404', variable_get('site_404', ''), 60, 70, t('This page is displayed when no other content matches the requested document.  If you are not using clean URLs, specify the part after "?q=". If unsure, specify nothing.'));
  $group .= form_select(t('Error reporting'), 'error_level', variable_get('error_level', 1), array(t('Write errors to the log'), t('Write errors to the log and to the screen')), t('Where Drupal, PHP and SQL errors are logged. On a production server it is recommended that errors are only written to the error log. On a test server it can be helpful to write logs to the screen.'));
  $group .= form_select(t('Discard log entries older than'), 'watchdog_clear', variable_get('watchdog_clear', 604800), $period, t('The time log entries should be kept.  Older entries will be automatically discarded.  Requires crontab.'));

  $output .= form_group_collapsible(t('Error handling'), $group, TRUE);

  // Caching:
  $group  = form_radios(t('Page cache'), 'cache', variable_get('cache', CACHE_DISABLED), array(CACHE_DISABLED => t('Disabled'), CACHE_ENABLED => t('Enabled')), t("Drupal has a caching mechanism which stores dynamically generated web pages in a database.  By caching a web page, Drupal does not have to create the page each time someone wants to view it, instead it takes only one SQL query to display it, reducing response time and the server's load.  Only pages requested by \"anonymous\" users are cached.  In order to reduce server load and save bandwidth, Drupal stores and sends compressed cached pages."));
  $period = drupal_map_assoc(array(0, 60, 180, 300, 600, 900, 1800, 2700, 3600, 10800, 21600, 32400, 43200, 86400), 'format_interval');
  $period[0] = t('none');
  $group .= form_select(t('Minimum cache lifetime'), 'cache_lifetime', variable_get('cache_lifetime', 0), $period, t('Enabling the cache will offer a sufficient performance boost for most low-traffic and medium-traffic sites.  On high-traffic sites it can become necessary to enforce a minimum cache lifetime.  The minimum cache lifetime is the minimum amount of time that will go by before the cache is emptied and recreated.  A larger minimum cache lifetime offers better performance, but users will not see new content for a longer period of time.'));

  $output .= form_group_collapsible(t('Cache settings'), $group, TRUE);

  // File system:
  $directory_path = variable_get('file_directory_path', 'files');
  file_check_directory($directory_path, FILE_CREATE_DIRECTORY, 'file_directory_path');

  $directory_temp = variable_get('file_directory_temp', FILE_DIRECTORY_TEMP);
  file_check_directory($directory_temp, FILE_CREATE_DIRECTORY, 'file_directory_temp');

  $group = form_textfield(t('File system path'), 'file_directory_path', $directory_path, 60, 255, t('A file system path where the files will be stored. This directory has to exist and be writable by Drupal. If the download method is set to public this directory has to be relative to Drupal installation directory, and be accessible over the web. When download method is set to private this directory should not be accessible over the web. Changing this location after the site has been in use will cause problems so only change this setting on an existing site if you know what you are doing.'));
  $group .= form_textfield(t('Temporary directory'), 'file_directory_temp', $directory_temp, 60, 255, t('Location where uploaded files will be kept during previews. Relative paths will be resolved relative to the Drupal installation directory.'));
  $group .= form_radios(t('Download method'), 'file_downloads', variable_get('file_downloads', FILE_DOWNLOADS_PUBLIC), array(FILE_DOWNLOADS_PUBLIC => t('Public - files are available using http directly.'), FILE_DOWNLOADS_PRIVATE => t('Private - files are transferred by Drupal.')), t('If you want any sort of access control on the downloading of files, this needs to be set to <em>private</em>. You can change this at any time, however all download URLs will change and there may be unexpected problems so it is not recommended.'));
  $output .= form_group_collapsible(t('File system settings'), $group, TRUE);

  // Image handling:
  $group = '';
  $toolkits_available = image_get_available_toolkits();
  if (count($toolkits_available) > 1) {
    $group .= form_radios(t('Select an image processing toolkit'), 'image_toolkit', variable_get('image_toolkit', image_get_toolkit()), $toolkits_available);
  }
  $group .= image_toolkit_invoke('settings');
  if ($group) {
    $output .= form_group_collapsible(t('Image handling'), '<p>'. $group .'</p>', TRUE);
  }

  // Feed settings
  $group = '';
  $group .= form_select(t('Number of items per feed'), 'feed_default_items', variable_get('feed_default_items', 10), drupal_map_assoc(array(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30)), t('The default number of items to include in a feed.'));
  $group .= form_select(t('Display of XML feed items'), 'feed_item_length', variable_get('feed_item_length','teaser'), array('title' => t('Titles only'), 'teaser' => t('Titles plus teaser'), 'fulltext' => t('Full text')), t('Global setting for the length of XML feed items that are output by default.'));
  $output .= form_group_collapsible(t('RSS feed settings'), $group, TRUE);

  // Date settings:
  $zones = _system_zonelist();

  // Date settings: possible date formats
  $dateshort = array('Y-m-d H:i','m/d/Y - H:i', 'd/m/Y - H:i', 'Y/m/d - H:i',
           'm/d/Y - g:ia', 'd/m/Y - g:ia', 'Y/m/d - g:ia',
           'M j Y - H:i', 'j M Y - H:i', 'Y M j - H:i',
           'M j Y - g:ia', 'j M Y - g:ia', 'Y M j - g:ia');
  $datemedium = array('D, Y-m-d H:i', 'D, m/d/Y - H:i', 'D, d/m/Y - H:i',
          'D, Y/m/d - H:i', 'F j, Y - H:i', 'j F, Y - H:i', 'Y, F j - H:i',
          'D, m/d/Y - g:ia', 'D, d/m/Y - g:ia', 'D, Y/m/d - g:ia',
          'F j, Y - g:ia', 'j F, Y - g:ia', 'Y, F j - g:ia');
  $datelong = array('l, F j, Y - H:i', 'l, j F, Y - H:i', 'l, Y,  F j - H:i',
        'l, F j, Y - g:ia', 'l, j F, Y - g:ia', 'l, Y,  F j - g:ia');

  // Date settings: construct choices for user
  foreach ($dateshort as $f) {
    $dateshortchoices[$f] = format_date(time(), 'custom', $f);
  }
  foreach ($datemedium as $f) {
    $datemediumchoices[$f] = format_date(time(), 'custom', $f);
  }
  foreach ($datelong as $f) {
    $datelongchoices[$f] = format_date(time(), 'custom', $f);
  }

  $group  = form_select(t('Default time zone'), 'date_default_timezone', variable_get('date_default_timezone', 0), $zones, t('Select the default site time zone.'));
  $group .= form_radios(t('Configurable time zones'), 'configurable_timezones', variable_get('configurable_timezones', 1), array(t('Disabled'), t('Enabled')), t('Enable or disable user-configurable time zones.  When enabled, users can set their own time zone and dates will be updated accordingly.'));
  $group .= form_select(t('Short date format'), 'date_format_short', variable_get('date_format_short', $dateshort[0]), $dateshortchoices, t('The short format of date display.'));
  $group .= form_select(t('Medium date format'), 'date_format_medium', variable_get('date_format_medium', $datemedium[0]), $datemediumchoices, t('The medium sized date display.'));
  $group .= form_select(t('Long date format'), 'date_format_long', variable_get('date_format_long', $datelong[0]), $datelongchoices, t('Longer date format used for detailed display.'));
  $group .= form_select(t('First day of week'), 'date_first_day', variable_get('date_first_day', 0), array(0 => t('Sunday'), 1 => t('Monday'), 2 => t('Tuesday'), 3 => t('Wednesday'), 4 => t('Thursday'), 5 => t('Friday'), 6 => t('Saturday')), t('The first day of the week for calendar views.'));

  $output .= form_group_collapsible(t('Date settings'), $group, TRUE);

  // String handling: report status and errors.
  $output .= form_group_collapsible(t('String handling'), unicode_settings(), TRUE);

  return $output;
}

/**
 * Retrieves the current status of an array of files in the system table.
 */
function system_get_files_database(&$files, $type) {
  // Extract current files from database.
  $result = db_query("SELECT name, type, status, throttle FROM {system} WHERE type = '%s'", $type);
  while ($file = db_fetch_object($result)) {
    if (isset($files[$file->name]) && is_object($files[$file->name])) {
      foreach ($file as $key => $value) {
        if (!isset($files[$file->name]) || !isset($files[$file->name]->$key)) {
          $files[$file->name]->$key = $value;
        }
      }
    }
  }
}

/**
 * Collect data about all currently available themes
 */
function system_theme_data() {
  // Find themes
  $themes = system_listing('\.theme$', 'themes');

  // Find theme engines
  $engines = system_listing('\.engine$', 'themes/engines');

  // can't iterate over array itself as it uses a copy of the array items
  foreach (array_keys($themes) as $key) {
    drupal_get_filename('theme', $themes[$key]->name, $themes[$key]->filename);
    drupal_load('theme', $themes[$key]->name);
    $themes[$key]->owner = $themes[$key]->filename;
    $themes[$key]->prefix = $key;
  }

  // Remove all theme engines from the system table
  db_query("DELETE FROM {system} WHERE type = 'theme_engine'");

  foreach ($engines as $engine) {
    // Insert theme engine into system table
    drupal_get_filename('theme_engine', $engine->name, $engine->filename);
    drupal_load('theme_engine', $engine->name);
    db_query("INSERT INTO {system} (name, type, filename, status, throttle, bootstrap) VALUES ('%s', '%s', '%s', %d, %d, %d)", $engine->name, 'theme_engine', $engine->filename, 1, 0, 0);

    // Add templates to the site listing
    foreach (call_user_func($engine->name . '_templates') as $template) {
      // Do not double-insert templates with theme files in their directory,
      // but do register their engine data.
      if (array_key_exists($template->name, $themes)) {
        $themes[$template->name]->template = TRUE;
        $themes[$template->name]->owner = $engine->filename;
        $themes[$template->name]->prefix = $engine->name;
      }
      else {
        $template->template = TRUE;
        $template->name = basename(dirname($template->filename));
        $template->owner = $engine->filename;
        $template->prefix = $engine->name;

        $themes[$template->name] = $template;
      }
    }
  }

  // Find styles in each theme's directory.
  foreach ($themes as $theme) {
    foreach (file_scan_directory(dirname($theme->filename), 'style.css$') as $style) {
      $style->style = TRUE;
      $style->template = $theme->template;
      $style->name = basename(dirname($style->filename));
      $style->owner = $theme->filename;
      $style->prefix = $theme->template ? $theme->prefix : $theme->name;
      // do not double-insert styles with theme files in their directory
      if (array_key_exists($style->name, $themes)) {
        continue;
      }
      $themes[$style->name] = $style;
    }
  }

  // Extract current files from database.
  system_get_files_database($themes, 'theme');

  db_query("DELETE FROM {system} WHERE type = 'theme'");

  foreach ($themes as $theme) {
    db_query("INSERT INTO {system} (name, description, type, filename, status, throttle, bootstrap) VALUES ('%s', '%s', '%s', '%s', %d, %d, %d)", $theme->name, $theme->owner, 'theme', $theme->filename, $theme->status, 0, 0);
  }

  return $themes;
}

/**
 * Get a list of available regions from a specified theme.
 *
 * @param $theme_key
 *   The name of a theme.
 * @return
 *   An array of regions in the form $region['name'] = 'description'.
 */
function system_region_list($theme_key) {
  static $list = array();

  if(!array_key_exists($theme_key, $list)) {

    $result = db_query("SELECT * FROM {system} WHERE type = 'theme' AND name = '%s'", $theme_key);
    $theme = db_fetch_object($result);

    if (strpos($theme->filename, '.css')) {
      // File is a style, which can't have its own regions; use its theme instead.
      $list[$theme_key] = system_region_list(basename(dirname($theme->description)));
      return $list[$theme_key];
    }
    if (file_exists($file = dirname($theme->filename) .'/' . $theme_key . '.theme')) {
    include_once "./$file";
    }

    $regions = function_exists($theme_key . '_regions') ? call_user_func($theme_key . '_regions') : array();
    if (strpos($theme->description, '.engine')) {
      // File is a template; include its engine's regions.
    include_once './' . $theme->description;
      $theme_engine = basename($theme->description, '.engine');
      $engine_regions = function_exists($theme_engine . '_regions') ? call_user_func($theme_engine . '_regions') : array();
      $regions = array_merge($engine_regions, $regions);
    }

    $list[$theme_key] = $regions;
  }

  return $list[$theme_key];
}

/**
 * Get the name of the default region for a given theme.
 *
 * @param $theme
 *   The name of a theme.
 * @return
 *   A string that is the region name.
 */
function system_default_region($theme) {
  $regions = array_keys(system_region_list($theme));
  return $regions[0];
}

/**
 * Returns an array of files objects of the given type from both the
 * site-wide directory (i.e. modules/) and site-specific directory
 * (i.e. sites/somesite/modules/).  The returned array will be keyed
 * using the key specified (name, basename, filename).  Using name or
 * basename will cause site-specific files to shadow files in the
 * default directories.  That is, if a file with the same name appears
 * in both location, only the site-specific version will be included.
 *
 * @param $mask
 *   The regular expression of the files to find.
 * @param $directory
 *   The subdirectory name in which the files are found.  For example,
 *   'modules' will search in both modules/ and
 *   sites/somesite/modules/.
 * @param $key
 *   The key to be passed to file_scan_directory().
 * @param $min_depth
 *   Minimum depth of directories to return files from.
 *
 * @return
 *   An array of file objects of the specified type.
 */
function system_listing($mask, $directory, $key = 'name', $min_depth = 1) {
  $config = conf_init();
  $searchdir = array($directory);
  $files = array();

  if (file_exists("$config/$directory")) {
    $searchdir[] = "$config/$directory";
  }

  // Get current list of items
  foreach ($searchdir as $dir) {
    $files = array_merge($files, file_scan_directory($dir, $mask, array('.', '..', 'CVS'), 0, TRUE, $key, $min_depth));
  }

  return $files;
}

/**
 * Generate a list of all the available theme/style combinations.
 */
function system_theme_listing() {
  $themes = system_theme_data();
  ksort($themes);

  foreach ($themes as $info) {
    $info->screenshot = dirname($info->filename) . '/screenshot.png';
    $row = array();

    // Screenshot column.
    $row[] = file_exists($info->screenshot) ? theme('image', $info->screenshot, t('Screenshot for %theme theme', array('%theme' => $info->name)), '', array('class' => 'screenshot')) : t('no screenshot');

    // Information field.
    $row[] = "<strong>$info->name</strong><br /><em>" . dirname($info->filename) . '</em>';

    // enabled, default, and operations columns
    $row[] = array('data' => form_checkbox('', 'status]['. $info->name, 1, $info->status), 'align' => 'center');
    $row[] = array('data' => form_radio('', 'theme_default', $info->name, (variable_get('theme_default', 'bluemarine') == $info->name) ? 1 : 0), 'align' => 'center');
    if ($info->status && (function_exists($info->prefix . '_settings') || function_exists($info->prefix . '_features'))) {
      $row[] = array('data' => l(t('configure'), 'admin/themes/settings/' . $info->name), 'align' => 'center');
    }
    else {
      $row[] = '';
    }
    $rows[] = $row;
  }

  $header = array(t('Screenshot'), t('Name'), t('Enabled'), t('Default'), t('Operations'));
  $output = form_hidden('type', 'theme');
  $output .= theme('table', $header, $rows);
  return $output;
}

/**
 * Generate a list of all the available modules, as well as update the system list.
 */
function system_module_listing() {
  // Get current list of modules
  $files = system_listing('\.module$', 'modules', 'name', 0);

  // Extract current files from database.
  system_get_files_database($files, 'module');

  ksort($files);

  $required = array('block', 'filter', 'system', 'user', 'watchdog');
  $throttle_required = array_merge($required, array('throttle'));

  $header = array(t('Name'), t('Description'), t('Enabled'));
  if (module_exist('throttle')) {
    $header[] = t('Throttle');
  }

  foreach ($files as $filename => $file) {
    drupal_get_filename('module', $file->name, $file->filename);
    drupal_load('module', $file->name);

    $file->description = module_invoke($file->name, 'help', 'admin/modules#description');

    // log the critical hooks implemented by this module
    $bootstrap = 0;
    foreach (bootstrap_hooks() as $hook) {
      if (module_hook($file->name, $hook)) {
        $bootstrap = 1;
        break;
      }
    }

    // Update the contents of the system table:
    db_query("DELETE FROM {system} WHERE name = '%s' AND type = '%s'", $file->name, 'module');
    db_query("INSERT INTO {system} (name, description, type, filename, status, throttle, bootstrap) VALUES ('%s', '%s', '%s', '%s', %d, %d, %d)", $file->name, $file->description, 'module', $file->filename, $file->status, $file->throttle, $bootstrap);

    $row = array($file->name, $file->description, array('data' => (in_array($file->name, $required) ? form_hidden("status][$file->name", 1) . t('required') : form_checkbox('', "status][$file->name", 1, $file->status)), 'align' => 'center'));
    if (module_exist('throttle')) {
      $row[] = array('data' => (in_array($file->name, $throttle_required) ? form_hidden("throttle][$file->name", 0) . t('required') : form_checkbox(NULL, "throttle][$file->name", 1, $file->throttle, NULL)), 'align' => 'center');
    }
    $rows[] = $row;
  }

  $output  = theme('table', $header, $rows);
  $output .= form_hidden('type', 'module');

  return $output;
}

function system_listing_save($edit = array()) {
  $op = $_POST['op'];
  $edit = $_POST['edit'];

  if ($op == t('Save configuration')) {
    db_query("UPDATE {system} SET status = 0 WHERE type = '%s'", $edit['type']);
    foreach ($edit['status'] as $name => $status) {
      // Make certain that the default theme is enabled to avoid user error
      if (($edit['type'] == 'theme') && ($edit['theme_default'] == $name)) {
        $status = 1;
      }
      // If status is being set to 1 from 0, initialize block data for this theme if necessary.
      if (($edit['type'] == 'theme') && ($status == 1) && db_num_rows(db_query("SELECT status FROM {system} WHERE type = '%s' AND name = '%s' AND status = 0", $edit['type'], $name))) {
        system_initialize_theme_blocks($name);
      }

      db_query("UPDATE {system} SET status = %d, throttle = %d WHERE type = '%s' AND name = '%s'", $status, $edit['throttle'][$name], $edit['type'], $name);
    }

    if ($edit['type'] == 'theme') {
      variable_set('theme_default', $edit['theme_default']);
    }

    menu_rebuild();

    drupal_set_message(t('The configuration options have been saved.'));
    drupal_goto($_GET['q']);
  }
}
/**
 * Assign an initial, default set of blocks for a theme.
 *
 * This function is called the first time a new theme is enabled.  The new theme
 * gets a copy of the default theme's blocks, with the difference that if a
 * particular region isn't available in the new theme, the block is assigned
 * to the new theme's default region.
 *
 * @param $theme
 *   The name of a theme.
 */
function system_initialize_theme_blocks($theme) {
  // Initialize theme's blocks if none already registered.
  if (!(db_num_rows(db_query("SELECT module FROM {blocks} WHERE theme = '%s'", $theme)))) {
    $default_theme = variable_get('theme_default', 'bluemarine');
    $regions = system_region_list($theme);
    $result = db_query("SELECT * FROM {blocks} WHERE theme = '%s'", $default_theme);
    while($block = db_fetch_array($result)) {
      // If the region isn't supported by the theme, assign the block to the theme's default region.
      if (!array_key_exists($block['region'], $regions)) {
        $block['region'] = system_default_region($theme);
      }
      db_query("INSERT INTO {blocks} (module, delta, theme, status, weight, region, visibility, pages, custom, throttle) VALUES ('%s', '%s', '%s', %d, %d, '%s', %d, '%s', %d, %d)",
          $block['module'], $block['delta'], $theme, $block['status'], $block['weight'], $block['region'], $block['visibility'], $block['pages'], $block['custom'], $block['throttle']);
    }
  }
}

function system_settings_form($form) {
  $form .= form_submit(t('Save configuration'));
  $form .= form_submit(t('Reset to defaults'));

  return form($form);
}

function system_settings_save() {
  $op = $_POST['op'];
  $edit = $_POST['edit'];

  if ($op == t('Reset to defaults')) {
    if (is_array($edit)) {
      foreach ($edit as $name => $value) {
        variable_del($name);
      }
    }
    drupal_set_message(t('The configuration options have been reset to their default values.'));
  }
  else if ($op == t('Save configuration')) {
    if (is_array($edit)) {
      if ($edit['clean_url'] && !variable_get('clean_url_ok', 0)) {
        drupal_set_message(t('It appears your host is not configured correctly for Clean URLs. Please check for <code>ModRewrite</code> support with your administrator.'), 'error');
        $edit['clean_url'] = 0;
      }
      foreach ($edit as $name => $value) {
        variable_set($name, $value);
      }
    }
    drupal_set_message(t('The configuration options have been saved.'));
  }
  else {
    return;
  }
  menu_rebuild();
  drupal_goto($_GET['q']);
}

/**
 * Menu callback; displays a listing of all themes.
 */
function system_themes() {
  system_listing_save();
  $form = system_theme_listing();
  $form .= form_submit(t('Save configuration'));
  return form($form);
}

/**
 * Menu callback; displays a listing of all modules.
 */
function system_modules() {
  system_listing_save();
  $form = system_module_listing();
  $form .= form_submit(t('Save configuration'));
  return form($form);
}

/**
 * Menu callback; displays a module's settings page.
 */
function system_site_settings($module = NULL) {
  system_settings_save();

  if ($module) {
    $form = module_invoke($module, 'settings');
  }
  else {
    $form = system_view_general();
  }

  return system_settings_form($form);
}

/**
 * Menu callback; display theme configuration for entire site and individual themes.
 */
function system_theme_settings($key = '') {
  // Default settings are defined in theme_get_settings() in includes/theme.inc
  if ($key) {
    $settings = theme_get_settings($key);
    $var = str_replace('/', '_', 'theme_'. $key .'_settings');
    $themes = system_theme_data();
    $features = function_exists($themes[$key]->prefix . '_features') ? call_user_func($themes[$key]->prefix . '_features') : array();
  }
  else {
    $settings = theme_get_settings('');
    $var = 'theme_settings';
  }

  // Check for a new uploaded logo, and use that instead.
  if ($file = file_check_upload('logo_upload')) {
    if ($info = image_get_info($file->filepath)) {
      $parts = pathinfo($file->filename);
      $filename = ($key) ? str_replace('/', '_', $key) . '_logo.' . $parts['extension'] : 'logo.' . $parts['extension'];

      if ($file = file_save_upload('logo_upload', $filename, 1)) {
        $_POST['edit'][$var]['default_logo'] = 0;
        $_POST['edit'][$var]['logo_path'] = $file->filepath;
      }
    }
    else {
      form_set_error('file_upload', t('Only JPEG, PNG and GIF images are allowed to be used as logos.'));
    }
  }

  // Check for a new uploaded favicon, and use that instead.
  if ($file = file_check_upload('favicon_upload')) {
    $parts = pathinfo($file->filename);
    $filename = ($key) ? str_replace('/', '_', $key) . '_favicon.' . $parts['extension'] : 'favicon.' . $parts['extension'];

    if ($file = file_save_upload('favicon_upload', $filename, 1)) {
      $_POST['edit'][$var]['default_favicon'] = 0;
      $_POST['edit'][$var]['favicon_path'] = $file->filepath;
    }
  }

  system_settings_save();

  $form = '';

  // Logo settings
  if ((!$key) || in_array('logo', $features)) {
    $group = form_checkbox(t('Use the default logo'), "$var][default_logo", 1, $settings['default_logo'], t('Check here if you want the theme to use the logo supplied with it.'));
    $group .= form_textfield(t('Path to custom logo'), "$var][logo_path", $settings['logo_path'], 60, 128, t('The path to the file you would like to use as your logo file instead of the default logo.'));

    $directory_path = variable_get('file_directory_path', 'files');
    file_check_directory($directory_path, FILE_CREATE_DIRECTORY, 'file_directory_path');
    $group .= form_file(t('Upload logo image'), 'logo_upload', 40, t("If you don't have direct file access to the server, use this field to upload your logo."));

    $form .= form_group(t('Logo image settings'), $group);
  }

  // Icon settings
  if ((!$key) || in_array('toggle_favicon', $features)) {
    $group = t('Your shortcut icon or \'favicon\' is displayed in the address bar and bookmarks of most browsers.');
    $group .= form_checkbox(t('Use the default shortcut icon.'), "$var][default_favicon", 1, $settings['default_favicon'], t('Check here if you want the theme to use the default shortcut icon.'));
    $group .= form_textfield(t('Path to custom icon'), "$var][favicon_path", $settings['favicon_path'], 60, 128, t('The path to the image file you would like to use as your custom shortcut icon.'));

    $directory_path = variable_get('file_directory_path', 'files');
    file_check_directory($directory_path, FILE_CREATE_DIRECTORY, 'file_directory_path');
    $group .= form_file(t('Upload icon image'), 'favicon_upload', 40, t("If you don't have direct file access to the server, use this field to upload your shortcut icon."));

    $form .= form_group(t('Shortcut icon settings'), $group);
  }

  // System wide only settings.
  if (!$key) {
    // Menu settings

    $header = array(t('link text'), t('url'), t('description'));
    foreach (array('Primary', 'Secondary') as $utype) {
      $group = '';
      $rows = array();

      // Use $utype field , and strtolower() it to get the type field.. to avoid issues with ucfirst() and unicode.
      $type = drupal_strtolower($utype);
      $value = $settings[$type . '_links'];
      if (!is_array($value)) {
        $value = array();
      }

      // Increment the link count, if the user has requested more links.
      if (variable_get($type . '_links_more', false)) {
        variable_del($type . '_links_more');
        variable_set($type . '_link_count', variable_get($type . '_link_count', 5) + 5);
      }

      // Get the amount of links to show, possibly expanding if there are more links defined than the count specifies.
      $count = variable_get($type . '_link_count', 5);
      $count = ($count > sizeof($value['link'])) ? $count : sizeof($value['link']);
      if (variable_get($type . '_link_count', 5) != $count) {
        variable_set($type . '_link_count', $count);
      }

      for ($i = 0; $i < $count; $i++) {
        $row = array();
        foreach (array('text', 'link', 'description') as $field) {
          $row[] = form_textfield('', $var . '][' . $type . '_links][' . $field . '][' . $i, $value[$field][$i], 15, 90);
        }
        $rows[] = $row;
      }

      $group .= form_item('', theme("table", $header, $rows), t('You can specify your _TYPE_ links here, one link per line.<br /> The link text field is the text you want to link.<br /> The url field is the location the link points to.<br /> The description field is an optional description of where the link points.', array('_TYPE_' => $type)));
      $group .= form_checkbox(t('I need more _TYPE_ links.', array('_TYPE_' => $type)), $type . '_links_more', 1, FALSE, t('Checking this box will give you 5 additional _TYPE_ links.', array('_TYPE_' => $type)));
      $form .= form_group(t('_TYPE_ link settings', array('_TYPE_' => $utype)), $group);
    }

    // Toggle node display.
    $node_types = module_invoke('node', 'get_types');
    if ($node_types) {
      $group = '';
      foreach ($node_types as $type => $name) {
        $group .= form_checkbox($name, "$var][toggle_node_info_$type", 1, $settings["toggle_node_info_$type"]);
      }
      $form .= form_group(t('Display post information on'), $group, t('Enable or disable the "submitted by Username on date" text when displaying posts of the above type'));
    }
  }

  $group = '';

  // Toggle settings
  $toggles = array(
    'toggle_name'                 => t('Site name'),
    'toggle_slogan'               => t('Site slogan'),
    'toggle_mission'              => t('Mission statement'),
    'toggle_primary_links'        => t('Primary links'),
    'toggle_secondary_links'      => t('Secondary links'),
    'toggle_node_user_picture'    => t('User pictures in posts'),
    'toggle_comment_user_picture' => t('User pictures in comments'),
    'toggle_search'               => t('Search box'),
    'toggle_favicon'              => t('Shortcut icon')
  );

  // Some features are not always available
  $disabled = array();
  if (!variable_get('user_pictures', 0)) {
    $disabled['toggle_node_user_picture'] = true;
    $disabled['toggle_comment_user_picture'] = true;
  }
  if (!module_exist('search')) {
    $disabled['toggle_search'] = true;
  }

  foreach ($toggles as $name => $title) {
    if ((!$key) || in_array($name, $features)) {
      // disable search box if search.module is disabled
      $group .= form_checkbox($title, "$var][$name", 1, $settings[$name], NULL, isset($disabled[$name]) ? array('disabled' => 'disabled') : NULL);
    }
  }
  if ($group) {
    $form .= form_group(t('Toggle display'), $group, t('Enable or disable the display of certain page elements.'));
  }

  if ($key) {
    // Template-specific settings
    $function = $themes[$key]->prefix .'_settings';
    if (function_exists($function)) {
      $group = $function();
      if ($themes[$key]->template) {
        // file is a template or a style of a template
        $form .= form_group(t('Engine-specific settings'), $group, t('These settings only exist for all the templates and styles based on the %engine theme engine.', array('%engine' => $themes[$key]->prefix)));
      }
      else {
        // file is a theme or a style of a theme
        $form .= form_group(t('Theme-specific settings'), $group, t('These settings only exist for the %theme theme and all the styles based on it.', array('%theme' => $themes[$key]->prefix)));
      }
    }
  }
  $form .= form_submit(t('Save configuration'));
  $form .= form_submit(t('Reset to defaults'));

  return form($form, 'post', null, array('enctype' => 'multipart/form-data'));

}