cipherstash-pg 1.0.0.beta.1-x86_64-darwin-22 → 1.0.0.beta.3-x86_64-darwin-22

data/lib/cipherstash-pg/basic_type_registry.rb

@@ -0,0 +1,206 @@
+require("cipherstash-pg") unless defined? CipherStashPG
+class CipherStashPG::BasicTypeRegistry
+  class CoderMap
+    DONT_QUOTE_TYPES = ["int2", "int4", "int8", "float4", "float8", "oid", "bool", "date", "timestamp", "timestamptz"].inject({}) do |h, e|
+      h[e] = true
+      h
+    end
+    
+    def initialize(result, coders_by_name, format, arraycoder)
+      coder_map = {}
+      arrays, nodes = result.partition { |row| (row["typinput"] == "array_in") }
+      nodes.find_all { |row| coders_by_name.key?(row["typname"]) }.each do |row|
+        coder = coders_by_name[row["typname"]].dup
+        coder.oid = row["oid"].to_i
+        coder.name = row["typname"]
+        coder.format = format
+        coder_map[coder.oid] = coder
+      end
+      if arraycoder then
+        arrays.each do |row|
+          elements_coder = coder_map[row["typelem"].to_i]
+          next unless elements_coder
+          coder = arraycoder.new
+          coder.oid = row["oid"].to_i
+          coder.name = row["typname"]
+          coder.format = format
+          coder.elements_type = elements_coder
+          coder.needs_quotation = (not DONT_QUOTE_TYPES[elements_coder.name])
+          coder_map[coder.oid] = coder
+        end
+      end
+      @coders = coder_map.values
+      @coders_by_name = @coders.inject({}) do |h, t|
+        h[t.name] = t
+        h
+      end
+      @coders_by_oid = @coders.inject({}) do |h, t|
+        h[t.oid] = t
+        h
+      end
+    end
+    
+    attr_reader(:coders)
+    
+    attr_reader(:coders_by_oid)
+    
+    attr_reader(:coders_by_name)
+    
+    def coder_by_name(name)
+      @coders_by_name[name]
+    end
+    
+    def coder_by_oid(oid)
+      @coders_by_oid[oid]
+    end
+  end
+  
+  class CoderMapsBundle
+    attr_reader(:typenames_by_oid)
+    
+    def initialize(connection, registry: nil)
+      registry ||= DEFAULT_TYPE_REGISTRY
+      result = connection.exec("\t\t\t\tSELECT t.oid, t.typname, t.typelem, t.typdelim, ti.proname AS typinput\n\t\t\t\tFROM pg_type as t\n\t\t\t\tJOIN pg_proc as ti ON ti.oid = t.typinput\n").to_a
+      @maps = [[0, :encoder, CipherStashPG::TextEncoder::Array], [0, :decoder, CipherStashPG::TextDecoder::Array], [1, :encoder, nil], [1, :decoder, nil]].inject([]) do |h, (format, direction, arraycoder)|
+        coders = (registry.coders_for(format, direction) or {})
+        h[format] ||= {}
+        h[format][direction] = CoderMap.new(result, coders, format, arraycoder)
+        h
+      end
+      @typenames_by_oid = result.inject({}) do |h, t|
+        h[t["oid"].to_i] = t["typname"]
+        h
+      end
+    end
+    
+    def each_format(direction)
+      @maps.map { |f| f[direction] }
+    end
+    
+    def map_for(format, direction)
+      @maps[format][direction]
+    end
+  end
+  
+  module Checker
+    ValidFormats = { 0 => true, 1 => true }
+    
+    ValidDirections = { :encoder => true, :decoder => true }
+    
+    protected(def check_format_and_direction(format, direction)
+      unless ValidFormats[format] then
+        raise(ArgumentError, ("Invalid format value %p" % format))
+      end
+      unless ValidDirections[direction] then
+        raise(ArgumentError, ("Invalid direction %p" % direction))
+      end
+    end)
+    
+    protected(def build_coder_maps(conn_or_maps, registry: nil)
+      if conn_or_maps.is_a?(CipherStashPG::BasicTypeRegistry::CoderMapsBundle) then
+        if registry then
+          raise(ArgumentError, "registry argument must be given to CoderMapsBundle")
+        end
+        conn_or_maps
+      else
+        CipherStashPG::BasicTypeRegistry::CoderMapsBundle.new(conn_or_maps, :registry => registry)
+      end
+    end)
+  end
+  
+  include(Checker)
+  
+  def initialize
+    @coders_by_name = []
+  end
+  
+  def coders_for(format, direction)
+    check_format_and_direction(format, direction)
+    @coders_by_name[format][direction]
+  end
+  
+  def register_coder(coder)
+    h = @coders_by_name[coder.format] ||= { :encoder => ({}), :decoder => ({}) }
+    name = (coder.name or raise(ArgumentError, "name of #{coder.inspect} must be defined"))
+    h[:encoder][name] = coder if coder.respond_to?(:encode)
+    h[:decoder][name] = coder if coder.respond_to?(:decode)
+    self
+  end
+  
+  def register_type(format, name, encoder_class, decoder_class)
+    if encoder_class then
+      register_coder(encoder_class.new(:name => name, :format => format))
+    end
+    if decoder_class then
+      register_coder(decoder_class.new(:name => name, :format => format))
+    end
+    self
+  end
+  
+  def alias_type(format, new, old)
+    [:encoder, :decoder].each do |ende|
+      enc = @coders_by_name[format][ende][old]
+      if enc then
+        @coders_by_name[format][ende][new] = enc
+      else
+        @coders_by_name[format][ende].delete(new)
+      end
+    end
+    self
+  end
+  
+  def register_default_types
+    register_type(0, "int2", CipherStashPG::TextEncoder::Integer, CipherStashPG::TextDecoder::Integer)
+    alias_type(0, "int4", "int2")
+    alias_type(0, "int8", "int2")
+    alias_type(0, "oid", "int2")
+    register_type(0, "numeric", CipherStashPG::TextEncoder::Numeric, CipherStashPG::TextDecoder::Numeric)
+    register_type(0, "text", CipherStashPG::TextEncoder::String, CipherStashPG::TextDecoder::String)
+    alias_type(0, "varchar", "text")
+    alias_type(0, "char", "text")
+    alias_type(0, "bpchar", "text")
+    alias_type(0, "xml", "text")
+    alias_type(0, "name", "text")
+    register_type(0, "bytea", nil, CipherStashPG::TextDecoder::Bytea)
+    register_type(0, "bool", CipherStashPG::TextEncoder::Boolean, CipherStashPG::TextDecoder::Boolean)
+    register_type(0, "float4", CipherStashPG::TextEncoder::Float, CipherStashPG::TextDecoder::Float)
+    alias_type(0, "float8", "float4")
+    register_type(0, "timestamp", CipherStashPG::TextEncoder::TimestampWithoutTimeZone, CipherStashPG::TextDecoder::TimestampWithoutTimeZone)
+    register_type(0, "timestamptz", CipherStashPG::TextEncoder::TimestampWithTimeZone, CipherStashPG::TextDecoder::TimestampWithTimeZone)
+    register_type(0, "date", CipherStashPG::TextEncoder::Date, CipherStashPG::TextDecoder::Date)
+    register_type(0, "json", CipherStashPG::TextEncoder::JSON, CipherStashPG::TextDecoder::JSON)
+    alias_type(0, "jsonb", "json")
+    register_type(0, "inet", CipherStashPG::TextEncoder::Inet, CipherStashPG::TextDecoder::Inet)
+    alias_type(0, "cidr", "inet")
+    register_type(1, "int2", CipherStashPG::BinaryEncoder::Int2, CipherStashPG::BinaryDecoder::Integer)
+    register_type(1, "int4", CipherStashPG::BinaryEncoder::Int4, CipherStashPG::BinaryDecoder::Integer)
+    register_type(1, "int8", CipherStashPG::BinaryEncoder::Int8, CipherStashPG::BinaryDecoder::Integer)
+    alias_type(1, "oid", "int2")
+    register_type(1, "text", CipherStashPG::BinaryEncoder::String, CipherStashPG::BinaryDecoder::String)
+    alias_type(1, "varchar", "text")
+    alias_type(1, "char", "text")
+    alias_type(1, "bpchar", "text")
+    alias_type(1, "xml", "text")
+    alias_type(1, "name", "text")
+    register_type(1, "bytea", CipherStashPG::BinaryEncoder::Bytea, CipherStashPG::BinaryDecoder::Bytea)
+    register_type(1, "bool", CipherStashPG::BinaryEncoder::Boolean, CipherStashPG::BinaryDecoder::Boolean)
+    register_type(1, "float4", nil, CipherStashPG::BinaryDecoder::Float)
+    register_type(1, "float8", nil, CipherStashPG::BinaryDecoder::Float)
+    register_type(1, "timestamp", nil, CipherStashPG::BinaryDecoder::TimestampUtc)
+    register_type(1, "timestamptz", nil, CipherStashPG::BinaryDecoder::TimestampUtcToLocal)
+    self
+  end
+  
+  alias :define_default_types :register_default_types
+  
+  DEFAULT_TYPE_REGISTRY = CipherStashPG::BasicTypeRegistry.new.register_default_types
+  
+  class << self
+    [:register_coder, :register_type, :alias_type].each do |meth|
+      define_method(meth) do |*args|
+        warn("PG::BasicTypeRegistry.#{meth} is deprecated. Please use your own instance by PG::BasicTypeRegistry.new instead!")
+        DEFAULT_TYPE_REGISTRY.send(meth, *args)
+      end
+    end
+  end
+end

data/lib/cipherstash-pg/binary_decoder.rb

@@ -0,0 +1,21 @@
+module CipherStashPG
+  module BinaryDecoder
+    class TimestampUtc < Timestamp
+      def initialize(params = {})
+        super(params.merge(:flags => (CipherStashPG::Coder::TIMESTAMP_DB_UTC | CipherStashPG::Coder::TIMESTAMP_APP_UTC)))
+      end
+    end
+    
+    class TimestampUtcToLocal < Timestamp
+      def initialize(params = {})
+        super(params.merge(:flags => (CipherStashPG::Coder::TIMESTAMP_DB_UTC | CipherStashPG::Coder::TIMESTAMP_APP_LOCAL)))
+      end
+    end
+    
+    class TimestampLocal < Timestamp
+      def initialize(params = {})
+        super(params.merge(:flags => (CipherStashPG::Coder::TIMESTAMP_DB_LOCAL | CipherStashPG::Coder::TIMESTAMP_APP_LOCAL)))
+      end
+    end
+  end
+end

data/lib/cipherstash-pg/coder.rb

@@ -0,0 +1,82 @@
+module CipherStashPG
+  class Coder
+    module BinaryFormatting
+      Params = { :format => 1 }
+      
+      def initialize(params = {})
+        super(Params.merge(params))
+      end
+    end
+    
+    def initialize(params = {})
+      params.each { |key, val| send("#{key}=", val) }
+    end
+    
+    def dup
+      self.class.new(to_h)
+    end
+    
+    def to_h
+      { :oid => oid, :format => format, :flags => flags, :name => name }
+    end
+    
+    def ==(v)
+      (self.class == v.class) and (to_h == v.to_h)
+    end
+    
+    def marshal_dump
+      Marshal.dump(to_h)
+    end
+    
+    def marshal_load(str)
+      initialize(Marshal.load(str))
+    end
+    
+    def inspect
+      str = self.to_s
+      oid_str = " oid=#{oid}" unless (oid == 0)
+      format_str = " format=#{format}" unless (format == 0)
+      name_str = " #{name.inspect}" if name
+      str[-1, 0] = "#{name_str} #{oid_str}#{format_str}"
+      str
+    end
+    
+    def inspect_short
+      str = case format
+      when 0 then
+        "T"
+      when 1 then
+        "B"
+      else
+        format.to_s
+      end
+      str = (str + "E") if respond_to?(:encode)
+      str = (str + "D") if respond_to?(:decode)
+      "#{(name or self.class.name)}:#{str}"
+    end
+  end
+  
+  class CompositeCoder < Coder
+    def to_h
+      super.merge!(:elements_type => elements_type, :needs_quotation => needs_quotation?, :delimiter => delimiter)
+    end
+    
+    def inspect
+      str = super
+      str[-1, 0] = " elements_type=#{elements_type.inspect} #{needs_quotation? ? ("needs") : ("no")} quotation"
+      str
+    end
+  end
+  
+  class CopyCoder < Coder
+    def to_h
+      super.merge!(:type_map => type_map, :delimiter => delimiter, :null_string => null_string)
+    end
+  end
+  
+  class RecordCoder < Coder
+    def to_h
+      super.merge!(:type_map => type_map)
+    end
+  end
+end