[#62]civix upgrade
This commit is contained in:
Anna
parent
dbdaa25468
commit
5d41d0f460
|
|
@ -7,9 +7,9 @@
|
|||
* extension.
|
||||
*/
|
||||
class CRM_Civiproxy_ExtensionUtil {
|
||||
const SHORT_NAME = "civiproxy";
|
||||
const LONG_NAME = "de.systopia.civiproxy";
|
||||
const CLASS_PREFIX = "CRM_Civiproxy";
|
||||
const SHORT_NAME = 'civiproxy';
|
||||
const LONG_NAME = 'de.systopia.civiproxy';
|
||||
const CLASS_PREFIX = 'CRM_Civiproxy';
|
||||
|
||||
/**
|
||||
* Translate a string using the extension's domain.
|
||||
|
|
@ -24,7 +24,7 @@ class CRM_Civiproxy_ExtensionUtil {
|
|||
* Translated text.
|
||||
* @see ts
|
||||
*/
|
||||
public static function ts($text, $params = []) {
|
||||
public static function ts($text, $params = []): string {
|
||||
if (!array_key_exists('domain', $params)) {
|
||||
$params['domain'] = [self::LONG_NAME, NULL];
|
||||
}
|
||||
|
|
@ -41,7 +41,7 @@ class CRM_Civiproxy_ExtensionUtil {
|
|||
* Ex: 'http://example.org/sites/default/ext/org.example.foo'.
|
||||
* Ex: 'http://example.org/sites/default/ext/org.example.foo/css/foo.css'.
|
||||
*/
|
||||
public static function url($file = NULL) {
|
||||
public static function url($file = NULL): string {
|
||||
if ($file === NULL) {
|
||||
return rtrim(CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME), '/');
|
||||
}
|
||||
|
|
@ -79,6 +79,13 @@ class CRM_Civiproxy_ExtensionUtil {
|
|||
|
||||
use CRM_Civiproxy_ExtensionUtil as E;
|
||||
|
||||
function _civiproxy_civix_mixin_polyfill() {
|
||||
if (!class_exists('CRM_Extension_MixInfo')) {
|
||||
$polyfill = __DIR__ . '/mixin/polyfill.php';
|
||||
(require $polyfill)(E::LONG_NAME, E::SHORT_NAME, E::path());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* (Delegated) Implements hook_civicrm_config().
|
||||
*
|
||||
|
|
@ -91,9 +98,9 @@ function _civiproxy_civix_civicrm_config(&$config = NULL) {
|
|||
}
|
||||
$configured = TRUE;
|
||||
|
||||
$template =& CRM_Core_Smarty::singleton();
|
||||
$template = CRM_Core_Smarty::singleton();
|
||||
|
||||
$extRoot = dirname(__FILE__) . DIRECTORY_SEPARATOR;
|
||||
$extRoot = __DIR__ . DIRECTORY_SEPARATOR;
|
||||
$extDir = $extRoot . 'templates';
|
||||
|
||||
if (is_array($template->template_dir)) {
|
||||
|
|
@ -105,19 +112,7 @@ function _civiproxy_civix_civicrm_config(&$config = NULL) {
|
|||
|
||||
$include_path = $extRoot . PATH_SEPARATOR . get_include_path();
|
||||
set_include_path($include_path);
|
||||
}
|
||||
|
||||
/**
|
||||
* (Delegated) Implements hook_civicrm_xmlMenu().
|
||||
*
|
||||
* @param $files array(string)
|
||||
*
|
||||
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_xmlMenu
|
||||
*/
|
||||
function _civiproxy_civix_civicrm_xmlMenu(&$files) {
|
||||
foreach (_civiproxy_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) {
|
||||
$files[] = $file;
|
||||
}
|
||||
_civiproxy_civix_mixin_polyfill();
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -130,6 +125,7 @@ function _civiproxy_civix_civicrm_install() {
|
|||
if ($upgrader = _civiproxy_civix_upgrader()) {
|
||||
$upgrader->onInstall();
|
||||
}
|
||||
_civiproxy_civix_mixin_polyfill();
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -170,6 +166,7 @@ function _civiproxy_civix_civicrm_enable() {
|
|||
$upgrader->onEnable();
|
||||
}
|
||||
}
|
||||
_civiproxy_civix_mixin_polyfill();
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -217,160 +214,6 @@ function _civiproxy_civix_upgrader() {
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Search directory tree for files which match a glob pattern.
|
||||
*
|
||||
* Note: Dot-directories (like "..", ".git", or ".svn") will be ignored.
|
||||
* Note: In Civi 4.3+, delegate to CRM_Utils_File::findFiles()
|
||||
*
|
||||
* @param string $dir base dir
|
||||
* @param string $pattern , glob pattern, eg "*.txt"
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
function _civiproxy_civix_find_files($dir, $pattern) {
|
||||
if (is_callable(['CRM_Utils_File', 'findFiles'])) {
|
||||
return CRM_Utils_File::findFiles($dir, $pattern);
|
||||
}
|
||||
|
||||
$todos = [$dir];
|
||||
$result = [];
|
||||
while (!empty($todos)) {
|
||||
$subdir = array_shift($todos);
|
||||
foreach (_civiproxy_civix_glob("$subdir/$pattern") as $match) {
|
||||
if (!is_dir($match)) {
|
||||
$result[] = $match;
|
||||
}
|
||||
}
|
||||
if ($dh = opendir($subdir)) {
|
||||
while (FALSE !== ($entry = readdir($dh))) {
|
||||
$path = $subdir . DIRECTORY_SEPARATOR . $entry;
|
||||
if ($entry[0] == '.') {
|
||||
}
|
||||
elseif (is_dir($path)) {
|
||||
$todos[] = $path;
|
||||
}
|
||||
}
|
||||
closedir($dh);
|
||||
}
|
||||
}
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* (Delegated) Implements hook_civicrm_managed().
|
||||
*
|
||||
* Find any *.mgd.php files, merge their content, and return.
|
||||
*
|
||||
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_managed
|
||||
*/
|
||||
function _civiproxy_civix_civicrm_managed(&$entities) {
|
||||
$mgdFiles = _civiproxy_civix_find_files(__DIR__, '*.mgd.php');
|
||||
sort($mgdFiles);
|
||||
foreach ($mgdFiles as $file) {
|
||||
$es = include $file;
|
||||
foreach ($es as $e) {
|
||||
if (empty($e['module'])) {
|
||||
$e['module'] = E::LONG_NAME;
|
||||
}
|
||||
if (empty($e['params']['version'])) {
|
||||
$e['params']['version'] = '3';
|
||||
}
|
||||
$entities[] = $e;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* (Delegated) Implements hook_civicrm_caseTypes().
|
||||
*
|
||||
* Find any and return any files matching "xml/case/*.xml"
|
||||
*
|
||||
* Note: This hook only runs in CiviCRM 4.4+.
|
||||
*
|
||||
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_caseTypes
|
||||
*/
|
||||
function _civiproxy_civix_civicrm_caseTypes(&$caseTypes) {
|
||||
if (!is_dir(__DIR__ . '/xml/case')) {
|
||||
return;
|
||||
}
|
||||
|
||||
foreach (_civiproxy_civix_glob(__DIR__ . '/xml/case/*.xml') as $file) {
|
||||
$name = preg_replace('/\.xml$/', '', basename($file));
|
||||
if ($name != CRM_Case_XMLProcessor::mungeCaseType($name)) {
|
||||
$errorMessage = sprintf("Case-type file name is malformed (%s vs %s)", $name, CRM_Case_XMLProcessor::mungeCaseType($name));
|
||||
throw new CRM_Core_Exception($errorMessage);
|
||||
}
|
||||
$caseTypes[$name] = [
|
||||
'module' => E::LONG_NAME,
|
||||
'name' => $name,
|
||||
'file' => $file,
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* (Delegated) Implements hook_civicrm_angularModules().
|
||||
*
|
||||
* Find any and return any files matching "ang/*.ang.php"
|
||||
*
|
||||
* Note: This hook only runs in CiviCRM 4.5+.
|
||||
*
|
||||
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_angularModules
|
||||
*/
|
||||
function _civiproxy_civix_civicrm_angularModules(&$angularModules) {
|
||||
if (!is_dir(__DIR__ . '/ang')) {
|
||||
return;
|
||||
}
|
||||
|
||||
$files = _civiproxy_civix_glob(__DIR__ . '/ang/*.ang.php');
|
||||
foreach ($files as $file) {
|
||||
$name = preg_replace(':\.ang\.php$:', '', basename($file));
|
||||
$module = include $file;
|
||||
if (empty($module['ext'])) {
|
||||
$module['ext'] = E::LONG_NAME;
|
||||
}
|
||||
$angularModules[$name] = $module;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* (Delegated) Implements hook_civicrm_themes().
|
||||
*
|
||||
* Find any and return any files matching "*.theme.php"
|
||||
*/
|
||||
function _civiproxy_civix_civicrm_themes(&$themes) {
|
||||
$files = _civiproxy_civix_glob(__DIR__ . '/*.theme.php');
|
||||
foreach ($files as $file) {
|
||||
$themeMeta = include $file;
|
||||
if (empty($themeMeta['name'])) {
|
||||
$themeMeta['name'] = preg_replace(':\.theme\.php$:', '', basename($file));
|
||||
}
|
||||
if (empty($themeMeta['ext'])) {
|
||||
$themeMeta['ext'] = E::LONG_NAME;
|
||||
}
|
||||
$themes[$themeMeta['name']] = $themeMeta;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Glob wrapper which is guaranteed to return an array.
|
||||
*
|
||||
* The documentation for glob() says, "On some systems it is impossible to
|
||||
* distinguish between empty match and an error." Anecdotally, the return
|
||||
* result for an empty match is sometimes array() and sometimes FALSE.
|
||||
* This wrapper provides consistency.
|
||||
*
|
||||
* @link http://php.net/glob
|
||||
* @param string $pattern
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
function _civiproxy_civix_glob($pattern) {
|
||||
$result = glob($pattern);
|
||||
return is_array($result) ? $result : [];
|
||||
}
|
||||
|
||||
/**
|
||||
* Inserts a navigation menu item at a given place in the hierarchy.
|
||||
*
|
||||
|
|
@ -453,18 +296,6 @@ function _civiproxy_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID)
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* (Delegated) Implements hook_civicrm_alterSettingsFolders().
|
||||
*
|
||||
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_alterSettingsFolders
|
||||
*/
|
||||
function _civiproxy_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) {
|
||||
$settingsDir = __DIR__ . DIRECTORY_SEPARATOR . 'settings';
|
||||
if (!in_array($settingsDir, $metaDataFolders) && is_dir($settingsDir)) {
|
||||
$metaDataFolders[] = $settingsDir;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* (Delegated) Implements hook_civicrm_entityTypes().
|
||||
*
|
||||
|
|
|
|||
|
|
@ -25,15 +25,6 @@ function civiproxy_civicrm_config(&$config) {
|
|||
_civiproxy_civix_civicrm_config($config);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of hook_civicrm_xmlMenu
|
||||
*
|
||||
* @param $files array(string)
|
||||
*/
|
||||
function civiproxy_civicrm_xmlMenu(&$files) {
|
||||
_civiproxy_civix_civicrm_xmlMenu($files);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of hook_civicrm_install
|
||||
*/
|
||||
|
|
@ -75,41 +66,27 @@ function civiproxy_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
|
|||
return _civiproxy_civix_civicrm_upgrade($op, $queue);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of hook_civicrm_managed
|
||||
*
|
||||
* Generate a list of entities to create/deactivate/delete when this module
|
||||
* is installed, disabled, uninstalled.
|
||||
*/
|
||||
function civiproxy_civicrm_managed(&$entities) {
|
||||
return _civiproxy_civix_civicrm_managed($entities);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of hook_civicrm_caseTypes
|
||||
*
|
||||
* Generate a list of case-types
|
||||
*
|
||||
* Note: This hook only runs in CiviCRM 4.4+.
|
||||
*/
|
||||
function civiproxy_civicrm_caseTypes(&$caseTypes) {
|
||||
_civiproxy_civix_civicrm_caseTypes($caseTypes);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of hook_civicrm_alterSettingsFolders
|
||||
*
|
||||
* Scan for settings in custom folder and import them
|
||||
*
|
||||
*/
|
||||
function civiproxy_civicrm_alterSettingsFolders(&$metaDataFolders = NULL){
|
||||
static $configured = FALSE;
|
||||
if ($configured) return;
|
||||
$configured = TRUE;
|
||||
|
||||
$extRoot = dirname( __FILE__ ) . DIRECTORY_SEPARATOR;
|
||||
$extDir = $extRoot . 'settings';
|
||||
if(!in_array($extDir, $metaDataFolders)){
|
||||
$metaDataFolders[] = $extDir;
|
||||
}
|
||||
/**
|
||||
* Implements hook_civicrm_postInstall().
|
||||
*
|
||||
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
|
||||
*/
|
||||
function civiproxy_civicrm_postInstall() {
|
||||
_civiproxy_civix_civicrm_postInstall();
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements hook_civicrm_entityTypes().
|
||||
*
|
||||
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
|
||||
*/
|
||||
function civiproxy_civicrm_entityTypes(&$entityTypes) {
|
||||
_civiproxy_civix_civicrm_entityTypes($entityTypes);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
<author>B. Endres</author>
|
||||
<email>endres@systopia.de</email>
|
||||
</maintainer>
|
||||
<releaseDate></releaseDate>
|
||||
<releaseDate/>
|
||||
<version>0.6-dev</version>
|
||||
<develStage>dev</develStage>
|
||||
<compatibility>
|
||||
|
|
@ -17,5 +17,10 @@
|
|||
<comments>This is the companion extension to SYSTOPIA's CiviProxy security system</comments>
|
||||
<civix>
|
||||
<namespace>CRM/Civiproxy</namespace>
|
||||
<format>22.05.2</format>
|
||||
</civix>
|
||||
<mixins>
|
||||
<mixin>menu-xml@1.0.0</mixin>
|
||||
<mixin>setting-php@1.0.0</mixin>
|
||||
</mixins>
|
||||
</extension>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,31 @@
|
|||
<?php
|
||||
|
||||
/**
|
||||
* Auto-register "xml/Menu/*.xml" files.
|
||||
*
|
||||
* @mixinName menu-xml
|
||||
* @mixinVersion 1.0.0
|
||||
*
|
||||
* @param CRM_Extension_MixInfo $mixInfo
|
||||
* On newer deployments, this will be an instance of MixInfo. On older deployments, Civix may polyfill with a work-a-like.
|
||||
* @param \CRM_Extension_BootCache $bootCache
|
||||
* On newer deployments, this will be an instance of MixInfo. On older deployments, Civix may polyfill with a work-a-like.
|
||||
*/
|
||||
return function ($mixInfo, $bootCache) {
|
||||
|
||||
/**
|
||||
* @param \Civi\Core\Event\GenericHookEvent $e
|
||||
* @see CRM_Utils_Hook::xmlMenu()
|
||||
*/
|
||||
Civi::dispatcher()->addListener('hook_civicrm_xmlMenu', function ($e) use ($mixInfo) {
|
||||
if (!$mixInfo->isActive()) {
|
||||
return;
|
||||
}
|
||||
|
||||
$files = (array) glob($mixInfo->getPath('xml/Menu/*.xml'));
|
||||
foreach ($files as $file) {
|
||||
$e->files[] = $file;
|
||||
}
|
||||
});
|
||||
|
||||
};
|
||||
|
|
@ -0,0 +1,101 @@
|
|||
<?php
|
||||
|
||||
/**
|
||||
* When deploying on systems that lack mixin support, fake it.
|
||||
*
|
||||
* @mixinFile polyfill.php
|
||||
*
|
||||
* This polyfill does some (persnickity) deduplication, but it doesn't allow upgrades or shipping replacements in core.
|
||||
*
|
||||
* Note: The polyfill.php is designed to be copied into extensions for interoperability. Consequently, this file is
|
||||
* not used 'live' by `civicrm-core`. However, the file does need a canonical home, and it's convenient to keep it
|
||||
* adjacent to the actual mixin files.
|
||||
*
|
||||
* @param string $longName
|
||||
* @param string $shortName
|
||||
* @param string $basePath
|
||||
*/
|
||||
return function ($longName, $shortName, $basePath) {
|
||||
// Construct imitations of the mixin services. These cannot work as well (e.g. with respect to
|
||||
// number of file-reads, deduping, upgrading)... but they should be OK for a few months while
|
||||
// the mixin services become available.
|
||||
|
||||
// List of active mixins; deduped by version
|
||||
$mixinVers = [];
|
||||
foreach ((array) glob($basePath . '/mixin/*.mixin.php') as $f) {
|
||||
[$name, $ver] = explode('@', substr(basename($f), 0, -10));
|
||||
if (!isset($mixinVers[$name]) || version_compare($ver, $mixinVers[$name], '>')) {
|
||||
$mixinVers[$name] = $ver;
|
||||
}
|
||||
}
|
||||
$mixins = [];
|
||||
foreach ($mixinVers as $name => $ver) {
|
||||
$mixins[] = "$name@$ver";
|
||||
}
|
||||
|
||||
// Imitate CRM_Extension_MixInfo.
|
||||
$mixInfo = new class() {
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
public $longName;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
public $shortName;
|
||||
|
||||
public $_basePath;
|
||||
|
||||
public function getPath($file = NULL) {
|
||||
return $this->_basePath . ($file === NULL ? '' : (DIRECTORY_SEPARATOR . $file));
|
||||
}
|
||||
|
||||
public function isActive() {
|
||||
return \CRM_Extension_System::singleton()->getMapper()->isActiveModule($this->shortName);
|
||||
}
|
||||
|
||||
};
|
||||
$mixInfo->longName = $longName;
|
||||
$mixInfo->shortName = $shortName;
|
||||
$mixInfo->_basePath = $basePath;
|
||||
|
||||
// Imitate CRM_Extension_BootCache.
|
||||
$bootCache = new class() {
|
||||
|
||||
public function define($name, $callback) {
|
||||
$envId = \CRM_Core_Config_Runtime::getId();
|
||||
$oldExtCachePath = \Civi::paths()->getPath("[civicrm.compile]/CachedExtLoader.{$envId}.php");
|
||||
$stat = stat($oldExtCachePath);
|
||||
$file = Civi::paths()->getPath('[civicrm.compile]/CachedMixin.' . md5($name . ($stat['mtime'] ?? 0)) . '.php');
|
||||
if (file_exists($file)) {
|
||||
return include $file;
|
||||
}
|
||||
else {
|
||||
$data = $callback();
|
||||
file_put_contents($file, '<' . "?php\nreturn " . var_export($data, 1) . ';');
|
||||
return $data;
|
||||
}
|
||||
}
|
||||
|
||||
};
|
||||
|
||||
// Imitate CRM_Extension_MixinLoader::run()
|
||||
// Parse all live mixins before trying to scan any classes.
|
||||
global $_CIVIX_MIXIN_POLYFILL;
|
||||
foreach ($mixins as $mixin) {
|
||||
// If the exact same mixin is defined by multiple exts, just use the first one.
|
||||
if (!isset($_CIVIX_MIXIN_POLYFILL[$mixin])) {
|
||||
$_CIVIX_MIXIN_POLYFILL[$mixin] = include_once $basePath . '/mixin/' . $mixin . '.mixin.php';
|
||||
}
|
||||
}
|
||||
foreach ($mixins as $mixin) {
|
||||
// If there's trickery about installs/uninstalls/resets, then we may need to register a second time.
|
||||
if (!isset(\Civi::$statics[__FUNCTION__][$mixin])) {
|
||||
\Civi::$statics[__FUNCTION__][$mixin] = 1;
|
||||
$func = $_CIVIX_MIXIN_POLYFILL[$mixin];
|
||||
$func($mixInfo, $bootCache);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
<?php
|
||||
|
||||
/**
|
||||
* Auto-register "settings/*.setting.php" files.
|
||||
*
|
||||
* @mixinName setting-php
|
||||
* @mixinVersion 1.0.0
|
||||
*
|
||||
* @param CRM_Extension_MixInfo $mixInfo
|
||||
* On newer deployments, this will be an instance of MixInfo. On older deployments, Civix may polyfill with a work-a-like.
|
||||
* @param \CRM_Extension_BootCache $bootCache
|
||||
* On newer deployments, this will be an instance of MixInfo. On older deployments, Civix may polyfill with a work-a-like.
|
||||
*/
|
||||
return function ($mixInfo, $bootCache) {
|
||||
|
||||
/**
|
||||
* @param \Civi\Core\Event\GenericHookEvent $e
|
||||
* @see CRM_Utils_Hook::alterSettingsFolders()
|
||||
*/
|
||||
Civi::dispatcher()->addListener('hook_civicrm_alterSettingsFolders', function ($e) use ($mixInfo) {
|
||||
// When deactivating on a polyfill/pre-mixin system, listeners may not cleanup automatically.
|
||||
if (!$mixInfo->isActive()) {
|
||||
return;
|
||||
}
|
||||
|
||||
$settingsDir = $mixInfo->getPath('settings');
|
||||
if (!in_array($settingsDir, $e->settingsFolders) && is_dir($settingsDir)) {
|
||||
$e->settingsFolders[] = $settingsDir;
|
||||
}
|
||||
});
|
||||
|
||||
};
|
||||
Loading…
Reference in New Issue