c525d2513f78fd2810a503d3d499efb3337535b1
[riece] / lisp / riece-log.el
1 ;;; riece-log.el --- Save IRC logs -*- lexical-binding: t -*-
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., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
25
26 ;;; Commentary:
27
28 ;;; NOTE: This is an add-on module for Riece.
29
30 ;;; Code:
31
32 (require 'riece-message)
33 (require 'riece-button)
34 (require 'riece-mcat)
35
36 (defgroup riece-log nil
37   "Save IRC logs."
38   :prefix "riece-"
39   :group 'riece)
40
41 (defcustom riece-log-directory
42   (expand-file-name "log" riece-directory)
43   "*Where to look for log files."
44   :type 'directory
45   :group 'riece-log)
46
47 (defcustom riece-log-directory-map nil
48   "*The map of channel name and directory name."
49   :type '(repeat (cons (string :tag "Channel name")
50                        (string :tag "Directory name")))
51   :group 'riece-log)
52
53 (defcustom riece-log-flashback 10
54   "*If non-nil, irc messages flash back from log files.
55 If integer, flash back only this line numbers. t means all lines."
56   :type '(choice (integer :tag "line numbers")
57                  (const t :tag "of the day")
58                  (const nil :tag "no flashback"))
59   :group 'riece-log)
60
61 (defcustom riece-log-coding-system nil
62   "*Coding system used for log files."
63   :type 'symbol
64   :group 'riece-log)
65
66 (defcustom riece-log-file-name-coding-system
67   (if (boundp 'file-name-coding-system)
68       file-name-coding-system)
69   "*Coding system used for filenames of log files."
70   :type 'symbol
71   :group 'riece-log)
72
73 (defface riece-log-date-face
74   '((((class color)
75       (background dark))
76      (:foreground "Gray70"))
77     (((class color)
78       (background light))
79      (:foreground "DimGray"))
80     (t
81      (:bold t)))
82   "Face used for displaying \"(YYYY/MM/dd)\" extent."
83   :group 'riece-highlight-faces)
84 (defvar riece-log-date-face 'riece-log-date-face)
85
86 (defvar riece-log-lock-file nil
87   "Lock file for riece-log.
88 It is created if there is at least one instance of Emacs running riece-log.")
89
90 (defconst riece-log-file-name-regexp
91   (concat (riece-make-interval-regexp "[0-9]" 8) "\\.txt\\(\\.\\(.*\\)\\)?$"))
92
93 (defconst riece-log-description
94   "Save IRC logs.")
95
96 (defun riece-log-display-message-function (message)
97   (if (get 'riece-log 'riece-addon-enabled)
98       (let* ((coding-system-for-write
99               (if (featurep 'mule)
100                   (or riece-log-coding-system
101                       (car (get-language-info current-language-environment
102                                               'coding-system)))))
103              (file (riece-log-make-file-name (riece-message-target message)
104                                              coding-system-for-write))
105              (file-name-coding-system 'no-conversion))
106         (unless (file-directory-p (file-name-directory file))
107           (make-directory (file-name-directory file) t))
108         (write-region (concat (format-time-string "%H:%M") " "
109                               (riece-format-message message))
110                       nil file t 0
111                       riece-log-lock-file))))
112
113 (defun riece-log-make-file-name (identity coding-system)
114   (expand-file-name (if (and (featurep 'mule) coding-system)
115                         (format "%s.txt.%s"
116                                 (format-time-string "%Y%m%d")
117                                 coding-system)
118                       (format "%s.txt"
119                                 (format-time-string "%Y%m%d")))
120                     (riece-log-directory identity)))
121
122 (defun riece-log-list-files (identity time)
123   (let ((directory (riece-log-directory identity))
124         (time-prefix (format-time-string "%Y%m%d" (or time '(0 0))))
125         files)
126     (when (file-directory-p directory)
127       (setq files (nreverse (sort (directory-files
128                                    directory t
129                                    (concat "^" riece-log-file-name-regexp)
130                                    t)
131                                   #'string-lessp)))
132       (while (and files
133                   (string-lessp (file-name-nondirectory (car files))
134                                 time-prefix))
135         (setq files (cdr files)))
136       files)))
137
138 (defun riece-log-directory (identity)
139   (let ((prefix (riece-identity-canonicalize-prefix
140                  (riece-identity-prefix identity)))
141         (server (riece-identity-server identity))
142         (map (assoc (riece-format-identity identity) riece-log-directory-map)))
143     (if map
144         (expand-file-name (cdr map) riece-log-directory)
145       (expand-file-name (riece-log-encode-file-name prefix)
146                         (expand-file-name
147                          (concat "." (riece-log-encode-file-name server))
148                          riece-log-directory)))))
149
150 (defun riece-log-encode-file-name (file-name)
151   (if riece-log-file-name-coding-system
152       (setq file-name
153             (encode-coding-string file-name
154                                   riece-log-file-name-coding-system)))
155   (let ((index 0)
156         c)
157     (while (string-match "[^-0-9A-Za-z_\x80-\xFF]" file-name index)
158       (setq c (aref file-name (match-beginning 0)))
159       (if (eq c ?=)
160           (setq file-name (replace-match "==" nil t file-name)
161                 index (1+ (match-end 0)))
162         (setq file-name (replace-match (format "=%02X" c) nil t file-name)
163               index (+ 2 (match-end 0)))))
164     file-name))
165
166 (defun riece-log-decode-file-name (file-name)
167   (let ((index 0))
168     (while (string-match "==\\|=\\([0-7][0-9A-F]\\)" file-name index)
169       (setq file-name (replace-match
170                        (if (eq (aref file-name (1- (match-end 0))) ?=)
171                            "="
172                          (char-to-string
173                           (car (read-from-string
174                                 (concat "?\\x" (match-string 1 file-name))))))
175                        nil t file-name)
176             index (1+ (match-beginning 0))))
177     file-name)
178   (if riece-log-file-name-coding-system
179       (setq file-name
180             (decode-coding-string file-name
181                                   riece-log-file-name-coding-system)))
182   file-name)
183
184 (defun riece-log-insert (identity lines)
185   "Insert logs for IDENTITY at most LINES.
186 If LINES is t, insert today's logs entirely."
187   (let* ((file-name-coding-system 'no-conversion)
188          (files (riece-log-list-files identity
189                                       (if (eq lines t) (current-time))))
190          name coding-system date point)
191     (while (and (or (eq lines t) (> lines 0)) files)
192       (save-restriction
193         (narrow-to-region (point) (point))
194         (if (and (string-match
195                   (concat "^" riece-log-file-name-regexp)
196                   (setq name (file-name-nondirectory (car files))))
197                  (match-beginning 2))
198             (progn
199               (setq coding-system
200                     (intern (substring name (match-beginning 2))))
201               (if (featurep 'xemacs)
202                   (setq coding-system (find-coding-system coding-system))
203                 (unless (coding-system-p coding-system)
204                   (setq coding-system nil)))
205               (if coding-system
206                   (let ((coding-system-for-read coding-system))
207                     (insert-file-contents (car files)))
208                 ;;don't insert file contents if they use non
209                 ;;supported coding-system.
210                 ))
211           ;;if the filename has no coding-system suffix, decode with
212           ;;riece-log-coding-system.
213           (let ((coding-system-for-read riece-log-coding-system))
214             (insert-file-contents (car files))))
215         ;;lines in the file contents are in reversed order.
216         (unless (eq lines t)
217           (goto-char (point-max))
218           (setq lines (- (forward-line (- lines))))
219           (delete-region (point-min) (point)))
220         ;;add (YYYY/MM/dd) suffix on each line left in the current buffer.
221         (unless (equal (substring name 0 8) (format-time-string "%Y%m%d"))
222           (setq date (concat " (" (substring name 0 4) "/"
223                              (substring name 4 6) "/"
224                              (substring name 6 8) ")"))
225           (while (not (eobp))
226             (end-of-line)
227             (setq point (point))
228             (insert date)
229             (put-text-property point (point)
230                                'riece-overlay-face 'riece-log-date-face)
231             (forward-line))
232           (goto-char (point-min))))
233       (setq files (cdr files)))))
234
235 (defun riece-log-flashback (identity)
236   (when riece-log-flashback
237     (riece-insert-info (current-buffer)
238                        (if (eq riece-log-flashback t)
239                            (riece-mcat "Recent messages of the day:\n")
240                          (format (riece-mcat
241                                   "Recent messages up to %d lines:\n")
242                                  riece-log-flashback)))
243     (let (buffer-read-only
244           (point (goto-char (point-max))))
245       (insert (with-temp-buffer
246                 (riece-log-insert identity riece-log-flashback)
247                 (buffer-string)))
248       (goto-char point)
249       (while (re-search-forward
250               (concat "^" riece-time-prefix-regexp
251                        "\\(<[^>]+>\\|>[^<]+<\\|([^)]+)\\|{[^}]+}\\|=[^=]+=\\)")
252               nil t)
253         (put-text-property (1+ (match-beginning 1)) (1- (match-end 1))
254                            'riece-identity
255                            (riece-make-identity
256                             (buffer-substring (1+ (match-beginning 1))
257                                               (1- (match-end 1)))
258                             (riece-identity-server identity))))
259       (run-hook-with-args 'riece-after-insert-functions
260                           point (goto-char (point-max)))
261       (set-window-point (get-buffer-window (current-buffer))
262                         (point)))))
263
264 (defun riece-log-dired (&optional channel)
265   (interactive)
266   (let ((directory (riece-log-directory (or channel riece-current-channel))))
267     (if (file-directory-p directory)
268         (dired directory)
269       (error "No log directory"))))
270
271 (defun riece-log-requires ()
272   (if (memq 'riece-button riece-addons)
273       '(riece-button)))
274
275 (defun riece-log-insinuate ()
276   (make-directory riece-log-directory t)
277   (setq riece-log-lock-file
278         (expand-file-name (format "!%s-%d-%d"
279                                   (riece-log-encode-file-name (system-name))
280                                   (user-uid)
281                                   (emacs-pid))
282                           riece-log-directory))
283   ;; FIXME: Use `riece-after-insert-functions' for trapping change,
284   ;; notice, wallops and so on. But must add argument.
285   (add-hook 'riece-after-display-message-functions
286             'riece-log-display-message-function)
287   (add-hook 'riece-channel-buffer-create-functions
288             'riece-log-flashback))
289
290 (defun riece-log-uninstall ()
291   (setq riece-log-lock-file nil)
292   (remove-hook 'riece-after-display-message-functions
293                'riece-log-display-message-function)
294   (remove-hook 'riece-channel-buffer-create-functions
295                'riece-log-flashback))
296
297 (defvar riece-command-mode-map)
298 (defun riece-log-enable ()
299   (define-key riece-command-mode-map "\C-cd" 'riece-log-dired))
300
301 (defun riece-log-disable ()
302   (define-key riece-command-mode-map "\C-cd" nil))
303
304 (provide 'riece-log)
305
306 ;;; riece-log.el ends here