-
-
Notifications
You must be signed in to change notification settings - Fork 211
/
class.symphony.php
1029 lines (902 loc) · 33.1 KB
/
class.symphony.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
/**
* @package core
*/
/**
* The Symphony class is an abstract class that implements the
* Singleton interface. It provides the glue that forms the Symphony
* CMS and initialises the toolkit classes. Symphony is extended by
* the Frontend and Administration classes
*/
require_once CORE . '/class.errorhandler.php';
require_once CORE . '/class.configuration.php';
require_once CORE . '/class.log.php';
require_once CORE . '/class.cookie.php';
require_once FACE . '/interface.singleton.php';
require_once TOOLKIT . '/class.page.php';
require_once TOOLKIT . '/class.ajaxpage.php';
require_once TOOLKIT . '/class.xmlelement.php';
require_once TOOLKIT . '/class.widget.php';
require_once TOOLKIT . '/class.general.php';
require_once TOOLKIT . '/class.cryptography.php';
require_once TOOLKIT . '/class.xsrf.php';
require_once TOOLKIT . '/class.profiler.php';
require_once TOOLKIT . '/class.author.php';
require_once TOOLKIT . '/class.email.php';
require_once TOOLKIT . '/class.mysql.php';
require_once TOOLKIT . '/class.extensionmanager.php';
require_once TOOLKIT . '/class.pagemanager.php';
require_once TOOLKIT . '/class.authormanager.php';
require_once TOOLKIT . '/class.emailgatewaymanager.php';
require_once TOOLKIT . '/class.entrymanager.php';
require_once TOOLKIT . '/class.fieldmanager.php';
require_once TOOLKIT . '/class.sectionmanager.php';
require_once TOOLKIT . '/class.textformattermanager.php';
require_once TOOLKIT . '/class.datasourcemanager.php';
require_once TOOLKIT . '/class.eventmanager.php';
abstract class Symphony implements Singleton
{
/**
* An instance of the Symphony class, either `Administration` or `Frontend`.
* @var Symphony
*/
protected static $_instance = null;
/**
* An instance of the Profiler class
* @var Profiler
*/
protected static $Profiler = null;
/**
* An instance of the `Configuration` class
* @var Configuration
*/
private static $Configuration = null;
/**
* An instance of the `Database` class
* @var MySQL
*/
private static $Database = null;
/**
* An instance of the `ExtensionManager` class
* @var ExtensionManager
*/
private static $ExtensionManager = null;
/**
* An instance of the `Log` class
* @var Log
*/
private static $Log = null;
/**
* The current page namespace, used for translations
* @since Symphony 2.3
* @var string
*/
private static $namespace = false;
/**
* An instance of the Cookie class
* @var Cookie
*/
public static $Cookie = null;
/**
* An instance of the currently logged in Author
* @var Author
*/
public static $Author = null;
/**
* A previous exception that has been fired. Defaults to null.
* @since Symphony 2.3.2
* @var Exception
*/
private static $exception = null;
/**
* The Symphony constructor initialises the class variables of Symphony.
* It will set the DateTime settings, define new date constants and initialise
* the correct Language for the currently logged in Author. If magic quotes
* are enabled, Symphony will sanitize the `$_SERVER`, `$_COOKIE`,
* `$_GET` and `$_POST` arrays. The constructor loads in
* the initial Configuration values from the `CONFIG` file
*/
protected function __construct()
{
self::$Profiler = Profiler::instance();
if (get_magic_quotes_gpc()) {
General::cleanArray($_SERVER);
General::cleanArray($_COOKIE);
General::cleanArray($_GET);
General::cleanArray($_POST);
}
// Set date format throughout the system
define_safe('__SYM_DATE_FORMAT__', self::Configuration()->get('date_format', 'region'));
define_safe('__SYM_TIME_FORMAT__', self::Configuration()->get('time_format', 'region'));
define_safe('__SYM_DATETIME_FORMAT__', __SYM_DATE_FORMAT__ . self::Configuration()->get('datetime_separator', 'region') . __SYM_TIME_FORMAT__);
DateTimeObj::setSettings(self::Configuration()->get('region'));
// Initialise logging
self::initialiseLog();
GenericExceptionHandler::initialise(self::Log());
GenericErrorHandler::initialise(self::Log());
// Initialize language management
Lang::initialize();
Lang::set(self::$Configuration->get('lang', 'symphony'));
self::initialiseCookie();
// If the user is not a logged in Author, turn off the verbose error messages.
if (!self::isLoggedIn() && is_null(self::$Author)) {
GenericExceptionHandler::$enabled = false;
}
// Engine is ready.
self::$Profiler->sample('Engine Initialisation');
}
/**
* Accessor for the Symphony instance, whether it be Frontend
* or Administration
*
* @since Symphony 2.2
* @throws Exception
* @return Symphony
*/
public static function Engine()
{
if (class_exists('Administration')) {
return Administration::instance();
} elseif (class_exists('Frontend')) {
return Frontend::instance();
} else {
throw new Exception(__('No suitable engine object found'));
}
}
/**
* Setter for `$Configuration`. This function initialise the configuration
* object and populate its properties based on the given $array.
*
* @since Symphony 2.3
* @param array $data
* An array of settings to be stored into the Configuration object
*/
public static function initialiseConfiguration(array $data = array())
{
if (empty($data)) {
// Includes the existing CONFIG file and initialises the Configuration
// by setting the values with the setArray function.
include CONFIG;
$data = $settings;
}
self::$Configuration = new Configuration(true);
self::$Configuration->setArray($data);
}
/**
* Accessor for the current `Configuration` instance. This contains
* representation of the the Symphony config file.
*
* @return Configuration
*/
public static function Configuration()
{
return self::$Configuration;
}
/**
* Is XSRF enabled for this Symphony install?
*
* @since Symphony 2.4
* @return boolean
*/
public static function isXSRFEnabled()
{
return self::Configuration()->get('enable_xsrf', 'symphony') === 'yes';
}
/**
* Accessor for the current `Profiler` instance.
*
* @since Symphony 2.3
* @return Profiler
*/
public static function Profiler()
{
return self::$Profiler;
}
/**
* Setter for `$Log`. This function uses the configuration
* settings in the 'log' group in the Configuration to create an instance. Date
* formatting options are also retrieved from the configuration.
*
* @param string $filename (optional)
* The file to write the log to, if omitted this will default to `ACTIVITY_LOG`
* @throws Exception
* @return bool|void
*/
public static function initialiseLog($filename = null)
{
if (self::$Log instanceof Log && self::$Log->getLogPath() == $filename) {
return true;
}
if (is_null($filename)) {
$filename = ACTIVITY_LOG;
}
self::$Log = new Log($filename);
self::$Log->setArchive((self::Configuration()->get('archive', 'log') == '1' ? true : false));
self::$Log->setMaxSize(intval(self::Configuration()->get('maxsize', 'log')));
self::$Log->setDateTimeFormat(self::Configuration()->get('date_format', 'region') . ' ' . self::Configuration()->get('time_format', 'region'));
if (self::$Log->open(Log::APPEND, self::Configuration()->get('write_mode', 'file')) == '1') {
self::$Log->initialise('Symphony Log');
}
}
/**
* Accessor for the current `Log` instance
*
* @since Symphony 2.3
* @return Log
*/
public static function Log()
{
return self::$Log;
}
/**
* Setter for `$Cookie`. This will use PHP's parse_url
* function on the current URL to set a cookie using the cookie_prefix
* defined in the Symphony configuration. The cookie will last two
* weeks.
*
* This function also defines two constants, `__SYM_COOKIE_PATH__`
* and `__SYM_COOKIE_PREFIX__`.
*
* @deprecated Prior to Symphony 2.3.2, the constant `__SYM_COOKIE_PREFIX_`
* had a typo where it was missing the second underscore. Symphony will
* support both constants, `__SYM_COOKIE_PREFIX_` and `__SYM_COOKIE_PREFIX__`
* until Symphony 2.6.0.
*/
public static function initialiseCookie()
{
$cookie_path = @parse_url(URL, PHP_URL_PATH);
$cookie_path = '/' . trim($cookie_path, '/');
define_safe('__SYM_COOKIE_PATH__', $cookie_path);
define_safe('__SYM_COOKIE_PREFIX_', self::Configuration()->get('cookie_prefix', 'symphony'));
define_safe('__SYM_COOKIE_PREFIX__', self::Configuration()->get('cookie_prefix', 'symphony'));
self::$Cookie = new Cookie(__SYM_COOKIE_PREFIX__, TWO_WEEKS, __SYM_COOKIE_PATH__);
}
/**
* Accessor for the current `$Cookie` instance.
*
* @since Symphony 2.5.0
* @return Cookie
*/
public static function Cookie() {
return self::$Cookie;
}
/**
* Setter for `$ExtensionManager` using the current
* Symphony instance as the parent. If for some reason this fails,
* a Symphony Error page will be thrown
* @param Boolean $force (optional)
* When set to true, this function will always create a new
* instance of ExtensionManager, replacing self::$ExtensionManager.
*/
public static function initialiseExtensionManager($force=false)
{
if (!$force && self::$ExtensionManager instanceof ExtensionManager) {
return true;
}
self::$ExtensionManager = new ExtensionManager;
if (!(self::$ExtensionManager instanceof ExtensionManager)) {
self::throwCustomError(__('Error creating Symphony extension manager.'));
}
}
/**
* Accessor for the current `$ExtensionManager` instance.
*
* @since Symphony 2.2
* @return ExtensionManager
*/
public static function ExtensionManager()
{
return self::$ExtensionManager;
}
/**
* Setter for `$Database`, accepts a Database object. If `$database`
* is omitted, this function will set `$Database` to be of the `MySQL`
* class.
*
* @since Symphony 2.3
* @param StdClass $database (optional)
* The class to handle all Database operations, if omitted this function
* will set `self::$Database` to be an instance of the `MySQL` class.
* @return boolean
* This function will always return true
*/
public static function setDatabase(StdClass $database = null)
{
if (self::Database()) {
return true;
}
self::$Database = !is_null($database) ? $database : new MySQL;
return true;
}
/**
* Accessor for the current `$Database` instance.
*
* @return MySQL
*/
public static function Database()
{
return self::$Database;
}
/**
* This will initialise the Database class and attempt to create a connection
* using the connection details provided in the Symphony configuration. If any
* errors occur whilst doing so, a Symphony Error Page is displayed.
*
* @throws SymphonyErrorPage
* @return boolean
* This function will return true if the `$Database` was
* initialised successfully.
*/
public static function initialiseDatabase()
{
self::setDatabase();
$details = self::Configuration()->get('database');
try {
if (!self::Database()->connect($details['host'], $details['user'], $details['password'], $details['port'], $details['db'])) {
return false;
}
if (!self::Database()->isConnected()) {
return false;
}
self::Database()->setPrefix($details['tbl_prefix']);
self::Database()->setCharacterEncoding();
self::Database()->setCharacterSet();
// Set Timezone, need to convert human readable, ie. Australia/Brisbane to be +10:00
// @see https://github.com/symphonycms/symphony-2/issues/1726
$timezone = self::Configuration()->get('timezone', 'region');
$symphony_date = new DateTime('now', new DateTimeZone($timezone));
// MySQL wants the offset to be in the format +/-H:I, getOffset returns offset in seconds
$utc = new DateTime('now ' . $symphony_date->getOffset() . ' seconds', new DateTimeZone("UTC"));
// On PHP5.3+ we can use DateInterval to format the difference
// in way that MySQL will be happy
$offset = $symphony_date->diff($utc)->format('%R%H:%I');
self::Database()->setTimeZone($offset);
if (self::Configuration()->get('query_caching', 'database') == 'off') {
self::Database()->disableCaching();
} elseif (self::Configuration()->get('query_caching', 'database') == 'on') {
self::Database()->enableCaching();
}
} catch (DatabaseException $e) {
self::throwCustomError(
$e->getDatabaseErrorCode() . ': ' . $e->getDatabaseErrorMessage(),
__('Symphony Database Error'),
Page::HTTP_STATUS_ERROR,
'database',
array(
'error' => $e,
'message' => __('There was a problem whilst attempting to establish a database connection. Please check all connection information is correct.') . ' ' . __('The following error was returned:')
)
);
}
return true;
}
/**
* Accessor for the current `$Author` instance.
*
* @since Symphony 2.5.0
* @return Author
*/
public static function Author() {
return self::$Author;
}
/**
* Attempts to log an Author in given a username and password.
* If the password is not hashed, it will be hashed using the sha1
* algorithm. The username and password will be sanitized before
* being used to query the Database. If an Author is found, they
* will be logged in and the sanitized username and password (also hashed)
* will be saved as values in the `$Cookie`.
*
* @see toolkit.General#hash()
* @param string $username
* The Author's username. This will be sanitized before use.
* @param string $password
* The Author's password. This will be sanitized and then hashed before use
* @param boolean $isHash
* If the password provided is already hashed, setting this parameter to
* true will stop it becoming rehashed. By default it is false.
* @throws DatabaseException
* @return boolean
* True if the Author was logged in, false otherwise
*/
public static function login($username, $password, $isHash = false)
{
$username = self::Database()->cleanValue($username);
$password = self::Database()->cleanValue($password);
if (strlen(trim($username)) > 0 && strlen(trim($password)) > 0) {
$author = AuthorManager::fetch('id', 'ASC', 1, null, sprintf(
"`username` = '%s'",
$username
));
if (!empty($author) && Cryptography::compare($password, current($author)->get('password'), $isHash)) {
self::$Author = current($author);
// Only migrate hashes if there is no update available as the update might change the tbl_authors table.
if (self::isUpgradeAvailable() === false && Cryptography::requiresMigration(self::$Author->get('password'))) {
self::$Author->set('password', Cryptography::hash($password));
self::Database()->update(array('password' => self::$Author->get('password')), 'tbl_authors', sprintf(
" `id` = %d", self::$Author->get('id')
));
}
self::$Cookie->set('username', $username);
self::$Cookie->set('pass', self::$Author->get('password'));
self::Database()->update(array(
'last_seen' => DateTimeObj::get('Y-m-d H:i:s')),
'tbl_authors',
sprintf(" `id` = %d", self::$Author->get('id'))
);
return true;
}
}
return false;
}
/**
* Symphony allows Authors to login via the use of tokens instead of
* a username and password. A token is derived from concatenating the
* Author's username and password and applying the sha1 hash to
* it, from this, a portion of the hash is used as the token. This is a useful
* feature often used when setting up other Authors accounts or if an
* Author forgets their password.
*
* @param string $token
* The Author token, which is a portion of the hashed string concatenation
* of the Author's username and password
* @throws DatabaseException
* @return boolean
* True if the Author is logged in, false otherwise
*/
public static function loginFromToken($token)
{
$token = self::Database()->cleanValue($token);
if (strlen(trim($token)) == 0) {
return false;
}
if (strlen($token) == 6 || strlen($token) == 16) {
$row = self::Database()->fetchRow(0, sprintf(
"SELECT `a`.`id`, `a`.`username`, `a`.`password`
FROM `tbl_authors` AS `a`, `tbl_forgotpass` AS `f`
WHERE `a`.`id` = `f`.`author_id`
AND `f`.`expiry` > '%s'
AND `f`.`token` = '%s'
LIMIT 1",
DateTimeObj::getGMT('c'),
$token
));
self::Database()->delete('tbl_forgotpass', sprintf(" `token` = '%s' ", $token));
} else {
$row = self::Database()->fetchRow(0, sprintf(
"SELECT `id`, `username`, `password`
FROM `tbl_authors`
WHERE SUBSTR(%s(CONCAT(`username`, `password`)), 1, 8) = '%s'
AND `auth_token_active` = 'yes'
LIMIT 1",
'SHA1',
$token
));
}
if ($row) {
self::$Author = AuthorManager::fetchByID($row['id']);
self::$Cookie->set('username', $row['username']);
self::$Cookie->set('pass', $row['password']);
self::Database()->update(array('last_seen' => DateTimeObj::getGMT('Y-m-d H:i:s')), 'tbl_authors', sprintf("
`id` = %d", $row['id']
));
return true;
}
return false;
}
/**
* This function will destroy the currently logged in `$Author`
* session, essentially logging them out.
*
* @see core.Cookie#expire()
*/
public static function logout()
{
self::$Cookie->expire();
}
/**
* This function determines whether an there is a currently logged in
* Author for Symphony by using the `$Cookie`'s username
* and password. If an Author is found, they will be logged in, otherwise
* the `$Cookie` will be destroyed.
*
* @see core.Cookie#expire()
*/
public static function isLoggedIn()
{
// Ensures that we're in the real world.. Also reduces three queries from database
// We must return true otherwise exceptions are not shown
if (is_null(self::$_instance)) {
return true;
}
if (self::$Author) {
return true;
} else {
$username = self::Database()->cleanValue(self::$Cookie->get('username'));
$password = self::Database()->cleanValue(self::$Cookie->get('pass'));
if (strlen(trim($username)) > 0 && strlen(trim($password)) > 0) {
$author = AuthorManager::fetch('id', 'ASC', 1, null, sprintf(
"`username` = '%s'",
$username
));
if (!empty($author) && Cryptography::compare($password, current($author)->get('password'), true)) {
self::$Author = current($author);
self::Database()->update(array(
'last_seen' => DateTimeObj::get('Y-m-d H:i:s')),
'tbl_authors',
sprintf(" `id` = %d", self::$Author->get('id'))
);
// Only set custom author language in the backend
if (class_exists('Administration')) {
Lang::set(self::$Author->get('language'));
}
return true;
}
}
return false;
}
}
/**
* Returns the most recent version found in the `/install/migrations` folder.
* Returns a version string to be used in `version_compare()` if an updater
* has been found. Returns `FALSE` otherwise.
*
* @since Symphony 2.3.1
* @return mixed
*/
public static function getMigrationVersion()
{
if (self::isInstallerAvailable()) {
$migrations = scandir(DOCROOT . '/install/migrations');
$migration_file = end($migrations);
include_once DOCROOT . '/install/lib/class.migration.php';
include_once DOCROOT . '/install/migrations/' . $migration_file;
$migration_class = 'migration_' . str_replace('.', '', substr($migration_file, 0, -4));
return call_user_func(array($migration_class, 'getVersion'));
}
return false;
}
/**
* Checks if an update is available and applicable for the current installation.
*
* @since Symphony 2.3.1
* @return boolean
*/
public static function isUpgradeAvailable()
{
if (self::isInstallerAvailable()) {
$migration_version = self::getMigrationVersion();
$current_version = Symphony::Configuration()->get('version', 'symphony');
return version_compare($current_version, $migration_version, '<');
}
return false;
}
/**
* Checks if the installer/upgrader is available.
*
* @since Symphony 2.3.1
* @return boolean
*/
public static function isInstallerAvailable()
{
return file_exists(DOCROOT . '/install/index.php');
}
/**
* A wrapper for throwing a new Symphony Error page.
*
* This methods sets the `GenericExceptionHandler::$enabled` value to `true`.
*
* @see core.SymphonyErrorPage
* @param string|XMLElement $message
* A description for this error, which can be provided as a string
* or as an XMLElement.
* @param string $heading
* A heading for the error page
* @param integer $status
* Properly sets the HTTP status code for the response. Defaults to
* `Page::HTTP_STATUS_ERROR`. Use `Page::HTTP_STATUS_XXX` to set this value.
* @param string $template
* A string for the error page template to use, defaults to 'generic'. This
* can be the name of any template file in the `TEMPLATES` directory.
* A template using the naming convention of `tpl.*.php`.
* @param array $additional
* Allows custom information to be passed to the Symphony Error Page
* that the template may want to expose, such as custom Headers etc.
* @throws SymphonyErrorPage
*/
public static function throwCustomError($message, $heading = 'Symphony Fatal Error', $status = Page::HTTP_STATUS_ERROR, $template = 'generic', array $additional = array())
{
GenericExceptionHandler::$enabled = true;
throw new SymphonyErrorPage($message, $heading, $template, $additional, $status);
}
/**
* Setter accepts a previous Exception. Useful for determining the context
* of a current exception (ie. detecting recursion).
*
* @since Symphony 2.3.2
* @param Exception $ex
*/
public static function setException(Exception $ex)
{
self::$exception = $ex;
}
/**
* Accessor for `self::$exception`.
*
* @since Symphony 2.3.2
* @return Exception|null
*/
public static function getException()
{
return self::$exception;
}
/**
* Returns the page namespace based on the current URL.
* A few examples:
*
* /login
* /publish
* /blueprints/datasources
* [...]
* /extension/$extension_name/$page_name
*
* This method is especially useful in couple with the translation function.
*
* @see toolkit#__()
* @return string
* The page namespace, without any action string (e.g. "new", "saved") or
* any value that depends upon the single setup (e.g. the section handle in
* /publish/$handle)
*/
public static function getPageNamespace()
{
if (self::$namespace !== false) {
return self::$namespace;
}
$page = getCurrentPage();
if (!is_null($page)) {
$page = trim($page, '/');
}
if (substr($page, 0, 7) == 'publish') {
self::$namespace = '/publish';
} elseif (empty($page) && isset($_REQUEST['mode'])) {
self::$namespace = '/login';
} elseif (empty($page)) {
self::$namespace = null;
} else {
$bits = explode('/', $page);
if ($bits[0] == 'extension') {
self::$namespace = sprintf('/%s/%s/%s', $bits[0], $bits[1], $bits[2]);
} else {
self::$namespace = sprintf('/%s/%s', $bits[0], isset($bits[1]) ? $bits[1] : '');
}
}
return self::$namespace;
}
}
/**
* The `SymphonyErrorPageHandler` extends the `GenericExceptionHandler`
* to allow the template for the exception to be provided from the `TEMPLATES`
* directory
*/
Class SymphonyErrorPageHandler extends GenericExceptionHandler
{
/**
* The render function will take a `SymphonyErrorPage` exception and
* output a HTML page. This function first checks to see if their is a custom
* template for this exception otherwise it reverts to using the default
* `usererror.generic.php`
*
* @param Exception $e
* The Exception object
* @return string
* An HTML string
*/
public static function render(Exception $e)
{
if ($e->getTemplate() === false) {
Page::renderStatusCode($e->getHttpStatusCode());
if (isset($e->getAdditional()->header)) {
header($e->getAdditional()->header);
}
echo '<h1>Symphony Fatal Error</h1><p>'.$e->getMessage().'</p>';
exit;
}
include $e->getTemplate();
}
}
/**
* `SymphonyErrorPage` extends the default `Exception` class. All
* of these exceptions will halt execution immediately and return the
* exception as a HTML page. By default the HTML template is `usererror.generic.php`
* from the `TEMPLATES` directory.
*/
Class SymphonyErrorPage extends Exception
{
/**
* A heading for the error page, this will be prepended to
* "Symphony Fatal Error".
* @return string
*/
private $_heading;
/**
* A string for the error page template to use, defaults to 'generic'. This
* can be the name of any template file in the `TEMPLATES` directory.
* A template using the naming convention of `usererror.*.php`.
* @var string
*/
private $_template = 'generic';
/**
* If the message as provided as an `XMLElement`, it will be saved to
* this parameter
* @var XMLElement
*/
private $_messageObject = null;
/**
* An object of an additional information for this error page. Note that
* this is provided as an array and then typecast to an object
* @var StdClass
*/
private $_additional = null;
/**
* A simple container for the response status code.
* Full value is setted usign `$Page->setHttpStatus()`
* in the template.
*/
private $_status = Page::HTTP_STATUS_ERROR;
/**
* Constructor for SymphonyErrorPage sets it's class variables
*
* @param string|XMLElement $message
* A description for this error, which can be provided as a string
* or as an XMLElement.
* @param string $heading
* A heading for the error page, by default this is "Symphony Fatal Error"
* @param string $template
* A string for the error page template to use, defaults to 'generic'. This
* can be the name of any template file in the `TEMPLATES` directory.
* A template using the naming convention of `tpl.*.php`.
* @param array $additional
* Allows custom information to be passed to the Symphony Error Page
* that the template may want to expose, such as custom Headers etc.
* @param integer $status
* Properly sets the HTTP status code for the response. Defaults to
* `Page::HTTP_STATUS_ERROR`
*/
public function __construct($message, $heading = 'Symphony Fatal Error', $template = 'generic', array $additional = array(), $status = Page::HTTP_STATUS_ERROR)
{
if ($message instanceof XMLElement) {
$this->_messageObject = $message;
$message = $this->_messageObject->generate();
}
parent::__construct($message);
$this->_heading = $heading;
$this->_template = $template;
$this->_additional = (object)$additional;
$this->_status = $status;
}
/**
* Accessor for the `$_heading` of the error page
*
* @return string
*/
public function getHeading()
{
return $this->_heading;
}
/**
* Accessor for `$_messageObject`
*
* @return XMLElement
*/
public function getMessageObject()
{
return $this->_messageObject;
}
/**
* Accessor for `$_additional`
*
* @return StdClass
*/
public function getAdditional()
{
return $this->_additional;
}
/**
* Accessor for `$_status`
*
* @since Symphony 2.3.2
* @return integer
*/
public function getHttpStatusCode()
{
return $this->_status;
}
/**
* Returns the path to the current template by looking at the
* `WORKSPACE/template/` directory, then at the `TEMPLATES`
* directory for the convention `usererror.*.php`. If the template
* is not found, `false` is returned
*
* @since Symphony 2.3
* @return mixed
* String, which is the path to the template if the template is found,
* false otherwise
*/
public function getTemplate()
{
$format = '%s/usererror.%s.php';
if (file_exists($template = sprintf($format, WORKSPACE . '/template', $this->_template))) {
return $template;
} elseif (file_exists($template = sprintf($format, TEMPLATE, $this->_template))) {
return $template;
} else {
return false;
}
}
/**
* A simple getter to the template name in order to be able
* to identify which type of exception this is.
*
* @since Symphony 2.3.2
* @return string
*/
public function getTemplateName()
{
return $this->_template;
}
}
/**
* The `DatabaseExceptionHandler` provides a render function to provide
* customised output for database exceptions. It displays the exception
* message as provided by the Database.
*/
Class DatabaseExceptionHandler extends GenericExceptionHandler
{
/**
* The render function will take a `DatabaseException` and output a
* HTML page.
*
* @param Exception $e
* The Exception object
* @return string
* An HTML string
*/
public static function render(Exception $e)
{
$trace = $queries = null;
foreach ($e->getTrace() as $t) {
$trace .= sprintf(
'<li><code><em>[%s:%d]</em></code></li><li><code>    %s%s%s();</code></li>',
$t['file'],
$t['line'],
(isset($t['class']) ? $t['class'] : null),
(isset($t['type']) ? $t['type'] : null),
$t['function']
);
}