AOLserver Wiki - User contributions [en]

Sites That Run On AOLserver

2006-03-30T15:54:28Z

Vkurup:

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/ ||
|-
| 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/ ||
|-
| 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/ ||
|-
| WhatsThisIP.com || AOLserver/4.0.10 || http://whatsthisip.com/ ||
|-
| 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/ ||
|-
| Bayt.com || AOLserver/3.4.2 || http://www.bayt.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/ ||
|-
| 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/ ||
|-
| 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.

Useful Links

2006-03-30T15:12:42Z

Vkurup:

Here are a list of links to useful resources for AOLserver.
* TCL Performance Hints Page [http://mini.net/cgi-bin/wikit/348]
* Tcl Wiki [http://mini.net/cgi-bin/wikit/]
* Tcl for Web Nerds [http://philip.greenspun.com/tcl/index.adp]
* Article about XML processing in AOLserver using nsxml module [http://www.fifthgate.org/articles/aolserver/xml/ns_xml_doc.html]
* Article about implementing search in AOLserver with SWISH++ [http://www.fifthgate.org/articles/aolserver/search/swish_search.html]
* An introductory article to AOLserver [http://www.fifthgate.org/articles/aolserver/intro.html]
* TCL Quick Reference Manual [http://sdss.fnal.gov:8000/dss/doc/www/tcl/tcl.commands.html]
* Frequently Made Mistakes in Tcl [http://starbase.neosoft.com/~claird/comp.lang.tcl/fmm.html] '''(DOWN)'''
* RPG style "Level Break" functionality in TCL [http://www.walters.demon.co.uk/tcl/tcl_stuff.htm]
* Tcl in AOL Digital City The Architecture of a Multithreaded High-Performance Web Site (by [[Jim Davidson]]). Many requests for this. [http://www.aolserver.com/docs/intro/tcl2k/]
* AOLServer Utils [http://dante.nailed.org/software/] '''(DOWN)'''
* Resources for ArsDigita Bootcampers, Home-Studiers, etc. [http://www.primenet.com/~cohen/arsdigita/index.html]
* Beginner's Guide to the Installation of the ArsDigita Community System [http://www.openknowledge.org/acs/acs-beginner-toc.html]
* AOLserver @ am.net New Parser and ODBC Instructions [http://aolserver.am.net/]
* Fixing Crashing AOLServers [http://www.badgertronics.com/writings/server-fix.html]
* AOLServer Articles at Linux World [http://linuxworld.com/linuxworld/lw-1999-09/lw-09-aolserver_1.html]
* Building Sites with AOLserver Scott G.'s New Documentation Site [http://www.scottg.net/aolserver/] '''(DOWN)'''
* SSL, SSLv3, and Client-side Certificates with AOLserver [http://www.arsdigita.com/asj/aolserver-ssl]
* [[How to generate self-signed SSL certificates]]

* AOLServer Web Hosting : I could only find zill.net [http://www.zill.net/openacs-pricing.html]

* Some AOLserver programming hints from OpenACS [http://openacs.org/doc/current/programming-with-aolserver.html]

Welcome, New Visitors

2006-03-30T13:15:59Z

Vkurup:

Hi. Welcome to the [[AOLserver Wiki]]. This is a website geared towards the collaborative building of a resource for [[AOLserver]].

Once registered for a free account, '''Anyone can edit anything''', using these simple [[Formatting Rules]]. Therefore, please '''be conscientious''' and do not disturb what someone else has contributed, and '''take time and care to proofread''' what you're contributing as others will see it immediately. The wiki requires registration now since there was too much vandalism from spammers. That may change once we can add a CAPTCHA to the editing page.

'''If you leave a comment''', please '''sign it''' (just your initials are sufficient) and maybe even '''date it''' (so that others can tell how old your comment is). A shortcut to sign your content is to enter 4 tildes (~) in a row. It's always awkward responding to a phantom commenteer, and usually frustrating to respond to something which turns out to be over a year old. *smile*

Also, if you are creating a personal page (i.e., like the following page: [[Dossy Shiobara]]) please use your full real name. If you want to sign comments with your initials as a wiki page, place in that page a pointer to your page consisting of your full name.

If there are any problems, report them to me directly (I'm [[Dossy]]). I'll try and fix problems and resolve issues as soon as I can, but I won't make any promises.

I hope this [[wiki]] makes a significant contribution to the AOLserver community, and that everyone finds it useful in some way. Most of all, I hope people will enjoy interacting with one another in this new medium and find enough commonality between one another that a truly wonderful collaborative product can be born here.

-- [[Dossy]]

Talk:AOLserver Wiki

2006-03-30T01:22:37Z

Vkurup:

Ns guesstype

2006-03-20T17:21:01Z

Vkurup: Reverted edit of 24.60.130.36, changed back to last version by WikiSysop

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

----

'''NAME'''

: ns_guesstype - Lookup MIME type based on file extension.

'''SYNOPSIS'''

: '''ns_guesstype''' ''filename''

'''DESCRIPTION'''

: This command guesses and returns the MIME type of a file, based on the extension of ''filename''. A large set of default extension to MIME type mappings is built into the command:
* .adp returns "text/html; charset=iso-8859-1"
* .dci returns "text/html; charset=iso-8859-1"
* .htm returns "text/html; charset=iso-8859-1"
* .html returns "text/html; charset=iso-8859-1"
* .sht returns "text/html; charset=iso-8859-1"
* .shtml returns "text/html; charset=iso-8859-1"
* .ai returns "application/postscript"
* .aif returns "audio/aiff"
* .aifc returns "audio/aiff"
* .aiff returns "audio/aiff"
* .ani returns "application/x-navi-animation"
* .art returns "image/x-art"
* .au returns "audio/basic"
* .avi returns "video/x-msvideo"
* .bin returns "application/x-macbinary"
* .bmp returns "image/bmp"
* .css returns "text/css"
* .csv returns "application/csv"
* .dcr returns "application/x-director"
* .dir returns "application/x-director"
* .dp returns "application/commonground"
* .dxr returns "application/x-director"
* .elm returns "text/plain"
* .eml returns "text/plain"
* .exe returns "application/octet-stream"
* .gbt returns "text/plain"
* .gif returns "image/gif"
* .gz returns "application/x-compressed"
* .hqx returns "application/mac-binhex40"
* .jfif returns "image/jpeg"
* .jpe returns "image/jpeg"
* .jpg returns "image/jpeg"
* .jpeg returns "image/jpeg"
* .js returns "application/x-javascript"
* .ls returns "application/x-javascript"
* .map returns "application/x-navimap"
* .mid returns "audio/x-midi"
* .midi returns "audio/x-midi"
* .mocha returns "application/x-javascript"
* .mov returns "video/quicktime"
* .mpe returns "video/mpeg"
* .mpeg returns "video/mpeg"
* .mpg returns "video/mpeg"
* .nvd returns "application/x-navidoc"
* .nvm returns "application/x-navimap"
* .pbm returns "image/x-portable-bitmap"
* .pdf returns "application/pdf"
* .pgm returns "image/x-portable-graymap"
* .pic returns "image/pict"
* .pict returns "image/pict"
* .pnm returns "image/x-portable-anymap"
* .png returns "image/png"
* .ps returns "application/postscript"
* .qt returns "video/quicktime"
* .ra returns "audio/x-pn-realaudio"
* .ram returns "audio/x-pn-realaudio"
* .ras returns "image/x-cmu-raster"
* .rgb returns "image/x-rgb"
* .rtf returns "application/rtf"
* .sit returns "application/x-stuffit"
* .snd returns "audio/basic"
* .sql returns "application/x-sql"
* .stl returns "application/x-navistyle"
* .tar returns "application/x-tar"
* .tcl returns "text/plain"
* .text returns "text/plain"
* .tgz returns "application/x-compressed"
* .tif returns "image/tiff"
* .tiff returns "image/tiff"
* .txt returns "text/plain"
* .xbm returns "image/x-xbitmap"
* .xpm returns "image/x-xpixmap"
* .xht returns "application/xhtml+xml"
* .xhtml returns "application/xhtml+xml"
* .xml returns "text/xml"
* .xsl returns "text/xml"
* .vrml returns "x-world/x-vrml"
* .wav returns "audio/x-wav"
* .wrl returns "x-world/x-vrml"
* .z returns "application/x-compressed"
* .zip returns "application/x-zip-compressed"

: The MIME type returned for an extension can be overriden in the AOLserver config file, and new mappings can be added, e.g.

ns_section "ns/mimetypes"
ns_param ".xls" "application/vnd.ms-excel" ;# Add a mapping for Excel files
ns_param ".sjis_html" "text/html; charset=shift_jis" ;# Adding a mapping, specifing charset
ns_param ".adp" "text/html; charset=UTF-8" ;# Overriding an existing mapping

: The MIME type to be returned for files with unrecognized or missing extensions can also be specified in the "ns/mimetypes" section of the config file, e.g.

ns_section "ns/mimetypes"
ns_param default "*/*" ;# MIME type for unrecognized extension.
ns_param noextension "*/*" ;# MIME type for missing extension.

: If default is not configured, "*/*" will be returned for files with unrecognized extensions. If noextension is not configured, the MIME type configured as default (or "*/*") will be used.

'''EXAMPLES'''

: (Assuming configured with the examples above)

% ns_guesstype "hello.jpg"
image/jpeg

% ns_guesstype "hello.xls"
application/vnd.ms-excel

% ns_guesstype "hello.html"
text/html; charset=iso-8859-1

% ns_guesstype "world.adp"
text/html; charset=UTF-8

% ns_guesstype "world.doc"
*/*

% ns_guesstype somefile
*/*

----

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

Configuring AOLserver 4 and PostgreSQL on Debian

2006-03-19T03:13:33Z

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

Some might say that AOLserver practically configures itself. But, since that isn't really the case, here are the steps you will go through after installing AOLserver and PostgreSQL.

== AOLserver Configuration ==

<pre>
/etc/aolserver4/aolserver4.tcl
</pre>

* Uncomment the ''ns_section "ns/db/drivers"'' line.
* Uncomment the ''ns_param postgres_driver ...'' line.
* Uncomment the ''ns_section "ns/db/pools"'' line.
* Uncomment the ''ns_param postgres_pool ...'' line.
* Uncomment the entire ''ns_section "ns/db/pool/postgres_pool"'' section, modifying the datasource, user, and password parameters as applicable to your system.

== See also ==

* [[AOLserver 4 on Debian]]
* [[PostgreSQL on Debian]]

Ad13 vs. 3.5.1

2006-03-19T03:13:19Z

Vkurup: Reverted edit of 68.20.219.76, 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-19T03:13:07Z

Vkurup: Reverted edit of 24.98.245.24, changed back to last version by WikiSysop

'' '''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-19T03:12:55Z

Vkurup: Reverted edit of 68.100.158.95, changed back to last version by 64.236.208.25

'' '''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]]

How to set up Sql-Ledger to serve from AOLserver

2006-03-19T03:12:44Z

Vkurup: Reverted edit of 24.154.237.216, changed back to last version by 24.22.122.207

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-19T03:12:25Z

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

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-19T03:12:12Z

Vkurup: Reverted edit of 24.37.179.235, changed back to last version by Caveman

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]]

Ns returnnotfound

2006-03-19T03:11:56Z

Vkurup: Reverted edit of 67.183.149.64, changed back to last version by WikiSysop

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

----

'''NAME'''

: ns_returnnotfound - Return a 404 (Not Found) status message to the client

'''SYNOPSIS'''

: '''ns_returnnotfound''' ''?connid?''

'''DESCRIPTION'''

: This command informs the client that the content they requested could not be located given the URL that was requested.

: The optional ''connid'' parameter is deprecated and should not be used.

: '''Note:''' The script does not end at the time this command is invoked. [[ns_adp_abort]] or [[ns_adp_return]] should be called to end script processing after '''ns_returnnotfound'''.

'''EXAMPLES'''

ns_returnnotfound

'''SEE ALSO'''

: [[ns_return]], [[ns_returnadminnotice]], [[ns_returnbadrequest]], [[ns_returnerror]], [[ns_returnfile]], [[ns_returnforbidden]], [[ns_returnfp]], [[ns_returnnotice]], [[ns_returnok]], [[ns_returnredirect]], [[ns_returnunauthorized]]

----

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

Jk-voting-template

2006-03-19T03:11:43Z

Vkurup: Reverted edit of 71.130.196.168, changed back to last version by WikiSysop

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
}

Jk-voting

2006-03-19T03:11:16Z

Vkurup: rollback

Database Backed Voting Booth

In theory, this is a well commented walk-through of how one might impliment a flexible voting booth in AOLserver. My purpose isn't to provide a plug-in voting booth module but rather to demonstrate one style of AOLserver programming. I don't know what the best way to present this is, so feel free to edit (after all, that's what a wiki is all about).

'''ns_register_proc GET /voting vote_subjects'''

'''ns_register_proc GET /voting/new_subject new_subject'''

'''ns_register_proc GET /voting/place_vote place_vote'''

'''ns_register_proc GET /voting/delete_subject delete_subject'''

'''ns_register_proc GET /voting/dovote dovote'''

'''ns_register_proc GET /voting/view view_vote'''

Ok, mockery of my questionably named procedures aside here is the overview. My preference is to have each .tcl file impliment one collection of related functions. In this case all the code specific to the Voting booth is in one file. I like to put all the ns_register_proc's right at the top so I always know where to look when correlating a URL with it's procedure.

Six URL's for a voting booth might seem excessive, let me explain the purpose of each first and then we'll get to the code itself (the code is the easy part).

''/voting'' -- this is the top-level url for the voting booth. It presents the first voting-related page I want the end users to see. Some folks might prefer /voting.html (which has some advantages, even the dumbest browsers won't have any trouble mime-typing it) but I like to only use .html extentions for static pages. Maybe that's weird.

''/voting/new_subject'' -- When a user wants to add a new subject for voting this is the URL called in the <form action= field (lets see how the wiki handles broken html...). The relevant form values are described in the comments near the "new_subject" procedure. I used to comment form values up here near the ns_register_proc but I've found that when I do that, they don't stay current (my lazyness or an inherent inefficiency problem, I'll declare the latter rather than risking the former).

''/voting/place_vote'' -- this is a badly named url/procedure. It's badly named because it's actually presenting all the possible voting choices, not placing an actual vote. A better name would be "present_choices".

''/voting/delete_subject'' -- I really like to empower users to maintain a web site by themselves. If I leave for a month, I don't want to see piles of cruft. So the voting booth allows whichever user created a given topic to delete it. This is the <form action reciever for a user deleting one of their voting topics.

''/voting/dovote'' -- actually place_vote would be better but I already mis-used that one. This does the actual voting. It's somewhat complex because I want users to be able to change their votes after the fact. The method I'm using to allow for such changes is highly questionable (it works, but I have every reason to believe it doesn't scale). The ability of a site to scale nicely is really underrated. Bad algorithms (like the one I'm using here) can work for a small site with fifty hits a day, but if you get pounded for some reason (slashdot-effect) you're dead in the water. Another important scaling concern isn't hits, but expandability. In this case, if there are more than a couple dozen voting subjects the page gets so cluttered and some of the DB lookups get so slow that the usability of the site is flushed.

''/voting/view'' -- finally a nice simple one. view_vote displays a quick summary of the voting results for a given subject. I tossed in a hack to allow this to also display results immediatly after someone votes with their vote highlighted. Yes, it's a hack. I call it that not because I'm risking DMCA violations but rather because it breaks the paradygm under which the module was designed. /voting/dovote doesn't actually ns_return anything. Instead it hands off to /voting/view; a dangerous choice because a problem might be more difficult to track down (it may not be immediatly apparant if the problem is in dovote or view), resulting in a potential for extra work down the road.

'''Database Schema'''

I can hear the database experts out there groaning. There are a number of flaws (one glaring flaw) in these two tables. I like to create procedures like this because when you're coding by the seat of your pants the schema is going to get tweaked. Dropping the tables and sequences by hand is quick but recreating them is a hassle.

[[jk-voting-force_voting_exist]]

Now for the procedures that make up the voting booth. First the entire vote_subjects procedure then I'll pull it apart and explain the odd parts.

[[jk-voting-vote_subjects]]

I'll be deliriously optimistic and assume that the entire procedure make sense with the exception of these two lines:

set userrow [[user $db $conn]]
append subject_lines [[template "voting_subject.html" $content_set]]

The first calls the "user" procedure which actually checks against a cookie to see who is logged on, validates their password and returns an ns_set of information about the user (simple enough).

The "template" procedure is outragously useful. Here it is:

[[jk-voting-template]]

That's it. It takes a file and an ns_set of key-value pairs. It replaces every instance of %%%%key%%%% with the corresponding value from the ns_set. This lets you create your page in _any_ html editor, just put %%%%keyname%%%% in for anything that needs to be dynamic. The alternatives are ADP or hardcoding html. ADP is a pretty good solution but I like to have a stronger barrier between code and data. Actually the latest Dr Dobbs (Feb 2002) has an article about Zope's approach to this very question.

----

''Why do your own variable interpolation yourself, when you could have just used ns_adp_include of your template files, and used <% ns_set get key %> wherever appropriate, instead? Just curious ...'' -- [[Dossy]]

----

I ought to. ;) It's possible my template procedure is a little faster (no eval), and I can give users access to editing the template files without huge potential for destruction. But I still ought to switch. [[Jason Kane]]

----
In case that wasn't quite clear, here are the templates themselves:

[[jk-voting-voting_subject_page.html]]

[[jk-voting-voting_subject.html]]

Now that we know how to display all the voting topics, we need to actually let people ''vote''. But before they can vote, they need to know what the options are. Since this is slick-n-smooth voting booth, they also need to be able to add new voting options. While we're at it, if this user has already voting on this subject we want to re-present all of the options but default to whatever they chose last time.

See if it happens again

2006-03-18T21:59:47Z

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

A systems engineer, mechanical engineer, and a software engineer are in a car careening down a mountainous road without brakes. The driver is furiously pumping the pedal while he steers the speeding car around the treacherous turns - stones flying and passengers gasping. Finally, he finds an incline and the car coasts to a stop. All three get out and, thanking their lucky stars, begin to assess the situation.

"Oh," says the mechanical engineer, "the brake lines are leaking - lets patch the hole, bleed the brakes and be on our way!"

The systems engineer said "maybe we should consult with the manufacturer and the dealer to ensure that is really the problem."

The software engineer said "why don't we get back in and see if it happens again?"

Ns db

2006-03-18T21:59:32Z

Vkurup: Reverted edit of 69.239.124.88, changed back to last version by WikiSysop

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

----

'''NAME'''

: ns_db - Standard database access API.

'''SYNOPSIS'''

: '''ns_db''' ''option ?arg arg ...?''

'''DESCRIPTION'''

This command provides a mechanism to access databases. The legal ''option''s (which may be abbreviated) are:
* '''ns_db bindrow''' ''dbhandle''
* '''ns_db bouncepool''' ''poolname''

: Marks all database handles for the specified database pool as stale. When any database handle currently open is put back into the pool, its connection to the database will be reset.
* '''ns_db cancel''' ''dbhandle''
* '''ns_db close''' ''dbhandle''

: Closes the connection. Use this function only on handles that were obtained by the '''ns_db open''' function. The server automatically close handles when the operation is complete, so you don't normally have to call this function.
* '''ns_db connected''' ''dbhandle''
* '''ns_db datasource''' ''dbhandle''

: Returns the datasource for the database pool.
* '''ns_db dbtype''' ''dbhandle''

: Returns the database type for the database pool.
* '''ns_db dml''' ''dbhandle sql''
* '''ns_db driver''' ''dbhandle''

: Returns the name of the driver of the handle.
* '''ns_db exception''' ''dbhandle''
* '''ns_db exec''' ''dbhandle sqlcommand''

: Executes the specified SQL command. It returns either NS_DML (if the SQL command is a DML or DDL command) or NS_ROWS (if the SQL command returns rows, such as a SELECT). This function can be used for ad hoc querying, where you don't know what kind of SQL command will be executed.
* '''ns_db flush''' ''dbhandle''
* '''ns_db gethandle''' ''?-timeout timeout? poolname ?nhandles?''
* '''ns_db getrow''' ''dbhandle setId''
* '''ns_db open''' ''driver datasource user password''
* '''ns_db poolname''' ''dbhandle''
* '''ns_db pools'''
* '''ns_db releasehandle''' ''dbhandle''

: Puts the handle back in the pool. The server will automatically return any open handles to the pool after a page has finished executing.
* '''ns_db 1row''' ''dbhandle sql''

: This command expects the SQL to be a select statement that returns exactly one row and returns that row as an ns_set. An error is returned if zero or more than one row is returned.
* '''ns_db 0or1row''' ''dbhandle sql''

: This command expects the SQL to be a select statement that returns exactly zero or one row. On zero rows, a null string is returned. On one row, a newly allocated ns_set is returned. An error is thrown if more then one row is returned.
* '''ns_db password''' ''dbhandle''

: Returns the password of the user for the database pool.
* '''ns_db select''' ''dbhandle sql''
* '''ns_db setexception''' ''dbhandle code message''
* '''ns_db sp_exec''' ''dbhandle''
* '''ns_db sp_getparams'''
* '''ns_db sp_returncode''' ''dbhandle''
* '''ns_db sp_setparam''' ''dbhandle varname vartype inout value''
* '''ns_db sp_start''' ''dbhandle procname''
* '''ns_db user''' ''dbhandle''

: Returns the user for the database pool.
* '''ns_db verbose''' ''dbhandle ?on | off?''

'''EXAMPLES'''

'''SEE ALSO'''

: [[ns_buildsqldate]], [[ns_buildsqltime]], [[ns_buildsqltimestamp]], [[ns_dbquotename]], [[ns_dbquotevalue]], [[ns_localsqltimestamp]], [[ns_parsesqldate]], [[ns_parsesqltime]], [[ns_parsesqltimestamp]], [[ns_writecsv]]

: The tutorial [[Accessing A Database]] shows some very simple '''ns_db''' usage

----

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

Ns cp

2006-03-18T21:59:05Z

Vkurup: Reverted edit of 24.37.179.235, changed back to last version by WikiSysop

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

----

'''NAME'''

ns_cp - Copy one file to another.

'''SYNOPSIS'''

'''ns_cp''' ''?-preserve? file1 file2''

'''DESCRIPTION'''

ns_cp copies the contents of ''file1'' to ''file2'', just like the Unix "cp" command. The default directory is the home directory for the server.

If ''-preserve'' is specified, the copied file will retain the creation time, modification time, owner, and mode of the original file, just like the Unix "cp -p" command.

'''SEE ALSO'''

Tcl [file copy], [[ns_cpfp]]

----

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

Daniel P. Stasinski

2006-03-18T21:58:32Z

Vkurup: Reverted edit of 69.239.124.88, changed back to last version by 207.224.16.158

Daniel P. Stasinski (mailto:daniels@mayorlabs.com, mailto:daniels@avenues.org)

I'm Daniel P. Stasinski, and am currently lead Software Engineer and Internet Development Administrator for Mayor Pharmaceutical Laboratories in Phoenix, AZ. Prior to that I ran a software publishing company (DSE Software Publishing) for about 15 years in a small Northern California town. Needing a change, I sold the product line to various publishers and moved to hot Phoenix.

I've always believed that instead of going only with what you know or which way the wind blows, you use the tool that best suits the project at hand. For my web development needs, AOLserver and TCL have been best. For other needs I usually choose between 80x86 assembler, BASIC, C, Delphi Pascal, java, or perl. A lifetime ago I even chose Prolog for a project solution.

My latest TCL related project is x10bot, a home automation daemon for x10 CM11A appliance controller and accessories under Linux. If you're interested, it can be found at http://www.scriptkitties.com/x10bot/

Other completed projects are the [[ns_encrypt]] module for AOLserver and a TCL plugin for the XChat IRC client.

My most recent AOLserver TCL project was bringing back the old AOLserver Administration Pages to v3.x. These can be found at http://www.scriptkitties.com/ too. Other AOLserver projects included building blowfish and twofish encryption as a shared module and also a Windows DLL. Other assorted projects include a couple megs of custom C and TCL code.

Next on the agenda is a TCL enabled sendmail milter (filter), inspired by the perl sendmail::milter.

My current project is developing my newest site at:

http://www.saidsimple.com/

[[Dossy]] 26apr04: ''Nice blend of wiki, MovableType and Gallery. Looks like you rolled your own WikiEngine? Hope you get lots of mileage out of SaidSimple -- good job.''

[[Category:Person|Stasinski, Daniel P.]]

Kriston J. Rehberg

2006-03-18T21:58:13Z

Vkurup: revert to correct version

<mailto:Kriston@AOL.COM>

Worked for America Online as a Software Engineer from 1996 through 2002.
He can be found at http://kriston.net/

----

[[Category Home Page]]

Kriston J. Rehberg

2006-03-18T21:57:36Z

Vkurup: Reverted edit of 69.246.172.124, changed back to last version by 24.20.162.126

AOLserver Wiki

2006-03-18T21:56:47Z

Vkurup: Reverted edit of 24.115.25.69, changed back to last version by 82.135.77.129

'''[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]].

== 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.
* [[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__

Private C API

2006-03-18T21:56:19Z

Vkurup: Reverted edit of 24.154.233.104, changed back to last version by WikiSysop

When hacking on the core AOLserver itself, the functions defined in the nsd.h header are available, listed below. People writing loadable modules should use the public [[C API]] and [[Tcl API]].
* [[NsAdpCache()]]
* [[NsAdpProc()]]
* [[NsBlockSignals()]]
* [[NsCacheArgProc()]]
* [[NsCachePurge()]]
* [[NsCloseAllFiles()]]
* [[NsClosePreBound()]]
* [[NsClsCleanup()]]
* [[NsComputeEncodingFromType()]]
* [[NsConfigEval()]]
* [[NsConfigRead()]]
* [[NsConfUpdate()]]
* [[NsConnArgProc()]]
* [[NsConnectService()]]
* [[NsConnRunProxyRequest()]]
* [[NsConnThread()]]
* [[NsCreatePidFile()]]
* [[NsEnableDNSCache()]]
* [[NsFastGet()]]
* [[NsFastpathCache()]]
* [[NsFreeConn()]]
* [[NsGetBuf()]]
* [[NsGetCallbacks()]]
* [[NsGetInitServer()]]
* [[NsGetInterp()]]
* [[NsGetScheduled()]]
* [[NsGetServer()]]
* [[NsGetSockCallbacks()]]
* [[NsGetTypeEncodingWithDef()]]
* [[NsHandleSignals()]]
* [[NsInitBinder()]]
* [[NsInitCache()]]
* [[NsInitConf()]]
* [[NsInitDrivers()]]
* [[NsInitEncodings()]]
* [[NsInitListen()]]
* [[NsInitLog()]]
* [[NsInitMimeTypes()]]
* [[NsInitModLoad()]]
* [[NsInitProcInfo()]]
* [[NsInitQueue()]]
* [[NsInitRequests()]]
* [[NsInitSched()]]
* [[NsInitServer()]]
* [[NsInitTcl()]]
* [[NsInitUrlSpace()]]
* [[NsInstallService()]]
* [[NsInterp()]]
* [[NsIsIdConn()]]
* [[NsLoadModules()]]
* [[NsLogOpen()]]
* [[NsMapPool()]]
* [[NsPreBind()]]
* [[NsQueueConn()]]
* [[NsRemovePidFile()]]
* [[NsRemoveService()]]
* [[NsRestoreSignals()]]
* [[NsRunAtClose()]]
* [[NsRunAtExitProcs()]]
* [[NsRunAtReadyProcs()]]
* [[NsRunCleanups()]]
* [[NsRunFilters()]]
* [[NsRunPreStartupProcs()]]
* [[NsRunSignalProcs()]]
* [[NsRunStartupProcs()]]
* [[NsRunTraces()]]
* [[NsSendSignal()]]
* [[NsServer()]]
* [[NsSockClose()]]
* [[NsSockSend()]]
* [[NsStartDrivers()]]
* [[NsStartJobsShutdown()]]
* [[NsStartSchedShutdown()]]
* [[NsStartServers()]]
* [[NsStartShutdownProcs()]]
* [[NsStartSockShutdown()]]
* [[NsStopDrivers()]]
* [[NsStopScheduledProcs()]]
* [[NsStopServers()]]
* [[NsStopSockCallbacks()]]
* [[NsTclArgProc()]]
* [[NsTclCallback()]]
* [[NsTclConnId()]]
* [[NsTclCreateBuckets()]]
* [[NsTclCreateCmds()]]
* [[NsTclInitAddrType()]]
* [[NsTclInitObjs()]]
* [[NsTclInitQueueType()]]
* [[NsTclInitServer()]]
* [[NsTclInitTimeType()]]
* [[NsTclSchedProc()]]
* [[NsTclSignalProc()]]
* [[NsTclSockArgProc()]]
* [[NsTclSockProc()]]
* [[NsTclThread()]]
* [[NsTclThreadArgProc()]]
* [[NsUpdateEncodings()]]
* [[NsUpdateMimeTypes()]]
* [[NsUpdateUrlEncode()]]
* [[NsWaitDriversShutdown()]]
* [[NsWaitJobsShutdown()]]
* [[NsWaitSchedShutdown()]]
* [[NsWaitShutdownProcs()]]
* [[NsWaitSockShutdown()]]

----

[[Category Documentation]] - [[Category Core Private C API]]

C API

2006-03-18T21:55:39Z

Vkurup: Reverted edit of 69.119.228.55, changed back to last version by Caveman

AOLserver public C API for people writing [[modules]].
* [[Ns_AdpParserProc()]]
* [[Ns_ArgProc()]]
* [[Ns_AuthorizeRequest()]]
* [[Ns_AuthorizeUser()]]
* [[Ns_BindSock()]]
* [[Ns_Cache()]]
* [[Ns_CacheCreate()]]
* [[Ns_CacheCreateSz()]]
* [[Ns_CacheFind()]]
* [[Ns_CacheSearch()]]
* [[Ns_Callback()]]
* [[Ns_Cancel()]]
* [[Ns_ClearSockErrno()]]
* [[Ns_CloseOnExec()]]
* [[Ns_Cls()]]
* [[Ns_ConfigGetBool()]]
* [[Ns_ConfigGetInt()]]
* [[Ns_ConfigGetInt64()]]
* [[Ns_ConfigGetPath()]]
* [[Ns_ConfigGetSection()]]
* [[Ns_ConfigGetSections()]]
* [[Ns_ConfigGetValue()]]
* [[Ns_ConfigGetValueExact()]]
* [[Ns_Conn()]]
* [[Ns_ConnCondSetHeaders()]]
* [[Ns_ConnFlushHeaders()]]
* [[Ns_ConnPrintfHeader()]]
* [[Ns_ConnPuts()]]
* [[Ns_ConnReplaceHeaders()]]
* [[Ns_ConnResetReturn()]]
* [[Ns_ConnReturnAdminNotice()]]
* [[Ns_ConnReturnBadRequest()]]
* [[Ns_ConnReturnFile()]]
* [[Ns_ConnReturnForbidden()]]
* [[Ns_ConnReturnHtml()]]
* [[Ns_ConnReturnInternalError()]]
* [[Ns_ConnReturnNoResponse()]]
* [[Ns_ConnReturnNotFound()]]
* [[Ns_ConnReturnNotice()]]
* [[Ns_ConnReturnNotImplemented()]]
* [[Ns_ConnReturnNotModified()]]
* [[Ns_ConnReturnOk()]]
* [[Ns_ConnReturnOpenFile()]]
* [[Ns_ConnReturnRedirect()]]
* [[Ns_ConnReturnStatus()]]
* [[Ns_ConnReturnUnauthorized()]]
* [[Ns_ConnSetExpiresHeader()]]
* [[Ns_ConnSetHeaders()]]
* [[Ns_ConnSetLastModifiedHeader()]]
* [[Ns_ConnSetLengthHeader()]]
* [[Ns_ConnSetRequiredHeaders()]]
* [[Ns_ConnSetTypeHeader()]]
* [[Ns_DecodeUrlCharset()]]
* [[Ns_DRand()]]
* [[Ns_Driver()]]
* [[Ns_DriverCmd()]]
* [[Ns_DriverInit()]]
* [[Ns_DriverInitData()]]
* [[Ns_DriverProc()]]
* [[Ns_DString()]]
* [[Ns_DStringAppend()]]
* [[Ns_DStringAppendElement()]]
* [[Ns_DStringFree()]]
* [[Ns_DStringInit()]]
* [[Ns_DStringLength()]]
* [[Ns_DStringNAppend()]]
* [[Ns_DStringPop()]]
* [[Ns_DStringSetLength()]]
* [[Ns_DStringTrunc()]]
* [[Ns_DStringValue()]]
* [[Ns_DupHigh()]]
* [[Ns_ElemTestProc()]]
* [[Ns_ElemValProc()]]
* [[Ns_ElemVoidProc()]]
* [[Ns_EncodeUrlCharset()]]
* [[Ns_Encrypt()]]
* [[Ns_Entry()]]
* [[Ns_EqualProc()]]
* [[Ns_ExecArgblk()]]
* [[Ns_ExecArgv()]]
* [[Ns_ExecProc()]]
* [[Ns_ExecProcess()]]
* [[Ns_Fatal()]]
* [[Ns_FilterProc()]]
* [[Ns_FreeRequest()]]
* [[Ns_GenSeeds()]]
* [[Ns_GetCharsetEncoding()]]
* [[Ns_GetConn()]]
* [[Ns_GetEncoding()]]
* [[Ns_GetEnviron()]]
* [[Ns_GetFileEncoding()]]
* [[Ns_GetGid()]]
* [[Ns_GetMimeType()]]
* [[Ns_GetProcInfo()]]
* [[Ns_GetRequest()]]
* [[Ns_GetSockAddr()]]
* [[Ns_GetSockErrno()]]
* [[Ns_GetTemp()]]
* [[Ns_GetThreadServer()]]
* [[Ns_GetTypeEncoding()]]
* [[Ns_GetUid()]]
* [[Ns_GetUserGid()]]
* [[Ns_GetVersion()]]
* [[Ns_HeaderCaseDisposition()]]
* [[Ns_HtuuDecode()]]
* [[Ns_HtuuEncode()]]
* [[Ns_Index()]]
* [[Ns_IndexCmpProc()]]
* [[Ns_IndexCount()]]
* [[Ns_InfoAddress()]]
* [[Ns_InfoBootTime()]]
* [[Ns_InfoBuildDate()]]
* [[Ns_InfoConfigFile()]]
* [[Ns_InfoErrorLog()]]
* [[Ns_InfoHomePath()]]
* [[Ns_InfoHostname()]]
* [[Ns_InfoLabel()]]
* [[Ns_InfoNameOfExecutable()]]
* [[Ns_InfoPid()]]
* [[Ns_InfoPlatform()]]
* [[Ns_InfoServerName()]]
* [[Ns_InfoServersStarted()]]
* [[Ns_InfoServerVersion()]]
* [[Ns_InfoShutdownPending()]]
* [[Ns_InfoStarted()]]
* [[Ns_InfoTag()]]
* [[Ns_InfoUptime()]]
* [[Ns_IntPrint()]]
* [[Ns_List()]]
* [[Ns_ListCons()]]
* [[Ns_ListFirst()]]
* [[Ns_ListPush()]]
* [[Ns_ListRest()]]
* [[Ns_LocationProc()]]
* [[Ns_LogRoll()]]
* [[Ns_LogSeverity()]]
* [[Ns_LogTime()]]
* [[Ns_LogTime2()]]
* [[Ns_Match()]]
* [[Ns_ModuleGetSymbol()]]
* [[Ns_ModuleInit()]]
* [[Ns_ModuleInitProc()]]
* [[Ns_ModuleLoad()]]
* [[Ns_ModuleSymbol()]]
* [[Ns_NextWord()]]
* [[Ns_NoCloseOnExec()]]
* [[Ns_OpContext()]]
* [[Ns_OpProc()]]
* [[Ns_PageRoot()]]
* [[Ns_ParseHttpTime()]]
* [[Ns_ParseRequest()]]
* [[Ns_ParseUrl()]]
* [[Ns_PathIsAbsolute()]]
* [[Ns_Pause()]]
* [[Ns_PreQueueProc()]]
* [[Ns_PurgeFiles()]]
* [[Ns_QueueWaitProc()]]
* [[Ns_RegisterFilter()]]
* [[Ns_RegisterProcDesc()]]
* [[Ns_RegisterRequest()]]
* [[Ns_RegisterReturn()]]
* [[Ns_RelativeUrl()]]
* [[Ns_ReleaseTemp()]]
* [[Ns_Request()]]
* [[Ns_RequestAuthorizeProc()]]
* [[Ns_Resume()]]
* [[Ns_RollFile()]]
* [[Ns_RollFileByDate()]]
* [[Ns_SchedProc()]]
* [[Ns_Select()]]
* [[Ns_ServerInitProc()]]
* [[Ns_ServerSpecificAlloc()]]
* [[Ns_ServerSpecificDestroy()]]
* [[Ns_ServerSpecificGet()]]
* [[Ns_ServerSpecificSet()]]
* [[ns_set()]]
* [[Ns_SetCreate()]]
* [[Ns_SetField()]]
* [[Ns_SetKey()]]
* [[Ns_SetLast()]]
* [[Ns_SetName()]]
* [[Ns_SetRequestAuthorizeProc()]]
* [[Ns_SetSize()]]
* [[Ns_SetSockErrno()]]
* [[Ns_SetThreadServer()]]
* [[Ns_SetValue()]]
* [[Ns_Sock()]]
* [[Ns_SockAccept()]]
* [[Ns_SockAsyncConnect()]]
* [[Ns_SockAsyncConnect2()]]
* [[Ns_SockBind()]]
* [[Ns_SockCancelCallback()]]
* [[Ns_SockCloseLater()]]
* [[Ns_SockConnect()]]
* [[Ns_SockConnect2()]]
* [[Ns_SockErrno()]]
* [[Ns_SockError()]]
* [[Ns_SockListen()]]
* [[Ns_SockListenEx()]]
* [[Ns_SockPortBound()]]
* [[Ns_SockProc()]]
* [[Ns_SockRecv()]]
* [[Ns_SockSend()]]
* [[Ns_SockSetBlocking()]]
* [[Ns_SockSetNonBlocking()]]
* [[Ns_SockStrError()]]
* [[Ns_SockTimedConnect()]]
* [[Ns_SockTimedConnect2()]]
* [[Ns_SockWait()]]
* [[Ns_SortProc()]]
* [[Ns_StrCaseFind()]]
* [[Ns_StringPrint()]]
* [[Ns_StrNStr()]]
* [[Ns_StrToLower()]]
* [[Ns_StrToUpper()]]
* [[Ns_StrTrim()]]
* [[Ns_StrTrimLeft()]]
* [[Ns_StrTrimRight()]]
* [[Ns_TclAllocateInterp()]]
* [[Ns_TclCreateInterp()]]
* [[Ns_TclDeAllocateInterp()]]
* [[Ns_TclDeferProc()]]
* [[Ns_TclDestroyInterp()]]
* [[Ns_TclDetachedThread()]]
* [[Ns_TclFreeSet()]]
* [[Ns_TclGetConn()]]
* [[Ns_TclGetOpenChannel()]]
* [[Ns_TclGetOpenFd()]]
* [[Ns_TclGetSet()]]
* [[Ns_TclInit()]]
* [[Ns_TclInitModule()]]
* [[Ns_TclInterpInitProc()]]
* [[Ns_TclInterpServer()]]
* [[Ns_TclLibrary()]]
* [[Ns_TclLogError()]]
* [[Ns_TclMarkForDelete()]]
* [[Ns_TclTraceProc()]]
* [[Ns_Thread()]]
* [[Ns_Time()]]
* [[Ns_TraceProc()]]
* [[Ns_UnRegisterRequest()]]
* [[Ns_UnscheduleProc()]]
* [[Ns_UrlIsDir()]]
* [[Ns_UrlIsFile()]]
* [[Ns_UrlSpecificAlloc()]]
* [[Ns_UrlSpecificDestroy()]]
* [[Ns_UrlSpecificGet()]]
* [[Ns_UrlSpecificGetExact()]]
* [[Ns_UrlSpecificGetFast()]]
* [[Ns_UrlSpecificSet()]]
* [[Ns_UrlToFileProc()]]
* [[Ns_UserAuthorizeProc()]]
* [[Ns_WaitForProcess()]]
* [[Ns_WaitForStartup()]]
* [[Ns_WaitProcess()]]

----

[[Category Documentation]] - [[Category Core Public C API]]

Ad13 vs. 3.5.1

2006-03-18T18:06:41Z

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

AIP 1

2006-03-18T18:06:23Z

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

AIP: 1
Title: AOLserver Improvement Proposal Guidelines
Version: 1.0
Authors: Dossy Shiobara <dossy at panoptic dot com>
incl. [http://www.tcl.tk/cgi-bin/tct/tip/2.html].
State: Draft
Type: Process
Vote: Pending
Created: 04 September 2003

----

'''Abstract'''

This document describes and defines the editorial process a TCT document (TIP) has to go through before accepted as official.

'''What is a TIP?'''

TIP stands for Tcl Improvement Proposal. A TIP is a design document providing information to the Tcl community, or describing a new feature for Tcl. The TIP should provide a concise technical specification of the feature and a rationale for the feature.

We intend TIPs to be the primary mechanisms for proposing new features, for collecting community input on an issue, and for documenting the design decisions that have gone into Tcl. The TIP author is responsible for building consensus within the community and documenting dissenting opinions.

Because the TIPs are maintained as text files under revision control, their history is the historical record of the feature proposal. This historical record is available by the normal (CVS?) commands for retrieving older revisions. For those without direct access to the CVS tree, you can browse the current and past TIP revisions via http://www.cs.man.ac.uk/fellowsd-bin/TIP/ .

Further details on the arguments behind the evolution of the TIP concept and formatting can be found in the archive of the tclcore mailing list at http://aspn.activestate.com/ASPN/Mail/Browse/Threaded/tcl-core .

'''Kinds of TIPs'''

There are three kinds of TIPs. A project TIP describes a new (or significantly updated) feature or implementation for Tcl. An informative TIP describes a Tcl design issue, or provides general guidelines or information to the Tcl community, but does not propose a new feature. A process TIP is like an informative TIP but the provided guidelines are mandatory in a certain context (as specified in the TIP itself).

Voting by the TCT as per the charter (see TIP #0) is required to make a project or process TIP official.

'''TIP Workflow'''

The TIP editor, Donal K. Fellows <fellowsd at cs dot man dot ac dot uk> pro tem, assigns numbers for each TIP and changes its status.

Everyone in the community can submit a TIP to the TIP editor. It should contain at least a proposed title and a rough, but fleshed out, draft of the TIP.

If the TIP editor approves, he will assign the TIP a number, label it as either project, process or informational, give it status Draft, and create and check-in the initial draft of the TIP. The TIP editor will not unreasonably deny a TIP. Reasons for denying TIP status include gross malformatting, inappropriate copyright, duplication of effort, being technically unsound, or not in keeping with the Tcl philosophy; the TCT and after that John Ousterhout <ouster at pacbell dot net> is the final arbitrator of the latter, as defined in the charter (TIP #0).

Discussion concerning a TIP should initially be kept out of the tclcore and tct mailing lists. Instead, comments should be sent to, and collected by, the TIP author, who has the responsibility to incorporate these comments into the document.

Note: It has been proposed to create a new mailing list for each TIP to handle its discussion. Rejection and finalization of the TIP closes the mailing list, but not the archive. Together with the CVS history a complete record of the development of a TIP will be available.

The authors of the TIP are responsible for writing the TIP and marshaling community support for it. The structure of a TIP is described in detail in TIP #3.

A project TIP consists of two parts, a design document and a reference implementation. The TIP should be reviewed and accepted before a reference implementation is begun, unless a reference implementation will aid people in studying the TIP. The implementation can be given in the form of code, patch, or URL to same - before it can be considered Final; small reference implementations may be placed inside the TIP itself, and large reference implementations should be held externally and linked to by reference (typically URL.)

Process and Informational TIPs do not need an implementation.

TIP authors are responsible for collecting community feedback on a TIP before submitting it for review (the creation of a TIP is a part of that review process.) However, wherever possible, long open-ended discussions on public mailing lists should be avoided. A better strategy is to encourage public feedback directly to the TIP author, who collects and integrates the comments back into the TIP.

Once the authors have completed a TIP, they must inform the Tcl Core Team that it is ready for review. TIPs are reviewed by the Tcl Core Team and (for Project TIPs) the maintainers for the relevant parts of the core, who may accept or reject a TIP or send it back to the author(s) for revision (as detailed in TIP #0.) The acceptance or rejection of a TIP will cause its state to be changed accordingly to Accepted or Rejected.

Once a TIP requiring a reference implementation has been accepted, the reference implementation must be completed. When the reference implementation is complete and accepted by the TCT (who can reject it if they feel the implementation would damage the rest of the core) the status will be changed to Final.

A TIP can also be assigned status Deferred. The TIP author or the editor can assign the TIP this status when no progress is being made on the TIP. Once a TIP is deferred, the TIP editor can re-assign it to Draft status.

A TIP can also be Withdrawn by the author. Perhaps after all is said and done, the author believes it was not a good idea. It is still important to have a record of this fact. It is expected that Accepted TIPs will only be withdrawn very rarely, and Final TIPs only under exceptional circumstances.

TIP workflow is as follows:

[http://www.tcl.tk/cgi-bin/tct/tip/2workflow.gif]

Some informative TIPs may also have a status of Active if they are never meant to be completed. For example: TIP #1.

'''What belongs in a successful TIP?'''

Each TIP should have the following parts:

1. Title - a short, descriptive title.

2. Author(s) - names and contact info (email addresses) for each author.

3. Abstract - a short (typically <200 word) description of the technical issue being addressed.

4. Copyright/public domain - Each TIP must either be explicitly labelled in the public domain (the preferred 'license') or the Open Publication License (http://www.opencontent.org/openpub/). It is recommended that this be done by making the last section of the document be a copyright heading, with the body describing what copyright (if any) the document is released under.

5. Specification - Project TIPs should have a technical specification that should describe the syntax and semantics of any new language feature. The specification should be detailed enough to allow (competing) interoperable implementations for any of the current Tcl platforms.

6. Rationale - The rationale fleshes out the specification by describing what motivated the design and why particular design decisions were made. It should describe alternate designs that were considered and related work, e.g. how the feature is supported in other languages.

The rationale should provide evidence of consensus within the community and discuss important objections or concerns raised during discussion.

7. Reference Implementation - The reference implementation must be completed before any TIP requiring such is given status Final, but it need not be completed before the TIP is accepted. It is better to finish the specification and rationale first and reach consensus on it before writing code.

The final implementation must include test code and documentation appropriate for either the Tcl language reference or the standard library reference.

'''TIP Style'''

TIPs are written in plain ASCII text with an RFC822-like header and embedded sequences suitable for Wiki-like processing as indicated in TIP #3.

There are Tcl scripts that convert the TIP into HTML for viewing on the web. Scripts for producing other formats are available too, for example LaTeX and plain ASCII.

'''Sample Project TIP'''

(With thanks to William H. Duquette <William dot H dot Duquette at jpl dot nasa dot gov> for suggesting this.) Note that the TIP Editor is responsible for allocating TIP numbers, so you can leave that unfilled.

TIP: ???
Title: The TIP Title as Plain Text
Version: $Revision: 1.21 $
Author: Author Name <author@somewhere.com>
State: Draft
Type: Project
Tcl-Version: 8.4
Vote: Pending
Created: 31-Feb-1999
Post-History:

'''~ Abstract'''

This is an example of how to write a simple project TIP. This is the
abstract which should consist of a single paragraph of under 200
words. If you need more than this, you should stop and think about
writing a real abstract, not a whole section! :^)

'''~ Some Sections'''

Yada yada yada. Look at the sources to the various TIPs for tricks
on how to do various things. ''Note that for complete legal safety,
you must specify what copyright is used.'' We prefer public domain,
as it allows others (notably the TIP editor(s)) to maintain the TIP
as necessary without having to seek permission.

I also prefer to make sure TIP and section titles are capitalized
according to the usual rules of English.

'''~ Copyright'''

This document has been placed in the public domain.

A more complex example is TIP #7 by Kevin Kenny <kennykb at acm dot org> (the source is at http://www.cs.man.ac.uk/fellowsd-bin/TIP/7.tip) and which includes demonstrations of how to use advanced features like figures and verbatim text. His is a very high quality TIP though, and it has been though several revisions; don't feel too put off if your first attempt isn't quite as good...

'''Patches'''

For preference, patches to Tcl should be stored separately on another website or submitted as a separate file. This is because (quite rightly) the news:comp.lang.tcl.announce moderator does not allow patches to be posted on that newsgroup. If you want a patch to be incorporated into the archive, please contact the TIP Editor.

----

'''Comments'''

Ad13 vs. 3.5.1

2006-03-16T17:28:40Z

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

AIP 1

2006-03-16T17:28:22Z

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

Ns configsection

2006-03-15T21:44:41Z

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

<manpage>ns_configsection</manpage>

'''NAME'''

ns_configsection - Return a handle to an [[ns_set]] for a section of the server's configuration

'''SYNOPSIS'''

'''ns_configsection''' ''section''

'''DESCRIPTION'''

This command returns a handle for an [[ns_set]] which contains all the parameter key-value pairs for the ''section'' from the server's configuration. If the ''section'' is not defined, this command returns an empty string.

'''EXAMPLES'''

% set setId [ns_configsection ns/parameters]
t0

% ns_set name $setId
ns/parameters

% array set a [ns_set array $setId]
% array names a
EnableAdmin MailHost Home Group User debug

'''SEE ALSO'''

[[ns_config]], [[ns_configsections]], [[ns_set]]

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

Ns time

2006-03-15T21:44:14Z

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

<manpage>ns_time</manpage>

'''NAME'''

: ns_time - Perform various time-related functions

'''SYNOPSIS'''

: '''ns_time''' ''?option? ?arg arg ...?''

'''DESCRIPTION'''

: This command provides various time-related functions. The legal ''option''s (which may be abbreviated) are:

* '''ns_time adjust''' ''time''

: Adjusts ''time'' so that it is within the valid range of values for a time. ''(TODO: Figure out how this is actually useful.)''

* '''ns_time diff''' ''time1 time2''

: Computes the time difference between ''time1'' to ''time2''. It does this by subtracting ''time1'' from ''time2'' and returns a string in "sec:usec" format.

* '''ns_time get'''

: Returns the current time in "sec:usec" format.

* '''ns_time incr''' ''time sec ?usec?''

: Increments ''time'' by ''sec'' seconds and optionally ''usec'' microseconds. Returns a string in "sec:usec" format.

* '''ns_time make''' ''sec ?usec?''

: Returns a string in the form "sec:usec". ''usec'' defaults to zero. If ''usec'' is zero, the colon and ''usec'' are not returned. If ''sec'' is zero, however, it is returned as part of the time string.

* '''ns_time seconds''' ''time''

: Parses a time in "sec:usec" format and returns the seconds portion.

* '''ns_time microseconds''' ''time''

: Parses a time in "sec:usec" format and returns the microseconds portion. It assumes zero microseconds if ''time'' only contains seconds.

'''NOTES'''

: All times are relative to 00:00:00 UTC, January 1, 1970 aka the Unix epoch. '''ns_time''' called with no option returns the current time in seconds.

'''EXAMPLES'''

% ns_time
1087006685

% set time [[ns_time get]]
1087013247:598897

% ns_time seconds $time
1087013247

% ns_time microseconds $time
598897

% set time2 [[ns_time incr $time 5 30]]
1087013252:598927

% ns_set diff $time2 $time
5:30

% set time3 [[ns_time make 1087013240 598890]]
1087013240:598890

% ns_time diff $time $time3
7:7

% ns_time diff $time3 $time
-8:999993

% set time3 [[ns_time incr $time3 7 7]]
1087013247:598897

% ns_time diff $time $time3
0

'''SEE ALSO'''

: [[ns_fmttime]], [[ns_gmtime]], [[ns_httptime]], [[ns_localtime]], [[ns_parsehttptime]], [[ns_parsetime]]

[[Category:Core Tcl API]]

AOLserver Improvement Proposals

2006-03-09T13:05:41Z

Vkurup: Reverted edit of Zvgdab, changed back to last version by 87.236.29.207

This page serves as the main index for all AOLserver Improvement Proposals (or, AIPs). The idea and format for AIPs has been shamelessly stolen from the Tcl project and their Tcl Improvement Proposal (TIP) format [http://www.tcl.tk/cgi-bin/tct/tip/].
* [[AIP 1]]: AOLserver Improvement Proposal Guidelines

Nsmaverix

2006-03-03T13:13:52Z

Vkurup: Reverted edit of Ldjwum, changed back to last version by WikiSysop

Authors: [[Vlad Seryakov]] [[Eric Dean]]

This is AOLserver module that implements SMTP protocol and acts as SMTP proxy with anti-spam and anti-virus capabilities. It includes Web interface to manage quarantined messages and administrative interface based on [[OSSWEB]].

Download: http://www.crystalballinc.com/vlad/software/maverix/

AOLserver Improvement Proposals

2006-02-28T19:01:52Z

Vkurup: Reverted edit of Kexxcn, changed back to last version by WikiSysop

Category:Person

2006-02-28T19:01:34Z

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

This category lists all of the pages on this wiki that refers to actual people.

To add a page to this category, add a link to this page, e.g., <nowiki>[[Category:Person|Lastname, Firstname]]</nowiki>.

Nssqlite3

2006-02-28T19:01:00Z

Vkurup: Reverted edit of Krqtum, changed back to last version by WikiSysop

See: [http://cvs.sourceforge.net/viewcvs.py/*checkout*/aolserver/nssqlite3/nssqlite3.html?rev=HEAD SF CVS: nssqlite3/nssqlite3.html]

User talk:Vkurup

2006-01-18T02:06:33Z

Vkurup:

Hi, Vinod, I've gone and added you to the "sysop" group on the wiki, which will allow you to rollback changes made by others, since it seems you're really quick to hit the wiki spam (thanks again, by the way). You can only roll back the most recent change, by going to the diff screen for it (easiest is off the [[Special:Recentchanges]] page, on the top-most edit, clicking the "diff" link on the left-hand side) and on the right-side showing the "current version" will be a little link "[rollback]"). Let me know if you have any questions. Thanks again. ''-- [[User:Dossy|Dossy]] 07:50, 13 January 2006 (EST)''

Thanks Dossy,

Hopefully I'll be able to add something more valuable down the road, but in the meantime, it's easy enough to monitor for spam... [[User:Vkurup|Vkurup]] 21:06, 17 January 2006 (EST)

Help:Contents

2006-01-10T01:47:17Z

Vkurup: removed spam

For help with MediaWiki, please see the [http://meta.wikimedia.org/wiki/MediaWiki_User%27s_Guide MediaWiki User's Guide] or the [http://en.wikipedia.org/wiki/Wikipedia:Tutorial Wikipedia:Tutorial].

{{:Formatting Rules}}

AOLserver Wiki

2006-01-10T01:44:16Z

Vkurup: removed junk

'''[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]].

== 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.
* [[AOLserver User Groups]]

== AOLserver Core Developers ==

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

__NOTOC__

Roadmap

2006-01-05T17:15:28Z

Vkurup: remove spam

'''AOLserver 2005 Roadmap'''

[[Jim Davidson]] has offered the following summary [http://listserv.aol.com/cgi-bin/wa?A2=ind0506&L=aolserver&P=6872] based on the ChangeLog that describes the changes going into AOLserver 4.5:

We should put a page on aolserver.com with some details. We've moved
the version to 4.5 from 4.1 to reflect the scope of changes.
Scanning the ChangeLog and from what I can recall:
* New connection management features including the ns_limits and
ns_pools commands:

-- ns_limits: control # of threads executing and/or waiting for
execution by method/URL

-- ns_pools: map method/URL's to specific thread pools

The idea is to use the two together, e.g., map slow-running db
requests to specific pools and set limits to avoid overload. The
result would be to trap cases where impatient folks press reload when
things are slow, generating quick "try later" responses instead of
gumming up the server.
* I/O features including:

-- A new "Ns_QueueWait" API to enable event-driven callbacks in the
driver thread before dispatching to pools for processing. The model
is to augment data received from the client (headers, request,
content) with additional data fetched over the network (likely stored
in the new Ns_Cls "connection local storage" API's) before
dispatching to the connection threads. An example would be to add
certain personalization data received via a web service. The
rationale here is that I/O events are cheap so do those upfront
instead of having expensive connection threads burdened with wasteful
blocking I/O. This is a somewhat obscure and technical interface.

-- Ability to manage larger file uploads by spooling to a temp file.
This keeps many of the useful functions folks utilize from working
for these large files, in particular auto-parsing of input available
via ns_conn form, but is available for custom apps willing to deal
with the complexity.
* ADP improvements including:

-- A new execution caching technique at the ns_adp_include level
which allows you to save the results of execution of an included ADP
(and includes below that) for reuse on subsequent connections up to a
specified time. Embedded ns_adp_include's with the -nocache flag at
lower levels allow you to still execute dynamic code within cached
blocks if necessary. The goal is to improve performance of pages
which are nearly dynamic, i.e., pages where underlying data really
isn't personalized but instead may change every few minutes or so.
We prototyped this technique at AOL for an app which had these
characteristics and drove transaction throughput from less than 50/
second to well over 400 while still maintaining certain personalized
features of the page.

-- New "singlescript" config option which turns ADP pages into a
single script enabling syntax such as "<% foreach e $list { %>
element <%= $e %> here <% } %>" and treating an error anywhere on the
pages as an error for the full page. Evidently this is more similar
to other execution environments such as JSP. It's a matter of
opinion whether this is a better or worse approach to ADP execution -
the default is off.
* Output buffer improvements via new Ns_ConnFlush:

-- Automatic UTF-8 to output charset encoding

-- Gzip compression

-- Streaming output in chunked-encoding format instead of the
previous "response with no length" HTTP/1.0 method.

Much of the code for Ns_ConnFlush was previously private to ADP. ADP
has been modified to use Ns_ConnFlush and will also automatically
switch into streaming mode when output buffer limits are exceeded
(the previous behavior is to simply keep buffering without limit).
Ns_ConnFlush could be useful to simplify and standardize output from
other execution environments as well, e.g., PHP and Java servlets.
* Tcl improvements including:

-- Cleaned up and well commented core code so folks can understand
the arcane config/resource management approach of Tcl within AOLserver.

-- A new Ns_TclRegisterTrace API to enable callbacks at key state
transition points in a much more natural way. The ns_ictl command
has been updated to support script-level traces.
* A new Ns_Task API designed to replace the old Ns_SockCallback API
which didn't do a very good job at managing timeouts along with I/O
events. The ns_http command has been modified to use Ns_Task (the
old Ns_SockCallback-based ns_http is also still available via
configuration for the paranoid).
* Numerous bug fixes.

Unfortunately, no comprehensive list is maintained of these changes
and the documentation is not yet up to date. Actually, the
documentation hasn't been up to date since version 2.3 which is a
great disappointment for me. However, the ChangeLog has been
maintained quite well so it's possible to get an overview of the
various bug fixes and other minor updates from there.

Dossy and Zoran may recall other new features as they've been active
on the release as well. Overall, I believe we're done with 4.5 and
should tag it, complete the documentation, produce some quality
release notes, and move on to 5.0.

----

'''AOLserver project 2004 Roadmap'''

This document will serve as the roadmap for the AOLserver project and Open Source community for 2004.

N.B.: There is no designation whether any of the tasks necessary to complete items on the roadmap must be performed by an AOL employee or someone from the larger AOLserver community. Ideally, tasks will be completed by whoever is enthusiastic about the work, has the necessary time to commit to completing it as well as the capability. There is no explicit limit to the amount of contribution that can come from any participant in the project.

----

'''Goals and milestones for Q3 2004'''

'''1) Feature roadmap for AOLserver through 2004 and into 2005'''

In order to enable the Open Source community to better participate, it is important that we have a clear list of [[Features]] that should be worked on.

----

'''Goals and milestones for Q2 2004'''

'''1) www.aolserver.com website revamp'''

The project website deserves a more modern look and feel while maintaining the crisp, clean design aspects of the site. The site needs to clearly represent the most current releases and recent changes.

Specific information that should be easily accessible on the website initially:
* what it is
* how it's different
* where is useful, where it's not
* how to get started - basic guide, notes for apache users
* latest source and binary bundles
* basic intro docs and extensive, complete, accurate manpages

''Update on 6/25: aolserver.org and aolserver.net should both point to aolserver.com by the week of 6/28.''

----

'''2) Freshen up documentation'''

Currently available documentation for AOLserver mixes information for 2.3, 3.x and 4.x. All of the documentation needs to be evaluated for correctness and updated where appropriate. Documentation should be made available in at least three formats: plain text, HTML and PDF. All documentation should be readily available from the project website.

The goal is to have a list of all documentation, both what exists and what we still need, by 5/26. From there, the plan is to spend the next 4 weeks verifying or updating documentation. Targeting 6/25 to have documentation for AOLserver 4.0 complete.

''Update on 6/25: [[Tcl API]] effort: 142 out of 228 commands or 62% complete. Work on the [[Tutorials]] and HOWTO sections have also begun. See the [[Documentation]] page for more.''

----

'''3) SourceForge bug and support trackers'''

There are currently 56 open bugs, 3 open support requests, 29 open patches and 8 open feature requests in SourceForge. Attention to these trackers is minimal at best which sends the wrong message about the project's commitment to supporting itself.

The current goal is to ensure that opened requests get assigned to someone within 24-48 hours and resolved in a reasonable timeframe. Resolutions for common problems should be properly documented and published appropriately.

''Update on 6/25: 78 open bugs, 4 open support tickets, 37 open patches, 14 open feature requests.''

''Update on 7/2: Bugs: 78 > 39 (-39 / -50%). Support Requests: 4 > 2 (-2 / -50%). Patches: 39 > 37 (-2 / -5%). RFEs: 14 > 16 (+2 / +13%). Current open bug breakdown by year: 2001 (7), 2002 (4), 2003 (20), 2004 (8).''

''Update on 7/9: Bugs: 39 > 66 (+27 / +41%). Support Requests: 2 > 3 (+1 / 33%). RFEs: 16 > 56 (+40 / +71%). Current open bug breakdown: 2001 (8), 2002 (7), 2003 (24), 2004 (10). The "Patches" tracker at SourceForge has been retired.''

''Update on 7/16: Bugs: 66 > 44 (-22 / -33%). Support Requests: 2 > 2 (0 / NC). RFEs: 56 > 40 (-16 / -28%). Current open bug breakdown: 2001 (8), 2002 (5), 2003 (20), 2004 (11).''

''Update on 7/23: Bugs: 44 > 47 (+3 / 6%). Support Requests: 2 > 2 (0 / NC). RFEs: 40 > 41 (+1 / 2%). Current open bug breakdown: 2001 (8), 2002 (5), 2003 (19), 2004 (15).''

''Update on 9/1: Bugs: 41. Support Requests: 0. Feature Requests: 49. Current open bug breakdown: 2001 (7), 2002 (4), 2003 (13), 2004 (17).''

----

'''4) Better release management of AOLserver'''

While maintaining a ChangeLog and tagging code periodically may be suitable for the developer community, the larger user audience of AOLserver has a varying degree of technical background. Releases need to be managed such that a clear communication accessible to a non-technical background should be able to understand the value contained in the latest code release providing clear and compelling reasons to keep their installations up to date. This same information should also be be published on the project website as well as distributed to the AOLSERVER-ANNOUNCE mailing list.

We need to ensure that changes since the previous release will be collated and prepared along with the actual code release, then published on the wiki and the aolserver.com website. Official releases will be published in source and binary form (when applicable) on the project website via the Project Files section in SourceForge. An update to the AOLserver project record on Freshmeat.net should also be done.

''Update on 7/16: With the bug that slipped into the 4.0.6 release, it's obvious that even a simple automated test suite would prove useful. With that, it's time to start documenting: [[How are releases tested]].''

Release announcements:
* 07 Sep 2004: [http://listserv.aol.com/cgi-bin/wa?A2=ind0409&L=aolserver-announce&P=66 AOLserver 4.0.8]
* 19 Jul 2004: [http://listserv.aol.com/cgi-bin/wa?A2=ind0407&L=aolserver-announce&P=163 AOLserver 4.0.7]
* 16 Jul 2004: [http://listserv.aol.com/cgi-bin/wa?A2=ind0407&L=aolserver-announce&P=61 AOLserver 4.0.6]
* 07 Jun 2004: [http://listserv.aol.com/cgi-bin/wa?A2=ind0406&L=aolserver&P=4884 AOLserver 4.0.5]
* 26 Mar 2004: AOLserver 4.0.3
* 23 Nov 2003: AOLserver 4.0.2
* 20 Nov 2003: AOLserver 4.0.1
* 03 Nov 2003: AOLserver 4.0.0

----

'''5) Establish metrics for measuring success and publish reports on a regular basis'''

There are several simple measurements that we can take that can be automated on a regular schedule (daily, weekly, monthly) and published on the project website. The first metric will be:

Commit frequency per username: number of files affected, lines of code affected.

This serves the purpose of making clear to the community where activity is taking place within the project as well as which individuals are actively involved and participating. Without this, it is unclear from a high level what kind of progress is being made on the project, if any at all, giving people a sense that the project is inactive when that may not actually be the case. Having this metric measured regularly and published will either confirm or dispel this belief and allow us to better manage this issue.

''Update on 7/9: The first [http://article.gmane.org/gmane.comp.web.aolserver/10810 CVS commit stats for June 2004] were posted to the AOLserver mailing list.''

''Update on 9/1: CVS commit stats for [http://article.gmane.org/gmane.comp.web.aolserver/11299 July 2004] and [http://article.gmane.org/gmane.comp.web.aolserver/11300 August 2004] have been posted to the AOLserver mailing list.''

----

'''6) Regular and open communications to the world'''

In order to raise awareness about AOLserver to both attract users and developers, we need regular and open communication with the world. The messages need to be clear, concise and accessible to a wide audience. They need to be sent out regularly to keep the attention of our audience as well as to show steady progress.

----

'''7) Tighter integration of Java into the core execution environment'''

With tighter Java integration into AOLserver, we will be able to leverage more available talent as well as more third-party developed software under AOLserver. There are several efforts to bring Java into AOLserver but the project could benefit from having these separate efforts aligned and deliver a single solution.

Currently, the [[nsjk2]] module is under active development, especially at AOL, for supporting Java/Tomcat with AOLserver.

----

'''8) Win32 platform becomes a first-class citizen again'''

While even the more recent releases of AOLserver can still be built on Win32, the commitment of official support for it was left to the community to resolve. Consider this the resolution: the audience for AOLserver on Win32 should not be diminished without good reason.

''Update on 7/22: The availability of [http://article.gmane.org/gmane.comp.web.aolserver/10927 experimental Win32 binaries] of AOLserver 4.0.7 was sent to the mailing list. Links to downloads are on the [[Downloads]] page.''

Implementing a Mutex Pool

2005-12-21T17:49:08Z

Vkurup: remove spam

In a multi-threaded application, there may be a need to "dynamically" create mutexes for short-lived operations and the natural desire to destroy them once you are done. Creating and destroying mutexes may be a relatively cheap operation, it's still not the best way to do this. Instead, we can simply implement mutex pools and allocate mutexes out of it.

----
Note that this is ''not'' just about performance. Because of the way
the underlying POSIX thread API works, there are strong correctness
reasons for avoiding the regular use of "ns_mutex destroy".
TODO: Add more details about that.
--[[atp]]@piskorski.com, 2004/05/28 19:02 EDT
----

First, we have to determine the size of our mutex pool. We must decide that "we will never handle more than X concurrent requests", where X may be 1000. At server start-up, create 1001 mutexes. Store 1000 of them in a single NSV, where the key is the mutex ID, value an empty string. Store the 1001th mutex in another NSV, with the key being some constant string and the mutex ID being the value. The code may look something like this:

nsv_set guardMutex guard [[ns_mutex create]]
for {set i 0} {$i < 1000} {incr i} {
nsv_set mutexPool [[ns_mutex create]] {}
}

Whenever you need to grab a mutex, you use the NSV to get the mutex ID of that 1001th (guard) mutex, and lock it. Then, you pop a mutex out of the pool, then release the guard mutex. You can then use that popped mutex for the particular request you want to perform:

ns_mutex lock [[nsv_get guardMutex guard]]
set mutex [[lindex [nsv_array names mutexPool]] 0]
nsv_unset mutexPool $mutex
ns_mutex unlock [[nsv_get guardMutex guard]]

(Obviously, you want to add some error checking to make sure that [llength [[nsv_array names mutexPool]]] is not 0 -- in which case, you've exhausted your mutex pool and should either spinwait for a mutex to be returned to the pool, or handle the error however appropriate.)

When the request is done and you're done with the mutex, instead of destroying it, return it to the pool:

ns_mutex lock [[nsv_get guardMutex guard]]
nsv_set mutexPool $mutex {}
ns_mutex unlock [[nsv_get guardMutex guard]]

No destroying of mutexes. Except, at server shutdown, you may want to grab the guard mutex and foreach over all the mutexes in mutexPool and destroy them all. You might want to check the size of the pool and if it's not 1000, you know that not all mutexes have been returned to the pool and you can handle that however you please.

Doing this, we no longer have to create and destroy mutexes all the time. We serialize the mutex pool through a single global guard mutex, but that's not as bad as constantly creating and destroying mutexes.

AOLserver Wiki

2005-12-15T03:19:31Z

Vkurup: removed spam

'''[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]].

== 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.
* [[AOLserver User Groups]]

== AOLserver Core Developers ==

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

__NOTOC__

User talk:Dossy

2005-12-13T13:09:17Z

Vkurup: removed spam

Please feel free to leave comments for me here. Thanks.

AOLserver Wiki

2005-12-13T13:08:38Z

Vkurup: removed spam

'''[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]].

== 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.
* [[AOLserver User Groups]]

== AOLserver Core Developers ==

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

__NOTOC__

AOLserver Packages

2005-12-07T02:22:35Z

Vkurup: Added Darwinports link

I'd like to see the following package formats supported for AOLserver binary distributions:
* RedHat RPM (Some older releases in RPM format are available here [http://openacs.org/software/])
* [[AOLServer 4 on Debian|Debian]] .deb for AOLserver 3 [http://packages.qa.debian.org/a/aolserver.html] and AOLserver 4 [http://packages.qa.debian.org/a/aolserver4.html]
* Solaris .pkg (both /usr/local and /opt)
* FreeBSD ports collection
* NetBSD pkgsrc collection, available for Linux, NetBSD, Solaris, etc [http://www.netbsd.org/Documentation/software/packages.html] The AOLServer package is still in pkgsrc-wip, but builds and runs on NetBSD and Solaris 9 [http://cvs.sourceforge.net/viewcvs.py/pkgsrc-wip/wip/aolserver4/])
* Win32 binaries are available from the [[Downloads]] page
* Darwinports for MacOS X [http://darwinports.opendarwin.org/ports/?by=name&substr=aolserver&Search=Submit+Query]

If you know the names of the popular package mangement facility for other platforms that AOLserver is supported on, please add them to this page. Thanks. '''-D'''

''I have done some reading and can't find any type of windows version, a windows version would be good for testing and dev of sites. I only ask that at some point windows such as NT, 2000 and XP Pro have a version of AOLServer. You guys are working hard and please don't stop. ~sudha''

[[Dossy]] 17feb2005: Sudha, if you look on the [[Downloads]] page, you'll notice two Win32 binary builds are available. They're somewhat outdated now, but I will periodically update the Win32 binary builds.

Vat

2005-11-28T20:53:59Z

Vkurup: Not that kind of VAT

Tcl virtual hosting module, by [[Tom Jackson]].

Has some support for content negotiation and templating[http://zmbh.com/vat/].

User:Vkurup

2005-11-14T13:08:46Z

Vkurup:

== See also ==

* [[Vinod Kurup]]

Ns chan

2005-11-14T13:07:35Z

Vkurup: remove spam

{{manpage|ns_chan}}

'''NAME'''

: ns_chan - Share Tcl channels between threads and interpreters

'''SYNOPSIS'''

: '''ns_chan''' ''option ?arg arg ...?''

'''DESCRIPTION'''

: This command lets you transfer ownership of Tcl channels between threads and interpreters within the AOLserver process.

: AOLserver maintains several internal tables to implement the channel-transfer capability. Each virtual server maintains a private table of shared Tcl channels which are not associated to any particular thread. Each Tcl interpreter maintains a table of currently attached shared channels. Consequently, a shared channel can be in the per-virtual-server private table, or it can be in the interpreter private table, but not both at the same time.

: Furthermore, each shared channel has a user-supplied name. This name is used to track the channel handle in the tables mentioned above. By using the various '''ns_chan''' commands, you can create shared Tcl channels and move them back and forth between the current Tcl interpreter and per-virtual-server private table.

: The legal ''option''s (which may be abbreviated) are:

* '''ns_chan cleanup''' ''?-shared?''

: Closes all shared channels found in the per-virtual-server private table or current Tcl interpreter table, depending on the ''-shared'' flag. If the ''-shared'' flag is not specified, this command will close all channels from the current interpreter which were attached to it by the '''ns_chan get''' command. If the ''-shared'' flag is specified, this command will close all channels from the per-virtual-server private table, i.e., all those which are currently not attached in any Tcl interpreter or thread.

* '''ns_chan create''' ''channel name''

: Given an existing Tcl ''channel'' handle, '''ns_chan create''' "unplugs" this channel from the current interpreter, and stores it under the ''name'' in the per-virtual-server private table. Any further attempt to use this ''channel'' from the current interpreter will fail by throwing a Tcl error. On success, this command will return an empty string. The command also throws an error if the channel cannot be found in the current Tcl interpreter or if an entry already exists with the same ''name'' in the per-virtual-server private table.

* '''ns_chan get''' ''name''

: Retrieves a channel from the per-virtual-server private table for the entry ''name'' and makes it available within the current interpreter. On success, the command will return the handle for the channel. This handle can be used in any regular Tcl or AOLserver command that operates on Tcl channels, like puts, read, fconfigure, etc. The command will throw an error if the channel cannot be plugged in for current interpreter or if the entry ''name'' could not be found in the per-virtual-server private table.

* '''ns_chan list''' ''?-shared?''

: Returns a list of all shared channels found in the per-virtual-server private table or current Tcl interpreter, depending on the ''-shared'' flag. If the ''-shared'' flag is not specified, this command will report all channels from the current interpreter which were attached to it by the '''ns_chan get''' command. If the ''-shared'' flag is specified, this command will report all channels from the per-virtual-server private table, i.e., all those which are currently not attached in any Tcl interpreter or thread.

* '''ns_chan put''' ''name''

: Unplugs a channel from the current interpreter matching entry ''name'' and returns it to the per-virtual-server private table. Any further attempt to use the named channel from the current interpreter will fail by throwing a Tcl error. On success, command will return an empty string. The command will also throw an error if the named channel was never attached to the current interpreter by some previous '''ns_chan get''' command or if the entry ''name'' is already found in the per-virtual-server private table.

'''EXAMPLES'''

<pre>
# In thread #1, create the shared entry.
ns_chan create [open /tmp/ns_chan w] test

# Attach to it in thread #1, and write something to it.
set fd [ns_chan get test]
puts $fd "this is thread #1"

# Detach from it in thread #1.
ns_chan put test

# Now, in thread #2, attach to the channel and write something to it.
set fd [ns_chan get test]
puts $fd "this is thread #2"

# See it in the attached state in thread #2.
ns_chan list ;# => test

# Detach from it in thread #2.
ns_chan put test

# See it back in the per-virtual-server private table.
ns_chan list -shared ;# => test
</pre>

'''SEE ALSO'''

: [[ns_cleanupchans]], [[ns_getchannels]]

[[Category:Core Tcl API]]