Plugin::checkIsPluginUpgraded() - Code Metrics - Inspection of "Fixed PHPStan errors" - GraphQLAPI/graphql-api-for-wp - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ed3c2e...98ec12 )

by Leonardo

created 2020-09-21 14:43 UTC

Plugin::checkIsPluginUpgraded() A

↳ Parent: Plugin

Complexity

Conditions	5
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	30

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	5
eloc	5
c	1
b	0
f	0
nc	2
nop	2
dl	0
loc	10
ccs	0
cts	5
cp	0
crap	30
rs	9.6111

<?php

declare(strict_types=1);

namespace GraphQLAPI\GraphQLAPI;

use PoP\Engine\ComponentLoader;
use GraphQLAPI\GraphQLAPI\PluginConfiguration;
use GraphQLAPI\GraphQLAPI\Blocks\AbstractBlock;
use GraphQLAPI\GraphQLAPI\General\RequestParams;
use GraphQLAPI\GraphQLAPI\Admin\Menus\AbstractMenu;
use GraphQLAPI\GraphQLAPI\PostTypes\AbstractPostType;
use GraphQLAPI\GraphQLAPI\Taxonomies\AbstractTaxonomy;
use GraphQLAPI\GraphQLAPI\Facades\ModuleRegistryFacade;
use PoP\ComponentModel\Container\ContainerBuilderUtils;
use GraphQLAPI\GraphQLAPI\Admin\MenuPages\AboutMenuPage;
use GraphQLAPI\GraphQLAPI\Admin\MenuPages\ModulesMenuPage;
use GraphQLAPI\GraphQLAPI\Facades\UserSettingsManagerFacade;
use GraphQLAPI\GraphQLAPI\PostTypes\GraphQLEndpointPostType;
use GraphQLAPI\GraphQLAPI\EditorScripts\AbstractEditorScript;
use PoP\ComponentModel\Facades\Instances\InstanceManagerFacade;
use GraphQLAPI\GraphQLAPI\BlockCategories\AbstractBlockCategory;
use GraphQLAPI\GraphQLAPI\PostTypes\GraphQLPersistedQueryPostType;
use GraphQLAPI\GraphQLAPI\Admin\TableActions\ModuleListTableAction;
use GraphQLAPI\GraphQLAPI\PostTypes\GraphQLCacheControlListPostType;
use GraphQLAPI\GraphQLAPI\EndpointResolvers\AbstractEndpointResolver;
use GraphQLAPI\GraphQLAPI\PostTypes\GraphQLAccessControlListPostType;
use GraphQLAPI\GraphQLAPI\PostTypes\GraphQLSchemaConfigurationPostType;
use GraphQLAPI\GraphQLAPI\PostTypes\GraphQLFieldDeprecationListPostType;
use GraphQLAPI\GraphQLAPI\ModuleResolvers\EndpointFunctionalityModuleResolver;
use GraphQLAPI\GraphQLAPI\ModuleResolvers\VersioningFunctionalityModuleResolver;
use GraphQLAPI\GraphQLAPI\ModuleResolvers\PerformanceFunctionalityModuleResolver;
use GraphQLAPI\GraphQLAPI\ModuleResolvers\AccessControlFunctionalityModuleResolver;
use GraphQLAPI\GraphQLAPI\ModuleResolvers\UserInterfaceFunctionalityModuleResolver;
use GraphQLAPI\GraphQLAPI\Blocks\AccessControlRuleBlocks\AccessControlUserRolesBlock;
use GraphQLAPI\GraphQLAPI\Blocks\AccessControlRuleBlocks\AccessControlUserStateBlock;
use GraphQLAPI\GraphQLAPI\Blocks\AccessControlRuleBlocks\AccessControlDisableAccessBlock;
use GraphQLAPI\GraphQLAPI\ModuleResolvers\SchemaConfigurationFunctionalityModuleResolver;
use GraphQLAPI\GraphQLAPI\Blocks\AccessControlRuleBlocks\AccessControlUserCapabilitiesBlock;
use WP_Upgrader;
class Plugin
{
    /**
     * Plugin's namespace
     */
    public const NAMESPACE = __NAMESPACE__;

    /**
     * Transient to indicate if plugin was just updated
     */
    public const TRANSIENT_PLUGIN_UPDATED = 'graphql-api-plugin-updated';

    /**
     * Plugin set-up, executed immediately when loading the plugin.
     * There are three stages for this plugin, and for each extension plugin:
     * `setup`, `initialize` and `boot`.
     *
     * This is because:
     *
     * - The plugin must execute its logic before the extensions
     * - The services can't be booted before all services have been initialized
     *
     * To attain the needed order, we execute them using hook "plugins_loaded":
     *
     * 1. GraphQL API => setup(): immediately
     * 2. GraphQL API extensions => setup(): priority 0
     * 3. GraphQL API => initialize(): priority 5
     * 4. GraphQL API extensions => initialize(): priority 10
     * 5. GraphQL API => boot(): priority 15
     * 6. GraphQL API extensions => boot(): priority 20
     *
     * @return void
     */
    public function setup(): void
    {
        // Functions to execute when activating/deactivating the plugin
        \register_deactivation_hook(\GRAPHQL_API_PLUGIN_FILE, [$this, 'deactivate']);
        /**
         * PoP depends on hook "init" to set-up the endpoint rewrite,
         * as in function `addRewriteEndpoints` in `AbstractEndpointHandler`
         * However, activating the plugin takes place AFTER hooks "plugins_loaded"
         * and "init". Hence, the code cannot flush the rewrite_rules when the plugin
         * is activated, and any non-default GraphQL endpoint is not set.
         *
         * The solution (hack) is to check if the plugin has just been installed,
         * and then apply the logic, on every request in the admin!
         *
         * @see https://developer.wordpress.org/reference/functions/register_activation_hook/#process-flow
         */
        $isPluginJustActivatedOptionName = 'graphql-api-activated-plugin';
        \register_activation_hook(
            \GRAPHQL_API_PLUGIN_FILE,
            function () use ($isPluginJustActivatedOptionName): void {
                // Flag to indicate that the plugin has been activated
                \add_option($isPluginJustActivatedOptionName, true);
                // This is the proper activation logic
                $this->activate();
            }
        );
        \add_action(
            'admin_init',
            function () use ($isPluginJustActivatedOptionName): void {
                // If the flag is there, it's the first screen after activating the plugin
                if (\is_admin() && \get_option($isPluginJustActivatedOptionName) == true) {
                    // Delete the flag
                    \delete_option($isPluginJustActivatedOptionName);
                    // Required logic after plugin is activated
                    \flush_rewrite_rules();
                }

                // On updates only: Show a link to view the new version's release notes
                // Check if there is a transient indicating that the plugin was updated
                if (\get_transient(self::TRANSIENT_PLUGIN_UPDATED)) {
                    delete_transient(self::TRANSIENT_PLUGIN_UPDATED);
                    $this->showReleaseNotesInAdminNotice();
                }
            }
        );
        /**
         * On updates only: Show a link to view the new version's release notes
         *
         * @see https://codex.wordpress.org/Plugin_API/Action_Reference/upgrader_process_complete
         */
        add_action(
            'upgrader_process_complete',
            [$this, 'checkIsPluginUpgraded'],
            10,
            2
        );

        /**
         * Wait until "plugins_loaded" to initialize the plugin, because:
         *
         * - ModuleListTableAction requires `wp_verify_nonce`, loaded in pluggable.php
         * - Allow other plugins to inject their own functionality
         */
        \add_action('plugins_loaded', [$this, 'initialize'], 5);
        \add_action('plugins_loaded', [$this, 'boot'], 15);
    }

    /**
     * This function runs when WordPress completes its upgrade process
     * If this plugin is updated, it sets a transient flag
     *
     * @param array<string, mixed> $options
     * @see https://codex.wordpress.org/Plugin_API/Action_Reference/upgrader_process_complete
     */
    protected function checkIsPluginUpgraded(WP_Upgrader $upgrader_object, array $options): void
    {
        // If an update has taken place and the updated type is plugins and the plugins element exists
        if ($options['action'] == 'update'
            && $options['type'] == 'plugin'
            && isset($options['plugins'])
            && in_array(\GRAPHQL_API_BASE_NAME, $options['plugins'])
        ) {
            // Set a transient to record that the plugin has just been updated
            set_transient(self::TRANSIENT_PLUGIN_UPDATED, 1);
        }
    }

    /**
     * Add a notice with a link to the latest release note,
     * to open in a modal window
     */
    protected function showReleaseNotesInAdminNotice(): void
    {
        // Load the assets to open in a modal
        \add_action('admin_enqueue_scripts', function () {
            /**
             * Hack to open the modal thickbox iframe with the documentation
             */
            \wp_enqueue_style(
                'thickbox'
            );
            \wp_enqueue_script(
                'plugin-install'
            );
        });
        // Add the admin notice
        \add_action('admin_notices', function () {
            $instanceManager = InstanceManagerFacade::getInstance();
            /**
             * @var AboutMenuPage
             */
            $aboutMenuPage = $instanceManager->getInstance(AboutMenuPage::class);
            // Calculate the minor release version.
            // Eg: if current version is 0.6.3, minor version is 0.6
            $versionParts = explode('.', \GRAPHQL_API_VERSION);
            $minorReleaseVersion = $versionParts[0] . '.' . $versionParts[1];
            $url = \admin_url(sprintf(
                'admin.php?page=%s&%s=%s&%s=%s&TB_iframe=true',
                $aboutMenuPage->getScreenID(),
                RequestParams::TAB,
                RequestParams::TAB_DOCS,
                RequestParams::DOC,
                sprintf(
                    'release-notes/%s.md',
                    $minorReleaseVersion
                )
            ));
            _e(sprintf(
                '<div class="notice notice-success is-dismissible">' .
                '<p>%s</p>' .
                '</div>',
                sprintf(
                    __('Plugin <strong>GraphQL API for WordPress</strong> has been updated to version <code>%s</code>. <a href="%s" class="%s">Check out what\'s new</a>.', 'graphql-api'),
                    \GRAPHQL_API_VERSION,
                    $url,
                    'thickbox open-plugin-details-modal'
                )
            ));
        });
    }

    /**
     * Plugin initialization, executed on hook "plugins_loaded"
     * to wait for all extensions to be loaded
     *
     * @return void
     */
    public function initialize(): void
    {
        /**
         * Watch out! If we are in the Modules page and enabling/disabling
         * a module, then already take that new state!
         * This is because `maybeProcessAction`, which is where modules are
         * enabled/disabled, must be executed before PluginConfiguration::initialize(),
         * which is where the plugin reads if a module is enabled/disabled as to
         * set the environment constants.
         *
         * This is mandatory, because only when it is enabled, can a module
         * have its state persisted when calling `flush_rewrite`
         */
        if (\is_admin()) {
            // We can't use the InstanceManager, since at this stage it hasn't
            // been initialized yet
            // We can create a new instances of ModulesMenuPage because
            // its instantiation produces no side-effects
            $modulesMenuPage = new ModulesMenuPage();
            if (isset($_GET['page']) && $_GET['page'] == $modulesMenuPage->getScreenID()) {
                // Instantiating ModuleListTableAction DOES have side-effects,
                // but they are needed, and won't be repeated when instantiating
                // the class through the Container Builder
                $moduleListTable = new ModuleListTableAction();
                $moduleListTable->maybeProcessAction();
            }
        }

        // Configure the plugin. This defines hooks to set environment variables,
        // so must be executed
        // before those hooks are triggered for first time
        // (in ComponentConfiguration classes)
        PluginConfiguration::initialize();

        // Component configuration
        $componentClassConfiguration = PluginConfiguration::getComponentClassConfiguration();
        $skipSchemaComponentClasses = PluginConfiguration::getSkippingSchemaComponentClasses();

        // Initialize the plugin's Component and, with it,
        // all its dependencies from PoP
        ComponentLoader::initializeComponents(
            [
                \GraphQLAPI\GraphQLAPI\Component::class,
            ],
            $componentClassConfiguration,
            $skipSchemaComponentClasses
        );
    }

    /**
     * Plugin initialization, executed on hook "plugins_loaded"
     * to wait for all extensions to be loaded
     */
    public function boot(): void
    {
        // Boot all PoP components, from this plugin and all extensions
        ComponentLoader::bootComponents();

        $instanceManager = InstanceManagerFacade::getInstance();
        $moduleRegistry = ModuleRegistryFacade::getInstance();
        /**
         * Initialize classes for the admin panel
         */
        if (\is_admin()) {
            /**
             * Initialize all the services
             */
            $menuServiceClasses = ContainerBuilderUtils::getServiceClassesUnderNamespace(__NAMESPACE__ . '\\Admin\\Menus');
            foreach ($menuServiceClasses as $serviceClass) {
                /**
                 * @var AbstractMenu
                 */
                $service = $instanceManager->getInstance($serviceClass);
                $service->initialize();
            }
            $endpointResolverServiceClasses = ContainerBuilderUtils::getServiceClassesUnderNamespace(__NAMESPACE__ . '\\Admin\\EndpointResolvers');
            foreach ($endpointResolverServiceClasses as $serviceClass) {
                /**
                 * @var AbstractEndpointResolver
                 */
                $service = $instanceManager->getInstance($serviceClass);
                $service->initialize();
            }
        }

        /**
         * Taxonomies must be initialized before Post Types
         */
        $taxonomyServiceClasses = ContainerBuilderUtils::getServiceClassesUnderNamespace(__NAMESPACE__ . '\\Taxonomies');
        foreach ($taxonomyServiceClasses as $serviceClass) {
            /**
             * @var AbstractTaxonomy
             */
            $service = $instanceManager->getInstance($serviceClass);
            $service->initialize();
        }
        /**
         * Initialize Post Types manually to control in what order they are added to the menu
         */
        $postTypeServiceClassModules = [
            GraphQLEndpointPostType::class => EndpointFunctionalityModuleResolver::CUSTOM_ENDPOINTS,
            GraphQLPersistedQueryPostType::class => EndpointFunctionalityModuleResolver::PERSISTED_QUERIES,
            GraphQLSchemaConfigurationPostType::class => SchemaConfigurationFunctionalityModuleResolver::SCHEMA_CONFIGURATION,
            GraphQLAccessControlListPostType::class => AccessControlFunctionalityModuleResolver::ACCESS_CONTROL,
            GraphQLCacheControlListPostType::class => PerformanceFunctionalityModuleResolver::CACHE_CONTROL,
            GraphQLFieldDeprecationListPostType::class => VersioningFunctionalityModuleResolver::FIELD_DEPRECATION,
        ];
        foreach ($postTypeServiceClassModules as $serviceClass => $module) {
            // Check that the corresponding module is enabled
            if ($moduleRegistry->isModuleEnabled($module)) {
                /**
                 * @var AbstractPostType
                 */
                $service = $instanceManager->getInstance($serviceClass);
                $service->initialize();
            }
        }
        /**
         * Editor Scripts
         * They are all used to show the Welcome Guide
         */
        if ($moduleRegistry->isModuleEnabled(UserInterfaceFunctionalityModuleResolver::WELCOME_GUIDES)) {
            $editorScriptServiceClasses = ContainerBuilderUtils::getServiceClassesUnderNamespace(__NAMESPACE__ . '\\EditorScripts');
            foreach ($editorScriptServiceClasses as $serviceClass) {
                /**
                 * @var AbstractEditorScript
                 */
                $service = $instanceManager->getInstance($serviceClass);
                $service->initialize();
            }
        }
        /**
         * Blocks
         * The GraphiQL Block may be overriden to GraphiQLWithExplorerBlock
         */
        $blockServiceClasses = ContainerBuilderUtils::getServiceClassesUnderNamespace(__NAMESPACE__ . '\\Blocks', false);
        foreach ($blockServiceClasses as $serviceClass) {
            /**
             * @var AbstractBlock
             */
            $service = $instanceManager->getInstance($serviceClass);
            $service->initialize();
        }
        /**
         * Access Control Nested Blocks
         * Register them one by one, as to disable them if module is disabled
         */
        $accessControlRuleBlockServiceClassModules = [
            AccessControlDisableAccessBlock::class => AccessControlFunctionalityModuleResolver::ACCESS_CONTROL_RULE_DISABLE_ACCESS,
            AccessControlUserStateBlock::class => AccessControlFunctionalityModuleResolver::ACCESS_CONTROL_RULE_USER_STATE,
            AccessControlUserRolesBlock::class => AccessControlFunctionalityModuleResolver::ACCESS_CONTROL_RULE_USER_ROLES,
            AccessControlUserCapabilitiesBlock::class => AccessControlFunctionalityModuleResolver::ACCESS_CONTROL_RULE_USER_CAPABILITIES,
        ];
        foreach ($accessControlRuleBlockServiceClassModules as $serviceClass => $module) {
            if ($moduleRegistry->isModuleEnabled($module)) {
                /**
                 * @var AbstractBlock
                 */
                $service = $instanceManager->getInstance($serviceClass);
                $service->initialize();
            }
        }
        /**
         * Block categories
         */
        $blockCategoryServiceClasses = ContainerBuilderUtils::getServiceClassesUnderNamespace(__NAMESPACE__ . '\\BlockCategories');
        foreach ($blockCategoryServiceClasses as $serviceClass) {
            /**
             * @var AbstractBlockCategory
             */
            $service = $instanceManager->getInstance($serviceClass);
            $service->initialize();
        }
    }

    /**
     * Get permalinks to work when activating the plugin
     *
     * @see    https://codex.wordpress.org/Function_Reference/register_post_type#Flushing_Rewrite_on_Activation
     * @return void
     */
    public function activate(): void
    {
        // Initialize the timestamp
        $userSettingsManager = UserSettingsManagerFacade::getInstance();
        $userSettingsManager->storeTimestamp();
    }

    /**
     * Remove permalinks when deactivating the plugin
     *
     * @see    https://developer.wordpress.org/plugins/plugin-basics/activation-deactivation-hooks/
     * @return void
     */
    public function deactivate(): void
    {
        // First, unregister the post type, so the rules are no longer in memory.
        $instanceManager = InstanceManagerFacade::getInstance();
        $postTypeObjects = array_map(
            function ($serviceClass) use ($instanceManager): AbstractPostType {
                /**
                 * @var AbstractPostType
                 */
                $postTypeObject = $instanceManager->getInstance($serviceClass);
                return $postTypeObject;
            },
            ContainerBuilderUtils::getServiceClassesUnderNamespace(__NAMESPACE__ . '\\PostTypes')
        );
        foreach ($postTypeObjects as $postTypeObject) {
            $postTypeObject->unregisterPostType();
        }

        // Then, clear the permalinks to remove the post type's rules from the database.
        \flush_rewrite_rules();

        // Remove the timestamp
        $userSettingsManager = UserSettingsManagerFacade::getInstance();
        $userSettingsManager->removeTimestamp();
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace GraphQLAPI\GraphQLAPI;
6
7			use PoP\Engine\ComponentLoader;
8			use GraphQLAPI\GraphQLAPI\PluginConfiguration;
9			use GraphQLAPI\GraphQLAPI\Blocks\AbstractBlock;
10			use GraphQLAPI\GraphQLAPI\General\RequestParams;
11			use GraphQLAPI\GraphQLAPI\Admin\Menus\AbstractMenu;
12			use GraphQLAPI\GraphQLAPI\PostTypes\AbstractPostType;
13			use GraphQLAPI\GraphQLAPI\Taxonomies\AbstractTaxonomy;
14			use GraphQLAPI\GraphQLAPI\Facades\ModuleRegistryFacade;
15			use PoP\ComponentModel\Container\ContainerBuilderUtils;
16			use GraphQLAPI\GraphQLAPI\Admin\MenuPages\AboutMenuPage;
17			use GraphQLAPI\GraphQLAPI\Admin\MenuPages\ModulesMenuPage;
18			use GraphQLAPI\GraphQLAPI\Facades\UserSettingsManagerFacade;
19			use GraphQLAPI\GraphQLAPI\PostTypes\GraphQLEndpointPostType;
20			use GraphQLAPI\GraphQLAPI\EditorScripts\AbstractEditorScript;
21			use PoP\ComponentModel\Facades\Instances\InstanceManagerFacade;
22			use GraphQLAPI\GraphQLAPI\BlockCategories\AbstractBlockCategory;
23			use GraphQLAPI\GraphQLAPI\PostTypes\GraphQLPersistedQueryPostType;
24			use GraphQLAPI\GraphQLAPI\Admin\TableActions\ModuleListTableAction;
25			use GraphQLAPI\GraphQLAPI\PostTypes\GraphQLCacheControlListPostType;
26			use GraphQLAPI\GraphQLAPI\EndpointResolvers\AbstractEndpointResolver;
27			use GraphQLAPI\GraphQLAPI\PostTypes\GraphQLAccessControlListPostType;
28			use GraphQLAPI\GraphQLAPI\PostTypes\GraphQLSchemaConfigurationPostType;
29			use GraphQLAPI\GraphQLAPI\PostTypes\GraphQLFieldDeprecationListPostType;
30			use GraphQLAPI\GraphQLAPI\ModuleResolvers\EndpointFunctionalityModuleResolver;
31			use GraphQLAPI\GraphQLAPI\ModuleResolvers\VersioningFunctionalityModuleResolver;
32			use GraphQLAPI\GraphQLAPI\ModuleResolvers\PerformanceFunctionalityModuleResolver;
33			use GraphQLAPI\GraphQLAPI\ModuleResolvers\AccessControlFunctionalityModuleResolver;
34			use GraphQLAPI\GraphQLAPI\ModuleResolvers\UserInterfaceFunctionalityModuleResolver;
35			use GraphQLAPI\GraphQLAPI\Blocks\AccessControlRuleBlocks\AccessControlUserRolesBlock;
36			use GraphQLAPI\GraphQLAPI\Blocks\AccessControlRuleBlocks\AccessControlUserStateBlock;
37			use GraphQLAPI\GraphQLAPI\Blocks\AccessControlRuleBlocks\AccessControlDisableAccessBlock;
38			use GraphQLAPI\GraphQLAPI\ModuleResolvers\SchemaConfigurationFunctionalityModuleResolver;
39			use GraphQLAPI\GraphQLAPI\Blocks\AccessControlRuleBlocks\AccessControlUserCapabilitiesBlock;
40			use WP_Upgrader;
41			class Plugin
42			{
43			/**
44			* Plugin's namespace
45			*/
46			public const NAMESPACE = __NAMESPACE__;
47
48			/**
49			* Transient to indicate if plugin was just updated
50			*/
51			public const TRANSIENT_PLUGIN_UPDATED = 'graphql-api-plugin-updated';
52
53			/**
54			* Plugin set-up, executed immediately when loading the plugin.
55			* There are three stages for this plugin, and for each extension plugin:
56			* `setup`, `initialize` and `boot`.
57			*
58			* This is because:
59			*
60			* - The plugin must execute its logic before the extensions
61			* - The services can't be booted before all services have been initialized
62			*
63			* To attain the needed order, we execute them using hook "plugins_loaded":
64			*
65			* 1. GraphQL API => setup(): immediately
66			* 2. GraphQL API extensions => setup(): priority 0
67			* 3. GraphQL API => initialize(): priority 5
68			* 4. GraphQL API extensions => initialize(): priority 10
69			* 5. GraphQL API => boot(): priority 15
70			* 6. GraphQL API extensions => boot(): priority 20
71			*
72			* @return void
73			*/
74			public function setup(): void
75			{
76			// Functions to execute when activating/deactivating the plugin
77			\register_deactivation_hook(\GRAPHQL_API_PLUGIN_FILE, [$this, 'deactivate']);
78			/**
79			* PoP depends on hook "init" to set-up the endpoint rewrite,
80			* as in function `addRewriteEndpoints` in `AbstractEndpointHandler`
81			* However, activating the plugin takes place AFTER hooks "plugins_loaded"
82			* and "init". Hence, the code cannot flush the rewrite_rules when the plugin
83			* is activated, and any non-default GraphQL endpoint is not set.
84			*
85			* The solution (hack) is to check if the plugin has just been installed,
86			* and then apply the logic, on every request in the admin!
87			*
88			* @see https://developer.wordpress.org/reference/functions/register_activation_hook/#process-flow
89			*/
90			$isPluginJustActivatedOptionName = 'graphql-api-activated-plugin';
91			\register_activation_hook(
92			\GRAPHQL_API_PLUGIN_FILE,
93			function () use ($isPluginJustActivatedOptionName): void {
94			// Flag to indicate that the plugin has been activated
95			\add_option($isPluginJustActivatedOptionName, true);
96			// This is the proper activation logic
97			$this->activate();
98			}
99			);
100			\add_action(
101			'admin_init',
102			function () use ($isPluginJustActivatedOptionName): void {
103			// If the flag is there, it's the first screen after activating the plugin
104			if (\is_admin() && \get_option($isPluginJustActivatedOptionName) == true) {
105			// Delete the flag
106			\delete_option($isPluginJustActivatedOptionName);
107			// Required logic after plugin is activated
108			\flush_rewrite_rules();
109			}
110
111			// On updates only: Show a link to view the new version's release notes
112			// Check if there is a transient indicating that the plugin was updated
113			if (\get_transient(self::TRANSIENT_PLUGIN_UPDATED)) {
114			delete_transient(self::TRANSIENT_PLUGIN_UPDATED);
115			$this->showReleaseNotesInAdminNotice();
116			}
117			}
118			);
119			/**
120			* On updates only: Show a link to view the new version's release notes
121			*
122			* @see https://codex.wordpress.org/Plugin_API/Action_Reference/upgrader_process_complete
123			*/
124			add_action(
125			'upgrader_process_complete',
126			[$this, 'checkIsPluginUpgraded'],
127			10,
128			2
129			);
130
131			/**
132			* Wait until "plugins_loaded" to initialize the plugin, because:
133			*
134			* - ModuleListTableAction requires `wp_verify_nonce`, loaded in pluggable.php
135			* - Allow other plugins to inject their own functionality
136			*/
137			\add_action('plugins_loaded', [$this, 'initialize'], 5);
138			\add_action('plugins_loaded', [$this, 'boot'], 15);
139			}
140
141			/**
142			* This function runs when WordPress completes its upgrade process
143			* If this plugin is updated, it sets a transient flag
144			*
145			* @param array<string, mixed> $options
146			* @see https://codex.wordpress.org/Plugin_API/Action_Reference/upgrader_process_complete
147			*/
148			protected function checkIsPluginUpgraded(WP_Upgrader $upgrader_object, array $options): void
149			{
150			// If an update has taken place and the updated type is plugins and the plugins element exists
151			if ($options['action'] == 'update'
152			&& $options['type'] == 'plugin'
153			&& isset($options['plugins'])
154			&& in_array(\GRAPHQL_API_BASE_NAME, $options['plugins'])
155			) {
156			// Set a transient to record that the plugin has just been updated
157			set_transient(self::TRANSIENT_PLUGIN_UPDATED, 1);
158			}
159			}
160
161			/**
162			* Add a notice with a link to the latest release note,
163			* to open in a modal window
164			*/
165			protected function showReleaseNotesInAdminNotice(): void
166			{
167			// Load the assets to open in a modal
168			\add_action('admin_enqueue_scripts', function () {
169			/**
170			* Hack to open the modal thickbox iframe with the documentation
171			*/
172			\wp_enqueue_style(
173			'thickbox'
174			);
175			\wp_enqueue_script(
176			'plugin-install'
177			);
178			});
179			// Add the admin notice
180			\add_action('admin_notices', function () {
181			$instanceManager = InstanceManagerFacade::getInstance();
182			/**
183			* @var AboutMenuPage
184			*/
185			$aboutMenuPage = $instanceManager->getInstance(AboutMenuPage::class);
186			// Calculate the minor release version.
187			// Eg: if current version is 0.6.3, minor version is 0.6
188			$versionParts = explode('.', \GRAPHQL_API_VERSION);
189			$minorReleaseVersion = $versionParts[0] . '.' . $versionParts[1];
190			$url = \admin_url(sprintf(
191			'admin.php?page=%s&%s=%s&%s=%s&TB_iframe=true',
192			$aboutMenuPage->getScreenID(),
193			RequestParams::TAB,
194			RequestParams::TAB_DOCS,
195			RequestParams::DOC,
196			sprintf(
197			'release-notes/%s.md',
198			$minorReleaseVersion
199			)
200			));
201			_e(sprintf(
202			'<div class="notice notice-success is-dismissible">' .
203			'<p>%s</p>' .
204			'</div>',
205			sprintf(
206			__('Plugin <strong>GraphQL API for WordPress</strong> has been updated to version <code>%s</code>. <a href="%s" class="%s">Check out what\'s new</a>.', 'graphql-api'),
207			\GRAPHQL_API_VERSION,
208			$url,
209			'thickbox open-plugin-details-modal'
210			)
211			));
212			});
213			}
214
215			/**
216			* Plugin initialization, executed on hook "plugins_loaded"
217			* to wait for all extensions to be loaded
218			*
219			* @return void
220			*/
221			public function initialize(): void
222			{
223			/**
224			* Watch out! If we are in the Modules page and enabling/disabling
225			* a module, then already take that new state!
226			* This is because `maybeProcessAction`, which is where modules are
227			* enabled/disabled, must be executed before PluginConfiguration::initialize(),
228			* which is where the plugin reads if a module is enabled/disabled as to
229			* set the environment constants.
230			*
231			* This is mandatory, because only when it is enabled, can a module
232			* have its state persisted when calling `flush_rewrite`
233			*/
234			if (\is_admin()) {
235			// We can't use the InstanceManager, since at this stage it hasn't
236			// been initialized yet
237			// We can create a new instances of ModulesMenuPage because
238			// its instantiation produces no side-effects
239			$modulesMenuPage = new ModulesMenuPage();
240			if (isset($_GET['page']) && $_GET['page'] == $modulesMenuPage->getScreenID()) {
241			// Instantiating ModuleListTableAction DOES have side-effects,
242			// but they are needed, and won't be repeated when instantiating
243			// the class through the Container Builder
244			$moduleListTable = new ModuleListTableAction();
245			$moduleListTable->maybeProcessAction();
246			}
247			}
248
249			// Configure the plugin. This defines hooks to set environment variables,
250			// so must be executed
251			// before those hooks are triggered for first time
252			// (in ComponentConfiguration classes)
253			PluginConfiguration::initialize();
254
255			// Component configuration
256			$componentClassConfiguration = PluginConfiguration::getComponentClassConfiguration();
257			$skipSchemaComponentClasses = PluginConfiguration::getSkippingSchemaComponentClasses();
258
259			// Initialize the plugin's Component and, with it,
260			// all its dependencies from PoP
261			ComponentLoader::initializeComponents(
262			[
263			\GraphQLAPI\GraphQLAPI\Component::class,
264			],
265			$componentClassConfiguration,
266			$skipSchemaComponentClasses
267			);
268			}
269
270			/**
271			* Plugin initialization, executed on hook "plugins_loaded"
272			* to wait for all extensions to be loaded
273			*/
274			public function boot(): void
275			{
276			// Boot all PoP components, from this plugin and all extensions
277			ComponentLoader::bootComponents();
278
279			$instanceManager = InstanceManagerFacade::getInstance();
280			$moduleRegistry = ModuleRegistryFacade::getInstance();
281			/**
282			* Initialize classes for the admin panel
283			*/
284			if (\is_admin()) {
285			/**
286			* Initialize all the services
287			*/
288			$menuServiceClasses = ContainerBuilderUtils::getServiceClassesUnderNamespace(__NAMESPACE__ . '\\Admin\\Menus');
289			foreach ($menuServiceClasses as $serviceClass) {
290			/**
291			* @var AbstractMenu
292			*/
293			$service = $instanceManager->getInstance($serviceClass);
294			$service->initialize();
295			}
296			$endpointResolverServiceClasses = ContainerBuilderUtils::getServiceClassesUnderNamespace(__NAMESPACE__ . '\\Admin\\EndpointResolvers');
297			foreach ($endpointResolverServiceClasses as $serviceClass) {
298			/**
299			* @var AbstractEndpointResolver
300			*/
301			$service = $instanceManager->getInstance($serviceClass);
302			$service->initialize();
303			}
304			}
305
306			/**
307			* Taxonomies must be initialized before Post Types
308			*/
309			$taxonomyServiceClasses = ContainerBuilderUtils::getServiceClassesUnderNamespace(__NAMESPACE__ . '\\Taxonomies');
310			foreach ($taxonomyServiceClasses as $serviceClass) {
311			/**
312			* @var AbstractTaxonomy
313			*/
314			$service = $instanceManager->getInstance($serviceClass);
315			$service->initialize();
316			}
317			/**
318			* Initialize Post Types manually to control in what order they are added to the menu
319			*/
320			$postTypeServiceClassModules = [
321			GraphQLEndpointPostType::class => EndpointFunctionalityModuleResolver::CUSTOM_ENDPOINTS,
322			GraphQLPersistedQueryPostType::class => EndpointFunctionalityModuleResolver::PERSISTED_QUERIES,
323			GraphQLSchemaConfigurationPostType::class => SchemaConfigurationFunctionalityModuleResolver::SCHEMA_CONFIGURATION,
324			GraphQLAccessControlListPostType::class => AccessControlFunctionalityModuleResolver::ACCESS_CONTROL,
325			GraphQLCacheControlListPostType::class => PerformanceFunctionalityModuleResolver::CACHE_CONTROL,
326			GraphQLFieldDeprecationListPostType::class => VersioningFunctionalityModuleResolver::FIELD_DEPRECATION,
327			];
328			foreach ($postTypeServiceClassModules as $serviceClass => $module) {
329			// Check that the corresponding module is enabled
330			if ($moduleRegistry->isModuleEnabled($module)) {
331			/**
332			* @var AbstractPostType
333			*/
334			$service = $instanceManager->getInstance($serviceClass);
335			$service->initialize();
336			}
337			}
338			/**
339			* Editor Scripts
340			* They are all used to show the Welcome Guide
341			*/
342			if ($moduleRegistry->isModuleEnabled(UserInterfaceFunctionalityModuleResolver::WELCOME_GUIDES)) {
343			$editorScriptServiceClasses = ContainerBuilderUtils::getServiceClassesUnderNamespace(__NAMESPACE__ . '\\EditorScripts');
344			foreach ($editorScriptServiceClasses as $serviceClass) {
345			/**
346			* @var AbstractEditorScript
347			*/
348			$service = $instanceManager->getInstance($serviceClass);
349			$service->initialize();
350			}
351			}
352			/**
353			* Blocks
354			* The GraphiQL Block may be overriden to GraphiQLWithExplorerBlock
355			*/
356			$blockServiceClasses = ContainerBuilderUtils::getServiceClassesUnderNamespace(__NAMESPACE__ . '\\Blocks', false);
357			foreach ($blockServiceClasses as $serviceClass) {
358			/**
359			* @var AbstractBlock
360			*/
361			$service = $instanceManager->getInstance($serviceClass);
362			$service->initialize();
363			}
364			/**
365			* Access Control Nested Blocks
366			* Register them one by one, as to disable them if module is disabled
367			*/
368			$accessControlRuleBlockServiceClassModules = [
369			AccessControlDisableAccessBlock::class => AccessControlFunctionalityModuleResolver::ACCESS_CONTROL_RULE_DISABLE_ACCESS,
370			AccessControlUserStateBlock::class => AccessControlFunctionalityModuleResolver::ACCESS_CONTROL_RULE_USER_STATE,
371			AccessControlUserRolesBlock::class => AccessControlFunctionalityModuleResolver::ACCESS_CONTROL_RULE_USER_ROLES,
372			AccessControlUserCapabilitiesBlock::class => AccessControlFunctionalityModuleResolver::ACCESS_CONTROL_RULE_USER_CAPABILITIES,
373			];
374			foreach ($accessControlRuleBlockServiceClassModules as $serviceClass => $module) {
375			if ($moduleRegistry->isModuleEnabled($module)) {
376			/**
377			* @var AbstractBlock
378			*/
379			$service = $instanceManager->getInstance($serviceClass);
380			$service->initialize();
381			}
382			}
383			/**
384			* Block categories
385			*/
386			$blockCategoryServiceClasses = ContainerBuilderUtils::getServiceClassesUnderNamespace(__NAMESPACE__ . '\\BlockCategories');
387			foreach ($blockCategoryServiceClasses as $serviceClass) {
388			/**
389			* @var AbstractBlockCategory
390			*/
391			$service = $instanceManager->getInstance($serviceClass);
392			$service->initialize();
393			}
394			}
395
396			/**
397			* Get permalinks to work when activating the plugin
398			*
399			* @see https://codex.wordpress.org/Function_Reference/register_post_type#Flushing_Rewrite_on_Activation
400			* @return void
401			*/
402			public function activate(): void
403			{
404			// Initialize the timestamp
405			$userSettingsManager = UserSettingsManagerFacade::getInstance();
406			$userSettingsManager->storeTimestamp();
407			}
408
409			/**
410			* Remove permalinks when deactivating the plugin
411			*
412			* @see https://developer.wordpress.org/plugins/plugin-basics/activation-deactivation-hooks/
413			* @return void
414			*/
415			public function deactivate(): void
416			{
417			// First, unregister the post type, so the rules are no longer in memory.
418			$instanceManager = InstanceManagerFacade::getInstance();
419			$postTypeObjects = array_map(
420			function ($serviceClass) use ($instanceManager): AbstractPostType {
421			/**
422			* @var AbstractPostType
423			*/
424			$postTypeObject = $instanceManager->getInstance($serviceClass);
425			return $postTypeObject;
426			},
427			ContainerBuilderUtils::getServiceClassesUnderNamespace(__NAMESPACE__ . '\\PostTypes')
428			);
429			foreach ($postTypeObjects as $postTypeObject) {
430			$postTypeObject->unregisterPostType();
431			}
432
433			// Then, clear the permalinks to remove the post type's rules from the database.
434			\flush_rewrite_rules();
435
436			// Remove the timestamp
437			$userSettingsManager = UserSettingsManagerFacade::getInstance();
438			$userSettingsManager->removeTimestamp();
439			}
440			}
441

GraphQLAPI / graphql-api-for-wp

GitHub Access Token became invalid

Push — master ( ed3c2e...98ec12 )

Plugin::checkIsPluginUpgraded() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like