Parse geo URIs (#189)

* Add function to parse geo into mf

* Remove duplicate code

* Final parsing fixes

* Bump version

Author: dshanske

includes/class-micropub-endpoint.php

@@ -167,6 +167,17 @@ protected static function load_input( $request ) {
 			}
 			static::log_error( static::$input, 'Micropub Input' );
 		}
+
+		if ( isset( static::$input['properties'] ) ) {
+			$properties = static::$input['properties'];
+			if ( isset( $properties['location'] ) ) {
+				static::$input['properties']['location'] = self::parse_geo_uri( $properties['location'][0] );
+			}
+			if ( isset( $properties['checkin'] ) ) {
+				static::$input['properties']['checkin'] = self::parse_geo_uri( $properties['checkin'][0] );
+			}
+		}
+
 		static::$input = apply_filters( 'before_micropub', static::$input );
 	}
 
@@ -775,7 +786,7 @@ public static function default_file_handler( $post_id ) {
 	public static function store_geodata( $args ) {
 		$properties = static::get( static::$input, 'properties' );
 		$location   = static::get( $properties, 'location', static::get( $properties, 'checkin' ) );
-		$location   = static::get( $location, 0, null );
+		$location   = static::get( $location, 0, $location );
 		// Location-visibility is an experimental property https://indieweb.org/Micropub-extensions#Location_Visibility
 		// It attempts to mimic the geo_public property
 		$visibility = static::get( $properties, 'location-visibility', null );
@@ -807,6 +818,7 @@ public static function store_geodata( $args ) {
 			if ( ! isset( $args['meta_input'] ) ) {
 				$args['meta_input'] = array();
 			}
+			// $location = self::parse_geo_uri( $location );
 			if ( is_array( $location ) ) {
 				$props = $location['properties'];
 				if ( isset( $props['geo'] ) ) {
@@ -834,44 +846,72 @@ function( $v ) {
 				$args['meta_input']['geo_latitude']  = $props['latitude'][0];
 				$args['meta_input']['geo_longitude'] = $props['longitude'][0];
 				$args['meta_input']['geo_altitude']  = $props['altitude'][0];
-			} elseif ( 'geo:' === substr( $location, 0, 4 ) ) {
-				// Geo URI format:
-				// http://en.wikipedia.org/wiki/Geo_URI#Example
-				// https://indieweb.org/Micropub#h-entry
-				//
-				// e.g. geo:37.786971,-122.399677;u=35
-				$geo                                 = explode( ':', substr( urldecode( $location ), 4 ) );
-				$geo                                 = explode( ';', $geo[0] );
-				$coords                              = explode( ',', $geo[0] );
-				$args['meta_input']['geo_latitude']  = trim( $coords[0] );
-				$args['meta_input']['geo_longitude'] = trim( $coords[1] );
-				// Geo URI optionally allows for altitude to be stored as a third csv
-				if ( isset( $coords[2] ) ) {
-					$args['meta_input']['geo_altitude'] = trim( $coords[2] );
-				}
-				// Store additional parameters
-				array_shift( $geo ); // Remove coordinates to check for other parameters
-				$params = array();
-				foreach ( $geo as $g ) {
-					$g               = explode( '=', $g );
-					$params[ $g[0] ] = $g[1];
-				}
-				$args['meta_input']['geo'] = $params;
-				if ( array_key_exists( 'u', $params ) ) {
-					$args['meta_input']['geo_accuracy'] = $params['u'];
-				}
-				if ( array_key_exists( 'name', $params ) ) {
-					$args['meta_input']['geo_address'] = $params['name'];
-				} elseif ( array_key_exists( 'label', $params ) ) {
-					$args['meta_input']['geo_address'] = $params['label'];
-				}
+				$args['meta_input']['geo_accuracy']  = $props['accuracy'][0];
 			} elseif ( 'http' !== substr( $location, 0, 4 ) ) {
 				$args['meta_input']['geo_address'] = $location;
 			}
 		}
 		return $args;
 	}
 
+	/**
+	 * Parse a GEO URI into an mf2 object for storage
+	 */
+	public static function parse_geo_uri( $uri ) {
+		if ( ! is_string( $uri ) ) {
+			return $uri;
+		}
+		// Ensure this is a geo uri
+		if ( 'geo:' !== substr( $uri, 0, 4 ) ) {
+			return $uri;
+		}
+		$properties = array();
+		// Geo URI format:
+		// http://en.wikipedia.org/wiki/Geo_URI#Example
+		// https://indieweb.org/Micropub#h-entry
+		//
+		// e.g. geo:37.786971,-122.399677;u=35
+		$geo                     = str_replace( 'geo:', '', urldecode( $uri ) );
+		$geo                     = explode( ';', $geo );
+		$coords                  = explode( ',', $geo[0] );
+		$properties['latitude']  = array( trim( $coords[0] ) );
+		$properties['longitude'] = array( trim( $coords[1] ) );
+		// Geo URI optionally allows for altitude to be stored as a third csv
+		if ( isset( $coords[2] ) ) {
+			$properties['altitude'] = array( trim( $coords[2] ) );
+		}
+		// Store additional parameters
+		array_shift( $geo ); // Remove coordinates to check for other parameters
+		foreach ( $geo as $g ) {
+			$g = explode( '=', $g );
+			if ( 'u' === $g[0] ) {
+				$g[0] = 'accuracy';
+			}
+			$properties[ $g[0] ] = array( $g[1] );
+		}
+		// If geo URI is overloaded h-card... e.g. geo:37.786971,-122.399677;u=35;h=card;name=Home;url=https://example.com
+		if ( array_key_exists( 'h', $return ) ) {
+			$type = array( 'h-' . $properties['h'][0] );
+			unset( $properties['h'] );
+		} else {
+			$diff = array_diff(
+				array_keys( $properties ),
+				array( 'longitude', 'latitude', 'altitude', 'accuracy' )
+			);
+			// If empty that means this is a geo
+			if ( empty( $diff ) ) {
+				$type = array( 'h-geo' );
+			} else {
+				$type = array( 'h-card' );
+			}
+		}
+
+		return array(
+			'type'       => $type,
+			'properties' => array_filter( $properties ),
+		);
+	}
+
 	/**
 	 * Store the return of the authorization endpoint as post metadata. Details:
 	 * https://tokens.indieauth.com/

micropub.php

@@ -7,7 +7,7 @@
  * Author: Ryan Barrett
  * Author URI: https://snarfed.org/
  * Text Domain: micropub
- * Version: 2.0.7
+ * Version: 2.0.8
  */
 
 /* See README for supported filters and actions.

readme.md

@@ -212,7 +212,11 @@ into markdown and saved to readme.md.
 ## Changelog 
 
 
-### 2.0.7 (2018-02-18) 
+### 2.0.8 (2019-03-08) 
+* Parse geo URI into h-geo or h-card object
+
+
+### 2.0.7 (2019-02-18) 
 * Update geo storage to fix accuracy storage as well as allow for name parameter and future parameters to be passed. Indigenous for Android now supports passing this
 
 

readme.txt

@@ -3,8 +3,8 @@ Contributors: indieweb, snarfed, dshanske
 Tags: micropub, publish, indieweb, microformats
 Requires at least: 4.7
 Requires PHP: 5.3
-Tested up to: 5.0.3
-Stable tag: 2.0.7
+Tested up to: 5.1
+Stable tag: 2.0.8
 License: CC0
 License URI: http://creativecommons.org/publicdomain/zero/1.0/
 Donate link: -
@@ -207,7 +207,10 @@ into markdown and saved to readme.md.
 
 == Changelog ==
 
-= 2.0.7 (2018-02-18) =
+= 2.0.8 (2019-03-08) =
+* Parse geo URI into h-geo or h-card object
+
+= 2.0.7 (2019-02-18) =
 * Update geo storage to fix accuracy storage as well as allow for name parameter and future parameters to be passed. Indigenous for Android now supports passing this
 
 = 2.0.6 (2018-12-30) =

tests/test_endpoint.php

@@ -16,7 +16,7 @@ class Micropub_Endpoint_Test extends WP_UnitTestCase {
 		'summary'   => 'my summary',
 		'category'  => array( 'tag1', 'tag4' ),
 		'published' => '2016-01-01T04:01:23-08:00',
-		'location'  => 'geo:42.361,-71.092;u=25000',
+		'location'  => 'geo:42.361,-71.092,25000;u=25000',
 	);
 
 	// JSON mf2 input
@@ -29,7 +29,7 @@ class Micropub_Endpoint_Test extends WP_UnitTestCase {
 			'summary'   => array( 'my summary' ),
 			'category'  => array( 'tag1', 'tag4' ),
 			'published' => array( '2016-01-01T04:01:23-08:00' ),
-			'location'  => array( 'geo:42.361,-71.092;u=25000' ),
+			'location'  => array( 'geo:42.361,-71.092,25000;u=25000' ),
 		),
 	);
 
@@ -51,6 +51,7 @@ class Micropub_Endpoint_Test extends WP_UnitTestCase {
 			'latitude'  => array( '42.361' ),
 			'longitude' => array( '-71.092' ),
 			'altitude'  => array( '25000' ),
+			'accuracy'  => array( '25000' )
 		),
 	);
 
@@ -101,6 +102,11 @@ public function setUp() {
 		static::$scopes = array( 'post' );
 	}
 
+	public function test_parse_geo_uri() {
+		$geo = Micropub_Endpoint::parse_geo_uri( 'geo:42.361,-71.092,25000;u=25000' );
+		$this->assertEquals( $geo, static::$geo );
+		}
+
 
 	public function test_register_routes() {
 		$routes = rest_get_server()->get_routes();
@@ -196,6 +202,7 @@ public function check_create_basic( $request, $input = null ) {
 		if ( ! $input ) {
 			$input = static::$mf2;
 		}
+
 		$post = $this->check_create( $request );
 		$this->assertEquals( 'publish', $post->post_status );
 		$this->assertEquals( 'post', $post->post_type );
@@ -212,7 +219,9 @@ public function check_create_basic( $request, $input = null ) {
 		$this->assertEquals( '42.361', get_post_meta( $post->ID, 'geo_latitude', true ) );
 		$this->assertEquals( '-71.092', get_post_meta( $post->ID, 'geo_longitude', true ) );
 		$this->assertEquals( '', get_post_meta( $post->ID, 'geo_address', true ) );
-		$this->assertEquals( $input, $this->query_source( $post->ID ) );
+		$source = $this->query_source( $post->ID );
+		$input['properties']['location'] = static::$geo;
+		$this->assertEquals( $input, $source, wp_json_encode( $source ) );
 		return $post;
 	}