├── .gitmodules ├── .editorconfig ├── _meta.lua ├── .luarc.json ├── defaultsettings.lua ├── TODO.md ├── README.md ├── readeckcache.lua ├── readeckbrowser.lua ├── main.lua ├── readeckapi.lua └── LICENCE /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "koreader"] 2 | path = koreader 3 | url = git@github.com:koreader/koreader.git 4 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # https://editorconfig.org/#supported-properties 2 | root = true 3 | 4 | [*.{lua}] 5 | indent_style = space 6 | indent_size = 4 7 | -------------------------------------------------------------------------------- /_meta.lua: -------------------------------------------------------------------------------- 1 | local _ = require("gettext") 2 | return { 3 | name = "readeck", 4 | fullname = _("Readeck"), 5 | description = _([[Plugin for integration with a Readeck server.]]), 6 | } 7 | -------------------------------------------------------------------------------- /.luarc.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://raw.githubusercontent.com/sumneko/vscode-lua/master/setting/schema.json", 3 | "runtime.version": "LuaJIT", 4 | "workspace": { 5 | "library": [ "koreader/frontend", "koreader/plugins" ] 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /defaultsettings.lua: -------------------------------------------------------------------------------- 1 | return { 2 | data_dir = require("datastorage"):getDataDir() .. "/readeck", -- path string 3 | server_url = nil, -- string 4 | api_token = nil, -- string 5 | username = nil, -- string 6 | password = nil, -- string 7 | default_labels = { }, -- string list 8 | _cache_size = 1024 * 1024 * 10, -- 10 MB. Change only if you know what you're doing 9 | } 10 | -------------------------------------------------------------------------------- /TODO.md: -------------------------------------------------------------------------------- 1 | # TODO 2 | 3 | ## Features 4 | 5 | - [-] Bookmark catalog 6 | - [-] Download bookmarks 7 | - [ ] Show a menu only with the downloaded bookmarks 8 | - [x] Only download new bookmarks, else, simply open the local copy 9 | - [-] Cache a bookmark list locally, for browsing when offline 10 | - [ ] Option to clean cache 11 | - [ ] Avoid entering in submenu when it would be empty 12 | - [ ] Search bookmarks from all collections, or only the current collection/submenu 13 | - [x] List by labels 14 | - [ ] Search labels 15 | - [x] List collections 16 | - [ ] Bookmarks sync 17 | - [ ] Sync reading progress 18 | - [ ] Sync highlights (with colors) 19 | - [ ] Option to archive or mark as favorite while reading (and push when online) 20 | - [-] Add bookmark links to Readeck while reading 21 | - [x] when online 22 | - [ ] when offline, add bookmark to "push queue" until online 23 | - [ ] Option (with configurable defaults) to download the new bookmark, 24 | mark as finished, mark as archived (like in the browser extension) 25 | - [ ] Option to immediately open the new bookmark 26 | - [-] Configuration menu 27 | - [x] Logging in 28 | - [x] Option to set default labels (e.g.: "from kindle") 29 | - [ ] More settings...? 30 | - [ ] Delete downloaded bookmarks 31 | - [ ] Button to delete all/read/archived bookmarks 32 | - [ ] Hold a bookmark in the browser to allow deletion 33 | 34 | ## Bugs 35 | 36 | - [x] On Kindle (not on PC), text input fields automatically fill up with some text 37 | about reporting bugs via email. 38 | - [x] Don't crash when certain operations are done without network... 39 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # readeck.koplugin 2 | 3 | A [KOReader](https://koreader.rocks/) plugin to add integration with your 4 | [Readeck](https://readeck.org/en/) instance's API. 5 | 6 | > [!WARNING] 7 | > THIS IS STILL IN EARLY DEVELOPMENT, AND MAY NOT FUNCTION AS EXPECTED SOMETIMES. 8 | > Early progress tracked in [TODO.md](./TODO.md) 9 | 10 | ## Installation 11 | 12 | Simply put this repo in your KOReader's plugin folder (koreader/plugins). 13 | 14 | *No need to also copy the koreader git submodule (`./koreader`), as it's only 15 | there for better Lua development integration.* 16 | 17 | ## Usage 18 | 19 | #TODO 20 | 21 | - Browse bookmarks 22 | You can browse your bookmarks and collections in `🔎 > Readeck bookmarks` (will likely be on the second page of the `🔎` menu). 23 | - Save links 24 | You can click on links while reading to add them as a bookmark to Readeck. 25 | 26 | ## Configuration 27 | 28 | Settings can be changed within KOReader in `🔎 > Settings > Readeck Settings`. 29 | 30 | ### Server and credentials 31 | 32 | You **must** set the Server URL and either: 33 | - Username and Password, and click on "Sign in"; 34 | - or the API Token, and click on "Save". 35 | 36 | If you don't want your password being stored in plaintext on your device, you 37 | can manually create your API token at `http(s)://[yourreadeckserver]/profile/tokens`. 38 | Don't forget to set both the "Bookmarks: Read Only" and "Bookmarks: Write Only" 39 | roles. 40 | 41 | ### Misc. 42 | 43 | - New bookmark settings: 44 | - Default labels: Comma-separated list of labels to add by default when 45 | creating new bookmarks from links. 46 | 47 | You can also configure it by changing the `readeck.lua` file in your 48 | `koreader/settings` folder: 49 | 50 | ```koreader/settings/readeck.lua 51 | return { 52 | data_dir = nil -- default: require("datastorage"):getDataDir() .. "/readeck", 53 | server_url = "http(s)://[yourreadeckserver]/", -- mandatory 54 | username = nil, -- Needed to generate the API token automatically 55 | password = nil, -- Needed to generate the API token automatically 56 | api_token = nil, -- Generated automatically if username and password are given, 57 | -- but can also be set manually. 58 | default_labels = { }, -- string list 59 | } 60 | ``` 61 | 62 | -------------------------------------------------------------------------------- /readeckcache.lua: -------------------------------------------------------------------------------- 1 | local CacheSQLite = require("cachesqlite") 2 | local LuaSettings = require("luasettings") 3 | 4 | local defaults = require("defaultsettings") 5 | local logger = require("logger") 6 | 7 | --- @todo this could be much better optimized by using lua-ljsqlite3 directly 8 | local ReadeckCache = { 9 | -- Mandatory 10 | settings = LuaSettings, 11 | } 12 | 13 | function ReadeckCache:getSetting(setting) 14 | return self.settings:readSetting(setting, defaults[setting]) 15 | end 16 | 17 | function ReadeckCache:new(o) 18 | o = o or {} 19 | if not o.settings then 20 | return nil, "Missing constructor parameters" 21 | end 22 | 23 | setmetatable(o, self) 24 | self.__index = self 25 | if o.init then o:init() end 26 | return o 27 | end 28 | 29 | function ReadeckCache:init() 30 | self.cache = CacheSQLite:new{ 31 | size = self:getSetting("_cache_size"), 32 | db_path = self:getSetting("data_dir") .. "/cache.sqlite" 33 | } 34 | end 35 | 36 | function ReadeckCache:cacheBookmarkList(key, bookmarks) 37 | self.cache.auto_close = false 38 | 39 | local bookmark_ids = {} 40 | 41 | for i, b in ipairs(bookmarks) do 42 | -- Add to list of bookmarks in this collection 43 | table.insert(bookmark_ids, b.id) 44 | 45 | -- Cache bookmark data 46 | -- TODO compare last modified dates so we can decide whether the entry should be updated? 47 | if not self.cache:check(b.id) then 48 | self.cache:insert(b.id, b) 49 | end 50 | end 51 | 52 | self.cache:insert(key, bookmark_ids) 53 | 54 | self.cache.auto_close = true 55 | self.cache:closeDB() 56 | end 57 | 58 | function ReadeckCache:getCachedBookmarksFromList(key) 59 | self.cache.auto_close = false 60 | 61 | local bookmark_ids = self.cache:get(key) 62 | if not bookmark_ids then 63 | self.cache.auto_close = true 64 | self.cache:closeDB() 65 | return nil 66 | end 67 | 68 | local bookmarks = {} 69 | 70 | for i, id in ipairs(bookmark_ids) do 71 | local b = self.cache:get(id) 72 | if b then 73 | table.insert(bookmarks, b) 74 | end 75 | end 76 | 77 | self.cache.auto_close = true 78 | self.cache:closeDB() 79 | 80 | return bookmarks 81 | end 82 | 83 | -- Labels 84 | function ReadeckCache:cacheLabelList(labels) 85 | self.cache:insert("labels", labels) 86 | end 87 | 88 | function ReadeckCache:getCachedLabelList() 89 | return self.cache:get("labels") 90 | end 91 | 92 | function ReadeckCache:cacheLabelBookmarks(label, bookmarks) 93 | self:cacheBookmarkList("l-" .. label.name, bookmarks) 94 | end 95 | 96 | function ReadeckCache:getCachedLabelBookmarks(label) 97 | return self:getCachedBookmarksFromList("l-" .. label.name) 98 | end 99 | 100 | -- Collections 101 | function ReadeckCache:cacheCollectionList(collections) 102 | self.cache:insert("collections", collections) 103 | end 104 | 105 | function ReadeckCache:getCachedCollectionList() 106 | local result = self.cache:get("collections") 107 | return result 108 | end 109 | 110 | function ReadeckCache:cacheCollectionBookmarks(collection, bookmarks) 111 | self:cacheBookmarkList(collection.id, bookmarks) 112 | end 113 | 114 | function ReadeckCache:getCachedCollectionBookmarks(collection) 115 | return self:getCachedBookmarksFromList(collection.id) 116 | end 117 | 118 | return ReadeckCache 119 | -------------------------------------------------------------------------------- /readeckbrowser.lua: -------------------------------------------------------------------------------- 1 | local BookList = require("ui/widget/booklist") 2 | local Cache = require("cache") 3 | local InfoMessage = require("ui/widget/infomessage") 4 | local LuaSettings = require("luasettings") 5 | local Menu = require("ui/widget/menu") 6 | local ReaderUI = require("apps/reader/readerui") 7 | local UIManager = require("ui/uimanager") 8 | 9 | local util = require("util") 10 | local logger = require("logger") 11 | local _ = require("gettext") 12 | local N_ = _.ngettext 13 | local T = require("ffi/util").template 14 | 15 | local ReadeckApi = require("readeckapi") 16 | 17 | local CatalogCache = Cache:new { 18 | -- Make it 20 slots, with no storage space constraints 19 | slots = 20, 20 | } 21 | 22 | --------====== PATHS ======-------- 23 | 24 | local MenuPath = { 25 | browser = nil, 26 | title = nil, 27 | subtitle = nil, 28 | item_table = nil, 29 | itemnumber = nil, 30 | } 31 | 32 | function MenuPath:extend(subclass_prototype) 33 | local o = subclass_prototype or {} 34 | setmetatable(o, self) 35 | self.__index = self 36 | return o 37 | end 38 | 39 | function MenuPath:new(o) 40 | o = self:extend(o) 41 | if o.init then o:init() end 42 | return o 43 | end 44 | 45 | function MenuPath:buildItemTable() 46 | return nil, T("Readeck: MenuPath:buildItemTable(): Method was not overriden for %1. Returning empty item table.", self.title or "nil") 47 | end 48 | 49 | function MenuPath:getItemTable() 50 | if not self.item_table then 51 | local result, err = self:buildItemTable() 52 | if not result then 53 | return nil, err 54 | end 55 | 56 | self.item_table = result 57 | end 58 | 59 | return self.item_table 60 | end 61 | 62 | -- -- Bookmarks path 63 | 64 | local BookmarksPath = MenuPath:extend{ 65 | -- Queries parameters are directly used for https://[yourreadeck]/docs/api#get-/bookmarks 66 | query = {}, 67 | -- The entry id to get or save the bookmark list to 68 | cache_entry = nil, 69 | } 70 | 71 | function BookmarksPath:buildItemTable() 72 | local bookmarks, err = self.browser.api:bookmarkList(self.query, self.cache_entry) 73 | if not bookmarks then 74 | return nil, err 75 | end 76 | 77 | local item_table = {} 78 | for i, b in ipairs(bookmarks) do 79 | item_table[i] = { 80 | text = b.title, 81 | mandatory_func = function() 82 | local progress_str 83 | if self.browser.api:bookmarkDownloaded(b) then 84 | local book_info = BookList.getBookInfo(self.browser.api:getBookmarkFilename(b)) 85 | local local_progress = 100 * util.round_decimal(book_info.percent_finished or 0, 2) 86 | 87 | progress_str = local_progress == b.read_progress 88 | and local_progress .. "%  " -- FontAwesome download icon 89 | or T("%1%  %2% ", local_progress, b.read_progress) 90 | else 91 | progress_str = b.read_progress .. "% " -- FontAwesome cloud icon 92 | end 93 | 94 | return T("%1, %2min", progress_str, b.reading_time) 95 | end, 96 | bookmark = b, 97 | } 98 | end 99 | 100 | return item_table 101 | end 102 | 103 | function BookmarksPath:onMenuSelect(item) 104 | local downloading_dialog = InfoMessage:new{ 105 | text = T(_(self.browser.api:bookmarkDownloaded(item.bookmark) 106 | and "Opening bookmark...\n%1" 107 | or "Downloading bookmark...\n%1"), item.bookmark.title) 108 | } 109 | UIManager:show(downloading_dialog) 110 | 111 | local file, already_downloaded = self.browser.api:downloadBookmark(item.bookmark) 112 | if not file then 113 | local err = already_downloaded 114 | 115 | UIManager:close(downloading_dialog) 116 | UIManager:show(InfoMessage:new{ text = T(_"Error downloading bookmark: %1", err), }) 117 | return nil 118 | end 119 | 120 | UIManager:close(downloading_dialog) 121 | ReaderUI:showReader(file) 122 | end 123 | 124 | -- -- LabelsPath 125 | 126 | local LabelsPath = MenuPath:extend{ 127 | title = _"Redeck labels" 128 | } 129 | 130 | function LabelsPath:buildItemTable() 131 | local item_table = {} 132 | 133 | local labels, err = self.browser.api:labelList() 134 | if not labels then 135 | return nil, err 136 | end 137 | for i, l in ipairs(labels) do 138 | item_table[i] = { 139 | text = l.name, 140 | mandatory = l.count, 141 | path = BookmarksPath:new{ 142 | browser = self.browser, 143 | query = { labels = '"' .. l.name .. '"' }, 144 | cache_entry = "l-" .. l.name, 145 | }, 146 | } 147 | end 148 | 149 | return item_table 150 | end 151 | 152 | function LabelsPath:onMenuSelect(item) 153 | self.browser:pushPath(item.path) 154 | return item.path 155 | end 156 | 157 | -- -- RootPath 158 | 159 | local RootPath = MenuPath:extend{ 160 | title = _"Redeck bookmarks" 161 | } 162 | 163 | function RootPath:buildItemTable() 164 | local item_table = { 165 | { 166 | text = _"Unread Bookmarks", 167 | -- TODO mandatory = get amount somehow 168 | path = BookmarksPath:new{ 169 | browser = self.browser, 170 | query = { is_archived = false }, 171 | cache_entry = "Unread", 172 | } 173 | }, { 174 | text = _"Archived Bookmarks", 175 | -- TODO mandatory = get amount somehow 176 | path = BookmarksPath:new{ 177 | browser = self.browser, 178 | query = { is_archived = true }, 179 | cache_entry = "Archived", 180 | } 181 | }, { 182 | text = _"Favorite Bookmarks", 183 | path = BookmarksPath:new{ 184 | browser = self.browser, 185 | query = { is_marked = true }, 186 | cache_entry = "Favorite", 187 | } 188 | }, { 189 | text = _"All Bookmarks", 190 | path = BookmarksPath:new{ 191 | browser = self.browser, 192 | query = {}, 193 | cache_entry = "All", 194 | } 195 | }, { 196 | text = _"Labels", 197 | path = LabelsPath:new{ browser = self.browser } 198 | }, 199 | } 200 | 201 | local collections, err = self.browser.api:collectionList() 202 | if not collections then 203 | logger.warn("ReadeckBrowser : Couldn't load collections: " .. err) 204 | return item_table, err 205 | end 206 | 207 | for i, c in pairs(collections) do 208 | local collection_id = c.id 209 | -- NOTE: THIS IS ASSUMING NONE OF THE FIELDS OTHER THAN id RETURNED IN 210 | -- collectionDetails CONTAINS ANY FIELDS RELEVANT FOR THE bookmarkList's 211 | -- QUERY, AND WILL BE IGNORED, LEADING TO THE EXPECTED RESULT 212 | c.id = nil -- So the collection id doesn't conflict with the bookmark query 213 | local item = { 214 | text = T(_"Collection: %1", c.name), 215 | path = BookmarksPath:new{ 216 | browser = self.browser, 217 | query = c, 218 | cache_entry = collection_id 219 | } 220 | } 221 | table.insert(item_table, item) 222 | end 223 | 224 | return item_table 225 | end 226 | 227 | function RootPath:onLeftButtonTap() 228 | -- TODO search for bookmark 229 | end 230 | 231 | function RootPath:onMenuSelect(item) 232 | local new_path = item.path 233 | new_path.title = new_path.title or item.text 234 | self.browser:pushPath(new_path) 235 | return new_path 236 | end 237 | 238 | 239 | --------====== BROWSER WINDOW ======-------- 240 | 241 | local Browser = Menu:extend{ 242 | -- Mandatory 243 | api = ReadeckApi, 244 | settings = LuaSettings, 245 | } 246 | 247 | function Browser:new(o) 248 | print(o.api) 249 | print(o.settings) 250 | if not (o and o.api and o.settings) then 251 | logger.warn("Browser:new() : Missing constructor parameters") 252 | return nil, "Missing constructor parameters" 253 | end 254 | return getmetatable(self).new(self, o) 255 | end 256 | 257 | function Browser:init() 258 | self.no_title = false 259 | self.is_borderless = true 260 | self.is_popout = false 261 | self.parent = nil 262 | self.covers_full_screen = true 263 | self.return_arrow_propagation = false 264 | 265 | self.title_bar_left_icon = "appbar.search" 266 | 267 | self.root_path = RootPath:new { browser = self } 268 | self.item_table = self.root_path:getItemTable() 269 | self.title = self.root_path.title 270 | self.subtitle = self.root_path.subtitle 271 | 272 | self.refresh_callback = function() 273 | --UIManager:setDirty(...?) 274 | self.ui:onRefresh() 275 | end 276 | Menu.init(self) -- call parent's init() 277 | end 278 | 279 | function Browser:getCurrentPath() 280 | return self.paths[#self.paths] or self.root_path 281 | end 282 | 283 | function Browser:pushPath(path) 284 | local new_item_table, err = path:getItemTable() 285 | if not new_item_table then 286 | UIManager:show(InfoMessage:new{ 287 | text = T(_"Couldn't load menu '%1':\n%2", path.title, err or _"Unknown error"), 288 | timeout = 5, 289 | }) 290 | return self.paths[#self.paths] 291 | end 292 | 293 | table.insert(self.paths, path) 294 | self:switchItemTable(path.title, path:getItemTable(), path.itemnumber, nil, path.subtitle) 295 | return path 296 | end 297 | 298 | -- -- UI EVENT HANDLING -- -- 299 | -- Menu overrides -- 300 | function Browser:onMenuSelect(item) 301 | return self:getCurrentPath():onMenuSelect(item) 302 | end 303 | 304 | function Browser:onReturn() 305 | table.remove(self.paths) 306 | local path = self.paths[#self.paths] or self.root_path 307 | -- return to root path 308 | self:switchItemTable(path.title, path:getItemTable(), path.itemnumber, nil, path.subtitle) 309 | return path 310 | end 311 | 312 | -- Menu action on return-arrow long-press (return to root path) 313 | function Browser:onHoldReturn() 314 | self.paths = {} 315 | self:switchItemTable(self.root_path.title, self.root_path:getItemTable(), 316 | self.root_path.itemnumber, nil, self.root_path.subtitle) 317 | return self.root_path 318 | end 319 | 320 | function Browser:onLeftButtonTap() 321 | self:getCurrentPath():onLeftButtonTap() 322 | end 323 | 324 | return Browser 325 | -------------------------------------------------------------------------------- /main.lua: -------------------------------------------------------------------------------- 1 | --[[-- 2 | @module koplugin.readeck 3 | ]] 4 | 5 | local BD = require("ui/bidi") 6 | local DataStorage = require("datastorage") 7 | local Dispatcher = require("dispatcher") -- luacheck:ignore 8 | local Event = require("ui/event") 9 | local FFIUtil = require("ffi/util") 10 | local InfoMessage = require("ui/widget/infomessage") 11 | local LuaSettings = require("luasettings") 12 | local MultiInputDialog = require("ui/widget/multiinputdialog") 13 | local NetworkMgr = require("ui/network/manager") 14 | local UIManager = require("ui/uimanager") 15 | local WidgetContainer = require("ui/widget/container/widgetcontainer") 16 | 17 | local logger = require("logger") 18 | local util = require("util") 19 | local _ = require("gettext") 20 | local T = FFIUtil.template 21 | local N_ = _.ngettext 22 | 23 | local ReadeckApi = require("readeckapi") 24 | local ReadeckBrowser = require("readeckbrowser") 25 | local ReadeckCache = require("readeckcache") 26 | 27 | local defaults = require("defaultsettings") 28 | 29 | ---------====== UTILITY FUNCTIONS ========------ 30 | 31 | local function parseLabels(labels_str) 32 | local labels = {} 33 | for label in labels_str:gmatch("[^,]+") do 34 | label = label:match("^%s*(.-)%s*$") 35 | if #label > 0 then -- ignore only whitespace sections 36 | table.insert(labels, label) 37 | end 38 | end 39 | 40 | return labels 41 | end 42 | 43 | local function labelsToString(labels) 44 | return table.concat(labels or {}, ", ") 45 | end 46 | 47 | 48 | ---------====== MODULE ========------ 49 | 50 | local Readeck = WidgetContainer:extend { 51 | name = "readeck", 52 | -- Set by init() 53 | settings = LuaSettings, 54 | cache = ReadeckCache, 55 | } 56 | 57 | function Readeck:onDispatcherRegisterActions() 58 | -- TODO do I need actions for anything? 59 | Dispatcher:registerAction("helloworld_action", { 60 | category="none", 61 | event="HelloWorld", 62 | title=_"Hello World", 63 | general=true, 64 | }) 65 | end 66 | 67 | function Readeck:init() 68 | self.settings = LuaSettings:open(DataStorage:getSettingsDir() .. "/readeck.lua") 69 | util.makePath(self:getSetting("data_dir")) 70 | 71 | self.cache = ReadeckCache:new{ 72 | settings = self.settings, 73 | } 74 | 75 | self.api = ReadeckApi:new{ 76 | settings = self.settings, 77 | cache = self.cache, 78 | } 79 | 80 | self:onDispatcherRegisterActions() 81 | self.ui.menu:registerToMainMenu(self) 82 | if self.ui.link then 83 | self.ui.link:addToExternalLinkDialog("22_readeck", function(this, link_url) 84 | return { 85 | text = _"Add to Readeck", 86 | callback = function() 87 | UIManager:close(this.external_link_dialog) 88 | this.ui:handleEvent(Event:new("AddArticleToReadeck", link_url)) 89 | end, 90 | } 91 | end) 92 | end 93 | end 94 | 95 | function Readeck:onAddArticleToReadeck(article_url) 96 | if not NetworkMgr:isOnline() then 97 | -- TODO store article link to upload on next sync 98 | UIManager:show(InfoMessage:new{ 99 | text = T(_"Not connected to the internet. Couldn't add article:\n%1", BD.url(article_url)), 100 | timeout = 3, 101 | }) 102 | return nil, "Not connected" 103 | end 104 | 105 | -- TODO option to add as favorite, mark as read, or archive immediately 106 | local labels_text = labelsToString(self:getSetting("default_labels")) 107 | if #labels_text > 0 then 108 | labels_text = labels_text .. ", " 109 | end 110 | 111 | local bookmark_id, err 112 | local dialog 113 | dialog = MultiInputDialog:new { 114 | title = T(_"Create bookmark for %1", BD.url(article_url)), 115 | fields = { 116 | { 117 | description = _"Bookmark title", 118 | text = "", 119 | hint = _"Custom title (optional)", 120 | }, 121 | { 122 | description = _"Labels", 123 | text = labels_text, 124 | hint = _"E.g.: label 1, label 2, ... (optional)", 125 | }, 126 | }, 127 | buttons = { 128 | { 129 | { 130 | text = _"Cancel", 131 | id = "close", 132 | callback = function() 133 | UIManager:close(dialog) 134 | end 135 | }, 136 | { 137 | text = _"OK", 138 | id = "ok", 139 | callback = function() 140 | local fields = dialog:getFields() 141 | local title = fields[1] 142 | local labels = parseLabels(fields[2]) 143 | 144 | bookmark_id, err = self.api:bookmarkCreate(article_url, title, labels) 145 | 146 | UIManager:close(dialog) 147 | 148 | -- TODO ask if the user wants to open the bookmark now, or favorite it, or archive it 149 | UIManager:show(InfoMessage:new { 150 | text = 151 | bookmark_id 152 | and T(_"Bookmark for\n%1\nsuccessfully created.", BD.url(article_url)) 153 | or T(_"Failed to create bookmark:\n%1", err), 154 | timeout = 3, 155 | }) 156 | return bookmark_id, err 157 | end 158 | }, 159 | }, 160 | }, 161 | } 162 | UIManager:show(dialog) 163 | dialog:onShowKeyboard() 164 | 165 | return bookmark_id, err 166 | end 167 | 168 | function Readeck:addToMainMenu(menu_items) 169 | menu_items.readeck_bookmarks = { 170 | text = _"Readeck bookmarks", 171 | sorting_hint = "search", 172 | callback = function() 173 | self.browser = ReadeckBrowser:new{ api = self.api, settings = self.settings } 174 | UIManager:show(self.browser) 175 | end, 176 | } 177 | menu_items.readeck_settings = { 178 | text = _"Readeck settings", 179 | sorting_hint = "search_settings", 180 | sub_item_table = { 181 | { 182 | text = _"Readeck server and credentials", 183 | keep_menu_open = true, 184 | callback = function() 185 | return self:severConfigDialog() 186 | end, 187 | }, { 188 | text = _"New bookmarks settings", 189 | keep_menu_open = true, 190 | callback = function() 191 | return self:newBookmarksConfigDialog() 192 | end, 193 | } 194 | }, 195 | } 196 | end 197 | 198 | function Readeck:getSetting(setting) 199 | return self.settings:readSetting(setting, defaults[setting]) 200 | end 201 | 202 | function Readeck:severConfigDialog() 203 | local text_info = T(_[[ 204 | If you don't want your password being stored in plaintext, you can erase the password field and save the settings after logging in and getting your API token. 205 | 206 | You can also edit the configuration file directly in your settings folder: 207 | %1 208 | and then restart KOReader.]], self.settings.file) 209 | 210 | local function saveSettings(fields) 211 | self.settings:saveSetting("server_url", fields[1]:gsub("/*$", "")) -- remove all trailing slashes 212 | :saveSetting("username", fields[2]) 213 | :saveSetting("password", fields[3]) 214 | :saveSetting("api_token", fields[4]) 215 | :flush() 216 | end 217 | 218 | local dialog 219 | dialog = MultiInputDialog:new{ 220 | title = _"Readeck server settings", 221 | fields = { 222 | { 223 | text = self:getSetting("server_url"), 224 | hint = _"Server URL" 225 | }, { 226 | text = self:getSetting("username"), 227 | hint = _"Username (if no API Token is given)" 228 | }, { 229 | text = self:getSetting("password"), 230 | text_type = "password", 231 | hint = _"Password (if no API Token is given)" 232 | }, { 233 | text = self:getSetting("api_token"), 234 | description = _"API Token", 235 | text_type = "password", 236 | hint = _"Will be acquired automatically if Username and Password are given." 237 | }, 238 | }, 239 | buttons = { 240 | { 241 | { 242 | text = _"Cancel", 243 | id = "close", 244 | callback = function() 245 | UIManager:close(dialog) 246 | end 247 | }, { 248 | text = _"Info", 249 | callback = function() 250 | UIManager:show(InfoMessage:new{ text = text_info }) 251 | end 252 | }, { 253 | text = _"Save", 254 | callback = function() 255 | saveSettings(dialog:getFields()) 256 | UIManager:close(dialog) 257 | end 258 | }, 259 | }, { 260 | { 261 | text = _"Sign in (generate API token) and save", 262 | timeout = 5, 263 | callback = function() 264 | local fields = dialog:getFields() 265 | local token, err = self.api:authenticate(fields[2], fields[3]) 266 | if not token then 267 | UIManager:show(InfoMessage:new{ text = err }) 268 | return 269 | end 270 | 271 | fields[4] = token 272 | UIManager:show(InfoMessage:new{ 273 | text = _"Logged in successfully.", 274 | timeout = 5, 275 | }) 276 | 277 | saveSettings(fields) 278 | UIManager:close(dialog) 279 | end, 280 | } 281 | }, 282 | }, 283 | } 284 | 285 | UIManager:show(dialog) 286 | dialog:onShowKeyboard() 287 | end 288 | 289 | function Readeck:newBookmarksConfigDialog() 290 | local function saveSettings(fields) 291 | self.settings:saveSetting("default_labels", parseLabels(fields[1])) 292 | :flush() 293 | end 294 | 295 | local dialog 296 | dialog = MultiInputDialog:new{ 297 | title = _"New bookmarks settings", 298 | fields = { 299 | { 300 | description = _"Default labels", 301 | text = labelsToString(self:getSetting("default_labels")), 302 | hint = _"E.g.: from koreader, label 2, ... (optional)", 303 | }, 304 | }, 305 | buttons = { 306 | { 307 | { 308 | text = _"Cancel", 309 | id = "close", 310 | callback = function() 311 | UIManager:close(dialog) 312 | end 313 | }, { 314 | text = _"Save", 315 | callback = function() 316 | saveSettings(dialog:getFields()) 317 | UIManager:close(dialog) 318 | end 319 | }, 320 | }, 321 | }, 322 | } 323 | 324 | UIManager:show(dialog) 325 | dialog:onShowKeyboard() 326 | end 327 | 328 | return Readeck 329 | -------------------------------------------------------------------------------- /readeckapi.lua: -------------------------------------------------------------------------------- 1 | local socket = require("socket") 2 | local http = require("socket.http") 3 | local url = require("socket.url") 4 | local ltn12 = require("ltn12") 5 | local util = require("util") 6 | local lfs = require("libs/libkoreader-lfs") 7 | -- Apparently https://github.com/harningt/luajson 8 | local rapidjson = require("rapidjson") 9 | local logger = require("logger") 10 | 11 | local _ = require("gettext") 12 | local T = require("ffi/util").template 13 | 14 | local NetworkMgr = require("ui/network/manager") 15 | local LuaSettings = require("luasettings") 16 | 17 | local ReadeckCache = require("readeckcache") 18 | 19 | local defaults = require("defaultsettings") 20 | 21 | 22 | local function log_return_error(err_msg) 23 | err_msg = "Readeck API error: " .. err_msg 24 | logger.warn(err_msg) 25 | return nil, err_msg 26 | end 27 | 28 | local Api = { 29 | -- Mandatory 30 | settings = LuaSettings, 31 | cache = ReadeckCache, 32 | } 33 | 34 | function Api:new(o) 35 | o = o or {} 36 | if not (o.settings and o.cache) then 37 | logger.warn("Api:new() : Missing constructor parameters") 38 | return nil, "Missing constructor parameters" 39 | end 40 | 41 | setmetatable(o, self) 42 | self.__index = self 43 | if o.init then o:init() end 44 | return o 45 | end 46 | 47 | function Api:getSetting(setting) 48 | return self.settings:readSetting(setting, defaults[setting]) 49 | end 50 | 51 | -------======= API call utilities =======------- 52 | 53 | function Api:buildUrl(path, query) 54 | local target_url = self:getSetting("server_url") .. "/api" .. path .. "?" 55 | for q, val in pairs(query or {}) do 56 | if val ~= rapidjson.null then 57 | if type(val) == "table" then 58 | -- If an array, add the query several times 59 | for i, elt in pairs(val) do 60 | if elt ~= rapidjson.null then 61 | target_url = target_url .. url.escape(q) .. "=" .. url.escape(tostring(elt)) .. "&" 62 | end 63 | end 64 | else 65 | target_url = target_url .. url.escape(q) .. "=" .. url.escape(tostring(val)) .. "&" 66 | end 67 | end 68 | end 69 | return target_url 70 | end 71 | 72 | --- 73 | -- @param sink 74 | -- @param method GET, POST, DELETE, PATCH, etc… 75 | -- @param path URL endpoint on Readeck server, without "/api" 76 | -- @query[opt] query Query to include in the url, if needed 77 | -- @param[opt] body Body to include in the request, if needed 78 | -- @param[opt] headers Defaults to Authorization for API endpoints, none for external 79 | -- @return header, or nil 80 | -- @return nil, or error message 81 | function Api:callApi(sink, method, path, query, body, headers, no_auth) 82 | local server_url = self:getSetting("server_url") 83 | if not server_url or server_url:len() == 0 then 84 | return log_return_error( 85 | _'Readeck server not defined. Please do so in "Readeck settings ▸ Readeck server and credentials"') 86 | end 87 | if not self:getSetting("server_url"):match("^https?://") then 88 | return log_return_error( 89 | _'Readeck server URL missing protocol "http://" or "https://". Please adjust in "Readeck settings ▸ Readeck server and credentials"') 90 | end 91 | 92 | local api_token = self:getSetting("api_token") 93 | if not no_auth and (not api_token or api_token:len() == 0) then 94 | logger.dbg("BABEU") 95 | local username = self:getSetting("username") 96 | local password = self:getSetting("password") 97 | if username and username:len() ~= 0 and password and password:len() ~= 0 then 98 | logger.dbg("BABEU2") 99 | local result, err = self:authenticate(username, password) 100 | if err then 101 | return result, err 102 | end 103 | else 104 | logger.dbg("BABEU3") 105 | return log_return_error( 106 | _'Need authentication, but username and/or password not defined. Please do so in "Readeck settings ▸ Readeck server and credentials"') 107 | end 108 | end 109 | logger.dbg("BABEU4") 110 | 111 | local ret 112 | NetworkMgr:runWhenOnline(function() 113 | ret = { self:callApiWhenOnline(sink, method, path, query, body, headers, no_auth) } 114 | end) 115 | 116 | if ret then 117 | return table.unpack(ret) 118 | else 119 | return log_return_error("Couldn't connect to the internet.") 120 | end 121 | end 122 | 123 | function Api:callApiWhenOnline(sink, method, path, query, body, headers, no_auth) 124 | local target_url = self:buildUrl(path, query) 125 | logger.dbg("Readeck API: Sending " .. method .. " " .. target_url) 126 | 127 | headers = headers or {} 128 | if not headers.Authorization and not no_auth then 129 | headers.Authorization = "Bearer " .. self:getSetting("api_token") 130 | end 131 | 132 | local source = body 133 | if type(body) == "table" then 134 | -- Convert body to JSON 135 | -- TODO check if this is still compatible with rapidjson (was maed for "luajson") 136 | local bodyJson = rapidjson.encode(body) 137 | logger.dbg("JSON: ", bodyJson) 138 | source = ltn12.source.string(bodyJson) 139 | 140 | headers["Content-type"] = "application/json" 141 | headers["Content-Length"] = tostring(#bodyJson) 142 | end 143 | 144 | local success, error, code, header = pcall(http.request, { 145 | url = target_url, 146 | method = method, 147 | headers = headers, 148 | sink = sink, 149 | source = source, 150 | }) 151 | 152 | if not success then 153 | return log_return_error("socket.http error: " .. error) 154 | elseif type(code) ~= "number" then 155 | return log_return_error(code or _ "Unknown error") 156 | elseif code >= 400 then 157 | return log_return_error("Status code " .. code) 158 | else 159 | return header 160 | end 161 | end 162 | 163 | function Api:callDownloadApi(file, method, path, query, body, headers, no_auth) 164 | local sink = ltn12.sink.file(io.open(file, "wb")) 165 | return self:callApi(sink, method, path, query, body, headers, no_auth) 166 | end 167 | 168 | --- 169 | -- @return Lua table parsed from response JSON, or nil 170 | -- @return The response headers, or error message 171 | function Api:callJsonApi(method, path, query, body, headers, no_auth) 172 | headers = headers or {} 173 | headers["Accept"] = "application/json" 174 | 175 | local response_data = {} 176 | local sink = ltn12.sink.table(response_data) 177 | 178 | local resp_headers, err = self:callApi(sink, method, path, query, body, headers, no_auth) 179 | 180 | local content = table.concat(response_data, "") 181 | logger.dbg("Readeck API response: " .. content) 182 | 183 | -- TODO check if this is still compatible with rapidjson (was made for "luajson") 184 | local json_ok, json_result = pcall(rapidjson.decode, content) 185 | 186 | -- Even if the API call fails (returns > 400), we might still want the response JSON 187 | if not resp_headers then 188 | return nil, 189 | err .. (json_result and json_result.message and T(" (%1)", json_result.message) or ""), 190 | json_result 191 | end 192 | 193 | if json_ok then 194 | -- Empty JSON responses return nil, but we'd want an empty table 195 | return json_result or {}, resp_headers 196 | else 197 | return log_return_error("Failed to parse JSON in response: " .. tostring(json_result)) 198 | end 199 | end 200 | 201 | -------======= Concrete API functions =======------- 202 | 203 | -- -- User Profile 204 | 205 | --- See https://your.readeck/docs/api#post-/auth 206 | function Api:authenticate(username, password) 207 | if not username or not password or username == "" or password == "" then 208 | return nil, "Please provide both username and password." 209 | end 210 | 211 | -- Get my hostname for more informative API token name 212 | local hostname 213 | local cmd_out, err, err_code = io.popen("hostname") 214 | if cmd_out then 215 | hostname = cmd_out:read("*l") 216 | cmd_out:close() 217 | else 218 | logger.dbg("Readeck: 'hostname' command failed: " .. err .. " (" .. tostring(err_code) .. ")") 219 | end 220 | 221 | -- Request API token creation 222 | local body = { 223 | application = "readeck.koplugin" .. (hostname and (" @ " .. hostname) or ""), 224 | username = username, 225 | password = password, 226 | roles = { "scoped_bookmarks_r", "scoped_bookmarks_w" } 227 | } 228 | local result, err, err_json = self:callJsonApi("POST", "/auth", nil, body, nil, true) 229 | if not result then 230 | return result, err_json and err_json.message or err 231 | end 232 | 233 | if result.token then 234 | self.settings:saveSetting("api_token", result.token) 235 | end 236 | return result.token 237 | end 238 | 239 | --- See https://your.readeck/docs/api#get-/profile 240 | function Api:userProfile() 241 | return self:callJsonApi("GET", "/profile") 242 | end 243 | 244 | -- -- Bookmarks 245 | 246 | --- See https://your.readeck/docs/api#get-/bookmarks 247 | function Api:bookmarkList(query, cache_entry) 248 | -- TODO define limits and pagination? 249 | local result, err = self:callJsonApi("GET", "/bookmarks", query) 250 | if result and cache_entry then 251 | self.cache:cacheBookmarkList(cache_entry, result) 252 | elseif cache_entry then 253 | logger.dbg("ReadeckApi:bookmarkList() : Couldn't fetch bookmark list. Loading from cache entry:", cache_entry) 254 | result = self.cache:getCachedBookmarksFromList(cache_entry) 255 | end 256 | return result, err 257 | end 258 | 259 | --- See https://your.readeck/docs/api#post-/bookmarks 260 | -- @return The new bookmark's id, or nil 261 | -- @return nil, or error message 262 | function Api:bookmarkCreate(bookmark_url, title, labels) 263 | local response, headers = self:callJsonApi("POST", "/bookmarks", {}, { 264 | url = bookmark_url, 265 | title = #title ~= 0 and title or nil, 266 | labels = #labels ~= 0 and labels or nil, 267 | }) 268 | if not response or not headers then 269 | return response, headers 270 | end 271 | 272 | logger.dbg("Readeck: Bookmark created:", tostring(headers["bookmark-id"])) 273 | return headers["bookmark-id"] 274 | end 275 | 276 | --- See http://your.readeck/docs/api#get-/bookmarks/-id- 277 | -- @return A table with the bookmark's details 278 | function Api:bookmarkDetails(id) 279 | return self:callJsonApi("GET", "/bookmarks/" .. id) 280 | end 281 | 282 | -- TODO bookmarkDelete 283 | -- TODO bookmarkUpdate 284 | 285 | -- TODO bookmarkArticle? 286 | 287 | --- See https://your.readeck/docs/api#get-/bookmarks/-id-/article.-format- 288 | -- @return Response header, or nil 289 | -- @return nil, or error message 290 | function Api:bookmarkExport(file, id) 291 | return self:callDownloadApi(file, "GET", "/bookmarks/" .. id .. "/article.epub", nil, nil, 292 | { ["Accept"] = "application/epub+zip" }) 293 | end 294 | 295 | -- -- Labels 296 | 297 | --- See https://your.readeck/docs/api#get-/bookmarks/labels 298 | function Api:labelList() 299 | local result, err = self:callJsonApi("GET", "/bookmarks/labels") 300 | if result then 301 | self.cache:cacheLabelList(result) 302 | else 303 | logger.dbg("ReadeckApi:labelList() : Couldn't fetch label list. Loading cache entry.") 304 | result = self.cache:getCachedLabelList() 305 | end 306 | return result, err 307 | end 308 | 309 | -- TODO labelInfo 310 | -- TODO labelDelete 311 | -- TODO labelUpdate 312 | 313 | 314 | -- -- Highlights 315 | -- TODO highlightList 316 | -- TODO bookmarkHighlights 317 | -- TODO highlightCreate 318 | -- TODO highlightDelete 319 | -- TODO highlightUpdate 320 | 321 | 322 | -- -- Collections 323 | 324 | --- See https://your.readeck/docs/api#get-/bookmarks/collections 325 | function Api:collectionList() 326 | -- TODO define limits and pagination? 327 | local result, err = self:callJsonApi("GET", "/bookmarks/collections") 328 | if result then 329 | self.cache:cacheCollectionList(result) 330 | else 331 | logger.dbg("ReadeckApi:collectionList() : Couldn't fetch collection list. Loading cache entry.") 332 | result = self.cache:getCachedCollectionList() 333 | end 334 | return result, err 335 | end 336 | 337 | -- TODO collectionCreate 338 | 339 | --- See https://your.readeck/docs/api#get-/bookmarks/collections/-id- 340 | function Api:collectionDetails(id) 341 | return self:callJsonApi("GET", "/bookmarks/collections/" .. id) 342 | end 343 | 344 | -- TODO collectionDelete 345 | -- TODO collectionUpdate 346 | 347 | 348 | -------======= Other functions =======------- 349 | 350 | function Api:getDownloadDir() 351 | return self:getSetting("data_dir") .. "/downloaded" 352 | end 353 | 354 | function Api:getBookmarkFilename(bookmark) 355 | return self:getDownloadDir() .. "/" .. util.getSafeFilename(bookmark.id .. ".epub") 356 | end 357 | 358 | function Api:bookmarkDownloaded(bookmark) 359 | return util.fileExists(self:getBookmarkFilename(bookmark)) 360 | end 361 | 362 | -- From https://forums.solar2d.com/t/convert-string-to-date/309743/2 363 | local function makeTimeStamp(dateString) 364 | -- 2025-04-20T11:19:34.431815474Z 365 | local year, month, day, hour, minute, seconds, offset, offsethour, offsetmin = 366 | dateString:match("(%d+)%-(%d+)%-(%d+)T(%d+):(%d+):(%d+).%d+([%+%-])(%d+)%:(%d+)") 367 | local offsetTimestamp 368 | if year then 369 | offsetTimestamp = offsethour * 60 + offsetmin 370 | if offset == "-" then offsetTimestamp = offsetTimestamp * -1 end 371 | else 372 | year, month, day, hour, minute, seconds = 373 | dateString:match("(%d+)%-(%d+)%-(%d+)T(%d+):(%d+):(%d+).%d+Z") 374 | offsetTimestamp = 0 375 | end 376 | local convertedTimestamp = os.time({ 377 | year = year, 378 | month = month, 379 | day = day, 380 | hour = hour, 381 | min = minute, 382 | sec = seconds 383 | }) 384 | return convertedTimestamp + offsetTimestamp 385 | end 386 | 387 | function Api:applyBookmarkDetails(bookmark) 388 | if not self:bookmarkDownloaded(bookmark) then 389 | return nil, "Bookmark not downloaded" 390 | end 391 | 392 | -- TODO apply reading progress and title 393 | end 394 | 395 | function Api:uploadBookmarkDetails(bookmark) 396 | if not self:bookmarkDownloaded(bookmark) then 397 | return nil, "Bookmark not downloaded" 398 | end 399 | 400 | -- TODO upload reading progress and title 401 | end 402 | 403 | -- TODO function not tested 404 | function Api:syncBookmarkDetails(bookmark) 405 | if not self:bookmarkDownloaded(bookmark) then 406 | return nil, "Bookmark not downloaded" 407 | end 408 | 409 | local file = self:getBookmarkFilename(bookmark) 410 | local localtime, err = lfs.attributes(file, 'modification') 411 | if err then 412 | logger.dbg("LFS: " .. err) 413 | return nil, err 414 | end 415 | 416 | local ok, result = pcall(makeTimeStamp, bookmark.updated) 417 | if not ok then 418 | logger.dbg("Error making timestamp: " .. result) 419 | return nil, result 420 | end 421 | local remotetime = result 422 | 423 | if localtime > remotetime then 424 | return self:uploadBookmarkDetails(bookmark) 425 | else 426 | return self:applyBookmarkDetails(bookmark) 427 | end 428 | end 429 | 430 | --- Shortcut for bookmarkExport with a properly named file 431 | -- @return the filepath, or nil 432 | -- @return true if already downloaded, or error message 433 | function Api:downloadBookmark(bookmark) 434 | local file = self:getBookmarkFilename(bookmark) 435 | if util.fileExists(file) then 436 | return file, true 437 | end 438 | 439 | util.makePath(self:getDownloadDir()) 440 | 441 | local result, err = self:callDownloadApi(file, "GET", "/bookmarks/" .. bookmark.id .. "/article.epub", 442 | nil, nil, { ["Accept"] = "application/epub+zip" }) 443 | if result then 444 | self:applyBookmarkDetails(bookmark) 445 | return file, false 446 | else 447 | util.removeFile(file) 448 | return result, err 449 | end 450 | end 451 | 452 | return Api 453 | -------------------------------------------------------------------------------- /LICENCE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 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 Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------