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

function system_help() {
Dries Buytaert's avatar
   
Dries Buytaert committed
5
  $output .= "<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
6
7
  $output .= "<h3>Cache</h3>". system_help_cache();
  $output .= "<h3>Cron</h3>". system_help_cron();
Dries Buytaert's avatar
   
Dries Buytaert committed
8
9
10
  return $output;
}

11
function system_system($field){
12
  $system["description"] = t("Configuration system that lets site admins modify the workings of the site.");
13
14
15
  return $system[$field];
}

Dries Buytaert's avatar
   
Dries Buytaert committed
16
function system_help_cache() {
Dries Buytaert's avatar
   
Dries Buytaert committed
17
18
19
  $output .= "<p>Drupal has a caching mechanism that stores dynamically generated pages in a database.  By caching a page, Drupal does not have to generate the page each time it is requested.  Only pages requested by anonymous users are being cached.  When a cached page is accessed, Drupal will retrieve that page with minimal overhead using one SQL query only, thus reducing both the server load and the response time.</p>";
  $output .= "<p>Drupal's caching mechanism can be enabled and disabled by the site administrators from the 'settings' page.  He can also define how long cached pages should be kept.</p>";
  return $output;
Dries Buytaert's avatar
   
Dries Buytaert committed
20
21
22
}

function system_help_cron() {
Dries Buytaert's avatar
   
Dries Buytaert committed
23
24
25
26
27
28
  $output .= "<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>";
  $output .= "<p>Whenever <a href=\"". path_uri() ."cron.php\">". 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>";
  $output .= "<p>The recommended way to setup your cron system is to setup a Unix/Linux crontab that frequently visits <a href=\"". path_uri() ."cron.php\">". 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>";
  $output .= "<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=\"". path_uri() ."cron.php\">". path_uri() ."cron.php</a>.</p>";
  $output .= "<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: <pre>     00 * * * * /home/www/drupal/scripts/cron-lynx</pre></p>";
  return $output;
Dries Buytaert's avatar
 
Dries Buytaert committed
29
30
31
}

function system_perm() {
Dries Buytaert's avatar
   
Dries Buytaert committed
32
  return array("administer site configuration", "access administration pages");
Dries Buytaert's avatar
   
Dries Buytaert committed
33
34
35
}

function system_link($type) {
Dries Buytaert's avatar
   
Dries Buytaert committed
36
37
  if ($type == "admin" && user_access("administer site configuration")) {
    $links[] = la(t("site configuration"), array("mod" => "system"));
Dries Buytaert's avatar
   
Dries Buytaert committed
38
39
40
  }

  return $links ? $links : array();
Dries Buytaert's avatar
 
Dries Buytaert committed
41
42
43
}

function system_view_options() {
44
  global $conf, $cmodes, $corder;
Dries Buytaert's avatar
   
Dries Buytaert committed
45

Dries Buytaert's avatar
 
Dries Buytaert committed
46
  // general settings:
Dries Buytaert's avatar
   
Dries Buytaert committed
47
  $output .= "<h3>General settings</h3>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
48
  $output .= form_textfield("Name", "site_name", variable_get("site_name", "drupal"), 55, 55, "The name of this website.");
Kjartan Mannes's avatar
Kjartan Mannes committed
49
50
  $output .= form_textfield("E-mail address", "site_mail", variable_get("site_mail", ini_get("sendmail_from")), 55, 128, "A valid e-mail address for this website, used by the auto-mailer during registration, new password requests, notifications, etc.");
  $output .= form_textfield("Slogan", "site_slogan", variable_get("site_slogan", ""), 55, 128, "The slogan of this website. Some themes display a slogan when available.");
Dries Buytaert's avatar
   
Dries Buytaert committed
51
  $output .= form_textarea("Mission", "site_mission", variable_get("site_mission", ""), 55, 5, "Your site's mission statement or focus.");
Dries Buytaert's avatar
   
Dries Buytaert committed
52
53
  $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.");
54
  foreach (module_list() as $name) { if (module_hook($name, "page")) $pages[$name] = $name; }
Kjartan Mannes's avatar
Kjartan Mannes committed
55
  $output .= form_select("Default front page", "site_frontpage", variable_get("site_frontpage", "node"), $pages, "The home page displays content from this module (usually <b>node</b>).");
Dries Buytaert's avatar
   
Dries Buytaert committed
56
  $output .= "<hr />\n";
Dries Buytaert's avatar
 
Dries Buytaert committed
57

Dries Buytaert's avatar
   
Dries Buytaert committed
58
  // caching:
Dries Buytaert's avatar
   
Dries Buytaert committed
59
  $output .= "<h3>Cache settings</h3>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
60
  $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
61
62
  $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
63
  $output .= "<hr />\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
64

Dries Buytaert's avatar
 
Dries Buytaert committed
65
  // submission settings:
Dries Buytaert's avatar
   
Dries Buytaert committed
66
  $output .= "<h3>Submission settings</h3>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
67
  $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
68
69
  $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
70
  $output .= "<hr />\n";
Dries Buytaert's avatar
 
Dries Buytaert committed
71

Dries Buytaert's avatar
   
Dries Buytaert committed
72
73
74
75
76
  // date settings:
  $output .= "<h3>Date format setting</h3>\n";
  $output .= form_select("Date format", "date_format", variable_get("date_format", "m/d/Y - H:i"), array("m/d/Y - H:i" => "m/d/Y - H:i", "d/m/Y - H:i" => "d/m/Y - H:i", "Y/m/d - H:i" => "Y/m/d - H:i"), "The format in which dates are displayed");
  $output .= "<hr />\n";

Dries Buytaert's avatar
 
Dries Buytaert committed
77
  // layout settings:
Dries Buytaert's avatar
   
Dries Buytaert committed
78
  $output .= "<h3>Layout settings</h3>\n";
79
  foreach (theme_list() as $key => $value) $options .= "<option value=\"$key\"". (variable_get("theme_default", 0) == $key ? " selected=\"selected\"" : "") .">$key</option>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
80
  $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
81
  $output .= "<hr />\n";
Dries Buytaert's avatar
 
Dries Buytaert committed
82
83

  // development settings:
Dries Buytaert's avatar
   
Dries Buytaert committed
84
  $output .= "<h3>Development settings</h3>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
85
  $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
86
87
  $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
88
  $output .= "<hr />\n";
Dries Buytaert's avatar
 
Dries Buytaert committed
89
90
91

  foreach (module_list() as $name) {
    if (module_hook($name, "conf_options")) {
92
      $output .= "<h3><a name=\"$name\">". ucfirst($name) ." settings</a></h3>". module_invoke($name, "conf_options") ."<hr />\n";
Dries Buytaert's avatar
 
Dries Buytaert committed
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
    }
  }
  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()) {
108
  foreach ($edit as $name => $value) variable_set($name, $value);
Dries Buytaert's avatar
 
Dries Buytaert committed
109
110
111
112
  return "the configuration options have been saved.";
}

function system_default($edit = array()) {
113
  foreach ($edit as $name => $value) variable_del($name);
Dries Buytaert's avatar
 
Dries Buytaert committed
114
115
116
117
118
119
120
121
122
123
  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:
Dries Buytaert's avatar
   
Dries Buytaert committed
124
125
126
127
128
129
      foreach (module_list() as $name) {
        if (module_hook($name, "conf_options")) {
          $links[] = la($name, array("mod" => "system"), $name);
        }
      }

130
      $output = "<small>". implode(" :: ", $links) ."</small><hr />";
Dries Buytaert's avatar
 
Dries Buytaert committed
131
132
133
134
135
136
      $form = system_view_options();
  }

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

137
  return $output . form($form);
Dries Buytaert's avatar
 
Dries Buytaert committed
138
139
}

140
141
142
143
144
145
146
/**
* Module configuration
*
* @author Kjartan Mannes
* @group system.module
* @return string module list
*/
Dries Buytaert's avatar
 
Dries Buytaert committed
147
function system_modules() {
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
  $result = db_query("SELECT name, status FROM system WHERE type = 'module'");
  $status = array();
  while ($module = db_fetch_object($result)) {
    $status[$module->name] = $module->status;
  }

  if ($handle = @opendir("modules")) {
    $modules = array();
    while ($file = readdir($handle)) {
      if (".module" == substr($file, -7)) {
        $name = substr($file, 0, -7);
        $modules[$name] = array("filename" => "$file", "status" => $status[$name]);
       include_once("modules/$file");
      }
    }
    closedir($handle);
    asort($modules);
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
167
168
  db_query("DELETE FROM system WHERE type = 'module'");

Dries Buytaert's avatar
   
Dries Buytaert committed
169
  $required = array("user", "system", "watchdog");
170

Dries Buytaert's avatar
   
Dries Buytaert committed
171
  $output .= "<table border=\"1\" cellpadding=\"2\" cellspacing=\"2\">\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
172
  $output .= "<tr><th>module</th><th>description</th><th>status</th><th colspan=\"2\">operations</th></tr>\n";
173
  foreach ($modules as $name => $module) {
174
175
176
    $output .= "<tr>";
    $output .= "<td>$name</td>";
    $output .= "<td>". check_output(module_invoke($name, "system", "description")) ."</td>";
Dries Buytaert's avatar
   
Dries Buytaert committed
177
    $output .= "<td align=\"center\">". (in_array($name, $required) ? "required" : form_checkbox("", "status][$name", 1, $module["status"])) ."</td>";
Dries Buytaert's avatar
   
Dries Buytaert committed
178
179
180
    $output .= "<td>". (module_hook($name, "page") ? $module["status"] || in_array($name, $required) ? lm(t("view"), array("mod" => $name)) : t("view") : "&nbsp;") ."</td>";
    $output .= "<td>". (module_hook($name, "admin") ? $module["status"] || in_array($name, $required) ? la(t("admin"), array("mod" => $name)) : t("admin")  : "&nbsp;") ."</td>";
//  $output .= "<td>". (module_hook($name, "help") ? $module["status"]   || in_array($name, $required) ? la(t("help"), array("mod" => $name, "op" => "help")) : t("help")  : "&nbsp;") ."</td>";
181
    $output .= "</tr>\n";
182
    if (!in_array($name, $required)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
183
      db_query("INSERT INTO system (name, type, filename, status) VALUES ('%s', 'module', '%s', '%s')", $name, $module["filename"], $module["status"]);
184
    }
Dries Buytaert's avatar
 
Dries Buytaert committed
185
  }
186
187
  $output .= "</table><br />\n";
  $output .= form_submit("Save module settings");
Dries Buytaert's avatar
 
Dries Buytaert committed
188

189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
  return form($output);
}

/**
* Theme configuration
*
* This function handles the Drupal themes and lets the site administrator enable or disable them as they wish.
*
* @author Kjartan Mannes
* @package system.module
* @return string theme list
*/
function system_themes() {
  $result = db_query("SELECT * FROM system WHERE type = 'theme' ORDER BY filename");
  $status = array();
  while ($theme = db_fetch_object($result)) {
    $_themes[$theme->name] = $theme;
  }

  if ($handle = @opendir("themes")) {
    $themes = array();
    while ($dir = readdir($handle)) {
      if (!substr_count($dir, ".") && is_dir("themes/$dir")) {
        if ($handle2 = @opendir("themes/$dir")) {
          while ($file = readdir($handle2)) {
            if (".theme" == substr($file, -6)) {
              include_once("themes/$dir/$file");
              $name = substr($file, 0, -6);
              $_theme = "theme_$name";
              if (class_exists($_theme)) {
                $_theme =& new $_theme;
                $_themes[$name]->filename = "themes/$dir/$file";
                if (method_exists($_theme, "system")) {
                  $_themes[$name]->displayname = $_theme->system("name");
                  $_themes[$name]->author = $_theme->system("author");
                  if (empty($_themes[$name]->description)) {
                    $_themes[$name]->description = $_theme->system("description");
                  }
                }

                $themes[$name] = $_themes[$name];
                unset($_theme);
              }
            }
          }
          closedir($handle2);
        }
      }
    }
    closedir($handle);
    asort($themes);
  }

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

  $output .= "<table border=\"1\" cellpadding=\"2\" cellspacing=\"2\">\n";
245
  $output .= "<tr><th>theme</th><th>name</th><th>description</th><th>author</th><th>enabled</th></tr>\n";
246
  foreach ($themes as $name => $theme) {
247
248
249
250
251
252
253
    $output .= "<tr>";
    $output .= "<td>$name</td>";
    $output .= "<td>$theme->displayname</td>";
    $output .= "<td>". form_textfield("", "$name][description", $theme->description, 40, 255)."</td>";
    $output .= "<td>$theme->author</td>";
    $output .= "<td align=\"center\">". form_checkbox("", "$name][status", 1, $theme->status) ."</td>";
    $output .= "</tr>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
254
    db_query("INSERT INTO system (name, type, filename, status, description) VALUES ('%s', 'theme', '%s', '%s', '%s')", $name, $theme->filename, $theme->status, $theme->description);
255
256
257
258
259
  }
  $output .= "</table><br />\n";
  $output .= form_submit("Save theme settings");

  return form($output);
Dries Buytaert's avatar
 
Dries Buytaert committed
260
261
262
}

function system_admin() {
Dries Buytaert's avatar
   
Dries Buytaert committed
263
  global $edit, $op, $type;
Dries Buytaert's avatar
   
Dries Buytaert committed
264
  if (user_access("administer site configuration")) {
Dries Buytaert's avatar
 
Dries Buytaert committed
265

Dries Buytaert's avatar
   
Dries Buytaert committed
266
    print "<small>". la(t("site settings"), array("mod" => "system", "type" => "options")) ." - ". la(t("content filters"), array("mod" => "system", "type" => "filter")) ." - ". la(t("modules"), array("mod" => "system", "op" => "modules")) ." - ". la(t("themes"), array("mod" => "system", "op" => "themes")) ." - ". la(t("help"), array("mod" => "system", "op" => "help")) ."</small><hr />\n";
Dries Buytaert's avatar
 
Dries Buytaert committed
267
268
269

    switch ($op) {
      case "help":
Dries Buytaert's avatar
   
Dries Buytaert committed
270
        print system_help();
Dries Buytaert's avatar
 
Dries Buytaert committed
271
        break;
272
      case "Save module settings":
273
        db_query("UPDATE system SET status = '0' WHERE type = 'module'");
274
275
276
        foreach ($edit["status"] as $name => $status) {
          db_query("UPDATE system SET status = '$status' WHERE name = '$name'");
        }
Dries Buytaert's avatar
 
Dries Buytaert committed
277
278
279
      case "modules":
        print system_modules();
        break;
280
      case "Save theme settings":
281
        db_query("UPDATE system SET status = '0' WHERE type = 'theme'");
282
        foreach ($edit as $name => $settings) {
Dries Buytaert's avatar
   
Dries Buytaert committed
283
          db_query("UPDATE system SET status = '%s', description = '%s' WHERE name = '$name'", $settings["status"], $settings["description"]);
284
285
286
287
        }
      case "themes":
        print system_themes();
        break;
Dries Buytaert's avatar
 
Dries Buytaert committed
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
      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
304

Dries Buytaert's avatar
   
Dries Buytaert committed
305
?>