cgit.sxemacs.org Git - riece/blob - lisp/riece-log.el

   1 ;;; riece-log.el --- saving irc logs add-on
   2 ;; Copyright (C) 2003 OHASHI Akira
   3 ;; Copyright (C) 2004 Daiki Ueno
   4
   5 ;; Author: OHASHI Akira <bg66@koka-in.org>
   6 ;;      Daiki Ueno <ueno@unixuser.org>
   7 ;; Keywords: IRC, riece
   8
   9 ;; This file is part of Riece.
  10
  11 ;; This program is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  15
  16 ;; This program is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  24 ;; Boston, MA 02111-1307, USA.
  25
  26 ;;; Commentary:
  27
  28 ;; This add-on saves irc logs for every channel.
  29
  30 ;; To use, add the following line to your ~/.riece/init.el:
  31 ;; (add-to-list 'riece-addons 'riece-log)
  32
  33 ;;; Code:
  34
  35 (require 'riece-message)
  36 (require 'riece-button)
  37
  38 (defgroup riece-log nil
  39   "Save irc log"
  40   :group 'riece)
  41
  42 (defcustom riece-log-directory
  43   (expand-file-name "log" riece-directory)
  44   "*Where to look for log files."
  45   :type 'directory
  46   :group 'riece-log)
  47
  48 (defcustom riece-log-directory-map nil
  49   "*The map of channel name and directory name."
  50   :type '(repeat (cons (string :tag "Channel name")
  51                        (string :tag "Directory name")))
  52   :group 'riece-log)
  53
  54 (defcustom riece-log-flashback 10
  55   "*If non-nil, irc messages flash back from log files.
  56 If integer, flash back only this line numbers. t means all lines."
  57   :type '(choice (integer :tag "line numbers")
  58                  (const t :tag "of the day")
  59                  (const nil :tag "no flashback"))
  60   :group 'riece-log)
  61
  62 (defcustom riece-log-coding-system nil
  63   "*Coding system used for log files."
  64   :type 'symbol
  65   :group 'riece-log)
  66
  67 (defcustom riece-log-file-name-coding-system
  68   (if (boundp 'file-name-coding-system)
  69       file-name-coding-system)
  70   "*Coding system used for filenames of log files."
  71   :type 'symbol
  72   :group 'riece-log)
  73
  74 (defcustom riece-log-open-directory-function 'find-file
  75   "*Function for opening a directory."
  76   :type 'function
  77   :group 'riece-log)
  78
  79 (defface riece-log-date-face
  80   '((((class color)
  81       (background dark))
  82      (:foreground "Gray70"))
  83     (((class color)
  84       (background light))
  85      (:foreground "DimGray"))
  86     (t
  87      (:bold t)))
  88   "Face used for displaying \"(YYYY/MM/dd)\" extent."
  89   :group 'riece-highlight-faces)
  90 (defvar riece-log-date-face 'riece-log-date-face)
  91
  92 (defvar riece-log-enabled nil)
  93
  94 (defconst riece-log-description
  95   "Saving IRC logs")
  96
  97 (defun riece-log-display-message-function (message)
  98   (if riece-log-enabled
  99       (let ((file (riece-log-get-file (riece-message-target message)))
 100             (coding-system-for-write riece-log-coding-system)
 101             file-name-coding-system
 102             default-file-name-coding-system)
 103         (unless (file-directory-p (file-name-directory file))
 104           (make-directory (file-name-directory file) t))
 105         (write-region (concat (format-time-string "%H:%M") " "
 106                               (riece-format-message message))
 107                       nil file t 0))))
 108
 109 (defun riece-log-get-file (identity)
 110   (expand-file-name
 111    (concat (format-time-string "%Y%m%d") ".txt")
 112    (riece-log-get-directory identity)))
 113
 114 (defun riece-log-get-files (identity)
 115   (let ((directory (riece-log-get-directory identity)))
 116     (if (file-directory-p directory)
 117         (nreverse (sort (directory-files directory t
 118                          (concat "^"
 119                                  (riece-make-interval-regexp "[0-9]" 8)
 120                                  "\\.txt$")
 121                          t)
 122                   #'string-lessp)))))
 123
 124 (defun riece-log-get-directory (identity)
 125   (let ((prefix (riece-identity-canonicalize-prefix
 126                  (riece-identity-prefix identity)))
 127         (server (riece-identity-server identity))
 128         (map (assoc (riece-format-identity identity) riece-log-directory-map))
 129         name)
 130     (if map
 131         (setq name (cdr map))
 132       (expand-file-name (riece-log-encode-file-name prefix)
 133                         (expand-file-name
 134                          (concat "." (riece-log-encode-file-name server))
 135                          riece-log-directory)))))
 136
 137 (defun riece-log-encode-file-name (file-name)
 138   (if riece-log-file-name-coding-system
 139       (setq file-name
 140             (encode-coding-string file-name
 141                                   riece-log-file-name-coding-system)))
 142   (let ((index 0)
 143         c)
 144     (while (string-match "[^-0-9A-Za-z_\x80-\xFF]" file-name index)
 145       (setq c (aref file-name (match-beginning 0)))
 146       (if (eq c ?=)
 147           (setq file-name (replace-match "==" nil t file-name)
 148                 index (1+ (match-end 0)))
 149         (setq file-name (replace-match (format "=%02X" c) nil t file-name)
 150               index (+ 2 (match-end 0)))))
 151     file-name))
 152
 153 (defun riece-log-decode-file-name (file-name)
 154   (let ((index 0))
 155     (while (string-match "==\\|=\\([0-7][0-9A-F]\\)" file-name index)
 156       (setq file-name (replace-match
 157                        (if (eq (aref file-name (1- (match-end 0))) ?=)
 158                            "="
 159                          (char-to-string
 160                           (car (read-from-string
 161                                 (concat "?\\x" (match-string 1 file-name))))))
 162                        nil t file-name)
 163             index (1+ (match-beginning 0))))
 164     file-name)
 165   (if riece-log-file-name-coding-system
 166       (setq file-name
 167             (decode-coding-string file-name
 168                                   riece-log-file-name-coding-system)))
 169   file-name)
 170
 171 (defun riece-log-insert (identity lines)
 172   "Insert logs for IDENTITY at most LINES.
 173 If LINES is t, insert today's logs entirely."
 174   (if (eq lines t)
 175       (let ((file (riece-log-get-file identity)))
 176         (if (file-exists-p file)
 177             (insert-file-contents file)))
 178     (let ((files (riece-log-get-files identity))
 179           (lines (- lines))
 180           name date point)
 181       (while (and (< lines 0) files)
 182         (if (and (file-exists-p (car files))
 183                  (string-match (concat (riece-make-interval-regexp "[0-9]" 8)
 184                                        "\\.txt$")
 185                                (setq name (file-name-nondirectory
 186                                            (car files)))))
 187             (save-restriction
 188               (narrow-to-region (point) (point))
 189               (insert-file-contents (car files))
 190               (goto-char (point-max))
 191               (setq lines (forward-line lines))
 192               (delete-region (point-min) (point))
 193               (unless (equal name (format-time-string "%Y%m%d.txt"))
 194                 (setq date (concat " (" (substring name 0 4) "/"
 195                                    (substring name 4 6) "/"
 196                                    (substring name 6 8) ")"))
 197                 (while (not (eobp))
 198                   (end-of-line)
 199                   (setq point (point))
 200                   (insert date)
 201                   (put-text-property point (point)
 202                                      'riece-overlay-face 'riece-log-date-face)
 203                   (forward-line))
 204                 (goto-char (point-min)))))
 205         (setq files (cdr files))))))
 206
 207 (defun riece-log-flashback (identity)
 208   (when riece-log-flashback
 209     (riece-insert-info (current-buffer)
 210                        (if (eq riece-log-flashback t)
 211                            "Recent messages of the day:\n"
 212                          (format "Recent messages up to %d lines:\n"
 213                                  riece-log-flashback)))
 214     (let (buffer-read-only
 215           (point (goto-char (point-max))))
 216       (insert (with-temp-buffer
 217                 (riece-log-insert identity riece-log-flashback)
 218                 (buffer-string)))
 219       (goto-char point)
 220       (while (re-search-forward
 221               "^[0-9][0-9]:[0-9][0-9] [<>]\\([^<>]+\\)[<>] " nil t)
 222         (put-text-property (match-beginning 1) (match-end 1)
 223                            'riece-identity
 224                            (riece-make-identity
 225                             (riece-match-string-no-properties 1)
 226                             (riece-identity-server identity))))
 227       (run-hook-with-args 'riece-after-insert-functions
 228                           point (goto-char (point-max)))
 229       (set-window-point (get-buffer-window (current-buffer))
 230                         (point)))))
 231
 232 (defun riece-log-open-directory (&optional channel)
 233   (interactive)
 234   (let ((directory (riece-log-get-directory
 235                     (or channel riece-current-channel))))
 236     (if (file-directory-p directory)
 237         (funcall riece-log-open-directory-function directory)
 238       (error "No log directory"))))
 239
 240 (defun riece-log-requires ()
 241   (if (memq 'riece-button riece-addons)
 242       '(riece-button)))
 243
 244 (defun riece-log-insinuate ()
 245   ;; FIXME: Use `riece-after-insert-functions' for trapping change,
 246   ;; notice, wallops and so on. But must add argument.
 247   (add-hook 'riece-after-display-message-functions
 248             'riece-log-display-message-function)
 249   (add-hook 'riece-channel-buffer-create-functions
 250             'riece-log-flashback))
 251
 252 (defvar riece-command-mode-map)
 253 (defun riece-log-enable ()
 254   (define-key riece-command-mode-map "\C-cd" 'riece-log-open-directory)
 255   (setq riece-log-enabled t))
 256
 257 (defun riece-log-disable ()
 258   (define-key riece-command-mode-map "\C-cd" nil)
 259   (setq riece-log-enabled nil))
 260
 261 (provide 'riece-log)
 262
 263 ;;; riece-log.el ends here