pg 0.18.0.pre20141017160319-x86-mingw32 → 0.18.0.pre20141117110243-x86-mingw32

data/History.rdoc

@@ -1,8 +1,23 @@
 == v0.18.0 [unreleased]
 
+Bugfixes:
+- Fix OID to Integer mapping (it is unsigned now). #187
+- Fix possible segfault in conjunction with notice receiver. #185
+
 Enhancements:
 
 - Add an extensible type cast system.
+- A lot of performance improvements.
+- Return frozen String objects for result field names.
+- Add PG::Result#stream_each and #stream_each_row as fast helpers for
+  the single row mode.
+- Add Enumerator variant to PG::Result#each and #each_row.
+- Add PG::Connection#conninfo and #hostaddr.
+- Add PG.init_openssl and PG.init_ssl methods.
+- Force zero termination for all text strings that are given to libpq.
+  It raises an ArgumentError if the string contains a null byte.
+- Update Windows cross build to PostgreSQL 9.3.
+
 
 == v0.17.1 [2013-12-18] Michael Granger <ged@FaerieMUD.org>
 

data/Manifest.txt

@@ -30,6 +30,7 @@ ext/pg_result.c
 ext/pg_text_decoder.c
 ext/pg_text_encoder.c
 ext/pg_type_map_all_strings.c
+ext/pg_type_map_by_class.c
 ext/pg_type_map_by_column.c
 ext/pg_type_map_by_mri_type.c
 ext/pg_type_map_by_oid.c
@@ -73,6 +74,7 @@ spec/helpers.rb
 spec/pg/basic_type_mapping_spec.rb
 spec/pg/connection_spec.rb
 spec/pg/result_spec.rb
+spec/pg/type_map_by_class_spec.rb
 spec/pg/type_map_by_column_spec.rb
 spec/pg/type_map_by_mri_type_spec.rb
 spec/pg/type_map_by_oid_spec.rb

data/README.rdoc

@@ -105,7 +105,7 @@ to convert single values to/from their string representation.
 A TypeMap defines which value will be converted by which encoder/decoder.
 There are different type map strategies, implemented by several derivations
 of this class. They can be chosen and configured according to the particular
-needs for type casting.
+needs for type casting. The default type map is PG::TypeMapAllStrings.
 
 A type map can be assigned per connection or per query respectively per
 result set. Type maps can also be used for COPY in and out data streaming.

data/ext/extconf.rb

@@ -73,6 +73,7 @@ have_func 'PQlibVersion'
 have_func 'PQping'
 have_func 'PQsetSingleRowMode'
 have_func 'PQconninfo'
+have_func 'PQhostaddr'
 
 have_func 'rb_encdb_alias'
 have_func 'rb_enc_alias'
@@ -81,6 +82,7 @@ have_func 'rb_thread_call_with_gvl'
 have_func 'rb_thread_fd_select'
 have_func 'rb_w32_wrap_io_handle'
 have_func 'rb_str_modify_expand'
+have_func 'rb_hash_dup'
 
 have_const 'PGRES_COPY_BOTH', 'libpq-fe.h'
 have_const 'PGRES_SINGLE_TUPLE', 'libpq-fe.h'

data/ext/pg.c

@@ -333,6 +333,67 @@ pg_s_threadsafe_p(VALUE self)
 	return PQisthreadsafe() ? Qtrue : Qfalse;
 }
 
+static int
+pg_to_bool_int(VALUE value)
+{
+	switch( TYPE(value) ){
+		case T_FALSE:
+			return 0;
+		case T_TRUE:
+			return 1;
+		default:
+			return NUM2INT(value);
+	}
+}
+
+/*
+ * call-seq:
+ *    PG.init_openssl(do_ssl, do_crypto)  -> nil
+ *
+ * Allows applications to select which security libraries to initialize.
+ *
+ * If your application initializes libssl and/or libcrypto libraries and libpq is
+ * built with SSL support, you should call PG.init_openssl() to tell libpq that the
+ * libssl and/or libcrypto libraries have been initialized by your application,
+ * so that libpq will not also initialize those libraries. See
+ * http://h71000.www7.hp.com/doc/83final/BA554_90007/ch04.html for details on the SSL API.
+ *
+ * When do_ssl is +true+, libpq will initialize the OpenSSL library before first
+ * opening a database connection. When do_crypto is +true+, the libcrypto library
+ * will be initialized. By default (if PG.init_openssl() is not called), both libraries
+ * are initialized. When SSL support is not compiled in, this function is present but does nothing.
+ *
+ * If your application uses and initializes either OpenSSL or its underlying libcrypto library,
+ * you must call this function with +false+ for the appropriate parameter(s) before first opening
+ * a database connection. Also be sure that you have done that initialization before opening a
+ * database connection.
+ *
+ */
+static VALUE
+pg_s_init_openssl(VALUE self, VALUE do_ssl, VALUE do_crypto)
+{
+	UNUSED( self );
+	PQinitOpenSSL(pg_to_bool_int(do_ssl), pg_to_bool_int(do_crypto));
+	return Qnil;
+}
+
+
+/*
+ * call-seq:
+ *    PG.init_ssl(do_ssl)  -> nil
+ *
+ * Allows applications to select which security libraries to initialize.
+ *
+ * This function is equivalent to <tt>PG.init_openssl(do_ssl, do_ssl)</tt> . It is sufficient for
+ * applications that initialize both or neither of OpenSSL and libcrypto.
+ */
+static VALUE
+pg_s_init_ssl(VALUE self, VALUE do_ssl)
+{
+	UNUSED( self );
+	PQinitSSL(pg_to_bool_int(do_ssl));
+	return Qnil;
+}
 
 
 /**************************************************************************
@@ -355,6 +416,10 @@ Init_pg_ext()
 	SINGLETON_ALIAS( rb_mPG, "is_threadsafe?", "isthreadsafe" );
 	SINGLETON_ALIAS( rb_mPG, "threadsafe?", "isthreadsafe" );
 
+  rb_define_singleton_method( rb_mPG, "init_openssl", pg_s_init_openssl, 2 );
+  rb_define_singleton_method( rb_mPG, "init_ssl", pg_s_init_ssl, 1 );
+
+
 	/******     PG::Connection CLASS CONSTANTS: Connection Status     ******/
 
 	/* Connection succeeded */
@@ -586,6 +651,7 @@ Init_pg_ext()
 	init_pg_errors();
 	init_pg_type_map();
 	init_pg_type_map_all_strings();
+	init_pg_type_map_by_class();
 	init_pg_type_map_by_column();
 	init_pg_type_map_by_mri_type();
 	init_pg_type_map_by_oid();

data/ext/pg.h

@@ -90,6 +90,15 @@
 	typedef intptr_t native_int;
 #endif
 
+#ifndef RETURN_SIZED_ENUMERATOR
+	#define RETURN_SIZED_ENUMERATOR(obj, argc, argv, size_fn) RETURN_ENUMERATOR((obj), (argc), (argv))
+#endif
+
+#ifndef HAVE_RB_HASH_DUP
+	/* Rubinius doesn't define rb_hash_dup() */
+	#define rb_hash_dup(tuple) rb_funcall((tuple), rb_intern("dup"), 0)
+#endif
+
 #ifndef timeradd
 #define timeradd(a, b, result) \
 	do { \
@@ -171,6 +180,19 @@ typedef struct {
 	 * 1 = PGresult is cleared internally by libpq
 	 */
 	int autoclear;
+
+	/* Number of fields in fnames[] .
+	 * Set to -1 if fnames[] is not yet initialized.
+	 */
+	int nfields;
+
+	/* Prefilled tuple Hash with fnames[] as keys. */
+	VALUE tuple_hash;
+
+	/* List of field names as frozen String objects.
+	 * Only valid if nfields != -1
+	 */
+	VALUE fnames[0];
 } t_pg_result;
 
 
@@ -179,8 +201,8 @@ typedef VALUE (* t_pg_coder_dec_func)(t_pg_coder *, char *, int, int, int, int);
 typedef VALUE (* t_pg_fit_to_result)(VALUE, VALUE);
 typedef VALUE (* t_pg_fit_to_query)(VALUE, VALUE);
 typedef int (* t_pg_fit_to_copy_get)(VALUE);
-typedef VALUE (* t_pg_typecast_result)(VALUE, int, int);
-typedef t_pg_coder *(* t_pg_typecast_query_param)(VALUE, VALUE, int);
+typedef VALUE (* t_pg_typecast_result)(t_typemap *, VALUE, int, int);
+typedef t_pg_coder *(* t_pg_typecast_query_param)(t_typemap *, VALUE, int);
 typedef VALUE (* t_pg_typecast_copy_get)( t_typemap *, VALUE, int, int, int );
 
 struct pg_coder {
@@ -199,12 +221,15 @@ typedef struct {
 } t_pg_composite_coder;
 
 struct pg_typemap {
-	t_pg_fit_to_result fit_to_result;
-	t_pg_fit_to_query fit_to_query;
-	t_pg_fit_to_copy_get fit_to_copy_get;
-	t_pg_typecast_result typecast_result_value;
-	t_pg_typecast_query_param typecast_query_param;
-	t_pg_typecast_copy_get typecast_copy_get;
+	struct pg_typemap_funcs {
+		t_pg_fit_to_result fit_to_result;
+		t_pg_fit_to_query fit_to_query;
+		t_pg_fit_to_copy_get fit_to_copy_get;
+		t_pg_typecast_result typecast_result_value;
+		t_pg_typecast_query_param typecast_query_param;
+		t_pg_typecast_copy_get typecast_copy_get;
+	} funcs;
+	VALUE default_typemap;
 };
 
 typedef struct {
@@ -227,12 +252,16 @@ extern VALUE rb_ePGerror;
 extern VALUE rb_eServerError;
 extern VALUE rb_eUnableToSend;
 extern VALUE rb_eConnectionBad;
+extern VALUE rb_eInvalidResultStatus;
+extern VALUE rb_eNoResultError;
+extern VALUE rb_eInvalidChangeOfResultFields;
 extern VALUE rb_mPGconstants;
 extern VALUE rb_cPGconn;
 extern VALUE rb_cPGresult;
 extern VALUE rb_hErrors;
 extern VALUE rb_cTypeMap;
 extern VALUE rb_cTypeMapAllStrings;
+extern VALUE rb_mDefaultTypeMappable;
 extern VALUE rb_cPG_Coder;
 extern VALUE rb_cPG_SimpleEncoder;
 extern VALUE rb_cPG_SimpleDecoder;
@@ -245,9 +274,11 @@ extern VALUE rb_mPG_TextEncoder;
 extern VALUE rb_mPG_TextDecoder;
 extern VALUE rb_mPG_BinaryEncoder;
 extern VALUE rb_mPG_BinaryDecoder;
-extern const t_typemap pg_tmbc_default_typemap;
+extern VALUE rb_mPG_BinaryFormatting;
+extern const struct pg_typemap_funcs pg_tmbc_funcs;
+extern const struct pg_typemap_funcs pg_typemap_funcs;
 
-extern VALUE pg_default_typemap;
+extern VALUE pg_typemap_all_strings;
 
 /***************************************************************************
  * MACROS
@@ -267,6 +298,7 @@ void init_pg_result                                    _(( void ));
 void init_pg_errors                                    _(( void ));
 void init_pg_type_map                                  _(( void ));
 void init_pg_type_map_all_strings                      _(( void ));
+void init_pg_type_map_by_class                         _(( void ));
 void init_pg_type_map_by_column                        _(( void ));
 void init_pg_type_map_by_mri_type                      _(( void ));
 void init_pg_type_map_by_oid                           _(( void ));
@@ -308,8 +340,8 @@ char *pg_rb_str_ensure_capa                            _(( VALUE, long, char *,
 VALUE pg_typemap_fit_to_result                         _(( VALUE, VALUE ));
 VALUE pg_typemap_fit_to_query                          _(( VALUE, VALUE ));
 int pg_typemap_fit_to_copy_get                         _(( VALUE ));
-VALUE pg_typemap_result_value                          _(( VALUE, int, int ));
-t_pg_coder *pg_typemap_typecast_query_param            _(( VALUE, VALUE, int ));
+VALUE pg_typemap_result_value                          _(( t_typemap *, VALUE, int, int ));
+t_pg_coder *pg_typemap_typecast_query_param            _(( t_typemap *, VALUE, int ));
 VALUE pg_typemap_typecast_copy_get                     _(( t_typemap *, VALUE, int, int, int ));
 
 PGconn *pg_get_pgconn                                  _(( VALUE ));
@@ -327,7 +359,12 @@ VALUE pg_result_clear                                  _(( VALUE ));
 static inline t_pg_result *
 pgresult_get_this( VALUE self )
 {
-	return DATA_PTR(self);
+	t_pg_result *this = DATA_PTR(self);
+
+	if( this == NULL )
+		rb_raise(rb_ePGerror, "result has been cleared");
+
+	return this;
 }
 
 

data/ext/pg_binary_decoder.c

@@ -83,9 +83,9 @@ pg_bin_dec_float(t_pg_coder *conv, char *val, int len, int tuple, int field, int
 /*
  * Document-class: PG::BinaryDecoder::Bytea < PG::SimpleDecoder
  *
- * This is a decoder class for conversion of PostgreSQL binary data (bytea)
- * to binary Ruby String objects or some other Ruby object, if a #elements_type
- * decoder was defined.
+ * This decoder class delivers the data received from the server as binary String object.
+ * It is therefore suitable for conversion of PostgreSQL bytea data as well as any other
+ * data in binary format.
  *
  */
 VALUE

data/ext/pg_coder.c

@@ -12,6 +12,7 @@ VALUE rb_cPG_SimpleDecoder;
 VALUE rb_cPG_CompositeCoder;
 VALUE rb_cPG_CompositeEncoder;
 VALUE rb_cPG_CompositeDecoder;
+VALUE rb_mPG_BinaryFormatting;
 static ID s_id_encode;
 static ID s_id_decode;
 static ID s_id_CFUNC;
@@ -348,6 +349,9 @@ pg_define_coder( const char *name, void *func, VALUE base_klass, VALUE nsp )
 {
 	VALUE cfunc_obj = Data_Wrap_Struct( rb_cObject, NULL, NULL, func );
 	VALUE coder_klass = rb_define_class_under( nsp, name, base_klass );
+	if( nsp==rb_mPG_BinaryEncoder || nsp==rb_mPG_BinaryDecoder )
+		rb_include_module( coder_klass, rb_mPG_BinaryFormatting );
+
 	rb_define_const( coder_klass, "CFUNC", cfunc_obj );
 
 	RB_GC_GUARD(cfunc_obj);
@@ -470,4 +474,6 @@ init_pg_coder()
 	/* Document-class: PG::CompositeDecoder < PG::CompositeCoder */
 	rb_cPG_CompositeDecoder = rb_define_class_under( rb_mPG, "CompositeDecoder", rb_cPG_CompositeCoder );
 	rb_define_alloc_func( rb_cPG_CompositeDecoder, pg_composite_decoder_allocate );
+
+	rb_mPG_BinaryFormatting = rb_define_module_under( rb_cPG_Coder, "BinaryFormatting");
 }

data/ext/pg_connection.c

@@ -66,6 +66,10 @@ pg_get_connection_safe( VALUE self )
 
 /*
  * Fetch the PGconn data pointer and check it for sanity.
+ *
+ * Note: This function is used externally by the sequel_pg gem,
+ * so do changes carefully.
+ *
  */
 PGconn *
 pg_get_pgconn( VALUE self )
@@ -189,8 +193,8 @@ pgconn_s_allocate( VALUE klass )
 	this->socket_io = Qnil;
 	this->notice_receiver = Qnil;
 	this->notice_processor = Qnil;
-	this->type_map_for_queries = Qnil;
-	this->type_map_for_results = Qnil;
+	this->type_map_for_queries = pg_typemap_all_strings;
+	this->type_map_for_results = pg_typemap_all_strings;
 	this->encoder_for_put_copy_data = Qnil;
 	this->decoder_for_get_copy_data = Qnil;
 	this->trace_stream = Qnil;
@@ -623,6 +627,22 @@ pgconn_host(VALUE self)
 	return rb_tainted_str_new2(host);
 }
 
+#ifdef HAVE_PQHOSTADDR
+/*
+ * call-seq:
+ *    conn.hostaddr()
+ *
+ * Returns the server numeric IP address of the connection.
+ */
+static VALUE
+pgconn_hostaddr(VALUE self)
+{
+	char *hostaddr = PQhostaddr(pg_get_pgconn(self));
+	if (!hostaddr) return Qnil;
+	return rb_tainted_str_new2(hostaddr);
+}
+#endif
+
 /*
  * call-seq:
  *    conn.port()
@@ -1049,7 +1069,7 @@ alloc_typecast_buf( VALUE *typecast_heap_chain, int len )
 
 
 static int
-alloc_query_params1(struct query_params_data *paramsData)
+alloc_query_params(struct query_params_data *paramsData)
 {
 	VALUE param_value;
 	t_typemap *p_typemap;
@@ -1059,7 +1079,14 @@ alloc_query_params1(struct query_params_data *paramsData)
 	unsigned int required_pool_size;
 	char *memory_pool;
 
-	Data_Get_Struct( paramsData->typemap, t_typemap, p_typemap);
+	Check_Type(paramsData->params, T_ARRAY);
+
+	p_typemap = DATA_PTR( paramsData->typemap );
+	p_typemap->funcs.fit_to_query( paramsData->typemap, paramsData->params );
+
+	paramsData->heap_pool = Qnil;
+	paramsData->typecast_heap_chain = Qnil;
+	paramsData->gc_array = Qnil;
 
 	nParams = (int)RARRAY_LEN(paramsData->params);
 
@@ -1096,7 +1123,7 @@ alloc_query_params1(struct query_params_data *paramsData)
 				paramsData->types[i] = 0;
 
 			/* Let the given typemap select a coder for this param */
-			conv = p_typemap->typecast_query_param(paramsData->typemap, param_value, i);
+			conv = p_typemap->funcs.typecast_query_param(p_typemap, param_value, i);
 
 			/* Using a coder object for the param_value? Then set it's format code and oid. */
 			if( conv ){
@@ -1136,8 +1163,11 @@ alloc_query_params1(struct query_params_data *paramsData)
 					if( paramsData->formats[i] == 0 )
 						StringValueCStr(intermediate);
 					/* In case a new string object was generated, make sure it doesn't get freed by the GC */
-					if( intermediate != param_value )
+					if( intermediate != param_value ){
+						if( NIL_P(paramsData->gc_array) )
+							paramsData->gc_array = rb_ary_new();
 						rb_ary_push(paramsData->gc_array, intermediate);
+					}
 					paramsData->values[i] = RSTRING_PTR(intermediate);
 					paramsData->lengths[i] = RSTRING_LENINT(intermediate);
 
@@ -1176,28 +1206,6 @@ free_query_params(struct query_params_data *paramsData)
 	/* currently nothing to free */
 }
 
-static int
-alloc_query_params(struct query_params_data *paramsData)
-{
-	int nParams;
-	Check_Type(paramsData->params, T_ARRAY);
-
-	if( NIL_P(paramsData->typemap) ){
-		/* We don't need to call fit_to_query for pg_default_typemap. It does nothing. */
-		paramsData->typemap = pg_default_typemap;
-	} else {
-		t_typemap *p_typemap = DATA_PTR( paramsData->typemap );
-		paramsData->typemap = p_typemap->fit_to_query( paramsData->typemap, paramsData->params );
-	}
-
-	paramsData->heap_pool = Qnil;
-	paramsData->typecast_heap_chain = Qnil;
-	paramsData->gc_array = rb_ary_new();
-
-	nParams = alloc_query_params1(paramsData);
-	return nParams;
-}
-
 void
 pgconn_query_assign_typemap( VALUE self, struct query_params_data *paramsData )
 {
@@ -3609,9 +3617,7 @@ pgconn_set_default_encoding( VALUE self )
  *
  * Set the default TypeMap that is used for type casts of query bind parameters.
  *
- * +typemap+ can be:
- * * a kind of PG::TypeMap
- * * +nil+ - to type cast all query params by #to_str.
+ * +typemap+ must be a kind of PG::TypeMap .
  *
  */
 static VALUE
@@ -3619,13 +3625,11 @@ pgconn_type_map_for_queries_set(VALUE self, VALUE typemap)
 {
 	t_pg_connection *this = pg_get_connection( self );
 
-	if( typemap != Qnil ){
-		if ( !rb_obj_is_kind_of(typemap, rb_cTypeMap) ) {
-			rb_raise( rb_eTypeError, "wrong argument type %s (expected kind of PG::TypeMap)",
-					rb_obj_classname( typemap ) );
-		}
-		Check_Type(typemap, T_DATA);
+	if ( !rb_obj_is_kind_of(typemap, rb_cTypeMap) ) {
+		rb_raise( rb_eTypeError, "wrong argument type %s (expected kind of PG::TypeMap)",
+				rb_obj_classname( typemap ) );
 	}
+	Check_Type(typemap, T_DATA);
 	this->type_map_for_queries = typemap;
 
 	return typemap;
@@ -3638,10 +3642,6 @@ pgconn_type_map_for_queries_set(VALUE self, VALUE typemap)
  * Returns the default TypeMap that is currently set for type casts of query
  * bind parameters.
  *
- * Returns either:
- * * a kind of PG::TypeMap or
- * * +nil+ - when no type map is set.
- *
  */
 static VALUE
 pgconn_type_map_for_queries_get(VALUE self)
@@ -3657,9 +3657,7 @@ pgconn_type_map_for_queries_get(VALUE self)
  *
  * Set the default TypeMap that is used for type casts of result values.
  *
- * +typemap+ can be:
- * * a kind of PG::TypeMap
- * * +nil+ - to type cast all result values to String.
+ * +typemap+ must be a kind of PG::TypeMap .
  *
  */
 static VALUE
@@ -3667,13 +3665,11 @@ pgconn_type_map_for_results_set(VALUE self, VALUE typemap)
 {
 	t_pg_connection *this = pg_get_connection( self );
 
-	if( typemap != Qnil ){
-		if ( !rb_obj_is_kind_of(typemap, rb_cTypeMap) ) {
-			rb_raise( rb_eTypeError, "wrong argument type %s (expected kind of PG::TypeMap)",
-					rb_obj_classname( typemap ) );
-		}
-		Check_Type(typemap, T_DATA);
+	if ( !rb_obj_is_kind_of(typemap, rb_cTypeMap) ) {
+		rb_raise( rb_eTypeError, "wrong argument type %s (expected kind of PG::TypeMap)",
+				rb_obj_classname( typemap ) );
 	}
+	Check_Type(typemap, T_DATA);
 	this->type_map_for_results = typemap;
 
 	return typemap;
@@ -3685,10 +3681,6 @@ pgconn_type_map_for_results_set(VALUE self, VALUE typemap)
  *
  * Returns the default TypeMap that is currently set for type casts of result values.
  *
- * Returns either:
- * * a kind of PG::TypeMap or
- * * +nil+ - when no type map is set.
- *
  */
 static VALUE
 pgconn_type_map_for_results_get(VALUE self)
@@ -3843,6 +3835,9 @@ init_pg_connection()
 	rb_define_method(rb_cPGconn, "user", pgconn_user, 0);
 	rb_define_method(rb_cPGconn, "pass", pgconn_pass, 0);
 	rb_define_method(rb_cPGconn, "host", pgconn_host, 0);
+#ifdef HAVE_PQHOSTADDR
+	rb_define_method(rb_cPGconn, "hostaddr", pgconn_hostaddr, 0);
+#endif
 	rb_define_method(rb_cPGconn, "port", pgconn_port, 0);
 	rb_define_method(rb_cPGconn, "tty", pgconn_tty, 0);
 #ifdef HAVE_PQCONNINFO