cgit.sxemacs.org Git - sxemacs/blob - lisp/ffi/ffi-curl.el

   1 ;;; ffi-curl.el --- Emacs interface to libcurl.
   2
   3 ;; Copyright (C) 2005-2009 by Zajcev Evgeny.
   4
   5 ;; Author: Zajcev Evgeny <zevlg@yandex.ru>
   6 ;; Keywords: ffi, curl, ftp
   7
   8 ;; This file is part of SXEmacs.
   9
  10 ;; SXEmacs is free software: you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation, either version 3 of the License, or
  13 ;; (at your option) any later version.
  14
  15 ;; SXEmacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22
  23 ;;; Synched up with: Not in FSF
  24
  25 ;;; Commentary:
  26
  27 ;;
  28
  29 ;;; Code:
  30 \f
  31 (require 'ffi)
  32 (require 'ffi-libc)
  33
  34 (ffi-load "libcurl")
  35
  36 ;;{{{ Low-level FFI: types and functions
  37
  38 (define-ffi-enum curl-option
  39   (:fstream 10001)                      ; FILE* stream to write to
  40   (:url 10002)                          ; full URL to get/put
  41   (:port 3)                             ; port number to connect to
  42   (:write-function 20011)
  43   (:read-function 20012)
  44   (:timeout 13)                         ; read timeout in seconds
  45   (:post-fields 10015)                  ; POST static input fields
  46   (:header 42)                          ; throw the header out too
  47   (:nobody 44)                          ; use HEAD to get http document
  48   (:post 47)                            ; HTTP POST method
  49   (:nosignal 99)
  50   )
  51
  52 (define-ffi-enum curl-info
  53   (:effective-url  #x100001)
  54   (:response-code  #x200002)
  55   (:header-size    #x20000b)
  56   (:content-type   #x100012)
  57   (:size-download  #x300008)
  58   (:speed-download #x300009))
  59
  60 (cffi:defcfun ("curl_easy_init" curl:curl_easy_init) pointer)
  61 (cffi:defcfun ("curl_easy_cleanup" curl:curl_easy_cleanup) void
  62   (handler pointer))
  63 (cffi:defcfun ("curl_easy_perform" curl:curl_easy_perform) int
  64   (handler pointer))
  65
  66 (cffi:defcfun ("curl_easy_setopt" curl:curl_easy_setopt) int
  67   (handler pointer) (opt curl-option) &rest)
  68 (cffi:defcfun ("curl_easy_getinfo" curl:curl_easy_getinfo) int
  69   (handler pointer) (info curl-info) &rest)
  70
  71 ;;}}}
  72 \f
  73 ;;{{{ Errors list
  74
  75 (defconst curl:errors-alist
  76   '((1 . "Unsupported protocol")
  77     (2 . "Failed init")
  78     (3 . "Malformated URL")
  79     (4 . "NOT USED")
  80     (5 . "Could not resolve proxy")
  81     (6 . "Could not resolve host")
  82     (7 . "Could not connect")
  83     (8 . "FTP weird server reply")
  84     (9 . "FTP access denied")
  85     (10 . "FTP user or password is incorrect")
  86     (11 . "FTP weird PASS reply")
  87     (12 . "FTP weird USER reply")
  88     (13 . "FTP weird PASV reply")
  89     (14 . "FTP weird 227 format")
  90     (15 . "FTP can't get host")
  91     (16 . "FTP can't reconnect")
  92     (17 . "FTP could not set binary")
  93     (18 . "partial file")
  94     (19 . "FTP could not RETR file")
  95     (20 . "FTP write error")
  96     (21 . "FTP quote error")
  97     (22 . "HTTP returned errror")
  98     (23 . "write error")
  99     (24 . "NOT USED")
 100     (25 . "failed FTP upload")
 101     (26 . "could open/read from file")
 102     (27 . "Out of memory")
 103     (28 . "the timeout time was reached")
 104     (29 . "TYPE A failed")
 105     (30 . "FTP PORT operation failed")
 106     (31 . "the REST command failed")
 107     (32 . "the SIZE command failed")
 108     (33 . "RANGE \"command\" didn't work")
 109     (34 . "HTTP port error")
 110     (35 . "wrong when connecting with SSL")
 111     (36 . "couldn't resume download")
 112     (37 . "FILE could not read file")
 113     (38 . "LDAP cannot bind")
 114     (39 . "LDAP search failed")
 115     (40 . "library not found")
 116     (41 . "function not found")
 117     (42 . "aborted by callback")
 118     (43 . "bad function argument")
 119     (44 . "NOT USED")
 120     (45 . "CURLOPT_INTERFACE failed")
 121     (46 . "NOT USED")
 122     (47 . "catch endless re-direct loops")
 123     (48 . "User specified an unknown option")
 124     (49 . "Malformed telnet option")
 125     (50 . "NOT USED")
 126     (51 . "peer's certificate wasn't ok")
 127     (52 . "when this is a specific error")
 128     (53 . "SSL crypto engine not found")
 129     (54 . "can not set SSL crypto engine as default")
 130     (55 . "failed sending network data")
 131     (56 . "failure in receiving network data")
 132     (57 . "share is in use")
 133     (58 . "problem with the local certificate")
 134     (59 . "couldn't use specified cipher")
 135     (60 . "problem with the CA cert (path?)")
 136     (61 . "Unrecognized transfer encoding")
 137     (62 . "Invalid LDAP URL")
 138     (63 . "Maximum file size exceeded")
 139     (64 . "Requested FTP SSL level failed"))
 140   "Alist of error codes and associated clear-text error messages.")
 141
 142 ;;}}}
 143 \f
 144 ;;{{{ High level API
 145
 146 (defun curl:easy-init ()
 147   "Initialize curl easy interface and return a context handle."
 148   (let ((ret (curl:curl_easy_init)))
 149     (when (ffi-null-p ret)
 150       (error "curl:easy-init: Can't init easy interface"))
 151     ret))
 152
 153 (defun curl:easy-cleanup (ctx)
 154   "Clean up context CTX and free resources allocated with it.
 155 This function must be called after every easy session."
 156   (curl:curl_easy_cleanup ctx)
 157   ;; Remove references to saved values
 158   (remprop ctx 'saved-values))
 159
 160 (defun curl:easy-setopt (ctx &rest options)
 161   "Set OPTIONS for curl transfer.
 162 Options are passed as keyword-value-pairs. Supported keywords are:
 163 :url string - a valid Uniform Resource Locator.
 164 :fstream ffi-fo - a file descriptor to which output is redirected."
 165   (while options
 166     (let ((option (car options))
 167           (value (cadr options))
 168           error)
 169       ;; Handle special cases in options
 170       (case option
 171         ((:url :post-fields)
 172          (unless (stringp value)
 173            (error 'invalid-argument
 174                   "curl:easy-setopt invalid option value(must be string)"
 175                   option value))
 176          (setq value (ffi-create-fo 'c-string value))
 177          ;; Keep reference to value until context is destroyed
 178          (push value (get ctx 'saved-values)))
 179
 180         ((:read-function :write-function)
 181          (setq value (ffi-callback-fo value)))
 182
 183         ((:nobody :header :post :nosignal)
 184          (setq value (ffi-create-fo 'int (if value 1 0)))))
 185
 186       (setq error (curl:curl_easy_setopt ctx option value))
 187       (unless (zerop error)
 188         (error 'invalid-operation "curl:easy-setopt error" error))
 189
 190       (setq options (cddr options)))))
 191
 192 (defun curl:easy-perform (ctx)
 193   "Perform cURL operation on the context CTX.
 194 To control the behaviour of the session or set options into the
 195 context, see `curl:easy-setopt'."
 196   (let ((err (curl:curl_easy_perform ctx)))
 197     (unless (zerop err)
 198       (error 'invalid-operation "curl:easy-perform error"
 199              (cdr (assq err curl:errors-alist))))
 200     err))
 201
 202 (defun curl:easy-perform& (ctx sentinel fs)
 203   "Perform cURL operation on CTX, return a worker job object.
 204 Afterwards run SENTINEL.
 205
 206 The original (curl) context CTX is stored in the plist of the worker job
 207 object with key 'ctx to keep it accessible."
 208   (if (featurep 'workers)
 209       (let* ((job (ffi-call-function&
 210                    (get 'curl:curl_easy_perform 'ffi-fun)
 211                    ctx sentinel fs ctx)))
 212         ;; add ctx to plist of job
 213         (put job 'ctx ctx)
 214         job)
 215     (error 'unimplemented "Asynchronous Event Queues")))
 216
 217 (defun curl:easy-perform-sentinel (job fs ctx)
 218   (curl:easy-cleanup ctx)
 219   (unless (car fs) (c:fclose (cdr fs)))
 220   (run-hook-with-args 'curl:download&-post-hook job))
 221
 222 (defun curl:easy-getinfo (ctx what)
 223   "Get info from the context CTX about WHAT."
 224   (let* ((ival (cdr (assq what (ffi-enum-values 'curl-info))))
 225          (itype (if (not (numberp ival))
 226                     (error "Unsupported info" what)
 227                   (ecase (lsh (logand #xf00000 ival) -20)
 228                     (1 'c-string) (2 'long) (3 'double))))
 229          (retfo (make-ffi-object itype)))
 230     (unless (zerop (curl:curl_easy_getinfo
 231                     ctx what (ffi-address-of retfo)))
 232       (error 'invalid-operation "curl:easy-getinfo error"))
 233     (ffi-get retfo)))
 234
 235 (defvar curl:download-history nil
 236   "History for `curl:download' and `curl:download&'.")
 237
 238 (ignore-errors
 239   (define-ffi-callback curl:cb-write-to-buffer int
 240     ((ptr pointer) (size int) (nmemb int) (stream pointer))
 241     "Writer to STREAM buffer."
 242     (let ((buf (ffi-pointer-to-lisp-object stream))
 243           (rsz (* size nmemb)))
 244       (when (and (positivep rsz) (buffer-live-p buf))
 245         (with-current-buffer buf
 246           (insert (ffi-get ptr :type (cons 'c-data rsz)))))
 247       rsz)))
 248
 249 ;;;###autoload
 250 (defun curl:download (url file-or-buffer &rest options)
 251   "Download the contents of URL and write them to FILE-OR-BUFFER.
 252
 253 Optionally you can specify keywords in OPTIONS.  The options are
 254 keyword-value-pairs and are set via `curl:easy-setopt'.
 255
 256 When called interactively you can choose, with a prefix arg, to download
 257 the HTTP header instead of the actual remote file.  Obviously this only
 258 works with HTTP URLs."
 259   (interactive
 260    (list (read-string "URL: " (and-fboundp #'ffap-url-at-point
 261                                 (ffap-url-at-point))
 262                       curl:download-history)
 263          (read-file-name "Local file: " default-directory
 264                          (expand-file-name (make-temp-name "curl:downloaded:")
 265                                            (temp-directory)))))
 266   (when current-prefix-arg
 267     ;; In case of C-u
 268     (and (y-or-n-p (format "Only download %s's HTTP header? "
 269                            (file-basename file-or-buffer)))
 270          (setq options (list :header t :nobody t))))
 271
 272   (let* ((ctx (curl:easy-init))
 273          (bufferp (when (bufferp file-or-buffer)
 274                     (or (boundp 'curl:cb-write-to-buffer)
 275                         (error 'unimplemented 'ffi-make-callback
 276                                "for this architecture"))))
 277          (fs (if bufferp
 278                  (ffi-lisp-object-to-pointer file-or-buffer)
 279                (c:fopen (expand-file-name file-or-buffer) "w"))))
 280     (unwind-protect
 281         (progn
 282           (when bufferp
 283             (curl:easy-setopt ctx :write-function 'curl:cb-write-to-buffer))
 284
 285           ;; Avoid signalling!
 286           (curl:easy-setopt ctx :nosignal t)
 287
 288           (apply #'curl:easy-setopt ctx :fstream fs :url url options)
 289           (curl:easy-perform ctx))
 290       (unless bufferp (c:fclose fs))
 291       (curl:easy-cleanup ctx))))
 292
 293 ;;;###autoload
 294 (defun curl:download& (url file-or-buffer &rest options)
 295   "Download the contents of URL and write them to FILE asynchronously.
 296
 297 Optionally you can specify keywords in OPTIONS.  The options are
 298 keyword-value-pairs and are set via `curl:easy-setopt'.
 299
 300 When called interactively you can choose, with a prefix arg, to download
 301 the HTTP header instead of the actual remote file.  Obviously this only
 302 works with HTTP URLs.
 303
 304 After the download operation succeeded the hook `curl:download&-post-hook'
 305 is run.  Functions in there will be called with an argument JOB."
 306   (interactive
 307    (list (read-string "URL: " (and-fboundp #'ffap-url-at-point
 308                                 (ffap-url-at-point))
 309                       curl:download-history)
 310          (read-file-name "Local file: " default-directory
 311                          (expand-file-name (make-temp-name "curl:downloaded:")
 312                                            (temp-directory)))))
 313   (when current-prefix-arg
 314     (and (y-or-n-p (format "Only download %s's HTTP header? "
 315                            (file-basename file-or-buffer)))
 316          (setq options (list :header t :nobody t))))
 317
 318   (if (featurep 'workers)
 319       (let* ((ctx (curl:easy-init))
 320              (bufferp (when (bufferp file-or-buffer)
 321                         (or (boundp 'curl:cb-write-to-buffer)
 322                             (error 'unimplemented 'ffi-make-callback
 323                                    "for this architecture"))))
 324              (fs (if bufferp
 325                      (ffi-lisp-object-to-pointer file-or-buffer)
 326                    (c:fopen (expand-file-name file-or-buffer) "w"))))
 327         (condition-case cerr
 328             (progn
 329               (when bufferp
 330                 (curl:easy-setopt ctx :write-function 'curl:cb-write-to-buffer))
 331
 332               ;; Avoid signalling!
 333               (curl:easy-setopt ctx :nosignal t)
 334
 335               (apply #'curl:easy-setopt ctx :fstream fs :url url options)
 336               (curl:easy-perform& ctx #'curl:easy-perform-sentinel
 337                                   (cons bufferp fs)))
 338
 339           ;; Close FS, cleanup CTX and resignal error
 340           (t (unless bufferp (c:fclose fs))
 341              (curl:easy-cleanup ctx)
 342              (signal (car cerr) (cdr cerr)))))
 343     (error 'unimplemented "Asynchronous Event Queues")))
 344
 345 ;;;###autoload
 346 (defvar curl:download&-post-hook nil
 347   "*Hook run after a `curl:download&' call.
 348 Functions in here are called with one argument JOB containing
 349 the job which just finished.")
 350
 351 ;;}}}
 352
 353 \f
 354 (provide 'ffi-curl)
 355
 356 ;;; ffi-curl.el ends here