Fix -- user list buffer not updating when parts are hidden.
[riece] / lisp / riece-rdcc.el
index b77c978..7b34f28 100644 (file)
@@ -1,4 +1,4 @@
-;;; riece-rdcc.el --- ruby implementation of DCC add-on
+;;; riece-rdcc.el --- DCC file sending protocol support (written in Ruby) -*- lexical-binding: t -*-
 ;; Copyright (C) 1998-2003 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
 
 ;; You should have received a copy of the GNU General Public License
 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+
+;; NOTE: This is an add-on module for Riece.
 
 ;;; Code:
 
 (require 'riece-channel)
 (require 'riece-identity)
 (require 'riece-ctcp)                  ;for riece-ctcp-additional-clientinfo
+(require 'riece-ruby)
+(require 'riece-mcat)
 
 (defgroup riece-rdcc nil
-  "DCC implementation using ruby"
+  "DCC written in Ruby."
   :prefix "riece-"
   :group 'riece)
 
@@ -40,44 +46,59 @@ Only used for sending files."
   :type 'string
   :group 'riece-rdcc)
 
-(defcustom riece-rdcc-ruby-command "ruby"
-  "Command name for Ruby interpreter."
-  :type 'string
+(defcustom riece-rdcc-server-port nil
+  "Local port of the DCC server.
+Only used for sending files."
+  :type 'integer
   :group 'riece-rdcc)
 
 (defcustom riece-rdcc-send-program
   '("\
+require 'socket'
 address = " address "
+port = " port "
 unless address
   sock = UDPSocket.new
   sock.connect('164.46.176.4', 7)              # www.unixuser.org/echo
   address = sock.getsockname[4 .. 7].unpack('CCCC').join('.')
 end
-server = TCPServer.new(address, 0)
-puts(\"#{server.addr[3].split(/\\./).collect{|c| c.to_i}.pack('CCCC').unpack('N')[0]} #{server.addr[1]}\")
+server = TCPServer.new(address, port)
+output(\"#{server.addr[3].split(/\\./).collect{|c| c.to_i}.pack('CCCC').unpack('N')[0]} #{server.addr[1]}\")
 session = server.accept
 if session
   total = 0
   File.open(" file ") {|file|
-    while (bytes = file.read(4096))
+    while (bytes = file.read(" block-size "))
       total += bytes.length
-      puts(\"#{total}\")
+      output(total)
       session.write(bytes)
+      begin
+        buf = session.read(4)
+      end until buf.unpack('N')[0] == total
     end
   }
   session.close
 end
 ")
   "Ruby program to send file with DCC."
-  :type 'list
+  :type 'sexp
   :group 'riece-rdcc)
 
 (defcustom riece-rdcc-decode-address-program
-  '("\
-puts(\"#{" address " >> 24 & 0xFF}.#{" address " >> 16 & 0xFF}.#{"
-    address " >> 8 & 0xFF}.#{" address " & 0xFF}\")")
+  '("\"#{" address " >> 24 & 0xFF}.#{" address " >> 16 & 0xFF}.#{"
+    address " >> 8 & 0xFF}.#{" address " & 0xFF}\"")
   "Ruby program to numeric IP address."
-  :type 'list
+  :type 'sexp
+  :group 'riece-rdcc)
+
+(defcustom riece-rdcc-save-directory nil
+  "Default directory where received files are saved in."
+  :type 'directory
+  :group 'riece-rdcc)
+
+(defcustom riece-rdcc-block-size 1024
+  "Number of bytes sent as a block."
+  :type 'integer
   :group 'riece-rdcc)
 
 (defvar riece-rdcc-requests nil)
@@ -86,118 +107,120 @@ puts(\"#{" address " >> 24 & 0xFF}.#{" address " >> 16 & 0xFF}.#{"
 (defvar riece-rdcc-request-file nil)
 (defvar riece-rdcc-request-size nil)
 
+(defvar riece-rdcc-temp-file nil)
+(defvar riece-rdcc-received-size nil)
+
+(defconst riece-rdcc-description
+  "DCC file sending protocol support (written in Ruby.)")
+
+(defvar temporary-file-directory)
 (defvar jka-compr-compression-info-list)
 (defvar jam-zcat-filename-list)
-(defun riece-rdcc-substitute-variables (program variable value)
-  (setq program (copy-sequence program))
-  (let ((pointer program))
-    (while pointer
-      (setq pointer (memq variable program))
-      (if pointer
-         (setcar pointer value)))
-    program))
-
-(defun riece-rdcc-server-filter (process input)
-  (save-excursion
-    (set-buffer (process-buffer process))
-    (goto-char (point-max))
-    (insert input)
-    (goto-char (point-min))
-    (while (and (not (eobp))
-               (looking-at "\\([0-9]+\\)\n"))
-      (message "Sending %s...(%s/%d)"
-              riece-rdcc-request-file
-              (match-string 1) riece-rdcc-request-size)
-      (forward-line))
-    (unless (eobp)
-      (delete-region (point-min) (point)))))
-
-(defun riece-rdcc-server-sentinel (process status)
-  (with-current-buffer (process-buffer process)
-    (message "Sending %s...done" riece-rdcc-request-file))
-  (kill-buffer (process-buffer process))
-  (delete-process process))
+
+(defun riece-rdcc-output-handler (name output _time)
+  (if (string-match "\\([0-9]+\\) \\([0-9]+\\)" output)
+      (let ((address (match-string 1 output))
+           (port (match-string 2 output)))
+       (riece-send-string
+        (format "PRIVMSG %s :\1DCC SEND %s %s %s %d\1\r\n"
+                (riece-identity-prefix
+                 (riece-ruby-property name 'riece-rdcc-request-user))
+                (file-name-nondirectory
+                 (riece-ruby-property name 'riece-rdcc-request-file))
+                address port
+                (riece-ruby-property name 'riece-rdcc-request-size)))))
+  (riece-ruby-set-output-handler name #'riece-rdcc-output-handler-2))
+
+(defun riece-rdcc-output-handler-2 (name output _time)
+  (message (riece-mcat "Sending %s...(%s/%d)")
+          (riece-ruby-property name 'riece-rdcc-request-file)
+          (string-to-number output)
+          (riece-ruby-property name 'riece-rdcc-request-size)))
+
+(defun riece-rdcc-exit-handler (name)
+  (message (riece-mcat "Sending %s...done")
+          (riece-ruby-property name 'riece-rdcc-request-file)))
 
 (defun riece-command-dcc-send (user file)
   (interactive
    (let ((completion-ignore-case t))
-     (list (completing-read
-           "User: "
-           (mapcar #'list (riece-get-users-on-server)))
-          (expand-file-name (read-file-name "File: ")))))
-  (let ((process
-        (start-process "DCC" (generate-new-buffer " *DCC*")
-                       "ruby" "-rsocket")))
-    (process-send-string process
-                        (apply #'concat
-                               (riece-rdcc-substitute-variables
-                                (riece-rdcc-substitute-variables
-                                 riece-rdcc-send-program
-                                 'address
-                                 (if riece-rdcc-server-address
-                                     (concat "'" riece-rdcc-server-address
-                                             "'")
-                                   "nil"))
-                                'file
-                                (concat "'" file "'"))))
-    (process-send-eof process)
-    (save-excursion
-      (set-buffer (process-buffer process))
-      (while (and (eq (process-status process) 'run)
-                 (progn
-                   (goto-char (point-min))
-                   (not (looking-at "\\([0-9]+\\) \\([0-9]+\\)"))))
-       (accept-process-output))
-      (if (eq (process-status process) 'run)
-         (let ((address (match-string 1))
-               (port (match-string 2)))
-           (erase-buffer)
-           (make-local-variable 'riece-rdcc-request-size)
-           (setq riece-rdcc-request-file file
-                 riece-rdcc-request-size (nth 7 (file-attributes file)))
-           (set-buffer-modified-p nil)
-           (set-process-filter process #'riece-rdcc-server-filter)
-           (set-process-sentinel process #'riece-rdcc-server-sentinel)
-           (riece-send-string
-            (format "PRIVMSG %s :\1DCC SEND %s %s %s %d\1\r\n"
-                    user (file-name-nondirectory file)
-                    address port
-                    riece-rdcc-request-size)))))))
+     (list (riece-completing-read-identity
+           (riece-mcat "User: ")
+           (riece-get-users-on-server (riece-current-server-name)))
+          (expand-file-name (read-file-name (riece-mcat "File: "))))))
+  (let ((name (riece-ruby-execute
+              (riece-ruby-substitute-variables
+               riece-rdcc-send-program
+               (list (cons 'address
+                           (if riece-rdcc-server-address
+                               (concat "'" riece-rdcc-server-address
+                                         "'")
+                             "nil"))
+                     (cons 'port
+                           (if riece-rdcc-server-port
+                               (number-to-string riece-rdcc-server-port)
+                             "0"))
+                     (cons 'file
+                           (concat "'" file "'"))
+                     (cons 'block-size
+                           (number-to-string
+                            riece-rdcc-block-size)))))))
+    (riece-ruby-set-property name 'riece-rdcc-request-user user)
+    (riece-ruby-set-property name 'riece-rdcc-request-file file)
+    (riece-ruby-set-property name 'riece-rdcc-request-size
+                            (nth 7 (file-attributes file)))
+    (riece-ruby-set-output-handler name #'riece-rdcc-output-handler)
+    (riece-ruby-set-exit-handler name #'riece-rdcc-exit-handler)))
 
 (defun riece-rdcc-filter (process input)
-  (save-excursion
-    (set-buffer (process-buffer process))
-    (goto-char (point-max))
+  (with-current-buffer (process-buffer process)
+    (erase-buffer)
     (insert input)
-    (message "Receiving %s from %s...(%d/%d)"
+    (let ((coding-system-for-write 'binary)
+         jka-compr-compression-info-list jam-zcat-filename-list)
+      (write-region (point-min) (point-max) riece-rdcc-temp-file t 0))
+    (setq riece-rdcc-received-size (+ (buffer-size) riece-rdcc-received-size))
+    (process-send-string
+     process
+     (format "%c%c%c%c"
+            (lsh riece-rdcc-received-size -24)
+            (logand (lsh riece-rdcc-received-size -16) 255)
+            (logand (lsh riece-rdcc-received-size -8) 255)
+            (logand riece-rdcc-received-size 255)))
+    (message (riece-mcat "Receiving %s from %s...(%s/%s)")
             (file-name-nondirectory riece-rdcc-request-file)
             riece-rdcc-request-user
-            (1- (point))
-            riece-rdcc-request-size)))
+            (riece-rdcc-format-size riece-rdcc-received-size)
+            (riece-rdcc-format-size riece-rdcc-request-size))
+    (if (= riece-rdcc-received-size riece-rdcc-request-size)
+       (set-process-filter process nil))))
 
-(defun riece-rdcc-sentinel (process status)
-  (save-excursion
-    (set-buffer (process-buffer process))
-    (unless (= (buffer-size) riece-rdcc-request-size)
+(defun riece-rdcc-sentinel (process _status)
+  (with-current-buffer (process-buffer process)
+    (unless (= riece-rdcc-received-size riece-rdcc-request-size)
       (error "Premature end of file"))
-    (message "Receiving %s from %s...done"
+    (message (riece-mcat "Receiving %s from %s...done")
             (file-name-nondirectory riece-rdcc-request-file)
             riece-rdcc-request-user)
-    (let ((coding-system-for-write 'binary)
-         jka-compr-compression-info-list jam-zcat-filename-list)
-      (write-region (point-min) (point-max) riece-rdcc-request-file)))
-  (kill-buffer (process-buffer process))
-  (delete-process process))
+    (condition-case nil
+       (progn
+         (rename-file riece-rdcc-temp-file riece-rdcc-request-file)
+         (delete-directory (file-name-directory riece-rdcc-temp-file)))
+      (file-already-exists
+       (error "Can't save %s.  Temporarily saved in %s"
+             riece-rdcc-request-file riece-rdcc-temp-file))))
+  (kill-buffer (process-buffer process)))
 
 (defun riece-rdcc-decode-address (address)
-  (with-temp-buffer
-    (call-process riece-rdcc-ruby-command nil t nil "-e"
-                 (apply #'concat
-                        (riece-rdcc-substitute-variables
-                         riece-rdcc-decode-address-program
-                         'address
-                         address)))
-    (buffer-substring (point-min) (1- (point-max)))))
+  (let ((name (riece-ruby-execute
+              (riece-ruby-substitute-variables
+               riece-rdcc-decode-address-program
+               (list (cons 'address address)))))
+       response)
+    (while (equal (nth 2 (setq response (riece-ruby-inspect name))) "running")
+      (accept-process-output riece-ruby-process))
+    (riece-ruby-clear name)
+    (nth 1 response)))
 
 (defun riece-command-dcc-receive (request file)
   (interactive
@@ -211,7 +234,7 @@ puts(\"#{" address " >> 24 & 0xFF}.#{" address " >> 16 & 0xFF}.#{"
                 (let ((requests riece-rdcc-requests)
                       (index 1))
                   (while requests
-                    (princ (format "%2d: %s %s (%d bytes)\n"
+                    (princ (format (riece-mcat "%2d: %s %s (%d bytes)\n")
                                    index
                                    (car (car requests))
                                    (nth 1 (car requests))
@@ -227,21 +250,37 @@ puts(\"#{" address " >> 24 & 0xFF}.#{" address " >> 16 & 0xFF}.#{"
                     (error "Invalid number"))
                 (nth (1- number) riece-rdcc-requests))))
            (default-name (expand-file-name
-                          (nth 1 request) default-directory)))
+                          (convert-standard-filename (nth 1 request))
+                          (or riece-rdcc-save-directory
+                              default-directory))))
        (list request
             (expand-file-name
              (read-file-name
-              (concat "Save as (default "
-                      (file-name-nondirectory default-name) ") ")
+              (format (riece-mcat "Save as (default %s) ")
+                      (file-name-nondirectory default-name))
               (file-name-directory default-name)
               default-name))))))
-  (let* (selective-display
+  (let* ((temp-file (expand-file-name
+                    (file-name-nondirectory file)
+                    (expand-file-name (make-temp-name "riece-rdcc")
+                                      (if (featurep 'xemacs)
+                                          (temp-directory)
+                                        temporary-file-directory))))
+        (orig-mode (default-file-modes))
+        selective-display
         (coding-system-for-read 'binary)
         (coding-system-for-write 'binary)
-        (process (open-network-stream
+        process)
+    (unwind-protect
+       (progn
+         (set-default-file-modes 448)
+         ;; This may throw an error.
+         (make-directory (file-name-directory temp-file)))
+      (set-default-file-modes orig-mode))
+    (setq process (open-network-stream
                   "DCC" (generate-new-buffer " *DCC*")
                   (riece-rdcc-decode-address (nth 2 request))
-                  (nth 3 request))))
+                  (nth 3 request)))
     (setq riece-rdcc-requests (delq request riece-rdcc-requests))
     (with-current-buffer (process-buffer process)
       (if (fboundp 'set-buffer-multibyte)
@@ -253,28 +292,53 @@ puts(\"#{" address " >> 24 & 0xFF}.#{" address " >> 16 & 0xFF}.#{"
       (make-local-variable 'riece-rdcc-request-file)
       (setq riece-rdcc-request-file file)
       (make-local-variable 'riece-rdcc-request-size)
-      (setq riece-rdcc-request-size (nth 4 request)))
+      (setq riece-rdcc-request-size (nth 4 request))
+      (make-local-variable 'riece-rdcc-temp-file)
+      (setq riece-rdcc-temp-file temp-file)
+      (make-local-variable 'riece-rdcc-received-size)
+      (setq riece-rdcc-received-size 0))
     (set-process-filter process #'riece-rdcc-filter)
     (set-process-sentinel process #'riece-rdcc-sentinel)))
 
+(defun riece-rdcc-format-size (size)
+  (if (< size 1024)
+      (format "%0.1f" size)
+    (setq size (/ size 1024.0))
+    (if (< size 1024)
+       (format "%0.1fKB" size)
+      (setq size (/ size 1024.0))
+      (if (< size 1024)
+         (format "%0.1fMB" size)
+       (format "%0.1fGB" (/ size 1024.0))))))
+
 (defun riece-handle-dcc-request (prefix target message)
   (let ((case-fold-search t))
-    (when (string-match
-          "SEND \\([^ ]+\\) \\([^ ]+\\) \\([^ ]+\\) \\([^ ]+\\)"
-          message)
-      (let ((file (match-string 1 message))
-           (address (match-string 2 message))
-           (port (string-to-number (match-string 3 message)))
-           (size (string-to-number (match-string 4 message)))
+    (when (and (get 'riece-rdcc 'riece-addon-enabled)
+              (string-match
+               "SEND \\(\\([^ ]+\\)\\|\"\\(.+\\)\"\\) \\([^ ]+\\) \\([^ ]+\\) \\([^ ]+\\)"
+               message))
+      (let ((file (or (match-string 2 message)
+                     (match-string 3 message)))
+           (address (match-string 4 message))
+           (port (string-to-number (match-string 5 message)))
+           (size (string-to-number (match-string 6 message)))
            (buffer (if (riece-channel-p target)
-                       (cdr (riece-identity-assoc
-                             (riece-make-identity target)
-                             riece-channel-buffer-alist))))
+                       (riece-channel-buffer (riece-make-identity
+                                              target riece-server-name))))
            (user (riece-prefix-nickname prefix)))
        (setq riece-rdcc-requests
              (cons (list user file address port size)
                    riece-rdcc-requests))
-       (riece-insert-change buffer (format "DCC SEND from %s\n" user))
+       (message "%s"
+                (with-current-buffer (window-buffer (selected-window))
+                  (substitute-command-keys
+                   (format
+                    (riece-mcat
+                     "Type \\[riece-command-dcc-receive] to receive")
+                    user))))
+       (riece-insert-change buffer (format "DCC SEND from %s: %s (%s)\n"
+                                           user file
+                                           (riece-rdcc-format-size size)))
        (riece-insert-change
         (if (and riece-channel-buffer-mode
                  (not (eq buffer riece-channel-buffer)))
@@ -282,11 +346,13 @@ puts(\"#{" address " >> 24 & 0xFF}.#{" address " >> 16 & 0xFF}.#{"
           riece-dialogue-buffer)
         (concat
          (riece-concat-server-name
-          (format "DCC SEND from %s (%s) to %s"
+          (format "DCC SEND from %s (%s) to %s: %s (%s)"
                   user
                   (riece-strip-user-at-host
                    (riece-prefix-user-at-host prefix))
-                  target))
+                  (riece-decode-coding-string target)
+                  file
+                  (riece-rdcc-format-size size)))
          "\n")))
       t)))
 
@@ -295,11 +361,22 @@ puts(\"#{" address " >> 24 & 0xFF}.#{" address " >> 16 & 0xFF}.#{"
 
 (defvar riece-dialogue-mode-map)
 (defun riece-rdcc-insinuate ()
-  (add-to-list 'riece-ctcp-additional-clientinfo "DCC" t)
-  (add-hook 'riece-ctcp-dcc-request-hook 'riece-handle-dcc-request)
+  (add-to-list 'riece-ctcp-additional-clientinfo "DCC")
+  (add-hook 'riece-ctcp-dcc-request-hook 'riece-handle-dcc-request))
+
+(defun riece-rdcc-uninstall ()
+  (setq riece-ctcp-additional-clientinfo
+       (delete "DCC" riece-ctcp-additional-clientinfo))
+  (remove-hook 'riece-ctcp-dcc-request-hook 'riece-handle-dcc-request))
+
+(defun riece-rdcc-enable ()
   (define-key riece-dialogue-mode-map "\C-ds" 'riece-command-dcc-send)
   (define-key riece-dialogue-mode-map "\C-dr" 'riece-command-dcc-receive))
 
+(defun riece-rdcc-disable ()
+  (define-key riece-dialogue-mode-map "\C-ds" nil)
+  (define-key riece-dialogue-mode-map "\C-dr" nil))
+
 (provide 'riece-rdcc)
 
 ;;; riece-rdcc.el ends here