MDL-20636 implement the shell of the system for completing the upgrad…

…e using cron.

local/qeupgradehelper/cronsetup.php

@@ -26,6 +26,7 @@
 
 require_once(dirname(__FILE__) . '/../../config.php');
 require_once(dirname(__FILE__) . '/locallib.php');
+require_once(dirname(__FILE__) . '/cronsetup_form.php');
 require_once($CFG->libdir . '/adminlib.php');
 
 require_login();
@@ -35,7 +36,34 @@
         local_qeupgradehelper_url('cronsetup'));
 $PAGE->navbar->add(get_string('cronsetup', 'local_qeupgradehelper'));
 
-
 $renderer = $PAGE->get_renderer('local_qeupgradehelper');
 
-echo $renderer->simple_message_page('Not implemented yet. Sorry.');
+$form = new local_qeupgradehelper_cron_setup_form(
+        new moodle_url('/local/qeupgradehelper/cronsetup.php'));
+$form->set_data(get_config('local_qeupgradehelper'));
+
+if ($form->is_cancelled()) {
+    redirect(local_qeupgradehelper_url('index'));
+
+} else if ($fromform = $form->get_data()) {
+    if ($fromform->cronenabled) {
+        set_config('cronenabled', $fromform->cronenabled, 'local_qeupgradehelper');
+        set_config('starthour', $fromform->starthour, 'local_qeupgradehelper');
+        set_config('stophour', $fromform->stophour, 'local_qeupgradehelper');
+        set_config('procesingtime', $fromform->procesingtime, 'local_qeupgradehelper');
+
+    } else {
+        unset_config('cronenabled', 'local_qeupgradehelper');
+        unset_config('starthour', 'local_qeupgradehelper');
+        unset_config('stophour', 'local_qeupgradehelper');
+        unset_config('procesingtime', 'local_qeupgradehelper');
+    }
+    redirect(local_qeupgradehelper_url('index'));
+
+}
+
+echo $renderer->header();
+echo $renderer->heading(get_string('cronsetup', 'local_qeupgradehelper'));
+echo $renderer->box(get_string('croninstructions', 'local_qeupgradehelper'));
+$form->display();
+echo $renderer->footer();

local/qeupgradehelper/cronsetup_form.php

@@ -0,0 +1,62 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Settings form for cronsetup.php.
+ *
+ * @package    local
+ * @subpackage qeupgradehelper
+ * @copyright  2011 The Open University
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->libdir . '/formslib.php');
+
+
+/**
+ * Cron setup form.
+ * @copyright  2011 The Open University
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class local_qeupgradehelper_cron_setup_form extends moodleform {
+    public function definition() {
+        $mform = $this->_form;
+
+        $mform->addElement('selectyesno', 'cronenabled',
+                get_string('cronenabled', 'local_qeupgradehelper'));
+
+        $mform->addElement('select', 'starthour',
+                get_string('cronstarthour', 'local_qeupgradehelper'), range(0, 23));
+
+        $mform->addElement('select', 'stophour',
+                get_string('cronstophour', 'local_qeupgradehelper'),
+                array_combine(range(1, 24), range(1, 24)));
+        $mform->setDefault('stophour', 24);
+
+        $mform->addElement('duration', 'procesingtime',
+                get_string('cronprocesingtime', 'local_qeupgradehelper'));
+        $mform->setDefault('procesingtime', 60);
+
+        $mform->disabledIf('starthour', 'cronenabled', 'eq', 0);
+        $mform->disabledIf('stophour', 'cronenabled', 'eq', 0);
+        $mform->disabledIf('procesingtime', 'cronenabled', 'eq', 0);
+
+        $this->add_action_buttons();
+    }
+}

local/qeupgradehelper/lang/en/local_qeupgradehelper.php

@@ -35,8 +35,13 @@
 $string['convertattempts'] = 'Convert attempts';
 $string['convertquiz'] = 'Convert attempts...';
 $string['convertedattempts'] = 'Converted attempts';
+$string['cronenabled'] = 'Cron enabled';
+$string['croninstructions'] = 'You can enable cron to automatically complete the upgrade following a partial upgrade. Cron will run between set hours on the day (according to server local time). Each time cron runs, it will process a number of attempts until Time limit amount of time has been used, then it will stop and wait for the next cron run. Even if you have set up cron, it will not do anything unless it detects that the main upgrade to 2.1 has been completed.';
+$string['cronprocesingtime'] = 'Processing time each cron run';
 $string['cronsetup'] = 'Configure cron';
 $string['cronsetup_desc'] = 'You can configure cron to complete the upgrade of quiz attempt data automatically.';
+$string['cronstarthour'] = 'Start hour';
+$string['cronstophour'] = 'Stop hour';
 $string['extracttestcase'] = 'Extract test case';
 $string['extracttestcase_desc'] = 'Use example data from the database to help create unit tests that can be used to test the upgrade.';
 $string['gotoindex'] = 'Back to the list of quizzes that can be upgraded';

local/qeupgradehelper/lib.php

@@ -0,0 +1,74 @@
+<?php
+
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Lib functions (cron) to automatically complete the question engine upgrade
+ * if it was not done all at once during the main upgrade.
+ *
+ * @package    local
+ * @subpackage qeupgradehelper
+ * @copyright  2011 The Open University
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+require_once (dirname(__FILE__) . '/locallib.php');
+
+
+/**
+ * Standard cron function
+ */
+function local_qeupgradehelper_cron() {
+    $settings = get_config('local_qeupgradehelper');
+    if (empty($settings->cronenabled)) {
+        return;
+    }
+
+    mtrace('qeupgradehelper: local_qeupgradehelper_cron() started at '. date('H:i:s'));
+    try {
+        local_qeupgradehelper_process($settings);
+    } catch (Exception $e) {
+        mtrace('qeupgradehelper: local_qeupgradehelper_cron() failed with an exception:');
+        mtrace($e->getMessage());
+    }
+    mtrace('qeupgradehelper: local_qeupgradehelper_cron() finished at ' . date('H:i:s'));
+}
+
+/**
+ * This function does the cron process within the time range according to settings.
+ */
+function local_qeupgradehelper_process($settings) {
+    if (!local_qeupgradehelper_is_upgraded()) {
+        mtrace('qeupgradehelper: site not yet upgraded. Doing nothing.');
+        return;
+    }
+
+    $hour = (int) date('H');
+    if ($hour < $settings->starthour || $hour >= $settings->stophour) {
+        mtrace('qeupgradehelper: not between starthour and stophour, so doing nothing (hour = ' .
+                $hour . ').');
+        return;
+    }
+
+    $stoptime = time() + $settings->procesingtime;
+    while (time() < $stoptime) {
+        mtrace('qeupgradehelper: processing ...');
+
+        // TODO
+        mtrace('qeupgradehelper: sorry, not implemented yet.');
+        return;
+    }
+}

local/qeupgradehelper/locallib.php

@@ -328,7 +328,7 @@ public function get_row($quizinfo) {
 
     protected function out_of($restrictedtotal, $fulltotal) {
         $a = new stdClass();
-        $a->some = $restrictedtotal;
+        $a->some = $a->some = html_writer::tag('b', $restrictedtotal);
         $a->total = $fulltotal;
         return get_string('outof', 'local_qeupgradehelper', $a);
     }
@@ -338,10 +338,8 @@ public function get_total_row() {
             '',
             html_writer::tag('b', get_string('total')),
             '',
-            html_writer::tag('b', $this->out_of(
-                    $this->restrictedtotalquizas, $this->totalquizas),
-            html_writer::tag('b', $this->out_of(
-                    $this->restrictedtotalqas, $this->totalqas))),
+            $this->out_of($this->restrictedtotalquizas, $this->totalquizas),
+            $this->out_of($this->restrictedtotalqas, $this->totalqas),
         );
     }
 }

local/qeupgradehelper/styles.css

@@ -1,2 +1,6 @@
-#page-local-qeupgradehelper-index {
+#page-admin-local-qeupgradehelper-index .dimmed {
+    color: grey;
+}
+#page-admin-local-qeupgradehelper-index .dimmed a {
+    color: #88c;
 }