Commit | Line | Data |
---|---|---|
e3d28c74 TO |
1 | <?php |
2 | namespace Civi\Core; | |
3 | ||
4 | /** | |
5 | * Class Paths | |
6 | * @package Civi\Core | |
7 | * | |
8 | * This paths class translates path-expressions into local file paths and | |
9 | * URLs. Path-expressions may take a few forms: | |
10 | * | |
11 | * - Paths and URLs may use a variable prefix. For example, '[civicrm.files]/upload' | |
12 | * - Paths and URLS may be absolute. | |
13 | * - Paths may be relative (base dir: [civicrm.files]). | |
14 | * - URLs may be relative (base dir: [cms.root]). | |
15 | */ | |
16 | class Paths { | |
17 | ||
18 | const DEFAULT_URL = 'cms.root'; | |
19 | const DEFAULT_PATH = 'civicrm.files'; | |
20 | ||
21 | /** | |
22 | * @var array | |
23 | * Array(string $name => array(url => $, path => $)). | |
24 | */ | |
c64f69d9 | 25 | private $variables = []; |
e3d28c74 | 26 | |
c64f69d9 | 27 | private $variableFactory = []; |
e3d28c74 | 28 | |
e8e8f3ad | 29 | /** |
30 | * Class constructor. | |
31 | */ | |
e3d28c74 | 32 | public function __construct() { |
f553d1ea | 33 | $paths = $this; |
e3d28c74 | 34 | $this |
e3d28c74 TO |
35 | ->register('civicrm.root', function () { |
36 | return \CRM_Core_Config::singleton()->userSystem->getCiviSourceStorage(); | |
37 | }) | |
2f4b426c | 38 | ->register('civicrm.packages', function () { |
c64f69d9 | 39 | return [ |
2f4b426c TO |
40 | 'path' => \Civi::paths()->getPath('[civicrm.root]/packages/'), |
41 | 'url' => \Civi::paths()->getUrl('[civicrm.root]/packages/'), | |
c64f69d9 | 42 | ]; |
2f4b426c TO |
43 | }) |
44 | ->register('civicrm.vendor', function () { | |
c64f69d9 | 45 | return [ |
2f4b426c TO |
46 | 'path' => \Civi::paths()->getPath('[civicrm.root]/vendor/'), |
47 | 'url' => \Civi::paths()->getUrl('[civicrm.root]/vendor/'), | |
c64f69d9 | 48 | ]; |
2f4b426c TO |
49 | }) |
50 | ->register('civicrm.bower', function () { | |
c64f69d9 | 51 | return [ |
2f4b426c TO |
52 | 'path' => \Civi::paths()->getPath('[civicrm.root]/bower_components/'), |
53 | 'url' => \Civi::paths()->getUrl('[civicrm.root]/bower_components/'), | |
c64f69d9 | 54 | ]; |
2f4b426c | 55 | }) |
e3d28c74 TO |
56 | ->register('civicrm.files', function () { |
57 | return \CRM_Core_Config::singleton()->userSystem->getDefaultFileStorage(); | |
58 | }) | |
86a36a73 | 59 | ->register('civicrm.private', function () { |
0bd3f65c TO |
60 | return [ |
61 | // For backward compatibility with existing deployments, this | |
62 | // effectively returns `dirname(CIVICRM_TEMPLATE_COMPILEDIR)`. | |
63 | // That's confusing. Future installers should probably set `civicrm.private` | |
64 | // explicitly instead of setting `CIVICRM_TEMPLATE_COMPILEDIR`. | |
65 | 'path' => \CRM_Utils_File::baseFilePath(), | |
66 | ]; | |
67 | }) | |
68 | ->register('civicrm.log', function () { | |
69 | return [ | |
70 | 'path' => \Civi::paths()->getPath('[civicrm.private]/ConfigAndLog'), | |
71 | ]; | |
72 | }) | |
73 | ->register('civicrm.compile', function () { | |
74 | return [ | |
75 | // These two formulations are equivalent in typical deployments; however, | |
76 | // for existing systems which previously customized CIVICRM_TEMPLATE_COMPILEDIR, | |
77 | // using the constant should be more backward-compatibility. | |
78 | 'path' => defined('CIVICRM_TEMPLATE_COMPILEDIR') ? CIVICRM_TEMPLATE_COMPILEDIR : \Civi::paths()->getPath('[civicrm.private]/templates_c'), | |
79 | ]; | |
86a36a73 | 80 | }) |
1b94154b EE |
81 | ->register('civicrm.l10n', function () { |
82 | $dir = defined('CIVICRM_L10N_BASEDIR') ? CIVICRM_L10N_BASEDIR : \Civi::paths()->getPath('[civicrm.private]/l10n'); | |
83 | return [ | |
84 | 'path' => is_dir($dir) ? $dir : \Civi::paths()->getPath('[civicrm.root]/l10n'), | |
85 | ]; | |
86 | }) | |
f553d1ea | 87 | ->register('wp.frontend.base', function () { |
c64f69d9 | 88 | return ['url' => rtrim(CIVICRM_UF_BASEURL, '/') . '/']; |
f553d1ea KC |
89 | }) |
90 | ->register('wp.frontend', function () use ($paths) { | |
91 | $config = \CRM_Core_Config::singleton(); | |
92 | $suffix = defined('CIVICRM_UF_WP_BASEPAGE') ? CIVICRM_UF_WP_BASEPAGE : $config->wpBasePage; | |
c64f69d9 | 93 | return [ |
f553d1ea | 94 | 'url' => $paths->getVariable('wp.frontend.base', 'url') . $suffix, |
c64f69d9 | 95 | ]; |
f553d1ea KC |
96 | }) |
97 | ->register('wp.backend.base', function () { | |
c64f69d9 | 98 | return ['url' => rtrim(CIVICRM_UF_BASEURL, '/') . '/wp-admin/']; |
f553d1ea KC |
99 | }) |
100 | ->register('wp.backend', function () use ($paths) { | |
c64f69d9 | 101 | return [ |
f553d1ea | 102 | 'url' => $paths->getVariable('wp.backend.base', 'url') . 'admin.php', |
c64f69d9 | 103 | ]; |
f553d1ea | 104 | }) |
e3d28c74 | 105 | ->register('cms', function () { |
c64f69d9 | 106 | return [ |
e3d28c74 TO |
107 | 'path' => \CRM_Core_Config::singleton()->userSystem->cmsRootPath(), |
108 | 'url' => \CRM_Utils_System::baseCMSURL(), | |
c64f69d9 | 109 | ]; |
e3d28c74 TO |
110 | }) |
111 | ->register('cms.root', function () { | |
c64f69d9 | 112 | return [ |
e3d28c74 TO |
113 | 'path' => \CRM_Core_Config::singleton()->userSystem->cmsRootPath(), |
114 | // Misleading: this *removes* the language part of the URL, producing a pristine base URL. | |
115 | 'url' => \CRM_Utils_System::languageNegotiationURL(\CRM_Utils_System::baseCMSURL(), FALSE, TRUE), | |
c64f69d9 | 116 | ]; |
e3d28c74 TO |
117 | }); |
118 | } | |
119 | ||
120 | /** | |
121 | * Register a new URL/file path mapping. | |
122 | * | |
123 | * @param string $name | |
b698e2d5 | 124 | * The name of the variable. |
e3d28c74 TO |
125 | * @param callable $factory |
126 | * Function which returns an array with keys: | |
127 | * - path: string. | |
128 | * - url: string. | |
4b350175 | 129 | * @return Paths |
e3d28c74 TO |
130 | */ |
131 | public function register($name, $factory) { | |
b698e2d5 | 132 | $this->variableFactory[$name] = $factory; |
e3d28c74 TO |
133 | return $this; |
134 | } | |
135 | ||
b698e2d5 TO |
136 | /** |
137 | * @param string $name | |
138 | * Ex: 'civicrm.root'. | |
139 | * @param string $attr | |
140 | * Ex: 'url', 'path'. | |
141 | * @return mixed | |
142 | */ | |
143 | public function getVariable($name, $attr) { | |
144 | if (!isset($this->variables[$name])) { | |
145 | $this->variables[$name] = call_user_func($this->variableFactory[$name]); | |
313a57a0 TO |
146 | if (isset($GLOBALS['civicrm_paths'][$name])) { |
147 | $this->variables[$name] = array_merge($this->variables[$name], $GLOBALS['civicrm_paths'][$name]); | |
148 | } | |
d1532c9d TO |
149 | if (isset($this->variables[$name]['url'])) { |
150 | // Typical behavior is to return an absolute URL. If an admin has put an override that's site-relative, then convert. | |
151 | $this->variables[$name]['url'] = $this->toAbsoluteUrl($this->variables[$name]['url'], $name); | |
152 | } | |
e3d28c74 | 153 | } |
b698e2d5 | 154 | if (!isset($this->variables[$name][$attr])) { |
e3d28c74 TO |
155 | throw new \RuntimeException("Cannot resolve path using \"$name.$attr\""); |
156 | } | |
b698e2d5 TO |
157 | return $this->variables[$name][$attr]; |
158 | } | |
159 | ||
d1532c9d TO |
160 | /** |
161 | * @param string $url | |
162 | * Ex: 'https://example.com:8000/foobar' or '/foobar' | |
163 | * @param string $for | |
164 | * Ex: 'civicrm.root' or 'civicrm.packages' | |
165 | * @return string | |
166 | */ | |
167 | private function toAbsoluteUrl($url, $for) { | |
168 | if (!$url) { | |
169 | return $url; | |
170 | } | |
171 | elseif ($url[0] === '/') { | |
172 | // Relative URL interpretation | |
173 | if ($for === 'cms.root') { | |
174 | throw new \RuntimeException('Invalid configuration: the [cms.root] path must be an absolute URL'); | |
175 | } | |
176 | $cmsUrl = rtrim($this->getVariable('cms.root', 'url'), '/'); | |
177 | // The norms for relative URLs dictate: | |
178 | // Single-slash: "/sub/dir" or "/" (domain-relative) | |
179 | // Double-slash: "//example.com/sub/dir" (same-scheme) | |
180 | $prefix = ($url === '/' || $url[1] !== '/') | |
181 | ? $cmsUrl | |
182 | : (parse_url($cmsUrl, PHP_URL_SCHEME) . ':'); | |
183 | return $prefix . $url; | |
184 | } | |
185 | else { | |
186 | // Assume this is an absolute URL, as in the past ('_h_ttp://'). | |
187 | return $url; | |
188 | } | |
189 | } | |
190 | ||
e8e8f3ad | 191 | /** |
192 | * Does the variable exist. | |
193 | * | |
194 | * @param string $name | |
195 | * | |
196 | * @return bool | |
197 | */ | |
b698e2d5 TO |
198 | public function hasVariable($name) { |
199 | return isset($this->variableFactory[$name]); | |
e3d28c74 TO |
200 | } |
201 | ||
202 | /** | |
203 | * Determine the absolute path to a file, given that the file is most likely | |
b698e2d5 | 204 | * in a given particular variable. |
e3d28c74 TO |
205 | * |
206 | * @param string $value | |
b698e2d5 TO |
207 | * The file path. |
208 | * Use "." to reference to default file root. | |
209 | * Values may begin with a variable, e.g. "[civicrm.files]/upload". | |
e3d28c74 TO |
210 | * @return mixed|string |
211 | */ | |
212 | public function getPath($value) { | |
213 | $defaultContainer = self::DEFAULT_PATH; | |
214 | if ($value && $value{0} == '[' && preg_match(';^\[([a-zA-Z0-9\._]+)\]/(.*);', $value, $matches)) { | |
215 | $defaultContainer = $matches[1]; | |
216 | $value = $matches[2]; | |
217 | } | |
218 | if (empty($value)) { | |
219 | return FALSE; | |
220 | } | |
221 | if ($value === '.') { | |
222 | $value = ''; | |
223 | } | |
b698e2d5 | 224 | return \CRM_Utils_File::absoluteDirectory($value, $this->getVariable($defaultContainer, 'path')); |
e3d28c74 TO |
225 | } |
226 | ||
227 | /** | |
b698e2d5 | 228 | * Determine the URL to a file. |
e3d28c74 TO |
229 | * |
230 | * @param string $value | |
b698e2d5 | 231 | * The file path. The path may begin with a variable, e.g. "[civicrm.files]/upload". |
e3d28c74 TO |
232 | * @param string $preferFormat |
233 | * The preferred format ('absolute', 'relative'). | |
234 | * The result data may not meet the preference -- if the setting | |
235 | * refers to an external domain, then the result will be | |
236 | * absolute (regardless of preference). | |
237 | * @param bool|NULL $ssl | |
238 | * NULL to autodetect. TRUE to force to SSL. | |
239 | * @return mixed|string | |
240 | */ | |
241 | public function getUrl($value, $preferFormat = 'relative', $ssl = NULL) { | |
242 | $defaultContainer = self::DEFAULT_URL; | |
ac47f7ca | 243 | if ($value && $value{0} == '[' && preg_match(';^\[([a-zA-Z0-9\._]+)\](/(.*))$;', $value, $matches)) { |
e3d28c74 | 244 | $defaultContainer = $matches[1]; |
ac47f7ca | 245 | $value = empty($matches[3]) ? '.' : $matches[3]; |
e3d28c74 TO |
246 | } |
247 | ||
248 | if (empty($value)) { | |
249 | return FALSE; | |
250 | } | |
251 | if ($value === '.') { | |
252 | $value = ''; | |
253 | } | |
254 | if (substr($value, 0, 4) == 'http') { | |
255 | return $value; | |
256 | } | |
257 | ||
232fdd3d | 258 | $value = rtrim($this->getVariable($defaultContainer, 'url'), '/') . '/' . $value; |
e3d28c74 TO |
259 | |
260 | if ($preferFormat === 'relative') { | |
261 | $parsed = parse_url($value); | |
262 | if (isset($_SERVER['HTTP_HOST']) && isset($parsed['host']) && $_SERVER['HTTP_HOST'] == $parsed['host']) { | |
263 | $value = $parsed['path']; | |
264 | } | |
265 | } | |
266 | ||
267 | if ($ssl || ($ssl === NULL && \CRM_Utils_System::isSSL())) { | |
268 | $value = str_replace('http://', 'https://', $value); | |
269 | } | |
270 | ||
271 | return $value; | |
272 | } | |
273 | ||
274 | } |