install/civicrm.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This code is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  * @param $filesDirectory
  17  */
  18 function civicrm_setup($filesDirectory) {
  19   global $crmPath, $sqlPath, $pkgPath, $tplPath;
  20   global $compileDir;
  21
  22   // Setup classloader
  23   // This is needed to allow CiviCRM to be installed by drush.
  24   // TODO: move to civicrm.drush.inc drush_civicrm_install()
  25   global $crmPath;
  26   require_once $crmPath . '/CRM/Core/ClassLoader.php';
  27   CRM_Core_ClassLoader::singleton()->register();
  28
  29   $sqlPath = $crmPath . DIRECTORY_SEPARATOR . 'sql';
  30   $tplPath = $crmPath . DIRECTORY_SEPARATOR . 'templates' . DIRECTORY_SEPARATOR . 'CRM' . DIRECTORY_SEPARATOR . 'common' . DIRECTORY_SEPARATOR;
  31
  32   if (!is_dir($filesDirectory)) {
  33     mkdir($filesDirectory, 0777);
  34     chmod($filesDirectory, 0777);
  35   }
  36
  37   $scratchDir = $filesDirectory . DIRECTORY_SEPARATOR . 'civicrm';
  38   if (!is_dir($scratchDir)) {
  39     mkdir($scratchDir, 0777);
  40   }
  41
  42   $compileDir = $scratchDir . DIRECTORY_SEPARATOR . 'templates_c' . DIRECTORY_SEPARATOR;
  43   if (!is_dir($compileDir)) {
  44     mkdir($compileDir, 0777);
  45   }
  46   $compileDir = addslashes($compileDir);
  47 }
  48
  49 /**
  50  * @param string $name
  51  * @param $buffer
  52  */
  53 function civicrm_write_file($name, &$buffer) {
  54   $fd = fopen($name, "w");
  55   if (!$fd) {
  56     die("Cannot open $name");
  57   }
  58   fwrite($fd, $buffer);
  59   fclose($fd);
  60 }
  61
  62 /**
  63  * @param $config
  64  */
  65 function civicrm_main(&$config) {
  66   global $sqlPath, $crmPath, $cmsPath, $installType;
  67
  68   if ($installType == 'drupal') {
  69     $siteDir = $config['site_dir'] ?? getSiteDir($cmsPath, $_SERVER['SCRIPT_FILENAME']);
  70     civicrm_setup($cmsPath . DIRECTORY_SEPARATOR . 'sites' . DIRECTORY_SEPARATOR . $siteDir . DIRECTORY_SEPARATOR . 'files'
  71     );
  72   }
  73   elseif ($installType == 'backdrop') {
  74     civicrm_setup($cmsPath . DIRECTORY_SEPARATOR . 'files');
  75   }
  76   elseif ($installType == 'wordpress') {
  77     $upload_dir = wp_upload_dir();
  78     $files_dirname = $upload_dir['basedir'];
  79     civicrm_setup($files_dirname);
  80   }
  81
  82   $parts = explode(':', $config['mysql']['server']);
  83   if (empty($parts[1])) {
  84     $parts[1] = 3306;
  85   }
  86   $config['mysql']['server'] = implode(':', $parts);
  87
  88   $dsn = "mysql://{$config['mysql']['username']}:{$config['mysql']['password']}@{$config['mysql']['server']}/{$config['mysql']['database']}?new_link=true";
  89   civicrm_source($dsn, $sqlPath . DIRECTORY_SEPARATOR . 'civicrm.mysql');
  90
  91   if (!empty($config['loadGenerated'])) {
  92     civicrm_source($dsn, $sqlPath . DIRECTORY_SEPARATOR . 'civicrm_generated.mysql', TRUE);
  93   }
  94   else {
  95     if (isset($config['seedLanguage'])
  96       and preg_match('/^[a-z][a-z]_[A-Z][A-Z]$/', $config['seedLanguage'])
  97       and file_exists($sqlPath . DIRECTORY_SEPARATOR . "civicrm_data.{$config['seedLanguage']}.mysql")
  98       and file_exists($sqlPath . DIRECTORY_SEPARATOR . "civicrm_acl.{$config['seedLanguage']}.mysql")
  99     ) {
 100       civicrm_source($dsn, $sqlPath . DIRECTORY_SEPARATOR . "civicrm_data.{$config['seedLanguage']}.mysql");
 101       civicrm_source($dsn, $sqlPath . DIRECTORY_SEPARATOR . "civicrm_acl.{$config['seedLanguage']}.mysql");
 102     }
 103     else {
 104       civicrm_source($dsn, $sqlPath . DIRECTORY_SEPARATOR . 'civicrm_data.mysql');
 105       civicrm_source($dsn, $sqlPath . DIRECTORY_SEPARATOR . 'civicrm_acl.mysql');
 106     }
 107   }
 108
 109   // generate backend settings file
 110   if ($installType == 'drupal') {
 111     $configFile = $cmsPath . DIRECTORY_SEPARATOR . 'sites' . DIRECTORY_SEPARATOR . $siteDir . DIRECTORY_SEPARATOR . 'civicrm.settings.php';
 112   }
 113   elseif ($installType == 'backdrop') {
 114     $configFile = $cmsPath . DIRECTORY_SEPARATOR . 'civicrm.settings.php';
 115   }
 116   elseif ($installType == 'wordpress') {
 117     $configFile = $files_dirname . DIRECTORY_SEPARATOR . 'civicrm' . DIRECTORY_SEPARATOR . 'civicrm.settings.php';
 118   }
 119
 120   $string = civicrm_config($config);
 121   civicrm_write_file($configFile,
 122     $string
 123   );
 124 }
 125
 126 /**
 127  * @param $dsn
 128  * @param string $fileName
 129  * @param bool $lineMode
 130  */
 131 function civicrm_source($dsn, $fileName, $lineMode = FALSE) {
 132   global $crmPath;
 133
 134   // CRM-19699 See also CRM_Core_DAO for PHP7 mysqli compatiblity.
 135   // Duplicated here because this is not using CRM_Core_DAO directly
 136   // and this function may be called directly from Drush.
 137   if (!defined('DB_DSN_MODE')) {
 138     define('DB_DSN_MODE', 'auto');
 139   }
 140
 141   $db = DB::connect($dsn);
 142   if (PEAR::isError($db)) {
 143     die("Cannot open $dsn: " . $db->getMessage());
 144   }
 145   $db->query('SET NAMES utf8mb4');
 146
 147   if (!$lineMode) {
 148     $string = file_get_contents($fileName);
 149
 150     // change \r\n to fix windows issues
 151     $string = str_replace("\r\n", "\n", $string);
 152
 153     //get rid of comments starting with # and --
 154
 155     $string = preg_replace("/^#[^\n]*$/m", "\n", $string);
 156     $string = preg_replace("/^(--[^-]).*/m", "\n", $string);
 157
 158     $queries = preg_split('/;\s*$/m', $string);
 159     foreach ($queries as $query) {
 160       $query = trim($query);
 161       if (!empty($query)) {
 162         $res = &$db->query($query);
 163         if (PEAR::isError($res)) {
 164           print_r($res);
 165           die("Cannot execute $query: " . $res->getMessage());
 166         }
 167       }
 168     }
 169   }
 170   else {
 171     $fd = fopen($fileName, "r");
 172     while ($string = fgets($fd)) {
 173       $string = preg_replace("/^#[^\n]*$/m", "\n", $string);
 174       $string = preg_replace("/^(--[^-]).*/m", "\n", $string);
 175
 176       $string = trim($string);
 177       if (!empty($string)) {
 178         $res = &$db->query($string);
 179         if (PEAR::isError($res)) {
 180           die("Cannot execute $string: " . $res->getMessage());
 181         }
 182       }
 183     }
 184   }
 185 }
 186
 187 /**
 188  * @param $config
 189  *
 190  * @return string
 191  */
 192 function civicrm_config(&$config) {
 193   global $crmPath, $comPath;
 194   global $compileDir;
 195   global $tplPath, $installType;
 196
 197   // Ex: $extraSettings[] = '$civicrm_settings["domain"]["foo"] = "bar";';
 198   $extraSettings = [];
 199
 200   $params = array(
 201     'crmRoot' => $crmPath,
 202     'templateCompileDir' => $compileDir,
 203     'frontEnd' => 0,
 204     'dbUser' => addslashes($config['mysql']['username']),
 205     'dbPass' => addslashes($config['mysql']['password']),
 206     'dbHost' => $config['mysql']['server'],
 207     'dbName' => addslashes($config['mysql']['database']),
 208   );
 209
 210   $params['baseURL'] = $config['base_url'] ?? civicrm_cms_base();
 211   if ($installType == 'drupal' && defined('VERSION')) {
 212     if (version_compare(VERSION, '8.0') >= 0) {
 213       $params['cms'] = 'Drupal';
 214       $params['CMSdbUser'] = addslashes($config['drupal']['username']);
 215       $params['CMSdbPass'] = addslashes($config['drupal']['password']);
 216       $params['CMSdbHost'] = $config['drupal']['host'] . ":" . !empty($config['drupal']['port']) ? $config['drupal']['port'] : "3306";
 217       $params['CMSdbName'] = addslashes($config['drupal']['database']);
 218     }
 219     elseif (version_compare(VERSION, '7.0-rc1') >= 0) {
 220       $params['cms'] = 'Drupal';
 221       $params['CMSdbUser'] = addslashes($config['drupal']['username']);
 222       $params['CMSdbPass'] = addslashes($config['drupal']['password']);
 223       $params['CMSdbHost'] = $config['drupal']['server'];
 224       $params['CMSdbName'] = addslashes($config['drupal']['database']);
 225     }
 226     elseif (version_compare(VERSION, '6.0') >= 0) {
 227       $params['cms'] = 'Drupal6';
 228       $params['CMSdbUser'] = addslashes($config['drupal']['username']);
 229       $params['CMSdbPass'] = addslashes($config['drupal']['password']);
 230       $params['CMSdbHost'] = $config['drupal']['server'];
 231       $params['CMSdbName'] = addslashes($config['drupal']['database']);
 232     }
 233   }
 234   elseif ($installType == 'drupal') {
 235     $params['cms'] = $config['cms'];
 236     $params['CMSdbUser'] = addslashes($config['cmsdb']['username']);
 237     $params['CMSdbPass'] = addslashes($config['cmsdb']['password']);
 238     $params['CMSdbHost'] = $config['cmsdb']['server'];
 239     $params['CMSdbName'] = addslashes($config['cmsdb']['database']);
 240   }
 241   elseif ($installType == 'backdrop') {
 242     $params['cms'] = 'Backdrop';
 243     $params['CMSdbUser'] = addslashes($config['backdrop']['username']);
 244     $params['CMSdbPass'] = addslashes($config['backdrop']['password']);
 245     $params['CMSdbHost'] = $config['backdrop']['server'];
 246     $params['CMSdbName'] = addslashes($config['backdrop']['database']);
 247   }
 248   else {
 249     $params['cms'] = 'WordPress';
 250     $params['CMSdbUser'] = addslashes(DB_USER);
 251     $params['CMSdbPass'] = addslashes(DB_PASSWORD);
 252     $params['CMSdbHost'] = DB_HOST;
 253     $params['CMSdbName'] = addslashes(DB_NAME);
 254
 255     // CRM-12386
 256     $params['crmRoot'] = addslashes($params['crmRoot']);
 257     //CRM-16421
 258
 259     $extraSettings[] = sprintf('$civicrm_paths[\'wp.frontend.base\'][\'url\'] = %s;', var_export(home_url() . '/', 1));
 260     $extraSettings[] = sprintf('$civicrm_paths[\'wp.backend.base\'][\'url\'] = %s;', var_export(admin_url(), 1));
 261     $extraSettings[] = sprintf('$civicrm_setting[\'URL Preferences\'][\'userFrameworkResourceURL\'] = %s;', var_export(plugin_dir_url(CIVICRM_PLUGIN_FILE) . 'civicrm', 1));
 262   }
 263
 264   if ($extraSettings) {
 265     $params['extraSettings'] = "Additional settings generated by installer:\n" . implode("\n", $extraSettings);
 266   }
 267   else {
 268     $params['extraSettings'] = "";
 269   }
 270
 271   $params['siteKey'] = md5(rand() . mt_rand() . rand() . uniqid('', TRUE) . $params['baseURL']);
 272   // Would prefer openssl_random_pseudo_bytes(), but I don't think it's universally available.
 273
 274   $str = file_get_contents($tplPath . 'civicrm.settings.php.template');
 275   foreach ($params as $key => $value) {
 276     $str = str_replace('%%' . $key . '%%', $value, $str);
 277   }
 278   return trim($str);
 279 }
 280
 281 /**
 282  * @return string
 283  */
 284 function civicrm_cms_base() {
 285   global $installType;
 286
 287   // for drupal
 288   $numPrevious = 6;
 289
 290   if (isset($_SERVER['HTTPS']) &&
 291     !empty($_SERVER['HTTPS']) &&
 292     strtolower($_SERVER['HTTPS']) != 'off'
 293   ) {
 294     $url = 'https://' . $_SERVER['HTTP_HOST'];
 295   }
 296   else {
 297     $url = 'http://' . $_SERVER['HTTP_HOST'];
 298   }
 299
 300   $baseURL = $_SERVER['SCRIPT_NAME'];
 301
 302   if ($installType == 'drupal' || $installType == 'backdrop') {
 303     //don't assume 6 dir levels, as civicrm
 304     //may or may not be in sites/all/modules/
 305     //lets allow to install in custom dir. CRM-6840
 306     global $cmsPath;
 307     $crmDirLevels = str_replace($cmsPath, '', str_replace('\\', '/', $_SERVER['SCRIPT_FILENAME']));
 308     $baseURL = str_replace($crmDirLevels, '', str_replace('\\', '/', $baseURL));
 309   }
 310   elseif ($installType == 'wordpress') {
 311     $baseURL = str_replace($url, '', site_url());
 312   }
 313   else {
 314     for ($i = 1; $i <= $numPrevious; $i++) {
 315       $baseURL = dirname($baseURL);
 316     }
 317   }
 318
 319   // remove the last directory separator string from the directory
 320   if (substr($baseURL, -1, 1) == DIRECTORY_SEPARATOR) {
 321     $baseURL = substr($baseURL, 0, -1);
 322   }
 323
 324   // also convert all DIRECTORY_SEPARATOR to the forward slash for windoze
 325   $baseURL = str_replace(DIRECTORY_SEPARATOR, '/', $baseURL);
 326
 327   if ($baseURL != '/') {
 328     $baseURL .= '/';
 329   }
 330
 331   return $url . $baseURL;
 332 }
 333
 334 /**
 335  * @return string
 336  */
 337 function civicrm_home_url() {
 338   $drupalURL = civicrm_cms_base();
 339   return $drupalURL . 'index.php?q=civicrm';
 340 }