Adds Filters to Geocoder; Sets options to autoload=false

class.geocoder.php

@@ -2,7 +2,7 @@
 /**
 * Geocoder
 *
-* calls the specific geocoder function (chosen in admin or default: google_geocode)
+* calls the specific geocoder function (chosen in admin or default: osm)
 *
 */
 
@@ -11,7 +11,7 @@ class Leaflet_Geocoder {
     * Geocoder should return this on error/not found
     * @var array $not_found
     */
-    private $not_found = array('lat' => 0, 'lng' => 0);
+    private static $not_found = array('lat' => 0, 'lng' => 0);
     /**
     * Latitude
     * @var float $lat
@@ -23,6 +23,9 @@ class Leaflet_Geocoder {
     */
     public $lng = 0;
 
+    /** key for all locations */
+    public static $locations_key = 'leaflet_geocoded_locations';
+
     /**
     * new Geocoder from address
     *
@@ -42,7 +45,7 @@ public function __construct ($address) {
         $cached_address = 'leaflet_' . $geocoder . '_' . $address;
 
         /* retrieve cached geocoded location */
-        $found_cache = get_option( $cached_address );
+        $found_cache = $this->get_cache( $cached_address, $address );
 
         if ( $found_cache ) {
             $location = $found_cache;
@@ -53,16 +56,17 @@ public function __construct ($address) {
             try {
                 $location = (Object) $this->$geocoding_method( $address );
 
-                /* add location */
-                add_option($cached_address, $location);
+                /* update location data in db/cache */
+                $this->set_cache( $cached_address, $location );
 
-                /* add option key to locations for clean up purposes */
-                $locations = get_option('leaflet_geocoded_locations', array());
-                array_push($locations, $cached_address);
-                update_option('leaflet_geocoded_locations', $locations);
+                /* add cache to cached list for cleanup */
+                $this->update_caches( $cached_address );
             } catch (Exception $e) {
-                // failed
-                $location = $this->not_found;
+                /**
+                 * @since 3.4.0
+                 * use 'leaflet_geocoder_not_found' filter to return your own not_found response
+                 */
+                $location = apply_filters( 'leaflet_geocoder_not_found', self::$not_found );
             }
         }
 
@@ -72,17 +76,6 @@ public function __construct ($address) {
         }
     }
 
-    /**
-    * Removes location caches
-    */
-    public static function remove_caches () {
-        $addresses = get_option('leaflet_geocoded_locations', array());
-        foreach ($addresses as $address) {
-            delete_option($address);
-        }
-        delete_option('leaflet_geocoded_locations');
-    }
-
     /**
     * Used by geocoders to make requests via curl or file_get_contents
     *
@@ -95,13 +88,12 @@ private function get_url( $url ) {
         $referer = get_site_url();
 
         if (in_array('curl', get_loaded_extensions())) {
-            /* try curl */
             $ch = curl_init();
 
             curl_setopt($ch, CURLOPT_AUTOREFERER, TRUE);
             curl_setopt($ch, CURLOPT_HEADER, 0);
-                    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
-                    curl_setopt($ch, CURLOPT_REFERER, $referer);
+            curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
+            curl_setopt($ch, CURLOPT_REFERER, $referer);
             curl_setopt($ch, CURLOPT_URL, $url);
             curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE);
 
@@ -110,14 +102,12 @@ private function get_url( $url ) {
 
             return $data;
         } else if (ini_get('allow_url_fopen')) {
-                    /* try file get contents */
-
-                    $opts = array(
-                        'http' => array(
-                            'header' => array("Referer: $referer\r\n")
-                        )
-                    );
-                    $context = stream_context_create($opts);
+            $opts = array(
+                'http' => array(
+                    'header' => array("Referer: $referer\r\n")
+                )
+            );
+            $context = stream_context_create($opts);
 
             return file_get_contents($url, false, $context);
         }
@@ -132,7 +122,6 @@ private function get_url( $url ) {
     * @param string $address    the urlencoded address to look up
     * @return varies object from API or null (failed)
     */
-
     private function google_geocode ( $address ) {
         // Leaflet_Map_Plugin_Settings
         $settings = Leaflet_Map_Plugin_Settings::init();
@@ -146,7 +135,6 @@ private function google_geocode ( $address ) {
 
         /* found location */
         if ($json->status == 'OK') {
-
             $location = $json->results[0]->geometry->location;
 
             return (Object) $location;
@@ -161,7 +149,6 @@ private function google_geocode ( $address ) {
     * @param string $address    the urlencoded address to look up
     * @return varies object from API or null (failed)
     */
-
     private function osm_geocode ( $address ) {
         $geocode_url = 'https://nominatim.openstreetmap.org/?format=json&limit=1&q=';
         $geocode_url .= $address;
@@ -198,4 +185,89 @@ private function dawa_geocode ( $address ) {
             'lng' => $json[0]->adgangsadresse->adgangspunkt->koordinater[0]
         );
     }
+
+    /** 
+     * gets a single location's coordinates from the cached locations
+     */
+    public function get_cache($address_key, $plain_address) {
+        /** 
+         * @since 3.4.0
+         * using 'leaflet_geocoder_get_cache', 
+         * you can return any value that is not identical to the address_key to avoid using get_transient
+         */
+        $filtered = apply_filters( 'leaflet_geocoder_get_cache', $address_key, $plain_address );
+
+        if ($filtered === $address_key) {
+            return get_transient( $address_key );
+        }
+
+        return $filtered;
+    }
+
+    /** 
+     * gets the array of saved locations and updates an individual location
+     */
+    public function set_cache($key, $value) {
+        /** 
+         * @since 3.4.0
+         * using 'leaflet_geocoder_set_cache', 
+         * you can return any falsy value to omit the set_transient
+         */
+        if (apply_filters('leaflet_geocoder_set_cache', $key, $value)) {
+            // get user-defined expiry (maybe this should be an admin option?)
+            $expiry = apply_filters('leaflet_geocoder_expiry', null);
+
+            if ($expiry === null) {
+                // stagger caches between 200-400 days to prevent all caches expiring on the same day
+                $stagger = random_int(200, 400);
+                $expiry = DAY_IN_SECONDS * $stagger;
+            }
+
+            set_transient( $key, $value, $expiry );
+        }
+    }
+
+    /**
+     * Appends an address to a list of addresses in the db, for cleanup
+     */
+    public function update_caches( $address ) {
+        /** 
+         * @since 3.4.0
+         * using 'leaflet_geocoder_update_caches', 
+         * you can return any falsy value to omit the set_transient
+         */
+        if (apply_filters('leaflet_geocoder_update_caches', $address)) {
+            $locations = get_transient( self::$locations_key );
+
+            if (!$locations) {
+                $locations = array();
+            }
+
+            array_push( $locations, $address );
+
+            // set to 25 year expiry since we never really want it to expire
+            // but omitting expiry causes it to autoload
+            set_transient( self::$locations_key, $locations, YEAR_IN_SECONDS * 25 );
+        }
+    }
+
+    /**
+    * Removes all location caches
+    */
+    public static function remove_caches() {
+        /** @since 3.4.0 */
+        do_action('leaflet_geocoder_remove_caches');
+
+        $addresses = get_transient( self::$locations_key );
+
+        if ( !$addresses ) {
+            return;
+        }
+
+        foreach ($addresses as $address) {
+            delete_transient( $address );
+        }
+
+        delete_transient( self::$locations_key );
+    }
 }

class.leaflet-map.php

@@ -104,13 +104,34 @@ public static function init() {
      * Leaflet_Map Constructor
      */
     private function __construct() {
+        $this->run_migrations();
         $this->init_hooks();
         $this->add_shortcodes();
 
         // loaded
         do_action('leaflet_map_loaded');
     }
 
+    /**
+     * Check for version discrepancy and run migrations if necessary
+     * @since 3.4.0
+     */
+    private function run_migrations() {
+        // assume 3.3.0 if it doesn't exist
+        $db_version = get_option(LEAFLET_MAP__DB_VERSION_KEY, '3.3.0');
+
+        if ($db_version === LEAFLET_MAP__PLUGIN_VERSION) {
+            return;
+        }
+
+        include_once LEAFLET_MAP__PLUGIN_DIR . 'class.migrations.php';
+
+        Leaflet_Map_Migrations::run_once($db_version);
+
+        // set db version to current plugin version
+        update_option(LEAFLET_MAP__DB_VERSION_KEY, LEAFLET_MAP__PLUGIN_VERSION);
+    }
+
     /**
      * Add actions and filters
      */
@@ -187,8 +208,8 @@ public static function enqueue_and_register()
         $js_url = $settings->get('js_url');
         $css_url = $settings->get('css_url');
 
-        wp_register_style('leaflet_stylesheet', $css_url, Array(), null, false);
-        wp_register_script('leaflet_js', $js_url, Array(), null, true);
+        wp_register_style('leaflet_stylesheet', $css_url, Array(), LEAFLET_MAP__PLUGIN_VERSION, false);
+        wp_register_script('leaflet_js', $js_url, Array(), LEAFLET_MAP__PLUGIN_VERSION, true);
 
         // new required MapQuest javascript file
         $tiling_service = $settings->get('default_tiling_service');
@@ -204,7 +225,8 @@ public static function enqueue_and_register()
         // optional ajax geojson plugin
         wp_register_script('tmcw_togeojson', $settings->get('togeojson_url'), Array('jquery'), LEAFLET_MAP__PLUGIN_VERSION, false);
 
-        if (defined('WP_DEBUG') && WP_DEBUG) {
+        // @since 3.4.0
+        if (defined('LEAFLET_MAP__DEBUG') && LEAFLET_MAP__DEBUG) {
             $minified = '';
         } else {
             $minified = '.min';

class.migrations.php

@@ -0,0 +1,40 @@
+<?php
+/**
+ * Leaflet Map Migrations
+ * @since 3.4.0
+ */
+
+// Exit if accessed directly
+if (!defined('ABSPATH')) {
+    exit;
+}
+
+define('LEAFLET_MAP__MIGRATION_DIR', LEAFLET_MAP__PLUGIN_DIR . 'migrations/');
+
+class Leaflet_Map_Migrations {
+    /**
+     * only call once
+     **/
+    private static $called = false;
+
+    /**
+     * We assume if this is called, our db version diverges from plugin version
+     * migrations here are run in ascending order, always compared via '<' against db version
+     */
+    public static function run_once($db_version) {
+        if ( self::$called ) {
+            return;
+        }
+
+        self::$called = true;
+
+        if (version_compare($db_version, '3.4.0', '<')) {
+            include_once LEAFLET_MAP__MIGRATION_DIR . '001-v3.4.0-geocoder-transients.php';
+
+            migration001();
+
+            // update version, if for some reason something fails afterwards, and we want to prevent this migration
+            update_option(LEAFLET_MAP__DB_VERSION_KEY, '3.4.0');
+        }
+    }
+}

docker-compose.yml

@@ -58,6 +58,14 @@ services:
       WORDPRESS_DB_PASSWORD: wordpress
       WORDPRESS_DEBUG: 1
 
+  # phpmyadmin:
+  #   image: phpmyadmin
+  #   restart: always
+  #   ports:
+  #     - 8080:80
+  #   environment:
+  #     - PMA_ARBITRARY=1
+
 volumes:
   wp_db:
   wordpress:

leaflet-map.php

@@ -3,12 +3,12 @@
 /**
  * Plugin Name: Leaflet Map
  * Plugin URI: https://wordpress.org/plugins/leaflet-map/
- * Description: A plugin for creating a Leaflet JS map with a shortcode. Boasts two free map tile services and three free geocoders.
+ * Description: A plugin for creating a Leaflet JS map with shortcodes. Boasts integrations with free map tile services and geocoders.
  * Author: bozdoz
  * Author URI: https://bozdoz.com/
  * Text Domain: leaflet-map
  * Domain Path: /languages/
- * Version: 3.3.0
+ * Version: 3.4.0
  * License: GPL2
  * Leaflet Map is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -29,14 +29,14 @@
     exit; 
 }
 
-define('LEAFLET_MAP__PLUGIN_VERSION', '3.3.0');
+define('LEAFLET_MAP__PLUGIN_VERSION', '3.4.0');
+define('LEAFLET_MAP__DB_VERSION_KEY', 'leaflet_map_version');
 define('LEAFLET_MAP__PLUGIN_FILE', __FILE__);
 define('LEAFLET_MAP__PLUGIN_DIR', plugin_dir_path(__FILE__));
 
 // import main class
 require_once LEAFLET_MAP__PLUGIN_DIR . 'class.leaflet-map.php';
 
-// uninstall hook
 register_uninstall_hook(__FILE__, array('Leaflet_Map', 'uninstall'));
 
-add_action('init', array('Leaflet_Map', 'init'));
+add_action('init', array('Leaflet_Map', 'init'));