org-mobile.el 41.6 KB
Newer Older
Rasmus's avatar
Rasmus committed
1
;;; org-mobile.el --- Code for Asymmetric Sync With a Mobile Device -*- lexical-binding: t; -*-
Paul Eggert's avatar
Paul Eggert committed
2
;; Copyright (C) 2009-2020 Free Software Foundation, Inc.
3 4 5
;;
;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
Rasmus's avatar
Rasmus committed
6
;; Homepage: https://orgmode.org
7 8 9 10 11 12 13 14 15 16 17 18 19 20
;;
;; This file is part of GNU Emacs.
;;
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;;
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
21
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
22 23 24 25 26
;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;;; Commentary:
;;
Bastien's avatar
Bastien committed
27 28 29 30 31 32
;; This file contains the code to interact with a mobile application,
;; such as Richard Moreland's iPhone application MobileOrg, or the
;; Android version by Matthew Jones.  This code is documented in
;; Appendix B of the Org manual.  The code is not specific for the
;; iPhone and Android - any external viewer/flagging/editing
;; application that uses the same conventions could be used.
33

Bastien's avatar
Bastien committed
34
(require 'cl-lib)
35 36
(require 'org)
(require 'org-agenda)
Bastien's avatar
Bastien committed
37
(require 'ol)
38

Rasmus's avatar
Rasmus committed
39
;;; Code:
Bastien Guerry's avatar
Bastien Guerry committed
40

41
(defgroup org-mobile nil
42
  "Options concerning support for a viewer/editor on a mobile device."
43 44 45 46
  :tag "Org Mobile"
  :group 'org)

(defcustom org-mobile-files '(org-agenda-files)
Bastien's avatar
Bastien committed
47 48
  "Files to be staged for the mobile application.

49
This is basically a list of files and directories.  Files will be staged
Bastien's avatar
Bastien committed
50
directly.  Directories will be search for files with the extension \".org\".
51 52
In addition to this, the list may also contain the following symbols:

Bastien's avatar
Bastien committed
53
`org-agenda-files'
54
     This means include the complete, unrestricted list of files given in
55
     the variable `org-agenda-files'.
Bastien's avatar
Bastien committed
56 57

`org-agenda-text-search-extra-files'
58
     Include the files given in the variable
59
     `org-agenda-text-search-extra-files'."
60 61 62 63 64 65 66 67
  :group 'org-mobile
  :type '(list :greedy t
	       (option (const :tag "org-agenda-files" org-agenda-files))
	       (option (const :tag "org-agenda-text-search-extra-files"
			      org-agenda-text-search-extra-files))
	       (repeat :inline t :tag "Additional files"
		       (file))))

68 69 70
(defcustom org-mobile-files-exclude-regexp ""
  "A regexp to exclude files from `org-mobile-files'."
  :group 'org-mobile
71
  :version "24.1"
72 73
  :type 'regexp)

74 75 76 77 78
(defcustom org-mobile-directory ""
  "The WebDAV directory where the interaction with the mobile takes place."
  :group 'org-mobile
  :type 'directory)

Bastien Guerry's avatar
Bastien Guerry committed
79 80 81 82 83 84 85
(defcustom org-mobile-allpriorities "A B C"
  "Default set of priority cookies for the index file."
  :version "24.4"
  :package-version '(Org . "8.0")
  :type 'string
  :group 'org-mobile)

86
(defcustom org-mobile-use-encryption nil
87
  "Non-nil means keep only encrypted files on the WebDAV server.
Bastien's avatar
Bastien committed
88

89
Encryption uses AES-256, with a password given in
Bastien's avatar
Bastien committed
90 91 92 93 94 95
`org-mobile-encryption-password'.  When nil, plain files are kept
on the server.

Turning on encryption requires setting the same password in the
mobile application.  Before turning this on, check if the mobile
application does support it."
96
  :group 'org-mobile
97
  :version "24.1"
98 99 100 101
  :type 'boolean)

(defcustom org-mobile-encryption-tempfile "~/orgtmpcrypt"
  "File that is being used as a temporary file for encryption.
102
This must be local file on your local machine (not on the WebDAV server).
103 104
You might want to put this file into a directory where only you have access."
  :group 'org-mobile
105
  :version "24.1"
106 107 108 109
  :type 'directory)

(defcustom org-mobile-encryption-password ""
  "Password for encrypting files uploaded to the server.
Bastien's avatar
Bastien committed
110

111
This is a single password which is used for AES-256 encryption.  The same
Bastien's avatar
Bastien committed
112 113
password must also be set in the mobile application.  All Org files,
including \"mobileorg.org\" will be encrypted using this password.
Carsten Dominik's avatar
Carsten Dominik committed
114 115 116

SECURITY CONSIDERATIONS:

117
Note that, when Org runs the encryption commands, the password could
Carsten Dominik's avatar
Carsten Dominik committed
118 119 120 121 122 123 124 125
be visible briefly on your system with the `ps' command.  So this method is
only intended to keep the files secure on the server, not on your own machine.

Also, if you set this variable in an init file (.emacs or .emacs.d/init.el
or custom.el...) and if that file is stored in a way so that other can read
it, this also limits the security of this approach.  You can also leave
this variable empty - Org will then ask for the password once per Emacs
session."
126
  :group 'org-mobile
127
  :version "24.1"
128 129
  :type '(string :tag "Password"))

Carsten Dominik's avatar
Carsten Dominik committed
130 131 132 133 134 135
(defvar org-mobile-encryption-password-session nil)

(defun org-mobile-encryption-password ()
  (or (org-string-nw-p org-mobile-encryption-password)
      (org-string-nw-p org-mobile-encryption-password-session)
      (setq org-mobile-encryption-password-session
Bastien's avatar
Bastien committed
136
	    (read-passwd "Password for mobile application: " t))))
Carsten Dominik's avatar
Carsten Dominik committed
137

138 139 140
(defcustom org-mobile-inbox-for-pull "~/org/from-mobile.org"
  "The file where captured notes and flags will be appended to.
During the execution of `org-mobile-pull', the file
Bastien's avatar
Bastien committed
141
`org-mobile-capture-file' is emptied as soon as its contents have
142 143
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."
144 145 146 147 148
  :group 'org-mobile
  :type 'file)

(defconst org-mobile-capture-file "mobileorg.org"
  "The capture file where the mobile stores captured notes and flags.
Bastien's avatar
Bastien committed
149
This must not be changed, because the mobile application assumes this name.")
150 151

(defcustom org-mobile-index-file "index.org"
Bastien's avatar
Bastien committed
152 153 154 155
  "Index file with links to all Org files.
It should be loaded by the mobile application.  The file name is
relative to `org-mobile-directory'.  The \"Address\" field in the
mobile application setup should point to this file."
156 157 158
  :group 'org-mobile
  :type 'file)

159
(defcustom org-mobile-agendas 'all
Bastien's avatar
Bastien committed
160 161
  "The agendas that should be pushed to the mobile application.

162 163
Allowed values:

Bastien's avatar
Bastien committed
164 165 166 167
`default'  the weekly agenda and the global TODO list
`custom'   all custom agendas defined by the user
`all'      the custom agendas and the default ones
`list'     a list of selection key(s) as string."
168
  :group 'org-mobile
169
  :version "24.1"
170 171 172 173 174 175 176
  :type '(choice
	  (const :tag "Default Agendas" default)
	  (const :tag "Custom Agendas" custom)
	  (const :tag "Default and Custom Agendas" all)
	  (repeat :tag "Selected"
		  (string :tag "Selection Keys"))))

177
(defcustom org-mobile-force-id-on-agenda-items t
Carsten Dominik's avatar
Carsten Dominik committed
178
  "Non-nil means make all agenda items carry an ID."
179 180 181
  :group 'org-mobile
  :type 'boolean)

182
(defcustom org-mobile-force-mobile-change nil
183
  "Non-nil means force the change made on the mobile device.
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
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-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)

208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
(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
remove files that used to be included in the agenda but no longer are.
The presence of such files would not really be a problem, but after time
they may accumulate.")

(defvar org-mobile-post-push-hook nil
  "Hook run after running `org-mobile-push'.
If Emacs does not have direct write access to the WebDAV directory used
by the mobile device, this hook should be used to copy all files from the
local staging directory `org-mobile-directory' to the WebDAV directory,
for example using `rsync' or `scp'.")

(defvar org-mobile-pre-pull-hook nil
  "Hook run before executing `org-mobile-pull'.
If Emacs does not have direct write access to the WebDAV directory used
by the mobile device, this hook should be used to copy the capture file
`mobileorg.org' from the WebDAV location to the local staging
directory `org-mobile-directory'.")

(defvar org-mobile-post-pull-hook nil
230
  "Hook run after running `org-mobile-pull', only if new items were found.
231 232 233 234 235
If Emacs does not have direct write access to the WebDAV directory used
by the mobile device, this hook should be used to copy the emptied
capture file `mobileorg.org' back to the WebDAV directory, for example
using `rsync' or `scp'.")

Rasmus's avatar
Rasmus committed
236 237
(defconst org-mobile-action-alist '(("edit" . org-mobile-edit))
  "Alist with flags and actions for mobile sync.
Bastien's avatar
Bastien committed
238 239 240

When flagging an entry, the mobile application creates entries
that look like
Rasmus's avatar
Rasmus committed
241 242 243 244 245 246 247 248 249 250 251 252 253 254

  * F(action:data)  [[id:entry-id][entry title]]

This alist defines that the ACTION in the parentheses of F()
should mean, i.e. what action should be taken.  The :data part in
the parenthesis is optional.  If present, the string after the
colon will be passed to the action function as the first argument
variable.

The car of each elements of the alist is an actions string.  The
cdr is a function that is called with the cursor on the headline
of that entry.  It should accept three arguments, the :data part,
the old and new values for the entry.")

255
(defvar org-mobile-last-flagged-files nil
256
  "List of files containing entries flagged in the latest pull.")
257 258 259 260 261 262

(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))
263
  (setq org-mobile-checksum-files nil))
264 265

(defun org-mobile-files-alist ()
266 267
  "Expand the list in `org-mobile-files' to a list of existing files.
Also exclude files matching `org-mobile-files-exclude-regexp'."
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
  (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)))
Bastien Guerry's avatar
Bastien Guerry committed
289
	 (files (delq
290
		 nil
291 292 293 294 295
		 (mapcar (lambda (f)
			   (unless (and (not (string= org-mobile-files-exclude-regexp ""))
					(string-match org-mobile-files-exclude-regexp f))
			     (identity f)))
			 files)))
296 297 298 299 300 301
	 (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))
302 303
      (if (not (file-name-absolute-p file))
	  (setq file (expand-file-name file org-directory)))
304 305 306 307 308 309 310 311 312 313 314
      (setq uname (file-truename file))
      (unless (member uname seen)
	(push uname seen)
	(if (string-match orgdir-re uname)
	    (setq link-name (substring uname (match-end 0)))
	  (setq link-name (file-name-nondirectory uname)))
	(push (cons file link-name) rtn)))
    (nreverse rtn)))

;;;###autoload
(defun org-mobile-push ()
315
  "Push the current state of Org affairs to the target directory.
316 317 318
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)
Rasmus's avatar
Rasmus committed
319 320 321
  (let ((org-agenda-buffer-name "*SUMO*")
	(org-agenda-tag-filter org-agenda-tag-filter)
	(org-agenda-redo-command org-agenda-redo-command))
Bastien's avatar
Bastien committed
322 323 324 325 326
    ;; Offer to save agenda-related buffers before pushing, preventing
    ;; "Non-existent agenda file" prompt for lock files (see #19448).
    (let ((agenda-buffers (org-buffer-list 'agenda)))
      (save-some-buffers nil
			 (lambda () (memq (current-buffer) agenda-buffers))))
Rasmus's avatar
Rasmus committed
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
    (save-excursion
      (save-restriction
	(save-window-excursion
	  (run-hooks 'org-mobile-pre-push-hook)
	  (org-mobile-check-setup)
	  (org-mobile-prepare-file-lists)
	  (message "Creating agendas...")
	  (let ((inhibit-redisplay t)
		(org-agenda-files (mapcar 'car org-mobile-files-alist)))
	    (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)))))
  (org-agenda-maybe-redo)
347
  (message "Files for mobile viewer staged"))
348

349 350
(defvar org-mobile-before-process-capture-hook nil
  "Hook that is run after content was moved to `org-mobile-inbox-for-pull'.
351 352
The inbox file is visited by the current buffer, and the buffer is
narrowed to the newly captured data.")
353 354 355 356 357 358 359 360 361 362 363 364 365

;;;###autoload
(defun org-mobile-pull ()
  "Pull the contents of `org-mobile-capture-file' and integrate them.
Apply all flagged actions, flag entries to be flagged and then call an
agenda view showing the flagged items."
  (interactive)
  (org-mobile-check-setup)
  (run-hooks 'org-mobile-pre-pull-hook)
  (let ((insertion-marker (org-mobile-move-capture)))
    (if (not (markerp insertion-marker))
	(message "No new items")
      (org-with-point-at insertion-marker
366 367 368 369 370
	(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)))
371 372 373 374 375 376
      (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)
377
	(let ((org-agenda-keep-restricted-file-list t))
378 379 380 381
	  (org-agenda nil "?"))))))

(defun org-mobile-check-setup ()
  "Check if org-mobile-directory has been set up."
Carsten Dominik's avatar
Carsten Dominik committed
382
  (org-mobile-cleanup-encryption-tempfile)
383 384 385 386 387 388 389 390 391 392 393 394
  (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))
395 396
    (error
     "Variable `org-mobile-directory' must point to an existing directory"))
397 398 399 400 401
  (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)))
402
    (error
403
     "Variable `org-mobile-inbox-for-pull' must point to a file in an existing directory"))
404 405 406
  (unless (and org-mobile-checksum-binary
	       (string-match "\\S-" org-mobile-checksum-binary))
    (error "No executable found to compute checksums"))
407
  (when org-mobile-use-encryption
Carsten Dominik's avatar
Carsten Dominik committed
408
    (unless (string-match "\\S-" (org-mobile-encryption-password))
409 410 411
      (error
       "To use encryption, you must set `org-mobile-encryption-password'"))
    (unless (file-writable-p org-mobile-encryption-tempfile)
412
      (error "Cannot write to encryption tempfile %s"
413 414
	     org-mobile-encryption-tempfile))
    (unless (executable-find "openssl")
415
      (error "OpenSSL is needed to encrypt files"))))
416 417 418

(defun org-mobile-create-index-file ()
  "Write the index file in the WebDAV directory."
419 420 421
  (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))
Rasmus's avatar
Rasmus committed
422
	(def-tags org-tag-alist)
Carsten Dominik's avatar
Carsten Dominik committed
423 424
	(target-file (expand-file-name org-mobile-index-file
				       org-mobile-directory))
Rasmus's avatar
Rasmus committed
425
	todo-kwds done-kwds tags)
426 427
    (when (stringp (car def-todo))
      (setq def-todo (list (cons 'sequence def-todo))))
428
    (org-agenda-prepare-buffers (mapcar 'car files-alist))
429 430 431 432
    (setq done-kwds (org-uniquify org-done-keywords-for-agenda))
    (setq todo-kwds (org-delete-all
		     done-kwds
		     (org-uniquify org-todo-keywords-for-agenda)))
433 434
    (setq tags (mapcar 'car (org-global-tags-completion-table
			     (mapcar 'car files-alist))))
Rasmus's avatar
Rasmus committed
435 436 437 438 439 440 441 442 443 444 445 446 447 448
    (with-temp-file (if org-mobile-use-encryption org-mobile-encryption-tempfile
		      target-file)
      (insert "#+READONLY\n")
      (dolist (entry def-todo)
	(let ((kwds (mapcar (lambda (x)
			      (if (string-match "(" x)
				  (substring x 0 (match-beginning 0))
				x))
			    (cdr entry))))
	  (insert "#+TODO: " (mapconcat #'identity kwds " ") "\n")
	  (let* ((dwds (or (member "|" kwds) (last kwds)))
		 (twds (org-delete-all dwds kwds)))
	    (setq todo-kwds (org-delete-all twds todo-kwds))
	    (setq done-kwds (org-delete-all dwds done-kwds)))))
449 450 451
      (when (or todo-kwds done-kwds)
	(insert "#+TODO: " (mapconcat 'identity todo-kwds " ") " | "
		(mapconcat 'identity done-kwds " ") "\n"))
Rasmus's avatar
Rasmus committed
452
      (setq def-tags (split-string (org-tag-alist-to-string def-tags t)))
453 454 455 456
      (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")
Bastien Guerry's avatar
Bastien Guerry committed
457
      (insert "#+ALLPRIORITIES: " org-mobile-allpriorities "\n")
458 459 460
      (when (file-exists-p (expand-file-name
			    org-mobile-directory "agendas.org"))
	(insert "* [[file:agendas.org][Agenda Views]]\n"))
Rasmus's avatar
Rasmus committed
461 462
      (pcase-dolist (`(,_ . ,link-name) files-alist)
	(insert (format "* [[file:%s][%s]]\n" link-name link-name)))
463
      (push (cons org-mobile-index-file (md5 (buffer-string)))
Carsten Dominik's avatar
Carsten Dominik committed
464 465 466 467 468
	    org-mobile-checksum-files))
    (when org-mobile-use-encryption
      (org-mobile-encrypt-and-move org-mobile-encryption-tempfile
				   target-file)
      (org-mobile-cleanup-encryption-tempfile))))
469 470 471 472

(defun org-mobile-copy-agenda-files ()
  "Copy all agenda files to the stage or WebDAV directory."
  (let ((files-alist org-mobile-files-alist)
473
	file buf entry link-name target-path target-dir check)
474 475 476 477 478 479
    (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)
480
	  (make-directory target-dir 'parents))
481 482
	(if org-mobile-use-encryption
	    (org-mobile-encrypt-and-move file target-path)
483
	  (copy-file file target-path 'ok-if-already-exists))
484
	(setq check (shell-command-to-string
Rasmus's avatar
Rasmus committed
485 486
		     (concat (shell-quote-argument org-mobile-checksum-binary)
			     " "
487
			     (shell-quote-argument (expand-file-name file)))))
488
	(when (string-match "[[:xdigit:]]\\{30,40\\}" check)
489 490
	  (push (cons link-name (match-string 0 check))
		org-mobile-checksum-files))))
Carsten Dominik's avatar
Carsten Dominik committed
491

492 493
    (setq file (expand-file-name org-mobile-capture-file
				 org-mobile-directory))
494 495
    (save-excursion
      (setq buf (find-file file))
496
      (when (and (= (point-min) (point-max)))
Carsten Dominik's avatar
Carsten Dominik committed
497 498 499 500 501
	(insert "\n")
	(save-buffer)
	(when org-mobile-use-encryption
	  (write-file org-mobile-encryption-tempfile)
	  (org-mobile-encrypt-and-move org-mobile-encryption-tempfile file)))
502 503
      (push (cons org-mobile-capture-file (md5 (buffer-string)))
	    org-mobile-checksum-files))
Carsten Dominik's avatar
Carsten Dominik committed
504
    (org-mobile-cleanup-encryption-tempfile)
505
    (kill-buffer buf)))
506 507 508 509

(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."
510 511 512 513 514 515 516 517
  (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))))))
518 519 520 521 522 523 524 525 526 527 528 529 530

(defun org-mobile-sumo-agenda-command ()
  "Return an agenda custom command that comprises all custom commands."
  (let ((custom-list
	 ;; normalize different versions
	 (delq nil
	       (mapcar
		(lambda (x)
		  (cond ((stringp (cdr x)) nil)
			((stringp (nth 1 x)) x)
			((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
			(t (cons (car x) (cons "" (cdr x))))))
		org-agenda-custom-commands)))
531
	(default-list '(("a" "Agenda" agenda) ("t" "All TODO" alltodo)))
532
	thelist	atitle new e key desc type match settings cmds gkey gdesc gsettings cnt)
533 534 535 536 537 538 539 540 541 542 543 544 545 546
    (cond
     ((eq org-mobile-agendas 'custom)
      (setq thelist custom-list))
     ((eq org-mobile-agendas 'default)
      (setq thelist default-list))
     ((eq org-mobile-agendas 'all)
      (setq thelist custom-list)
      (unless (assoc "t" thelist) (push '("t" "ALL TODO" alltodo) thelist))
      (unless (assoc "a" thelist) (push '("a" "Agenda" agenda) thelist)))
     ((listp org-mobile-agendas)
      (setq thelist (append custom-list default-list))
      (setq thelist (delq nil (mapcar (lambda (k) (assoc k thelist))
				      org-mobile-agendas)))))
    (while (setq e (pop thelist))
547 548 549 550 551 552 553 554 555 556
      (cond
       ((stringp (cdr e))
	;; this is a description entry - skip it
	)
       ((eq (nth 2 e) 'search)
	;; Search view is interactive, skip
	)
       ((memq (nth 2 e) '(todo-tree tags-tree occur-tree))
	;; These are trees, not really agenda commands
	)
557 558 559 560 561 562
       ((and (memq (nth 2 e) '(todo tags tags-todo))
	     (or (null (nth 3 e))
		 (not (string-match "\\S-" (nth 3 e)))))
	;; These would be interactive because the match string is empty
	)
       ((memq (nth 2 e) '(agenda alltodo todo tags tags-todo))
563 564 565 566 567
	;; a normal command
	(setq key (car e) desc (nth 1 e) type (nth 2 e) match (nth 3 e)
	      settings (nth 4 e))
	(setq settings
	      (cons (list 'org-agenda-title-append
568
			  (concat "<after>KEYS=" key " TITLE: "
569 570
				  (if (and (stringp desc) (> (length desc) 0))
				      desc (symbol-name type))
571
				  "</after>"))
572 573
		    settings))
	(push (list type match settings) new))
574 575 576
       ((or (functionp (nth 2 e)) (symbolp (nth 2 e)))
	;; A user-defined function, which can do anything, so simply
	;; ignore it.
577 578 579 580 581 582 583
	)
       (t
	;; a block agenda
	(setq gkey (car e) gdesc (nth 1 e) gsettings (nth 3 e) cmds (nth 2 e))
	(setq cnt 0)
	(while (setq e (pop cmds))
	  (setq type (car e) match (nth 1 e) settings (nth 2 e))
584
	  (setq atitle (if (string= "" gdesc) match gdesc))
585 586 587
	  (setq settings (append gsettings settings))
	  (setq settings
		(cons (list 'org-agenda-title-append
588
			    (concat "<after>KEYS=" gkey "#" (number-to-string
589
							     (setq cnt (1+ cnt)))
590
				    " TITLE: " atitle "</after>"))
591 592
		      settings))
	  (push (list type match settings) new)))))
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
    (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)
612 613
	  (setq app (get-text-property (point) 'org-agenda-title-append))
	  (setq short (get-text-property (point) 'short-heading))
614
	  (when (and short (looking-at ".+"))
615
	    (replace-match short nil t)
616 617 618 619 620 621 622 623 624 625 626 627 628
	    (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")))
629
	  (if (setq pl (text-property-any (point) (point-at-eol) 'org-heading t))
630 631
	      (progn
		(setq prefix (org-trim (buffer-substring
632
					(point) pl))
633
		      line (org-trim (buffer-substring
634
				      pl
635 636 637 638 639 640 641 642 643 644 645 646 647
				      (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
Rasmus's avatar
Rasmus committed
648
			(if (bound-and-true-p
649 650
			     org-mobile-force-id-on-agenda-items)
			    (org-id-get m 'create)
Carsten Dominik's avatar
Carsten Dominik committed
651 652
			  (or (org-entry-get m "ID")
			      (org-mobile-get-outline-path-link m))))
653 654 655
	      (insert "   :PROPERTIES:\n   :ORIGINAL_ID: " id
		      "\n   :END:\n")))))
	(beginning-of-line 2))
Carsten Dominik's avatar
Carsten Dominik committed
656
      (push (cons "agendas.org" (md5 (buffer-string)))
657 658
	    org-mobile-checksum-files))
    (message "Agenda written to Org file %s" file)))
659

Carsten Dominik's avatar
Carsten Dominik committed
660 661 662 663
(defun org-mobile-get-outline-path-link (pom)
  (org-with-point-at pom
    (concat "olp:"
	    (org-mobile-escape-olp (file-name-nondirectory buffer-file-name))
Rasmus's avatar
Rasmus committed
664
	    ":"
Carsten Dominik's avatar
Carsten Dominik committed
665 666 667 668 669 670 671
	    (mapconcat 'org-mobile-escape-olp
		       (org-get-outline-path)
		       "/")
	    "/"
	    (org-mobile-escape-olp (nth 4 (org-heading-components))))))

(defun org-mobile-escape-olp (s)
Bastien's avatar
Bastien committed
672
  (org-link-encode s '(?: ?/)))
Carsten Dominik's avatar
Carsten Dominik committed
673

674 675 676 677 678
(defun org-mobile-create-sumo-agenda ()
  "Create a file that contains all custom agenda views."
  (interactive)
  (let* ((file (expand-file-name "agendas.org"
				 org-mobile-directory))
679 680 681
	 (file1 (if org-mobile-use-encryption
		    org-mobile-encryption-tempfile
		  file))
682
	 (sumo (org-mobile-sumo-agenda-command))
683
	 (org-agenda-custom-commands
684
	  (list (append sumo (list (list file1)))))
685
	 (org-mobile-creating-agendas t))
686 687
    (unless (file-writable-p file1)
      (error "Cannot write to file %s" file1))
688
    (when sumo
689 690
      (org-store-agenda-views))
    (when org-mobile-use-encryption
Carsten Dominik's avatar
Carsten Dominik committed
691 692 693
      (org-mobile-encrypt-and-move file1 file)
      (delete-file file1)
      (org-mobile-cleanup-encryption-tempfile))))
694 695 696 697 698 699 700 701

(defun org-mobile-encrypt-and-move (infile outfile)
  "Encrypt INFILE locally to INFILE_enc, then move it to OUTFILE.
We do this in two steps so that remote paths will work, even if the
encryption program does not understand them."
  (let ((encfile (concat infile "_enc")))
    (org-mobile-encrypt-file infile encfile)
    (when outfile
702
      (copy-file encfile outfile 'ok-if-already-exists)
703 704 705 706 707
      (delete-file encfile))))

(defun org-mobile-encrypt-file (infile outfile)
  "Encrypt INFILE to OUTFILE, using `org-mobile-encryption-password'."
  (shell-command
Rasmus's avatar
Rasmus committed
708
   (format "openssl enc -md md5 -aes-256-cbc -salt -pass %s -in %s -out %s"
Carsten Dominik's avatar
Carsten Dominik committed
709 710
	   (shell-quote-argument (concat "pass:"
					 (org-mobile-encryption-password)))
711 712 713 714 715 716
	   (shell-quote-argument (expand-file-name infile))
	   (shell-quote-argument (expand-file-name outfile)))))

(defun org-mobile-decrypt-file (infile outfile)
  "Decrypt INFILE to OUTFILE, using `org-mobile-encryption-password'."
  (shell-command
Rasmus's avatar
Rasmus committed
717
   (format "openssl enc -md md5 -d -aes-256-cbc -salt -pass %s -in %s -out %s"
Carsten Dominik's avatar
Carsten Dominik committed
718 719
	   (shell-quote-argument (concat "pass:"
					 (org-mobile-encryption-password)))
720 721
	   (shell-quote-argument (expand-file-name infile))
	   (shell-quote-argument (expand-file-name outfile)))))
722

Carsten Dominik's avatar
Carsten Dominik committed
723 724 725 726 727 728
(defun org-mobile-cleanup-encryption-tempfile ()
  "Remove the encryption tempfile if it exists."
  (and (stringp org-mobile-encryption-tempfile)
       (file-exists-p org-mobile-encryption-tempfile)
       (delete-file org-mobile-encryption-tempfile)))

729 730 731
(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.
732
If nothing new has been added, return nil."
733
  (interactive)
734 735 736 737 738 739 740
  (let* ((encfile nil)
	 (capture-file (expand-file-name org-mobile-capture-file
					 org-mobile-directory))
	 (inbox-buffer (find-file-noselect org-mobile-inbox-for-pull))
	 (capture-buffer
	  (if (not org-mobile-use-encryption)
	      (find-file-noselect capture-file)
Carsten Dominik's avatar
Carsten Dominik committed
741
	    (org-mobile-cleanup-encryption-tempfile)
742 743 744 745 746 747
	    (setq encfile (concat org-mobile-encryption-tempfile "_enc"))
	    (copy-file capture-file encfile)
	    (org-mobile-decrypt-file encfile org-mobile-encryption-tempfile)
	    (find-file-noselect org-mobile-encryption-tempfile)))
	 (insertion-point (make-marker))
	 not-empty content)
748
    (with-current-buffer capture-buffer
749 750 751 752 753 754 755 756 757 758 759 760
      (setq content (buffer-string))
      (setq not-empty (string-match "\\S-" content))
      (when not-empty
	(set-buffer inbox-buffer)
	(widen)
	(goto-char (point-max))
	(or (bolp) (newline))
	(move-marker insertion-point
		     (prog1 (point) (insert content)))
	(save-buffer)
	(set-buffer capture-buffer)
	(erase-buffer)
761 762
	(save-buffer)
	(org-mobile-update-checksum-for-capture-file (buffer-string))))
763
    (kill-buffer capture-buffer)
764 765
    (when org-mobile-use-encryption
      (org-mobile-encrypt-and-move org-mobile-encryption-tempfile
Carsten Dominik's avatar
Carsten Dominik committed
766 767
				   capture-file)
      (org-mobile-cleanup-encryption-tempfile))
768 769
    (if not-empty insertion-point)))

770
(defun org-mobile-update-checksum-for-capture-file (buffer-string)
771
  "Find the checksum line and modify it to match BUFFER-STRING."
772 773 774 775
  (let* ((file (expand-file-name "checksums.dat" org-mobile-directory))
	 (buffer (find-file-noselect file)))
    (when buffer
      (with-current-buffer buffer
776
	(when (re-search-forward (concat "\\([[:xdigit:]]\\{30,\\}\\).*?"
777 778 779 780 781 782 783 784 785 786
					 (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.
787 788 789 790 791
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)))
792 793

  ;; Remove all Note IDs
794
  (goto-char beg)
795 796 797 798
  (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
799
  (let ((marker (make-marker))
800
	(bos-marker (make-marker))
801
	(end (move-marker (make-marker) end))
802 803 804 805 806
	(cnt-new 0)
	(cnt-edit 0)
	(cnt-flag 0)
	(cnt-error 0)
	buf-list
Rasmus's avatar
Rasmus committed
807
	org-mobile-error)
808 809 810 811 812 813

    ;; 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("))
Rasmus's avatar
Rasmus committed
814
	   (cl-incf cnt-new)))
815

816
    ;; Find and apply the edits
817
    (goto-char beg)
818
    (while (re-search-forward
819
	    "^\\*+[ \t]+F(\\([^():\n]*\\)\\(:\\([^()\n]*\\)\\)?)[ \t]+\\[\\[\\(\\(id\\|olp\\):\\([^]\n]+\\)\\)" end t)
820
      (catch 'next
821 822 823 824 825
	(let* ((action (match-string 1))
	       (data (and (match-end 3) (match-string 3)))
	       (id-pos (condition-case msg
			   (org-mobile-locate-entry (match-string 4))
			 (error (nth 1 msg))))
Rasmus's avatar
Rasmus committed
826
	       (bos (line-beginning-position))
827 828
	       (eos (save-excursion (org-end-of-subtree t t)))
	       (cmd (if (equal action "")
Rasmus's avatar
Rasmus committed
829 830 831 832 833 834 835 836 837
			(let ((note (buffer-substring-no-properties
				     (line-beginning-position 2) eos)))
			  (lambda (_data _old _new)
			    (cl-incf cnt-flag)
			    (org-toggle-tag "FLAGGED" 'on)
			    (org-entry-put
			     nil "THEFLAGGINGNOTE"
			     (replace-regexp-in-string "\n" "\\\\n" note))))
		      (cl-incf cnt-edit)
838
		      (cdr (assoc action org-mobile-action-alist))))
Rasmus's avatar
Rasmus committed
839 840
	       ;; Do not take notes interactively.
	       (org-inhibit-logging 'note)
841 842 843 844 845 846 847 848 849 850 851 852
	       old new)

	  (goto-char bos)
	  (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))
	  (unless (markerp id-pos)
	    (goto-char (+ 2 (point-at-bol)))
	    (if (stringp id-pos)
		(insert id-pos " ")
	      (insert "BAD REFERENCE "))
Rasmus's avatar
Rasmus committed
853
	    (cl-incf cnt-error)
854 855 856
	    (throw 'next t))
	  (unless cmd
	    (insert "BAD FLAG ")
Rasmus's avatar
Rasmus committed
857
	    (cl-incf cnt-error)
858 859
	    (throw 'next t))
	  (move-marker bos-marker (point))
860
	  (if (re-search-forward "^\\** Old value[ \t]*$" eos t)
861 862 863
	      (setq old (buffer-substring
			 (1+ (match-end 0))
			 (progn (outline-next-heading) (point)))))
864
	  (if (re-search-forward "^\\** New value[ \t]*$" eos t)
865 866 867 868 869
	      (setq new (buffer-substring
			 (1+ (match-end 0))
			 (progn (outline-next-heading)
				(if (eobp) (org-back-over-empty-lines))
				(point)))))
Rasmus's avatar
Rasmus committed
870 871
	  (setq old (org-string-nw-p old))
	  (setq new (org-string-nw-p new))
872
	  (unless (equal data "body")
Rasmus's avatar
Rasmus committed
873 874
	    (setq new (and new (org-trim new)))
	    (setq old (and old (org-trim old))))
875 876 877 878
	  (goto-char (+ 2 bos-marker))
	  ;; Remember this place so that we can return
	  (move-marker marker (point))
	  (setq org-mobile-error nil)
Rasmus's avatar
Rasmus committed
879 880 881 882 883
	  (condition-case msg
	      (org-with-point-at id-pos
		(funcall cmd data old new)
		(unless (member data '("delete" "archive" "archive-sibling"
				       "addheading"))
Bastien's avatar
Bastien committed
884
		  (when (member "FLAGGED" (org-get-tags nil t))
Rasmus's avatar
Rasmus committed
885 886 887
		    (add-to-list 'org-mobile-last-flagged-files
				 (buffer-file-name)))))
	    (error (setq org-mobile-error msg)))
888
	  (when org-mobile-error
Rasmus's avatar
Rasmus committed
889
	    (pop-to-buffer-same-window (marker-buffer marker))
890
	    (goto-char marker)
Rasmus's avatar
Rasmus committed
891
	    (cl-incf cnt-error)
892 893 894 895 896 897 898 899 900
	    (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)))))
901
    (save-buffer)
902
    (move-marker marker nil)
903
    (move-marker end nil)
Rasmus's avatar
Rasmus committed
904 905
    (message "%d new, %d edits, %d flags, %d errors"
	     cnt-new cnt-edit cnt-flag cnt-error)
906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
    (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")))))
924 925 926 927 928 929 930 931 932 933 934

(defun org-mobile-smart-read ()
  "Parse the entry at point for shortcuts and expand them.
These shortcuts are meant for fast and easy typing on the limited
keyboards of a mobile device.  Below we show a list of the shortcuts
currently implemented.

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.
935
Abbreviations are expected to take up entire lines, just because it is so
936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956
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.
Time stamps will be constructed using `org-read-date'.  So for example a
line \"dd. 2tue\" will set a deadline on the second Tuesday after the
creation date.

Here are the shortcuts currently implemented:

dd. string             set deadline
ss. string             set scheduling
tt. string             set time tamp, here.
ti. string             set inactive time

tg. tag1 tag2 tag3     set all these tags, change case where necessary
td. kwd                set this todo keyword, change case where necessary

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.")

957 958 959 960
(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))
961 962 963 964 965
					; not found with path, but maybe it is to be inserted
					; in top level of the file?
	(if (not (string-match "\\`olp:\\(.*?\\)$" link))
	    nil
	  (let ((file (match-string 1 link)))
Bastien's avatar
Bastien committed
966
	    (setq file (org-link-decode file))
967 968 969 970 971 972
	    (setq file (expand-file-name file org-directory))
	    (save-excursion
	      (find-file file)
	      (goto-char (point-max))
	      (newline)
	      (goto-char (point-max))
973
	      (point-marker))))
974
      (let ((file (match-string 1 link))
975
	    (path (match-string 2 link)))
Bastien's avatar
Bastien committed
976
	(setq file (org-link-decode file))
977
	(setq file (expand-file-name file org-directory))
Bastien's avatar
Bastien committed
978
	(setq path (mapcar #'org-link-decode
979 980 981 982 983 984 985 986 987 988
			   (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."
989
  (let (current old1 new1 level)
990 991 992 993 994 995 996 997 998 999
    (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))
Rasmus's avatar
Rasmus committed
1000
       ((equal new current) t)		; nothing needs to be done
1001 1002 1003 1004 1005 1006
       ((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))))
1007

1008
     ((eq what 'tags)
Bastien's avatar
Bastien committed
1009
      (setq current (org-get-tags nil t)
1010 1011 1012 1013 1014 1015 1016
	    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))
Bastien's avatar
Bastien committed
1017
	(org-set-tags new1) t)
1018 1019
       (t (error "Tags before change were expected as \"%s\", but are \"%s\""
		 (or old "") (or current "")))))
1020

1021
     ((eq what 'priority)
Rasmus's avatar
Rasmus committed
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
      (let ((case-fold-search nil))
	(when (looking-at org-complex-heading-regexp)
	  (let ((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)))))))
1033 1034

     ((eq what 'heading)
Rasmus's avatar
Rasmus committed
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
      (let ((case-fold-search nil))
	(when (looking-at org-complex-heading-regexp)
	  (let ((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)))
Bastien's avatar
Bastien committed
1046 1047 1048 1049
	      (org-align-tags))
	     (t
	      (error
	       "Heading changed in the mobile device and on the computer")))))))
1050

1051
     ((eq what 'addheading)
Rasmus's avatar
Rasmus committed
1052
      (if (org-at-heading-p)	; if false we are in top-level of file
1053
	  (progn
Bastien Guerry's avatar
Bastien Guerry committed
1054 1055 1056
	    ;; Workaround a `org-insert-heading-respect-content' bug
	    ;; which prevents correct insertion when point is invisible
	    (org-show-subtree)
1057
	    (end-of-line 1)
Bastien Guerry's avatar
Bastien Guerry committed
1058
	    (org-insert-heading-respect-content t)
1059 1060 1061 1062 1063 1064 1065 1066
	    (org-demote))
	(beginning-of-line)
	(insert "* "))
      (insert new))

     ((eq what 'refile)
      (org-copy-subtree)
      (org-with-point-at (org-mobile-locate-entry new)
Rasmus's avatar
Rasmus committed
1067
	(if (org-at-heading-p)	; if false we are in top-level of file
1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
	    (progn
	      (setq level (org-get-valid-level (funcall outline-level) 1))
	      (org-end-of-subtree t t)
	      (org-paste-subtree level))
	  (org-paste-subtree 1)))
      (org-cut-subtree))

     ((eq what 'delete)
      (org-cut-subtree))

     ((eq what 'archive)
      (org-archive-subtree))

     ((eq what 'archive-sibling)
      (org-archive-to-archive-sibling))

1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
     ((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)
Bastien's avatar
Bastien committed
1102 1103
       (t (error
	   "Body was changed in the mobile device and on the computer")))))))
1104

1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
(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))))

1124 1125
(provide 'org-mobile)

1126 1127 1128 1129
;; Local variables:
;; generated-autoload-file: "org-loaddefs.el"
;; End:

1130
;;; org-mobile.el ends here