| 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 | */ |
| 25 | private $variables = []; |
| 26 | |
| 27 | private $variableFactory = []; |
| 28 | |
| 29 | /** |
| 30 | * Class constructor. |
| 31 | */ |
| 32 | public function __construct() { |
| 33 | $paths = $this; |
| 34 | $this |
| 35 | ->register('civicrm.root', function () { |
| 36 | return \CRM_Core_Config::singleton()->userSystem->getCiviSourceStorage(); |
| 37 | }) |
| 38 | ->register('civicrm.packages', function () { |
| 39 | return [ |
| 40 | 'path' => \Civi::paths()->getPath('[civicrm.root]/packages/'), |
| 41 | 'url' => \Civi::paths()->getUrl('[civicrm.root]/packages/', 'absolute'), |
| 42 | ]; |
| 43 | }) |
| 44 | ->register('civicrm.vendor', function () { |
| 45 | return [ |
| 46 | 'path' => \Civi::paths()->getPath('[civicrm.root]/vendor/'), |
| 47 | 'url' => \Civi::paths()->getUrl('[civicrm.root]/vendor/', 'absolute'), |
| 48 | ]; |
| 49 | }) |
| 50 | ->register('civicrm.bower', function () { |
| 51 | return [ |
| 52 | 'path' => \Civi::paths()->getPath('[civicrm.root]/bower_components/'), |
| 53 | 'url' => \Civi::paths()->getUrl('[civicrm.root]/bower_components/', 'absolute'), |
| 54 | ]; |
| 55 | }) |
| 56 | ->register('civicrm.files', function () { |
| 57 | return \CRM_Core_Config::singleton()->userSystem->getDefaultFileStorage(); |
| 58 | }) |
| 59 | ->register('civicrm.private', function () { |
| 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 | ]; |
| 80 | }) |
| 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 | }) |
| 87 | ->register('wp.frontend.base', function () { |
| 88 | return ['url' => rtrim(CIVICRM_UF_BASEURL, '/') . '/']; |
| 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; |
| 93 | return [ |
| 94 | 'url' => $paths->getVariable('wp.frontend.base', 'url') . $suffix, |
| 95 | ]; |
| 96 | }) |
| 97 | ->register('wp.backend.base', function () { |
| 98 | return ['url' => rtrim(CIVICRM_UF_BASEURL, '/') . '/wp-admin/']; |
| 99 | }) |
| 100 | ->register('wp.backend', function () use ($paths) { |
| 101 | return [ |
| 102 | 'url' => $paths->getVariable('wp.backend.base', 'url') . 'admin.php', |
| 103 | ]; |
| 104 | }) |
| 105 | ->register('cms', function () { |
| 106 | return [ |
| 107 | 'path' => \CRM_Core_Config::singleton()->userSystem->cmsRootPath(), |
| 108 | 'url' => \CRM_Utils_System::baseCMSURL(), |
| 109 | ]; |
| 110 | }) |
| 111 | ->register('cms.root', function () { |
| 112 | return [ |
| 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), |
| 116 | ]; |
| 117 | }); |
| 118 | } |
| 119 | |
| 120 | /** |
| 121 | * Register a new URL/file path mapping. |
| 122 | * |
| 123 | * @param string $name |
| 124 | * The name of the variable. |
| 125 | * @param callable $factory |
| 126 | * Function which returns an array with keys: |
| 127 | * - path: string. |
| 128 | * - url: string. |
| 129 | * @return Paths |
| 130 | */ |
| 131 | public function register($name, $factory) { |
| 132 | $this->variableFactory[$name] = $factory; |
| 133 | return $this; |
| 134 | } |
| 135 | |
| 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]); |
| 146 | if (isset($GLOBALS['civicrm_paths'][$name])) { |
| 147 | $this->variables[$name] = array_merge($this->variables[$name], $GLOBALS['civicrm_paths'][$name]); |
| 148 | } |
| 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 | } |
| 153 | } |
| 154 | if (!isset($this->variables[$name][$attr])) { |
| 155 | throw new \RuntimeException("Cannot resolve path using \"$name.$attr\""); |
| 156 | } |
| 157 | return $this->variables[$name][$attr]; |
| 158 | } |
| 159 | |
| 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 | |
| 191 | /** |
| 192 | * Does the variable exist. |
| 193 | * |
| 194 | * @param string $name |
| 195 | * |
| 196 | * @return bool |
| 197 | */ |
| 198 | public function hasVariable($name) { |
| 199 | return isset($this->variableFactory[$name]); |
| 200 | } |
| 201 | |
| 202 | /** |
| 203 | * Determine the absolute path to a file, given that the file is most likely |
| 204 | * in a given particular variable. |
| 205 | * |
| 206 | * @param string $value |
| 207 | * The file path. |
| 208 | * Use "." to reference to default file root. |
| 209 | * Values may begin with a variable, e.g. "[civicrm.files]/upload". |
| 210 | * @return mixed|string |
| 211 | */ |
| 212 | public function getPath($value) { |
| 213 | if ($value === NULL || $value === FALSE || $value === '') { |
| 214 | return FALSE; |
| 215 | } |
| 216 | |
| 217 | $defaultContainer = self::DEFAULT_PATH; |
| 218 | if ($value && $value{0} == '[' && preg_match(';^\[([a-zA-Z0-9\._]+)\]/(.*);', $value, $matches)) { |
| 219 | $defaultContainer = $matches[1]; |
| 220 | $value = $matches[2]; |
| 221 | } |
| 222 | |
| 223 | $isDot = $value === '.'; |
| 224 | if ($isDot) { |
| 225 | $value = ''; |
| 226 | } |
| 227 | |
| 228 | $result = \CRM_Utils_File::absoluteDirectory($value, $this->getVariable($defaultContainer, 'path')); |
| 229 | return $isDot ? rtrim($result, '/' . DIRECTORY_SEPARATOR) : $result; |
| 230 | } |
| 231 | |
| 232 | /** |
| 233 | * Determine the URL to a file. |
| 234 | * |
| 235 | * @param string $value |
| 236 | * The file path. The path may begin with a variable, e.g. "[civicrm.files]/upload". |
| 237 | * |
| 238 | * This function was designed for locating files under a given tree, and the |
| 239 | * the result for a straight variable expressions ("[foo.bar]") was not |
| 240 | * originally defined. You may wish to use one of these: |
| 241 | * |
| 242 | * - getVariable('foo.bar', 'url') => Lookup variable by itself |
| 243 | * - getUrl('[foo.bar]/') => Get the variable (normalized with a trailing "/"). |
| 244 | * - getUrl('[foo.bar]/.') => Get the variable (normalized without a trailing "/"). |
| 245 | * @param string $preferFormat |
| 246 | * The preferred format ('absolute', 'relative'). |
| 247 | * The result data may not meet the preference -- if the setting |
| 248 | * refers to an external domain, then the result will be |
| 249 | * absolute (regardless of preference). |
| 250 | * @param bool|NULL $ssl |
| 251 | * NULL to autodetect. TRUE to force to SSL. |
| 252 | * @return FALSE|string |
| 253 | * The URL for $value (string), or FALSE if the $value is not specified. |
| 254 | */ |
| 255 | public function getUrl($value, $preferFormat = 'relative', $ssl = NULL) { |
| 256 | if ($value === NULL || $value === FALSE || $value === '') { |
| 257 | return FALSE; |
| 258 | } |
| 259 | |
| 260 | $defaultContainer = self::DEFAULT_URL; |
| 261 | if ($value && $value{0} == '[' && preg_match(';^\[([a-zA-Z0-9\._]+)\](/(.*))$;', $value, $matches)) { |
| 262 | $defaultContainer = $matches[1]; |
| 263 | $value = $matches[3]; |
| 264 | } |
| 265 | |
| 266 | $isDot = $value === '.'; |
| 267 | if (substr($value, 0, 5) === 'http:' || substr($value, 0, 6) === 'https:') { |
| 268 | return $value; |
| 269 | } |
| 270 | |
| 271 | $value = rtrim($this->getVariable($defaultContainer, 'url'), '/') . ($isDot ? '' : "/$value"); |
| 272 | |
| 273 | if ($preferFormat === 'relative') { |
| 274 | $parsed = parse_url($value); |
| 275 | if (isset($_SERVER['HTTP_HOST']) && isset($parsed['host']) && $_SERVER['HTTP_HOST'] == $parsed['host']) { |
| 276 | $value = $parsed['path']; |
| 277 | } |
| 278 | } |
| 279 | |
| 280 | if ($ssl || ($ssl === NULL && \CRM_Utils_System::isSSL())) { |
| 281 | $value = str_replace('http://', 'https://', $value); |
| 282 | } |
| 283 | |
| 284 | return $value; |
| 285 | } |
| 286 | |
| 287 | } |