Patch from Edi Weitz to fix parsing of URI like '%25%23'
[puri.git] / src.lisp
1 ;; -*- mode: common-lisp; package: puri -*-
2 ;; Support for URIs
3 ;; For general URI information see RFC2396.
4 ;;
5 ;; copyright (c) 1999-2002 Franz Inc, Berkeley, CA  - All rights reserved.
6 ;; copyright (c) 2002-2005 Franz Inc, Oakland, CA - All rights reserved.
7 ;; copyright (c) 2003-2010 Kevin Rosenberg
8 ;;
9 ;; This code is free software; you can redistribute it and/or
10 ;; modify it under the terms of the version 2.1 of
11 ;; the GNU Lesser General Public License as published by
12 ;; the Free Software Foundation, as clarified by the
13 ;; preamble found here:
14 ;;     http://opensource.franz.com/preamble.html
15 ;;
16 ;; Versions ported from Franz's opensource release
17 ;; uri.cl,v 2.3.6.4.2.1 2001/08/09 17:42:39 layer
18 ;; uri.cl,v 2.9.84.1 2005/08/11 18:38:52 layer
19
20 ;; This code is distributed in the hope that it will be useful,
21 ;; but without any warranty; without even the implied warranty of
22 ;; merchantability or fitness for a particular purpose.  See the GNU
23 ;; Lesser General Public License for more details.
24 ;;
25 ;; $Id$
26
27 (defpackage #:puri
28   (:use #:cl)
29   #-allegro (:nicknames #:net.uri)
30   (:export
31    #:uri                                ; the type and a function
32    #:uri-p
33    #:copy-uri
34
35    #:uri-scheme                         ; and slots
36    #:uri-host #:uri-port
37    #:uri-path
38    #:uri-query
39    #:uri-fragment
40    #:uri-plist
41    #:uri-authority                      ; pseudo-slot accessor
42
43    #:urn                                ; class
44    #:urn-nid                            ; pseudo-slot accessor
45    #:urn-nss                            ; pseudo-slot accessor
46
47    #:*strict-parse*
48    #:parse-uri
49    #:merge-uris
50    #:enough-uri
51    #:uri-parsed-path
52    #:render-uri
53
54    #:make-uri-space                     ; interning...
55    #:uri-space
56    #:uri=
57    #:intern-uri
58    #:unintern-uri
59    #:do-all-uris
60
61    #:uri-parse-error ;; Added by KMR
62    ))
63
64 (in-package #:puri)
65
66 (eval-when (:compile-toplevel) (declaim (optimize (speed 3))))
67
68
69 #-allegro
70 (defun parse-body (forms &optional env)
71   "Parses a body, returns (VALUES docstring declarations forms)"
72   (declare (ignore env))
73   ;; fixme -- need to add parsing of multiple declarations
74   (let (docstring declarations)
75     (when (stringp (car forms))
76       (setq docstring (car forms))
77       (setq forms (cdr forms)))
78     (when (and (listp (car forms))
79                (symbolp (caar forms))
80                (string-equal (symbol-name '#:declare)
81                              (symbol-name (caar forms))))
82       (setq declarations (car forms))
83       (setq forms (cdr forms)))
84     (values docstring declarations forms)))
85
86
87 (defun shrink-vector (str size)
88   #+allegro
89   (excl::.primcall 'sys::shrink-svector str size)
90   #+sbcl
91   (setq str (sb-kernel:shrink-vector str size))
92   #+cmu
93   (lisp::shrink-vector str size)
94   #+lispworks
95   (system::shrink-vector$vector str size)
96   #+scl
97   (common-lisp::shrink-vector str size)
98   #-(or allegro cmu lispworks sbcl scl)
99   (setq str (subseq str 0 size))
100   str)
101
102
103 ;; KMR: Added new condition to handle cross-implementation variances
104 ;; in the parse-error condition many implementations define
105
106 (define-condition uri-parse-error (parse-error)
107   ((fmt-control :initarg :fmt-control :accessor fmt-control)
108    (fmt-arguments :initarg :fmt-arguments :accessor fmt-arguments ))
109   (:report (lambda (c stream)
110              (format stream "Parse error:")
111              (apply #'format stream (fmt-control c) (fmt-arguments c)))))
112
113 (defun .parse-error (fmt &rest args)
114   (error 'uri-parse-error :fmt-control fmt :fmt-arguments args))
115
116 #-allegro
117 (defun internal-reader-error (stream fmt &rest args)
118   (apply #'format stream fmt args))
119
120 #-allegro (defvar *current-case-mode* :case-insensitive-upper)
121 #+allegro (eval-when (:compile-toplevel :load-toplevel :execute)
122             (import '(excl:*current-case-mode*
123                       excl:delimited-string-to-list
124                       excl::parse-body
125                       excl::internal-reader-error
126                       excl:if*)))
127
128 #-allegro
129 (defmethod position-char (char (string string) start max)
130   (declare (optimize (speed 3) (safety 0) (space 0))
131            (fixnum start max) (string string))
132   (do* ((i start (1+ i)))
133        ((= i max) nil)
134     (declare (fixnum i))
135     (when (char= char (char string i)) (return i))))
136
137 #-allegro
138 (defun delimited-string-to-list (string &optional (separator #\space)
139                                         skip-terminal)
140   (declare (optimize (speed 3) (safety 0) (space 0)
141                      (compilation-speed 0))
142            (type string string)
143            (type character separator))
144   (do* ((len (length string))
145         (output '())
146         (pos 0)
147         (end (position-char separator string pos len)
148              (position-char separator string pos len)))
149        ((null end)
150         (if (< pos len)
151             (push (subseq string pos) output)
152           (when (and (plusp len) (not skip-terminal))
153             (push "" output)))
154         (nreverse output))
155     (declare (type fixnum pos len)
156              (type (or null fixnum) end))
157     (push (subseq string pos end) output)
158     (setq pos (1+ end))))
159
160 #-allegro
161 (eval-when (:compile-toplevel :load-toplevel :execute)
162   (defvar if*-keyword-list '("then" "thenret" "else" "elseif"))
163
164   (defmacro if* (&rest args)
165     (do ((xx (reverse args) (cdr xx))
166          (state :init)
167          (elseseen nil)
168          (totalcol nil)
169         (lookat nil nil)
170          (col nil))
171         ((null xx)
172          (cond ((eq state :compl)
173                 `(cond ,@totalcol))
174                (t (error "if*: illegal form ~s" args))))
175       (cond ((and (symbolp (car xx))
176                   (member (symbol-name (car xx))
177                           if*-keyword-list
178                           :test #'string-equal))
179              (setq lookat (symbol-name (car xx)))))
180
181        (cond ((eq state :init)
182               (cond (lookat (cond ((string-equal lookat "thenret")
183                                    (setq col nil
184                                          state :then))
185                                   (t (error
186                                       "if*: bad keyword ~a" lookat))))
187                     (t (setq state :col
188                              col nil)
189                        (push (car xx) col))))
190              ((eq state :col)
191               (cond (lookat
192                      (cond ((string-equal lookat "else")
193                             (cond (elseseen
194                                    (error
195                                     "if*: multiples elses")))
196                             (setq elseseen t)
197                             (setq state :init)
198                             (push `(t ,@col) totalcol))
199                            ((string-equal lookat "then")
200                             (setq state :then))
201                            (t (error "if*: bad keyword ~s"
202                                               lookat))))
203                     (t (push (car xx) col))))
204              ((eq state :then)
205               (cond (lookat
206                      (error
207                       "if*: keyword ~s at the wrong place " (car xx)))
208                     (t (setq state :compl)
209                        (push `(,(car xx) ,@col) totalcol))))
210              ((eq state :compl)
211               (cond ((not (string-equal lookat "elseif"))
212                      (error "if*: missing elseif clause ")))
213               (setq state :init))))))
214
215
216 (defclass uri ()
217   (
218 ;;;; external:
219    (scheme :initarg :scheme :initform nil :accessor uri-scheme)
220    (host :initarg :host :initform nil :accessor uri-host)
221    (port :initarg :port :initform nil :accessor uri-port)
222    (path :initarg :path :initform nil :accessor uri-path)
223    (query :initarg :query :initform nil :accessor uri-query)
224    (fragment :initarg :fragment :initform nil :accessor uri-fragment)
225    (plist :initarg :plist :initform nil :accessor uri-plist)
226
227 ;;;; internal:
228    (escaped
229     ;; used to prevent unnessary work, looking for chars to escape and
230     ;; unescape.
231     :initarg :escaped :initform nil :accessor uri-escaped)
232    (string
233     ;; the cached printable representation of the URI.  It *might* be
234     ;; different than the original string, though, because the user might
235     ;; have escaped non-reserved chars--they won't be escaped when the URI
236     ;; is printed.
237     :initarg :string :initform nil :accessor uri-string)
238    (parsed-path
239     ;; the cached parsed representation of the URI path.
240     :initarg :parsed-path
241     :initform nil
242     :accessor .uri-parsed-path)
243    (hashcode
244     ;; cached sxhash, so we don't have to compute it more than once.
245     :initarg :hashcode :initform nil :accessor uri-hashcode)))
246
247 (defclass urn (uri)
248   ((nid :initarg :nid :initform nil :accessor urn-nid)
249    (nss :initarg :nss :initform nil :accessor urn-nss)))
250
251 (eval-when (:compile-toplevel :execute)
252   (defmacro clear-caching-on-slot-change (name)
253     `(defmethod (setf ,name) :around (new-value (self uri))
254        (declare (ignore new-value))
255        (prog1 (call-next-method)
256          (setf (uri-string self) nil)
257          ,@(when (eq name 'uri-path) `((setf (.uri-parsed-path self) nil)))
258          (setf (uri-hashcode self) nil))))
259   )
260
261 (clear-caching-on-slot-change uri-scheme)
262 (clear-caching-on-slot-change uri-host)
263 (clear-caching-on-slot-change uri-port)
264 (clear-caching-on-slot-change uri-path)
265 (clear-caching-on-slot-change uri-query)
266 (clear-caching-on-slot-change uri-fragment)
267
268
269 (defmethod make-load-form ((self uri) &optional env)
270   (declare (ignore env))
271   `(make-instance ',(class-name (class-of self))
272      :scheme ,(uri-scheme self)
273      :host ,(uri-host self)
274      :port ,(uri-port self)
275      :path ',(uri-path self)
276      :query ,(uri-query self)
277      :fragment ,(uri-fragment self)
278      :plist ',(uri-plist self)
279      :string ,(uri-string self)
280      :parsed-path ',(.uri-parsed-path self)))
281
282 (defmethod uri-p ((thing uri)) t)
283 (defmethod uri-p ((thing t)) nil)
284
285 (defun copy-uri (uri
286                  &key place
287                       (scheme (when uri (uri-scheme uri)))
288                       (host (when uri (uri-host uri)))
289                       (port (when uri (uri-port uri)))
290                       (path (when uri (uri-path uri)))
291                       (parsed-path
292                        (when uri (copy-list (.uri-parsed-path uri))))
293                       (query (when uri (uri-query uri)))
294                       (fragment (when uri (uri-fragment uri)))
295                       (plist (when uri (copy-list (uri-plist uri))))
296                       (class (when uri (class-of uri)))
297                  &aux (escaped (when uri (uri-escaped uri))))
298   (if* place
299      then (setf (uri-scheme place) scheme)
300           (setf (uri-host place) host)
301           (setf (uri-port place) port)
302           (setf (uri-path place) path)
303           (setf (.uri-parsed-path place) parsed-path)
304           (setf (uri-query place) query)
305           (setf (uri-fragment place) fragment)
306           (setf (uri-plist place) plist)
307           (setf (uri-escaped place) escaped)
308           (setf (uri-string place) nil)
309           (setf (uri-hashcode place) nil)
310           place
311    elseif (eq 'uri class)
312      then ;; allow the compiler to optimize the call to make-instance:
313           (make-instance 'uri
314             :scheme scheme :host host :port port :path path
315             :parsed-path parsed-path
316             :query query :fragment fragment :plist plist
317             :escaped escaped :string nil :hashcode nil)
318      else (make-instance class
319             :scheme scheme :host host :port port :path path
320             :parsed-path parsed-path
321             :query query :fragment fragment :plist plist
322             :escaped escaped :string nil :hashcode nil)))
323
324 (defmethod uri-parsed-path ((uri uri))
325   (when (uri-path uri)
326     (when (null (.uri-parsed-path uri))
327       (setf (.uri-parsed-path uri)
328         (parse-path (uri-path uri) (uri-escaped uri))))
329     (.uri-parsed-path uri)))
330
331 (defmethod (setf uri-parsed-path) (path-list (uri uri))
332   (assert (and (consp path-list)
333                (or (member (car path-list) '(:absolute :relative)
334                            :test #'eq))))
335   (setf (uri-path uri) (render-parsed-path path-list t))
336   (setf (.uri-parsed-path uri) path-list)
337   path-list)
338
339 (defun uri-authority (uri)
340   (when (uri-host uri)
341     (let ((*print-pretty* nil))
342       (format nil "~a~@[:~a~]" (uri-host uri) (uri-port uri)))))
343
344 (defun uri-nid (uri)
345   (if* (equalp "urn" (uri-scheme uri))
346      then (uri-host uri)
347      else (error "URI is not a URN: ~s." uri)))
348
349 (defun uri-nss (uri)
350   (if* (equalp "urn" (uri-scheme uri))
351      then (uri-path uri)
352      else (error "URI is not a URN: ~s." uri)))
353
354 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
355 ;; Parsing
356
357 (defparameter *excluded-characters*
358     (append
359      ;; exclude control characters
360      (loop for i from 0 to #x1f
361            collect (code-char i))
362      '(;; `delims' (except #\%, because it's handled specially):
363       #\< #\> #\" #\space #\#
364       #\Rubout ;; (code-char #x7f)
365       ;; `unwise':
366       #\{ #\} #\| #\\ #\^ #\[ #\] #\`))
367   "Excluded charcters from RFC2369 (http://www.ietf.org/rfc/rfc2396.txt 2.4.3)")
368
369 (defun reserved-char-vector (chars &key except)
370   (do* ((a (make-array 128 :element-type 'bit :initial-element 0))
371         (chars chars (cdr chars))
372         (c (car chars) (car chars)))
373       ((null chars) a)
374     (if* (and except (member c except :test #'char=))
375        thenret
376        else (setf (sbit a (char-int c)) 1))))
377
378 (defparameter *reserved-characters*
379     (reserved-char-vector
380      (append *excluded-characters*
381              '(#\; #\/ #\? #\: #\@ #\& #\= #\+ #\$ #\, #\%))))
382 (defparameter *reserved-authority-characters*
383     (reserved-char-vector
384      (append *excluded-characters* '(#\; #\/ #\? #\: #\@))))
385 (defparameter *reserved-path-characters*
386     (reserved-char-vector
387      (append *excluded-characters*
388              '(#\; #\%
389 ;;;;The rfc says this should be here, but it doesn't make sense.
390                ;; #\=
391                #\/ #\?))))
392
393 (defparameter *reserved-fragment-characters*
394     (reserved-char-vector (remove #\# *excluded-characters*)))
395
396 (eval-when (:compile-toplevel :execute)
397 (defun gen-char-range-list (start end)
398   (do* ((res '())
399         (endcode (1+ (char-int end)))
400         (chcode (char-int start)
401                 (1+ chcode))
402         (hyphen nil))
403       ((= chcode endcode)
404        ;; - has to be first, otherwise it signifies a range!
405        (if* hyphen
406           then (setq res (nreverse res))
407                (push #\- res)
408                res
409           else (nreverse res)))
410     (if* (= #.(char-int #\-) chcode)
411        then (setq hyphen t)
412        else (push (code-char chcode) res))))
413 )
414
415 (defparameter *valid-nid-characters*
416     (reserved-char-vector
417      '#.(nconc (gen-char-range-list #\a #\z)
418                (gen-char-range-list #\A #\Z)
419                (gen-char-range-list #\0 #\9)
420                '(#\- #\. #\+))))
421 (defparameter *reserved-nss-characters*
422     (reserved-char-vector
423      (append *excluded-characters* '(#\& #\~ #\/ #\?))))
424
425 (defparameter *illegal-characters*
426     (reserved-char-vector (remove #\# *excluded-characters*)))
427 (defparameter *strict-illegal-query-characters*
428     (reserved-char-vector (append '(#\?) (remove #\# *excluded-characters*))))
429 (defparameter *illegal-query-characters*
430     (reserved-char-vector
431      *excluded-characters* :except '(#\^ #\| #\#)))
432
433
434 (defun parse-uri (thing &key (class 'uri) &aux escape)
435   (when (uri-p thing) (return-from parse-uri thing))
436
437   (setq escape (escape-p thing))
438   (multiple-value-bind (scheme host port path query fragment)
439       (parse-uri-string thing)
440     (when scheme
441       (setq scheme
442         (intern (funcall
443                  (case *current-case-mode*
444                    ((:case-insensitive-upper :case-sensitive-upper)
445                     #'string-upcase)
446                    ((:case-insensitive-lower :case-sensitive-lower)
447                     #'string-downcase))
448                  (decode-escaped-encoding scheme escape))
449                 (find-package :keyword))))
450
451     (when (and scheme (eq :urn scheme))
452       (return-from parse-uri
453         (make-instance 'urn :scheme scheme :nid host :nss path)))
454
455     (when host (setq host (decode-escaped-encoding host escape)))
456     (when port
457       (setq port (read-from-string port))
458       (when (not (numberp port)) (error "port is not a number: ~s." port))
459       (when (not (plusp port))
460         (error "port is not a positive integer: ~d." port))
461       (when (eql port (case scheme
462                       (:http 80)
463                       (:https 443)
464                       (:ftp 21)
465                       (:telnet 23)))
466         (setq port nil)))
467     (when (or (string= "" path)
468               (and ;; we canonicalize away a reference to just /:
469                scheme
470                (member scheme '(:http :https :ftp) :test #'eq)
471                (string= "/" path)))
472       (setq path nil))
473     (when path
474       (setq path
475         (decode-escaped-encoding path escape *reserved-path-characters*)))
476     (when query (setq query (decode-escaped-encoding query escape)))
477     (when fragment
478       (setq fragment
479         (decode-escaped-encoding fragment escape
480                                  *reserved-fragment-characters*)))
481     (if* (eq 'uri class)
482        then ;; allow the compiler to optimize the make-instance call:
483             (make-instance 'uri
484               :scheme scheme
485               :host host
486               :port port
487               :path path
488               :query query
489               :fragment fragment
490               :escaped escape)
491        else ;; do it the slow way:
492             (make-instance class
493               :scheme scheme
494               :host host
495               :port port
496               :path path
497               :query query
498               :fragment fragment
499               :escaped escape))))
500
501 (defmethod uri ((thing uri))
502   thing)
503
504 (defmethod uri ((thing string))
505   (parse-uri thing))
506
507 (defmethod uri ((thing t))
508   (error "Cannot coerce ~s to a uri." thing))
509
510 (defvar *strict-parse* t)
511
512 (defun parse-uri-string (string &aux (illegal-chars *illegal-characters*))
513   (declare (optimize (speed 3)))
514   ;; Speed is important, so use a specialized state machine instead of
515   ;; regular expressions for parsing the URI string. The regexp we are
516   ;; simulating:
517   ;;  ^(([^:/?#]+):)?
518   ;;   (//([^/?#]*))?
519   ;;   ([^?#]*)
520   ;;   (\?([^#]*))?
521   ;;   (#(.*))?
522   (let* ((state 0)
523          (start 0)
524          (end (length string))
525          (tokval nil)
526          (scheme nil)
527          (host nil)
528          (port nil)
529          (path-components '())
530          (query nil)
531          (fragment nil)
532          ;; namespace identifier, for urn parsing only:
533          (nid nil))
534     (declare (fixnum state start end))
535     (flet ((read-token (kind &optional legal-chars)
536              (setq tokval nil)
537              (if* (>= start end)
538                 then :end
539                 else (let ((sindex start)
540                            (res nil)
541                            c)
542                        (declare (fixnum sindex))
543                        (setq res
544                          (loop
545                            (when (>= start end) (return nil))
546                            (setq c (char string start))
547                            (let ((ci (char-int c)))
548                              (if* legal-chars
549                                 then (if* (and (eq :colon kind) (eq c #\:))
550                                         then (return :colon)
551                                       elseif (= 0 (sbit legal-chars ci))
552                                         then (.parse-error
553                                               "~
554 URI ~s contains illegal character ~s at position ~d."
555                                               string c start))
556                               elseif (and (< ci 128)
557                                           *strict-parse*
558                                           (= 1 (sbit illegal-chars ci)))
559                                 then (.parse-error "~
560 URI ~s contains illegal character ~s at position ~d."
561                                                          string c start)))
562                            (case kind
563                              (:path (case c
564                                       (#\? (return :question))
565                                       (#\# (return :hash))))
566                              (:query (case c (#\# (return :hash))))
567                              (:rest)
568                              (t (case c
569                                   (#\: (return :colon))
570                                   (#\? (return :question))
571                                   (#\# (return :hash))
572                                   (#\/ (return :slash)))))
573                            (incf start)))
574                        (if* (> start sindex)
575                           then ;; we found some chars
576                                ;; before we stopped the parse
577                                (setq tokval (subseq string sindex start))
578                                :string
579                           else ;; immediately stopped at a special char
580                                (incf start)
581                                res))))
582            (failure (&optional why)
583              (.parse-error "illegal URI: ~s [~d]~@[: ~a~]"
584                                  string state why))
585            (impossible ()
586              (.parse-error "impossible state: ~d [~s]" state string)))
587       (loop
588         (case state
589           (0 ;; starting to parse
590            (ecase (read-token t)
591              (:colon (failure))
592              (:question (setq state 7))
593              (:hash (setq state 8))
594              (:slash (setq state 3))
595              (:string (setq state 1))
596              (:end (setq state 9))))
597           (1 ;; seen <token><special char>
598            (let ((token tokval))
599              (ecase (read-token t)
600                (:colon (setq scheme token)
601                        (if* (equalp "urn" scheme)
602                           then (setq state 15)
603                           else (setq state 2)))
604                (:question (push token path-components)
605                           (setq state 7))
606                (:hash (push token path-components)
607                       (setq state 8))
608                (:slash (push token path-components)
609                        (push "/" path-components)
610                        (setq state 6))
611                (:string (failure))
612                (:end (push token path-components)
613                      (setq state 9)))))
614           (2 ;; seen <scheme>:
615            (ecase (read-token t)
616              (:colon (failure))
617              (:question (setq state 7))
618              (:hash (setq state 8))
619              (:slash (setq state 3))
620              (:string (setq state 10))
621              (:end (setq state 9))))
622           (10 ;; seen <scheme>:<token>
623            (let ((token tokval))
624              (ecase (read-token t)
625                (:colon (failure))
626                (:question (push token path-components)
627                           (setq state 7))
628                (:hash (push token path-components)
629                       (setq state 8))
630                (:slash (push token path-components)
631                        (setq state 6))
632                (:string (failure))
633                (:end (push token path-components)
634                      (setq state 9)))))
635           (3 ;; seen / or <scheme>:/
636            (ecase (read-token t)
637              (:colon (failure))
638              (:question (push "/" path-components)
639                         (setq state 7))
640              (:hash (push "/" path-components)
641                     (setq state 8))
642              (:slash (setq state 4))
643              (:string (push "/" path-components)
644                       (push tokval path-components)
645                       (setq state 6))
646              (:end (push "/" path-components)
647                    (setq state 9))))
648           (4 ;; seen [<scheme>:]//
649            (ecase (read-token t)
650              (:colon (failure))
651              (:question (failure))
652              (:hash (failure))
653              (:slash
654               (if* (and (equalp "file" scheme)
655                         (null host))
656                  then ;; file:///...
657                       (push "/" path-components)
658                       (setq state 6)
659                  else (failure)))
660              (:string (setq host tokval)
661                       (setq state 11))
662              (:end (failure))))
663           (11 ;; seen [<scheme>:]//<host>
664            (ecase (read-token t)
665              (:colon (setq state 5))
666              (:question (setq state 7))
667              (:hash (setq state 8))
668              (:slash (push "/" path-components)
669                      (setq state 6))
670              (:string (impossible))
671              (:end (setq state 9))))
672           (5 ;; seen [<scheme>:]//<host>:
673            (ecase (read-token t)
674              (:colon (failure))
675              (:question (failure))
676              (:hash (failure))
677              (:slash (push "/" path-components)
678                      (setq state 6))
679              (:string (setq port tokval)
680                       (setq state 12))
681              (:end (failure))))
682           (12 ;; seen [<scheme>:]//<host>:[<port>]
683            (ecase (read-token t)
684              (:colon (failure))
685              (:question (setq state 7))
686              (:hash (setq state 8))
687              (:slash (push "/" path-components)
688                      (setq state 6))
689              (:string (impossible))
690              (:end (setq state 9))))
691           (6 ;; seen /
692            (ecase (read-token :path)
693              (:question (setq state 7))
694              (:hash (setq state 8))
695              (:string (push tokval path-components)
696                       (setq state 13))
697              (:end (setq state 9))))
698           (13 ;; seen path
699            (ecase (read-token :path)
700              (:question (setq state 7))
701              (:hash (setq state 8))
702              (:string (impossible))
703              (:end (setq state 9))))
704           (7 ;; seen ?
705            (setq illegal-chars
706              (if* *strict-parse*
707                 then *strict-illegal-query-characters*
708                 else *illegal-query-characters*))
709            (ecase (prog1 (read-token :query)
710                     (setq illegal-chars *illegal-characters*))
711              (:hash (setq state 8))
712              (:string (setq query tokval)
713                       (setq state 14))
714              (:end (setq state 9))))
715           (14 ;; query
716            (ecase (read-token :query)
717              (:hash (setq state 8))
718              (:string (impossible))
719              (:end (setq state 9))))
720           (8 ;; seen #
721            (ecase (read-token :rest)
722              (:string (setq fragment tokval)
723                       (setq state 9))
724              (:end (setq state 9))))
725           (9 ;; done
726            (return
727              (values
728               scheme host port
729               (apply #'concatenate 'string (nreverse path-components))
730               query fragment)))
731           ;; URN parsing:
732           (15 ;; seen urn:, read nid now
733            (case (read-token :colon *valid-nid-characters*)
734              (:string (setq nid tokval)
735                       (setq state 16))
736              (t (failure "missing namespace identifier"))))
737           (16 ;; seen urn:<nid>
738            (case (read-token t)
739              (:colon (setq state 17))
740              (t (failure "missing namespace specific string"))))
741           (17 ;; seen urn:<nid>:, rest is nss
742            (return (values scheme
743                            nid
744                            nil
745                            (progn
746                              (setq illegal-chars *reserved-nss-characters*)
747                              (read-token :rest)
748                              tokval))))
749           (t (.parse-error
750               "internal error in parse engine, wrong state: ~s." state)))))))
751
752 (defun escape-p (string)
753   (declare (optimize (speed 3)))
754   (do* ((i 0 (1+ i))
755         (max (the fixnum (length string))))
756       ((= i max) nil)
757     (declare (fixnum i max))
758     (when (char= #\% (char string i))
759       (return t))))
760
761 (defun parse-path (path-string escape)
762   (do* ((xpath-list (delimited-string-to-list path-string #\/))
763         (path-list
764          (progn
765            (if* (string= "" (car xpath-list))
766               then (setf (car xpath-list) :absolute)
767               else (push :relative xpath-list))
768            xpath-list))
769         (pl (cdr path-list) (cdr pl))
770         segments)
771       ((null pl) path-list)
772
773     (if* (cdr (setq segments
774                 (if* (string= "" (car pl))
775                    then '("")
776                    else (delimited-string-to-list (car pl) #\;))))
777        then ;; there is a param
778             (setf (car pl)
779               (mapcar #'(lambda (s)
780                           (decode-escaped-encoding s escape
781                                                    ;; decode all %xx:
782                                                    nil))
783                       segments))
784        else ;; no param
785             (setf (car pl)
786               (decode-escaped-encoding (car segments) escape
787                                        ;; decode all %xx:
788                                        nil)))))
789
790 (defun decode-escaped-encoding (string escape
791                                 &optional (reserved-chars
792                                            *reserved-characters*))
793   ;; Return a string with the real characters.
794   (when (null escape) (return-from decode-escaped-encoding string))
795   (do* ((i 0 (1+ i))
796         (max (length string))
797         (new-string (copy-seq string))
798         (new-i 0 (1+ new-i))
799         ch ch2 chc chc2)
800       ((= i max)
801        (shrink-vector new-string new-i))
802     (if* (char= #\% (setq ch (char string i)))
803        then (when (> (+ i 3) max)
804               (.parse-error
805                "Unsyntactic escaped encoding in ~s." string))
806             (setq ch (char string (incf i)))
807             (setq ch2 (char string (incf i)))
808             (when (not (and (setq chc (digit-char-p ch 16))
809                             (setq chc2 (digit-char-p ch2 16))))
810               (.parse-error
811                "Non-hexidecimal digits after %: %c%c." ch ch2))
812             (let ((ci (+ (* 16 chc) chc2)))
813               (if* (or (null reserved-chars)
814                        (> ci 127)       ; bug11527
815                        (= 0 (sbit reserved-chars ci)))
816                  then ;; ok as is
817                       (setf (char new-string new-i)
818                         (code-char ci))
819                  else (setf (char new-string new-i) #\%)
820                       (setf (char new-string (incf new-i)) ch)
821                       (setf (char new-string (incf new-i)) ch2)))
822        else (setf (char new-string new-i) ch))))
823
824 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
825 ;;;; Printing
826
827 (defun render-uri (uri stream
828                    &aux (escape (uri-escaped uri))
829                         (*print-pretty* nil))
830   (when (null (uri-string uri))
831     (setf (uri-string uri)
832       (let ((scheme (uri-scheme uri))
833             (host (uri-host uri))
834             (port (uri-port uri))
835             (path (uri-path uri))
836             (query (uri-query uri))
837             (fragment (uri-fragment uri)))
838         (concatenate 'string
839           (when scheme
840             (encode-escaped-encoding
841              (string-downcase ;; for upper case lisps
842               (symbol-name scheme))
843              *reserved-characters* escape))
844           (when scheme ":")
845           (when (or host (eq :file scheme)) "//")
846           (when host
847             (encode-escaped-encoding
848              host *reserved-authority-characters* escape))
849           (when port ":")
850           (when port
851             #-allegro (format nil "~D" port)
852             #+allegro (with-output-to-string (s)
853                         (excl::maybe-print-fast s port))
854             )
855           (encode-escaped-encoding (or path "/")
856                                    nil
857                                    ;;*reserved-path-characters*
858                                    escape)
859           (when query "?")
860           (when query (encode-escaped-encoding query nil escape))
861           (when fragment "#")
862           (when fragment (encode-escaped-encoding fragment nil escape))))))
863   (if* stream
864      then (format stream "~a" (uri-string uri))
865      else (uri-string uri)))
866
867 (defun render-parsed-path (path-list escape)
868   (do* ((res '())
869         (first (car path-list))
870         (pl (cdr path-list) (cdr pl))
871         (pe (car pl) (car pl)))
872       ((null pl)
873        (when res (apply #'concatenate 'string (nreverse res))))
874     (when (or (null first)
875               (prog1 (eq :absolute first)
876                 (setq first nil)))
877       (push "/" res))
878     (if* (atom pe)
879        then (push
880              (encode-escaped-encoding pe *reserved-path-characters* escape)
881              res)
882        else ;; contains params
883             (push (encode-escaped-encoding
884                    (car pe) *reserved-path-characters* escape)
885                   res)
886             (dolist (item (cdr pe))
887               (push ";" res)
888               (push (encode-escaped-encoding
889                      item *reserved-path-characters* escape)
890                     res)))))
891
892 (defun render-urn (urn stream
893                    &aux (*print-pretty* nil))
894   (when (null (uri-string urn))
895     (setf (uri-string urn)
896       (let ((nid (urn-nid urn))
897             (nss (urn-nss urn)))
898         (concatenate 'string "urn:" nid ":" nss))))
899   (if* stream
900      then (format stream "~a" (uri-string urn))
901      else (uri-string urn)))
902
903 (defparameter *escaped-encoding*
904     (vector #\0 #\1 #\2 #\3 #\4 #\5 #\6 #\7 #\8 #\9 #\a #\b #\c #\d #\e #\f))
905
906 (defun encode-escaped-encoding (string reserved-chars escape)
907   (when (null escape) (return-from encode-escaped-encoding string))
908   ;; Make a string as big as it possibly needs to be (3 times the original
909   ;; size), and truncate it at the end.
910   (do* ((max (length string))
911         (new-max (* 3 max)) ;; worst case new size
912         (new-string (make-string new-max))
913         (i 0 (1+ i))
914         (new-i -1)
915         c ci)
916       ((= i max)
917        (shrink-vector new-string (incf new-i)))
918     (setq ci (char-int (setq c (char string i))))
919     (if* (or (null reserved-chars)
920              (> ci 127)
921              (= 0 (sbit reserved-chars ci)))
922        then ;; ok as is
923             (incf new-i)
924             (setf (char new-string new-i) c)
925        else ;; need to escape it
926             (multiple-value-bind (q r) (truncate ci 16)
927               (setf (char new-string (incf new-i)) #\%)
928               (setf (char new-string (incf new-i)) (elt *escaped-encoding* q))
929               (setf (char new-string (incf new-i))
930                 (elt *escaped-encoding* r))))))
931
932 (defmethod print-object ((uri uri) stream)
933   (if* *print-escape*
934      then (print-unreadable-object (uri stream :type t) (render-uri uri stream))
935      else (render-uri uri stream)))
936
937 (defmethod print-object ((urn urn) stream)
938   (if* *print-escape*
939      then (print-unreadable-object (urn stream :type t) (render-urn urn stream))
940      else (render-urn urn stream)))
941
942 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
943 ;; merging and unmerging
944
945 (defmethod merge-uris ((uri string) (base string) &optional place)
946   (merge-uris (parse-uri uri) (parse-uri base) place))
947
948 (defmethod merge-uris ((uri uri) (base string) &optional place)
949   (merge-uris uri (parse-uri base) place))
950
951 (defmethod merge-uris ((uri string) (base uri) &optional place)
952   (merge-uris (parse-uri uri) base place))
953
954
955 (defmethod merge-uris ((uri uri) (base uri) &optional place)
956   ;; See ../doc/rfc2396.txt for info on the algorithm we use to merge
957   ;; URIs.
958   ;;
959   (tagbody
960 ;;;; step 2
961     (when (and (null (uri-parsed-path uri))
962                (null (uri-scheme uri))
963                (null (uri-host uri))
964                (null (uri-port uri))
965                (null (uri-query uri)))
966       (return-from merge-uris
967         (let ((new (copy-uri base :place place)))
968           (when (uri-query uri)
969             (setf (uri-query new) (uri-query uri)))
970           (when (uri-fragment uri)
971             (setf (uri-fragment new) (uri-fragment uri)))
972           new)))
973
974     (setq uri (copy-uri uri :place place))
975
976 ;;;; step 3
977     (when (uri-scheme uri)
978       (return-from merge-uris uri))
979     (setf (uri-scheme uri) (uri-scheme base))
980
981 ;;;; step 4
982     (when (uri-host uri) (go :done))
983     (setf (uri-host uri) (uri-host base))
984     (setf (uri-port uri) (uri-port base))
985
986 ;;;; step 5
987     (let ((p (uri-parsed-path uri)))
988
989       ;; bug13133:
990       ;; The following form causes our implementation to be at odds with
991       ;; RFC 2396, however this is apparently what was intended by the
992       ;; authors of the RFC.  Specifically, (merge-uris "?y" "/foo")
993       ;; should return #<uri /foo?y> instead of #<uri ?y>, according to
994       ;; this:
995 ;;; http://www.apache.org/~fielding/uri/rev-2002/issues.html#003-relative-query
996       (when (null p)
997         (setf (uri-path uri) (uri-path base))
998         (go :done))
999
1000       (when (and p (eq :absolute (car p)))
1001         (when (equal '(:absolute "") p)
1002           ;; Canonicalize the way parsing does:
1003           (setf (uri-path uri) nil))
1004         (go :done)))
1005
1006 ;;;; step 6
1007     (let* ((base-path
1008             (or (uri-parsed-path base)
1009                 ;; needed because we canonicalize away a path of just `/':
1010                 '(:absolute "")))
1011            (path (uri-parsed-path uri))
1012            new-path-list)
1013       (when (not (eq :absolute (car base-path)))
1014         (error "Cannot merge ~a and ~a, since latter is not absolute."
1015                uri base))
1016
1017       ;; steps 6a and 6b:
1018       (setq new-path-list
1019         (append (butlast base-path)
1020                 (if* path then (cdr path) else '(""))))
1021
1022       ;; steps 6c and 6d:
1023       (let ((last (last new-path-list)))
1024         (if* (atom (car last))
1025            then (when (string= "." (car last))
1026                   (setf (car last) ""))
1027            else (when (string= "." (caar last))
1028                   (setf (caar last) ""))))
1029       (setq new-path-list
1030         (delete "." new-path-list :test #'(lambda (a b)
1031                                             (if* (atom b)
1032                                                then (string= a b)
1033                                                else nil))))
1034
1035       ;; steps 6e and 6f:
1036       (let ((npl (cdr new-path-list))
1037             index tmp fix-tail)
1038         (setq fix-tail
1039           (string= ".." (let ((l (car (last npl))))
1040                           (if* (atom l)
1041                              then l
1042                              else (car l)))))
1043         (loop
1044           (setq index
1045             (position ".." npl
1046                       :test #'(lambda (a b)
1047                                 (string= a
1048                                          (if* (atom b)
1049                                             then b
1050                                             else (car b))))))
1051           (when (null index) (return))
1052           (when (= 0 index)
1053             ;; The RFC says, in 6g, "that the implementation may handle
1054             ;; this error by retaining these components in the resolved
1055             ;; path, by removing them from the resolved path, or by
1056             ;; avoiding traversal of the reference."  The examples in C.2
1057             ;; imply that we should do the first thing (retain them), so
1058             ;; that's what we'll do.
1059             (return))
1060           (if* (= 1 index)
1061              then (setq npl (cddr npl))
1062              else (setq tmp npl)
1063                   (dotimes (x (- index 2)) (setq tmp (cdr tmp)))
1064                   (setf (cdr tmp) (cdddr tmp))))
1065         (setf (cdr new-path-list) npl)
1066         (when fix-tail (setq new-path-list (nconc new-path-list '("")))))
1067
1068       ;; step 6g:
1069       ;; don't complain if new-path-list starts with `..'.  See comment
1070       ;; above about this step.
1071
1072       ;; step 6h:
1073       (when (or (equal '(:absolute "") new-path-list)
1074                 (equal '(:absolute) new-path-list))
1075         (setq new-path-list nil))
1076       (setf (uri-path uri)
1077         (render-parsed-path new-path-list
1078                             ;; don't know, so have to assume:
1079                             t)))
1080
1081 ;;;; step 7
1082    :done
1083     (return-from merge-uris uri)))
1084
1085 (defmethod enough-uri ((uri string) (base string) &optional place)
1086   (enough-uri (parse-uri uri) (parse-uri base) place))
1087
1088 (defmethod enough-uri ((uri uri) (base string) &optional place)
1089   (enough-uri uri (parse-uri base) place))
1090
1091 (defmethod enough-uri ((uri string) (base uri) &optional place)
1092   (enough-uri (parse-uri uri) base place))
1093
1094 (defmethod enough-uri ((uri uri) (base uri) &optional place)
1095   (let ((new-scheme nil)
1096         (new-host nil)
1097         (new-port nil)
1098         (new-parsed-path nil))
1099
1100     (when (or (and (uri-scheme uri)
1101                    (not (equalp (uri-scheme uri) (uri-scheme base))))
1102               (and (uri-host uri)
1103                    (not (equalp (uri-host uri) (uri-host base))))
1104               (not (equalp (uri-port uri) (uri-port base))))
1105       (return-from enough-uri uri))
1106
1107     (when (null (uri-host uri))
1108       (setq new-host (uri-host base)))
1109     (when (null (uri-port uri))
1110       (setq new-port (uri-port base)))
1111
1112     (when (null (uri-scheme uri))
1113       (setq new-scheme (uri-scheme base)))
1114
1115     ;; Now, for the hard one, path.
1116     ;; We essentially do here what enough-namestring does.
1117     (do* ((base-path (uri-parsed-path base))
1118           (path (uri-parsed-path uri))
1119           (bp base-path (cdr bp))
1120           (p path (cdr p)))
1121         ((or (null bp) (null p))
1122          ;; If p is nil, that means we have something like
1123          ;; (enough-uri "/foo/bar" "/foo/bar/baz.htm"), so
1124          ;; new-parsed-path will be nil.
1125          (when (null bp)
1126            (setq new-parsed-path (copy-list p))
1127            (when (not (symbolp (car new-parsed-path)))
1128              (push :relative new-parsed-path))))
1129       (if* (equal (car bp) (car p))
1130          thenret ;; skip it
1131          else (setq new-parsed-path (copy-list p))
1132               (when (not (symbolp (car new-parsed-path)))
1133                 (push :relative new-parsed-path))
1134               (return)))
1135
1136     (let ((new-path
1137            (when new-parsed-path
1138              (render-parsed-path new-parsed-path
1139                                  ;; don't know, so have to assume:
1140                                  t)))
1141           (new-query (uri-query uri))
1142           (new-fragment (uri-fragment uri))
1143           (new-plist (copy-list (uri-plist uri))))
1144       (if* (and (null new-scheme)
1145                 (null new-host)
1146                 (null new-port)
1147                 (null new-path)
1148                 (null new-parsed-path)
1149                 (null new-query)
1150                 (null new-fragment))
1151          then ;; can't have a completely empty uri!
1152               (copy-uri nil
1153                         :class (class-of uri)
1154                         :place place
1155                         :path "/"
1156                         :plist new-plist)
1157          else (copy-uri nil
1158                         :class (class-of uri)
1159                         :place place
1160                         :scheme new-scheme
1161                         :host new-host
1162                         :port new-port
1163                         :path new-path
1164                         :parsed-path new-parsed-path
1165                         :query new-query
1166                         :fragment new-fragment
1167                         :plist new-plist)))))
1168
1169 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1170 ;; support for interning URIs
1171
1172 (defun make-uri-space (&rest keys &key (size 777) &allow-other-keys)
1173   #+allegro
1174   (apply #'make-hash-table :size size
1175          :hash-function 'uri-hash
1176          :test 'uri= :values nil keys)
1177   #-allegro
1178   (apply #'make-hash-table :size size keys))
1179
1180 (defun gethash-uri (uri table)
1181   #+allegro (gethash uri table)
1182   #-allegro
1183   (let* ((hash (uri-hash uri))
1184          (existing (gethash hash table)))
1185     (dolist (u existing)
1186       (when (uri= u uri)
1187         (return-from gethash-uri (values u t))))
1188     (values nil nil)))
1189
1190 (defun puthash-uri (uri table)
1191   #+allegro (excl:puthash-key uri table)
1192   #-allegro
1193   (let ((existing (gethash (uri-hash uri) table)))
1194     (dolist (u existing)
1195       (when (uri= u uri)
1196         (return-from puthash-uri u)))
1197     (setf (gethash (uri-hash uri) table)
1198       (cons uri existing))
1199     uri))
1200
1201
1202 (defun uri-hash (uri)
1203   (if* (uri-hashcode uri)
1204      thenret
1205      else (setf (uri-hashcode uri)
1206                 (sxhash
1207                  #+allegro
1208                  (render-uri uri nil)
1209                  #-allegro
1210                  (string-downcase
1211                   (render-uri uri nil))))))
1212
1213 (defvar *uris* (make-uri-space))
1214
1215 (defun uri-space () *uris*)
1216
1217 (defun (setf uri-space) (new-val)
1218   (setq *uris* new-val))
1219
1220 ;; bootstrapping (uri= changed from function to method):
1221 (when (fboundp 'uri=) (fmakunbound 'uri=))
1222
1223 (defgeneric uri= (uri1 uri2))
1224 (defmethod uri= ((uri1 uri) (uri2 uri))
1225   (when (not (eq (uri-scheme uri1) (uri-scheme uri2)))
1226     (return-from uri= nil))
1227   ;; RFC2396 says: a URL with an explicit ":port", where the port is
1228   ;; the default for the scheme, is the equivalent to one where the
1229   ;; port is elided.  Hmmmm.  This means that this function has to be
1230   ;; scheme dependent.  Grrrr.
1231   (let ((default-port (case (uri-scheme uri1)
1232                         (:http 80)
1233                         (:https 443)
1234                         (:ftp 21)
1235                         (:telnet 23))))
1236     (and (equalp (uri-host uri1) (uri-host uri2))
1237          (eql (or (uri-port uri1) default-port)
1238               (or (uri-port uri2) default-port))
1239          (string= (uri-path uri1) (uri-path uri2))
1240          (string= (uri-query uri1) (uri-query uri2))
1241          (string= (uri-fragment uri1) (uri-fragment uri2)))))
1242
1243 (defmethod uri= ((urn1 urn) (urn2 urn))
1244   (when (not (eq (uri-scheme urn1) (uri-scheme urn2)))
1245     (return-from uri= nil))
1246   (and (equalp (urn-nid urn1) (urn-nid urn2))
1247        (urn-nss-equal (urn-nss urn1) (urn-nss urn2))))
1248
1249 (defun urn-nss-equal (nss1 nss2 &aux len)
1250   ;; Return t iff the nss values are the same.
1251   ;; %2c and %2C are equivalent.
1252   (when (or (null nss1) (null nss2)
1253             (not (= (setq len (length nss1))
1254                     (length nss2))))
1255     (return-from urn-nss-equal nil))
1256   (do* ((i 0 (1+ i))
1257         (state :char)
1258         c1 c2)
1259       ((= i len) t)
1260     (setq c1 (char nss1 i))
1261     (setq c2 (char nss2 i))
1262     (ecase state
1263       (:char
1264        (if* (and (char= #\% c1) (char= #\% c2))
1265           then (setq state :percent+1)
1266         elseif (char/= c1 c2)
1267           then (return nil)))
1268       (:percent+1
1269        (when (char-not-equal c1 c2) (return nil))
1270        (setq state :percent+2))
1271       (:percent+2
1272        (when (char-not-equal c1 c2) (return nil))
1273        (setq state :char)))))
1274
1275 (defmethod intern-uri ((xuri uri) &optional (uri-space *uris*))
1276   (let ((uri (gethash-uri xuri uri-space)))
1277     (if* uri
1278        thenret
1279        else (puthash-uri xuri uri-space))))
1280
1281 (defmethod intern-uri ((uri string) &optional (uri-space *uris*))
1282   (intern-uri (parse-uri uri) uri-space))
1283
1284 (defun unintern-uri (uri &optional (uri-space *uris*))
1285   (if* (eq t uri)
1286      then (clrhash uri-space)
1287    elseif (uri-p uri)
1288      then (remhash uri uri-space)
1289      else (error "bad uri: ~s." uri)))
1290
1291 (defmacro do-all-uris ((var &optional uri-space result-form)
1292                        &rest forms
1293                        &environment env)
1294   "do-all-uris (var [[uri-space] result-form])
1295                     {declaration}* {tag | statement}*
1296 Executes the forms once for each uri with var bound to the current uri"
1297   (let ((f (gensym))
1298         (g-ignore (gensym))
1299         (g-uri-space (gensym))
1300         (body (third (parse-body forms env))))
1301     `(let ((,g-uri-space (or ,uri-space *uris*)))
1302        (prog nil
1303          (flet ((,f (,var &optional ,g-ignore)
1304                   (declare (ignore-if-unused ,var ,g-ignore))
1305                   (tagbody ,@body)))
1306            (maphash #',f ,g-uri-space))
1307          (return ,result-form)))))
1308
1309 (defun sharp-u (stream chr arg)
1310   (declare (ignore chr arg))
1311   (let ((arg (read stream nil nil t)))
1312     (if *read-suppress*
1313         nil
1314       (if* (stringp arg)
1315          then (parse-uri arg)
1316          else
1317
1318          (internal-reader-error
1319           stream
1320           "#u takes a string or list argument: ~s" arg)))))
1321
1322
1323 (set-dispatch-macro-character #\# #\u #'puri::sharp-u)
1324
1325 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1326
1327 (provide :uri)
1328
1329 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1330 ;; timings
1331 ;; (don't run under emacs with M-x fi:common-lisp)
1332
1333 #+allegro
1334 (eval-when (:compile-toplevel :load-toplevel :execute)
1335   (import 'excl::gc))
1336
1337 #-allegro
1338 (defun gc (&rest options)
1339   (declare (ignore options))
1340   #+sbcl (sb-ext::gc)
1341   #+cmu (ext::gc)
1342   )
1343
1344 (defun time-uri-module ()
1345   (declare (optimize (speed 3) (safety 0) (debug 0)))
1346   (let ((uri "http://www.franz.com/a/b;x;y;z/c/foo?bar=baz&xxx#foo")
1347         (uri2 "http://www.franz.com/a/b;x;y;z/c/%2ffoo?bar=baz&xxx#foo"))
1348     (gc t) (gc :tenure) (gc :tenure) (gc :tenure)
1349     (format t "~&;;; starting timing testing 1...~%")
1350     (time (dotimes (i 100000) (parse-uri uri)))
1351
1352     (gc t) (gc :tenure) (gc :tenure) (gc :tenure)
1353     (format t "~&;;; starting timing testing 2...~%")
1354     (let ((uri (parse-uri uri)))
1355       (time (dotimes (i 100000)
1356               ;; forces no caching of the printed representation:
1357               (setf (uri-string uri) nil)
1358               (format nil "~a" uri))))
1359
1360     (gc t) (gc :tenure) (gc :tenure) (gc :tenure)
1361     (format t "~&;;; starting timing testing 3...~%")
1362     (time
1363      (progn
1364        (dotimes (i 100000) (parse-uri uri2))
1365        (let ((uri (parse-uri uri)))
1366          (dotimes (i 100000)
1367            ;; forces no caching of the printed representation:
1368            (setf (uri-string uri) nil)
1369            (format nil "~a" uri)))))))
1370
1371 ;;******** reference output (ultra, modified 5.0.1):
1372 ;;; starting timing testing 1...
1373 ; cpu time (non-gc) 13,710 msec user, 0 msec system
1374 ; cpu time (gc)     600 msec user, 10 msec system
1375 ; cpu time (total)  14,310 msec user, 10 msec system
1376 ; real time  14,465 msec
1377 ; space allocation:
1378 ;  1,804,261 cons cells, 7 symbols, 41,628,832 other bytes, 0 static bytes
1379 ;;; starting timing testing 2...
1380 ; cpu time (non-gc) 27,500 msec user, 0 msec system
1381 ; cpu time (gc)     280 msec user, 20 msec system
1382 ; cpu time (total)  27,780 msec user, 20 msec system
1383 ; real time  27,897 msec
1384 ; space allocation:
1385 ;  1,900,463 cons cells, 0 symbols, 17,693,712 other bytes, 0 static bytes
1386 ;;; starting timing testing 3...
1387 ; cpu time (non-gc) 52,290 msec user, 10 msec system
1388 ; cpu time (gc)     1,290 msec user, 30 msec system
1389 ; cpu time (total)  53,580 msec user, 40 msec system
1390 ; real time  54,062 msec
1391 ; space allocation:
1392 ;  7,800,205 cons cells, 0 symbols, 81,697,496 other bytes, 0 static bytes
1393
1394 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1395 ;;; after improving decode-escaped-encoding/encode-escaped-encoding:
1396
1397 ;;; starting timing testing 1...
1398 ; cpu time (non-gc) 14,520 msec user, 0 msec system
1399 ; cpu time (gc)     400 msec user, 0 msec system
1400 ; cpu time (total)  14,920 msec user, 0 msec system
1401 ; real time  15,082 msec
1402 ; space allocation:
1403 ;  1,800,270 cons cells, 0 symbols, 41,600,160 other bytes, 0 static bytes
1404 ;;; starting timing testing 2...
1405 ; cpu time (non-gc) 27,490 msec user, 10 msec system
1406 ; cpu time (gc)     300 msec user, 0 msec system
1407 ; cpu time (total)  27,790 msec user, 10 msec system
1408 ; real time  28,025 msec
1409 ; space allocation:
1410 ;  1,900,436 cons cells, 0 symbols, 17,693,712 other bytes, 0 static bytes
1411 ;;; starting timing testing 3...
1412 ; cpu time (non-gc) 47,900 msec user, 20 msec system
1413 ; cpu time (gc)     920 msec user, 10 msec system
1414 ; cpu time (total)  48,820 msec user, 30 msec system
1415 ; real time  49,188 msec
1416 ; space allocation:
1417 ;  3,700,215 cons cells, 0 symbols, 81,707,144 other bytes, 0 static bytes