r10806: Automated commit for Debian build of puri upstream-version-1.3.1.3
[puri.git] / src.lisp
1 ;; -*- mode: common-lisp; package: puri -*-
2 ;; Support for URIs in Allegro.
3 ;; For general URI information see RFC2396.
4 ;;
5 ;; copyright (c) 1999-2001 Franz Inc, Berkeley, CA - All rights reserved.
6 ;; copyright (c) 2003 Kevin Rosenberg (porting changes)
7 ;;
8 ;; The software, data and information contained herein are proprietary
9 ;; to, and comprise valuable trade secrets of, Franz, Inc.  They are
10 ;; given in confidence by Franz, Inc. pursuant to a written license
11 ;; agreement, and may be stored and used only in accordance with the terms
12 ;; of such license.
13 ;;
14 ;; Restricted Rights Legend
15 ;; ------------------------
16 ;; Use, duplication, and disclosure of the software, data and information
17 ;; contained herein by any agency, department or entity of the U.S.
18 ;; Government are subject to restrictions of Restricted Rights for
19 ;; Commercial Software developed at private expense as specified in
20 ;; DOD FAR Supplement 52.227-7013 (c) (1) (ii), as applicable.
21 ;;
22 ;; Original version from ACL 6.1:
23 ;; uri.cl,v 2.3.6.4.2.1 2001/08/09 17:42:39 layer
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   (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 (defun position-char (char string start max)
130   (declare (optimize (speed 3) (safety 0) (space 0))
131            (fixnum start max) (simple-string string))
132   (do* ((i start (1+ i)))
133        ((= i max) nil)
134     (declare (fixnum i))
135     (when (char= char (schar 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 (or (not skip-terminal) (zerop len))
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     '(;; `delims' (except #\%, because it's handled specially):
359       #\< #\> #\" #\space #\#
360       ;; `unwise':
361       #\{ #\} #\| #\\ #\^ #\[ #\] #\`))
362
363 (defun reserved-char-vector (chars &key except)
364   (do* ((a (make-array 127 :element-type 'bit :initial-element 0))
365         (chars chars (cdr chars))
366         (c (car chars) (car chars)))
367       ((null chars) a)
368     (if* (and except (member c except :test #'char=))
369        thenret
370        else (setf (sbit a (char-int c)) 1))))
371
372 (defparameter *reserved-characters*
373     (reserved-char-vector
374      (append *excluded-characters*
375              '(#\; #\/ #\? #\: #\@ #\& #\= #\+ #\$ #\, #\%))))
376 (defparameter *reserved-authority-characters*
377     (reserved-char-vector
378      (append *excluded-characters* '(#\; #\/ #\? #\: #\@))))
379 (defparameter *reserved-path-characters*
380     (reserved-char-vector
381      (append *excluded-characters*
382              '(#\;
383 ;;;;The rfc says this should be here, but it doesn't make sense.
384                ;; #\=
385                #\/ #\?))))
386 (defparameter *reserved-path-characters2*
387     ;; These are the same characters that are in
388     ;; *reserved-path-characters*, minus #\/.  Why?  Because the parsed
389     ;; representation of the path can contain the %2f converted into a /.
390     ;; That's the whole point of having the parsed representation, so that
391     ;; lisp programs can deal with the path element data in the most
392     ;; convenient form.
393     (reserved-char-vector
394      (append *excluded-characters*
395              '(#\;
396 ;;;;The rfc says this should be here, but it doesn't make sense.
397                ;; #\=
398                #\?))))
399 (defparameter *reserved-fragment-characters*
400     (reserved-char-vector (remove #\# *excluded-characters*)))
401
402 (eval-when (:compile-toplevel :execute)
403 (defun gen-char-range-list (start end)
404   (do* ((res '())
405         (endcode (1+ (char-int end)))
406         (chcode (char-int start)
407                 (1+ chcode))
408         (hyphen nil))
409       ((= chcode endcode)
410        ;; - has to be first, otherwise it signifies a range!
411        (if* hyphen
412           then (setq res (nreverse res))
413                (push #\- res)
414                res
415           else (nreverse res)))
416     (if* (= #.(char-int #\-) chcode)
417        then (setq hyphen t)
418        else (push (code-char chcode) res))))
419 )
420
421 (defparameter *valid-nid-characters*
422     (reserved-char-vector
423      '#.(nconc (gen-char-range-list #\a #\z)
424                (gen-char-range-list #\A #\Z)
425                (gen-char-range-list #\0 #\9)
426                '(#\- #\. #\+))))
427 (defparameter *reserved-nss-characters*
428     (reserved-char-vector
429      (append *excluded-characters* '(#\& #\~ #\/ #\?))))
430
431 (defparameter *illegal-characters*
432     (reserved-char-vector (remove #\# *excluded-characters*)))
433 (defparameter *strict-illegal-query-characters*
434     (reserved-char-vector (append '(#\?) (remove #\# *excluded-characters*))))
435 (defparameter *illegal-query-characters*
436     (reserved-char-vector
437      *excluded-characters* :except '(#\^ #\| #\#)))
438
439
440 (defun parse-uri (thing &key (class 'uri) &aux escape)
441   (when (uri-p thing) (return-from parse-uri thing))
442   
443   (setq escape (escape-p thing))
444   (multiple-value-bind (scheme host port path query fragment)
445       (parse-uri-string thing)
446     (when scheme
447       (setq scheme
448         (intern (funcall
449                  (case *current-case-mode*
450                    ((:case-insensitive-upper :case-sensitive-upper)
451                     #'string-upcase)
452                    ((:case-insensitive-lower :case-sensitive-lower)
453                     #'string-downcase))
454                  (decode-escaped-encoding scheme escape))
455                 (find-package :keyword))))
456     
457     (when (and scheme (eq :urn scheme))
458       (return-from parse-uri
459         (make-instance 'urn :scheme scheme :nid host :nss path)))
460     
461     (when host (setq host (decode-escaped-encoding host escape)))
462     (when port
463       (setq port (read-from-string port))
464       (when (not (numberp port)) (error "port is not a number: ~s." port))
465       (when (not (plusp port))
466         (error "port is not a positive integer: ~d." port))
467       (when (eql port (case scheme
468                       (:http 80)
469                       (:https 443)
470                       (:ftp 21)
471                       (:telnet 23)))
472         (setq port nil)))
473     (when (or (string= "" path)
474               (and ;; we canonicalize away a reference to just /:
475                scheme
476                (member scheme '(:http :https :ftp) :test #'eq)
477                (string= "/" path)))
478       (setq path nil))
479     (when path
480       (setq path
481         (decode-escaped-encoding path escape *reserved-path-characters*)))
482     (when query (setq query (decode-escaped-encoding query escape)))
483     (when fragment
484       (setq fragment
485         (decode-escaped-encoding fragment escape
486                                  *reserved-fragment-characters*)))
487     (if* (eq 'uri class)
488        then ;; allow the compiler to optimize the make-instance call:
489             (make-instance 'uri
490               :scheme scheme
491               :host host
492               :port port
493               :path path
494               :query query
495               :fragment fragment
496               :escaped escape)
497        else ;; do it the slow way:
498             (make-instance class
499               :scheme scheme
500               :host host
501               :port port
502               :path path
503               :query query
504               :fragment fragment
505               :escaped escape))))
506
507 (defmethod uri ((thing uri))
508   thing)
509
510 (defmethod uri ((thing string))
511   (parse-uri thing))
512
513 (defmethod uri ((thing t))
514   (error "Cannot coerce ~s to a uri." thing))
515
516 (defvar *strict-parse* t)
517
518 (defun parse-uri-string (string &aux (illegal-chars *illegal-characters*))
519   (declare (optimize (speed 3)))
520   ;; Speed is important, so use a specialized state machine instead of
521   ;; regular expressions for parsing the URI string. The regexp we are
522   ;; simulating:
523   ;;  ^(([^:/?#]+):)?
524   ;;   (//([^/?#]*))?
525   ;;   ([^?#]*)
526   ;;   (\?([^#]*))?
527   ;;   (#(.*))?
528   (let* ((state 0)
529          (start 0)
530          (end (length string))
531          (tokval nil)
532          (scheme nil)
533          (host nil)
534          (port nil)
535          (path-components '())
536          (query nil)
537          (fragment nil)
538          ;; namespace identifier, for urn parsing only:
539          (nid nil))
540     (declare (fixnum state start end))
541     (flet ((read-token (kind &optional legal-chars)
542              (setq tokval nil)
543              (if* (>= start end)
544                 then :end
545                 else (let ((sindex start)
546                            (res nil)
547                            c)
548                        (declare (fixnum sindex))
549                        (setq res
550                          (loop
551                            (when (>= start end) (return nil))
552                            (setq c (schar string start))
553                            (let ((ci (char-int c)))
554                              (if* legal-chars
555                                 then (if* (and (eq :colon kind) (eq c #\:))
556                                         then (return :colon)
557                                       elseif (= 0 (sbit legal-chars ci))
558                                         then (.parse-error
559                                               "~
560 URI ~s contains illegal character ~s at position ~d."
561                                               string c start))
562                               elseif (and (< ci 128)
563                                           *strict-parse*
564                                           (= 1 (sbit illegal-chars ci)))
565                                 then (.parse-error "~
566 URI ~s contains illegal character ~s at position ~d."
567                                                          string c start)))
568                            (case kind
569                              (:path (case c
570                                       (#\? (return :question))
571                                       (#\# (return :hash))))
572                              (:query (case c (#\# (return :hash))))
573                              (:rest)
574                              (t (case c
575                                   (#\: (return :colon))
576                                   (#\? (return :question))
577                                   (#\# (return :hash))
578                                   (#\/ (return :slash)))))
579                            (incf start)))
580                        (if* (> start sindex)
581                           then ;; we found some chars
582                                ;; before we stopped the parse
583                                (setq tokval (subseq string sindex start))
584                                :string
585                           else ;; immediately stopped at a special char
586                                (incf start)
587                                res))))
588            (failure (&optional why)
589              (.parse-error "illegal URI: ~s [~d]~@[: ~a~]"
590                                  string state why))
591            (impossible ()
592              (.parse-error "impossible state: ~d [~s]" state string)))
593       (loop
594         (case state
595           (0 ;; starting to parse
596            (ecase (read-token t)
597              (:colon (failure))
598              (:question (setq state 7))
599              (:hash (setq state 8))
600              (:slash (setq state 3))
601              (:string (setq state 1))
602              (:end (setq state 9))))
603           (1 ;; seen <token><special char>
604            (let ((token tokval))
605              (ecase (read-token t)
606                (:colon (setq scheme token)
607                        (if* (equalp "urn" scheme)
608                           then (setq state 15)
609                           else (setq state 2)))
610                (:question (push token path-components)
611                           (setq state 7))
612                (:hash (push token path-components)
613                       (setq state 8))
614                (:slash (push token path-components)
615                        (push "/" path-components)
616                        (setq state 6))
617                (:string (failure))
618                (:end (push token path-components)
619                      (setq state 9)))))
620           (2 ;; seen <scheme>:
621            (ecase (read-token t)
622              (:colon (failure))
623              (:question (setq state 7))
624              (:hash (setq state 8))
625              (:slash (setq state 3))
626              (:string (setq state 10))
627              (:end (setq state 9))))
628           (10 ;; seen <scheme>:<token>
629            (let ((token tokval))
630              (ecase (read-token t)
631                (:colon (failure))
632                (:question (push token path-components)
633                           (setq state 7))
634                (:hash (push token path-components)
635                       (setq state 8))
636                (:slash (push token path-components)
637                        (setq state 6))
638                (:string (failure))
639                (:end (push token path-components)
640                      (setq state 9)))))
641           (3 ;; seen / or <scheme>:/
642            (ecase (read-token t)
643              (:colon (failure))
644              (:question (push "/" path-components)
645                         (setq state 7))
646              (:hash (push "/" path-components)
647                     (setq state 8))
648              (:slash (setq state 4))
649              (:string (push "/" path-components)
650                       (push tokval path-components)
651                       (setq state 6))
652              (:end (push "/" path-components)
653                    (setq state 9))))
654           (4 ;; seen [<scheme>:]//
655            (ecase (read-token t)
656              (:colon (failure))
657              (:question (failure))
658              (:hash (failure))
659              (:slash (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 'simple-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= #\% (schar 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     (if* (cdr (setq segments (delimited-string-to-list (car pl) #\;)))
773        then ;; there is a param
774 ;;;         (setf (car pl) segments)
775             (setf (car pl)
776               (mapcar #'(lambda (s)
777                           (decode-escaped-encoding
778                            s escape *reserved-path-characters2*))
779                segments))
780        else ;; no param
781 ;;;         (setf (car pl) (car segments))
782             (setf (car pl)
783               (decode-escaped-encoding
784                (car segments) escape *reserved-path-characters2*)))))
785
786 (defun decode-escaped-encoding (string escape
787                                 &optional (reserved-chars
788                                            *reserved-characters*))
789   ;; Return a string with the real characters.
790   (when (null escape) (return-from decode-escaped-encoding string))
791   (do* ((i 0 (1+ i))
792         (max (length string))
793         (new-string (copy-seq string))
794         (new-i 0 (1+ new-i))
795         ch ch2 chc chc2)
796       ((= i max)
797        (shrink-vector new-string new-i))
798     (if* (char= #\% (setq ch (schar string i)))
799        then (when (> (+ i 3) max)
800               (.parse-error
801                "Unsyntactic escaped encoding in ~s." string))
802             (setq ch (schar string (incf i)))
803             (setq ch2 (schar string (incf i)))
804             (when (not (and (setq chc (digit-char-p ch 16))
805                             (setq chc2 (digit-char-p ch2 16))))
806               (.parse-error
807                "Non-hexidecimal digits after %: %c%c." ch ch2))
808             (let ((ci (+ (* 16 chc) chc2)))
809               (if* (or (null reserved-chars)
810                        (= 0 (sbit reserved-chars ci)))
811                  then ;; ok as is
812                       (setf (schar new-string new-i)
813                         (code-char ci))
814                  else (setf (schar new-string new-i) #\%)
815                       (setf (schar new-string (incf new-i)) ch)
816                       (setf (schar new-string (incf new-i)) ch2)))
817        else (setf (schar new-string new-i) ch))))
818
819 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
820 ;;;; Printing
821
822 (defun render-uri (uri stream
823                    &aux (escape (uri-escaped uri))
824                         (*print-pretty* nil))
825   (when (null (uri-string uri))
826     (setf (uri-string uri)
827       (let ((scheme (uri-scheme uri))
828             (host (uri-host uri))
829             (port (uri-port uri))
830             (path (uri-path uri))
831             (query (uri-query uri))
832             (fragment (uri-fragment uri)))
833         (concatenate 'simple-string
834           (when scheme
835             (encode-escaped-encoding
836              (string-downcase ;; for upper case lisps
837               (symbol-name scheme))
838              *reserved-characters* escape))
839           (when scheme ":")
840           (when host "//")
841           (when host
842             (encode-escaped-encoding
843              host *reserved-authority-characters* escape))
844           (when port ":")
845           (when port
846             #-allegro (format nil "~D" port)
847             #+allegro (with-output-to-string (s)
848                         (excl::maybe-print-fast s port))
849             )
850           (when path
851             (encode-escaped-encoding path
852                                      nil
853                                      ;;*reserved-path-characters*
854                                      escape))
855           (when query "?")
856           (when query (encode-escaped-encoding query nil escape))
857           (when fragment "#")
858           (when fragment (encode-escaped-encoding fragment nil escape))))))
859   (if* stream
860      then (format stream "~a" (uri-string uri))
861      else (uri-string uri)))
862
863 (defun render-parsed-path (path-list escape)
864   (do* ((res '())
865         (first (car path-list))
866         (pl (cdr path-list) (cdr pl))
867         (pe (car pl) (car pl)))
868       ((null pl)
869        (when res (apply #'concatenate 'simple-string (nreverse res))))
870     (when (or (null first)
871               (prog1 (eq :absolute first)
872                 (setq first nil)))
873       (push "/" res))
874     (if* (atom pe)
875        then (push
876              (encode-escaped-encoding pe *reserved-path-characters* escape)
877              res)
878        else ;; contains params
879             (push (encode-escaped-encoding
880                    (car pe) *reserved-path-characters* escape)
881                   res)
882             (dolist (item (cdr pe))
883               (push ";" res)
884               (push (encode-escaped-encoding
885                      item *reserved-path-characters* escape)
886                     res)))))
887
888 (defun render-urn (urn stream
889                    &aux (*print-pretty* nil))
890   (when (null (uri-string urn))
891     (setf (uri-string urn)
892       (let ((nid (urn-nid urn))
893             (nss (urn-nss urn)))
894         (concatenate 'simple-string "urn:" nid ":" nss))))
895   (if* stream
896      then (format stream "~a" (uri-string urn))
897      else (uri-string urn)))
898
899 (defparameter *escaped-encoding*
900     (vector #\0 #\1 #\2 #\3 #\4 #\5 #\6 #\7 #\8 #\9 #\a #\b #\c #\d #\e #\f))
901
902 (defun encode-escaped-encoding (string reserved-chars escape)
903   (unless (typep string 'simple-string)
904     (setq string (coerce string 'simple-string)))
905   (when (null escape) (return-from encode-escaped-encoding string))
906   ;; Make a string as big as it possibly needs to be (3 times the original
907   ;; size), and truncate it at the end.
908   (do* ((max (length string))
909         (new-max (* 3 max)) ;; worst case new size
910         (new-string (make-string new-max))
911         (i 0 (1+ i))
912         (new-i -1)
913         c ci)
914       ((= i max)
915        (shrink-vector new-string (incf new-i)))
916     (setq ci (char-int (setq c (schar string i))))
917     (if* (or (null reserved-chars)
918              (> ci 127)
919              (= 0 (sbit reserved-chars ci)))
920        then ;; ok as is
921             (incf new-i)
922             (setf (schar new-string new-i) c)
923        else ;; need to escape it
924             (multiple-value-bind (q r) (truncate ci 16)
925               (setf (schar new-string (incf new-i)) #\%)
926               (setf (schar new-string (incf new-i)) (elt *escaped-encoding* q))
927               (setf (schar new-string (incf new-i))
928                 (elt *escaped-encoding* r))))))
929
930 (defmethod print-object ((uri uri) stream)
931   (if* *print-escape*
932      then (format stream "#<~a ~a>" 'uri (render-uri uri nil))
933      else (render-uri uri stream)))
934
935 (defmethod print-object ((urn urn) stream)
936   (if* *print-escape*
937      then (format stream "#<~a ~a>" 'uri (render-urn urn nil))
938      else (render-urn urn stream)))
939
940 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
941 ;; merging and unmerging
942
943 (defmethod merge-uris ((uri string) (base string) &optional place)
944   (merge-uris (parse-uri uri) (parse-uri base) place))
945
946 (defmethod merge-uris ((uri uri) (base string) &optional place)
947   (merge-uris uri (parse-uri base) place))
948
949 (defmethod merge-uris ((uri string) (base uri) &optional place)
950   (merge-uris (parse-uri uri) base place))
951
952 (defmethod merge-uris ((uri uri) (base uri) &optional place)
953   ;; The following is from
954   ;; http://info.internet.isi.edu/in-notes/rfc/files/rfc2396.txt
955   ;; and is algorithm we use to merge URIs.
956   ;;
957   ;; For more information, see section 5.2 of the RFC.
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       (when (and p (eq :absolute (car p)))
989         (when (equal '(:absolute "") p)
990           ;; Canonicalize the way parsing does:
991           (setf (uri-path uri) nil))
992         (go :done)))
993     
994 ;;;; step 6
995     (let* ((base-path
996             (or (uri-parsed-path base)
997                 ;; needed because we canonicalize away a path of just `/':
998                 '(:absolute "")))
999            (path (uri-parsed-path uri))
1000            new-path-list)
1001       (when (not (eq :absolute (car base-path)))
1002         (error "Cannot merge ~a and ~a, since latter is not absolute."
1003                uri base))
1004
1005       ;; steps 6a and 6b:
1006       (setq new-path-list
1007         (append (butlast base-path)
1008                 (if* path then (cdr path) else '(""))))
1009
1010       ;; steps 6c and 6d:
1011       (let ((last (last new-path-list)))
1012         (if* (atom (car last))
1013            then (when (string= "." (car last))
1014                   (setf (car last) ""))
1015            else (when (string= "." (caar last))
1016                   (setf (caar last) ""))))
1017       (setq new-path-list
1018         (delete "." new-path-list :test #'(lambda (a b)
1019                                             (if* (atom b)
1020                                                then (string= a b)
1021                                                else nil))))
1022
1023       ;; steps 6e and 6f:
1024       (let ((npl (cdr new-path-list))
1025             index tmp fix-tail)
1026         (setq fix-tail
1027           (string= ".." (let ((l (car (last npl))))
1028                           (if* (atom l)
1029                              then l
1030                              else (car l)))))
1031         (loop
1032           (setq index
1033             (position ".." npl
1034                       :test #'(lambda (a b)
1035                                 (string= a
1036                                          (if* (atom b)
1037                                             then b
1038                                             else (car b))))))
1039           (when (null index) (return))
1040           (when (= 0 index)
1041             ;; The RFC says, in 6g, "that the implementation may handle
1042             ;; this error by retaining these components in the resolved
1043             ;; path, by removing them from the resolved path, or by
1044             ;; avoiding traversal of the reference."  The examples in C.2
1045             ;; imply that we should do the first thing (retain them), so
1046             ;; that's what we'll do.
1047             (return))
1048           (if* (= 1 index)
1049              then (setq npl (cddr npl))
1050              else (setq tmp npl)
1051                   (dotimes (x (- index 2)) (setq tmp (cdr tmp)))
1052                   (setf (cdr tmp) (cdddr tmp))))
1053         (setf (cdr new-path-list) npl)
1054         (when fix-tail (setq new-path-list (nconc new-path-list '("")))))
1055
1056       ;; step 6g:
1057       ;; don't complain if new-path-list starts with `..'.  See comment
1058       ;; above about this step.
1059
1060       ;; step 6h:
1061       (when (or (equal '(:absolute "") new-path-list)
1062                 (equal '(:absolute) new-path-list))
1063         (setq new-path-list nil))
1064       (setf (uri-path uri)
1065         (render-parsed-path new-path-list
1066                             ;; don't know, so have to assume:
1067                             t)))
1068
1069 ;;;; step 7
1070    :done
1071     (return-from merge-uris uri)))
1072
1073 (defmethod enough-uri ((uri string) (base string) &optional place)
1074   (enough-uri (parse-uri uri) (parse-uri base) place))
1075
1076 (defmethod enough-uri ((uri uri) (base string) &optional place)
1077   (enough-uri uri (parse-uri base) place))
1078
1079 (defmethod enough-uri ((uri string) (base uri) &optional place)
1080   (enough-uri (parse-uri uri) base place))
1081
1082 (defmethod enough-uri ((uri uri) (base uri) &optional place)
1083   (let ((new-scheme nil)
1084         (new-host nil)
1085         (new-port nil)
1086         (new-parsed-path nil))
1087
1088     (when (or (and (uri-scheme uri)
1089                    (not (equalp (uri-scheme uri) (uri-scheme base))))
1090               (and (uri-host uri)
1091                    (not (equalp (uri-host uri) (uri-host base))))
1092               (not (equalp (uri-port uri) (uri-port base))))
1093       (return-from enough-uri uri))
1094
1095     (when (null (uri-host uri))
1096       (setq new-host (uri-host base)))
1097     (when (null (uri-port uri))
1098       (setq new-port (uri-port base)))
1099     
1100     (when (null (uri-scheme uri))
1101       (setq new-scheme (uri-scheme base)))
1102
1103     ;; Now, for the hard one, path.
1104     ;; We essentially do here what enough-namestring does.
1105     (do* ((base-path (uri-parsed-path base))
1106           (path (uri-parsed-path uri))
1107           (bp base-path (cdr bp))
1108           (p path (cdr p)))
1109         ((or (null bp) (null p))
1110          ;; If p is nil, that means we have something like
1111          ;; (enough-uri "/foo/bar" "/foo/bar/baz.htm"), so
1112          ;; new-parsed-path will be nil.
1113          (when (null bp)
1114            (setq new-parsed-path (copy-list p))
1115            (when (not (symbolp (car new-parsed-path)))
1116              (push :relative new-parsed-path))))
1117       (if* (equal (car bp) (car p))
1118          thenret ;; skip it
1119          else (setq new-parsed-path (copy-list p))
1120               (when (not (symbolp (car new-parsed-path)))
1121                 (push :relative new-parsed-path))
1122               (return)))
1123
1124     (let ((new-path 
1125            (when new-parsed-path
1126              (render-parsed-path new-parsed-path
1127                                  ;; don't know, so have to assume:
1128                                  t)))
1129           (new-query (uri-query uri))
1130           (new-fragment (uri-fragment uri))
1131           (new-plist (copy-list (uri-plist uri))))
1132       (if* (and (null new-scheme)
1133                 (null new-host)
1134                 (null new-port)
1135                 (null new-path)
1136                 (null new-parsed-path)
1137                 (null new-query)
1138                 (null new-fragment))
1139          then ;; can't have a completely empty uri!
1140               (copy-uri nil
1141                         :class (class-of uri)
1142                         :place place
1143                         :path "/"
1144                         :plist new-plist)
1145          else (copy-uri nil
1146                         :class (class-of uri)
1147                         :place place
1148                         :scheme new-scheme
1149                         :host new-host
1150                         :port new-port
1151                         :path new-path
1152                         :parsed-path new-parsed-path
1153                         :query new-query
1154                         :fragment new-fragment
1155                         :plist new-plist)))))
1156
1157 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1158 ;; support for interning URIs
1159
1160 (defun make-uri-space (&rest keys &key (size 777) &allow-other-keys)
1161   #+allegro
1162   (apply #'make-hash-table :size size
1163          :hash-function 'uri-hash
1164          :test 'uri= :values nil keys)
1165   #-allegro
1166   (apply #'make-hash-table :size size keys))
1167
1168 (defun gethash-uri (uri table)
1169   #+allegro (gethash uri table)
1170   #-allegro 
1171   (let* ((hash (uri-hash uri))
1172          (existing (gethash hash table)))
1173     (dolist (u existing)
1174       (when (uri= u uri)
1175         (return-from gethash-uri (values u t))))
1176     (values nil nil)))
1177
1178 (defun puthash-uri (uri table)
1179   #+allegro (excl:puthash-key uri table)
1180   #-allegro 
1181   (let ((existing (gethash (uri-hash uri) table)))
1182     (dolist (u existing)
1183       (when (uri= u uri)
1184         (return-from puthash-uri u)))
1185     (setf (gethash (uri-hash uri) table)
1186       (cons uri existing))
1187     uri))
1188
1189
1190 (defun uri-hash (uri)
1191   (if* (uri-hashcode uri)
1192      thenret
1193      else (setf (uri-hashcode uri)
1194                 (sxhash
1195                  #+allegro
1196                  (render-uri uri nil)
1197                  #-allegro
1198                  (string-downcase 
1199                   (render-uri uri nil))))))
1200
1201 (defvar *uris* (make-uri-space))
1202
1203 (defun uri-space () *uris*)
1204
1205 (defun (setf uri-space) (new-val)
1206   (setq *uris* new-val))
1207
1208 ;; bootstrapping (uri= changed from function to method):
1209 (when (fboundp 'uri=) (fmakunbound 'uri=))
1210
1211 (defgeneric uri= (uri1 uri2))
1212 (defmethod uri= ((uri1 uri) (uri2 uri))
1213   (when (not (eq (uri-scheme uri1) (uri-scheme uri2)))
1214     (return-from uri= nil))
1215   ;; RFC2396 says: a URL with an explicit ":port", where the port is
1216   ;; the default for the scheme, is the equivalent to one where the
1217   ;; port is elided.  Hmmmm.  This means that this function has to be
1218   ;; scheme dependent.  Grrrr.
1219   (let ((default-port (case (uri-scheme uri1)
1220                         (:http 80)
1221                         (:https 443)
1222                         (:ftp 21)
1223                         (:telnet 23))))
1224     (and (equalp (uri-host uri1) (uri-host uri2))
1225          (eql (or (uri-port uri1) default-port)
1226               (or (uri-port uri2) default-port))
1227          (string= (uri-path uri1) (uri-path uri2))
1228          (string= (uri-query uri1) (uri-query uri2))
1229          (string= (uri-fragment uri1) (uri-fragment uri2)))))
1230
1231 (defmethod uri= ((urn1 urn) (urn2 urn))
1232   (when (not (eq (uri-scheme urn1) (uri-scheme urn2)))
1233     (return-from uri= nil))
1234   (and (equalp (urn-nid urn1) (urn-nid urn2))
1235        (urn-nss-equal (urn-nss urn1) (urn-nss urn2))))
1236
1237 (defun urn-nss-equal (nss1 nss2 &aux len)
1238   ;; Return t iff the nss values are the same.
1239   ;; %2c and %2C are equivalent.
1240   (when (or (null nss1) (null nss2)
1241             (not (= (setq len (length nss1))
1242                     (length nss2))))
1243     (return-from urn-nss-equal nil))
1244   (do* ((i 0 (1+ i))
1245         (state :char)
1246         c1 c2)
1247       ((= i len) t)
1248     (setq c1 (schar nss1 i))
1249     (setq c2 (schar nss2 i))
1250     (ecase state
1251       (:char
1252        (if* (and (char= #\% c1) (char= #\% c2))
1253           then (setq state :percent+1)
1254         elseif (char/= c1 c2)
1255           then (return nil)))
1256       (:percent+1
1257        (when (char-not-equal c1 c2) (return nil))
1258        (setq state :percent+2))
1259       (:percent+2
1260        (when (char-not-equal c1 c2) (return nil))
1261        (setq state :char)))))
1262
1263 (defmethod intern-uri ((xuri uri) &optional (uri-space *uris*))
1264   (let ((uri (gethash-uri xuri uri-space)))
1265     (if* uri
1266        thenret
1267        else (puthash-uri xuri uri-space))))
1268
1269 (defmethod intern-uri ((uri string) &optional (uri-space *uris*))
1270   (intern-uri (parse-uri uri) uri-space))
1271
1272 (defun unintern-uri (uri &optional (uri-space *uris*))
1273   (if* (eq t uri)
1274      then (clrhash uri-space)
1275    elseif (uri-p uri)
1276      then (remhash uri uri-space)
1277      else (error "bad uri: ~s." uri)))
1278
1279 (defmacro do-all-uris ((var &optional uri-space result-form)
1280                        &rest forms
1281                        &environment env)
1282   "do-all-uris (var [[uri-space] result-form])
1283                     {declaration}* {tag | statement}*
1284 Executes the forms once for each uri with var bound to the current uri"
1285   (let ((f (gensym))
1286         (g-ignore (gensym))
1287         (g-uri-space (gensym))
1288         (body (third (parse-body forms env))))
1289     `(let ((,g-uri-space (or ,uri-space *uris*)))
1290        (prog nil
1291          (flet ((,f (,var &optional ,g-ignore)
1292                   (declare (ignore-if-unused ,var ,g-ignore))
1293                   (tagbody ,@body)))
1294            (maphash #',f ,g-uri-space))
1295          (return ,result-form)))))
1296
1297 (defun sharp-u (stream chr arg)
1298   (declare (ignore chr arg))
1299   (let ((arg (read stream nil nil t)))
1300     (if *read-suppress*
1301         nil
1302       (if* (stringp arg)
1303          then (parse-uri arg)
1304          else
1305
1306          (internal-reader-error
1307           stream
1308           "#u takes a string or list argument: ~s" arg)))))
1309
1310
1311 #+allegro
1312 excl::
1313 #+allegro
1314 (locally (declare (special std-lisp-readtable))
1315   (let ((*readtable* std-lisp-readtable))
1316     (set-dispatch-macro-character #\# #\u #'puri::sharp-u)))
1317 #-allegro
1318 (set-dispatch-macro-character #\# #\u #'puri::sharp-u)
1319
1320 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1321
1322 (provide :uri)
1323
1324 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1325 ;; timings
1326 ;; (don't run under emacs with M-x fi:common-lisp)
1327
1328 #+allegro
1329 (eval-when (:compile-toplevel :load-toplevel :execute)
1330   (import 'excl::gc))
1331
1332 #-allegro
1333 (defun gc (&rest options)
1334   (declare (ignore options))
1335   #+sbcl (sb-ext::gc)
1336   #+cmu (ext::gc)
1337   )
1338
1339 (defun time-uri-module ()
1340   (declare (optimize (speed 3) (safety 0) (debug 0)))
1341   (let ((uri "http://www.franz.com/a/b;x;y;z/c/foo?bar=baz&xxx#foo")
1342         (uri2 "http://www.franz.com/a/b;x;y;z/c/%2ffoo?bar=baz&xxx#foo"))
1343     (gc t) (gc :tenure) (gc :tenure) (gc :tenure)
1344     (format t "~&;;; starting timing testing 1...~%")
1345     (time (dotimes (i 100000) (parse-uri uri)))
1346     
1347     (gc t) (gc :tenure) (gc :tenure) (gc :tenure)
1348     (format t "~&;;; starting timing testing 2...~%")
1349     (let ((uri (parse-uri uri)))
1350       (time (dotimes (i 100000)
1351               ;; forces no caching of the printed representation:
1352               (setf (uri-string uri) nil)
1353               (format nil "~a" uri))))
1354     
1355     (gc t) (gc :tenure) (gc :tenure) (gc :tenure)
1356     (format t "~&;;; starting timing testing 3...~%")
1357     (time
1358      (progn
1359        (dotimes (i 100000) (parse-uri uri2))
1360        (let ((uri (parse-uri uri)))
1361          (dotimes (i 100000)
1362            ;; forces no caching of the printed representation:
1363            (setf (uri-string uri) nil)
1364            (format nil "~a" uri)))))))
1365
1366 ;;******** reference output (ultra, modified 5.0.1):
1367 ;;; starting timing testing 1...
1368 ; cpu time (non-gc) 13,710 msec user, 0 msec system
1369 ; cpu time (gc)     600 msec user, 10 msec system
1370 ; cpu time (total)  14,310 msec user, 10 msec system
1371 ; real time  14,465 msec
1372 ; space allocation:
1373 ;  1,804,261 cons cells, 7 symbols, 41,628,832 other bytes, 0 static bytes
1374 ;;; starting timing testing 2...
1375 ; cpu time (non-gc) 27,500 msec user, 0 msec system
1376 ; cpu time (gc)     280 msec user, 20 msec system
1377 ; cpu time (total)  27,780 msec user, 20 msec system
1378 ; real time  27,897 msec
1379 ; space allocation:
1380 ;  1,900,463 cons cells, 0 symbols, 17,693,712 other bytes, 0 static bytes
1381 ;;; starting timing testing 3...
1382 ; cpu time (non-gc) 52,290 msec user, 10 msec system
1383 ; cpu time (gc)     1,290 msec user, 30 msec system
1384 ; cpu time (total)  53,580 msec user, 40 msec system
1385 ; real time  54,062 msec
1386 ; space allocation:
1387 ;  7,800,205 cons cells, 0 symbols, 81,697,496 other bytes, 0 static bytes
1388
1389 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1390 ;;; after improving decode-escaped-encoding/encode-escaped-encoding:
1391
1392 ;;; starting timing testing 1...
1393 ; cpu time (non-gc) 14,520 msec user, 0 msec system
1394 ; cpu time (gc)     400 msec user, 0 msec system
1395 ; cpu time (total)  14,920 msec user, 0 msec system
1396 ; real time  15,082 msec
1397 ; space allocation:
1398 ;  1,800,270 cons cells, 0 symbols, 41,600,160 other bytes, 0 static bytes
1399 ;;; starting timing testing 2...
1400 ; cpu time (non-gc) 27,490 msec user, 10 msec system
1401 ; cpu time (gc)     300 msec user, 0 msec system
1402 ; cpu time (total)  27,790 msec user, 10 msec system
1403 ; real time  28,025 msec
1404 ; space allocation:
1405 ;  1,900,436 cons cells, 0 symbols, 17,693,712 other bytes, 0 static bytes
1406 ;;; starting timing testing 3...
1407 ; cpu time (non-gc) 47,900 msec user, 20 msec system
1408 ; cpu time (gc)     920 msec user, 10 msec system
1409 ; cpu time (total)  48,820 msec user, 30 msec system
1410 ; real time  49,188 msec
1411 ; space allocation:
1412 ;  3,700,215 cons cells, 0 symbols, 81,707,144 other bytes, 0 static bytes