├── .gitignore ├── README.org ├── org-pdftools.el ├── org-noter-pdftools.el └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *.elc 2 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | #+TITLE: org-pdftools: a custom org link type for pdf-tools 2 | 3 | This project was inspired by and built upon ~org-pdfview~ from @markus1189. 4 | * Installation 5 | 6 | You can now install ~org-pdftools~ and ~org-noter-pdftools~ from MELPA! 7 | 8 | [[https://melpa.org/#/org-pdftools][file:https://melpa.org/packages/org-pdftools-badge.svg]] 9 | 10 | [[https://melpa.org/#/org-pdftools][file:https://melpa.org/packages/org-noter-pdftools-badge.svg]] 11 | 12 | Run ~M-x pdf-tools-install~ after installation of ~pdftools~ if you haven't done before. 13 | #+BEGIN_SRC elisp 14 | (use-package org-noter 15 | :config 16 | ;; Your org-noter config ........ 17 | (require 'org-noter-pdftools)) 18 | 19 | (use-package org-pdftools 20 | :hook (org-mode . org-pdftools-setup-link)) 21 | 22 | (use-package org-noter-pdftools 23 | :after org-noter 24 | :config 25 | ;; Add a function to ensure precise note is inserted 26 | (defun org-noter-pdftools-insert-precise-note (&optional toggle-no-questions) 27 | (interactive "P") 28 | (org-noter--with-valid-session 29 | (let ((org-noter-insert-note-no-questions (if toggle-no-questions 30 | (not org-noter-insert-note-no-questions) 31 | org-noter-insert-note-no-questions)) 32 | (org-pdftools-use-isearch-link t) 33 | (org-pdftools-use-freepointer-annot t)) 34 | (org-noter-insert-note (org-noter--get-precise-info))))) 35 | 36 | ;; fix https://github.com/weirdNox/org-noter/pull/93/commits/f8349ae7575e599f375de1be6be2d0d5de4e6cbf 37 | (defun org-noter-set-start-location (&optional arg) 38 | "When opening a session with this document, go to the current location. 39 | With a prefix ARG, remove start location." 40 | (interactive "P") 41 | (org-noter--with-valid-session 42 | (let ((inhibit-read-only t) 43 | (ast (org-noter--parse-root)) 44 | (location (org-noter--doc-approx-location (when (called-interactively-p 'any) 'interactive)))) 45 | (with-current-buffer (org-noter--session-notes-buffer session) 46 | (org-with-wide-buffer 47 | (goto-char (org-element-property :begin ast)) 48 | (if arg 49 | (org-entry-delete nil org-noter-property-note-location) 50 | (org-entry-put nil org-noter-property-note-location 51 | (org-noter--pretty-print-location location)))))))) 52 | (with-eval-after-load 'pdf-annot 53 | (add-hook 'pdf-annot-activate-handler-functions #'org-noter-pdftools-jump-to-note))) 54 | #+END_SRC 55 | 56 | * Latest release note 57 | - Incorporated https://github.com/weirdNox/org-noter/pull/93/commits/f8349ae7575e599f375de1be6be2d0d5de4e6cbf in Usage README 58 | - Added customizable variable ~org-pdftools-use-isearch-link~ and ~org-pdftools-use-freepointer-annot~ to control whether you will get prompt to create isearch/freepointer link if no existing annotations are found 59 | 60 | * Usage 61 | In order to link a specific page of a .pdf-file in an org-file, use the following syntax: 62 | #+begin_example 63 | [[pdf:~/file.pdf::3][Link to page 3]] 64 | #+end_example 65 | 66 | When browsing a pdftools-buffer you can use =org-store-link= (by default =C-c l=) to get a link to this location withing the pdf -- even while marking some content in the .pdf. 67 | Then use =org-insert-link= (by default =C-c C-l=) to create a link to this page and this place on the page: 68 | #+begin_example 69 | [[pdf:~/file.pdf::5++0.00;;annot-5-0][file.pdf: Page 5; Quoting: some text]] 70 | #+end_example 71 | 72 | * Current features 73 | The provided function includes: 74 | - [X] (Sort-of) backward compatibility with org-pdfview: simply change the link prefix from 75 | ~pdfview:~ to ~pdf:~. 76 | - [X] The reason this URL prefix change was proposed is that ~pdftools:~ links can 77 | also point to ~pdf-occur~ searchs. Multi-file search is also supported. 78 | - [X] There is also support for ~pdf-isearch~. 79 | - [X] Beyond the original link implementation that stores only file path and page 80 | number, now you can store the precise location of annotations. 81 | - [X] If there are selected texts on the current PDF page, it will be ~marked-up~ 82 | using pdf-tools markup functions (by default, underline) automatically and the 83 | corresponding annotation id is stored in the link. 84 | 85 | - HTML exported link now have a "#page=n" postfix, which should make browsers like Chrome open the corresponding page. 86 | - You can now customize the link description format using ~org-pdftools-get-desc-function~ 87 | - Added ~org-noter-pdftools-embed-org-note-to-pdf~, ~org-noter-pdftools-embed-all-org-note-to-pdf~ to copy one or all *org-noter annotation headings* (the ones with a ~annot-id~ and ~org-pdftools link~) to the corresponding PDF file. 88 | - Added ~org-noter-pdftools-embed-org-buffer-to-pdf~ to copy the whole *org-noter* buffer to a annotation in the left upper corner of the first page in the PDF. 89 | - Added ~org-noter-pdftools-jump-to-note~ config in the README. 90 | - The prefix of pdftools link can now be customized using ~org-pdftools-link-prefix~, and the default is now set to "pdf" 91 | - The ~org-pdftools-search-string-separator~ is now set to ~??~ to avoid org fontification problem 92 | - You can now specify how the path of pdf is stored using two function: 93 | - ~org-pdftools-path-generator~ takes ~buffer-file-name~ as an argument, and output a translated path. Default to ~abbreviate-file-name~ 94 | - ~org-pdftools-path-resolver~ takes a translated path as an argument and translate it back to absolute path. Default to ~expand-file-name~ 95 | 96 | 97 | * Integration with ~org-noter~ 98 | You can use the vanilla ~org-noter~ now. 99 | 100 | - [X] Integrate with ~org-noter~, such that ~org-noter~ can remember the precise 101 | location (in the resolution of the exact annotation). 102 | - [X] Jump from a PDF annotation to a associated org-heading ~org-noter-sync-*~ and 103 | ~org-noter-jump-to-heading~. 104 | - [X] Transform old org-noter notes to newer ones and sync with the corresponding 105 | PDF. ~org-noter-convert-old-notes~ 106 | - [-] PDF annotation will have full and synced information with the associated 107 | org-note. (Besides the note content, each annotate will record the IDs of the 108 | corresponding org heading and potentially even it's parent org heading, such 109 | that tree-rebuild is possible.) 110 | 111 | * Planed features 112 | This is the first step of a set of overhauls of Emacs PDF notetaking experience. 113 | The features below are planned (either in this package or as PR to other 114 | packages): 115 | - [-] Optionally grab image/text excerpt from the PDF and insert below the 116 | corresponding org-heading. 117 | Please refer to ~pdf-view-extract-region-image~, not sure what's the best way 118 | to integrate it. 119 | - [ ] Link export with image/text-based excerpt from the PDF. 120 | - [ ] (Long-term) Org <-> PDF Annotation converter. 121 | -------------------------------------------------------------------------------- /org-pdftools.el: -------------------------------------------------------------------------------- 1 | ;;; org-pdftools.el --- Support for links to documents in pdfview mode -*- lexical-binding: t; -*- 2 | ;; Copyright (C) 2020 Alexander Fu Xi 3 | 4 | ;; Author: Alexander Fu Xi 5 | ;; Maintainer: Alexander Fu Xi 6 | ;; Homepage: https://github.com/fuxialexander/org-pdftools 7 | ;; Version: 1.1 8 | ;; Keywords: convenience 9 | ;; Package-Requires: ((emacs "26.1") (org "9.3.6") (pdf-tools "0.8") (org-noter "1.4.1")) 10 | 11 | ;; This program is free software; you can redistribute it and/or modify 12 | ;; it under the terms of the GNU General Public License as published by 13 | ;; the Free Software Foundation, either version 3 of the License, or 14 | ;; (at your option) any later version. 15 | ;; 16 | ;; This program is distributed in the hope that it will be useful, 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 | ;; GNU General Public License for more details. 20 | ;; 21 | ;; You should have received a copy of the GNU General Public License 22 | ;; along with this program. If not, see . 23 | 24 | ;;; Commentary: 25 | ;; Add support for org links from pdftools buffers with more precise location control. 26 | ;; 27 | ;; https://github.com/fuxialexander/org-pdftools/ 28 | 29 | 30 | ;;; Code: 31 | (require 'subr-x) 32 | (require 'cl-lib) 33 | (require 'org) 34 | (require 'org-refile nil t) 35 | (require 'org-noter) 36 | (require 'pdf-tools) 37 | (require 'pdf-view) 38 | (require 'pdf-annot) 39 | (require 'pdf-occur) 40 | 41 | (defgroup org-pdftools nil 42 | "Tools for adding pdftools link support in Org mode." 43 | :group 'tools) 44 | 45 | (defcustom org-pdftools-get-desc-function #'org-pdftools-get-desc-default 46 | "A function that takes 3 arguments and output a link description. 47 | - `file': basename of the PDF file 48 | - `page': current page number converted to string 49 | - `text' (should have optional tag): additional text infomation like 50 | highlighted text or isearch string. 51 | See `org-pdftools-get-desc-default' as an example." 52 | 53 | :group 'org-pdftools 54 | :type 'function) 55 | (defcustom org-pdftools-path-generator #'org-pdftools-abbreviate-file-name 56 | "Translate your PDF file path the way you like. Take variable `buffer-file-name' as the argument." 57 | :group 'org-pdftools 58 | :type 'function) 59 | (defcustom org-pdftools-path-resolver #'org-pdftools-expand-file-name 60 | "Resolve your translated PDF file path back to an absolute path." 61 | :group 'org-pdftools 62 | :type 'function) 63 | (defcustom org-pdftools-path-exporter #'org-pdftools-export-file-name 64 | "Resolve your translated PDF file path back to an absolute or relative path for export." 65 | :group 'org-pdftools 66 | :type 'function) 67 | (defcustom org-pdftools-path-translations nil 68 | "An alist of form (FROM . TO) to specify path translations. 69 | Expands path starting with `FROM' to `TO' when opening links. 70 | And reverse substitutes from `TO' to `FROM' occurs when creating pdf links." 71 | :group 'org-pdftools 72 | :type 'alist) 73 | (defcustom org-pdftools-path-export-translations nil 74 | "An alist of (FROM . TO) such that path starting with `FROM' are expanded to `TO' when exporting links." 75 | :group 'org-pdftools 76 | :type 'alist) 77 | (defcustom org-pdftools-open-custom-open nil 78 | "Custom function to open linked pdf files." 79 | :group 'org-pdftools 80 | :type '(choice function nil)) 81 | 82 | (defcustom org-pdftools-use-freepointer-annot nil 83 | "Whether prompt to use freepointer annotation or not." 84 | :group 'org-pdftools 85 | :type 'boolean) 86 | 87 | (defcustom org-pdftools-use-isearch-link nil 88 | "Whether prompt to use isearch link or not." 89 | :group 'org-pdftools 90 | :type 'boolean) 91 | 92 | (defcustom org-pdftools-export-style 'pdftools 93 | "Export style of org-pdftools links. 94 | - pdftools :: export the link as is 95 | - protocol :: export the link as a org-protocal link such that it could open pdf-tools when clicked" 96 | :group 'org-pdftools 97 | :type 'symbol) 98 | (defcustom org-pdftools-markup-pointer-function 'pdf-annot-add-underline-markup-annotation 99 | "Color for markup pointer annotations. 100 | Can be one of highlight/underline/strikeout/squiggly." 101 | :group 'org-pdftools 102 | :type 'function) 103 | (defcustom org-pdftools-markup-pointer-color "#A9A9A9" 104 | "Color for markup pointer annotations." 105 | :group 'org-pdftools 106 | :type 'string) 107 | (defcustom org-pdftools-markup-pointer-opacity 1.0 108 | "Opacity for markup pointer annotations." 109 | :group 'org-pdftools 110 | :type 'float) 111 | (defcustom org-pdftools-free-pointer-icon "Circle" 112 | "Color for free pointer annotations. Refer to `pdf-annot-standard-text-icons`." 113 | :group 'org-pdftools 114 | :type 'string) 115 | (defcustom org-pdftools-link-prefix "pdf" 116 | "Prefix for org-pdftools link." 117 | :group 'org-pdftools 118 | :type 'string) 119 | (defcustom org-pdftools-search-string-separator "??" 120 | "Separator of search-string." 121 | :group 'org-pdftools 122 | :type 'string) 123 | (defcustom org-pdftools-free-pointer-color "#FFFFFF" 124 | "Color for free pointer annotations." 125 | :group 'org-pdftools 126 | :type 'string) 127 | (defcustom org-pdftools-free-pointer-opacity 1.0 128 | "Opacity for free pointer annotations." 129 | :group 'org-pdftools 130 | :type 'float) 131 | 132 | (cl-defun org-pdftools-add-path-translation (from to-open &optional (to-export to-open)) 133 | "Add path translation rule for opening, creating and exporting links. 134 | Adds translation rule to replace `FROM' with `TO-OPEN' when opening links and 135 | with `TO-EXPORT' when exporting links. Also use reverse translation from 136 | `TO-OPEN' to `FROM' when creating links." 137 | (cl-pushnew (cons from to-open) org-pdftools-path-translations :test #'equalp) 138 | (when to-export 139 | (cl-pushnew (cons from to-export) org-pdftools-path-export-translations :test #'equalp))) 140 | 141 | (defun org-pdftools-abbreviate-file-name (path) 142 | "Abbreviate `PATH' using `org-pdftools-path-translations'." 143 | (let ((translation-rule (cl-find-if (lambda (rule) 144 | (cl-destructuring-bind (from . to) rule 145 | (string-prefix-p to path))) 146 | org-pdftools-path-translations))) 147 | (if translation-rule 148 | (cl-destructuring-bind (from . to) translation-rule 149 | (cl-concatenate 'string 150 | from 151 | (cl-subseq path (length to)))) 152 | (abbreviate-file-name path)))) 153 | 154 | (defun org-pdftools--apply-translations (path rules) 155 | "Expand `PATH' using `RULES'. 156 | - `RULES' is an alist of (FROM . TO). 157 | If no rules match, `PATH' is returned as it is." 158 | (let ((translation-rule (cl-find-if (lambda (rule) 159 | (cl-destructuring-bind (from . to) rule 160 | (string-prefix-p from path))) 161 | rules))) 162 | (if translation-rule 163 | (cl-destructuring-bind (from . to) translation-rule 164 | (setf path (cl-concatenate 'string 165 | to 166 | (cl-subseq path (length from))))) 167 | path))) 168 | 169 | (defun org-pdftools-expand-file-name (path) 170 | "Expand `PATH' as per `org-pdftools-path-translations'." 171 | (expand-file-name (org-pdftools--apply-translations path org-pdftools-path-translations))) 172 | 173 | (defun org-pdftools-export-file-name (path) 174 | "Expand `PATH' as per `org-pdftools-path-export-translations'." 175 | (org-pdftools--apply-translations path org-pdftools-path-export-translations)) 176 | 177 | (defun org-pdftools-parse-link (link) 178 | "Parse a pdf: `LINK'. 179 | Returns components of the path" 180 | (let ((link-regexp 181 | (concat "\\(.*\\)::\\([0-9]*\\)\\(\\+\\+\\)?\\([[0-9]\\.*[0-9]*\\)?\\(;;\\|" 182 | (regexp-quote org-pdftools-search-string-separator) 183 | "\\)?\\(.*\\)"))) 184 | (cond ((string-match link-regexp link) 185 | (let ((path (match-string 1 link)) 186 | (page (match-string 2 link)) 187 | (height (match-string 4 link)) 188 | annot-id 189 | search-string) 190 | (cond ((string-equal 191 | (match-string 5 link) 192 | ";;") 193 | (setq annot-id 194 | (match-string 6 link))) 195 | ((string-equal 196 | (match-string 5 link) 197 | org-pdftools-search-string-separator) 198 | (setq search-string 199 | (replace-regexp-in-string 200 | "%20" 201 | " " 202 | (match-string 6 link))))) 203 | (list :path path 204 | :page page 205 | :height height 206 | :annot-id annot-id 207 | :search-string search-string))) 208 | ((string-match 209 | "\\(.*\\)@@\\(.*\\)" 210 | link) 211 | (let* ((paths (match-string 1 link)) 212 | (occur-search-string (match-string 2 link)) 213 | (pathlist (split-string paths "%&%"))) 214 | (list :pathlist pathlist 215 | :occur-search-string occur-search-string))) 216 | (t 217 | (list :path link))))) 218 | 219 | ;; pdf://path::page++height_percent;;annot_id??isearch_string or @@occur_search_string 220 | (defun org-pdftools-open-pdftools (link) 221 | "Internal function to open org-pdftools LINK." 222 | (let ((pdf-link (org-pdftools-parse-link link))) 223 | (cond ((cl-getf pdf-link :path) 224 | (cl-destructuring-bind (&key path page height annot-id search-string) pdf-link 225 | (when (and path 226 | (not (string-empty-p path))) 227 | (if (bound-and-true-p org-noter--session) 228 | (org-noter--with-valid-session 229 | (let ((doc (with-selected-window 230 | (org-noter--get-doc-window) 231 | buffer-file-name)) 232 | (fullpath (funcall org-pdftools-path-resolver path))) 233 | (if (string-equal doc fullpath) 234 | (select-window 235 | (org-noter--get-doc-window)) 236 | (let ((org-link-frame-setup 237 | (cl-acons 'file 'find-file-other-frame org-link-frame-setup))) 238 | (org-open-file fullpath 1))))) 239 | (org-open-file (funcall org-pdftools-path-resolver path) 1))) 240 | (if (and page 241 | (not (string-empty-p page))) 242 | (progn 243 | (setq page (string-to-number page)) 244 | (if (bound-and-true-p org-noter--session) 245 | (org-noter--with-valid-session 246 | (with-selected-window 247 | (org-noter--get-doc-window) 248 | (pdf-view-goto-page page))) 249 | (pdf-view-goto-page page))) 250 | (setq page nil)) 251 | (when (and height 252 | (not (string-empty-p height))) 253 | (if (bound-and-true-p org-noter--session) 254 | (org-noter--with-valid-session 255 | (with-selected-window 256 | (org-noter--get-doc-window) 257 | (image-set-window-vscroll 258 | (round 259 | (/ 260 | (* 261 | (string-to-number height) 262 | (cdr (pdf-view-image-size))) 263 | (frame-char-height)))))) 264 | (image-set-window-vscroll 265 | (round 266 | (/ 267 | (* 268 | (string-to-number height) 269 | (cdr (pdf-view-image-size))) 270 | (frame-char-height)))))) 271 | (when (and annot-id 272 | (not (string-empty-p annot-id))) 273 | (if (bound-and-true-p org-noter--session) 274 | (org-noter--with-valid-session 275 | (with-selected-window 276 | (org-noter--get-doc-window) 277 | (pdf-annot-show-annotation 278 | (pdf-info-getannot annot-id) 279 | t))) 280 | (pdf-annot-show-annotation 281 | (pdf-info-getannot annot-id) 282 | t))) 283 | (when (and search-string 284 | (not (string-empty-p search-string))) 285 | (if (bound-and-true-p org-noter--session) 286 | (org-noter--with-valid-session 287 | (with-selected-window 288 | (org-noter--get-doc-window) 289 | (isearch-mode t) 290 | (let ((pdf-isearch-narrow-to-page t)) 291 | (isearch-yank-string search-string)))) 292 | (isearch-mode t) 293 | (let ((pdf-isearch-narrow-to-page t)) 294 | (isearch-yank-string search-string)))))) 295 | ((cl-getf pdf-link :pathlist) 296 | (pdf-occur-search 297 | pathlist 298 | occur-search-string)) 299 | (t (message "Invalid pdf link."))))) 300 | 301 | (defun org-pdftools-get-link () 302 | "Get link from the active pdf buffer." 303 | (let* ((path 304 | (with-current-buffer (current-buffer) 305 | (funcall org-pdftools-path-generator (buffer-file-name)))) 306 | (page (pdf-view-current-page)) 307 | (annot-id (if (pdf-view-active-region-p) 308 | (pdf-annot-get-id 309 | (funcall 310 | org-pdftools-markup-pointer-function 311 | (pdf-view-active-region) 312 | org-pdftools-markup-pointer-color 313 | `((opacity . ,org-pdftools-markup-pointer-opacity)))) 314 | (if (and (not (bound-and-true-p org-noter--session)) 315 | (pdf-annot-getannots page)) 316 | (condition-case nil 317 | (pdf-annot-get-id 318 | (pdf-annot-read-annotation 319 | "Click the annotation that you want to link to.")) 320 | (error 321 | (if org-pdftools-use-freepointer-annot 322 | (pdf-annot-get-id 323 | (funcall-interactively 324 | #'pdf-annot-add-text-annotation 325 | (pdf-util-read-image-position 326 | "Click where a new text annotation should be added ...") 327 | org-pdftools-free-pointer-icon 328 | `((color . ,org-pdftools-free-pointer-color) 329 | (opacity . ,org-pdftools-free-pointer-opacity)))) 330 | nil))) 331 | (if org-pdftools-use-freepointer-annot 332 | (pdf-annot-get-id 333 | (funcall-interactively 334 | #'pdf-annot-add-text-annotation 335 | (pdf-util-read-image-position 336 | "Click where a new text annotation should be added ...") 337 | org-pdftools-free-pointer-icon 338 | `((color . ,org-pdftools-free-pointer-color) 339 | (opacity . ,org-pdftools-free-pointer-opacity)))) 340 | nil)))) 341 | (height (cond ((bound-and-true-p annot-id) 342 | (nth 1 (pdf-annot-get 343 | (pdf-info-getannot 344 | annot-id 345 | path) 346 | 'edges))) 347 | (t 348 | (/ 349 | (* 350 | (or (image-mode-window-get 351 | 'vscroll) 352 | 0) 353 | (frame-char-height)) 354 | (float 355 | (cdr (pdf-view-image-size))))))) 356 | ;; pdf://path::page++height_percent;;annot_id\\|??search-string 357 | (search-string (if (and (not annot-id) 358 | org-pdftools-use-isearch-link) 359 | isearch-string 360 | "")) 361 | (link (concat 362 | 363 | org-pdftools-link-prefix ":" 364 | path 365 | "::" 366 | (number-to-string page) 367 | "++" 368 | (format "%.2f" height) 369 | (if annot-id 370 | (concat 371 | ";;" 372 | (symbol-name annot-id)) 373 | (if (not (string-empty-p search-string)) 374 | (concat 375 | org-pdftools-search-string-separator 376 | (replace-regexp-in-string 377 | " " 378 | "%20" 379 | search-string)) 380 | (message 381 | " Reminder: You haven't performed a isearch!") ""))))) 382 | link)) 383 | 384 | (defun org-pdftools-get-desc-default (file page &optional text) 385 | "Get description for newly createad pdf link. 386 | - `FILE': basename of the PDF file 387 | - `PAGE': current page number converted to string 388 | - `TEXT' (should have optional tag): additional text infomation like 389 | highlighted text or isearch string." 390 | (concat file ".pdf: Page " page (when text (concat "; Quoting: " text)))) 391 | 392 | ;;;###autoload 393 | (defun org-pdftools-open (link &optional arg) 394 | "Function to open org-pdftools LINK." 395 | (if (and (not arg) 396 | (display-graphic-p) 397 | (featurep 'pdf-tools)) 398 | (org-pdftools-open-pdftools 399 | link) 400 | (if (bound-and-true-p org-pdftools-open-custom-open) 401 | (funcall org-pdftools-open-custom-open link) 402 | (let ((pdf-link (org-pdftools-parse-link link))) 403 | (if (cl-getf pdf-link :occur-search-string) 404 | (message "Please install pdf-tools to open pdf-occur links") 405 | (org-open-file (cl-getf pdf-link :path))))))) 406 | 407 | ;;;###autoload 408 | (defun org-pdftools-store-link () 409 | "Store a link to a pdfview/pdfoccur buffer." 410 | (cond ((eq major-mode 'pdf-view-mode) 411 | ;; This buffer is in pdf-view-mode 412 | (let* ((file (file-name-base (pdf-view-buffer-file-name))) 413 | (quot (if (pdf-view-active-region-p) 414 | (replace-regexp-in-string "\n" " " 415 | (mapconcat 'identity (pdf-view-active-region-text) ? )))) 416 | (page (number-to-string (pdf-view-current-page))) 417 | (link (org-pdftools-get-link)) 418 | (isearchstr (if (string-match (concat ".*" (regexp-quote org-pdftools-search-string-separator) "\\(.*\\)") link) 419 | (match-string 1 link))) 420 | (desc (funcall org-pdftools-get-desc-function file page (or quot isearchstr)))) 421 | (org-link-store-props 422 | :type org-pdftools-link-prefix 423 | :link link 424 | :description desc))) 425 | ((eq major-mode 'pdf-occur-buffer-mode) 426 | (let* ((paths (mapconcat #'identity (mapcar #'car 427 | pdf-occur-search-documents) "%&%")) 428 | (occur-search-string pdf-occur-search-string) 429 | (link (concat org-pdftools-link-prefix ":" 430 | paths "@@" occur-search-string))) 431 | (org-link-store-props 432 | :type org-pdftools-link-prefix 433 | :link link 434 | :description (concat "Search: " occur-search-string)))))) 435 | 436 | ;;;###autoload 437 | (defun org-pdftools-export (link description format) 438 | "Export the pdfview LINK with DESCRIPTION for FORMAT from Org files." 439 | (let ((pdf-link (org-pdftools-parse-link link))) 440 | (cl-destructuring-bind (&key path page &allow-other-keys) pdf-link 441 | 442 | (unless description 443 | (setf description (file-name-nondirectory path))) 444 | 445 | ;; `org-export-file-uri` expands the filename correctly 446 | (setq path (org-export-file-uri (org-link-escape (funcall org-pdftools-path-exporter path)))) 447 | (cond ((eq format 'html) 448 | (format 449 | "%s" 450 | path 451 | page 452 | description)) 453 | ((or (eq format 'latex) (eql format 'beamer)) 454 | (format 455 | "\\href{%s}{%s}" 456 | path 457 | description)) 458 | ((eq format 'ascii) 459 | (format "%s (%s)" description path)) 460 | (t path))))) 461 | 462 | ;;;###autoload 463 | (defun org-pdftools-setup-link (&optional prefix) 464 | "Set up pdf links in `org-mode'. 465 | Optional argument PREFIX specifies link prefix. 466 | Default value is variable `org-pdftools-link-prefix' (pdf:)." 467 | (setq org-pdftools-prefix (or prefix org-pdftools-link-prefix)) 468 | (org-link-set-parameters org-pdftools-prefix 469 | :follow #'org-pdftools-open 470 | :complete #'org-pdftools-complete-link 471 | :store #'org-pdftools-store-link 472 | :export #'org-pdftools-export)) 473 | 474 | ;;;###autoload 475 | (defun org-pdftools-complete-link (&optional arg) 476 | "Use the existing file name completion for file. 477 | Links to get the file name, then ask the user for the page number 478 | and append it. ARG is passed to `org-link-complete-file'." 479 | (let* ((pdf-or-dir-p '(lambda (file-name) 480 | (string-match "/$\\|.pdf$" file-name))) 481 | ;; pdf-or-dir-p, a predicate returns t when file's path 482 | ;; is a directory or ends with .pdf. 483 | (current-read-file-name-function read-file-name-function) 484 | ;; Replace the `read-file-name-function' temporarily, 485 | ;; See its docstring for more. 486 | (read-file-name-function 487 | ;; This is the replacement, it's just a wrapper, it passes 488 | ;; the same argument to the old read file name function, one 489 | ;; difference is the PREDICATE arguement being our defined 490 | ;; pdf-or-dir-p. 491 | ;; Why?: So that `org-link-complete-file' only "show" pdf file 492 | ;; or directory. 493 | (lambda 494 | (prompt &optional dir default-filename mustmatch initial 495 | predicate) 496 | (funcall current-read-file-name-function 497 | prompt dir default-filename mustmatch initial 498 | pdf-or-dir-p)))) 499 | (concat 500 | (replace-regexp-in-string 501 | "^file:" 502 | (concat org-pdftools-link-prefix ":") 503 | (org-link-complete-file arg)) 504 | "::" 505 | (read-from-minibuffer 506 | "Page:" 507 | "1")))) 508 | 509 | (provide 'org-pdftools) 510 | ;;; org-pdftools.el ends here 511 | -------------------------------------------------------------------------------- /org-noter-pdftools.el: -------------------------------------------------------------------------------- 1 | ;;; org-noter-pdftools.el --- Integration between org-pdftools and org-noter 2 | ;; Copyright (C) 2020 Alexander Fu Xi 3 | 4 | ;; Author: Alexander Fu Xi 5 | ;; Maintainer: Alexander Fu Xi 6 | ;; Homepage: https://github.com/fuxialexander/org-pdftools 7 | ;; Version: 1.0 8 | ;; Keywords: convenience 9 | ;; Package-Requires: ((emacs "26.1") (org "9.4") (pdf-tools "0.8") (org-pdftools "1.0") (org-noter "1.4.1")) 10 | 11 | ;; This program is free software; you can redistribute it and/or modify 12 | ;; it under the terms of the GNU General Public License as published by 13 | ;; the Free Software Foundation, either version 3 of the License, or 14 | ;; (at your option) any later version. 15 | ;; 16 | ;; This program is distributed in the hope that it will be useful, 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 | ;; GNU General Public License for more details. 20 | ;; 21 | ;; You should have received a copy of the GNU General Public License 22 | ;; along with this program. If not, see . 23 | 24 | ;;; Commentary: 25 | ;; Add integration between org-pdftools and org-noter. 26 | 27 | 28 | ;;; Code: 29 | (require 'org-id) 30 | (require 'org-pdftools) 31 | (require 'org-noter) 32 | (require 'image-mode) 33 | 34 | (declare-function pdf-info-editannot "ext:pdf-info") 35 | (declare-function pdf-annot-add-text-annotation "ext:pdf-annot") 36 | (declare-function pdf-annot-get-id "ext:pdf-annot") 37 | 38 | (defcustom org-noter-pdftools-markup-pointer-function 'pdf-annot-add-highlight-markup-annotation 39 | "Color for markup pointer annotations. 40 | Can be one of highlight/underline/strikeout/squiggly." 41 | :group 'org-noter 42 | :type 'function) 43 | 44 | (defcustom org-noter-pdftools-path-generator #'abbreviate-file-name 45 | "Translate your PDF file path the way you like. Take buffer-file-name as the argument." 46 | :group 'org-pdftools 47 | :type 'function) 48 | 49 | (defcustom org-noter-pdftools-markup-pointer-color "#A9A9A9" 50 | "Color for markup pointer annotations." 51 | :group 'org-noter 52 | :type 'string) 53 | 54 | (defcustom org-noter-pdftools-markup-pointer-opacity 1.0 55 | "Color for markup pointer annotations." 56 | :group 'org-noter 57 | :type 'float) 58 | 59 | (defcustom org-noter-pdftools-free-pointer-icon "Circle" 60 | "Color for free pointer annotations. Refer to `pdf-annot-standard-text-icons`." 61 | :group 'org-noter 62 | :type 'string) 63 | 64 | (defcustom org-noter-pdftools-free-pointer-color "#FFFFFF" 65 | "Color for free pointer annotations." 66 | :group 'org-noter 67 | :type 'string) 68 | 69 | (defcustom org-noter-pdftools-free-pointer-opacity 1.0 70 | "Color for free pointer annotations." 71 | :group 'org-noter 72 | :type 'float) 73 | 74 | (defcustom org-noter-pdftools-use-pdftools-link-location t 75 | "When non-nil, org-pdftools link is used instead of location-cons when inserting notes." 76 | :group 'org-noter 77 | :type 'boolean) 78 | 79 | (defcustom org-noter-pdftools-use-org-id t 80 | "When non-nil, an org-id is generated for each heading for linking with PDF annotations and record entry parents." 81 | :group 'org-noter 82 | :type 'boolean) 83 | 84 | (defcustom org-noter-pdftools-export-to-pdf t 85 | "TODO: Whether you want to export the org notes to pdf annotation contents. 86 | To use this, `org-noter-pdftools-use-org-id' has to be t." 87 | :group 'org-noter 88 | :type 'boolean) 89 | 90 | (defcustom org-noter-pdftools-export-to-pdf-with-structure t 91 | "TODO: Whether you want to export the org notes to pdf annotation contents. 92 | To use this, `org-noter-pdftools-use-org-id' has to be t." 93 | :group 'org-noter 94 | :type 'boolean) 95 | 96 | (defcustom org-noter-pdftools-use-unique-org-id t 97 | "When non-nil, an org-id is generated for each heading for linking with PDF annotations and record entry parents." 98 | :group 'org-noter 99 | :type 'boolean) 100 | 101 | (defcustom org-noter-pdftools-insert-content-heading t 102 | "When non-nil, insert a \"Content\" heading above the content of an annotation (underline, highlight)" 103 | :group 'org-noter 104 | :type 'boolean) 105 | 106 | (defcustom org-noter-pdftools-insert-comment-heading t 107 | "When non-nil, insert a \"Content\" heading above the content of an annotation (underline, highlight)" 108 | :group 'org-noter 109 | :type 'boolean) 110 | 111 | (cl-defstruct org-noter-pdftools--location 112 | path page height annot-id search-string original-property) 113 | 114 | (defun org-noter-pdftools--location-link-p (location) 115 | "Check whether LOCATION is a org-pdftools link." 116 | (and location 117 | (stringp location) 118 | (or 119 | (string-prefix-p 120 | (concat "[[" org-pdftools-link-prefix ":") 121 | location) 122 | (string-prefix-p 123 | (concat org-pdftools-link-prefix ":") 124 | location)))) 125 | 126 | (defun org-noter-pdftools--location-cons-to-link (location) 127 | "Convert LOCATION cons to link." 128 | (cond ((consp location) 129 | (concat 130 | "::" 131 | (number-to-string 132 | (car location)) 133 | "++" 134 | (format "%.2f" (cadr location)))) 135 | ((integerp location) 136 | (concat 137 | "::" 138 | (number-to-string 139 | (car location)))))) 140 | 141 | (defun org-noter-pdftools--location-link-to-cons (location) 142 | "Convert a org-pdftools link to old LOCATION cons." 143 | (cons (org-noter-pdftools--location-page location) (or (org-noter-pdftools--location-height location) 0.0))) 144 | 145 | ;; -------------------------------------------------------------------------------- 146 | ;; NOTE(nox): Interface 147 | (defun org-noter-pdftools--check-link (property) 148 | "Interface for checking PROPERTY link." 149 | (org-noter-pdftools--location-link-p property)) 150 | 151 | (defun org-noter-pdftools--parse-link (property) 152 | "Interface for parse PROPERTY link." 153 | (when (org-noter-pdftools--location-link-p property) 154 | (setq property (string-trim property "\\[\\[" "\\]\\]")) 155 | (let ((link-regexp (concat "\\(.*\\)::\\([0-9]*\\)\\(\\+\\+\\)?\\([[0-9]\\.*[0-9]*\\)?\\(;;\\|" 156 | (regexp-quote org-pdftools-search-string-separator) 157 | "\\)?\\(.*\\)?"))) 158 | (string-match link-regexp property) 159 | (let ((path (match-string 1 property)) 160 | (page (match-string 2 property)) 161 | (height (match-string 4 property)) 162 | annot-id search-string) 163 | (condition-case nil 164 | (cond ((string-equal (match-string 5 property) ";;") 165 | (setq annot-id (match-string 6 property))) 166 | ((string-equal (match-string 5 property) org-pdftools-search-string-separator) 167 | (setq search-string (replace-regexp-in-string "%20" " " (match-string 6 property))))) 168 | (error nil)) 169 | (make-org-noter-pdftools--location 170 | :path path 171 | :page (and page (string-to-number page)) 172 | :height (and height (string-to-number height)) 173 | :annot-id annot-id 174 | :search-string search-string 175 | :original-property property))))) 176 | 177 | (defun org-noter-pdftools--pretty-print-location (location) 178 | "Function for print the LOCATION link." 179 | (org-noter--with-valid-session 180 | (if (memq (org-noter--session-doc-mode session) '(doc-view-mode pdf-view-mode)) 181 | (let ((loc (if (org-noter-pdftools--location-p location) 182 | location 183 | (org-noter-pdftools--parse-link location)))) 184 | (concat "[[" 185 | (org-noter-pdftools--location-original-property loc) 186 | "]]")) 187 | nil))) 188 | 189 | (defun org-noter-pdftools--convert-to-location-cons (location) 190 | "Function for converting the LOCATION link to cons." 191 | (if (and location (consp location)) 192 | location 193 | (let ((loc (if (org-noter-pdftools--location-p location) 194 | location 195 | (org-noter-pdftools--parse-link location)))) 196 | (org-noter-pdftools--location-link-to-cons loc)))) 197 | 198 | (defun org-noter-pdftools--doc-goto-location (mode location &optional _window) 199 | "Goto LOCATION in the corresponding MODE." 200 | (when (and (eq mode 'pdf-view-mode) (org-noter-pdftools--location-p location)) 201 | (when (org-noter-pdftools--location-page location) 202 | (pdf-view-goto-page (org-noter-pdftools--location-page location))) 203 | (when (org-noter-pdftools--location-height location) 204 | (image-set-window-vscroll 205 | (round (/ (* (org-noter-pdftools--location-height location) (cdr (pdf-view-image-size))) 206 | (frame-char-height))))) 207 | (when (org-noter-pdftools--location-annot-id location) 208 | (pdf-annot-show-annotation (pdf-info-getannot (org-noter-pdftools--location-annot-id location)) t)) 209 | (when (org-noter-pdftools--location-search-string location) 210 | (isearch-mode t) 211 | (isearch-yank-string (org-noter-pdftools--location-search-string location))) 212 | t)) 213 | 214 | (defun org-noter-pdftools--note-after-tipping-point (point location view) 215 | "Call `org-noter--note-after-tipping-point' relative to POINT based on LOCATION and VIEW." 216 | (when (org-noter-pdftools--location-p location) 217 | (cons t (org-noter--note-after-tipping-point point (org-noter-pdftools--location-link-to-cons location) view)))) 218 | 219 | (defun org-noter-pdftools--relative-position-to-view (location view) 220 | "Get relative position based on LOCATION and VIEW." 221 | (when (org-noter-pdftools--location-p location) 222 | (org-noter--relative-position-to-view (org-noter-pdftools--location-link-to-cons location) view))) 223 | 224 | (defun org-noter-pdftools--get-precise-info (mode &optional _window) 225 | "Get precise info from MODE." 226 | (when (eq mode 'pdf-view-mode) 227 | (let ((org-pdftools-free-pointer-icon org-noter-pdftools-free-pointer-icon) 228 | (org-pdftools-free-pointer-color org-noter-pdftools-free-pointer-color) 229 | (org-pdftools-free-pointer-opacity org-noter-pdftools-free-pointer-opacity) 230 | (org-pdftools-markup-pointer-color org-noter-pdftools-markup-pointer-color) 231 | (org-pdftools-markup-pointer-opacity org-noter-pdftools-markup-pointer-opacity) 232 | (org-pdftools-markup-pointer-function org-noter-pdftools-markup-pointer-function)) 233 | (org-noter-pdftools--parse-link (org-pdftools-get-link))))) 234 | 235 | (defun org-noter-pdftools--doc-approx-location (mode precise-info force-new-ref) 236 | "Get approximate location in MODE buffer based on PRECISE-INFO and FORCE-NEW-REF." 237 | (org-noter--with-valid-session 238 | (when (eq mode 'pdf-view-mode) 239 | (cond ((or (numberp precise-info) (not precise-info)) 240 | (org-noter-pdftools--parse-link 241 | (concat org-pdftools-link-prefix ":" (expand-file-name (org-noter--session-property-text session)) "::" 242 | (number-to-string (image-mode-window-get 'page)) 243 | (when precise-info (concat "++" (number-to-string precise-info)))))) 244 | ((org-noter-pdftools--location-p precise-info) precise-info) 245 | ((eq precise-info 'interactive) 246 | (when force-new-ref 247 | (setf (gv-deref force-new-ref) t)) 248 | (org-noter-pdftools--get-precise-info mode)) 249 | (t (error "Invalid pdftools precise-info case: %s" precise-info)))))) 250 | 251 | (defun org-noter-pdftools--insert-heading () 252 | "Insert heading in the `org-noter' org document." 253 | (let* ((location-property (org-entry-get nil org-noter-property-note-location))) 254 | (when location-property 255 | (if (string-suffix-p "]]" location-property) 256 | (setq location-property (substring location-property 0 -2))) 257 | (when (string-match ".*;;\\(.*\\)" location-property) 258 | (org-noter--with-valid-session 259 | (let ((id (match-string 1 location-property))) 260 | (if org-noter-pdftools-use-org-id 261 | (org-entry-put nil "ID" 262 | (if org-noter-pdftools-use-unique-org-id 263 | (concat 264 | (org-noter--session-property-text session) 265 | "-" 266 | id) 267 | id))))))))) 268 | 269 | (dolist (pair '((org-noter--check-location-property-hook . org-noter-pdftools--check-link) 270 | (org-noter--parse-location-property-hook . org-noter-pdftools--parse-link) 271 | (org-noter--pretty-print-location-hook . org-noter-pdftools--pretty-print-location) 272 | (org-noter--convert-to-location-cons-hook . org-noter-pdftools--convert-to-location-cons) 273 | (org-noter--doc-goto-location-hook . org-noter-pdftools--doc-goto-location) 274 | (org-noter--note-after-tipping-point-hook . org-noter-pdftools--note-after-tipping-point) 275 | (org-noter--relative-position-to-view-hook . org-noter-pdftools--relative-position-to-view) 276 | (org-noter--get-precise-info-hook . org-noter-pdftools--get-precise-info) 277 | (org-noter--doc-approx-location-hook . org-noter-pdftools--doc-approx-location) 278 | (org-noter-insert-heading-hook . org-noter-pdftools--insert-heading))) 279 | (add-hook (car pair) (cdr pair))) 280 | 281 | ;; -------------------------------------------------------------------------------- 282 | ;; NOTE(nox): User commands 283 | (defun org-noter-pdftools-convert-old-org-heading () 284 | "Covert an old org heading to a new one for compatiblility." 285 | (interactive) 286 | (org-noter--with-valid-session 287 | (cond ((eq (org-noter--session-doc-mode 288 | session) 289 | 'pdf-view-mode) 290 | (let* ((document-property (org-noter--session-property-text 291 | session))) 292 | (let* ((location (org-noter--parse-location-property 293 | (org-entry-get 294 | nil 295 | org-noter-property-note-location))) 296 | (path document-property) 297 | (page (if (consp location) 298 | (car location) 299 | location)) 300 | (height (if (consp location) 301 | (cadr location) 302 | 0.0)) 303 | (pos `(0 . ,(round 304 | (* 305 | (cdr (with-current-buffer 306 | (org-noter--session-doc-buffer 307 | session) 308 | (pdf-view-image-size))) 309 | height)))) 310 | (annot-id (symbol-name 311 | (pdf-annot-get-id 312 | (save-excursion 313 | (with-selected-window 314 | (org-noter--get-doc-window) 315 | (pdf-view-goto-page page) 316 | (funcall-interactively 317 | #'pdf-annot-add-text-annotation 318 | pos 319 | org-pdftools-free-pointer-icon 320 | `((color . ,org-pdftools-free-pointer-color) 321 | (opacity . ,org-pdftools-free-pointer-opacity))))))))) 322 | (org-entry-put 323 | nil 324 | org-noter-property-note-location 325 | (concat 326 | "[[" 327 | org-pdftools-link-prefix 328 | ":" 329 | path 330 | (org-noter-pdftools--location-cons-to-link 331 | location) 332 | ";;" 333 | annot-id 334 | "]]")) 335 | (when org-noter-pdftools-use-org-id 336 | (org-entry-put 337 | nil 338 | "ID" 339 | (if org-noter-pdftools-use-unique-org-id 340 | (concat 341 | document-property 342 | "-" 343 | annot-id) 344 | annot-id))) 345 | (when org-noter-pdftools-export-to-pdf 346 | (let* ((content (if (and (> (org-current-level) 2) 347 | org-noter-pdftools-export-to-pdf-with-structure) 348 | (let ((parent-id (save-excursion 349 | (org-up-heading-safe) 350 | (org-id-get)))) 351 | (if parent-id 352 | (concat 353 | "#+PROPERTY: PARENT " 354 | parent-id 355 | "\n" 356 | (save-excursion 357 | (org-back-to-heading nil) 358 | (buffer-substring-no-properties 359 | (point) 360 | (org-end-of-subtree nil t)))))) 361 | (save-excursion 362 | (org-back-to-heading nil) 363 | (buffer-substring-no-properties 364 | (point) 365 | (org-end-of-subtree nil t)))))) 366 | (with-selected-window 367 | (org-noter--get-doc-window) 368 | (pdf-info-editannot 369 | (intern annot-id) 370 | `((contents . ,content))))))))) 371 | (t 372 | (error 373 | "This command is only supported on PDF Tools"))))) 374 | 375 | (defun org-noter-pdftools-convert-old-notes () 376 | "Convert old notes (location cons based) to new format (link based)." 377 | (interactive) 378 | (org-noter--with-valid-session 379 | (goto-char (point-min)) 380 | (when (org-before-first-heading-p) 381 | (org-next-visible-heading 1)) 382 | (while (not (eq (point) (point-max))) 383 | (org-next-visible-heading 1) 384 | (goto-char (point-at-eol)) 385 | (let ((prop (org-entry-get 386 | nil 387 | org-noter-property-note-location))) 388 | (if (and prop 389 | (not (string-prefix-p 390 | org-pdftools-link-prefix ":" 391 | prop))) 392 | (call-interactively 393 | #'org-noter-pdftools-convert-old-org-heading)))))) 394 | 395 | (defun org-noter-pdftools-jump-to-note (a) 396 | "Jump from a PDF annotation A to the corresponding org heading." 397 | (interactive (list 398 | (with-selected-window 399 | (org-noter--get-doc-window) 400 | (pdf-annot-read-annotation 401 | "Left click the annotation ")))) 402 | (unless org-noter-pdftools-use-org-id 403 | "You have to enable `org-noter-pdftools-use-org-id'!") 404 | (org-noter--with-valid-session 405 | (pdf-annot-show-annotation a t) 406 | (let ((id (symbol-name 407 | (pdf-annot-get-id a)))) 408 | (select-window 409 | (org-noter--get-notes-window)) 410 | (let ((exist-id (org-id-find-id-in-file 411 | (if org-noter-pdftools-use-unique-org-id 412 | (concat (org-noter--session-property-text session) "-" id) 413 | id) 414 | buffer-file-name))) 415 | (if exist-id (goto-char (cdr exist-id)) 416 | nil))))) 417 | 418 | ;; TODO(nox): Implement interface for skeleton creation 419 | (defun org-noter-pdftools-create-skeleton () 420 | "Create notes skeleton with the PDF outline or annotations. 421 | Only available with PDF Tools." 422 | (interactive) 423 | (org-noter--with-valid-session 424 | (cond 425 | ((eq (org-noter--session-doc-mode session) 'pdf-view-mode) 426 | (let* ((ast (org-noter--parse-root)) 427 | (top-level (org-element-property :level ast)) 428 | (options '(("Outline" . (outline)) 429 | ("Annotations" . (annots)) 430 | ("Both" . (outline annots)))) 431 | answer output-data) 432 | (with-current-buffer (org-noter--session-doc-buffer session) 433 | (setq answer (assoc (completing-read "What do you want to import? " options nil t) options)) 434 | 435 | (when (memq 'outline answer) 436 | (dolist (item (pdf-info-outline)) 437 | (let ((type (alist-get 'type item)) 438 | (page (alist-get 'page item)) 439 | (depth (alist-get 'depth item)) 440 | (title (alist-get 'title item)) 441 | (top (alist-get 'top item)) 442 | pdftools-link path) 443 | (when (and (eq type 'goto-dest) 444 | (> page 0)) 445 | (when org-noter-pdftools-use-pdftools-link-location 446 | (setq path 447 | (funcall org-noter-pdftools-path-generator (buffer-file-name))) 448 | (if title 449 | (setq pdftools-link 450 | (concat 451 | org-pdftools-link-prefix ":" 452 | path 453 | "::" 454 | (number-to-string page) 455 | "++" 456 | (if top 457 | (number-to-string top) 458 | "0") 459 | org-pdftools-search-string-separator 460 | (replace-regexp-in-string 461 | " " 462 | "%20" 463 | title))) 464 | (setq pdftools-link 465 | (concat 466 | org-pdftools-link-prefix ":" 467 | path 468 | "::" 469 | (number-to-string page) 470 | "++" 471 | (number-to-string top))))) 472 | (push 473 | (vector 474 | title 475 | (if org-noter-pdftools-use-pdftools-link-location pdftools-link 476 | (cons page top)) 477 | (1+ depth) 478 | nil) 479 | output-data))))) 480 | 481 | (when (memq 'annots answer) 482 | (let ((possible-annots (list '("Highlights" . highlight) 483 | '("Underlines" . underline) 484 | '("Squigglies" . squiggly) 485 | '("Text notes" . text) 486 | '("Strikeouts" . strike-out) 487 | '("Links" . link) 488 | '("ALL" . all))) 489 | chosen-annots insert-contents pages-with-links) 490 | (while (> (length possible-annots) 1) 491 | (let* ((chosen-string (completing-read "Which types of annotations do you want? " 492 | possible-annots nil t)) 493 | (chosen-pair (assoc chosen-string possible-annots))) 494 | (cond ((eq (cdr chosen-pair) 'all) 495 | (dolist (annot possible-annots) 496 | (when (and (cdr annot) (not (eq (cdr annot) 'all))) 497 | (push (cdr annot) chosen-annots))) 498 | (setq possible-annots nil)) 499 | ((cdr chosen-pair) 500 | (push (cdr chosen-pair) chosen-annots) 501 | (setq possible-annots (delq chosen-pair possible-annots)) 502 | (when (= 1 (length chosen-annots)) (push '("DONE") possible-annots))) 503 | (t 504 | (setq possible-annots nil))))) 505 | 506 | (setq insert-contents (y-or-n-p "Should we insert the annotations contents? ")) 507 | 508 | (dolist (item (pdf-info-getannots)) 509 | (let* ((type (alist-get 'type item)) 510 | (page (alist-get 'page item)) 511 | (edges (or (org-noter--pdf-tools-edges-to-region (alist-get 'markup-edges item)) 512 | (alist-get 'edges item))) 513 | (top (nth 1 edges)) 514 | (item-subject (alist-get 'subject item)) 515 | (item-contents (alist-get 'contents item)) 516 | (id (symbol-name (alist-get 'id item))) 517 | name contents pdftools-link path) 518 | (when org-noter-pdftools-use-pdftools-link-location 519 | (setq path (funcall org-noter-pdftools-path-generator (buffer-file-name))) 520 | (setq pdftools-link (concat org-pdftools-link-prefix ":" path "::" 521 | (number-to-string page) "++" 522 | (number-to-string top) ";;" 523 | id))) 524 | 525 | (when (and (memq type chosen-annots) (> page 0)) 526 | (if (eq type 'link) 527 | (cl-pushnew page pages-with-links) 528 | (setq name (cond ((eq type 'highlight) "Highlight") 529 | ((eq type 'underline) "Underline") 530 | ((eq type 'squiggly) "Squiggly") 531 | ((eq type 'text) "Text note") 532 | ((eq type 'strike-out) "Strikeout"))) 533 | 534 | (when insert-contents 535 | (setq contents (cons (pdf-info-gettext page edges) 536 | (and (or (and item-subject (> (length item-subject) 0)) 537 | (and item-contents (> (length item-contents) 0))) 538 | (concat (or item-subject "") 539 | (if (and item-subject item-contents) "\n" "") 540 | (or item-contents "")))))) 541 | 542 | (push (vector (format "%s on page %d" name page) (if org-noter-pdftools-use-pdftools-link-location 543 | pdftools-link 544 | (cons page top)) 'inside contents) 545 | output-data))))) 546 | 547 | (dolist (page pages-with-links) 548 | (let ((links (pdf-info-pagelinks page)) 549 | type) 550 | (dolist (link links) 551 | (setq type (alist-get 'type link)) 552 | (unless (eq type 'goto-dest) ;; NOTE(nox): Ignore internal links 553 | (let* ((edges (alist-get 'edges link)) 554 | (title (alist-get 'title link)) 555 | (top (nth 1 edges)) 556 | (target-page (alist-get 'page link)) 557 | target heading-text pdftools-link path) 558 | (when org-noter-pdftools-use-pdftools-link-location 559 | (setq path 560 | (funcall org-noter-pdftools-path-generator (buffer-file-name))) 561 | (setq pdftools-link (concat org-pdftools-link-prefix ":" path "::" 562 | (number-to-string page) "++" 563 | (number-to-string top)))) 564 | (unless (and title (> (length title) 0)) (setq title (pdf-info-gettext page edges))) 565 | 566 | (cond 567 | ((eq type 'uri) 568 | (setq target (alist-get 'uri link) 569 | heading-text (format "Link on page %d: [[%s][%s]]" page target title))) 570 | 571 | ((eq type 'goto-remote) 572 | (setq target (concat "file:" (alist-get 'filename link)) 573 | heading-text (format "Link to document on page %d: [[%s][%s]]" page target title)) 574 | (when target-page 575 | (setq heading-text (concat heading-text (format " (target page: %d)" target-page))))) 576 | 577 | (t (error "Unexpected link type"))) 578 | 579 | (push 580 | (vector 581 | heading-text 582 | (if org-noter-pdftools-use-pdftools-link-location 583 | pdftools-link 584 | (cons page top)) 585 | 'inside 586 | nil) 587 | output-data)))))))) 588 | 589 | 590 | (when output-data 591 | (if (memq 'annots answer) 592 | (setq output-data 593 | (sort output-data 594 | (lambda (e1 e2) 595 | (or (not (aref e1 1)) 596 | (and (aref e2 1) 597 | (org-noter--compare-locations '< (aref e1 1) (aref e2 1))))))) 598 | (setq output-data (nreverse output-data))) 599 | 600 | (push (vector "Skeleton" nil 1 nil) output-data))) 601 | 602 | (with-current-buffer (org-noter--session-notes-buffer session) 603 | ;; NOTE(nox): org-with-wide-buffer can't be used because we want to reset the 604 | ;; narrow region to include the new headings 605 | (widen) 606 | (save-excursion 607 | (goto-char (org-element-property :end ast)) 608 | 609 | (let (last-absolute-level 610 | title location relative-level contents 611 | level) 612 | (dolist (data output-data) 613 | (setq title (aref data 0) 614 | location (aref data 1) 615 | relative-level (aref data 2) 616 | contents (aref data 3)) 617 | 618 | (if (symbolp relative-level) 619 | (setq level (1+ last-absolute-level)) 620 | (setq last-absolute-level (+ top-level relative-level) 621 | level last-absolute-level)) 622 | 623 | (org-noter--insert-heading level title nil location) 624 | 625 | (when (car contents) 626 | (when org-noter-pdftools-insert-content-heading 627 | (org-noter--insert-heading (1+ level) "Contents")) 628 | (insert (car contents))) 629 | (when (cdr contents) 630 | (when org-noter-pdftools-insert-comment-heading 631 | (org-noter--insert-heading (1+ level) "Comment")) 632 | (insert (cdr contents))))) 633 | 634 | (setq ast (org-noter--parse-root)) 635 | (org-noter--narrow-to-root ast) 636 | (goto-char (org-element-property :begin ast)) 637 | (outline-hide-subtree) 638 | (org-show-children 2))))) 639 | 640 | (t (error "This command is only supported on PDF Tools"))))) 641 | 642 | (defun org-noter-pdftools-embed-org-note-to-pdf () 643 | "Embed a org subtree to its corresponding PDF annotation." 644 | (interactive) 645 | (org-noter--with-valid-session 646 | (unless (equal (selected-window) (org-noter--get-notes-window)) 647 | (error "You should use this command in an org-noter note buffer")) 648 | (let* ((org-id (org-id-get))) 649 | (unless (and (string-match ".*\\(annot-.*-.*\\)" org-id) 650 | org-noter-pdftools-use-org-id 651 | org-noter-pdftools-use-pdftools-link-location) 652 | (error "This can only be run on an org heading with a valid org-pdftools annotation ID. 653 | Please also make sure `org-noter-pdftools-use-org-id' and `org-noter-pdftools-use-pdftools-link-location' are enabled")) 654 | (let* ((annot-id (match-string 1 org-id)) 655 | note) 656 | (setq kr kill-ring) 657 | (org-copy-subtree nil nil nil t) 658 | (setq note (car kill-ring)) 659 | (setq kill-ring kr) 660 | (with-selected-window 661 | (org-noter--get-doc-window) 662 | (let ((annot (pdf-annot-getannot (intern annot-id)))) 663 | (with-current-buffer (pdf-annot-edit-contents-noselect annot) 664 | (insert note) 665 | (pdf-annot-edit-contents-finalize t))) 666 | (save-buffer)))))) 667 | (defun org-noter-pdftools-embed-all-org-note-to-pdf () 668 | (interactive) 669 | (org-noter--with-valid-session 670 | (with-selected-window (org-noter--get-notes-window) 671 | (save-excursion 672 | (org-map-entries #'org-noter-pdftools-embed-org-note-to-pdf "ID={annot-}"))))) 673 | (defun org-noter-pdftools-embed-org-buffer-to-pdf () 674 | "Embed the whole org-noter doc buffer to a PDF annotation." 675 | (interactive) 676 | (org-noter--with-valid-session 677 | (let* ((note (with-selected-window (org-noter--get-notes-window) 678 | (save-excursion 679 | (buffer-substring-no-properties 680 | (point-min) (point-max))))) 681 | annot-id) 682 | (with-selected-window 683 | (org-noter--get-doc-window) 684 | (save-excursion 685 | (pdf-view-goto-page 1) 686 | (setq annot-id 687 | (pdf-annot-get-id 688 | (let ((annot (ignore-errors (pdf-annot-at-position '(0 . 0))))) 689 | (if annot 690 | annot 691 | (funcall-interactively 692 | #'pdf-annot-add-text-annotation 693 | '(0 . 0) 694 | org-pdftools-free-pointer-icon 695 | `((color . ,org-pdftools-free-pointer-color) 696 | (opacity . ,org-pdftools-free-pointer-opacity)))))))) 697 | (with-selected-window 698 | (org-noter--get-doc-window) 699 | (let ((annot (pdf-annot-getannot annot-id))) 700 | (with-current-buffer (pdf-annot-edit-contents-noselect annot) 701 | (insert note) 702 | (pdf-annot-edit-contents-finalize t))) 703 | (save-buffer)))))) 704 | 705 | (provide 'org-noter-pdftools) 706 | 707 | ;;; org-noter-pdftools.el ends here 708 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------