granicus.if.org Git - postgresql/blob - src/pl/plpython/plpython.c

   1 /**********************************************************************
   2  * plpython.c - python as a procedural language for PostgreSQL
   3  *
   4  *      $PostgreSQL: pgsql/src/pl/plpython/plpython.c,v 1.119 2009/03/26 22:26:08 petere Exp $
   5  *
   6  *********************************************************************
   7  */
   8
   9 #if defined(_MSC_VER) && defined(_DEBUG)
  10 /* Python uses #pragma to bring in a non-default libpython on VC++ if
  11  * _DEBUG is defined */
  12 #undef _DEBUG
  13 /* Also hide away errcode, since we load Python.h before postgres.h */
  14 #define errcode __msvc_errcode
  15 #include <Python.h>
  16 #undef errcode
  17 #define _DEBUG
  18 #elif defined (_MSC_VER)
  19 #define errcode __msvc_errcode
  20 #include <Python.h>
  21 #undef errcode
  22 #else
  23 #include <Python.h>
  24 #endif
  25
  26 /*
  27  * Py_ssize_t compat for Python <= 2.4
  28  */
  29 #if PY_VERSION_HEX < 0x02050000 && !defined(PY_SSIZE_T_MIN)
  30 typedef int Py_ssize_t;
  31
  32 #define PY_SSIZE_T_MAX INT_MAX
  33 #define PY_SSIZE_T_MIN INT_MIN
  34 #endif
  35
  36 /*
  37  * PyBool_FromLong is supported from 2.3.
  38  */
  39 #if PY_VERSION_HEX < 0x02030000
  40 #define PyBool_FromLong(x) PyInt_FromLong(x)
  41 #endif
  42
  43
  44 #include "postgres.h"
  45
  46 /* system stuff */
  47 #include <unistd.h>
  48 #include <fcntl.h>
  49
  50 /* postgreSQL stuff */
  51 #include "catalog/pg_proc.h"
  52 #include "catalog/pg_type.h"
  53 #include "commands/trigger.h"
  54 #include "executor/spi.h"
  55 #include "funcapi.h"
  56 #include "fmgr.h"
  57 #include "miscadmin.h"
  58 #include "nodes/makefuncs.h"
  59 #include "parser/parse_type.h"
  60 #include "tcop/tcopprot.h"
  61 #include "utils/builtins.h"
  62 #include "utils/lsyscache.h"
  63 #include "utils/memutils.h"
  64 #include "utils/syscache.h"
  65 #include "utils/typcache.h"
  66
  67 /* define our text domain for translations */
  68 #undef TEXTDOMAIN
  69 #define TEXTDOMAIN PG_TEXTDOMAIN("plpython")
  70
  71 #include <compile.h>
  72 #include <eval.h>
  73
  74 PG_MODULE_MAGIC;
  75
  76 /* convert Postgresql Datum or tuple into a PyObject.
  77  * input to Python.  Tuples are converted to dictionary
  78  * objects.
  79  */
  80
  81 typedef PyObject *(*PLyDatumToObFunc) (const char *);
  82
  83 typedef struct PLyDatumToOb
  84 {
  85         PLyDatumToObFunc func;
  86         FmgrInfo        typfunc;                /* The type's output function */
  87         Oid                     typoid;                 /* The OID of the type */
  88         Oid                     typioparam;
  89         bool            typbyval;
  90 }       PLyDatumToOb;
  91
  92 typedef struct PLyTupleToOb
  93 {
  94         PLyDatumToOb *atts;
  95         int                     natts;
  96 }       PLyTupleToOb;
  97
  98 typedef union PLyTypeInput
  99 {
 100         PLyDatumToOb d;
 101         PLyTupleToOb r;
 102 }       PLyTypeInput;
 103
 104 /* convert PyObject to a Postgresql Datum or tuple.
 105  * output from Python
 106  */
 107 typedef struct PLyObToDatum
 108 {
 109         FmgrInfo        typfunc;                /* The type's input function */
 110         Oid                     typoid;                 /* The OID of the type */
 111         Oid                     typioparam;
 112         bool            typbyval;
 113 }       PLyObToDatum;
 114
 115 typedef struct PLyObToTuple
 116 {
 117         PLyObToDatum *atts;
 118         int                     natts;
 119 }       PLyObToTuple;
 120
 121 typedef union PLyTypeOutput
 122 {
 123         PLyObToDatum d;
 124         PLyObToTuple r;
 125 }       PLyTypeOutput;
 126
 127 /* all we need to move Postgresql data to Python objects,
 128  * and vis versa
 129  */
 130 typedef struct PLyTypeInfo
 131 {
 132         PLyTypeInput in;
 133         PLyTypeOutput out;
 134         int                     is_rowtype;
 135
 136         /*
 137          * is_rowtype can be: -1  not known yet (initial state) 0  scalar datatype
 138          * 1  rowtype 2  rowtype, but I/O functions not set up yet
 139          */
 140 }       PLyTypeInfo;
 141
 142
 143 /* cached procedure data */
 144 typedef struct PLyProcedure
 145 {
 146         char       *proname;            /* SQL name of procedure */
 147         char       *pyname;                     /* Python name of procedure */
 148         TransactionId fn_xmin;
 149         ItemPointerData fn_tid;
 150         bool            fn_readonly;
 151         PLyTypeInfo result;                     /* also used to store info for trigger tuple
 152                                                                  * type */
 153         bool            is_setof;               /* true, if procedure returns result set */
 154         PyObject   *setof;                      /* contents of result set. */
 155         char      **argnames;           /* Argument names */
 156         PLyTypeInfo args[FUNC_MAX_ARGS];
 157         int                     nargs;
 158         PyObject   *code;                       /* compiled procedure code */
 159         PyObject   *statics;            /* data saved across calls, local scope */
 160         PyObject   *globals;            /* data saved across calls, global scope */
 161         PyObject   *me;                         /* PyCObject containing pointer to this
 162                                                                  * PLyProcedure */
 163 }       PLyProcedure;
 164
 165
 166 /* Python objects */
 167 typedef struct PLyPlanObject
 168 {
 169         PyObject_HEAD
 170         void       *plan;                       /* return of an SPI_saveplan */
 171         int                     nargs;
 172         Oid                *types;
 173         Datum      *values;
 174         PLyTypeInfo *args;
 175 }       PLyPlanObject;
 176
 177 typedef struct PLyResultObject
 178 {
 179         PyObject_HEAD
 180         /* HeapTuple *tuples; */
 181         PyObject * nrows;                       /* number of rows returned by query */
 182         PyObject   *rows;                       /* data rows, or None if no data returned */
 183         PyObject   *status;                     /* query status, SPI_OK_*, or SPI_ERR_* */
 184 }       PLyResultObject;
 185
 186
 187 /* function declarations */
 188
 189 /* Two exported functions: first is the magic telling Postgresql
 190  * what function call interface it implements. Second is for
 191  * initialization of the interpreter during library load.
 192  */
 193 Datum           plpython_call_handler(PG_FUNCTION_ARGS);
 194 void            _PG_init(void);
 195
 196 PG_FUNCTION_INFO_V1(plpython_call_handler);
 197
 198 /* most of the remaining of the declarations, all static */
 199
 200 /* these should only be called once at the first call
 201  * of plpython_call_handler.  initialize the python interpreter
 202  * and global data.
 203  */
 204 static void PLy_init_interp(void);
 205 static void PLy_init_plpy(void);
 206
 207 /* call PyErr_SetString with a vprint interface and translation support */
 208 static void
 209 PLy_exception_set(PyObject *, const char *,...)
 210 __attribute__((format(printf, 2, 3)));
 211
 212 /* Get the innermost python procedure called from the backend */
 213 static char *PLy_procedure_name(PLyProcedure *);
 214
 215 /* some utility functions */
 216 static void PLy_elog(int, const char *,...)
 217 __attribute__((format(printf, 2, 3)));
 218 static char *PLy_traceback(int *);
 219
 220 static void *PLy_malloc(size_t);
 221 static void *PLy_malloc0(size_t);
 222 static char *PLy_strdup(const char *);
 223 static void PLy_free(void *);
 224
 225 /* sub handlers for functions and triggers */
 226 static Datum PLy_function_handler(FunctionCallInfo fcinfo, PLyProcedure *);
 227 static HeapTuple PLy_trigger_handler(FunctionCallInfo fcinfo, PLyProcedure *);
 228
 229 static PyObject *PLy_function_build_args(FunctionCallInfo fcinfo, PLyProcedure *);
 230 static void PLy_function_delete_args(PLyProcedure *);
 231 static PyObject *PLy_trigger_build_args(FunctionCallInfo fcinfo, PLyProcedure *,
 232                                            HeapTuple *);
 233 static HeapTuple PLy_modify_tuple(PLyProcedure *, PyObject *,
 234                                  TriggerData *, HeapTuple);
 235
 236 static PyObject *PLy_procedure_call(PLyProcedure *, char *, PyObject *);
 237
 238 static PLyProcedure *PLy_procedure_get(FunctionCallInfo fcinfo,
 239                                   Oid tgreloid);
 240
 241 static PLyProcedure *PLy_procedure_create(HeapTuple procTup, Oid tgreloid,
 242                                                                                   char *key);
 243
 244 static void PLy_procedure_compile(PLyProcedure *, const char *);
 245 static char *PLy_procedure_munge_source(const char *, const char *);
 246 static void PLy_procedure_delete(PLyProcedure *);
 247
 248 static void PLy_typeinfo_init(PLyTypeInfo *);
 249 static void PLy_typeinfo_dealloc(PLyTypeInfo *);
 250 static void PLy_output_datum_func(PLyTypeInfo *, HeapTuple);
 251 static void PLy_output_datum_func2(PLyObToDatum *, HeapTuple);
 252 static void PLy_input_datum_func(PLyTypeInfo *, Oid, HeapTuple);
 253 static void PLy_input_datum_func2(PLyDatumToOb *, Oid, HeapTuple);
 254 static void PLy_output_tuple_funcs(PLyTypeInfo *, TupleDesc);
 255 static void PLy_input_tuple_funcs(PLyTypeInfo *, TupleDesc);
 256
 257 /* conversion functions */
 258 static PyObject *PLyDict_FromTuple(PLyTypeInfo *, HeapTuple, TupleDesc);
 259 static PyObject *PLyBool_FromString(const char *);
 260 static PyObject *PLyFloat_FromString(const char *);
 261 static PyObject *PLyInt_FromString(const char *);
 262 static PyObject *PLyLong_FromString(const char *);
 263 static PyObject *PLyString_FromString(const char *);
 264
 265 static HeapTuple PLyMapping_ToTuple(PLyTypeInfo *, PyObject *);
 266 static HeapTuple PLySequence_ToTuple(PLyTypeInfo *, PyObject *);
 267 static HeapTuple PLyObject_ToTuple(PLyTypeInfo *, PyObject *);
 268
 269 /*
 270  * Currently active plpython function
 271  */
 272 static PLyProcedure *PLy_curr_procedure = NULL;
 273
 274 /*
 275  * When a callback from Python into PG incurs an error, we temporarily store
 276  * the error information here, and return NULL to the Python interpreter.
 277  * Any further callback attempts immediately fail, and when the Python
 278  * interpreter returns to the calling function, we re-throw the error (even if
 279  * Python thinks it trapped the error and doesn't return NULL).  Eventually
 280  * this ought to be improved to let Python code really truly trap the error,
 281  * but that's more of a change from the pre-8.0 semantics than I have time for
 282  * now --- it will only be possible if the callback query is executed inside a
 283  * subtransaction.
 284  */
 285 static ErrorData *PLy_error_in_progress = NULL;
 286
 287 static PyObject *PLy_interp_globals = NULL;
 288 static PyObject *PLy_interp_safe_globals = NULL;
 289 static PyObject *PLy_procedure_cache = NULL;
 290
 291 /* Python exceptions */
 292 static PyObject *PLy_exc_error = NULL;
 293 static PyObject *PLy_exc_fatal = NULL;
 294 static PyObject *PLy_exc_spi_error = NULL;
 295
 296 /* some globals for the python module */
 297 static char PLy_plan_doc[] = {
 298         "Store a PostgreSQL plan"
 299 };
 300
 301 static char PLy_result_doc[] = {
 302         "Results of a PostgreSQL query"
 303 };
 304
 305
 306 /*
 307  * the function definitions
 308  */
 309
 310 /*
 311  * This routine is a crock, and so is everyplace that calls it.  The problem
 312  * is that the cached form of plpython functions/queries is allocated permanently
 313  * (mostly via malloc()) and never released until backend exit.  Subsidiary
 314  * data structures such as fmgr info records therefore must live forever
 315  * as well.  A better implementation would store all this stuff in a per-
 316  * function memory context that could be reclaimed at need.  In the meantime,
 317  * fmgr_info_cxt must be called specifying TopMemoryContext so that whatever
 318  * it might allocate, and whatever the eventual function might allocate using
 319  * fn_mcxt, will live forever too.
 320  */
 321 static void
 322 perm_fmgr_info(Oid functionId, FmgrInfo *finfo)
 323 {
 324         fmgr_info_cxt(functionId, finfo, TopMemoryContext);
 325 }
 326
 327 Datum
 328 plpython_call_handler(PG_FUNCTION_ARGS)
 329 {
 330         Datum           retval;
 331         PLyProcedure *save_curr_proc;
 332         PLyProcedure *volatile proc = NULL;
 333
 334         if (SPI_connect() != SPI_OK_CONNECT)
 335                 elog(ERROR, "SPI_connect failed");
 336
 337         save_curr_proc = PLy_curr_procedure;
 338
 339         PG_TRY();
 340         {
 341                 if (CALLED_AS_TRIGGER(fcinfo))
 342                 {
 343                         TriggerData *tdata = (TriggerData *) fcinfo->context;
 344                         HeapTuple       trv;
 345
 346                         proc = PLy_procedure_get(fcinfo,
 347                                                                          RelationGetRelid(tdata->tg_relation));
 348                         PLy_curr_procedure = proc;
 349                         trv = PLy_trigger_handler(fcinfo, proc);
 350                         retval = PointerGetDatum(trv);
 351                 }
 352                 else
 353                 {
 354                         proc = PLy_procedure_get(fcinfo, InvalidOid);
 355                         PLy_curr_procedure = proc;
 356                         retval = PLy_function_handler(fcinfo, proc);
 357                 }
 358         }
 359         PG_CATCH();
 360         {
 361                 PLy_curr_procedure = save_curr_proc;
 362                 if (proc)
 363                 {
 364                         /* note: Py_DECREF needs braces around it, as of 2003/08 */
 365                         Py_DECREF(proc->me);
 366                 }
 367                 PyErr_Clear();
 368                 PG_RE_THROW();
 369         }
 370         PG_END_TRY();
 371
 372         PLy_curr_procedure = save_curr_proc;
 373
 374         Py_DECREF(proc->me);
 375
 376         return retval;
 377 }
 378
 379 /* trigger and function sub handlers
 380  *
 381  * the python function is expected to return Py_None if the tuple is
 382  * acceptable and unmodified.  Otherwise it should return a PyString
 383  * object who's value is SKIP, or MODIFY.  SKIP means don't perform
 384  * this action.  MODIFY means the tuple has been modified, so update
 385  * tuple and perform action.  SKIP and MODIFY assume the trigger fires
 386  * BEFORE the event and is ROW level.  postgres expects the function
 387  * to take no arguments and return an argument of type trigger.
 388  */
 389 static HeapTuple
 390 PLy_trigger_handler(FunctionCallInfo fcinfo, PLyProcedure * proc)
 391 {
 392         HeapTuple       rv = NULL;
 393         PyObject   *volatile plargs = NULL;
 394         PyObject   *volatile plrv = NULL;
 395
 396         PG_TRY();
 397         {
 398                 plargs = PLy_trigger_build_args(fcinfo, proc, &rv);
 399                 plrv = PLy_procedure_call(proc, "TD", plargs);
 400
 401                 Assert(plrv != NULL);
 402                 Assert(!PLy_error_in_progress);
 403
 404                 /*
 405                  * Disconnect from SPI manager
 406                  */
 407                 if (SPI_finish() != SPI_OK_FINISH)
 408                         elog(ERROR, "SPI_finish failed");
 409
 410                 /*
 411                  * return of None means we're happy with the tuple
 412                  */
 413                 if (plrv != Py_None)
 414                 {
 415                         char       *srv;
 416
 417                         if (!PyString_Check(plrv))
 418                                 ereport(ERROR,
 419                                                 (errcode(ERRCODE_DATA_EXCEPTION),
 420                                         errmsg("unexpected return value from trigger procedure"),
 421                                                  errdetail("Expected None or a string.")));
 422
 423                         srv = PyString_AsString(plrv);
 424                         if (pg_strcasecmp(srv, "SKIP") == 0)
 425                                 rv = NULL;
 426                         else if (pg_strcasecmp(srv, "MODIFY") == 0)
 427                         {
 428                                 TriggerData *tdata = (TriggerData *) fcinfo->context;
 429
 430                                 if (TRIGGER_FIRED_BY_INSERT(tdata->tg_event) ||
 431                                         TRIGGER_FIRED_BY_UPDATE(tdata->tg_event))
 432                                         rv = PLy_modify_tuple(proc, plargs, tdata, rv);
 433                                 else
 434                                         ereport(WARNING,
 435                                                         (errmsg("PL/Python trigger function returned \"MODIFY\" in a DELETE trigger -- ignored")));
 436                         }
 437                         else if (pg_strcasecmp(srv, "OK") != 0)
 438                         {
 439                                 /*
 440                                  * accept "OK" as an alternative to None; otherwise, raise an
 441                                  * error
 442                                  */
 443                                 ereport(ERROR,
 444                                                 (errcode(ERRCODE_DATA_EXCEPTION),
 445                                         errmsg("unexpected return value from trigger procedure"),
 446                                                  errdetail("Expected None, \"OK\", \"SKIP\", or \"MODIFY\".")));
 447                         }
 448                 }
 449         }
 450         PG_CATCH();
 451         {
 452                 Py_XDECREF(plargs);
 453                 Py_XDECREF(plrv);
 454
 455                 PG_RE_THROW();
 456         }
 457         PG_END_TRY();
 458
 459         Py_DECREF(plargs);
 460         Py_DECREF(plrv);
 461
 462         return rv;
 463 }
 464
 465 static HeapTuple
 466 PLy_modify_tuple(PLyProcedure * proc, PyObject * pltd, TriggerData *tdata,
 467                                  HeapTuple otup)
 468 {
 469         PyObject   *volatile plntup;
 470         PyObject   *volatile plkeys;
 471         PyObject   *volatile platt;
 472         PyObject   *volatile plval;
 473         PyObject   *volatile plstr;
 474         HeapTuple       rtup;
 475         int                     natts,
 476                                 i,
 477                                 attn,
 478                                 atti;
 479         int                *volatile modattrs;
 480         Datum      *volatile modvalues;
 481         char       *volatile modnulls;
 482         TupleDesc       tupdesc;
 483
 484         plntup = plkeys = platt = plval = plstr = NULL;
 485         modattrs = NULL;
 486         modvalues = NULL;
 487         modnulls = NULL;
 488
 489         PG_TRY();
 490         {
 491                 if ((plntup = PyDict_GetItemString(pltd, "new")) == NULL)
 492                         ereport(ERROR,
 493                                         (errmsg("TD[\"new\"] deleted, cannot modify row")));
 494                 if (!PyDict_Check(plntup))
 495                         ereport(ERROR,
 496                                         (errmsg("TD[\"new\"] is not a dictionary")));
 497                 Py_INCREF(plntup);
 498
 499                 plkeys = PyDict_Keys(plntup);
 500                 natts = PyList_Size(plkeys);
 501
 502                 modattrs = (int *) palloc(natts * sizeof(int));
 503                 modvalues = (Datum *) palloc(natts * sizeof(Datum));
 504                 modnulls = (char *) palloc(natts * sizeof(char));
 505
 506                 tupdesc = tdata->tg_relation->rd_att;
 507
 508                 for (i = 0; i < natts; i++)
 509                 {
 510                         char       *src;
 511
 512                         platt = PyList_GetItem(plkeys, i);
 513                         if (!PyString_Check(platt))
 514                                 ereport(ERROR,
 515                                                 (errmsg("name of TD[\"new\"] attribute at ordinal position %d is not a string", i)));
 516                         attn = SPI_fnumber(tupdesc, PyString_AsString(platt));
 517                         if (attn == SPI_ERROR_NOATTRIBUTE)
 518                                 ereport(ERROR,
 519                                                 (errmsg("key \"%s\" found in TD[\"new\"] does not exist as a column in the triggering row",
 520                                                                 PyString_AsString(platt))));
 521                         atti = attn - 1;
 522
 523                         plval = PyDict_GetItem(plntup, platt);
 524                         if (plval == NULL)
 525                                 elog(FATAL, "Python interpreter is probably corrupted");
 526
 527                         Py_INCREF(plval);
 528
 529                         modattrs[i] = attn;
 530
 531                         if (tupdesc->attrs[atti]->attisdropped)
 532                         {
 533                                 modvalues[i] = (Datum) 0;
 534                                 modnulls[i] = 'n';
 535                         }
 536                         else if (plval != Py_None)
 537                         {
 538                                 plstr = PyObject_Str(plval);
 539                                 if (!plstr)
 540                                         PLy_elog(ERROR, "could not compute string representation of Python object in PL/Python function \"%s\" while modifying trigger row",
 541                                                          proc->proname);
 542                                 src = PyString_AsString(plstr);
 543
 544                                 modvalues[i] =
 545                                         InputFunctionCall(&proc->result.out.r.atts[atti].typfunc,
 546                                                                           src,
 547                                                                         proc->result.out.r.atts[atti].typioparam,
 548                                                                           tupdesc->attrs[atti]->atttypmod);
 549                                 modnulls[i] = ' ';
 550
 551                                 Py_DECREF(plstr);
 552                                 plstr = NULL;
 553                         }
 554                         else
 555                         {
 556                                 modvalues[i] =
 557                                         InputFunctionCall(&proc->result.out.r.atts[atti].typfunc,
 558                                                                           NULL,
 559                                                                         proc->result.out.r.atts[atti].typioparam,
 560                                                                           tupdesc->attrs[atti]->atttypmod);
 561                                 modnulls[i] = 'n';
 562                         }
 563
 564                         Py_DECREF(plval);
 565                         plval = NULL;
 566                 }
 567
 568                 rtup = SPI_modifytuple(tdata->tg_relation, otup, natts,
 569                                                            modattrs, modvalues, modnulls);
 570                 if (rtup == NULL)
 571                         elog(ERROR, "SPI_modifytuple failed: error %d", SPI_result);
 572         }
 573         PG_CATCH();
 574         {
 575                 Py_XDECREF(plntup);
 576                 Py_XDECREF(plkeys);
 577                 Py_XDECREF(plval);
 578                 Py_XDECREF(plstr);
 579
 580                 if (modnulls)
 581                         pfree(modnulls);
 582                 if (modvalues)
 583                         pfree(modvalues);
 584                 if (modattrs)
 585                         pfree(modattrs);
 586
 587                 PG_RE_THROW();
 588         }
 589         PG_END_TRY();
 590
 591         Py_DECREF(plntup);
 592         Py_DECREF(plkeys);
 593
 594         pfree(modattrs);
 595         pfree(modvalues);
 596         pfree(modnulls);
 597
 598         return rtup;
 599 }
 600
 601 static PyObject *
 602 PLy_trigger_build_args(FunctionCallInfo fcinfo, PLyProcedure * proc, HeapTuple *rv)
 603 {
 604         TriggerData *tdata = (TriggerData *) fcinfo->context;
 605         PyObject   *pltname,
 606                            *pltevent,
 607                            *pltwhen,
 608                            *pltlevel,
 609                            *pltrelid,
 610                            *plttablename,
 611                            *plttableschema;
 612         PyObject   *pltargs,
 613                            *pytnew,
 614                            *pytold;
 615         PyObject   *volatile pltdata = NULL;
 616         char       *stroid;
 617
 618         PG_TRY();
 619         {
 620                 pltdata = PyDict_New();
 621                 if (!pltdata)
 622                         PLy_elog(ERROR, "could not create new dictionary while building trigger arguments");
 623
 624                 pltname = PyString_FromString(tdata->tg_trigger->tgname);
 625                 PyDict_SetItemString(pltdata, "name", pltname);
 626                 Py_DECREF(pltname);
 627
 628                 stroid = DatumGetCString(DirectFunctionCall1(oidout,
 629                                                            ObjectIdGetDatum(tdata->tg_relation->rd_id)));
 630                 pltrelid = PyString_FromString(stroid);
 631                 PyDict_SetItemString(pltdata, "relid", pltrelid);
 632                 Py_DECREF(pltrelid);
 633                 pfree(stroid);
 634
 635                 stroid = SPI_getrelname(tdata->tg_relation);
 636                 plttablename = PyString_FromString(stroid);
 637                 PyDict_SetItemString(pltdata, "table_name", plttablename);
 638                 Py_DECREF(plttablename);
 639                 pfree(stroid);
 640
 641                 stroid = SPI_getnspname(tdata->tg_relation);
 642                 plttableschema = PyString_FromString(stroid);
 643                 PyDict_SetItemString(pltdata, "table_schema", plttableschema);
 644                 Py_DECREF(plttableschema);
 645                 pfree(stroid);
 646
 647
 648                 if (TRIGGER_FIRED_BEFORE(tdata->tg_event))
 649                         pltwhen = PyString_FromString("BEFORE");
 650                 else if (TRIGGER_FIRED_AFTER(tdata->tg_event))
 651                         pltwhen = PyString_FromString("AFTER");
 652                 else
 653                 {
 654                         elog(ERROR, "unrecognized WHEN tg_event: %u", tdata->tg_event);
 655                         pltwhen = NULL;         /* keep compiler quiet */
 656                 }
 657                 PyDict_SetItemString(pltdata, "when", pltwhen);
 658                 Py_DECREF(pltwhen);
 659
 660                 if (TRIGGER_FIRED_FOR_ROW(tdata->tg_event))
 661                 {
 662                         pltlevel = PyString_FromString("ROW");
 663                         PyDict_SetItemString(pltdata, "level", pltlevel);
 664                         Py_DECREF(pltlevel);
 665
 666                         if (TRIGGER_FIRED_BY_INSERT(tdata->tg_event))
 667                         {
 668                                 pltevent = PyString_FromString("INSERT");
 669
 670                                 PyDict_SetItemString(pltdata, "old", Py_None);
 671                                 pytnew = PLyDict_FromTuple(&(proc->result), tdata->tg_trigtuple,
 672                                                                                    tdata->tg_relation->rd_att);
 673                                 PyDict_SetItemString(pltdata, "new", pytnew);
 674                                 Py_DECREF(pytnew);
 675                                 *rv = tdata->tg_trigtuple;
 676                         }
 677                         else if (TRIGGER_FIRED_BY_DELETE(tdata->tg_event))
 678                         {
 679                                 pltevent = PyString_FromString("DELETE");
 680
 681                                 PyDict_SetItemString(pltdata, "new", Py_None);
 682                                 pytold = PLyDict_FromTuple(&(proc->result), tdata->tg_trigtuple,
 683                                                                                    tdata->tg_relation->rd_att);
 684                                 PyDict_SetItemString(pltdata, "old", pytold);
 685                                 Py_DECREF(pytold);
 686                                 *rv = tdata->tg_trigtuple;
 687                         }
 688                         else if (TRIGGER_FIRED_BY_UPDATE(tdata->tg_event))
 689                         {
 690                                 pltevent = PyString_FromString("UPDATE");
 691
 692                                 pytnew = PLyDict_FromTuple(&(proc->result), tdata->tg_newtuple,
 693                                                                                    tdata->tg_relation->rd_att);
 694                                 PyDict_SetItemString(pltdata, "new", pytnew);
 695                                 Py_DECREF(pytnew);
 696                                 pytold = PLyDict_FromTuple(&(proc->result), tdata->tg_trigtuple,
 697                                                                                    tdata->tg_relation->rd_att);
 698                                 PyDict_SetItemString(pltdata, "old", pytold);
 699                                 Py_DECREF(pytold);
 700                                 *rv = tdata->tg_newtuple;
 701                         }
 702                         else
 703                         {
 704                                 elog(ERROR, "unrecognized OP tg_event: %u", tdata->tg_event);
 705                                 pltevent = NULL;        /* keep compiler quiet */
 706                         }
 707
 708                         PyDict_SetItemString(pltdata, "event", pltevent);
 709                         Py_DECREF(pltevent);
 710                 }
 711                 else if (TRIGGER_FIRED_FOR_STATEMENT(tdata->tg_event))
 712                 {
 713                         pltlevel = PyString_FromString("STATEMENT");
 714                         PyDict_SetItemString(pltdata, "level", pltlevel);
 715                         Py_DECREF(pltlevel);
 716
 717                         PyDict_SetItemString(pltdata, "old", Py_None);
 718                         PyDict_SetItemString(pltdata, "new", Py_None);
 719                         *rv = NULL;
 720
 721                         if (TRIGGER_FIRED_BY_INSERT(tdata->tg_event))
 722                                 pltevent = PyString_FromString("INSERT");
 723                         else if (TRIGGER_FIRED_BY_DELETE(tdata->tg_event))
 724                                 pltevent = PyString_FromString("DELETE");
 725                         else if (TRIGGER_FIRED_BY_UPDATE(tdata->tg_event))
 726                                 pltevent = PyString_FromString("UPDATE");
 727                         else if (TRIGGER_FIRED_BY_TRUNCATE(tdata->tg_event))
 728                                 pltevent = PyString_FromString("TRUNCATE");
 729                         else
 730                         {
 731                                 elog(ERROR, "unrecognized OP tg_event: %u", tdata->tg_event);
 732                                 pltevent = NULL;        /* keep compiler quiet */
 733                         }
 734
 735                         PyDict_SetItemString(pltdata, "event", pltevent);
 736                         Py_DECREF(pltevent);
 737                 }
 738                 else
 739                         elog(ERROR, "unrecognized LEVEL tg_event: %u", tdata->tg_event);
 740
 741                 if (tdata->tg_trigger->tgnargs)
 742                 {
 743                         /*
 744                          * all strings...
 745                          */
 746                         int                     i;
 747                         PyObject   *pltarg;
 748
 749                         pltargs = PyList_New(tdata->tg_trigger->tgnargs);
 750                         for (i = 0; i < tdata->tg_trigger->tgnargs; i++)
 751                         {
 752                                 pltarg = PyString_FromString(tdata->tg_trigger->tgargs[i]);
 753
 754                                 /*
 755                                  * stolen, don't Py_DECREF
 756                                  */
 757                                 PyList_SetItem(pltargs, i, pltarg);
 758                         }
 759                 }
 760                 else
 761                 {
 762                         Py_INCREF(Py_None);
 763                         pltargs = Py_None;
 764                 }
 765                 PyDict_SetItemString(pltdata, "args", pltargs);
 766                 Py_DECREF(pltargs);
 767         }
 768         PG_CATCH();
 769         {
 770                 Py_XDECREF(pltdata);
 771                 PG_RE_THROW();
 772         }
 773         PG_END_TRY();
 774
 775         return pltdata;
 776 }
 777
 778
 779
 780 /* function handler and friends */
 781 static Datum
 782 PLy_function_handler(FunctionCallInfo fcinfo, PLyProcedure * proc)
 783 {
 784         Datum           rv;
 785         PyObject   *volatile plargs = NULL;
 786         PyObject   *volatile plrv = NULL;
 787         PyObject   *volatile plrv_so = NULL;
 788         char       *plrv_sc;
 789
 790         PG_TRY();
 791         {
 792                 if (!proc->is_setof || proc->setof == NULL)
 793                 {
 794                         /* Simple type returning function or first time for SETOF function */
 795                         plargs = PLy_function_build_args(fcinfo, proc);
 796                         plrv = PLy_procedure_call(proc, "args", plargs);
 797                         if (!proc->is_setof)
 798
 799                                 /*
 800                                  * SETOF function parameters will be deleted when last row is
 801                                  * returned
 802                                  */
 803                                 PLy_function_delete_args(proc);
 804                         Assert(plrv != NULL);
 805                         Assert(!PLy_error_in_progress);
 806                 }
 807
 808                 /*
 809                  * Disconnect from SPI manager and then create the return values datum
 810                  * (if the input function does a palloc for it this must not be
 811                  * allocated in the SPI memory context because SPI_finish would free
 812                  * it).
 813                  */
 814                 if (SPI_finish() != SPI_OK_FINISH)
 815                         elog(ERROR, "SPI_finish failed");
 816
 817                 if (proc->is_setof)
 818                 {
 819                         bool            has_error = false;
 820                         ReturnSetInfo *rsi = (ReturnSetInfo *) fcinfo->resultinfo;
 821
 822                         if (proc->setof == NULL)
 823                         {
 824                                 /* first time -- do checks and setup */
 825                                 if (!rsi || !IsA(rsi, ReturnSetInfo) ||
 826                                         (rsi->allowedModes & SFRM_ValuePerCall) == 0)
 827                                 {
 828                                         ereport(ERROR,
 829                                                         (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
 830                                                          errmsg("unsupported set function return mode"),
 831                                                          errdetail("PL/Python set-returning functions only support returning only value per call.")));
 832                                 }
 833                                 rsi->returnMode = SFRM_ValuePerCall;
 834
 835                                 /* Make iterator out of returned object */
 836                                 proc->setof = PyObject_GetIter(plrv);
 837                                 Py_DECREF(plrv);
 838                                 plrv = NULL;
 839
 840                                 if (proc->setof == NULL)
 841                                         ereport(ERROR,
 842                                                         (errcode(ERRCODE_DATATYPE_MISMATCH),
 843                                                          errmsg("returned object cannot be iterated"),
 844                                         errdetail("PL/Python set-returning functions must return an iterable object.")));
 845                         }
 846
 847                         /* Fetch next from iterator */
 848                         plrv = PyIter_Next(proc->setof);
 849                         if (plrv)
 850                                 rsi->isDone = ExprMultipleResult;
 851                         else
 852                         {
 853                                 rsi->isDone = ExprEndResult;
 854                                 has_error = PyErr_Occurred() != NULL;
 855                         }
 856
 857                         if (rsi->isDone == ExprEndResult)
 858                         {
 859                                 /* Iterator is exhausted or error happened */
 860                                 Py_DECREF(proc->setof);
 861                                 proc->setof = NULL;
 862
 863                                 Py_XDECREF(plargs);
 864                                 Py_XDECREF(plrv);
 865                                 Py_XDECREF(plrv_so);
 866
 867                                 PLy_function_delete_args(proc);
 868
 869                                 if (has_error)
 870                                         ereport(ERROR,
 871                                                         (errcode(ERRCODE_DATA_EXCEPTION),
 872                                                   errmsg("error fetching next item from iterator")));
 873
 874                                 fcinfo->isnull = true;
 875                                 return (Datum) NULL;
 876                         }
 877                 }
 878
 879                 /*
 880                  * If the function is declared to return void, the Python return value
 881                  * must be None. For void-returning functions, we also treat a None
 882                  * return value as a special "void datum" rather than NULL (as is the
 883                  * case for non-void-returning functions).
 884                  */
 885                 if (proc->result.out.d.typoid == VOIDOID)
 886                 {
 887                         if (plrv != Py_None)
 888                                 ereport(ERROR,
 889                                                 (errcode(ERRCODE_DATATYPE_MISMATCH),
 890                                            errmsg("PL/Python function with return type \"void\" did not return None")));
 891
 892                         fcinfo->isnull = false;
 893                         rv = (Datum) 0;
 894                 }
 895                 else if (plrv == Py_None)
 896                 {
 897                         fcinfo->isnull = true;
 898                         if (proc->result.is_rowtype < 1)
 899                                 rv = InputFunctionCall(&proc->result.out.d.typfunc,
 900                                                                            NULL,
 901                                                                            proc->result.out.d.typioparam,
 902                                                                            -1);
 903                         else
 904                                 /* Tuple as None */
 905                                 rv = (Datum) NULL;
 906                 }
 907                 else if (proc->result.is_rowtype >= 1)
 908                 {
 909                         HeapTuple       tuple = NULL;
 910
 911                         if (PySequence_Check(plrv))
 912                                 /* composite type as sequence (tuple, list etc) */
 913                                 tuple = PLySequence_ToTuple(&proc->result, plrv);
 914                         else if (PyMapping_Check(plrv))
 915                                 /* composite type as mapping (currently only dict) */
 916                                 tuple = PLyMapping_ToTuple(&proc->result, plrv);
 917                         else
 918                                 /* returned as smth, must provide method __getattr__(name) */
 919                                 tuple = PLyObject_ToTuple(&proc->result, plrv);
 920
 921                         if (tuple != NULL)
 922                         {
 923                                 fcinfo->isnull = false;
 924                                 rv = HeapTupleGetDatum(tuple);
 925                         }
 926                         else
 927                         {
 928                                 fcinfo->isnull = true;
 929                                 rv = (Datum) NULL;
 930                         }
 931                 }
 932                 else
 933                 {
 934                         fcinfo->isnull = false;
 935                         plrv_so = PyObject_Str(plrv);
 936                         if (!plrv_so)
 937                                 PLy_elog(ERROR, "could not create string representation of Python object in PL/Python function \"%s\" while creating return value", proc->proname);
 938                         plrv_sc = PyString_AsString(plrv_so);
 939                         rv = InputFunctionCall(&proc->result.out.d.typfunc,
 940                                                                    plrv_sc,
 941                                                                    proc->result.out.d.typioparam,
 942                                                                    -1);
 943                 }
 944         }
 945         PG_CATCH();
 946         {
 947                 Py_XDECREF(plargs);
 948                 Py_XDECREF(plrv);
 949                 Py_XDECREF(plrv_so);
 950
 951                 PG_RE_THROW();
 952         }
 953         PG_END_TRY();
 954
 955         Py_XDECREF(plargs);
 956         Py_DECREF(plrv);
 957         Py_XDECREF(plrv_so);
 958
 959         return rv;
 960 }
 961
 962 static PyObject *
 963 PLy_procedure_call(PLyProcedure * proc, char *kargs, PyObject * vargs)
 964 {
 965         PyObject   *rv;
 966
 967         PyDict_SetItemString(proc->globals, kargs, vargs);
 968         rv = PyEval_EvalCode((PyCodeObject *) proc->code,
 969                                                  proc->globals, proc->globals);
 970
 971         /*
 972          * If there was an error in a PG callback, propagate that no matter what
 973          * Python claims about its success.
 974          */
 975         if (PLy_error_in_progress)
 976         {
 977                 ErrorData  *edata = PLy_error_in_progress;
 978
 979                 PLy_error_in_progress = NULL;
 980                 ReThrowError(edata);
 981         }
 982
 983         if (rv == NULL || PyErr_Occurred())
 984         {
 985                 Py_XDECREF(rv);
 986                 PLy_elog(ERROR, "PL/Python function \"%s\" failed", proc->proname);
 987         }
 988
 989         return rv;
 990 }
 991
 992 static PyObject *
 993 PLy_function_build_args(FunctionCallInfo fcinfo, PLyProcedure * proc)
 994 {
 995         PyObject   *volatile arg = NULL;
 996         PyObject   *volatile args = NULL;
 997         int                     i;
 998
 999         PG_TRY();
1000         {
1001                 args = PyList_New(proc->nargs);
1002                 for (i = 0; i < proc->nargs; i++)
1003                 {
1004                         if (proc->args[i].is_rowtype > 0)
1005                         {
1006                                 if (fcinfo->argnull[i])
1007                                         arg = NULL;
1008                                 else
1009                                 {
1010                                         HeapTupleHeader td;
1011                                         Oid                     tupType;
1012                                         int32           tupTypmod;
1013                                         TupleDesc       tupdesc;
1014                                         HeapTupleData tmptup;
1015
1016                                         td = DatumGetHeapTupleHeader(fcinfo->arg[i]);
1017                                         /* Extract rowtype info and find a tupdesc */
1018                                         tupType = HeapTupleHeaderGetTypeId(td);
1019                                         tupTypmod = HeapTupleHeaderGetTypMod(td);
1020                                         tupdesc = lookup_rowtype_tupdesc(tupType, tupTypmod);
1021
1022                                         /* Set up I/O funcs if not done yet */
1023                                         if (proc->args[i].is_rowtype != 1)
1024                                                 PLy_input_tuple_funcs(&(proc->args[i]), tupdesc);
1025
1026                                         /* Build a temporary HeapTuple control structure */
1027                                         tmptup.t_len = HeapTupleHeaderGetDatumLength(td);
1028                                         tmptup.t_data = td;
1029
1030                                         arg = PLyDict_FromTuple(&(proc->args[i]), &tmptup, tupdesc);
1031                                         ReleaseTupleDesc(tupdesc);
1032                                 }
1033                         }
1034                         else
1035                         {
1036                                 if (fcinfo->argnull[i])
1037                                         arg = NULL;
1038                                 else
1039                                 {
1040                                         char       *ct;
1041
1042                                         ct = OutputFunctionCall(&(proc->args[i].in.d.typfunc),
1043                                                                                         fcinfo->arg[i]);
1044                                         arg = (proc->args[i].in.d.func) (ct);
1045                                         pfree(ct);
1046                                 }
1047                         }
1048
1049                         if (arg == NULL)
1050                         {
1051                                 Py_INCREF(Py_None);
1052                                 arg = Py_None;
1053                         }
1054
1055                         if (PyList_SetItem(args, i, arg) == -1 ||
1056                                 (proc->argnames &&
1057                                  PyDict_SetItemString(proc->globals, proc->argnames[i], arg) == -1))
1058                                 PLy_elog(ERROR, "PyDict_SetItemString() failed for PL/Python function \"%s\" while setting up arguments", proc->proname);
1059                         arg = NULL;
1060                 }
1061         }
1062         PG_CATCH();
1063         {
1064                 Py_XDECREF(arg);
1065                 Py_XDECREF(args);
1066
1067                 PG_RE_THROW();
1068         }
1069         PG_END_TRY();
1070
1071         return args;
1072 }
1073
1074
1075 static void
1076 PLy_function_delete_args(PLyProcedure * proc)
1077 {
1078         int                     i;
1079
1080         if (!proc->argnames)
1081                 return;
1082
1083         for (i = 0; i < proc->nargs; i++)
1084                 PyDict_DelItemString(proc->globals, proc->argnames[i]);
1085 }
1086
1087
1088 /*
1089  * PLyProcedure functions
1090  */
1091
1092 /* PLy_procedure_get: returns a cached PLyProcedure, or creates, stores and
1093  * returns a new PLyProcedure.  fcinfo is the call info, tgreloid is the
1094  * relation OID when calling a trigger, or InvalidOid (zero) for ordinary
1095  * function calls.
1096  */
1097 static PLyProcedure *
1098 PLy_procedure_get(FunctionCallInfo fcinfo, Oid tgreloid)
1099 {
1100         Oid                     fn_oid;
1101         HeapTuple       procTup;
1102         char            key[128];
1103         PyObject   *plproc;
1104         PLyProcedure *proc = NULL;
1105         int                     rv;
1106
1107         fn_oid = fcinfo->flinfo->fn_oid;
1108         procTup = SearchSysCache(PROCOID,
1109                                                          ObjectIdGetDatum(fn_oid),
1110                                                          0, 0, 0);
1111         if (!HeapTupleIsValid(procTup))
1112                 elog(ERROR, "cache lookup failed for function %u", fn_oid);
1113
1114         rv = snprintf(key, sizeof(key), "%u_%u", fn_oid, tgreloid);
1115         if (rv >= sizeof(key) || rv < 0)
1116                 elog(ERROR, "key too long");
1117
1118         plproc = PyDict_GetItemString(PLy_procedure_cache, key);
1119
1120         if (plproc != NULL)
1121         {
1122                 Py_INCREF(plproc);
1123                 if (!PyCObject_Check(plproc))
1124                         elog(FATAL, "expected a PyCObject, didn't get one");
1125
1126                 proc = PyCObject_AsVoidPtr(plproc);
1127                 if (proc->me != plproc)
1128                         elog(FATAL, "proc->me != plproc");
1129                 /* did we find an up-to-date cache entry? */
1130                 if (proc->fn_xmin != HeapTupleHeaderGetXmin(procTup->t_data) ||
1131                         !ItemPointerEquals(&proc->fn_tid, &procTup->t_self))
1132                 {
1133                         Py_DECREF(plproc);
1134                         proc = NULL;
1135                 }
1136         }
1137
1138         if (proc == NULL)
1139                 proc = PLy_procedure_create(procTup, tgreloid, key);
1140
1141         if (OidIsValid(tgreloid))
1142         {
1143                 /*
1144                  * Input/output conversion for trigger tuples.  Use the result
1145                  * TypeInfo variable to store the tuple conversion info.  We
1146                  * do this over again on each call to cover the possibility that
1147                  * the relation's tupdesc changed since the trigger was last called.
1148                  * PLy_input_tuple_funcs and PLy_output_tuple_funcs are responsible
1149                  * for not doing repetitive work.
1150                  */
1151                 TriggerData *tdata = (TriggerData *) fcinfo->context;
1152
1153                 Assert(CALLED_AS_TRIGGER(fcinfo));
1154                 PLy_input_tuple_funcs(&(proc->result), tdata->tg_relation->rd_att);
1155                 PLy_output_tuple_funcs(&(proc->result), tdata->tg_relation->rd_att);
1156         }
1157
1158         ReleaseSysCache(procTup);
1159
1160         return proc;
1161 }
1162
1163 static PLyProcedure *
1164 PLy_procedure_create(HeapTuple procTup, Oid tgreloid, char *key)
1165 {
1166         char            procName[NAMEDATALEN + 256];
1167         Form_pg_proc procStruct;
1168         PLyProcedure *volatile proc;
1169         char       *volatile procSource = NULL;
1170         Datum           prosrcdatum;
1171         bool            isnull;
1172         int                     i,
1173                                 rv;
1174
1175         procStruct = (Form_pg_proc) GETSTRUCT(procTup);
1176
1177         if (OidIsValid(tgreloid))
1178                 rv = snprintf(procName, sizeof(procName),
1179                                           "__plpython_procedure_%s_%u_trigger_%u",
1180                                           NameStr(procStruct->proname),
1181                                           HeapTupleGetOid(procTup),
1182                                           tgreloid);
1183         else
1184                 rv = snprintf(procName, sizeof(procName),
1185                                           "__plpython_procedure_%s_%u",
1186                                           NameStr(procStruct->proname),
1187                                           HeapTupleGetOid(procTup));
1188         if (rv >= sizeof(procName) || rv < 0)
1189                 elog(ERROR, "procedure name would overrun buffer");
1190
1191         proc = PLy_malloc(sizeof(PLyProcedure));
1192         proc->proname = PLy_strdup(NameStr(procStruct->proname));
1193         proc->pyname = PLy_strdup(procName);
1194         proc->fn_xmin = HeapTupleHeaderGetXmin(procTup->t_data);
1195         proc->fn_tid = procTup->t_self;
1196         /* Remember if function is STABLE/IMMUTABLE */
1197         proc->fn_readonly =
1198                 (procStruct->provolatile != PROVOLATILE_VOLATILE);
1199         PLy_typeinfo_init(&proc->result);
1200         for (i = 0; i < FUNC_MAX_ARGS; i++)
1201                 PLy_typeinfo_init(&proc->args[i]);
1202         proc->nargs = 0;
1203         proc->code = proc->statics = NULL;
1204         proc->globals = proc->me = NULL;
1205         proc->is_setof = procStruct->proretset;
1206         proc->setof = NULL;
1207         proc->argnames = NULL;
1208
1209         PG_TRY();
1210         {
1211                 /*
1212                  * get information required for output conversion of the return value,
1213                  * but only if this isn't a trigger.
1214                  */
1215                 if (!OidIsValid(tgreloid))
1216                 {
1217                         HeapTuple       rvTypeTup;
1218                         Form_pg_type rvTypeStruct;
1219
1220                         rvTypeTup = SearchSysCache(TYPEOID,
1221                                                                         ObjectIdGetDatum(procStruct->prorettype),
1222                                                                            0, 0, 0);
1223                         if (!HeapTupleIsValid(rvTypeTup))
1224                                 elog(ERROR, "cache lookup failed for type %u",
1225                                          procStruct->prorettype);
1226                         rvTypeStruct = (Form_pg_type) GETSTRUCT(rvTypeTup);
1227
1228                         /* Disallow pseudotype result, except for void */
1229                         if (rvTypeStruct->typtype == TYPTYPE_PSEUDO &&
1230                                 procStruct->prorettype != VOIDOID)
1231                         {
1232                                 if (procStruct->prorettype == TRIGGEROID)
1233                                         ereport(ERROR,
1234                                                         (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1235                                                          errmsg("trigger functions can only be called as triggers")));
1236                                 else
1237                                         ereport(ERROR,
1238                                                         (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1239                                                    errmsg("PL/Python functions cannot return type %s",
1240                                                                   format_type_be(procStruct->prorettype))));
1241                         }
1242
1243                         if (rvTypeStruct->typtype == TYPTYPE_COMPOSITE)
1244                         {
1245                                 /*
1246                                  * Tuple: set up later, during first call to
1247                                  * PLy_function_handler
1248                                  */
1249                                 proc->result.out.d.typoid = procStruct->prorettype;
1250                                 proc->result.is_rowtype = 2;
1251                         }
1252                         else
1253                                 PLy_output_datum_func(&proc->result, rvTypeTup);
1254
1255                         ReleaseSysCache(rvTypeTup);
1256                 }
1257
1258                 /*
1259                  * Now get information required for input conversion of the
1260                  * procedure's arguments.  Note that we ignore output arguments
1261                  * here --- since we don't support returning record, and that was
1262                  * already checked above, there's no need to worry about multiple
1263                  * output arguments.
1264                  */
1265                 if (procStruct->pronargs)
1266                 {
1267                         Oid             *types;
1268                         char   **names,
1269                                         *modes;
1270                         int              i,
1271                                          pos,
1272                                          total;
1273
1274                         /* extract argument type info from the pg_proc tuple */
1275                         total = get_func_arg_info(procTup, &types, &names, &modes);
1276
1277                         /* count number of in+inout args into proc->nargs */
1278                         if (modes == NULL)
1279                                 proc->nargs = total;
1280                         else
1281                         {
1282                                 /* proc->nargs was initialized to 0 above */
1283                                 for (i = 0; i < total; i++)
1284                                 {
1285                                         if (modes[i] != PROARGMODE_OUT &&
1286                                                 modes[i] != PROARGMODE_TABLE)
1287                                                 (proc->nargs)++;
1288                                 }
1289                         }
1290
1291                         proc->argnames = (char **) PLy_malloc0(sizeof(char *) * proc->nargs);
1292                         for (i = pos = 0; i < total; i++)
1293                         {
1294                                 HeapTuple       argTypeTup;
1295                                 Form_pg_type argTypeStruct;
1296
1297                                 if (modes &&
1298                                         (modes[i] == PROARGMODE_OUT ||
1299                                          modes[i] == PROARGMODE_TABLE))
1300                                         continue;       /* skip OUT arguments */
1301
1302                                 Assert(types[i] == procStruct->proargtypes.values[pos]);
1303
1304                                 argTypeTup = SearchSysCache(TYPEOID,
1305                                                                                         ObjectIdGetDatum(types[i]),
1306                                                                                         0, 0, 0);
1307                                 if (!HeapTupleIsValid(argTypeTup))
1308                                         elog(ERROR, "cache lookup failed for type %u", types[i]);
1309                                 argTypeStruct = (Form_pg_type) GETSTRUCT(argTypeTup);
1310
1311                                 /* check argument type is OK, set up I/O function info */
1312                                 switch (argTypeStruct->typtype)
1313                                 {
1314                                         case TYPTYPE_PSEUDO:
1315                                                 /* Disallow pseudotype argument */
1316                                                 ereport(ERROR,
1317                                                                 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
1318                                                                  errmsg("PL/Python functions cannot accept type %s",
1319                                                                  format_type_be(types[i]))));
1320                                                 break;
1321                                         case TYPTYPE_COMPOSITE:
1322                                                 /* we'll set IO funcs at first call */
1323                                                 proc->args[pos].is_rowtype = 2;
1324                                                 break;
1325                                         default:
1326                                                 PLy_input_datum_func(&(proc->args[pos]),
1327                                                                                          types[i],
1328                                                                                          argTypeTup);
1329                                                 break;
1330                                 }
1331
1332                                 /* get argument name */
1333                                 proc->argnames[pos] = names ? PLy_strdup(names[i]) : NULL;
1334
1335                                 ReleaseSysCache(argTypeTup);
1336
1337                                 pos++;
1338                         }
1339                 }
1340
1341                 /*
1342                  * get the text of the function.
1343                  */
1344                 prosrcdatum = SysCacheGetAttr(PROCOID, procTup,
1345                                                                           Anum_pg_proc_prosrc, &isnull);
1346                 if (isnull)
1347                         elog(ERROR, "null prosrc");
1348                 procSource = TextDatumGetCString(prosrcdatum);
1349
1350                 PLy_procedure_compile(proc, procSource);
1351
1352                 pfree(procSource);
1353
1354                 proc->me = PyCObject_FromVoidPtr(proc, NULL);
1355                 PyDict_SetItemString(PLy_procedure_cache, key, proc->me);
1356         }
1357         PG_CATCH();
1358         {
1359                 PLy_procedure_delete(proc);
1360                 if (procSource)
1361                         pfree(procSource);
1362
1363                 PG_RE_THROW();
1364         }
1365         PG_END_TRY();
1366
1367         return proc;
1368 }
1369
1370 static void
1371 PLy_procedure_compile(PLyProcedure * proc, const char *src)
1372 {
1373         PyObject   *crv = NULL;
1374         char       *msrc;
1375
1376         proc->globals = PyDict_Copy(PLy_interp_globals);
1377
1378         /*
1379          * SD is private preserved data between calls. GD is global data shared by
1380          * all functions
1381          */
1382         proc->statics = PyDict_New();
1383         PyDict_SetItemString(proc->globals, "SD", proc->statics);
1384
1385         /*
1386          * insert the function code into the interpreter
1387          */
1388         msrc = PLy_procedure_munge_source(proc->pyname, src);
1389         crv = PyRun_String(msrc, Py_file_input, proc->globals, NULL);
1390         free(msrc);
1391
1392         if (crv != NULL && (!PyErr_Occurred()))
1393         {
1394                 int                     clen;
1395                 char            call[NAMEDATALEN + 256];
1396
1397                 Py_DECREF(crv);
1398
1399                 /*
1400                  * compile a call to the function
1401                  */
1402                 clen = snprintf(call, sizeof(call), "%s()", proc->pyname);
1403                 if (clen < 0 || clen >= sizeof(call))
1404                         elog(ERROR, "string would overflow buffer");
1405                 proc->code = Py_CompileString(call, "<string>", Py_eval_input);
1406                 if (proc->code != NULL && (!PyErr_Occurred()))
1407                         return;
1408         }
1409         else
1410                 Py_XDECREF(crv);
1411
1412         PLy_elog(ERROR, "could not compile PL/Python function \"%s\"", proc->proname);
1413 }
1414
1415 static char *
1416 PLy_procedure_munge_source(const char *name, const char *src)
1417 {
1418         char       *mrc,
1419                            *mp;
1420         const char *sp;
1421         size_t          mlen,
1422                                 plen;
1423
1424         /*
1425          * room for function source and the def statement
1426          */
1427         mlen = (strlen(src) * 2) + strlen(name) + 16;
1428
1429         mrc = PLy_malloc(mlen);
1430         plen = snprintf(mrc, mlen, "def %s():\n\t", name);
1431         Assert(plen >= 0 && plen < mlen);
1432
1433         sp = src;
1434         mp = mrc + plen;
1435
1436         while (*sp != '\0')
1437         {
1438                 if (*sp == '\r' && *(sp + 1) == '\n')
1439                         sp++;
1440
1441                 if (*sp == '\n' || *sp == '\r')
1442                 {
1443                         *mp++ = '\n';
1444                         *mp++ = '\t';
1445                         sp++;
1446                 }
1447                 else
1448                         *mp++ = *sp++;
1449         }
1450         *mp++ = '\n';
1451         *mp++ = '\n';
1452         *mp = '\0';
1453
1454         if (mp > (mrc + mlen))
1455                 elog(FATAL, "buffer overrun in PLy_munge_source");
1456
1457         return mrc;
1458 }
1459
1460 static void
1461 PLy_procedure_delete(PLyProcedure * proc)
1462 {
1463         int                     i;
1464
1465         Py_XDECREF(proc->code);
1466         Py_XDECREF(proc->statics);
1467         Py_XDECREF(proc->globals);
1468         Py_XDECREF(proc->me);
1469         if (proc->proname)
1470                 PLy_free(proc->proname);
1471         if (proc->pyname)
1472                 PLy_free(proc->pyname);
1473         for (i = 0; i < proc->nargs; i++)
1474         {
1475                 if (proc->args[i].is_rowtype == 1)
1476                 {
1477                         if (proc->args[i].in.r.atts)
1478                                 PLy_free(proc->args[i].in.r.atts);
1479                         if (proc->args[i].out.r.atts)
1480                                 PLy_free(proc->args[i].out.r.atts);
1481                 }
1482                 if (proc->argnames && proc->argnames[i])
1483                         PLy_free(proc->argnames[i]);
1484         }
1485         if (proc->argnames)
1486                 PLy_free(proc->argnames);
1487 }
1488
1489 /*
1490  * Conversion functions.  Remember output from Python is input to
1491  * PostgreSQL, and vice versa.
1492  */
1493 static void
1494 PLy_input_tuple_funcs(PLyTypeInfo * arg, TupleDesc desc)
1495 {
1496         int                     i;
1497
1498         if (arg->is_rowtype == 0)
1499                 elog(ERROR, "PLyTypeInfo struct is initialized for a Datum");
1500         arg->is_rowtype = 1;
1501
1502         if (arg->in.r.natts != desc->natts)
1503         {
1504                 if (arg->in.r.atts)
1505                         PLy_free(arg->in.r.atts);
1506                 arg->in.r.natts = desc->natts;
1507                 arg->in.r.atts = PLy_malloc0(desc->natts * sizeof(PLyDatumToOb));
1508         }
1509
1510         for (i = 0; i < desc->natts; i++)
1511         {
1512                 HeapTuple       typeTup;
1513
1514                 if (desc->attrs[i]->attisdropped)
1515                         continue;
1516
1517                 if (arg->in.r.atts[i].typoid == desc->attrs[i]->atttypid)
1518                         continue;                       /* already set up this entry */
1519
1520                 typeTup = SearchSysCache(TYPEOID,
1521                                                                  ObjectIdGetDatum(desc->attrs[i]->atttypid),
1522                                                                  0, 0, 0);
1523                 if (!HeapTupleIsValid(typeTup))
1524                         elog(ERROR, "cache lookup failed for type %u",
1525                                  desc->attrs[i]->atttypid);
1526
1527                 PLy_input_datum_func2(&(arg->in.r.atts[i]),
1528                                                           desc->attrs[i]->atttypid,
1529                                                           typeTup);
1530
1531                 ReleaseSysCache(typeTup);
1532         }
1533 }
1534
1535 static void
1536 PLy_output_tuple_funcs(PLyTypeInfo * arg, TupleDesc desc)
1537 {
1538         int                     i;
1539
1540         if (arg->is_rowtype == 0)
1541                 elog(ERROR, "PLyTypeInfo struct is initialized for a Datum");
1542         arg->is_rowtype = 1;
1543
1544         if (arg->out.r.natts != desc->natts)
1545         {
1546                 if (arg->out.r.atts)
1547                         PLy_free(arg->out.r.atts);
1548                 arg->out.r.natts = desc->natts;
1549                 arg->out.r.atts = PLy_malloc0(desc->natts * sizeof(PLyDatumToOb));
1550         }
1551
1552         for (i = 0; i < desc->natts; i++)
1553         {
1554                 HeapTuple       typeTup;
1555
1556                 if (desc->attrs[i]->attisdropped)
1557                         continue;
1558
1559                 if (arg->out.r.atts[i].typoid == desc->attrs[i]->atttypid)
1560                         continue;                       /* already set up this entry */
1561
1562                 typeTup = SearchSysCache(TYPEOID,
1563                                                                  ObjectIdGetDatum(desc->attrs[i]->atttypid),
1564                                                                  0, 0, 0);
1565                 if (!HeapTupleIsValid(typeTup))
1566                         elog(ERROR, "cache lookup failed for type %u",
1567                                  desc->attrs[i]->atttypid);
1568
1569                 PLy_output_datum_func2(&(arg->out.r.atts[i]), typeTup);
1570
1571                 ReleaseSysCache(typeTup);
1572         }
1573 }
1574
1575 static void
1576 PLy_output_datum_func(PLyTypeInfo * arg, HeapTuple typeTup)
1577 {
1578         if (arg->is_rowtype > 0)
1579                 elog(ERROR, "PLyTypeInfo struct is initialized for a Tuple");
1580         arg->is_rowtype = 0;
1581         PLy_output_datum_func2(&(arg->out.d), typeTup);
1582 }
1583
1584 static void
1585 PLy_output_datum_func2(PLyObToDatum * arg, HeapTuple typeTup)
1586 {
1587         Form_pg_type typeStruct = (Form_pg_type) GETSTRUCT(typeTup);
1588
1589         perm_fmgr_info(typeStruct->typinput, &arg->typfunc);
1590         arg->typoid = HeapTupleGetOid(typeTup);
1591         arg->typioparam = getTypeIOParam(typeTup);
1592         arg->typbyval = typeStruct->typbyval;
1593 }
1594
1595 static void
1596 PLy_input_datum_func(PLyTypeInfo * arg, Oid typeOid, HeapTuple typeTup)
1597 {
1598         if (arg->is_rowtype > 0)
1599                 elog(ERROR, "PLyTypeInfo struct is initialized for Tuple");
1600         arg->is_rowtype = 0;
1601         PLy_input_datum_func2(&(arg->in.d), typeOid, typeTup);
1602 }
1603
1604 static void
1605 PLy_input_datum_func2(PLyDatumToOb * arg, Oid typeOid, HeapTuple typeTup)
1606 {
1607         Form_pg_type typeStruct = (Form_pg_type) GETSTRUCT(typeTup);
1608
1609         /* Get the type's conversion information */
1610         perm_fmgr_info(typeStruct->typoutput, &arg->typfunc);
1611         arg->typoid = HeapTupleGetOid(typeTup);
1612         arg->typioparam = getTypeIOParam(typeTup);
1613         arg->typbyval = typeStruct->typbyval;
1614
1615         /* Determine which kind of Python object we will convert to */
1616         switch (typeOid)
1617         {
1618                 case BOOLOID:
1619                         arg->func = PLyBool_FromString;
1620                         break;
1621                 case FLOAT4OID:
1622                 case FLOAT8OID:
1623                 case NUMERICOID:
1624                         arg->func = PLyFloat_FromString;
1625                         break;
1626                 case INT2OID:
1627                 case INT4OID:
1628                         arg->func = PLyInt_FromString;
1629                         break;
1630                 case INT8OID:
1631                         arg->func = PLyLong_FromString;
1632                         break;
1633                 default:
1634                         arg->func = PLyString_FromString;
1635                         break;
1636         }
1637 }
1638
1639 static void
1640 PLy_typeinfo_init(PLyTypeInfo * arg)
1641 {
1642         arg->is_rowtype = -1;
1643         arg->in.r.natts = arg->out.r.natts = 0;
1644         arg->in.r.atts = NULL;
1645         arg->out.r.atts = NULL;
1646 }
1647
1648 static void
1649 PLy_typeinfo_dealloc(PLyTypeInfo * arg)
1650 {
1651         if (arg->is_rowtype == 1)
1652         {
1653                 if (arg->in.r.atts)
1654                         PLy_free(arg->in.r.atts);
1655                 if (arg->out.r.atts)
1656                         PLy_free(arg->out.r.atts);
1657         }
1658 }
1659
1660 /* assumes that a bool is always returned as a 't' or 'f' */
1661 static PyObject *
1662 PLyBool_FromString(const char *src)
1663 {
1664         /*
1665          * We would like to use Py_RETURN_TRUE and Py_RETURN_FALSE here for
1666          * generating SQL from trigger functions, but those are only supported in
1667          * Python >= 2.3, and we support older versions.
1668          * http://docs.python.org/api/boolObjects.html
1669          */
1670         if (src[0] == 't')
1671                 return PyBool_FromLong(1);
1672         return PyBool_FromLong(0);
1673 }
1674
1675 static PyObject *
1676 PLyFloat_FromString(const char *src)
1677 {
1678         double          v;
1679         char       *eptr;
1680
1681         errno = 0;
1682         v = strtod(src, &eptr);
1683         if (*eptr != '\0' || errno)
1684                 return NULL;
1685         return PyFloat_FromDouble(v);
1686 }
1687
1688 static PyObject *
1689 PLyInt_FromString(const char *src)
1690 {
1691         long            v;
1692         char       *eptr;
1693
1694         errno = 0;
1695         v = strtol(src, &eptr, 0);
1696         if (*eptr != '\0' || errno)
1697                 return NULL;
1698         return PyInt_FromLong(v);
1699 }
1700
1701 static PyObject *
1702 PLyLong_FromString(const char *src)
1703 {
1704         return PyLong_FromString((char *) src, NULL, 0);
1705 }
1706
1707 static PyObject *
1708 PLyString_FromString(const char *src)
1709 {
1710         return PyString_FromString(src);
1711 }
1712
1713 static PyObject *
1714 PLyDict_FromTuple(PLyTypeInfo * info, HeapTuple tuple, TupleDesc desc)
1715 {
1716         PyObject   *volatile dict;
1717         int                     i;
1718
1719         if (info->is_rowtype != 1)
1720                 elog(ERROR, "PLyTypeInfo structure describes a datum");
1721
1722         dict = PyDict_New();
1723         if (dict == NULL)
1724                 PLy_elog(ERROR, "could not create new dictionary");
1725
1726         PG_TRY();
1727         {
1728                 for (i = 0; i < info->in.r.natts; i++)
1729                 {
1730                         char       *key,
1731                                            *vsrc;
1732                         Datum           vattr;
1733                         bool            is_null;
1734                         PyObject   *value;
1735
1736                         if (desc->attrs[i]->attisdropped)
1737                                 continue;
1738
1739                         key = NameStr(desc->attrs[i]->attname);
1740                         vattr = heap_getattr(tuple, (i + 1), desc, &is_null);
1741
1742                         if (is_null || info->in.r.atts[i].func == NULL)
1743                                 PyDict_SetItemString(dict, key, Py_None);
1744                         else
1745                         {
1746                                 vsrc = OutputFunctionCall(&info->in.r.atts[i].typfunc,
1747                                                                                   vattr);
1748
1749                                 /*
1750                                  * no exceptions allowed
1751                                  */
1752                                 value = info->in.r.atts[i].func(vsrc);
1753                                 pfree(vsrc);
1754                                 PyDict_SetItemString(dict, key, value);
1755                                 Py_DECREF(value);
1756                         }
1757                 }
1758         }
1759         PG_CATCH();
1760         {
1761                 Py_DECREF(dict);
1762                 PG_RE_THROW();
1763         }
1764         PG_END_TRY();
1765
1766         return dict;
1767 }
1768
1769
1770 static HeapTuple
1771 PLyMapping_ToTuple(PLyTypeInfo * info, PyObject * mapping)
1772 {
1773         TupleDesc       desc;
1774         HeapTuple       tuple;
1775         Datum      *values;
1776         bool       *nulls;
1777         volatile int i;
1778
1779         Assert(PyMapping_Check(mapping));
1780
1781         desc = lookup_rowtype_tupdesc(info->out.d.typoid, -1);
1782         if (info->is_rowtype == 2)
1783                 PLy_output_tuple_funcs(info, desc);
1784         Assert(info->is_rowtype == 1);
1785
1786         /* Build tuple */
1787         values = palloc(sizeof(Datum) * desc->natts);
1788         nulls = palloc(sizeof(bool) * desc->natts);
1789         for (i = 0; i < desc->natts; ++i)
1790         {
1791                 char       *key;
1792                 PyObject   *volatile value,
1793                                    *volatile so;
1794
1795                 key = NameStr(desc->attrs[i]->attname);
1796                 value = so = NULL;
1797                 PG_TRY();
1798                 {
1799                         value = PyMapping_GetItemString(mapping, key);
1800                         if (value == Py_None)
1801                         {
1802                                 values[i] = (Datum) NULL;
1803                                 nulls[i] = true;
1804                         }
1805                         else if (value)
1806                         {
1807                                 char       *valuestr;
1808
1809                                 so = PyObject_Str(value);
1810                                 if (so == NULL)
1811                                         PLy_elog(ERROR, "could not compute string representation of Python object");
1812                                 valuestr = PyString_AsString(so);
1813
1814                                 values[i] = InputFunctionCall(&info->out.r.atts[i].typfunc
1815                                                                                           ,valuestr
1816                                                                                           ,info->out.r.atts[i].typioparam
1817                                                                                           ,-1);
1818                                 Py_DECREF(so);
1819                                 so = NULL;
1820                                 nulls[i] = false;
1821                         }
1822                         else
1823                                 ereport(ERROR,
1824                                                 (errcode(ERRCODE_UNDEFINED_COLUMN),
1825                                                  errmsg("key \"%s\" not found in mapping", key),
1826                                                  errhint("To return null in a column, "
1827                                           "add the value None to the mapping with the key named after the column.")));
1828
1829                         Py_XDECREF(value);
1830                         value = NULL;
1831                 }
1832                 PG_CATCH();
1833                 {
1834                         Py_XDECREF(so);
1835                         Py_XDECREF(value);
1836                         PG_RE_THROW();
1837                 }
1838                 PG_END_TRY();
1839         }
1840
1841         tuple = heap_form_tuple(desc, values, nulls);
1842         ReleaseTupleDesc(desc);
1843         pfree(values);
1844         pfree(nulls);
1845
1846         return tuple;
1847 }
1848
1849
1850 static HeapTuple
1851 PLySequence_ToTuple(PLyTypeInfo * info, PyObject * sequence)
1852 {
1853         TupleDesc       desc;
1854         HeapTuple       tuple;
1855         Datum      *values;
1856         bool       *nulls;
1857         volatile int i;
1858
1859         Assert(PySequence_Check(sequence));
1860
1861         /*
1862          * Check that sequence length is exactly same as PG tuple's. We actually
1863          * can ignore exceeding items or assume missing ones as null but to avoid
1864          * plpython developer's errors we are strict here
1865          */
1866         desc = lookup_rowtype_tupdesc(info->out.d.typoid, -1);
1867         if (PySequence_Length(sequence) != desc->natts)
1868                 ereport(ERROR,
1869                                 (errcode(ERRCODE_DATATYPE_MISMATCH),
1870                 errmsg("length of returned sequence did not match number of columns in row")));
1871
1872         if (info->is_rowtype == 2)
1873                 PLy_output_tuple_funcs(info, desc);
1874         Assert(info->is_rowtype == 1);
1875
1876         /* Build tuple */
1877         values = palloc(sizeof(Datum) * desc->natts);
1878         nulls = palloc(sizeof(bool) * desc->natts);
1879         for (i = 0; i < desc->natts; ++i)
1880         {
1881                 PyObject   *volatile value,
1882                                    *volatile so;
1883
1884                 value = so = NULL;
1885                 PG_TRY();
1886                 {
1887                         value = PySequence_GetItem(sequence, i);
1888                         Assert(value);
1889                         if (value == Py_None)
1890                         {
1891                                 values[i] = (Datum) NULL;
1892                                 nulls[i] = true;
1893                         }
1894                         else if (value)
1895                         {
1896                                 char       *valuestr;
1897
1898                                 so = PyObject_Str(value);
1899                                 if (so == NULL)
1900                                         PLy_elog(ERROR, "could not compute string representation of Python object");
1901                                 valuestr = PyString_AsString(so);
1902                                 values[i] = InputFunctionCall(&info->out.r.atts[i].typfunc
1903                                                                                           ,valuestr
1904                                                                                           ,info->out.r.atts[i].typioparam
1905                                                                                           ,-1);
1906                                 Py_DECREF(so);
1907                                 so = NULL;
1908                                 nulls[i] = false;
1909                         }
1910
1911                         Py_XDECREF(value);
1912                         value = NULL;
1913                 }
1914                 PG_CATCH();
1915                 {
1916                         Py_XDECREF(so);
1917                         Py_XDECREF(value);
1918                         PG_RE_THROW();
1919                 }
1920                 PG_END_TRY();
1921         }
1922
1923         tuple = heap_form_tuple(desc, values, nulls);
1924         ReleaseTupleDesc(desc);
1925         pfree(values);
1926         pfree(nulls);
1927
1928         return tuple;
1929 }
1930
1931
1932 static HeapTuple
1933 PLyObject_ToTuple(PLyTypeInfo * info, PyObject * object)
1934 {
1935         TupleDesc       desc;
1936         HeapTuple       tuple;
1937         Datum      *values;
1938         bool       *nulls;
1939         volatile int i;
1940
1941         desc = lookup_rowtype_tupdesc(info->out.d.typoid, -1);
1942         if (info->is_rowtype == 2)
1943                 PLy_output_tuple_funcs(info, desc);
1944         Assert(info->is_rowtype == 1);
1945
1946         /* Build tuple */
1947         values = palloc(sizeof(Datum) * desc->natts);
1948         nulls = palloc(sizeof(bool) * desc->natts);
1949         for (i = 0; i < desc->natts; ++i)
1950         {
1951                 char       *key;
1952                 PyObject   *volatile value,
1953                                    *volatile so;
1954
1955                 key = NameStr(desc->attrs[i]->attname);
1956                 value = so = NULL;
1957                 PG_TRY();
1958                 {
1959                         value = PyObject_GetAttrString(object, key);
1960                         if (value == Py_None)
1961                         {
1962                                 values[i] = (Datum) NULL;
1963                                 nulls[i] = true;
1964                         }
1965                         else if (value)
1966                         {
1967                                 char       *valuestr;
1968
1969                                 so = PyObject_Str(value);
1970                                 if (so == NULL)
1971                                         PLy_elog(ERROR, "could not compute string representation of Python object");
1972                                 valuestr = PyString_AsString(so);
1973                                 values[i] = InputFunctionCall(&info->out.r.atts[i].typfunc
1974                                                                                           ,valuestr
1975                                                                                           ,info->out.r.atts[i].typioparam
1976                                                                                           ,-1);
1977                                 Py_DECREF(so);
1978                                 so = NULL;
1979                                 nulls[i] = false;
1980                         }
1981                         else
1982                                 ereport(ERROR,
1983                                                 (errcode(ERRCODE_UNDEFINED_COLUMN),
1984                                                  errmsg("attribute \"%s\" does not exist in Python object", key),
1985                                                  errhint("To return null in a column, "
1986                                                                  "let the returned object have an attribute named "
1987                                                                  "after column with value None.")));
1988
1989                         Py_XDECREF(value);
1990                         value = NULL;
1991                 }
1992                 PG_CATCH();
1993                 {
1994                         Py_XDECREF(so);
1995                         Py_XDECREF(value);
1996                         PG_RE_THROW();
1997                 }
1998                 PG_END_TRY();
1999         }
2000
2001         tuple = heap_form_tuple(desc, values, nulls);
2002         ReleaseTupleDesc(desc);
2003         pfree(values);
2004         pfree(nulls);
2005
2006         return tuple;
2007 }
2008
2009
2010 /* initialization, some python variables function declared here */
2011
2012 /* interface to postgresql elog */
2013 static PyObject *PLy_debug(PyObject *, PyObject *);
2014 static PyObject *PLy_log(PyObject *, PyObject *);
2015 static PyObject *PLy_info(PyObject *, PyObject *);
2016 static PyObject *PLy_notice(PyObject *, PyObject *);
2017 static PyObject *PLy_warning(PyObject *, PyObject *);
2018 static PyObject *PLy_error(PyObject *, PyObject *);
2019 static PyObject *PLy_fatal(PyObject *, PyObject *);
2020
2021 /* PLyPlanObject, PLyResultObject and SPI interface */
2022 #define is_PLyPlanObject(x) ((x)->ob_type == &PLy_PlanType)
2023 static PyObject *PLy_plan_new(void);
2024 static void PLy_plan_dealloc(PyObject *);
2025 static PyObject *PLy_plan_getattr(PyObject *, char *);
2026 static PyObject *PLy_plan_status(PyObject *, PyObject *);
2027
2028 static PyObject *PLy_result_new(void);
2029 static void PLy_result_dealloc(PyObject *);
2030 static PyObject *PLy_result_getattr(PyObject *, char *);
2031 static PyObject *PLy_result_nrows(PyObject *, PyObject *);
2032 static PyObject *PLy_result_status(PyObject *, PyObject *);
2033 static Py_ssize_t PLy_result_length(PyObject *);
2034 static PyObject *PLy_result_item(PyObject *, Py_ssize_t);
2035 static PyObject *PLy_result_slice(PyObject *, Py_ssize_t, Py_ssize_t);
2036 static int      PLy_result_ass_item(PyObject *, Py_ssize_t, PyObject *);
2037 static int      PLy_result_ass_slice(PyObject *, Py_ssize_t, Py_ssize_t, PyObject *);
2038
2039
2040 static PyObject *PLy_spi_prepare(PyObject *, PyObject *);
2041 static PyObject *PLy_spi_execute(PyObject *, PyObject *);
2042 static PyObject *PLy_spi_execute_query(char *query, long limit);
2043 static PyObject *PLy_spi_execute_plan(PyObject *, PyObject *, long);
2044 static PyObject *PLy_spi_execute_fetch_result(SPITupleTable *, int, int);
2045
2046
2047 static PyTypeObject PLy_PlanType = {
2048         PyObject_HEAD_INIT(NULL)
2049         0,                                                      /* ob_size */
2050         "PLyPlan",                                      /* tp_name */
2051         sizeof(PLyPlanObject),          /* tp_size */
2052         0,                                                      /* tp_itemsize */
2053
2054         /*
2055          * methods
2056          */
2057         PLy_plan_dealloc,                       /* tp_dealloc */
2058         0,                                                      /* tp_print */
2059         PLy_plan_getattr,                       /* tp_getattr */
2060         0,                                                      /* tp_setattr */
2061         0,                                                      /* tp_compare */
2062         0,                                                      /* tp_repr */
2063         0,                                                      /* tp_as_number */
2064         0,                                                      /* tp_as_sequence */
2065         0,                                                      /* tp_as_mapping */
2066         0,                                                      /* tp_hash */
2067         0,                                                      /* tp_call */
2068         0,                                                      /* tp_str */
2069         0,                                                      /* tp_getattro */
2070         0,                                                      /* tp_setattro */
2071         0,                                                      /* tp_as_buffer */
2072         Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,       /* tp_flags */
2073         PLy_plan_doc,                           /* tp_doc */
2074 };
2075
2076 static PyMethodDef PLy_plan_methods[] = {
2077         {"status", PLy_plan_status, METH_VARARGS, NULL},
2078         {NULL, NULL, 0, NULL}
2079 };
2080
2081 static PySequenceMethods PLy_result_as_sequence = {
2082         PLy_result_length,                      /* sq_length */
2083         NULL,                                           /* sq_concat */
2084         NULL,                                           /* sq_repeat */
2085         PLy_result_item,                        /* sq_item */
2086         PLy_result_slice,                       /* sq_slice */
2087         PLy_result_ass_item,            /* sq_ass_item */
2088         PLy_result_ass_slice,           /* sq_ass_slice */
2089 };
2090
2091 static PyTypeObject PLy_ResultType = {
2092         PyObject_HEAD_INIT(NULL)
2093         0,                                                      /* ob_size */
2094         "PLyResult",                            /* tp_name */
2095         sizeof(PLyResultObject),        /* tp_size */
2096         0,                                                      /* tp_itemsize */
2097
2098         /*
2099          * methods
2100          */
2101         PLy_result_dealloc,                     /* tp_dealloc */
2102         0,                                                      /* tp_print */
2103         PLy_result_getattr,                     /* tp_getattr */
2104         0,                                                      /* tp_setattr */
2105         0,                                                      /* tp_compare */
2106         0,                                                      /* tp_repr */
2107         0,                                                      /* tp_as_number */
2108         &PLy_result_as_sequence,        /* tp_as_sequence */
2109         0,                                                      /* tp_as_mapping */
2110         0,                                                      /* tp_hash */
2111         0,                                                      /* tp_call */
2112         0,                                                      /* tp_str */
2113         0,                                                      /* tp_getattro */
2114         0,                                                      /* tp_setattro */
2115         0,                                                      /* tp_as_buffer */
2116         Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,       /* tp_flags */
2117         PLy_result_doc,                         /* tp_doc */
2118 };
2119
2120 static PyMethodDef PLy_result_methods[] = {
2121         {"nrows", PLy_result_nrows, METH_VARARGS, NULL},
2122         {"status", PLy_result_status, METH_VARARGS, NULL},
2123         {NULL, NULL, 0, NULL}
2124 };
2125
2126 static PyMethodDef PLy_methods[] = {
2127         /*
2128          * logging methods
2129          */
2130         {"debug", PLy_debug, METH_VARARGS, NULL},
2131         {"log", PLy_log, METH_VARARGS, NULL},
2132         {"info", PLy_info, METH_VARARGS, NULL},
2133         {"notice", PLy_notice, METH_VARARGS, NULL},
2134         {"warning", PLy_warning, METH_VARARGS, NULL},
2135         {"error", PLy_error, METH_VARARGS, NULL},
2136         {"fatal", PLy_fatal, METH_VARARGS, NULL},
2137
2138         /*
2139          * create a stored plan
2140          */
2141         {"prepare", PLy_spi_prepare, METH_VARARGS, NULL},
2142
2143         /*
2144          * execute a plan or query
2145          */
2146         {"execute", PLy_spi_execute, METH_VARARGS, NULL},
2147
2148         {NULL, NULL, 0, NULL}
2149 };
2150
2151
2152 /* plan object methods */
2153 static PyObject *
2154 PLy_plan_new(void)
2155 {
2156         PLyPlanObject *ob;
2157
2158         if ((ob = PyObject_NEW(PLyPlanObject, &PLy_PlanType)) == NULL)
2159                 return NULL;
2160
2161         ob->plan = NULL;
2162         ob->nargs = 0;
2163         ob->types = NULL;
2164         ob->args = NULL;
2165
2166         return (PyObject *) ob;
2167 }
2168
2169
2170 static void
2171 PLy_plan_dealloc(PyObject * arg)
2172 {
2173         PLyPlanObject *ob = (PLyPlanObject *) arg;
2174
2175         if (ob->plan)
2176                 SPI_freeplan(ob->plan);
2177         if (ob->types)
2178                 PLy_free(ob->types);
2179         if (ob->args)
2180         {
2181                 int                     i;
2182
2183                 for (i = 0; i < ob->nargs; i++)
2184                         PLy_typeinfo_dealloc(&ob->args[i]);
2185                 PLy_free(ob->args);
2186         }
2187
2188         arg->ob_type->tp_free(arg);
2189 }
2190
2191
2192 static PyObject *
2193 PLy_plan_getattr(PyObject * self, char *name)
2194 {
2195         return Py_FindMethod(PLy_plan_methods, self, name);
2196 }
2197
2198 static PyObject *
2199 PLy_plan_status(PyObject * self, PyObject * args)
2200 {
2201         if (PyArg_ParseTuple(args, ""))
2202         {
2203                 Py_INCREF(Py_True);
2204                 return Py_True;
2205                 /* return PyInt_FromLong(self->status); */
2206         }
2207         PLy_exception_set(PLy_exc_error, "plan.status takes no arguments");
2208         return NULL;
2209 }
2210
2211
2212
2213 /* result object methods */
2214
2215 static PyObject *
2216 PLy_result_new(void)
2217 {
2218         PLyResultObject *ob;
2219
2220         if ((ob = PyObject_NEW(PLyResultObject, &PLy_ResultType)) == NULL)
2221                 return NULL;
2222
2223         /* ob->tuples = NULL; */
2224
2225         Py_INCREF(Py_None);
2226         ob->status = Py_None;
2227         ob->nrows = PyInt_FromLong(-1);
2228         ob->rows = PyList_New(0);
2229
2230         return (PyObject *) ob;
2231 }
2232
2233 static void
2234 PLy_result_dealloc(PyObject * arg)
2235 {
2236         PLyResultObject *ob = (PLyResultObject *) arg;
2237
2238         Py_XDECREF(ob->nrows);
2239         Py_XDECREF(ob->rows);
2240         Py_XDECREF(ob->status);
2241
2242         arg->ob_type->tp_free(arg);
2243 }
2244
2245 static PyObject *
2246 PLy_result_getattr(PyObject * self, char *name)
2247 {
2248         return Py_FindMethod(PLy_result_methods, self, name);
2249 }
2250
2251 static PyObject *
2252 PLy_result_nrows(PyObject * self, PyObject * args)
2253 {
2254         PLyResultObject *ob = (PLyResultObject *) self;
2255
2256         Py_INCREF(ob->nrows);
2257         return ob->nrows;
2258 }
2259
2260 static PyObject *
2261 PLy_result_status(PyObject * self, PyObject * args)
2262 {
2263         PLyResultObject *ob = (PLyResultObject *) self;
2264
2265         Py_INCREF(ob->status);
2266         return ob->status;
2267 }
2268
2269 static Py_ssize_t
2270 PLy_result_length(PyObject * arg)
2271 {
2272         PLyResultObject *ob = (PLyResultObject *) arg;
2273
2274         return PyList_Size(ob->rows);
2275 }
2276
2277 static PyObject *
2278 PLy_result_item(PyObject * arg, Py_ssize_t idx)
2279 {
2280         PyObject   *rv;
2281         PLyResultObject *ob = (PLyResultObject *) arg;
2282
2283         rv = PyList_GetItem(ob->rows, idx);
2284         if (rv != NULL)
2285                 Py_INCREF(rv);
2286         return rv;
2287 }
2288
2289 static int
2290 PLy_result_ass_item(PyObject * arg, Py_ssize_t idx, PyObject * item)
2291 {
2292         int                     rv;
2293         PLyResultObject *ob = (PLyResultObject *) arg;
2294
2295         Py_INCREF(item);
2296         rv = PyList_SetItem(ob->rows, idx, item);
2297         return rv;
2298 }
2299
2300 static PyObject *
2301 PLy_result_slice(PyObject * arg, Py_ssize_t lidx, Py_ssize_t hidx)
2302 {
2303         PyObject   *rv;
2304         PLyResultObject *ob = (PLyResultObject *) arg;
2305
2306         rv = PyList_GetSlice(ob->rows, lidx, hidx);
2307         if (rv == NULL)
2308                 return NULL;
2309         Py_INCREF(rv);
2310         return rv;
2311 }
2312
2313 static int
2314 PLy_result_ass_slice(PyObject * arg, Py_ssize_t lidx, Py_ssize_t hidx, PyObject * slice)
2315 {
2316         int                     rv;
2317         PLyResultObject *ob = (PLyResultObject *) arg;
2318
2319         rv = PyList_SetSlice(ob->rows, lidx, hidx, slice);
2320         return rv;
2321 }
2322
2323 /* SPI interface */
2324 static PyObject *
2325 PLy_spi_prepare(PyObject * self, PyObject * args)
2326 {
2327         PLyPlanObject *plan;
2328         PyObject   *list = NULL;
2329         PyObject   *volatile optr = NULL;
2330         char       *query;
2331         void       *tmpplan;
2332         MemoryContext oldcontext;
2333
2334         /* Can't execute more if we have an unhandled error */
2335         if (PLy_error_in_progress)
2336         {
2337                 PLy_exception_set(PLy_exc_error, "transaction aborted");
2338                 return NULL;
2339         }
2340
2341         if (!PyArg_ParseTuple(args, "s|O", &query, &list))
2342         {
2343                 PLy_exception_set(PLy_exc_spi_error,
2344                                                   "invalid arguments for plpy.prepare");
2345                 return NULL;
2346         }
2347
2348         if (list && (!PySequence_Check(list)))
2349         {
2350                 PLy_exception_set(PLy_exc_spi_error,
2351                                                   "second argument of plpy.prepare must be a sequence");
2352                 return NULL;
2353         }
2354
2355         if ((plan = (PLyPlanObject *) PLy_plan_new()) == NULL)
2356                 return NULL;
2357
2358         oldcontext = CurrentMemoryContext;
2359         PG_TRY();
2360         {
2361                 if (list != NULL)
2362                 {
2363                         int                     nargs,
2364                                                 i;
2365
2366                         nargs = PySequence_Length(list);
2367                         if (nargs > 0)
2368                         {
2369                                 plan->nargs = nargs;
2370                                 plan->types = PLy_malloc(sizeof(Oid) * nargs);
2371                                 plan->values = PLy_malloc(sizeof(Datum) * nargs);
2372                                 plan->args = PLy_malloc(sizeof(PLyTypeInfo) * nargs);
2373
2374                                 /*
2375                                  * the other loop might throw an exception, if PLyTypeInfo
2376                                  * member isn't properly initialized the Py_DECREF(plan) will
2377                                  * go boom
2378                                  */
2379                                 for (i = 0; i < nargs; i++)
2380                                 {
2381                                         PLy_typeinfo_init(&plan->args[i]);
2382                                         plan->values[i] = PointerGetDatum(NULL);
2383                                 }
2384
2385                                 for (i = 0; i < nargs; i++)
2386                                 {
2387                                         char       *sptr;
2388                                         HeapTuple       typeTup;
2389                                         Oid                     typeId;
2390                                         int32           typmod;
2391                                         Form_pg_type typeStruct;
2392
2393                                         optr = PySequence_GetItem(list, i);
2394                                         if (!PyString_Check(optr))
2395                                                 ereport(ERROR,
2396                                                                 (errmsg("plpy.prepare: type name at ordinal position %d is not a string", i)));
2397                                         sptr = PyString_AsString(optr);
2398
2399                                         /********************************************************
2400                                          * Resolve argument type names and then look them up by
2401                                          * oid in the system cache, and remember the required
2402                                          *information for input conversion.
2403                                          ********************************************************/
2404
2405                                         parseTypeString(sptr, &typeId, &typmod);
2406
2407                                         typeTup = SearchSysCache(TYPEOID,
2408                                                                                          ObjectIdGetDatum(typeId),
2409                                                                                          0, 0, 0);
2410                                         if (!HeapTupleIsValid(typeTup))
2411                                                 elog(ERROR, "cache lookup failed for type %u", typeId);
2412
2413                                         Py_DECREF(optr);
2414                                         optr = NULL;    /* this is important */
2415
2416                                         plan->types[i] = typeId;
2417                                         typeStruct = (Form_pg_type) GETSTRUCT(typeTup);
2418                                         if (typeStruct->typtype != TYPTYPE_COMPOSITE)
2419                                                 PLy_output_datum_func(&plan->args[i], typeTup);
2420                                         else
2421                                                 ereport(ERROR,
2422                                                                 (errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
2423                                                                  errmsg("plpy.prepare does not support composite types")));
2424                                         ReleaseSysCache(typeTup);
2425                                 }
2426                         }
2427                 }
2428
2429                 plan->plan = SPI_prepare(query, plan->nargs, plan->types);
2430                 if (plan->plan == NULL)
2431                         elog(ERROR, "SPI_prepare failed: %s",
2432                                  SPI_result_code_string(SPI_result));
2433
2434                 /* transfer plan from procCxt to topCxt */
2435                 tmpplan = plan->plan;
2436                 plan->plan = SPI_saveplan(tmpplan);
2437                 SPI_freeplan(tmpplan);
2438                 if (plan->plan == NULL)
2439                         elog(ERROR, "SPI_saveplan failed: %s",
2440                                  SPI_result_code_string(SPI_result));
2441         }
2442         PG_CATCH();
2443         {
2444                 MemoryContextSwitchTo(oldcontext);
2445                 PLy_error_in_progress = CopyErrorData();
2446                 FlushErrorState();
2447                 Py_DECREF(plan);
2448                 Py_XDECREF(optr);
2449                 if (!PyErr_Occurred())
2450                         PLy_exception_set(PLy_exc_spi_error,
2451                                                           "unrecognized error in PLy_spi_prepare");
2452                 /* XXX this oughta be replaced with errcontext mechanism */
2453                 PLy_elog(WARNING, "in PL/Python function \"%s\"",
2454                                  PLy_procedure_name(PLy_curr_procedure));
2455                 return NULL;
2456         }
2457         PG_END_TRY();
2458
2459         return (PyObject *) plan;
2460 }
2461
2462 /* execute(query="select * from foo", limit=5)
2463  * execute(plan=plan, values=(foo, bar), limit=5)
2464  */
2465 static PyObject *
2466 PLy_spi_execute(PyObject * self, PyObject * args)
2467 {
2468         char       *query;
2469         PyObject   *plan;
2470         PyObject   *list = NULL;
2471         long            limit = 0;
2472
2473         /* Can't execute more if we have an unhandled error */
2474         if (PLy_error_in_progress)
2475         {
2476                 PLy_exception_set(PLy_exc_error, "transaction aborted");
2477                 return NULL;
2478         }
2479
2480         if (PyArg_ParseTuple(args, "s|l", &query, &limit))
2481                 return PLy_spi_execute_query(query, limit);
2482
2483         PyErr_Clear();
2484
2485         if (PyArg_ParseTuple(args, "O|Ol", &plan, &list, &limit) &&
2486                 is_PLyPlanObject(plan))
2487                 return PLy_spi_execute_plan(plan, list, limit);
2488
2489         PLy_exception_set(PLy_exc_error, "plpy.execute expected a query or a plan");
2490         return NULL;
2491 }
2492
2493 static PyObject *
2494 PLy_spi_execute_plan(PyObject * ob, PyObject * list, long limit)
2495 {
2496         volatile int nargs;
2497         int                     i,
2498                                 rv;
2499         PLyPlanObject *plan;
2500         MemoryContext oldcontext;
2501
2502         if (list != NULL)
2503         {
2504                 if (!PySequence_Check(list) || PyString_Check(list))
2505                 {
2506                         PLy_exception_set(PLy_exc_spi_error, "plpy.execute takes a sequence as its second argument");
2507                         return NULL;
2508                 }
2509                 nargs = PySequence_Length(list);
2510         }
2511         else
2512                 nargs = 0;
2513
2514         plan = (PLyPlanObject *) ob;
2515
2516         if (nargs != plan->nargs)
2517         {
2518                 char       *sv;
2519                 PyObject   *so = PyObject_Str(list);
2520
2521                 if (!so)
2522                         PLy_elog(ERROR, "PL/Python function \"%s\" could not execute plan",
2523                                          PLy_procedure_name(PLy_curr_procedure));
2524                 sv = PyString_AsString(so);
2525                 PLy_exception_set(PLy_exc_spi_error,
2526                                                   dngettext(TEXTDOMAIN, "Expected sequence of %d argument, got %d: %s", "Expected sequence of %d arguments, got %d: %s", plan->nargs),
2527                                                   plan->nargs, nargs, sv);
2528                 Py_DECREF(so);
2529
2530                 return NULL;
2531         }
2532
2533         oldcontext = CurrentMemoryContext;
2534         PG_TRY();
2535         {
2536                 char       *nulls = palloc(nargs * sizeof(char));
2537                 volatile int j;
2538
2539                 for (j = 0; j < nargs; j++)
2540                 {
2541                         PyObject   *elem,
2542                                            *so;
2543
2544                         elem = PySequence_GetItem(list, j);
2545                         if (elem != Py_None)
2546                         {
2547                                 so = PyObject_Str(elem);
2548                                 if (!so)
2549                                         PLy_elog(ERROR, "PL/Python function \"%s\" could not execute plan",
2550                                                          PLy_procedure_name(PLy_curr_procedure));
2551                                 Py_DECREF(elem);
2552
2553                                 PG_TRY();
2554                                 {
2555                                         char       *sv = PyString_AsString(so);
2556
2557                                         plan->values[j] =
2558                                                 InputFunctionCall(&(plan->args[j].out.d.typfunc),
2559                                                                                   sv,
2560                                                                                   plan->args[j].out.d.typioparam,
2561                                                                                   -1);
2562                                 }
2563                                 PG_CATCH();
2564                                 {
2565                                         Py_DECREF(so);
2566                                         PG_RE_THROW();
2567                                 }
2568                                 PG_END_TRY();
2569
2570                                 Py_DECREF(so);
2571                                 nulls[j] = ' ';
2572                         }
2573                         else
2574                         {
2575                                 Py_DECREF(elem);
2576                                 plan->values[j] =
2577                                         InputFunctionCall(&(plan->args[j].out.d.typfunc),
2578                                                                           NULL,
2579                                                                           plan->args[j].out.d.typioparam,
2580                                                                           -1);
2581                                 nulls[j] = 'n';
2582                         }
2583                 }
2584
2585                 rv = SPI_execute_plan(plan->plan, plan->values, nulls,
2586                                                           PLy_curr_procedure->fn_readonly, limit);
2587
2588                 pfree(nulls);
2589         }
2590         PG_CATCH();
2591         {
2592                 int                     k;
2593
2594                 MemoryContextSwitchTo(oldcontext);
2595                 PLy_error_in_progress = CopyErrorData();
2596                 FlushErrorState();
2597
2598                 /*
2599                  * cleanup plan->values array
2600                  */
2601                 for (k = 0; k < nargs; k++)
2602                 {
2603                         if (!plan->args[k].out.d.typbyval &&
2604                                 (plan->values[k] != PointerGetDatum(NULL)))
2605                         {
2606                                 pfree(DatumGetPointer(plan->values[k]));
2607                                 plan->values[k] = PointerGetDatum(NULL);
2608                         }
2609                 }
2610
2611                 if (!PyErr_Occurred())
2612                         PLy_exception_set(PLy_exc_error,
2613                                                           "unrecognized error in PLy_spi_execute_plan");
2614                 /* XXX this oughta be replaced with errcontext mechanism */
2615                 PLy_elog(WARNING, "in PL/Python function \"%s\"",
2616                                  PLy_procedure_name(PLy_curr_procedure));
2617                 return NULL;
2618         }
2619         PG_END_TRY();
2620
2621         for (i = 0; i < nargs; i++)
2622         {
2623                 if (!plan->args[i].out.d.typbyval &&
2624                         (plan->values[i] != PointerGetDatum(NULL)))
2625                 {
2626                         pfree(DatumGetPointer(plan->values[i]));
2627                         plan->values[i] = PointerGetDatum(NULL);
2628                 }
2629         }
2630
2631         if (rv < 0)
2632         {
2633                 PLy_exception_set(PLy_exc_spi_error,
2634                                                   "SPI_execute_plan failed: %s",
2635                                                   SPI_result_code_string(rv));
2636                 return NULL;
2637         }
2638
2639         return PLy_spi_execute_fetch_result(SPI_tuptable, SPI_processed, rv);
2640 }
2641
2642 static PyObject *
2643 PLy_spi_execute_query(char *query, long limit)
2644 {
2645         int                     rv;
2646         MemoryContext oldcontext;
2647
2648         oldcontext = CurrentMemoryContext;
2649         PG_TRY();
2650         {
2651                 rv = SPI_execute(query, PLy_curr_procedure->fn_readonly, limit);
2652         }
2653         PG_CATCH();
2654         {
2655                 MemoryContextSwitchTo(oldcontext);
2656                 PLy_error_in_progress = CopyErrorData();
2657                 FlushErrorState();
2658                 if (!PyErr_Occurred())
2659                         PLy_exception_set(PLy_exc_spi_error,
2660                                                           "unrecognized error in PLy_spi_execute_query");
2661                 /* XXX this oughta be replaced with errcontext mechanism */
2662                 PLy_elog(WARNING, "in PL/Python function \"%s\"",
2663                                  PLy_procedure_name(PLy_curr_procedure));
2664                 return NULL;
2665         }
2666         PG_END_TRY();
2667
2668         if (rv < 0)
2669         {
2670                 PLy_exception_set(PLy_exc_spi_error,
2671                                                   "SPI_execute failed: %s",
2672                                                   SPI_result_code_string(rv));
2673                 return NULL;
2674         }
2675
2676         return PLy_spi_execute_fetch_result(SPI_tuptable, SPI_processed, rv);
2677 }
2678
2679 static PyObject *
2680 PLy_spi_execute_fetch_result(SPITupleTable *tuptable, int rows, int status)
2681 {
2682         PLyResultObject *result;
2683         MemoryContext oldcontext;
2684
2685         result = (PLyResultObject *) PLy_result_new();
2686         Py_DECREF(result->status);
2687         result->status = PyInt_FromLong(status);
2688
2689         if (status > 0 && tuptable == NULL)
2690         {
2691                 Py_DECREF(result->nrows);
2692                 result->nrows = PyInt_FromLong(rows);
2693         }
2694         else if (status > 0 && tuptable != NULL)
2695         {
2696                 PLyTypeInfo args;
2697                 int                     i;
2698
2699                 Py_DECREF(result->nrows);
2700                 result->nrows = PyInt_FromLong(rows);
2701                 PLy_typeinfo_init(&args);
2702
2703                 oldcontext = CurrentMemoryContext;
2704                 PG_TRY();
2705                 {
2706                         if (rows)
2707                         {
2708                                 Py_DECREF(result->rows);
2709                                 result->rows = PyList_New(rows);
2710
2711                                 PLy_input_tuple_funcs(&args, tuptable->tupdesc);
2712                                 for (i = 0; i < rows; i++)
2713                                 {
2714                                         PyObject   *row = PLyDict_FromTuple(&args, tuptable->vals[i],
2715                                                                                                                 tuptable->tupdesc);
2716
2717                                         PyList_SetItem(result->rows, i, row);
2718                                 }
2719                                 PLy_typeinfo_dealloc(&args);
2720
2721                                 SPI_freetuptable(tuptable);
2722                         }
2723                 }
2724                 PG_CATCH();
2725                 {
2726                         MemoryContextSwitchTo(oldcontext);
2727                         PLy_error_in_progress = CopyErrorData();
2728                         FlushErrorState();
2729                         if (!PyErr_Occurred())
2730                                 PLy_exception_set(PLy_exc_error,
2731                                                                   "unrecognized error in PLy_spi_execute_fetch_result");
2732                         Py_DECREF(result);
2733                         PLy_typeinfo_dealloc(&args);
2734                         return NULL;
2735                 }
2736                 PG_END_TRY();
2737         }
2738
2739         return (PyObject *) result;
2740 }
2741
2742
2743 /*
2744  * language handler and interpreter initialization
2745  */
2746
2747 /*
2748  * _PG_init()                   - library load-time initialization
2749  *
2750  * DO NOT make this static nor change its name!
2751  */
2752 void
2753 _PG_init(void)
2754 {
2755         /* Be sure we do initialization only once (should be redundant now) */
2756         static bool inited = false;
2757
2758         if (inited)
2759                 return;
2760
2761         pg_bindtextdomain(TEXTDOMAIN);
2762
2763         Py_Initialize();
2764         PLy_init_interp();
2765         PLy_init_plpy();
2766         if (PyErr_Occurred())
2767                 PLy_elog(FATAL, "untrapped error in initialization");
2768         PLy_procedure_cache = PyDict_New();
2769         if (PLy_procedure_cache == NULL)
2770                 PLy_elog(ERROR, "could not create procedure cache");
2771
2772         inited = true;
2773 }
2774
2775 static void
2776 PLy_init_interp(void)
2777 {
2778         PyObject   *mainmod;
2779
2780         mainmod = PyImport_AddModule("__main__");
2781         if (mainmod == NULL || PyErr_Occurred())
2782                 PLy_elog(ERROR, "could not import \"__main__\" module");
2783         Py_INCREF(mainmod);
2784         PLy_interp_globals = PyModule_GetDict(mainmod);
2785         PLy_interp_safe_globals = PyDict_New();
2786         PyDict_SetItemString(PLy_interp_globals, "GD", PLy_interp_safe_globals);
2787         Py_DECREF(mainmod);
2788         if (PLy_interp_globals == NULL || PyErr_Occurred())
2789                 PLy_elog(ERROR, "could not initialize globals");
2790 }
2791
2792 static void
2793 PLy_init_plpy(void)
2794 {
2795         PyObject   *main_mod,
2796                            *main_dict,
2797                            *plpy_mod;
2798         PyObject   *plpy,
2799                            *plpy_dict;
2800
2801         /*
2802          * initialize plpy module
2803          */
2804         if (PyType_Ready(&PLy_PlanType) < 0)
2805                 elog(ERROR, "could not initialize PLy_PlanType");
2806         if (PyType_Ready(&PLy_ResultType) < 0)
2807                 elog(ERROR, "could not initialize PLy_ResultType");
2808
2809         plpy = Py_InitModule("plpy", PLy_methods);
2810         plpy_dict = PyModule_GetDict(plpy);
2811
2812         /* PyDict_SetItemString(plpy, "PlanType", (PyObject *) &PLy_PlanType); */
2813
2814         PLy_exc_error = PyErr_NewException("plpy.Error", NULL, NULL);
2815         PLy_exc_fatal = PyErr_NewException("plpy.Fatal", NULL, NULL);
2816         PLy_exc_spi_error = PyErr_NewException("plpy.SPIError", NULL, NULL);
2817         PyDict_SetItemString(plpy_dict, "Error", PLy_exc_error);
2818         PyDict_SetItemString(plpy_dict, "Fatal", PLy_exc_fatal);
2819         PyDict_SetItemString(plpy_dict, "SPIError", PLy_exc_spi_error);
2820
2821         /*
2822          * initialize main module, and add plpy
2823          */
2824         main_mod = PyImport_AddModule("__main__");
2825         main_dict = PyModule_GetDict(main_mod);
2826         plpy_mod = PyImport_AddModule("plpy");
2827         PyDict_SetItemString(main_dict, "plpy", plpy_mod);
2828         if (PyErr_Occurred())
2829                 elog(ERROR, "could not initialize plpy");
2830 }
2831
2832 /* the python interface to the elog function
2833  * don't confuse these with PLy_elog
2834  */
2835 static PyObject *PLy_output(volatile int, PyObject *, PyObject *);
2836
2837 static PyObject *
2838 PLy_debug(PyObject * self, PyObject * args)
2839 {
2840         return PLy_output(DEBUG2, self, args);
2841 }
2842
2843 static PyObject *
2844 PLy_log(PyObject * self, PyObject * args)
2845 {
2846         return PLy_output(LOG, self, args);
2847 }
2848
2849 static PyObject *
2850 PLy_info(PyObject * self, PyObject * args)
2851 {
2852         return PLy_output(INFO, self, args);
2853 }
2854
2855 static PyObject *
2856 PLy_notice(PyObject * self, PyObject * args)
2857 {
2858         return PLy_output(NOTICE, self, args);
2859 }
2860
2861 static PyObject *
2862 PLy_warning(PyObject * self, PyObject * args)
2863 {
2864         return PLy_output(WARNING, self, args);
2865 }
2866
2867 static PyObject *
2868 PLy_error(PyObject * self, PyObject * args)
2869 {
2870         return PLy_output(ERROR, self, args);
2871 }
2872
2873 static PyObject *
2874 PLy_fatal(PyObject * self, PyObject * args)
2875 {
2876         return PLy_output(FATAL, self, args);
2877 }
2878
2879
2880 static PyObject *
2881 PLy_output(volatile int level, PyObject * self, PyObject * args)
2882 {
2883         PyObject   *so;
2884         char       *volatile sv;
2885         MemoryContext oldcontext;
2886
2887         so = PyObject_Str(args);
2888         if (so == NULL || ((sv = PyString_AsString(so)) == NULL))
2889         {
2890                 level = ERROR;
2891                 sv = dgettext(TEXTDOMAIN, "could not parse error message in plpy.elog");
2892         }
2893
2894         oldcontext = CurrentMemoryContext;
2895         PG_TRY();
2896         {
2897                 elog(level, "%s", sv);
2898         }
2899         PG_CATCH();
2900         {
2901                 MemoryContextSwitchTo(oldcontext);
2902                 PLy_error_in_progress = CopyErrorData();
2903                 FlushErrorState();
2904                 Py_XDECREF(so);
2905
2906                 /*
2907                  * returning NULL here causes the python interpreter to bail. when
2908                  * control passes back to PLy_procedure_call, we check for PG
2909                  * exceptions and re-throw the error.
2910                  */
2911                 PyErr_SetString(PLy_exc_error, sv);
2912                 return NULL;
2913         }
2914         PG_END_TRY();
2915
2916         Py_XDECREF(so);
2917
2918         /*
2919          * return a legal object so the interpreter will continue on its merry way
2920          */
2921         Py_INCREF(Py_None);
2922         return Py_None;
2923 }
2924
2925
2926 /*
2927  * Get the name of the last procedure called by the backend (the
2928  * innermost, if a plpython procedure call calls the backend and the
2929  * backend calls another plpython procedure).
2930  *
2931  * NB: this returns the SQL name, not the internal Python procedure name
2932  */
2933 static char *
2934 PLy_procedure_name(PLyProcedure * proc)
2935 {
2936         if (proc == NULL)
2937                 return "<unknown procedure>";
2938         return proc->proname;
2939 }
2940
2941 /* output a python traceback/exception via the postgresql elog
2942  * function.  not pretty.
2943  */
2944 static void
2945 PLy_exception_set(PyObject * exc, const char *fmt,...)
2946 {
2947         char            buf[1024];
2948         va_list         ap;
2949
2950         va_start(ap, fmt);
2951         vsnprintf(buf, sizeof(buf), dgettext(TEXTDOMAIN, fmt), ap);
2952         va_end(ap);
2953
2954         PyErr_SetString(exc, buf);
2955 }
2956
2957 /* Emit a PG error or notice, together with any available info about the
2958  * current Python error.  This should be used to propagate Python errors
2959  * into PG.
2960  */
2961 static void
2962 PLy_elog(int elevel, const char *fmt,...)
2963 {
2964         char       *xmsg;
2965         int                     xlevel;
2966         StringInfoData emsg;
2967
2968         xmsg = PLy_traceback(&xlevel);
2969
2970         initStringInfo(&emsg);
2971         for (;;)
2972         {
2973                 va_list         ap;
2974                 bool            success;
2975
2976                 va_start(ap, fmt);
2977                 success = appendStringInfoVA(&emsg, dgettext(TEXTDOMAIN, fmt), ap);
2978                 va_end(ap);
2979                 if (success)
2980                         break;
2981                 enlargeStringInfo(&emsg, emsg.maxlen);
2982         }
2983
2984         PG_TRY();
2985         {
2986                 ereport(elevel,
2987                                 (errmsg("PL/Python: %s", emsg.data),
2988                                  (xmsg) ? errdetail("%s", xmsg) : 0));
2989         }
2990         PG_CATCH();
2991         {
2992                 pfree(emsg.data);
2993                 if (xmsg)
2994                         pfree(xmsg);
2995                 PG_RE_THROW();
2996         }
2997         PG_END_TRY();
2998
2999         pfree(emsg.data);
3000         if (xmsg)
3001                 pfree(xmsg);
3002 }
3003
3004 static char *
3005 PLy_traceback(int *xlevel)
3006 {
3007         PyObject   *e,
3008                            *v,
3009                            *tb;
3010         PyObject   *eob,
3011                            *vob = NULL;
3012         char       *vstr,
3013                            *estr;
3014         StringInfoData xstr;
3015
3016         /*
3017          * get the current exception
3018          */
3019         PyErr_Fetch(&e, &v, &tb);
3020
3021         /*
3022          * oops, no exception, return
3023          */
3024         if (e == NULL)
3025         {
3026                 *xlevel = WARNING;
3027                 return NULL;
3028         }
3029
3030         PyErr_NormalizeException(&e, &v, &tb);
3031         Py_XDECREF(tb);
3032
3033         eob = PyObject_Str(e);
3034         if (v && ((vob = PyObject_Str(v)) != NULL))
3035                 vstr = PyString_AsString(vob);
3036         else
3037                 vstr = "unknown";
3038
3039         /*
3040          * I'm not sure what to do if eob is NULL here -- we can't call PLy_elog
3041          * because that function calls us, so we could end up with infinite
3042          * recursion.  I'm not even sure if eob could be NULL here -- would an
3043          * Assert() be more appropriate?
3044          */
3045         estr = eob ? PyString_AsString(eob) : "unrecognized exception";
3046         initStringInfo(&xstr);
3047         appendStringInfo(&xstr, "%s: %s", estr, vstr);
3048
3049         Py_DECREF(eob);
3050         Py_XDECREF(vob);
3051         Py_XDECREF(v);
3052
3053         /*
3054          * intuit an appropriate error level based on the exception type
3055          */
3056         if (PLy_exc_error && PyErr_GivenExceptionMatches(e, PLy_exc_error))
3057                 *xlevel = ERROR;
3058         else if (PLy_exc_fatal && PyErr_GivenExceptionMatches(e, PLy_exc_fatal))
3059                 *xlevel = FATAL;
3060         else
3061                 *xlevel = ERROR;
3062
3063         Py_DECREF(e);
3064         return xstr.data;
3065 }
3066
3067 /* python module code */
3068
3069 /* some dumb utility functions */
3070 static void *
3071 PLy_malloc(size_t bytes)
3072 {
3073         void       *ptr = malloc(bytes);
3074
3075         if (ptr == NULL)
3076                 ereport(FATAL,
3077                                 (errcode(ERRCODE_OUT_OF_MEMORY),
3078                                  errmsg("out of memory")));
3079         return ptr;
3080 }
3081
3082 static void *
3083 PLy_malloc0(size_t bytes)
3084 {
3085         void       *ptr = PLy_malloc(bytes);
3086
3087         MemSet(ptr, 0, bytes);
3088         return ptr;
3089 }
3090
3091 static char *
3092 PLy_strdup(const char *str)
3093 {
3094         char       *result;
3095         size_t          len;
3096
3097         len = strlen(str) + 1;
3098         result = PLy_malloc(len);
3099         memcpy(result, str, len);
3100
3101         return result;
3102 }
3103
3104 /* define this away */
3105 static void
3106 PLy_free(void *ptr)
3107 {
3108         free(ptr);
3109 }