org-taskjuggler.el 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631
  1. ;;; org-taskjuggler.el --- TaskJuggler exporter for org-mode
  2. ;;
  3. ;; Copyright (C) 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
  4. ;;
  5. ;; Emacs Lisp Archive Entry
  6. ;; Filename: org-taskjuggler.el
  7. ;; Version: 6.34trans
  8. ;; Author: Christian Egli
  9. ;; Maintainer: Christian Egli
  10. ;; Keywords: org, taskjuggler, project planning
  11. ;; Description: Converts an org-mode buffer into a taskjuggler project plan
  12. ;; URL:
  13. ;; This file is part of GNU Emacs.
  14. ;; GNU Emacs is free software: you can redistribute it and/or modify
  15. ;; it under the terms of the GNU General Public License as published by
  16. ;; the Free Software Foundation, either version 3 of the License, or
  17. ;; (at your option) any later version.
  18. ;; GNU Emacs is distributed in the hope that it will be useful,
  19. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  20. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  21. ;; GNU General Public License for more details.
  22. ;; You should have received a copy of the GNU General Public License
  23. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  24. ;; Commentary:
  25. ;;
  26. ;; This library implements a TaskJuggler exporter for org-mode.
  27. ;; TaskJuggler uses a text format to define projects, tasks and
  28. ;; resources, so it is a natural fit for org-mode. It can produce all
  29. ;; sorts of reports for tasks or resources in either HTML, CSV or PDF.
  30. ;; The current version of TaskJuggler requires KDE but the next
  31. ;; version is implemented in Ruby and should therefore run on any
  32. ;; platform.
  33. ;;
  34. ;; The exporter is a bit different from other exporters, such as the
  35. ;; HTML and LaTeX exporters for example, in that it does not export
  36. ;; all the nodes of a document or strictly follow the order of the
  37. ;; nodes in the document.
  38. ;;
  39. ;; Instead the TaskJuggler exporter looks for a tree that defines the
  40. ;; tasks and a optionally tree that defines the resources for this
  41. ;; project. It then creates a TaskJuggler file based on these trees
  42. ;; and the attributes defined in all the nodes.
  43. ;;
  44. ;; * Installation
  45. ;;
  46. ;; Put this file into your load-path and the following line into your
  47. ;; ~/.emacs:
  48. ;;
  49. ;; (require 'org-taskjuggler)
  50. ;;
  51. ;; The interactive functions are similar to those of the HTML and LaTeX
  52. ;; exporters:
  53. ;;
  54. ;; M-x `org-export-as-taskjuggler'
  55. ;; M-x `org-export-as-taskjuggler-and-open'
  56. ;;
  57. ;; * Tasks
  58. ;;
  59. ;; Let's illustrate the usage with a small example. Create your tasks
  60. ;; as you usually do with org-mode. Assign efforts to each task using
  61. ;; properties (it's easiest to do this in the column view). You should
  62. ;; end up with something similar to the example by Peter Jones in
  63. ;; http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org.
  64. ;; Now mark the top node of your tasks with a tag named
  65. ;; "taskjuggler_project" (or whatever you customized
  66. ;; `org-export-taskjuggler-project-tag' to). You are now ready to
  67. ;; export the project plan with `org-export-as-taskjuggler-and-open'
  68. ;; which will export the project plan and open a gant chart in
  69. ;; TaskJugglerUI.
  70. ;;
  71. ;; * Resources
  72. ;;
  73. ;; Next you can define resources and assign those to work on specific
  74. ;; tasks. You can group your resources hierarchically. Tag the top
  75. ;; node of the resources with "taskjuggler_resource" (or whatever you
  76. ;; customized `org-export-taskjuggler-resource-tag' to). You can
  77. ;; optionally assign an ID to the resources (using the standard org
  78. ;; properties commands) or you can let the exporter generate IDs
  79. ;; automatically (the exporter picks the first word of the headline as
  80. ;; the ID as long as it is unique). Using that ID you can then
  81. ;; allocate resources to tasks. This is again done with the "allocate"
  82. ;; property on the tasks. Do this in column view or when on the task
  83. ;; type
  84. ;;
  85. ;; C-c C-x p allocate RET <ID> RET
  86. ;;
  87. ;; Once the allocations are done you can again export to TaskJuggler
  88. ;; and check in the Resource Allocation Graph which person is working
  89. ;; on what task at what time.
  90. ;;
  91. ;; * Export of properties
  92. ;;
  93. ;; The exporter also takes TODO state information into consideration,
  94. ;; i.e. if a task is marked as done it will have the corresponding
  95. ;; attribute in TaskJuggler ("complete 100"). Also it will export any
  96. ;; property on a task resource or resource node which is known to
  97. ;; TaskJuggler, such as limits, vacation, shift, booking, efficiency,
  98. ;; journalentry, rate for resources or account, start, note, duration,
  99. ;; end, journalentry, milestone, reference, responsible, scheduling,
  100. ;; etc for tasks.
  101. ;;
  102. ;; * Dependencies
  103. ;;
  104. ;; The exporter will handle dependencies that are defined in the tasks
  105. ;; either with the ORDERED attribute (see TODO dependencies in the Org
  106. ;; mode manual) or with the BLOCKER attribute (see org-depend.el) or
  107. ;; alternatively with a depends attribute. Both the BLOCKER and the
  108. ;; depends attribute can be either "previous-sibling" or a reference
  109. ;; to an ID which is defined for another task in the project. BLOCKER
  110. ;; and the depends attribute can define multiple dependencies
  111. ;; separated by either space or comma. You can also specify optional
  112. ;; attributes on the dependency by simply appending it. The following
  113. ;; examples should illustrate this:
  114. ;;
  115. ;; * Training material
  116. ;; :PROPERTIES:
  117. ;; :ID: training_material
  118. ;; :ORDERED: t
  119. ;; :END:
  120. ;; ** Markup Guidelines
  121. ;; :PROPERTIES:
  122. ;; :Effort: 2.0
  123. ;; :END:
  124. ;; ** Workflow Guidelines
  125. ;; :PROPERTIES:
  126. ;; :Effort: 2.0
  127. ;; :END:
  128. ;; * Presentation
  129. ;; :PROPERTIES:
  130. ;; :Effort: 2.0
  131. ;; :BLOCKER: training_material { gapduration 1d } some_other_task
  132. ;; :END:
  133. ;;
  134. ;;;; * TODO
  135. ;; - Look at org-file-properties, org-global-properties and
  136. ;; org-global-properties-fixed
  137. ;; - What about property inheritance and org-property-inherit-p?
  138. ;; - Use TYPE_TODO as an way to assign resources
  139. ;; - Make sure multiple dependency definitions (i.e. BLOCKER on
  140. ;; previous-sibling and on a specific ID) in multiple attributes
  141. ;; are properly exported.
  142. ;; - Fix compiler warnings about reference and assignment to free
  143. ;; variable `old-level' in org-taskjuggler-close-maybe
  144. ;;
  145. ;;; Code:
  146. (eval-when-compile
  147. (require 'cl))
  148. (require 'org)
  149. (require 'org-exp)
  150. ;;; User variables:
  151. (defgroup org-export-taskjuggler nil
  152. "Options for exporting Org-mode files to TaskJuggler."
  153. :tag "Org Export TaskJuggler"
  154. :group 'org-export)
  155. (defcustom org-export-taskjuggler-extension ".tjp"
  156. "Extension of TaskJuggler files."
  157. :group 'org-export-taskjuggler
  158. :type 'string)
  159. (defcustom org-export-taskjuggler-project-tag "taskjuggler_project"
  160. "Tag, property or todo used to find the tree containing all
  161. the tasks for the project."
  162. :group 'org-export-taskjuggler
  163. :type 'string)
  164. (defcustom org-export-taskjuggler-resource-tag "taskjuggler_resource"
  165. "Tag, property or todo used to find the tree containing all the
  166. resources for the project."
  167. :group 'org-export-taskjuggler
  168. :type 'string)
  169. (defcustom org-export-taskjuggler-default-project-version "1.0"
  170. "Default version string for the project."
  171. :group 'org-export-taskjuggler
  172. :type 'string)
  173. (defcustom org-export-taskjuggler-default-project-duration 180
  174. "Default project duration if no start and end date have been defined
  175. in the root node of the task tree, i.e. the tree that has been marked
  176. with `org-export-taskjuggler-project-tag'"
  177. :group 'org-export-taskjuggler
  178. :type 'integer)
  179. (defcustom org-export-taskjuggler-default-reports
  180. '("taskreport \"Gantt Chart\" {
  181. headline \"Project Gantt Chart\"
  182. columns hierarchindex, name, start, end, effort, duration, completed, chart
  183. timeformat \"%Y-%m-%d\"
  184. hideresource 1
  185. loadunit shortauto
  186. }"
  187. "resourcereport \"Resource Graph\" {
  188. headline \"Resource Allocation Graph\"
  189. columns no, name, utilization, freeload, chart
  190. loadunit shortauto
  191. sorttasks startup
  192. hidetask ~isleaf()
  193. }")
  194. "Default reports for the project."
  195. :group 'org-export-taskjuggler
  196. :type '(repeat (string :tag "Report")))
  197. (defcustom org-export-taskjuggler-default-global-properties
  198. "shift s40 \"Part time shift\" {
  199. workinghours wed, thu, fri off
  200. }
  201. "
  202. "Default global properties for the project. Here you typically
  203. define global properties such as shifts, accounts, rates,
  204. vacation, macros and flags. Any property that is allowed within
  205. the TaskJuggler file can be inserted. You could for example
  206. include another TaskJuggler file.
  207. The global properties are inserted after the project declaration
  208. but before any resource and task declarations."
  209. :group 'org-export-taskjuggler
  210. :type '(string :tag "Preamble"))
  211. ;;; Hooks
  212. (defvar org-export-taskjuggler-final-hook nil
  213. "Hook run at the end of TaskJuggler export, in the new buffer.")
  214. ;;; Autoload functions:
  215. ;;;###autoload
  216. (defun org-export-as-taskjuggler ()
  217. "Export parts of the current buffer as a TaskJuggler file.
  218. The exporter looks for a tree with tag, property or todo that
  219. matches `org-export-taskjuggler-project-tag' and takes this as
  220. the tasks for this project. The first node of this tree defines
  221. the project properties such as project name and project period.
  222. If there is a tree with tag, property or todo that matches
  223. `org-export-taskjuggler-resource-tag' this three is taken as
  224. resources for the project. If no resources are specified, a
  225. default resource is created and allocated to the project. Also
  226. the taskjuggler project will be created with default reports as
  227. defined in `org-export-taskjuggler-default-reports'."
  228. (interactive)
  229. (message "Exporting...")
  230. (setq-default org-done-keywords org-done-keywords)
  231. (let* ((tasks
  232. (org-taskjuggler-resolve-dependencies
  233. (org-taskjuggler-assign-task-ids
  234. (org-map-entries
  235. '(org-taskjuggler-components)
  236. org-export-taskjuggler-project-tag nil 'archive 'comment))))
  237. (resources
  238. (org-taskjuggler-assign-resource-ids
  239. (org-map-entries
  240. '(org-taskjuggler-components)
  241. org-export-taskjuggler-resource-tag nil 'archive 'comment)))
  242. (filename (expand-file-name
  243. (concat
  244. (file-name-sans-extension
  245. (file-name-nondirectory buffer-file-name))
  246. org-export-taskjuggler-extension)))
  247. (buffer (find-file-noselect filename))
  248. (old-level 0)
  249. task resource)
  250. (unless tasks
  251. (error "No tasks specified"))
  252. ;; add a default resource
  253. (unless resources
  254. (setq resources
  255. `((("ID" . ,(user-login-name))
  256. ("headline" . ,user-full-name)
  257. ("level" . 1)))))
  258. ;; add a default allocation to the first task if none was given
  259. (unless (assoc "allocate" (car tasks))
  260. (let ((task (car tasks))
  261. (resource-id (cdr (assoc "ID" (car resources)))))
  262. (setcar tasks (push (cons "allocate" resource-id) task))))
  263. ;; add a default start date to the first task if none was given
  264. (unless (assoc "start" (car tasks))
  265. (let ((task (car tasks))
  266. (time-string (format-time-string "%Y-%m-%d")))
  267. (setcar tasks (push (cons "start" time-string) task))))
  268. ;; add a default version if none was given
  269. (unless (assoc "version" (car tasks))
  270. (let ((task (car tasks))
  271. (version org-export-taskjuggler-default-project-version))
  272. (setcar tasks (push (cons "version" version) task))))
  273. (with-current-buffer buffer
  274. (erase-buffer)
  275. (org-taskjuggler-open-project (car tasks))
  276. (insert org-export-taskjuggler-default-global-properties)
  277. (insert "\n")
  278. (dolist (resource resources)
  279. (let ((level (cdr (assoc "level" resource))))
  280. (org-taskjuggler-close-maybe level)
  281. (org-taskjuggler-open-resource resource)
  282. (setq old-level level)))
  283. (org-taskjuggler-close-maybe 1)
  284. (setq old-level 0)
  285. (dolist (task tasks)
  286. (let ((level (cdr (assoc "level" task))))
  287. (org-taskjuggler-close-maybe level)
  288. (org-taskjuggler-open-task task)
  289. (setq old-level level)))
  290. (org-taskjuggler-close-maybe 1)
  291. (org-taskjuggler-insert-reports)
  292. (save-buffer)
  293. (or (org-export-push-to-kill-ring "TaskJuggler")
  294. (message "Exporting... done"))
  295. (current-buffer))))
  296. ;;;###autoload
  297. (defun org-export-as-taskjuggler-and-open ()
  298. "Export the current buffer as a TaskJuggler file and open it
  299. with the TaskJuggler GUI."
  300. (interactive)
  301. (let ((file-name (buffer-file-name (org-export-as-taskjuggler)))
  302. (command "TaskJugglerUI"))
  303. (start-process-shell-command command nil command file-name)))
  304. (defun org-taskjuggler-parent-is-ordered-p ()
  305. "Return true if the parent of the current node has a property
  306. \"ORDERED\". Return nil otherwise."
  307. (save-excursion
  308. (and (org-up-heading-safe) (org-entry-get (point) "ORDERED"))))
  309. (defun org-taskjuggler-components ()
  310. "Return an alist containing all the pertinent information for
  311. the current node such as the headline, the level, todo state
  312. information, all the properties, etc."
  313. (let* ((props (org-entry-properties))
  314. (components (org-heading-components))
  315. (level (car components))
  316. (headline (nth 4 components))
  317. (parent-ordered (org-taskjuggler-parent-is-ordered-p)))
  318. (push (cons "level" level) props)
  319. (push (cons "headline" headline) props)
  320. (push (cons "parent-ordered" parent-ordered) props)))
  321. (defun org-taskjuggler-assign-task-ids (tasks)
  322. "Given a list of tasks return the same list assigning a unique id
  323. and the full path to each task. Taskjuggler takes hierarchical ids.
  324. For that reason we have to make ids locally unique and we have to keep
  325. a path to the current task."
  326. (let ((previous-level 0)
  327. unique-ids unique-id
  328. path
  329. task resolved-tasks tmp)
  330. (dolist (task tasks resolved-tasks)
  331. (let ((level (cdr (assoc "level" task))))
  332. (cond
  333. ((< previous-level level)
  334. (setq unique-id (org-taskjuggler-get-unique-id task (car unique-ids)))
  335. (dotimes (tmp (- level previous-level))
  336. (push (list unique-id) unique-ids)
  337. (push unique-id path)))
  338. ((= previous-level level)
  339. (setq unique-id (org-taskjuggler-get-unique-id task (car unique-ids)))
  340. (push unique-id (car unique-ids))
  341. (setcar path unique-id))
  342. ((> previous-level level)
  343. (dotimes (tmp (- previous-level level))
  344. (pop unique-ids)
  345. (pop path))
  346. (setq unique-id (org-taskjuggler-get-unique-id task (car unique-ids)))
  347. (push unique-id (car unique-ids))
  348. (setcar path unique-id)))
  349. (push (cons "unique-id" unique-id) task)
  350. (push (cons "path" (mapconcat 'identity (reverse path) ".")) task)
  351. (setq previous-level level)
  352. (setq resolved-tasks (append resolved-tasks (list task)))))))
  353. (defun org-taskjuggler-assign-resource-ids (resources &optional unique-ids)
  354. "Given a list of resources return the same list, assigning a
  355. unique id to each resource."
  356. (cond
  357. ((null resources) nil)
  358. (t
  359. (let* ((resource (car resources))
  360. (unique-id (org-taskjuggler-get-unique-id resource unique-ids)))
  361. (push (cons "unique-id" unique-id) resource)
  362. (cons resource
  363. (org-taskjuggler-assign-resource-ids (cdr resources)
  364. (cons unique-id unique-ids)))))))
  365. (defun org-taskjuggler-resolve-dependencies (tasks)
  366. (let ((previous-level 0)
  367. siblings
  368. task resolved-tasks)
  369. (dolist (task tasks resolved-tasks)
  370. (let* ((level (cdr (assoc "level" task)))
  371. (depends (cdr (assoc "depends" task)))
  372. (parent-ordered (cdr (assoc "parent-ordered" task)))
  373. (blocker (cdr (assoc "BLOCKER" task)))
  374. (blocked-on-previous
  375. (and blocker (string-match "previous-sibling" blocker)))
  376. (dependencies
  377. (org-taskjuggler-resolve-explicit-dependencies
  378. (append
  379. (and depends (org-taskjuggler-tokenize-dependencies depends))
  380. (and blocker (org-taskjuggler-tokenize-dependencies blocker)))
  381. tasks))
  382. previous-sibling)
  383. ; update previous sibling info
  384. (cond
  385. ((< previous-level level)
  386. (dotimes (tmp (- level previous-level))
  387. (push task siblings)))
  388. ((= previous-level level)
  389. (setq previous-sibling (car siblings))
  390. (setcar siblings task))
  391. ((> previous-level level)
  392. (dotimes (tmp (- previous-level level))
  393. (pop siblings))
  394. (setq previous-sibling (car siblings))
  395. (setcar siblings task)))
  396. ; insert a dependency on previous sibling if the parent is
  397. ; ordered or if the tasks has a BLOCKER attribute with value "previous-sibling"
  398. (when (or (and previous-sibling parent-ordered) blocked-on-previous)
  399. (push (format "!%s" (cdr (assoc "unique-id" previous-sibling))) dependencies))
  400. ; store dependency information
  401. (when dependencies
  402. (push (cons "depends" (mapconcat 'identity dependencies ", ")) task))
  403. (setq previous-level level)
  404. (setq resolved-tasks (append resolved-tasks (list task)))))))
  405. (defun org-taskjuggler-tokenize-dependencies (dependencies)
  406. "Split a dependency property value DEPENDENCIES into the
  407. individual dependencies and return them as a list while keeping
  408. the optional arguments (such as gapduration) for the
  409. dependencies. A dependency will have to match `[-a-zA-Z0-9_]+'."
  410. (cond
  411. ((string-match "^ *$" dependencies) nil)
  412. ((string-match "^[ \t]*\\([-a-zA-Z0-9_]+\\([ \t]*{[^}]+}\\)?\\)[ \t,]*" dependencies)
  413. (cons
  414. (substring dependencies (match-beginning 1) (match-end 1))
  415. (org-taskjuggler-tokenize-dependencies (substring dependencies (match-end 0)))))
  416. (t (error (format "invalid dependency id %s" dependencies)))))
  417. (defun org-taskjuggler-resolve-explicit-dependencies (dependencies tasks)
  418. "For each dependency in DEPENDENCIES try to find a
  419. corresponding task with a matching ID in TASKS. Return a list
  420. containing the resolved links for all DEPENDENCIES where a
  421. matching tasks was found. If the dependency is
  422. \"previous-sibling\" it is ignored (as this is dealt with in
  423. `org-taskjuggler-resolve-dependencies'). If there is no matching
  424. task the dependency is silently ignored."
  425. (unless (null dependencies)
  426. (let*
  427. ;; the dependency might have optional attributes such as "{
  428. ;; gapduration 5d }", so only use the first string as id for the
  429. ;; dependency
  430. ((dependency (car dependencies))
  431. (id (car (split-string dependency)))
  432. (optional-attributes
  433. (mapconcat 'identity (cdr (split-string dependency)) " "))
  434. (path (org-taskjuggler-find-task-with-id id tasks)))
  435. (cond
  436. ;; ignore previous sibling dependencies
  437. ((equal (car dependencies) "previous-sibling")
  438. (org-taskjuggler-resolve-explicit-dependencies (cdr dependencies) tasks))
  439. ;; if the id is found in another task use its path
  440. ((not (null path))
  441. (cons (mapconcat 'identity (list path optional-attributes) " ")
  442. (org-taskjuggler-resolve-explicit-dependencies
  443. (cdr dependencies) tasks)))
  444. ;; silently ignore all other dependencies
  445. (t (org-taskjuggler-resolve-explicit-dependencies (cdr dependencies) tasks))))))
  446. (defun org-taskjuggler-find-task-with-id (id tasks)
  447. "Find ID in tasks. If found return the path of task. Otherwise
  448. return nil."
  449. (let ((task-id (cdr (assoc "ID" (car tasks))))
  450. (path (cdr (assoc "path" (car tasks)))))
  451. (cond
  452. ((null tasks) nil)
  453. ((equal task-id id) path)
  454. (t (org-taskjuggler-find-task-with-id id (cdr tasks))))))
  455. (defun org-taskjuggler-get-unique-id (item unique-ids)
  456. "Return a unique id for an ITEM which can be a task or a resource.
  457. The id is derived from the headline and made unique against
  458. UNIQUE-IDS. If the first part of the headline is not unique try
  459. to add more parts of the headline or finally add more underscore
  460. characters (\"_\")."
  461. (let* ((headline (cdr (assoc "headline" item)))
  462. (parts (split-string headline))
  463. (id (org-taskjuggler-clean-id (downcase (pop parts)))))
  464. ; try to add more parts of the headline to make it unique
  465. (while (member id unique-ids)
  466. (setq id (concat id "_" (org-taskjuggler-clean-id (downcase (pop parts))))))
  467. ; if its still not unique add "_"
  468. (while (member id unique-ids)
  469. (setq id (concat id "_")))
  470. id))
  471. (defun org-taskjuggler-clean-id (id)
  472. "Clean and return ID to make it acceptable for taskjuggler."
  473. (and id (replace-regexp-in-string "[^a-zA-Z0-9_]" "_" id)))
  474. (defun org-taskjuggler-open-project (project)
  475. "Insert a the beginning of project declaration. All valid
  476. attributes from the PROJECT alist are inserted. If no end date is
  477. specified it is calculated
  478. `org-export-taskjuggler-default-project-duration' days from now."
  479. (let* ((unique-id (cdr (assoc "unique-id" project)))
  480. (headline (cdr (assoc "headline" project)))
  481. (version (cdr (assoc "version" project)))
  482. (start (cdr (assoc "start" project)))
  483. (end (cdr (assoc "end" project))))
  484. (insert
  485. (format "project %s \"%s\" \"%s\" %s +%sd {\n }\n"
  486. unique-id headline version start
  487. org-export-taskjuggler-default-project-duration))))
  488. (defun org-taskjuggler-filter-and-join (items)
  489. "Filter all nil elements from ITEMS and join the remaining ones
  490. with separator \"\n\"."
  491. (let ((filtered-items (remq nil items)))
  492. (and filtered-items (mapconcat 'identity filtered-items "\n"))))
  493. (defun org-taskjuggler-get-attributes (item attributes)
  494. "Return all attribute as a single formated string. ITEM is an
  495. alist representing either a resource or a task. ATTRIBUTES is a
  496. list of symbols. Only entries from ITEM are considered that are
  497. listed in ATTRIBUTES."
  498. (org-taskjuggler-filter-and-join
  499. (mapcar
  500. (lambda (attribute)
  501. (org-taskjuggler-filter-and-join
  502. (org-taskjuggler-get-attribute item attribute)))
  503. attributes)))
  504. (defun org-taskjuggler-get-attribute (item attribute)
  505. "Return a list of strings containing the properly formatted
  506. taskjuggler declaration for a given ATTRIBUTE in ITEM (an alist).
  507. If the ATTRIBUTE is not in ITEM return nil."
  508. (cond
  509. ((null item) nil)
  510. ((equal (symbol-name attribute) (car (car item)))
  511. (cons (format "%s %s" (symbol-name attribute) (cdr (car item)))
  512. (org-taskjuggler-get-attribute (cdr item) attribute)))
  513. (t (org-taskjuggler-get-attribute (cdr item) attribute))))
  514. (defun org-taskjuggler-open-resource (resource)
  515. (let ((id (org-taskjuggler-clean-id (cdr (assoc "ID" resource))))
  516. (unique-id (org-taskjuggler-clean-id (cdr (assoc "unique-id" resource))))
  517. (headline (cdr (assoc "headline" resource)))
  518. (attributes '(limits vacation shift booking efficiency journalentry rate)))
  519. (insert
  520. (concat
  521. "resource " (or id unique-id) " \"" headline "\" {\n "
  522. (org-taskjuggler-get-attributes resource attributes) "\n"))))
  523. (defun org-taskjuggler-clean-effort (effort)
  524. "Translate effort strings into a format acceptable to taskjuggler,
  525. i.e. REAL UNIT. If the effort string is something like 5:30 it
  526. will be assumed to be hours and will be translated into 5.5h.
  527. Otherwise if it contains something like 3.0 it is assumed to be
  528. days and will be translated into 3.0d. Other formats that
  529. taskjuggler supports (like weeks, months and years) are currently
  530. not supported."
  531. (cond
  532. ((null effort) effort)
  533. ((string-match "\\([0-9]+\\):\\([0-9]+\\)" effort)
  534. (let ((hours (string-to-number (match-string 1 effort)))
  535. (minutes (string-to-number (match-string 2 effort))))
  536. (format "%dh" (+ hours (/ minutes 60.0)))))
  537. ((string-match "\\([0-9]+\\).\\([0-9]+\\)" effort) (concat effort "d"))
  538. (t (error "Not a valid effort (%s)" effort))))
  539. (defun org-taskjuggler-get-priority (priority)
  540. "Return a priority between 1 and 1000 based on PRIORITY, an
  541. org-mode priority string."
  542. (max 1 (/ (* 1000 (- org-lowest-priority (string-to-char priority)))
  543. (- org-lowest-priority org-highest-priority))))
  544. (defun org-taskjuggler-open-task (task)
  545. (let* ((unique-id (cdr (assoc "unique-id" task)))
  546. (headline (cdr (assoc "headline" task)))
  547. (effort (org-taskjuggler-clean-effort (cdr (assoc org-effort-property task))))
  548. (depends (cdr (assoc "depends" task)))
  549. (allocate (cdr (assoc "allocate" task)))
  550. (priority-raw (cdr (assoc "PRIORITY" task)))
  551. (priority (and priority-raw (org-taskjuggler-get-priority priority-raw)))
  552. (state (cdr (assoc "TODO" task)))
  553. (complete (or (and (member state org-done-keywords) "100")
  554. (cdr (assoc "complete" task))))
  555. (parent-ordered (cdr (assoc "parent-ordered" task)))
  556. (previous-sibling (cdr (assoc "previous-sibling" task)))
  557. (attributes
  558. '(account start note duration endbuffer endcredit end
  559. flags journalentry, length maxend maxstart milestone
  560. minend minstart period reference responsible
  561. scheduling startbuffer startcredit statusnote)))
  562. (insert
  563. (concat
  564. "task " unique-id " \"" headline "\" {\n"
  565. (if (and parent-ordered previous-sibling)
  566. (format " depends %s\n" previous-sibling)
  567. (and depends (format " depends %s\n" depends)))
  568. (and allocate (format " purge allocations\n allocate %s\n" allocate))
  569. (and complete (format " complete %s\n" complete))
  570. (and effort (format " effort %s\n" effort))
  571. (and priority (format " priority %s\n" priority))
  572. (org-taskjuggler-get-attributes task attributes)
  573. "\n"))))
  574. (defun org-taskjuggler-close-maybe (level)
  575. (while (> old-level level)
  576. (insert "}\n")
  577. (setq old-level (1- old-level)))
  578. (when (= old-level level)
  579. (insert "}\n")))
  580. (defun org-taskjuggler-insert-reports ()
  581. (let (report)
  582. (dolist (report org-export-taskjuggler-default-reports)
  583. (insert report "\n"))))
  584. (provide 'org-taskjuggler)
  585. ;;; org-taskjuggler.el ends here