├── .github ├── ISSUE_TEMPLATE │ ├── bug_report.md │ ├── config.yml │ ├── documentation-request.md │ └── feature_request.md ├── PULL_REQUEST_TEMPLATE.md └── workflows │ └── build.yml ├── .gitignore ├── LICENSE ├── README.md ├── calibre_plugin ├── __init__.py ├── about.txt ├── config.py ├── image │ └── opds_client_icon.png ├── main.py ├── model.py ├── plugin-import-name-opds_client.txt └── ui.py └── tox.ini /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: File a report to help us reproduce and fix the problem 4 | title: '' 5 | labels: 'Type: Bug' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To reproduce** 14 | A clear, step-by-step set of instructions to reproduce the bug. 15 | 16 | **Expected behavior** 17 | A clear and concise description of what you expected to happen. 18 | 19 | **Logs or screenshots** 20 | If applicable, add logs or screenshots to help explain your problem. 21 | 22 | **System information** 23 | A description of your system, including: 24 | - Plugin version 25 | - Calibre version 26 | - Operating system 27 | - Any other relevant information 28 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/documentation-request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Documentation request 3 | about: Request improved documentation 4 | title: '' 5 | labels: 'Type: Documentation' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **What did you find confusing? Please describe.** 11 | A clear and concise description of what you found confusing. Ex. I tried to [...] but I didn't understand how to [...] 12 | 13 | **Describe how documentation can be improved** 14 | A clear and concise description of where documentation was lacking and how it can be improved. 15 | 16 | **Additional context** 17 | Add any other context or screenshots about the documentation request here. 18 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an improvement to this package 4 | title: '' 5 | labels: 'Type: Enhancement' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the feature you'd like** 11 | A clear and concise description of the functionality you want. 12 | 13 | **How would this feature be used? Please describe.** 14 | A clear and concise description of the use case for this feature. Please provide an example, if possible. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | 22 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | *Issue #, if available:* 2 | 3 | *Description of changes:* 4 | 5 | *Testing done:* 6 | 7 | By submitting this pull request, I confirm that my contribution is made under the terms of the GNU General Public License v3.0. 8 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | # This workflow will install Python dependencies, run tests and lint with a variety of Python versions 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions 3 | 4 | name: build 5 | 6 | on: 7 | push: 8 | branches: [ master ] 9 | pull_request: 10 | branches: [ master ] 11 | 12 | jobs: 13 | build: 14 | 15 | runs-on: ubuntu-latest 16 | strategy: 17 | matrix: 18 | python-version: [3.8] 19 | 20 | steps: 21 | - uses: actions/checkout@v2 22 | - name: Set up Python ${{ matrix.python-version }} 23 | uses: actions/setup-python@v2 24 | with: 25 | python-version: ${{ matrix.python-version }} 26 | - name: Run linters 27 | run: | 28 | python -m pip install --upgrade pip 29 | pip install tox 30 | tox -e flake8,black-check 31 | - name: Build and install plugin 32 | run: | 33 | sudo -v && wget -nv -O- https://download.calibre-ebook.com/linux-installer.sh | sudo sh /dev/stdin 34 | cd calibre_plugin 35 | calibre-customize -b . 36 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | 131 | # PyCharm 132 | .idea 133 | 134 | # artifact directories 135 | /downloaded_files/ 136 | -------------------------------------------------------------------------------- /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 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Calibre OPDS Client 2 | 3 | [![build](https://github.com/goodlibs/calibre-opds-client/workflows/build/badge.svg)](https://github.com/goodlibs/calibre-opds-client/actions?query=workflow%3Abuild) [![Code Style: Black](https://img.shields.io/badge/code_style-black-000000.svg)](https://github.com/python/black) 4 | 5 | Download books from an OPDS catalog using a Calibre plugin. 6 | 7 | ## :books: Background 8 | 9 | [Calibre](https://calibre-ebook.com) is a cross-platform open-source suite of e-book software. 10 | Calibre supports organizing existing e-books into virtual libraries, displaying, editing, creating and converting e-books, as well as syncing e-books with a variety of e-readers. 11 | 12 | The [Open Publication Distribution System](https://en.wikipedia.org/wiki/Open_Publication_Distribution_System) (OPDS) catalog format is a syndication format for electronic publications based on Atom and HTTP. 13 | OPDS catalogs enable the aggregation, distribution, discovery, and acquisition of electronic publications. 14 | 15 | The **Calibre OPDS Client** is a Calibre plugin that reads from an OPDS server and downloads the contents to a Calibre library. 16 | 17 | ## :hammer_and_wrench: Installation 18 | 19 | 1. Ensure [Calibre](https://calibre-ebook.com/download) is installed on your machine and the [command line tools](https://manual.calibre-ebook.com/generated/en/cli-index.html) are available in your search path. 20 | 21 | 1. Install the plugin. 22 | ```bash 23 | cd calibre_plugin 24 | calibre-customize -b . 25 | ``` 26 | 27 | 1. Restart Calibre. 28 | 29 | 1. Add the plugin to the main toolbar. 30 | 1. Open the Preferences menu. 31 | 1. Under the `Interface` section, click on the button labeled `Toolbars & menus`. 32 | 1. Click the dropdown menu and select `The main toolbar`. 33 | 1. Select `OPDS Client` under `Available actions` on the left side. 34 | 1. Click the right arrow (`>`) to add it to the main toolbar. 35 | 1. Click `Apply`, then `Close` the Preferences menu. 36 | 37 | ## :computer: Usage 38 | 39 | ### Download books from an external OPDS catalog 40 | 41 | ``` 42 | https://standardebooks.org/opds 43 | ``` 44 | 45 | ### Replicate a book collection between two computers on a LAN 46 | 47 | 1. In the calibre you wish to copy from (in this example called 48 | calibre1.home.lan): 49 | 1. Click Preferences 50 | 2. In the "calibre - Preferences" dialog: 51 | 1. Click "Sharing over the net" 52 | 2. In the "calibre - Preferences - Sharing over the net" 53 | dialog: 54 | 1. Click the "Start Server" button 55 | 2. Select the checkbox "Run server automatically when 56 | calibre starts" 57 | 3. Click the "Apply" button 58 | 3. Click the "close" button 59 | 2. In the calibre you wish to copy to 60 | 1. Install this plugin (see the "How do I install it?" section) 61 | 2. Click the "OPDS client" button 62 | 3. In the "OPDS client" dialog 63 | 1. Edit the "OPDS URL" value, change 64 | 65 | ``` example 66 | http://localhost:8080/opds 67 | ``` 68 | 69 | to 70 | 71 | ``` example 72 | http://calibre1.home.lan:8080/opds 73 | ``` 74 | 75 | and then press the RETURN key on the keyboard 76 | 77 | 2. Click the "Download OPDS" button 78 | 79 | 3. Wait until the OPDS feed has finished loading (this may take 80 | some time if there is a large number of books to load) 81 | 82 | - Note: if no books appear, try unchecking the "Hide books 83 | already in the library" checkbox. If that makes a lot of 84 | books appear, it means that the two calibre instances 85 | have the same books 86 | 87 | 4. select the books you wish to copy into the current calibre 88 | and click the "Download selected books" 89 | 90 | - calibre will start downloading and installing the books: 91 | - The Jobs counter in calibre's lower right corner, 92 | will show a decrementing number and the icon will 93 | spin 94 | - The book list will be updated as the books are 95 | downloaded 96 | 97 | 5. The downloaded books will be in approximately the same order 98 | as in the original, but the time stamp will be the download 99 | time. To fix the time stamp, click on the "Fix timestamps of 100 | the selection" button 101 | 102 | - The updated timestamps may not show up immediately, but 103 | they will show up after the first update of the display, 104 | and the books will be ordered according to the timestamp 105 | after stopping and starting calibre 106 | 107 | ## :balance_scale: License 108 | 109 | This code is licensed under the GNU General Public License v3.0. 110 | For more details, please take a look at the [LICENSE](https://github.com/goodlibs/calibre-opds-client/blob/master/LICENSE) file. 111 | 112 | ## :handshake: Contributing 113 | 114 | Contributions are welcome! 115 | Please feel free to open an issue or submit a pull request. 116 | -------------------------------------------------------------------------------- /calibre_plugin/__init__.py: -------------------------------------------------------------------------------- 1 | """main.py: A calibre plugin containing an OPDS client""" 2 | 3 | __author__ = "Steinar Bang" 4 | __copyright__ = "Steinar Bang, 2015" 5 | __credits__ = ["Steinar Bang"] 6 | __license__ = "GPL v3" 7 | 8 | from calibre.customize import InterfaceActionBase 9 | 10 | 11 | class OpdsClient(InterfaceActionBase): 12 | """ 13 | An OPDS client that can read the OPDS of a different calibre, 14 | and display the differences between this calibre and the other 15 | and download the missing books from the other calibre 16 | """ 17 | 18 | name = "OPDS Client" 19 | description = "Import from the OPDS catalog exported by a different calibre" 20 | supported_platforms = ["windows", "osx", "linux"] 21 | author = "Steinar Bang" 22 | version = (1, 0, 0) 23 | minimum_calibre_version = (2, 35, 0) 24 | 25 | actual_plugin = "calibre_plugins.opds_client.ui:OpdsInterfacePlugin" 26 | 27 | def is_customizable(self): 28 | return True 29 | 30 | def config_widget(self): 31 | from calibre_plugins.opds_client.config import ConfigWidget 32 | 33 | return ConfigWidget() 34 | 35 | def save_settings(self, config_widget): 36 | config_widget.save_settings() 37 | 38 | ac = self.actual_plugin_ 39 | if ac is not None: 40 | ac.apply_settings() 41 | -------------------------------------------------------------------------------- /calibre_plugin/about.txt: -------------------------------------------------------------------------------- 1 | This is a plugin that adds functionality to read the OPDS feed of a 2 | different Calibre and list and import books into this calibre. 3 | -------------------------------------------------------------------------------- /calibre_plugin/config.py: -------------------------------------------------------------------------------- 1 | """main.py: Configuration parameter GUI for a Calibre plugin that can read OPDS feeds""" 2 | 3 | __author__ = "Steinar Bang" 4 | __copyright__ = "Steinar Bang, 2015" 5 | __credits__ = ["Steinar Bang"] 6 | __license__ = "GPL v3" 7 | 8 | from PyQt5.Qt import QCheckBox, QComboBox, QGridLayout, QLabel, QWidget 9 | 10 | from calibre.utils.config import JSONConfig 11 | 12 | prefs = JSONConfig("plugins/opds_client") 13 | 14 | prefs.defaults["opds_url"] = ["http://localhost:8080/opds"] 15 | prefs.defaults["hideNewspapers"] = True 16 | prefs.defaults["hideBooksAlreadyInLibrary"] = True 17 | 18 | 19 | class ConfigWidget(QWidget): 20 | def __init__(self): 21 | QWidget.__init__(self) 22 | self.layout = QGridLayout() 23 | self.setLayout(self.layout) 24 | labelColumnWidths = [] 25 | 26 | self.opdsUrlLabel = QLabel("OPDS URL: ") 27 | self.layout.addWidget(self.opdsUrlLabel, 0, 0) 28 | labelColumnWidths.append(self.layout.itemAtPosition(0, 0).sizeHint().width()) 29 | 30 | print(type(prefs.defaults["opds_url"])) 31 | print(type(prefs["opds_url"])) 32 | convertSingleStringOpdsUrlPreferenceToListOfStringsPreference() 33 | self.opdsUrlEditor = QComboBox(self) 34 | self.opdsUrlEditor.addItems(prefs["opds_url"]) 35 | self.opdsUrlEditor.setEditable(True) 36 | self.opdsUrlEditor.setInsertPolicy(QComboBox.InsertAtTop) 37 | self.layout.addWidget(self.opdsUrlEditor, 0, 1) 38 | self.opdsUrlLabel.setBuddy(self.opdsUrlEditor) 39 | 40 | self.hideNewsCheckbox = QCheckBox("Hide Newspapers", self) 41 | self.hideNewsCheckbox.setChecked(prefs["hideNewspapers"]) 42 | self.layout.addWidget(self.hideNewsCheckbox, 1, 0) 43 | labelColumnWidths.append(self.layout.itemAtPosition(1, 0).sizeHint().width()) 44 | 45 | self.hideBooksAlreadyInLibraryCheckbox = QCheckBox("Hide books already in library", self) 46 | self.hideBooksAlreadyInLibraryCheckbox.setChecked(prefs["hideBooksAlreadyInLibrary"]) 47 | self.layout.addWidget(self.hideBooksAlreadyInLibraryCheckbox, 2, 0) 48 | labelColumnWidths.append(self.layout.itemAtPosition(2, 0).sizeHint().width()) 49 | 50 | labelColumnWidth = max(labelColumnWidths) 51 | self.layout.setColumnMinimumWidth(1, labelColumnWidth * 2) 52 | 53 | def save_settings(self): 54 | prefs["hideNewspapers"] = self.hideNewsCheckbox.isChecked() 55 | prefs["hideBooksAlreadyInLibrary"] = self.hideBooksAlreadyInLibraryCheckbox.isChecked() 56 | prefs["opds_url"] = saveOpdsUrlCombobox(self.opdsUrlEditor) 57 | 58 | 59 | def saveOpdsUrlCombobox(opdsUrlEditor): 60 | opdsUrls = [] 61 | print("item count: %d" % opdsUrlEditor.count()) 62 | for i in range(opdsUrlEditor.count()): 63 | print("item %d: %s" % (i, opdsUrlEditor.itemText(i))) 64 | opdsUrls.append(opdsUrlEditor.itemText(i)) 65 | # Move the selected item first in the list 66 | currentSelectedUrlIndex = opdsUrlEditor.currentIndex() 67 | if currentSelectedUrlIndex > 0: 68 | currentUrl = opdsUrls[currentSelectedUrlIndex] 69 | del opdsUrls[currentSelectedUrlIndex] 70 | opdsUrls.insert(0, currentUrl) 71 | return opdsUrls 72 | 73 | 74 | def convertSingleStringOpdsUrlPreferenceToListOfStringsPreference(): 75 | if type(prefs["opds_url"]) != type(prefs.defaults["opds_url"]): # noqa: E721 76 | # Upgrade config option from single string to list of strings 77 | originalUrl = prefs["opds_url"] 78 | prefs["opds_url"] = prefs.defaults["opds_url"] 79 | prefs["opds_url"].insert(0, originalUrl) 80 | -------------------------------------------------------------------------------- /calibre_plugin/image/opds_client_icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/goodlibs/calibre-opds-client/5f9da4693ebe61dd4f2e05380283c1728ce7fbb3/calibre_plugin/image/opds_client_icon.png -------------------------------------------------------------------------------- /calibre_plugin/main.py: -------------------------------------------------------------------------------- 1 | """main.py: A GUI to download an OPDS feed, filter out parts of the results, 2 | and download selected books from the feed into the local library""" 3 | 4 | __author__ = "Steinar Bang" 5 | __copyright__ = "Steinar Bang, 2015" 6 | __credits__ = ["Steinar Bang"] 7 | __license__ = "GPL v3" 8 | 9 | import datetime 10 | 11 | from PyQt5.Qt import ( 12 | QAbstractItemView, 13 | QCheckBox, 14 | QComboBox, 15 | QDialog, 16 | QGridLayout, 17 | QHeaderView, 18 | QLabel, 19 | QLineEdit, 20 | QMessageBox, 21 | QPushButton, 22 | QSortFilterProxyModel, 23 | QStringListModel, 24 | QTableView, 25 | Qt, 26 | ) 27 | 28 | from calibre.ebooks.metadata.book.base import Metadata 29 | 30 | from calibre_plugins.opds_client import config 31 | from calibre_plugins.opds_client.config import prefs 32 | from calibre_plugins.opds_client.model import OpdsBooksModel 33 | 34 | 35 | class DynamicBook(dict): 36 | pass 37 | 38 | 39 | class OpdsDialog(QDialog): 40 | def __init__(self, gui, icon, do_user_config): 41 | QDialog.__init__(self, gui) 42 | self.gui = gui 43 | self.do_user_config = do_user_config 44 | 45 | self.db = gui.current_db.new_api 46 | 47 | # The model for the book list 48 | self.model = OpdsBooksModel(None, self.dummy_books(), self.db) 49 | self.searchproxymodel = QSortFilterProxyModel(self) 50 | self.searchproxymodel.setFilterCaseSensitivity(Qt.CaseInsensitive) 51 | self.searchproxymodel.setFilterKeyColumn(-1) 52 | self.searchproxymodel.setSourceModel(self.model) 53 | 54 | self.layout = QGridLayout() 55 | self.setLayout(self.layout) 56 | 57 | self.setWindowTitle("OPDS Client") 58 | self.setWindowIcon(icon) 59 | 60 | labelColumnWidths = [] 61 | 62 | self.opdsUrlLabel = QLabel("OPDS URL: ") 63 | self.layout.addWidget(self.opdsUrlLabel, 0, 0) 64 | labelColumnWidths.append(self.layout.itemAtPosition(0, 0).sizeHint().width()) 65 | 66 | config.convertSingleStringOpdsUrlPreferenceToListOfStringsPreference() 67 | self.opdsUrlEditor = QComboBox(self) 68 | self.opdsUrlEditor.activated.connect(self.opdsUrlEditorActivated) 69 | self.opdsUrlEditor.addItems(prefs["opds_url"]) 70 | self.opdsUrlEditor.setEditable(True) 71 | self.opdsUrlEditor.setInsertPolicy(QComboBox.InsertAtTop) 72 | self.layout.addWidget(self.opdsUrlEditor, 0, 1, 1, 3) 73 | self.opdsUrlLabel.setBuddy(self.opdsUrlEditor) 74 | 75 | buttonColumnNumber = 7 76 | buttonColumnWidths = [] 77 | self.about_button = QPushButton("About", self) 78 | self.about_button.setAutoDefault(False) 79 | self.about_button.clicked.connect(self.about) 80 | self.layout.addWidget(self.about_button, 0, buttonColumnNumber) 81 | buttonColumnWidths.append( 82 | self.layout.itemAtPosition(0, buttonColumnNumber).sizeHint().width() 83 | ) 84 | 85 | # Initially download the catalogs found in the root catalog of the URL 86 | # selected at startup. Fail quietly on failing to open the URL 87 | catalogsTuple = self.model.downloadOpdsRootCatalog( 88 | self.gui, self.opdsUrlEditor.currentText(), False 89 | ) 90 | print(catalogsTuple) 91 | firstCatalogTitle = catalogsTuple[0] 92 | self.currentOpdsCatalogs = catalogsTuple[1] # A dictionary of title->feedURL 93 | 94 | self.opdsCatalogSelectorLabel = QLabel("OPDS Catalog:") 95 | self.layout.addWidget(self.opdsCatalogSelectorLabel, 1, 0) 96 | labelColumnWidths.append(self.layout.itemAtPosition(1, 0).sizeHint().width()) 97 | 98 | self.opdsCatalogSelector = QComboBox(self) 99 | self.opdsCatalogSelector.setEditable(False) 100 | self.opdsCatalogSelectorModel = QStringListModel(self.currentOpdsCatalogs.keys()) 101 | self.opdsCatalogSelector.setModel(self.opdsCatalogSelectorModel) 102 | self.opdsCatalogSelector.setCurrentText(firstCatalogTitle) 103 | self.layout.addWidget(self.opdsCatalogSelector, 1, 1, 1, 3) 104 | 105 | self.download_opds_button = QPushButton("Download OPDS", self) 106 | self.download_opds_button.setAutoDefault(False) 107 | self.download_opds_button.clicked.connect(self.download_opds) 108 | self.layout.addWidget(self.download_opds_button, 1, buttonColumnNumber) 109 | buttonColumnWidths.append( 110 | self.layout.itemAtPosition(1, buttonColumnNumber).sizeHint().width() 111 | ) 112 | 113 | # Search GUI 114 | self.searchEditor = QLineEdit(self) 115 | self.searchEditor.returnPressed.connect(self.searchBookList) 116 | self.layout.addWidget(self.searchEditor, 2, buttonColumnNumber - 2, 1, 2) 117 | 118 | self.searchButton = QPushButton("Search", self) 119 | self.searchButton.setAutoDefault(False) 120 | self.searchButton.clicked.connect(self.searchBookList) 121 | self.layout.addWidget(self.searchButton, 2, buttonColumnNumber) 122 | buttonColumnWidths.append( 123 | self.layout.itemAtPosition(2, buttonColumnNumber).sizeHint().width() 124 | ) 125 | 126 | # The main book list 127 | self.library_view = QTableView(self) 128 | self.library_view.setAlternatingRowColors(True) 129 | self.library_view.setModel(self.searchproxymodel) 130 | self.library_view.horizontalHeader().setSectionResizeMode(0, QHeaderView.Stretch) 131 | self.library_view.horizontalHeader().setSectionResizeMode(1, QHeaderView.Stretch) 132 | self.library_view.horizontalHeader().setSectionResizeMode(2, QHeaderView.Stretch) 133 | self.library_view.setSelectionBehavior(QAbstractItemView.SelectRows) 134 | self.resizeAllLibraryViewLinesToHeaderHeight() 135 | self.library_view.resizeColumnsToContents() 136 | self.layout.addWidget(self.library_view, 3, 0, 3, buttonColumnNumber + 1) 137 | 138 | self.hideNewsCheckbox = QCheckBox("Hide Newspapers", self) 139 | self.hideNewsCheckbox.clicked.connect(self.setHideNewspapers) 140 | self.hideNewsCheckbox.setChecked(prefs["hideNewspapers"]) 141 | self.layout.addWidget(self.hideNewsCheckbox, 6, 0, 1, 3) 142 | 143 | self.hideBooksAlreadyInLibraryCheckbox = QCheckBox("Hide books already in library", self) 144 | self.hideBooksAlreadyInLibraryCheckbox.clicked.connect(self.setHideBooksAlreadyInLibrary) 145 | self.hideBooksAlreadyInLibraryCheckbox.setChecked(prefs["hideBooksAlreadyInLibrary"]) 146 | self.layout.addWidget(self.hideBooksAlreadyInLibraryCheckbox, 7, 0, 1, 3) 147 | 148 | # Let the checkbox initial state control the filtering 149 | self.model.setFilterBooksThatAreNewspapers(self.hideNewsCheckbox.isChecked()) 150 | self.model.setFilterBooksThatAreAlreadyInLibrary( 151 | self.hideBooksAlreadyInLibraryCheckbox.isChecked() 152 | ) 153 | 154 | self.downloadButton = QPushButton("Download selected books", self) 155 | self.downloadButton.setAutoDefault(False) 156 | self.downloadButton.clicked.connect(self.downloadSelectedBooks) 157 | self.layout.addWidget(self.downloadButton, 6, buttonColumnNumber) 158 | buttonColumnWidths.append( 159 | self.layout.itemAtPosition(6, buttonColumnNumber).sizeHint().width() 160 | ) 161 | 162 | self.fixTimestampButton = QPushButton("Fix timestamps of selection", self) 163 | self.fixTimestampButton.setAutoDefault(False) 164 | self.fixTimestampButton.clicked.connect(self.fixBookTimestamps) 165 | self.layout.addWidget(self.fixTimestampButton, 7, buttonColumnNumber) 166 | buttonColumnWidths.append( 167 | self.layout.itemAtPosition(7, buttonColumnNumber).sizeHint().width() 168 | ) 169 | 170 | # Make all columns of the grid layout the same width as the button column 171 | buttonColumnWidth = max(buttonColumnWidths) 172 | for columnNumber in range(0, buttonColumnNumber): 173 | self.layout.setColumnMinimumWidth(columnNumber, buttonColumnWidth) 174 | 175 | # Make sure the first column isn't wider than the labels it holds 176 | labelColumnWidth = max(labelColumnWidths) 177 | self.layout.setColumnMinimumWidth(0, labelColumnWidth) 178 | 179 | self.resize(self.sizeHint()) 180 | 181 | def opdsUrlEditorActivated(self, text): 182 | prefs["opds_url"] = config.saveOpdsUrlCombobox(self.opdsUrlEditor) 183 | catalogsTuple = self.model.downloadOpdsRootCatalog( 184 | self.gui, self.opdsUrlEditor.currentText(), True 185 | ) 186 | firstCatalogTitle = catalogsTuple[0] 187 | self.currentOpdsCatalogs = catalogsTuple[1] # A dictionary of title->feedURL 188 | self.opdsCatalogSelectorModel.setStringList(self.currentOpdsCatalogs.keys()) 189 | self.opdsCatalogSelector.setCurrentText(firstCatalogTitle) 190 | 191 | def setHideNewspapers(self, checked): 192 | prefs["hideNewspapers"] = checked 193 | self.model.setFilterBooksThatAreNewspapers(checked) 194 | self.resizeAllLibraryViewLinesToHeaderHeight() 195 | 196 | def setHideBooksAlreadyInLibrary(self, checked): 197 | prefs["hideBooksAlreadyInLibrary"] = checked 198 | self.model.setFilterBooksThatAreAlreadyInLibrary(checked) 199 | self.resizeAllLibraryViewLinesToHeaderHeight() 200 | 201 | def searchBookList(self): 202 | searchString = self.searchEditor.text() 203 | print("starting book list search for: %s" % searchString) 204 | self.searchproxymodel.setFilterFixedString(searchString) 205 | 206 | def about(self): 207 | text = get_resources("about.txt") 208 | QMessageBox.about(self, "About the OPDS Client plugin", text.decode("utf-8")) 209 | 210 | def download_opds(self): 211 | opdsCatalogUrl = self.currentOpdsCatalogs.get(self.opdsCatalogSelector.currentText(), None) 212 | if opdsCatalogUrl is None: 213 | # Just give up quietly 214 | return 215 | self.model.downloadOpdsCatalog(self.gui, opdsCatalogUrl) 216 | if self.model.isCalibreOpdsServer(): 217 | self.model.downloadMetadataUsingCalibreRestApi(self.opdsUrlEditor.currentText()) 218 | self.library_view.horizontalHeader().setSectionResizeMode(0, QHeaderView.Stretch) 219 | self.library_view.horizontalHeader().setSectionResizeMode(1, QHeaderView.Stretch) 220 | self.library_view.horizontalHeader().setSectionResizeMode(2, QHeaderView.Stretch) 221 | self.resizeAllLibraryViewLinesToHeaderHeight() 222 | self.resize(self.sizeHint()) 223 | 224 | def config(self): 225 | self.do_user_config(parent=self) 226 | 227 | def downloadSelectedBooks(self): 228 | selectionmodel = self.library_view.selectionModel() 229 | if selectionmodel.hasSelection(): 230 | rows = selectionmodel.selectedRows() 231 | for row in reversed(rows): 232 | book = row.data(Qt.UserRole) 233 | self.downloadBook(book) 234 | 235 | def downloadBook(self, book): 236 | if len(book.links) > 0: 237 | self.gui.download_ebook(book.links[0]) 238 | 239 | def fixBookTimestamps(self): 240 | selectionmodel = self.library_view.selectionModel() 241 | if selectionmodel.hasSelection(): 242 | rows = selectionmodel.selectedRows() 243 | for row in reversed(rows): 244 | book = row.data(Qt.UserRole) 245 | self.fixBookTimestamp(book) 246 | 247 | def fixBookTimestamp(self, book): 248 | bookTimestamp = book.timestamp 249 | identicalBookIds = self.findIdenticalBooksForBooksWithMultipleAuthors(book) 250 | bookIdToValMap = {} 251 | for identicalBookId in identicalBookIds: 252 | bookIdToValMap[identicalBookId] = bookTimestamp 253 | if len(bookIdToValMap) < 1: 254 | print("Failed to set timestamp of book: %s" % book) 255 | self.db.set_field("timestamp", bookIdToValMap) 256 | 257 | def findIdenticalBooksForBooksWithMultipleAuthors(self, book): 258 | authorsList = book.authors 259 | if len(authorsList) < 2: 260 | return self.db.find_identical_books(book) 261 | # Try matching the authors one by one 262 | identicalBookIds = set() 263 | for author in authorsList: 264 | singleAuthorBook = Metadata(book.title, [author]) 265 | singleAuthorIdenticalBookIds = self.db.find_identical_books(singleAuthorBook) 266 | identicalBookIds = identicalBookIds.union(singleAuthorIdenticalBookIds) 267 | return identicalBookIds 268 | 269 | def dummy_books(self): 270 | dummy_author = " " * 40 271 | dummy_title = " " * 60 272 | books_list = [] 273 | for line in range(1, 10): 274 | book = DynamicBook() 275 | book.author = dummy_author 276 | book.title = dummy_title 277 | book.updated = datetime.datetime.now().strftime("%Y-%m-%dT%H:%M:%S+00:00") 278 | book.id = "" 279 | books_list.append(book) 280 | return books_list 281 | 282 | def resizeAllLibraryViewLinesToHeaderHeight(self): 283 | rowHeight = self.library_view.horizontalHeader().height() 284 | for rowNumber in range(0, self.library_view.model().rowCount()): 285 | self.library_view.setRowHeight(rowNumber, rowHeight) 286 | -------------------------------------------------------------------------------- /calibre_plugin/model.py: -------------------------------------------------------------------------------- 1 | """model.py: This is a QAbstractTableModel that holds a list of Metadata objects created from books in an OPDS feed""" 2 | 3 | __author__ = "Steinar Bang" 4 | __copyright__ = "Steinar Bang, 2015" 5 | __credits__ = ["Steinar Bang"] 6 | __license__ = "GPL v3" 7 | 8 | import datetime 9 | import json 10 | import re 11 | import urllib2 12 | import urlparse 13 | 14 | from PyQt5.Qt import QAbstractTableModel, QCoreApplication, Qt 15 | 16 | from calibre.ebooks.metadata.book.base import Metadata 17 | from calibre.gui2 import error_dialog 18 | from calibre.web.feeds import feedparser 19 | 20 | 21 | class OpdsBooksModel(QAbstractTableModel): 22 | column_headers = [_("Title"), _("Author(s)"), _("Updated")] 23 | booktableColumnCount = 3 24 | filterBooksThatAreNewspapers = False 25 | filterBooksThatAreAlreadyInLibrary = False 26 | 27 | def __init__(self, parent, books=[], db=None): 28 | QAbstractTableModel.__init__(self, parent) 29 | self.db = db 30 | self.books = self.makeMetadataFromParsedOpds(books) 31 | self.filterBooks() 32 | 33 | def headerData(self, section, orientation, role): 34 | if role != Qt.DisplayRole: 35 | return None 36 | if orientation == Qt.Vertical: 37 | return section + 1 38 | if section >= len(self.column_headers): 39 | return None 40 | return self.column_headers[section] 41 | 42 | def rowCount(self, parent): 43 | return len(self.filteredBooks) 44 | 45 | def columnCount(self, parent): 46 | return self.booktableColumnCount 47 | 48 | def data(self, index, role): 49 | row, col = index.row(), index.column() 50 | if row >= len(self.filteredBooks): 51 | return None 52 | opdsBook = self.filteredBooks[row] 53 | if role == Qt.UserRole: 54 | # Return the Metadata object underlying each row 55 | return opdsBook 56 | if role != Qt.DisplayRole: 57 | return None 58 | if col >= self.booktableColumnCount: 59 | return None 60 | if col == 0: 61 | return opdsBook.title 62 | if col == 1: 63 | return u" & ".join(opdsBook.author) 64 | if col == 2: 65 | if opdsBook.timestamp is not None: 66 | return opdsBook.timestamp.strftime("%Y-%m-%d %H:%M:%S") 67 | return opdsBook.timestamp 68 | return None 69 | 70 | def downloadOpdsRootCatalog(self, gui, opdsUrl, displayDialogOnErrors): 71 | feed = feedparser.parse(opdsUrl) 72 | if "bozo_exception" in feed: 73 | exception = feed["bozo_exception"] 74 | message = "Failed opening the OPDS URL " + opdsUrl + ": " 75 | reason = "" 76 | if hasattr(exception, "reason"): 77 | reason = str(exception.reason) 78 | error_dialog( 79 | gui, _("Failed opening the OPDS URL"), message, reason, displayDialogOnErrors 80 | ) 81 | return (None, {}) 82 | self.serverHeader = feed.headers["server"] 83 | print("serverHeader: %s" % self.serverHeader) 84 | print("feed.entries: %s" % feed.entries) 85 | catalogEntries = {} 86 | firstTitle = None 87 | for entry in feed.entries: 88 | title = entry.get("title", "No title") 89 | if firstTitle is None: 90 | firstTitle = title 91 | links = entry.get("links", []) 92 | firstLink = next(iter(links), None) 93 | if firstLink is not None: 94 | print("firstLink: %s" % firstLink) 95 | catalogEntries[title] = firstLink.href 96 | return (firstTitle, catalogEntries) 97 | 98 | def downloadOpdsCatalog(self, gui, opdsCatalogUrl): 99 | print("downloading catalog: %s" % opdsCatalogUrl) 100 | opdsCatalogFeed = feedparser.parse(opdsCatalogUrl) 101 | self.books = self.makeMetadataFromParsedOpds(opdsCatalogFeed.entries) 102 | self.filterBooks() 103 | QCoreApplication.processEvents() 104 | nextUrl = self.findNextUrl(opdsCatalogFeed.feed) 105 | while nextUrl is not None: 106 | nextFeed = feedparser.parse(nextUrl) 107 | self.books = self.books + self.makeMetadataFromParsedOpds(nextFeed.entries) 108 | self.filterBooks() 109 | QCoreApplication.processEvents() 110 | nextUrl = self.findNextUrl(nextFeed.feed) 111 | 112 | def isCalibreOpdsServer(self): 113 | return self.serverHeader.startswith("calibre") 114 | 115 | def setFilterBooksThatAreAlreadyInLibrary(self, value): 116 | if value != self.filterBooksThatAreAlreadyInLibrary: 117 | self.filterBooksThatAreAlreadyInLibrary = value 118 | self.filterBooks() 119 | 120 | def setFilterBooksThatAreNewspapers(self, value): 121 | if value != self.filterBooksThatAreNewspapers: 122 | self.filterBooksThatAreNewspapers = value 123 | self.filterBooks() 124 | 125 | def filterBooks(self): 126 | self.beginResetModel() 127 | self.filteredBooks = [] 128 | for book in self.books: 129 | if (not self.isFilteredNews(book)) and (not self.isFilteredAlreadyInLibrary(book)): 130 | self.filteredBooks.append(book) 131 | self.endResetModel() 132 | 133 | def isFilteredNews(self, book): 134 | if self.filterBooksThatAreNewspapers: 135 | if u"News" in book.tags: 136 | return True 137 | return False 138 | 139 | def isFilteredAlreadyInLibrary(self, book): 140 | if self.filterBooksThatAreAlreadyInLibrary: 141 | return self.db.has_book(book) 142 | return False 143 | 144 | def makeMetadataFromParsedOpds(self, books): 145 | metadatalist = [] 146 | for book in books: 147 | metadata = self.opdsToMetadata(book) 148 | metadatalist.append(metadata) 149 | return metadatalist 150 | 151 | def opdsToMetadata(self, opdsBookStructure): 152 | authors = opdsBookStructure.author.replace(u"& ", u"&") 153 | metadata = Metadata(opdsBookStructure.title, authors.split(u"&")) 154 | metadata.uuid = opdsBookStructure.id.replace("urn:uuid:", "", 1) 155 | rawTimestamp = opdsBookStructure.updated 156 | parsableTimestamp = re.sub(r"((\.[0-9]+)?\+00:00|Z)$", "", rawTimestamp) 157 | metadata.timestamp = datetime.datetime.strptime(parsableTimestamp, "%Y-%m-%dT%H:%M:%S") 158 | tags = [] 159 | summary = opdsBookStructure.get(u"summary", u"") 160 | summarylines = summary.splitlines() 161 | for summaryline in summarylines: 162 | if summaryline.startswith(u"TAGS: "): 163 | tagsline = summaryline.replace(u"TAGS: ", u"") 164 | tagsline = tagsline.replace(u"
", u"") 165 | tagsline = tagsline.replace(u", ", u",") 166 | tags = tagsline.split(u",") 167 | metadata.tags = tags 168 | bookDownloadUrls = [] 169 | links = opdsBookStructure.get("links", []) 170 | for link in links: 171 | url = link.get("href", "") 172 | bookType = link.get("type", "") 173 | # Skip covers and thumbnails 174 | if not bookType.startswith("image/"): 175 | if bookType == "application/x-mobipocket-ebook": 176 | # azw3 books are preferred and always put at the head of the list if found 177 | bookDownloadUrls.insert(0, url) 178 | else: 179 | # Other formats are appended as they are found 180 | bookDownloadUrls.append(url) 181 | metadata.links = bookDownloadUrls 182 | return metadata 183 | 184 | def findNextUrl(self, feed): 185 | for link in feed.links: 186 | if link.rel == u"next": 187 | return link.href 188 | return None 189 | 190 | def downloadMetadataUsingCalibreRestApi(self, opdsUrl): 191 | # The "updated" values on the book metadata, in the OPDS returned 192 | # by calibre, are unrelated to the books they are returned with: 193 | # the "updated" value is the same value for all books metadata, 194 | # and this value is the last modified date of the entire calibre 195 | # database. 196 | # 197 | # It is therefore necessary to use the calibre REST API to get 198 | # a meaningful timestamp for the books 199 | 200 | # Get the base of the web server, from the OPDS URL 201 | parsedOpdsUrl = urlparse.urlparse(opdsUrl) 202 | 203 | # GET the search URL twice: the first time is to get the total number 204 | # of books in the other calibre. The second GET gets arguments 205 | # to retrieve all book ids in the other calibre. 206 | parsedCalibreRestSearchUrl = urlparse.ParseResult( 207 | parsedOpdsUrl.scheme, parsedOpdsUrl.netloc, "/ajax/search", "", "", "" 208 | ) 209 | calibreRestSearchUrl = parsedCalibreRestSearchUrl.geturl() 210 | calibreRestSearchResponse = urllib2.urlopen(calibreRestSearchUrl) 211 | calibreRestSearchJsonResponse = json.load(calibreRestSearchResponse) 212 | getAllIdsArgument = "num=" + str(calibreRestSearchJsonResponse["total_num"]) + "&offset=0" 213 | parsedCalibreRestSearchUrl = urlparse.ParseResult( 214 | parsedOpdsUrl.scheme, parsedOpdsUrl.netloc, "/ajax/search", "", getAllIdsArgument, "" 215 | ).geturl() 216 | calibreRestSearchResponse = urllib2.urlopen(parsedCalibreRestSearchUrl) 217 | calibreRestSearchJsonResponse = json.load(calibreRestSearchResponse) 218 | bookIds = map(str, calibreRestSearchJsonResponse["book_ids"]) 219 | 220 | # Get the metadata for all books by adding the list of 221 | # all IDs as a GET argument 222 | bookIdsGetArgument = "ids=" + ",".join(bookIds) 223 | parsedCalibreRestBooksUrl = urlparse.ParseResult( 224 | parsedOpdsUrl.scheme, parsedOpdsUrl.netloc, "/ajax/books", "", bookIdsGetArgument, "" 225 | ) 226 | calibreRestBooksResponse = urllib2.urlopen(parsedCalibreRestBooksUrl.geturl()) 227 | booksDictionary = json.load(calibreRestBooksResponse) 228 | self.updateTimestampInMetadata(bookIds, booksDictionary) 229 | 230 | def updateTimestampInMetadata(self, bookIds, booksDictionary): 231 | bookMetadataById = {} 232 | for bookId in bookIds: 233 | bookMetadata = booksDictionary[bookId] 234 | uuid = bookMetadata["uuid"] 235 | bookMetadataById[uuid] = bookMetadata 236 | for book in self.books: 237 | bookMetadata = bookMetadataById[book.uuid] 238 | rawTimestamp = bookMetadata["timestamp"] 239 | parsableTimestamp = re.sub(r"(\.[0-9]+)?\+00:00$", "", rawTimestamp) 240 | timestamp = datetime.datetime.strptime(parsableTimestamp, "%Y-%m-%dT%H:%M:%S") 241 | book.timestamp = timestamp 242 | self.filterBooks() 243 | -------------------------------------------------------------------------------- /calibre_plugin/plugin-import-name-opds_client.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/goodlibs/calibre-opds-client/5f9da4693ebe61dd4f2e05380283c1728ce7fbb3/calibre_plugin/plugin-import-name-opds_client.txt -------------------------------------------------------------------------------- /calibre_plugin/ui.py: -------------------------------------------------------------------------------- 1 | """main.py: GUI initialization for a Calibre plugin implementing an OPDS client""" 2 | 3 | __author__ = "Steinar Bang" 4 | __copyright__ = "Steinar Bang, 2015" 5 | __credits__ = ["Steinar Bang"] 6 | __license__ = "GPL v3" 7 | 8 | from calibre.gui2.actions import InterfaceAction 9 | 10 | from calibre_plugins.opds_client.main import OpdsDialog 11 | 12 | 13 | class OpdsInterfacePlugin(InterfaceAction): 14 | name = "OPDS Client Interface plugin" 15 | 16 | action_spec = ("OPDS Client", None, "Run the OPDS client UI", "Ctrl+Shift+F1") 17 | 18 | def genesis(self): 19 | icon = get_icons("image/opds_client_icon.png") 20 | self.qaction.setIcon(icon) 21 | self.qaction.triggered.connect(self.show_dialog) 22 | 23 | def show_dialog(self): 24 | base_plugin_object = self.interface_action_base_plugin 25 | do_user_config = base_plugin_object.do_user_config 26 | d = OpdsDialog(self.gui, self.qaction.icon(), do_user_config) 27 | d.show() 28 | 29 | def apply_settings(self): 30 | from config import prefs 31 | 32 | prefs 33 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | # Tox (http://tox.testrun.org/) is a tool for running tests 2 | # in multiple virtualenvs. This configuration file will run the 3 | # test suite on all supported Python versions. To use it, "pip install tox" 4 | # and then run "tox" from this directory. 5 | 6 | [tox] 7 | envlist = black-format,flake8 8 | 9 | skipsdist=True 10 | 11 | skip_missing_interpreters = False 12 | 13 | [flake8] 14 | max-line-length = 120 15 | exclude = 16 | build/ 17 | .git 18 | __pycache__ 19 | .tox 20 | venv/ 21 | 22 | max-complexity = 15 23 | 24 | ignore = 25 | E203, # whitespace before ':'. Black violates this. 26 | W503, # Ignore line break before binary operator. Black violates this. 27 | N802, # Ignore camelCase function names. Qt violates this. 28 | N803, # Ignore camelCase argument names. Qt violates this. 29 | N806, # Ignore camelCase variable names. Qt violates this. 30 | N815, # Ignore camelCase class variable names. Qt violates this. 31 | F821, # Temporarily ignore undefined names. 32 | 33 | [testenv] 34 | deps = 35 | pytest 36 | 37 | commands = 38 | pytest 39 | 40 | [testenv:flake8] 41 | basepython = python3 42 | deps = 43 | flake8 44 | pep8-naming 45 | flake8-import-order 46 | commands = flake8 47 | 48 | [testenv:black-format] 49 | # Used during development (before committing) to format .py files. 50 | basepython = python3 51 | deps = black 52 | commands = 53 | black -l 100 ./ 54 | 55 | [testenv:black-check] 56 | # Used by automated build steps to check that all files are properly formatted. 57 | basepython = python3 58 | deps = black 59 | commands = 60 | black -l 100 --check ./ 61 | --------------------------------------------------------------------------------