Overview

Namespaces

  • None
  • WPGMZA
    • CustomFieldFilterWidget
    • Integration
    • MarkerListing
    • Selector

Classes

  • WPGMapsImportExport
  • WPGMZA\AddMapDialog
  • WPGMZA\AdminMarkerDataTable
  • WPGMZA\AjaxTable
  • WPGMZA\AutoLoader
  • WPGMZA\Categories
  • WPGMZA\Category
  • WPGMZA\CategoryTree
  • WPGMZA\CategoryTreeNode
  • WPGMZA\ContentEditorMapButton
  • WPGMZA\Crud
  • WPGMZA\CustomFieldFilter
  • WPGMZA\CustomFieldFilterController
  • WPGMZA\CustomFieldFilterWidget
  • WPGMZA\CustomFieldFilterWidget\Checkboxes
  • WPGMZA\CustomFieldFilterWidget\Dropdown
  • WPGMZA\CustomFieldFilterWidget\Text
  • WPGMZA\CustomFields
  • WPGMZA\CustomFieldsPage
  • WPGMZA\CustomMapObjectFields
  • WPGMZA\CustomMarkerFields
  • WPGMZA\Database
  • WPGMZA\DataTable
  • WPGMZA\Distance
  • WPGMZA\DOMDocument
  • WPGMZA\DOMElement
  • WPGMZA\Export
  • WPGMZA\Factory
  • WPGMZA\FontAwesomeIconPicker
  • WPGMZA\GDPRCompliance
  • WPGMZA\GlobalSettings
  • WPGMZA\GoogleGeocoder
  • WPGMZA\GoogleMap
  • WPGMZA\GoogleMapsAPILoader
  • WPGMZA\GoogleMapsLoader
  • WPGMZA\GoogleProMapsLoader
  • WPGMZA\Import
  • WPGMZA\ImportCSV
  • WPGMZA\ImportGPX
  • WPGMZA\ImportJSON
  • WPGMZA\ImportKML
  • WPGMZA\Integration\Gutenberg
  • WPGMZA\Integration\ProGutenberg
  • WPGMZA\Integration\WPMigrateDB
  • WPGMZA\LatLng
  • WPGMZA\Map
  • WPGMZA\MapSelect
  • WPGMZA\MapsEngineDialog
  • WPGMZA\Marker
  • WPGMZA\MarkerDataTable
  • WPGMZA\MarkerFilter
  • WPGMZA\MarkerLibraryDialog
  • WPGMZA\MarkerListing
  • WPGMZA\MarkerListing\AdvancedTable
  • WPGMZA\MarkerListing\BasicList
  • WPGMZA\MarkerListing\BasicTable
  • WPGMZA\MarkerListing\Carousel
  • WPGMZA\MarkerListing\Modern
  • WPGMZA\ModalDialog
  • WPGMZA\NominatimGeocodeCache
  • WPGMZA\OLLoader
  • WPGMZA\OLProLoader
  • WPGMZA\Plugin
  • WPGMZA\ProAdminMarkerDataTable
  • WPGMZA\ProMap
  • WPGMZA\ProMarker
  • WPGMZA\ProMarkerFilter
  • WPGMZA\ProPlugin
  • WPGMZA\ProRestAPI
  • WPGMZA\Query
  • WPGMZA\QueryFragment
  • WPGMZA\RestAPI
  • WPGMZA\ScriptLoader
  • WPGMZA\Selector\AttributeSelector
  • WPGMZA\Selector\Parser
  • WPGMZA\Selector\PseudoSelector
  • WPGMZA\Selector\Selector
  • WPGMZA\Selector\Token
  • WPGMZA\Selector\Tokenizer
  • WPGMZA\Selector\TokenStream
  • WPGMZA\Selector\XPathConverter
  • WPGMZA\Strings
  • WPGMZA\Table

Exceptions

  • WPGMZA\Selector\ConvertException
  • WPGMZA\Selector\ParseException

Functions

  • old_wpgmaps_list_categories
  • old_wpgmza_pro_return_category_select_list
  • wpgmaps_admin_add_poly_javascript
  • wpgmaps_admin_add_polyline_javascript
  • wpgmaps_admin_category_scripts
  • wpgmaps_admin_category_styles
  • wpgmaps_admin_edit_poly_javascript
  • wpgmaps_admin_edit_polyline_javascript
  • wpgmaps_admin_wizard_scripts
  • wpgmaps_category_head
  • wpgmaps_list_categories
  • wpgmaps_menu_category_layout
  • wpgmaps_trash_cat
  • wpgmaps_wizard_layout
  • WPGMZA\add_custom_filter_widgets
  • WPGMZA\create_marker_instance_delegate
  • WPGMZA\custom_field_filter_get_filtered_marker_ids
  • WPGMZA\get_custom_field_filter
  • WPGMZA\get_custom_field_filter_controller
  • WPGMZA\get_custom_field_filter_widget
  • WPGMZA\get_marker_custom_fields
  • WPGMZA\import_ajax_delete_schedule
  • WPGMZA\import_ajax_file_options
  • WPGMZA\import_ajax_handle_delete
  • WPGMZA\import_ajax_handle_upload
  • WPGMZA\import_ajax_import
  • WPGMZA\import_ajax_schedule
  • WPGMZA\import_cron_import
  • WPGMZA\import_cron_schedules
  • WPGMZA\import_export_admin_options
  • WPGMZA\import_export_admin_tabs
  • WPGMZA\import_export_download
  • WPGMZA\import_export_get_maps_list
  • WPGMZA\import_get_progress
  • WPGMZA\import_get_schedule
  • WPGMZA\import_mimes
  • WPGMZA\import_wp_check_filetype_and_ext
  • WPGMZA\load_advanced_menu_page_hooks
  • WPGMZA\query_nominatim_cache
  • WPGMZA\Selector\trace
  • WPGMZA\show_custom_fields_page
  • WPGMZA\store_nominatim_cache
  • wpgmza_backwards_compat_get_all_circle_data
  • wpgmza_backwards_compat_get_all_rectangle_data
  • wpgmza_build_tree
  • wpgmza_check_admin_head_backwards_compat_v6
  • wpgmza_check_cat_map
  • wpgmza_check_map_editor_backwards_compat_v6
  • wpgmza_check_pro_compat_required_v6
  • wpgmza_check_user_backwards_compat_v6
  • wpgmza_consume_tree
  • wpgmza_consume_tree_dropdown
  • wpgmza_consume_tree_main_list
  • wpgmza_get_category_localized_data
  • wpgmza_pro_add_poly
  • wpgmza_pro_add_polyline
  • wpgmza_pro_category_edit_layout
  • wpgmza_pro_category_new_layout
  • wpgmza_pro_edit_poly
  • wpgmza_pro_edit_polyline
  • wpgmza_pro_return_category_blocks
  • wpgmza_pro_return_category_checkbox_list
  • wpgmza_pro_return_category_dropdown_list
  • wpgmza_pro_return_category_select_list
  • wpgmza_pro_return_maps_linked_to_cat
  • wpgmza_return_all_categories
  • wpgmza_return_category_data
  • wpgmza_return_marker_count_by_category
  • wpgmza_return_marker_count_category_via_elements
  • wpgmza_return_poly_options
  • wpgmza_return_polygon_array
  • wpgmza_return_polygon_id_array
  • wpgmza_return_polygon_list
  • wpgmza_return_polyline_array
  • wpgmza_return_polyline_id_array
  • wpgmza_return_polyline_list
  • wpgmza_return_polyline_options
  • wpgmza_tree_marker_counter
  • wpgmza_wizard_item_control_c
  • wpgmza_wizard_item_control_gd
  • wpgmza_wizard_item_control_ml
  • wpgmza_wizard_item_control_sl
  • Overview
  • Namespace
  • Class
  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: 
<?php
/**
 * WP Google Maps Pro Import / Export API: Import abstract class
 *
 * @package WPGMapsPro\ImportExport
 * @since 7.0.0
 */

namespace WPGMZA;

/**
 * Importer for WP Google Maps Pro
 *
 * This handles importing of files.
 *
 * @since 7.0.0
 */
abstract class Import {

    /**
     * Absolute path to file.
     *
     * @var string $file Absolute path to file.
     */
    protected $file = '';

    /**
     * URL to file.
     *
     * @var string $file URL to file.
     */
    protected $file_url = '';

    /**
     * Decoded file data.
     *
     * @var mixed $file_data Decoded file data.
     */
    protected $file_data = null;

    /**
     * Import options.
     *
     * @var array $options Import options.
     */
    protected $options = array();

    /**
     * Database insertion defaults.
     *
     * @var array $db_defaults Array of object types with key value pairs of default data.
     */
    protected $db_defaults = array();
    
    private $recorded_start_time;
    
    /**
     * Import constructor.
     *
     * @throws \Exception If unable to load file.
     *
     * @param string $file     Optional. Absolute path to file.
     * @param string $file_url Optional. URL to file.
     * @param array  $options  Optional. Import options.
     */
    public function __construct( $file = '', $file_url = '', $options = array() ) {

        $this->options = $options;
        if ( file_exists( $file ) ) {

            $this->file = $file;

        }

        if ( strpos( $file_url, 'http' ) === 0 ) {

            $this->file_url = $file_url;

        }

        $this->load_file();
        $this->parse_file();
        
        if ( empty( $this->file_data ) ) {

            throw new \Exception( __( 'Error: Unable to load file.', 'wp-google-maps' ) );

        }

        $this->options = $options;
        $this->check_options();
        
        $this->record_start_time();
        $this->attempt_set_time_limit();
    }

    /**
     * Sanitize options.
     */
    abstract protected function check_options();

    /**
     * Check ids.
     *
     * @throws \Exception On bad id.
     *
     * @param array $ids Integer array of ids.
     * @return array Integer array of ids.
     */
    protected function check_ids( $ids ) {

        $id_count = count( $ids );

        for ( $i = 0; $i < $id_count; $i++ ) {

            if ( ! is_numeric( $ids[ $i ] ) ) {

                throw new \Exception( __( 'Error: Malformed options. Bad id.', 'wp-google-maps' ) );

            }

            $ids[ $i ] = absint( $ids[ $i ] );

            if ( $ids[ $i ] < 1 ) {

                throw new \Exception( __( 'Error: Malformed options. Bad id.', 'wp-google-maps' ) );

            }
        }

        return $ids;

    }

    /**
     * Load file data from file.
     */
    protected function load_file() {

        if ( ! empty( $this->file ) ) {

            $file_contents = file_get_contents( $this->file );

            if ( ! empty( $file_contents ) ) {

                $this->file_data = $file_contents;

            }
            
        }

        if ( empty( $file_contents ) && ! empty( $this->file_url ) ) {

            $file_contents = wp_remote_get( $this->file_url );
            
            if ( ! is_wp_error( $file_contents ) ) {

                $this->file_data = wp_remote_retrieve_body( $file_contents );

            }
        }
    }
    
    protected function attempt_set_time_limit()
    {
        $desired_time_limit = 60 * 15;
        
        if(function_exists('set_time_limit'))
            set_time_limit($desired_time_limit);
        
        if(function_exists('get_time_limit'))
            ini_set('max_execution_time', $desired_time_limit);
    }
    
    protected function record_start_time()
    {
        $this->recorded_start_time = time();
    }
    
    protected function get_time_limit()
    {
        if(function_exists('ini_get'))
            return (int)ini_get('max_execution_time');
        
        return 30; // PHP default
    }
    
    protected function get_remaining_time()
    {
        $now = time();
        $elapsed = (int)$now - (int)$this->recorded_start_time;
        $limit = $this->get_time_limit();
        
        return $limit - $elapsed;
    }
    
    protected function bail_if_near_time_limit()
    {
        $remaining = $this->get_remaining_time();
        $threshold = 5;
        
        if($remaining < $threshold)
            throw new \Exception(__('Time limit threshold reached. Please speak to your host to increase your PHP execution time limit, or break your data into smaller parts', 'wp-google-maps'));
    }

    /**
     * Parse file data.
     */
    abstract protected function parse_file();

    /**
     * Output admin import options.
     *
     * @return string Options html.
     */
    abstract public function admin_options();

    /**
     * Import the file.
     */
    abstract public function import();
    
    public function onImportComplete()
    {
        global $wpdb;
        global $wpgmza_tblname_maps;
        
        // TODO: Use global settings module
        $settings = get_option('WPGMZA_OTHER_SETTINGS');
        
        if(!empty($settings['wpgmza_settings_marker_pull']) && $settings['wpgmza_settings_marker_pull'] == '1') // TODO: Replace with constant
        {
            $map_ids = $wpdb->get_col("SELECT id FROM $wpgmza_tblname_maps");
            
            foreach($map_ids as $map_id)
                wpgmaps_update_xml_file($map_id);
        }
        
        do_action('wpgmza_import_complete');
    }

    /**
     * Sets the import progress for this session.
     *
     * @param float $value A number between 0 and 1 representing the progress.
     */
    public function set_progress( $value ) {

        @session_start();

        $_SESSION['wpgmza_import_progress_' . $_POST['wpgmaps_security']] = $value;

        session_write_close();

    }

    /**
     * Returns HTML for the admin notices.
     *
     * @return string
     */
    public function get_admin_notices() {

        return '';

    }

    /**
     * Geocode.
     *
     * @param string $location Either an address or latitude, longitude coordinates.
     * @param string $type     Optional. 'address' to geocode, 'latlng' to reverse geocode. Default 'address'.
     * @return string|array|bool Address or array of latitude and longitude, false on failure or no results.
     */
    protected function geocode( $location, $type = 'address' ) {

        $api_key = get_option( 'wpgmza_google_maps_api_key' );

        if ( empty( $api_key ) || empty( $location ) || ( 'address' !== $type && 'latlng' !== $type ) ) {

            return false;

        }

        $url = add_query_arg( array(
            $type => rawurlencode( $location ),
            'key' => $api_key,
        ), 'https://maps.googleapis.com/maps/api/geocode/json' );

        $start_time = microtime( true );

        $response = wp_remote_get( $url );

        if ( is_wp_error( $response ) ) {

            return false;

        }

        $response = wp_remote_retrieve_body( $response );
        $response = json_decode( $response );

        $this->geocode_response = $response;

        $result = false;

        switch ( $type ) {

            case 'address':

                if ( isset( $response->results[0]->geometry->location->lat, $response->results[0]->geometry->location->lng ) ) {

                    $result = array( $response->results[0]->geometry->location->lat, $response->results[0]->geometry->location->lng );

                }
                break;

            case 'latlng':

                if ( isset( $response->results[0]->formatted_address ) ) {

                    $result = $response->results[0]->formatted_address;

                }
                break;

        }

        $end_time = microtime( true );
        $delta_time = $end_time - $start_time;
        $min_time_between_requests = 1000000 / 10;

        if ( $delta_time < $min_time_between_requests ) {

            $delay = $min_time_between_requests - $delta_time;
            usleep( $delay );

        }

        return $result;

    }
}
API documentation generated by ApiGen