4 * Note that this installer has been based of the SilverStripe installer.
5 * You can get more information from the SilverStripe Website at
6 * http://www.silverstripe.com/.
8 * Copyright (c) 2006-7, SilverStripe Limited - www.silverstripe.com
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
16 * Redistributions of source code must retain the above copyright notice,
17 * this list of conditions and the following disclaimer.
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.
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.
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.
39 * Changes and modifications (c) 2007-2017 by CiviCRM LLC
46 ini_set('max_execution_time', 3000);
48 if (stristr(PHP_OS
, 'WIN')) {
49 define('CIVICRM_DIRECTORY_SEPARATOR', '/');
50 define('CIVICRM_WINDOWS', 1);
53 define('CIVICRM_DIRECTORY_SEPARATOR', DIRECTORY_SEPARATOR
);
54 define('CIVICRM_WINDOWS', 0);
60 global $installDirPath;
61 global $installURLPath;
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
66 if (isset($_POST['civicrm_install_type'])) {
67 $installType = $_POST['civicrm_install_type'];
69 elseif (isset($_GET['civicrm_install_type'])) {
70 $installType = strtolower($_GET['civicrm_install_type']);
73 // default value if not set
74 $installType = "drupal";
77 if ($installType == 'drupal' ||
$installType == 'backdrop') {
78 $crmPath = dirname(dirname($_SERVER['SCRIPT_FILENAME']));
79 $installDirPath = $installURLPath = '';
81 elseif ($installType == 'wordpress') {
82 $crmPath = WP_PLUGIN_DIR
. DIRECTORY_SEPARATOR
. 'civicrm' . DIRECTORY_SEPARATOR
. 'civicrm' . DIRECTORY_SEPARATOR
;
83 $installDirPath = WP_PLUGIN_DIR
. DIRECTORY_SEPARATOR
. 'civicrm' . DIRECTORY_SEPARATOR
. 'civicrm' . DIRECTORY_SEPARATOR
. 'install' . DIRECTORY_SEPARATOR
;
84 $installURLPath = WP_PLUGIN_URL
. DIRECTORY_SEPARATOR
. 'civicrm' . DIRECTORY_SEPARATOR
. 'civicrm' . DIRECTORY_SEPARATOR
. 'install' . DIRECTORY_SEPARATOR
;
87 $errorTitle = "Oops! Unsupported installation mode";
88 $errorMsg = sprintf('%s: unknown installation mode. Please refer to the online documentation for more information.', $installType);
89 errorDisplayPage($errorTitle, $errorMsg, FALSE);
92 $pkgPath = $crmPath . DIRECTORY_SEPARATOR
. 'packages';
94 require_once $crmPath . '/CRM/Core/ClassLoader.php';
95 CRM_Core_ClassLoader
::singleton()->register();
98 if (isset($_POST['loadGenerated'])) {
102 require_once dirname(__FILE__
) . CIVICRM_DIRECTORY_SEPARATOR
. 'langs.php';
103 foreach ($langs as $locale => $_) {
104 if ($locale == 'en_US') {
107 if (!file_exists(implode(CIVICRM_DIRECTORY_SEPARATOR
, array($crmPath, 'sql', "civicrm_data.$locale.mysql")))) {
108 unset($langs[$locale]);
113 // This is mostly sympbolic, since nothing we do during the install
114 // really requires CIVICRM_UF to be defined.
115 $installTypeToUF = array(
116 'wordpress' => 'WordPress',
117 'drupal' => 'Drupal',
118 'backdrop' => 'Backdrop',
121 $uf = (isset($installTypeToUF[$installType]) ?
$installTypeToUF[$installType] : 'Drupal');
122 define('CIVICRM_UF', $uf);
124 // Set the Locale (required by CRM_Core_Config)
128 $seedLanguage = 'en_US';
130 // CRM-16801 This validates that seedLanguage is valid by looking in $langs.
131 // NB: the variable is initial a $_REQUEST for the initial page reload,
132 // then becomes a $_POST when the installation form is submitted.
133 if (isset($_REQUEST['seedLanguage']) and isset($langs[$_REQUEST['seedLanguage']])) {
134 $seedLanguage = $_REQUEST['seedLanguage'];
135 $tsLocale = $_REQUEST['seedLanguage'];
138 $config = CRM_Core_Config
::singleton(FALSE);
139 $GLOBALS['civicrm_default_error_scope'] = NULL;
141 // The translation files are in the parent directory (l10n)
142 $i18n = CRM_Core_I18n
::singleton();
144 // Support for Arabic, Hebrew, Farsi, etc.
145 // Used in the template.html
146 $short_lang_code = CRM_Core_I18n_PseudoConstant
::shortForLong($tsLocale);
147 $text_direction = (CRM_Core_I18n
::isLanguageRTL($tsLocale) ?
'rtl' : 'ltr');
150 if ($installType == 'drupal') {
151 //CRM-6840 -don't force to install in sites/all/modules/
152 $object = new CRM_Utils_System_Drupal();
153 $cmsPath = $object->cmsRootPath();
155 $siteDir = getSiteDir($cmsPath, $_SERVER['SCRIPT_FILENAME']);
156 $alreadyInstalled = file_exists($cmsPath . CIVICRM_DIRECTORY_SEPARATOR
.
157 'sites' . CIVICRM_DIRECTORY_SEPARATOR
.
158 $siteDir . CIVICRM_DIRECTORY_SEPARATOR
.
159 'civicrm.settings.php'
162 elseif ($installType == 'backdrop') {
163 $object = new CRM_Utils_System_Backdrop();
164 $cmsPath = $object->cmsRootPath();
165 $siteDir = getSiteDir($cmsPath, $_SERVER['SCRIPT_FILENAME']);
166 $alreadyInstalled = file_exists($cmsPath . CIVICRM_DIRECTORY_SEPARATOR
. 'civicrm.settings.php');
168 elseif ($installType == 'wordpress') {
169 $cmsPath = WP_PLUGIN_DIR
. DIRECTORY_SEPARATOR
. 'civicrm';
170 $upload_dir = wp_upload_dir();
171 $files_dirname = $upload_dir['basedir'] . DIRECTORY_SEPARATOR
. 'civicrm';
172 $wp_civi_settings = $upload_dir['basedir'] . DIRECTORY_SEPARATOR
. 'civicrm' . DIRECTORY_SEPARATOR
. 'civicrm.settings.php';
173 $wp_civi_settings_deprectated = CIVICRM_PLUGIN_DIR
. 'civicrm.settings.php';
174 if (file_exists($wp_civi_settings_deprectated)) {
175 $alreadyInstalled = $wp_civi_settings_deprectated;
177 elseif (file_exists($wp_civi_settings)) {
178 $alreadyInstalled = $wp_civi_settings;
182 if ($installType == 'drupal') {
183 // Lets check only /modules/.
184 $pattern = '/' . preg_quote(CIVICRM_DIRECTORY_SEPARATOR
. 'modules', CIVICRM_DIRECTORY_SEPARATOR
) . '/';
186 if (!preg_match($pattern, str_replace("\\", "/", $_SERVER['SCRIPT_FILENAME']))) {
187 $directory = implode(CIVICRM_DIRECTORY_SEPARATOR
, array('sites', 'all', 'modules'));
188 $errorTitle = ts("Oops! Please correct your install location");
189 $errorMsg = ts("Please untar (uncompress) your downloaded copy of CiviCRM in the <strong>%1</strong> directory below your Drupal root directory.", array(1 => $directory));
190 errorDisplayPage($errorTitle, $errorMsg);
194 if ($installType == 'backdrop') {
195 // Lets check only /modules/.
196 $pattern = '/' . preg_quote(CIVICRM_DIRECTORY_SEPARATOR
. 'modules', CIVICRM_DIRECTORY_SEPARATOR
) . '/';
198 if (!preg_match($pattern, str_replace("\\", "/", $_SERVER['SCRIPT_FILENAME']))) {
199 $directory = 'modules';
200 $errorTitle = ts("Oops! Please correct your install location");
201 $errorMsg = ts("Please untar (uncompress) your downloaded copy of CiviCRM in the <strong>%1</strong> directory below your Drupal root directory.", array(1 => $directory));
202 errorDisplayPage($errorTitle, $errorMsg);
206 // Exit with error if CiviCRM has already been installed.
207 if ($alreadyInstalled) {
208 $errorTitle = ts("Oops! CiviCRM is already installed");
209 $settings_directory = $cmsPath;
211 if ($installType == 'drupal') {
212 $settings_directory = implode(CIVICRM_DIRECTORY_SEPARATOR
, array(
213 ts('[your Drupal root directory]'),
218 if ($installType == 'backdrop') {
219 $settings_directory = implode(CIVICRM_DIRECTORY_SEPARATOR
, array(
220 ts('[your Backdrop root directory]'),
225 $docLink = CRM_Utils_System
::docURL2('Installation and Upgrades', FALSE, ts('Installation Guide'), NULL, NULL, "wiki");
226 $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));
227 errorDisplayPage($errorTitle, $errorMsg, FALSE);
230 $versionFile = $crmPath . CIVICRM_DIRECTORY_SEPARATOR
. 'civicrm-version.php';
231 if (file_exists($versionFile)) {
232 require_once $versionFile;
233 $civicrm_version = civicrmVersion();
236 $civicrm_version = 'unknown';
239 if ($installType == 'drupal') {
240 // Ensure that they have downloaded the correct version of CiviCRM
241 if ($civicrm_version['cms'] != 'Drupal' && $civicrm_version['cms'] != 'Drupal6') {
242 $errorTitle = ts("Oops! Incorrect CiviCRM version");
243 $errorMsg = ts("This installer can only be used for the Drupal version of CiviCRM.");
244 errorDisplayPage($errorTitle, $errorMsg);
247 define('DRUPAL_ROOT', $cmsPath);
248 $drupalVersionFiles = array(
250 implode(CIVICRM_DIRECTORY_SEPARATOR
, array($cmsPath, 'modules', 'system', 'system.module')),
252 implode(CIVICRM_DIRECTORY_SEPARATOR
, array($cmsPath, 'includes', 'bootstrap.inc')),
254 foreach ($drupalVersionFiles as $drupalVersionFile) {
255 if (file_exists($drupalVersionFile)) {
256 require_once $drupalVersionFile;
260 // Bootstrap Drupal to get settings and user
261 $base_root = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ?
'https' : 'http';
262 $base_root .= '://' . $_SERVER['HTTP_HOST'];
263 $base_url = $base_root;
264 drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL
);
266 // Check that user is logged in and has administrative permissions
267 // This is necessary because the script exposes the database settings in the form and these could be viewed by unauthorised users
268 if ((!function_exists('user_access')) ||
(!user_access('administer site configuration'))) {
269 $errorTitle = ts("You don't have permission to access this page");
270 $errorMsg = ts("The installer can only be run by a user with the permission to administer site configuration.");
271 errorDisplayPage($errorTitle, $errorMsg);
275 if (!defined('VERSION') or version_compare(VERSION
, '6.0') < 0) {
276 $errorTitle = ts("Oops! Incorrect Drupal version");
277 $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)));
278 errorDisplayPage($errorTitle, $errorMsg);
281 elseif ($installType == 'backdrop') {
282 // Ensure that they have downloaded the correct version of CiviCRM
283 if ($civicrm_version['cms'] != 'Backdrop') {
284 $errorTitle = ts("Oops! Incorrect CiviCRM version");
285 $errorMsg = ts("This installer can only be used for the Backdrop version of CiviCRM.");
286 errorDisplayPage($errorTitle, $errorMsg);
289 define('BACKDROP_ROOT', $cmsPath);
291 $backdropVersionFiles = array(
293 implode(CIVICRM_DIRECTORY_SEPARATOR
, array($cmsPath, 'core', 'includes', 'bootstrap.inc')),
295 foreach ($backdropVersionFiles as $backdropVersionFile) {
296 if (file_exists($backdropVersionFile)) {
297 require_once $backdropVersionFile;
300 if (!defined('BACKDROP_VERSION') or version_compare(BACKDROP_VERSION
, '1.0') < 0) {
301 $errorTitle = ts("Oops! Incorrect Backdrop version");
302 $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)));
303 errorDisplayPage($errorTitle, $errorMsg);
306 elseif ($installType == 'wordpress') {
308 $civicrm_version['cms'] = 'WordPress';
310 // Ensure that they have downloaded the correct version of CiviCRM
311 if ($civicrm_version['cms'] != 'WordPress') {
312 $errorTitle = ts("Oops! Incorrect CiviCRM version");
313 $errorMsg = ts("This installer can only be used for the WordPress version of CiviCRM.");
314 errorDisplayPage($errorTitle, $errorMsg);
318 // Load CiviCRM database config
319 if (isset($_POST['mysql'])) {
320 $databaseConfig = $_POST['mysql'];
323 if ($installType == 'wordpress') {
324 // Load WP database config
325 if (isset($_POST['mysql'])) {
326 $databaseConfig = $_POST['mysql'];
329 $databaseConfig = array(
331 "username" => DB_USER
,
332 "password" => DB_PASSWORD
,
333 "database" => DB_NAME
,
338 if ($installType == 'drupal') {
339 // Load drupal database config
340 if (isset($_POST['drupal'])) {
341 $drupalConfig = $_POST['drupal'];
344 $dbServer = $databases['default']['default']['host'];
345 if (!empty($databases['default']['default']['port'])) {
346 $dbServer .= ':' . $databases['default']['default']['port'];
348 $drupalConfig = array(
349 "server" => $dbServer,
350 "username" => $databases['default']['default']['username'],
351 "password" => $databases['default']['default']['password'],
352 "database" => $databases['default']['default']['database'],
357 if ($installType == 'backdrop') {
358 // Load backdrop database config
359 if (isset($_POST['backdrop'])) {
360 $backdropConfig = $_POST['backdrop'];
363 $backdropConfig = array(
364 "server" => "localhost",
365 "username" => "backdrop",
367 "database" => "backdrop",
372 // By default set CiviCRM database to be same as CMS database
373 if (!isset($databaseConfig)) {
374 if (($installType == 'drupal') && (isset($drupalConfig))) {
375 $databaseConfig = $drupalConfig;
377 if (($installType == 'backdrop') && (isset($backdropConfig))) {
378 $databaseConfig = $backdropConfig;
382 // Check requirements
383 $req = new InstallRequirements();
386 if ($req->hasErrors()) {
387 $hasErrorOtherThanDatabase = TRUE;
390 if ($databaseConfig) {
391 $dbReq = new InstallRequirements();
392 $dbReq->checkdatabase($databaseConfig, 'CiviCRM');
393 if ($installType == 'drupal') {
394 $dbReq->checkdatabase($drupalConfig, 'Drupal');
396 if ($installType == 'backdrop') {
397 $dbReq->checkdatabase($backdropConfig, 'Backdrop');
402 if (isset($_POST['go']) && !$req->hasErrors() && !$dbReq->hasErrors()) {
403 // Confirm before reinstalling
404 if (!isset($_POST['force_reinstall']) && $alreadyInstalled) {
405 include $installDirPath . 'template.html';
408 $inst = new Installer();
409 $inst->install($_POST);
412 // Show the config form
415 include $installDirPath . 'template.html';
419 * This class checks requirements
420 * Each of the requireXXX functions takes an argument which gives a user description of the test. It's an array
422 * $description[0] - The test category
423 * $description[1] - The test title
424 * $description[2] - The test error to show, if it goes wrong
426 class InstallRequirements
{
427 var $errors, $warnings, $tests, $conn;
429 // @see CRM_Upgrade_Form::MINIMUM_THREAD_STACK
430 const MINIMUM_THREAD_STACK
= 192;
433 * Just check that the database configuration is okay.
434 * @param $databaseConfig
437 public function checkdatabase($databaseConfig, $dbName) {
438 if ($this->requireFunction('mysqli_connect',
440 ts("PHP Configuration"),
442 ts("MySQL support not included in PHP."),
446 $this->requireMySQLServer($databaseConfig['server'],
448 ts("MySQL %1 Configuration", array(1 => $dbName)),
449 ts("Does the server exist?"),
450 ts("Can't find the a MySQL server on '%1'.", array(1 => $databaseConfig['server'])),
451 $databaseConfig['server'],
454 if ($this->requireMysqlConnection($databaseConfig['server'],
455 $databaseConfig['username'],
456 $databaseConfig['password'],
458 ts("MySQL %1 Configuration", array(1 => $dbName)),
459 ts("Are the access credentials correct?"),
460 ts("That username/password doesn't work"),
464 @$this->requireMySQLVersion("5.1",
466 ts("MySQL %1 Configuration", array(1 => $dbName)),
467 ts("MySQL version at least %1", array(1 => '5.1')),
468 ts("MySQL version %1 or higher is required, you are running MySQL %2.", array(1 => '5.1', 2 => mysqli_get_server_info($this->conn
))),
469 ts("MySQL %1", array(1 => mysqli_get_server_info($this->conn
))),
472 $this->requireMySQLAutoIncrementIncrementOne($databaseConfig['server'],
473 $databaseConfig['username'],
474 $databaseConfig['password'],
476 ts("MySQL %1 Configuration", array(1 => $dbName)),
477 ts("Is auto_increment_increment set to 1"),
478 ts("An auto_increment_increment value greater than 1 is not currently supported. Please see issue CRM-7923 for further details and potential workaround."),
481 $testDetails = array(
482 ts("MySQL %1 Configuration", array(1 => $dbName)),
483 ts("Is the provided database name valid?"),
484 ts("The database name provided is not valid. Please use only 0-9, a-z, A-Z, _ and - as characters in the name."),
486 if (!CRM_Core_DAO
::requireSafeDBName($databaseConfig['database'])) {
487 $this->error($testDetails);
491 $this->testing($testDetails);
493 $this->requireMySQLThreadStack($databaseConfig['server'],
494 $databaseConfig['username'],
495 $databaseConfig['password'],
496 $databaseConfig['database'],
497 self
::MINIMUM_THREAD_STACK
,
499 ts("MySQL %1 Configuration", array(1 => $dbName)),
500 ts("Does MySQL thread_stack meet minimum (%1k)", array(1 => self
::MINIMUM_THREAD_STACK
)),
502 // "The MySQL thread_stack does not meet minimum " . CRM_Upgrade_Form::MINIMUM_THREAD_STACK . "k. Please update thread_stack in my.cnf.",
506 $onlyRequire = ($dbName == 'Drupal' ||
$dbName == 'Backdrop') ?
TRUE : FALSE;
507 $this->requireDatabaseOrCreatePermissions(
508 $databaseConfig['server'],
509 $databaseConfig['username'],
510 $databaseConfig['password'],
511 $databaseConfig['database'],
513 ts("MySQL %1 Configuration", array(1 => $dbName)),
514 ts("Can I access/create the database?"),
515 ts("I can't create new databases and the database '%1' doesn't exist.", array(1 => $databaseConfig['database'])),
519 if ($dbName != 'Drupal' && $dbName != 'Backdrop') {
520 $this->requireMySQLInnoDB($databaseConfig['server'],
521 $databaseConfig['username'],
522 $databaseConfig['password'],
523 $databaseConfig['database'],
525 ts("MySQL %1 Configuration", array(1 => $dbName)),
526 ts("Can I access/create InnoDB tables in the database?"),
527 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."),
530 $this->requireMySQLTempTables($databaseConfig['server'],
531 $databaseConfig['username'],
532 $databaseConfig['password'],
533 $databaseConfig['database'],
535 ts("MySQL %1 Configuration", array(1 => $dbName)),
536 ts('Can I create temporary tables in the database?'),
537 ts('Unable to create temporary tables. This MySQL user is missing the CREATE TEMPORARY TABLES privilege.'),
540 $this->requireMySQLLockTables($databaseConfig['server'],
541 $databaseConfig['username'],
542 $databaseConfig['password'],
543 $databaseConfig['database'],
545 ts("MySQL %1 Configuration", array(1 => $dbName)),
546 ts('Can I create lock tables in the database?'),
547 ts('Unable to lock tables. This MySQL user is missing the LOCK TABLES privilege.'),
550 $this->requireMySQLTrigger($databaseConfig['server'],
551 $databaseConfig['username'],
552 $databaseConfig['password'],
553 $databaseConfig['database'],
555 ts("MySQL %1 Configuration", array(1 => $dbName)),
556 ts('Can I create triggers in the database?'),
557 ts('Unable to create triggers. This MySQL user is missing the CREATE TRIGGERS privilege.'),
560 $this->requireMySQLUtf8mb4($databaseConfig['server'],
561 $databaseConfig['username'],
562 $databaseConfig['password'],
563 $databaseConfig['database'],
565 ts("MySQL %1 Configuration", array(1 => $dbName)),
566 ts('Is the <code>utf8mb4</code> character set supported?'),
567 ts('This MySQL server does not support the <code>utf8mb4</code> character set.'),
575 * Connect via mysqli.
577 * This is exactly the same as mysqli_connect(), except that it accepts
578 * the port as part of the `$host`.
580 * @param string $host
581 * Ex: 'localhost', 'localhost:3307', '127.0.0.1:3307', '[::1]', '[::1]:3307'.
582 * @param string $username
583 * @param string $password
584 * @param string $database
587 protected function connect($host, $username, $password, $database = '') {
588 $hostParts = explode(':', $host);
589 if (count($hostParts) > 1 && strrpos($host, ']') !== strlen($host) - 1) {
590 $port = array_pop($hostParts);
591 $host = implode(':', $hostParts);
596 $conn = @mysqli_connect
($host, $username, $password, $database, $port);
601 * Check everything except the database.
603 public function check() {
604 global $crmPath, $installType;
606 $this->errors
= NULL;
608 $this->requirePHPVersion(array(
609 ts("PHP Configuration"),
610 ts("PHP5 installed"),
613 // Check that we can identify the root folder successfully
614 $this->requireFile($crmPath . CIVICRM_DIRECTORY_SEPARATOR
. 'README.md',
616 ts("File permissions"),
617 ts("Does the webserver know where files are stored?"),
618 ts("The webserver isn't letting me identify where files are stored."),
624 // CRM-6485: make sure the path does not contain PATH_SEPARATOR, as we don’t know how to escape it
625 $this->requireNoPathSeparator(
627 ts("File permissions"),
628 ts('Does the CiviCRM path contain PATH_SEPARATOR?'),
629 ts('The path %1 contains PATH_SEPARATOR (the %2 character).', array(1 => $this->getBaseDir(), 2 => PATH_SEPARATOR
)),
634 $requiredDirectories = array('CRM', 'packages', 'templates', 'js', 'api', 'i', 'sql');
635 foreach ($requiredDirectories as $dir) {
636 $this->requireFile($crmPath . CIVICRM_DIRECTORY_SEPARATOR
. $dir,
638 ts("File permissions"),
639 ts("Folder '%1' exists?", array(1 => $dir)),
640 ts("There is no '%1' folder.", array(1 => $dir)),
645 $configIDSiniDir = NULL;
647 $siteDir = getSiteDir($cmsPath, $_SERVER['SCRIPT_FILENAME']);
648 if ($installType == 'drupal') {
650 // make sure that we can write to sites/default and files/
651 $writableDirectories = array(
652 $cmsPath . CIVICRM_DIRECTORY_SEPARATOR
.
653 'sites' . CIVICRM_DIRECTORY_SEPARATOR
.
654 $siteDir . CIVICRM_DIRECTORY_SEPARATOR
.
656 $cmsPath . CIVICRM_DIRECTORY_SEPARATOR
.
657 'sites' . CIVICRM_DIRECTORY_SEPARATOR
.
661 elseif ($installType == 'backdrop') {
663 // make sure that we can write to sites/default and files/
664 $writableDirectories = array(
665 $cmsPath . CIVICRM_DIRECTORY_SEPARATOR
.
670 elseif ($installType == 'wordpress') {
671 // make sure that we can write to uploads/civicrm/
672 $upload_dir = wp_upload_dir();
673 $files_dirname = $upload_dir['basedir'] . DIRECTORY_SEPARATOR
. 'civicrm';
674 if (!file_exists($files_dirname)) {
675 wp_mkdir_p($files_dirname);
677 $writableDirectories = array($files_dirname);
680 foreach ($writableDirectories as $dir) {
681 $dirName = CIVICRM_WINDOWS ?
$dir : CIVICRM_DIRECTORY_SEPARATOR
. $dir;
682 $testDetails = array(
683 ts("File permissions"),
684 ts("Is the %1 folder writeable?", array(1 => $dir)),
687 $this->requireWriteable($dirName, $testDetails, TRUE);
690 //check for Config.IDS.ini, file may exist in re-install
691 $configIDSiniDir = array($cmsPath, 'sites', $siteDir, 'files', 'civicrm', 'upload', 'Config.IDS.ini');
693 if (is_array($configIDSiniDir) && !empty($configIDSiniDir)) {
694 $configIDSiniFile = implode(CIVICRM_DIRECTORY_SEPARATOR
, $configIDSiniDir);
695 if (file_exists($configIDSiniFile)) {
696 unlink($configIDSiniFile);
700 // Check for rewriting
701 if (isset($_SERVER['SERVER_SOFTWARE'])) {
702 $webserver = strip_tags(trim($_SERVER['SERVER_SOFTWARE']));
704 elseif (isset($_SERVER['SERVER_SIGNATURE'])) {
705 $webserver = strip_tags(trim($_SERVER['SERVER_SIGNATURE']));
708 if ($webserver == '') {
709 $webserver = ts("I can't tell what webserver you are running");
712 // Check for $_SERVER configuration
713 $this->requireServerVariables(array('SCRIPT_NAME', 'HTTP_HOST', 'SCRIPT_FILENAME'), array(
714 ts("Webserver config"),
715 ts("Recognised webserver"),
716 ts("You seem to be using an unsupported webserver. The server variables SCRIPT_NAME, HTTP_HOST, SCRIPT_FILENAME need to be set."),
719 // Check for MySQL support
720 $this->requireFunction('mysqli_connect', array(
721 ts("PHP Configuration"),
723 ts("MySQL support not included in PHP."),
726 // Check for XML support
727 $this->requireFunction('simplexml_load_file', array(
728 ts("PHP Configuration"),
729 ts("SimpleXML support"),
730 ts("SimpleXML support not included in PHP."),
733 // Check for JSON support
734 $this->requireFunction('json_encode', array(
735 ts("PHP Configuration"),
737 ts("JSON support not included in PHP."),
740 // check for Multibyte support such as mb_substr. Required for proper handling of Multilingual setups.
741 $this->requireFunction('mb_substr', array(
742 ts("PHP Configuration"),
743 ts("Multibyte support"),
744 ts("Multibyte support not enabled in PHP."),
747 // Check for xcache_isset and emit warning if exists
748 $this->checkXCache(array(
749 ts("PHP Configuration"),
750 ts("XCache compatibility"),
751 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."),
754 // Check memory allocation
755 $this->requireMemory(32 * 1024 * 1024,
758 ts("PHP Configuration"),
759 ts("Memory allocated (PHP config option 'memory_limit')"),
760 ts("CiviCRM needs a minimum of %1 MB allocated to PHP, but recommends %2 MB.", array(1 => 32, 2 => 64)),
761 ini_get("memory_limit"),
765 return $this->errors
;
770 * @param $recommended
771 * @param $testDetails
773 public function requireMemory($min, $recommended, $testDetails) {
774 $this->testing($testDetails);
775 $mem = $this->getPHPMemory();
777 if ($mem < $min && $mem > 0) {
778 $testDetails[2] .= " " . ts("You only have %1 allocated", array(1 => ini_get("memory_limit")));
779 $this->error($testDetails);
781 elseif ($mem < $recommended && $mem > 0) {
782 $testDetails[2] .= " " . ts("You only have %1 allocated", array(1 => ini_get("memory_limit")));
783 $this->warning($testDetails);
786 $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));
787 $this->warning($testDetails);
794 public function getPHPMemory() {
795 $memString = ini_get("memory_limit");
797 switch (strtolower(substr($memString, -1))) {
799 return round(substr($memString, 0, -1) * 1024);
802 return round(substr($memString, 0, -1) * 1024 * 1024);
805 return round(substr($memString, 0, -1) * 1024 * 1024 * 1024);
808 return round($memString);
812 public function listErrors() {
814 echo "<p>" . ts("The following problems are preventing me from installing CiviCRM:") . "</p>";
815 foreach ($this->errors
as $error) {
816 echo "<li>" . htmlentities($error) . "</li>";
822 * @param null $section
824 public function showTable($section = NULL) {
826 $tests = $this->tests
[$section];
827 echo "<table class=\"testResults\" width=\"100%\">";
828 foreach ($tests as $test => $result) {
829 echo "<tr class=\"$result[0]\"><td>$test</td><td>" . nl2br(htmlentities($result[1])) . "</td></tr>";
834 foreach ($this->tests
as $section => $tests) {
835 echo "<h3>$section</h3>";
836 echo "<table class=\"testResults\" width=\"100%\">";
838 foreach ($tests as $test => $result) {
839 echo "<tr class=\"$result[0]\"><td>$test</td><td>" . nl2br(htmlentities($result[1])) . "</td></tr>";
847 * @param string $funcName
848 * @param $testDetails
852 public function requireFunction($funcName, $testDetails) {
853 $this->testing($testDetails);
855 if (!function_exists($funcName)) {
856 $this->error($testDetails);
865 * @param $testDetails
867 public function checkXCache($testDetails) {
868 if (function_exists('xcache_isset') &&
869 ini_get('xcache.size') > 0
871 $this->testing($testDetails);
872 $this->warning($testDetails);
877 * @param array $testDetails
880 public function requirePHPVersion($testDetails) {
882 $this->testing($testDetails);
884 $phpVersion = phpversion();
885 $aboveMinVersion = version_compare($phpVersion, CRM_Upgrade_Incremental_General
::MIN_INSTALL_PHP_VER
) >= 0;
887 if ($aboveMinVersion) {
888 if (version_compare($phpVersion, CRM_Upgrade_Incremental_General
::MIN_RECOMMENDED_PHP_VER
) < 0) {
889 $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(
891 2 => CRM_Upgrade_Incremental_General
::MIN_RECOMMENDED_PHP_VER
,
892 3 => CRM_Upgrade_Incremental_General
::RECOMMENDED_PHP_VER
,
894 $this->warning($testDetails);
899 if (empty($testDetails[2])) {
900 $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));
903 $this->error($testDetails);
907 * @param string $filename
908 * @param $testDetails
909 * @param bool $absolute
911 public function requireFile($filename, $testDetails, $absolute = FALSE) {
912 $this->testing($testDetails);
914 $filename = $this->getBaseDir() . $filename;
916 if (!file_exists($filename)) {
917 $testDetails[2] .= " (" . ts("file '%1' not found", array(1 => $filename)) . ')';
918 $this->error($testDetails);
923 * @param $testDetails
925 public function requireNoPathSeparator($testDetails) {
926 $this->testing($testDetails);
927 if (substr_count($this->getBaseDir(), PATH_SEPARATOR
)) {
928 $this->error($testDetails);
933 * @param string $filename
934 * @param $testDetails
936 public function requireNoFile($filename, $testDetails) {
937 $this->testing($testDetails);
938 $filename = $this->getBaseDir() . $filename;
939 if (file_exists($filename)) {
940 $testDetails[2] .= " (" . ts("file '%1' found", array(1 => $filename)) . ")";
941 $this->error($testDetails);
946 * @param string $filename
947 * @param $testDetails
949 public function moveFileOutOfTheWay($filename, $testDetails) {
950 $this->testing($testDetails);
951 $filename = $this->getBaseDir() . $filename;
952 if (file_exists($filename)) {
953 if (file_exists("$filename.bak")) {
956 rename($filename, "$filename.bak");
961 * @param string $filename
962 * @param $testDetails
963 * @param bool $absolute
965 public function requireWriteable($filename, $testDetails, $absolute = FALSE) {
966 $this->testing($testDetails);
968 $filename = $this->getBaseDir() . $filename;
971 if (!is_writable($filename)) {
973 if (function_exists('posix_getpwuid')) {
974 $user = posix_getpwuid(posix_geteuid());
975 $name = '- ' . $user['name'] . ' -';
978 if (!isset($testDetails[2])) {
979 $testDetails[2] = NULL;
981 $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";
982 $this->error($testDetails);
987 * @param string $moduleName
988 * @param $testDetails
990 public function requireApacheModule($moduleName, $testDetails) {
991 $this->testing($testDetails);
992 if (!in_array($moduleName, apache_get_modules())) {
993 $this->error($testDetails);
999 * @param string $username
1001 * @param $testDetails
1003 public function requireMysqlConnection($server, $username, $password, $testDetails) {
1004 $this->testing($testDetails);
1005 $this->conn
= $this->connect($server, $username, $password);
1011 $testDetails[2] .= ": " . mysqli_connect_error();
1012 $this->error($testDetails);
1018 * @param $testDetails
1020 public function requireMySQLServer($server, $testDetails) {
1021 $this->testing($testDetails);
1022 $conn = $this->connect($server, NULL, NULL);
1024 if ($conn ||
mysqli_connect_errno() < 2000) {
1028 $testDetails[2] .= ": " . mysqli_connect_error();
1029 $this->error($testDetails);
1035 * @param $testDetails
1037 public function requireMySQLVersion($version, $testDetails) {
1038 $this->testing($testDetails);
1040 if (!mysqli_get_server_info($this->conn
)) {
1041 $testDetails[2] = ts('Cannot determine the version of MySQL installed. Please ensure at least version %1 is installed.', array(1 => $version));
1042 $this->warning($testDetails);
1045 list($majorRequested, $minorRequested) = explode('.', $version);
1046 list($majorHas, $minorHas) = explode('.', mysqli_get_server_info($this->conn
));
1048 if (($majorHas > $majorRequested) ||
($majorHas == $majorRequested && $minorHas >= $minorRequested)) {
1052 $testDetails[2] .= "{$majorHas}.{$minorHas}.";
1053 $this->error($testDetails);
1060 * @param string $username
1063 * @param $testDetails
1065 public function requireMySQLInnoDB($server, $username, $password, $database, $testDetails) {
1066 $this->testing($testDetails);
1067 $conn = $this->connect($server, $username, $password);
1069 $testDetails[2] .= ' ' . ts("Could not determine if MySQL has InnoDB support. Assuming no.");
1070 $this->error($testDetails);
1074 $innodb_support = FALSE;
1075 $result = mysqli_query($conn, "SHOW ENGINES");
1076 while ($values = mysqli_fetch_array($result)) {
1077 if ($values['Engine'] == 'InnoDB') {
1078 if (strtolower($values['Support']) == 'yes' ||
1079 strtolower($values['Support']) == 'default'
1081 $innodb_support = TRUE;
1085 if ($innodb_support) {
1086 $testDetails[3] = ts('MySQL server does have InnoDB support');
1089 $testDetails[2] .= ' ' . ts('Could not determine if MySQL has InnoDB support. Assuming no');
1095 * @param string $username
1098 * @param $testDetails
1100 public function requireMySQLTempTables($server, $username, $password, $database, $testDetails) {
1101 $this->testing($testDetails);
1102 $conn = $this->connect($server, $username, $password);
1104 $testDetails[2] = ts('Could not login to the database.');
1105 $this->error($testDetails);
1109 if (!@mysqli_select_db
($conn, $database)) {
1110 $testDetails[2] = ts('Could not select the database.');
1111 $this->error($testDetails);
1115 $result = mysqli_query($conn, 'CREATE TEMPORARY TABLE civicrm_install_temp_table_test (test text)');
1117 $testDetails[2] = ts('Could not create a temp table.');
1118 $this->error($testDetails);
1120 $result = mysqli_query($conn, 'DROP TEMPORARY TABLE civicrm_install_temp_table_test');
1125 * @param string $username
1128 * @param $testDetails
1130 public function requireMySQLTrigger($server, $username, $password, $database, $testDetails) {
1131 $this->testing($testDetails);
1132 $conn = $this->connect($server, $username, $password);
1134 $testDetails[2] = ts('Could not login to the database.');
1135 $this->error($testDetails);
1139 if (!@mysqli_select_db
($conn, $database)) {
1140 $testDetails[2] = ts('Could not select the database.');
1141 $this->error($testDetails);
1145 $result = mysqli_query($conn, 'CREATE TABLE civicrm_install_temp_table_test (test text)');
1147 $testDetails[2] = ts('Could not create a table in the database.');
1148 $this->error($testDetails);
1151 $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');
1153 mysqli_query($conn, 'DROP TABLE civicrm_install_temp_table_test');
1154 $testDetails[2] = ts('Could not create a database trigger.');
1155 $this->error($testDetails);
1158 mysqli_query($conn, 'DROP TRIGGER civicrm_install_temp_table_test_trigger');
1159 mysqli_query($conn, 'DROP TABLE civicrm_install_temp_table_test');
1165 * @param string $username
1168 * @param $testDetails
1170 public function requireMySQLLockTables($server, $username, $password, $database, $testDetails) {
1171 $this->testing($testDetails);
1172 $conn = $this->connect($server, $username, $password);
1174 $testDetails[2] = ts('Could not connect to the database server.');
1175 $this->error($testDetails);
1179 if (!@mysqli_select_db
($conn, $database)) {
1180 $testDetails[2] = ts('Could not select the database.');
1181 $this->error($testDetails);
1185 $result = mysqli_query($conn, 'CREATE TEMPORARY TABLE civicrm_install_temp_table_test (test text)');
1187 $testDetails[2] = ts('Could not create a table in the database.');
1188 $this->error($testDetails);
1192 $result = mysqli_query($conn, 'LOCK TABLES civicrm_install_temp_table_test WRITE');
1194 $testDetails[2] = ts('Could not obtain a write lock for the database table.');
1195 $this->error($testDetails);
1196 $result = mysqli_query($conn, 'DROP TEMPORARY TABLE civicrm_install_temp_table_test');
1200 $result = mysqli_query($conn, 'UNLOCK TABLES');
1202 $testDetails[2] = ts('Could not release the lock for the database table.');
1203 $this->error($testDetails);
1204 $result = mysqli_query($conn, 'DROP TEMPORARY TABLE civicrm_install_temp_table_test');
1208 $result = mysqli_query($conn, 'DROP TEMPORARY TABLE civicrm_install_temp_table_test');
1213 * @param string $username
1215 * @param $testDetails
1217 public function requireMySQLAutoIncrementIncrementOne($server, $username, $password, $testDetails) {
1218 $this->testing($testDetails);
1219 $conn = $this->connect($server, $username, $password);
1221 $testDetails[2] = ts('Could not connect to the database server.');
1222 $this->error($testDetails);
1226 $result = mysqli_query($conn, "SHOW variables like 'auto_increment_increment'");
1228 $testDetails[2] = ts('Could not query database server variables.');
1229 $this->error($testDetails);
1233 $values = mysqli_fetch_row($result);
1234 if ($values[1] == 1) {
1235 $testDetails[3] = ts('MySQL server auto_increment_increment is 1');
1238 $this->error($testDetails);
1245 * @param string $username
1248 * @param $minValueKB
1249 * @param $testDetails
1251 public function requireMySQLThreadStack($server, $username, $password, $database, $minValueKB, $testDetails) {
1252 $this->testing($testDetails);
1253 $conn = $this->connect($server, $username, $password);
1255 $testDetails[2] = ts('Could not connect to the database server.');
1256 $this->error($testDetails);
1260 if (!@mysqli_select_db
($conn, $database)) {
1261 $testDetails[2] = ts('Could not select the database.');
1262 $this->error($testDetails);
1266 $result = mysqli_query($conn, "SHOW VARIABLES LIKE 'thread_stack'"); // bytes => kb
1268 $testDetails[2] = ts('Could not get information about the thread_stack of the database.');
1269 $this->error($testDetails);
1272 $values = mysqli_fetch_row($result);
1273 if ($values[1] < (1024 * $minValueKB)) {
1274 $testDetails[2] = ts('MySQL "thread_stack" is %1 kb', array(1 => ($values[1] / 1024)));
1275 $this->error($testDetails);
1282 * @param string $username
1285 * @param $testDetails
1286 * @param bool $onlyRequire
1288 public function requireDatabaseOrCreatePermissions(
1294 $onlyRequire = FALSE
1296 $this->testing($testDetails);
1297 $conn = $this->connect($server, $username, $password);
1300 if (@mysqli_select_db
($conn, $database)) {
1301 $okay = "Database '$database' exists";
1303 elseif ($onlyRequire) {
1304 $testDetails[2] = ts("The database: '%1' does not exist.", array(1 => $database));
1305 $this->error($testDetails);
1309 $query = sprintf("CREATE DATABASE %s", mysqli_real_escape_string($conn, $database));
1310 if (@mysqli_query
($conn, $query)) {
1311 $okay = ts("Able to create a new database.");
1314 $testDetails[2] .= " (" . ts("user '%1' doesn't have CREATE DATABASE permissions.", array(1 => $username)) . ")";
1315 $this->error($testDetails);
1321 $testDetails[3] = $okay;
1322 $this->testing($testDetails);
1328 * @param $errorMessage
1330 public function requireServerVariables($varNames, $errorMessage) {
1331 //$this->testing($testDetails);
1332 foreach ($varNames as $varName) {
1333 if (!$_SERVER[$varName]) {
1334 $missing[] = '$_SERVER[' . $varName . ']';
1337 if (!isset($missing)) {
1341 $testDetails[2] = " (" . ts('the following PHP variables are missing: %1', array(1 => implode(", ", $missing))) . ")";
1342 $this->error($testDetails);
1348 * @param string $username
1351 * @param $testDetails
1353 public function requireMysqlUtf8mb4($server, $username, $password, $database, $testDetails) {
1354 $this->testing($testDetails);
1355 $conn = $this->connect($server, $username, $password);
1357 $testDetails[2] = ts('Could not connect to the database server.');
1358 $this->error($testDetails);
1362 if (!@mysqli_select_db
($conn, $database)) {
1363 $testDetails[2] = ts('Could not select the database.');
1364 $this->error($testDetails);
1368 $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');
1370 $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');
1371 $this->warning($testDetails);
1374 $result = mysqli_query($conn, 'DROP TABLE civicrm_utf8mb4_test');
1376 // Ensure that the MySQL driver supports utf8mb4 encoding.
1377 $version = mysqli_get_client_info($conn);
1378 if (strpos($version, 'mysqlnd') !== FALSE) {
1379 // The mysqlnd driver supports utf8mb4 starting at version 5.0.9.
1380 $version = preg_replace('/^\D+([\d.]+).*/', '$1', $version);
1381 if (version_compare($version, '5.0.9', '<')) {
1382 $testDetails[2] = 'It is recommended, though not yet required, to upgrade your PHP MySQL driver (mysqlnd) to >= 5.0.9 for utf8mb4 support.';
1383 $this->warning($testDetails);
1388 // The libmysqlclient driver supports utf8mb4 starting at version 5.5.3.
1389 if (version_compare($version, '5.5.3', '<')) {
1390 $testDetails[2] = 'It is recommended, though not yet required, to upgrade your PHP MySQL driver (libmysqlclient) to >= 5.5.3 for utf8mb4 support.';
1391 $this->warning($testDetails);
1398 * @param $testDetails
1402 public function isRunningApache($testDetails) {
1403 $this->testing($testDetails);
1404 if (function_exists('apache_get_modules') ||
stristr($_SERVER['SERVER_SIGNATURE'], 'Apache')) {
1408 $this->warning($testDetails);
1415 public function getBaseDir() {
1416 return dirname($_SERVER['SCRIPT_FILENAME']) . CIVICRM_DIRECTORY_SEPARATOR
;
1420 * @param $testDetails
1422 public function testing($testDetails) {
1423 if (!$testDetails) {
1427 $section = $testDetails[0];
1428 $test = $testDetails[1];
1430 $message = ts("OK");
1431 if (isset($testDetails[3])) {
1432 $message .= " ($testDetails[3])";
1435 $this->tests
[$section][$test] = array("good", $message);
1439 * @param $testDetails
1441 public function error($testDetails) {
1442 $section = $testDetails[0];
1443 $test = $testDetails[1];
1445 $this->tests
[$section][$test] = array("error", $testDetails[2]);
1446 $this->errors
[] = $testDetails;
1450 * @param $testDetails
1452 public function warning($testDetails) {
1453 $section = $testDetails[0];
1454 $test = $testDetails[1];
1456 $this->tests
[$section][$test] = array("warning", $testDetails[2]);
1457 $this->warnings
[] = $testDetails;
1463 public function hasErrors() {
1464 return !empty($this->errors
);
1470 public function hasWarnings() {
1471 return !empty($this->warnings
);
1479 class Installer
extends InstallRequirements
{
1486 public function createDatabaseIfNotExists($server, $username, $password, $database) {
1487 $conn = $this->connect($server, $username, $password);
1489 if (@mysqli_select_db
($conn, $database)) {
1490 // skip if database already present
1493 $query = sprintf("CREATE DATABASE %s", mysqli_real_escape_string($conn, $database));
1494 if (@mysqli_query
($conn, $query)) {
1497 $errorTitle = ts("Oops! Could not create database %1", array(1 => $database));
1498 $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.");
1499 errorDisplayPage($errorTitle, $errorMsg);
1508 public function install($config) {
1509 global $installDirPath;
1511 // create database if does not exists
1512 $this->createDatabaseIfNotExists($config['mysql']['server'],
1513 $config['mysql']['username'],
1514 $config['mysql']['password'],
1515 $config['mysql']['database']
1518 global $installDirPath;
1521 require_once $installDirPath . 'civicrm.php';
1522 civicrm_main($config);
1524 if (!$this->errors
) {
1525 global $installType, $installURLPath;
1527 $registerSiteURL = "https://civicrm.org/register-site";
1528 $commonOutputMessage
1529 = "<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>"
1530 . "<li>" . ts("We have integrated KCFinder with CKEditor and TinyMCE. This allows a user to upload images. All uploaded images are public.") . "</li>";
1535 $installType == 'drupal' &&
1536 version_compare(VERSION
, '7.0-rc1') >= 0
1542 $output .= '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">';
1543 $output .= '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1544 $output .= '<head>';
1545 $output .= '<title>' . ts('CiviCRM Installed') . '</title>';
1546 $output .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
1547 $output .= '<link rel="stylesheet" type="text/css" href="template.css" />';
1548 $output .= '</head>';
1549 $output .= '<body>';
1550 $output .= '<div style="padding: 1em;"><p class="good">' . ts('CiviCRM has been successfully installed') . '</p>';
1553 $drupalURL = civicrm_cms_base();
1554 $drupalPermissionsURL = "{$drupalURL}index.php?q=admin/people/permissions";
1555 $drupalURL .= "index.php?q=civicrm/admin/configtask&reset=1";
1557 $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>";
1558 $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>";
1559 $output .= $commonOutputMessage;
1561 // automatically enable CiviCRM module once it is installed successfully.
1562 // so we need to Bootstrap Drupal, so that we can call drupal hooks.
1563 global $cmsPath, $crmPath;
1565 // relative / abosolute paths are not working for drupal, hence using chdir()
1568 // Force the re-initialisation of the config singleton on the next call
1569 // since so far, we had used the Config object without loading the DB.
1570 $c = CRM_Core_Config
::singleton(FALSE);
1573 include_once "./includes/bootstrap.inc";
1574 include_once "./includes/unicode.inc";
1576 drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL
);
1578 // prevent session information from being saved.
1579 drupal_save_session(FALSE);
1581 // Force the current user to anonymous.
1582 $original_user = $GLOBALS['user'];
1583 $GLOBALS['user'] = drupal_anonymous_user();
1585 // explicitly setting error reporting, since we cannot handle drupal related notices
1588 // rebuild modules, so that civicrm is added
1589 system_rebuild_module_data();
1591 // now enable civicrm module.
1592 module_enable(array('civicrm', 'civicrmtheme'));
1594 // SystemInstallEvent will be called from here with the first call of CRM_Core_Config,
1595 // which calls Core_BAO_ConfigSetting::applyLocale(), who will default to calling
1596 // Civi::settings()->get('lcMessages');
1597 // Therefore, we need to pass the seedLanguage before that.
1598 global $civicrm_setting;
1599 $civicrm_setting['domain']['lcMessages'] = $config['seedLanguage'];
1601 // clear block, page, theme, and hook caches
1602 drupal_flush_all_caches();
1604 //add basic drupal permissions
1605 civicrm_install_set_drupal_perms();
1607 // restore the user.
1608 $GLOBALS['user'] = $original_user;
1609 drupal_save_session(TRUE);
1612 $output .= '</div>';
1613 $output .= '</body>';
1614 $output .= '</html>';
1618 $installType == 'backdrop'
1624 $output .= '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">';
1625 $output .= '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1626 $output .= '<head>';
1627 $output .= '<title>' . ts('CiviCRM Installed') . '</title>';
1628 $output .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
1629 $output .= '<link rel="stylesheet" type="text/css" href="template.css" />';
1630 $output .= '</head>';
1631 $output .= '<body>';
1632 $output .= '<div style="padding: 1em;"><p class="good">' . ts('CiviCRM has been successfully installed') . '</p>';
1635 $backdropURL = civicrm_cms_base();
1636 $backdropPermissionsURL = "{$backdropURL}index.php?q=admin/config/people/permissions";
1637 $backdropURL .= "index.php?q=civicrm/admin/configtask&reset=1";
1639 $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>";
1640 $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>";
1641 $output .= $commonOutputMessage;
1643 // automatically enable CiviCRM module once it is installed successfully.
1644 // so we need to Bootstrap Drupal, so that we can call drupal hooks.
1645 global $cmsPath, $crmPath;
1647 // relative / abosolute paths are not working for drupal, hence using chdir()
1650 // Force the re-initialisation of the config singleton on the next call
1651 // since so far, we had used the Config object without loading the DB.
1652 $c = CRM_Core_Config
::singleton(FALSE);
1655 include_once "./core/includes/bootstrap.inc";
1656 include_once "./core/includes/unicode.inc";
1657 include_once "./core/includes/config.inc";
1659 backdrop_bootstrap(BACKDROP_BOOTSTRAP_FULL
);
1661 // prevent session information from being saved.
1662 backdrop_save_session(FALSE);
1664 // Force the current user to anonymous.
1665 $original_user = $GLOBALS['user'];
1666 $GLOBALS['user'] = backdrop_anonymous_user();
1668 // explicitly setting error reporting, since we cannot handle drupal related notices
1671 // rebuild modules, so that civicrm is added
1672 system_rebuild_module_data();
1674 // now enable civicrm module.
1675 module_enable(array('civicrm', 'civicrmtheme'));
1677 // clear block, page, theme, and hook caches
1678 backdrop_flush_all_caches();
1680 //add basic backdrop permissions
1681 civicrm_install_set_backdrop_perms();
1683 // restore the user.
1684 $GLOBALS['user'] = $original_user;
1685 backdrop_save_session(TRUE);
1687 //change the default language to one chosen
1688 if (isset($config['seedLanguage']) && $config['seedLanguage'] != 'en_US') {
1689 civicrm_api3('Setting', 'create', array(
1690 'domain_id' => 'current_domain',
1691 'lcMessages' => $config['seedLanguage'],
1697 $output .= '</div>';
1698 $output .= '</body>';
1699 $output .= '</html>';
1702 elseif ($installType == 'drupal' && version_compare(VERSION
, '6.0') >= 0) {
1706 $output .= '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">';
1707 $output .= '<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">';
1708 $output .= '<head>';
1709 $output .= '<title>' . ts('CiviCRM Installed') . '</title>';
1710 $output .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
1711 $output .= '<link rel="stylesheet" type="text/css" href="template.css" />';
1712 $output .= '</head>';
1713 $output .= '<body>';
1714 $output .= '<div style="padding: 1em;"><p class="good">' . ts("CiviCRM has been successfully installed") . '</p>';
1717 $drupalURL = civicrm_cms_base();
1718 $drupalPermissionsURL = "{$drupalURL}index.php?q=admin/user/permissions";
1719 $drupalURL .= "index.php?q=civicrm/admin/configtask&reset=1";
1721 $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>";
1722 $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>";
1723 $output .= $commonOutputMessage;
1725 // explicitly setting error reporting, since we cannot handle drupal related notices
1728 // automatically enable CiviCRM module once it is installed successfully.
1729 // so we need to Bootstrap Drupal, so that we can call drupal hooks.
1730 global $cmsPath, $crmPath;
1732 // relative / abosolute paths are not working for drupal, hence using chdir()
1735 // Force the re-initialisation of the config singleton on the next call
1736 // since so far, we had used the Config object without loading the DB.
1737 $c = CRM_Core_Config
::singleton(FALSE);
1740 include_once "./includes/bootstrap.inc";
1741 drupal_bootstrap(DRUPAL_BOOTSTRAP_FULL
);
1743 // rebuild modules, so that civicrm is added
1744 module_rebuild_cache();
1746 // now enable civicrm module.
1747 module_enable(array('civicrm'));
1749 // clear block, page, theme, and hook caches
1750 drupal_flush_all_caches();
1752 //add basic drupal permissions
1753 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)');
1757 elseif ($installType == 'wordpress') {
1758 echo '<h1>' . ts('CiviCRM Installed') . '</h1>';
1759 echo '<div style="padding: 1em;"><p style="background-color: #0C0; border: 1px #070 solid; color: white;">' . ts("CiviCRM has been successfully installed") . '</p>';
1762 $cmsURL = civicrm_cms_base();
1763 $cmsURL .= "wp-admin/admin.php?page=CiviCRM&q=civicrm/admin/configtask&reset=1";
1764 $wpPermissionsURL = "wp-admin/admin.php?page=CiviCRM&q=civicrm/admin/access/wp-permissions&reset=1";
1766 $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>";
1767 $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>";
1768 $output .= $commonOutputMessage;
1771 $output .= '</div>';
1774 $c = CRM_Core_Config
::singleton(FALSE);
1776 $wpInstallRedirect = admin_url('admin.php?page=CiviCRM&q=civicrm&reset=1');
1778 window.location = '$wpInstallRedirect';
1783 return $this->errors
;
1788 function civicrm_install_set_drupal_perms() {
1789 if (!function_exists('db_select')) {
1790 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)');
1794 'access all custom data',
1795 'access uploaded files',
1796 'make online contributions',
1800 'register for events',
1802 'view event participants',
1803 'access CiviMail subscribe/unsubscribe pages',
1806 // Adding a permission that has not yet been assigned to a module by
1807 // a hook_permission implementation results in a database error.
1809 $allPerms = array_keys(module_invoke_all('permission'));
1810 foreach (array_diff($perms, $allPerms) as $perm) {
1812 'Cannot grant the %perm permission because it does not yet exist.',
1813 array('%perm' => $perm),
1817 $perms = array_intersect($perms, $allPerms);
1818 user_role_grant_permissions(DRUPAL_AUTHENTICATED_RID
, $perms);
1819 user_role_grant_permissions(DRUPAL_ANONYMOUS_RID
, $perms);
1823 function civicrm_install_set_backdrop_perms() {
1825 'access all custom data',
1826 'access uploaded files',
1827 'make online contributions',
1831 'register for events',
1833 'view event participants',
1834 'access CiviMail subscribe/unsubscribe pages',
1837 // Adding a permission that has not yet been assigned to a module by
1838 // a hook_permission implementation results in a database error.
1840 $allPerms = array_keys(module_invoke_all('permission'));
1841 foreach (array_diff($perms, $allPerms) as $perm) {
1843 'Cannot grant the %perm permission because it does not yet exist.',
1844 array('%perm' => $perm),
1848 $perms = array_intersect($perms, $allPerms);
1849 user_role_grant_permissions(BACKDROP_AUTHENTICATED_ROLE
, $perms);
1850 user_role_grant_permissions(BACKDROP_ANONYMOUS_ROLE
, $perms);
1859 function getSiteDir($cmsPath, $str) {
1860 static $siteDir = '';
1866 $sites = CIVICRM_DIRECTORY_SEPARATOR
. 'sites' . CIVICRM_DIRECTORY_SEPARATOR
;
1867 $modules = CIVICRM_DIRECTORY_SEPARATOR
. 'modules' . CIVICRM_DIRECTORY_SEPARATOR
;
1868 preg_match("/" . preg_quote($sites, CIVICRM_DIRECTORY_SEPARATOR
) .
1869 "([\-a-zA-Z0-9_.]+)" .
1870 preg_quote($modules, CIVICRM_DIRECTORY_SEPARATOR
) . "/",
1871 $_SERVER['SCRIPT_FILENAME'], $matches
1873 $siteDir = isset($matches[1]) ?
$matches[1] : 'default';
1875 if (strtolower($siteDir) == 'all') {
1876 // For this case - use drupal's way of finding out multi-site directory
1877 $uri = explode(CIVICRM_DIRECTORY_SEPARATOR
, $_SERVER['SCRIPT_FILENAME']);
1878 $server = explode('.', implode('.', array_reverse(explode(':', rtrim($_SERVER['HTTP_HOST'], '.')))));
1879 for ($i = count($uri) - 1; $i > 0; $i--) {
1880 for ($j = count($server); $j > 0; $j--) {
1881 $dir = implode('.', array_slice($server, -$j)) . implode('.', array_slice($uri, 0, $i));
1882 if (file_exists($cmsPath . CIVICRM_DIRECTORY_SEPARATOR
.
1883 'sites' . CIVICRM_DIRECTORY_SEPARATOR
. $dir
1890 $siteDir = 'default';
1897 * @param $errorTitle
1901 function errorDisplayPage($errorTitle, $errorMsg, $showRefer = TRUE) {
1903 // Add a link to the documentation
1905 if (is_callable(array('CRM_Utils_System', 'docURL2'))) {
1906 $docLink = CRM_Utils_System
::docURL2('Installation and Upgrades', FALSE, 'Installation Guide', NULL, NULL, "wiki");
1912 if (function_exists('ts')) {
1913 $errorMsg .= '<p>' . ts("Refer to the online documentation for more information: ") . $docLink . '</p>';
1916 $errorMsg .= '<p>' . 'Refer to the online documentation for more information: ' . $docLink . '</p>';
1920 include 'error.html';