* server.rb (Server::unescape): Fixed.
[riece] / lisp / riece-rdcc.el
1 ;;; riece-rdcc.el --- ruby implementation of DCC add-on
2 ;; Copyright (C) 1998-2003 Daiki Ueno
3
4 ;; Author: Daiki Ueno <ueno@unixuser.org>
5 ;; Keywords: IRC, riece
6
7 ;; This file is part of Riece.
8
9 ;; This program is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; any later version.
13
14 ;; This program is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 ;; GNU General Public License for more details.
18
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
23
24 ;;; Code:
25
26 (require 'riece-globals)
27 (require 'riece-misc)
28 (require 'riece-channel)
29 (require 'riece-identity)
30 (require 'riece-ctcp)                   ;for riece-ctcp-additional-clientinfo
31 (require 'riece-ruby)
32
33 (defgroup riece-rdcc nil
34   "DCC implementation using ruby"
35   :prefix "riece-"
36   :group 'riece)
37
38 (defcustom riece-rdcc-server-address nil
39   "Local address of the DCC server.
40 Only used for sending files."
41   :type 'string
42   :group 'riece-rdcc)
43
44 (defcustom riece-rdcc-send-program
45   '("\
46 require 'socket'
47 address = " address "
48 unless address
49   sock = UDPSocket.new
50   sock.connect('164.46.176.4', 7)               # www.unixuser.org/echo
51   address = sock.getsockname[4 .. 7].unpack('CCCC').join('.')
52 end
53 server = TCPServer.new(address, 0)
54 output(\"#{server.addr[3].split(/\\./).collect{|c| c.to_i}.pack('CCCC').unpack('N')[0]} #{server.addr[1]}\")
55 session = server.accept
56 if session
57   total = 0
58   File.open(" file ") {|file|
59     while (bytes = file.read(" block-size "))
60       total += bytes.length
61       output(total)
62       session.write(bytes)
63       begin
64         buf = session.read(4)
65       end until buf.unpack('N')[0] == total
66     end
67   }
68   session.close
69 end
70 ")
71   "Ruby program to send file with DCC."
72   :type 'list
73   :group 'riece-rdcc)
74
75 (defcustom riece-rdcc-decode-address-program
76   '("\"#{" address " >> 24 & 0xFF}.#{" address " >> 16 & 0xFF}.#{"
77     address " >> 8 & 0xFF}.#{" address " & 0xFF}\"")
78   "Ruby program to numeric IP address."
79   :type 'list
80   :group 'riece-rdcc)
81
82 (defcustom riece-rdcc-save-directory nil
83   "Default directory where received files are saved in."
84   :type 'directory
85   :group 'riece-rdcc)
86
87 (defcustom riece-rdcc-block-size 1024
88   "Number of bytes sent as a block."
89   :type 'integer
90   :group 'riece-rdcc)
91
92 (defvar riece-rdcc-requests nil)
93
94 (defvar riece-rdcc-request-user nil)
95 (defvar riece-rdcc-request-file nil)
96 (defvar riece-rdcc-request-size nil)
97
98 (defvar riece-rdcc-temp-file nil)
99 (defvar riece-rdcc-received-size nil)
100
101 (defvar riece-rdcc-enabled nil)
102
103 (defconst riece-rdcc-description
104   "DCC file sending extension implemented in Ruby")
105
106 (defvar temporary-file-directory)
107 (defvar jka-compr-compression-info-list)
108 (defvar jam-zcat-filename-list)
109
110 (defun riece-rdcc-output-handler (name output)
111   (if (string-match "\\([0-9]+\\) \\([0-9]+\\)" output)
112       (let ((address (match-string 1 output))
113             (port (match-string 2 output)))
114         (riece-send-string
115          (format "PRIVMSG %s :\1DCC SEND %s %s %s %d\1\r\n"
116                  (riece-identity-prefix
117                   (riece-ruby-property name 'riece-rdcc-request-user))
118                  (file-name-nondirectory
119                   (riece-ruby-property name 'riece-rdcc-request-file))
120                  address port
121                  (riece-ruby-property name 'riece-rdcc-request-size)))))
122   (riece-ruby-set-output-handler name #'riece-rdcc-output-handler-2))
123
124 (defun riece-rdcc-output-handler-2 (name output)
125   (message "Sending %s...(%s/%d)"
126            (riece-ruby-property name 'riece-rdcc-request-file)
127            (string-to-number output)
128            (riece-ruby-property name 'riece-rdcc-request-size)))
129
130 (defun riece-rdcc-exit-handler (name)
131   (message "Sending %s...done"
132            (riece-ruby-property name 'riece-rdcc-request-file))
133   (riece-ruby-clear name))
134
135 (defun riece-command-dcc-send (user file)
136   (interactive
137    (let ((completion-ignore-case t))
138      (list (riece-completing-read-identity
139             "User: "
140             (riece-get-users-on-server (riece-current-server-name)))
141            (expand-file-name (read-file-name "File: ")))))
142   (let ((name (riece-ruby-execute
143                (riece-ruby-substitute-variables
144                 riece-rdcc-send-program
145                 (list (cons 'address
146                             (if riece-rdcc-server-address
147                                 (concat "'" riece-rdcc-server-address
148                                         "'")
149                               "nil"))
150                       (cons 'file
151                             (concat "'" file "'"))
152                       (cons 'block-size
153                             (number-to-string
154                              riece-rdcc-block-size)))))))
155     (riece-ruby-set-property name 'riece-rdcc-request-user user)
156     (riece-ruby-set-property name 'riece-rdcc-request-file file)
157     (riece-ruby-set-property name 'riece-rdcc-request-size
158                              (nth 7 (file-attributes file)))
159     (riece-ruby-set-output-handler name #'riece-rdcc-output-handler)
160     (riece-ruby-set-exit-handler name #'riece-rdcc-exit-handler)))
161
162 (defun riece-rdcc-filter (process input)
163   (save-excursion
164     (set-buffer (process-buffer process))
165     (erase-buffer)
166     (insert input)
167     (let ((coding-system-for-write 'binary)
168           jka-compr-compression-info-list jam-zcat-filename-list)
169       (write-region (point-min) (point-max) riece-rdcc-temp-file t 0))
170     (setq riece-rdcc-received-size (+ (buffer-size) riece-rdcc-received-size))
171     (process-send-string
172      process
173      (format "%c%c%c%c"
174              (lsh riece-rdcc-received-size -24)
175              (logand (lsh riece-rdcc-received-size -16) 255)
176              (logand (lsh riece-rdcc-received-size -8) 255)
177              (logand riece-rdcc-received-size 255)))
178     (message "Receiving %s from %s...(%s/%s)"
179              (file-name-nondirectory riece-rdcc-request-file)
180              riece-rdcc-request-user
181              (riece-rdcc-format-size riece-rdcc-received-size)
182              (riece-rdcc-format-size riece-rdcc-request-size))
183     (if (= riece-rdcc-received-size riece-rdcc-request-size)
184         (set-process-filter process nil))))
185
186 (defun riece-rdcc-sentinel (process status)
187   (save-excursion
188     (set-buffer (process-buffer process))
189     (unless (= riece-rdcc-received-size riece-rdcc-request-size)
190       (error "Premature end of file"))
191     (message "Receiving %s from %s...done"
192              (file-name-nondirectory riece-rdcc-request-file)
193              riece-rdcc-request-user)
194     (condition-case nil
195         (progn
196           (rename-file riece-rdcc-temp-file riece-rdcc-request-file)
197           (delete-directory (file-name-directory riece-rdcc-temp-file)))
198       (file-already-exists
199        (error "Can't save %s.  Temporarily saved in %s"
200               riece-rdcc-request-file riece-rdcc-temp-file))))
201   (kill-buffer (process-buffer process)))
202
203 (defun riece-rdcc-decode-address (address)
204   (let ((name (riece-ruby-execute
205                (riece-ruby-substitute-variables
206                 riece-rdcc-decode-address-program
207                 (list (cons 'address address)))))
208         response)
209     (while (equal (nth 2 (setq response (riece-ruby-inspect name))) "running")
210       (accept-process-output riece-ruby-process))
211     (riece-ruby-clear name)
212     (nth 1 response)))
213
214 (defun riece-command-dcc-receive (request file)
215   (interactive
216    (progn
217      (unless riece-rdcc-requests
218        (error "No request"))
219      (let* ((request
220              (if (= (length riece-rdcc-requests) 1)
221                  (car riece-rdcc-requests)
222                (with-output-to-temp-buffer "*Help*"
223                  (let ((requests riece-rdcc-requests)
224                        (index 1))
225                    (while requests
226                      (princ (format "%2d: %s %s (%d bytes)\n"
227                                     index
228                                     (car (car requests))
229                                     (nth 1 (car requests))
230                                     (nth 4 (car requests))))
231                      (setq index (1+ index)
232                            requests (cdr requests)))))
233                (let ((number (read-string "Request#: ")))
234                  (unless (string-match "^[0-9]+$" number)
235                    (error "Not a number"))
236                  (if (or (> (setq number (string-to-number number))
237                             (length riece-rdcc-requests))
238                          (< number 1))
239                      (error "Invalid number"))
240                  (nth (1- number) riece-rdcc-requests))))
241             (default-name (expand-file-name
242                            (convert-standard-filename (nth 1 request))
243                            (or riece-rdcc-save-directory
244                                default-directory))))
245        (list request
246              (expand-file-name
247               (read-file-name
248                (concat "Save as (default "
249                        (file-name-nondirectory default-name) ") ")
250                (file-name-directory default-name)
251                default-name))))))
252   (let* ((temp-file (expand-file-name
253                      (file-name-nondirectory file)
254                      (expand-file-name (make-temp-name "riece-rdcc")
255                                        (if (featurep 'xemacs)
256                                            (temp-directory)
257                                          temporary-file-directory))))
258          (orig-mode (default-file-modes))
259          selective-display
260          (coding-system-for-read 'binary)
261          (coding-system-for-write 'binary)
262          process)
263     (unwind-protect
264         (progn
265           (set-default-file-modes 448)
266           ;; This may throw an error.
267           (make-directory (file-name-directory temp-file)))
268       (set-default-file-modes orig-mode))
269     (setq process (open-network-stream
270                    "DCC" (generate-new-buffer " *DCC*")
271                    (riece-rdcc-decode-address (nth 2 request))
272                    (nth 3 request)))
273     (setq riece-rdcc-requests (delq request riece-rdcc-requests))
274     (with-current-buffer (process-buffer process)
275       (if (fboundp 'set-buffer-multibyte)
276           (set-buffer-multibyte nil))
277       (buffer-disable-undo)
278       (erase-buffer)
279       (make-local-variable 'riece-rdcc-request-user)
280       (setq riece-rdcc-request-user (car request))
281       (make-local-variable 'riece-rdcc-request-file)
282       (setq riece-rdcc-request-file file)
283       (make-local-variable 'riece-rdcc-request-size)
284       (setq riece-rdcc-request-size (nth 4 request))
285       (make-local-variable 'riece-rdcc-temp-file)
286       (setq riece-rdcc-temp-file temp-file)
287       (make-local-variable 'riece-rdcc-received-size)
288       (setq riece-rdcc-received-size 0))
289     (set-process-filter process #'riece-rdcc-filter)
290     (set-process-sentinel process #'riece-rdcc-sentinel)))
291
292 (defun riece-rdcc-format-size (size)
293   (if (< size 1024)
294       (format "%0.1f" size)
295     (setq size (/ size 1024.0))
296     (if (< size 1024)
297         (format "%0.1fKB" size)
298       (setq size (/ size 1024.0))
299       (if (< size 1024)
300           (format "%0.1fMB" size)
301         (format "%0.1fGB" (/ size 1024.0))))))
302
303 (defun riece-handle-dcc-request (prefix target message)
304   (let ((case-fold-search t))
305     (when (and riece-rdcc-enabled
306                (string-match
307                 "SEND \\(\\([^ ]+\\)\\|\"\\(.+\\)\"\\) \\([^ ]+\\) \\([^ ]+\\) \\([^ ]+\\)"
308                 message))
309       (let ((file (or (match-string 2 message)
310                       (match-string 3 message)))
311             (address (match-string 4 message))
312             (port (string-to-number (match-string 5 message)))
313             (size (string-to-number (match-string 6 message)))
314             (buffer (if (riece-channel-p target)
315                         (riece-channel-buffer (riece-make-identity
316                                                target riece-server-name))))
317             (user (riece-prefix-nickname prefix)))
318         (setq riece-rdcc-requests
319               (cons (list user file address port size)
320                     riece-rdcc-requests))
321         (message "%s"
322                  (with-current-buffer (window-buffer (selected-window))
323                    (substitute-command-keys
324                     (format
325                      "Type \\[riece-command-dcc-receive] to receive"
326                      user))))
327         (riece-insert-change buffer (format "DCC SEND from %s: %s (%s)\n"
328                                             user file
329                                             (riece-rdcc-format-size size)))
330         (riece-insert-change
331          (if (and riece-channel-buffer-mode
332                   (not (eq buffer riece-channel-buffer)))
333              (list riece-dialogue-buffer riece-others-buffer)
334            riece-dialogue-buffer)
335          (concat
336           (riece-concat-server-name
337            (format "DCC SEND from %s (%s) to %s: %s (%s)"
338                    user
339                    (riece-strip-user-at-host
340                     (riece-prefix-user-at-host prefix))
341                    (riece-decode-coding-string target)
342                    file
343                    (riece-rdcc-format-size size)))
344           "\n")))
345       t)))
346
347 (defun riece-rdcc-requires ()
348   '(riece-ctcp))
349
350 (defvar riece-dialogue-mode-map)
351 (defun riece-rdcc-insinuate ()
352   (add-to-list 'riece-ctcp-additional-clientinfo "DCC")
353   (add-hook 'riece-ctcp-dcc-request-hook 'riece-handle-dcc-request))
354
355 (defun riece-rdcc-enable ()
356   (define-key riece-dialogue-mode-map "\C-ds" 'riece-command-dcc-send)
357   (define-key riece-dialogue-mode-map "\C-dr" 'riece-command-dcc-receive)
358   (setq riece-rdcc-enabled t))
359
360 (defun riece-rdcc-disable ()
361   (define-key riece-dialogue-mode-map "\C-ds" nil)
362   (define-key riece-dialogue-mode-map "\C-dr" nil)
363   (setq riece-rdcc-enabled nil))
364
365 (provide 'riece-rdcc)
366
367 ;;; riece-rdcc.el ends here