From 6a93794737981247a1acb72704c172ef858153ad Mon Sep 17 00:00:00 2001 From: Sam Chudnick Date: Sun, 17 Jul 2022 20:20:23 -0400 Subject: Initial commit --- LICENSE | 674 ++++++++++++++++++++++++ Makefile | 18 + README.md | 94 ++++ config.ini | 32 ++ config.py | 21 + database.py | 64 +++ interface.py | 626 ++++++++++++++++++++++ jellyfin.py | 203 +++++++ jellyfin_apiclient_python/__init__.py | 133 +++++ jellyfin_apiclient_python/api.py | 653 +++++++++++++++++++++++ jellyfin_apiclient_python/client.py | 87 +++ jellyfin_apiclient_python/configuration.py | 53 ++ jellyfin_apiclient_python/connection_manager.py | 379 +++++++++++++ jellyfin_apiclient_python/credentials.py | 128 +++++ jellyfin_apiclient_python/exceptions.py | 11 + jellyfin_apiclient_python/http.py | 267 ++++++++++ jellyfin_apiclient_python/keepalive.py | 20 + jellyfin_apiclient_python/timesync_manager.py | 140 +++++ jellyfin_apiclient_python/ws_client.py | 140 +++++ joc.py | 41 ++ 20 files changed, 3784 insertions(+) create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 README.md create mode 100644 config.ini create mode 100644 config.py create mode 100644 database.py create mode 100644 interface.py create mode 100644 jellyfin.py create mode 100644 jellyfin_apiclient_python/__init__.py create mode 100644 jellyfin_apiclient_python/api.py create mode 100644 jellyfin_apiclient_python/client.py create mode 100644 jellyfin_apiclient_python/configuration.py create mode 100644 jellyfin_apiclient_python/connection_manager.py create mode 100644 jellyfin_apiclient_python/credentials.py create mode 100644 jellyfin_apiclient_python/exceptions.py create mode 100644 jellyfin_apiclient_python/http.py create mode 100644 jellyfin_apiclient_python/keepalive.py create mode 100644 jellyfin_apiclient_python/timesync_manager.py create mode 100644 jellyfin_apiclient_python/ws_client.py create mode 100755 joc.py diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..5723c45 --- /dev/null +++ b/Makefile @@ -0,0 +1,18 @@ +PREFIX = /usr/local +BINDIR = $(PREFIX)/bin +SRCDIR = $(PREFIX)/src +JOCDIR = $(SRCDIR)/joc + +install: + mkdir -p $(DESTDIR)$(BINDIR) + mkdir -p $(DESTDIR)$(SRCDIR) + mkdir -p $(DESTDIR)$(JOCDIR) + cp -rf *.py jellyfin_apiclient_python/ $(DESTDIR)$(JOCDIR) + chmod 755 $(DESTDIR)$(JOCDIR)/joc.py + ln -s $(DESTDIR)$(JOCDIR)/joc.py $(DESTDIR)$(BINDIR)/joc + +uninstall: + rm -rf $(DESTDIR)$(JOCDIR) + rm -f $(DESTDIR)$(BINDIR)/joc + +.PHONY: install uninstall diff --git a/README.md b/README.md new file mode 100644 index 0000000..0184169 --- /dev/null +++ b/README.md @@ -0,0 +1,94 @@ +# joc - Jellyfin on Console +joc is a lightweight terminal client to your Jellyfin media server. joc has +a sleek curses interface and offers many of the same features as your other favorite +terminal programs including: Vim-like keybindings, keystroke combination actions, +user input bar, configurable color scheme, and more. + +## Installation + +### Dependencies + +Install the following dependencies. The following are the package names +on Debian derivatives. If you are using a different distro the package names +may be slightly different. + +- python3-mpv +- python3-urwid +- python3-urllib3 +- python3-certifi +- python3-websocket +- python3-requests +- python3-six + +``` +git clone https://git.chudnick.com/joc +cd joc +sudo make install +``` + +## Configuration + +You'll need to do some basic configuration to get joc talking to your Jellyfin +server. You can copy the example `config.ini` to the configuration directory at +`~/.config/joc` to begin. + +At the minimum, you'll need to change the +`server`, `username`, and `password` options to fit your environment. `server` is +the url for your jellyfin server and `username` and `password` are the credentials +for an account on the server. Instead of storing a plaintext password in the config +file you may want to instead use the `passcmd` setting which allows you to specify +a command to run to get the password instead. + +The `verify_tls` option determines whether joc will verify the Jellyfin server's +certificate. `0` tells joc not to verify the certificate while `1` tells joc to +verify and drop the connection if the certificate is invalid. If you are accessing +a public Jellyfin instance it is highly recommended to set this to `1`, but for +internal servers you will probably need to set this to `0`. + +## Usage + +Simply run `joc` from your terminal or application launcher after doing the basic +configuration. + +## Modes + +Like Vim, joc contains a number of different modes + +- `Main` - Main mode is where you will spend most of your time. In this mode + the Jellyfin library is displayed as a folder structure and watched + items are highlighted. +- `Favorites` - The same as main mode but favorites are highlighted instead. +- `Search` - Search mode displays the results of a search. Search mode does not + have a folder structure like main and favorites mode. +- `Info` - Shows additonal information about a selected item + +## Keybindings + +- `l` - Move into a folder +- `j` - Scroll up through a list of items +- `k` - Scroll down through a list of items +- `h` - Move out of a folder and back up the folder structure +- `g` - Go to the top item +- `G` - Go to the bottom item +- `Enter` - Play the currently highlighted item +- `i` - View more information about an item +- `:` - Enter input mode to provide a command +- `/` - Search for a provided term (shorcut for `:search `) +- `q` - Quit a non-standard mode +- `Q` - Quit the program + +## Keystroke Combinations + +- `mw` - Mark item as watched +- `uw` - Mark item as not watched +- `mf` - Mark item as favorite +- `uf` - Mark item as not a favorite +- `sf` - Toggle favorites mode +- `sm` - Toggle main mode + +## Limitations + +The Jellyfin API does not currently provide a method to update the playback progress +for an item so as of now joc cannot sync the progress with the Jellyfin server. joc +uses a local sqlite database to store this information instead. Other information +user data such as watched status and favorites are synced with the server. diff --git a/config.ini b/config.ini new file mode 100644 index 0000000..4f8fd58 --- /dev/null +++ b/config.ini @@ -0,0 +1,32 @@ +[connection] +server = https://jellyfin.home.local +username = jellyfin +password = changeme +#passcmd = pass jellyfin +verify_tls = 0 + +[colors] +header_fg = black +header_bg = light gray +text_fg = white +text_bg = default +focus_fg = white +focus_bg = dark read +text_viewed_fg = yellow +text_viewed_bg = default +focus_viewed_fg = yellow +focus_viewed_bg = dark red +fav_fg = light green +fav_bg = default +non_fav_fg = dark gray +non_fav_bg = default +fav_foc_fg = light green +fav_foc_bg = dark gray +non_fav_foc_fg = light gray +non_fav_foc_bg = dark gray + + +[options] +autoplay = off +search_insensitive = off + diff --git a/config.py b/config.py new file mode 100644 index 0000000..184dbd8 --- /dev/null +++ b/config.py @@ -0,0 +1,21 @@ +""" +Functions for handling the program's configuration file +""" + +from configparser import ConfigParser +import os + +CONFIG_FILE = os.path.expanduser("~/.config/joc/config.ini") + +def read_config_file(): + """ Read config file and return ConfigParser instance """ + parser = ConfigParser(inline_comment_prefixes="#") + parser.read(os.path.expanduser(CONFIG_FILE)) + return parser + + +def write_config_file(parser): + """ Write ConfigParser contents back to config file """ + with open(os.path.expanduser(CONFIG_FILE), "w") as conf: + parser.write(conf) + diff --git a/database.py b/database.py new file mode 100644 index 0000000..1c5304c --- /dev/null +++ b/database.py @@ -0,0 +1,64 @@ +""" +Defines a database class for holding locally stored information +""" + +import sqlite3 +import os + +class Database(object): + + def __init__(self, path): + self.path = path + if not self.exists(): + self.create() + + def exists(self): + """ Checks if the database path exists """ + return os.path.exists(self.path) + + + def create(self): + with sqlite3.connect(self.path) as conn: + c = conn.cursor() + c.execute("""CREATE TABLE playstate ( + item_id text, + pct_played float, + sec_played int + )""") + + + def query_playstate(self, item_id): + """ Gets the playstate data for a given item id """ + with sqlite3.connect(self.path) as conn: + c = conn.cursor() + c.execute("SELECT * FROM playstate WHERE item_id=?",(item_id,)) + playstate = c.fetchone() + + if playstate == None: + playstate = ("",0,0) + return playstate + + + def update_playstate(self, item_id, pct_played, sec_played): + """ Updates the playstate of a given item id """ + with sqlite3.connect(self.path) as conn: + c = conn.cursor() + + # Delete item from DB if not needed to keep database small + if sec_played == 0: + c.execute("DELETE FROM playstate WHERE item_id=?",(item_id,)) + with open("log","a") as log: + log.write("deleted " + item_id + " from playstate db\n") + + else: + c.execute("SELECT * FROM playstate WHERE item_id=?",(item_id,)) + + # If item not in DB add it, otherwise update the entry + if c.fetchone() == None: + c.execute("INSERT INTO playstate VALUES (?,?,?)", + (item_id,pct_played,sec_played)) + else: + c.execute("UPDATE playstate SET pct_played=? WHERE item_id=?", + (pct_played,item_id)) + c.execute("UPDATE playstate SET sec_played=? WHERE item_id=?", + (sec_played,item_id)) diff --git a/interface.py b/interface.py new file mode 100644 index 0000000..5d3ff24 --- /dev/null +++ b/interface.py @@ -0,0 +1,626 @@ +""" +Defines a class to represent the user interface of the program. +""" + +import config + +import sys +import subprocess +import threading +import os +import urwid +import string +import random +import json +import mpv +import time + +class Interface: + + def __init__(self, jellyfin, libs, parser, db): + self.jellyfin = jellyfin + self.parser = parser + self.db = db + + # Focus + self.focus = 0 + self.main_focus = 0 + self.search_focus = 0 + + # Settings + self.show_favorites = False + self.autoplay = False + + # Search + self.search_insensitive = True + self.search_term = None + self.search_mode = False + self.search_results = [] + self.search_position = 0 + + # Information + self.info_mode = False + + # Commands + self.input_buffer = [] + self.cmd_pos = -1 + self.cmd_history = [] + #self.cmd_history = commands.read_cmdhist() + + # Jellyfin + self.libs = libs # User media folders + self.display_contents = [] # JSON of items currently being displayed + self.focus_stack = [] # Keeps track of focus on various screens + + + + def parse_options(self): + if not self.parser.has_section("options"): + return + autoplay = self.parser.get("options", "autoplay", fallback="off") + search_insensitive = self.parser.get("options","search_insensitive", + fallback="on") + if autoplay == "on": + self.autoplay = True + if search_insensitive == 'off': + self.search_insenstive = False + + + def get_colors(self): + valid_colors = [ 'black', 'brown', 'dark blue', 'dark cyan', 'dark gray', + 'dark green', 'dark magenta', 'dark red', 'light blue', + 'light cyan', 'light gray', 'light green', 'light magenta', + 'light red', 'white', 'yellow', 'default'] + + # Validate and sanitize values + if self.parser.has_section("colors"): + for name, value in self.parser.items("colors"): + if value not in valid_colors: + self.parser.remove_option("colors", name) + + # Get colors from config file + + # Main view colors + header_fg = self.parser.get("colors", "header_fg", fallback="black") + header_bg = self.parser.get("colors", "header_bg", fallback="light gray") + text_fg = self.parser.get("colors", "text_fg", fallback="white") + text_bg = self.parser.get("colors", "text_bg", fallback="default") + focus_fg = self.parser.get("colors", "focus_fg", fallback="white") + focus_bg = self.parser.get("colors", "focus_bg", fallback="dark red") + text_viewed_fg = self.parser.get("colors", "text_viewed_fg", fallback="yellow") + text_viewed_bg = self.parser.get("colors", "text_viewed_bg",fallback="default") + focus_viewed_fg = self.parser.get("colors","focus_viewed_fg",fallback="yellow") + focus_viewed_bg=self.parser.get("colors","focus_viewed_bg",fallback="dark red") + + # Favorites view colors + fav_fg = self.parser.get("colors", "fav_fg", fallback = "light green") + fav_bg = self.parser.get("colors", "fav_bg", fallback = "default") + non_fav_fg = self.parser.get("colors", "non_fav_fg", fallback = "dark gray") + non_fav_bg = self.parser.get("colors", "non_fav_bg", fallback = "default") + fav_foc_fg = self.parser.get("colors", "fav_foc_fg", fallback = "light green") + fav_foc_bg = self.parser.get("colors", "fav_foc_bg", fallback = "dark gray") + non_fav_foc_fg = self.parser.get("colors","non_fav_foc_fg", + fallback="light gray") + non_fav_foc_bg = self.parser.get("colors","non_fav_foc_bg", + fallback="dark gray") + + self.palette = [ + ('header', header_fg, header_bg), + ('text', text_fg, text_bg), + ('focus', focus_fg, focus_bg), + ('text_viewed', text_viewed_fg, text_viewed_bg), + ('focus_viewed', focus_viewed_fg, focus_viewed_bg), + ('fav', fav_fg, fav_bg), + ('fav-foc', fav_foc_fg, fav_foc_bg), + ('non-fav', non_fav_fg, non_fav_bg), + ('non-fav-foc', non_fav_foc_fg, non_fav_foc_bg), + ('error', 'dark red', 'black'), + ] + + + def start(self): + """ Start curses and initialize containers, windows, and variables """ + self.screen = urwid.raw_display.Screen() + self.get_colors() + self.parse_options() + self.screen.register_palette(self.palette) + self.build() + self.screen.run_wrapper(self.run) + + + def build(self): + """ Build urwid/curses UI """ + self.header = urwid.AttrWrap(urwid.Text("joc"), "header") + self.content = urwid.SimpleFocusListWalker([]) + self.body = urwid.ListBox(self.content) + self.display_contents = self.libs + self.display(self.libs) + self.input = urwid.Edit("") + self.ui_main = urwid.Frame(self.body, header=self.header, footer=self.input) + self.ui_main.set_focus("body") + + + def run(self): + """ Run urwid UI until exit """ + def input_handler(key): + self.keypress(key) + + self.size = self.screen.get_cols_rows() + self.mainloop = urwid.MainLoop( + self.ui_main, + screen=self.screen, + handle_mouse=False, + unhandled_input=input_handler + ) + try: + self.mainloop.run() + except KeyboardInterrupt: + self.end() + + + def end(self): + """ Exit gracefully when user ends program """ + sys.exit(0) + + + def keypress(self, key): + """ Handle a key press by the user """ + if self.ui_main.get_focus() == "body": + if key == 'h' or key == 'left': + if not self.search_mode: + self.shift_left() + self.clear_buffer() + elif key == 'enter': + result = self.play() + self.clear_buffer() + elif key == 'j' or key == 'down': + self.scroll_down() + self.clear_buffer() + elif key =='k' or key == 'up': + self.scroll_up() + self.clear_buffer() + elif key == 'g': + self.focus = 0 + self.content.set_focus(self.focus) + self.clear_buffer() + elif key == 'G': + self.focus = len(self.content) - 1 + self.content.set_focus(self.focus) + self.clear_buffer() + elif key == 'l'or key == 'right': + if not self.search_mode: + self.shift_right() + self.clear_buffer() + elif key == 'i': + self.info_mode = True + if not self.search_mode: + self.main_focus = self.focus + elif self.search_mode: + self.search_focus = self.focus + self.header.set_text("Info Mode") + self.get_info() + elif key == 'q': + if self.search_mode and not self.info_mode: + self.search_mode = False + self.search_term = None + self.search_results = [] + self.header.set_text("Main Mode") + self.focus = self.main_focus + self.display(self.display_contents) + elif self.search_mode and self.info_mode: + self.info_mode = False + self.focus = self.search_focus + self.header.set_text("Search Mode") + self.display(self.search_results) + elif self.info_mode and not self.search_mode: + self.info_mode = False + self.focus = self.main_focus + self.header.set_text("Main Mode") + self.display(self.display_contents) + elif key == 'Q': + self.end() + elif key == ':': + self.clear_buffer() + self.ui_main.set_focus("footer") + self.input.set_caption(":") + elif key == "/": + self.clear_buffer() + self.ui_main.set_focus("footer") + self.input.set_caption(":") + self.input.insert_text("search ") + elif key == "esc": + self.clear_buffer() + else: + self.input_buffer.append(key) + self.parse_buffer() + + elif self.ui_main.get_focus() == "footer": + if key == 'esc': + self.ui_main.set_focus("body") + self.input.set_edit_text("") + self.input.set_caption("") + self.cmd_pos = -1 + elif key == 'enter': + self.parse_input() + elif key == 'up': + if self.cmd_pos == -1 and self.input.get_edit_text() != "": + pass + elif self.cmd_pos+1 < len(self.cmd_history): + self.cmd_pos += 1 + self.input.set_edit_text("") + self.input.insert_text(self.cmd_history[self.cmd_pos]) + elif key == 'down': + if self.cmd_pos-1 > -1: + self.cmd_pos -= 1 + self.input.set_edit_text("") + self.input.insert_text(self.cmd_history[self.cmd_pos]) + elif self.cmd_pos-1 == -1: + self.cmd_pos -= 1 + self.input.set_edit_text("") + + + def clear_buffer(self): + """ Reset keystroke combination buffer """ + self.input_buffer = [] + self.input.set_caption("") + + + def parse_buffer(self): + """Check the input buffer to see if the user has entered an action + Perform the associated action if applicable + + Keystroke combination actions consist of two parts: + action - the first key in the combination, tells what to do (mark, show) + argument - tells what to do with the action. actions generally have more than + one argument, for example, watched and favorite are both valid + arguments to the mark action. arguments are also generally + adjectives, used to describe a media item, again such as favorite + or watched.""" + + keys = ''.join(self.input_buffer) + if self.search_mode: + focus_item = self.search_results[self.focus] + else: + focus_item = self.display_contents[self.focus] + + if keys == 'mw': + # Mark watched + self.jellyfin.mark_watched(focus_item["Id"]) + self.update_display() + self.clear_buffer() + + elif keys == 'uw': + # Unmark watched + self.jellyfin.mark_watched(focus_item["Id"], False) + self.update_display() + self.clear_buffer() + + elif keys == 'mf': + # Mark favorite + self.jellyfin.mark_favorite(focus_item["Id"]) + self.update_display() + self.clear_buffer() + + elif keys == "uf": + # Unmark favorite + self.jellyfin.mark_favorite(focus_item["Id"], False) + self.update_display() + self.clear_buffer() + + elif keys == "sf": + # Show favorites + self.show_favorites = True + self.header.set_text("Favorites View") + self.update_display() + self.clear_buffer() + + elif keys == 'sm': + # Show main + self.show_favorites = False + self.header.set_text("Main View") + self.update_display() + self.clear_buffer() + + else: + action_keys = ['m', 'u', 's'] + arguments = {'m':['f','w'], 'u':['f','w'], 's':['f', 'm']} + if len(keys) == 1 and keys[0] not in action_keys: + # If there is only one key in the buffer, and it is not a valid action + # key, clear the buffer + self.clear_buffer() + elif len(keys) > 1 and keys[1] not in arguments[keys[0]]: + # If there are multiple (currently shouldn't be greater than 2) keys in + # the buffer, and the second isn't a valid argument to the action key, + # clear the buffer + self.clear_buffer() + else: + # Will only be triggered if there is one key in the buffer, and it is + # a valid action key. In which case update buffer display for user + self.input.set_caption(keys) + + + def parse_input(self): + """ Parse the command input and perform the associated action + if the command is valid """ + command = self.input.get_edit_text().strip() + # History + if len(self.cmd_history) == 0 or self.cmd_history[0] != command: + with open(os.path.expanduser("~/.config/joc/history"), "a") as hist: + hist.write(command + "\n") + self.cmd_history = [] + + with open(os.path.expanduser("~/.config/joc/history")) as hist: + for line in hist: + if not line.startswith("#"): + self.cmd_history.append(line.strip()) + + self.cmd_history.reverse() + + # Parse input to get command + keyword = command.split(' ')[0] + if keyword == "search": + searchterm = ''.join(command.split(' ')[1:]) + results = self.jellyfin.search(searchterm) + if len(results) == 0: + self.input.set_caption("No results found") + else: + self.search_mode = True + self.main_focus = self.focus + self.search_term = searchterm + self.search_results = results + self.header.set_text("Search Mode") + self.focus = 0 + self.display(results) + + elif keyword.startswith("clearhist"): + commands.clear_cmdhist() + self.cmd_history = commands.read_cmdhist() + + elif keyword.startswith("reset-viewed"): + command = command.split(' ') + + elif keyword.startswith("set-viewed"): + command = command.split(' ') + + elif keyword == "autoplay": + if self.autoplay == False: + self.autoplay = True + self.input.set_caption("Autoplay enabled") + else: + self.autoplay = False + self.input.set_caption("Autoplay disabled") + + elif keyword == "autoplay-status": + if self.autoplay == True: + self.input.set_caption("Autoplay is enabled") + else: + self.input.set_caption("Autoplay is disabled") + + elif keyword == 'search-insensitive': + self.search_insensitive = True + + elif keyword == 'search-sensitive': + self.search_insensitive = False + + # Reset input bar + self.input.set_edit_text("") + # Reset the caption unless it is being used for a message + if self.input.caption == ":": + self.input.set_caption("") + self.ui_main.set_focus("body") + self.cmd_pos = -1 + + + + def display(self, content:list): + """ Set given contents as current display objects and display them """ + + del self.content[:] + + # Do not update display_contents if we are in search or info mode + if not self.search_mode and not self.info_mode: + self.display_contents = content + + if self.info_mode: + for line in content: + self.content.append(urwid.AttrWrap( + urwid.Text(line), 'text','focus')) + self.content.set_focus(0) + return + + for item in content: + title = item["Name"] + + if self.show_favorites: + if item["UserData"]["IsFavorite"]: + self.content.append(urwid.AttrWrap( + urwid.Text(title), 'fav', 'fav-foc') + ) + else: + self.content.append(urwid.AttrWrap( + urwid.Text(title), 'non-fav', 'non-fav-foc') + ) + else: + if item["UserData"]["Played"] and item["Type"] != "Audio": + self.content.append(urwid.AttrWrap( + urwid.Text(title), 'text_viewed', 'focus_viewed') + ) + else: + self.content.append(urwid.AttrWrap( + urwid.Text(title), 'text', 'focus') + ) + + self.content.set_focus(self.focus) + + + def update_display(self): + """ Refresh the display by redisplaying the current contents + Re-retrieves the objects to get any changes that were made""" + + if self.search_mode: + results = self.jellyfin.search(self.search_term) + self.display(results) + else: + focus_item = self.display_contents[self.focus] + parent = self.jellyfin.get_parent(focus_item["Id"]) + content = self.jellyfin.get_children(parent["Id"]) + self.display(content) + self.content.set_focus(self.focus) + + + def is_media(self, item): + """ Determines if an item is a piece of media (as opposed to a container) + and returns a boolean. Determination is made by 'Type' field in Jellyfin + item JSON. """ + + media_types = ["Audio","AudioBook","Book","Episode","Movie","LiveTvProgram", + "MusicVideo","Photo","Program","TvProgram","Video"] + if item["Type"] in media_types: + return True + else: + return False + + + def shift_left(self): + """ Shifts the displayed contents 'left', can also be thought of as + moving 'up' in the folder structure of the media. + Moves from current contents to parent and parent's siblings """ + + # Do nothing if at media folders root level + if self.display_contents == self.libs: + return + else: + focus_item = self.display_contents[self.focus] + new_contents = self.jellyfin.get_previous(focus_item["Id"]) + if len(self.focus_stack) == 0: + self.focus = 0 + else: + self.focus = self.focus_stack.pop() + self.display(new_contents) + + + def shift_right(self): + """ Shift the display contents to the right by display the child items + of the currently selected item """ + + # Do nothing if item is media + focus_item = self.display_contents[self.focus] + if self.is_media(focus_item): + return + else: + new_contents = self.jellyfin.get_children(focus_item["Id"]) + self.focus_stack.append(self.focus) + self.focus = 0 + self.display(new_contents) + + + def scroll_up(self): + """ Scroll up in the list of currently displayed items """ + + if self.focus == 0: + return + self.focus -= 1 + self.content.set_focus(self.focus) + + def scroll_down(self): + """ Scroll down in the list of currently displayed items """ + + if self.focus == len(self.content)-1: + return + self.focus += 1 + self.content.set_focus(self.focus) + + + def play(self): + """ Play the currently selected item """ + + if self.search_mode: + all_items = self.search_results[self.focus:] + focus_item = self.search_results[self.focus] + else: + all_items = self.display_contents[self.focus:] + focus_item = self.display_contents[self.focus] + + player = mpv.MPV(ytdl=True,input_default_bindings=True,input_vo_keyboard=True) + + @player.on_key_press('q') + def getpos_then_quit(): + player.pct_played = player.percent_pos + player.sec_played = player.time_pos + player.quit() + + try: + if self.autoplay: + AUTOPLAY_LIMIT = 10 + autoplay_items = all_items[:AUTOPLAY_LIMIT] + current_item = focus_item + + for item in autoplay_items: + url = self.jellyfin.get_url(item["Id"]) + player.playlist_append(url) + + player.playlist_pos = 0 + count = 0 + while count < AUTOPLAY_LIMIT: + current_item = autoplay_items[count] + pct_played, sec_played = self.get_playstate(focus_item["Id"]) + player.wait_until_playing() + player.seek(float(pct_played), reference='absolute-percent') + player.wait_for_playback() + self.jellyfin.mark_watched(focus_item["Id"]) + self.set_playstate(focus_item["Id"], 100.0, 0) + count += 1 + self.focus += 1 + else: + url = self.jellyfin.get_url(focus_item["Id"]) + pct_played, sec_played = self.get_playstate(focus_item["Id"]) + player.play(url) + player.wait_until_playing() + player.seek(float(pct_played), reference='absolute-percent') + player.wait_for_playback() + self.jellyfin.mark_watched(focus_item["Id"]) + self.set_playstate(focus_item["Id"], 100.0, 0) + + except mpv.ShutdownError: + if self.autoplay: + item_id = current_item["Id"] + else: + item_id = focus_item["Id"] + self.set_playstate(item_id,player.pct_played,player.sec_played) + + player.terminate() + self.update_display() + + + + def get_playstate(self, item_id): + DB_ITEMID_INDEX = 0 + DB_PCT_INDEX = 1 + DB_SEC_INDEX = 2 + """ Gets playstate from local db + Returns (pct_played, sec_played) tuple """ + playstate = self.db.query_playstate(item_id) + return playstate[DB_PCT_INDEX],playstate[DB_SEC_INDEX] + + def set_playstate(self, item_id, pct_played, sec_played): + """ Updates playstate in local db of an item """ + pct_played = float(pct_played) + sec_played = int(sec_played) + if pct_played > 95.0: + self.jellyfin.mark_watched(item_id) + self.db.update_playstate(item_id, 0, 0) + else: + self.jellyfin.mark_watched(item_id, False) + self.db.update_playstate(item_id, pct_played, sec_played) + + + def get_info(self): + """ Get and then display the JSON info of the currently selected item """ + + if self.search_mode: + focus_item = self.search_results[self.focus] + else: + focus_item = self.display_contents[self.focus] + + info = self.jellyfin.get_info(focus_item["Id"]) + self.display(info) diff --git a/jellyfin.py b/jellyfin.py new file mode 100644 index 0000000..007dccf --- /dev/null +++ b/jellyfin.py @@ -0,0 +1,203 @@ +#!/usr/bin/env python3 + +""" +Class to manage Jellyfin server connection and REST API calls +""" + +import jellyfin_apiclient_python as jellyfin +import json +import os +import sys +import warnings +import threading +import subprocess +import ssl +import shlex + +APP_NAME = "joc" +CLIENT_VERSION = "0.01" +DEVICE_NAME = "joc" +USER_AGENT = "joc/0.01" +DEVICE_ID = "joc" + +NO_VERIFY = 0 +VERIFY = 1 + +SORT_ALNUM = 0 +SORT_DATE = 1 + +MEDIA_TYPES = ["Audio","AudioBook","Book","Episode","Movie","LiveTvProgram", + "MusicVideo","Photo","Program","TvProgram","Video"] + +CONNECTION_STATE = jellyfin.connection_manager.CONNECTION_STATE + + +def die(msg): + print(msg) + sys.exit(1) + +class JellyfinConnection(object): + + def __init__(self, parser): + + self.parser = parser + + self.client = None + self.http_client = None + self.api = None + self.verify_tls = None + + self.server = None + self.username = None + self.password = None + self.passcmd = None + + self.read_config() + self.connect() + + def read_config(self): + """ Read connection information from configuratino file """ + + if not self.parser.has_section("connection"): + die("error: unable to find connection info") + + if not self.parser.has_option("connection","server"): + die("error: no server given") + if not self.parser.has_option("connection","username"): + die("error: no username given") + if not self.parser.has_option("connection","password") and \ + not self.parser.has_option("connection","passcmd"): + die("error: no password or passcmd given") + + self.server = self.parser.get("connection", "server") + self.username = self.parser.get("connection", "username") + self.password = self.parser.get("connection", "password", fallback=None) + self.passcmd = self.parser.get("connection", "passcmd", fallback=None) + verify_tls = self.parser.get("connection", "verify_tls", fallback=VERIFY) + try: + if int(verify_tls) not in [0,1]: + self.verify_tls = VERIFY + else: + self.verify_tls = int(verify_tls) + except ValueError: + self.verify_tls = VERIFY + + + # Taken mostly from jellyfin-mpv-shim + def client_factory(self): + """ Build and return JellyfinClient instance """ + + client = jellyfin.client.JellyfinClient() + client.config.data["app.default"] = True + client.config.app(APP_NAME,CLIENT_VERSION,DEVICE_NAME,DEVICE_ID) + client.config.data["http.user_agent"] = USER_AGENT + client.config.data["auth.ssl"] = self.verify_tls + if self.verify_tls == NO_VERIFY: + warnings.filterwarnings("ignore") + return client + + def login(self, server, username, password): + """ Login to Jellyfin server with JellyfinClient instance """ + + client = self.client_factory() + result = client.auth.connect_to_address(server) + if result["State"] == CONNECTION_STATE["Unavailable"]: + die("error: unable to connect to server") + result = client.auth.login(server,username,password) + return client + + + def connect(self): + """ Initalizes JellyfinClient, HTTP connection, and API instance. """ + + # Prep Connection + if self.password == None: + password = subprocess.run(self.passcmd, shell=True, \ + capture_output=True,text=True).stdout + self.password = password.strip() + self.client = self.login(self.server,self.username,self.password) + self.http_client = jellyfin.http.HTTP(self.client) + self.api = jellyfin.api.API(self.http_client) + + + def get_libraries(self): + """ Get user root media folders """ + + folders = self.api.get_media_folders()["Items"] + return sorted(folders,key=lambda folder: folder["Name"]) + + def get_children(self,parent_id): + """ Get children of a given parent_id. + Sorts by date created if items are videos or by name otherwise. + Returns the sotrted list """ + + children = self.api.get_items_by_letter(parent_id=parent_id, recurse=False) + children = children["Items"] + + # Sort items, by date if video, by name otherwise + if len(children) > 0 and children[0]["Type"] == "MusicVideo": + children = sorted(children,key=lambda item: item["DateCreated"], + reverse=True) + else: + children = sorted(children,key=lambda item: item["Name"]) + + return children + + def get_previous(self,item_id): + """Gets items that were shown on the previous screen, i.e. + the parent item's siblings, i.e. the children of the grandparent item """ + + PARENT_INDEX = 0 + GRANDPARENT_INDEX = 1 + ancestors = self.api.get_ancestors(item_id) + + if len(ancestors) == 1 and ancestors[0]["Type"] == "UserRootFolder": + return self.get_libraries() + else: + grandparent = ancestors[GRANDPARENT_INDEX] + return self.get_children(grandparent["Id"]) + + + def get_parent(self,item_id): + """ Get parent (first ancestor) of a given item """ + + PARENT_INDEX = 0 + ancestors = self.api.get_ancestors(item_id) + parent = ancestors[PARENT_INDEX] + return parent + + def search(self, term): + """ Search for a given term and return a alphabetically sorted list """ + + items = self.api.search_media_items(term,MEDIA_TYPES,None)["Items"] + items = sorted(items,key=lambda item: item["Name"]) + return items + + def get_info(self, item_id): + """ Get stored information about an item and return a pretty printed JSON + string representation of the item """ + + item = self.api.get_item(item_id) + return json.dumps(item,indent=4) + + def mark_watched(self, item_id, watched=True): + """ Mark an item as watched or unwatched""" + self.api.item_played(item_id, watched) + + def mark_favorite(self, item_id, favorite=True): + """ Mark an item as a favorite or unfavorite the item""" + self.api.favorite(item_id, favorite) + + def get_url(self, item_id): + """ Get download URL of the selected media item """ + url = self.api.download_url(item_id) + return url + + def set_played_progress(self, item:dict, ticks): + item["UserData"]["PlaybackPositionTicks"] = int(ticks) + res = self.api.session_progress(item) + + +if __name__ == '__main__': + main() + diff --git a/jellyfin_apiclient_python/__init__.py b/jellyfin_apiclient_python/__init__.py new file mode 100644 index 0000000..dcc660f --- /dev/null +++ b/jellyfin_apiclient_python/__init__.py @@ -0,0 +1,133 @@ +# -*- coding: utf-8 -*- +from __future__ import division, absolute_import, print_function, unicode_literals + +################################################################################################# + +import logging + +from .client import JellyfinClient + +################################################################################################# + + +class NullHandler(logging.Handler): + def emit(self, record): + print(self.format(record)) + + +loghandler = NullHandler +LOG = logging.getLogger('Jellyfin') + +################################################################################################# + + +def config(level=logging.INFO): + + logger = logging.getLogger('Jellyfin') + logger.addHandler(Jellyfin.loghandler()) + logger.setLevel(level) + +def has_attribute(obj, name): + try: + object.__getattribute__(obj, name) + return True + except AttributeError: + return False + +def ensure_client(): + + def decorator(func): + def wrapper(self, *args, **kwargs): + + if self.client.get(self.server_id) is None: + self.construct() + + return func(self, *args, **kwargs) + + return wrapper + return decorator + + +class Jellyfin(object): + + ''' This is your Jellyfinclient, you can create more than one. The server_id is only a temporary thing + to communicate with the JellyfinClient(). + + from jellyfin import Jellyfin + + Jellyfin('123456').config.data['app'] + + # Permanent client reference + client = Jellyfin('123456').get_client() + client.config.data['app'] + ''' + + # Borg - multiple instances, shared state + _shared_state = {} + client = {} + server_id = "default" + loghandler = loghandler + + def __init__(self, server_id=None): + self.__dict__ = self._shared_state + self.server_id = server_id or "default" + + def get_client(self): + return self.client[self.server_id] + + @classmethod + def set_loghandler(cls, func=loghandler, level=logging.INFO): + + for handler in logging.getLogger('Jellyfin').handlers: + if isinstance(handler, cls.loghandler): + logging.getLogger('Jellyfin').removeHandler(handler) + + cls.loghandler = func + config(level) + + def close(self): + + if self.server_id not in self.client: + return + + self.client[self.server_id].stop() + self.client.pop(self.server_id, None) + + LOG.info("---[ STOPPED JELLYFINCLIENT: %s ]---", self.server_id) + + @classmethod + def close_all(cls): + + for client in cls.client: + cls.client[client].stop() + + cls.client = {} + LOG.info("---[ STOPPED ALL JELLYFINCLIENTS ]---") + + @classmethod + def get_active_clients(cls): + return cls.client + + @ensure_client() + def __setattr__(self, name, value): + + if has_attribute(self, name): + return super(Jellyfin, self).__setattr__(name, value) + + setattr(self.client[self.server_id], name, value) + + @ensure_client() + def __getattr__(self, name): + return getattr(self.client[self.server_id], name) + + def construct(self): + + self.client[self.server_id] = JellyfinClient() + + if self.server_id == 'default': + LOG.info("---[ START JELLYFINCLIENT ]---") + else: + LOG.info("---[ START JELLYFINCLIENT: %s ]---", self.server_id) + + +config() diff --git a/jellyfin_apiclient_python/api.py b/jellyfin_apiclient_python/api.py new file mode 100644 index 0000000..a6df708 --- /dev/null +++ b/jellyfin_apiclient_python/api.py @@ -0,0 +1,653 @@ +# -*- coding: utf-8 -*- +from __future__ import division, absolute_import, print_function, unicode_literals +from datetime import datetime +import requests +import json +import logging + +LOG = logging.getLogger('JELLYFIN.' + __name__) + + +def jellyfin_url(client, handler): + return "%s/%s" % (client.config.data['auth.server'], handler) + + +def basic_info(): + return "Etag" + + +def info(): + return ( + "Path,Genres,SortName,Studios,Writer,Taglines,LocalTrailerCount," + "OfficialRating,CumulativeRunTimeTicks,ItemCounts," + "Metascore,AirTime,DateCreated,People,Overview," + "CriticRating,CriticRatingSummary,Etag,ShortOverview,ProductionLocations," + "Tags,ProviderIds,ParentId,RemoteTrailers,SpecialEpisodeNumbers," + "MediaSources,VoteCount,RecursiveItemCount,PrimaryImageAspectRatio" + ) + + +def music_info(): + return ( + "Etag,Genres,SortName,Studios,Writer," + "OfficialRating,CumulativeRunTimeTicks,Metascore," + "AirTime,DateCreated,MediaStreams,People,ProviderIds,Overview,ItemCounts" + ) + + +class API(object): + + ''' All the api calls to the server. + ''' + def __init__(self, client, *args, **kwargs): + self.client = client + self.config = client.config + self.default_timeout = 5 + + def _http(self, action, url, request={}): + request.update({'type': action, 'handler': url}) + + return self.client.request(request) + + def _http_url(self, action, url, request={}): + request.update({"type": action, "handler": url}) + + return self.client.request_url(request) + + def _http_stream(self, action, url, dest_file, request={}): + request.update({'type': action, 'handler': url}) + + self.client.request(request, dest_file=dest_file) + + def _get(self, handler, params=None): + return self._http("GET", handler, {'params': params}) + + def _get_url(self, handler, params=None): + return self._http_url("GET", handler, {"params": params}) + + def _post(self, handler, json=None, params=None): + return self._http("POST", handler, {'params': params, 'json': json}) + + def _delete(self, handler, params=None): + return self._http("DELETE", handler, {'params': params}) + + def _get_stream(self, handler, dest_file, params=None): + self._http_stream("GET", handler, dest_file, {'params': params}) + + ################################################################################################# + + # Bigger section of the Jellyfin api + + ################################################################################################# + + def try_server(self): + return self._get("System/Info/Public") + + def sessions(self, handler="", action="GET", params=None, json=None): + if action == "POST": + return self._post("Sessions%s" % handler, json, params) + elif action == "DELETE": + return self._delete("Sessions%s" % handler, params) + else: + return self._get("Sessions%s" % handler, params) + + def users(self, handler="", action="GET", params=None, json=None): + if action == "POST": + return self._post("Users/{UserId}%s" % handler, json, params) + elif action == "DELETE": + return self._delete("Users/{UserId}%s" % handler, params) + else: + return self._get("Users/{UserId}%s" % handler, params) + + def items(self, handler="", action="GET", params=None, json=None): + if action == "POST": + return self._post("Items%s" % handler, json, params) + elif action == "DELETE": + return self._delete("Items%s" % handler, params) + else: + return self._get("Items%s" % handler, params) + + def user_items(self, handler="", params=None): + return self.users("/Items%s" % handler, params=params) + + def shows(self, handler, params): + return self._get("Shows%s" % handler, params) + + def videos(self, handler): + return self._get("Videos%s" % handler) + + def artwork(self, item_id, art, max_width, ext="jpg", index=None): + params = {"MaxWidth": max_width, "format": ext} + handler = ("Items/%s/Images/%s" % (item_id, art) if index is None + else "Items/%s/Images/%s/%s" % (item_id, art, index) + ) + + return self._get_url(handler, params) + + def audio_url(self, item_id, container=None, audio_codec=None, max_streaming_bitrate=140000000): + params = { + "UserId": "{UserId}", + "DeviceId": "{DeviceId}", + "MaxStreamingBitrate": max_streaming_bitrate, + } + + if container: + params["Container"] = container + + if audio_codec: + params["AudioCodec"] = audio_codec + + return self._get_url("Audio/%s/universal" % item_id, params) + + def video_url(self, item_id, media_source_id=None): + params = { + "static": "true", + "DeviceId": "{DeviceId}" + } + if media_source_id is not None: + params["MediaSourceId"] = media_source_id + + return self._get_url("Videos/%s/stream" % item_id, params) + + def download_url(self, item_id): + params = {} + return self._get_url("Items/%s/Download" % item_id, params) + + ################################################################################################# + + # More granular api + + ################################################################################################# + + def get_users(self): + return self._get("Users") + + def get_public_users(self): + return self._get("Users/Public") + + def get_user(self, user_id=None): + return self.users() if user_id is None else self._get("Users/%s" % user_id) + + def get_user_settings(self, client="emby"): + return self._get("DisplayPreferences/usersettings", params={ + "userId": "{UserId}", + "client": client + }) + + def get_views(self): + return self.users("/Views") + + def get_media_folders(self): + return self.users("/Items") + + def get_item(self, item_id): + return self.users("/Items/%s" % item_id) + + def get_items(self, item_ids): + return self.users("/Items", params={ + 'Ids': ','.join(str(x) for x in item_ids), + 'Fields': info() + }) + + def get_sessions(self): + return self.sessions(params={'ControllableByUserId': "{UserId}"}) + + def get_device(self, device_id): + return self.sessions(params={'DeviceId': device_id}) + + def post_session(self, session_id, url, params=None, data=None): + return self.sessions("/%s/%s" % (session_id, url), "POST", params, data) + + def get_images(self, item_id): + return self.items("/%s/Images" % item_id) + + def get_suggestion(self, media="Movie,Episode", limit=1): + return self.users("/Suggestions", params={ + 'Type': media, + 'Limit': limit + }) + + def get_recently_added(self, media=None, parent_id=None, limit=20): + return self.user_items("/Latest", { + 'Limit': limit, + 'UserId': "{UserId}", + 'IncludeItemTypes': media, + 'ParentId': parent_id, + 'Fields': info() + }) + + def get_next(self, index=None, limit=1): + return self.shows("/NextUp", { + 'Limit': limit, + 'UserId': "{UserId}", + 'StartIndex': None if index is None else int(index) + }) + + def get_adjacent_episodes(self, show_id, item_id): + return self.shows("/%s/Episodes" % show_id, { + 'UserId': "{UserId}", + 'AdjacentTo': item_id, + 'Fields': "Overview" + }) + + def get_season(self, show_id, season_id): + return self.shows("/%s/Episodes" % show_id, { + 'UserId': "{UserId}", + 'SeasonId': season_id + }) + + def get_genres(self, parent_id=None): + return self._get("Genres", { + 'ParentId': parent_id, + 'UserId': "{UserId}", + 'Fields': info() + }) + + def get_recommendation(self, parent_id=None, limit=20): + return self._get("Movies/Recommendations", { + 'ParentId': parent_id, + 'UserId': "{UserId}", + 'Fields': info(), + 'Limit': limit + }) + + # Modified + def get_items_by_letter(self, parent_id=None, media=None, letter=None, recurse=True): + return self.user_items(params={ + 'ParentId': parent_id, + 'NameStartsWith': letter, + 'Fields': info(), + 'Recursive': recurse, + 'IncludeItemTypes': media + }) + + def search_media_items(self, term=None, media=None, limit=20): + return self.user_items(params={ + 'searchTerm': term, + 'Recursive': True, + 'IncludeItemTypes': media, + 'Limit': limit + }) + + def get_channels(self): + return self._get("LiveTv/Channels", { + 'UserId': "{UserId}", + 'EnableImages': True, + 'EnableUserData': True + }) + + def get_intros(self, item_id): + return self.user_items("/%s/Intros" % item_id) + + def get_additional_parts(self, item_id): + return self.videos("/%s/AdditionalParts" % item_id) + + def delete_item(self, item_id): + return self.items("/%s" % item_id, "DELETE") + + def get_local_trailers(self, item_id): + return self.user_items("/%s/LocalTrailers" % item_id) + + def get_transcode_settings(self): + return self._get('System/Configuration/encoding') + + def get_ancestors(self, item_id): + return self.items("/%s/Ancestors" % item_id, params={ + 'UserId': "{UserId}" + }) + + def get_items_theme_video(self, parent_id): + return self.users("/Items", params={ + 'HasThemeVideo': True, + 'ParentId': parent_id + }) + + def get_themes(self, item_id): + return self.items("/%s/ThemeMedia" % item_id, params={ + 'UserId': "{UserId}", + 'InheritFromParent': True + }) + + def get_items_theme_song(self, parent_id): + return self.users("/Items", params={ + 'HasThemeSong': True, + 'ParentId': parent_id + }) + + def get_plugins(self): + return self._get("Plugins") + + def check_companion_installed(self): + try: + self._get("/Jellyfin.Plugin.KodiSyncQueue/GetServerDateTime") + return True + except Exception: + return False + + def get_seasons(self, show_id): + return self.shows("/%s/Seasons" % show_id, params={ + 'UserId': "{UserId}", + 'EnableImages': True, + 'Fields': info() + }) + + def get_date_modified(self, date, parent_id, media=None): + return self.users("/Items", params={ + 'ParentId': parent_id, + 'Recursive': False, + 'IsMissing': False, + 'IsVirtualUnaired': False, + 'IncludeItemTypes': media or None, + 'MinDateLastSaved': date, + 'Fields': info() + }) + + def get_userdata_date_modified(self, date, parent_id, media=None): + return self.users("/Items", params={ + 'ParentId': parent_id, + 'Recursive': True, + 'IsMissing': False, + 'IsVirtualUnaired': False, + 'IncludeItemTypes': media or None, + 'MinDateLastSavedForUser': date, + 'Fields': info() + }) + + def refresh_item(self, item_id): + return self.items("/%s/Refresh" % item_id, "POST", json={ + 'Recursive': True, + 'ImageRefreshMode': "FullRefresh", + 'MetadataRefreshMode': "FullRefresh", + 'ReplaceAllImages': False, + 'ReplaceAllMetadata': True + }) + + def favorite(self, item_id, option=True): + return self.users("/FavoriteItems/%s" % item_id, "POST" if option else "DELETE") + + def get_system_info(self): + return self._get("System/Configuration") + + def post_capabilities(self, data): + return self.sessions("/Capabilities/Full", "POST", json=data) + + def session_add_user(self, session_id, user_id, option=True): + return self.sessions("/%s/Users/%s" % (session_id, user_id), "POST" if option else "DELETE") + + def session_playing(self, data): + return self.sessions("/Playing", "POST", json=data) + + def session_progress(self, data): + return self.sessions("/Playing/Progress", "POST", json=data) + + def session_stop(self, data): + return self.sessions("/Playing/Stopped", "POST", json=data) + + def item_played(self, item_id, watched): + return self.users("/PlayedItems/%s" % item_id, "POST" if watched else "DELETE") + + def get_sync_queue(self, date, filters=None): + return self._get("Jellyfin.Plugin.KodiSyncQueue/{UserId}/GetItems", params={ + 'LastUpdateDT': date, + 'filter': filters or None + }) + + def get_server_time(self): + return self._get("Jellyfin.Plugin.KodiSyncQueue/GetServerDateTime") + + def get_play_info(self, item_id, profile, aid=None, sid=None, start_time_ticks=None, is_playback=True): + args = { + 'UserId': "{UserId}", + 'DeviceProfile': profile, + 'AutoOpenLiveStream': is_playback, + 'IsPlayback': is_playback + } + if sid: + args['SubtitleStreamIndex'] = sid + if aid: + args['AudioStreamIndex'] = aid + if start_time_ticks: + args['StartTimeTicks'] = start_time_ticks + return self.items("/%s/PlaybackInfo" % item_id, "POST", json=args) + + def get_live_stream(self, item_id, play_id, token, profile): + return self._post("LiveStreams/Open", json={ + 'UserId': "{UserId}", + 'DeviceProfile': profile, + 'OpenToken': token, + 'PlaySessionId': play_id, + 'ItemId': item_id + }) + + def close_live_stream(self, live_id): + return self._post("LiveStreams/Close", json={ + 'LiveStreamId': live_id + }) + + def close_transcode(self, device_id): + return self._delete("Videos/ActiveEncodings", params={ + 'DeviceId': device_id + }) + + def get_audio_stream(self, dest_file, item_id, play_id, container, max_streaming_bitrate=140000000, audio_codec=None): + self._get_stream("Audio/%s/universal" % item_id, dest_file, params={ + 'UserId': "{UserId}", + 'DeviceId': "{DeviceId}", + 'PlaySessionId': play_id, + 'Container': container, + 'AudioCodec': audio_codec, + "MaxStreamingBitrate": max_streaming_bitrate, + }) + + def get_default_headers(self): + auth = "MediaBrowser " + auth += "Client=%s, " % self.config.data['app.name'] + auth += "Device=%s, " % self.config.data['app.device_name'] + auth += "DeviceId=%s, " % self.config.data['app.device_id'] + auth += "Version=%s" % self.config.data['app.version'] + + return { + "Accept": "application/json", + "Content-type": "application/x-www-form-urlencoded; charset=UTF-8", + "X-Application": "%s/%s" % (self.config.data['app.name'], self.config.data['app.version']), + "Accept-Charset": "UTF-8,*", + "Accept-encoding": "gzip", + "User-Agent": self.config.data['http.user_agent'] or "%s/%s" % (self.config.data['app.name'], self.config.data['app.version']), + "x-emby-authorization": auth + } + + def send_request(self, url, path, method="get", timeout=None, headers=None, data=None, session=None): + request_method = getattr(session or requests, method.lower()) + url = "%s/%s" % (url, path) + request_settings = { + "timeout": timeout or self.default_timeout, + "headers": headers or self.get_default_headers(), + "data": data + } + + # Changed to use non-Kodi specific setting. + if self.config.data.get('auth.ssl') == False: + request_settings["verify"] = False + + LOG.info("Sending %s request to %s" % (method, path)) + LOG.debug(request_settings['timeout']) + LOG.debug(request_settings['headers']) + + return request_method(url, **request_settings) + + def login(self, server_url, username, password=""): + path = "Users/AuthenticateByName" + authData = { + "username": username, + "Pw": password + } + + headers = self.get_default_headers() + headers.update({'Content-type': "application/json"}) + + try: + LOG.info("Trying to login to %s/%s as %s" % (server_url, path, username)) + response = self.send_request(server_url, path, method="post", headers=headers, + data=json.dumps(authData), timeout=(5, 30)) + + if response.status_code == 200: + return response.json() + else: + LOG.error("Failed to login to server with status code: " + str(response.status_code)) + LOG.error("Server Response:\n" + str(response.content)) + LOG.debug(headers) + + return {} + except Exception as e: # Find exceptions for likely cases i.e, server timeout, etc + LOG.error(e) + + return {} + + def validate_authentication_token(self, server): + authTokenHeader = { + 'X-MediaBrowser-Token': server['AccessToken'] + } + headers = self.get_default_headers() + headers.update(authTokenHeader) + + response = self.send_request(server['address'], "system/info", headers=headers) + return response.json() if response.status_code == 200 else {} + + def get_public_info(self, server_address): + response = self.send_request(server_address, "system/info/public") + return response.json() if response.status_code == 200 else {} + + def check_redirect(self, server_address): + ''' Checks if the server is redirecting traffic to a new URL and + returns the URL the server prefers to use + ''' + response = self.send_request(server_address, "system/info/public") + url = response.url.replace('/system/info/public', '') + return url + + + + ################################################################################################# + + # Syncplay + + ################################################################################################# + + def _parse_precise_time(self, time): + # We have to remove the Z and the least significant digit. + return datetime.strptime(time[:-2], "%Y-%m-%dT%H:%M:%S.%f") + + def utc_time(self): + # Measure time as close to the call as is possible. + server_address = self.config.data.get("auth.server") + session = self.client.session + + response = self.send_request(server_address, "GetUTCTime", session=session) + response_received = datetime.utcnow() + request_sent = response_received - response.elapsed + + response_obj = response.json() + request_received = self._parse_precise_time(response_obj["RequestReceptionTime"]) + response_sent = self._parse_precise_time(response_obj["ResponseTransmissionTime"]) + + return { + "request_sent": request_sent, + "request_received": request_received, + "response_sent": response_sent, + "response_received": response_received + } + + def get_sync_play(self, item_id=None): + params = {} + if item_id is not None: + params["FilterItemId"] = item_id + return self._get("SyncPlay/List", params) + + def join_sync_play(self, group_id): + return self._post("SyncPlay/Join", { + "GroupId": group_id + }) + + def leave_sync_play(self): + return self._post("SyncPlay/Leave") + + def play_sync_play(self): + """deprecated (<= 10.7.0)""" + return self._post("SyncPlay/Play") + + def pause_sync_play(self): + return self._post("SyncPlay/Pause") + + def unpause_sync_play(self): + """10.7.0+ only""" + return self._post("SyncPlay/Unpause") + + def seek_sync_play(self, position_ticks): + return self._post("SyncPlay/Seek", { + "PositionTicks": position_ticks + }) + + def buffering_sync_play(self, when, position_ticks, is_playing, item_id): + return self._post("SyncPlay/Buffering", { + "When": when.isoformat() + "Z", + "PositionTicks": position_ticks, + "IsPlaying": is_playing, + "PlaylistItemId": item_id + }) + + def ready_sync_play(self, when, position_ticks, is_playing, item_id): + """10.7.0+ only""" + return self._post("SyncPlay/Ready", { + "When": when.isoformat() + "Z", + "PositionTicks": position_ticks, + "IsPlaying": is_playing, + "PlaylistItemId": item_id + }) + + def reset_queue_sync_play(self, queue_item_ids, position=0, position_ticks=0): + """10.7.0+ only""" + return self._post("SyncPlay/SetNewQueue", { + "PlayingQueue": queue_item_ids, + "PlayingItemPosition": position, + "StartPositionTicks": position_ticks + }) + + def ignore_sync_play(self, should_ignore): + """10.7.0+ only""" + return self._post("SyncPlay/SetIgnoreWait", { + "IgnoreWait": should_ignore + }) + + def next_sync_play(self, item_id): + """10.7.0+ only""" + return self._post("SyncPlay/NextItem", { + "PlaylistItemId": item_id + }) + + def prev_sync_play(self, item_id): + """10.7.0+ only""" + return self._post("SyncPlay/PreviousItem", { + "PlaylistItemId": item_id + }) + + def set_item_sync_play(self, item_id): + """10.7.0+ only""" + return self._post("SyncPlay/SetPlaylistItem", { + "PlaylistItemId": item_id + }) + + def ping_sync_play(self, ping): + return self._post("SyncPlay/Ping", { + "Ping": ping + }) + + def new_sync_play(self): + """deprecated (< 10.7.0)""" + return self._post("SyncPlay/New") + + def new_sync_play_v2(self, group_name): + """10.7.0+ only""" + return self._post("SyncPlay/New", { + "GroupName": group_name + }) + diff --git a/jellyfin_apiclient_python/client.py b/jellyfin_apiclient_python/client.py new file mode 100644 index 0000000..474c47c --- /dev/null +++ b/jellyfin_apiclient_python/client.py @@ -0,0 +1,87 @@ +# -*- coding: utf-8 -*- +from __future__ import division, absolute_import, print_function, unicode_literals + +################################################################################################# + +import logging + +from . import api +from .configuration import Config +from .http import HTTP +from .ws_client import WSClient +from .connection_manager import ConnectionManager, CONNECTION_STATE +from .timesync_manager import TimeSyncManager + +################################################################################################# + +LOG = logging.getLogger('JELLYFIN.' + __name__) + +################################################################################################# + + +def callback(message, data): + + ''' Callback function should received message, data + message: string + data: json dictionary + ''' + pass + + +class JellyfinClient(object): + + logged_in = False + + def __init__(self, allow_multiple_clients=False): + LOG.debug("JellyfinClient initializing...") + + self.config = Config() + self.http = HTTP(self) + self.wsc = WSClient(self, allow_multiple_clients) + self.auth = ConnectionManager(self) + self.jellyfin = api.API(self.http) + self.callback_ws = callback + self.callback = callback + self.timesync = TimeSyncManager(self) + + def set_credentials(self, credentials=None): + self.auth.credentials.set_credentials(credentials or {}) + + def get_credentials(self): + return self.auth.credentials.get_credentials() + + def authenticate(self, credentials=None, options=None, discover=True): + + self.set_credentials(credentials or {}) + state = self.auth.connect(options or {}, discover) + + if state['State'] == CONNECTION_STATE['SignedIn']: + + LOG.info("User is authenticated.") + self.logged_in = True + self.callback("ServerOnline", {'Id': self.auth.server_id}) + + state['Credentials'] = self.get_credentials() + + return state + + def start(self, websocket=False, keep_alive=True): + + if not self.logged_in: + raise ValueError("User is not authenticated.") + + self.http.start_session() + + if keep_alive: + self.http.keep_alive = True + + if websocket: + self.start_wsc() + + def start_wsc(self): + self.wsc.start() + + def stop(self): + self.wsc.stop_client() + self.http.stop_session() + self.timesync.stop_ping() diff --git a/jellyfin_apiclient_python/configuration.py b/jellyfin_apiclient_python/configuration.py new file mode 100644 index 0000000..1d93ef9 --- /dev/null +++ b/jellyfin_apiclient_python/configuration.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +from __future__ import division, absolute_import, print_function, unicode_literals + +''' This will hold all configs from the client. + Configuration set here will be used for the HTTP client. +''' + +################################################################################################# + +import logging + +################################################################################################# + +DEFAULT_HTTP_MAX_RETRIES = 3 +DEFAULT_HTTP_TIMEOUT = 30 +LOG = logging.getLogger('JELLYFIN.' + __name__) + +################################################################################################# + + +class Config(object): + + def __init__(self): + + LOG.debug("Configuration initializing...") + self.data = {} + self.http() + + def app(self, name, version, device_name, device_id, capabilities=None, device_pixel_ratio=None): + + LOG.debug("Begin app constructor.") + self.data['app.name'] = name + self.data['app.version'] = version + self.data['app.device_name'] = device_name + self.data['app.device_id'] = device_id + self.data['app.capabilities'] = capabilities + self.data['app.device_pixel_ratio'] = device_pixel_ratio + self.data['app.default'] = False + + def auth(self, server, user_id, token=None, ssl=None): + + LOG.debug("Begin auth constructor.") + self.data['auth.server'] = server + self.data['auth.user_id'] = user_id + self.data['auth.token'] = token + self.data['auth.ssl'] = ssl + + def http(self, user_agent=None, max_retries=DEFAULT_HTTP_MAX_RETRIES, timeout=DEFAULT_HTTP_TIMEOUT): + + LOG.debug("Begin http constructor.") + self.data['http.max_retries'] = max_retries + self.data['http.timeout'] = timeout + self.data['http.user_agent'] = user_agent diff --git a/jellyfin_apiclient_python/connection_manager.py b/jellyfin_apiclient_python/connection_manager.py new file mode 100644 index 0000000..9c6a6af --- /dev/null +++ b/jellyfin_apiclient_python/connection_manager.py @@ -0,0 +1,379 @@ +# -*- coding: utf-8 -*- +from __future__ import division, absolute_import, print_function, unicode_literals + +################################################################################################# + +import json +import logging +import socket +from datetime import datetime +from operator import itemgetter + +import urllib3 + +from .credentials import Credentials +from .api import API +import traceback + +################################################################################################# + +LOG = logging.getLogger('JELLYFIN.' + __name__) +CONNECTION_STATE = { + 'Unavailable': 0, + 'ServerSelection': 1, + 'ServerSignIn': 2, + 'SignedIn': 3 +} + +################################################################################################# + +class ConnectionManager(object): + + user = {} + server_id = None + + def __init__(self, client): + + LOG.debug("ConnectionManager initializing...") + + self.client = client + self.config = client.config + self.credentials = Credentials() + + self.API = API(client) + + def clear_data(self): + + LOG.info("connection manager clearing data") + + self.user = None + credentials = self.credentials.get_credentials() + credentials['Servers'] = list() + self.credentials.get_credentials(credentials) + + self.config.auth(None, None) + + def revoke_token(self): + + LOG.info("revoking token") + + self['server']['AccessToken'] = None + self.credentials.set_credentials(self.credentials.get()) + + self.config.data['auth.token'] = None + + def get_available_servers(self, discover=True): + + LOG.info("Begin getAvailableServers") + + # Clone the credentials + credentials = self.credentials.get() + found_servers = [] + + if discover: + found_servers = self.process_found_servers(self._server_discovery()) + + if not found_servers and not credentials['Servers']: # back out right away, no point in continuing + LOG.info("Found no servers") + return list() + + servers = list(credentials['Servers']) + + # Merges servers we already knew with newly found ones + for found_server in found_servers: + try: + self.credentials.add_update_server(servers, found_server) + except KeyError: + continue + + servers.sort(key=itemgetter('DateLastAccessed'), reverse=True) + credentials['Servers'] = servers + self.credentials.set(credentials) + + return servers + + def login(self, server_url, username, password=None, clear=None, options=None): + + if not username: + raise AttributeError("username cannot be empty") + + if not server_url: + raise AttributeError("server url cannot be empty") + + if clear is not None: + LOG.warn("The clear option on login() has no effect.") + + if options is not None: + LOG.warn("The options option on login() has no effect.") + + data = self.API.login(server_url, username, password) # returns empty dict on failure + + if not data: + LOG.info("Failed to login as `"+username+"`") + return {} + + LOG.info("Succesfully logged in as %s" % (username)) + # TODO Change when moving to database storage of server details + credentials = self.credentials.get() + + self.config.data['auth.user_id'] = data['User']['Id'] + self.config.data['auth.token'] = data['AccessToken'] + + for server in credentials['Servers']: + if server['Id'] == data['ServerId']: + found_server = server + break + else: + return {} # No server found + + found_server['DateLastAccessed'] = datetime.now().strftime('%Y-%m-%dT%H:%M:%SZ') + found_server['UserId'] = data['User']['Id'] + found_server['AccessToken'] = data['AccessToken'] + + self.credentials.add_update_server(credentials['Servers'], found_server) + + info = { + 'Id': data['User']['Id'], + 'IsSignedInOffline': True + } + self.credentials.add_update_user(server, info) + + self.credentials.set_credentials(credentials) + + return data + + + def connect_to_address(self, address, options={}): + + if not address: + return False + + address = self._normalize_address(address) + + try: + response_url = self.API.check_redirect(address) + if address != response_url: + address = response_url + LOG.info("connect_to_address %s succeeded", address) + server = { + 'address': address, + } + server = self.connect_to_server(server, options) + if server is False: + LOG.error("connect_to_address %s failed", address) + return { 'State': CONNECTION_STATE['Unavailable'] } + + return server + except Exception: + LOG.error("connect_to_address %s failed", address) + return { 'State': CONNECTION_STATE['Unavailable'] } + + + def connect_to_server(self, server, options={}): + + LOG.info("begin connect_to_server") + + try: + result = self.API.get_public_info(server.get('address')) + + if not result: + LOG.error("Failed to connect to server: %s" % server.get('address')) + return { 'State': CONNECTION_STATE['Unavailable'] } + + LOG.info("calling onSuccessfulConnection with server %s", server.get('Name')) + + self._update_server_info(server, result) + credentials = self.credentials.get() + return self._after_connect_validated(server, credentials, result, True, options) + + except Exception as e: + LOG.error(traceback.format_exc()) + LOG.error("Failing server connection. ERROR msg: {}".format(e)) + return { 'State': CONNECTION_STATE['Unavailable'] } + + def connect(self, options={}, discover=True): + + LOG.info("Begin connect") + + servers = self.get_available_servers(discover) + LOG.info("connect has %s servers", len(servers)) + + if not (len(servers)): # No servers provided + return { + 'State': ['ServerSelection'] + } + + result = self.connect_to_server(servers[0], options) + LOG.debug("resolving connect with result: %s", result) + + return result + + def jellyfin_user_id(self): + return self.get_server_info(self.server_id)['UserId'] + + def jellyfin_token(self): + return self.get_server_info(self.server_id)['AccessToken'] + + def get_server_info(self, server_id): + + if server_id is None: + LOG.info("server_id is empty") + return {} + + servers = self.credentials.get()['Servers'] + + for server in servers: + if server['Id'] == server_id: + return server + + def get_public_users(self): + return self.client.jellyfin.get_public_users() + + def get_jellyfin_url(self, base, handler): + return "%s/%s" % (base, handler) + + def _server_discovery(self): + MULTI_GROUP = ("", 7359) + MESSAGE = b"who is JellyfinServer?" + + sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM) + sock.settimeout(1.0) # This controls the socket.timeout exception + + sock.setsockopt(socket.IPPROTO_IP, socket.IP_MULTICAST_TTL, 20) + sock.setsockopt(socket.SOL_SOCKET, socket.SO_BROADCAST, 1) + sock.setsockopt(socket.SOL_IP, socket.IP_MULTICAST_LOOP, 1) + sock.setsockopt(socket.IPPROTO_IP, socket.SO_REUSEADDR, 1) + + LOG.debug("MultiGroup : %s", str(MULTI_GROUP)) + LOG.debug("Sending UDP Data: %s", MESSAGE) + + servers = [] + + try: + sock.sendto(MESSAGE, MULTI_GROUP) + except Exception as error: + LOG.exception(traceback.format_exc()) + LOG.exception(error) + return servers + + while True: + try: + data, addr = sock.recvfrom(1024) # buffer size + servers.append(json.loads(data)) + + except socket.timeout: + LOG.info("Found Servers: %s", servers) + return servers + + except Exception as e: + LOG.error(traceback.format_exc()) + LOG.exception("Error trying to find servers: %s", e) + return servers + + def process_found_servers(self, found_servers): + + servers = [] + + for found_server in found_servers: + + server = self._convert_endpoint_address_to_manual_address(found_server) + + info = { + 'Id': found_server['Id'], + 'address': server or found_server['Address'], + 'Name': found_server['Name'] + } + + servers.append(info) + else: + return servers + + # TODO: Make IPv6 compatable + def _convert_endpoint_address_to_manual_address(self, info): + + if info.get('Address') and info.get('EndpointAddress'): + address = info['EndpointAddress'].split(':')[0] + + # Determine the port, if any + parts = info['Address'].split(':') + if len(parts) > 1: + port_string = parts[len(parts) - 1] + + try: + address += ":%s" % int(port_string) + return self._normalize_address(address) + except ValueError: + pass + + return None + + def _normalize_address(self, address): + # TODO: Try HTTPS first, then HTTP if that fails. + if '://' not in address: + address = 'http://' + address + + # Attempt to correct bad input + url = urllib3.util.parse_url(address.strip()) + + if url.scheme is None: + url = url._replace(scheme='http') + + if url.scheme == 'http' and url.port == 80: + url = url._replace(port=None) + + if url.scheme == 'https' and url.port == 443: + url = url._replace(port=None) + + return url.url + + def _after_connect_validated(self, server, credentials, system_info, verify_authentication, options): + if options.get('enableAutoLogin') is False: + + self.config.data['auth.user_id'] = server.pop('UserId', None) + self.config.data['auth.token'] = server.pop('AccessToken', None) + + elif verify_authentication and server.get('AccessToken'): + system_info = self.API.validate_authentication_token(server) + if system_info: + + self._update_server_info(server, system_info) + self.config.data['auth.user_id'] = server['UserId'] + self.config.data['auth.token'] = server['AccessToken'] + + return self._after_connect_validated(server, credentials, system_info, False, options) + + server['UserId'] = None + server['AccessToken'] = None + return { 'State': CONNECTION_STATE['Unavailable'] } + + self._update_server_info(server, system_info) + + server['DateLastAccessed'] = datetime.now().strftime('%Y-%m-%dT%H:%M:%SZ') + self.credentials.add_update_server(credentials['Servers'], server) + self.credentials.set(credentials) + self.server_id = server['Id'] + + # Update configs + self.config.data['auth.server'] = server['address'] + self.config.data['auth.server-name'] = server['Name'] + self.config.data['auth.server=id'] = server['Id'] + self.config.data['auth.ssl'] = options.get('ssl', self.config.data['auth.ssl']) + + result = { + 'Servers': [server] + } + + result['State'] = CONNECTION_STATE['SignedIn'] if server.get('AccessToken') else CONNECTION_STATE['ServerSignIn'] + # Connected + return result + + def _update_server_info(self, server, system_info): + + if server is None or system_info is None: + return + + server['Name'] = system_info['ServerName'] + server['Id'] = system_info['Id'] + + if system_info.get('address'): + server['address'] = system_info['address'] diff --git a/jellyfin_apiclient_python/credentials.py b/jellyfin_apiclient_python/credentials.py new file mode 100644 index 0000000..715abb5 --- /dev/null +++ b/jellyfin_apiclient_python/credentials.py @@ -0,0 +1,128 @@ +# -*- coding: utf-8 -*- +from __future__ import division, absolute_import, print_function, unicode_literals + +################################################################################################# + +import logging +import time +from datetime import datetime + +################################################################################################# + +LOG = logging.getLogger('JELLYFIN.' + __name__) + +################################################################################################# + + +class Credentials(object): + + credentials = None + + def __init__(self): + LOG.debug("Credentials initializing...") + self.credentials = {} + + def set_credentials(self, credentials): + self.credentials = credentials + + def get_credentials(self): + return self.get() + + def _ensure(self): + + if not self.credentials: + try: + LOG.info(self.credentials) + if not isinstance(self.credentials, dict): + raise ValueError("invalid credentials format") + + except Exception as e: # File is either empty or missing + LOG.warning(e) + self.credentials = {} + + LOG.debug("credentials initialized with: %s", self.credentials) + self.credentials['Servers'] = self.credentials.setdefault('Servers', []) + + def get(self): + self._ensure() + + return self.credentials + + def set(self, data): + + if data: + self.credentials.update(data) + else: + self._clear() + + LOG.debug("credentialsupdated") + + def _clear(self): + self.credentials.clear() + + def add_update_user(self, server, user): + + for existing in server.setdefault('Users', []): + if existing['Id'] == user['Id']: + # Merge the data + existing['IsSignedInOffline'] = True + break + else: + server['Users'].append(user) + + def add_update_server(self, servers, server): + + if server.get('Id') is None: + raise KeyError("Server['Id'] cannot be null or empty") + + # Add default DateLastAccessed if doesn't exist. + server.setdefault('DateLastAccessed', "2001-01-01T00:00:00Z") + + for existing in servers: + if existing['Id'] == server['Id']: + + # Merge the data + if server.get('DateLastAccessed'): + if self._date_object(server['DateLastAccessed']) > self._date_object(existing['DateLastAccessed']): + existing['DateLastAccessed'] = server['DateLastAccessed'] + + if server.get('UserLinkType'): + existing['UserLinkType'] = server['UserLinkType'] + + if server.get('AccessToken'): + existing['AccessToken'] = server['AccessToken'] + existing['UserId'] = server['UserId'] + + if server.get('ExchangeToken'): + existing['ExchangeToken'] = server['ExchangeToken'] + + if server.get('ManualAddress'): + existing['ManualAddress'] = server['ManualAddress'] + + if server.get('LocalAddress'): + existing['LocalAddress'] = server['LocalAddress'] + + if server.get('Name'): + existing['Name'] = server['Name'] + + if server.get('LastConnectionMode') is not None: + existing['LastConnectionMode'] = server['LastConnectionMode'] + + if server.get('ConnectServerId'): + existing['ConnectServerId'] = server['ConnectServerId'] + + return existing + else: + servers.append(server) + return server + + def _date_object(self, date): + # Convert string to date + try: + date_obj = time.strptime(date, "%Y-%m-%dT%H:%M:%SZ") + except (ImportError, TypeError): + # TypeError: attribute of type 'NoneType' is not callable + # Known Kodi/python error + date_obj = datetime(*(time.strptime(date, "%Y-%m-%dT%H:%M:%SZ")[0:6])) + + return date_obj diff --git a/jellyfin_apiclient_python/exceptions.py b/jellyfin_apiclient_python/exceptions.py new file mode 100644 index 0000000..6cd5051 --- /dev/null +++ b/jellyfin_apiclient_python/exceptions.py @@ -0,0 +1,11 @@ +# -*- coding: utf-8 -*- +from __future__ import division, absolute_import, print_function, unicode_literals + +################################################################################################# + + +class HTTPException(Exception): + # Jellyfin HTTP exception + def __init__(self, status, message): + self.status = status + self.message = message diff --git a/jellyfin_apiclient_python/http.py b/jellyfin_apiclient_python/http.py new file mode 100644 index 0000000..4cb7ae1 --- /dev/null +++ b/jellyfin_apiclient_python/http.py @@ -0,0 +1,267 @@ +# -*- coding: utf-8 -*- +from __future__ import division, absolute_import, print_function, unicode_literals + +################################################################################################# + +import json +import logging +import time +import urllib + +import requests +from six import string_types + +from .exceptions import HTTPException + +################################################################################################# + +LOG = logging.getLogger('Jellyfin.' + __name__) + +################################################################################################# + + +class HTTP(object): + + session = None + keep_alive = False + + def __init__(self, client): + + self.client = client + self.config = client.config + + def start_session(self): + + self.session = requests.Session() + + max_retries = self.config.data['http.max_retries'] + self.session.mount("http://", requests.adapters.HTTPAdapter(max_retries=max_retries)) + self.session.mount("https://", requests.adapters.HTTPAdapter(max_retries=max_retries)) + + def stop_session(self): + + if self.session is None: + return + + try: + LOG.info("--<[ session/%s ]", id(self.session)) + self.session.close() + except Exception as error: + LOG.warning("The requests session could not be terminated: %s", error) + + def _replace_user_info(self, string): + + if '{server}' in string: + if self.config.data.get('auth.server', None): + string = string.replace("{server}", self.config.data['auth.server']) + else: + LOG.debug("Server address not set") + + if '{UserId}'in string: + if self.config.data.get('auth.user_id', None): + string = string.replace("{UserId}", self.config.data['auth.user_id']) + else: + LOG.debug("UserId is not set.") + + if '{DeviceId}'in string: + if self.config.data.get('app.device_id', None): + string = string.replace("{DeviceId}", self.config.data['app.device_id']) + else: + LOG.debug("DeviceId is not set.") + + return string + + def request_url(self, data): + if not data: + raise AttributeError("Request cannot be empty") + + data = self._request(data) + + params = data["params"] + if "api_key" not in params: + params["api_key"] = self.config.data.get('auth.token') + + encoded_params = urllib.parse.urlencode(data["params"]) + return "%s?%s" % (data["url"], encoded_params) + + def request(self, data, session=None, dest_file=None): + + ''' Give a chance to retry the connection. Jellyfin sometimes can be slow to answer back + data dictionary can contain: + type: GET, POST, etc. + url: (optional) + handler: not considered when url is provided (optional) + params: request parameters (optional) + json: request body (optional) + headers: (optional), + verify: ssl certificate, True (verify using device built-in library) or False + ''' + if not data: + raise AttributeError("Request cannot be empty") + + data = self._request(data) + LOG.debug("--->[ http ] %s", json.dumps(data, indent=4)) + retry = data.pop('retry', 5) + stream = dest_file is not None + + while True: + + try: + r = self._requests(session or self.session or requests, data.pop('type', "GET"), **data, stream=stream) + if stream: + for chunk in r.iter_content(chunk_size=8192): + if chunk: # filter out keep-alive new chunks + dest_file.write(chunk) + else: + r.content # release the connection + + if not self.keep_alive and self.session is not None: + self.stop_session() + + r.raise_for_status() + + except requests.exceptions.ConnectionError as error: + if retry: + + retry -= 1 + time.sleep(1) + + continue + + LOG.error(error) + self.client.callback("ServerUnreachable", {'ServerId': self.config.data['auth.server-id']}) + + raise HTTPException("ServerUnreachable", error) + + except requests.exceptions.ReadTimeout as error: + if retry: + + retry -= 1 + time.sleep(1) + + continue + + LOG.error(error) + + raise HTTPException("ReadTimeout", error) + + except requests.exceptions.HTTPError as error: + LOG.error(error) + + if r.status_code == 401: + + if 'X-Application-Error-Code' in r.headers: + self.client.callback("AccessRestricted", {'ServerId': self.config.data['auth.server-id']}) + + raise HTTPException("AccessRestricted", error) + else: + self.client.callback("Unauthorized", {'ServerId': self.config.data['auth.server-id']}) + self.client.auth.revoke_token() + + raise HTTPException("Unauthorized", error) + + elif r.status_code == 500: # log and ignore. + LOG.error("--[ 500 response ] %s", error) + + return + + elif r.status_code == 502: + if retry: + + retry -= 1 + time.sleep(1) + + continue + + raise HTTPException(r.status_code, error) + + except requests.exceptions.MissingSchema as error: + LOG.error("Request missing Schema. " + str(error)) + raise HTTPException("MissingSchema", {'Id': self.config.data.get('auth.server', "None")}) + + except Exception as error: + raise + + else: + try: + if stream: + return + self.config.data['server-time'] = r.headers['Date'] + elapsed = int(r.elapsed.total_seconds() * 1000) + response = r.json() + LOG.debug("---<[ http ][%s ms]", elapsed) + LOG.debug(json.dumps(response, indent=4)) + + return response + except ValueError: + return + + def _request(self, data): + + if 'url' not in data: + data['url'] = "%s/%s" % (self.config.data.get("auth.server", ""), data.pop('handler', "")) + + self._get_header(data) + data['timeout'] = data.get('timeout') or self.config.data['http.timeout'] + data['verify'] = data.get('verify') or self.config.data.get('auth.ssl', False) + data['url'] = self._replace_user_info(data['url']) + self._process_params(data.get('params') or {}) + self._process_params(data.get('json') or {}) + + return data + + def _process_params(self, params): + + for key in params: + value = params[key] + + if isinstance(value, dict): + self._process_params(value) + + if isinstance(value, string_types): + params[key] = self._replace_user_info(value) + + def _get_header(self, data): + + data['headers'] = data.setdefault('headers', {}) + + if not data['headers']: + data['headers'].update({ + 'Content-type': "application/json", + 'Accept-Charset': "UTF-8,*", + 'Accept-encoding': "gzip", + 'User-Agent': self.config.data['http.user_agent'] or "%s/%s" % (self.config.data.get('app.name', 'Jellyfin for Kodi'), self.config.data.get('app.version', "0.0.0")) + }) + + if 'x-emby-authorization' not in data['headers']: + self._authorization(data) + + return data + + def _authorization(self, data): + + auth = "MediaBrowser " + auth += "Client=%s, " % self.config.data.get('app.name', "Jellyfin for Kodi") + auth += "Device=%s, " % self.config.data.get('app.device_name', 'Unknown Device') + auth += "DeviceId=%s, " % self.config.data.get('app.device_id', 'Unknown Device id') + auth += "Version=%s" % self.config.data.get('app.version', '0.0.0') + + data['headers'].update({'x-emby-authorization': auth}) + + if self.config.data.get('auth.token') and self.config.data.get('auth.user_id'): + + auth += ', UserId=%s' % self.config.data.get('auth.user_id') + data['headers'].update({'x-emby-authorization': auth, 'X-MediaBrowser-Token': self.config.data.get('auth.token')}) + + return data + + def _requests(self, session, action, **kwargs): + + if action == "GET": + return session.get(**kwargs) + elif action == "POST": + return session.post(**kwargs) + elif action == "HEAD": + return session.head(**kwargs) + elif action == "DELETE": + return session.delete(**kwargs) diff --git a/jellyfin_apiclient_python/keepalive.py b/jellyfin_apiclient_python/keepalive.py new file mode 100644 index 0000000..7d9e40e --- /dev/null +++ b/jellyfin_apiclient_python/keepalive.py @@ -0,0 +1,20 @@ +import threading + +class KeepAlive(threading.Thread): + def __init__(self, timeout, ws): + self.halt = threading.Event() + self.timeout = timeout + self.ws = ws + + threading.Thread.__init__(self) + + def stop(self): + self.halt.set() + self.join() + + def run(self): + while not self.halt.is_set(): + if self.halt.wait(self.timeout/2): + break + else: + self.ws.send("KeepAlive") diff --git a/jellyfin_apiclient_python/timesync_manager.py b/jellyfin_apiclient_python/timesync_manager.py new file mode 100644 index 0000000..5c4e98e --- /dev/null +++ b/jellyfin_apiclient_python/timesync_manager.py @@ -0,0 +1,140 @@ +# This is based on https://github.com/jellyfin/jellyfin-web/blob/master/src/components/syncPlay/timeSyncManager.js +import threading +import logging +import datetime + +LOG = logging.getLogger('Jellyfin.' + __name__) + +number_of_tracked_measurements = 8 +polling_interval_greedy = 1 +polling_interval_low_profile = 60 +greedy_ping_count = 3 + + +class Measurement: + def __init__(self, request_sent, request_received, response_sent, response_received): + self.request_sent = request_sent + self.request_received = request_received + self.response_sent = response_sent + self.response_received = response_received + + def get_offset(self): + """Time offset from server.""" + return ((self.request_received - self.request_sent) + (self.response_sent - self.response_received)) / 2.0 + + def get_delay(self): + """Get round-trip delay.""" + return (self.response_received - self.request_sent) - (self.response_sent - self.request_received) + + def get_ping(self): + """Get ping time.""" + return self.get_delay() / 2.0 + + +class _TimeSyncThread(threading.Thread): + def __init__(self, manager): + self.manager = manager + self.halt = threading.Event() + threading.Thread.__init__(self) + + def run(self): + while not self.halt.wait(self.manager.polling_interval): + try: + measurement = self.manager.client.jellyfin.utc_time() + measurement = Measurement(measurement["request_sent"], measurement["request_received"], + measurement["response_sent"], measurement["response_received"]) + + self.manager.update_time_offset(measurement) + + if self.manager.pings > greedy_ping_count: + self.manager.polling_interval = polling_interval_low_profile + else: + self.manager.pings += 1 + + self.manager._notify_subscribers() + except Exception: + LOG.error("Timesync call failed.", exc_info=True) + + def stop(self): + self.halt.set() + self.join() + + +class TimeSyncManager: + def __init__(self, client): + self.ping_stop = True + self.polling_interval = polling_interval_greedy + self.poller = None + self.pings = 0 # number of pings + self.measurement = None # current time sync + self.measurements = [] + self.client = client + self.timesync_thread = None + self.subscribers = set() + + def is_ready(self): + """Gets status of time sync.""" + return self.measurement is not None + + def get_time_offset(self): + """Gets time offset with server.""" + return self.measurement.get_offset() if self.measurement is not None else datetime.timedelta(0) + + def get_ping(self): + """Gets ping time to server.""" + return self.measurement.get_ping() if self.measurement is not None else datetime.timedelta(0) + + def update_time_offset(self, measurement): + """Updates time offset between server and client.""" + self.measurements.append(measurement) + if len(self.measurements) > number_of_tracked_measurements: + self.measurements.pop(0) + + self.measurement = min(self.measurements, key=lambda x: x.get_delay()) + + def reset_measurements(self): + """Drops accumulated measurements.""" + self.measurement = None + self.measurements = [] + + def start_ping(self): + """Starts the time poller.""" + if not self.timesync_thread: + self.timesync_thread = _TimeSyncThread(self) + self.timesync_thread.start() + + def stop_ping(self): + """Stops the time poller.""" + if self.timesync_thread: + self.timesync_thread.stop() + self.timesync_thread = None + + def force_update(self): + """Resets poller into greedy mode.""" + self.stop_ping() + self.polling_interval = polling_interval_greedy + self.pings = 0 + self.start_ping() + + def server_date_to_local(self, server): + """Converts server time to local time.""" + return server - self.get_time_offset() + + def local_date_to_server(self, local): + """Converts local time to server time.""" + return local + self.get_time_offset() + + def subscribe_time_offset(self, subscriber_callable): + """Pass a callback function to get notified about time offset changes.""" + self.subscribers.add(subscriber_callable) + + def remove_subscriber(self, subscriber_callable): + """Remove a callback function from notifications.""" + self.subscribers.remove(subscriber_callable) + + def _notify_subscribers(self): + for subscriber in self.subscribers: + try: + subscriber(self.get_time_offset(), self.get_ping()) + except Exception: + LOG.error("Exception in subscriber callback.") diff --git a/jellyfin_apiclient_python/ws_client.py b/jellyfin_apiclient_python/ws_client.py new file mode 100644 index 0000000..d36310b --- /dev/null +++ b/jellyfin_apiclient_python/ws_client.py @@ -0,0 +1,140 @@ +# -*- coding: utf-8 -*- +from __future__ import division, absolute_import, print_function, unicode_literals + +################################################################################################# + +import json +import logging +import threading +import ssl +import certifi + +import websocket + +from .keepalive import KeepAlive + +################################################################################################## + +LOG = logging.getLogger('JELLYFIN.' + __name__) + +################################################################################################## + + +class WSClient(threading.Thread): + multi_client = False + global_wsc = None + global_stop = False + + def __init__(self, client, allow_multiple_clients=False): + + LOG.debug("WSClient initializing...") + + self.client = client + self.keepalive = None + self.wsc = None + self.stop = False + self.message_ids = set() + + if self.multi_client or allow_multiple_clients: + self.multi_client = True + + threading.Thread.__init__(self) + + def send(self, message, data=""): + if self.wsc is None: + raise ValueError("The websocket client is not started.") + + self.wsc.send(json.dumps({'MessageType': message, "Data": data})) + + def run(self): + + token = self.client.config.data['auth.token'] + device_id = self.client.config.data['app.device_id'] + server = self.client.config.data['auth.server'] + server = server.replace('https', "wss") if server.startswith('https') else server.replace('http', "ws") + wsc_url = "%s/socket?api_key=%s&device_id=%s" % (server, token, device_id) + verify = self.client.config.data.get('auth.ssl', False) + + LOG.info("Websocket url: %s", wsc_url) + + self.wsc = websocket.WebSocketApp(wsc_url, + on_message=lambda ws, message: self.on_message(ws, message), + on_error=lambda ws, error: self.on_error(ws, error)) + self.wsc.on_open = lambda ws: self.on_open(ws) + + if not self.multi_client: + if self.global_wsc is not None: + self.global_wsc.close() + self.global_wsc = self.wsc + + while not self.stop and not self.global_stop: + if not verify: + # https://stackoverflow.com/questions/48740053/ + self.wsc.run_forever( + ping_interval=10, sslopt={"cert_reqs": ssl.CERT_NONE} + ) + else: + self.wsc.run_forever(ping_interval=10, sslopt={"ca_certs": certifi.where()}) + + if not self.stop: + break + + LOG.info("---<[ websocket ]") + self.client.callback('WebSocketDisconnect', None) + + def on_error(self, ws, error): + LOG.error(error) + self.client.callback('WebSocketError', error) + + def on_open(self, ws): + LOG.info("--->[ websocket ]") + self.client.callback('WebSocketConnect', None) + + def on_message(self, ws, message): + + message = json.loads(message) + + # If a message is received multiple times, ignore repeats. + message_id = message.get("MessageId") + if message_id is not None: + if message_id in self.message_ids: + return + self.message_ids.add(message_id) + + data = message.get('Data', {}) + + if message['MessageType'] == "ForceKeepAlive": + self.send("KeepAlive") + if self.keepalive is not None: + self.keepalive.stop() + self.keepalive = KeepAlive(data, self) + self.keepalive.start() + LOG.debug("ForceKeepAlive received from server.") + return + elif message['MessageType'] == "KeepAlive": + LOG.debug("KeepAlive received from server.") + return + + if data is None: + data = {} + elif type(data) is not dict: + data = {"value": data} + + if not self.client.config.data['app.default']: + data['ServerId'] = self.client.auth.server_id + + self.client.callback(message['MessageType'], data) + + def stop_client(self): + + self.stop = True + + if self.keepalive is not None: + self.keepalive.stop() + + if self.wsc is not None: + self.wsc.close() + + if not self.multi_client: + self.global_stop = True + self.global_wsc = None diff --git a/joc.py b/joc.py new file mode 100755 index 0000000..b836222 --- /dev/null +++ b/joc.py @@ -0,0 +1,41 @@ +#!/usr/bin/env python3 + +""" +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +any later version. +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +""" + +import os +import sys +import subprocess +import urwid + +import interface +import config +import jellyfin +import database + +def main(): + if not os.path.exists(os.path.expanduser("~/.config/joc")): + os.mkdir(os.path.expanduser("~/.config/joc")) + parser = config.read_config_file() + dbpath = parser.get("connection","database", + fallback=os.path.expanduser("~/.config/joc/jellyfin.db")) + db = database.Database(dbpath) + conn = jellyfin.JellyfinConnection(parser) + libs = conn.get_libraries() + tui = interface.Interface(conn, libs, parser, db) + tui.start() + + +if __name__ == '__main__': + main() -- cgit v1.2.3