-
Notifications
You must be signed in to change notification settings - Fork 452
/
Copy pathPKPTemplateManager.inc.php
2394 lines (2093 loc) · 76.8 KB
/
PKPTemplateManager.inc.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
/**
* @defgroup template Template
* Implements template management.
*/
/**
* @file classes/template/PKPTemplateManager.inc.php
*
* Copyright (c) 2014-2021 Simon Fraser University
* Copyright (c) 2000-2021 John Willinsky
* Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
*
* @class TemplateManager
* @ingroup template
*
* @brief Class for accessing the underlying template engine.
* Currently integrated with Smarty (from http://smarty.php.net/).
*/
use function PHP81_BC\strftime;
/* This definition is required by Smarty */
define('SMARTY_DIR', Core::getBaseDir() . '/lib/pkp/lib/vendor/smarty/smarty/libs/');
require_once('./lib/pkp/lib/vendor/smarty/smarty/libs/plugins/modifier.escape.php'); // Seems to be needed?
define('CACHEABILITY_NO_CACHE', 'no-cache');
define('CACHEABILITY_NO_STORE', 'no-store');
define('CACHEABILITY_PUBLIC', 'public');
define('CACHEABILITY_MUST_REVALIDATE', 'must-revalidate');
define('CACHEABILITY_PROXY_REVALIDATE', 'proxy-revalidate');
define('STYLE_SEQUENCE_CORE', 0);
define('STYLE_SEQUENCE_NORMAL', 10);
define('STYLE_SEQUENCE_LATE', 15);
define('STYLE_SEQUENCE_LAST', 20);
define('CSS_FILENAME_SUFFIX', 'css');
define('PAGE_WIDTH_NARROW', 'narrow');
define('PAGE_WIDTH_NORMAL', 'normal');
define('PAGE_WIDTH_WIDE', 'wide');
define('PAGE_WIDTH_FULL', 'full');
import('lib.pkp.classes.template.PKPTemplateResource');
class PKPTemplateManager extends Smarty {
/** @var array of URLs to stylesheets */
private $_styleSheets = [];
/** @var array of URLs to javascript files */
private $_javaScripts = [];
/** @var array of HTML head content to output */
private $_htmlHeaders = [];
/** @var array Key/value list of constants to expose in the JS interface */
private $_constants = [];
/** @var array Key/value list of locale keys to expose in the JS interface */
private $_localeKeys = [];
/** @var array Initial state data to be managed by the page's Vue.js component */
protected $_state = [];
/** @var string Type of cacheability (Cache-Control). */
private $_cacheability;
/** @var object The form builder vocabulary class. */
private $_fbv;
/** @var PKPRequest */
private $_request;
/** @var string[] */
private $_headers = [];
/** @var bool Track whether its backend page */
private $isBackendPage = false;
/**
* Constructor.
* Initialize template engine and assign basic template variables.
*/
function __construct() {
parent::__construct();
// Set up Smarty configuration
$baseDir = Core::getBaseDir();
$cachePath = CacheManager::getFileCachePath();
$this->compile_dir = $cachePath . DIRECTORY_SEPARATOR . 't_compile';
$this->config_dir = $cachePath . DIRECTORY_SEPARATOR . 't_config';
$this->cache_dir = $cachePath . DIRECTORY_SEPARATOR . 't_cache';
$this->_cacheability = CACHEABILITY_NO_STORE; // Safe default
// Register the template resources.
$this->registerResource('core', new PKPTemplateResource($coreTemplateDir = 'lib' . DIRECTORY_SEPARATOR . 'pkp' . DIRECTORY_SEPARATOR . 'templates'));
$this->registerResource('app', new PKPTemplateResource(['templates', $coreTemplateDir]));
$this->default_resource_type = 'app';
$this->error_reporting = E_ALL & ~E_NOTICE & ~E_WARNING;
}
/**
* Initialize the template manager.
* @param $request PKPRequest
*/
function initialize($request) {
assert(is_a($request, 'PKPRequest'));
$this->_request = $request;
$locale = AppLocale::getLocale();
$application = Application::get();
$router = $request->getRouter();
assert(is_a($router, 'PKPRouter'));
AppLocale::requireComponents(LOCALE_COMPONENT_APP_COMMON, LOCALE_COMPONENT_PKP_COMMON);
$currentContext = $request->getContext();
$this->assign([
'defaultCharset' => Config::getVar('i18n', 'client_charset'),
'baseUrl' => $request->getBaseUrl(),
'currentContext' => $currentContext,
'currentLocale' => $locale,
'currentLocaleLangDir' => AppLocale::getLocaleDirection($locale),
'applicationName' => __($application->getNameKey()),
]);
// Assign date and time format
if ($currentContext) {
$this->assign(array(
'dateFormatShort' => $currentContext->getLocalizedDateFormatShort(),
'dateFormatLong' => $currentContext->getLocalizedDateFormatLong(),
'datetimeFormatShort' => $currentContext->getLocalizedDateTimeFormatShort(),
'datetimeFormatLong' => $currentContext->getLocalizedDateTimeFormatLong(),
'timeFormat' => $currentContext->getLocalizedTimeFormat(),
'displayPageHeaderTitle' => $currentContext->getLocalizedData('name'),
'displayPageHeaderLogo' => $currentContext->getLocalizedData('pageHeaderLogoImage'),
'displayPageHeaderLogoAltText' => $currentContext->getLocalizedData('pageHeaderLogoImageAltText'),
));
} else {
$this->assign(array(
'dateFormatShort' => Config::getVar('general', 'date_format_short'),
'dateFormatLong' => Config::getVar('general', 'date_format_long'),
'datetimeFormatShort' => Config::getVar('general', 'datetime_format_short'),
'datetimeFormatLong' => Config::getVar('general', 'datetime_format_long'),
'timeFormat' => Config::getVar('general', 'time_format'),
));
}
if (Config::getVar('general', 'installed') && !$currentContext) {
$site = $request->getSite();
$this->assign(array(
'displayPageHeaderTitle' => $site->getLocalizedTitle(),
'displayPageHeaderLogo' => $site->getLocalizedData('pageHeaderTitleImage'),
));
}
// Assign meta tags
if ($currentContext) {
$favicon = $currentContext->getLocalizedFavicon();
if (!empty($favicon)) {
$publicFileManager = new PublicFileManager();
$faviconDir = $request->getBaseUrl() . '/' . $publicFileManager->getContextFilesPath($currentContext->getId());
$this->addHeader('favicon', '<link rel="icon" href="' . $faviconDir . '/' . $favicon['uploadName'] . '">', ['contexts' => ['frontend', 'backend']]);
}
}
if (Config::getVar('general', 'installed')) {
$activeTheme = null;
$contextOrSite = $currentContext ? $currentContext : $request->getSite();
$allThemes = PluginRegistry::getPlugins('themes');
foreach ($allThemes as $theme) {
if ($contextOrSite->getData('themePluginPath') === $theme->getDirName()) {
$activeTheme = $theme;
break;
}
}
$this->assign(['activeTheme' => $activeTheme]);
}
if (is_a($router, 'PKPPageRouter')) {
$this->assign([
'requestedPage' => $router->getRequestedPage($request),
'requestedOp' => $router->getRequestedOp($request),
]);
// A user-uploaded stylesheet
if ($currentContext) {
$contextStyleSheet = $currentContext->getData('styleSheet');
if ($contextStyleSheet) {
import('classes.file.PublicFileManager');
$publicFileManager = new PublicFileManager();
$this->addStyleSheet(
'contextStylesheet',
$request->getBaseUrl() . '/' . $publicFileManager->getContextFilesPath($currentContext->getId()) . '/' . $contextStyleSheet['uploadName'] . '?d=' . urlencode($contextStyleSheet['dateUploaded']),
['priority' => STYLE_SEQUENCE_LATE]
);
}
}
// Register recaptcha on relevant pages
if (Config::getVar('captcha', 'recaptcha') && Config::getVar('captcha', 'captcha_on_register')) {
$this->addJavaScript(
'recaptcha',
'https://www.recaptcha.net/recaptcha/api.js?hl=' . substr(AppLocale::getLocale(),0,2),
[
'contexts' => ['frontend-user-register', 'frontend-user-registerUser'],
]
);
}
// Register meta tags
if (Config::getVar('general', 'installed')) {
if (($request->getRequestedPage()=='' || $request->getRequestedPage() == 'index') && $currentContext && $currentContext->getLocalizedData('searchDescription')) {
$this->addHeader('searchDescription', '<meta name="description" content="' . $currentContext->getLocalizedData('searchDescription') . '">');
}
$this->addHeader(
'generator',
'<meta name="generator" content="' . __($application->getNameKey()) . ' ' . $application->getCurrentVersion()->getVersionString(false) . '">',
[
'contexts' => ['frontend', 'backend'],
]
);
if ($currentContext) {
$customHeaders = $currentContext->getLocalizedData('customHeaders');
if (!empty($customHeaders)) {
$this->addHeader('customHeaders', $customHeaders);
}
}
}
if ($currentContext && !$currentContext->getEnabled()) {
$this->addHeader(
'noindex',
'<meta name="robots" content="noindex,nofollow">',
[
'contexts' => ['frontend', 'backend'],
]
);
}
// Register Navigation Menus
import('classes.core.Services');
$nmService = Services::get('navigationMenu');
if (Config::getVar('general', 'installed')) {
\HookRegistry::register('LoadHandler', [$nmService, '_callbackHandleCustomNavigationMenuItems']);
}
}
// Register custom functions
$this->registerPlugin('modifier', 'trim', 'trim');
$this->registerPlugin('modifier', 'intval', 'intval');
$this->registerPlugin('modifier', 'json_encode', 'json_encode');
$this->registerPlugin('modifier', 'uniqid', 'uniqid');
$this->registerPlugin('modifier', 'substr', 'substr');
$this->registerPlugin('modifier', 'strstr', 'strstr');
$this->registerPlugin('modifier', 'substr_replace', 'substr_replace');
$this->registerPlugin('modifier', 'array_key_first', 'array_key_first');
$this->registerPlugin('modifier', 'array_values', 'array_values');
$this->registerPlugin('modifier', 'fatalError', 'fatalError');
$this->registerPlugin('modifier', 'translate', 'AppLocale::translate');
$this->registerPlugin('modifier', 'parse_url', 'parse_url');
$this->registerPlugin('modifier', 'parse_str', 'parse_str');
$this->registerPlugin('modifier', 'strtok', 'strtok');
$this->registerPlugin('modifier', 'array_pop', 'array_pop');
$this->registerPlugin('modifier', 'array_keys', 'array_keys');
$this->registerPlugin('modifier','strip_unsafe_html', 'PKPString::stripUnsafeHtml');
$this->registerPlugin('modifier','String_substr', 'PKPString::substr');
$this->registerPlugin('modifier','dateformatPHP2JQueryDatepicker', 'PKPString::dateformatPHP2JQueryDatepicker');
$this->registerPlugin('modifier','to_array', [$this, 'smartyToArray']);
$this->registerPlugin('modifier','compare', [$this, 'smartyCompare']);
$this->registerPlugin('modifier','concat', [$this, 'smartyConcat']);
$this->registerPlugin('modifier','strtotime', [$this, 'smartyStrtotime']);
$this->registerPlugin('modifier','explode', [$this, 'smartyExplode']);
$this->registerPlugin('modifier','escape', [$this, 'smartyEscape']);
$this->registerPlugin('function','csrf', [$this, 'smartyCSRF']);
$this->registerPlugin('function', 'translate', [$this, 'smartyTranslate']);
$this->registerPlugin('function','null_link_action', [$this, 'smartyNullLinkAction']);
$this->registerPlugin('function','help', [$this, 'smartyHelp']);
$this->registerPlugin('function','flush', [$this, 'smartyFlush']);
$this->registerPlugin('function','call_hook', [$this, 'smartyCallHook']);
$this->registerPlugin('function','html_options_translate', [$this, 'smartyHtmlOptionsTranslate']);
$this->registerPlugin('block','iterate', [$this, 'smartyIterate']);
$this->registerPlugin('function','page_links', [$this, 'smartyPageLinks']);
$this->registerPlugin('function','page_info', [$this, 'smartyPageInfo']);
$this->registerPlugin('function','pluck_files', [$this, 'smartyPluckFiles']);
$this->registerPlugin('function','locale_direction', [$this, 'smartyLocaleDirection']);
$this->registerPlugin('function','html_select_date_a11y', [$this, 'smartyHtmlSelectDateA11y']);
$this->registerPlugin('function','title', [$this, 'smartyTitle']);
$this->registerPlugin('function', 'url', [$this, 'smartyUrl']);
// load stylesheets/scripts/headers from a given context
$this->registerPlugin('function', 'load_stylesheet', [$this, 'smartyLoadStylesheet']);
$this->registerPlugin('function', 'load_script', [$this, 'smartyLoadScript']);
$this->registerPlugin('function', 'load_header', [$this, 'smartyLoadHeader']);
// load NavigationMenu Areas from context
$this->registerPlugin('function', 'load_menu', [$this, 'smartyLoadNavigationMenuArea']);
// Load form builder vocabulary
$fbv = $this->getFBV();
$this->registerPlugin('block', 'fbvFormSection', [$fbv, 'smartyFBVFormSection']);
$this->registerPlugin('block', 'fbvFormArea', [$fbv, 'smartyFBVFormArea']);
$this->registerPlugin('function', 'fbvFormButtons', [$fbv, 'smartyFBVFormButtons']);
$this->registerPlugin('function', 'fbvElement', [$fbv, 'smartyFBVElement']);
$this->registerPlugin('function', 'fieldLabel', [$fbv, 'smartyFieldLabel']);
$this->assign('fbvStyles', $fbv->getStyles());
// ajax load into a div or any element
$this->registerPlugin('function', 'load_url_in_el', [$this, 'smartyLoadUrlInEl']);
$this->registerPlugin('function', 'load_url_in_div', [$this, 'smartyLoadUrlInDiv']);
// Always pass these ListBuilder constants to the browser
// because a ListBuilder may be loaded in an ajax request
// and won't have an opportunity to pass its constants to
// the template manager. This is not a recommended practice,
// but these are the only constants from a controller that are
// required on the frontend. We can remove them once the
// ListBuilderHandler is no longer needed.
import('lib.pkp.classes.controllers.listbuilder.ListbuilderHandler');
$this->setConstants([
'LISTBUILDER_SOURCE_TYPE_TEXT',
'LISTBUILDER_SOURCE_TYPE_SELECT',
'LISTBUILDER_OPTGROUP_LABEL',
]);
/**
* Kludge to make sure no code that tries to connect to the
* database is executed (e.g., when loading installer pages).
*/
if (!defined('SESSION_DISABLE_INIT')) {
$this->assign([
'isUserLoggedIn' => Validation::isLoggedIn(),
'isUserLoggedInAs' => Validation::isLoggedInAs(),
'itemsPerPage' => Config::getVar('interface', 'items_per_page'),
'numPageLinks' => Config::getVar('interface', 'page_links'),
'siteTitle' => $request->getSite()->getLocalizedData('title'),
]);
$user = $request->getUser();
if ($user) {
$notificationDao = DAORegistry::getDAO('NotificationDAO');
$this->assign([
'currentUser' => $user,
// Assign the user name to be used in the sitenav
'loggedInUsername' => $user->getUserName(),
// Assign a count of unread tasks
'unreadNotificationCount' => $notificationDao->getNotificationCount(false, $user->getId(), null, NOTIFICATION_LEVEL_TASK),
]);
}
}
if (Config::getVar('general', 'installed')) {
// Respond to the sidebar hook
if ($currentContext) {
$this->assign('hasSidebar', !empty($currentContext->getData('sidebar')));
} else {
$this->assign('hasSidebar', !empty($request->getSite()->getData('sidebar')));
}
HookRegistry::register('Templates::Common::Sidebar', [$this, 'displaySidebar']);
// Clear the cache whenever the active theme is changed
HookRegistry::register('Context::edit', [$this, 'clearThemeTemplateCache']);
HookRegistry::register('Site::edit', [$this, 'clearThemeTemplateCache']);
}
}
/**
* Flag the page as cacheable (or not).
* @param $cacheability boolean optional
*/
function setCacheability($cacheability = CACHEABILITY_PUBLIC) {
$this->_cacheability = $cacheability;
}
/**
* Compile a LESS stylesheet
*
* @param $name string Unique name for this LESS stylesheet
* @param $lessFile string Path to the LESS file to compile
* @param $args array Optional arguments. Supports:
* 'baseUrl': Base URL to use when rewriting URLs in the LESS file.
* 'addLess': Array of additional LESS files to parse before compiling
* @return string Compiled CSS styles
*/
public function compileLess($name, $lessFile, $args = []) {
$less = new Less_Parser([
'relativeUrls' => false,
'compress' => true,
]);
$request = $this->_request;
// Allow plugins to intervene
HookRegistry::call('PageHandler::compileLess', [&$less, &$lessFile, &$args, $name, $request]);
// Read the stylesheet
$less->parseFile($lessFile);
// Add extra LESS files before compiling
if (isset($args['addLess']) && is_array($args['addLess'])) {
foreach ($args['addLess'] as $addless) {
$less->parseFile($addless);
}
}
// Add extra LESS variables before compiling
if (isset($args['addLessVariables'])) {
foreach ((array) $args['addLessVariables'] as $addlessVariables) {
$less->parse($addlessVariables);
}
}
// Set the @baseUrl variable
$baseUrl = !empty($args['baseUrl']) ? $args['baseUrl'] : $request->getBaseUrl(true);
$less->parse("@baseUrl: '$baseUrl';");
return $less->getCSS();
}
/**
* Save LESS styles to a cached file
*
* @param $path string File path to save the compiled styles
* @param styles string CSS styles compiled from the LESS
* @return bool success/failure
*/
public function cacheLess($path, $styles) {
if (file_put_contents($path, $styles) === false) {
error_log("Unable to write \"$path\".");
return false;
}
return true;
}
/**
* Retrieve the file path for a cached LESS file
*
* @param $name string Unique name for the LESS file
* @return $path string Path to the less file or false if not found
*/
public function getCachedLessFilePath($name) {
$cacheDirectory = CacheManager::getFileCachePath();
$context = $this->_request->getContext();
$contextId = is_a($context, 'Context') ? $context->getId() : 0;
return $cacheDirectory . DIRECTORY_SEPARATOR . $contextId . '-' . $name . '-' . crc32(Application::get()->getRequest()->getBaseUrl()) . '.css';
}
/**
* Register a stylesheet with the style handler
*
* @param $name string Unique name for the stylesheet
* @param $style string The stylesheet to be included. Should be a URL
* or, if the `inline` argument is included, stylesheet data to be output.
* @param $args array Key/value array defining display details
* `priority` int The order in which to print this stylesheet.
* Default: STYLE_SEQUENCE_NORMAL
* `contexts` string|array Where the stylesheet should be loaded.
* Default: array('frontend')
* `inline` bool Whether the $stylesheet value should be output directly as
* stylesheet data. Used to pass backend data to the scripts.
*/
function addStyleSheet($name, $style, $args = []) {
$args = array_merge(
[
'priority' => STYLE_SEQUENCE_NORMAL,
'contexts' => ['frontend'],
'inline' => false,
],
$args
);
$args['contexts'] = (array) $args['contexts'];
foreach($args['contexts'] as $context) {
$this->_styleSheets[$context][$args['priority']][$name] = [
'style' => $style,
'inline' => $args['inline'],
];
}
}
/**
* Register a script with the script handler
*
* @param $name string Unique name for the script
* @param $script string The script to be included. Should be a URL or, if
* the `inline` argument is included, script data to be output.
* @param $args array Key/value array defining display details
* `priority` int The order in which to print this script.
* Default: STYLE_SEQUENCE_NORMAL
* `contexts` string|array Where the script should be loaded.
* Default: array('frontend')
* `inline` bool Whether the $script value should be output directly as
* script data. Used to pass backend data to the scripts.
*/
function addJavaScript($name, $script, $args = []) {
$args = array_merge(
[
'priority' => STYLE_SEQUENCE_NORMAL,
'contexts' => ['frontend'],
'inline' => false,
'type' => 'text/javascript',
],
$args
);
$args['contexts'] = (array) $args['contexts'];
foreach($args['contexts'] as $context) {
$this->_javaScripts[$context][$args['priority']][$name] = [
'script' => $script,
'inline' => $args['inline'],
'type' => $args['type'],
];
}
}
/**
* Add a page-specific item to the <head>.
*
* @param $name string Unique name for the header
* @param $header string The header to be included.
* @param $args array Key/value array defining display details
* `priority` int The order in which to print this header.
* Default: STYLE_SEQUENCE_NORMAL
* `contexts` string|array Where the header should be loaded.
* Default: array('frontend')
*/
function addHeader($name, $header, $args = []) {
$args = array_merge(
[
'priority' => STYLE_SEQUENCE_NORMAL,
'contexts' => ['frontend'],
],
$args
);
$args['contexts'] = (array) $args['contexts'];
foreach($args['contexts'] as $context) {
$this->_htmlHeaders[$context][$args['priority']][$name] = [
'header' => $header,
];
}
}
/**
* Set constants to be exposed in JavaScript at pkp.const.<constant>
*
* @param array $names Array of constant names
*/
function setConstants($names) {
foreach ($names as $name) {
$this->_constants[$name] = constant($name);
}
}
/**
* Set locale keys to be exposed in JavaScript at pkp.localeKeys.<key>
*
* @param array $keys Array of locale keys
*/
function setLocaleKeys($keys) {
foreach ($keys as $key) {
if (!array_key_exists($key, $this->_localeKeys)) {
$this->_localeKeys[$key] = __($key);
}
}
}
/**
* Get a piece of the state data
*
* @param string $key
* @return mixed
*/
function getState($key) {
return array_key_exists($key, $this->_state)
? $this->_state[$key]
: null;
}
/**
* Set initial state data to be managed by the Vue.js component on this page
*
* @param array $data
*/
function setState($data) {
$this->_state = array_merge($this->_state, $data);
}
/**
* Register all files required by the core JavaScript library
*/
function registerJSLibrary() {
$baseUrl = $this->_request->getBaseUrl();
$localeChecks = [AppLocale::getLocale(), strtolower(substr(AppLocale::getLocale(), 0, 2))];
// Common $args array used for all our core JS files
$args = [
'priority' => STYLE_SEQUENCE_CORE,
'contexts' => 'backend',
];
// Load jQuery validate separately because it can not be linted
// properly by our build script
$this->addJavaScript(
'jqueryValidate',
$baseUrl . '/lib/pkp/js/lib/jquery/plugins/validate/jquery.validate.min.js',
$args
);
$jqvLocalePath = 'lib/pkp/js/lib/jquery/plugins/validate/localization/messages_';
foreach ($localeChecks as $localeCheck) {
if (file_exists($jqvLocalePath . $localeCheck .'.js')) {
$this->addJavaScript('jqueryValidateLocale', $baseUrl . '/' . $jqvLocalePath . $localeCheck . '.js', $args);
}
}
$this->addJavaScript(
'plUpload',
$baseUrl . '/lib/pkp/lib/vendor/moxiecode/plupload/js/plupload.full.min.js',
$args
);
$this->addJavaScript(
'jQueryPlUpload',
$baseUrl . '/lib/pkp/lib/vendor/moxiecode/plupload/js/jquery.ui.plupload/jquery.ui.plupload.js',
$args
);
$plLocalePath = 'lib/pkp/lib/vendor/moxiecode/plupload/js/i18n/';
foreach ($localeChecks as $localeCheck) {
if (file_exists($plLocalePath . $localeCheck . '.js')) {
$this->addJavaScript('plUploadLocale', $baseUrl . '/' . $plLocalePath . $localeCheck . '.js', $args);
}
}
// Load new component library bundle
$this->addJavaScript(
'pkpApp',
$baseUrl . '/js/build.js',
[
'priority' => STYLE_SEQUENCE_LATE,
'contexts' => ['backend']
]
);
// Load minified file if it exists
if (Config::getVar('general', 'enable_minified')) {
$this->addJavaScript(
'pkpLib',
$baseUrl . '/js/pkp.min.js',
[
'priority' => STYLE_SEQUENCE_CORE,
'contexts' => ['backend']
]
);
return;
}
// Otherwise retrieve and register all script files
$minifiedScripts = array_filter(array_map('trim', file('registry/minifiedScripts.txt')), function($s) {
return strlen($s) && $s[0] != '#'; // Exclude empty and commented (#) lines
});
foreach ($minifiedScripts as $key => $script) {
$this->addJavaScript( 'pkpLib' . $key, "$baseUrl/$script", $args);
}
}
/**
* Register JavaScript data used by the core JS library
*
* This function registers script data that is required by the core JS
* library. This data is queued after jQuery but before the pkp-lib
* framework, allowing dynamic data to be passed to the framework. It is
* intended to be used for passing constants and locale strings, but plugins
* may also take advantage of a hook to include data required by their own
* scripts, when integrating with the pkp-lib framework.
*/
function registerJSLibraryData() {
$context = $this->_request->getContext();
// Instantiate the namespace
$output = '$.pkp = $.pkp || {};';
// Load data intended for general use by the app
import('lib.pkp.classes.security.Role');
$app_data = [
'currentLocale' => AppLocale::getLocale(),
'primaryLocale' => AppLocale::getPrimaryLocale(),
'baseUrl' => $this->_request->getBaseUrl(),
'contextPath' => isset($context) ? $context->getPath() : '',
'apiBasePath' => '/api/v1',
'pathInfoEnabled' => Config::getVar('general', 'disable_path_info') ? false : true,
'restfulUrlsEnabled' => Config::getVar('general', 'restful_urls') ? true : false,
'tinyMceContentCSS' => $this->_request->getBaseUrl() . '/plugins/generic/tinymce/styles/content.css',
];
// Add an array of rtl languages (right-to-left)
if (Config::getVar('general', 'installed') && !defined('SESSION_DISABLE_INIT')) {
$allLocales = [];
if ($context) {
$allLocales = array_merge(
$context->getSupportedLocales(),
$context->getSupportedFormLocales(),
$context->getSupportedSubmissionLocales()
);
} else {
$allLocales = $this->_request->getSite()->getSupportedLocales();
}
$allLocales = array_unique($allLocales);
$rtlLocales = array_filter($allLocales, function($locale) {
return AppLocale::getLocaleDirection($locale) === 'rtl';
});
$app_data['rtlLocales'] = array_values($rtlLocales);
}
$output .= '$.pkp.app = ' . json_encode($app_data) . ';';
// Load exposed constants
$output .= '$.pkp.cons = ' . json_encode($this->_constants) . ';';
// Allow plugins to load data within their own namespace
$output .= '$.pkp.plugins = {};';
$this->addJavaScript(
'pkpLibData',
$output,
[
'priority' => STYLE_SEQUENCE_CORE,
'contexts' => 'backend',
'inline' => true,
]
);
}
/**
* Set up the template requirements for editorial backend pages
*/
function setupBackendPage() {
$this->isBackendPage = true;
$request = Application::get()->getRequest();
$dispatcher = $request->getDispatcher();
$router = $request->getRouter();
if (empty($this->get_template_vars('pageComponent'))) {
$this->assign('pageComponent', 'Page');
}
$this->setConstants([
'REALLY_BIG_NUMBER',
'UPLOAD_MAX_FILESIZE',
'WORKFLOW_STAGE_ID_PUBLISHED',
'WORKFLOW_STAGE_ID_SUBMISSION',
'WORKFLOW_STAGE_ID_INTERNAL_REVIEW',
'WORKFLOW_STAGE_ID_EXTERNAL_REVIEW',
'WORKFLOW_STAGE_ID_EDITING',
'WORKFLOW_STAGE_ID_PRODUCTION',
'INSERT_TAG_VARIABLE_TYPE_PLAIN_TEXT',
'INSERT_TAG_VARIABLE_TYPE_SAFE_HTML',
'ROLE_ID_MANAGER',
'ROLE_ID_SITE_ADMIN',
'ROLE_ID_AUTHOR',
'ROLE_ID_REVIEWER',
'ROLE_ID_ASSISTANT',
'ROLE_ID_READER',
'ROLE_ID_SUB_EDITOR',
'ROLE_ID_SUBSCRIPTION_MANAGER',
]);
// Common locale keys available in the browser for every page
$this->setLocaleKeys([
'common.cancel',
'common.clearSearch',
'common.close',
'common.commaListSeparator',
'common.confirm',
'common.delete',
'common.edit',
'common.editItem',
'common.error',
'common.filter',
'common.filterAdd',
'common.filterRemove',
'common.loading',
'common.no',
'common.noItemsFound',
'common.none',
'common.ok',
'common.orderUp',
'common.orderDown',
'common.pageNumber',
'common.pagination.goToPage',
'common.pagination.label',
'common.pagination.next',
'common.pagination.previous',
'common.remove',
'common.required',
'common.save',
'common.saving',
'common.search',
'common.selectWithName',
'common.unknownError',
'common.view',
'list.viewLess',
'list.viewMore',
'common.viewWithName',
'common.yes',
'form.dataHasChanged',
'form.errorA11y',
'form.errorGoTo',
'form.errorMany',
'form.errorOne',
'form.errors',
'form.multilingualLabel',
'form.multilingualProgress',
'form.saved',
'help.help',
'navigation.backTo',
'validator.required'
]);
// Register the jQuery script
$min = Config::getVar('general', 'enable_minified') ? '.min' : '';
$this->addJavaScript(
'jquery',
$request->getBaseUrl() . '/lib/pkp/lib/vendor/components/jquery/jquery' . $min . '.js',
[
'priority' => STYLE_SEQUENCE_CORE,
'contexts' => 'backend',
]
);
$this->addJavaScript(
'jqueryUI',
$request->getBaseUrl() . '/lib/pkp/lib/vendor/components/jqueryui/jquery-ui' . $min . '.js',
[
'priority' => STYLE_SEQUENCE_CORE,
'contexts' => 'backend',
]
);
// Register the pkp-lib JS library
$this->registerJSLibraryData();
$this->registerJSLibrary();
// FontAwesome - http://fontawesome.io/
$this->addStyleSheet(
'fontAwesome',
$request->getBaseUrl() . '/lib/pkp/styles/fontawesome/fontawesome.css',
[
'priority' => STYLE_SEQUENCE_CORE,
'contexts' => 'backend',
]
);
// Stylesheet compiled from Vue.js single-file components
$this->addStyleSheet(
'build',
$request->getBaseUrl() . '/styles/build.css',
[
'priority' => STYLE_SEQUENCE_CORE,
'contexts' => 'backend',
]
);
// The legacy stylesheet for the backend
$this->addStyleSheet(
'pkpLib',
$dispatcher->url($request, ROUTE_COMPONENT, null, 'page.PageHandler', 'css'),
[
'priority' => STYLE_SEQUENCE_CORE,
'contexts' => 'backend',
]
);
// If there's a locale-specific stylesheet, add it.
if (($localeStyleSheet = AppLocale::getLocaleStyleSheet(AppLocale::getLocale())) != null) {
$this->addStyleSheet(
'pkpLibLocale',
$request->getBaseUrl() . '/' . $localeStyleSheet,
[
'contexts' => ['backend'],
]
);
}
// Set up required state properties
$this->setState([
'menu' => [],
]);
/**
* Kludge to make sure no code that tries to connect to the
* database is executed (e.g., when loading installer pages).
*/
if (Config::getVar('general', 'installed') && !defined('SESSION_DISABLE_INIT')) {
if ($request->getUser()) {
// Get a count of unread tasks
$notificationDao = DAORegistry::getDAO('NotificationDAO'); /* @var $notificationDao NotificationDAO */
import('lib.pkp.controllers.grid.notifications.TaskNotificationsGridHandler');
$unreadTasksCount = (int) $notificationDao->getNotificationCount(false, $request->getUser()->getId(), null, NOTIFICATION_LEVEL_TASK);
// Get a URL to load the tasks grid
$tasksUrl = $request->getDispatcher()->url($request, ROUTE_COMPONENT, null, 'page.PageHandler', 'tasks');
// Load system notifications in SiteHandler.js
$notificationDao = DAORegistry::getDAO('NotificationDAO'); /* @var $notificationDao NotificationDAO */
$notificationsCount = count($notificationDao->getByUserId($request->getUser()->getId(), NOTIFICATION_LEVEL_TRIVIAL)->toArray());
// Load context switcher
$isAdmin = in_array(ROLE_ID_SITE_ADMIN, $this->get_template_vars('userRoles'));
if ($isAdmin) {
$args = [];
} else {
$args = ['userId' => $request->getUser()->getId()];
}
$availableContexts = Services::get('context')->getManySummary($args);
if ($request->getContext()) {
$availableContexts = array_filter($availableContexts, function($context) use ($request) {
return $context->id !== $request->getContext()->getId();
});
}
// Admins should switch to the same page on another context where possible
$requestedOp = $request->getRequestedOp() === 'index' ? null : $request->getRequestedOp();
$isSwitchable = $isAdmin && in_array($request->getRequestedPage(), [
'submissions',
'manageIssues',
'management',
'payment',
'stats',
]);
foreach ($availableContexts as $availableContext) {
// Site admins redirected to the same page. Everyone else to submission lists
if ($isSwitchable) {
$availableContext->url = $dispatcher->url($request, ROUTE_PAGE, $availableContext->urlPath, $request->getRequestedPage(), $requestedOp, $request->getRequestedArgs($request));
} else {
$availableContext->url = $dispatcher->url($request, ROUTE_PAGE, $availableContext->urlPath, 'submissions');
}
}
// Create main navigation menu
$userRoles = (array) $router->getHandler()->getAuthorizedContextObject(ASSOC_TYPE_USER_ROLES);
$menu = [];
if ($request->getContext()) {
if (count(array_intersect([ROLE_ID_MANAGER, ROLE_ID_SUB_EDITOR, ROLE_ID_ASSISTANT, ROLE_ID_REVIEWER, ROLE_ID_AUTHOR], $userRoles))) {
$menu['submissions'] = [
'name' => __('navigation.submissions'),
'url' => $router->url($request, null, 'submissions'),
'isCurrent' => $router->getRequestedPage($request) === 'submissions',
];
} elseif (count($userRoles) === 1 && in_array(ROLE_ID_READER, $userRoles)) {
AppLocale::requireComponents(LOCALE_COMPONENT_APP_AUTHOR);
$menu['submit'] = [
'name' => __('author.submit'),
'url' => $router->url($request, null, 'submission', 'wizard'),
'isCurrent' => $router->getRequestedPage($request) === 'submission',
];
}
if (in_array(ROLE_ID_MANAGER, $userRoles)) {
if ($request->getContext()->getData('enableAnnouncements')) {
$menu['announcements'] = [
'name' => __('announcement.announcements'),
'url' => $router->url($request, null, 'management', 'settings', 'announcements'),
'isCurrent' => $router->getRequestedPage($request) === 'management' && in_array('announcements', (array) $router->getRequestedArgs($request)),
];
}
$menu['settings'] = [
'name' => __('navigation.settings'),
'submenu' => [
'context' => [
'name' => __('context.context'),
'url' => $router->url($request, null, 'management', 'settings', 'context'),
'isCurrent' => $router->getRequestedPage($request) === 'management' && in_array('context', (array) $router->getRequestedArgs($request)),
],
'website' => [
'name' => __('manager.website'),
'url' => $router->url($request, null, 'management', 'settings', 'website'),
'isCurrent' => $router->getRequestedPage($request) === 'management' && in_array('website', (array) $router->getRequestedArgs($request)),
],
'workflow' => [
'name' => __('manager.workflow'),