1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
;
; CLISP FastCGI interface
;
; Copyright (C) 2003 Alma Mater Software, Inc., Tarrytown, NY, USA
;
; This program is free software; you can redistribute it and/or modify
; it under the terms of the GNU General Public License version 2 as
; published by the Free Software Foundation; see file GNU-GPL.
;
; This program is distributed in the hope that it will be useful,
; but WITHOUT ANY WARRANTY; without even the implied warranty of
; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
; GNU General Public License for more details.
;
; You should have received a copy of the GNU General Public License
; along with this program; if not, write to the Free Software Foundation,
; Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
;
; $Id: fastcgi.lisp,v 1.18 2008/11/12 04:54:48 sds Exp $
(defpackage "FASTCGI"
(:documentation "Minimal bindings for FastCGI use from CLISP")
(:use "CL" "FFI")
(:export "GETENV"
"SLURP-STDIN" "OUT" "WRITE-STDOUT" "WRITE-STDERR" "NL"
"IS-CGI" "ACCEPT" "FINISH" "WITH-LISTENER")
)
(in-package "FASTCGI")
(pushnew :fastcgi *features*)
(provide "fastcgi")
(setf (documentation (find-package "FASTCGI") 'sys::impnotes) "fastcgi")
(FFI:default-foreign-language :STDC)
; Global: is request active?
(defvar *fastcgi-request-active* nil)
; ----------- Exported functions
; IS-CGI
(defun is-cgi ()
"Return T iff this is an old-fashioned CGI request rather than FastCGI mode."
(fcgi_is_cgi_wrapper))
; ACCEPT
(defun accept ()
"Place at the top of an explicit FastCGI server loop. Returns T iff there is a request to do, otherwise consider exiting the application."
(setf *fastcgi-request-active* t)
(= 0 (fcgi_accept_wrapper)))
; FINISH
(defun finish ()
"Place at the bottom of an explicit FastCGI server loop. Always returns NIL."
(check-active-request 'finish)
(setf *fastcgi-request-active* nil)
(fcgi_finish_wrapper)
nil)
; GETENV
(defun getenv (&optional var)
"(FASTCGI:GETENV var) - Gets the value of an environment variable, which should be a string; if called with no argument, returns the entire environment as an alist"
(if var (fcgi_getenv (to-string var)) (env)))
; ENV -- Return entire environment as an alist
(defun env ()
"ENV - Returns the entire set of environment variables as an alist"
(do* ((kv (fcgi_env))
(result nil)
(i (- (length kv) 2) (- i 2)))
((< i 0) result)
(push (cons (aref kv i) (aref kv (1+ i))) result)))
; WRITE-STDOUT
(defun write-stdout (data)
"(FASTCGI:WRITE-STDOUT string) - Write a string to standard output"
;; Do it in chunks since there seems to be FFI problems with large buffers
(do* ((chunksize 65536)
(s (to-string data))
(totlen (length s)))
((= 0 (length s)) totlen)
(let ((to-write (min (length s) chunksize)))
(fcgi_write_stdout (subseq s 0 to-write) to-write)
(setf s (subseq s to-write)))))
; WRITE-STDERR
(defun write-stderr (data)
"(FASTCGI:WRITE-STDERR string) - Write a string to standard error"
(let ((s (to-string data)))
(fcgi_write_stderr s (length s))))
; SLURP-STDIN
(defun slurp-stdin ()
"(FASTCGI:SLURP-STDIN) Reads in the entirety of standard input and returns as a string"
(check-active-request 'slurp-stdin)
(do ((result "")
(eof nil))
(eof result)
(let ((buf (byte-array-to-string (hex-to-byte-array (fcgi_read_stdin)))))
(if (= 0 (length buf))
(setf eof t)
(setf result (ext:string-concat result buf))))))
; Output functions
; OUT
(defun out (&rest args)
"(FASTCGI:OUT args ...) Write arguments to standard output"
(write-stdout (cat args)))
; NL
; Return newline
(defun nl () "Return a newline" #\Newline)
; ---------------- Internal functions
;; HEX-VALUE -- Get integer value of single hex digit
(defun hex-value (h)
(or (digit-char-p h 16)
(error "~S: Invalid hex digit ~S" 'hex-value h)))
;; HEX-BYTE-VALUE -- Get byte value of pair of hex digits
(defun hex-byte-value (h1 h2)
(+ (ash (hex-value h1) 4)
(hex-value h2)))
;; HEX-TO-BYTE-ARRAY -- Convert hex string to byte array
(defun hex-to-byte-array (h)
(let* ((len (length h))
(size (if (oddp len)
(error "~S: odd hex string length: ~:D"
'hex-to-byte-array len)
(ash len -1)))
(result (make-array size :element-type '(unsigned-byte 8))))
(loop :for string-pos :from 0 :below len :by 2
:and vector-pos :from 0 :below size :do
(setf (aref result vector-pos)
(hex-byte-value (char h string-pos) (char h (1+ string-pos)))))
result))
;; BYTE-ARRAY-TO-STRING -- Convert byte array to string
(defun byte-array-to-string (b) (map 'string #'code-char b))
; CAT
; Concatenate strings
(defun cat (&rest args)
(apply #'ext:string-concat (mapcar #'to-string (flatten args))))
; FLATTEN
; Flatten list (lifted from Paul Graham)
(defun flatten (x)
(labels ((rec (x acc)
(cond ((null x) acc)
((atom x) (cons x acc))
(t (rec (car x) (rec (cdr x) acc))))))
(rec x nil)))
; TO-STRING
; Convert object to a string; NIL -> ""
(defun to-string (s)
(cond ((null s) "")
((stringp s) s)
((symbolp s) (symbol-name s))
(t (princ-to-string s))))
; CHECK-ACTIVE-REQUEST - Sanity check on use of library function
(defun check-active-request (func)
(when (not *fastcgi-request-active*)
(error "Need to call FASTCGI:ACCEPT before using ~S" func)))
;; -------------- "C" functions
(eval-when (compile)
;;NB this global affects further compilations in this session
(setq ffi:*output-c-functions* t))
; Our wrappers
(def-call-out fcgi_getenv (:arguments (var c-string)) (:return-type c-string))
(def-call-out fcgi_env (:arguments) (:return-type (c-array-ptr c-string) :malloc-free))
(def-call-out fcgi_read_stdin (:arguments) (:return-type c-string))
(def-call-out fcgi_write_stdout (:arguments (data c-string) (length int)) (:return-type int))
(def-call-out fcgi_write_stderr (:arguments (data c-string) (length int)) (:return-type int))
; Direct passthroughs to FCGI library
(def-call-out fcgi_accept_wrapper (:arguments) (:return-type int))
(def-call-out fcgi_finish_wrapper (:arguments) (:return-type nil))
(def-call-out fcgi_is_cgi_wrapper (:arguments) (:return-type boolean))
; End of fastcgi.lisp
|
