diff --git a/CRM/Twingle/Upgrader.php b/CRM/Twingle/Upgrader.php
index 98d956b..6cf7d91 100644
--- a/CRM/Twingle/Upgrader.php
+++ b/CRM/Twingle/Upgrader.php
@@ -4,7 +4,7 @@ use CRM_Twingle_ExtensionUtil as E;
/**
* Collection of upgrade steps.
*/
-class CRM_Twingle_Upgrader extends CRM_Twingle_Upgrader_Base {
+class CRM_Twingle_Upgrader extends CRM_Extension_Upgrader_Base {
/**
* Installer script
diff --git a/CRM/Twingle/Upgrader/Base.php b/CRM/Twingle/Upgrader/Base.php
deleted file mode 100644
index 1ffe718..0000000
--- a/CRM/Twingle/Upgrader/Base.php
+++ /dev/null
@@ -1,376 +0,0 @@
-ctx = array_shift($args);
- $instance->queue = $instance->ctx->queue;
- $method = array_shift($args);
- return call_user_func_array([$instance, $method], $args);
- }
-
- public function __construct($extensionName, $extensionDir) {
- $this->extensionName = $extensionName;
- $this->extensionDir = $extensionDir;
- }
-
- // ******** Task helpers ********
-
- /**
- * Run a CustomData file.
- *
- * @param string $relativePath the CustomData XML file path (relative to this extension's dir)
- * @return bool
- */
- public function executeCustomDataFile($relativePath) {
- $xml_file = $this->extensionDir . '/' . $relativePath;
- return $this->executeCustomDataFileByAbsPath($xml_file);
- }
-
- /**
- * Run a CustomData file
- *
- * @param string $xml_file the CustomData XML file path (absolute path)
- *
- * @return bool
- */
- protected static function executeCustomDataFileByAbsPath($xml_file) {
- $import = new CRM_Utils_Migrate_Import();
- $import->run($xml_file);
- return TRUE;
- }
-
- /**
- * Run a SQL file.
- *
- * @param string $relativePath the SQL file path (relative to this extension's dir)
- *
- * @return bool
- */
- public function executeSqlFile($relativePath) {
- CRM_Utils_File::sourceSQLFile(
- CIVICRM_DSN,
- $this->extensionDir . DIRECTORY_SEPARATOR . $relativePath
- );
- return TRUE;
- }
-
- /**
- * @param string $tplFile
- * The SQL file path (relative to this extension's dir).
- * Ex: "sql/mydata.mysql.tpl".
- * @return bool
- */
- public function executeSqlTemplate($tplFile) {
- // Assign multilingual variable to Smarty.
- $upgrade = new CRM_Upgrade_Form();
-
- $tplFile = CRM_Utils_File::isAbsolute($tplFile) ? $tplFile : $this->extensionDir . DIRECTORY_SEPARATOR . $tplFile;
- $smarty = CRM_Core_Smarty::singleton();
- $smarty->assign('domainID', CRM_Core_Config::domainID());
- CRM_Utils_File::sourceSQLFile(
- CIVICRM_DSN, $smarty->fetch($tplFile), NULL, TRUE
- );
- return TRUE;
- }
-
- /**
- * Run one SQL query.
- *
- * This is just a wrapper for CRM_Core_DAO::executeSql, but it
- * provides syntatic sugar for queueing several tasks that
- * run different queries
- */
- public function executeSql($query, $params = []) {
- // FIXME verify that we raise an exception on error
- CRM_Core_DAO::executeQuery($query, $params);
- return TRUE;
- }
-
- /**
- * Syntatic sugar for enqueuing a task which calls a function in this class.
- *
- * The task is weighted so that it is processed
- * as part of the currently-pending revision.
- *
- * After passing the $funcName, you can also pass parameters that will go to
- * the function. Note that all params must be serializable.
- */
- public function addTask($title) {
- $args = func_get_args();
- $title = array_shift($args);
- $task = new CRM_Queue_Task(
- [get_class($this), '_queueAdapter'],
- $args,
- $title
- );
- return $this->queue->createItem($task, ['weight' => -1]);
- }
-
- // ******** Revision-tracking helpers ********
-
- /**
- * Determine if there are any pending revisions.
- *
- * @return bool
- */
- public function hasPendingRevisions() {
- $revisions = $this->getRevisions();
- $currentRevision = $this->getCurrentRevision();
-
- if (empty($revisions)) {
- return FALSE;
- }
- if (empty($currentRevision)) {
- return TRUE;
- }
-
- return ($currentRevision < max($revisions));
- }
-
- /**
- * Add any pending revisions to the queue.
- */
- public function enqueuePendingRevisions(CRM_Queue_Queue $queue) {
- $this->queue = $queue;
-
- $currentRevision = $this->getCurrentRevision();
- foreach ($this->getRevisions() as $revision) {
- if ($revision > $currentRevision) {
- $title = ts('Upgrade %1 to revision %2', [
- 1 => $this->extensionName,
- 2 => $revision,
- ]);
-
- // note: don't use addTask() because it sets weight=-1
-
- $task = new CRM_Queue_Task(
- [get_class($this), '_queueAdapter'],
- ['upgrade_' . $revision],
- $title
- );
- $this->queue->createItem($task);
-
- $task = new CRM_Queue_Task(
- [get_class($this), '_queueAdapter'],
- ['setCurrentRevision', $revision],
- $title
- );
- $this->queue->createItem($task);
- }
- }
- }
-
- /**
- * Get a list of revisions.
- *
- * @return array(revisionNumbers) sorted numerically
- */
- public function getRevisions() {
- if (!is_array($this->revisions)) {
- $this->revisions = [];
-
- $clazz = new ReflectionClass(get_class($this));
- $methods = $clazz->getMethods();
- foreach ($methods as $method) {
- if (preg_match('/^upgrade_(.*)/', $method->name, $matches)) {
- $this->revisions[] = $matches[1];
- }
- }
- sort($this->revisions, SORT_NUMERIC);
- }
-
- return $this->revisions;
- }
-
- public function getCurrentRevision() {
- $revision = CRM_Core_BAO_Extension::getSchemaVersion($this->extensionName);
- if (!$revision) {
- $revision = $this->getCurrentRevisionDeprecated();
- }
- return $revision;
- }
-
- private function getCurrentRevisionDeprecated() {
- $key = $this->extensionName . ':version';
- if ($revision = CRM_Core_BAO_Setting::getItem('Extension', $key)) {
- $this->revisionStorageIsDeprecated = TRUE;
- }
- return $revision;
- }
-
- public function setCurrentRevision($revision) {
- CRM_Core_BAO_Extension::setSchemaVersion($this->extensionName, $revision);
- // clean up legacy schema version store (CRM-19252)
- $this->deleteDeprecatedRevision();
- return TRUE;
- }
-
- private function deleteDeprecatedRevision() {
- if ($this->revisionStorageIsDeprecated) {
- $setting = new CRM_Core_BAO_Setting();
- $setting->name = $this->extensionName . ':version';
- $setting->delete();
- Civi::log()->debug("Migrated extension schema revision ID for {$this->extensionName} from civicrm_setting (deprecated) to civicrm_extension.\n");
- }
- }
-
- // ******** Hook delegates ********
-
- /**
- * @see https://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install
- */
- public function onInstall() {
- $files = glob($this->extensionDir . '/sql/*_install.sql');
- if (is_array($files)) {
- foreach ($files as $file) {
- CRM_Utils_File::sourceSQLFile(CIVICRM_DSN, $file);
- }
- }
- $files = glob($this->extensionDir . '/sql/*_install.mysql.tpl');
- if (is_array($files)) {
- foreach ($files as $file) {
- $this->executeSqlTemplate($file);
- }
- }
- $files = glob($this->extensionDir . '/xml/*_install.xml');
- if (is_array($files)) {
- foreach ($files as $file) {
- $this->executeCustomDataFileByAbsPath($file);
- }
- }
- if (is_callable([$this, 'install'])) {
- $this->install();
- }
- }
-
- /**
- * @see https://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_postInstall
- */
- public function onPostInstall() {
- $revisions = $this->getRevisions();
- if (!empty($revisions)) {
- $this->setCurrentRevision(max($revisions));
- }
- if (is_callable([$this, 'postInstall'])) {
- $this->postInstall();
- }
- }
-
- /**
- * @see https://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall
- */
- public function onUninstall() {
- $files = glob($this->extensionDir . '/sql/*_uninstall.mysql.tpl');
- if (is_array($files)) {
- foreach ($files as $file) {
- $this->executeSqlTemplate($file);
- }
- }
- if (is_callable([$this, 'uninstall'])) {
- $this->uninstall();
- }
- $files = glob($this->extensionDir . '/sql/*_uninstall.sql');
- if (is_array($files)) {
- foreach ($files as $file) {
- CRM_Utils_File::sourceSQLFile(CIVICRM_DSN, $file);
- }
- }
- }
-
- /**
- * @see https://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable
- */
- public function onEnable() {
- // stub for possible future use
- if (is_callable([$this, 'enable'])) {
- $this->enable();
- }
- }
-
- /**
- * @see https://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable
- */
- public function onDisable() {
- // stub for possible future use
- if (is_callable([$this, 'disable'])) {
- $this->disable();
- }
- }
-
- public function onUpgrade($op, CRM_Queue_Queue $queue = NULL) {
- switch ($op) {
- case 'check':
- return [$this->hasPendingRevisions()];
-
- case 'enqueue':
- return $this->enqueuePendingRevisions($queue);
-
- default:
- }
- }
-
-}
diff --git a/info.xml b/info.xml
index 32c0ab7..d6e896f 100644
--- a/info.xml
+++ b/info.xml
@@ -14,25 +14,28 @@
https://github.com/systopia/de.systopia.twingle/issues
http://www.gnu.org/licenses/agpl-3.0.html
-
+
1.5-dev
dev
5.56
-
+
de.systopia.xcm
CRM/Twingle
- 22.10.0
+ 23.02.1
menu-xml@1.0.0
mgd-php@1.0.0
+ smarty-v2@1.0.1
+
+ CRM_Twingle_Upgrader
diff --git a/mixin/menu-xml@1.0.0.mixin.php b/mixin/menu-xml@1.0.0.mixin.php
deleted file mode 100644
index 4c0b227..0000000
--- a/mixin/menu-xml@1.0.0.mixin.php
+++ /dev/null
@@ -1,31 +0,0 @@
-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;
- }
- });
-
-};
diff --git a/mixin/polyfill.php b/mixin/polyfill.php
deleted file mode 100644
index f57c5eb..0000000
--- a/mixin/polyfill.php
+++ /dev/null
@@ -1,101 +0,0 @@
-')) {
- $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);
- }
- }
-};
diff --git a/mixin/smarty-v2@1.0.1.mixin.php b/mixin/smarty-v2@1.0.1.mixin.php
new file mode 100644
index 0000000..5972dbd
--- /dev/null
+++ b/mixin/smarty-v2@1.0.1.mixin.php
@@ -0,0 +1,51 @@
+getPath('templates');
+ if (!file_exists($dir)) {
+ return;
+ }
+
+ $register = function() use ($dir) {
+ // This implementation has a theoretical edge-case bug on older versions of CiviCRM where a template could
+ // be registered more than once.
+ CRM_Core_Smarty::singleton()->addTemplateDir($dir);
+ };
+
+ // Let's figure out what environment we're in -- so that we know the best way to call $register().
+
+ if (!empty($GLOBALS['_CIVIX_MIXIN_POLYFILL'])) {
+ // Polyfill Loader (v<=5.45): We're already in the middle of firing `hook_config`.
+ if ($mixInfo->isActive()) {
+ $register();
+ }
+ return;
+ }
+
+ if (CRM_Extension_System::singleton()->getManager()->extensionIsBeingInstalledOrEnabled($mixInfo->longName)) {
+ // New Install, Standard Loader: The extension has just been enabled, and we're now setting it up.
+ // System has already booted. New templates may be needed for upcoming installation steps.
+ $register();
+ return;
+ }
+
+ // Typical Pageview, Standard Loader: Defer the actual registration for a moment -- to ensure that Smarty is online.
+ \Civi::dispatcher()->addListener('hook_civicrm_config', function() use ($mixInfo, $register) {
+ if ($mixInfo->isActive()) {
+ $register();
+ }
+ });
+
+};
diff --git a/twingle.civix.php b/twingle.civix.php
index 4cd74d1..c207adf 100644
--- a/twingle.civix.php
+++ b/twingle.civix.php
@@ -79,40 +79,22 @@ class CRM_Twingle_ExtensionUtil {
use CRM_Twingle_ExtensionUtil as E;
-function _twingle_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().
*
* @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config
*/
-function _twingle_civix_civicrm_config(&$config = NULL) {
+function _twingle_civix_civicrm_config($config = NULL) {
static $configured = FALSE;
if ($configured) {
return;
}
$configured = TRUE;
- $template = CRM_Core_Smarty::singleton();
-
$extRoot = __DIR__ . DIRECTORY_SEPARATOR;
- $extDir = $extRoot . 'templates';
-
- if (is_array($template->template_dir)) {
- array_unshift($template->template_dir, $extDir);
- }
- else {
- $template->template_dir = [$extDir, $template->template_dir];
- }
-
$include_path = $extRoot . PATH_SEPARATOR . get_include_path();
set_include_path($include_path);
- _twingle_civix_mixin_polyfill();
+ // Based on , this does not currently require mixin/polyfill.php.
}
/**
@@ -122,36 +104,7 @@ function _twingle_civix_civicrm_config(&$config = NULL) {
*/
function _twingle_civix_civicrm_install() {
_twingle_civix_civicrm_config();
- if ($upgrader = _twingle_civix_upgrader()) {
- $upgrader->onInstall();
- }
- _twingle_civix_mixin_polyfill();
-}
-
-/**
- * Implements hook_civicrm_postInstall().
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_postInstall
- */
-function _twingle_civix_civicrm_postInstall() {
- _twingle_civix_civicrm_config();
- if ($upgrader = _twingle_civix_upgrader()) {
- if (is_callable([$upgrader, 'onPostInstall'])) {
- $upgrader->onPostInstall();
- }
- }
-}
-
-/**
- * Implements hook_civicrm_uninstall().
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_uninstall
- */
-function _twingle_civix_civicrm_uninstall(): void {
- _twingle_civix_civicrm_config();
- if ($upgrader = _twingle_civix_upgrader()) {
- $upgrader->onUninstall();
- }
+ // Based on , this does not currently require mixin/polyfill.php.
}
/**
@@ -161,57 +114,7 @@ function _twingle_civix_civicrm_uninstall(): void {
*/
function _twingle_civix_civicrm_enable(): void {
_twingle_civix_civicrm_config();
- if ($upgrader = _twingle_civix_upgrader()) {
- if (is_callable([$upgrader, 'onEnable'])) {
- $upgrader->onEnable();
- }
- }
- _twingle_civix_mixin_polyfill();
-}
-
-/**
- * (Delegated) Implements hook_civicrm_disable().
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_disable
- * @return mixed
- */
-function _twingle_civix_civicrm_disable(): void {
- _twingle_civix_civicrm_config();
- if ($upgrader = _twingle_civix_upgrader()) {
- if (is_callable([$upgrader, 'onDisable'])) {
- $upgrader->onDisable();
- }
- }
-}
-
-/**
- * (Delegated) Implements hook_civicrm_upgrade().
- *
- * @param $op string, the type of operation being performed; 'check' or 'enqueue'
- * @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks
- *
- * @return mixed
- * based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending)
- * for 'enqueue', returns void
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_upgrade
- */
-function _twingle_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
- if ($upgrader = _twingle_civix_upgrader()) {
- return $upgrader->onUpgrade($op, $queue);
- }
-}
-
-/**
- * @return CRM_Twingle_Upgrader
- */
-function _twingle_civix_upgrader() {
- if (!file_exists(__DIR__ . '/CRM/Twingle/Upgrader.php')) {
- return NULL;
- }
- else {
- return CRM_Twingle_Upgrader_Base::instance();
- }
+ // Based on , this does not currently require mixin/polyfill.php.
}
/**
@@ -230,8 +133,8 @@ function _twingle_civix_insert_navigation_menu(&$menu, $path, $item) {
if (empty($path)) {
$menu[] = [
'attributes' => array_merge([
- 'label' => CRM_Utils_Array::value('name', $item),
- 'active' => 1,
+ 'label' => $item['name'] ?? NULL,
+ 'active' => 1,
], $item),
];
return TRUE;
@@ -295,14 +198,3 @@ function _twingle_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID) {
}
}
}
-
-/**
- * (Delegated) Implements hook_civicrm_entityTypes().
- *
- * Find any *.entityType.php files, merge their content, and return.
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
- */
-function _twingle_civix_civicrm_entityTypes(&$entityTypes) {
- $entityTypes = array_merge($entityTypes, []);
-}
diff --git a/twingle.php b/twingle.php
index 062152e..f22eafc 100644
--- a/twingle.php
+++ b/twingle.php
@@ -30,24 +30,6 @@ function twingle_civicrm_install() {
_twingle_civix_civicrm_install();
}
-/**
- * Implements hook_civicrm_postInstall().
- *
- * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_postInstall
- */
-function twingle_civicrm_postInstall() {
- _twingle_civix_civicrm_postInstall();
-}
-
-/**
- * Implements hook_civicrm_uninstall().
- *
- * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall
- */
-function twingle_civicrm_uninstall() {
- _twingle_civix_civicrm_uninstall();
-}
-
/**
* Implements hook_civicrm_enable().
*
@@ -57,24 +39,6 @@ function twingle_civicrm_enable() {
_twingle_civix_civicrm_enable();
}
-/**
- * Implements hook_civicrm_disable().
- *
- * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable
- */
-function twingle_civicrm_disable() {
- _twingle_civix_civicrm_disable();
-}
-
-/**
- * Implements hook_civicrm_upgrade().
- *
- * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_upgrade
- */
-function twingle_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) {
- return _twingle_civix_civicrm_upgrade($op, $queue);
-}
-
/**
* Implements hook_civicrm_permission().
*
@@ -137,12 +101,3 @@ function twingle_civicrm_navigationMenu(&$menu) {
));
_twingle_civix_navigationMenu($menu);
} // */
-
-/**
- * Implements hook_civicrm_entityTypes().
- *
- * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_entityTypes
- */
-function twingle_civicrm_entityTypes(&$entityTypes) {
- _twingle_civix_civicrm_entityTypes($entityTypes);
-}