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