Switch to recommended form of GPLv3 permissions notice.
[emacs.git] / lisp / epa-file-hook.el
blob18ee43e13b813c2387e7a7bb85e7805c6dc41d8f
1 ;;; epa-file-hook.el --- preloaded code to enable epa-file.el
2 ;; Copyright (C) 2006, 2007, 2008 Free Software Foundation, Inc.
4 ;; Author: Daiki Ueno <ueno@unixuser.org>
5 ;; Keywords: PGP, GnuPG
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs 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 3 of the License, or
12 ;; (at your option) any later version.
14 ;; GNU Emacs 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.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
22 ;;; Code:
24 (defgroup epa-file nil
25 "The EasyPG Assistant hooks for transparent file encryption"
26 :version "23.1"
27 :group 'epa)
29 (defun epa-file--file-name-regexp-set (variable value)
30 (set-default variable value)
31 (if (fboundp 'epa-file-name-regexp-update)
32 (epa-file-name-regexp-update)))
34 (defcustom epa-file-name-regexp "\\.gpg\\(~\\|\\.~[0-9]+~\\)?\\'"
35 "Regexp which matches filenames to be encrypted with GnuPG.
37 If you set this outside Custom while epa-file is already enabled, you
38 have to call `epa-file-name-regexp-update' after setting it to
39 properly update file-name-handler-alist. Setting this through Custom
40 does that automatically."
41 :type 'regexp
42 :group 'epa-file
43 :set 'epa-file--file-name-regexp-set)
45 (defcustom epa-file-inhibit-auto-save t
46 "If non-nil, disable auto-saving when opening an encrypted file."
47 :type 'boolean
48 :group 'epa-file)
50 (defvar epa-file-encrypt-to nil
51 "*Recipient(s) used for encrypting files.
52 May either be a string or a list of strings.")
54 (put 'epa-file-encrypt-to 'safe-local-variable
55 (lambda (val)
56 (or (stringp val)
57 (and (listp val)
58 (catch 'safe
59 (mapc (lambda (elt)
60 (unless (stringp elt)
61 (throw 'safe nil)))
62 val)
63 t)))))
65 (put 'epa-file-encrypt-to 'permanent-local t)
67 (defvar epa-file-handler
68 (cons epa-file-name-regexp 'epa-file-handler))
70 (defvar epa-file-auto-mode-alist-entry
71 (list epa-file-name-regexp nil 'epa-file))
73 (defun epa-file-name-regexp-update ()
74 (interactive)
75 (unless (equal (car epa-file-handler) epa-file-name-regexp)
76 (setcar epa-file-handler epa-file-name-regexp)))
78 (defun epa-file-find-file-hook ()
79 (if (and buffer-file-name
80 (string-match epa-file-name-regexp buffer-file-name)
81 epa-file-inhibit-auto-save)
82 (auto-save-mode 0))
83 (set-buffer-modified-p nil))
85 (define-minor-mode auto-encryption-mode
86 "Toggle automatic file encryption and decryption.
87 With prefix argument ARG, turn auto encryption on if positive, else off.
88 Return the new status of auto encryption (non-nil means on)."
89 :global t :init-value t :group 'epa-file :version "23.1"
90 (setq file-name-handler-alist
91 (delq epa-file-handler file-name-handler-alist))
92 (remove-hook 'find-file-hooks 'epa-file-find-file-hook)
93 (setq auto-mode-alist (delq epa-file-auto-mode-alist-entry
94 auto-mode-alist))
95 (when auto-encryption-mode
96 (setq file-name-handler-alist
97 (cons epa-file-handler file-name-handler-alist))
98 (add-hook 'find-file-hook 'epa-file-find-file-hook)
99 (setq auto-mode-alist (cons epa-file-auto-mode-alist-entry
100 auto-mode-alist))))
102 (put 'epa-file-handler 'safe-magic t)
103 (put 'epa-file-handler 'operations '(write-region insert-file-contents))
105 (provide 'epa-file-hook)
107 ;; arch-tag: f75c8a50-d32e-4eb3-9ec6-9e940c1fc8b5
108 ;;; epa-file-hook.el ends here