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     '(;; `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
 387 (defparameter *reserved-fragment-characters*
 388     (reserved-char-vector (remove #\# *excluded-characters*)))
 389
 390 (eval-when (:compile-toplevel :execute)
 391 (defun gen-char-range-list (start end)
 392   (do* ((res '())
 393         (endcode (1+ (char-int end)))
 394         (chcode (char-int start)
 395                 (1+ chcode))
 396         (hyphen nil))
 397       ((= chcode endcode)
 398        ;; - has to be first, otherwise it signifies a range!
 399        (if* hyphen
 400           then (setq res (nreverse res))
 401                (push #\- res)
 402                res
 403           else (nreverse res)))
 404     (if* (= #.(char-int #\-) chcode)
 405        then (setq hyphen t)
 406        else (push (code-char chcode) res))))
 407 )
 408
 409 (defparameter *valid-nid-characters*
 410     (reserved-char-vector
 411      '#.(nconc (gen-char-range-list #\a #\z)
 412                (gen-char-range-list #\A #\Z)
 413                (gen-char-range-list #\0 #\9)
 414                '(#\- #\. #\+))))
 415 (defparameter *reserved-nss-characters*
 416     (reserved-char-vector
 417      (append *excluded-characters* '(#\& #\~ #\/ #\?))))
 418
 419 (defparameter *illegal-characters*
 420     (reserved-char-vector (remove #\# *excluded-characters*)))
 421 (defparameter *strict-illegal-query-characters*
 422     (reserved-char-vector (append '(#\?) (remove #\# *excluded-characters*))))
 423 (defparameter *illegal-query-characters*
 424     (reserved-char-vector
 425      *excluded-characters* :except '(#\^ #\| #\#)))
 426
 427
 428 (defun parse-uri (thing &key (class 'uri) &aux escape)
 429   (when (uri-p thing) (return-from parse-uri thing))
 430
 431   (setq escape (escape-p thing))
 432   (multiple-value-bind (scheme host port path query fragment)
 433       (parse-uri-string thing)
 434     (when scheme
 435       (setq scheme
 436         (intern (funcall
 437                  (case *current-case-mode*
 438                    ((:case-insensitive-upper :case-sensitive-upper)
 439                     #'string-upcase)
 440                    ((:case-insensitive-lower :case-sensitive-lower)
 441                     #'string-downcase))
 442                  (decode-escaped-encoding scheme escape))
 443                 (find-package :keyword))))
 444
 445     (when (and scheme (eq :urn scheme))
 446       (return-from parse-uri
 447         (make-instance 'urn :scheme scheme :nid host :nss path)))
 448
 449     (when host (setq host (decode-escaped-encoding host escape)))
 450     (when port
 451       (setq port (read-from-string port))
 452       (when (not (numberp port)) (error "port is not a number: ~s." port))
 453       (when (not (plusp port))
 454         (error "port is not a positive integer: ~d." port))
 455       (when (eql port (case scheme
 456                       (:http 80)
 457                       (:https 443)
 458                       (:ftp 21)
 459                       (:telnet 23)))
 460         (setq port nil)))
 461     (when (or (string= "" path)
 462               (and ;; we canonicalize away a reference to just /:
 463                scheme
 464                (member scheme '(:http :https :ftp) :test #'eq)
 465                (string= "/" path)))
 466       (setq path nil))
 467     (when path
 468       (setq path
 469         (decode-escaped-encoding path escape *reserved-path-characters*)))
 470     (when query (setq query (decode-escaped-encoding query escape)))
 471     (when fragment
 472       (setq fragment
 473         (decode-escaped-encoding fragment escape
 474                                  *reserved-fragment-characters*)))
 475     (if* (eq 'uri class)
 476        then ;; allow the compiler to optimize the make-instance call:
 477             (make-instance 'uri
 478               :scheme scheme
 479               :host host
 480               :port port
 481               :path path
 482               :query query
 483               :fragment fragment
 484               :escaped escape)
 485        else ;; do it the slow way:
 486             (make-instance class
 487               :scheme scheme
 488               :host host
 489               :port port
 490               :path path
 491               :query query
 492               :fragment fragment
 493               :escaped escape))))
 494
 495 (defmethod uri ((thing uri))
 496   thing)
 497
 498 (defmethod uri ((thing string))
 499   (parse-uri thing))
 500
 501 (defmethod uri ((thing t))
 502   (error "Cannot coerce ~s to a uri." thing))
 503
 504 (defvar *strict-parse* t)
 505
 506 (defun parse-uri-string (string &aux (illegal-chars *illegal-characters*))
 507   (declare (optimize (speed 3)))
 508   ;; Speed is important, so use a specialized state machine instead of
 509   ;; regular expressions for parsing the URI string. The regexp we are
 510   ;; simulating:
 511   ;;  ^(([^:/?#]+):)?
 512   ;;   (//([^/?#]*))?
 513   ;;   ([^?#]*)
 514   ;;   (\?([^#]*))?
 515   ;;   (#(.*))?
 516   (let* ((state 0)
 517          (start 0)
 518          (end (length string))
 519          (tokval nil)
 520          (scheme nil)
 521          (host nil)
 522          (port nil)
 523          (path-components '())
 524          (query nil)
 525          (fragment nil)
 526          ;; namespace identifier, for urn parsing only:
 527          (nid nil))
 528     (declare (fixnum state start end))
 529     (flet ((read-token (kind &optional legal-chars)
 530              (setq tokval nil)
 531              (if* (>= start end)
 532                 then :end
 533                 else (let ((sindex start)
 534                            (res nil)
 535                            c)
 536                        (declare (fixnum sindex))
 537                        (setq res
 538                          (loop
 539                            (when (>= start end) (return nil))
 540                            (setq c (char string start))
 541                            (let ((ci (char-int c)))
 542                              (if* legal-chars
 543                                 then (if* (and (eq :colon kind) (eq c #\:))
 544                                         then (return :colon)
 545                                       elseif (= 0 (sbit legal-chars ci))
 546                                         then (.parse-error
 547                                               "~
 548 URI ~s contains illegal character ~s at position ~d."
 549                                               string c start))
 550                               elseif (and (< ci 128)
 551                                           *strict-parse*
 552                                           (= 1 (sbit illegal-chars ci)))
 553                                 then (.parse-error "~
 554 URI ~s contains illegal character ~s at position ~d."
 555                                                          string c start)))
 556                            (case kind
 557                              (:path (case c
 558                                       (#\? (return :question))
 559                                       (#\# (return :hash))))
 560                              (:query (case c (#\# (return :hash))))
 561                              (:rest)
 562                              (t (case c
 563                                   (#\: (return :colon))
 564                                   (#\? (return :question))
 565                                   (#\# (return :hash))
 566                                   (#\/ (return :slash)))))
 567                            (incf start)))
 568                        (if* (> start sindex)
 569                           then ;; we found some chars
 570                                ;; before we stopped the parse
 571                                (setq tokval (subseq string sindex start))
 572                                :string
 573                           else ;; immediately stopped at a special char
 574                                (incf start)
 575                                res))))
 576            (failure (&optional why)
 577              (.parse-error "illegal URI: ~s [~d]~@[: ~a~]"
 578                                  string state why))
 579            (impossible ()
 580              (.parse-error "impossible state: ~d [~s]" state string)))
 581       (loop
 582         (case state
 583           (0 ;; starting to parse
 584            (ecase (read-token t)
 585              (:colon (failure))
 586              (:question (setq state 7))
 587              (:hash (setq state 8))
 588              (:slash (setq state 3))
 589              (:string (setq state 1))
 590              (:end (setq state 9))))
 591           (1 ;; seen <token><special char>
 592            (let ((token tokval))
 593              (ecase (read-token t)
 594                (:colon (setq scheme token)
 595                        (if* (equalp "urn" scheme)
 596                           then (setq state 15)
 597                           else (setq state 2)))
 598                (:question (push token path-components)
 599                           (setq state 7))
 600                (:hash (push token path-components)
 601                       (setq state 8))
 602                (:slash (push token path-components)
 603                        (push "/" path-components)
 604                        (setq state 6))
 605                (:string (failure))
 606                (:end (push token path-components)
 607                      (setq state 9)))))
 608           (2 ;; seen <scheme>:
 609            (ecase (read-token t)
 610              (:colon (failure))
 611              (:question (setq state 7))
 612              (:hash (setq state 8))
 613              (:slash (setq state 3))
 614              (:string (setq state 10))
 615              (:end (setq state 9))))
 616           (10 ;; seen <scheme>:<token>
 617            (let ((token tokval))
 618              (ecase (read-token t)
 619                (:colon (failure))
 620                (:question (push token path-components)
 621                           (setq state 7))
 622                (:hash (push token path-components)
 623                       (setq state 8))
 624                (:slash (push token path-components)
 625                        (setq state 6))
 626                (:string (failure))
 627                (:end (push token path-components)
 628                      (setq state 9)))))
 629           (3 ;; seen / or <scheme>:/
 630            (ecase (read-token t)
 631              (:colon (failure))
 632              (:question (push "/" path-components)
 633                         (setq state 7))
 634              (:hash (push "/" path-components)
 635                     (setq state 8))
 636              (:slash (setq state 4))
 637              (:string (push "/" path-components)
 638                       (push tokval path-components)
 639                       (setq state 6))
 640              (:end (push "/" path-components)
 641                    (setq state 9))))
 642           (4 ;; seen [<scheme>:]//
 643            (ecase (read-token t)
 644              (:colon (failure))
 645              (:question (failure))
 646              (:hash (failure))
 647              (:slash
 648               (if* (and (equalp "file" scheme)
 649                         (null host))
 650                  then ;; file:///...
 651                       (push "/" path-components)
 652                       (setq state 6)
 653                  else (failure)))
 654              (:string (setq host tokval)
 655                       (setq state 11))
 656              (:end (failure))))
 657           (11 ;; seen [<scheme>:]//<host>
 658            (ecase (read-token t)
 659              (:colon (setq state 5))
 660              (:question (setq state 7))
 661              (:hash (setq state 8))
 662              (:slash (push "/" path-components)
 663                      (setq state 6))
 664              (:string (impossible))
 665              (:end (setq state 9))))
 666           (5 ;; seen [<scheme>:]//<host>:
 667            (ecase (read-token t)
 668              (:colon (failure))
 669              (:question (failure))
 670              (:hash (failure))
 671              (:slash (push "/" path-components)
 672                      (setq state 6))
 673              (:string (setq port tokval)
 674                       (setq state 12))
 675              (:end (failure))))
 676           (12 ;; seen [<scheme>:]//<host>:[<port>]
 677            (ecase (read-token t)
 678              (:colon (failure))
 679              (:question (setq state 7))
 680              (:hash (setq state 8))
 681              (:slash (push "/" path-components)
 682                      (setq state 6))
 683              (:string (impossible))
 684              (:end (setq state 9))))
 685           (6 ;; seen /
 686            (ecase (read-token :path)
 687              (:question (setq state 7))
 688              (:hash (setq state 8))
 689              (:string (push tokval path-components)
 690                       (setq state 13))
 691              (:end (setq state 9))))
 692           (13 ;; seen path
 693            (ecase (read-token :path)
 694              (:question (setq state 7))
 695              (:hash (setq state 8))
 696              (:string (impossible))
 697              (:end (setq state 9))))
 698           (7 ;; seen ?
 699            (setq illegal-chars
 700              (if* *strict-parse*
 701                 then *strict-illegal-query-characters*
 702                 else *illegal-query-characters*))
 703            (ecase (prog1 (read-token :query)
 704                     (setq illegal-chars *illegal-characters*))
 705              (:hash (setq state 8))
 706              (:string (setq query tokval)
 707                       (setq state 14))
 708              (:end (setq state 9))))
 709           (14 ;; query
 710            (ecase (read-token :query)
 711              (:hash (setq state 8))
 712              (:string (impossible))
 713              (:end (setq state 9))))
 714           (8 ;; seen #
 715            (ecase (read-token :rest)
 716              (:string (setq fragment tokval)
 717                       (setq state 9))
 718              (:end (setq state 9))))
 719           (9 ;; done
 720            (return
 721              (values
 722               scheme host port
 723               (apply #'concatenate 'string (nreverse path-components))
 724               query fragment)))
 725           ;; URN parsing:
 726           (15 ;; seen urn:, read nid now
 727            (case (read-token :colon *valid-nid-characters*)
 728              (:string (setq nid tokval)
 729                       (setq state 16))
 730              (t (failure "missing namespace identifier"))))
 731           (16 ;; seen urn:<nid>
 732            (case (read-token t)
 733              (:colon (setq state 17))
 734              (t (failure "missing namespace specific string"))))
 735           (17 ;; seen urn:<nid>:, rest is nss
 736            (return (values scheme
 737                            nid
 738                            nil
 739                            (progn
 740                              (setq illegal-chars *reserved-nss-characters*)
 741                              (read-token :rest)
 742                              tokval))))
 743           (t (.parse-error
 744               "internal error in parse engine, wrong state: ~s." state)))))))
 745
 746 (defun escape-p (string)
 747   (declare (optimize (speed 3)))
 748   (do* ((i 0 (1+ i))
 749         (max (the fixnum (length string))))
 750       ((= i max) nil)
 751     (declare (fixnum i max))
 752     (when (char= #\% (char string i))
 753       (return t))))
 754
 755 (defun parse-path (path-string escape)
 756   (do* ((xpath-list (delimited-string-to-list path-string #\/))
 757         (path-list
 758          (progn
 759            (if* (string= "" (car xpath-list))
 760               then (setf (car xpath-list) :absolute)
 761               else (push :relative xpath-list))
 762            xpath-list))
 763         (pl (cdr path-list) (cdr pl))
 764         segments)
 765       ((null pl) path-list)
 766
 767     (if* (cdr (setq segments
 768                 (if* (string= "" (car pl))
 769                    then '("")
 770                    else (delimited-string-to-list (car pl) #\;))))
 771        then ;; there is a param
 772             (setf (car pl)
 773               (mapcar #'(lambda (s)
 774                           (decode-escaped-encoding s escape
 775                                                    ;; decode all %xx:
 776                                                    nil))
 777                       segments))
 778        else ;; no param
 779             (setf (car pl)
 780               (decode-escaped-encoding (car segments) escape
 781                                        ;; decode all %xx:
 782                                        nil)))))
 783
 784 (defun decode-escaped-encoding (string escape
 785                                 &optional (reserved-chars
 786                                            *reserved-characters*))
 787   ;;Return a string with the real characters.
 788   (when (null escape) (return-from decode-escaped-encoding string))
 789
 790   (let ((curpos 0)
 791         (maxpos (length string))
 792         (strs nil))
 793     (flet ((next-ansii-substring ()
 794              (let ((pos (or (position #\% string :start curpos)
 795                             maxpos)))
 796                (when (and (= curpos 0)
 797                           (= pos maxpos))
 798                  (return-from decode-escaped-encoding string))
 799                (when (< curpos pos)
 800                  (push (subseq string
 801                                curpos
 802                                pos)
 803                        strs)
 804                  (setf curpos pos))))
 805            (next-encoded-substring ()
 806              (let ((pos (or (loop for i from curpos below maxpos by 3
 807                                unless (char= (aref string i)
 808                                              #\%)
 809                                return i)
 810                             maxpos)))
 811                (when (< curpos pos)
 812                  (let ((octets (handler-case (make-array (/ (- pos curpos)
 813                                                             3)
 814                                                          :element-type '(unsigned-byte 8)
 815                                                          :fill-pointer 0)
 816                                  (error ()
 817                                    (.parse-error "Unsyntactic escaped encoding in ~s." string)))))
 818                    (loop for i from curpos below pos by 3
 819                       do (vector-push (handler-case
 820                                           (parse-integer string
 821                                                          :start (1+ i)
 822                                                          :end (+ i 3)
 823                                                          :radix 16)
 824                                         (error ()
 825                                           (.parse-error "Non-hexidecimal digits after %: ~c~c."
 826                                                         (aref string  (1+ i))
 827                                                         (aref string (+ 2 i)))))
 828                                       octets))
 829
 830                    (let* ((decoded-string (babel:octets-to-string octets
 831                                                                   :encoding :utf-8))
 832                           (rpos (if reserved-chars
 833                                     (position-if #'(lambda (ch)
 834                                                      (not (or (> (char-code ch) 127)
 835                                                               (= (sbit reserved-chars (char-code ch)) 0))))
 836                                                  decoded-string))))
 837                      (push (if rpos
 838                                (with-output-to-string (out)
 839                                  (loop for ch across decoded-string
 840                                     with i = curpos
 841                                     do (let ((code (char-code ch)))
 842                                          (cond
 843                                            ((or (null reserved-chars)
 844                                                 (> code 127)
 845                                                 (= (sbit reserved-chars code) 0))
 846                                             (write-char ch out)
 847                                             (incf i
 848                                                   (* (cond
 849                                                        ((< code #x80) 1)
 850                                                        ((< code #x800) 2)
 851                                                        ((< code #x10000) 3)
 852                                                        ((< code #x200000) 4)
 853                                                        ((< code #x4000000) 5)
 854                                                        (t 6))
 855                                                      3)))
 856                                            (t (write-string (subseq string i (+ i 3)) out)
 857                                               (incf i 3))))))
 858                                decoded-string)
 859                            strs))))
 860                    (setf curpos pos))))
 861       (loop
 862          while (< curpos maxpos)
 863          do (next-ansii-substring)
 864          while (< curpos maxpos)
 865          do (next-encoded-substring)))
 866     (if (cdr strs)
 867         (apply #'concatenate
 868                    'string
 869                    (nreverse strs))
 870         (or (car strs)
 871             ""))))
 872
 873
 874 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 875 ;;;; Printing
 876
 877 (defun render-uri (uri stream
 878                    &aux (escape (uri-escaped uri))
 879                         (*print-pretty* nil))
 880   (when (null (uri-string uri))
 881     (setf (uri-string uri)
 882       (let ((scheme (uri-scheme uri))
 883             (host (uri-host uri))
 884             (port (uri-port uri))
 885             (path (uri-path uri))
 886             (query (uri-query uri))
 887             (fragment (uri-fragment uri)))
 888         (concatenate 'string
 889           (when scheme
 890             (encode-escaped-encoding
 891              (string-downcase ;; for upper case lisps
 892               (symbol-name scheme))
 893              *reserved-characters* escape))
 894           (when scheme ":")
 895           (when (or host (eq :file scheme)) "//")
 896           (when host
 897             (encode-escaped-encoding
 898              host *reserved-authority-characters* escape))
 899           (when port ":")
 900           (when port
 901             #-allegro (format nil "~D" port)
 902             #+allegro (with-output-to-string (s)
 903                         (excl::maybe-print-fast s port))
 904             )
 905           (encode-escaped-encoding (or path "/")
 906                                    nil
 907                                    ;;*reserved-path-characters*
 908                                    escape)
 909           (when query "?")
 910           (when query (encode-escaped-encoding query nil escape))
 911           (when fragment "#")
 912           (when fragment (encode-escaped-encoding fragment nil escape))))))
 913   (if* stream
 914      then (format stream "~a" (uri-string uri))
 915      else (uri-string uri)))
 916
 917 (defun render-parsed-path (path-list escape)
 918   (do* ((res '())
 919         (first (car path-list))
 920         (pl (cdr path-list) (cdr pl))
 921         (pe (car pl) (car pl)))
 922       ((null pl)
 923        (when res (apply #'concatenate 'string (nreverse res))))
 924     (when (or (null first)
 925               (prog1 (eq :absolute first)
 926                 (setq first nil)))
 927       (push "/" res))
 928     (if* (atom pe)
 929        then (push
 930              (encode-escaped-encoding pe *reserved-path-characters* escape)
 931              res)
 932        else ;; contains params
 933             (push (encode-escaped-encoding
 934                    (car pe) *reserved-path-characters* escape)
 935                   res)
 936             (dolist (item (cdr pe))
 937               (push ";" res)
 938               (push (encode-escaped-encoding
 939                      item *reserved-path-characters* escape)
 940                     res)))))
 941
 942 (defun render-urn (urn stream
 943                    &aux (*print-pretty* nil))
 944   (when (null (uri-string urn))
 945     (setf (uri-string urn)
 946       (let ((nid (urn-nid urn))
 947             (nss (urn-nss urn)))
 948         (concatenate 'string "urn:" nid ":" nss))))
 949   (if* stream
 950      then (format stream "~a" (uri-string urn))
 951      else (uri-string urn)))
 952
 953 (defun encode-escaped-encoding (string reserved-chars escape)
 954   (when (null escape) (return-from encode-escaped-encoding string))
 955   (with-output-to-string (out)
 956     (loop for ch across string
 957        do (let ((code (char-code ch)))
 958             (if (and (< code 128)
 959                      (or (null reserved-chars)
 960                          (= 0 (sbit reserved-chars code))))
 961                 (write-char ch out)
 962                 (loop for octet across (babel:string-to-octets (string ch) :encoding :utf-8)
 963                    do (format out "%~(~2,'0x~)" octet)))))))
 964
 965 (defmethod print-object ((uri uri) stream)
 966   (if* *print-escape*
 967      then (print-unreadable-object (uri stream :type t) (render-uri uri stream))
 968      else (render-uri uri stream)))
 969
 970 (defmethod print-object ((urn urn) stream)
 971   (if* *print-escape*
 972      then (print-unreadable-object (urn stream :type t) (render-urn urn stream))
 973      else (render-urn urn stream)))
 974
 975 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 976 ;; merging and unmerging
 977
 978 (defmethod merge-uris ((uri string) (base string) &optional place)
 979   (merge-uris (parse-uri uri) (parse-uri base) place))
 980
 981 (defmethod merge-uris ((uri uri) (base string) &optional place)
 982   (merge-uris uri (parse-uri base) place))
 983
 984 (defmethod merge-uris ((uri string) (base uri) &optional place)
 985   (merge-uris (parse-uri uri) base place))
 986
 987
 988 (defmethod merge-uris ((uri uri) (base uri) &optional place)
 989   ;; See ../doc/rfc2396.txt for info on the algorithm we use to merge
 990   ;; URIs.
 991   ;;
 992   (tagbody
 993 ;;;; step 2
 994     (when (and (null (uri-parsed-path uri))
 995                (null (uri-scheme uri))
 996                (null (uri-host uri))
 997                (null (uri-port uri))
 998                (null (uri-query uri)))
 999       (return-from merge-uris
1000         (let ((new (copy-uri base :place place)))
1001           (when (uri-query uri)
1002             (setf (uri-query new) (uri-query uri)))
1003           (when (uri-fragment uri)
1004             (setf (uri-fragment new) (uri-fragment uri)))
1005           new)))
1006
1007     (setq uri (copy-uri uri :place place))
1008
1009 ;;;; step 3
1010     (when (uri-scheme uri)
1011       (return-from merge-uris uri))
1012     (setf (uri-scheme uri) (uri-scheme base))
1013
1014 ;;;; step 4
1015     (when (uri-host uri) (go :done))
1016     (setf (uri-host uri) (uri-host base))
1017     (setf (uri-port uri) (uri-port base))
1018
1019 ;;;; step 5
1020     (let ((p (uri-parsed-path uri)))
1021
1022       ;; bug13133:
1023       ;; The following form causes our implementation to be at odds with
1024       ;; RFC 2396, however this is apparently what was intended by the
1025       ;; authors of the RFC.  Specifically, (merge-uris "?y" "/foo")
1026       ;; should return #<uri /foo?y> instead of #<uri ?y>, according to
1027       ;; this:
1028 ;;; http://www.apache.org/~fielding/uri/rev-2002/issues.html#003-relative-query
1029       (when (null p)
1030         (setf (uri-path uri) (uri-path base))
1031         (go :done))
1032
1033       (when (and p (eq :absolute (car p)))
1034         (when (equal '(:absolute "") p)
1035           ;; Canonicalize the way parsing does:
1036           (setf (uri-path uri) nil))
1037         (go :done)))
1038
1039 ;;;; step 6
1040     (let* ((base-path
1041             (or (uri-parsed-path base)
1042                 ;; needed because we canonicalize away a path of just `/':
1043                 '(:absolute "")))
1044            (path (uri-parsed-path uri))
1045            new-path-list)
1046       (when (not (eq :absolute (car base-path)))
1047         (error "Cannot merge ~a and ~a, since latter is not absolute."
1048                uri base))
1049
1050       ;; steps 6a and 6b:
1051       (setq new-path-list
1052         (append (butlast base-path)
1053                 (if* path then (cdr path) else '(""))))
1054
1055       ;; steps 6c and 6d:
1056       (let ((last (last new-path-list)))
1057         (if* (atom (car last))
1058            then (when (string= "." (car last))
1059                   (setf (car last) ""))
1060            else (when (string= "." (caar last))
1061                   (setf (caar last) ""))))
1062       (setq new-path-list
1063         (delete "." new-path-list :test #'(lambda (a b)
1064                                             (if* (atom b)
1065                                                then (string= a b)
1066                                                else nil))))
1067
1068       ;; steps 6e and 6f:
1069       (let ((npl (cdr new-path-list))
1070             index tmp fix-tail)
1071         (setq fix-tail
1072           (string= ".." (let ((l (car (last npl))))
1073                           (if* (atom l)
1074                              then l
1075                              else (car l)))))
1076         (loop
1077           (setq index
1078             (position ".." npl
1079                       :test #'(lambda (a b)
1080                                 (string= a
1081                                          (if* (atom b)
1082                                             then b
1083                                             else (car b))))))
1084           (when (null index) (return))
1085           (when (= 0 index)
1086             ;; The RFC says, in 6g, "that the implementation may handle
1087             ;; this error by retaining these components in the resolved
1088             ;; path, by removing them from the resolved path, or by
1089             ;; avoiding traversal of the reference."  The examples in C.2
1090             ;; imply that we should do the first thing (retain them), so
1091             ;; that's what we'll do.
1092             (return))
1093           (if* (= 1 index)
1094              then (setq npl (cddr npl))
1095              else (setq tmp npl)
1096                   (dotimes (x (- index 2)) (setq tmp (cdr tmp)))
1097                   (setf (cdr tmp) (cdddr tmp))))
1098         (setf (cdr new-path-list) npl)
1099         (when fix-tail (setq new-path-list (nconc new-path-list '("")))))
1100
1101       ;; step 6g:
1102       ;; don't complain if new-path-list starts with `..'.  See comment
1103       ;; above about this step.
1104
1105       ;; step 6h:
1106       (when (or (equal '(:absolute "") new-path-list)
1107                 (equal '(:absolute) new-path-list))
1108         (setq new-path-list nil))
1109       (setf (uri-path uri)
1110         (render-parsed-path new-path-list
1111                             ;; don't know, so have to assume:
1112                             t)))
1113
1114 ;;;; step 7
1115    :done
1116     (return-from merge-uris uri)))
1117
1118 (defmethod enough-uri ((uri string) (base string) &optional place)
1119   (enough-uri (parse-uri uri) (parse-uri base) place))
1120
1121 (defmethod enough-uri ((uri uri) (base string) &optional place)
1122   (enough-uri uri (parse-uri base) place))
1123
1124 (defmethod enough-uri ((uri string) (base uri) &optional place)
1125   (enough-uri (parse-uri uri) base place))
1126
1127 (defmethod enough-uri ((uri uri) (base uri) &optional place)
1128   (let ((new-scheme nil)
1129         (new-host nil)
1130         (new-port nil)
1131         (new-parsed-path nil))
1132
1133     (when (or (and (uri-scheme uri)
1134                    (not (equalp (uri-scheme uri) (uri-scheme base))))
1135               (and (uri-host uri)
1136                    (not (equalp (uri-host uri) (uri-host base))))
1137               (not (equalp (uri-port uri) (uri-port base))))
1138       (return-from enough-uri uri))
1139
1140     (when (null (uri-host uri))
1141       (setq new-host (uri-host base)))
1142     (when (null (uri-port uri))
1143       (setq new-port (uri-port base)))
1144
1145     (when (null (uri-scheme uri))
1146       (setq new-scheme (uri-scheme base)))
1147
1148     ;; Now, for the hard one, path.
1149     ;; We essentially do here what enough-namestring does.
1150     (do* ((base-path (uri-parsed-path base))
1151           (path (uri-parsed-path uri))
1152           (bp base-path (cdr bp))
1153           (p path (cdr p)))
1154         ((or (null bp) (null p))
1155          ;; If p is nil, that means we have something like
1156          ;; (enough-uri "/foo/bar" "/foo/bar/baz.htm"), so
1157          ;; new-parsed-path will be nil.
1158          (when (null bp)
1159            (setq new-parsed-path (copy-list p))
1160            (when (not (symbolp (car new-parsed-path)))
1161              (push :relative new-parsed-path))))
1162       (if* (equal (car bp) (car p))
1163          thenret ;; skip it
1164          else (setq new-parsed-path (copy-list p))
1165               (when (not (symbolp (car new-parsed-path)))
1166                 (push :relative new-parsed-path))
1167               (return)))
1168
1169     (let ((new-path
1170            (when new-parsed-path
1171              (render-parsed-path new-parsed-path
1172                                  ;; don't know, so have to assume:
1173                                  t)))
1174           (new-query (uri-query uri))
1175           (new-fragment (uri-fragment uri))
1176           (new-plist (copy-list (uri-plist uri))))
1177       (if* (and (null new-scheme)
1178                 (null new-host)
1179                 (null new-port)
1180                 (null new-path)
1181                 (null new-parsed-path)
1182                 (null new-query)
1183                 (null new-fragment))
1184          then ;; can't have a completely empty uri!
1185               (copy-uri nil
1186                         :class (class-of uri)
1187                         :place place
1188                         :path "/"
1189                         :plist new-plist)
1190          else (copy-uri nil
1191                         :class (class-of uri)
1192                         :place place
1193                         :scheme new-scheme
1194                         :host new-host
1195                         :port new-port
1196                         :path new-path
1197                         :parsed-path new-parsed-path
1198                         :query new-query
1199                         :fragment new-fragment
1200                         :plist new-plist)))))
1201
1202 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1203 ;; support for interning URIs
1204
1205 (defun make-uri-space (&rest keys &key (size 777) &allow-other-keys)
1206   #+allegro
1207   (apply #'make-hash-table :size size
1208          :hash-function 'uri-hash
1209          :test 'uri= :values nil keys)
1210   #-allegro
1211   (apply #'make-hash-table :size size keys))
1212
1213 (defun gethash-uri (uri table)
1214   #+allegro (gethash uri table)
1215   #-allegro
1216   (let* ((hash (uri-hash uri))
1217          (existing (gethash hash table)))
1218     (dolist (u existing)
1219       (when (uri= u uri)
1220         (return-from gethash-uri (values u t))))
1221     (values nil nil)))
1222
1223 (defun puthash-uri (uri table)
1224   #+allegro (excl:puthash-key uri table)
1225   #-allegro
1226   (let ((existing (gethash (uri-hash uri) table)))
1227     (dolist (u existing)
1228       (when (uri= u uri)
1229         (return-from puthash-uri u)))
1230     (setf (gethash (uri-hash uri) table)
1231       (cons uri existing))
1232     uri))
1233
1234
1235 (defun uri-hash (uri)
1236   (if* (uri-hashcode uri)
1237      thenret
1238      else (setf (uri-hashcode uri)
1239                 (sxhash
1240                  #+allegro
1241                  (render-uri uri nil)
1242                  #-allegro
1243                  (string-downcase
1244                   (render-uri uri nil))))))
1245
1246 (defvar *uris* (make-uri-space))
1247
1248 (defun uri-space () *uris*)
1249
1250 (defun (setf uri-space) (new-val)
1251   (setq *uris* new-val))
1252
1253 ;; bootstrapping (uri= changed from function to method):
1254 (when (fboundp 'uri=) (fmakunbound 'uri=))
1255
1256 (defgeneric uri= (uri1 uri2))
1257 (defmethod uri= ((uri1 uri) (uri2 uri))
1258   (when (not (eq (uri-scheme uri1) (uri-scheme uri2)))
1259     (return-from uri= nil))
1260   ;; RFC2396 says: a URL with an explicit ":port", where the port is
1261   ;; the default for the scheme, is the equivalent to one where the
1262   ;; port is elided.  Hmmmm.  This means that this function has to be
1263   ;; scheme dependent.  Grrrr.
1264   (let ((default-port (case (uri-scheme uri1)
1265                         (:http 80)
1266                         (:https 443)
1267                         (:ftp 21)
1268                         (:telnet 23))))
1269     (and (equalp (uri-host uri1) (uri-host uri2))
1270          (eql (or (uri-port uri1) default-port)
1271               (or (uri-port uri2) default-port))
1272          (string= (uri-path uri1) (uri-path uri2))
1273          (string= (uri-query uri1) (uri-query uri2))
1274          (string= (uri-fragment uri1) (uri-fragment uri2)))))
1275
1276 (defmethod uri= ((urn1 urn) (urn2 urn))
1277   (when (not (eq (uri-scheme urn1) (uri-scheme urn2)))
1278     (return-from uri= nil))
1279   (and (equalp (urn-nid urn1) (urn-nid urn2))
1280        (urn-nss-equal (urn-nss urn1) (urn-nss urn2))))
1281
1282 (defun urn-nss-equal (nss1 nss2 &aux len)
1283   ;; Return t iff the nss values are the same.
1284   ;; %2c and %2C are equivalent.
1285   (when (or (null nss1) (null nss2)
1286             (not (= (setq len (length nss1))
1287                     (length nss2))))
1288     (return-from urn-nss-equal nil))
1289   (do* ((i 0 (1+ i))
1290         (state :char)
1291         c1 c2)
1292       ((= i len) t)
1293     (setq c1 (char nss1 i))
1294     (setq c2 (char nss2 i))
1295     (ecase state
1296       (:char
1297        (if* (and (char= #\% c1) (char= #\% c2))
1298           then (setq state :percent+1)
1299         elseif (char/= c1 c2)
1300           then (return nil)))
1301       (:percent+1
1302        (when (char-not-equal c1 c2) (return nil))
1303        (setq state :percent+2))
1304       (:percent+2
1305        (when (char-not-equal c1 c2) (return nil))
1306        (setq state :char)))))
1307
1308 (defmethod intern-uri ((xuri uri) &optional (uri-space *uris*))
1309   (let ((uri (gethash-uri xuri uri-space)))
1310     (if* uri
1311        thenret
1312        else (puthash-uri xuri uri-space))))
1313
1314 (defmethod intern-uri ((uri string) &optional (uri-space *uris*))
1315   (intern-uri (parse-uri uri) uri-space))
1316
1317 (defun unintern-uri (uri &optional (uri-space *uris*))
1318   (if* (eq t uri)
1319      then (clrhash uri-space)
1320    elseif (uri-p uri)
1321      then (remhash uri uri-space)
1322      else (error "bad uri: ~s." uri)))
1323
1324 (defmacro do-all-uris ((var &optional uri-space result-form)
1325                        &rest forms
1326                        &environment env)
1327   "do-all-uris (var [[uri-space] result-form])
1328                     {declaration}* {tag | statement}*
1329 Executes the forms once for each uri with var bound to the current uri"
1330   (let ((f (gensym))
1331         (g-ignore (gensym))
1332         (g-uri-space (gensym))
1333         (body (third (parse-body forms env))))
1334     `(let ((,g-uri-space (or ,uri-space *uris*)))
1335        (prog nil
1336          (flet ((,f (,var &optional ,g-ignore)
1337                   (declare (ignore-if-unused ,var ,g-ignore))
1338                   (tagbody ,@body)))
1339            (maphash #',f ,g-uri-space))
1340          (return ,result-form)))))
1341
1342 (defun sharp-u (stream chr arg)
1343   (declare (ignore chr arg))
1344   (let ((arg (read stream nil nil t)))
1345     (if *read-suppress*
1346         nil
1347       (if* (stringp arg)
1348          then (parse-uri arg)
1349          else
1350
1351          (internal-reader-error
1352           stream
1353           "#u takes a string or list argument: ~s" arg)))))
1354
1355
1356 (set-dispatch-macro-character #\# #\u #'puri::sharp-u)
1357
1358 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1359
1360 (provide :uri)
1361
1362 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1363 ;; timings
1364 ;; (don't run under emacs with M-x fi:common-lisp)
1365
1366 #+allegro
1367 (eval-when (:compile-toplevel :load-toplevel :execute)
1368   (import 'excl::gc))
1369
1370 #-allegro
1371 (defun gc (&rest options)
1372   (declare (ignore options))
1373   #+sbcl (sb-ext::gc)
1374   #+cmu (ext::gc)
1375   )
1376
1377 (defun time-uri-module ()
1378   (declare (optimize (speed 3) (safety 0) (debug 0)))
1379   (let ((uri "http://www.franz.com/a/b;x;y;z/c/foo?bar=baz&xxx#foo")
1380         (uri2 "http://www.franz.com/a/b;x;y;z/c/%2ffoo?bar=baz&xxx#foo"))
1381     (gc t) (gc :tenure) (gc :tenure) (gc :tenure)
1382     (format t "~&;;; starting timing testing 1...~%")
1383     (time (dotimes (i 100000) (parse-uri uri)))
1384
1385     (gc t) (gc :tenure) (gc :tenure) (gc :tenure)
1386     (format t "~&;;; starting timing testing 2...~%")
1387     (let ((uri (parse-uri uri)))
1388       (time (dotimes (i 100000)
1389               ;; forces no caching of the printed representation:
1390               (setf (uri-string uri) nil)
1391               (format nil "~a" uri))))
1392
1393     (gc t) (gc :tenure) (gc :tenure) (gc :tenure)
1394     (format t "~&;;; starting timing testing 3...~%")
1395     (time
1396      (progn
1397        (dotimes (i 100000) (parse-uri uri2))
1398        (let ((uri (parse-uri uri)))
1399          (dotimes (i 100000)
1400            ;; forces no caching of the printed representation:
1401            (setf (uri-string uri) nil)
1402            (format nil "~a" uri)))))))
1403
1404 ;;******** reference output (ultra, modified 5.0.1):
1405 ;;; starting timing testing 1...
1406 ; cpu time (non-gc) 13,710 msec user, 0 msec system
1407 ; cpu time (gc)     600 msec user, 10 msec system
1408 ; cpu time (total)  14,310 msec user, 10 msec system
1409 ; real time  14,465 msec
1410 ; space allocation:
1411 ;  1,804,261 cons cells, 7 symbols, 41,628,832 other bytes, 0 static bytes
1412 ;;; starting timing testing 2...
1413 ; cpu time (non-gc) 27,500 msec user, 0 msec system
1414 ; cpu time (gc)     280 msec user, 20 msec system
1415 ; cpu time (total)  27,780 msec user, 20 msec system
1416 ; real time  27,897 msec
1417 ; space allocation:
1418 ;  1,900,463 cons cells, 0 symbols, 17,693,712 other bytes, 0 static bytes
1419 ;;; starting timing testing 3...
1420 ; cpu time (non-gc) 52,290 msec user, 10 msec system
1421 ; cpu time (gc)     1,290 msec user, 30 msec system
1422 ; cpu time (total)  53,580 msec user, 40 msec system
1423 ; real time  54,062 msec
1424 ; space allocation:
1425 ;  7,800,205 cons cells, 0 symbols, 81,697,496 other bytes, 0 static bytes
1426
1427 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1428 ;;; after improving decode-escaped-encoding/encode-escaped-encoding:
1429
1430 ;;; starting timing testing 1...
1431 ; cpu time (non-gc) 14,520 msec user, 0 msec system
1432 ; cpu time (gc)     400 msec user, 0 msec system
1433 ; cpu time (total)  14,920 msec user, 0 msec system
1434 ; real time  15,082 msec
1435 ; space allocation:
1436 ;  1,800,270 cons cells, 0 symbols, 41,600,160 other bytes, 0 static bytes
1437 ;;; starting timing testing 2...
1438 ; cpu time (non-gc) 27,490 msec user, 10 msec system
1439 ; cpu time (gc)     300 msec user, 0 msec system
1440 ; cpu time (total)  27,790 msec user, 10 msec system
1441 ; real time  28,025 msec
1442 ; space allocation:
1443 ;  1,900,436 cons cells, 0 symbols, 17,693,712 other bytes, 0 static bytes
1444 ;;; starting timing testing 3...
1445 ; cpu time (non-gc) 47,900 msec user, 20 msec system
1446 ; cpu time (gc)     920 msec user, 10 msec system
1447 ; cpu time (total)  48,820 msec user, 30 msec system
1448 ; real time  49,188 msec
1449 ; space allocation:
1450 ;  3,700,215 cons cells, 0 symbols, 81,707,144 other bytes, 0 static bytes