-
Notifications
You must be signed in to change notification settings - Fork 3
/
system.php
2043 lines (1852 loc) · 67.1 KB
/
system.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
/**
* Scavix Web Development Framework
*
* Copyright (c) 2007-2012 PamConsult GmbH
* Copyright (c) 2013-2019 Scavix Software Ltd. & Co. KG
* Copyright (c) since 2019 Scavix Software GmbH & Co. KG
*
* This library is free software; you can redistribute it
* and/or modify it under the terms of the GNU Lesser General
* Public License as published by the Free Software Foundation;
* either version 3 of the License, or (at your option) any
* later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>
*
* @author PamConsult GmbH http://www.pamconsult.com <[email protected]>
* @copyright 2007-2012 PamConsult GmbH
* @author Scavix Software Ltd. & Co. KG https://www.scavix.com <[email protected]>
* @copyright 2012-2019 Scavix Software Ltd. & Co. KG
* @author Scavix Software GmbH & Co. KG https://www.scavix.com <[email protected]>
* @copyright since 2019 Scavix Software GmbH & Co. KG
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
*/
define('FRAMEWORK_LOADED','uSI7hcKMQgPaPKAQDXg5');
define('__SCAVIXWDF__',__DIR__);
date_default_timezone_set("Europe/Berlin");
require_once(__DIR__.'/system_objects.php');
require_once(__DIR__.'/system_functions.php');
use ScavixWDF\Base\AjaxResponse;
use ScavixWDF\Base\Args;
use ScavixWDF\Base\Renderable;
use ScavixWDF\ICallable;
use ScavixWDF\Model\DataSource;
use ScavixWDF\Reflection\WdfReflector;
use ScavixWDF\Wdf;
use ScavixWDF\WdfException;
use ScavixWDF\WdfResource;
// Homebrew CLI args if missing
// see https://www.php.net/manual/en/ini.core.php#ini.register-argc-argv
if( !isset($argv) && isset($_SERVER['argv']) )
{
$argv = $_SERVER['argv'];
$argc = max(1,count($argv));
}
// Moved here from cli module to make sure SERVER var is same as in calling (apache env) process.
// This is needed to make all dependent configs/modules/... work as expected.
if( PHP_SAPI == 'cli' )
{
foreach( $argv as $i=>$a )
{
if( starts_iwith($a,'--wdf-extended-data') )
{
$datafile = substr($a,19);
$data = json_decode(@file_get_contents($datafile),true);
if( is_array($data) )
$_SERVER = array_merge($_SERVER,$data);
@unlink($datafile);
unset($argv[$i]);
break;
}
}
}
// Config handling
system_config_default( !defined("NO_DEFAULT_CONFIG") );
if( file_exists("config.php") )
system_config("config.php",false);
elseif( file_exists(__DIR__."/config.php") )
system_config(__DIR__."/config.php",false);
elseif( !defined("NO_CONFIG_NEEDED") )
system_die("No valid configuration found!");
/**
* Loads a config file.
*
* Should not be used if a config file is present in root path.
* @param string $filename Full path to the config file
* @param bool $reset_to_defaults If true resets the complete config to the one to read
* @return void
*/
function system_config($filename,$reset_to_defaults=true)
{
global $CONFIG;
if( $reset_to_defaults )
system_config_default();
detectEnvironment(dirname($filename));
require_once($filename);
}
/**
* Resets the global $CONFIG variable to defauls values.
*
* Just sets some useful default values. This is also a good reference of the basic system variables.
* @param bool $reset If true resets the config completely to default, extends/overwrites only if false
* @return void
* @suppress PHP0443
*/
function system_config_default($reset = true)
{
global $CONFIG;
# see http://www.php.net/manual/de/session.configuration.php
ini_set('session.hash_function',1);
ini_set('session.hash_bits_per_character',5);
if( $reset )
$CONFIG = [];
$CONFIG['class_path']['system'][] = __DIR__.'/reflection/';
$CONFIG['class_path']['system'][] = __DIR__.'/base/';
$CONFIG['class_path']['system'][] = __DIR__.'/tasks/';
$CONFIG['class_path']['content'][] = __DIR__.'/lib/';
$CONFIG['class_path']['content'][] = __DIR__.'/lib/controls/';
$CONFIG['class_path']['content'][] = __DIR__.'/lib/controls/listing/';
$CONFIG['class_path']['content'][] = __DIR__.'/lib/controls/form/';
$CONFIG['class_path']['content'][] = __DIR__.'/lib/controls/table/';
$CONFIG['class_path']['content'][] = __DIR__.'/lib/controls/locale/';
$CONFIG['class_path']['content'][] = __DIR__.'/lib/jquery-ui/';
$CONFIG['class_path']['content'][] = __DIR__.'/lib/jquery-ui/dialog/';
$CONFIG['class_path']['content'][] = __DIR__.'/lib/jquery-ui/slider/';
$CONFIG['class_path']['content'][] = __DIR__.'/lib/widgets/';
$CONFIG['class_path']['content'][] = __DIR__.'/lib/google/';
$CONFIG['class_path']['order'] = ['system','model','content'];
$CONFIG['system']['path_root'] = __DIR__;
$CONFIG['requestparam']['ignore_case'] = true;
$CONFIG['requestparam']['tagstostrip'] = ['script'];
$CONFIG['model']['internal']['auto_create_tables'] = true;
$CONFIG['model']['internal']['datasource_type'] = 'DataSource';
$CONFIG['model']['internal']['debug'] = false;
$CONFIG['system']['application_name'] = 'wdf_application';
$CONFIG['system']['cache_datasource'] = 'internal';
$CONFIG['system']['cache_ttl'] = 3600; // secs
$CONFIG['system']['hook_logging'] = false;
$CONFIG['system']['header']['Content-Type'] = "text/html; charset=utf-8";
$CONFIG['system']['header']['X-XSS-Protection'] = "1; mode=block";
$CONFIG['system']['header']["Referrer-Policy"] = "strict-origin-when-cross-origin";
$path = explode("index.php",$_SERVER['PHP_SELF']);
if(PHP_SAPI == 'cli')
$path = ['/'];
if( !isset($_SERVER['REQUEST_SCHEME']) )
$_SERVER['REQUEST_SCHEME'] = urlScheme(false);
if( !isset($_SERVER['HTTP_HOST']) )
$_SERVER['HTTP_HOST'] = '127.0.0.1';
if( !isset($_SERVER['REQUEST_URI']) )
$_SERVER['REQUEST_URI'] = '';
if(defined('IDNA_DEFAULT') && defined('INTL_IDNA_VARIANT_UTS46'))
{
/**
* Bug in PHP 7.2: INTL_IDNA_VARIANT_2003 is deprecated but used as default value @see: http://php.net/manual/de/migration72.deprecated.php
*/
$CONFIG['system']['url_root'] = idn_to_utf8("{$_SERVER['REQUEST_SCHEME']}://{$_SERVER['HTTP_HOST']}", IDNA_DEFAULT, INTL_IDNA_VARIANT_UTS46)."{$path[0]}";
$CONFIG['system']['same_page'] = idn_to_utf8("{$_SERVER['REQUEST_SCHEME']}://{$_SERVER['HTTP_HOST']}", IDNA_DEFAULT, INTL_IDNA_VARIANT_UTS46)."{$_SERVER['REQUEST_URI']}";
}
else
{
$CONFIG['system']['url_root'] = idn_to_utf8("{$_SERVER['REQUEST_SCHEME']}://{$_SERVER['HTTP_HOST']}")."{$path[0]}";
$CONFIG['system']['same_page'] = idn_to_utf8("{$_SERVER['REQUEST_SCHEME']}://{$_SERVER['HTTP_HOST']}")."{$_SERVER['REQUEST_URI']}";
}
$CONFIG['system']['modules'] = [];
$CONFIG['system']['default_page'] = \ScavixWDF\Base\HtmlPage::class;
$CONFIG['system']['default_event'] = false;
$CONFIG['system']['tpl_ext'] = array("tpl.php");
$CONFIG['system']['admin']['enabled'] = false;
$CONFIG['system']['admin']['username'] = false;
$CONFIG['system']['admin']['password'] = false;
}
/**
* Loads a module.
*
* Use this to manually load a module. You can also add it to the config so that
* system_init() loads it automatically.
* @param string $path_to_module Complete path to module file
* @return void
*/
function system_load_module($path_to_module)
{
// prevent double-loading:
$mod = basename($path_to_module,".php");
if( $mod == "mod_phpexcel" )
WdfException::Raise("PHPExcel module has bee removed. Use PhpSpreadsheet instead.");
if(system_is_module_loaded($mod))
return;
require($path_to_module);
$initfuncname = $mod."_init";
if( function_exists($initfuncname) )
$initfuncname();
execute_hooks(HOOK_POST_MODULE_INIT,array($mod));
// mark module loaded:
Wdf::$Modules[$mod] = $path_to_module;
}
/**
* Checks if a module is already loaded.
*
* Looks into `Wdf::$Modules` if there's a key named `$mod`.
* @param string $mod The name of the module (not the path!)
* @return bool true or false
*/
function system_is_module_loaded($mod)
{
return isset(Wdf::$Modules[$mod]);
}
/**
* Initializes the Scavix ScavixWDF.
*
* This is one of two essential functions you must know about.
* Initializes the complete ScavixWDF, loads all essentials and defined modules and initializes them,
* prepares the session and writes out some headers (from config too).
* @param string $application_name Application name. This will become your session cookie name!
* @param bool $skip_header Optional. If true, will not send headers.
* @param bool $logging_category An initial category for logging. Very optional!
* @return void
*/
function system_init($application_name, $skip_header = false, $logging_category=false)
{
global $CONFIG;
$thispath = __DIR__;
$CONFIG['system']['application_name'] = $application_name;
if(!isset($CONFIG['model']['internal']['connection_string']))
$CONFIG['model']['internal']['connection_string'] = 'sqlite::memory:';
// load essentials as if they were modules.
system_load_module('essentials/logging.php');
system_load_module('essentials/model.php');
system_load_module('essentials/session.php');
system_load_module('essentials/resources.php');
system_load_module('essentials/admin.php');
system_load_module('essentials/localization.php');
system_load_module('essentials/translation.php');
foreach( system_glob($thispath.'/essentials/*.php') as $essential ) // load all other essentials
system_load_module($essential);
// on posix systems: automatically load cli-module when we are actually in cli
if( PHP_SAPI=='cli' && !function_exists('cli_init') )
system_load_module('modules/cli.php');
if( $logging_category )
logging_add_category($logging_category);
session_run();
// auto-load all system-modules defined in $CONFIG['system']['modules']
foreach( $CONFIG['system']['modules'] as $mod )
{
if( file_exists($thispath."/modules/$mod.php") )
system_load_module($thispath."/modules/$mod.php");
elseif( file_exists( "$mod.php") )
system_load_module("$mod.php");
elseif( file_exists( "$mod") )
system_load_module("$mod");
}
if( isset($_REQUEST['request_id']) )
session_keep_alive();
// attach more headers here if required
if( !$skip_header && PHP_SAPI!='cli' )
{
try {
foreach( $CONFIG['system']['header'] as $k=>$v )
header("$k: $v");
} catch(Exception $ex) { log_debug($ex); }
}
// if $_SERVER['SCRIPT_URI'] is not set build from $_SERVER['SCRIPT_NAME'] and $_SERVER['SERVER_NAME'] Mantis #3477
if( ( !isset($_SERVER['SCRIPT_URI']) || $_SERVER['SCRIPT_URI'] == '' ) && isset($_SERVER['SCRIPT_NAME']) && isset($_SERVER['SERVER_NAME']) )
{
$_SERVER['SCRIPT_URI'] = $_SERVER['SERVER_NAME'].$_SERVER['SCRIPT_NAME'];
}
execute_hooks(HOOK_POST_INIT);
}
/**
* Parses the request and returns a controller/event pair (if present).
*
* Note that your .htaccess files must contain these lines:
* <code>
* SetEnv WDF_FEATURES_REWRITE on
* RewriteCond %{REQUEST_FILENAME} !-f
* RewriteCond %{REQUEST_FILENAME} !-d
* RewriteCond %{REQUEST_URI} !index.php
* RewriteRule (.*) index.php?wdf_route=$1 [L,QSA]
* </code>
* @return array
*/
function system_parse_request_path()
{
if( isset($_REQUEST['wdf_route']) )
{
// test for *.less request -> need to compile that to css
if( ends_iwith($_REQUEST['wdf_route'],".less") )
{
Wdf::$Request->RouteArgs = array($_REQUEST['wdf_route']);
$GLOBALS['routing_args'] = array($_REQUEST['wdf_route']); // compat
unset($_REQUEST['wdf_route']);
unset($_GET['wdf_route']);
return ['ScavixWDF\WdfResource','CompileLess'];
}
// now for the normal processing
if( isset($GLOBALS['CONFIG']['wdf_route_parser']) )
{
$path = $GLOBALS['CONFIG']['wdf_route_parser'];
$path = $path(explode("/",$_REQUEST['wdf_route']));
}
else
$path = explode("/",$_REQUEST['wdf_route']);
Wdf::$Request->Route = $path;
$GLOBALS['wdf_route'] = $path; // compat
unset($_REQUEST['wdf_route']);
unset($_GET['wdf_route']);
if( count($path)>0 )
{
if( $path[0]=='~' ) $path[0] = cfg_get('system','default_page');
$path[0] = fq_class_name($path[0]);
if( class_exists($path[0]) || in_object_storage($path[0]) )
{
$controller = $path[0];
if( count($path)>1 )
{
$offset = 2;
if( in_object_storage($path[0]) || system_method_exists($controller,$path[1]) )
$event = $path[1];
else
$offset = 1;
if( count($path)>$offset )
{
foreach( array_slice($path,$offset) as $ra )
if( $ra !== '' )
{
Wdf::$Request->RouteArgs[] = $ra;
$GLOBALS['routing_args'][] = $ra; // compat
}
}
}
}
}
}
if( !isset($controller) || !$controller )
{
$controller = Args::request('page', cfg_get('system','default_page')); // really oldschool
Wdf::$Request->UsingDefaultPage = true;
}
if( !isset($event) || !$event )
{
$event = Args::request('event', cfg_get('system','default_event')); // really oldschool
Wdf::$Request->UsingDefaultEvent = true;
}
$pattern = '/[^A-Za-z0-9\-_\\\\]/';
$controller = substr(preg_replace($pattern, "", $controller), 0, 256);
$event = substr(preg_replace($pattern, "", $event), 0, 256);
return [$controller,$event];
}
/**
* Instanciates the previously chosen controller
*
* Checks what is requested: and object from the object-store, a controller via classname and loads/instaciates it.
* Will also die in AJAX requests when something weird is called or throw an exception if in normal mode.
* @param mixed $controller_id Whatever system_parse_request_path() returned
* @return ICallable Fresh Instance of whatever is needed
*/
function system_instanciate_controller($controller_id)
{
if( in_object_storage($controller_id) )
$res = restore_object($controller_id);
elseif( class_exists($controller_id) )
$res = new $controller_id();
else
WdfException::Raise("ACCESS DENIED: Unknown controller '$controller_id'","REQ=",$_REQUEST);
if( system_is_ajax_call() )
{
if( !($res instanceof Renderable) && !($res instanceof WdfResource) )
{
log_fatal("ACCESS DENIED: $controller_id is no Renderable");
die("__SESSION_TIMEOUT__");
}
}
else if( !($res instanceof ICallable) )
WdfException::Raise("ACCESS DENIED: $controller_id is no ICallable");
return $res;
}
/**
* Executes the current request.
*
* This is the second of two essential functions.
* It runs the actual execution. If fact it is the only place where you will
* find an `echo` in the ScavixWDF code.
* @return void
*/
function system_execute()
{
session_sanitize();
execute_hooks(HOOK_POST_INITSESSION);
if( PHP_SAPI == 'cli' && function_exists('cli_execute') )
cli_execute();
// respond to PING requests that are sended to keep the session alive
if( Args::request('ping',false) )
{
session_update(true);
execute_hooks(HOOK_PING_RECIEVED);
die("PONG");
}
Args::strip_tags();
Wdf::$Request = new stdClass();
Wdf::$Request->URL = $GLOBALS['CONFIG']['system']['same_page'];
list($current_controller,$current_event) = system_parse_request_path();
Wdf::$Request->CurrentController = $current_controller;
Wdf::$Request->CurrentEvent = $current_event;
execute_hooks(HOOK_PRE_CONSTRUCT,array($current_controller,$current_event));
Wdf::$Request->CurrentController = $current_controller
= system_instanciate_controller($current_controller);
if( system_method_exists($current_controller,'__translate_event') )
$current_event = call_user_func([$current_controller,'__translate_event'],$current_event);
if( !(system_method_exists($current_controller,$current_event) ||
(system_method_exists($current_controller,'__method_exists') && $current_controller->__method_exists($current_event) )) )
{
Wdf::$Request->CurrentEvent = $current_event
= cfg_get('system','default_event');
}
if( !isset($GLOBALS['wdf_route']) ) // compat
$GLOBALS['wdf_route'] = array($current_controller,$current_event); // compat
if( !isset(Wdf::$Request->Route) )
Wdf::$Request->Route = array($current_controller,$current_event);
if( system_method_exists($current_controller,$current_event) ||
(system_method_exists($current_controller,'__method_exists') && $current_controller->__method_exists($current_event) ) )
{
$content = system_invoke_request($current_controller,$current_event,HOOK_PRE_EXECUTE);
}else $content = '';
@set_time_limit(ini_get('max_execution_time'));
system_exit($content,false);
}
/**
* Executes the given request.
*
* Will parse the target class/method for required parameters
* and prepare the data given in the $_REQUEST variable to match them.
* @param string $target_class Name of the class
* @param string $target_event Name of the method
* @param int $pre_execute_hook_type Type of Hook to be executed pre call
* @return mixed The result of the target-methods
*/
function system_invoke_request($target_class,$target_event,$pre_execute_hook_type)
{
$ref = WdfReflector::GetInstance($target_class);
$params = $ref->GetMethodAttributes($target_event,"RequestParam");
$args = [];
if( count($params) > 0 )
{
$argscheck = [];
$failedargs = [];
$req_data = array_merge($_FILES,$_GET,$_POST);
$last = max(array_keys($params));
foreach( $params as $i=>$prm )
{
$argscheck[$prm->Name] = $prm->UpdateArgs($req_data,$args,$i==$last);
if( $argscheck[$prm->Name] !== true )
{
$failedargs[$prm->Name] = "ARGUMENT FAILED";
$args[$prm->Name] = "ARGUMENT FAILED";
}
}
if( count($failedargs) > 0 )
execute_hooks(HOOK_ARGUMENTS_PARSED, $failedargs);
}
execute_hooks($pre_execute_hook_type,array($target_class,$target_event,$args));
return call_user_func_array(array(&$target_class,$target_event), array_values($args));
}
/**
* Terminats the current run and presents a result to the browser.
*
* @param mixed $result The result that shall be passed to the browser
* @param bool $die If true uses <die>() for output, else uses <echo>()
* @return void
*/
function system_exit($result=null,$die=true)
{
execute_hooks(HOOK_POST_EXECUTE);
if( !isset($result) || !$result )
$result = current_controller(false);
$response = '';
if( PHP_SAPI == 'cli' )
die("Missing CLI handling, cannot render HTML here\n");
if( system_is_ajax_call() )
{
if( $result instanceof AjaxResponse )
$response = $result->Render();
elseif( $result instanceof ScavixWDF\Base\HtmlPage )
{
// use this to redirect if some previous AJAX redirect should have in fact been redirected to an HTML page.
log_error("Cannot deliver HtmlPage via AJAX, redirecting instead:",system_current_request());
$response = AjaxResponse::Redirect(system_current_request(true))->Render();
}
elseif( $result instanceof Renderable )
$response = AjaxResponse::Renderable($result)->Render();
elseif( !is_string($result) )
WdfException::Raise("Unknown AJAX return value",$result);
else
$response = $result;
}
elseif( $result instanceof AjaxResponse ) // is system_is_ajax_call() failed to detect AJAX but response in fact IS for AJAX
die("__SESSION_TIMEOUT__");
else
{
$_SESSION['request_id'] = request_id();
$_SESSION['latest_requests'][$_SESSION['request_id']] = [current_controller(),current_event(),$_GET,$_POST];
while( count($_SESSION['latest_requests']) > 20 )
array_shift($_SESSION['latest_requests']);
if( $result instanceof Renderable)
{
$response = $result->WdfRenderAsRoot();
if( $result->_translate && system_is_module_loaded("translation") )
$response = __translate($response);
}
elseif( system_is_module_loaded("translation") )
$response = __translate($result);
}
if( function_exists('translation_add_unknown_strings') )
translation_add_unknown_strings();
if( function_exists('model_store') )
model_store();
if( function_exists('session_update') )
session_update();
execute_hooks(HOOK_PRE_FINISH, [$response]);
if( $die )
die($response);
echo $response;
}
/**
* Terminats the current run.
*
* Will be called from exception and error handlers. You may, call this directly, but we
* recommend to throw an exception instead. See the WdfException class and it's Raise() method
* for more about this.
* Note: This function will call `system_exit()`!
* @param string $reason The reason as human readable and hopefully understandable text
* @param string $details_internal More details to be logged
* @param bool $log_error If true logs error to files, else just die
* @return void
*/
function system_die($reason,$details_internal='',$log_error=true)
{
$details_internal = '';
if( $reason instanceof Exception )
{
$stacktrace = ($reason instanceof WdfException)?$reason->getTraceEx():$reason->getTrace();
$details_internal = (($reason instanceof WdfException) && avail($reason, 'details'))?"\n".$reason->details:'';
$reason = logging_render_var($reason);
}
if( !isset($stacktrace) )
$stacktrace = debug_backtrace();
$errid = uniqid();
if( $log_error )
{
if( function_exists('log_fatal') )
log_fatal('Fatal system error (ErrorID: '.$errid.')'."\n".$reason.$details_internal."\n".system_stacktrace_to_string($stacktrace));
else
error_log('Fatal system error (ErrorID: '.$errid.')'."\n".$reason.$details_internal."\n".system_stacktrace_to_string($stacktrace));
}
if( isset(Wdf::$Hooks[HOOK_SYSTEM_DIE]) && count(Wdf::$Hooks[HOOK_SYSTEM_DIE]) > 0 )
{
execute_hooks(HOOK_SYSTEM_DIE,array(
$reason,
$stacktrace
));
}
if( PHP_SAPI == 'cli' )
{
if(isDev())
$res = 'Fatal system error (ErrorID: '.$errid.')'."\n".$reason.$details_internal."\n".system_stacktrace_to_string($stacktrace);
else
$res = 'Oh no! A fatal system error occured. Please try again. Contact our technical support if this problem occurs again (ErrorID: '.$errid.')';
system_exit("$res\n");
}
elseif( system_is_ajax_call() )
{
if(isDev())
$res = AjaxResponse::Error('Fatal system error (ErrorID: '.$errid.')'."\n".$reason.$details_internal."\n".system_stacktrace_to_string($stacktrace),true);
else
$res = AjaxResponse::Error('Oh no! A fatal system error occured. Please try again. Contact our technical support if this problem occurs again (ErrorID: '.$errid.')',true);
system_exit($res->Render());
}
else
{
$res = "<html><head><style> * { font-family: Arial,sans-serif; } body { margin: 20px; } </style><title>Fatal system error</title></head>";
$res .= "<body>";
$res .= "<h1>Oh no! A fatal system error occured... :-(</h1>";
if(isDev())
$res .= "Error ID: {$errid}<br/><pre>$reason</pre>".($details_internal ? "<pre>$details_internal</pre>" : '')."<pre>".system_stacktrace_to_string($stacktrace)."</pre>";
else
$res .= "<br/>Please try again.<br/>Contact our technical support if this problem occurs again (ErrorID: {$errid}).<br/><br/>Apologies for any inconveniences this may have caused you.";
$res .= "</body></html>";
system_exit($res);
}
}
/**
* Terminates script execution and delivers valid HTTP header information.
*
* @param mixed $code The HTTP status code to be delivered, @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
* @return void
*/
function system_die_http($code)
{
static $codes = [
100 => "Continue",
101 => "Switching Protocols",
102 => "Processing",
103 => "Early Hints",
200 => "OK",
201 => "Created",
202 => "Accepted",
203 => "Non Authoritative Information",
204 => "No Content",
205 => "Reset Content",
206 => "Partial Content",
207 => "Multi-Status",
300 => "Multiple Choices",
301 => "Moved Permanently",
302 => "Moved Temporarily",
303 => "See Other",
304 => "Not Modified",
305 => "Use Proxy",
307 => "Temporary Redirect",
308 => "Permanent Redirect",
400 => "Bad Request",
401 => "Unauthorized",
402 => "Payment Required",
403 => "Forbidden",
404 => "Not Found",
405 => "Method Not Allowed",
406 => "Not Acceptable",
407 => "Proxy Authentication Required",
408 => "Request Timeout",
409 => "Conflict",
410 => "Gone",
411 => "Length Required",
412 => "Precondition Failed",
413 => "Request Entity Too Large",
414 => "Request-URI Too Long",
415 => "Unsupported Media Type",
416 => "Requested Range Not Satisfiable",
417 => "Expectation Failed",
418 => "I'm a teapot",
419 => "Insufficient Space on Resource",
420 => "Method Failure",
421 => "Misdirected Request",
422 => "Unprocessable Entity",
423 => "Locked",
424 => "Failed Dependency",
426 => "Upgrade Required",
428 => "Precondition Required",
429 => "Too Many Requests",
431 => "Request Header Fields Too Large",
451 => "Unavailable For Legal Reasons",
500 => "Internal Server Error",
501 => "Not Implemented",
502 => "Bad Gateway",
503 => "Service Unavailable",
504 => "Gateway Timeout",
505 => "HTTP Version Not Supported",
507 => "Insufficient Storage",
511 => "Network Authentication Required",
];
$protocol = ifavail($_SERVER, 'SERVER_PROTOCOL') ?: 'HTTP/1.1';
header("$protocol $code " . (ifavail($codes, $code) ?: 'Unknown'), true, $code);
die();
}
/**
* Registers a function to be executed on a system hook.
*
* Note that this registers a function! If you want an objects method to be executed, see `register_hook()`.
* @param int $type Valid hook type (see the HOOK_* constants)
* @param string|\Closure $handler_method name of function to call
* @param bool $prepend If true will prepend, else will append
* @return void
*/
function register_hook_function($type,$handler_method,$prepend=false)
{
$dummy = false;
register_hook($type,$dummy,$handler_method,$prepend);
}
/**
* Registers a method to be executed on a system hook.
*
* Note that this registers an objects method! If you want function to be executed, see `register_hook_function()`.
* @param int $type Valid hook type (see the HOOK_* constants)
* @param object $handler_obj The object containig the handler method
* @param string $handler_method name of method to call
* @param bool $prepend If true will prepend, else will append
* @return void
*/
function register_hook($type,&$handler_obj,$handler_method,$prepend=false)
{
if( !isset(Wdf::$Hooks[$type]) )
Wdf::$Hooks[$type] = [];
is_valid_hook_type($type);
if( $prepend )
array_unshift(Wdf::$Hooks[$type],[$handler_obj, $handler_method]);
else
Wdf::$Hooks[$type][] = [$handler_obj, $handler_method];
}
/**
* Removes previously registered hook handler from all hook types.
*
* This is automatically called when content is removed from <Renderable> objects to avoid performing actions on objects that are not part
* of the DOM anymore.
* @param object $handler_obj The object taht shall be removed from the hanlder stack
* @return void
*/
function release_hooks($handler_obj)
{
foreach( Wdf::$Hooks as $type=>$stack )
foreach( $stack as $i=>$def )
if( is_array($def) && ($def[0] == $handler_obj) )
unset( Wdf::$Hooks[$type][$i] );
foreach( Wdf::$Hooks as $type=>$stack )
Wdf::$Hooks[$type] = array_values($stack);
}
/**
* Executes a system hook (calls all registered handlers).
*
* This is very internal, but no magic: just loops all registered handlers and calls them.
* Arguments given vary from hook_type to hook_type.
* @param int $type Valid hook type (see the HOOK_* constants)
* @param array $arguments to be passed to the handler functions/methods
* @return void
*/
function execute_hooks($type,$arguments = [])
{
global $CONFIG;
Wdf::$Hooks['fired'][$type] = $type;
if( !isset(Wdf::$Hooks[$type]) )
return;
is_valid_hook_type($type);
$loghooks = $CONFIG['system']['hook_logging'];
if( $loghooks )
log_debug("BEGIN ".hook_type_to_string($type));
// note: as hooks may be added to the chain do not remove the count(...) here: it may grow!
for($i=0; $i<count(Wdf::$Hooks[$type]); $i++)
{
list($hook0,$hook1) = Wdf::$Hooks[$type][$i];
if( is_object($hook0) )
{
if( $loghooks )
log_debug( "Executing ".get_class($hook0)."->".$hook1."(...)",hook_type_to_string($type) );
$res = $hook0->$hook1($arguments);
if( $loghooks )
log_debug( "result:",$res);
}
else
{
if( $loghooks )
if( is_string($hook1) )
log_debug( "Executing '".$hook1."(...)'",hook_type_to_string($type) );
else
log_debug( "Executing 'Closure(...)'",hook_type_to_string($type) );
$res = $hook1($arguments);
}
if( $res === false )
{
if( $loghooks )
log_debug("ABORT ".hook_type_to_string($type));
break;
}
}
if( $loghooks )
log_debug("END ".hook_type_to_string($type));
}
/**
* Checks if a given int is a valid hook type.
*
* Checks a given integer if it represents a valid hook_type.
* @param int $type Value to be checked against valid hook type (see the HOOK_* constants)
* @return bool true if valid
*/
function is_valid_hook_type($type)
{
if( $type == HOOK_POST_INIT || $type == HOOK_POST_INITSESSION || $type == HOOK_PRE_CONSTRUCT ||
$type == HOOK_PRE_EXECUTE || $type == HOOK_POST_EXECUTE ||
$type == HOOK_PRE_FINISH || $type == HOOK_POST_MODULE_INIT ||
$type == HOOK_PING_RECIEVED || $type == HOOK_SYSTEM_DIE || $type == HOOK_PRE_RENDER ||
$type == HOOK_ARGUMENTS_PARSED
)
return true;
WdfException::Raise("Invalid hook type ($type)!");
return false;
}
/**
* Returns the string representation of an int hook type.
*
* In fact just returns the constant name as a string, so
* <code php>
* echo (hook_type_to_string(HOOK_POST_INIT) == 'HOOK_POST_INIT')?'true':'false';
* // output: true
* </code>
* @param int $type Hook type
* @return string Type as string or 'HOOK_UNDEFINED' if $type is not a valid hook type
*/
function hook_type_to_string($type)
{
switch( $type )
{
case HOOK_POST_INIT: return 'HOOK_POST_INIT';
case HOOK_POST_INITSESSION: return 'HOOK_POST_INITSESSION';
case HOOK_PRE_CONSTRUCT: return 'HOOK_PRE_CONSTRUCT';
case HOOK_PRE_EXECUTE: return 'HOOK_PRE_EXECUTE';
case HOOK_POST_EXECUTE: return 'HOOK_POST_EXECUTE';
case HOOK_PRE_FINISH: return 'HOOK_PRE_FINISH';
case HOOK_POST_MODULE_INIT: return 'HOOK_POST_MODULE_INIT';
case HOOK_PING_RECIEVED: return 'HOOK_PING_RECIEVED';
case HOOK_SYSTEM_DIE: return 'HOOK_SYSTEM_DIE';
case HOOK_PRE_RENDER: return "HOOK_PRE_RENDER";
case HOOK_ARGUMENTS_PARSED: return 'HOOK_ARGUMENTS_PARSED';
}
return 'HOOK_UNDEFINED';
}
/**
* Checks if the hook of the given type is already fired
*
* Sometimes you'll need to know the step of the current execution. You may use this function
* to check which hooks have already been fired.
* @param int $type Hook Type
* @return bool true|bool
*/
function hook_already_fired($type)
{
if( isset(Wdf::$Hooks['fired']) && isset(Wdf::$Hooks['fired'][$type]) )
return true;
return false;
}
/**
* Checks if there is a handler bound to a HOOK
*
* Checks if there's at least one handler registered for the hook
* @param int $type Hook Type
* @return bool true|bool
*/
function hook_bound($type)
{
return isset(Wdf::$Hooks[$type]) && count(Wdf::$Hooks[$type]) > 0;
}
/**
* Returns a string representation of the given stacktrace
*
* This is kind of internal, but may be of use. We shift the stacktrace a bit to have more information
* in each line that belong together.
* @param array $stacktrace Use debug_backtrace() to get this
* @return string The stacktrace-string
*/
function system_stacktrace_to_string($stacktrace)
{
$stack = [];
$stcnt = count($stacktrace);
for($i=1; $i<=$stcnt; $i++)
{
$t0 = $stacktrace[$i-1];
$t1 = isset($stacktrace[$i]) ? $stacktrace[$i] : array("function" => "");
if( isset($t1['class']) && isset($t1['type']) )
$function = $t1['class'].$t1['type'].$t1['function'];
else
$function = $t1['function'];
if( isset($t0['file']) && isset($t0['line']) )
{
$rp_file = $t0['file'];
$stack[] = sprintf("+ %s(...) [in %s:%s]",$function,$rp_file,$t0['line']);
}
elseif($function)
$stack[] = sprintf("+ %s(...)",$function);
}
return implode("\n",$stack);
}
/**
* Sets a specific key of the classpath array to be searched first.
* @param string $key_to_priorize the key to be priorized
* @return array The classpath array before reordering
*/
function __priorize_classpath($key_to_priorize)
{
global $CONFIG;
$cp = $CONFIG['class_path']['order'];
$CONFIG['class_path']['order'] = array($key_to_priorize);
foreach( $cp as &$cp_item )
if( $CONFIG['class_path']['order'] != $key_to_priorize )
$CONFIG['class_path']['order'][] = $cp_item;
return $cp;
}
/**
* Sets the classpath search order.
* @param array The new classpath order.
*/
function __set_classpath_order($class_path_order)
{
global $CONFIG;
$CONFIG['class_path']['order'] = $class_path_order;
}
/**
* Called whenever a class shall be instanciated but there's no definition found
*
* See http://www.php.net/manual/de/function.spl-autoload-register.php
* @param string $class_name Name of the class to load
* @return void
*/
function system_spl_autoload($class_name)
{