5.26.0 release notes: added boilerplate
[civicrm-core.git] / install / index.php
CommitLineData
6a488035
TO
1<?php
2
3/**
4 * Note that this installer has been based of the SilverStripe installer.
5 * You can get more information from the SilverStripe Website at
47465875 6 * http://www.silverstripe.com/.
6a488035
TO
7 *
8 * Copyright (c) 2006-7, SilverStripe Limited - www.silverstripe.com
9 * All rights reserved.
10 *
47465875
DS
11 * License: BSD-3-clause
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions are
14 * met:
15 *
16 * Redistributions of source code must retain the above copyright notice,
17 * this list of conditions and the following disclaimer.
18 *
19 * Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
22 *
23 * Neither the name of SilverStripe nor the names of its contributors may
24 * be used to endorse or promote products derived from this software
25 * without specific prior written permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
28 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
30 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
31 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 *
626f739f 39 * Changes and modifications (c) 2007-2017 by CiviCRM LLC
6a488035
TO
40 *
41 */
42
43/**
44 * CiviCRM Installer
45 */
6a488035
TO
46ini_set('max_execution_time', 3000);
47
48if (stristr(PHP_OS, 'WIN')) {
49 define('CIVICRM_DIRECTORY_SEPARATOR', '/');
481a74f4 50 define('CIVICRM_WINDOWS', 1);
6a488035
TO
51}
52else {
53 define('CIVICRM_DIRECTORY_SEPARATOR', DIRECTORY_SEPARATOR);
481a74f4 54 define('CIVICRM_WINDOWS', 0);
6a488035
TO
55}
56
6a488035 57global $installType;
6a488035 58global $crmPath;
97b8e6b2 59global $pkgPath;
6a488035
TO
60global $installDirPath;
61global $installURLPath;
97b8e6b2 62
aa58127b
WM
63// Set the install type
64// this is sent as a query string when the page is first loaded
65// and subsequently posted to the page as a hidden field
e063fc66
SL
66// only permit acceptable installation types to prevent issues;
67$acceptableInstallTypes = ['drupal', 'wordpress', 'backdrop'];
68if (isset($_POST['civicrm_install_type']) && in_array($_POST['civicrm_install_type'], $acceptableInstallTypes)) {
aa58127b
WM
69 $installType = $_POST['civicrm_install_type'];
70}
e063fc66 71elseif (isset($_GET['civicrm_install_type']) && in_array(strtolower($_GET['civicrm_install_type']), $acceptableInstallTypes)) {
aa58127b
WM
72 $installType = strtolower($_GET['civicrm_install_type']);
73}
74else {
e063fc66 75 // default value if not set and not an acceptable install type.
aa58127b
WM
76 $installType = "drupal";
77}
6a9514e1 78
5757adf3 79if ($installType == 'drupal' || $installType == 'backdrop') {
6a488035
TO
80 $crmPath = dirname(dirname($_SERVER['SCRIPT_FILENAME']));
81 $installDirPath = $installURLPath = '';
82}
83elseif ($installType == 'wordpress') {
84 $crmPath = WP_PLUGIN_DIR . DIRECTORY_SEPARATOR . 'civicrm' . DIRECTORY_SEPARATOR . 'civicrm' . DIRECTORY_SEPARATOR;
85 $installDirPath = WP_PLUGIN_DIR . DIRECTORY_SEPARATOR . 'civicrm' . DIRECTORY_SEPARATOR . 'civicrm' . DIRECTORY_SEPARATOR . 'install' . DIRECTORY_SEPARATOR;
6a488035
TO
86 $installURLPath = WP_PLUGIN_URL . DIRECTORY_SEPARATOR . 'civicrm' . DIRECTORY_SEPARATOR . 'civicrm' . DIRECTORY_SEPARATOR . 'install' . DIRECTORY_SEPARATOR;
87}
6a9514e1
ML
88else {
89 $errorTitle = "Oops! Unsupported installation mode";
90 $errorMsg = sprintf('%s: unknown installation mode. Please refer to the online documentation for more information.', $installType);
91 errorDisplayPage($errorTitle, $errorMsg, FALSE);
92}
6a488035 93
1f180621
TO
94$composerJsonPath = dirname(__DIR__) . DIRECTORY_SEPARATOR . 'composer.json';
95if (file_exists($composerJsonPath)) {
96 $composerJson = json_decode(file_get_contents($composerJsonPath), 1);
97 $minPhpVer = preg_replace(';[~^];', '', $composerJson['require']['php']);
98 if (!version_compare(phpversion(), $minPhpVer, '>=')) {
99 errorDisplayPage('PHP Version Requirement', sprintf("CiviCRM requires PHP %s+. The web server is running PHP %s.", $minPhpVer, phpversion()), FALSE);
100 }
101}
102
97b8e6b2 103$pkgPath = $crmPath . DIRECTORY_SEPARATOR . 'packages';
104
6a488035
TO
105require_once $crmPath . '/CRM/Core/ClassLoader.php';
106CRM_Core_ClassLoader::singleton()->register();
107
6a488035 108$loadGenerated = 0;
aca6ce6e 109if (isset($_POST['loadGenerated'])) {
6a488035
TO
110 $loadGenerated = 1;
111}
112
113require_once dirname(__FILE__) . CIVICRM_DIRECTORY_SEPARATOR . 'langs.php';
114foreach ($langs as $locale => $_) {
115 if ($locale == 'en_US') {
116 continue;
117 }
4f99ca55
TO
118 if (!file_exists(implode(CIVICRM_DIRECTORY_SEPARATOR, array($crmPath, 'sql', "civicrm_data.$locale.mysql")))) {
119 unset($langs[$locale]);
1f5f3294 120 }
6a488035
TO
121}
122
ece6501c 123// Set the CMS
97b8e6b2 124// This is mostly sympbolic, since nothing we do during the install
125// really requires CIVICRM_UF to be defined.
126$installTypeToUF = array(
127 'wordpress' => 'WordPress',
128 'drupal' => 'Drupal',
5757adf3 129 'backdrop' => 'Backdrop',
97b8e6b2 130);
131
2e1f50d6 132$uf = ($installTypeToUF[$installType] ?? 'Drupal');
97b8e6b2 133define('CIVICRM_UF', $uf);
134
ece6501c 135// Set the Locale (required by CRM_Core_Config)
97b8e6b2 136global $tsLocale;
137
138$tsLocale = 'en_US';
6a488035 139$seedLanguage = 'en_US';
97b8e6b2 140
d0051c50 141// Backwards compatibility with default location of l10n files
142if (!defined('CIVICRM_L10N_BASEDIR') && file_exists($crmPath . DIRECTORY_SEPARATOR . 'l10n')) {
143 define('CIVICRM_L10N_BASEDIR', $crmPath . DIRECTORY_SEPARATOR . 'l10n');
144}
145
5f6b3b5d
ML
146// CRM-16801 This validates that seedLanguage is valid by looking in $langs.
147// NB: the variable is initial a $_REQUEST for the initial page reload,
148// then becomes a $_POST when the installation form is submitted.
149if (isset($_REQUEST['seedLanguage']) and isset($langs[$_REQUEST['seedLanguage']])) {
150 $seedLanguage = $_REQUEST['seedLanguage'];
151 $tsLocale = $_REQUEST['seedLanguage'];
6a488035
TO
152}
153
9c6ae641 154CRM_Core_Config::singleton(FALSE);
0ad1e2de
ML
155$GLOBALS['civicrm_default_error_scope'] = NULL;
156
97b8e6b2 157// The translation files are in the parent directory (l10n)
97b8e6b2 158$i18n = CRM_Core_I18n::singleton();
159
3a55aa6b
ML
160// Support for Arabic, Hebrew, Farsi, etc.
161// Used in the template.html
162$short_lang_code = CRM_Core_I18n_PseudoConstant::shortForLong($tsLocale);
163$text_direction = (CRM_Core_I18n::isLanguageRTL($tsLocale) ? 'rtl' : 'ltr');
164
6a488035
TO
165global $cmsPath;
166if ($installType == 'drupal') {
167 //CRM-6840 -don't force to install in sites/all/modules/
168 $object = new CRM_Utils_System_Drupal();
169 $cmsPath = $object->cmsRootPath();
170
171 $siteDir = getSiteDir($cmsPath, $_SERVER['SCRIPT_FILENAME']);
172 $alreadyInstalled = file_exists($cmsPath . CIVICRM_DIRECTORY_SEPARATOR .
173 'sites' . CIVICRM_DIRECTORY_SEPARATOR .
174 $siteDir . CIVICRM_DIRECTORY_SEPARATOR .
175 'civicrm.settings.php'
176 );
177}
5757adf3
HD
178elseif ($installType == 'backdrop') {
179 $object = new CRM_Utils_System_Backdrop();
180 $cmsPath = $object->cmsRootPath();
181 $siteDir = getSiteDir($cmsPath, $_SERVER['SCRIPT_FILENAME']);
683bf891 182 $alreadyInstalled = file_exists($cmsPath . CIVICRM_DIRECTORY_SEPARATOR . 'civicrm.settings.php');
5757adf3 183}
6a488035
TO
184elseif ($installType == 'wordpress') {
185 $cmsPath = WP_PLUGIN_DIR . DIRECTORY_SEPARATOR . 'civicrm';
7ba2c8ad
KC
186 $upload_dir = wp_upload_dir();
187 $files_dirname = $upload_dir['basedir'] . DIRECTORY_SEPARATOR . 'civicrm';
895a7985 188 $wp_civi_settings = $upload_dir['basedir'] . DIRECTORY_SEPARATOR . 'civicrm' . DIRECTORY_SEPARATOR . 'civicrm.settings.php';
e7bf24e8
KC
189 $wp_civi_settings_deprectated = CIVICRM_PLUGIN_DIR . 'civicrm.settings.php';
190 if (file_exists($wp_civi_settings_deprectated)) {
191 $alreadyInstalled = $wp_civi_settings_deprectated;
192 }
193 elseif (file_exists($wp_civi_settings)) {
194 $alreadyInstalled = $wp_civi_settings;
195 }
6a488035
TO
196}
197
6a9514e1
ML
198if ($installType == 'drupal') {
199 // Lets check only /modules/.
200 $pattern = '/' . preg_quote(CIVICRM_DIRECTORY_SEPARATOR . 'modules', CIVICRM_DIRECTORY_SEPARATOR) . '/';
201
202 if (!preg_match($pattern, str_replace("\\", "/", $_SERVER['SCRIPT_FILENAME']))) {
203 $directory = implode(CIVICRM_DIRECTORY_SEPARATOR, array('sites', 'all', 'modules'));
204 $errorTitle = ts("Oops! Please correct your install location");
205 $errorMsg = ts("Please untar (uncompress) your downloaded copy of CiviCRM in the <strong>%1</strong> directory below your Drupal root directory.", array(1 => $directory));
206 errorDisplayPage($errorTitle, $errorMsg);
207 }
208}
209
5757adf3
HD
210if ($installType == 'backdrop') {
211 // Lets check only /modules/.
212 $pattern = '/' . preg_quote(CIVICRM_DIRECTORY_SEPARATOR . 'modules', CIVICRM_DIRECTORY_SEPARATOR) . '/';
213
214 if (!preg_match($pattern, str_replace("\\", "/", $_SERVER['SCRIPT_FILENAME']))) {
215 $directory = 'modules';
216 $errorTitle = ts("Oops! Please correct your install location");
217 $errorMsg = ts("Please untar (uncompress) your downloaded copy of CiviCRM in the <strong>%1</strong> directory below your Drupal root directory.", array(1 => $directory));
218 errorDisplayPage($errorTitle, $errorMsg);
219 }
220}
221
6a488035
TO
222// Exit with error if CiviCRM has already been installed.
223if ($alreadyInstalled) {
6a9514e1
ML
224 $errorTitle = ts("Oops! CiviCRM is already installed");
225 $settings_directory = $cmsPath;
6a488035 226
6a9514e1
ML
227 if ($installType == 'drupal') {
228 $settings_directory = implode(CIVICRM_DIRECTORY_SEPARATOR, array(
229 ts('[your Drupal root directory]'),
230 'sites',
231 $siteDir,
232 ));
6a488035 233 }
5757adf3
HD
234 if ($installType == 'backdrop') {
235 $settings_directory = implode(CIVICRM_DIRECTORY_SEPARATOR, array(
236 ts('[your Backdrop root directory]'),
237 $siteDir,
238 ));
239 }
6a9514e1
ML
240
241 $docLink = CRM_Utils_System::docURL2('Installation and Upgrades', FALSE, ts('Installation Guide'), NULL, NULL, "wiki");
ac2b0d29 242 $errorMsg = ts("CiviCRM has already been installed. <ul><li>To <strong>start over</strong>, you must delete or rename the existing CiviCRM settings file - <strong>civicrm.settings.php</strong> - from <strong>%1</strong>.</li><li>To <strong>upgrade an existing installation</strong>, refer to the online documentation: %2.</li></ul>", array(1 => $settings_directory, 2 => $docLink));
6a9514e1 243 errorDisplayPage($errorTitle, $errorMsg, FALSE);
6a488035
TO
244}
245
246$versionFile = $crmPath . CIVICRM_DIRECTORY_SEPARATOR . 'civicrm-version.php';
247if (file_exists($versionFile)) {
1f5f3294 248 require_once $versionFile;
6a488035
TO
249 $civicrm_version = civicrmVersion();
250}
251else {
252 $civicrm_version = 'unknown';
253}
254
255if ($installType == 'drupal') {
256 // Ensure that they have downloaded the correct version of CiviCRM
6a9514e1
ML
257 if ($civicrm_version['cms'] != 'Drupal' && $civicrm_version['cms'] != 'Drupal6') {
258 $errorTitle = ts("Oops! Incorrect CiviCRM version");
259 $errorMsg = ts("This installer can only be used for the Drupal version of CiviCRM.");
6a488035
TO
260 errorDisplayPage($errorTitle, $errorMsg);
261 }
262
263 define('DRUPAL_ROOT', $cmsPath);
264 $drupalVersionFiles = array(
265 // D6
266 implode(CIVICRM_DIRECTORY_SEPARATOR, array($cmsPath, 'modules', 'system', 'system.module')),
267 // D7
268 implode(CIVICRM_DIRECTORY_SEPARATOR, array($cmsPath, 'includes', 'bootstrap.inc')),
269 );
270 foreach ($drupalVersionFiles as $drupalVersionFile) {
271 if (file_exists($drupalVersionFile)) {
272 require_once $drupalVersionFile;
273 }
274 }
275
bb79149d
WM
276 // Bootstrap Drupal to get settings and user
277 $base_root = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ? 'https' : 'http';
278 $base_root .= '://' . $_SERVER['HTTP_HOST'];
279 $base_url = $base_root;
280 drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
281
282 // Check that user is logged in and has administrative permissions
283 // This is necessary because the script exposes the database settings in the form and these could be viewed by unauthorised users
284 if ((!function_exists('user_access')) || (!user_access('administer site configuration'))) {
285 $errorTitle = ts("You don't have permission to access this page");
286 $errorMsg = ts("The installer can only be run by a user with the permission to administer site configuration.");
287 errorDisplayPage($errorTitle, $errorMsg);
288 exit();
289 }
db922230 290
6a488035 291 if (!defined('VERSION') or version_compare(VERSION, '6.0') < 0) {
6a9514e1
ML
292 $errorTitle = ts("Oops! Incorrect Drupal version");
293 $errorMsg = ts("This version of CiviCRM can only be used with Drupal 6.x or 7.x. Please ensure that '%1' exists if you are running Drupal 7.0 and over.", array(1 => implode("' or '", $drupalVersionFiles)));
6a488035
TO
294 errorDisplayPage($errorTitle, $errorMsg);
295 }
296}
5757adf3
HD
297elseif ($installType == 'backdrop') {
298 // Ensure that they have downloaded the correct version of CiviCRM
299 if ($civicrm_version['cms'] != 'Backdrop') {
300 $errorTitle = ts("Oops! Incorrect CiviCRM version");
301 $errorMsg = ts("This installer can only be used for the Backdrop version of CiviCRM.");
302 errorDisplayPage($errorTitle, $errorMsg);
303 }
304
305 define('BACKDROP_ROOT', $cmsPath);
306
307 $backdropVersionFiles = array(
308 // Backdrop
309 implode(CIVICRM_DIRECTORY_SEPARATOR, array($cmsPath, 'core', 'includes', 'bootstrap.inc')),
310 );
311 foreach ($backdropVersionFiles as $backdropVersionFile) {
312 if (file_exists($backdropVersionFile)) {
313 require_once $backdropVersionFile;
314 }
315 }
316 if (!defined('BACKDROP_VERSION') or version_compare(BACKDROP_VERSION, '1.0') < 0) {
317 $errorTitle = ts("Oops! Incorrect Backdrop version");
318 $errorMsg = ts("This version of CiviCRM can only be used with Backdrop 1.x. Please ensure that '%1' exists if you are running Backdrop 1.0 and over.", array(1 => implode("' or '", $backdropVersionFiles)));
319 errorDisplayPage($errorTitle, $errorMsg);
320 }
321}
6a488035
TO
322elseif ($installType == 'wordpress') {
323 //HACK for now
324 $civicrm_version['cms'] = 'WordPress';
325
326 // Ensure that they have downloaded the correct version of CiviCRM
327 if ($civicrm_version['cms'] != 'WordPress') {
6a9514e1
ML
328 $errorTitle = ts("Oops! Incorrect CiviCRM version");
329 $errorMsg = ts("This installer can only be used for the WordPress version of CiviCRM.");
6a488035
TO
330 errorDisplayPage($errorTitle, $errorMsg);
331 }
332}
333
9178521b 334// Load CiviCRM database config
09e6ef4a 335if (isset($_POST['mysql'])) {
7f5a1bb1 336 $databaseConfig = $_POST['mysql'];
09e6ef4a 337}
09e6ef4a
WM
338
339if ($installType == 'wordpress') {
7f5a1bb1
WM
340 // Load WP database config
341 if (isset($_POST['mysql'])) {
342 $databaseConfig = $_POST['mysql'];
343 }
344 else {
7862a492 345 $databaseConfig = array(
7f5a1bb1
WM
346 "server" => DB_HOST,
347 "username" => DB_USER,
348 "password" => DB_PASSWORD,
349 "database" => DB_NAME,
7862a492 350 );
7f5a1bb1 351 }
09e6ef4a
WM
352}
353
354if ($installType == 'drupal') {
7f5a1bb1
WM
355 // Load drupal database config
356 if (isset($_POST['drupal'])) {
357 $drupalConfig = $_POST['drupal'];
358 }
359 else {
61ab5109
WM
360 $dbServer = $databases['default']['default']['host'];
361 if (!empty($databases['default']['default']['port'])) {
362 $dbServer .= ':' . $databases['default']['default']['port'];
363 }
7862a492 364 $drupalConfig = array(
61ab5109 365 "server" => $dbServer,
7f5a1bb1
WM
366 "username" => $databases['default']['default']['username'],
367 "password" => $databases['default']['default']['password'],
368 "database" => $databases['default']['default']['database'],
7862a492 369 );
7f5a1bb1 370 }
09e6ef4a
WM
371}
372
373if ($installType == 'backdrop') {
7f5a1bb1
WM
374 // Load backdrop database config
375 if (isset($_POST['backdrop'])) {
376 $backdropConfig = $_POST['backdrop'];
377 }
378 else {
7862a492 379 $backdropConfig = array(
7f5a1bb1
WM
380 "server" => "localhost",
381 "username" => "backdrop",
382 "password" => "",
383 "database" => "backdrop",
7862a492 384 );
7f5a1bb1 385 }
09e6ef4a
WM
386}
387
9178521b
WM
388// By default set CiviCRM database to be same as CMS database
389if (!isset($databaseConfig)) {
390 if (($installType == 'drupal') && (isset($drupalConfig))) {
391 $databaseConfig = $drupalConfig;
392 }
393 if (($installType == 'backdrop') && (isset($backdropConfig))) {
394 $databaseConfig = $backdropConfig;
395 }
396}
397
6a488035
TO
398// Check requirements
399$req = new InstallRequirements();
400$req->check();
401
402if ($req->hasErrors()) {
403 $hasErrorOtherThanDatabase = TRUE;
404}
405
406if ($databaseConfig) {
407 $dbReq = new InstallRequirements();
408 $dbReq->checkdatabase($databaseConfig, 'CiviCRM');
409 if ($installType == 'drupal') {
410 $dbReq->checkdatabase($drupalConfig, 'Drupal');
411 }
5757adf3
HD
412 if ($installType == 'backdrop') {
413 $dbReq->checkdatabase($backdropConfig, 'Backdrop');
414 }
6a488035
TO
415}
416
417// Actual processor
aca6ce6e 418if (isset($_POST['go']) && !$req->hasErrors() && !$dbReq->hasErrors()) {
6a488035 419 // Confirm before reinstalling
aca6ce6e 420 if (!isset($_POST['force_reinstall']) && $alreadyInstalled) {
1f5f3294 421 include $installDirPath . 'template.html';
6a488035
TO
422 }
423 else {
424 $inst = new Installer();
aca6ce6e 425 $inst->install($_POST);
6a488035
TO
426 }
427
428 // Show the config form
429}
430else {
1f5f3294 431 include $installDirPath . 'template.html';
6a488035
TO
432}
433
434/**
435 * This class checks requirements
436 * Each of the requireXXX functions takes an argument which gives a user description of the test. It's an array
437 * of 3 parts:
6a9514e1 438 * $description[0] - The test category
6a488035
TO
439 * $description[1] - The test title
440 * $description[2] - The test error to show, if it goes wrong
441 */
442class InstallRequirements {
683bf891
SL
443 public $errors;
444 public $warnings;
445 public $tests;
446 public $conn;
6a488035
TO
447
448 // @see CRM_Upgrade_Form::MINIMUM_THREAD_STACK
449 const MINIMUM_THREAD_STACK = 192;
450
451 /**
fe482240 452 * Just check that the database configuration is okay.
d7c8cf03
EM
453 * @param $databaseConfig
454 * @param $dbName
6a488035 455 */
971d41b1 456 public function checkdatabase($databaseConfig, $dbName) {
fcf908c6 457 if ($this->requireFunction('mysqli_connect',
56fdfc52 458 array(
97b8e6b2 459 ts("PHP Configuration"),
460 ts("MySQL support"),
461 ts("MySQL support not included in PHP."),
56fdfc52
TO
462 )
463 )
464 ) {
6a488035
TO
465 $this->requireMySQLServer($databaseConfig['server'],
466 array(
2f8082cd
ML
467 ts("MySQL %1 Configuration", array(1 => $dbName)),
468 ts("Does the server exist?"),
469 ts("Can't find the a MySQL server on '%1'.", array(1 => $databaseConfig['server'])),
6a488035
TO
470 $databaseConfig['server'],
471 )
472 );
473 if ($this->requireMysqlConnection($databaseConfig['server'],
56fdfc52
TO
474 $databaseConfig['username'],
475 $databaseConfig['password'],
476 array(
2f8082cd
ML
477 ts("MySQL %1 Configuration", array(1 => $dbName)),
478 ts("Are the access credentials correct?"),
479 ts("That username/password doesn't work"),
56fdfc52
TO
480 )
481 )
482 ) {
965596b4 483 @$this->requireMySQLVersion(CRM_Upgrade_Incremental_General::MIN_INSTALL_MYSQL_VER,
6a488035 484 array(
2f8082cd 485 ts("MySQL %1 Configuration", array(1 => $dbName)),
965596b4
SL
486 ts("MySQL version at least %1", array(1 => CRM_Upgrade_Incremental_General::MIN_INSTALL_MYSQL_VER)),
487 ts("MySQL version %1 or higher is required, you are running MySQL %2.", array(1 => CRM_Upgrade_Incremental_General::MIN_INSTALL_MYSQL_VER, 2 => mysqli_get_server_info($this->conn))),
fcf908c6 488 ts("MySQL %1", array(1 => mysqli_get_server_info($this->conn))),
6a488035
TO
489 )
490 );
491 $this->requireMySQLAutoIncrementIncrementOne($databaseConfig['server'],
492 $databaseConfig['username'],
493 $databaseConfig['password'],
494 array(
2f8082cd
ML
495 ts("MySQL %1 Configuration", array(1 => $dbName)),
496 ts("Is auto_increment_increment set to 1"),
497 ts("An auto_increment_increment value greater than 1 is not currently supported. Please see issue CRM-7923 for further details and potential workaround."),
6a488035
TO
498 )
499 );
e5d3a11d
PN
500 $testDetails = array(
501 ts("MySQL %1 Configuration", array(1 => $dbName)),
502 ts("Is the provided database name valid?"),
ee17d64d 503 ts("The database name provided is not valid. Please use only 0-9, a-z, A-Z, _ and - as characters in the name."),
e5d3a11d 504 );
ee17d64d 505 if (!CRM_Core_DAO::requireSafeDBName($databaseConfig['database'])) {
e5d3a11d 506 $this->error($testDetails);
ff3f52f7
PN
507 return FALSE;
508 }
e5d3a11d
PN
509 else {
510 $this->testing($testDetails);
511 }
6a488035
TO
512 $this->requireMySQLThreadStack($databaseConfig['server'],
513 $databaseConfig['username'],
514 $databaseConfig['password'],
515 $databaseConfig['database'],
516 self::MINIMUM_THREAD_STACK,
517 array(
2f8082cd
ML
518 ts("MySQL %1 Configuration", array(1 => $dbName)),
519 ts("Does MySQL thread_stack meet minimum (%1k)", array(1 => self::MINIMUM_THREAD_STACK)),
56fdfc52
TO
520 "",
521 // "The MySQL thread_stack does not meet minimum " . CRM_Upgrade_Form::MINIMUM_THREAD_STACK . "k. Please update thread_stack in my.cnf.",
6a488035
TO
522 )
523 );
524 }
1699214f 525 $onlyRequire = $dbName == 'Drupal' || $dbName == 'Backdrop';
6a488035
TO
526 $this->requireDatabaseOrCreatePermissions(
527 $databaseConfig['server'],
528 $databaseConfig['username'],
529 $databaseConfig['password'],
530 $databaseConfig['database'],
531 array(
2f8082cd
ML
532 ts("MySQL %1 Configuration", array(1 => $dbName)),
533 ts("Can I access/create the database?"),
5f40a878 534 ts("I can't create new databases and the database '%1' doesn't exist.", array(1 => $databaseConfig['database'])),
6a488035
TO
535 ),
536 $onlyRequire
537 );
5757adf3 538 if ($dbName != 'Drupal' && $dbName != 'Backdrop') {
1b4a049e
AP
539 $this->requireNoExistingData(
540 $databaseConfig['server'],
541 $databaseConfig['username'],
542 $databaseConfig['password'],
543 $databaseConfig['database'],
544 array(
545 ts("MySQL %1 Configuration", array(1 => $dbName)),
c66b58c9 546 ts("Does the database have data from a previous installation?"),
1b4a049e
AP
547 ts("CiviCRM data from previous installation exists in '%1'.", array(1 => $databaseConfig['database'])),
548 )
549 );
6a488035
TO
550 $this->requireMySQLInnoDB($databaseConfig['server'],
551 $databaseConfig['username'],
552 $databaseConfig['password'],
553 $databaseConfig['database'],
554 array(
2f8082cd
ML
555 ts("MySQL %1 Configuration", array(1 => $dbName)),
556 ts("Can I access/create InnoDB tables in the database?"),
557 ts("Unable to create InnoDB tables. MySQL InnoDB support is required for CiviCRM but is either not available or not enabled in this MySQL database server."),
6a488035
TO
558 )
559 );
560 $this->requireMySQLTempTables($databaseConfig['server'],
561 $databaseConfig['username'],
562 $databaseConfig['password'],
563 $databaseConfig['database'],
564 array(
2f8082cd
ML
565 ts("MySQL %1 Configuration", array(1 => $dbName)),
566 ts('Can I create temporary tables in the database?'),
567 ts('Unable to create temporary tables. This MySQL user is missing the CREATE TEMPORARY TABLES privilege.'),
6a488035
TO
568 )
569 );
570 $this->requireMySQLLockTables($databaseConfig['server'],
571 $databaseConfig['username'],
572 $databaseConfig['password'],
573 $databaseConfig['database'],
574 array(
2f8082cd
ML
575 ts("MySQL %1 Configuration", array(1 => $dbName)),
576 ts('Can I create lock tables in the database?'),
577 ts('Unable to lock tables. This MySQL user is missing the LOCK TABLES privilege.'),
6a488035
TO
578 )
579 );
580 $this->requireMySQLTrigger($databaseConfig['server'],
581 $databaseConfig['username'],
582 $databaseConfig['password'],
583 $databaseConfig['database'],
584 array(
2f8082cd
ML
585 ts("MySQL %1 Configuration", array(1 => $dbName)),
586 ts('Can I create triggers in the database?'),
587 ts('Unable to create triggers. This MySQL user is missing the CREATE TRIGGERS privilege.'),
6a488035
TO
588 )
589 );
75615982 590 $this->requireMySQLUtf8mb4($databaseConfig['server'],
591 $databaseConfig['username'],
592 $databaseConfig['password'],
593 $databaseConfig['database'],
594 array(
595 ts("MySQL %1 Configuration", array(1 => $dbName)),
596 ts('Is the <code>utf8mb4</code> character set supported?'),
597 ts('This MySQL server does not support the <code>utf8mb4</code> character set.'),
598 )
599 );
6a488035
TO
600 }
601 }
602 }
603
6a511829
TO
604 /**
605 * Connect via mysqli.
606 *
607 * This is exactly the same as mysqli_connect(), except that it accepts
608 * the port as part of the `$host`.
609 *
28d4c718
TO
610 * @param string $host
611 * Ex: 'localhost', 'localhost:3307', '127.0.0.1:3307', '[::1]', '[::1]:3307'.
612 * @param string $username
613 * @param string $password
6a511829
TO
614 * @param string $database
615 * @return \mysqli
616 */
617 protected function connect($host, $username, $password, $database = '') {
618 $hostParts = explode(':', $host);
8e1997f9
TO
619 if (count($hostParts) > 1 && strrpos($host, ']') !== strlen($host) - 1) {
620 $port = array_pop($hostParts);
621 $host = implode(':', $hostParts);
6a511829
TO
622 }
623 else {
5df2c60d 624 $port = NULL;
6a511829
TO
625 }
626 $conn = @mysqli_connect($host, $username, $password, $database, $port);
627 return $conn;
628 }
629
6a488035 630 /**
fe482240 631 * Check everything except the database.
6a488035 632 */
971d41b1 633 public function check() {
6a488035
TO
634 global $crmPath, $installType;
635
636 $this->errors = NULL;
637
cc1f4988 638 $this->requirePHPVersion(array(
2f8082cd 639 ts("PHP Configuration"),
bd17dd0f 640 ts("PHP7 installed"),
56fdfc52 641 ));
6a488035
TO
642
643 // Check that we can identify the root folder successfully
d34d7fa8 644 $this->requireFile($crmPath . CIVICRM_DIRECTORY_SEPARATOR . 'README.md',
6a488035 645 array(
2f8082cd
ML
646 ts("File permissions"),
647 ts("Does the webserver know where files are stored?"),
648 ts("The webserver isn't letting me identify where files are stored."),
6a488035
TO
649 $this->getBaseDir(),
650 ),
651 TRUE
652 );
653
654 // CRM-6485: make sure the path does not contain PATH_SEPARATOR, as we don’t know how to escape it
655 $this->requireNoPathSeparator(
656 array(
2f8082cd
ML
657 ts("File permissions"),
658 ts('Does the CiviCRM path contain PATH_SEPARATOR?'),
659 ts('The path %1 contains PATH_SEPARATOR (the %2 character).', array(1 => $this->getBaseDir(), 2 => PATH_SEPARATOR)),
6a488035
TO
660 $this->getBaseDir(),
661 )
662 );
663
664 $requiredDirectories = array('CRM', 'packages', 'templates', 'js', 'api', 'i', 'sql');
665 foreach ($requiredDirectories as $dir) {
666 $this->requireFile($crmPath . CIVICRM_DIRECTORY_SEPARATOR . $dir,
667 array(
2f8082cd
ML
668 ts("File permissions"),
669 ts("Folder '%1' exists?", array(1 => $dir)),
670 ts("There is no '%1' folder.", array(1 => $dir)),
56fdfc52 671 ), TRUE
6a488035
TO
672 );
673 }
674
675 $configIDSiniDir = NULL;
676 global $cmsPath;
3fdcdfbb 677 $siteDir = getSiteDir($cmsPath, $_SERVER['SCRIPT_FILENAME']);
6a488035 678 if ($installType == 'drupal') {
6a488035
TO
679
680 // make sure that we can write to sites/default and files/
681 $writableDirectories = array(
682 $cmsPath . CIVICRM_DIRECTORY_SEPARATOR .
683 'sites' . CIVICRM_DIRECTORY_SEPARATOR .
684 $siteDir . CIVICRM_DIRECTORY_SEPARATOR .
685 'files',
686 $cmsPath . CIVICRM_DIRECTORY_SEPARATOR .
687 'sites' . CIVICRM_DIRECTORY_SEPARATOR .
688 $siteDir,
689 );
690 }
5757adf3
HD
691 elseif ($installType == 'backdrop') {
692
693 // make sure that we can write to sites/default and files/
694 $writableDirectories = array(
695 $cmsPath . CIVICRM_DIRECTORY_SEPARATOR .
696 'files',
697 $cmsPath,
698 );
699 }
6a488035 700 elseif ($installType == 'wordpress') {
7ba2c8ad
KC
701 // make sure that we can write to uploads/civicrm/
702 $upload_dir = wp_upload_dir();
703 $files_dirname = $upload_dir['basedir'] . DIRECTORY_SEPARATOR . 'civicrm';
704 if (!file_exists($files_dirname)) {
705 wp_mkdir_p($files_dirname);
706 }
707 $writableDirectories = array($files_dirname);
6a488035
TO
708 }
709
710 foreach ($writableDirectories as $dir) {
711 $dirName = CIVICRM_WINDOWS ? $dir : CIVICRM_DIRECTORY_SEPARATOR . $dir;
2f8082cd
ML
712 $testDetails = array(
713 ts("File permissions"),
714 ts("Is the %1 folder writeable?", array(1 => $dir)),
715 NULL,
6a488035 716 );
2f8082cd 717 $this->requireWriteable($dirName, $testDetails, TRUE);
6a488035
TO
718 }
719
6a488035
TO
720 // Check for rewriting
721 if (isset($_SERVER['SERVER_SOFTWARE'])) {
722 $webserver = strip_tags(trim($_SERVER['SERVER_SOFTWARE']));
723 }
724 elseif (isset($_SERVER['SERVER_SIGNATURE'])) {
725 $webserver = strip_tags(trim($_SERVER['SERVER_SIGNATURE']));
726 }
727
728 if ($webserver == '') {
2f8082cd 729 $webserver = ts("I can't tell what webserver you are running");
6a488035
TO
730 }
731
732 // Check for $_SERVER configuration
56fdfc52 733 $this->requireServerVariables(array('SCRIPT_NAME', 'HTTP_HOST', 'SCRIPT_FILENAME'), array(
2f8082cd
ML
734 ts("Webserver config"),
735 ts("Recognised webserver"),
736 ts("You seem to be using an unsupported webserver. The server variables SCRIPT_NAME, HTTP_HOST, SCRIPT_FILENAME need to be set."),
56fdfc52 737 ));
6a488035
TO
738
739 // Check for MySQL support
fcf908c6 740 $this->requireFunction('mysqli_connect', array(
2f8082cd
ML
741 ts("PHP Configuration"),
742 ts("MySQL support"),
743 ts("MySQL support not included in PHP."),
744 ));
6a488035 745
927a045d
J
746 // Check for XML support
747 $this->requireFunction('simplexml_load_file', array(
748 ts("PHP Configuration"),
8d241549
J
749 ts("SimpleXML support"),
750 ts("SimpleXML support not included in PHP."),
927a045d
J
751 ));
752
6a488035 753 // Check for JSON support
2f8082cd
ML
754 $this->requireFunction('json_encode', array(
755 ts("PHP Configuration"),
756 ts("JSON support"),
757 ts("JSON support not included in PHP."),
758 ));
6a488035 759
cbd60be4
SL
760 // check for Multibyte support such as mb_substr. Required for proper handling of Multilingual setups.
761 $this->requireFunction('mb_substr', array(
762 ts("PHP Configuration"),
763 ts("Multibyte support"),
764 ts("Multibyte support not enabled in PHP."),
765 ));
766
6a488035
TO
767 // Check for xcache_isset and emit warning if exists
768 $this->checkXCache(array(
2f8082cd
ML
769 ts("PHP Configuration"),
770 ts("XCache compatibility"),
771 ts("XCache is installed and there are known compatibility issues between XCache and CiviCRM. Consider using an alternative PHP caching mechanism or disable PHP caching altogether."),
56fdfc52 772 ));
6a488035
TO
773
774 // Check memory allocation
775 $this->requireMemory(32 * 1024 * 1024,
776 64 * 1024 * 1024,
777 array(
2f8082cd
ML
778 ts("PHP Configuration"),
779 ts("Memory allocated (PHP config option 'memory_limit')"),
780 ts("CiviCRM needs a minimum of %1 MB allocated to PHP, but recommends %2 MB.", array(1 => 32, 2 => 64)),
6a488035
TO
781 ini_get("memory_limit"),
782 )
783 );
784
785 return $this->errors;
786 }
787
627456b5
EM
788 /**
789 * @param $min
790 * @param $recommended
791 * @param $testDetails
792 */
971d41b1 793 public function requireMemory($min, $recommended, $testDetails) {
6a488035
TO
794 $this->testing($testDetails);
795 $mem = $this->getPHPMemory();
796
797 if ($mem < $min && $mem > 0) {
2f8082cd 798 $testDetails[2] .= " " . ts("You only have %1 allocated", array(1 => ini_get("memory_limit")));
6a488035
TO
799 $this->error($testDetails);
800 }
801 elseif ($mem < $recommended && $mem > 0) {
2f8082cd 802 $testDetails[2] .= " " . ts("You only have %1 allocated", array(1 => ini_get("memory_limit")));
6a488035
TO
803 $this->warning($testDetails);
804 }
805 elseif ($mem == 0) {
2f8082cd 806 $testDetails[2] .= " " . ts("We can't determine how much memory you have allocated. Install only if you're sure you've allocated at least %1 MB.", array(1 => 32));
6a488035
TO
807 $this->warning($testDetails);
808 }
809 }
810
627456b5
EM
811 /**
812 * @return float
813 */
971d41b1 814 public function getPHPMemory() {
6a488035
TO
815 $memString = ini_get("memory_limit");
816
817 switch (strtolower(substr($memString, -1))) {
818 case "k":
819 return round(substr($memString, 0, -1) * 1024);
820
821 case "m":
822 return round(substr($memString, 0, -1) * 1024 * 1024);
823
824 case "g":
825 return round(substr($memString, 0, -1) * 1024 * 1024 * 1024);
826
827 default:
828 return round($memString);
829 }
830 }
831
971d41b1 832 public function listErrors() {
6a488035 833 if ($this->errors) {
2f8082cd 834 echo "<p>" . ts("The following problems are preventing me from installing CiviCRM:") . "</p>";
6a488035
TO
835 foreach ($this->errors as $error) {
836 echo "<li>" . htmlentities($error) . "</li>";
837 }
838 }
839 }
840
627456b5
EM
841 /**
842 * @param null $section
843 */
971d41b1 844 public function showTable($section = NULL) {
6a488035
TO
845 if ($section) {
846 $tests = $this->tests[$section];
847 echo "<table class=\"testResults\" width=\"100%\">";
848 foreach ($tests as $test => $result) {
849 echo "<tr class=\"$result[0]\"><td>$test</td><td>" . nl2br(htmlentities($result[1])) . "</td></tr>";
850 }
851 echo "</table>";
852 }
853 else {
854 foreach ($this->tests as $section => $tests) {
855 echo "<h3>$section</h3>";
856 echo "<table class=\"testResults\" width=\"100%\">";
857
858 foreach ($tests as $test => $result) {
859 echo "<tr class=\"$result[0]\"><td>$test</td><td>" . nl2br(htmlentities($result[1])) . "</td></tr>";
860 }
861 echo "</table>";
862 }
863 }
864 }
865
627456b5 866 /**
100fef9d 867 * @param string $funcName
627456b5
EM
868 * @param $testDetails
869 *
870 * @return bool
871 */
971d41b1 872 public function requireFunction($funcName, $testDetails) {
6a488035
TO
873 $this->testing($testDetails);
874
875 if (!function_exists($funcName)) {
876 $this->error($testDetails);
877 return FALSE;
878 }
879 else {
880 return TRUE;
881 }
882 }
883
627456b5
EM
884 /**
885 * @param $testDetails
886 */
971d41b1 887 public function checkXCache($testDetails) {
6a488035
TO
888 if (function_exists('xcache_isset') &&
889 ini_get('xcache.size') > 0
890 ) {
891 $this->testing($testDetails);
892 $this->warning($testDetails);
893 }
894 }
895
627456b5 896 /**
cc1f4988
CW
897 * @param array $testDetails
898 * @return bool
627456b5 899 */
cc1f4988 900 public function requirePHPVersion($testDetails) {
6a488035
TO
901
902 $this->testing($testDetails);
903
56fdfc52 904 $phpVersion = phpversion();
cc1f4988 905 $aboveMinVersion = version_compare($phpVersion, CRM_Upgrade_Incremental_General::MIN_INSTALL_PHP_VER) >= 0;
6a488035 906
cc1f4988 907 if ($aboveMinVersion) {
f0c475b0 908 if (version_compare($phpVersion, CRM_Upgrade_Incremental_General::MIN_RECOMMENDED_PHP_VER) < 0) {
cc1f4988 909 $testDetails[2] = ts('This webserver is running an outdated version of PHP (%1). It is strongly recommended to upgrade to PHP %2 or later, as older versions can present a security risk. The preferred version is %3.', array(
f0c475b0 910 1 => $phpVersion,
ef064e55 911 2 => CRM_Upgrade_Incremental_General::MIN_RECOMMENDED_PHP_VER,
f955c30c 912 3 => preg_replace(';^(\d+\.\d+(?:\.[1-9]\d*)?).*$;', '\1', CRM_Upgrade_Incremental_General::RECOMMENDED_PHP_VER),
ef064e55
CW
913 ));
914 $this->warning($testDetails);
915 }
6a488035
TO
916 return TRUE;
917 }
918
cc1f4988
CW
919 if (empty($testDetails[2])) {
920 $testDetails[2] = ts("You need PHP version %1 or later, only %2 is installed. Please upgrade your server, or ask your web-host to do so.", array(1 => CRM_Upgrade_Incremental_General::MIN_INSTALL_PHP_VER, 2 => $phpVersion));
6a488035
TO
921 }
922
923 $this->error($testDetails);
924 }
925
627456b5 926 /**
100fef9d 927 * @param string $filename
627456b5
EM
928 * @param $testDetails
929 * @param bool $absolute
930 */
971d41b1 931 public function requireFile($filename, $testDetails, $absolute = FALSE) {
6a488035
TO
932 $this->testing($testDetails);
933 if (!$absolute) {
934 $filename = $this->getBaseDir() . $filename;
935 }
936 if (!file_exists($filename)) {
2f8082cd 937 $testDetails[2] .= " (" . ts("file '%1' not found", array(1 => $filename)) . ')';
6a488035
TO
938 $this->error($testDetails);
939 }
940 }
941
627456b5
EM
942 /**
943 * @param $testDetails
944 */
971d41b1 945 public function requireNoPathSeparator($testDetails) {
6a488035
TO
946 $this->testing($testDetails);
947 if (substr_count($this->getBaseDir(), PATH_SEPARATOR)) {
948 $this->error($testDetails);
949 }
950 }
951
627456b5 952 /**
100fef9d 953 * @param string $filename
627456b5
EM
954 * @param $testDetails
955 */
971d41b1 956 public function requireNoFile($filename, $testDetails) {
6a488035
TO
957 $this->testing($testDetails);
958 $filename = $this->getBaseDir() . $filename;
959 if (file_exists($filename)) {
2f8082cd 960 $testDetails[2] .= " (" . ts("file '%1' found", array(1 => $filename)) . ")";
6a488035
TO
961 $this->error($testDetails);
962 }
963 }
964
627456b5 965 /**
100fef9d 966 * @param string $filename
627456b5
EM
967 * @param $testDetails
968 */
971d41b1 969 public function moveFileOutOfTheWay($filename, $testDetails) {
6a488035
TO
970 $this->testing($testDetails);
971 $filename = $this->getBaseDir() . $filename;
972 if (file_exists($filename)) {
973 if (file_exists("$filename.bak")) {
974 rm("$filename.bak");
975 }
976 rename($filename, "$filename.bak");
977 }
978 }
979
627456b5 980 /**
100fef9d 981 * @param string $filename
627456b5
EM
982 * @param $testDetails
983 * @param bool $absolute
984 */
971d41b1 985 public function requireWriteable($filename, $testDetails, $absolute = FALSE) {
6a488035
TO
986 $this->testing($testDetails);
987 if (!$absolute) {
988 $filename = $this->getBaseDir() . $filename;
989 }
990
22e263ad 991 if (!is_writable($filename)) {
6a488035
TO
992 $name = NULL;
993 if (function_exists('posix_getpwuid')) {
994 $user = posix_getpwuid(posix_geteuid());
995 $name = '- ' . $user['name'] . ' -';
996 }
997
998 if (!isset($testDetails[2])) {
999 $testDetails[2] = NULL;
1000 }
2f8082cd 1001 $testDetails[2] .= ts("The user account used by your web-server %1 needs to be granted write access to the following directory in order to configure the CiviCRM settings file:", array(1 => $name)) . "\n$filename";
6a488035
TO
1002 $this->error($testDetails);
1003 }
1004 }
1005
627456b5 1006 /**
100fef9d 1007 * @param string $moduleName
627456b5
EM
1008 * @param $testDetails
1009 */
971d41b1 1010 public function requireApacheModule($moduleName, $testDetails) {
6a488035
TO
1011 $this->testing($testDetails);
1012 if (!in_array($moduleName, apache_get_modules())) {
1013 $this->error($testDetails);
1014 }
1015 }
1016
627456b5
EM
1017 /**
1018 * @param $server
100fef9d 1019 * @param string $username
627456b5
EM
1020 * @param $password
1021 * @param $testDetails
1022 */
971d41b1 1023 public function requireMysqlConnection($server, $username, $password, $testDetails) {
6a488035 1024 $this->testing($testDetails);
6a511829 1025 $this->conn = $this->connect($server, $username, $password);
6a488035 1026
fcf908c6 1027 if ($this->conn) {
6a488035
TO
1028 return TRUE;
1029 }
1030 else {
fcf908c6 1031 $testDetails[2] .= ": " . mysqli_connect_error();
6a488035
TO
1032 $this->error($testDetails);
1033 }
1034 }
1035
627456b5
EM
1036 /**
1037 * @param $server
1038 * @param $testDetails
1039 */
971d41b1 1040 public function requireMySQLServer($server, $testDetails) {
6a488035 1041 $this->testing($testDetails);
6a511829 1042 $conn = $this->connect($server, NULL, NULL);
6a488035 1043
fcf908c6 1044 if ($conn || mysqli_connect_errno() < 2000) {
6a488035
TO
1045 return TRUE;
1046 }
1047 else {
fcf908c6 1048 $testDetails[2] .= ": " . mysqli_connect_error();
6a488035
TO
1049 $this->error($testDetails);
1050 }
1051 }
1052
627456b5
EM
1053 /**
1054 * @param $version
1055 * @param $testDetails
1056 */
971d41b1 1057 public function requireMySQLVersion($version, $testDetails) {
6a488035
TO
1058 $this->testing($testDetails);
1059
fcf908c6 1060 if (!mysqli_get_server_info($this->conn)) {
2f8082cd 1061 $testDetails[2] = ts('Cannot determine the version of MySQL installed. Please ensure at least version %1 is installed.', array(1 => $version));
6a488035
TO
1062 $this->warning($testDetails);
1063 }
1064 else {
1065 list($majorRequested, $minorRequested) = explode('.', $version);
fcf908c6 1066 list($majorHas, $minorHas) = explode('.', mysqli_get_server_info($this->conn));
6a488035
TO
1067
1068 if (($majorHas > $majorRequested) || ($majorHas == $majorRequested && $minorHas >= $minorRequested)) {
1069 return TRUE;
1070 }
1071 else {
1072 $testDetails[2] .= "{$majorHas}.{$minorHas}.";
1073 $this->error($testDetails);
1074 }
1075 }
1076 }
1077
627456b5
EM
1078 /**
1079 * @param $server
100fef9d 1080 * @param string $username
627456b5
EM
1081 * @param $password
1082 * @param $database
1083 * @param $testDetails
1084 */
971d41b1 1085 public function requireMySQLInnoDB($server, $username, $password, $database, $testDetails) {
6a488035 1086 $this->testing($testDetails);
6a511829 1087 $conn = $this->connect($server, $username, $password);
6a488035 1088 if (!$conn) {
2f8082cd 1089 $testDetails[2] .= ' ' . ts("Could not determine if MySQL has InnoDB support. Assuming no.");
6a488035
TO
1090 $this->error($testDetails);
1091 return;
1092 }
1093
1094 $innodb_support = FALSE;
fcf908c6 1095 $result = mysqli_query($conn, "SHOW ENGINES");
1096 while ($values = mysqli_fetch_array($result)) {
6a488035
TO
1097 if ($values['Engine'] == 'InnoDB') {
1098 if (strtolower($values['Support']) == 'yes' ||
1099 strtolower($values['Support']) == 'default'
1100 ) {
1101 $innodb_support = TRUE;
1102 }
1103 }
1104 }
1105 if ($innodb_support) {
2f8082cd 1106 $testDetails[3] = ts('MySQL server does have InnoDB support');
6a488035
TO
1107 }
1108 else {
2f8082cd 1109 $testDetails[2] .= ' ' . ts('Could not determine if MySQL has InnoDB support. Assuming no');
6a488035
TO
1110 }
1111 }
1112
627456b5
EM
1113 /**
1114 * @param $server
100fef9d 1115 * @param string $username
627456b5
EM
1116 * @param $password
1117 * @param $database
1118 * @param $testDetails
1119 */
971d41b1 1120 public function requireMySQLTempTables($server, $username, $password, $database, $testDetails) {
6a488035 1121 $this->testing($testDetails);
6a511829 1122 $conn = $this->connect($server, $username, $password);
6a488035 1123 if (!$conn) {
2f8082cd 1124 $testDetails[2] = ts('Could not login to the database.');
6a488035
TO
1125 $this->error($testDetails);
1126 return;
1127 }
1128
fcf908c6 1129 if (!@mysqli_select_db($conn, $database)) {
2f8082cd 1130 $testDetails[2] = ts('Could not select the database.');
6a488035
TO
1131 $this->error($testDetails);
1132 return;
1133 }
1134
fcf908c6 1135 $result = mysqli_query($conn, 'CREATE TEMPORARY TABLE civicrm_install_temp_table_test (test text)');
6a488035 1136 if (!$result) {
2f8082cd 1137 $testDetails[2] = ts('Could not create a temp table.');
6a488035
TO
1138 $this->error($testDetails);
1139 }
fcf908c6 1140 $result = mysqli_query($conn, 'DROP TEMPORARY TABLE civicrm_install_temp_table_test');
6a488035
TO
1141 }
1142
627456b5
EM
1143 /**
1144 * @param $server
100fef9d 1145 * @param string $username
627456b5
EM
1146 * @param $password
1147 * @param $database
1148 * @param $testDetails
1149 */
971d41b1 1150 public function requireMySQLTrigger($server, $username, $password, $database, $testDetails) {
6a488035 1151 $this->testing($testDetails);
6a511829 1152 $conn = $this->connect($server, $username, $password);
6a488035 1153 if (!$conn) {
2f8082cd 1154 $testDetails[2] = ts('Could not login to the database.');
6a488035
TO
1155 $this->error($testDetails);
1156 return;
1157 }
1158
fcf908c6 1159 if (!@mysqli_select_db($conn, $database)) {
2f8082cd 1160 $testDetails[2] = ts('Could not select the database.');
6a488035
TO
1161 $this->error($testDetails);
1162 return;
1163 }
1164
fcf908c6 1165 $result = mysqli_query($conn, 'CREATE TABLE civicrm_install_temp_table_test (test text)');
6a488035 1166 if (!$result) {
2f8082cd 1167 $testDetails[2] = ts('Could not create a table in the database.');
6a488035
TO
1168 $this->error($testDetails);
1169 }
1170
fcf908c6 1171 $result = mysqli_query($conn, 'CREATE TRIGGER civicrm_install_temp_table_test_trigger BEFORE INSERT ON civicrm_install_temp_table_test FOR EACH ROW BEGIN END');
6a488035 1172 if (!$result) {
fcf908c6 1173 mysqli_query($conn, 'DROP TABLE civicrm_install_temp_table_test');
2f8082cd 1174 $testDetails[2] = ts('Could not create a database trigger.');
6a488035
TO
1175 $this->error($testDetails);
1176 }
1177
fcf908c6 1178 mysqli_query($conn, 'DROP TRIGGER civicrm_install_temp_table_test_trigger');
1179 mysqli_query($conn, 'DROP TABLE civicrm_install_temp_table_test');
6a488035
TO
1180 }
1181
627456b5
EM
1182 /**
1183 * @param $server
100fef9d 1184 * @param string $username
627456b5
EM
1185 * @param $password
1186 * @param $database
1187 * @param $testDetails
1188 */
971d41b1 1189 public function requireMySQLLockTables($server, $username, $password, $database, $testDetails) {
6a488035 1190 $this->testing($testDetails);
6a511829 1191 $conn = $this->connect($server, $username, $password);
6a488035 1192 if (!$conn) {
2f8082cd 1193 $testDetails[2] = ts('Could not connect to the database server.');
6a488035
TO
1194 $this->error($testDetails);
1195 return;
1196 }
1197
fcf908c6 1198 if (!@mysqli_select_db($conn, $database)) {
2f8082cd 1199 $testDetails[2] = ts('Could not select the database.');
6a488035
TO
1200 $this->error($testDetails);
1201 return;
1202 }
1203
fcf908c6 1204 $result = mysqli_query($conn, 'CREATE TEMPORARY TABLE civicrm_install_temp_table_test (test text)');
6a488035 1205 if (!$result) {
2f8082cd 1206 $testDetails[2] = ts('Could not create a table in the database.');
6a488035
TO
1207 $this->error($testDetails);
1208 return;
1209 }
1210
fcf908c6 1211 $result = mysqli_query($conn, 'LOCK TABLES civicrm_install_temp_table_test WRITE');
6a488035 1212 if (!$result) {
2f8082cd 1213 $testDetails[2] = ts('Could not obtain a write lock for the database table.');
6a488035 1214 $this->error($testDetails);
fcf908c6 1215 $result = mysqli_query($conn, 'DROP TEMPORARY TABLE civicrm_install_temp_table_test');
6a488035
TO
1216 return;
1217 }
1218
fcf908c6 1219 $result = mysqli_query($conn, 'UNLOCK TABLES');
6a488035 1220 if (!$result) {
2f8082cd 1221 $testDetails[2] = ts('Could not release the lock for the database table.');
6a488035 1222 $this->error($testDetails);
fcf908c6 1223 $result = mysqli_query($conn, 'DROP TEMPORARY TABLE civicrm_install_temp_table_test');
6a488035
TO
1224 return;
1225 }
1226
fcf908c6 1227 $result = mysqli_query($conn, 'DROP TEMPORARY TABLE civicrm_install_temp_table_test');
6a488035
TO
1228 }
1229
627456b5
EM
1230 /**
1231 * @param $server
100fef9d 1232 * @param string $username
627456b5
EM
1233 * @param $password
1234 * @param $testDetails
1235 */
971d41b1 1236 public function requireMySQLAutoIncrementIncrementOne($server, $username, $password, $testDetails) {
6a488035 1237 $this->testing($testDetails);
6a511829 1238 $conn = $this->connect($server, $username, $password);
6a488035 1239 if (!$conn) {
2f8082cd 1240 $testDetails[2] = ts('Could not connect to the database server.');
6a488035
TO
1241 $this->error($testDetails);
1242 return;
1243 }
1244
fcf908c6 1245 $result = mysqli_query($conn, "SHOW variables like 'auto_increment_increment'");
6a488035 1246 if (!$result) {
2f8082cd 1247 $testDetails[2] = ts('Could not query database server variables.');
6a488035
TO
1248 $this->error($testDetails);
1249 return;
1250 }
1251 else {
fcf908c6 1252 $values = mysqli_fetch_row($result);
6a488035 1253 if ($values[1] == 1) {
2f8082cd 1254 $testDetails[3] = ts('MySQL server auto_increment_increment is 1');
6a488035
TO
1255 }
1256 else {
1257 $this->error($testDetails);
1258 }
1259 }
1260 }
1261
627456b5
EM
1262 /**
1263 * @param $server
100fef9d 1264 * @param string $username
627456b5
EM
1265 * @param $password
1266 * @param $database
1267 * @param $minValueKB
1268 * @param $testDetails
1269 */
971d41b1 1270 public function requireMySQLThreadStack($server, $username, $password, $database, $minValueKB, $testDetails) {
6a488035 1271 $this->testing($testDetails);
6a511829 1272 $conn = $this->connect($server, $username, $password);
6a488035 1273 if (!$conn) {
2f8082cd 1274 $testDetails[2] = ts('Could not connect to the database server.');
6a488035
TO
1275 $this->error($testDetails);
1276 return;
1277 }
1278
fcf908c6 1279 if (!@mysqli_select_db($conn, $database)) {
2f8082cd 1280 $testDetails[2] = ts('Could not select the database.');
6a488035
TO
1281 $this->error($testDetails);
1282 return;
1283 }
1284
683bf891
SL
1285 // bytes => kb
1286 $result = mysqli_query($conn, "SHOW VARIABLES LIKE 'thread_stack'");
6a488035 1287 if (!$result) {
2f8082cd 1288 $testDetails[2] = ts('Could not get information about the thread_stack of the database.');
6a488035 1289 $this->error($testDetails);
0db6c3e1
TO
1290 }
1291 else {
fcf908c6 1292 $values = mysqli_fetch_row($result);
1f5f3294 1293 if ($values[1] < (1024 * $minValueKB)) {
2f8082cd 1294 $testDetails[2] = ts('MySQL "thread_stack" is %1 kb', array(1 => ($values[1] / 1024)));
6a488035
TO
1295 $this->error($testDetails);
1296 }
1297 }
1298 }
1299
1b4a049e
AP
1300 /**
1301 * @param $server
1302 * @param $username
1303 * @param $password
1304 * @param $database
1305 * @param $testDetails
1306 */
1307 public function requireNoExistingData(
1308 $server,
1309 $username,
1310 $password,
1311 $database,
1312 $testDetails
1313 ) {
1314 $this->testing($testDetails);
1315 $conn = $this->connect($server, $username, $password);
1316
1317 @mysqli_select_db($conn, $database);
1318 $contactRecords = mysqli_query($conn, "SELECT count(*) as contactscount FROM civicrm_contact");
1319 if ($contactRecords) {
1320 $contactRecords = mysqli_fetch_object($contactRecords);
1321 if ($contactRecords->contactscount > 0) {
1322 $this->error($testDetails);
1323 return;
1324 }
1325 }
1326
c66b58c9 1327 $testDetails[3] = ts('CiviCRM data from previous installation does not exist in %1.', array(1 => $database));
1b4a049e
AP
1328 $this->testing($testDetails);
1329 }
1330
627456b5
EM
1331 /**
1332 * @param $server
100fef9d 1333 * @param string $username
627456b5
EM
1334 * @param $password
1335 * @param $database
1336 * @param $testDetails
1337 * @param bool $onlyRequire
1338 */
971d41b1 1339 public function requireDatabaseOrCreatePermissions(
56fdfc52 1340 $server,
6a488035
TO
1341 $username,
1342 $password,
1343 $database,
1344 $testDetails,
1345 $onlyRequire = FALSE
1346 ) {
1347 $this->testing($testDetails);
6a511829 1348 $conn = $this->connect($server, $username, $password);
6a488035
TO
1349
1350 $okay = NULL;
fcf908c6 1351 if (@mysqli_select_db($conn, $database)) {
6a488035
TO
1352 $okay = "Database '$database' exists";
1353 }
1354 elseif ($onlyRequire) {
2f8082cd 1355 $testDetails[2] = ts("The database: '%1' does not exist.", array(1 => $database));
6a488035
TO
1356 $this->error($testDetails);
1357 return;
1358 }
1359 else {
fcf908c6 1360 $query = sprintf("CREATE DATABASE %s", mysqli_real_escape_string($conn, $database));
1361 if (@mysqli_query($conn, $query)) {
2f8082cd 1362 $okay = ts("Able to create a new database.");
6a488035
TO
1363 }
1364 else {
2f8082cd 1365 $testDetails[2] .= " (" . ts("user '%1' doesn't have CREATE DATABASE permissions.", array(1 => $username)) . ")";
6a488035
TO
1366 $this->error($testDetails);
1367 return;
1368 }
1369 }
1370
1371 if ($okay) {
1372 $testDetails[3] = $okay;
1373 $this->testing($testDetails);
1374 }
1375 }
1376
627456b5
EM
1377 /**
1378 * @param $varNames
1379 * @param $errorMessage
1380 */
971d41b1 1381 public function requireServerVariables($varNames, $errorMessage) {
6a488035
TO
1382 //$this->testing($testDetails);
1383 foreach ($varNames as $varName) {
1384 if (!$_SERVER[$varName]) {
1385 $missing[] = '$_SERVER[' . $varName . ']';
1386 }
1387 }
1388 if (!isset($missing)) {
1389 return TRUE;
1390 }
1391 else {
2f8082cd 1392 $testDetails[2] = " (" . ts('the following PHP variables are missing: %1', array(1 => implode(", ", $missing))) . ")";
6a488035
TO
1393 $this->error($testDetails);
1394 }
1395 }
1396
75615982 1397 /**
1398 * @param $server
1399 * @param string $username
1400 * @param $password
1401 * @param $database
1402 * @param $testDetails
1403 */
1404 public function requireMysqlUtf8mb4($server, $username, $password, $database, $testDetails) {
1405 $this->testing($testDetails);
1406 $conn = $this->connect($server, $username, $password);
1407 if (!$conn) {
1408 $testDetails[2] = ts('Could not connect to the database server.');
1409 $this->error($testDetails);
1410 return;
1411 }
1412
1413 if (!@mysqli_select_db($conn, $database)) {
1414 $testDetails[2] = ts('Could not select the database.');
1415 $this->error($testDetails);
1416 return;
1417 }
1418
1419 $result = mysqli_query($conn, 'CREATE TABLE civicrm_utf8mb4_test (id VARCHAR(255), PRIMARY KEY(id(255))) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci ROW_FORMAT=DYNAMIC ENGINE=INNODB');
1420 if (!$result) {
1421 $testDetails[2] = ts('It is recommended, though not yet required, to configure your MySQL server for utf8mb4 support. You will need the following MySQL server configuration: innodb_large_prefix=true innodb_file_format=barracuda innodb_file_per_table=true');
1422 $this->warning($testDetails);
1423 return;
1424 }
1425 $result = mysqli_query($conn, 'DROP TABLE civicrm_utf8mb4_test');
1426
1427 // Ensure that the MySQL driver supports utf8mb4 encoding.
e479ac61 1428 $version = mysqli_get_client_info();
75615982 1429 if (strpos($version, 'mysqlnd') !== FALSE) {
1430 // The mysqlnd driver supports utf8mb4 starting at version 5.0.9.
1431 $version = preg_replace('/^\D+([\d.]+).*/', '$1', $version);
1432 if (version_compare($version, '5.0.9', '<')) {
1433 $testDetails[2] = 'It is recommended, though not yet required, to upgrade your PHP MySQL driver (mysqlnd) to >= 5.0.9 for utf8mb4 support.';
1434 $this->warning($testDetails);
1435 return;
1436 }
1437 }
1438 else {
1439 // The libmysqlclient driver supports utf8mb4 starting at version 5.5.3.
1440 if (version_compare($version, '5.5.3', '<')) {
1441 $testDetails[2] = 'It is recommended, though not yet required, to upgrade your PHP MySQL driver (libmysqlclient) to >= 5.5.3 for utf8mb4 support.';
1442 $this->warning($testDetails);
1443 return;
1444 }
1445 }
1446 }
1447
627456b5
EM
1448 /**
1449 * @param $testDetails
1450 *
1451 * @return bool
1452 */
971d41b1 1453 public function isRunningApache($testDetails) {
6a488035
TO
1454 $this->testing($testDetails);
1455 if (function_exists('apache_get_modules') || stristr($_SERVER['SERVER_SIGNATURE'], 'Apache')) {
1456 return TRUE;
1457 }
1458
1459 $this->warning($testDetails);
1460 return FALSE;
1461 }
1462
627456b5
EM
1463 /**
1464 * @return string
1465 */
971d41b1 1466 public function getBaseDir() {
6a488035
TO
1467 return dirname($_SERVER['SCRIPT_FILENAME']) . CIVICRM_DIRECTORY_SEPARATOR;
1468 }
1469
627456b5
EM
1470 /**
1471 * @param $testDetails
1472 */
971d41b1 1473 public function testing($testDetails) {
6a488035
TO
1474 if (!$testDetails) {
1475 return;
1476 }
1477
1478 $section = $testDetails[0];
1479 $test = $testDetails[1];
1480
2f8082cd 1481 $message = ts("OK");
6a488035
TO
1482 if (isset($testDetails[3])) {
1483 $message .= " ($testDetails[3])";
1484 }
1485
1486 $this->tests[$section][$test] = array("good", $message);
1487 }
1488
627456b5
EM
1489 /**
1490 * @param $testDetails
1491 */
971d41b1 1492 public function error($testDetails) {
6a488035
TO
1493 $section = $testDetails[0];
1494 $test = $testDetails[1];
1495
1496 $this->tests[$section][$test] = array("error", $testDetails[2]);
1497 $this->errors[] = $testDetails;
1498 }
1499
627456b5
EM
1500 /**
1501 * @param $testDetails
1502 */
971d41b1 1503 public function warning($testDetails) {
6a488035
TO
1504 $section = $testDetails[0];
1505 $test = $testDetails[1];
1506
6a488035
TO
1507 $this->tests[$section][$test] = array("warning", $testDetails[2]);
1508 $this->warnings[] = $testDetails;
1509 }
1510
627456b5
EM
1511 /**
1512 * @return int
1513 */
971d41b1 1514 public function hasErrors() {
f0879544 1515 return !empty($this->errors);
6a488035
TO
1516 }
1517
627456b5
EM
1518 /**
1519 * @return int
1520 */
971d41b1 1521 public function hasWarnings() {
f0879544 1522 return !empty($this->warnings);
6a488035 1523 }
96025800 1524
6a488035
TO
1525}
1526
627456b5
EM
1527/**
1528 * Class Installer
1529 */
6a488035 1530class Installer extends InstallRequirements {
683bf891 1531
627456b5
EM
1532 /**
1533 * @param $server
1534 * @param $username
1535 * @param $password
1536 * @param $database
1537 */
971d41b1 1538 public function createDatabaseIfNotExists($server, $username, $password, $database) {
6a511829 1539 $conn = $this->connect($server, $username, $password);
6a488035 1540
fcf908c6 1541 if (@mysqli_select_db($conn, $database)) {
6a488035
TO
1542 // skip if database already present
1543 return;
1544 }
fcf908c6 1545 $query = sprintf("CREATE DATABASE %s", mysqli_real_escape_string($conn, $database));
1546 if (@mysqli_query($conn, $query)) {
56fdfc52 1547 }
6a488035 1548 else {
6a9514e1
ML
1549 $errorTitle = ts("Oops! Could not create database %1", array(1 => $database));
1550 $errorMsg = ts("We encountered an error when attempting to create the database. Please check your MySQL server permissions and the database name and try again.");
6a488035
TO
1551 errorDisplayPage($errorTitle, $errorMsg);
1552 }
1553 }
1554
627456b5
EM
1555 /**
1556 * @param $config
1557 *
1558 * @return mixed
1559 */
971d41b1 1560 public function install($config) {
6a488035
TO
1561 global $installDirPath;
1562
1563 // create database if does not exists
1564 $this->createDatabaseIfNotExists($config['mysql']['server'],
1565 $config['mysql']['username'],
1566 $config['mysql']['password'],
1567 $config['mysql']['database']
1568 );
1569
1570 global $installDirPath;
1571
1572 // Build database
1573 require_once $installDirPath . 'civicrm.php';
1574 civicrm_main($config);
1575
1576 if (!$this->errors) {
1577 global $installType, $installURLPath;
1578
bb216f68 1579 $registerSiteURL = "https://civicrm.org/register-site";
56de7273
ML
1580 $commonOutputMessage
1581 = "<li>" . ts("Have you registered this site at CiviCRM.org? If not, please help strengthen the CiviCRM ecosystem by taking a few minutes to <a %1>fill out the site registration form</a>. The information collected will help us prioritize improvements, target our communications and build the community. If you have a technical role for this site, be sure to check Keep in Touch to receive technical updates (a low volume mailing list).", array(1 => "href='$registerSiteURL' target='_blank'")) . "</li>"
1582 . "<li>" . ts("We have integrated KCFinder with CKEditor and TinyMCE. This allows a user to upload images. All uploaded images are public.") . "</li>";
41547a19 1583
6a488035 1584 $output = NULL;
97b8e6b2 1585
6a488035
TO
1586 if (
1587 $installType == 'drupal' &&
1588 version_compare(VERSION, '7.0-rc1') >= 0
1589 ) {
1590
1591 // clean output
1592 @ob_clean();
1593
1594 $output .= '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">';
1595 $output .= '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1596 $output .= '<head>';
2f8082cd 1597 $output .= '<title>' . ts('CiviCRM Installed') . '</title>';
6a9514e1 1598 $output .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6a488035
TO
1599 $output .= '<link rel="stylesheet" type="text/css" href="template.css" />';
1600 $output .= '</head>';
1601 $output .= '<body>';
2f8082cd 1602 $output .= '<div style="padding: 1em;"><p class="good">' . ts('CiviCRM has been successfully installed') . '</p>';
6a488035 1603 $output .= '<ul>';
6a9514e1 1604
6a488035
TO
1605 $drupalURL = civicrm_cms_base();
1606 $drupalPermissionsURL = "{$drupalURL}index.php?q=admin/people/permissions";
1607 $drupalURL .= "index.php?q=civicrm/admin/configtask&reset=1";
6a488035 1608
6a9514e1
ML
1609 $output .= "<li>" . ts("Drupal user permissions have been automatically set - giving anonymous and authenticated users access to public CiviCRM forms and features. We recommend that you <a %1>review these permissions</a> to ensure that they are appropriate for your requirements (<a %2>learn more...</a>)", array(1 => "target='_blank' href='{$drupalPermissionsURL}'", 2 => "target='_blank' href='http://wiki.civicrm.org/confluence/display/CRMDOC/Default+Permissions+and+Roles'")) . "</li>";
1610 $output .= "<li>" . ts("Use the <a %1>Configuration Checklist</a> to review and configure settings for your new site", array(1 => "target='_blank' href='$drupalURL'")) . "</li>";
1611 $output .= $commonOutputMessage;
6a488035
TO
1612
1613 // automatically enable CiviCRM module once it is installed successfully.
1614 // so we need to Bootstrap Drupal, so that we can call drupal hooks.
1615 global $cmsPath, $crmPath;
1616
1617 // relative / abosolute paths are not working for drupal, hence using chdir()
1618 chdir($cmsPath);
1619
97b8e6b2 1620 // Force the re-initialisation of the config singleton on the next call
1621 // since so far, we had used the Config object without loading the DB.
1622 $c = CRM_Core_Config::singleton(FALSE);
1623 $c->free();
1624
6a488035
TO
1625 include_once "./includes/bootstrap.inc";
1626 include_once "./includes/unicode.inc";
1627
1628 drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
1629
1630 // prevent session information from being saved.
1631 drupal_save_session(FALSE);
1632
1633 // Force the current user to anonymous.
1634 $original_user = $GLOBALS['user'];
1635 $GLOBALS['user'] = drupal_anonymous_user();
1636
1637 // explicitly setting error reporting, since we cannot handle drupal related notices
1638 error_reporting(1);
1639
1640 // rebuild modules, so that civicrm is added
1641 system_rebuild_module_data();
1642
1643 // now enable civicrm module.
1644 module_enable(array('civicrm', 'civicrmtheme'));
1645
ece6501c
ML
1646 // SystemInstallEvent will be called from here with the first call of CRM_Core_Config,
1647 // which calls Core_BAO_ConfigSetting::applyLocale(), who will default to calling
1648 // Civi::settings()->get('lcMessages');
1649 // Therefore, we need to pass the seedLanguage before that.
1650 global $civicrm_setting;
1651 $civicrm_setting['domain']['lcMessages'] = $config['seedLanguage'];
1652
d8a4acc0
C
1653 // clear block, page, theme, and hook caches
1654 drupal_flush_all_caches();
6a488035
TO
1655
1656 //add basic drupal permissions
1657 civicrm_install_set_drupal_perms();
1658
1659 // restore the user.
1660 $GLOBALS['user'] = $original_user;
1661 drupal_save_session(TRUE);
1662
1663 $output .= '</ul>';
1664 $output .= '</div>';
1665 $output .= '</body>';
1666 $output .= '</html>';
1667 echo $output;
1668 }
5757adf3
HD
1669 elseif (
1670 $installType == 'backdrop'
1671 ) {
1672
1673 // clean output
1674 @ob_clean();
1675
1676 $output .= '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">';
1677 $output .= '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1678 $output .= '<head>';
1679 $output .= '<title>' . ts('CiviCRM Installed') . '</title>';
1680 $output .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
1681 $output .= '<link rel="stylesheet" type="text/css" href="template.css" />';
1682 $output .= '</head>';
1683 $output .= '<body>';
1684 $output .= '<div style="padding: 1em;"><p class="good">' . ts('CiviCRM has been successfully installed') . '</p>';
1685 $output .= '<ul>';
1686
1687 $backdropURL = civicrm_cms_base();
1688 $backdropPermissionsURL = "{$backdropURL}index.php?q=admin/config/people/permissions";
1689 $backdropURL .= "index.php?q=civicrm/admin/configtask&reset=1";
1690
1691 $output .= "<li>" . ts("Backdrop user permissions have been automatically set - giving anonymous and authenticated users access to public CiviCRM forms and features. We recommend that you <a %1>review these permissions</a> to ensure that they are appropriate for your requirements (<a %2>learn more...</a>)", array(1 => "target='_blank' href='{$backdropPermissionsURL}'", 2 => "target='_blank' href='http://wiki.civicrm.org/confluence/display/CRMDOC/Default+Permissions+and+Roles'")) . "</li>";
1692 $output .= "<li>" . ts("Use the <a %1>Configuration Checklist</a> to review and configure settings for your new site", array(1 => "target='_blank' href='$backdropURL'")) . "</li>";
1693 $output .= $commonOutputMessage;
1694
1695 // automatically enable CiviCRM module once it is installed successfully.
1696 // so we need to Bootstrap Drupal, so that we can call drupal hooks.
1697 global $cmsPath, $crmPath;
1698
1699 // relative / abosolute paths are not working for drupal, hence using chdir()
1700 chdir($cmsPath);
1701
1702 // Force the re-initialisation of the config singleton on the next call
1703 // since so far, we had used the Config object without loading the DB.
1704 $c = CRM_Core_Config::singleton(FALSE);
1705 $c->free();
1706
1707 include_once "./core/includes/bootstrap.inc";
1708 include_once "./core/includes/unicode.inc";
228391b3 1709 include_once "./core/includes/config.inc";
5757adf3
HD
1710
1711 backdrop_bootstrap(BACKDROP_BOOTSTRAP_FULL);
1712
1713 // prevent session information from being saved.
1714 backdrop_save_session(FALSE);
1715
1716 // Force the current user to anonymous.
1717 $original_user = $GLOBALS['user'];
1718 $GLOBALS['user'] = backdrop_anonymous_user();
1719
1720 // explicitly setting error reporting, since we cannot handle drupal related notices
1721 error_reporting(1);
1722
1723 // rebuild modules, so that civicrm is added
1724 system_rebuild_module_data();
1725
1726 // now enable civicrm module.
1727 module_enable(array('civicrm', 'civicrmtheme'));
1728
1729 // clear block, page, theme, and hook caches
1730 backdrop_flush_all_caches();
1731
1732 //add basic backdrop permissions
1733 civicrm_install_set_backdrop_perms();
1734
1735 // restore the user.
1736 $GLOBALS['user'] = $original_user;
1737 backdrop_save_session(TRUE);
1738
1739 //change the default language to one chosen
1740 if (isset($config['seedLanguage']) && $config['seedLanguage'] != 'en_US') {
1741 civicrm_api3('Setting', 'create', array(
683bf891
SL
1742 'domain_id' => 'current_domain',
1743 'lcMessages' => $config['seedLanguage'],
1744 ));
5757adf3
HD
1745 }
1746
1747 $output .= '</ul>';
1748 $output .= '</div>';
1749 $output .= '</body>';
1750 $output .= '</html>';
1751 echo $output;
1752 }
6a488035
TO
1753 elseif ($installType == 'drupal' && version_compare(VERSION, '6.0') >= 0) {
1754 // clean output
1755 @ob_clean();
1756
1757 $output .= '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">';
1758 $output .= '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1759 $output .= '<head>';
6a9514e1
ML
1760 $output .= '<title>' . ts('CiviCRM Installed') . '</title>';
1761 $output .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6a488035
TO
1762 $output .= '<link rel="stylesheet" type="text/css" href="template.css" />';
1763 $output .= '</head>';
1764 $output .= '<body>';
97b8e6b2 1765 $output .= '<div style="padding: 1em;"><p class="good">' . ts("CiviCRM has been successfully installed") . '</p>';
6a488035 1766 $output .= '<ul>';
6a9514e1 1767
6a488035
TO
1768 $drupalURL = civicrm_cms_base();
1769 $drupalPermissionsURL = "{$drupalURL}index.php?q=admin/user/permissions";
1770 $drupalURL .= "index.php?q=civicrm/admin/configtask&reset=1";
6a488035 1771
6a9514e1
ML
1772 $output .= "<li>" . ts("Drupal user permissions have been automatically set - giving anonymous and authenticated users access to public CiviCRM forms and features. We recommend that you <a %1>review these permissions</a> to ensure that they are appropriate for your requirements (<a %2>learn more...</a>)", array(1 => "target='_blank' href='{$drupalPermissionsURL}'", 2 => "target='_blank' href='http://wiki.civicrm.org/confluence/display/CRMDOC/Default+Permissions+and+Roles'")) . "</li>";
1773 $output .= "<li>" . ts("Use the <a %1>Configuration Checklist</a> to review and configure settings for your new site", array(1 => "target='_blank' href='$drupalURL'")) . "</li>";
1774 $output .= $commonOutputMessage;
6a488035
TO
1775
1776 // explicitly setting error reporting, since we cannot handle drupal related notices
1777 error_reporting(1);
1778
1779 // automatically enable CiviCRM module once it is installed successfully.
1780 // so we need to Bootstrap Drupal, so that we can call drupal hooks.
1781 global $cmsPath, $crmPath;
1782
1783 // relative / abosolute paths are not working for drupal, hence using chdir()
1784 chdir($cmsPath);
1785
2f8082cd
ML
1786 // Force the re-initialisation of the config singleton on the next call
1787 // since so far, we had used the Config object without loading the DB.
1788 $c = CRM_Core_Config::singleton(FALSE);
1789 $c->free();
1790
6a488035
TO
1791 include_once "./includes/bootstrap.inc";
1792 drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL);
1793
1794 // rebuild modules, so that civicrm is added
1795 module_rebuild_cache();
1796
1797 // now enable civicrm module.
1798 module_enable(array('civicrm'));
1799
d8a4acc0
C
1800 // clear block, page, theme, and hook caches
1801 drupal_flush_all_caches();
6a488035
TO
1802
1803 //add basic drupal permissions
1804 db_query('UPDATE {permission} SET perm = CONCAT( perm, \', access CiviMail subscribe/unsubscribe pages, access all custom data, access uploaded files, make online contributions, profile create, profile edit, profile view, register for events, view event info\') WHERE rid IN (1, 2)');
1805
1806 echo $output;
1807 }
1808 elseif ($installType == 'wordpress') {
6a9514e1 1809 echo '<h1>' . ts('CiviCRM Installed') . '</h1>';
97b8e6b2 1810 echo '<div style="padding: 1em;"><p style="background-color: #0C0; border: 1px #070 solid; color: white;">' . ts("CiviCRM has been successfully installed") . '</p>';
6a488035 1811 echo '<ul>';
6a488035
TO
1812
1813 $cmsURL = civicrm_cms_base();
1814 $cmsURL .= "wp-admin/admin.php?page=CiviCRM&q=civicrm/admin/configtask&reset=1";
41547a19
DL
1815 $wpPermissionsURL = "wp-admin/admin.php?page=CiviCRM&q=civicrm/admin/access/wp-permissions&reset=1";
1816
6a9514e1
ML
1817 $output .= "<li>" . ts("WordPress user permissions have been automatically set - giving Anonymous and Subscribers access to public CiviCRM forms and features. We recommend that you <a %1>review these permissions</a> to ensure that they are appropriate for your requirements (<a %2>learn more...</a>)", array(1 => "target='_blank' href='{$wpPermissionsURL}'", 2 => "target='_blank' href='http://wiki.civicrm.org/confluence/display/CRMDOC/Default+Permissions+and+Roles'")) . "</li>";
1818 $output .= "<li>" . ts("Use the <a %1>Configuration Checklist</a> to review and configure settings for your new site", array(1 => "target='_blank' href='$cmsURL'")) . "</li>";
1819 $output .= $commonOutputMessage;
41547a19 1820
138a7961
KC
1821 $output .= '</ul>';
1822 $output .= '</div>';
1823 echo $output;
b232c132 1824
1825 $c = CRM_Core_Config::singleton(FALSE);
1826 $c->free();
138a7961 1827 $wpInstallRedirect = admin_url('admin.php?page=CiviCRM&q=civicrm&reset=1');
7ba2c8ad
KC
1828 echo "<script>
1829 window.location = '$wpInstallRedirect';
1830 </script>";
1f5f3294
TO
1831 }
1832 }
6a488035
TO
1833
1834 return $this->errors;
1835 }
96025800 1836
6a488035
TO
1837}
1838
1839function civicrm_install_set_drupal_perms() {
1840 if (!function_exists('db_select')) {
1841 db_query('UPDATE {permission} SET perm = CONCAT( perm, \', access CiviMail subscribe/unsubscribe pages, access all custom data, access uploaded files, make online contributions, profile listings and forms, register for events, view event info, view event participants\') WHERE rid IN (1, 2)');
1842 }
1843 else {
1844 $perms = array(
1845 'access all custom data',
1846 'access uploaded files',
1847 'make online contributions',
1848 'profile create',
1849 'profile edit',
1850 'profile view',
1851 'register for events',
1852 'view event info',
1853 'view event participants',
1854 'access CiviMail subscribe/unsubscribe pages',
1855 );
1856
1857 // Adding a permission that has not yet been assigned to a module by
1858 // a hook_permission implementation results in a database error.
1859 // CRM-9042
1860 $allPerms = array_keys(module_invoke_all('permission'));
1861 foreach (array_diff($perms, $allPerms) as $perm) {
1862 watchdog('civicrm',
1863 'Cannot grant the %perm permission because it does not yet exist.',
971d41b1
CW
1864 array('%perm' => $perm),
1865 WATCHDOG_ERROR
6a488035
TO
1866 );
1867 }
1868 $perms = array_intersect($perms, $allPerms);
1869 user_role_grant_permissions(DRUPAL_AUTHENTICATED_RID, $perms);
1870 user_role_grant_permissions(DRUPAL_ANONYMOUS_RID, $perms);
1871 }
1872}
1873
5757adf3
HD
1874function civicrm_install_set_backdrop_perms() {
1875 $perms = array(
1876 'access all custom data',
1877 'access uploaded files',
1878 'make online contributions',
1879 'profile create',
1880 'profile edit',
1881 'profile view',
1882 'register for events',
1883 'view event info',
1884 'view event participants',
1885 'access CiviMail subscribe/unsubscribe pages',
1886 );
1887
1888 // Adding a permission that has not yet been assigned to a module by
1889 // a hook_permission implementation results in a database error.
1890 // CRM-9042
1891 $allPerms = array_keys(module_invoke_all('permission'));
1892 foreach (array_diff($perms, $allPerms) as $perm) {
1893 watchdog('civicrm',
1894 'Cannot grant the %perm permission because it does not yet exist.',
1895 array('%perm' => $perm),
1896 WATCHDOG_ERROR
1897 );
1898 }
1899 $perms = array_intersect($perms, $allPerms);
1900 user_role_grant_permissions(BACKDROP_AUTHENTICATED_ROLE, $perms);
1901 user_role_grant_permissions(BACKDROP_ANONYMOUS_ROLE, $perms);
1902}
1903
627456b5
EM
1904/**
1905 * @param $cmsPath
1906 * @param $str
1907 *
1908 * @return string
1909 */
6a488035
TO
1910function getSiteDir($cmsPath, $str) {
1911 static $siteDir = '';
1912
1913 if ($siteDir) {
1914 return $siteDir;
1915 }
1916
1917 $sites = CIVICRM_DIRECTORY_SEPARATOR . 'sites' . CIVICRM_DIRECTORY_SEPARATOR;
1918 $modules = CIVICRM_DIRECTORY_SEPARATOR . 'modules' . CIVICRM_DIRECTORY_SEPARATOR;
1919 preg_match("/" . preg_quote($sites, CIVICRM_DIRECTORY_SEPARATOR) .
1920 "([\-a-zA-Z0-9_.]+)" .
1921 preg_quote($modules, CIVICRM_DIRECTORY_SEPARATOR) . "/",
1922 $_SERVER['SCRIPT_FILENAME'], $matches
1923 );
2e1f50d6 1924 $siteDir = $matches[1] ?? 'default';
6a488035
TO
1925
1926 if (strtolower($siteDir) == 'all') {
1927 // For this case - use drupal's way of finding out multi-site directory
1928 $uri = explode(CIVICRM_DIRECTORY_SEPARATOR, $_SERVER['SCRIPT_FILENAME']);
1929 $server = explode('.', implode('.', array_reverse(explode(':', rtrim($_SERVER['HTTP_HOST'], '.')))));
1930 for ($i = count($uri) - 1; $i > 0; $i--) {
1931 for ($j = count($server); $j > 0; $j--) {
1932 $dir = implode('.', array_slice($server, -$j)) . implode('.', array_slice($uri, 0, $i));
1933 if (file_exists($cmsPath . CIVICRM_DIRECTORY_SEPARATOR .
56fdfc52
TO
1934 'sites' . CIVICRM_DIRECTORY_SEPARATOR . $dir
1935 )) {
6a488035
TO
1936 $siteDir = $dir;
1937 return $siteDir;
1938 }
1939 }
1940 }
1941 $siteDir = 'default';
1942 }
1943
1944 return $siteDir;
1945}
1946
627456b5
EM
1947/**
1948 * @param $errorTitle
1949 * @param $errorMsg
6a9514e1 1950 * @param $showRefer
627456b5 1951 */
6a9514e1 1952function errorDisplayPage($errorTitle, $errorMsg, $showRefer = TRUE) {
e0b29e26
WM
1953
1954 // Add a link to the documentation
6a9514e1 1955 if ($showRefer) {
e0b29e26
WM
1956 if (is_callable(array('CRM_Utils_System', 'docURL2'))) {
1957 $docLink = CRM_Utils_System::docURL2('Installation and Upgrades', FALSE, 'Installation Guide', NULL, NULL, "wiki");
1958 }
2c99dd75
WM
1959 else {
1960 $docLink = '';
1961 }
e0b29e26
WM
1962
1963 if (function_exists('ts')) {
1964 $errorMsg .= '<p>' . ts("Refer to the online documentation for more information: ") . $docLink . '</p>';
1965 }
1966 else {
1967 $errorMsg .= '<p>' . 'Refer to the online documentation for more information: ' . $docLink . '</p>';
1968 }
6a9514e1
ML
1969 }
1970
1f5f3294 1971 include 'error.html';
6a488035
TO
1972 exit();
1973}