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