1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
|
;;;; -*- Mode: Lisp -*-
;;;; Author: Matthew Danish <mrd@debian.org>
;;;; See LICENSE file for copyright details.
;;;; FTP client functionality
#+allegro
(eval-when (:compile-toplevel :load-toplevel :execute)
(require :sock)) ; just in case
(defpackage #:org.mapcar.ftp.client
(:use #:common-lisp #:socket #:split-sequence)
(:nicknames #:ftp.client #:ftp)
(:export #:ftp-connection
#:with-ftp-connection
#:connect-to-server
#:close-connection
#:send-list-command
#:send-nlst-command
#:with-transfer-socket
#:call-with-transfer-socket
#:ftp-error
#:invalid-code
#:transient-negative-completion
#:permanent-negative-completion
#:ftp-error-code
#:error-message
#:expected
#:received
#:passive-ftp-p
#:code-cut-off-p
#:ftp-hostname
#:ftp-port
#:ftp-username
#:ftp-password
#:ftp-session-stream
#:data-to-string
#:retrieve-file
#:store-file
#:receive-response
#:data-ready-p
#:retrieve-filename-list
#:retrieve-file-info-list))
(in-package #:org.mapcar.ftp.client)
(eval-when (:compile-toplevel :load-toplevel :execute)
(define-condition ftp-error ()
((ftp-error-code :initarg :ftp-error-code
:initform "\"unspecified\""
:reader ftp-error-code)
(error-message :initarg :error-message
:initform "\"unspecified\""
:reader error-message))
(:report (lambda (c s)
(format s "FTP error ~A raised: ~A"
(ftp-error-code c)
(error-message c)))))
(define-condition invalid-code (ftp-error)
((expected :reader expected :initarg :expected)
(received :reader received :initarg :received))
(:report (lambda (c s)
(format s "Expected FTP code ~A, got FTP code ~A"
(expected c)
(received c)))))
(define-condition transient-negative-completion (ftp-error)
()
(:report (lambda (c s)
(format s "Received transient error code ~A: ~A"
(ftp-error-code c)
(error-message c)))))
(define-condition permanent-negative-completion (ftp-error)
()
(:report (lambda (c s)
(format s "Received permanent error code ~A: ~A"
(ftp-error-code c)
(error-message c)))))
(defclass ftp-connection ()
((hostname :initarg :hostname
:reader ftp-hostname)
(port :initarg :port :initform 21
:reader ftp-port)
(username :initarg :username :initform "anonymous"
:reader ftp-username)
(password :initarg :password :initform "cl-ftp@cclan.net"
:reader ftp-password)
(session-stream :initarg :session-stream :initform nil
:reader ftp-session-stream)
(passive-ftp-p :initarg :passive-ftp-p :initform nil
:accessor passive-ftp-p)
(code-cut-off-p :initarg :code-cut-off-p :initform t
:accessor code-cut-off-p)
(socket))))
(defmacro with-ftp-connection-slots ((conn) &body body)
`(with-slots (socket hostname port username password session-stream passive-ftp-p code-cut-off-p) ,conn
,@body))
(defmethod print-object ((obj ftp-connection) stream)
(with-ftp-connection-slots (obj)
(print-unreadable-object (obj stream)
(format stream "FTP connection to ~A:~A username: ~A"
hostname port username))))
(defun raise-ftp-error (error-code error-msg &key (expected-code nil))
(cond ((and (>= error-code 400)
(< error-code 500))
(error 'transient-negative-completion
:ftp-error-code error-code
:error-message error-msg))
((and (>= error-code 500)
(< error-code 600))
(error 'permanent-negative-completion
:ftp-error-code error-code
:error-message error-msg))
(expected-code
(error 'invalid-code
:expected expected-code
:received error-code
:ftp-error-code error-code
:error-message error-msg))
(t
(error 'ftp-error
:ftp-error-code error-code
:error-message error-msg))))
(defun data-to-string (data)
(format nil "~{~A~%~}" data))
(defmethod expect-code-or-lose ((conn ftp-connection) (expected-code integer))
(multiple-value-bind (data code)
(receive-response conn :block t)
(unless (eql code expected-code)
(raise-ftp-error code (data-to-string data)
:expected-code expected-code))
data))
(defmethod initialize-instance :after ((conn ftp-connection) &rest initargs)
(declare (ignorable initargs))
(connect-to-server conn))
(defmethod connect-to-server ((conn ftp-connection))
(with-ftp-connection-slots (conn)
(unless (and hostname port (integerp port) (stringp hostname))
(error "You must specify a hostname string and an integer port"))
(when (and (slot-boundp conn 'socket) (streamp socket))
(close socket))
(setf socket (make-socket :remote-host hostname :remote-port port))
(unless socket
(error "Error connecting to ~A:~A" hostname port))
(when (and username password (stringp username) (stringp password))
(expect-code-or-lose conn 220)
(send-raw-line conn
(format nil "USER ~A" username))
(expect-code-or-lose conn 331)
(send-raw-line conn
(format nil "PASS ~A" password))
(expect-code-or-lose conn 230))
(values)))
(defmacro with-ftp-connection ((conn &key hostname port username password passive-ftp-p session-stream (code-cut-off-p t code-cut-off-p-p) (if-failed :error)) &body body)
`(let ((,conn (make-instance 'ftp-connection
,@(if hostname `(:hostname ,hostname) ())
,@(if port `(:port ,port) ())
,@(if username `(:username ,username) ())
,@(if password `(:password ,password) ())
,@(if passive-ftp-p
`(:passive-ftp-p ,passive-ftp-p) ())
,@(if session-stream
`(:session-stream ,session-stream) ())
,@(if code-cut-off-p-p
`(:code-cut-off-p ,code-cut-off-p) ()))))
(if (null ,conn)
(if (eql ,if-failed :error)
(error "Connection to ~A:~A failed" ,hostname ,port)
,if-failed)
(unwind-protect (progn ,@body)
(close-connection ,conn)))))
(defmethod log-session ((conn ftp-connection) (data string))
(with-ftp-connection-slots (conn)
(when (and session-stream (streamp session-stream))
(write-string data session-stream))
(values)))
(defmethod log-session ((conn ftp-connection) (data list))
(log-session conn (data-to-string data)))
(defmethod close-connection ((conn ftp-connection))
(with-ftp-connection-slots (conn)
(close socket)))
(defmethod send-raw-line ((conn ftp-connection) (line string))
(with-ftp-connection-slots (conn)
(let ((line (format nil "~A~C~C" line #\Return #\Newline)))
(log-session conn line)
(write-string line socket))
(force-output socket)
(values)))
(defmethod data-ready-p ((conn ftp-connection))
(with-ftp-connection-slots (conn)
(listen socket)))
(defun clean-ftp-response (data)
(mapcar #'(lambda (line)
(string-trim '(#\Return #\Newline)
line))
data))
(defun maybe-cut-off-code (cut-off-p data code)
(if cut-off-p
data
(mapcar #'(lambda (x)
(if (and (> (length x) 3)
(eql (parse-integer x :end 3 :junk-allowed t)
code))
(subseq x 4)
x))
data)))
(defmethod receive-response ((conn ftp-connection) &key (block nil))
(with-ftp-connection-slots (conn)
(when (and (not block) (not (data-ready-p conn)))
(return-from receive-response nil))
(let* ((initial-line (read-line socket))
(ftp-code (parse-integer initial-line :end 3))
(continue-p (char= (char initial-line 3) #\-))
(lines (list (if code-cut-off-p
(subseq initial-line 4)
initial-line))))
(loop while continue-p do
(let* ((line (read-line socket))
(line-length (length line))
(line-code (when (> line-length 3)
(parse-integer line :end 3
:junk-allowed t))))
(push (if (and code-cut-off-p (eql line-code ftp-code))
(subseq line 4);; cut-off the code, if present
line)
lines)
;; continue until reaching a line that begins with the code
;; and has a #\Space after it
(when (and (eql line-code ftp-code)
(char= #\Space (char line 3)))
(setf continue-p nil))))
(let ((data (clean-ftp-response (nreverse lines))))
(log-session conn data)
(values (maybe-cut-off-code code-cut-off-p data ftp-code)
ftp-code)))))
(defmethod send-port-command ((conn ftp-connection) (ip string) (port-num integer))
(multiple-value-bind (quot rem)
(truncate port-num 256)
(send-raw-line conn
(format nil "PORT ~A,~A,~A"
(substitute #\, #\. ip) quot rem))))
(defmethod receive-pasv-response ((conn ftp-connection))
(with-ftp-connection-slots (conn)
(multiple-value-bind (data code)
(receive-response conn :block t)
(unless (eql code 227)
(raise-ftp-error code (data-to-string data)
:expected-code 227))
(let ((start (position #\( (first data) :from-end t))
(end (position #\) (first data) :from-end t)))
(unless (and start end)
(error "Unable to parse PASV response"))
(let ((numbers (split-sequence #\, (first data)
:start (1+ start)
:end end)))
(values (format nil "~{~A~^.~}"
(subseq numbers 0 4))
(+ (ash (parse-integer (fifth numbers)) 8)
(parse-integer (sixth numbers)))))))))
(defmethod setup-port ((conn ftp-connection) &key (format :binary))
(with-ftp-connection-slots (conn)
(let ((server-socket
(loop for p = (+ 1025 (random 10000))
for s = (ignore-errors
(make-socket :connect :passive
:local-port p
:format format))
when s return s))
(local-ip (ipaddr-to-dotted (local-host socket))))
(send-port-command conn local-ip (local-port server-socket))
server-socket)))
(defmethod establish-data-transfer ((conn ftp-connection) (command string) &key (rest nil) (type :binary))
(with-ftp-connection-slots (conn)
(send-raw-line conn (format nil "TYPE ~A"
(ecase type
((:binary :image) "I")
(:ascii "A"))))
(expect-code-or-lose conn 200)
(cond (passive-ftp-p
(send-raw-line conn "PASV")
(multiple-value-bind (dtp-hostname dtp-port)
(receive-pasv-response conn)
(let ((data-socket
(make-socket :remote-host dtp-hostname
:remote-port dtp-port
:format (ecase type
((:binary :image) :binary)
(:ascii :text)))))
(when (and rest (integerp rest))
(send-raw-line conn (format nil "REST ~A" rest)))
(send-raw-line conn command)
data-socket)))
(t
(let ((server-socket (setup-port conn
:format (ecase type
((:binary :image)
:binary)
(:ascii :text)))))
(unwind-protect
(progn
(when (and rest (integerp rest))
(send-raw-line conn (format nil "REST ~A" rest)))
(expect-code-or-lose conn 200)
(send-raw-line conn command)
(accept-connection server-socket))
(close server-socket)))))))
(defmethod flush-response ((conn ftp-connection))
(loop while (receive-response conn)))
(defmethod call-with-transfer-socket ((conn ftp-connection) (command string) (fn function) &rest args)
(flush-response conn)
(let ((transfer-socket (apply #'establish-data-transfer
conn command args)))
(unwind-protect
(funcall fn transfer-socket)
(progn
(close transfer-socket)
(loop
(multiple-value-bind (data code)
(receive-response conn :block t)
(declare (ignorable data))
(when (and (integerp code) (eql code 226))
(return-from call-with-transfer-socket t))
(when (and (integerp code) (>= code 500))
(return-from call-with-transfer-socket nil))))))))
(defmacro with-transfer-socket ((socket conn command &rest args) &body body)
`(call-with-transfer-socket ,conn ,command
#'(lambda (,socket) ,@body)
,@args))
(defmethod send-list-command ((conn ftp-connection) (output null) &optional (pathname "."))
(with-output-to-string (s)
(send-list-command conn s pathname)))
(defmethod send-list-command ((conn ftp-connection) (output t) &optional (pathname "."))
(send-list-command conn *standard-output* pathname))
(defmethod send-list-command ((conn ftp-connection) (output stream) &optional (pathname "."))
(flet ((read-all (s)
(loop (handler-case (write-line (read-line s) output)
(end-of-file () (return (values)))))))
(with-transfer-socket (s conn (format nil "LIST ~A" pathname)
:type :ascii)
(read-all s))))
(defmethod send-nlst-command ((conn ftp-connection) (output null) &optional (pathname "."))
(with-output-to-string (s)
(send-nlst-command conn s pathname)))
(defmethod send-nlst-command ((conn ftp-connection) (output t) &optional (pathname "."))
(send-nlst-command conn *standard-output* pathname))
(defmethod send-nlst-command ((conn ftp-connection) (output stream) &optional (pathname "."))
(flet ((read-all (s)
(loop (handler-case (write-line (read-line s) output)
(end-of-file () (return (values)))))))
(with-transfer-socket (s conn (format nil "NLST ~A" pathname)
:type :ascii)
(read-all s))))
(defmethod retrieve-filename-list ((conn ftp-connection) &optional (pathname "."))
(let* ((data (send-nlst-command conn nil pathname))
(split-data (split-sequence #\Newline data
:remove-empty-subseqs t)))
(mapcar #'(lambda (x) (string-trim '(#\Return) x)) split-data)))
(defmethod retrieve-file-info-list ((conn ftp-connection) &optional (pathname "."))
(let ((names (retrieve-filename-list conn pathname))
(file-info-list nil)
(orig-dir (send-pwd-command conn))
(base-dir nil))
(send-cwd-command conn pathname)
(setf base-dir (send-pwd-command conn))
(unwind-protect
(dolist (name names file-info-list)
(handler-case
(progn
(send-cwd-command conn name)
(push (list :directory name) file-info-list))
(ftp-error ()
(push (list :file name) file-info-list)))
(send-cwd-command conn base-dir))
(send-cwd-command conn orig-dir))))
(defmethod retrieve-file ((conn ftp-connection) (remote-filename string) local-filename &key (type :binary) (rest nil))
(with-open-file (local-stream local-filename
:direction :output
:element-type (ecase type
((:binary :image)
'(unsigned-byte 8))
(:ascii
'character)))
(retrieve-file conn remote-filename local-stream :type type :rest rest)))
(defmethod retrieve-file ((conn ftp-connection) (remote-filename string) (local-stream stream) &key (type :binary) (rest nil))
(with-transfer-socket (s conn (format nil "RETR ~A" remote-filename)
:type type :rest rest)
(handler-case
(ecase type
((:binary :image)
(loop (write-byte (read-byte s) local-stream)))
(:ascii
(loop (write-char (read-char s) local-stream))))
(end-of-file () (values)))))
(defmethod store-file ((conn ftp-connection) local-filename (remote-filename string) &key (type :binary) (rest nil))
(with-open-file (local-stream local-filename
:direction :input
:element-type (ecase type
((:binary :image)
'(unsigned-byte 8))
(:ascii
'character)))
(store-file conn local-stream remote-filename :type type :rest rest)))
(defmethod store-file ((conn ftp-connection) (local-stream stream) (remote-filename string) &key (type :binary) (rest nil))
(with-transfer-socket (s conn (format nil "STOR ~A" remote-filename)
:type type :rest rest)
(handler-case
(ecase type
((:binary :image)
(loop (write-byte (read-byte local-stream) s)))
(:ascii
(loop (write-char (read-char local-stream) s))))
(end-of-file () (values)))))
(defmacro def-simple-command (cmd (conn &rest args) &body body)
(let ((name (intern (format nil "SEND-~A-COMMAND" cmd))))
`(progn
(defmethod ,name ((,conn ftp-connection) ,@args)
(flush-response ,conn)
,@body)
(export ',name))))
(def-simple-command size (conn (remote-filename string))
(send-raw-line conn (format nil "SIZE ~A" remote-filename))
(parse-integer (first (expect-code-or-lose conn 213))))
(def-simple-command cwd (conn (remote-dir string))
(send-raw-line conn (if (string-equal remote-dir "..")
"CDUP"
(format nil "CWD ~A" remote-dir)))
(expect-code-or-lose conn 250))
(def-simple-command cdup (conn)
(send-raw-line conn "CDUP")
(expect-code-or-lose conn 250))
(defun parse-257-response (string)
(let ((start (1+ (position #\" string)))
(last (1- (length string))))
(with-output-to-string (out)
(do ((i start (1+ i)))
((>= i last) (values))
(if (char= (char string i) #\")
(cond ((char= (char string (1+ i)) #\")
(write-char #\" out)
(incf i))
(t (return (values))))
(write-char (char string i) out))))))
(def-simple-command pwd (conn)
(send-raw-line conn "PWD")
(parse-257-response
(data-to-string (expect-code-or-lose conn 257))))
(def-simple-command mkd (conn (dir-name string))
(send-raw-line conn (format nil "MKD ~A" dir-name))
(parse-257-response
(data-to-string (expect-code-or-lose conn 257))))
|