-
Notifications
You must be signed in to change notification settings - Fork 19
/
lib-common.php
8271 lines (7164 loc) · 296 KB
/
lib-common.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
/* Reminder: always indent with 4 spaces (no tabs). */
// +---------------------------------------------------------------------------+
// | Geeklog 2.2 |
// +---------------------------------------------------------------------------+
// | lib-common.php |
// | |
// | Geeklog common library. |
// +---------------------------------------------------------------------------+
// | Copyright (C) 2000-2017 by the following authors: |
// | |
// | Authors: Tony Bibbs - tony AT tonybibbs DOT com |
// | Mark Limburg - mlimburg AT users DOT sourceforge DOT net |
// | Jason Whittenburg - jwhitten AT securitygeeks DOT com |
// | Dirk Haun - dirk AT haun-online DOT de |
// | Vincent Furia - vinny01 AT users DOT sourceforge DOT net |
// +---------------------------------------------------------------------------+
// | |
// | This program 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 2 |
// | of the License, or (at your option) any later version. |
// | |
// | This program 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 this program; if not, write to the Free Software Foundation, |
// | Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
// | |
// +---------------------------------------------------------------------------+
// Prevent PHP from reporting uninitialized variables
error_reporting(E_ERROR | E_WARNING | E_PARSE | E_CORE_ERROR | E_COMPILE_ERROR | E_USER_ERROR | E_RECOVERABLE_ERROR);
/**
* This is the common library for Geeklog. Through our code, you will see
* functions with the COM_ prefix (e.g. COM_siteHeader()). Any such functions
* can be found in this file.
* --- You don't need to modify anything in this file! ---
* WARNING: put any custom hacks in lib-custom.php and not in here. This file is
* modified frequently by the Geeklog development team. If you put your hacks in
* lib-custom.php you will find upgrading much easier.
*/
/**
* Prevent getting any surprise values. But we should really stop
* using $_REQUEST altogether.
*/
$_REQUEST = array_merge($_GET, $_POST);
/**
* Here, we shall establish an error handler. This will mean that whenever a
* php level error is encountered, our own code handles it. This will hopefuly
* go someway towards preventing nasties like path exposures from ever being
* possible. That is, unless someone has overridden our error handler with one
* with a path exposure issue...
* Must make sure that the function hasn't been disabled before calling it.
*/
if (is_callable('set_error_handler')) {
/* Tell the error handler to use the default error reporting options.
* You may like to change this to use it in more/less cases, if so,
* just use the syntax used in the call to error_reporting() above.
*/
$defaultErrorHandler = set_error_handler('COM_handleError', error_reporting());
}
if (is_callable('set_exception_handler')) {
set_exception_handler('COM_handleException');
}
/**
* Configuration Include:
* You do NOT need to modify anything here any more!
*/
require_once __DIR__ . '/siteconfig.php';
if (COM_isDeveloperMode() &&
isset($_CONF['developer_mode_php'], $_CONF['developer_mode_php']['error_reporting'])) {
error_reporting((int) $_CONF['developer_mode_php']['error_reporting']);
}
/**
* Turn this on to get various debug messages from the code in this library
*
* @global bool $_COM_VERBOSE
*/
$_COM_VERBOSE = COM_isEnableDeveloperModeLog('common');
COM_checkInstalled();
// Register autoloader
require_once $_CONF['path_system'] . 'classes/Autoload.php';
Geeklog\Autoload::initialize();
// Load configuration
$config = config::get_instance();
$config->set_configfile($_CONF['path'] . 'db-config.php');
$config->load_baseconfig();
$config->initConfig();
$_CONF = $config->get_config('Core');
// Get features that has ft_name like 'config%'
$_CONF_FT = $config->_get_config_features();
// Load Cache class
Geeklog\Cache::init();
// Load in Geeklog Variables Table
/**
* @global $_VARS array
*/
$_VARS = array();
$result = DB_query("SELECT * FROM {$_TABLES['vars']}");
while ($row = DB_fetchArray($result)) {
$_VARS[$row['name']] = $row['value'];
}
// Before we do anything else, check to ensure site is enabled
if (isset($_CONF['site_enabled']) && !$_CONF['site_enabled']) {
if (empty($_CONF['site_disabled_msg'])) {
header("HTTP/1.1 503 Service Unavailable");
header("Status: 503 Service Unavailable");
header('Content-Type: text/plain; charset=' . COM_getCharset());
echo $_CONF['site_name'] . ' is temporarily down. Please check back soon.' . LB;
} else {
// if the msg starts with http: assume it's a URL we should redirect to
if (preg_match("/^(https?):/", $_CONF['site_disabled_msg'])) {
COM_redirect($_CONF['site_disabled_msg']);
} else {
header("HTTP/1.1 503 Service Unavailable");
header("Status: 503 Service Unavailable");
header('Content-Type: text/html; charset=' . COM_getCharset());
echo $_CONF['site_disabled_msg'] . LB;
}
}
exit;
}
// this file can't be used on its own - redirect to index.php
if (stripos($_SERVER['PHP_SELF'], basename(__FILE__)) !== false) {
COM_redirect($_CONF['site_url'] . '/index.php');
}
// +---------------------------------------------------------------------------+
// | Library Includes: You shouldn't have to touch anything below here |
// +---------------------------------------------------------------------------+
// Set the web server's timezone
TimeZoneConfig::setSystemTimeZone();
// Include multibyte functions
require_once $_CONF['path_system'] . 'lib-mbyte.php';
/**
* Include plugin class.
* This is a poorly implemented class that was not very well thought out.
* Still very necessary
*
* @global $_PLUGINS array of the names of active plugins
*/
require_once $_CONF['path_system'] . 'lib-plugins.php';
/**
* Include page time -- used to time how fast each page was created
*
* @global $_PAGE_TIMER timerobject
*/
$_PAGE_TIMER = new timerobject();
$_PAGE_TIMER->startTimer();
/**
* This provides optional URL rewriting functionality.
*
* @global $_URL Url
*/
$_URL = new Url($_CONF['url_rewrite'], $_CONF['url_routing']);
/**
* Include Device Detect class
*
* @global $_DEVICE Device
*/
$_DEVICE = new Device();
// This is the security library used for application security
require_once $_CONF['path_system'] . 'lib-security.php';
// This is the syndication library used to offer (RSS) feeds.
require_once $_CONF['path_system'] . 'lib-syndication.php';
// This is the topic library used to manage topics.
require_once $_CONF['path_system'] . 'lib-topic.php';
// This is the block library used to manage blocks.
require_once $_CONF['path_system'] . 'lib-block.php';
/**
* These variables were taken out of the configuration and placed here since they
* are necessary to change with the themes, not whole sites. They should now be
* overridden by setting them to a different value than here in the theme's
* function.php or in lib-custom.php. Therefore they are NOT TO BE CHANGED HERE.
*/
$_CONF['left_blocks_in_footer'] = 0; // use left blocks in header
$_CONF['right_blocks_in_footer'] = 1; // use right blocks in footer
$_CONF['theme_oauth_icons'] = 0; // 0 - Use Geeklogs OAuth icons. 1 - Use theme OAuth icons
/**
* This is the custom library.
* It is the sandbox for every Geeklog Admin to play in.
* The lib-custom.php as shipped will never contain required code,
* so it's safe to always use your own copy.
* This should hold all custom hacks to make upgrading easier.
*/
if (file_exists($_CONF['path_system'] . 'lib-custom.php')) {
require_once $_CONF['path_system'] . 'lib-custom.php';
}
// Session management library
require_once $_CONF['path_system'] . 'lib-sessions.php';
SESS_sessionCheck(); // Load user data
TimeZoneConfig::setUserTimeZone();
if (COM_isAnonUser()) {
$_USER['advanced_editor'] = $_CONF['advanced_editor'];
}
// Retrieve new topic if found
$topic = '';
if ($_CONF['url_rewrite']) {
COM_setArgNames(array(TOPIC_PLACEHOLDER, 'topic'));
if (strcasecmp(COM_getArgument(TOPIC_PLACEHOLDER), 'topic') === 0) {
$topic = COM_getArgument('topic');
}
} else {
$topic = \Geeklog\Input::fGet('topic', \Geeklog\Input::fPost('topic', ''));
}
if ($topic === '-') {
$topic = '';
}
// See if user has access to view topic
if ($topic != '') {
$test_topic = DB_getItem($_TABLES['topics'], 'tid', "tid = '$topic' " . COM_getPermSQL('AND'));
if (strtolower($topic) !== strtolower($test_topic)) {
$topic = '';
} else { // Make it equal to the db version since case maybe different
$topic = $test_topic;
}
}
// Set theme
$useTheme = '';
if (isset($_POST['usetheme'])) {
$useTheme = COM_sanitizeFilename($_POST['usetheme'], true);
}
if (!empty($useTheme) && is_dir($_CONF['path_themes'] . $useTheme)) {
$_CONF['theme'] = $useTheme;
$_CONF['path_layout'] = $_CONF['path_themes'] . $_CONF['theme'] . '/';
$_CONF['layout_url'] = $_CONF['site_url'] . '/layout/' . $_CONF['theme'];
} elseif ($_CONF['allow_user_themes'] == 1) {
if (isset($_COOKIE[$_CONF['cookie_theme']]) && empty($_USER['theme'])) {
$theme = COM_sanitizeFilename($_COOKIE[$_CONF['cookie_theme']], true);
if (is_dir($_CONF['path_themes'] . $theme)) {
$_USER['theme'] = $theme;
}
}
if (!empty($_USER['theme'])) {
if (is_dir($_CONF['path_themes'] . $_USER['theme'])) {
$_CONF['theme'] = $_USER['theme'];
$_CONF['path_layout'] = $_CONF['path_themes'] . $_CONF['theme'] . '/';
$_CONF['layout_url'] = $_CONF['site_url'] . '/layout/' . $_CONF['theme'];
} else {
$_USER['theme'] = $_CONF['theme'];
}
}
}
// Fix a wrong theme name, since "professional" and "professional_css" themes are deprecated as of Geeklog 2.1.2
if (($_CONF['theme'] === 'professional') || ($_CONF['theme'] === 'professional_css')) {
$_CONF['theme'] = $_USER['theme'] = 'denim';
$_CONF['path_layout'] = $_CONF['path_themes'] . $_CONF['theme'] . '/';
$_CONF['layout_url'] = $_CONF['site_url'] . '/layout/' . $_CONF['theme'];
if (!headers_sent()) {
@setcookie(
$_CONF['cookie_theme'], 'denim', time() + 31536000, $_CONF['cookie_path'],
$_CONF['cookiedomain'], $_CONF['cookiesecure']
);
}
}
/**
* This provides the ability to set css and javascript.
*
* @global $_SCRIPTS Scripts
*/
//$_SCRIPTS = new Scripts();
// Include theme functions file which may/may not do anything
if (file_exists($_CONF['path_layout'] . 'functions.php')) {
require_once $_CONF['path_layout'] . 'functions.php';
}
// Get the configuration values from the theme
$_CONF['theme_default'] = ''; // Default is none
$_CONF['path_layout_default'] = ''; // Default is none
$_CONF['supported_version_theme'] = '1.8.1'; // if the themes supported version of the theme engine not found assume lowest version
$_CONF['theme_etag'] = false;
$_CONF['theme_plugins'] = ''; // Default is none - CANNOT be a child theme
$_CONF['theme_options'] = array(); // Default is empty array
$func = "theme_config_" . $_CONF['theme'];
if (function_exists($func)) {
$theme_config = $func();
$_CONF['doctype'] = $theme_config['doctype'];
$_IMAGE_TYPE = $theme_config['image_type'];
if (isset($theme_config['theme_default'])) {
$_CONF['theme_default'] = $theme_config['theme_default'];
$_CONF['path_layout_default'] = $_CONF['path_themes'] . $_CONF['theme_default'] . '/';
}
$_CONF['supported_version_theme'] = (!isset($theme_config['supported_version_theme']))
? $_CONF['supported_version_theme'] : $theme_config['supported_version_theme'];
$_CONF['theme_etag'] = (!isset($theme_config['etag']))
? $_CONF['theme_etag'] : $theme_config['etag'];
if ($_CONF['theme_etag'] && !file_exists($_CONF['path_layout'] . 'style.css.php')) {
// See if style.css.php file exists that is required
$_CONF['theme_etag'] = false;
}
if (isset($theme_config['theme_plugins'])) {
// EXPERIMENTAL
$_CONF['theme_plugins'] = $theme_config['theme_plugins'];
}
if (isset($theme_config['options']) && is_array($theme_config['options'])) {
$_CONF['theme_options'] = $theme_config['options'];
}
}
/**
* This provides the ability to set css and javascript.
*
* @global $_SCRIPTS Geeklog\Resource
*/
$_SCRIPTS = new Geeklog\Resource($_CONF);
/**
* themes can specify the default image type
* fall back to 'gif' if they don't
*
* @global $_IMAGE_TYPE string
*/
if (empty($_IMAGE_TYPE)) {
$_IMAGE_TYPE = 'gif';
}
// Ensure XHTML constant is defined to avoid problems elsewhere
if (!defined('XHTML')) {
switch ($_CONF['doctype']) {
case 'xhtml10transitional':
case 'xhtml10strict':
case 'xhtml5':
define('XHTML', ' /');
break;
default:
define('XHTML', '');
break;
}
}
// Set template class default template variables option
/**
* @global $TEMPLATE_OPTIONS array
*/
$TEMPLATE_OPTIONS = array(
'path_cache' => $_CONF['path_data'] . 'layout_cache/', // location of template cache
'path_prefixes' => array( // used to strip directories off file names. Order is important here.
$_CONF['path_themes'], // this is not path_layout. When stripping directories, you want files in different themes to end up in different directories.
$_CONF['path'],
'/' // this entry must always exist and must always be last
),
'incl_phpself_header' => true, // set this to true if your template cache exists within your web server's docroot.
'cache_by_language' => true, // create cache directories for each language. Takes extra space but moves all $LANG variable text directly into the cached file
'cache_for_mobile' => $_CONF['cache_mobile'], // create cache directories for mobile devices. Non mobile devices uses regular directory. If disabled mobile uses regular cache files. Takes extra space
'default_vars' => array( // list of vars found in all templates.
'xhtml' => XHTML,
'site_url' => $_CONF['site_url'],
'site_admin_url' => $_CONF['site_admin_url'],
'layout_url' => $_CONF['layout_url'], // Can be set by lib-common on theme change
'anonymous_user' => COM_isAnonUser(),
'device_mobile' => $_DEVICE->is_mobile(),
),
'hook' => array('set_root' => 'CTL_setTemplateRoot'), // Function found in lib-template and is used to add the ability for child themes
);
\Geeklog\Autoload::load('template');
// Template library contains helper functions for template class
require_once $_CONF['path_system'] . 'lib-template.php';
// Set language
if (isset($_COOKIE[$_CONF['cookie_language']]) && empty($_USER['language'])) {
$language = COM_sanitizeFilename($_COOKIE[$_CONF['cookie_language']]);
if (is_file($_CONF['path_language'] . $language . '.php') &&
($_CONF['allow_user_language'] == 1)
) {
$_USER['language'] = $language;
$_CONF['language'] = $language;
}
} elseif (!empty($_USER['language'])) {
if (is_file($_CONF['path_language'] . $_USER['language'] . '.php') &&
($_CONF['allow_user_language'] == 1)
) {
$_CONF['language'] = $_USER['language'];
}
} elseif (!empty($_CONF['languages']) && !empty($_CONF['language_files'])) {
$_CONF['language'] = COM_getLanguage();
}
// Include a language file
require_once $_CONF['path_language'] . $_CONF['language'] . '.php';
if (empty($LANG_DIRECTION)) {
// default to left-to-right
$LANG_DIRECTION = 'ltr';
}
COM_switchLocaleSettings();
if (setlocale(LC_ALL, $_CONF['locale']) === false) {
setlocale(LC_TIME, $_CONF['locale']);
}
// Override language items (since v2.1.2)
Language::override(array(
'LANG01', 'LANG03', 'LANG04', 'LANG_MYACCOUNT', 'LANG05', 'LANG08', 'LANG09',
'LANG10', 'LANG11', 'LANG12', 'LANG_LOGVIEW', 'LANG_ENVCHECK', 'LANG20',
'LANG21', 'LANG24', 'LANG27', 'LANG28', 'LANG29', 'LANG31', 'LANG32', 'LANG33',
'MESSAGE', 'LANG_ACCESS', 'LANG_DB_BACKUP', 'LANG_BUTTONS', 'LANG_404',
'LANG_LOGIN', 'LANG_TRB', 'LANG_DIR', 'LANG_SECTEST', 'LANG_WHATSNEW', 'LANG_MONTH',
'LANG_WEEK', 'LANG_ADMIN', 'LANG_commentcodes', 'LANG_commentmodes',
'LANG_cookiecodes', 'LANG_dateformats', 'LANG_featurecodes', 'LANG_frontpagecodes',
'LANG_postmodes', 'LANG_sortcodes', 'LANG_trackbackcodes', 'LANG_CONFIG',
'LANG_VALIDATION',
));
/**
* Global array of groups current user belongs to
*
* @global $_GROUPS array
*/
$_GROUPS = COM_isAnonUser() ? SEC_getUserGroups(1) : SEC_getUserGroups($_USER['uid']);
/**
* Global array of current user permissions [read,edit]
*
* @global $_RIGHTS array
*/
$_RIGHTS = explode(',', SEC_getUserPermissions());
// Include scripts on behalf of the theme
$func = 'theme_css_' . $_CONF['theme'];
if (function_exists($func)) {
foreach ($func() as $info) {
$file = (!empty($info['file'])) ? $info['file'] : '';
$name = (!empty($info['name'])) ? $info['name'] : md5(!empty($file) ? $file : strval(time()));
$constant = (!empty($info['constant'])) ? $info['constant'] : true;
$attributes = (!empty($info['attributes'])) ? $info['attributes'] : array();
$priority = (!empty($info['priority'])) ? $info['priority'] : 100;
$_SCRIPTS->setCSSFile($name, $file, $constant, $attributes, $priority, 'theme');
}
}
$func = 'theme_js_libs_' . $_CONF['theme'];
if (function_exists($func)) {
foreach ($func() as $info) {
$footer = true;
if (isset($info['footer']) && !$info['footer']) {
$footer = false;
}
$_SCRIPTS->setJavaScriptLibrary($info['library'], $footer);
}
}
$func = 'theme_js_files_' . $_CONF['theme'];
if (function_exists($func)) {
foreach ($func() as $info) {
$footer = true;
if (isset($info['footer']) && !$info['footer']) {
$footer = false;
}
$priority = (!empty($info['priority'])) ? $info['priority'] : 100;
$_SCRIPTS->setJavaScriptFile(md5($info['file']), $info['file'], $footer, $priority);
}
}
$func = 'theme_init_' . $_CONF['theme'];
if (function_exists($func)) {
$func();
}
unset($theme_config, $func);
// Disable Resource cache (combined and minified CSS and JavaScript files)
if (isset($_CONF['cache_resource']) && !$_CONF['cache_resource']) {
Geeklog\Cache::disable();
};
// Clear out any expired sessions
DB_lockTable($_TABLES['sessions']);
DB_query("UPDATE {$_TABLES['sessions']} SET whos_online = 0 WHERE start_time < " . (time() - $_CONF['whosonline_threshold']));
DB_unlockTable($_TABLES['sessions']);
/**
* Build global array of Link Tags used by the header of a page. This is a stop
* gap measure to support pagination with rel="next" and rel="prev" in
* COM_printPageNavigation. When the GL Page class is finished this global
* function will no longer be accessible.
*/
$relLinks = array();
/**
* Build global array of Topics current user has access to
*
* @global $_TOPICS array
*/
// Figure out if we need to update topic tree or retrieve it from the cache
// For anonymous users topic tree data can be shared
$cacheInstance = 'topic_tree__' . CACHE_security_hash();
$serialized_topic_tree = CACHE_check_instance($cacheInstance, true);
// See if Topic Tree cache exists
if (empty($serialized_topic_tree)) {
$_TOPICS = TOPIC_buildTree(TOPIC_ROOT, true);
// Need this check since this variable is not set correctly when Geeklog is being install
if (isset($GLOBALS['TEMPLATE_OPTIONS']) && is_array($TEMPLATE_OPTIONS) && isset($TEMPLATE_OPTIONS['path_cache'])) {
// Save updated topic tree and date
CACHE_create_instance($cacheInstance, serialize($_TOPICS), true);
}
} else {
$_TOPICS = unserialize($serialized_topic_tree);
}
// Figure out if we need to update article feeds. Check last article date published in feed
$sql = "SELECT date FROM {$_TABLES['stories']} "
. "WHERE draft_flag = 0 AND date <= NOW() AND perm_anon > 0 "
. "ORDER BY date DESC LIMIT 1";
$result = DB_query($sql);
$A = DB_fetchArray($result);
if ($_VARS['last_article_publish'] != $A['date']) {
//Set new latest article published
DB_query("UPDATE {$_TABLES['vars']} SET value='{$A['date']}' WHERE name='last_article_publish'");
// We need to see if there are currently two featured articles (because of future article).
// Can only have one but you can have one current featured article
// and one for the future...this check will set the latest one as featured
// solely
COM_featuredCheck();
// Geeklog now allows for articles to be published in the future. Because of
// this, we need to check to see if we need to rebuild the RDF file in the case
// that any such articles have now been published. Need to do this for comments
// as well since article can have comments
COM_rdfUpToDateCheck('article');
COM_rdfUpToDateCheck('comment');
}
// +---------------------------------------------------------------------------+
// | HTML WIDGETS |
// +---------------------------------------------------------------------------+
/**
* Return the file to use for a block template.
* This returns the template needed to build the HTML for a block. This function
* allows designers to give a block it's own custom look and feel. If no
* templates for the block are specified, the default blockheader.html and
* blockfooter.html will be used.
*
* @param string $blockName corresponds to name field in block table
* @param string $which can be either 'header' or 'footer' for corresponding template
* @param string $position can be 'left', 'right' or blank. If set, will be used to find a side specific
* override template.
* @see function COM_startBlock
* @see function COM_endBlock
* @see function COM_showBlocks
* @see function COM_showBlock
* @return string template name
*/
function COM_getBlockTemplate($blockName, $which, $position = '')
{
global $_BLOCK_TEMPLATE, $_COM_VERBOSE, $_CONF;
if ($_COM_VERBOSE) {
COM_errorLog("_BLOCK_TEMPLATE[$blockName] = " . $_BLOCK_TEMPLATE[$blockName], 1);
}
$template = ($which === 'header') ? 'blockheader.thtml' : 'blockfooter.thtml';
if (!empty($_BLOCK_TEMPLATE[$blockName])) {
$i = ($which === 'header') ? 0 : 1;
$templates = explode(',', $_BLOCK_TEMPLATE[$blockName]);
if (count($templates) === 2 && !empty($templates[$i])) {
$template = $templates[$i];
}
}
// If we have a position specific request, and the template is not already
// position specific then look to see if there is a position specific
// override.
$templateLC = strtolower($template);
if (!empty($position) && (strpos($templateLC, $position) === false)) {
// Trim .thtml from the end.
$positionSpecific = substr($template, 0, strlen($template) - 6);
$positionSpecific .= '-' . $position . '.thtml';
if (file_exists($_CONF['path_layout'] . $positionSpecific)) {
$template = $positionSpecific;
}
// See if default theme if so check there
if (!empty($_CONF['theme_default'])) {
if (file_exists($_CONF['path_layout_default'] . $positionSpecific)) {
$template = $positionSpecific;
}
}
}
if ($_COM_VERBOSE) {
COM_errorLog("Block template for the $which of $blockName is: $template", 1);
}
return $template;
}
/**
* Gets all installed themes
* Returns a list of all the directory names in $_CONF['path_themes'], i.e.
* a list of all the theme names.
*
* @param boolean $all if true, return all themes even if users aren't allowed to change their default themes
* @return array All installed themes
*/
function COM_getThemes($all = false)
{
global $_CONF;
$index = 1;
$themes = array();
// If users aren't allowed to change their theme then only return the default theme
if (($_CONF['allow_user_themes'] == 0) && !$all) {
$themes[$index] = $_CONF['theme'];
} else {
$fd = opendir($_CONF['path_themes']);
while (($dir = @readdir($fd)) !== false) {
if (is_dir($_CONF['path_themes'] . $dir) && ($dir !== '.') && ($dir !== '..') &&
($dir !== 'CVS') && (substr($dir, 0, 1) !== '.')
) {
clearstatcache();
$themes[$index] = $dir;
$index++;
}
}
}
return $themes;
}
/**
* Create the menu, i.e. replace {menu_elements} in the site header with the
* actual menu entries.
*
* @param Template $header reference to the header template
* @param array $plugin_menu array of plugin menu entries, if any
*/
function COM_renderMenu($header, $plugin_menu)
{
global $_CONF, $LANG01, $topic;
if (empty($_CONF['menu_elements'])) {
$_CONF['menu_elements'] = array( // default set of links
'contribute', 'search', 'stats', 'directory', 'plugins',
);
}
$anon = COM_isAnonUser();
$menuCounter = 0;
$allowedCounter = 0;
$counter = 0;
$custom_entries = array();
$num_plugins = count($plugin_menu);
if (($num_plugins === 0) && in_array('plugins', $_CONF['menu_elements'])) {
$key = array_search('plugins', $_CONF['menu_elements']);
unset($_CONF['menu_elements'][$key]);
}
if (in_array('custom', $_CONF['menu_elements'])) {
if (function_exists('CUSTOM_menuEntries')) {
$custom_entries = CUSTOM_menuEntries();
}
if (count($custom_entries) === 0) {
$key = array_search('custom', $_CONF['menu_elements']);
unset($_CONF['menu_elements'][$key]);
}
}
$num_elements = count($_CONF['menu_elements']);
foreach ($_CONF['menu_elements'] as $item) {
$counter++;
$allowed = true;
$last_entry = ($counter == $num_elements);
switch ($item) {
case 'contribute':
$url = $_CONF['site_url'] . '/submit.php?type=story';
$header->set_var('current_topic', '');
$label = $LANG01[71];
if ($anon && ($_CONF['loginrequired'] ||
$_CONF['submitloginrequired'])
) {
$allowed = false;
}
break;
case 'custom':
if (function_exists('CUSTOM_renderMenu')) {
CUSTOM_renderMenu($header, $custom_entries, $menuCounter);
} else {
$custom_count = 0;
$custom_size = count($custom_entries);
foreach ($custom_entries as $entry) {
$custom_count++;
if (empty($entry['url']) || empty($entry['label'])) {
continue;
}
$header->set_var('menuitem_url', $entry['url']);
$header->set_var('menuitem_text', $entry['label']);
if ($last_entry && ($custom_count == $custom_size)) {
$header->parse('menu_elements', 'menuitem_last',
true);
} else {
$header->parse('menu_elements', 'menuitem', true);
}
$menuCounter++;
}
}
$url = '';
$label = '';
break;
case 'directory':
$url = $_CONF['site_url'] . '/directory.php';
if (!empty($topic)) {
$url = COM_buildURL($url . '?topic=' . urlencode($topic));
}
$label = $LANG01[117];
if ($anon && ($_CONF['loginrequired'] || $_CONF['directoryloginrequired'])) {
$allowed = false;
}
break;
case 'home':
$url = $_CONF['site_url'] . '/';
$label = $LANG01[90];
break;
case 'plugins':
for ($i = 1; $i <= $num_plugins; $i++) {
$header->set_var('menuitem_url', current($plugin_menu));
$header->set_var('menuitem_text', key($plugin_menu));
if ($last_entry && ($i == $num_plugins)) {
$header->parse('menu_elements', 'menuitem_last',
true);
} else {
$header->parse('menu_elements', 'menuitem', true);
}
$menuCounter++;
next($plugin_menu);
}
$url = '';
$label = '';
break;
case 'login':
if ($anon) {
$url = $_CONF['site_url'] . '/users.php';
$label = $LANG01[58];
} else {
$url = $_CONF['site_url'] . '/users.php?mode=logout';
$label = $LANG01[35];
}
break;
case 'prefs':
if ($anon) {
$url = '';
$label = '';
} else {
$url = $_CONF['site_url'] . '/usersettings.php';
$label = $LANG01[48];
}
break;
case 'search':
$url = $_CONF['site_url'] . '/search.php';
$label = $LANG01[75];
if ($anon && ($_CONF['loginrequired'] || $_CONF['searchloginrequired'])) {
$allowed = false;
}
break;
case 'stats':
$url = $_CONF['site_url'] . '/stats.php';
$label = $LANG01[76];
if ($anon &&
($_CONF['loginrequired'] || $_CONF['statsloginrequired'])
) {
$allowed = false;
}
break;
default: // unknown entry
$url = '';
$label = '';
break;
}
if (!empty($url) && !empty($label)) {
$header->set_var('menuitem_url', $url);
$header->set_var('menuitem_text', $label);
if ($last_entry) {
$header->parse('menu_elements', 'menuitem_last', true);
} else {
$header->parse('menu_elements', 'menuitem', true);
}
$menuCounter++;
if ($allowed) {
if ($last_entry) {
$header->parse('allowed_menu_elements', 'menuitem_last',
true);
} else {
$header->parse('allowed_menu_elements', 'menuitem', true);
}
$allowedCounter++;
}
}
}
if ($menuCounter == 0) {
$header->parse('menu_elements', 'menuitem_none', true);
}
if ($allowedCounter == 0) {
$header->parse('allowed_menu_elements', 'menuitem_none', true);
}
}
/**
* Create and return the HTML document
*
* @param string $content Main content for the page
* @param array $information An array defining variables to be used when creating the output
* string 'what' If 'none' then no left blocks are returned, if 'menu'
* (default) then right blocks are returned string 'pagetitle' Optional content for
* the page's <title> string 'breadcrumbs' Optional content for the page's breadcrumb
* string 'headercode' Optional code to go into the page's <head> boolean
* 'rightblock' Whether or not to show blocks on right hand side default is no (-1)
* array 'custom' An array defining custom function to be used to format
* Rightblocks
* @return string Formatted HTML document
*/
function COM_createHTMLDocument(&$content = '', $information = array())
{
global $_CONF, $_VARS, $_TABLES, $_USER, $LANG01, $LANG_BUTTONS, $LANG_DIRECTION,
$_IMAGE_TYPE, $topic, $_COM_VERBOSE, $_SCRIPTS, $_PAGE_TIMER, $relLinks;
// Retrieve required variables from information array
$what = isset($information['what']) ? $information['what'] : 'menu';
$pageTitle = isset($information['pagetitle']) ? $information['pagetitle'] : '';
$headerCode = isset($information['headercode']) ? $information['headercode'] : '';
$breadcrumbs = isset($information['breadcrumbs']) ? $information['breadcrumbs'] : '';
$rightBlock = isset($information['rightblock']) ? $information['rightblock'] : -1;
$custom = isset($information['custom']) ? $information['custom'] : '';
// If the theme does not support the CSS layout then call the legacy functions (Geeklog 1.8.1 and older).
if ($_CONF['supported_version_theme'] === '1.8.1') {
die('COM_siteHeader and COM_siteFooter are removed. Please use COM_createHTMLDocument instead.');
}
// If the theme implemented this for us then call their version instead.
$function = $_CONF['theme'] . '_createHTMLDocument';
if (function_exists($function)) {
return $function($content, $information);
}
// If we reach here then either we have the default theme OR
// the current theme only needs the default variable substitutions
switch ($_CONF['doctype']) {
case 'html401transitional':
$docType = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">';
break;
case 'html401strict':
$docType = '<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">';
break;
case 'xhtml10transitional':
$docType = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">';
break;
case 'xhtml10strict':
$docType = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">';
break;
case 'html5':
case 'xhtml5':
$docType = '<!DOCTYPE html>';
break;
default: // fallback: HTML 4.01 Transitional w/o system identifier
$docType = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">';
break;
}
// send out the charset header
header('Content-Type: text/html; charset=' . COM_getCharset());
header('X-XSS-Protection: 1; mode=block');
header('X-Content-Type-Options: nosniff');
if (!empty($_CONF['frame_options'])) {
header('X-FRAME-OPTIONS: ' . $_CONF['frame_options']);
}
$header = COM_newTemplate($_CONF['path_layout']);
$header->set_file(array(
'header' => 'header.thtml',
'menunavigation' => 'menunavigation.thtml',
'leftblocks' => 'leftblocks.thtml',
'rightblocks' => 'rightblocks.thtml',
));
$blocks = array('menuitem', 'menuitem_last', 'menuitem_none');
foreach ($blocks as $block) {
$header->set_block('menunavigation', $block);
}
$header->parse('menu_elements', 'menunavigation', true);
$header->set_var('doctype', $docType . LB);
COM_setLangIdAndAttribute($header);
$langId = $header->get_var('lang_id');
if (XHTML == '') {
$header->set_var('xmlns', '');
} else {
$header->set_var('xmlns', ' xmlns="http://www.w3.org/1999/xhtml" xml:lang="' . $langId . '"');
}
$feed_url = array();
if ($_CONF['backend'] == 1) { // add feed-link to header if applicable
$baseUrl = SYND_getFeedUrl();
$sql = "SELECT format, filename, title, language FROM {$_TABLES['syndication']} "
. " WHERE (header_tid = 'all')";
if (!empty($topic)) {
$sql .= " OR (header_tid = '" . DB_escapeString($topic) . "')";
}
$result = DB_query($sql);
$numRows = DB_numRows($result);
for ($i = 0; $i < $numRows; $i++) {
$A = DB_fetchArray($result);
if (!empty($A['filename'])) {
$format_type = SYND_getMimeType($A['format']);
$format_name = SYND_getFeedType($A['format']);
$feed_title = $format_name . ' Feed: ' . $A['title'];
$feed_url[] = '<link rel="alternate" type="' . $format_type
. '" href="' . $baseUrl . $A['filename'] . '" title="'
. htmlspecialchars($feed_title) . '"' . XHTML . '>';
}
}
}
$header->set_var('feed_url', implode(LB, $feed_url));
// for backward compatibility only - use {feed_url} instead
$feed = SYND_getDefaultFeedUrl();
$isOnFrontPage = COM_onFrontpage();