Ticket #27124: mc-muplugin-loader.php

<?php
namespace Mesoconcepts\WP\Plugin\MUPluginLoader;

/*
 * Plugin Name: MU Plugin Loader
 * Plugin URI: http://www.mesoconcepts.com
 * Description: Automatically loads, and checks for updates of, MU plugins in subfolders
 * Author: Denis de Bernardy
 * Author URI: http://www.mesoconcepts.com
 * Version: 0.1-alpha
 */

/**
 * WP mu-plugin loader
 *
 * References:
 *
 * - https://core.trac.wordpress.org/ticket/14359
 *
 * @author Denis de Bernardy
 **/
class MUPluginLoaderPlugin
{
    /**
     * The plugin files
     *
     * @var array $plugin_files
     **/
    protected $plugin_files;


    /**
     * The full plugin data as returned by WP
     **/
    protected $plugin_data;


    /**
     * Constructor
     **/
    public function __construct()
    {
        $this->findPlugins();

        add_filter('http_request_args', array($this, 'injectMUPluginHttpArgs'), 10, 2);
        add_filter('pre_set_site_transient_update_plugins', array($this, 'stripMUPluginPackageUrls'));

        add_filter('pre_set_transient_plugin_slugs', array($this, 'injectMUPluginSlugs'));

        if ($this->inPluginAdmin()) {
            add_filter('plugin_action_links', array($this, 'injectMUPluginActionLinks'), 10, 4);
            add_filter('network_admin_plugin_action_links', array($this, 'injectMUPluginActionLinks'), 10, 4);
        }
    }


    /**
     * Injects MU plugin data during update checks
     *
     * @param array $args
     * @param string $url
     * @return array $args
     **/
    public function injectMUPluginHttpArgs($args, $url)
    {
        # We only care about plugin update checks
        if ($url != 'https://api.wordpress.org/plugins/update-check/1.1/') {
            return $args;
        }

        $this->findPlugins(true);
        $mu_plugins = $this->plugin_data;
        $to_send = json_decode($args['body']['plugins']);
        $plugins = (object) array_merge((array) $to_send->plugins, (array) $this->plugin_data);
        $to_send->plugins = $plugins;
        $args['body']['plugins'] = json_encode($to_send);

        return $args;
    }


    /**
     * Strips package URIs from MU Plugin update responses, to disable auto-updates
     *
     * @param object $value The old update_plugins transient value
     * @return object $value The new update_plugins transient value
     **/
    public function stripMUPluginPackageUrls($value)
    {
        if (!isset($value->response)) {
            return $value;
        }

        $this->findPlugins(true);
        $mu_plugins = array_keys($this->plugin_data);
        $responses = $value->response;

        foreach ($value->response as $plugin => $response) {
            if (in_array($plugin, $mu_plugins)) {
                unset($response->package);
            }
        }

        return $value;
    }


    /**
     * Injects our extra plugins in the $plugins global (!) when in the plugins screen
     *
     * This shenanigan is fragile and subject to break if WP ever changes its
     * API, but we've no adequate filter at our disposal...
     *
     * @param array $plugin_slugs
     * @return array $plugin_slugs
     **/
    public function injectMUPluginSlugs($plugin_slugs)
    {
        if (!$this->inPluginAdmin()) {
            return $plugin_slugs;
        }

        global $plugins;

        # Bail early if WP ever changes its API
        if (!isset($plugins) || !isset($plugins['mustuse'])) {
            return $plugin_slugs;
        }

        # Merge our plugins
        $mu_plugins = array_merge($plugins['mustuse'], $this->plugin_data);
        uasort($mu_plugins, function($a, $b) {
            return strnatcasecmp($a['Name'], $b['Name']);
        });
        $plugins['mustuse'] = $mu_plugins;

        if (current_user_can('update_plugins')) {
            $current = get_site_transient('update_plugins');
            foreach ($plugins['mustuse'] as $plugin_file => $plugin_data ) {
                if (isset($current->response[$plugin_file])) {
                    $plugins['mustuse'][$plugin_file]['update'] = true;
                    $plugins['upgrade'][$plugin_file] = $plugins['mustuse'][$plugin_file];
                }
            }
        }

        return $plugin_slugs;
    }


    /**
     * Disables actions and the checkbox in the plugin upgrade table
     *
     * @param array $actions
     * @param string $plugin_file
     * @param array $plugin_data
     * @param string $context
     * @return array $actions
     **/
    public function injectMUPluginActionLinks($actions, $plugin_file, $plugin_data, $context)
    {
        # Bail immediately if we're not interested
        if ($context != 'upgrade' || !isset($this->plugin_data[$plugin_file])) {
            return $actions;
        }
        else {
            # Let WP localize this as needed
            $label = _n('Must-Use <span class="count">(%s)</span>', 'Must-Use <span class="count">(%s)</span>', 1);
            $label = trim(preg_replace("#<.+>#", '', $label));
            # This id is subject to change with WP versions
            $cb = "checkbox_" . md5($plugin_data['Name']);
            $script = <<<EOS

<script>
var $cb = jQuery("#$cb");
$cb.parents('tr.inactive:first').removeClass('inactive').addClass('active');
$cb.replaceWith('');
</script>
EOS;
            return array(
                'mustuse-upgrade' => $label . $script,
            );
        }

        return $actions;
    }


    /**
     * Whether we're in a plugin admin area or not
     *
     * @return boolean $in_plugin_admin
     **/
    protected function inPluginAdmin()
    {
        foreach (array(
            '/wp-admin/plugins.php',
            '/wp-admin/network/plugins.php',
            '/wp-admin/update-core.php',
            '/wp-admin/network/update-core.php',
        ) as $url_pattern) {
            if (strpos($_SERVER['REQUEST_URI'], $url_pattern) !== false) return true;
        }
        return false;
    }


    /**
     * Returns mu plugins in subfolders
     *
     * Plugins must be loaded in the global scope
     *
     * References:
     *
     * - https://core.trac.wordpress.org/ticket/22802
     *
     * @return array $plugin_files
     **/
    public function getPluginFiles()
    {
        return $this->plugin_files;
    }

    /**
     * Finds mu plugins in subfolders
     *
     * @param boolean @fetch_data
     **/
    protected function findPlugins($fetch_data = false)
    {
        # Don't do this more than once
        if ($this->plugin_files && ($this->plugin_data || !$fetch_data)) {
            return;
        }

        $plugins = false;

        # Fetch cached plugins unless we're in the plugins area
        if (!$this->inPluginAdmin() && ($this->plugin_data || !$fetch_data)) {
            $plugins = get_site_transient('mu_plugins_loader');
        }

        # Invalidate cache if anything is going to break
        if ($plugins !== false) {
            foreach ($plugins as $plugin) {
                if (!is_readable(__DIR__ . DIRECTORY_SEPARATOR . $plugin)) {
                    $plugins = false;
                    break;
                }
            }
        }

        # Build cache if needed
        if ($plugins === false) {
            if (!function_exists('get_plugins')) {
                require ABSPATH . 'wp-admin/includes/plugin.php';
            }
            $plugin_data = get_plugins('/../mu-plugins');

            # Keep a copy of the raw data if it's needed or requested
            if ($this->inPluginAdmin() || $fetch_data) {
                $this->plugin_data = $plugin_data;
            }

            $plugins = array_keys($plugin_data);
            $plugins = array_filter($plugins, function($plugin) {
                return dirname($plugin) != '.';
            });

            # Cache for future use
            set_site_transient('mu_plugins_loader', $plugins);
        }

        # Cache the results
        $this->plugin_files = $plugins;
    }
} # END class

# Bootstrap plugin
global $mu_plugin_loader_plugin;
$mu_plugin_loader_plugin = new MUPluginLoaderPlugin;

# Load MU plugins
foreach ($mu_plugin_loader_plugin->getPluginFiles() as $extra_mu_plugin) {
    include_once __DIR__ . DIRECTORY_SEPARATOR . $extra_mu_plugin;
}
unset($extra_mu_plugin);