;; Editing:
;;
;; This file also provides `plstore-mode', a major mode for editing
-;; the PLSTORE format file. Visit a non-existing file and put the
+;; the plstore format file. Visit a non-existing file and put the
;; following line:
;;
;; (("foo" :host "foo.example.org" :secret-user "user"))
(put 'plstore-encrypt-to 'permanent-local t)
-(defvar plstore-encoded nil)
+(defvar plstore-encoded nil
+ "Non-nil if the current buffer shows the decoded alist.") ; [sic!]
(put 'plstore-encoded 'permanent-local t)
+;;; EasyPG callback functions.
+
(defvar plstore-cache-passphrase-for-symmetric-encryption nil)
(defvar plstore-passphrase-alist nil)
(cons entry
plstore-passphrase-alist)))
(setq passphrase
- (read-passwd (format "Passphrase for PLSTORE %s: "
+ (read-passwd (format "Passphrase for plstore %s: "
(plstore--get-buffer plstore))))
(setcdr entry (copy-sequence passphrase))
passphrase)))
- (read-passwd (format "Passphrase for PLSTORE %s: "
+ (read-passwd (format "Passphrase for plstore %s: "
(plstore--get-buffer plstore)))))
(defun plstore-progress-callback-function (_context _what _char current total
(message "%s...%d%%" handback
(if (> total 0) (floor (* (/ current (float total)) 100)) 0))))
+;;; Core functions.
+
(defun plstore--get-buffer (arg)
(aref arg 0))
(vector buffer alist encrypted-data secret-alist merged-alist))
(defun plstore--init-from-buffer (plstore)
+ "Parse current buffer and initialize PLSTORE from it."
(goto-char (point-min))
(when (looking-at ";;; public entries")
(forward-line)
store)))
(defun plstore-revert (plstore)
- "Replace current data in PLSTORE with the file on disk."
+ "Replace current data in PLSTORE from its associated file."
(with-current-buffer (plstore--get-buffer plstore)
(revert-buffer t t)
(plstore--init-from-buffer plstore)))
(defun plstore-close (plstore)
- "Destroy a plstore instance PLSTORE."
+ "Destroy plstore instance PLSTORE."
(kill-buffer (plstore--get-buffer plstore)))
(defun plstore--merge-secret (plstore)
+ "Determine the merged alist of PLSTORE.
+Create the merged alist as a copy of the template alist with all
+placeholder properties that have corresponding properties in the
+secret alist replaced by their plain-text secret properties."
(let ((alist (plstore--get-secret-alist plstore))
modified-alist
modified-plist
modified-entry (assoc (car entry) modified-alist)
modified-plist (cdr modified-entry))
(while plist
+ ;; Search for a placeholder property in the merged alist
+ ;; corresponding to the current secret property.
(setq placeholder
(plist-member
modified-plist
(intern (concat ":secret-"
(substring (symbol-name (car plist)) 1)))))
+ ;; Replace its name with the real, secret property name.
(if placeholder
(setcar placeholder (car plist)))
+ ;; Update its value to the plain-text secret property value.
(setq modified-plist
(plist-put modified-plist (car plist) (car (cdr plist))))
(setq plist (nthcdr 2 plist)))
(setcdr modified-entry modified-plist))))
(defun plstore--decrypt (plstore)
+ "Decrypt the encrypted data of PLSTORE.
+Update its internal alists and other data structures
+accordingly."
(if (plstore--get-encrypted-data plstore)
(let ((context (epg-make-context 'OpenPGP))
plain)
(plstore--set-encrypted-data plstore nil))))
(defun plstore--match (entry keys skip-if-secret-found)
+ "Return whether plist KEYS matches ENTRY.
+ENTRY should be a key of the merged alist of a PLSTORE. This
+function returns nil if KEYS do not match ENTRY, t if they match,
+and symbol `secret' if the secret alist needs to be consulted to
+perform a match."
(let ((result t) key-name key-value prop-value secret-name)
(while keys
(setq key-name (car keys)
result))
(defun plstore-find (plstore keys)
- "Perform search on PLSTORE with KEYS.
-KEYS is a plist."
+ "Return all PLSTORE entries matching plist KEYS."
(let (entries alist entry match decrypt plist)
- ;; First, go through the merged plist alist and collect entries
- ;; matched with keys.
+ ;; First, go through the merged alist and collect entries matched
+ ;; by the keys.
(setq alist (plstore--get-merged-alist plstore))
(while alist
(setq entry (car alist)
plist nil))
(setq plist (nthcdr 2 plist)))
(setq entries (cons entry entries)))))
- ;; Second, decrypt the encrypted plist and try again.
+ ;; Second, decrypt the plstore and try again.
(when decrypt
(setq entries nil)
(plstore--decrypt plstore)
(nreverse entries)))
(defun plstore-get (plstore name)
- "Get an entry with NAME in PLSTORE."
+ "Return the entry named NAME in PLSTORE.
+Return nil if there is none."
(let ((entry (assoc name (plstore--get-merged-alist plstore)))
plist)
(setq plist (cdr entry))
entry))
(defun plstore-put (plstore name keys secret-keys)
- "Put an entry with NAME in PLSTORE.
+ "Put an entry named NAME in PLSTORE.
KEYS is a plist containing non-secret data.
SECRET-KEYS is a plist containing secret data."
(let (entry
(plstore--merge-secret plstore)))
(defun plstore-delete (plstore name)
- "Delete an entry with NAME from PLSTORE."
+ "Delete the first entry named NAME from PLSTORE."
(let ((entry (assoc name (plstore--get-alist plstore))))
(if entry
(plstore--set-alist
(defvar pp-escape-newlines)
(defun plstore--insert-buffer (plstore)
+ "Insert the file representation of PLSTORE at point.
+Assumes that PLSTORE has been decrypted."
(insert ";;; public entries -*- mode: plstore -*- \n"
(pp-to-string (plstore--get-alist plstore)))
(if (plstore--get-secret-alist plstore)
(insert ";;; secret entries\n" (pp-to-string cipher)))))
(defun plstore-save (plstore)
- "Save the contents of PLSTORE associated with a FILE."
+ "Save PLSTORE to its associated file."
(with-current-buffer (plstore--get-buffer plstore)
(erase-buffer)
(plstore--insert-buffer plstore)
(save-buffer)))
+;;; plstore mode.
+
;; The functions related to plstore mode unfortunately introduce yet
;; another alist format ("decoded alist"). After executing the "foo",
;; "bar", "baz" example from above the decoded alist of the plstore
;; `plstore-encoded' is non-nil if a buffer shows the decoded form.
(defun plstore--encode (plstore)
+ "Return the printed representation of the decoded alist of PLSTORE."
(plstore--decrypt plstore)
(let ((merged-alist (plstore--get-merged-alist plstore)))
(concat "("
")")))
(defun plstore--decode (string)
+ "Create a plstore instance from STRING.
+STRING should be the printed representation of a decoded alist of
+some plstore."
(let* ((alist (car (read-from-string string)))
(pointer alist)
secret-alist
entry)
(while pointer
(unless (stringp (car (car pointer)))
- (error "Invalid PLSTORE format %s" string))
+ (error "Invalid plstore format %s" string))
(setq plist (cdr (car pointer)))
(while plist
(when (string-match "\\`:secret-" (symbol-name (car plist)))
(plstore--make nil alist nil secret-alist)))
(defun plstore--write-contents-functions ()
+ "Convert the decoded form of a plstore in the current buffer.
+Convert it to the regular file representation of a plstore if
+needed. This function is used on hook `write-contents-functions'
+in plstore mode buffers."
(when plstore-encoded
(let ((store (plstore--decode (buffer-string)))
(file (buffer-file-name)))
(erase-buffer)
(insert
(substitute-command-keys "\
-;;; You are looking at the decoded form of the PLSTORE file.\n\
+;;; You are looking at the decoded form of the plstore file.\n\
;;; To see the original form content, do \\[plstore-mode-toggle-display]\n\n"))
(insert (plstore--encode store))
(set-buffer-modified-p nil)
;;;###autoload
(define-derived-mode plstore-mode emacs-lisp-mode "PLSTORE"
- "Major mode for editing PLSTORE files."
+ "Major mode for editing plstore files."
(make-local-variable 'plstore-encoded)
(add-hook 'write-contents-functions #'plstore--write-contents-functions)
(define-key plstore-mode-map "\C-c\C-c" #'plstore-mode-toggle-display)
projects / emacs.git / commitdiff