forked from moodle-an-hochschulen/moodle-theme_boost_union
-
Notifications
You must be signed in to change notification settings - Fork 0
/
lib.php
664 lines (556 loc) · 29.2 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
<?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/>.
/**
* Theme Boost Union - Library
*
* @package theme_boost_union
* @copyright 2022 Alexander Bias, lern.link GmbH <alexander.bias@lernlink.de>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
// Constants which are use throughout this theme.
define('THEME_BOOST_UNION_SETTING_SELECT_YES', 'yes');
define('THEME_BOOST_UNION_SETTING_SELECT_NO', 'no');
define('THEME_BOOST_UNION_SETTING_STATICPAGELINKPOSITION_NONE', 'none');
define('THEME_BOOST_UNION_SETTING_STATICPAGELINKPOSITION_FOOTNOTE', 'footnote');
define('THEME_BOOST_UNION_SETTING_STATICPAGELINKPOSITION_FOOTER', 'footer');
define('THEME_BOOST_UNION_SETTING_STATICPAGELINKPOSITION_BOTH', 'both');
define('THEME_BOOST_UNION_SETTING_HIDENODESPRIMARYNAVIGATION_HOME', 'home');
define('THEME_BOOST_UNION_SETTING_HIDENODESPRIMARYNAVIGATION_MYHOME', 'myhome');
define('THEME_BOOST_UNION_SETTING_HIDENODESPRIMARYNAVIGATION_MYCOURSES', 'courses');
define('THEME_BOOST_UNION_SETTING_HIDENODESPRIMARYNAVIGATION_SITEADMIN', 'siteadminnode');
define('THEME_BOOST_UNION_SETTING_INFOBANNER_COUNT', 5);
define('THEME_BOOST_UNION_SETTING_INFOBANNERPAGES_MY', 'mydashboard');
define('THEME_BOOST_UNION_SETTING_INFOBANNERPAGES_MYCOURSES', 'mycourses');
define('THEME_BOOST_UNION_SETTING_INFOBANNERPAGES_SITEHOME', 'frontpage');
define('THEME_BOOST_UNION_SETTING_INFOBANNERPAGES_COURSE', 'course');
define('THEME_BOOST_UNION_SETTING_INFOBANNERPAGES_LOGIN', 'login');
define('THEME_BOOST_UNION_SETTING_INFOBANNERMODE_PERPETUAL', 'perp');
define('THEME_BOOST_UNION_SETTING_INFOBANNERMODE_TIMEBASED', 'time');
define('THEME_BOOST_UNION_SETTING_ADVERTISEMENTTILES_COUNT', 12);
define('THEME_BOOST_UNION_SETTING_ADVERTISEMENTTILES_COLUMN_COUNT', 4);
define('THEME_BOOST_UNION_SETTING_ADVERTISEMENTTILES_FRONTPAGEPOSITION_BEFORE', 1);
define('THEME_BOOST_UNION_SETTING_ADVERTISEMENTTILES_FRONTPAGEPOSITION_AFTER', 2);
define('THEME_BOOST_UNION_SETTING_SLIDES_COUNT', 6);
define('THEME_BOOST_UNION_SETTING_SLIDER_ANIMATIONTYPE_NONE', 0);
define('THEME_BOOST_UNION_SETTING_SLIDER_ANIMATIONTYPE_SLIDE', 1);
define('THEME_BOOST_UNION_SETTING_SLIDER_ANIMATIONTYPE_FADE', 2);
define('THEME_BOOST_UNION_SETTING_SLIDER_FRONTPAGEPOSITION_BEFOREBEFORE', 1);
define('THEME_BOOST_UNION_SETTING_SLIDER_FRONTPAGEPOSITION_BEFOREAFTER', 2);
define('THEME_BOOST_UNION_SETTING_SLIDER_FRONTPAGEPOSITION_AFTERBEFORE', 3);
define('THEME_BOOST_UNION_SETTING_SLIDER_FRONTPAGEPOSITION_AFTERAFTER', 4);
define('THEME_BOOST_UNION_SETTING_SLIDER_RIDE_ONPAGELOAD', 0);
define('THEME_BOOST_UNION_SETTING_SLIDER_RIDE_AFTERINTERACTION', 1);
define('THEME_BOOST_UNION_SETTING_SLIDER_RIDE_NEVER', 2);
define('THEME_BOOST_UNION_SETTING_SLIDER_LINKSOURCE_BOTH', 0);
define('THEME_BOOST_UNION_SETTING_SLIDER_LINKSOURCE_IMAGE', 1);
define('THEME_BOOST_UNION_SETTING_SLIDER_LINKSOURCE_TEXT', 2);
define('THEME_BOOST_UNION_SETTING_HEIGHT_100PX', '100px');
define('THEME_BOOST_UNION_SETTING_HEIGHT_150PX', '150px');
define('THEME_BOOST_UNION_SETTING_HEIGHT_200PX', '200px');
define('THEME_BOOST_UNION_SETTING_HEIGHT_250PX', '250px');
define('THEME_BOOST_UNION_SETTING_IMAGEPOSITION_CENTER_CENTER', 'center center');
define('THEME_BOOST_UNION_SETTING_IMAGEPOSITION_CENTER_TOP', 'center top');
define('THEME_BOOST_UNION_SETTING_IMAGEPOSITION_CENTER_BOTTOM', 'center bottom');
define('THEME_BOOST_UNION_SETTING_IMAGEPOSITION_LEFT_TOP', 'left top');
define('THEME_BOOST_UNION_SETTING_IMAGEPOSITION_LEFT_CENTER', 'left center');
define('THEME_BOOST_UNION_SETTING_IMAGEPOSITION_LEFT_BOTTOM', 'left bottom');
define('THEME_BOOST_UNION_SETTING_IMAGEPOSITION_RIGHT_TOP', 'right top');
define('THEME_BOOST_UNION_SETTING_IMAGEPOSITION_RIGHT_CENTER', 'right center');
define('THEME_BOOST_UNION_SETTING_IMAGEPOSITION_RIGHT_BOTTOM', 'right bottom');
define('THEME_BOOST_UNION_SETTING_COURSEIMAGELAYOUT_STACKEDDARK', 'stackeddark');
define('THEME_BOOST_UNION_SETTING_COURSEIMAGELAYOUT_STACKEDLIGHT', 'stackedlight');
define('THEME_BOOST_UNION_SETTING_COURSEIMAGELAYOUT_HEADINGABOVE', 'headingabove');
define('THEME_BOOST_UNION_SETTING_COMPLETIONINFOPOSITION_STARTOFLINE', 'startofline');
define('THEME_BOOST_UNION_SETTING_COMPLETIONINFOPOSITION_ENDOFLINE', 'endofline');
define('THEME_BOOST_UNION_SETTING_COMPLETIONINFOPOSITION_ICONCOLOR', 'iconcolor');
define('THEME_BOOST_UNION_SETTING_CONTENTSTYLE_NOCHANGE', 'nochange');
define('THEME_BOOST_UNION_SETTING_CONTENTSTYLE_LIGHT', 'light');
define('THEME_BOOST_UNION_SETTING_CONTENTSTYLE_LIGHTSHADOW', 'lightshadow');
define('THEME_BOOST_UNION_SETTING_CONTENTSTYLE_DARK', 'dark');
define('THEME_BOOST_UNION_SETTING_CONTENTSTYLE_DARKSHADOW', 'darkshadow');
define('THEME_BOOST_UNION_SETTING_LINKTARGET_SAMEWINDOW', 'same');
define('THEME_BOOST_UNION_SETTING_LINKTARGET_NEWTAB', 'new');
define('THEME_BOOST_UNION_SETTING_LOGINFORMPOS_CENTER', 'center');
define('THEME_BOOST_UNION_SETTING_LOGINFORMPOS_LEFT', 'left');
define('THEME_BOOST_UNION_SETTING_LOGINFORMPOS_RIGHT', 'right');
define('THEME_BOOST_UNION_SETTING_NAVBARCOLOR_LIGHT', 'light');
define('THEME_BOOST_UNION_SETTING_NAVBARCOLOR_DARK', 'dark');
define('THEME_BOOST_UNION_SETTING_NAVBARCOLOR_PRIMARYLIGHT', 'primarylight');
define('THEME_BOOST_UNION_SETTING_NAVBARCOLOR_PRIMARYDARK', 'primarydark');
define('THEME_BOOST_UNION_SETTING_OUTSIDEREGIONSPLACEMENT_NEXTMAINCONTENT', 'nextmaincontent');
define('THEME_BOOST_UNION_SETTING_OUTSIDEREGIONSPLACEMENT_NEARWINDOW', 'nearwindowedges');
define('THEME_BOOST_UNION_SETTING_OUTSIDEREGIONSWITH_FULLWIDTH', 'fullwidth');
define('THEME_BOOST_UNION_SETTING_OUTSIDEREGIONSWITH_COURSECONTENTWIDTH', 'coursecontentwidth');
define('THEME_BOOST_UNION_SETTING_OUTSIDEREGIONSWITH_HEROWIDTH', 'herowidth');
define('THEME_BOOST_UNION_SETTING_ENABLEFOOTER_ALL', 'enablefooterbuttonall');
define('THEME_BOOST_UNION_SETTING_ENABLEFOOTER_DESKTOP', 'enablefooterbuttondesktop');
define('THEME_BOOST_UNION_SETTING_ENABLEFOOTER_MOBILE', 'enablefooterbuttonmobile');
define('THEME_BOOST_UNION_SETTING_ENABLEFOOTER_NONE', 'enablefooterbuttonnone');
define('THEME_BOOST_UNION_SETTING_COURSEOVERVIEW_SHOWCOURSEIMAGES_CARD', 'card');
define('THEME_BOOST_UNION_SETTING_COURSEOVERVIEW_SHOWCOURSEIMAGES_LIST', 'list');
define('THEME_BOOST_UNION_SETTING_COURSEOVERVIEW_SHOWCOURSEIMAGES_SUMMARY', 'summary');
define('THEME_BOOST_UNION_SETTING_MARKLINKS_WHOLEPAGE', 'wholepage');
define('THEME_BOOST_UNION_SETTING_MARKLINKS_COURSEMAIN', 'coursemain');
define('THEME_BOOST_UNION_SETTING_EXTSCSSSOURCE_NONE', 0);
define('THEME_BOOST_UNION_SETTING_EXTSCSSSOURCE_DOWNLOAD', 1);
define('THEME_BOOST_UNION_SETTING_EXTSCSSSOURCE_GITHUB', 2);
/**
* Returns the main SCSS content.
*
* @param theme_config $theme The theme config object.
* @return string
*/
function theme_boost_union_get_main_scss_content($theme) {
global $CFG;
$scss = '';
// Require Boost Core library.
require_once($CFG->dirroot.'/theme/boost/lib.php');
// Include pre.scss from Boost Union.
$scss .= file_get_contents($CFG->dirroot . '/theme/boost_union/scss/boost_union/pre.scss');
// Get and include the main SCSS from Boost Core.
// This particularly covers the theme preset which is set in Boost Core and not Boost Union.
$scss .= theme_boost_get_main_scss_content(theme_config::load('boost'));
// Include post.scss from Boost Union.
$scss .= file_get_contents($CFG->dirroot . '/theme/boost_union/scss/boost_union/post.scss');
// Get and include the external Post SCSS.
// This should actually be in theme_boost_union_get_extra_scss().
// But as the *_get_extra_scss() functions work in practice, this is not possible as the external Raw SCSS code
// would end of _after_ the code from theme_boost_get_extra_scss() and not _before_.
// Thus, we sadly have to get and include the external Post SCSS here already.
$scss .= theme_boost_union_get_external_scss('post');
return $scss;
}
/**
* Get SCSS to prepend.
*
* @param theme_config $theme The theme config object.
* @return string
*/
function theme_boost_union_get_pre_scss($theme) {
global $CFG;
// Require local library.
require_once($CFG->dirroot . '/theme/boost_union/locallib.php');
$scss = '';
// Add SCSS constants for evaluating select setting values in SCSS code.
$scss .= '$boostunionsettingyes: '.THEME_BOOST_UNION_SETTING_SELECT_YES. ";\n";
$scss .= '$boostunionsettingno: '.THEME_BOOST_UNION_SETTING_SELECT_NO. ";\n";
$configurable = [
// Config key => [variableName, ...].
'brandcolor' => ['primary'],
'bootstrapcolorsuccess' => ['success'],
'bootstrapcolorinfo' => ['info'],
'bootstrapcolorwarning' => ['warning'],
'bootstrapcolordanger' => ['danger'],
];
// Prepend variables first.
foreach ($configurable as $configkey => $targets) {
$value = get_config('theme_boost_union', $configkey);
if (!($value)) {
continue;
}
array_map(function($target) use (&$scss, $value) {
$scss .= '$' . $target . ': ' . $value . ";\n";
}, (array) $targets);
}
// Overwrite Boost core SCSS variables which need units and thus couldn't be added to $configurable above.
// Set variables which are influenced by the coursecontentmaxwidth setting.
if (get_config('theme_boost_union', 'coursecontentmaxwidth')) {
$scss .= '$course-content-maxwidth: '.get_config('theme_boost_union', 'coursecontentmaxwidth').";\n";
}
// Set variables which are influenced by the mediumcontentmaxwidth setting.
if (get_config('theme_boost_union', 'mediumcontentmaxwidth')) {
$scss .= '$medium-content-maxwidth: '.get_config('theme_boost_union', 'mediumcontentmaxwidth').";\n";
}
// Set variables which are influenced by the h5pcontentmaxwidth setting.
if (get_config('theme_boost_union', 'h5pcontentmaxwidth')) {
$scss .= '$h5p-content-maxwidth: '.get_config('theme_boost_union', 'h5pcontentmaxwidth').";\n";
}
// Set variables which are influenced by the courseindexdrawerwidth setting.
if (get_config('theme_boost_union', 'courseindexdrawerwidth')) {
$scss .= '$drawer-width: '.get_config('theme_boost_union', 'courseindexdrawerwidth').";\n";
$scss .= '$drawer-left-width: '.get_config('theme_boost_union', 'courseindexdrawerwidth').";\n";
}
// Set variables which are influenced by the blockdrawerwidth setting.
if (get_config('theme_boost_union', 'blockdrawerwidth')) {
$scss .= '$drawer-right-width: '.get_config('theme_boost_union', 'blockdrawerwidth').";\n";
}
// Set variables which are influenced by the activityiconcolor* settings.
$purposes = [MOD_PURPOSE_ADMINISTRATION,
MOD_PURPOSE_ASSESSMENT,
MOD_PURPOSE_COLLABORATION,
MOD_PURPOSE_COMMUNICATION,
MOD_PURPOSE_CONTENT,
MOD_PURPOSE_INTERACTIVECONTENT,
MOD_PURPOSE_INTERFACE];
// Iterate over all purposes.
foreach ($purposes as $purpose) {
// Get color setting.
$activityiconcolor = get_config('theme_boost_union', 'activityiconcolor'.$purpose);
// If a color is set.
if (!empty($activityiconcolor)) {
// Set the activity-icon-*-bg variable which was replaced by the CSS filters in Moodle 4.4 but which is still part
// of the codebase.
$scss .= '$activity-icon-'.$purpose.'-bg: '.$activityiconcolor.";\n";
// Set the activity-icon-*-filter variable which holds the CSS filters for the activity icon colors now.
$solver = new \theme_boost_union\lib\hextocssfilter\solver($activityiconcolor);
$cssfilterresult = $solver->solve();
$scss .= '$activity-icon-'.$purpose.'-filter: '.$cssfilterresult['filter'].";\n";
}
}
// Set custom Boost Union SCSS variable: The block region outside left width.
$blockregionoutsideleftwidth = get_config('theme_boost_union', 'blockregionoutsideleftwidth');
// If the setting is not set.
if (!$blockregionoutsideleftwidth) {
// Set the variable to the default setting to make sure that the SCSS variable does not remain uninitialized.
$blockregionoutsideleftwidth = '300px';
}
$scss .= '$blockregionoutsideleftwidth: '.$blockregionoutsideleftwidth.";\n";
// Set custom Boost Union SCSS variable: The block region outside left width.
$blockregionoutsiderightwidth = get_config('theme_boost_union', 'blockregionoutsiderightwidth');
// If the setting is not set.
if (!$blockregionoutsiderightwidth) {
// Set the variable to the default setting to make sure that the SCSS variable does not remain uninitialized.
$blockregionoutsiderightwidth = '300px';
}
$scss .= '$blockregionoutsiderightwidth: '.$blockregionoutsiderightwidth.";\n";
// Add custom Boost Union SCSS variable as goody for designers: $themerev.
$scss .= '$themerev: '.$CFG->themerev.";\n";
// Get and include the external Pre SCSS.
$scss .= theme_boost_union_get_external_scss('pre');
// Prepend pre-scss.
if (get_config('theme_boost_union', 'scsspre')) {
$scss .= get_config('theme_boost_union', 'scsspre');
}
return $scss;
}
/**
* Inject additional SCSS.
*
* @param theme_config $theme The theme config object.
* @return string
*/
function theme_boost_union_get_extra_scss($theme) {
global $CFG;
// Require the necessary libraries.
require_once($CFG->dirroot . '/course/lib.php');
// Initialize extra SCSS.
$content = '';
// You might think that this extra SCSS function is only called for the activated theme.
// However, due to the way how the theme_*_get_extra_scss callback functions are searched and called within Boost child theme
// hierarchy Boost Union not only gets the extra SCSS from this function here but only from theme_boost_get_extra_scss as well.
//
// There, the CSS snippets for the background image and the login background images are added already to the SCSS codebase.
// Additionally, the custom SCSS from $theme->settings->scss (which hits the SCSS settings from theme_boost_union even though
// the code is within theme_boost) is already added to the SCSS codebase as well.
//
// We have to accept this fact here and must not copy the code from theme_boost_get_extra_scss into this function.
// Instead, we must only add additionally CSS code which is based on any Boost Union-only functionality.
// In contrast to Boost core, Boost Union should add the login page background to the body element as well.
// Thus, check if a login background image is set.
$loginbackgroundimagepresent = get_config('theme_boost_union', 'loginbackgroundimage');
if (!empty($loginbackgroundimagepresent)) {
// We first have to revert the background which is set to #page on the login page by Boost core already.
// Doing this, we also have to make the background of the #page element transparent on the login page.
$content .= 'body.pagelayout-login #page { ';
$content .= "background-image: none !important;";
$content .= "background-color: transparent !important;";
$content .= '}';
// Afterwards, we set the background-size attribute for the body element again.
$content .= 'body.pagelayout-login { ';
$content .= "background-size: cover;";
$content .= '}';
// Finally, we add all possible background image urls which will be picked based on the (random) loginpageimage class.
$content .= theme_boost_union_get_loginbackgroundimage_scss();
}
// Boost core has the behaviour that the normal background image is not shown on the login page, only the login background image
// is shown on the login page.
// This is fine, but it is done improperly as the normal background image is still there on the login page and just overlaid
// with a grey color in the #page element. This can result in flickering during the page load.
// We try to avoid this by removing the background image from the body tag if no login background image is set.
if (empty($loginbackgroundimagepresent)) {
$content .= 'body.pagelayout-login { ';
$content .= "background-image: none !important;";
$content .= '}';
}
// If a login background image is present, we set its background image position.
if (!empty($loginbackgroundimagepresent)) {
$content .= 'body.pagelayout-login { ';
$content .= "background-position: ".get_config('theme_boost_union', 'loginbackgroundimageposition').";";
$content .= '}';
}
// And we set the normal background image position in any case.
$content .= 'body { ';
$content .= "background-position: ".get_config('theme_boost_union', 'backgroundimageposition').";";
// Lastly, we make sure that the (normal and login) background image is fixed and not repeated. Just to be sure.
$content .= "background-repeat: no-repeat;";
$content .= "background-attachment: fixed;";
$content .= '}';
// Note: Boost Union is also capable of overriding the background image in its flavours.
// In contrast to the other flavour assets like the favicon overriding, this isn't done here in place as this function
// is composing Moodle core CSS which has to remain flavour-independent.
// Instead, the flavour is overriding the background image later in flavours/styles.php.
// For the rest of this function, we add SCSS snippets to the SCSS stack based on enabled admin settings.
// This is done here as it is quite easy to do. As an alternative, it could also been done in post.scss by using
// SCSS variables with @if conditions and SCSS variables. However, we preferred to do it here in a single place.
// Setting: Activity icon purpose.
$content .= theme_boost_union_get_scss_for_activity_icon_purpose($theme);
// Setting: Mark external links.
$content .= theme_boost_union_get_scss_to_mark_external_links($theme);
// Setting: Mark mailto links.
$content .= theme_boost_union_get_scss_to_mark_mailto_links($theme);
// Setting: Mark broken links.
$content .= theme_boost_union_get_scss_to_mark_broken_links($theme);
// Setting: Course overview block.
$content .= theme_boost_union_get_scss_courseoverview_block($theme);
// Setting: Login order.
$content .= theme_boost_union_get_scss_login_order($theme);
return $content;
}
/**
* Get compiled css.
*
* @return string compiled css
*/
function theme_boost_union_get_precompiled_css() {
global $CFG;
// Get the fallback CSS file from Boost Core as long as Boost Union does not use a fallback file of its own.
return file_get_contents($CFG->dirroot . '/theme/boost/style/moodle.css');
}
/**
* Serves any files associated with the theme settings.
*
* @param stdClass $course
* @param stdClass $cm
* @param context $context
* @param string $filearea
* @param array $args
* @param bool $forcedownload
* @param array $options
* @return bool
*/
function theme_boost_union_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options = []) {
global $CFG;
// Serve the (general) logo files or favicon file from the theme settings.
// This code is copied and modified from core_admin_pluginfile() in admin/lib.php.
if (in_array($filearea, ['logo', 'logocompact', 'favicon'])) {
$size = array_shift($args); // The path hides the size.
$itemid = clean_param(array_shift($args), PARAM_INT);
$filename = clean_param(array_shift($args), PARAM_FILE);
$themerev = theme_get_revision();
if ($themerev <= 0) {
// Normalise to 0 as -1 doesn't place well with paths.
$themerev = 0;
}
// Extract the requested width and height.
$maxwidth = 0;
$maxheight = 0;
if (preg_match('/^\d+x\d+$/', $size)) {
list($maxwidth, $maxheight) = explode('x', $size);
$maxwidth = clean_param($maxwidth, PARAM_INT);
$maxheight = clean_param($maxheight, PARAM_INT);
}
$lifetime = 0;
if ($itemid > 0 && $themerev == $itemid) {
// The itemid is $CFG->themerev, when 0 or less no caching. Also no caching when they don't match.
$lifetime = DAYSECS * 60;
}
// Anyone, including guests and non-logged in users, can view the logos.
$options = ['cacheability' => 'public'];
// Check if we've got a cached file to return. When lifetime is 0 then we don't want to cached one.
$candidate = $CFG->localcachedir . "/theme_boost_union/$themerev/$filearea/{$maxwidth}x{$maxheight}/$filename";
if (file_exists($candidate) && $lifetime > 0) {
send_file($candidate, $filename, $lifetime, 0, false, false, '', false, $options);
}
// Find the original file.
$fs = get_file_storage();
$filepath = "/{$context->id}/theme_boost_union/{$filearea}/0/{$filename}";
if (!$file = $fs->get_file_by_hash(sha1($filepath))) {
send_file_not_found();
}
// Check whether width/height are specified, and we can resize the image (some types such as ICO cannot be resized).
if (($maxwidth === 0 && $maxheight === 0) ||
!$filedata = $file->resize_image($maxwidth, $maxheight)) {
if ($lifetime) {
file_safe_save_content($file->get_content(), $candidate);
}
send_stored_file($file, $lifetime, 0, false, $options);
}
// If we don't want to cached the file, serve now and quit.
if (!$lifetime) {
send_content_uncached($filedata, $filename);
}
// Save, serve and quit.
file_safe_save_content($filedata, $candidate);
send_file($candidate, $filename, $lifetime, 0, false, false, '', false, $options);
// Serve all other (general) image and resource files from the theme settings.
// This code is copied and modified from theme_boost_pluginfile() in theme/boost/lib.php.
} else if ($context->contextlevel == CONTEXT_SYSTEM && ($filearea === 'backgroundimage' ||
$filearea === 'loginbackgroundimage' || $filearea === 'additionalresources' ||
$filearea === 'customfonts' || $filearea === 'courseheaderimagefallback' ||
$filearea === 'touchiconsios' ||
preg_match("/tilebackgroundimage[2-9]|1[0-2]?/", $filearea) ||
preg_match("/slidebackgroundimage[2-9]|1[0-2]?/", $filearea))) {
$theme = theme_config::load('boost_union');
// By default, theme files must be cache-able by both browsers and proxies.
if (!array_key_exists('cacheability', $options)) {
$options['cacheability'] = 'public';
}
return $theme->setting_file_serve($filearea, $args, $forcedownload, $options);
// Serve the files from the theme flavours.
} else if ($filearea === 'flavours_look_logocompact' || $filearea === 'flavours_look_logo' ||
$filearea === 'flavours_look_favicon' || $filearea === 'flavours_look_backgroundimage') {
// Flavour files should not be top secret.
// Even if they apply to particular contexts or cohorts, we do not do any hard checks if a user should be
// allowed to request a file.
// We just make sure that the forcelogin setting is respected. This is ok as there isn't any possibility
// to apply a flavour to the login page / for non-logged-in users at the moment.
if ($CFG->forcelogin) {
require_login();
}
// Get file storage.
$fs = get_file_storage();
// Get the file from the filestorage.
$filename = clean_param(array_pop($args), PARAM_FILE);
array_pop($args); // This is the themerev number in the $args array which is used for browser caching, here we ignore it.
$itemid = clean_param(array_pop($args), PARAM_INT);
if ((!$file = $fs->get_file($context->id, 'theme_boost_union', $filearea, $itemid, '/', $filename)) ||
$file->is_directory()) {
send_file_not_found();
}
// Unlock session during file serving.
\core\session\manager::write_close();
// Send stored file (and cache it for 90 days, similar to other static assets within Moodle).
send_stored_file($file, DAYSECS * 90, 0, $forcedownload, $options);
// Serve the files from the smart menu card images.
} else if ($filearea === 'smartmenus_itemimage' && $context->contextlevel === CONTEXT_SYSTEM) {
// Get file storage.
$fs = get_file_storage();
// Get the file from the filestorage.
$file = $fs->get_file($context->id, 'theme_boost_union', $filearea, $args[0], '/', $args[1]);
if (!$file) {
send_file_not_found();
}
// Send stored file (and cache it for 90 days, similar to other static assets within Moodle).
send_stored_file($file, DAYSECS * 90, 0, $forcedownload, $options);
} else {
send_file_not_found();
}
}
/**
* Callback to add head elements (for releases up to Moodle 4.3).
*
* @return string
*/
function theme_boost_union_before_standard_html_head() {
global $CFG;
// Require local library.
require_once($CFG->dirroot.'/theme/boost_union/locallib.php');
// Call and return callback implementation.
return theme_boost_union_callbackimpl_before_standard_html();
}
/**
* Fetches the list of icons and creates an icon suggestion list to be sent to a fragment.
*
* @param array $args An array of arguments.
* @return string The rendered HTML of the icon suggestion list.
*/
function theme_boost_union_output_fragment_icons_list($args) {
global $OUTPUT, $PAGE;
// Proceed only if a context was given as argument.
if ($args['context']) {
// Initialize rendered icon list.
$icons = [];
// Load the theme config.
$theme = \theme_config::load($PAGE->theme->name);
// Get the FA system.
$faiconsystem = \core\output\icon_system_fontawesome::instance($theme->get_icon_system());
// Get the icon list.
$iconlist = $faiconsystem->get_core_icon_map();
// Add an empty element to the beginning of the icon list.
array_unshift($iconlist, '');
// Iterate over the icons.
foreach ($iconlist as $iconkey => $icontxt) {
// Split the component from the icon key.
$icon = explode(':', $iconkey);
// Pick the icon key.
$iconstr = isset($icon[1]) ? $icon[1] : 'moodle';
// Pick the component.
$component = isset($icon[0]) ? $icon[0] : '';
// Render the pix icon.
$icon = new \pix_icon($iconstr, "", $component);
$icons[] = [
'icon' => $faiconsystem->render_pix_icon($OUTPUT, $icon),
'value' => $iconkey,
'label' => $icontxt,
];
}
// Return the rendered icon list.
return $OUTPUT->render_from_template('theme_boost_union/fontawesome-iconpicker-popover', ['options' => $icons]);
}
}
/**
* Define preferences which may be set via the core_user_set_user_preferences external function.
*
* @uses core_user::is_current_user
*
* @return array[]
*/
function theme_boost_union_user_preferences(): array {
// Build preferences array.
$preferences = [];
for ($i = 1; $i <= THEME_BOOST_UNION_SETTING_INFOBANNER_COUNT; $i++) {
$preferences['theme_boost_union_infobanner'.$i.'_dismissed'] = [
'type' => PARAM_INT,
'null' => NULL_NOT_ALLOWED,
'default' => 0,
'choices' => [0, 1],
'permissioncallback' => [core_user::class, 'is_current_user'],
];
}
return $preferences;
}
/**
* Returns the html for the starred courses popover menu.
*
* @return string
*/
function theme_boost_union_render_navbar_output() {
global $CFG;
// Require local library.
require_once($CFG->dirroot . '/theme/boost_union/locallib.php');
// Initialize the navbar content.
$content = '';
// Setting: Show starred courses popover in the navbar.
$content .= theme_boost_union_get_navbar_starredcoursespopover();
// Return.
return $content;
}
/**
* Triggered as soon as practical on every moodle bootstrap after config has been loaded.
*
* We use this callback function to manipulate / set settings which would normally be manipulated / set through
* /config.php, but we do not want to urge the admin to add stuff to /config.php when installing Boost Union.
*/
function theme_boost_union_after_config() {
global $CFG;
// Require own local library.
require_once($CFG->dirroot.'/theme/boost_union/locallib.php');
// If this is not called by a CLI script or an AJAX script.
if (!CLI_SCRIPT && !AJAX_SCRIPT) {
// Manipulate Moodle core hooks.
theme_boost_union_manipulate_hooks();
}
}