claw-cvs

claw-cvs@common-lisp.net

175 discussions

[claw-cvs] r35 - trunk/doc
by achiumenti＠common-lisp.net 09 Apr '08

09 Apr '08

Author: achiumenti Date: Wed Apr 9 14:01:54 2008 New Revision: 35 Modified: trunk/doc/claw.texinfo Log: updating user manual Modified: trunk/doc/claw.texinfo ============================================================================== --- trunk/doc/claw.texinfo (original) +++ trunk/doc/claw.texinfo Wed Apr 9 14:01:54 2008 @@ -46,6 +46,16 @@ @menu * Introduction:: * Server:: +* Lisplets:: +* Pages:: +* Getting Started:: +* i18n:: +* forms:: +* validation:: +* writing components:: +* advanced components:: +* login access:: +* Advanced techniques:: * Function index:: @c * Starting and Stopping:: @c * Compiler:: @@ -59,6 +69,16 @@ @include chapters/intro.texinfo @include chapters/server.texinfo +@include chapters/lisplets.texinfo +@include chapters/pages.texinfo +@include chapters/getting-started.texinfo +@include chapters/i18n.texinfo +@include chapters/forms.texinfo +@include chapters/validation.texinfo +@include chapters/writing-components.texinfo +@include chapters/advanced-components.texinfo +@include chapters/access.texinfo +@include chapters/advanced-techniques.texinfo @node Function index @unnumbered Function index

1 0

[claw-cvs] r34 - trunk/doc/chapters
by achiumenti＠common-lisp.net 09 Apr '08

09 Apr '08

Author: achiumenti Date: Wed Apr 9 13:59:58 2008 New Revision: 34 Modified: trunk/doc/chapters/getting-started.texinfo trunk/doc/chapters/intro.texinfo trunk/doc/chapters/lisplets.texinfo trunk/doc/chapters/pages.texinfo trunk/doc/chapters/server.texinfo Log: updating user manual Modified: trunk/doc/chapters/getting-started.texinfo ============================================================================== --- trunk/doc/chapters/getting-started.texinfo (original) +++ trunk/doc/chapters/getting-started.texinfo Wed Apr 9 13:59:58 2008 @@ -1,3 +1,41 @@ @node Getting Started @comment node-name, next, previous, up @chapter Getting started with @value{claw} + +Now that you know how to write pages in @value{claw}, lets move to a further step: writing components. + +A real @value{claw} web application is made of a lisplet, several pages and resources, and, of course, many reusable +components that go into pages. + +Using reusable components, may dramatically improve your productivity. You can then create custom components libraries +that will give to your web application a crystal clear style, and speed up the creation of repetitive piece +of HTML code, as page templates for instance. + +So said, let's create our first @value{claw} component, a site template. +@cartouche +@lisp +(defcomponent site-template () ()) + +(defmethod wcomponent-parameters ((o site-template)) + (list :title :required :home-page "/claw/test/index.html")) + +(defmethod wcomponent-template ((o site-template)) + (html> + (head> + (title> + (wcomponent-parameter-value o :title)) + (style> :type "text/css" +"input.error { + background-color: #FF9999; +} +")) + (body> + (wcomponent-informal-parameters o) + (div> + :style "background-color: #DBDFE0;padding: 3px;" + (a> :href (wcomponent-parameter-value o :home-page) "home")) + (htcomponent-body o)))) +@end lisp +@end cartouche +Thought this is not the best template you can do, it's a nice starting point to explain how components are created +(and used). Modified: trunk/doc/chapters/intro.texinfo ============================================================================== --- trunk/doc/chapters/intro.texinfo (original) +++ trunk/doc/chapters/intro.texinfo Wed Apr 9 13:59:58 2008 @@ -10,13 +10,13 @@ @value{claw} is based on components, highly reusable building blocks the make easy and fast the creation of a web application. By using and creating new components, the developer can create robust and consistent web application with the minimal effort. -Each component may inject into a page ist own set of stylesheet and javasctipt files, and may come with its own class or instance javascript +Each component may inject into a page its own set of stylesheet and javascript files, and may come with its own class or instance javascript directives (a class directive is inserted only once into the page, while this is not true for an instance script). This leads to the creation of very sophisticated components with a very little effort. -@value{claw} comes with its own authentication systme that lets you create both basic and form based authentication systems. +@value{claw} comes with its own authentication system that lets you create both basic and form based authentication systems. -@value{claw} has the capability to force the page renderinig throught the protocol https of pages managing sensible data, using simple +@value{claw} has the capability to force the page rendering through the HTTPS protocol of pages managing sensible data, using simple directives. @value{claw} comes with its own extensible localization and validation system. @@ -34,13 +34,13 @@ When a user asks for a page the request is sent to the @code{CLAWSERVER} that dispatches the request to the registered lisplets. -Lisplets are web resource containers that hold web pages and other resource files, such as javascript, image, css, etc. files, or even funcions, under a common path. +Lisplets are web resource containers that hold web pages and other resource files, such as javascript, image, css, etc. files, or even functions, under a common path. When a matching lisplet is then found, it dispatches the request to a registered resource that can be a page or a file or even a function. If the request is sent for a file, this is then sent back to the browser if found. -If the request is sent for a page, usually mapped to a html url, the dispatcher calls the page rendering function to display the page as an html resource. +If the request is sent for a page, usually mapped to a html URL, the dispatcher calls the page rendering function to display the page as an html resource. If no resource is found a 404 message page, is sent to the user as feedback. Modified: trunk/doc/chapters/lisplets.texinfo ============================================================================== --- trunk/doc/chapters/lisplets.texinfo (original) +++ trunk/doc/chapters/lisplets.texinfo Wed Apr 9 13:59:58 2008 @@ -32,7 +32,7 @@ At this point you have defined a web application registered to the URL ``http://localhost:4242/test'' that @value{claw} will be able to serve. -All sessions and the authentication and authourization logic will be under the default realm ``claw'', +All sessions and the authentication and authorization logic will be under the default realm ``claw'', so if you register another lisplet into the server with the instruction: @cartouche @lisp @@ -71,7 +71,7 @@ @subsection Adding files and folders to a @code{LISPLET} -Suppose now you want to provide, thought your web application, a file present on jour hard disk, for example: +Suppose now you want to provide, thought your web application, a file present on your hard disk, for example: ``/opt/webresources/images/matrix.jpg''. This is made very simple with the following instructions @@ -84,9 +84,9 @@ @end cartouche The jpeg file will now be available when accessing ``http://localhost:4242/test/images/matrix.jpg''. -The last rgument specifies the mime-type, but it's optional. +The last argument specifies the mime-type, but it's optional. -If you want to regiter an entire folder, the process is very similar +If you want to register an entire folder, the process is very similar @cartouche @lisp (lisplet-register-resource-location *test-lisplet* @@ -100,10 +100,10 @@ @subsection Adding functions to a @code{LISPLET} -Registering a function gives you more flexybility then registering a static resource as a file or a directory but the complexity +Registering a function gives you more flexibility then registering a static resource as a file or a directory but the complexity relies into the function that you want to register. -For example, if you want to provide the same ``matrix.jpg'' file throught a function, you'll have to do something of the kind: +For example, if you want to provide the same ``matrix.jpg'' file through a function, you'll have to do something of the kind: @cartouche @lisp (lisplet-register-function-location *test-lisplet* @@ -118,7 +118,7 @@ "images/matrix2.jpg" ) @end lisp @end cartouche -Now the image will be availbe at the URL ``http://localhost:4242/test/images/matrix2.jpg''. +Now the image will be available at the URL ``http://localhost:4242/test/images/matrix2.jpg''. The method @code{lisplet-register-function-location} accepts two optional keys: @itemize @minus @@ -139,10 +139,22 @@ @cartouche @lisp (defclass empty-page (page) ()) -(lisplet-register-page-location *test-lisplet* 'empty-page "index.html" :welcome-page-p t) +(lisplet-register-page-location *test-lisplet* 'empty-page "index.html" + :welcome-page-p t) @end lisp @end cartouche This will provide an empty page at the URL ``http://localhost:4242/test/index.html'' and, since it is defined as a welcome page when you'll access the URL ``http://localhost:4242/test'' you will redirected to it. + +@section Sessions + +Sessions are common place where you sore stateful user data. Session handling is slightly different from the original one +implemented by @code{Hunchentoot}, so, to instantiate a session you have to use the method +@cartouche +@lisp +(lisplet-start-session) +@end lisp +@end cartouche +inside your code. Modified: trunk/doc/chapters/pages.texinfo ============================================================================== --- trunk/doc/chapters/pages.texinfo (original) +++ trunk/doc/chapters/pages.texinfo Wed Apr 9 13:59:58 2008 @@ -1,3 +1,158 @@ @node Pages @comment node-name, next, previous, up @chapter Web application pages + +@value{claw} applications are usually made of pages. + +A @code{PAGE} is a @code{CLOS} class that contains the rendering logic and is called +by the @code{LISPLET} when the URL matches the page resource mapping. + +@section Writing your first @value{claw} page + +You already know how to register a @code{PAGE} into a @code{LISPLET}, if not, visit the previous chapter; what +you miss, is how to put content into a page. + +@value{claw} comes with the full set of html tags plus some custom components that we'll see in the next sections. + +All html tag are rendered with functions whose names are the tag name plus the character >. Tag attributes are pairs +of symbols for attribute names and strings for their values. + +For example the function that render a DIV tag with class attribute ``foo'' is: +@cartouche +@lisp +(div> :class "foo") +@end lisp +@end cartouche + +Given this short intro we are now ready to write our first @value{claw} page: +@cartouche +@lisp +(defclass index-page (page) ()) +(defmethod page-content ((index-page index-page)) + (html> + (head> + (title> "First sample page")) + (body> + (h1> "Hello world")))) +(lisplet-register-page-location *test-lisplet* 'index-page "index.html" + :welcome-page-p t) +@end lisp +@end cartouche + +So, overriding the method @code{PAGE-CONTENT} for your new defined page gives you the possibility +to insert its content. As you can see the method definition is very similar to an HTML file, thought +more concise. + +@subsection The special tag attribute: @code{:ID} and @code{:STATIC-ID} + +@value{claw} pages try to keep ``ID'' tag attributes unique among the page. This is particularly useful +when you have to render tags that expose their id inside a loop. +To see what happens when this situation occurs see the following example: +@cartouche +@lisp +(defmethod page-content ((sample-page sample-page)) + (html> + (head> + (title> "First sample page")) + (body> + (loop for letter in (list "A" "B" "C" "D") + collect (div> :id "item" letter))))) +@end lisp +@end cartouche + +will produce the following HTML code +@cartouche +@example +@format +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" + "http://www.w3.org/TR/html4/strict.dtd"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> + <title>First sample page</title> + </head> + <body> + <div id="item">A</div> + <div id="item_1">B</div> + <div id="item_2">C</div> + <div id="item_3">D</div> + <script type="text/javascript"> +// + </script> + </body> +</html> +@end format +@end example +@end cartouche + +When you want to prevent the default behaviour on id generation you have to provide the tag with the +attribute @code{:STATIC-ID}, that will render into HTML as the attribute @code{:ID}, but without the id +unique logic generation. + +An important method that is present in all tags and component is the @code{GENERATE-ID} that you +may use to obtain a unique id and put into components or tags with @code{:STATIC-ID}. + +Look at the following to see how it can work: +@cartouche +@lisp +(defmethod page-content ((sample-page sample-page)) + (html> + (head> + (title> "First sample page")) + (body> + (loop for letter in (list "A" "B" "C" "D") + for id = (generate-id "item") then (generate-id "item") + collect (div> (span> :static-id id letter) + (span> :onclick + (format nil "alert(document.getElementById('~a').innerHTML);" + id) + "click me")))))) +@end lisp +@end cartouche +that will produce the following HTML code: +@cartouche +@example +@format +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" + "http://www.w3.org/TR/html4/strict.dtd"> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> + <title>First sample page</title> + </head> + <body> + <div> + <span id="item">A</span> + <span onclick="alert(document.getElementById('item').innerHTML);"> + click me</span> + </div> + <div> + <span id="item_1">B</span> + <span onclick="alert(document.getElementById('item_1').innerHTML);"> + click me</span> + </div> + <div> + <span id="item_2">C</span> + <span onclick="alert(document.getElementById('item_2').innerHTML);"> + click me</span> + </div> + <div> + <span id="item_3">D</span> + <span onclick="alert(document.getElementById('item_3').innerHTML);"> + click me</span> + </div> + <script type="text/javascript"> +// + </script> + </body> +</html> +@end format +@end example +@end cartouche + +So, the outside tag generated id, is used in the onclick method of the span tags to reference the +previous tag. Modified: trunk/doc/chapters/server.texinfo ============================================================================== --- trunk/doc/chapters/server.texinfo (original) +++ trunk/doc/chapters/server.texinfo Wed Apr 9 13:59:58 2008 @@ -431,7 +431,8 @@ @cartouche @lisp -(defparameter *clawserver* (make-instance 'clawserver :port 4242 :sslport 4443 +(defparameter *clawserver* (make-instance 'clawserver :port 4242 + :sslport 4443 :ssl-certificate-file #P"/path/to/certificate/cacert.pem" :ssl-privatekey-file #P"/path/to/certificate/privkey.pem"))) (clawserver-start *clawserver*)

1 0

[claw-cvs] r33 - trunk/main/claw-core/tests
by achiumenti＠common-lisp.net 09 Apr '08

09 Apr '08

Author: achiumenti Date: Wed Apr 9 13:59:03 2008 New Revision: 33 Modified: trunk/main/claw-core/tests/test1.lisp Log: clutter removing Modified: trunk/main/claw-core/tests/test1.lisp ============================================================================== --- trunk/main/claw-core/tests/test1.lisp (original) +++ trunk/main/claw-core/tests/test1.lisp Wed Apr 9 13:59:03 2008 @@ -115,7 +115,7 @@ (html> (head> (title> - (wcomponent-parameter-value o ':title)) + (wcomponent-parameter-value o :title)) (style> :type "text/css" "input.error { background-color: #FF9999;

1 0

[claw-cvs] r32 - in trunk/main/claw-core: src tests
by achiumenti＠common-lisp.net 09 Apr '08

09 Apr '08

Author: achiumenti Date: Wed Apr 9 09:17:57 2008 New Revision: 32 Modified: trunk/main/claw-core/src/tags.lisp trunk/main/claw-core/tests/test1.lisp Log: updating user manual Modified: trunk/main/claw-core/src/tags.lisp ============================================================================== --- trunk/main/claw-core/src/tags.lisp (original) +++ trunk/main/claw-core/src/tags.lisp Wed Apr 9 09:17:57 2008 @@ -1014,7 +1014,7 @@ (when (eq k :id) (setf id v)) (when (eq k :static-id) - (setf static-id v)))) + (setf static-id v)))) (when (and (eq id :required) (null static-id)) (error (format nil "Parameter id of class ~a is required" Modified: trunk/main/claw-core/tests/test1.lisp ============================================================================== --- trunk/main/claw-core/tests/test1.lisp (original) +++ trunk/main/claw-core/tests/test1.lisp Wed Apr 9 09:17:57 2008 @@ -55,12 +55,12 @@ ));:message-dispatcher *lisplet-messages*)) (defvar *test-lisplet2*) -(setf *test-lisplet2* (make-instance 'lisplet :realm "test2" :base-path "/test2" - ));:message-dispatcher *lisplet-messages*)) +(setf *test-lisplet2* (make-instance 'lisplet :realm "test2" + :base-path "/test2")) ;;(defparameter *clawserver* (make-instance 'clawserver :port 4242)) -(defparameter *clawserver* (make-instance 'clawserver :port 4242 :sslport 4445 +(defvar *clawserver* (make-instance 'clawserver :port 4242 :sslport 4445 :mod-lisp-p nil :ssl-certificate-file #P"/home/kiuma/pem/cacert.pem" :ssl-privatekey-file #P"/home/kiuma/pem/privkey.pem")) @@ -205,14 +205,12 @@ (lisplet-register-function-location *test-lisplet* #'(lambda () (let ((path (test-image-file))) - (progn - (setf (content-type) (mime-type path)) - (load-time-value - (with-open-file (in (test-image-file) :element-type 'flex:octet) - (let ((image-data (make-array (file-length in) - :element-type 'flex:octet))) - (read-sequence image-data in) - image-data)))))) + (setf (content-type) (mime-type path)) + (with-open-file (in path :element-type 'flex:octet) + (let ((image-data (make-array (file-length in) + :element-type 'flex:octet))) + (read-sequence image-data in) + image-data)))) "images/matrix2.jpg" ) ;;;--------------------realm test page-------------------------------- (defclass realm-page (page) ())

1 0

[claw-cvs] r31 - trunk/doc/chapters
by achiumenti＠common-lisp.net 09 Apr '08

09 Apr '08

Author: achiumenti Date: Wed Apr 9 09:17:29 2008 New Revision: 31 Modified: trunk/doc/chapters/intro.texinfo Log: updating user manual Modified: trunk/doc/chapters/intro.texinfo ============================================================================== --- trunk/doc/chapters/intro.texinfo (original) +++ trunk/doc/chapters/intro.texinfo Wed Apr 9 09:17:29 2008 @@ -10,6 +10,17 @@ @value{claw} is based on components, highly reusable building blocks the make easy and fast the creation of a web application. By using and creating new components, the developer can create robust and consistent web application with the minimal effort. +Each component may inject into a page ist own set of stylesheet and javasctipt files, and may come with its own class or instance javascript +directives (a class directive is inserted only once into the page, while this is not true for an instance script). This leads to +the creation of very sophisticated components with a very little effort. + +@value{claw} comes with its own authentication systme that lets you create both basic and form based authentication systems. + +@value{claw} has the capability to force the page renderinig throught the protocol https of pages managing sensible data, using simple +directives. + +@value{claw} comes with its own extensible localization and validation system. + The main aim of @value{claw} is @cite{`divide et impera'}, that means that dividing problems into small problems let programmers work on different part of an application, creating ad hoc components for both generic and specific tasks. @@ -21,9 +32,9 @@ @subsection The request cycle -When a user asks for a page the request is sent to the woserver that dispatches the request to the registered lisplets. +When a user asks for a page the request is sent to the @code{CLAWSERVER} that dispatches the request to the registered lisplets. -Lisplets are web resource containers that hold web pages and other resource files, such as javascript, image, css, etc. files, under a common path. +Lisplets are web resource containers that hold web pages and other resource files, such as javascript, image, css, etc. files, or even funcions, under a common path. When a matching lisplet is then found, it dispatches the request to a registered resource that can be a page or a file or even a function.

1 0

[claw-cvs] r30 - trunk/doc/chapters
by achiumenti＠common-lisp.net 09 Apr '08

09 Apr '08

Author: achiumenti Date: Wed Apr 9 09:17:03 2008 New Revision: 30 Modified: trunk/doc/chapters/server.texinfo Log: updating user manual Modified: trunk/doc/chapters/server.texinfo ============================================================================== --- trunk/doc/chapters/server.texinfo (original) +++ trunk/doc/chapters/server.texinfo Wed Apr 9 09:17:03 2008 @@ -440,3 +440,15 @@ @value{claw} is now up and you can browse it with your browser using address http://www.yourcompany.com:4242 and http://www.yourcompany.com:4443. Of course you will have only a 404 response page! + +@subsection Making all applications to work under a common path + +You have the possibility to define a common path to mapp all @value{claw} applications registered into the server, +defining the global variable @code{*CLAWSERVER-BASE-PATH*}. This way, if you have two applcations mapped for example to +``/applicationA'' and ``/applicationB'', setting that variable to the common path ``/yourcompany'' with the instruction +@cartouche +@lisp +(setf *clawserver-base-path* "/yourcompany") +@end lisp +@end cartouche +you will have the two applications now mapped to ``/yourcompany/applicationA'' and ``/yourcompany/applicationB''.

1 0

[claw-cvs] r29 - trunk/doc/chapters
by achiumenti＠common-lisp.net 09 Apr '08

09 Apr '08

Author: achiumenti Date: Wed Apr 9 09:16:31 2008 New Revision: 29 Added: trunk/doc/chapters/access.texinfo trunk/doc/chapters/advanced-components.texinfo trunk/doc/chapters/advanced-techniques.texinfo trunk/doc/chapters/forms.texinfo trunk/doc/chapters/getting-started.texinfo trunk/doc/chapters/i18n.texinfo trunk/doc/chapters/lisplets.texinfo trunk/doc/chapters/pages.texinfo trunk/doc/chapters/validation.texinfo trunk/doc/chapters/writing-components.texinfo Log: updating user manual Added: trunk/doc/chapters/access.texinfo ============================================================================== --- (empty file) +++ trunk/doc/chapters/access.texinfo Wed Apr 9 09:16:31 2008 @@ -0,0 +1,3 @@ +@node login access +@comment node-name, next, previous, up +@chapter Access validation and authorization Added: trunk/doc/chapters/advanced-components.texinfo ============================================================================== --- (empty file) +++ trunk/doc/chapters/advanced-components.texinfo Wed Apr 9 09:16:31 2008 @@ -0,0 +1,3 @@ +@node advanced components +@comment node-name, next, previous, up +@chapter Writing advanced components Added: trunk/doc/chapters/advanced-techniques.texinfo ============================================================================== --- (empty file) +++ trunk/doc/chapters/advanced-techniques.texinfo Wed Apr 9 09:16:31 2008 @@ -0,0 +1,3 @@ +@node Advanced techniques +@comment node-name, next, previous, up +@chapter Advanced techniques Added: trunk/doc/chapters/forms.texinfo ============================================================================== --- (empty file) +++ trunk/doc/chapters/forms.texinfo Wed Apr 9 09:16:31 2008 @@ -0,0 +1,3 @@ +@node forms +@comment node-name, next, previous, up +@chapter @value{claw} forms and form components Added: trunk/doc/chapters/getting-started.texinfo ============================================================================== --- (empty file) +++ trunk/doc/chapters/getting-started.texinfo Wed Apr 9 09:16:31 2008 @@ -0,0 +1,3 @@ +@node Getting Started +@comment node-name, next, previous, up +@chapter Getting started with @value{claw} Added: trunk/doc/chapters/i18n.texinfo ============================================================================== --- (empty file) +++ trunk/doc/chapters/i18n.texinfo Wed Apr 9 09:16:31 2008 @@ -0,0 +1,3 @@ +@node i18n +@comment node-name, next, previous, up +@chapter Internationalization of our application Added: trunk/doc/chapters/lisplets.texinfo ============================================================================== --- (empty file) +++ trunk/doc/chapters/lisplets.texinfo Wed Apr 9 09:16:31 2008 @@ -0,0 +1,148 @@ +@node Lisplets +@comment node-name, next, previous, up +@chapter Lisplets + +Lisplets are @code{CLOS} objects that extend the functionalities of @code{CLAWSERVER}, dispatching requests that +come from this last one. + +Lisplets are so, the place where you put your web applications developed with @value{claw}. + +Lisplets return to the requesting user, pages, functions and resources mapped into them. + +Each Lisplet contains its own dispatch table and realm so that applications are not mixed together. + +@section Registering a lisplet into the server, crating a web application + +To create a web application you have to instantiate a @code{LISPLET} and then register it into the server. +@cartouche +@lisp +(defvar *clawserver* (make-instance 'clawserver :port 4242)) + +(defvar *test-lisplet* (make-instance 'lisplet :base-path "/test")) +(clawserver-register-lisplet *clawserver* *test-lisplet*) + +;;; you can now start the server +;;; with: +;;; (clawserver-start *clawserver*) +;;; and +;;; (clawserver-stop *clawserver*) +@end lisp +@end cartouche + +At this point you have defined a web application registered to the URL ``http://localhost:4242/test'' that +@value{claw} will be able to serve. + +All sessions and the authentication and authourization logic will be under the default realm ``claw'', +so if you register another lisplet into the server with the instruction: +@cartouche +@lisp +(defvar *test-lisplet2* (make-instance 'lisplet :base-path "/test2")) +(clawserver-register-lisplet *clawserver* *test-lisplet2*) +@end lisp +@end cartouche +any user session will be shared among @code{*test-lisplet*} and @code{*test-lisplet2*} and if a user is logged into +``/test'' application, he will be logged into ``/test2'' application too. + +To avoid this behaviour, you need to define a different realm for each of the two lisplet as the following example does: +@cartouche +@lisp +(defvar *clawserver* (make-instance 'clawserver :port 4242)) + +(defvar *test-lisplet* (make-instance 'lisplet :realm "test" + :base-path "/test")) +(clawserver-register-lisplet *clawserver* *test-lisplet*) + +(defvar *test-lisplet2* (make-instance 'lisplet :realm "test2" + :base-path "/test2")) +(clawserver-register-lisplet *clawserver* *test-lisplet2*) +@end lisp +@end cartouche + +The two lisplets will now have different realms, so a user session in @code{*test-lisplet*} will be +different from the one in @code{*test-lisplet2*}. So for the authentication and authorization module. +The same is for a user logged into the first application, he will not be automatically logged into the +other now. + +@section Adding resources into a @code{LISPLET} + +Lisplets alone don't do anything more then providing some error pages when something goes wrong. +To make a @code{LISPLET} a web application, you have to fill it with some application resource, and this +may be done in several ways. + +@subsection Adding files and folders to a @code{LISPLET} + +Suppose now you want to provide, thought your web application, a file present on jour hard disk, for example: +``/opt/webresources/images/matrix.jpg''. + +This is made very simple with the following instructions +@cartouche +@lisp +(lisplet-register-resource-location *test-lisplet* + #P"/opt/webresources/images/matrix.jpg" + "images/matrix.jpg" "image/jpeg") +@end lisp +@end cartouche + +The jpeg file will now be available when accessing ``http://localhost:4242/test/images/matrix.jpg''. +The last rgument specifies the mime-type, but it's optional. + +If you want to regiter an entire folder, the process is very similar +@cartouche +@lisp +(lisplet-register-resource-location *test-lisplet* + #P"/opt/webresources/images/" + "images2/") +@end lisp +@end cartouche + +Now you'll be able to access the same resource following the URL +``http://localhost:4242/test/images2/matrix.jpg'', easy, isn't it? + +@subsection Adding functions to a @code{LISPLET} + +Registering a function gives you more flexybility then registering a static resource as a file or a directory but the complexity +relies into the function that you want to register. + +For example, if you want to provide the same ``matrix.jpg'' file throught a function, you'll have to do something of the kind: +@cartouche +@lisp +(lisplet-register-function-location *test-lisplet* + #'(lambda () + (let ((path #P"/opt/webresources/images/matrix.jpg")) + (setf (content-type) (mime-type path)) + (with-open-file (in path :element-type 'flex:octet) + (let ((image-data (make-array (file-length in) + :element-type 'flex:octet))) + (read-sequence image-data in) + image-data)))) + "images/matrix2.jpg" ) +@end lisp +@end cartouche +Now the image will be availbe at the URL ``http://localhost:4242/test/images/matrix2.jpg''. + +The method @code{lisplet-register-function-location} accepts two optional keys: +@itemize @minus +@item +@code{:WELCOME-PAGE-P} that +will redirect you to the registered location when you'll access your application with the URL +``http://localhost:4242/test'' +@item +@code{:LOGIN-PAGE-P} that will redirect an unregistered user to the resource when he tries to access +a protected resource to perform the login with a form based authentication. +@end itemize + +@subsection Adding pages to a @code{LISPLET} + +Pages are one of the key objects of @value{claw}, since they are sophisticated collectors of web components. +Pages are described in the next chapter, meanwhile to register a page that is a @code{CLOS} object, the procedure +is very similar to when you register a function. +@cartouche +@lisp +(defclass empty-page (page) ()) +(lisplet-register-page-location *test-lisplet* 'empty-page "index.html" :welcome-page-p t) +@end lisp +@end cartouche + +This will provide an empty page at the URL ``http://localhost:4242/test/index.html'' and, since it +is defined as a welcome page when you'll access the URL ``http://localhost:4242/test'' you will redirected +to it. Added: trunk/doc/chapters/pages.texinfo ============================================================================== --- (empty file) +++ trunk/doc/chapters/pages.texinfo Wed Apr 9 09:16:31 2008 @@ -0,0 +1,3 @@ +@node Pages +@comment node-name, next, previous, up +@chapter Web application pages Added: trunk/doc/chapters/validation.texinfo ============================================================================== --- (empty file) +++ trunk/doc/chapters/validation.texinfo Wed Apr 9 09:16:31 2008 @@ -0,0 +1,3 @@ +@node validation +@comment node-name, next, previous, up +@chapter Input validation and field translations Added: trunk/doc/chapters/writing-components.texinfo ============================================================================== --- (empty file) +++ trunk/doc/chapters/writing-components.texinfo Wed Apr 9 09:16:31 2008 @@ -0,0 +1,3 @@ +@node writing components +@comment node-name, next, previous, up +@chapter Creating a web application by writing reusable components

1 0

[claw-cvs] r28 - trunk/main/claw-core/src
by achiumenti＠common-lisp.net 09 Apr '08

09 Apr '08

Author: achiumenti Date: Wed Apr 9 08:24:28 2008 New Revision: 28 Modified: trunk/main/claw-core/src/misc.lisp Log: Corrected the registering lisplet function Modified: trunk/main/claw-core/src/misc.lisp ============================================================================== --- trunk/main/claw-core/src/misc.lisp (original) +++ trunk/main/claw-core/src/misc.lisp Wed Apr 9 08:24:28 2008 @@ -71,7 +71,7 @@ "Isert a new cons into a list of cons, or replace the one that has the same location registered (its car)." (let ((result (remove-by-location (car location-cons) cons-list))) - (setf result (push location-cons cons-list)))) + (setf result (push location-cons result)))) (defun lisplet-start-session () "Starts a session boud to the current lisplet base path"

1 0

[claw-cvs] r27 - in trunk/main/claw-core: src tests
by achiumenti＠common-lisp.net 09 Apr '08

09 Apr '08

Author: achiumenti Date: Wed Apr 9 05:26:01 2008 New Revision: 27 Modified: trunk/main/claw-core/src/misc.lisp trunk/main/claw-core/src/packages.lisp trunk/main/claw-core/src/tags.lisp trunk/main/claw-core/tests/test1.lisp Log: corrected json requests and init script injection that will be evaluate on document load Modified: trunk/main/claw-core/src/misc.lisp ============================================================================== --- trunk/main/claw-core/src/misc.lisp (original) +++ trunk/main/claw-core/src/misc.lisp Wed Apr 9 05:26:01 2008 @@ -144,6 +144,13 @@ (t (push element result)))) (nreverse result))) +(defun msie-p (&optional (request *request*)) + "Returns nil when the calling browser is not the evil of MSIE" + (let* ((header-props (headers-in request)) + (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)))))) + (defmacro with-message (key &optional (default "") locale) (let ((current-lisplet (gensym)) (current-page (gensym)) Modified: trunk/main/claw-core/src/packages.lisp ============================================================================== --- trunk/main/claw-core/src/packages.lisp (original) +++ trunk/main/claw-core/src/packages.lisp Wed Apr 9 05:26:01 2008 @@ -46,6 +46,7 @@ :*clawserver-base-path* :*apache-http-port* :*apache-https-port* + :*empty-tags* ;:request-realm :request-id-table-map ;:dyna-id @@ -260,6 +261,7 @@ #-:hunchentoot-no-ssl :clawserver-ssl-certificate-file #-:hunchentoot-no-ssl :clawserver-ssl-privatekey-file #-:hunchentoot-no-ssl :clawserver-ssl-privatekey-password + :msie-p :clawserver-register-configuration :claw-require-authorization :configuration Modified: trunk/main/claw-core/src/tags.lisp ============================================================================== --- trunk/main/claw-core/src/tags.lisp (original) +++ trunk/main/claw-core/src/tags.lisp Wed Apr 9 05:26:01 2008 @@ -585,6 +585,16 @@ (page-format-raw page "<?xml version=\"1.0\" encoding=\"~a\"?>~%" encoding)) (when content-type (page-format-raw page "~a~%" content-type))))) + +(defun json-validation-errors () + (let ((validation-errors (aux-request-value :validation-errors))) + (if validation-errors + (strings-to-jsarray + (loop for component-exceptions in validation-errors + collect (format "{~a:~a}"(car component-exceptions) + (strings-to-jsarray (loop for message in (cdr component-exceptions) + collect (prin1-to-string message)))))) + "null"))) (defmethod page-render ((page page)) (let ((body (page-content page)) @@ -603,7 +613,7 @@ (page-init page) (when jsonp (page-format-raw page "{components:{")) - (setf (page-can-print page) t) + ;;(setf (page-can-print page) (null jsonp)) (htcomponent-render (page-content page) page) ;Here we need a fresh new body!!! (when jsonp (page-format-raw page "},classInjections:\"") @@ -615,7 +625,9 @@ (let ((init-scripts (htbody-init-scripts-tag page))) (when init-scripts (htcomponent-render init-scripts page))) - (page-format-raw page "\"}")))))) + (page-format-raw page "\",errors:") + (page-format-raw page (json-validation-errors)) + (page-format-raw page "}")))))) (defmethod page-body-init-scripts ((page page)) (let ((js-body "")) @@ -651,14 +663,17 @@ (setf (htcomponent-body current-js) class-init-scripts) (push current-js tag-list))) (dolist (js-file (page-script-files page)) - (let ((current-js (script> :type "text/javascript" :src ""))) - (setf (getf (htcomponent-attributes current-js) :src) js-file) - (push current-js tag-list))) - + (if (typep js-file 'htcomponent) + (push js-file tag-list) + (let ((current-js (script> :type "text/javascript" :src ""))) + (setf (getf (htcomponent-attributes current-js) :src) js-file) + (push current-js tag-list)))) (dolist (css-file (page-stylesheet-files page)) - (let ((current-css (link> :rel "stylesheet" :type "text/css" :href ""))) - (setf (getf (htcomponent-attributes current-css) :href) css-file) - (push current-css tag-list))) + (if (typep css-file 'htcomponent) + (push css-file tag-list) + (let ((current-css (link> :rel "stylesheet" :type "text/css" :href ""))) + (setf (getf (htcomponent-attributes current-css) :href) css-file) + (push current-css tag-list)))) tag-list)) @@ -681,7 +696,7 @@ (let* ((page (htcomponent-page htcomponent)) (jsonp (page-json-id-list page)) (id (htcomponent-client-id htcomponent))) - (when (or jsonp + (when (and jsonp (member id jsonp :test #'string-equal)) (when (> (page-json-component-count page) 0) (page-format page ",")) @@ -692,7 +707,7 @@ (let* ((page (htcomponent-page htcomponent)) (jsonp (page-json-id-list page)) (id (htcomponent-client-id htcomponent))) - (when (or jsonp + (when (and jsonp (member id jsonp :test #'string-equal)) (page-format-raw page "\"")))) @@ -943,9 +958,21 @@ (htcomponent-json-print-end-component htbody)))) (defmethod htbody-init-scripts-tag ((page page)) - (let ((js (script> :type "text/javascript"))) - (setf (htcomponent-page js) page) - (setf (htcomponent-body js) (page-body-init-scripts page)) + (let ((js (script> :type "text/javascript")) + (js-start-directive (if (msie-p) + "window.attachEvent('onload', function(e) {" + "document.addEventListener('DOMContentLoaded', function(e) {")) + (js-end-directive (if (msie-p) + "});" + "}, false);")) + (page-body-init-scripts (page-body-init-scripts page))) + (setf (htcomponent-page js) page + (htcomponent-body js) (when page-body-init-scripts + (if (listp page-body-init-scripts) + (append (list js-start-directive) + page-body-init-scripts + (list js-end-directive)) + (list js-start-directive page-body-init-scripts js-end-directive)))) js)) ;;;========= WCOMPONENT =================================== Modified: trunk/main/claw-core/tests/test1.lisp ============================================================================== --- trunk/main/claw-core/tests/test1.lisp (original) +++ trunk/main/claw-core/tests/test1.lisp Wed Apr 9 05:26:01 2008 @@ -163,6 +163,23 @@ (li> (a> :href "unauth.html" "unauthorized page")))))) (lisplet-register-page-location *test-lisplet* 'index-page "index.html" :welcome-page-p t) +(defcomponent msie-p ()()) + +(defmethod wcomponent-parameters ((msie-p msie-p)) + (list :id :required)) + +(defmethod wcomponent-template ((msie-p msie-p)) + (let ((id (htcomponent-client-id msie-p))) + (p> :static-id id))) + +(defmethod htcomponent-instance-initscript ((msie-p msie-p)) + (let ((id (htcomponent-client-id msie-p))) + (format nil "document.getElementById('~a').innerHTML = '~a';" + id + (if (msie-p) + "The browser is MSIE" + "The browser is not MSIE")))) + (defclass info-page (page) ()) (defmethod page-content ((o info-page)) @@ -174,7 +191,8 @@ (loop for key-val in header-props collect (tr> (td> (format nil "~a" (car key-val)) - (td> (format nil "~a" (cdr key-val))))))))))) + (td> (format nil "~a" (cdr key-val)))))))) + (msie-p> :id "msie")))) (lisplet-register-page-location *test-lisplet* 'info-page "info.html")

1 0

[claw-cvs] r26 - trunk/doc/chapters
by achiumenti＠common-lisp.net 02 Apr '08

02 Apr '08

Author: achiumenti Date: Wed Apr 2 02:15:27 2008 New Revision: 26 Modified: trunk/doc/chapters/intro.texinfo Log: documentation update Modified: trunk/doc/chapters/intro.texinfo ============================================================================== --- trunk/doc/chapters/intro.texinfo (original) +++ trunk/doc/chapters/intro.texinfo Wed Apr 2 02:15:27 2008 @@ -25,9 +25,9 @@ Lisplets are web resource containers that hold web pages and other resource files, such as javascript, image, css, etc. files, under a common path. -When a matching lisplet is then found, it dispatches the request to a registered resource that can be a page or a file. +When a matching lisplet is then found, it dispatches the request to a registered resource that can be a page or a file or even a function. -If the request is sent for a file, this is then sent pack to the browser if found. +If the request is sent for a file, this is then sent back to the browser if found. If the request is sent for a page, usually mapped to a html url, the dispatcher calls the page rendering function to display the page as an html resource.

1 0

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

claw-cvs