-
Notifications
You must be signed in to change notification settings - Fork 5
/
renderer.php
2560 lines (2218 loc) · 97.5 KB
/
renderer.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
// 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/>.
/**
* mod/reader/renderer.php
*
* @package mod
* @subpackage reader
* @copyright 2013 Gordon Bateson (gordon.bateson@gmail.com)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
/** Prevent direct access to this script */
defined('MOODLE_INTERNAL') || die();
/**
* mod_reader_renderer
*
* @copyright 2013 Gordon Bateson (gordon.bateson@gmail.com)
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
* @package mod
* @subpackage reader
*/
class mod_reader_renderer extends plugin_renderer_base {
/**#@+
* tab ids
*
* @var integer
*/
const TAB_VIEW = 1;
const TAB_SETTINGS = 2;
const TAB_REPORTS = 3;
const TAB_BOOKS = 4;
const TAB_USERS = 6;
const TAB_TOOLS = 7;
const TAB_ADMINAREA = 8;
/**#@-*/
/** object to represent associated reader activity */
public $reader = null;
/** array of allow modes for this page (mode is second row of tabs) */
public $modes = array();
/**
* init
*
* @param xxx $reader
*/
public function init($reader) {
$this->reader = $reader;
}
///////////////////////////////////////////
// format tabs
///////////////////////////////////////////
/**
* tabs
*
* @return string HTML output to display navigation tabs
*/
public function tabs($selected=null, $inactive=null, $activated=null) {
$tab = $this->get_tab();
$tabs = $this->get_tabs();
if (class_exists('tabtree')) {
// Moodle >= 2.6
return $this->tabtree($tabs, $tab);
} else {
// Moodle <= 2.5
$this->set_active_tabs($tabs, $tab);
$html = convert_tree_to_html($tabs);
return html_writer::tag('div', $html, array('class' => 'tabtree')).
html_writer::tag('div', '', array('class' => 'clearer'));
}
}
/**
* set_active_tabs
*
* @param array $tabs (passed by reference)
* @param integer currently selected $tab id
* @return boolean, TRUE if any tabs or child tabs were selected, FALSE otherwise
*/
public function set_active_tabs(&$tabs, $tab) {
$result = false;
foreach (array_keys($tabs) as $t) {
// selected
if ($tabs[$t]->id==$tab) {
$tabs[$t]->selected = true;
} else {
$tabs[$t]->selected = false;
}
// active
if (isset($tabs[$t]->subtree) && $this->set_active_tabs($tabs[$t]->subtree, $tab)) {
$tabs[$t]->active = true;
} else {
$tabs[$t]->active = false;
}
// inactive (make sure it is set)
if (empty($tabs[$t]->inactive)) {
$tabs[$t]->inactive = false;
}
// result
$result = ($result || $tabs[$t]->selected || $tabs[$t]->active);
}
return $result;
}
/**
* get_tab
*
* @return integer tab id
*/
public function get_tab() {
$tab = $this->get_my_tab(); // the default tab
$tab = optional_param('tab', $tab, PARAM_INT);
if ($tab==$this->get_my_tab()) {
$tab = $this->get_default_tab();
}
return $tab;
}
/**
* get_my_tab
*
* @return integer tab id
*/
public function get_my_tab() {
return self::TAB_VIEW;
}
/**
* get_default_tab
*
* @return integer tab id
*/
public function get_default_tab() {
return self::TAB_VIEW;
}
/**
* get_tabs
*
* @return string HTML output to display navigation tabs
*/
public function get_tabs() {
$tabs = array();
if (isset($this->reader)) {
if (isset($this->reader->cm)) {
$cmid = $this->reader->cm->id;
} else {
$cmid = 0; // unusual !!
}
$showadminarea = false;
if ($this->reader->can_viewbooks()) {
$tab = self::TAB_VIEW;
$url = new moodle_url('/mod/reader/view.php', array('id' => $cmid, 'tab' => $tab));
$tabs[$tab] = new tabobject($tab, $url, get_string('view'));
}
if ($this->reader->can_addinstance()) {
$tab = self::TAB_SETTINGS;
$url = new moodle_url('/course/mod.php', array('update' => $cmid, 'return' => 1, 'sesskey' => sesskey()));
$tabs[$tab] = new tabobject($tab, $url, get_string('settings'));
}
if ($this->reader->can_viewreports()) {
$tab = self::TAB_REPORTS;
$url = new moodle_url('/mod/reader/admin/reports.php', array('id' => $cmid, 'tab' => $tab));
$tabs[$tab] = new tabobject($tab, $url, get_string('reports'));
$showadminarea = true;
}
if ($this->reader->can_managebooks()) {
$tab = self::TAB_BOOKS;
$url = new moodle_url('/mod/reader/admin/books.php', array('id' => $cmid, 'tab' => $tab));
$tabs[$tab] = new tabobject($tab, $url, get_string('books', 'mod_reader'));
$showadminarea = true;
}
if ($this->reader->can_manageusers()) {
$tab = self::TAB_USERS;
$url = new moodle_url('/mod/reader/admin/users.php', array('id' => $cmid, 'tab' => $tab));
$tabs[$tab] = new tabobject($tab, $url, get_string('users', 'mod_reader'));
$showadminarea = true;
}
if ($this->reader->can_managetools() || $this->reader->can_managebooks()) {
$tab = self::TAB_TOOLS;
$url = new moodle_url('/mod/reader/admin/tools.php', array('id' => $cmid, 'tab' => $tab));
$tabs[$tab] = new tabobject($tab, $url, get_string('tools', 'mod_reader'));
$showadminarea = true;
}
if ($showadminarea) {
$tab = self::TAB_ADMINAREA;
$url = new moodle_url('/mod/reader/admin.php', array('id' => $cmid, 'tab' => $tab, 'a' => 'admin'));
$tabs[$tab] = new tabobject($tab, $url, get_string('adminarea', 'mod_reader'));
}
}
return $tabs;
}
/**
* attach_tabs_subtree
*
* @return string HTML output to display navigation tabs
*/
public function attach_tabs_subtree($tabs, $id, $subtree) {
foreach (array_keys($tabs) as $i) {
if ($tabs[$i]->id==$id) {
$tabs[$i]->subtree = $subtree;
}
}
return $tabs;
}
///////////////////////////////////////////
// generate SQL to select available books
///////////////////////////////////////////
/**
* available_sql
* generate sql to select books that this user is currently allowed to attempt
*
* @param boolean $noquiz TRUE books that have no associated quiz, FALSE otherwise
* @param mixed $hasquiz (TRUE : require quizid > 0,
* FALSE : require quizid == 0,
* NULL : require quizid >= 0)
* @return array (string $from, string $where, array $params)
*/
public function available_sql($hasquiz=null) {
global $USER;
$reader = $this->reader;
$cmid = $reader->cm->id;
$userid = $USER->id;
return reader_available_sql($cmid, $reader, $userid, $hasquiz);
}
/**
* select_items
*
* @param xxx $action
* @return xxx
* @todo Finish documenting this function
*/
public function select_items($action='') {
global $CFG, $USER;
// get parameters passed from browser
$publisher = optional_param('publisher', null, PARAM_CLEAN); // book publisher
$level = optional_param('level', null, PARAM_CLEAN); // book level
$bookid = optional_param('bookid', null, PARAM_INT ); // book id
if ($action=='') {
$action = optional_param('action', $action, PARAM_CLEAN);
}
require_once($CFG->dirroot.'/mod/reader/admin/books/download/downloader.php');
$type = reader_downloader::BOOKS_WITHOUT_QUIZZES;
$type = optional_param('type', $type, PARAM_INT);
// get SQL $from and $where statements to extract available books
$hasquiz = ($type==reader_downloader::BOOKS_WITH_QUIZZES);
list($from, $where, $params) = reader_available_sql($this->reader->cm->id,
$this->reader,
$USER->id,
$hasquiz);
$output = '';
switch (true) {
case ($publisher===null || $publisher=='' || optional_param('go', null, PARAM_CLEAN)):
$output .= $this->request_js();
$output .= html_writer::start_tag('div', array('id' => 'publishers'));
$output .= $this->select_publishers($action, $from, $where, $params, $type, $publisher, $level, $bookid);
$output .= html_writer::end_tag('div');
break;
case ($level===null || $level==''):
$output .= html_writer::start_tag('div', array('id' => 'levels'));
$output .= $this->select_levels($action, $from, $where, $params, $type, $publisher, $level, $bookid);
$output .= html_writer::end_tag('div');
break;
case ($bookid===null || $bookid==0) :
$output .= html_writer::start_tag('div', array('id' => 'books'));
$output .= $this->select_books($action, $from, $where, $params, $type, $publisher, $level, $bookid);
$output .= html_writer::end_tag('div');
break;
default:
$output .= $this->select_book($action, $from, $where, $params, $type, $publisher, $level, $bookid);
}
return $output;
}
/**
* select_items_url
*
* @param xxx $url
* @param xxx $params
* @return xxx
* @todo Finish documenting this function
*/
public function select_items_url($url, $params) {
$url = new moodle_url($url, $params);
$url = "$url"; // convert to string
if (substr($url, -1)=='=') {
// Moodle <= 2.4
$url = substr($url, 0 ,-1);
}
return "'$url='+escape(this.options[this.selectedIndex].value)";
}
/**
* select_publishers
*
* @param xxx $action
* @param xxx $from
* @param xxx $where
* @param xxx $sqlparams
* @param xxx $publisher (optional, default="")
* @param xxx $level (optional, default="")
* @param xxx $bookid (optional, default=0)
* @return xxx
* @todo Finish documenting this function
*/
public function select_publishers($action, $sqlfrom, $sqlwhere, $sqlparams, $type, $publisher='', $level='', $bookid=0) {
global $DB;
$output = '';
$select = 'rb.publisher, COUNT(*) AS countbooks';
if ($records = $DB->get_records_sql("SELECT $select FROM $sqlfrom WHERE $sqlwhere GROUP BY rb.publisher ORDER BY rb.publisher", $sqlparams)) {
$count = count($records);
} else {
$count = 0;
}
// publisher title
$output .= html_writer::tag('div', get_string('publisher', 'mod_reader'), array('class' => 'selecteditemhdr'));
// publisher list
if ($count==0) {
if ($this->reader->can_viewallbooks()) {
$msg = get_string('nobooksfound', 'mod_reader');
} else {
$msg = get_string('nobooksinlist', 'mod_reader');
}
$output .= html_writer::tag('div', $msg, array('class' => 'selecteditemtxt'));
} else if ($count==1) {
$record = reset($records);
$publisher = $record->publisher;
$output .= html_writer::tag('div', $publisher, array('class' => 'selecteditemtxt'));
$output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'publisher', 'value' => $publisher));
} else if ($count > 1) {
$params = array('action' => $action,
'mode' => $this->mode,
'id' => $this->reader->cm->id,
'type' => $type,
'publisher' => ''); // will be added by javascript
$url = $this->select_items_url('/mod/reader/view_books.php', $params);
$params = array('id' => 'id_publisher',
'name' => 'publisher',
'size' => min(10, count($records)),
'onchange' => "request($url, 'levels')");
$output .= html_writer::start_tag('select', $params);
foreach ($records as $record) {
$params = array('value' => $record->publisher);
if ($publisher==$record->publisher) {
$params['selected'] = 'selected';
}
$output .= html_writer::tag('option', "$record->publisher ($record->countbooks books)", $params);
}
$output .= html_writer::end_tag('select');
}
$output .= html_writer::start_tag('div', array('id' => 'levels'));
if ($count==0 || $publisher=='') {
$output .= html_writer::tag('div', '', array('id' => 'books'));
} else {
$output .= $this->select_levels($action, $sqlfrom, $sqlwhere, $sqlparams, $type, $publisher, $level, $bookid);
}
$output .= html_writer::end_tag('div');
return $output;
}
/**
* select_levels
*
* @param xxx $action
* @param xxx $sqlfrom
* @param xxx $sqlwhere
* @param xxx $sqlparams
* @param xxx $type
* @param xxx $publisher
* @param xxx $level (optional, default = "")
* @param xxx $bookid (optional, default = 0)
* @return xxx
* @todo Finish documenting this function
*/
public function select_levels($action, $sqlfrom, $sqlwhere, $sqlparams, $type, $publisher, $level='', $bookid=0) {
global $DB;
$output = '';
$select = "rb.level, COUNT(*) AS countbooks, ROUND(SUM(rb.difficulty) / COUNT(*), 0) AS average_difficulty";
$where = $sqlwhere.' AND rb.publisher = ?';
$params = array_merge($sqlparams, array($publisher));
if ($records = $DB->get_records_sql("SELECT $select FROM $sqlfrom WHERE $where GROUP BY rb.level ORDER BY average_difficulty", $params)) {
$count = count($records);
} else {
$count = 0;
}
// level title
$output .= html_writer::tag('div', get_string('level', 'mod_reader'), array('class' => 'selecteditemhdr'));
// level list
if ($count==0) {
$$msg = 'Sorry, there are currently no books for you by '.$publisher;
$output .= html_writer::tag('div', $msg, array('class' => 'selecteditemtxt'));
} else if ($count==1) {
$record = reset($records);
$level = $record->level;
$output .= html_writer::tag('div', $level, array('class' => 'selecteditemtxt'));
$output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'level', 'value' => $level));
} else if ($count > 1) {
$params = array('action' => $action,
'mode' => $this->mode,
'id' => $this->reader->cm->id,
'type' => $type,
'publisher' => $publisher,
'level' => ''); // will be added by javascript
$url = $this->select_items_url('/mod/reader/view_books.php', $params);
$params = array('id' => 'id_level',
'name' => 'level',
'size' => min(10, count($records)),
'onchange' => "request($url, 'books')");
$output .= html_writer::start_tag('select', $params);
foreach ($records as $record) {
if ($record->level=='' || $record->level=='--') {
$displaylevel = $publisher;
} else {
$displaylevel = $record->level;
}
$params = array('value' => $record->level);
if ($level==$record->level) {
$params['selected'] = 'selected';
}
$output .= html_writer::tag('option', "$displaylevel ($record->countbooks books)", $params);
}
$output .= html_writer::end_tag('select');
}
$output .= html_writer::start_tag('div', array('id' => 'books'));
if ($count==0 || $level=='') {
$output .= html_writer::tag('div', '', array('id' => 'book'));
} else {
$output .= $this->select_books($action, $sqlfrom, $sqlwhere, $sqlparams, $type, $publisher, $level, $bookid);
}
$output .= html_writer::end_tag('div');
return $output;
}
/**
* select_books
*
* @param xxx $action
* @param xxx $sqlfrom
* @param xxx $sqlwhere
* @param xxx $sqlparams
* @param xxx $type
* @param xxx $publisher
* @param xxx $level
* @param xxx $bookid (optional, default = 0)
* @return xxx
* @todo Finish documenting this function
*/
public function select_books($action, $sqlfrom, $sqlwhere, $sqlparams, $type, $publisher, $level, $bookid=0) {
global $DB;
$output = '';
$select = '*';
$where = $sqlwhere.' AND rb.publisher = ? AND rb.level = ?';
$params = array_merge($sqlparams, array($publisher, $level));
if ($records = $DB->get_records_sql("SELECT $select FROM $sqlfrom WHERE $where ORDER BY rb.name", $params)) {
$count = count($records);
} else {
$count = 0;
}
$output .= html_writer::tag('div', get_string('book', 'mod_reader'), array('class' => 'selecteditemhdr'));
if ($count==0) {
$msg = "Sorry, there are currently no books for you by $publisher ($level)";
$output .= html_writer::tag('div', $msg, array('class' => 'selecteditemtxt'));
} else if ($count==1) {
$record = reset($records); // just one book found
$bookid = $record->id;
$output .= html_writer::tag('div', $this->format_bookname($record), array('class' => 'selecteditemtxt'));
$output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'bookid', 'value' => $record->id));
} else if ($count > 1) {
$params = array('action' => $action,
'mode' => $this->mode,
'id' => $this->reader->cm->id,
'type' => $type,
'publisher' => $publisher,
'level' => $level,
'bookid' => ''); // will be added by javascript
$url = $this->select_items_url('/mod/reader/view_books.php', $params);
$params = array('id' => 'id_bookid',
'name' => 'bookid',
'size' => min(10, count($records)),
'onchange' => "request($url, 'bookid')");
$output .= html_writer::start_tag('select', $params);
foreach ($records as $record) {
$params = array('value' => $record->id);
if ($bookid==$record->id) {
$params['selected'] = 'selected';
}
$output .= html_writer::tag('option', "[RL-$record->difficulty] $record->name", $params);
}
$output .= html_writer::end_tag('select');
}
$output .= html_writer::start_tag('div', array('id' => 'bookid', 'style' => 'clear: both;'));
if ($count==0 || $bookid==0) {
// do nothing
} else {
$output .= $this->select_book($action, $sqlfrom, $sqlwhere, $sqlparams, $type, $publisher, $level, $bookid);
}
$output .= html_writer::end_tag('div');
return $output;
}
/**
* select_book
*
* @param xxx $action
* @param xxx $sqlfrom
* @param xxx $sqlwhere
* @param xxx $sqlparams
* @param xxx $type
* @param xxx $publisher
* @param xxx $level
* @param xxx $bookid
* @return xxx
* @todo Finish documenting this function
*/
public function select_book($action, $sqlfrom, $sqlwhere, $sqlparams, $type, $publisher, $level, $bookid) {
global $DB;
$output = '';
$select = 'rb.id, rb.publisher, rb.level, rb.name, rb.words';
$where = $sqlwhere.' AND rb.publisher = ? AND rb.level = ? AND rb.id = ?';
$params = array_merge($sqlparams, array($publisher, $level, $bookid));
if ($record = $DB->get_record_sql("SELECT $select FROM $sqlfrom WHERE $where", $params)) {
$output .= html_writer::tag('div', $this->format_bookname($record), array('class' => 'selecteditemtxt'));
$output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'bookid', 'value' => $record->id));
}
return $output;
}
/**
* format_bookname
*
* @param xxx $book
* @return xxx
* @todo Finish documenting this function
*/
public function format_bookname($book) {
return "$book->name (".$this->number_format($book->words)." words)";
}
/**
* get_booktable
*
* @param xxx $action
* @return xxx
* @todo Finish documenting this function
*/
public function get_booktable($action='') {
return 'reader_books';
}
/**
* request_js
*
* @return string
*/
public function request_js() {
static $done = false;
if ($done) {
return '';
}
$done = true;
global $PAGE;
if (method_exists($PAGE->theme, 'image_url')) {
$image_url = 'image_url'; // Moodle >= 3.3
} else {
$image_url = 'pix_url'; // Moodle <= 3.2
}
$src = $PAGE->theme->$image_url('i/ajaxloader', 'core')->out();
$js = '';
$js .= '<script type="text/javascript">'."\n";
$js .= "//<![CDATA[\n";
$js .= "window.loading = '".'<img src="'.$src.'" alt="loading..."/>'."';\n";
$js .= "window.req = false;\n";
$js .= "function request(url, targetids, callback) {\n";
$js .= " url = url.replace(new RegExp('&', 'g'), '&');\n";
$js .= " if (typeof(targetids)=='string') {\n";
$js .= " targetids = targetids.split(',');\n";
$js .= " }\n";
$js .= " var i_max = targetids.length;\n";
$js .= " for (var i=0; i<i_max; i++) {\n";
$js .= " var obj = document.getElementById(targetids[i]);\n";
$js .= " if (obj) {\n";
$js .= " obj.innerHTML = (i==0 && loading ? loading : '');\n";
$js .= " obj = null;\n";
$js .= " }\n";
$js .= " }\n";
$js .= " if (window.XMLHttpRequest) {\n"; // modern browser (incl. IE7+)
$js .= " req = new XMLHttpRequest();\n";
$js .= " } else if (window.ActiveXObject) {\n"; // IE6, IE5
$js .= " req = new ActiveXObject('Microsoft.XMLHTTP');\n";
$js .= " }\n";
$js .= " if (req) {\n"; // && confirm('REQUEST: ' + url)
$js .= " if (callback) {\n";
$js .= " req.onreadystatechange = eval(callback);\n";
$js .= " } else {\n";
$js .= " req.onreadystatechange = function() { response(url, targetids); }\n";
$js .= " }\n";
$js .= " req.open('GET', url, true);\n";
$js .= " req.send(null);\n";
$js .= " }\n";
$js .= "}\n";
$js .= "function response(url, targetids) {\n";
$js .= " if (req.readyState==4) {\n";
$js .= " if (typeof(targetids)=='string') {\n";
$js .= " targetids = targetids.split(',');\n";
$js .= " }\n";
$js .= " var i_max = targetids.length;\n";
$js .= " for (var i=0; i<i_max; i++) {\n";
$js .= " var obj = document.getElementById(targetids[i]);\n";
$js .= " if (obj) {\n";
$js .= " if (req.status==200) {\n";
$js .= " obj.innerHTML = req.responseText;\n";
$js .= " } else if (i==0) {\n";
$js .= " obj.innerHTML = 'An error was encountered: ' + req.status;\n";
$js .= " } else {\n";
$js .= " obj.innerHTML = '';\n";
$js .= " }\n";
$js .= " obj = null;\n";
$js .= " }\n";
$js .= " }\n";
$js .= " }\n";
$js .= "}\n";
$js .= "function setLoadMessage(msg) {\n";
$js .= " loading = msg;\n";
$js .= "}\n";
$js .= "//]]>\n";
$js .= "</script>\n";
return $js;
}
///////////////////////////////////////////
// get user level and book difficulty
///////////////////////////////////////////
/**
* get_level_data
*
* @uses $CFG
* @uses $DB
* @uses $USER
* @return xxx
* @todo Finish documenting this function
*/
public function get_level_data($userid=0) {
global $CFG, $DB, $USER;
// initialize count of quizzes taken at "prev", "this" and "next" levels
// Note that for "prev" and "next" we count ANY attempt
// but for "this" level, we only count PASSED attempts
$count = array('prev' => 0, 'this' => 0, 'next' => 0);
if ($userid==0) {
$userid = $USER->id;
}
if (! $level = $DB->get_record('reader_levels', array('userid' => $userid, 'readerid' => $this->id))) {
$level = (object)array(
'userid' => $userid,
'readerid' => $this->id,
'startlevel' => 0,
'currentlevel' => 0,
'allowpromotion' => 1,
'stoplevel' => $this->stoplevel,
'goal' => $this->goal,
'time' => time(),
);
if (! $level->id = $DB->insert_record('reader_levels', $level)) {
// oops record could not be added - shouldn't happen !!
}
}
$select = 'ra.*, rb.difficulty, rb.id AS bookid';
$from = '{reader_attempts} ra INNER JOIN {reader_books} rb ON ra.bookid = rb.id';
$where = 'ra.userid= ? AND ra.readerid= ? AND ra.timefinish > ?';
$params = array($USER->id, $this->id, $this->ignoredate);
if ($attempts = $DB->get_records_sql("SELECT $select FROM $from WHERE $where ORDER BY ra.timemodified", $params)) {
foreach ($attempts as $attempt) {
$difficulty = $this->get_reader_difficulty($attempt->bookid, $attempt->difficulty);
switch (true) {
case ($difficulty == ($level->currentlevel - 1)):
if ($level->currentlevel < $level->startlevel) {
$count['prev'] = -1;
} else if ($level->time < $attempt->timefinish) {
$count['prev'] += 1;
}
break;
case ($difficulty == $level->currentlevel):
if ($attempt->passed) {
$count['this'] += 1;
}
break;
case ($difficulty == ($level->currentlevel + 1)):
if ($level->time < $attempt->timefinish) {
$count['next'] += 1;
}
break;
}
}
}
// if this is the highest allowed level, then disable the "allowpromotion" switch
if ($level->stoplevel > 0 && $level->stoplevel <= $level->currentlevel) {
$DB->set_field('reader_levels', 'allowpromotion', 0, array('readerid' => $this->id, 'userid' => $USER->id));
$level->allowpromotion = 0;
}
if ($level->allowpromotion==0) {
$count['this'] = 1;
}
// promote this student, if they have done enough quizzes at this level
if ($count['this'] >= $this->thislevel) {
$level->currentlevel += 1;
$level->time = time();
$DB->update_record('reader_levels', $level);
$count['this'] = 0;
$count['prev'] = 0;
$count['next'] = 0;
echo '<script type="text/javascript">'."\n";
echo '//<![CDATA['."\n";
echo 'alert("'.addslashes_js(get_string('youhavebeenpromoted', 'mod_reader'. $level->currentlevel)).'");'."\n";
echo '//]]>'."\n";
echo '</script>';
}
// prepare level data
$leveldata = array(
'promotiondate' => $level->time,
'currentlevel' => $level->currentlevel, // current level of this user
'prevlevel' => $this->prevlevel - $count['prev'], // number of quizzes allowed at previous level
'thislevel' => $this->thislevel - $count['this'], // number of quizzes allowed at current level
'nextlevel' => $this->nextlevel - $count['next'] // number of quizzes allowed at next level
);
if ($level->currentlevel==0 || $count['prev'] == -1) {
$leveldata['prevlevel'] = -1;
}
return $leveldata;
}
/**
* get_reader_difficulty
*
* @uses $DB
* @param xxx $bookid
* @param xxx $difficulty (optional, default=0)
* @return xxx
* @todo Finish documenting this function
*/
public function get_reader_difficulty($bookid, $difficulty=0) {
global $DB;
// "Course-specific quiz selection" is enabled for this reader activity
if ($this->bookinstances) {
if ($instance = $DB->get_record('reader_book_instances', array('readerid' => $this->id, 'bookid' => $bookid))) {
return $instance->difficulty;
}
}
// if we already know the difficulty for this book, then use that
if ($difficulty) {
return $difficulty;
}
// get the book difficulty from the "reader_books" table
if ($book = $DB->get_record('reader_books', array('id' => $bookid))) {
return $book->difficulty;
}
return 0; // shouldn't happen !!
}
///////////////////////////////////////////
// format search form
///////////////////////////////////////////
/**
* search_form
*
* generate HTML code to display a form to search for books
* that appears when students view this module. As well as
* allowing students to search by name, the form includes
* filters for publisher, level, reading level, and genre.
*
* The action for this form is handled by view_books.php
* which calls the books_menu() method
*
* @param xxx $userid
* @param xxx $includeformtag (optional, default=false)
* @param xxx $action (optional, default='')
* @return html code for a form to enter criteria for searching books
* @todo Finish documenting this function
*/
public function search_form($userid=0, $includeformtag=false, $action='') {
global $CFG, $DB, $OUTPUT, $USER;
$output = '';
if ($userid==0) {
$userid = $USER->id;
}
// get parameters passed from form
$searchpublisher = optional_param('searchpublisher', '', PARAM_CLEAN);
$searchlevel = optional_param('searchlevel', '', PARAM_CLEAN);
$searchname = optional_param('searchname', '', PARAM_CLEAN);
$searchgenre = optional_param('searchgenre', '', PARAM_CLEAN);
$searchdifficulty = optional_param('searchdifficulty', -1, PARAM_INT);
$search = optional_param('search', 0, PARAM_INT);
$action = optional_param('action', $action, PARAM_CLEAN);
$ajax = optional_param('ajax', 0, PARAM_INT);
// get SQL $from and $where statements to extract available books
list($from, $where, $sqlparams) = reader_available_sql($this->reader->cm->id, $this->reader, $userid);
if ($includeformtag) {
$target_div = 'searchresultsdiv';
$target_url = "'view_books.php?id=".$this->reader->cm->id."'".
"+'&ajax=1'". // so we can detect incoming search results
"+'&search='+parseInt(this.search.value)".
"+'&action=$action'". // "adjustscores" or "takequiz"
"+'&searchpublisher='+escape(this.searchpublisher.value)".
"+'&searchlevel='+escape(this.searchlevel.value)".
"+'&searchname='+escape(this.searchname.value)".
"+'&searchgenre='+escape(this.searchgenre.options[this.searchgenre.selectedIndex].value)".
"+'&searchdifficulty='+this.searchdifficulty.options[this.searchdifficulty.selectedIndex].value";
// create the search form
$params = array(
'id' => 'id_readersearchform',
'class' => 'readersearchform',
'method' => 'post',
'action' => new moodle_url('/mod/reader/view.php', array('id' => $this->reader->cm->id)),
'onsubmit' => "request($target_url, '$target_div'); return false;"
);
$output .= html_writer::start_tag('form', $params);
$hidden = html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'search', 'value' => 1));
$output .= html_writer::tag('div', $hidden, array('style' => 'display: none;'));
$table = new html_table();
$table->align = array('right', 'left');
$table->rowclasses[0] = 'advanced'; // publisher
$table->rowclasses[1] = 'advanced'; // level
$table->rowclasses[3] = 'advanced'; // genre
$table->rowclasses[4] = 'advanced'; // difficulty
$table->data[] = new html_table_row(array(
html_writer::tag('b', get_string('publisher', 'mod_reader').':'),
html_writer::empty_tag('input', array('type' => 'text', 'name' => 'searchpublisher', 'value' => $searchpublisher))
));
$table->data[] = new html_table_row(array(
html_writer::tag('b', get_string('level', 'mod_reader').':'),
html_writer::empty_tag('input', array('type' => 'text', 'name' => 'searchlevel', 'value' => $searchlevel))
));
$table->data[] = new html_table_row(array(
html_writer::tag('b', get_string('booktitle', 'mod_reader').':'),
html_writer::empty_tag('input', array('type' => 'text', 'name' => 'searchname', 'value' => $searchname))
));
// get list of valid and available genres ($code => $text)
$genres = $this->available_genres($from, $where, $sqlparams);
$genres = array('' => get_string('none')) + $genres;
// add the "genre" drop-down list
$table->data[] = new html_table_row(array(
html_writer::tag('b', get_string('genre', 'mod_reader').':'),
html_writer::select($genres, 'searchgenre', $searchgenre, '')
));
// can this user view all levels of books in this reader activity?
if (isset($_SESSION['SESSION']->reader_teacherview) && $_SESSION['SESSION']->reader_teacherview == 'teacherview') {
// this is a teacher
$alllevels = true;
} else if ($this->reader->levelcheck == 0) {
// no level checking
$alllevels = true;
} else {
$alllevels = false;
}
// create list of RL's (reading levels) this user can attempt
$levels = array();
if ($alllevels) {
if ($this->reader->bookinstances) {
$tablename = 'reader_book_instances';
} else {
$tablename = 'reader_books';
}
if ($records = $DB->get_records_select($tablename, 'difficulty < 99', null, 'difficulty', 'DISTINCT difficulty')) {
foreach ($records as $record) {
$levels[] = $record->difficulty;
}
}
} else {
$leveldata = reader_get_level_data($this->reader, $userid);
if ($leveldata['prevlevel'] > 0 && $leveldata['currentlevel'] >= 1) {
$levels[] = ($leveldata['currentlevel'] - 1);
}
if ($leveldata['thislevel'] > 0 && $leveldata['currentlevel'] >= 0) {
$levels[] = $leveldata['currentlevel'];