├── README.md ├── zotra.el └── LICENSE /README.md: -------------------------------------------------------------------------------- 1 | # Zotra 2 | 3 | [![MELPA](https://melpa.org/packages/zotra-badge.svg)](https://melpa.org/#/zotra) 4 | 5 | This emacs library provides functions to fetch bibliographic information in different formats (e.g. bibtex) using website urls or search identifiers (e.g. DOI). 6 | It also provides functions to fetch attachments (e.g. PDF files) associated with a url. 7 | 8 | This is done using [**ZO**tero **TRA**nslators](https://www.zotero.org/support/translators), but without using the Zotero client. 9 | 10 | 11 | ## Changelog 12 | 13 | - [2023-10-14 Thu]: The `zotra-server` backend added. 14 | - [2023-09-30 Thu]: The `citoid` backend added. 15 | - [2023-09-30 Thu]: The functions `zotra-add-entry-from-url`, `zotra-add-entry-from-search`, `zotra-download-attachment-from-url` and `zotra-download-attachment-from-search` are obsolete. Use `zotra-add-entry` and `zotra-download-attachment` instead. 16 | - [2023-09-30 Thu]: The `curl_translation-server` backend removed. Use the variable `zotra-use-curl` instead. 17 | - [2023-09-21 Thu]: Better integration with bibtex-completion. Also the variables `zotra-download-attachment-default-directory` and `zotra-default-bibliography` can now be lists. 18 | - [2023-08-18 Fri]: The variable `zotra-after-add-entry-hook` is now obsolete; use `zotra-after-get-bibtex-entry-hook` instead. 19 | - [2023-07-23 Sun]: Some internal functions have changed. `zotra-url-cleanup-functions` is renamed to `zotra-url-redirect-functions`. 20 | - [2023-01-27 Fri]: `zotra-cli-command` now takes a list of strings instead of a single string. 21 | 22 | ## Instalation 23 | 24 | ### Zotra 25 | 26 | The prefered instllation method is from MELPA. 27 | 28 | Alternatively, you can clone the repository and add the following line to your init file. 29 | 30 | ``` emacs-lisp 31 | (add-to-list 'load-path "/path/to/zotra") 32 | (require 'zotra) 33 | ``` 34 | 35 | ### Backend 36 | 37 | This library tries to connect to a backend to do the translation. 38 | The choice of backend can be customized through `zotra-backend` variable. 39 | 40 | There are 4 options for `zotra-backend`: 41 | 42 | - `citoid` 43 | 44 | Use the Wikimedia Citoid public API. 45 | See [here](https://en.wikipedia.org/api/rest_v1/#/Citation/getCitation) for terms of service and documentation. 46 | This is the default backend since it only uses a public API and does not require any extra installations. 47 | However, this backend is more limited than the other options. 48 | 49 | - `zotra-server` 50 | 51 | Use a remote or local instance of [Zotra server](https://github.com/mpedramfar/zotra-server). 52 | This is the recommended backend to use as **it is able to fetch attachments**. 53 | See [Zotra server](https://github.com/mpedramfar/zotra-server) for instructions on how to install locally. 54 | If you have have installed an instance of the server, you may instruct Zotra to run the server locally by setting the variable `zotra-local-server-directory` to the local git directory containing the sever. 55 | Set this variable to nil if you want to start the server externally or if you are connecting to a remote server. 56 | The path of the server is specified by `zotra-server-path`. 57 | If you have used the default settings to install Zotra server, you only need to add the following lines to your init file: 58 | ```emacs-lisp 59 | (setq zotra-backend 'zotra-server) 60 | (setq zotra-local-server-directory "/path/to/zotra-server/") 61 | ``` 62 | 63 | - `translation-server` 64 | 65 | Use a remote or local instance of [Zotero translation server](https://github.com/zotero/translation-server/). 66 | See [Zotero translation server](https://github.com/zotero/translation-server/) for instructions on how to install locally. 67 | If you have have installed an instance of the server, you may instruct Zotra to run the server locally by setting the variable `zotra-local-server-directory` to the local git directory containing the sever. 68 | Set this variable to nil if you want to start the server externally or if you are connecting to a remote server. 69 | The path of the server is specified by `zotra-server-path`. 70 | If you have used the default settings to install Zotra server, you only need to add the following lines to your init file: 71 | ```emacs-lisp 72 | (setq zotra-backend 'translation-server) 73 | (setq zotra-local-server-directory "/path/to/translation-server/") 74 | ``` 75 | 76 | - `zotra-cli` (**This backend is obsolete**) 77 | 78 | Use the [Zotra sever](https://github.com/mpedramfar/zotra-server) library, as a command-line tool. 79 | This backend is also able to fetch attachments. 80 | However, it is significantly slower than `zotra-server` backend and **will be removed in the future**. 81 | See [Zotra server](https://github.com/mpedramfar/zotra-server) repository for its installation guide. 82 | Note that if Zotra server is not installed globally (i.e. the `zotra` command is not available from your shell), then you can customize `zotra-cli-command` to point at the installed library: 83 | ```emacs-lisp 84 | (setq zotra-backend 'zotra-cli) 85 | (setq zotra-cli-command '("node" "/path/to/zotra-server/bin/index.js")) 86 | ``` 87 | 88 | 89 | If you have the external curl program, it is recommended to set `zotra-use-curl` to `t` to use curl instead. 90 | This option affects all backends except `zotra-cli`. 91 | 92 | ## Usage and configuration 93 | 94 | From inside emacs, run `zotra-add-entry`, then enter the url or the search identifier (DOI, ISBN, PMID, arXiv ID) and choose the bibtex file to save into. 95 | To download attachments from a url or search identifier, run `zotra-download-attachment`. 96 | 97 | See `zotra` customization group for a complete list of options and their description. 98 | 99 | ### Using Zotra with a browser and org-protocol 100 | 101 | First you need to set up [org-protocol](https://orgmode.org/worg/org-contrib/org-protocol.html). [This section](https://www.orgroam.com/manual.html#Installation-_00281_0029) of the `org-roam` manual describes how to set it up on Linux, macOS, and Windows. 102 | 103 | Then make a bookmark in your browser with the following url: 104 | ``` 105 | javascript:location.href=('org-protocol://zotra?url='+ encodeURIComponent(location.href)+'&bibfile='+encodeURIComponent('/path/to/bibfile.bib')+'&format=my-save-format').replace(/'/gi,"%27") 106 | ``` 107 | where `/path/to/bibfile.bib` should be replaced with the path to the bibfile and `my-save-format` should be replaced with one of the acceptable formats listed in the description of `zotra-default-entry-format`. 108 | 109 | You can omit format and bibfile to use the value of `zotra-default-entry-format` and `zotra-default-bibliography` respectively: 110 | ``` 111 | javascript:location.href=('org-protocol://zotra?url='+ encodeURIComponent(location.href)).replace(/'/gi,"%27") 112 | ``` 113 | Now you can click on the bookmark in any page and the bibliographic information of the page will be saved into emacs automatically. 114 | 115 | ### Using Zotra with [bibtex-completion](https://github.com/tmalsburg/helm-bibtex/) 116 | 117 | Add the following line to your init file. 118 | ```emacs-lisp 119 | (with-eval-after-load "bibtex-completion" 120 | (zotra-bibtex-completion)) 121 | ``` 122 | By adding this, Zotra will add a fallback options to `bibtex-completion-fallback-options`. 123 | It will also add the option to download with Zotra when calling `bibtex-completion-add-pdf-to-library`. 124 | 125 | You can also set `zotra-download-attachment-default-directory` to one (or more) of the values in `bibtex-completion-library-path` and `zotra-default-bibliography` to one (or more) of the values in `bibtex-completion-bibliography`, for example: 126 | ```emacs-lisp 127 | (setq zotra-download-attachment-default-directory bibtex-completion-library-path) 128 | (setq zotra-default-bibliography bibtex-completion-bibliography) 129 | ``` 130 | Note that bibtex-completion can work with bibtex, biblatex and org-bibtex bibliography files, while Zotra can work with formats listed in the description of `zotra-default-entry-format`. 131 | In particular, org-bibtex is not supported in Zotra, so you can't set `zotra-download-attachment-default-directory` equal to `bibtex-completion-library-path` if it contains org-bibtex items. 132 | 133 | ### Using Zotra with [org-ref](https://github.com/jkitchin/org-ref) 134 | 135 | The functions in `zotra-after-get-bibtex-entry-hook` are called before a bibtex/biblatex entry is added. 136 | They take no arguments, and they can be used to cleanup and format new entries. 137 | For example, if you are using org-ref, you could add this line to your init file: 138 | ```emacs-lisp 139 | (add-hook 'zotra-after-get-bibtex-entry-hook 'org-ref-clean-bibtex-entry) 140 | ``` 141 | Note that org-ref depends on bibtex-completion. 142 | 143 | ### Automatically download attachment after adding a bibtex entry 144 | 145 | When the point is at a bibtex entry, the following function downloads the attachment for it and adds the filename to a bibtex field named "File". 146 | ```emacs-lisp 147 | (defun zotra-download-attachment-for-current-entry () 148 | (interactive) 149 | (save-excursion 150 | (bibtex-beginning-of-entry) 151 | (let* ((entry (bibtex-parse-entry t)) 152 | (key (cdr (assoc "=key=" entry))) 153 | (url (cdr (assoc "url" entry))) 154 | (filename (concat key ".pdf")) 155 | (filename (when entry 156 | (zotra-download-attachment 157 | url nil filename)))) 158 | (when filename 159 | (bibtex-make-field (list "File" nil filename) t))))) 160 | ``` 161 | 162 | This function can be added to `zotra-after-get-bibtex-entry-hook`. 163 | *Note that this function chooses the bibtex key as the filename so it should be after any hook that might change the bibtex key.* 164 | When it is added to this hook, any time a bibtex entry is added, its attachments will also be downloaded. 165 | Alternatively, you can add the following function to your init file to add an entry from url and download its attachments. 166 | 167 | ```emacs-lisp 168 | (defun zotra-add-entry-and-download-attachment (&optional url) 169 | (interactive) 170 | (let ((zotra-after-get-bibtex-entry-hook 171 | (append zotra-after-get-bibtex-entry-hook 172 | '(zotra-download-attachment-for-current-entry)))) 173 | (zotra-add-entry url))) 174 | ``` 175 | -------------------------------------------------------------------------------- /zotra.el: -------------------------------------------------------------------------------- 1 | ;;; zotra.el --- Import bibliographic data from (almost) everywhere -*- lexical-binding: t; -*- 2 | 3 | 4 | ;; Author: Mohammad Pedramfar 5 | ;; Version: 1.0 6 | ;; Package-Requires: ((emacs "27.1")) 7 | ;; URL: https://github.com/mpedramfar/zotra 8 | 9 | 10 | ;; This program is free software; you can redistribute it and/or modify 11 | ;; it under the terms of the GNU General Public License as published by 12 | ;; the Free Software Foundation, either version 3 of the License, or 13 | ;; (at your option) any later version. 14 | 15 | ;; This program is distributed in the hope that it will be useful, 16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 | ;; GNU General Public License for more details. 19 | 20 | ;; You should have received a copy of the GNU General Public License 21 | ;; along with this program. If not, see . 22 | 23 | ;;; Commentary: 24 | 25 | ;; This library provides functions to fetch bibliographic information 26 | ;; in different formats (e.g. bibtex) using website urls or search 27 | ;; identifiers (e.g. DOI). It also provides functions to fetch 28 | ;; attachments (e.g. PDF files) associated with a url. 29 | ;; 30 | ;; This is done using ZOtero TRAnslators, but without using the Zotero client. 31 | ;; 32 | ;; 33 | ;; See the README.md file for details. 34 | 35 | 36 | ;;; Code: 37 | (require 'url) 38 | (require 'org-element) 39 | (require 'org-protocol) 40 | (require 'bibtex) 41 | 42 | 43 | (defgroup zotra nil 44 | "Customization group for Zotra." 45 | :group 'editing) 46 | 47 | 48 | (defcustom zotra-default-bibliography 49 | nil 50 | "Default bibliography file or list of files. 51 | 52 | If this variable contains a single file, interactive calls to 53 | `zotra-add-entry' will not ask the user for the bibfile. 54 | Otherwise, Zotra will ask the user to choose one." 55 | :group 'zotra 56 | :type '(choice file (repeat file))) 57 | 58 | 59 | (defcustom zotra-url-redirect-functions 60 | '(zotra-url-redirect--arxiv) 61 | "Currently, the Zotero translation server can't handle links to attachments. 62 | \(See https://github.com/zotero/translation-server/issues/70\). 63 | These functions provide a way to fix the issue by manually changing the link to 64 | an attachment to a link to the url for the article. 65 | Each function in this list should take a url and return a url. If the function 66 | is not applicable, it should return its input without change." 67 | :group 'zotra 68 | :type 'hook) 69 | 70 | 71 | (define-obsolete-variable-alias 72 | 'zotra-after-add-entry-hook 'zotra-after-get-bibtex-entry-hook 73 | "[2023-08-18 Fri]") 74 | 75 | (defcustom zotra-after-get-bibtex-entry-hook 76 | '(bibtex-clean-entry) 77 | "These functions are called after `zotra-get-entry'. 78 | They take no arguments, and they can be used to cleanup and format new entries. 79 | 80 | These hooks are run only if ENTRY-FORMAT is \"bibtex\" or \"biblatex\"." 81 | :group 'zotra 82 | :type 'hook) 83 | 84 | 85 | (defcustom zotra-backend 86 | 'citoid 87 | "Backend used by Zotra. 88 | CITOID: The Wikimedia Citoid server. 89 | ZOTRA-SERVER: An instance of the Zotra server. 90 | TRANSLATION-SERVER: An instance of the Zotero translation server. 91 | ZOTRA-CLI: Zotra server used as a command-line program." 92 | :group 'zotra 93 | :type '(choice 94 | (const citoid) 95 | (const zotra-server) 96 | (const translation-server) 97 | (const zotra-cli))) 98 | 99 | 100 | (defcustom zotra-server-path 101 | "http://127.0.0.1:1969" 102 | "The url and the port of the Zotero translation server to be used. 103 | This variable should not end in a trailing slash mark. 104 | This is only relevant when `zotra-backend' is translation-server 105 | or zotra-server." 106 | :group 'zotra 107 | :type 'string) 108 | 109 | 110 | (defcustom zotra-local-server-directory 111 | nil 112 | "The directory of the local server. 113 | When this variable is non-nil, Zotra will attempt to start the 114 | server. Set this variable to nil if you are using a remote server 115 | or if you want to run the server yourself. 116 | This is only relevant when `zotra-backend' is translation-server 117 | or zotra-server." 118 | :group 'zotra 119 | :type '(choice (const nil) directory)) 120 | 121 | 122 | (defcustom zotra-use-curl 123 | nil 124 | "Use the external curl program. 125 | This is only relevant when `zotra-backend' is either citoid, 126 | translation-server or zotra-server." 127 | :group 'zotra 128 | :type 'string) 129 | 130 | 131 | (defcustom zotra-cli-command 132 | '("zotra") 133 | "The command to run the Zotra server as a cli program. 134 | The command should be entered as a list of strings where the 135 | first element is the command and the rest are its arguments." 136 | :group 'zotra 137 | :type '(repeat string)) 138 | 139 | 140 | (defcustom zotra-url-retrieve-timeout 141 | 15 142 | "How many seconds to wait for server to get a response. 143 | This is only relevant when `zotra-backend' is is either citoid or 144 | translation-server." 145 | :group 'zotra 146 | :type 'natnum) 147 | 148 | (defconst zotra-citoid-supported-formats 149 | '("mediawiki" 150 | "zotero" 151 | "bibtex" 152 | "mediawiki-basefields") 153 | "List of entry formats supported by the citoid backend.") 154 | 155 | (defconst zotra-translation-server-supported-formats 156 | '("bibtex" 157 | "biblatex" 158 | "bookmarks" 159 | "coins" 160 | "csljson" 161 | "csv" 162 | "endnote_xml" 163 | "evernote" 164 | "mods" 165 | "rdf_bibliontology" 166 | "rdf_dc" 167 | "rdf_zotero" 168 | "refer" 169 | "refworks_tagged" 170 | "ris" 171 | "tei" 172 | "wikipedia" 173 | "zotero") 174 | "List of entry formats supported by translation-server, zotra-server or zotra-cli backends. 175 | 176 | See https://github.com/zotero/translation-server#export-translation 177 | and https://github.com/zotero/translation-server/blob/master/src/formats.js 178 | 179 | Note that the value \"zotero\" is not listed in the above links and 180 | corresponds to Zotero JSON format.") 181 | 182 | 183 | (defcustom zotra-default-entry-format 184 | "bibtex" 185 | "The bibliography format. 186 | 187 | Can be one of the value in `zotra-citoid-supported-formats' 188 | or `zotra-translation-server-supported-formats'" 189 | :group 'zotra 190 | :type 'string) 191 | 192 | 193 | (defcustom zotra-multiple-item-strategy 194 | 'ask 195 | "What should Zotra do when a url corresponds to multiple entries. 196 | SINGLE: capture the url as a single entry. 197 | MULTIPLE: ask user which entry in the page should be captures. 198 | ASK: ask user if the url should be captured as a single entry or not." 199 | :group 'zotra 200 | :type '(choice (const single) (const multiple) (const ask))) 201 | 202 | 203 | (defcustom zotra-protocol-multiple-item-strategy 204 | 'single 205 | "What should Zotra protocol do when a url corresponds to multiple entries. 206 | SINGLE: capture the url as a single entry. 207 | MULTIPLE: ask user which entry in the page should be captures. 208 | ASK: ask user if the url should be captured as a single entry or not." 209 | :group 'zotra 210 | :type '(choice (const single) (const multiple) (const ask))) 211 | 212 | 213 | (defcustom zotra-download-attachment-default-directory 214 | (expand-file-name "zotra-attachment-dir" temporary-file-directory) 215 | "The default download directory (or directories) for attachments. 216 | Used in `zotra-download-attachment'." 217 | :group 'zotra 218 | :type '(choice directory (repeat directory))) 219 | 220 | 221 | 222 | (defun zotra-run-external-command (cmd &optional silent-error) 223 | "Run the external command described by the list CMD and return the stdout. 224 | If SILENT-ERROR is nil and the command fails, raise a user-error." 225 | (with-temp-buffer 226 | (let* ((stderr-file (make-temp-file "zotra-stderr-")) 227 | (return-code 228 | (apply #'call-process 229 | (append 230 | (list (car cmd) 231 | nil 232 | (list (current-buffer) stderr-file) 233 | nil) 234 | (cdr cmd)))) 235 | (out (buffer-string)) 236 | (err (with-temp-buffer (insert-file-contents stderr-file) (buffer-string)))) 237 | (delete-file stderr-file) 238 | (if (and (not (= return-code 0)) 239 | (null silent-error)) 240 | (user-error 241 | (if err 242 | err 243 | (format "Command '%s' failed with return code '%s'" cmd return-code))) 244 | (when err (message "%s" err))) 245 | out))) 246 | 247 | 248 | (defun zotra-retrieve-synchronously (url &optional headers-alist data response-handler) 249 | (let (response-code output) 250 | (if zotra-use-curl 251 | (let ((output-file (make-temp-file "zotra-output-"))) 252 | (setq response-code 253 | (string-to-number 254 | (zotra-run-external-command 255 | (flatten-list 256 | (list "curl" 257 | "--compressed" 258 | "-w" "%{http_code}" 259 | "-o" output-file 260 | "--max-time" (format "%s" zotra-url-retrieve-timeout) 261 | "-s" "--show-error" 262 | (when data (list "-d" (format "%s" data))) 263 | (mapcar (lambda (h) 264 | (list "-H" (format "%s: %s" (car h) (cdr h)))) 265 | headers-alist) 266 | url))))) 267 | (setq output 268 | (with-temp-buffer 269 | (insert-file-contents output-file) (buffer-string))) 270 | (delete-file output-file)) 271 | (condition-case e 272 | (let* ((url-request-method (if data "POST" "GET")) 273 | (url-request-extra-headers headers-alist) 274 | (url-request-data (when data (encode-coding-string data 'utf-8))) 275 | (response-buffer 276 | (url-retrieve-synchronously url nil nil 277 | zotra-url-retrieve-timeout))) 278 | (unless response-buffer 279 | (user-error "Request failed. If this issue persists, try changing `zotra-use-curl' or `zotra-backend'")) 280 | (setq response-code 281 | (with-current-buffer response-buffer 282 | (and (boundp 'url-http-response-status) url-http-response-status))) 283 | (setq output 284 | (with-temp-buffer 285 | (url-insert-buffer-contents response-buffer url) 286 | (buffer-string)))) 287 | (file-error 288 | (user-error (concat (format "%s\n" e) 289 | (unless zotra-local-server-directory 290 | "The variable `zotra-local-server-directory' is nil. ") 291 | (format "Are you sure a server is running on `%s'?" zotra-server-path)))))) 292 | (if response-handler 293 | (funcall response-handler response-code output)) 294 | output)) 295 | 296 | 297 | (defvar zotra-local-server-process nil) 298 | (defvar zotra-local-server-process-directory nil) 299 | (defvar zotra-local-server-process-buffer-name "*zotra-local-server*") 300 | 301 | 302 | (defun zotra-maybe-start-local-server () 303 | (when (and zotra-local-server-directory 304 | (member zotra-backend '(translation-server zotra-server))) 305 | (let ((start (not (process-live-p zotra-local-server-process)))) 306 | (when (and (process-live-p zotra-local-server-process) 307 | (not (equal zotra-local-server-process-directory 308 | zotra-local-server-directory))) 309 | (zotra-kill-local-server) 310 | (setq start t)) 311 | (when start 312 | (message "Starting local %s..." zotra-backend) 313 | (setq zotra-local-server-process 314 | (make-process 315 | :name "zotra-server-process" 316 | :buffer (and zotra-local-server-process-buffer-name 317 | (get-buffer-create 318 | zotra-local-server-process-buffer-name)) 319 | :noquery t 320 | :command (list "npm" "start" "--prefix" 321 | zotra-local-server-directory))) 322 | (setq zotra-local-server-process-directory 323 | zotra-local-server-directory) 324 | (sleep-for 2))))) 325 | 326 | 327 | (defun zotra-kill-local-server () 328 | (when (process-live-p zotra-local-server-process) 329 | (kill-process zotra-local-server-process))) 330 | 331 | 332 | ;; For `zotra-server', `translation-server' and `zotra-cli' backends 333 | (defun zotra-contact-server (data content-type endpoint &optional param) 334 | (cond 335 | ((member zotra-backend '(translation-server zotra-server)) 336 | (zotra-retrieve-synchronously 337 | (concat zotra-server-path "/" endpoint 338 | (when param (format "?%s=%s" (car param) (cdr param)))) 339 | `(("Content-Type" . ,content-type)) data)) 340 | ((equal zotra-backend 'zotra-cli) 341 | (zotra-run-external-command 342 | (append 343 | zotra-cli-command 344 | (if param 345 | (if (equal "single" (car param)) 346 | (list "--single") 347 | (list (format "--%s=%s" (car param) (cdr param)))) 348 | (when (equal content-type "application/json") 349 | (list "--json"))) 350 | (list endpoint data)) 351 | t)))) 352 | 353 | 354 | ;; For `zotra-server', `translation-server' and `zotra-cli' backends 355 | (defun zotra-get-json (data &optional endpoint) 356 | "Get bibliographic data of DATA in Zotero JSON format. 357 | 358 | ENDPOINT must be \"search\" or \"web\". Any value other than \"search\" will 359 | be treated as \"web\"." 360 | (let* ((j (or (zotra-contact-server 361 | data "text/plain" (or endpoint "web") 362 | (when (and (eq zotra-multiple-item-strategy 'single) 363 | (not (equal endpoint "search"))) 364 | '("single" . "1"))) 365 | ""))) 366 | (condition-case nil 367 | (let* ((p (json-parse-string j :object-type 'alist :array-type 'list)) 368 | (p-items (assoc 'items p))) 369 | (cond 370 | ((null p-items) 371 | j) 372 | ((and (not (eq zotra-multiple-item-strategy 'multiple)) 373 | (yes-or-no-p "Capture the page as a single item? ")) 374 | (zotra-contact-server 375 | data 376 | "text/plain" "web" '("single" . "1"))) 377 | (t 378 | (let* ((candidates 379 | (cl-loop 380 | for item in (cdr p-items) 381 | collect 382 | (replace-regexp-in-string 383 | "," ";" (format "%s --- %s" (car item) (cdr item))))) 384 | (choices 385 | (cl-loop 386 | for c in (completing-read-multiple "Select: " candidates nil t) 387 | collect 388 | (nth (cl-position c candidates :test #'equal) (cdr p-items))))) 389 | (setcdr p-items choices) 390 | (zotra-contact-server (json-serialize p) "application/json" "web"))))) 391 | (json-parse-error 392 | (user-error "JSON parse error: %s" j))))) 393 | 394 | 395 | ;; For `zotra-server', `translation-server' and `zotra-cli' backends 396 | (defun zotra-get-entry-from-json (json entry-format) 397 | "Convert Zotero JSON format to ENTRY-FORMAT. 398 | 399 | This function does NOT run the hooks in `zotra-after-get-bibtex-entry-hook'." 400 | (let* ((entry (zotra-contact-server 401 | json "application/json" "export" `("format" . ,entry-format)))) 402 | (cond ((string= entry "Bad Request") 403 | (user-error "Bad Request")) 404 | ((string= entry "An error occurred during translation. Please check translation with the Zotero client.") 405 | (user-error "An error occurred during translation")) 406 | (t entry)))) 407 | 408 | 409 | (defun zotra-get-entry-1 (data entry-format &optional endpoint) 410 | (zotra-maybe-start-local-server) 411 | (cond 412 | ((equal zotra-backend 'citoid) 413 | (zotra-retrieve-synchronously 414 | (format "https://en.wikipedia.org/api/rest_v1/data/citation/%s/%s" 415 | entry-format 416 | (url-hexify-string data)) 417 | nil nil 418 | (lambda (response-code output) 419 | (cl-case response-code 420 | (200 nil) 421 | (404 422 | (user-error "404: Citation data was not found" response-code output)) 423 | (t 424 | (user-error "Citoid server responded with code: %s\n%s" 425 | response-code 426 | (or (ignore-errors 427 | (string-join 428 | (mapcar 429 | (lambda (it) (format "%s: %s" (car it) (cdr it))) 430 | (json-parse-string output :object-type 'alist)) 431 | "\n")) 432 | output))))))) 433 | ((not (member zotra-backend '(citoid zotra-cli zotra-server translation-server))) 434 | nil) 435 | ((equal entry-format "zotero") 436 | (zotra-get-json data endpoint)) 437 | (t 438 | (zotra-get-entry-from-json 439 | (zotra-get-json data endpoint) entry-format)))) 440 | 441 | 442 | (defun zotra-query-url-or-search-string (&optional url-or-search-string) 443 | "Ask the user where to get bibliographic data from. 444 | 445 | If URL-OR-SEARCH-STRING is nil, ask the user. 446 | If it is a url, ensure that url is redirected properly using 447 | `zotra-url-redirect-functions'." 448 | (let* ((input (or url-or-search-string 449 | (read-string 450 | (if (equal zotra-backend 'citoid) 451 | "URL or search identifier (DOI, PMCID, PMID or QID): " 452 | "URL or search identifier (DOI, ISBN, PMID, arXiv ID): ") 453 | (ignore-errors (current-kill 0 t)))))) 454 | (if (not (string-match-p "https?://" input)) 455 | (cons input "search") 456 | (mapc (lambda (x) 457 | (setq input (funcall x input))) 458 | zotra-url-redirect-functions) 459 | (cons input "web")))) 460 | 461 | 462 | (defun zotra-get-entry (&optional url-or-search-string entry-format) 463 | "Get bibliography entry. 464 | 465 | Return the entry for URL-OR-SEARCH-STRING in the format ENTRY-FORMAT or 466 | `zotra-default-entry-format' if ENTRY_FORMAT is nil. 467 | If the format is not supported by the current backend, default to \"bibtex\". 468 | 469 | When ENTRY-FORMAT is \"bibtex\" or \"biblatex\", this function runs the hooks 470 | in `zotra-after-get-bibtex-entry-hook' before returning its output." 471 | (let* ((zotra-backend 472 | (if (member zotra-backend '(citoid zotra-cli zotra-server translation-server)) 473 | zotra-backend 474 | (message "Unrecognised backend. Trying `citoid'...") 475 | 'citoid)) 476 | (query-result 477 | (zotra-query-url-or-search-string url-or-search-string)) 478 | (data (car query-result)) 479 | (endpoint (cdr query-result)) 480 | (entry-format (or entry-format 481 | zotra-default-entry-format)) 482 | (entry-format 483 | (if (member entry-format 484 | (if (equal zotra-backend 'citoid) 485 | zotra-citoid-supported-formats 486 | zotra-translation-server-supported-formats)) 487 | entry-format 488 | (message (concat 489 | "The entry format `%s' is not supported by the backend `%s'.\n" 490 | "Using `bibtex' instead...") 491 | entry-format zotra-backend) 492 | "bibtex")) 493 | (entry-bibtex-dialect 494 | (cond 495 | ((equal entry-format "bibtex") 'BibTeX) 496 | ((equal entry-format "biblatex") 'biblatex)))) 497 | (with-temp-buffer 498 | (insert "\n" (zotra-get-entry-1 data entry-format endpoint)) 499 | (goto-char (point-min)) 500 | (when entry-bibtex-dialect 501 | (bibtex-mode) 502 | (bibtex-set-dialect entry-bibtex-dialect t) 503 | (while (bibtex-next-entry) 504 | (save-excursion 505 | (save-restriction 506 | (bibtex-narrow-to-entry) 507 | (dolist (h zotra-after-get-bibtex-entry-hook) 508 | (bibtex-beginning-of-entry) 509 | (ignore-errors (funcall h))))))) 510 | (buffer-string)))) 511 | 512 | 513 | (defun zotra-add-entry (&optional url-or-search-string entry-format bibfile) 514 | "Add bibliography entry for URL-OR-SEARCH-STRING to BIBFILE. 515 | 516 | Pass URL-OR-SEARCH-STRING and ENTRY-FORMAT to `zotra-get-entry' 517 | to get the entry. 518 | 519 | If BIBFILE is the symbol `here', then insert entry at point. 520 | If BIBFILE is nil, use `zotra-default-bibliography'. 521 | If `zotra-default-bibliography' is also nil, ask the user to choose 522 | the bib file. 523 | 524 | Return the last bibtex key of the added entries." 525 | (interactive) 526 | (let ((bibfile 527 | (or bibfile 528 | (and (stringp zotra-default-bibliography) zotra-default-bibliography) 529 | (and (listp zotra-default-bibliography) 530 | (not (cdr zotra-default-bibliography)) 531 | (car zotra-default-bibliography)) 532 | (completing-read 533 | "Bibfile: " 534 | (append zotra-default-bibliography 535 | (directory-files "." t ".*\\.bib\\'") 536 | (and (fboundp #'org-cite-list-bibliography-files) 537 | (org-cite-list-bibliography-files)))))) 538 | (entry (zotra-get-entry url-or-search-string entry-format)) 539 | last-key) 540 | (if (equal bibfile 'here) 541 | (progn 542 | (insert entry) 543 | (save-excursion 544 | (bibtex-previous-entry) 545 | (setq last-key (cdr (assoc "=key=" (bibtex-parse-entry)))))) 546 | (with-current-buffer (or (find-buffer-visiting bibfile) 547 | (find-file-noselect bibfile)) 548 | (save-excursion 549 | (save-restriction 550 | (widen) 551 | (goto-char (point-max)) 552 | (when (not (looking-at "^")) (insert "\n")) 553 | (insert entry) 554 | (bibtex-previous-entry) 555 | (setq last-key (cdr (assoc "=key=" (bibtex-parse-entry)))))) 556 | (save-buffer))) 557 | last-key)) 558 | 559 | 560 | (define-obsolete-function-alias 561 | 'zotra-add-entry-from-url 'zotra-add-entry 562 | "[2023-09-30 Fri]") 563 | 564 | 565 | (define-obsolete-function-alias 566 | 'zotra-add-entry-from-search 'zotra-add-entry 567 | "[2023-09-30 Fri]") 568 | 569 | 570 | ;; attachments 571 | 572 | 573 | (defun zotra-get-attachments-1 (data &optional endpoint json) 574 | (let ((attachments 575 | (cl-case zotra-backend 576 | (zotra-cli 577 | (let* ((endpoint (or endpoint "web")) 578 | (cli-output (zotra-run-external-command 579 | (append 580 | zotra-cli-command 581 | (list "-a") 582 | (when json "-j") 583 | (list endpoint data)) 584 | t))) 585 | (cl-loop 586 | for item in (split-string cli-output "\n") 587 | for trimmed-item = (string-trim item) 588 | if (not (equal trimmed-item "")) 589 | collect trimmed-item))) 590 | (zotra-server 591 | (zotra-maybe-start-local-server) 592 | (let* ((j (zotra-get-json data endpoint)) 593 | (p (json-parse-string j :object-type 'alist :array-type 'list))) 594 | (flatten-tree 595 | (mapcar (lambda (item) 596 | (and (equal (cdr (assoc 'itemType item)) "attachment") 597 | (not (equal (cdr (assoc 'mimeType item)) "text/html")) 598 | (cdr (assoc 'url item)))) 599 | p))))))) 600 | (if attachments 601 | attachments 602 | (user-error "Zotra failed to find any attachments in page")))) 603 | 604 | 605 | (defun zotra-get-attachment (&optional url-or-search-string all) 606 | "Get the attachment URLs for the URL-OR-SEARCH-STRING. 607 | If IS-SEARCH is nil, treat URL-OR-SEARCH-STRING as a url. Otherwise, treat it 608 | as a search identifier. 609 | If ALL is non-nil, return the list of attachments." 610 | (let* ((zotra-backend 611 | (if (member zotra-backend '(zotra-cli zotra-server)) 612 | zotra-backend 613 | (message "Fetching attachments is only supported with `zotra-cli' and `zotra-server' backends.") 614 | (message "Trying `zotra-server'...") 615 | 'zotra-server)) 616 | (query-result 617 | (zotra-query-url-or-search-string url-or-search-string)) 618 | (data (car query-result)) 619 | (endpoint (cdr query-result)) 620 | (attachments (zotra-get-attachments-1 data endpoint))) 621 | (if all 622 | attachments 623 | (if (cdr attachments) 624 | (completing-read "Which attachment? " attachments nil t) 625 | (car attachments))))) 626 | 627 | 628 | (defun zotra-correct-file-extension? (path) 629 | "Check if the file extension of PATH matches its mime type." 630 | (if (not (and (executable-find "file") (file-exists-p "/etc/mime.types"))) 631 | t ;; we have no way of checking, so we assume it's correct! 632 | (let* ((mime-type 633 | (replace-regexp-in-string 634 | "\n$" "" 635 | (zotra-run-external-command 636 | (list "file" "-b" "--mime-type" path)))) 637 | (correct-extensions 638 | (split-string 639 | (replace-regexp-in-string 640 | mime-type " " 641 | (with-temp-buffer 642 | (insert-file-contents "/etc/mime.types") 643 | (goto-char (point-min)) 644 | (keep-lines (format "^%s" mime-type)) 645 | (buffer-string))) 646 | nil t))) 647 | (when (member (file-name-extension path) correct-extensions) 648 | t)))) 649 | 650 | 651 | (defun zotra-download-attachment (&optional url-or-search-string download-dir filename confirm-filename) 652 | "Download the attachments for URL-OR-SEARCH-STRING. 653 | 654 | If URL-OR-SEARCH-STRING is nil, ask the user. 655 | If FILENAME does not contain directory, use the directory DOWNLOAD-DIR. 656 | If DOWNLOAD-DIR is nil, use `zotra-download-attachment-default-directory'. 657 | If `zotra-download-attachment-default-directory' is also nil, ask for 658 | the download directory. 659 | If FILENAME is nil or CONFIRM-FILENAME is non-nil, ask for the filename 660 | to save. 661 | 662 | Return the path to the downloaded attachment." 663 | (interactive) 664 | (let* ((attachment-url (zotra-get-attachment url-or-search-string)) 665 | (download-dir (expand-file-name 666 | (or (when filename (file-name-directory filename)) 667 | download-dir 668 | (and (stringp zotra-download-attachment-default-directory) 669 | zotra-download-attachment-default-directory) 670 | (and (listp zotra-download-attachment-default-directory) 671 | (not (cdr zotra-download-attachment-default-directory)) 672 | (car zotra-download-attachment-default-directory)) 673 | (and zotra-download-attachment-default-directory 674 | (completing-read "Where to save? " 675 | zotra-download-attachment-default-directory)) 676 | (and (not zotra-download-attachment-default-directory) 677 | (read-directory-name "Where to save? "))))) 678 | (filename (or (when (and filename (not confirm-filename)) 679 | (expand-file-name filename download-dir)) 680 | (expand-file-name 681 | (completing-read 682 | "Rename attachment to: " nil nil nil 683 | (or filename 684 | (car (last (split-string attachment-url "/" t))))) 685 | download-dir)))) 686 | (mkdir (file-name-directory filename) t) 687 | (url-copy-file attachment-url filename 1) 688 | (unless (file-exists-p filename) 689 | (browse-url attachment-url) 690 | (user-error "Failed to download file. Opening the attachment in browser")) 691 | (unless (zotra-correct-file-extension? filename) 692 | (delete-file filename) 693 | (browse-url attachment-url) 694 | (user-error "The attachment file seems to be corrupted. Opening the attachment in browser")) 695 | filename)) 696 | 697 | 698 | (define-obsolete-function-alias 699 | 'zotra-download-attachment-from-url 'zotra-download-attachment 700 | "[2023-09-30 Fri]") 701 | 702 | 703 | (define-obsolete-function-alias 704 | 'zotra-download-attachment-from-search 'zotra-download-attachment 705 | "[2023-09-30 Fri]") 706 | 707 | 708 | ;; zotra-protocol 709 | 710 | 711 | (defun zotra-protocol (info) 712 | (let ((url (plist-get info :url)) 713 | (bibfile (plist-get info :bibfile)) 714 | (entry-format (plist-get info :format)) 715 | (zotra-multiple-item-strategy zotra-protocol-multiple-item-strategy)) 716 | (message "Zotra received: `%s' to be saved in `%s'" 717 | url (or bibfile "zotra-default-bibliography")) 718 | (zotra-add-entry url entry-format bibfile) 719 | nil)) 720 | 721 | 722 | (add-to-list 'org-protocol-protocol-alist 723 | '("zotra-protocol" 724 | :protocol "zotra" 725 | :function zotra-protocol)) 726 | 727 | 728 | ;; zotra-url-redirect-functions 729 | 730 | 731 | (defun zotra-url-redirect--arxiv (url) 732 | (if (string-match 733 | "^\\(https?://\\)?\\(www\.\\)?arxiv.org/pdf/\\(.*\\)\.pdf" url) 734 | (concat 735 | "https://arxiv.org/abs/" 736 | (match-string-no-properties 3 url)) 737 | url)) 738 | 739 | 740 | ;;; Zotra + bibtex-completion 741 | 742 | 743 | (declare-function bibtex-completion-add-pdf-to-library "bibtex-completion") 744 | (declare-function bibtex-completion-get-entry "bibtex-completion") 745 | (declare-function bibtex-completion-get-value "bibtex-completion") 746 | (defvar bibtex-completion-library-path) 747 | (defvar bibtex-completion-pdf-extension) 748 | (defvar bibtex-completion-fallback-options) 749 | 750 | 751 | (defcustom zotra-bibtex-completion-confirm-url 752 | t 753 | "Prompt user to confirm url before downloading attachment." 754 | :group 'zotra 755 | :type 'boolean) 756 | 757 | 758 | (defun zotra--bibtex-completion-add-pdf-to-library (keys) 759 | "Add a PDF to the library for the first entry in KEYS. 760 | The PDF can be added either from an open buffer, a file, a 761 | URL, or using Zotra." 762 | (let* ((key (car keys)) 763 | (source (char-to-string 764 | (read-char-choice "Add pdf from [b]uffer, [f]ile, [u]rl, or [z]otra? " '(?b ?f ?u ?z)))) 765 | (buffer (when (string= source "b") 766 | (read-buffer-to-switch "Add pdf buffer: "))) 767 | (file (when (string= source "f") 768 | (expand-file-name (read-file-name "Add pdf file: " nil nil t)))) 769 | (url (cond 770 | ((string= source "u") 771 | (read-string "Add pdf URL: ")) 772 | ((string= source "z") 773 | (let* ((entry (bibtex-completion-get-entry key)) 774 | (url-field (string-trim 775 | (or (bibtex-completion-get-value "url" entry) "")))) 776 | (zotra-get-attachment 777 | (if (and (< 0 (length url-field)) 778 | (or (not zotra-bibtex-completion-confirm-url) 779 | (y-or-n-p 780 | (format "Use '%s' with Zotra? " url-field)))) 781 | url-field 782 | (read-string "URL to use with Zotra: "))))))) 783 | (path (flatten-list bibtex-completion-library-path)) 784 | (path (if (cdr path) 785 | (completing-read "Add pdf to: " path nil t) 786 | (car path))) 787 | (pdf (expand-file-name (completing-read "Rename pdf to: " 788 | (mapcar (lambda (it) (concat key it)) 789 | (flatten-list bibtex-completion-pdf-extension)) 790 | nil nil key) 791 | path))) 792 | (cond 793 | (buffer 794 | (with-current-buffer buffer 795 | (write-file pdf t))) 796 | (file 797 | (copy-file file pdf 1)) 798 | (url 799 | (url-copy-file url pdf 1))))) 800 | 801 | 802 | (defun zotra-bibtex-completion () 803 | "Integrate Zotra with bibtex-completion." 804 | (interactive) 805 | (add-to-list 'bibtex-completion-fallback-options 806 | '("Add entry from URL or search identifier (zotra.el)" 807 | . zotra-add-entry)) 808 | (defalias #'bibtex-completion-add-pdf-to-library 809 | #'zotra--bibtex-completion-add-pdf-to-library)) 810 | 811 | 812 | ;; The end 813 | (provide 'zotra) 814 | 815 | ;;; zotra.el ends here 816 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------