UCW intro

YOURLISPHERE (-)-load start.lisp

darcs get http://common-lisp.net/project/ucw/repos/ucw_dev

darcs get http://common-lisp.net/project/ucw/repos/ucw_public

darcs get http://common-lisp.net/project/bese/repos/arnesi_dev/

darcs get http://common-lisp.net/project/bese/repos/yaclml/

darcs get http://common-lisp.net/project/ucw/repos/parenscript/

darcs get http://common-lisp.net/project/ucw/repos/rfc2388/

darcs get http://common-lisp.net/project/rfc2109/rfc2109

export CVSROOT=:pserver:anonymous@common-lisp.net:/project/slime/cvsroot
cvs login

cvs checkout slime

darcs get http://common-lisp.net/project/bese/repos/detachtty/

make
make install

apxs -i -c mod_lisp.c

apxs2 -i -c mod_lisp2.c

LoadModule lisp_module /path/to/modules/directory/mod_lisp.so

LispServer 127.0.0.1 3001 ucw

<LocationMatch "/path/.*\.ucw">
               SetHandler lisp-handler
</LocationMatch>

darcs get http://verisons.telent.net/araneida/

ln -s /path/to/library/lib.asd /usr/share/common-lisp/systems

(push #P"/path/to/asd/files/" asdf:*central-registry*)

darcs get http://common-lisp.net/project/ucw/repos/ucw-presentations

darcs get http://common-lisp.net/project/repos/ucw-forms

(load "/path/to/ucw/etc/start.lisp")

-a, --asdf-root DIRECTORY   Register asdf search DIRECTORY
-c, --config-file FILE      Read FILE as config file.
-h, --help                  Display this help and exit.
-k, --stop-file FILE        Use FILE as stop file.
-l, --lisp NAME             Use NAME (without PATH) as Common Lisp
                            implementation.
    --log-root DIRECTORY    Save the logs in DIRECTORY, overriding the
                            --var-root option.
    --run-root DIRECTORY    Created pid/socket in DIRECTORY, overriding the
                            --var-root option.
-s, --start-file FILE       Use FILE as start file.
-t, --timeout SECONDS       Set timeout in SECONDS when trying to stop a
                            a running session.
-u, --ucwctl-file FILE      Read FILE as the ucwctl.conf file.
    --var-root DIRECTORY    Save the logs in DIRECTORU/log/ucw and create
                            pid/socket in DIRECTORY/run/ucw, if the two
                            options --log-root and --run-root are not set.

ucwctl start

ucwctl stop

ucwctl attach

(setf *ucw-backend-type* ':httpd)
(setf *ucw-backend-host* "127.0.0.1")
(setf *ucw-backend-port* 8080)

(setf *ucw-backend-type* ':mod-lisp)
(setf *ucw-backend-host* "127.0.0.1")
(setf *ucw-backend-port* 3001)

(setf *ucw-backend-type* ':araneida)
(setf *ucw-backend-host* "127.0.0.1")
(setf *ucw-backend-port* 8080)

(setf *ucw-backend-type* ':aserve)
(setf *ucw-backend-host* "127.0.0.1")
(setf *ucw-backend-port* 8080)

(setf *ucw-swank-port* 4005)

(setf *ucw-server-class* 'standard-server)

(setf *ucw-inspector* t)

(setf *ucw-debugger* t)

(setf *ucw-log-level* '+INFO+)

(setf *ucw-applications-directory* "/etc/ucw/applications.d/")

(setf *ucw-systems* '(:ucw.admin :ucw.examples))
(setf *ucw-applications* '(it.bese.ucw::*admin-application*
	   		       it.bese.ucw-user::*example-application*))

(defpackage :ucw.intro.system
  (:use :cl :asdf))

(in-package :ucw.intro.system)

(defsystem ucw-intro
  :version "0.0.0.0.1"
  :depends-on (:ucw)
  :author "a lonely clown"
  :components ((:file "packages")
               (:file "config"      :depends-on ("packages"))
               (:file "hello-world" :depends-on ("config"))))

(in-package :cl-user)

(defpackage :ucw-intro
  (:use :common-lisp
        :it.bese.ucw
        :it.bese.arnesi
        :it.bese.yaclml))       

(defvar *ucw-systems* '(:ucw.admin :ucw.examples))
(defvar *ucw-applications* '(it.bese.ucw::*admin-application*
	    		         it.bese.ucw-user::*example-application*))

ln -s /path/to/ucw-intro/www var/www/localhost/htdocs/ucw-intro

(in-package :ucw-intro)

(defvar *www-root*
  (merge-pathnames
   (make-pathname :directory '(:relative "www"))
   (asdf:component-pathname (asdf:find-system :ucw-intro))))

(defparameter *ucw-intro-application*
  (make-instance 'cookie-session-application
                 :url-prefix "/ucw-intro/"
                 :www-roots (list *www-root*)
                 :dispatchers (list (make-instance 'ucw::action-dispatcher)
                                    ;; hello world
                                    (url-dispatcher "hello-world.ucw"
                                      (call 'hello-world)))
                 :debug-on-error t))

(in-package :ucw-intro)

(defcomponent hello-world (simple-window-component) ()
              (:default-initargs :title "hi"
              :stylesheet '("stylesheet.css" "stylesheet2.css")
              :content-type "text/html; charset=utf-8;"
              :javascript '((:src "dojo.js")
                            (:js (dojo.require "dojo.event.*"))
                            (:script "var foo = 3;")))
;;            (:entry-point "hello-world.ucw" (:application *ucw-intro-application* :class url-dispatcher))
              (:render () (<:as-html "hello world")))

(in-package :ucw-intro)

(defvar *www-root*
  (merge-pathnames
   (make-pathname :directory '(:relative "www"))
   (asdf:component-pathname (asdf:find-system :ucw-intro))))

(defparameter *ucw-intro-application*
  (make-instance 'cookie-session-application
                 :url-prefix "/ucw-intro/"
                 :www-roots (list *www-root*)
                 :dispatchers (list (make-instance 'ucw::action-dispatcher)
                                    ;; hello world
                                    (url-dispatcher "hello-world.ucw"
                                      (call 'hello-world)))
                 :debug-on-error t))

(in-package :ucw-intro)

(defcomponent hello-world (simple-window-component) ()
              (:default-initargs :title "hi"
              :stylesheet '("stylesheet.css" "stylesheet2.css")
              :content-type "text/html; charset=utf-8;"
              :javascript '((:src "dojo.js")
                            (:js (dojo.require "dojo.event.*"))
                            (:script "var foo = 3;")))
;;            (:entry-point "hello-world.ucw" (:application *ucw-intro-application* :class url-dispatcher))
              (:render () (<:as-html "hello world")))

(defclass hello-world () ()
  (:metaclass standard-component-class))

(defentry-point "hello-world.ucw"
  (:application *ucw-intro-application* :class url-dispatcher)
  () (call 'hello-world))

(defmethod render ((hello-world hello-world))
  (<:as-is "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/transitional.dtd\">"
	       #\Newline)
  (<:html
   (<:head
    (<:meta :http-equiv "Content-Type" :content "text/html; charset=utf-8;")
    (<:title (<:as-html "hi"))
    (<:link :rel "stylesheet"
            :href "stylesheet.css"
            :type "text/css")
    (<:link :rel "stylesheet"
            :href "stylesheet2.css"
            :type "text/css")
    (<:script
     ;; most browsers (firefox, safari and ie at least) really,
     ;; really, really don't like empty script tags. The "" forces
     ;; yaclml to generate a seperate closing tag.
     :type "text/javascript" :src "dojo.js" "")
    (<:script :type "text/javascript" (<:as-is (js:js* '(dojo.require "dojo.event.*"))))
    (<:script :type "text/javascript" (<:as-is "var foo = 3;")))
   (<:body (<:as-html "hello world"))))

(call ...

(answer ....

;; basics
(regexp-dispatcher "^(basics.ucw|)$"
  (call 'basics))
(regexp-dispatcher "^(get.ucw|)$"
  (with-request-params ((cow "moo"))
      (context.request *context*)
    (let ((cow (concatenate 'string "mighty " cow)))
      (call 'basics :cow cow))))

(:file "basics"      :depends-on ("config"))

(in-package :ucw-intro)

(defcomponent basics (simple-window-component)
  ((cow :initarg :cow :accessor cow :initform "aspacia")
   (pig :initarg :pig :accessor pig :initform "knorrie"))
  (:default-initargs :title "hi")
  (:render ()
           (with-slots (cow pig)
               basics
             (<:as-is "in the old days, to update the name of your lovely cow named <b>" #\Newline)
             (<:as-html cow)
             (<:as-is "</b> you would update it like so: ")
             (<:form :action "get.ucw"
                     :method "GET"
                     (<:text :name "cow")
                     (<:submit :value "name your cow"))
             (<:p (<:a :href "get.ucw" "go to get without any value to get to the default value of the entry point"))
             (<:p
              (<:as-html "but we have left them behind. In the brave new world we will update the name of our lovely pig like: ")
              (<ucw:form :method "POST"
                         :action (refresh-component basics)
                         (<ucw:text :accessor pig)
                         (<:submit :value "name your pig")))
             (<:p
              (<:as-html "to pass a value and control to another component we do like so:")
              (let ((stuff-to-say ""))
                (<ucw:form :action (get-stuff-to-say basics stuff-to-say)
                           :method "POST"
                           (<ucw:textarea :accessor stuff-to-say)
                           (<:br)
                           (<:submit :value "have something to say")))))))

;;(defentry-point "get.ucw"
;;    (:application *ucw-intro-application*)
;;    ((cow "moo"))
;;  (+ 2 2)
;;  (let ((cow (concatenate 'string "mighty " cow)))
;;    (call 'basics :cow cow)))

(defaction get-stuff-to-say ((basics basics) stuff-to-say)
  (let ((stuff-to-say (concatenate 'string stuff-to-say " (boring!!!)")))
    (setf (cow basics) (call 'the-other-one :stuff-to-say stuff-to-say))))

(defaction ok ((c component) &optional (value c))
  (answer value))

(defcomponent the-other-one (simple-window-component)
  ((stuff-to-say :initarg :stuff-to-say :accessor stuff-to-say))
  (:default-initargs :title "hi"
    :content-type "text/html; charset=utf-8;")
  (:render ()
           (<:p
            (<:as-html "- "(stuff-to-say the-other-one)))
           (<:p
            (<:as-html "yeah, very 'enlightning'. Dazzle me some more: "))
           (<ucw:form :method "POST"
                      :action (refresh-component the-other-one)
                      (<ucw:textarea :reader (stuff-to-say the-other-one)
                                     :writer #'(lambda (x)(setf (stuff-to-say the-other-one) (concatenate 'string x " (boring  
                                     !!!!!)"))))
                      (<:br)
                      (<:submit :value "have something to say"))
           (<:br)
           (<ucw:a :action (ok the-other-one "nice to be back") "back to the last component")))

(:file "containers"      :depends-on ("config"))

;; containers
(regexp-dispatcher "^(containers.ucw|)$"
  (call 'office))

(in-package :ucw-intro)

(defcomponent timeline (widget-component)
  ((history :initarg :history :accessor history))
  (:render () (<:as-html (history timeline))))

(defcomponent drawer (widget-component)
  ((contents :initarg :contents :accessor contents))
  (:render () (<:as-html (contents drawer))))

(defcomponent office (simple-window-component)
  ((what-happened :initform '(0 0 0) :accessor what-happened)
   (closet :component (switching-container
                       :current-component-key 'in-office
                       :contents
                       `((in-office       . ,(make-instance 'timeline :history "You stand alone in the office of your evil boss. In
                       front of you you see a closet in which you are sure you will find valuables with which you can pay off your
                       insurmountable debts."))
                         (top-drawer    . ,(make-instance 'drawer
                                                          :contents "you find memoirs of a broken soul"))
                         (middle-drawer . ,(make-instance 'drawer
                                                          :contents "you find an agenda of grinding daily chores"))
                         (bottom-drawer . ,(make-instance 'drawer
                                                          :contents "you find an ointment to take the edge off"))))
           :accessor closet))
  (:render ()
           (with-slots (what-happened closet)
               office
             (unless (find-component closet 'leave) 
               (case (container.current-component-key closet)
                 ('top-drawer (setf (car what-happened) 1))
                 ('bottom-drawer (setf (cadr what-happened) 1))
                 ('middle-drawer (setf (caddr what-happened) 1)))
               (when (and (= (car what-happened) 1)
                          (= (cadr what-happened) 1)
                          (= (caddr what-happened) 1))
                 (add-component closet
                                (make-instance 'timeline :history "You leave the office ashamed and angry. You know now your evil boss
                               is also a human being and you will have to feel compassion for him forever.")
                                'leave)))
             (render closet)
             (<:br)
             (<:as-html "What will you do next?")
             (<:br)
             (if (eql (container.current-component-key closet) 'leave)
               (flet ((drawer-link (name text)
                        (<ucw:a :action (switch-component (closet office) name)
                                (<:as-html text))))
                 (<:ul
                  (<:li (drawer-link 'top-drawer "inspect top drawer"))
                  (<:li (drawer-link 'middle-drawer "inspect middle drawer"))
                  (<:li (drawer-link 'bottom-drawer "inspect bottom drawer"))
                  (<:li (drawer-link 'in-office "recall what your doing here"))
                  (when (find-component closet 'leave)
                    (<:li (drawer-link 'leave "leave")))))
               (<:ai "<br/>Nothing, just stand here a bit")))))

(defcomponent pane (tabbed-pane simple-window-component) ()
              (:default-initargs
                :title "pane"
                :stylesheet "sheet.css"
                :contents `(("hello world" . ,(make-instance 'hello-world))
                            ("basics" . ,(make-instance 'basics))
                            ("tal" . ,(make-instance 'tal-component))
                            ("more tal" . ,(make-instance 'more-tal)))
                :current-component-key "hello world")
              (:render ()
                       (call-next-method)))

(defparameter *ucw-intro-application*
  (make-instance 'cookie-session-application
                 :url-prefix "/ucw-intro/"
                 :www-roots (list *www-root*)
                 :tal-generator (make-instance 'yaclml:file-system-generator
                                               :cachep t
                                               :root-directories (list *www-root*))
                 :dispatchers (list (make-instance 'ucw::action-dispatcher)
                                    ;; hello world
                                    (url-dispatcher "hello-world.ucw"
                                      (call 'hello-world))
                                    ;; basics
                                    (regexp-dispatcher "^(basics.ucw|)$"
                                      (call 'basics))
                                    (regexp-dispatcher "^(get.ucw|)$"
                                      (with-request-params ((cow "moo"))
                                          (context.request *context*)
                                        (let ((cow (concatenate 'string "mighty " cow)))
                                          (call 'basics :cow cow))))
                                    ;; containers
                                    (regexp-dispatcher "^(containers.ucw|)$"
                                      (call 'office))
                                    ;; tal
                                    (regexp-dispatcher "^(tal.ucw|)$"
                                      (call 'tal-component))
                                    (regexp-dispatcher "^(more-tal.ucw|)$"
                                      (call 'more-tal)))
                 :debug-on-error t))

(in-package :ucw-intro)

(defcomponent tal-component (template-component)
  ((page-name :initarg :page-name :accessor page-name)
   (contents :initarg :contents :accessor contents))
  ;;  (:entry-point "^(|tal.ucw)$" (:application *ucw-intro-application* :class regexp-dispatcher))
  (:default-initargs :template-name "intro.tal" :page-name "Que tal!" :contents "<blink>Qual blink!!!</blink>"
                     :flag t))

<html xmlns:tal="http://common-lisp.net/project/bese/tal/core"
      tal:in-package=":ucw-intro">
  <head>
    <title tal:content="$page-name">page name goes here</title> 
  </head>
  <body>
    <h1 tal:content="(content $component" tal:escape-html="nil">content goes here</h1>
    <h1 tal:replace="$contents" tal:escape-html="t">content goes here</h1>
  </body>
</html>

(defcomponent more-tal (template-component)
  ((flag :initarg :flag :accessor flag)
   (da-var :initform "da-var from more-tal class" :accessor da-var)
   (tal-name :initform "more-wrapper.tal" :accessor tal-name)
   (another-var :initform "another-var from more-tal class" :accessor another-var)
   (a-href :initform "http://planet.lisp.org" :accessor a-href)
   (a-class :initform (make-instance 'in-list) :accessor a-class)
   (spliced-href :accessor spliced-href :initform '("http://" "planet." "lisp." "org"))
   (my-list :accessor my-list
            :initform `((,(make-instance 'in-list)
                         ,(make-instance 'another-in-list))
                        (((da-var . "da-var from a-list") (another-var . "another-var from a-list")))
                        (,(make-instance 'in-list :da-var "da-var from class in another bullet")
                         ((da-var . "da-var from another a-list") (another-var . "another-var from another alist")))
                        (,*tal-table*))))
  ;;  (:entry-point "^(|more-tal.ucw)$" (:application *ucw-intro-application* :class regexp-dispatcher))
  (:default-initargs :template-name "more-tal.tal" :flag nil))

(defclass in-list ()
  ((da-var :initarg :da-var :initform "da-var from in-list class" :accessor da-var)))

(defclass another-in-list ()
  ((another-var :initform "another-var from in-list class" :accessor another-var)))

(defparameter *tal-table* (make-hash-table))

(setf (gethash 'another-var *tal-table*) "another-var from hash")

<html xmlns:tal="http://common-lisp.net/project/bese/tal/core"
  xmlns:ucw="http://common-lisp.net/project/ucw/core"
  xmlns:param="http://common-lisp.net/project/bese/tal/params"
  tal:in-package=":ucw-intro">
  <head>
    <title>more tal</title>
  </head>
  <tal:include tal:name="more-wrapper.tal" param:little-class="(a-class $component)">
    <param:contents>
      <div tal:when="$flag" tal:content="$another-var">
        flag is set?
      </div>
      <ul>   
        <li tal:dolist="$my-list">
          <b tal:content="$da-var"></b><br/>
            <tal:tal tal:content="$another-var">another var</tal:tal>
        </li>
      </ul>      
      <p><a href="${(a-href $component)}">attribute insertion</a></p>      
      <p><a href="@{(spliced-href $component)}">spliced attribute insertion</a></p>
      <tal:lisp>
        (setf (a-href $component) "http://www.cliki.net")
      </tal:lisp>
      <a href="${(a-href $component)}">new value of href</a>      
    </param:contents>
  </tal:include>
</html>

<body
  xmlns:tal="http://common-lisp.net/project/bese/tal/core"
  xmlns:ucw="http://common-lisp.net/project/ucw/core"
  tal:in-package=":ucw-intro">
  <tal:tal tal:content="$contents" tal:escape-html="nil">here goes more-tal</tal:tal>
  <tal:lisp>
    (setf (da-var $little-class) "this is the new and quite boring contents of little class")
  </tal:lisp>
  <p tal:content="(da-var $little-class)">contents of little-class</p>
</body>

tal:name-expression="more${(print (string-downcase '-wrapper.tal))}"

<a href="" ucw:action="(respond $component $value)" tal:content="$text">text</a>
<input type="file" ucw:accessor="(file-upload-example.file $component)"/>
<ucw:render-component ucw:component="$selected-component"/>

(render-template ucw:*context* "tal-file.tal" nil)

(defcomponent  tal-component ()
  ...

(defcomponent tal-component (template-component)
  ...

(defmethod render ((component tal-component))
        (render-template ucw:*context* "intro.tal" nil))

(defmethod render ((component tal-component))
  (render-template ucw:*context* "intro.tal"  `(((component . ,component)))))

(defmethod render ((component tal-component))
  (render-template ucw:*context* "intro.tal" (make-standard-environment `((component . ,component)) component)))

UCW-INTRO> (with-dummy-context (:action nil :application *ucw-intro-application*)
    (call 'tal-component))

-->
16:36 UCW-LOGGER/+INFO+: CALL'ing to /#<BASICS {AE183A1}> 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/transitional.dtd">
<html
  ><head
...
  ></html
>
#<BASICS {AE183A1}>

UCW-INTRO> (with-dummy-context ()
             (get-stuff-to-say * "bla"))

-->
16:40 UCW-LOGGER/+INFO+: Serving action (/#<BASICS {B00FDA9}>/UCW-INTRO::GET-STUFF-TO-SAY #<BASICS {B00FDA9}> "bla")
16:40 UCW-LOGGER/+INFO+: CALL'ing to /#<THE-OTHER-ONE {B1707B1}> 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/transitional.dtd">
<html
  ><head
...
  ></html
>

UCW-INTRO> (with-dummy-context (:render nil :application *ucw-intro-application*)
                      (call 'tal-component))

-->
; in: LAMBDA NIL
;     (IT.BESE.UCW:CONTEXT.WINDOW-COMPONENT IT.BESE.UCW:*CONTEXT*)
; ==>
;   IT.BESE.UCW:*CONTEXT*
; 
; note: deleting unreachable code
; 
; compilation unit finished
;   printed 1 note
16:48 UCW-LOGGER/+INFO+: CALL'ing to /#<TAL-COMPONENT {B6EEE21}> 
#<TAL-COMPONENT {B6EEE21}>

UCW intro

Introduction

Installation

The (experimental) easy way

The (old and boring) hard way

Implementation.

Debian

Dependencies

arnesi

yaclml

parenscript - ucw version

iterate

rfc2388 - ucw version

rfc2109 - ucw version

split-sequence

SLIME

cl-ppcre

trivial-sockets

net.uri/PURI

cl-fad

cl-launch

detachtty - ucw version

the backend

mod_lisp/mod_lisp2 for apache

allegroserve or portableaserve

araneida

httpd

asdf

Add-ons

presentations

forms

Testing/Quickstart (for the non-boxset way)

Configuration

Setting up the environment (and a hello world on the side)

Basic ucw mechanics

Components, render methods, applications and entry points

Components

Applications

defcomponent and render methods

Entry points, actions, forms and control flow

Templating: nested components, containers and tal

nested components

containers

Tabbed-panes

TAL

How it works

Tal and lisp

Ucw-specific tal

Rendering tal files from within render methods

Debugging

Source

Miscellaneous

Changes

Todo

Contact