-
Notifications
You must be signed in to change notification settings - Fork 187
/
install.php
2008 lines (1769 loc) · 62.8 KB
/
install.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 namespace ProcessWire;
/**
* ProcessWire Installer
*
* Because this installer runs before PW is installed, it is largely self contained.
* It's a quick-n-simple single purpose script that's designed to run once, and it should be deleted after installation.
* This file self-executes using code found at the bottom of the file, under the Installer class.
*
* Note that it creates this file once installation is completed: /site/assets/installed.php
* If that file exists, the installer will not run. So if you need to re-run this installer for any
* reason, then you'll want to delete that file. This was implemented just in case someone doesn't delete the installer.
*
* ProcessWire 3.x, Copyright 2022 by Ryan Cramer
* https://processwire.com
*
* @todo 3.0.190: provide option for command-line options to install
* @todo have installer set session name
*
*/
define("PROCESSWIRE_INSTALL", "3.x");
/**
* class Installer
*
* Self contained class to install ProcessWire 3.x
*
*/
class Installer {
/**
* Whether or not we force installed files to be copied.
*
* If false, we attempt a faster rename of directories instead.
*
*/
const FORCE_COPY = true;
/**
* Replace existing database tables if already present?
*
*/
const REPLACE_DB = true;
/**
* Minimum required PHP version to install ProcessWire
*
*/
const MIN_REQUIRED_PHP_VERSION = '5.3.8';
/**
* Test mode for installer development, non destructive
*
*/
const TEST_MODE = false;
/**
* Default profile name
*
*/
const DEFAULT_PROFILE = 'site-blank';
/**
* File permissions, determined in the dbConfig function
*
* Below are worst case scenario, last resort defaults
*
*/
protected $chmodDir = "0777";
protected $chmodFile = "0666";
/**
* Number of errors that occurred during the request
*
*/
protected $numErrors = 0;
/**
* True when we are in a section
*
* @var bool
*
*/
protected $inSection = false;
/**
* Execution controller
*
*/
public function execute() {
if(self::TEST_MODE) {
error_reporting(E_ALL | E_STRICT);
ini_set('display_errors', 1);
}
// these two vars used by install-head.inc
$title = "ProcessWire " . PROCESSWIRE_INSTALL . " Installer";
$formAction = "./install.php";
require("./wire/modules/AdminTheme/AdminThemeUikit/install-head.inc");
$step = $this->post('step');
if($step === null) {
$this->welcome();
} else {
$step = (int) $step;
switch($step) {
case 0: $this->initProfile(); break;
case 1: $this->compatibilityCheck(); break;
case 2: $this->dbConfig(); break;
case 4: $this->dbSaveConfig(); break;
case 5: require("./index.php");
/** @var ProcessWire $wire */
$wire->modules->refresh();
$this->adminAccountSave($wire);
break;
default:
$this->welcome();
}
}
require("./wire/modules/AdminTheme/AdminThemeUikit/install-foot.inc");
}
/**
* Welcome/Intro screen
*
*/
protected function welcome() {
$this->h("Welcome. This tool will guide you through the installation process.");
$this->p(
"Thanks for choosing ProcessWire! " .
"If you downloaded this copy of ProcessWire from somewhere other than " .
"<a target='_blank' href='https://processwire.com/'>processwire.com</a> or " .
"<a href='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/processwire/processwire' target='_blank'>our GitHub page</a>, " .
"please download a fresh copy before installing. " .
"If you need help or have questions during installation, please stop by our " .
"<a href='https://processwire.com/talk/' target='_blank'>support board</a> and we'll be glad to help."
);
$this->btn("Get Started", array('icon' => 'sign-in'));
}
/**
* Check if the given function $name exists and report OK or fail with $label
*
* @param string $name
* @param string $label
*
*/
protected function checkFunction($name, $label) {
if(function_exists($name)) {
$this->ok("$label");
} else {
$this->err("Fail: $label");
}
}
/**
* Find all profile directories (site-*) in the current dir and return info array for each
*
* @return array
*
*/
protected function findProfiles() {
$profiles = array(
//'site-blank' => null,
//'site-default' => null, // preferred starting order
//'site-beginner' => null,
//'site-languages' => null,
);
$dirTests = array(
'install',
'templates',
'assets',
);
$fileTests = array(
'config.php',
'templates/admin.php',
'install/install.sql',
);
foreach(new \DirectoryIterator(dirname(__FILE__)) as $dir) {
if($dir->isDot() || !$dir->isDir()) continue;
$name = $dir->getBasename();
$path = rtrim($dir->getPathname(), '/') . '/';
if(strpos($name, 'site-') !== 0) continue;
$passed = true;
foreach($dirTests as $test) if(!is_dir($path . $test)) $passed = false;
foreach($fileTests as $test) if(!file_exists($path . $test)) $passed = false;
if(!$passed) continue;
$profile = array('name' => str_replace('site-', '', $name));
$infoFile = $path . 'install/info.php';
if(file_exists($infoFile)) {
/** @noinspection PhpIncludeInspection */
include($infoFile);
if(isset($info) && is_array($info)) {
$profile = array_merge($profile, $info);
}
}
$profiles[$name] = $profile;
}
// remove any preferred starting order profiles that weren't present
foreach($profiles as $name => $profile) {
if(is_null($profile)) unset($profiles[$name]);
}
return $profiles;
}
/**
* Select profile
*
*/
protected function selectProfile() {
$options = '';
$out = '';
$profiles = $this->findProfiles();
if(!count($profiles)) $this->err("No profiles found!");
foreach($profiles as $name => $profile) {
$title = empty($profile['title']) ? ucfirst($profile['name']) : $profile['title'];
$options .= "<option value='$name'>$title</option>";
$out .= "<div class='profile-preview' id='$name' style='display: none;'>";
if(!empty($profile['summary'])) $out .= "<p>$profile[summary]</p>";
else $out .= "<p class='detail'>No summary.</p>";
if(!empty($profile['screenshot'])) {
$file = $profile['screenshot'];
if(strpos($file, '/') === false) $file = "$name/install/$file";
$out .= "<p><img src='$file' alt='$name screenshot' style='max-width: 100%;' /></p>";
} else {
$out .= "<p class='detail'>No screenshot.</p>";
}
$out .= "</div>";
}
$path = rtrim(str_replace('install.php', '', $_SERVER['REQUEST_URI']), '/') . '/';
$url = htmlspecialchars($path, ENT_QUOTES, 'UTF-8') . 'site-name/';
$angleUpIcon = $this->icon('angle-up', false);
echo "
<p>
A site installation profile is a ready-to-use and modify site for ProcessWire.
</p>
<p>
If you want something other than the included “blank” profile, please
<a target='_blank' href='https://processwire.com/download/site-profiles/'>download another site profile</a>,
unzip and place its files in <code>$url</code> (replacing <code>name</code> with the profile name)
and click the “Refresh” button to make it available here.
</p>
<p style='width: 240px;'>
<select class='uk-select' name='profile' id='select-profile'>
<option value=''>Installation Profiles</option>
$options
</select>
</p>
<p class='detail'>
$angleUpIcon
Select an installation profile to see more information.
</p>
$out
<script type='text/javascript'>
$('#select-profile').change(function() {
$('.profile-preview').hide();
$('#' + $(this).val()).fadeIn('fast');
}).change();
</script>
";
}
/**
* Step 1a: Determine profile
*
*/
protected function initProfile() {
$this->h('Site Installation Profile', 'building-o');
if(is_file("./site/install/install.sql")) {
$this->alertOk("Found installation profile in /site/install/");
} else if(is_dir("./site/")) {
$this->alertOk("Found /site/ — already installed? ");
} else if($this->post('profile') && $this->post('step') !== '000') {
$profiles = $this->findProfiles();
$profile = $this->post('profile', 'name');
if(empty($profile) || !isset($profiles[$profile]) || !is_dir(dirname(__FILE__) . "/$profile")) {
$this->alertErr("Profile not found");
$this->selectProfile();
$this->btnContinue();
return;
}
if(@rename("./$profile", "./site")) {
$this->alertOk("Renamed /$profile => /site");
} else {
$this->alertErr("File system is not writable by this installer. Before continuing, please rename '/$profile' to '/site'");
$this->btnContinue();
return;
}
} else {
if($this->post('step') === '000') $this->alertOk('Refreshed profiles');
$this->selectProfile();
$this->btn('Refresh', array('value' => '000', 'icon' => 'refresh', 'secondary' => true, 'float' => true));
$this->btnContinue();
return;
}
$this->compatibilityCheck();
}
/**
* Step 1b: Check for ProcessWire compatibility
*
*/
protected function compatibilityCheck() {
$this->sectionStart('fa-gears Compatibility Check');
if(version_compare(PHP_VERSION, self::MIN_REQUIRED_PHP_VERSION) >= 0) {
$this->ok("PHP version " . PHP_VERSION);
} else {
$this->err("ProcessWire requires PHP version " . self::MIN_REQUIRED_PHP_VERSION . " or newer. You are running PHP " . PHP_VERSION);
}
if(extension_loaded('pdo_mysql')) {
$this->ok("PDO (mysql) database");
} else {
$this->err("PDO (pdo_mysql) is required (for MySQL database)");
}
if(self::TEST_MODE) {
$this->err("Example error message for test mode");
$this->warn("Example warning message for test mode");
}
$this->checkFunction("filter_var", "Filter functions (filter_var)");
$this->checkFunction("mysqli_connect", "MySQLi (not used by core, but may still be used by some older 3rd party modules)");
$this->checkFunction("imagecreatetruecolor", "GD 2.0 or newer");
$this->checkFunction("json_encode", "JSON support");
$this->checkFunction("preg_match", "PCRE support");
$this->checkFunction("ctype_digit", "CTYPE support");
$this->checkFunction("iconv", "ICONV support");
$this->checkFunction("session_save_path", "SESSION support");
$this->checkFunction("hash", "HASH support");
$this->checkFunction("spl_autoload_register", "SPL support");
if(function_exists('apache_get_modules')) {
if(in_array('mod_rewrite', apache_get_modules())) $this->ok("Found Apache module: mod_rewrite");
else $this->err("Apache 'mod_rewrite' module does not appear to be installed and is required by ProcessWire.");
} else {
// apache_get_modules doesn't work on a cgi installation.
// check for environment var set in htaccess file, as submitted by jmarjie.
$mod_rewrite = getenv('HTTP_MOD_REWRITE') == 'On' || getenv('REDIRECT_HTTP_MOD_REWRITE') == 'On' ? true : false;
if($mod_rewrite) {
$this->ok("Found Apache module (cgi): mod_rewrite");
} else {
$this->err(
"Unable to determine if Apache mod_rewrite (required by ProcessWire) is installed. " .
"On some servers, we may not be able to detect it until your .htaccess file is place. " .
"Please click the 'check again' button at the bottom of this screen, if you haven't already."
);
}
}
if(class_exists('\ZipArchive')) {
$this->ok("ZipArchive support");
} else {
$this->warn("ZipArchive support was not found. This is recommended, but not required to complete installation.");
}
$memoryLimit = $this->getMemoryLimit('M');
$memoryLimitLabel = "PHP memory_limit is set to $memoryLimit MB";
if($memoryLimit < 64) {
$this->err("$memoryLimitLabel - At least 64 MB is strongly recommended but 128 MB or more is best");
} else if($memoryLimit < 128) {
$this->warn("$memoryLimitLabel - OK to continue, but at least 128 MB is recommended");
} else {
$this->ok("$memoryLimitLabel");
}
$dirs = array(
// directory => required?
'./site/assets/' => true,
'./site/modules/' => false,
);
foreach($dirs as $dir => $required) {
$d = ltrim($dir, '.');
if(!file_exists($dir)) {
$this->err("Directory $d does not exist! Please create this and make it writable before continuing.");
} else if(is_writable($dir)) {
$this->ok("$d is writable");
} else if($required) {
$this->err("Directory $d must be writable. Please adjust the server permissions before continuing.");
} else {
$this->warn("Consider making directory $d writable, at least during development.");
}
}
if(is_writable("./site/config.php")) {
$this->ok("/site/config.php is writable");
} else {
$this->err("/site/config.php must be writable. Please adjust the server permissions before continuing.");
}
if(!is_file("./.htaccess") || !is_readable("./.htaccess")) {
if(@rename("./htaccess.txt", "./.htaccess")) {
$this->ok("Installed .htaccess");
} else {
$this->err("/.htaccess doesn't exist. Before continuing, you should rename the included htaccess.txt file to be .htaccess (with the period in front of it, and no '.txt' at the end).");
}
} else if(!strpos(file_get_contents("./.htaccess"), "PROCESSWIRE")) {
$this->err("/.htaccess file exists, but is not for ProcessWire. Please overwrite or combine it with the provided /htaccess.txt file (i.e. rename /htaccess.txt to /.htaccess, with the period in front).");
} else {
$this->ok(".htaccess looks good");
}
$this->sectionStop();
if($this->numErrors) {
$this->p("One or more errors were found above. We recommend you correct these issues before proceeding or <a href='https://processwire.com/talk/'>contact ProcessWire support</a> if you have questions or think the error is incorrect. But if you want to proceed anyway, click Continue below.");
$this->btn("Check Again", array('value' => 1, 'icon' => 'refresh', 'float' => true));
$this->btn("Continue to Next Step", array('value' => 2, 'icon' => 'angle-right', 'secondary' => true));
} else {
$this->btn("Continue to Next Step", array('value' => 2, 'icon' => 'angle-right'));
}
}
/**
* Step 2: Configure the database and file permission settings
*
* @param array $values
* @param int $hasNumTables
*
*/
protected function dbConfig($values = array(), $hasNumTables = 0) {
if(!is_file("./site/install/install.sql")) die(
"There is no installation profile in /site/. Please place one there before continuing. " .
"You can get it at https://processwire.com/download/"
);
if($hasNumTables) {
$this->sectionStart('fa-database Existing tables action');
// select($name, $label, $value, array $options) {
$this->p("What would you like to do with the existing database tables that are present?");
$this->select('dbTablesAction', '', 0, array(
'0' => "Click to select tables action",
'ignore' => "Ignore tables*",
'remove' => "Remove tables",
), 0);
$this->p("*When choosing “Ignore tables”, existing tables having the same name as newly imported tables will still be deleted.", 'detail');
$this->sectionStop();
}
$this->sectionStart('fa-database MySQL Database');
$this->p(
"Please specify a MySQL 5.x+ database and user account on your server. If the database does not exist, " .
"we will attempt to create it. If the database already exists, the user account should have full read, " .
"write and delete permissions on the database (recommended permissions are select, insert, update, delete, " .
"create, alter, index, drop, create temporary tables, and lock tables)."
);
if(!isset($values['dbName'])) $values['dbName'] = '';
// @todo: are there PDO equivalents for the ini_get()s below?
if(!isset($values['dbHost'])) $values['dbHost'] = ini_get("mysqli.default_host");
if(!isset($values['dbPort'])) $values['dbPort'] = ini_get("mysqli.default_port");
if(!isset($values['dbUser'])) $values['dbUser'] = ini_get("mysqli.default_user");
if(!isset($values['dbPass'])) $values['dbPass'] = ini_get("mysqli.default_pw");
if(!isset($values['dbEngine'])) $values['dbEngine'] = 'MyISAM';
if(!$values['dbHost']) $values['dbHost'] = 'localhost';
if(!$values['dbPort']) $values['dbPort'] = 3306;
if(empty($values['dbCharset'])) $values['dbCharset'] = 'utf8';
if($values['dbCharset'] != 'utf8mb4') $values['dbCharset'] = 'utf8';
if($values['dbEngine'] != 'InnoDB') $values['dbEngine'] = 'MyISAM';
foreach($values as $key => $value) {
if(strpos($key, 'chmod') === 0) {
$values[$key] = (int) $value;
} else if($key != 'httpHosts') {
$values[$key] = htmlspecialchars($value, ENT_QUOTES, 'utf-8');
}
}
$this->input('dbName', 'DB Name', $values['dbName']);
$this->input('dbUser', 'DB User', $values['dbUser']);
$this->input('dbPass', 'DB Pass', $values['dbPass'], array('type' => 'password', 'required' => false));
$this->input('dbHost', 'DB Host', $values['dbHost']);
$this->input('dbPort', 'DB Port', $values['dbPort']);
$this->select('dbCharset', 'DB Charset', $values['dbCharset'], array('utf8', 'utf8mb4'));
$this->select('dbEngine', 'DB Engine', $values['dbEngine'], array('MyISAM', 'InnoDB'));
$this->clear();
$this->p(
"The DB Charset option “utf8mb4” may not be compatible with all 3rd party modules.<br />" .
"The DB Engine option “InnoDB” requires MySQL 5.6.4 or newer.",
array('class' => 'detail', 'style' => 'margin-top:0')
);
$this->sectionStop();
$cgi = false;
$defaults = array();
if(is_writable(__FILE__)) {
$defaults['chmodDir'] = "755";
$defaults['chmodFile'] = "644";
$cgi = true;
} else {
$defaults['chmodDir'] = "777";
$defaults['chmodFile'] = "666";
}
$timezone = isset($values['timezone']) ? $values['timezone'] : date_default_timezone_get();
$timezones = $this->timezones();
if(!$timezone || !in_array($timezone, $timezones)) {
$timezone = ini_get('date.timezone');
if(!$timezone || !in_array($timezone, $timezones)) $timezone = 'America/New_York';
}
$defaults['timezone'] = $timezone;
$defaults['httpHosts'] = strtolower(filter_var($_SERVER['HTTP_HOST'], FILTER_SANITIZE_URL));
if(strpos($defaults['httpHosts'], 'www.') === 0) {
$defaults['httpHosts'] .= "\n" . substr($defaults['httpHosts'], 4);
} else if(substr_count($defaults['httpHosts'], '.') == 1) {
$defaults['httpHosts'] .= "\n" . "www.$defaults[httpHosts]";
}
if($_SERVER['SERVER_NAME'] && $_SERVER['SERVER_NAME'] != $_SERVER['HTTP_HOST']) {
$defaults['httpHosts'] .= "\n" . $_SERVER['SERVER_NAME'];
}
if(isset($values['httpHosts']) && is_array($values['httpHosts'])) $values['httpHosts'] = implode("\n", $values['httpHosts']);
$values = array_merge($defaults, $values);
$this->sectionStart('fa-globe Time Zone');
$this->p('The time zone selection should be consistent with the time zone of the web server you are installing to.');
$this->selectTimezone($values['timezone']);
$this->sectionStop();
$this->sectionStart("fa-key File Permissions");
$this->p(
"When ProcessWire creates directories or files, it assigns permissions to them. " .
"Enter the most restrictive permissions possible that give ProcessWire (and you) read and write access to the web server (Apache). " .
"The safest setting to use varies from server to server. " .
"If you are not on a dedicated or private server, or are in any kind of shared environment, you may want to contact your web host to advise on what are the best permissions to use in your environment. " .
"<a target='_blank' href='https://processwire.com/docs/security/file-permissions/'>Read more about securing file permissions</a>"
);
$this->p("Permissions must be 3 digits each. Should you opt to use the defaults provided, you can also adjust these permissions later if desired by editing <u>/site/config.php</u>.", "detail");
$this->input('chmodDir', 'Directories', $values['chmodDir']);
$this->input('chmodFile', 'Files', $values['chmodFile'], array('clear' => true));
if($cgi) {
$this->p(
"We detected that this file (install.php) is writable. That means Apache may be running as your user account. Given that, we populated the permissions above (755 & 644) as possible starting point.",
array('class' => 'detail', 'style' => 'margin-top:0')
);
} else {
$this->p(
"WARNING: 777 and 666 permissions mean that directories and files are readable and writable to everyone on the server (and thus not particularly safe). If in any kind of shared hosting environment, please consult your web host for their recommended permission settings for Apache readable/writable directories and files before proceeding. " .
"<a target='_blank' href='https://processwire.com/docs/security/file-permissions/'>More</a>",
array('class' => 'detail', 'style' => 'margin-top:0')
);
}
$this->sectionStop();
$this->sectionStart('fa-server HTTP Host Names');
$this->p(
"What host names will this installation run on now and in the future? Please enter one host per line. " .
"You can also modify this setting later by editing the <code>\$config->httpHosts</code> setting in the <u>/site/config.php</u> file."
);
$rows = substr_count($values['httpHosts'], "\n") + 2;
$this->textarea('httpHosts', '', $values['httpHosts'], $rows);
$this->sectionStop();
$this->sectionStart('fa-bug Debug mode?');
$this->p(
"When debug mode is enabled, errors and exceptions are visible in ProcessWire’s output. This is helpful when developing a website or testing ProcessWire. " .
"When debug mode is NOT enabled, fatal errors/exceptions halt the request with an ambiguous http 500 error, and non-fatal errors are not shown. " .
"Regardless of debug mode, fatal errors are always logged and always visible to superusers. " .
"Debug mode should not be enabled for live or production sites, but at this stage (installation) it is worthwhile to have it enabled. "
);
$noChecked = empty($values['debugMode']) ? "checked='checked'" : "";
$yesChecked = empty($noChecked) ? "checked='checked'" : "";
$this->p(
"<label>" .
"<input type='radio' class='uk-radio' name='debugMode' $yesChecked value='1'> <strong>Enabled</strong> " .
"<span class='uk-text-small uk-text-muted'>(recommended while sites are in development or while testing ProcessWire)</span>" .
"</label><br />" .
"<label>" .
"<input type='radio' class='uk-radio' name='debugMode' $noChecked value='0'> <strong>Disabled</strong> " .
"<span class='uk-text-small uk-text-muted'>(recommended once a site goes live or becomes publicly accessible)</span>" .
"</label> "
);
$this->p(
"You can also enable or disable debug mode at any time by editing the <u>/site/config.php</u> file and setting " .
"<code>\$config->debug = true;</code> or <code>\$config->debug = false;</code>"
);
$this->sectionStop();
$this->btnContinue(array('value' => 4));
$this->p("Note: After you click the button above, be patient … it may take a minute.", "detail");
}
/**
* Step 3: Save database configuration, then begin profile import
*
*/
protected function dbSaveConfig() {
$values = array();
$database = null;
// file permissions
$fields = array('chmodDir', 'chmodFile');
foreach($fields as $field) {
$value = $this->post($field, 'int');
if(strlen("$value") !== 3) {
$this->alertErr("Value for '$field' is invalid");
} else {
$this->$field = "0$value";
}
$values[$field] = $value;
}
// timezone
$timezone = $this->post('timezone', 'int');
$timezones = $this->timezones();
if(isset($timezones[$timezone])) {
$value = $timezones[$timezone];
if(strpos($value, '|')) {
list($label, $value) = explode('|', $value);
if($label) {} // ignore
}
$values['timezone'] = $value;
} else {
$values['timezone'] = 'America/New_York';
}
// http hosts
$values['httpHosts'] = array();
$httpHosts = $this->post('httpHosts', 'textarea');
if(strlen($httpHosts)) {
$httpHosts = str_replace(array("'", '"'), '', $httpHosts);
$httpHosts = explode("\n", $httpHosts);
foreach($httpHosts as $key => $host) {
$host = strtolower(trim(filter_var($host, FILTER_SANITIZE_URL)));
$httpHosts[$key] = $host;
}
$values['httpHosts'] = $httpHosts;
}
// debug mode
$values['debugMode'] = $this->post('debugMode', 'int');
// db configuration
$fields = array('dbUser', 'dbName', 'dbPass', 'dbHost', 'dbPort', 'dbEngine', 'dbCharset');
foreach($fields as $field) {
$value = $this->post($field, 'string');
$value = substr($value, 0, 255);
if(strpos($value, "'") !== false) $value = str_replace("'", "\\" . "'", $value); // allow for single quotes (i.e. dbPass)
$values[$field] = trim($value);
}
$values['dbCharset'] = ($values['dbCharset'] === 'utf8mb4' ? 'utf8mb4' : 'utf8');
$values['dbEngine'] = ($values['dbEngine'] === 'InnoDB' ? 'InnoDB' : 'MyISAM');
if(!$values['dbUser'] || !$values['dbName'] || !$values['dbPort']) {
$this->alertErr("Missing database configuration fields");
} else {
error_reporting(0);
$dsn = "mysql:dbname=$values[dbName];host=$values[dbHost];port=$values[dbPort]";
$driver_options = array(
\PDO::MYSQL_ATTR_INIT_COMMAND => "SET NAMES 'UTF8'",
\PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION
);
try {
$database = new \PDO($dsn, $values['dbUser'], $values['dbPass'], $driver_options);
} catch(\Exception $e) {
if($e->getCode() == 1049) {
// If schema does not exist, try to create it
$database = $this->dbCreateDatabase($dsn, $values, $driver_options);
} else {
$this->alertErr("Database connection information did not work.");
$this->alertErr(htmlentities($e->getMessage(), ENT_QUOTES, 'UTF-8'));
}
}
}
if($this->numErrors || !$database) {
$this->dbConfig($values);
return;
}
$this->h("fa-database Test Database and Save Configuration");
$this->alertOk("Database connection successful to " . htmlspecialchars($values['dbName']));
$options = array(
'dbCharset' => strtolower($values['dbCharset']),
'dbEngine' => $values['dbEngine']
);
// check if MySQL is new enough to support InnoDB with fulltext indexes
if($options['dbEngine'] == 'InnoDB') {
$query = $database->query("SELECT VERSION()");
list($dbVersion) = $query->fetch(\PDO::FETCH_NUM);
if(version_compare($dbVersion, "5.6.4", "<")) {
$options['dbEngine'] = 'MyISAM';
$values['dbEngine'] = 'MyISAM';
$this->alertErr("Your MySQL version is $dbVersion and InnoDB requires 5.6.4 or newer. Engine changed to MyISAM.");
}
}
// check if database already has tables present
$query = $database->query("SHOW TABLES");
$tables = $query->fetchAll(\PDO::FETCH_COLUMN);
$numTables = count($tables);
$dbTablesAction = $this->post('dbTablesAction', 'string');
if($numTables && $dbTablesAction) {
if($dbTablesAction === 'remove') {
// remove
foreach($tables as $table) {
$database->exec("DROP TABLE `$table`");
}
$this->alertOk("Dropped $numTables existing table(s)");
$numTables = 0;
} else if($dbTablesAction === 'ignore') {
// ignore
$this->alertOk('Existing tables will be ignored');
} else {
$dbTablesAction = '';
}
}
if($numTables && empty($dbTablesAction)) {
$this->alertErr(
"<strong>Database already has $numTables table(s) present:</strong> " .
implode(', ', $tables) . ". " .
"<strong>Please select below what you would like to do with these tables.</strong>"
);
$this->dbConfig($values, $numTables);
} else if($this->dbSaveConfigFile($values)) {
$this->profileImport($database, $options);
} else {
$this->dbConfig($values);
}
}
/**
* Create database
*
* Note: only handles database names that stick to ascii _a-zA-Z0-9.
* For database names falling outside that set, they should be created
* ahead of time.
*
* Contains contributions from @plauclair PR #950
*
* @param string $dsn
* @param array $values
* @param array $driver_options
* @return \PDO|null
*
*/
protected function dbCreateDatabase($dsn, $values, $driver_options) {
$dbCharset = preg_replace('/[^a-z0-9]/', '', strtolower(substr($values['dbCharset'], 0, 64)));
$dbName = preg_replace('/[^_a-zA-Z0-9]/', '', substr($values['dbName'], 0, 64));
$dbNameTest = str_replace('_', '', $dbName);
if(ctype_alnum($dbNameTest) && $dbName === $values['dbName']
&& ctype_alnum($dbCharset) && $dbCharset === $values['dbCharset']) {
// valid database name with no changes after sanitization
try {
$dsn2 = "mysql:host=$values[dbHost];port=$values[dbPort]";
$database = new \PDO($dsn2, $values['dbUser'], $values['dbPass'], $driver_options);
$database->exec("CREATE SCHEMA IF NOT EXISTS `$dbName` DEFAULT CHARACTER SET `$dbCharset`");
// reconnect
$database = new \PDO($dsn, $values['dbUser'], $values['dbPass'], $driver_options);
$this->alertOk("Created database: $dbName");
} catch(\Exception $e) {
$this->alertErr("Failed to create database with name $dbName");
$this->alertErr($e->getMessage());
$database = null;
}
} else {
$database = null;
$this->alertErr("Unable to create database with that name. Please create the database with another tool and try again.");
}
return $database;
}
/**
* Save configuration to /site/config.php
*
* @param array $values
* @return bool
*
*/
protected function dbSaveConfigFile(array $values) {
if(self::TEST_MODE) return true;
$file = __FILE__;
$time = time();
$host = empty($values['httpHosts']) ? '' : implode(',', $values['httpHosts']);
if(function_exists('random_bytes')) {
$authSalt = sha1(random_bytes(random_int(40, 128)));
$tableSalt = sha1(random_int(0, 65535) . "$host$file$time");
} else {
$authSalt = md5(mt_rand() . microtime(true));
$tableSalt = md5(mt_rand() . "$host$file$time");
}
$cfg =
"\n/**" .
"\n * Installer: Database Configuration" .
"\n * " .
"\n */" .
"\n\$config->dbHost = '$values[dbHost]';" .
"\n\$config->dbName = '$values[dbName]';" .
"\n\$config->dbUser = '$values[dbUser]';" .
"\n\$config->dbPass = '$values[dbPass]';" .
"\n\$config->dbPort = '$values[dbPort]';";
if(!empty($values['dbCharset']) && strtolower($values['dbCharset']) != 'utf8') $cfg .= "\n\$config->dbCharset = '$values[dbCharset]';";
if(!empty($values['dbEngine']) && $values['dbEngine'] == 'InnoDB') $cfg .= "\n\$config->dbEngine = 'InnoDB';";
$cfg .=
"\n" .
"\n/**" .
"\n * Installer: User Authentication Salt " .
"\n * " .
"\n * This value was randomly generated for your system on " . date('Y/m/d') . "." .
"\n * This should be kept as private as a password and never stored in the database." .
"\n * Must be retained if you migrate your site from one server to another." .
"\n * Do not change this value, or user passwords will no longer work." .
"\n * " .
"\n */" .
"\n\$config->userAuthSalt = '$authSalt'; " .
"\n" .
"\n/**" .
"\n * Installer: Table Salt (General Purpose) " .
"\n * " .
"\n * Use this rather than userAuthSalt when a hashing salt is needed for non user " .
"\n * authentication purposes. Like with userAuthSalt, you should never change " .
"\n * this value or it may break internal system comparisons that use it. " .
"\n * " .
"\n */" .
"\n\$config->tableSalt = '$tableSalt'; " .
"\n" .
"\n/**" .
"\n * Installer: File Permission Configuration" .
"\n * " .
"\n */" .
"\n\$config->chmodDir = '0$values[chmodDir]'; // permission for directories created by ProcessWire" .
"\n\$config->chmodFile = '0$values[chmodFile]'; // permission for files created by ProcessWire " .
"\n" .
"\n/**" .
"\n * Installer: Time zone setting" .
"\n * " .
"\n */" .
"\n\$config->timezone = '$values[timezone]';" .
"\n" .
"\n/**" .
"\n * Installer: Admin theme" .
"\n * " .
"\n */" .
"\n\$config->defaultAdminTheme = 'AdminThemeUikit';" .
"\n" .
"\n/**" .
"\n * Installer: Unix timestamp of date/time installed" .
"\n * " .
"\n * This is used to detect which when certain behaviors must be backwards compatible." .
"\n * Please leave this value as-is." .
"\n * " .
"\n */" .
"\n\$config->installed = " . time() . ";" .
"\n\n";
if(!empty($values['httpHosts'])) {
$cfg .=
"\n/**" .
"\n * Installer: HTTP Hosts Whitelist" .
"\n * " .
"\n */" .
"\n\$config->httpHosts = array(";
foreach($values['httpHosts'] as $host) $cfg .= "'$host', ";
$cfg = rtrim($cfg, ", ") . ");\n\n";
}
$cfg .=
"\n/**" .
"\n * Installer: Debug mode?" .
"\n * " .
"\n * When debug mode is true, errors and exceptions are visible. " .
"\n * When false, they are not visible except to superuser and in logs. " .
"\n * Should be true for development sites and false for live/production sites. " .
"\n * " .
"\n */" .
"\n\$config->debug = " . ($values['debugMode'] ? 'true;' : 'false;') .
"\n\n";
if(($fp = fopen("./site/config.php", "a")) && fwrite($fp, $cfg)) {
fclose($fp);
$this->alertOk("Saved configuration to ./site/config.php");
return true;
} else {
$this->alertErr("Error saving configuration to ./site/config.php. Please make sure it is writable.");
return false;
}
}
/**
* Step 3b: Import profile
*
* @param \PDO $database
* @param array $options
*
*/
protected function profileImport($database, array $options) {
if(self::TEST_MODE) {
$this->alertOk("TEST MODE: Skipping profile import");
$this->adminAccount();
return;
}
$profile = "./site/install/";
if(!is_file("{$profile}install.sql")) die("No installation profile found in {$profile}");
$this->sectionStart('fa-building-o Profile Import');
// checks to see if the database exists using an arbitrary query (could just as easily be something else)
try {
$query = $database->prepare("SHOW COLUMNS FROM pages");
$result = $query->execute();
} catch(\Exception $e) {
$result = false;
$query = null;
}
if(self::REPLACE_DB || !$result || $query->rowCount() == 0) {
$this->profileImportSQL($database, "./wire/core/install.sql", $profile . "install.sql", $options);
if(is_dir($profile . "files")) {
$this->profileImportFiles($profile);
} else {
$this->mkdir("./site/assets/files/");
}
$this->mkdir("./site/assets/cache/", true, true);
$this->mkdir("./site/assets/logs/", true, true);
$this->mkdir("./site/assets/backups/", true, true);
$this->mkdir("./site/assets/sessions/", true, true);
} else {
$this->ok("A profile is already imported, skipping...");
}
// copy default site modules /site-default/modules/ to /site/modules/
$dir = "./site/modules/";
$defaultDir = "./" . self::DEFAULT_PROFILE . "/modules/";
if(!is_dir($dir)) $this->mkdir($dir);
if(is_dir($defaultDir)) {
if(is_writable($dir)) {
$result = $this->copyRecursive($defaultDir, $dir, false);
if($result) {
$this->ok("Imported: $defaultDir => $dir");
} else {
$this->warn("Error Importing: $defaultDir => $dir");