* riece-ignore.el (riece-ignore-buffer-name): New user option.
[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 ((file (riece-log-get-file (riece-message-target message)))
71         (coding-system-for-write riece-log-coding-system))
72     (unless (file-directory-p (file-name-directory file))
73       (make-directory (file-name-directory file) t))
74     (write-region (concat (format-time-string "%H:%M") " "
75                           (riece-format-message message))
76                   nil file t 0)))
77
78 (defun riece-log-get-file (identity)
79   (expand-file-name
80    (concat (format-time-string "%Y%m%d") ".log")
81    (riece-log-get-directory identity)))
82
83 (defun riece-log-get-directory (identity)
84   (let ((channel (riece-identity-canonicalize-prefix
85                   (riece-identity-prefix identity)))
86         (server (riece-identity-server identity))
87         (map (assoc (riece-format-identity identity) riece-log-directory-map))
88         name)
89     (cond (map (setq name (cdr map)))
90           ((string-match riece-strict-channel-regexp channel)
91            (let ((suffix (match-string 2 channel)))
92              (setq name (substring channel (match-end 1) (match-beginning 2)))
93              (when (and (stringp suffix)
94                         (string-match "^:\\*\\.\\(.*\\)" suffix))
95                (setq name (concat name "-" (match-string 1 suffix))))))
96           (t (setq name "priv")))
97     (if server
98         (expand-file-name name (expand-file-name server riece-log-directory))
99       (expand-file-name name riece-log-directory))))
100
101 (defun riece-log-flashback (identity)
102   (when riece-log-flashback
103     (let ((file (riece-log-get-file identity)))
104       (when (file-exists-p file)
105         (let (string)
106           (with-temp-buffer
107             (insert-file-contents file)
108             (if (not (integerp riece-log-flashback))
109                 (goto-char (point-min))
110               (goto-char (point-max))
111               (forward-line (- riece-log-flashback)))
112             (setq string (buffer-substring (point) (point-max))))
113           (let (buffer-read-only)
114             (goto-char (point-max))
115             (insert string)
116             (goto-char (point-min))
117             (while (re-search-forward
118                     "^[0-9][0-9]:[0-9][0-9] [<>]\\([^<>]+\\)[<>] " nil t)
119               (put-text-property (match-beginning 1) (match-end 1)
120                                  'riece-identity
121                                  (riece-make-identity
122                                   (riece-match-string-no-properties 1)
123                                   (riece-identity-server identity))))
124             (if (memq 'riece-button riece-addons)
125                 (riece-button-update-buffer))
126             (goto-char (point-max))
127             (set-window-point (get-buffer-window (current-buffer))
128                               (point))))))))
129
130 (defun riece-log-open-directory (&optional channel)
131   (interactive)
132   (let ((directory (riece-log-get-directory
133                     (or channel riece-current-channel))))
134     (if (file-directory-p directory)
135         (funcall riece-log-open-directory-function directory)
136       (error "No log directory"))))
137
138 (defun riece-log-requires ()
139   (if (memq 'riece-button riece-addons)
140       '(riece-button)))
141
142 (defvar riece-command-mode-map)
143 (defun riece-log-insinuate ()
144   ;; FIXME: Use `riece-after-insert-functions' for trapping change,
145   ;; notice, wallops and so on. But must add argument.
146   (add-hook 'riece-after-display-message-functions
147             'riece-log-display-message-function)
148   (add-hook 'riece-channel-buffer-create-functions
149             'riece-log-flashback)
150   (define-key riece-command-mode-map
151     "\C-cd" 'riece-log-open-directory))
152
153 (provide 'riece-log)
154
155 ;;; riece-log.el ends here