Add support for GeoPackage 1.2 format (#9)

Author: avvertix

readme.md

@@ -297,6 +297,7 @@ The library is able to recognize:
 - `Shapefile`
 - `Shapefile` inside `zip` archive
 - `GeoTIFF`
+- `GeoPackage` format version 1.2 (can contain both vector and raster data, but will be reported as vector)
 - Styled Layer Descriptor `SLD` files for layer styles in XML format
 
 You can check if a file is supported using
@@ -350,6 +351,10 @@ docker-compose -f ./tests/docker-compose.yml up -d
 vendor/bin/phpunit
 ```
 
+**Notes on testing files**
+
+- The GeoPackage testing file was copied from [github.com/ngageoint/geopackage-js](https://github.com/ngageoint/geopackage-js/blob/master/test/fixtures/rivers.gpkg)
+
 ## Contributing
 
 Hey, we're accepting Pull Requests. Please target your pull request to the `master` branch.

src/GeoFormat.php

@@ -11,4 +11,5 @@ final class GeoFormat
     const SHAPEFILE_ZIP = "shapefile_zip";
     const GEOTIFF = "geotiff";
     const SLD = "SLD";
+    const GEOPACKAGE = "geopackage";
 }

src/Http/InteractsWithHttp.php

@@ -42,9 +42,7 @@ private function checkResponseError(ResponseInterface $response)
         $responseBody = $response->getBody();
         $contentTypeHeader = $response->getHeader('Content-Type');
         $contentType = !empty($contentTypeHeader) ? $contentTypeHeader[0] : '';
-        
         if ($response->getStatusCode() !== 200 && $response->getStatusCode() !== 201 && $response->getStatusCode() !== 204) {
-            // dump($response);
             if ($response->getStatusCode() === 500 && strpos($contentType, 'text/html')!== false) {
                 $reason = substr((string)$responseBody, 0, 500);
 

src/Support/BinaryReader.php

@@ -114,6 +114,25 @@ public static function isGeoTiff($path)
         return $hasGeoKeyDirectory;
     }
 
+    public static function isGeoPackage($path)
+    {
+        $handle = self::openFileBinary($path);
+        $sqliteMagic = self::getString(fread($handle, 16), 15);
+        fseek($handle, 68);
+        $gpkgMagic = self::getString(fread($handle, 4), 4);
+        self::closeFile($handle);
+
+        if($sqliteMagic !== 'SQLite format 3'){
+            return false;
+        }
+
+        if($gpkgMagic !== 'GPKG'){
+            return false;
+        }
+
+        return true;
+    }
+
     private static function getBytes($data, $length, $offset = 0, $big_endian = true)
     {
         if ($length <= 2) {
@@ -124,4 +143,19 @@ private static function getBytes($data, $length, $offset = 0, $big_endian = true
         // unsigned short 16bit current(unpack($big_endian ? 'n' : 'v', $tiffHeader, 4));
         // unsigned long 32bit current(unpack($big_endian ? 'N' : 'V', $tiffHeader, 4));
     }
+
+    private static function getString($data, $length, $offset = 0)
+    {
+        try{
+            $chars = [];
+
+            for ($i=$offset; $i < $length; $i++) { 
+                $chars[] = current(unpack('a', $data, $i));
+            }
+
+            return implode('', $chars);
+        }catch(Exception $ex){
+            return '';
+        }
+    }
 }

src/Support/TypeResolver.php

@@ -12,7 +12,8 @@ final class TypeResolver
         GeoFormat::SHAPEFILE => 'application/octet-stream', // shapefile
         GeoFormat::SHAPEFILE_ZIP => 'application/zip', // shapefile in ZIP container
         GeoFormat::GEOTIFF => 'image/tiff', // geotiff
-        GeoFormat::SLD => 'application/vnd.ogc.sld+xml', // geotiff
+        GeoFormat::SLD => 'application/vnd.ogc.sld+xml',
+        GeoFormat::GEOPACKAGE => 'application/geopackage+sqlite3',
     ];
 
     protected static $mimeTypeToFormat = [];
@@ -21,10 +22,12 @@ final class TypeResolver
         GeoFormat::SHAPEFILE => GeoType::VECTOR,
         GeoFormat::SHAPEFILE_ZIP => GeoType::VECTOR,
         GeoFormat::GEOTIFF => GeoType::RASTER,
+        GeoFormat::GEOPACKAGE => GeoType::VECTOR,
 
         GeoType::VECTOR => [
             GeoFormat::SHAPEFILE,
             GeoFormat::SHAPEFILE_ZIP,
+            GeoFormat::GEOPACKAGE,
         ],
         GeoType::RASTER => [
             GeoFormat::GEOTIFF,
@@ -38,6 +41,7 @@ final class TypeResolver
         GeoFormat::SHAPEFILE => 'shp',
         GeoFormat::SHAPEFILE_ZIP => 'shp',
         GeoFormat::GEOTIFF => 'geotiff',
+        GeoFormat::GEOPACKAGE => 'gpkg',
     ];
 
     /**
@@ -89,6 +93,9 @@ public static function identify($path)
                 $format = GeoFormat::SLD;
                 $mimeType = self::$mimeTypes[GeoFormat::SLD];
             }
+        } elseif (BinaryReader::isGeoPackage($path)) {
+            $format = GeoFormat::GEOPACKAGE;
+            $mimeType = self::$mimeTypes[GeoFormat::GEOPACKAGE];
         }
 
         $type = self::convertFormatToType($format);

tests/Integration/GeoServerDataStoresTest.php

@@ -190,4 +190,41 @@ public function test_shapefile_in_zip_archive_can_be_renamed_during_upload_and_d
 
         $this->assertFalse($this->geoserver->exist($data), "Data still exists after remove");
     }
+
+    
+    public function test_geopackage_can_be_uploaded_and_deleted()
+    {
+        $datastoreName = 'rivers';
+        $data = GeoFile::from(__DIR__ . '/../fixtures/rivers.gpkg')->name($datastoreName);
+
+        $feature = $this->geoserver->upload($data);
+
+        $this->assertInstanceOf(Feature::class, $feature);
+        $this->assertEquals(GeoType::VECTOR, $feature->type());
+        $this->assertEquals($datastoreName, $feature->name);
+        $this->assertEquals($datastoreName, $feature->title);
+        $this->assertEquals($datastoreName, $feature->nativeName);
+        $this->assertEquals("EPSG:3857", $feature->srs);
+        $this->assertTrue($feature->enabled);
+        $this->assertFalse($feature->overridingServiceSRS);
+        $this->assertFalse($feature->skipNumberMatched);
+        $this->assertFalse($feature->circularArcPresent);
+        $this->assertNotNull($feature->store);
+        $this->assertNotNull($feature->keywords);
+        $this->assertNotNull($feature->nativeBoundingBox);
+        $this->assertNotNull($feature->boundingBox);
+        $this->assertEquals("EPSG:4326", $feature->boundingBox->crs);
+        $this->assertEquals(-165.18163033675, $feature->boundingBox->minX);
+        $this->assertEquals(-50.786361166949, $feature->boundingBox->minY);
+        $this->assertEquals(176.5891535779, $feature->boundingBox->maxX);
+        $this->assertEquals(73.578794485117, $feature->boundingBox->maxY);
+
+        $this->assertTrue($this->geoserver->exist($data), "Data not existing after upload");
+        
+        $deleteResult = $this->geoserver->remove($data);
+
+        $this->assertTrue($deleteResult, "GeoFile not deleted");
+
+        $this->assertFalse($this->geoserver->exist($data), "Data still exists after remove");
+    }
 }

tests/Unit/GeoFileTest.php

@@ -14,6 +14,7 @@ public function supported_files()
             [__DIR__ . '/../fixtures/shapefile.shp'],
             [__DIR__ . '/../fixtures/shapefile.zip'],
             [__DIR__ . '/../fixtures/geotiff.tiff'],
+            [__DIR__ . '/../fixtures/empty.gpkg'],
         ];
     }
 
@@ -87,6 +88,19 @@ public function test_geotiff_is_recognized()
         $this->assertEquals($file->originalName, $file->name);
     }
 
+    public function test_geopackage_is_recognized()
+    {
+        $file = GeoFile::from(__DIR__ . '/../fixtures/empty.gpkg');
+
+        $this->assertInstanceOf(GeoFile::class, $file);
+        $this->assertEquals(GeoFormat::GEOPACKAGE, $file->format);
+        $this->assertEquals(GeoType::VECTOR, $file->type);
+        $this->assertEquals('application/geopackage+sqlite3', $file->mimeType);
+        $this->assertEquals('gpkg', $file->extension);
+        $this->assertEquals('empty.gpkg', $file->name);
+        $this->assertEquals($file->originalName, $file->name);
+    }
+
     public function test_copy_to_temporary()
     {
         $file = GeoFile::from(__DIR__ . '/../fixtures/buildings.zip');