123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539 |
- <?php
- /**
- * Elgg plugins library
- * Contains functions for managing plugins
- *
- * @package Elgg.Core
- * @subpackage Plugins
- */
- /**
- * Tells \ElggPlugin::start() to include the start.php file.
- */
- define('ELGG_PLUGIN_INCLUDE_START', 1);
- /**
- * Tells \ElggPlugin::start() to automatically register the plugin's views.
- */
- define('ELGG_PLUGIN_REGISTER_VIEWS', 2);
- /**
- * Tells \ElggPlugin::start() to automatically register the plugin's languages.
- */
- define('ELGG_PLUGIN_REGISTER_LANGUAGES', 4);
- /**
- * Tells \ElggPlugin::start() to automatically register the plugin's classes.
- */
- define('ELGG_PLUGIN_REGISTER_CLASSES', 8);
- /**
- * Prefix for plugin setting names
- *
- * @todo Can't namespace these because many plugins directly call
- * private settings via $entity->$name.
- */
- //define('ELGG_PLUGIN_SETTING_PREFIX', 'plugin:setting:');
- /**
- * Prefix for plugin user setting names
- */
- define('ELGG_PLUGIN_USER_SETTING_PREFIX', 'plugin:user_setting:');
- /**
- * Internal settings prefix
- *
- * @todo This could be resolved by promoting \ElggPlugin to a 5th type.
- */
- define('ELGG_PLUGIN_INTERNAL_PREFIX', 'elgg:internal:');
- /**
- * Returns a list of plugin directory names from a base directory.
- *
- * @param string $dir A dir to scan for plugins. Defaults to config's plugins_path.
- * Must have a trailing slash.
- *
- * @return array Array of directory names (not full paths)
- * @since 1.8.0
- * @access private
- */
- function _elgg_get_plugin_dirs_in_dir($dir = null) {
- return _elgg_services()->plugins->getDirsInDir($dir);
- }
- /**
- * Discovers plugins in the plugins_path setting and creates \ElggPlugin
- * entities for them if they don't exist. If there are plugins with entities
- * but not actual files, will disable the \ElggPlugin entities and mark as inactive.
- * The \ElggPlugin object holds config data, so don't delete.
- *
- * @return bool
- * @since 1.8.0
- * @access private
- */
- function _elgg_generate_plugin_entities() {
- return _elgg_services()->plugins->generateEntities();
- }
- /**
- * Cache a reference to this plugin by its ID
- *
- * @param \ElggPlugin $plugin
- *
- * @access private
- */
- function _elgg_cache_plugin_by_id(\ElggPlugin $plugin) {
- return _elgg_services()->plugins->cache($plugin);
- }
- /**
- * Returns an \ElggPlugin object with the path $path.
- *
- * @param string $plugin_id The id (dir name) of the plugin. NOT the guid.
- * @return \ElggPlugin|null
- * @since 1.8.0
- */
- function elgg_get_plugin_from_id($plugin_id) {
- return _elgg_services()->plugins->get($plugin_id);
- }
- /**
- * Returns if a plugin exists in the system.
- *
- * @warning This checks only plugins that are registered in the system!
- * If the plugin cache is outdated, be sure to regenerate it with
- * {@link _elgg_generate_plugin_objects()} first.
- *
- * @param string $id The plugin ID.
- * @since 1.8.0
- * @return bool
- */
- function elgg_plugin_exists($id) {
- return _elgg_services()->plugins->exists($id);
- }
- /**
- * Returns the highest priority of the plugins
- *
- * @return int
- * @since 1.8.0
- * @access private
- */
- function _elgg_get_max_plugin_priority() {
- return _elgg_services()->plugins->getMaxPriority();
- }
- /**
- * Returns if a plugin is active for a current site.
- *
- * @param string $plugin_id The plugin ID
- * @param int $site_guid The site guid
- * @since 1.8.0
- * @return bool
- */
- function elgg_is_active_plugin($plugin_id, $site_guid = null) {
- return _elgg_services()->plugins->isActive($plugin_id, $site_guid);
- }
- /**
- * Loads all active plugins in the order specified in the tool admin panel.
- *
- * @note This is called on every page load. If a plugin is active and problematic, it
- * will be disabled and a visible error emitted. This does not check the deps system because
- * that was too slow.
- *
- * @return bool
- * @since 1.8.0
- * @access private
- */
- function _elgg_load_plugins() {
- return _elgg_services()->plugins->load();
- }
- /**
- * Returns an ordered list of plugins
- *
- * @param string $status The status of the plugins. active, inactive, or all.
- * @param mixed $site_guid Optional site guid
- * @return \ElggPlugin[]
- * @since 1.8.0
- */
- function elgg_get_plugins($status = 'active', $site_guid = null) {
- return _elgg_services()->plugins->find($status, $site_guid);
- }
- /**
- * Reorder plugins to an order specified by the array.
- * Plugins not included in this array will be appended to the end.
- *
- * @note This doesn't use the \ElggPlugin->setPriority() method because
- * all plugins are being changed and we don't want it to automatically
- * reorder plugins.
- *
- * @param array $order An array of plugin ids in the order to set them
- * @return bool
- * @since 1.8.0
- * @access private
- */
- function _elgg_set_plugin_priorities(array $order) {
- return _elgg_services()->plugins->setPriorities($order);
- }
- /**
- * Reindexes all plugin priorities starting at 1.
- *
- * @todo Can this be done in a single sql command?
- * @return bool
- * @since 1.8.0
- * @access private
- */
- function _elgg_reindex_plugin_priorities() {
- return _elgg_services()->plugins->reindexPriorities();
- }
- /**
- * Namespaces a string to be used as a private setting name for a plugin.
- *
- * For user_settings, two namespaces are added: a user setting namespace and the
- * plugin id.
- *
- * For internal (plugin priority), there is a single internal namespace added.
- *
- * @param string $type The type of setting: user_setting or internal.
- * @param string $name The name to namespace.
- * @param string $id The plugin's ID to namespace with. Required for user_setting.
- * @return string
- * @since 1.8.0
- * @access private
- */
- function _elgg_namespace_plugin_private_setting($type, $name, $id = null) {
- return _elgg_services()->plugins->namespacePrivateSetting($type, $name, $id);
- }
- /**
- * Returns an array of all provides from all active plugins.
- *
- * Array in the form array(
- * 'provide_type' => array(
- * 'provided_name' => array(
- * 'version' => '1.8',
- * 'provided_by' => 'provider_plugin_id'
- * )
- * )
- * )
- *
- * @param string $type The type of provides to return
- * @param string $name A specific provided name to return. Requires $provide_type.
- *
- * @return array
- * @since 1.8.0
- * @access private
- */
- function _elgg_get_plugins_provides($type = null, $name = null) {
- return _elgg_services()->plugins->getProvides($type, $name);
- }
- /**
- * Deletes all cached data on plugins being provided.
- *
- * @return boolean
- * @since 1.9.0
- * @access private
- */
- function _elgg_invalidate_plugins_provides_cache() {
- return _elgg_services()->plugins->invalidateProvidesCache();
- }
- /**
- * Checks if a plugin is currently providing $type and $name, and optionally
- * checking a version.
- *
- * @param string $type The type of the provide
- * @param string $name The name of the provide
- * @param string $version A version to check against
- * @param string $comparison The comparison operator to use in version_compare()
- *
- * @return array An array in the form array(
- * 'status' => bool Does the provide exist?,
- * 'value' => string The version provided
- * )
- * @since 1.8.0
- * @access private
- */
- function _elgg_check_plugins_provides($type, $name, $version = null, $comparison = 'ge') {
- return _elgg_services()->plugins->checkProvides($type, $name, $version, $comparison);
- }
- /**
- * Returns an array of parsed strings for a dependency in the
- * format: array(
- * 'type' => requires, conflicts, or provides.
- * 'name' => The name of the requirement / conflict
- * 'value' => A string representing the expected value: <1, >=3, !=enabled
- * 'local_value' => The current value, ("Not installed")
- * 'comment' => Free form text to help resovle the problem ("Enable / Search for plugin <link>")
- * )
- *
- * @param array $dep An \ElggPluginPackage dependency array
- * @return array
- * @since 1.8.0
- * @access private
- */
- function _elgg_get_plugin_dependency_strings($dep) {
- return _elgg_services()->plugins->getDependencyStrings($dep);
- }
- /**
- * Returns an array of all plugin user settings for a user.
- *
- * @param int $user_guid The user GUID or 0 for the currently logged in user.
- * @param string $plugin_id The plugin ID (Required)
- * @param bool $return_obj Return settings as an object? This can be used to in reusable
- * views where the settings are passed as $vars['entity'].
- * @return array
- * @since 1.8.0
- * @see \ElggPlugin::getAllUserSettings()
- */
- function elgg_get_all_plugin_user_settings($user_guid = 0, $plugin_id = null, $return_obj = false) {
- return _elgg_services()->plugins->getAllUserSettings($user_guid, $plugin_id, $return_obj);
- }
- /**
- * Set a user specific setting for a plugin.
- *
- * @param string $name The name. Note: cannot be "title".
- * @param mixed $value The value.
- * @param int $user_guid The user GUID or 0 for the currently logged in user.
- * @param string $plugin_id The plugin ID (Required)
- *
- * @return bool
- * @since 1.8.0
- * @see \ElggPlugin::setUserSetting()
- */
- function elgg_set_plugin_user_setting($name, $value, $user_guid = 0, $plugin_id = null) {
- return _elgg_services()->plugins->setUserSetting($name, $value, $user_guid, $plugin_id);
- }
- /**
- * Unsets a user-specific plugin setting
- *
- * @param string $name Name of the setting
- * @param int $user_guid The user GUID or 0 for the currently logged in user.
- * @param string $plugin_id The plugin ID (Required)
- *
- * @return bool
- * @since 1.8.0
- * @see \ElggPlugin::unsetUserSetting()
- */
- function elgg_unset_plugin_user_setting($name, $user_guid = 0, $plugin_id = null) {
- return _elgg_services()->plugins->unsetUserSetting($name, $user_guid, $plugin_id);
- }
- /**
- * Get a user specific setting for a plugin.
- *
- * @param string $name The name of the setting.
- * @param int $user_guid The user GUID or 0 for the currently logged in user.
- * @param string $plugin_id The plugin ID (Required)
- * @param mixed $default The default value to return if none is set
- *
- * @return mixed
- * @since 1.8.0
- * @see \ElggPlugin::getUserSetting()
- */
- function elgg_get_plugin_user_setting($name, $user_guid = 0, $plugin_id = null, $default = null) {
- return _elgg_services()->plugins->getUserSetting($name, $user_guid, $plugin_id, $default);
- }
- /**
- * Set a setting for a plugin.
- *
- * @param string $name The name of the setting - note, can't be "title".
- * @param mixed $value The value.
- * @param string $plugin_id The plugin ID (Required)
- *
- * @return bool
- * @since 1.8.0
- * @see \ElggPlugin::setSetting()
- */
- function elgg_set_plugin_setting($name, $value, $plugin_id = null) {
- return _elgg_services()->plugins->setSetting($name, $value, $plugin_id);
- }
- /**
- * Get setting for a plugin.
- *
- * @param string $name The name of the setting.
- * @param string $plugin_id The plugin ID (Required)
- * @param mixed $default The default value to return if none is set
- *
- * @return mixed
- * @since 1.8.0
- * @see \ElggPlugin::getSetting()
- */
- function elgg_get_plugin_setting($name, $plugin_id = null, $default = null) {
- return _elgg_services()->plugins->getSetting($name, $plugin_id, $default);
- }
- /**
- * Unsets a plugin setting.
- *
- * @param string $name The name of the setting.
- * @param string $plugin_id The plugin ID (Required)
- *
- * @return bool
- * @since 1.8.0
- * @see \ElggPlugin::unsetSetting()
- */
- function elgg_unset_plugin_setting($name, $plugin_id = null) {
- return _elgg_services()->plugins->unsetSetting($name, $plugin_id);
- }
- /**
- * Unsets all plugin settings for a plugin.
- *
- * @param string $plugin_id The plugin ID (Required)
- *
- * @return bool
- * @since 1.8.0
- * @see \ElggPlugin::unsetAllSettings()
- */
- function elgg_unset_all_plugin_settings($plugin_id = null) {
- return _elgg_services()->plugins->unsetAllSettings($plugin_id);
- }
- /**
- * Returns entities based upon plugin user settings.
- * Takes all the options for {@link elgg_get_entities_from_private_settings()}
- * in addition to the ones below.
- *
- * @param array $options Array in the format:
- *
- * plugin_id => STR The plugin id. Required.
- *
- * plugin_user_setting_names => null|ARR private setting names
- *
- * plugin_user_setting_values => null|ARR metadata values
- *
- * plugin_user_setting_name_value_pairs => null|ARR (
- * name => 'name',
- * value => 'value',
- * 'operand' => '=',
- * )
- * Currently if multiple values are sent via
- * an array (value => array('value1', 'value2')
- * the pair's operand will be forced to "IN".
- *
- * plugin_user_setting_name_value_pairs_operator => null|STR The operator to use for combining
- * (name = value) OPERATOR (name = value); default AND
- *
- * @return mixed int If count, int. If not count, array. false on errors.
- * @since 1.8.0
- */
- function elgg_get_entities_from_plugin_user_settings(array $options = array()) {
- return _elgg_services()->plugins->getEntitiesFromUserSettings($options);
- }
- /**
- * Runs unit tests for plugin API.
- *
- * @param string $hook unit_test
- * @param string $type system
- * @param mixed $value Array of tests
- * @param mixed $params Params
- *
- * @return array
- * @access private
- */
- function _elgg_plugins_test($hook, $type, $value, $params) {
- global $CONFIG;
- $value[] = $CONFIG->path . 'engine/tests/ElggCorePluginsAPITest.php';
- return $value;
- }
- /**
- * Checks on deactivate plugin event if disabling it won't create unmet dependencies and blocks disable in such case.
- *
- * @param string $event deactivate
- * @param string $type plugin
- * @param array $params Parameters array containing entry with ELggPlugin instance under 'plugin_entity' key
- * @return bool false to block plugin deactivation action
- *
- * @access private
- */
- function _plugins_deactivate_dependency_check($event, $type, $params) {
- $plugin_id = $params['plugin_entity']->getManifest()->getPluginID();
- $plugin_name = $params['plugin_entity']->getManifest()->getName();
- $active_plugins = elgg_get_plugins();
- $dependents = array();
- foreach ($active_plugins as $plugin) {
- $manifest = $plugin->getManifest();
- $requires = $manifest->getRequires();
- foreach ($requires as $required) {
- if ($required['type'] == 'plugin' && $required['name'] == $plugin_id) {
- // there are active dependents
- $dependents[$manifest->getPluginID()] = $plugin;
- }
- }
- }
- if ($dependents) {
- $list = '<ul>';
- // construct error message and prevent disabling
- foreach ($dependents as $dependent) {
- $list .= '<li>' . $dependent->getManifest()->getName() . '</li>';
- }
- $list .= '</ul>';
- register_error(elgg_echo('ElggPlugin:Dependencies:ActiveDependent', array($plugin_name, $list)));
- return false;
- }
- }
- /**
- * Initialize the plugin system
- *
- * @return void
- * @access private
- */
- function _elgg_plugins_init() {
- if (elgg_is_admin_logged_in()) {
- elgg_register_ajax_view('object/plugin/full');
- }
- elgg_register_plugin_hook_handler('unit_test', 'system', '_elgg_plugins_test');
- // note - plugins are booted by the time this handler is registered
- // deactivation due to error may have already occurred
- elgg_register_event_handler('deactivate', 'plugin', '_plugins_deactivate_dependency_check');
- /**
- * @see \Elgg\Database\Plugins::invalidateIsActiveCache
- */
- $svc = _elgg_services()->plugins;
- elgg_register_event_handler('deactivate', 'plugin', array($svc, 'invalidateIsActiveCache'));
- elgg_register_event_handler('activate', 'plugin', array($svc, 'invalidateIsActiveCache'));
- elgg_register_action("plugins/settings/save", '', 'admin');
- elgg_register_action("plugins/usersettings/save");
- elgg_register_action('admin/plugins/activate', '', 'admin');
- elgg_register_action('admin/plugins/deactivate', '', 'admin');
- elgg_register_action('admin/plugins/activate_all', '', 'admin');
- elgg_register_action('admin/plugins/deactivate_all', '', 'admin');
- elgg_register_action('admin/plugins/set_priority', '', 'admin');
- elgg_register_library('elgg:markdown', elgg_get_root_path() . 'vendors/markdown/markdown.php');
- }
- return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
- $events->registerHandler('init', 'system', '_elgg_plugins_init');
- };
|