1 ;;; org-mobile.el --- Code for asymmetric sync with a mobile device
2 ;; Copyright (C) 2009, 2010 Free Software Foundation, Inc.
4 ;; Author: Carsten Dominik <carsten at orgmode dot org>
5 ;; Keywords: outlines, hypermedia, calendar, wp
6 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
28 ;; This file contains the code to interact with Richard Moreland's iPhone
29 ;; application MobileOrg, as well as with the Android version by Matthew Jones.
30 ;; This code is documented in Appendix B of the Org-mode manual. The code is
31 ;; not specific for the iPhone and Android - any external
32 ;; viewer/flagging/editing application that uses the same conventions could
39 (eval-when-compile (require 'cl
))
41 (defgroup org-mobile nil
42 "Options concerning support for a viewer/editor on a mobile device."
46 (defcustom org-mobile-files
'(org-agenda-files)
47 "Files to be staged for MobileOrg.
48 This is basically a list of files and directories. Files will be staged
49 directly. Directories will be search for files with the extension `.org'.
50 In addition to this, the list may also contain the following symbols:
53 This means include the complete, unrestricted list of files given in
54 the variable `org-agenda-files'.
55 org-agenda-text-search-extra-files
56 Include the files given in the variable
57 `org-agenda-text-search-extra-files'"
59 :type
'(list :greedy t
60 (option (const :tag
"org-agenda-files" org-agenda-files
))
61 (option (const :tag
"org-agenda-text-search-extra-files"
62 org-agenda-text-search-extra-files
))
63 (repeat :inline t
:tag
"Additional files"
66 (defcustom org-mobile-directory
""
67 "The WebDAV directory where the interaction with the mobile takes place."
71 (defcustom org-mobile-use-encryption nil
72 "Non-nil means keep only encrypted files on the WebDAV server.
73 Encryption uses AES-256, with a password given in
74 `org-mobile-encryption-password'.
75 When nil, plain files are kept on the server.
76 Turning on encryption requires to set the same password in the MobileOrg
77 application. Before turning this on, check of MobileOrg does already
78 support it - at the time of this writing it did not yet."
82 (defcustom org-mobile-encryption-tempfile
"~/orgtmpcrypt"
83 "File that is being used as a temporary file for encryption.
84 This must be local file on your local machine (not on the WebDAV server).
85 You might want to put this file into a directory where only you have access."
89 (defcustom org-mobile-encryption-password
""
90 "Password for encrypting files uploaded to the server.
91 This is a single password which is used for AES-256 encryption. The same
92 password must also be set in the MobileOrg application. All Org files,
93 including mobileorg.org will be encrypted using this password.
95 SECURITY CONSIDERATIONS:
97 Note that, when Org runs the encryption commands, the password could
98 be visible briefly on your system with the `ps' command. So this method is
99 only intended to keep the files secure on the server, not on your own machine.
101 Also, if you set this variable in an init file (.emacs or .emacs.d/init.el
102 or custom.el...) and if that file is stored in a way so that other can read
103 it, this also limits the security of this approach. You can also leave
104 this variable empty - Org will then ask for the password once per Emacs
107 :type
'(string :tag
"Password"))
109 (defvar org-mobile-encryption-password-session nil
)
111 (defun org-mobile-encryption-password ()
112 (or (org-string-nw-p org-mobile-encryption-password
)
113 (org-string-nw-p org-mobile-encryption-password-session
)
114 (setq org-mobile-encryption-password-session
115 (read-passwd "Password for MobileOrg: " t
))))
117 (defcustom org-mobile-inbox-for-pull
"~/org/from-mobile.org"
118 "The file where captured notes and flags will be appended to.
119 During the execution of `org-mobile-pull', the file
120 `org-mobile-capture-file' will be emptied it's contents have
121 been appended to the file given here. This file should be in
122 `org-directory', and not in the staging area or on the web server."
126 (defconst org-mobile-capture-file
"mobileorg.org"
127 "The capture file where the mobile stores captured notes and flags.
128 This should not be changed, because MobileOrg assumes this name.")
130 (defcustom org-mobile-index-file
"index.org"
131 "The index file with inks to all Org files that should be loaded by MobileOrg.
132 Relative to `org-mobile-directory'. The Address field in the MobileOrg setup
133 should point to this file."
137 (defcustom org-mobile-agendas
'all
138 "The agendas that should be pushed to MobileOrg.
141 default the weekly agenda and the global TODO list
142 custom all custom agendas defined by the user
143 all the custom agendas and the default ones
144 list a list of selection key(s) as string."
147 (const :tag
"Default Agendas" default
)
148 (const :tag
"Custom Agendas" custom
)
149 (const :tag
"Default and Custom Agendas" all
)
150 (repeat :tag
"Selected"
151 (string :tag
"Selection Keys"))))
153 (defcustom org-mobile-force-id-on-agenda-items t
154 "Non-nil means make all agenda items carry an ID."
158 (defcustom org-mobile-force-mobile-change nil
159 "Non-nil means force the change made on the mobile device.
160 So even if there have been changes to the computer version of the entry,
161 force the new value set on the mobile.
162 When nil, mark the entry from the mobile with an error message.
163 Instead of nil or t, this variable can also be a list of symbols, indicating
164 the editing types for which the mobile version should always dominate."
167 (const :tag
"Always" t
)
168 (const :tag
"Never" nil
)
169 (set :greedy t
:tag
"Specify"
176 (defcustom org-mobile-action-alist
177 '(("edit" .
(org-mobile-edit data old new
)))
178 "Alist with flags and actions for mobile sync.
179 When flagging an entry, MobileOrg will create entries that look like
181 * F(action:data) [[id:entry-id][entry title]]
183 This alist defines that the ACTION in the parentheses of F() should mean,
184 i.e. what action should be taken. The :data part in the parenthesis is
185 optional. If present, the string after the colon will be passed to the
186 action form as the `data' variable.
187 The car of each elements of the alist is an actions string. The cdr is
188 an Emacs Lisp form that will be evaluated with the cursor on the headline
191 For now, it is not recommended to change this variable."
194 (cons (string :tag
"Action flag")
195 (sexp :tag
"Action form"))))
197 (defcustom org-mobile-checksum-binary
(or (executable-find "shasum")
198 (executable-find "sha1sum")
199 (executable-find "md5sum")
200 (executable-find "md5"))
201 "Executable used for computing checksums of agenda files."
205 (defvar org-mobile-pre-push-hook nil
206 "Hook run before running `org-mobile-push'.
207 This could be used to clean up `org-mobile-directory', for example to
208 remove files that used to be included in the agenda but no longer are.
209 The presence of such files would not really be a problem, but after time
210 they may accumulate.")
212 (defvar org-mobile-post-push-hook nil
213 "Hook run after running `org-mobile-push'.
214 If Emacs does not have direct write access to the WebDAV directory used
215 by the mobile device, this hook should be used to copy all files from the
216 local staging directory `org-mobile-directory' to the WebDAV directory,
217 for example using `rsync' or `scp'.")
219 (defvar org-mobile-pre-pull-hook nil
220 "Hook run before executing `org-mobile-pull'.
221 If Emacs does not have direct write access to the WebDAV directory used
222 by the mobile device, this hook should be used to copy the capture file
223 `mobileorg.org' from the WebDAV location to the local staging
224 directory `org-mobile-directory'.")
226 (defvar org-mobile-post-pull-hook nil
227 "Hook run after running `org-mobile-pull'.
228 If Emacs does not have direct write access to the WebDAV directory used
229 by the mobile device, this hook should be used to copy the emptied
230 capture file `mobileorg.org' back to the WebDAV directory, for example
231 using `rsync' or `scp'.")
233 (defvar org-mobile-last-flagged-files nil
234 "List of files containing entries flagged in the latest pull.")
236 (defvar org-mobile-files-alist nil
)
237 (defvar org-mobile-checksum-files nil
)
239 (defun org-mobile-prepare-file-lists ()
240 (setq org-mobile-files-alist
(org-mobile-files-alist))
241 (setq org-mobile-checksum-files nil
))
243 (defun org-mobile-files-alist ()
244 "Expand the list in `org-mobile-files' to a list of existing files."
245 (let* ((include-archives
246 (and (member 'org-agenda-text-search-extra-files org-mobile-files
)
247 (member 'agenda-archives org-agenda-text-search-extra-files
)
254 ((eq f
'org-agenda-files
)
255 (org-agenda-files t include-archives
))
256 ((eq f
'org-agenda-text-search-extra-files
)
257 (delq 'agenda-archives
259 org-agenda-text-search-extra-files
)))
260 ((and (stringp f
) (file-directory-p f
))
261 (directory-files f
'full
"\\.org\\'"))
262 ((and (stringp f
) (file-exists-p f
))
266 (orgdir-uname (file-name-as-directory (file-truename org-directory
)))
267 (orgdir-re (concat "\\`" (regexp-quote orgdir-uname
)))
268 uname seen rtn file link-name
)
269 ;; Make the files unique, and determine the name under which they will
271 (while (setq file
(pop files
))
272 (if (not (file-name-absolute-p file
))
273 (setq file
(expand-file-name file org-directory
)))
274 (setq uname
(file-truename file
))
275 (unless (member uname seen
)
277 (if (string-match orgdir-re uname
)
278 (setq link-name
(substring uname
(match-end 0)))
279 (setq link-name
(file-name-nondirectory uname
)))
280 (push (cons file link-name
) rtn
)))
284 (defun org-mobile-push ()
285 "Push the current state of Org affairs to the WebDAV directory.
286 This will create the index file, copy all agenda files there, and also
287 create all custom agenda views, for upload to the mobile phone."
289 (let ((a-buffer (get-buffer org-agenda-buffer-name
)))
290 (let ((org-agenda-buffer-name "*SUMO*")
291 (org-agenda-filter org-agenda-filter
)
292 (org-agenda-redo-command org-agenda-redo-command
))
294 (save-window-excursion
295 (org-mobile-check-setup)
296 (org-mobile-prepare-file-lists)
297 (run-hooks 'org-mobile-pre-push-hook
)
298 (message "Creating agendas...")
299 (let ((inhibit-redisplay t
)) (org-mobile-create-sumo-agenda))
300 (message "Creating agendas...done")
301 (org-save-all-org-buffers) ; to save any IDs created by this process
302 (message "Copying files...")
303 (org-mobile-copy-agenda-files)
304 (message "Writing index file...")
305 (org-mobile-create-index-file)
306 (message "Writing checksums...")
307 (org-mobile-write-checksums)
308 (run-hooks 'org-mobile-post-push-hook
))))
310 (when (and a-buffer
(buffer-live-p a-buffer
))
311 (if (not (get-buffer-window a-buffer
))
312 (kill-buffer a-buffer
)
313 (let ((cw (selected-window)))
314 (select-window (get-buffer-window a-buffer
))
316 (select-window cw
)))))
317 (message "Files for mobile viewer staged"))
319 (defvar org-mobile-before-process-capture-hook nil
320 "Hook that is run after content was moved to `org-mobile-inbox-for-pull'.
321 The inbox file is visited by the current buffer, and the buffer is
322 narrowed to the newly captured data.")
325 (defun org-mobile-pull ()
326 "Pull the contents of `org-mobile-capture-file' and integrate them.
327 Apply all flagged actions, flag entries to be flagged and then call an
328 agenda view showing the flagged items."
330 (org-mobile-check-setup)
331 (run-hooks 'org-mobile-pre-pull-hook
)
332 (let ((insertion-marker (org-mobile-move-capture)))
333 (if (not (markerp insertion-marker
))
334 (message "No new items")
335 (org-with-point-at insertion-marker
337 (narrow-to-region (point) (point-max))
338 (run-hooks 'org-mobile-before-process-capture-hook
)))
339 (org-with-point-at insertion-marker
340 (org-mobile-apply (point) (point-max)))
341 (move-marker insertion-marker nil
)
342 (run-hooks 'org-mobile-post-pull-hook
)
343 (when org-mobile-last-flagged-files
344 ;; Make an agenda view of flagged entries, but only in the files
345 ;; where stuff has been added.
346 (put 'org-agenda-files
'org-restrict org-mobile-last-flagged-files
)
347 (let ((org-agenda-keep-restricted-file-list t
))
348 (org-agenda nil
"?"))))))
350 (defun org-mobile-check-setup ()
351 "Check if org-mobile-directory has been set up."
352 (org-mobile-cleanup-encryption-tempfile)
353 (unless (and org-directory
354 (stringp org-directory
)
355 (string-match "\\S-" org-directory
)
356 (file-exists-p org-directory
)
357 (file-directory-p org-directory
))
359 "Please set `org-directory' to the directory where your org files live"))
360 (unless (and org-mobile-directory
361 (stringp org-mobile-directory
)
362 (string-match "\\S-" org-mobile-directory
)
363 (file-exists-p org-mobile-directory
)
364 (file-directory-p org-mobile-directory
))
366 "Variable `org-mobile-directory' must point to an existing directory"))
367 (unless (and org-mobile-inbox-for-pull
368 (stringp org-mobile-inbox-for-pull
)
369 (string-match "\\S-" org-mobile-inbox-for-pull
)
371 (file-name-directory org-mobile-inbox-for-pull
)))
373 "Variable `org-mobile-inbox-for-pull' must point to a file in an existing directory"))
374 (unless (and org-mobile-checksum-binary
375 (string-match "\\S-" org-mobile-checksum-binary
))
376 (error "No executable found to compute checksums"))
377 (when org-mobile-use-encryption
378 (unless (string-match "\\S-" (org-mobile-encryption-password))
380 "To use encryption, you must set `org-mobile-encryption-password'"))
381 (unless (file-writable-p org-mobile-encryption-tempfile
)
382 (error "Cannot write to encryption tempfile %s"
383 org-mobile-encryption-tempfile
))
384 (unless (executable-find "openssl")
385 (error "openssl is needed to encrypt files"))))
387 (defun org-mobile-create-index-file ()
388 "Write the index file in the WebDAV directory."
389 (let ((files-alist (sort (copy-sequence org-mobile-files-alist
)
390 (lambda (a b
) (string< (cdr a
) (cdr b
)))))
391 (def-todo (default-value 'org-todo-keywords
))
392 (def-tags (default-value 'org-tag-alist
))
393 (target-file (expand-file-name org-mobile-index-file
394 org-mobile-directory
))
395 file link-name todo-kwds done-kwds tags drawers entry kwds dwds twds
)
397 (org-prepare-agenda-buffers (mapcar 'car files-alist
))
398 (setq done-kwds
(org-uniquify org-done-keywords-for-agenda
))
399 (setq todo-kwds
(org-delete-all
401 (org-uniquify org-todo-keywords-for-agenda
)))
402 (setq drawers
(org-uniquify org-drawers-for-agenda
))
403 (setq tags
(org-uniquify
407 (cond ((stringp e
) e
)
409 (if (stringp (car e
)) (car e
) nil
))
411 org-tag-alist-for-agenda
))))
413 (if org-mobile-use-encryption
414 org-mobile-encryption-tempfile
416 (while (setq entry
(pop def-todo
))
417 (insert "#+READONLY\n")
418 (setq kwds
(mapcar (lambda (x) (if (string-match "(" x
)
419 (substring x
0 (match-beginning 0))
422 (insert "#+TODO: " (mapconcat 'identity kwds
" ") "\n")
423 (setq dwds
(member "|" kwds
)
424 twds
(org-delete-all dwds kwds
)
425 todo-kwds
(org-delete-all twds todo-kwds
)
426 done-kwds
(org-delete-all dwds done-kwds
)))
427 (when (or todo-kwds done-kwds
)
428 (insert "#+TODO: " (mapconcat 'identity todo-kwds
" ") " | "
429 (mapconcat 'identity done-kwds
" ") "\n"))
430 (setq def-tags
(mapcar
434 ((eq (car x
) :startgroup
) "{")
435 ((eq (car x
) :endgroup
) "}")
436 ((eq (car x
) :newline
) nil
)
440 (setq def-tags
(delq nil def-tags
))
441 (setq tags
(org-delete-all def-tags tags
))
442 (setq tags
(sort tags
(lambda (a b
) (string< (downcase a
) (downcase b
)))))
443 (setq tags
(append def-tags tags nil
))
444 (insert "#+TAGS: " (mapconcat 'identity tags
" ") "\n")
445 (insert "#+DRAWERS: " (mapconcat 'identity drawers
" ") "\n")
446 (insert "#+ALLPRIORITIES: A B C" "\n")
447 (when (file-exists-p (expand-file-name
448 org-mobile-directory
"agendas.org"))
449 (insert "* [[file:agendas.org][Agenda Views]]\n"))
450 (while (setq entry
(pop files-alist
))
451 (setq file
(car entry
)
452 link-name
(cdr entry
))
453 (insert (format "* [[file:%s][%s]]\n"
454 link-name link-name
)))
455 (push (cons org-mobile-index-file
(md5 (buffer-string)))
456 org-mobile-checksum-files
))
457 (when org-mobile-use-encryption
458 (org-mobile-encrypt-and-move org-mobile-encryption-tempfile
460 (org-mobile-cleanup-encryption-tempfile))))
462 (defun org-mobile-copy-agenda-files ()
463 "Copy all agenda files to the stage or WebDAV directory."
464 (let ((files-alist org-mobile-files-alist
)
465 file buf entry link-name target-path target-dir check
)
466 (while (setq entry
(pop files-alist
))
467 (setq file
(car entry
) link-name
(cdr entry
))
468 (when (file-exists-p file
)
469 (setq target-path
(expand-file-name link-name org-mobile-directory
)
470 target-dir
(file-name-directory target-path
))
471 (unless (file-directory-p target-dir
)
472 (make-directory target-dir
'parents
))
473 (if org-mobile-use-encryption
474 (org-mobile-encrypt-and-move file target-path
)
475 (copy-file file target-path
'ok-if-exists
))
476 (setq check
(shell-command-to-string
477 (concat org-mobile-checksum-binary
" "
478 (shell-quote-argument (expand-file-name file
)))))
479 (when (string-match "[a-fA-F0-9]\\{30,40\\}" check
)
480 (push (cons link-name
(match-string 0 check
))
481 org-mobile-checksum-files
))))
483 (setq file
(expand-file-name org-mobile-capture-file
484 org-mobile-directory
))
486 (setq buf
(find-file file
))
487 (when (and (= (point-min) (point-max)))
490 (when org-mobile-use-encryption
491 (write-file org-mobile-encryption-tempfile
)
492 (org-mobile-encrypt-and-move org-mobile-encryption-tempfile file
)))
493 (push (cons org-mobile-capture-file
(md5 (buffer-string)))
494 org-mobile-checksum-files
))
495 (org-mobile-cleanup-encryption-tempfile)
498 (defun org-mobile-write-checksums ()
499 "Create checksums for all files in `org-mobile-directory'.
500 The table of checksums is written to the file mobile-checksums."
501 (let ((sumfile (expand-file-name "checksums.dat" org-mobile-directory
))
502 (files org-mobile-checksum-files
)
504 (with-temp-file sumfile
505 (set-buffer-file-coding-system 'undecided-unix nil
)
506 (while (setq entry
(pop files
))
507 (setq file
(car entry
) sum
(cdr entry
))
508 (insert (format "%s %s\n" sum file
))))))
510 (defun org-mobile-sumo-agenda-command ()
511 "Return an agenda custom command that comprises all custom commands."
513 ;; normalize different versions
517 (cond ((stringp (cdr x
)) nil
)
518 ((stringp (nth 1 x
)) x
)
519 ((not (nth 1 x
)) (cons (car x
) (cons "" (cddr x
))))
520 (t (cons (car x
) (cons "" (cdr x
))))))
521 org-agenda-custom-commands
)))
522 (default-list '(("a" "Agenda" agenda
) ("t" "All TODO" alltodo
)))
523 thelist new e key desc type match settings cmds gkey gdesc gsettings cnt
)
525 ((eq org-mobile-agendas
'custom
)
526 (setq thelist custom-list
))
527 ((eq org-mobile-agendas
'default
)
528 (setq thelist default-list
))
529 ((eq org-mobile-agendas
'all
)
530 (setq thelist custom-list
)
531 (unless (assoc "t" thelist
) (push '("t" "ALL TODO" alltodo
) thelist
))
532 (unless (assoc "a" thelist
) (push '("a" "Agenda" agenda
) thelist
)))
533 ((listp org-mobile-agendas
)
534 (setq thelist
(append custom-list default-list
))
535 (setq thelist
(delq nil
(mapcar (lambda (k) (assoc k thelist
))
536 org-mobile-agendas
)))))
537 (while (setq e
(pop thelist
))
540 ;; this is a description entry - skip it
542 ((eq (nth 2 e
) 'search
)
543 ;; Search view is interactive, skip
545 ((memq (nth 2 e
) '(todo-tree tags-tree occur-tree
))
546 ;; These are trees, not really agenda commands
548 ((and (memq (nth 2 e
) '(todo tags tags-todo
))
550 (not (string-match "\\S-" (nth 3 e
)))))
551 ;; These would be interactive because the match string is empty
553 ((memq (nth 2 e
) '(agenda alltodo todo tags tags-todo
))
555 (setq key
(car e
) desc
(nth 1 e
) type
(nth 2 e
) match
(nth 3 e
)
558 (cons (list 'org-agenda-title-append
559 (concat "<after>KEYS=" key
" TITLE: "
560 (if (and (stringp desc
) (> (length desc
) 0))
561 desc
(symbol-name type
))
562 " " match
"</after>"))
564 (push (list type match settings
) new
))
566 ;; A user-defined function, not sure how to handle that yet
570 (setq gkey
(car e
) gdesc
(nth 1 e
) gsettings
(nth 3 e
) cmds
(nth 2 e
))
572 (while (setq e
(pop cmds
))
573 (setq type
(car e
) match
(nth 1 e
) settings
(nth 2 e
))
574 (setq settings
(append gsettings settings
))
576 (cons (list 'org-agenda-title-append
577 (concat "<after>KEYS=" gkey
"#" (number-to-string
579 " TITLE: " gdesc
" " match
"</after>"))
581 (push (list type match settings
) new
)))))
582 (and new
(list "X" "SUMO" (reverse new
)
583 '((org-agenda-compact-blocks nil
))))))
585 (defvar org-mobile-creating-agendas nil
)
586 (defun org-mobile-write-agenda-for-mobile (file)
587 (let ((all (buffer-string)) in-date id pl prefix line app short m sexp
)
590 (insert "#+READONLY\n")
592 (goto-char (point-min))
595 ((looking-at "[ \t]*$")) ; keep empty lines
597 ;; remove underlining
598 (delete-region (point) (point-at-eol)))
599 ((get-text-property (point) 'org-agenda-structural-header
)
601 (setq app
(get-text-property (point)
602 'org-agenda-title-append
))
603 (setq short
(get-text-property (point)
605 (when (and short
(looking-at ".+"))
606 (replace-match short
)
607 (beginning-of-line 1))
611 (beginning-of-line 1))
613 ((get-text-property (point) 'org-agenda-date-header
)
616 ((setq m
(or (get-text-property (point) 'org-hd-marker
)
617 (get-text-property (point) 'org-marker
)))
618 (setq sexp
(member (get-text-property (point) 'type
)
620 (if (setq pl
(get-text-property (point) 'prefix-length
))
622 (setq prefix
(org-trim (buffer-substring
623 (point) (+ (point) pl
)))
624 line
(org-trim (buffer-substring
627 (delete-region (point-at-bol) (point-at-eol))
628 (insert line
"<before>" prefix
"</before>")
629 (beginning-of-line 1))
630 (and (looking-at "[ \t]+") (replace-match "")))
631 (insert (if in-date
"*** " "** "))
635 (insert (org-agenda-get-some-entry-text
639 (if (org-bound-and-true-p
640 org-mobile-force-id-on-agenda-items
)
641 (org-id-get m
'create
)
642 (or (org-entry-get m
"ID")
643 (org-mobile-get-outline-path-link m
))))
644 (insert " :PROPERTIES:\n :ORIGINAL_ID: " id
646 (beginning-of-line 2))
647 (push (cons "agendas.org" (md5 (buffer-string)))
648 org-mobile-checksum-files
))
649 (message "Agenda written to Org file %s" file
)))
651 (defun org-mobile-get-outline-path-link (pom)
652 (org-with-point-at pom
654 (org-mobile-escape-olp (file-name-nondirectory buffer-file-name
))
656 (mapconcat 'org-mobile-escape-olp
657 (org-get-outline-path)
660 (org-mobile-escape-olp (nth 4 (org-heading-components))))))
662 (defun org-mobile-escape-olp (s)
663 (let ((table '(?
: ?
/)))
664 (org-link-escape s table
)))
667 (defun org-mobile-create-sumo-agenda ()
668 "Create a file that contains all custom agenda views."
670 (let* ((file (expand-file-name "agendas.org"
671 org-mobile-directory
))
672 (file1 (if org-mobile-use-encryption
673 org-mobile-encryption-tempfile
675 (sumo (org-mobile-sumo-agenda-command))
676 (org-agenda-custom-commands
677 (list (append sumo
(list (list file1
)))))
678 (org-mobile-creating-agendas t
))
679 (unless (file-writable-p file1
)
680 (error "Cannot write to file %s" file1
))
682 (org-store-agenda-views))
683 (when org-mobile-use-encryption
684 (org-mobile-encrypt-and-move file1 file
)
686 (org-mobile-cleanup-encryption-tempfile))))
688 (defun org-mobile-encrypt-and-move (infile outfile
)
689 "Encrypt INFILE locally to INFILE_enc, then move it to OUTFILE.
690 We do this in two steps so that remote paths will work, even if the
691 encryption program does not understand them."
692 (let ((encfile (concat infile
"_enc")))
693 (org-mobile-encrypt-file infile encfile
)
695 (copy-file encfile outfile
'ok-if-exists
)
696 (delete-file encfile
))))
698 (defun org-mobile-encrypt-file (infile outfile
)
699 "Encrypt INFILE to OUTFILE, using `org-mobile-encryption-password'."
701 (format "openssl enc -aes-256-cbc -salt -pass %s -in %s -out %s"
702 (shell-quote-argument (concat "pass:"
703 (org-mobile-encryption-password)))
704 (shell-quote-argument (expand-file-name infile
))
705 (shell-quote-argument (expand-file-name outfile
)))))
707 (defun org-mobile-decrypt-file (infile outfile
)
708 "Decrypt INFILE to OUTFILE, using `org-mobile-encryption-password'."
710 (format "openssl enc -d -aes-256-cbc -salt -pass %s -in %s -out %s"
711 (shell-quote-argument (concat "pass:"
712 (org-mobile-encryption-password)))
713 (shell-quote-argument (expand-file-name infile
))
714 (shell-quote-argument (expand-file-name outfile
)))))
716 (defun org-mobile-cleanup-encryption-tempfile ()
717 "Remove the encryption tempfile if it exists."
718 (and (stringp org-mobile-encryption-tempfile
)
719 (file-exists-p org-mobile-encryption-tempfile
)
720 (delete-file org-mobile-encryption-tempfile
)))
722 (defun org-mobile-move-capture ()
723 "Move the contents of the capture file to the inbox file.
724 Return a marker to the location where the new content has been added.
725 If nothing new has been added, return nil."
728 (capture-file (expand-file-name org-mobile-capture-file
729 org-mobile-directory
))
730 (inbox-buffer (find-file-noselect org-mobile-inbox-for-pull
))
732 (if (not org-mobile-use-encryption
)
733 (find-file-noselect capture-file
)
734 (org-mobile-cleanup-encryption-tempfile)
735 (setq encfile
(concat org-mobile-encryption-tempfile
"_enc"))
736 (copy-file capture-file encfile
)
737 (org-mobile-decrypt-file encfile org-mobile-encryption-tempfile
)
738 (find-file-noselect org-mobile-encryption-tempfile
)))
739 (insertion-point (make-marker))
741 (with-current-buffer capture-buffer
742 (setq content
(buffer-string))
743 (setq not-empty
(string-match "\\S-" content
))
745 (set-buffer inbox-buffer
)
747 (goto-char (point-max))
748 (or (bolp) (newline))
749 (move-marker insertion-point
750 (prog1 (point) (insert content
)))
752 (set-buffer capture-buffer
)
755 (org-mobile-update-checksum-for-capture-file (buffer-string))))
756 (kill-buffer capture-buffer
)
757 (when org-mobile-use-encryption
758 (org-mobile-encrypt-and-move org-mobile-encryption-tempfile
760 (org-mobile-cleanup-encryption-tempfile))
761 (if not-empty insertion-point
)))
763 (defun org-mobile-update-checksum-for-capture-file (buffer-string)
764 "Find the checksum line and modify it to match BUFFER-STRING."
765 (let* ((file (expand-file-name "checksums.dat" org-mobile-directory
))
766 (buffer (find-file-noselect file
)))
768 (with-current-buffer buffer
769 (when (re-search-forward (concat "\\([0-9a-fA-F]\\{30,\\}\\).*?"
770 (regexp-quote org-mobile-capture-file
)
772 (goto-char (match-beginning 1))
773 (delete-region (match-beginning 1) (match-end 1))
774 (insert (md5 buffer-string
))
776 (kill-buffer buffer
))))
778 (defun org-mobile-apply (&optional beg end
)
779 "Apply all change requests in the current buffer.
780 If BEG and END are given, only do this in that region."
782 (require 'org-archive
)
783 (setq org-mobile-last-flagged-files nil
)
784 (setq beg
(or beg
(point-min)) end
(or end
(point-max)))
786 ;; Remove all Note IDs
788 (while (re-search-forward "^\\*\\* Note ID: [-0-9A-F]+[ \t]*\n" end t
)
791 ;; Find all the referenced entries, without making any changes yet
792 (let ((marker (make-marker))
793 (bos-marker (make-marker))
794 (end (move-marker (make-marker) end
))
800 id-pos org-mobile-error
)
802 ;; Count the new captures
804 (while (re-search-forward "^\\* \\(.*\\)" end t
)
805 (and (>= (- (match-end 1) (match-beginning 1)) 2)
806 (not (equal (downcase (substring (match-string 1) 0 2)) "f("))
810 (while (re-search-forward
811 "^\\*+[ \t]+F(\\([^():\n]*\\)\\(:\\([^()\n]*\\)\\)?)[ \t]+\\[\\[\\(\\(id\\|olp\\):\\([^]\n]+\\)\\)" end t
)
812 (setq id-pos
(condition-case msg
813 (org-mobile-locate-entry (match-string 4))
814 (error (nth 1 msg
))))
815 (when (and (markerp id-pos
)
816 (not (member (marker-buffer id-pos
) buf-list
)))
817 (org-mobile-timestamp-buffer (marker-buffer id-pos
))
818 (push (marker-buffer id-pos
) buf-list
))
820 (if (or (not id-pos
) (stringp id-pos
))
822 (goto-char (+ 2 (point-at-bol)))
825 (add-text-properties (point-at-bol) (point-at-eol)
826 (list 'org-mobile-marker
827 (or id-pos
"Linked entry not found")))))
829 ;; OK, now go back and start applying
831 (while (re-search-forward "^\\*+[ \t]+F(\\([^():\n]*\\)\\(:\\([^()\n]*\\)\\)?)" end t
)
833 (setq id-pos
(get-text-property (point-at-bol) 'org-mobile-marker
))
834 (if (not (markerp id-pos
))
837 (insert "UNKNOWN PROBLEM"))
838 (let* ((action (match-string 1))
839 (data (and (match-end 3) (match-string 3)))
841 (eos (save-excursion (org-end-of-subtree t t
)))
842 (cmd (if (equal action
"")
845 (org-toggle-tag "FLAGGED" 'on
)
847 (org-entry-put nil
"THEFLAGGINGNOTE" note
)))
849 (cdr (assoc action org-mobile-action-alist
))))
850 (note (and (equal action
"")
851 (buffer-substring (1+ (point-at-eol)) eos
)))
852 (org-inhibit-logging 'note
) ;; Do not take notes interactively
855 (move-marker bos-marker
(point))
856 (if (re-search-forward "^** Old value[ \t]*$" eos t
)
857 (setq old
(buffer-substring
859 (progn (outline-next-heading) (point)))))
860 (if (re-search-forward "^** New value[ \t]*$" eos t
)
861 (setq new
(buffer-substring
863 (progn (outline-next-heading)
864 (if (eobp) (org-back-over-empty-lines))
866 (setq old
(and old
(if (string-match "\\S-" old
) old nil
)))
867 (setq new
(and new
(if (string-match "\\S-" new
) new nil
)))
868 (if (and note
(> (length note
) 0))
869 ;; Make Note into a single line, to fit into a property
870 (setq note
(mapconcat 'identity
871 (org-split-string (org-trim note
) "\n")
873 (unless (equal data
"body")
874 (setq new
(and new
(org-trim new
))
875 old
(and old
(org-trim old
))))
876 (goto-char (+ 2 bos-marker
))
877 (unless (markerp id-pos
)
878 (insert "BAD REFERENCE ")
885 ;; Remember this place so that we can return
886 (move-marker marker
(point))
887 (setq org-mobile-error nil
)
890 (org-with-point-at id-pos
893 (if (member "FLAGGED" (org-get-tags))
894 (add-to-list 'org-mobile-last-flagged-files
895 (buffer-file-name (current-buffer))))))
896 (error (setq org-mobile-error msg
))))
897 (when org-mobile-error
898 (switch-to-buffer (marker-buffer marker
))
901 (insert (if (stringp (nth 1 org-mobile-error
))
902 (nth 1 org-mobile-error
)
906 ;; If we get here, the action has been applied successfully
907 ;; So remove the entry
908 (goto-char bos-marker
)
909 (delete-region (point) (org-end-of-subtree t t
))))))
911 (move-marker marker nil
)
912 (move-marker end nil
)
913 (message "%d new, %d edits, %d flags, %d errors" cnt-new
914 cnt-edit cnt-flag cnt-error
)
917 (defun org-mobile-timestamp-buffer (buf)
918 "Time stamp buffer BUF, just to make sure its checksum will change."
919 (with-current-buffer buf
923 (goto-char (point-min))
924 (if (re-search-forward
925 "^\\([ \t]*\\)#\\+LAST_MOBILE_CHANGE:.*\n?" nil t
)
927 (goto-char (match-end 1))
928 (delete-region (point) (match-end 0)))
929 (if (looking-at ".*?-\\*-.*-\\*-")
931 (insert "#+LAST_MOBILE_CHANGE: "
932 (format-time-string "%Y-%m-%d %T") "\n")))))
934 (defun org-mobile-smart-read ()
935 "Parse the entry at point for shortcuts and expand them.
936 These shortcuts are meant for fast and easy typing on the limited
937 keyboards of a mobile device. Below we show a list of the shortcuts
938 currently implemented.
940 The entry is expected to contain an inactive time stamp indicating when
941 the entry was created. When setting dates and
942 times (for example for deadlines), the time strings are interpreted
943 relative to that creation date.
944 Abbreviations are expected to take up entire lines, just because it is so
945 easy to type RET on a mobile device. Abbreviations start with one or two
946 letters, followed immediately by a dot and then additional information.
947 Generally the entire shortcut line is removed after action have been taken.
948 Time stamps will be constructed using `org-read-date'. So for example a
949 line \"dd. 2tue\" will set a deadline on the second Tuesday after the
952 Here are the shortcuts currently implemented:
954 dd. string set deadline
955 ss. string set scheduling
956 tt. string set time tamp, here.
957 ti. string set inactive time
959 tg. tag1 tag2 tag3 set all these tags, change case where necessary
960 td. kwd set this todo keyword, change case where necessary
962 FIXME: Hmmm, not sure if we can make his work against the
963 auto-correction feature. Needs a bit more thinking. So this function
964 is currently a noop.")
966 (defun org-mobile-locate-entry (link)
967 (if (string-match "\\`id:\\(.*\\)$" link
)
968 (org-id-find (match-string 1 link
) 'marker
)
969 (if (not (string-match "\\`olp:\\(.*?\\):\\(.*\\)$" link
))
971 (let ((file (match-string 1 link
))
972 (path (match-string 2 link
)))
973 (setq file
(org-link-unescape file
))
974 (setq file
(expand-file-name file org-directory
))
975 (setq path
(mapcar 'org-link-unescape
976 (org-split-string path
"/")))
977 (org-find-olp (cons file path
))))))
979 (defun org-mobile-edit (what old new
)
980 "Edit item WHAT in the current entry by replacing OLD with NEW.
981 WHAT can be \"heading\", \"todo\", \"tags\", \"priority\", or \"body\".
982 The edit only takes place if the current value is equal (except for
983 white space) the OLD. If this is so, OLD will be replace by NEW
984 and the command will return t. If something goes wrong, a string will
985 be returned that indicates what went wrong."
986 (let (current old1 new1
)
987 (if (stringp what
) (setq what
(intern what
)))
991 ((memq what
'(todo todostate
))
992 (setq current
(org-get-todo-state))
994 ((equal new
"DONEARCHIVE")
996 (org-archive-subtree-default))
997 ((equal new current
) t
) ; nothing needs to be done
998 ((or (equal current old
)
999 (eq org-mobile-force-mobile-change t
)
1000 (memq 'todo org-mobile-force-mobile-change
))
1001 (org-todo (or new
'none
)) t
)
1002 (t (error "State before change was expected as \"%s\", but is \"%s\""
1006 (setq current
(org-get-tags)
1007 new1
(and new
(org-split-string new
":+"))
1008 old1
(and old
(org-split-string old
":+")))
1010 ((org-mobile-tags-same-p current new1
) t
) ; no change needed
1011 ((or (org-mobile-tags-same-p current old1
)
1012 (eq org-mobile-force-mobile-change t
)
1013 (memq 'tags org-mobile-force-mobile-change
))
1014 (org-set-tags-to new1
) t
)
1015 (t (error "Tags before change were expected as \"%s\", but are \"%s\""
1016 (or old
"") (or current
"")))))
1018 ((eq what
'priority
)
1019 (when (looking-at org-complex-heading-regexp
)
1020 (setq current
(and (match-end 3) (substring (match-string 3) 2 3)))
1022 ((equal current new
) t
) ; no action required
1023 ((or (equal current old
)
1024 (eq org-mobile-force-mobile-change t
)
1025 (memq 'tags org-mobile-force-mobile-change
))
1026 (org-priority (and new
(string-to-char new
))))
1027 (t (error "Priority was expected to be %s, but is %s"
1031 (when (looking-at org-complex-heading-regexp
)
1032 (setq current
(match-string 4))
1034 ((equal current new
) t
) ; no action required
1035 ((or (equal current old
)
1036 (eq org-mobile-force-mobile-change t
)
1037 (memq 'heading org-mobile-force-mobile-change
))
1038 (goto-char (match-beginning 4))
1040 (delete-region (point) (+ (point) (length current
)))
1041 (org-set-tags nil
'align
))
1042 (t (error "Heading changed in MobileOrg and on the computer")))))
1045 (setq current
(buffer-substring (min (1+ (point-at-eol)) (point-max))
1046 (save-excursion (outline-next-heading)
1048 (if (not (string-match "\\S-" current
)) (setq current nil
))
1050 ((org-mobile-bodies-same-p current new
) t
) ; no action necessary
1051 ((or (org-mobile-bodies-same-p current old
)
1052 (eq org-mobile-force-mobile-change t
)
1053 (memq 'body org-mobile-force-mobile-change
))
1057 (or (bolp) (insert "\n"))
1058 (delete-region (point) (progn (org-back-to-heading t
)
1059 (outline-next-heading)
1062 (t (error "Body was changed in MobileOrg and on the computer")))))))
1064 (defun org-mobile-tags-same-p (list1 list2
)
1065 "Are the two tag lists the same?"
1066 (not (or (org-delete-all list1 list2
)
1067 (org-delete-all list2 list1
))))
1069 (defun org-mobile-bodies-same-p (a b
)
1070 "Compare if A and B are visually equal strings.
1071 We first remove leading and trailing white space from the entire strings.
1072 Then we split the strings into lines and remove leading/trailing whitespace
1073 from each line. Then we compare.
1074 A and B must be strings or nil."
1076 ((and (not a
) (not b
)) t
)
1077 ((or (not a
) (not b
)) nil
)
1078 (t (setq a
(org-trim a
) b
(org-trim b
))
1079 (setq a
(mapconcat 'identity
(org-split-string a
"[ \t]*\n[ \t]*") "\n"))
1080 (setq b
(mapconcat 'identity
(org-split-string b
"[ \t]*\n[ \t]*") "\n"))
1083 (provide 'org-mobile
)
1085 ;; arch-tag: ace0e26c-58f2-4309-8a61-05ec1535f658
1087 ;;; org-mobile.el ends here