Commit | Line | Data |
---|---|---|
9977c6f5 | 1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
06b69b18 | 4 | | CiviCRM version 4.5 | |
9977c6f5 | 5 | +--------------------------------------------------------------------+ |
06b69b18 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
9977c6f5 | 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 | |
06b69b18 | 31 | * @copyright CiviCRM LLC (c) 2004-2014 |
9977c6f5 | 32 | * $Id$ |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * Drupal specific stuff goes here | |
38 | */ | |
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; | |
43 | } | |
44 | ||
45 | /** | |
46 | * @param string dir base civicrm directory | |
47 | * Return default Site Settings | |
48 | * @return array array | |
49 | * - $url, (Joomla - non admin url) | |
50 | * - $siteName, | |
51 | * - $siteRoot | |
52 | */ | |
53 | function getDefaultSiteSettings($dir){ | |
54 | $config = CRM_Core_Config::singleton(); | |
55 | $siteName = $siteRoot = NULL; | |
56 | $matches = array(); | |
57 | if (preg_match( | |
58 | '|/sites/([\w\.\-\_]+)/|', | |
59 | $config->templateCompileDir, | |
60 | $matches | |
61 | )) { | |
62 | $siteName = $matches[1]; | |
63 | if ($siteName) { | |
64 | $siteName = "/sites/$siteName/"; | |
65 | $siteNamePos = strpos($dir, $siteName); | |
66 | if ($siteNamePos !== FALSE) { | |
67 | $siteRoot = substr($dir, 0, $siteNamePos); | |
68 | } | |
69 | } | |
70 | } | |
71 | $url = $config->userFrameworkBaseURL; | |
72 | return array($url, $siteName, $siteRoot); | |
73 | } | |
42e1a97c E |
74 | |
75 | /** | |
76 | * Check if a resource url is within the drupal directory and format appropriately | |
77 | * | |
78 | * @param url (reference) | |
79 | * | |
abfa8a7d EM |
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 | |
42e1a97c E |
82 | */ |
83 | function formatResourceUrl(&$url) { | |
84 | $internal = FALSE; | |
85 | $base = CRM_Core_Config::singleton()->resourceBase; | |
86 | global $base_url; | |
87 | // Handle absolute urls | |
abfa8a7d EM |
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 | |
42e1a97c E |
90 | if (strpos($url, $base_url) === 0) { |
91 | $internal = TRUE; | |
92 | $url = trim(str_replace($base_url, '', $url), '/'); | |
93 | } | |
abfa8a7d | 94 | // Handle relative urls that are within the CiviCRM module directory |
42e1a97c E |
95 | elseif (strpos($url, $base) === 0) { |
96 | $internal = TRUE; | |
168be77d | 97 | $url = $this->appendCoreDirectoryToResourceBase(substr(drupal_get_path('module', 'civicrm'), 0, -6)) . trim(substr($url, strlen($base)), '/'); |
42e1a97c E |
98 | } |
99 | // Strip query string | |
100 | $q = strpos($url, '?'); | |
101 | if ($q && $internal) { | |
102 | $url = substr($url, 0, $q); | |
103 | } | |
104 | return $internal; | |
105 | } | |
168be77d E |
106 | |
107 | /** | |
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. | |
113 | * | |
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 | |
116 | */ | |
117 | function appendCoreDirectoryToResourceBase($url) { | |
118 | global $civicrm_root; | |
2102546d | 119 | $lastDirectory = basename($civicrm_root); |
f4a6cab8 | 120 | if($lastDirectory != 'civicrm') { |
168be77d E |
121 | return $url .= $lastDirectory . '/'; |
122 | } | |
123 | return $url; | |
124 | } | |
72b140cf E |
125 | |
126 | /** | |
127 | * Generate an internal CiviCRM URL (copied from DRUPAL/includes/common.inc#url) | |
128 | * | |
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 | |
133 | * RSS feed. | |
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 | |
138 | * | |
139 | * @return string an HTML string containing a link to the given path. | |
140 | * @access public | |
141 | * | |
142 | */ | |
143 | function url($path = NULL, $query = NULL, $absolute = FALSE, | |
144 | $fragment = NULL, $htmlize = TRUE, | |
145 | $frontend = FALSE, $forceBackend = FALSE | |
146 | ) { | |
147 | $config = CRM_Core_Config::singleton(); | |
148 | $script = 'index.php'; | |
149 | ||
150 | $path = CRM_Utils_String::stripPathChars($path); | |
151 | ||
152 | if (isset($fragment)) { | |
153 | $fragment = '#' . $fragment; | |
154 | } | |
155 | ||
156 | if (!isset($config->useFrameworkRelativeBase)) { | |
157 | $base = parse_url($config->userFrameworkBaseURL); | |
158 | $config->useFrameworkRelativeBase = $base['path']; | |
159 | } | |
160 | $base = $absolute ? $config->userFrameworkBaseURL : $config->useFrameworkRelativeBase; | |
161 | ||
162 | $separator = $htmlize ? '&' : '&'; | |
163 | ||
164 | if (!$config->cleanURL) { | |
165 | if (isset($path)) { | |
166 | if (isset($query)) { | |
167 | return $base . $script . '?q=' . $path . $separator . $query . $fragment; | |
168 | } | |
169 | else { | |
170 | return $base . $script . '?q=' . $path . $fragment; | |
171 | } | |
172 | } | |
173 | else { | |
174 | if (isset($query)) { | |
175 | return $base . $script . '?' . $query . $fragment; | |
176 | } | |
177 | else { | |
178 | return $base . $fragment; | |
179 | } | |
180 | } | |
181 | } | |
182 | else { | |
183 | if (isset($path)) { | |
184 | if (isset($query)) { | |
185 | return $base . $path . '?' . $query . $fragment; | |
186 | } | |
187 | else { | |
188 | return $base . $path . $fragment; | |
189 | } | |
190 | } | |
191 | else { | |
192 | if (isset($query)) { | |
193 | return $base . $script . '?' . $query . $fragment; | |
194 | } | |
195 | else { | |
196 | return $base . $fragment; | |
197 | } | |
198 | } | |
199 | } | |
200 | } | |
32998c82 EM |
201 | |
202 | /** | |
203 | * Get User ID from UserFramework system (Drupal) | |
204 | * @param object $user object as described by the CMS | |
205 | * @return mixed <NULL, number> | |
206 | */ | |
207 | function getUserIDFromUserObject($user) { | |
208 | return !empty($user->uid) ? $user->uid : NULL; | |
209 | } | |
2b617cb0 EM |
210 | |
211 | /** | |
212 | * Get Unique Identifier from UserFramework system (CMS) | |
213 | * @param object $user object as described by the User Framework | |
214 | * @return mixed $uniqueIdentifer Unique identifier from the user Framework system | |
215 | * | |
216 | */ | |
217 | function getUniqueIdentifierFromUserObject($user) { | |
218 | return empty($user->mail) ? NULL : $user->mail; | |
219 | } | |
220 | ||
221 | /** | |
222 | * Get currently logged in user unique identifier - this tends to be the email address or user name. | |
223 | * | |
224 | * @return string $userID logged in user unique identifier | |
225 | */ | |
226 | function getLoggedInUniqueIdentifier() { | |
227 | global $user; | |
228 | return $this->getUniqueIdentifierFromUserObject($user); | |
229 | } | |
d0ffa3e4 EM |
230 | |
231 | /** | |
232 | * Action to take when access is not permitted | |
233 | */ | |
234 | function permissionDenied() { | |
235 | drupal_access_denied(); | |
236 | } | |
232624b1 | 237 | } |