/************************************************ pg.c - Author: matz created at: Tue May 13 20:07:35 JST 1997 Author: ematsu modified at: Wed Jan 20 16:41:51 1999 $Author: jdavis $ $Date: 2007-12-07 09:51:23 -0800 (Fri, 07 Dec 2007) $ ************************************************/ #include "ruby.h" #if RUBY_VM != 1 #define RUBY_18_COMPAT #endif #ifdef RUBY_18_COMPAT #include "rubyio.h" #else #include "ruby/io.h" #endif #ifdef RUBY_18_COMPAT #include "st.h" #include "intern.h" #else #include "ruby/st.h" #include "ruby/intern.h" #endif /* grep '^#define' $(pg_config --includedir)/server/catalog/pg_type.h | grep OID */ #include "type-oids.h" #include #include /* large-object interface */ #include #include #include #ifndef HAVE_PQSERVERVERSION static int PQserverVersion(const PGconn *conn) { rb_raise(rb_eArgError,"this version of libpq doesn't support PQserverVersion"); } #endif /* HAVE_PQSERVERVERSION */ #ifndef RHASH_SIZE #define RHASH_SIZE(x) RHASH((x))->tbl->num_entries #endif /* RHASH_SIZE */ #ifndef RSTRING_LEN #define RSTRING_LEN(x) RSTRING((x))->len #endif /* RSTRING_LEN */ #ifndef RSTRING_PTR #define RSTRING_PTR(x) RSTRING((x))->ptr #endif /* RSTRING_PTR */ #ifndef RARRAY_LEN #define RARRAY_LEN(x) RARRAY((x))->len #endif /* RARRAY_LEN */ #ifndef RARRAY_PTR #define RARRAY_PTR(x) RARRAY((x))->ptr #endif /* RARRAY_PTR */ #ifndef HAVE_PG_ENCODING_TO_CHAR #define pg_encoding_to_char(x) "SQL_ASCII" #endif #ifndef HAVE_PQFREEMEM #define PQfreemem(ptr) free(ptr) #endif #ifndef StringValuePtr #define StringValuePtr(x) STR2CSTR(x) #endif #define AssignCheckedStringValue(cstring, rstring) do { \ if (!NIL_P(temp = rstring)) { \ Check_Type(temp, T_STRING); \ cstring = StringValuePtr(temp); \ } \ } while (0) #if RUBY_VERSION_CODE < 180 #define rb_check_string_type(x) rb_check_convert_type(x, T_STRING, "String", "to_str") #endif #define rb_check_hash_type(x) rb_check_convert_type(x, T_HASH, "Hash", "to_hash") #define rb_define_singleton_alias(klass,new,old) rb_define_alias(rb_singleton_class(klass),new,old) #define Data_Set_Struct(obj,ptr) do { \ Check_Type(obj, T_DATA); \ DATA_PTR(obj) = ptr; \ } while (0) #define RUBY_CLASS(name) rb_const_get(rb_cObject, rb_intern(name)) #define SINGLE_QUOTE '\'' EXTERN VALUE rb_mEnumerable; EXTERN VALUE rb_mKernel; EXTERN VALUE rb_cTime; static VALUE rb_cDate; static VALUE rb_cDateTime; static VALUE rb_cBigDecimal; static VALUE rb_cPGconn; static VALUE rb_cPGresult; static VALUE rb_ePGError; static VALUE rb_cPGlarge; static VALUE rb_cPGrow; static VALUE pgconn_lastval _((VALUE)); static VALUE pgconn_close _((VALUE)); static VALUE pgresult_fields _((VALUE)); static VALUE pgresult_clear _((VALUE)); static VALUE pgresult_result_with_clear _((VALUE)); static VALUE pgresult_new _((PGresult*)); static int translate_results = 0; /* Large Object support */ typedef struct pglarge_object { PGconn *pgconn; Oid lo_oid; int lo_fd; } PGlarge; static VALUE pglarge_new _((PGconn*, Oid, int)); /* Large Object support */ static void free_pgconn(PGconn *); static VALUE pgconn_alloc(klass) VALUE klass; { return Data_Wrap_Struct(klass, 0, free_pgconn, NULL); } static int build_key_value_string_i(VALUE key, VALUE value, VALUE result); static PGconn *get_pgconn(VALUE obj); static PGconn * try_connectdb(arg) VALUE arg; { VALUE conninfo; if (!NIL_P(conninfo = rb_check_string_type(arg))) { /* do nothing */ } else if (!NIL_P(conninfo = rb_check_hash_type(arg))) { VALUE key_values = rb_ary_new2(RHASH_SIZE(conninfo)); rb_hash_foreach(conninfo, build_key_value_string_i, key_values); conninfo = rb_ary_join(key_values, rb_str_new2(" ")); } else { return NULL; } return PQconnectdb(StringValuePtr(conninfo)); } static PGconn * try_setdbLogin(args) VALUE args; { VALUE temp; char *host, *port, *opt, *tty, *dbname, *login, *pwd; host=port=opt=tty=dbname=login=pwd=NULL; rb_funcall(args, rb_intern("flatten!"), 0); AssignCheckedStringValue(host, rb_ary_entry(args, 0)); if (!NIL_P(temp = rb_ary_entry(args, 1)) && NUM2INT(temp) != -1) { temp = rb_obj_as_string(temp); port = StringValuePtr(temp); } AssignCheckedStringValue(opt, rb_ary_entry(args, 2)); AssignCheckedStringValue(tty, rb_ary_entry(args, 3)); AssignCheckedStringValue(dbname, rb_ary_entry(args, 4)); AssignCheckedStringValue(login, rb_ary_entry(args, 5)); AssignCheckedStringValue(pwd, rb_ary_entry(args, 6)); return PQsetdbLogin(host, port, opt, tty, dbname, login, pwd); } static VALUE pgconn_connect(argc, argv, self) int argc; VALUE *argv; VALUE self; { VALUE args; PGconn *conn = NULL; rb_scan_args(argc, argv, "0*", &args); if (RARRAY_LEN(args) == 1) { conn = try_connectdb(rb_ary_entry(args, 0)); } if (conn == NULL) { conn = try_setdbLogin(args); } if (PQstatus(conn) == CONNECTION_BAD) { VALUE message = rb_str_new2(PQerrorMessage(conn)); PQfinish(conn); rb_raise(rb_ePGError, StringValuePtr(message)); } #ifdef HAVE_PQSERVERVERSION if (PQserverVersion(conn) >= 80100) { rb_define_singleton_method(self, "lastval", pgconn_lastval, 0); } #endif /* HAVE_PQSERVERVERSION */ Data_Set_Struct(self, conn); return self; } /* * call-seq: * PGconn.translate_results = boolean * * When true (default), results are translated to appropriate ruby class. * When false, results are returned as +Strings+. */ static VALUE pgconn_s_translate_results_set(self, fact) VALUE self, fact; { translate_results = (fact == Qfalse || fact == Qnil) ? 0 : 1; return fact; } static VALUE pgconn_s_format(self, obj) VALUE self; VALUE obj; { switch(TYPE(obj)) { case T_STRING: return obj; case T_TRUE: case T_FALSE: case T_FIXNUM: case T_BIGNUM: case T_FLOAT: return rb_obj_as_string(obj); case T_NIL: return rb_str_new2("NULL"); default: if (CLASS_OF(obj) == rb_cBigDecimal) { return rb_funcall(obj, rb_intern("to_s"), 1, rb_str_new2("F")); } else if (rb_block_given_p()) { return rb_yield(obj); } else { rb_raise(rb_ePGError, "can't format"); } } } /* * call-seq: * PGconn.quote( obj ) * PGconn.quote( obj ) { |obj| ... } * PGconn.format( obj ) * PGconn.format( obj ) { |obj| ... } * * If _obj_ is a Number, String, Array, +nil+, +true+, or +false+ then * #quote returns a String representation of that object safe for use in PostgreSQL. * * If _obj_ is not one of the above classes and a block is supplied to #quote, * the block is invoked, passing along the object. The return value from the * block is returned as a string. * * If _obj_ is not one of the recognized classes andno block is supplied, * a PGError is raised. */ static VALUE pgconn_s_quote(self, obj) VALUE self, obj; { char* quoted; int size; VALUE result; if (TYPE(obj) == T_STRING) { /* length * 2 because every char could require escaping */ /* + 2 for the quotes, + 1 for the null terminator */ quoted = ALLOCA_N(char, RSTRING_LEN(obj) * 2 + 2 + 1); size = PQescapeString(quoted + 1, RSTRING_PTR(obj), RSTRING_LEN(obj)); *quoted = *(quoted + size + 1) = SINGLE_QUOTE; result = rb_str_new(quoted, size + 2); OBJ_INFECT(result, obj); return result; } else { return pgconn_s_format(self, obj); } } /* * call-seq: * PGconn.quote( obj ) * PGconn.quote( obj ) { |obj| ... } * PGconn.format( obj ) * PGconn.format( obj ) { |obj| ... } * * If _obj_ is a Number, String, Array, +nil+, +true+, or +false+ then * #quote returns a String representation of that object safe for use in PostgreSQL. * * If _obj_ is not one of the above classes and a block is supplied to #quote, * the block is invoked, passing along the object. The return value from the * block is returned as a string. * * If _obj_ is not one of the recognized classes andno block is supplied, * a PGError is raised. */ static VALUE pgconn_quote(self, obj) VALUE self, obj; { char* quoted; int size,error; VALUE result; if (TYPE(obj) == T_STRING) { /* length * 2 because every char could require escaping */ /* + 2 for the quotes, + 1 for the null terminator */ quoted = ALLOCA_N(char, RSTRING_LEN(obj) * 2 + 2 + 1); size = PQescapeStringConn(get_pgconn(self),quoted + 1, RSTRING_PTR(obj), RSTRING_LEN(obj), &error); *quoted = *(quoted + size + 1) = SINGLE_QUOTE; result = rb_str_new(quoted, size + 2); OBJ_INFECT(result, obj); return result; } else { return pgconn_s_format(self, obj); } } static VALUE pgconn_s_quote_connstr(string) VALUE string; { char *str,*ptr; int i,j=0,len; VALUE result; Check_Type(string, T_STRING); ptr = RSTRING_PTR(string); len = RSTRING_LEN(string); str = ALLOCA_N(char, len * 2 + 2 + 1); str[j++] = '\''; for(i = 0; i < len; i++) { if(ptr[i] == '\'' || ptr[i] == '\\') str[j++] = '\\'; str[j++] = ptr[i]; } str[j++] = '\''; result = rb_str_new(str, j); OBJ_INFECT(result, string); return result; } static int build_key_value_string_i(key, value, result) VALUE key, value, result; { VALUE key_value; if (key == Qundef) return ST_CONTINUE; key_value = (TYPE(key) == T_STRING ? rb_str_dup(key) : rb_obj_as_string(key)); rb_str_cat(key_value, "=", 1); rb_str_concat(key_value, pgconn_s_quote_connstr(value)); rb_ary_push(result, key_value); return ST_CONTINUE; } /* * call-seq: * PGconn.quote_ident( str ) * * Returns a SQL-safe identifier. */ static VALUE pgconn_s_quote_ident(self, string) VALUE self; VALUE string; { char *str,*ptr; int i,j=0,len; VALUE result; Check_Type(string, T_STRING); ptr = RSTRING_PTR(string); len = RSTRING_LEN(string); str = ALLOCA_N(char, len * 2 + 2 + 1); str[j++] = '"'; for(i = 0; i < len; i++) { if(ptr[i] == '"') str[j++] = '"'; else if(ptr[i] == '\0') rb_raise(rb_ePGError, "Identifier cannot contain NULL bytes"); str[j++] = ptr[i]; } str[j++] = '"'; result = rb_str_new(str, j); OBJ_INFECT(result, string); return result; } /* * Returns a SQL-safe version of the String _str_. Unlike #quote, does not wrap the String in '...'. */ static VALUE pgconn_s_escape(self, string) VALUE self; VALUE string; { char *escaped; int size; VALUE result; Check_Type(string, T_STRING); escaped = ALLOCA_N(char, RSTRING_LEN(string) * 2 + 1); size = PQescapeString(escaped, RSTRING_PTR(string), RSTRING_LEN(string)); result = rb_str_new(escaped, size); OBJ_INFECT(result, string); return result; } /* * Returns a SQL-safe version of the String _str_. Unlike #quote, does not wrap the String in '...'. */ static VALUE pgconn_escape(self, string) VALUE self; VALUE string; { char *escaped; int size,error; VALUE result; Check_Type(string, T_STRING); escaped = ALLOCA_N(char, RSTRING_LEN(string) * 2 + 1); size = PQescapeStringConn(get_pgconn(self),escaped, RSTRING_PTR(string), RSTRING_LEN(string), &error); result = rb_str_new(escaped, size); OBJ_INFECT(result, string); return result; } /* * call-seq: * PGconn.escape_bytea( obj ) * * Escapes binary data for use within an SQL command with the type +bytea+. * * Certain byte values must be escaped (but all byte values may be escaped) * when used as part of a +bytea+ literal in an SQL statement. In general, to * escape a byte, it is converted into the three digit octal number equal to * the octet value, and preceded by two backslashes. The single quote (') and * backslash (\) characters have special alternative escape sequences. * #escape_bytea performs this operation, escaping only the minimally required bytes. * * See the PostgreSQL documentation on PQescapeBytea[http://www.postgresql.org/docs/current/interactive/libpq-exec.html#LIBPQ-EXEC-ESCAPE-BYTEA] for more information. */ static VALUE pgconn_s_escape_bytea(self, obj) VALUE self; VALUE obj; { unsigned char *from, *to; size_t from_len, to_len; VALUE ret; Check_Type(obj, T_STRING); from = (unsigned char*)RSTRING_PTR(obj); from_len = RSTRING_LEN(obj); to = PQescapeBytea(from, from_len, &to_len); ret = rb_str_new((char*)to, to_len - 1); OBJ_INFECT(ret, obj); PQfreemem(to); return ret; } /* * call-seq: * PGconn.escape_bytea( obj ) * * Escapes binary data for use within an SQL command with the type +bytea+. * * Certain byte values must be escaped (but all byte values may be escaped) * when used as part of a +bytea+ literal in an SQL statement. In general, to * escape a byte, it is converted into the three digit octal number equal to * the octet value, and preceded by two backslashes. The single quote (') and * backslash (\) characters have special alternative escape sequences. * #escape_bytea performs this operation, escaping only the minimally required bytes. * * See the PostgreSQL documentation on PQescapeBytea[http://www.postgresql.org/docs/current/interactive/libpq-exec.html#LIBPQ-EXEC-ESCAPE-BYTEA] for more information. */ static VALUE pgconn_escape_bytea(self, obj) VALUE self; VALUE obj; { unsigned char *from, *to; size_t from_len, to_len; VALUE ret; Check_Type(obj, T_STRING); from = (unsigned char*)RSTRING_PTR(obj); from_len = RSTRING_LEN(obj); to = PQescapeByteaConn(get_pgconn(self),from, from_len, &to_len); ret = rb_str_new((char*)to, to_len - 1); OBJ_INFECT(ret, obj); PQfreemem(to); return ret; } /* * call-seq: * PGconn.unescape_bytea( obj ) * * Converts an escaped string representation of binary data into binary data --- the * reverse of #escape_bytea. This is needed when retrieving +bytea+ data in text format, * but not when retrieving it in binary format. * * See the PostgreSQL documentation on PQunescapeBytea[http://www.postgresql.org/docs/current/interactive/libpq-exec.html#LIBPQ-EXEC-ESCAPE-BYTEA] for more information. */ static VALUE pgconn_s_unescape_bytea(self, obj) VALUE self, obj; { unsigned char *from, *to; size_t to_len; VALUE ret; Check_Type(obj, T_STRING); from = (unsigned char*)StringValuePtr(obj); to = PQunescapeBytea(from, &to_len); ret = rb_str_new((char*)to, to_len); OBJ_INFECT(ret, obj); PQfreemem(to); return ret; } /* * Document-method: new * * call-seq: * PGconn.open(connection_hash) -> PGconn * PGconn.open(connection_string) -> PGconn * PGconn.open(host, port, options, tty, dbname, login, passwd) -> PGconn * * _host_:: server hostname * _port_:: server port number * _options_:: backend options (String) * _tty_:: tty to print backend debug message (ignored in newer versions of PostgreSQL) (String) * _dbname_:: connecting database name * _login_:: login user name * _passwd_:: login password * * On failure, it raises a PGError exception. */ #ifndef HAVE_RB_DEFINE_ALLOC_FUNC static VALUE pgconn_s_new(argc, argv, klass) int argc; VALUE *argv; VALUE klass; { VALUE obj = rb_obj_alloc(klass); rb_obj_call_init(obj, argc, argv); return obj; } #endif static VALUE pgconn_init(argc, argv, self) int argc; VALUE *argv; VALUE self; { pgconn_connect(argc, argv, self); if (rb_block_given_p()) { return rb_ensure(rb_yield, self, pgconn_close, self); } return self; } static PGconn* get_pgconn(obj) VALUE obj; { PGconn *conn; Data_Get_Struct(obj, PGconn, conn); if (conn == NULL) rb_raise(rb_ePGError, "closed connection"); return conn; } /* * call-seq: * conn.close * * Closes the backend connection. */ static VALUE pgconn_close(self) VALUE self; { PQfinish(get_pgconn(self)); DATA_PTR(self) = NULL; return Qnil; } /* * call-seq: * conn.reset() * * Resets the backend connection. This method closes the backend connection and tries to re-connect. */ static VALUE pgconn_reset(obj) VALUE obj; { PQreset(get_pgconn(obj)); return obj; } static PGresult* get_pgresult(obj) VALUE obj; { PGresult *result; Data_Get_Struct(obj, PGresult, result); if (result == NULL) rb_raise(rb_ePGError, "query not performed"); return result; } #ifndef HAVE_PQEXECPARAMS PGresult *PQexecParams_compat(PGconn *conn, VALUE command, VALUE values); #endif #define TEXT_FORMAT 0 #define BINARY_FORMAT 1 void translate_to_pg(VALUE value, char const** result, int* length, int* format) { switch (TYPE(value)) { case T_NIL: *result = NULL; *length = 0; *format = BINARY_FORMAT; return; case T_TRUE: *result = "\1"; *length = 1; *format = BINARY_FORMAT; return; case T_FALSE: *result = "\0"; *length = 1; *format = BINARY_FORMAT; return; case T_STRING: *result = StringValuePtr(value); *length = RSTRING_LEN(value); *format = BINARY_FORMAT; return; default: { VALUE formatted = pgconn_s_format(rb_cPGconn, value); *result = StringValuePtr(formatted); *length = RSTRING_LEN(formatted); *format = TEXT_FORMAT; } } } /* * call-seq: * conn.exec(sql, *bind_values) * * Sends SQL query request specified by _sql_ to the PostgreSQL. * Returns a PGresult instance on success. * On failure, it raises a PGError exception. * * +bind_values+ represents values for the PostgreSQL bind parameters found in the +sql+. PostgreSQL bind parameters are presented as $1, $1, $2, etc. */ static VALUE pgconn_exec(argc, argv, obj) int argc; VALUE *argv; VALUE obj; { PGconn *conn = get_pgconn(obj); PGresult *result = NULL; VALUE command, params; char *msg; rb_scan_args(argc, argv, "1*", &command, ¶ms); Check_Type(command, T_STRING); if (RARRAY_LEN(params) <= 0) { result = PQexec(conn, StringValuePtr(command)); } else { int len = RARRAY_LEN(params); int i; #ifdef HAVE_PQEXECPARAMS VALUE* ptr = RARRAY_PTR(params); char const** values = ALLOCA_N(char const*, len); int* lengths = ALLOCA_N(int, len); int* formats = ALLOCA_N(int, len); for (i = 0; i < len; i++, ptr++) { translate_to_pg(*ptr, values+i, lengths+i, formats+i); } result = PQexecParams(conn, StringValuePtr(command), len, NULL, values, lengths, formats, 0); #else for (i = 0; i < len; i++) { rb_ary_store(params, i, pgconn_s_quote(rb_cPGconn, rb_ary_entry(params, i))); } result = PQexecParams_compat(conn, command, params); #endif } if (!result) { rb_raise(rb_ePGError, PQerrorMessage(conn)); } switch (PQresultStatus(result)) { case PGRES_TUPLES_OK: case PGRES_COPY_OUT: case PGRES_COPY_IN: case PGRES_EMPTY_QUERY: case PGRES_COMMAND_OK: { VALUE pg_result = pgresult_new(result); if (rb_block_given_p()) { return rb_ensure(rb_yield, pg_result, pgresult_clear, pg_result); } else { return pg_result; } } case PGRES_BAD_RESPONSE: case PGRES_FATAL_ERROR: case PGRES_NONFATAL_ERROR: msg = RSTRING_PTR(rb_str_new2(PQresultErrorMessage(result))); break; default: msg = "internal error : unknown result status."; break; } PQclear(result); rb_raise(rb_ePGError, msg); } /* * call-seq: * conn.async_exec( sql ) * * Sends an asyncrhonous SQL query request specified by _sql_ to the PostgreSQL. * Returns a PGresult instance on success. * On failure, it raises a PGError exception. */ static VALUE pgconn_async_exec(obj, str) VALUE obj, str; { PGconn *conn = get_pgconn(obj); PGresult *result; char *msg; int cs; int ret; fd_set rset; Check_Type(str, T_STRING); while ((result = PQgetResult(conn)) != NULL) { PQclear(result); } if (!PQsendQuery(conn, RSTRING_PTR(str))) { rb_raise(rb_ePGError, PQerrorMessage(conn)); } cs = PQsocket(conn); for(;;) { FD_ZERO(&rset); FD_SET(cs, &rset); ret = rb_thread_select(cs + 1, &rset, NULL, NULL, NULL); if (ret < 0) { rb_sys_fail(0); } if (ret == 0) { continue; } if (PQconsumeInput(conn) == 0) { rb_raise(rb_ePGError, PQerrorMessage(conn)); } if (PQisBusy(conn) == 0) { break; } } result = PQgetResult(conn); if (!result) { rb_raise(rb_ePGError, PQerrorMessage(conn)); } switch (PQresultStatus(result)) { case PGRES_TUPLES_OK: case PGRES_COPY_OUT: case PGRES_COPY_IN: case PGRES_EMPTY_QUERY: case PGRES_COMMAND_OK: /* no data will be received */ return pgresult_new(result); case PGRES_BAD_RESPONSE: case PGRES_FATAL_ERROR: case PGRES_NONFATAL_ERROR: msg = RSTRING_PTR(rb_str_new2(PQresultErrorMessage(result))); break; default: msg = "internal error : unknown result status."; break; } PQclear(result); rb_raise(rb_ePGError, msg); } /* * call-seq: * conn.query(sql, *bind_values) * * Sends SQL query request specified by _sql_ to the PostgreSQL. * Returns an Array as the resulting tuple on success. * On failure, it returns +nil+, and the error details can be obtained by #error. * * +bind_values+ represents values for the PostgreSQL bind parameters found in the +sql+. PostgreSQL bind parameters are presented as $1, $1, $2, etc. */ static VALUE pgconn_query(argc, argv, obj) int argc; VALUE *argv; VALUE obj; { return pgresult_result_with_clear(pgconn_exec(argc, argv, obj)); } /* * call-seq: * conn.async_query(sql) * * Sends an asynchronous SQL query request specified by _sql_ to the PostgreSQL. * Returns an Array as the resulting tuple on success. * On failure, it returns +nil+, and the error details can be obtained by #error. */ static VALUE pgconn_async_query(obj, str) VALUE obj, str; { return pgresult_result_with_clear(pgconn_async_exec(obj, str)); } /* * call-seq: * conn.get_notify() * * Returns an array of the unprocessed notifiers. * If there is no unprocessed notifier, it returns +nil+. */ static VALUE pgconn_get_notify(obj) VALUE obj; { PGconn* conn = get_pgconn(obj); PGnotify *notify; VALUE ary; if (PQconsumeInput(conn) == 0) { rb_raise(rb_ePGError, PQerrorMessage(conn)); } /* gets notify and builds result */ notify = PQnotifies(conn); if (notify == NULL) { /* there are no unhandled notifications */ return Qnil; } ary = rb_ary_new3(2, rb_tainted_str_new2(notify->relname), INT2NUM(notify->be_pid)); PQfreemem(notify); /* returns result */ return ary; } static VALUE pg_escape_str; static ID pg_gsub_bang_id; static void free_pgconn(ptr) PGconn *ptr; { PQfinish(ptr); } /* * call-seq: * conn.insert_table( table, values ) * * Inserts contents of the _values_ Array into the _table_. */ static VALUE pgconn_insert_table(obj, table, values) VALUE obj, table, values; { PGconn *conn = get_pgconn(obj); PGresult *result; VALUE s, buffer; int i, j; int res = 0; Check_Type(table, T_STRING); Check_Type(values, T_ARRAY); i = RARRAY_LEN(values); while (i--) { if (TYPE(RARRAY(RARRAY_PTR(values)[i])) != T_ARRAY) { rb_raise(rb_ePGError, "second arg must contain some kind of arrays."); } } buffer = rb_str_new(0, RSTRING_LEN(table) + 17 + 1); /* starts query */ snprintf(RSTRING_PTR(buffer), RSTRING_LEN(buffer), "copy %s from stdin ", StringValuePtr(table)); result = PQexec(conn, StringValuePtr(buffer)); if (!result){ rb_raise(rb_ePGError, PQerrorMessage(conn)); } PQclear(result); for (i = 0; i < RARRAY_LEN(values); i++) { struct RArray *row = RARRAY(RARRAY_PTR(values)[i]); buffer = rb_tainted_str_new(0,0); for (j = 0; j < RARRAY_LEN(row); j++) { if (j > 0) rb_str_cat(buffer, "\t", 1); if (NIL_P(RARRAY_PTR(row)[j])) { rb_str_cat(buffer, "\\N",2); } else { s = rb_obj_as_string(RARRAY_PTR(row)[j]); rb_funcall(s,pg_gsub_bang_id,2, rb_str_new("([\\t\\n\\\\])", 10),pg_escape_str); rb_str_cat(buffer, StringValuePtr(s), RSTRING_LEN(s)); } } rb_str_cat(buffer, "\n\0", 2); /* sends data */ PQputline(conn, StringValuePtr(buffer)); } PQputline(conn, "\\.\n"); res = PQendcopy(conn); return obj; } /* * call-seq: * conn.putline() * * Sends the string to the backend server. * Users must send a single "." to denote the end of data transmission. */ static VALUE pgconn_putline(obj, str) VALUE obj, str; { Check_Type(str, T_STRING); PQputline(get_pgconn(obj), StringValuePtr(str)); return obj; } /* * call-seq: * conn.getline() * * Reads a line from the backend server into internal buffer. * Returns +nil+ for EOF, +0+ for success, +1+ for buffer overflowed. * You need to ensure single "." from backend to confirm transmission completion. * The sample program psql.rb (see source for postgres) treats this copy protocol right. */ static VALUE pgconn_getline(obj) VALUE obj; { PGconn *conn = get_pgconn(obj); VALUE str; long size = BUFSIZ; long bytes = 0; int ret; str = rb_tainted_str_new(0, size); for (;;) { ret = PQgetline(conn, RSTRING_PTR(str) + bytes, size - bytes); switch (ret) { case EOF: return Qnil; case 0: rb_str_resize(str, strlen(StringValuePtr(str))); return str; } bytes += BUFSIZ; size += BUFSIZ; rb_str_resize(str, size); } return Qnil; } /* * call-seq: * conn.endcopy() * * Waits until the backend completes the copying. * You should call this method after #putline or #getline. * Returns +nil+ on success; raises an exception otherwise. */ static VALUE pgconn_endcopy(obj) VALUE obj; { if (PQendcopy(get_pgconn(obj)) == 1) { rb_raise(rb_ePGError, "cannot complete copying"); } return Qnil; } static void notice_proxy(self, message) VALUE self; const char *message; { VALUE block; if ((block = rb_iv_get(self, "@on_notice")) != Qnil) { rb_funcall(block, rb_intern("call"), 1, rb_str_new2(message)); } } /* * call-seq: * conn.on_notice {|message| ... } * * Notice and warning messages generated by the server are not returned * by the query execution functions, since they do not imply failure of * the query. Instead they are passed to a notice handling function, and * execution continues normally after the handler returns. The default * notice handling function prints the message on stderr, but the * application can override this behavior by supplying its own handling * function. */ static VALUE pgconn_on_notice(self) VALUE self; { VALUE block = rb_block_proc(); PGconn *conn = get_pgconn(self); if (PQsetNoticeProcessor(conn, NULL, NULL) != notice_proxy) { PQsetNoticeProcessor(conn, notice_proxy, (void *) self); } rb_iv_set(self, "@on_notice", block); return self; } /* * call-seq: * conn.host() * * Returns the connected server name. */ static VALUE pgconn_host(obj) VALUE obj; { char *host = PQhost(get_pgconn(obj)); if (!host) return Qnil; return rb_tainted_str_new2(host); } /* * call-seq: * conn.port() * * Returns the connected server port number. */ static VALUE pgconn_port(obj) VALUE obj; { char* port = PQport(get_pgconn(obj)); return INT2NUM(atol(port)); } /* * call-seq: * conn.db() * * Returns the connected database name. */ static VALUE pgconn_db(obj) VALUE obj; { char *db = PQdb(get_pgconn(obj)); if (!db) return Qnil; return rb_tainted_str_new2(db); } /* * call-seq: * conn.options() * * Returns backend option string. */ static VALUE pgconn_options(obj) VALUE obj; { char *options = PQoptions(get_pgconn(obj)); if (!options) return Qnil; return rb_tainted_str_new2(options); } /* * call-seq: * conn.tty() * * Returns the connected pgtty. */ static VALUE pgconn_tty(obj) VALUE obj; { char *tty = PQtty(get_pgconn(obj)); if (!tty) return Qnil; return rb_tainted_str_new2(tty); } /* * call-seq: * conn.user() * * Returns the authenticated user name. */ static VALUE pgconn_user(obj) VALUE obj; { char *user = PQuser(get_pgconn(obj)); if (!user) return Qnil; return rb_tainted_str_new2(user); } /* * call-seq: * conn.status() * * MISSING: documentation */ static VALUE pgconn_status(obj) VALUE obj; { return INT2NUM(PQstatus(get_pgconn(obj))); } /* * call-seq: * conn.error() * * Returns the error message about connection. */ static VALUE pgconn_error(obj) VALUE obj; { char *error = PQerrorMessage(get_pgconn(obj)); if (!error) return Qnil; return rb_tainted_str_new2(error); } /*TODO broken for ruby 1.9 * call-seq: * conn.trace( port ) * * Enables tracing message passing between backend. * The trace message will be written to the _port_ object, * which is an instance of the class +File+. */ static VALUE pgconn_trace(obj, port) VALUE obj, port; { //OpenFile* fp; Check_Type(port, T_FILE); //GetOpenFile(port, fp); //PQtrace(get_pgconn(obj), fp->f2?fp->f2:fp->f); return obj; } /* * call-seq: * conn.untrace() * * Disables the message tracing. */ static VALUE pgconn_untrace(obj) VALUE obj; { PQuntrace(get_pgconn(obj)); return obj; } /* * call-seq: * conn.transaction_status() * * returns one of the following statuses: * PQTRANS_IDLE = 0 (connection idle) * PQTRANS_ACTIVE = 1 (command in progress) * PQTRANS_INTRANS = 2 (idle, within transaction block) * PQTRANS_INERROR = 3 (idle, within failed transaction) * PQTRANS_UNKNOWN = 4 (cannot determine status) * * See the PostgreSQL documentation on PQtransactionStatus[http://www.postgresql.org/docs/current/interactive/libpq-status.html#AEN24919] for more information. */ static VALUE pgconn_transaction_status(obj) VALUE obj; { return INT2NUM(PQtransactionStatus(get_pgconn(obj))); } #ifdef HAVE_PQSETCLIENTENCODING /* * call-seq: * conn.protocol_version -> Integer * * The 3.0 protocol will normally be used when communicating with PostgreSQL 7.4 or later servers; pre-7.4 servers support only protocol 2.0. (Protocol 1.0 is obsolete and not supported by libpq.) */ static VALUE pgconn_protocol_version(obj) VALUE obj; { return INT2NUM(PQprotocolVersion(get_pgconn(obj))); } /* * call-seq: * conn.server_version -> Integer * * The number is formed by converting the major, minor, and revision numbers into two-decimal-digit numbers and appending them together. For example, version 7.4.2 will be returned as 70402, and version 8.1 will be returned as 80100 (leading zeroes are not shown). Zero is returned if the connection is bad. */ static VALUE pgconn_server_version(obj) VALUE obj; { return INT2NUM(PQserverVersion(get_pgconn(obj))); } /* * call-seq: * conn.lastval -> Integer * * Returns the sequence value returned by the last call to the PostgreSQL function nextval(sequence_name). Equivalent to conn.query('select lastval()').first.first. * * This functionality is only available with PostgreSQL 8.1 and newer. * See the PostgreSQL documentation on lastval[http://www.postgresql.org/docs/current/interactive/functions-sequence.html] for more information. */ static VALUE pgconn_lastval(obj) VALUE obj; { PGconn *conn = get_pgconn(obj); PGresult *result; VALUE lastval, error; result = PQexec(conn, "select lastval()"); if (!result) rb_raise(rb_ePGError, PQerrorMessage(conn)); switch (PQresultStatus(result)) { case PGRES_TUPLES_OK: lastval = rb_cstr2inum(PQgetvalue(result, 0, 0), 10); PQclear(result); return lastval; case PGRES_BAD_RESPONSE: case PGRES_FATAL_ERROR: case PGRES_NONFATAL_ERROR: error = rb_str_new2(PQresultErrorMessage(result)); PQclear(result); rb_raise(rb_ePGError, StringValuePtr(error)); default: PQclear(result); rb_raise(rb_ePGError, "unknown lastval"); } } /* * call-seq: * conn.client_encoding() -> String * * Returns the client encoding as a String. */ static VALUE pgconn_client_encoding(obj) VALUE obj; { char *encoding = (char *)pg_encoding_to_char(PQclientEncoding(get_pgconn(obj))); return rb_tainted_str_new2(encoding); } /* * call-seq: * conn.set_client_encoding( encoding ) * * Sets the client encoding to the _encoding_ String. */ static VALUE pgconn_set_client_encoding(obj, str) VALUE obj, str; { Check_Type(str, T_STRING); if ((PQsetClientEncoding(get_pgconn(obj), StringValuePtr(str))) == -1){ rb_raise(rb_ePGError, "invalid encoding name: %s",StringValuePtr(str)); } return Qnil; } #endif static void free_pgresult(ptr) PGresult *ptr; { PQclear(ptr); } #define VARHDRSZ 4 #define SCALE_MASK 0xffff static int has_numeric_scale(typmod) int typmod; { if (typmod == -1) return 1; return (typmod - VARHDRSZ) & SCALE_MASK; } #define PARSE(klass, string) rb_funcall(klass, rb_intern("parse"), 1, rb_tainted_str_new2(string)); static VALUE fetch_pgresult(result, row, column) PGresult *result; int row; int column; { char* string; if (PQgetisnull(result, row, column)) { return Qnil; } string = PQgetvalue(result, row, column); if (!translate_results) { #ifdef RUBY_18_COMPAT return rb_tainted_str_new2(string); #else return rb_enc_associate(rb_tainted_str_new2(string), rb_default_external_encoding()); #endif } switch (PQftype(result, column)) { case BOOLOID: return *string == 't' ? Qtrue : Qfalse; case BYTEAOID: return pgconn_s_unescape_bytea(rb_cPGconn, rb_tainted_str_new2(string)); case NUMERICOID: if (has_numeric_scale(PQfmod(result, column))) { return rb_funcall(rb_cBigDecimal, rb_intern("new"), 1, rb_tainted_str_new2(string)); } /* when scale == 0 return inum */ case INT8OID: case INT4OID: case INT2OID: return rb_cstr2inum(string, 10); case FLOAT8OID: case FLOAT4OID: return rb_float_new(rb_cstr_to_dbl(string, Qfalse)); case DATEOID: return PARSE(rb_cDate, string); case TIMEOID: case TIMETZOID: case TIMESTAMPOID: case TIMESTAMPTZOID: return PARSE(rb_cTime, string); default: #ifdef RUBY_18_COMPAT return rb_tainted_str_new2(string); #else return rb_enc_associate(rb_tainted_str_new2(string), rb_default_external_encoding()); #endif } } static VALUE pgresult_new(ptr) PGresult *ptr; { return Data_Wrap_Struct(rb_cPGresult, 0, free_pgresult, ptr); } /* * call-seq: * res.status() * * Returns the status of the query. The status value is one of: * * +EMPTY_QUERY+ * * +COMMAND_OK+ * * +TUPLES_OK+ * * +COPY_OUT+ * * +COPY_IN+ */ static VALUE pgresult_status(obj) VALUE obj; { return INT2NUM(PQresultStatus(get_pgresult(obj))); } /* * call-seq: * res.result() * * Returns an array of tuples (rows, which are themselves arrays) that represent the query result. */ static VALUE fetch_pgrow(self, fields, row_num) VALUE self, fields; int row_num; { PGresult *result = get_pgresult(self); VALUE row = rb_funcall(rb_cPGrow, rb_intern("new"), 1, fields); int field_num; for (field_num = 0; field_num < RARRAY_LEN(fields); field_num++) { /* don't use push, PGrow is sized with nils in #new */ rb_ary_store(row, field_num, fetch_pgresult(result, row_num, field_num)); } return row; } /* * call-seq: * conn.select_one(query, *bind_values) * * Return the first row of the query results. * Equivalent to conn.query(query, *bind_values).first */ static VALUE pgconn_select_one(argc, argv, self) int argc; VALUE *argv; VALUE self; { VALUE result = pgconn_exec(argc, argv, self); VALUE row = fetch_pgrow(result, pgresult_fields(result), 0); pgresult_clear(result); return row; } /* * call-seq: * conn.select_value(query, *bind_values) * * Return the first value of the first row of the query results. * Equivalent to conn.query(query, *bind_values).first.first */ static VALUE pgconn_select_value(argc, argv, self) int argc; VALUE *argv; VALUE self; { VALUE result = pgconn_exec(argc, argv, self); VALUE value = fetch_pgresult(get_pgresult(result), 0, 0); pgresult_clear(result); return value; } /* * call-seq: * conn.select_values(query, *bind_values) * * Equivalent to conn.query(query, *bind_values).flatten */ static VALUE pgconn_select_values(argc, argv, self) int argc; VALUE *argv; VALUE self; { VALUE pg_result = pgconn_exec(argc, argv, self); PGresult * result = get_pgresult(pg_result); int ntuples = PQntuples(result); int nfields = PQnfields(result); VALUE values = rb_ary_new2(ntuples * nfields); int row_num, field_num; for (row_num = 0; row_num < ntuples; row_num++) { for (field_num = 0; field_num < nfields; field_num++) { rb_ary_push(values, fetch_pgresult(result, row_num, field_num)); } } pgresult_clear(pg_result); return values; } /* * call-seq: * res.each{ |tuple| ... } * * Invokes the block for each tuple (row) in the result. * * Equivalent to res.result.each{ |tuple| ... }. */ static VALUE pgresult_each(self) VALUE self; { PGresult *result = get_pgresult(self); int row_count = PQntuples(result); VALUE fields = pgresult_fields(self); int row_num; for (row_num = 0; row_num < row_count; row_num++) { VALUE row = fetch_pgrow(self, fields, row_num); rb_yield(row); } return self; } /* * call-seq: * res[ n ] * * Returns the tuple (row) corresponding to _n_. Returns +nil+ if _n_ >= res.num_tuples. * * Equivalent to res.result[n]. */ static VALUE pgresult_aref(argc, argv, obj) int argc; VALUE *argv; VALUE obj; { PGresult *result; VALUE a1, a2, val; int i, j, nf, nt; result = get_pgresult(obj); nt = PQntuples(result); nf = PQnfields(result); switch (rb_scan_args(argc, argv, "11", &a1, &a2)) { case 1: i = NUM2INT(a1); if( i >= nt ) return Qnil; val = rb_ary_new(); for (j=0; j= nt ) return Qnil; j = NUM2INT(a2); if( j >= nf ) return Qnil; return fetch_pgresult(result, i, j); default: return Qnil; /* not reached */ } } /* * call-seq: * res.fields() * * Returns an array of Strings representing the names of the fields in the result. * * res=conn.exec("SELECT foo,bar AS biggles,jim,jam FROM mytable") * res.fields => [ 'foo' , 'biggles' , 'jim' , 'jam' ] */ static VALUE pgresult_fields(obj) VALUE obj; { PGresult *result; VALUE ary; int n, i; result = get_pgresult(obj); n = PQnfields(result); ary = rb_ary_new2(n); for (i=0;ires.result.length (but faster). */ static VALUE pgresult_num_tuples(obj) VALUE obj; { int n; n = PQntuples(get_pgresult(obj)); return INT2NUM(n); } /* * call-seq: * res.num_fields() * * Returns the number of fields (columns) in the query result. * * Similar to res.result[0].length (but faster). */ static VALUE pgresult_num_fields(obj) VALUE obj; { int n; n = PQnfields(get_pgresult(obj)); return INT2NUM(n); } /* * call-seq: * res.fieldname( index ) * * Returns the name of the field (column) corresponding to the index. * * res=conn.exec("SELECT foo,bar AS biggles,jim,jam FROM mytable") * puts res.fieldname(2) => 'jim' * puts res.fieldname(1) => 'biggles' * * Equivalent to res.fields[_index_]. */ static VALUE pgresult_fieldname(obj, index) VALUE obj, index; { PGresult *result; int i = NUM2INT(index); char *name; result = get_pgresult(obj); if (i < 0 || i >= PQnfields(result)) { rb_raise(rb_eArgError,"invalid field number %d", i); } name = PQfname(result, i); return rb_tainted_str_new2(name); } /* * call-seq: * res.fieldnum( name ) * * Returns the index of the field specified by the string _name_. * * res=conn.exec("SELECT foo,bar AS biggles,jim,jam FROM mytable") * puts res.fieldnum('foo') => 0 * * Raises an ArgumentError if the specified _name_ isn't one of the field names; * raises a TypeError if _name_ is not a String. */ static VALUE pgresult_fieldnum(obj, name) VALUE obj, name; { int n; Check_Type(name, T_STRING); n = PQfnumber(get_pgresult(obj), StringValuePtr(name)); if (n == -1) { rb_raise(rb_eArgError,"Unknown field: %s", StringValuePtr(name)); } return INT2NUM(n); } /* * call-seq: * res.type( index ) * * Returns the data type associated with the given column number. * * The integer returned is the internal +OID+ number (in PostgreSQL) of the type. * If you have the PostgreSQL source available, you can see the OIDs for every column type in the file src/include/catalog/pg_type.h. */ static VALUE pgresult_type(obj, index) VALUE obj, index; { PGresult* result = get_pgresult(obj); int i = NUM2INT(index); if (i < 0 || i >= PQnfields(result)) { rb_raise(rb_eArgError, "invalid field number %d", i); } return INT2NUM(PQftype(result, i)); } /* * call-seq: * res.size( index ) * * Returns the size of the field type in bytes. Returns -1 if the field is variable sized. * * res = conn.exec("SELECT myInt, myVarChar50 FROM foo") * res.size(0) => 4 * res.size(1) => -1 */ static VALUE pgresult_size(obj, index) VALUE obj, index; { PGresult *result; int i = NUM2INT(index); int size; result = get_pgresult(obj); if (i < 0 || i >= PQnfields(result)) { rb_raise(rb_eArgError,"invalid field number %d", i); } size = PQfsize(result, i); return INT2NUM(size); } /* * call-seq: * res.value( tup_num, field_num ) * * Returns the value in tuple number tup_num, field number field_num. (Row tup_num, column field_num.) * * Equivalent to res.result[tup_num][field_num] (but faster). */ static VALUE pgresult_getvalue(obj, tup_num, field_num) VALUE obj, tup_num, field_num; { PGresult *result; int i = NUM2INT(tup_num); int j = NUM2INT(field_num); result = get_pgresult(obj); if (i < 0 || i >= PQntuples(result)) { rb_raise(rb_eArgError,"invalid tuple number %d", i); } if (j < 0 || j >= PQnfields(result)) { rb_raise(rb_eArgError,"invalid field number %d", j); } return fetch_pgresult(result, i, j); } /* * call-seq: * res.value_byname( tup_num, field_name ) * * Returns the value in tuple number tup_num, for the field named field_name. * * Equivalent to (but faster than) either of: * res.result[tup_num][ res.fieldnum(field_name) ] * res.value( tup_num, res.fieldnum(field_name) ) * * (This method internally calls #value as like the second example above; it is slower than using the field index directly.) */ static VALUE pgresult_getvalue_byname(obj, tup_num, field_name) VALUE obj, tup_num, field_name; { return pgresult_getvalue(obj, tup_num, pgresult_fieldnum(obj, field_name)); } /* * call-seq: * res.getlength( tup_num, field_num ) * * Returns the (String) length of the field in bytes. * * Equivalent to res.value(tup_num,field_num).length. */ static VALUE pgresult_getlength(obj, tup_num, field_num) VALUE obj, tup_num, field_num; { PGresult *result; int i = NUM2INT(tup_num); int j = NUM2INT(field_num); result = get_pgresult(obj); if (i < 0 || i >= PQntuples(result)) { rb_raise(rb_eArgError,"invalid tuple number %d", i); } if (j < 0 || j >= PQnfields(result)) { rb_raise(rb_eArgError,"invalid field number %d", j); } return INT2FIX(PQgetlength(result, i, j)); } /* * call-seq: * res.getisnull(tuple_position, field_position) -> boolean * * Returns +true+ if the specified value is +nil+; +false+ otherwise. * * Equivalent to res.value(tup_num,field_num)==+nil+. */ static VALUE pgresult_getisnull(obj, tup_num, field_num) VALUE obj, tup_num, field_num; { PGresult *result; int i = NUM2INT(tup_num); int j = NUM2INT(field_num); result = get_pgresult(obj); if (i < 0 || i >= PQntuples(result)) { rb_raise(rb_eArgError,"invalid tuple number %d", i); } if (j < 0 || j >= PQnfields(result)) { rb_raise(rb_eArgError,"invalid field number %d", j); } return PQgetisnull(result, i, j) ? Qtrue : Qfalse; } /* * call-seq: * res.cmdtuples() * * Returns the number of tuples (rows) affected by the SQL command. * * If the SQL command that generated the PGresult was not one of +INSERT+, +UPDATE+, +DELETE+, +MOVE+, or +FETCH+, or if no tuples (rows) were affected, 0 is returned. */ static VALUE pgresult_cmdtuples(obj) VALUE obj; { long n; n = strtol(PQcmdTuples(get_pgresult(obj)),NULL, 10); return INT2NUM(n); } /* * call-seq: * res.cmdstatus() * * Returns the status string of the last query command. */ static VALUE pgresult_cmdstatus(obj) VALUE obj; { return rb_tainted_str_new2(PQcmdStatus(get_pgresult(obj))); } /* * call-seq: * res.oid() * * Returns the +oid+. */ static VALUE pgresult_oid(obj) VALUE obj; { Oid n = PQoidValue(get_pgresult(obj)); if (n == InvalidOid) return Qnil; else return INT2NUM(n); } /* * call-seq: * res.clear() * * Clears the PGresult object as the result of the query. */ static VALUE pgresult_clear(obj) VALUE obj; { PQclear(get_pgresult(obj)); DATA_PTR(obj) = 0; return Qnil; } static VALUE pgresult_result_with_clear(self) VALUE self; { VALUE rows = rb_funcall(self, rb_intern("rows"), 0); pgresult_clear(self); return rows; } /* Large Object support */ static PGlarge* get_pglarge(obj) VALUE obj; { PGlarge *pglarge; Data_Get_Struct(obj, PGlarge, pglarge); if (pglarge == NULL) rb_raise(rb_ePGError, "invalid large object"); return pglarge; } /* * call-seq: * conn.lo_import(file) -> PGlarge * * Import a file to a large object. Returns a PGlarge instance on success. On failure, it raises a PGError exception. */ static VALUE pgconn_loimport(obj, filename) VALUE obj, filename; { Oid lo_oid; PGconn *conn = get_pgconn(obj); Check_Type(filename, T_STRING); lo_oid = lo_import(conn, StringValuePtr(filename)); if (lo_oid == 0) { rb_raise(rb_ePGError, PQerrorMessage(conn)); } return pglarge_new(conn, lo_oid, -1); } /* * call-seq: * conn.lo_export( oid, file ) * * Saves a large object of _oid_ to a _file_. */ static VALUE pgconn_loexport(obj, lo_oid,filename) VALUE obj, lo_oid, filename; { PGconn *conn = get_pgconn(obj); int oid; Check_Type(filename, T_STRING); oid = NUM2INT(lo_oid); if (oid < 0) { rb_raise(rb_ePGError, "invalid large object oid %d",oid); } if (!lo_export(conn, oid, StringValuePtr(filename))) { rb_raise(rb_ePGError, PQerrorMessage(conn)); } return Qnil; } /* * call-seq: * conn.lo_create( [mode] ) -> PGlarge * * Returns a PGlarge instance on success. On failure, it raises PGError exception. * (See #lo_open for information on _mode_.) */ static VALUE pgconn_locreate(argc, argv, obj) int argc; VALUE *argv; VALUE obj; { Oid lo_oid; int mode; VALUE nmode; PGconn *conn; if (rb_scan_args(argc, argv, "01", &nmode) == 0) { mode = INV_READ; } else { mode = FIX2INT(nmode); } conn = get_pgconn(obj); lo_oid = lo_creat(conn, mode); if (lo_oid == 0){ rb_raise(rb_ePGError, "can't creat large object"); } return pglarge_new(conn, lo_oid, -1); } /* * call-seq: * conn.lo_open( oid, [mode] ) -> PGlarge * * Open a large object of _oid_. Returns a PGlarge instance on success. * The _mode_ argument specifies the mode for the opened large object, * which is either +INV_READ+, or +INV_WRITE+. * * If _mode_ On failure, it raises a PGError exception. * * If _mode_ is omitted, the default is +INV_READ+. */ static VALUE pgconn_loopen(argc, argv, obj) int argc; VALUE *argv; VALUE obj; { Oid lo_oid; int fd, mode; VALUE nmode, objid; PGconn *conn = get_pgconn(obj); switch (rb_scan_args(argc, argv, "02", &objid, &nmode)) { case 1: lo_oid = NUM2INT(objid); mode = INV_READ; break; case 2: lo_oid = NUM2INT(objid); mode = FIX2INT(nmode); break; default: mode = INV_READ; lo_oid = lo_creat(conn, mode); if (lo_oid == 0){ rb_raise(rb_ePGError, "can't creat large object"); } } if((fd = lo_open(conn, lo_oid, mode)) < 0) { rb_raise(rb_ePGError, "can't open large object"); } return pglarge_new(conn, lo_oid, fd); } /* * call-seq: * conn.lo_unlink( oid ) * * Unlinks (deletes) the postgres large object of _oid_. */ static VALUE pgconn_lounlink(obj, lo_oid) VALUE obj, lo_oid; { PGconn *conn; int oid = NUM2INT(lo_oid); int result; if (oid < 0){ rb_raise(rb_ePGError, "invalid oid %d",oid); } conn = get_pgconn(obj); result = lo_unlink(conn,oid); return Qnil; } static void free_pglarge(ptr) PGlarge *ptr; { if ((ptr->lo_fd) > 0) { lo_close(ptr->pgconn,ptr->lo_fd); } free(ptr); } static VALUE pglarge_new(conn, lo_oid ,lo_fd) PGconn *conn; Oid lo_oid; int lo_fd; { VALUE obj; PGlarge *pglarge; obj = Data_Make_Struct(rb_cPGlarge, PGlarge, 0, free_pglarge, pglarge); pglarge->pgconn = conn; pglarge->lo_oid = lo_oid; pglarge->lo_fd = lo_fd; return obj; } /* * call-seq: * lrg.oid() * * Returns the large object's +oid+. */ static VALUE pglarge_oid(obj) VALUE obj; { PGlarge *pglarge = get_pglarge(obj); return INT2NUM(pglarge->lo_oid); } /* * call-seq: * lrg.open( [mode] ) * * Opens a large object. * The _mode_ argument specifies the mode for the opened large object, * which is either +INV_READ+ or +INV_WRITE+. */ static VALUE pglarge_open(argc, argv, obj) int argc; VALUE *argv; VALUE obj; { PGlarge *pglarge = get_pglarge(obj); VALUE nmode; int fd; int mode; if (rb_scan_args(argc, argv, "01", &nmode) == 0) { mode = INV_READ; } else { mode = FIX2INT(nmode); } if((fd = lo_open(pglarge->pgconn, pglarge->lo_oid, mode)) < 0) { rb_raise(rb_ePGError, "can't open large object"); } pglarge->lo_fd = fd; return INT2FIX(pglarge->lo_fd); } /* * call-seq: * lrg.close() * * Closes a large object. Closed when they are garbage-collected. */ static VALUE pglarge_close(obj) VALUE obj; { PGlarge *pglarge = get_pglarge(obj); if((lo_close(pglarge->pgconn, pglarge->lo_fd)) < 0) { rb_raise(rb_ePGError, "can't closed large object"); } DATA_PTR(obj) = 0; return Qnil; } /* * call-seq: * lrg.tell() * * Returns the current position of the large object pointer. */ static VALUE pglarge_tell(obj) VALUE obj; { int start; PGlarge *pglarge = get_pglarge(obj); if ((start = lo_tell(pglarge->pgconn,pglarge->lo_fd)) == -1) { rb_raise(rb_ePGError, "error while getting position"); } return INT2NUM(start); } static VALUE loread_all(obj) VALUE obj; { PGlarge *pglarge = get_pglarge(obj); VALUE str; long siz = BUFSIZ; long bytes = 0; int n; str = rb_tainted_str_new(0,siz); for (;;) { n = lo_read(pglarge->pgconn, pglarge->lo_fd, RSTRING_PTR(str) + bytes,siz - bytes); if (n == 0 && bytes == 0) return Qnil; bytes += n; if (bytes < siz ) break; siz += BUFSIZ; rb_str_resize(str,siz); } if (bytes == 0) return rb_tainted_str_new(0,0); if (bytes != siz) rb_str_resize(str, bytes); return str; } /* * call-seq: * lrg.read( [length] ) * * Attempts to read _length_ bytes from large object. * If no _length_ is given, reads all data. */ static VALUE pglarge_read(argc, argv, obj) int argc; VALUE *argv; VALUE obj; { int len; PGlarge *pglarge = get_pglarge(obj); VALUE length; char *buffer; rb_scan_args(argc, argv, "01", &length); if (NIL_P(length)) { return loread_all(obj); } len = NUM2INT(length); if (len < 0){ rb_raise(rb_ePGError,"nagative length %d given", len); } buffer = ALLOCA_N(char, len); if((len = lo_read(pglarge->pgconn, pglarge->lo_fd, buffer, len)) < 0) { rb_raise(rb_ePGError, "error while reading"); } if (len == 0) return Qnil; return rb_str_new(buffer,len); } /* * call-seq: * lrg.write( str ) * * Writes the string _str_ to the large object. * Returns the number of bytes written. */ static VALUE pglarge_write(obj, buffer) VALUE obj, buffer; { int n; PGlarge *pglarge = get_pglarge(obj); Check_Type(buffer, T_STRING); if( RSTRING_LEN(buffer) < 0) { rb_raise(rb_ePGError, "write buffer zero string"); } if((n = lo_write(pglarge->pgconn, pglarge->lo_fd, StringValuePtr(buffer), RSTRING_LEN(buffer))) == -1) { rb_raise(rb_ePGError, "buffer truncated during write"); } return INT2FIX(n); } /* * call-seq: * lrg.seek( offset, whence ) * * Move the large object pointer to the _offset_. * Valid values for _whence_ are +SEEK_SET+, +SEEK_CUR+, and +SEEK_END+. * (Or 0, 1, or 2.) */ static VALUE pglarge_seek(obj, offset, whence) VALUE obj, offset, whence; { PGlarge *pglarge = get_pglarge(obj); int ret; if((ret = lo_lseek(pglarge->pgconn, pglarge->lo_fd, NUM2INT(offset), NUM2INT(whence))) == -1) { rb_raise(rb_ePGError, "error while moving cursor"); } return INT2NUM(ret); } /* * call-seq: * lrg.size() * * Returns the size of the large object. */ static VALUE pglarge_size(obj) VALUE obj; { PGlarge *pglarge = get_pglarge(obj); int start, end; if ((start = lo_tell(pglarge->pgconn,pglarge->lo_fd)) == -1) { rb_raise(rb_ePGError, "error while getting position"); } if ((end = lo_lseek(pglarge->pgconn, pglarge->lo_fd, 0, SEEK_END)) == -1) { rb_raise(rb_ePGError, "error while moving cursor"); } if ((start = lo_lseek(pglarge->pgconn, pglarge->lo_fd,start, SEEK_SET)) == -1) { rb_raise(rb_ePGError, "error while moving back to posiion"); } return INT2NUM(end); } /* * call-seq: * lrg.export( file ) * * Saves the large object to a file. */ static VALUE pglarge_export(obj, filename) VALUE obj, filename; { PGlarge *pglarge = get_pglarge(obj); Check_Type(filename, T_STRING); if (!lo_export(pglarge->pgconn, pglarge->lo_oid, StringValuePtr(filename))){ rb_raise(rb_ePGError, PQerrorMessage(pglarge->pgconn)); } return Qnil; } /* * call-seq: * lrg.unlink() * * Deletes the large object. */ static VALUE pglarge_unlink(obj) VALUE obj; { PGlarge *pglarge = get_pglarge(obj); if (!lo_unlink(pglarge->pgconn,pglarge->lo_oid)) { rb_raise(rb_ePGError, PQerrorMessage(pglarge->pgconn)); } DATA_PTR(obj) = 0; return Qnil; } static VALUE pgrow_init(self, keys) VALUE self, keys; { VALUE args[1] = { LONG2NUM(RARRAY_LEN(keys)) }; rb_call_super(1, args); rb_iv_set(self, "@keys", keys); return self; } /* * call-seq: * row.keys -> Array * * Column names. */ static VALUE pgrow_keys(self) VALUE self; { return rb_iv_get(self, "@keys"); } /* * call-seq: * row.values -> row */ static VALUE pgrow_values(self) VALUE self; { return self; } /* * call-seq: * row[position] -> value * row[name] -> value * * Access elements of this row by column position or name. */ static VALUE pgrow_aref(argc, argv, self) int argc; VALUE * argv; VALUE self; { if (TYPE(argv[0]) == T_STRING) { VALUE keys = pgrow_keys(self); VALUE index = rb_funcall(keys, rb_intern("index"), 1, argv[0]); if (index == Qnil) { rb_raise(rb_ePGError, "%s: field not found", StringValuePtr(argv[0])); } else { return rb_ary_entry(self, NUM2INT(index)); } } else { return rb_call_super(argc, argv); } } /* * call-seq: * row.each_value { |value| block } -> row * * Iterate with values. */ static VALUE pgrow_each_value(self) VALUE self; { rb_ary_each(self); return self; } /* * call-seq: * row.each_pair { |column_value_array| block } -> row * * Iterate with column,value pairs. */ static VALUE pgrow_each_pair(self) VALUE self; { VALUE keys = pgrow_keys(self); int i; for (i = 0; i < RARRAY_LEN(keys); ++i) { rb_yield(rb_assoc_new(rb_ary_entry(keys, i), rb_ary_entry(self, i))); } return self; } /* * call-seq: * row.each { |column, value| block } -> row * row.each { |value| block } -> row * * Iterate with values or column,value pairs. */ static VALUE pgrow_each(self) VALUE self; { int arity = NUM2INT(rb_funcall(rb_block_proc(), rb_intern("arity"), 0)); if (arity == 2) { pgrow_each_pair(self); } else { pgrow_each_value(self); } return self; } /* * call-seq: * row.each_key { |column| block } -> row * * Iterate with column names. */ static VALUE pgrow_each_key(self) VALUE self; { rb_ary_each(pgrow_keys(self)); return self; } /* * call-seq: * row.to_hash -> Hash * * Returns a +Hash+ of the row's values indexed by column name. * Equivalent to Hash [*row.keys.zip(row).flatten] */ static VALUE pgrow_to_hash(self) VALUE self; { VALUE result = rb_hash_new(); VALUE keys = pgrow_keys(self); int i; for (i = 0; i < RARRAY_LEN(self); ++i) { rb_hash_aset(result, rb_ary_entry(keys, i), rb_ary_entry(self, i)); } return result; } /* Large Object support */ /******************************************************************** * * Document-class: PGconn * * The class to access PostgreSQL database. * * For example, to send query to the database on the localhost: * require 'pg' * conn = PGconn.open('dbname' => 'test1') * res = conn.exec('select * from a') * * See the PGresult class for information on working with the results of a query. */ /******************************************************************** * * Document-class: PGresult * * The class to represent the query result tuples (rows). * An instance of this class is created as the result of every query. * You may need to invoke the #clear method of the instance when finished with * the result for better memory performance. */ /******************************************************************** * * Document-class: PGrow * * Array subclass that provides hash-like behavior. */ /******************************************************************** * * Document-class: PGlarge * * The class to access large objects. * An instance of this class is created as the result of * PGconn#lo_import, PGconn#lo_create, and PGconn#lo_open. */ void Init_postgres() { pg_gsub_bang_id = rb_intern("gsub!"); pg_escape_str = rb_str_new("\\\\\\1", 4); rb_global_variable(&pg_escape_str); rb_require("bigdecimal"); rb_require("date"); rb_require("time"); rb_cBigDecimal = RUBY_CLASS("BigDecimal"); rb_cDate = RUBY_CLASS("Date"); rb_cDateTime = RUBY_CLASS("DateTime"); rb_ePGError = rb_define_class("PGError", rb_eStandardError); rb_define_alias(rb_ePGError, "error", "message"); rb_cPGconn = rb_define_class("PGconn", rb_cObject); #ifdef HAVE_RB_DEFINE_ALLOC_FUNC rb_define_alloc_func(rb_cPGconn, pgconn_alloc); #else rb_define_singleton_method(rb_cPGconn, "new", pgconn_s_new, -1); #endif rb_define_singleton_alias(rb_cPGconn, "connect", "new"); rb_define_singleton_alias(rb_cPGconn, "open", "connect"); rb_define_singleton_alias(rb_cPGconn, "setdb", "connect"); rb_define_singleton_alias(rb_cPGconn, "setdblogin", "connect"); rb_define_singleton_method(rb_cPGconn, "escape", pgconn_s_escape, 1); rb_define_singleton_method(rb_cPGconn, "quote", pgconn_s_quote, 1); rb_define_singleton_alias(rb_cPGconn, "format", "quote"); rb_define_singleton_method(rb_cPGconn, "escape_bytea", pgconn_s_escape_bytea, 1); rb_define_singleton_method(rb_cPGconn, "unescape_bytea", pgconn_s_unescape_bytea, 1); rb_define_singleton_method(rb_cPGconn, "translate_results=", pgconn_s_translate_results_set, 1); rb_define_singleton_method(rb_cPGconn, "quote_ident", pgconn_s_quote_ident, 1); rb_define_const(rb_cPGconn, "CONNECTION_OK", INT2FIX(CONNECTION_OK)); rb_define_const(rb_cPGconn, "CONNECTION_BAD", INT2FIX(CONNECTION_BAD)); rb_define_method(rb_cPGconn, "initialize", pgconn_init, -1); rb_define_method(rb_cPGconn, "db", pgconn_db, 0); rb_define_method(rb_cPGconn, "host", pgconn_host, 0); rb_define_method(rb_cPGconn, "options", pgconn_options, 0); rb_define_method(rb_cPGconn, "port", pgconn_port, 0); rb_define_method(rb_cPGconn, "tty", pgconn_tty, 0); rb_define_method(rb_cPGconn, "status", pgconn_status, 0); rb_define_method(rb_cPGconn, "error", pgconn_error, 0); rb_define_method(rb_cPGconn, "close", pgconn_close, 0); rb_define_alias(rb_cPGconn, "finish", "close"); rb_define_method(rb_cPGconn, "reset", pgconn_reset, 0); rb_define_method(rb_cPGconn, "user", pgconn_user, 0); rb_define_method(rb_cPGconn, "trace", pgconn_trace, 1); rb_define_method(rb_cPGconn, "untrace", pgconn_untrace, 0); rb_define_method(rb_cPGconn, "exec", pgconn_exec, -1); rb_define_method(rb_cPGconn, "query", pgconn_query, -1); rb_define_method(rb_cPGconn, "select_one", pgconn_select_one, -1); rb_define_method(rb_cPGconn, "select_value", pgconn_select_value, -1); rb_define_method(rb_cPGconn, "select_values", pgconn_select_values, -1); rb_define_method(rb_cPGconn, "async_exec", pgconn_async_exec, 1); rb_define_method(rb_cPGconn, "async_query", pgconn_async_query, 1); rb_define_method(rb_cPGconn, "get_notify", pgconn_get_notify, 0); rb_define_method(rb_cPGconn, "insert_table", pgconn_insert_table, 2); rb_define_method(rb_cPGconn, "putline", pgconn_putline, 1); rb_define_method(rb_cPGconn, "getline", pgconn_getline, 0); rb_define_method(rb_cPGconn, "endcopy", pgconn_endcopy, 0); rb_define_method(rb_cPGconn, "on_notice", pgconn_on_notice, 0); rb_define_method(rb_cPGconn, "transaction_status", pgconn_transaction_status, 0); rb_define_method(rb_cPGconn, "protocol_version", pgconn_protocol_version, 0); rb_define_method(rb_cPGconn, "server_version", pgconn_server_version, 0); rb_define_method(rb_cPGconn, "escape", pgconn_escape, 1); rb_define_method(rb_cPGconn, "escape_bytea", pgconn_escape_bytea, 1); rb_define_method(rb_cPGconn, "unescape_bytea", pgconn_s_unescape_bytea, 1); rb_define_method(rb_cPGconn, "quote", pgconn_quote, 1); rb_define_method(rb_cPGconn, "quote_ident", pgconn_s_quote_ident, 1); rb_define_alias(rb_cPGconn, "format", "quote"); /* following line is for rdoc */ /* rb_define_method(rb_cPGconn, "lastval", pgconn_lastval, 0); */ #ifdef HAVE_PQSETCLIENTENCODING rb_define_method(rb_cPGconn, "client_encoding", pgconn_client_encoding, 0); rb_define_method(rb_cPGconn, "set_client_encoding", pgconn_set_client_encoding, 1); #endif /* Large Object support */ rb_define_method(rb_cPGconn, "lo_import", pgconn_loimport, 1); rb_define_alias(rb_cPGconn, "loimport", "lo_import"); rb_define_method(rb_cPGconn, "lo_create", pgconn_locreate, -1); rb_define_alias(rb_cPGconn, "locreate", "lo_create"); rb_define_method(rb_cPGconn, "lo_open", pgconn_loopen, -1); rb_define_alias(rb_cPGconn, "loopen", "lo_open"); rb_define_method(rb_cPGconn, "lo_export", pgconn_loexport, 2); rb_define_alias(rb_cPGconn, "loexport", "lo_export"); rb_define_method(rb_cPGconn, "lo_unlink", pgconn_lounlink, 1); rb_define_alias(rb_cPGconn, "lounlink", "lo_unlink"); rb_cPGlarge = rb_define_class("PGlarge", rb_cObject); rb_define_method(rb_cPGlarge, "oid",pglarge_oid, 0); rb_define_method(rb_cPGlarge, "open",pglarge_open, -1); rb_define_method(rb_cPGlarge, "close",pglarge_close, 0); rb_define_method(rb_cPGlarge, "read",pglarge_read, -1); rb_define_method(rb_cPGlarge, "write",pglarge_write, 1); rb_define_method(rb_cPGlarge, "seek",pglarge_seek, 2); rb_define_method(rb_cPGlarge, "tell",pglarge_tell, 0); rb_define_method(rb_cPGlarge, "size",pglarge_size, 0); rb_define_method(rb_cPGlarge, "export",pglarge_export, 1); rb_define_method(rb_cPGlarge, "unlink",pglarge_unlink, 0); rb_define_const(rb_cPGlarge, "INV_WRITE", INT2FIX(INV_WRITE)); rb_define_const(rb_cPGlarge, "INV_READ", INT2FIX(INV_READ)); rb_define_const(rb_cPGlarge, "SEEK_SET", INT2FIX(SEEK_SET)); rb_define_const(rb_cPGlarge, "SEEK_CUR", INT2FIX(SEEK_CUR)); rb_define_const(rb_cPGlarge, "SEEK_END", INT2FIX(SEEK_END)); /* Large Object support */ rb_cPGresult = rb_define_class("PGresult", rb_cObject); rb_include_module(rb_cPGresult, rb_mEnumerable); rb_define_const(rb_cPGresult, "EMPTY_QUERY", INT2FIX(PGRES_EMPTY_QUERY)); rb_define_const(rb_cPGresult, "COMMAND_OK", INT2FIX(PGRES_COMMAND_OK)); rb_define_const(rb_cPGresult, "TUPLES_OK", INT2FIX(PGRES_TUPLES_OK)); rb_define_const(rb_cPGresult, "COPY_OUT", INT2FIX(PGRES_COPY_OUT)); rb_define_const(rb_cPGresult, "COPY_IN", INT2FIX(PGRES_COPY_IN)); rb_define_const(rb_cPGresult, "BAD_RESPONSE", INT2FIX(PGRES_BAD_RESPONSE)); rb_define_const(rb_cPGresult, "NONFATAL_ERROR",INT2FIX(PGRES_NONFATAL_ERROR)); rb_define_const(rb_cPGresult, "FATAL_ERROR", INT2FIX(PGRES_FATAL_ERROR)); rb_define_method(rb_cPGresult, "status", pgresult_status, 0); rb_define_alias(rb_cPGresult, "result", "entries"); rb_define_alias(rb_cPGresult, "rows", "entries"); rb_define_method(rb_cPGresult, "each", pgresult_each, 0); rb_define_method(rb_cPGresult, "[]", pgresult_aref, -1); rb_define_method(rb_cPGresult, "fields", pgresult_fields, 0); rb_define_method(rb_cPGresult, "ntuples", pgresult_num_tuples, 0); rb_define_alias(rb_cPGresult, "num_tuples", "ntuples"); rb_define_method(rb_cPGresult, "nfields", pgresult_num_fields, 0); rb_define_alias(rb_cPGresult, "num_fields", "nfields"); rb_define_method(rb_cPGresult, "fieldname", pgresult_fieldname, 1); rb_define_method(rb_cPGresult, "fieldnum", pgresult_fieldnum, 1); rb_define_method(rb_cPGresult, "ftype", pgresult_type, 1); rb_define_alias(rb_cPGresult, "type", "ftype"); rb_define_method(rb_cPGresult, "size", pgresult_size, 1); rb_define_method(rb_cPGresult, "getvalue", pgresult_getvalue, 2); rb_define_method(rb_cPGresult, "getvalue_byname", pgresult_getvalue_byname, 2); rb_define_method(rb_cPGresult, "getlength", pgresult_getlength, 2); rb_define_method(rb_cPGresult, "getisnull", pgresult_getisnull, 2); rb_define_method(rb_cPGresult, "cmd_tuples", pgresult_cmdtuples, 0); rb_define_alias(rb_cPGresult, "cmdtuples", "cmd_tuples"); rb_define_method(rb_cPGresult, "cmdstatus", pgresult_cmdstatus, 0); rb_define_method(rb_cPGresult, "oid", pgresult_oid, 0); rb_define_method(rb_cPGresult, "clear", pgresult_clear, 0); rb_define_alias(rb_cPGresult, "close", "clear"); rb_cPGrow = rb_define_class("PGrow", rb_cArray); rb_define_method(rb_cPGrow, "initialize", pgrow_init, 1); rb_define_method(rb_cPGrow, "[]", pgrow_aref, -1); rb_define_method(rb_cPGrow, "keys", pgrow_keys, 0); rb_define_method(rb_cPGrow, "values", pgrow_values, 0); rb_define_method(rb_cPGrow, "each", pgrow_each, 0); rb_define_method(rb_cPGrow, "each_pair", pgrow_each_pair, 0); rb_define_method(rb_cPGrow, "each_key", pgrow_each_key, 0); rb_define_method(rb_cPGrow, "each_value", pgrow_each_value, 0); rb_define_method(rb_cPGrow, "to_hash", pgrow_to_hash, 0); }