Patch to add a new org-archive hook and context info type

Patch to add a new org-archive hook and context info type

[John Wiegley]

Hello,

The following patch adds ‘org-archive-finalize-hook’, which runs earlier than
‘org-archive-hook’ and in the destination buffer, not the original file. This
allows the context to be extended, the archived entry to be cleaned up after
inseration, maybe even encrypted or hashed to prevent changes.

I also added a new ‘ARCHIVE_OLID’ context type, which preserves the ID of the
parent the archived entry was previously under. This is because ARCHIVE_OLPATH
is not stable: it’s very possible the tree structure may change over time and
invalidate the path. But as long as the original parent is not deleted, there
stands a better chance that the original context of the archived entry can be
restored.

John

--- a/lisp/org-archive.el
+++ b/lisp/org-archive.el
@@ -144,13 +144,26 @@ information."
 	      (const :tag "Priority" priority)
 	      (const :tag "Inherited tags" itags)
 	      (const :tag "Outline path" olpath)
+	      (const :tag "Outline parent id" olid)
 	      (const :tag "Local tags" ltags)))
 
-(defvar org-archive-hook nil
+(defcustom org-archive-hook nil
   "Hook run after successfully archiving a subtree.
 Hook functions are called with point on the subtree in the
 original file.  At this stage, the subtree has been added to the
-archive location, but not yet deleted from the original file.")
+archive location, but not yet deleted from the original file."
+  :group 'org-archive
+  :type 'hook)
+
+(defcustom org-archive-finalize-hook nil
+  "Hook run after successfully archiving a subtree in final location.
+Hook functions are called with point on the subtree in the
+destination file. Compare this with `org-archive-hook', which
+runs in the original file. At this stage, the subtree has been
+added to the archive location, but not yet deleted from the
+original file."
+  :group 'org-archive
+  :type 'hook)
 
 ;;;###autoload
 (defun org-add-archive-files (files)
@@ -299,6 +312,9 @@ direct children of this heading."
 		    (olpath . ,(mapconcat #'identity
 					  (org-get-outline-path)
 					  "/"))
+                    (olid . ,(org-with-wide-buffer
+                              (and (org-up-heading-safe)
+	                           (org-entry-get (point) "ID"))))
 		    (time . ,time)
 		    (todo . ,(org-entry-get (point) "TODO")))))
 	    ;; We first only copy, in case something goes wrong
@@ -393,6 +409,7 @@ direct children of this heading."
 		     (point)
 		     (concat "ARCHIVE_" (upcase (symbol-name item)))
 		     value))))
+              (run-hooks 'org-archive-finalize-hook)
 	      ;; Save the buffer, if it is not the same buffer and
 	      ;; depending on `org-archive-subtree-save-file-p'.
 	      (unless (eq this-buffer buffer)