[WIP] Add support for Postgis Geometry data types

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 2.2.0
+
+- Supporting Unix socket connections. (Thanks to [grillbiff](https://github.com/grillbiff),
+  [#124](https://github.com/stablekernel/postgresql-dart/pull/124))
+- Preparation for custom type converters.
+
 ## 2.1.1
 
 - Fix `RuneIterator.current` use, which no longer returns `null` in 2.8 SDK.

README.md

@@ -11,7 +11,7 @@ This driver uses the more efficient and secure extended query format of the Post
 Create `PostgreSQLConnection`s and `open` them:
 
 ```dart
-var connection = new PostgreSQLConnection("localhost", 5432, "dart_test", username: "dart", password: "dart");
+var connection = PostgreSQLConnection("localhost", 5432, "dart_test", username: "dart", password: "dart");
 await connection.open();
 ```
 
@@ -47,18 +47,13 @@ Execute queries in a transaction:
 ```dart
 await connection.transaction((ctx) async {
     var result = await ctx.query("SELECT id FROM table");
-    await ctx.query("INSERT INTO table (id) VALUES (@a:int4)", {
+    await ctx.query("INSERT INTO table (id) VALUES (@a:int4)", substitutionValues: {
         "a" : result.last[0] + 1
     });
 });
 ```
 
-See the API documentation: https://www.dartdocs.org/documentation/postgres/latest.
-
-## Development branch
-
-The package's upcoming 2.0 version is being developed in the
-[`dev`](https://github.com/stablekernel/postgresql-dart/tree/dev) branch.
+See the API documentation: https://pub.dev/documentation/postgres/latest/
 
 ## Features and bugs
 

lib/postgres.dart

@@ -1,6 +1,12 @@
 library postgres;
 
+import 'package:postgres/src/types.dart';
+
+export 'package:dart_jts/dart_jts.dart' show WKBReader,Geometry;
 export 'src/connection.dart';
 export 'src/execution_context.dart';
 export 'src/substituter.dart';
 export 'src/types.dart';
+
+
+Map<int, PostgreSQLDataType> typeMap = {};

lib/src/binary_codec.dart

@@ -199,6 +199,16 @@ class PostgresBinaryEncoder extends Converter<dynamic, Uint8List> {
           }
           return outBuffer;
         }
+      case PostgreSQLDataType.geometry:
+        {
+          if (value is Geometry) {
+            return castBytes(
+              utf8.encode(
+                value.toText(),
+              ),
+            ); ///TODO: Is this neccessary since I've added it to `PostgresTextEncoder`
+          }
+        }
     }
 
     throw PostgreSQLException('Unsupported datatype');
@@ -209,6 +219,7 @@ class PostgresBinaryDecoder extends Converter<Uint8List, dynamic> {
   const PostgresBinaryDecoder(this.typeCode);
 
   final int typeCode;
+  // final Map<int,PostgreSQLDataType> typeMap;
 
   @override
   dynamic convert(Uint8List value) {
@@ -277,6 +288,17 @@ class PostgresBinaryDecoder extends Converter<Uint8List, dynamic> {
 
           return buf.toString();
         }
+      case PostgreSQLDataType.geometry:
+        {
+          final wkbReader =
+              WKBReader(); // postgis geometries are stored as Well Known Binaries (https://postgis.net/docs/using_postgis_dbmanagement.html)
+          final geometry = wkbReader.read(value);
+          if (geometry is Geometry) {
+            return geometry;
+          } else {
+            throw PostgreSQLException('Error parsing geometry');
+          }
+        }
     }
 
     // We'll try and decode this as a utf8 string and return that
@@ -290,20 +312,22 @@ class PostgresBinaryDecoder extends Converter<Uint8List, dynamic> {
     }
   }
 
-  static final Map<int, PostgreSQLDataType> typeMap = {
-    16: PostgreSQLDataType.boolean,
-    17: PostgreSQLDataType.byteArray,
-    19: PostgreSQLDataType.name,
-    20: PostgreSQLDataType.bigInteger,
-    21: PostgreSQLDataType.smallInteger,
-    23: PostgreSQLDataType.integer,
-    25: PostgreSQLDataType.text,
-    700: PostgreSQLDataType.real,
-    701: PostgreSQLDataType.double,
-    1082: PostgreSQLDataType.date,
-    1114: PostgreSQLDataType.timestampWithoutTimezone,
-    1184: PostgreSQLDataType.timestampWithTimezone,
-    2950: PostgreSQLDataType.uuid,
-    3802: PostgreSQLDataType.json,
-  };
+  // static final Map<int, PostgreSQLDataType> typeMap = {
+  //   16: PostgreSQLDataType.boolean,
+  //   17: PostgreSQLDataType.byteArray,
+  //   19: PostgreSQLDataType.name,
+  //   20: PostgreSQLDataType.bigInteger,
+  //   21: PostgreSQLDataType.smallInteger,
+  //   23: PostgreSQLDataType.integer,
+  //   25: PostgreSQLDataType.text,
+  //   700: PostgreSQLDataType.real,
+  //   701: PostgreSQLDataType.double,
+  //   1082: PostgreSQLDataType.date,
+  //   1114: PostgreSQLDataType.timestampWithoutTimezone,
+  //   1184: PostgreSQLDataType.timestampWithTimezone,
+  //   2950: PostgreSQLDataType.uuid,
+  //   3802: PostgreSQLDataType.json,
+  //   46315: PostgreSQLDataType.geometry, /// TODO: Oid Changes on different databases after running `CREATE EXTENSION postgis`
+  //   46971: PostgreSQLDataType.geometry  /// `SELECT oid, typarray FROM pg_type WHERE typname in ('geometry','geography')`;
+  // };
 }

lib/src/connection.dart

@@ -6,6 +6,7 @@ import 'dart:io';
 import 'dart:typed_data';
 
 import 'package:buffer/buffer.dart';
+import 'package:postgres/postgres.dart';
 
 import 'client_messages.dart';
 import 'execution_context.dart';
@@ -38,13 +39,18 @@ class PostgreSQLConnection extends Object
   /// [queryTimeoutInSeconds] refers to the default timeout for [PostgreSQLExecutionContext]'s execute and query methods.
   /// [timeZone] is the timezone the connection is in. Defaults to 'UTC'.
   /// [useSSL] when true, uses a secure socket when connecting to a PostgreSQL database.
-  PostgreSQLConnection(this.host, this.port, this.databaseName,
-      {this.username,
-      this.password,
-      this.timeoutInSeconds = 30,
-      this.queryTimeoutInSeconds = 30,
-      this.timeZone = 'UTC',
-      this.useSSL = false}) {
+  PostgreSQLConnection(
+    this.host,
+    this.port,
+    this.databaseName, {
+    this.username,
+    this.password,
+    this.timeoutInSeconds = 30,
+    this.queryTimeoutInSeconds = 30,
+    this.timeZone = 'UTC',
+    this.useSSL = false,
+    this.isUnixSocket = false,
+  }) {
     _connectionState = _PostgreSQLConnectionStateClosed();
     _connectionState.connection = this;
   }
@@ -82,6 +88,9 @@ class PostgreSQLConnection extends Object
   /// The processID of this backend.
   int get processID => _processID;
 
+  /// If true, connection is made via unix socket.
+  final bool isUnixSocket;
+
   /// Stream of notification from the database.
   ///
   /// Listen to this [Stream] to receive events from PostgreSQL NOTIFY commands.
@@ -112,6 +121,8 @@ class PostgreSQLConnection extends Object
   int _secretKey;
   List<int> _salt;
 
+  final Map<String, int> _extraDataTypes = {};
+
   bool _hasConnectedPreviously = false;
   _PostgreSQLConnectionState _connectionState;
 
@@ -129,16 +140,22 @@ class PostgreSQLConnection extends Object
   ///
   /// Connections may not be reopened after they are closed or opened more than once. If a connection has already been
   /// opened and this method is called, an exception will be thrown.
-  Future open() async {
+  Future open({bool enablePostGISSupport = false}) async {
     if (_hasConnectedPreviously) {
       throw PostgreSQLException(
           'Attempting to reopen a closed connection. Create a instance instead.');
     }
 
     try {
       _hasConnectedPreviously = true;
-      _socket = await Socket.connect(host, port)
-          .timeout(Duration(seconds: timeoutInSeconds));
+      if (isUnixSocket) {
+        _socket = await Socket.connect(
+                InternetAddress(host, type: InternetAddressType.unix), port)
+            .timeout(Duration(seconds: timeoutInSeconds));
+      } else {
+        _socket = await Socket.connect(host, port)
+            .timeout(Duration(seconds: timeoutInSeconds));
+      }
 
       _framer = MessageFramer();
       if (useSSL) {
@@ -163,6 +180,66 @@ class PostgreSQLConnection extends Object
 
       rethrow;
     }
+
+    if(enablePostGISSupport) {
+      //CREATE EXTENSION postgis;
+      try {
+        await _connection.execute('CREATE EXTENSION IF NOT EXISTS postgis');
+      } catch (e,st) {
+        await _close(e, st);
+        rethrow;
+      }
+    }
+
+    await _updateIDS();
+  }
+
+  Future updateIDS() => _updateIDS();
+
+  Future _updateIDS() async {
+    typeMap = typeMap.isNotEmpty ? typeMap : {
+      16: PostgreSQLDataType.boolean,
+      17: PostgreSQLDataType.byteArray,
+      19: PostgreSQLDataType.name,
+      20: PostgreSQLDataType.bigInteger,
+      21: PostgreSQLDataType.smallInteger,
+      23: PostgreSQLDataType.integer,
+      25: PostgreSQLDataType.text,
+      700: PostgreSQLDataType.real,
+      701: PostgreSQLDataType.double,
+      1082: PostgreSQLDataType.date,
+      1114: PostgreSQLDataType.timestampWithoutTimezone,
+      1184: PostgreSQLDataType.timestampWithTimezone,
+      2950: PostgreSQLDataType.uuid,
+      3802: PostgreSQLDataType.json,
+    };
+
+    // if (enablePostGISSupport) {
+
+    // fetch oids from database (dynamic values)
+    final dataTypes = await _connection._query(
+      '''
+        select oid::int,typname from pg_type where typname in ('text','int2','int4','int8','float4','float8','bool','date','bytea', 'timestamp','timestamptz','jsonb','name','uuid','geometry', 'geography');
+        ''',
+    );
+
+    final mapped = dataTypes.map((row) {
+      final oid = row[0] as int;
+      final typname = row[1] as String;
+      return MapEntry<String, int>(typname, oid);
+    });
+    _extraDataTypes.addEntries(mapped);
+    // }
+
+    typeMap = _extraDataTypes.map((key, value) {
+      // add boolean since it's not called bool on pg_types
+      if (key == 'bool') {
+        return MapEntry<int, PostgreSQLDataType>(
+            value, PostgreSQLFormatIdentifier.typeStringToCodeMap['boolean']);
+      }
+      return MapEntry<int, PostgreSQLDataType>(
+          value, PostgreSQLFormatIdentifier.typeStringToCodeMap[key]);
+    });
   }
 
   /// Closes a connection.
@@ -425,7 +502,7 @@ abstract class _PostgreSQLExecutionContextMixin
     }
 
     final query = Query<List<List<dynamic>>>(
-        fmtString, substitutionValues, _connection, _transaction);
+        fmtString, substitutionValues, _connection, _transaction, typeMap);
     if (allowReuse) {
       query.statementIdentifier = _connection._cache.identifierForQuery(query);
     }
@@ -470,7 +547,7 @@ abstract class _PostgreSQLExecutionContextMixin
     }
 
     final query = Query<int>(
-        fmtString, substitutionValues, _connection, _transaction,
+        fmtString, substitutionValues, _connection, _transaction, typeMap,
         onlyReturnAffectedRowCount: true);
 
     return _enqueue(query, timeoutInSeconds: timeoutInSeconds);

lib/src/execution_context.dart

@@ -6,6 +6,12 @@ import 'substituter.dart';
 import 'types.dart';
 
 abstract class PostgreSQLExecutionContext {
+
+  // final Map<int,PostgreSQLDataType> typeMap;
+
+  // PostgreSQLExecutionContext(this.typeMap);
+
+
   /// Returns this context queue size
   int get queueSize;
 

lib/src/query.dart

@@ -18,11 +18,14 @@ class Query<T> {
     this.statement,
     this.substitutionValues,
     this.connection,
-    this.transaction, {
+    this.transaction, 
+    this.typeMap,
+    {
     this.onlyReturnAffectedRowCount = false,
   });
 
   final bool onlyReturnAffectedRowCount;
+  final Map<int,PostgreSQLDataType> typeMap;
 
   String statementIdentifier;
 
@@ -121,8 +124,7 @@ class Query<T> {
         return true;
       }
 
-      final actualType = PostgresBinaryDecoder
-          .typeMap[actualParameterTypeCodeIterator.current];
+      final actualType = typeMap[actualParameterTypeCodeIterator.current];
       return actualType == specifiedType;
     }).any((v) => v == false);
 
@@ -209,8 +211,9 @@ class ParameterValue {
   factory ParameterValue.text(dynamic value) {
     Uint8List bytes;
     if (value != null) {
-      final converter = PostgresTextEncoder(false);
-      bytes = castBytes(utf8.encode(converter.convert(value)));
+      final converter = PostgresTextEncoder();
+      bytes = castBytes(
+          utf8.encode(converter.convert(value, escapeStrings: false)));
     }
     final length = bytes?.length ?? 0;
     return ParameterValue._(false, bytes, length);
@@ -315,7 +318,9 @@ class PostgreSQLFormatIdentifier {
     'jsonb': PostgreSQLDataType.json,
     'bytea': PostgreSQLDataType.byteArray,
     'name': PostgreSQLDataType.name,
-    'uuid': PostgreSQLDataType.uuid
+    'uuid': PostgreSQLDataType.uuid,
+    'geometry': PostgreSQLDataType.geometry,
+    'geography': PostgreSQLDataType.geometry
   };
 
   factory PostgreSQLFormatIdentifier(String t) {

lib/src/server_messages.dart

@@ -2,6 +2,7 @@ import 'dart:convert';
 import 'dart:typed_data';
 
 import 'package:buffer/buffer.dart';
+import 'package:postgres/postgres.dart';
 
 import 'connection.dart';
 import 'query.dart';

lib/src/substituter.dart

@@ -47,14 +47,16 @@ class PostgreSQLFormat {
         return 'name';
       case PostgreSQLDataType.uuid:
         return 'uuid';
+      case PostgreSQLDataType.geometry:
+        return 'geometry';
     }
 
     return null;
   }
 
   static String substitute(String fmtString, Map<String, dynamic> values,
       {SQLReplaceIdentifierFunction replace}) {
-    final converter = PostgresTextEncoder(true);
+    final converter = PostgresTextEncoder();
     values ??= <String, dynamic>{};
     replace ??= (spec, index) => converter.convert(values[spec.name]);