Skip to content

Commit e6d51e4

Browse files
FragoniteFragonite
committed
Add update files context ad hoc task and cli script
1 parent 939ef51 commit e6d51e4

File tree

2 files changed

+234
-0
lines changed

2 files changed

+234
-0
lines changed

‎classes/task/update_files_context.php

+155
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
<?php
2+
// This file is part of Moodle - https://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 <https://www.gnu.org/licenses/>.
16+
17+
namespace mod_cms\task;
18+
19+
use core\task\adhoc_task;
20+
use csv_export_writer;
21+
use file_storage;
22+
use moodle_exception;
23+
24+
/**
25+
* Update the context of embedded files to match the context of the mod_cms module instance.
26+
*
27+
* @package mod_cms
28+
* @author Alexander Van der Bellen <[email protected]>
29+
* @copyright 2024 Catalyst IT Australia
30+
* @license https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
31+
*/
32+
class update_files_context extends adhoc_task {
33+
34+
/**
35+
* Factory method to create a new update_files_context task.
36+
*
37+
* @param int|null $courseid Limit the task to a specific course or all courses if null.
38+
* @param bool $dryrun Whether to run the task without making database changes.
39+
* @return update_files_context The task instance.
40+
*/
41+
public static function instance(?int $courseid = null, bool $dryrun = true): update_files_context {
42+
$task = new self();
43+
$task->set_custom_data((object) ['courseid' => $courseid, 'dryrun' => $dryrun]);
44+
return $task;
45+
}
46+
47+
/**
48+
* Run the task to delete course results for a user.
49+
*/
50+
public function execute(): void {
51+
global $CFG;
52+
$data = $this->get_custom_data();
53+
$csv = self::update_contexts($data->courseid, $data->dryrun);
54+
file_put_contents($CFG->dataroot . '/' . $csv->filename, $csv->print_csv_data(true));
55+
}
56+
57+
/**
58+
* Update mod_cms customfield_textarea embedded file contexts to match the context of the mod_cms module instance.
59+
* @param int|null $courseid Limit the task to a specific course or all courses if null.
60+
* @param bool $dryrun Whether to run the task without making database changes.
61+
* @return csv_export_writer The CSV export writer containing the results of the task.
62+
*/
63+
private static function update_contexts(?int $courseid, bool $dryrun): csv_export_writer {
64+
global $DB;
65+
66+
$sql = "SELECT f.*, ctx.id AS ctxid, cms.course AS courseid
67+
FROM {files} f
68+
JOIN {customfield_data} cfd ON cfd.id = f.itemid
69+
JOIN {customfield_field} cff ON cff.id = cfd.fieldid
70+
JOIN {cms} cms ON cms.id = cfd.instanceid
71+
JOIN {cms_types} cmst ON cmst.id = cms.typeid AND cmst.datasources LIKE '%fields%'
72+
JOIN {course_modules} cm ON cm.instance = cms.id
73+
JOIN {modules} m ON m.id = cm.module AND m.name = 'cms'
74+
JOIN {context} ctx ON ctx.instanceid = cm.id AND ctx.contextlevel = :modulecontextlevel
75+
WHERE f.contextid = 1 AND f.component = 'customfield_textarea' AND f.filearea = 'value'";
76+
77+
$params = ['modulecontextlevel' => CONTEXT_MODULE];
78+
79+
if (!empty($courseid)) {
80+
$sql .= " AND cms.course = :courseid";
81+
$params['courseid'] = $courseid;
82+
}
83+
84+
$csv = new csv_export_writer();
85+
$csv->set_filename('mod_cms_update_files_context');
86+
$csv->add_data([
87+
'courseid',
88+
'newpathnamehash',
89+
'newcontextid',
90+
'id',
91+
'contenthash',
92+
'pathnamehash',
93+
'contextid',
94+
'component',
95+
'filearea',
96+
'itemid',
97+
'filepath',
98+
'filename',
99+
'timecreated',
100+
'timemodified',
101+
]);
102+
103+
$records = $DB->get_recordset_sql($sql, $params);
104+
foreach ($records as $record) {
105+
$newcontextid = $record->ctxid;
106+
107+
$newpathnamehash = file_storage::get_pathname_hash(
108+
$newcontextid,
109+
$record->component,
110+
$record->filearea,
111+
$record->itemid,
112+
$record->filepath,
113+
$record->filename
114+
);
115+
116+
$csv->add_data([
117+
$record->courseid,
118+
$newpathnamehash,
119+
$newcontextid,
120+
$record->id,
121+
$record->contenthash,
122+
$record->pathnamehash,
123+
$record->contextid,
124+
$record->component,
125+
$record->filearea,
126+
$record->itemid,
127+
$record->filepath,
128+
$record->filename,
129+
$record->timecreated,
130+
$record->timemodified,
131+
]);
132+
133+
// Update the record with the new context id and path name hash.
134+
$record->contextid = $newcontextid;
135+
$record->pathnamehash = $newpathnamehash;
136+
137+
if (!$dryrun) {
138+
// Remove the ctxid and courseid fields.
139+
unset($record->ctxid);
140+
unset($record->courseid);
141+
142+
// Update the record in the database.
143+
try {
144+
$DB->update_record('files', $record);
145+
} catch (moodle_exception $e) {
146+
debugging('Failed to insert record into files table: ' . $e->getMessage(), DEBUG_DEVELOPER);
147+
}
148+
}
149+
}
150+
151+
$records->close();
152+
153+
return $csv;
154+
}
155+
}

‎cli/update_files_context.php

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
<?php
2+
// This file is part of Moodle - https://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 <https://www.gnu.org/licenses/>.
16+
17+
/**
18+
* CLI script to delete a section from a course
19+
*
20+
* @package mod_cms
21+
* @author Alexander Van der Bellen <[email protected]>
22+
* @copyright 2024 Catalyst IT Australia
23+
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24+
*/
25+
26+
use mod_cms\task\update_files_context;
27+
28+
define('CLI_SCRIPT', true);
29+
30+
require(__DIR__ . '/../../../config.php');
31+
require_once($CFG->libdir . '/clilib.php');
32+
require_once($CFG->libdir . '/cronlib.php');
33+
require_once($CFG->libdir . '/csvlib.class.php');
34+
require_once(__DIR__ . '/../classes/task/update_files_context.php');
35+
36+
list($options, $unrecognized) = cli_get_params(
37+
[
38+
'course' => null,
39+
'execute' => false,
40+
'help' => false,
41+
], [
42+
'c' => 'course',
43+
'e' => 'execute',
44+
'h' => 'help',
45+
]
46+
);
47+
48+
if ($unrecognized) {
49+
$unrecognized = implode("\n ", $unrecognized);
50+
cli_error(get_string('cliunknowoption', 'admin', $unrecognized));
51+
}
52+
53+
if ($options['help']) {
54+
$help = <<<EOT
55+
CLI script to update the context id of files belonging to mod_cms customfield_textarea instances.
56+
Output is a CSV file where each row represents a matching record in the files table plus the course id of the mod_cms instance.
57+
58+
Options:
59+
-h, --help Print out this help
60+
-c, --course Limit the task to a specific course instead of all courses
61+
-e, --execute Write changes to the database
62+
63+
Examples:
64+
\$sudo -u www-data /usr/bin/php mod/cms/cli/update_files_context.php
65+
\$sudo -u www-data /usr/bin/php mod/cms/cli/update_files_context.php --course=1234
66+
\$sudo -u www-data /usr/bin/php mod/cms/cli/update_files_context.php --course=1234 --execute
67+
68+
EOT;
69+
70+
echo $help;
71+
exit(0);
72+
}
73+
74+
$dryrun = empty($options['execute']);
75+
$courseid = $options['course'] ?? null;
76+
77+
$task = update_files_context::instance($courseid, $dryrun);
78+
$task->execute();
79+
mtrace("Task completed - please check the CSV file in your dataroot directory ({$CFG->dataroot})");

0 commit comments

Comments
 (0)