system.module 32 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2
// $Id$
Dries's avatar
 
Dries committed
3

Dries's avatar
 
Dries committed
4 5 6 7 8
/**
 * @file
 * Configuration system that lets administrators modify the workings of the site.
 */

Dries's avatar
 
Dries committed
9 10 11 12
/**
 * Implementation of hook_help().
 */
function system_help($section) {
Dries's avatar
 
Dries committed
13
  global $base_url;
Dries's avatar
 
Dries committed
14

15
  switch ($section) {
16
    case 'admin/settings':
Dries's avatar
 
Dries committed
17 18
      return t('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.');
    case 'admin/themes':
Dries's avatar
 
Dries committed
19 20 21 22 23 24
      return t('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.');
    case 'admin/themes/settings':
      return t('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.');
    case 'admin/themes/settings/'. arg(3):
      $theme = array_pop(explode('.', arg(3), 2));
      return t('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.', array('%template' => $theme, '%global' => url('admin/themes/settings')));
Dries's avatar
 
Dries committed
25
    case 'admin/modules':
26
      return t("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 checking throttle.  The auto-throttle functionality must be enabled on the <a href=\"%throttle\">throttle configuration page</a> after having enabled the throttle module.", array('%permissions' => url('admin/user/configure/permission'), '%throttle' => url('admin/settings/throttle')));
Dries's avatar
 
Dries committed
27
    case 'admin/help#system':
Dries's avatar
 
Dries committed
28
      return t("
Dries's avatar
 
Dries committed
29 30 31
      <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>
32
      <p>Whenever %cron-link is accessed, cron will run: it calls the _cron hook in each module allowing the module to run tasks if they have not been executed in the last <em>n</em> seconds, where n is the period of that task.  When all the tasks are finished, cron is done.</p>
Dries's avatar
 
Dries committed
33 34 35 36
      <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>
37
      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>
Dries's avatar
 
Dries committed
38
      <h3><a id=\"cache\">Cache</a></h3>
Dries's avatar
 
Dries committed
39
      <p>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 cached pages compressed.</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' ));
Dries's avatar
 
Dries committed
40 41
    case 'admin/modules#description':
      return t('Configuration system that lets administrators modify the workings of the site.');
42
  }
Dries's avatar
 
Dries committed
43 44
}

Dries's avatar
 
Dries committed
45 46 47
/**
 * Menu callback; presents system-specific help text from admin/help.
 */
Dries's avatar
 
Dries committed
48
function system_help_page() {
Dries's avatar
 
Dries committed
49
  print theme('page', system_help('admin/help#system'));
Dries's avatar
 
Dries committed
50 51
}

Dries's avatar
 
Dries committed
52 53 54
/**
 * Implementation of hook_perm().
 */
Dries's avatar
 
Dries committed
55
function system_perm() {
56
  return array('administer site configuration', 'access administration pages', 'bypass input data check');
Dries's avatar
 
Dries committed
57 58
}

Dries's avatar
 
Dries committed
59
/**
Dries's avatar
 
Dries committed
60
 * Implementation of hook_menu().
Dries's avatar
 
Dries committed
61
 */
Dries's avatar
 
Dries committed
62 63 64 65 66 67 68 69
function system_menu() {
  $items = array();
  $items[] = array('path' => 'system/files', 'title' => t('file download'),
    'callback' => 'file_download',
    'access' => TRUE,
    'type' => MENU_CALLBACK);

  $access = user_access('administer site configuration');
Dries's avatar
 
Dries committed
70

71
  // Themes:
Dries's avatar
 
Dries committed
72 73
  $items[] = array('path' => 'admin/themes', 'title' => t('themes'),
    'callback' => 'system_themes', 'access' => $access);
Dries's avatar
 
Dries committed
74 75 76 77 78 79 80 81 82 83 84 85 86 87

  $items[] = array('path' => 'admin/themes/select', 'title' => t('select'),
    '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);

88
  foreach (list_themes() as $theme) {
Dries's avatar
 
Dries committed
89 90 91 92
     $path = str_replace('/', '.', $theme->name);
     $items[] = array('path' => 'admin/themes/settings/'. $path, 'title' => basename($theme->name),
     'callback' => 'system_theme_settings', 'access' => $access,
     'type' => MENU_LOCAL_TASK);
Dries's avatar
 
Dries committed
93
  }
Dries's avatar
 
Dries committed
94

Dries's avatar
 
Dries committed
95 96 97 98 99 100
  // 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));
Dries's avatar
 
Dries committed
101
    }
Dries's avatar
 
Dries committed
102
  }
Dries's avatar
 
Dries committed
103 104 105 106
  $items[] = array('path' => 'admin/modules', 'title' => t('modules'),
    'callback' => 'system_modules', 'access' => $access);

  return $items;
Dries's avatar
 
Dries committed
107 108
}

Dries's avatar
 
Dries committed
109 110 111 112 113
/**
 * Implementation of hook_user().
 *
 * Allows users to individually set their theme and time zone.
 */
114 115
function system_user($type, $edit, &$user, $category = NULL) {
  if ($type == 'form' && $category == 'account') {
Dries's avatar
 
Dries committed
116
    if (count($themes = list_themes()) > 1) {
Dries's avatar
 
Dries committed
117
      $rows = array();
Dries's avatar
 
Dries committed
118
      foreach ($themes as $key => $value) {
Dries's avatar
 
Dries committed
119 120 121 122
        $row = array();

        // Screenshot column.
        $screenshot = dirname($value->filename) .'/screenshot.png';
123
        $row[] = file_exists($screenshot) ? theme('image', $screenshot, t('Screenshot for %theme theme', array('%theme' => $value->name)), '', 'class="screenshot"', false) : t('no screenshot');
Dries's avatar
 
Dries committed
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140

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

        // 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;
Dries's avatar
 
Dries committed
141
      }
Dries's avatar
 
Dries committed
142 143
      $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);
Dries's avatar
 
Dries committed
144
    }
145

146
    if (variable_get('configurable_timezones', 1)) {
Steven Wittens's avatar
Steven Wittens committed
147
      $zones = _system_zonelist();
Steven Wittens's avatar
Steven Wittens committed
148
      $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);
Dries's avatar
 
Dries committed
149
    }
150
    return $data;
Dries's avatar
 
Dries committed
151
  }
Dries's avatar
 
Dries committed
152 153
}

Steven Wittens's avatar
Steven Wittens committed
154 155 156 157 158 159 160 161 162 163 164
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;
}

Dries's avatar
 
Dries committed
165
function system_view_general() {
Dries's avatar
 
Dries committed
166
  global $conf;
Dries's avatar
 
Dries committed
167

Dries's avatar
 
Dries committed
168
  // general settings:
Dries's avatar
 
Dries committed
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
  $group  = form_textfield(t('Name'), 'site_name', variable_get('site_name', 'drupal'), 70, 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')), 70, 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', ''), 70, 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', ''), 70, 5, t('Your site\'s mission statement or focus.'));
  $group .= form_textarea(t('Footer message'), 'site_footer', variable_get('site_footer', ''), 70, 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'), 70, 70, t('The name used to indicate anonymous users.'));
  $group .= form_textfield(t('Default front page'), 'site_frontpage', variable_get('site_frontpage', 'node'), 70, 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".'));
  $group .= form_textfield(t('Default 403 (access denied) page'), 'site_403', variable_get('site_403', ''), 70, 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', ''), 70, 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_radios(t('Clean URLs'), 'clean_url', variable_get('clean_url', 0), array(t('Disabled'), t('Enabled')), t('Enable or disable clean URLs.  If enabled, you\'ll need <code>ModRewrite</code> support.  See also the <code>.htaccess</code> file in Drupal\'s top-level directory.'));

  // watchdog setting:
  $period = drupal_map_assoc(array(3600, 10800, 21600, 32400, 43200, 86400, 172800, 259200, 604800, 1209600, 2419200), 'format_interval');
  $period['1000000000'] = t('Never');
  $group .= form_select(t('Discard log entries older than'), 'watchdog_clear', variable_get('watchdog_clear', 604800), $period, t('The time watchdog entries should be kept.  Older entries will be automatically discarded.  Requires crontab.'));

  $output = form_group(t('General settings'), $group);
Dries's avatar
 
Dries committed
186

Dries's avatar
 
Dries committed
187
  // caching:
Dries's avatar
 
Dries committed
188
  $group  = form_radios(t('Cache support'), 'cache', variable_get('cache', 0), array(t('Disabled'), t('Enabled')), t('Enable or disable the caching of rendered pages.  When caching is enabled, Drupal will flush the cache when required to make sure updates take effect immediately.  Check the <a href="%documentation">cache documentation</a> for information on Drupal\'s cache system.', array('%documentation' => url('admin/help', NULL, NULL, 'cache'))));
Dries's avatar
 
Dries committed
189

Dries's avatar
 
Dries committed
190
  $output .= form_group(t('Cache settings'), $group);
Dries's avatar
 
Dries committed
191

Dries's avatar
 
Dries committed
192
  // file system:
Dries's avatar
 
Dries committed
193
  $directory_path = variable_get('file_directory_path', 'files');
Dries's avatar
 
Dries committed
194
  file_check_directory($directory_path, FILE_CREATE_DIRECTORY, 'file_directory_path');
Dries's avatar
 
Dries committed
195

Dries's avatar
 
Dries committed
196 197
  $directory_temp = variable_get('file_directory_temp', 'temp');
  file_check_directory(file_create_path($directory_temp), FILE_CREATE_DIRECTORY, 'file_directory_temp');
Dries's avatar
 
Dries committed
198 199

  $group = form_textfield(t('File system path'), 'file_directory_path', $directory_path, 70, 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.'));
Dries's avatar
 
Dries committed
200
  $group .= form_textfield(t('Temporary directory'), 'file_directory_temp', $directory_temp, 70, 255, t('Location where uploaded files will be placed for preview purposes. This directory should be relative to the file system path.'));
Dries's avatar
 
Dries committed
201
  $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 be transferred by Drupal.')), t('This setting can be changed at any time, however, all download URLs will change and there may be unexpected problems so it is not recommended.'));
Dries's avatar
 
Dries committed
202
  $output .= form_group(t('File system settings'), $group);
Dries's avatar
 
Dries committed
203

Dries's avatar
 
Dries committed
204
  // date settings:
Steven Wittens's avatar
Steven Wittens committed
205
  $zones = _system_zonelist();
206

Dries's avatar
 
Dries committed
207
  // date settings: possible date formats
Dries's avatar
 
Dries committed
208 209 210 211 212 213 214 215 216 217
  $dateshort = array('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, 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');
Dries's avatar
 
Dries committed
218 219 220

  // date settings: construct choices for user
  foreach ($dateshort as $f) {
Dries's avatar
 
Dries committed
221
    $dateshortchoices[$f] = format_date(time(), 'custom', $f);
Dries's avatar
 
Dries committed
222 223
  }
  foreach ($datemedium as $f) {
Dries's avatar
 
Dries committed
224
    $datemediumchoices[$f] = format_date(time(), 'custom', $f);
Dries's avatar
 
Dries committed
225 226
  }
  foreach ($datelong as $f) {
Dries's avatar
 
Dries committed
227
    $datelongchoices[$f] = format_date(time(), 'custom', $f);
Dries's avatar
 
Dries committed
228 229
  }

Dries's avatar
 
Dries committed
230 231 232 233 234
  $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.'));
Dries's avatar
 
Dries committed
235

Dries's avatar
 
Dries committed
236
  $output .= form_group(t('Date settings'), $group);
Dries's avatar
 
Dries committed
237

Dries's avatar
 
Dries committed
238 239 240
  return $output;
}

Dries's avatar
 
Dries committed
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
/**
 * Inventory theme engines and insert entries for them into the system table
 */
function system_theme_engine_inventory($directory) {
  $engines = array();

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

  // Find theme engines in the directory and insert into database
  $files = file_scan_directory($directory. '/engines', '\.engine$');

  foreach ($files as $filename => $file) {
    module_set_filename($file->name, $filename);
    module_load($file->name);

    $info->name = $file->name;
    $info->filename = $file->filename;
    $engines[$info->name] = $info;

    db_query('INSERT INTO {system} (name, type, filename, status, throttle, bootstrap) VALUES (\'%s\', \'%s\', \'%s\', %d, %d, %d)', $info->name, 'theme_engine', $filename, 1, 0, 0);
262
  }
Dries's avatar
 
Dries committed
263 264
  return $engines;
}
Dries's avatar
 
Dries committed
265

Dries's avatar
 
Dries committed
266 267 268 269 270
/**
 * Retrieves an array of a particular type of files (specified by $type) in a particular $directory
 * and their current status in the system table.
 */
function system_get_files($search, $type, $directory) {
Dries's avatar
 
Dries committed
271
  // Find files in the directory.
Dries's avatar
 
Dries committed
272
  $files = file_scan_directory($directory, $search);
273

Dries's avatar
 
Dries committed
274 275 276 277 278 279 280
  return $files;
}

/**
 * Retrieves the current status of an array of files in the system table.
 */
function system_get_files_database(&$files, $type) {
Dries's avatar
 
Dries committed
281
  // Extract current files from database.
Dries's avatar
 
Dries committed
282
  $result = db_query('SELECT filename, type, status, throttle FROM {system} WHERE type = \'%s\'', $type);
Dries's avatar
 
Dries committed
283 284 285 286 287
  while ($file = db_fetch_object($result)) {
    if (is_object($files[$file->filename])) {
      foreach ($file as $key => $value) {
        $files[$file->filename]->$key = $value;
      }
288
    }
Dries's avatar
 
Dries committed
289
  }
Dries's avatar
 
Dries committed
290
}
Dries's avatar
 
Dries committed
291

Dries's avatar
 
Dries committed
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
/**
 * Obtains information about each theme in the $files array
 * Also updates the system table
 */
function system_obtain_theme_info($files, $directory) {
  foreach ($files as $filename => $file) {
    if ($file->theme) {
      // file is a style
      $info->description = $file->theme;
      $info->style = TRUE;
    }

    if (strpos($filename, '.theme')) {
      // file is a theme
      module_set_filename($file->name, $filename);
      module_load($file->name);
      $info->description = '';
      $info->prefix = basename($filename, '.theme');
    }
    elseif ($info->style && !$file->engine) {
      $info->prefix = $info->description;
    }
    else {
      // file is a template
      $info->description = $info->style ? $info->description : $file->engine;
      $info->template = TRUE;
      $info->prefix = basename($file->engine, '.engine');
    }

    $info->filename = $filename;
    $info->path = pathinfo($info->filename);
    $info->name = str_replace(array($directory .'/'), '', $info->path['dirname']);
    $info->shortname = basename($info->name);
    $info->screenshot = dirname($info->filename) .'/screenshot.png';

    $info->status = $file->status;
328

Dries's avatar
 
Dries committed
329
    $themes[$info->name] = $info;
330

Dries's avatar
 
Dries committed
331 332 333
    // Update the contents of the system table:
    db_query('DELETE FROM {system} WHERE filename = \'%s\' AND type = \'%s\'', $info->filename, 'theme');
    db_query('INSERT INTO {system} (name, description, type, filename, status, throttle, bootstrap) VALUES (\'%s\', \'%s\', \'%s\', \'%s\', %d, %d, %d)', $info->name, $info->description, 'theme', $info->filename, $info->status, 0, 0);
Dries's avatar
 
Dries committed
334
  }
Dries's avatar
 
Dries committed
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
  return $themes;
}

/**
 * Collect data about all currently available themes
 */
function system_theme_data($directory) {
  // Find theme engines
  $engines = system_theme_engine_inventory($directory);

  // Get current list of themes and their present status in the system table.
  $files = system_get_files('\.theme$', 'theme', $directory);

  // Add templates to the site listing
  foreach ($engines as $engine) {
    foreach (call_user_func($engine->name .'_templates', $directory) as $template) {
      $template_files[$template->filename] = $template;
      $template_files[$template->filename]->engine = $engine->filename;
      foreach ($files as $file) {
        // do not double-insert templates with theme files in their directory
        if (dirname($template->filename) == dirname($file->filename)) {
          unset($template_files[$template->filename]);
        }
      }
    }
  }
  $files = array_merge($files, $template_files);

  // Find styles in each theme's directory.
  foreach ($files as $file) {
    foreach (system_get_files("style.css$", 'theme', dirname($file->filename)) as $style) {
      // do not double-insert themes with css files in their directory
      if (dirname($style->filename) != dirname($file->filename)) {
        $style_files[$style->filename] = $style;
        $path = pathinfo($file->filename);
        $style_files[$style->filename]->theme = str_replace(array($directory .'/'), '', $path['dirname']);
        if ($file->engine) {
          $style_files[$style->filename]->engine = $file->engine;
        }
      }
    }
Dries's avatar
 
Dries committed
376
  }
Dries's avatar
 
Dries committed
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
  $files = array_merge($files, $style_files);

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

  // Build an array of information about each theme for use in displaying the selection table.
  return system_obtain_theme_info($files, $directory);
}

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

  $themes = system_theme_data($directory);
  ksort($themes);

  foreach ($themes as $key => $info) {
    $row = array();

    // Screenshot column.
399
    $row[] = file_exists($info->screenshot) ? theme('image', $info->screenshot, t('Screenshot for %theme theme', array('%theme' => $info->shortname)), '', 'class="screenshot"', false) : t('no screenshot');
Dries's avatar
 
Dries committed
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441

    // Information field.
    $field = '<strong>'. $info->shortname .'</strong>';
    $field .= '<br /><em>themes/'. $key .'</em>';
    $row[] = $field;

    // enabled, default, and operations columns
    $row[] = array('data' => form_checkbox('', 'status]['. $info->filename, 1, $info->status), 'align' => 'center');
    $row[] = array('data' => form_radio('', 'theme_default', $info->filename, (variable_get('theme_default', 'bluemarine') == $key) ? 1 : 0), 'align' => 'center');
    if (function_exists($info->prefix .'_settings') || function_exists($info->prefix .'_features')) {
      $row[] = array('data' => l(t('configure'), 'admin/themes/settings/'. str_replace('/', '.', $key)), '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() {
  $directory = 'modules';

  // Get current list of modules
  $files = system_get_files('\.module$', 'module', $directory);

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

  ksort($files);

  $required = array('modules/admin.module', 'modules/block.module', 'modules/filter.module', 'modules/system.module', 'modules/user.module', 'modules/watchdog.module');
  // the throttle mechanism requires additional modules always be enabled
  $throttle_required = array_merge($required, array('modules/statistics.module', 'modules/throttle.module'));

Dries's avatar
 
Dries committed
442
  $header = array(t('Name'), t('Description'), t('Enabled'), t('Throttle'));
Dries's avatar
 
Dries committed
443 444

  foreach ($files as $filename => $file) {
Dries's avatar
 
Dries committed
445 446 447
    module_set_filename($file->name, $filename);
    module_load($file->name);

Dries's avatar
 
Dries committed
448 449 450 451 452 453 454 455
    $info->name = module_invoke($file->name, 'help', 'admin/modules#name') ? module_invoke($file->name, 'help', 'admin/modules#name') : $file->name;
    $info->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;
Dries's avatar
 
Dries committed
456
      }
457 458
    }

Dries's avatar
 
Dries committed
459
    // Update the contents of the system table:
Dries's avatar
 
Dries committed
460 461
    db_query('DELETE FROM {system} WHERE filename = \'%s\' AND type = \'%s\'', $filename, 'module');
    db_query('INSERT INTO {system} (name, description, type, filename, status, throttle, bootstrap) VALUES (\'%s\', \'%s\', \'%s\', \'%s\', %d, %d, %d)', $info->name, $info->description, 'module', $filename, $file->status, $file->throttle, $bootstrap);
462

Dries's avatar
 
Dries committed
463 464
    $row = array($info->name, $info->description, array('data' => (in_array($filename, $required) ? form_hidden('status]['. $filename, 1) . t('required') : form_checkbox('', 'status]['. $filename, 1, $file->status)), 'align' => 'center'));
    $row[] = array('data' => (in_array($filename, $throttle_required) ? form_hidden('throttle]['. $filename, 0) . t('required') : form_checkbox(NULL, 'throttle]['. $filename, 1, $file->throttle, NULL, module_exist('throttle') ? NULL : array('disabled' => 'disabled'))), 'align' => 'center');
Dries's avatar
 
Dries committed
465
    $rows[] = $row;
466
  }
Dries's avatar
 
Dries committed
467

Dries's avatar
 
Dries committed
468
  $output  = theme('table', $header, $rows);
Dries's avatar
 
Dries committed
469
  $output .= form_hidden('type', 'module');
Dries's avatar
 
Dries committed
470

Dries's avatar
 
Dries committed
471
  return $output;
Dries's avatar
 
Dries committed
472
}
Dries's avatar
 
Dries committed
473

474
function system_listing_save($edit = array()) {
Dries's avatar
 
Dries committed
475 476
  $op = $_POST['op'];
  $edit = $_POST['edit'];
Dries's avatar
 
Dries committed
477

Dries's avatar
 
Dries committed
478 479 480
  if ($op == t('Save configuration')) {
    db_query("UPDATE {system} SET status = 0 WHERE type = '%s'", $edit['type']);
    foreach ($edit['status'] as $filename => $status) {
Dries's avatar
 
Dries committed
481 482 483 484 485
      // Make certain that the default theme is enabled to avoid user error
      if (($edit['type'] == 'theme') && ($edit['theme_default'] == $filename)) {
        $status = 1;
      }

Dries's avatar
 
Dries committed
486
      db_query("UPDATE {system} SET status = %d, throttle = %d WHERE filename = '%s'", $status, $edit['throttle'][$filename], $filename);
Dries's avatar
 
Dries committed
487
    }
Dries's avatar
 
Dries committed
488
    if ($edit['type'] == 'theme') {
Dries's avatar
 
Dries committed
489 490 491
      $path = pathinfo($edit['theme_default']);
      $name = str_replace(array('themes/'), '', $path['dirname']);
      variable_set('theme_default', $name);
492 493 494 495
    }

    cache_clear_all();

Dries's avatar
 
Dries committed
496
    drupal_set_message(t('The configuration options have been saved.'));
Steven Wittens's avatar
Steven Wittens committed
497
    drupal_goto($_GET['q']);
498 499 500 501
  }
}

function system_settings_form($form) {
Dries's avatar
 
Dries committed
502 503
  $form .= form_submit(t('Save configuration'));
  $form .= form_submit(t('Reset to defaults'));
504 505 506 507 508

  return form($form);
}

function system_settings_save() {
Dries's avatar
 
Dries committed
509 510
  $op = $_POST['op'];
  $edit = $_POST['edit'];
Dries's avatar
 
Dries committed
511

Dries's avatar
 
Dries committed
512
  if ($op == t('Reset to defaults')) {
513 514 515
    foreach ($edit as $name => $value) {
      variable_del($name);
    }
Dries's avatar
 
Dries committed
516
    drupal_set_message(t('The configuration options have been reset to their default values.'));
517
  }
Dries's avatar
 
Dries committed
518
  if ($op == t('Save configuration')) {
519 520
    foreach ($edit as $name => $value) {
      variable_set($name, $value);
Dries's avatar
 
Dries committed
521
    }
Dries's avatar
 
Dries committed
522
    drupal_set_message(t('The configuration options have been saved.'));
523 524 525 526
  }
  else {
    return;
  }
Dries's avatar
 
Dries committed
527

528
  cache_clear_all();
Steven Wittens's avatar
Steven Wittens committed
529
  drupal_goto($_GET['q']);
530 531
}

Dries's avatar
 
Dries committed
532 533 534 535 536
/**
 * Menu callback; displays a listing of all themes.
 */
function system_themes() {
  system_listing_save();
Dries's avatar
 
Dries committed
537
  $form = system_theme_listing();
Dries's avatar
 
Dries committed
538 539 540 541 542 543 544 545 546
  $form .= form_submit(t('Save configuration'));
  print theme('page', form($form));
}

/**
 * Menu callback; displays a listing of all modules.
 */
function system_modules() {
  system_listing_save();
Dries's avatar
 
Dries committed
547
  $form = system_module_listing();
Dries's avatar
 
Dries committed
548 549 550 551
  $form .= form_submit(t('Save configuration'));
  print theme('page', form($form));
}

552
/**
Dries's avatar
 
Dries committed
553
 * Menu callback; displays a module's settings page.
554
 */
Dries's avatar
 
Dries committed
555
function system_site_settings($module = NULL) {
556 557
  system_settings_save();

Dries's avatar
 
Dries committed
558 559 560 561 562
  if ($module) {
    $form = module_invoke($module, 'settings');
  }
  else {
    $form = system_view_general();
563 564 565 566 567
  }

  print theme('page', system_settings_form($form));
}

Dries's avatar
 
Dries committed
568
/**
Dries's avatar
 
Dries committed
569
 * Menu callback; display theme configuration for entire site and individual themes.
Dries's avatar
 
Dries committed
570
 */
Dries's avatar
 
Dries committed
571
function system_theme_settings() {
Dries's avatar
 
Dries committed
572
  system_settings_save();
Dries's avatar
 
Dries committed
573 574 575
  // Default settings are defined in _theme_settings() in includes/theme.inc
  $key = str_replace('.', '/', arg(3));
  if ($key) {
576
    $settings = theme_get_settings($key);
Dries's avatar
 
Dries committed
577 578 579
    $var = str_replace('/', '_', 'theme_'. $key .'_settings');
    $themes = system_theme_data('themes');
    $features = function_exists($themes[$key]->prefix .'_features') ? call_user_func($themes[$key]->prefix .'_features') : array();
Dries's avatar
 
Dries committed
580 581
  }
  else {
582
    $settings = theme_get_settings('');
Dries's avatar
 
Dries committed
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
    $var = 'theme_settings';
  }

  $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'], 50, 60, t('The path to the file you would like to use as your logo file instead of the default logo.'));
    $form = form_group(t('Logo image settings'), $group);
  }

  // System wide only settings.
  if (!$key) {
    // Menu settings
    $group = form_textarea(t('Primary links'), "$var][primary_links", $settings['primary_links'], 70, 8, t('The HTML code for the primary links. If this field is empty, Drupal will automatically generate a set of links based on which modules are enabled.'));
    $group .= form_textarea(t('Secondary links'), "$var][secondary_links", $settings['secondary_links'], 70, 8, t('The HTML code for the secondary links.'));
    $form .= form_group(t('Menu Settings'), $group, t('Customize the menus that are displayed at the top and/or bottom of the page. This configuration screen is only available in the site wide display configuration.'));

    // Toggle node display.
    $group = '';
    foreach (node_list() as $type) {
      $group .= form_checkbox($type, "$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_search' => t('Search box'),
        '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'));

  foreach ($toggles as $name => $title) {
    if ((!$key) || in_array($name, $features)) {
      $group .= form_checkbox($title, "$var][$name", 1, $settings[$name]);
    }
  }
  if ($group) {
    $form .= form_group(t('Toggle display'), $group, t('Enable or disable the display of certain page elements.'));
  }

  if ($key) {
    // Template-specific settings
Dries's avatar
 
Dries committed
633
    $function = $themes[$key]->prefix .'_settings';
Dries's avatar
 
Dries committed
634 635 636 637 638 639 640 641 642
    if (function_exists($function)) {
      $group = $function();
      if (strpos($themes[$key]->description, '.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)));
      }
      else {
        $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)));
      }
    }
Dries's avatar
 
Dries committed
643 644 645
  }

  print theme('page', system_settings_form($form));
Dries's avatar
 
Dries committed
646
}
Dries's avatar
 
Dries committed
647

Dries's avatar
 
Dries committed
648
?>