mu-register.el

   1 ;;; mu-register.el --- registration feature of mu-cite
   2
   3 ;; Copyright (C) 1995,1996,1997,1998,1999 Free Software Foundation, Inc.
   4
   5 ;; Author: MINOURA Makoto <minoura@netlaputa.or.jp>
   6 ;;         MORIOKA Tomohiko <tomo@m17n.org>
   7 ;;; Created: 1995-12-27 by MINOURA Makoto
   8 ;; Maintainer: Katsumi Yamaoka <yamaoka@jpl.org>
   9 ;; Keywords: registration, citation, mail, news
  10
  11 ;; This file is part of MU (Message Utilities).
  12
  13 ;; This program is free software; you can redistribute it and/or
  14 ;; modify it under the terms of the GNU General Public License as
  15 ;; published by the Free Software Foundation; either version 2, or (at
  16 ;; your option) any later version.
  17
  18 ;; This program is distributed in the hope that it will be useful, but
  19 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 ;; General Public License for more details.
  22
  23 ;; You should have received a copy of the GNU General Public License
  24 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  26 ;; Boston, MA 02111-1307, USA.
  27
  28 ;;; Code:
  29
  30 (require 'mu-cite)
  31
  32 (eval-when-compile (require 'static))
  33
  34
  35 ;;; @ variables
  36 ;;;
  37
  38 (defcustom mu-registration-file (expand-file-name "~/.mu-cite.el")
  39   "The name of the user environment file for mu-cite."
  40   :type 'file
  41   :group 'mu-cite)
  42
  43 (defcustom mu-registration-file-modes 384
  44   "Mode bits of `mu-registration-file', as an integer."
  45   :type 'integer
  46   :group 'mu-cite)
  47
  48 (defcustom mu-registration-file-coding-system-for-read nil
  49   "Coding system used when reading a registration file."
  50   :group 'mu-cite)
  51
  52 (defcustom mu-cite-allow-null-string-registration nil
  53   "If non-nil, null-string citation-name is registered."
  54   :type 'boolean
  55   :group 'mu-cite)
  56
  57 (defvar mu-registration-symbol 'mu-citation-name-alist
  58   "*Name of the variable to register citation prefix strings.")
  59
  60 (defvar mu-registration-file-coding-system nil
  61   "Coding system used when writing a current registration file.")
  62
  63 (defvar mu-register-history nil)
  64
  65 (static-when (featurep 'xemacs)
  66   (define-obsolete-variable-alias
  67     'mu-cite/registration-file 'mu-registration-file)
  68
  69   (define-obsolete-variable-alias
  70     'mu-cite/allow-null-string-registration
  71     'mu-cite-allow-null-string-registration)
  72
  73   (define-obsolete-variable-alias
  74     'mu-cite/registration-symbol 'mu-registration-symbol)
  75   )
  76
  77
  78 ;;; @ load / save registration file
  79 ;;;
  80
  81 (defun mu-cite-load-registration-file ()
  82   (if (file-readable-p mu-registration-file)
  83       (with-temp-buffer
  84         (if mu-registration-file-coding-system-for-read
  85             (insert-file-contents-as-coding-system
  86              mu-registration-file-coding-system-for-read
  87              mu-registration-file)
  88           (insert-file-contents mu-registration-file))
  89         (setq mu-registration-file-coding-system
  90               (static-if (<= emacs-major-version 19)
  91                   file-coding-system
  92                 buffer-file-coding-system))
  93         (let ((exp (read (current-buffer))))
  94           (or (eq (car (cdr exp)) mu-registration-symbol)
  95               (setcar (cdr exp) mu-registration-symbol))
  96           (eval exp))))
  97   (or (boundp mu-registration-symbol)
  98       (set mu-registration-symbol nil)))
  99
 100 (defun mu-cite-save-registration-file ()
 101   (with-temp-buffer
 102     (insert ";;; " (file-name-nondirectory mu-registration-file) "\n")
 103     (insert ";;; This file is generated automatically by mu-cite "
 104             mu-cite-version "\n\n")
 105     (insert "(setq "
 106             (symbol-name mu-registration-symbol)
 107             "\n      '(")
 108     (insert (mapconcat
 109              (function prin1-to-string)
 110              (symbol-value mu-registration-symbol) "\n        "))
 111     (insert "\n        ))\n\n")
 112     (insert ";;; "
 113             (file-name-nondirectory mu-registration-file)
 114             " ends here.\n")
 115     (write-region-as-coding-system mu-registration-file-coding-system
 116                                    (point-min)(point-max)
 117                                    mu-registration-file nil 'nomsg)
 118     (condition-case nil
 119         (set-file-modes mu-registration-file mu-registration-file-modes)
 120       (error nil))))
 121
 122
 123 ;;; @ database accessors
 124 ;;;
 125
 126 ;; get citation-name from the database
 127 (defun mu-register-get-citation-name (from)
 128   (cdr (assoc from (symbol-value mu-registration-symbol))))
 129
 130 ;; register citation-name to the database
 131 (defun mu-register-add-citation-name (name from)
 132   (set-alist mu-registration-symbol from name)
 133   (mu-cite-save-registration-file))
 134
 135
 136 ;;; @ methods
 137 ;;;
 138
 139 ;;;###autoload
 140 (defun mu-cite-get-prefix-method ()
 141   (or (mu-register-get-citation-name (mu-cite-get-value 'address))
 142       ">"))
 143
 144 ;;;###autoload
 145 (defun mu-cite-get-prefix-register-method ()
 146   (let ((addr (mu-cite-get-value 'address)))
 147     (or (mu-register-get-citation-name addr)
 148         (let ((return
 149                (read-string "Citation name? "
 150                             (or (mu-cite-get-value 'x-attribution)
 151                                 (mu-cite-get-value 'full-name))
 152                             'mu-register-history)))
 153           (when (and (or mu-cite-allow-null-string-registration
 154                          (not (string-equal return "")))
 155                      (y-or-n-p (format "Register \"%s\"? " return)))
 156             (mu-register-add-citation-name return addr))
 157           return))))
 158
 159 ;;;###autoload
 160 (defun mu-cite-get-prefix-register-verbose-method ()
 161   (let* ((addr (mu-cite-get-value 'address))
 162          (return1 (mu-register-get-citation-name addr))
 163          (return (read-string "Citation name? "
 164                               (or return1
 165                                   (mu-cite-get-value 'x-attribution)
 166                                   (mu-cite-get-value 'full-name))
 167                               'mu-register-history)))
 168     (when (and (or mu-cite-allow-null-string-registration
 169                    (not (string-equal return "")))
 170                (not (string-equal return return1))
 171                (y-or-n-p (format "Register \"%s\"? " return)))
 172       (mu-register-add-citation-name return addr))
 173     return))
 174
 175
 176 ;;; @ end
 177 ;;;
 178
 179 (provide 'mu-register)
 180
 181 (mu-cite-load-registration-file)
 182
 183 ;;; mu-register.el ends here