project.lisp

   1 ;;;; -*- Mode: Lisp; Syntax: ANSI-Common-Lisp; Base: 10; Package: wol -*-
   2 ;;;; *************************************************************************
   3 ;;;; FILE IDENTIFICATION
   4 ;;;;
   5 ;;;; Name:          project.lisp
   6 ;;;; Purpose:       Project handler for wol library
   7 ;;;; Programmer:    Kevin M. Rosenberg
   8 ;;;; Date Started:  July 2003
   9 ;;;;
  10 ;;;; $Id: project.lisp,v 1.9 2003/08/09 21:42:24 kevin Exp $
  11 ;;;;
  12 ;;;; This file and Wol are Copyright (c) 2001-2003 by Kevin M. Rosenberg
  13 ;;;; *************************************************************************
  14
  15 (in-package #:wol)
  16
  17 (defun wol-project (name &key (project-prefix "/") map index
  18                     (sessions t) (session-lifetime 18000)
  19                     (reap-interval 300) server
  20                     (connector :modlisp))
  21   (unless server
  22     (setq server
  23           (ecase connector
  24             (:modlisp ml:*ml-server*)
  25             (:aserve net.aserve:*wserver*))))
  26
  27   (unless server
  28     (warn "Can't start project without server")
  29     (return-from wol-project nil))
  30
  31   (multiple-value-bind (project found) (gethash name *active-projects*)
  32     (unless found
  33       (setq project (make-instance 'wol-project))
  34       (setf (gethash name *active-projects*) project))
  35
  36     (setf (project-name project) name)
  37     (setf (project-prefix project) project-prefix)
  38     (setf (project-map project) map)
  39     (setf (project-index project) index)
  40     (setf (project-server project) server)
  41     (setf (project-connector project) connector)
  42     (setf (lifetime (session-master project)) session-lifetime)
  43     (setf (cookie-name (session-master project)) name)
  44
  45     (let ((hash (make-hash-table :size (length map) :test 'equal)))
  46       (dolist (map-item map)
  47         (setf (gethash (first map-item) hash) (second map-item)))
  48       (setf (project-hash-map project) hash))
  49
  50     (ecase connector
  51       (:modlisp
  52        (setf (ml::processor server) 'wol-ml-processor))
  53       (:aserve
  54        (net.aserve:publish-prefix :prefix project-prefix
  55                                   :server server
  56                                   :function 'wol-aserve-processor)))
  57
  58   (if sessions
  59         (when (null (sessions (session-master project)))
  60           (setf (sessions (session-master project))
  61             (make-hash-table :test 'eq)))
  62       (when (sessions (session-master project))
  63         (setf (sessions (session-master project)) nil)))
  64
  65     (setq *reap-interval* reap-interval)
  66     (when (and sessions (null *reaper-process*))
  67       (setq *reaper-process* (start-reaper)))))
  68
  69 (defun wol-ml-processor (command)
  70   "Processes an incoming modlisp command"
  71   (let* ((req (command->request command
  72                                 :ml-server *ml-server*))
  73          (ent (make-entity-for-request req)))
  74     (if ent
  75         (dispatch-request req ent)
  76         (no-url-handler req ent))))
  77
  78
  79 (defun wol-aserve-processor (as-req as-ent)
  80   "Processes an incoming modlisp command"
  81   (multiple-value-bind (req ent) (make-request/ent-from-aserve as-req as-ent)
  82     (dispatch-request req ent)))
  83
  84
  85
  86 (defun make-request/ent-from-aserve (as-req as-ent)
  87   (let* ((req (make-instance
  88                'http-request
  89                :method (net.aserve:request-method as-req)
  90                ;;:host (net.aserve:request-host as-req)
  91                :raw-request (net.aserve::request-raw-request as-req)
  92                :raw-uri (puri:intern-uri
  93                          (net.uri:render-uri
  94                          (net.aserve:request-raw-uri as-req) nil))
  95                :decoded-uri-path
  96                (net.aserve::request-decoded-uri-path as-req)
  97                :uri (puri:intern-uri
  98                      (net.uri:render-uri
  99                      (net.aserve:request-uri as-req) nil))
 100                :protocol (net.aserve:request-protocol as-req)
 101                :protocol-string
 102                (net.aserve:request-protocol-string as-req)
 103                :posted-content (net.aserve::request-request-body as-req)
 104                :socket (net.aserve:request-socket as-req)
 105                :headers (net.aserve::request-headers as-req)
 106                :aserve-server net.aserve:*wserver*
 107                :aserve-request as-req))
 108          (ent (make-instance 'entity
 109                              :project (find-project-for-request req)
 110                              :aserve-entity as-ent)))
 111     (values req ent)))
 112
 113
 114 (defun command->request (command &key ml-server)
 115   "Convert a cl-modlisp command into a wol request"
 116   (let ((req
 117          (make-instance 'http-request
 118            :host (header-value command :host)
 119            :raw-request (header-value command :url)
 120            :raw-uri  (puri:intern-uri (header-value command :url))
 121            :uri (puri:intern-uri (command->uri command))
 122            :protocol (ensure-keyword
 123                       (header-value command :server-protocol))
 124            :protocol-string (header-value command :server-protocol)
 125            :method (ensure-keyword (header-value command :method))
 126            :posted-content (header-value command :posted-content)
 127            :headers command
 128            :socket *modlisp-socket*
 129            :ml-server ml-server)))
 130     (awhen (request-raw-uri req)
 131            (setf (request-decoded-uri-path req) (puri:uri-path it)))
 132     req))
 133
 134 (defun header-slot-value (req slot)
 135   (header-value (request-headers req) slot))
 136
 137 (defun command->uri (command)
 138   (format nil "http://~A:~D~A"
 139           (header-value command :host)
 140           (header-value command :server-ip-port)
 141           (header-value command :url)))
 142
 143 (defun is-index-request (req ent)
 144   (string= (request-decoded-uri-path req)
 145            (project-prefix (entity-project ent))))
 146
 147 (defun set-cookie (req ent)
 148   (let ((session (websession-from-req req)))
 149     (when (and session (websession-key session)
 150                (not (eq :url (websession-method session))))
 151       (let ((proj (entity-project ent)))
 152         (ecase (project-connector proj)
 153           (:aserve
 154            (cmsg "Set-cookie: ~A"  (websession-key
 155                                                  (websession-from-req req)))
 156            (net.aserve:set-cookie-header (aserve-request req)
 157                                          :name (project-name
 158                                                 (entity-project ent))
 159                                          :expires :never
 160                                          :secure nil
 161                                          :domain ".b9.com"
 162                                          :value (websession-key
 163                                                  (websession-from-req req))
 164                                          :path "/"))
 165           (:modlisp
 166            ;; fixme
 167            ))))))
 168
 169
 170 (defun redirect-entity (page req ent &optional plist)
 171   (let ((proj (entity-project ent))
 172         (url (render-uri
 173               (copy-uri (request-uri req)
 174                         :path (make-wol-url page req ent plist))
 175               nil)))
 176     (ecase (project-connector proj)
 177       (:aserve
 178        (net.aserve:with-http-response
 179            ((aserve-request req)
 180             (entity-aserve-entity ent)
 181             :response net.aserve:*response-temporary-redirect*)
 182          (set-cookie req ent)
 183          (net.aserve:with-http-body
 184              ((aserve-request req)
 185               (entity-aserve-entity ent)
 186               :headers `((:location . ,url))))))
 187       (:modlisp
 188        (redirect-to-location url)))))
 189
 190 (defun dispatch-request (req ent)
 191   (let ((proj (entity-project ent)))
 192     (if (is-index-request req ent)
 193         (redirect-entity (project-index proj) req ent)
 194         (progn
 195           (compute-uris req ent)
 196           (dispatch-to-handler req ent)))))
 197
 198 (defun make-entity (&key project)
 199   (make-instance 'entity :project project))
 200
 201 (defun make-entity-for-request (req)
 202   (awhen (find-project-for-request req)
 203          (make-entity :project it)))
 204
 205 (defun find-project-for-request (req)
 206   (maphash (lambda (name project)
 207              (declare (ignore name))
 208              (when (request-matches-prefix req (project-prefix project))
 209                (return-from find-project-for-request project)))
 210            *active-projects*))
 211
 212 (defun request-matches-prefix (req prefix)
 213   "Returns project if request matches project"
 214   (string-starts-with prefix (request-decoded-uri-path req)))
 215
 216
 217 (defun dispatch-to-handler (req ent)
 218   (let ((handler (request-find-handler req ent))
 219         (*wol-stream* (request-socket req)))
 220     (if handler
 221         (handle-request handler req ent)
 222       (no-url-handler req ent))))
 223
 224 (defun request-find-handler (req ent)
 225   (nth-value 0 (gethash (request-page req)
 226                         (project-hash-map (entity-project ent)))))
 227
 228 (defun handle-request (handler req ent)
 229   (typecase handler
 230     (null
 231      nil)
 232     ((or symbol function)
 233      (when (and (symbolp handler)
 234                 (not (fboundp handler)))
 235        (cmsg "handler given a symbol without a function ~S" handler)
 236        (return-from handle-request nil))
 237      (let ((next-page (funcall handler req ent)))
 238        (typecase next-page
 239          (string
 240           (redirect-entity next-page req ent))
 241          (cons
 242           (redirect-entity (car next-page) req ent (cadr next-page)))
 243          (null
 244           t)
 245          (t
 246           (cmsg "handler should return nil or a string, not ~S" next-page))))
 247      t)
 248     (string
 249      (cmsg "string handler not supported: ~A" handler)
 250      nil)
 251     (t
 252      (cmsg "unknown handler type: ~S" handler)
 253      nil)))
 254
 255
 256
 257 (defun wol-version-string ()
 258   (format nil "~{~D~^.~}" *wol-version*))
 259
 260 (defun alist-key->keyword (alist)
 261   (loop for a in alist
 262       collect (cons (kmrcl:ensure-keyword (car a)) (cdr a))))
 263
 264 (defun request-query (req &key (uri t) (post t))
 265   (aif (aserve-request req)
 266        (alist-key->keyword
 267         (net.aserve:request-query it :uri uri :post post))
 268     (let ((desired (cons uri post)))
 269       (if (equal desired (request-desired-query req))
 270           ;; Same desired as cached
 271           (request-query-alist req)
 272         (progn
 273           (setf (request-desired-query req) desired)
 274           (setf (request-query-alist req)
 275             (append
 276              (when (and uri (request-uri-query req))
 277                (query-to-alist (request-uri-query req)))
 278              (when (and post (request-posted-content req))
 279                (query-to-alist (request-posted-content req))))))))))
 280
 281 (defun request-query-value (key req &key (uri t) (post t))
 282   (aif (aserve-request req)
 283        (net.aserve:request-query-value (string key) it :uri uri :post post)
 284        (cdr (assoc key (request-query req :uri uri :post post)
 285                    :test 'equal))))
 286
 287 (defun websession-variable (ws name)
 288   (when ws
 289     (gethash name (websession-variables ws))))
 290
 291 (defun (setf websession-variable) (value ws name)
 292   (when ws
 293     (setf (gethash name (websession-variables ws)) value)))
 294
 295
 296 (defmacro with-wol-page ((req ent
 297                           &key (format :html) (precompute t) headers)
 298                          &body body)
 299   `(ecase (project-connector (entity-project ,ent))
 300      (:aserve
 301       (net.aserve:with-http-response
 302           ((aserve-request ,req)
 303            (entity-aserve-entity ,ent)
 304            :content-type (ml::format-string ,format))
 305         (set-cookie ,req ,ent)
 306         (net.aserve:with-http-body
 307             ((aserve-request ,req)
 308              (entity-aserve-entity ,ent)
 309              :headers ,headers)
 310           (let ((*html-stream* net.html.generator:*html-stream*))
 311             ,@body))))
 312      (:modlisp
 313       (%with-wol-page (,req ,ent :format ,format :precompute ,precompute
 314                             :headers ,headers)
 315                       ,@body))))
 316
 317
 318 (defmacro %with-wol-page ((req ent
 319                               &key (format :html) (precompute t) headers)
 320                          &body body)
 321   (declare (ignore req ent))
 322   (let ((fmt (gensym "FMT-"))
 323         (precomp (gensym "PRE-"))
 324         (result (gensym "RES-"))
 325         (outstr (gensym "STR-"))
 326         (stream (gensym "STRM-"))
 327         (hdr (gensym "HDR-")))
 328     `(let ((,fmt ,format)
 329            (,precomp ,precompute)
 330            ,result ,outstr ,stream)
 331        (declare (ignorable ,stream))
 332        (write-header-line "Status" "200 OK")
 333        (write-header-line "Content-Type" (ml::format-string ,fmt))
 334        (dolist (,hdr ,headers)
 335          (write-header-line (car ,hdr) (cdr ,hdr)))
 336        (unless ,precomp
 337          (write-string "end" *wol-stream*)
 338          (write-char #\NewLine *wol-stream*))
 339        (setq ,outstr
 340          (with-output-to-string (,stream)
 341            (let ((*html-stream* (if ,precomp
 342                                    ,stream
 343                                    *wol-stream*))
 344                  (*wol-stream* (if ,precomp
 345                                    ,stream
 346                                    *wol-stream*)))
 347              (setq ,result (progn ,@body)))))
 348        (cond
 349         (,precomp
 350          (write-header-line "Content-Length"
 351                             (write-to-string (length ,outstr)))
 352          (write-header-line "Keep-Socket" "1")
 353          (write-header-line "Connection" "Keep-Alive")
 354          (write-string "end" *wol-stream*)
 355          (write-char #\NewLine *wol-stream*)
 356          (write-string ,outstr *wol-stream*)
 357          (finish-output *wol-stream*)
 358          (setq *close-modlisp-socket* nil))
 359         (t
 360          (finish-output *wol-stream*)
 361          (setq *close-modlisp-socket* t)))
 362        ,result)))
 363
 364
 365 (defun no-url-handler (req ent)
 366   (with-wol-page (req ent)
 367     (html
 368      (:html
 369       (:head
 370        (:title "404 - NotFound"))
 371       (:body
 372        (:h1 "Not Found")
 373        (:p "The request for "
 374            (:b (:write-string (render-uri (request-uri req) nil)))
 375            " was not found on this server.")
 376        (:hr)
 377        (:div (:i "WOL "
 378                  (:write-string (wol-version-string)))))))))