mirrored from git://git.moodle.org/moodle.git
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-61244 caching: Allow granular purging of caches
- Loading branch information
Mark Johnson
committed
Jun 14, 2018
1 parent
9e7c397
commit e3389c8
Showing
7 changed files
with
219 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
<?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/>. | ||
|
||
/** | ||
* Form for selective purging of caches. | ||
* | ||
* @package core | ||
* @copyright 2018 The Open University | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
|
||
namespace core_admin\form; | ||
|
||
defined('MOODLE_INTERNAL') || die(); | ||
|
||
require_once($CFG->libdir.'/formslib.php'); | ||
|
||
/** | ||
* Form for selecting which caches to purge on admin/purgecaches.php | ||
* | ||
* @package core | ||
* @copyright 2018 The Open University | ||
* @author Mark Johnson <mark.johnson@open.ac.uk> | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
class purge_caches extends \moodleform { | ||
/** | ||
* Define a "Purge all caches" button, and a fieldset with checkboxes for selectively purging separate caches. | ||
*/ | ||
public function definition() { | ||
$mform = $this->_form; | ||
$mform->addElement('hidden', 'returnurl', $this->_customdata['returnurl']); | ||
$mform->setType('returnurl', PARAM_LOCALURL); | ||
$mform->addElement('submit', 'all', get_string('purgecaches', 'admin')); | ||
$mform->addElement('header', 'purgecacheheader', get_string('purgeselectedcaches', 'admin')); | ||
$checkboxes = [ | ||
$mform->createElement('advcheckbox', 'theme', '', get_string('purgethemecache', 'admin')), | ||
$mform->createElement('advcheckbox', 'lang', '', get_string('purgelangcache', 'admin')), | ||
$mform->createElement('advcheckbox', 'js', '', get_string('purgejscache', 'admin')), | ||
$mform->createElement('advcheckbox', 'filter', '', get_string('purgefiltercache', 'admin')), | ||
$mform->createElement('advcheckbox', 'muc', '', get_string('purgemuc', 'admin')), | ||
$mform->createElement('advcheckbox', 'other', '', get_string('purgeothercaches', 'admin')) | ||
]; | ||
$mform->addGroup($checkboxes, 'purgeselectedoptions'); | ||
$mform->addElement('submit', 'purgeselectedcaches', get_string('purgeselectedcaches', 'admin')); | ||
} | ||
|
||
/** | ||
* If the "Purge selected caches" button was pressed, ensure at least one cache was selected. | ||
* | ||
* @param array $data | ||
* @param array $files | ||
* @return array Error messages | ||
*/ | ||
public function validation($data, $files) { | ||
$errors = []; | ||
if (isset($data['purgeselectedcaches']) && empty(array_filter($data['purgeselectedoptions']))) { | ||
$errors['purgeselectedoptions'] = get_string('purgecachesnoneselected', 'admin'); | ||
} | ||
return $errors; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
@core @core_admin | ||
Feature: Purge caches | ||
In order to see changes to cached data | ||
As a Moodle administrator | ||
I want manually purge different data and file caches | ||
|
||
Background: | ||
Given I log in as "admin" | ||
And I navigate to "Development > Purge all caches" in site administration | ||
|
||
Scenario: Purge all caches | ||
Given I should not see "All caches were purged" | ||
When I press "Purge all caches" | ||
Then I should see "All caches were purged" | ||
|
||
Scenario: Purge selected caches | ||
Given I should not see "Selected caches were purged" | ||
When I set the field "Themes" to "1" | ||
And I press "Purge selected caches" | ||
Then I should see "The selected caches were purged" | ||
|
||
Scenario: Purge selected caches without selecting any caches | ||
Given I should not see "Select one or more caches to purge" | ||
When I press "Purge selected caches" | ||
Then I should not see "The selected caches were purged" | ||
And I should see "Select one or more caches to purge" | ||
|
||
Scenario: Redirect back to the original page after following a Purge all caches link | ||
Given I am on site homepage | ||
And I should see "Available courses" | ||
And I should not see "All caches were purged" | ||
When I follow "Purge all caches" | ||
Then I should see "All caches were purged" | ||
And I should see "Available courses" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters