Add support for location-visibility altitude and accuracy

Author: dshanske

micropub.php

@@ -893,13 +893,43 @@ public static function default_file_handler( $post_id ) {
 	 * https://ownyourswarm.p3k.io/docs#checkins
 	 *
 	 * WordPress geo data is stored in post meta: geo_address (free text),
-	 * geo_latitude, and geo_longitude:
+	 * geo_latitude, geo_longitude, and geo_public:
 	 * https://codex.wordpress.org/Geodata
+	 * It is noted that should the HTML5 style geolocation properties of altitude, accuracy, speed, and heading are
+	 * used they would use the same geo prefix. Simple Location stores these when available using accuracy to estimate
+	 * map zoom when displayed.
 	 */
 	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-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 );
+		if ( $visibility ) {
+			$visibility = array_pop( $visibility );
+			if ( ! isset( $args['meta_input'] ) ) {
+				$args['meta_input'] = array();
+			}
+			switch ( $visibility ) {
+				// Currently supported by https://github.com/dshanske/simple-location as part of the Geodata store noted in codex link above
+				// Public indicates coordinates, map, and textual description displayed
+				case 'public':
+					$args['meta_input']['geo_public'] = 1;
+					break;
+				// Private indicates no display
+				case 'private':
+					$args['meta_input']['geo_public'] = 0;
+					break;
+				// Protected which is not in the original geodata spec is used by Simple Location to indicate textual description only
+				case 'protected':
+					$args['meta_input']['geo_public'] = 2;
+					break;
+				default:
+					static::error( 400, 'unsupported location visibility ' . $visibility );
+
+			}
+		}
 		if ( $location ) {
 			if ( ! isset( $args['meta_input'] ) ) {
 				$args['meta_input'] = array();
@@ -928,17 +958,24 @@ public static function store_geodata( $args ) {
 				}
 				$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://indiewebcamp.com/micropub##location
+				// 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] );
+				$geo = explode( ':', substr( urldecode( $location ), 4 ) );
+				$geo = explode( ';', $geo[0] );
+				// Store the accuracy/uncertainty
+				$args['meta_input']['geo_accuracy']  = substr( $geo[1], 2 );
 				$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] );
+				}
 			} elseif ( 'http' !== substr( $location, 0, 4 ) ) {
 				$args['meta_input']['geo_address'] = $location;
 			}

tests/test_micropub.php

@@ -504,6 +504,7 @@ function test_create_location_h_geo() {
 
 		$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( '25000', get_post_meta( $post->ID, 'geo_altitude', true ) );
 		$this->assertEquals( '', get_post_meta( $post->ID, 'geo_address', true ) );
 	}
 
@@ -525,17 +526,62 @@ function test_create_location_h_adr() {
 		$this->assertEquals( '', get_post_meta( $post->ID, 'geo_address', true ) );
 	}
 
+	function test_create_location_geo_with_altitude() {
+		Recorder::$request_headers = array( 'content-type' => 'application/json; charset=utf-8' );
+		Recorder::$input = static::$mf2;
+		Recorder::$input['properties']['location'] = array( 'geo:42.361,-71.092,1500;u=25000' );
+		$post = self::check_create();
+
+		$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( '1500', get_post_meta( $post->ID, 'geo_altitude', true ) );
+	}
+
 	function test_create_location_plain_text() {
 		Recorder::$request_headers = array( 'content-type' => 'application/json; charset=utf-8' );
 		Recorder::$input = static::$mf2;
 		Recorder::$input['properties']['location'] = array( 'foo bar baz' );
 		$post = self::check_create();
-
 		$this->assertEquals( 'foo bar baz', get_post_meta( $post->ID, 'geo_address', true ) );
 		$this->assertEquals( '', get_post_meta( $post->ID, 'geo_latitude', true ) );
 		$this->assertEquals( '', get_post_meta( $post->ID, 'geo_longitude', true ) );
 	}
 
+	function test_create_location_visibility_private() {
+		Recorder::$request_headers = array( 'content-type' => 'application/json; charset=utf-8' );
+		Recorder::$input = static::$mf2;
+		Recorder::$input['properties']['location-visibility'] = array( 'private' );
+		$post = self::check_create();
+		$this->assertEquals( 0, get_post_meta( $post->ID, 'geo_public', true ) );
+
+	}
+
+	function test_create_location_visibility_public() {
+		Recorder::$request_headers = array( 'content-type' => 'application/json; charset=utf-8' );
+		Recorder::$input = static::$mf2;
+		Recorder::$input['properties']['location-visibility'] = array( 'public' );
+		$post = self::check_create();
+		$this->assertEquals( 1, get_post_meta( $post->ID, 'geo_public', true ) );
+
+	}
+
+	function test_create_location_visibility_unsupported() {
+		Recorder::$request_headers = array( 'content-type' => 'application/json; charset=utf-8' );
+		Recorder::$input = static::$mf2;
+		Recorder::$input['properties']['location-visibility'] = array( 'bleh' );
+		$this->check( 400, 'unsupported location visibility bleh' )	;
+	}
+
+
+	function test_create_location_visibility_none() {
+		Recorder::$request_headers = array( 'content-type' => 'application/json; charset=utf-8' );
+		Recorder::$input = static::$mf2;
+		$post = self::check_create();
+		$this->assertEquals( '', get_post_meta( $post->ID, 'geo_public', true ) );
+
+	}
+
+
 	// checkin isn't a standard mf2 property yet, but OwnYourSwarm uses it.
 	// https://ownyourswarm.p3k.io/docs#checkins
 	function test_create_checkin() {