835c6c2001-06-17Martin Nilsson // This file is part of Roxen WebServer. // Copyright © 1996 - 2001, Roxen IS.
9a91eb2004-05-04Martin Stjernholm // $Id: module.pike,v 1.171 2004/05/04 12:35:13 mast Exp $
c20c872000-02-16Per Hedbor  #include <module_constants.h>
b1fca01996-11-12Per Hedbor #include <module.h>
c5e0961999-10-04Per Hedbor #include <request_trace.h>
b275871998-05-23Henrik Grubbström (Grubba) 
c089042001-06-11Per Hedbor constant __pragma_save_parent__ = 1;
a59d252000-07-04Per Hedbor inherit "basic_defvar";
9d9b9b1999-11-17Per Hedbor mapping(string:array(int)) error_log=([]);
c5e0961999-10-04Per Hedbor 
9d9b9b1999-11-17Per Hedbor constant is_module = 1;
a730c22001-01-19Per Hedbor // constant module_type = MODULE_ZERO; // constant module_name = "Unnamed module"; // constant module_doc = "Undocumented"; constant module_unique = 1;
c5e0961999-10-04Per Hedbor 
a59d252000-07-04Per Hedbor 
7211372001-06-29Martin Stjernholm private Configuration _my_configuration;
0aa37d2001-08-23Martin Stjernholm private string _module_local_identifier;
2e8d0f2001-06-28Martin Stjernholm private string _module_identifier =
7211372001-06-29Martin Stjernholm  lambda() {
3557f52001-06-30Martin Stjernholm  mixed init_info = roxen->bootstrap_info->get(); if (arrayp (init_info)) {
0aa37d2001-08-23Martin Stjernholm  [_my_configuration, _module_local_identifier] = init_info; return _my_configuration->name + "/" + _module_local_identifier;
7211372001-06-29Martin Stjernholm  } }();
a59d252000-07-04Per Hedbor static mapping _api_functions = ([]); string|array(string) module_creator; string module_url; RXML.TagSet module_tag_set;
c20c872000-02-16Per Hedbor /* 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
b7eaa22001-08-09Martin Stjernholm  * solution is not really all that beautiful, but it works. :-)
c20c872000-02-16Per Hedbor  */ 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 ); }
b9ec252000-01-05Martin Stjernholm string module_identifier()
0aa37d2001-08-23Martin Stjernholm //! Returns a string that uniquely identifies this module instance //! within the server. The identifier is the same as //! @[Roxen.get_module] and @[Roxen.get_modname] handles.
b9ec252000-01-05Martin Stjernholm {
4246ca2001-06-28Martin Stjernholm #if 1
2e8d0f2001-06-28Martin Stjernholm  return _module_identifier;
4246ca2001-06-28Martin Stjernholm #else
2e8d0f2001-06-28Martin Stjernholm  if (!_module_identifier) {
225c8e2001-01-31Marcus Comstedt  string|mapping name = this_object()->register_module()[1];
b9ec252000-01-05Martin Stjernholm  if (mappingp (name)) name = name->standard;
8d49192000-03-18Martin Stjernholm  string cname = sprintf ("%O", my_configuration()); if (sscanf (cname, "Configuration(%s", cname) == 1 && sizeof (cname) && cname[-1] == ')') cname = cname[..sizeof (cname) - 2];
55a8662000-11-20Per Hedbor  _module_identifier = sprintf ("%s,%s",
ad56072001-01-29Per Hedbor  name||this_object()->module_name, cname);
b9ec252000-01-05Martin Stjernholm  } return _module_identifier;
2e8d0f2001-06-28Martin Stjernholm #endif
b9ec252000-01-05Martin Stjernholm }
0aa37d2001-08-23Martin Stjernholm string module_local_id() //! Returns a string that uniquely identifies this module instance //! within the configuration. The returned string is the same as the //! part after the first '/' in the one returned from //! @[module_identifier]. { return _module_local_identifier; }
298be12001-08-13Per Hedbor RoxenModule this_module() { return this_object(); // To be used from subclasses. }
b6fb051999-11-02Per Hedbor string _sprintf() {
b7eaa22001-08-09Martin Stjernholm  return sprintf ("RoxenModule(%s)", _module_identifier || "?");
b6fb051999-11-02Per Hedbor }
c5e0961999-10-04Per Hedbor array register_module() { return ({
a730c22001-01-19Per Hedbor  this_object()->module_type,
ad56072001-01-29Per Hedbor  this_object()->module_name, this_object()->module_doc,
c5e0961999-10-04Per Hedbor  0, module_unique,
5b81122002-02-26Marcus Wellhardh  this_object()->module_locked,
c5e0961999-10-04Per Hedbor  }); }
2a2a5b1996-12-01Per Hedbor string fix_cvs(string from) {
fd0b6f1996-12-02Per Hedbor  from = replace(from, ({ "$", "Id: "," Exp $" }), ({"","",""}));
2a2a5b1996-12-01Per Hedbor  sscanf(from, "%*s,v %s", from);
00730e1999-11-18Per Hedbor  return replace(from,"/","-");
2a2a5b1996-12-01Per Hedbor }
72ac572000-01-31Per Hedbor int module_dependencies(Configuration configuration,
f5a2741999-10-18Per Hedbor  array (string) modules, int|void now)
facee72000-07-18Johan Sundström //! If your module depends on other modules present in the server, //! calling <pi>module_dependencies()</pi>, supplying an array of
cb9c222000-09-06Martin Stjernholm //! 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.
edb5061997-08-25Peter Bortas {
cb9c222000-09-06Martin Stjernholm  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),
4246ca2001-06-28Martin Stjernholm  module_identifier());
cb9c222000-09-06Martin Stjernholm  else conf->add_modules( modules, now );
edb5061997-08-25Peter Bortas  return 1; }
2a2a5b1996-12-01Per Hedbor string file_name_and_stuff() {
a59d252000-07-04Per Hedbor  return ("<b>Loaded from:</b> "+(roxen->filename(this_object()))+"<br>"+ (this_object()->cvs_version?
80cd682003-11-17Anders Johansson  "<b>CVS Version:</b> "+
a59d252000-07-04Per Hedbor  fix_cvs(this_object()->cvs_version)+"\n":""));
2a2a5b1996-12-01Per Hedbor }
5839c31999-01-22Marcus Comstedt 
9f2a971999-11-29Per Hedbor Configuration my_configuration()
facee72000-07-18Johan Sundström //! Returns the Configuration object of the virtual server the module //! belongs to.
b1fca01996-11-12Per Hedbor {
2e8d0f2001-06-28Martin Stjernholm  return _my_configuration;
b1fca01996-11-12Per Hedbor }
7fb7f51999-11-29Per Hedbor nomask void set_configuration(Configuration c)
5839c31999-01-22Marcus Comstedt { if(_my_configuration && _my_configuration != c) error("set_configuration() called twice.\n"); _my_configuration = c; }
48679b2000-02-03Johan Sundström void set_module_creator(string|array(string) c)
facee72000-07-18Johan Sundström //! 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.
b1fca01996-11-12Per Hedbor { module_creator = c; } void set_module_url(string to)
facee72000-07-18Johan Sundström //! 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.
b1fca01996-11-12Per Hedbor { module_url = to; } void free_some_sockets_please(){}
7fb7f51999-11-29Per Hedbor void start(void|int num, void|Configuration conf) {}
b1fca01996-11-12Per Hedbor 
a59d252000-07-04Per Hedbor string status() {}
c5e0961999-10-04Per Hedbor 
7fb7f51999-11-29Per Hedbor string info(Configuration conf)
72ac572000-01-31Per Hedbor {
facee72000-07-18Johan Sundström  return (this_object()->register_module()[2]);
df6cd11998-10-13Per Hedbor }
b1fca01996-11-12Per Hedbor 
a730c22001-01-19Per Hedbor string sname( ) {
4a50182001-01-30Per Hedbor  return my_configuration()->otomod[ this_object() ];
a730c22001-01-19Per Hedbor }
2f4ac12000-11-02Per Hedbor ModuleInfo my_moduleinfo( )
6533f22001-08-23Martin Nilsson //! Returns the associated @[ModuleInfo] object
2f4ac12000-11-02Per Hedbor {
a730c22001-01-19Per Hedbor  string f = sname();
2f4ac12000-11-02Per Hedbor  if( f ) return roxen.find_module( (f/"#")[0] ); }
2c13a81999-11-10Per Hedbor void save_me()
e7e6031999-11-05Per Hedbor { my_configuration()->save_one( this_object() );
2f4ac12000-11-02Per Hedbor  my_configuration()->module_changed( my_moduleinfo(), this_object() );
e7e6031999-11-05Per Hedbor }
1e9a1b2001-02-21Per Hedbor void save() { save_me(); } string comment() { return ""; }
b1fca01996-11-12Per Hedbor 
5839c31999-01-22Marcus Comstedt string query_internal_location()
facee72000-07-18Johan Sundström //! Returns the internal mountpoint, where <ref>find_internal()</ref> //! is mounted.
5839c31999-01-22Marcus Comstedt { if(!_my_configuration) error("Please do not call this function from create()!\n"); return _my_configuration->query_internal_location(this_object()); }
525f722000-12-05Martin Nilsson string query_absolute_internal_location(RequestID id) //! Returns the internal mountpoint as an absolute path. { return (id->misc->site_prefix_path || "") + query_internal_location(); }
b7c45e1997-01-27Per Hedbor string query_location()
1e9a1b2001-02-21Per Hedbor //! Returns the mountpoint as an absolute path. The default //! implementation uses the "location" configuration variable in the //! module.
b7c45e1997-01-27Per Hedbor { string s; catch{s = query("location");}; return s; }
162bd52000-02-20Martin Stjernholm array(string) location_urls()
facee72000-07-18Johan Sundström //! Returns an array of all locations where the module is mounted.
162bd52000-02-20Martin Stjernholm { string loc = query_location(); if (!loc) return ({}); if(!_my_configuration) error("Please do not call this function from create()!\n");
3adf202000-03-06Jonas Wallden  array(string) urls = copy_value(_my_configuration->query("URLs"));
7984d62000-10-06Martin Stjernholm  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++)
21182a2001-10-05Per Hedbor  { urls[i] = (urls[i]/"#")[0];
7984d62000-10-06Martin Stjernholm  if (sizeof (urls[i]/"*") == 2)
162bd52000-02-20Martin Stjernholm  urls[i] = replace(urls[i], "*", hostname);
21182a2001-10-05Per Hedbor  }
162bd52000-02-20Martin Stjernholm  return map (urls, `+, loc[1..]); }
ae32d01998-03-23David Hedbor /* By default, provide nothing. */
72ac572000-01-31Per Hedbor string query_provides() { return 0; }
b7c45e1997-01-27Per Hedbor 
bc0fa02001-03-08Per Hedbor function(RequestID:int|mapping) query_seclevels()
b1fca01996-11-12Per Hedbor {
a59d252000-07-04Per Hedbor  if(catch(query("_seclevels")) || (query("_seclevels") == 0))
bc0fa02001-03-08Per Hedbor  return 0; return roxen.compile_security_pattern(query("_seclevels"),this_object());
b1fca01996-11-12Per Hedbor }
8b8ecf2000-08-28Johan Sundström 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)
a476711997-10-20Henrik Grubbström (Grubba) {
ca28e82004-03-23Martin Stjernholm  SIMPLE_TRACE_ENTER(this, "find_dir_stat(): %O", f);
b275871998-05-23Henrik Grubbström (Grubba) 
a476711997-10-20Henrik Grubbström (Grubba)  array(string) files = find_dir(f, id);
8b8ecf2000-08-28Johan Sundström  mapping(string:Stat) res = ([]);
a476711997-10-20Henrik Grubbström (Grubba) 
0c8b9a1997-10-22Henrik Grubbström (Grubba)  foreach(files || ({}), string fname) {
ca28e82004-03-23Martin Stjernholm  SIMPLE_TRACE_ENTER(this, "stat()'ing %O", f + "/" + fname);
c0f4542001-02-19Jonas Wallden  Stat st = stat_file(replace(f + "/" + fname, "//", "/"), id);
a476711997-10-20Henrik Grubbström (Grubba)  if (st) {
0c8b9a1997-10-22Henrik Grubbström (Grubba)  res[fname] = st;
b275871998-05-23Henrik Grubbström (Grubba)  TRACE_LEAVE("OK"); } else { TRACE_LEAVE("No stat info");
a476711997-10-20Henrik Grubbström (Grubba)  } }
b275871998-05-23Henrik Grubbström (Grubba)  TRACE_LEAVE("");
a476711997-10-20Henrik Grubbström (Grubba)  return(res); }
a59d252000-07-04Per Hedbor 
d35dfd2004-04-20Martin Stjernholm class DefaultPropertySet { inherit PropertySet;
7c83872004-04-28Martin Stjernholm  static Stat stat; static void create (string path, RequestID id, Stat stat) { ::create (path, id); this_program::stat = stat; } Stat get_stat() {return stat;}
d35dfd2004-04-20Martin Stjernholm  static mapping(string:string) response_headers; mapping(string:string) get_response_headers() { if (!response_headers) { // Old kludge inherited from configuration.try_get_file. if (!id->misc->common) id->misc->common = ([]); RequestID sub_id = id->clone_me(); sub_id->misc->common = id->misc->common; sub_id->not_query = query_location() + path; sub_id->raw_url = replace (id->raw_url, id->not_query, sub_id->not_query); sub_id->method = "HEAD";
7ff7602004-04-28Martin Stjernholm  mapping(string:mixed)|int(-1..0)|object res = find_file (path, sub_id);
d35dfd2004-04-20Martin Stjernholm  if (res == -1) res = ([]); else if (objectp (res)) { string ext; if(stringp(sub_id->extension)) { sub_id->not_query += sub_id->extension; ext = lower_case(Roxen.extension(sub_id->not_query, sub_id)); } array(string) tmp=sub_id->conf->type_from_filename(sub_id->not_query, 1, ext); if(tmp) res = ([ "file":res, "type":tmp[0], "encoding":tmp[1] ]); else res = (["file": res]); } response_headers = sub_id->make_response_headers (res); destruct (sub_id); } return response_headers; } }
c5dd9f2004-03-16Henrik Grubbström (Grubba) //! Return the set of properties for @[path].
b64c122003-08-26Henrik Grubbström (Grubba) //!
c5dd9f2004-03-16Henrik Grubbström (Grubba) //! @returns //! Returns @tt{0@} (zero) if @[path] does not exist.
b64c122003-08-26Henrik Grubbström (Grubba) //!
aecff12004-03-23Martin Stjernholm //! Returns an error mapping if there's some other error accessing //! the properties. //!
c5dd9f2004-03-16Henrik Grubbström (Grubba) //! Otherwise returns a @[PropertySet] object.
aecff12004-03-23Martin Stjernholm PropertySet|mapping(string:mixed) query_properties(string path, RequestID id)
265ca42003-06-02Henrik Grubbström (Grubba) {
ca28e82004-03-23Martin Stjernholm  SIMPLE_TRACE_ENTER (this, "Querying properties on %O", path);
c5dd9f2004-03-16Henrik Grubbström (Grubba)  Stat st = stat_file(path, id);
ca28e82004-03-23Martin Stjernholm  if (!st) { SIMPLE_TRACE_LEAVE ("No such file or dir"); return 0; }
7c83872004-04-28Martin Stjernholm  PropertySet res = DefaultPropertySet(path, id, st);
ca28e82004-03-23Martin Stjernholm  SIMPLE_TRACE_LEAVE (""); return res;
265ca42003-06-02Henrik Grubbström (Grubba) } //! Returns the value of the specified property, or an error code //! mapping. //! //! @note //! Returning a string is shorthand for returning an array //! with a single text node. string|array(Parser.XML.Tree.Node)|mapping(string:mixed)
c5dd9f2004-03-16Henrik Grubbström (Grubba)  query_property(string path, string prop_name, RequestID id)
265ca42003-06-02Henrik Grubbström (Grubba) {
aecff12004-03-23Martin Stjernholm  mapping(string:mixed)|PropertySet properties = query_properties(path, id);
c5dd9f2004-03-16Henrik Grubbström (Grubba)  if (!properties) { return Roxen.http_status(Protocols.HTTP.HTTP_NOT_FOUND, "No such file or directory.");
265ca42003-06-02Henrik Grubbström (Grubba)  }
aecff12004-03-23Martin Stjernholm  if (mappingp (properties)) return properties;
c5dd9f2004-03-16Henrik Grubbström (Grubba)  return properties->query_property(prop_name) || Roxen.http_status(Protocols.HTTP.HTTP_NOT_FOUND, "No such property.");
265ca42003-06-02Henrik Grubbström (Grubba) }
762b932004-03-03Martin Stjernholm //! RFC 2518 PROPFIND implementation with recursion according to //! @[depth]. See @[find_properties] for details.
a98f752004-03-03Henrik Grubbström (Grubba) void recurse_find_properties(string path, string mode, int depth, MultiStatus result, RequestID id,
ca28e82004-03-23Martin Stjernholm  multiset(string)|void filt)
265ca42003-06-02Henrik Grubbström (Grubba) {
ca28e82004-03-23Martin Stjernholm  SIMPLE_TRACE_ENTER (this, "%s for %O, depth %d", mode == "DAV:propname" ? "Listing property names" : mode == "DAV:allprop" ? "Retrieving all properties" : mode == "DAV:prop" ? "Retrieving specific properties" : "Finding properties with mode " + mode, path, depth);
aecff12004-03-23Martin Stjernholm  mapping(string:mixed)|PropertySet properties = query_properties(path, id);
c5dd9f2004-03-16Henrik Grubbström (Grubba) 
ca28e82004-03-23Martin Stjernholm  if (!properties) { SIMPLE_TRACE_LEAVE ("No such file or dir"); return; }
c5dd9f2004-03-16Henrik Grubbström (Grubba) 
ca28e82004-03-23Martin Stjernholm  { mapping(string:mixed) ret = mappingp (properties) ? properties : properties->find_properties(mode, result, filt); if (ret) { result->add_response(path, XMLStatusNode(ret->error, ret->rettext)); if (ret->rettext) { Parser.XML.Tree.ElementNode descr = Parser.XML.Tree.ElementNode ("DAV:responsedescription", ([])); descr->add_child (Parser.XML.Tree.TextNode (ret->rettext)); result->add_response (path, descr); } SIMPLE_TRACE_LEAVE ("Got status %d: %O", ret->error, ret->rettext); return;
762b932004-03-03Martin Stjernholm  }
a98f752004-03-03Henrik Grubbström (Grubba)  }
ca28e82004-03-23Martin Stjernholm 
7c83872004-04-28Martin Stjernholm  if (properties->get_stat()->isdir) {
ca28e82004-03-23Martin Stjernholm  if (depth <= 0) { SIMPLE_TRACE_LEAVE ("Not recursing due to depth limit"); return; } depth--; foreach(find_dir(path, id) || ({}), string filename) { recurse_find_properties(combine_path(path, filename), mode, depth, result, id, filt); }
265ca42003-06-02Henrik Grubbström (Grubba)  }
ca28e82004-03-23Martin Stjernholm  SIMPLE_TRACE_LEAVE ("");
a98f752004-03-03Henrik Grubbström (Grubba)  return;
265ca42003-06-02Henrik Grubbström (Grubba) }
a98f752004-03-03Henrik Grubbström (Grubba) mapping(string:mixed) patch_properties(string path, array(PatchPropertyCommand) instructions, MultiStatus result, RequestID id)
265ca42003-06-02Henrik Grubbström (Grubba) {
ca28e82004-03-23Martin Stjernholm  SIMPLE_TRACE_ENTER (this, "Patching properties for %O", path);
aecff12004-03-23Martin Stjernholm  mapping(string:mixed)|PropertySet properties = query_properties(path, id);
265ca42003-06-02Henrik Grubbström (Grubba) 
ca28e82004-03-23Martin Stjernholm  if (!properties) { SIMPLE_TRACE_LEAVE ("No such file or dir"); return 0; } if (mappingp (properties)) { SIMPLE_TRACE_LEAVE ("Got error %d from query_properties: %O", properties->error, properties->rettext); return properties; }
a98f752004-03-03Henrik Grubbström (Grubba) 
c5dd9f2004-03-16Henrik Grubbström (Grubba)  mapping(string:mixed) errcode = properties->start();
0cb4c42004-03-15Martin Stjernholm 
ca28e82004-03-23Martin Stjernholm  if (errcode) { SIMPLE_TRACE_LEAVE ("Got error %d from PropertySet.start: %O", errcode->error, errcode->rettext); return errcode; }
0cb4c42004-03-15Martin Stjernholm 
c5dd9f2004-03-16Henrik Grubbström (Grubba)  array(mapping(string:mixed)) results; mixed err = catch {
df04242004-03-16Henrik Grubbström (Grubba)  results = instructions->execute(properties);
c5dd9f2004-03-16Henrik Grubbström (Grubba)  }; if (err) { properties->unroll(); throw (err); } else { int any_failed; foreach(results, mapping(string:mixed) answer) { if (any_failed = (answer && (answer->error >= 300))) { break;
265ca42003-06-02Henrik Grubbström (Grubba)  }
0cb4c42004-03-15Martin Stjernholm  }
c5dd9f2004-03-16Henrik Grubbström (Grubba)  if (any_failed) { // Unroll and fail any succeeded items. int i; mapping(string:mixed) answer = Roxen.http_status (Protocols.HTTP.DAV_FAILED_DEP, "Failed dependency."); for(i = 0; i < sizeof(results); i++) { if (!results[i] || results[i]->error < 300) { result->add_property(path, instructions[i]->property_name, answer); } else { result->add_property(path, instructions[i]->property_name, results[i]); } } properties->unroll(); } else {
265ca42003-06-02Henrik Grubbström (Grubba)  int i; for(i = 0; i < sizeof(results); i++) { result->add_property(path, instructions[i]->property_name, results[i]); }
c5dd9f2004-03-16Henrik Grubbström (Grubba)  properties->commit();
265ca42003-06-02Henrik Grubbström (Grubba)  } }
0cb4c42004-03-15Martin Stjernholm 
ca28e82004-03-23Martin Stjernholm  SIMPLE_TRACE_LEAVE ("");
a98f752004-03-03Henrik Grubbström (Grubba)  return 0;
265ca42003-06-02Henrik Grubbström (Grubba) }
c5dd9f2004-03-16Henrik Grubbström (Grubba) //! Convenience variant of @[patch_properties()] that sets a single
aecff12004-03-23Martin Stjernholm //! property.
0cb4c42004-03-15Martin Stjernholm //! //! @returns //! Returns a mapping on any error, zero otherwise.
aecff12004-03-23Martin Stjernholm mapping(string:mixed) set_property (string path, string prop_name, string|array(Parser.XML.Tree.Node) value, RequestID id)
25ceaf2004-03-01Martin Stjernholm {
aecff12004-03-23Martin Stjernholm  mapping(string:mixed)|PropertySet properties = query_properties(path, id);
c5dd9f2004-03-16Henrik Grubbström (Grubba)  if (!properties) return Roxen.http_status(Protocols.HTTP.HTTP_NOT_FOUND, "File not found.");
aecff12004-03-23Martin Stjernholm  if (mappingp (properties)) return properties;
0cb4c42004-03-15Martin Stjernholm 
c5dd9f2004-03-16Henrik Grubbström (Grubba)  mapping(string:mixed) result = properties->start(); if (result) return result; result = properties->set_property(prop_name, value);
aecff12004-03-23Martin Stjernholm  if (result && result->error >= 300) {
c5dd9f2004-03-16Henrik Grubbström (Grubba)  properties->unroll();
aecff12004-03-23Martin Stjernholm  return result; } properties->commit(); return 0;
25ceaf2004-03-01Martin Stjernholm }
c5dd9f2004-03-16Henrik Grubbström (Grubba) //! Convenience variant of @[patch_properties()] that removes a single
0cb4c42004-03-15Martin Stjernholm //! property. //! //! @returns //! Returns a mapping on any error, zero otherwise.
aecff12004-03-23Martin Stjernholm mapping(string:mixed) remove_property (string path, string prop_name, RequestID id)
25ceaf2004-03-01Martin Stjernholm {
aecff12004-03-23Martin Stjernholm  mapping(string:mixed)|PropertySet properties = query_properties(path, id);
c5dd9f2004-03-16Henrik Grubbström (Grubba)  if (!properties) return Roxen.http_status(Protocols.HTTP.HTTP_NOT_FOUND, "File not found.");
aecff12004-03-23Martin Stjernholm  if (mappingp (properties)) return properties;
c5dd9f2004-03-16Henrik Grubbström (Grubba)  mapping(string:mixed) result = properties->start(); if (result) return result;
0cb4c42004-03-15Martin Stjernholm 
c5dd9f2004-03-16Henrik Grubbström (Grubba)  result = properties->remove_property(prop_name);
aecff12004-03-23Martin Stjernholm  if (result && result->error >= 300) {
c5dd9f2004-03-16Henrik Grubbström (Grubba)  properties->unroll();
aecff12004-03-23Martin Stjernholm  return result; } properties->commit(); return 0;
25ceaf2004-03-01Martin Stjernholm }
4908322004-04-29Martin Stjernholm //! Mapping from canonical path to a mapping from username to the lock //! that apply to the path.
12cfc52004-04-28Henrik Grubbström (Grubba) //! //! The @expr{0@} username is the anonymous user.
4908322004-04-29Martin Stjernholm //! //! Only used internally by the default lock implementation.
12cfc52004-04-28Henrik Grubbström (Grubba) static mapping(string:mapping(string:DAVLock)) file_locks = ([]);
4908322004-04-29Martin Stjernholm //! Mapping from canonical path prefix to a mapping from username to //! the lock that apply recursively to all files under that prefix.
12cfc52004-04-28Henrik Grubbström (Grubba) //! //! The @expr{0@} username is the anonymous user.
4908322004-04-29Martin Stjernholm //! //! Only used internally by the default lock implementation.
12cfc52004-04-28Henrik Grubbström (Grubba) static mapping(string:mapping(string:DAVLock)) prefix_locks = ([]);
47fa212004-05-03Martin Stjernholm //! Find some or all locks that apply to @[path].
12cfc52004-04-28Henrik Grubbström (Grubba) //! //! @param path
4908322004-04-29Martin Stjernholm //! Canonical path relative to the filesystem root. Always ends with //! a @expr{"/"@}.
12cfc52004-04-28Henrik Grubbström (Grubba) //! //! @param recursive
9a91eb2004-05-04Martin Stjernholm //! If @expr{1@} also return locks under @[path].
12cfc52004-04-28Henrik Grubbström (Grubba) //!
47fa212004-05-03Martin Stjernholm //! @param exclude_shared //! If @expr{1@} do not return shared locks that are held by users //! other than the one the request is authenticated as. (This is //! appropriate to get the list of locks that would conflict if the //! current user were to make a shared lock.) //!
12cfc52004-04-28Henrik Grubbström (Grubba) //! @returns //! Returns a multiset containing all applicable locks in //! this location module, or @expr{0@} (zero) if there are none.
4908322004-04-29Martin Stjernholm //! //! @note //! @[DAVLock] objects may be created if the filesystem has some
47fa212004-05-03Martin Stjernholm //! persistent storage of them. The default implementation does not //! store locks persistently.
4908322004-04-29Martin Stjernholm //! //! @note //! The default implementation only handles the @expr{"DAV:write"@} //! lock type.
47fa212004-05-03Martin Stjernholm multiset(DAVLock) find_locks(string path, int(0..1) recursive, int(0..1) exclude_shared, RequestID id)
12cfc52004-04-28Henrik Grubbström (Grubba) { // Common case. if (!sizeof(file_locks) && !sizeof(prefix_locks)) return 0; multiset(DAVLock) locks = (<>);
47fa212004-05-03Martin Stjernholm  function(mapping(string:DAVLock):void) add_locks; if (exclude_shared) { User uid = id->conf->authenticate (id); string auth_user = uid && uid->name(); add_locks = lambda (mapping(string:DAVLock) sub_locks) { foreach (sub_locks; string user; DAVLock lock) if (user == auth_user || lock->lockscope == "DAV:exclusive") locks[lock] = 1; }; } else add_locks = lambda (mapping(string:DAVLock) sub_locks) { locks |= mkmultiset (values (sub_locks)); };
12cfc52004-04-28Henrik Grubbström (Grubba)  if (file_locks[path]) {
47fa212004-05-03Martin Stjernholm  add_locks (file_locks[path]);
12cfc52004-04-28Henrik Grubbström (Grubba)  }
47fa212004-05-03Martin Stjernholm 
12cfc52004-04-28Henrik Grubbström (Grubba)  foreach(prefix_locks; string prefix; mapping(string:DAVLock) sub_locks) { if (has_prefix(path, prefix)) {
47fa212004-05-03Martin Stjernholm  add_locks (sub_locks);
12cfc52004-04-28Henrik Grubbström (Grubba)  break; } }
47fa212004-05-03Martin Stjernholm 
12cfc52004-04-28Henrik Grubbström (Grubba)  if (recursive) { foreach(file_locks|prefix_locks; string prefix; mapping(string:DAVLock) sub_locks) { if (has_prefix(prefix, path)) {
47fa212004-05-03Martin Stjernholm  add_locks (sub_locks);
12cfc52004-04-28Henrik Grubbström (Grubba)  } } }
47fa212004-05-03Martin Stjernholm 
12cfc52004-04-28Henrik Grubbström (Grubba)  return sizeof(locks) && locks; }
4908322004-04-29Martin Stjernholm //! Check if there are one or more locks that apply to @[path] for the //! user the request is authenticated as.
12cfc52004-04-28Henrik Grubbström (Grubba) //! //! @param path
4908322004-04-29Martin Stjernholm //! Canonical path relative to the filesystem root. Always ends with //! a @expr{"/"@}.
12cfc52004-04-28Henrik Grubbström (Grubba) //! //! @param recursive
4908322004-04-29Martin Stjernholm //! If @expr{1@} also check recursively under @[path] for locks.
12cfc52004-04-28Henrik Grubbström (Grubba) //! //! @returns //! @mixed //! @type DAVLock
4908322004-04-29Martin Stjernholm //! Returns the lock owned by the authenticated user that apply //! to @[path]. (It doesn't matter if the @expr{recursive@} flag //! in the lock doesn't match the @[recursive] argument.)
9a91eb2004-05-04Martin Stjernholm //! @type int(0..3)
12cfc52004-04-28Henrik Grubbström (Grubba) //! @int
9a91eb2004-05-04Martin Stjernholm //! @value 0 //! Returns @expr{0@} if no locks apply. //! @value 1 //! Returns @expr{1@} if there only are one or more shared
4908322004-04-29Martin Stjernholm //! locks held by other users.
9a91eb2004-05-04Martin Stjernholm //! @value 2 //! Returns @expr{2@} if @[recursive] is set, the
4908322004-04-29Martin Stjernholm //! authenticated user has locks under @[path] (but not on //! @[path] itself), and there are no exclusive locks held //! by other users.
9a91eb2004-05-04Martin Stjernholm //! @value 3 //! Returns @expr{3@} if there are one or more exclusive //! locks held by other users.
12cfc52004-04-28Henrik Grubbström (Grubba) //! @endint //! @endmixed
4908322004-04-29Martin Stjernholm //! //! @note //! @[DAVLock] objects may be created if the filesystem has some
47fa212004-05-03Martin Stjernholm //! persistent storage of them. The default implementation does not //! store locks persistently.
4908322004-04-29Martin Stjernholm //! //! @note //! The default implementation only handles the @expr{"DAV:write"@} //! lock type.
9a91eb2004-05-04Martin Stjernholm DAVLock|int(0..3) check_locks(string path, int(0..1) recursive, RequestID id)
12cfc52004-04-28Henrik Grubbström (Grubba) { // Common case. if (!sizeof(file_locks) && !sizeof(prefix_locks)) return 0;
4908322004-04-29Martin Stjernholm  User uid = id->conf->authenticate (id); string auth_user = uid && uid->name(); if (DAVLock lock = file_locks[path] && file_locks[path][auth_user] || prefix_locks[path] && prefix_locks[path][auth_user]) return lock;
12cfc52004-04-28Henrik Grubbström (Grubba)  int(0..1) shared;
4908322004-04-29Martin Stjernholm  if (mapping(string:DAVLock) locks = file_locks[path]) { foreach(locks;; DAVLock lock) {
9a91eb2004-05-04Martin Stjernholm  if (lock->lockscope == "DAV:exclusive") return 3;
12cfc52004-04-28Henrik Grubbström (Grubba)  shared = 1; break; } }
4908322004-04-29Martin Stjernholm  foreach(prefix_locks; string prefix; mapping(string:DAVLock) locks) {
12cfc52004-04-28Henrik Grubbström (Grubba)  if (has_prefix(path, prefix)) {
4908322004-04-29Martin Stjernholm  if (DAVLock lock = locks[auth_user]) return lock; if (!shared) // If we've found a shared lock then we won't find an // exclusive one higher up. foreach(locks;; DAVLock lock) {
9a91eb2004-05-04Martin Stjernholm  if (lock->lockscope == "DAV:exclusive") return 3;
4908322004-04-29Martin Stjernholm  shared = 1; break; }
12cfc52004-04-28Henrik Grubbström (Grubba)  } }
4908322004-04-29Martin Stjernholm  if (!recursive) return shared;
12cfc52004-04-28Henrik Grubbström (Grubba) 
4908322004-04-29Martin Stjernholm  int(0..1) locked_by_auth_user;
12cfc52004-04-28Henrik Grubbström (Grubba)  // We want to know if there are any locks with @[path] as prefix // that apply to us.
4908322004-04-29Martin Stjernholm  foreach(file_locks|prefix_locks; string prefix; mapping(string:DAVLock) locks) {
12cfc52004-04-28Henrik Grubbström (Grubba)  if (has_prefix(prefix, path)) {
4908322004-04-29Martin Stjernholm  if (locks[auth_user]) locked_by_auth_user = 1; else foreach(locks;; DAVLock lock) {
9a91eb2004-05-04Martin Stjernholm  if (lock->lockscope == "DAV:exclusive") return 3;
4908322004-04-29Martin Stjernholm  shared = 1; break; }
12cfc52004-04-28Henrik Grubbström (Grubba)  } }
4908322004-04-29Martin Stjernholm 
9a91eb2004-05-04Martin Stjernholm  return locked_by_auth_user ? 2 : shared;
12cfc52004-04-28Henrik Grubbström (Grubba) }
0850612004-05-03Martin Stjernholm //! Lock the resource at @[path] with the given @[lock]. It's already //! checked that no other lock that applies, i.e. a call //! @code{check_locks(path,lock->recursive,id)@} would return
4908322004-04-29Martin Stjernholm //! @expr{0@} or @expr{1@}.
12cfc52004-04-28Henrik Grubbström (Grubba) //!
0850612004-05-03Martin Stjernholm //! The implementation must at least support the @expr{"DAV:write"@} //! lock type (RFC 2518, section 7). Briefly: An exclusive lock on a //! file prohibits other users from changing its content. An exclusive //! lock on a file or directory prohibits other users from setting or //! deleting any of its properties. An exclusive lock on a directory //! prohibits other users from adding or removing files or directories //! in it. A shared lock prohibits other users from obtaining an //! exclusive lock. A resource that doesn't exist can be locked, //! provided the directory it would be in exists.
12cfc52004-04-28Henrik Grubbström (Grubba) //! //! @param path
4908322004-04-29Martin Stjernholm //! Canonical path that the lock applies to. It's relative to the //! filesystem root and always ends with a @expr{"/"@}.
12cfc52004-04-28Henrik Grubbström (Grubba) //! //! @param lock //! The lock to register. //!
0850612004-05-03Martin Stjernholm //! @returns //! Returns @expr{0@} if the lock is successfully installed or a //! status mapping if an error occurred. //!
4908322004-04-29Martin Stjernholm //! @note
0850612004-05-03Martin Stjernholm //! The default implementation supports only @expr{"DAV:write"@}. It //! works under the assumption that every path maps to exactly one //! file or directory (when it exists), and that the authenticated //! user is uniquely identified by //! @code{id->conf->authenticate(id)->name()@}. mapping(string:mixed) lock_file(string path, DAVLock lock, RequestID id)
12cfc52004-04-28Henrik Grubbström (Grubba) {
4908322004-04-29Martin Stjernholm  ASSERT_IF_DEBUG (lock->locktype == "DAV:write"); User uid = id->conf->authenticate (id); string user = uid && uid->name();
12cfc52004-04-28Henrik Grubbström (Grubba)  if (lock->recursive) { if (prefix_locks[path]) { prefix_locks[path][user] = lock; } else { prefix_locks[path] = ([ user:lock ]); } } else { if (file_locks[path]) { file_locks[path][user] = lock; } else { file_locks[path] = ([ user:lock ]); } } return 0; }
4908322004-04-29Martin Stjernholm  //! Remove @[lock] that currently is locking the resource at @[path]. //! //! @param path //! Canonical path that the lock applies to. It's relative to the //! filesystem root and always ends with a @expr{"/"@}. //! //! @param lock //! The lock to unregister. (It must not be changed or destructed.) //! //! @returns //! Returns a status mapping on any error, zero otherwise. mapping(string:mixed) unlock_file (string path, DAVLock lock, RequestID id) { User uid = id->conf->authenticate (id); string user = uid && uid->name(); DAVLock removed_lock; if (lock->recursive) { removed_lock = m_delete (prefix_locks[path], user); if (!sizeof (prefix_locks[path])) m_delete (prefix_locks, path); } else { removed_lock = m_delete (file_locks[path], user); if (!sizeof (file_locks[path])) m_delete (file_locks, path); } ASSERT_IF_DEBUG (lock /*%O*/ == removed_lock /*%O*/, lock, removed_lock); return 0; }
12cfc52004-04-28Henrik Grubbström (Grubba) 
d396ad2004-03-03Henrik Grubbström (Grubba) mapping(string:mixed)|int(-1..0)|Stdio.File find_file(string path, RequestID id); //! Delete the file specified by @[path]. //! //! @note //! Should return a 204 status on success. //! //! @note //! The default implementation falls back to @[find_file()]. mapping(string:mixed) delete_file(string path, RequestID id) { // Fall back to find_file(). RequestID tmp_id = id->close_me();
d35dfd2004-04-20Martin Stjernholm  tmp_id->not_query = query_location() + path;
d396ad2004-03-03Henrik Grubbström (Grubba)  tmp_id->method = "DELELE"; // FIXME: Logging?
7810372004-03-04Henrik Grubbström (Grubba)  return find_file(path, id) || Roxen.http_status(404);
d396ad2004-03-03Henrik Grubbström (Grubba) } int(0..1) recurse_delete_files(string path, MultiStatus stat, RequestID id) { Stat st = stat_file(path, id);
7810372004-03-04Henrik Grubbström (Grubba)  if (!st) return 0;
d396ad2004-03-03Henrik Grubbström (Grubba)  if (st->isdir) { // RFC 2518 8.6.2 // The DELETE operation on a collection MUST act as if a // "Depth: infinity" header was used on it. int(0..1) fail; foreach(find_dir(path, id) || ({}), string fname) { fail |= recurse_delete_files(path+"/"+fname, stat, id); } // RFC 2518 8.6.2 // 424 (Failed Dependancy) errors SHOULD NOT be in the // 207 (Multi-Status). if (fail) return fail; } mapping ret = delete_file(path, id); if (ret->code != 204) { // RFC 2518 8.6.2 // Additionally 204 (No Content) errors SHOULD NOT be returned // in the 207 (Multi-Status). The reason for this prohibition // is that 204 (No COntent) is the default success code. stat->add_response(path, XMLStatusNode(ret->code)); } return ret->code >= 300; }
6413232004-03-01Henrik Grubbström (Grubba) mapping copy_file(string path, string dest, int(-1..1) behavior, RequestID id)
265ca42003-06-02Henrik Grubbström (Grubba) {
6413232004-03-01Henrik Grubbström (Grubba)  werror("copy_file(%O, %O, %O, %O)\n", path, dest, behavior, id);
762b932004-03-03Martin Stjernholm  return Roxen.http_status (Protocols.HTTP.HTTP_NOT_IMPL);
6413232004-03-01Henrik Grubbström (Grubba) }
265ca42003-06-02Henrik Grubbström (Grubba) 
6413232004-03-01Henrik Grubbström (Grubba) void recurse_copy_files(string path, int depth, string dest_prefix, string dest_suffix, mapping(string:int(-1..1)) behavior, MultiStatus result, RequestID id) { Stat st = stat_file(path, id); if (!st) return; if (!dest_prefix) { Standards.URI dest_uri = Standards.URI(result->href_prefix); Configuration c = roxen->find_configuration_for_url(dest_uri, id->conf); // FIXME: Mounting server on subpath. if (!c || !has_prefix(dest_uri->path||"/", query_location())) { // Destination is not local to this module. // FIXME: Not supported yet. result->add_response(dest_suffix, XMLStatusNode(502)); return; } dest_prefix = (dest_uri->path||"/")[sizeof(query_location())..]; Stat dest_st; if (!(dest_st = stat_file(combine_path(dest_prefix, ".."), id)) || !(dest_st->isdir)) { result->add_response("", XMLStatusNode(409)); return; } if (combine_path(dest_prefix, dest_suffix, ".") == combine_path(path, ".")) { result->add_response(dest_suffix, XMLStatusNode(403, "Source and destination are the same.")); return; } } werror("recurse_copy_files(%O, %O, %O, %O, %O, %O, %O)\n", path, depth, dest_prefix, dest_suffix, behavior, result, id); mapping res = copy_file(path, dest_prefix + dest_suffix, behavior[dest_prefix + dest_suffix]||behavior[0], id); result->add_response(dest_suffix, XMLStatusNode(res->error, res->data)); if (res->error >= 300) { // RFC 2518 8.8.3 and 8.8.8 (error minimization). return; } if ((depth <= 0) || !st->isdir) return;
265ca42003-06-02Henrik Grubbström (Grubba)  depth--; foreach(find_dir(path, id), string filename) {
6413232004-03-01Henrik Grubbström (Grubba)  recurse_copy_files(combine_path(path, filename), depth, dest_prefix, combine_path(dest_suffix, filename), behavior, result, id);
265ca42003-06-02Henrik Grubbström (Grubba)  } }
8b8ecf2000-08-28Johan Sundström string real_file(string f, RequestID id){}
b1fca01996-11-12Per Hedbor 
4f4bc11998-02-04Per Hedbor void add_api_function( string name, function f, void|array(string) types) { _api_functions[name] = ({ f, types }); } mapping api_functions() { return _api_functions; }
60b81c2001-01-04Martin Nilsson #if ROXEN_COMPAT <= 1.4
9ed3ea2000-08-06Martin Stjernholm mapping(string:function) query_tag_callers()
facee72000-07-18Johan Sundström //! Compat
48ca161999-05-18Per Hedbor {
9ed3ea2000-08-06Martin Stjernholm  mapping(string:function) m = ([]);
48ca161999-05-18Per Hedbor  foreach(glob("tag_*", indices( this_object())), string q) if(functionp( this_object()[q] )) m[replace(q[4..], "_", "-")] = this_object()[q]; return m; }
9ed3ea2000-08-06Martin Stjernholm mapping(string:function) query_container_callers() //! Compat
48ca161999-05-18Per Hedbor {
9ed3ea2000-08-06Martin Stjernholm  mapping(string:function) m = ([]);
48ca161999-05-18Per Hedbor  foreach(glob("container_*", indices( this_object())), string q) if(functionp( this_object()[q] )) m[replace(q[10..], "_", "-")] = this_object()[q]; return m; }
60b81c2001-01-04Martin Nilsson #endif
48ca161999-05-18Per Hedbor 
9ed3ea2000-08-06Martin Stjernholm mapping(string:array(int|function)) query_simpletag_callers()
7d2a5d2000-01-31Martin Nilsson {
9ed3ea2000-08-06Martin Stjernholm  mapping(string:array(int|function)) m = ([]);
7d2a5d2000-01-31Martin Nilsson  foreach(glob("simpletag_*", indices(this_object())), string q) if(functionp(this_object()[q]))
d6b20a2000-02-08Martin Stjernholm  m[replace(q[10..],"_","-")] = ({ intp (this_object()[q + "_flags"]) && this_object()[q + "_flags"], this_object()[q] });
7d2a5d2000-01-31Martin Nilsson  return m;
48ca161999-05-18Per Hedbor }
ea062e1999-11-21Martin Nilsson 
9ed3ea2000-08-06Martin Stjernholm 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; }
1b2b752000-01-07Martin Stjernholm RXML.TagSet query_tag_set()
b9ec252000-01-05Martin Stjernholm {
395e462000-01-18Martin Stjernholm  if (!module_tag_set) { array(function|program|object) tags = filter (rows (this_object(), glob ("Tag*", indices (this_object()))),
d6b0f82003-01-15Henrik Grubbström (Grubba)  lambda(mixed x) { return functionp(x)||programp(x); });
395e462000-01-18Martin Stjernholm  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 =
dd9a412001-08-24Martin Stjernholm  (this_object()->ModuleTagSet || RXML.TagSet) (this_object(), "", tags);
395e462000-01-18Martin Stjernholm  } return module_tag_set;
b9ec252000-01-05Martin Stjernholm }
12e79e1999-12-07Martin Nilsson mixed get_value_from_file(string path, string index, void|string pre)
ea062e1999-11-21Martin Nilsson {
7fb7f51999-11-29Per Hedbor  Stdio.File file=Stdio.File();
ea062e1999-11-21Martin Nilsson  if(!file->open(path,"r")) return 0;
e4baad2003-08-07Jonas Wallden  if(has_suffix(index, "()")) index = index[..sizeof(index) - 3]; // Pass path to original file so that include statements for local files // work correctly. return compile_string((pre || "") + file->read(), path)[index];
ea062e1999-11-21Martin Nilsson }
a730c22001-01-19Per Hedbor 
2be1982001-08-01Per Hedbor static private mapping __my_tables = ([]);
2466122001-08-01Per Hedbor array(mapping(string:mixed)) sql_query( string query, mixed ... args )
2be1982001-08-01Per Hedbor //! 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 ); }
2466122001-08-01Per Hedbor object sql_big_query( string query, mixed ... args )
2be1982001-08-01Per Hedbor //! 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 ); }
2466122001-08-01Per Hedbor array(mapping(string:mixed)) sql_query_ro( string query, mixed ... args ) //! Do a read-only 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(1)->query( replace( query, __my_tables ), @args ); } object sql_big_query_ro( string query, mixed ... args ) //! Identical to @[sql_query_ro], but the @[Sql.sql()->big_query] method //! will be used instead of the @[Sql.sql()->query] method. { return get_my_sql(1)->big_query( replace( query, __my_tables ), @args ); }
6d22f92003-04-23Martin Stjernholm static int create_sql_tables( mapping(string:array(string)) definitions,
3a7e562001-08-23Per Hedbor  string|void comment, int|void no_unique_names )
2be1982001-08-01Per Hedbor //! Create multiple tables in one go. See @[get_my_table]
3a7e562001-08-23Per Hedbor //! Returns the number of tables that were actually created.
2be1982001-08-01Per Hedbor {
3a7e562001-08-23Per Hedbor  int ddc;
59ccd82001-08-14Per Hedbor  if( !no_unique_names )
6d22f92003-04-23Martin Stjernholm  foreach( indices( definitions ), string t ) ddc+=get_my_table( t, definitions[t], comment, 1 );
59ccd82001-08-14Per Hedbor  else { Sql.Sql sql = get_my_sql();
6d22f92003-04-23Martin Stjernholm  foreach( indices( definitions ), string t )
59ccd82001-08-14Per Hedbor  {
3a7e562001-08-23Per Hedbor  if( !catch {
6d22f92003-04-23Martin Stjernholm  sql->query("CREATE TABLE "+t+" ("+definitions[t]*","+")" );
3a7e562001-08-23Per Hedbor  } ) ddc++;
59ccd82001-08-14Per Hedbor  DBManager.is_module_table( this_object(), my_db, t, comment ); } }
3a7e562001-08-23Per Hedbor  return ddc;
2be1982001-08-01Per Hedbor }
2466122001-08-01Per Hedbor static string sql_table_exists( string name )
298be12001-08-13Per Hedbor //! Return the real name of the table 'name' if it exists.
2466122001-08-01Per Hedbor { if(strlen(name)) name = "_"+name; string res = hash(_my_configuration->name)->digits(36) + "_" + replace(sname(),"#","_") + name;
8214e62001-08-01Per Hedbor  return catch(get_my_sql()->query( "SELECT * FROM "+res+" LIMIT 1" ))?0:res;
2466122001-08-01Per Hedbor }
3a7e562001-08-23Per Hedbor static string|int get_my_table( string|array(string) name,
c76ebd2004-03-23Martin Stjernholm  void|array(string)|string definition,
3a7e562001-08-23Per Hedbor  string|void comment, int|void flag )
1e9a1b2001-02-21Per Hedbor //! @decl string get_my_table( string name, array(string) types )
c76ebd2004-03-23Martin Stjernholm //! @decl string get_my_table( string name, string definition ) //! @decl string get_my_table( string definition ) //! @decl string get_my_table( array(string) definition )
1e9a1b2001-02-21Per Hedbor //! //! 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.
2be1982001-08-01Per Hedbor //! //! You can use @[create_sql_tables] instead of this function if you want //! to create more than one table in one go.
1e9a1b2001-02-21Per Hedbor //!
3a7e562001-08-23Per Hedbor //! If @[flag] is true, return 1 if a table was created, and 0 otherwise. //!
1e9a1b2001-02-21Per Hedbor //! In the first form, @[name] is the (postfix of) the name of the
6d22f92003-04-23Martin Stjernholm //! table, and @[types] is an array of definitions, as an example:
1e9a1b2001-02-21Per Hedbor //!
3a7e562001-08-23Per Hedbor //!
6533f22001-08-23Martin Nilsson //! @code{
1e9a1b2001-02-21Per Hedbor //! cache_table = get_my_table( "cache", ({ //! "id INT UNSIGNED AUTO_INCREMENT", //! "data BLOB", //! }) );
6533f22001-08-23Martin Nilsson //! @} //!
c76ebd2004-03-23Martin Stjernholm //! In the second form, the whole table definition is instead sent as
1e9a1b2001-02-21Per Hedbor //! 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 "" //!
a0487b2001-07-31Per Hedbor //! If the table does not exist in the datbase, it is created.
1e9a1b2001-02-21Per Hedbor //!
6533f22001-08-23Martin Nilsson //! @note //! This function may not be called from create //
c76ebd2004-03-23Martin Stjernholm // If it exists, but it's definition is different, the table will be // altered with a ALTER TABLE call to conform to the definition. This
a0487b2001-07-31Per Hedbor // 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).
1e9a1b2001-02-21Per Hedbor {
2be1982001-08-01Per Hedbor  string oname;
3a7e562001-08-23Per Hedbor  int ddc;
c76ebd2004-03-23Martin Stjernholm  if( !definition )
1e9a1b2001-02-21Per Hedbor  {
c76ebd2004-03-23Martin Stjernholm  definition = name;
2be1982001-08-01Per Hedbor  oname = name = "";
1e9a1b2001-02-21Per Hedbor  } else if(strlen(name))
2be1982001-08-01Per Hedbor  name = "_"+(oname = name);
a730c22001-01-19Per Hedbor 
a665382001-01-29Per Hedbor  Sql.Sql sql = get_my_sql();
2466122001-08-01Per Hedbor 
1e9a1b2001-02-21Per Hedbor  string res = hash(_my_configuration->name)->digits(36) + "_" + replace(sname(),"#","_") + name;
a665382001-01-29Per Hedbor  if( !sql ) { report_error("Failed to get SQL handle, permission denied for "+my_db+"\n"); return 0; }
c76ebd2004-03-23Martin Stjernholm  if( arrayp( definition ) ) definition *= ", ";
1e9a1b2001-02-21Per Hedbor 
a665382001-01-29Per Hedbor  if( catch(sql->query( "SELECT * FROM "+res+" LIMIT 1" )) )
1e9a1b2001-02-21Per Hedbor  {
3a7e562001-08-23Per Hedbor  ddc++;
1e9a1b2001-02-21Per Hedbor  mixed error = catch {
c76ebd2004-03-23Martin Stjernholm  get_my_sql()->query( "CREATE TABLE "+res+" ("+definition+")" );
298be12001-08-13Per Hedbor  DBManager.is_module_table( this_object(), my_db, res, oname+"\0"+comment );
1e9a1b2001-02-21Per Hedbor  }; if( error ) { if( strlen( name ) ) name = " "+name;
2466122001-08-01Per Hedbor  report_error( "Failed to create table"+name+": "+ describe_error( error ) );
1e9a1b2001-02-21Per Hedbor  return 0; }
3a7e562001-08-23Per Hedbor  if( flag ) { __my_tables[ "&"+oname+";" ] = res; return ddc; }
2be1982001-08-01Per Hedbor  return __my_tables[ "&"+oname+";" ] = res;
1e9a1b2001-02-21Per Hedbor  }
c76ebd2004-03-23Martin Stjernholm // // Update definition if it has changed.
a0487b2001-07-31Per Hedbor // mixed error = // catch // {
c76ebd2004-03-23Martin Stjernholm // get_my_sql()->query( "ALTER TABLE "+res+" ("+definition+")" );
a0487b2001-07-31Per Hedbor // }; // if( error ) // { // if( strlen( name ) ) // name = " for "+name;
c76ebd2004-03-23Martin Stjernholm // report_notice( "Failed to update table definition"+name+": "+
a0487b2001-07-31Per Hedbor // describe_error( error ) ); // }
3a7e562001-08-23Per Hedbor  if( flag ) { __my_tables[ "&"+oname+";" ] = res; return ddc; }
2be1982001-08-01Per Hedbor  return __my_tables[ "&"+oname+";" ] = res;
a730c22001-01-19Per Hedbor }
e082212001-08-28Per Hedbor static string my_db = "local";
6533f22001-08-23Martin Nilsson 
2be1982001-08-01Per Hedbor static void set_my_db( string to )
1e9a1b2001-02-21Per Hedbor //! 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; }
2466122001-08-01Per Hedbor Sql.Sql get_my_sql( int|void read_only )
1e9a1b2001-02-21Per Hedbor //! 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]
a730c22001-01-19Per Hedbor {
2be1982001-08-01Per Hedbor  return DBManager.cached_get( my_db, _my_configuration, read_only );
a730c22001-01-19Per Hedbor }