Roxen.git / server / modules / examples / common_api.pike

version» Context lines:

Roxen.git/server/modules/examples/common_api.pike:1:   inherit "module";   // All roxen modules must inherit module.pike    - constant cvs_version = "$Id: common_api.pike,v 1.1 2000/07/07 17:39:30 jhs Exp $"; + constant cvs_version = "$Id: common_api.pike,v 1.2 2000/08/24 10:56:10 jhs Exp $";   //! This string (filtered to remove some ugly cvs id markup) shows up in   //! the roxen administration interface when handling module parameters in   //! developer mode (configured under "User Settings" below the Admin tab).   //! It will also serve as the basis for extracting version information of   //! the file in the inherit tree. Optional, but convenient, especially if   //! you use cvs for version control of your code.      constant module_name = "Tamaroxchi";   //! The name that will show up in the module listings when adding modules   //! or viewing the modules of a virtual server. Keep it fairly informative
Roxen.git/server/modules/examples/common_api.pike:40:   //!   //! If your module is not thread safe, setting this flag to zero (0) or   //! leaving it unset altogether will make roxen serialize accesses to   //! your module. This will hurt performance on a busy server. A value of   //! one (1) means your module is thread safe.      int itching = 0;   // Like this, see? We keep global state here, which is a really bad habit   // most of the time - hence the zero for thread_safe just above.    - void create() + void create(Configuration|void conf)   //! In <pi>create()</pi>, you typically define your module's - //! configurable variables (using <ref>defvar()</ref>) and set - //! data about it using <ref>set_module_creator()</ref> and - //! <ref>set_module_url()</ref>. Se also <ref>start</ref>. + //! configurable variables (using <ref>defvar()</ref>) and set data + //! about it using <ref>set_module_creator()</ref> and + //! <ref>set_module_url()</ref>. The configuration object of the + //! virtual server the module was initialized in is always passed, + //! except for the one occation when the file is compiled for the + //! first time, when the `conf' argument passed is 0. Se also + //! <ref>start</ref>.   { -  +  report_debug("tamagotchi(%O)\n", conf); // Ends up in the debug log +  set_module_creator("Johan Sundström <>"); +  set_module_url("");   }      mapping(string:function(RequestID:void)) query_action_buttons( RequestID id )   //! Optional callback for adding action buttons to the module's   //! administration settings page; convenient for triggering module   //! actions like flushing caches and the like.   //!   //! The indices of the returned mapping are the action descriptions that will   //! show up on each button (e g "flush cache"), and the corresponding values   //! are the callbacks for each button respectively. These functions may take
Roxen.git/server/modules/examples/common_api.pike:74:   // No, this is not a common API function. :-)   {    if(itching)    {    itching = 0;    report_notice("Aah, that's good.\n");    } else    report_warning("Ouch!\n");   }    - string info( Configuration conf ) + string info( Configuration|void conf )   //! Implementing this function in your module is optional.   //!   //! When present, it returns a string that describes the module.   //! When absent, Roxen will use element <ref>module_doc</ref>. Unlike   //! module_doc, though, this information is only shown when the module   //! is present in a virtual server, so it won't show up when adding   //! modules to a server.   { -  +  string mp = query_internal_location();    return "This string overrides the documentation string given in " -  "module_doc, but only once the module is added to a server."; +  "module_doc, but only once the module is added to a server. " +  "The module's internal mountpoint is found at <tt>" + +  mp + "</tt>.";   }      string|void check_variable(string variable, mixed set_to)   //! Custom checks of configuration variable validities. (optional)   //!   //! Check admin interface variables for sanity.   //!   //! "variable" is the name of the variable we're checking,   //! "set_to" is the value being tested. A return value of zero (0)   //! means all was OK, a string is used as an error message that the
Roxen.git/server/modules/examples/common_api.pike:109:    if(variable=="variable1")    {    // find out if it's a value we'll accept... if so, then just return.    if(set_to=="whatevervalueweaccept")    return;    else // if it's not, return an error message.    return "Sorry, we don't accept that value...\n";    }   }    - void start() - //! Set up shop. (optional) + void start(int occasion, Configuration conf) + //! Set up shop / perform some action when saving variables. (optional)   //! - //! Do anything required before we are able to service requests. This - //! method is called when the virtual server the module belongs to - //! gets initialized, just after the module is successfully added by - //! the administrator or when reloading the module. + //! If occasion is 0, we're being called when starting up the module, + //! to perform whatever actions necessary before we are able to service + //! requests. This call is received when the virtual server the module + //! belongs to gets initialized, just after the module is successfully + //! added by the administrator or when reloading the module. + //! + //! This method is also called with occasion set to 2 whenever the + //! configuration is saved, as in when some module variable has changed + //! and the administrator clicked "save" in the admin interface. This + //! also happens just before calling <ref>stop()</ref> upon reloading + //! the module.   {    report_notice("Wow, I feel good!\n");   }      void stop()   //! Close down shop. (optional)   //!   //! Tidy up before the module is terminated. This method is called   //! when the administrator drops the module, reloads the module or   //! when the server is being shut down.
Roxen.git/server/modules/examples/common_api.pike:154:    case 1: how_much = "a bit."; break;    case 2: how_much = "noticeably."; break;    case 3: how_much = "quite a bit."; break;    case 4: how_much = "really much."; break;    case 5: how_much = "a lot."; break;    case 6: how_much = "unbearably!"; break;    default: how_much = "more than any sane person could stand!";    }    return sprintf("I'm itching %s Please scratch me!", how_much);   } +  + mapping|int|Stdio.File|void find_internal(string file, RequestID id) + //! Internal magic location. May return a result mapping, + //! -1 for a directory indicator, an open file descriptor + //! or 0, signifying file not found / request not handled. + //! Similar to the MODULE_LOCATION <ref>find_file()</ref> + //! in most respects, except that the mountpoint is defined + //! by the virtual server, and mostly used for background + //! things where a URL doesn't show too much, such as when + //! generating background images and the like. To get the + //! internal mountpoint below which find_internal will handle + //! requests, use <ref>query_internal_location()</ref>. + { +  return Roxen.http_string_answer(status()); + }