source: branches/4.x/module/pgmodule.c @ 652

Last change on this file since 652 was 652, checked in by cito, 4 years ago

Fix issue with some cleanup code in the C module

  • Property svn:keywords set to Id
File size: 100.7 KB
Line 
1/*
2 * $Id: pgmodule.c 652 2015-11-27 22:30:33Z cito $
3 * PyGres, version 2.2 A Python interface for PostgreSQL database. Written by
4 * D'Arcy J.M. Cain, (darcy@druid.net).  Based heavily on code written by
5 * Pascal Andre, andre@chimay.via.ecp.fr. Copyright (c) 1995, Pascal Andre
6 * (andre@via.ecp.fr).
7 *
8 * Permission to use, copy, modify, and distribute this software and its
9 * documentation for any purpose, without fee, and without a written
10 * agreement is hereby granted, provided that the above copyright notice and
11 * this paragraph and the following two paragraphs appear in all copies or in
12 * any new file that contains a substantial portion of this file.
13 *
14 * IN NO EVENT SHALL THE AUTHOR BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
15 * SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
16 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE
17 * AUTHOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
18 *
19 * THE AUTHOR SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED
20 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 * PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE
22 * AUTHOR HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
23 * ENHANCEMENTS, OR MODIFICATIONS.
24 *
25 * Further modifications copyright 1997, 1998, 1999 by D'Arcy J.M. Cain
26 * (darcy@druid.net) subject to the same terms and conditions as above.
27 *
28 */
29
30/* Note: This should be linked against the same C runtime lib as Python */
31#include <Python.h>
32
33#include <libpq-fe.h>
34
35/* some definitions from <libpq/libpq-fs.h> */
36#include "pgfs.h"
37/* the type definitions from <catalog/pg_type.h> */
38#include "pgtypes.h"
39
40static PyObject *Error, *Warning, *InterfaceError,
41        *DatabaseError, *InternalError, *OperationalError, *ProgrammingError,
42        *IntegrityError, *DataError, *NotSupportedError;
43
44#define _TOSTRING(x) #x
45#define TOSTRING(x) _TOSTRING(x)
46static const char *PyPgVersion = TOSTRING(PYGRESQL_VERSION);
47
48#if PY_VERSION_HEX < 0x02050000 && !defined(PY_SSIZE_T_MIN)
49typedef int Py_ssize_t;
50#define PY_SSIZE_T_MAX INT_MAX
51#define PY_SSIZE_T_MIN INT_MIN
52#endif
53
54#if PY_VERSION_HEX >= 0x02050000 && SIZEOF_SIZE_T != SIZEOF_INT
55#define Py_InitModule4 Py_InitModule4_64
56#endif
57
58/* taken from fileobject.c */
59#define BUF(v) PyString_AS_STRING((PyStringObject *)(v))
60
61/* default values */
62#define MODULE_NAME                     "pgsql"
63#define PG_ARRAYSIZE                    1
64
65/* flags for object validity checks */
66#define CHECK_OPEN                      1
67#define CHECK_CLOSE                     2
68#define CHECK_CNX                       4
69#define CHECK_RESULT            8
70#define CHECK_DQL                       16
71
72/* query result types */
73#define RESULT_EMPTY            1
74#define RESULT_DML                      2
75#define RESULT_DDL                      3
76#define RESULT_DQL                      4
77
78/* flags for move methods */
79#define QUERY_MOVEFIRST         1
80#define QUERY_MOVELAST          2
81#define QUERY_MOVENEXT          3
82#define QUERY_MOVEPREV          4
83
84/* moves names for errors */
85const char *__movename[5] =
86{"", "movefirst", "movelast", "movenext", "moveprev"};
87
88#define MAX_BUFFER_SIZE 8192    /* maximum transaction size */
89
90#ifndef PG_VERSION_NUM
91#ifdef PQnoPasswordSupplied
92#define PG_VERSION_NUM 80000
93#else
94#define PG_VERSION_NUM 70400
95#endif
96#endif
97
98/* Before 8.0, PQsetdbLogin was not thread-safe with kerberos. */
99#if PG_VERSION_NUM >= 80000 || !(defined(KRB4) || defined(KRB5))
100#define PQsetdbLoginIsThreadSafe 1
101#endif
102
103/* --------------------------------------------------------------------- */
104
105/* MODULE GLOBAL VARIABLES */
106
107#ifdef DEFAULT_VARS
108static PyObject *pg_default_host;       /* default database host */
109static PyObject *pg_default_base;       /* default database name */
110static PyObject *pg_default_opt;        /* default connection options */
111static PyObject *pg_default_tty;        /* default debug tty */
112static PyObject *pg_default_port;       /* default connection port */
113static PyObject *pg_default_user;       /* default username */
114static PyObject *pg_default_passwd;     /* default password */
115#endif  /* DEFAULT_VARS */
116
117DL_EXPORT(void) init_pg(void);
118int *get_type_array(PGresult *result, int nfields);
119
120static PyObject *decimal = NULL, /* decimal type */
121                                *namedresult = NULL; /* function for getting named results */
122static char decimal_point = '.'; /* decimal point used in money values */
123static int use_bool = 0; /* whether or not bool objects shall be returned */
124
125/* --------------------------------------------------------------------- */
126/* OBJECTS DECLARATION */
127
128/* pg connection object */
129
130typedef struct
131{
132        PyObject_HEAD
133        int                     valid;                          /* validity flag */
134        PGconn          *cnx;                           /* PostGres connection handle */
135        PyObject        *notice_receiver;       /* current notice receiver */
136}       pgobject;
137
138staticforward PyTypeObject PgType;
139
140#define is_pgobject(v) ((v)->ob_type == &PgType)
141
142static PyObject *
143pgobject_New(void)
144{
145        pgobject        *pgobj;
146
147        if (!(pgobj = PyObject_NEW(pgobject, &PgType)))
148                return NULL;
149
150        pgobj->valid = 1;
151        pgobj->cnx = NULL;
152        pgobj->notice_receiver = NULL;
153
154        return (PyObject *) pgobj;
155}
156
157/* pg notice result object */
158
159typedef struct
160{
161        PyObject_HEAD
162        pgobject        *pgcnx;         /* parent connection object */
163        PGresult        const *res;     /* an error or warning */
164}       pgnoticeobject;
165
166staticforward PyTypeObject PgNoticeType;
167
168#define is_pgnoticeobject(v) ((v)->ob_type == &PgNoticeType)
169
170/* pg query object */
171
172typedef struct
173{
174        PyObject_HEAD
175        PGresult        *result;                /* result content */
176        int                     result_type;    /* type of previous result */
177        long            current_pos;    /* current position in last result */
178        long            num_rows;               /* number of (affected) rows */
179}       pgqueryobject;
180
181staticforward PyTypeObject PgQueryType;
182
183#define is_pgqueryobject(v) ((v)->ob_type == &PgQueryType)
184
185/* pg source object */
186
187typedef struct
188{
189        PyObject_HEAD
190        int                     valid;                  /* validity flag */
191        pgobject        *pgcnx;                 /* parent connection object */
192        PGresult        *result;                /* result content */
193        int                     result_type;    /* result type (DDL/DML/DQL) */
194        long            arraysize;              /* array size for fetch method */
195        int                     current_row;    /* current selected row */
196        int                     max_row;                /* number of rows in the result */
197        int                     num_fields;             /* number of fields in each row */
198}       pgsourceobject;
199
200staticforward PyTypeObject PgSourceType;
201
202#define is_pgsourceobject(v) ((v)->ob_type == &PgSourceType)
203
204
205#ifdef LARGE_OBJECTS
206/* pg large object */
207
208typedef struct
209{
210        PyObject_HEAD
211        pgobject        *pgcnx;                 /* parent connection object */
212        Oid                     lo_oid;                 /* large object oid */
213        int                     lo_fd;                  /* large object fd */
214}       pglargeobject;
215
216staticforward PyTypeObject PglargeType;
217
218#define is_pglargeobject(v) ((v)->ob_type == &PglargeType)
219#endif /* LARGE_OBJECTS */
220
221/* --------------------------------------------------------------------- */
222/* INTERNAL FUNCTIONS */
223
224/* sets database error with sqlstate attribute */
225/* This should be used when raising a subclass of DatabaseError */
226static void
227set_dberror(PyObject *type, const char *msg, PGresult *result)
228{
229        PyObject *err = NULL;
230        PyObject *str;
231
232        if (!(str = PyString_FromString(msg)))
233                err = NULL;
234        else
235        {
236                err = PyObject_CallFunctionObjArgs(type, str, NULL);
237                Py_DECREF(str);
238        }
239        if (err)
240        {
241                if (result)
242                {
243                        char *sqlstate = PQresultErrorField(result, PG_DIAG_SQLSTATE);
244                        str = sqlstate ? PyString_FromStringAndSize(sqlstate, 5) : NULL;
245                }
246                else
247                        str = NULL;
248                if (!str)
249                {
250                        Py_INCREF(Py_None);
251                        str = Py_None;
252                }
253                PyObject_SetAttrString(err, "sqlstate", str);
254                Py_DECREF(str);
255                PyErr_SetObject(type, err);
256                Py_DECREF(err);
257        }
258        else
259                PyErr_SetString(type, msg);
260}
261
262
263/* checks connection validity */
264static int
265check_cnx_obj(pgobject *self)
266{
267        if (!self->valid)
268        {
269                set_dberror(OperationalError, "connection has been closed.", NULL);
270                return 0;
271        }
272        return 1;
273}
274
275#ifdef LARGE_OBJECTS
276/* checks large object validity */
277static int
278check_lo_obj(pglargeobject *self, int level)
279{
280        if (!check_cnx_obj(self->pgcnx))
281                return 0;
282
283        if (!self->lo_oid)
284        {
285                set_dberror(IntegrityError, "object is not valid (null oid).", NULL);
286                return 0;
287        }
288
289        if (level & CHECK_OPEN)
290        {
291                if (self->lo_fd < 0)
292                {
293                        PyErr_SetString(PyExc_IOError, "object is not opened.");
294                        return 0;
295                }
296        }
297
298        if (level & CHECK_CLOSE)
299        {
300                if (self->lo_fd >= 0)
301                {
302                        PyErr_SetString(PyExc_IOError, "object is already opened.");
303                        return 0;
304                }
305        }
306
307        return 1;
308}
309#endif /* LARGE_OBJECTS */
310
311/* checks source object validity */
312static int
313check_source_obj(pgsourceobject *self, int level)
314{
315        if (!self->valid)
316        {
317                set_dberror(OperationalError, "object has been closed", NULL);
318                return 0;
319        }
320
321        if ((level & CHECK_RESULT) && !self->result)
322        {
323                set_dberror(DatabaseError, "no result.", NULL);
324                return 0;
325        }
326
327        if ((level & CHECK_DQL) && self->result_type != RESULT_DQL)
328        {
329                set_dberror(DatabaseError,
330                        "last query did not return tuples.", self->result);
331                return 0;
332        }
333
334        if ((level & CHECK_CNX) && !check_cnx_obj(self->pgcnx))
335                return 0;
336
337        return 1;
338}
339
340/* define internal types */
341
342#define PYGRES_INT 1
343#define PYGRES_LONG 2
344#define PYGRES_FLOAT 3
345#define PYGRES_DECIMAL 4
346#define PYGRES_MONEY 5
347#define PYGRES_BOOL 6
348#define PYGRES_DEFAULT 7
349
350/* shared functions for converting PG types to Python types */
351int *
352get_type_array(PGresult *result, int nfields)
353{
354        int *typ;
355        int j;
356
357        if (!(typ = malloc(sizeof(int) * nfields)))
358        {
359                PyErr_SetString(PyExc_MemoryError, "memory error in getresult().");
360                return NULL;
361        }
362
363        for (j = 0; j < nfields; j++)
364        {
365                switch (PQftype(result, j))
366                {
367                        case INT2OID:
368                        case INT4OID:
369                        case OIDOID:
370                                typ[j] = PYGRES_INT;
371                                break;
372
373                        case INT8OID:
374                                typ[j] = PYGRES_LONG;
375                                break;
376
377                        case FLOAT4OID:
378                        case FLOAT8OID:
379                                typ[j] = PYGRES_FLOAT;
380                                break;
381
382                        case NUMERICOID:
383                                typ[j] = PYGRES_DECIMAL;
384                                break;
385
386                        case CASHOID:
387                                typ[j] = PYGRES_MONEY;
388                                break;
389
390                        case BOOLOID:
391                                typ[j] = PYGRES_BOOL;
392                                break;
393
394                        default:
395                                typ[j] = PYGRES_DEFAULT;
396                                break;
397                }
398        }
399
400        return typ;
401}
402
403/* format result (mostly useful for debugging) */
404/* Note: This is similar to the Postgres function PQprint().
405 * PQprint() is not used because handing over a stream from Python to
406 * Postgres can be problematic if they use different libs for streams
407 * and because using PQprint() and tp_print is not recommended any more.
408 */
409
410static PyObject *
411format_result(const PGresult *res)
412{
413        const int n = PQnfields(res);
414
415        if (n > 0)
416        {
417                char * const aligns = (char *) malloc(n * sizeof(char));
418                int * const sizes = (int *) malloc(n * sizeof(int));
419
420                if (aligns && sizes)
421                {
422                        const int m = PQntuples(res);
423                        int i, j;
424                        size_t size;
425                        char *buffer;
426
427                        /* calculate sizes and alignments */
428                        for (j = 0; j < n; j++)
429                        {
430                                const char * const s = PQfname(res, j);
431                                const int format = PQfformat(res, j);
432
433                                sizes[j] = s ? (int)strlen(s) : 0;
434                                if (format)
435                                {
436                                        aligns[j] = '\0';
437                                        if (m && sizes[j] < 8)
438                                                /* "<binary>" must fit */
439                                                sizes[j] = 8;
440                                }
441                                else
442                                {
443                                        const Oid ftype = PQftype(res, j);
444
445                                        switch (ftype)
446                                        {
447                                                case INT2OID:
448                                                case INT4OID:
449                                                case INT8OID:
450                                                case FLOAT4OID:
451                                                case FLOAT8OID:
452                                                case NUMERICOID:
453                                                case OIDOID:
454                                                case XIDOID:
455                                                case CIDOID:
456                                                case CASHOID:
457                                                        aligns[j] = 'r';
458                                                        break;
459                                                default:
460                                                        aligns[j] = 'l';
461                                                        break;
462                                        }
463                                }
464                        }
465                        for (i = 0; i < m; i++)
466                        {
467                                for (j = 0; j < n; j++)
468                                {
469                                        if (aligns[j])
470                                        {
471                                                const int k = PQgetlength(res, i, j);
472
473                                                if (sizes[j] < k)
474                                                        /* value must fit */
475                                                        sizes[j] = k;
476                                        }
477                                }
478                        }
479                        size = 0;
480                        /* size of one row */
481                        for (j = 0; j < n; j++) size += sizes[j] + 1;
482                        /* times number of rows incl. heading */
483                        size *= (m + 2);
484                        /* plus size of footer */
485                        size += 40;
486                        /* is the buffer size that needs to be allocated */
487                        buffer = (char *) malloc(size);
488                        if (buffer)
489                        {
490                                char *p = buffer;
491                                PyObject *result;
492
493                                /* create the header */
494                                for (j = 0; j < n; j++)
495                                {
496                                        const char * const s = PQfname(res, j);
497                                        const int k = sizes[j];
498                                        const int h = (k - (int)strlen(s)) / 2;
499
500                                        sprintf(p, "%*s", h, "");
501                                        sprintf(p + h, "%-*s", k - h, s);
502                                        p += k;
503                                        if (j + 1 < n)
504                                                *p++ = '|';
505                                }
506                                *p++ = '\n';
507                                for (j = 0; j < n; j++)
508                                {
509                                        int k = sizes[j];
510
511                                        while (k--)
512                                                *p++ = '-';
513                                        if (j + 1 < n)
514                                                *p++ = '+';
515                                }
516                                *p++ = '\n';
517                                /* create the body */
518                                for (i = 0; i < m; i++)
519                                {
520                                        for (j = 0; j < n; j++)
521                                        {
522                                                const char align = aligns[j];
523                                                const int k = sizes[j];
524
525                                                if (align)
526                                                {
527                                                        sprintf(p, align == 'r' ?
528                                                                "%*s" : "%-*s", k,
529                                                                PQgetvalue(res, i, j));
530                                                }
531                                                else
532                                                {
533                                                        sprintf(p, "%-*s", k,
534                                                                PQgetisnull(res, i, j) ?
535                                                                "" : "<binary>");
536                                                }
537                                                p += k;
538                                                if (j + 1 < n)
539                                                        *p++ = '|';
540                                        }
541                                        *p++ = '\n';
542                                }
543                                /* free memory */
544                                free(aligns);
545                                free(sizes);
546                                /* create the footer */
547                                sprintf(p, "(%d row%s)", m, m == 1 ? "" : "s");
548                                /* return the result */
549                                result = PyString_FromString(buffer);
550                                free(buffer);
551                                return result;
552                        }
553                        else
554                        {
555                                PyErr_SetString(PyExc_MemoryError,
556                                        "Not enough memory for formatting the query result.");
557                                return NULL;
558                        }
559                } else {
560                        if (aligns)
561                                free(aligns);
562                        if (sizes)
563                                free(aligns);
564                        PyErr_SetString(PyExc_MemoryError,
565                                "Not enough memory for formatting the query result.");
566                        return NULL;
567                }
568        }
569        else
570                return PyString_FromString("(nothing selected)");
571}
572
573/* prototypes for constructors */
574static pgsourceobject *pgsource_new(pgobject *pgcnx);
575
576/* --------------------------------------------------------------------- */
577/* PG SOURCE OBJECT IMPLEMENTATION */
578
579/* constructor (internal use only) */
580static pgsourceobject *
581pgsource_new(pgobject *pgcnx)
582{
583        pgsourceobject *npgobj;
584
585        /* allocates new query object */
586        if (!(npgobj = PyObject_NEW(pgsourceobject, &PgSourceType)))
587                return NULL;
588
589        /* initializes internal parameters */
590        Py_XINCREF(pgcnx);
591        npgobj->pgcnx = pgcnx;
592        npgobj->result = NULL;
593        npgobj->valid = 1;
594        npgobj->arraysize = PG_ARRAYSIZE;
595
596        return npgobj;
597}
598
599/* destructor */
600static void
601pgsource_dealloc(pgsourceobject *self)
602{
603        if (self->result)
604                PQclear(self->result);
605
606        Py_XDECREF(self->pgcnx);
607        PyObject_Del(self);
608}
609
610/* closes object */
611static char pgsource_close__doc__[] =
612"close() -- close query object without deleting it. "
613"All instances of the query object can no longer be used after this call.";
614
615static PyObject *
616pgsource_close(pgsourceobject *self, PyObject *args)
617{
618        /* checks args */
619        if (!PyArg_ParseTuple(args, ""))
620        {
621                PyErr_SetString(PyExc_TypeError, "method close() takes no parameter.");
622                return NULL;
623        }
624
625        /* frees result if necessary and invalidates object */
626        if (self->result)
627        {
628                PQclear(self->result);
629                self->result_type = RESULT_EMPTY;
630                self->result = NULL;
631        }
632
633        self->valid = 0;
634
635        /* return None */
636        Py_INCREF(Py_None);
637        return Py_None;
638}
639
640/* database query */
641static char pgsource_execute__doc__[] =
642"execute(sql) -- execute a SQL statement (string).\n "
643"On success, this call returns the number of affected rows, "
644"or None for DQL (SELECT, ...) statements.\n"
645"The fetch (fetch(), fetchone() and fetchall()) methods can be used "
646"to get result rows.";
647
648static PyObject *
649pgsource_execute(pgsourceobject *self, PyObject *args)
650{
651        char            *query;
652
653        /* checks validity */
654        if (!check_source_obj(self, CHECK_CNX))
655                return NULL;
656
657        /* make sure that the connection object is valid */
658        if (!self->pgcnx->cnx)
659                return NULL;
660
661        /* get query args */
662        if (!PyArg_ParseTuple(args, "s", &query))
663        {
664                PyErr_SetString(PyExc_TypeError, "execute(sql), with sql (string).");
665                return NULL;
666        }
667
668        /* frees previous result */
669        if (self->result)
670        {
671                PQclear(self->result);
672                self->result = NULL;
673        }
674        self->max_row = 0;
675        self->current_row = 0;
676        self->num_fields = 0;
677
678        /* gets result */
679        Py_BEGIN_ALLOW_THREADS
680        self->result = PQexec(self->pgcnx->cnx, query);
681        Py_END_ALLOW_THREADS
682
683        /* checks result validity */
684        if (!self->result)
685        {
686                PyErr_SetString(PyExc_ValueError, PQerrorMessage(self->pgcnx->cnx));
687                return NULL;
688        }
689
690        /* checks result status */
691        switch (PQresultStatus(self->result))
692        {
693                long    num_rows;
694                char   *temp;
695
696                /* query succeeded */
697                case PGRES_TUPLES_OK:   /* DQL: returns None (DB-SIG compliant) */
698                        self->result_type = RESULT_DQL;
699                        self->max_row = PQntuples(self->result);
700                        self->num_fields = PQnfields(self->result);
701                        Py_INCREF(Py_None);
702                        return Py_None;
703                case PGRES_COMMAND_OK:  /* other requests */
704                case PGRES_COPY_OUT:
705                case PGRES_COPY_IN:
706                        self->result_type = RESULT_DDL;
707                        temp = PQcmdTuples(self->result);
708                        num_rows = -1;
709                        if (temp[0])
710                        {
711                                self->result_type = RESULT_DML;
712                                num_rows = atol(temp);
713                        }
714                        return PyInt_FromLong(num_rows);
715
716                /* query failed */
717                case PGRES_EMPTY_QUERY:
718                        PyErr_SetString(PyExc_ValueError, "empty query.");
719                        break;
720                case PGRES_BAD_RESPONSE:
721                case PGRES_FATAL_ERROR:
722                case PGRES_NONFATAL_ERROR:
723                        set_dberror(ProgrammingError,
724                                PQerrorMessage(self->pgcnx->cnx), self->result);
725                        break;
726                default:
727                        set_dberror(InternalError, "internal error: "
728                                "unknown result status.", self->result);
729                        break;
730        }
731
732        /* frees result and returns error */
733        PQclear(self->result);
734        self->result = NULL;
735        self->result_type = RESULT_EMPTY;
736        return NULL;
737}
738
739/* gets oid status for last query (valid for INSERTs, 0 for other) */
740static char pgsource_oidstatus__doc__[] =
741"oidstatus() -- return oid of last inserted row (if available).";
742
743static PyObject *
744pgsource_oidstatus(pgsourceobject *self, PyObject *args)
745{
746        Oid                     oid;
747
748        /* checks validity */
749        if (!check_source_obj(self, CHECK_RESULT))
750                return NULL;
751
752        /* checks args */
753        if (args && !PyArg_ParseTuple(args, ""))
754        {
755                PyErr_SetString(PyExc_TypeError,
756                        "method oidstatus() takes no parameters.");
757                return NULL;
758        }
759
760        /* retrieves oid status */
761        if ((oid = PQoidValue(self->result)) == InvalidOid)
762        {
763                Py_INCREF(Py_None);
764                return Py_None;
765        }
766
767        return PyInt_FromLong(oid);
768}
769
770/* fetches rows from last result */
771static char pgsource_fetch__doc__[] =
772"fetch(num) -- return the next num rows from the last result in a list. "
773"If num parameter is omitted arraysize attribute value is used. "
774"If size equals -1, all rows are fetched.";
775
776static PyObject *
777pgsource_fetch(pgsourceobject *self, PyObject *args)
778{
779        PyObject   *rowtuple,
780                           *reslist,
781                           *str;
782        int                     i,
783                                j;
784        long            size;
785
786        /* checks validity */
787        if (!check_source_obj(self, CHECK_RESULT | CHECK_DQL))
788                return NULL;
789
790        /* checks args */
791        size = self->arraysize;
792        if (!PyArg_ParseTuple(args, "|l", &size))
793        {
794                PyErr_SetString(PyExc_TypeError,
795                        "fetch(num), with num (integer, optional).");
796                return NULL;
797        }
798
799        /* seeks last line */
800        /* limit size to be within the amount of data we actually have */
801        if (size == -1 || (self->max_row - self->current_row) < size)
802                size = self->max_row - self->current_row;
803
804        /* allocate list for result */
805        if (!(reslist = PyList_New(0)))
806                return NULL;
807
808        /* builds result */
809        for (i = 0; i < size; i++)
810        {
811                if (!(rowtuple = PyTuple_New(self->num_fields)))
812                {
813                        Py_DECREF(reslist);
814                        return NULL;
815                }
816
817                for (j = 0; j < self->num_fields; j++)
818                {
819                        if (PQgetisnull(self->result, self->current_row, j))
820                        {
821                                Py_INCREF(Py_None);
822                                str = Py_None;
823                        }
824                        else
825                                str = PyString_FromString(PQgetvalue(self->result, self->current_row, j));
826
827                        PyTuple_SET_ITEM(rowtuple, j, str);
828                }
829
830                PyList_Append(reslist, rowtuple);
831                Py_DECREF(rowtuple);
832                self->current_row++;
833        }
834
835        return reslist;
836}
837
838/* changes current row (internal wrapper for all "move" methods) */
839static PyObject *
840pgsource_move(pgsourceobject *self, PyObject *args, int move)
841{
842        /* checks validity */
843        if (!check_source_obj(self, CHECK_RESULT | CHECK_DQL))
844                return NULL;
845
846        /* checks args */
847        if (!PyArg_ParseTuple(args, ""))
848        {
849                char            errbuf[256];
850                PyOS_snprintf(errbuf, sizeof(errbuf),
851                        "method %s() takes no parameter.", __movename[move]);
852                PyErr_SetString(PyExc_TypeError, errbuf);
853                return NULL;
854        }
855
856        /* changes the current row */
857        switch (move)
858        {
859                case QUERY_MOVEFIRST:
860                        self->current_row = 0;
861                        break;
862                case QUERY_MOVELAST:
863                        self->current_row = self->max_row - 1;
864                        break;
865                case QUERY_MOVENEXT:
866                        if (self->current_row != self->max_row)
867                                self->current_row++;
868                        break;
869                case QUERY_MOVEPREV:
870                        if (self->current_row > 0)
871                                self->current_row--;
872                        break;
873        }
874
875        Py_INCREF(Py_None);
876        return Py_None;
877}
878
879/* move to first result row */
880static char pgsource_movefirst__doc__[] =
881"movefirst() -- move to first result row.";
882
883static PyObject *
884pgsource_movefirst(pgsourceobject *self, PyObject *args)
885{
886        return pgsource_move(self, args, QUERY_MOVEFIRST);
887}
888
889/* move to last result row */
890static char pgsource_movelast__doc__[] =
891"movelast() -- move to last valid result row.";
892
893static PyObject *
894pgsource_movelast(pgsourceobject *self, PyObject *args)
895{
896        return pgsource_move(self, args, QUERY_MOVELAST);
897}
898
899/* move to next result row */
900static char pgsource_movenext__doc__[] =
901"movenext() -- move to next result row.";
902
903static PyObject *
904pgsource_movenext(pgsourceobject *self, PyObject *args)
905{
906        return pgsource_move(self, args, QUERY_MOVENEXT);
907}
908
909/* move to previous result row */
910static char pgsource_moveprev__doc__[] =
911"moveprev() -- move to previous result row.";
912
913static PyObject *
914pgsource_moveprev(pgsourceobject *self, PyObject *args)
915{
916        return pgsource_move(self, args, QUERY_MOVEPREV);
917}
918
919/* finds field number from string/integer (internal use only) */
920static int
921pgsource_fieldindex(pgsourceobject *self, PyObject *param, const char *usage)
922{
923        int                     num;
924
925        /* checks validity */
926        if (!check_source_obj(self, CHECK_RESULT | CHECK_DQL))
927                return -1;
928
929        /* gets field number */
930        if (PyString_Check(param))
931                num = PQfnumber(self->result, PyString_AsString(param));
932        else if (PyInt_Check(param))
933                num = PyInt_AsLong(param);
934        else
935        {
936                PyErr_SetString(PyExc_TypeError, usage);
937                return -1;
938        }
939
940        /* checks field validity */
941        if (num < 0 || num >= self->num_fields)
942        {
943                PyErr_SetString(PyExc_ValueError, "Unknown field.");
944                return -1;
945        }
946
947        return num;
948}
949
950/* builds field information from position (internal use only) */
951static PyObject *
952pgsource_buildinfo(pgsourceobject *self, int num)
953{
954        PyObject *result;
955
956        /* allocates tuple */
957        result = PyTuple_New(3);
958        if (!result)
959                return NULL;
960
961        /* affects field information */
962        PyTuple_SET_ITEM(result, 0, PyInt_FromLong(num));
963        PyTuple_SET_ITEM(result, 1,
964                PyString_FromString(PQfname(self->result, num)));
965        PyTuple_SET_ITEM(result, 2,
966                PyInt_FromLong(PQftype(self->result, num)));
967
968        return result;
969}
970
971/* lists fields info */
972static char pgsource_listinfo__doc__[] =
973"listinfo() -- return information for all fields "
974"(position, name, type oid).";
975
976static PyObject *
977pgsource_listinfo(pgsourceobject *self, PyObject *args)
978{
979        int                     i;
980        PyObject   *result,
981                           *info;
982
983        /* checks validity */
984        if (!check_source_obj(self, CHECK_RESULT | CHECK_DQL))
985                return NULL;
986
987        /* gets args */
988        if (!PyArg_ParseTuple(args, ""))
989        {
990                PyErr_SetString(PyExc_TypeError,
991                        "method listinfo() takes no parameter.");
992                return NULL;
993        }
994
995        /* builds result */
996        if (!(result = PyTuple_New(self->num_fields)))
997                return NULL;
998
999        for (i = 0; i < self->num_fields; i++)
1000        {
1001                info = pgsource_buildinfo(self, i);
1002                if (!info)
1003                {
1004                        Py_DECREF(result);
1005                        return NULL;
1006                }
1007                PyTuple_SET_ITEM(result, i, info);
1008        }
1009
1010        /* returns result */
1011        return result;
1012};
1013
1014/* list fields information for last result */
1015static char pgsource_fieldinfo__doc__[] =
1016"fieldinfo(string|integer) -- return specified field information "
1017"(position, name, type oid).";
1018
1019static PyObject *
1020pgsource_fieldinfo(pgsourceobject *self, PyObject *args)
1021{
1022        static const char short_usage[] =
1023        "fieldinfo(desc), with desc (string|integer).";
1024        int                     num;
1025        PyObject   *param;
1026
1027        /* gets args */
1028        if (!PyArg_ParseTuple(args, "O", &param))
1029        {
1030                PyErr_SetString(PyExc_TypeError, short_usage);
1031                return NULL;
1032        }
1033
1034        /* checks args and validity */
1035        if ((num = pgsource_fieldindex(self, param, short_usage)) == -1)
1036                return NULL;
1037
1038        /* returns result */
1039        return pgsource_buildinfo(self, num);
1040};
1041
1042/* retrieve field value */
1043static char pgsource_field__doc__[] =
1044"field(string|integer) -- return specified field value.";
1045
1046static PyObject *
1047pgsource_field(pgsourceobject *self, PyObject *args)
1048{
1049        static const char short_usage[] =
1050        "field(desc), with desc (string|integer).";
1051        int                     num;
1052        PyObject   *param;
1053
1054        /* gets args */
1055        if (!PyArg_ParseTuple(args, "O", &param))
1056        {
1057                PyErr_SetString(PyExc_TypeError, short_usage);
1058                return NULL;
1059        }
1060
1061        /* checks args and validity */
1062        if ((num = pgsource_fieldindex(self, param, short_usage)) == -1)
1063                return NULL;
1064
1065        return PyString_FromString(PQgetvalue(self->result,
1066                                                                        self->current_row, num));
1067}
1068
1069/* query object methods */
1070static PyMethodDef pgsource_methods[] = {
1071        {"close", (PyCFunction) pgsource_close, METH_VARARGS,
1072                        pgsource_close__doc__},
1073        {"execute", (PyCFunction) pgsource_execute, METH_VARARGS,
1074                        pgsource_execute__doc__},
1075        {"oidstatus", (PyCFunction) pgsource_oidstatus, METH_VARARGS,
1076                        pgsource_oidstatus__doc__},
1077        {"fetch", (PyCFunction) pgsource_fetch, METH_VARARGS,
1078                        pgsource_fetch__doc__},
1079        {"movefirst", (PyCFunction) pgsource_movefirst, METH_VARARGS,
1080                        pgsource_movefirst__doc__},
1081        {"movelast", (PyCFunction) pgsource_movelast, METH_VARARGS,
1082                        pgsource_movelast__doc__},
1083        {"movenext", (PyCFunction) pgsource_movenext, METH_VARARGS,
1084                        pgsource_movenext__doc__},
1085        {"moveprev", (PyCFunction) pgsource_moveprev, METH_VARARGS,
1086                        pgsource_moveprev__doc__},
1087        {"field", (PyCFunction) pgsource_field, METH_VARARGS,
1088                        pgsource_field__doc__},
1089        {"fieldinfo", (PyCFunction) pgsource_fieldinfo, METH_VARARGS,
1090                        pgsource_fieldinfo__doc__},
1091        {"listinfo", (PyCFunction) pgsource_listinfo, METH_VARARGS,
1092                        pgsource_listinfo__doc__},
1093        {NULL, NULL}
1094};
1095
1096/* gets query object attributes */
1097static PyObject *
1098pgsource_getattr(pgsourceobject *self, char *name)
1099{
1100        /* pg connection object */
1101        if (!strcmp(name, "pgcnx"))
1102        {
1103                if (check_source_obj(self, 0))
1104                {
1105                        Py_INCREF(self->pgcnx);
1106                        return (PyObject *) (self->pgcnx);
1107                }
1108                Py_INCREF(Py_None);
1109                return Py_None;
1110        }
1111
1112        /* arraysize */
1113        if (!strcmp(name, "arraysize"))
1114                return PyInt_FromLong(self->arraysize);
1115
1116        /* resulttype */
1117        if (!strcmp(name, "resulttype"))
1118                return PyInt_FromLong(self->result_type);
1119
1120        /* ntuples */
1121        if (!strcmp(name, "ntuples"))
1122                return PyInt_FromLong(self->max_row);
1123
1124        /* nfields */
1125        if (!strcmp(name, "nfields"))
1126                return PyInt_FromLong(self->num_fields);
1127
1128        /* attributes list */
1129        if (!strcmp(name, "__members__"))
1130        {
1131                PyObject *list = PyList_New(5);
1132
1133                PyList_SET_ITEM(list, 0, PyString_FromString("pgcnx"));
1134                PyList_SET_ITEM(list, 1, PyString_FromString("arraysize"));
1135                PyList_SET_ITEM(list, 2, PyString_FromString("resulttype"));
1136                PyList_SET_ITEM(list, 3, PyString_FromString("ntuples"));
1137                PyList_SET_ITEM(list, 4, PyString_FromString("nfields"));
1138
1139                return list;
1140        }
1141
1142        /* module name */
1143        if (!strcmp(name, "__module__"))
1144                return PyString_FromString(MODULE_NAME);
1145
1146        /* class name */
1147        if (!strcmp(name, "__class__"))
1148                return PyString_FromString("pgsource");
1149
1150        /* seeks name in methods (fallback) */
1151        return Py_FindMethod(pgsource_methods, (PyObject *) self, name);
1152}
1153
1154/* sets query object attributes */
1155static int
1156pgsource_setattr(pgsourceobject *self, char *name, PyObject *v)
1157{
1158        /* arraysize */
1159        if (!strcmp(name, "arraysize"))
1160        {
1161                if (!PyInt_Check(v))
1162                {
1163                        PyErr_SetString(PyExc_TypeError, "arraysize must be integer.");
1164                        return -1;
1165                }
1166
1167                self->arraysize = PyInt_AsLong(v);
1168                return 0;
1169        }
1170
1171        /* unknown attribute */
1172        PyErr_SetString(PyExc_TypeError, "not a writable attribute.");
1173        return -1;
1174}
1175
1176static PyObject *
1177pgsource_repr(pgsourceobject *self)
1178{
1179        return PyString_FromString("<pg source object>");
1180}
1181
1182/* returns source object as string in human readable format */
1183
1184static PyObject *
1185pgsource_str(pgsourceobject *self)
1186{
1187        switch (self->result_type)
1188        {
1189                case RESULT_DQL:
1190                        return format_result(self->result);
1191                case RESULT_DDL:
1192                case RESULT_DML:
1193                        return PyString_FromString(PQcmdStatus(self->result));
1194                case RESULT_EMPTY:
1195                default:
1196                        return PyString_FromString("(empty PostgreSQL source object)");
1197        }
1198}
1199
1200/* query type definition */
1201staticforward PyTypeObject PgSourceType = {
1202        PyObject_HEAD_INIT(NULL)
1203        0,                                                              /* ob_size */
1204        "pgsourceobject",                               /* tp_name */
1205        sizeof(pgsourceobject),                 /* tp_basicsize */
1206        0,                                                              /* tp_itemsize */
1207        /* methods */
1208        (destructor) pgsource_dealloc,  /* tp_dealloc */
1209        0,                                                              /* tp_print */
1210        (getattrfunc) pgsource_getattr, /* tp_getattr */
1211        (setattrfunc) pgsource_setattr, /* tp_setattr */
1212        0,                                                              /* tp_compare */
1213        (reprfunc) pgsource_repr,               /* tp_repr */
1214        0,                                                              /* tp_as_number */
1215        0,                                                              /* tp_as_sequence */
1216        0,                                                              /* tp_as_mapping */
1217        0,                                                              /* tp_hash */
1218        0,                                                              /* tp_call */
1219        (reprfunc) pgsource_str,                /* tp_str */
1220};
1221
1222/* --------------------------------------------------------------------- */
1223/* PG "LARGE" OBJECT IMPLEMENTATION */
1224
1225#ifdef LARGE_OBJECTS
1226
1227/* constructor (internal use only) */
1228static pglargeobject *
1229pglarge_new(pgobject *pgcnx, Oid oid)
1230{
1231        pglargeobject *npglo;
1232
1233        if (!(npglo = PyObject_NEW(pglargeobject, &PglargeType)))
1234                return NULL;
1235
1236        Py_XINCREF(pgcnx);
1237        npglo->pgcnx = pgcnx;
1238        npglo->lo_fd = -1;
1239        npglo->lo_oid = oid;
1240
1241        return npglo;
1242}
1243
1244/* destructor */
1245static void
1246pglarge_dealloc(pglargeobject *self)
1247{
1248        if (self->lo_fd >= 0 && self->pgcnx->valid)
1249                lo_close(self->pgcnx->cnx, self->lo_fd);
1250
1251        Py_XDECREF(self->pgcnx);
1252        PyObject_Del(self);
1253}
1254
1255/* opens large object */
1256static char pglarge_open__doc__[] =
1257"open(mode) -- open access to large object with specified mode "
1258"(INV_READ, INV_WRITE constants defined by module).";
1259
1260static PyObject *
1261pglarge_open(pglargeobject *self, PyObject *args)
1262{
1263        int                     mode,
1264                                fd;
1265
1266        /* gets arguments */
1267        if (!PyArg_ParseTuple(args, "i", &mode))
1268        {
1269                PyErr_SetString(PyExc_TypeError, "open(mode), with mode(integer).");
1270                return NULL;
1271        }
1272
1273        /* check validity */
1274        if (!check_lo_obj(self, CHECK_CLOSE))
1275                return NULL;
1276
1277        /* opens large object */
1278        if ((fd = lo_open(self->pgcnx->cnx, self->lo_oid, mode)) < 0)
1279        {
1280                PyErr_SetString(PyExc_IOError, "can't open large object.");
1281                return NULL;
1282        }
1283        self->lo_fd = fd;
1284
1285        /* no error : returns Py_None */
1286        Py_INCREF(Py_None);
1287        return Py_None;
1288}
1289
1290/* close large object */
1291static char pglarge_close__doc__[] =
1292"close() -- close access to large object data.";
1293
1294static PyObject *
1295pglarge_close(pglargeobject *self, PyObject *args)
1296{
1297        /* checks args */
1298        if (!PyArg_ParseTuple(args, ""))
1299        {
1300                PyErr_SetString(PyExc_TypeError,
1301                        "method close() takes no parameters.");
1302                return NULL;
1303        }
1304
1305        /* checks validity */
1306        if (!check_lo_obj(self, CHECK_OPEN))
1307                return NULL;
1308
1309        /* closes large object */
1310        if (lo_close(self->pgcnx->cnx, self->lo_fd))
1311        {
1312                PyErr_SetString(PyExc_IOError, "error while closing large object fd.");
1313                return NULL;
1314        }
1315        self->lo_fd = -1;
1316
1317        /* no error : returns Py_None */
1318        Py_INCREF(Py_None);
1319        return Py_None;
1320}
1321
1322/* reads from large object */
1323static char pglarge_read__doc__[] =
1324"read(integer) -- read from large object to sized string. "
1325"Object must be opened in read mode before calling this method.";
1326
1327static PyObject *
1328pglarge_read(pglargeobject *self, PyObject *args)
1329{
1330        int                     size;
1331        PyObject   *buffer;
1332
1333        /* gets arguments */
1334        if (!PyArg_ParseTuple(args, "i", &size))
1335        {
1336                PyErr_SetString(PyExc_TypeError, "read(size), with size (integer).");
1337                return NULL;
1338        }
1339
1340        if (size <= 0)
1341        {
1342                PyErr_SetString(PyExc_ValueError, "size must be positive.");
1343                return NULL;
1344        }
1345
1346        /* checks validity */
1347        if (!check_lo_obj(self, CHECK_OPEN))
1348                return NULL;
1349
1350        /* allocate buffer and runs read */
1351        buffer = PyString_FromStringAndSize((char *) NULL, size);
1352
1353        if ((size = lo_read(self->pgcnx->cnx, self->lo_fd, BUF(buffer), size)) < 0)
1354        {
1355                PyErr_SetString(PyExc_IOError, "error while reading.");
1356                Py_XDECREF(buffer);
1357                return NULL;
1358        }
1359
1360        /* resize buffer and returns it */
1361        _PyString_Resize(&buffer, size);
1362        return buffer;
1363}
1364
1365/* write to large object */
1366static char pglarge_write__doc__[] =
1367"write(string) -- write sized string to large object. "
1368"Object must be opened in read mode before calling this method.";
1369
1370static PyObject *
1371pglarge_write(pglargeobject *self, PyObject *args)
1372{
1373        char       *buffer;
1374        int                     size,
1375                                bufsize;
1376
1377        /* gets arguments */
1378        if (!PyArg_ParseTuple(args, "s#", &buffer, &bufsize))
1379        {
1380                PyErr_SetString(PyExc_TypeError,
1381                        "write(buffer), with buffer (sized string).");
1382                return NULL;
1383        }
1384
1385        /* checks validity */
1386        if (!check_lo_obj(self, CHECK_OPEN))
1387                return NULL;
1388
1389        /* sends query */
1390        if ((size = lo_write(self->pgcnx->cnx, self->lo_fd, buffer,
1391                                                 bufsize)) < bufsize)
1392        {
1393                PyErr_SetString(PyExc_IOError, "buffer truncated during write.");
1394                return NULL;
1395        }
1396
1397        /* no error : returns Py_None */
1398        Py_INCREF(Py_None);
1399        return Py_None;
1400}
1401
1402/* go to position in large object */
1403static char pglarge_seek__doc__[] =
1404"seek(off, whence) -- move to specified position. Object must be opened "
1405"before calling this method. whence can be SEEK_SET, SEEK_CUR or SEEK_END, "
1406"constants defined by module.";
1407
1408static PyObject *
1409pglarge_lseek(pglargeobject *self, PyObject *args)
1410{
1411        /* offset and whence are initialized to keep compiler happy */
1412        int                     ret,
1413                                offset = 0,
1414                                whence = 0;
1415
1416        /* gets arguments */
1417        if (!PyArg_ParseTuple(args, "ii", &offset, &whence))
1418        {
1419                PyErr_SetString(PyExc_TypeError,
1420                        "lseek(offset, whence), with offset and whence (integers).");
1421                return NULL;
1422        }
1423
1424        /* checks validity */
1425        if (!check_lo_obj(self, CHECK_OPEN))
1426                return NULL;
1427
1428        /* sends query */
1429        if ((ret = lo_lseek(self->pgcnx->cnx, self->lo_fd, offset, whence)) == -1)
1430        {
1431                PyErr_SetString(PyExc_IOError, "error while moving cursor.");
1432                return NULL;
1433        }
1434
1435        /* returns position */
1436        return PyInt_FromLong(ret);
1437}
1438
1439/* gets large object size */
1440static char pglarge_size__doc__[] =
1441"size() -- return large object size. "
1442"Object must be opened before calling this method.";
1443
1444static PyObject *
1445pglarge_size(pglargeobject *self, PyObject *args)
1446{
1447        int                     start,
1448                                end;
1449
1450        /* checks args */
1451        if (!PyArg_ParseTuple(args, ""))
1452        {
1453                PyErr_SetString(PyExc_TypeError,
1454                        "method size() takes no parameters.");
1455                return NULL;
1456        }
1457
1458        /* checks validity */
1459        if (!check_lo_obj(self, CHECK_OPEN))
1460                return NULL;
1461
1462        /* gets current position */
1463        if ((start = lo_tell(self->pgcnx->cnx, self->lo_fd)) == -1)
1464        {
1465                PyErr_SetString(PyExc_IOError, "error while getting current position.");
1466                return NULL;
1467        }
1468
1469        /* gets end position */
1470        if ((end = lo_lseek(self->pgcnx->cnx, self->lo_fd, 0, SEEK_END)) == -1)
1471        {
1472                PyErr_SetString(PyExc_IOError, "error while getting end position.");
1473                return NULL;
1474        }
1475
1476        /* move back to start position */
1477        if ((start = lo_lseek(self->pgcnx->cnx, self->lo_fd, start, SEEK_SET)) == -1)
1478        {
1479                PyErr_SetString(PyExc_IOError,
1480                        "error while moving back to first position.");
1481                return NULL;
1482        }
1483
1484        /* returns size */
1485        return PyInt_FromLong(end);
1486}
1487
1488/* gets large object cursor position */
1489static char pglarge_tell__doc__[] =
1490"tell() -- give current position in large object. "
1491"Object must be opened before calling this method.";
1492
1493static PyObject *
1494pglarge_tell(pglargeobject *self, PyObject *args)
1495{
1496        int                     start;
1497
1498        /* checks args */
1499        if (!PyArg_ParseTuple(args, ""))
1500        {
1501                PyErr_SetString(PyExc_TypeError,
1502                        "method tell() takes no parameters.");
1503                return NULL;
1504        }
1505
1506        /* checks validity */
1507        if (!check_lo_obj(self, CHECK_OPEN))
1508                return NULL;
1509
1510        /* gets current position */
1511        if ((start = lo_tell(self->pgcnx->cnx, self->lo_fd)) == -1)
1512        {
1513                PyErr_SetString(PyExc_IOError, "error while getting position.");
1514                return NULL;
1515        }
1516
1517        /* returns size */
1518        return PyInt_FromLong(start);
1519}
1520
1521/* exports large object as unix file */
1522static char pglarge_export__doc__[] =
1523"export(string) -- export large object data to specified file. "
1524"Object must be closed when calling this method.";
1525
1526static PyObject *
1527pglarge_export(pglargeobject *self, PyObject *args)
1528{
1529        char *name;
1530
1531        /* checks validity */
1532        if (!check_lo_obj(self, CHECK_CLOSE))
1533                return NULL;
1534
1535        /* gets arguments */
1536        if (!PyArg_ParseTuple(args, "s", &name))
1537        {
1538                PyErr_SetString(PyExc_TypeError,
1539                        "export(filename), with filename (string).");
1540                return NULL;
1541        }
1542
1543        /* runs command */
1544        if (!lo_export(self->pgcnx->cnx, self->lo_oid, name))
1545        {
1546                PyErr_SetString(PyExc_IOError, "error while exporting large object.");
1547                return NULL;
1548        }
1549
1550        Py_INCREF(Py_None);
1551        return Py_None;
1552}
1553
1554/* deletes a large object */
1555static char pglarge_unlink__doc__[] =
1556"unlink() -- destroy large object. "
1557"Object must be closed when calling this method.";
1558
1559static PyObject *
1560pglarge_unlink(pglargeobject *self, PyObject *args)
1561{
1562        /* checks args */
1563        if (!PyArg_ParseTuple(args, ""))
1564        {
1565                PyErr_SetString(PyExc_TypeError,
1566                        "method unlink() takes no parameters.");
1567                return NULL;
1568        }
1569
1570        /* checks validity */
1571        if (!check_lo_obj(self, CHECK_CLOSE))
1572                return NULL;
1573
1574        /* deletes the object, invalidate it on success */
1575        if (!lo_unlink(self->pgcnx->cnx, self->lo_oid))
1576        {
1577                PyErr_SetString(PyExc_IOError, "error while unlinking large object");
1578                return NULL;
1579        }
1580        self->lo_oid = 0;
1581
1582        Py_INCREF(Py_None);
1583        return Py_None;
1584}
1585
1586
1587/* large object methods */
1588static struct PyMethodDef pglarge_methods[] = {
1589        {"open", (PyCFunction) pglarge_open, METH_VARARGS, pglarge_open__doc__},
1590        {"close", (PyCFunction) pglarge_close, METH_VARARGS, pglarge_close__doc__},
1591        {"read", (PyCFunction) pglarge_read, METH_VARARGS, pglarge_read__doc__},
1592        {"write", (PyCFunction) pglarge_write, METH_VARARGS, pglarge_write__doc__},
1593        {"seek", (PyCFunction) pglarge_lseek, METH_VARARGS, pglarge_seek__doc__},
1594        {"size", (PyCFunction) pglarge_size, METH_VARARGS, pglarge_size__doc__},
1595        {"tell", (PyCFunction) pglarge_tell, METH_VARARGS, pglarge_tell__doc__},
1596        {"export",(PyCFunction) pglarge_export,METH_VARARGS,pglarge_export__doc__},
1597        {"unlink",(PyCFunction) pglarge_unlink,METH_VARARGS,pglarge_unlink__doc__},
1598        {NULL, NULL}
1599};
1600
1601/* get attribute */
1602static PyObject *
1603pglarge_getattr(pglargeobject *self, char *name)
1604{
1605        /* list postgreSQL large object fields */
1606
1607        /* associated pg connection object */
1608        if (!strcmp(name, "pgcnx"))
1609        {
1610                if (check_lo_obj(self, 0))
1611                {
1612                        Py_INCREF(self->pgcnx);
1613                        return (PyObject *) (self->pgcnx);
1614                }
1615                PyErr_Clear();
1616                Py_INCREF(Py_None);
1617                return Py_None;
1618        }
1619
1620        /* large object oid */
1621        if (!strcmp(name, "oid"))
1622        {
1623                if (check_lo_obj(self, 0))
1624                        return PyInt_FromLong(self->lo_oid);
1625                PyErr_Clear();
1626                Py_INCREF(Py_None);
1627                return Py_None;
1628        }
1629
1630        /* error (status) message */
1631        if (!strcmp(name, "error"))
1632                return PyString_FromString(PQerrorMessage(self->pgcnx->cnx));
1633
1634        /* attributes list */
1635        if (!strcmp(name, "__members__"))
1636        {
1637                PyObject *list = PyList_New(3);
1638
1639                if (list)
1640                {
1641                        PyList_SET_ITEM(list, 0, PyString_FromString("oid"));
1642                        PyList_SET_ITEM(list, 1, PyString_FromString("pgcnx"));
1643                        PyList_SET_ITEM(list, 2, PyString_FromString("error"));
1644                }
1645
1646                return list;
1647        }
1648
1649        /* module name */
1650        if (!strcmp(name, "__module__"))
1651                return PyString_FromString(MODULE_NAME);
1652
1653        /* class name */
1654        if (!strcmp(name, "__class__"))
1655                return PyString_FromString("pglarge");
1656
1657        /* seeks name in methods (fallback) */
1658        return Py_FindMethod(pglarge_methods, (PyObject *) self, name);
1659}
1660
1661/* prints query object in human readable format */
1662static int
1663pglarge_print(pglargeobject *self, FILE *fp, int flags)
1664{
1665        char            print_buffer[128];
1666        PyOS_snprintf(print_buffer, sizeof(print_buffer),
1667                self->lo_fd >= 0 ?
1668                        "Opened large object, oid %ld" :
1669                        "Closed large object, oid %ld", (long) self->lo_oid);
1670        fputs(print_buffer, fp);
1671        return 0;
1672}
1673
1674/* object type definition */
1675staticforward PyTypeObject PglargeType = {
1676        PyObject_HEAD_INIT(NULL)
1677        0,                                                      /* ob_size */
1678        "pglarge",                                      /* tp_name */
1679        sizeof(pglargeobject),          /* tp_basicsize */
1680        0,                                                      /* tp_itemsize */
1681
1682        /* methods */
1683        (destructor) pglarge_dealloc,           /* tp_dealloc */
1684        (printfunc) pglarge_print,      /* tp_print */
1685        (getattrfunc) pglarge_getattr,          /* tp_getattr */
1686        0,                                                      /* tp_setattr */
1687        0,                                                      /* tp_compare */
1688        0,                                                      /* tp_repr */
1689        0,                                                      /* tp_as_number */
1690        0,                                                      /* tp_as_sequence */
1691        0,                                                      /* tp_as_mapping */
1692        0,                                                      /* tp_hash */
1693};
1694#endif /* LARGE_OBJECTS */
1695
1696
1697/* --------------------------------------------------------------------- */
1698/* PG QUERY OBJECT IMPLEMENTATION */
1699
1700/* connects to a database */
1701static char connect__doc__[] =
1702"connect(dbname, host, port, opt, tty) -- connect to a PostgreSQL database "
1703"using specified parameters (optionals, keywords aware).";
1704
1705static PyObject *
1706pgconnect(pgobject *self, PyObject *args, PyObject *dict)
1707{
1708        static const char *kwlist[] = {"dbname", "host", "port", "opt",
1709        "tty", "user", "passwd", NULL};
1710
1711        char       *pghost,
1712                           *pgopt,
1713                           *pgtty,
1714                           *pgdbname,
1715                           *pguser,
1716                           *pgpasswd;
1717        int                     pgport;
1718        char            port_buffer[20];
1719        pgobject   *npgobj;
1720
1721        pghost = pgopt = pgtty = pgdbname = pguser = pgpasswd = NULL;
1722        pgport = -1;
1723
1724        /*
1725         * parses standard arguments With the right compiler warnings, this
1726         * will issue a diagnostic. There is really no way around it.  If I
1727         * don't declare kwlist as const char *kwlist[] then it complains when
1728         * I try to assign all those constant strings to it.
1729         */
1730        if (!PyArg_ParseTupleAndKeywords(args, dict, "|zzizzzz", (char **) kwlist,
1731                &pgdbname, &pghost, &pgport, &pgopt, &pgtty, &pguser, &pgpasswd))
1732                return NULL;
1733
1734#ifdef DEFAULT_VARS
1735        /* handles defaults variables (for uninitialised vars) */
1736        if ((!pghost) && (pg_default_host != Py_None))
1737                pghost = PyString_AsString(pg_default_host);
1738
1739        if ((pgport == -1) && (pg_default_port != Py_None))
1740                pgport = PyInt_AsLong(pg_default_port);
1741
1742        if ((!pgopt) && (pg_default_opt != Py_None))
1743                pgopt = PyString_AsString(pg_default_opt);
1744
1745        if ((!pgtty) && (pg_default_tty != Py_None))
1746                pgtty = PyString_AsString(pg_default_tty);
1747
1748        if ((!pgdbname) && (pg_default_base != Py_None))
1749                pgdbname = PyString_AsString(pg_default_base);
1750
1751        if ((!pguser) && (pg_default_user != Py_None))
1752                pguser = PyString_AsString(pg_default_user);
1753
1754        if ((!pgpasswd) && (pg_default_passwd != Py_None))
1755                pgpasswd = PyString_AsString(pg_default_passwd);
1756#endif /* DEFAULT_VARS */
1757
1758        if (!(npgobj = (pgobject *) pgobject_New()))
1759                return NULL;
1760
1761        if (pgport != -1)
1762        {
1763                memset(port_buffer, 0, sizeof(port_buffer));
1764                sprintf(port_buffer, "%d", pgport);
1765        }
1766
1767#ifdef PQsetdbLoginIsThreadSafe
1768        Py_BEGIN_ALLOW_THREADS
1769#endif
1770        npgobj->cnx = PQsetdbLogin(pghost, pgport == -1 ? NULL : port_buffer,
1771                pgopt, pgtty, pgdbname, pguser, pgpasswd);
1772#ifdef PQsetdbLoginIsThreadSafe
1773        Py_END_ALLOW_THREADS
1774#endif
1775
1776        if (PQstatus(npgobj->cnx) == CONNECTION_BAD)
1777        {
1778                set_dberror(InternalError, PQerrorMessage(npgobj->cnx), NULL);
1779                Py_XDECREF(npgobj);
1780                return NULL;
1781        }
1782
1783        return (PyObject *) npgobj;
1784}
1785
1786/* internal wrapper for the notice receiver callback */
1787void notice_receiver(void *arg, const PGresult *res)
1788{
1789        PyGILState_STATE gstate = PyGILState_Ensure();
1790        pgobject *self = (pgobject*) arg;
1791        PyObject *proc = self->notice_receiver;
1792        if (proc && PyCallable_Check(proc))
1793        {
1794                pgnoticeobject *notice = PyObject_NEW(pgnoticeobject, &PgNoticeType);
1795                PyObject *args, *ret;
1796                if (notice)
1797                {
1798                        notice->pgcnx = arg;
1799                        notice->res = res;
1800                }
1801                else
1802                {
1803                        Py_INCREF(Py_None);
1804                        notice = (pgnoticeobject *)(void *)Py_None;
1805                }
1806                args = Py_BuildValue("(O)", notice);
1807                ret = PyObject_CallObject(proc, args);
1808                Py_XDECREF(ret);
1809                Py_DECREF(args);
1810        }
1811        PyGILState_Release(gstate);
1812}
1813
1814/* pgobject methods */
1815
1816/* destructor */
1817static void
1818pg_dealloc(pgobject *self)
1819{
1820        if (self->cnx)
1821        {
1822                Py_BEGIN_ALLOW_THREADS
1823                PQfinish(self->cnx);
1824                Py_END_ALLOW_THREADS
1825        }
1826        if (self->notice_receiver)
1827        {
1828                Py_DECREF(self->notice_receiver);
1829        }
1830        PyObject_Del(self);
1831}
1832
1833/* close without deleting */
1834static char pg_close__doc__[] =
1835"close() -- close connection. All instances of the connection object and "
1836"derived objects (queries and large objects) can no longer be used after "
1837"this call.";
1838
1839static PyObject *
1840pg_close(pgobject *self, PyObject *args)
1841{
1842        /* gets args */
1843        if (!PyArg_ParseTuple(args, ""))
1844        {
1845                PyErr_SetString(PyExc_TypeError, "close().");
1846                return NULL;
1847        }
1848
1849        /* connection object cannot already be closed */
1850        if (!self->cnx)
1851        {
1852                set_dberror(InternalError, "Connection already closed", NULL);
1853                return NULL;
1854        }
1855
1856        Py_BEGIN_ALLOW_THREADS
1857        PQfinish(self->cnx);
1858        Py_END_ALLOW_THREADS
1859
1860        self->cnx = NULL;
1861        Py_INCREF(Py_None);
1862        return Py_None;
1863}
1864
1865static void
1866pgquery_dealloc(pgqueryobject *self)
1867{
1868        if (self->result)
1869                PQclear(self->result);
1870
1871        PyObject_Del(self);
1872}
1873
1874/* resets connection */
1875static char pg_reset__doc__[] =
1876"reset() -- reset connection with current parameters. All derived queries "
1877"and large objects derived from this connection will not be usable after "
1878"this call.";
1879
1880static PyObject *
1881pg_reset(pgobject *self, PyObject *args)
1882{
1883        if (!self->cnx)
1884        {
1885                PyErr_SetString(PyExc_TypeError, "Connection is not valid.");
1886                return NULL;
1887        }
1888
1889        /* checks args */
1890        if (!PyArg_ParseTuple(args, ""))
1891        {
1892                PyErr_SetString(PyExc_TypeError,
1893                        "method reset() takes no parameters.");
1894                return NULL;
1895        }
1896
1897        /* resets the connection */
1898        PQreset(self->cnx);
1899        Py_INCREF(Py_None);
1900        return Py_None;
1901}
1902
1903/* cancels current command */
1904static char pg_cancel__doc__[] =
1905"cancel() -- abandon processing of the current command.";
1906
1907static PyObject *
1908pg_cancel(pgobject *self, PyObject *args)
1909{
1910        if (!self->cnx)
1911        {
1912                PyErr_SetString(PyExc_TypeError, "Connection is not valid.");
1913                return NULL;
1914        }
1915
1916        /* checks args */
1917        if (!PyArg_ParseTuple(args, ""))
1918        {
1919                PyErr_SetString(PyExc_TypeError,
1920                        "method cancel() takes no parameters.");
1921                return NULL;
1922        }
1923
1924        /* request that the server abandon processing of the current command */
1925        return PyInt_FromLong((long) PQrequestCancel(self->cnx));
1926}
1927
1928/* get connection socket */
1929static char pg_fileno__doc__[] =
1930"fileno() -- return database connection socket file handle.";
1931
1932static PyObject *
1933pg_fileno(pgobject *self, PyObject *args)
1934{
1935        if (!self->cnx)
1936        {
1937                PyErr_SetString(PyExc_TypeError, "Connection is not valid.");
1938                return NULL;
1939        }
1940
1941        /* checks args */
1942        if (!PyArg_ParseTuple(args, ""))
1943        {
1944                PyErr_SetString(PyExc_TypeError,
1945                        "method fileno() takes no parameters.");
1946                return NULL;
1947        }
1948
1949#ifdef NO_PQSOCKET
1950        return PyInt_FromLong((long) self->cnx->sock);
1951#else
1952        return PyInt_FromLong((long) PQsocket(self->cnx));
1953#endif
1954}
1955
1956/* set notice receiver callback function */
1957static char pg_set_notice_receiver__doc__[] =
1958"set_notice_receiver() -- set the current notice receiver.";
1959
1960static PyObject *
1961pg_set_notice_receiver(pgobject * self, PyObject * args)
1962{
1963        PyObject *ret = NULL;
1964        PyObject *proc;
1965
1966        if (PyArg_ParseTuple(args, "O", &proc))
1967        {
1968                if (PyCallable_Check(proc))
1969                {
1970                        Py_XINCREF(proc);
1971                        self->notice_receiver = proc;
1972                        PQsetNoticeReceiver(self->cnx, notice_receiver, self);
1973                        Py_INCREF(Py_None); ret = Py_None;
1974                }
1975                else
1976                        PyErr_SetString(PyExc_TypeError, "notice receiver must be callable");
1977        }
1978        return ret;
1979}
1980
1981/* get notice receiver callback function */
1982static char pg_get_notice_receiver__doc__[] =
1983"get_notice_receiver() -- get the current notice receiver.";
1984
1985static PyObject *
1986pg_get_notice_receiver(pgobject * self, PyObject * args)
1987{
1988        PyObject *ret = NULL;
1989
1990        if (PyArg_ParseTuple(args, ""))
1991        {
1992                ret = self->notice_receiver;
1993                if (!ret)
1994                        ret = Py_None;
1995                Py_INCREF(ret);
1996        }
1997        else
1998        {
1999                PyErr_SetString(PyExc_TypeError,
2000                        "method get_notice_receiver() takes no parameters.");
2001        }
2002        return ret;
2003}
2004
2005/* get number of rows */
2006static char pgquery_ntuples__doc__[] =
2007"ntuples() -- returns number of tuples returned by query.";
2008
2009static PyObject *
2010pgquery_ntuples(pgqueryobject *self, PyObject *args)
2011{
2012        /* checks args */
2013        if (!PyArg_ParseTuple(args, ""))
2014        {
2015                PyErr_SetString(PyExc_TypeError,
2016                        "method ntuples() takes no parameters.");
2017                return NULL;
2018        }
2019
2020        return PyInt_FromLong((long) PQntuples(self->result));
2021}
2022
2023/* list fields names from query result */
2024static char pgquery_listfields__doc__[] =
2025"listfields() -- Lists field names from result.";
2026
2027static PyObject *
2028pgquery_listfields(pgqueryobject *self, PyObject *args)
2029{
2030        int                     i,
2031                                n;
2032        char       *name;
2033        PyObject   *fieldstuple,
2034                           *str;
2035
2036        /* checks args */
2037        if (!PyArg_ParseTuple(args, ""))
2038        {
2039                PyErr_SetString(PyExc_TypeError,
2040                        "method listfields() takes no parameters.");
2041                return NULL;
2042        }
2043
2044        /* builds tuple */
2045        n = PQnfields(self->result);
2046        fieldstuple = PyTuple_New(n);
2047
2048        for (i = 0; i < n; i++)
2049        {
2050                name = PQfname(self->result, i);
2051                str = PyString_FromString(name);
2052                PyTuple_SET_ITEM(fieldstuple, i, str);
2053        }
2054
2055        return fieldstuple;
2056}
2057
2058/* get field name from last result */
2059static char pgquery_fieldname__doc__[] =
2060"fieldname() -- returns name of field from result from its position.";
2061
2062static PyObject *
2063pgquery_fieldname(pgqueryobject *self, PyObject *args)
2064{
2065        int             i;
2066        char   *name;
2067
2068        /* gets args */
2069        if (!PyArg_ParseTuple(args, "i", &i))
2070        {
2071                PyErr_SetString(PyExc_TypeError,
2072                        "fieldname(number), with number(integer).");
2073                return NULL;
2074        }
2075
2076        /* checks number validity */
2077        if (i >= PQnfields(self->result))
2078        {
2079                PyErr_SetString(PyExc_ValueError, "invalid field number.");
2080                return NULL;
2081        }
2082
2083        /* gets fields name and builds object */
2084        name = PQfname(self->result, i);
2085        return PyString_FromString(name);
2086}
2087
2088/* gets fields number from name in last result */
2089static char pgquery_fieldnum__doc__[] =
2090"fieldnum() -- returns position in query for field from its name.";
2091
2092static PyObject *
2093pgquery_fieldnum(pgqueryobject *self, PyObject *args)
2094{
2095        int             num;
2096        char   *name;
2097
2098        /* gets args */
2099        if (!PyArg_ParseTuple(args, "s", &name))
2100        {
2101                PyErr_SetString(PyExc_TypeError, "fieldnum(name), with name (string).");
2102                return NULL;
2103        }
2104
2105        /* gets field number */
2106        if ((num = PQfnumber(self->result, name)) == -1)
2107        {
2108                PyErr_SetString(PyExc_ValueError, "Unknown field.");
2109                return NULL;
2110        }
2111
2112        return PyInt_FromLong(num);
2113}
2114
2115/* retrieves last result */
2116static char pgquery_getresult__doc__[] =
2117"getresult() -- Gets the result of a query.  The result is returned "
2118"as a list of rows, each one a tuple of fields in the order returned "
2119"by the server.";
2120
2121static PyObject *
2122pgquery_getresult(pgqueryobject *self, PyObject *args)
2123{
2124        PyObject   *rowtuple,
2125                           *reslist,
2126                           *val;
2127        int                     i,
2128                                j,
2129                                m,
2130                                n,
2131                           *typ;
2132
2133        /* checks args (args == NULL for an internal call) */
2134        if (args && !PyArg_ParseTuple(args, ""))
2135        {
2136                PyErr_SetString(PyExc_TypeError,
2137                        "method getresult() takes no parameters.");
2138                return NULL;
2139        }
2140
2141        /* stores result in tuple */
2142        m = PQntuples(self->result);
2143        n = PQnfields(self->result);
2144        reslist = PyList_New(m);
2145
2146        typ = get_type_array(self->result, n);
2147
2148        for (i = 0; i < m; i++)
2149        {
2150                if (!(rowtuple = PyTuple_New(n)))
2151                {
2152                        Py_DECREF(reslist);
2153                        reslist = NULL;
2154                        goto exit;
2155                }
2156
2157                for (j = 0; j < n; j++)
2158                {
2159                        int                     k;
2160                        char       *s = PQgetvalue(self->result, i, j);
2161                        char            cashbuf[64];
2162                        PyObject   *tmp_obj;
2163
2164                        if (PQgetisnull(self->result, i, j))
2165                        {
2166                                Py_INCREF(Py_None);
2167                                val = Py_None;
2168                        }
2169                        else
2170                                switch (typ[j])
2171                                {
2172                                        case PYGRES_INT:
2173                                                val = PyInt_FromString(s, NULL, 10);
2174                                                break;
2175
2176                                        case PYGRES_LONG:
2177                                                val = PyLong_FromString(s, NULL, 10);
2178                                                break;
2179
2180                                        case PYGRES_FLOAT:
2181                                                tmp_obj = PyString_FromString(s);
2182                                                val = PyFloat_FromString(tmp_obj, NULL);
2183                                                Py_DECREF(tmp_obj);
2184                                                break;
2185
2186                                        case PYGRES_MONEY:
2187                                                /* convert to decimal only if decimal point is set */
2188                                                if (!decimal_point) goto default_case;
2189                                                for (k = 0;
2190                                                         *s && k < sizeof(cashbuf) / sizeof(cashbuf[0]) - 1;
2191                                                         s++)
2192                                                {
2193                                                        if (*s >= '0' && *s <= '9')
2194                                                                cashbuf[k++] = *s;
2195                                                        else if (*s == decimal_point)
2196                                                                cashbuf[k++] = '.';
2197                                                        else if (*s == '(' || *s == '-')
2198                                                                cashbuf[k++] = '-';
2199                                                }
2200                                                cashbuf[k] = 0;
2201                                                s = cashbuf;
2202                                                /* FALLTHROUGH */ /* no break */
2203
2204                                        case PYGRES_DECIMAL:
2205                                                if (decimal)
2206                                                {
2207                                                        tmp_obj = Py_BuildValue("(s)", s);
2208                                                        val = PyEval_CallObject(decimal, tmp_obj);
2209                                                }
2210                                                else
2211                                                {
2212                                                        tmp_obj = PyString_FromString(s);
2213                                                        val = PyFloat_FromString(tmp_obj, NULL);
2214                                                }
2215                                                Py_DECREF(tmp_obj);
2216                                                break;
2217
2218                                        case PYGRES_BOOL:
2219                                                /* convert to bool only if bool_type is set */
2220                                                if (use_bool)
2221                                                {
2222                                                        val = *s == 't' ? Py_True : Py_False;
2223                                                        Py_INCREF(val);
2224                                                        break;
2225                                                }
2226                                                /* FALLTHROUGH */ /* no break */
2227
2228                                        default:
2229                                        default_case:
2230                                                val = PyString_FromString(s);
2231                                                break;
2232                                }
2233
2234                        if (!val)
2235                        {
2236                                Py_DECREF(reslist);
2237                                Py_DECREF(rowtuple);
2238                                reslist = NULL;
2239                                goto exit;
2240                        }
2241
2242                        PyTuple_SET_ITEM(rowtuple, j, val);
2243                }
2244
2245                PyList_SET_ITEM(reslist, i, rowtuple);
2246        }
2247
2248exit:
2249        free(typ);
2250
2251        /* returns list */
2252        return reslist;
2253}
2254
2255/* retrieves last result as a list of dictionaries*/
2256static char pgquery_dictresult__doc__[] =
2257"dictresult() -- Gets the result of a query.  The result is returned "
2258"as a list of rows, each one a dictionary with the field names used "
2259"as the labels.";
2260
2261static PyObject *
2262pgquery_dictresult(pgqueryobject *self, PyObject *args)
2263{
2264        PyObject   *dict,
2265                           *reslist,
2266                           *val;
2267        int                     i,
2268                                j,
2269                                m,
2270                                n,
2271                           *typ;
2272
2273        /* checks args (args == NULL for an internal call) */
2274        if (args && !PyArg_ParseTuple(args, ""))
2275        {
2276                PyErr_SetString(PyExc_TypeError,
2277                        "method dictresult() takes no parameters.");
2278                return NULL;
2279        }
2280
2281        /* stores result in list */
2282        m = PQntuples(self->result);
2283        n = PQnfields(self->result);
2284        reslist = PyList_New(m);
2285
2286        typ = get_type_array(self->result, n);
2287
2288        for (i = 0; i < m; i++)
2289        {
2290                if (!(dict = PyDict_New()))
2291                {
2292                        Py_DECREF(reslist);
2293                        reslist = NULL;
2294                        goto exit;
2295                }
2296
2297                for (j = 0; j < n; j++)
2298                {
2299                        int                     k;
2300                        char       *s = PQgetvalue(self->result, i, j);
2301                        char            cashbuf[64];
2302                        PyObject   *tmp_obj;
2303
2304                        if (PQgetisnull(self->result, i, j))
2305                        {
2306                                Py_INCREF(Py_None);
2307                                val = Py_None;
2308                        }
2309                        else
2310                                switch (typ[j])
2311                                {
2312                                        case PYGRES_INT:
2313                                                val = PyInt_FromString(s, NULL, 10);
2314                                                break;
2315
2316                                        case PYGRES_LONG:
2317                                                val = PyLong_FromString(s, NULL, 10);
2318                                                break;
2319
2320                                        case PYGRES_FLOAT:
2321                                                tmp_obj = PyString_FromString(s);
2322                                                val = PyFloat_FromString(tmp_obj, NULL);
2323                                                Py_DECREF(tmp_obj);
2324                                                break;
2325
2326                                        case PYGRES_MONEY:
2327                                                /* convert to decimal only if decimal point is set */
2328                                                if (!decimal_point) goto default_case;
2329
2330                                                for (k = 0;
2331                                                         *s && k < sizeof(cashbuf) / sizeof(cashbuf[0]) - 1;
2332                                                         s++)
2333                                                {
2334                                                        if (*s >= '0' && *s <= '9')
2335                                                                cashbuf[k++] = *s;
2336                                                        else if (*s == decimal_point)
2337                                                                cashbuf[k++] = '.';
2338                                                        else if (*s == '(' || *s == '-')
2339                                                                cashbuf[k++] = '-';
2340                                                }
2341                                                cashbuf[k] = 0;
2342                                                s = cashbuf;
2343                                                /* FALLTHROUGH */ /* no break */
2344
2345                                        case PYGRES_DECIMAL:
2346                                                if (decimal)
2347                                                {
2348                                                        tmp_obj = Py_BuildValue("(s)", s);
2349                                                        val = PyEval_CallObject(decimal, tmp_obj);
2350                                                }
2351                                                else
2352                                                {
2353                                                        tmp_obj = PyString_FromString(s);
2354                                                        val = PyFloat_FromString(tmp_obj, NULL);
2355                                                }
2356                                                Py_DECREF(tmp_obj);
2357                                                break;
2358
2359                                        case PYGRES_BOOL:
2360                                                /* convert to bool only if bool_type is set */
2361                                                if (use_bool)
2362                                                {
2363                                                        val = *s == 't' ? Py_True : Py_False;
2364                                                        Py_INCREF(val);
2365                                                        break;
2366                                                }
2367                                                /* FALLTHROUGH */ /* no break */
2368
2369                                        default:
2370                                        default_case:
2371                                                val = PyString_FromString(s);
2372                                                break;
2373                                }
2374
2375                        if (!val)
2376                        {
2377                                Py_DECREF(dict);
2378                                Py_DECREF(reslist);
2379                                reslist = NULL;
2380                                goto exit;
2381                        }
2382
2383                        PyDict_SetItemString(dict, PQfname(self->result, j), val);
2384                        Py_DECREF(val);
2385                }
2386
2387                PyList_SET_ITEM(reslist, i, dict);
2388        }
2389
2390exit:
2391        free(typ);
2392
2393        /* returns list */
2394        return reslist;
2395}
2396
2397/* retrieves last result as named tuples */
2398static char pgquery_namedresult__doc__[] =
2399"namedresult() -- Gets the result of a query.  The result is returned "
2400"as a list of rows, each one a tuple of fields in the order returned "
2401"by the server.";
2402
2403static PyObject *
2404pgquery_namedresult(pgqueryobject *self, PyObject *args)
2405{
2406        PyObject   *arglist,
2407                           *ret;
2408
2409        /* checks args (args == NULL for an internal call) */
2410        if (args && !PyArg_ParseTuple(args, ""))
2411        {
2412                PyErr_SetString(PyExc_TypeError,
2413                        "method namedresult() takes no parameters.");
2414                return NULL;
2415        }
2416
2417        if (!namedresult)
2418        {
2419                PyErr_SetString(PyExc_TypeError,
2420                        "named tuples are not supported.");
2421                return NULL;
2422        }
2423
2424        arglist = Py_BuildValue("(O)", self);
2425        ret = PyObject_CallObject(namedresult, arglist);
2426        Py_DECREF(arglist);
2427
2428        if (ret == NULL)
2429            return NULL;
2430
2431        return ret;
2432}
2433
2434/* gets asynchronous notify */
2435static char pg_getnotify__doc__[] =
2436"getnotify() -- get database notify for this connection.";
2437
2438static PyObject *
2439pg_getnotify(pgobject *self, PyObject *args)
2440{
2441        PGnotify   *notify;
2442
2443        if (!self->cnx)
2444        {
2445                PyErr_SetString(PyExc_TypeError, "Connection is not valid.");
2446                return NULL;
2447        }
2448
2449        /* checks args */
2450        if (!PyArg_ParseTuple(args, ""))
2451        {
2452                PyErr_SetString(PyExc_TypeError,
2453                        "method getnotify() takes no parameters.");
2454                return NULL;
2455        }
2456
2457        /* checks for NOTIFY messages */
2458        PQconsumeInput(self->cnx);
2459
2460        if (!(notify = PQnotifies(self->cnx)))
2461        {
2462                Py_INCREF(Py_None);
2463                return Py_None;
2464        }
2465        else
2466        {
2467                PyObject   *notify_result,
2468                                   *temp;
2469
2470                if (!(temp = PyString_FromString(notify->relname)))
2471                        return NULL;
2472
2473                if (!(notify_result = PyTuple_New(3)))
2474                        return NULL;
2475
2476                PyTuple_SET_ITEM(notify_result, 0, temp);
2477
2478                if (!(temp = PyInt_FromLong(notify->be_pid)))
2479                {
2480                        Py_DECREF(notify_result);
2481                        return NULL;
2482                }
2483
2484                PyTuple_SET_ITEM(notify_result, 1, temp);
2485
2486                /* extra exists even in old versions that did not support it */
2487                if (!(temp = PyString_FromString(notify->extra)))
2488                {
2489                        Py_DECREF(notify_result);
2490                        return NULL;
2491                }
2492
2493                PyTuple_SET_ITEM(notify_result, 2, temp);
2494
2495                PQfreemem(notify);
2496
2497                return notify_result;
2498        }
2499}
2500
2501/* source creation */
2502static char pg_source__doc__[] =
2503"source() -- creates a new source object for this connection";
2504
2505static PyObject *
2506pg_source(pgobject *self, PyObject *args)
2507{
2508        /* checks validity */
2509        if (!check_cnx_obj(self))
2510                return NULL;
2511
2512        /* checks args */
2513        if (!PyArg_ParseTuple(args, ""))
2514        {
2515                PyErr_SetString(PyExc_TypeError, "method source() takes no parameter.");
2516                return NULL;
2517        }
2518
2519        /* allocate new pg query object */
2520        return (PyObject *) pgsource_new(self);
2521}
2522
2523/* database query */
2524static char pg_query__doc__[] =
2525"query(sql, [args]) -- creates a new query object for this connection, using"
2526" sql (string) request and optionally a tuple with positional parameters.";
2527
2528static PyObject *
2529pg_query(pgobject *self, PyObject *args)
2530{
2531        char            *query;
2532        PyObject        *oargs = NULL;
2533        PGresult        *result;
2534        pgqueryobject *npgobj;
2535        int                     status,
2536                                nparms = 0;
2537
2538        if (!self->cnx)
2539        {
2540                PyErr_SetString(PyExc_TypeError, "Connection is not valid.");
2541                return NULL;
2542        }
2543
2544        /* get query args */
2545        if (!PyArg_ParseTuple(args, "s|O", &query, &oargs))
2546        {
2547                PyErr_SetString(PyExc_TypeError, "query(sql, [args]), with sql (string).");
2548                return NULL;
2549        }
2550
2551        /* If oargs is passed, ensure it's a non-empty tuple. We want to treat
2552         * an empty tuple the same as no argument since we'll get that when the
2553         * caller passes no arguments to db.query(), and historic behaviour was
2554         * to call PQexec() in that case, which can execute multiple commands. */
2555        if (oargs)
2556        {
2557                if (!PyTuple_Check(oargs) && !PyList_Check(oargs))
2558                {
2559                        PyErr_SetString(PyExc_TypeError, "query parameters must be a tuple or list.");
2560                        return NULL;
2561                }
2562
2563                nparms = (int)PySequence_Size(oargs);
2564        }
2565
2566        /* gets result */
2567        if (nparms)
2568        {
2569                /* prepare arguments */
2570                PyObject        **str, **s, *obj = PySequence_GetItem(oargs, 0);
2571                char            **parms, **p, *enc=NULL;
2572                int                     *lparms, *l;
2573                register int i;
2574
2575                /* if there's a single argument and it's a list or tuple, it
2576                 * contains the positional aguments. */
2577                if (nparms == 1 && (PyList_Check(obj) || PyTuple_Check(obj)))
2578                {
2579                        oargs = obj;
2580                        nparms = (int)PySequence_Size(oargs);
2581                }
2582                str = (PyObject **)malloc(nparms * sizeof(*str));
2583                parms = (char **)malloc(nparms * sizeof(*parms));
2584                lparms = (int *)malloc(nparms * sizeof(*lparms));
2585
2586                /* convert optional args to a list of strings -- this allows
2587                 * the caller to pass whatever they like, and prevents us
2588                 * from having to map types to OIDs */
2589                for (i = 0, s=str, p=parms, l=lparms; i < nparms; i++, s++, p++, l++)
2590                {
2591                        obj = PySequence_GetItem(oargs, i);
2592
2593                        if (obj == Py_None)
2594                        {
2595                                *s = NULL;
2596                                *p = NULL;
2597                                *l = 0;
2598                        }
2599                        else if (PyUnicode_Check(obj))
2600                        {
2601                                if (!enc)
2602                                        enc = (char *)pg_encoding_to_char(
2603                                                PQclientEncoding(self->cnx));
2604                                if (!strcmp(enc, "UTF8"))
2605                                        *s = PyUnicode_AsUTF8String(obj);
2606                                else if (!strcmp(enc, "LATIN1"))
2607                                        *s = PyUnicode_AsLatin1String(obj);
2608                                else if (!strcmp(enc, "SQL_ASCII"))
2609                                        *s = PyUnicode_AsASCIIString(obj);
2610                                else
2611                                        *s = PyUnicode_AsEncodedString(obj, enc, "strict");
2612                                if (*s == NULL)
2613                                {
2614                                        free(lparms); free(parms);
2615                                        while (i--)
2616                                        {
2617                                                if (*--s)
2618                                                {
2619                                                        Py_DECREF(*s);
2620                                                }
2621                                        }
2622                                        free(str);
2623                                        PyErr_SetString(PyExc_UnicodeError, "query parameter"
2624                                                " could not be decoded (bad client encoding)");
2625                                        return NULL;
2626                                }
2627                                *p = PyString_AsString(*s);
2628                                *l = (int)PyString_Size(*s);
2629                        }
2630                        else
2631                        {
2632                                *s = PyObject_Str(obj);
2633                                if (*s == NULL)
2634                                {
2635                                        free(lparms); free(parms);
2636                                        while (i--)
2637                                        {
2638                                                if (*--s)
2639                                                {
2640                                                        Py_DECREF(*s);
2641                                                }
2642                                        }
2643                                        free(str);
2644                                        PyErr_SetString(PyExc_TypeError,
2645                                                "query parameter has no string representation");
2646                                        return NULL;
2647                                }
2648                                *p = PyString_AsString(*s);
2649                                *l = (int)PyString_Size(*s);
2650                        }
2651                }
2652
2653                Py_BEGIN_ALLOW_THREADS
2654                result = PQexecParams(self->cnx, query, nparms,
2655                        NULL, (const char * const *)parms, lparms, NULL, 0);
2656                Py_END_ALLOW_THREADS
2657
2658                free(lparms); free(parms);
2659                for (i = 0, s=str; i < nparms; i++, s++)
2660                {
2661                        if (*s)
2662                        {
2663                                Py_DECREF(*s);
2664                        }
2665                }
2666                free(str);
2667        }
2668        else
2669        {
2670                Py_BEGIN_ALLOW_THREADS
2671                result = PQexec(self->cnx, query);
2672                Py_END_ALLOW_THREADS
2673        }
2674
2675        /* checks result validity */
2676        if (!result)
2677        {
2678                PyErr_SetString(PyExc_ValueError, PQerrorMessage(self->cnx));
2679                return NULL;
2680        }
2681
2682        /* checks result status */
2683        if ((status = PQresultStatus(result)) != PGRES_TUPLES_OK)
2684        {
2685                switch (status)
2686                {
2687                        case PGRES_EMPTY_QUERY:
2688                                PyErr_SetString(PyExc_ValueError, "empty query.");
2689                                break;
2690                        case PGRES_BAD_RESPONSE:
2691                        case PGRES_FATAL_ERROR:
2692                        case PGRES_NONFATAL_ERROR:
2693                                set_dberror(ProgrammingError,
2694                                        PQerrorMessage(self->cnx), result);
2695                                break;
2696                        case PGRES_COMMAND_OK:
2697                                {                                               /* INSERT, UPDATE, DELETE */
2698                                        Oid             oid = PQoidValue(result);
2699                                        if (oid == InvalidOid)  /* not a single insert */
2700                                        {
2701                                                char    *ret = PQcmdTuples(result);
2702
2703                                                PQclear(result);
2704                                                if (ret[0])             /* return number of rows affected */
2705                                                {
2706                                                        return PyString_FromString(ret);
2707                                                }
2708                                                Py_INCREF(Py_None);
2709                                                return Py_None;
2710                                        }
2711                                        /* for a single insert, return the oid */
2712                                        PQclear(result);
2713                                        return PyInt_FromLong(oid);
2714                                }
2715                        case PGRES_COPY_OUT:            /* no data will be received */
2716                        case PGRES_COPY_IN:
2717                                PQclear(result);
2718                                Py_INCREF(Py_None);
2719                                return Py_None;
2720                        default:
2721                                set_dberror(InternalError,
2722                                        "internal error: unknown result status.", result);
2723                                break;
2724                }
2725
2726                PQclear(result);
2727                return NULL;                    /* error detected on query */
2728        }
2729
2730        if (!(npgobj = PyObject_NEW(pgqueryobject, &PgQueryType)))
2731                return NULL;
2732
2733        /* stores result and returns object */
2734        npgobj->result = result;
2735        return (PyObject *) npgobj;
2736}
2737
2738#ifdef DIRECT_ACCESS
2739static char pg_putline__doc__[] =
2740"putline() -- sends a line directly to the backend";
2741
2742/* direct acces function : putline */
2743static PyObject *
2744pg_putline(pgobject *self, PyObject *args)
2745{
2746        char *line;
2747
2748        if (!self->cnx)
2749        {
2750                PyErr_SetString(PyExc_TypeError, "Connection is not valid.");
2751                return NULL;
2752        }
2753
2754        /* reads args */
2755        if (!PyArg_ParseTuple(args, "s", &line))
2756        {
2757                PyErr_SetString(PyExc_TypeError, "putline(line), with line (string).");
2758                return NULL;
2759        }
2760
2761        /* sends line to backend */
2762        if (PQputline(self->cnx, line))
2763        {
2764                PyErr_SetString(PyExc_IOError, PQerrorMessage(self->cnx));
2765                return NULL;
2766        }
2767        Py_INCREF(Py_None);
2768        return Py_None;
2769}
2770
2771/* direct access function : getline */
2772static char pg_getline__doc__[] =
2773"getline() -- gets a line directly from the backend.";
2774
2775static PyObject *
2776pg_getline(pgobject *self, PyObject *args)
2777{
2778        char            line[MAX_BUFFER_SIZE];
2779        PyObject   *str = NULL;         /* GCC */
2780
2781        if (!self->cnx)
2782        {
2783                PyErr_SetString(PyExc_TypeError, "Connection is not valid.");
2784                return NULL;
2785        }
2786
2787        /* checks args */
2788        if (!PyArg_ParseTuple(args, ""))
2789        {
2790                PyErr_SetString(PyExc_TypeError,
2791                        "method getline() takes no parameters.");
2792                return NULL;
2793        }
2794
2795        /* gets line */
2796        switch (PQgetline(self->cnx, line, MAX_BUFFER_SIZE))
2797        {
2798                case 0:
2799                        str = PyString_FromString(line);
2800                        break;
2801                case 1:
2802                        PyErr_SetString(PyExc_MemoryError, "buffer overflow");
2803                        str = NULL;
2804                        break;
2805                case EOF:
2806                        Py_INCREF(Py_None);
2807                        str = Py_None;
2808                        break;
2809        }
2810
2811        return str;
2812}
2813
2814/* direct access function : end copy */
2815static char pg_endcopy__doc__[] =
2816"endcopy() -- synchronizes client and server";
2817
2818static PyObject *
2819pg_endcopy(pgobject *self, PyObject *args)
2820{
2821        if (!self->cnx)
2822        {
2823                PyErr_SetString(PyExc_TypeError, "Connection is not valid.");
2824                return NULL;
2825        }
2826
2827        /* checks args */
2828        if (!PyArg_ParseTuple(args, ""))
2829        {
2830                PyErr_SetString(PyExc_TypeError,
2831                        "method endcopy() takes no parameters.");
2832                return NULL;
2833        }
2834
2835        /* ends direct copy */
2836        if (PQendcopy(self->cnx))
2837        {
2838                PyErr_SetString(PyExc_IOError, PQerrorMessage(self->cnx));
2839                return NULL;
2840        }
2841        Py_INCREF(Py_None);
2842        return Py_None;
2843}
2844#endif /* DIRECT_ACCESS */
2845
2846static PyObject *
2847pgquery_repr(pgqueryobject *self)
2848{
2849        return PyString_FromString("<pg query result>");
2850}
2851
2852static PyObject *
2853pgquery_str(pgqueryobject *self)
2854{
2855        return format_result(self->result);
2856}
2857
2858/* insert table */
2859static char pg_inserttable__doc__[] =
2860"inserttable(string, list) -- insert list in table. The fields in the "
2861"list must be in the same order as in the table.";
2862
2863static PyObject *
2864pg_inserttable(pgobject *self, PyObject *args)
2865{
2866        PGresult        *result;
2867        char            *table,
2868                                *buffer,
2869                                *bufpt;
2870        size_t          bufsiz;
2871        PyObject        *list,
2872                                *sublist,
2873                                *item;
2874        PyObject        *(*getitem) (PyObject *, Py_ssize_t);
2875        PyObject        *(*getsubitem) (PyObject *, Py_ssize_t);
2876        Py_ssize_t      i,
2877                                j,
2878                                m,
2879                                n;
2880
2881        if (!self->cnx)
2882        {
2883                PyErr_SetString(PyExc_TypeError, "Connection is not valid.");
2884                return NULL;
2885        }
2886
2887        /* gets arguments */
2888        if (!PyArg_ParseTuple(args, "sO:filter", &table, &list))
2889        {
2890                PyErr_SetString(PyExc_TypeError,
2891                        "inserttable(table, content), with table (string) "
2892                        "and content (list).");
2893                return NULL;
2894        }
2895
2896        /* checks list type */
2897        if (PyTuple_Check(list))
2898        {
2899                m = PyTuple_Size(list);
2900                getitem = PyTuple_GetItem;
2901        }
2902        else if (PyList_Check(list))
2903        {
2904                m = PyList_Size(list);
2905                getitem = PyList_GetItem;
2906        }
2907        else
2908        {
2909                PyErr_SetString(PyExc_TypeError,
2910                        "second arg must be some kind of array.");
2911                return NULL;
2912        }
2913
2914        /* allocate buffer */
2915        if (!(buffer = malloc(MAX_BUFFER_SIZE)))
2916        {
2917                PyErr_SetString(PyExc_MemoryError,
2918                        "can't allocate insert buffer.");
2919                return NULL;
2920        }
2921
2922        /* starts query */
2923        sprintf(buffer, "copy %s from stdin", table);
2924
2925        Py_BEGIN_ALLOW_THREADS
2926        result = PQexec(self->cnx, buffer);
2927        Py_END_ALLOW_THREADS
2928
2929        if (!result)
2930        {
2931                free(buffer);
2932                PyErr_SetString(PyExc_ValueError, PQerrorMessage(self->cnx));
2933                return NULL;
2934        }
2935
2936        PQclear(result);
2937
2938        n = 0; /* not strictly necessary but avoids warning */
2939
2940        /* feed table */
2941        for (i = 0; i < m; i++)
2942        {
2943                sublist = getitem(list, i);
2944                if (PyTuple_Check(sublist))
2945                {
2946                        j = PyTuple_Size(sublist);
2947                        getsubitem = PyTuple_GetItem;
2948                }
2949                else if (PyList_Check(sublist))
2950                {
2951                        j = PyList_Size(sublist);
2952                        getsubitem = PyList_GetItem;
2953                }
2954                else
2955                {
2956                        PyErr_SetString(PyExc_TypeError,
2957                                "second arg must contain some kind of arrays.");
2958                        return NULL;
2959                }
2960                if (i)
2961                {
2962                        if (j != n)
2963                        {
2964                                free(buffer);
2965                                PyErr_SetString(PyExc_TypeError,
2966                                        "arrays contained in second arg must have same size.");
2967                                return NULL;
2968                        }
2969                }
2970                else
2971                {
2972                        n = j; /* never used before this assignment */
2973                }
2974
2975                /* builds insert line */
2976                bufpt = buffer;
2977                bufsiz = MAX_BUFFER_SIZE - 1;
2978
2979                for (j = 0; j < n; j++)
2980                {
2981                        if (j)
2982                        {
2983                                *bufpt++ = '\t'; --bufsiz;
2984                        }
2985
2986                        item = getsubitem(sublist, j);
2987
2988                        /* convert item to string and append to buffer */
2989                        if (item == Py_None)
2990                        {
2991                                if (bufsiz > 2)
2992                                {
2993                                        *bufpt++ = '\\'; *bufpt++ = 'N';
2994                                        bufsiz -= 2;
2995                                }
2996                                else
2997                                        bufsiz = 0;
2998                        }
2999                        else if (PyString_Check(item))
3000                        {
3001                                const char* t = PyString_AS_STRING(item);
3002                                while (*t && bufsiz)
3003                                {
3004                                        if (*t == '\\' || *t == '\t' || *t == '\n')
3005                                        {
3006                                                *bufpt++ = '\\'; --bufsiz;
3007                                                if (!bufsiz) break;
3008                                        }
3009                                        *bufpt++ = *t++; --bufsiz;
3010                                }
3011                        }
3012                        else if (PyInt_Check(item) || PyLong_Check(item))
3013                        {
3014                                PyObject* s = PyObject_Str(item);
3015                                const char* t = PyString_AsString(s);
3016                                while (*t && bufsiz)
3017                                {
3018                                        *bufpt++ = *t++; --bufsiz;
3019                                }
3020                                Py_DECREF(s);
3021                        }
3022                        else
3023                        {
3024                                PyObject* s = PyObject_Repr(item);
3025                                const char* t = PyString_AsString(s);
3026                                while (*t && bufsiz)
3027                                {
3028                                        if (*t == '\\' || *t == '\t' || *t == '\n')
3029                                        {
3030                                                *bufpt++ = '\\'; --bufsiz;
3031                                                if (!bufsiz) break;
3032                                        }
3033                                        *bufpt++ = *t++; --bufsiz;
3034                                }
3035                                Py_DECREF(s);
3036                        }
3037
3038                        if (bufsiz <= 0)
3039                        {
3040                                free(buffer);
3041                                PyErr_SetString(PyExc_MemoryError,
3042                                        "insert buffer overflow.");
3043                                return NULL;
3044                        }
3045
3046                }
3047
3048                *bufpt++ = '\n'; *bufpt = '\0';
3049
3050                /* sends data */
3051                if (PQputline(self->cnx, buffer))
3052                {
3053                        PyErr_SetString(PyExc_IOError, PQerrorMessage(self->cnx));
3054                        PQendcopy(self->cnx);
3055                        free(buffer);
3056                        return NULL;
3057                }
3058        }
3059
3060        /* ends query */
3061        if (PQputline(self->cnx, "\\.\n"))
3062        {
3063                PyErr_SetString(PyExc_IOError, PQerrorMessage(self->cnx));
3064                PQendcopy(self->cnx);
3065                free(buffer);
3066                return NULL;
3067        }
3068
3069        if (PQendcopy(self->cnx))
3070        {
3071                PyErr_SetString(PyExc_IOError, PQerrorMessage(self->cnx));
3072                free(buffer);
3073                return NULL;
3074        }
3075
3076        free(buffer);
3077
3078        /* no error : returns nothing */
3079        Py_INCREF(Py_None);
3080        return Py_None;
3081}
3082
3083/* get transaction state */
3084static char pg_transaction__doc__[] =
3085"Returns the current transaction status.";
3086
3087static PyObject *
3088pg_transaction(pgobject *self, PyObject *args)
3089{
3090        if (!self->cnx)
3091        {
3092                PyErr_SetString(PyExc_TypeError, "Connection is not valid.");
3093                return NULL;
3094        }
3095
3096        /* checks args */
3097        if (!PyArg_ParseTuple(args, ""))
3098        {
3099                PyErr_SetString(PyExc_TypeError,
3100                        "method transaction() takes no parameters.");
3101                return NULL;
3102        }
3103
3104        return PyInt_FromLong(PQtransactionStatus(self->cnx));
3105}
3106
3107/* get parameter setting */
3108static char pg_parameter__doc__[] =
3109"Looks up a current parameter setting.";
3110
3111static PyObject *
3112pg_parameter(pgobject *self, PyObject *args)
3113{
3114        const char *name;
3115
3116        if (!self->cnx)
3117        {
3118                PyErr_SetString(PyExc_TypeError, "Connection is not valid.");
3119                return NULL;
3120        }
3121
3122        /* get query args */
3123        if (!PyArg_ParseTuple(args, "s", &name))
3124        {
3125                PyErr_SetString(PyExc_TypeError, "parameter(name), with name (string).");
3126                return NULL;
3127        }
3128
3129        name = PQparameterStatus(self->cnx, name);
3130
3131        if (name)
3132                return PyString_FromString(name);
3133
3134        /* unknown parameter, return None */
3135        Py_INCREF(Py_None);
3136        return Py_None;
3137}
3138
3139#ifdef ESCAPING_FUNCS
3140
3141/* escape literal */
3142static char pg_escape_literal__doc__[] =
3143"pg_escape_literal(str) -- escape a literal constant for use within SQL.";
3144
3145static PyObject *
3146pg_escape_literal(pgobject *self, PyObject *args)
3147{
3148        char *str; /* our string argument */
3149        int str_length; /* length of string */
3150        char *esc; /* the escaped version of the string */
3151        PyObject *ret; /* string object to return */
3152
3153        if (!PyArg_ParseTuple(args, "s#", &str, &str_length))
3154                return NULL;
3155        esc = PQescapeLiteral(self->cnx, str, (size_t)str_length);
3156        ret = Py_BuildValue("s", esc);
3157        if (esc)
3158                PQfreemem(esc);
3159        if (!ret) /* pass on exception */
3160                return NULL;
3161        return ret;
3162}
3163
3164/* escape identifier */
3165static char pg_escape_identifier__doc__[] =
3166"pg_escape_identifier(str) -- escape an identifier for use within SQL.";
3167
3168static PyObject *
3169pg_escape_identifier(pgobject *self, PyObject *args)
3170{
3171        char *str; /* our string argument */
3172        int str_length; /* length of string */
3173        char *esc; /* the escaped version of the string */
3174        PyObject *ret; /* string object to return */
3175
3176        if (!PyArg_ParseTuple(args, "s#", &str, &str_length))
3177                return NULL;
3178        esc = PQescapeIdentifier(self->cnx, str, (size_t)str_length);
3179        ret = Py_BuildValue("s", esc);
3180        if (esc)
3181                PQfreemem(esc);
3182        if (!ret) /* pass on exception */
3183                return NULL;
3184        return ret;
3185}
3186
3187#endif  /* ESCAPING_FUNCS */
3188
3189/* escape string */
3190static char pg_escape_string__doc__[] =
3191"pg_escape_string(str) -- escape a string for use within SQL.";
3192
3193static PyObject *
3194pg_escape_string(pgobject *self, PyObject *args)
3195{
3196        char *from; /* our string argument */
3197        char *to=NULL; /* the result */
3198        int from_length; /* length of string */
3199        int to_length; /* length of result */
3200        PyObject *ret; /* string object to return */
3201
3202        if (!PyArg_ParseTuple(args, "s#", &from, &from_length))
3203                return NULL;
3204        to_length = 2*from_length + 1;
3205        if (to_length < from_length) /* overflow */
3206        {
3207                to_length = from_length;
3208                from_length = (from_length - 1)/2;
3209        }
3210        to = (char *)malloc(to_length);
3211        to_length = (int)PQescapeStringConn(self->cnx,
3212                to, from, (size_t)from_length, NULL);
3213        ret = Py_BuildValue("s#", to, to_length);
3214        if (to)
3215                free(to);
3216        if (!ret) /* pass on exception */
3217                return NULL;
3218        return ret;
3219}
3220
3221/* escape bytea */
3222static char pg_escape_bytea__doc__[] =
3223"pg_escape_bytea(data) -- escape binary data for use within SQL as type bytea.";
3224
3225static PyObject *
3226pg_escape_bytea(pgobject *self, PyObject *args)
3227{
3228        unsigned char *from; /* our string argument */
3229        unsigned char *to; /* the result */
3230        int from_length; /* length of string */
3231        size_t to_length; /* length of result */
3232        PyObject *ret; /* string object to return */
3233
3234        if (!PyArg_ParseTuple(args, "s#", &from, &from_length))
3235                return NULL;
3236        to = PQescapeByteaConn(self->cnx, from, (int)from_length, &to_length);
3237        ret = Py_BuildValue("s", to);
3238        if (to)
3239                PQfreemem((void *)to);
3240        if (!ret) /* pass on exception */
3241                return NULL;
3242        return ret;
3243}
3244
3245#ifdef LARGE_OBJECTS
3246/* creates large object */
3247static char pg_locreate__doc__[] =
3248"locreate() -- creates a new large object in the database.";
3249
3250static PyObject *
3251pg_locreate(pgobject *self, PyObject *args)
3252{
3253        int                     mode;
3254        Oid                     lo_oid;
3255
3256        /* checks validity */
3257        if (!check_cnx_obj(self))
3258                return NULL;
3259
3260        /* gets arguments */
3261        if (!PyArg_ParseTuple(args, "i", &mode))
3262        {
3263                PyErr_SetString(PyExc_TypeError,
3264                        "locreate(mode), with mode (integer).");
3265                return NULL;
3266        }
3267
3268        /* creates large object */
3269        lo_oid = lo_creat(self->cnx, mode);
3270        if (lo_oid == 0)
3271        {
3272                set_dberror(OperationalError, "can't create large object.", NULL);
3273                return NULL;
3274        }
3275
3276        return (PyObject *) pglarge_new(self, lo_oid);
3277}
3278
3279/* init from already known oid */
3280static char pg_getlo__doc__[] =
3281"getlo(long) -- create a large object instance for the specified oid.";
3282
3283static PyObject *
3284pg_getlo(pgobject *self, PyObject *args)
3285{
3286        int                     lo_oid;
3287
3288        /* checks validity */
3289        if (!check_cnx_obj(self))
3290                return NULL;
3291
3292        /* gets arguments */
3293        if (!PyArg_ParseTuple(args, "i", &lo_oid))
3294        {
3295                PyErr_SetString(PyExc_TypeError, "getlo(oid), with oid (integer).");
3296                return NULL;
3297        }
3298
3299        if (!lo_oid)
3300        {
3301                PyErr_SetString(PyExc_ValueError, "the object oid can't be null.");
3302                return NULL;
3303        }
3304
3305        /* creates object */
3306        return (PyObject *) pglarge_new(self, lo_oid);
3307}
3308
3309/* import unix file */
3310static char pg_loimport__doc__[] =
3311"loimport(string) -- create a new large object from specified file.";
3312
3313static PyObject *
3314pg_loimport(pgobject *self, PyObject *args)
3315{
3316        char   *name;
3317        Oid             lo_oid;
3318
3319        /* checks validity */
3320        if (!check_cnx_obj(self))
3321                return NULL;
3322
3323        /* gets arguments */
3324        if (!PyArg_ParseTuple(args, "s", &name))
3325        {
3326                PyErr_SetString(PyExc_TypeError, "loimport(name), with name (string).");
3327                return NULL;
3328        }
3329
3330        /* imports file and checks result */
3331        lo_oid = lo_import(self->cnx, name);
3332        if (lo_oid == 0)
3333        {
3334                set_dberror(OperationalError, "can't create large object.", NULL);
3335                return NULL;
3336        }
3337
3338        return (PyObject *) pglarge_new(self, lo_oid);
3339}
3340#endif /* LARGE_OBJECTS */
3341
3342
3343/* connection object methods */
3344static struct PyMethodDef pgobj_methods[] = {
3345        {"source", (PyCFunction) pg_source, METH_VARARGS, pg_source__doc__},
3346        {"query", (PyCFunction) pg_query, METH_VARARGS, pg_query__doc__},
3347        {"reset", (PyCFunction) pg_reset, METH_VARARGS, pg_reset__doc__},
3348        {"cancel", (PyCFunction) pg_cancel, METH_VARARGS, pg_cancel__doc__},
3349        {"close", (PyCFunction) pg_close, METH_VARARGS, pg_close__doc__},
3350        {"fileno", (PyCFunction) pg_fileno, METH_VARARGS, pg_fileno__doc__},
3351        {"get_notice_receiver", (PyCFunction) pg_get_notice_receiver, METH_VARARGS,
3352                        pg_get_notice_receiver__doc__},
3353        {"set_notice_receiver", (PyCFunction) pg_set_notice_receiver, METH_VARARGS,
3354                        pg_set_notice_receiver__doc__},
3355        {"getnotify", (PyCFunction) pg_getnotify, METH_VARARGS,
3356                        pg_getnotify__doc__},
3357        {"inserttable", (PyCFunction) pg_inserttable, METH_VARARGS,
3358                        pg_inserttable__doc__},
3359        {"transaction", (PyCFunction) pg_transaction, METH_VARARGS,
3360                        pg_transaction__doc__},
3361        {"parameter", (PyCFunction) pg_parameter, METH_VARARGS,
3362                        pg_parameter__doc__},
3363
3364#ifdef ESCAPING_FUNCS
3365        {"escape_literal", (PyCFunction) pg_escape_literal, METH_VARARGS,
3366                        pg_escape_literal__doc__},
3367        {"escape_identifier", (PyCFunction) pg_escape_identifier, METH_VARARGS,
3368                        pg_escape_identifier__doc__},
3369#endif  /* ESCAPING_FUNCS */
3370        {"escape_string", (PyCFunction) pg_escape_string, METH_VARARGS,
3371                        pg_escape_string__doc__},
3372        {"escape_bytea", (PyCFunction) pg_escape_bytea, METH_VARARGS,
3373                        pg_escape_bytea__doc__},
3374
3375#ifdef DIRECT_ACCESS
3376        {"putline", (PyCFunction) pg_putline, 1, pg_putline__doc__},
3377        {"getline", (PyCFunction) pg_getline, 1, pg_getline__doc__},
3378        {"endcopy", (PyCFunction) pg_endcopy, 1, pg_endcopy__doc__},
3379#endif /* DIRECT_ACCESS */
3380
3381#ifdef LARGE_OBJECTS
3382        {"locreate", (PyCFunction) pg_locreate, 1, pg_locreate__doc__},
3383        {"getlo", (PyCFunction) pg_getlo, 1, pg_getlo__doc__},
3384        {"loimport", (PyCFunction) pg_loimport, 1, pg_loimport__doc__},
3385#endif /* LARGE_OBJECTS */
3386
3387        {NULL, NULL} /* sentinel */
3388};
3389
3390/* get attribute */
3391static PyObject *
3392pg_getattr(pgobject *self, char *name)
3393{
3394        /*
3395         * Although we could check individually, there are only a few
3396         * attributes that don't require a live connection and unless someone
3397         * has an urgent need, this will have to do
3398         */
3399
3400        /* first exception - close which returns a different error */
3401        if (strcmp(name, "close") && !self->cnx)
3402        {
3403                PyErr_SetString(PyExc_TypeError, "Connection is not valid.");
3404                return NULL;
3405        }
3406
3407        /* list PostgreSQL connection fields */
3408
3409        /* postmaster host */
3410        if (!strcmp(name, "host"))
3411        {
3412                char *r = PQhost(self->cnx);
3413                if (!r)
3414                        r = "localhost";
3415                return PyString_FromString(r);
3416        }
3417
3418        /* postmaster port */
3419        if (!strcmp(name, "port"))
3420                return PyInt_FromLong(atol(PQport(self->cnx)));
3421
3422        /* selected database */
3423        if (!strcmp(name, "db"))
3424                return PyString_FromString(PQdb(self->cnx));
3425
3426        /* selected options */
3427        if (!strcmp(name, "options"))
3428                return PyString_FromString(PQoptions(self->cnx));
3429
3430        /* selected postgres tty */
3431        if (!strcmp(name, "tty"))
3432                return PyString_FromString(PQtty(self->cnx));
3433
3434        /* error (status) message */
3435        if (!strcmp(name, "error"))
3436                return PyString_FromString(PQerrorMessage(self->cnx));
3437
3438        /* connection status : 1 - OK, 0 - BAD */
3439        if (!strcmp(name, "status"))
3440                return PyInt_FromLong(PQstatus(self->cnx) == CONNECTION_OK ? 1 : 0);
3441
3442        /* provided user name */
3443        if (!strcmp(name, "user"))
3444                return PyString_FromString(PQuser(self->cnx));
3445
3446        /* protocol version */
3447        if (!strcmp(name, "protocol_version"))
3448                return PyInt_FromLong(PQprotocolVersion(self->cnx));
3449
3450        /* backend version */
3451        if (!strcmp(name, "server_version"))
3452#if PG_VERSION_NUM < 80000
3453                return PyInt_FromLong(PG_VERSION_NUM);
3454#else
3455                return PyInt_FromLong(PQserverVersion(self->cnx));
3456#endif
3457
3458        /* attributes list */
3459        if (!strcmp(name, "__members__"))
3460        {
3461                PyObject *list = PyList_New(10);
3462
3463                if (list)
3464                {
3465                        PyList_SET_ITEM(list, 0, PyString_FromString("host"));
3466                        PyList_SET_ITEM(list, 1, PyString_FromString("port"));
3467                        PyList_SET_ITEM(list, 2, PyString_FromString("db"));
3468                        PyList_SET_ITEM(list, 3, PyString_FromString("options"));
3469                        PyList_SET_ITEM(list, 4, PyString_FromString("tty"));
3470                        PyList_SET_ITEM(list, 5, PyString_FromString("error"));
3471                        PyList_SET_ITEM(list, 6, PyString_FromString("status"));
3472                        PyList_SET_ITEM(list, 7, PyString_FromString("user"));
3473                        PyList_SET_ITEM(list, 8, PyString_FromString("protocol_version"));
3474                        PyList_SET_ITEM(list, 9, PyString_FromString("server_version"));
3475                }
3476
3477                return list;
3478        }
3479
3480        return Py_FindMethod(pgobj_methods, (PyObject *) self, name);
3481}
3482
3483/* object type definition */
3484staticforward PyTypeObject PgType = {
3485        PyObject_HEAD_INIT(NULL)
3486        0,                                                      /* ob_size */
3487        "pgobject",                                     /* tp_name */
3488        sizeof(pgobject),                       /* tp_basicsize */
3489        0,                                                      /* tp_itemsize */
3490        /* methods */
3491        (destructor) pg_dealloc,        /* tp_dealloc */
3492        0,                                                      /* tp_print */
3493        (getattrfunc) pg_getattr,       /* tp_getattr */
3494        0,                                                      /* tp_setattr */
3495        0,                                                      /* tp_compare */
3496        0,                                                      /* tp_repr */
3497        0,                                                      /* tp_as_number */
3498        0,                                                      /* tp_as_sequence */
3499        0,                                                      /* tp_as_mapping */
3500        0,                                                      /* tp_hash */
3501};
3502
3503
3504/* get attribute */
3505static PyObject *
3506pgnotice_getattr(pgnoticeobject *self, char *name)
3507{
3508        PGresult const *res = self->res;
3509        int fieldcode;
3510
3511        if (!res)
3512        {
3513                PyErr_SetString(PyExc_TypeError, "Cannot get current notice.");
3514                return NULL;
3515        }
3516
3517        /* pg connection object */
3518        if (!strcmp(name, "pgcnx"))
3519        {
3520                if (self->pgcnx && check_cnx_obj(self->pgcnx))
3521                {
3522                        Py_INCREF(self->pgcnx);
3523                        return (PyObject *) self->pgcnx;
3524                }
3525                else
3526                {
3527                        Py_INCREF(Py_None);
3528                        return Py_None;
3529                }
3530        }
3531
3532        /* full message */
3533        if (!strcmp(name, "message"))
3534                return PyString_FromString(PQresultErrorMessage(res));
3535
3536        /* other possible fields */
3537        fieldcode = 0;
3538        if (!strcmp(name, "severity"))
3539                fieldcode = PG_DIAG_SEVERITY;
3540        else if (!strcmp(name, "primary"))
3541                fieldcode = PG_DIAG_MESSAGE_PRIMARY;
3542        else if (!strcmp(name, "detail"))
3543                fieldcode = PG_DIAG_MESSAGE_DETAIL;
3544        else if (!strcmp(name, "hint"))
3545                fieldcode = PG_DIAG_MESSAGE_HINT;
3546        if (fieldcode)
3547        {
3548                char *s = PQresultErrorField(res, fieldcode);
3549                if (s)
3550                        return PyString_FromString(s);
3551                else
3552                {
3553                        Py_INCREF(Py_None); return Py_None;
3554                }
3555        }
3556
3557        /* attributes list */
3558        if (!strcmp(name, "__members__"))
3559        {
3560                PyObject *list = PyList_New(6);
3561                if (list)
3562                {
3563                        PyList_SET_ITEM(list, 0, PyString_FromString("pgcnx"));
3564                        PyList_SET_ITEM(list, 1, PyString_FromString("severity"));
3565                        PyList_SET_ITEM(list, 2, PyString_FromString("message"));
3566                        PyList_SET_ITEM(list, 3, PyString_FromString("primary"));
3567                        PyList_SET_ITEM(list, 4, PyString_FromString("detail"));
3568                        PyList_SET_ITEM(list, 5, PyString_FromString("hint"));
3569                }
3570                return list;
3571        }
3572
3573        PyErr_Format(PyExc_AttributeError,
3574                "'pgnoticeobject' has no attribute %s", name);
3575        return NULL;
3576}
3577
3578static PyObject *
3579pgnotice_str(pgnoticeobject *self)
3580{
3581        return pgnotice_getattr(self, "message");
3582}
3583
3584/* object type definition */
3585staticforward PyTypeObject PgNoticeType = {
3586        PyObject_HEAD_INIT(NULL)
3587        0,                                                      /* ob_size */
3588        "pgnoticeobject",                       /* tp_name */
3589        sizeof(pgnoticeobject),         /* tp_basicsize */
3590        0,                                                      /* tp_itemsize */
3591        /* methods */
3592        0,                                                              /* tp_dealloc */
3593        0,                                                              /* tp_print */
3594        (getattrfunc) pgnotice_getattr, /* tp_getattr */
3595        0,                                                              /* tp_setattr */
3596        0,                                                              /* tp_compare */
3597        0,                                                              /* tp_repr */
3598        0,                                                              /* tp_as_number */
3599        0,                                                              /* tp_as_sequence */
3600        0,                                                              /* tp_as_mapping */
3601        0,                                                              /* tp_hash */
3602        0,                                                              /* tp_call */
3603        (reprfunc) pgnotice_str                 /* tp_str */
3604};
3605
3606
3607/* query object methods */
3608static struct PyMethodDef pgquery_methods[] = {
3609        {"getresult", (PyCFunction) pgquery_getresult, METH_VARARGS,
3610                        pgquery_getresult__doc__},
3611        {"dictresult", (PyCFunction) pgquery_dictresult, METH_VARARGS,
3612                        pgquery_dictresult__doc__},
3613        {"namedresult", (PyCFunction) pgquery_namedresult, METH_VARARGS,
3614                        pgquery_namedresult__doc__},
3615        {"fieldname", (PyCFunction) pgquery_fieldname, METH_VARARGS,
3616                         pgquery_fieldname__doc__},
3617        {"fieldnum", (PyCFunction) pgquery_fieldnum, METH_VARARGS,
3618                        pgquery_fieldnum__doc__},
3619        {"listfields", (PyCFunction) pgquery_listfields, METH_VARARGS,
3620                        pgquery_listfields__doc__},
3621        {"ntuples", (PyCFunction) pgquery_ntuples, METH_VARARGS,
3622                        pgquery_ntuples__doc__},
3623        {NULL, NULL}
3624};
3625
3626/* gets query object attributes */
3627static PyObject *
3628pgquery_getattr(pgqueryobject *self, char *name)
3629{
3630        /* list postgreSQL connection fields */
3631        return Py_FindMethod(pgquery_methods, (PyObject *) self, name);
3632}
3633
3634/* query type definition */
3635staticforward PyTypeObject PgQueryType = {
3636        PyObject_HEAD_INIT(NULL)
3637        0,                                                              /* ob_size */
3638        "pgqueryobject",                                /* tp_name */
3639        sizeof(pgqueryobject),                  /* tp_basicsize */
3640        0,                                                              /* tp_itemsize */
3641        /* methods */
3642        (destructor) pgquery_dealloc,   /* tp_dealloc */
3643        0,                                                              /* tp_print */
3644        (getattrfunc) pgquery_getattr,  /* tp_getattr */
3645        0,                                                              /* tp_setattr */
3646        0,                                                              /* tp_compare */
3647        (reprfunc) pgquery_repr,                /* tp_repr */
3648        0,                                                              /* tp_as_number */
3649        0,                                                              /* tp_as_sequence */
3650        0,                                                              /* tp_as_mapping */
3651        0,                                                              /* tp_hash */
3652        0,                                                              /* tp_call */
3653        (reprfunc) pgquery_str                  /* tp_str */
3654};
3655
3656
3657/* --------------------------------------------------------------------- */
3658
3659/* MODULE FUNCTIONS */
3660
3661/* escape string */
3662static char escape_string__doc__[] =
3663"escape_string(str) -- escape a string for use within SQL.";
3664
3665static PyObject *
3666escape_string(PyObject *self, PyObject *args)
3667{
3668        char *from; /* our string argument */
3669        char *to=NULL; /* the result */
3670        int from_length; /* length of string */
3671        int to_length; /* length of result */
3672        PyObject *ret; /* string object to return */
3673
3674        if (!PyArg_ParseTuple(args, "s#", &from, &from_length))
3675                return NULL;
3676        to_length = 2*from_length + 1;
3677        if (to_length < from_length) /* overflow */
3678        {
3679                to_length = from_length;
3680                from_length = (from_length - 1)/2;
3681        }
3682        to = (char *)malloc(to_length);
3683        to_length = (int)PQescapeString(to, from, (size_t)from_length);
3684        ret = Py_BuildValue("s#", to, to_length);
3685        if (to)
3686                free(to);
3687        if (!ret) /* pass on exception */
3688                return NULL;
3689        return ret;
3690}
3691
3692/* escape bytea */
3693static char escape_bytea__doc__[] =
3694"escape_bytea(data) -- escape binary data for use within SQL as type bytea.";
3695
3696static PyObject *
3697escape_bytea(PyObject *self, PyObject *args)
3698{
3699        unsigned char *from; /* our string argument */
3700        unsigned char *to; /* the result */
3701        int from_length; /* length of string */
3702        size_t to_length; /* length of result */
3703        PyObject *ret; /* string object to return */
3704
3705        if (!PyArg_ParseTuple(args, "s#", &from, &from_length))
3706                return NULL;
3707        to = PQescapeBytea(from, (int)from_length, &to_length);
3708        ret = Py_BuildValue("s", to);
3709        if (to)
3710                PQfreemem((void *)to);
3711        if (!ret) /* pass on exception */
3712                return NULL;
3713        return ret;
3714}
3715
3716/* unescape bytea */
3717static char unescape_bytea__doc__[] =
3718"unescape_bytea(str) -- unescape bytea data that has been retrieved as text.";
3719
3720static PyObject
3721*unescape_bytea(PyObject *self, PyObject *args)
3722{
3723        unsigned char *from; /* our string argument */
3724        unsigned char *to; /* the result */
3725        size_t to_length; /* length of result string */
3726        PyObject *ret; /* string object to return */
3727
3728        if (!PyArg_ParseTuple(args, "s", &from))
3729                return NULL;
3730        to = PQunescapeBytea(from, &to_length);
3731        ret = Py_BuildValue("s#", to, (int)to_length);
3732        if (to)
3733                PQfreemem((void *)to);
3734        if (!ret) /* pass on exception */
3735                return NULL;
3736        return ret;
3737}
3738
3739/* get decimal point */
3740static char get_decimal_point__doc__[] =
3741"get_decimal_point() -- get decimal point to be used for money values.";
3742
3743static PyObject *
3744get_decimal_point(PyObject *self, PyObject * args)
3745{
3746        PyObject *ret = NULL;
3747        char s[2];
3748
3749        if (PyArg_ParseTuple(args, ""))
3750        {
3751                if (decimal_point)
3752                {
3753                        s[0] = decimal_point; s[1] = '\0';
3754                        ret = PyString_FromString(s);
3755                } else {
3756                        Py_INCREF(Py_None); ret = Py_None;
3757                }
3758        }
3759        else
3760        {
3761                PyErr_SetString(PyExc_TypeError,
3762                        "get_decimal_point() takes no parameter");
3763        }
3764
3765        return ret;
3766}
3767
3768/* set decimal point */
3769static char set_decimal_point__doc__[] =
3770"set_decimal_point(char) -- set decimal point to be used for money values.";
3771
3772static PyObject *
3773set_decimal_point(PyObject *self, PyObject * args)
3774{
3775        PyObject *ret = NULL;
3776        char *s = NULL;
3777
3778        /* gets arguments */
3779        if (PyArg_ParseTuple(args, "z", &s)) {
3780                if (!s)
3781                        s = "\0";
3782                else if (*s && (*(s+1) || !strchr(".,;: '*/_`|", *s)))
3783                        s = NULL;
3784        }
3785
3786        if (s) {
3787                decimal_point = *s;
3788                Py_INCREF(Py_None); ret = Py_None;
3789        } else {
3790                PyErr_SetString(PyExc_TypeError,
3791                        "set_decimal_point() expects a decimal mark character");
3792        }
3793
3794        return ret;
3795}
3796
3797/* get decimal type */
3798static char get_decimal__doc__[] =
3799"get_decimal() -- set a decimal type to be used for numeric values.";
3800
3801static PyObject *
3802get_decimal(PyObject *self, PyObject *args)
3803{
3804        PyObject *ret = NULL;
3805
3806        if (PyArg_ParseTuple(args, ""))
3807        {
3808                ret = decimal ? decimal : Py_None;
3809                Py_INCREF(ret);
3810        }
3811
3812        return ret;
3813}
3814
3815/* set decimal type */
3816static char set_decimal__doc__[] =
3817"set_decimal(cls) -- set a decimal type to be used for numeric values.";
3818
3819static PyObject *
3820set_decimal(PyObject *self, PyObject *args)
3821{
3822        PyObject *ret = NULL;
3823        PyObject *cls;
3824
3825        if (PyArg_ParseTuple(args, "O", &cls))
3826        {
3827                if (cls == Py_None)
3828                {
3829                        Py_XDECREF(decimal); decimal = NULL;
3830                        Py_INCREF(Py_None); ret = Py_None;
3831                }
3832                else if (PyCallable_Check(cls))
3833                {
3834                        Py_XINCREF(cls); Py_XDECREF(decimal); decimal = cls;
3835                        Py_INCREF(Py_None); ret = Py_None;
3836                }
3837                else
3838                        PyErr_SetString(PyExc_TypeError,
3839                                "decimal type must be None or callable");
3840        }
3841
3842        return ret;
3843}
3844
3845/* get usage of bool values */
3846static char get_bool__doc__[] =
3847"get_bool() -- check whether boolean values are converted to bool.";
3848
3849static PyObject *
3850get_bool(PyObject *self, PyObject * args)
3851{
3852        PyObject *ret = NULL;
3853
3854        if (PyArg_ParseTuple(args, ""))
3855        {
3856                ret = use_bool ? Py_True : Py_False;
3857                Py_INCREF(ret);
3858        }
3859
3860        return ret;
3861}
3862
3863/* set usage of bool values */
3864static char set_bool__doc__[] =
3865"set_bool(bool) -- set whether boolean values should be converted to bool.";
3866
3867static PyObject *
3868set_bool(PyObject *self, PyObject * args)
3869{
3870        PyObject *ret = NULL;
3871        int                     i;
3872
3873        /* gets arguments */
3874        if (PyArg_ParseTuple(args, "i", &i))
3875        {
3876                use_bool = i ? 1 : 0;
3877                Py_INCREF(Py_None); ret = Py_None;
3878        }
3879
3880        return ret;
3881}
3882
3883/* get named result factory */
3884static char get_namedresult__doc__[] =
3885"get_namedresult(cls) -- get the function used for getting named results.";
3886
3887static PyObject *
3888get_namedresult(PyObject *self, PyObject *args)
3889{
3890        PyObject *ret = NULL;
3891
3892        if (PyArg_ParseTuple(args, ""))
3893        {
3894                ret = namedresult ? namedresult : Py_None;
3895                Py_INCREF(ret);
3896        }
3897
3898        return ret;
3899}
3900
3901/* set named result factory */
3902static char set_namedresult__doc__[] =
3903"set_namedresult(cls) -- set a function to be used for getting named results.";
3904
3905static PyObject *
3906set_namedresult(PyObject *self, PyObject *args)
3907{
3908        PyObject *ret = NULL;
3909        PyObject *func;
3910
3911        if (PyArg_ParseTuple(args, "O", &func))
3912        {
3913                if (PyCallable_Check(func))
3914                {
3915                        Py_XINCREF(func); Py_XDECREF(namedresult); namedresult = func;
3916                        Py_INCREF(Py_None); ret = Py_None;
3917                }
3918                else
3919                        PyErr_SetString(PyExc_TypeError, "parameter must be callable");
3920        }
3921
3922        return ret;
3923}
3924
3925#ifdef DEFAULT_VARS
3926
3927/* gets default host */
3928static char getdefhost__doc__[] =
3929"get_defhost() -- return default database host.";
3930
3931static PyObject *
3932pggetdefhost(PyObject *self, PyObject *args)
3933{
3934        /* checks args */
3935        if (!PyArg_ParseTuple(args, ""))
3936        {
3937                PyErr_SetString(PyExc_TypeError,
3938                        "method get_defhost() takes no parameter.");
3939                return NULL;
3940        }
3941
3942        Py_XINCREF(pg_default_host);
3943        return pg_default_host;
3944}
3945
3946/* sets default host */
3947static char setdefhost__doc__[] =
3948"set_defhost(string) -- set default database host. Return previous value.";
3949
3950static PyObject *
3951pgsetdefhost(PyObject *self, PyObject *args)
3952{
3953        char       *temp = NULL;
3954        PyObject   *old;
3955
3956        /* gets arguments */
3957        if (!PyArg_ParseTuple(args, "z", &temp))
3958        {
3959                PyErr_SetString(PyExc_TypeError,
3960                        "set_defhost(name), with name (string/None).");
3961                return NULL;
3962        }
3963
3964        /* adjusts value */
3965        old = pg_default_host;
3966
3967        if (temp)
3968                pg_default_host = PyString_FromString(temp);
3969        else
3970        {
3971                Py_INCREF(Py_None);
3972                pg_default_host = Py_None;
3973        }
3974
3975        return old;
3976}
3977
3978/* gets default base */
3979static char getdefbase__doc__[] =
3980"get_defbase() -- return default database name.";
3981
3982static PyObject *
3983pggetdefbase(PyObject *self, PyObject *args)
3984{
3985        /* checks args */
3986        if (!PyArg_ParseTuple(args, ""))
3987        {
3988                PyErr_SetString(PyExc_TypeError,
3989                        "method get_defbase() takes no parameter.");
3990                return NULL;
3991        }
3992
3993        Py_XINCREF(pg_default_base);
3994        return pg_default_base;
3995}
3996
3997/* sets default base */
3998static char setdefbase__doc__[] =
3999"set_defbase(string) -- set default database name. Return previous value";
4000
4001static PyObject *
4002pgsetdefbase(PyObject *self, PyObject *args)
4003{
4004        char       *temp = NULL;
4005        PyObject   *old;
4006
4007        /* gets arguments */
4008        if (!PyArg_ParseTuple(args, "z", &temp))
4009        {
4010                PyErr_SetString(PyExc_TypeError,
4011                        "set_defbase(name), with name (string/None).");
4012                return NULL;
4013        }
4014
4015        /* adjusts value */
4016        old = pg_default_base;
4017
4018        if (temp)
4019                pg_default_base = PyString_FromString(temp);
4020        else
4021        {
4022                Py_INCREF(Py_None);
4023                pg_default_base = Py_None;
4024        }
4025
4026        return old;
4027}
4028
4029/* gets default options */
4030static char getdefopt__doc__[] =
4031"get_defopt() -- return default database options.";
4032
4033static PyObject *
4034pggetdefopt(PyObject *self, PyObject *args)
4035{
4036        /* checks args */
4037        if (!PyArg_ParseTuple(args, ""))
4038        {
4039                PyErr_SetString(PyExc_TypeError,
4040                        "method get_defopt() takes no parameter.");
4041                return NULL;
4042        }
4043
4044        Py_XINCREF(pg_default_opt);
4045        return pg_default_opt;
4046}
4047
4048/* sets default opt */
4049static char setdefopt__doc__[] =
4050"set_defopt(string) -- set default database options. Return previous value.";
4051
4052static PyObject *
4053pgsetdefopt(PyObject *self, PyObject *args)
4054{
4055        char       *temp = NULL;
4056        PyObject   *old;
4057
4058        /* gets arguments */
4059        if (!PyArg_ParseTuple(args, "z", &temp))
4060        {
4061                PyErr_SetString(PyExc_TypeError,
4062                        "set_defopt(name), with name (string/None).");
4063                return NULL;
4064        }
4065
4066        /* adjusts value */
4067        old = pg_default_opt;
4068
4069        if (temp)
4070                pg_default_opt = PyString_FromString(temp);
4071        else
4072        {
4073                Py_INCREF(Py_None);
4074                pg_default_opt = Py_None;
4075        }
4076
4077        return old;
4078}
4079
4080/* gets default tty */
4081static char getdeftty__doc__[] =
4082"get_deftty() -- return default database debug terminal.";
4083
4084static PyObject *
4085pggetdeftty(PyObject *self, PyObject *args)
4086{
4087        /* checks args */
4088        if (!PyArg_ParseTuple(args, ""))
4089        {
4090                PyErr_SetString(PyExc_TypeError,
4091                        "method get_deftty() takes no parameter.");
4092                return NULL;
4093        }
4094
4095        Py_XINCREF(pg_default_tty);
4096        return pg_default_tty;
4097}
4098
4099/* sets default tty */
4100static char setdeftty__doc__[] =
4101"set_deftty(string) -- set default database debug terminal. "
4102"Return previous value.";
4103
4104static PyObject *
4105pgsetdeftty(PyObject *self, PyObject *args)
4106{
4107        char       *temp = NULL;
4108        PyObject   *old;
4109
4110        /* gets arguments */
4111        if (!PyArg_ParseTuple(args, "z", &temp))
4112        {
4113                PyErr_SetString(PyExc_TypeError,
4114                        "set_deftty(name), with name (string/None).");
4115                return NULL;
4116        }
4117
4118        /* adjusts value */
4119        old = pg_default_tty;
4120
4121        if (temp)
4122                pg_default_tty = PyString_FromString(temp);
4123        else
4124        {
4125                Py_INCREF(Py_None);
4126                pg_default_tty = Py_None;
4127        }
4128
4129        return old;
4130}
4131
4132/* gets default username */
4133static char getdefuser__doc__[] =
4134"get_defuser() -- return default database username.";
4135
4136static PyObject *
4137pggetdefuser(PyObject *self, PyObject *args)
4138{
4139        /* checks args */
4140        if (!PyArg_ParseTuple(args, ""))
4141        {
4142                PyErr_SetString(PyExc_TypeError,
4143                        "method get_defuser() takes no parameter.");
4144
4145                return NULL;
4146        }
4147
4148        Py_XINCREF(pg_default_user);
4149        return pg_default_user;
4150}
4151
4152/* sets default username */
4153static char setdefuser__doc__[] =
4154"set_defuser() -- set default database username. Return previous value.";
4155
4156static PyObject *
4157pgsetdefuser(PyObject *self, PyObject *args)
4158{
4159        char       *temp = NULL;
4160        PyObject   *old;
4161
4162        /* gets arguments */
4163        if (!PyArg_ParseTuple(args, "z", &temp))
4164        {
4165                PyErr_SetString(PyExc_TypeError,
4166                        "set_defuser(name), with name (string/None).");
4167                return NULL;
4168        }
4169
4170        /* adjusts value */
4171        old = pg_default_user;
4172
4173        if (temp)
4174                pg_default_user = PyString_FromString(temp);
4175        else
4176        {
4177                Py_INCREF(Py_None);
4178                pg_default_user = Py_None;
4179        }
4180
4181        return old;
4182}
4183
4184/* sets default password */
4185static char setdefpasswd__doc__[] =
4186"set_defpasswd() -- set default database password.";
4187
4188static PyObject *
4189pgsetdefpasswd(PyObject *self, PyObject *args)
4190{
4191        char       *temp = NULL;
4192
4193        /* gets arguments */
4194        if (!PyArg_ParseTuple(args, "z", &temp))
4195        {
4196                PyErr_SetString(PyExc_TypeError,
4197                        "set_defpasswd(password), with password (string/None).");
4198                return NULL;
4199        }
4200
4201        if (temp)
4202                pg_default_passwd = PyString_FromString(temp);
4203        else
4204        {
4205                Py_INCREF(Py_None);
4206                pg_default_passwd = Py_None;
4207        }
4208
4209        Py_INCREF(Py_None);
4210        return Py_None;
4211}
4212
4213/* gets default port */
4214static char getdefport__doc__[] =
4215"get_defport() -- return default database port.";
4216
4217static PyObject *
4218pggetdefport(PyObject *self, PyObject *args)
4219{
4220        /* checks args */
4221        if (!PyArg_ParseTuple(args, ""))
4222        {
4223                PyErr_SetString(PyExc_TypeError,
4224                        "method get_defport() takes no parameter.");
4225                return NULL;
4226        }
4227
4228        Py_XINCREF(pg_default_port);
4229        return pg_default_port;
4230}
4231
4232/* sets default port */
4233static char setdefport__doc__[] =
4234"set_defport(integer) -- set default database port. Return previous value.";
4235
4236static PyObject *
4237pgsetdefport(PyObject *self, PyObject *args)
4238{
4239        long int        port = -2;
4240        PyObject   *old;
4241
4242        /* gets arguments */
4243        if ((!PyArg_ParseTuple(args, "l", &port)) || (port < -1))
4244        {
4245                PyErr_SetString(PyExc_TypeError, "set_defport(port), with port "
4246                        "(positive integer/-1).");
4247                return NULL;
4248        }
4249
4250        /* adjusts value */
4251        old = pg_default_port;
4252
4253        if (port != -1)
4254                pg_default_port = PyInt_FromLong(port);
4255        else
4256        {
4257                Py_INCREF(Py_None);
4258                pg_default_port = Py_None;
4259        }
4260
4261        return old;
4262}
4263#endif /* DEFAULT_VARS */
4264
4265/* List of functions defined in the module */
4266
4267static struct PyMethodDef pg_methods[] = {
4268        {"connect", (PyCFunction) pgconnect, METH_VARARGS|METH_KEYWORDS,
4269                        connect__doc__},
4270        {"escape_string", (PyCFunction) escape_string, METH_VARARGS,
4271                        escape_string__doc__},
4272        {"escape_bytea", (PyCFunction) escape_bytea, METH_VARARGS,
4273                        escape_bytea__doc__},
4274        {"unescape_bytea", (PyCFunction) unescape_bytea, METH_VARARGS,
4275                        unescape_bytea__doc__},
4276        {"get_decimal_point", (PyCFunction) get_decimal_point, METH_VARARGS,
4277                        get_decimal_point__doc__},
4278        {"set_decimal_point", (PyCFunction) set_decimal_point, METH_VARARGS,
4279                        set_decimal_point__doc__},
4280        {"get_decimal", (PyCFunction) get_decimal, METH_VARARGS,
4281                        get_decimal__doc__},
4282        {"set_decimal", (PyCFunction) set_decimal, METH_VARARGS,
4283                        set_decimal__doc__},
4284        {"get_bool", (PyCFunction) get_bool, METH_VARARGS, get_bool__doc__},
4285        {"set_bool", (PyCFunction) set_bool, METH_VARARGS, set_bool__doc__},
4286        {"get_namedresult", (PyCFunction) get_namedresult, METH_VARARGS,
4287                        get_namedresult__doc__},
4288        {"set_namedresult", (PyCFunction) set_namedresult, METH_VARARGS,
4289                        set_namedresult__doc__},
4290
4291#ifdef DEFAULT_VARS
4292        {"get_defhost", pggetdefhost, METH_VARARGS, getdefhost__doc__},
4293        {"set_defhost", pgsetdefhost, METH_VARARGS, setdefhost__doc__},
4294        {"get_defbase", pggetdefbase, METH_VARARGS, getdefbase__doc__},
4295        {"set_defbase", pgsetdefbase, METH_VARARGS, setdefbase__doc__},
4296        {"get_defopt", pggetdefopt, METH_VARARGS, getdefopt__doc__},
4297        {"set_defopt", pgsetdefopt, METH_VARARGS, setdefopt__doc__},
4298        {"get_deftty", pggetdeftty, METH_VARARGS, getdeftty__doc__},
4299        {"set_deftty", pgsetdeftty, METH_VARARGS, setdeftty__doc__},
4300        {"get_defport", pggetdefport, METH_VARARGS, getdefport__doc__},
4301        {"set_defport", pgsetdefport, METH_VARARGS, setdefport__doc__},
4302        {"get_defuser", pggetdefuser, METH_VARARGS, getdefuser__doc__},
4303        {"set_defuser", pgsetdefuser, METH_VARARGS, setdefuser__doc__},
4304        {"set_defpasswd", pgsetdefpasswd, METH_VARARGS, setdefpasswd__doc__},
4305#endif /* DEFAULT_VARS */
4306        {NULL, NULL} /* sentinel */
4307};
4308
4309static char pg__doc__[] = "Python interface to PostgreSQL DB";
4310
4311/* Initialization function for the module */
4312DL_EXPORT(void)
4313init_pg(void)
4314{
4315        PyObject   *mod,
4316                           *dict,
4317                           *v;
4318
4319        /* Initialize here because some WIN platforms get confused otherwise */
4320        PgType.ob_type = PgNoticeType.ob_type =
4321                PgQueryType.ob_type = PgSourceType.ob_type = &PyType_Type;
4322#ifdef LARGE_OBJECTS
4323        PglargeType.ob_type = &PyType_Type;
4324#endif
4325
4326        /* Create the module and add the functions */
4327        mod = Py_InitModule4("_pg", pg_methods, pg__doc__, NULL, PYTHON_API_VERSION);
4328        dict = PyModule_GetDict(mod);
4329
4330        /* Exceptions as defined by DB-API 2.0 */
4331        Error = PyErr_NewException("pg.Error", PyExc_StandardError, NULL);
4332        PyDict_SetItemString(dict, "Error", Error);
4333
4334        Warning = PyErr_NewException("pg.Warning", PyExc_StandardError, NULL);
4335        PyDict_SetItemString(dict, "Warning", Warning);
4336
4337        InterfaceError = PyErr_NewException("pg.InterfaceError", Error, NULL);
4338        PyDict_SetItemString(dict, "InterfaceError", InterfaceError);
4339
4340        DatabaseError = PyErr_NewException("pg.DatabaseError", Error, NULL);
4341        PyDict_SetItemString(dict, "DatabaseError", DatabaseError);
4342
4343        InternalError = PyErr_NewException("pg.InternalError", DatabaseError, NULL);
4344        PyDict_SetItemString(dict, "InternalError", InternalError);
4345
4346        OperationalError =
4347                PyErr_NewException("pg.OperationalError", DatabaseError, NULL);
4348        PyDict_SetItemString(dict, "OperationalError", OperationalError);
4349
4350        ProgrammingError =
4351                PyErr_NewException("pg.ProgrammingError", DatabaseError, NULL);
4352        PyDict_SetItemString(dict, "ProgrammingError", ProgrammingError);
4353
4354        IntegrityError =
4355                PyErr_NewException("pg.IntegrityError", DatabaseError, NULL);
4356        PyDict_SetItemString(dict, "IntegrityError", IntegrityError);
4357
4358        DataError = PyErr_NewException("pg.DataError", DatabaseError, NULL);
4359        PyDict_SetItemString(dict, "DataError", DataError);
4360
4361        NotSupportedError =
4362                PyErr_NewException("pg.NotSupportedError", DatabaseError, NULL);
4363        PyDict_SetItemString(dict, "NotSupportedError", NotSupportedError);
4364
4365        /* Make the version available */
4366        v = PyString_FromString(PyPgVersion);
4367        PyDict_SetItemString(dict, "version", v);
4368        PyDict_SetItemString(dict, "__version__", v);
4369        Py_DECREF(v);
4370
4371        /* results type for queries */
4372        PyDict_SetItemString(dict, "RESULT_EMPTY", PyInt_FromLong(RESULT_EMPTY));
4373        PyDict_SetItemString(dict, "RESULT_DML", PyInt_FromLong(RESULT_DML));
4374        PyDict_SetItemString(dict, "RESULT_DDL", PyInt_FromLong(RESULT_DDL));
4375        PyDict_SetItemString(dict, "RESULT_DQL", PyInt_FromLong(RESULT_DQL));
4376
4377        /* transaction states */
4378        PyDict_SetItemString(dict,"TRANS_IDLE",PyInt_FromLong(PQTRANS_IDLE));
4379        PyDict_SetItemString(dict,"TRANS_ACTIVE",PyInt_FromLong(PQTRANS_ACTIVE));
4380        PyDict_SetItemString(dict,"TRANS_INTRANS",PyInt_FromLong(PQTRANS_INTRANS));
4381        PyDict_SetItemString(dict,"TRANS_INERROR",PyInt_FromLong(PQTRANS_INERROR));
4382        PyDict_SetItemString(dict,"TRANS_UNKNOWN",PyInt_FromLong(PQTRANS_UNKNOWN));
4383
4384#ifdef LARGE_OBJECTS
4385        /* create mode for large objects */
4386        PyDict_SetItemString(dict, "INV_READ", PyInt_FromLong(INV_READ));
4387        PyDict_SetItemString(dict, "INV_WRITE", PyInt_FromLong(INV_WRITE));
4388
4389        /* position flags for lo_lseek */
4390        PyDict_SetItemString(dict, "SEEK_SET", PyInt_FromLong(SEEK_SET));
4391        PyDict_SetItemString(dict, "SEEK_CUR", PyInt_FromLong(SEEK_CUR));
4392        PyDict_SetItemString(dict, "SEEK_END", PyInt_FromLong(SEEK_END));
4393#endif /* LARGE_OBJECTS */
4394
4395#ifdef DEFAULT_VARS
4396        /* prepares default values */
4397        Py_INCREF(Py_None);
4398        pg_default_host = Py_None;
4399        Py_INCREF(Py_None);
4400        pg_default_base = Py_None;
4401        Py_INCREF(Py_None);
4402        pg_default_opt = Py_None;
4403        Py_INCREF(Py_None);
4404        pg_default_port = Py_None;
4405        Py_INCREF(Py_None);
4406        pg_default_tty = Py_None;
4407        Py_INCREF(Py_None);
4408        pg_default_user = Py_None;
4409        Py_INCREF(Py_None);
4410        pg_default_passwd = Py_None;
4411#endif /* DEFAULT_VARS */
4412
4413        /* Check for errors */
4414        if (PyErr_Occurred())
4415                Py_FatalError("can't initialize module _pg");
4416}
Note: See TracBrowser for help on using the repository browser.