admin/upgradesettings.php

   1 <?php // $Id$
   2
   3 // detects settings that were added during an upgrade, displays a screen for the admin to
   4 // modify them, and then processes modifications
   5
   6 require_once('../config.php');
   7 require_once($CFG->libdir.'/adminlib.php');
   8
   9 admin_externalpage_setup('upgradesettings'); // now hidden page
  10
  11 // a caveat: we're depending on only having one admin access this page at once. why? the following line
  12 // (the function call to find_new_settings) must have the EXACT SAME RETURN VALUE both times that this
  13 // page is loaded (i.e. both when we're displaying the form and then when we process the form's input).
  14 // if the return values don't match, we could potentially lose changes that the admin is making.
  15
  16 $newsettingshtml = output_new_settings_by_page(admin_get_root());
  17
  18 // first we deal with the case where there are no new settings to be set
  19 if ($newsettingshtml == '') {
  20     redirect($CFG->wwwroot . '/' . $CFG->admin . '/index.php');
  21     die;
  22 }
  23
  24 // now we'll deal with the case that the admin has submitted the form with new settings
  25 if ($data = data_submitted()) {
  26     $unslashed = (array)stripslashes_recursive($data);
  27     if (confirm_sesskey()) {
  28         $newsettings = find_new_settings(admin_get_root());
  29         $errors = '';
  30
  31         foreach($newsettings as $newsetting) {
  32             if (isset($unslashed['s_' . $newsetting->name])) {
  33                 $errors .= $newsetting->write_setting($unslashed['s_' . $newsetting->name]);
  34             } else {
  35                 $errors .= $newsetting->write_setting($newsetting->defaultsetting);
  36             }
  37         }
  38
  39         if (empty($errors)) {
  40             // there must be either redirect without message or continue button or else upgrade would be sometimes broken
  41             redirect($CFG->wwwroot . '/' . $CFG->admin . '/index.php');
  42             die;
  43         } else {
  44             error(get_string('errorwithsettings', 'admin') . ' <br />' . $errors);
  45             die;
  46         }
  47     } else {
  48         error(get_string('confirmsesskeybad', 'error'));
  49         die;
  50     }
  51
  52 }
  53
  54 // and finally, if we get here, then there are new settings and we have to print a form
  55 // to modify them
  56 admin_externalpage_print_header();
  57
  58 print_simple_box(get_string('upgradesettingsintro','admin'),'','100%','',5,'generalbox','');
  59
  60 echo '<form action="upgradesettings.php" method="post" id="adminsettings">';
  61 echo '<input type="hidden" name="sesskey" value="' . sesskey() . '" />';
  62 echo '<fieldset>';
  63 echo '<div class="clearer"><!-- --></div>';
  64 echo $newsettingshtml;
  65 echo '</fieldset>';
  66 echo '<div class="form-buttons"><input class="form-submit" type="submit" value="' . get_string('savechanges','admin') . '" /></div>';
  67 echo '</form>';
  68
  69 admin_externalpage_print_footer();
  70
  71
  72 /**
  73  * Find settings that have not been initialized (e.g. during initial install or an upgrade).
  74  *
  75  * Tests each setting's get_setting() method. If the result is NULL, we consider the setting
  76  * to be uninitialized.
  77  *
  78  * @param string &$node The node at which to start searching. Should be $ADMIN for all external calls to this function.
  79  * @return array An array containing admin_setting objects that haven't yet been initialized
  80  */
  81 function find_new_settings(&$node) {
  82
  83     if (is_a($node, 'admin_category')) {
  84         $return = array();
  85         $entries = array_keys($node->children);
  86         foreach ($entries as $entry) {
  87             $return = array_merge($return, find_new_settings($node->children[$entry]));
  88         }
  89         return $return;
  90     }
  91
  92     if (is_a($node, 'admin_settingpage')) {
  93         $return = array();
  94         foreach ($node->settings as $setting) {
  95             if ($setting->get_setting() === NULL) {
  96                 $return[] =& $setting;
  97             }
  98             unset($setting); // needed to prevent odd (imho) reference behaviour
  99                              // see http://www.php.net/manual/en/language.references.whatdo.php#AEN6399
 100         }
 101         return $return;
 102     }
 103
 104     return array();
 105
 106 }
 107
 108 function output_new_settings_by_page(&$node) {
 109
 110     if (is_a($node, 'admin_category')) {
 111         $entries = array_keys($node->children);
 112         $return = '';
 113         foreach ($entries as $entry) {
 114             $return .= output_new_settings_by_page($node->children[$entry]);
 115         }
 116         return $return;
 117     }
 118
 119     if (is_a($node, 'admin_settingpage')) {
 120         $newsettings = array();
 121         foreach ($node->settings as $setting) {
 122             if ($setting->get_setting() === NULL) {
 123                 $newsettings[] =& $setting;
 124             }
 125             unset($setting); // needed to prevent odd (imho) reference behaviour
 126                              // see http://www.php.net/manual/en/language.references.whatdo.php#AEN6399
 127         }
 128         $return = '';
 129         if (count($newsettings) > 0) {
 130             $return .= print_heading(get_string('upgradesettings','admin').' - '.$node->visiblename, '', 2, 'main', true);
 131             $return .= '<fieldset class="adminsettings">' . "\n";
 132             foreach ($newsettings as $newsetting) {
 133                 $return .= '<div class="clearer"><!-- --></div>' . "\n";
 134                 $return .= $newsetting->output_html();
 135             }
 136             $return .= '</fieldset>';
 137         }
 138         return $return;
 139     }
 140
 141     return '';
 142
 143 }
 144
 145 ?>