dd997e6386ffdc67220cf822e31e04c935ab3706
[riece] / lisp / riece-log.el
1 ;;; riece-log.el --- saving irc logs add-on
2 ;; Copyright (C) 2003 OHASHI Akira
3
4 ;; Author: OHASHI Akira <bg66@koka-in.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 ;;; Commentary:
25
26 ;; This add-on saves irc logs for every channel.
27
28 ;; To use, add the following line to your ~/.riece/init.el:
29 ;; (add-to-list 'riece-addons 'riece-log)
30
31 ;;; Code:
32
33 (eval-when-compile (require 'riece-message)
34                    (require 'riece-button))
35
36 (defgroup riece-log nil
37   "Save irc log"
38   :group 'riece)
39
40 (defcustom riece-log-directory
41   (expand-file-name "log" riece-directory)
42   "*Where to look for log files."
43   :type 'directory
44   :group 'riece-log)
45
46 (defcustom riece-log-directory-map nil
47   "*The map of channel name and directory name."
48   :type '(repeat (cons (string :tag "Channel name")
49                        (string :tag "Directory name")))
50   :group 'riece-log)
51
52 (defcustom riece-log-flashback 10
53   "*If non-nil, irc messages flash back from log files.
54 If integer, flash back only this line numbers. t means all lines."
55   :type '(choice (integer :tag "line numbers")
56                  (boolean :tag "flash back or not"))
57   :group 'riece-log)
58
59 (defcustom riece-log-coding-system nil
60   "*Coding system used for log files."
61   :type 'symbol
62   :group 'riece-log)
63
64 (defcustom riece-log-open-directory-function 'find-file
65   "*Function for opening a directory."
66   :type 'function
67   :group 'riece-log)
68
69 (defun riece-log-display-message-function (message)
70   (let ((open-bracket
71          (funcall riece-message-make-open-bracket-function message))
72         (close-bracket
73          (funcall riece-message-make-close-bracket-function message))
74         (name
75          (funcall riece-message-make-name-function message))
76         (file (riece-log-get-file (riece-message-target message)))
77         (coding-system-for-write riece-log-coding-system))
78     (unless (file-directory-p (file-name-directory file))
79       (make-directory (file-name-directory file) t))
80     (write-region (concat (format-time-string "%H:%M") " "
81                           open-bracket name close-bracket
82                           " " (riece-message-text message) "\n")
83                   nil file t 0)))
84
85 (defun riece-log-get-file (identity)
86   (expand-file-name
87    (concat (format-time-string "%Y%m%d") ".log")
88    (riece-log-get-directory identity)))
89
90 (defun riece-log-get-directory (identity)
91   (let ((channel (riece-identity-canonicalize-prefix
92                   (riece-identity-prefix identity)))
93         (server (riece-identity-server identity))
94         (map (assoc (riece-format-identity identity) riece-log-directory-map))
95         name)
96     (cond (map (setq name (cdr map)))
97           ((string-match riece-strict-channel-regexp channel)
98            (let ((suffix (match-string 2 channel)))
99              (setq name (substring channel (match-end 1) (match-beginning 2)))
100              (when (and (stringp suffix)
101                         (string-match "^:\\*\\.\\(.*\\)" suffix))
102                (setq name (concat name "-" (match-string 1 suffix))))))
103           (t (setq name "priv")))
104     (if server
105         (expand-file-name name (expand-file-name server riece-log-directory))
106       (expand-file-name name riece-log-directory))))
107
108 (defun riece-log-flashback (identity)
109   (when riece-log-flashback
110     (let ((file (riece-log-get-file identity)))
111       (when (file-exists-p file)
112         (let (string)
113           (with-temp-buffer
114             (insert-file-contents file)
115             (if (not (integerp riece-log-flashback))
116                 (goto-char (point-min))
117               (goto-char (point-max))
118               (forward-line (- riece-log-flashback)))
119             (setq string (buffer-substring (point) (point-max))))
120           (let (buffer-read-only)
121             (goto-char (point-max))
122             (insert string)
123             (goto-char (point-min))
124             (while (re-search-forward
125                     "^[0-9][0-9]:[0-9][0-9] [<>]\\([^<>]+\\)[<>] " nil t)
126               (put-text-property (match-beginning 1) (match-end 1)
127                                  'riece-identity
128                                  (riece-make-identity
129                                   (riece-match-string-no-properties 1)
130                                   (riece-identity-server identity))))
131             (if (memq 'riece-button riece-addons)
132                 (riece-button-update-buffer))
133             (goto-char (point-max))
134             (set-window-point (get-buffer-window (current-buffer))
135                               (point))))))))
136
137 (defun riece-log-open-directory (&optional channel)
138   (interactive)
139   (let ((directory (riece-log-get-directory
140                     (or channel riece-current-channel))))
141     (if (file-directory-p directory)
142         (funcall riece-log-open-directory-function directory)
143       (error "No log directory"))))
144
145 (defun riece-log-requires ()
146   (if (memq 'riece-button riece-addons)
147       '(riece-button)))
148
149 (defvar riece-command-mode-map)
150 (defun riece-log-insinuate ()
151   ;; FIXME: Use `riece-after-insert-functions' for trapping change,
152   ;; notice, wallops and so on. But must add argument.
153   (add-hook 'riece-after-display-message-functions
154             'riece-log-display-message-function)
155   (add-hook 'riece-channel-buffer-create-functions
156             'riece-log-flashback)
157   (define-key riece-command-mode-map
158     "\C-cd" 'riece-log-open-directory))
159
160 (provide 'riece-log)
161
162 ;;; riece-log.el ends here