CRM/Core/Config/Defaults.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2015
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class is a temporary place to store default setting values
  38  * before they will be distributed in proper places (component configurations
  39  * and core configuration). The name is intentionally stupid so that it will be fixed
  40  * ASAP.
  41  *
  42  */
  43 class CRM_Core_Config_Defaults {
  44
  45   public function setCoreVariables() {
  46     global $civicrm_root;
  47
  48     // set of base directories relying on $civicrm_root
  49     $this->smartyDir = $civicrm_root . DIRECTORY_SEPARATOR . 'packages' . DIRECTORY_SEPARATOR . 'Smarty' . DIRECTORY_SEPARATOR;
  50
  51     $this->pluginsDir = $civicrm_root . DIRECTORY_SEPARATOR . 'CRM' . DIRECTORY_SEPARATOR . 'Core' . DIRECTORY_SEPARATOR . 'Smarty' . DIRECTORY_SEPARATOR . 'plugins' . DIRECTORY_SEPARATOR;
  52
  53     $this->templateDir = array(
  54       $civicrm_root . DIRECTORY_SEPARATOR .
  55       'templates' . DIRECTORY_SEPARATOR,
  56     );
  57
  58     $this->sqlDir = $civicrm_root . DIRECTORY_SEPARATOR . 'sql' . DIRECTORY_SEPARATOR;
  59
  60     $this->importDataSourceDir = $civicrm_root . DIRECTORY_SEPARATOR . 'CRM' . DIRECTORY_SEPARATOR . 'Import' . DIRECTORY_SEPARATOR . 'DataSource' . DIRECTORY_SEPARATOR;
  61
  62     $this->gettextResourceDir = $civicrm_root . DIRECTORY_SEPARATOR . 'l10n' . DIRECTORY_SEPARATOR;
  63
  64     // show tree widget
  65     $this->groupTree = defined('CIVICRM_GROUPTREE') ? TRUE : FALSE;
  66
  67     // add UI revamp pages
  68     //$this->revampPages = array( 'CRM/Admin/Form/Setting/Url.tpl', 'CRM/Admin/Form/Preferences/Address.tpl' );
  69     $this->revampPages = array();
  70
  71     $size = trim(ini_get('upload_max_filesize'));
  72     if ($size) {
  73       $this->maxImportFileSize = self::formatUnitSize($size);
  74     }
  75   }
  76
  77   /**
  78    * Format size.
  79    *
  80    */
  81   public static function formatUnitSize($size, $checkForPostMax = FALSE) {
  82     if ($size) {
  83       $last = strtolower($size{strlen($size) - 1});
  84       switch ($last) {
  85         // The 'G' modifier is available since PHP 5.1.0
  86
  87         case 'g':
  88           $size *= 1024;
  89         case 'm':
  90           $size *= 1024;
  91         case 'k':
  92           $size *= 1024;
  93       }
  94
  95       if ($checkForPostMax) {
  96         $maxImportFileSize = self::formatUnitSize(ini_get('upload_max_filesize'));
  97         $postMaxSize = self::formatUnitSize(ini_get('post_max_size'));
  98         if ($maxImportFileSize > $postMaxSize && $postMaxSize == $size) {
  99           CRM_Core_Session::setStatus(ts("Note: Upload max filesize ('upload_max_filesize') should not exceed Post max size ('post_max_size') as defined in PHP.ini, please check with your system administrator."), ts("Warning"), "alert");
 100         }
 101         //respect php.ini upload_max_filesize
 102         if ($size > $maxImportFileSize && $size !== $postMaxSize) {
 103           $size = $maxImportFileSize;
 104           CRM_Core_Session::setStatus(ts("Note: Please verify your configuration for Maximum File Size (in MB) <a href='%1'>Administrator >> System Settings >> Misc</a>. It should support 'upload_max_size' as defined in PHP.ini.Please check with your system administrator.", array(1 => CRM_Utils_System::url('civicrm/admin/setting/misc', 'reset=1'))), ts("Warning"), "alert");
 105         }
 106       }
 107       return $size;
 108     }
 109   }
 110
 111   /**
 112    * Set the default values.
 113    * in an empty db, also called when setting component using GUI
 114    *
 115    * @param array $defaults
 116    *   Associated array of form elements.
 117    * @param bool $formMode
 118    *   this variable is set true for GUI
 119    *   mode (eg: Global setting >> Components)
 120    *
 121    */
 122   public static function setValues(&$defaults, $formMode = FALSE) {
 123     $config = CRM_Core_Config::singleton();
 124
 125     $baseURL = $config->userFrameworkBaseURL;
 126
 127     // CRM-6216: Drupal’s $baseURL might have a trailing LANGUAGE_NEGOTIATION_PATH,
 128     // which needs to be stripped before we start basing ResourceURL on it
 129     if ($config->userSystem->is_drupal) {
 130       global $language;
 131       if (isset($language->prefix) and $language->prefix) {
 132         if (substr($baseURL, -(strlen($language->prefix) + 1)) == $language->prefix . '/') {
 133           $baseURL = substr($baseURL, 0, -(strlen($language->prefix) + 1));
 134         }
 135       }
 136     }
 137
 138     $baseCMSURL = CRM_Utils_System::baseCMSURL();
 139     if ($config->templateCompileDir) {
 140       $path = CRM_Utils_File::baseFilePath($config->templateCompileDir);
 141     }
 142     if (!isset($defaults['enableSSL'])) {
 143       $defaults['enableSSL'] = 0;
 144     }
 145     //set defaults if not set in db
 146     if (!isset($defaults['userFrameworkResourceURL'])) {
 147       if ($config->userFramework == 'Joomla') {
 148         $defaults['userFrameworkResourceURL'] = $baseURL . "components/com_civicrm/civicrm/";
 149       }
 150       elseif ($config->userFramework == 'WordPress') {
 151         $defaults['userFrameworkResourceURL'] = $baseURL . "wp-content/plugins/civicrm/civicrm/";
 152       }
 153       else {
 154         // Drupal setting
 155         // check and see if we are installed in sites/all (for D5 and above)
 156         // we dont use checkURL since drupal generates an error page and throws
 157         // the system for a loop on lobo's macosx box
 158         // or in modules
 159         global $civicrm_root;
 160         $cmsPath = $config->userSystem->cmsRootPath();
 161         $defaults['userFrameworkResourceURL'] = $baseURL . str_replace("$cmsPath/", '',
 162             str_replace('\\', '/', $civicrm_root)
 163           );
 164
 165         if (strpos($civicrm_root,
 166             DIRECTORY_SEPARATOR . 'sites' .
 167             DIRECTORY_SEPARATOR . 'all' .
 168             DIRECTORY_SEPARATOR . 'modules'
 169           ) === FALSE
 170         ) {
 171           $startPos = strpos($civicrm_root,
 172             DIRECTORY_SEPARATOR . 'sites' . DIRECTORY_SEPARATOR
 173           );
 174           $endPos = strpos($civicrm_root,
 175             DIRECTORY_SEPARATOR . 'modules' . DIRECTORY_SEPARATOR
 176           );
 177           if ($startPos && $endPos) {
 178             // if component is in sites/SITENAME/modules
 179             $siteName = substr($civicrm_root,
 180               $startPos + 7,
 181               $endPos - $startPos - 7
 182             );
 183
 184             $civicrmDirName = trim(basename($civicrm_root));
 185             $defaults['userFrameworkResourceURL'] = $baseURL . "sites/$siteName/modules/$civicrmDirName/";
 186             if (!isset($defaults['imageUploadURL'])) {
 187               $defaults['imageUploadURL'] = $baseURL . "sites/$siteName/files/civicrm/persist/contribute/";
 188             }
 189           }
 190         }
 191       }
 192     }
 193
 194     if (!isset($defaults['imageUploadURL'])) {
 195       if ($config->userFramework == 'Joomla') {
 196         // gross hack
 197         // we need to remove the administrator/ from the end
 198         $tempURL = str_replace("/administrator/", "/", $baseURL);
 199         $defaults['imageUploadURL'] = $tempURL . "media/civicrm/persist/contribute/";
 200       }
 201       elseif ($config->userFramework == 'WordPress') {
 202         //for standalone no need of sites/defaults directory
 203         $defaults['imageUploadURL'] = $baseURL . "wp-content/plugins/files/civicrm/persist/contribute/";
 204       }
 205       else {
 206         $defaults['imageUploadURL'] = $baseURL . "sites/default/files/civicrm/persist/contribute/";
 207       }
 208     }
 209
 210     if (!isset($defaults['imageUploadDir']) && is_dir($config->templateCompileDir)) {
 211       $imgDir = $path . "persist/contribute/";
 212
 213       CRM_Utils_File::createDir($imgDir);
 214       $defaults['imageUploadDir'] = $imgDir;
 215     }
 216
 217     if (!isset($defaults['uploadDir']) && is_dir($config->templateCompileDir)) {
 218       $uploadDir = $path . "upload/";
 219
 220       CRM_Utils_File::createDir($uploadDir);
 221       CRM_Utils_File::restrictAccess($uploadDir);
 222       $defaults['uploadDir'] = $uploadDir;
 223     }
 224
 225     if (!isset($defaults['customFileUploadDir']) && is_dir($config->templateCompileDir)) {
 226       $customDir = $path . "custom/";
 227
 228       CRM_Utils_File::createDir($customDir);
 229       CRM_Utils_File::restrictAccess($customDir);
 230       $defaults['customFileUploadDir'] = $customDir;
 231     }
 232
 233     // FIXME: hack to bypass the step for generating defaults for components,
 234     // while running upgrade, to avoid any serious non-recoverable error
 235     // which might hinder the upgrade process.
 236     $args = array();
 237     if (isset($_GET[$config->userFrameworkURLVar])) {
 238       $args = explode('/', $_GET[$config->userFrameworkURLVar]);
 239     }
 240
 241     if (isset($defaults['enableComponents'])) {
 242       foreach ($defaults['enableComponents'] as $key => $name) {
 243         $comp = $config->componentRegistry->get($name);
 244         if ($comp) {
 245           $co = $comp->getConfigObject();
 246           $co->setDefaults($defaults);
 247         }
 248       }
 249     }
 250   }
 251
 252 }