-
Notifications
You must be signed in to change notification settings - Fork 0
Backport: add mixin polyfill to support CiviCRM 5.75+ #21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| <?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[$longName][$mixin])) { | ||
| \Civi::$statics[$longName][$mixin] = 1; | ||
| $func = $_CIVIX_MIXIN_POLYFILL[$mixin]; | ||
| $func($mixInfo, $bootCache); | ||
| } | ||
| } | ||
| }; | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
WARNING: The PR title (and likely the commit message) does not follow the required format
CIVIMM-###:. Please update it to include the relevant ticket number (e.g.,CIVIMM-20: Backport: add mixin polyfill to support CiviCRM 5.75+) as per the repository style guide (rule 25).References