3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2013
37 * Drupal specific stuff goes here
39 abstract class CRM_Utils_System_DrupalBase
extends CRM_Utils_System_Base
{
40 function __construct() {
41 $this->is_drupal
= TRUE;
42 $this->supports_form_extensions
= TRUE;
46 * @param string dir base civicrm directory
47 * Return default Site Settings
49 * - $url, (Joomla - non admin url)
53 function getDefaultSiteSettings($dir){
54 $config = CRM_Core_Config
::singleton();
55 $siteName = $siteRoot = NULL;
58 '|/sites/([\w\.\-\_]+)/|',
59 $config->templateCompileDir
,
62 $siteName = $matches[1];
64 $siteName = "/sites/$siteName/";
65 $siteNamePos = strpos($dir, $siteName);
66 if ($siteNamePos !== FALSE) {
67 $siteRoot = substr($dir, 0, $siteNamePos);
71 $url = $config->userFrameworkBaseURL
;
72 return array($url, $siteName, $siteRoot);
76 * Check if a resource url is within the drupal directory and format appropriately
78 * @param url (reference)
80 * @return bool: TRUE for internal paths, FALSE for external. The drupal_add_js fn is able to add js more
81 * efficiently if it is known to be in the drupal site
83 function formatResourceUrl(&$url) {
85 $base = CRM_Core_Config
::singleton()->resourceBase
;
87 // Handle absolute urls
88 // compares $url (which is some unknown/untrusted value from a third-party dev) to the CMS's base url (which is independent of civi's url)
89 // to see if the url is within our drupal dir, if it is we are able to treated it as an internal url
90 if (strpos($url, $base_url) === 0) {
92 $url = trim(str_replace($base_url, '', $url), '/');
94 // Handle relative urls that are within the CiviCRM module directory
95 elseif (strpos($url, $base) === 0) {
97 $url = $this->appendCoreDirectoryToResourceBase(substr(drupal_get_path('module', 'civicrm'), 0, -6)) . trim(substr($url, strlen($base)), '/');
100 $q = strpos($url, '?');
101 if ($q && $internal) {
102 $url = substr($url, 0, $q);
108 * In instance where civicrm folder has a drupal folder & a civicrm core folder @ the same level append the
109 * civicrm folder name to the url
110 * See CRM-13737 for discussion of how this allows implementers to alter the folder structure
111 * @todo - this only provides a limited amount of flexiblity - it still expects a 'civicrm' folder with a 'drupal' folder
112 * and is only flexible as to the name of the civicrm folder.
114 * @param string $url potential resource url based on standard folder assumptions
115 * @return string $url with civicrm-core directory appended if not standard civi dir
117 function appendCoreDirectoryToResourceBase($url) {
118 global $civicrm_root;
119 $lastDirectory = basename($civicrm_root);
120 if($lastDirectory != 'civicrm') {
121 return $url .= $lastDirectory . '/';
127 * Generate an internal CiviCRM URL (copied from DRUPAL/includes/common.inc#url)
129 * @param $path string The path being linked to, such as "civicrm/add"
130 * @param $query string A query string to append to the link.
131 * @param $absolute boolean Whether to force the output to be an absolute link (beginning with http:).
132 * Useful for links that will be displayed outside the site, such as in an
134 * @param $fragment string A fragment identifier (named anchor) to append to the link.
135 * @param $htmlize boolean whether to convert to html eqivalant
136 * @param $frontend boolean a gross joomla hack
137 * @param $forceBackend boolean a gross joomla hack
139 * @return string an HTML string containing a link to the given path.
143 function url($path = NULL, $query = NULL, $absolute = FALSE,
144 $fragment = NULL, $htmlize = TRUE,
145 $frontend = FALSE, $forceBackend = FALSE
147 $config = CRM_Core_Config
::singleton();
148 $script = 'index.php';
150 $path = CRM_Utils_String
::stripPathChars($path);
152 if (isset($fragment)) {
153 $fragment = '#' . $fragment;
156 if (!isset($config->useFrameworkRelativeBase
)) {
157 $base = parse_url($config->userFrameworkBaseURL
);
158 $config->useFrameworkRelativeBase
= $base['path'];
160 $base = $absolute ?
$config->userFrameworkBaseURL
: $config->useFrameworkRelativeBase
;
162 $separator = $htmlize ?
'&' : '&';
164 if (!$config->cleanURL
) {
167 return $base . $script . '?q=' . $path . $separator . $query . $fragment;
170 return $base . $script . '?q=' . $path . $fragment;
175 return $base . $script . '?' . $query . $fragment;
178 return $base . $fragment;
185 return $base . $path . '?' . $query . $fragment;
188 return $base . $path . $fragment;
193 return $base . $script . '?' . $query . $fragment;
196 return $base . $fragment;