-
Notifications
You must be signed in to change notification settings - Fork 0
/
px.php
2354 lines (2152 loc) · 85.3 KB
/
px.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
/**
* Pickles 2
*/
namespace picklesFramework2;
/**
* Pickles 2 core class
*
* @author Tomoya Koyanagi <tomk79@gmail.com>
*/
class px{
/**
* Pickles 2 のホームディレクトリのパス
* @access private
*/
private $realpath_homedir;
/**
* コンテンツディレクトリのパス
* @access private
*/
private $path_content;
/**
* オブジェクト
* @access private
*/
private $conf, $fs, $req, $site, $bowl, $pxcmd;
/**
* ディレクトリインデックス(省略できるファイル名の一覧)
* @access private
*/
private $directory_index = array();
/**
* プロセス関連情報
* @access private
*/
private $proc_type, $proc_id, $proc_num = 0;
/**
* HTTP Response Header List
*/
private $response_headers = array(
"Content-type" => array("text/html")
);
/**
* 関連ファイルのURL情報
* @access private
*/
private $relatedlinks = array();
/**
* エラーメッセージ情報
*/
private $errors = array();
/**
* 言語コード
*/
private $lang = null;
/**
* 応答ステータスコード
* @access private
*/
private $response_status = 200;
/**
* 応答ステータスメッセージ
* @access private
*/
private $response_message = 'OK';
/**
* 動的に追加されたプロパティ
*
* NOTE: Pickles Framework v2.1.14 で追加されました。
*
* @access private
*/
private $custom_dynamic_property = array();
/**
* Pickles Framework のバージョン番号を取得する。
*
* Pickles Framework のバージョン番号はこのメソッドにハードコーディングされます。
*
* バージョン番号発行の規則は、 Semantic Versioning 2.0.0 仕様に従います。
* - [Semantic Versioning(英語原文)](http://semver.org/)
* - [セマンティック バージョニング(日本語)](http://semver.org/lang/ja/)
*
* *[開発版]*<br />
* バージョン番号が振られていない、開発途中のリビジョンを、開発版と呼びます。<br />
* 開発版の場合、バージョン番号は、次のリリースが予定されているバージョン番号に、
* ビルドメタデータ `+dev` を付加します。
* 通常は、プレリリース記号 `alpha` または `beta` を伴うようにします。
* - 例：1.0.0-beta.12+dev (=1.0.0-beta.12リリース前の開発版)
*
* @return string バージョン番号を示す文字列
*/
public function get_version(){
// v2.1系(v2.1.0 とそれ以降) と、v2.0系(v2.0.50 とそれ以降) は、
// 対応するPHPのバージョンが異なる以外の仕様は基本的に同じままメンテナンスを継続するため、
// 同一のバージョンとして扱うことができる。
// 便宜上、 v2.1系 の番号で代表して示す。
return '2.1.16';
}
/**
* Constructor
*
* @param string $path_homedir Pickles のホームディレクトリのパス
*/
public function __construct( $path_homedir ){
// initialize PHP
if( !extension_loaded( 'mbstring' ) ){
trigger_error('mbstring not loaded.');
}
@ini_set( 'default_charset' , 'UTF-8' );
@ini_set( 'internal_encoding' , 'UTF-8' );
@ini_set( 'input_encoding' , 'UTF-8' );
@ini_set( 'output_encoding' , 'UTF-8' );
if( is_callable('mb_internal_encoding') ){
mb_internal_encoding('UTF-8');
}
if( is_callable('mb_detect_order') ){
mb_detect_order( 'UTF-8,SJIS-win,cp932,eucJP-win,SJIS,EUC-JP,JIS,ASCII' );
}
@ini_set( 'session.use_strict_mode' , '1' ); // NOTE: Pickles Framework v2.1.13 で追加
@ini_set( 'session.cookie_secure' , '1' ); // NOTE: Pickles Framework v2.1.12 で追加
@ini_set( 'session.cookie_httponly' , '1' ); // NOTE: Pickles Framework v2.1.11 で追加
@header_remove('X-Powered-By');
$this->set_status(200);// 200 OK
if( realpath('/') !== '/' ) {
// Windows + PHP7 で CSV を正しく読み込めない問題への対策。
// Windows では、 ja_JP.UTF-8 ロケールが正しく受け付けられない問題がある。
// 代わりに、Cロケールを設定することで回避できる。
setlocale(LC_CTYPE, 'C');
}
if( !array_key_exists( 'REMOTE_ADDR' , $_SERVER ) ){
// commandline only
if( realpath($_SERVER['SCRIPT_FILENAME']) === false ||
dirname(realpath($_SERVER['SCRIPT_FILENAME'])) !== realpath('./')
){
if( array_key_exists( 'PWD' , $_SERVER ) && is_file($_SERVER['PWD'].'/'.$_SERVER['SCRIPT_FILENAME']) ){
$_SERVER['SCRIPT_FILENAME'] = realpath($_SERVER['PWD'].'/'.$_SERVER['SCRIPT_FILENAME']);
}else{
// for Windows
// .px_execute.php で chdir(__DIR__) されていることが前提。
$_SERVER['SCRIPT_FILENAME'] = realpath('./'.basename($_SERVER['SCRIPT_FILENAME']));
}
}
}
if( !array_key_exists( 'REQUEST_METHOD' , $_SERVER ) ){
// REQUEST_METHOD が存在しない場合、文字列 `GET` で初期化する。
$_SERVER['REQUEST_METHOD'] = 'GET';
}
if( !array_key_exists( 'HTTP_USER_AGENT' , $_SERVER ) ){
// HTTP_USER_AGENT が存在しない場合、空白文字列で初期化する。
$_SERVER['HTTP_USER_AGENT'] = '';
}
// load Config
$this->realpath_homedir = $path_homedir;
if( is_file($this->realpath_homedir.DIRECTORY_SEPARATOR.'config.json') ){
$this->conf = json_decode( file_get_contents( $this->realpath_homedir.DIRECTORY_SEPARATOR.'config.json' ) );
}elseif( is_file($this->realpath_homedir.DIRECTORY_SEPARATOR.'config.php') ){
$this->conf = include( $this->realpath_homedir.DIRECTORY_SEPARATOR.'config.php' );
}
if( !is_object($this->conf) ){
$this->conf = (object) $this->conf;
}
if( !property_exists($this->conf, 'paths_enable_sitemap') || !is_array($this->conf->paths_enable_sitemap) ){
// sitemap のロードを有効にするべきパス。
$this->conf->paths_enable_sitemap = array(
'*.html',
'*.htm',
);
}
if ( property_exists($this->conf, 'default_timezone') && strlen($this->conf->default_timezone ?? "") ) {
date_default_timezone_set($this->conf->default_timezone);
}
if ( !property_exists($this->conf, 'default_lang') || !strlen($this->conf->default_lang ?? "") ) {
$this->conf->default_lang = 'ja';
}
if ( !property_exists($this->conf, 'accept_langs') || !is_array($this->conf->accept_langs) ) {
$this->conf->accept_langs = array($this->conf->default_lang);
}
if ( !property_exists($this->conf, 'path_files') || ( !is_callable($this->conf->path_files) && !strlen($this->conf->path_files ?? "") ) ) {
$this->conf->path_files = '{$dirname}/{$filename}_files/';
}
if ( !property_exists($this->conf, 'copyright') || !strlen($this->conf->copyright ?? "") ) {
// NOTE: 2016-03-15 $conf->copyright 追加
// 古い環境で Notice レベルのエラーが出る可能性があることを考慮し、初期化する。
$this->conf->copyright = null;
}
if( !property_exists($this->conf, 'path_phpini') ){
$this->conf->path_phpini = null;
}
if( !property_exists($this->conf, 'commands') ){
$this->conf->commands = null;
}
if( !property_exists($this->conf->commands, 'php') ){
$this->conf->commands->php = null;
}
// make instance $bowl
$this->bowl = new bowl();
// Apply command-line option "--command-php"
$req_conf = new \stdClass;
$req_conf->session_name = $this->conf->session_name ?? 'PXSID';
$req_conf->session_expire = $this->conf->session_expire ?? (24 * 60 * 60);
$req_conf->cookie_default_expire = $this->conf->cookie_default_expire ?? (7 * 24 * 60 * 60);
$req_conf->cookie_default_domain = $this->conf->cookie_default_domain ?? null;
$req_conf->cookie_default_path = $this->conf->cookie_default_path ?? $this->conf->path_controot ?? '/';
$temporary_req = new \tomk79\request( $req_conf );
if( strlen($temporary_req->get_cli_option( '--command-php' ) ?? "") ){
$this->conf->commands->php = $temporary_req->get_cli_option( '--command-php' );
}
if( strlen($temporary_req->get_cli_option( '-c' ) ?? "") ){
$this->conf->path_phpini = $temporary_req->get_cli_option( '-c' );
}
if( strlen($temporary_req->get_cli_option( '--method' ) ?? "") ){
$_SERVER['REQUEST_METHOD'] = strtoupper($temporary_req->get_cli_option( '--method' ));
}
if( strtoupper($_SERVER['REQUEST_METHOD']) == "POST" ){
$tmp_body_file = $temporary_req->get_cli_option( '--body-file' );
if( strlen($tmp_body_file ?? "") ){
// ファイルからPOSTパラメータを読み取る
if( is_file($this->realpath_homedir.'/_sys/ram/data/'.$tmp_body_file) ){
// 先に _sys/ram/data/ の中を探す
parse_str(file_get_contents( $this->realpath_homedir.'/_sys/ram/data/'.$tmp_body_file ), $_POST);
}elseif( is_file($tmp_body_file) ){
// なければ、絶対パスとして探す
parse_str(file_get_contents( $tmp_body_file ), $_POST);
}
}elseif( strlen($temporary_req->get_cli_option( '--body' ) ?? "") ){
// POSTパラメータを直接受け取る
parse_str($temporary_req->get_cli_option( '--body' ), $_POST);
}
unset($tmp_body_file);
}
// make instance $fs
$fs_conf = new \stdClass;
$fs_conf->file_default_permission = $this->conf->file_default_permission;
$fs_conf->dir_default_permission = $this->conf->dir_default_permission;
$fs_conf->filesystem_encoding = $this->conf->filesystem_encoding;
$this->fs = new \tomk79\filesystem( $fs_conf );
$this->realpath_homedir = $this->fs()->get_realpath($this->realpath_homedir.'/');
$this->realpath_homedir = $this->fs()->normalize_path($this->realpath_homedir);
// Re-make instance $req
$req_conf->directory_index_primary = $this->get_directory_index_primary();
$this->req = new \tomk79\request( $req_conf );
if( strlen($this->req->get_cli_option( '-u' ) ?? "") ){
$_SERVER['HTTP_USER_AGENT'] = $this->req->get_cli_option( '-u' ) ?? null;
}
if(!count($_GET)){
$tmp_cli_params = $this->req->get_cli_params();
if( count($tmp_cli_params) ){
$tmp_path = $tmp_cli_params[count($tmp_cli_params)-1];
if( preg_match( '/^\//', $tmp_path ) ){
$tmp_path = parse_url($tmp_path);
if( is_array($tmp_path) && array_key_exists('query', $tmp_path) ){
parse_str( $tmp_path['query'], $tmp_query );
if( is_array($tmp_query) ){
$_GET = array_merge( $_GET, $tmp_query );
}
}
}
}
unset( $tmp_cli_params, $tmp_path, $tmp_query );
}
if(!count($_REQUEST)){
$_REQUEST = $this->req->get_all_params();
}
// 言語設定を決める
$this->lang = $this->conf->default_lang;
$tmp_param_lang = $this->req->get_param("LANG");
$tmp_cookie_lang = $this->req->get_cookie("LANG");
if( strlen( $tmp_param_lang ?? "" ) && ( $tmp_param_lang == $this->conf->default_lang || array_search( $tmp_param_lang, $this->conf->accept_langs ) !== false ) ){
$this->lang = $tmp_param_lang;
$this->req->set_cookie("LANG", $tmp_param_lang);
}elseif( strlen($tmp_cookie_lang ?? "") ){
$this->lang = $tmp_cookie_lang;
}
// 公開キャッシュフォルダが存在しない場合、作成する
if( property_exists($this->conf, 'public_cache_dir') && strlen($this->conf->public_cache_dir ?? "") && !is_dir( './'.$this->conf->public_cache_dir ) ){
$this->fs()->mkdir( './'.$this->conf->public_cache_dir );
}
// _sysフォルダが存在しない場合、作成する
foreach( array(
'/_sys/',
'/_sys/ram/',
'/_sys/ram/applock/',
'/_sys/ram/caches/',
'/_sys/ram/data/',
'/_sys/ram/publish/'
) as $tmp_path_sys_dir ){
if( strlen($this->realpath_homedir.$tmp_path_sys_dir ?? "") && !is_dir( $this->realpath_homedir.$tmp_path_sys_dir ) ){
$this->fs()->mkdir( $this->realpath_homedir.$tmp_path_sys_dir );
}
}
// 環境変数 `$_SERVER['DOCUMENT_ROOT']` をセット
// `$px->get_realpath_docroot()` は、`$conf`, `$fs` を参照するので、
// これらの初期化の後が望ましい。
if( !strlen( $_SERVER['DOCUMENT_ROOT'] ?? "" ) ){
// commandline only
$_SERVER['DOCUMENT_ROOT'] = $this->get_realpath_docroot();
$_SERVER['DOCUMENT_ROOT'] = realpath( $_SERVER['DOCUMENT_ROOT'] );
}
// デフォルトの Content-type を出力
$this->header('Content-type: '.$this->get_default_mime_type());
// ignore されたコンテンツをレスポンスする
$fnc_response_ignore = function($px){
$px->set_status(403);// 403 Forbidden
print 'ignored path';
exit;
};
// pass 判定されたコンテンツをレスポンスする
$fnc_response_pass = function($px){
if( !$px->fs()->is_file( './'.$px->req()->get_request_file_path() ) ){
$px->header('Content-type: text/html');
$px->set_status(404);// 404 NotFound
$px->bowl()->send('<p>404 - File not found.</p>');
return true;
}
$src = $px->fs()->read_file( './'.$px->req()->get_request_file_path() );
$px->bowl()->send($src);
return true;
};
$pxcmd = $this->get_px_command();
if( is_null($pxcmd) || !count($pxcmd) ){
// PXコマンドが無効かつ ignore か pass の場合、
// この時点でレスポンスを返す。
if( $this->is_ignore_path( $this->req()->get_request_file_path() ) ){
// ignore のレスポンス
$fnc_response_ignore($this);
return;
}
if( $this->get_path_proc_type( $this->req()->get_request_file_path() ) === 'pass' ){
// pass のレスポンス
$fnc_response_pass($this);
return;
}
}
// make instance $pxcmd
$this->pxcmd = new pxcmd($this);
if( !array_key_exists( 'REMOTE_ADDR' , $_SERVER ) ){
// REMOTE_ADDR が存在しない場合、nullで初期化する。
// `$req` より先に初期化すると壊れます。
$_SERVER['REMOTE_ADDR'] = null;
}
// funcs: Before sitemap
$this->fnc_call_plugin_funcs( $this->conf->funcs->before_sitemap ?? null, $this );
// make instance $site
$is_enable_sitemap = $this->is_path_enable_sitemap( $this->req()->get_request_file_path() );
if( is_object( $this->site ) ){
// 既にセットされている場合はそのまま利用する
}elseif( $is_enable_sitemap ){
$this->site = new site($this);
}else{
$this->site = false;
}
// コンテンツファイルのパスと処理タイプを求める
// $this->conf->funcs->before_content の処理前に、暫定計算しておく。
list($this->path_content, $this->proc_type) = $this->assemble_path_content_and_proc_type();
// funcs: Before contents
if( isset( $this->conf->funcs->before_content ) ){
$this->fnc_call_plugin_funcs( $this->conf->funcs->before_content, $this );
}
// コンテンツファイルのパスと処理タイプを求める (再計算)
// $this->conf->funcs->before_content の処理を受けて再計算する
list($this->path_content, $this->proc_type) = $this->assemble_path_content_and_proc_type();
// PXコマンドが有効、かつ ignore か pass の場合、
// この時点でレスポンスを返す。
// ここまでの before sitemap, before contents でレスポンスされた場合は、ここは通らない。
if( $this->is_ignore_path( $this->req()->get_request_file_path() ) ){
// ignore のレスポンス
$fnc_response_ignore($this);
return;
}
if( $this->get_path_proc_type( $this->req()->get_request_file_path() ) === 'pass' ){
// pass のレスポンス
$fnc_response_pass($this);
return;
}
// execute content
self::exec_content( $this );
// funcs: process functions
if( isset( $this->conf->funcs->processor->{$this->proc_type} ) ){
$this->fnc_call_plugin_funcs( $this->conf->funcs->processor->{$this->proc_type}, $this );
}
// funcs: Before output
if( isset( $this->conf->funcs->before_output ) ){
$this->fnc_call_plugin_funcs( $this->conf->funcs->before_output, $this );
}
}
/**
* $path_content を計算する
*
* @return array $path_content, $proc_type
*/
private function assemble_path_content_and_proc_type(){
$path_content = $this->req()->get_request_file_path();
$ext = $this->get_path_proc_type( $this->req()->get_request_file_path() );
if($ext !== 'direct' && $ext !== 'pass'){
if( is_object($this->site) ){
$current_page_info = $this->site()->get_page_info( $this->req()->get_request_file_path() );
$path_content = null;
if( is_array($current_page_info) && array_key_exists('content', $current_page_info) ){
$path_content = $current_page_info['content'];
}
if( is_null( $path_content ) ){
$path_content = $this->req()->get_request_file_path();
}
unset($current_page_info);
}
}
foreach( array_keys( get_object_vars( $this->conf->funcs->processor ) ) as $tmp_ext ){
if( $this->fs()->is_file( './'.$path_content.'.'.$tmp_ext ) ){
$ext = $tmp_ext;
$path_content = $path_content.'.'.$tmp_ext;
break;
}
}
$proc_type = $ext;
unset($ext);
return array($path_content, $proc_type);
}
/**
* 動的なプロパティを登録する
*
* NOTE: Pickles Framework v2.1.14 で追加されました。
*/
public function __set( $name, $property ){
if( isset($this->custom_dynamic_property[$name]) ){
$this->error('$px->'.$name.' is already registered.');
return;
}
$this->custom_dynamic_property[$name] = $property;
return;
}
/**
* 動的に追加されたプロパティを取り出す
*
* NOTE: Pickles Framework v2.1.14 で追加されました。
*/
public function __get( $name ){
return $this->custom_dynamic_property[$name] ?? null;
}
/**
* Destructor
* @return null
*/
public function __destruct(){
if(is_callable(array($this->site(),'__destruct'))){
$this->site()->__destruct();
}
}
/**
* call plugin functions
*
* @param mixed $func_list List of plugins function
* @return bool 成功時 `true`、失敗時 `false`
*/
private function fnc_call_plugin_funcs( $func_list ){
if( is_null($func_list) ){
return false;
}
$param_arr = func_get_args();
array_shift($param_arr);
if( !empty( $func_list ) ){
// functions
if( is_object($func_list) ){
$func_list = get_object_vars( $func_list );
}
if( is_string($func_list) ){
$fnc_name = $func_list;
$fnc_name = preg_replace( '/^\\\\*/', '\\', $fnc_name );
$option_value = null;
preg_match( '/^(.*?)(?:\\((.*)\\))?$/s', $fnc_name, $matched );
if(array_key_exists( 1, $matched )){
$fnc_name = $matched[1] ?? null;
}
if(array_key_exists( 2, $matched )){
$option_value = $matched[2] ?? null;
}
unset($matched);
if( strlen( trim($option_value ?? "") ) ){
$option_value = json_decode( $option_value );
}else{
$option_value = null;
}
// var_dump($fnc_name);
// var_dump($option_value);
$this->proc_num ++;
if( !strlen($this->proc_id ?? "") ){
$this->proc_id = $this->proc_type.'_'.$this->proc_num;
}
array_push( $param_arr, $option_value );
call_user_func_array( $fnc_name, $param_arr);
$this->proc_id = null;
}elseif( is_array($func_list) ){
foreach( $func_list as $fnc_id=>$fnc_name ){
if( is_string($fnc_name) ){
$fnc_name = preg_replace( '/^\\\\*/', '\\', $fnc_name );
}
if( is_string($fnc_id) && !preg_match('/^[0-9]+$/', $fnc_id) ){
$this->proc_id = $fnc_id;
}
$param_arr_dd = $param_arr;
array_unshift( $param_arr_dd, $fnc_name );
call_user_func_array( array( $this, 'fnc_call_plugin_funcs' ), $param_arr_dd);
}
}
unset($fnc_name);
}
return true;
}
/**
* `$fs` オブジェクトを取得する。
*
* `$fs`(class [tomk79\filesystem](tomk79.filesystem.html))のインスタンスを返します。
*
* @see https://github.com/tomk79/filesystem
* @return object $fs オブジェクト
*/
public function fs(){
return $this->fs;
}
/**
* `$req` オブジェクトを取得する。
*
* `$req`(class [tomk79\request](tomk79.request.html))のインスタンスを返します。
*
* @see https://github.com/tomk79/request
* @return object $req オブジェクト
*/
public function req(){
return $this->req;
}
/**
* `$site` オブジェクトを取得する。
*
* `$site`(class [picklesFramework2\site](picklesFramework2.site.html))のインスタンスを返します。
*
* `$site` は、主にサイトマップCSVから読み込んだページの一覧情報を管理するオブジェクトです。
*
* `$conf->paths_enable_sitemap` の設定によって、 `$site` がロードされない場合があります。
* ロードされない場合は、 `false` が返されます。
*
* また、サイトマップをロードする前段階(`before_sitemap`) では、 `null` を返します。
*
* @return object|bool `$site` オブジェクト。ロード前は `null`、ロードされない場合は `false`。
*/
public function site(){
return $this->site;
}
/**
* `$site` オブジェクトをセットする
*
* 外部から `$site`(class [picklesFramework2\site](picklesFramework2.site.html))のインスタンスを受け取ります。
*
* このメソッドを通じて、プラグインから `$site` の振る舞いを変更することができます。
*
* @param object $site `$site` オブジェクト
* @return bool 成功時 `true`、失敗時 `false` を返します。
*/
public function set_site( $site ){
if( !is_object($site) ){
return false;
}
$this->site = $site;
return true;
}
/**
* `$pxcmd` オブジェクトを取得する。
*
* @return object $pxcmd オブジェクト
*/
public function pxcmd(){
return $this->pxcmd;
}
/**
* `$bowl` オブジェクトを取得する。
*
* `$bowl`(class [picklesFramework2\bowl](picklesFramework2.bowl.html))のインスタンスを返します。
*
* @return object $bowl オブジェクト
*/
public function bowl(){
return $this->bowl;
}
/**
* `$conf` オブジェクトを取得する。
* @return object $conf オブジェクト
*/
public function conf(){
return $this->conf;
}
/**
* 言語コードを取得する
* @return string 言語コード
*/
public function lang(){
return $this->lang;
}
/**
* 言語コードを設定する
* @param string $new_lang 言語コード
* @return boolean 成功時 `true`、 失敗時 `false`
*/
public function set_lang( $new_lang ){
if( !strlen( $new_lang ?? "" ) ){
return false;
}
if( $new_lang != $this->conf->default_lang && array_search( $new_lang, $this->conf->accept_langs ) === false ){
return false;
}
$this->lang = $new_lang;
$this->req->set_cookie("LANG", $new_lang);
return true;
}
/**
* ホームディレクトリの絶対パスを取得する (deprecated)
* このメソッドの使用は推奨されません。
* 代わりに `$px->get_realpath_homedir()` を使用してください。
* @return string ホームディレクトリの絶対パス
*/
public function get_path_homedir(){
return $this->get_realpath_homedir();
}
/**
* ホームディレクトリの絶対パスを取得する。
*
* ホームディレクトリは、 Pickles 2 のフレームワークが使用するファイルが置かれるディレクトリで、
* 主には `config.php`, `sitemaps/*`, `_sys/ram/*` などが格納されているディレクトリのことです。
*
* Pickles Framework v2.0.29 で `get_path_homedir()` からの名称変更として追加されました。
*
* @return string ホームディレクトリの絶対パス
*/
public function get_realpath_homedir(){
return $this->realpath_homedir;
}
/**
* コンテンツのパスを取得する。
* @return string コンテンツのパス
*/
public function get_path_content(){
return $this->path_content;
}
/**
* `directory_index` (省略できるファイル名) の一覧を得る。
*
* @return array ディレクトリインデックスの一覧
*/
public function get_directory_index(){
if( count($this->directory_index) ){
return $this->directory_index;
}
$tmp_di = $this->conf->directory_index;
$this->directory_index = array();
foreach( $tmp_di as $file_name ){
$file_name = trim($file_name);
if( !strlen($file_name ?? "") ){
continue;
}
array_push( $this->directory_index, $file_name );
}
if( !count( $this->directory_index ) ){
array_push( $this->directory_index, 'index.html' );
}
return $this->directory_index;
}//get_directory_index()
/**
* `directory_index` のいずれかにマッチするための pregパターン式を得る。
*
* @param string $delimiter pregパターンのデリミタ。省略時は `/` (`preg_quote()` の実装に従う)。
* @return string pregパターン
*/
public function get_directory_index_preg_pattern( $delimiter = null ){
$directory_index = $this->get_directory_index();
foreach( $directory_index as $key=>$row ){
$directory_index[$key] = preg_quote($row, $delimiter);
}
$rtn = '(?:'.implode( '|', $directory_index ).')';
return $rtn;
} // get_directory_index_preg_pattern()
/**
* 最も優先されるインデックスファイル名を得る。
*
* @return string 最も優先されるインデックスファイル名
*/
public function get_directory_index_primary(){
$directory_index = $this->get_directory_index();
return $directory_index[0];
} // get_directory_index_primary()
/**
* ファイルの処理方法を調べる。
*
* 設定値 `$conf->paths_proc_type` の連想配列にもとづいてパスを評価し、
* 処理方法の種類を調べて返します。
*
* @param string $path パス
* @return string 処理方法
* - ignore = 対象外パス。Pickles 2 のアクセス可能範囲から除外します。このパスにへのアクセスは拒絶され、パブリッシュの対象からも外されます。
* - direct = 物理ファイルを、ファイルとして読み込んだでから加工処理を通します。 (direct以外の通常の処理は、PHPファイルとして `include()` されます)
* - pass = 物理ファイルを、そのまま無加工で出力します。 (デフォルト)
* - その他 = extension名
*/
public function get_path_proc_type( $path = null ){
static $rtn = array();
static $rtn_after_sitemap = array();
if( is_null($path) ){
$path = $this->req()->get_request_file_path();
}
$path = preg_replace('/\#.*$/', '', $path);
$path = preg_replace('/\?.*$/', '', $path);
$path = $this->fs()->get_realpath( '/'.$path );
if( is_dir('./'.$path) ){
$path .= '/'.$this->get_directory_index_primary();
}
if( preg_match('/(?:\/|\\\\)$/', $path) ){
$path .= $this->get_directory_index_primary();
}
$path = $this->fs()->normalize_path($path);
if( is_object( $this->site ) ){
if( !is_null($rtn_after_sitemap[$path] ?? null) ){
return $rtn_after_sitemap[$path];
}
$page_info = $this->site()->get_page_info( $path );
if( strlen( $page_info['proc_type'] ?? "" ) ){
$rtn_after_sitemap[$path] = $page_info['proc_type'];
return $rtn_after_sitemap[$path];
}
}
if( !is_null($rtn[$path] ?? null) ){
return $rtn[$path];
}
$realpath_controot = $this->fs()->normalize_path( $this->fs()->get_realpath( $this->get_realpath_docroot().$this->get_path_controot() ) );
foreach( $this->conf->paths_proc_type as $row => $type ){
if(!is_string($row)){continue;}
$preg_pattern = preg_quote($this->fs()->normalize_path($this->fs()->get_realpath($row)), '/');
if( preg_match('/\*/',$preg_pattern) ){
// ワイルドカードが使用されている場合
$preg_pattern = preg_quote($row,'/');
$preg_pattern = preg_replace('/'.preg_quote('\*','/').'/','(?:.*?)',$preg_pattern);//ワイルドカードをパターンに反映
$preg_pattern = $preg_pattern.'$';//前方・後方一致
}elseif(is_dir($realpath_controot.$row)){
$preg_pattern = preg_quote($this->fs()->normalize_path($this->fs()->get_realpath($row)).'/','/');
}elseif(is_file($realpath_controot.$row)){
$preg_pattern = preg_quote($this->fs()->normalize_path($this->fs()->get_realpath($row)),'/');
}
if( preg_match( '/^'.$preg_pattern.'$/s' , $path ) ){
$rtn[$path] = $type;
return $rtn[$path];
}
}
$rtn[$path] = 'pass';// <- default
return $rtn[$path];
} // get_path_proc_type();
/**
* サイトマップのロードが有効なパスか調べる。
*
* 設定値 `$conf->paths_enable_sitemap` の配列にもとづいてパスを評価し、
* サイトマップをロードするべきかどうかを判定します。
*
* @param string $path パス
* @return bool 有効の場合 true, 無効の場合 false.
*/
public function is_path_enable_sitemap( $path = null ){
static $rtn = array();
if( is_null($path) ){
$path = $this->req()->get_request_file_path();
}
$path = $this->fs()->get_realpath( '/'.$path );
if( is_dir('./'.$path) ){
$path .= '/'.$this->get_directory_index_primary();
}
if( preg_match('/(?:\/|\\\\)$/', $path) ){
$path .= $this->get_directory_index_primary();
}
$path = $this->fs()->normalize_path($path);
if( is_bool($rtn[$path] ?? null) ){
return $rtn[$path];
}
foreach( $this->conf->paths_enable_sitemap as $row ){
if(!is_string($row)){continue;}
$preg_pattern = preg_quote($this->fs()->normalize_path($this->fs()->get_realpath($row)), '/');
if( preg_match('/\*/',$preg_pattern) ){
// ワイルドカードが使用されている場合
$preg_pattern = preg_quote($row,'/');
$preg_pattern = preg_replace('/'.preg_quote('\*','/').'/','(?:.*?)',$preg_pattern);//ワイルドカードをパターンに反映
$preg_pattern = $preg_pattern.'$';//前方・後方一致
}elseif(is_dir($row)){
$preg_pattern = preg_quote($this->fs()->normalize_path($this->fs()->get_realpath($row)).'/','/');
}elseif(is_file($row)){
$preg_pattern = preg_quote($this->fs()->normalize_path($this->fs()->get_realpath($row)),'/');
}
if( preg_match( '/^'.$preg_pattern.'$/s' , $path ) ){
$rtn[$path] = true;
return $rtn[$path];
}
}
$rtn[$path] = false;// <- default
return $rtn[$path];
} // is_path_enable_sitemap();
/**
* 除外ファイルか調べる。
*
* @param string $path パス
* @return bool 除外ファイルの場合 `true`、それ以外の場合に `false` を返します。
*/
public function is_ignore_path( $path ){
$type = $this->get_path_proc_type($path);
if( $type == 'ignore' ){
return true;
}
return false;
}
/**
* デフォルトの MIME Type を取得する。
*
* @param string $path パス
* @return string MIME Type
*/
private function get_default_mime_type( $path = null ){
$rtn = null;
if( !strlen($path ?? "") ){
$path = $this->req()->get_request_file_path();
}
$extension = $this->get_path_proc_type( $path );
switch( strtolower( $extension ) ){
case 'pass':
case 'ignore':
case 'direct':
$extension = pathinfo( $path , PATHINFO_EXTENSION );
break;
default:
break;
}
switch( strtolower( $extension ) ){
case 'css':
$rtn = 'text/css';
break;
case 'js':
$rtn = 'text/javascript';
break;
case 'html':
case 'htm':
case 'shtml':
case 'shtm':
case 'xbm':
$rtn = 'text/html';
break;
case 'png': $rtn = 'image/png'; break;
case 'gif': $rtn = 'image/gif'; break;
case 'jpg':case 'jpeg':case 'jpe': $rtn = 'image/jpeg'; break;
case 'svg':case 'svgz': $rtn = 'image/svg+xml'; break;
case 'csv': $rtn = 'text/comma-separated-values'; break;
case 'tsv': $rtn = 'text/tab-separated-values'; break;
case 'pdf': $rtn = 'application/pdf'; break;
case 'swf': $rtn = 'application/x-shockwave-flash'; break;
case 'txt':case 'text':
default:
$rtn = 'text/plain'; break;
}
return $rtn;
}
/**
* Pickles 2 内部でサブリクエストを発行し、結果を受け取る
*
* @param string $request_path リクエストを発行する対象のパス
* @param array $options Pickles 2 へのコマンド発行時のオプション
* - output = 期待する出力形式。`json` を指定すると、サブリクエストに `-o json` オプションが加えられ、JSON形式で解析済みのオブジェクトが返されます。
* - user_agent = `HTTP_USER_AGENT` 文字列。 `user_agent` が空白の場合、または文字列 `PicklesCrawler` を含む場合には、パブリッシュツールからのアクセスであるとみなされます。
* - method = メソッド名。 指定すると、サブリクエストに `--method` オプションとして加えられます。
* - body = リクエストボディ値。 指定すると、サブリクエストに `--body` オプションとして加えられます。
* - body_file = リクエストボディが保存されたファイルのパス。 指定すると、サブリクエストに `--body-file` オプションとして加えられます。
* @param int &$return_var コマンドの終了コードで上書きされます
* @return mixed サブリクエストの実行結果。
* 通常は 得られた標準出力をそのまま文字列として返します。
* `output` オプションに `json` が指定された場合、 `json_decode()` された値が返却されます。
*
* サブリクエストから標準エラー出力を検出した場合、 `$px->error( $stderr )` に転送します。
*/
public function internal_sub_request($request_path, $options = null, &$return_var = null){
if(!is_string($request_path)){
$this->error('Invalid argument supplied for 1st option $request_path in $px->internal_sub_request(). It required String value.');
return false;
}
if(!strlen($request_path ?? "")){ $request_path = '/'; }
if(is_null($options)){ $options = array(); }
if(!is_array($options)){ $options = (array) $options; }
$php_command = array();
array_push( $php_command, addslashes($this->conf()->commands->php) );
// ↑ Windows でこれを `escapeshellarg()` でエスケープすると、なぜかエラーに。
if( strlen($this->conf()->path_phpini ?? "") ){
$php_command = array_merge(
$php_command,
array(
'-c', escapeshellarg($this->conf()->path_phpini),// ← php.ini のパス
)
);
}
if( strlen($this->req()->get_cli_option( '-d' ) ?? "") ){
$php_command = array_merge(
$php_command,
array(