diff options
Diffstat (limited to 'lisp/org/org-mobile.el')
| -rw-r--r-- | lisp/org/org-mobile.el | 714 |
1 files changed, 574 insertions, 140 deletions
diff --git a/lisp/org/org-mobile.el b/lisp/org/org-mobile.el index 65d063db7d1..b9e267113d1 100644 --- a/lisp/org/org-mobile.el +++ b/lisp/org/org-mobile.el @@ -4,7 +4,7 @@ ;; Author: Carsten Dominik <carsten at orgmode dot org> ;; Keywords: outlines, hypermedia, calendar, wp ;; Homepage: http://orgmode.org -;; Version: 6.31a +;; Version: 6.33 ;; ;; This file is part of GNU Emacs. ;; @@ -28,20 +28,21 @@ ;; This file contains the code to interact with Richard Moreland's iPhone ;; application MobileOrg. This code is documented in Appendix B of the ;; Org-mode manual. The code is not specific for the iPhone, however. -;; Any external viewer and flagging application that uses the same +;; Any external viewer/flagging/editing application that uses the same ;; conventions could be used. (require 'org) (require 'org-agenda) +(eval-when-compile (require 'cl)) (defgroup org-mobile nil - "Options concerning support for a viewer on a mobile device." + "Options concerning support for a viewer/editor on a mobile device." :tag "Org Mobile" :group 'org) (defcustom org-mobile-files '(org-agenda-files) "Files to be staged for MobileOrg. -This is basically a list of filesand directories. Files will be staged +This is basically a list of files and directories. Files will be staged directly. Directories will be search for files with the extension `.org'. In addition to this, the list may also contain the following symbols: @@ -68,7 +69,8 @@ org-agenda-text-search-extra-files "The file where captured notes and flags will be appended to. During the execution of `org-mobile-pull', the file `org-mobile-capture-file' will be emptied it's contents have -been appended to the file given here." +been appended to the file given here. This file should be in +`org-directory', and not in the staging area or on the web server." :group 'org-mobile :type 'file) @@ -88,12 +90,26 @@ should point to this file." :group 'org-mobile :type 'boolean) +(defcustom org-mobile-force-mobile-change nil + "Non-nil means, force the change made on the mobile device. +So even if there have been changes to the computer version of the entry, +force the new value set on the mobile. +When nil, mark the entry from the mobile with an error message. +Instead of nil or t, this variable can also be a list of symbols, indicating +the editing types for which the mobile version should always dominate." + :group 'org-mobile + :type '(choice + (const :tag "Always" t) + (const :tag "Never" nil) + (set :greedy t :tag "Specify" + (const todo) + (const tags) + (const priority) + (const heading) + (const body)))) + (defcustom org-mobile-action-alist - '(("d" . (org-todo 'done)) - ("a" . (org-archive-subtree-default)) - ("d-a" . (progn (org-todo 'done) (org-archive-subtree-default))) - ("todo" . (org-todo data)) - ("tags" . (org-set-tags-to data))) + '(("edit" . (org-mobile-edit data old new))) "Alist with flags and actions for mobile sync. When flagging an entry, MobileOrg will create entries that look like @@ -105,12 +121,22 @@ optional. If present, the string after the colon will be passed to the action form as the `data' variable. The car of each elements of the alist is an actions string. The cdr is an Emacs Lisp form that will be evaluated with the cursor on the headline -of that entry." +of that entry. + +For now, it is not recommended to change this variable." :group 'org-mobile :type '(repeat (cons (string :tag "Action flag") (sexp :tag "Action form")))) +(defcustom org-mobile-checksum-binary (or (executable-find "shasum") + (executable-find "sha1sum") + (executable-find "md5sum") + (executable-find "md5")) + "Executable used for computing checksums of agenda files." + :group 'org-mobile + :type 'string) + (defvar org-mobile-pre-push-hook nil "Hook run before running `org-mobile-push'. This could be used to clean up `org-mobile-directory', for example to @@ -140,36 +166,46 @@ capture file `mobileorg.org' back to the WebDAV directory, for example using `rsync' or `scp'.") (defvar org-mobile-last-flagged-files nil - "List of files containing entreis flagged in the latest pull.") + "List of files containing entries flagged in the latest pull.") (defvar org-mobile-files-alist nil) (defvar org-mobile-checksum-files nil) (defun org-mobile-prepare-file-lists () (setq org-mobile-files-alist (org-mobile-files-alist)) - (setq org-mobile-checksum-files (mapcar 'cdr org-mobile-files-alist))) + (setq org-mobile-checksum-files nil)) (defun org-mobile-files-alist () "Expand the list in `org-mobile-files' to a list of existing files." - (let* ((files - (apply 'append (mapcar - (lambda (f) - (cond - ((eq f 'org-agenda-files) (org-agenda-files t)) - ((eq f 'org-agenda-text-search-extra-files) - org-agenda-text-search-extra-files) - ((and (stringp f) (file-directory-p f)) - (directory-files f 'full "\\.org\\'")) - ((and (stringp f) (file-exists-p f)) - (list f)) - (t nil))) - org-mobile-files))) + (let* ((include-archives + (and (member 'org-agenda-text-search-extra-files org-mobile-files) + (member 'agenda-archives org-agenda-text-search-extra-files) + t)) + (files + (apply 'append + (mapcar + (lambda (f) + (cond + ((eq f 'org-agenda-files) + (org-agenda-files t include-archives)) + ((eq f 'org-agenda-text-search-extra-files) + (delq 'agenda-archives + (copy-sequence + org-agenda-text-search-extra-files))) + ((and (stringp f) (file-directory-p f)) + (directory-files f 'full "\\.org\\'")) + ((and (stringp f) (file-exists-p f)) + (list f)) + (t nil))) + org-mobile-files))) (orgdir-uname (file-name-as-directory (file-truename org-directory))) (orgdir-re (concat "\\`" (regexp-quote orgdir-uname))) uname seen rtn file link-name) ;; Make the files unique, and determine the name under which they will ;; be listed. (while (setq file (pop files)) + (if (not (file-name-absolute-p file)) + (setq file (expand-file-name file org-directory))) (setq uname (file-truename file)) (unless (member uname seen) (push uname seen) @@ -185,16 +221,41 @@ using `rsync' or `scp'.") This will create the index file, copy all agenda files there, and also create all custom agenda views, for upload to the mobile phone." (interactive) - (org-mobile-check-setup) - (org-mobile-prepare-file-lists) - (run-hooks 'org-mobile-pre-push-hook) - (org-mobile-create-sumo-agenda) - (org-save-all-org-buffers) ; to save any IDs created by this process - (org-mobile-copy-agenda-files) - (org-mobile-create-index-file) - (org-mobile-write-checksums) - (run-hooks 'org-mobile-post-push-hook) + (let ((a-buffer (get-buffer org-agenda-buffer-name))) + (let ((org-agenda-buffer-name "*SUMO*") + (org-agenda-filter org-agenda-filter) + (org-agenda-redo-command org-agenda-redo-command)) + (save-excursion + (save-window-excursion + (org-mobile-check-setup) + (org-mobile-prepare-file-lists) + (run-hooks 'org-mobile-pre-push-hook) + (message "Creating agendas...") + (let ((inhibit-redisplay t)) (org-mobile-create-sumo-agenda)) + (message "Creating agendas...done") + (org-save-all-org-buffers) ; to save any IDs created by this process + (message "Copying files...") + (org-mobile-copy-agenda-files) + (message "Writing index file...") + (org-mobile-create-index-file) + (message "Writing checksums...") + (org-mobile-write-checksums) + (run-hooks 'org-mobile-post-push-hook)))) + (redraw-display) + (when (and a-buffer (buffer-live-p a-buffer)) + (if (not (get-buffer-window a-buffer)) + (kill-buffer a-buffer) + (let ((cw (selected-window))) + (select-window (get-buffer-window a-buffer)) + + (org-agenda-redo) + (select-window cw))))) (message "Files for mobile viewer staged")) + +(defvar org-mobile-before-process-capture-hook nil + "Hook that is run after content was moved to `org-mobile-inbox-for-pull'. +The inbox file is in the current buffer, and the buffer is arrowed to the +new captured data.") ;;;###autoload (defun org-mobile-pull () @@ -208,37 +269,52 @@ agenda view showing the flagged items." (if (not (markerp insertion-marker)) (message "No new items") (org-with-point-at insertion-marker - (org-mobile-apply-flags (point) (point-max))) + (save-restriction + (narrow-to-region (point) (point-max)) + (run-hooks 'org-mobile-before-process-capture-hook))) + (org-with-point-at insertion-marker + (org-mobile-apply (point) (point-max))) (move-marker insertion-marker nil) (run-hooks 'org-mobile-post-pull-hook) (when org-mobile-last-flagged-files ;; Make an agenda view of flagged entries, but only in the files ;; where stuff has been added. (put 'org-agenda-files 'org-restrict org-mobile-last-flagged-files) - (let ((org-agenda-keep-restriced-file-list t)) + (let ((org-agenda-keep-restricted-file-list t)) (org-agenda nil "?")))))) (defun org-mobile-check-setup () "Check if org-mobile-directory has been set up." - (when (or (not org-mobile-directory) - (not (stringp org-mobile-directory)) - (not (string-match "\\S-" org-mobile-directory)) - (not (file-exists-p org-mobile-directory)) - (not (file-directory-p org-mobile-directory))) + (unless (and org-directory + (stringp org-directory) + (string-match "\\S-" org-directory) + (file-exists-p org-directory) + (file-directory-p org-directory)) + (error + "Please set `org-directory' to the directory where your org files live")) + (unless (and org-mobile-directory + (stringp org-mobile-directory) + (string-match "\\S-" org-mobile-directory) + (file-exists-p org-mobile-directory) + (file-directory-p org-mobile-directory)) (error "Variable `org-mobile-directory' must point to an existing directory")) - (when (or (not org-mobile-inbox-for-pull) - (not (stringp org-mobile-inbox-for-pull)) - (not (string-match "\\S-" org-mobile-inbox-for-pull)) - (not (file-exists-p - (file-name-directory org-mobile-inbox-for-pull)))) + (unless (and org-mobile-inbox-for-pull + (stringp org-mobile-inbox-for-pull) + (string-match "\\S-" org-mobile-inbox-for-pull) + (file-exists-p + (file-name-directory org-mobile-inbox-for-pull))) (error "Variable `org-mobile-inbox-for-pull' must point to a file in an existing directory"))) (defun org-mobile-create-index-file () "Write the index file in the WebDAV directory." - (let ((files-alist org-mobile-files-alist) - file link-name todo-kwds done-kwds tags drawers entry) + (let ((files-alist (sort (copy-sequence org-mobile-files-alist) + (lambda (a b) (string< (cdr a) (cdr b))))) + (def-todo (default-value 'org-todo-keywords)) + (def-tags (default-value 'org-tag-alist)) + file link-name todo-kwds done-kwds tags drawers entry kwds dwds twds) + (org-prepare-agenda-buffers (mapcar 'car files-alist)) (setq done-kwds (org-uniquify org-done-keywords-for-agenda)) (setq todo-kwds (org-delete-all @@ -256,61 +332,87 @@ agenda view showing the flagged items." org-tag-alist-for-agenda)))) (with-temp-file (expand-file-name org-mobile-index-file org-mobile-directory) - (insert "#+TODO: " (mapconcat 'identity todo-kwds " ") " | " - (mapconcat 'identity done-kwds " ") "\n" - "#+TAGS: " (mapconcat 'identity tags " ") "\n" - "#+DRAWERS: " (mapconcat 'identity drawers " ") "\n") - (insert "* [[file:agendas.org][Agenda Views]]\n") + (while (setq entry (pop def-todo)) + (insert "#+READONLY\n") + (setq kwds (mapcar (lambda (x) (if (string-match "(" x) + (substring x 0 (match-beginning 0)) + x)) + (cdr entry))) + (insert "#+TODO: " (mapconcat 'identity kwds " ") "\n") + (setq dwds (member "|" kwds) + twds (org-delete-all dwds kwds) + todo-kwds (org-delete-all twds todo-kwds) + done-kwds (org-delete-all dwds done-kwds))) + (when (or todo-kwds done-kwds) + (insert "#+TODO: " (mapconcat 'identity todo-kwds " ") " | " + (mapconcat 'identity done-kwds " ") "\n")) + (setq def-tags (mapcar + (lambda (x) + (cond ((null x) nil) + ((stringp x) x) + ((eq (car x) :startgroup) "{") + ((eq (car x) :endgroup) "}") + ((eq (car x) :newline) nil) + ((listp x) (car x)) + (t nil))) + def-tags)) + (setq def-tags (delq nil def-tags)) + (setq tags (org-delete-all def-tags tags)) + (setq tags (sort tags (lambda (a b) (string< (downcase a) (downcase b))))) + (setq tags (append def-tags tags nil)) + (insert "#+TAGS: " (mapconcat 'identity tags " ") "\n") + (insert "#+DRAWERS: " (mapconcat 'identity drawers " ") "\n") + (insert "#+ALLPRIORITIES: A B C" "\n") + (when (file-exists-p (expand-file-name + org-mobile-directory "agendas.org")) + (insert "* [[file:agendas.org][Agenda Views]]\n")) (while (setq entry (pop files-alist)) (setq file (car entry) link-name (cdr entry)) (insert (format "* [[file:%s][%s]]\n" link-name link-name))) - (insert (format "* [[file:%s][Captured before last sync]]\n" - org-mobile-capture-file))))) + (push (cons org-mobile-index-file (md5 (buffer-string))) + org-mobile-checksum-files)))) (defun org-mobile-copy-agenda-files () "Copy all agenda files to the stage or WebDAV directory." (let ((files-alist org-mobile-files-alist) - file buf entry link-name target-path target-dir) + file buf entry link-name target-path target-dir check) (while (setq entry (pop files-alist)) (setq file (car entry) link-name (cdr entry)) (when (file-exists-p file) (setq target-path (expand-file-name link-name org-mobile-directory) target-dir (file-name-directory target-path)) (unless (file-directory-p target-dir) - (make-directory target-dir 'parents) - (copy-file file target-path 'ok-if-exists)))) + (make-directory target-dir 'parents)) + (copy-file file target-path 'ok-if-exists) + (setq check (shell-command-to-string + (concat org-mobile-checksum-binary " " + (shell-quote-argument (expand-file-name file))))) + (when (string-match "[a-fA-F0-9]\\{30,40\\}" check) + (push (cons link-name (match-string 0 check)) + org-mobile-checksum-files)))) (setq file (expand-file-name org-mobile-capture-file org-mobile-directory)) - (unless (file-exists-p file) - (save-excursion - (setq buf (find-file file)) - (insert "\n") - (save-buffer)) - (kill-buffer buf)))) + (save-excursion + (setq buf (find-file file)) + (and (= (point-min) (point-max)) (insert "\n")) + (save-buffer) + (push (cons org-mobile-capture-file (md5 (buffer-string))) + org-mobile-checksum-files)) + (kill-buffer buf))) (defun org-mobile-write-checksums () "Create checksums for all files in `org-mobile-directory'. The table of checksums is written to the file mobile-checksums." - (let ((cmd (cond ((executable-find "shasum")) - ((executable-find "sha1sum")) - ((executable-find "md5sum")) - ((executable-find "md5")))) - (files org-mobile-checksum-files)) - (if (not cmd) - (message "Checksums could not be generated: no executable") - (with-temp-buffer - (cd org-mobile-directory) - (if (file-exists-p "agendas.org") - (push "agendas.org" files)) - (if (file-exists-p "mobileorg.org") - (push "mobileorg.org" files)) - (setq cmd (concat cmd " " (mapconcat 'shell-quote-argument files " ") - " > checksums.dat")) - (if (equal 0 (shell-command cmd)) - (message "Checksums written") - (message "Checksums could not be generated")))))) + (let ((sumfile (expand-file-name "checksums.dat" org-mobile-directory)) + (files org-mobile-checksum-files) + entry file sum) + (with-temp-file sumfile + (set-buffer-file-coding-system 'undecided-unix nil) + (while (setq entry (pop files)) + (setq file (car entry) sum (cdr entry)) + (insert (format "%s %s\n" sum file)))))) (defun org-mobile-sumo-agenda-command () "Return an agenda custom command that comprises all custom commands." @@ -342,10 +444,10 @@ The table of checksums is written to the file mobile-checksums." settings (nth 4 e)) (setq settings (cons (list 'org-agenda-title-append - (concat "<break>KEYS=" key " TITLE: " + (concat "<after>KEYS=" key " TITLE: " (if (and (stringp desc) (> (length desc) 0)) desc (symbol-name type)) - " " match)) + " " match "</after>")) settings)) (push (list type match settings) new)) ((symbolp (nth 2 e)) @@ -360,12 +462,78 @@ The table of checksums is written to the file mobile-checksums." (setq settings (append gsettings settings)) (setq settings (cons (list 'org-agenda-title-append - (concat "<break>KEYS=" gkey "#" (number-to-string + (concat "<after>KEYS=" gkey "#" (number-to-string (setq cnt (1+ cnt))) - " TITLE: " gdesc " " match)) + " TITLE: " gdesc " " match "</after>")) settings)) (push (list type match settings) new))))) - (list "X" "SUMO" (reverse new) nil))) + (and new (list "X" "SUMO" (reverse new) + '((org-agenda-compact-blocks nil)))))) + +(defvar org-mobile-creating-agendas nil) +(defun org-mobile-write-agenda-for-mobile (file) + (let ((all (buffer-string)) in-date id pl prefix line app short m sexp) + (with-temp-file file + (org-mode) + (insert "#+READONLY\n") + (insert all) + (goto-char (point-min)) + (while (not (eobp)) + (cond + ((looking-at "[ \t]*$")) ; keep empty lines + ((looking-at "=+$") + ;; remove underlining + (delete-region (point) (point-at-eol))) + ((get-text-property (point) 'org-agenda-structural-header) + (setq in-date nil) + (setq app (get-text-property (point) + 'org-agenda-title-append)) + (setq short (get-text-property (point) + 'short-heading)) + (when (and short (looking-at ".+")) + (replace-match short) + (beginning-of-line 1)) + (when app + (end-of-line 1) + (insert app) + (beginning-of-line 1)) + (insert "* ")) + ((get-text-property (point) 'org-agenda-date-header) + (setq in-date t) + (insert "** ")) + ((setq m (or (get-text-property (point) 'org-hd-marker) + (get-text-property (point) 'org-marker))) + (setq sexp (member (get-text-property (point) 'type) + '("diary" "sexp"))) + (if (setq pl (get-text-property (point) 'prefix-length)) + (progn + (setq prefix (org-trim (buffer-substring + (point) (+ (point) pl))) + line (org-trim (buffer-substring + (+ (point) pl) + (point-at-eol)))) + (delete-region (point-at-bol) (point-at-eol)) + (insert line "<before>" prefix "</before>") + (beginning-of-line 1)) + (and (looking-at "[ \t]+") (replace-match ""))) + (insert (if in-date "*** " "** ")) + (end-of-line 1) + (insert "\n") + (unless sexp + (insert (org-agenda-get-some-entry-text + m 10 " " 'planning) + "\n") + (when (setq id + (if (org-bound-and-true-p + org-mobile-force-id-on-agenda-items) + (org-id-get m 'create) + (org-entry-get m "ID"))) + (insert " :PROPERTIES:\n :ORIGINAL_ID: " id + "\n :END:\n"))))) + (beginning-of-line 2)) + (push (cons (file-name-nondirectory file) (md5 (buffer-string))) + org-mobile-checksum-files)) + (message "Agenda written to Org file %s" file))) ;;;###autoload (defun org-mobile-create-sumo-agenda () @@ -373,17 +541,19 @@ The table of checksums is written to the file mobile-checksums." (interactive) (let* ((file (expand-file-name "agendas.org" org-mobile-directory)) + (sumo (org-mobile-sumo-agenda-command)) (org-agenda-custom-commands - (list (append (org-mobile-sumo-agenda-command) - (list (list file)))))) + (list (append sumo (list (list file))))) + (org-mobile-creating-agendas t)) (unless (file-writable-p file) (error "Cannot write to file %s" file)) - (org-store-agenda-views))) + (when sumo + (org-store-agenda-views)))) (defun org-mobile-move-capture () "Move the contents of the capture file to the inbox file. Return a marker to the location where the new content has been added. -If nothing new has beed added, return nil." +If nothing new has been added, return nil." (interactive) (let ((inbox-buffer (find-file-noselect org-mobile-inbox-for-pull)) (capture-buffer (find-file-noselect @@ -404,71 +574,180 @@ If nothing new has beed added, return nil." (save-buffer) (set-buffer capture-buffer) (erase-buffer) - (save-buffer))) + (save-buffer) + (org-mobile-update-checksum-for-capture-file (buffer-string)))) (kill-buffer capture-buffer) (if not-empty insertion-point))) -(defun org-mobile-apply-flags (&optional beg end) - "Apply all flags in the current buffer. +(defun org-mobile-update-checksum-for-capture-file (buffer-string) + (let* ((file (expand-file-name "checksums.dat" org-mobile-directory)) + (buffer (find-file-noselect file))) + (when buffer + (with-current-buffer buffer + (when (re-search-forward (concat "\\([0-9a-fA-F]\\{30,\\}\\).*?" + (regexp-quote org-mobile-capture-file) + "[ \t]*$") nil t) + (goto-char (match-beginning 1)) + (delete-region (match-beginning 1) (match-end 1)) + (insert (md5 buffer-string)) + (save-buffer))) + (kill-buffer buffer)))) + +(defun org-mobile-apply (&optional beg end) + "Apply all change requests in the current buffer. If BEG and END are given, only do this in that region." (interactive) (require 'org-archive) (setq org-mobile-last-flagged-files nil) (setq beg (or beg (point-min)) end (or end (point-max))) + + ;; Remove all Note IDs (goto-char beg) + (while (re-search-forward "^\\*\\* Note ID: [-0-9A-F]+[ \t]*\n" end t) + (replace-match "")) + + ;; Find all the referenced entries, without making any changes yet (let ((marker (make-marker)) - (org-inhibit-logging 'note) + (bos-marker (make-marker)) (end (move-marker (make-marker) end)) - action data id id-pos cmd text) + (cnt-new 0) + (cnt-edit 0) + (cnt-flag 0) + (cnt-error 0) + buf-list + id-pos org-mobile-error) + + ;; Count the new captures + (goto-char beg) + (while (re-search-forward "^\\* \\(.*\\)" end t) + (and (>= (- (match-end 1) (match-beginning 1)) 2) + (not (equal (downcase (substring (match-string 1) 0 2)) "f(")) + (incf cnt-new))) + + (goto-char beg) (while (re-search-forward - "^\\*+[ \t]+F(\\([^():\n]*\\)\\(:\\([^()\n]*\\)\\)?)[ \t]+\\[\\[id:\\([^]\n ]+\\)" end t) - (goto-char (- (match-beginning 1) 2)) + "^\\*+[ \t]+F(\\([^():\n]*\\)\\(:\\([^()\n]*\\)\\)?)[ \t]+\\[\\[\\(\\(id\\|olp\\):\\([^]\n]+\\)\\)" end t) + (setq id-pos (condition-case msg + (org-mobile-locate-entry (match-string 4)) + (error (nth 1 msg)))) + (when (and (markerp id-pos) + (not (member (marker-buffer id-pos) buf-list))) + (org-mobile-timestamp-buffer (marker-buffer id-pos)) + (push (marker-buffer id-pos) buf-list)) + + (if (or (not id-pos) (stringp id-pos)) + (progn + (goto-char (+ 2 (point-at-bol))) + (insert id-pos " ") + (incf cnt-error)) + (add-text-properties (point-at-bol) (point-at-eol) + (list 'org-mobile-marker + (or id-pos "Linked entry not found"))))) + + ;; OK, now go back and start applying + (goto-char beg) + (while (re-search-forward "^\\*+[ \t]+F(\\([^():\n]*\\)\\(:\\([^()\n]*\\)\\)?)" end t) (catch 'next - (setq action (match-string 1) - data (and (match-end 3) (match-string 3)) - id (match-string 4) - cmd (if (equal action "") - '(progn - (org-toggle-tag "FLAGGED" 'on) - (and text (org-entry-put nil "THEFLAGGINGNOTE" text))) - (cdr (assoc action org-mobile-action-alist))) - text (org-trim (buffer-substring (1+ (point-at-eol)) - (save-excursion - (org-end-of-subtree t)))) - id-pos (org-id-find id 'marker)) - (if (> (length text) 0) - ;; Make TEXT into a single line, to fit into a property - (setq text (mapconcat 'identity - (org-split-string text "\n") - "\\n")) - (setq text nil)) - (unless id-pos - (insert "BAD ID REFERENCE ") - (throw 'next t)) - (unless cmd - (insert "BAD FLAG ") - (throw 'next t)) - (move-marker marker (point)) - (save-excursion - (condition-case nil - (org-with-point-at id-pos - (progn + (setq id-pos (get-text-property (point-at-bol) 'org-mobile-marker)) + (if (not (markerp id-pos)) + (progn + (incf cnt-error) + (insert "UNKNOWN PROBLEM")) + (let* ((action (match-string 1)) + (data (and (match-end 3) (match-string 3))) + (bos (point-at-bol)) + (eos (save-excursion (org-end-of-subtree t t))) + (cmd (if (equal action "") + '(progn + (incf cnt-flag) + (org-toggle-tag "FLAGGED" 'on) + (and note + (org-entry-put nil "THEFLAGGINGNOTE" note))) + (incf cnt-edit) + (cdr (assoc action org-mobile-action-alist)))) + (note (and (equal action "") + (buffer-substring (1+ (point-at-eol)) eos))) + (org-inhibit-logging 'note) ;; Do not take notes interactively + old new) + (goto-char bos) + (move-marker bos-marker (point)) + (if (re-search-forward "^** Old value[ \t]*$" eos t) + (setq old (buffer-substring + (1+ (match-end 0)) + (progn (outline-next-heading) (point))))) + (if (re-search-forward "^** New value[ \t]*$" eos t) + (setq new (buffer-substring + (1+ (match-end 0)) + (progn (outline-next-heading) + (if (eobp) (org-back-over-empty-lines)) + (point))))) + (setq old (and old (if (string-match "\\S-" old) old nil))) + (setq new (and new (if (string-match "\\S-" new) new nil))) + (if (and note (> (length note) 0)) + ;; Make Note into a single line, to fit into a property + (setq note (mapconcat 'identity + (org-split-string (org-trim note) "\n") + "\\n"))) + (unless (equal data "body") + (setq new (and new (org-trim new)) + old (and old (org-trim old)))) + (goto-char (+ 2 bos-marker)) + (unless (markerp id-pos) + (insert "BAD REFERENCE ") + (incf cnt-error) + (throw 'next t)) + (unless cmd + (insert "BAD FLAG ") + (incf cnt-error) + (throw 'next t)) + ;; Remember this place so that we can return + (move-marker marker (point)) + (setq org-mobile-error nil) + (save-excursion + (condition-case msg + (org-with-point-at id-pos + (progn (eval cmd) (if (member "FLAGGED" (org-get-tags)) (add-to-list 'org-mobile-last-flagged-files (buffer-file-name (current-buffer)))))) - (error - (progn - (switch-to-buffer (marker-buffer marker)) - (goto-char marker) - (insert "EXECUTION FAILED ") - (throw 'next t))))) - ;; If we get here, the action has been applied successfully - ;; So remove the entry - (org-back-to-heading t) - (delete-region (point) (org-end-of-subtree t t)))) + (error (setq org-mobile-error msg)))) + (when org-mobile-error + (switch-to-buffer (marker-buffer marker)) + (goto-char marker) + (incf cnt-error) + (insert (if (stringp (nth 1 org-mobile-error)) + (nth 1 org-mobile-error) + "EXECUTION FAILED") + " ") + (throw 'next t)) + ;; If we get here, the action has been applied successfully + ;; So remove the entry + (goto-char bos-marker) + (delete-region (point) (org-end-of-subtree t t)))))) + (save-buffer) (move-marker marker nil) - (move-marker end nil))) + (move-marker end nil) + (message "%d new, %d edits, %d flags, %d errors" cnt-new + cnt-edit cnt-flag cnt-error) + (sit-for 1))) + +(defun org-mobile-timestamp-buffer (buf) + "Time stamp buffer BUF, just to make sure its checksum will change." + (with-current-buffer buf + (save-excursion + (save-restriction + (widen) + (goto-char (point-min)) + (if (re-search-forward + "^\\([ \t]*\\)#\\+LAST_MOBILE_CHANGE:.*\n?" nil t) + (progn + (goto-char (match-end 1)) + (delete-region (point) (match-end 0))) + (if (looking-at ".*?-\\*-.*-\\*-") + (forward-line 1))) + (insert "#+LAST_MOBILE_CHANGE: " + (format-time-string "%Y-%m-%d %T") "\n"))))) (defun org-mobile-smart-read () "Parse the entry at point for shortcuts and expand them. @@ -480,7 +759,7 @@ The entry is expected to contain an inactive time stamp indicating when the entry was created. When setting dates and times (for example for deadlines), the time strings are interpreted relative to that creation date. -Abbreviations are expected to take up entire lines, jst because it is so +Abbreviations are expected to take up entire lines, just because it is so easy to type RET on a mobile device. Abbreviations start with one or two letters, followed immediately by a dot and then additional information. Generally the entire shortcut line is removed after action have been taken. @@ -502,6 +781,161 @@ FIXME: Hmmm, not sure if we can make his work against the auto-correction feature. Needs a bit more thinking. So this function is currently a noop.") + +(defun org-find-olp (path) + "Return a marker pointing to the entry at outline path OLP. +If anything goes wrong, the return value will instead an error message, +as a string." + (let* ((file (pop path)) + (buffer (find-file-noselect file)) + (level 1) + (lmin 1) + (lmax 1) + limit re end found pos heading cnt) + (unless buffer (error "File not found :%s" file)) + (with-current-buffer buffer + (save-excursion + (save-restriction + (widen) + (setq limit (point-max)) + (goto-char (point-min)) + (while (setq heading (pop path)) + (setq re (format org-complex-heading-regexp-format + (regexp-quote heading))) + (setq cnt 0 pos (point)) + (while (re-search-forward re end t) + (setq level (- (match-end 1) (match-beginning 1))) + (if (and (>= level lmin) (<= level lmax)) + (setq found (match-beginning 0) cnt (1+ cnt)))) + (when (= cnt 0) (error "Heading not found on level %d: %s" + lmax heading)) + (when (> cnt 1) (error "Heading not unique on level %d: %s" + lmax heading)) + (goto-char found) + (setq lmin (1+ level) lmax (+ lmin (if org-odd-levels-only 1 0))) + (setq end (save-excursion (org-end-of-subtree t t)))) + (when (org-on-heading-p) + (move-marker (make-marker) (point)))))))) + +(defun org-mobile-locate-entry (link) + (if (string-match "\\`id:\\(.*\\)$" link) + (org-id-find (match-string 1 link) 'marker) + (if (not (string-match "\\`olp:\\(.*?\\):\\(.*\\)$" link)) + nil + (let ((file (match-string 1 link)) + (path (match-string 2 link)) + (table '((?: . "%3a") (?\[ . "%5b") (?\] . "%5d") (?/ . "%2f")))) + (setq file (org-link-unescape file table)) + (setq file (expand-file-name file org-directory)) + (setq path (mapcar (lambda (x) (org-link-unescape x table)) + (org-split-string path "/"))) + (org-find-olp (cons file path)))))) + +(defun org-mobile-edit (what old new) + "Edit item WHAT in the current entry by replacing OLD with NEW. +WHAT can be \"heading\", \"todo\", \"tags\", \"priority\", or \"body\". +The edit only takes place if the current value is equal (except for +white space) the OLD. If this is so, OLD will be replace by NEW +and the command will return t. If something goes wrong, a string will +be returned that indicates what went wrong." + (let (current old1 new1) + (if (stringp what) (setq what (intern what))) + + (cond + + ((memq what '(todo todostate)) + (setq current (org-get-todo-state)) + (cond + ((equal new "DONEARCHIVE") + (org-todo 'done) + (org-archive-subtree-default)) + ((equal new current) t) ; nothing needs to be done + ((or (equal current old) + (eq org-mobile-force-mobile-change t) + (memq 'todo org-mobile-force-mobile-change)) + (org-todo (or new 'none)) t) + (t (error "State before change was expected as \"%s\", but is \"%s\"" + old current)))) + + ((eq what 'tags) + (setq current (org-get-tags) + new1 (and new (org-split-string new ":+")) + old1 (and old (org-split-string old ":+"))) + (cond + ((org-mobile-tags-same-p current new1) t) ; no change needed + ((or (org-mobile-tags-same-p current old1) + (eq org-mobile-force-mobile-change t) + (memq 'tags org-mobile-force-mobile-change)) + (org-set-tags-to new1) t) + (t (error "Tags before change were expected as \"%s\", but are \"%s\"" + (or old "") (or current ""))))) + + ((eq what 'priority) + (when (looking-at org-complex-heading-regexp) + (setq current (and (match-end 3) (substring (match-string 3) 2 3))) + (cond + ((equal current new) t) ; no action required + ((or (equal current old) + (eq org-mobile-force-mobile-change t) + (memq 'tags org-mobile-force-mobile-change)) + (org-priority (and new (string-to-char new)))) + (t (error "Priority was expected to be %s, but is %s" + old current))))) + + ((eq what 'heading) + (when (looking-at org-complex-heading-regexp) + (setq current (match-string 4)) + (cond + ((equal current new) t) ; no action required + ((or (equal current old) + (eq org-mobile-force-mobile-change t) + (memq 'heading org-mobile-force-mobile-change)) + (goto-char (match-beginning 4)) + (insert new) + (delete-region (point) (+ (point) (length current))) + (org-set-tags nil 'align)) + (t (error "Heading changed in MobileOrg and on the computer"))))) + + ((eq what 'body) + (setq current (buffer-substring (min (1+ (point-at-eol)) (point-max)) + (save-excursion (outline-next-heading) + (point)))) + (if (not (string-match "\\S-" current)) (setq current nil)) + (cond + ((org-mobile-bodies-same-p current new) t) ; no action necessary + ((or (org-mobile-bodies-same-p current old) + (eq org-mobile-force-mobile-change t) + (memq 'body org-mobile-force-mobile-change)) + (save-excursion + (end-of-line 1) + (insert "\n" new) + (or (bolp) (insert "\n")) + (delete-region (point) (progn (org-back-to-heading t) + (outline-next-heading) + (point)))) + t) + (t (error "Body was changed in MobileOrg and on the computer"))))))) + + +(defun org-mobile-tags-same-p (list1 list2) + "Are the two tag lists the same?" + (not (or (org-delete-all list1 list2) + (org-delete-all list2 list1)))) + +(defun org-mobile-bodies-same-p (a b) + "Compare if A and B are visually equal strings. +We first remove leading and trailing white space from the entire strings. +Then we split the strings into lines and remove leading/trailing whitespace +from each line. Then we compare. +A and B must be strings or nil." + (cond + ((and (not a) (not b)) t) + ((or (not a) (not b)) nil) + (t (setq a (org-trim a) b (org-trim b)) + (setq a (mapconcat 'identity (org-split-string a "[ \t]*\n[ \t]*") "\n")) + (setq b (mapconcat 'identity (org-split-string b "[ \t]*\n[ \t]*") "\n")) + (equal a b)))) + (provide 'org-mobile) ;; arch-tag: ace0e26c-58f2-4309-8a61-05ec1535f658 |