1 ;;; riece-log.el --- saving irc logs add-on
2 ;; Copyright (C) 2003 OHASHI Akira
3 ;; Copyright (C) 2004 Daiki Ueno
5 ;; Author: OHASHI Akira <bg66@koka-in.org>
6 ;; Daiki Ueno <ueno@unixuser.org>
7 ;; Keywords: IRC, riece
9 ;; This file is part of Riece.
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)
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.
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.
28 ;; This add-on saves irc logs for every channel.
30 ;; To use, add the following line to your ~/.riece/init.el:
31 ;; (add-to-list 'riece-addons 'riece-log)
35 (require 'riece-message)
36 (require 'riece-button)
38 (defgroup riece-log nil
42 (defcustom riece-log-directory
43 (expand-file-name "log" riece-directory)
44 "*Where to look for log files."
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")))
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"))
62 (defcustom riece-log-coding-system nil
63 "*Coding system used for log files."
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."
74 (defcustom riece-log-open-directory-function 'find-file
75 "*Function for opening a directory."
79 (defface riece-log-date-face
82 (:foreground "Gray70"))
85 (:foreground "DimGray"))
88 "Face used for displaying \"(YYYY/MM/dd)\" extent."
89 :group 'riece-highlight-faces)
90 (defvar riece-log-date-face 'riece-log-date-face)
92 (defvar riece-log-enabled nil)
94 (defconst riece-log-description
97 (defun riece-log-display-message-function (message)
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))
109 (defun riece-log-get-file (identity)
111 (concat (format-time-string "%Y%m%d") ".txt")
112 (riece-log-get-directory identity)))
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
119 (riece-make-interval-regexp "[0-9]" 8)
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)))
130 (expand-file-name (cdr map) riece-log-directory)
131 (expand-file-name (riece-log-encode-file-name prefix)
133 (concat "." (riece-log-encode-file-name server))
134 riece-log-directory)))))
136 (defun riece-log-encode-file-name (file-name)
137 (if riece-log-file-name-coding-system
139 (encode-coding-string file-name
140 riece-log-file-name-coding-system)))
143 (while (string-match "[^-0-9A-Za-z_\x80-\xFF]" file-name index)
144 (setq c (aref file-name (match-beginning 0)))
146 (setq file-name (replace-match "==" nil t file-name)
147 index (1+ (match-end 0)))
148 (setq file-name (replace-match (format "=%02X" c) nil t file-name)
149 index (+ 2 (match-end 0)))))
152 (defun riece-log-decode-file-name (file-name)
154 (while (string-match "==\\|=\\([0-7][0-9A-F]\\)" file-name index)
155 (setq file-name (replace-match
156 (if (eq (aref file-name (1- (match-end 0))) ?=)
159 (car (read-from-string
160 (concat "?\\x" (match-string 1 file-name))))))
162 index (1+ (match-beginning 0))))
164 (if riece-log-file-name-coding-system
166 (decode-coding-string file-name
167 riece-log-file-name-coding-system)))
170 (defun riece-log-insert (identity lines)
171 "Insert logs for IDENTITY at most LINES.
172 If LINES is t, insert today's logs entirely."
174 (let ((file (riece-log-get-file identity)))
175 (if (file-exists-p file)
176 (insert-file-contents file)))
177 (let ((files (riece-log-get-files identity))
180 (while (and (< lines 0) files)
181 (if (and (file-exists-p (car files))
182 (string-match (concat (riece-make-interval-regexp "[0-9]" 8)
184 (setq name (file-name-nondirectory
187 (narrow-to-region (point) (point))
188 (insert-file-contents (car files))
189 (goto-char (point-max))
190 (setq lines (forward-line lines))
191 (delete-region (point-min) (point))
192 (unless (equal name (format-time-string "%Y%m%d.txt"))
193 (setq date (concat " (" (substring name 0 4) "/"
194 (substring name 4 6) "/"
195 (substring name 6 8) ")"))
200 (put-text-property point (point)
201 'riece-overlay-face 'riece-log-date-face)
203 (goto-char (point-min)))))
204 (setq files (cdr files))))))
206 (defun riece-log-flashback (identity)
207 (when riece-log-flashback
208 (riece-insert-info (current-buffer)
209 (if (eq riece-log-flashback t)
210 "Recent messages of the day:\n"
211 (format "Recent messages up to %d lines:\n"
212 riece-log-flashback)))
213 (let (buffer-read-only
214 (point (goto-char (point-max))))
215 (insert (with-temp-buffer
216 (riece-log-insert identity riece-log-flashback)
219 (while (re-search-forward
220 "^[0-9][0-9]:[0-9][0-9] [<>]\\([^<>]+\\)[<>] " nil t)
221 (put-text-property (match-beginning 1) (match-end 1)
224 (riece-match-string-no-properties 1)
225 (riece-identity-server identity))))
226 (run-hook-with-args 'riece-after-insert-functions
227 point (goto-char (point-max)))
228 (set-window-point (get-buffer-window (current-buffer))
231 (defun riece-log-open-directory (&optional channel)
233 (let ((directory (riece-log-get-directory
234 (or channel riece-current-channel))))
235 (if (file-directory-p directory)
236 (funcall riece-log-open-directory-function directory)
237 (error "No log directory"))))
239 (defun riece-log-requires ()
240 (if (memq 'riece-button riece-addons)
243 (defun riece-log-insinuate ()
244 ;; FIXME: Use `riece-after-insert-functions' for trapping change,
245 ;; notice, wallops and so on. But must add argument.
246 (add-hook 'riece-after-display-message-functions
247 'riece-log-display-message-function)
248 (add-hook 'riece-channel-buffer-create-functions
249 'riece-log-flashback))
251 (defvar riece-command-mode-map)
252 (defun riece-log-enable ()
253 (define-key riece-command-mode-map "\C-cd" 'riece-log-open-directory)
254 (setq riece-log-enabled t))
256 (defun riece-log-disable ()
257 (define-key riece-command-mode-map "\C-cd" nil)
258 (setq riece-log-enabled nil))
262 ;;; riece-log.el ends here