-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathimport.php
227 lines (173 loc) · 7.67 KB
/
import.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
<?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/>.
/**
* Import translations
*
* @package filter_translations
* @copyright 2023 Rajneel Totaram <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
use filter_translations\translation;
define('REASON_LANGNOTFOUND', 1); // Language not found on the site.
define('REASON_RECORDEXISTS', 2); // Transaltion record already exsits.
define('REASON_MISSINGCSVDATA', 3); // Some transaltion data is missing.
require('../../config.php');
require_once($CFG->libdir . '/csvlib.class.php');
$courseid = optional_param('id', SITEID, PARAM_INT);
if ($courseid > 1) {
// Not really necessary to check course, but it provides a nicer user exprience.
if (!$course = $DB->get_record('course', ['id' => $courseid])) {
throw new \moodle_exception('invalidcourseid');
}
}
require_login();
$context = context_system::instance();
require_capability('filter/translations:bulkimporttranslations', $context);
$url = new moodle_url('/filter/translations/import.php', []);
$PAGE->set_url($url);
$PAGE->set_context($context);
$title = get_string('importtranslations', 'filter_translations');
$PAGE->set_title($title);
$PAGE->set_heading($title);
$PAGE->set_pagelayout('standard');
$form = new \filter_translations\form\import_form();
$data = new stdClass();
$data->id = $courseid;
$form->set_data($data);
if ($form->is_cancelled()) {
if ($courseid > SITEID) {
redirect(new moodle_url('/course/view.php', ['id' => $courseid]));
}
redirect($CFG->wwwroot);
} else if ($data = $form->get_data()) {
$filecontents = $form->get_file_content('file');
$importid = csv_import_reader::get_new_iid('translationimport');
$csvimport = new csv_import_reader($importid, 'translationimport');
$delimiter = 'comma';
$encoding = 'UTF-8';
$readcount = $csvimport->load_csv_content($filecontents, $encoding, $delimiter);
if ($readcount === false) {
throw new \moodle_exception('csvfileerror', 'error', $PAGE->url, $csvimport->get_error());
} else if ($readcount == 0) {
throw new \moodle_exception('csvemptyfile', 'error', $PAGE->url, $csvimport->get_error());
} else if ($readcount == 1) {
throw new \moodle_exception('csvnodata', 'error', $PAGE->url);
}
$csvimport->init();
unset($filecontents); // Not needed anymore.
// These are the fields, and they always should be in the same order (for simplicity).
$requiredfields = ['md5key', 'rawtext', 'substitutetext', 'targetlanguage', 'contextid'];
// Using get_columns() ensures the Byte Order Mark is removed.
$header = $csvimport->get_columns();
// Check that the fields in the CSV file are in the expected/required order.
// Same number of fields and always in the same order.
if (count($header) != count($requiredfields)) {
throw new \moodle_exception('fieldsmismatch', 'filter_translations', $PAGE->url);
}
foreach ($header as $i => $h) {
if (!in_array($h, $requiredfields)) {
throw new \moodle_exception('fieldrequired', 'filter_translations', $PAGE->url, $h);
}
if ($h != $requiredfields[$i]) {
throw new \moodle_exception('fieldwrongorder', 'filter_translations', $PAGE->url, $h);
}
}
$filter = new filter_translations($context, []);
// Get list of languages on the site.
$listoftranslations = get_string_manager()->get_list_of_translations(true);
$skipped = [];
$linenum = 2; // Since header is line 1.
while ($line = $csvimport->next()) {
$md5key = trim($line[0]);
$rawtext = trim($line[1]);
$substitutetext = trim($line[2]);
$targetlanguage = trim($line[3]);
$contextid = trim($line[4]);
// Skip if any field is empty.
if (empty($md5key) || empty($rawtext) || empty($substitutetext) || empty($targetlanguage) || empty($contextid)) {
$row = new stdClass();
$row->linenum = $linenum;
$row->md5key = $md5key;
$row->targetlanguage = $targetlanguage;
$row->reason = get_string('reasonimportskipped' . REASON_MISSINGCSVDATA, 'filter_translations');
$skipped[$linenum] = $row;
$linenum++; // Increment line number before skipping.
continue;
}
// Skip line if language is not installed.
if (!isset($listoftranslations[$targetlanguage])) {
$row = new stdClass();
$row->linenum = $linenum;
$row->md5key = $md5key;
$row->targetlanguage = $targetlanguage;
$row->reason = get_string('reasonimportskipped' . REASON_LANGNOTFOUND, 'filter_translations');
$skipped[$linenum] = $row;
$linenum++; // Increment line number before skipping.
continue;
}
// Ready to import into the database.
// You can only import new/missing translations.
// Existing translations cannot be overwritten. Atleast not if overwrite is allowed.
// Check records from filter_translations matching md5key and targetlanguage.
$count = $DB->count_records('filter_translations', ['md5key' => $md5key, 'targetlanguage' => $targetlanguage]);
if ($count == 0) {
// Nothing found, good to import.
$persistent = new translation();
$persistent->set('md5key', trim($line[0]));
$persistent->set('rawtext', trim($line[1]));
$persistent->set('substitutetext', trim($line[2]));
$persistent->set('targetlanguage', trim($line[3]));
$persistent->set('contextid', trim($line[4]));
$persistent->set('lastgeneratedhash', $filter->generatehash($persistent->get('rawtext')));
$persistent->set('substitutetextformat', 1); // TODO: Set correct format.
$persistent->create();
} else {
// If a record exists, skip this one, Do not update.
$row = new stdClass();
$row->linenum = $linenum;
$row->md5key = $md5key;
$row->targetlanguage = $targetlanguage;
$row->reason = get_string('reasonimportskipped' . REASON_RECORDEXISTS, 'filter_translations');
$skipped[$linenum] = $row;
}
$linenum++;
}
$csvimport->close();
// Show the import summary.
echo $OUTPUT->header();
$processedcount = $linenum - 2;
$skippedcount = count($skipped);
if ($courseid > SITEID) {
$returnurl = new moodle_url('/course/view.php', ['id' => $courseid]);
} else {
$returnurl = new moodle_url('/');
}
$data = (object) [
'processedcount' => $processedcount,
'skippedcount' => $skippedcount,
'skipped' => array_values($skipped),
'continueurl' => $returnurl,
];
echo $OUTPUT->render_from_template('filter_translations/import_summary', $data);
echo $OUTPUT->footer();
exit;
}
echo $OUTPUT->header();
echo '<div class="description">';
echo get_string('importdescription', 'filter_translations');
echo '</div>';
$form->display();
echo $OUTPUT->footer();