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
  
485
  
486
  
487
  
488
  
489
  
490
  
491
  
492
  
493
  
494
  
495
  
496
  
497
  
498
  
499
  
500
  
501
  
502
  
// This file is part of Roxen WebServer. 
// Copyright © 1996 - 2001, Roxen IS. 
// $Id: module.pike,v 1.119 2001/08/01 11:07:59 per Exp $ 
 
#include <module_constants.h> 
#include <module.h> 
#include <request_trace.h> 
 
constant __pragma_save_parent__ = 1; 
 
inherit "basic_defvar"; 
mapping(string:array(int)) error_log=([]); 
 
constant is_module = 1; 
// constant module_type = MODULE_ZERO; 
// constant module_name    = "Unnamed module"; 
// constant module_doc     = "Undocumented"; 
constant module_unique  = 1; 
 
 
private Configuration _my_configuration; 
private string _module_identifier = 
  lambda() { 
    mixed init_info = roxen->bootstrap_info->get(); 
    if (arrayp (init_info)) { 
      [_my_configuration, string modname] = init_info; 
      return _my_configuration->name + "/" + modname; 
    } 
  }(); 
static mapping _api_functions = ([]); 
 
string|array(string) module_creator; 
string module_url; 
RXML.TagSet module_tag_set; 
 
/* These functions exists in here because otherwise the messages in 
 * the event log does not always end up in the correct 
 * module/configuration.  And the reason for that is that if the 
 * messages are logged from subclasses in the module, the DWIM in 
 * roxenlib.pike cannot see that they are logged from a module. This 
 * solution is not really all that beatiful, but it works. :-) 
 */ 
void report_fatal( mixed ... args )  { predef::report_fatal( @args );  } 
void report_error( mixed ... args )  { predef::report_error( @args );  } 
void report_notice( mixed ... args ) { predef::report_notice( @args ); } 
void report_debug( mixed ... args )  { predef::report_debug( @args );  } 
 
 
string module_identifier() 
{ 
#if 1 
  return _module_identifier; 
#else 
  if (!_module_identifier) { 
    string|mapping name = this_object()->register_module()[1]; 
    if (mappingp (name)) name = name->standard; 
    string cname = sprintf ("%O", my_configuration()); 
    if (sscanf (cname, "Configuration(%s", cname) == 1 && 
        sizeof (cname) && cname[-1] == ')') 
      cname = cname[..sizeof (cname) - 2]; 
    _module_identifier = sprintf ("%s,%s", 
                                  name||this_object()->module_name, cname); 
  } 
  return _module_identifier; 
#endif 
} 
 
string _sprintf() 
{ 
  return sprintf ("RoxenModule(%s)", _module_identifier); 
} 
 
array register_module() 
{ 
  return ({ 
    this_object()->module_type, 
    this_object()->module_name, 
    this_object()->module_doc, 
    0, 
    module_unique, 
  }); 
} 
 
string fix_cvs(string from) 
{ 
  from = replace(from, ({ "$", "Id: "," Exp $" }), ({"","",""})); 
  sscanf(from, "%*s,v %s", from); 
  return replace(from,"/","-"); 
} 
 
int module_dependencies(Configuration configuration, 
                        array (string) modules, 
                        int|void now) 
//! If your module depends on other modules present in the server, 
//! calling <pi>module_dependencies()</pi>, supplying an array of 
//! module identifiers. A module identifier is either the filename 
//! minus extension, or a string on the form that Roxen.get_modname 
//! returns. In the latter case, the <config name> and <copy> parts 
//! are ignored. 
{ 
  modules = map (modules, 
                 lambda (string modname) { 
                   sscanf ((modname / "/")[-1], "%[^#]", modname); 
                   return modname; 
                 }); 
  Configuration conf = configuration || my_configuration(); 
  if (!conf) 
    report_warning ("Configuration not resolved; module(s) %s that %s " 
                    "depend on weren't added.", String.implode_nicely (modules), 
                    module_identifier()); 
  else 
    conf->add_modules( modules, now ); 
  return 1; 
} 
 
string file_name_and_stuff() 
{ 
  return ("<b>Loaded from:</b> "+(roxen->filename(this_object()))+"<br>"+ 
          (this_object()->cvs_version? 
           "<b>CVS Version: </b>"+ 
           fix_cvs(this_object()->cvs_version)+"\n":"")); 
} 
 
 
Configuration my_configuration() 
//! Returns the Configuration object of the virtual server the module 
//! belongs to. 
{ 
  return _my_configuration; 
} 
 
nomask void set_configuration(Configuration c) 
{ 
  if(_my_configuration && _my_configuration != c) 
    error("set_configuration() called twice.\n"); 
  _my_configuration = c; 
} 
 
void set_module_creator(string|array(string) c) 
//! Set the name and optionally email address of the author of the 
//! module. Names on the format "author name <author_email>" will 
//! end up as links on the module's information page in the admin 
//! interface. In the case of multiple authors, an array of such 
//! strings can be passed. 
{ 
  module_creator = c; 
} 
 
void set_module_url(string to) 
//! A common way of referring to a location where you maintain 
//! information about your module or similar. The URL will turn up 
//! on the module's information page in the admin interface, 
//! referred to as the module's home page. 
{ 
  module_url = to; 
} 
 
void free_some_sockets_please(){} 
 
void start(void|int num, void|Configuration conf) {} 
 
string status() {} 
 
string info(Configuration conf) 
{ 
 return (this_object()->register_module()[2]); 
} 
 
string sname( ) 
{ 
  return my_configuration()->otomod[ this_object() ]; 
} 
 
ModuleInfo my_moduleinfo( ) 
//! Returns the associated @ref{ModuleInfo} object 
{ 
  string f = sname(); 
  if( f ) return roxen.find_module( (f/"#")[0] ); 
} 
 
void save_me() 
{ 
  my_configuration()->save_one( this_object() ); 
  my_configuration()->module_changed( my_moduleinfo(), this_object() ); 
} 
 
void save()      { save_me(); } 
string comment() { return ""; } 
 
string query_internal_location() 
//! Returns the internal mountpoint, where <ref>find_internal()</ref> 
//! is mounted. 
{ 
  if(!_my_configuration) 
    error("Please do not call this function from create()!\n"); 
  return _my_configuration->query_internal_location(this_object()); 
} 
 
string query_absolute_internal_location(RequestID id) 
//! Returns the internal mountpoint as an absolute path. 
{ 
  return (id->misc->site_prefix_path || "") + query_internal_location(); 
} 
 
string query_location() 
//! Returns the mountpoint as an absolute path. The default 
//! implementation uses the "location" configuration variable in the 
//! module. 
{ 
  string s; 
  catch{s = query("location");}; 
  return s; 
} 
 
array(string) location_urls() 
//! Returns an array of all locations where the module is mounted. 
{ 
  string loc = query_location(); 
  if (!loc) return ({}); 
  if(!_my_configuration) 
    error("Please do not call this function from create()!\n"); 
  array(string) urls = copy_value(_my_configuration->query("URLs")); 
  string hostname; 
  if (string world_url = _my_configuration->query ("MyWorldLocation")) 
    sscanf (world_url, "%*s://%s%*[:/]", hostname); 
  if (!hostname) hostname = gethostname(); 
  for (int i = 0; i < sizeof (urls); i++) 
    if (sizeof (urls[i]/"*") == 2) 
      urls[i] = replace(urls[i], "*", hostname); 
  return map (urls, `+, loc[1..]); 
} 
 
/* By default, provide nothing. */ 
string query_provides() { return 0; } 
 
 
function(RequestID:int|mapping) query_seclevels() 
{ 
  if(catch(query("_seclevels")) || (query("_seclevels") == 0)) 
    return 0; 
  return roxen.compile_security_pattern(query("_seclevels"),this_object()); 
} 
 
Stat stat_file(string f, RequestID id){} 
array(string) find_dir(string f, RequestID id){} 
mapping(string:Stat) find_dir_stat(string f, RequestID id) 
{ 
  TRACE_ENTER("find_dir_stat(): \""+f+"\"", 0); 
 
  array(string) files = find_dir(f, id); 
  mapping(string:Stat) res = ([]); 
 
  foreach(files || ({}), string fname) { 
    TRACE_ENTER("stat()'ing "+ f + "/" + fname, 0); 
    Stat st = stat_file(replace(f + "/" + fname, "//", "/"), id); 
    if (st) { 
      res[fname] = st; 
      TRACE_LEAVE("OK"); 
    } else { 
      TRACE_LEAVE("No stat info"); 
    } 
  } 
 
  TRACE_LEAVE(""); 
  return(res); 
} 
 
string real_file(string f, RequestID id){} 
 
void add_api_function( string name, function f, void|array(string) types) 
{ 
  _api_functions[name] = ({ f, types }); 
} 
 
mapping api_functions() 
{ 
  return _api_functions; 
} 
 
#if ROXEN_COMPAT <= 1.4 
mapping(string:function) query_tag_callers() 
//! Compat 
{ 
  mapping(string:function) m = ([]); 
  foreach(glob("tag_*", indices( this_object())), string q) 
    if(functionp( this_object()[q] )) 
      m[replace(q[4..], "_", "-")] = this_object()[q]; 
  return m; 
} 
 
mapping(string:function) query_container_callers() 
//! Compat 
{ 
  mapping(string:function) m = ([]); 
  foreach(glob("container_*", indices( this_object())), string q) 
    if(functionp( this_object()[q] )) 
      m[replace(q[10..], "_", "-")] = this_object()[q]; 
  return m; 
} 
#endif 
 
mapping(string:array(int|function)) query_simpletag_callers() 
{ 
  mapping(string:array(int|function)) m = ([]); 
  foreach(glob("simpletag_*", indices(this_object())), string q) 
    if(functionp(this_object()[q])) 
      m[replace(q[10..],"_","-")] = 
        ({ intp (this_object()[q + "_flags"]) && this_object()[q + "_flags"], 
           this_object()[q] }); 
  return m; 
} 
 
mapping(string:array(int|function)) query_simple_pi_tag_callers() 
{ 
  mapping(string:array(int|function)) m = ([]); 
  foreach (glob ("simple_pi_tag_*", indices (this_object())), string q) 
    if (functionp (this_object()[q])) 
      m[replace (q[sizeof ("simple_pi_tag_")..], "_", "-")] = 
        ({(intp (this_object()[q + "_flags"]) && this_object()[q + "_flags"]) | 
          RXML.FLAG_PROC_INSTR, this_object()[q]}); 
  return m; 
} 
 
RXML.TagSet query_tag_set() 
{ 
  if (!module_tag_set) { 
    array(function|program|object) tags = 
      filter (rows (this_object(), 
                    glob ("Tag*", indices (this_object()))), 
              functionp); 
    for (int i = 0; i < sizeof (tags); i++) 
      if (programp (tags[i])) 
        if (!tags[i]->is_RXML_Tag) tags[i] = 0; 
        else tags[i] = tags[i](); 
      else { 
        tags[i] = tags[i](); 
        // Bogosity: The check is really a little too late here.. 
        if (!tags[i]->is_RXML_Tag) tags[i] = 0; 
      } 
    tags -= ({0}); 
    module_tag_set = 
      (this_object()->ModuleTagSet || RXML.TagSet) (module_identifier(), tags); 
  } 
  return module_tag_set; 
} 
 
mixed get_value_from_file(string path, string index, void|string pre) 
{ 
  Stdio.File file=Stdio.File(); 
  if(!file->open(path,"r")) return 0; 
  if(index[sizeof(index)-2..sizeof(index)-1]=="()") { 
    return compile_string((pre||"")+file->read())[index[..sizeof(index)-3]](); 
  } 
  return compile_string((pre||"")+file->read())[index]; 
} 
 
static private mapping __my_tables = ([]); 
 
static array(mapping(string:mixed)) sql_query( string query, mixed ... args ) 
//! Do a SQL-query using @[get_my_sql], the table names in the query 
//! should be written as &table; instead of table. As an example, if 
//! the tables 'meta' and 'data' have been created with create_tables 
//! or get_my_table, this query will work: 
//! 
//! SELECT &meta;.id AS id, &data;.data as DATA 
//!        FROM &data;, &meta; WHERE &my.meta;.xsize=200 
//! 
{ 
  return get_my_sql()->query( replace( query, __my_tables ), @args ); 
} 
 
 
static object sql_big_query( string query, mixed ... args ) 
//! Identical to @[sql_query], but the @[Sql.sql()->big_query] method 
//! will be used instead of the @[Sql.sql()->query] method. 
{ 
  return get_my_sql()->big_query( replace( query, __my_tables ), @args ); 
} 
 
static void create_sql_tables( mapping(string:array(string)) defenitions ) 
//! Create multiple tables in one go. See @[get_my_table] 
{ 
  foreach( indices( defenitions ), string t ) 
    get_my_table( t, defenitions[t] ); 
} 
 
static string get_my_table( string|array(string) name, 
                            void|array(string)|string defenition ) 
//! @decl string get_my_table( string name, array(string) types ) 
//! @decl string get_my_table( string name, string defenition ) 
//! @decl string get_my_table( string defenition ) 
//! @decl string get_my_table( array(string) defenition ) 
//! 
//! Returns the name of a table in the 'shared' database that is 
//! unique for this module. It is possible to select another database 
//! by using @[set_my_db] before calling this function. 
//! 
//! You can use @[create_sql_tables] instead of this function if you want 
//! to create more than one table in one go. 
//!  
//! In the first form, @[name] is the (postfix of) the name of the 
//! table, and @[types] is an array of defenitions, as an example: 
//! 
//! @example{ 
//!   cache_table = get_my_table( "cache", ({ 
//!               "id INT UNSIGNED AUTO_INCREMENT", 
//!               "data BLOB", 
//!               }) ); 
//!  @} 
//!   
//! In the second form, the whole table defenition is instead sent as 
//! a string. The cases where the name is not included (the third and 
//! fourth form) is equivalent to the first two cases with the name "" 
//! 
//! If the table does not exist in the datbase, it is created. 
//! 
// If it exists, but it's defenition is different, the table will be 
// altered with a ALTER TABLE call to conform to the defenition. This 
// might not work if the database the table resides in is not a MySQL 
// database (normally it is, but it's possible, using @[set_my_db], 
// to change this). 
// 
//! @note This function may not be called from create 
{ 
  string oname; 
  if( !defenition ) 
  { 
    defenition = name; 
    oname = name = ""; 
  } 
  else if(strlen(name)) 
    name = "_"+(oname = name); 
 
  Sql.Sql sql = get_my_sql(); 
  string res = hash(_my_configuration->name)->digits(36) 
    + "_" + replace(sname(),"#","_") + name; 
 
  if( !sql ) 
  { 
    report_error("Failed to get SQL handle, permission denied for "+my_db+"\n"); 
    return 0; 
  } 
  if( arrayp( defenition ) ) 
    defenition *= ", "; 
   
  if( catch(sql->query( "SELECT * FROM "+res+" LIMIT 1" )) ) 
  { 
    mixed error = 
      catch 
      { 
        get_my_sql()->query( "CREATE TABLE "+res+" ("+defenition+")" ); 
      }; 
    if( error ) 
    { 
      if( strlen( name ) ) 
        name = " "+name; 
      report_notice( "Failed to create table"+name+": "+ 
                     describe_error( error ) ); 
      return 0; 
    } 
    return __my_tables[ "&"+oname+";" ] = res; 
  } 
//   // Update defenition if it has changed. 
//   mixed error =  
//     catch 
//     { 
//       get_my_sql()->query( "ALTER TABLE "+res+" ("+defenition+")" ); 
//     }; 
//   if( error ) 
//   { 
//     if( strlen( name ) ) 
//       name = " for "+name; 
//     report_notice( "Failed to update table defenition"+name+": "+ 
//               describe_error( error ) ); 
//   } 
  return __my_tables[ "&"+oname+";" ] = res; 
} 
 
 
 
 
 
static string my_db = "shared"; 
static void set_my_db( string to ) 
//! Select the database in which tables will be created with 
//! get_my_table, and also the one that will be returned by 
//! @[get_my_sql] 
{ 
  my_db = to; 
} 
 
static Sql.Sql get_my_sql( int|void read_only ) 
//! Return a SQL-object for the database set with @[set_my_db], 
//! defaulting to the 'shared' database. If read_only is specified, 
//! the database will be opened in read_only mode. 
//!  
//! See also @[DBManager.get] 
{ 
  return DBManager.cached_get( my_db, _my_configuration, read_only ); 
}