/
process.php
327 lines (295 loc) · 11.4 KB
/
process.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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
<?php
// 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/>.
/**
* OBU Forms - Process a form
*
* @package local_obu_forms
* @author Peter Welham
* @copyright 2019, Oxford Brookes University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*
*/
require_once('../../config.php');
require_once('./locallib.php');
require_once('./form_view.php');
require_once($CFG->libdir . '/moodlelib.php');
require_login();
$home = new moodle_url('/');
$dir = $home . 'local/obu_forms/';
$source = '';
if (local_obu_forms_is_manager()) {
$forms_course = local_obu_forms_get_forms_course();
require_login($forms_course);
if (isset($_REQUEST['source'])) {
$source = $_REQUEST['source'];
}
if ($source) {
$back = $dir . urldecode($source);
} else {
$back = $home . 'course/view.php?id=' . $forms_course;
}
} else {
$PAGE->set_context(context_user::instance($USER->id));
$back = $home;
}
if (!has_capability('local/obu_forms:update', context_system::instance())) {
redirect($back);
}
// We only handle an existing form (id given)
if (!isset($_REQUEST['id'])) {
echo(get_string('invalid_data', 'local_obu_forms'));
die;
}
$data_id = $_REQUEST['id'];
if (!local_obu_forms_load_form_data($data_id, $record, $fields)) {
echo(get_string('invalid_data', 'local_obu_forms'));
die;
}
$url = $dir . 'process.php?source=' . $source .'&id=' . $data_id;
$redirect_form = $dir . 'redirect.php?id=' . $data_id;
$title = get_string('forms_management', 'local_obu_forms');
$heading = get_string('form_title', 'local_obu_forms');
$PAGE->set_url($url);
$PAGE->set_pagelayout('standard');
$PAGE->set_title($title);
$PAGE->set_heading($title);
$template = local_obu_forms_read_form_template_by_id($record->template_id);
$form = local_obu_forms_read_form_settings($template->form_id);
$PAGE->navbar->add(get_string('form', 'local_obu_forms') . ' ' . $form->formref);
$message = '';
// If not awaiting authorisation by someone, display the current status (prominently)
if (($record->authorisation_state == 0) && ($record->authorisation_level == 0)) { // Form not yet submitted
if ($USER->id != $record->author) { // no-one else can look at your unsubmitted forms
$message = get_string('form_unavailable', 'local_obu_forms');
}
$status_text = get_string('status_not_submitted', 'local_obu_forms');
// For the time being, we auto-submit the form to avoid a two-stage process for the author (might change?)
local_obu_forms_update_workflow(true);
$status_text = '';
} else if ($record->authorisation_state == 1) { // Form rejected
$status_text = get_string('status_rejected', 'local_obu_forms');
} else if ($record->authorisation_state == 2) { // Form processed
$status_text = get_string('status_processed', 'local_obu_forms');
} else {
$status_text = '';
}
if ($status_text) {
$status_text = '<h3>' . $status_text . '</h3>';
}
local_obu_forms_get_form_status($USER->id, $form, $record, $text, $button_text); // get the authorisation trail and the next action (from the user's perspective)
$status_text .= $text;
if ($button_text != 'authorise') { // If not the next authoriser, check that this user can view the form
if (!local_obu_forms_is_manager($form) && ($USER->id != $record->author)) {
$message = get_string('form_unavailable', 'local_obu_forms');
}
} else { // Display any notes prepared for the authoriser
$text = '';
if ($record->authorisation_level == 1) {
$text = $form->auth_1_notes;
} else if ($record->authorisation_level == 2) {
$text = $form->auth_2_notes;
} else if ($record->authorisation_level == 3) {
$text = $form->auth_3_notes;
} else if ($record->authorisation_level == 4) {
$text = $form->auth_4_notes;
} else if ($record->authorisation_level == 5) {
$text = $form->auth_5_notes;
} else {
$text = $form->auth_6_notes;
}
if ($text) {
$text = '<h4>' . $text . '</h4>';
$status_text .= $text;
}
}
$parameters = [
'source' => $source,
'modular' => $form->modular,
'data_id' => $data_id,
'template' => $template,
'username' => null,
'surname' => null,
'forenames' => null,
'current_course' => null,
'start_dates' => null,
'start_selected' => null,
'adviser' => null,
'supervisor' => null,
'course' => null,
'not_enroled' => null,
'enroled' => null,
'study_mode' => null,
'reason' => null,
'addition_reason' => null,
'deletion_reason' => null,
'auth_state' => $record->authorisation_state,
'auth_level' => $record->authorisation_level,
'notes' => $record->notes,
'fields' => $fields,
'status_text' => $status_text,
'button_text' => $button_text
];
$mform = new form_view(null, $parameters);
if ($mform->is_cancelled()) {
redirect($back);
}
if ($mform_data = $mform->get_data()) {
if (($mform_data->auth_state == $record->authorisation_state) && ($mform_data->auth_level == $record->authorisation_level)) { // Check nothing happened while we were away (or they clicked twice)
if (local_obu_forms_is_manager($form) && ($mform_data->redirectbutton == get_string('redirect', 'local_obu_forms')) && ($record->authorisation_state == 0)) { // They want to redirect the form
local_obu_forms_save_notes($mform_data->notes);
redirect($redirect_form);
} else if (local_obu_forms_is_manager($form) && ($mform_data->savebutton == get_string('save', 'local_obu_forms'))) { // They just want to save the notes
local_obu_forms_save_notes($mform_data->notes);
} else if (($button_text == 'authorise') && ($mform_data->submitbutton != get_string('continue', 'local_obu_forms'))) { // They can do something (and they want to)
if (local_obu_forms_is_manager($form)) { // A forms manager
local_obu_forms_save_notes($mform_data->notes);
}
if ($mform_data->rejectbutton != get_string('reject', 'local_obu_forms')) {
local_obu_forms_update_workflow(true, $mform_data->comment);
} else {
local_obu_forms_update_workflow(false, $mform_data->comment);
}
}
}
if ($USER->id == $record->author) { // Looking at their own form
redirect($dir);
} else {
redirect($back);
}
}
echo $OUTPUT->header();
if ($message) {
notice($message, $back);
}
else {
$mform->display();
}
echo $OUTPUT->footer();
function local_obu_forms_save_notes($notes) {
global $record, $fields;
// Update the form data record
$record->notes = $notes;
local_obu_forms_save_form_data($record, $fields);
}
function local_obu_forms_update_workflow($authorised = true, $comment = null) {
global $form, $record, $fields;
// Update the form data record
$authoriser_id = 0;
if ($record->authorisation_level == 0) { // Being submitted
$authoriser_id = local_obu_forms_get_authoriser($record->author, $form->modular, $form->auth_1_role, $fields);
$record->auth_1_id = $authoriser_id;
if ($authoriser_id != 0) {
$record->authorisation_level = 1;
} else { // Skip the level (OK for some roles)
$authoriser_id = local_obu_forms_get_authoriser($record->author, $form->modular, $form->auth_2_role, $fields);
$record->auth_2_id = $authoriser_id;
$record->authorisation_level = 2;
}
} else if ($record->authorisation_level == 1) {
$record->auth_1_notes = $comment;
$record->auth_1_date = time();
if (!$authorised) {
$record->authorisation_state = 1; // Rejected
} else if ($form->auth_2_role == 0) {
$record->authorisation_state = 2; // It ends here
} else {
$authoriser_id = local_obu_forms_get_authoriser($record->author, $form->modular, $form->auth_2_role, $fields);
$record->auth_2_id = $authoriser_id;
if ($authoriser_id != 0) {
$record->authorisation_level = 2;
} else { // Skip the level (OK for some roles)
$authoriser_id = local_obu_forms_get_authoriser($record->author, $form->modular, $form->auth_3_role, $fields);
$record->auth_3_id = $authoriser_id;
$record->authorisation_level = 3;
}
}
} else if ($record->authorisation_level == 2) {
$record->auth_2_notes = $comment;
$record->auth_2_date = time();
if (!$authorised) {
$record->authorisation_state = 1; // Rejected
} else if ($form->auth_3_role == 0) {
$record->authorisation_state = 2; // It ends here
} else {
$authoriser_id = local_obu_forms_get_authoriser($record->author, $form->modular, $form->auth_3_role, $fields);
$record->auth_3_id = $authoriser_id;
if ($authoriser_id != 0) {
$record->authorisation_level = 3;
} else { // Skip the level (OK for some roles)
$authoriser_id = local_obu_forms_get_authoriser($record->author, $form->modular, $form->auth_4_role, $fields);
$record->auth_4_id = $authoriser_id;
$record->authorisation_level = 4;
}
}
} else if ($record->authorisation_level == 3) {
$record->auth_3_notes = $comment;
$record->auth_3_date = time();
if (!$authorised) {
$record->authorisation_state = 1; // Rejected
} else if ($form->auth_4_role == 0) {
$record->authorisation_state = 2; // It ends here
} else {
$authoriser_id = local_obu_forms_get_authoriser($record->author, $form->modular, $form->auth_4_role, $fields);
$record->auth_4_id = $authoriser_id;
if ($authoriser_id != 0) {
$record->authorisation_level = 4;
} else { // Skip the level (OK for some roles)
$authoriser_id = local_obu_forms_get_authoriser($record->author, $form->modular, $form->auth_5_role, $fields);
$record->auth_5_id = $authoriser_id;
$record->authorisation_level = 5;
}
}
} else if ($record->authorisation_level == 4) {
$record->auth_4_notes = $comment;
$record->auth_4_date = time();
if (!$authorised) {
$record->authorisation_state = 1; // Rejected
} else if ($form->auth_5_role == 0) {
$record->authorisation_state = 2; // It ends here
} else {
$authoriser_id = local_obu_forms_get_authoriser($record->author, $form->modular, $form->auth_5_role, $fields);
$record->auth_5_id = $authoriser_id;
if ($authoriser_id != 0) {
$record->authorisation_level = 5;
} else { // Skip the level (OK for some roles)
$authoriser_id = local_obu_forms_get_authoriser($record->author, $form->modular, $form->auth_6_role, $fields);
$record->auth_6_id = $authoriser_id;
$record->authorisation_level = 6;
}
}
} else if ($record->authorisation_level == 5) {
$record->auth_5_notes = $comment;
$record->auth_5_date = time();
if (!$authorised) {
$record->authorisation_state = 1; // Rejected
} else if ($form->auth_6_role == 0) {
$record->authorisation_state = 2; // It ends here
} else {
$authoriser_id = local_obu_forms_get_authoriser($record->author, $form->modular, $form->auth_6_role, $fields);
$record->auth_6_id = $authoriser_id;
$record->authorisation_level = 6;
}
} else {
$record->auth_6_notes = $comment;
$record->auth_6_date = time();
if (!$authorised) {
$record->authorisation_state = 1; // Rejected
} else {
$record->authorisation_state = 2; // It ends here
}
}
local_obu_forms_save_form_data($record, $fields);
// Update the stored authorisation requests and send notification emails
local_obu_forms_update_authoriser($form, $record, $authoriser_id);
}