mirrored from git://git.moodle.org/moodle.git
/
lib.php
1360 lines (1174 loc) · 48.9 KB
/
lib.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 // $Id$
/// Library of functions and constants for module wiki
/// (replace wiki with the name of your module and delete this line)
$wiki_CONSTANT = 7; /// for example
$site = get_site();
$WIKI_TYPES = array ('teacher' => $site->teacher,
'group' => get_string('groups',"wiki"),
'student' => $site->student );
define("EWIKI_ESCAPE_AT", 0); # For the algebraic filter
function wiki_add_instance($wiki) {
/// Given an object containing all the necessary data,
/// (defined by the form in mod.html) this function
/// will create a new instance and return the id number
/// of the new instance.
$wiki->timemodified = time();
# May have to add extra stuff in here #
/// Determine the pagename for this wiki and save.
$wiki->pagename = wiki_page_name($wiki);
return insert_record("wiki", $wiki);
}
function wiki_update_instance($wiki) {
/// Given an object containing all the necessary data,
/// (defined by the form in mod.html) this function
/// will update an existing instance with new data.
/// Determine the pagename for this wiki.
$wiki->pagename = wiki_page_name($wiki);
$wiki->timemodified = time();
$wiki->id = $wiki->instance;
return update_record("wiki", $wiki);
}
/// Delete all Directories recursively
function wiki_rmdir($basedir) {
$handle = @opendir($basedir);
if($handle) {
while (false!==($folder = readdir($handle))) {
if($folder != "." && $folder != ".." && $Folder != "CVS") {
wiki_rmdir("$basedir/$folder"); // recursive
}
}
closedir($handle);
}
@rmdir($basedir);
}
function wiki_delete_instance($id) {
/// Given an ID of an instance of this module,
/// this function will permanently delete the instance
/// and any data that depends on it.
global $CFG;
if (! $wiki = get_record("wiki", "id", $id)) {
return false;
}
$result = true;
#Delete Files
### Should probably check regardless of this setting in case its been changed...
if($wiki->ewikiacceptbinary) {
if ($basedir = $CFG->dataroot."/".$wiki->course."/".$CFG->moddata."/wiki/$id") {
if ($files = get_directory_list($basedir)) {
foreach ($files as $file) {
#if ($file != $exception) {
unlink("$basedir/$file");
notify("Existing file '$file' has been deleted!");
#}
}
}
#if (!$exception) { // Delete directory as well, if empty
wiki_rmdir("$basedir");
#}
}
}
# Delete any dependent records here #
if (! delete_records("wiki", "id", $wiki->id)) {
$result = false;
}
/// Delete all wiki_entries and wiki_pages.
if (($wiki_entries = wiki_get_entries($wiki)) !== false) {
foreach ($wiki_entries as $wiki_entry) {
if (! delete_records("wiki_pages", "wiki", "$wiki_entry->id")) {
$result = false;
}
if (! delete_records("wiki_entries", "id", "$wiki_entry->id")) {
$result = false;
}
}
}
return $result;
}
function wiki_user_outline($course, $user, $mod, $wiki) {
/// Return a small object with summary information about what a
/// user has done with a given particular instance of this module
/// Used for user activity reports.
/// $return->time = the time they did it
/// $return->info = a short text description
return $return;
}
function wiki_user_complete($course, $user, $mod, $wiki) {
/// Print a detailed representation of what a user has done with
/// a given particular instance of this module, for user activity reports.
return true;
}
function wiki_print_recent_activity($course, $isteacher, $timestart) {
/// Given a course and a time, this module should find recent activity
/// that has occurred in wiki activities and print it out.
/// Return true if there was output, or false is there was none.
global $CFG;
return false; // True if anything was printed, otherwise false
}
function wiki_cron () {
/// Function to be run periodically according to the moodle cron
/// This function searches for things that need to be done, such
/// as sending out mail, toggling flags etc ...
global $CFG;
return true;
}
function wiki_grades($wikiid) {
/// Must return an array of grades for a given instance of this module,
/// indexed by user. It also returns a maximum allowed grade.
$return->grades = NULL;
$return->maxgrade = NULL;
return $return;
}
function wiki_get_participants($wikiid) {
//Must return an array of user records (all data) who are participants
//for a given instance of wiki. Must include every user involved
//in the instance, independient of his role (student, teacher, admin...)
//See other modules as example.
return false;
}
//////////////////////////////////////////////////////////////////////////////////////
/// Any other wiki functions go here. Each of them must have a name that
/// starts with wiki_
function wiki_wiki_name($wikiname) {
/// Return the passed in string in Wiki name format.
/// Remove any leading and trailing whitespace, capitalize all the words
/// and then remove any internal whitespace.
if (wiki_is_wiki_name($wikiname)) {
return $wikiname;
}
else {
/// Create uppercase words and remove whitespace.
$wikiname = preg_replace("/(\w+)\s/", "$1", ucwords(trim($wikiname)));
/// Check again - there may only be one word.
if (wiki_is_wiki_name($wikiname)) {
return $wikiname;
}
/// If there is only one word, append default wiki name to it.
else {
return $wikiname.get_string('wikidefaultpagename', 'wiki');
}
}
}
function wiki_is_wiki_name($wikiname) {
/// Check for correct wikiname syntax and return true or false.
/// If there are spaces between the words, incorrect format.
if (preg_match_all('/\w+/', $wikiname, $out) > 1) {
return false;
}
/// If there isn't more than one group of uppercase letters separated by
/// lowercase letters or '_', incorrect format.
else if (preg_match_all('/[A-Z]+[a-z_]+/', $wikiname, $out) > 1) {
return true;
}
else {
return false;
}
}
function wiki_page_name(&$wiki) {
/// Determines the wiki's page name and returns it.
if (!empty($wiki->initialcontent)) {
$ppos = strrpos($wiki->initialcontent, '/');
if ($ppos === false) {
$pagename = $wiki->initialcontent;
}
else {
$pagename = substr($wiki->initialcontent, $ppos+1);
}
}
else if (!empty($wiki->pagename)) {
$pagename = $wiki->pagename;
}
else {
$pagename = $wiki->name;
}
return $pagename;
}
function wiki_content_dir(&$wiki) {
/// Determines the wiki's default content directory (if there is one).
global $CFG;
if (!empty($wiki->initialcontent)) {
$ppos = strrpos($wiki->initialcontent, '/');
if ($ppos === false) {
$subdir = '';
}
else {
$subdir = substr($wiki->initialcontent, 0, $ppos+1);
}
$contentdir = $CFG->dataroot.'/'.$wiki->course.'/'.$subdir;
}
else {
$contentdir = false;
}
return $contentdir;
}
function wiki_has_entries(&$wiki) {
/// Returns true if wiki already has wiki entries; otherwise false.
return record_exists('wiki_entries', 'wikiid', $wiki->id);
}
function wiki_get_entries(&$wiki, $byindex=NULL) {
/// Returns an array with all wiki entries indexed by entry id; false if there are none.
/// If the optional $byindex is specified, returns the entries indexed by that field.
/// Valid values for $byindex are 'student', 'group'.
if ($byindex == 'student') {
return get_records('wiki_entries', 'wikiid', $wiki->id, '',
'userid,id,wikiid,course,groupid,pagename,timemodified');
}
else if ($byindex == 'group') {
return get_records('wiki_entries', 'wikiid', $wiki->id, '',
'groupid,id,wikiid,course,userid,pagename,timemodified');
}
else {
return get_records('wiki_entries', 'wikiid', $wiki->id);
}
}
function wiki_get_entry(&$wiki, &$course, $userid=0, $groupid=0) {
/// Returns the wiki entry according to the wiki type.
/// Optionally, will return wiki entry for $userid student wiki, or
/// $groupid group or teacher wiki.
global $USER;
switch ($wiki->wtype) {
case 'student':
/// If a specific user was requested, return it, if allowed.
if ($userid and wiki_user_can_access_student_wiki($wiki, $userid, $course)) {
$wentry = wiki_get_student_entry($wiki, $userid);
}
/// If there is no entry for this user, check if this user is a teacher.
else if (!$wentry = wiki_get_student_entry($wiki, $USER->id)) {
/* if (isteacher($course->id, $USER->id)) {
/// If this user is a teacher, return the first entry.
if ($wentries = wiki_get_entries($wiki)) {
$wentry = current($wentries);
}
}*/
}
break;
case 'group':
/// If there is a groupmode, get the user's group id.
$groupmode = groupmode($course, $wiki);
/// If a specific group was requested, return it, if allowed.
if ($groupid and wiki_user_can_access_group_wiki($wiki, $groupid, $course)) {
$wentry = wiki_get_group_entry($wiki, $groupid);
}
else if ($groupmode) {
/// If there is no entry for this user, check if this user is a teacher.
if (!$wentry = wiki_get_group_entry($wiki, mygroupid($course->id))) {
/* if (isteacher($course->id, $USER->id)) {
/// If this user is a teacher, return the first entry.
if ($wentries = wiki_get_entries($wiki)) {
$wentry = current($wentries);
}
} */
}
}
/// If mode is 'nogroups', then groupid is zero.
else {
$wentry = wiki_get_group_entry($wiki, 0);
}
break;
case 'teacher':
/// If there is a groupmode, get the user's group id.
if (groupmode($course, $wiki)) {
$groupid = $groupid ? $groupid : mygroupid($course->id);
}
/// If a specific group was requested, return it, if allowed.
if (wiki_user_can_access_teacher_wiki($wiki, $groupid, $course)) {
$wentry = wiki_get_teacher_entry($wiki, $groupid);
}
break;
}
return $wentry;
}
function wiki_get_teacher_entry(&$wiki, $groupid=0) {
/// Returns the wiki entry for the wiki teacher type.
return get_record('wiki_entries', 'wikiid', $wiki->id, 'course', $wiki->course, 'groupid', $groupid);
}
function wiki_get_group_entry(&$wiki, $groupid=null) {
/// Returns the wiki entry for the given group.
return get_record('wiki_entries', 'wikiid', $wiki->id, 'groupid', $groupid);
}
function wiki_get_student_entry(&$wiki, $userid=null) {
/// Returns the wiki entry for the given student.
global $USER;
if (is_null($userid)) {
$userid = $USER->id;
}
return get_record('wiki_entries', 'wikiid', $wiki->id, 'userid', $userid);
}
function wiki_get_other_wikis(&$wiki, &$user, &$course, $currentid=0) {
/// Returns a list of other wikis to display, depending on the type, group and user.
/// Returns the key containing the currently selected entry as well.
global $CFG, $ME, $id;
$wikis = false;
$groupmode = groupmode($course, $wiki);
$mygroupid = mygroupid($course->id);
$isteacher = isteacher($course->id, $user->id);
$isteacheredit = isteacheredit($course->id, $user->id);
$site = get_site();
switch ($wiki->wtype) {
case 'student':
/// Get all the existing entries for this wiki.
$wiki_entries = wiki_get_entries($wiki, 'student');
if ($isteacher and ($site->id != $course->id)) {
/// If the user is an editing teacher, or a non-editing teacher not assigned to a group, show all student
/// wikis, regardless of creation.
if (($site->id != $course->id) and ($isteacheredit or ($groupmode == NOGROUPS))) {
if ($students = get_course_students($course->id)) {
/// Default pagename is dependent on the wiki settings.
$defpagename = empty($wiki->pagename) ? get_string('wikidefaultpagename', 'wiki') : $wiki->pagename;
foreach ($students as $student) {
/// If this student already has an entry, use its pagename.
if ($wiki_entries[$student->id]) {
$pagename = $wiki_entries[$student->id]->pagename;
}
else {
$pagename = $defpagename;
}
$key = $ME.'?id='.$id.'&userid='.$student->id.'&wikipage='.$pagename;
$wikis[$key] = fullname($student).':'.$pagename;
}
}
}
else if ($groupmode == SEPARATEGROUPS) {
if ($students = get_group_students($mygroupid)) {
$defpagename = empty($wiki->pagename) ? get_string('wikidefaultpagename', 'wiki') : $wiki->pagename;
foreach ($students as $student) {
/// If this student already has an entry, use its pagename.
if ($wiki_entries[$student->id]) {
$pagename = $wiki_entries[$student->id]->pagename;
}
else {
$pagename = $defpagename;
}
$key = $ME.'?id='.$id.'&userid='.$student->id.'&wikipage='.$pagename;
$wikis[$key] = fullname($student).':'.$pagename;
}
}
}
else if ($groupmode == VISIBLEGROUPS) {
/// Get all students in your group.
if ($students = get_group_students($mygroupid)) {
$defpagename = empty($wiki->pagename) ? get_string('wikidefaultpagename', 'wiki') : $wiki->pagename;
foreach ($students as $student) {
/// If this student already has an entry, use its pagename.
if ($wiki_entries[$student->id]) {
$pagename = $wiki_entries[$student->id]->pagename;
}
else {
$pagename = $defpagename;
}
$key = $ME.'?id='.$id.'&userid='.$student->id.'&wikipage='.$pagename;
$wikis[$key] = fullname($student).':'.$pagename;
}
}
/// Get all student wikis created, regardless of group.
$sql = 'SELECT w.id, w.userid, w.pagename, u.firstname, u.lastname '
.' FROM '.$CFG->prefix.'wiki_entries w, '.$CFG->prefix.'user u '
.' WHERE w.wikiid = '.$wiki->id.' AND u.id = w.userid '
.' ORDER BY w.id';
$wiki_entries = get_records_sql($sql);
$wiki_entries=is_array($wiki_entries)?$wiki_entries:array();
foreach ($wiki_entries as $wiki_entry) {
$key = $ME.'?id='.$id.'&userid='.$wiki_entry->userid.'&wikipage='.$wiki_entry->pagename;
$wikis[$key] = fullname($wiki_entry).':'.$wiki_entry->pagename;
if ($currentid == $wiki_entry->id) {
$wikis['selected'] = $key;
}
}
}
}
else {
/// A user can see other student wikis if they are a member of the same
/// group (for separate groups) or there are visible groups, or if this is
/// a site-level wiki, and they are an administrator.
if (($groupmode == VISIBLEGROUPS) or
(($site->id == $course->id) and isadmin())) {
$viewall = true;
}
else if ($groupmode == SEPARATEGROUPS) {
$viewall = mygroupid($course->id);
}
else {
$viewall = false;
}
if ($viewall !== false) {
$sql = 'SELECT w.id, w.userid, w.pagename, u.firstname, u.lastname '
.' FROM '.$CFG->prefix.'wiki_entries w, '.$CFG->prefix.'user u '
.' WHERE w.wikiid = '.$wiki->id.' AND u.id = w.userid '
.' ORDER BY w.id';
$wiki_entries = get_records_sql($sql);
$wiki_entries=is_array($wiki_entries)?$wiki_entries:array();
foreach ($wiki_entries as $wiki_entry) {
if (($viewall === true) or ismember($viewall, $wiki_entry->userid)) {
$key = $ME.'?id='.$id.'&userid='.$wiki_entry->userid.'&wikipage='.$wiki_entry->pagename;
$wikis[$key] = fullname($wiki_entry).':'.$wiki_entry->pagename;
if ($currentid == $wiki_entry->id) {
$wikis['selected'] = $key;
}
}
}
}
}
break;
case 'group':
/// If the user is an editing teacher, or a non-editing teacher not assigned to a group, show all group
/// wikis, regardless of creation.
/// Get all the existing entries for this wiki.
$wiki_entries = wiki_get_entries($wiki, 'group');
if ($groupmode and ($isteacheredit or ($isteacher and !$mygroupid))) {
if ($groups = get_groups($course->id)) {
$defpagename = empty($wiki->pagename) ? get_string('wikidefaultpagename', 'wiki') : $wiki->pagename;
foreach ($groups as $group) {
/// If this group already has an entry, use its pagename.
if (isset($wiki_entries[$group->id])) {
$pagename = $wiki_entries[$group->id]->pagename;
}
else {
$pagename = $defpagename;
}
$key = $ME.'?id='.$id.'&groupid='.$group->id.'&wikipage='.$pagename;
$wikis[$key] = $group->name.':'.$pagename;
}
}
}
/// A user can see other group wikis if there are visible groups.
else if ($groupmode == VISIBLEGROUPS) {
$sql = 'SELECT w.id, w.groupid, w.pagename, g.name as gname '
.' FROM '.$CFG->prefix.'wiki_entries w, '.$CFG->prefix.'groups g '
.' WHERE w.wikiid = '.$wiki->id.' AND g.id = w.groupid '
.' ORDER BY w.groupid';
$wiki_entries = get_records_sql($sql);
$wiki_entries=is_array($wiki_entries)?$wiki_entries:array();
foreach ($wiki_entries as $wiki_entry) {
$key = $ME.'?id='.$id.'&groupid='.$wiki_entry->groupid.'&wikipage='.$wiki_entry->pagename;
$wikis[$key] = $wiki_entry->gname.':'.$wiki_entry->pagename;
if ($currentid == $wiki_entry->id) {
$wikis['selected'] = $key;
}
}
}
break;
case 'teacher':
if ($isteacher) {
/// If the user is an editing teacher, or a non-editing teacher not assigned to a group, show all
/// teacher wikis, regardless of creation.
if ($groupmode and ($isteacheredit or ($isteacher and !$mygroupid))) {
if ($groups = get_groups($course->id)) {
$defpagename = empty($wiki->pagename) ? get_string('wikidefaultpagename', 'wiki') : $wiki->pagename;
foreach ($groups as $group) {
/// If this group already has an entry, use its pagename.
if ($wiki_entries[$group->id]) {
$pagename = $wiki_entries[$group->id]->pagename;
}
else {
$pagename = $defpagename;
}
$key = $ME.'?id='.$id.'&groupid='.$group->id.'&wikipage='.$pagename;
$wikis[$key] = $group->name.':'.$pagename;
}
}
}
/// A teacher can see all other group teacher wikis.
else if ($groupmode) {
$sql = 'SELECT w.id, w.groupid, w.pagename, g.name as gname '
.' FROM '.$CFG->prefix.'wiki_entries w, '.$CFG->prefix.'groups g '
.' WHERE w.wikiid = '.$wiki->id.' AND g.id = w.groupid '
.' ORDER BY w.groupid';
$wiki_entries = get_records_sql($sql);
$wiki_entries=is_array($wiki_entries)?$wiki_entries:array();
foreach ($wiki_entries as $wiki_entry) {
$key = $ME.'?id='.$id.'&groupid='.$wiki_entry->groupid.'&wikipage='.$wiki_entry->pagename;
$wikis[$key] = $wiki_entry->gname.':'.$wiki_entry->pagename;
if ($currentid == $wiki_entry->id) {
$wikis['selected'] = $key;
}
}
}
}
else {
/// A user can see other teacher wikis if they are a teacher, a member of the same
/// group (for separate groups) or there are visible groups.
if ($groupmode == VISIBLEGROUPS) {
$viewall = true;
}
else if ($groupmode == SEPARATEGROUPS) {
$viewall = $mygroupid;
}
else {
$viewall = false;
}
if ($viewall !== false) {
$sql = 'SELECT w.id, w.groupid, w.pagename, g.name as gname '
.' FROM '.$CFG->prefix.'wiki_entries w, '.$CFG->prefix.'groups g '
.' WHERE w.wikiid = '.$wiki->id.' AND g.id = w.groupid '
.' ORDER BY w.groupid';
$wiki_entries = get_records_sql($sql);
$wiki_entries=is_array($wiki_entries)?$wiki_entries:array();
foreach ($wiki_entries as $wiki_entry) {
if (($viewall === true) or $viewall == $wiki_entry->groupid) {
$key = $ME.'?id='.$id.'&groupid='.$wiki_entry->groupid.'&wikipage='.$wiki_entry->pagename;
$wikis[$key] = $wiki_entry->gname.':'.$wiki_entry->pagename;
if ($currentid == $wiki_entry->id) {
$wikis['selected'] = $key;
}
}
}
}
}
break;
}
return $wikis;
}
function wiki_add_entry(&$wiki, &$course, $userid=0, $groupid=0) {
/// Adds a new wiki entry of the specified type, unless already entered.
/// No checking is done here. It is assumed that the caller has the correct
/// privileges to add this entry.
global $USER;
/// If this wiki already has a wiki_type entry, return false.
if (wiki_get_entry($wiki, $course, $userid, $groupid) !== false) {
return false;
}
switch ($wiki->wtype) {
case 'student':
$wiki_entry->wikiid = $wiki->id;
$wiki_entry->userid = $userid ? $userid : $USER->id;
$wiki_entry->pagename = wiki_page_name($wiki);
$wiki_entry->timemodified = time();
break;
case 'group':
/// Get the groupmode. It's been added to the wiki object.
$groupmode = groupmode($course, $wiki);
/// If there is a groupmode, get the group id.
if ($groupmode) {
$groupid = $groupid ? $groupid : mygroupid($course->id);
}
/// If mode is 'nogroups', then groupid is zero.
else {
$groupid = 0;
}
$wiki_entry->wikiid = $wiki->id;
$wiki_entry->groupid = $groupid;
$wiki_entry->pagename = wiki_page_name($wiki);
$wiki_entry->timemodified = time();
break;
case 'teacher':
/// Get the groupmode. It's been added to the wiki object.
$groupmode = groupmode($course, $wiki);
/// If there is a groupmode, get the user's group id.
if ($groupmode and $groupid == 0) {
$groupid = mygroupid($course->id);
}
$wiki_entry->wikiid = $wiki->id;
$wiki_entry->course = $wiki->course;
$wiki_entry->groupid = $groupid;
$wiki_entry->pagename = wiki_page_name($wiki);
$wiki_entry->timemodified = time();
break;
}
return insert_record("wiki_entries", $wiki_entry, true);
}
function wiki_can_add_entry(&$wiki, &$user, &$course, $userid=0, $groupid=0) {
/// Returns true or false if the user can add a wiki entry for this wiki.
/// Get the groupmode. It's been added to the wiki object.
$groupmode = groupmode($course, $wiki);
$mygroupid = mygroupid($course->id);
$site = get_site();
switch ($wiki->wtype) {
case 'student':
/// A student can create their own wiki, if they are a member of that course.
/// A user can create their own wiki at the site level.
if ($userid == 0) {
return (isstudent($course->id, $user->id) or
(($site->id == $course->id) and !empty($user) and !isguest()));
}
/// An editing teacher can create any student wiki, or
/// a non-editing teacher, if not assigned to a group can create any student wiki, or if assigned to a group can
/// create any student wiki in their group.
else {
return ((($userid == $user->id) and isstudent($course->id, $user->id)) or isteacheredit($course->id) or
(isteacher($course->id) and (!$groupmode or $mygroupid == 0 or (ismember($mygroupid, $userid)))));
}
break;
case 'group':
/// If mode is 'nogroups', then all participants can add wikis.
if (!$groupmode) {
return (isstudent($course->id, $user->id) or isteacher($course->id, $user->id) or
(($site->id == $course->id) and !empty($user) and !isguest()));
}
/// If not requesting a group, must be a member of a group.
else if ($groupid == 0) {
return ($mygroupid != 0);
}
/// If requesting a group, must be an editing teacher, a non-editing teacher with no assigned group,
/// or a non-editing teacher requesting their group.
else {
return (isteacheredit($course->id) or
(isteacher($course->id) and ($mygroupid == 0 or $mygroupid == $groupid)));
}
break;
case 'teacher':
/// If mode is 'nogroups', then all teachers can add wikis.
if (!$groupmode) {
return (isteacher($course->id, $user->id) or (($site->id == $course->id) and isadmin()));
}
/// If not requesting a group, must be a member of a group.
else if ($groupid == 0) {
return ($mygroupid != 0 and isteacher($course->id));
}
/// If there is a group mode, non-editing teachers with an assigned group, can only create wikis
/// in their group. Non-editing teachers with no assigned group and editing teachers can create any wiki.
else {
return (isteacheredit($course->id) or
(isteacher($course->id) and ($mygroupid == 0 or $mygroupid == $groupid)));
}
break;
}
return false;
}
function wiki_can_edit_entry(&$wiki_entry, &$wiki, &$user, &$course) {
/// Returns true or false if the user can edit this wiki entry.
$can_edit = false;
$groupmode = groupmode($course, $wiki);
$mygroupid = mygroupid($course->id);
$site = get_site();
/// Editing teacher's and admins can edit all wikis, non-editing teachers can edit wikis in their groups,
/// or all wikis if group mode is 'no groups' or they don't belong to a group.
if (isadmin() or isteacheredit($course->id, $user->id) or
((!$groupmode or $mygroupid == 0) and isteacher($course->id, $user->id))) {
$can_edit = true;
}
else {
switch ($wiki->wtype) {
/// Only a teacher or the owner of a student wiki can edit it.
case 'student':
$can_edit = (($user->id == $wiki_entry->userid) or
($groupmode and isteacher($course->id, $user->id) and
ismember($mygroupid, $wiki_entry->userid)));
break;
case 'group':
/// If there is a groupmode, determine the user's group status.
if ($groupmode) {
/// If the user is a member of the wiki group, they can edit the wiki.
$can_edit = ismember($wiki_entry->groupid, $user->id);
}
/// If mode is 'nogroups', then all participants can edit the wiki.
else {
$can_edit = (isstudent($course->id, $user->id) or isteacher($course->id, $user->id) or
(($site->id == $course->id) and !empty($user) and !isguest()));
}
break;
case 'teacher':
/// If there is a groupmode, determine the user's group status.
if ($groupmode) {
/// If the user is a member of the wiki group, they can edit the wiki.
$can_edit = (isteacher($course->id, $user->id) and ismember($wiki_entry->groupid, $user->id));
}
else {
$can_edit = (isteacher($course->id, $user->id) or (($site->id == $course->id) and isadmin()));
}
break;
}
}
return $can_edit;
}
function wiki_user_can_access_student_wiki(&$wiki, $userid, &$course) {
global $USER;
/// Get the groupmode. It's been added to the wiki object.
$groupmode = groupmode($course, $wiki);
$usersgroup = mygroupid($course->id);
$isteacher = isteacher($course->id, $USER->id);
/// If this user is allowed to access this wiki then return TRUE.
/// *** THIS COULD BE A PROBLEM, IF STUDENTS COULD EVER BE PART OF MORE THAN ONE GROUP ***
/// A user can access a student wiki, if:
/// - it is their wiki,
/// - group mode is VISIBLEGROUPS,
/// - group mode is SEPARATEGROUPS, and the user is a member of the requested user's group,
/// - they are an editing teacher or administrator,
/// - they are a non-editing teacher not assigned to a specific group,
/// - they are a non-editing teacher and group mode is NOGROUPS.
/// - they are an administrator (mostly for site-level wikis).
if (($userid and ($USER->id == $userid)) or ($groupmode == VISIBLEGROUPS) or
(($groupmode == SEPARATEGROUPS) and ismember($usersgroup, $userid)) or
(isteacheredit($course->id, $USER->id)) or
(isteacher($course->id, $USER->id) and (!$usersgroup or ($groupmode == NOGROUPS))) or
(isadmin())) {
$can_access = true;
}
else {
$can_access = false;
}
return $can_access;
}
function wiki_user_can_access_group_wiki(&$wiki, $groupid, &$course) {
global $USER;
/// Get the groupmode. It's been added to the wiki object.
$groupmode = groupmode($course, $wiki);
$usersgroup = mygroupid($course->id);
$isteacher = isteacher($course->id, $USER->id);
/// A user can access a group wiki, if:
/// - group mode is NOGROUPS,
/// - group mode is VISIBLEGROUPS,
/// - group mode is SEPARATEGROUPS, and they are a member of the requested group,
/// - they are an editing teacher or administrator,
/// - they are a non-editing teacher not assigned to a specific group.
if (($groupmode == NOGROUPS) or ($groupmode == VISIBLEGROUPS) or
(($groupmode == SEPARATEGROUPS) and ($usersgroup == $groupid)) or
(isteacheredit($course->id, $USER->id)) or
(isteacher($course->id, $USER->id) and !$usersgroup)) {
$can_access = true;
}
else {
$can_access = false;
}
return $can_access;
}
function wiki_user_can_access_teacher_wiki(&$wiki, $groupid, &$course) {
global $USER;
/// Get the groupmode. It's been added to the wiki object.
$groupmode = groupmode($course, $wiki);
/// A user can access a teacher wiki, if:
/// - group mode is NOGROUPS,
/// - group mode is VISIBLEGROUPS,
/// - group mode is SEPARATEGROUPS, and they are a member of the requested group,
/// - they are a teacher or administrator,
if (($groupmode == NOGROUPS) or ($groupmode == VISIBLEGROUPS) or
(($groupmode == SEPARATEGROUPS) and (mygroupid($course->id) == $groupid)) or
(isteacher($course->id, $USER->id))){
$can_access = true;
}
else {
$can_access = false;
}
return $can_access;
}
function wiki_get_owner(&$wiki_entry) {
if ($wiki_entry->userid > 0) {
$user = get_record('user', 'id', $wiki_entry->userid);
$owner = fullname($user);
}
else if ($wiki_entry->groupid > 0) {
$group = get_record('groups', 'id', $wiki_entry->groupid);
$owner = $group->name;
}
else if ($wiki_entry->course > 0) {
$course = get_record('course', 'id', $wiki_entry->course);
$owner = $course->shortname;
}
else {
$owner = '- unknown -';
}
return $owner;
}
function wiki_print_search_form($cmid, $search="", $userid, $groupid, $return=false) {
global $CFG;
# TODO: Add Group and User !!!
$output = "<form name=\"search\" action=\"$CFG->wwwroot/mod/wiki/view.php\">";
$output .= "<font size=\"-1\">".get_string("search").': ';
$output .= "<input name=\"id\" type=\"hidden\" value=\"$cmid\">";
$output = $output.($groupid?"<input name=\"groupid\" type=\"hidden\" value=\"$groupid\">":"");
$output = $output.($userid?"<input name=\"userid\" type=\"hidden\" value=\"$userid\">":"");
$output .= "<input name=\"q\" type=\"text\" size=\"20\" value=\"$search\">".' ';
$output .= "<input value=\"".get_string("searchwiki", "wiki")."\" type=\"submit\">";
$output .= "</font>";
$output .= "<input name=\"wikipage\" type=\"hidden\" value=\"SearchPages\">";
$output .= "</form>";
if ($return) {
return $output;
}
echo $output;
}
function wiki_print_wikilinks_block($cmid, $binary=false, $return=false) {
/// Prints a lin-list of special wiki-pages
global $CFG, $ewiki_title;
$links=array();
$links["SiteMap"]=get_string("sitemap", "wiki");
$links["PageIndex"]=get_string("pageindex", "wiki");
$links["NewestPages"]=get_string("newestpages", "wiki");
$links["MostVisitedPages"]=get_string("mostvisitedpages", "wiki");
$links["MostOftenChangedPages"]=get_string("mostoftenchangedpages", "wiki");
$links["UpdatedPages"]=get_string("updatedpages", "wiki");
$links["OrphanedPages"]=get_string("orphanedpages", "wiki");
$links["WantedPages"]=get_string("wantedpages", "wiki");
if($binary) {
$links["FileDownload"]=get_string("filedownload", "wiki");
}
popup_form(EWIKI_SCRIPT, $links, "wikilinks", "", get_string("choosewikilinks", "wiki"), "", "", $return);
}
function wiki_print_page_actions($cmid, $specialpages, $wikipage, $action, $binary=false, $canedit=true) {
/// Displays actions which can be performed on the page
$page=array();
// Edit this Page
if (in_array($action, array("edit", "links", "info", "attachments"))) {
$page["view/$wikipage"]=get_string("viewpage","wiki");
}
if ($canedit && !in_array($wikipage, $specialpages) && $action != "edit") {
$page["edit/$wikipage"]=get_string("editthispage","wiki");
}
if ($action != "links") {
$page["links/$wikipage"]=get_string("backlinks","wiki");
}
if ($canedit && !in_array($wikipage, $specialpages) && $action!="info") {
$page["info/$wikipage"]=get_string("pageinfo","wiki");
}
if($canedit && $binary && !in_array($wikipage, $specialpages) && $action != "attachments") {
$page["attachments/$wikipage"]=get_string("attachments","wiki");
}
popup_form(EWIKI_SCRIPT, $page, "wikiactions", "", get_string("action", "wiki"), "", "", false);
}
function wiki_print_administration_actions($cmid, $userid, $groupid, $wikipage, $noeditor) {
/// Displays actions which can be performed on the page
global $ME;
/// Create the URL
$ewscript = 'admin.php?id='.$cmid;
if (isset($userid)) $ewscript .= '&userid='.$userid;
if (isset($groupid)) $ewscript .= '&groupid='.$groupid;
if (isset($wikipage)) $ewscript .= '&wikipage='.$wikipage;
$ewscript.="&action=";
$action=array(
"removepages" => get_string("removepages", "wiki"),
"strippages" => get_string("strippages", "wiki"),
"setpageflags" => get_string("setpageflags", "wiki"),
"revertpages" => get_string("revertpages", "wiki"),
);
// We cannot do certain things if html is used !
if($noeditor) {
$action["checklinks"]=get_string("checklinks", "wiki");
}
popup_form($ewscript, $action, "wikiadministration", "", get_string("chooseadministration", "wiki"), "", "", false);
}
function wiki_admin_get_flagarray() {
$ret = array(
EWIKI_DB_F_TEXT => get_string("flagtxt","wiki"),
EWIKI_DB_F_BINARY => get_string("flagbin","wiki"),
EWIKI_DB_F_DISABLED => get_string("flagoff","wiki"),
EWIKI_DB_F_HTML => get_string("flaghtm","wiki"),
EWIKI_DB_F_READONLY => get_string("flagro","wiki"),
EWIKI_DB_F_WRITEABLE => get_string("flagwr","wiki"),
);
return $ret;
}
///////// Ewiki Administration. Mostly taken from the ewiki/tools folder and changed
function wiki_admin_setpageflags_list($pageflagstatus) {
$FD = wiki_admin_get_flagarray();
$table->head = array(get_string("pagename","wiki"), get_string("flags","wiki"));
if($pageflagstatus) {
$table->head[]=get_string("status","wiki");
}
$result = ewiki_database("GETALL", array("version", "flags"));
while ($row = $result->get()) {
$id = $row["id"];
$data = ewiki_database("GET", $row);
$cell_pagename="";
$cell_flags="";
if ($data["flags"] & EWIKI_DB_F_TEXT) {
$cell_pagename .= '<A HREF="' . EWIKI_SCRIPT . $id . '">';
} else {
$cell_pagename .= '<A HREF="' . EWIKI_SCRIPT_BINARY . $id . '">';
}
$cell_pagename .= htmlentities($id) . '</A> / '.get_string("version","wiki").": ".$row["version"];