Index: modules/system.module
===================================================================
RCS file: /cvs/drupal/drupal/modules/system.module,v
retrieving revision 1.234
diff -u -F^f -u -F^f -r1.234 system.module
--- modules/system.module 13 Sep 2005 19:12:19 -0000 1.234
+++ modules/system.module 13 Sep 2005 20:43:35 -0000
@@ -50,6 +50,35 @@ function system_perm() {
}
/**
+ * Implementation of hook_elements().
+ */
+function system_elements() {
+ // Top level form
+ $type['form'] = array(method => 'POST', action => request_uri());
+
+ // Inputs
+ $type['checkbox'] = array(input => TRUE, return_value => 1);
+ $type['submit'] = array(input => TRUE, name => 'op', button_type => 'submit');
+ $type['button'] = array(input => TRUE, name => 'op', button_type => 'submit');
+ $type['textfield'] = array(input => TRUE, size => 60, maxlength => 70, autocomplete_path => FALSE);
+ $type['password'] = array(input => TRUE, size => 60, maxlength => 70);
+ $type['textarea'] = array(input => TRUE, cols => 60, rows => 20);
+ $type['radios'] = array(input => TRUE, process => 'expand_radios');
+ $type['radio'] = array(input => TRUE);
+ $type['checkboxes'] = array(input => TRUE, process => 'expand_checkboxes');
+ $type['checkbox'] = array(input => TRUE);
+ $type['select'] = array(input => TRUE);
+ $type['weight'] = array(input => TRUE);
+
+ // Form structure
+ $type['item'] = array();
+ $type['hidden'] = array(input => TRUE);
+ $type['markup'] = array(prefix => '', suffix => '');
+ $type['fieldset'] = array(collapsible => FALSE, collapsed => FALSE);
+ return $type;
+}
+
+/**
* Implementation of hook_menu().
*/
function system_menu($may_cache) {
@@ -180,63 +209,136 @@ function _system_zonelist() {
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".'));
+ $form['general'] = array(
+ type => 'fieldset', title => t('General settings'),
+ collapsible => TRUE, collapsed => TRUE
+ );
+ $form['general']['site_name'] = array(
+ type => 'textfield', title => t('Name'), default_value => variable_get('site_name', 'drupal'),
+ description => t('The name of this web site.')
+ );
+ $form['general']['site_mail'] = array(
+ type => 'textfield', title => t('E-mail address'), default_value => variable_get('site_mail', ini_get('sendmail_from')), maxlength => 128,
+ description => t('A valid e-mail address for this website, used by the auto-mailer during registration, new password requests, notifications, etc.')
+ );
+ $form['general']['site_slogan'] = array(
+ type => 'textfield', title => t('Slogan'), default_value => variable_get('site_slogan', ''),
+ maxlength => 128, description => t('The slogan of this website. Some themes display a slogan when available.')
+ );
+
+ $form['general']['site_mission'] = array(
+ type => 'textarea', title => t('Mission'), default_value => variable_get('site_mission', ''),
+ rows => 5, description => t('Your site\'s mission statement or focus.')
+ );
+ $form['general']['site_footer'] = array(
+ type => 'textarea', title => t('Footer message'), default_value => variable_get('site_footer', ''), rows => 5,
+ description => t('This text will be displayed at the bottom of each page. Useful for adding a copyright notice to your pages.')
+ );
+ $form['general']['anonymous'] = array(
+ type => 'textfield', title => t('Anonymous user'), default_value => variable_get('anonymous', 'Anonymous'),
+ description => t('The name used to indicate anonymous users.')
+ );
+ $form['general']['site_frontpage'] = array(
+ type => 'textfield', title => t('Default front page'), default_value => variable_get('site_frontpage', 'node'),
+ description => 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 ?q=
in the URL). You\'ll need ModRewrite
support for this to work. See the .htaccess
file in Drupal\'s top-level directory for more information.'));
+ $form['general']['clean_url'] = array(
+ type => 'radios', title => t('Clean URLs'), default_value => variable_get('clean_url', 0), options => array(t('Disabled'), t('Enabled')),
+ description => t('This option makes Drupal emit clean URLs (i.e. without ?q=
in the URL). You\'ll need ModRewrite
support for this to work. See the .htaccess
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 .= '';
-
- $output = form_group_collapsible(t('General settings'), $group, TRUE);
+ $form['general']['clean_url_test'] = array(type => 'markup', value => '');
// Error handling:
+
+ $form['errors'] = array( type => 'fieldset', title =>t('Error handling'), collapsible => TRUE, collapsed => TRUE );
+ $form['errors']['site_403'] = array(
+ type => 'textfield', title => t('Default 403 (access denied) page'), default_value => variable_get('site_403', ''),
+ description => 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.')
+ );
+
+ $form['errors']['site_404'] = array(
+ type => 'textfield', title => t('Default 404 (not found) page'), default_value => variable_get('site_404', ''),
+ description => 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.')
+ );
+
+ $form['errors']['error_level'] = array(
+ type => 'select', title => t('Error reporting'), default_value => variable_get('error_level', 1),
+ options => array(t('Write errors to the log'), t('Write errors to the log and to the screen')),
+ description => 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.')
+ );
+
$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.'));
+ $form['errors']['watchdog_clear'] = array(
+ type => 'select', title => t('Discard log entries older than'), default_value => variable_get('watchdog_clear', 604800), options => $period,
+ description => 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."));
+ $form['cache'] = array(type => 'fieldset', title => t('Cache settings'), collapsible => TRUE, collapsed => TRUE);
+
+ $form['cache']['cache'] = array(
+ type => 'radios', title => t('Page cache'), default_value => variable_get('cache', CACHE_DISABLED),
+ options => array(CACHE_DISABLED => t('Disabled'), CACHE_ENABLED => t('Enabled')),
+ description => 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.'));
+ $form['cache']['cache_lifetime'] = array(
+ type => 'select', title => t('Minimum cache lifetime'), default_value => variable_get('cache_lifetime', 0), options => $period,
+ description => 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:
+ $form['files'] = array(type => 'fieldset', title => t('File system settings'), collapsible => TRUE, collapsed => TRUE);
+
$directory_path = variable_get('file_directory_path', 'files');
file_check_directory($directory_path, FILE_CREATE_DIRECTORY, 'file_directory_path');
+ $form['files']['file_directory_path'] = array(
+ type => 'textfield', title => t('File system path'), default_value => $directory_path, maxlength => 255, valid => 'directory',
+ description => 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.')
+ );
+
$directory_temp = variable_get('file_directory_temp', FILE_DIRECTORY_TEMP);
file_check_directory($directory_temp, FILE_CREATE_DIRECTORY, 'file_directory_temp');
+
+ $form['files']['file_directory_tmp'] = array(
+ type => 'textfield', title => t('Temporary directory'), default_value => $directory_temp, maxlength => 255, valid => 'directory',
+ description => t('Location where uploaded files will be kept during previews. Relative paths will be resolved relative to the file system path.')
+ );
+
+ $form['files']['file_downloads'] = array(
+ type => 'radios', title => t('Download method'), default_value => variable_get('file_downloads', FILE_DOWNLOADS_PUBLIC),
+ options => array(FILE_DOWNLOADS_PUBLIC => t('Public - files are available using http directly.'), FILE_DOWNLOADS_PRIVATE => t('Private - files are transferred by Drupal.')),
+ description => t('If you want any sort of access control on the downloading of files, this needs to be set to private. You can change this at any time, however all download URLs will change and there may be unexpected problems so it is not recommended.')
+ );
- $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 private. 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 = '';
+ $group = array();
$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'), '
'. $group .'
', TRUE); + $group['image_toolkit'] = array( + type => 'radios', title => t('Select an image processing toolkit'), + default_value => variable_get('image_toolkit', image_get_toolkit()), options => $toolkits_available + ); + } + $group['toolkit'] = image_toolkit_invoke('settings'); + if (is_array($group)) { + $form['image'] = array(type => 'fieldset', title => t('Image handling'), collapsible => TRUE, collapsed => true); + $form['image'] = array_merge($form['image'], $group); } + */ // Date settings: $zones = _system_zonelist(); @@ -264,19 +366,44 @@ function system_view_general() { $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.')); + $form['dates'] = array(type => 'fieldset', title => t('Date settings'), collapsible => TRUE, collapsed => TRUE); + $form['dates']['date_default_timezone'] = array( + type => 'select', title => t('Default time zone'), default_value => variable_get('date_default_timezone', 0), + options => $zones, description => t('Select the default site time zone.') + ); + + $form['dates']['configurable_timezones'] = array( + type => 'radios', title => t('Configurable time zones'), default_value => variable_get('configurable_timezones', 1), options => array(t('Disabled'), t('Enabled')), + description => t('Enable or disable user-configurable time zones. When enabled, users can set their own time zone and dates will be updated accordingly.') + ); + + $form['dates']['date_format_short'] = array( + type => 'select', title => t('Short date format'), default_value => variable_get('date_format_short', $dateshort[0]), + options => $dateshortchoices, description => t('The short format of date display.') + ); + + $form['dates']['date_format_medium'] = array( + type => 'select', title => t('Medium date format'), default_value => variable_get('date_format_medium', $datemedium[0]), + options => $datemediumchoices, description => t('The medium sized date display.') + ); + + $form['dates']['date_format_long'] = array( + type => 'select', title => t('Long date format'), default_value => variable_get('date_format_long', $datelong[0]), + options => $datelongchoices, description => t('Longer date format used for detailed display.') + ); + + $form['dates']['date_first_day'] = array( + type => 'select', title => t('First day of week'), default_value => variable_get('date_first_day', 0), + options => array(0 => t('Sunday'), 1 => t('Monday'), 2 => t('Tuesday'), 3 => t('Wednesday'), 4 => t('Thursday'), 5 => t('Friday'), 6 => t('Saturday')), + description => 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); + $form['strings'] = array(type => 'fieldset', title => t('String handling'), collapsible => TRUE, collapsed => TRUE); + $form['strings']['settings'] = array_merge($from['strings'], unicode_settings()); - return $output; + return $form; } /** @@ -465,41 +592,6 @@ function system_listing($mask, $director } /** - * 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[] = "$info->nameModRewrite
support with your administrator.'), 'error');
- $edit['clean_url'] = 0;
- }
- foreach ($edit as $name => $value) {
- variable_set($name, $value);
- }
- }
+ array_walk_recursive($form_values, 'system_settings_save');
drupal_set_message(t('The configuration options have been saved.'));
+
}
- else {
- return;
- }
+
menu_rebuild();
- drupal_goto($_GET['q']);
}
/**
+ * Save all the variables submitted to the system table.
+ */
+function system_settings_save($key, $value) {
+ variable_set($key, $value);
+}
+
+function system_settings_reset($key, $value) {
+ variable_del($key);
+}
+
+/**
+ * Do the clean url validation, changing the form property if it doesn't work.
+ */
+function system_settings_validate($form_id, &$form) {
+ #TODO .. fix here.
+ 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 ModRewrite
support with your administrator.'), 'error');
+ $edit['clean_url'] = 0;
+ }
+
+}
+
+
+
+
+/**
* 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);
+ $themes = system_theme_data();
+ ksort($themes);
+
+ foreach ($themes as $info) {
+ $info->screenshot = dirname($info->filename) . '/screenshot.png';
+ $screenshot = file_exists($info->screenshot) ? theme('image', $info->screenshot, t('Screenshot for %theme theme', array('%theme' => $info->name)), '', array('class' => 'screenshot'), false) : t('no screenshot');
+
+ $form[$info->name]['screenshot'] = array(type => 'markup', value => $screenshot);
+ $form[$info->name]['description'] = array(type => 'item', title => $info->name, value => dirname($info->filename));
+ $options[$info->name] = '';
+ if ($info->status) {
+ $status[] = $info->name;
+ }
+ if ($info->status && (function_exists($info->prefix . '_settings') || function_exists($info->prefix . '_features'))) {
+ $form[$info->name]['operations'] = array(type => 'markup', value => l(t('configure'), 'admin/themes/settings/' . $info->name) );
+ }
+ else {
+ // Dummy element for form_render. Cleaner than adding a check in the theme function.
+ $form[$info->name]['operations'] = array();
+ }
+ }
+
+ $form['status'] = array(type => 'checkboxes', options => $options, default_value => $status);
+ $form['theme_default'] = array(type => 'radios', options => $options, default_value => variable_get('theme_default', 'bluemarine'));
+ $form['buttons']['submit'] = array(type => 'submit', value => t('Save configuration') );
+ $form['buttons']['reset'] = array(type => 'submit', value => t('Reset to defaults') );
+
+ return drupal_get_form('system_themes', $form);
+}
+
+function theme_system_themes($form) {
+ foreach ($form as $key => $element) {
+ $row = array();
+ if (is_array($element['description'])) {
+
+ $row[] = form_render($form[$key]['screenshot']);
+ $row[] = form_render($form[$key]['description']);
+ $row[] = array('data' => form_render($form['status'][$key]), 'align' => 'center');
+ $row[] = array('data' => form_render($form['theme_default'][$key]), 'align' => 'center');
+ $row[] = array('data' => form_render($form[$key]['operations']), 'align' => 'center');
+ }
+ $rows[] = $row;
+ }
+
+ $header = array(t('Screenshot'), t('Name'), t('Enabled'), t('Default'), t('Operations'));
+ $output = theme('table', $header, $rows);
+ $output .= form_render($form);
+ return $output;
+}
+
+
+function system_themes_execute($form_id, $form) {
+ global $form_values;
+
+ db_query("UPDATE {system} SET status = 0 WHERE type = 'theme'");
+
+ if ($_POST['op'] == t('Save configuration')) {
+ variable_set('theme_default', $form_values['theme_default']);
+ if (is_array($form_values['status'])) {
+ foreach ($form_values['status'] as $key => $choice) {
+ if ($key == $choice) {
+ db_query("UPDATE {system} SET status = 1 WHERE type = 'theme' and name = '%s'", $choice);
+ }
+ }
+ }
+ }
+ else {
+ variable_del('theme_default');
+ }
+ drupal_set_message(t('The configuration options have been saved.'));
}
/**
@@ -670,16 +844,16 @@ function system_modules() {
* 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();
+ $module = 'system';
}
- return system_settings_form($form);
+ return system_settings_form($module . '_settings_form', $form);
}
/**
@@ -725,7 +899,6 @@ function system_theme_settings($key = ''
}
}
- system_settings_save();
$form = '';
@@ -864,4 +1037,16 @@ function system_theme_settings($key = ''
}
+function search_box() {
+ $form[action] = url('search');
+ $form['keys'] = array(type => 'textfield', size=> 15, value => '', attributes => array('alt' => t('Enter the terms you wish to search for.'), 'class' => 'form-text'));
+ $form['submit'] = array(type => 'submit', value => t('search'));
+ return drupal_get_form('search_box', $form);
+}
+function theme_search_box($form) {
+ $output = '