[claw-cvs] r55 - in trunk/main/claw-core: . src tests

Author: achiumenti Date: Thu Jul 17 09:11:41 2008 New Revision: 55

Added: trunk/main/claw-core/src/connector.lisp trunk/main/claw-core/src/logger.lisp trunk/main/claw-core/src/session-manager.lisp Modified: trunk/main/claw-core/claw-tests.asd trunk/main/claw-core/claw.asd trunk/main/claw-core/src/components.lisp trunk/main/claw-core/src/i18n.lisp trunk/main/claw-core/src/lisplet.lisp trunk/main/claw-core/src/misc.lisp trunk/main/claw-core/src/packages.lisp trunk/main/claw-core/src/server.lisp trunk/main/claw-core/src/tags.lisp trunk/main/claw-core/src/translators.lisp trunk/main/claw-core/src/validators.lisp trunk/main/claw-core/tests/packages.lisp trunk/main/claw-core/tests/test1.lisp Log: commit of version 0.1.0

Modified: trunk/main/claw-core/claw-tests.asd ============================================================================== --- trunk/main/claw-core/claw-tests.asd (original) +++ trunk/main/claw-core/claw-tests.asd Thu Jul 17 09:11:41 2008 @@ -31,7 +31,7 @@ :name "claw-tests" :author "Andrea Chiumenti" :description "Tests for cl-webobjects" - :depends-on (:claw) + :depends-on (:claw :hunchentoot-connector) :components ((:module tests :components ((:file "packages") (:file "test1" :depends-on ("packages"))

Modified: trunk/main/claw-core/claw.asd ============================================================================== --- trunk/main/claw-core/claw.asd (original) +++ trunk/main/claw-core/claw.asd Thu Jul 17 09:11:41 2008 @@ -31,16 +31,19 @@ :name "claw" :author "Andrea Chiumenti" :description "Common Lisp Active Web.A famework to write web applications" - :depends-on (:closer-mop :hunchentoot :alexandria :cl-ppcre :cl-fad :local-time :split-sequence :parenscript) - :components ((:module src + :depends-on (:closer-mop :alexandria :cl-ppcre :cl-fad :local-time :split-sequence :parenscript :bordeaux-threads :flexi-streams :md5) + :components ((:module src :components ((:file "packages") - (:file "misc" :depends-on ("packages")) + (:file "mime-type" :depends-on ("packages")) + (:file "misc" :depends-on ("mime-type")) (:file "i18n" :depends-on ("packages")) (:file "locales" :depends-on ("i18n")) - (:file "hunchentoot-overrides" :depends-on ("packages")) - (:file "tags" :depends-on ("misc")) + (:file "connector" :depends-on ("misc")) + (:file "logger" :depends-on ("misc")) + (:file "session-manager" :depends-on ("misc")) + (:file "tags" :depends-on ("misc")) (:file "components" :depends-on ("tags")) (:file "validators" :depends-on ("components")) (:file "translators" :depends-on ("validators")) - (:file "server" :depends-on ("components")) + (:file "server" :depends-on ("components")) (:file "lisplet" :depends-on ("server"))))))

Modified: trunk/main/claw-core/src/components.lisp ============================================================================== --- trunk/main/claw-core/src/components.lisp (original) +++ trunk/main/claw-core/src/components.lisp Thu Jul 17 09:11:41 2008 @@ -79,10 +79,10 @@ (defvar *file-translator* nil "*FILE-TRANSLATOR* is the default translator for any CINPUT component of type "file".")

-(defun component-validation-errors (component &optional (request *request*)) +(defun component-validation-errors (component) "Resurns possible validation errors occurred during form rewinding bound to a specific component" (let ((client-id (htcomponent-client-id component))) - (getf (validation-errors request) (intern client-id)))) + (getf (validation-errors) (intern client-id))))

;--------------------------------------------------------------------------------

@@ -285,6 +285,7 @@ (writer (cinput-writer cinput)) (validator (validator cinput)) (value (translator-decode (translator cinput) cinput))) +; (log-message :info "********************* ~a : ~a" cinput value) (unless (or (null value) (component-validation-errors cinput)) (when validator (funcall validator value))

Added: trunk/main/claw-core/src/connector.lisp ============================================================================== --- (empty file) +++ trunk/main/claw-core/src/connector.lisp Thu Jul 17 09:11:41 2008 @@ -0,0 +1,261 @@ +;; -*- Mode: LISP; Syntax: COMMON-LISP; Package: CL-USER; Base: 10 -*- +;;; $Header: src/connector.lisp $ + +;;; Copyright (c) 2008, Andrea Chiumenti. All rights reserved. + +;;; Redistribution and use in source and binary forms, with or without +;;; modification, are permitted provided that the following conditions +;;; are met: + +;;; * Redistributions of source code must retain the above copyright +;;; notice, this list of conditions and the following disclaimer. + +;;; * Redistributions in binary form must reproduce the above +;;; copyright notice, this list of conditions and the following +;;; disclaimer in the documentation and/or other materials +;;; provided with the distribution. + +;;; THIS SOFTWARE IS PROVIDED BY THE AUTHOR 'AS IS' AND ANY EXPRESSED +;;; OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +;;; WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +;;; ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +;;; DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +;;; DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE +;;; GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +;;; INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +;;; WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +;;; NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +;;; SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +(in-package :claw) + +(defgeneric connector-host (connector) + (:documentation " +Returns the value of the incoming Host http header. (This corresponds to the environment variable HTTP_HOST in CGI scripts.)")) + +(defgeneric connector-request-method (connector) + (:documentation "Returns the request method as a keyword, i.e. something like :POST. (This corresponds to the environment variable REQUEST_METHOD in CGI scripts.)")) + +(defgeneric connector-script-name (connector) + (:documentation "Returns the file name (or path) component of the URI for request, i.e. the part of the string returned by REQUEST-URI in front of the first question mark (if any). +(This corresponds to the environment variable SCRIPT_NAME in CGI scripts.)")) + +(defgeneric connector-request-uri (connector) + (:documentation "Returns the URI for request. +Note that this not the full URI but only the part behind the scheme and authority components, so that if the user has typed http://user:password@www.domain.com/xxx/frob.html?foo=bar into his browser, this function will return "/xxx/frob.html?foo=bar". (This corresponds to the environment variable REQUEST_URI in CGI scripts.")) + +(defgeneric connector-query-string (connector) + (:documentation "Returns the query component of the URI for request, i.e. the part of the string returned by REQUEST-URI behind the first question mark (if any). +(This corresponds to the environment variable QUERY_STRING in CGI scripts.) See also CONNECTOR-GET-PARAMETER and CONNECTOR-GET-PARAMETERS.")) + +(defgeneric connector-get-parameter (connector name) + (:documentation "Returns the value of the GET parameter (as provided via the request URI) named by the string name as a string (or NIL if there ain't no GET parameter with this name). +Note that only the first value will be returned if the client provided more than one GET parameter with the name name. See also CONNECTOR-GET-PARAMETERS")) + +(defgeneric connector-get-parameters (connector) + (:documentation "Returns an alist of all GET parameters (as provided via the request URI). The car of each element of this list is the parameter's name while the cdr is its value (as a string). +The elements of this list are in the same order as they were within the request URI. See also CONNECTOR-GET-PARAMETER.")) + +(defgeneric connector-post-parameter (connector name) + (:documentation "Returns the value of the POST parameter (as provided in the request's body) named by the string name. +Note that only the first value will be returned if the client provided more than one POST parameter with the name name. +This value will usually be a string (or NIL if there ain't no POST parameter with this name). +If, however, the browser sent a file through a multipart/form-data form, the value of this function is a three-element list + +(path file-name content-type) + +where path is a pathname denoting the place were the uploaded file was stored, file-name (a string) is the file name sent by the browser, and content-type (also a string) is the content type sent by the browser. +The file denoted by path will be deleted after the request has been handled - you have to move or copy it somewhere else if you want to keep it.")) + +(defgeneric connector-post-parameters (connector) + (:documentation "Returns an alist of all POST parameters (as provided via the request's body). The car of each element of this list is the parameter's name while the cdr is its value. The elements of this list are in the same order as they were within the request's body. +See also CONNECTOR-POST-PARAMETER.")) + +(defgeneric connector-parameter (connector name) + (:documentation "Returns the value of the GET or POST parameter named by the string name as a string (or NIL if there ain't no parameter with this name). +If both a GET and a POST parameter with the name name exist, the GET parameter will be returned. See also CONNECTOR-GET-PARAMETER and CONNECTOR-POST-PARAMETER.")) + +(defgeneric connector-header-in (connector name) + (:documentation "Returns the incoming header named by the keyword name as a string (or NIL if there ain't no header with this name). +Note that this queries the headers sent to Hunchentoot by the client or by mod_lisp. +In the latter case this may not only include the incoming http headers but also some headers sent by mod_lisp. +For backwards compatibility, name can also be a string which is matched case-insensitively. See also CONNECTOR-HEADERS-IN.")) + +(defgeneric connector-headers-in (connector) + (:documentation "Returns an alist of all incoming headers. +The car of each element of this list is the headers's name (a Lisp keyword) while the cdr is its value (as a string). +There's no guarantee about the order of this list. See also CONECTOR-HEADER-IN and the remark about incoming headers there.")) + +(defgeneric connector-authorization (connector) + (:documentation "Returns as two values the user and password (if any) from the incoming Authorization http header. +Returns NIL if there is no such header.")) + +(defgeneric connector-remote-addr (connector) + (:documentation "Returns the IP address (as a string) of the client which sent the request. (This corresponds to the environment variable REMOTE_ADDR in CGI scripts.) See also CONNECTOR-REAL-REMOTE-ADDR.")) + +(defgeneric connector-remote-port (connector) + (:documentation "Returns the IP port (as a number) of the client which sent the request.")) + +(defgeneric connector-real-remote-addr (connector) + (:documentation "Returns the value of the incoming X-Forwarded-For http header as the second value in the form of a list of IP addresses and the first element of this list as the first value if this header exists. +Otherwise returns the value of CONNECTOR-REMOTE-ADDR as the only value.")) + +(defgeneric connector-server-addr (connector) + (:documentation "Returns the IP address (as a string) where the request came in. +(This corresponds to the environment variable SERVER_ADDR in CGI scripts.)")) + +(defgeneric connector-server-port (connector) + (:documentation "Returns the IP port (as a number) where the request came in.")) + +(defgeneric connector-server-protocol (connector) + (:documentation "Returns the version of the http protocol which is used by the client as a Lisp keyword - this is usually either :HTTP/1.0 or :HTTP/1.1. +(This corresponds to the environment variable SERVER_PROTOCOL in CGI scripts.")) + +(defgeneric connector-user-agent (connector) + (:documentation "Returns the value of the incoming User-Agent http header. +(This corresponds to the environment variable HTTP_USER_AGENT in CGI scripts.)")) + + +(defgeneric connector-referer (connector) + (:documentation "Returns the value of the incoming Referer (sic!) http header. (This corresponds to the environment variable HTTP_REFERER in CGI scripts.)")) + +(defgeneric connector-cookie-in (connector name) + (:documentation "Returns the value of the incoming cookie named by the string name (or NIL if there ain't no cookie with this name). +See also CONNECTOR-COOKIES-IN")) + +(defgeneric connector-cookies-in (connector) + (:documentation "Returns an alist of all incoming cookies. +The car of each element of this list is the cookie's name while the cdr is the cookie's value. See also CONNECTOR-COOKIE-IN")) + +(defgeneric connector-aux-request-value (connector symbol) + (:documentation "Returns values VALUE, PRESENTP. +This accessor associates arbitrary data with the the symbol symbol in the REQUEST object request. +PRESENTP is true if such data was found, otherwise NIL")) + +(defgeneric (setf connector-aux-request-value) (value connector symbol) + (:documentation "This accessor can be used to associate arbitrary data with the the symbol symbol in the REQUEST object request.")) + +(defgeneric connector-delete-aux-request-value (connector symbol) + (:documentation "Completely removes any data associated with the symbol symbol from the REQUEST object request. Note that this is different from using AUX-REQUEST-VALUE to set the data to NIL")) + +;;--------------------------- + +(defgeneric connector-header-out (connector name) + (:documentation "Returns the outgoing http header named by the keyword name if there is one, otherwise NIL (name parameter must be a symbol). +Note that the headers Set-Cookie, Content-Length, and Content-Type cannot be queried by HEADER-OUT. +See also CONNECTOR-HEADERS-OUT, CONNECTOR-CONTENT-TYPE, CONNECTOR-CONTENT-LENGTH, CONNECTOR-COOKIES-OUT, and CONNECTOR-COOKIE-OUT")) + +(defgeneric (setf connector-header-out) (value connector name) + (:documentation "SETF of HEADER-OUT changes the current value of the header named name (name parameter must be a symbol). +If no header named name exists it is created. +Note that the headers Set-Cookie, Content-Length, and Content-Type must not be set by SETF of HEADER-OUT. +Also, there are a couple of "technical" headers like Connection or Transfer-Encoding that you're not supposed to set yourself. +See also CONNECTOR-HEADERS-OUT, CONNECTOR-CONTENT-TYPE, CONNECTOR-CONTENT-LENGTH, CONNECTOR-COOKIES-OUT, and CONNECTOR-COOKIE-OUT")) + +(defgeneric connector-headers-out (connector) + (:documentation "Returns an alist of all outgoing http parameters (except for Set-Cookie, Content-Length, and Content-Type). +The car of each element of this list is the headers's name while the cdr is its value. +This alist should not be manipulated directly, use SETF of CONNECTOR-HEADER-OUT instead")) + +(defgeneric connector-cookie-out (connector name) + (:documentation "Returns the outgoing cookie named by the string name (or NIL if there ain't no cookie with this name). +See also CONNECTOR-COOKIES-OUT and the CLAW-COOKIE class definition.")) + +(defgeneric (setf connector-cookie-out) (cookie-instance connector name) + (:documentation "Creates a CLAW-COOKIE object from the parameters provided to this function and adds it to the outgoing cookies of the REPLY object reply. +If a cookie with the same name (case-sensitive) already exists, it is replaced. + The default for value is the empty string.")) + +(defgeneric connector-cookies-out (connector) + (:documentation "Returns the outgoing cookie named by the string name (or NIL if there ain't no cookie with this name). +See also CONNECTOR-COOKIES-OUT and the CLAW-COOKIE class definition.")) + +(defgeneric connector-return-code (connector) + (:documentation "CONNECTOR-RETURN-CODE returns the http return code of the reply. The return code of each REPLY object is initially set to 200 (OK)")) + +(defgeneric (setf connector-return-code) (value connector) + (:documentation "Setf CONNECTOR-RETURN-CODE sets the http return code of the reply.")) + +(defgeneric connector-content-type (connector) + (:documentation "CONNECTOR-CONTENT-TYPE returns the outgoing Content-Type http header (such as: "text/html; charset=utf-8").")) + +(defgeneric (setf connector-content-type) (value connector) + (:documentation "SETF CONNECTOR-CONTENT-TYPE sets the outgoing Content-Type http header (such as: "text/html; charset=utf-8").")) + +(defgeneric connector-reply-external-format-encoding (connector) + (:documentation "CONNECTOR-REPLY-EXTERNAL-FORMAT-ENCODING returns the symbol of the reply charset encoding (Such as UTF-8).")) + +(defgeneric (setf connector-reply-external-format-encoding) (value connector) + (:documentation "SETF CONNECTOR-REPLY-EXTERNAL-FORMAT-ENCODING sets the symbol of the reply charset encoding (Such as UTF-8).")) + +(defgeneric connector-writer (connector) + (:documentation "Returns the output stream writer to generate replies. It's default to *standard-output*")) + +(defgeneric connector-redirect (connector target &key host port protocol add-session-id code) + (:documentation "Sends back appropriate headers to redirect the client to target (a string). +If target is a full URL starting with a scheme, host, port, and protocol are ignored. +Otherwise, target should denote the path part of a URL, protocol must be one of the keywords :HTTP or :HTTPS, and the URL to redirect to will be constructed from host, port, protocol, and target. +If code is a 3xx redirection code, it will be sent as status code. +In case of NIL, a 302 status code will be sent to the client. If host is not provided, the current host (see CONNECTOR-HOST) will be used. +If protocol is the keyword :HTTPS, the client will be redirected to a https URL, if it's :HTTP it'll be sent to a http URL. +If both host and protocol aren't provided, then the value of protocol will match the current request.")) + +(defgeneric connector-content-length (connector) + (:documentation "Returns the outgoing Content-Length http header")) + +(defgeneric (setf connector-content-length) (value connector) + (:documentation "Sets the outgoing Content-Length http header")) + +(defclass connector (claw-service) + ((behind-apache-p :initarg :behind-apache-p + :accessor connector-behind-apache-p + :documentation "Returns true if the connector is running behind apache.") + (port :initarg :port + :accessor connector-port + :documentation "The port under which normal http requests are handled") + (sslport :initarg :sslport + :accessor connector-sslport + :documentation "The port under which https requests are handled") + (address :initarg :address + :accessor connector-address + :documentation "The address under which https reqhests are handled")) + (:default-initargs :port 80 :sslport 443 + :address nil + :behind-apache-p nil :name 'connector) + (:documentation "CONNECTOR is an interface, so you cannot directly use it. +A Connector subclass is a class that helps to decouple CLAW from the web server on which CLAWSERVER resides. +To properly work a CLAWSERVER instance must be provided with a CONNECTOR implementation. +A CONNECTOR implementation to properly work, must implement all the CONNECTOR- methods.")) + +(defmethod connector-writer ((connector connector))) + +(defclass claw-cookie () + ((name :initarg :name + :reader claw-cookie-name + :type string + :documentation "The name of the claw-cookie - a string.") + (value :initarg :value + :accessor claw-cookie-value + :initform "" + :documentation "The value of the claw-cookie. Will be URL-encoded when sent to the browser.") + (expires :initarg :expires + :initform nil + :accessor claw-cookie-expires + :documentation "The time (a universal time) when the claw-cookie expires (or NIL).") + (path :initarg :path + :initform nil + :accessor claw-cookie-path + :documentation "The path this claw-cookie is valid for (or NIL).") + (domain :initarg :domain + :initform nil + :accessor claw-cookie-domain + :documentation "The domain this claw-cookie is valid for (or NIL).") + (secure :initarg :secure + :initform nil + :accessor claw-cookie-secure + :documentation "A generalized boolean denoting whether this is a secure claw-cookie.") + (http-only :initarg :http-only + :initform nil + :accessor claw-cookie-http-only + :documentation "A generalized boolean denoting whether this is a HttpOnly claw-cookie."))) +

Modified: trunk/main/claw-core/src/i18n.lisp ============================================================================== --- trunk/main/claw-core/src/i18n.lisp (original) +++ trunk/main/claw-core/src/i18n.lisp Thu Jul 17 09:11:41 2008 @@ -31,7 +31,7 @@

(defgeneric local-time-add (local-time field value) (:documentation "Adds the specified amount of VALUE to the LOCAL_TIME. -FIELD may be any of: +FIELD may be any of: * 'NSEC nano-seconds * 'MSEC milli-seconds * 'SEC seconds @@ -43,18 +43,18 @@ And other FIELD value will produce an error condition."))

-(defvar *locales* (make-hash-table :test 'equal) - "A hash table of locale key strings and lists of locale directives. +(defvar *locales* (make-hash-table :test 'equal) + "A hash table of locale key strings and lists of locale directives. You should use locale access functions to get its internal values.")

(defun number-format-grouping-separator (&optional (locale (user-locale))) "Returns the character used as thousands grouping separator for numbers" (getf (getf (gethash locale *locales*) :number-format) :grouping-separator)) - + (defun number-format-decimal-separator (&optional (locale (user-locale))) "Returns the character used as decimals separator for numbers" (getf (getf (gethash locale *locales*) :number-format) :decimal-separator)) - + (defun ampm (&optional (locale (user-locale))) "Returns a list with the localized version of AM and PM for time" (getf (gethash locale *locales*) :ampm)) @@ -90,88 +90,97 @@ (decode-local-time local-time) (encode-local-time ns ss mm hh day month (+ year value))))

-(defun local-time-add-month (local-time value) +(defun local-time-add-month (local-time value) "Add or remove monthes, expressed by the value parameter, to a local-time instance. Correction on other local-time fields is performed if needed" (multiple-value-bind (d-month d-year) (floor (abs value) 12) (when (< value 0) (setf d-month (- d-month) - d-year (- d-year)) + d-year (- d-year)) (multiple-value-bind (ns ss mm hh day month year) - (decode-local-time local-time) - (multiple-value-bind (ns ss mm hh day month-ignore year) - (decode-local-time (encode-local-time ns ss mm hh day 1 (+ year d-year))) - (encode-local-time ns ss mm hh day month year)))))) + (decode-local-time local-time) + (multiple-value-bind (ns ss mm hh day month-ignore year) + (decode-local-time (encode-local-time ns ss mm hh day 1 (+ year d-year))) + (declare (ignore month-ignore)) + (encode-local-time ns ss mm hh day month year))))))

(defun local-time-add-day (local-time value) "Add or remove days, expressed by the value parameter, to a local-time instance. Correction on other local-time fields is performed if needed" (let* ((curr-day (day-of local-time)) - (local-time-result (make-instance 'local-time - :day curr-day - :sec (sec-of local-time) - :nsec (nsec-of local-time) - :time-zone (timezone-of local-time)))) + (local-time-result (make-instance 'local-time + :day curr-day + :sec (sec-of local-time) + :nsec (nsec-of local-time) + :time-zone (timezone-of local-time)))) (setf (day-of local-time-result) (+ curr-day value)) local-time-result))

(defun local-time-add-hour (local-time value) "Add or remove hours, expressed by the value parameter, to a local-time instance. Correction on other local-time fields is performed if needed" - (multiple-value-bind (ns ss mm hh day month year) - (decode-local-time local-time) + (multiple-value-bind (ns-ignore ss-ignore mm-ignore hh day-ignore month-ignore year-ignore) + (decode-local-time local-time) + (declare (ignore ns-ignore ss-ignore mm-ignore day-ignore month-ignore year-ignore)) (multiple-value-bind (d-hour d-day) - (floor (abs value) 24) + (floor (abs value) 24) (when (< value 0) - (setf d-hour (- d-hour) - d-day (- d-day))) + (setf d-hour (- d-hour) + d-day (- d-day))) (let ((local-time-result (local-time-add-day local-time d-day))) - (multiple-value-bind (ns2 ss2 mm2 hh2 day2 month2 year2) - (decode-local-time local-time-result) - (encode-local-time ns2 ss2 mm2 (+ hh d-hour) day2 month2 year2)))))) + (multiple-value-bind (ns2 ss2 mm2 hh-ignore day2 month2 year2) + (decode-local-time local-time-result) + (declare (ignore hh-ignore)) + (encode-local-time ns2 ss2 mm2 (+ hh d-hour) day2 month2 year2))))))

(defun local-time-add-min (local-time value) "Add or remove minutes, expressed by the value parameter, to a local-time instance. Correction on other local-time fields is performed if needed" - (multiple-value-bind (ns ss mm hh day month year) - (decode-local-time local-time) + (multiple-value-bind (ns-ignore ss-ignore mm hh-ignore day-ignore month-ignore year-ignore) + (decode-local-time local-time) + (declare (ignore ns-ignore ss-ignore hh-ignore day-ignore month-ignore year-ignore)) (multiple-value-bind (d-min d-hour) - (floor (abs value) 60) + (floor (abs value) 60) (when (< value 0) - (setf d-min (- d-min) - d-hour (- d-hour))) + (setf d-min (- d-min) + d-hour (- d-hour))) (let ((local-time-result (local-time-add-hour local-time d-hour))) - (multiple-value-bind (ns2 ss2 mm2 hh2 day2 month2 year2) - (decode-local-time local-time-result) - (encode-local-time ns2 ss2 (+ mm d-min) hh2 day2 month2 year2)))))) + (multiple-value-bind (ns2 ss2 mm-ignore hh2 day2 month2 year2) + (decode-local-time local-time-result) + (declare (ignore mm-ignore)) + (encode-local-time ns2 ss2 (+ mm d-min) hh2 day2 month2 year2))))))

(defun local-time-add-sec (local-time value) "Add or remove seconds, expressed by the value parameter, to a local-time instance. Correction on other local-time fields is performed if needed" - (multiple-value-bind (ns ss mm hh day month year) - (decode-local-time local-time) + (multiple-value-bind (ns-ignore ss mm-ignore hh-ignore day-ignore month-ignore year-ignore) + (decode-local-time local-time) + (declare (ignore ns-ignore mm-ignore hh-ignore day-ignore month-ignore year-ignore)) (multiple-value-bind (d-sec d-min) - (floor (abs value) 60) + (floor (abs value) 60) (when (< value 0) - (setf d-sec (- d-sec) - d-min (- d-min))) + (setf d-sec (- d-sec) + d-min (- d-min))) (let ((local-time-result (local-time-add-min local-time d-min))) - (multiple-value-bind (ns2 ss2 mm2 hh2 day2 month2 year2) - (decode-local-time local-time-result) - (encode-local-time ns2 (+ ss d-sec) mm2 hh2 day2 month2 year2)))))) + (multiple-value-bind (ns2 ss-ignore mm2 hh2 day2 month2 year2) + (decode-local-time local-time-result) + (declare (ignore ss-ignore)) + (encode-local-time ns2 (+ ss d-sec) mm2 hh2 day2 month2 year2))))))

(defun local-time-add-nsec (local-time value) "Add or remove nanoseconds, expressed by the value parameter, to a local-time instance. Correction on other local-time fields is performed if needed" - (multiple-value-bind (ns ss mm hh day month year) - (decode-local-time local-time) + (multiple-value-bind (ns ss-ignore mm-ignore hh-ignore day-ignore month-ignore year-ignore) + (decode-local-time local-time) + (declare (ignore ss-ignore mm-ignore hh-ignore day-ignore month-ignore year-ignore)) (multiple-value-bind (d-nsec d-sec) - (floor (abs value) 10000000) + (floor (abs value) 10000000) (when (< value 0) - (setf d-nsec (- d-nsec) - d-sec (- d-sec))) + (setf d-nsec (- d-nsec) + d-sec (- d-sec))) (let ((local-time-result (local-time-add-sec local-time d-sec))) - (multiple-value-bind (ns2 ss2 mm2 hh2 day2 month2 year2) - (decode-local-time local-time-result) - (encode-local-time (+ ns d-nsec) ss2 mm2 hh2 day2 month2 year2)))))) - + (multiple-value-bind (ns-ignore ss2 mm2 hh2 day2 month2 year2) + (decode-local-time local-time-result) + (declare (ignore ns-ignore)) + (encode-local-time (+ ns d-nsec) ss2 mm2 hh2 day2 month2 year2)))))) + (defmethod local-time-add ((local-time local-time) field value) - (ccase field + (ccase field (NSEC (local-time-add-nsec local-time value)) (SEC (local-time-add-sec local-time value)) (MIN (local-time-add-min local-time value))

Modified: trunk/main/claw-core/src/lisplet.lisp ============================================================================== --- trunk/main/claw-core/src/lisplet.lisp (original) +++ trunk/main/claw-core/src/lisplet.lisp Thu Jul 17 09:11:41 2008 @@ -49,7 +49,7 @@ - :WELCOME-PAGE-P When true, the function will be a welcome page, making the lisplet to redirect direct access to its base path to the expressed location - :LOGIN-PAGE-P Marks the function as a login page"))

-(defgeneric lisplet-register-page-location (lisplet page-class location &key welcome-page-p login-page-p external-format) +(defgeneric lisplet-register-page-location (lisplet page-class location &key welcome-page-p login-page-p) (:documentation "Registers a page into a lisplet for dispatching. parameters: - LISPLET the lisplet that will dispatch the page @@ -57,23 +57,21 @@ - LOCATION The url location where the page will be registered (relative to the lisplet base path) keys: - :WELCOME-PAGE-P When true, the page will be a welcome page, making the lisplet to redirect direct access to its base path to the expressed location -- :LOGIN-PAGE-P Marks the page as a login page -- :EXTERNAL-FORMAT The FLEXI-STREAMS:EXTERNAL-FORMAT used to render the resource")) +- :LOGIN-PAGE-P Marks the page as a login page"))

-(defgeneric lisplet-register-resource-location (lisplet resource-path location &optional content-type external-format) +(defgeneric lisplet-register-resource-location (lisplet resource-path location &optional content-type) (:documentation "Registers a resource (file or directory) into a lisplet for dispatching. parameters: - LISPLET the lisplet that will dispatch the page - RESOURCE-PATH pathname of a file or directory that is to be registered for dispatching - LOCATION The url location where the resource will be registered (relative to the lisplet base path) -- CONTENT-TYPE Meaningful only when the resource-path points to a file, indicates the resource content type -- :EXTERNAL-FORMAT The FLEXI-STREAMS:EXTERNAL-FORMAT used to render the resource")) +- CONTENT-TYPE Meaningful only when the resource-path points to a file, indicates the resource content type"))

(defgeneric lisplet-dispatch-method (lisplet) (:documentation "Performs authorizations checking then makes a call to LISPLET-DISPATCH-REQUEST - LISPLET the lisplet object"))

-(defgeneric lisplet-dispatch-request (lisplet) +(defgeneric lisplet-dispatch-request (lisplet uri) (:documentation "Dispatches the http request. - LISPLET the lisplet object"))

@@ -85,7 +83,7 @@ - LOCATION the location that must be protected. - ROLES a string list containing all the roles allowed to acces the given location."))

-(defgeneric lisplet-check-authorization (lisplet &optional request) +(defgeneric lisplet-check-authorization (lisplet) (:documentation "Performs authentication and authorization checking. Sets the return code of each REPLY, to +HTTP-OK+, +HTTP-FORBIDDEN+ or +HTTP-AUTHORIZATION-REQUIRED+. If the lisplet authentication type is :BASIC and the user isn't logged in, asks for a basic login.")) @@ -98,33 +96,22 @@ (defgeneric build-lisplet-location (lisplet) (:documentation "Constructs a full path prepending the lisplet base path to the given location"))

-(setf *http-error-handler* - ;;overrides the default hunchentoot error handling - #'(lambda (error-code) - (let* ((error-handlers (if (current-lisplet) - (lisplet-error-handlers (current-lisplet)) - (make-hash-table))) - (handler (gethash error-code error-handlers))) - (if handler - (funcall handler) - (let ((error-page (make-instance 'error-page - :title (format nil "Server error: ~a" error-code) - :error-code error-code))) - (with-output-to-string (*standard-output*) (page-render error-page))))))) - (defclass lisplet (i18n-aware) ((base-path :initarg :base-path :reader lisplet-base-path :documentation "common base path all resources registered into this lisplet") + (server-address :initarg :server-address + :accessor lisplet-server-address + :documentation "Server address used on redirections") (welcome-page :initarg :welcome-page :accessor lisplet-welcome-page :documentation "url location for the welcome page") (login-page :initarg :login-page :accessor lisplet-login-page :documentation "url location for the welcome page") - (external-format :initarg :external-format - :accessor lisplet-external-format - :documentation "The default charset external format for resources provided by this lisplet.") + (log-manager :initarg :log-manager + :accessor lisplet-log-manager + :documentation "Log meanager used to log lisplet application messages. When nil the server one is used.") (realm :initarg :realm :reader lisplet-realm :documentation "realm for requests that pass through this lisplet and session opened into this lisplet") @@ -140,9 +127,10 @@ (redirect-protected-resources-p :initarg :redirect-protected-resources-p :accessor lisplet-redirect-protected-resources-p :documentation "When not null every request will be redirected in https mode. When running in mod-lisp mode, *apache-http-port* and *apache-https-port* values are used")) - (:default-initargs :welcome-page nil + (:default-initargs :server-address *claw-default-server-address* + :welcome-page nil :login-page nil - :external-format nil + :log-manager nil :realm "claw" :redirect-protected-resources-p nil) (:documentation "A lisplet is a container for resources provided trhough the clawserver. @@ -154,10 +142,7 @@ (setf (clawserver-dispatchers clawserver) (sort-by-location (pushnew-location (cons location #'(lambda () - (progn - (setf (current-realm *request*) (lisplet-realm lisplet) - (current-lisplet) lisplet) - (lisplet-dispatch-method lisplet)))) + (lisplet-dispatch-method lisplet))) dispatchers)))))

(defmethod clawserver-unregister-lisplet ((clawserver clawserver) (lisplet lisplet)) @@ -168,7 +153,7 @@

(defmethod build-lisplet-location ((lisplet lisplet)) "Constructs a full path prepending the lisplet base path to the given location" - (format nil "~a~a" (clawserver-base-path (current-server)) (lisplet-base-path lisplet))) + (format nil "~a~a" (clawserver-base-path *clawserver*) (lisplet-base-path lisplet)))

(defmethod lisplet-authentication-type ((lisplet lisplet)) (if (lisplet-login-page lisplet) @@ -184,54 +169,52 @@ (when login-page-p (setf (lisplet-login-page lisplet) location))))

-(defmethod lisplet-register-page-location ((lisplet lisplet) page-class location &key welcome-page-p login-page-p external-format) - (let ((charset-external-format (or external-format (lisplet-external-format lisplet)))) - (lisplet-register-function-location lisplet - #'(lambda () (with-output-to-string (*standard-output*) - (page-render (make-instance page-class :lisplet lisplet :url location :external-format charset-external-format)))) - location - :welcome-page-p welcome-page-p - :login-page-p login-page-p))) - -(defmethod lisplet-register-resource-location ((lisplet lisplet) resource-path location &optional content-type external-format) - (let ((pages (lisplet-pages lisplet)) - (charset-external-format (or external-format (lisplet-external-format lisplet)))) +(defmethod lisplet-register-page-location ((lisplet lisplet) page-class location &key welcome-page-p login-page-p) + (lisplet-register-function-location lisplet + #'(lambda () (with-output-to-string (*standard-output*) + (page-render (make-instance page-class)))) + location + :welcome-page-p welcome-page-p + :login-page-p login-page-p)) + +(defmethod lisplet-register-resource-location ((lisplet lisplet) resource-path location &optional content-type) + (let ((pages (lisplet-pages lisplet))) (setf (lisplet-pages lisplet) (sort-by-location (pushnew-location (cons location (if (directory-pathname-p resource-path) #'(lambda () (let ((resource-full-path (merge-pathnames - (uri-to-pathname (subseq (script-name) - (+ (length (clawserver-base-path (current-server))) + (uri-to-pathname (subseq (claw-script-name) + (+ (length (clawserver-base-path *clawserver*)) (length (lisplet-base-path lisplet)) (length location) 1))) resource-path))) - (unless (or (null charset-external-format) - (eq (flexi-streams:external-format-name (reply-external-format)) - (flexi-streams:external-format-name charset-external-format))) - (setf (reply-external-format) charset-external-format)) - (handle-static-file resource-full-path content-type))) - #'(lambda () (handle-static-file resource-path content-type)))) + (claw-handle-static-file resource-full-path content-type))) + #'(lambda () (claw-handle-static-file resource-path content-type)))) pages)))))

-(defmethod lisplet-dispatch-request ((lisplet lisplet)) + +(defmethod lisplet-dispatch-request ((lisplet lisplet) uri) (let ((dispatchers (lisplet-pages lisplet)) - (rel-script-name (subseq (script-name) (1+ (length (build-lisplet-location lisplet)))))) + (rel-script-name (subseq uri (1+ (length (build-lisplet-location lisplet)))))) (loop for dispatcher in dispatchers for url = (car dispatcher) for action = (cdr dispatcher) do (when (starts-with-subseq rel-script-name url) (return (funcall action))))))

(defmethod lisplet-dispatch-method ((lisplet lisplet)) - (let ((base-path (build-lisplet-location lisplet)) - (uri (script-name)) - (welcome-page (lisplet-welcome-page lisplet))) + (let* ((*claw-current-realm* (lisplet-realm lisplet)) + (*claw-current-lisplet* lisplet) + (*claw-session* (default-session-manager-session-verify *session-manager*)) + (base-path (build-lisplet-location lisplet)) + (uri (claw-script-name)) + (welcome-page (lisplet-welcome-page lisplet))) (lisplet-check-authorization lisplet) - (when (= (return-code) +http-ok+) - (if (and welcome-page (string= uri base-path)) - (page-render (lisplet-welcome-page lisplet)) - (lisplet-dispatch-request lisplet))))) + (when (= (claw-return-code) +http-ok+) + (if (and welcome-page (or (string= uri base-path) (string= uri (concatenate 'string base-path "/")))) + (funcall (cdr (assoc welcome-page (lisplet-pages lisplet)))) + (lisplet-dispatch-request lisplet uri)))))

(defmethod lisplet-protect ((lisplet lisplet) location roles) (let ((protected-resources (lisplet-protected-resources lisplet))) @@ -240,29 +223,31 @@ (cons location roles) protected-resources)))))

-(defun redirect-to-https (server request &optional uri) +(defun redirect-to-https (&optional uri) "Redirects a request sent through http using https" - (let ((path (or uri (request-uri request))) - (port (server-port request)) - (protocol :http)) - #-:hunchentoot-no-ssl (when (or (clawserver-mod-lisp-p server) - (clawserver-ssl-certificate-file server)) - (setf protocol :https - port (if (clawserver-mod-lisp-p server) - *apache-https-port* - (clawserver-sslport server)))) - (redirect path :port port :protocol protocol))) - -(defmethod lisplet-check-authorization ((lisplet lisplet) &optional (request *request*)) - (let* ((uri (script-name request)) + (let* ((connector (clawserver-connector *clawserver*)) + (path (or uri (claw-request-uri))) + (port (connector-port connector)) + (sslport (connector-sslport connector))) + (if (connector-behind-apache-p connector) + (claw-redirect path :port *apache-https-port* :protocol :https) + (claw-redirect path :port (or sslport port) :protocol (if sslport + :https + :http))))) + +(defmethod lisplet-check-authorization ((lisplet lisplet)) + (let* ((connector (clawserver-connector *clawserver*)) + (uri (claw-script-name)) (base-path (build-lisplet-location lisplet)) (protected-resources (lisplet-protected-resources lisplet)) (princp (current-principal)) (login-config (current-config)) (login-page-url (format nil "~a/~a" base-path (lisplet-login-page lisplet))) - (server (current-server request)) + (sslport (connector-sslport connector)) (auth-basicp (eq (lisplet-authentication-type lisplet) :basic))) - (setf (return-code) +http-ok+) + (when (or (string= uri base-path) (string= uri (concatenate 'string base-path "/"))) + (setf uri (format nil "~a/~a" base-path uri))) + (setf (claw-return-code) +http-ok+) (when login-config (when (and auth-basicp (null princp)) (configuration-login login-config)) @@ -273,15 +258,15 @@ do (when (or (starts-with-subseq match uri) (string= login-page-url uri)) (cond ((and princp (not (user-in-role-p allowed-roles)) (not (string= login-page-url uri))) - (setf (return-code) +http-forbidden+) + (setf (claw-return-code) +http-forbidden+) (throw 'handler-done nil)) ((and (null princp) auth-basicp) - (setf (return-code) +http-authorization-required+ - (header-out "WWW-Authenticate") (format nil "Basic realm="~A"" (hunchentoot::quote-string (current-realm)))) + (setf (claw-return-code) +http-authorization-required+ + (claw-header-out "WWW-Authenticate") (format nil "Basic realm="~A"" *claw-current-realm*)) (throw 'handler-done nil)) ((and (null princp) (null auth-basicp) (not (string= login-page-url uri))) - (redirect-to-https server request login-page-url) + (redirect-to-https login-page-url) (throw 'handler-done nil)) - #-:hunchentoot-no-ssl ((not (find (server-port request) (list (clawserver-sslport server) *apache-https-port*))) - (redirect-to-https server request) + ((and sslport (not (= (claw-server-port) sslport))) + (redirect-to-https) (throw 'handler-done nil))))))))

Added: trunk/main/claw-core/src/logger.lisp ============================================================================== --- (empty file) +++ trunk/main/claw-core/src/logger.lisp Thu Jul 17 09:11:41 2008 @@ -0,0 +1,43 @@ +;; -*- Mode: LISP; Syntax: COMMON-LISP; Package: CL-USER; Base: 10 -*- +;;; $Header: src/logger.lisp $ + +;;; Copyright (c) 2008, Andrea Chiumenti. All rights reserved. + +;;; Redistribution and use in source and binary forms, with or without +;;; modification, are permitted provided that the following conditions +;;; are met: + +;;; * Redistributions of source code must retain the above copyright +;;; notice, this list of conditions and the following disclaimer. + +;;; * Redistributions in binary form must reproduce the above +;;; copyright notice, this list of conditions and the following +;;; disclaimer in the documentation and/or other materials +;;; provided with the distribution. + +;;; THIS SOFTWARE IS PROVIDED BY THE AUTHOR 'AS IS' AND ANY EXPRESSED +;;; OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +;;; WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +;;; ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +;;; DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +;;; DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE +;;; GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +;;; INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +;;; WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +;;; NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +;;; SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +(in-package :claw) + +(defgeneric logger-log (logger level control-string &rest args) + (:documentation "Logs a message. +log-level should be one of the keywords :EMERG, :ALERT, :CRIT, :ERROR, :WARNING, :NOTICE, :INFO, or :DEBUG which correspond to the various Apache log levels. +Form the rest this method behaves like the FORMAT function.")) + +(defclass logger (claw-service) + () + (:documentation "The logger is a class that logs messages sent via LOGGER-LOG method. +LOGGER is an interface, so you cannot directly use it. +A LOGGER subclass is a class that helps to decouple CLAW from the web server on which CLAWSERVER resides. +To properly work a CLAWSERVER instance must be provided with a LOGGER implementation. +A LOG implementation to properly work, must implement all the LOGGER-LOG method."))

Modified: trunk/main/claw-core/src/misc.lisp ============================================================================== --- trunk/main/claw-core/src/misc.lisp (original) +++ trunk/main/claw-core/src/misc.lisp Thu Jul 17 09:11:41 2008 @@ -29,29 +29,349 @@

(in-package :claw)

-(setf *hunchentoot-default-external-format* (flex:make-external-format :utf-8 :eol-style :lf)) +(defconstant +buffer-length+ 8192 + "Length of buffers used for internal purposes.")

-(defvar *apache-http-port* 80 - "Default apache http port when claw is running in mod_lisp mode") -(defvar *apache-https-port* 443 - "Default apache https port when claw is running in mod_lisp mode") - -(defvar *claw-libraries-resources* () - "Global variable to hold exposed web resources") - -(defun strings-to-jsarray (strings) - "Transforms a list of strings into a javascript array." - (let ((st-size (length strings)) - (items "")) - (cond ((= st-size 0) "[]") - ((= st-size 1) (format nil "[~a]" (prin1-to-string (first strings)))) - (t (format nil (format nil "[~a~a]" - (prin1-to-string (first strings)) - (progn - (dolist (str (rest strings)) - (setf items (format nil "~a,~a" - items (prin1-to-string str)))) - items))))))) +(eval-when (:compile-toplevel :execute :load-toplevel) + + (defvar *clawserver* nil + "The current serving CLAWSERVER instance") + + (defvar *session-manager* nil + "The SESSION-MANAGER used by the *CLAWSERVER*") + + (defvar *apache-http-port* 80 + "Default apache http port when claw is running in mod_lisp mode, or behind mod_proxy") + (defvar *apache-https-port* 443 + "Default apache https port when claw is running in mod_lisp mode, or behind mod_proxy") + + (defvar *claw-default-server-address* nil + "Default host address given as default server address for lisplets used on redirections") + + (defvar *claw-libraries-resources* () + "Global variable to hold exposed web resources") + + (defvar *claw-current-page* nil + "The CLAW page currently rendering") + + (defvar *claw-current-realm* "CLAW" + "The realm under which the request has been sent. +A realm is used to group resources under a common 'place', and is used for registered web applications +to have different or common sessions for a give user.") + + (defvar *claw-current-lisplet* nil + "The liplet currently serving") + + (defvar *claw-session* nil + "The session bound to the current request") + + (defvar *http-reason-phrase-map* (make-hash-table) + "Used to map numerical return codes to reason phrases.") + + (defvar *id-and-static-id-description* "- :ID The htcomponent-client-id value. CLAW can transform its value to make it univocal +- :STATIC-ID Like the :ID parameter, it sets the htcomponent-client-id instance property, but CLAW will not manage its value to manage its univocity." "Description used for describing :ID and :STATIC-ID used in claw component init functions documentation +") + + (defvar *day-names* + '("Mon" "Tue" "Wed" "Thu" "Fri" "Sat" "Sun") + "The three-character names of the seven days of the week - needed +for cookie date format.") + + (defvar *month-names* + '("Jan" "Feb" "Mar" "Apr" "May" "Jun" "Jul" "Aug" "Sep" "Oct" "Nov" "Dec") + "The three-character names of the twelve months - needed for cookie +date format.") + + (defmacro def-http-return-code (name value reason-phrase) + "Shortcut to define constants for return codes. NAME is a +Lisp symbol, VALUE is the numerical value of the return code, and +REASON-PHRASE is the phrase (a string) to be shown in the +server's status line." + `(eval-when (:compile-toplevel :execute :load-toplevel) + (defconstant ,name ,value ,(format nil "HTTP return code (~A) for '~A'." + value reason-phrase)) + (setf (gethash ,value *http-reason-phrase-map*) ,reason-phrase))) + + (defvar *http-reason-phrase-map* (make-hash-table) + "Used to map numerical return codes to reason phrases.")) + +(def-http-return-code +http-continue+ 100 "Continue") +(def-http-return-code +http-switching-protocols+ 101 "Switching Protocols") +(def-http-return-code +http-ok+ 200 "OK") +(def-http-return-code +http-created+ 201 "Created") +(def-http-return-code +http-accepted+ 202 "Accepted") +(def-http-return-code +http-non-authoritative-information+ 203 "Non-Authoritative Information") +(def-http-return-code +http-no-content+ 204 "No Content") +(def-http-return-code +http-reset-content+ 205 "Reset Content") +(def-http-return-code +http-partial-content+ 206 "Partial Content") +(def-http-return-code +http-multi-status+ 207 "Multi-Status") +(def-http-return-code +http-multiple-choices+ 300 "Multiple Choices") +(def-http-return-code +http-moved-permanently+ 301 "Moved Permanently") +(def-http-return-code +http-moved-temporarily+ 302 "Moved Temporarily") +(def-http-return-code +http-see-other+ 303 "See Other") +(def-http-return-code +http-not-modified+ 304 "Not Modified") +(def-http-return-code +http-use-proxy+ 305 "Use Proxy") +(def-http-return-code +http-temporary-redirect+ 307 "Temporary Redirect") +(def-http-return-code +http-bad-request+ 400 "Bad Request") +(def-http-return-code +http-authorization-required+ 401 "Authorization Required") +(def-http-return-code +http-payment-required+ 402 "Payment Required") +(def-http-return-code +http-forbidden+ 403 "Forbidden") +(def-http-return-code +http-not-found+ 404 "Not Found") +(def-http-return-code +http-method-not-allowed+ 405 "Method Not Allowed") +(def-http-return-code +http-not-acceptable+ 406 "Not Acceptable") +(def-http-return-code +http-proxy-authentication-required+ 407 "Proxy Authentication Required") +(def-http-return-code +http-request-time-out+ 408 "Request Time-out") +(def-http-return-code +http-conflict+ 409 "Conflict") +(def-http-return-code +http-gone+ 410 "Gone") +(def-http-return-code +http-length-required+ 411 "Length Required") +(def-http-return-code +http-precondition-failed+ 412 "Precondition Failed") +(def-http-return-code +http-request-entity-too-large+ 413 "Request Entity Too Large") +(def-http-return-code +http-request-uri-too-large+ 414 "Request-URI Too Large") +(def-http-return-code +http-unsupported-media-type+ 415 "Unsupported Media Type") +(def-http-return-code +http-requested-range-not-satisfiable+ 416 "Requested range not satisfiable") +(def-http-return-code +http-expectation-failed+ 417 "Expectation Failed") +(def-http-return-code +http-failed-dependency+ 424 "Failed Dependency") +(def-http-return-code +http-internal-server-error+ 500 "Internal Server Error") +(def-http-return-code +http-not-implemented+ 501 "Not Implemented") +(def-http-return-code +http-bad-gateway+ 502 "Bad Gateway") +(def-http-return-code +http-service-unavailable+ 503 "Service Unavailable") +(def-http-return-code +http-gateway-time-out+ 504 "Gateway Time-out") +(def-http-return-code +http-version-not-supported+ 505 "Version not supported") + +(defvar *approved-return-codes* '(#.+http-ok+ #.+http-no-content+ + #.+http-multi-status+ + #.+http-not-modified+) + "A list of return codes the server should not treat as an error - +see *HANDLE-HTTP-ERRORS-P*.") + +;;-------------------------------------------------------------------------------------------- +;;---------------------------------------- WRAPPERS ----------------------------------------- +;;-------------------------------------------------------------------------------------------- + +(defun claw-request-method () + "Wrapper function around CONNECTOR-REQUEST-METHOD. +Returns :GET or POST. respectively." + (clawserver-request-method *clawserver*)) + +(defun claw-script-name () + "Wrapper function around CONNECTOR-SCRIPT-NAME. +Returns the file name (or path) component of the URI for request (before the question mark)," + (clawserver-script-name *clawserver*)) + +(defun claw-request-uri () + "Wrapper function around CONNECTOR-REQUEST-URI. +Returns the URI for request." + (clawserver-request-uri *clawserver*)) + +(defun claw-query-string () + "Wrapper function around CONNECTOR-QUERY-STRING. +Returns the query component of the URI for request (the part behing the question mark)" + (clawserver-query-string *clawserver*)) + +(defun claw-get-parameter (name) + "Wrapper function around CONNECTOR-GET-PARAMETER. +Returns the value of the GET parameter as a string (or nil), identified by NAME (a string too)" + (clawserver-get-parameter *clawserver* name)) + +(defun claw-get-parameters () + "Wrapper function around CONNECTOR-GET-PARAMETERS. +Returns an alist of all GET parameters." + (clawserver-get-parameters *clawserver*)) + +(defun claw-post-parameter (name) + "Wrapper function around CONNECTOR-POST-PARAMETER. +Returns the value of the POST parameter as a string (or nil), identified by NAME (a string too)" + (clawserver-post-parameter *clawserver* name)) + +(defun claw-post-parameters () + "Wrapper function around CONNECTOR-POST-PARAMETERS. +Returns an alist of all POST parameters." + (clawserver-post-parameters *clawserver*)) + +(defun claw-parameter (name) + "Wrapper function around CONNECTOR-PARAMETER. +Returns the value of the GET or POST parameter as a string (or nil), identified by NAME (a string too)" + (clawserver-parameter *clawserver* name)) + +(defun claw-header-in (symbol) + "Wrapper function around CONNECTOR-HEADER-IN. +Returns the incoming header named by the keyword SYMBOL, as a string." + (clawserver-header-in *clawserver* symbol)) + +(defun claw-headers-in () + "Wrapper function around CONNECTOR-HEADERS-IN." + (clawserver-headers-in *clawserver*)) + +(defun claw-authorization () + "Wrapper function around CONNECTOR-AUTHORIZATION. +Returns as two values the user and password (if any) from the incoming Authorization http header." + (clawserver-authorization *clawserver*)) + +(defun claw-remote-addr () + "Wrapper function around CONNECTOR-REMOTE-ADDR. +Returns the IP address (as a string) of the client which sent the request." + (clawserver-remote-addr *clawserver*)) + +(defun claw-remote-port () + "Wrapper function around CONNECTOR-REMOTE-PORT. +Returns the IP port (as a number) of the client which sent the request." + (clawserver-remote-port *clawserver*)) + +(defun claw-real-remote-addr () + "Wrapper function around CONNECTOR-REAL-REMOTE-ADDR see it for more info." + (clawserver-real-remote-addr *clawserver*)) + +(defun claw-server-addr () + "Wrapper function around CONNECTOR-SERVER-ADDR. +Returns the IP address (as a string) where the request came in." + (clawserver-server-addr *clawserver*)) + +(defun claw-server-port () + "Wrapper function around CONNECTOR-SERVER-PORT. +Returns the IP port (as a number) where the request came in." + (clawserver-server-addr *clawserver*)) + +(defun claw-user-agent () + "Wrapper function around CONNECTOR-USER-AGENT. +Returns the value of the incoming User-Agent http header." + (clawserver-user-agent *clawserver*)) + +(defun claw-referer () + "Wrapper function around CONNECTOR-REFERER see it for more info." + (clawserver-referer *clawserver*)) + +(defun claw-cookie-in (name) + "Wrapper function around CONNECTOR-COOKIE-IN. +Returns the value (a CLAW-COOKIE instance or nil) of the incoming cookie named by the string NAME." + (clawserver-cookie-in *clawserver* name)) + +(defun claw-cookies-in () + "Wrapper function around CONNECTOR-COOKIES-IN. +Returns the value (as CLAW-COOKIE instance) of the incoming cookies." + (clawserver-cookies-in *clawserver*)) + +(defun claw-aux-request-value (symbol) + "Wrapper function around CONNECTOR-AUX-REQUEST-VALUE. +Returns values VALUE, PRESENTP. +This accessor can be used to associate arbitrary data with the the symbol symbol in the REQUEST object request. +present-p is true if such data was found, otherwise NIL" + (clawserver-aux-request-value *clawserver* symbol)) + +(defun (setf claw-aux-request-value) (value symbol) + "Wrapper function around (SETF CONNECTOR-AUX-REQUEST-VALUE). +This accessor can be used to associate arbitrary data with the the symbol symbol in the REQUEST object request." + (setf (clawserver-aux-request-value *clawserver* symbol) value)) + +(defun claw-delete-aux-request-value (symbol) + "Wrapper function around CONNECTOR-DELETE-AUX-REQUEST-VALUE. +Completely removes any data associated with the symbol symbol from the REQUEST object request." + (clawserver-delete-aux-request-value *clawserver* symbol)) + +(defun claw-content-type () + "Returns the outgoing Content-Type http header (such as: "text/html; charset=utf-8")." + (clawserver-content-type *clawserver*)) + +(defun (setf claw-content-type) (value) + "Sets the outgoing Content-Type http header (such as: "text/html; charset=utf-8")." + (setf (clawserver-content-type *clawserver*) value)) + +(defun claw-content-length () + "Returns the outgoing Content-Length http header" + (clawserver-content-length *clawserver*)) + +(defun (setf claw-content-length) (value) + "Sets the outgoing Content-Length http header" + (setf (clawserver-content-length *clawserver*) value)) + +;;--------------------------- + +(defun claw-header-out (symbol) + "Wrapper function around CONNECTOR-HEADER-OUT. +Returns the outgoing http header named by the keyword name if there is one, otherwise NIL." + (clawserver-header-out *clawserver* symbol)) + +(defun (setf claw-header-out) (value symbol) + "Wrapper function around (SETF CONNECTOR-HEADER-OUT). +SETF of HEADER-OUT changes the current value of the header named name (name parameter must be a symbol). +If no header named name exists it is created." + (setf (clawserver-header-out *clawserver* symbol) value)) + +(defun claw-headers-out () + "Wrapper function around CONNECTOR-HEADERS-OUT. +Returns an alist of all outgoing http parameters (except for Set-Cookie, Content-Length, and Content-Type)." + (clawserver-headers-out *clawserver*)) + +(defun claw-cookie-out (name) + "Wrapper function around CONNECTOR-COOKIE-OUT. +Returns the outgoing cookie named by the string name (or NIL if there ain't no cookie with this name)." + (clawserver-cookie-out *clawserver* name)) + +(defun (setf claw-cookie-out) (cookie-instance name) + "Wrapper function around (SETF CONNECTOR-COOKIE-OUT). +Creates a CLAW-COOKIE object from the parameters provided to this function and adds it to the outgoing cookies of the REPLY object reply." + (setf (clawserver-cookie-out *clawserver* name) cookie-instance)) + +(defun claw-cookies-out () + "Wrapper function around CONNECTOR-COOKIES-OUT. +Returns the outgoing cookie named by the string name (or NIL if there ain't no cookie with this name)." + (clawserver-cookies-out *clawserver*)) + +(defun claw-return-code () + "Wrapper function around CONNECTOR-COOKIES-OUT. +Returns the http return code of the reply. The return code of each REPLY object is initially set to 200 (OK)" + (clawserver-return-code *clawserver*)) + +(defun (setf claw-return-code) (value) + "Wrapper function around (SETF CONNECTOR-COOKIES-OUT). +Sets the http return code of the reply." + (setf (clawserver-return-code *clawserver*) value)) + +(defun claw-reply-external-format-encoding () + "Wrapper function around CONNECTOR-REPLY-EXTERNAL-FORMAT-ENCODING. +Returns the symbol of the reply charset encoding (Such as UTF-8)." + (clawserver-reply-external-format-encoding *clawserver*)) + +(defun (setf claw-reply-external-format-encoding) (value) + "Wrapper function around (SETF CONNECTOR-REPLY-EXTERNAL-FORMAT-ENCODING). +Sets the symbol of the reply charset encoding (Such as UTF-8)." + (setf (clawserver-reply-external-format-encoding *clawserver*) value)) + +(defun claw-writer () + "Wrapper function around CONNECTOR-WRITER. +Returns the output stream writer to generate replies. It's default to *standard-output*" + (clawserver-writer *clawserver*)) + +(defun claw-redirect (target &key host port protocol add-session-id code) + "Wrapper function around CONNECTOR-REDIRECT. +Sends back appropriate headers to redirect the client to target (a string)." + (clawserver-redirect *clawserver* target + :host (or host (lisplet-server-address *claw-current-lisplet*)) + :port port + :protocol protocol + :add-session-id add-session-id :code code)) + +(defun claw-session-value (symbol) + "Wrapper function around SESSION-MANAGER-SESSION-VALUE. +Returns the value identified by SYMBOL, bounded to the user session." + (session-manager-session-value (clawserver-session-manager *clawserver*) symbol)) + +(defun (setf claw-session-value) (value symbol) + "Wrapper function around (SETF SESSION-MANAGER-SESSION-VALUE). +Sets or modifies the value identified by SYMBOL, bounded to the user session" + (setf (session-manager-session-value (clawserver-session-manager *clawserver*) symbol) value)) + +(defun claw-delete-session-value (symbol) + "Wrapper function around SESSION-MANAGER-DELETE-SESSION-VALUE. +Deletes the value identified by SYMBOL, bounded to the user session. +This is different from setting the value to null." + (session-manager-delete-session-value (clawserver-session-manager *clawserver*) symbol)) +;;-------------------------------------------------------------------------------------------- +;;---------------------------------------- WRAPPERS --------------------------------------END +;;-------------------------------------------------------------------------------------------- + + +(defun duplicate-back-slashes (string) + (regex-replace-all "\" string "\\\\"))

(defun sort-by-location (location-list) "Sorts a list of location items by their first element (the location itself)." @@ -75,67 +395,41 @@ (let ((result (remove-by-location (first location-items) location-list))) (setf result (push location-items result))))

-(defun claw-start-session () +(defun claw-start-session (&key max-time domain) "Starts a session bound to the current lisplet base path" - (start-session (format nil "~a/" (build-lisplet-location (current-lisplet))))) + (session-manager-start-session (clawserver-session-manager *clawserver*) + :path (format nil "~a/" (build-lisplet-location *claw-current-lisplet*)) + :max-time max-time + :domain domain)) + +(defun claw-remove-session () + "Disposes user session if present" + (session-manager-remove-session (clawserver-session-manager *clawserver*)))

- -(defun current-page (&optional (request *request*)) - "Returns the page that is rendering" - (aux-request-value 'page request)) - -(defun (setf current-page) (page &optional (request *request*)) - "Setf the page that is to be rendered" - (setf (aux-request-value 'page request) page)) - -(defun current-realm (&optional (request *request*)) - "Returns the realm under which the request has been sent" - (aux-request-value 'realm request)) - -(defun (setf current-realm) (realm &optional (request *request*)) - "Setf the realm under which the request has been sent" - (setf (aux-request-value 'realm request) realm)) - -(defun current-lisplet (&optional (request *request*)) - "Returns the lisplet instance from which the request comes from" - (aux-request-value 'lisplet request)) - -(defun (setf current-lisplet) (lisplet &optional (request *request*)) - "Sets the lisplet instance from which the request comes from" - (setf (aux-request-value 'lisplet request) lisplet)) - -(defun current-server (&optional (request *request*)) - "Returns the clawserver instance from which the request comes from" - (aux-request-value 'clawserver request)) - -(defun (setf current-server) (server &optional (request *request*)) - "Sets the clawserver instance from which the request comes from" - (setf (aux-request-value 'clawserver request) server)) - -(defun current-principal (&optional (session *session*)) +(defun current-principal () "Returns the principal(user) that logged into the application" - (when session - (session-value 'principal session))) + (when *claw-session* + (claw-session-value 'principal)))

-(defun (setf current-principal) (principal &optional (session *session*)) +(defun (setf current-principal) (principal) "Setf the principal(user) that logged into the application" - (unless session - (setf session (claw-start-session))) - (setf (session-value 'principal session) principal)) + (unless *claw-session* + (setf *claw-session* (claw-start-session))) + (setf (claw-session-value 'principal) principal))

-(defun user-in-role-p (roles &optional (session *session*)) +(defun user-in-role-p (roles) "Detects if current principal belongs to any of the expressed roles" - (let ((principal (current-principal session))) + (let ((principal (current-principal))) (when principal (loop for el in (principal-roles principal) thereis (member el roles)))))

-(defun current-config (&optional (request *request*)) +(defun current-config () "Returns the current configuration object for the realm of the request" - (gethash (current-realm request) (clawserver-login-config (current-server request)))) + (gethash *claw-current-realm* (clawserver-login-config *clawserver*)))

-(defun login (&optional (request *request*)) +(defun login () "Perfoms a login action using the configuration object given for the request realm (see CURRENT-REALM)" - (configuration-login (current-config request))) + (configuration-login (current-config)))

(defun flatten (tree &optional result-list) "Traverses the tree in order, collecting even non-null leaves into a list." @@ -146,9 +440,9 @@ (t (push element result)))) (nreverse result)))

-(defun msie-p (&optional (request *request*)) +(defun msie-p () "Returns nil when the calling browser is not the evil of MSIE" - (let* ((header-props (headers-in request)) + (let* ((header-props (claw-headers-in)) (user-agent (find :USER-AGENT header-props :test #'(lambda (member value) (eq member (car value)))))) (when user-agent (all-matches "MSIE" (string-upcase (cdr user-agent)))))) @@ -158,33 +452,29 @@ The first message dispatching is made by the lisplet, then, if the message is not already vlorized the computation is left to the current rendering page, then to the current rendering web component. If the message is null after these passages the default value is used." - (let ((current-lisplet (gensym)) - (current-page (gensym)) - (current-component (gensym)) + (let ((current-component (gensym)) (result (gensym)) (key-val key) (locale-val (gensym)) (default-val default)) `#'(lambda () - (let ((,current-lisplet (current-lisplet)) - (,current-page (current-page)) - (,current-component (current-component)) + (let ((,current-component (current-component)) (,locale-val ,locale) (,result)) (unless ,locale-val (setf ,locale-val (user-locale))) - (when ,current-lisplet - (setf ,result (message-dispatch ,current-lisplet ,key-val ,locale-val))) - (when (and (null ,result) ,current-page) - (setf ,result (message-dispatch ,current-page ,key-val ,locale-val))) + (when *claw-current-lisplet* + (setf ,result (message-dispatch *claw-current-lisplet* ,key-val ,locale-val))) + (when (and (null ,result) *claw-current-page*) + (setf ,result (message-dispatch *claw-current-page* ,key-val ,locale-val))) (when (and (null ,result) ,current-component) (setf ,result (message-dispatch ,current-component ,key-val ,locale-val))) (when (null ,result) (setf ,locale-val "") - (when ,current-lisplet - (setf ,result (message-dispatch ,current-lisplet ,key-val ,locale-val))) - (when (and (null ,result) ,current-page) - (setf ,result (message-dispatch ,current-page ,key-val ,locale-val))) + (when *claw-current-lisplet* + (setf ,result (message-dispatch *claw-current-lisplet* ,key-val ,locale-val))) + (when (and (null ,result) *claw-current-page*) + (setf ,result (message-dispatch *claw-current-page* ,key-val ,locale-val))) (when (and (null ,result) ,current-component) (setf ,result (message-dispatch ,current-component ,key-val ,locale-val)))) (if ,result @@ -195,45 +485,90 @@ "This function calls the lambda function returned by the WITH-MESSAGE macro." (funcall (with-message key default locale)))

-(defun user-locale (&optional (request *request*) (session *session*)) +(defun user-locale () "This function returns the user locale. If no locale was directly set, the browser default locale is used." - (let ((locale (when session - (session-value 'locale session)))) - (unless locale - (setf locale (first (loop for str in (all-matches-as-strings - "[A-Z|a-z|_]+" - (regex-replace-all "-" (regex-replace-all ";.*" (header-in "ACCEPT-LANGUAGE" request) "") "_")) - collect (if (> (length str) 2) - (string-upcase str :start 2) - str))))) - locale)) + (let ((locale (when *claw-session* (claw-session-value 'locale)))) + (or locale + (first (loop for str in (all-matches-as-strings + "[A-Z|a-z|_]+" + (regex-replace-all "-" (regex-replace-all ";.*" (claw-header-in 'ACCEPT-LANGUAGE) "") "_")) + collect (if (> (length str) 2) + (string-upcase str :start 2) + str))))))

-(defun (setf user-locale) (locale &optional (session *session*)) +(defun (setf user-locale) (locale) "This function forces the locale for the current user, binding it to the user session, that is created if no session exists." - (unless session - (setf session (claw-start-session))) - (setf (session-value 'locale session) locale)) + (unless *claw-session* + (setf *claw-session* (claw-start-session))) + (setf (claw-session-value 'locale) locale))

-(defun validation-errors (&optional (request *request*)) +(defun validation-errors () "Resurns possible validation errors occurred during form rewinding" - (aux-request-value :validation-errors request)) + (claw-aux-request-value :validation-errors))

-(defun (setf validation-errors) (value &optional (request *request*)) +(defun (setf validation-errors) (value) "Sets possible validation errors occurred during form rewinding" - (setf (aux-request-value :validation-errors request) value)) + (setf (claw-aux-request-value :validation-errors) value))

-(defun validation-compliances (&optional (request *request*)) +(defun validation-compliances () "Resurns the list of components that pass validation during form rewinding" - (aux-request-value :validation-compliances request)) + (claw-aux-request-value :validation-compliances))

-(defun (setf validation-compliances) (value &optional (request *request*)) +(defun (setf validation-compliances) (value) "Sets the list of components that pass validation during form rewinding" - (setf (aux-request-value :validation-compliances request) value)) + (setf (claw-aux-request-value :validation-compliances) value))

-(defun add-validation-compliance (id &optional (request *request*)) +(defun add-validation-compliance (id) "Adds a component id to the list of components that pass validation during form rewinding" - (setf (validation-compliances request) (nconc (validation-compliances request) (list id)))) + (setf (validation-compliances) (nconc (validation-compliances) (list id)))) + +(defun claw-handle-static-file (path &optional content-type (server *clawserver*)) + "A function which acts like a Hunchentoot handler for the file +denoted by PATH. Send a content type header corresponding to +CONTENT-TYPE or (if that is NIL) tries to determine the content +type via the file's suffix." + (unless (and (fad:file-exists-p path) + (not (fad:directory-exists-p path))) + ;; does not exist + (setf (claw-return-code) 404) + (throw 'handler-done nil)) + (let ((time (or (file-write-date path) (get-universal-time)))) + (setf (claw-content-type) (or content-type + (mime-type path) + "application/octet-stream")) + ;(handle-if-modified-since time) + (with-open-file (file path + :direction :input + :element-type 'octet + :if-does-not-exist nil) + (setf (claw-header-out "Last-Modified") (rfc-1123-date time) + (claw-content-length) (file-length file)) + (let ((out (clawserver-writer server))) + (loop with buf = (make-array +buffer-length+ :element-type 'octet) + for pos = (read-sequence buf file) + until (zerop pos) + do (write-sequence buf out :end pos) + (finish-output out)))))) + +(defun claw-write-response-string (content &key (content-type "text/html") last-modified) + (when content + (when last-modified + (setf (claw-header-out "Last-Modified") (rfc-1123-date last-modified))) + (setf (claw-content-length) (length content) + (claw-content-type) content-type) + (let ((out (clawserver-writer *clawserver*))) + (write-sequence content out) + (finish-output out)) + content)) + +(defun md5-hex (string) + "Calculates the md5 sum of the string STRING and returns it as a hex string." + (with-output-to-string (s) + (loop for code across (md5:md5sum-sequence string) + do (format s "~2,'0x" code)))) + +

(defclass metacomponent (standard-class) () @@ -272,10 +607,6 @@ slot-initarg (documentation slot 't))))))))))

-(defvar *id-and-static-id-description* "- :ID The htcomponent-client-id value. CLAW can transform its value to make it univocal -- :STATIC-ID Like the :ID parameter, it sets the htcomponent-client-id instance property, but CLAW will not manage its value to manage its univocity." "Description used for describing :ID and :STATIC-ID used in claw component init functions documentation -") - (defun describe-component-behaviour (class) "Returns the behaviour descrioption of a WCOMPONENT init function. If it allows informal parameters, body and the reserved parameters" (let* ((initargs (closer-mop:class-default-initargs class)) @@ -291,7 +622,7 @@ (format nil "~{:~a ~}" (eval reserved-parameters)) "NONE"))))

-(defun register-library-resource (location resource-path &optional content-type external-format) +(defun register-library-resource (location resource-path &optional content-type) "Adds a RESOURCE (a file or directory) as a library exposed resource to the given relative LOCATION." (setf *claw-libraries-resources* (sort-by-location (pushnew-location @@ -299,21 +630,12 @@ (if (directory-pathname-p resource-path) #'(lambda () (let ((resource-full-path (merge-pathnames - (uri-to-pathname (subseq (script-name) - (+ (length (clawserver-base-path (current-server))) + (uri-to-pathname (subseq (claw-script-name) + (+ (length (clawserver-base-path *clawserver*)) (length location)))) resource-path))) - (unless (or (null external-format) - (eq (flexi-streams:external-format-name (reply-external-format)) - (flexi-streams:external-format-name external-format))) - (setf (reply-external-format) external-format)) - (handle-static-file resource-full-path content-type))) - #'(lambda () (progn - (unless (or (null external-format) - (eq (flexi-streams:external-format-name (reply-external-format)) - (flexi-streams:external-format-name external-format))) - (setf (reply-external-format) external-format)) - (handle-static-file resource-path content-type))))) + (claw-handle-static-file resource-full-path content-type))) + #'(lambda () (claw-handle-static-file resource-path content-type)))) *claw-libraries-resources*))))

(defun uri-to-pathname (uri &optional (relative t)) @@ -330,3 +652,29 @@ (cons :absolute directory-list)) :name (first file-name-and-type) :type (second file-name-and-type)))) + +(defun rfc-1123-date (&optional (time (get-universal-time))) + "Generates a time string according to RFC 1123. Default is current time." + (multiple-value-bind + (second minute hour date month year day-of-week) + (decode-universal-time time 0) + (format nil "~A, ~2,'0d ~A ~4d ~2,'0d:~2,'0d:~2,'0d GMT" + (nth day-of-week *day-names*) + date + (nth (1- month) *month-names*) + year + hour + minute + second))) + +(defun log-message (level control-string &rest args) + "Logs a message. +log-level should be one of the keywords :EMERG, :ALERT, :CRIT, :ERROR, :WARNING, :NOTICE, :INFO, or :DEBUG which correspond to the various Apache log levels. +Form the rest this method behaves like the FORMAT function." + (apply #'logger-log (if *claw-current-lisplet* + (or (lisplet-log-manager *claw-current-lisplet*) + (clawserver-log-manager *clawserver*)) + (clawserver-log-manager *clawserver*)) + level + control-string + args)) \ No newline at end of file

Modified: trunk/main/claw-core/src/packages.lisp ============================================================================== --- trunk/main/claw-core/src/packages.lisp (original) +++ trunk/main/claw-core/src/packages.lisp Thu Jul 17 09:11:41 2008 @@ -29,291 +29,434 @@

(in-package :cl-user)

-(export 'HUNCHENTOOT::REQUEST-REALM 'HUNCHENTOOT) -(export 'HUNCHENTOOT::SESSION-REALM 'HUNCHENTOOT)

(defpackage :claw - (:use :cl :closer-mop :hunchentoot :alexandria :cl-ppcre :cl-fad :local-time :split-sequence) + (:use :cl :closer-mop :alexandria :cl-ppcre :cl-fad :local-time :split-sequence :bordeaux-threads :flexi-streams) (:shadow :flatten) (:documentation "A comprehensive web application framework and server for the Common Lisp programming language") - (:export :*html-4.01-strict* - :*html-4.01-transitional* - :*html-4.01-frameset* - :*xhtml-1.0-strict* - :*xhtml-1.0-transitional* - :*xhtml-1.0-frameset* - :*rewind-parameter* - :*clawserver-base-path* - :*apache-http-port* - :*apache-https-port* - :*empty-tags* - :tag-emptyp - :strings-to-jsarray - :empty-string-p - :build-tagf - :page - :page-external-format - :page-url - :page-lisplet - :page-current-form - :page-req-parameter - :page-script-files - :page-stylesheet-files - :page-class-initscripts - :page-instance-initscripts - :page-current-component - :page-body-init-scripts - :htcomponent - :htcomponent-page - :htcomponent-body - :htcomponent-empty - :htcomponent-client-id - :htcomponent-real-id - :htcomponent-script-files - :htcomponent-stylesheet-files - :htcomponent-class-initscripts - :htcomponent-instance-initscript - :tag - :tag-name - :tag-attributes - :htbody - :htscript - :htlink - :hthead - :htstring - :$> - :$raw> + (:export #:*html-4.01-strict* + #:*html-4.01-transitional* + #:*html-4.01-frameset* + #:*xhtml-1.0-strict* + #:*xhtml-1.0-transitional* + #:*xhtml-1.0-frameset* + #:*rewind-parameter* + #:*clawserver-base-path* + #:*apache-http-port* + #:*apache-https-port* + #:*claw-default-server-address* + #:*empty-tags* + #:*clawserver* + #:*session-manager* + #:*claw-current-page* + #:*claw-current-lisplet* + #:*claw-current-realm* + #:*claw-session* + #:+http-continue+ + #:+http-switching-protocols+ + #:+http-ok+ + #:+http-created+ + #:+http-accepted+ + #:+http-non-authoritative-information+ + #:+http-no-content+ + #:+http-reset-content+ + #:+http-partial-content+ + #:+http-multi-status+ + #:+http-multiple-choices+ + #:+http-moved-permanently+ + #:+http-moved-temporarily+ + #:+http-see-other+ + #:+http-not-modified+ + #:+http-use-proxy+ + #:+http-temporary-redirect+ + #:+http-bad-request+ + #:+http-authorization-required+ + #:+http-payment-required+ + #:+http-forbidden+ + #:+http-not-found+ + #:+http-method-not-allowed+ + #:+http-not-acceptable+ + #:+http-proxy-authentication-required+ + #:+http-request-time-out+ + #:+http-conflict+ + #:+http-gone+ + #:+http-length-required+ + #:+http-precondition-failed+ + #:+http-request-entity-too-large+ + #:+http-request-uri-too-large+ + #:+http-unsupported-media-type+ + #:+http-requested-range-not-satisfiable+ + #:+http-expectation-failed+ + #:+http-failed-dependency+ + #:+http-internal-server-error+ + #:+http-not-implemented+ + #:+http-bad-gateway+ + #:+http-service-unavailable+ + #:+http-gateway-time-out+ + #:+http-version-not-supported+ + + #:claw-request-method + #:claw-script-name + #:claw-request-uri + #:claw-query-string + #:claw-get-parameter + #:claw-get-parameters + #:claw-post-parameter + #:claw-post-parameters + #:claw-parameter + #:claw-header-in + #:claw-headers-in + #:claw-authorization + #:claw-remote-addr + #:claw-remote-port + #:claw-real-remote-addr + #:claw-server-addr + #:claw-server-port + #:claw-user-agent + #:claw-referer + #:claw-cookie-in + #:claw-cookies-in + #:claw-aux-request-value + #:claw-delete-aux-request-value + #:claw-content-type + #:claw-header-out + #:claw-headers-out + #:claw-cookie-out + #:claw-cookies-out + #:claw-return-code + #:claw-reply-external-format-encoding + #:claw-writer + #:claw-redirect + #:claw-session-value + #:claw-start-session + #:claw-remove-session + #:claw-delete-session-value + #:log-message + + #:claw-cookie + #:claw-cookie-name + #:claw-cookie-value + #:claw-cookie-expires + #:claw-cookie-path + #:claw-cookie-domain + #:claw-cookie-secure + #:claw-cookie-http-only + + #:connector + #:connector-behind-apache-p + #:connector-host + #:connector-request-method + #:connector-script-name + #:connector-request-uri + #:connector-query-string + #:connector-get-parameter + #:connector-get-parameters + #:connector-post-parameter + #:connector-post-parameters + #:connector-parameter + #:connector-header-in + #:connector-headers-in + #:connector-authorization + #:connector-remote-addr + #:connector-remote-port + #:connector-real-remote-addr + #:connector-server-addr + #:connector-server-port + #:connector-server-protocol + #:connector-user-agent + #:connector-referer + #:connector-cookie-in + #:connector-cookies-in + #:connector-aux-request-value + #:connector-delete-aux-request-value + #:connector-header-out + #:connector-headers-out + #:connector-cookie-out + #:connector-cookies-out + #:connector-return-code + #:connector-content-type + #:connector-reply-external-format-encoding + #:connector-writer + #:connector-redirect + #:connector-content-length + #:connector-port + #:connector-sslport + #:connector-address + + #:logger + #:logger-log + + #:session-manager + #:default-session-manager + + #:error-page + #:render-error-page + + #:mime-type + #:duplicate-back-slashes + #:build-tagf + #:page + #:page-render + #:page-current-form + #:page-req-parameter + #:page-script-files + #:page-stylesheet-files + #:page-class-initscripts + #:page-instance-initscripts + #:page-current-component + #:page-body-init-scripts + #:htcomponent + #:htcomponent-page + #:htcomponent-body + #:htcomponent-empty + #:htcomponent-client-id + #:htcomponent-real-id + #:htcomponent-script-files + #:htcomponent-stylesheet-files + #:htcomponent-class-initscripts + #:htcomponent-instance-initscript + #:tag + #:tag-name + #:tag-attributes + #:htbody + #:htscript + #:htlink + #:hthead + #:htstring + #:$> + #:$raw> ;empty tags definition - :area> - :base> - :basefont> - :br> - :col> - :frame> - :hr> - :img> - :input> - :isindex> - :link> - :meta> - :param> + #:area> + #:base> + #:basefont> + #:br> + #:col> + #:frame> + #:hr> + #:img> + #:input> + #:isindex> + #:link> + #:meta> + #:param> ;standard tags - :a> - :abbr> - :acronym> - :address> - :applet> - :b> - :bdo> - :big> - :blockquote> - :body> - :button> - :caption> - :center> - :cite> - :code> - :colgroup> - :dd> - :del> - :dfn> - :dir> - :div> - :dl> - :dt> - :em> - :fieldset> - :font> - :form> - :frameset> - :h1> - :h2> - :h3> - :h4> - :h5> - :h6> - :head> - :html> - :i> - :iframe> - :ins> - :kbd> - :label> - :legend> - :li> - :map> - :menu> - :noframes> - :noscript> - :object> - :ol> - :optgroup> - :option> - :p> - :pre> - :q> - :s> - :samp> - :script> - :select> - :small> - :span> - :strike> - :strong> - :style> - :sub> - :sup> - :table> - :tbody> - :td> - :textarea> - :tfoot> - :th> - :thead> - :title> - :tr> - :tt> - :u> - :ul> - :var> + #:a> + #:abbr> + #:acronym> + #:address> + #:applet> + #:b> + #:bdo> + #:big> + #:blockquote> + #:body> + #:button> + #:caption> + #:center> + #:cite> + #:code> + #:colgroup> + #:dd> + #:del> + #:dfn> + #:dir> + #:div> + #:dl> + #:dt> + #:em> + #:fieldset> + #:font> + #:form> + #:frameset> + #:h1> + #:h2> + #:h3> + #:h4> + #:h5> + #:h6> + #:head> + #:html> + #:i> + #:iframe> + #:ins> + #:kbd> + #:label> + #:legend> + #:li> + #:map> + #:menu> + #:noframes> + #:noscript> + #:object> + #:ol> + #:optgroup> + #:option> + #:p> + #:pre> + #:q> + #:s> + #:samp> + #:script> + #:select> + #:small> + #:span> + #:strike> + #:strong> + #:style> + #:sub> + #:sup> + #:table> + #:tbody> + #:td> + #:textarea> + #:tfoot> + #:th> + #:thead> + #:title> + #:tr> + #:tt> + #:u> + #:ul> + #:var> ;; class modifiers - :page-content - :generate-id - :metacomponent - :wcomponent - :wcomponent-informal-parameters - :wcomponent-allow-informal-parametersp - :wcomponent-template - :wcomponent-before-rewind - :wcomponent-after-rewind - :wcomponent-before-prerender - :wcomponent-after-prerender - :wcomponent-before-render - :wcomponent-after-render - :cform - :form-method - :cform> - :action - :action-link - :action-link> - :cinput - :cinput> - :ctextarea - :ctextarea> - :cinput-file - :cinput-file> - :cinput-result-as-list-p - :ccheckbox - :ccheckbox> - :cradio - :cradio> - :cselect - :cselect> - :csubmit - :csubmit> - :csubmit-value - :submit-link - :submit-link> - :input-type - :ccheckbox-value - :css-class - :name-attr - :lisplet - :lisplet-external-format - :lisplet-pages - :lisplet-register-page-location - :lisplet-register-function-location - :lisplet-register-resource-location - :lisplet-protect - :lisplet-authentication-type - :claw-start-session - :build-lisplet-location + #:page-content + #:generate-id + #:metacomponent + #:wcomponent + #:wcomponent-informal-parameters + #:wcomponent-allow-informal-parametersp + #:wcomponent-template + #:wcomponent-before-rewind + #:wcomponent-after-rewind + #:wcomponent-before-prerender + #:wcomponent-after-prerender + #:wcomponent-before-render + #:wcomponent-after-render + #:cform + #:form-method + #:cform> + #:action + #:action-link + #:action-link> + #:cinput + #:cinput> + #:ctextarea + #:ctextarea> + #:cinput-file + #:cinput-file> + #:cinput-result-as-list-p + #:ccheckbox + #:ccheckbox> + #:cradio + #:cradio> + #:cselect + #:cselect> + #:csubmit + #:csubmit> + #:csubmit-value + #:submit-link + #:submit-link> + #:input-type + #:ccheckbox-value + #:css-class + #:name-attr + #:lisplet + + #:lisplet-log-manager + #:lisplet-server-addrss + :lisplet-error-handlers + #:lisplet-pages + #:lisplet-register-page-location + #:lisplet-register-function-location + #:lisplet-register-resource-location + #:lisplet-protect + #:lisplet-authentication-type + + #:build-lisplet-location + ;; claw-service + #:claw-service + #:claw-service-name + #:claw-service-start + #:claw-service-stop + #:claw-service-running-p ;; clawserver :clawserver - :clawserver-base-path - :clawserver-register-lisplet - :clawserver-unregister-lisplet - :clawserver-start - :clawserver-stop - :clawserver-port - :clawserver-sslport - :clawserver-address - :clawserver-name - :clawserver-sslname - :clawserver-mod-lisp-p - :clawserver-use-apache-log-p - :clawserver-input-chunking-p - :clawserver-read-timeout - :clawserver-write-timeout - :clawserver-login-config - #+(and :unix (not :win32)) :clawserver-setuid - #+(and :unix (not :win32)) :clawserver-setgid - #-:hunchentoot-no-ssl :clawserver-ssl-certificate-file - #-:hunchentoot-no-ssl :clawserver-ssl-privatekey-file - #-:hunchentoot-no-ssl :clawserver-ssl-privatekey-password - :add-exception - :component-exceptions - :msie-p - :*id-and-static-id-description* - :describe-component-behaviour - :describe-html-attributes-from-class-slot-initargs - :clawserver-register-configuration - :configuration - :configuration-login - :principal - :current-principal - :principal-name - :principal-roles - :current-lisplet - :current-server - :current-realm - :current-page - :current-component - :user-locale - :page-current-component - :user-in-role-p - :login - :register-library-resource + #:clawserver-dispatch-method + #:clawserver-log-manager + #:clawserver-add-service + #:clawserver-base-path + #:clawserver-register-lisplet + #:clawserver-unregister-lisplet + #:clawserver-start + #:clawserver-stop + #:clawserver-name + #:clawserver-sslname + #:clawserver-mod-lisp-p + #:clawserver-use-apache-log-p + #:clawserver-input-chunking-p + #:clawserver-read-timeout + #:clawserver-write-timeout + #:clawserver-login-config + + #:add-exception + #:component-exceptions + #:msie-p + #:*id-and-static-id-description* + #:describe-component-behaviour + #:describe-html-attributes-from-class-slot-initargs + #:clawserver-register-configuration + #:configuration + #:configuration-login + #:principal + #:current-principal + #:principal-name + #:principal-roles + #:current-component + #:user-locale + #:page-current-component + #:user-in-role-p + #:login + #:register-library-resource ;;i18n - :message-dispatcher - :message-dispatch - :simple-message-dispatcher - :simple-message-dispatcher-add-message - :with-message - :do-message + #:message-dispatcher + #:message-dispatch + #:simple-message-dispatcher + #:simple-message-dispatcher-add-message + #:with-message + #:do-message ;;validation - :translator - :translator-integer - :translator-number - :translator-boolean - :translator-date - :translator-file - :translator-encode - :translator-decode - :translator-string-to-type - :translator-type-to-string - :translator-value-decode - :translator-value-encode - :translator-value-string-to-type - :translator-value-type-to-string - :*simple-translator* - :*boolean-translator* - :*integer-translator* - :*number-translator* - :*date-translator-ymd* - :*date-translator-time* - :*file-translator* - :*locales* - :validate - :validation-errors - :validation-compliances - :add-validation-compliance - :component-validation-errors - :validate-required - :validate-size - :validate-range - :validate-number - :validate-integer - :validate-date-range - :exception-monitor - :exception-monitor>)) \ No newline at end of file + #:translator + #:translator-integer + #:translator-number + #:translator-boolean + #:translator-date + #:translator-file + #:translator-encode + #:translator-decode + #:translator-string-to-type + #:translator-type-to-string + #:translator-value-decode + #:translator-value-encode + #:translator-value-string-to-type + #:translator-value-type-to-string + #:*simple-translator* + #:*boolean-translator* + #:*integer-translator* + #:*number-translator* + #:*date-translator-ymd* + #:*date-translator-time* + #:*file-translator* + #:*locales* + #:validate + #:validation-errors + #:validation-compliances + #:add-validation-compliance + #:component-validation-errors + #:validate-required + #:validate-size + #:validate-range + #:validate-number + #:validate-integer + #:validate-date-range + #:exception-monitor + #:exception-monitor>)) \ No newline at end of file

Modified: trunk/main/claw-core/src/server.lisp ============================================================================== --- trunk/main/claw-core/src/server.lisp (original) +++ trunk/main/claw-core/src/server.lisp Thu Jul 17 09:11:41 2008 @@ -29,6 +29,184 @@

(in-package :claw)

+;;------------------------------------------------------------------------------------------ + +(defgeneric render-error-page (clawserver &optional error-code) + (:documentation "Method called when need to display an error page.")) + +(defgeneric clawserver-host (clawserver) + (:documentation " +Returns the value of the incoming Host http header. (This corresponds to the environment variable HTTP_HOST in CGI scripts.)")) + +(defgeneric clawserver-request-method (clawserver) + (:documentation "Returns the request method as a keyword, i.e. something like :POST. (This corresponds to the environment variable REQUEST_METHOD in CGI scripts.)")) + +(defgeneric clawserver-request-uri (clawserver) + (:documentation "Returns the URI for request. +Note that this not the full URI but only the part behind the scheme and authority components, so that if the user has typed http://user:password@www.domain.com/xxx/frob.html?foo=bar into his browser, this function will return "/xxx/frob.html?foo=bar". (This corresponds to the environment variable REQUEST_URI in CGI scripts.")) + +(defgeneric clawserver-script-name (connector) + (:documentation "Returns the file name (or path) component of the URI for request, i.e. the part of the string returned by REQUEST-URI in front of the first question mark (if any). +(This corresponds to the environment variable SCRIPT_NAME in CGI scripts.)")) + +(defgeneric clawserver-query-string (clawserver) + (:documentation "Returns the query component of the URI for request, i.e. the part of the string returned by REQUEST-URI behind the first question mark (if any). +(This corresponds to the environment variable QUERY_STRING in CGI scripts.) See also CLAWSERVER-GET-PARAMETER and CLAWSERVER-GET-PARAMETERS.")) + +(defgeneric clawserver-get-parameter (clawserver name) + (:documentation "Returns the value of the GET parameter (as provided via the request URI) named by the string name as a string (or NIL if there ain't no GET parameter with this name). +Note that only the first value will be returned if the client provided more than one GET parameter with the name name. See also CLAWSERVER-GET-PARAMETERS")) + +(defgeneric clawserver-get-parameters (clawserver) + (:documentation "Returns an alist of all GET parameters (as provided via the request URI). The car of each element of this list is the parameter's name while the cdr is its value (as a string). +The elements of this list are in the same order as they were within the request URI. See also CLAWSERVER-GET-PARAMETER.")) + +(defgeneric clawserver-post-parameter (clawserver name) + (:documentation "Returns the value of the POST parameter (as provided in the request's body) named by the string name. +Note that only the first value will be returned if the client provided more than one POST parameter with the name name. +This value will usually be a string (or NIL if there ain't no POST parameter with this name). +If, however, the browser sent a file through a multipart/form-data form, the value of this function is a three-element list + +(path file-name content-type) + +where path is a pathname denoting the place were the uploaded file was stored, file-name (a string) is the file name sent by the browser, and content-type (also a string) is the content type sent by the browser. +The file denoted by path will be deleted after the request has been handled - you have to move or copy it somewhere else if you want to keep it.")) + +(defgeneric clawserver-post-parameters (clawserver) + (:documentation "Returns an alist of all POST parameters (as provided via the request's body). The car of each element of this list is the parameter's name while the cdr is its value. The elements of this list are in the same order as they were within the request's body. +See also CLAWSERVER-POST-PARAMETER.")) + +(defgeneric clawserver-parameter (clawserver name) + (:documentation "Returns the value of the GET or POST parameter named by the string name as a string (or NIL if there ain't no parameter with this name). +If both a GET and a POST parameter with the name name exist, the GET parameter will be returned. See also CLAWSERVER-GET-PARAMETER and CLAWSERVER-POST-PARAMETER.")) + +(defgeneric clawserver-header-in (clawserver name) + (:documentation "Returns the incoming header named by the keyword name as a string (or NIL if there ain't no header with this name). +Note that this queries the headers sent to Hunchentoot by the client or by mod_lisp. In the latter case this may not only include the incoming http headers but also some headers sent by mod_lisp. +For backwards compatibility, name can also be a string which is matched case-insensitively. See also CLAWSERVER-HEADERS-IN.")) + +(defgeneric clawserver-headers-in (clawserver) + (:documentation "Returns an alist of all incoming headers. +The car of each element of this list is the headers's name (a Lisp keyword) while the cdr is its value (as a string). +There's no guarantee about the order of this list. See also CLAWSERVER-HEADER-IN and the remark about incoming headers there.")) + +(defgeneric clawserver-authorization (clawserver) + (:documentation "Returns as two values the user and password (if any) from the incoming Authorization http header. +Returns NIL if there is no such header.")) + +(defgeneric clawserver-remote-addr (clawserver) + (:documentation "Returns the IP address (as a string) of the client which sent the request. (This corresponds to the environment variable REMOTE_ADDR in CGI scripts.) See also CLAWSERVER-REAL-REMOTE-ADDR.")) + +(defgeneric clawserver-remote-port (clawserver) + (:documentation "Returns the IP port (as a number) of the client which sent the request.")) + +(defgeneric clawserver-real-remote-addr (clawserver) + (:documentation "Returns the value of the incoming X-Forwarded-For http header as the second value in the form of a list of IP addresses and the first element of this list as the first value if this header exists. +Otherwise returns the value of CLAWSERVER-REMOTE-ADDR as the only value.")) + +(defgeneric clawserver-server-addr (clawserver) + (:documentation "Returns the IP address (as a string) where the request came in. +(This corresponds to the environment variable SERVER_ADDR in CGI scripts.)")) + +(defgeneric clawserver-server-port (clawserver) + (:documentation "Returns the IP port (as a number) where the request came in.")) + +(defgeneric clawserver-server-protocol (clawserver) + (:documentation "Returns the version of the http protocol which is used by the client as a Lisp keyword - this is usually either :HTTP/1.0 or :HTTP/1.1. +(This corresponds to the environment variable SERVER_PROTOCOL in CGI scripts.")) + +(defgeneric clawserver-user-agent (clawserver) + (:documentation "Returns the value of the incoming User-Agent http header. +(This corresponds to the environment variable HTTP_USER_AGENT in CGI scripts.)")) + + +(defgeneric clawserver-referer (clawserver) + (:documentation "Returns the value of the incoming Referer (sic!) http header. (This corresponds to the environment variable HTTP_REFERER in CGI scripts.)")) + +(defgeneric clawserver-cookie-in (clawserver name) + (:documentation "Returns the value of the incoming cookie named by the string name (or NIL if there ain't no cookie with this name). +See also CLAWSERVER-COOKIES-IN")) + +(defgeneric clawserver-cookies-in (clawserver) + (:documentation "Returns an alist of all incoming cookies. +The car of each element of this list is the cookie's name while the cdr is the cookie's value. See also CLAWSERVER-COOKIE-IN")) + +(defgeneric clawserver-aux-request-value (clawserver symbol) + (:documentation "This accessor can be used to associate arbitrary data with the the symbol symbol in the REQUEST object request. present-p is true if such data was found, otherwise NIL")) + +(defgeneric (setf clawserver-aux-request-value) (value clawserver symbol) + (:documentation "This accessor can be used to associate arbitrary data with the the symbol symbol in the REQUEST object request. present-p is true if such data was found, otherwise NIL")) + +(defgeneric clawserver-delete-aux-request-value (clawserver symbol) + (:documentation "Completely removes any data associated with the symbol symbol from the REQUEST object request. Note that this is different from using AUX-REQUEST-VALUE to set the data to NIL")) + +(defgeneric clawserver-header-out (clawserver name) + (:documentation "Returns the outgoing http header named by the keyword name if there is one, otherwise NIL (name parameter must be a symbol). +Note that the headers Set-Cookie, Content-Length, and Content-Type cannot be queried by HEADER-OUT. +See also CLAWSERVER-HEADERS-OUT, CLAWSERVER-CONTENT-TYPE, CLAWSERVER-CONTENT-LENGTH, CLAWSERVER-COOKIES-OUT, and CLAWSERVER-COOKIE-OUT")) + +(defgeneric (setf clawserver-header-out) (value clawserver name) + (:documentation "SETF of HEADER-OUT changes the current value of the header named name (name parameter must be a symbol). +If no header named name exists it is created. +Note that the headers Set-Cookie, Content-Length, and Content-Type must not be set by SETF of HEADER-OUT. +Also, there are a couple of "technical" headers like Connection or Transfer-Encoding that you're not supposed to set yourself. +See also CLAWSERVER-HEADERS-OUT, CLAWSERVER-CONTENT-TYPE, CLAWSERVER-CONTENT-LENGTH, CLAWSERVER-COOKIES-OUT, and CLAWSERVER-COOKIE-OUT")) + +(defgeneric clawserver-headers-out (clawserver) + (:documentation "Returns an alist of all outgoing http parameters (except for Set-Cookie, Content-Length, and Content-Type). +The car of each element of this list is the headers's name while the cdr is its value. +This alist should not be manipulated directly, use SETF of CLAWSERVER-HEADER-OUT instead")) + +(defgeneric clawserver-cookie-out (clawserver name) + (:documentation "Returns the outgoing cookie named by the string name (or NIL if there ain't no cookie with this name). +See also CLAWSERVER-COOKIES-OUT and the CLAW-COOKIE class definition.")) + +(defgeneric (setf clawserver-cookie-out) (cookie-instance clawserver name) + (:documentation "Creates a CLAW-COOKIE object from the parameters provided to this function and adds it to the outgoing cookies of the REPLY object reply. +If a cookie with the same name (case-sensitive) already exists, it is replaced. + The default for value is the empty string.")) + +(defgeneric clawserver-cookies-out (clawserver) + (:documentation "Returns the outgoing cookie named by the string name (or NIL if there ain't no cookie with this name). +See also CLAWSERVER-COOKIES-OUT and the CLAW-COOKIE class definition.")) + +(defgeneric clawserver-return-code (clawserver) + (:documentation "CLAWSERVER-RETURN-CODE returns the http return code of the reply. The return code of each REPLY object is initially set to 200 (OK)")) + +(defgeneric (setf clawserver-return-code) (value clawserver) + (:documentation "Setf CLAWSERVER-RETURN-CODE sets the http return code of the reply.")) + +(defgeneric clawserver-content-type (clawserver) + (:documentation "CLAWSERVER-CONTENT-TYPE returns the outgoing Content-Type http header (such as: "text/html; charset=utf-8").")) + +(defgeneric (setf clawserver-content-type) (value clawserver) + (:documentation "SETF CLAWSERVER-CONTENT-TYPE sets the outgoing Content-Type http header (such as: "text/html; charset=utf-8").")) + +(defgeneric clawserver-content-length (clawserver) + (:documentation "Returns the outgoing Content-Length http header")) + +(defgeneric (setf clawserver-content-length) (value clawserver) + (:documentation "Sets the outgoing Content-Length http header")) + +(defgeneric clawserver-reply-external-format-encoding (clawserver) + (:documentation "CLAWSERVER-REPLY-EXTERNAL-FORMAT-ENCODING returns the symbol of the reply charset encoding (Such as UTF-8).")) + +(defgeneric (setf clawserver-reply-external-format-encoding) (value clawserver) + (:documentation "SETF CLAWSERVER-REPLY-EXTERNAL-FORMAT-ENCODING sets the symbol of the reply charset encoding (Such as UTF-8).")) + +(defgeneric clawserver-writer (clawserver) + (:documentation "Returns the output stream writer to generate replies. It's default to *standard-output*")) + +(defgeneric clawserver-redirect (clawserver target &key host port protocol add-session-id code) + (:documentation "Sends back appropriate headers to redirect the client to target (a string). +If target is a full URL starting with a scheme, host, port, and protocol are ignored. +Otherwise, target should denote the path part of a URL, protocol must be one of the keywords :HTTP or :HTTPS, and the URL to redirect to will be constructed from host, port, protocol, and target. +If code is a 3xx redirection code, it will be sent as status code. +In case of NIL, a 302 status code will be sent to the client. If host is not provided, the current host (see CLAWSERVER-HOST) will be used. +If protocol is the keyword :HTTPS, the client will be redirected to a https URL, if it's :HTTP it'll be sent to a http URL. If both host and protocol aren't provided, then the value of protocol will match the current request.")) +;;------------------------------------------------------------------------------------------ + + (defgeneric clawserver-dispatch-request (clawserver) (:documentation "Dispatches http requests through registered dispatchers"))

@@ -50,53 +228,52 @@ (defgeneric (setf clawserver-address) (address clawserver) (:documentation "Binds the claw server to a specific address. When server is started an error will be signaled."))

-(defgeneric (setf clawserver-name) (name clawserver) - (:documentation "Sets the name of the server that dispatches http requests.")) - -(defgeneric (setf clawserver-sslname) (sslname clawserver) - (:documentation "Sets the name of the server that dispatches https requests.")) - -(defgeneric (setf clawserver-mod-lisp-p) (mod-lisp-p clawserver) - (:documentation "When not null binds the claw server to apache using mod_lisp2. When server is started an error will be signaled.")) - -(defgeneric (setf clawserver-use-apache-log-p) (apache-log-p clawserver) - (:documentation "When boud to apache with mod_lisp2 if not nil, uses apache logging. When server is started an error will be signaled.")) - -(defgeneric (setf clawserver-input-chunking-p) (input-chunking-p clawserver) - (:documentation "Sets input-chunking-p, when true the server will accept request -bodies without a Content-Length header if the client uses chunked transfer encoding. -If you want to use this feature behind mod_lisp, you should make sure that your combination of -Apache and mod_lisp can cope with that. When server is started an error will be signaled.")) - +(defgeneric clawserver-behind-apache-p (clawserver) + (:documentation "Returns true if the server (or better, the connector) is running behind apache.")) +;;----------------------------------------------------------------------------------------------- (defgeneric (setf clawserver-read-timeout) (read-timeout clawserver) (:documentation "Sets the read timeout in seconds. When server is started an error will be signaled."))

(defgeneric (setf clawserver-write-timeout) (write-timeout clawserver) (:documentation "Sets the write timeout in seconds. When server is started an error will be signaled."))

-#+(and :unix (not :win32)) (defgeneric (setf clawserver-setuid) (setuid clawserver) - (:documentation "Sets the uid under which the server runs (Only for *NIX). When server is started an error will be signaled.")) - -#+(and :unix (not :win32)) (defgeneric (setf clawserver-setgid) (setgid clawserver) - (:documentation "Sets the gid under which the server runs (Only for *NIX). When server is started an error will be signaled.")) +(defgeneric clawserver-add-service (clawserver service) + (:documentation "Registers a service for the given CLAWSERVER object with the given SERVICE name. +A service may be added if the CLAWSERVER object is not running."))

-#-:hunchentoot-no-ssl (defgeneric (setf clawserver-ssl-certificate-file) (certificate-file clawserver) - (:documentation "The ssl certificate file for https connections. When server is started an error will be signaled.")) - -#-:hunchentoot-no-ssl (defgeneric (setf clawserver-ssl-privatekey-file) (ssl-privatekey-file clawserver) - (:documentation "The ssl private key file for https connections. When server is started an error will be signaled.")) - -#-:hunchentoot-no-ssl (defgeneric (setf clawserver-ssl-privatekey-password) (ssl-privatekey-password clawserver) - (:documentation "The password for the ssl private key file. When server is started an error will be signaled.")) +;;------------------------------------------------------------

(defgeneric clawserver-register-configuration(clawserver realm configuration) (:documentation "Registers a configuration object for the given realm into the server. The configuration will perform the authentication logic."))

-(defgeneric configuration-login (configuration &optional request) +(defgeneric configuration-login (configuration) (:documentation "Authenticate a user creating a principal object that will be stored into the http session. If no session is present one will be created, if the authentication succeds the principal instance is returned"))

+(defgeneric claw-service-start (claw-service) + (:documentation "Starts the service")) + +(defgeneric claw-service-stop (claw-service) + (:documentation "Stop the service")) + +(defclass claw-service () + ((running-p :initform nil + :accessor claw-service-running-p + :documentation "Returns if the server is running or not.") + (name :initarg :name + :type symbol + :reader claw-service-name + :documentation "Mandatory and unique service name that will be used inside the CLAWSERVER object.")) + (:documentation "Generic claw service, must implement claw-service-start and claw-service-stop. +A service injected into a CLAWSERVER oject via CLAWSERVER-ADD-SERVICE method is automatically started or stopped when the CLAWSERVER object is started or stopped")) + +(defmethod claw-service-start ((claw-service claw-service)) + (setf (claw-service-running-p claw-service) t)) + +(defmethod claw-service-stop ((claw-service claw-service)) + (setf (claw-service-running-p claw-service) nil)) + (defclass error-page (page) ((title :initarg :title :reader page-title @@ -151,7 +328,8 @@ (defmethod wcomponent-template ((error-page-template error-page-template)) (let ((error-code (error-code error-page-template)) (title (title error-page-template)) - (style (style error-page-template))) + (style (style error-page-template)) + (request-uri (connector-request-uri (clawserver-connector *clawserver*)))) (html> (head> (title> title) @@ -159,7 +337,7 @@ (body> (p> (p> :class "h1" - (format nil "HTTP Status ~a - ~a" error-code (request-uri *request*))) + (format nil "HTTP Status ~a - ~a" error-code request-uri)) (hr> :noshade "noshade") (p> (span> :class "blue" @@ -168,101 +346,47 @@ (p> (span> :class "blue" "url") - (request-uri *request*)) + request-uri) (p> (span> :class "blue" "description") - (gethash error-code hunchentoot::*http-reason-phrase-map*) + (gethash error-code *http-reason-phrase-map*) (hr> :noshade "noshade")) (p> :class "h2" "claw server"))))))

(defmethod page-content ((error-page error-page)) - (error-page-template> :title (page-title error-page) - :error-code (page-error-code error-page) - (format nil "The requested resource (~a) is not available." (request-uri *request*)))) + (let ((connector (clawserver-connector *clawserver*))) + (error-page-template> :title (page-title error-page) + :error-code (page-error-code error-page) + (format nil "The requested resource (~a) is not available." (connector-request-uri connector)))))

(defclass clawserver () ((base-path :initarg :base-path :accessor clawserver-base-path :documentation "This slot is used to keep all server resources under a common URL") - (port :initarg :port - :reader clawserver-port - :documentation "Returns the claw server http port") - (sslport :initarg :sslport - :reader clawserver-sslport - :documentation "Returns the claw server https port") - (address :initarg :address - :reader clawserver-address - :documentation "Returns the address where claw server is bound to.") - (name :initarg :name - :reader clawserver-name - :documentation "Returns the name of the server that dispatches http requests.") - (sslname :initarg :sslname - :reader clawserver-sslname - :documentation "Returns the name of the server that dispatches https requests.") - (mod-lisp-p :initarg :mod-lisp-p - :reader clawserver-mod-lisp-p - :documentation "Returns not nil when the server is bound to apache through mod_lisp") - (use-apache-log-p :initarg :use-apache-log-p - :reader clawserver-use-apache-log-p - :documentation "Returns not nil when the server uses apache logging") - (input-chunking-p :initarg :input-chunking-p - :reader clawserver-input-chunking-p - :documentation "When true the server will accept request -bodies without a Content-Length header if the client uses chunked transfer encoding. -If you want to use this feature behind mod_lisp, you should make sure that your combination of -Apache and mod_lisp can cope with that.") - (read-timeout :initarg :read-timeout - :reader clawserver-read-timeout - :documentation "Returns the server read timeout in seconds.") - (write-timeout :initarg :write-timeout - :reader clawserver-write-timeout - :documentation "Returns the server write timeout in seconds.") + (connector :initarg :connector + :accessor clawserver-connector + :documentation "Reads or sets the server connector that dispatches requests and processes replies from the remote host.") + (log-manager :initarg :log-manager + :accessor clawserver-log-manager + :documentation "Required log meanager used to log application messages when no lisplet one is provided") + (session-manager :initarg :session-manager + :accessor clawserver-session-manager + :documentation "Accessor for the session manager. See the definition of the SESSION-MANAGER class.") + (services :initarg :services + :accessor clawserver-services + :documentation "A hash map of services handled by the current server") (login-config :initform (make-hash-table :test 'equal) :accessor clawserver-login-config :documentation "An hash table holding a pair of realm, expressed as string, and a predicate. The predicate should take two arguments (login and password), and return a principal instance if the login call succeeds.") - #+(and :unix (not :win32)) (setuid :initarg :setuid - :reader clawserver-setuid - :documentation "Returns the uid under which the server runs.") - #+(and :unix (not :win32)) (setgid :initarg :setgid - :reader clawserver-setgid - :documentation "Returns the gid under which the server runs.") - #-:hunchentoot-no-ssl (ssl-certificate-file :initarg :ssl-certificate-file - :reader clawserver-ssl-certificate-file - :documentation "The ssl certificate file for https connections.") - #-:hunchentoot-no-ssl (ssl-privatekey-file :initarg :ssl-privatekey-file - :reader clawserver-ssl-privatekey-file - :documentation "The ssl private key file for https connections") - #-:hunchentoot-no-ssl (ssl-privatekey-password :initarg :ssl-privatekey-password - :reader clawserver-ssl-privatekey-password - :documentation "The password for the ssl private key file for https connections") - (server :initform nil - :accessor clawserver-server - :documentation "The hunchentoot server dispatching http requests.") - (sslserver :initform nil - :accessor clawserver-sslserver - :documentation "The hunchentoot server dispatching https requests.") (dispatchers :initform nil :accessor clawserver-dispatchers :documentation "A collection of cons where the car is an url location where a lisplet is registered and the cdr is a dispatcher for that lisplet")) (:default-initargs :base-path "" - :use-apache-log-p nil - :address nil - :name (gensym) - :sslname (gensym) - :port 80 - :sslport 443 - :mod-lisp-p nil - :input-chunking-p t - :read-timeout *default-read-timeout* - :write-timeout *default-write-timeout* - #+(and :unix (not :win32)) :setuid nil - #+(and :unix (not :win32)) :setgid nil - #-:hunchentoot-no-ssl :ssl-certificate-file nil - #-:hunchentoot-no-ssl :ssl-privatekey-password nil) + :services (make-hash-table)) (:documentation "CLAWSERVER is built around huncentoot and has the instructions for lisplet dispatching, so use this class to start and stop 3hunchentoot server.")) @@ -271,8 +395,8 @@ () (:documentation "A configuration class for CLAW server realm login configurations"))

-(defmethod configuration-login ((configuration configuration) &optional (request *request*)) - (declare (ignore request))) +(defmethod configuration-login ((configuration configuration)) + nil)

(defclass principal () ((name :initarg :name @@ -284,90 +408,12 @@ (:default-initargs :roles nil) (:documentation "An instance of PRINCIPAL is stored into session after a user successfully login into the application."))

-(defmethod initialize-instance :after ((clawserver clawserver) &rest keys) - (let ((use-apache-log-p (getf keys :use-apache-log-p :undefined)) - #-:hunchentoot-no-ssl (ssl-privatekey-file (getf keys :ssl-privatekey-file :undefined))) - (when (eq use-apache-log-p :undefined) - (setf (clawserver-use-apache-log-p clawserver) (getf keys :mod-lisp-p))) - #-:hunchentoot-no-ssl (when (eq ssl-privatekey-file :undefined) - (setf (clawserver-ssl-privatekey-file clawserver) (getf keys :ssl-certificate-file)))))

;;;-------------------------- WRITERS ----------------------------------------

-(defmethod (setf clawserver-port) (port (clawserver clawserver)) - (unless (null (clawserver-server clawserver)) - (error "Cannot change port when server is started")) - (setf (slot-value clawserver 'port) port)) - -(defmethod (setf clawserver-sslport) (sslport (clawserver clawserver)) - (unless (null (clawserver-server clawserver)) - (error "Cannot change SSL port when server is started")) - (setf (slot-value clawserver 'sslport) sslport)) - -(defmethod (setf clawserver-address) (address (clawserver clawserver)) - (unless (null (clawserver-server clawserver)) - (error "Cannot change binding address when server is started")) - (setf (slot-value clawserver 'address) address)) - -(defmethod (setf clawserver-name) (name (clawserver clawserver)) - (unless (null (clawserver-server clawserver)) - (setf (server-name (clawserver-server clawserver)) name)) - (setf (slot-value clawserver 'name) name)) - -(defmethod (setf clawserver-sslname) (sslname (clawserver clawserver)) - (unless (null (clawserver-sslserver clawserver)) - (setf (server-name (clawserver-sslserver clawserver)) sslname)) - (setf (slot-value clawserver 'sslname) sslname)) - -(defmethod (setf clawserver-mod-lisp-p) (mod-lisp-p (clawserver clawserver)) - (unless (null (clawserver-server clawserver)) - (error "Cannot change mod-lisp property when server is started")) - (setf (slot-value clawserver 'mod-lisp-p) mod-lisp-p)) - -(defmethod (setf clawserver-use-apache-log-p) (use-apache-log-p (clawserver clawserver)) - (unless (null (clawserver-server clawserver)) - (error "Cannot change logging property when server is started")) - (setf (slot-value clawserver 'use-apache-log-p) use-apache-log-p)) - -(defmethod (setf clawserver-input-chunking-p) (input-chunking-p (clawserver clawserver)) - (unless (null (clawserver-server clawserver)) - (error "Cannot change chunking property when server is started")) - (setf (slot-value clawserver 'input-chunking-p) input-chunking-p)) - -(defmethod (setf clawserver-read-timeout) (read-timeout (clawserver clawserver)) - (unless (null (clawserver-server clawserver)) - (error "Cannot change read timeout property when server is started")) - (setf (slot-value clawserver 'read-timeout) read-timeout)) - -(defmethod (setf clawserver-write-timeout) (write-timeout (clawserver clawserver)) - (unless (null (clawserver-server clawserver)) - (error "Cannot change write timeout property when server is started")) - (setf (slot-value clawserver 'write-timeout) write-timeout)) - -#+(and :unix (not :win32)) (defmethod (setf clawserver-setuid) (setuid (clawserver clawserver)) - (unless (null (clawserver-server clawserver)) - (error "Cannot change uid property when server is started")) - (setf (slot-value clawserver 'setuid) setuid)) - -#+(and :unix (not :win32)) (defmethod (setf clawserver-setgid) (setgid (clawserver clawserver)) - (unless (null (clawserver-server clawserver)) - (error "Cannot change gid property when server is started")) - (setf (slot-value clawserver 'setgid) setgid)) - -#-:hunchentoot-no-ssl (defmethod (setf clawserver-ssl-certificate-file) (ssl-certificate-file (clawserver clawserver)) - (unless (null (clawserver-server clawserver)) - (error "Cannot change ssl certificate file property when server is started")) - (setf (slot-value clawserver 'ssl-certificate-file) ssl-certificate-file)) - -#-:hunchentoot-no-ssl (defmethod (setf clawserver-ssl-privatekey-file) (ssl-privatekey-file (clawserver clawserver)) - (unless (null (clawserver-server clawserver)) - (error "Cannot change ssl privatekey file property when server is started")) - (setf (slot-value clawserver 'ssl-privatekey-file) ssl-privatekey-file)) - -#-:hunchentoot-no-ssl (defmethod (setf clawserver-ssl-privatekey-password) (ssl-privatekey-password (clawserver clawserver)) - (unless (null (clawserver-server clawserver)) - (error "Cannot change ssl privatekey password property when server is started")) - (setf (slot-value clawserver 'ssl-privatekey-password) ssl-privatekey-password)) +(defmethod clawserver-add-service ((server clawserver) (service claw-service)) + (setf (gethash (claw-service-name service) (clawserver-services server)) service)) +

;;;-------------------------- METHODS ----------------------------------------

@@ -375,92 +421,219 @@ (setf (gethash realm (clawserver-login-config clawserver)) configuration))

+(defmethod render-error-page ((clawserver clawserver) &optional (error-code +http-not-found+)) + (let ((connector (clawserver-connector clawserver))) + (setf (claw-return-code) +http-ok+) + (page-render (make-instance 'error-page + :title (format nil "Server error: ~a" error-code) + :writer (connector-writer connector) + :error-code error-code)))) + (defmethod clawserver-dispatch-request ((clawserver clawserver)) - (let ((base-path (clawserver-base-path clawserver)) - (dispatchers (clawserver-dispatchers clawserver)) - (script-name (script-name)) - (rel-script-name) - (rel-script-name-libs)) - (setf (current-server) clawserver) - (when (starts-with-subseq script-name base-path) - (setf rel-script-name (subseq script-name (length base-path)) - rel-script-name-libs (subseq script-name (1+ (length base-path)))) - (or - (loop for dispatcher in *claw-libraries-resources* - for url = (car dispatcher) - for action = (cdr dispatcher) - do (when (starts-with-subseq rel-script-name-libs url) (funcall action))) - (loop for dispatcher in dispatchers - for url = (car dispatcher) - for action = (cdr dispatcher) - do (when (starts-with-subseq rel-script-name url) (return (funcall action)))))))) + (let* ((*clawserver* clawserver) + (*session-manager* (clawserver-session-manager clawserver)) + (connector (clawserver-connector clawserver)) + (base-path (clawserver-base-path clawserver)) + (dispatchers (clawserver-dispatchers clawserver)) + (script-name (connector-script-name connector)) + (rel-script-name) + (rel-script-name-libs) + (http-result)) + (handler-bind ((error (lambda (cond) + ;(log-message :error "~a" cond) + (logger-log (clawserver-log-manager clawserver) :error "~a" cond) + (with-output-to-string (*standard-output*) + (render-error-page clawserver +http-internal-server-error+))))) + (unwind-protect + (catch 'handler-done + (if (starts-with-subseq script-name base-path) + (progn + (setf rel-script-name (subseq script-name (length base-path)) + rel-script-name-libs (subseq script-name (1+ (length base-path)))) + (setf http-result (or + (loop for dispatcher in *claw-libraries-resources* + for url = (car dispatcher) + for action = (cdr dispatcher) + do (when (starts-with-subseq rel-script-name-libs url) (funcall action))) + (loop for dispatcher in dispatchers + for url = (car dispatcher) + for action = (cdr dispatcher) + do (when (starts-with-subseq rel-script-name url) (return (funcall action)))))))))) + (or http-result + (with-output-to-string (*standard-output*) + (render-error-page clawserver (or + (let ((return-code (claw-return-code))) + (if (= return-code +http-ok+) + nil + return-code)) + +http-not-found+))))))) +

(defmethod clawserver-dispatch-method ((clawserver clawserver)) - (let ((result (clawserver-dispatch-request clawserver))) + (let ((result (clawserver-dispatch-request clawserver)) + (connector (clawserver-connector clawserver))) (if (null result) - #'(lambda () (when (= (return-code) +http-ok+) - (setf (return-code *reply*) +http-not-found+))) + #'(lambda () (when (= (connector-return-code connector) 200) ;OK + (setf (connector-return-code connector) 404))) ; Not found #'(lambda () result))))

(defmethod clawserver-start ((clawserver clawserver)) - (let ((port (clawserver-port clawserver)) - (sslport (clawserver-sslport clawserver)) - (address (clawserver-address clawserver)) - (dispatch-table (list #'(lambda (request) - (declare (ignorable request)) - (clawserver-dispatch-method clawserver)))) - (name (clawserver-name clawserver)) - (sslname (clawserver-sslname clawserver)) - (mod-lisp-p (clawserver-mod-lisp-p clawserver)) - (use-apache-log-p (clawserver-use-apache-log-p clawserver)) - (input-chunking-p (clawserver-input-chunking-p clawserver)) - (read-timeout (clawserver-read-timeout clawserver)) - (write-timeout (clawserver-write-timeout clawserver)) - (uid (clawserver-setuid clawserver)) - (gid (clawserver-setgid clawserver)) - (ssl-certificate-file (clawserver-ssl-certificate-file clawserver)) - (ssl-privatekey-file (clawserver-ssl-privatekey-file clawserver)) - (ssl-privatekey-password (clawserver-ssl-privatekey-password clawserver))) - (progn - (setf (clawserver-server clawserver) - (start-server :port port - :address address - :dispatch-table dispatch-table - :name name - :mod-lisp-p mod-lisp-p - :use-apache-log-p use-apache-log-p - :input-chunking-p input-chunking-p - :read-timeout read-timeout - :write-timeout write-timeout - #+(and :unix (not :win32)) :setuid uid - #+(and :unix (not :win32)) :setgid gid)) - #-:hunchentoot-no-ssl (when ssl-certificate-file - (setf (clawserver-sslserver clawserver) - (start-server :port sslport - :address address - :dispatch-table dispatch-table - :name sslname - :mod-lisp-p mod-lisp-p - :use-apache-log-p use-apache-log-p - :input-chunking-p input-chunking-p - :read-timeout read-timeout - :write-timeout write-timeout - #+(and :unix (not :win32)) :setuid uid - #+(and :unix (not :win32)) :setgid gid - :ssl-certificate-file ssl-certificate-file - :ssl-privatekey-file ssl-privatekey-file - :ssl-privatekey-password ssl-privatekey-password)))))) + (let ((*clawserver* clawserver) + (log-manager (clawserver-log-manager clawserver)) + (connector (clawserver-connector clawserver)) + (sm (clawserver-session-manager clawserver))) + (unless (claw-service-running-p log-manager) + (claw-service-start log-manager)) + (unless (claw-service-running-p connector) + (claw-service-start connector)) + (claw-service-start sm)))

(defmethod clawserver-stop ((clawserver clawserver)) - (progn - (setf (clawserver-server clawserver) (stop-server (clawserver-server clawserver))) - (when (clawserver-sslserver clawserver) - (setf (clawserver-sslserver clawserver) (stop-server (clawserver-sslserver clawserver)))))) -;;;---------------------------------------------------------------------------- -(defun login (&optional (request *request*)) + (let ((*clawserver* clawserver) + (log-manager (clawserver-log-manager clawserver)) + (connector (clawserver-connector clawserver)) + (sm (clawserver-session-manager clawserver))) + (when (claw-service-running-p connector) + (claw-service-stop connector)) + (when (claw-service-running-p log-manager) + (claw-service-stop log-manager)) + (claw-service-stop sm))) + +(defun login () "Perform user authentication for the reaml where the request has been created" - (let* ((server (current-server request)) - (realm (current-realm request)) - (login-config (gethash realm (clawserver-login-config server)))) - (configuration-login login-config request))) + (let* ((login-config (gethash *claw-current-realm* (clawserver-login-config *clawserver*)))) + (configuration-login login-config))) + + + + +;;------------------------------------------------------------------------------------------------------- + +(defmethod clawserver-host ((clawserver clawserver)) + (connector-host (clawserver-connector clawserver))) + +(defmethod clawserver-request-method ((clawserver clawserver)) + (connector-request-method (clawserver-connector clawserver))) + +(defmethod clawserver-request-uri ((clawserver clawserver)) + (connector-request-uri (clawserver-connector clawserver))) + +(defmethod clawserver-query-string ((clawserver clawserver)) + (connector-query-string (clawserver-connector clawserver))) + +(defmethod clawserver-get-parameter ((clawserver clawserver) name) + (connector-get-parameter (clawserver-connector clawserver) name)) + +(defmethod clawserver-get-parameters ((clawserver clawserver)) + (connector-get-parameters (clawserver-connector clawserver))) + +(defmethod clawserver-post-parameter ((clawserver clawserver) name) + (connector-post-parameter (clawserver-connector clawserver) name)) + +(defmethod clawserver-post-parameters ((clawserver clawserver)) + (connector-post-parameters (clawserver-connector clawserver))) + +(defmethod clawserver-parameter ((clawserver clawserver) name) + (connector-parameter (clawserver-connector clawserver) name)) + +(defmethod clawserver-header-in ((clawserver clawserver) name) + (connector-header-in (clawserver-connector clawserver) name)) + +(defmethod clawserver-headers-in ((clawserver clawserver)) + (connector-headers-in (clawserver-connector clawserver))) + +(defmethod clawserver-authorization ((clawserver clawserver)) + (connector-authorization (clawserver-connector clawserver))) + +(defmethod clawserver-remote-addr ((clawserver clawserver)) + (connector-remote-addr (clawserver-connector clawserver))) + +(defmethod clawserver-remote-port ((clawserver clawserver)) + (connector-remote-port (clawserver-connector clawserver))) + +(defmethod clawserver-real-remote-addr ((clawserver clawserver)) + (connector-real-remote-addr (clawserver-connector clawserver))) + +(defmethod clawserver-server-addr ((clawserver clawserver)) + (connector-server-addr (clawserver-connector clawserver))) + +(defmethod clawserver-server-port ((clawserver clawserver)) + (connector-server-port (clawserver-connector clawserver))) + +(defmethod clawserver-server-protocol ((clawserver clawserver)) + (connector-server-protocol (clawserver-connector clawserver))) + +(defmethod clawserver-user-agent ((clawserver clawserver)) + (connector-user-agent (clawserver-connector clawserver))) + +(defmethod clawserver-referer ((clawserver clawserver)) + (connector-referer (clawserver-connector clawserver))) + +(defmethod clawserver-cookie-in ((clawserver clawserver) name) + (connector-cookie-in (clawserver-connector clawserver) name)) + +(defmethod clawserver-cookies-in ((clawserver clawserver)) + (connector-cookies-in (clawserver-connector clawserver))) + +(defmethod clawserver-aux-request-value ((clawserver clawserver) symbol) + (connector-aux-request-value (clawserver-connector clawserver) symbol)) + +(defmethod (setf clawserver-aux-request-value) (value (clawserver clawserver) symbol) + (setf (connector-aux-request-value (clawserver-connector clawserver) symbol) value)) + +(defmethod clawserver-delete-aux-request-value ((clawserver clawserver) symbol) + (connector-delete-aux-request-value (clawserver-connector clawserver) symbol)) + +(defmethod clawserver-header-out ((clawserver clawserver) name) + (connector-header-out (clawserver-connector clawserver) name)) + +(defmethod (setf clawserver-header-out) (value (clawserver clawserver) name) + (setf (connector-header-out (clawserver-connector clawserver) name) value)) + +(defmethod clawserver-headers-out ((clawserver clawserver)) + (connector-headers-out (clawserver-connector clawserver))) + +(defmethod clawserver-cookie-out ((clawserver clawserver) name) + (connector-cookie-out (clawserver-connector clawserver) name)) + +(defmethod (setf clawserver-cookie-out) (cookie-instance (clawserver clawserver) name) + (setf (connector-cookie-out (clawserver-connector clawserver) name) cookie-instance)) + +(defmethod clawserver-cookies-out ((clawserver clawserver)) + (connector-cookies-out (clawserver-connector clawserver))) + +(defmethod clawserver-return-code ((clawserver clawserver)) + (connector-return-code (clawserver-connector clawserver))) + +(defmethod (setf clawserver-return-code) (value (clawserver clawserver)) + (setf (connector-return-code (clawserver-connector clawserver)) value)) + +(defmethod clawserver-content-type ((clawserver clawserver)) + (connector-content-type (clawserver-connector clawserver))) + +(defmethod (setf clawserver-content-type) (value (clawserver clawserver)) + (setf (connector-content-type (clawserver-connector clawserver)) value)) + +(defmethod clawserver-content-length ((clawserver clawserver)) + (connector-content-length (clawserver-connector clawserver))) + +(defmethod (setf clawserver-content-length) (value (clawserver clawserver)) + (setf (connector-content-length (clawserver-connector clawserver)) value)) + +(defmethod clawserver-reply-external-format-encoding ((clawserver clawserver)) + (connector-reply-external-format-encoding (clawserver-connector clawserver))) + +(defmethod (setf clawserver-reply-external-format-encoding) (value (clawserver clawserver)) + (setf (connector-reply-external-format-encoding (clawserver-connector clawserver)) value)) + +(defmethod clawserver-writer ((clawserver clawserver)) + (connector-writer (clawserver-connector clawserver))) + +(defmethod clawserver-redirect (clawserver target &key host port protocol add-session-id code) + (connector-redirect (clawserver-connector clawserver) target :host host :port port :protocol protocol :add-session-id add-session-id :code code)) + +(defmethod clawserver-behind-apache-p ((clawserver clawserver)) + (connector-behind-apache-p (clawserver-connector clawserver)))

+(defmethod clawserver-script-name ((clawserver clawserver)) + (connector-script-name (clawserver-connector clawserver))) \ No newline at end of file

Added: trunk/main/claw-core/src/session-manager.lisp ============================================================================== --- (empty file) +++ trunk/main/claw-core/src/session-manager.lisp Thu Jul 17 09:11:41 2008 @@ -0,0 +1,374 @@ +;; -*- Mode: LISP; Syntax: COMMON-LISP; Package: CL-USER; Base: 10 -*- +;;; $Header: src/session-manager.lisp $ + +;;; Copyright (c) 2008, Andrea Chiumenti. All rights reserved. + +;;; Redistribution and use in source and binary forms, with or without +;;; modification, are permitted provided that the following conditions +;;; are met: + +;;; * Redistributions of source code must retain the above copyright +;;; notice, this list of conditions and the following disclaimer. + +;;; * Redistributions in binary form must reproduce the above +;;; copyright notice, this list of conditions and the following +;;; disclaimer in the documentation and/or other materials +;;; provided with the distribution. + +;;; THIS SOFTWARE IS PROVIDED BY THE AUTHOR 'AS IS' AND ANY EXPRESSED +;;; OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +;;; WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +;;; ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY +;;; DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +;;; DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE +;;; GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +;;; INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +;;; WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +;;; NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +;;; SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +(in-package :claw) + + +(defgeneric session-manager-start-session (session-manager &key path max-time domain) + (:documentation "Creates a new session if none exists")) + +(defgeneric session-manager-session-value (session-manager symbol) + (:documentation "Returns the value bound to the given session symbol. +It returns nil if no symbol is defined for the current session.")) + +(defgeneric (setf session-manager-session-value) (value session-manager symbol) + (:documentation "Sets the session symbol with the given value.")) + +(defgeneric session-manager-delete-session-value (session-manager symbol) + (:documentation "Completely removes any data associated with the symbol symbol from the session. +Note that this is different from using SESSION-VALUE to set the data to NIL")) + +(defgeneric session-manager-remove-session (session-manager &optional session) (:documentation "Removes the user session.")) + +(defgeneric session-manager-reset-sessions (session-manager) + (:documentation "Invalidates and destroy all sessions")) + +(defgeneric session-manager-session-cookie-value (session-manager) + (:documentation "Returns a unique string that's associated with the user session")) + +(defgeneric session-manager-session-max-time (session-manager) + (:documentation "This gets or sets the maximum time (in seconds) the session should be valid before it's invalidated. +If a request associated with this session comes in and the last request for the same session was more than seconds seconds ago than the session is deleted and a new one is started for this client")) + +(defgeneric session-manager-session-remote-addr (session-manager) + (:documentation "Returns the 'real' remote address (see CONNECTOR-REAL-REMOTE-ADDR) of the client for which the session was initiated.")) + +(defgeneric session-manager-session-user-agent (session-manager) + (:documentation "Returns the 'User-Agent' http header (see USER-AGENT) of the client for which the session was initiated.")) + +(defgeneric session-manager-session-gc (session-manager) + (:documentation "Deletes sessions which are too old - see SESSION-MANAGER-SESSION-TOO-OLD-P. Usually, you don't call this function directly")) + +(defgeneric session-manager-session-too-old-p (session-manager) + (:documentation "Returns a true value if the session is too old and would be deleted during the next session GC.")) + +(defgeneric session-manager-start (session-manager) + (:documentation "Starts the session manager.")) + +(defgeneric session-manager-stop (session-manager) + (:documentation "Stops the session manager.")) + +(let ((session-id-counter 0)) + (defun get-next-session-id () + "Returns the next sequential session id." + (incf session-id-counter))) + +;;------------------------------------------------------------------------- +(defvar *session-default-max-time* (* 30 60) + "The default time (in seconds) after which this +session expires if it's not used.") + +(defclass session () + ((session-id :initform (get-next-session-id) + :reader session-id + :type integer + :documentation "The unique ID (an INTEGER) of the session.") + (realm :initarg :realm + :accessor session-realm + :documentation "The realm under which the request has been sent. +A realm is used to group resources under a common 'place', and is used for registered web applications +to have different or common sessions for a give user") + (session-string :accessor session-string + :documentation "The session strings encodes enough +data to safely retrieve this session. It is sent to the browser as a +cookie value or as a GET parameter.") + (user-agent :initform (connector-user-agent (clawserver-connector *clawserver*)) + :reader session-user-agent + :documentation "The incoming 'User-Agent' header that +was sent when this session was created.") + (remote-addr :initform (connector-real-remote-addr (clawserver-connector *clawserver*)) + :reader session-remote-addr + :documentation "The remote IP address of the client when +this sessions was started as returned by REAL-REMOTE-ADDR.") + (session-start :initform (get-universal-time) + :reader session-start + :documentation "The time this session was started.") + (last-click :initform (get-universal-time) + :reader session-last-click + :documentation "The last time this session was used.") + (session-data :initarg :session-data + :initform (make-hash-table) + :reader session-data + :documentation "Data associated with this session - +see SESSION-VALUE.") + (session-counter :initform 0 + :reader session-counter + :documentation "The number of times this session +has been used.") + (max-time :initarg :max-time + :initform *session-default-max-time* + :accessor session-max-time + :type fixnum + :documentation "The time (in seconds) after which this +session expires if it's not used.")) + (:default-initargs :realm *claw-current-realm*) + (:documentation "SESSION objects are automatically maintained +by Hunchentoot. They should not be created explicitly with +MAKE-INSTANCE but implicitly with START-SESSION. Note that +SESSION objects can only be created when the special variable +*REQUEST* is bound to a REQUEST object.")) + +;;------------------------------------------------------------------------- +(defvar *session-manager* nil + "The session manager used during the request cycle.") + +(defclass session-manager (claw-service) + ((max-time :initarg :max-time + :accessor session-manager-max-time + :type fixnum + :documentation "The time (in seconds) after which this session expires if it's not used.")) + (:default-initargs :name 'session-manager :max-time 1800) + (:documentation "SESSION-MANAGER is an interface, so you cannot directly use it. +A SESSION-MANAGER subclass is a class that helps to decouple CLAW from the web server on which CLAWSERVER resides. +To properly work a CLAWSERVER instance must be provided with a SESSION-MANAGER implementation. +A SESSION-MANAGER implementation to properly work, must implement all the CONNECTOR- methods. +As the name suggests this is a server that handles user sessions.")) + + +(defgeneric default-session-manager-session-verify (session-manager) + (:documentation "Tries to get a session identifier from the cookies (oralternatively from the GET parameters) sent by the client. +This identifier is then checked for validity against the REQUEST. +On success the corresponding session object (if not too old) is returned (and updated). Otherwise NIL is returned.")) + +;;------------------------------------------------------------------------- +(defgeneric default-session-manager-session-too-old-p (default-session-manager session) + (:documentation "Returns true if the SESSION has not been active in the last (SESSION-MANAGER-MAX-TIME SESSION-MANAGER) seconds.")) + +(defgeneric default-session-manager-encode-session-string (default-session-manager id user-agent remote-addr start realm) + (:documentation "Create a uniquely encoded session string based on the values ID, USER-AGENT, REMOTE-ADDR, START and REALM")) + +(defgeneric default-session-manager-current-session (default-session-manager) + (:documentation "Returns the session bouded to the current request")) + +(defclass default-session-manager (session-manager) + ((gc-timeout :initarg :gc-timeout + :accessor default-session-manager-gc-timeout + :documentation "The period the service waits before calling the session garbage collector") + (sessions :initform (make-hash-table) + :accessor default-session-manager-sessions + :documentation "A hash table containing all sessions identified by their id") + (service-lock :accessor default-session-manager-service-lock + :documentation "This is a thread lock that is used when adding or removing sessions, or when calling the session garbage collector.") + (session-cookie-name :initarg :session-cookie-name + :accessor default-session-manager-session-cookie-name + :documentation "The name of the cookie that stores the session id.") + (use-user-agent-for-sessions-p :initarg :use-user-agent-for-sessions-p + :reader use-user-agent-for-sessions-p + :documentation "") + (use-remote-addr-for-sessions-p :initarg :use-remote-addr-for-sessions-p + :reader use-remote-addr-for-sessions-p + :documentation "") + (session-secret :initarg :session-secret + :accessor default-session-manager-random-secret + :documentation "A random letter used to encode sessin into a string in a random way.")) + (:default-initargs :gc-timeout 1 :session-cookie-name "CLAWSID" + :use-user-agent-for-sessions-p t + :use-remote-addr-for-sessions-p t + :session-secret (format nil "~VR" 36 (random 36 (make-random-state t)))) + (:documentation "This is the CLAW default session manager.")) + +(defmethod initialize-instance :after ((session-manager default-session-manager) &rest keys) + (declare (ignore keys)) + (setf (default-session-manager-service-lock session-manager) + (bt:make-lock (symbol-name 'session-manager)))) + +(defmethod default-session-manager-current-session ((session-manager default-session-manager)) + (or *claw-session* + (let* ((connector (clawserver-connector *clawserver*)) + (cookie-name (default-session-manager-session-cookie-name session-manager)) + (sessions (default-session-manager-sessions session-manager)) + (session-identifier (or (connector-cookie-in connector cookie-name) + (connector-get-parameter connector cookie-name)))) + (when session-identifier + (destructuring-bind (id-string session-string) + (split ":" session-identifier :limit 2) + (declare (ignore session-string)) + (let ((id (and (scan "^\d+$" id-string) + (parse-integer id-string :junk-allowed t)))) + (and id (gethash id sessions)))))))) + +(defmethod claw-service-start :after ((session-manager default-session-manager)) + (unless (claw-service-running-p session-manager) + (bt:make-thread #'(lambda () + (do ((continue (claw-service-running-p session-manager) (funcall #'claw-service-running-p session-manager))) + ((null continue)) + (session-manager-session-gc session-manager)))))) + +(defmethod default-session-manager-encode-session-string ((session-manager default-session-manager) id user-agent remote-addr start realm) + ;; *SESSION-SECRET* is used twice due to known theoretical + ;; vulnerabilities of MD5 encoding + (let ((session-secret (default-session-manager-random-secret session-manager))) + (md5-hex (concatenate 'string + session-secret + (md5-hex (format nil "~A~A~@[~A~]~@[~A~]~A~@[~A~]" + session-secret + id + user-agent + remote-addr + start + realm)))))) + +(defmethod default-session-manager-session-verify ((session-manager default-session-manager)) + (let* ((connector (clawserver-connector *clawserver*)) + (sessions (default-session-manager-sessions session-manager)) + (cookie-name (default-session-manager-session-cookie-name session-manager)) + (session-identifier (or (connector-cookie-in connector cookie-name) + (connector-get-parameter connector cookie-name)))) + (unless (and session-identifier + (stringp session-identifier) + (plusp (length session-identifier))) + (return-from default-session-manager-session-verify nil)) + (destructuring-bind (id-string session-string) + (split ":" session-identifier :limit 2) + (let* ((id (and (scan "^\d+$" id-string) + (parse-integer id-string + :junk-allowed t))) + (session (and id + (gethash id sessions))) + (user-agent (connector-user-agent connector)) + (remote-addr (connector-remote-addr connector)) + (realm (when session (session-realm session)))) + (unless (and session + session-string + (string= session-string + (session-string session)) + (string= session-string + (default-session-manager-encode-session-string session-manager + id + (and (use-user-agent-for-sessions-p session-manager) + user-agent) + (and (use-remote-addr-for-sessions-p session-manager) + remote-addr) + (session-start session) + realm))) + (cond ((null session) + (log-message :notice "No session for session identifier '~A' (User-Agent: '~A', IP: '~A', REALM: '~A')" + session-identifier user-agent remote-addr realm)) + (t + (log-message :warning "Fake session identifier '~A' (User-Agent: '~A', IP: '~A', REALM: '~A')" + session-identifier user-agent remote-addr realm))) + (when (and session-identifier *claw-current-lisplet*) + (let ((cookie (make-instance 'claw-cookie + :name cookie-name + :expires (get-universal-time) + :path (format nil "~a/" (build-lisplet-location *claw-current-lisplet*)) + :domain nil + :value ""))) + (setf (connector-cookie-out connector cookie-name) cookie))) + (when session + (session-manager-remove-session session-manager session)) + (setf *claw-session* nil) + (return-from default-session-manager-session-verify *claw-session*)) + (incf (slot-value session 'session-counter)) + (setf (slot-value session 'last-click) (get-universal-time) + *claw-session* session))))) + + +(defmethod default-session-manager-session-too-old-p ((session-manager default-session-manager) (session session)) + (< (+ (session-last-click session) (or (session-max-time session) (session-manager-max-time session-manager))) + (get-universal-time))) + +(defmethod session-manager-start-session ((session-manager default-session-manager) &key (path "/") max-time domain) + (let* ((connector (clawserver-connector *clawserver*)) + (sessions (default-session-manager-sessions session-manager)) + (cookie-name (default-session-manager-session-cookie-name session-manager)) + (session-identifier (or (connector-cookie-in connector cookie-name) + (connector-get-parameter connector cookie-name)))) + (if (and session-identifier (gethash (parse-integer session-identifier :junk-allowed t) sessions)) + (destructuring-bind (id-string session-string) + (split ":" session-identifier :limit 2) + (declare (ignore session-string)) + (let* ((id (and (scan "^\d+$" id-string) + (parse-integer id-string :junk-allowed t))) + (session (and id (gethash id sessions)))) + (unless (and session (default-session-manager-session-too-old-p session-manager session)) + (return-from session-manager-start-session session)))) + (bt:with-lock-held ((default-session-manager-service-lock session-manager)) + (let* ((session (make-instance 'session + :max-time (or max-time (session-manager-max-time session-manager)))) + (cookie-name (default-session-manager-session-cookie-name session-manager)) + (cookie)) + (setf (session-string session) (default-session-manager-encode-session-string session-manager + (session-id session) + (session-user-agent session) + (session-remote-addr session) + (session-start session) + (session-realm session)) + cookie (make-instance 'claw-cookie + :name cookie-name + :expires nil + :path path + :domain domain + :value (format nil "~a:~a" (session-id session) (session-string session)))) + (setf (connector-cookie-out connector cookie-name) cookie) + (setf (gethash (session-id session) (default-session-manager-sessions session-manager)) session + *claw-session* session)))))) + + +(defmethod session-manager-remove-session ((session-manager default-session-manager) &optional session) + (let ((current-session (or session (default-session-manager-current-session session-manager)))) + (bt:with-lock-held ((default-session-manager-service-lock session-manager)) + (remhash (session-id current-session) (default-session-manager-sessions session-manager))))) + +(defmethod session-manager-session-value ((session-manager default-session-manager) symbol) + (let ((session (default-session-manager-current-session session-manager))) + (when session + (gethash symbol (session-data session))))) + +(defmethod (setf session-manager-session-value) (value (session-manager default-session-manager) symbol) + (let ((session (default-session-manager-current-session session-manager))) + (when session + (bt:with-lock-held ((default-session-manager-service-lock session-manager)) + (setf (gethash symbol (session-data session)) value))))) + + +(defmethod session-manager-delete-session-value ((session-manager default-session-manager) symbol) + (let ((session (default-session-manager-current-session session-manager))) + (when session + (bt:with-lock-held ((default-session-manager-service-lock session-manager)) + (remhash symbol (session-data session)))))) + +(defmethod session-manager-remove-session ((session-manager default-session-manager) &optional session) + (unless session + (setf session (default-session-manager-current-session session-manager))) + (when session + (bt:with-lock-held ((default-session-manager-service-lock session-manager)) + (remhash (session-id session) (default-session-manager-sessions session-manager))))) + +(defmethod session-manager-reset-sessions ((session-manager default-session-manager)) + (bt:with-lock-held ((default-session-manager-service-lock session-manager)) + (setf (default-session-manager-sessions session-manager) (make-hash-table)))) + +(defmethod session-manager-session-gc ((session-manager default-session-manager)) + (let ((sessions (default-session-manager-sessions session-manager))) + (loop for session-id being the hash-key of sessions using (hash-value session) + do (when (default-session-manager-session-too-old-p session-manager session) + (bt:with-lock-held ((default-session-manager-service-lock session-manager)) + (remhash session-id sessions)))))) +

Modified: trunk/main/claw-core/src/tags.lisp ============================================================================== --- trunk/main/claw-core/src/tags.lisp (original) +++ trunk/main/claw-core/src/tags.lisp Thu Jul 17 09:11:41 2008 @@ -247,18 +247,16 @@ "Holds an hash table of used components/tags id as keys and the number of their occurrences as values. So if you have a :id "compId" given to a previous component, the second time this id will be used, it will be rendered as "compId1", the third time will be "compId2" and so on" - (when (boundp '*request*) - (let ((id-table-map (aux-request-value :id-table-map))) - (if (null id-table-map) - (progn - (setf (aux-request-value :id-table-map) (make-hash-table :test 'equal))) - id-table-map)))) + (let ((id-table-map (claw-aux-request-value :id-table-map))) + (if (null id-table-map) + (progn + (setf (claw-aux-request-value :id-table-map) (make-hash-table :test 'equal))) + id-table-map)))

(defun reset-request-id-table-map () "This function resets the ID-TABLE-MAP built during the request cycle to handle id uniqueness. See REQUEST-ID-TABLE-MAP for more info." - (when (boundp '*request*) - (setf (aux-request-value :id-table-map) (make-hash-table :test 'equal)))) + (setf (claw-aux-request-value :id-table-map) (make-hash-table :test 'equal)))

(defun parse-htcomponent-function (function-body) "This function parses attributes passed to a htcomponent creation function" @@ -355,8 +353,6 @@ (defclass page(i18n-aware) ((writer :initarg :writer :accessor page-writer :documentation "The output stream for this page instance") - (lisplet :initarg :lisplet - :reader page-lisplet :documentation "The lisplet that owns this page instance") (can-print :initform nil :accessor page-can-print :documentation "Controls the printing process when a json request is dispatched. @@ -393,14 +389,9 @@ (mime-type :initarg :mime-type :accessor page-mime-type :documentation "Define the mime type of the page when rendered") - (external-format :initarg :external-format - :accessor page-external-format - :documentation "The charset external format. When not provided the lisplet one is used") (injection-writing-p :initform nil :accessor page-injection-writing-p - :documentation "Flag that becomes true when rendering page injections") - (url :initarg :url - :accessor page-url :documentation "The URL provided with this page instance")) + :documentation "Flag that becomes true when rendering page injections")) (:default-initargs :writer t :script-files nil :json-component-count 0 @@ -412,9 +403,7 @@ :xmloutput nil :doc-type *html-4.01-strict* :request-parameters nil - :mime-type "text/html" - :external-format nil - :url nil) + :mime-type "text/html") (:documentation "A page object holds claw components to be rendered") )

(defclass htcomponent (i18n-aware) @@ -539,10 +528,6 @@ "table" "tbody" "td" "textarea" "tfoot" "th" "thead" "title" "tr" "tt" "u" "ul" "var"))

-(defun tag-emptyp (tag-name) - "Returns if a tag defined by the string TAG-NAME is empty" - (member tag-name *empty-tags* :test #'string-equal)) - ;;;--------------------METHODS implementation---------------------------------------------- (defmethod (setf htcomponent-page) ((page page) (htcomponent htcomponent)) (setf (slot-value htcomponent 'page) page) @@ -556,8 +541,8 @@ (setf (htcomponent-client-id htcomponent) (generate-id id)))))))

(defmethod page-request-parameters ((page page)) - (if (and (boundp '*request*) (null (slot-value page 'request-parameters))) - (let ((parameters (append (post-parameters) (get-parameters))) + (if (null (slot-value page 'request-parameters)) + (let ((parameters (append (claw-post-parameters) (claw-get-parameters))) (pparameters (make-hash-table :test 'equal))) (loop for kv in parameters do (setf (gethash (string-upcase (car kv)) pparameters) @@ -611,7 +596,7 @@

(defmethod page-render-headings ((page page)) (let* ((jsonp (page-json-id-list page)) - (encoding (flexi-streams:external-format-name (or (page-external-format page) (reply-external-format)))) + (encoding (claw-reply-external-format-encoding)) (xml-p (page-xmloutput page)) (doc-type (page-doc-type page))) (when (null jsonp) @@ -638,16 +623,11 @@

(defmethod page-render ((page page)) (let ((body (page-content page)) - (jsonp (page-json-id-list page)) - (external-format (page-external-format page))) - (unless (or (null external-format) - (eq (flexi-streams:external-format-name (reply-external-format)) - (flexi-streams:external-format-name external-format))) - (setf (reply-external-format) external-format)) + (jsonp (page-json-id-list page))) (if (null body) (format nil "null body for page ~a~%" (type-of page)) (progn - (setf (current-page) page) + (setf *claw-current-page* page) (page-init page) (when (page-req-parameter page *rewind-parameter*) (htcomponent-rewind body page)) @@ -728,11 +708,10 @@ (defmethod page-current-component ((page page)) (car (page-components-stack page)))

-(defun current-component (&optional (request *request*)) +(defun current-component () "Returns the component that is currently rendering" - (let ((page (current-page request))) - (when page - (car (page-components-stack page))))) + (when *claw-current-page* + (car (page-components-stack *claw-current-page*)))) ;;;========= HTCOMPONENT ============================ (defmethod htcomponent-can-print ((htcomponent htcomponent)) (let* ((id (when (slot-boundp htcomponent 'client-id) (htcomponent-client-id htcomponent))) @@ -938,7 +917,7 @@ (when (null (page-json-id-list page)) (let ((body-list (htcomponent-body hthead)) (injections (page-init-injections page)) - (encoding (flexi-streams:external-format-name (or (page-external-format page) (reply-external-format))))) + (encoding (claw-reply-external-format-encoding))) (tag-render-starttag hthead page) (htcomponent-render (meta> :http-equiv "Content-Type" :content (format nil "~a;charset=~a" @@ -1190,10 +1169,16 @@ (when (null previous-print-status) (setf (page-can-print page) (htcomponent-can-print wcomponent))) (when (page-can-print page) - (dolist (script (htcomponent-script-files wcomponent)) - (pushnew script (page-script-files page) :test #'equal)) - (dolist (css (htcomponent-stylesheet-files wcomponent)) - (pushnew css (page-stylesheet-files page) :test #'equal)) + (let ((script-files (htcomponent-script-files wcomponent))) + (dolist (script (if (listp script-files) + script-files + (list script-files))) + (pushnew script (page-script-files page) :test #'equal))) + (let ((css-files (htcomponent-stylesheet-files wcomponent))) + (dolist (css (if (listp css-files) + css-files + (list css-files))) + (pushnew css (page-stylesheet-files page) :test #'equal))) (dolist (js (htcomponent-class-initscripts wcomponent)) (pushnew js (page-class-initscripts page) :test #'equal)) (when (htcomponent-instance-initscript wcomponent)

Modified: trunk/main/claw-core/src/translators.lisp ============================================================================== --- trunk/main/claw-core/src/translators.lisp (original) +++ trunk/main/claw-core/src/translators.lisp Thu Jul 17 09:11:41 2008 @@ -273,6 +273,7 @@ (format nil "~a" value))

(defmethod translator-value-decode ((translator translator-boolean) value &optional client-id label) + (declare (ignore client-id label)) (if (string-equal value "NIL") nil t)) @@ -297,6 +298,7 @@ (t (second value))))

(defmethod translator-value-decode ((translator translator-file) value &optional client-id label) + (declare (ignore client-id label)) value)

(setf *file-translator* (make-instance 'translator-file)) \ No newline at end of file

Modified: trunk/main/claw-core/src/validators.lisp ============================================================================== --- trunk/main/claw-core/src/validators.lisp (original) +++ trunk/main/claw-core/src/validators.lisp Thu Jul 17 09:11:41 2008 @@ -31,11 +31,11 @@

(defgeneric local-time-to-string (local-time format) (:documentation "Writes a local-time instance the FORMAT list where element are joined together and :SECOND :MINUTE :HOUR :DATE :MONTH and :YEAR are -expanded into seconds for :SECOND, minutes for :MINUTE, hour of the day for :HOUR, day of the month for :DATE, month number for :MONTH and the year for :YEAR. +expanded into seconds for :SECOND, minutes for :MINUTE, hour of the day for :HOUR, day of the month for :DATE, month number for :MONTH and the year for :YEAR. A format list may be for example '(:month "/" :date "/" :year)"))

(defmethod local-time-to-string ((local-time local-time) format) - (multiple-value-bind (nsec sec min hour day month year) + (multiple-value-bind (nsec sec min hour day month year) (decode-local-time local-time) (declare (ignore nsec)) (loop for result = "" then (concatenate 'string result (if (stringp element) @@ -50,13 +50,13 @@ for element in format finally (return result))))

-(defun add-exception (id reason) +(defun add-exception (id reason) "Adds an exception for the given input component identified by its ID with the message expressed by REASON" (let* ((validation-errors (validation-errors)) (symbol-id (intern id)) (errors (getf validation-errors symbol-id))) (setf (getf validation-errors symbol-id) (nconc errors (list reason)) - (validation-errors *request*) validation-errors))) + (validation-errors) validation-errors)))

(defun component-exceptions (id) "Returns a list of exception connectd to the given component" @@ -66,7 +66,7 @@ (defun validate (test &key component message) "When test is nil, an exception message given by MESSAGE is added for the COMPONENT. See: ADD-EXCEPTION..." (let ((client-id (htcomponent-client-id component))) - (if test + (if test (add-validation-compliance client-id) (add-exception client-id message))))

@@ -74,12 +74,12 @@ "Checks if the required input field VALUE is present. If not, a localizable message "Field ~a may not be empty." is sent with key "VALIDATE-REQUIRED". The argument for the message will be the :label attribute of the COMPONENT." (when (stringp value) - (validate (and value (string-not-equal value "")) - :component component + (validate (and value (string-not-equal value "")) + :component component :message (or message (format nil (do-message "VALIDATE-REQUIRED" "Field ~a may not be empty.") (label component))))))

(defun validate-size (component value &key min-size max-size message-low message-hi) - "Checks if the input field VALUE legth is less then or greater then rispectively of the form keywords :MIN-SIZE and :MAX-SIZE. + "Checks if the input field VALUE legth is less then or greater then rispectively of the form keywords :MIN-SIZE and :MAX-SIZE. If less then :MIN-SIZE, a localizable message "Size of ~a may not be less then ~a chars." is sent with key "VALIDATE-SIZE-MIN". The argument for the message will be the :label attribute of the COMPONENT and the :MIN-ZIZE value. If greater then :MAX-SIZE, a localizable message "Size of ~a may not be more then ~a chars" is sent with key "VALIDATE-SIZE-MAX". @@ -88,40 +88,40 @@ (when value (setf value (format nil "~a" value)) (setf value-len (length value)) - (and (= value-len 0) - (when min-size + (and (= value-len 0) + (when min-size (validate (>= value-len min-size) - :component component + :component component :message (or message-low (format nil (do-message "VALIDATE-SIZE-MIN" "Size of ~a may not be less then ~a chars." ) - (label component) - min-size)))) - (when max-size + (label component) + min-size)))) + (when max-size (validate (<= value-len max-size) - :component component + :component component :message (or message-hi (format nil (do-message "VALIDATE-SIZE-MAX" "Size of ~a may not be more then ~a chars." ) - (label component) - max-size)))))))) + (label component) + max-size))))))))

(defun validate-range (component value &key min max message-low message-hi) - "Checks if the numeric input field VALUE is less then or greater then rispectively of the form keywords :MIN and :MAX. + "Checks if the numeric input field VALUE is less then or greater then rispectively of the form keywords :MIN and :MAX. If less then :MIN, a localizable message "Field ~a is not less then or equal to ~d." is sent with key "VALIDATE-RANGE-MIN". The argument for the message will be the :label attribute of the COMPONENT and the :MIN value. If greater then :MIN, a localizable message "Field ~a is not greater then or equal to ~d." is sent with key "VALIDATE-RANGE-MAX". The argument for the message will be the :label attribute of the COMPONENT and the :MAX value." - (when value + (when value (and (when min (validate (>= value min) - :component component + :component component :message (or message-low (format nil (do-message "VALIDATE-RANGE-MIN" "Field ~a is not greater then or equal to ~d") - (label component) + (label component) (if (typep min 'ratio) (coerce min 'float) min))))) (when max (validate (<= value max) - :component component + :component component :message (or message-hi (format nil (do-message "VALIDATE-RANGE-MAX" "Field ~a is not less then or equal to ~d") - (label component) + (label component) (if (typep max 'ratio) (coerce max 'float) max)))))))) @@ -130,10 +130,10 @@ "Checks if the input field VALUE is a valid number and then passes the validation to VALIDATION-RANGE. If not a number, a localizable message "Field ~a is not a valid number." is sent with key "VALIDATE-NUMBER". The argument for the message will be the :label attribute of the COMPONENT." - (when value + (when value (let ((test (numberp value))) (and (validate test - :component component + :component component :message (or message-nan (format nil (do-message "VALIDATE-NUMBER" "Field ~a is not a valid number.") (label component)))) (validate-range component value :min min :max max :message-low message-low :message-hi message-hi)))))

@@ -141,15 +141,15 @@ "Checks if the input field VALUE is a valid number and then passes the validation to VALIDATION-RANGE. If not a number, a localizable message "Field ~a is not a valid integer." is sent with key "VALIDATE-INTEGER". The argument for the message will be the :label attribute of the COMPONENT." - (when value + (when value (let ((test (integerp value))) (and (validate test - :component component + :component component :message (or message-nan (format nil (do-message "VALIDATE-INTEGER" "Field ~a is not a valid integer.") (label component)))) (validate-range component value :min min :max max :message-low message-low :message-hi message-hi)))))

-(defun validate-date-range (component value &key min max (use-date-p t) use-time-p message-low message-hi) +(defun validate-date-range (component value &key min max (use-date-p t) use-time-p message-low message-hi) "Checks if the input field VALUE is a date between min and max. If :USE-DATE-P is not nil and :USE-TIME-P is nil, validation is made without considering the time part of local-time. If :USE-DATE-P nil and :USE-TIME-P is not nil, validation is made without considering the date part of local-time. @@ -160,7 +160,7 @@ The argument for the message will be the :label attribute of the COMPONENT and the value passed to :MAX parsed with the :LOCAL-TIME-FORMAT keyword." (unless (component-validation-errors component) (let ((local-time-format '(:date "-" :month "-" :year)) - (new-value (make-instance 'local-time + (new-value (make-instance 'local-time :nsec (nsec-of value) :sec (sec-of value) :day (day-of value) @@ -182,17 +182,17 @@ (setf (local-time:day-of max) 0))) (and (when min (validate (local-time> new-value min) - :component component - :message (or message-low (format nil (do-message "VALIDATE-DATE-RANGE-MIN" "Field ~a is less then ~a.") - (label component) + :component component + :message (or message-low (format nil (do-message "VALIDATE-DATE-RANGE-MIN" "Field ~a is less then ~a.") + (label component) (local-time-to-string min local-time-format))))) (when max (validate (local-time< new-value max) - :component component - :message (or message-hi (format nil (do-message "VALIDATE-DATE-RANGE-MAX" "Field ~a is greater then ~a.") - (label component) + :component component + :message (or message-hi (format nil (do-message "VALIDATE-DATE-RANGE-MAX" "Field ~a is greater then ~a.") + (label component) (local-time-to-string max local-time-format))))))))) - +

;; ------------------------------------------------------------------------------------ @@ -213,16 +213,16 @@ (defmethod wcomponent-template ((exception-monitor exception-monitor)) (let ((client-id (htcomponent-client-id exception-monitor)) (validation-errors (validation-errors)) - (body (htcomponent-body exception-monitor))) + (body (htcomponent-body exception-monitor))) (div> :static-id client-id - (wcomponent-informal-parameters exception-monitor) + (wcomponent-informal-parameters exception-monitor) (when validation-errors (if body body (ul> :id "errors" - (loop for (client-id component-exceptions) on validation-errors by #'cddr - collect (loop for message in component-exceptions - collect (li> message))))))))) + (loop for (client-id component-exceptions) on validation-errors by #'cddr + collect (loop for message in component-exceptions + collect (li> message)))))))))

;;-------------------------------------------------------------------------------------------

Modified: trunk/main/claw-core/tests/packages.lisp ============================================================================== --- trunk/main/claw-core/tests/packages.lisp (original) +++ trunk/main/claw-core/tests/packages.lisp Thu Jul 17 09:11:41 2008 @@ -30,6 +30,6 @@ (in-package :cl-user)

(defpackage :claw-tests - (:use :cl :hunchentoot :claw :local-time) + (:use :cl :claw :hunchentoot-connector :local-time) (:export :claw-tst-start :claw-tst-stop)) \ No newline at end of file

Modified: trunk/main/claw-core/tests/test1.lisp ============================================================================== --- trunk/main/claw-core/tests/test1.lisp (original) +++ trunk/main/claw-core/tests/test1.lisp Thu Jul 17 09:11:41 2008 @@ -29,9 +29,9 @@

(in-package :claw-tests)

-(setf hunchentoot:*default-content-type* "text/html; charset=UTF-8") +;(setf hunchentoot:*default-content-type* "text/html; charset=UTF-8")

-(setf hunchentoot:*rewrite-for-session-urls* nil) +;(setf hunchentoot:*rewrite-for-session-urls* nil)

(defvar *this-file* (load-time-value (or #.*compile-file-pathname* *load-pathname*))) @@ -63,53 +63,60 @@ :redirect-protected-resources-p t))

(defvar *test-lisplet2*) -(setf *test-lisplet2* (make-instance 'lisplet :realm "test2" +(setf *test-lisplet2* (make-instance 'lisplet + :realm "test2" :base-path "/test2"))

-;;(defparameter *clawserver* (make-instance 'clawserver :port 4242 :base-path "/claw")) - -(defvar *clawserver* (make-instance 'clawserver - :port 4242 - :sslport 4445 - :base-path "/claw" - :mod-lisp-p nil - :ssl-certificate-file #P"/home/kiuma/pem/cacert.pem" - :ssl-privatekey-file #P"/home/kiuma/pem/privkey.pem")) +;;(defparameter *test-server* (make-instance 'clawserver :port 4242 :base-path "/claw")) +(defvar *ht-connector* (make-instance 'hunchentoot-connector + :port 4242 + :sslport nil + :behind-apache-p t + :mod-lisp-p nil + :ssl-certificate-file #P"/home/kiuma/pem/cacert.pem" + :ssl-privatekey-file #P"/home/kiuma/pem/privkey.pem")) +(defvar *sm* (make-instance 'default-session-manager)) + +(defvar *ht-log-manager* (make-instance 'hunchentoot-logger)) + +(defvar *test-server* (make-instance 'clawserver + :connector *ht-connector* + :log-manager *ht-log-manager* + :session-manager *sm* + :base-path "/claw"))

;(setf (lisplet-redirect-protected-resources-p *test-lisplet*) t)

-(clawserver-register-lisplet *clawserver* *test-lisplet*) -(clawserver-register-lisplet *clawserver* *test-lisplet2*) +(clawserver-register-lisplet *test-server* *test-lisplet*) +(clawserver-register-lisplet *test-server* *test-lisplet2*)

-(defun test-configuration-do-login (request user password) - (declare (ignore request)) - (let ((session *session*)) - (when (and (string-equal user "kiuma") +(defun test-configuration-do-login (user password) + (when (and (string-equal user "kiuma") (string-equal password "password")) - (setf (current-principal session) (make-instance 'principal :name user :roles '("user")))))) + (setf (current-principal) (make-instance 'principal :name user :roles '("user")))))

(defclass test-configuration (configuration) ())

-(defmethod configuration-login ((test-configuration test-configuration) &optional (request *request*)) - (let ((lisplet (current-lisplet request))) - (multiple-value-bind (user password) - (if (eq (lisplet-authentication-type lisplet) :basic) - (authorization) - (values (aux-request-value 'user request) - (aux-request-value 'password request))) - (test-configuration-do-login request user password)))) +(defmethod configuration-login ((test-configuration test-configuration)) + (log-message :info "AUX athenticating: ~a" (claw-aux-request-value 'user)) + (multiple-value-bind (user password) + (if (eq (lisplet-authentication-type *claw-current-lisplet*) :basic) + (claw-authorization) + (values (claw-aux-request-value 'user) + (claw-aux-request-value 'password))) + (test-configuration-do-login user password)))

-(clawserver-register-configuration *clawserver* "test1" (make-instance 'test-configuration)) +(clawserver-register-configuration *test-server* "test1" (make-instance 'test-configuration))

(defun claw-tst-start () - (clawserver-start *clawserver*)) + (clawserver-start *test-server*))

(defun claw-tst-stop () - (clawserver-stop *clawserver*)) + (clawserver-stop *test-server*))

;;;--------------------template-------------------------------- @@ -150,7 +157,7 @@ (defclass index-page (page) ())

(defmethod page-content ((o index-page)) - (let ((clawserver-base-path (clawserver-base-path (current-server)))) + (let ((clawserver-base-path (clawserver-base-path *clawserver*))) (site-template> :title "Home test page" (p> :id "p" (ul> @@ -196,7 +203,7 @@ (defclass info-page (page) ())

(defmethod page-content ((o info-page)) - (let ((header-props (headers-in))) + (let ((header-props (claw-headers-in))) (site-template> :title "Header info page" (p> :id "p" (table> @@ -218,7 +225,8 @@ (lisplet-register-function-location *test-lisplet* (lambda () (let ((path (test-image-file))) - (setf (hunchentoot:content-type) (hunchentoot:mime-type path)) + (setf (claw-content-type) (or (mime-type path) + "application/octet-stream")) (with-open-file (in path :element-type 'flex:octet) (let ((image-data (make-array (file-length in) :element-type 'flex:octet))) @@ -226,16 +234,30 @@ image-data)))) "images/matrix2.jpg" ) ;;;--------------------realm test page-------------------------------- -(defclass realm-page (page) ()) +(defgeneric realm-page-session-dispose (page)) + +(defgeneric realm-page-generate-number (page)) + +(defclass realm-page (page) + ((rnd-number :initform nil + :accessor realm-page-rnd-numuber))) + +(defmethod realm-page-generate-number ((page realm-page)) + (claw-start-session) + (unless (claw-session-value 'RND-NUMBER) + (setf (claw-session-value 'RND-NUMBER) (random 1000))) + (setf (realm-page-rnd-numuber page) (claw-session-value 'RND-NUMBER))) + +(defmethod realm-page-session-dispose ((page realm-page)) + (claw-remove-session) + (realm-page-generate-number page))

(defmethod page-content ((o realm-page)) - (when (null hunchentoot:*session*) - (claw-start-session)) - (unless (session-value 'RND-NUMBER) - (setf (session-value 'RND-NUMBER) (random 1000))) + (realm-page-generate-number o) (site-template> :title "Realm test page" (p> - "session" + (cform> :id "sessionDispose" :action #'realm-page-session-dispose + (submit-link> :id "submit" "Session dispose")) (ul> (li> (a> :href "http://www.gentoo.org" :target "gentoo" "gentoo")) @@ -243,13 +265,7 @@ "realm on lisplet 'test'")) (li> (a> :href "../test2/realm.html" :target "clwo2" "realm on lisplet 'test2'")) - (li> "Rnd number value: " (format nil "~d" (session-value 'RND-NUMBER))) - (li> "Remote Addr: " (session-remote-addr *session*)) - (li> "User agent: " (session-user-agent *session*)) - (li> "Lisplet Realm: " (current-realm)) - (li> "Session Realm: " (session-realm *session*)) - (li> "Session value: " (format nil "~a" (hunchentoot::session-string *session*))) - (li> "Request Realm: " (hunchentoot::realm *request*)))))) + (li> "Rnd number value: " #'(lambda () (format nil "~d" (realm-page-rnd-numuber o))))))))

(lisplet-register-page-location *test-lisplet* 'realm-page "realm.html") (lisplet-register-page-location *test-lisplet2* 'realm-page "realm.html") @@ -298,7 +314,7 @@ (let ((princp (current-principal))) (site-template> :title "a page title" (if (null princp) - (cform> :id "loginform" :method "post" :action #'login-page-login + (cform> :id "loginform" :method "get" :action #'login-page-login (table> (tr> (td> "Username") @@ -323,8 +339,9 @@ (a> :href "index.html" "home"))))))

(defmethod login-page-login ((login-page login-page)) - (setf (aux-request-value 'user) (login-page-username login-page) - (aux-request-value 'password) (login-page-password login-page)) + (log-message :info "athenticating: ~a" (login-page-username login-page)) + (setf (claw-aux-request-value 'user) (login-page-username login-page) + (claw-aux-request-value 'password) (login-page-password login-page)) (login))

(lisplet-register-page-location *test-lisplet* 'login-page "login.html" :login-page-p t)