Port of v2.1.0 (Resolves SQL injection vulnerability: PR #51)

Author: grimzy

composer.json

@@ -41,7 +41,8 @@
         "laravel": {
             "providers": [
                 "Grimzy\\LaravelMysqlSpatial\\SpatialServiceProvider"
-            ]
+            ],
+            "require": "5.5.*"
         }
     }
 }

src/Eloquent/BaseBuilder.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Grimzy\LaravelMysqlSpatial\Eloquent;
+
+use Illuminate\Database\Query\Builder as QueryBuilder;
+
+class BaseBuilder extends QueryBuilder
+{
+    protected function cleanBindings(array $bindings)
+    {
+        $bindings = array_map(function ($binding) {
+            return $binding instanceof SpatialExpression ? $binding->getSpatialValue() : $binding;
+        }, $bindings);
+
+        return parent::cleanBindings($bindings);
+    }
+}

src/Eloquent/Builder.php

@@ -20,6 +20,6 @@ public function update(array $values)
 
     protected function asWKT(GeometryInterface $geometry)
     {
-        return $this->getQuery()->raw("GeomFromText('".$geometry->toWKT()."')");
+        return new SpatialExpression($geometry);
     }
 }

src/Eloquent/SpatialExpression.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Grimzy\LaravelMysqlSpatial\Eloquent;
+
+use Illuminate\Database\Query\Expression;
+
+class SpatialExpression extends Expression
+{
+    public function getValue()
+    {
+        return 'ST_GeomFromText(?)';
+    }
+
+    public function getSpatialValue()
+    {
+        return $this->value->toWkt();
+    }
+}

src/Eloquent/SpatialTrait.php

@@ -3,6 +3,7 @@
 namespace Grimzy\LaravelMysqlSpatial\Eloquent;
 
 use Grimzy\LaravelMysqlSpatial\Exceptions\SpatialFieldsNotDefinedException;
+use Grimzy\LaravelMysqlSpatial\Exceptions\UnknownSpatialRelationFunction;
 use Grimzy\LaravelMysqlSpatial\Types\Geometry;
 use Grimzy\LaravelMysqlSpatial\Types\GeometryInterface;
 use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
@@ -37,6 +38,17 @@ trait SpatialTrait
 
     public $geometries = [];
 
+    protected $stRelations = [
+        'within',
+        'crosses',
+        'contains',
+        'disjoint',
+        'equals',
+        'intersects',
+        'overlaps',
+        'touches',
+    ];
+
     /**
      * Create a new Eloquent query builder for the model.
      *
@@ -49,12 +61,21 @@ public function newEloquentBuilder($query)
         return new Builder($query);
     }
 
+    protected function newBaseQueryBuilder()
+    {
+        $connection = $this->getConnection();
+
+        return new BaseBuilder(
+            $connection, $connection->getQueryGrammar(), $connection->getPostProcessor()
+        );
+    }
+
     protected function performInsert(EloquentBuilder $query, array $options = [])
     {
         foreach ($this->attributes as $key => $value) {
             if ($value instanceof GeometryInterface) {
                 $this->geometries[$key] = $value; //Preserve the geometry objects prior to the insert
-                $this->attributes[$key] = $this->getConnection()->raw(sprintf("GeomFromText('%s')", $value->toWKT()));
+                $this->attributes[$key] = new SpatialExpression($value);
             }
         }
 
@@ -89,30 +110,58 @@ public function getSpatialFields()
         }
     }
 
+    public function isColumnAllowed($geometryColumn)
+    {
+        if (!in_array($geometryColumn, $this->getSpatialFields())) {
+            throw new SpatialFieldsNotDefinedException();
+        }
+        return true;
+    }
+
     public function scopeDistance($query, $geometryColumn, $geometry, $distance, $exclude_self = false)
     {
-        $query->whereRaw("st_distance(`{$geometryColumn}`, GeomFromText('{$geometry->toWkt()}')) <= {$distance}");
+        $this->isColumnAllowed($geometryColumn);
+
+        $query->whereRaw("st_distance(`$geometryColumn`, ST_GeomFromText(?)) <= ?", [
+            $geometry->toWkt(),
+            $distance,
+        ]);
 
         if ($exclude_self) {
-            $query->whereRaw("st_distance(`{$geometryColumn}`, GeomFromText('{$geometry->toWkt()}')) != 0");
+            $query->whereRaw("st_distance(`$geometryColumn`, ST_GeomFromText(?)) != 0", [
+                $geometry->toWkt(),
+            ]);
         }
 
         return $query;
     }
 
     public function scopeDistanceValue($query, $geometryColumn, $geometry)
     {
+        $this->isColumnAllowed($geometryColumn);
+
         $columns = $query->getQuery()->columns;
 
         if (!$columns) {
             $query->select('*');
         }
-        $query->selectRaw("st_distance(`{$geometryColumn}`, GeomFromText('{$geometry->toWkt()}')) as distance");
+
+        $query->selectRaw("st_distance(`$geometryColumn`, ST_GeomFromText(?)) as distance", [
+            $geometry->toWkt(),
+        ]);
     }
 
     public function scopeComparison($query, $geometryColumn, $geometry, $relationship)
     {
-        $query->whereRaw("st_{$relationship}(`{$geometryColumn}`, GeomFromText('{$geometry->toWkt()}'))");
+        $this->isColumnAllowed($geometryColumn);
+
+        if (!in_array($relationship, $this->stRelations)) {
+            throw new UnknownSpatialRelationFunction($relationship);
+        }
+
+        $query->whereRaw("st_{$relationship}(`$geometryColumn`, ST_GeomFromText(?))", [
+            $geometry->toWkt(),
+        ]);
 
         return $query;
     }

src/Exceptions/UnknownSpatialRelationFunction.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Grimzy\LaravelMysqlSpatial\Exceptions;
+
+class UnknownSpatialRelationFunction extends \RuntimeException
+{
+}

src/MysqlConnection.php

@@ -24,6 +24,7 @@ public function __construct($pdo, $database = '', $tablePrefix = '', array $conf
                 'multilinestring',
                 'multipolygon',
                 'geometrycollection',
+                'geomcollection',
             ];
             $dbPlatform = $this->getDoctrineSchemaManager()->getDatabasePlatform();
             foreach ($geometries as $type) {

tests/Integration/SpatialTest.php

@@ -29,6 +29,14 @@ public function createApplication()
         $app['config']->set('database.connections.mysql.database', 'spatial_test');
         $app['config']->set('database.connections.mysql.username', 'root');
         $app['config']->set('database.connections.mysql.password', '');
+        $app['config']->set('database.connections.mysql.modes', [
+            'ONLY_FULL_GROUP_BY',
+            'STRICT_TRANS_TABLES',
+            'NO_ZERO_IN_DATE',
+            'NO_ZERO_DATE',
+            'ERROR_FOR_DIVISION_BY_ZERO',
+            'NO_ENGINE_SUBSTITUTION',
+        ]);
 
         return $app;
     }

tests/Unit/Eloquent/BuilderTest.php

@@ -4,6 +4,7 @@
 
 use BaseTestCase;
 use Grimzy\LaravelMysqlSpatial\Eloquent\Builder;
+use Grimzy\LaravelMysqlSpatial\Eloquent\SpatialExpression;
 use Grimzy\LaravelMysqlSpatial\Eloquent\SpatialTrait;
 use Grimzy\LaravelMysqlSpatial\MysqlConnection;
 use Grimzy\LaravelMysqlSpatial\Types\LineString;
@@ -36,50 +37,39 @@ protected function setUp()
 
     public function testUpdatePoint()
     {
-        $this->queryBuilder
-            ->shouldReceive('raw')
-            ->with("GeomFromText('POINT(2 1)')")
-            ->once();
-
+        $point = new Point(1, 2);
         $this->queryBuilder
             ->shouldReceive('update')
+            ->with(['point' => new SpatialExpression($point)])
             ->once();
 
-        $this->builder->update(['point' => new Point(1, 2)]);
+        $this->builder->update(['point' => $point]);
     }
 
     public function testUpdateLinestring()
     {
-        $this->queryBuilder
-            ->shouldReceive('raw')
-            ->with("GeomFromText('LINESTRING(0 0,1 1,2 2)')")
-            ->once();
+        $linestring = new LineString([new Point(0, 0), new Point(1, 1), new Point(2, 2)]);
 
         $this->queryBuilder
             ->shouldReceive('update')
+            ->with(['linestring' => new SpatialExpression($linestring)])
             ->once();
 
-        $linestring = new LineString([new Point(0, 0), new Point(1, 1), new Point(2, 2)]);
-
         $this->builder->update(['linestring' => $linestring]);
     }
 
     public function testUpdatePolygon()
     {
-        $this->queryBuilder
-            ->shouldReceive('raw')
-            ->with("GeomFromText('POLYGON((0 0,1 0),(1 0,1 1),(1 1,0 0))')")
-            ->once();
-
-        $this->queryBuilder
-            ->shouldReceive('update')
-            ->once();
-
         $linestrings[] = new LineString([new Point(0, 0), new Point(0, 1)]);
         $linestrings[] = new LineString([new Point(0, 1), new Point(1, 1)]);
         $linestrings[] = new LineString([new Point(1, 1), new Point(0, 0)]);
         $polygon = new Polygon($linestrings);
 
+        $this->queryBuilder
+            ->shouldReceive('update')
+            ->with(['polygon' => new SpatialExpression($polygon)])
+            ->once();
+
         $this->builder->update(['polygon' => $polygon]);
     }
 }