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: 

<?php

namespace WPGMZA;

if(class_exists('WPGMZA\\GoogleMapsAPILoader'))
    return;

/**
 * This class handles loading the Google Maps API and the conditional settings associated with that (load API conditions, exclude pages, etc.)
 * @deprecated This class will be merged into GoogleLoader, the API conditionality mechanisms will be abstracted to APILoader for use with OpenLayers
 */
class GoogleMapsAPILoader
{
    private static $googleAPILoadCalled = false;
    
    /**
     * @const Status code when the user has selected "Do not load Google Maps API"
     */
    const REMOVE_API_CHECKED            = 'REMOVE_API_CHECKED';

    /**
     * @const Status code when the user has not given GDPR consent, where it is required
     */
    const USER_CONSENT_NOT_GIVEN        = 'USER_CONSENT_NOT_GIVEN';
    
    /**
     * @const Status code when the selected maps engine is not Google Maps
     */
    const ENGINE_NOT_GOOGLE_MAPS        = 'ENGINE_NOT_GOOGLE_MAPS';
    
    /**
     * @const Status code when the current page ID has been explicitly included in the load settings
     */
    const PAGE_EXPLICITLY_INCLUDED      = 'PAGE_EXPLICITLY_INCLUDED';
    
    /**
     * @const Status code when the current page ID has been explicitly excluded in the load settings
     */
    const PAGE_EXPLICITLY_EXCLUDED      = 'PAGE_EXPLICITLY_EXCLUDED';
    
    /**
     * @const Status code when the "Never" option has been selected in the load API condition setting
     */
    const NEVER_LOAD_API_SELECTED       = 'NEVER_LOAD_API_SELECTED';
    
    /**
     * @const Status code when the "Front End Only" option has been selected in the load API condition setting
     */
    const ONLY_LOAD_FRONT_END_SELECTED  = 'ONLY_LOAD_FRONT_END_SELECTED';
    
    /**
     * @const Status code when the "Back End Only" option has been selected in the load API condition setting
     */
    const ONLY_LOAD_BACK_END_SELECTED   = 'ONLY_LOAD_BACK_END_SELECTED';
    
    /**
     * @const Status code when class has attempted to enqueue the API. Please note that this does not necessarily guarantee it was successful in doing so, just that the conditions to enqueue were met.
     */
    const ENQUEUED                      = 'ENQUEUED';
    
    private static $apiWillNotLoadWarningDisplayed = false;
    
    /**
     * Constructor
     */
    public function __construct()
    {
        global $wpgmza;
        
        $include_allowed = $this->isIncludeAllowed($status);
        $isAllowed = $this->isIncludeAllowed($status);
        
        wp_enqueue_script('wpgmza_data', plugin_dir_url(__DIR__) . 'wpgmza_data.js');
        wp_localize_script('wpgmza_data', 'wpgmza_google_api_status', (array)$status);
        
        if($wpgmza->settings->engine == "google-maps" && !$isAllowed && !GoogleMapsAPILoader::$apiWillNotLoadWarningDisplayed)
        {
            GoogleMapsAPILoader::$apiWillNotLoadWarningDisplayed = true;
            
            add_action('admin_notices', function() use ($status) {
                ?>
                <div class="notice notice-warning is-dismissable">
                    <p>
                        <?php
                        _e( sprintf(
                            'WP Google Maps: You have selected the Google Maps engine, but the Google Maps API is not being loaded for the following reason: %s.<br/>We recommend you uncheck "Do not load Google Maps API" and set "Load Maps Engine API" to "Where Required" in your <a href="%s">maps settings page</a>', 
                            $status->message,
                            admin_url('admin.php?page=wp-google-maps-menu-settings')
                        ));
                        ?>
                    </p>
                </div>
                <?php
            });
        }
    }
    
    /**
     * Gets the parameters to be sent to the Google Maps API load call
     * @return array Key value parameters to be passed to the Google API URL
     */
    protected function getGoogleMapsAPIParams()
    {
        global $wpgmza;
        
        // Locale
        $locale = get_locale();
        $suffix = '.com';
        
        switch($locale)
        {
            case 'he_IL':
                // Hebrew correction
                $locale = 'iw';
                break;
            
            case 'zh_CN':
                // Chinese integration
                $suffix = '.cn';
                break;
        }
        
        
        $locale = substr($locale, 0, 2);
        
        // Default params for google maps
        $params = array(
            'v'         => 'quarterly',
            'language'  => $locale,
            'suffix'    => $suffix
        );
        
        // API Key
        $key = get_option('wpgmza_google_maps_api_key');
        
        if($key)
            $params['key'] = $key;
        else if(is_admin())
            $params['key'] = get_option('wpgmza_temp_api');
        
        // Libraries
        $libraries = array('geometry', 'places', 'visualization');
        $params['libraries'] = implode(',', $libraries);
        
        $params = apply_filters( 'wpgmza_google_maps_api_params', $params );
        
        return $params;
    }
    
    /**
     * This function loads the Google API if it hasn't been called already
     * @return void
     */
    public function registerGoogleMaps()
    {
        global $wpgmza;
        global $post;
        
        $settings = (array)$wpgmza->settings;
        
        if(GoogleMapsAPILoader::$googleAPILoadCalled)
            return;
        
        if(!$this->isIncludeAllowed())
            return;
        
        $params = $this->getGoogleMapsAPIParams();
        
        $suffix = $params['suffix'];
        unset($params['suffix']);

        $url = '//maps.google' . $suffix . '/maps/api/js?' . http_build_query($params);
        
        wp_register_script('wpgmza_api_call', $url);
        
        // Are we always enqueuing?
        if(!empty($settings['wpgmza_load_engine_api_condition']) && $settings['wpgmza_load_engine_api_condition'] == 'always')
            $this->enqueueGoogleMaps();
        
        // Are we always enqueuing on this page?
        if($post && $this->isPageIncluded($post->ID))
            $this->enqueueGoogleMaps();
        
        GoogleMapsAPILoader::$googleAPILoadCalled = true;
        
        // Block other plugins from including the API
        if(!empty($settings['wpgmza_prevent_other_plugins_and_theme_loading_api']))
            add_filter('script_loader_tag', array($this, 'preventOtherGoogleMapsTag'), 9999999, 3);
    }
    
    /**
     * This function will enqueue the Google Maps API, if the conditions to include it are met. Otherwise, this function will do nothing.
     * @return void
     */
    public function enqueueGoogleMaps()
    {
        if(!$this->isIncludeAllowed())
            return;
        
        wp_enqueue_script('wpgmza_api_call');
    }
    
    /**
     * Checks whether the specified page ID has been explicitly included in the plugin settings
     * @param int $page_id The page / post ID.
     * @return bool Whether or not the user has explicitly stated to include the API on this page.
     */
    public function isPageIncluded($page_id)
    {
        global $wpgmza;
        global $post;
        
        $settings = $wpgmza->settings;
        
        if(empty($settings['wpgmza_always_include_engine_api_on_pages']))
            return false;
        
        if(!preg_match_all('/\d+/', $settings['wpgmza_always_include_engine_api_on_pages'], $m))
            return false;
        
        if(empty($m[0]))
            return false;
        
        $page_ids = $m[0];
        
        return (array_search($page_id, $page_ids) !== false);
    }
    
    /**
     * Checks whether the specified page ID has been explicitly excluded in the plugin settings
     * @param int $page_id The page / post ID.
     * @return bool Whether or not the user has explicitly stated to exclude the API on this page.
     */
    public function isPageExcluded($page_id)
    {
        global $wpgmza;
        
        $settings = $wpgmza->settings;
        
        if(empty($settings['wpgmza_always_exclude_engine_api_on_pages']))
            return false;
        
        if(!preg_match_all('/\d+/', $settings['wpgmza_always_exclude_engine_api_on_pages'], $m))
            return false;
            
        if(empty($m[0]))
            return false;
        
        $page_ids = $m[0];
            
        return (array_search($page_id, $page_ids) !== false);
    }
    
    /**
     * Checks if including the Google API is allowed, based on all the relevant settings.
     * @param string &$status Reference to a string to store the resulting status in.
     * @return bool Whether or not it is permitted to include the API on this page, based on the current settings.
     */
    public function isIncludeAllowed(&$status=null)
    {
        global $wpgmza;
        global $post;
        
        $settings = $wpgmza->settings;
        
        $status = (object)array(
            'message' => null,
            'code' => null
        );
            
        // Correction for Pro <= 7.10.04
        if(isset($wpgmza->settings->wpgmza_maps_engine) && $wpgmza->settings->wpgmza_maps_engine == 'open-street-map')
            $wpgmza->settings->wpgmza_maps_engine = 'open-layers';
        
        if(!empty($settings['wpgmza_settings_remove_api']))
        {
            $status->message = 'Remove API checked in settings';
            $status->code = GoogleMapsAPILoader::REMOVE_API_CHECKED;
            
            return false;
        }
        
        if(!is_admin() && 
            !empty($settings['wpgmza_gdpr_require_consent_before_load']) && 
            !isset($_COOKIE['wpgmza-api-consent-given']))
        {
            $status->message = 'User consent not given';
            $status->code = GoogleMapsAPILoader::USER_CONSENT_NOT_GIVEN;
            
            return false;
        }
        
        if(!empty($settings['wpgmza_maps_engine']) && $settings['wpgmza_maps_engine'] == 'open-layers')
        {
            $status->message = 'Engine is not google-maps';
            $status->code = GoogleMapsAPILoader::ENGINE_NOT_GOOGLE_MAPS;
            
            return false;
        }
        
        if($post)
        {
            if($this->isPageIncluded($post->ID))
            {
                $status->message = 'Page is explicitly included in settings';
                $status->code = GoogleMapsAPILoader::PAGE_EXPLICITLY_INCLUDED;
                
                return true;
            }
            
            if($this->isPageExcluded($post->ID))
            {
                $status->message = 'Page is explicitly excluded in settings';
                $status->code = GoogleMapsAPILoader::PAGE_EXPLICITLY_EXCLUDED;
                
                return false;
            }
        }
            
        if(!empty($settings['wpgmza_load_engine_api_condition']))
            switch($settings['wpgmza_load_engine_api_condition'])
            {
                case 'never':
                    $status->message = 'Never load API chosen in settings';
                    $status->code = GoogleMapsAPILoader::NEVER_LOAD_API_SELECTED;
                    
                    return false;
                    break;
                    
                case 'only-front-end':
                    $status->message = 'Load API front end only chosen in settings';
                    $status->code = GoogleMapsAPILoader::ONLY_LOAD_FRONT_END_SELECTED;
                    
                    return !is_admin();
                    break;
                    
                case 'only-back-end':
                    $status->message = 'Load API back end only chosen in settings';
                    $status->code = GoogleMapsAPILoader::ONLY_LOAD_BACK_END_SELECTED;
                    
                    return is_admin();
                    break;
                
                default:
                    break;
            }
        
        $status->message = 'Enqueued';
        $status->code = GoogleMapsAPILoader::ENQUEUED;
        
        return true;
    }
    
    /**
     * This function hooks into script_loader_tag. If any other plugin or the theme has enqueued a script containing "maps.google", an empty string will be returned, preventing that script loader tag from being rendered. Only the script with the handle wpgmza_api_call will be allowed through. This can be bound using the "prevent other plugins and theme loading maps API" setting.
     * @param string $tag The full script tag
     * @param string $handle The handle the script was enqueued with
     * @param string $src The URL to the script file
     * @return string Either $tag where permitted, or an empty string if this function should block
     */
    public function preventOtherGoogleMapsTag($tag, $handle, $src)
    {
        if(preg_match('/maps\.google/i', $src))
        {
            if(!$this->isIncludeAllowed($status))
                return '';
            
            if($handle != 'wpgmza_api_call')
                return '';
            
            if(!preg_match('/\?.+$/', $src))
                return str_replace($src, $src . '?' . http_build_query($this->getGoogleMapsAPIParams()), $tag);
        }

        return $tag;
    }
    
    /**
     * Gets the HTML for the settings panel for this module, which appears in the general settings tab.
     * @return string The HTML string for the settings panel
     */
    public function getSettingsHTML()
    {
        global $wpgmza;
        
        // Load our subclass of PHPs DOMDocument, for the populate function
        require_once(plugin_dir_path(__FILE__) . 'class.dom-document.php');
        
        // Load HTML
        $document = new DOMDocument();
        $document->loadPHPFile(plugin_dir_path(__DIR__) . 'html/google-maps-api-settings.html.php');
        
        // Populate options. This is a quick way to put key => value array/object values into elements with "name" matching "key"
        $document->populate($wpgmza->settings);
        
        return $document->saveInnerBody();
    }
    
}