system.module 36.2 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
17
    case 'admin':
      return t('<p>Welcome to the administration section. Below are the most recent system events.</p>');
18
    case 'admin/settings':
19
      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>');
Dries's avatar
   
Dries committed
20
    case 'admin/themes':
21
      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.</p>');
Dries's avatar
   
Dries committed
22
    case 'admin/themes/settings':
23
      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>');
Dries's avatar
   
Dries committed
24
25
    case 'admin/themes/settings/'. arg(3):
      $theme = array_pop(explode('.', arg(3), 2));
26
      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')));
Dries's avatar
   
Dries committed
27
    case 'admin/modules':
28
      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')));
Dries's avatar
   
Dries committed
29
    case 'admin/help#system':
Dries's avatar
   
Dries committed
30
      return t("
Dries's avatar
   
Dries committed
31
32
33
34
35
36
37
      <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>
38
      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' ));
Dries's avatar
   
Dries committed
39
    case 'admin/modules#description':
40
      return t('Handles general site configuration for administrators.');
41
  }
Dries's avatar
   
Dries committed
42
43
}

Dries's avatar
   
Dries committed
44
45
46
/**
 * Implementation of hook_perm().
 */
Dries's avatar
   
Dries committed
47
function system_perm() {
48
  return array('administer site configuration', 'access administration pages', 'bypass input data check');
Dries's avatar
   
Dries committed
49
50
}

Dries's avatar
   
Dries committed
51
/**
Dries's avatar
   
Dries committed
52
 * Implementation of hook_menu().
Dries's avatar
   
Dries committed
53
 */
Dries's avatar
   
Dries committed
54
function system_menu($may_cache) {
Dries's avatar
   
Dries committed
55
  $items = array();
Dries's avatar
   
Dries committed
56

Dries's avatar
   
Dries committed
57
58
59
60
61
62
  if ($may_cache) {
    $items[] = array('path' => 'system/files', 'title' => t('file download'),
      'callback' => 'file_download',
      'access' => TRUE,
      'type' => MENU_CALLBACK);

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

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

71
72
    $items[] = array('path' => 'admin', 'title' => t('administer'),
      'access' => user_access('access administration pages'),
Dries's avatar
   
Dries committed
73
      'callback' => 'watchdog_overview',
74
75
      'weight' => 9);

Dries's avatar
   
Dries committed
76
77
78
79
    // Themes:
    $items[] = array('path' => 'admin/themes', 'title' => t('themes'),
      'callback' => 'system_themes', 'access' => $access);

Dries's avatar
   
Dries committed
80
    $items[] = array('path' => 'admin/themes/select', 'title' => t('list'),
Dries's avatar
   
Dries committed
81
82
83
84
85
86
87
88
89
90
91
92
93
      '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) {
Dries's avatar
   
Dries committed
94
       $items[] = array('path' => 'admin/themes/settings/'. $theme->name, 'title' => $theme->name,
95
       'callback' => 'system_theme_settings', 'callback arguments' => array($theme->name), 'access' => $access,
Dries's avatar
   
Dries committed
96
97
98
99
100
101
102
103
104
105
       '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));
      }
Dries's avatar
   
Dries committed
106
    }
Dries's avatar
   
Dries committed
107
108
    $items[] = array('path' => 'admin/modules', 'title' => t('modules'),
      'callback' => 'system_modules', 'access' => $access);
Dries's avatar
   
Dries committed
109
  }
Dries's avatar
   
Dries committed
110
111

  return $items;
Dries's avatar
   
Dries committed
112
113
}

114
115
116
117
/**
 * Menu callback: dummy clean URL tester.
 */
function system_test() {
118
119
  variable_set('clean_url_ok', 1);
  exit;
120
121
}

Dries's avatar
   
Dries committed
122
123
124
125
126
/**
 * Implementation of hook_user().
 *
 * Allows users to individually set their theme and time zone.
 */
127
128
function system_user($type, $edit, &$user, $category = NULL) {
  if ($type == 'form' && $category == 'account') {
129
130
131
132
133
134
135
136
137
138
    $allthemes = list_themes();

    // list only active themes
    foreach ($allthemes as $key => $theme) {
      if ($theme->status) {
        $themes[$key] = $theme;
      }
    }

    if (count($themes) > 1) {
Dries's avatar
   
Dries committed
139
      $rows = array();
Dries's avatar
   
Dries committed
140
      foreach ($themes as $key => $value) {
Dries's avatar
   
Dries committed
141
142
143
144
        $row = array();

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

        // Information field.
Dries's avatar
   
Dries committed
148
        $field = '<strong>'. $value->name .'</strong>';
Dries's avatar
   
Dries committed
149
150
151
152
153
154
155
156
157
158
159
160
161
162
        $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
163
      }
Dries's avatar
   
Dries committed
164
165
      $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
166
    }
167

168
    if (variable_get('configurable_timezones', 1)) {
Steven Wittens's avatar
Steven Wittens committed
169
      $zones = _system_zonelist();
Steven Wittens's avatar
Steven Wittens committed
170
      $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
171
    }
172
    return $data;
Dries's avatar
   
Dries committed
173
  }
Dries's avatar
   
Dries committed
174
175
}

Steven Wittens's avatar
Steven Wittens committed
176
177
178
179
180
181
182
183
184
185
186
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
187
function system_view_general() {
Dries's avatar
   
Dries committed
188
  global $conf;
Dries's avatar
   
Dries committed
189

190
  // General settings:
Dries's avatar
   
Dries committed
191
192
193
194
195
196
197
  $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".'));
198

199
200
201
202
203
204
  // 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="" />';
Dries's avatar
   
Dries committed
205

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

208
  // Error handling:
Dries's avatar
   
Dries committed
209
210
  $period = drupal_map_assoc(array(3600, 10800, 21600, 32400, 43200, 86400, 172800, 259200, 604800, 1209600, 2419200), 'format_interval');
  $period['1000000000'] = t('Never');
Dries's avatar
   
Dries committed
211
212
  $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.'));
Steven Wittens's avatar
Steven Wittens committed
213
  $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.'));
Dries's avatar
   
Dries committed
214
  $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.'));
Dries's avatar
   
Dries committed
215

Dries's avatar
   
Dries committed
216
  $output .= form_group(t('Error handling'), $group);
Dries's avatar
   
Dries committed
217

218
  // Caching:
219
  $group  = form_radios(t('Page cache'), 'cache', variable_get('cache', CACHE_DISABLED), array(CACHE_DISABLED => t('Disabled (low-traffic sites)'), CACHE_ENABLED_STRICT => t('Strict (medium-traffic sites)'), CACHE_ENABLED_LOOSE => t('Loose (high-traffic sites)')), 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 cached pages compressed.  Drupal supports strict caching and loose caching.  Strict caching immediately deletes cached data as soon as it becomes invalid for any user.  Loose caching delays the deletion of cached data to provide better performance for high traffic sites."));
Dries's avatar
   
Dries committed
220

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

223
  // File system:
Dries's avatar
   
Dries committed
224
  $directory_path = variable_get('file_directory_path', 'files');
Dries's avatar
   
Dries committed
225
  file_check_directory($directory_path, FILE_CREATE_DIRECTORY, 'file_directory_path');
Dries's avatar
   
Dries committed
226

Steven Wittens's avatar
Steven Wittens committed
227
  $directory_temp = variable_get('file_directory_temp', FILE_DIRECTORY_TEMP);
228
  file_check_directory($directory_temp, FILE_CREATE_DIRECTORY, 'file_directory_temp');
Dries's avatar
   
Dries committed
229
230

  $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.'));
Steven Wittens's avatar
Steven Wittens committed
231
  $group .= form_textfield(t('Temporary directory'), 'file_directory_temp', $directory_temp, 70, 255, t('Location where uploaded files will be kept during previews. Relative paths will be resolved relative to the file system path.'));
232
  $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.'));
Dries's avatar
   
Dries committed
233
  $output .= form_group(t('File system settings'), $group);
Dries's avatar
   
Dries committed
234

235
  // Image handling:
236
237
238
  $group = '';
  $toolkits_available = image_get_available_toolkits();
  if (count($toolkits_available) > 1) {
239
      $group .= form_radios(t('Select an image processing toolkit'), 'image_toolkit', variable_get('image_toolkit', image_get_toolkit()), $toolkits_available);
240
  }
241
242
243
  $group .= image_toolkit_invoke('settings');
  if ($group) {
    $output .= form_group(t('Image handling'), $group);
244
245
  }

246
  // Date settings:
Steven Wittens's avatar
Steven Wittens committed
247
  $zones = _system_zonelist();
248

249
  // Date settings: possible date formats
Dries's avatar
   
Dries committed
250
  $dateshort = array('Y-m-d H:i','m/d/Y - H:i', 'd/m/Y - H:i', 'Y/m/d - H:i',
Dries's avatar
   
Dries committed
251
252
253
           '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');
Dries's avatar
   
Dries committed
254
255
  $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',
Dries's avatar
   
Dries committed
256
257
258
259
          '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
260

261
  // Date settings: construct choices for user
Dries's avatar
   
Dries committed
262
  foreach ($dateshort as $f) {
Dries's avatar
   
Dries committed
263
    $dateshortchoices[$f] = format_date(time(), 'custom', $f);
Dries's avatar
   
Dries committed
264
265
  }
  foreach ($datemedium as $f) {
Dries's avatar
   
Dries committed
266
    $datemediumchoices[$f] = format_date(time(), 'custom', $f);
Dries's avatar
   
Dries committed
267
268
  }
  foreach ($datelong as $f) {
Dries's avatar
   
Dries committed
269
    $datelongchoices[$f] = format_date(time(), 'custom', $f);
Dries's avatar
   
Dries committed
270
271
  }

Dries's avatar
   
Dries committed
272
273
274
275
276
  $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.'));
277
  $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.'));
Dries's avatar
   
Dries committed
278

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

Dries's avatar
   
Dries committed
281
282
283
  return $output;
}

Dries's avatar
   
Dries committed
284
285
286
287
/**
 * 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
288
  // Extract current files from database.
Dries's avatar
Dries committed
289
  $result = db_query("SELECT name, type, status, throttle FROM {system} WHERE type = '%s'", $type);
Dries's avatar
   
Dries committed
290
  while ($file = db_fetch_object($result)) {
Dries's avatar
Dries committed
291
    if (is_object($files[$file->name])) {
Dries's avatar
   
Dries committed
292
      foreach ($file as $key => $value) {
Dries's avatar
Dries committed
293
294
295
        if (!$files[$file->name]->$key) {
          $files[$file->name]->$key = $value;
        }
Dries's avatar
   
Dries committed
296
      }
297
    }
Dries's avatar
   
Dries committed
298
  }
Dries's avatar
   
Dries committed
299
}
Dries's avatar
   
Dries committed
300

Dries's avatar
   
Dries committed
301
302
303
/**
 * Collect data about all currently available themes
 */
Dries's avatar
Dries committed
304
305
306
307
function system_theme_data() {
  // Find themes
  $themes = system_listing('\.theme$', 'themes');

Dries's avatar
   
Dries committed
308
  // Find theme engines
Dries's avatar
Dries committed
309
310
311
312
313
314
315
316
317
  $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;
  }
Dries's avatar
   
Dries committed
318

Dries's avatar
Dries committed
319
320
  // Remove all theme engines from the system table
  db_query("DELETE FROM {system} WHERE type = 'theme_engine'");
Dries's avatar
   
Dries committed
321
322

  foreach ($engines as $engine) {
Dries's avatar
   
Dries committed
323
    // Insert theme engine into system table
Dries's avatar
Dries committed
324
325
326
327
    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);

Dries's avatar
   
Dries committed
328
    // Add templates to the site listing
Dries's avatar
Dries committed
329
330
331
332
333
    foreach (call_user_func($engine->name . '_templates') as $template) {
      $template->template = TRUE;
      $template->name = basename(dirname($template->filename));
      $template->owner = $engine->filename;
      $template->prefix = $engine->name;
Dries's avatar
   
Dries committed
334
      // do not double-insert templates with theme files in their directory
Dries's avatar
   
Dries committed
335
336
      if (array_key_exists($template->name, $themes)) {
        continue;
Dries's avatar
   
Dries committed
337
      }
Dries's avatar
Dries committed
338
      $themes[$template->name] = $template;
Dries's avatar
   
Dries committed
339
340
341
342
    }
  }

  // Find styles in each theme's directory.
Dries's avatar
Dries committed
343
344
  foreach ($themes as $theme) {
    foreach (file_scan_directory(dirname($theme->filename), 'style.css$') as $style) {
Dries's avatar
   
Dries committed
345
346
347
348
349
350
351
352
      $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;
Dries's avatar
   
Dries committed
353
      }
Dries's avatar
   
Dries committed
354
      $themes[$style->name] = $style;
Dries's avatar
   
Dries committed
355
    }
Dries's avatar
   
Dries committed
356
  }
Dries's avatar
   
Dries committed
357
358

  // Extract current files from database.
Dries's avatar
Dries committed
359
360
361
  system_get_files_database($themes, 'theme');

  db_query("DELETE FROM {system} WHERE type = 'theme'");
Dries's avatar
   
Dries committed
362

Dries's avatar
Dries committed
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
  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;
}

/**
 * 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().
387
388
 * @param $min_depth
 *   Minimum depth of directories to return files from.
Dries's avatar
Dries committed
389
390
391
392
 *
 * @return
 *   An array of file objects of the specified type.
 */
393
function system_listing($mask, $directory, $key = 'name', $min_depth = 1) {
Dries's avatar
Dries committed
394
395
396
397
398
399
400
401
402
403
  $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) {
404
    $files = array_merge($files, file_scan_directory($dir, $mask, array('.', '..', 'CVS'), 0, TRUE, $key, $min_depth));
Dries's avatar
Dries committed
405
406
407
  }

  return $files;
Dries's avatar
   
Dries committed
408
409
410
411
412
413
}

/**
 * Generate a list of all the available theme/style combinations.
 */
function system_theme_listing() {
Dries's avatar
Dries committed
414
  $themes = system_theme_data();
Dries's avatar
   
Dries committed
415
416
  ksort($themes);

Dries's avatar
   
Dries committed
417
  foreach ($themes as $info) {
Dries's avatar
Dries committed
418
    $info->screenshot = dirname($info->filename) . '/screenshot.png';
Dries's avatar
   
Dries committed
419
420
421
    $row = array();

    // Screenshot column.
422
    $row[] = file_exists($info->screenshot) ? theme('image', $info->screenshot, t('Screenshot for %theme theme', array('%theme' => $info->name)), '', array('class' => 'screenshot'), false) : t('no screenshot');
Dries's avatar
   
Dries committed
423
424

    // Information field.
Dries's avatar
   
Dries committed
425
    $row[] = "<strong>$info->name</strong><br /><em>" . dirname($info->filename) . '</em>';
Dries's avatar
   
Dries committed
426
427

    // enabled, default, and operations columns
Dries's avatar
Dries committed
428
    $row[] = array('data' => form_checkbox('', 'status]['. $info->name, 1, $info->status), 'align' => 'center');
Dries's avatar
   
Dries committed
429
    $row[] = array('data' => form_radio('', 'theme_default', $info->name, (variable_get('theme_default', 'bluemarine') == $info->name) ? 1 : 0), 'align' => 'center');
Dries's avatar
Dries committed
430
    if (function_exists($info->prefix . '_settings') || function_exists($info->prefix . '_features')) {
Dries's avatar
   
Dries committed
431
      $row[] = array('data' => l(t('configure'), 'admin/themes/settings/' . $info->name), 'align' => 'center');
Dries's avatar
   
Dries committed
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
    }
    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
450
  $files = system_listing('\.module$', 'modules', 'name', 0);
Dries's avatar
   
Dries committed
451
452
453
454
455
456

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

  ksort($files);

457
  $required = array('block', 'filter', 'system', 'user', 'watchdog');
Dries's avatar
Dries committed
458
  $throttle_required = array_merge($required, array('throttle'));
Dries's avatar
   
Dries committed
459

Dries's avatar
   
Dries committed
460
461
462
463
  $header = array(t('Name'), t('Description'), t('Enabled'));
  if (module_exist('throttle')) {
    $header[] = t('Throttle');
  }
Dries's avatar
   
Dries committed
464
465

  foreach ($files as $filename => $file) {
Dries's avatar
Dries committed
466
467
468
469
    drupal_get_filename('module', $file->name, $file->filename);
    drupal_load('module', $file->name);

    $file->description = module_invoke($file->name, 'help', 'admin/modules#description');
Dries's avatar
   
Dries committed
470

Dries's avatar
   
Dries committed
471
472
473
474
475
476
    // 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
477
      }
478
479
    }

Dries's avatar
   
Dries committed
480
    // Update the contents of the system table:
Dries's avatar
Dries committed
481
482
    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);
483

Dries's avatar
Dries committed
484
    $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'));
Dries's avatar
   
Dries committed
485
    if (module_exist('throttle')) {
Dries's avatar
Dries committed
486
      $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');
Dries's avatar
   
Dries committed
487
    }
Dries's avatar
   
Dries committed
488
    $rows[] = $row;
489
  }
Dries's avatar
   
Dries committed
490

Dries's avatar
   
Dries committed
491
  $output  = theme('table', $header, $rows);
Dries's avatar
   
Dries committed
492
  $output .= form_hidden('type', 'module');
Dries's avatar
   
Dries committed
493

Dries's avatar
   
Dries committed
494
  return $output;
Dries's avatar
   
Dries committed
495
}
Dries's avatar
   
Dries committed
496

497
function system_listing_save($edit = array()) {
Dries's avatar
   
Dries committed
498
499
  $op = $_POST['op'];
  $edit = $_POST['edit'];
Dries's avatar
   
Dries committed
500

Dries's avatar
   
Dries committed
501
502
  if ($op == t('Save configuration')) {
    db_query("UPDATE {system} SET status = 0 WHERE type = '%s'", $edit['type']);
Dries's avatar
Dries committed
503
    foreach ($edit['status'] as $name => $status) {
Dries's avatar
   
Dries committed
504
      // Make certain that the default theme is enabled to avoid user error
Dries's avatar
Dries committed
505
      if (($edit['type'] == 'theme') && ($edit['theme_default'] == $name)) {
Dries's avatar
   
Dries committed
506
507
508
        $status = 1;
      }

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

Dries's avatar
   
Dries committed
512
    if ($edit['type'] == 'theme') {
Dries's avatar
Dries committed
513
      variable_set('theme_default', $edit['theme_default']);
514
515
516
    }

    cache_clear_all();
Dries's avatar
   
Dries committed
517
    menu_rebuild();
518

Dries's avatar
   
Dries committed
519
    drupal_set_message(t('The configuration options have been saved.'));
Steven Wittens's avatar
Steven Wittens committed
520
    drupal_goto($_GET['q']);
521
522
523
524
  }
}

function system_settings_form($form) {
Dries's avatar
   
Dries committed
525
526
  $form .= form_submit(t('Save configuration'));
  $form .= form_submit(t('Reset to defaults'));
527
528
529
530
531

  return form($form);
}

function system_settings_save() {
Dries's avatar
   
Dries committed
532
533
  $op = $_POST['op'];
  $edit = $_POST['edit'];
Dries's avatar
   
Dries committed
534

Dries's avatar
   
Dries committed
535
  if ($op == t('Reset to defaults')) {
Dries's avatar
   
Dries committed
536
537
538
539
    if (is_array($edit)) {
      foreach ($edit as $name => $value) {
        variable_del($name);
      }
540
    }
Dries's avatar
   
Dries committed
541
    drupal_set_message(t('The configuration options have been reset to their default values.'));
542
  }
543
  else if ($op == t('Save configuration')) {
Dries's avatar
   
Dries committed
544
    if (is_array($edit)) {
545
546
547
548
      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;
      }
Dries's avatar
   
Dries committed
549
550
551
      foreach ($edit as $name => $value) {
        variable_set($name, $value);
      }
Dries's avatar
   
Dries committed
552
    }
Dries's avatar
   
Dries committed
553
    drupal_set_message(t('The configuration options have been saved.'));
554
555
556
557
558
  }
  else {
    return;
  }
  cache_clear_all();
Dries's avatar
   
Dries committed
559
  menu_rebuild();
Steven Wittens's avatar
Steven Wittens committed
560
  drupal_goto($_GET['q']);
561
562
}

Dries's avatar
   
Dries committed
563
564
565
566
567
/**
 * Menu callback; displays a listing of all themes.
 */
function system_themes() {
  system_listing_save();
Dries's avatar
   
Dries committed
568
  $form = system_theme_listing();
Dries's avatar
   
Dries committed
569
  $form .= form_submit(t('Save configuration'));
Dries's avatar
   
Dries committed
570
  return form($form);
Dries's avatar
   
Dries committed
571
572
573
574
575
576
577
}

/**
 * Menu callback; displays a listing of all modules.
 */
function system_modules() {
  system_listing_save();
Dries's avatar
   
Dries committed
578
  $form = system_module_listing();
Dries's avatar
   
Dries committed
579
  $form .= form_submit(t('Save configuration'));
Dries's avatar
   
Dries committed
580
  return form($form);
Dries's avatar
   
Dries committed
581
582
}

583
/**
Dries's avatar
   
Dries committed
584
 * Menu callback; displays a module's settings page.
585
 */
Dries's avatar
   
Dries committed
586
function system_site_settings($module = NULL) {
587
588
  system_settings_save();

Dries's avatar
   
Dries committed
589
590
591
592
593
  if ($module) {
    $form = module_invoke($module, 'settings');
  }
  else {
    $form = system_view_general();
594
595
  }

Dries's avatar
   
Dries committed
596
  return system_settings_form($form);
597
598
}

Dries's avatar
   
Dries committed
599
/**
Dries's avatar
   
Dries committed
600
 * Menu callback; display theme configuration for entire site and individual themes.
Dries's avatar
   
Dries committed
601
 */
Dries's avatar
   
Dries committed
602
function system_theme_settings($key = '') {
Dries's avatar
   
Dries committed
603
  system_settings_save();
Dries's avatar
   
Dries committed
604

Dries's avatar
   
Dries committed
605
  // Default settings are defined in theme_get_settings() in includes/theme.inc
Dries's avatar
   
Dries committed
606
  if ($key) {
607
    $settings = theme_get_settings($key);
Dries's avatar
   
Dries committed
608
    $var = str_replace('/', '_', 'theme_'. $key .'_settings');
Dries's avatar
Dries committed
609
610
    $themes = system_theme_data();
    $features = function_exists($themes[$key]->prefix . '_features') ? call_user_func($themes[$key]->prefix . '_features') : array();
Dries's avatar
   
Dries committed
611
612
  }
  else {
613
    $settings = theme_get_settings('');
Dries's avatar
   
Dries committed
614
615
616
    $var = 'theme_settings';
  }

Dries's avatar
   
Dries committed
617
618
  // Check for a new uploaded logo, and use that instead.
  if ($file = file_check_upload('logo_upload')) {
619
    if ($info = image_get_info($file->filepath)) {
Dries's avatar
   
Dries committed
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
      $parts = pathinfo($file->filename);
      $filename = ($key) ? str_replace('/', '_', $key) . '_logo.' . $parts['extension'] : 'logo.' . $parts['extension'];

      if ($file = file_save_upload('logo_upload', $filename, 1)) {
        $settings['default_logo'] = 0;
        $settings['logo_path'] = $file->filepath;

        // Update the variable table with the new settings so that they take effect immediately.
        variable_set($var, $settings);
      }
    }
    else {
      form_set_error('file_upload', t('Only JPEG, PNG and GIF images are allowed to be used as logos.'));
    }
  }


Dries's avatar
   
Dries committed
637
638
639
640
641
  $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.'));
642
    $group .= form_textfield(t('Path to custom logo'), "$var][logo_path", $settings['logo_path'], 50, 128, t('The path to the file you would like to use as your logo file instead of the default logo.'));
Dries's avatar
   
Dries committed
643
644
645
646
647

    file_check_directory(variable_get('file_directory_path', 'files'), 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."));
    $group .= form_button(t('Upload'), 'fileop');

Dries's avatar
   
Dries committed
648
    $form = form_group(t('Logo image settings'), $group);
Dries's avatar
   
Dries committed
649

Dries's avatar
   
Dries committed
650
651
652
653
654
  }

  // System wide only settings.
  if (!$key) {
    // Menu settings
655
656
657
658
659
660

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

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

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

674
      // Get the amount of links to show, possibly expanding if there are more links defined than the count specifies.
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
      $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);
    }
Dries's avatar
   
Dries committed
693
694
695
696

    // Toggle node display.
    $group = '';
    foreach (node_list() as $type) {
697
      $group .= form_checkbox(node_invoke($type, 'node_name'), "$var][toggle_node_info_$type", 1, $settings["toggle_node_info_$type"]);
Dries's avatar
   
Dries committed
698
699
700
701
702
703
704
705
706
707
708
709
710
    }
    $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'),
Dries's avatar
   
Dries committed
711
712
        'toggle_comment_user_picture' => t('User pictures in comments'),
        'toggle_search' => t('Search box'));
Dries's avatar
   
Dries committed
713
714
715

  foreach ($toggles as $name => $title) {
    if ((!$key) || in_array($name, $features)) {
Dries's avatar
   
Dries committed
716
717
      // disable search box if search.module is disabled
      $group .= form_checkbox($title, "$var][$name", 1, $settings[$name], NULL, (!module_exist('search') && $name == 'toggle_search') ? array('disabled' => 'disabled') : NULL);
Dries's avatar
   
Dries committed
718
719
720
721
722
723
724
725
    }
  }
  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
726
    $function = $themes[$key]->prefix .'_settings';
Dries's avatar
   
Dries committed
727
728
    if (function_exists($function)) {
      $group = $function();
Dries's avatar
   
Dries committed
729
730
731
      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)));
Dries's avatar
   
Dries committed
732
733
      }
      else {
Dries's avatar
   
Dries committed
734
735
        // 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)));
Dries's avatar
   
Dries committed
736
737
      }
    }
Dries's avatar
   
Dries committed
738
  }
Dries's avatar
   
Dries committed
739
740
741
  $form .= form_submit(t('Save configuration'));
  $form .= form_submit(t('Reset to defaults'));

Dries's avatar
   
Dries committed
742
  return form($form, 'post', null, array('enctype' => 'multipart/form-data'));
Dries's avatar
   
Dries committed
743

Dries's avatar
   
Dries committed
744
}
Dries's avatar
   
Dries committed
745

Dries's avatar
   
Dries committed
746
?>