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 +--------------------------------------------------------------------+
30 * @copyright CiviCRM LLC (c) 2004-2013
35 * An extension container is a locally-accessible source tree which can be
36 * scanned for extensions.
38 class CRM_Extension_Container_Basic
implements CRM_Extension_Container_Interface
{
43 * Note: Treat as private. This is only public to facilitate debugging.
50 * Note: Treat as private. This is only public to facilitate debugging.
55 * @var CRM_Utils_Cache_Interface|NULL
57 * Note: Treat as private. This is only public to facilitate debugging.
62 * @var string the cache key used for any data stored by this container
64 * Note: Treat as private. This is only public to facilitate debugging.
69 * @var array($key => $relPath)
71 * Note: Treat as private. This is only public to facilitate debugging.
73 public $relPaths = FALSE;
76 * @var array($key => $relUrl)
78 * Derived from $relPaths. On Unix systems (where file-paths and
79 * URL-paths both use '/' separator), this isn't necessary. On Windows
80 * systems, this is derived from $relPaths.
82 * Note: Treat as private. This is only public to facilitate debugging.
84 public $relUrls = FALSE;
87 * @param string $baseDir local path to the container
88 * @param string $baseUrl public URL of the container
89 * @param CRM_Utils_Cache_Interface $cache
90 * @param string $cacheKey unique name for this container
92 public function __construct($baseDir, $baseUrl, CRM_Utils_Cache_Interface
$cache = NULL, $cacheKey = NULL) {
93 $this->cache
= $cache;
94 $this->cacheKey
= $cacheKey;
95 $this->baseDir
= rtrim($baseDir, '/');
96 $this->baseUrl
= rtrim($baseUrl, '/');
102 public function checkRequirements() {
105 if (empty($this->baseDir
) ||
!is_dir($this->baseDir
)) {
107 'title' => ts('Invalid Base Directory'),
108 'message' => ts('An extension container has been defined with a blank directory.'),
111 if (empty($this->baseUrl
)) {
113 'title' => ts('Invalid Base URL'),
114 'message' => ts('An extension container has been defined with a blank URL.'),
124 public function getKeys() {
125 return array_keys($this->getRelPaths());
131 public function getPath($key) {
132 return $this->baseDir
. $this->getRelPath($key);
138 public function getResUrl($key) {
139 if (! $this->baseUrl
) {
140 CRM_Core_Session
::setStatus(
141 ts('Failed to determine URL for extension (%1). Please update <a href="%2">Resource URLs</a>.',
144 2 => CRM_Utils_System
::url('civicrm/admin/setting/url', 'reset=1'),
149 return $this->baseUrl
. $this->getRelUrl($key);
155 public function refresh() {
156 $this->relPaths
= NULL;
158 $this->cache
->delete($this->cacheKey
);
165 public function getBaseDir() {
166 return $this->baseDir
;
170 * Determine the relative path of an extension directory
173 * @throws CRM_Extension_Exception
175 protected function getRelPath($key) {
176 $keypaths = $this->getRelPaths();
177 if (!isset($keypaths[$key])) {
178 throw new CRM_Extension_Exception_MissingException("Failed to find extension: $key");
180 return $keypaths[$key];
184 * Scan $basedir for a list of extension-keys
186 * @return array($key => $relPath)
188 protected function getRelPaths() {
189 if (!is_array($this->relPaths
)) {
191 $this->relPaths
= $this->cache
->get($this->cacheKey
);
193 if (!is_array($this->relPaths
)) {
194 $this->relPaths
= array();
195 $infoPaths = CRM_Utils_File
::findFiles($this->baseDir
, 'info.xml');
196 foreach ($infoPaths as $infoPath) {
197 $relPath = CRM_Utils_File
::relativize(dirname($infoPath), $this->baseDir
);
199 $info = CRM_Extension_Info
::loadFromFile($infoPath);
200 } catch (CRM_Extension_Exception_ParseException
$e) {
201 CRM_Core_Session
::setStatus(ts('Parse error in extension: %1', array(
202 1 => $e->getMessage(),
204 CRM_Core_Error
::debug_log_message("Parse error in extension: " . $e->getMessage());
207 $this->relPaths
[$info->key
] = $relPath;
210 $this->cache
->set($this->cacheKey
, $this->relPaths
);
214 return $this->relPaths
;
218 * Determine the relative path of an extension directory
221 * @throws CRM_Extension_Exception
223 protected function getRelUrl($key) {
224 $relUrls = $this->getRelUrls();
225 if (!isset($relUrls[$key])) {
226 throw new CRM_Extension_Exception_MissingException("Failed to find extension: $key");
228 return $relUrls[$key];
232 * Scan $basedir for a list of extension-keys
234 * @param string $dirSep the local system's directory separator
235 * @return array($key => $relUrl)
237 protected function getRelUrls() {
238 if (DIRECTORY_SEPARATOR
== '/') {
239 return $this->getRelPaths();
241 if (!is_array($this->relUrls
)) {
242 $this->relUrls
= self
::convertPathsToUrls(DIRECTORY_SEPARATOR
, $this->getRelPaths());
244 return $this->relUrls
;
248 * Convert a list of relative paths to relative URLs.
250 * Note: Treat as private. This is only public to facilitate testing.
252 * @param string $dirSep
253 * @param array $relPaths ($key => $relPath)
254 * @return array($key => $relUrl)
256 public static function convertPathsToUrls($dirSep, $relPaths) {
258 foreach ($relPaths as $key => $relPath) {
259 $relUrls[$key] = str_replace($dirSep, '/', $relPath);