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

function system_help() {
 ?>
Dries Buytaert's avatar
   
Dries Buytaert committed
6
  <p>Drupal comes with system-wide defaults but the setting-module provides control over many Drupal preferences, behaviors including visual and operational settings.</p>
Dries Buytaert's avatar
   
Dries Buytaert committed
7
  <h3>Cron</h3>
Dries Buytaert's avatar
   
Dries Buytaert committed
8
9
10
11
12
  <p>Some settings require a <i>cron</i> or <i>crontab</i>.  Cron (which stands for chronograph) is a periodic command scheduler: it executes 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 of <i>n</i> 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>Whenever <a href="<?php echo path_uri(); ?>cron.php"><?php echo path_uri(); ?>cron.php</a> is accessed, cron will run: it checks for the jobs cron controls, and their periods in seconds.  If a certain task wasn't executed in the last n seconds, where n is the period of that job, it will be executed.  When all the executed commands terminate, cron is done.</p>
  <p>The recommended way to setup your cron system is to setup a Unix/Linux crontab that frequently visits <a href="<?php echo path_uri(); ?>cron.php"><?php echo path_uri(); ?>cron.php</a>. Note that cron does not guarantee the commands will be executed at the specified interval.  However, Drupal will try his best and run the crons 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 setup crontabs, you can always ask someone else to setup a crontab for you. After all, virtually any Unix/Linux machine with access to the internet can setup a crontab to frequently visit <a href="<?php echo path_uri(); ?>cron.php"><?php echo path_uri(); ?>cron.php</a>.</p>
  <p>For the Unix/Linux crontab itself, use a browser like <i>lynx</i> or <i>wget</i> but make sure the process terminates: either use <code>/usr/bin/lynx -source <?php echo path_uri(); ?>cron.php</code> or <code>/usr/bin/wget -O /dev/null <?php echo path_uri(); ?>cron.php</code>.  Take a look at the example scripts in the <code>scripts</code>-directory and make sure to adjust them to your needs.  A good crontab-line to run the cron-script once every hour would be: <code>00 * * * * /home/www/drupal/scripts/cron-lynx</code>.</p>
Dries Buytaert's avatar
 
Dries Buytaert committed
13
14
15
16
 <?php
}

function system_perm() {
Dries Buytaert's avatar
   
Dries Buytaert committed
17
  return array("administer settings and filters", "access administration pages");
Dries Buytaert's avatar
   
Dries Buytaert committed
18
19
20
}

function system_link($type) {
Dries Buytaert's avatar
   
Dries Buytaert committed
21
22
  if ($type == "admin" && user_access("administer settings and filters")) {
    $links[] = "<a href=\"admin.php?mod=system\">settings and filters</a>";
Dries Buytaert's avatar
   
Dries Buytaert committed
23
24
25
  }

  return $links ? $links : array();
Dries Buytaert's avatar
 
Dries Buytaert committed
26
27
28
29
30
31
}

function system_view_options() {
  global $conf, $cmodes, $corder, $themes;

  // general settings:
Dries Buytaert's avatar
   
Dries Buytaert committed
32
  $output .= "<h3>General settings</h3>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
33
34
  $output .= form_textfield("Name", "site_name", variable_get("site_name", "drupal"), 55, 55, "The name of this website.");
  $output .= form_textfield("E-mail address", "site_mail", variable_get("site_mail", "root@localhost"), 55, 128, "A valid e-mail address for this website, used by the auto-mailer to create new user accounts.");
Dries Buytaert's avatar
   
Dries Buytaert committed
35
  $output .= form_textfield("Slogan", "site_slogan", variable_get("site_slogan", ""), 55, 128, "The slogan of this website");
Dries Buytaert's avatar
   
Dries Buytaert committed
36
37
38
  $output .= form_textarea("Mission", "site_mission", variable_get("site_mission", ""), 55, 5, "Your site's mission statement or focus.");
  $output .= form_textarea("Footer message", "site_footer", variable_get("site_footer", ""), 55, 5, "This text will be displayed at the bottom of each page.  Useful for adding a copyright notice to your pages.");
  $output .= form_textfield("Anonymous user", "anonymous", variable_get("anonymous", "Anonymous"), 55, 55, "The name used to indicate anonymous users.");
39
40
  foreach (module_list() as $name) { if (module_hook($name, "page")) $pages[$name] = $name; }
  $output .= form_select("Default front page", "site_frontpage", variable_get("site_frontpage", "node"), $pages, "The default front page.");
41
  $output .= form_textfield("Extra front page settings", "site_frontpage_extra", variable_get("site_frontpage_extra", ""), 55, 128, "Lets you define additonal variables for the main page in PHP.");
Dries Buytaert's avatar
   
Dries Buytaert committed
42
  $output .= "<hr />\n";
Dries Buytaert's avatar
 
Dries Buytaert committed
43

Dries Buytaert's avatar
   
Dries Buytaert committed
44
  // caching:
Dries Buytaert's avatar
   
Dries Buytaert committed
45
  $output .= "<h3>Cache settings</h3>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
46
  $period = array(10 => format_interval(10), 20 => format_interval(20), 30 => format_interval(30), 40 => format_interval(40), 50 => format_interval(50), 50 => format_interval(50), 60 => format_interval(60), 90 => format_interval(90), 120 => format_interval(120), 150 => format_interval(150), 180 => format_interval(180), 210 => format_interval(210), 240 => format_interval(240), 270 => format_interval(270), 300 => format_interval(300), 360 => format_interval(360), 420 => format_interval(420), 480 => format_interval(480), 540 => format_interval(540), 600 => format_interval(600), 1800 => format_interval(1800), 3600 => format_interval(3600), 7200 => format_interval(7200));
Dries Buytaert's avatar
   
Dries Buytaert committed
47
48
  $output .= form_select("Cache support", "cache", variable_get("cache", 0), array("Disabled", "Enabled"), "Enable or disable the caching of pages.");
  $output .= form_select("Discard cached pages older than", "cache_clear", variable_get("cache_clear", 30), $period, "The time cached pages should be kept.  Older pages are automatically refreshed.");
Dries Buytaert's avatar
   
Dries Buytaert committed
49
  $output .= "<hr />\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
50

Dries Buytaert's avatar
 
Dries Buytaert committed
51
  // submission settings:
Dries Buytaert's avatar
   
Dries Buytaert committed
52
  $output .= "<h3>Submission settings</h3>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
53
  $rate = array(1 => "Maximum 1 every second", 5 => "Maximum 1 every 5 seconds", 15 => "Maximum 1 every 15 seconds", 30 => "Maximum 1 every 30 seconds", 60 => "Maximum 1 every minute", 300 => "Maximum 1 every 5 minutes", 900 => "Maximum 1 every 15 minutes", 1800 => "Maximum 1 every 30 minutes", 3600 => "Maximum 1 every hour", 21600 => "Maximum 1 every 6 hours", 43200 => "Maximum 1 every 12 hours");
Dries Buytaert's avatar
   
Dries Buytaert committed
54
55
  $output .= form_select("Maximum node rate", "max_node_rate", variable_get("max_node_rate", 900), $rate, "The maximum submission rate for nodes.  Its purpose is to stop potential abuse or denial of service attacks.");
  $output .= form_select("Maximum comment rate", "max_comment_rate", variable_get("max_comment_rate", 120), $rate, "The maximum submission rate for comments.  Its purpose is to stop potential abuse or denial of service attacks.");
Dries Buytaert's avatar
   
Dries Buytaert committed
56
  $output .= "<hr />\n";
Dries Buytaert's avatar
 
Dries Buytaert committed
57
58

  // comment settings:
Dries Buytaert's avatar
   
Dries Buytaert committed
59
  $output .= "<h3>Comment settings</h3>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
60
61
62
63
  $output .= form_select("Default display mode", "default_comment_mode", $conf[default_comment_mode], $cmodes, "The default mode in which comments are displayed.");
  $output .= form_select("Default display order", "default_comment_order", $conf[default_comment_order], $corder, "The default order in which comments are displayed.");
  for ($count = -1; $count < 6; $count++) $threshold[$count] = "Filter - $count";
  $output .= form_select("Default filter threshold", "default_comment_threshold", $conf[default_comment_threshold], $threshold, "The default threshold used to filter comments.");
Dries Buytaert's avatar
   
Dries Buytaert committed
64
  $output .= "<hr />\n";
Dries Buytaert's avatar
 
Dries Buytaert committed
65
66

  // layout settings:
Dries Buytaert's avatar
   
Dries Buytaert committed
67
  $output .= "<h3>Layout settings</h3>\n";
Dries Buytaert's avatar
 
Dries Buytaert committed
68
  foreach ($themes as $key=>$value) $options .= "<OPTION VALUE=\"$key\"". (variable_get("theme_default", key($themes)) == $key ? " SELECTED" : "") .">$key</OPTION>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
69
  $output .= form_item("Default theme", "<SELECT NAME=\"edit[theme_default]\">$options</SELECT>", "The default theme as seen by visitors or anonymous users.");
Dries Buytaert's avatar
   
Dries Buytaert committed
70
  $output .= "<hr />\n";
Dries Buytaert's avatar
 
Dries Buytaert committed
71
72

  // development settings:
Dries Buytaert's avatar
   
Dries Buytaert committed
73
  $output .= "<h3>Development settings</h3>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
74
  $output .= form_select("Display timer information", "dev_timer", variable_get("dev_timer", 0), array("Disabled", "Enabled"), "Display the time it took to generate a page.  For Drupal development only.");
Dries Buytaert's avatar
   
Dries Buytaert committed
75
76
  $output .= form_select("Display query log", "dev_query", variable_get("dev_query", 0), array("Disabled", "Enabled"), "Display a log of the database queries needed to generate the current page.");

Dries Buytaert's avatar
   
Dries Buytaert committed
77
  $output .= "<hr />\n";
Dries Buytaert's avatar
 
Dries Buytaert committed
78
79
80

  foreach (module_list() as $name) {
    if (module_hook($name, "conf_options")) {
81
      $output .= "<h3><a name=\"$name\">". ucfirst($name) ." settings</a></h3>". module_invoke($name, "conf_options") ."<hr />\n";
Dries Buytaert's avatar
 
Dries Buytaert committed
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
    }
  }
  return $output;
}

function system_view_filters() {
  foreach (module_list() as $name) {
    if (module_hook($name, "conf_filters")) {
      $output .= module_invoke($name, "conf_filters");
    }
  }
  return $output;
}

function system_save($edit = array()) {
  foreach ($edit as $name=>$value) variable_set($name, $value);
  return "the configuration options have been saved.";
}

function system_default($edit = array()) {
  foreach ($edit as $name=>$value) variable_del($name);
  return "the configuration options have been reset to their default values.";
}

function system_view($type) {

  switch ($type) {
    case "filter":
      $form = system_view_filters();
      break;
    default:
      $form = system_view_options();
  }

  $form .= form_submit("Save configuration");
  $form .= form_submit("Reset to defaults");

Dries Buytaert's avatar
   
Dries Buytaert committed
119
  return form($form);
Dries Buytaert's avatar
 
Dries Buytaert committed
120
121
122
}

function system_modules() {
Dries Buytaert's avatar
   
Dries Buytaert committed
123
124
  $output .= "<table border=\"1\" cellpadding=\"2\" cellspacing=\"2\">\n";
  $output .= " <tr><th>module</th><th colspan=\"2\">operations</th></tr>\n";
Dries Buytaert's avatar
 
Dries Buytaert committed
125
  foreach (module_list() as $name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
126
    $output .= " <tr><td>$name</td><td>". (module_hook($name, "page") ? "<a href=\"module.php?mod=$name\">view</a>" : "&nbsp;") ."</td><td>". (module_hook($name, "admin") ? "<a href=\"admin.php?mod=$name\">admin</a>" : "&nbsp;") ."</td></tr>\n";
Dries Buytaert's avatar
 
Dries Buytaert committed
127
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
128
  $output .= "</table>\n";
Dries Buytaert's avatar
 
Dries Buytaert committed
129
130
131
132
133

  return $output;
}

function system_admin() {
Dries Buytaert's avatar
   
Dries Buytaert committed
134
  global $edit, $op, $type;
Dries Buytaert's avatar
 
Dries Buytaert committed
135

Dries Buytaert's avatar
   
Dries Buytaert committed
136
  if (user_access("administer settings and filters")) {
Dries Buytaert's avatar
 
Dries Buytaert committed
137

Dries Buytaert's avatar
   
Dries Buytaert committed
138
    print "<small><a href=\"admin.php?mod=system&type=options\">site settings</a> | <a href=\"admin.php?mod=system&type=filter\">content filters</a> | <a href=\"admin.php?mod=system&op=modules\">modules</a> | <a href=\"admin.php?mod=system&op=help\">help</a></small><hr />\n";
Dries Buytaert's avatar
 
Dries Buytaert committed
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

    switch ($op) {
      case "help":
        system_help();
        break;
      case "modules":
        print system_modules();
        break;
      case "Reset to defaults":
        print status(system_default($edit));
        print system_view($type);
        break;
      case "Save configuration":
        print status(system_save($edit));
        print system_view($type);
        break;
      default:
        print system_view($type);
    }
  }
  else {
    print message_access();
  }
}
Dries Buytaert's avatar
   
Dries Buytaert committed
163

Dries Buytaert's avatar
 
Dries Buytaert committed
164
?>