org-archive.el: Add command to archive entries with timestamps before today master
authorToby S. Cubitt <tsc25@cantab.net>
Fri, 17 Jan 2014 15:14:13 +0000 (15:14 +0000)
committerNicolas Goaziou <mail@nicolasgoaziou.fr>
Tue, 16 Dec 2014 23:08:39 +0000 (00:08 +0100)
* lisp/org-archive.el (org-archive-all-old): archive all entries with
  timestamps prior to today.
  (org-archive-subtree): double prefix argument invokes
  org-archive-all-old.
  (org-archive-all-matches, org-archive-all-done): factor out common
  code into org-archive-all-matches.

doc/org.texi
lisp/org-archive.el

index 03f0e91..7c464ca 100644 (file)
@@ -7513,6 +7513,10 @@ the archive.  To do this, each subtree is checked for open TODO entries.
 If none are found, the command offers to move it to the archive
 location.  If the cursor is @emph{not} on a headline when this command
 is invoked, the level 1 trees will be checked.
+@orgkey{C-u C-u C-c C-x C-s}
+As above, but check subtree for timestamps instead of TODO entries.  The
+command will offer to archive the subtree if it @emph{does} contain a
+timestamp, and that timestamp is in the past.
 @end table
 
 @cindex archive locations
index 96ef021..3e14291 100644 (file)
@@ -204,9 +204,11 @@ The archive can be a certain top-level heading in the current file, or in
 a different file.  The tree will be moved to that location, the subtree
 heading be marked DONE, and the current time will be added.
 
-When called with prefix argument FIND-DONE, find whole trees without any
+When called with a single prefix argument FIND-DONE, find whole trees without any
 open TODO items and archive them (after getting confirmation from the user).
-If the cursor is not at a headline when this command is called, try all level
+When called with a double prefix argument, find whole trees with timestamps before
+today and archive them (after getting confirmation from the user).
+If the cursor is not at a headline when these commands are called, try all level
 1 trees.  If the cursor is on a headline, only try the direct children of
 this heading."
   (interactive "P")
@@ -219,8 +221,10 @@ this heading."
                 (org-archive-subtree ,find-done))
         org-loop-over-headlines-in-active-region
         cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
-    (if find-done
-       (org-archive-all-done)
+    (cond
+     ((equal find-done '(4))  (org-archive-all-done))
+     ((equal find-done '(16)) (org-archive-all-old))
+     (t
       ;; Save all relevant TODO keyword-relatex variables
       (let ((tr-org-todo-line-regexp org-todo-line-regexp) ; keep despite compiler
            (tr-org-todo-keywords-1 org-todo-keywords-1)
@@ -383,7 +387,7 @@ this heading."
        (message "Subtree archived %s"
                 (if (eq this-buffer buffer)
                     (concat "under heading: " heading)
-                  (concat "in file: " (abbreviate-file-name afile))))))
+                  (concat "in file: " (abbreviate-file-name afile)))))))
     (org-reveal)
     (if (looking-at "^[ \t]*$")
        (outline-next-visible-heading 1))))
@@ -464,13 +468,50 @@ sibling does not exist, it will be created at the end of the subtree."
 If the cursor is not on a headline, try all level 1 trees.  If
 it is on a headline, try all direct children.
 When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
-  (let ((re org-not-done-heading-regexp) re1
-       (rea (concat ".*:" org-archive-tag ":"))
+  (org-archive-all-matches
+   (lambda (beg end)
+     (unless (re-search-forward org-not-done-heading-regexp end t)
+       "no open TODO items"))
+   tag))
+
+(defun org-archive-all-old (&optional tag)
+  "Archive sublevels of the current tree with timestamps prior to today.
+If the cursor is not on a headline, try all level 1 trees.  If
+it is on a headline, try all direct children.
+When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
+  (org-archive-all-matches
+   (lambda (beg end)
+     (let (ts)
+       (and (re-search-forward org-ts-regexp end t)
+           (setq ts (match-string 0))
+           (< (org-time-stamp-to-now ts) 0)
+           (if (not (looking-at
+                     (concat "--\\(" org-ts-regexp "\\)")))
+               (concat "old timestamp " ts)
+             (setq ts (concat "old timestamp " ts (match-string 0)))
+             (and (< (org-time-stamp-to-now (match-string 1)) 0)
+                  ts)))))
+   tag))
+
+(defun org-archive-all-matches (predicate &optional tag)
+  "Archive sublevels of the current tree that match PREDICATE.
+
+PREDICATE is a function of two arguments, BEG and END, which
+specify the beginning and end of the headline being considered.
+It is called with point positioned at BEG.  The headline will be
+archived if PREDICATE returns non-nil.  If the return value of
+PREDICATE is a string, it should describe the reason for
+archiving the heading.
+
+If the cursor is not on a headline, try all level 1 trees.  If it
+is on a headline, try all direct children.  When TAG is non-nil,
+don't move trees, but mark them with the ARCHIVE tag."
+  (let ((rea (concat ".*:" org-archive-tag ":")) re1
        (begm (make-marker))
        (endm (make-marker))
-       (question (if tag "Set ARCHIVE tag (no open TODO items)? "
-                   "Move subtree to archive (no open TODO items)? "))
-       beg end (cntarch 0))
+       (question (if tag "Set ARCHIVE tag? "
+                   "Move subtree to archive? "))
+       reason beg end (cntarch 0))
     (if (org-at-heading-p)
        (progn
          (setq re1 (concat "^" (regexp-quote
@@ -490,11 +531,14 @@ When TAG is non-nil, don't move trees, but mark them with the ARCHIVE tag."
        (setq beg (match-beginning 0)
              end (save-excursion (org-end-of-subtree t) (point)))
        (goto-char beg)
-       (if (re-search-forward re end t)
+       (if (not (setq reason (funcall predicate beg end)))
            (goto-char end)
          (goto-char beg)
          (if (and (or (not tag) (not (looking-at rea)))
-                  (y-or-n-p question))
+                  (y-or-n-p
+                   (if (stringp reason)
+                       (concat question "(" reason ")")
+                     question)))
              (progn
                (if tag
                    (org-toggle-tag org-archive-tag 'on)