1
  
2
  
3
  
4
  
5
  
6
  
7
  
8
  
9
  
10
  
11
  
12
  
13
  
14
  
15
  
16
  
17
  
18
  
19
  
20
  
21
  
22
  
23
  
24
  
25
  
26
  
27
  
28
  
29
  
30
  
31
  
32
  
33
  
34
  
35
  
36
  
37
  
38
  
39
  
40
  
41
  
42
  
43
  
44
  
45
  
46
  
47
  
48
  
49
  
50
  
51
  
52
  
53
  
54
  
55
  
56
  
57
  
58
  
59
  
60
  
61
  
62
  
63
  
64
  
65
  
66
  
67
  
68
  
69
  
70
  
71
  
72
  
73
  
74
  
75
  
76
  
77
  
78
  
79
  
80
  
81
  
82
  
83
  
84
  
85
  
86
  
87
  
88
  
89
  
90
  
91
  
92
  
93
  
94
  
95
  
96
  
97
  
98
  
99
  
100
  
101
  
102
  
103
  
104
  
105
  
106
  
107
  
108
  
109
  
110
  
111
  
112
  
113
  
114
  
115
  
116
  
117
  
118
  
119
  
120
  
121
  
122
  
123
  
124
  
125
  
126
  
127
  
128
  
129
  
130
  
131
  
132
  
133
  
134
  
135
  
136
  
137
  
138
  
139
  
140
  
141
  
142
  
143
  
144
  
145
  
146
  
147
  
148
  
149
  
150
  
151
  
152
  
153
  
154
  
155
  
156
  
157
  
158
  
159
  
160
  
161
  
162
  
163
  
164
  
165
  
166
  
167
  
168
  
169
  
170
  
171
  
172
  
173
  
174
  
175
  
176
  
177
  
178
  
179
  
180
  
181
  
182
  
183
  
184
  
185
  
186
  
187
  
188
  
189
  
190
  
191
  
192
  
193
  
194
  
195
  
196
  
197
  
198
  
199
  
200
  
201
  
202
  
203
  
204
  
205
  
206
  
207
  
208
  
209
  
210
  
211
  
212
  
213
  
214
  
215
  
216
  
217
  
218
  
219
  
220
  
221
  
222
  
223
  
224
  
225
  
226
  
227
  
228
  
229
  
230
  
231
  
232
  
233
  
234
  
235
  
236
  
237
  
238
  
239
  
240
  
241
  
242
  
243
  
244
  
245
  
246
  
247
  
248
  
249
  
250
  
251
  
252
  
253
  
254
  
255
  
256
  
257
  
258
  
259
  
260
  
261
  
262
  
263
  
264
  
265
  
266
  
267
  
268
  
269
  
270
  
271
  
272
  
273
  
274
  
275
  
276
  
277
  
278
  
279
  
280
  
281
  
282
  
283
  
284
  
285
  
286
  
287
  
288
  
289
  
290
  
291
  
292
  
293
  
294
  
295
  
296
  
297
  
298
  
299
  
300
  
301
  
302
  
303
  
304
  
305
  
306
  
307
  
308
  
309
  
310
  
311
  
312
  
313
  
314
  
315
  
316
  
317
  
318
  
319
  
320
  
321
  
322
  
323
  
324
  
325
  
326
  
327
  
328
  
329
  
330
  
331
  
332
  
333
  
334
  
335
  
336
  
337
  
338
  
339
  
340
  
341
  
342
  
343
  
344
  
345
  
346
  
347
  
348
  
349
  
350
  
351
  
352
  
353
  
354
  
355
  
356
  
357
  
358
  
359
  
360
  
361
  
362
  
363
  
364
  
365
  
366
  
367
  
368
  
369
  
370
  
371
  
372
  
373
  
374
  
375
  
376
  
377
  
378
  
379
  
380
  
381
  
382
  
383
  
384
  
385
  
386
  
387
  
388
  
389
  
390
  
391
  
392
  
393
  
394
  
395
  
396
  
397
  
398
  
399
  
400
  
401
  
402
  
403
  
404
  
405
  
406
  
407
  
408
  
409
  
410
  
411
  
412
  
413
  
414
  
415
  
416
  
417
  
418
  
419
  
420
  
421
  
422
  
423
  
424
  
425
  
426
  
427
  
428
  
429
  
430
  
431
  
432
  
433
  
434
  
435
  
436
  
437
  
438
  
439
  
440
  
441
  
442
  
443
  
444
  
445
  
446
  
447
  
448
  
449
  
450
  
451
  
452
  
453
  
454
  
455
  
456
  
457
  
458
  
459
  
460
  
461
  
462
  
463
  
464
  
465
  
466
  
467
  
468
  
469
  
470
  
471
  
472
  
473
  
474
  
475
  
476
  
477
  
478
  
479
  
480
  
481
  
482
  
483
  
484
  
/* 
 * This is part of the Postgres module for Pike. 
 * 
 */ 
 
#pike __REAL_VERSION__ 
 
// Cannot dump this since the #if constant(...) check below may depend 
// on the presence of system libs at runtime. 
optional constant dont_dump_program = 1; 
 
#if constant(Postgres.postgres) 
 
//! This is an interface to the Postgres (Postgres95, PostgreSQL) database 
//! server. This module may or may not be available on your Pike, 
//! depending on whether or not the appropriate include and library files could 
//! be found at compile-time. Note that you @b{do not@} need to have a 
//! Postgres server running on your host to use this module: you can 
//! connect to the database over a TCP/IP socket. 
//! 
//! @note 
//! This driver has been @b{deprecated@}.  You should use the 
//! more advanced driver @[Sql.pgsql] to access PostgreSQL databases instead. 
//! 
//! @note 
//! Also note that @b{this module uses blocking I/O@} to connect 
//! to the server, but it is thread-safe, and so it can be used in a 
//! multithreaded environment. 
//! 
//! The behavior of the Postgres C API also depends on certain 
//! environment variables defined in the environment of the Pike 
//! interpreter; some notice and warning notifications might are dumped 
//! on stderr. 
//! 
//! @string 
//!   @value "PGHOST" 
//!     Sets the name of the default host to connect to. It defaults 
//!     to @expr{"localhost"@}. 
//!   @value "PGHOSTADDR" 
//!     Set the numeric IP address to connect to.  This may be set instead of 
//!     or in addition to PGHOST to avoid DNS lookups. 
//!   @value "PGPORT" 
//!     Sets the default port or unix domain socket file extension to connect to, 
//!     otherwise it will use compile-time defaults (that is: the time you compiled 
//!     the postgres library, not the Pike driver). 
//!   @value "PGDATABASE" 
//!     Sets the default database to connect to. 
//!   @value "PGUSER" 
//!     Sets the default username used to connect to the database. 
//!   @value "PGPASSWORD" 
//!     Set the default password used to connect to the database.  This is not 
//!     recommended for security reasons, some operating systems allow non-root 
//!     users to see process environment variables.  Use your ~/.pgpass file instead. 
//!   @value "PGSERVICE" 
//!     Sets the service name to be looked up in pg_service.conf.  This is a 
//!     shorter way to set all the parameters. 
//!   @value "PGSSLMODE" 
//!     This determines how SSL connections will be negotiated.  If set to @b{disable@}, 
//!     it will require an unencrypted connection; @b{allow@} will negotiate a non-SSL 
//!     connection, and if it fails try an SSL connection; @b{prefer@} will attempt SSL 
//!     connections first, falling back to non-SSL if SSL fails; and @b{require@} will 
//!     force an SSL connection or cause an error if SSL is not available. 
//!   @value "PGOPTIONS" 
//!     Sets some extra flags for the frontend-backend connection. 
//!     @b{do not set@} unless you're sure of what you're doing. 
//!   @value "PGREALM" 
//!     Sets the Kerberos realm for authentication, if it is different 
//!     from the local realm.  PostgreSQL will attempt to authenticate 
//!     with servers for this realm and use seperate ticket files to avoid 
//!     conflicts with local ticket files.  This variable is only used if 
//!     Keberos authentication is selected in PostgreSQL. 
//!   @value "PGTTY" 
//!     Sets the file to be used for Postgres frontend debugging. 
//!     Do not use, unless you're sure of what you're doing. 
//!     This variable is ignored in recent versions of PostgreSQL. 
//! @endstring 
//! 
//! Refer to the Postgres documentation for further details. 
//! 
//! @seealso 
//!  @[Sql.pgsql], @[Sql.Sql], @[Postgres.postgres], @[Sql.postgres_result] 
 
#define ERROR(X) throw (({X,backtrace()})) 
 
inherit Postgres.postgres: mo; 
private protected mixed  callout; 
private string has_relexpires = "unknown"; 
 
//! @decl void select_db(string dbname) 
//! 
//! This function allows you to connect to a database. Due to 
//! restrictions of the Postgres frontend-backend protocol, you always 
//! have to be connected to a database, so in fact this function just 
//! allows you to connect to a different database on the same server. 
//! 
//! @note 
//! This function @b{can@} raise exceptions if something goes wrong 
//! (backend process not running, not enough permissions..) 
//! 
//! @seealso 
//!   @[create] 
 
//! @decl string error() 
//! 
//! This function returns the textual description of the last 
//! server-related error. Returns @expr{0@} if no error has occurred 
//! yet. It is not cleared upon reading (can be invoked multiple 
//! times, will return the same result until a new error occurs). 
//! 
//! @seealso 
//!   @[big_query] 
 
//! @decl string host_info() 
//! 
//! This function returns a string describing what host are we talking to, 
//! and how (TCP/IP or UNIX sockets). 
 
//! @decl void reset() 
//! 
//! This function resets the connection to the backend. Can be used for 
//! a variety of reasons, for example to detect the status of a connection. 
//! 
//! @note 
//! This function is Postgres-specific, and thus it is not available 
//! through the generic SQL-interface. 
 
//! @decl string version 
//! 
//! Should you need to report a bug to the author, please submit along with 
//! the report the driver version number, as returned by this call. 
 
private protected string glob_to_regexp (string glob) { 
        if (!glob||!sizeof(glob)) 
                return 0; 
        return "^"+replace(glob,({"*","?","'","\\"}),({".*",".","\\'","\\\\"}))+"$"; 
} 
 
protected private int mkbool(string s) { 
        if (s=="f") 
                return 0; 
        return 1; 
} 
 
//! @decl void create() 
//! @decl void create(string host, void|string database, void|string user,@ 
//!                   void|string password, void|mapping options) 
//! 
//! With no arguments, this function initializes (reinitializes if a 
//! connection had been previously set up) a connection to the 
//! Postgres backend. Since Postgres requires a database to be 
//! selected, it will try to connect to the default database. The 
//! connection may fail however for a variety of reasons, in this case 
//! the most likely of all is because you don't have enough authority 
//! to connect to that database. So use of this particular syntax is 
//! discouraged. 
//! 
//! The host argument can have the syntax @expr{"hostname"@} or 
//! @expr{"hostname:portname"@}. This allows to specify the TCP/IP 
//! port to connect to. If it is @expr{0@} or @expr{""@}, it will try 
//! to connect to localhost, default port. 
//! 
//! The database argument specifies the database to connect to. If 
//! @expr{0@} or @expr{""@}, it will try to connect to the specified 
//! database. 
//! 
//! @note 
//! Notice that this function @b{can@} raise exceptions if the db 
//! server doesn't respond, if the database doesn't exist or is not 
//! accessible by you. 
//! 
//! You don't need bothering about syncronizing the connection to the database: 
//! it is automatically closed (and the database is sync-ed) when the 
//! object is destroyed. 
//! 
//! @seealso 
//!   @[Sql.pgsql], @[Postgres.postgres], @[Sql.Sql], @[postgres->select_db] 
void create(void|string host, void|string database, void|string user, 
            void|string _pass, void|mapping options) { 
        string pass = _pass; 
        _pass = "CENSORED"; 
        string real_host=host, real_db=database; 
        int port=0; 
        quote = this->_quote ? this->_quote : simple_quote; 
        if (stringp(host)&&(search(host,":")>=0)) 
                if (sscanf(host,"%s:%d",real_host,port)!=2) 
                        ERROR("Error in parsing the hostname argument.\n"); 
 
        mo::create(real_host||"",real_db||"",user||"",pass||"",port); 
} 
 
protected void poll (int delay) 
{ 
        callout=call_out(poll,delay,delay); 
        big_query(""); 
} 
 
//! @decl void set_notify_callback() 
//! @decl void set_notify_callback(function f) 
//! @decl void set_notify_callback(function f, int|float poll_delay) 
//! 
//! With Postgres you can associate events and notifications to tables. 
//! This function allows you to detect and handle such events. 
//! 
//! With no arguments, resets and removes any callback you might have 
//! put previously, and any polling cycle. 
//! 
//! With one argument, sets the notification callback (there can be only 
//! one for each sqlobject). 
//! 
//! With two arguments, sets a notification callback and sets a polling 
//! cycle. 
//! 
//! The polling cycle is necessary because of the way notifications are 
//! delivered, that is piggyback with a query result. This means that 
//! if you don't do any query, you'll receive no notification. The polling 
//! cycle starts a call_out cycle which will do an empty query when 
//! the specified interval expires, so that pending notifications 
//! may be delivered. 
//! 
//! The callback function must return no value, and takes a string argument, 
//! which will be the name of the table on which the notification event 
//! has occurred. In future versions, support for user-specified arguments 
//! will be added. 
//! 
//! @note 
//! The polling cycle can be run only if your process is in "event-driven mode" 
//! (that is, if 'main' has returned a negative number). 
//! 
//! This function is Postgres-specific, and thus it is not available 
//! through the generic SQL-interface. 
//! 
//! @fixme 
//! An integer can be passed as first argument, but it's effect is 
//! not documented. 
void set_notify_callback(int|function f, int|float|void poll_delay) { 
        if (callout) { 
                remove_call_out(callout); 
                callout=0; 
        } 
        if (intp(f)) { 
                mo::_set_notify_callback(0); 
                return; 
        } 
        mo::_set_notify_callback(f); 
        if(poll_delay>0) 
                poll(poll_delay); 
} 
 
function quote; 
string simple_quote(string s) 
{ 
  return replace(s, ({ "\\", "'", "\0" }), ({ "\\\\", "''", "\\0" }) ); 
} 
 
//! This function creates a new database with the given name (assuming we 
//! have enough permissions to do this). 
//! 
//! @seealso 
//!   @[drop_db] 
void create_db(string db) { 
        big_query(sprintf("CREATE DATABASE %s",db)); 
} 
 
//! This function destroys a database and all the data it contains (assuming 
//! we have enough permissions to do so). 
//! 
//! @seealso 
//!   @[create_db] 
void drop_db(string db) { 
        big_query(sprintf("DROP database %s",db)); 
} 
 
//! This function returns a string describing the server we are 
//! talking to. It has the form @expr{"servername/serverversion"@} 
//! (like the HTTP protocol description) and is most useful in 
//! conjunction with the generic SQL-server module. 
string server_info () { 
  return "Postgres/unknown"; 
} 
 
//! Lists all the databases available on the server. 
//! If glob is specified, lists only those databases matching it. 
array(string) list_dbs (void|string glob) { 
        array name,ret=({}); 
        object res= 
                big_query( 
                                "SELECT datname from pg_database"+ 
                                ((glob&&sizeof(glob))? " WHERE datname ~ '"+glob_to_regexp(glob)+"'" : "") 
                                ); 
        while (name=res->fetch_row()) { 
                ret += ({name[0]}); 
        } 
        return sort(ret); 
} 
 
//! Returns an array containing the names of all the tables in the currently 
//! selected database. 
//! If a glob is specified, it will return only those tables 
//! whose name matches it. 
array(string) list_tables (void|string glob) { 
        array name,ret=({}); 
        object res; 
        res=big_query( 
                        "SELECT relname, relkind FROM pg_class, pg_user " 
                        "WHERE ( relkind = 'r' OR relkind = 'i' OR relkind = 'S') " 
                        "AND relname !~ '^pg_' " 
                        "AND usesysid = relowner " + 
                        ((glob && sizeof(glob)) ? "AND relname ~ '"+glob_to_regexp(glob)+"' " : "") + 
                        "ORDER BY relname" 
                        ); 
        while (name=res->fetch_row()) { 
                ret += ({name[0]}); 
        } 
        return ret; 
} 
 
//! Returns a mapping, indexed on the column name, of mappings describing 
//! the attributes of a table of the current database. 
//! If a glob is specified, will return descriptions only of the columns 
//! matching it. 
//! 
//! The currently defined fields are: 
//! 
//! @mapping 
//!   @member int "has_rules" 
//! 
//!   @member int "is_shared" 
//! 
//!   @member string "owner" 
//!     The textual representation of a Postgres uid. 
//! 
//!   @member string "length" 
//! 
//!   @member string "text" 
//!     A textual description of the internal (to the server) type-name 
//! 
//!   @member mixed "default" 
//! 
//!   @member string "expires" 
//!     The "relexpires" attribute for the table. Obsolescent; modern 
//!     versions of Postgres don't seem to use this feature, so don't 
//!     count on this field to contain any useful value. 
//! 
//! @endmapping 
//! 
array(mapping(string:mixed)) list_fields (string table, void|string wild) 
{ 
  array row, ret=({}); 
  string schema; 
 
  if (has_relexpires == "unknown") 
  { 
    if (catch (big_query("SELECT relexpires FROM pg_class WHERE 1 = 0"))) 
      has_relexpires = "no"; 
    else 
      has_relexpires = "yes"; 
  } 
 
  sscanf(table, "%s.%s", schema, table); 
 
  object res = big_query( 
        "SELECT a.attnum, a.attname, t.typname, a.attlen, c.relowner, " 
        "c.relisshared, c.relhasrules, t.typdefault " + 
        (has_relexpires == "yes" ? ", c.relexpires " : "") + 
        (schema ? ", s.schemaname " : "") + 
        "FROM pg_class c, pg_attribute a, pg_type t " + 
        (schema ? ", pg_tables s " : "") + 
        "WHERE c.relname = '"+table+"' AND a.attnum > 0 " + 
        (schema ? "AND s.tablename = '"+table+"' " : "") + 
        "AND a.attrelid = c.oid AND a.atttypid = t.oid ORDER BY attnum"); 
 
  while (row = res->fetch_row()) 
  { 
    if (wild && sizeof(wild) && !glob(wild, row[1])) 
      continue; 
    ret += 
      ({ ([ 
         "name":    row[1], 
         "type":    row[2], 
         "length":  row[3], 
         "owner":   row[4], 
         "is_shared":       mkbool(row[5]), 
         "has_rules":   mkbool(row[6]), 
         "default":     row[7], 
         "expires":     (sizeof(row) > 8 ? row[8] : 0) 
       ]) }); 
  } 
  return ret; 
} 
 
//! This is the only provided interface which allows you to query the 
//! database. If you wish to use the simpler "query" function, you need to 
//! use the @[Sql.Sql] generic SQL-object. 
//! 
//! It returns a postgres_result object (which conforms to the 
//! @[Sql.sql_result] standard interface for accessing data). I 
//! recommend using @[Sql.Sql()->query()] for simpler queries (because it is 
//! easier to handle, but stores all the result in memory), and 
//! @[big_query()] for queries you expect to return huge amounts of 
//! data (it's harder to handle, but fetches results on demand). 
//! 
//! @note 
//! This function @b{can@} raise exceptions. 
//! 
//! @seealso 
//!   @[Sql.Sql], @[Sql.sql_result] 
int|object big_query(object|string q, mapping(string|int:mixed)|void bindings) 
{ 
  if(stringp(q) && String.width(q)>8) 
    q=string_to_utf8(q); 
  if (!bindings) 
    return ::big_query(q); 
  int pi=0,rep=0; 
  array(string|int) paramValues=allocate(sizeof(bindings)); 
  array(string) from=allocate(sizeof(bindings)); 
  array(string) to=allocate(sizeof(bindings)); 
  foreach(bindings; mixed name; mixed value) { 
    // Throws if mapping key is empty string. 
    if(stringp(name)) { 
      if(name[0]!=':') 
        name=":"+name; 
      if(name[1]=='_') { 
        // Special parameter 
        continue; 
      } 
      if(search(q,name)<0) 
        continue;                        // Omit unused references 
    } 
    from[rep]=name; 
    string rval; 
    if(multisetp(value)) { 
      rval=sizeof(value) ? indices(value)[0] : ""; 
    } 
    else { 
      if(undefinedp(value)) 
        paramValues[pi++]=UNDEFINED; 
      else { 
        if(stringp(value) && String.width(value)>8) 
          value=string_to_utf8(value); 
        paramValues[pi++]=(string)value; 
      } 
      rval="$"+(string)pi; 
    } 
    to[rep++]=rval; 
  } 
  paramValues= pi ? paramValues[..pi-1] : UNDEFINED; 
  if(rep--) { 
    q=replace(q,from[..rep],to[..rep]); 
  } 
  return paramValues ? ::big_query(q, paramValues): ::big_query(q); 
} 
 
//! This is an alias for @[big_query()], since @[big_query()] already supports 
//! streaming. 
//! 
//! @seealso 
//!   @[big_query], @[Sql.Sql], @[Sql.sql_result] 
int|object streaming_query(object|string q, 
 mapping(string|int:mixed)|void bindings) 
{ 
  return big_query(q, bindings); 
} 
 
#else 
/* 
 * If libpq wasn't available at compile time, the pgsql-module can provide 
 * near the same functionality as the postgres module. 
 */ 
 
//! Maps SQL-urls for 
//!   @tt{postgres://[user[:password]@@][hostname][:port][/database]@} 
//! onto 
//!   @tt{pgsql://[user[:password]@@][hostname][:port][/database]@} 
//! 
//! This only happens if Pike was compiled without libpq 
//! support, therefore Pike falls back to the faster, smaller memory 
//! footprint, more advanced and native PostgreSQL driver called @[Sql.pgsql]. 
//! 
//! @seealso 
//!   @[Sql.pgsql], @[Sql.Sql] 
inherit Sql.pgsql; 
#endif /* constant(Postgres.postgres) */