MDL-48252 scheduled tasks: file_temp_cleanup_task does full delete.
[moodle.git] / lib / classes / task / file_temp_cleanup_task.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * A scheduled task.
19  *
20  * @package    core
21  * @copyright  2013 onwards Martin Dougiamas  http://dougiamas.com
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
24 namespace core\task;
26 /**
27  * Simple task to delete temp files older than 1 week.
28  */
29 class file_temp_cleanup_task extends scheduled_task {
31     /**
32      * Get a descriptive name for this task (shown to admins).
33      *
34      * @return string
35      */
36     public function get_name() {
37         return get_string('tasktempfilecleanup', 'admin');
38     }
40     /**
41      * Do the job.
42      * Throw exceptions on errors (the job will be retried).
43      */
44     public function execute() {
45         global $CFG;
47         $tmpdir = $CFG->tempdir;
48         // Default to last weeks time.
49         $time = strtotime('-1 week');
51         $dir = new \RecursiveDirectoryIterator($tmpdir);
52         // Show all child nodes prior to their parent.
53         $iter = new \RecursiveIteratorIterator($dir, \RecursiveIteratorIterator::CHILD_FIRST);
55         // An array of the full path (key) and date last modified.
56         $modifieddateobject = array();
58         // Get the time modified for each directory node. Nodes will be updated
59         // once a file is deleted, so we need a list of the original values.
60         for ($iter->rewind(); $iter->valid(); $iter->next()) {
61             $node = $iter->getRealPath();
62             if (!is_readable($node)) {
63                 continue;
64             }
65             $modifieddateobject[$node] = $iter->getMTime();
66         }
68         // Now loop through again and remove old files and directories.
69         for ($iter->rewind(); $iter->valid(); $iter->next()) {
70             $node = $iter->getRealPath();
71             if (!is_readable($node)) {
72                 continue;
73             }
75             // Check if file or directory is older than the given time.
76             if ($modifieddateobject[$node] < $time) {
77                 if ($iter->isDir() && !$iter->isDot()) {
78                     // Don't attempt to delete the directory if it isn't empty.
79                     if (!glob($node. DIRECTORY_SEPARATOR . '*')) {
80                         if (@rmdir($node) === false) {
81                             mtrace("Failed removing directory '$node'.");
82                         }
83                     }
84                 }
85                 if ($iter->isFile()) {
86                     if (@unlink($node) === false) {
87                         mtrace("Failed removing file '$node'.");
88                     }
89                 }
90             } else {
91                 // Return the time modified to the original date.
92                 touch($node, $modifieddateobject[$node]);
93             }
94         }
95     }
97 }