Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the ucw Reference Manual, version 0.9, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 06:05:50 2022 GMT+0.
Next: Systems, Previous: The ucw Reference Manual, Up: The ucw Reference Manual [Contents][Index]
-*- outline -*-
This directory contains UnCommon Web (UCW), a Common Lisp web application
platform.
* Getting Started
Well, there's a shortcut nowadays. Marco Baringer made a UCW boxset
with all the dependencies boxed up and ready to fire.
wget http://common-lisp.net/project/ucw/ucw-boxset.tar.gz
tar -zxf ucw-boxset.tar.gz
cd ucw-boxset
YOURLISPHERE (-)-load start.lisp
This will start UCW with the built in httpd server backend. But if you
want to get the dependencies seperately or want a different initial setup,
then read on!
Assuming that every dependency is set up correctly then evaluating
(load (merge-pathnames "etc/start.lisp"
(asdf:component-pathname (asdf:find-system :ucw))))
should start up the examples at http://localhost:8080/
** Dependencies
UCW depends an a number of external libraries:
* arnesi - an all purpose lisp toolkit
* yaclml - yet another common lisp markup language
* parenscript - javascript in common-lisp
* iterate - a lispy loop
* rfc2388 - implements multipart/form specification
* rfc2109 - implements cookie specification
* trivial-garbage - portable weak hashtables and pointers
* bordeaux-threads - portable threads
* split-sequence - splits sequences
* slime - Superior Lisp Interaction Mode for Emacs
* cl-ppcre - regular expressions lib
* cl-l10n - l10n and i18n lib
* trivial-sockets - handles stream sockets for undemanding network
applications
* net.uri or PURI - parses URI's according to the RFC 2396
specification
* cl-fad - a portable pathname library based on code from PCL
* net-telent-date - an RFC822-compliand date parser and printer
* cl-launch - invokes lisp code from the command line
* detachtty - a screen-like detachment tool to be able to detach
and reattach the lisp server from and to a console
* a server backend - be it mod_lisp (apache 1 or 2), araneida,
allegroserve, portable aserve or the built in httpd server
* asdf - a package loader facility
*** arnesi
Arnesi is a Common Lisp utility suite. It contains various "bits 'n
pieces" of code which were useful while developing other code. It can
be found on http://common-lisp.net/project/bese/arnesi.html.
You will need the latest version:
darcs get http://common-lisp.net/project/bese/repos/arnesi_dev/
Daily snapshots are available at
http://common-lisp.net/project/bese/tarballs/arnesi_dev-latest.tar.gz
*** yaclml
yaclml is a collection of macros and utilities for generating XML/HTML
like markup from lisp code. It can be found on
http://common-lisp.net/project/bese/yaclml.html.
You will need the latest version:
darcs get http://common-lisp.net/project/bese/repos/yaclml/
Daily snapshots are available at:
http://common-lisp.net/project/bese/tarballs/yaclml-latest.tar.gz
*** parenscript - ucw version
Parenscript is a javascript compiler. You will need to get the latest
development version:
darcs get http://common-lisp.net/project/ucw/repos/parenscript/
Daily snapshots are available at:
http://common-lisp.net/project/ucw/tarballs/parenscript-latest.tar.gz
*** iterate
Iterate is an iteration construct for Common Lisp. It can be found on
http://common-lisp.net/project/iterate/
Download link:
http://common-lisp.net/project/iterate/releases/iterate-current.tar.gz
*** rfc2388 - ucw version
Rfc2388 is a lisp implemantation of RFC 2388, which is used to process
form data posted with HTTP POST method using enctype
"multipart/form-data".
UCW uses its own fork of rfc2388. You can get the latest code from the
darcs repository located at
http://common-lisp.net/project/ucw/repos/rfc2388:
darcs get http://common-lisp.net/project/ucw/repos/rfc2388/
Daily snapshots are available at
http://common-lisp.net/project/ucw/tarballs/rfc2388-latest.tar.gz
*** rfc2109 - ucw version
Rfc2109 is the lisp implementation of the cookie protocol. You can get
it at: http://common-lisp.net/project/rfc2109/:
darcs get http://common-lisp.net/project/rfc2109/rfc2109
Daily snapshots are available at
http://www.common-lisp.net/project/rfc2109/release/rfc2109-latest.tar.gz
*** split-sequence
splits sequences
info: http://www.cliki.net/SPLIT-SEQUENCE
download: http://ww.telent.net/cclan/split-sequence.tar.gz (you might
have to select a mirror first)
If said link is dead, go to http://ww.telent.net/cclan-choose-mirror
to delete your CCLAN-SITE cookie and choose another mirror. At least
some of them are definitely working.
*** SLIME
The Superior Lisp Interaction Mode for Emacs.
Download and install the latest CVS version of SLIME from
http://common-lisp.net/project/slime.
To checkout from CVS you must first login to the repository:
export CVSROOT=:pserver:anonymous@common-lisp.net:/project/slime/cvsroot
cvs login
Enter anonymous when prompted for the password. You can then check out
the latest version with:
cvs checkout slime
It's swank you want to add to your asd systems dir. To solve a current
problem with cl-launch you might want to overwrite your swank.asd file
with this one:
http://cl-debian.alioth.debian.org/repository/pvaneynd/slime/debian/swank.asd
Check the description on cl-launch to see why.
*** cl-l10n
Localization and internationalization library: http://common-lisp.net/project/cl-l10n/
Get the latest version with:
darcs get http://www.common-lisp.net/project/cl-l10n/repos/cl-l10n
*** cl-ppcre
Edi Weitz's regular expression library: http://www.weitz.de/cl-ppcre/.
Download the latest version: http://weitz.de/files/cl-ppcre.tar.gz
*** trivial-sockets
Networking library to create small server applications. Download the
latest version from: http://ww.telent.net/cclan/trivial-sockets.tar.gz
(you might have to select a mirror first.
If said link is dead, go to http://ww.telent.net/cclan-choose-mirror
to delete your CCLAN-SITE cookie and choose another mirror. At least
some of them are definitely working.
Or use asdf install.
*** net.uri/PURI
All of the backends (except araneida) depend on Franz's open-source
net.uri library. It only works on Allegro but Kevin Rosenberg has made
a portable version called PURI.
For allegro users, NET.URI can be downloaded from here (it may be
included in your version of acl):
http://opensource.franz.com/uri/index.html
If you're not using allegro you'll need puri which can be downloaded
from http://puri.b9.com/download.html
*** cl-fad
A portable pathname library based on code from Peter Seibels book
Practical Common Lisp.
info: http://www.cliki.net/CL-FAD
download: http://weitz.de/files/cl-fad.tar.gz
*** net-telent-date
A library consisting mostly of the time parsing routines from CMUCL
that were removed from SBCL. Additionally it has a universal-time to
rfc822 date convertor.
info: http://www.cliki.net/net-telent-date
download: http://ww.telent.net/cclan/net-telent-date.tar.gz
*** cl-launch
A bash script to make your Lisp software easily invokable from the
shell command-line.
info: http://www.cliki.net/cl-launch
download page: http://fare.tunes.org/files/cl-launch/
Download and add to your shell executable search path so ucw can find
it while loading. Cl-launch can either be called cl-launch or
cl-launch.sh, ucw will check for both. Also cl-launch depends on swank
behavior other than that of the current cvs code, at least under sbcl,
eg via swank-loader it looks for files under the load path, which is not
what you want if you made a symbolic link to another dir. The easiest way
to get around this problem is to overwrite your swank.asd file (in the
slime directory root), with this one:
http://cl-debian.alioth.debian.org/repository/pvaneynd/slime/debian/swank.asd
If you are a Debian user and you got slime/swank through apt-get, you
already have this version on your harddisk/pendrive.
The downside might be that swank won't work anymore as it should,
although i haven't heard anyone about this yet. Another approach is to
copy your swank*.fasls from the slime directory to the relevant shadow
directory under ~/.cache/...
Check this thread for more info:
http://common-lisp.net/pipermail/slime-devel/2006-March/004664.html
Yes, ucw is bleeding edge ;)
*** detachtty - ucw version
A screen-like detachment tool to be able to detach and re-attach the
lisp server from and to a console. Ucw uses a custom detachtty
version, e.g. detachtty-9 plus a patch by Kevin Rosenberg. It accepts
an eval argument when invoking a lisp, with obvious benefits. Get it
through Darcs:
darcs get http://common-lisp.net/project/bese/repos/detachtty/
Go to the directory root and compile and install:
make
make install
** the backend
choose one of mod_lisp/mod_lisp2, araneida, aserve/paserve or the
built-in httpd server
*** mod_lisp/mod_lisp2 for apache
You can choose between apache 1 and 2. First of course you have to
have a Apache web server up and runnnig; then you have to add the
mod-lisp module by Marc Battyani which you find at
http://www.fractalconcept.com/asp/html/mod_lisp.html
First download the mod_lisp c file. Watch out, don't follow the logic
of the website. Except for the windows version the info is outdated
concerning the apache 1 version and info about apache 2 is
non-existent. Go to subversion from the download page or click the
links below:
* apache 1 .c file - mod_lisp.c
* apache 2 .c file - mod_lisp2.c
use the command:
apxs -i -c mod_lisp.c
or
apxs2 -i -c mod_lisp2.c
for respectively apache 1 or 2. This will install the module in the
appropriate apache directory. Then add the following lines to
'httpd.conf' in your apache configuration directory for both apache 1
and 2. Just be sure to change mod_lisp.so to mod_lisp2.so for apache
2:
# This goes near the other LoadModlue directives
LoadModule lisp_module modules/mod_lisp.so
LispServer 127.0.0.1 3001 ucw
SetHandler lisp-handler
This means that ucw INTERNALLY talks to apache on port 3001 at the
internet address 127.0.0.1 (so in this case your localhost). The
locationmatch part redirects all traffic from (in this case) 127.0.0.1
with prefix "/path/" and files ending on .ucw to ucw. So
http://127.0.0.1/path/something.ucw as well as
http://127.0.0.1/path/anotherpath/somethingelse.ucw will be
redirected, but not http://127.0.0.1/somethingfaulty.ucw or
http://127.0.0.1/path/somethingfaulty.html.
*** allegroserve or portableaserve
Should you want to use the aserve backend you will need to download
and install either the AllegroServe if you use acl or portableaserve
for any other. AllegroServe doesn't seem to have an asdf file, you're
going to have to load it manually or however AllegroServe handles it's
own files. Portableaserve does however.
AllegroServe can be downloaded from here (it may be included in your
version of acl): http://opensource.franz.com/aserve/
portableaserve is hosted on sourceforge: http://portableaserve.sf.net
portableaserve download: http://constantly.at/lisp/aserve.tar.gz
To use portableaserve you'll also need the Allegro Common Lisp
compatibility package (acl-compat). It's part of portableaserve and so
it's home is also the before-mentioned sourceforge site.
acl-compat download: http://constantly.at/lisp/acl-compat.tar.gz
*** araneida
Should you want to use the araneida backend you will need to download
araneida. Get the latest version just to be on the safe
side. Originally araneida was meant to live behind apache and it can
of course still be configured as such. Explaining this is beyond the
scope of this document but have a look at this site for more info.
info: http://www.cliki.net/Araneida}
download: http://common-lisp.net/project/araneida/release/araneida-latest.tar.gz
or use darcs, although the connection seems a bit slow:
darcs get http://verisons.telent.net/araneida/
*** httpd
Ucw's in-house server. It's a simple server bundled with ucw. Nice for
testing.
** Setting up ASDF
UCW, and all the libraries it depends on, use ASDF for loading and
compiling the code in the proper order. The first thing you must do is
make sure that ASDF can find the system definitions for ucw and all
the related libraries.
ASDF searches for system definition files by looking in the
directories in the list asdf:*central-registry*. To make a system
definition visible you can either push the name of the directory which
contains the .asd file onto the list asdf:*central-registry* or you
can create a symlink from the .asd file to a directory which is
already in the list asdf:*central-registry*.
For example: on some linux installations the directory
/usr/share/common-lisp/systems is in the list asdf:*central-registry*,
by creating a symlink from a particular .asd file to
/usr/share/common-lisp/systems (ln -s /path/to/library/lib.asd
/usr/share/common-lisp/systems) we guarentee that (adsf:oos
'asdf:load-op :lib) will Just Work(TM).
** Testing UCW
When you have set up all your dependencies correctly, you can test
ucw by first creating either /etc/ucw/applications.d or
/path/to/home/.ucw/applications.d, firing
up your favorite distribution and type:
(load "/path/to/ucw/etc/start.lisp")
If all went well, you have started ucw with the httpd backend. Surf to
\link{\href{http://127.0.0.1:8080}\text{http://127.0.0.1:8080}} and
again if all went well you should see the example page. That's it!
Start hacking!!
To run ucw detached use the ucwctl script under /path/to/ucw/bin/
For an explanation of it's configuration check the ucw-intro html under
/docs/ucw-intro.
* Documentation
Check the docs section for various introductions, tutorials, quickstarts and
code examples. The API documentation is, as much as possible, contained in
the docstrings of the various classes, methods, and packages which make
up UCW itself. Using a good inspector (SLIME's inspector for example)
you should be able to easily navigate and browse the API.
* Developing UCW
Eventually (probably too soon) you'll discover a bug or a missing
feature in UCW and want to fix it. The first thing to do is to send an
email to bese-devel@common-lisp.net and make sure it's a real bug or
missing feature (and not a user or documentation error).
If you do have a bug fix or feature improvement you'd like to submit
there are two ways to go about sending the patch: if the patch is
relativly small than just send a plain old diff or a tar ball of the
arch changeset to the list. If it is bigger, send it to ucw_public
and eventually it will find it's way to ucw_dev. If the change is
bigger than bigger or requires multiple patches over time then branch
off of ucw_dev and publish your repository with your changes.
** Reporting BUGS
The simplest thing you can is just send an email to
bese-devel@common-lisp.net. We keep a collection of all the known bugs
and issues as text files in the directory docs/issues.
*** Using darcs
**** Creating a changeset
# darcs send
or, if you don't have sendmail properly set up;
# darcs send -o CHANGESET
Then just mail the file CHANGESET to bese-devel@common-lisp.net
**** Branching from ucw--dev
You already have a branch. :)
Next: Modules, Previous: Introduction, Up: The ucw Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
UncommonWeb : Standard Components
Drew Crampsie <drewc@tech.coop>
Marco Baringer <mb@bese.it>
BSD (sans advertising clause)
Containts a simple, standard component library.
0.9
src (module).
Core features of UnCommon Web
Marco Baringer <mb@bese.it>
BSD (sans advertising clause)
Contains the base features essential for a useful Read Eval Render Loop (RERL).
0.9
src (module).
Next: Files, Previous: Systems, Up: The ucw Reference Manual [Contents][Index]
Modules are listed depth-first from the system components tree.
Next: ucw/src/ucw-standard, Previous: Modules, Up: Modules [Contents][Index]
ucw (system).
ucw-standard (module).
Next: ucw/src/ucw-standard/application-mixins, Previous: ucw/src, Up: Modules [Contents][Index]
src (module).
Next: ucw/src/ucw-standard/components, Previous: ucw/src/ucw-standard, Up: Modules [Contents][Index]
ucw-standard (module).
Next: ucw/src/ucw-standard/yaclml, Previous: ucw/src/ucw-standard/application-mixins, Up: Modules [Contents][Index]
standard-components.lisp (file).
ucw-standard (module).
Next: ucw-core/src, Previous: ucw/src/ucw-standard/components, Up: Modules [Contents][Index]
standard-tags.lisp (file).
ucw-standard (module).
tal.lisp (file).
Next: ucw-core/src/backend, Previous: ucw/src/ucw-standard/yaclml, Up: Modules [Contents][Index]
ucw-core (system).
Next: ucw-core/src/rerl, Previous: ucw-core/src, Up: Modules [Contents][Index]
src (module).
accept-headers.lisp (file).
Next: ucw-core/src/rerl/standard-component, Previous: ucw-core/src/backend, Up: Modules [Contents][Index]
src (module).
Next: ucw-core/src/core-components, Previous: ucw-core/src/rerl, Up: Modules [Contents][Index]
rerl (module).
Previous: ucw-core/src/rerl/standard-component, Up: Modules [Contents][Index]
rerl (module).
src (module).
window.lisp (file).
Next: Packages, Previous: Modules, Up: The ucw Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: ucw-core/ucw-core.asd, Previous: Lisp, Up: Lisp [Contents][Index]
Next: ucw/src/ucw-standard/standard-package.lisp, Previous: ucw/ucw.asd, Up: Lisp [Contents][Index]
ucw-core (system).
Next: ucw/src/ucw-standard/standard-action.lisp, Previous: ucw-core/ucw-core.asd, Up: Lisp [Contents][Index]
ucw-standard (module).
Next: ucw/src/ucw-standard/standard-dispatchers.lisp, Previous: ucw/src/ucw-standard/standard-package.lisp, Up: Lisp [Contents][Index]
standard-package.lisp (file).
ucw-standard (module).
Next: ucw/src/ucw-standard/standard-tags.lisp, Previous: ucw/src/ucw-standard/standard-action.lisp, Up: Lisp [Contents][Index]
standard-package.lisp (file).
ucw-standard (module).
Next: ucw/src/ucw-standard/standard-components.lisp, Previous: ucw/src/ucw-standard/standard-dispatchers.lisp, Up: Lisp [Contents][Index]
standard-action.lisp (file).
ucw-standard (module).
Next: ucw/src/ucw-standard/file-serve.lisp, Previous: ucw/src/ucw-standard/standard-tags.lisp, Up: Lisp [Contents][Index]
standard-tags.lisp (file).
ucw-standard (module).
Next: ucw/src/ucw-standard/application-mixins/cookie-session-application.lisp, Previous: ucw/src/ucw-standard/standard-components.lisp, Up: Lisp [Contents][Index]
standard-package.lisp (file).
ucw-standard (module).
Next: ucw/src/ucw-standard/application-mixins/secure-application.lisp, Previous: ucw/src/ucw-standard/file-serve.lisp, Up: Lisp [Contents][Index]
application-mixins (module).
Next: ucw/src/ucw-standard/application-mixins/static-roots-application.lisp, Previous: ucw/src/ucw-standard/application-mixins/cookie-session-application.lisp, Up: Lisp [Contents][Index]
application-mixins (module).
Next: ucw/src/ucw-standard/application-mixins/tal-application.lisp, Previous: ucw/src/ucw-standard/application-mixins/secure-application.lisp, Up: Lisp [Contents][Index]
application-mixins (module).
Next: ucw/src/ucw-standard/application-mixins/transactional-application.lisp, Previous: ucw/src/ucw-standard/application-mixins/static-roots-application.lisp, Up: Lisp [Contents][Index]
application-mixins (module).
tal-application-mixin (class).
Next: ucw/src/ucw-standard/components/html-element.lisp, Previous: ucw/src/ucw-standard/application-mixins/tal-application.lisp, Up: Lisp [Contents][Index]
application-mixins (module).
Next: ucw/src/ucw-standard/components/cached.lisp, Previous: ucw/src/ucw-standard/application-mixins/transactional-application.lisp, Up: Lisp [Contents][Index]
components (module).
*xml-id-counter* (special variable).
Next: ucw/src/ucw-standard/components/container.lisp, Previous: ucw/src/ucw-standard/components/html-element.lisp, Up: Lisp [Contents][Index]
components (module).
Next: ucw/src/ucw-standard/components/error.lisp, Previous: ucw/src/ucw-standard/components/cached.lisp, Up: Lisp [Contents][Index]
html-element.lisp (file).
components (module).
Next: ucw/src/ucw-standard/components/option-dialog.lisp, Previous: ucw/src/ucw-standard/components/container.lisp, Up: Lisp [Contents][Index]
components (module).
Next: ucw/src/ucw-standard/components/paged-list.lisp, Previous: ucw/src/ucw-standard/components/error.lisp, Up: Lisp [Contents][Index]
components (module).
Next: ucw/src/ucw-standard/components/redirect.lisp, Previous: ucw/src/ucw-standard/components/option-dialog.lisp, Up: Lisp [Contents][Index]
components (module).
Next: ucw/src/ucw-standard/components/tal.lisp, Previous: ucw/src/ucw-standard/components/paged-list.lisp, Up: Lisp [Contents][Index]
components (module).
render (method).
Next: ucw/src/ucw-standard/components/task.lisp, Previous: ucw/src/ucw-standard/components/redirect.lisp, Up: Lisp [Contents][Index]
components (module).
Next: ucw/src/ucw-standard/components/user-login.lisp, Previous: ucw/src/ucw-standard/components/tal.lisp, Up: Lisp [Contents][Index]
components (module).
Next: ucw/src/ucw-standard/yaclml/tal.lisp, Previous: ucw/src/ucw-standard/components/task.lisp, Up: Lisp [Contents][Index]
components (module).
Next: ucw-core/src/core-package.lisp, Previous: ucw/src/ucw-standard/components/user-login.lisp, Up: Lisp [Contents][Index]
yaclml (module).
render-template (method).
Next: ucw-core/src/helpers.lisp, Previous: ucw/src/ucw-standard/yaclml/tal.lisp, Up: Lisp [Contents][Index]
src (module).
Next: ucw-core/src/loggers.lisp, Previous: ucw-core/src/core-package.lisp, Up: Lisp [Contents][Index]
src (module).
Next: ucw-core/src/vars.lisp, Previous: ucw-core/src/helpers.lisp, Up: Lisp [Contents][Index]
src (module).
defucwlogger (macro).
Next: ucw-core/src/control.lisp, Previous: ucw-core/src/loggers.lisp, Up: Lisp [Contents][Index]
core-package.lisp (file).
src (module).
Next: ucw-core/src/backend/accept-headers.lisp, Previous: ucw-core/src/vars.lisp, Up: Lisp [Contents][Index]
src (module).
Next: ucw-core/src/rerl/protocol.lisp, Previous: ucw-core/src/control.lisp, Up: Lisp [Contents][Index]
backend (module).
parse-accept-language-header (function).
Next: ucw-core/src/rerl/rerl-variables.lisp, Previous: ucw-core/src/backend/accept-headers.lisp, Up: Lisp [Contents][Index]
rerl (module).
Next: ucw-core/src/rerl/rerl-utils.lisp, Previous: ucw-core/src/rerl/protocol.lisp, Up: Lisp [Contents][Index]
rerl (module).
Next: ucw-core/src/rerl/conditions.lisp, Previous: ucw-core/src/rerl/rerl-variables.lisp, Up: Lisp [Contents][Index]
rerl (module).
Next: ucw-core/src/rerl/backtracking.lisp, Previous: ucw-core/src/rerl/rerl-utils.lisp, Up: Lisp [Contents][Index]
protocol.lisp (file).
rerl (module).
Next: ucw-core/src/rerl/request-loop-error.lisp, Previous: ucw-core/src/rerl/conditions.lisp, Up: Lisp [Contents][Index]
basic-classes.lisp (file).
rerl (module).
Next: ucw-core/src/rerl/basic-classes.lisp, Previous: ucw-core/src/rerl/backtracking.lisp, Up: Lisp [Contents][Index]
rerl (module).
Next: ucw-core/src/rerl/basic-action.lisp, Previous: ucw-core/src/rerl/request-loop-error.lisp, Up: Lisp [Contents][Index]
rerl (module).
Next: ucw-core/src/rerl/basic-application.lisp, Previous: ucw-core/src/rerl/basic-classes.lisp, Up: Lisp [Contents][Index]
rerl (module).
Next: ucw-core/src/rerl/standard-component/standard-component.lisp, Previous: ucw-core/src/rerl/basic-action.lisp, Up: Lisp [Contents][Index]
rerl (module).
Next: ucw-core/src/rerl/standard-component/control-flow.lisp, Previous: ucw-core/src/rerl/basic-application.lisp, Up: Lisp [Contents][Index]
standard-component-class.lisp (file).
standard-component (module).
Next: ucw-core/src/rerl/standard-component/standard-component-class.lisp, Previous: ucw-core/src/rerl/standard-component/standard-component.lisp, Up: Lisp [Contents][Index]
standard-component.lisp (file).
standard-component (module).
Next: ucw-core/src/rerl/standard-component/transactions.lisp, Previous: ucw-core/src/rerl/standard-component/control-flow.lisp, Up: Lisp [Contents][Index]
standard-component (module).
Next: ucw-core/src/rerl/basic-dispatchers.lisp, Previous: ucw-core/src/rerl/standard-component/standard-component-class.lisp, Up: Lisp [Contents][Index]
standard-component.lisp (file).
standard-component (module).
Next: ucw-core/src/rerl/standard-request-context.lisp, Previous: ucw-core/src/rerl/standard-component/transactions.lisp, Up: Lisp [Contents][Index]
rerl (module).
Next: ucw-core/src/rerl/standard-server.lisp, Previous: ucw-core/src/rerl/basic-dispatchers.lisp, Up: Lisp [Contents][Index]
rerl (module).
Next: ucw-core/src/rerl/basic-session.lisp, Previous: ucw-core/src/rerl/standard-request-context.lisp, Up: Lisp [Contents][Index]
rerl (module).
Next: ucw-core/src/rerl/standard-session-frame.lisp, Previous: ucw-core/src/rerl/standard-server.lisp, Up: Lisp [Contents][Index]
rerl (module).
Next: ucw-core/src/core-components/window.lisp, Previous: ucw-core/src/rerl/basic-session.lisp, Up: Lisp [Contents][Index]
rerl (module).
Previous: ucw-core/src/rerl/standard-session-frame.lisp, Up: Lisp [Contents][Index]
core-components (module).
Next: Definitions, Previous: Files, Up: The ucw Reference Manual [Contents][Index]
Packages are listed by definition order.
Next: it.bese.ucw.system, Previous: Packages, Up: Packages [Contents][Index]
ucw-core
Next: it.bese.ucw.core.generated, Previous: it.bese.ucw.core, Up: Packages [Contents][Index]
ucw.system
Next: ucw-standard, Previous: it.bese.ucw.system, Up: Packages [Contents][Index]
Next: it.bese.ucw.loggers, Previous: it.bese.ucw.core.generated, Up: Packages [Contents][Index]
ucw
Next: ucw-user, Previous: ucw-standard, Up: Packages [Contents][Index]
ucw-log
defucwlogger (macro).
Next: ucw-tags, Previous: it.bese.ucw.loggers, Up: Packages [Contents][Index]
<ucw
Next: Indexes, Previous: Packages, Up: The ucw Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Symbol macros, Previous: Public Interface, Up: Public Interface [Contents][Index]
The current request-context object.
When rendering this is bound to the current component (the second argument passed to render).
The default, system wide, value for debug-on-error. Applications may override this.
Default action class for MAKE-ACTION
The application object to use when none is explicitly specified.
The server object to use when none is explicitly specified.
When rendering, should we put links next to components that will bring up the inspector?
When T, load the UCW lisp files so that it will be used in a production system.
This means that debug-only blocks are skipped and various variables are initialized accordingly.
While uploading a file the size of the request may go higher then this in which case UCW signals an error. See also the REQUEST-CONTENT-LENGTH-LIMIT slot of BASIC-BACKEND.
Each element of this list is evaluated and should return an application instance. (A CLOS object instance evaluates to itself, so you are free to provide either app instances or expressions evaluating to app instances.)
UCW logger messages below this level will not be compiled into the code, so they will have no performance penalty.
This is the default runtime log level for the UCW loggers.
The asdf systems listed here will be loaded as part of the configuration process.
Next: Macros, Previous: Special variables, Up: Public Interface [Contents][Index]
Next: Ordinary functions, Previous: Symbol macros, Up: Public Interface [Contents][Index]
A Simple <:A which does not require javascript.
Macro for defining a component class.
This macro is used to create component classes and provides
options for easily creating the methods which often accompany a
component definition.
NAME, SUPERS and SLOTS as treated as per defclass. The following
extra options are allowed:
(:ENTRY-POINT url (&key application class)) - Define an
entry-point on the url URL which simply calls an instance of
this component. Any request parameters passed to the entry-point
are used to initialize the slots in the component. This option
may appear multiple times.
(:DEFAULT-BACKTRACK function-designator) - Unless the slots
already have a :backtrack option FUNCTION-DESIGNATOR is
added. As with the ’regular’ :backtrack options if you pass T
here it is assumed to mean #’IDENTITY.
(:RENDER (&optional COMPONENT) &body BODY) - Generate a render
method specialized to COMPONENT. COMPONENT may be a symbol, in
which case the method will be specialized on the componnet
class. If COMPONNET is omited the component is bound to a
variable with the same name as the class.
(:ACTION &optional NAME) - Generate a defmethod/cc form named NAME (which defaults to the name of the component) which simply CALL’s this component class passing all the arguments passed to the action as initargs.
Define an entry point bound to the url URL of type CLASS.
URL must be a string which, when appended to APPLICATION’s
url-prefix, specifies the complete url for this entry
point. CLASS is a symbol naming the dispatcher class.
APPLICATION (evaluated) specifies the application object this
entry point will be attached to. If NIL *default-application*
will be used, otherwise it must be the name of an existing
application.
REQUEST-LAMBDA-LIST is a request lambda list as per
WITH-REQUEST-PARAMS.
The body of the entry-point is executed whenever the server
recieves a request for the specified url. The body can contain
calls to components but must not contain answer forms.
If the backend supports it then the url is
automatically registered with the backend, otherwise (mod_lisp)
developers must manually configure the backend.
A Simple form which does not require javascript.
This macro handles a raw request. Will set the http cache control headers according to the supplied arguments, send the headers, execute the BODY and close the request. WITH-NETWORK-STREAM will be bound to the network stream unless it’s nil. When WITH-YACLML-STREAM is not nil the body will run inside a with-yaclml-stream block and after it finished it will be properly encoded and written into the network stream. Additionally if it is a symbol then it will be bound with that name.
Create a new place around FORM.
Replacement for the standard OPTION tag, must be used with <UCW:SELECT tag. Unlike "regular" OPTION tags the :value attribute can be any lisp object (printable or not).
Makes a new action and registers it in FRAME. For more details see make-action.
Bind, according the REQUEST-LAMBDA-LIST the parameters in
REQUEST and execute BODY.
REQUEST-LAMBDA-LIST is a list of the form:
( [ ( symbol string ) | symbol ]
[ default-value [ supplied-symbol-name ]? ]? )
If the request contains a param (no distinction between GET and
POST params is made) named STRING (which defaults to the symbol
name of SYMBOL) the variable SYMBOL is bound to the associated
value (which is always a string) . If no parameter with that name
was passed SYMBOL will be bound to DEFAULT-VALUE and the variable
named SUPPLIED-SYMBOL-NAME will be bound to NIL.
NB: Parameter names are matched case insensitively.
Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]
Calling it without arguments means a graceful abort, while providing a failure message means there was an error. An ajax request will for example show the FAILURE-MESSAGE in one way or another when provided.
Given an action returns an URL (as a string) which will call
the action lambda.
The COMPONENT parameter is passed directly to COMPUTE-URL, FRAME
is passed to REGISTER-ACTION. ACTION may be a lambda
or an action object made with MAKE-ACTION factory methods.
Sets up a proper request-handling environment around THUNK
Creates and returns a UCW server according to SERVER-CLASS, HOST and
PORT. Affects *DEFAULT-SERVER*.
BACKEND is a list of (BACKEND-TYPE &rest INITARGS). BACKEND-TYPE
may be :HTTPD, :MOD-LISP, an existing
backend, an existing UCW server backend or :DEFAULT in which case
it attempts to return a sane default from the UCW backends loaded
and available, or any other value for which a valid MAKE-BACKEND
method has been defined. INITARGS will be passed, unmodified, to
MAKE-BACKEND.
APPLICATIONS is a list of defined applications to be loaded into the
server.
Logs are generated in verbosity defined by LOG-LEVEL and directed to LOG-ROOT-DIRECTORY if defined.
Convenience wrapper around session.value.
SESSION defaults to the current session.
Convience wrapper around (setf session.value).
SESSION defaults to the current session.
Makes a new unregistered action.
Returns the part of the context’s request’s query-path after the context’s application’s url-prefix. NB: The returned value shares structure with the query-path. NB: We assume the proper application has already been placed in CONTEXT.
Makes a new callback and registers it in FRAME. For more details see make-callback.
Write SEQUENCE into the network stream and clean up the request. SEQUENCE may be a string or a byte vector. When it’s a string it will be encoded according to what the (encoding response) protocol answers.
Generates a unique DOM id
Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
Isolated actions are invalidated after the first call.
Return control to CALLEE’s CALLER, continuing
with the value VALUE.
answer-component can be called by user code though it will generally be called through the UCW:ANSWER function.
Check user credentials to call TO by FROM in APPLICATION.
Validate PASSWORD against USER for APPLICATION.
Find USER by USERNAME for APPLICATION.
Default charset for sent text/html documents.
A list of request
dispatchers. The user supplied list of dispatchers is extended
with other dispatchers that are required for UCW to function
properly (action-dispatcher, a parenscript-dispatcher, etc). If
you want full control over the active dispatchers use the (setf
application.dispatchers) accessor or, if you want control over
the order of the dispathcers, (slot-value instance
’dispatchers).
A list of request
dispatchers. The user supplied list of dispatchers is extended
with other dispatchers that are required for UCW to function
properly (action-dispatcher, a parenscript-dispatcher, etc). If
you want full control over the active dispatchers use the (setf
application.dispatchers) accessor or, if you want control over
the order of the dispathcers, (slot-value instance
’dispatchers).
automatically generated reader method
automatically generated writer method
automatically generated reader method
automatically generated writer method
A list of (URL-subdir . pathname)
pairs to use when looking for static files. This follows
standard CL pathname syntax i.e. you must include a
trailing / in both the URL-subdir and pathname.
Returns the url prefix (a string) for APPLICATION.
The URL prefix is that string which, when used as the prefix of an incoming http query path, identifies an application.
A string specifying the
start (prefix) of all the urls this app should handle.
This value is used by the standard-server to decide what app a particular request is aimed at and for generating links to actions within the app.
A string specifying the
start (prefix) of all the urls this app should handle.
This value is used by the standard-server to decide what app a particular request is aimed at and for generating links to actions within the app.
This protocol is started when we are ready to call the action.
If the action was found to be valid then the default implementation simply funcalls
the action wrapped in an error handler.
The base method simply funcalls the action.
Call all the callbacks in REQUEST for FRAME.
Methods defined on this generic function must be built up from using map-parameters (part of the backend protocol). Return nil iff there were no callbacks executed.
Execute all the callback lambda in CONTEXT’s request.
Simply goes through the request’s params and, for every param
which isn’t +action-parameter-name+, +frame-parameter-name+ or
+session-parameter-name+, looks up and call the associated lambda
in the current frame. Makes sure dependent callbacks are executed after
their dependencies.
Transfer control from the component CALLER, to
the component CALLEE.
CALLEE should replace CALLER in the user interface (by setting
itself in CALLER’s place). CALLEE can return control to CALLER by
calling answer-component.
call-component can be called by user code even though it will generally be called through the UCW:CALL function.
cc-standard.
Passes control to the TO when there is no current (FROM) component. This method is called in dispatchers, actions should always have a FROM component.
Transfer control from FROM to the component TO.
This method grabs the current continuation (and so doesn’t return
normally) passes it to TO and puts TO in FROM’s place (by
modifying FROM’s component.place).
This method does not return normally but simply stops the execution of the current action and returns when TO answers.
cc-standard.
Return the children of a component.
Find all children components of the given components.
This will only return children components that were declared on the class
as a component and have components in those slots.
This method is called when the server is done
with REQUEST. If any shared resources were grabbed during the
request handling they should be freed.
A string holding the output to use
for this component. This string will be written
directly to the html stream.
Returns T if COMPONENT’s cache is invalid.
The component which transfered control to this component.
When this component ANSWERs it returns control to the calling-component and modifes the associated place. Only in the case of top level components will this slot be NIL.
The component which transfered control to this component.
When this component ANSWERs it returns control to the calling-component and modifes the associated place. Only in the case of top level components will this slot be NIL.
The place (a PLACE object) which holds this component.
Only in the case of top level component will this slot be NIL.
Return a URL with the proper session, frame and action-id parameters.
Walks up the component tree based at COMPONENT and calls UPDATE-URL on the components.
Appends the session and frame parameters UCW needs to find the session and the frame.
Creates the default url for APP which, when requested, will
cause the action to be called.
The generated URL’s path will be the app’s url-prefix.
This method assumes that the container was initialized with #’identity as key generator.
Returns two values: (VALUE T) if the set actually happenend,
or (VALUE NIL) if the given component is already the current component.
The key of the current component.
automatically generated reader method
automatically generated writer method
Accessor for the application object in CONTEXT.
automatically generated reader method
automatically generated writer method
Return the "current" (most recent) session-frame in CONTEXT’s session.
Simply call session.current-frame on context’s session object.
Simply call (setf session.current-frame) on context’s session object.
Accessor for the request object in CONTEXT.
automatically generated reader method
automatically generated writer method
Accessor for the response object in CONTEXT.
automatically generated reader method
automatically generated writer method
Accessor for the session object in CONTEXT.
automatically generated reader method
automatically generated writer method
Return the "current" (most recenct) window component in CONTEXT’s session.
Returns the cookies in this request in a sequence.
Returns T if APPLICATION should attempt to debug errors (instead of just returning an error page).
automatically generated reader method
Method used when there is no current application or its debug-on-error slot is unbound.
automatically generated writer method
Remove the session SESSION from APPLICATION.
User code may not call this function directly, see MARK-SESSION-INVALID if you want to mark a session invalid.
Entry point into a dispatcher. Must return T
if the context has been handled or NIL if it hasn’t.
No methods defined on this function may rebind *context*, nor change CONTEXT’s application. Only if the method returns T is it allowed to modify CONTEXT or APPLICATION, even in that case methods defined on this function must not modify CONTEXT’s application nor rebind *context*.
Return a symbol representing the desired encoding when writing strings into the network stream.
Makes sure the context has a valid session,
set it to NEW-SESSION if there’s none. Returns the session.
If CONTEXT’s request specifies a session then put it in the
context, otherwise create a new context.
Updates the session’s last-access time.
cc-standard.
Delete session and throw user away to entry point.
Same as find-session-id but looks for the action id.
Returns the client supplied session-id in CONTEXT.
Methods should inspect the context’s request object and return a
string specifying the session-id. No guarantee on the
validity (well-formedness or existence) of the returned
session-id is made.
If no session-id is supplied NIL must be returned.
Returns the value of the GET or POST parameter named +session-parameter-name+
automatically generated reader method
id.
automatically generated writer method
id.
Accessor for SESSION-FRAME’s window component.
The root component for this
frame. The standard-server calls render on this component when
the frame is ready to be presented to the user.
The root component for this
frame. The standard-server calls render on this component when
the frame is ready to be presented to the user.
Return the value of the header named HEADER-NAME.
HEADER-NAME must be a string and will be compared case sensitvly
agaist the headers in the message.
Callers are not allowed to modify the value returned by GET-HEADER.
Change the value of the header named
HEADER-NAME. Like in get-header HEADER-NAME must be a
string.
Returns the query value, a string or a list of
strings, associated with the name PARAMETER-NAME. As with
GET-HEADER callers are not allowed to modify the value retruned
by this function.
Determines how a UCW action is processed.
This method is called when a valid session was identified or created and
an action needs to be executed in that session (this includes entry points, too).
This method can be a central point for user code to hook into, for app specific purposes like setting up a db transaction, etc.
wrapping-standard.
Perform one iteration of the RERL on REQUEST and RESPONSE.
Methods defined on this generic function must be built from the methods associated-application and service and should, as much as possible, handle all conditions signalled by calls to service.
Process a condition that reached the UCW toplevel.
If this function returns it means that the callers must try to clean up
and continue.
Called when the dispatchers finds a
maching request. This function must be a zero arg’ed
(lambda ()
...)
Function to run when this
entry-point-handler runs. This handler is a
zero-arged.
Abstract function for handler classes to
implement the handling of the matched request.
These methods may modify context as they wish since they are matched, request will be closed after this method is run.
Returns whether the headers are already written to the network stream or not.
automatically generated reader method
automatically generated writer method
automatically generated reader method
automatically generated writer method
automatically generated reader method
automatically generated writer method
Return the stream we can write html output to.
This stream may be cached in order to provide an accurate Content-Length header.
Transfer control of the window to TARGET.
This method, unlike call-component, drops the backtrack and component stack and clears the session table. TARGET will be placed in the current frame’s window-component (and so sholud be a window-component or similar). Using the backbutton or accessing previously cloned windows will no longer work.
automatically generated reader method
lock.
automatically generated reader method
lock.
automatically generated reader method
lock.
automatically generated writer method
lock.
automatically generated writer method
lock.
automatically generated writer method
lock.
cc-standard.
cc-standard.
Delete user but stay at the same place.
Returns a UCW server backend as requested by
the functional arguments. BACKEND-SPEC may be :HTTPD, :MOD-LISP,
an existing backend, an existing UCW server backend or :DEFAULT
in which case it attempts to return a sane default from the UCW
backends loaded and available.
Create a new request-context form REQUEST and RESPONSE.
The returned context will have its application, request and
response slots set to APPLICATION, REQUEST and RESPONSE.
This method need not neccessarily return a new object each time but may reuse previouly created objects in which case a call to clear-context must be made before returning the object.
Apply LAMBDA to all the parameters in REQUEST.
LAMBDA will be passed two arguments: the name of the parameter, a string, and the value of the parameter, a string or a list of strings. The values are passed in that order and LAMBDA must not modify any of the values passed to it.
Abstract method for subclasses to implement a
matcher. This method would return multiple-values according to
matcher internal nature, but the first return value is always
used to indicate if this matcher matched.
No methods defined on this function may rebind *context*, nor change CONTEXT’s application. Only if the method matches the request, it is allowed to modify CONTEXT or APPLICATION, even in that case methods defined on this function must not modify CONTEXT’s application nor rebind *context*.
Returns two values to handler on success: the whole match as a string plus an array of substrings (or NILs) corresponding to the matched registers.
Returns matched url-string to handler.
Returns matched url-string to handler.
Returns the body of MIME-PART.
Returns an alist of the headers of MIME-PART.
The alist must be of the form (NAME . VALUE) where both NAME and VALUE are strings.
Return the stream attached to the client’s browser.
Any bytes written to this stream are sent immediatly to the client (though buffering issues may arise).
automatically generated reader method
automatically generated writer method
Called whenever COMPONENT’s cache is updated. It is safe to override the primary method.
This is called after the session has been deleted.
While this method is called the application is not locked (so it’s ok to grab external resouces) but the session is.
cc-standard.
Returns true if VIEW has a page after the current one.
Returns true if VIEW has a page before the current one.
Which of the pages we’re currently looking at.
automatically generated reader method
automatically generated writer method
automatically generated reader method
Returns the parent of COMPONENT.
Only window components and detached components may return NIL from this function.
automatically generated reader method
automatically generated writer method
Return the QUERY-PATH of REQUEST as a string.
The returned string may share structure with objects in the request and sholud be considered read-only. The returned query-path must be already escaped.
This generic action is should simply redraw COMPONENT without performing any action.
It can be used as the :action parameter to forms which have
multiple submit buttons and we don’t want hitting the enter key
to call one of the actions.
cc-standard.
Register an action in the frame and return its id.
Registers a callback-entry in this frame and return the callback itself.
When passed in an action generated by FRAME then CALLBACK will be called passing it the value of the corresponding request param.
Registers a callback-entry in this frame. When passed in an
action generated by FRAME then CALLBACK will be called passing it the value of
the corresponding request param.
The generic entry point for rendering components to the user.
wrapping-standard.
Render a template based component.
The name of the template is the value returned by the generic function
TAL-COMPONENT.TEMPLATE-NAME, the template will be rendered
in the environment returned by the generic function
TAL-COMPONENT-ENVIRONMENT.
Wrap component in a <span> tag.
Wrap component in a <div> tag.
This convience method assumes: 1) the stylesheet is
external (as opposed to inlined) or is not used; 2) the script
file is javascript and is external or is no script is used and 3)
the title is either a literal or a lambda with one argument (the
window).
Setup up a convience restart, bind *yaclml-stream* and add inspector links.
Render a single element of a paged-list.
Standard implementation of RENDER-PAGED-LIST-ITEM. Simply applies ITEM to princ (via <:as-html).
Returns a list of the context mixin classes.
Custom implementations should look something like this: (defmethod request-context-class list ((app your-application)) ’your-request-context-mixin)
list.
:most-specific-first
cc-standard.
Calls shutdown-application and then startup-application on APPLICATION.
Calls shutdown-application and then startup-application on APP.
cc-standard.
cc-standard.
cc-standard.
cc-standard.
cc-standard.
Does APPLICATION require authorized access.
Sends all the headers in RESPONSE to the
client. Unlike the send-response method we don’t add a
Content-Length header, though if one is present in RESPONSE it
will be sent.
After calling this method the response data, a sequence of bytes, should be sent to RESPONSE’s network-stream.
Assuming RESPONSE is complete send it to the
client. When calling this function we assume all headers have
already been set and the body’s content has been collected in
the response object.
Return a list of all the application objects SERVER manages.
automatically generated reader method
automatically generated writer method
automatically generated reader method
automatically generated writer method
automatically generated reader method
automatically generated writer method
The core request handling generic function.
The service protocol consists of 4 passes: application -> session -> session-frame -> action. At each phase the appropriate object is passed to service with the current request object (which is also bound to *context*). The appropiate object must perform whatever it needs and then explicitly call service again passing it the next object in the chain.
Returns a list of the session mixin classes.
Custom implementations should look something like this: (defmethod session-class list ((app your-application)) ’your-session-mixin)
list.
:most-specific-first
Returns a list of the session frame mixin classes.
Custom implementations should look something like this: (defmethod session-frame-class list ((session your-session-class)) ’your-session-frame-mixin)
list.
:most-specific-first
The owner session of this component. A component may only be used in one session at a time.
UCW guarantees to only call this function from inside HANDLE-ACTION (and therefore with the session being locked) to check if the session is valid.
This method is similar to SESSION-EXPIRED-P but users can install more heavyweight customizations on it and assume being wrapped by HANDLE-ACTION and WITH-LOCK-HELD-ON-SESSION.
Returns the id of SESSION.
An ID is a unique (within the same application) object identifying SESSION.
automatically generated reader method
id.
automatically generated writer method
id.
Terminate the application’s life cycle.
Release any and all resources held by APPLICATION. The value returned by the generic function is unspecified.
Make SERVER stop responding to requests and close/release and resources.
First call SHUTDOWN-APPLICATION on all the apps registered with SERVER, then call SHUTDOWN-BACKEND on SERVER’s backend.
action which gets called automatically when
task-component is active. Use defmethod/cc to define your specialized
"start" methods
cc-standard.
Start the application’s request-eval-response loop.
Simply clears out the app’s session-table.
Make SERVER start responding to requests.
Startup SERVER. This calls startup-backend on the server’s backend and startup-application on all the application objcets registered with SERVER.
cc-standard.
cc-standard.
Create the TAL environment for rendering COMPONENT’s template.
Methods defined on this generic function must return a TAL environment: a list of TAL binding sets (see the documentation for YACLML:MAKE-STANDARD-TAL-ENVIRONMENT for details on TAL environments.)
nconc.
:most-specific-first
Create the basic TAL environment.
Binds the symbol ucw:component to the component object itself, also puts the object COMPONENT on the environment (after the binding of ucw:component) so that slots are, by default, visable.
Prepare URL for rendering as action urls.
Each component can define a method on UPDATE-URL to add component-specific parameters. This is generally coupled with a url-dispatcher to create bookmark-able urls.
Do nothing to the URL.
automatically generated reader method
automatically generated writer method
automatically generated reader method
automatically generated writer method
automatically generated reader method
body.
automatically generated writer method
body.
Unless nil it’s printed <:as-is before any other output. Suitable for <?xml...?> lines.
Either use slot value, or compute content-type from current application charset.
The Content-Type header for the
http response (also used in the meta tag)
The Content-Type header for the
http response (also used in the meta tag)
Doctype for this window.
A yaclml attribute list that’ll be rendered into the <:html tag’s attributes.
Optional URL for an icon.
icon.
List of javascript includes.
Each element must be a list whose first value is either the
symbol :SRC or :JS.
(:SRC url) - writes <script src="URL"></script> tag.
(:JS form) - equivalent to (:SCRIPT (js:js* form))
(:SCRIPT string) - write <script>STRING</script>.
The elements will be rendered in order.
The URL of the css file to use as a stylesheet for this window.
automatically generated reader method
automatically generated writer method
Next: Classes, Previous: Generic functions, Up: Public Interface [Contents][Index]
sb-mop.
it.bese.arnesi.
sb-mop.
sb-mop.
it.bese.arnesi.
:after initialization function for standard-component-class objects.
Setup the proper values in component-class.backtrack-slots and component-class.component-slots in CLASS based on the effective slots of CLASS.
sb-mop.
asdf/action.
Perform the standard initialization for C.
This method registers C’s transaction slot for backtracking and any other slot which has been declared as backtracked. It then proceeds to initialize any component slots in C.
This method sets up any initial contents for backtacking. If the contents are created via (setf find-component) then the backtracking is done there.
Make sure the non-visible contained components are detached (their parent is nil).
sb-mop.
Declare that standard-component-classes can be sub classes of standard-class.
sb-mop.
Previous: Standalone methods, Up: Public Interface [Contents][Index]
funcallable-standard-object.
(lambda nil (error "no action function"))
:lambda
This is the core dispatcher for ucw. Due to
how ucw’s COMPUTE-URL method works it is important that the
action-dispatcher be checked before any url-dispatchers, so it
should be the first element in an application’s dispatcher
list.
| Initarg | Value |
|---|---|
| :priority | +action-dispatcher-default-priority+ |
Invalid actions are never called anymore.
boolean
t
Isolated actions are invalidated after the first call.
boolean
:isolated
A UCW application.
Application objects are responsible for:
- Managing a collection of sessions and finding the right session for a given request.
- Managing session life time (session creation and expiration).
- Creating request contexts.
- Managing dispatchers and associating them to request objects.
- Creating http query paths which subsequently (when requested)
call action lambdas.
Since application objects are used to create sessions (via
make-new-session) they are also important when customizing the
functionality of the RERL.
| Initarg | Value |
|---|---|
| :call-render | t |
boolean
t
:call-callbacks
boolean
:call-render
boolean
t
:make-new-frame
The base UCW application class.
| Initarg | Value |
|---|---|
| :dispatchers | (list (make-instance (quote action-dispatcher))) |
Default charset for sent text/html documents.
:utf-8
:charset
A list of request
dispatchers. The user supplied list of dispatchers is extended
with other dispatchers that are required for UCW to function
properly (action-dispatcher, a parenscript-dispatcher, etc). If
you want full control over the active dispatchers use the (setf
application.dispatchers) accessor or, if you want control over
the order of the dispathcers, (slot-value instance
’dispatchers).
:dispatchers
The table of session-frame objects generated in this session.
(make-instance (quote it.bese.ucw.core::frame-queue) :size it.bese.ucw.core::+session-backtracking-max-depth+)
:id
(get-universal-time)
:last-access
(trivial-garbage::make-hash-table :test (quote eql))
:object-pool
A cumulated hashtable of all the ALLOCATED-BACKTRACKS of each frame.
When a new frame is created, only these backtracks are cloned. When a frame is
dropped, its ALLOCATED-BACKTRACKS are remhash’s from here. Because weak pointers
are too expensive for this.
(trivial-garbage::make-hash-table :test (function eq))
bordeaux-threads.
Caches the class of the effective session frame.
Component which caches its output.
0
The component caching protocol consists of the generic functions
COMPONENT-CACHE-INVALID-P, REFRESH-COMPONENT-OUTPUT, and
NOTE-CACHE-UPDATED. Caching is managed in a :wrapping method on RENDER.
A string holding the output to use
for this component. This string will be written
directly to the html stream.
The generic super class of all components.
Allow multiple components to share the same place.
The container component serves to manage a set of components.
It does not provide any render impementation, which is the
resposibility of the subclasses (e.g. switching-container or
list-container).
Each contained component has a "key" associated with it which
is used to retrieve a particular component. Keys are compared with
container.key-test.
The :contents inintarg, if provided, must be either a list of (key . component) or a list of components. In the latter case it will be converted into (component . component) form.
An alist of (key . component) holding the controlled components.
(quote nil)
:contents
A lambda that generates the keys from a component when they are not specified
(function identity)
:key-generator
Function used to compare two keys.
(function eql)
:key-test
Class for applications which use cookies for sesion tracking.
Cookie session applications work exactly like standard-applications except that when the session is not found using the standard mechanisms the id is looked for in a cookie.
Dispatchers will be checked from
highest-priority to lowest priority. The default
values for priority on the various classes assume
this is a positive integer less than
most-positive-fixnum.
0
:priority
This handler is used to handle entry-points.
Function to run when this
entry-point-handler runs. This handler is a
zero-arged.
:handler
Generic component for showing server side error messages.
"[no message specified]"
:message
Abstract handler class.
A component which should be wrapped in a <div>.
An HTML element.
HTML elements control aspects that are relevant to almost all tags.
They provide a place to store the class, id, and style of the component. The specific render methods of the components themselves must pass these values to whatever code is used to render the actual tag.
A component which should be wrapped in a <span>
A simple renderable container component.
This component is exactly like the regular CONTAINER but provides
an implementation of RENDER which renders its contents in <:ol/<:li tags
| Initarg | Value |
|---|---|
| :css-class | ucw-list-container |
| :orientation | horizontal |
:horizontal
:orientation
Abstract matcher class.
A dispatcher which does as little work as
possible. The handler function must do basically
everything (including shutdowning down request and response).
| Initarg | Value |
|---|---|
| :priority | +minimal-dispatcher-default-priority+ |
Render the component every HITS views.
Component for querying the user.
The value of the slot MESSAGE is used as a general heading.
The OPTIONS slot must be an alist of (VALUE . LABEL). LABEL (a
string) will be used as the text of a link which, when clikced,
will answer VALUE.
If the CONFIRM slot is T the user will be presented with a second OPTION-DIALOG asking the user if they are sure they want to submit that value.
Component for showing the user a set of data one "page" at a time.
The data set is presented one "page" at a time with links to the the first, previous, next and last page. Each page shows at most PAGE-SIZE elements of the data. The data is passed to the paged-list at instance creation time via the :DATA initarg.
The generic function RENDER-PAGED-LIST-ITEM is used to render
each item of DATA.
In order to change the rendering of the single elements of a range view developer’s should create a sub class of PAGED-LIST and define their RENDER-PAGED-LIST-ITEM methods on that.
Which of the pages we’re currently looking at.
0
:offset
(quote nil)
This slot is read-only.
20
:page-size
A "pointer" or "locative", an object encapsulating a settable and readable place
Matches URL using a cl-ppcre regular expression. Captured registers are available via ‘ucw:*dispatcher-registers*’
| Initarg | Value |
|---|---|
| :priority | +regex-dispatcher-default-priority+ |
Generic superclass for all HTTP requests.
The generic super class of all request contexts.
A request-context object contains all the information associated with one particular request/response loop. The request context is usually accessed via the special variable *context* and contains the currently relevant application, session, session-frame, request and response object.
Generic superlcass for all HTTP responses.
An HTTP response has, other than the headers, two streams:
1) the html-stream - This is a character based stream which can
be used to send ISO-8859-1 characters to the client.
2) the network-stream - This is the binary (unsigned-byte 8) stream attached directly to the client’ browser.
SEND-RESPONSE for unmanaged responses is a no-op.
t
Mixin class for applications which require authorized access.
Concrete application must specialize the following methods:
APPLICATION-FIND-USER (APPLICATION USERNAME)
APPLICATION-CHECK-PASSWORD (APPLICATION USER PASSWORD)
APPLICATION-AUTHORIZE-CALL (APPLICATION USER FROM-COMPONENT TO-COMPONENT).
Class of component for user login.
It must return authenticated USER data or NIL on answer.
(quote ucw-standard:user-login-window)
:login-component
Calls to these components are never checked.
(quote (ucw-standard:error-message-window))
:insecure-components
This class of dispatchers avoids all of UCW’s
standard call/cc (and therefore frame/backtracking/component)
mechanism.
Unlike all other UCW dispatchers a simple-dispatcher must not use CALL, and must perform the rendering directly within the handler.
| Initarg | Value |
|---|---|
| :priority | +simple-dispatcher-default-priority+ |
:environment
(quote ucw-standard:standard-action)
:action-class
Super class of all standard components.
Our continuation (a 1 arg lambda)
:continuation
The component which transfered control to this component.
When this component ANSWERs it returns control to the calling-component and modifes the associated place. Only in the case of top level components will this slot be NIL.
:calling-component
The place (a PLACE object) which holds this component.
Only in the case of top level component will this slot be NIL.
:place
A flag whether the component was invalidated (which means that it needs rendering).
This slot is read-only.
The owner session of this component. A component may only be used in one session at a time.
(it.bese.ucw.core:context.session it.bese.ucw.core:*context*)
This slot is read-only.
:parent
The meta class for standard-components.
Classes defined with this meta-class have extra slot options, see the class STANDARD-COMPONENT-DIRECT-SLOT for details.
standard-class.
A list of effective-slot-definition’s that are backtracked.
A list of effective-slot-definition’s that are component slots.
:place-slot
:request
:response
:application
:session
:action
bordeaux-threads.
(bordeaux-threads:make-lock "server lock")
:started
:backend
A hash table mapping action ids to 0 argument functions.
(trivial-garbage::make-hash-table :test (quote equal))
A hash table mapping callback ids to 1 argument functions.
(trivial-garbage::make-hash-table :test (quote equal))
The root component for this
frame. The standard-server calls render on this component when
the frame is ready to be presented to the user.
:window-component
:id
The places allocated in this frame.
(make-array 16 :adjustable t :fill-pointer 0)
PLACE -> VALUE mapping of the effective backtracked places.
(trivial-garbage::make-hash-table :test (function eq))
:effective-backtracks
it.bese.arnesi.
:body
| Initarg | Value |
|---|---|
| :priority | +starts-with-dispatcher-default-priority+ |
A list of (URL-subdir . pathname)
pairs to use when looking for static files. This follows
standard CL pathname syntax i.e. you must include a
trailing / in both the URL-subdir and pathname.
:static-roots
A simple renderable container component.
This component is like the regular CONTAINER but serves to manage a set of components which share the same place in the UI. Therefore it provides an implementation of RENDER which simply renders its current component.
The switching-container component class is generally used as the super
class for navigatation components and tabbed-pane like
components.
The key of the current component.
:current-component-key
This slot is read-only.
Component for providing the user with a standard "tabbed pane" GUI widget.
| Initarg | Value |
|---|---|
| :css-class | ucw-tabbed-pane |
| :key-test | (function string=) |
A tal-generator object used to
lookup and compile tal pages for template-components.
it.bese.yaclml.
:tal-generator
Component which is rendered via a TAL template.
:template-name
A controller for a single task or operation to
be performed by the user.
A task component’s START action is called as soon as the component is instantiated. Task components do not have their own RENDER method, in fact they have no graphical representation but serve only to order a sequence of other components.
Render the component at most every EXPIRES-AFTER seconds.
| Initarg | Value |
|---|---|
| :expires-after | (* 30 60 60) |
The time, exrpessed as a
universal time, when the component was last rendered.
Number of seconds the cache is valid.
:expires-after
:scheme
:host
:port
:path
:query
:fragment
| Initarg | Value |
|---|---|
| :priority | +url-dispatcher-default-priority+ |
Matcher used to match url-string exactly (using string=).
:url-string
User login component.
A container window componenet for the user-login.
| Initarg | Value |
|---|---|
| :title | user login |
(make-instance (quote ucw-standard:user-login))
:user-login
module to mix with your application in order to track logged in and out users.
(quote nil)
:online-users
The Content-Type header for the
http response (also used in the meta tag)
:content-type
Previous: Public Interface, Up: Definitions [Contents][Index]
Next: Special variables, Previous: Internals, Up: Internals [Contents][Index]
The maximum size of the cache of Accept-Language header over which the hashtable is cleared.
Length, in chars, of the automatically generates action ids.
UTF-8 is the semi-standard encoding for URL:s
RFC 2396 does not specify how multi-byte characters are encoded, but mentions UTF-8 as an example.
RFC 2718 Strongly recommends UTF-8 for new URI-schemes.
RFC 3987 The IRI (International Resource Identifier) proposed standard specifies UTF-8.
The Javascript ECMA standard specifies that the conversion functions (EncodeURI et al.) use UTF-8,
http://www.ecma-international.org/publications/files/ecma-st/ECMA-262.pdf
Length, in chars, of the automatically generated frame ids.
The maximum size of the Accept-Language header value that is accepted.
Length, in chars, of the automatically generated session ids.
Session key for user’s authorization data.
Next: Symbol macros, Previous: Constants, Up: Internals [Contents][Index]
Holder variable used for the copy-down link in the inspector links. not thread safe (but good enough for single user debugging).
Seconds of inactivity allowed before a basic-session object is expired.
Seconds of minimal delay between looking for expired sessions.
Used for file uploads, too.
The external formats used for url-unescaping, slime and http(via swank) intercommunication
Contains the l10n resource names that should be sent to the client side js.
A universal-time timestamp updated when the registry was last modified.
UCW will render a ’503 Service Unavailable’ when there are this many live sessions in an application and new ones are coming.
When ‘t’ display local variables in error log backtrace
This parameter identifies an invocation of an action (to be used when the action is invocation-isolated-p)