AOLserver Wiki - User contributions [en]

Sites That Run On AOLserver

2010-09-21T18:59:27Z

Dossy: Reverted edits by Cargames (Talk) to last revision by Markm

The following is (a probably incomplete) list of sites that run on AOLserver. Some you will recognize, some you probably won't.

Note: Please add entries in the following format:
* Site name | Version | URL | description (optional)

In order to appear on this list, the server '''MUST''' respond with a "Server:" header in the HTTP response which indicates that it is running AOLserver, and what version.

The following is a list of sites running some version of AOLserver at AOL:

{| class="tabulardata" cellpadding="4" cellspacing="0" border="1"
|- class="header"
! Site name !! Version !! URL !! Description (optional)
|-
| AOL.COM || AOLserver/3.4.2 || http://aol.com/ ||
|-
| Netscape || AOLserver/3.5.5 || http://home.netscape.com/ ||
|-
| Digital City || AOLserver/4.0 || http://home.digitalcity.com/ ||
|-
| AOL Mail || AOLserver/3.5.9 || http://webmail.aol.com/ ||
|-
| Moviefone || ArtBlast/3.5.4 || http://www.moviefone.com/ ||
|}

These are non-AOL sites that also use some version of AOLserver:

{| class="tabulardata" cellpadding="4" cellspacing="0" border="1"
|- class="header"
! Site name !! Version !! URL !! Description (optional)
|-
| colspan="4" | '''AOLserver 4.1.x'''
|-
| the CodeMill || AOLserver/4.1.0 || http://www.thecodemill.biz || host of the #aolserver IRC logs[http://www.thecodemill.biz/services/aolserver/irc/]
|-
| colspan="4" | '''AOLserver 4.0.x'''
|-
| [[Panoptic Computer Network]] || AOLserver/4.0.10a || http://panoptic.com/ ||
|-
| NS_SHUTDOWN || AOLserver/4.0.10a || http://www.nsshutdown.com/ ||
|-
| Bayt.com || AOLserver/4.0.10 || http://www.bayt.com/ ||
|-
| CiteULike || AOLserver/4.0.10 || http://www.citeulike.org/ ||
|-
| OpenACS || AOLserver/4.0.9 || http://openacs.org/ ||
|-
| Creative Commons || AOLserver/4.0.8 || http://creativecommons.org/ ||
|-
| Volunteer Solutions || AOLserver/4.0.8 || http://www.volunteersolutions.org/ ||
|-
| jongriffin.com || AOLserver/4.0.5 || http://www.jongriffin.com/ ||
|-
| Rate Your Music || AOLserver/4.0.10 || http://rateyourmusic.com/ ||
|-
| Salsa Blanca || AOLserver/4.0.5 || http://www.salsablanca.com/ ||
|-
| Kurup.org || AOLserver/4.0.10 || http://kurup.org/ ||
|-
| Seven Sisters Trading || AOLserver/4.0.3 || http://www.7-sisters.com/ ||
|-
| AIESEC.net || AOLserver/4.0 || http://www.aiesec.net/ ||
|-
| Don Baccus Photography || AOLserver/4.0 || http://donb.photo.net/ ||
|-
| M³ Beratungsgesellschaft || AOLserver/4.0 || http://www.m3-beratung.de/ ||
|-
| photo.net || AOLserver/4.0 || http://www.photo.net/ ||
|-
| Treffpunkt || AOLserver/4.0.10 || http://www.treffpunktsystems.com/ ||
|-
| Uptime || Aolserver/4.0.10 || http://uptime.openacs.org||
|-
| Myturl || Aolserver/4.0.10 || http://myturl.com || tinyurl clone
|-
| colspan="4" | '''AOLserver 3.5.x'''
|-
| OneWeek || AOLserver/3.5.10 || http://oneweek.org/ ||
|-
| Vitamist Spray Vitamins || AOLserver/3.5.6 || http://www.vitamist.com/ ||
|-
| Anchor Baptist Church || AOLserver/3.5.0 || http://www.anchorbaptist.org/ ||
|-
| Blue Ridge Amateur Radio Club || NaviServer/2.0 AOLserver/3.5.0 || http://www.radioclub.org/ ||
|-
| Irish Tribute || AOLserver/3.5.0 || http://www.irishtribute.com/ || IrishAbroad's tribute site for the WTC dead and missing
|-
| online.ie || AOLserver/3.5.0 || http://www.online.ie/ || Irish news portal
|-
| colspan="4" | '''AOLserver 3.4.x'''
|-
| Polska.pl || AOLserver/3.4z4l || http://www.polska.pl/ ||
|-
| AMTDA || AOLserver/3.4.2 || http://www.amtda.org/ ||
|-
| Away.com || AOLserver 3.4.2 || http://www.away.com/ ||
|-
| Onet.pl || AOLserver/3.4.2 || http://www.onet.pl/ ||
|-
| Techspex || AOLserver/3.4.2 || http://www.techspex.com/ ||
|-
| University of Hawaii Athletics || AOLserver/3.4.2 || http://uhathletics.hawaii.edu/ ||
|-
| Vivtek || AOLserver/3.4.2 || http://www.vivtek.com/ ||
|-
| unresponsive.net || AOLserver/3.4 || http://www.unresponsive.net/ ||
|-
| DolphinGames || AOLserver/3.4.2 || http://www.dolphingames.cz/ || "Server:" header renamed to DolphinGames/1.0.0; online wap and sms games; internal run also 4.0.x aol servers
|-
| colspan="4" | '''AOLserver 3.3.x'''
|-
| Akoor || AOLserver/3.3.1+ad13 || http://www.akoor.com/ || a cultural french quiz site
|-
| Bitzi || AOLserver/3.3.1+ad13 || http://bitzi.com/ ||
|-
| Caltech || AOLserver/3.3.1+ad13 || http://www.caltech.edu/ ||
|-
| Greatest Networker dot.Community || AOLserver/3.3.1+ad13 || http://www.greatestnetworker.com/ ||
|-
| Infogettable.net Backgammon || AOLserver/3.3.1+ad13 || http://backgammon.infogettable.net/ ||
|-
| thedesignexperience || AOLserver/3.3.1+ad13 || http://www.thedesignexperience.org/ ||
|-
| ]project-open[ || AOLserver/3.3.1+ad13 || http://projop.dnsalias.com/ ||
|-
| ]project-consulting[ Demoserver || AOLserver/3.3.1+ad13 || http://pcdemo.dnsalias.com/ ||
|-
| ]project-translation[ Demoserver || AOLserver/3.3.1+ad13 || http://ptdemo.dnsalias.com/ ||
|-
| colspan="4" | '''AOLserver 3.2.x'''
|-
| Investsberbank || AOLserver/3.2 || http://www.isb.ru/ || Joint-Stock Bank "Investsberbank"
|-
| MyWorkoutProgram || AOLserver/3.2+ad12 || http://www.myworkoutprogram.com/ ||
|-
| colspan="4" | '''AOLserver 2.x'''
|-
| Asimba Trainer Pro || NaviServer/2.0 AOLserver/2.3.3 || http://www.asimbatrainerpro.com/ ||
|-
| Fitrex.com || NaviServer/2.0 AOLserver/2.3.3 || http://www.fitrex.com/ ||
|-
| WGCR Radio || NaviServer/2.0 AOLserver/2.3.3 || http://www.wgcr.org/ ||
|-
| British Cattle Movement Service || NaviServer/2.0 AOLserver/2.3.3 || http://www.bcms.gov.uk/ ||
|}

Also, every website on this list is should be using AOLserver as well: http://openacs.org/community/sites/

----

'''Discussion:'''

'''Why MUST?''' Some people turn that off as part of their security principles. A known bug in Version 4.x would allow an attacker do simply grep through the following list. Could we please take that into consideration? How many sites would, e.g., introduce .adp pages just to get it on this _huge_ (irony) list?

''If anyone takes "security through obscurity" seriously enough to obfuscate the Server: header that's returned, then they also shouldn't want to be included on this list for the same reasons, so that people don't know they run AOLserver. Everyone else is free to advertise their sites here to try and ensure they get picked up by web server surveys like Netcraft, et. al.''

Ok, good point. You're perfectly right. Maybe I was just annoyed by being deleted from the list without explanation about the reason (which was added later). But why reject sites that don't expose the Server header for whatever reason? It is very easy to test that a site is running AOLserver (as easy as testing if a bug exists, of course). Why should we insist on detailed versioning?

''It makes maintaining the list easier. It'd be annoying for folks to add sites to this list and claim they run AOLserver, and then three months later the site switches to Apache. Who has the time to go poking and prodding to do server detection? It's easy to automate a script that asks "do I get a Server: AOLserver/xxx in the HTTP response?" and have it automatically keep the list fresh, which is what I currently have and run periodically. If folks running Apache/IIS want to falsely report AOLserver, that's annoying because the list will be inaccurate, but at least AOLserver will get the credit for the sites. :-)''

----

'''Sites that claim to run AOLserver 3.x, because the person who entered it into this Wiki assured it at that point in time. It may happen that the site runs Apache when you visit it and that may result in immediate pain, suffering or death. You have been warned!'''
* removed

''The links on the pages look awfully Vignette CURL-like. Is this site really running AOLserver? How can you prove it?''

How does a label in the header prove it? But we had this already. I started this rubric ''Sites that claim to run...'' to go around it. But I have absolutely no problem to remove all my sites (including the ones who have the header) from this wiki page in order to satisfy this principle.

Modules

2010-09-21T18:58:00Z

Dossy: Undo revision 5721 by 3qdesigns123 (Talk)

''See also: [[Toolkits]] and [[Languages]]''

''[[Jamie Rasmussen]] maintains a list of AOLserver modules tested against Windows[http://empoweringminds.spd.dcu.ie/openacs/aolserver_modules]. (Not recently updated - JR)''

== Standard Modules ==

AOLserver ships with the following modules:

* [[nscgi]] -- Standard CGI support for running external C programs, perl scripts etc.
* [[nscp]] -- Admin/debug support via a telnet like interface into a running server.
* [[nsdb]] -- The database interface, loads database specific drivers (below).
* [[nsext]] -- Communicates with external database drivers via proxy daemon.
* [[nslog]] -- Common log format or extended common log format access logging.
* [[nsperm]] -- Access control lists for groups/users, supports basic auth.
* [[nsproxy]] -- Execute Tcl scripts in an external process
* [[nssock]] -- Standard [[socket driver]], used for HTTP requests.
* [[nsssl]] -- SSL [[socket driver]], links against proprietary RSA BSAFE library (not supplied).

== Database Drivers ==

AOLserver database drivers are either internal or external. Internal drivers are shared libraries that are loaded in-process with the webserver -- they provide the best performance. External drivers are shared libraries which are loaded by the AOLserver database proxy daemon [[nsext]], which communicates with the webserver process via sockets. The advantage of running the database driver external to the webserver is that it isolates buggy, non-threadsafe database access libraries. These days however this is largely unneccessary, and the external drivers are usually slower due to context switching overhead.

* [[nsfb]] -- Internal '''Firebird|Interbase''' driver.
* [[dqd_db2]] -- Internal '''IBM DB2''' driver (unmaintained).
* [[nsberkeleydb]] -- Internal '''BerkeleyDB''' driver.
* [[nsfreetds]] -- Internal MS '''SQL Server'''/'''Sybase''' driver.
* [[nsinformix]] -- Internal '''Informix''' driver.
* [[nsingres]] -- Internal '''Ingres r3''' driver.
* [[nsibasepd]] -- External '''Interbase''' driver.
* [[nsmysql]] -- Internal '''MySQL''' driver.
* [[nsodbc]] -- Internal '''ODBC''' driver.
* [[nsoracle]] -- Internal '''Oracle''' driver.
* [[nspostgres]] -- Internal '''PostgreSQL''' driver.
* [[nssolid]] -- Internal '''Solid''' driver.
* [[nssqlite2]] -- Internal '''SQLite v2''' driver.
* [[nssqlite3]] -- Internal '''SQLite v3''' driver.
* [[nsunixodbc]] -- Internal ODBC driver which uses the '''unixODBC''' driver.

== Encryption / Security ==

* [[nsblowfish]] -- Encrypt Tcl strings with Blowfish cypher and hex encode.
* [[nsencrypt]] -- Uses OpenSSL to encrypt using the AES, Blowfish, Cast5, IDEA and DES cyphers.
* [[nsnss]] -- New SSL [[socket driver]], links against Netscape's portable runtime (NSPR) and security services (NSS) libraries.
* [[nsopenssl]] -- SSL [[socket driver]] links against OpenSSL, and also provides client connection capabilities.
* [[nspasswd]] -- CRYPT, MD5, SMD5, SHA and SSHA hashing algorithms.
* [[nssha1]] -- AOLserver module to perform SHA1 hashes.
* [[nspam]] -- Interface to Pluggable Authentication Modules (PAM).
* [[nsdigest]] -- Access control lists for groups/users (like [[nsperm]]), supports digest authentication.
* [[nsmhash]] -- Implementation of mhash library interface to hash, hmac and keygen algorithms (MD5,SHA1, ...). Available shared with nsv_*.
* [[nsmcrypt]] -- Implementation of mcrypt library interface to crypt,decrypt algorithms (blowfish, des, ...). Available shared with nsv_*.

== Virtual Hosting ==

AOLserver 2.x and 4.x have built-in support for software or name-based [[virtual hosting]], but AOLserver 3.x does not. Hardware virtual hosting (each server on its own port or IP) is supported across all three versions.

* [[nsvhr]] -- Redirecting proxy, passes virtualy hosted requests back to standalone server.
* [[nsunix]] -- [[socket driver]] for unix domain sockets, complements '''nsvhr'''.
* Patches to nsvhr and nsunix by [[Jerry Asher]] [http://web.hollyjerry.org:16080/]
* [[nssmartvh]] -- C and Tcl based smart virtual hosting module, by [[Zoro]]
* [[vat]] -- Tcl based Vhost Abstract Template Module, by [[Tom Jackson]]
* C-based virtual hosting module [http://deadlock.et.tudelft.nl/~daniel/vhost.html]
* [[nsvirthost]]

== Charting ==

* [[nsgdchart]] -- Generate png/jpg charts using open source gd library.
* [[nschartdir]] -- Generate charts using proprietary ChartDirector library.
* [[nsgd]] -- Generate png,jpg,wbmp,gif,... images using open source gd library.
* [[nsgraph]] --
* i-no graphing module using gd library (defunct: [http://www.i-no.com/art/inochart.html])

== XML ==

* [[tDOM]] -- a Tcl extension which provides XML/XSLT functionality.
* [[nsxml]] --
* [[nsexpat]] -- Interface to Expat

== Web Services ==

* [[nssoap]] -- ''unfinnished, unsupported''
* [[nsxmlrpc]] -- XML-RPC server and client API [http://openacs.org/sdm/one-package.tcl?package_id=12]

== WebDAV ==

* [[nsdav]] -- Port of Apache's WebDAV [http://www.webdav.org/mod_dav/] support for AOLserver.
* [[nswebdav]] --
* [[tDAV]] -- A WebDAV server module that uses [[tDOM]].

== Miscellaneous ==

* [[dqd_log]] -- Makes AOLserver log to a file descriptor.
* [[dqd_threadpool]] -- Job scheduling system with Tcl interface.
* [[dqd_utils]] -- collection of half a dozen small utility procs.
* [[nsadmin]] -- Database admin/log viewing features from v2 ported to v3.
* [[nsaspell]] -- Aspell Module [http://www.crystalballinc.com/vlad/software/]
* [[nsbinarysupport]] -- Write 8bit strings to connection without translation.
* [[nscache]] -- Tcl interface to AOLserver's caching API ([[ns_cache]] is builtin in AOLserver 4.5.1 or newer)
* [[nsclamav]] -- ClamAV Anti-Virus Interface Module [http://www.crystalballinc.com/vlad/software/]
* [[nsdci]] -- AOL's Digital City extensions (distributed cache, among other goodies) (http://code.google.com/p/nsdci/)
* [[nsdns]] -- DNS Server/Proxy Module [http://www.crystalballinc.com/vlad/software/]
* [[nsdqe]] -- Collection of utilities including caching, page counter, virtual hosting etc.
* [[nsexample]] -- An example module to help guide new module writers.
* [[nsfortune]] - Fortune like game module, uses real fortune files
* [[nsftp]] -- FTP server front end for AOLserver.
* [[nsfts]] -- Interface to Postgres full text search engine.
* [[nsimage]] -- returns sizes of various modules, implements [[ns_image]] & [[ns_pngsize]], replaces [[ns_jpegsize]] & [[ns_gifsize]]
* [[nsimap]] -- IMAP Module [http://www.crystalballinc.com/vlad/software/]
* [[nsjabber]] --
* [[nsjk2]] -- Jakarta connector
* [[nsldap]] -- LDAP client
* [[nsmaverix]] -- SMTP Proxy with anti-spam/anti-virus/whitelist/greylist/blacklist capabilities and Web interface [http://www.crystalballinc.com/vlad/software/maverix/]
* [[nsmsg]] - IPC message module for AOLserver
* [[ns_pkg]] -- Dynamic Tcl package loading.
* [[nspool]] -- Pools of sockets, pipes and external processes.
* [[nsprofile]] -- Time execution of Tcl commands.
* [[nsreturnz]] -- Gzip content encoding for dynamic requests.
* [[nsrewrite]] --
* [[nsroaming]] -- Netscape Navigator 4 Roaming Profiles.
* [[nssavi]] -- SOPHOS Anti-Virus Interface Module [http://www.crystalballinc.com/vlad/software/]
* [[nssession]] -- Session Management
* [[nssession (C module)]] -- Sessions implemented as a C module
* [[nssnmp]] -- SNMP Module [http://www.crystalballinc.com/vlad/software/]
* [[nssys]] - Unix system calls, including chmod, ioctl, fsstat, syslog, signal
* [[nstelemetry]] --
* [[nsthreadpool]] --
* [[nsuuid]] -- UUID generator module
* [[nszlib]] -- Zlib Module [http://www.crystalballinc.com/vlad/software/]
* [[nsperl]] -- Embedded Perl module (not production ready) [http://jam.sessionsnet.org/files/file?file_id=5477]

== Additional Software ==

* [[jk-voting]] -- Example DB based Voting Booth
* [http://bas.scheffers.net/aolserver/ Cache Tools], by [[Bas Scheffers]] -- I haven't worked with this or tested it in years, would like to hear from users!
* Tcl AutoLoader for AOLServer by Hal Heisler [http://www.heisler.net/hal]
* AOLserver 3.x Remote Administration Modules [http://www.scriptkitties.com/]
* HTTP Cookie Library [http://www.scriptkitties.com/]
* Simple-Templating System [http://www.oakroad.net/simple-templates/]
* [[nstest]]
* [[William Webb]] has a list of some unmaintained AOLserver software he created which may still be useful to you.
* AM.net[http://aolserver.am.net] maintains a page of AOLserver resources which includes an [[ADP]] pareser module and a module which fetches web pages.

[[Category:Documentation]]
[[Category:Modules]]

Modules

2010-09-21T18:55:33Z

Dossy: Reverted edits by Poersz (Talk) to last revision by 3qdesigns123

''See also: [[Toolkits]] and [[Languages]]''

''[[Jamie Rasmussen]] maintains a list of AOLserver modules tested against Windows[http://empoweringminds.spd.dcu.ie/openacs/aolserver_modules]. (Not recently updated - JR)''

== Standard Modules ==

AOLserver ships with the following modules:

* [[nscgi]] -- Standard CGI support for running external C programs, perl scripts etc.
* [[nscp]] -- Admin/debug support via a telnet like interface into a running server.
* [[nsdb]] -- The database interface, loads database specific drivers (below).
* [[nsext]] -- Communicates with external database drivers via proxy daemon.
* [[nslog]] -- Common log format or extended common log format access logging.
* [[nsperm]] -- Access control lists for groups/users, supports basic auth.
* [[nsproxy]] -- Execute Tcl scripts in an external process
* [[nssock]] -- Standard [[socket driver]], used for HTTP requests.
* [[nsssl]] -- SSL [[socket driver]], links against proprietary RSA BSAFE library (not supplied).

== Database Drivers ==

AOLserver database drivers are either internal or external. Internal drivers are shared libraries that are loaded in-process with the webserver -- they provide the best performance. External drivers are shared libraries which are loaded by the AOLserver database proxy daemon [[nsext]], which communicates with the webserver process via sockets. The advantage of running the database driver external to the webserver is that it isolates buggy, non-threadsafe database access libraries. These days however this is largely unneccessary, and the external drivers are usually slower due to context switching overhead.

* [[nsfb]] -- Internal '''Firebird|Interbase''' driver.
* [[dqd_db2]] -- Internal '''IBM DB2''' driver (unmaintained).
* [[nsberkeleydb]] -- Internal '''BerkeleyDB''' driver.
* [[nsfreetds]] -- Internal MS '''SQL Server'''/'''Sybase''' driver.
* [[nsinformix]] -- Internal '''Informix''' driver.
* [[nsingres]] -- Internal '''Ingres r3''' driver.
* [[nsibasepd]] -- External '''Interbase''' driver.
* [[nsmysql]] -- Internal '''MySQL''' driver.
* [[nsodbc]] -- Internal '''ODBC''' driver.
* [[nsoracle]] -- Internal '''Oracle''' driver.
* [[nspostgres]] -- Internal '''PostgreSQL''' driver.
* [[nssolid]] -- Internal '''Solid''' driver.
* [[nssqlite2]] -- Internal '''SQLite v2''' driver.
* [[nssqlite3]] -- Internal '''SQLite v3''' driver.
* [[nsunixodbc]] -- Internal ODBC driver which uses the '''unixODBC''' driver.

== Encryption / Security ==

* [[nsblowfish]] -- Encrypt Tcl strings with Blowfish cypher and hex encode.
* [[nsencrypt]] -- Uses OpenSSL to encrypt using the AES, Blowfish, Cast5, IDEA and DES cyphers.
* [[nsnss]] -- New SSL [[socket driver]], links against Netscape's portable runtime (NSPR) and security services (NSS) libraries.
* [[nsopenssl]] -- SSL [[socket driver]] links against OpenSSL, and also provides client connection capabilities.
* [[nspasswd]] -- CRYPT, MD5, SMD5, SHA and SSHA hashing algorithms.
* [[nssha1]] -- AOLserver module to perform SHA1 hashes.
* [[nspam]] -- Interface to Pluggable Authentication Modules (PAM).
* [[nsdigest]] -- Access control lists for groups/users (like [[nsperm]]), supports digest authentication.
* [[nsmhash]] -- Implementation of mhash library interface to hash, hmac and keygen algorithms (MD5,SHA1, ...). Available shared with nsv_*.
* [[nsmcrypt]] -- Implementation of mcrypt library interface to crypt,decrypt algorithms (blowfish, des, ...). Available shared with nsv_*.

== Virtual Hosting ==

AOLserver 2.x and 4.x have built-in support for software or name-based [[virtual hosting]], but AOLserver 3.x does not. Hardware virtual hosting (each server on its own port or IP) is supported across all three versions.

* [[nsvhr]] -- Redirecting proxy, passes virtualy hosted requests back to standalone server.
* [[nsunix]] -- [[socket driver]] for unix domain sockets, complements '''nsvhr'''.
* Patches to nsvhr and nsunix by [[Jerry Asher]] [http://web.hollyjerry.org:16080/]
* [[nssmartvh]] -- C and Tcl based smart virtual hosting module, by [[Zoro]]
* [[vat]] -- Tcl based Vhost Abstract Template Module, by [[Tom Jackson]]
* C-based virtual hosting module [http://deadlock.et.tudelft.nl/~daniel/vhost.html]
* [[nsvirthost]]

== Charting ==

* [[nsgdchart]] -- Generate png/jpg charts using open source gd library.
* [[nschartdir]] -- Generate charts using proprietary ChartDirector library.
* [[nsgd]] -- Generate png,jpg,wbmp,gif,... images using open source gd library.
* [[nsgraph]] --
* i-no graphing module using gd library (defunct: [http://www.i-no.com/art/inochart.html])

== XML ==

* [[tDOM]] -- a Tcl extension which provides XML/XSLT functionality.
* [[nsxml]] --
* [[nsexpat]] -- Interface to Expat

== Web Services ==

* [[nssoap]] -- ''unfinnished, unsupported''
* [[nsxmlrpc]] -- XML-RPC server and client API [http://openacs.org/sdm/one-package.tcl?package_id=12]

== WebDAV ==

* [[nsdav]] -- Port of Apache's WebDAV [http://www.webdav.org/mod_dav/] support for AOLserver.
* [[nswebdav]] --
* [[tDAV]] -- A WebDAV server module that uses [[tDOM]].

== Miscellaneous ==

* [[dqd_log]] -- Makes AOLserver log to a file descriptor.
* [[dqd_threadpool]] -- Job scheduling system with Tcl interface.
* [[dqd_utils]] -- collection of half a dozen small utility procs.
* [[nsadmin]] -- Database admin/log viewing features from v2 ported to v3.
* [[nsaspell]] -- Aspell Module [http://www.crystalballinc.com/vlad/software/]
* [[nsbinarysupport]] -- Write 8bit strings to connection without translation.
* [[nscache]] -- Tcl interface to AOLserver's caching API ([[ns_cache]] is builtin in AOLserver 4.5.1 or newer)
* [[nsclamav]] -- ClamAV Anti-Virus Interface Module [http://www.crystalballinc.com/vlad/software/]
* [[nsdci]] -- AOL's Digital City extensions (distributed cache, among other goodies) (http://code.google.com/p/nsdci/)
* [[nsdns]] -- DNS Server/Proxy Module [http://www.crystalballinc.com/vlad/software/]
* [[nsdqe]] -- Collection of utilities including caching, page counter, virtual hosting etc.
* [[nsexample]] -- An example module to help guide new module writers.
* [[nsfortune]] - Fortune like game module, uses real fortune files
* [[nsftp]] -- FTP server front end for AOLserver.
* [[nsfts]] -- Interface to Postgres full text search engine.
* [[nsimage]] -- returns sizes of various modules, implements [[ns_image]] & [[ns_pngsize]], replaces [[ns_jpegsize]] & [[ns_gifsize]]
* [[nsimap]] -- IMAP Module [http://www.crystalballinc.com/vlad/software/]
* [[nsjabber]] --
* [[nsjk2]] -- Jakarta connector
* [[nsldap]] -- LDAP client
* [[nsmaverix]] -- SMTP Proxy with anti-spam/anti-virus/whitelist/greylist/blacklist capabilities and Web interface [http://www.crystalballinc.com/vlad/software/maverix/]
* [[nsmsg]] - IPC message module for AOLserver
* [[ns_pkg]] -- Dynamic Tcl package loading.
* [[nspool]] -- Pools of sockets, pipes and external processes.
* [[nsprofile]] -- Time execution of Tcl commands.
* [[nsreturnz]] -- Gzip content encoding for dynamic requests.
* [[nsrewrite]] --
* [[nsroaming]] -- Netscape Navigator 4 Roaming Profiles.
* [[nssavi]] -- SOPHOS Anti-Virus Interface Module [http://www.crystalballinc.com/vlad/software/]
* [[nssession]] -- Session Management
* [[nssession (C module)]] -- Sessions implemented as a C module
* [[nssnmp]] -- SNMP Module [http://www.crystalballinc.com/vlad/software/]
* [[nssys]] - Unix system calls, including chmod, ioctl, fsstat, syslog, signal
* [[nstelemetry]] --
* [[nsthreadpool]] --
* [[nsuuid]] -- UUID [http://portablegeneratorsforsale.net/ portable generators] module
* [[nszlib]] -- Zlib Module [http://www.crystalballinc.com/vlad/software/]
* [[nsperl]] -- Embedded Perl module (not production ready) [http://jam.sessionsnet.org/files/file?file_id=5477]

== Additional Software ==

* [[jk-voting]] -- Example DB based Voting Booth
* [http://bas.scheffers.net/aolserver/ Cache Tools], by [[Bas Scheffers]] -- I haven't worked with this or tested it in years, would like to hear from users!
* Tcl AutoLoader for AOLServer by Hal Heisler [http://www.heisler.net/hal]
* AOLserver 3.x Remote Administration Modules [http://www.scriptkitties.com/]
* HTTP Cookie Library [http://www.scriptkitties.com/]
* Simple-Templating System [http://www.oakroad.net/simple-templates/]
* [[nstest]]
* [[William Webb]] has a list of some unmaintained AOLserver software he created which may still be useful to you.
* AM.net[http://aolserver.am.net] maintains a page of AOLserver resources which includes an [[ADP]] pareser module and a module which fetches web pages.

[[Category:Documentation]]
[[Category:Modules]]

AOLserver Wiki

2010-09-02T19:50:48Z

Dossy: Protected "AOLserver Wiki" ([edit=sysop] (indefinite) [move=sysop] (indefinite))

'''[http://www.aolserver.com AOLserver] is a high performance web server with a powerful customization API. The AOLserver Wiki is a comprehensive resource for all things AOLserver.'''

If you're new to [[wiki]]'s, then [[Welcome, New Visitors]]! Before you start editing, you may want to read over the [[Formatting Rules]]. To find pages grouped by category, [[Special:Categories|start here]].

== Topics of Conversation ==

* [[What is AOLserver]]?
* What [[Web Applications for AOLserver]] would you like to see?
* What [[AOLserver Bugs and Problems]] are you experiencing?
* What features does AOLserver need? Add them to the [[AOLserver Wishlist]].

* [[What's new in 4.5]] -- New features in version 4.5 of AOLserver. This is the current major release of AOLserver.

== AOLserver Resources: ==

* [[Downloads]] -- Access to various AOLserver files and resources.
* [[Modules]] -- Complete list of '''over 70''' AOLserver extension modules and other [[AOLserver Contributed Software]].
* [[Toolkits]] -- Everything you need to build a complete website, fast.
* [[Languages]] -- Build websites in a varierty of different programming languages.
* [[Documentation]] -- Tcl and C API references, tutorials and guides.
* [[FAQ]] -- Frequently Asked Questions about AOLserver.
* [[AOLserver Improvement Proposals]]
* The [[AOLserver Cookbook]] -- A collection of questions, and code examples to answer them.
* [[AOLserver Packages]] -- Binary distributions of AOLserver in popular package management formats.
* [[Useful Links]]
* [http://panoptic.com/wiki/aolserver/Special:Recentchanges?feed=rss RSS 2.0 syndication] of this wiki's recent changes.

== Developers' Guide (A Work In Progress) ==

* [[AOLserver Developer's Guide]] -- A growing, community generated guide on how to develop, deploy and maintain applications using AOLserver including discussions of internals, troubleshooting, debugging, testing and tuning.

== AOLserver Community ==

* The AOLserver project [[Roadmap]], as well as the planned [[Features]] and changes.
* The [[People]] who work on and contribute to AOLserver, organized into [[Project Teams]].
* Come join us in our [http://www.aolserver.com/chat/ online chat], or just read the [http://panoptic.com/aolserver/chat/ chat logs]. You can participate on the chat either via IRC (irc.freenode.net:6667 #aolserver) or via AIM.
* There's also an [http://www.livejournal.com/community/aolserver/ AOLserver LiveJournal community].
* [[Sites That Run On AOLserver]]
* The [[OpenACS]] Project.
* The [[ProjectOpen]] Project (project management based on [[OpenACS]])
* [[AOLserver User Groups]]
* [[AOLserver Jobs]]

== AOLserver Core Developers ==

* [[Vision Statement]]
* [[CVS Commit Guidelines]]
* [http://www.aolserver.com/docs/devel/tech/standards.html AOLserver Engineering Standards Manual]

__NOTOC__

AOLserver Wiki

2010-09-02T19:50:03Z

Dossy: Revert a whole bunch of spam edits.

AOLserver Wiki

2010-09-02T19:49:22Z

Dossy: Revert a whole bunch of spam edits.

'''[http://www.aolserver.com AOLserver] is a high performance web server with a powerful customization API. The AOLserver Wiki is a comprehensive resource for all things AOLserver.'''

If you're new to [[wiki]]'s, then [[Welcome, New Visitors]]! Before you start editing, you may want to read over the [[Formatting Rules]]. To find pages grouped by category, [[Special:Categories|start here]].

== Topics of Conversation ==

* [[What is AOLserver]]?
[http://uk.bestessays.com essays]
* What [[Web Applications for AOLserver]] would you like to see?
* What [[AOLserver Bugs and Problems]] are you experiencing?
[http://www.essaywriter.co.uk/custom-essays.aspx custom essays] | [http://www.florela.co.uk/ Christmas Wreath] | [http://www.best-webhost-review.com web hosting reviews]
* What features does AOLserver need? Add them to the [[AOLserver Wishlist]].

* [[What's new in 4.5]] -- New features in version 4.5 of AOLserver. This is the current major release of AOLserver.

== AOLserver Resources: ==

* [[Downloads]] -- Access to various AOLserver files and resources.
* [[Modules]] -- Complete list of '''over 70''' AOLserver extension modules and other [[AOLserver Contributed Software]].
* [[Toolkits]] -- Everything you need to build a complete website, fast.
* [[Languages]] -- Build websites in a varierty of different programming languages.
* [[Documentation]] -- Tcl and C API references, tutorials and guides.
* [[FAQ]] -- Frequently Asked Questions about AOLserver.
* [[AOLserver Improvement Proposals]]
* The [[AOLserver Cookbook]] -- A collection of questions, and code examples to answer them.
* [[AOLserver Packages]] -- Binary distributions of AOLserver in popular package management formats.
* [[Useful Links]]
* [http://panoptic.com/wiki/aolserver/Special:Recentchanges?feed=rss RSS 2.0 syndication] of this wiki's recent changes.
* [http://www.lsbf.org.uk MBA college london]

== Developers' Guide (A Work In Progress) ==

* [[AOLserver Developer's Guide]] -- A growing, community generated guide on how to develop, deploy and maintain applications using AOLserver including discussions of internals, troubleshooting, debugging, testing and tuning.

== AOLserver Community ==

* The AOLserver project [[Roadmap]], as well as the planned [[Features]] and changes.
* The [[People]] who work on and contribute to AOLserver, organized into [[Project Teams]].
* Come join us in our [http://www.aolserver.com/chat/ online chat], or just read the [http://panoptic.com/aolserver/chat/ chat logs]. You can participate on the chat either via IRC (irc.freenode.net:6667 #aolserver) or via AIM.
* There's also an [http://www.livejournal.com/community/aolserver/ AOLserver LiveJournal community].
* [[Sites That Run On AOLserver]]
* The [[OpenACS]] Project.
* The [[ProjectOpen]] Project (project management based on [[OpenACS]])
* [[AOLserver User Groups]]
* [[AOLserver Jobs]]

== AOLserver Core Developers ==

* [[Vision Statement]]
* [[CVS Commit Guidelines]]
* [http://www.aolserver.com/docs/devel/tech/standards.html AOLserver Engineering Standards Manual]

__NOTOC__

Ns schedule proc

2010-04-10T05:23:51Z

Dossy: remove spam link that snuck by

Man page: http://aolserver.com/docs/tcl/ns_schedule_proc.html

----

'''NAME'''

: ns_schedule_proc - Schedule a script to run after a certain number of seconds

'''SYNOPSIS'''

: '''ns_schedule_proc''' ''?-once? ?-thread? interval script''

'''DESCRIPTION'''

: This command schedules a script to be run after a certain number of seconds. Returns the ID of the newly scheduled script. If ''-once'' is specified, then the script is run once and then unscheduled, otherwise it will continue to run every ''interval'' seconds. If ''-thread'' is specified, then the script will be run in its own thread, otherwise it will run in the scheduler's thread. If the script is long-running, this may interfere with the running of other scheduled scripts, so long-running scripts should be run in their own threads.

'''EXAMPLES'''

% set id [[ns_schedule_proc -once 60 { ns_log notice "this should run in 60 seconds" }]]
123

% ns_unschedule_proc $id

'''SEE ALSO'''

: [[ns_after]], [[ns_info]] scheduled, [[ns_pause]], [[ns_resume]], [[ns_schedule_daily]], [[ns_schedule_weekly]], [[ns_unschedule_proc]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns schedule proc

2010-04-10T05:22:34Z

Dossy: Reverted edits by StacieLott (Talk) to last revision by Dossy

Man page: http://aolserver.com/docs/tcl/ns_schedule_proc.html

----

'''NAME'''

: ns_schedule_proc - Schedule a script to run after a certain number of seconds

'''SYNOPSIS'''

: '''ns_schedule_proc''' ''?-once? ?-thread? interval script''

'''DESCRIPTION'''

: This command schedules a script to be run after a certain number of seconds. Returns the ID of the newly scheduled script. If ''-once'' is specified, then the script is run once and then unscheduled, otherwise it will continue to run every ''interval'' seconds. If ''-thread'' is specified, then the script will be run in its own thread, otherwise it will run in the scheduler's thread. If the script is long-running, this may interfere with the running of other scheduled scripts, so long-running scripts should be run in their own threads.

'''EXAMPLES'''

% set id [[ns_schedule_proc -once 60 { ns_log notice "this should run in 60 seconds" }]]
123

% ns_unschedule_proc $id

'''SEE ALSO'''

: [[ns_after]], [[ns_info]] scheduled, [[ns_pause]], [http://www.rushessay.com essay], [[ns_resume]], [[ns_schedule_daily]], [[ns_schedule_weekly]], [[ns_unschedule_proc]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

User talk:Josephbui

2010-03-15T16:36:34Z

Dossy:

Joseph: Thanks for your help cleaning up the wiki vandalism. Would you like Admin privileges to take care of deletes and blocks? -- [[User:Dossy|Dossy]] 14:30, 15 March 2010 (UTC)

Dossy: Sure, thanks! [[User:Josephbui|Josephbui]] 16:25, 15 March 2010 (UTC)
* OK, done. Thanks - would love to hear your thoughts on AOLserver and Tcl at some point ... -- [[User:Dossy|Dossy]] 16:36, 15 March 2010 (UTC)

User talk:Josephbui

2010-03-15T14:30:51Z

Dossy: Created page with 'Joseph: Thanks for your help cleaning up the wiki vandalism. Would you like Admin privileges to take care of deletes and blocks? -- ~~~~'

Joseph: Thanks for your help cleaning up the wiki vandalism. Would you like Admin privileges to take care of deletes and blocks? -- [[User:Dossy|Dossy]] 14:30, 15 March 2010 (UTC)

Ns schedule proc

2010-03-15T14:24:11Z

Dossy: Undo revision 5678 by Patersonmaikl3 (Talk)

Man page: http://aolserver.com/docs/tcl/ns_schedule_proc.html

----

'''NAME'''

: ns_schedule_proc - Schedule a script to run after a certain number of seconds

'''SYNOPSIS'''

: '''ns_schedule_proc''' ''?-once? ?-thread? interval script''

'''DESCRIPTION'''

: This command schedules a script to be run after a certain number of seconds. Returns the ID of the newly scheduled script. If ''-once'' is specified, then the script is run once and then unscheduled, otherwise it will continue to run every ''interval'' seconds. If ''-thread'' is specified, then the script will be run in its own thread, otherwise it will run in the scheduler's thread. If the script is long-running, this may interfere with the running of other scheduled scripts, so long-running scripts should be run in their own threads.

'''EXAMPLES'''

% set id [[ns_schedule_proc -once 60 { ns_log notice "this should run in 60 seconds" }]]
123

% ns_unschedule_proc $id

'''SEE ALSO'''

: [[ns_after]], [[ns_info]] scheduled, [[ns_pause]], [http://www.rushessay.com essay], [[ns_resume]], [[ns_schedule_daily]], [[ns_schedule_weekly]], [[ns_unschedule_proc]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

Ns register proc

2010-03-15T14:19:30Z

Dossy: Reverted edits by HelenArchibald (Talk) to last revision by Umbrella13

{{manpage|ns_proc}}

'''NAME'''

: ns_register_proc - Register a procedure for a method/URL combination

'''SYNOPSIS'''

: '''ns_register_proc''' ''?-noinherit? method URL myproc ?args?''

'''DESCRIPTION'''

: '''ns_register_proc''' registers the procname to handle the specified method/URL combination. When the server gets a matching request, it calls procname with the connection id and any arguments specified here.

: If ''-noinherit'' is specified, the requested URL must match the specified URL exactly. For example, if the URL specified with '''ns_register_proc''' is /foo/bar, procname will not be called unless the requested URL is exactly /foo/bar.

: If ''-noinherit'' is not specified, the requested URL can match the specified URL or any URL below it. For example, if the URL specified with '''ns_register_proc''' is /foo/bar, procname will be called for /foo/bar, /foo/bar/hmm, and any other URL below /foo/bar, provided there is not already another procedure registered for that exact URL or for an URL with a closer match.

: Note that you must use a glob-style matching character if you want inheritance for file names. For example, if you want /foo/bar to match /foo/bar.html, you must use:

ns_register_proc /foo/bar*

: You can register two procedures for any given method/URL combination by calling '''ns_register_proc''' once with the ''-noinherit'' flag set and once without it. Only one of the procedures will be called for any given request, depending on whether the URL was an exact match or not. For example:

ns_register_proc -noinherit GET /foo/bar Aproc
ns_register_proc GET /foo/bar Bproc
ns_register_proc GET /foo/bar/hmm Cproc

: Aproc will be called when the requested URL is exactly /foo/bar. Bproc will be called when the requested URL is below /foo/bar, provided there is not already another procedure registered to be called for that exact URL or for an URL with a closer match. Cproc (not Bproc) will be called when the requested URL is equal to or below /foo/bar/hmm. Syntax for the registered procedure The conn (connection) argument is optional for procedures registered by '''ns_register_proc''' if the procedure has 0 or 1 arguments (not including conn). The following [http://www.umbrellaonline.com real estate] examples show the variations that can be used in this case:

ns_register_proc GET /noargs noargs
ns_register_proc GET /context context fnord
ns_register_proc GET /conncontext conncontext greeblev

proc noargs { } {
ns_returnnotice 200 "noargs"
} ;# noargs

proc context { context } {
ns_returnnotice 200 "context is $context"
} ;# context

proc conncontext { conn context } {
ns_returnnotice 200 "conncontext is $context"
} ;# conncontext

: The ''conn'' (connection) argument is required for procedures registered by '''ns_register_proc''' if the procedure has 2 or more arguments (not including ''conn''). The ''conn'' argument will be filled automatically with the connection information. The first argument following ''conn'' will always take the value supplied by '''ns_register_proc''', if there is one, or an empty value. All other arguments must supply a default value. The following examples show the variations that can be used in this case:

ns_register_proc GET /twoargs twoargs fnord
ns_register_proc GET /threeargs threeargs fnord fjord

proc twoargs { conn context { greeble bork } } {
# Do stuff...
}

proc threeargs { conn context {greeble bork } { hoover quark } {
# Do stuff...
}

: When a GET of /twoargs is requested, the conn argument will be filled automatically, the context argument will be assigned "fnord" and the greeble argument will be assigned the default value "bork".

: When a GET of /threeargs is requested, the conn argument will be filled automatically, the context argument will be assigned "fnord" and the greeble argument will be assigned "fjord", and the hoover argument will be assigned the default value "quark".

'''SEE ALSO'''

: [[ns_unregister_proc]]

[[Category:Documentation]] [[Category:Core Tcl API]]

Ns schedule proc

2010-03-15T14:17:02Z

Dossy: Reverted edits by Umbrella13 (Talk) to last revision by Patersonmaikl3

Man page: http://aolserver.com/docs/tcl/ns_schedule_proc.html

----

'''NAME'''

: ns_schedule_proc - Schedule a script to run after a certain number of seconds

'''SYNOPSIS'''

: '''ns_schedule_proc''' ''?-once? ?-thread? interval script''

'''DESCRIPTION'''

: This command schedules a script to be run after a certain number of seconds. Returns the ID of the newly scheduled script. If ''-once'' is specified, then the script is run once and then unscheduled, otherwise it will continue to run every ''interval'' seconds. If ''-thread'' is specified, then the script will be run in its own thread, otherwise it will run in the scheduler's thread. If the script is long-running, this may interfere with the running of other scheduled scripts, so long-running scripts should be run in their own threads.

'''EXAMPLES'''

% set id [[ns_schedule_proc -once 60 { ns_log notice "this should run in 60 seconds" }]]
123

% ns_unschedule_proc $id

'''SEE ALSO'''

: [[ns_after]], [[ns_info]] scheduled, [[ns_pause]], [http://www.rushessay.com essay], [http://www.standoutessay.com/essay-writers essay writers], [[ns_resume]], [[ns_schedule_daily]], [[ns_schedule_weekly]], [[ns_unschedule_proc]]

----

[[Category:Documentation]] - [[Category:Core Tcl API]]

User talk:Caveman

2009-10-20T20:50:35Z

Dossy: New section: Sysop and Bureaucrat rights

== towards a data and authentication layer ==

It is possible that similar exists elsewhere (non-OpenACS) but I enjoy framework construction anyway. Services provided:
# authentication (password check)
# sequences
# data layer

----

Authentication/Authorization config (nsz):
<pre>
# config: "/security/password/expression"
# {::sha1::hmac [lindex $args 1] [lindex $args 0]}
# config: "/security/password/query"
# {select password, salt from users where name=[ns_dbquotevalue [lindex $args 0]]}
# config: "/security/salt/length" "64"
# config: "/security/salt/dictionary" "0123456789abcdefghijkl..."
</pre>

Basically the "expression" is used in a function, '''nsz_password''' to format a given clear-text password (varargs "args" to allow additional arguments to the function). The first argument is always the password.

The "query" is executed as part of password-based authentication. The form handler reaches '''nsz_auth "myname" "mypassword"''' and the query is executed using the input list "myname". All row data beyond the first column, which must always be the password, is appended to the input password "mypassword" to produce the hash/salted/hash input "xpassword". This input "xpassword" is compared with the result of the returned value for the first column from the database query. If there is a match, password authentication succeeds for the user.

Examples:
<pre>
nsz_auth "sam" "correctpassword"
# Query returns "sadf8vcx8vxasd7f7...","asduf7z6dfa..."
# Expression eval for input passes "correctpassword","asduf7z6dfa..." and returns "sadf8vcx8vxasd7f7..."
# Return value matches query
# nsz_auth returns "sam"

nsz_auth "sam" "badpassword"
# Query returns "sadf8vcx8vxasd7f7...","asduf7z6dfa..."
# Expression eval for input passes "badpassword","asduf7z6dfa..." and returns "yyzkfosd232cx7c..."
# Return value does not match query
# nsz_auth raises error "bad password"
</pre>

Different configurations could use simple clear-text passwords, no salt, etc, simply by changing their configuration:
<pre>
# config: "nsz/security/password/expression"
# {lindex $args 0}
# config: "nsz/security/password/query"
# {select password from users where name=[ns_dbquotevalue [lindex $args 0]]}
</pre>

The above would be the default configuration. For salt, the default would be size of 8 and dictionary of alphanumerics.

Function '''nsz_salt''' can take 0, 1, or 2 arguments and returns the generated salt. The first argument is the length of the salt, defaults to config value. The second argument is the dictionary for the salt, default to config value.

'''Question:''' How to make "users" table configurable? What about configuring which database pool to use? What about multiple authentication realms?

----

Sequences configuration should be as simple as specifying the database pool to use (default by default), the name of the sequence table, the size of the sequence chunk to claim when the local cache runs out of sequence numbers, and the number of retries before error during chunk claim. It could however be more complex, to specify the column names for the "name" and "value" of the sequence.

Config:
<pre>
# config: "nso/sequence/default/poolname" (default by default)
# config: "nso/sequence/default/size" "100"
# config: "nso/sequence/default/retry" "5"
# config: "nso/sequence/default/table" "sequences_table"
# config: "nso/sequence/default/name" "name_field"
# config: "nso/sequence/default/value" "value_field"
</pre>

Sequence defaults could be over-written per-sequence in similar fashion.

Example usage:
<pre>
set nextId [nso_sequence next "my_seq_name"]
# returns 53 or error if fail
</pre>

The function '''nso_sequence''' would thread-safe return the next sequence number it had available in its local nsv data, or if not available, claim the next chunk of 100 sequences numbers from the database:
<pre>
# select value_field from sequences_table where name_field='my_seq_name'
# result is 125, attempt to claim 100 values
# update cave_sequences set value=225 where name_field='my_seq_name' and value_field=125
</pre>

This would be retried up to ''5'' times.

----

Data layer notes:

Config would map names like "users" to database pools and table names. Default would be default database pool and identity table name.

Example usage:
<pre>
# set nssValues [ns_set create]
# ns_set update $nssValues "name" "sam"
# ns_set update $nssValues "password" "mypassword"
# ns_set put $nssValues "mail" "sam@caveman.org"
# set nssUserKey [nso_row create "users" $nssValues]
# set nssNewValues [ns_set create]
# ns_set put $nssNewValues "mail" "samuelmb@gmail.com"
# nso_row update "users" $nssUserKey $nssNewValues
</pre>

Using ns_set instead of a model type-checking "nso_set" at least for now for simplicity and it would be the simple case.

Additional config allows for data transforms:
<pre>
# multi stage of filters and expressions:
#
# stage 0: accept-data-filter
# e.g. "require a password is not null"
# e.g. "require this integer be above zero"
# e.g. "require id not be set"
#
# stage 1: transform-data-filter
# config: expressions to apply to row:
# e.g. "generate a salt"
# ns_set update $nssData "salt" [nsz_salt]
# e.g. "transform the password"
# ns_set update $nssData "password" [nsz_password [ns_set get $nssData "password"] [ns_set get $nssData "salt"]]
# e.g. "generate the next id from sequence"
# ns_set update $nssData "id" [nso_sequence next "my_seq_name"]
#
# stage 2: veto-data-filter?
#
# allow multiple "inheritance" of data rules? or just defining rules that
# can be referenced by multiple tables?
</pre>

''very draft state''

== useful links ==
[http://philip.greenspun.com/doc/ philip.greenspun.com/doc/]

[http://philip.greenspun.com/doc/data-pipeline data-pipeline]

== AJAX/JSON support in AOLserver ==

# HTTP request hits AOLserver, returns HTML including JavaScript with AJAX (or JSON-RPC, whatever) features.
# Client interacts with rendered HTML application, resulting in AJAX calls to AOLserver.
# AOLserver handles the AJAX calls and responds.
# Client potentially modified by result of AJAX call without reload.

Use cases:
# Rate something and store the rating without reload of page.
# Stateful drag and drop of tiles (shopping cart, wish list).
# Background saving of application state (e.g. word processor, calendar, etc) without page reload.
# Reload portions of the view (e.g. portlet) without reloading the whole page. E.g. stock tickers, chat windows, log viewers, etc.
# Add/remove item from cart statefully without reload of page.
# Recalculate shopping cart prices/totals without reload of page.

Benefits:
# Allows "Web 2.0" sites such as Digg and Gmail to be run on massively scalable AOLserver platform.
# It's an itch. We scratch these things.

Links:
* [http://www.writely.com/ writely -- the web word processor]
* [http://www.digg.com/spy digg spy -- show console data e.g. log, recent searches, monitoring, stocks, etc]
* [http://www.kiko.com/ kiko -- online calendar]
* [http://mail.google.com/ google mail]
* [http://maps.google.com/ google maps]
* [http://www.crockford.com/javascript/ javascript link collection]
* [http://en.wikipedia.org/wiki/AJAX wikipedia article on AJAX]
* [http://rajshekhar.net/blog/archives/85-Rasmus-30-second-AJAX-Tutorial.html 30 second intro to AJAX]

== Sysop and Bureaucrat rights ==

Hi, Sam - I've granted you Sysop and Bureaucrat rights, so you can delete wiki pages and such. You seem to watch the wiki and police it for spam a lot more than I can these days. Thanks! -- [[User:Dossy|Dossy]] 16:50, 20 October 2009 (EDT)

SMLserver

2008-04-14T20:39:10Z

Dossy: provide some factual information about SMLserver when it was AOLserver-related

Early SMLserver releases provided a Stanard ML module for AOLserver (nssml.so).

== See also ==

* A Functional Approach to Web Publishing ([http://www.itu.dk/~mael/mypapers/smlserver-4.1.0.pdf smlserver-4.1.0.pdf]), by Martin Elsman and Niels Hallenberg.
* [http://www.springerlink.com/content/vbkf26yab0elru3g/ Web Programming with SMLserver], ISBN 978-3-540-00389-2.

Talk:Ns url2file

2007-12-06T14:31:11Z

Dossy: /* What happens to special characters? */

== What happens to special characters? ==

If the url contains, e.g., the '+' character or the sequence '%20', does ns_url2file unencode it the same as the underlying page finding code does?

In AOLServer 3.4.2, it doesn't look like it does. Say I request the url '/foo%20bar.html'. If I use a Tcl library function as a "404" handler (using the file-system-as-cache technique), and generate my file via
<pre>
set file [open "[ns_url2file $url]" w]
puts $file $content
close $file
</pre>
Then the '$url' is still Not Found on the next request. I'm getting the URL by directly reading the request header (since I'm in a redirection routine, the value of [ns_conn url] is my redirected URL, not the URL originally requested).

Thought I'd ask here since it would be nice if the wiki page got updated with the answer....

: ''Indeed, there's a "bug" in the URL encoding code with respect to "+" and "%20" and whitespace. At some point, we have to "fix" this--but it'll result in a break in backward compatibility and can cause published URLs that expect the previous behavior to become 404's. Perhaps if this is clearly documented and made very clear, it'll be okay to make the change ... your thoughts?'' --[[User:Dossy|Dossy]] 09:31, 6 December 2007 (EST)

Sites That Run On AOLserver

2007-11-21T13:11:04Z

Dossy: added CiteULike

The following is (a probably incomplete) list of sites that run on AOLserver. Some you will recognize, some you probably won't.

Note: Please add entries in the following format:
* Site name | Version | URL | description (optional)

In order to appear on this list, the server '''MUST''' respond with a "Server:" header in the HTTP response which indicates that it is running AOLserver, and what version.

The following is a list of sites running some version of AOLserver at AOL:

{| class="tabulardata" cellpadding="4" cellspacing="0" border="1"
|- class="header"
! Site name !! Version !! URL !! Description (optional)
|-
| AOL.COM || AOLserver/3.4.2 || http://aol.com/ ||
|-
| Netscape || AOLserver/3.5.5 || http://home.netscape.com/ ||
|-
| Digital City || AOLserver/4.0 || http://home.digitalcity.com/ ||
|-
| AOL Mail || AOLserver/3.5.9 || http://webmail.aol.com/ ||
|-
| Moviefone || ArtBlast/3.5.4 || http://www.moviefone.com/ ||
|}

These are non-AOL sites that also use some version of AOLserver:

{| class="tabulardata" cellpadding="4" cellspacing="0" border="1"
|- class="header"
! Site name !! Version !! URL !! Description (optional)
|-
| colspan="4" | '''AOLserver 4.5.x'''
|-
| WhatsThisIP.com || AOLserver/4.5.0 || http://WhatsThisIP.com/ ||
|-
| colspan="4" | '''AOLserver 4.1.x'''
|-
| the CodeMill || AOLserver/4.1.0 || http://www.thecodemill.biz || host of the #aolserver IRC logs[http://www.thecodemill.biz/services/aolserver/irc/]
|-
| colspan="4" | '''AOLserver 4.0.x'''
|-
| [[Panoptic Computer Network]] || AOLserver/4.0.10a || http://panoptic.com/ ||
|-
| NS_SHUTDOWN || AOLserver/4.0.10a || http://www.nsshutdown.com/ ||
|-
| Bayt.com || AOLserver/4.0.10 || http://www.bayt.com/ ||
|-
| CiteULike || AOLserver/4.0.10 || http://www.citeulike.org/ ||
|-
| OpenACS || AOLserver/4.0.9 || http://openacs.org/ ||
|-
| Creative Commons || AOLserver/4.0.8 || http://creativecommons.org/ ||
|-
| Volunteer Solutions || AOLserver/4.0.8 || http://www.volunteersolutions.org/ ||
|-
| jongriffin.com || AOLserver/4.0.5 || http://www.jongriffin.com/ ||
|-
| Rate Your Music || AOLserver/4.0.10 || http://rateyourmusic.com/ ||
|-
| Salsa Blanca || AOLserver/4.0.5 || http://www.salsablanca.com/ ||
|-
| Kurup.org || AOLserver/4.0.10 || http://kurup.org/ ||
|-
| Seven Sisters Trading || AOLserver/4.0.3 || http://www.7-sisters.com/ ||
|-
| AIESEC.net || AOLserver/4.0 || http://www.aiesec.net/ ||
|-
| Don Baccus Photography || AOLserver/4.0 || http://donb.photo.net/ ||
|-
| M³ Beratungsgesellschaft || AOLserver/4.0 || http://www.m3-beratung.de/ ||
|-
| photo.net || AOLserver/4.0 || http://www.photo.net/ ||
|-
| Treffpunkt || AOLserver/4.0.10 || http://www.treffpunktsystems.com/ ||
|-
| Uptime || Aolserver/4.0.10 || http://uptime.openacs.org||
|-
| Myturl || Aolserver/4.0.10 || http://myturl.com || tinyurl clone
|-
| colspan="4" | '''AOLserver 3.5.x'''
|-
| OneWeek || AOLserver/3.5.10 || http://oneweek.org/ ||
|-
| Vitamist Spray Vitamins || AOLserver/3.5.6 || http://www.vitamist.com/ ||
|-
| Anchor Baptist Church || AOLserver/3.5.0 || http://www.anchorbaptist.org/ ||
|-
| Blue Ridge Amateur Radio Club || NaviServer/2.0 AOLserver/3.5.0 || http://www.radioclub.org/ ||
|-
| Irish Tribute || AOLserver/3.5.0 || http://www.irishtribute.com/ || IrishAbroad's tribute site for the WTC dead and missing
|-
| online.ie || AOLserver/3.5.0 || http://www.online.ie/ || Irish news portal
|-
| colspan="4" | '''AOLserver 3.4.x'''
|-
| Polska.pl || AOLserver/3.4z4l || http://www.polska.pl/ ||
|-
| AMTDA || AOLserver/3.4.2 || http://www.amtda.org/ ||
|-
| Away.com || AOLserver 3.4.2 || http://www.away.com/ ||
|-
| Onet.pl || AOLserver/3.4.2 || http://www.onet.pl/ ||
|-
| Techspex || AOLserver/3.4.2 || http://www.techspex.com/ ||
|-
| University of Hawaii Athletics || AOLserver/3.4.2 || http://uhathletics.hawaii.edu/ ||
|-
| Vivtek || AOLserver/3.4.2 || http://www.vivtek.com/ ||
|-
| unresponsive.net || AOLserver/3.4 || http://www.unresponsive.net/ ||
|-
| DolphinGames || AOLserver/3.4.2 || http://www.dolphingames.cz/ || "Server:" header renamed to DolphinGames/1.0.0; online wap and sms games; internal run also 4.0.x aol servers
|-
| colspan="4" | '''AOLserver 3.3.x'''
|-
| Akoor || AOLserver/3.3.1+ad13 || http://www.akoor.com/ || a cultural french quiz site
|-
| Bitzi || AOLserver/3.3.1+ad13 || http://bitzi.com/ ||
|-
| Caltech || AOLserver/3.3.1+ad13 || http://www.caltech.edu/ ||
|-
| Greatest Networker dot.Community || AOLserver/3.3.1+ad13 || http://www.greatestnetworker.com/ ||
|-
| Infogettable.net Backgammon || AOLserver/3.3.1+ad13 || http://backgammon.infogettable.net/ ||
|-
| thedesignexperience || AOLserver/3.3.1+ad13 || http://www.thedesignexperience.org/ ||
|-
| ]project-open[ || AOLserver/3.3.1+ad13 || http://projop.dnsalias.com/ ||
|-
| ]project-consulting[ Demoserver || AOLserver/3.3.1+ad13 || http://pcdemo.dnsalias.com/ ||
|-
| ]project-translation[ Demoserver || AOLserver/3.3.1+ad13 || http://ptdemo.dnsalias.com/ ||
|-
| colspan="4" | '''AOLserver 3.2.x'''
|-
| Investsberbank || AOLserver/3.2 || http://www.isb.ru/ || Joint-Stock Bank "Investsberbank"
|-
| MyWorkoutProgram || AOLserver/3.2+ad12 || http://www.myworkoutprogram.com/ ||
|-
| colspan="4" | '''AOLserver 2.x'''
|-
| Asimba Trainer Pro || NaviServer/2.0 AOLserver/2.3.3 || http://www.asimbatrainerpro.com/ ||
|-
| Fitrex.com || NaviServer/2.0 AOLserver/2.3.3 || http://www.fitrex.com/ ||
|-
| WGCR Radio || NaviServer/2.0 AOLserver/2.3.3 || http://www.wgcr.org/ ||
|-
| British Cattle Movement Service || NaviServer/2.0 AOLserver/2.3.3 || http://www.bcms.gov.uk/ ||
|}

Also, every website on this list is should be using AOLserver as well: http://openacs.org/community/sites/

----

'''Discussion:'''

'''Why MUST?''' Some people turn that off as part of their security principles. A known bug in Version 4.x would allow an attacker do simply grep through the following list. Could we please take that into consideration? How many sites would, e.g., introduce .adp pages just to get it on this _huge_ (irony) list?

''If anyone takes "security through obscurity" seriously enough to obfuscate the Server: header that's returned, then they also shouldn't want to be included on this list for the same reasons, so that people don't know they run AOLserver. Everyone else is free to advertise their sites here to try and ensure they get picked up by web server surveys like Netcraft, et. al.''

Ok, good point. You're perfectly right. Maybe I was just annoyed by being deleted from the list without explanation about the reason (which was added later). But why reject sites that don't expose the Server header for whatever reason? It is very easy to test that a site is running AOLserver (as easy as testing if a bug exists, of course). Why should we insist on detailed versioning?

''It makes maintaining the list easier. It'd be annoying for folks to add sites to this list and claim they run AOLserver, and then three months later the site switches to Apache. Who has the time to go poking and prodding to do server detection? It's easy to automate a script that asks "do I get a Server: AOLserver/xxx in the HTTP response?" and have it automatically keep the list fresh, which is what I currently have and run periodically. If folks running Apache/IIS want to falsely report AOLserver, that's annoying because the list will be inaccurate, but at least AOLserver will get the credit for the sites. :-)''

----

'''Sites that claim to run AOLserver 3.x, because the person who entered it into this Wiki assured it at that point in time. It may happen that the site runs Apache when you visit it and that may result in immediate pain, suffering or death. You have been warned!'''
* removed

''The links on the pages look awfully Vignette CURL-like. Is this site really running AOLserver? How can you prove it?''

How does a label in the header prove it? But we had this already. I started this rubric ''Sites that claim to run...'' to go around it. But I have absolutely no problem to remove all my sites (including the ones who have the header) from this wiki page in order to satisfy this principle.

Ns adp safeeval

2007-09-25T22:14:48Z

Dossy: fixup wiki category links

'''NAME'''

: ns_adp_safeeval - Safely evaluate an ADP block

'''SYNOPSIS'''

: '''ns_adp_safeeval''' ''page ?args ...?''

'''DESCRIPTION'''

: This function evaluates the ADP specified by ''page'' just as [[ns_adp_eval]] does, except that it ignores inline scripts "<% ... %>"; only adp registered tags are executed. This is useful for providing a limited execution environment for untrusted code (such as user-created templates) without allowing potentially damaging code to run on the server.

'''EXAMPLES'''

'''SEE ALSO'''

: [[ns_adp_abort]], [[ns_adp_append]], [[ns_adp_argc]], [[ns_adp_argv]], [[ns_adp_bind_args]], [[ns_adp_break]], [[ns_adp_debug]], [[ns_adp_debuginit]], [[ns_adp_dir]], [[ns_adp_dump]], [[ns_adp_exception]], [[ns_adp_include]], [[ns_adp_mime]], [[ns_adp_mimetype]], [[ns_adp_parse]], [[ns_adp_puts]], [[ns_adp_registeradp]], [[ns_adp_registerproc]], [[ns_adp_registertag]], [[ns_adp_return]], [[ns_adp_safeeval]], [[ns_adp_stats]], [[ns_adp_stream]], [[ns_adp_tell]], [[ns_adp_trunc]]

[[Category:Documentation]]
[[Category:Core Tcl API]]

Downloads

2007-06-16T03:11:29Z

Dossy:

Looking to download AOLserver related files and resources? Here's a list of what's available:

* [http://sourceforge.net/project/showfiles.php?group_id=3152 AOLserver Files at SourceForge]
* Latest 4.0.x release, 4.0.10: [http://aolserver.com/downloads/aolserver-4.0.10-src.tar.gz aolserver-4.0.10-src.tar.gz]
* Latest 4.5.x release, 4.5.0: [http://aolserver.com/downloads/aolserver-4.5.0-src.tar.gz aolserver-4.5.0-src.tar.gz]

Nightly CVS snapshots, refreshed daily at 01:00 AM US/Pacific time (as long as SourceForge is working):

* AOLserver HEAD: [http://aolserver.com/files/aolserver-HEAD-src.tar.gz aolserver-HEAD-src.tar.gz]
* AOLserver aolserver_v40_bp branch: [http://aolserver.com/files/aolserver-aolserver_v40_bp-src.tar.gz aolserver-aolserver_v40_bp-src.tar.gz]
* AOLserver aolserver_v45_bp branch: [http://aolserver.com/files/aolserver-aolserver_v45_bp-src.tar.gz aolserver-aolserver_v45_bp-src.tar.gz]
* nsopenssl HEAD: [http://aolserver.com/files/nsopenssl-HEAD-src.tar.gz nsopenssl-HEAD-src.tar.gz]

== "Batteries Included" binary distributions ==

If a "[[Batteries Included]]" binary distribution of AOLserver were to be made available, downloads for it would be available here.

== AOLserver on Win32 ==

These binary releases are unsupported and considered alpha-quality at best. Use them at your own risk, but if you do find any issues, please file a [http://sourceforge.net/tracker/?group_id=3152&atid=103152 bug report]. Thanks!

* [http://static.panoptic.com/aolserver/AOLserver-4.0.10-2-Win32-Setup.exe AOLserver-4.0.10-2-Win32-Setup.exe]: AOLserver 4.0.10 (built 20070615) and Tcl 8.4.15 for Win32. [http://dossy.org/archives/000461.html]

* [http://aolserver.com/downloads/aolserver-4.1.0a-win32-20040821.zip AOLserver 4.1.0a (built 20040821) and Tcl 8.4.6 for Win32]
* [http://aolserver.com/downloads/aolserver-4.0.7-win32.zip AOLserver 4.0.7 and Tcl 8.4.6 for Win32]

If you want to build your own binaries for Win32, you should read [[How to build AOLserver on Win32]].

AOLserver and Tcl Crash Course

2007-06-16T03:09:39Z

Dossy: outdent code examples

{{TOCright}}

The following is a working draft in progress for an introductory guide to AOLserver and Tcl.

== ADP Pages ==

Hello <Yourname> - Simple page, user submits form, displays name

=== ADP example ===

hello-world.adp:

<pre>
<% set name [ns_queryget name "world"] %>
<html>
<head>
<title>Hello <%= [ns_quotehtml $name] %>!</title>
</head>
<body>
<p>Hello <%= [ns_quotehtml $name] %>!</p>
<form>
<p>Name: <input name="name" value="<%= [ns_quotehtml $name] %>"></p>
<p><input type="submit" value="Go"></p>
</form>
</body>
</html>
</pre>

=== Tcl example ===

hello-world.tcl:

<pre>
set name [ns_queryget name "world"]
ns_return 200 text/html "<html>
<head>
<title>Hello [ns_quotehtml $name]!</title>
</head>
<body>
<p>Hello [ns_quotehtml $name]!</p>
<form>
<p>Name: <input name="name" value="[ns_quotehtml $name]"></p>
<p><input type="submit" value="Go"></p>
</form>
</body>
</html>"
</pre>

== Tcl Basics ==

** Explain Minimalist Syntax
*** Commands, Subcommands (Evaluated and Non-Evaluated)
*** Working with variables set, expr
** Control Structures
*** if, while, etc.
*** procedures

== Fetching GET and POST ==

** Including / Referring to other pages
** Controlling Output
** Databases
*** Defining the connection from as a pool in the config.tcl
*** Selecting from the pool
*** Executing Queries, Retrieving Values

== Questions ==

* Where does ADP excel?
* What practices should PHP, ASP, JSP developers stop doing?
* How can one use Tcl to write very concise and readable code?
* How does one efficiently separate pages into MVC components if the wanted?
* How and why should one write a domain specific sublanguage?

Template:TOCright

2007-06-16T03:08:06Z

Dossy: some attempt at a Template:TOCright

{| cellspacing="0" cellpadding="0" style="clear: right; margin-bottom: .5em; float: right; padding: .5em 0 .8em 1.4em; background: none; width: auto;"
| __TOC__
|}

AOLserver and Tcl Crash Course

2007-06-16T03:06:16Z

Dossy: fixup wiki markup

AOLserver and Tcl Crash Course

2007-06-16T02:54:58Z

Dossy: added the "hello world" ADP example

== Draft Outline ==

* ADP Pages
** Hello <Yourname> - Simple page, user submits form, displays name
*** DOSSY: Create this example with very simple Tcl.

# hello-world.adp
<% set name [ns_queryget name "world"] %>
<html>
<head>
<title>Hello <%= [ns_quotehtml $name] %>!</title>
</head>
<body>
<p>Hello <%= [ns_quotehtml $name] %>!</p>
<form>
<p>Name: <input name="name" value="<%= [ns_quotehtml $name] %>"></p>
<p><input type="submit" value="Go"></p>
</form>
</body>
</html>

# hello-world.tcl
set form [ns_getform]
set name [string trim [ns_set get $form name]]
if {$name eq ""} {
set name "world"
}
ns_return 200 text/html "<html>
<head><title>Hello [ns_quotehtml $name]!</title></head>
<body>
Hello [ns_quotehtml $name]!
<form action='hello-world.tcl' method='post'>
Name: <input name='name' value='[ns_quotehtml $name]'>
<input type='submit'>
</form>
</body>
</html>"

* Tcl Basics
** Explain Minimalist Syntax
*** Commands, Subcommands (Evaluated and Non-Evaluated)
*** Working with variables set, expr
** Control Structures
*** if, while, etc.
*** procedures
* Fetching GET and POST
** Including / Referring to other pages
** Controlling Output
** Databases
*** Defining the connection from as a pool in the config.tcl
*** Selecting from the pool
*** Executing Queries, Retrieving Values

== Questions ==
* Where does ADP excel?
* What practices should PHP, ASP, JSP developers stop doing?
* How can one use Tcl to write very concise and readable code?
* How does one efficiently separate pages into MVC components if the wanted?
* How and why should one write a domain specific sublanguage?

Ns dbquery

2007-06-12T14:56:19Z

Dossy:

<pre>
#
# ns_dbquery --
#
# Execute a SQL query against either a pool or an opened db handle,
# and return the resultset as a list of lists. The first list
# contains the column names.
#
# If the statement was a statement which does not return rows, the
# result is an empty list. TODO: Perhaps return the number of rows
# updated?
#

proc ns_dbquery {args} {
if {([llength $args] - 1) % 2 != 0} {
error "wrong # args: should be \"ns_dbquery ?-pool name\
| -handle dbId? ?-timeout secs? sql\""
}
foreach {key value} [lrange $args 0 end-1] {
switch -exact -- $key {
-pool { set pool $value }
-handle { set handle $value }
-timeout { set timeout $value }
}
}
if {![info exists timeout]} {
set timeout 0
}
if {[info exists pool]} {
set db [ns_db gethandle -timeout $timeout $pool]
} elseif {[info exists handle]} {
set db $handle
} else {
# Use default pool, if configured.
set db [ns_db gethandle -timeout $timeout]
}
if {![string length $db]} {
error "couldn't get db handle"
}
set res [catch {
set resultset [list]
if {[ns_db exec $db [lindex $args end]] eq "NS_ROWS"} {
set row [ns_db bindrow $db]
set columns [list]
foreach {key value} [ns_set array $row] {
lappend columns $key
}
lappend resultset $columns
while {[ns_db getrow $db $row]} {
set data [list]
foreach {key value} [ns_set array $row] {
lappend data $value
}
lappend resultset $data
}
ns_set free $row
}
} err]
if {![info exists handle]} {
ns_db releasehandle $db
}
if {$res} {
error $err
}
return $resultset
}
</pre>

Dossy Shiobara

2007-01-03T23:38:30Z

Dossy: /* Articles */ adding Linux Magazine Spain article

: [mailto:dossy@panoptic.com]
: Location: US, NJ/NY/VA

[[Category:Person|Shiobara, Dossy]]

I run the [[AOLserver Wiki]] at [[Panoptic]]. If there are any problems with it, ''abuse me''.

My blog is at http://dossy.org/ aka [http://dossy.org/ Dossy's Blog] -- I try to post regularly (at least once a day, minimally once a week) and I often try to post about AOLserver-related matters.

----

My current AOLserver-related projects are to:

* Ensure we meet all our goals and milestones for the AOLserver Project according to the published 2004 [[Roadmap]].
* Start formalizing the testing/QA procedures and pre-release checklist that will go into every release: [[How are releases tested]]?
* [[nssic]] -- the Server Inter-Connect module

The following items are old and need to be updated:

* Stress-test and release version 0.6 of [[nsmysql]] (an internal database driver for MySQL)
* Write a configuration tool which will manage and generate nsd.tcl files
* Work on the [[AOLserver Packages]] - Binary distribution of AOLserver in the many popular package mangement formats like RedHat's RPM, Debian's .deb, FreeBSD's ports, Solaris's .pkg
* Write a server-side session management module, [[nssession]]
* Clean up version 0.1pre of [[nsfreetds]] (an internal database driver that connects to Microsoft SQL Server or Sybase using FreeTDS 0.51)

== Articles ==

I'm starting to collect articles written about AOLserver that are available on the web. Eventually, these will move to their own wiki page:

* [http://www.eveandersson.com/arsdigita/asj/aolserver/introduction-1 Introduction to AOLserver, Part 1] by Philip Greenspun (LinuxWorld.com, July 1999)
* [http://www.linuxgazette.com/issue58/washington.html AOLserver - a web development platform] by Irving Washington (Issue 58, Linux Gazette, October 2000)
* [http://www.linuxgazette.com/issue63/washington.html XML parsing in AOLserver] by Irving Washington (Issue 63, Linux Gazette, February 2001)
* [http://www.webdeveloper.pl/aolserver__1,293,1,1,pl.html AOLserver (1)] by [[Wojciech Kocjan]] (WEBdeveloper.pl, February 2002)
* [http://www.webdeveloper.pl/aolserver__2,294,1,1,pl.html AOLserver (2)] by [[Wojciech Kocjan]] (WEBdeveloper.pl, March 2002)
* [http://www.linuxjournal.com/article/6164 Introducing AOLserver] by Reuven Lerner (Issue 101, Linux Journal, August/September 2002)
* [http://www.serverwatch.com/sreviews/article.php/2232651 Does AOLserver Have What It Takes to Stand Out?] by Michael Hall (ServerWatch, July 2003)
* [http://www.internetnews.com/dev-news/article.php/3462701 AOL Updates Its Open Source Web Server] by Sean Michael Kerner (InternetNews.com, January 2005)
* [http://www.linux-magazine.es/issue/12/AOLServer.pdf AOLServer: Un servidor web avanzado y abierto] (PDF) by Pietro Zuco (Issue 12, Linux Magazine Spain, November 2005)
* [https://www.linux-magazine.es/issue/15/AOLServer.pdf AOLServer II - Programación TCL, SQL y ADP] (PDF) by Pietro Zuco (Issue 15, Linux Magazine Spain, February 2006)
* [http://www.linuxjournal.com/article/8986 Play Ball: Introducing Fungoes] by Mat Kovach (LinuxJournal.com, April 2006)

----

Just saving a funny joke that's really relevant to the work I do: [[see if it happens again]].

----

My current scratch pad or whiteboard contents:

Current idiom:

set lock [ns_mutex create lock]
ns_mutex lock $lock
catch {
# synchronized code here
}
ns_mutex unlock $lock

Proposed change:

set lock [ns_mutex create lock]
ns_mutex eval $lock $script

----

== Dossy's Blog ==

Here's the three most recent RSS entries from my blog. This is just testing out a MediaWiki 1.5 extension I'm working on:

<feed limit="3">http://dossy.org/index.xml</feed>

Dossy Shiobara

2007-01-03T19:50:47Z

Dossy: /* Articles */ add article from Linux Magazine Spain

: [mailto:dossy@panoptic.com]
: Location: US, NJ/NY/VA

[[Category:Person|Shiobara, Dossy]]

I run the [[AOLserver Wiki]] at [[Panoptic]]. If there are any problems with it, ''abuse me''.

My blog is at http://dossy.org/ aka [http://dossy.org/ Dossy's Blog] -- I try to post regularly (at least once a day, minimally once a week) and I often try to post about AOLserver-related matters.

----

My current AOLserver-related projects are to:

* Ensure we meet all our goals and milestones for the AOLserver Project according to the published 2004 [[Roadmap]].
* Start formalizing the testing/QA procedures and pre-release checklist that will go into every release: [[How are releases tested]]?
* [[nssic]] -- the Server Inter-Connect module

The following items are old and need to be updated:

* Stress-test and release version 0.6 of [[nsmysql]] (an internal database driver for MySQL)
* Write a configuration tool which will manage and generate nsd.tcl files
* Work on the [[AOLserver Packages]] - Binary distribution of AOLserver in the many popular package mangement formats like RedHat's RPM, Debian's .deb, FreeBSD's ports, Solaris's .pkg
* Write a server-side session management module, [[nssession]]
* Clean up version 0.1pre of [[nsfreetds]] (an internal database driver that connects to Microsoft SQL Server or Sybase using FreeTDS 0.51)

== Articles ==

I'm starting to collect articles written about AOLserver that are available on the web. Eventually, these will move to their own wiki page:

* [http://www.eveandersson.com/arsdigita/asj/aolserver/introduction-1 Introduction to AOLserver, Part 1] by Philip Greenspun (LinuxWorld.com, July 1999)
* [http://www.linuxgazette.com/issue58/washington.html AOLserver - a web development platform] by Irving Washington (Issue 58, Linux Gazette, October 2000)
* [http://www.linuxgazette.com/issue63/washington.html XML parsing in AOLserver] by Irving Washington (Issue 63, Linux Gazette, February 2001)
* [http://www.webdeveloper.pl/aolserver__1,293,1,1,pl.html AOLserver (1)] by [[Wojciech Kocjan]] (WEBdeveloper.pl, February 2002)
* [http://www.webdeveloper.pl/aolserver__2,294,1,1,pl.html AOLserver (2)] by [[Wojciech Kocjan]] (WEBdeveloper.pl, March 2002)
* [http://www.linuxjournal.com/article/6164 Introducing AOLserver] by Reuven Lerner (Issue 101, Linux Journal, August/September 2002)
* [http://www.serverwatch.com/sreviews/article.php/2232651 Does AOLserver Have What It Takes to Stand Out?] by Michael Hall (ServerWatch, July 2003)
* [http://www.internetnews.com/dev-news/article.php/3462701 AOL Updates Its Open Source Web Server] by Sean Michael Kerner (InternetNews.com, January 2005)
* [http://www.linux-magazine.es/issue/12/AOLServer.pdf AOLServer: Un servidor web avanzado y abierto] (PDF) by Pietro Zuco (Issue 12, Linux Magazine Spain, August 2005)
* [http://www.linuxjournal.com/article/8986 Play Ball: Introducing Fungoes] by Mat Kovach (LinuxJournal.com, April 2006)

----

Just saving a funny joke that's really relevant to the work I do: [[see if it happens again]].

----

My current scratch pad or whiteboard contents:

Current idiom:

set lock [ns_mutex create lock]
ns_mutex lock $lock
catch {
# synchronized code here
}
ns_mutex unlock $lock

Proposed change:

set lock [ns_mutex create lock]
ns_mutex eval $lock $script

----

== Dossy's Blog ==

Here's the three most recent RSS entries from my blog. This is just testing out a MediaWiki 1.5 extension I'm working on:

<feed limit="3">http://dossy.org/index.xml</feed>

User talk:Juanjose

2006-12-18T19:00:44Z

Dossy:

I am feeling so alone... ;) Please, tell me something! :D

: ''Looks like you're able to get on the wiki now. :-)'' -- [[User:Dossy|Dossy]] 14:00, 18 December 2006 (EST)

Frequently Asked Questions

2006-12-15T16:30:24Z

Dossy:

__NOTOC__

(Please add new questions at the very bottom of the list. Thanks.)

== What is AOLserver? ==

AOLserver is America Online's Open Source web server. AOLserver is the backbone of the largest and busiest production environments in the world.

AOLserver is a multithreaded, Tcl-enabled, massively-scalable and extensible web server tuned for large scale, dynamic web sites. AOLserver also includes complete database integration and a dynamic page scripting language.

== What is the latest version of AOLserver? ==

* The latest stable 3.4.x version is 3.4.2 released 18 September 2001.
* The latest stable 3.5.x version is 3.5.11 released 17 October 2003.
* The latest stable 4.0.x version is 4.0.10 released 18 January 2005.
* The latest stable 4.5.x version is 4.5.0 released 27 June 2006.
* Current development (CVS HEAD) is 4.5.0.

== Where can I get AOLserver? ==

The AOLserver project is hosted at [http://sourceforge.net/ SourceForge], and file releases are available for [[download]] in the [http://sourceforge.net/project/showfiles.php?group_id=3152 AOLserver Project Filelist].

== What platforms does AOLserver support? ==

'''AOLserver''' is known to compile and run on the following platforms:
* Linux 2.2 (i386), 2.4 and 2.6
* Windows 95/98/NT/2K/XP (i386) (partially supported, see #6)
* FreeBSD 3.4 (i386)
* OpenBSD 2.5 (i386)
* UnixWare 7.x (i386)
* DEC Tru64 & OSF/1 4.0 (alpha)
* Solaris 2.x (sparc), Solaris 2.10 (x86)
* HP/UX 10 & 11 (hppa)
* Irix 6.x (mips)
* Apple MacOS X 10.3 (ppc), 10.4 (ppc)

== How is AOLserver licensed and distributed? ==

Via the [[AOLserver Public License]], viewable at http://aolserver.com/license/.

== How does AOLserver performance compare to other major servers? ==

[[Brady Wetherington]] says: On Unix, AOLserver can generate many, many dynamic pages very quickly and reliably. It also has some special code paths designed to speed up processing of static pages (fastpath), though I don't use that very much, personally. Along with the database connection pools, it's definitely one of the highest-performance web-based database systems I've used.

== How is it different from Apache HTTP Server? ==

The current Apache HTTP Server
* is part of / a project of the Apache Software Foundation. The process of development and decision making is working for years and accepted by all participants
* allows to run applications in a process-pre-forking or multi-threaded environment by design
* is the leading webserver, so it is widely known, accepted and supported
* is itself a subproject accompanied by lots of well known other projects and frameworks (like Ant, Jakarta, Struts...)

In contrast AOLserver
* can do lots of use cases that are done with Apache modules with a few lines of TCL code (via registered filters and procs)
* is bound to its multi-threaded architecture that has its own disadvantages, depending on what you want to do

== How is it different from <insert other webserver>? ==

???

== Where is AOLserver appropriate? Where is it not? ==

It is not appropriate...
* when you want to do virtual hosting for multiple customers. For static content, AOLserver is fine - you're just serving static content. For dynamic, server-side functionality, to get the level of privilege separation necessary, you'd have to run a separate nsd per customer to ensure that one customer can't access the content/data of another's. There are apparently some folks out there who have set up AOLserver just this way and are doing just this.
* when the code you want to use is not thread-safe (and you are not able to change that)
* when your main application makes heavy use of cgi-tools or other scripting languages like PHP or Phython (in general: where currently no active dedicated maintainer for corresponding modules is known)
* when you need backup of a large world wide community that uses tools, modules and code you can find and read in every single computer magazine. AOLserver and TCL are niche products, which only means they are not sexy to the broad audience, but are used intensively by a sophisticated, intelligent minority
* when you know you would need more than one day to convince your customer to use it (in other words: if you use technology the first time don't let your most important customer be the beta tester)

It is appropriate...
* when you want to make maximum use of your machines hardware ressources: AOLserver is a highly configurable beast that allows you to run big websites
* when you plan to run a website that makes heavy use of one or more databases (using pooled connections)
* when you want to cache lots or all of your static files (.html,.gif,.css.,.js ...) in your servers memory (via modules fastpath and nscache)
* when you like the good feeling of running and coding your apps on a well-tested multi-threaded server architecture. The server never has been a process-forking one.

The idea here is if you know your requirements and your scope is fairly stable and you feel comfortable you can predict the future, and if all signs point to the app. remaining small-to-medium in usage/traffic, then pick whatever platform or technology you like the best -- it really won't make a difference. But, if you think that it's a very real possibility you'll need
to scale up capacity to meet growing demand/traffic, possibly indefinitely, then yes, the hidden cost of re-architecting or migrating to a different technology can be a killer when you have to use the words "sunk cost" to describe the originally developed system. In that case, you may be better off starting with implementing with AOLserver, as its performance "ceiling" so to speak is higher than other technologies. (TODO: Benchmarks demonstrating this empirically?)

== How do I get started with AOLserver? ==

<need to link to a newbie guide HOWTO>

== How can I learn more about AOLserver? ==

Start by reading the [[Documentation]], which is still a work-in-progress.

== "package require" doesn't work! What's wrong? ==

Here's the relevant portion of a message [[Dossy Shiobara]] sent to the AOLserver mailing list back on 16 June 2000:

set tcl_library [file join $tcl_pkgPath tcl${tcl_version}]
source [file join $tcl_library init.tcl]

package require works like a charm after that :-)

There you have it. Perhaps, some day, this won't be a necessary step. But, in the meantime ...

''As of AOLserver 4.0 and perhaps even a late version of 3.5.x, this step is no longer necessary.''

== "ns_set update [ns_conn outputheaders] Content-Type" results in the server sending two copies of the Content-Type header. Why? ==

"ns_set update [ns_conn outputheaders $conn] Content-Type {application/x-tcl}" does not work in .adp files as I wish. The server always returns two copies of the Content-Type header, one as application/x-tcl, another as text/html and clients(galeon, tcl http package) always use the second. How do I remove the second Content-Type?'''

Good question -- this is really a bug that needs to be fixed in the server code itself.

== How can I get Tclet scripts served from AOLserver to run inside the Tcl Plugin? ==

Someone asks: ''I have an aolserver for OpenACS. I installed Tcl Plugin which works well with classic Tclets on Tcl Plugin Home Pages. But with Aolserver, it doesn't work.... Do you know the answer of this?''

== How can I compile AOLserver on HP-UX, both 10.20 and 11.x? ==

[[Dossy]]: Good question. If I had easy access to HP-UX machines, I'd try it myself. AOLserver 4.x should hopefully build on HP-UX without any changes, but I'm only guessing.

HPUX doesn't implement a lot of BSD/POSIX IPC functions, or so I hear.

== I'm getting an error compiling AOLserver about POLLIN, POLLOUT and POLLPRI being redefined. What's wrong? ==

AOLserver requires that the "configure" script be run using the GNU C (gcc) compiler. Try running the configure script like this:

$ CC=gcc ./configure --args...

== Does AOLserver support HTTP Keep-Alive? I'm sending a HTTP/1.1 request via httperf and AOLserver isn't doing Keep-Alive like Apache does! What's wrong? ==

Actually, nothing is wrong. You just need to tell httperf to include the headers that tell AOLserver to expect multiple requests per connection. Add '--add_header "Connection: Keep-Alive\n"' to your httperf request.

The issue is that Apache and AOLserver chose opposite default behaviors when interpretting [http://www.ietf.org/rfc/rfc2068.txt RFC 2068 section 8.1.2.1]:

An HTTP/1.1 server MAY assume that a HTTP/1.1 client intends to
maintain a persistent connection unless a Connection header including
the connection-token "close" was sent in the request. If the server
chooses to close the connection immediately after sending the
response, it SHOULD send a Connection header including the
connection-token close.

An HTTP/1.1 client MAY expect a connection to remain open, but would
decide to keep it open based on whether the response from a server
contains a Connection header with the connection-token close. In case
the client does not want to maintain a connection for more than that
request, it SHOULD send a Connection header including the
connection-token close.

The key here is "MAY" -- AOLserver (currently, as of 4.0.10) chooses not to assume a Keep-Alive connection unless the client explicitly requests it by sending "Connection: Keep-Alive" in the HTTP request header. This may change in the future (HTTP/1.1 requests default to Keep-Alive unless the client explicitly sends "Connection: close" -- apparently this is how Apache works).

== AOLserver 4.0.10 is consuming all my memory ==

[http://www.mail-archive.com/aolserver%40listserv.aol.com/msg09104.html Bas Scheffers says]: What version of Tcl did you use? Use 8.4.11 or 8.4.6, but nothing in between as they have a big memory leak.

Note that debian sarge includes tcl 8.4.9 (as of 2006-01-03).

== How do I customize standard HTTP responses? ==

<pre>
#
# Internal redirects
#
ns_section "ns/server/${servername}/redirects"
ns_param 404 "/notfound.html" ;# Not Found error page
ns_param 500 "/servererror.html" ;# Server Error page
</pre>

[[Category:Documentation]]

FAQ

2006-12-15T16:30:13Z

Dossy: FAQ moved to Frequently Asked Questions

#redirect [[Frequently Asked Questions]]

Frequently Asked Questions

2006-12-15T16:30:13Z

Dossy: FAQ moved to Frequently Asked Questions

__NOTOC__

= Frequently Asked Questions =

(Please add new questions at the very bottom of the list. Thanks.)

== What is AOLserver? ==

AOLserver is America Online's Open Source web server. AOLserver is the backbone of the largest and busiest production environments in the world.

AOLserver is a multithreaded, Tcl-enabled, massively-scalable and extensible web server tuned for large scale, dynamic web sites. AOLserver also includes complete database integration and a dynamic page scripting language.

== What is the latest version of AOLserver? ==

* The latest stable 3.4.x version is 3.4.2 released 18 September 2001.
* The latest stable 3.5.x version is 3.5.11 released 17 October 2003.
* The latest stable 4.0.x version is 4.0.10 released 18 January 2005.
* The latest stable 4.5.x version is 4.5.0 released 27 June 2006.
* Current development (CVS HEAD) is 4.5.0.

== Where can I get AOLserver? ==

The AOLserver project is hosted at [http://sourceforge.net/ SourceForge], and file releases are available for [[download]] in the [http://sourceforge.net/project/showfiles.php?group_id=3152 AOLserver Project Filelist].

== What platforms does AOLserver support? ==

'''AOLserver''' is known to compile and run on the following platforms:
* Linux 2.2 (i386), 2.4 and 2.6
* Windows 95/98/NT/2K/XP (i386) (partially supported, see #6)
* FreeBSD 3.4 (i386)
* OpenBSD 2.5 (i386)
* UnixWare 7.x (i386)
* DEC Tru64 & OSF/1 4.0 (alpha)
* Solaris 2.x (sparc), Solaris 2.10 (x86)
* HP/UX 10 & 11 (hppa)
* Irix 6.x (mips)
* Apple MacOS X 10.3 (ppc), 10.4 (ppc)

== How is AOLserver licensed and distributed? ==

Via the [[AOLserver Public License]], viewable at http://aolserver.com/license/.

== How does AOLserver performance compare to other major servers? ==

[[Brady Wetherington]] says: On Unix, AOLserver can generate many, many dynamic pages very quickly and reliably. It also has some special code paths designed to speed up processing of static pages (fastpath), though I don't use that very much, personally. Along with the database connection pools, it's definitely one of the highest-performance web-based database systems I've used.

== How is it different from Apache HTTP Server? ==

The current Apache HTTP Server
* is part of / a project of the Apache Software Foundation. The process of development and decision making is working for years and accepted by all participants
* allows to run applications in a process-pre-forking or multi-threaded environment by design
* is the leading webserver, so it is widely known, accepted and supported
* is itself a subproject accompanied by lots of well known other projects and frameworks (like Ant, Jakarta, Struts...)

In contrast AOLserver
* can do lots of use cases that are done with Apache modules with a few lines of TCL code (via registered filters and procs)
* is bound to its multi-threaded architecture that has its own disadvantages, depending on what you want to do

== How is it different from <insert other webserver>? ==

???

== Where is AOLserver appropriate? Where is it not? ==

It is not appropriate...
* when you want to do virtual hosting for multiple customers. For static content, AOLserver is fine - you're just serving static content. For dynamic, server-side functionality, to get the level of privilege separation necessary, you'd have to run a separate nsd per customer to ensure that one customer can't access the content/data of another's. There are apparently some folks out there who have set up AOLserver just this way and are doing just this.
* when the code you want to use is not thread-safe (and you are not able to change that)
* when your main application makes heavy use of cgi-tools or other scripting languages like PHP or Phython (in general: where currently no active dedicated maintainer for corresponding modules is known)
* when you need backup of a large world wide community that uses tools, modules and code you can find and read in every single computer magazine. AOLserver and TCL are niche products, which only means they are not sexy to the broad audience, but are used intensively by a sophisticated, intelligent minority
* when you know you would need more than one day to convince your customer to use it (in other words: if you use technology the first time don't let your most important customer be the beta tester)

It is appropriate...
* when you want to make maximum use of your machines hardware ressources: AOLserver is a highly configurable beast that allows you to run big websites
* when you plan to run a website that makes heavy use of one or more databases (using pooled connections)
* when you want to cache lots or all of your static files (.html,.gif,.css.,.js ...) in your servers memory (via modules fastpath and nscache)
* when you like the good feeling of running and coding your apps on a well-tested multi-threaded server architecture. The server never has been a process-forking one.

The idea here is if you know your requirements and your scope is fairly stable and you feel comfortable you can predict the future, and if all signs point to the app. remaining small-to-medium in usage/traffic, then pick whatever platform or technology you like the best -- it really won't make a difference. But, if you think that it's a very real possibility you'll need
to scale up capacity to meet growing demand/traffic, possibly indefinitely, then yes, the hidden cost of re-architecting or migrating to a different technology can be a killer when you have to use the words "sunk cost" to describe the originally developed system. In that case, you may be better off starting with implementing with AOLserver, as its performance "ceiling" so to speak is higher than other technologies. (TODO: Benchmarks demonstrating this empirically?)

== How do I get started with AOLserver? ==

<need to link to a newbie guide HOWTO>

== How can I learn more about AOLserver? ==

Start by reading the [[Documentation]], which is still a work-in-progress.

== "package require" doesn't work! What's wrong? ==

Here's the relevant portion of a message [[Dossy Shiobara]] sent to the AOLserver mailing list back on 16 June 2000:

set tcl_library [file join $tcl_pkgPath tcl${tcl_version}]
source [file join $tcl_library init.tcl]

package require works like a charm after that :-)

There you have it. Perhaps, some day, this won't be a necessary step. But, in the meantime ...

''As of AOLserver 4.0 and perhaps even a late version of 3.5.x, this step is no longer necessary.''

== "ns_set update [ns_conn outputheaders] Content-Type" results in the server sending two copies of the Content-Type header. Why? ==

"ns_set update [ns_conn outputheaders $conn] Content-Type {application/x-tcl}" does not work in .adp files as I wish. The server always returns two copies of the Content-Type header, one as application/x-tcl, another as text/html and clients(galeon, tcl http package) always use the second. How do I remove the second Content-Type?'''

Good question -- this is really a bug that needs to be fixed in the server code itself.

== How can I get Tclet scripts served from AOLserver to run inside the Tcl Plugin? ==

Someone asks: ''I have an aolserver for OpenACS. I installed Tcl Plugin which works well with classic Tclets on Tcl Plugin Home Pages. But with Aolserver, it doesn't work.... Do you know the answer of this?''

== How can I compile AOLserver on HP-UX, both 10.20 and 11.x? ==

[[Dossy]]: Good question. If I had easy access to HP-UX machines, I'd try it myself. AOLserver 4.x should hopefully build on HP-UX without any changes, but I'm only guessing.

HPUX doesn't implement a lot of BSD/POSIX IPC functions, or so I hear.

== I'm getting an error compiling AOLserver about POLLIN, POLLOUT and POLLPRI being redefined. What's wrong? ==

AOLserver requires that the "configure" script be run using the GNU C (gcc) compiler. Try running the configure script like this:

$ CC=gcc ./configure --args...

== Does AOLserver support HTTP Keep-Alive? I'm sending a HTTP/1.1 request via httperf and AOLserver isn't doing Keep-Alive like Apache does! What's wrong? ==

Actually, nothing is wrong. You just need to tell httperf to include the headers that tell AOLserver to expect multiple requests per connection. Add '--add_header "Connection: Keep-Alive\n"' to your httperf request.

The issue is that Apache and AOLserver chose opposite default behaviors when interpretting [http://www.ietf.org/rfc/rfc2068.txt RFC 2068 section 8.1.2.1]:

An HTTP/1.1 server MAY assume that a HTTP/1.1 client intends to
maintain a persistent connection unless a Connection header including
the connection-token "close" was sent in the request. If the server
chooses to close the connection immediately after sending the
response, it SHOULD send a Connection header including the
connection-token close.

An HTTP/1.1 client MAY expect a connection to remain open, but would
decide to keep it open based on whether the response from a server
contains a Connection header with the connection-token close. In case
the client does not want to maintain a connection for more than that
request, it SHOULD send a Connection header including the
connection-token close.

The key here is "MAY" -- AOLserver (currently, as of 4.0.10) chooses not to assume a Keep-Alive connection unless the client explicitly requests it by sending "Connection: Keep-Alive" in the HTTP request header. This may change in the future (HTTP/1.1 requests default to Keep-Alive unless the client explicitly sends "Connection: close" -- apparently this is how Apache works).

== AOLserver 4.0.10 is consuming all my memory ==

[http://www.mail-archive.com/aolserver%40listserv.aol.com/msg09104.html Bas Scheffers says]: What version of Tcl did you use? Use 8.4.11 or 8.4.6, but nothing in between as they have a big memory leak.

Note that debian sarge includes tcl 8.4.9 (as of 2006-01-03).

== How do I customize standard HTTP responses? ==

<pre>
#
# Internal redirects
#
ns_section "ns/server/${servername}/redirects"
ns_param 404 "/notfound.html" ;# Not Found error page
ns_param 500 "/servererror.html" ;# Server Error page
</pre>

[[Category:Documentation]]

Frequently Asked Questions

2006-12-15T16:29:53Z

Dossy:

Talk:Ns stats

2006-11-07T12:56:30Z

Dossy:

The link at the top of the page doesn't point to anything.

The rendering of the example at the bottom is broken; the source appears good, but the rendering is flawed.

: ''Actually, the source formatting was messed up--this was another victim of the WiKit-to-MediaWiki switch. I've updated the formatting--give it another shot and let me know if it's still wrong.'' -- [[User:Dossy|Dossy]] 07:56, 7 November 2006 (EST)

Ns stats

2006-11-07T12:55:26Z

Dossy:

Man page: http://aolserver.com/docs/tcl/ns_stats.html

----

'''NAME'''

ns_stats - Return command stats information

'''SYNOPSIS'''

'''ns_stats''' ''?option? ?pattern?''

'''DESCRIPTION'''

This command returns proc call stats for procs which match the glob ''pattern''. Results are sorted based on ''option'' which can be one of the following:
* '''-count''': results are sorted by count in descending order (default)
* '''-name''': results are sorted by proc name in ascending order

In order to instruct AOLserver to keep these stats, you must define two settings in your nsd.tcl, in section ns/server/${server_name}/tcl:

ns_section ns/server/${server_name}/tcl
ns_param statlevel x
ns_param statmaxbuf y

Stats will be collected if statlevel is greater than 0. It gets passed to Tcl_CreateTrace() like so:

Tcl_CreateTrace(interp, nsconf.tcl.statlevel, StatsTrace, NULL);

If statsmaxbuf is less than or equal to zero, there will be no stats buffer and the global table will be updated directly, according to the comment:

236 /*
237 * If buffering is not enabled, update the global table directly
238 * (this could be a source of lock contention). Otherwise, update
239 * this thread's table, flushing if the buffer limit is exceeded.
240 */

Otherwise, statmaxbuf specifies the number of entries in the stats buffer hash table.

This is all documented from AOLserver 3.4.2, nsd/tclstats.c.

'''EXAMPLES'''

Here is a sample ns_stats.adp to use to display the output of ns_stats:

<xmp>
<%
ns_adp_puts [format "%-60s %s" command {times invoked}]
ns_adp_puts "[string repeat = 60] [string repeat = 13]"
foreach {key value} [ns_stats] {
ns_adp_puts [format "%-60s %lu" $key $value]
}
%>
</xmp>

'''SEE ALSO'''

----

[[Category:Documentation]]
[[Category:Core Tcl API]]

Ns http

2006-09-09T20:10:26Z

Dossy: fix wikitext for code examples

<manpage>ns_http</manpage>

'''NAME'''

: ns_http - Simple HTTP client functionality

'''SYNOPSIS'''

: '''ns_http''' ''option ?arg arg ...?''

'''DESCRIPTION'''

: This command provides a simple HTTP client mechanism.

: The legal ''option''s (which may be abbreviated) are:
:* '''ns_http cancel''' ''id''
:* '''ns_http cleanup'''
:* '''ns_http queue''' ''method url ?body? ?headers?''

: ''body'' is the value which will be sent as the HTTP request body. ''headers'' is the [[ns_set]] ID containing the additional headers to include in the HTTP request.
:* '''ns_http wait''' ''id resultsVar ?timeout? ?headers? ?-servicetime svcTime?''

: ''resultsVar'' is the name of a variable that should be used to store the HTTP response body. Default ''timeout'' is "2:0" (2s, 0usec). ''headers'' is the [[ns_set]] ID which will receive the headers from the HTTP response.

'''EXAMPLES'''

Valid HTTP GET:

<pre>
% set id [ns_http queue GET http://aolserver.com/]
http0
% set status [ns_http wait $id results]
1
% string range $results 0 60
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN
</pre>

Timed out HTTP GET:

<pre>
% set id [ns_http queue GET http://aolserver.com:12345/]
http0
% set status [ns_http wait $id results 0]
0
% set results
timeout
</pre>

Bogus HTTP GET:

<pre>
% catch {ns_http queue GET http://nonexistant.domain/} err
1
% set err
could not connect to : http://nonexistant.domain/
</pre>

'''SEE ALSO'''

: [[ns_httpopen]]

[[Category:Core Tcl API]]

Downloads

2006-09-05T21:10:43Z

Dossy: add aolserver_v45_bp branch tarball snapshot link

Looking to download AOLserver related files and resources? Here's a list of what's available:

* [http://sourceforge.net/project/showfiles.php?group_id=3152 AOLserver Files at SourceForge]
* Latest 4.0.x release, 4.0.10: [http://aolserver.com/downloads/aolserver-4.0.10-src.tar.gz aolserver-4.0.10-src.tar.gz]
* Latest 4.5.x release, 4.5.0: [http://aolserver.com/downloads/aolserver-4.5.0-src.tar.gz aolserver-4.5.0-src.tar.gz]

Nightly CVS snapshots, refreshed daily at 01:00 AM US/Pacific time (as long as SourceForge is working):

* AOLserver HEAD: [http://aolserver.com/files/aolserver-HEAD-src.tar.gz aolserver-HEAD-src.tar.gz]
* AOLserver aolserver_v40_bp branch: [http://aolserver.com/files/aolserver-aolserver_v40_bp-src.tar.gz aolserver-aolserver_v40_bp-src.tar.gz]
* AOLserver aolserver_v45_bp branch: [http://aolserver.com/files/aolserver-aolserver_v45_bp-src.tar.gz aolserver-aolserver_v45_bp-src.tar.gz]
* nsopenssl HEAD: [http://aolserver.com/files/nsopenssl-HEAD-src.tar.gz nsopenssl-HEAD-src.tar.gz]

== "Batteries Included" binary distributions ==

If a "[[Batteries Included]]" binary distribution of AOLserver were to be made available, downloads for it would be available here.

== AOLserver on Win32 ==

These binary releases are unsupported and considered alpha-quality at best. Use them at your own risk, but if you do find any issues, please file a [http://sourceforge.net/tracker/?group_id=3152&atid=103152 bug report]. Thanks!

* [http://aolserver.com/downloads/aolserver-4.1.0a-win32-20040821.zip AOLserver 4.1.0a (built 20040821) and Tcl 8.4.6 for Win32]
* [http://aolserver.com/downloads/aolserver-4.0.7-win32.zip AOLserver 4.0.7 and Tcl 8.4.6 for Win32]

If you want to build your own binaries for Win32, you should read [[How to build AOLserver on Win32]].

Downloads

2006-09-05T21:10:11Z

Dossy: add 4.5.0 download tarball link

Looking to download AOLserver related files and resources? Here's a list of what's available:

* [http://sourceforge.net/project/showfiles.php?group_id=3152 AOLserver Files at SourceForge]
* Latest 4.0.x release, 4.0.10: [http://aolserver.com/downloads/aolserver-4.0.10-src.tar.gz aolserver-4.0.10-src.tar.gz]
* Latest 4.5.x release, 4.5.0: [http://aolserver.com/downloads/aolserver-4.5.0-src.tar.gz aolserver-4.5.0-src.tar.gz]

Nightly CVS snapshots, refreshed daily at 01:00 AM US/Pacific time (as long as SourceForge is working):

* AOLserver HEAD: [http://aolserver.com/files/aolserver-HEAD-src.tar.gz aolserver-HEAD-src.tar.gz]
* AOLserver aolserver_v40_bp branch: [http://aolserver.com/files/aolserver-aolserver_v40_bp-src.tar.gz aolserver-aolserver_v40_bp-src.tar.gz]
* nsopenssl HEAD: [http://aolserver.com/files/nsopenssl-HEAD-src.tar.gz nsopenssl-HEAD-src.tar.gz]

== "Batteries Included" binary distributions ==

If a "[[Batteries Included]]" binary distribution of AOLserver were to be made available, downloads for it would be available here.

== AOLserver on Win32 ==

These binary releases are unsupported and considered alpha-quality at best. Use them at your own risk, but if you do find any issues, please file a [http://sourceforge.net/tracker/?group_id=3152&atid=103152 bug report]. Thanks!

* [http://aolserver.com/downloads/aolserver-4.1.0a-win32-20040821.zip AOLserver 4.1.0a (built 20040821) and Tcl 8.4.6 for Win32]
* [http://aolserver.com/downloads/aolserver-4.0.7-win32.zip AOLserver 4.0.7 and Tcl 8.4.6 for Win32]

If you want to build your own binaries for Win32, you should read [[How to build AOLserver on Win32]].

Nsv incr

2006-06-27T14:44:30Z

Dossy:

Man page: http://aolserver.com/docs/tcl/nsv_incr.html

----

'''NAME'''

: nsv_incr - Increment the value of the element in the nsv array ''arrayName'' specified by ''key''

'''SYNOPSIS'''

: '''nsv_incr''' ''arrayName'' ''key'' ''?increment?''

'''DESCRIPTION'''

: If ''increment'' is supplied then its value (which must be an integer) is added to the value of the element ''key''; otherwise 1 is added to the value of the element ''key''. Unlike the TCL equivalent if ''key'' does not exists it is created. Returns the new value of the element specified by ''key''. Internally interlocked so it is thread safe, no mutex required.

'''EXAMPLES'''

% nsv_incr shared_array foo
1
% nsv_incr shared_array foo -1
0

Is this a good implementation with behavior similar to using ns_mutex or ns_critsec, except that later threads do not wait for the first thread to exit the script?

: ''What you're looking for is a kind of "ns_mutex trylock" type of functionality, where if the mutex is locked the caller doesn't block/sleep, but if it's unlocked, the caller locks the mutex. Interesting approach using NSVs, sure!'' -- [[User:Dossy|Dossy]] 10:44, 27 June 2006 (EDT)

# Return value 1 indicates that the call was executed normally
# Return value 0 indicates that another thread was executing
# the code so this thread was excluded

proc write_special_file {data} {
if {[nsv_incr one_thread_at_a_time $key] == 1} {
set had_error [catch {
set handle [open special_file w]
puts $handle $data
close $handle
} message]
nsv_set one_thread_at_a_time $key 0
if {$had_error} {
error $message
}
return 1
} else {
return 0
}
}

proc read_special_file {result_varname} {
if {[nsv_incr one_thread_at_a_time $key] == 1} {
upvar $result_varname result
set had_error [catch {
set handle [open special_file r]
set result [read $handle]
close $handle
} message]
nsv_set one_thread_at_a_time $key 0
if {$had_error} {
error $message
}
return 1
} else {
return 0
}
}

proc change_special_file {data result_varname} {
if {[nsv_incr one_thread_at_a_time $key] == 1} {
upvar $result_varname result
# BOTH READ AND WRITE CALLS WILL DO NOTHING
read_special_file result
write_special_file $data
nsv_set one_thread_at_a_time $key 0
return 1
} else {
return 0
}
}

'''SEE ALSO'''

: [[Thread-shared Variables]]

[[Category:Documentation]]
[[Category:Core Tcl API]]

Dossy Shiobara

2006-05-24T14:48:59Z

Dossy:

: [mailto:dossy@panoptic.com]
: Location: US, NJ/NY/VA

[[Category:Person|Shiobara, Dossy]]

I run the [[AOLserver Wiki]] at [[Panoptic]]. If there are any problems with it, ''abuse me''.

My blog is at http://dossy.org/ aka [http://dossy.org/ Dossy's Blog] -- I try to post regularly (at least once a day, minimally once a week) and I often try to post about AOLserver-related matters.

----

My current AOLserver-related projects are to:

* Ensure we meet all our goals and milestones for the AOLserver Project according to the published 2004 [[Roadmap]].
* Start formalizing the testing/QA procedures and pre-release checklist that will go into every release: [[How are releases tested]]?
* [[nssic]] -- the Server Inter-Connect module

The following items are old and need to be updated:

* Stress-test and release version 0.6 of [[nsmysql]] (an internal database driver for MySQL)
* Write a configuration tool which will manage and generate nsd.tcl files
* Work on the [[AOLserver Packages]] - Binary distribution of AOLserver in the many popular package mangement formats like RedHat's RPM, Debian's .deb, FreeBSD's ports, Solaris's .pkg
* Write a server-side session management module, [[nssession]]
* Clean up version 0.1pre of [[nsfreetds]] (an internal database driver that connects to Microsoft SQL Server or Sybase using FreeTDS 0.51)

== Articles ==

I'm starting to collect articles written about AOLserver that are available on the web. Eventually, these will move to their own wiki page:

* [http://www.eveandersson.com/arsdigita/asj/aolserver/introduction-1 Introduction to AOLserver, Part 1] by Philip Greenspun (LinuxWorld.com, July 1999)
* [http://www.linuxgazette.com/issue58/washington.html AOLserver - a web development platform] by Irving Washington (Issue 58, Linux Gazette, October 2000)
* [http://www.linuxgazette.com/issue63/washington.html XML parsing in AOLserver] by Irving Washington (Issue 63, Linux Gazette, February 2001)
* [http://www.webdeveloper.pl/aolserver__1,293,1,1,pl.html AOLserver (1)] by [[Wojciech Kocjan]] (WEBdeveloper.pl, February 2002)
* [http://www.webdeveloper.pl/aolserver__2,294,1,1,pl.html AOLserver (2)] by [[Wojciech Kocjan]] (WEBdeveloper.pl, March 2002)
* [http://www.linuxjournal.com/article/6164 Introducing AOLserver] by Reuven Lerner (Issue 101, Linux Journal, August/September 2002)
* [http://www.serverwatch.com/sreviews/article.php/2232651 Does AOLserver Have What It Takes to Stand Out?] by Michael Hall (ServerWatch, July 2003)
* [http://www.internetnews.com/dev-news/article.php/3462701 AOL Updates Its Open Source Web Server] by Sean Michael Kerner (InternetNews.com, January 2005)
* [http://www.linuxjournal.com/article/8986 Play Ball: Introducing Fungoes] by Mat Kovach (LinuxJournal.com, April 2006)

----

Just saving a funny joke that's really relevant to the work I do: [[see if it happens again]].

----

My current scratch pad or whiteboard contents:

Current idiom:

set lock [ns_mutex create lock]
ns_mutex lock $lock
catch {
# synchronized code here
}
ns_mutex unlock $lock

Proposed change:

set lock [ns_mutex create lock]
ns_mutex eval $lock $script

----

== Dossy's Blog ==

Here's the three most recent RSS entries from my blog. This is just testing out a MediaWiki 1.5 extension I'm working on:

<feed limit="3">http://dossy.org/index.xml</feed>

Ns return

2006-04-19T20:20:30Z

Dossy: formatting tweaks

<manpage>ns_return</manpage>

== NAME ==

ns_connsendfp, ns_respond, ns_return, ns_returnadminnotice, ns_returnbadrequest, ns_returnerror, ns_returnfile, ns_returnforbidden, ns_returnfp, ns_returnnotfound, ns_returnnotice, ns_returnredirect, ns_returnunauthorized, ns_write - commands

== SYNOPSIS ==

: '''[[ns_connsendfp]]''' ''fp len''
: '''[[ns_respond]]'''
: '''ns_return''' ''status type string''
: '''[[ns_returnadminnotice]]''' ''status msg ?longmsg?''
: '''[[ns_returnbadrequest]]''' ''reason''
: '''[[ns_returnerror]]''' ''status msg''
: '''[[ns_returnfile]]''' ''status type filename''
: '''[[ns_returnforbidden]]'''
: '''[[ns_returnfp]]''' ''status type fileid len''
: '''[[ns_returnnotfound]]'''
: '''[[ns_returnnotice]]''' ''status msg ?longmsg?''
: '''[[ns_returnredirect]]''' ''location''
: '''[[ns_returnunauthorized]]'''
: '''[[ns_write]]''' ''string''

== DESCRIPTION ==

These procedures provide a simple interface for returning information to the client. They build HTTP/1.0 headers and send the appropriate data out the socket to the client. The script does not end at the time ns_return* is invoked so you can continue processing data after the client has gotten the data and closed the socket.

''type'' should be a MIME type (see [[ns_guesstype]] for a list). ''status'' is a three-digit number fitting the pattern below:

: 1xx Informational - Not used, but reserved for future use.
: 2xx Success - The action was successfully received, understood, and accepted.
: 3xx Redirection - Further action must be taken in order to complete the request.
: 4xx Client Error - The request contains bad syntax or cannot be fulfilled.
: 5xx Server Error - The server failed to fulfill an apparently valid request.

Some common status values and their meanings are:

: 201 Created
: 202 Accepted
: 203 Provisional Information
: 204 No Content
: 300 Multiple Choices
: 301 Moved Permanently
: 302 Moved Temporarily
: 303 Method
: 304 Not Modified
: 401 Unauthorized
: 402 Payment Required
: 403 Forbidden
: 404 Not Found
: 405 Method Not Allowed
: 406 None Acceptable
: 407 Proxy Authentication Required
: 408 Request Time-out
: 409 Conflict
: 410 Gone
: 501 Not Implemented
: 502 Bad Gateway
: 503 Service Unavailable
: 504 Gateway Time-out

; ns_connsendfp
: This function writes len bytes of the specified channel or file to the conn.

; ns_return
: Sends back both the headers and the string.

; ns_returnadminnotice
: Wraps the text msg and longmsg in some html, appends a line with a link to "mailto:serveradministrator" based on the virtual server parameter "WebMaster".

; ns_returnbadrequest
: Returns a 400 status code and a formatted HTML message containing the reason text.

; ns_returnerror
: Wraps the text msg in some html and returns that to the client.

; ns_returnfile
: Sends back the headers and the contents of the file.

; ns_returnforbidden
: Returns a 403 status code.

; ns_returnfp
: First sends the appropriate headers. Next, it writes out the contents of file from the current file position until the end of the file.

; ns_returnnotfound
: Returns a 404 status code.

; ns_returnnotice
: Wraps the text msg and longmsg in some html and returns that to the client.

; ns_returnredirect
: Returns a redirect to the passed in location

; ns_returnunauthorized
: Returns a 401 status code

; ns_write
: Writes the string out the connection. You can use it instead of the ns_return or ns_respond functions to build HTTP responses. AOLserver will not include the usual headers on the output data. The script does not end at the time ns_write* is invoked so you can continue processing data after the client has gotten the data and closed the socket.

== SEE ALSO ==

: [[ns_connsendfp]], [[ns_respond]], [[ns_returnadminnotice]], [[ns_returnbadrequest]], [[ns_returnerror]], [[ns_returnfile]], [[ns_returnforbidden]], [[ns_returnfp]], [[ns_returnnotfound]], [[ns_returnnotice]], [[ns_returnredirect]], [[ns_returnunauthorized]], [[ns_write]]

__NOTOC__
[[Category:Documentation]]
[[Category:Core Tcl API]]

Talk:AOLserver Wiki

2006-03-30T06:14:54Z

Dossy:

== Anonymous edits disabled ==

I've gone ahead and disabled anonymous edits due to the high volume of wiki spamming. I'll be implementing some kind of anti-spam measures (most likely a CAPTCHA) before turning anonymous edits back on. I hate to do this, but it's starting to get out of control. -- [[User:Dossy|Dossy]] 08:11, 24 March 2006 (EST)

Since I know the spammers can create accounts (I just deleted ~600 of them), I've changed things so that only users who have a confirmed email address can make edits. You can set your email address via [[Special:Preferences]] then confirm it with [[Special:Confirmemail]]. -- [[User:Dossy|Dossy]] 08:29, 24 March 2006 (EST)

I agree with your decision Dossy. The spam was out of control. [[User:Vkurup|Vkurup]] 20:22, 29 March 2006 (EST)

* Thanks, Vinod. I especially appreciate your vigilance in rolling back the edits. Now, how do we encourage actual contributors to make changes to the wiki ... :-) -- [[User:Dossy|Dossy]] 01:14, 30 March 2006 (EST)

AOLserver Wiki:Protected page

2006-03-28T15:50:11Z

Dossy:

== Anonymous edits disabled ==

I've gone ahead and disabled anonymous edits due to the high volume of wiki spamming. I'll be implementing some kind of anti-spam measures (most likely a CAPTCHA) before turning anonymous edits back on. I hate to do this, but it's starting to get out of control. -- [[User:Dossy|Dossy]] 08:11, 24 March 2006 (EST)

Since I know the spammers can create accounts (I just deleted ~600 of them), I've changed things so that only users who have a confirmed email address can make edits. You can set your email address via [[Special:Preferences]] then confirm it with [[Special:Confirmemail]]. -- [[User:Dossy|Dossy]] 08:29, 24 March 2006 (EST)

I've now implemented a CAPTCHA in order to log in or create a new account. This should effectively end the spam. When I can, I'll add the CAPTCHA to the editing page, so that anonymous edits can be turned back on, but I don't know when I'll have the time to do that. -- [[User:Dossy|Dossy]] 10:50, 28 March 2006 (EST)

AOLserver Wiki:Protected page

2006-03-24T13:30:15Z

Dossy:

Talk:AOLserver Wiki

2006-03-24T13:29:12Z

Dossy:

Ad13 vs. 3.5.1

2006-03-24T13:17:54Z

Dossy: Reverted edit of 69.31.41.50, changed back to last version by Vkurup

This is an unfinished comparison between AOLserver 3.5.1 and AOLserver 3.3.1 + ad13 + oacs1. [http://uptime.openacs.org/aolserver-openacs/] It is based on Rob Mayoff's AD13 distribution notes. SourceForge patch #570072 brought the AD13 internationalization patches to 3.4.2, and would probably be a good starting point for integration.

- Jamie Rasmussen

----------------------------------------
'''+oacs1 patches'''

Vinod's ns_uuencode patch (SourceForge #474259)
* The oacs1 patch has a major bug as discussed on SourceForge. I believe my corrected patch works but it hasn't been tested. This is not crucial because OpenACS tests for the desired behavior and falls back on (slow) TCL-based encoding.

uid/gid from Jon Griffin
* This is SF Patch #509413. Jon confirms it has been fixed in 3.5+.

BSD exec patch
* Is this SF Patch #415475? It's marked fixed.

Merge some of Vinod's and Mat's changes for nsxml's makefile
* nsxml has changed since the oacs1 version so I'm not sure if these changes are needed.

----------------------------------------
'''+ad13 patches'''

Numerous patches to support character encodings including Henry Minsky's patches to translate form data to multiple charsets within a single HTTP request. Described in encoding-doc.html. These should be fleshed out here.

There is an additional encoding file, 8bit.enc (ascii, single-byte, 8 bits)
* Should this be added to TCL?

Set system encoding to ns/server/$server/SystemEncoding (default utf-8) in modules/tcl/init.tcl.
* This is a 1 line change

form.tcl and http.tcl are different, charsets.tcl needs to be added

Added byte range support in fastpath.c and ns_returnfile.
* This is a HTTP/1.1 feature. Patrick Spence asks if this could be made configurable to prevent abuse by download accelerators.

Reset ADP exception before executing an ADP, in case previous ADP called ns_adp_break, etc.
* One-line changes in adp.c and tclstubs.cpp to reset the exception
* There are also stack checks throwing ADP_OVERFLOW. The stack check function was in thread.c of the old threads lib, and is not in AOLserver 3.5.1 ADP_OVERFLOW is still caught in 3.5.1, but it doesn't appear to be thrown.

Ns_QueryToSet will not allow parameters whose names end with ".tmpfile".
* Looks like this could be added without much hassle.

Added boolean database parameter "WarnEmpty". If this is set, then AOLserver will log a warning when the last handle in a database pool is empty, and when a thread tries to get a handle from an empty pool. Set this in the ns/db/pool/poolname section.
* A simple change to dbinit.c

Added Tcl command "ns_db stats poolname", which returns a two-element list. The first element is the maximum number of handles in the pool (equal to the "connections" config parameter). The second element is the number of handles currently available in the pool.
* Simple changes to dbinit.c, dbtcl.c, and ns.h
* It looks like the ad13 patch didn't add the command to the usage message where it should have.
* This command doesn't appear to be used in OpenACS (CVS HEAD anyway)

Patch to op.c to not crash on bad HTTP request line if nsd.tcl has a 401 redirect.
* Test to see if this still happens. A minor change.

Patch to NsHandleSignals to actually exit on Linux if a SIGSEGV is received.
* Appears to be a straight-forward addition to unix.c

Patch to ns_sourceproc to cache Tcl pages (including bytecodes) if nscache module is installed.
* Modifications in tcl/file.tcl, tcl/tclcache.tcl added

Declare Ns_ConnWriteRawData in ns.h.
* This does not actually appear in ns.h. I believe the notes mean Ns_ConnReturnRawData in ns.h (body in return.c)

Add errorminsize to doc/config.txt.
* doc/config.txt was removed. We could add this small documentation change to sample-config.tcl.

Fix channel memory leak in tclIO.c.
* I'm assuming this memory leak is not in TCL 8.4, but someone should confirm. Not an AOLserver core problem anyway.

Import fix for freeing of Tcl TSD from AOLserver 4.0 tree.
* I'm not sure what the fix was, but I'm assuming it made it into 3.5.1 as well.

How to set up PHP under AOLserver

2006-03-24T13:17:41Z

Dossy: Reverted edit of 69.121.200.97, changed back to last version by Vkurup

'' '''Prerequisites:''' ''
* AOLserver 4.0.6 [http://www.aolserver.com/] (currently CVS aolserver_v40_bp branch)
* PHP 4.3.7 or 5.0.0 [http://www.php.net/] + interim patch

Also works with AOLserver 4.0.10 and PHP 5.0.4 but has problems if multiple virtual hosts use PHP (crashes the nsd process on Solaris). This behavior is also documented on the mailinglist for PHP 4.x, so it is not a regression.

'' '''Instructions:''' ''

'''Step 1. Build and install Tcl and AOLserver.'''

You can use a binary distribution of Tcl provided it is a threaded build of Tcl. However, in order to build PHP, you will need to have AOLserver source available as PHP requires it in its own build process. These instructions assume that you will install AOLserver into "/home/aolserver" and the source resides in "/src/aolserver-4.0.5". Replace these to reflect your environment as necessary.

Building both Tcl and AOLserver is outside the scope of this document and should be covered in a separate document.

'''Step 2. Build and install PHP.'''

The following is an example of how you will need to configure PHP for building:

$ ./configure --with-aolserver=/home/aolserver --with-aolserver-src=/src/aolserver-4.0.5 --enable-shared

"--with-aolserver=/home/aolserver" is the path to where AOLserver is installed (the --prefix option when you build AOLserver) and "--with-aolserver-src=/src/aolserver-4.0.5" is the path to where the AOLserver source lives. "--enable-shared" may be turned on by default, which should build "libphp4.so" which we will need for AOLserver.

Once configured, run "make" to compile PHP. You do NOT need to do a "make install" or "make install-su" unless you want PHP to install the CLI executable and/or the PEAR stuff. To install the necessary bits for AOLserver, simply copy "libs/libphp4.so" for PHP 4.3.7 or "libs/libphp5.so" for PHP 5.0.0 to your AOLserver module directory, and "php.ini-recommended" to your AOLserver home directory as "php.ini".

$ make
... lots of build output scrolls by ...

$ cp libs/libphp4.so /home/aolserver/bin
$ cp php.ini-recommended /home/aolserver/php.ini

The default php.ini file should be suitable at first: customize and tweak it later once you've confirmed that PHP is indeed working correctly.

'''Step 3. Configure AOLserver to load PHP support.'''

Starting with the "sample-config.tcl" that comes with AOLserver, you need to make two simple changes. The first is to set (or increase) the stack size to a minimum of 256KB. The recommended value is 1MB. Here is the relevant snippet from the sample-config.tcl, lines 139-143:

139 #
140 # Thread library (nsthread) parameters
141 #
142 ns_section "ns/threads"
143 #ns_param stacksize [[expr 128*1024]] ;# Per-thread stack size.

Note that the "ns_param" line that sets stack-size is currently commented out. Uncomment that line, and change it to:

143 ns_param stacksize [[expr 256*1024]] ;# Per-thread stack size.

(Do not include the line number, "143", at the start of the line -- that is for illustrative purposes only.)

We have changed the stack from 128KB ("128*1024") to 256KB ("256*1024") and uncommented the line. Change it to "1024*1024" to set it to 1MB.

The next step is to add the necessary configuration to instruct AOLserver to load the PHP module at server start-up. We do this by adding the following lines to the bottom of the sample-config.tcl file:

#
# PHP
#

ns_section "ns/server/${servername}/module/php"
ns_param map *.php

ns_section "ns/server/${servername}/modules"
ns_param php ${bindir}/libphp4.so

This tells AOLserver to load our libphp4.so from the directory pointed to by $bindir, and indicates that files ending with the suffix ".php" contain PHP code and should be processed by the PHP module.

You will also want the server to look for PHP index pages. To do this, append "index.php" to the end of the directory file line in your AOLserver configuration file:

set directoryfile index.adp,index.html,index.htm,index.xhtml,index.xht,index.php

'''Step 4. Start AOLserver, and enjoy!'''

That's all there is to it. Start up your server, place some .php files in your pageroot (configured as "servers/server1/pages" by default in sample-config.tcl) and request them in a web browser. Everything should be working.

As of 22jun2004, the following apps have been at least lightly tested:
* phpBB2 2.0.8 [http://www.phpbb.com/]
* SquirrelMail 1.4.3a [http://www.squirrelmail.org/]

Both phpBB2 and SquirrelMail store "sensitive" data that you probably don't want a user to browse. These come with .htaccess files installed but since AOLserver doesn't support .htaccess these files are unprotected. One option is to enable [[nsperm]] and create entries to grant access to a non-existent user (implicitly denying access to everyone else). The file to edit will live somewhere like "/home/aolserver/servers/server1/modules/nsperm/perms".

For phpBB2, add an entry like:

allowuser inherit GET /phpBB2/cache notfound

For SquirrelMail, add an entry like:

allowuser inherit GET /mail/data notfound
allowuser inherit GET /mail/plugins/squirrelspell/modules notfound

There is nothing special about the user "notfound". Any string here that is not found in your [[nsperm]] "passwd" file will work. Change the URLs in the above examples to match the actual location of where you've installed the applications.

An alternative approach to explictly deny users access might look something like:

denyuser inherit GET /mail/data ""

The downside of this second method is that it allows authenticated users (those users who are in the [[nsperm]] "passwd" file) to access these protected files.

----

'''Appendix A. Patch to PHP 4.3.7/5.0.0.'''

Before applying this patch, you may need to remove a single whitespace character from the beginning of every line (as they were added so that the patch appears as preformatted text on the wiki.) Place the file in the "php-4.3.7/sapi/aolserver" or "php-5.0.0/sapi/aolserver" directory as "aolserver.c.patch" and apply it with GNU patch:

$ patch -p0 < aolserver.c.patch

Patch follows:

--- aolserver.c.orig 2003-05-30 21:37:44.000000000 -0400
+++ aolserver.c 2004-06-21 22:00:48.000000000 -0400
@@ -88,21 +88,12 @@
static int
php_ns_sapi_ub_write(const char *str, uint str_length TSRMLS_DC)
{
- int n;
- uint sent = 0;
-
- while (str_length > 0) {
- n = Ns_ConnWrite(NSG(conn), (void *) str, str_length);
-
- if (n == -1)
- php_handle_aborted_connection();
-
- str += n;
- sent += n;
- str_length -= n;
+ if (Ns_WriteConn(NSG(conn), str, str_length) != NS_OK) {
+ php_handle_aborted_connection();
+ return 0;
}

- return sent;
+ return str_length;
}

/*
@@ -148,7 +139,7 @@
php_ns_sapi_send_headers(sapi_headers_struct *sapi_headers TSRMLS_DC)
{
if(SG(sapi_headers).send_default_content_type) {
- Ns_ConnSetRequiredHeaders(NSG(conn), "text/html", 0);
+ Ns_ConnSetRequiredHeaders(NSG(conn), "text/html", -1);
}

Ns_ConnFlushHeaders(NSG(conn), SG(sapi_headers).http_response_code);

'''Appendix B. Testing with the PHP test cases.'''

PHP comes with a pretty thorough suite of test cases that check for regressions and for basic functionality. Many of these tests work in a webserver context as well (about 2/3 of them). A perl script, [http://www.aolserver.com/files/webtest.pl webtest.pl], can be used execute these tests. This script is not specific to AOLserver. It is known to work with Apache and should work with any webserver.

To test PHP:

1. Download the script.
2. Place the script in the PHP source tree.
3. Execute: perl webtest.pl -h hostname:port -d /path/to/document/root

An example command line might look like:

$ perl webtest.pl -h localhost:8000 -d /home/aolserver/servers/server1/pages/

This script has been tested with PHP 4.3.7 and PHP 5.0.0.

----
php-5.0.5 patch
--- aolserver.c 2005-09-14 22:18:03.000000000 -0400
+++ aolserver.c.back 2005-09-14 22:14:44.000000000 -0400
@@ -88,12 +88,21 @@
static int
php_ns_sapi_ub_write(const char *str, uint str_length TSRMLS_DC)
{
- if (Ns_WriteConn(NSG(conn), str, str_length) != NS_OK) {
- php_handle_aborted_connection();
- return 0;
+ int n;
+ uint sent = 0;
+
+ while (str_length > 0) {
+ n = Ns_ConnWrite(NSG(conn), (void *) str, str_length);
+
+ if (n == -1)
+ php_handle_aborted_connection();
+
+ str += n;
+ sent += n;
+ str_length -= n;
}

- return str_length;
+ return sent;
}

/*
@@ -139,7 +148,7 @@
php_ns_sapi_send_headers(sapi_headers_struct *sapi_headers TSRMLS_DC)
{
if(SG(sapi_headers).send_default_content_type) {
- Ns_ConnSetRequiredHeaders(NSG(conn), "text/html", -1);
+ Ns_ConnSetRequiredHeaders(NSG(conn), "text/html", 0);
}

Ns_ConnFlushHeaders(NSG(conn), SG(sapi_headers).http_response_code);

~p

----

[[Category Documentation]] - [[Tutorials]] - [[PHP]]

How to set up WiKit under AOLserver

2006-03-24T13:17:29Z

Dossy: Reverted edit of 70.36.163.105, changed back to last version by Vkurup

'' '''Prerequisites:''' ''
* AOLserver 4.0.6 [http://www.aolserver.com/] (currently CVS aolserver_v40_bp branch)
* Tclkit 8.4.6 [http://equi4.com/tclkit.html]
* Wikit 2004/06/08 00:57:42 19564-63131 [http://equi4.com/wikit.html]

'' '''Instructions:''' ''

'''Step 1. Build and install Tcl and AOLserver.'''

You can use a binary distribution of Tcl provided it is a threaded build of Tcl, and build AOLserver with it.

Building both Tcl and AOLserver is outside the scope of this document and should be covered in a separate document.

'''Step 2. Create directories for the wiki..'''

Assuming that your AOLserver is installed in "/home/aolserver" (if it isn't, obviously replace that with the relevant path for your installation) and that you will start with the "sample-config.tcl" that comes standard with AOLserver, we should create a place to install the wiki-related files. Lets do that now:

$ mkdir /home/aolserver/servers/server1/wiki
$ mkdir /home/aolserver/servers/server1/wiki/data

You will only need to make the "wiki/data" directory writable by the user that AOLserver will run as.

Note that these directories do NOT live under the pageroot ("servers/server1/pages" in the sample-config.tcl) but rather at the same level as the pageroot. This is for security reasons.

'''Step 3. Download and install Tclkit and Wikit.'''

Download the latest version of Tclkit and Wikit. At the time of this writing, I tested with Tclkit 8.4.6. You can download binaries for several platforms:
* http://equi4.com/pub/tk/8.4.6/

In this example, the server is running on x86 Linux. Here's how you might download the necessary files:

<pre>
$ cd /home/aolserver/servers/server1/wiki

$ wget -O tclkit-8.4.6-static.gz http://equi4.com/pub/tk/8.4.6/tclkit-linux-x86-static.gz
... [ wget output ] ...

$ gunzip tclkit-8.4.6-static

$ chmod 755 tclkit-8.4.6-static
</pre>

Install Wikit in a similar way:

<pre>
$ cd /home/aolserver/servers/server1/wiki

$ wget http://equi4.com/pub/sk/wikit.kit
</pre>

You will also need a thin wrapper script (see Appendix B at the bottom of this page) that will execute wikit. Copy the script from Appendix B into a file named "wiki.sh" in the "wiki" directory then make it executable.

<pre>
$ cd /home/aolserver/servers/server1/wiki

$ cat <<-'EOF' | sed -e 's/^ //' > wiki.sh
... copy and paste contents of Appendix B ...
EOF

$ chmod 755 wiki.sh
</pre>

That's it! Tclkit and Wikit are now downloaded and installed.

'''Step 4. Configure AOLserver to load CGI support.'''

Starting with the "sample-config.tcl" that comes with AOLserver, you need to make a simple change to enable CGI and configure it to recognize requests for the wiki.

Start by adding the following three lines to the [[nscgi]] module section in your sample-config.tcl:

ns_param map "GET /wiki ${homedir}/servers/${servername}/wiki/wiki.sh"
ns_param map "POST /wiki ${homedir}/servers/${servername}/wiki/wiki.sh"
ns_param map "HEAD /wiki ${homedir}/servers/${servername}/wiki/wiki.sh"

This tells AOLserver to execute "wiki/wiki.sh" for requests to the server where the URL starts with "/wiki". This invokes our thin wrapper script.

Next, we need to instruct AOLserver to actually load the [[nscgi]] module by uncommenting the appropriate line in the "modules" section (around line 449 after inserting the three ns_params above):

ns_section "ns/server/${servername}/modules"
...
ns_param nscgi ${bindir}/nscgi.so
...

'''Step 5. Start AOLserver, and enjoy!'''

That's all there is to it. Start up your server, fire up your web browser and point it at your server:

http://www.aolserver.com/wiki

(Replace "www.aolserver.com" with your IP or the hostname of your server.)

You should get back the home page of your new wiki!

----

'''Before using any of the files in the appendix, you will need to remove the first whitespace character from the beginning of each line, as those were inserted so that the wiki will display them as preformatted text.'''

'''Appendix A. Patch to sample-config.tcl.'''

<pre>
--- sample-config.tcl 2004-06-14 20:18:19.000000000 -0400
+++ wiki-config.tcl 2004-06-23 16:48:23.000000000 -0400
@@ -352,6 +352,9 @@
#ns_param map "GET /cgi /usr/local/cgi" ;# CGI script file dir (GET).
#ns_param map "POST /cgi /usr/local/cgi" ;# CGI script file dir (POST).

+ns_param map "GET /wiki ${homedir}/servers/${servername}/wiki/wiki.sh"
+ns_param map "POST /wiki ${homedir}/servers/${servername}/wiki/wiki.sh"
+ns_param map "HEAD /wiki ${homedir}/servers/${servername}/wiki/wiki.sh"

#
# Modules to load
@@ -360,7 +363,7 @@
ns_section "ns/server/${servername}/modules"
ns_param nssock ${bindir}/nssock.so
ns_param nslog ${bindir}/nslog.so
- #ns_param nscgi ${bindir}/nscgi.so
+ ns_param nscgi ${bindir}/nscgi.so
#ns_param nsperm ${bindir}/nsperm.so

#
</pre>

'''Appendix B. wiki.sh wrapper script.'''

<pre>
#!/bin/sh

DIR=`dirname $0`
cd $DIR/data

WIKIT_BASE=${WIKIT_BASE:-http://${HTTP_HOST}${SCRIPT_NAME}/}
export WIKIT_BASE

$DIR/tclkit-8.4.6-static $DIR/wikit.kit
</pre>

[[Category:Documentation]]
[[Category:Tutorials]]

Talk:AOLserver Wiki

2006-03-24T13:11:44Z

Dossy:

How to set up Sql-Ledger to serve from AOLserver

2006-03-24T13:07:34Z

Dossy: Reverted edit of 71.134.22.190, changed back to last version by Vkurup

Install SQL-Ledger with the following modifications:

Note that I'm using this on an isolated LAN so have not done any testing to verify the integrity of SQL-Ledger security on it.

Be sure AOLserver is installed, and shutdown.

* Get [http://sql-ledger.org/cgi-bin/nav.pl?page=source/index.html&title=Download SQL-Ledger].

* Follow the directions for [http://sql-ledger.org/cgi-bin/nav.pl?page=source/readme.txt&title=README INSTALLATION WITHOUT setup.pl]. Be sure to '''skip''' using the sql-ledger supplied "setup.pl" file.

We adapt the instructions for setting setting up httpd (aolserver's nsd in this case):

* Download and build the AOLserver [[nscgi]] module. Usually [[nscgi]] is already included with the AOLserver distribution.

You can see examples of how to build AOLserver modules by reading the [http://openacs.org/doc/openacs-5-2/aolserver4.html AOLserver install docs for OpenACS 5.2].

In the OpenACS config.tcl file, activate the [[nscgi]] module in this section:

ns_section ns/server/${server}/modules
ns_param nscgi ${bindir}/nscgi.so

And modify the nscgi module configuration in config.tcl to something like this:

ns_section "ns/server/${server}/module/nscgi"
ns_param map "GET /sql-ledger /usr/local/sql-ledger"
ns_param map "GET /sql-ledger/css /usr/local/sql-ledger/css"

ns_param map "POST /sql-ledger /usr/local/sql-ledger"
# ns_param map "POST /sql-ledger/css /usr/local/sql-ledger/css"
# there is no need to post to css files ;)

ns_param Interps CGIinterps

ns_section "ns/interps/CGIinterps"
ns_param .pl "/usr/bin/perl"

Security: Jon Griffin has some advice about nscgi and security at http://jongriffin.com/static/consultant/nscgi For greater security, map each .pl file individually that is in the directories mapped above. For example:

# ns_param map "GET /sql-ledger /usr/local/sql-ledger"
# becomes:
ns_param map "GET /sql-ledger/admin.pl /usr/local/sql-ledger/admin.pl"
ns_param map "GET /sql-ledger/login.pl /usr/local/sql-ledger/login.pl"
ns_param map "GET /sql-ledger/am.pl /usr/local/sql-ledger/am.pl"
ns_param map "GET /sql-ledger/ap.pl /usr/local/sql-ledger/ap.pl"
ns_param map "GET /sql-ledger/ar.pl /usr/local/sql-ledger/ar.pl"
ns_param map "GET /sql-ledger/bp.pl /usr/local/sql-ledger/bp.pl"
ns_param map "GET /sql-ledger/ca.pl /usr/local/sql-ledger/ca.pl"
ns_param map "GET /sql-ledger/cp.pl /usr/local/sql-ledger/cp.pl"
ns_param map "GET /sql-ledger/ct.pl /usr/local/sql-ledger/ct.pl"
ns_param map "GET /sql-ledger/gl.pl /usr/local/sql-ledger/gl.pl"
ns_param map "GET /sql-ledger/hr.pl /usr/local/sql-ledger/hr.pl"
ns_param map "GET /sql-ledger/ic.pl /usr/local/sql-ledger/ic.pl"
ns_param map "GET /sql-ledger/ir.pl /usr/local/sql-ledger/ir.pl"
ns_param map "GET /sql-ledger/is.pl /usr/local/sql-ledger/is.pl"
ns_param map "GET /sql-ledger/jc.pl /usr/local/sql-ledger/jc.pl"
ns_param map "GET /sql-ledger/menu.pl /usr/local/sql-ledger/menu.pl"
ns_param map "GET /sql-ledger/oe.pl /usr/local/sql-ledger/oe.pl"
ns_param map "GET /sql-ledger/pe.pl /usr/local/sql-ledger/pe.pl"
ns_param map "GET /sql-ledger/ps.pl /usr/local/sql-ledger/ps.pl"
ns_param map "GET /sql-ledger/rc.pl /usr/local/sql-ledger/rc.pl"
ns_param map "GET /sql-ledger/rp.pl /usr/local/sql-ledger/rp.pl"
# skipping: setup.pl
# have to specify images too:
ns_param map "GET /sql-ledger/favicon.ico /usr/local/sql-ledger/favicon.ico"
ns_param map "GET /sql-ledger/sql-ledger.gif /usr/local/sql-ledger/sql-ledger.gif"
ns_param map "GET /sql-ledger/sql-ledger.png /usr/local/sql-ledger/sql-ledger.png"

# ns_param map "GET /sql-ledger/css /usr/local/sql-ledger/css/"
# becomes:
ns_param map "GET /sql-ledger/css/sql-ledger-blue.css /usr/local/sql-ledger/css/sql-ledger-blue.css"
ns_param map "GET /sql-ledger/css/sql-ledger-brown.css /usr/local/sql-ledger/css/sql-ledger-brown.css"
ns_param map "GET /sql-ledger/css/sql-ledger-purple.css /usr/local/sql-ledger/css/sql-ledger-purple.css"
ns_param map "GET /sql-ledger/css/sql-ledger-red.css /usr/local/sql-ledger/css/sql-ledger-red.css"
ns_param map "GET /sql-ledger/css/sql-ledger-yellow.css /usr/local/sql-ledger/css/sql-ledger-yellow.css"
ns_param map "GET /sql-ledger/css/sql-ledger.css /usr/local/sql-ledger/css/sql-ledger.css"

# ns_param map "POST /sql-ledger /usr/local/sql-ledger"
# becomes:
ns_param map "POST /sql-ledger/admin.pl /usr/local/sql-ledger/admin.pl"
ns_param map "POST /sql-ledger/login.pl /usr/local/sql-ledger/login.pl"
ns_param map "POST /sql-ledger/am.pl /usr/local/sql-ledger/am.pl"
ns_param map "POST /sql-ledger/ap.pl /usr/local/sql-ledger/ap.pl"
ns_param map "POST /sql-ledger/ar.pl /usr/local/sql-ledger/ar.pl"
ns_param map "POST /sql-ledger/bp.pl /usr/local/sql-ledger/bp.pl"
ns_param map "POST /sql-ledger/ca.pl /usr/local/sql-ledger/ca.pl"
ns_param map "POST /sql-ledger/cp.pl /usr/local/sql-ledger/cp.pl"
ns_param map "POST /sql-ledger/ct.pl /usr/local/sql-ledger/ct.pl"
ns_param map "POST /sql-ledger/gl.pl /usr/local/sql-ledger/gl.pl"
ns_param map "POST /sql-ledger/hr.pl /usr/local/sql-ledger/hr.pl"
ns_param map "POST /sql-ledger/ic.pl /usr/local/sql-ledger/ic.pl"
ns_param map "POST /sql-ledger/ir.pl /usr/local/sql-ledger/ir.pl"
ns_param map "POST /sql-ledger/is.pl /usr/local/sql-ledger/is.pl"
ns_param map "POST /sql-ledger/jc.pl /usr/local/sql-ledger/jc.pl"
ns_param map "POST /sql-ledger/menu.pl /usr/local/sql-ledger/menu.pl"
ns_param map "POST /sql-ledger/oe.pl /usr/local/sql-ledger/oe.pl"
ns_param map "POST /sql-ledger/pe.pl /usr/local/sql-ledger/pe.pl"
ns_param map "POST /sql-ledger/ps.pl /usr/local/sql-ledger/ps.pl"
ns_param map "POST /sql-ledger/rc.pl /usr/local/sql-ledger/rc.pl"
ns_param map "POST /sql-ledger/rp.pl /usr/local/sql-ledger/rp.pl"
# skipping setup.pl

Do *not* put the SQL-Ledger directory in the AOLserver's pageroot directory. Put sql-ledger dir in the /usr/local directory per SL docs:

mv sql-ledger /usr/local/.

# set permissions to match the rest of the aolserver files, for example:
cd /usr/local/
chown -R nsadmin:web sql-ledger
chmod -R 770 sql-ledger

cd /usr/local/sql-ledger
chmod 640 *.gif
chmod 640 *.png
chmod 640 *.ico
cd css
chmod 660 *.css

Follow the SL directions to create a SQL-Ledger database and user for PostgreSQL, and proceed with the configuration in the SL README. Hopefully you see a login page at http://yourservername:port/sql-ledger/admin.pl and are able to follow standard SQL-Ledger configuration directions.

[[Category:Tutorial]]

Ns adp return

2006-03-24T13:07:21Z

Dossy: Reverted edit of 68.93.107.54, changed back to last version by Vkurup

Man page: http://aolserver.com/docs/tcl/ns_adp_return.html

----

'''NAME'''

: ns_adp_return - Stop processing of the current ADP and return up the call stack

'''SYNOPSIS'''

: '''ns_adp_return''' ''?retval?''

'''DESCRIPTION'''

: This command ends processing of the current ADP and returns up the call stack, possibly to a previous ADP that had included the current one. Returns ''retval'' or an empty string by default.

: Note that this command returns only one level up the call stack. To return all the way up the call stack, use [[ns_adp_break]].

'''SEE ALSO'''

: [[ns_adp_abort]], [[ns_adp_append]], [[ns_adp_argc]], [[ns_adp_argv]], [[ns_adp_bind_args]], [[ns_adp_break]], [[ns_adp_debug]], [[ns_adp_debuginit]], [[ns_adp_dir]], [[ns_adp_dump]], [[ns_adp_eval]], [[ns_adp_exception]], [[ns_adp_include]], [[ns_adp_mime]], [[ns_adp_mimetype]], [[ns_adp_parse]], [[ns_adp_puts]], [[ns_adp_registeradp]], [[ns_adp_registerproc]], [[ns_adp_registertag]], [[ns_adp_safeeval]], [[ns_adp_stats]], [[ns_adp_stream]], [[ns_adp_tell]], [[ns_adp_trunc]]

[[Category:Documentation]]
[[Category:Core Tcl API]]

Ns set

2006-03-24T13:07:09Z

Dossy: Reverted edit of 70.160.102.101, changed back to last version by Vkurup

Man page: http://aolserver.com/docs/tcl/ns_set.html

----

'''NAME'''

: ns_set - Manipulate sets of key-value pairs

'''SYNOPSIS'''

: '''ns_set''' ''option ?arg arg ...?''

'''DESCRIPTION'''

: This command is used to manipulate sets of key-value pairs or "fields". The fields in the set are ordered by number. The field numbers start at zero and increase by one, up to the total number of fields. An '''ns_set''' is actually a multiset - in other words, the same key can appear multiple times in the same set. This data structure is particularly useful for things like HTTP headers which have this same property.

: The legal ''option''s (which may be abbreviated) are:
* '''ns_set array''' ''setId''

: Returns the contents of the ''setId'' in a string representation similar to Tcl's '''array get''' format. This is useful for converting an '''ns_set''' to an '''array''' or for iterating over the key-value pairs with '''foreach'''. Since '''ns_set'''s can contain the same key multiple times, converting an '''ns_set''' to an '''array''' can result in an array that is not exactly the same as the original '''ns_set''' as keys in an array are unique.
* '''ns_set cleanup'''

: Frees all sets in the current interp.
* '''ns_set copy''' ''?-persist? setId''

: Returns a new set that has the same name and contents as the set referenced in ''setId''. If ''-persist'' is specified, the new set will not be freed when the current transaction ends, and you can free it later with '''ns_set free'''. If ''-persist'' is not specified, the new set is automatically freed when the transaction ends.
* '''ns_set cput''' ''setId key value''

: Appends a new field to the set with ''key'' and ''value'', if the field does not already exist in the set. If the field already exists in the set, the set is unchanged. Returns the field number of the new field, or the field number of the existing field if it already exists in the set.
* '''ns_set create''' ''?-persist? ?name? ?key? ?value? ...''
* '''ns_set new''' ''?-persist? ?name? ?key? ?value? ...''

: Allocates memory for a new set and returns the setId for the new set. If ''-persist'' is specified, the new set will not be freed when the current transaction ends, and you can free it later with '''ns_set free'''. If ''-persist'' is not specified, the new set is automatically freed when the transaction ends.
* '''ns_set delete''' ''setId fieldNumber''

: Deletes the field in the set at field number ''fieldNumber''.
* '''ns_set delkey''' ''setId key''

: Removes the first field in the set whose key is ''key''. Note that there could be multiple fields in the set with this key; this command only removes the first occurrence.
* '''ns_set find''' ''setId key''

: Returns the index of the first field in the specified ''setId'' whose ''key'' matches the specified key. Indexing starts at zero. If no matching fields are found, '''ns_set find''' returns -1.
* '''ns_set free''' ''setId''

: Frees the specified set. Sets must be explicitly freed with '''ns_set free''' if the ''-persist'' option was used when creating the set. Otherwise, sets are automatically freed when the transaction ends.
* '''ns_set get''' ''setId key''

: Returns the first value associated with ''key''. If ''key'' isn't in the set, an empty string is returned.
* '''ns_set icput''' ''setId key value''

: Case-insensitive counterpart of '''ns_set cput'''.
* '''ns_set idelkey''' ''setId key''

: Case-insensitive counterpart of '''ns_set delkey'''.
* '''ns_set ifind''' ''setId key''

: Case-insensitive counterpart of '''ns_set find'''.
* '''ns_set iget''' ''setId key''

: Case-insensitive counterpart of '''ns_set get'''.
* '''ns_set isnull''' ''setId fieldNumber''

: Returns 1 if the value of the field specified by ''fieldNumber'' is null and 0 if it is not. Note that an empty string is not the same as a null. '''ns_set isnull''' will return 0 if the value is an empty string.
* '''ns_set iunique''' ''setId key''

: Case-insensitive counterpart of '''ns_set unique'''.
* '''ns_set key''' ''setId fieldNumber''

: Returns the key for the field numbered ''fieldNumber''. This command is useful when looping through all the key-value pairs in the set in order.
* '''ns_set list''' ''?-shared?''

: Returns the list of all non-persistent '''ns_set'''s. If ''-shared'' is specified, this command returns only the list of persistent '''ns_set'''s.
* '''ns_set merge''' ''high low''

: Merges two sets. Any fields in the ''low'' set are appended to the ''high'' set if a field with the same key name does not already exist in the ''high'' set.
* '''ns_set move''' ''to from''

: Moves all fields from the ''from'' set to the end of the ''to'' set, leaving the ''from'' set a valid, empty set.
* '''ns_set name''' ''setId''

: Returns the name of the set. Returns an empty string if no name has been set.
* '''ns_set print''' ''setId''

: Prints the specified set to stderr which should go to the server log. This is useful for debugging, but '''ns_set array''' may be more useful in actual code.
* '''ns_set put''' ''setId key value''

: Appends a new field to the set with ''key'' and ''value''. Note that the field is appended so if a previous field has the same key as the new field, the previous field will be returned by '''ns_set get'''. The field number of the new field is returned.
* '''ns_set size''' ''setId''

: Returns the number of fields in the set.
* '''ns_set split''' ''?-persist? setId ?splitChar?''

: Splits one set into multiple sets based on the ''splitChar'' as described below and returns a Tcl list of IDs for the newly-allocated sets. It assumes that the keys in the source ''setId'' contain a specific character (''splitChar'') that can be used to separate the name of a new set and the key in the new set. The default ''splitChar'' is a period ".".
* '''ns_set truncate''' ''setId fieldNumber''

: Removes any fields with index ''fieldNumber'' or greater and frees any memory allocated for them.
* '''ns_set unique''' ''setId key''

: Returns 1 if the specified key is unique in the specified set and 0 if it is not. For example, a web browser could send multiple "Accept:" headers which would end up in the header set for the connection. '''ns_set unique''' would return 0 for the "Accept:" key, because there are multiple fields with the key "Accept:". The test for uniqueness is performed case-sensitively.
* '''ns_set update''' ''setId key value''

: Updates the first field in the specified set whose key is ''key'' and replaces its value with ''value''. This is equivalent to '''ns_set delkey''' followed by '''ns_set put''' if there is only one field with the key of ''key''.
* '''ns_set value''' ''setId fieldNumber''

: Returns the value of the set at field number ''fieldNumber''. This command is useful when looping through all the key-value pairs in the set.

'''EXAMPLES'''

% set mySet [ns_set create mySetName a b c d e f A Joe B John C Jeff]
d0

% ns_set size $mySet
6

% ns_set name $mySet
mySetName

% ns_set array $mySet
a b c d e f A Joe B John C Jeff

% ns_set get $mySet A
Joe

% ns_set iget $mySet a
b

% ns_set unique $mySet a
1

% ns_set iunique $mySet a
0

% ns_set truncate $mySet 3

% ns_set print $mySet
mySetName:
a = b
c = d
e = f

% ns_set update $mySet c "Hello World!"
2

% ns_set print $mySet
mySetName:
a = b
e = f
c = Hello World!

% ns_set find $mySet c
2

% ns_set find $mySet nokey
-1

% ns_set delete $mySet 0

% ns_set array $mySet
e f c {Hello World!}

% set anotherSet [ns_set create]
d1

% ns_set list
d0 d1

% ns_set put $anotherSet dog.food "Yummy dog food!"
0

% ns_set put $anotherSet cat.food "Yummy cat food!"
1

% ns_set print $anotherSet
<Unamed set>:
dog.food = Yummy dog food!
cat.food = Yummy cat food!

% set newSets [ns_set split $anotherSet]
d2 d3

% foreach s $newSets { ns_set print $s }
dog:
food = Yummy dog food!
cat:
food = Yummy cat food!

% ns_set key $anotherSet 0
dog.food

% ns_set value $anotherSet 1
Yummy cat food!

% ns_set move $mySet $anotherSet
d0

% ns_set array $mySet
e f c {Hello World!} dog.food {Yummy dog food!} cat.food {Yummy cat food!}

% ns_set array $anotherSet

% set thirdSet [ns_set new]
d4

% ns_set move $thirdSet $mySet
d4

% ns_set array $thirdSet
e f c {Hello World!} dog.food {Yummy dog food!} cat.food {Yummy cat food!}

% array set testArray [ns_set array $thirdSet]

'''NOTES'''

: The ns_set command currently reports that it accepts two additional subcommands, idelete and purge. These are both noops (idelete may be a mistake as delete is already case-irrelevant).

: NULL values, distinct from the empty string, are useful when representing a database row as an ns_set. Currently, it is difficult to get a NULL value in an ns_set through the TCL API. You may get a NULL value in the set created by [[ns_parsequery]] or by omitting the last value when seeding the ns_set in the create/new subcommand, etc. It is possible to create NULL-valued fields through the C API.

: ns_set is intended for relatively ''small'' amounts of data. (Keys are found by a ''linear'' search through the whole underlying C array.) If you stuff very large amounts of data into an ns_set, performance will be very poor - use a Tcl Array instead for that.

'''SEE ALSO'''

: [[ns_findset]]

----

[[Category Documentation]] - [[Category Core Tcl API]]

Jk-voting-template

2006-03-24T13:06:51Z

Dossy: Reverted edit of 69.146.41.187, changed back to last version by Vkurup

proc template {fn keyset} {
set h [[open "[ns_info pageroot]]/templates/$fn" r]
set cont [[read $h]]
close $h

set keymap ""
for {set x 0} {$x < [[ns_set size $keyset]]} {incr x} {
set key [[ns_set key $keyset $x]]
set value [[ns_set value $keyset $x]]
lappend keymap "%%%%$key%%%%"
lappend keymap $value
}
if {$keymap != ""} {
set cont [[string map $keymap $cont]]
}
return $cont
}