source: project/release/4/spiffy/trunk/spiffy.scm @ 12529

Last change on this file since 12529 was 12529, checked in by sjamaan, 12 years ago

Change the way server-software is interpreted; make it a "product" value (like in user-agent and server headers) instead

File size: 15.3 KB
Line 
1;;
2;; Spiffy the web server
3;;
4; Copyright (c) 2007-2008, Peter Bex
5; Copyright (c) 2000-2005, Felix L. Winkelmann
6; All rights reserved.
7;
8; Redistribution and use in source and binary forms, with or without
9; modification, are permitted provided that the following conditions
10; are met:
11;
12; 1. Redistributions of source code must retain the above copyright
13;    notice, this list of conditions and the following disclaimer.
14; 2. Redistributions in binary form must reproduce the above copyright
15;    notice, this list of conditions and the following disclaimer in the
16;    documentation and/or other materials provided with the distribution.
17; 3. Neither the name of the author nor the names of its
18;    contributors may be used to endorse or promote products derived
19;    from this software without specific prior written permission.
20;
21; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24; FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25; COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
26; INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
27; (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28; SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29; HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
30; STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31; ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
32; OF THE POSSIBILITY OF SUCH DAMAGE.
33;
34; Please report bugs, suggestions and ideas to the Chicken Trac
35; ticket tracking system (assign tickets to user 'sjamaan'):
36; http://trac.callcc.org
37
38(module spiffy
39  (start-server with-headers send-status send-static-file log-to
40   write-logged-response
41   current-request remote-address local-address
42   current-response current-file current-pathinfo
43   server-software root-path server-port index-files mime-type-map
44   default-mime-type file-extension-handlers default-host vhost-map
45   access-log error-log debug-log
46   handle-directory handle-not-found handle-exception handle-access-logging
47   restart-request htmlize)
48
49(import chicken scheme extras ports files data-structures)
50(require-extension srfi-1 srfi-18 posix tcp regex
51                   intarweb uri-generic sendfile matchable)
52
53(define version 4)
54(define release 0)
55
56;;; Request processing information
57(define current-request  (make-parameter #f))
58(define current-response (make-parameter #f))
59(define current-file     (make-parameter #f))
60(define current-pathinfo (make-parameter #f))
61(define local-address    (make-parameter #f))
62(define remote-address   (make-parameter #f))
63
64;;; Configuration
65(define server-software  (make-parameter `(("Spiffy"
66                                            ,(conc version "." release)
67                                            ,(conc "Running on Chicken "
68                                                   (chicken-version))))))
69(define root-path        (make-parameter "./web"))
70(define server-port      (make-parameter 8080))
71(define index-files      (make-parameter '("index.html" "index.xhtml")))
72(define mime-type-map
73  (make-parameter
74   '(("xml" . text/xml)
75     ("html" . text/html)
76     ("xhtml" . text/xhtml+xml)
77     ("js"  . text/javascript)
78     ("pdf" . application/pdf)
79     ("css" . text/css)
80     ("png" . image/png)
81     ("ico" . image/x-icon)
82     ("gif" . image/gif)
83     ("jpeg" . image/jpeg)
84     ("jpg" . image/jpeg)
85     ("svg" . image/svg+xml)
86     ("bmp" . image/bmp)
87     ("txt" . text/plain))))
88(define default-mime-type (make-parameter 'application/octet-stream))
89(define file-extension-handlers (make-parameter '()))
90(define default-host (make-parameter "localhost")) ;; XXX Can we do without?
91(define vhost-map (make-parameter `((".*" . ,(lambda (continue) (continue))))))
92(define access-log (make-parameter #f))
93(define error-log (make-parameter (current-error-port)))
94(define debug-log (make-parameter #f))
95
96;;; Custom handlers
97(define handle-directory
98  (make-parameter
99   (lambda (path)
100     (send-status 403 "Forbidden"))))
101(define handle-file
102  (make-parameter
103   (lambda (path)
104     (let* ((ext (pathname-extension path))
105            (handler (alist-ref ext (file-extension-handlers)
106                                string-ci=? send-static-file)))
107       (handler path)))))
108(define handle-not-found
109  (make-parameter
110   (lambda (path)
111     (send-status 404 "Not found"
112                  "<p>The resource you requested could not be found</p>"))))
113(define handle-exception
114  (make-parameter
115   (lambda (exn chain)
116     (send-status 500 "Internal server error" (build-error-message exn chain)))))
117
118;; This is very powerful, but it also means people need to write quite
119;; a bit of code to change the line slightly. In this respect Apache-style
120;; log format strings could be better...
121(define handle-access-logging
122  (make-parameter
123   (lambda ()
124     (log-to (access-log)
125             "~A [~A] \"~A ~A HTTP/~A.~A\" ~A"
126             (remote-address)
127             (seconds->string (current-seconds))
128             (request-method (current-request))
129             (uri->string (request-uri (current-request)))
130             (request-major (current-request))
131             (request-minor (current-request))
132             (let ((product (header-contents 'user-agent
133                                             (request-headers (current-request)))))
134               (if product
135                   (product-unparser 'user-agent product)
136                   "**Unknown product**"))))))
137
138;;;; End of configuration parameters
139
140(define (with-output-to-log log thunk)
141  (when log
142    (if (output-port? log)
143        (with-output-to-port log thunk)
144        (with-output-to-file log thunk append:))))
145
146(define (log-to log fmt . rest)
147  (with-output-to-log log
148    (lambda ()
149      (apply printf fmt rest)
150      (newline))))
151
152(define build-error-message
153  (let* ((cpa condition-property-accessor)
154         (exn-message (cpa 'exn 'message "(no message)"))
155         (exn-location (cpa 'exn 'location "(unknown location)"))
156         (exn-arguments (cpa 'exn 'arguments '()))
157         (exn? (condition-predicate 'exn)))
158    (lambda (exn chain)
159      (with-output-to-string
160        (lambda ()
161          (if (exn? exn)
162              (begin
163                (display "<h2>Error:")
164                (and-let* ((loc (exn-location exn)))
165                  (printf " (<em>~A</em>)" (htmlize (->string loc))))
166                (printf "</h2>\n<h3>~A</h3>\n" (htmlize (exn-message exn)))
167                (unless (null? (exn-arguments exn))
168                        (printf "<ul>")
169                        (for-each
170                         (lambda (a)
171                           (##sys#with-print-length-limit 120 (lambda () (printf "<li>~S</li>" (htmlize (->string a))))))
172                         (exn-arguments exn))
173                        (printf "</ul>"))
174                (printf "<pre>~a</pre>" (htmlize chain)))
175              (begin
176                (##sys#with-print-length-limit
177                 120
178                 (lambda ()
179                   (printf "<h2>Uncaught exception:</h2>\n~S" exn))))))))))
180
181(define (extension->mime-type ext)
182  (alist-ref (or ext "") (mime-type-map) string-ci=? (default-mime-type)))
183
184(define (write-logged-response)
185  ((handle-access-logging))
186  (write-response (current-response)))
187
188;; A simple utility procedure to render a status code with message
189(define (send-status code reason #!optional text)
190  (parameterize ((current-response
191                  (update-response (current-response)
192                                   code: code
193                                   reason: reason
194                                   headers:
195                                   (headers
196                                    `((content-type text/html))
197                                    (response-headers (current-response))))))
198    (write-logged-response)
199    (with-output-to-port (response-port (current-response))
200      (lambda ()
201        (print "<?xml version=\"1.0\" encoding=\"iso-8859-1\" ?>")
202        (print "<!DOCTYPE html")
203        (print "  PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"")
204        (print "         \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">")
205        (print "<html xmlns=\"http://www.w3.org/1999/xhtml\" ")
206        (print "      xml:lang=\"en\" lang=\"en\">")
207        (print "  <head>")
208        (printf "    <title>~A - ~A</title>\n" code reason)
209        (print "  </head>")
210        (print "  <body>")
211        (printf "    <h1>~A - ~A</h1>\n" code reason)
212        (if text (display text))
213        (print "  </body>")
214        (print "</html>")))))
215
216(define (send-static-file filename)
217  (let ((path (make-pathname (root-path) filename)))
218    (with-headers `((content-length ,(file-size path))
219                    (content-type ,(extension->mime-type (pathname-extension filename))))
220      (lambda ()
221        (write-logged-response)
222        (let ((fd (file-open path (+ open/binary open/rdonly))))
223          (handle-exceptions exn (begin
224                                   (file-close fd)
225                                   (signal exn))
226                             (sendfile fd (response-port (current-response))))
227          (file-close fd))))))
228
229(define (with-headers new-headers thunk)
230  (parameterize ((current-response
231                  (update-response
232                   (current-response)
233                   headers: (headers new-headers
234                                     (response-headers (current-response))))))
235    (thunk)))
236
237(define (process-directory path)
238  (let ((index-page (find (lambda (ip)
239                            (file-exists?
240                             (make-pathname (list (root-path) path) ip)))
241                          (index-files))))
242    (if index-page
243        (process-entry (make-pathname path index-page) '())
244        ((handle-directory) (make-pathname "/" path)))))
245
246;; If an URL is missing a trailing slash, instead of directly serving
247;; its index-file, redirect to the URL _with_ trailing slash.  This
248;; prevents problems with relative references since the directory
249;; would be seen as the file component in the path and get replaced.
250(define (redirect-directory-root path)
251  (let* ((newloc (make-pathname path "/"))
252         (url (uri-relative-to (uri-reference newloc)
253                               (request-uri (current-request)))))
254    (with-headers `((location ,url))
255      (lambda () (send-status 301 "Moved permanently")))))
256
257(define (process-entry current-path remaining-path)
258  (let ((path (make-pathname (root-path) current-path)))
259    (cond
260     ;; TODO Check if there's a registered URI-handler first
261     ((directory? path)
262      (match remaining-path
263       (()    (redirect-directory-root (make-pathname "/" current-path)))
264       (("/") (process-directory current-path))
265       (else  (process-entry (make-pathname current-path (car remaining-path))
266                             (cdr remaining-path)))))
267     ((file-exists? path)
268      (parameterize ((current-pathinfo remaining-path)
269                     (current-file (make-pathname "/" current-path)))
270        ((handle-file) (current-file)))) ;; hmm, not too useful
271     (else ((handle-not-found) (list "/" current-path))))))
272
273;; Determine the vhost and port to use. This follows RFC 2616, section 5.2:
274;; If request URL is absolute, use that.  Otherwise, look at the Host header.
275;; In HTTP >= 1.1, a Host line is required, as per section 14.23 of
276;; RFC 2616.  If no host line is present, it returns the default host
277;; for HTTP/1.0.
278(define (determine-vhost/port)
279  (let* ((request-uri (request-uri (current-request)))
280         (request-host (uri-host request-uri))
281         (host-header (header-value 'host (request-headers (current-request)))))
282    (if request-host
283        (values request-host (or (uri-port request-uri) 80))
284        (if host-header
285            (values (car host-header) (cdr host-header))
286            (if (and (= (request-major (current-request)) 1)
287                     (>= (request-minor (current-request)) 1))
288                (values #f #f)
289                (values (default-host) 80))))))
290
291(define (normalize-current-request-uri)
292  (receive (host port) (determine-vhost/port)
293    (if host
294        (update-request (current-request)
295                        uri: (uri-relative-to
296                              (request-uri (current-request))
297                              ;; XXX
298                              (absolute-uri (conc "http://" host ":" port))))
299        (current-request))))
300
301(define request-restarter (make-parameter #f)) ; Internal parameter
302
303(define (restart-request req)
304  ((request-restarter) req (request-restarter)))
305
306(define (handle-incoming-request in out)
307  (receive (local remote)
308    (tcp-addresses in)
309    (parameterize ((remote-address remote)
310                   (local-address local)
311                   (current-request (read-request in))
312                   (current-response
313                    (make-response port: out
314                                   headers: (headers
315                                             `((content-type text/html)
316                                               (server ,(server-software)))))))
317      (let ((path (uri-path (request-uri (current-request)))))
318        (receive (req cont)
319          (call/cc (lambda (c) (values (normalize-current-request-uri) c)))
320          (parameterize ((current-request req)
321                         (request-restarter cont))
322            (handle-exceptions exn ((handle-exception) exn
323                                    (with-output-to-string print-call-chain))
324                               (if (and (uri-host (request-uri (current-request))) (pair? path))
325                                   (let* ((host (uri-host (request-uri (current-request))))
326                                          (handler (alist-ref host
327                                                              (vhost-map)
328                                                              (lambda (h _)
329                                                                (if (not (regexp? h))
330                                                                    (string-match (regexp h #t) host)
331                                                                    (string-match h host))))))
332                                     (if handler
333                                         (handler (lambda () (process-entry "" path)))
334                                         ;; Is this ok?
335                                         (send-status 404 "Not found" "<p>Host not found</p>")))
336                                   ;; No host in the request? That's an error.
337                                   (send-status 400 "Bad request"
338                                                "<p>Your client sent a request that the server did not understand</p>")))))
339        ;; For now, just close the ports and allow the thread to exit
340        (close-output-port out)
341        (close-input-port in)))))
342
343(define (htmlize str)
344  (string-translate* str '(("<" . "&lt;")    (">" . "&gt;")
345                           ("\"" . "&quot;") ("&" . "&amp;"))))
346
347(define (start-server #!key (port (server-port)))
348  (parameterize ((load-verbose #f))
349   (letrec ((listener (tcp-listen port))
350            (accept-loop (lambda ()
351                           (receive (in out)
352                             (tcp-accept listener)
353                             (thread-start!
354                              (make-thread (lambda ()
355                                             (handle-incoming-request in out))))
356                             (accept-loop)))))
357     (accept-loop))))
358
359)
Note: See TracBrowser for help on using the repository browser.