File Membership.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 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565

<?php
/*
Plugin Name: HJI Membership
Description: Core functionality required by all other Home Junction plugins.
Version: 2.4.7
Author URI: http://www.homejunction.com
Author: Home Junction
HJI Package: hji-membership
*/

namespace hji\membership;


use \hji\common\utils\WPHelper;
use \hji\membership\controllers\CommonScripts;
use hji\membership\abstracts\Controller;
use hji\membership\controllers\GForms;
use \hji\membership\controllers\ProductManager;
use \hji\membership\controllers\RequireJs;
use \hji\membership\models\Customer;
use \hji\common\models\JsVars;
use \hji\common\utils\Cookies;
use hji\membership\models\Settings;
use \hji\membership\models\UserSession;
use hji\users\controllers\User;

require_once(dirname(__FILE__) . '/autoload.php');
require_once(dirname(__FILE__) . '/third-party/Dice/dice.php');


class Membership extends Controller
{
    const NAME = 'HJI Membership';

    const SUPPORT_EMAIL = 'help@homejunction.com';
    const SUPPORT_PHONE = '(858) 777-9533 Ext. 4';

    private static $_instance;

    private $_authHasRan = false;

    public static $file;
    public static $slug;
    public static $dir;
    public static $url;

    private $hji_mce_buttons = array();

    public $eventDispatcher;
    public $eventLogger;

    function __construct()
    {
        if (!isset($_SESSION) && !headers_sent())
        {
            session_start();
        }

        self::$file = __FILE__;
        self::$slug = basename(dirname(self::$file));
        self::$dir  = dirname(self::$file);
        self::$url  = WP_PLUGIN_URL . '/' . self::$slug;

        require_once(self::$dir . '/common/utils/SiteInfo.php');
        require_once(self::$dir . '/common/models/JsVars.php');

        // Using this as action
        add_filter('tiny_mce_plugins', array($this, 'consolidateHjiMceButtons'));
        add_filter('mce_buttons_4', array($this, 'addTinyMceButtons'), 99);

        add_action('admin_enqueue_scripts', array($this, 'enqueue_scripts'));

        add_action('admin_print_footer_scripts', array($this, 'adminFooterScripts'));

        add_action('admin_menu', array($this, 'admin_menu'));            
        add_action('init', array($this, 'init'));

        // Registering scripts for admin and front-end at once
        // TODO: refactor script loading via correct hooks
        // TODO: eliminate theme customizer hooks usage
        add_action('init', array($this, 'register_scripts'));
        add_action('customize_controls_enqueue_scripts', array($this, 'register_scripts'));

        add_action('wp_enqueue_scripts', array($this, 'enqueue_scripts'));
        add_action('customize_preview_init', array($this, 'enqueue_scripts'));

        add_action('activated_plugin', array($this, 'loadThisPluginFirst'), 100);

        add_action('plugins_loaded', array($this, 'registerRequireJs'), 9);

        add_action('hji_plugin_version_update' . __FILE__, array($this, 'membershipUpdate'));

        register_activation_hook(__FILE__, array($this, 'pluginActivation'));
        register_deactivation_hook(__FILE__, array($this, 'pluginDeactivation'));

        add_action('init', array($this, 'registerImageSizes'));
        add_filter('image_size_names_choose', array($this, 'addImageSizeNames'));
        add_filter('wp_mail', array($this, 'addSendGridEmailHeaders'));
        add_filter('wp_mail_from_name', array($this, 'removeWPDefaultFromName'));
        add_filter('timber/loader/paths', array($this, 'setDefaultTemplatePaths'));
    }


    /**
     * Instantiating classes separately only once
     *
     * @since 1.0.4
     */
    function initAccessibleClasses()
    {
        $this->settingsController   = new controllers\Settings();
        $this->customerModel        = Customer::getInstance();
        $this->apiController        = new controllers\APIClient($this->customerModel);
        $this->productManager       = ProductManager::getInstance();
        $this->gFormsController     = new GForms();

        if ($this->isLicensed())
        {
            $this->downloadsController = new controllers\Downloads();

            $this->productManager->initActionHooks();


            // Register Membership First
            $this->productManager->registerProduct(__FILE__, 'plugin');

            // Start event logger
            $this->_startEventLogger();
        }

        $this->requireJs = RequireJs::getInstance();

        $this->gFormsController->setWPActions();
    }


    /**
     * Instance of the Membership Class
     *
     * @return Membership
     * @since   1.0.4
     */
    static function getInstance()
    {
        if (!( self::$_instance instanceof self))
        {
            self::$_instance = new self();
        }

        return self::$_instance;
    }


    /**
     * Checks if membership is licensed
     * based on last available authentication token.
     *
     * @return bool
     *
     * @since 1.0.4
     */
    function isLicensed()
    {
//        $settings = new Settings();
//
//        if (!$settings->licenseKey)
//        {
//            return false;
//        }

        // If authentication has ran in this runtime, token is set
        // and customer model has markets schema - we're good to go.

        if (UserSession::getToken() && $this->customerModel->markets)
        {
            return true;
        }
        else if (!$this->_authHasRan)
        {
            $authenticated = false;

            if (!$this->settingsController->isUpdating())
                $authenticated = $this->apiController->authenticate(true);

            $this->_authHasRan = true;

            return $authenticated;
        }

        return false;
    }


    /**
     * Returns array of licensed markets
     * or false
     *
     * @return array
     */
    function getMarkets()
    {
        $markets = (array) $this->customerModel->markets;
        return (!empty($markets)) ? array_keys($markets) : array();
    }


    /**
     * Forces Membership plugin to load first
     * Important, since we're calling common membership methods
     * from other HJI plugins.
     */
    function loadThisPluginFirst()
    {
        // ensure path to this file is via main wp plugin path
        $wp_path_to_this_file = preg_replace('/(.*)plugins\/(.*)$/', WP_PLUGIN_DIR."/$2", __FILE__);
        $this_plugin = plugin_basename(trim($wp_path_to_this_file));
        $active_plugins = get_option('active_plugins');
        $this_plugin_key = array_search($this_plugin, $active_plugins);

        if ($this_plugin_key)
        {
            // If it's 0 it's the first plugin already, no need to continue

            array_splice($active_plugins, $this_plugin_key, 1);
            array_unshift($active_plugins, $this_plugin);
            update_option('active_plugins', $active_plugins);
        }
    }


    function admin_menu()
    {
        add_menu_page(
            self::NAME,
            self::NAME,
            'manage_options',
            self::$slug,
            false,
            self::$url . '/resources/images/admin-menu.png'
        );
    }


    function init()
    {
        WPHelper::registerPluginVersion(__FILE__);

        add_action('wp_print_footer_scripts', '\hji\common\models\JsVars::loadVars', 0);
        add_action('admin_print_scripts', '\hji\common\models\JsVars::loadVars', 0);

        $this->di()->get('hji\\membership\\services\\SocialGraph')->init();
    }


    function registerRequireJs()
    {
        $this->requireJs->addPath('hji-membership', self::$url . '/resources/scripts/build');
        $this->requireJs->addPath('hji-membership/third-party', self::$url . '/third-party');
    }


    function register_scripts()
    {
        CommonScripts::register();

        wp_register_script('require-js', self::$url . '/resources/scripts/build/hji.js', array('jquery', 'backbone'), false, true);

        // Do not load on themes pages (conflict with Redux Framework).
        if (!stripos($_SERVER['REQUEST_URI'], 'themes.php'))
        {
            wp_enqueue_script('require-js');
            wp_register_style('hji-membership-admin', self::$url . '/resources/styles/admin.min.css');
        }


        // membership.js HAS to be loaded in the footer,
        // because it tries to load RequireJS on DOM ready and
        // making sure another RequireJS is not already loaded.
        // This solves possible conflicts with RequireJS async duplicate.
        wp_register_script('hji-membership', self::$url . '/resources/scripts/build/membership.js', array('require-js'), false, true);
        wp_register_style('hji-membership', self::$url . '/resources/styles/membership.min.css');

        $licenseKey = \hji\membership\models\Settings::getInstance()->licenseKey;

        JsVars::setVar('common', 'licenseKey', $licenseKey);
        JsVars::setVar('common', 'siteUrl', home_url());
        JsVars::setVar('common', 'ajaxUrl', admin_url('admin-ajax.php'));
        JsVars::setVar('common', 'apiBaseUrl', $this->apiController->api->getApiBaseUrl());
        JsVars::setVar('common', 'env', self::environment());
        JsVars::setVar('common', 'cookiePath', Cookies::COOKIEPATH);
        JsVars::setVar('common', 'cookieDomain', Cookies::COOKIE_DOMAIN);

        // Add markets and their centroids
        // Since we're calling customerModel before checking if customer is licensed
        // we need to check if markets data exists

        if ($this->customerModel->markets)
        {
            $markets = array();

            foreach($this->customerModel->markets as $k => $market)
            {
                $m = new \stdClass();
                $m->centroid = @$market->metadata->centroid;
                $markets[$k] = $m;
            }

            JsVars::setVar('common', 'markets', $markets);
        }
    }


    function enqueue_scripts()
    {

        
        if (!current_theme_supports('hji-twitter-bootstrap'))
        {
            wp_enqueue_style('hji-common');
            wp_enqueue_style('hji-bootstrap');
            wp_enqueue_script('hji-bootstrap');
        }

        if (is_admin())
        {
            wp_enqueue_script('hji-membership-admin');
            wp_enqueue_style('hji-membership-admin');
        }
        else
        {
            wp_deregister_script('underscore');
            wp_deregister_script('backbone');
            wp_register_script('underscore', 'https://cdnjs.cloudflare.com/ajax/libs/underscore.js/1.8.3/underscore-min.js', array('jquery'), true);
            wp_register_script('backbone', 'https://cdnjs.cloudflare.com/ajax/libs/backbone.js/1.2.3/backbone-min.js', array('underscore'), true);
        }
    }


    /**
     * Invoke js in the footer for common usage
     */
    function adminFooterScripts()
    {
        if (stristr($_SERVER['REQUEST_URI'], 'widgets.php'))
        {
            ?>
            <script type="text/javascript">
                jQuery(document).ready(function(){
                    HJI.Membership.Admin.autoSaveWidgets();
                });
            </script>
        <?php
        }
    }


    /**
     * Consolidating HJI MCE buttons into a single array.
     *
     * Before TinyMCE gets initialized, we're running custom filter
     * to gather all HJI buttons, so they can be added
     * to MCE panel at once.
     *
     * @param $plugins
     * @return mixed
     */
    function consolidateHjiMceButtons($plugins)
    {
        $this->hji_mce_buttons = apply_filters('hji_mce_buttons', $this->hji_mce_buttons);

        return $plugins;
    }


    function addTinyMceButtons($buttons)
    {
        if (empty($this->hji_mce_buttons))
        {
            return $buttons;
        }

        return array_merge($this->hji_mce_buttons, $buttons);
    }


    function pluginActivation()
    {
        WPHelper::registerPluginVersion(__FILE__);

        /**
         * Useful to other plugins to run their activation processes
         * like settings setup and rewrite rules flushes.
         */
        do_action('hji_membership_activation');
    }


    function pluginDeactivation(){}


    function membershipUpdate($params)
    {
        if (isset($params['plugin']) && $params['plugin'] == __FILE__)
        {
            // Force re-authentication after the update

            $this->_authHasRan = false;
            $this->apiController->authenticate(true);
        }
    }


    public static function environment()
    {
        if (defined('HJI_DEV') && HJI_DEV === true)
        {
            return 'test';
        }

        if (isset($_SERVER['HTTP_HOST']) &&
            (stristr($_SERVER['HTTP_HOST'], 'staging.spatialmatch.com')
                || stristr($_SERVER['HTTP_HOST'], 'hjstaging.com'))
        )
        {
            return 'test';
        }

        return 'production';
    }


    /**
     * Registers default image dimensions.
     */
    function registerImageSizes()
    {
        // Used for agent headshots in email templates

        add_image_size('hji/150w150h', 150, 150, array( 'center', 'top' ));

        // Used for agent logo in email templates

        add_image_size('hji/150h', 0, 150, false);
    }


    /**
     * Adds image sizes to some selector
     *
     * Allows media manager to pass custom media sizes
     * into select image (JS) object,
     * which is used in the License Key admin UI to select the correct size.
     *
     * @param $sizes
     *
     * @return array
     */
    function addImageSizeNames($sizes )
    {
        return array_merge( $sizes, array(
            'hji/150w150h' => __( 'HJI 150x150' ),
            'hji/150h' => __( 'HJI 150 height' ),
        ) );
    }


    /**
     * Adds SendGrid API-specific header to track email activity by license key
     *
     * @param $params
     *
     * @return mixed
     */
    function addSendGridEmailHeaders($params)
    {
        $settings = new Settings();

        if ($settings->licenseKey)
        {
            $obj = new \stdClass();
            $obj->category = array($settings->licenseKey);
            $params['headers']['X-SMTPAPI'] = json_encode($obj);
        }

        return $params;
    }


    /**
     * Removes "From WordPress" from email headers.
     *
     * When wp_mail function is used directly and From Name is not set,
     * WP will use FROM: WordPress by default.
     *
     * @param $fromName string
     *
     * @return string
     */
    function removeWPDefaultFromName($fromName)
    {
        if ($fromName == 'WordPress')
            return '';

        return $fromName;
    }


    private function _startEventLogger()
    {
        $userActionLogger = $this->di()->get('hji\\membership\\models\\UserActionLogger');
        $this->eventLogger      = $this->di()->create('hji\\membership\\observers\\EventLogger', array($userActionLogger));
        $this->getServiceContainer()->getDispatcher()->attachListener($this->eventLogger);
        $this->getServiceContainer()->getDispatcher()->attachListener($this->eventLogger);
    }


    /**
     * Sets default Twig paths in the following order:
     *  Child Theme
     *  Parent Theme
     *  Plugins
     *
     * @param $paths
     *
     * @return array
     */
    function setDefaultTemplatePaths($paths)
    {
        $childThemePath  = get_stylesheet_directory();
        $parentThemePath = get_template_directory();

        if (is_child_theme())
        {
            if (false !== $path = $this->getHJITemplatesPath($childThemePath))
                $default[] = $path;

            $default[] = $childThemePath;
        }

        if (false !== $path = $this->getHJITemplatesPath($parentThemePath))
            $default[] = $path;

        $default[] = $parentThemePath;

        $paths = array_merge($default, $paths);
        $uniquePaths = array_unique($paths);

        return $uniquePaths;
    }


    protected function getHJITemplatesPath($themePath)
    {
        $hjiTemplatesDir = 'hji-templates';
        $path = trailingslashit($themePath) . $hjiTemplatesDir;

        if (file_exists($path))
            return $path;

        return false;
    }
}

Membership::getInstance();
Membership::getInstance()->initAccessibleClasses();

Namespaces

Classes

Interfaces

Functions