phpcs - Fix error, "Expected 1 newline at end of file; XXX found".

[civicrm-core.git] / CRM / Core / Config / Defaults.php

<?php
/*
 +--------------------------------------------------------------------+
 | CiviCRM version 4.6                                                |
 +--------------------------------------------------------------------+
 | Copyright CiviCRM LLC (c) 2004-2014                                |
 +--------------------------------------------------------------------+
 | This file is a part of CiviCRM.                                    |
 |                                                                    |
 | CiviCRM is free software; you can copy, modify, and distribute it  |
 | under the terms of the GNU Affero General Public License           |
 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
 |                                                                    |
 | CiviCRM is distributed in the hope that it will be useful, but     |
 | WITHOUT ANY WARRANTY; without even the implied warranty of         |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
 | See the GNU Affero General Public License for more details.        |
 |                                                                    |
 | You should have received a copy of the GNU Affero General Public   |
 | License and the CiviCRM Licensing Exception along                  |
 | with this program; if not, contact CiviCRM LLC                     |
 | at info[AT]civicrm[DOT]org. If you have questions about the        |
 | GNU Affero General Public License or the licensing of CiviCRM,     |
 | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
 +--------------------------------------------------------------------+
*/

/**
 *
 * @package CRM
 * @copyright CiviCRM LLC (c) 2004-2014
 * $Id$
 *
 */

/**
 * This class is a temporary place to store default setting values
 * before they will be distributed in proper places (component configurations
 * and core configuration). The name is intentionally stupid so that it will be fixed
 * ASAP.
 *
 */
class CRM_Core_Config_Defaults {

  public function setCoreVariables() {
    global $civicrm_root;

    // set of base directories relying on $civicrm_root
    $this->smartyDir = $civicrm_root . DIRECTORY_SEPARATOR . 'packages' . DIRECTORY_SEPARATOR . 'Smarty' . DIRECTORY_SEPARATOR;

    $this->pluginsDir = $civicrm_root . DIRECTORY_SEPARATOR . 'CRM' . DIRECTORY_SEPARATOR . 'Core' . DIRECTORY_SEPARATOR . 'Smarty' . DIRECTORY_SEPARATOR . 'plugins' . DIRECTORY_SEPARATOR;

    $this->templateDir = array(
      $civicrm_root . DIRECTORY_SEPARATOR .
      'templates' . DIRECTORY_SEPARATOR,
    );

    $this->sqlDir = $civicrm_root . DIRECTORY_SEPARATOR . 'sql' . DIRECTORY_SEPARATOR;

    $this->importDataSourceDir = $civicrm_root . DIRECTORY_SEPARATOR . 'CRM' . DIRECTORY_SEPARATOR . 'Import' . DIRECTORY_SEPARATOR . 'DataSource' . DIRECTORY_SEPARATOR;

    $this->gettextResourceDir = $civicrm_root . DIRECTORY_SEPARATOR . 'l10n' . DIRECTORY_SEPARATOR;

    // show tree widget
    $this->groupTree = defined('CIVICRM_GROUPTREE') ? TRUE : FALSE;

    // add UI revamp pages
    //$this->revampPages = array( 'CRM/Admin/Form/Setting/Url.tpl', 'CRM/Admin/Form/Preferences/Address.tpl' );
    $this->revampPages = array();

    $size = trim(ini_get('upload_max_filesize'));
    if ($size) {
      $this->maxImportFileSize = self::formatUnitSize($size);
    }
  }

  /**
   * Format size
   *
   * @static
   */

  public static function formatUnitSize($size, $checkForPostMax = FALSE) {
    if ($size) {
      $last = strtolower($size{strlen($size) - 1});
      switch ($last) {
        // The 'G' modifier is available since PHP 5.1.0

        case 'g':
          $size *= 1024;
        case 'm':
          $size *= 1024;
        case 'k':
          $size *= 1024;
      }

      if ($checkForPostMax) {
        $config     = CRM_Core_Config::singleton();
        if($config->maxImportFileSize > $size) {
          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");
        }
      }
      return $size;
    }
  }

  /**
   * Set the default values
   *
   * @param array $defaults associated array of form elements
   * @param bool|\boolena $formMode this funtion is called to set default
   *                           values in an empty db, also called when setting component using GUI
   *                           this variable is set true for GUI
   *                           mode (eg: Global setting >> Components)
   *
   * @static
   */
  public static function setValues(&$defaults, $formMode = FALSE) {
    $config = CRM_Core_Config::singleton();

    $baseURL = $config->userFrameworkBaseURL;

    // CRM-6216: Drupal’s $baseURL might have a trailing LANGUAGE_NEGOTIATION_PATH,
    // which needs to be stripped before we start basing ResourceURL on it
    if ($config->userSystem->is_drupal) {
      global $language;
      if (isset($language->prefix) and $language->prefix) {
        if (substr($baseURL, -(strlen($language->prefix) + 1)) == $language->prefix . '/') {
          $baseURL = substr($baseURL, 0, -(strlen($language->prefix) + 1));
        }
      }
    }

    $baseCMSURL = CRM_Utils_System::baseCMSURL();
    if ($config->templateCompileDir) {
      $path = CRM_Utils_File::baseFilePath($config->templateCompileDir);
    }
    if (!isset($defaults['enableSSL'])) {
      $defaults['enableSSL'] = 0;
    }
    //set defaults if not set in db
    if (!isset($defaults['userFrameworkResourceURL'])) {
      if ($config->userFramework == 'Joomla') {
        $defaults['userFrameworkResourceURL'] = $baseURL . "components/com_civicrm/civicrm/";
      }
      elseif ($config->userFramework == 'WordPress') {
        $defaults['userFrameworkResourceURL'] = $baseURL . "wp-content/plugins/civicrm/civicrm/";
      }
      else {
        // Drupal setting
        // check and see if we are installed in sites/all (for D5 and above)
        // we dont use checkURL since drupal generates an error page and throws
        // the system for a loop on lobo's macosx box
        // or in modules
        global $civicrm_root;
        $cmsPath = $config->userSystem->cmsRootPath();
        $defaults['userFrameworkResourceURL'] = $baseURL . str_replace("$cmsPath/", '',
          str_replace('\\', '/', $civicrm_root)
        );

        if (strpos($civicrm_root,
            DIRECTORY_SEPARATOR . 'sites' .
            DIRECTORY_SEPARATOR . 'all' .
            DIRECTORY_SEPARATOR . 'modules'
          ) === FALSE) {
          $startPos = strpos($civicrm_root,
            DIRECTORY_SEPARATOR . 'sites' . DIRECTORY_SEPARATOR
          );
          $endPos = strpos($civicrm_root,
            DIRECTORY_SEPARATOR . 'modules' . DIRECTORY_SEPARATOR
          );
          if ($startPos && $endPos) {
            // if component is in sites/SITENAME/modules
            $siteName = substr($civicrm_root,
              $startPos + 7,
              $endPos - $startPos - 7
            );

            $civicrmDirName = trim(basename($civicrm_root));
            $defaults['userFrameworkResourceURL'] = $baseURL . "sites/$siteName/modules/$civicrmDirName/";
            if (!isset($defaults['imageUploadURL'])) {
              $defaults['imageUploadURL'] = $baseURL . "sites/$siteName/files/civicrm/persist/contribute/";
            }
          }
        }
      }
    }

    if (!isset($defaults['imageUploadURL'])) {
      if ($config->userFramework == 'Joomla') {
        // gross hack
        // we need to remove the administrator/ from the end
        $tempURL = str_replace("/administrator/", "/", $baseURL);
        $defaults['imageUploadURL'] = $tempURL . "media/civicrm/persist/contribute/";
      }
      elseif ($config->userFramework == 'WordPress') {
        //for standalone no need of sites/defaults directory
        $defaults['imageUploadURL'] = $baseURL . "wp-content/plugins/files/civicrm/persist/contribute/";
      }
      else {
        $defaults['imageUploadURL'] = $baseURL . "sites/default/files/civicrm/persist/contribute/";
      }
    }

    if (!isset($defaults['imageUploadDir']) && is_dir($config->templateCompileDir)) {
      $imgDir = $path . "persist/contribute/";

      CRM_Utils_File::createDir($imgDir);
      $defaults['imageUploadDir'] = $imgDir;
    }

    if (!isset($defaults['uploadDir']) && is_dir($config->templateCompileDir)) {
      $uploadDir = $path . "upload/";

      CRM_Utils_File::createDir($uploadDir);
      CRM_Utils_File::restrictAccess($uploadDir);
      $defaults['uploadDir'] = $uploadDir;
    }

    if (!isset($defaults['customFileUploadDir']) && is_dir($config->templateCompileDir)) {
      $customDir = $path . "custom/";

      CRM_Utils_File::createDir($customDir);
      CRM_Utils_File::restrictAccess($customDir);
      $defaults['customFileUploadDir'] = $customDir;
    }

    /* FIXME: hack to bypass the step for generating defaults for components,
                  while running upgrade, to avoid any serious non-recoverable error
                  which might hinder the upgrade process. */


    $args = array();
    if (isset($_GET[$config->userFrameworkURLVar])) {
      $args = explode('/', $_GET[$config->userFrameworkURLVar]);
    }

    if (isset($defaults['enableComponents'])) {
      foreach ($defaults['enableComponents'] as $key => $name) {
        $comp = $config->componentRegistry->get($name);
        if ($comp) {
          $co = $comp->getConfigObject();
          $co->setDefaults($defaults);
        }
      }
    }
  }
}