mirrored from git://git.moodle.org/moodle.git
/
blocklib.php
1073 lines (935 loc) · 38.1 KB
/
blocklib.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$
//This library includes all the necessary stuff to use blocks in course pages
define('BLOCK_LEFT', 11);
define('BLOCK_RIGHT', 12);
define('BLOCK_MOVE_LEFT', 0x01);
define('BLOCK_MOVE_RIGHT', 0x02);
define('BLOCK_MOVE_UP', 0x04);
define('BLOCK_MOVE_DOWN', 0x08);
function block_remove_inappropriate_from_course(&$course) {
$blocks = $course->blockinfo;
$delimpos = strpos($blocks, ':');
if($delimpos === false) {
// No ':' found, we have all left blocks
$leftblocks = explode(',', $blocks);
$rightblocks = array();
}
else if($delimpos === 0) {
// ':' at start of string, we have all right blocks
$blocks = substr($blocks, 1);
$leftblocks = array();
$rightblocks = explode(',', $blocks);
}
else {
// Both left and right blocks
$leftpart = substr($blocks, 0, $delimpos);
$rightpart = substr($blocks, $delimpos + 1);
$leftblocks = explode(',', $leftpart);
$rightblocks = explode(',', $rightpart);
}
$allblocks = get_records('blocks');
if(!empty($leftblocks)) {
foreach($leftblocks as $key => $id) {
$positiveid = abs($id);
$formats = block_method_result($allblocks[$positiveid]->name, 'applicable_formats');
if( !(isset($formats[$course->format]) ? $formats[$course->format] : !empty($formats['all']))) {
unset($leftblocks[$key]);
}
}
}
if(!empty($rightblocks)) {
foreach($rightblocks as $key => $id) {
$positiveid = abs($id);
$formats = block_method_result($allblocks[$positiveid]->name, 'applicable_formats');
if( !(isset($formats[$course->format]) ? $formats[$course->format] : !empty($formats['all']))) {
unset($rightblocks[$key]);
}
}
}
$course->blockinfo = implode(',', $leftblocks);
if(!empty($rightblocks)) {
$course->blockinfo .= ':' . implode(',', $rightblocks);
}
}
// Returns the case-sensitive name of the class' constructor function. This includes both
// PHP5- and PHP4-style constructors. If no appropriate constructor can be found, returns NULL.
// If there is no such class, returns boolean false.
function get_class_constructor($classname) {
// Caching
static $constructors = array();
if(!class_exists($classname)) {
return false;
}
// Tests indicate this doesn't hurt even in PHP5.
$classname = strtolower($classname);
// Return cached value, if exists
if(isset($constructors[$classname])) {
return $constructors[$classname];
}
// Get a list of methods. After examining several different ways of
// doing the check, (is_callable, method_exists, function_exists etc)
// it seems that this is the most reliable one.
$methods = get_class_methods($classname);
// PHP5 constructor?
if(phpversion() >= '5') {
if(in_array('__construct', $methods)) {
return $constructors[$classname] = '__construct';
}
}
// If we have PHP5 but no magic constructor, we have to lowercase the methods
$methods = array_map('strtolower', $methods);
if(in_array($classname, $methods)) {
return $constructors[$classname] = $classname;
}
return $constructors[$classname] = NULL;
}
//This function retrieves a method-defined property of a class WITHOUT instantiating an object
//It seems that the only way to use the :: operator with variable class names is eval() :(
//For caveats with this technique, see the PHP docs on operator ::
function block_method_result($blockname, $method) {
if(!block_load_class($blockname)) {
return NULL;
}
return eval('return CourseBlock_'.$blockname.'::'.$method.'();');
}
//This function creates a new object of the specified block class
function block_instance($blockname, $argument) {
if(!block_load_class($blockname)) {
return false;
}
$classname = 'CourseBlock_'.$blockname;
return New $classname($argument);
}
//This function loads the necessary class files for a block
//Whenever you want to load a block, use this first
function block_load_class($blockname) {
global $CFG;
@include_once($CFG->dirroot.'/blocks/moodleblock.class.php');
$classname = 'CourseBlock_'.$blockname;
@include_once($CFG->dirroot.'/blocks/'.$blockname.'/block_'.$blockname.'.php');
// After all this, return value indicating success or failure
return class_exists($classname);
}
//This function determines if there is some active block in an array of blocks
function block_have_active($array) {
foreach($array as $blockid) {
if($blockid > 0) {
return true;
}
}
return false;
}
//This function print the one side of blocks in course main page
function print_course_blocks(&$course, $blocksarray, $side) {
global $CFG;
$isediting = isediting($course->id);
$ismoving = ismoving($course->id);
$isteacheredit = isteacheredit($course->id);
if(!empty($blocksarray)) {
// Include the base class
@include_once($CFG->dirroot.'/blocks/moodleblock.class.php');
if(!class_exists('moodleblock')) {
error('Class MoodleBlock is not defined or file not found for /course/blocks/moodleblock.class.php');
}
$blockdata = get_records('blocks', 'visible', 1);
if($blockdata !== false) {
$lastblock = end($blocksarray);
$firstblock = reset($blocksarray);
foreach($blocksarray as $blockid) {
if(!isset($blockdata[abs($blockid)])) {
// This block is hidden. Don't show it.
continue;
}
$blockname = $blockdata[abs($blockid)]->name;
$block = block_instance($blockname, $course);
if($block === false) {
// Something went wrong
continue;
}
// There are various sanity checks commented out below
// because the block detection code should have already done them long ago.
/*
if(!is_subclass_of($block, 'MoodleBlock')) {
// Error: you have to derive from MoodleBlock
continue;
}
if($content === NULL || $title === NULL) {
// Error: This shouldn't have happened
continue;
}
*/
if ($isediting && !$ismoving && $isteacheredit) {
$options = 0;
$options |= BLOCK_MOVE_UP * ($blockid != $firstblock);
$options |= BLOCK_MOVE_DOWN * ($blockid != $lastblock);
$options |= ($side == BLOCK_LEFT) ? BLOCK_MOVE_RIGHT : BLOCK_MOVE_LEFT;
$block->add_edit_controls($options, $blockid);
}
if($blockid < 0) {
// We won't print this block...
if($isediting) {
// Unless we 're in editing mode, in which case we 'll print a 'shadow'
$block->print_shadow();
}
continue;
}
// So simple...
$block->print_block();
}
}
}
}
//This iterates over an array of blocks and calculates the preferred width
function blocks_preferred_width($blockarray, $blockinfos) {
$width = 0;
if(!is_array($blockarray) || empty($blockarray)) {
return 0;
}
foreach($blockarray as $blockid) {
if($blockid < 0) {
// Invisible block
continue;
}
if(isset($blockinfos[$blockid])) {
$blockname = $blockinfos[$blockid]->name;
$pref = block_method_result($blockname, 'preferred_width');
if($pref === NULL) {
continue;
}
if($pref > $width) {
$width = $pref;
}
}
}
return $width;
}
// $course passed by reference for speed
// $leftblocks, $rightblocks passed by reference because block_action() needs to
// update the arrays so that the change can be shown immediately.
function block_action(&$course, &$leftblocks, &$rightblocks, $blockaction, $blockid) {
$blockid = abs(intval($blockid)); // Just to make sure
switch($blockaction) {
case 'toggle':
$block = block_find($blockid, $leftblocks, $rightblocks);
if($block !== false) {
if($block->side == BLOCK_LEFT) {
$leftblocks[$block->position] = -$leftblocks[$block->position];
}
else {
$rightblocks[$block->position] = -$rightblocks[$block->position];
}
}
break;
case 'delete':
$block = block_find($blockid, $leftblocks, $rightblocks);
if($block !== false) {
if($block->side == BLOCK_LEFT) {
unset($leftblocks[$block->position]);
}
else {
unset($rightblocks[$block->position]);
}
}
break;
case 'add':
// Toggle to enabled, or add it if it doesn't exist at all
$block = block_find($blockid, $leftblocks, $rightblocks);
if($block === false) {
// It doesn't exist at all, so add it
$rightblocks[] = $blockid;
}
else if($block->enabled == false) {
// Enable it
if($block->side == BLOCK_LEFT) {
$leftblocks[$block->position] = -$leftblocks[$block->position];
}
else {
$rightblocks[$block->position] = -$rightblocks[$block->position];
}
}
break;
case 'moveup':
$block = block_find($blockid, $leftblocks, $rightblocks);
if($block !== false) {
if($block->side == BLOCK_LEFT) {
if(isset($leftblocks[$block->position - 1])) {
// We can move it upwards
$oldblock = $leftblocks[$block->position - 1];
$leftblocks[$block->position - 1] = $leftblocks[$block->position]; // not $blockid, as this loses the sign
$leftblocks[$block->position] = $oldblock;
}
}
else {
if(isset($rightblocks[$block->position - 1])) {
// We can move it upwards
$oldblock = $rightblocks[$block->position - 1];
$rightblocks[$block->position - 1] = $rightblocks[$block->position]; // not $blockid, as this loses the sign
$rightblocks[$block->position] = $oldblock;
}
}
}
break;
case 'movedown':
$block = block_find($blockid, $leftblocks, $rightblocks);
if($block !== false) {
if($block->side == BLOCK_LEFT) {
if(isset($leftblocks[$block->position + 1])) {
// We can move it downwards
$oldblock = $leftblocks[$block->position + 1];
$leftblocks[$block->position + 1] = $leftblocks[$block->position]; // not $blockid, as this loses the sign
$leftblocks[$block->position] = $oldblock;
}
}
else {
if(isset($rightblocks[$block->position + 1])) {
// We can move it downwards
$oldblock = $rightblocks[$block->position + 1];
$rightblocks[$block->position + 1] = $rightblocks[$block->position]; // not $blockid, as this loses the sign
$rightblocks[$block->position] = $oldblock;
}
}
}
break;
case 'moveside':
$block = block_find($blockid, $leftblocks, $rightblocks);
if($block !== false) {
if($block->side == BLOCK_LEFT) {
unset($leftblocks[$block->position]);
$rightblocks[] = $block->enabled ? $blockid : -$blockid;
}
else {
unset($rightblocks[$block->position]);
$leftblocks[] = $block->enabled ? $blockid : -$blockid;
}
}
break;
}
$course->blockinfo = implode(',', $leftblocks).':'.implode(',',$rightblocks);
set_field('course', 'blockinfo', $course->blockinfo, 'id', $course->id);
}
// Searches for the block with ID $blockid in one or more of the two
// blocks arrays. If not found, returns boolean false. Otherwise,
// returns an object $finding where:
// $finding->side = BLOCK_LEFT or BLOCK_RIGHT
// $finding->enabled = true or false
// $finding->position = index of corresponding array where found
function block_find($blockid, $leftblocks, $rightblocks) {
if(($blockid = abs($blockid)) == 0) {
return false;
}
$finding->side = BLOCK_LEFT;
$finding->enabled = true;
$finding->position = NULL;
// First, search for the "enabled" block, since that's what we
// will be doing most of the time.
$key = array_search($blockid, $leftblocks);
if($key !== false && $key !== NULL) {
$finding->position = $key;
return $finding;
}
$key = array_search($blockid, $rightblocks);
if($key !== false && $key !== NULL) {
$finding->position = $key;
$finding->side = BLOCK_RIGHT;
return $finding;
}
// "enabled" block not found. Now search for the disabled block.
$finding->enabled = false;
$blockid = -$blockid;
$key = array_search($blockid, $leftblocks);
if($key !== false && $key !== NULL) {
$finding->position = $key;
return $finding;
}
$key = array_search($blockid, $rightblocks);
if($key !== false && $key !== NULL) {
$finding->position = $key;
$finding->side = BLOCK_RIGHT;
return $finding;
}
// Nothing found :(
return false;
}
//This function prints the block to admin blocks as necessary
function block_print_blocks_admin(&$course, $missingblocks) {
if (isediting($course->id)) {
$strblocks = get_string('blocks');
$stradd = get_string('add');
if (!empty($missingblocks)) {
$blockdata = get_records_list('blocks', 'id', implode(',', $missingblocks));
if ($blockdata !== false) {
foreach ($blockdata as $block) {
$blockobject = block_instance($block->name, $course);
if ($blockobject === false) {
continue;
}
$menu[$block->id] = $blockobject->get_title();
}
if($course->id == 1) {
$target = 'index.php';
}
else {
$target = 'view.php';
}
$content = popup_form($target.'?id='.$course->id.'&blockaction=add&blockid=',
$menu, 'add_block', '', "$stradd...", '', '', true);
$content = '<div align="center">'.$content.'</div>';
print_side_block($strblocks, $content, NULL, NULL, NULL);
}
}
}
}
function upgrade_blocks_db($continueto) {
/// This function upgrades the blocks tables, if necessary
/// It's called from admin/index.php
global $CFG, $db;
require_once ("$CFG->dirroot/blocks/version.php"); // Get code versions
if (empty($CFG->blocks_version)) { // Blocks have never been installed.
$strdatabaseupgrades = get_string("databaseupgrades");
print_header($strdatabaseupgrades, $strdatabaseupgrades, $strdatabaseupgrades,
"", "", false, " ", " ");
$db->debug=true;
if (modify_database("$CFG->dirroot/blocks/db/$CFG->dbtype.sql")) {
$db->debug = false;
if (set_config("blocks_version", $blocks_version)) {
notify(get_string("databasesuccess"), "green");
notify(get_string("databaseupgradeblocks", "", $blocks_version));
print_continue($continueto);
exit;
} else {
error("Upgrade of blocks system failed! (Could not update version in config table)");
}
} else {
error("Blocks tables could NOT be set up successfully!");
}
}
if ($blocks_version > $CFG->blocks_version) { // Upgrade tables
$strdatabaseupgrades = get_string("databaseupgrades");
print_header($strdatabaseupgrades, $strdatabaseupgrades, $strdatabaseupgrades);
require_once ("$CFG->dirroot/blocks/db/$CFG->dbtype.php");
$db->debug=true;
if (blocks_upgrade($CFG->blocks_version)) {
$db->debug=false;
if (set_config("blocks_version", $blocks_version)) {
notify(get_string("databasesuccess"), "green");
notify(get_string("databaseupgradeblocks", "", $blocks_version));
print_continue($continueto);
exit;
} else {
error("Upgrade of blocks system failed! (Could not update version in config table)");
}
} else {
$db->debug=false;
error("Upgrade failed! See blocks/version.php");
}
} else if ($blocks_version < $CFG->blocks_version) {
notify("WARNING!!! The code you are using is OLDER than the version that made these databases!");
}
}
//This function finds all available blocks and install them
//into blocks table or do all the upgrade process if newer
function upgrade_blocks_plugins($continueto) {
global $CFG;
$blocktitles = array();
$invalidblocks = array();
$validblocks = array();
$notices = array();
//Count the number of blocks in db
$blockcount = count_records("blocks");
//If there isn't records. This is the first install, so I remember it
if ($blockcount == 0) {
$first_install = true;
} else {
$first_install = false;
}
$site = get_site();
if (!$blocks = get_list_of_plugins("blocks", "db") ) {
error("No blocks installed!");
}
include_once($CFG->dirroot."/blocks/moodleblock.class.php");
if(!class_exists('moodleblock')) {
error('Class MoodleBlock is not defined or file not found for /blocks/moodleblock.class.php');
}
foreach ($blocks as $blockname) {
if ($blockname == "NEWBLOCK") { // Someone has unzipped the template, ignore it
continue;
}
$fullblock = "$CFG->dirroot/blocks/$blockname";
if ( is_readable($fullblock."/block_".$blockname.".php")) {
include_once($fullblock."/block_".$blockname.".php");
} else {
$notices[] = "Block $blockname: ".$fullblock."/block_".$blockname.".php was not readable";
continue;
}
if ( is_dir("$fullblock/db/")) {
if ( is_readable("$fullblock/db/$CFG->dbtype.php")) {
include_once("$fullblock/db/$CFG->dbtype.php"); # defines upgrading function
} else {
$notices[] ="Block $blockname: $fullblock/db/$CFG->dbtype.php was not readable";
continue;
}
}
$classname = 'CourseBlock_'.$blockname;
if(!class_exists($classname)) {
$notices[] = "Block $blockname: $classname not implemented";
continue;
}
// Let's see if it supports some basic methods
$constructor = get_class_constructor($classname);
if(empty($constructor)) {
// No constructor
$notices[] = "Block $blockname: class does not have a constructor";
$invalidblocks[] = $blockname;
continue;
}
unset($block);
$blockobj = New $classname($site);
// Inherits from MoodleBlock?
if(!is_subclass_of($blockobj, 'moodleblock')) {
$notices[] = "Block $blockname: class does not inherit from MoodleBlock";
continue;
}
// OK, it's as we all hoped. For further tests, the object will do them itself.
if(!$blockobj->_self_test()) {
$notices[] = "Block $blockname: self test failed";
continue;
}
$block->version = $blockobj->get_version();
if (!isset($block->version)) {
$notices[] = "Block $blockname: hasn't version support";
continue;
}
$block->name = $blockname; // The name MUST match the directory
$blocktitle = $blockobj->get_title();
if ($currblock = get_record("blocks", "name", $block->name)) {
if ($currblock->version == $block->version) {
// do nothing
} else if ($currblock->version < $block->version) {
if (empty($updated_blocks)) {
$strblocksetup = get_string("blocksetup");
print_header($strblocksetup, $strblocksetup, $strblocksetup, "", "", false, " ", " ");
}
print_heading('New version of '.$blocktitle.' ('.$block->name.') exists');
$upgrade_function = $block->name.'_upgrade';
if (function_exists($upgrade_function)) {
$db->debug=true;
if ($upgrade_function($currblock->version, $block)) {
$upgradesuccess = true;
} else {
$upgradesuccess = false;
}
$db->debug=false;
}
else {
$upgradesuccess = true;
}
if(!$upgradesuccess) {
notify("Upgrading block $block->name from $currblock->version to $block->version FAILED!");
}
else {
// OK so far, now update the blocks record
$block->id = $currblock->id;
if (! update_record('blocks', $block)) {
error("Could not update block $block->name record in blocks table!");
}
notify(get_string('blocksuccess', '', $blocktitle), 'green');
echo '<hr />';
}
$updated_blocks = true;
} else {
error("Version mismatch: block $block->name can't downgrade $currblock->version -> $block->version !");
}
} else { // block not installed yet, so install it
// [pj] Normally this would be inline in the if, but we need to
// check for NULL (necessary for 4.0.5 <= PHP < 4.2.0)
$conflictblock = array_search($blocktitle, $blocktitles);
if($conflictblock !== false && $conflictblock !== NULL) {
// Duplicate block titles are not allowed, they confuse people
// AND PHP's associative arrays ;)
error('<strong>Naming conflict</strong>: block <strong>'.$block->name.'</strong> has the same title with an existing block, <strong>'.$conflictblock.'</strong>!');
}
if (empty($updated_blocks)) {
$strblocksetup = get_string("blocksetup");
print_header($strblocksetup, $strblocksetup, $strblocksetup, "", "", false, " ", " ");
}
print_heading($block->name);
$updated_blocks = true;
$db->debug = true;
@set_time_limit(0); // To allow slow databases to complete the long SQL
if (!is_dir("$fullblock/db/") || modify_database("$fullblock/db/$CFG->dbtype.sql")) {
$db->debug = false;
if ($block->id = insert_record('blocks', $block)) {
notify(get_string('blocksuccess', '', $blocktitle), 'green');
echo "<HR>";
} else {
error("$block->name block could not be added to the block list!");
}
} else {
error("Block $block->name tables could NOT be set up successfully!");
}
}
$blocktitles[$block->name] = $blocktitle;
}
if(!empty($notices)) {
foreach($notices as $notice) {
notify($notice);
}
}
//Finally, if we are in the first_install, update every course blockinfo field with
//default values.
if ($first_install) {
//Iterate over each course
if ($courses = get_records("course")) {
foreach ($courses as $course) {
//Depending of the format, insert some values
$blockinfo = blocks_get_default_blocks ($course->id,
blocks_get_config_default($course->format));
if ($CFG->debug) {
echo 'Updating blockinfo for course: '.$course->shortname.'('.$blockinfo.')<br>';
}
}
}
}
if (!empty($CFG->siteblocksadded)) { /// This is a once-off hack to make a proper upgrade
blocks_get_default_blocks(SITEID, blocks_get_config_default()); // Add blockinfo to the site course
delete_records('config', 'name', 'siteblocksadded');
}
if (!empty($updated_blocks)) {
print_continue($continueto);
die;
}
}
//This function returns the number of courses currently using the block
function blocks_get_courses_using_block_by_id($blockid) {
$num = 0;
if ($courses = get_records("course")) {
foreach($courses as $course) {
$blocks = str_replace(":",",",$course->blockinfo);
$blocksarr = explode(",",$blocks);
if (block_find($blockid,$blocksarr,array())) {
$num++;
}
}
}
return $num;
}
//This function hides a block in all courses using it
function blocks_update_every_block_by_id($blockid,$action) {
if ($courses = get_records("course")) {
foreach($courses as $course) {
//Calculate left and right blocks
$blocks = $course->blockinfo;
$delimpos = strpos($blocks, ':');
if($delimpos === false) {
// No ':' found, we have all left blocks
$leftblocks = explode(',', $blocks);
$rightblocks = array();
} else if($delimpos === 0) {
// ':' at start of string, we have all right blocks
$blocks = substr($blocks, 1);
$leftblocks = array();
$rightblocks = explode(',', $blocks);
}
else {
// Both left and right blocks
$leftpart = substr($blocks, 0, $delimpos);
$rightpart = substr($blocks, $delimpos + 1);
$leftblocks = explode(',', $leftpart);
$rightblocks = explode(',', $rightpart);
}
switch($action) {
case 'show':
$block = block_find($blockid, $leftblocks, $rightblocks);
if($block !== false) {
if($block->side == BLOCK_LEFT) {
$leftblocks[$block->position] = abs($leftblocks[$block->position]);
}
else {
$rightblocks[$block->position] = abs($rightblocks[$block->position]);
}
}
break;
case 'hide':
$block = block_find($blockid, $leftblocks, $rightblocks);
if($block !== false) {
if($block->side == BLOCK_LEFT) {
$leftblocks[$block->position] = -abs($leftblocks[$block->position]);
}
else {
$rightblocks[$block->position] = -abs($rightblocks[$block->position]);
}
}
break;
case 'delete':
$block = block_find($blockid, $leftblocks, $rightblocks);
if($block !== false) {
if($block->side == BLOCK_LEFT) {
unset($leftblocks[$block->position]);
}
else {
unset($rightblocks[$block->position]);
}
}
break;
}
$course->blockinfo = implode(',', $leftblocks).':'.implode(',',$rightblocks);
set_field('course', 'blockinfo', $course->blockinfo, 'id', $course->id);
}
}
}
// [pj] I didn't like the block_get_X_by_Y() functions because
// we should be able to do without them with clever coding,
// so I set out to see if they could be removed somehow.
// Only block_get_default_blocks() depends on them, and that
// one is used nowhere at the moment. So I 'm commenting
// them out until a use IS found.
// [el] Uncommented to be used in the installation process, when
// inserting new courses and when restoring courses. Perhaps
// they can be modified, but previously related processes
// will use them since now.
//This function returns the id of the block, searching it by name
function block_get_id_by_name ($blockname) {
if ($block = get_record("blocks","name",$blockname)) {
return $block->id;
} else {
return 0;
}
}
//This function returns the name of the block, searching it by id
function block_get_name_by_id ($blockid) {
if ($block = get_record("blocks","id",$blockid)) {
return $block->name;
} else {
return NULL;
}
}
//This function return the necessary contents to update course->blockinfo
//with default values. It accepts a list of block_names as parameter. They
//will be converted to their blockids equivalent. If a course is specified
//then the function will update the field too!
function blocks_get_default_blocks ($courseid = NULL, $blocknames = '') {
global $CFG;
if (empty($blocknames)) {
if (!empty($CFG->defaultblocks_override)) {
$blocknames = $CFG->defaultblocks_override;
} else {
$blocknames = $CFG->defaultblocks;
}
}
//Calculate left and right blocks
$blocksn = $blocknames;
$delimpos = strpos($blocksn, ':');
if($delimpos === false) {
// No ':' found, we have all left blocks
$leftblocksn = explode(',', $blocksn);
$rightblocksn = array();
} else if($delimpos === 0) {
// ':' at start of string, we have all right blocks
$blocksn = substr($blocksn, 1);
$leftblocksn = array();
$rightblocksn = explode(',', $blocksn);
}
else {
// Both left and right blocks
$leftpartn = substr($blocksn, 0, $delimpos);
$rightpartn = substr($blocksn, $delimpos + 1);
$leftblocksn = explode(',', $leftpartn);
$rightblocksn = explode(',', $rightpartn);
}
//Now I have blocks separated
$leftblocks = array();
$rightblocks = array();
if ($leftblocksn) {
foreach($leftblocksn as $leftblockn) {
//Convert blockname to id
$leftblock = block_get_id_by_name(str_replace("-","",$leftblockn));
if ($leftblock) {
//Check it's visible
if($block = get_record("blocks","id",$leftblock,"visible","1")) {
//Check if the module was hidden at course level
if (substr($leftblockn,0,1) == "-") {
$leftblocks[] = -$leftblock;
} else {
$leftblocks[] = $leftblock;
}
}
}
}
}
if ($rightblocksn) {
foreach($rightblocksn as $rightblockn) {
//Convert blockname to id
$rightblock = block_get_id_by_name(str_replace("-","",$rightblockn));
if ($rightblock) {
//Check it's visible
if($block = get_record("blocks","id",$rightblock,"visible","1")) {
//Check if the module was hidden at course level
if (substr($rightblockn,0,1) == "-") {
$rightblocks[] = -$rightblock;
} else {
$rightblocks[] = $rightblock;
}
}
}
}
}
//Calculate the blockinfo field
if ($leftblocks || $rightblocks) {
$blockinfo = '';
if ($leftblocks) {
$blockinfo .= implode(",", $leftblocks);
}
if ($rightblocks) {
$blockinfo .= ':'.implode(",",$rightblocks);
}
} else {
$blockinfo = '';
}
//If a course has been specified, update it
if ($courseid) {
set_field('course', "blockinfo", $blockinfo, "id", $courseid);
}
//Returns the blockinfo
return $blockinfo;
}
// This function returns the appropriate block default configuration string
// according to the $format argument. It will return the site override defined
// in the site config, a format override defined in the site config, a specific
// config defined in the course format config, or the site default.
// To request the site format, leave $format blank.
function blocks_get_config_default ($cformat='') {
global $CFG;
/// If the site override has been defined, it is the only valid one.
if (!empty($CFG->defaultblocks_override)) {
return $CFG->defaultblocks_override;
}
/// If not format is specified, return the site default.
else if ($cformat == '') {
if (!empty($CFG->defaultblocks_site)) {
return $CFG->defaultblocks_site;
}
/// Failsafe - in case nothing was defined.
else {
return 'site_main_menu,admin,course_list:course_summary,calendar_month';
}
}
/// Return the appropriate block string for the format.
else if (!empty($CFG->{'defaultblocks_'.$cformat})) {
return $CFG->{'defaultblocks_'.$cformat};
}
else {
$format_config = $CFG->dirroot.'/course/format/'.$cformat.'/config.php';
if (file_exists($format_config)) {
require($format_config);
}
if (!empty($format['defaultblocks'])) {
return $format['defaultblocks'];
}
else if (!empty($CFG->defaultblocks)){
return $CFG->defaultblocks;
}
/// Failsafe - in case nothing was defined.
else {
return 'participants,activity_modules,search_forums,admin,course_list:news_items,calendar_upcoming,recent_activity';
}
}
}
//This function will return the names representation of the blockinfo field.
//It's used to include that info in backups. To restore we'll use the
//blocks_get_block_ids() function. It makes the opposite conversion
//(from names to ids)
function blocks_get_block_names ($blockinfo) {
//Calculate left and right blocks
$blocksn = $blockinfo;
$delimpos = strpos($blocksn, ':');
if($delimpos === false) {
// No ':' found, we have all left blocks
$leftblocksn = explode(',', $blocksn);
$rightblocksn = array();
} else if($delimpos === 0) {
// ':' at start of string, we have all right blocks
$blocksn = substr($blocksn, 1);
$leftblocksn = array();
$rightblocksn = explode(',', $blocksn);
}
else {
// Both left and right blocks
$leftpartn = substr($blocksn, 0, $delimpos);
$rightpartn = substr($blocksn, $delimpos + 1);
$leftblocksn = explode(',', $leftpartn);
$rightblocksn = explode(',', $rightpartn);
}
//Now I have blocks separated
$leftblocks = array();
$rightblocks = array();
if ($leftblocksn) {
foreach($leftblocksn as $leftblockn) {
//Convert id to blockname
$leftblock = block_get_name_by_id(abs($leftblockn));
if ($leftblock) {
//Check it's visible
if($block = get_record("blocks","name",$leftblock,"visible","1")) {