File classes/controllers/Dependency.php | HJI WP Membership Code Reference

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502

<?php
namespace hji\membership\controllers;


use hji\common\models\Notices;
use hji\common\utils\Views;
use hji\membership\interfaces\Product;
use hji\membership\Membership;
use hji\membership\models\PluginEntity;
use hji\membership\models\ProductDependencies;


class Dependency
{
    /**
     * @var Notices
     */
    private $notices;

    /**
     * Products container - products added on ::dependenciesSatisfied() call
     * @var
     */
    private $products;


    function __construct()
    {
        $this->notices = new Notices();
    }


    /**
     * Action Hooks Setter
     * Has to run only once
     */
    function initActionHooks()
    {
        add_filter('extra_plugin_headers',  array($this, 'extraHeaders'));
        add_filter('extra_theme_headers',   array($this, 'extraHeaders'));

        if (is_admin())
        {
            add_action('activate_plugin',       array($this, 'checkDependenciesOnActivation'), 1, 2);
            add_action('admin_notices',         array($this, 'adminNotices'));
            add_action('admin_init',            array($this, 'setInPluginUpdateMessages'));
            add_filter('plugin_row_meta',       array($this, 'setPluginsRowMeta'), 999, 4);
        }
    }


    /**
     * Determines if product's dependencies are met
     *
     * @param Product $product
     * @return bool
     */
    public function dependenciesSatisfied(Product $product)
    {
        $this->products[] = $product;

        if ($missingDependencies = $product->dependencies->getMissingDependencies())
        {
            if ($product->getType() == 'theme')
            {
                $this->themeDependenciesNotice($missingDependencies, $product->getName());
            }

            return false;
        }

        return true;
    }


    /**
     * Registers HJI-related headers with WP-core get_file_data() parser
     * This data can be accessed via core getters of plugin and theme data.
     *
     * @param $headers
     * @return mixed
     */
    public static function extraHeaders($headers)
    {
        return array_merge($headers, ProductDependencies::getFileHeaderProperties());
    }


    /**
     * Determines if Membership plugin has an outstanding update available
     *
     * @return bool
     */
    function membershipUpdateAvailable()
    {
        $updates = get_site_transient('update_plugins');

        if (!empty($updates->response))
        {
            foreach ($updates->response as $file => $plugin)
            {
                if (isset($plugin->slug) && $plugin->slug == 'hji-membership')
                {
                    return true;
                }
            }
        }
    }


    /**
     * Renders admin notices
     */
    function adminNotices()
    {
        $this->onActivationNotice();

        $view = new Views(Membership::$dir . '/common/views/');
        echo $view->render('notices', array('notices' => $this->notices));
    }


    /**
     * Adds in-plugin update message action for each plugin
     */
    function setInPluginUpdateMessages()
    {
        $this->plugins = get_plugins();

        foreach ($this->plugins as $file => $pluginData)
        {
            add_action('in_plugin_update_message-' . $file, array($this, 'inPluginUpdateMessage'), 100, 2);
        }
    }


    /**
     * Renders upgrade notices on the wp-admin/update-core.php page
     *
     * @param $productSlug
     */
    function setUpgradeNotices($productSlug)
    {
        add_filter('puc_pre_inject_update-' . $productSlug, array($this, 'setDependencyUpgradeNotice'));
    }


    /**
     * Adds upgrade_notice property with upgrade dependencies info, to the upgrade data.
     *
     * @param $upgrade
     * @return mixed
     */
    function setDependencyUpgradeNotice($upgrade)
    {
        if (!empty($this->products))
        {
            foreach ($this->products as $product)
            {
                if ($product->getSlug() == $upgrade->slug)
                {
                    if ($missingDependencies = $product->dependencies->getMissingUpdateDependencies())
                    {
                        $upgrade->upgrade_notice = self::message('update_dependencies', self::depsToString($missingDependencies));
                        break;
                    }
                }
            }
        }

        return $upgrade;
    }


    /**
     * Renders dependencies message related to the available update
     * The message is rendered inside the table row for each respective plugin
     * inside Plugins Dashboard.
     *
     * @param $plugin_data
     * @param $r
     */
    function inPluginUpdateMessage($plugin_data, $r)
    {
//        if (!PluginEntity::isPackage($plugin_data))
//            return;

        $pluginFile = null;

        if (isset($r->plugin))
        {
            $pluginFile = $r->plugin;
        }
        else
        {
            $pluginFile = $this->getPluginFileBySlug($r->slug);
        }

        if ($pluginFile && $plugin = new PluginEntity($pluginFile))
        {
            if ($missingDependencies = $plugin->dependencies->getMissingUpdateDependencies())
            {
                echo self::message('update_dependencies', self::depsToString($missingDependencies));
            }
        }
    }


    /**
     * Renders required dependencies meta data within plugin's data row in the Plugins table
     * Hook plugin_row_meta implementation.
     *
     * @param $plugin_meta
     * @param $plugin_file
     * @param $plugin_data
     * @param $status
     * @return array
     */
    function setPluginsRowMeta($plugin_meta, $plugin_file, $plugin_data, $status)
    {
        if (PluginEntity::isPackage($plugin_data))
        {
            $plugin = new PluginEntity($plugin_file);

            $version = array_shift($plugin_meta);

            $headers = ProductDependencies::getFileHeadersHashmap();

            $meta[] = $version;

            if ($dependencies = $plugin->dependencies->getDependencies())
            {
                $meta[] = self::message('plugin_dependencies', self::depsToString($dependencies));
            }

            if ($missingDependencies = $plugin->dependencies->getMissingDependencies())
            {
                if (is_plugin_active($plugin_file))
                {
                    $plugin_meta[] = self::message('is_active_dependencies_not_met', self::depsToString($missingDependencies));
                }
                else
                {
                    $plugin_meta[] = self::message('dependencies_not_met', self::depsToString($missingDependencies));
                }
            }

            $plugin_meta = array_merge($meta, $plugin_meta);
        }

        return $plugin_meta;
    }


    /**
     * Returns plugin file path
     *
     * @param $slug
     * @return PluginEntity
     */
    function getPluginFileBySlug($slug)
    {
        $this->plugins = get_plugins();

        foreach ($this->plugins as $file => $pluginData)
        {
            if (strpos($file, $slug . '/') === 0)
            {
                return $file;
            }
        }
    }


    /**
     * Checks dependencies on plugin activation,
     * if not satisfied - sets temp transient to trigger deactivation upon page reload.
     *
     * @param $pluginFile
     * @param $network_wide
     */
    public function checkDependenciesOnActivation($pluginFile, $network_wide)
    {
        $plugin = new PluginEntity($pluginFile);

        $required = array();

        if ($plugin->getData())
        {
            if ($missingDependencies = $plugin->dependencies->getMissingDependencies())
            {
                $required[$pluginFile] = $missingDependencies;

                remove_all_actions('activate_' . $pluginFile);
                add_action('activated_plugin', array(__CLASS__, 'undo_activation_actions'), 9999, 2);
            }
        }

        if (!empty($required))
        {
            set_transient('hji_activate', $required);
        }
    }


    /**
     * Undo any activation actions which may have run for blocked activation plugins
     *
     * @param string $plugin        Name of the plugin which was blocked
     * @param bool   $network_wide  Whether the intended activation was for the network or single site
     */
    public static function undo_activation_actions($plugin, $network_wide)
    {
        remove_action(current_filter(), array(__CLASS__, __FUNCTION__));
        deactivate_plugins($plugin, $network_wide);
        do_action('deactivate_plugin', $plugin, $network_wide);
        do_action('deactivate_' . $plugin, $network_wide);
        do_action('deactivated_plugin', $plugin, $network_wide);
        $status = esc_html($_GET['plugin_status']);
        $page = esc_html($_GET['paged']);
        $s = esc_html($_GET['s']);
        wp_redirect(self_admin_url("plugins.php?plugin_status=$status&paged=$page&s=$s"));
        exit;
    }


    /**
     * Add activation failure notices to the ::$notices
     * due to dependencies being not satisfied.
     */
    function onActivationNotice()
    {
        if ($required = get_transient('hji_activate'))
        {
            delete_transient('hji_activate');

            $messages = array();
            $content = null;

            foreach ($required as $file => $dependencies)
            {
                if (!empty($dependencies))
                {
                    foreach ($dependencies as $dependency)
                    {
                        $messages[] = sprintf('%s v. %s', $dependency->name, $dependency->version);
                    }

                    $plugin = new PluginEntity($file);
                    $data = $plugin->getData();

                    $content .= $data['Name'] . ' requires ' . implode(', ', $messages);
                }
            }

            if ($content)
            {
                $content = self::message('on_activate_dependencies_not_met', $content);
            }

            $this->notices->addNotice($content, 2);
        }
    }


    /**
     * Adds theme dependency notice to the ::$notices container.
     *
     * @param array $deps dependencies
     * @param       $productName
     */
    function themeDependenciesNotice(array $deps, $productName)
    {
        $error = self::message('theme_dependencies_not_met', self::depsToString($deps), $productName);
        $this->notices->addNotice($error, 2);
    }


    /**
     * Stringifies array of dependency entities
     *
     * @param array $deps
     * @return null|string
     */
    protected static function depsToString(array $deps)
    {
        $result = null;

        if (!empty($deps))
        {
            $strings = array();

            foreach ($deps as $dependency)
            {
                $name = ($dependency->type == 'theme') ? self::_getThemeName($dependency->name) : $dependency->name;

                $strings[] = sprintf('%s v. %s', $name, $dependency->version);
            }

            $last   = array_pop($strings);
            $n      = count($strings);

            if ($n == 0)
            {
                $result .= $last;
            }
            else
            {
                $result .= implode(', ', $strings) . ' and ' . $last;
            }
        }

        return $result;
    }


    protected static function _getThemeName($template)
    {
        $theme = wp_get_theme($template);
        return $theme->get('Name');
    }


    /**
     * Returns message string based on code
     *
     * @param      $code
     * @param      $dependenciesStr
     * @param null $productName
     * @return string
     */
    protected static function message($code, $dependenciesStr, $productName = null)
    {
        $megaphone = '<i class="dashicons dashicons-megaphone"></i> ';
        $error     = '<i class="dashicons dashicons-dismiss"></i> ';
        $info      = '<i class="dashicons dashicons-info"></i> ';

        $theme = ($productName) ? $productName . ' theme' : 'Theme';

        $messages = array(

            'update_dependencies' => sprintf('<div class="hji-required-dependencies"><span style="color: #d54e21">%s<strong>%s</strong> </span> %s</div>', $megaphone, 'Update Requires:', $dependenciesStr),

            'is_active_dependencies_not_met' => sprintf('<div class="hji-required-dependencies"><span style="color: red">%s<strong>%s</strong> </span> %s</div>', $error, 'Plugin is inactive. Dependencies are not met:', $dependenciesStr),

            'dependencies_not_met' => sprintf('<div class="hji-required-dependencies"><span style="color: #d54e21">%s<strong>%s</strong> </span> %s</div>', $info, 'Dependencies not met:', $dependenciesStr),

            'theme_dependencies_not_met' => sprintf('<span style="color: #dd3d36">%s<strong>%s</strong> </span> %s', $error, $theme . ' dependencies are not met. Please update the following items:', $dependenciesStr),

            'on_activate_dependencies_not_met' => sprintf('<div class="hji-required-dependencies"><span style="color: #d54e21">%s<strong>%s</strong> </span> %s</div>', $error, 'Plugin activation failed. Dependencies were not met:', $dependenciesStr),

            'plugin_dependencies' => sprintf('<span class="hji-required-dependencies">Dependencies: %s<span>', $dependenciesStr),

        );

        return isset($messages[$code]) ? $messages[$code] : '';
    }


    /**
     * Returns array of items sorted in the order satisfying dependencies
     *
     * @param $dependenciesArray array(item => array(dep1, dep2..)...);
     * @return array
     */
    public function resolveDependencies($dependenciesArray)
    {
        $dependencyResolver = new DependencyResolver();

        foreach ($dependenciesArray as $item => $dependencies)
        {
            $dependencyResolver->add($item, $dependencies);
        }

        return $dependencyResolver->getResolved();
    }
}


class DependencyResolver
{
    protected $deps;


    function __construct()
    {
        $this->deps = new \WP_Dependencies();
    }


    function add($item, $dependencies)
    {
        $this->deps->add($item, false, $dependencies);
        $this->deps->enqueue($item);
    }


    function getResolved()
    {
        return $this->deps->do_items();
    }
}

Namespaces

Classes

Interfaces

Functions