summaryrefslogtreecommitdiff
path: root/elpa/org-9.5.2/ox-icalendar.el
diff options
context:
space:
mode:
authormattkae <mattkae@protonmail.com>2022-06-07 08:23:47 -0400
committermattkae <mattkae@protonmail.com>2022-06-07 08:23:47 -0400
commitbd18a38c2898548a3664a9ddab9f79c84f2caf4a (patch)
tree95b9933376770381bd8859782ae763be81c2d72b /elpa/org-9.5.2/ox-icalendar.el
parentb07628dddf418d4f47b858e6c35fd3520fbaeed2 (diff)
parentef160dea332af4b4fe5e2717b962936c67e5fe9e (diff)
Merge conflict
Diffstat (limited to 'elpa/org-9.5.2/ox-icalendar.el')
-rw-r--r--elpa/org-9.5.2/ox-icalendar.el1031
1 files changed, 0 insertions, 1031 deletions
diff --git a/elpa/org-9.5.2/ox-icalendar.el b/elpa/org-9.5.2/ox-icalendar.el
deleted file mode 100644
index 16c3dc9..0000000
--- a/elpa/org-9.5.2/ox-icalendar.el
+++ /dev/null
@@ -1,1031 +0,0 @@
-;;; ox-icalendar.el --- iCalendar Back-End for Org Export Engine -*- lexical-binding: t; -*-
-
-;; Copyright (C) 2004-2021 Free Software Foundation, Inc.
-
-;; Author: Carsten Dominik <carsten.dominik@gmail.com>
-;; Nicolas Goaziou <n dot goaziou at gmail dot com>
-;; Maintainer: Nicolas Goaziou <n.goaziou at gmail dot com>
-;; Keywords: outlines, hypermedia, calendar, wp
-;; Homepage: https://orgmode.org
-
-;; 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
-;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
-
-;;; Commentary:
-;;
-;; This library implements an iCalendar back-end for Org generic
-;; exporter. See Org manual for more information.
-;;
-;; It is expected to conform to RFC 5545.
-
-;;; Code:
-
-(require 'cl-lib)
-(require 'org-agenda)
-(require 'ox-ascii)
-(declare-function org-bbdb-anniv-export-ical "ol-bbdb" nil)
-
-
-
-;;; User-Configurable Variables
-
-(defgroup org-export-icalendar nil
- "Options specific for iCalendar export back-end."
- :tag "Org Export iCalendar"
- :group 'org-export)
-
-(defcustom org-icalendar-combined-agenda-file "~/org.ics"
- "The file name for the iCalendar file covering all agenda files.
-This file is created with the command `\\[org-icalendar-combine-agenda-files]'.
-The file name should be absolute. It will be overwritten without warning."
- :group 'org-export-icalendar
- :type 'file)
-
-(defcustom org-icalendar-alarm-time 0
- "Number of minutes for triggering an alarm for exported timed events.
-
-A zero value (the default) turns off the definition of an alarm trigger
-for timed events. If non-zero, alarms are created.
-
-- a single alarm per entry is defined
-- The alarm will go off N minutes before the event
-- only a DISPLAY action is defined."
- :group 'org-export-icalendar
- :version "24.1"
- :type 'integer)
-
-(defcustom org-icalendar-combined-name "OrgMode"
- "Calendar name for the combined iCalendar representing all agenda files."
- :group 'org-export-icalendar
- :type 'string)
-
-(defcustom org-icalendar-combined-description ""
- "Calendar description for the combined iCalendar (all agenda files)."
- :group 'org-export-icalendar
- :type 'string)
-
-(defcustom org-icalendar-exclude-tags nil
- "Tags that exclude a tree from export.
-This variable allows specifying different exclude tags from other
-back-ends. It can also be set with the ICALENDAR_EXCLUDE_TAGS
-keyword."
- :group 'org-export-icalendar
- :type '(repeat (string :tag "Tag")))
-
-(defcustom org-icalendar-use-deadline '(event-if-not-todo todo-due)
- "Contexts where iCalendar export should use a deadline time stamp.
-
-This is a list with possibly several symbols in it. Valid symbols are:
-
-`event-if-todo'
-
- Deadlines in TODO entries become calendar events.
-
-`event-if-todo-not-done'
-
- Deadlines in TODO entries with not-DONE state become events.
-
-`event-if-not-todo'
-
- Deadlines in non-TODO entries become calendar events.
-
-`todo-due'
-
- Use deadlines in TODO entries as due-dates."
- :group 'org-export-icalendar
- :type
- '(set :greedy t
- (const :tag "DEADLINE in non-TODO entries become events"
- event-if-not-todo)
- (const :tag "DEADLINE in TODO entries become events"
- event-if-todo)
- (const :tag "DEADLINE in TODO entries with not-DONE state become events"
- event-if-todo-not-done)
- (const :tag "DEADLINE in TODO entries become due-dates"
- todo-due)))
-
-(defcustom org-icalendar-use-scheduled '(todo-start)
- "Contexts where iCalendar export should use a scheduling time stamp.
-
-This is a list with possibly several symbols in it. Valid symbols are:
-
-`event-if-todo'
-
- Scheduling time stamps in TODO entries become an event.
-
-`event-if-todo-not-done'
-
- Scheduling time stamps in TODO entries with not-DONE state
- become events.
-
-`event-if-not-todo'
-
- Scheduling time stamps in non-TODO entries become an event.
-
-`todo-start'
-
- Scheduling time stamps in TODO entries become start date. Some
- calendar applications show TODO entries only after that date."
- :group 'org-export-icalendar
- :type
- '(set :greedy t
- (const :tag "SCHEDULED timestamps in non-TODO entries become events"
- event-if-not-todo)
- (const :tag "SCHEDULED timestamps in TODO entries become events"
- event-if-todo)
- (const :tag "SCHEDULED in TODO entries with not-DONE state become events"
- event-if-todo-not-done)
- (const :tag "SCHEDULED in TODO entries become start date"
- todo-start)))
-
-(defcustom org-icalendar-categories '(local-tags category)
- "Items that should be entered into the \"categories\" field.
-
-This is a list of symbols, the following are valid:
-`category' The Org mode category of the current file or tree
-`todo-state' The todo state, if any
-`local-tags' The tags, defined in the current line
-`all-tags' All tags, including inherited ones."
- :group 'org-export-icalendar
- :type '(repeat
- (choice
- (const :tag "The file or tree category" category)
- (const :tag "The TODO state" todo-state)
- (const :tag "Tags defined in current line" local-tags)
- (const :tag "All tags, including inherited ones" all-tags))))
-
-(defcustom org-icalendar-with-timestamps 'active
- "Non-nil means make an event from plain time stamps.
-
-It can be set to `active', `inactive', t or nil, in order to make
-an event from, respectively, only active timestamps, only
-inactive ones, all of them or none.
-
-This variable has precedence over `org-export-with-timestamps'.
-It can also be set with the #+OPTIONS line, e.g. \"<:t\"."
- :group 'org-export-icalendar
- :type '(choice
- (const :tag "All timestamps" t)
- (const :tag "Only active timestamps" active)
- (const :tag "Only inactive timestamps" inactive)
- (const :tag "No timestamp" nil)))
-
-(defcustom org-icalendar-include-todo nil
- "Non-nil means create VTODO components from TODO items.
-
-Valid values are:
-nil don't include any task.
-t include tasks that are not in DONE state.
-`unblocked' include all TODO items that are not blocked.
-`all' include both done and not done items."
- :group 'org-export-icalendar
- :type '(choice
- (const :tag "None" nil)
- (const :tag "Unfinished" t)
- (const :tag "Unblocked" unblocked)
- (const :tag "All" all)
- (repeat :tag "Specific TODO keywords"
- (string :tag "Keyword"))))
-
-(defcustom org-icalendar-include-bbdb-anniversaries nil
- "Non-nil means a combined iCalendar file should include anniversaries.
-The anniversaries are defined in the BBDB database."
- :group 'org-export-icalendar
- :type 'boolean)
-
-(defcustom org-icalendar-include-sexps t
- "Non-nil means export to iCalendar files should also cover sexp entries.
-These are entries like in the diary, but directly in an Org file."
- :group 'org-export-icalendar
- :type 'boolean)
-
-(defcustom org-icalendar-include-body t
- "Amount of text below headline to be included in iCalendar export.
-This is a number of characters that should maximally be included.
-Properties, scheduling and clocking lines will always be removed.
-The text will be inserted into the DESCRIPTION field."
- :group 'org-export-icalendar
- :type '(choice
- (const :tag "Nothing" nil)
- (const :tag "Everything" t)
- (integer :tag "Max characters")))
-
-(defcustom org-icalendar-store-UID nil
- "Non-nil means store any created UIDs in properties.
-
-The iCalendar standard requires that all entries have a unique identifier.
-Org will create these identifiers as needed. When this variable is non-nil,
-the created UIDs will be stored in the ID property of the entry. Then the
-next time this entry is exported, it will be exported with the same UID,
-superseding the previous form of it. This is essential for
-synchronization services.
-
-This variable is not turned on by default because we want to avoid creating
-a property drawer in every entry if people are only playing with this feature,
-or if they are only using it locally."
- :group 'org-export-icalendar
- :type 'boolean)
-
-(defcustom org-icalendar-timezone (getenv "TZ")
- "The time zone string for iCalendar export.
-When nil or the empty string, use output
-from (current-time-zone)."
- :group 'org-export-icalendar
- :type '(choice
- (const :tag "Unspecified" nil)
- (string :tag "Time zone")))
-
-(defcustom org-icalendar-date-time-format ":%Y%m%dT%H%M%S"
- "Format-string for exporting icalendar DATE-TIME.
-
-See `format-time-string' for a full documentation. The only
-difference is that `org-icalendar-timezone' is used for %Z.
-
-Interesting value are:
- - \":%Y%m%dT%H%M%S\" for local time
- - \";TZID=%Z:%Y%m%dT%H%M%S\" for local time with explicit timezone
- - \":%Y%m%dT%H%M%SZ\" for time expressed in Universal Time"
- :group 'org-export-icalendar
- :version "24.1"
- :type '(choice
- (const :tag "Local time" ":%Y%m%dT%H%M%S")
- (const :tag "Explicit local time" ";TZID=%Z:%Y%m%dT%H%M%S")
- (const :tag "Universal time" ":%Y%m%dT%H%M%SZ")
- (string :tag "Explicit format")))
-
-(defvar org-icalendar-after-save-hook nil
- "Hook run after an iCalendar file has been saved.
-This hook is run with the name of the file as argument. A good
-way to use this is to tell a desktop calendar application to
-re-read the iCalendar file.")
-
-
-
-;;; Define Back-End
-
-(org-export-define-derived-backend 'icalendar 'ascii
- :translate-alist '((clock . ignore)
- (footnote-definition . ignore)
- (footnote-reference . ignore)
- (headline . org-icalendar-entry)
- (inner-template . org-icalendar-inner-template)
- (inlinetask . ignore)
- (planning . ignore)
- (section . ignore)
- (template . org-icalendar-template))
- :options-alist
- '((:exclude-tags
- "ICALENDAR_EXCLUDE_TAGS" nil org-icalendar-exclude-tags split)
- (:with-timestamps nil "<" org-icalendar-with-timestamps)
- ;; Other variables.
- (:icalendar-alarm-time nil nil org-icalendar-alarm-time)
- (:icalendar-categories nil nil org-icalendar-categories)
- (:icalendar-date-time-format nil nil org-icalendar-date-time-format)
- (:icalendar-include-bbdb-anniversaries nil nil org-icalendar-include-bbdb-anniversaries)
- (:icalendar-include-body nil nil org-icalendar-include-body)
- (:icalendar-include-sexps nil nil org-icalendar-include-sexps)
- (:icalendar-include-todo nil nil org-icalendar-include-todo)
- (:icalendar-store-UID nil nil org-icalendar-store-UID)
- (:icalendar-timezone nil nil org-icalendar-timezone)
- (:icalendar-use-deadline nil nil org-icalendar-use-deadline)
- (:icalendar-use-scheduled nil nil org-icalendar-use-scheduled))
- :filters-alist
- '((:filter-headline . org-icalendar-clear-blank-lines))
- :menu-entry
- '(?c "Export to iCalendar"
- ((?f "Current file" org-icalendar-export-to-ics)
- (?a "All agenda files"
- (lambda (a s v b) (org-icalendar-export-agenda-files a)))
- (?c "Combine all agenda files"
- (lambda (a s v b) (org-icalendar-combine-agenda-files a))))))
-
-
-
-;;; Internal Functions
-
-(defun org-icalendar-create-uid (file &optional bell)
- "Set ID property on headlines missing it in FILE.
-When optional argument BELL is non-nil, inform the user with
-a message if the file was modified."
- (let (modified-flag)
- (org-map-entries
- (lambda ()
- (let ((entry (org-element-at-point)))
- (unless (org-element-property :ID entry)
- (org-id-get-create)
- (setq modified-flag t)
- (forward-line))))
- nil nil 'comment)
- (when (and bell modified-flag)
- (message "ID properties created in file \"%s\"" file)
- (sit-for 2))))
-
-(defun org-icalendar-blocked-headline-p (headline info)
- "Non-nil when HEADLINE is considered to be blocked.
-
-INFO is a plist used as a communication channel.
-
-A headline is blocked when either
-
- - it has children which are not all in a completed state;
-
- - it has a parent with the property :ORDERED:, and there are
- siblings prior to it with incomplete status;
-
- - its parent is blocked because it has siblings that should be
- done first or is a child of a blocked grandparent entry."
- (or
- ;; Check if any child is not done.
- (org-element-map (org-element-contents headline) 'headline
- (lambda (hl) (eq (org-element-property :todo-type hl) 'todo))
- info 'first-match)
- ;; Check :ORDERED: node property.
- (catch 'blockedp
- (let ((current headline))
- (dolist (parent (org-element-lineage headline))
- (cond
- ((not (org-element-property :todo-keyword parent))
- (throw 'blockedp nil))
- ((org-not-nil (org-element-property :ORDERED parent))
- (let ((sibling current))
- (while (setq sibling (org-export-get-previous-element
- sibling info))
- (when (eq (org-element-property :todo-type sibling) 'todo)
- (throw 'blockedp t)))))
- (t (setq current parent))))))))
-
-(defun org-icalendar-use-UTC-date-time-p ()
- "Non-nil when `org-icalendar-date-time-format' requires UTC time."
- (char-equal (elt org-icalendar-date-time-format
- (1- (length org-icalendar-date-time-format)))
- ?Z))
-
-(defun org-icalendar-convert-timestamp (timestamp keyword &optional end tz)
- "Convert TIMESTAMP to iCalendar format.
-
-TIMESTAMP is a timestamp object. KEYWORD is added in front of
-it, in order to make a complete line (e.g. \"DTSTART\").
-
-When optional argument END is non-nil, use end of time range.
-Also increase the hour by two (if time string contains a time),
-or the day by one (if it does not contain a time) when no
-explicit ending time is specified.
-
-When optional argument TZ is non-nil, timezone data time will be
-added to the timestamp. It can be the string \"UTC\", to use UTC
-time, or a string in the IANA TZ database
-format (e.g. \"Europe/London\"). In either case, the value of
-`org-icalendar-date-time-format' will be ignored."
- (let* ((year-start (org-element-property :year-start timestamp))
- (year-end (org-element-property :year-end timestamp))
- (month-start (org-element-property :month-start timestamp))
- (month-end (org-element-property :month-end timestamp))
- (day-start (org-element-property :day-start timestamp))
- (day-end (org-element-property :day-end timestamp))
- (hour-start (org-element-property :hour-start timestamp))
- (hour-end (org-element-property :hour-end timestamp))
- (minute-start (org-element-property :minute-start timestamp))
- (minute-end (org-element-property :minute-end timestamp))
- (with-time-p minute-start)
- (equal-bounds-p
- (equal (list year-start month-start day-start hour-start minute-start)
- (list year-end month-end day-end hour-end minute-end)))
- (mi (cond ((not with-time-p) 0)
- ((not end) minute-start)
- ((and org-agenda-default-appointment-duration equal-bounds-p)
- (+ minute-end org-agenda-default-appointment-duration))
- (t minute-end)))
- (h (cond ((not with-time-p) 0)
- ((not end) hour-start)
- ((or (not equal-bounds-p)
- org-agenda-default-appointment-duration)
- hour-end)
- (t (+ hour-end 2))))
- (d (cond ((not end) day-start)
- ((not with-time-p) (1+ day-end))
- (t day-end)))
- (m (if end month-end month-start))
- (y (if end year-end year-start)))
- (concat
- keyword
- (format-time-string
- (cond ((string-equal tz "UTC") ":%Y%m%dT%H%M%SZ")
- ((not with-time-p) ";VALUE=DATE:%Y%m%d")
- ((stringp tz) (concat ";TZID=" tz ":%Y%m%dT%H%M%S"))
- (t (replace-regexp-in-string "%Z"
- org-icalendar-timezone
- org-icalendar-date-time-format
- t)))
- ;; Convert timestamp into internal time in order to use
- ;; `format-time-string' and fix any mistake (i.e. MI >= 60).
- (encode-time 0 mi h d m y)
- (and (or (string-equal tz "UTC")
- (and (null tz)
- with-time-p
- (org-icalendar-use-UTC-date-time-p)))
- t)))))
-
-(defun org-icalendar-dtstamp ()
- "Return DTSTAMP property, as a string."
- (format-time-string "DTSTAMP:%Y%m%dT%H%M%SZ" nil t))
-
-(defun org-icalendar-get-categories (entry info)
- "Return categories according to `org-icalendar-categories'.
-ENTRY is a headline or an inlinetask element. INFO is a plist
-used as a communication channel."
- (mapconcat
- #'identity
- (org-uniquify
- (let (categories)
- (dolist (type org-icalendar-categories (nreverse categories))
- (cl-case type
- (category
- (push (org-export-get-category entry info) categories))
- (todo-state
- (let ((todo (org-element-property :todo-keyword entry)))
- (and todo (push todo categories))))
- (local-tags
- (setq categories
- (append (nreverse (org-export-get-tags entry info))
- categories)))
- (all-tags
- (setq categories
- (append (nreverse (org-export-get-tags entry info nil t))
- categories)))))))
- ","))
-
-(defun org-icalendar-transcode-diary-sexp (sexp uid summary)
- "Transcode a diary sexp into iCalendar format.
-SEXP is the diary sexp being transcoded, as a string. UID is the
-unique identifier for the entry. SUMMARY defines a short summary
-or subject for the event."
- (when (require 'icalendar nil t)
- (org-element-normalize-string
- (with-temp-buffer
- (let ((sexp (if (not (string-match "\\`<%%" sexp)) sexp
- (concat (substring sexp 1 -1) " " summary))))
- (put-text-property 0 1 'uid uid sexp)
- (insert sexp "\n"))
- (org-diary-to-ical-string (current-buffer))))))
-
-(defun org-icalendar-cleanup-string (s)
- "Cleanup string S according to RFC 5545."
- (when s
- ;; Protect "\", "," and ";" characters. and replace newline
- ;; characters with literal \n.
- (replace-regexp-in-string
- "[ \t]*\n" "\\n"
- (replace-regexp-in-string "[\\,;]" "\\\\\\&" s)
- nil t)))
-
-(defun org-icalendar-fold-string (s)
- "Fold string S according to RFC 5545."
- (org-element-normalize-string
- (mapconcat
- (lambda (line)
- ;; Limit each line to a maximum of 75 characters. If it is
- ;; longer, fold it by using "\r\n " as a continuation marker.
- (let ((len (length line)))
- (if (<= len 75) line
- (let ((folded-line (substring line 0 75))
- (chunk-start 75)
- chunk-end)
- ;; Since continuation marker takes up one character on the
- ;; line, real contents must be split at 74 chars.
- (while (< (setq chunk-end (+ chunk-start 74)) len)
- (setq folded-line
- (concat folded-line "\r\n "
- (substring line chunk-start chunk-end))
- chunk-start chunk-end))
- (concat folded-line "\r\n " (substring line chunk-start))))))
- (org-split-string s "\n") "\r\n")))
-
-
-
-;;; Filters
-
-(defun org-icalendar-clear-blank-lines (headline _back-end _info)
- "Remove blank lines in HEADLINE export.
-HEADLINE is a string representing a transcoded headline.
-BACK-END and INFO are ignored."
- (replace-regexp-in-string "^\\(?:[ \t]*\n\\)+" "" headline))
-
-
-
-;;; Transcode Functions
-
-;;;; Headline and Inlinetasks
-
-;; The main function is `org-icalendar-entry', which extracts
-;; information from a headline or an inlinetask (summary,
-;; description...) and then delegates code generation to
-;; `org-icalendar--vtodo' and `org-icalendar--vevent', depending
-;; on the component needed.
-
-;; Obviously, `org-icalendar--valarm' handles alarms, which can
-;; happen within a VTODO component.
-
-(defun org-icalendar-entry (entry contents info)
- "Transcode ENTRY element into iCalendar format.
-
-ENTRY is either a headline or an inlinetask. CONTENTS is
-ignored. INFO is a plist used as a communication channel.
-
-This function is called on every headline, the section below
-it (minus inlinetasks) being its contents. It tries to create
-VEVENT and VTODO components out of scheduled date, deadline date,
-plain timestamps, diary sexps. It also calls itself on every
-inlinetask within the section."
- (unless (org-element-property :footnote-section-p entry)
- (let* ((type (org-element-type entry))
- ;; Determine contents really associated to the entry. For
- ;; a headline, limit them to section, if any. For an
- ;; inlinetask, this is every element within the task.
- (inside
- (if (eq type 'inlinetask)
- (cons 'org-data (cons nil (org-element-contents entry)))
- (let ((first (car (org-element-contents entry))))
- (and (eq (org-element-type first) 'section)
- (cons 'org-data
- (cons nil (org-element-contents first))))))))
- (concat
- (let ((todo-type (org-element-property :todo-type entry))
- (uid (or (org-element-property :ID entry) (org-id-new)))
- (summary (org-icalendar-cleanup-string
- (or (org-element-property :SUMMARY entry)
- (org-export-data
- (org-element-property :title entry) info))))
- (loc (org-icalendar-cleanup-string
- (org-export-get-node-property
- :LOCATION entry
- (org-property-inherit-p "LOCATION"))))
- (class (org-icalendar-cleanup-string
- (org-export-get-node-property
- :CLASS entry
- (org-property-inherit-p "CLASS"))))
- ;; Build description of the entry from associated section
- ;; (headline) or contents (inlinetask).
- (desc
- (org-icalendar-cleanup-string
- (or (org-element-property :DESCRIPTION entry)
- (let ((contents (org-export-data inside info)))
- (cond
- ((not (org-string-nw-p contents)) nil)
- ((wholenump org-icalendar-include-body)
- (let ((contents (org-trim contents)))
- (substring
- contents 0 (min (length contents)
- org-icalendar-include-body))))
- (org-icalendar-include-body (org-trim contents)))))))
- (cat (org-icalendar-get-categories entry info))
- (tz (org-export-get-node-property
- :TIMEZONE entry
- (org-property-inherit-p "TIMEZONE"))))
- (concat
- ;; Events: Delegate to `org-icalendar--vevent' to generate
- ;; "VEVENT" component from scheduled, deadline, or any
- ;; timestamp in the entry.
- (let ((deadline (org-element-property :deadline entry))
- (use-deadline (plist-get info :icalendar-use-deadline)))
- (and deadline
- (pcase todo-type
- (`todo (or (memq 'event-if-todo-not-done use-deadline)
- (memq 'event-if-todo use-deadline)))
- (`done (memq 'event-if-todo use-deadline))
- (_ (memq 'event-if-not-todo use-deadline)))
- (org-icalendar--vevent
- entry deadline (concat "DL-" uid)
- (concat "DL: " summary) loc desc cat tz class)))
- (let ((scheduled (org-element-property :scheduled entry))
- (use-scheduled (plist-get info :icalendar-use-scheduled)))
- (and scheduled
- (pcase todo-type
- (`todo (or (memq 'event-if-todo-not-done use-scheduled)
- (memq 'event-if-todo use-scheduled)))
- (`done (memq 'event-if-todo use-scheduled))
- (_ (memq 'event-if-not-todo use-scheduled)))
- (org-icalendar--vevent
- entry scheduled (concat "SC-" uid)
- (concat "S: " summary) loc desc cat tz class)))
- ;; When collecting plain timestamps from a headline and its
- ;; title, skip inlinetasks since collection will happen once
- ;; ENTRY is one of them.
- (let ((counter 0))
- (mapconcat
- #'identity
- (org-element-map (cons (org-element-property :title entry)
- (org-element-contents inside))
- 'timestamp
- (lambda (ts)
- (when (let ((type (org-element-property :type ts)))
- (cl-case (plist-get info :with-timestamps)
- (active (memq type '(active active-range)))
- (inactive (memq type '(inactive inactive-range)))
- ((t) t)))
- (let ((uid (format "TS%d-%s" (cl-incf counter) uid)))
- (org-icalendar--vevent
- entry ts uid summary loc desc cat tz class))))
- info nil (and (eq type 'headline) 'inlinetask))
- ""))
- ;; Task: First check if it is appropriate to export it. If
- ;; so, call `org-icalendar--vtodo' to transcode it into
- ;; a "VTODO" component.
- (when (and todo-type
- (cl-case (plist-get info :icalendar-include-todo)
- (all t)
- (unblocked
- (and (eq type 'headline)
- (not (org-icalendar-blocked-headline-p
- entry info))))
- ((t) (eq todo-type 'todo))))
- (org-icalendar--vtodo entry uid summary loc desc cat tz class))
- ;; Diary-sexp: Collect every diary-sexp element within ENTRY
- ;; and its title, and transcode them. If ENTRY is
- ;; a headline, skip inlinetasks: they will be handled
- ;; separately.
- (when org-icalendar-include-sexps
- (let ((counter 0))
- (mapconcat #'identity
- (org-element-map
- (cons (org-element-property :title entry)
- (org-element-contents inside))
- 'diary-sexp
- (lambda (sexp)
- (org-icalendar-transcode-diary-sexp
- (org-element-property :value sexp)
- (format "DS%d-%s" (cl-incf counter) uid)
- summary))
- info nil (and (eq type 'headline) 'inlinetask))
- "")))))
- ;; If ENTRY is a headline, call current function on every
- ;; inlinetask within it. In agenda export, this is independent
- ;; from the mark (or lack thereof) on the entry.
- (when (eq type 'headline)
- (mapconcat #'identity
- (org-element-map inside 'inlinetask
- (lambda (task) (org-icalendar-entry task nil info))
- info) ""))
- ;; Don't forget components from inner entries.
- contents))))
-
-(defun org-icalendar--vevent
- (entry timestamp uid summary location description categories timezone class)
- "Create a VEVENT component.
-
-ENTRY is either a headline or an inlinetask element. TIMESTAMP
-is a timestamp object defining the date-time of the event. UID
-is the unique identifier for the event. SUMMARY defines a short
-summary or subject for the event. LOCATION defines the intended
-venue for the event. DESCRIPTION provides the complete
-description of the event. CATEGORIES defines the categories the
-event belongs to. TIMEZONE specifies a time zone for this event
-only. CLASS contains the visibility attribute. Three of them
-(\"PUBLIC\", \"CONFIDENTIAL\", and \"PRIVATE\") are predefined, others
-should be treated as \"PRIVATE\" if they are unknown to the iCalendar server.
-
-Return VEVENT component as a string."
- (org-icalendar-fold-string
- (if (eq (org-element-property :type timestamp) 'diary)
- (org-icalendar-transcode-diary-sexp
- (org-element-property :raw-value timestamp) uid summary)
- (concat "BEGIN:VEVENT\n"
- (org-icalendar-dtstamp) "\n"
- "UID:" uid "\n"
- (org-icalendar-convert-timestamp timestamp "DTSTART" nil timezone) "\n"
- (org-icalendar-convert-timestamp timestamp "DTEND" t timezone) "\n"
- ;; RRULE.
- (when (org-element-property :repeater-type timestamp)
- (format "RRULE:FREQ=%s;INTERVAL=%d\n"
- (cl-case (org-element-property :repeater-unit timestamp)
- (hour "HOURLY") (day "DAILY") (week "WEEKLY")
- (month "MONTHLY") (year "YEARLY"))
- (org-element-property :repeater-value timestamp)))
- "SUMMARY:" summary "\n"
- (and (org-string-nw-p location) (format "LOCATION:%s\n" location))
- (and (org-string-nw-p class) (format "CLASS:%s\n" class))
- (and (org-string-nw-p description)
- (format "DESCRIPTION:%s\n" description))
- "CATEGORIES:" categories "\n"
- ;; VALARM.
- (org-icalendar--valarm entry timestamp summary)
- "END:VEVENT"))))
-
-(defun org-icalendar--vtodo
- (entry uid summary location description categories timezone class)
- "Create a VTODO component.
-
-ENTRY is either a headline or an inlinetask element. UID is the
-unique identifier for the task. SUMMARY defines a short summary
-or subject for the task. LOCATION defines the intended venue for
-the task. DESCRIPTION provides the complete description of the
-task. CATEGORIES defines the categories the task belongs to.
-TIMEZONE specifies a time zone for this TODO only.
-
-Return VTODO component as a string."
- (let ((start (or (and (memq 'todo-start org-icalendar-use-scheduled)
- (org-element-property :scheduled entry))
- ;; If we can't use a scheduled time for some
- ;; reason, start task now.
- (let ((now (decode-time)))
- (list 'timestamp
- (list :type 'active
- :minute-start (nth 1 now)
- :hour-start (nth 2 now)
- :day-start (nth 3 now)
- :month-start (nth 4 now)
- :year-start (nth 5 now)))))))
- (org-icalendar-fold-string
- (concat "BEGIN:VTODO\n"
- "UID:TODO-" uid "\n"
- (org-icalendar-dtstamp) "\n"
- (org-icalendar-convert-timestamp start "DTSTART" nil timezone) "\n"
- (and (memq 'todo-due org-icalendar-use-deadline)
- (org-element-property :deadline entry)
- (concat (org-icalendar-convert-timestamp
- (org-element-property :deadline entry) "DUE" nil timezone)
- "\n"))
- "SUMMARY:" summary "\n"
- (and (org-string-nw-p location) (format "LOCATION:%s\n" location))
- (and (org-string-nw-p class) (format "CLASS:%s\n" class))
- (and (org-string-nw-p description)
- (format "DESCRIPTION:%s\n" description))
- "CATEGORIES:" categories "\n"
- "SEQUENCE:1\n"
- (format "PRIORITY:%d\n"
- (let ((pri (or (org-element-property :priority entry)
- org-priority-default)))
- (floor (- 9 (* 8. (/ (float (- org-priority-lowest pri))
- (- org-priority-lowest
- org-priority-highest)))))))
- (format "STATUS:%s\n"
- (if (eq (org-element-property :todo-type entry) 'todo)
- "NEEDS-ACTION"
- "COMPLETED"))
- "END:VTODO"))))
-
-(defun org-icalendar--valarm (entry timestamp summary)
- "Create a VALARM component.
-
-ENTRY is the calendar entry triggering the alarm. TIMESTAMP is
-the start date-time of the entry. SUMMARY defines a short
-summary or subject for the task.
-
-Return VALARM component as a string, or nil if it isn't allowed."
- ;; Create a VALARM entry if the entry is timed. This is not very
- ;; general in that:
- ;; (a) only one alarm per entry is defined,
- ;; (b) only minutes are allowed for the trigger period ahead of the
- ;; start time,
- ;; (c) only a DISPLAY action is defined. [ESF]
- (let ((alarm-time
- (let ((warntime
- (org-element-property :APPT_WARNTIME entry)))
- (if warntime (string-to-number warntime) 0))))
- (and (or (> alarm-time 0) (> org-icalendar-alarm-time 0))
- (org-element-property :hour-start timestamp)
- (format "BEGIN:VALARM
-ACTION:DISPLAY
-DESCRIPTION:%s
-TRIGGER:-P0DT0H%dM0S
-END:VALARM\n"
- summary
- (if (zerop alarm-time) org-icalendar-alarm-time alarm-time)))))
-
-
-;;;; Template
-
-(defun org-icalendar-inner-template (contents _)
- "Return document body string after iCalendar conversion.
-CONTENTS is the transcoded contents string."
- contents)
-
-(defun org-icalendar-template (contents info)
- "Return complete document string after iCalendar conversion.
-CONTENTS is the transcoded contents string. INFO is a plist used
-as a communication channel."
- (org-icalendar--vcalendar
- ;; Name.
- (if (not (plist-get info :input-file)) (buffer-name (buffer-base-buffer))
- (file-name-nondirectory
- (file-name-sans-extension (plist-get info :input-file))))
- ;; Owner.
- (if (not (plist-get info :with-author)) ""
- (org-export-data (plist-get info :author) info))
- ;; Timezone.
- (if (org-string-nw-p org-icalendar-timezone) org-icalendar-timezone
- (cadr (current-time-zone)))
- ;; Description.
- (org-export-data (plist-get info :title) info)
- contents))
-
-(defun org-icalendar--vcalendar (name owner tz description contents)
- "Create a VCALENDAR component.
-NAME, OWNER, TZ, DESCRIPTION and CONTENTS are all strings giving,
-respectively, the name of the calendar, its owner, the timezone
-used, a short description and the other components included."
- (concat (format "BEGIN:VCALENDAR
-VERSION:2.0
-X-WR-CALNAME:%s
-PRODID:-//%s//Emacs with Org mode//EN
-X-WR-TIMEZONE:%s
-X-WR-CALDESC:%s
-CALSCALE:GREGORIAN\n"
- (org-icalendar-cleanup-string name)
- (org-icalendar-cleanup-string owner)
- (org-icalendar-cleanup-string tz)
- (org-icalendar-cleanup-string description))
- contents
- "END:VCALENDAR\n"))
-
-
-
-;;; Interactive Functions
-
-;;;###autoload
-(defun org-icalendar-export-to-ics
- (&optional async subtreep visible-only body-only)
- "Export current buffer to an iCalendar file.
-
-If narrowing is active in the current buffer, only export its
-narrowed part.
-
-If a region is active, export that region.
-
-A non-nil optional argument ASYNC means the process should happen
-asynchronously. The resulting file should be accessible through
-the `org-export-stack' interface.
-
-When optional argument SUBTREEP is non-nil, export the sub-tree
-at point, extracting information from the headline properties
-first.
-
-When optional argument VISIBLE-ONLY is non-nil, don't export
-contents of hidden elements.
-
-When optional argument BODY-ONLY is non-nil, only write code
-between \"BEGIN:VCALENDAR\" and \"END:VCALENDAR\".
-
-Return ICS file name."
- (interactive)
- (let ((file (buffer-file-name (buffer-base-buffer))))
- (when (and file org-icalendar-store-UID)
- (org-icalendar-create-uid file 'warn-user)))
- ;; Export part. Since this back-end is backed up by `ascii', ensure
- ;; links will not be collected at the end of sections.
- (let ((outfile (org-export-output-file-name ".ics" subtreep)))
- (org-export-to-file 'icalendar outfile
- async subtreep visible-only body-only
- '(:ascii-charset utf-8 :ascii-links-to-notes nil)
- '(lambda (file)
- (run-hook-with-args 'org-icalendar-after-save-hook file) nil))))
-
-;;;###autoload
-(defun org-icalendar-export-agenda-files (&optional async)
- "Export all agenda files to iCalendar files.
-When optional argument ASYNC is non-nil, export happens in an
-external process."
- (interactive)
- (if async
- ;; Asynchronous export is not interactive, so we will not call
- ;; `org-check-agenda-file'. Instead we remove any non-existent
- ;; agenda file from the list.
- (let ((files (cl-remove-if-not #'file-exists-p (org-agenda-files t))))
- (org-export-async-start
- (lambda (results)
- (dolist (f results) (org-export-add-to-stack f 'icalendar)))
- `(let (output-files)
- (dolist (file ',files outputfiles)
- (with-current-buffer (org-get-agenda-file-buffer file)
- (push (expand-file-name (org-icalendar-export-to-ics))
- output-files))))))
- (let ((files (org-agenda-files t)))
- (org-agenda-prepare-buffers files)
- (unwind-protect
- (dolist (file files)
- (catch 'nextfile
- (org-check-agenda-file file)
- (with-current-buffer (org-get-agenda-file-buffer file)
- (org-icalendar-export-to-ics))))
- (org-release-buffers org-agenda-new-buffers)))))
-
-;;;###autoload
-(defun org-icalendar-combine-agenda-files (&optional async)
- "Combine all agenda files into a single iCalendar file.
-
-A non-nil optional argument ASYNC means the process should happen
-asynchronously. The resulting file should be accessible through
-the `org-export-stack' interface.
-
-The file is stored under the name chosen in
-`org-icalendar-combined-agenda-file'."
- (interactive)
- (if async
- (let ((files (cl-remove-if-not #'file-exists-p (org-agenda-files t))))
- (org-export-async-start
- (lambda (_)
- (org-export-add-to-stack
- (expand-file-name org-icalendar-combined-agenda-file)
- 'icalendar))
- `(apply #'org-icalendar--combine-files ',files)))
- (apply #'org-icalendar--combine-files (org-agenda-files t))))
-
-(defun org-icalendar-export-current-agenda (file)
- "Export current agenda view to an iCalendar FILE.
-This function assumes major mode for current buffer is
-`org-agenda-mode'."
- (let* ((org-export-use-babel) ;don't evaluate Babel blocks
- (contents
- (org-export-string-as
- (with-output-to-string
- (save-excursion
- (let ((p (point-min))
- (seen nil)) ;prevent duplicates
- (while (setq p (next-single-property-change p 'org-hd-marker))
- (let ((m (get-text-property p 'org-hd-marker)))
- (when (and m (not (member m seen)))
- (push m seen)
- (with-current-buffer (marker-buffer m)
- (org-with-wide-buffer
- (goto-char (marker-position m))
- (princ
- (org-element-normalize-string
- (buffer-substring (point)
- (org-entry-end-position))))))))
- (forward-line)))))
- 'icalendar t
- '(:ascii-charset utf-8 :ascii-links-to-notes nil
- :icalendar-include-todo all))))
- (with-temp-file file
- (insert
- (org-icalendar--vcalendar
- org-icalendar-combined-name
- user-full-name
- (or (org-string-nw-p org-icalendar-timezone) (cadr (current-time-zone)))
- org-icalendar-combined-description
- contents)))
- (run-hook-with-args 'org-icalendar-after-save-hook file)))
-
-(defun org-icalendar--combine-files (&rest files)
- "Combine entries from multiple files into an iCalendar file.
-FILES is a list of files to build the calendar from."
- ;; At the end of the process, all buffers related to FILES are going
- ;; to be killed. Make sure to only kill the ones opened in the
- ;; process.
- (let ((org-agenda-new-buffers nil))
- (unwind-protect
- (progn
- (with-temp-file org-icalendar-combined-agenda-file
- (insert
- (org-icalendar--vcalendar
- ;; Name.
- org-icalendar-combined-name
- ;; Owner.
- user-full-name
- ;; Timezone.
- (or (org-string-nw-p org-icalendar-timezone)
- (cadr (current-time-zone)))
- ;; Description.
- org-icalendar-combined-description
- ;; Contents.
- (concat
- ;; Agenda contents.
- (mapconcat
- (lambda (file)
- (catch 'nextfile
- (org-check-agenda-file file)
- (with-current-buffer (org-get-agenda-file-buffer file)
- ;; Create ID if necessary.
- (when org-icalendar-store-UID
- (org-icalendar-create-uid file t))
- (org-export-as
- 'icalendar nil nil t
- '(:ascii-charset utf-8 :ascii-links-to-notes nil)))))
- files "")
- ;; BBDB anniversaries.
- (when (and org-icalendar-include-bbdb-anniversaries
- (require 'ol-bbdb nil t))
- (with-output-to-string (org-bbdb-anniv-export-ical)))))))
- (run-hook-with-args 'org-icalendar-after-save-hook
- org-icalendar-combined-agenda-file))
- (org-release-buffers org-agenda-new-buffers))))
-
-
-(provide 'ox-icalendar)
-
-;; Local variables:
-;; generated-autoload-file: "org-loaddefs.el"
-;; End:
-
-;;; ox-icalendar.el ends here