-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSpecialGrades.php
4033 lines (3155 loc) · 178 KB
/
SpecialGrades.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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* Implements Special:Grades
*
* @package ScholasticGrading
* @author Jeffrey Gill <[email protected]>
*/
class SpecialGrades extends SpecialPage {
/**
* Constructor for SpecialGrades
*
* Sets up the special page Special:Grades
*
*/
function __construct() {
parent::__construct('Grades');
} /* end constructor */
/**
* Main execution method
*
* This function is run automatically when the special page is loaded
*
* @param string|null $subPage optional action passed in URL as Special:Grades/subPage
*/
function execute ( $subPage ) {
$page = $this->getOutput();
# Set the page title
$this->setHeaders();
# Load JavaScript and CSS resources
$page->addModules('ext.ScholasticGrading.SpecialGrades');
# Check whether database tables exist
if ( !$this->allTablesExist() ) {
return;
}
# Process requests
$request = $this->getRequest();
$action = $subPage ? $subPage : $request->getVal('action', $subPage);
switch ( $action ) {
case 'assignments':
if ( $this->canModify(true) ) {
$this->showAllAssignments();
}
$page->returnToMain(false, $this->getTitle());
break;
case 'groups':
if ( $this->canModify(true) ) {
$this->showAllGroups();
}
$page->returnToMain(false, $this->getTitle());
break;
case 'viewuserscores':
if ( $this->canModify(true) ) {
$page->addHTML(Html::rawElement('p', null,
Html::element('a', array('class' => 'sg-toggleunevaluated', 'href' => 'javascript:void(0);'), 'Hide unevaluated assignments')) . "\n");
$this->showUserScores(
$request->getVal('user', false)
);
}
$page->returnToMain(false, $this->getTitle());
break;
case 'viewalluserscores':
if ( $this->canModify(true) ) {
$page->addHTML(Html::rawElement('p', null,
Html::element('a', array('class' => 'sg-toggleuserscores', 'href' => 'javascript:void(0);'), 'Hide tables') . ' | ' .
Html::element('a', array('class' => 'sg-toggleunevaluated', 'href' => 'javascript:void(0);'), 'Hide unevaluated assignments')) . "\n");
$this->showAllUserScores();
}
$page->returnToMain(false, $this->getTitle());
break;
case 'editassignment':
if ( $this->canModify(true) ) {
$this->showAssignmentForm(
$request->getVal('id', false)
);
}
$page->returnToMain(false, $this->getTitle());
break;
case 'editevaluation':
if ( $this->canModify(true) ) {
$this->showEvaluationForm(
$request->getVal('user', false),
$request->getVal('assignment', false)
);
}
$page->returnToMain(false, $this->getTitle());
break;
case 'editadjustment':
if ( $this->canModify(true) ) {
$this->showAdjustmentForm(
$request->getVal('id', false),
$request->getVal('user', false)
);
}
$page->returnToMain(false, $this->getTitle());
break;
case 'editgroup':
if ( $this->canModify(true) ) {
$this->showGroupForm(
$request->getVal('id', false)
);
}
$page->returnToMain(false, $this->getTitle());
break;
case 'edituserscores':
if ( $this->canModify(true) ) {
$this->showUserScoreForms(
$request->getVal('user', false)
);
$page->addHTML(Html::rawElement('p', null,
Linker::linkKnown($this->getTitle(), 'See student\'s view', array(),
array('action' => 'viewuserscores', 'user' => $request->getVal('user', false))) . '.') . "\n");
}
$page->returnToMain(false, $this->getTitle());
break;
case 'editassignmentscores':
if ( $this->canModify(true) ) {
$this->showAssignmentEvaluationForms(
$request->getVal('id', false)
);
}
$page->returnToMain(false, $this->getTitle());
break;
case 'submit':
if ( $this->canModify(true) ) {
if ( $request->wasPosted() && $this->getUser()->matchEditToken($request->getVal('wpEditToken')) ) {
$this->submitForms();
} else {
# Prevent cross-site request forgeries
$page->addWikiMsg('sessionfailure');
}
}
$page->returnToMain(false, $this->getTitle());
break;
default:
if ( !$this->getUser()->isAnon() ) {
# User is registered and logged in
if ( $this->canModify(false) ) {
$page->addHTML(Html::rawElement('p', null,
Linker::linkKnown($this->getTitle(), 'Manage groups', array(),
array('action' => 'groups')) . ' | ' .
Linker::linkKnown($this->getTitle(), 'Manage assignments', array(),
array('action' => 'assignments')) . ' | ' .
Linker::linkKnown($this->getTitle(), 'View all user scores', array(),
array('action' => 'viewalluserscores')) . ' | ' .
Linker::linkKnown(Title::newFromText('Special:Log/grades'), 'View grade log')) . "\n");
$this->showGradeGrids();
} else {
$page->addHTML(Html::rawElement('p', null,
Html::element('a', array('class' => 'sg-toggleunevaluated', 'href' => 'javascript:void(0);'), 'Hide unevaluated assignments')) . "\n");
$this->showUserScores(
$this->getUser()->getId()
);
}
} else {
# The user is not logged in
$page->addWikiText('Grades are only available to registered users. You must be logged in to see your grades.');
}
break;
} /* end switch action */
} /* end execute */
/**
* Check whether all database tables exist
*
* Determines whether the database tables used by the extension exist
* and provides warnings if any do not.
*/
function allTablesExist () {
$page = $this->getOutput();
$dbr = wfGetDB(DB_SLAVE);
$allTablesExist = true;
$tables = array(
'scholasticgrading_assignment',
'scholasticgrading_evaluation',
'scholasticgrading_adjustment',
'scholasticgrading_group',
'scholasticgrading_groupuser',
'scholasticgrading_groupassignment'
);
foreach ( $tables as $table ) {
if ( !$dbr->tableExists($table) ) {
$page->addHTML(Html::element('p', null, 'Database table ' . $table . ' does not exist.') . "\n");
$allTablesExist = false;
}
}
if ( !$allTablesExist )
$page->addHTML(Html::element('p', null, 'Run maintenance/update.php.') . "\n");
return $allTablesExist;
} /* end allTablesExist */
/**
* Check grade editing permissions
*
* Determines whether the user has privileges to modify assignments and grades
*
* @param bool $printErrors whether to display error messages on the page
* @return bool whether the user can modify assignments and grades
*/
function canModify ( $printErrors = false ) {
$page = $this->getOutput();
if ( !$this->getUser()->isAllowed('editgrades') ) {
# The user does not have the correct privileges
if ( $printErrors ) {
throw new PermissionsError('editgrades');
}
return false;
} elseif ( wfReadOnly() ) {
# The database is in read-only mode
if ( $printErrors ) {
$page->readOnlyPage();
}
return false;
}
return true;
} /* end canModify */
/**
* Validate a title string
*
* Returns the string with leading and trailing
* whitespace removed if non-whitespace characters
* are present. Otherwise, returns false.
*
* @param string $test_title title string to validate
* @return sting|bool the trimmed string or false
*/
function validateTitle ( $test_title ) {
if ( strlen(trim($test_title)) > 0 ) {
return trim($test_title);
} else {
return false;
}
} /* end validateTitle */
/**
* Validate a date string
*
* Returns the date string if it has the form
* YYYY-MM-DD or null if it is an empty string.
* Otherwise, returns false.
*
* @param string $test_date date string to validate
* @return sting|bool the date string or false
*/
function validateDate ( $test_date ) {
if ( trim($test_date) == '' )
return null;
$date = DateTime::createFromFormat('Y-m-d', trim($test_date));
$date_errors = DateTime::getLastErrors();
if ( $date_errors['warning_count'] + $date_errors['error_count'] > 0 ) {
# Date is not of the form YYYY-MM-DD
return false;
} else {
return $date->format('Y-m-d');
}
} /* end validateDate */
/**
* Compare two scores and sort by date then title
*
* @param array $score1 score array containing date and title keys
* @param array $score2 score array containing date and title keys
* @return int -1, 1, or 0 if $score1 should be sorted before, after, or is equivalent to $score2
*/
function sortScores ( $score1, $score2 ) {
if ( $score1['date'] === null && $score2['date'] === null ) {
return strcmp($score1['title'], $score2['title']);
} elseif ( $score1['date'] === null ) {
return 1;
} elseif ( $score2['date'] === null ) {
return -1;
} elseif ( strcmp($score1['date'], $score2['date']) ) {
return strcmp($score1['date'], $score2['date']);
} else {
return strcmp($score1['title'], $score2['title']);
}
} /* end sortScores */
/**
* Set the page title depending on context
*
* Creates the title shown at the top of each page
* and in the browser title bar. Title depends on
* the interface in use.
*/
function getDescription() {
$request = $this->getRequest();
$action = $request->getVal('action');
if ( $request->getVal('title') == $this->getTitle() ) {
# User is visiting this special page
switch ( $action ) {
case 'assignments':
return 'Manage assignments';
break;
case 'groups':
return 'Manage groups';
break;
case 'edituserscores':
# Check whether user exists
$dbr = wfGetDB(DB_SLAVE);
$user = $dbr->selectRow('user', '*', array('user_id' => $request->getVal('user', false)));
if ( $user ) {
# The user exists
return 'Edit scores for ' . $this->getUserDisplayName($user->user_id);
} else {
# The user does not exist
return $this->msg('grades')->plain();
}
break;
case 'editassignmentscores':
# Check whether assignment exists
$dbr = wfGetDB(DB_SLAVE);
$assignment = $dbr->selectRow('scholasticgrading_assignment', '*', array('sga_id' => $request->getVal('id', false)));
if ( $assignment ) {
# The assignment exists
return 'Edit scores for "' . $assignment->sga_title . '" (' . $assignment->sga_date . ')';
} else {
# The assignment does not exist
return $this->msg('grades')->plain();
}
break;
case 'viewuserscores':
return 'Grades for ' . $this->getUserDisplayName($request->getVal('user', false));
break;
default:
if ( !$this->getUser()->isAnon() ) {
# User is registered and logged in
if ( $this->canModify(false) ) {
# Grader interface
return $this->msg('grades')->plain();
} else {
# Student interface
return 'Grades for ' . $this->getUserDisplayName(false);
}
} else {
# The user is not logged in
return $this->msg('grades')->plain();
}
break;
}
} else {
# User is viewing another page, such as Special:SpecialPages
return $this->msg('grades')->plain();
}
} /* end getDescription */
/**
* Get the user display name
*
* If a valid user id is provided, returns the
* user's real name with user name in parentheses,
* or, if the user has no real name, returns the
* user name instead. If false is provided, uses
* the information of the user that executed the
* page. Returns false if an invalid id is provided.
*
* @param int|bool user_id the user id
* @return string|bool the user display name or false
*/
function getUserDisplayName ( $user_id = false ) {
if ( $user_id ) {
# Use the provided user id to look up
# the user in the database
$dbr = wfGetDB(DB_SLAVE);
# Check whether user exists
$user = $dbr->selectRow('user', '*', array('user_id' => $user_id));
if ( $user ) {
# The user exists
# Determine if the user has a real name
if ( $user->user_real_name ) {
# Return the user real name with user name
return $user->user_real_name . ' (' . $user->user_name . ')';
} else {
# Return user name only
return $user->user_name;
}
} else {
# The user does not exist
return false;
}
} else {
# Use the user executing the page
# Determine if the user has a real name
if ( $this->getUser()->getRealName() ) {
# Return the user real name with user name
return $this->getUser()->getRealName() . ' (' . $this->getUser()->getName() . ')';
} else {
# Return user name only
return $this->getUser()->getName();
}
}
} /* end getUserDisplayName */
/**
* Process sets of assignment/evaluation/adjustment/group creation/modification/deletion requests
*
* Processes assignment, evaluation, adjustment, and group forms. Does not
* directly modify the database. Instead, each set of assignment parameters
* is sent to the writeAssignment function one at a time, each set of
* evaluation parameters is sent to the writeEvaluation function one at a
* time, each set of adjustment parameters is sent to the writeAdjustment
* function one at a time, and each set of group parameters is sent to the
* writeGroup function one at a time. The function first checks whether
* a delete button was pressed for any assignment, evaluation, adjustment,
* or group. If one was, all other requests are ignored, and the delete
* request is sent to the appropriate database function.
*
* @return bool whether the database was changed or not
*/
function submitForms () {
$page = $this->getOutput();
$request = $this->getRequest();
$assignmentParams = $request->getArray('assignment-params');
$evaluationParams = $request->getArray('evaluation-params');
$adjustmentParams = $request->getArray('adjustment-params');
$groupParams = $request->getArray('group-params');
if ( !$assignmentParams && !$evaluationParams && !$adjustmentParams && !$groupParams ) {
# No parameters are available to be processed
$page->addWikiText('Parameter arrays are missing or invalid.');
return;
}
# If this is a submission of more than one item, turn off warnings
$verboseFlag = true;
if ( count($assignmentParams) + count($evaluationParams) + count($adjustmentParams) + count($groupParams) > 1 )
$verboseFlag = false;
# Fill in missing parameters and handle any delete requests
if ( $assignmentParams ) {
foreach ( $assignmentParams as $key => $assignment ) {
# Store default values for missing parameters
if ( !array_key_exists('assignment-id', $assignment) )
$assignmentParams[$key]['assignment-id'] = false;
if ( !array_key_exists('assignment-title', $assignment) )
$assignmentParams[$key]['assignment-title'] = false;
if ( !array_key_exists('assignment-value', $assignment) )
$assignmentParams[$key]['assignment-value'] = false;
if ( !array_key_exists('assignment-enabled', $assignment) ) {
# Form posts omit checkboxes that are unchecked
$assignmentParams[$key]['assignment-enabled'] = false;
}
if ( !array_key_exists('assignment-date', $assignment) )
$assignmentParams[$key]['assignment-date'] = false;
if ( !array_key_exists('assignment-group', $assignment) )
$assignmentParams[$key]['assignment-group'] = false;
# Check whether a delete button was pressed
if ( $request->getVal('delete-assignment-' . $key, false) ) {
$dbChanged = $this->writeAssignment(
$assignmentParams[$key]['assignment-id'],
$assignmentParams[$key]['assignment-title'],
$assignmentParams[$key]['assignment-value'],
$assignmentParams[$key]['assignment-enabled'],
$assignmentParams[$key]['assignment-date'],
$assignmentParams[$key]['assignment-group'],
true
);
if ( $dbChanged )
$page->addWikiText('All changes are logged at [[Special:Log/grades]].');
return;
}
}
}
if ( $evaluationParams ) {
foreach ( $evaluationParams as $key => $evaluation ) {
# Store default values for missing parameters
if ( !array_key_exists('evaluation-user', $evaluation) )
$evaluationParams[$key]['evaluation-user'] = false;
if ( !array_key_exists('evaluation-assignment', $evaluation) )
$evaluationParams[$key]['evaluation-assignment'] = false;
if ( !array_key_exists('evaluation-score', $evaluation) )
$evaluationParams[$key]['evaluation-score'] = false;
if ( !array_key_exists('evaluation-enabled', $evaluation) ) {
# Form posts omit checkboxes that are unchecked
$evaluationParams[$key]['evaluation-enabled'] = false;
}
if ( !array_key_exists('evaluation-date', $evaluation) )
$evaluationParams[$key]['evaluation-date'] = false;
if ( !array_key_exists('evaluation-comment', $evaluation) )
$evaluationParams[$key]['evaluation-comment'] = false;
# Check whether a delete button was pressed
if ( $request->getVal('delete-evaluation-' . $key, false) ) {
$dbChanged = $this->writeEvaluation(
$evaluationParams[$key]['evaluation-user'],
$evaluationParams[$key]['evaluation-assignment'],
$evaluationParams[$key]['evaluation-score'],
$evaluationParams[$key]['evaluation-enabled'],
$evaluationParams[$key]['evaluation-date'],
$evaluationParams[$key]['evaluation-comment'],
true
);
if ( $dbChanged )
$page->addWikiText('All changes are logged at [[Special:Log/grades]].');
return;
}
}
}
if ( $adjustmentParams ) {
foreach ( $adjustmentParams as $key => $adjustment ) {
# Store default values for missing parameters
if ( !array_key_exists('adjustment-id', $adjustment) )
$adjustmentParams[$key]['adjustment-id'] = false;
if ( !array_key_exists('adjustment-user', $adjustment) )
$adjustmentParams[$key]['adjustment-user'] = false;
if ( !array_key_exists('adjustment-title', $adjustment) )
$adjustmentParams[$key]['adjustment-title'] = false;
if ( !array_key_exists('adjustment-value', $adjustment) )
$adjustmentParams[$key]['adjustment-value'] = false;
if ( !array_key_exists('adjustment-score', $adjustment) )
$adjustmentParams[$key]['adjustment-score'] = false;
if ( !array_key_exists('adjustment-enabled', $adjustment) ) {
# Form posts omit checkboxes that are unchecked
$adjustmentParams[$key]['adjustment-enabled'] = false;
}
if ( !array_key_exists('adjustment-date', $adjustment) )
$adjustmentParams[$key]['adjustment-date'] = false;
if ( !array_key_exists('adjustment-comment', $adjustment) )
$adjustmentParams[$key]['adjustment-comment'] = false;
# Check whether a delete button was pressed
if ( $request->getVal('delete-adjustment-' . $key, false) ) {
$dbChanged = $this->writeAdjustment(
$adjustmentParams[$key]['adjustment-id'],
$adjustmentParams[$key]['adjustment-user'],
$adjustmentParams[$key]['adjustment-title'],
$adjustmentParams[$key]['adjustment-value'],
$adjustmentParams[$key]['adjustment-score'],
$adjustmentParams[$key]['adjustment-enabled'],
$adjustmentParams[$key]['adjustment-date'],
$adjustmentParams[$key]['adjustment-comment'],
true
);
if ( $dbChanged )
$page->addWikiText('All changes are logged at [[Special:Log/grades]].');
return;
}
}
}
if ( $groupParams ) {
foreach ( $groupParams as $key => $group ) {
# Store default values for missing parameters
if ( !array_key_exists('group-id', $group) )
$groupParams[$key]['group-id'] = false;
if ( !array_key_exists('group-title', $group) )
$groupParams[$key]['group-title'] = false;
if ( !array_key_exists('group-enabled', $group) ) {
# Form posts omit checkboxes that are unchecked
$groupParams[$key]['group-enabled'] = false;
}
if ( !array_key_exists('group-user', $group) )
$groupParams[$key]['group-user'] = false;
# Check whether a delete button was pressed
if ( $request->getVal('delete-group-' . $key, false) ) {
$dbChanged = $this->writeGroup(
$groupParams[$key]['group-id'],
$groupParams[$key]['group-title'],
$groupParams[$key]['group-enabled'],
$groupParams[$key]['group-user'],
true
);
if ( $dbChanged )
$page->addWikiText('All changes are logged at [[Special:Log/grades]].');
return;
}
}
}
# A delete button was not pressed, so write all changes
$dbChangedAtLeastOnce = false;
if ( $assignmentParams ) {
# Make database changes for each assignment in assignment-params
foreach ( $assignmentParams as $assignment ) {
$dbChanged = $this->writeAssignment(
$assignment['assignment-id'],
$assignment['assignment-title'],
$assignment['assignment-value'],
$assignment['assignment-enabled'],
$assignment['assignment-date'],
$assignment['assignment-group'],
false,
$verboseFlag
);
$dbChangedAtLeastOnce = $dbChangedAtLeastOnce || $dbChanged;
}
}
if ( $evaluationParams ) {
# Make database changes for each evaluation in evaluation-params
foreach ( $evaluationParams as $evaluation ) {
$dbChanged = $this->writeEvaluation(
$evaluation['evaluation-user'],
$evaluation['evaluation-assignment'],
$evaluation['evaluation-score'],
$evaluation['evaluation-enabled'],
$evaluation['evaluation-date'],
$evaluation['evaluation-comment'],
false,
$verboseFlag
);
$dbChangedAtLeastOnce = $dbChangedAtLeastOnce || $dbChanged;
}
}
if ( $adjustmentParams ) {
# Make database changes for each adjustment in adjustment-params
foreach ( $adjustmentParams as $adjustment ) {
$dbChanged = $this->writeAdjustment(
$adjustment['adjustment-id'],
$adjustment['adjustment-user'],
$adjustment['adjustment-title'],
$adjustment['adjustment-value'],
$adjustment['adjustment-score'],
$adjustment['adjustment-enabled'],
$adjustment['adjustment-date'],
$adjustment['adjustment-comment'],
false,
$verboseFlag
);
$dbChangedAtLeastOnce = $dbChangedAtLeastOnce || $dbChanged;
}
}
if ( $groupParams ) {
# Make database changes for each group in group-params
foreach ( $groupParams as $group ) {
$dbChanged = $this->writeGroup(
$group['group-id'],
$group['group-title'],
$group['group-enabled'],
$group['group-user'],
false,
$verboseFlag
);
$dbChangedAtLeastOnce = $dbChangedAtLeastOnce || $dbChanged;
}
}
if ( $dbChangedAtLeastOnce )
$page->addWikiText('All changes are logged at [[Special:Log/grades]].');
else
$page->addWikiText('No changes were made.');
} /* end submitForms */
/**
* Execute assignment creation/modification/deletion
*
* Creates, modifies, or deletes an assignment by directly
* modifying the database. If the (id) key provided corresponds
* to an existing assignment, the function will modify or delete
* that assignment depending on whether the delete flag is set.
* Otherwise, the function will create a new assignment.
* Also handles group memberships. Parameters are initially
* validated and sanitized.
*
* @param int|bool $assignmentID the id of an assignment
* @param int|bool $assignmentTitle the title of an assignment
* @param float|bool $assignmentValue the value of an assignment
* @param int|bool $assignmentEnabled the enabled status of an assignment
* @param string|bool $assignmentDate the date of an assignment
* @param array|bool $assignmentGroups the group memberships of an assignment
* @param bool $delete whether to delete the assignment or not
* @param bool $verbose whether to print warnings
* @return bool whether the database was changed or not
*/
function writeAssignment ( $assignmentID = false, $assignmentTitle = false, $assignmentValue = false, $assignmentEnabled = false, $assignmentDate = false, $assignmentGroups = false, $delete = false, $verbose = true ) {
$page = $this->getOutput();
$request = $this->getRequest();
$dbw = wfGetDB(DB_MASTER);
$log = new LogPage('grades', false);
# Validate/sanitize assignment parameters
$assignmentID = filter_var($assignmentID, FILTER_VALIDATE_INT);
$assignmentTitle = filter_var($assignmentTitle, FILTER_CALLBACK, array('options' => array($this, 'validateTitle')));
$assignmentValue = filter_var($assignmentValue, FILTER_VALIDATE_FLOAT);
if ( !is_bool($assignmentEnabled) ) {
$assignmentEnabled = filter_var($assignmentEnabled, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
}
$assignmentDate = filter_var($assignmentDate, FILTER_CALLBACK, array('options' => array($this, 'validateDate')));
if ( $assignmentTitle === false ) {
if ( $verbose )
$page->addWikiText('Invalid title for assignment (may not be empty).');
return false;
}
if ( $assignmentValue === false ) {
if ( $verbose )
$page->addWikiText('Invalid value for assignment (must be a float).');
return false;
}
if ( !is_bool($assignmentEnabled) ) {
if ( $verbose )
$page->addWikiText('Invalid enabled status for assignment (must be a boolean).');
return false;
}
if ( $assignmentDate === false ) {
if ( $verbose )
$page->addWikiText('Invalid date for assignment (must have form YYYY-MM-DD).');
return false;
}
if ( !is_array($assignmentGroups) ) {
if ( $verbose )
$page->addWikiText('Invalid group membership array for assignment (must be an array).');
return false;
}
# Check whether assignment exists
$assignment = $dbw->selectRow('scholasticgrading_assignment', '*', array('sga_id' => $assignmentID));
if ( $assignment ) {
# The assignment exists
if ( !$delete ) {
# Edit the existing assignment
$totalAffectedRows = 0;
$dbw->update('scholasticgrading_assignment', array(
'sga_title' => $assignmentTitle,
'sga_value' => $assignmentValue,
'sga_enabled' => $assignmentEnabled,
'sga_date' => $assignmentDate,
), array('sga_id' => $assignmentID));
$totalAffectedRows += $dbw->affectedRows();
# Create a new log entry
if ( $dbw->affectedRows() > 0 ) {
$log->addEntry('editAssignment', $this->getTitle(),
'id=' . $assignmentID .
'; from ["' .
$assignment->sga_title . '", ' .
$assignment->sga_date . ', ' .
'value=' . (float)$assignment->sga_value . ', ' .
($assignment->sga_enabled ? 'enabled' : 'disabled') .
'] to ["' .
$assignmentTitle . '", ' .
$assignmentDate . ', ' .
'value=' . (float)$assignmentValue . ', ' .
($assignmentEnabled ? 'enabled' : 'disabled') .
']', array());
}
# Edit the group memberships for the assignment and create log entries
foreach ( $assignmentGroups as $groupID => $isMember ) {
$membership = $dbw->selectRow('scholasticgrading_groupassignment', '*', array('sgga_group_id' => $groupID, 'sgga_assignment_id' => $assignmentID));
$group = $dbw->selectRow('scholasticgrading_group', '*', array('sgg_id' => $groupID));
if ( $membership && !$isMember ) {
$dbw->delete('scholasticgrading_groupassignment', array('sgga_group_id' => $groupID, 'sgga_assignment_id' => $assignmentID));
$totalAffectedRows += $dbw->affectedRows();
if ( $dbw->affectedRows() > 0 ) {
$log->addEntry('deleteGroupAssignment', $this->getTitle(),
'assignment "' .
$assignmentTitle . '" (' .
$assignmentDate . ') [id=' .
$assignmentID .
']; group "' .
$group->sgg_title . '" [id=' .
$groupID .
']', array());
}
} elseif ( !$membership && $isMember ) {
$dbw->insert('scholasticgrading_groupassignment', array('sgga_group_id' => $groupID, 'sgga_assignment_id' => $assignmentID));
$totalAffectedRows += $dbw->affectedRows();
if ( $dbw->affectedRows() > 0 ) {
$log->addEntry('addGroupAssignment', $this->getTitle(),
'assignment "' .
$assignmentTitle . '" (' .
$assignmentDate . ') [id=' .
$assignmentID .
']; group "' .
$group->sgg_title . '" [id=' .
$groupID .
']', array());
}
}
}
# Report success
if ( $totalAffectedRows === 0 ) {