diff --git a/mediarepo-api/.github/workflows/build.yml b/mediarepo-api/.github/workflows/build.yml new file mode 100644 index 0000000..1df7aef --- /dev/null +++ b/mediarepo-api/.github/workflows/build.yml @@ -0,0 +1,50 @@ +name: Build on multiple platforms + +on: + push: + branches: [ main, develop ] + pull_request: + branches: [ main, develop ] + +env: + CARGO_TERM_COLOR: always + +jobs: + + build: + strategy: + fail-fast: false + matrix: + os: [ubuntu-latest, macos-latest, windows-latest] + runs-on: ${{ matrix.os }} + steps: + - uses: actions/checkout@v2 + + - name: Cache build data + uses: actions/cache@v2 + with: + path: | + target + ~/.cargo/ + key: ${{ runner.os }}-cargo-${{ hashFiles('Cargo.lock') }} + restore-keys: | + ${{ runner.os }}-cargo- + + - name: Install OS-specific dependencies + uses: knicknic/os-specific-run@v1.0.3 + with: + linux: | + sudo apt update + sudo apt install libwebkit2gtk-4.0-dev libgtk-3-dev libappindicator3-dev -y + + - name: Build + run: cargo build + + - name: Build API + run: cargo build --features=client-api + + - name: Build Plugin + run: cargo build --features=tauri-plugin + + - name: Test + run: cargo test --all-features \ No newline at end of file diff --git a/mediarepo-api/.gitignore b/mediarepo-api/.gitignore new file mode 100644 index 0000000..96ef6c0 --- /dev/null +++ b/mediarepo-api/.gitignore @@ -0,0 +1,2 @@ +/target +Cargo.lock diff --git a/mediarepo-api/.idea/.gitignore b/mediarepo-api/.idea/.gitignore new file mode 100644 index 0000000..13566b8 --- /dev/null +++ b/mediarepo-api/.idea/.gitignore @@ -0,0 +1,8 @@ +# Default ignored files +/shelf/ +/workspace.xml +# Editor-based HTTP Client requests +/httpRequests/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml diff --git a/mediarepo-api/.idea/discord.xml b/mediarepo-api/.idea/discord.xml new file mode 100644 index 0000000..d8e9561 --- /dev/null +++ b/mediarepo-api/.idea/discord.xml @@ -0,0 +1,7 @@ + + + + + \ No newline at end of file diff --git a/mediarepo-api/.idea/mediarepo-api.iml b/mediarepo-api/.idea/mediarepo-api.iml new file mode 100644 index 0000000..c254557 --- /dev/null +++ b/mediarepo-api/.idea/mediarepo-api.iml @@ -0,0 +1,11 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/mediarepo-api/.idea/modules.xml b/mediarepo-api/.idea/modules.xml new file mode 100644 index 0000000..83599d9 --- /dev/null +++ b/mediarepo-api/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/mediarepo-api/.idea/vcs.xml b/mediarepo-api/.idea/vcs.xml new file mode 100644 index 0000000..94a25f7 --- /dev/null +++ b/mediarepo-api/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/mediarepo-api/Cargo.toml b/mediarepo-api/Cargo.toml new file mode 100644 index 0000000..e350b59 --- /dev/null +++ b/mediarepo-api/Cargo.toml @@ -0,0 +1,52 @@ +[package] +name = "mediarepo-api" +version = "0.27.0" +edition = "2018" +license = "gpl-3" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] +tracing = "^0.1.29" +thiserror = "^1.0.30" +async-trait = {version = "^0.1.52", optional=true} +parking_lot = {version="^0.11.2", optional=true} +serde_json = {version="^1.0.73", optional=true} +directories = {version="^4.0.1", optional=true} +mime_guess = {version = "^2.0.3", optional=true} +serde_piecewise_default = "^0.2.0" +futures = {version = "^0.3.19", optional=true} +url = {version = "^2.2.2", optional=true } +pathsearch = {version="^0.2.0", optional=true} + +[dependencies.bromine] +version = "^0.17.1" +optional = true +features = ["serialize_bincode"] + +[dependencies.serde] +version = "^1.0.132" +features = ["serde_derive"] + +[dependencies.chrono] +version = "^0.4.19" +features = ["serde"] + +[dependencies.tauri] +version = "^1.0.0-beta.8" +optional=true +default-features = false +features = [] + +[dependencies.tokio] +version = "^1.15.0" +optional = true +features = ["sync", "fs", "net", "io-util", "io-std", "time", "rt", "process"] + +[dependencies.toml] +version = "^0.5.8" +optional = true + +[features] +tauri-plugin = ["client-api","tauri", "parking_lot", "serde_json", "tokio", "toml", "directories", "mime_guess", "futures", "url"] +client-api = ["bromine", "async-trait", "tokio", "pathsearch"] \ No newline at end of file diff --git a/mediarepo-api/LICENSE b/mediarepo-api/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/mediarepo-api/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/mediarepo-api/README.md b/mediarepo-api/README.md new file mode 100644 index 0000000..276d073 --- /dev/null +++ b/mediarepo-api/README.md @@ -0,0 +1,16 @@ +

+mediarepo-api +

+

+This project is a work in progress +

+ +- - - + +This repository contains common mediarepo API types to implement the API both serverside +and clientside. It also contains a tauri plugin (feature "tauri-plugin") to hook it +into the tauri application lifecycle. + +## License + +GPL-3 \ No newline at end of file diff --git a/mediarepo-api/src/client_api/error.rs b/mediarepo-api/src/client_api/error.rs new file mode 100644 index 0000000..f5e9e05 --- /dev/null +++ b/mediarepo-api/src/client_api/error.rs @@ -0,0 +1,12 @@ +use thiserror::Error; + +pub type ApiResult = Result; + +#[derive(Debug, Error)] +pub enum ApiError { + #[error(transparent)] + IPC(#[from] bromine::error::Error), + + #[error("The servers api version (version {server:?}) is incompatible with the api client {client:?}")] + VersionMismatch { server: String, client: String }, +} diff --git a/mediarepo-api/src/client_api/file.rs b/mediarepo-api/src/client_api/file.rs new file mode 100644 index 0000000..b0fb29b --- /dev/null +++ b/mediarepo-api/src/client_api/file.rs @@ -0,0 +1,205 @@ +use crate::client_api::error::ApiResult; +use crate::client_api::IPCApi; +use crate::types::files::{ + AddFileRequestHeader, FileBasicDataResponse, FileMetadataResponse, FileOSMetadata, FileStatus, + GetFileThumbnailOfSizeRequest, GetFileThumbnailsRequest, ReadFileRequest, + ThumbnailMetadataResponse, UpdateFileNameRequest, UpdateFileStatusRequest, +}; +use crate::types::filtering::{FilterExpression, FindFilesRequest, SortKey}; +use crate::types::identifier::FileIdentifier; +use async_trait::async_trait; +use bromine::context::{PoolGuard, PooledContext}; +use bromine::payload::BytePayload; +use bromine::prelude::*; +use tokio::time::Duration; + +pub struct FileApi { + ctx: PooledContext, +} + +impl Clone for FileApi { + fn clone(&self) -> Self { + Self { + ctx: self.ctx.clone(), + } + } +} + +#[async_trait] +impl IPCApi for FileApi { + fn namespace() -> &'static str { + "files" + } + + fn ctx(&self) -> PoolGuard { + self.ctx.acquire() + } +} + +impl FileApi { + /// Creates a new file api client + pub fn new(ctx: PooledContext) -> Self { + Self { ctx } + } + + /// Returns all known files + #[tracing::instrument(level = "debug", skip(self))] + pub async fn all_files(&self) -> ApiResult> { + self.emit_and_get("all_files", (), Some(Duration::from_secs(30))) + .await + } + + /// Returns a file by identifier + #[tracing::instrument(level = "debug", skip(self))] + pub async fn get_file(&self, id: FileIdentifier) -> ApiResult { + self.emit_and_get("get_file", id, Some(Duration::from_secs(2))) + .await + } + + /// Returns metadata for a range of files + #[tracing::instrument(level = "debug", skip(self, ids))] + pub async fn get_files( + &self, + ids: Vec, + ) -> ApiResult> { + self.emit_and_get("get_files", ids, Some(Duration::from_secs(10))) + .await + } + + pub async fn get_file_metadata(&self, id: FileIdentifier) -> ApiResult { + self.emit_and_get("get_file_metadata", id, Some(Duration::from_secs(2))) + .await + } + + /// Searches for a file by a list of tags + #[tracing::instrument(level = "debug", skip(self))] + pub async fn find_files( + &self, + filters: Vec, + sort_expression: Vec, + ) -> ApiResult> { + self.emit_and_get( + "find_files", + FindFilesRequest { + filters, + sort_expression, + }, + Some(Duration::from_secs(20)), + ) + .await + } + + /// Reads the file and returns its contents as bytes + #[tracing::instrument(level = "debug", skip(self))] + pub async fn read_file(&self, id: FileIdentifier) -> ApiResult> { + let payload: BytePayload = self + .emit_and_get( + "read_file", + ReadFileRequest { id }, + Some(Duration::from_secs(60)), + ) + .await?; + + Ok(payload.into_inner()) + } + + /// Adds a file with predefined tags + #[tracing::instrument(level = "debug", skip(self, bytes))] + pub async fn add_file( + &self, + metadata: FileOSMetadata, + tags: Vec, + bytes: Vec, + ) -> ApiResult { + let payload = TandemPayload::new( + AddFileRequestHeader { metadata, tags }, + BytePayload::new(bytes), + ); + + self.emit_and_get("add_file", payload, Some(Duration::from_secs(5))) + .await + } + + /// Updates a files name + #[tracing::instrument(level = "debug", skip(self))] + pub async fn update_file_name( + &self, + file_id: FileIdentifier, + name: String, + ) -> ApiResult { + self.emit_and_get( + "update_file_name", + UpdateFileNameRequest { file_id, name }, + Some(Duration::from_secs(1)), + ) + .await + } + + /// Updates the status of a file + #[tracing::instrument(level = "debug", skip(self))] + pub async fn update_file_status( + &self, + file_id: FileIdentifier, + status: FileStatus, + ) -> ApiResult { + self.emit_and_get( + "update_file_status", + UpdateFileStatusRequest { status, file_id }, + Some(Duration::from_secs(1)), + ) + .await + } + + /// Permanently deletes a file from the disk and database + #[tracing::instrument(level = "debug", skip(self))] + pub async fn delete_file(&self, file_id: FileIdentifier) -> ApiResult<()> { + self.emit_and_get("delete_file", file_id, Some(Duration::from_secs(10))) + .await + } + + /// Returns a list of all thumbnails of the file + #[tracing::instrument(level = "debug", skip(self))] + pub async fn get_file_thumbnails( + &self, + id: FileIdentifier, + ) -> ApiResult> { + self.emit_and_get( + "get_thumbnails", + GetFileThumbnailsRequest { id }, + Some(Duration::from_secs(2)), + ) + .await + } + + /// Returns a thumbnail of size that is within the specified range + #[tracing::instrument(level = "debug", skip(self))] + pub async fn get_thumbnail_of_size( + &self, + file_id: FileIdentifier, + min_size: (u32, u32), + max_size: (u32, u32), + ) -> ApiResult<(ThumbnailMetadataResponse, Vec)> { + let payload: TandemPayload, BytePayload> = self + .emit_and_get( + "get_thumbnail_of_size", + GetFileThumbnailOfSizeRequest { + id: file_id, + min_size, + max_size, + }, + Some(Duration::from_secs(2)), + ) + .await?; + let (metadata, bytes) = payload.into_inner(); + + Ok((metadata.data(), bytes.into_inner())) + } + + /// Deletes all thumbnails of a file to regenerate them when requested + #[tracing::instrument(level = "debug", skip(self))] + pub async fn delete_thumbnails(&self, file_id: FileIdentifier) -> ApiResult<()> { + self.emit("delete_thumbnails", file_id).await?; + + Ok(()) + } +} diff --git a/mediarepo-api/src/client_api/job.rs b/mediarepo-api/src/client_api/job.rs new file mode 100644 index 0000000..fe05ac8 --- /dev/null +++ b/mediarepo-api/src/client_api/job.rs @@ -0,0 +1,40 @@ +use crate::client_api::error::ApiResult; +use crate::client_api::IPCApi; +use crate::types::jobs::{JobType, RunJobRequest}; +use bromine::context::{Context, PoolGuard, PooledContext}; +use std::time::Duration; + +#[derive(Clone)] +pub struct JobApi { + ctx: PooledContext, +} + +impl IPCApi for JobApi { + fn namespace() -> &'static str { + "jobs" + } + + fn ctx(&self) -> PoolGuard { + self.ctx.acquire() + } +} + +impl JobApi { + pub fn new(ctx: PooledContext) -> Self { + Self { ctx } + } + + /// Runs a job of the given type and returns when it has finished + #[tracing::instrument(level = "debug", skip(self))] + pub async fn run_job(&self, job_type: JobType) -> ApiResult<()> { + self.emit_and_get( + "run_job", + RunJobRequest { + job_type, + sync: true, + }, + Some(Duration::from_secs(3600)), + ) + .await + } +} diff --git a/mediarepo-api/src/client_api/mod.rs b/mediarepo-api/src/client_api/mod.rs new file mode 100644 index 0000000..c3fbf2f --- /dev/null +++ b/mediarepo-api/src/client_api/mod.rs @@ -0,0 +1,133 @@ +pub mod error; +pub mod file; +pub mod job; +pub mod protocol; +pub mod repo; +pub mod tag; + +use crate::client_api::error::{ApiError, ApiResult}; +use crate::client_api::file::FileApi; +use crate::client_api::job::JobApi; +use crate::client_api::repo::RepoApi; +use crate::client_api::tag::TagApi; +use crate::types::misc::{check_apis_compatible, get_api_version, InfoResponse}; +use async_trait::async_trait; +use bromine::ipc::stream_emitter::EmitMetadata; +use bromine::prelude::*; +use tokio::time::Duration; + +#[async_trait] +pub trait IPCApi { + fn namespace() -> &'static str; + fn ctx(&self) -> PoolGuard; + + fn emit(&self, event_name: &str, data: T) -> EmitMetadata { + let ctx = self.ctx(); + ctx.emit_to(Self::namespace(), event_name, data) + } + + async fn emit_and_get( + &self, + event_name: &str, + data: T, + timeout: Option, + ) -> ApiResult { + let mut meta = self.emit(event_name, data).await_reply(); + + if let Some(timeout) = timeout { + meta = meta.with_timeout(timeout); + } + let response = meta.await?; + + Ok(response.payload()?) + } +} +pub struct ApiClient { + ctx: PooledContext, + pub file: FileApi, + pub tag: TagApi, + pub repo: RepoApi, + pub job: JobApi, +} + +impl Clone for ApiClient { + fn clone(&self) -> Self { + Self { + ctx: self.ctx.clone(), + file: self.file.clone(), + tag: self.tag.clone(), + repo: self.repo.clone(), + job: self.job.clone(), + } + } +} + +impl ApiClient { + /// Creates a new client from an existing ipc context + pub fn new(ctx: PooledContext) -> Self { + Self { + file: FileApi::new(ctx.clone()), + tag: TagApi::new(ctx.clone()), + repo: RepoApi::new(ctx.clone()), + job: JobApi::new(ctx.clone()), + ctx, + } + } + + /// Connects to the ipc Socket + #[tracing::instrument(level = "debug")] + pub async fn connect( + address: L::AddressType, + ) -> ApiResult { + let ctx = IPCBuilder::::new() + .address(address) + .timeout(Duration::from_secs(10)) + .build_pooled_client(8) + .await?; + let client = Self::new(ctx); + let info = client.info().await?; + let server_api_version = info.api_version(); + + if !check_apis_compatible(get_api_version(), server_api_version) { + let server_version_string = format!( + "{}.{}.{}", + server_api_version.0, server_api_version.1, server_api_version.2 + ); + let client_version_string = env!("CARGO_PKG_VERSION").to_string(); + Err(ApiError::VersionMismatch { + server: server_version_string, + client: client_version_string, + }) + } else { + Ok(client) + } + } + + /// Returns information about the connected ipc server + #[tracing::instrument(level = "debug", skip(self))] + pub async fn info(&self) -> ApiResult { + let ctx = self.ctx.acquire(); + let res = ctx.emit("info", ()).await_reply().await?; + Ok(res.payload::()?) + } + + /// Shuts down the daemon that the client is connected to. + #[tracing::instrument(level = "debug", skip(self))] + pub async fn shutdown_daemon(&self) -> ApiResult<()> { + self.ctx + .acquire() + .emit("shutdown", ()) + .await_reply() + .with_timeout(Duration::from_secs(5)) + .await?; + Ok(()) + } + + #[tracing::instrument(level = "debug", skip(self))] + pub async fn exit(self) -> ApiResult<()> { + let ctx = (*self.ctx.acquire()).clone(); + + ctx.stop().await?; + Ok(()) + } +} diff --git a/mediarepo-api/src/client_api/protocol.rs b/mediarepo-api/src/client_api/protocol.rs new file mode 100644 index 0000000..fad6e8f --- /dev/null +++ b/mediarepo-api/src/client_api/protocol.rs @@ -0,0 +1,184 @@ +use async_trait::async_trait; +use bromine::error::Result; +use bromine::prelude::IPCResult; +use bromine::protocol::*; +use std::io::Error; +use std::net::ToSocketAddrs; +use std::pin::Pin; +use std::task::{Context, Poll}; +use tokio::io::{AsyncRead, AsyncWrite, ReadBuf}; +use tokio::net::{TcpListener, TcpStream}; + +#[derive(Debug)] +pub enum ApiProtocolListener { + #[cfg(unix)] + UnixSocket(tokio::net::UnixListener), + + Tcp(TcpListener), +} + +unsafe impl Send for ApiProtocolListener {} +unsafe impl Sync for ApiProtocolListener {} + +#[async_trait] +impl AsyncStreamProtocolListener for ApiProtocolListener { + type AddressType = String; + type RemoteAddressType = String; + type Stream = ApiProtocolStream; + + #[tracing::instrument] + async fn protocol_bind(address: Self::AddressType) -> Result { + if let Some(addr) = address.to_socket_addrs().ok().and_then(|mut a| a.next()) { + let listener = TcpListener::bind(addr).await?; + tracing::info!("Connecting via TCP"); + + Ok(Self::Tcp(listener)) + } else { + #[cfg(unix)] + { + use std::path::PathBuf; + use tokio::net::UnixListener; + let path = PathBuf::from(address); + let listener = UnixListener::bind(path)?; + tracing::info!("Connecting via unix domain socket"); + + Ok(Self::UnixSocket(listener)) + } + #[cfg(not(unix))] + { + use bromine::prelude::IPCError; + Err(IPCError::BuildError( + "The address can not be made into a socket address".to_string(), + )) + } + } + } + + async fn protocol_accept(&self) -> Result<(Self::Stream, Self::RemoteAddressType)> { + match self { + #[cfg(unix)] + ApiProtocolListener::UnixSocket(listener) => { + let (stream, addr) = listener.accept().await?; + Ok(( + ApiProtocolStream::UnixSocket(stream), + addr.as_pathname() + .map(|p| p.to_str().unwrap().to_string()) + .unwrap_or(String::from("unknown")), + )) + } + ApiProtocolListener::Tcp(listener) => { + let (stream, addr) = listener.accept().await?; + Ok((ApiProtocolStream::Tcp(stream), addr.to_string())) + } + } + } +} + +#[derive(Debug)] +pub enum ApiProtocolStream { + #[cfg(unix)] + UnixSocket(tokio::net::UnixStream), + + Tcp(TcpStream), +} + +unsafe impl Send for ApiProtocolStream {} +unsafe impl Sync for ApiProtocolStream {} + +impl AsyncProtocolStreamSplit for ApiProtocolStream { + type OwnedSplitReadHalf = Box; + type OwnedSplitWriteHalf = Box; + + fn protocol_into_split(self) -> (Self::OwnedSplitReadHalf, Self::OwnedSplitWriteHalf) { + match self { + #[cfg(unix)] + ApiProtocolStream::UnixSocket(stream) => { + let (read, write) = stream.into_split(); + (Box::new(read), Box::new(write)) + } + ApiProtocolStream::Tcp(stream) => { + let (read, write) = stream.into_split(); + (Box::new(read), Box::new(write)) + } + } + } +} + +#[async_trait] +impl AsyncProtocolStream for ApiProtocolStream { + type AddressType = String; + + async fn protocol_connect(address: Self::AddressType) -> IPCResult { + if let Some(addr) = address.to_socket_addrs().ok().and_then(|mut a| a.next()) { + let stream = TcpStream::connect(addr).await?; + Ok(Self::Tcp(stream)) + } else { + #[cfg(unix)] + { + use std::path::PathBuf; + use tokio::net::UnixStream; + let path = PathBuf::from(address); + let stream = UnixStream::connect(path).await?; + + Ok(Self::UnixSocket(stream)) + } + #[cfg(not(unix))] + { + use bromine::prelude::IPCError; + Err(IPCError::BuildError( + "The address can not be made into a socket address".to_string(), + )) + } + } + } +} + +impl AsyncRead for ApiProtocolStream { + fn poll_read( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &mut ReadBuf<'_>, + ) -> Poll> { + match self.get_mut() { + #[cfg(unix)] + ApiProtocolStream::UnixSocket(stream) => Pin::new(stream).poll_read(cx, buf), + ApiProtocolStream::Tcp(stream) => Pin::new(stream).poll_read(cx, buf), + } + } +} + +impl AsyncWrite for ApiProtocolStream { + fn poll_write( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + buf: &[u8], + ) -> Poll> { + match self.get_mut() { + #[cfg(unix)] + ApiProtocolStream::UnixSocket(stream) => Pin::new(stream).poll_write(cx, buf), + ApiProtocolStream::Tcp(stream) => Pin::new(stream).poll_write(cx, buf), + } + } + + fn poll_flush( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + ) -> Poll> { + match self.get_mut() { + #[cfg(unix)] + ApiProtocolStream::UnixSocket(stream) => Pin::new(stream).poll_flush(cx), + ApiProtocolStream::Tcp(stream) => Pin::new(stream).poll_flush(cx), + } + } + + fn poll_shutdown( + self: Pin<&mut Self>, + cx: &mut Context<'_>, + ) -> Poll> { + match self.get_mut() { + #[cfg(unix)] + ApiProtocolStream::UnixSocket(stream) => Pin::new(stream).poll_shutdown(cx), + ApiProtocolStream::Tcp(stream) => Pin::new(stream).poll_flush(cx), + } + } +} diff --git a/mediarepo-api/src/client_api/repo.rs b/mediarepo-api/src/client_api/repo.rs new file mode 100644 index 0000000..1236f1d --- /dev/null +++ b/mediarepo-api/src/client_api/repo.rs @@ -0,0 +1,56 @@ +use bromine::prelude::*; +use tokio::time::Duration; + +use crate::client_api::error::ApiResult; +use crate::client_api::IPCApi; +use crate::types::repo::{FrontendState, RepositoryMetadata, SizeMetadata, SizeType}; + +#[derive(Clone)] +pub struct RepoApi { + ctx: PooledContext, +} + +impl IPCApi for RepoApi { + fn namespace() -> &'static str { + "repo" + } + + fn ctx(&self) -> PoolGuard { + self.ctx.acquire() + } +} + +impl RepoApi { + pub fn new(ctx: PooledContext) -> Self { + Self { ctx } + } + + /// Returns metadata about the repository + #[tracing::instrument(level = "debug", skip(self))] + pub async fn get_repo_metadata(&self) -> ApiResult { + self.emit_and_get("repository_metadata", (), Some(Duration::from_secs(3))) + .await + } + + /// Returns the size of a given type + #[tracing::instrument(level = "debug", skip(self))] + pub async fn get_size(&self, size_type: SizeType) -> ApiResult { + self.emit_and_get("size_metadata", size_type, Some(Duration::from_secs(30))) + .await + } + + /// Returns the state of the frontend that is stored in the repo + #[tracing::instrument(level = "debug", skip(self))] + pub async fn get_frontend_state(&self) -> ApiResult { + self.emit_and_get("frontend_state", (), Some(Duration::from_secs(5))) + .await + } + + /// Sets the state of the frontend + #[tracing::instrument(level = "debug", skip(self))] + pub async fn set_frontend_state(&self, state: FrontendState) -> ApiResult<()> { + self.emit("set_frontend_state", state).await?; + + Ok(()) + } +} diff --git a/mediarepo-api/src/client_api/tag.rs b/mediarepo-api/src/client_api/tag.rs new file mode 100644 index 0000000..45e5098 --- /dev/null +++ b/mediarepo-api/src/client_api/tag.rs @@ -0,0 +1,101 @@ +use crate::client_api::error::ApiResult; +use crate::client_api::IPCApi; +use crate::types::files::{GetFileTagsRequest, GetFilesTagsRequest}; +use crate::types::identifier::FileIdentifier; +use crate::types::tags::{ChangeFileTagsRequest, NamespaceResponse, TagResponse}; +use async_trait::async_trait; +use bromine::context::{PoolGuard, PooledContext}; +use bromine::ipc::context::Context; +use std::time::Duration; + +pub struct TagApi { + ctx: PooledContext, +} + +impl Clone for TagApi { + fn clone(&self) -> Self { + Self { + ctx: self.ctx.clone(), + } + } +} + +#[async_trait] +impl IPCApi for TagApi { + fn namespace() -> &'static str { + "tags" + } + + fn ctx(&self) -> PoolGuard { + self.ctx.acquire() + } +} + +impl TagApi { + pub fn new(ctx: PooledContext) -> Self { + Self { ctx } + } + + /// Returns a list of all tags stored in the repo + #[tracing::instrument(level = "debug", skip(self))] + pub async fn get_all_tags(&self) -> ApiResult> { + self.emit_and_get("all_tags", (), Some(Duration::from_secs(2))) + .await + } + + /// Returns a list of all namespaces stored in the repo + #[tracing::instrument(level = "debug", skip(self))] + pub async fn get_all_namespaces(&self) -> ApiResult> { + self.emit_and_get("all_namespaces", (), Some(Duration::from_secs(2))) + .await + } + + /// Returns a list of all tags for a file + #[tracing::instrument(level = "debug", skip(self))] + pub async fn get_tags_for_file(&self, id: FileIdentifier) -> ApiResult> { + self.emit_and_get( + "tags_for_file", + GetFileTagsRequest { id }, + Some(Duration::from_secs(1)), + ) + .await + } + + /// Returns a list of all tags that are assigned to the list of files + #[tracing::instrument(level = "debug", skip_all)] + pub async fn get_tags_for_files(&self, cds: Vec) -> ApiResult> { + self.emit_and_get( + "tags_for_files", + GetFilesTagsRequest { cds }, + Some(Duration::from_secs(10)), + ) + .await + } + + /// Creates a new tag and returns the created tag object + #[tracing::instrument(level = "debug", skip(self))] + pub async fn create_tags(&self, tags: Vec) -> ApiResult> { + self.emit_and_get("create_tags", tags, Some(Duration::from_secs(10))) + .await + } + + /// Changes the tags of a file + #[tracing::instrument(level = "debug", skip(self))] + pub async fn change_file_tags( + &self, + file_id: FileIdentifier, + added_tags: Vec, + removed_tags: Vec, + ) -> ApiResult> { + self.emit_and_get( + "change_file_tags", + ChangeFileTagsRequest { + file_id, + added_tags, + removed_tags, + }, + Some(Duration::from_secs(10)), + ) + .await + } +} diff --git a/mediarepo-api/src/daemon_management/cli.rs b/mediarepo-api/src/daemon_management/cli.rs new file mode 100644 index 0000000..e0baf9d --- /dev/null +++ b/mediarepo-api/src/daemon_management/cli.rs @@ -0,0 +1,95 @@ +use crate::daemon_management::error::{DaemonError, DaemonResult}; +use std::ffi::OsStr; +use std::mem; +use tokio::process::{Child, Command}; + +#[derive(Debug)] +pub struct DaemonCli { + daemon_path: String, + repo_path: String, + child: Option, +} + +impl DaemonCli { + pub fn new(daemon_path: String, repo_path: String) -> Self { + Self { + daemon_path, + repo_path, + child: None, + } + } + + /// Initializes a repository at the specified path + #[tracing::instrument] + pub async fn init_repo(&self) -> DaemonResult<()> { + let output = self + .run_command(vec!["--repo", self.repo_path.as_str(), "init"]) + .await?; + tracing::debug!("Response: {}", String::from_utf8(output).unwrap()); + + Ok(()) + } + + /// Starts a daemon for the given repository + #[tracing::instrument] + pub fn start_daemon(&mut self) -> DaemonResult<()> { + let child = self.run_daemon_process(vec!["--repo", self.repo_path.as_str(), "start"])?; + self.child = Some(child); + + Ok(()) + } + + /// Kills the running daemon process if there's one associated with the + /// daemon cli + #[tracing::instrument] + pub async fn stop_daemon(&mut self) -> DaemonResult<()> { + if let Some(mut child) = mem::take(&mut self.child) { + child.kill().await?; + } + + Ok(()) + } + + /// Returns if the daemon is currently running + pub fn daemon_running(&mut self) -> bool { + if let Some(child) = &mut self.child { + child.try_wait().map(|e| e.is_some()).unwrap_or(true) + } else { + false + } + } + + /// Returns the path the daemon is serving + pub fn repo_path(&self) -> &String { + &self.repo_path + } + + /// Runs a daemon subcommand + async fn run_command, I: IntoIterator>( + &self, + args: I, + ) -> DaemonResult> { + let child = self.run_daemon_process(args)?; + let output = child.wait_with_output().await?; + + if output.status.success() { + Ok(output.stdout) + } else { + let stdout = String::from_utf8(output.stdout).map_err(|e| e.to_string())?; + let stderr = String::from_utf8(output.stderr).map_err(|e| e.to_string())?; + Err(DaemonError::from(format!("{}\n{}", stdout, stderr))) + } + } + + /// Runs a daemon process with the given args + fn run_daemon_process, I: IntoIterator>( + &self, + args: I, + ) -> DaemonResult { + Command::new(&self.daemon_path) + .args(args) + .kill_on_drop(true) + .spawn() + .map_err(DaemonError::from) + } +} diff --git a/mediarepo-api/src/daemon_management/error.rs b/mediarepo-api/src/daemon_management/error.rs new file mode 100644 index 0000000..6506695 --- /dev/null +++ b/mediarepo-api/src/daemon_management/error.rs @@ -0,0 +1,30 @@ +use std::fmt::{Display, Formatter}; + +pub type DaemonResult = Result; + +#[derive(Debug)] +pub struct DaemonError { + pub message: String, +} + +impl Display for DaemonError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + self.message.fmt(f) + } +} + +impl std::error::Error for DaemonError {} + +impl From for DaemonError { + fn from(e: std::io::Error) -> Self { + Self { + message: e.to_string(), + } + } +} + +impl From for DaemonError { + fn from(s: String) -> Self { + Self { message: s } + } +} diff --git a/mediarepo-api/src/daemon_management/mod.rs b/mediarepo-api/src/daemon_management/mod.rs new file mode 100644 index 0000000..41b2d53 --- /dev/null +++ b/mediarepo-api/src/daemon_management/mod.rs @@ -0,0 +1,9 @@ +use pathsearch::find_executable_in_path; +use std::path::PathBuf; + +pub mod cli; +pub mod error; + +pub fn find_daemon_executable() -> Option { + find_executable_in_path("mediarepo-daemon") +} diff --git a/mediarepo-api/src/lib.rs b/mediarepo-api/src/lib.rs new file mode 100644 index 0000000..5cf790d --- /dev/null +++ b/mediarepo-api/src/lib.rs @@ -0,0 +1,16 @@ +pub mod types; + +#[cfg(feature = "client-api")] +pub mod client_api; + +#[cfg(feature = "client-api")] +pub mod daemon_management; + +#[cfg(feature = "tauri-plugin")] +pub mod tauri_plugin; + +#[cfg(feature = "bromine")] +pub use bromine; + +#[cfg(test)] +mod test; diff --git a/mediarepo-api/src/tauri_plugin/commands/daemon.rs b/mediarepo-api/src/tauri_plugin/commands/daemon.rs new file mode 100644 index 0000000..6d908cd --- /dev/null +++ b/mediarepo-api/src/tauri_plugin/commands/daemon.rs @@ -0,0 +1,76 @@ +use crate::daemon_management::find_daemon_executable; +use crate::tauri_plugin::commands::AppAccess; +use crate::tauri_plugin::error::PluginResult; +use crate::tauri_plugin::settings::save_settings; +use bromine::prelude::{IPCError, IPCResult}; +use bromine::IPCBuilder; +use std::io::ErrorKind; +use std::net::{SocketAddr, ToSocketAddrs}; +use tokio::net::TcpListener; + +#[tauri::command] +pub async fn has_executable(app_state: AppAccess<'_>) -> PluginResult { + let mut settings = app_state.settings.write().await; + + if settings.daemon_path.is_none() { + settings.daemon_path = find_daemon_executable().map(|e| e.to_string_lossy().to_string()); + save_settings(&settings)?; + } + + Ok(settings.daemon_path.is_some()) +} + +#[tauri::command] +pub async fn init_repository(app_state: AppAccess<'_>, repo_path: String) -> PluginResult<()> { + let daemon = app_state.get_daemon_cli(repo_path).await?; + daemon.init_repo().await?; + + Ok(()) +} + +#[tauri::command] +pub async fn start_daemon(app_state: AppAccess<'_>, repo_path: String) -> PluginResult<()> { + let mut daemon = app_state.get_daemon_cli(repo_path).await?; + daemon.start_daemon()?; + app_state.add_started_daemon(daemon).await; + + Ok(()) +} + +#[tauri::command] +pub async fn stop_daemon(app_state: AppAccess<'_>, repo_path: String) -> PluginResult<()> { + app_state.stop_running_daemon(&repo_path).await?; + + Ok(()) +} + +#[tauri::command] +pub async fn check_daemon_running(address: String) -> PluginResult { + let connect_result = try_connect_daemon(address).await; + + Ok(connect_result.is_ok()) +} + +async fn try_connect_daemon(address: String) -> IPCResult<()> { + let address = get_socket_address(address)?; + let ctx = IPCBuilder::::new() + .address(address) + .build_client() + .await?; + ctx.emit("info", ()).await_reply().await?; + ctx.stop().await?; + Ok(()) +} + +fn get_socket_address(address: String) -> IPCResult { + address + .to_socket_addrs() + .ok() + .and_then(|mut addr| addr.next()) + .ok_or_else(|| { + IPCError::IoError(std::io::Error::new( + ErrorKind::InvalidInput, + "Invalid Socket address", + )) + }) +} diff --git a/mediarepo-api/src/tauri_plugin/commands/file.rs b/mediarepo-api/src/tauri_plugin/commands/file.rs new file mode 100644 index 0000000..5cf7592 --- /dev/null +++ b/mediarepo-api/src/tauri_plugin/commands/file.rs @@ -0,0 +1,268 @@ +use crate::tauri_plugin::commands::{ApiAccess, BufferAccess}; +use crate::tauri_plugin::error::PluginResult; +use crate::tauri_plugin::utils::system_time_to_naive_date_time; +use crate::types::files::{ + FileBasicDataResponse, FileMetadataResponse, FileOSMetadata, FileStatus, + ThumbnailMetadataResponse, +}; +use crate::types::filtering::{FilterExpression, SortKey}; +use crate::types::identifier::FileIdentifier; +use serde::{Deserialize, Serialize}; +use std::path::PathBuf; +use std::time::SystemTime; +use tokio::fs; +use tokio::fs::DirEntry; + +#[derive(Serialize, Deserialize, Debug)] +pub struct AddFileOptions { + pub read_tags_from_txt: bool, + pub delete_after_import: bool, +} + +#[tauri::command] +pub async fn get_all_files(api_state: ApiAccess<'_>) -> PluginResult> { + let api = api_state.api().await?; + let all_files = api.file.all_files().await?; + + Ok(all_files) +} + +#[tauri::command] +pub async fn get_files( + api_state: ApiAccess<'_>, + ids: Vec, +) -> PluginResult> { + let api = api_state.api().await?; + let ids = ids.into_iter().map(|id| FileIdentifier::ID(id)).collect(); + let files = api.file.get_files(ids).await?; + + Ok(files) +} + +#[tauri::command] +pub async fn add_local_file( + api_state: ApiAccess<'_>, + metadata: FileOSMetadata, + options: AddFileOptions, +) -> PluginResult { + let api = api_state.api().await?; + let path = PathBuf::from(&metadata.path); + let mut tags = Vec::new(); + let txt_path = PathBuf::from(format!("{}.txt", path.to_string_lossy())); + + if options.read_tags_from_txt { + if txt_path.exists() { + let content = fs::read_to_string(&txt_path).await?; + tags.append( + &mut content + .split('\n') + .map(|line| line.to_owned()) + .collect::>(), + ); + } + } + + let file_content = fs::read(&path).await?; + let file = api.file.add_file(metadata, tags, file_content).await?; + if options.delete_after_import { + fs::remove_file(path).await?; + + if options.read_tags_from_txt { + fs::remove_file(txt_path).await?; + } + } + + Ok(file) +} + +#[tauri::command] +pub async fn find_files( + filters: Vec, + sort_by: Vec, + api_state: ApiAccess<'_>, +) -> PluginResult> { + let api = api_state.api().await?; + let files = api.file.find_files(filters, sort_by).await?; + + Ok(files) +} + +#[tauri::command] +pub async fn get_file_thumbnails( + api_state: ApiAccess<'_>, + id: i64, +) -> PluginResult> { + let api = api_state.api().await?; + let thumbs = api.file.get_file_thumbnails(FileIdentifier::ID(id)).await?; + + Ok(thumbs) +} + +#[tauri::command] +pub async fn get_file_metadata( + api_state: ApiAccess<'_>, + id: i64, +) -> PluginResult { + let api = api_state.api().await?; + let metadata = api.file.get_file_metadata(FileIdentifier::ID(id)).await?; + + Ok(metadata) +} + +#[tauri::command] +pub async fn update_file_name( + api_state: ApiAccess<'_>, + id: i64, + name: String, +) -> PluginResult { + let api = api_state.api().await?; + let metadata = api + .file + .update_file_name(FileIdentifier::ID(id), name) + .await?; + + Ok(metadata) +} + +#[tauri::command] +pub async fn update_file_status( + api_state: ApiAccess<'_>, + id: i64, + status: FileStatus, +) -> PluginResult { + let api = api_state.api().await?; + let file = api + .file + .update_file_status(FileIdentifier::ID(id), status) + .await?; + + Ok(file) +} + +#[tauri::command] +pub async fn delete_file(api_state: ApiAccess<'_>, id: i64) -> PluginResult<()> { + let api = api_state.api().await?; + api.file.delete_file(FileIdentifier::ID(id)).await?; + + Ok(()) +} + +#[tauri::command] +pub async fn read_file( + api_state: ApiAccess<'_>, + buffer_state: BufferAccess<'_>, + hash: String, +) -> PluginResult> { + if let Some(buffer) = buffer_state.get_entry(&hash) { + Ok(buffer.buf) + } else { + let api = api_state.api().await?; + let content = api.file.read_file(FileIdentifier::CD(hash.clone())).await?; + + Ok(content) + } +} + +/// Saves a file on the local system +#[tauri::command] +pub async fn save_file_locally( + api_state: ApiAccess<'_>, + id: i64, + path: String, +) -> PluginResult<()> { + let api = api_state.api().await?; + let content = api.file.read_file(FileIdentifier::ID(id)).await?; + fs::write(PathBuf::from(path), content).await?; + + Ok(()) +} + +#[tauri::command] +pub async fn delete_thumbnails(api_state: ApiAccess<'_>, id: i64) -> PluginResult<()> { + let api = api_state.api().await?; + api.file.delete_thumbnails(FileIdentifier::ID(id)).await?; + + Ok(()) +} + +#[tauri::command] +pub async fn resolve_paths_to_files(paths: Vec) -> PluginResult> { + let mut files = Vec::new(); + + for path in paths { + let path = PathBuf::from(path); + if path.exists() { + files.append(&mut resolve_path_to_files(path).await?); + } + } + + Ok(files) +} + +/// Resolves a path into several file metadata objects +#[tracing::instrument(level = "debug")] +async fn resolve_path_to_files(path: PathBuf) -> PluginResult> { + let mut files = Vec::new(); + + if path.is_dir() { + let mut read_dir = fs::read_dir(path).await?; + + while let Some(entry) = read_dir.next_entry().await? { + let subdir_entries = resolve_subdir(entry).await?; + for entry in subdir_entries.into_iter().filter(|e| !e.path().is_dir()) { + let metadata = retrieve_file_information(entry.path()).await?; + files.push(metadata); + } + } + } else { + let metadata = retrieve_file_information(path).await?; + files.push(metadata); + } + + Ok(files) +} + +/// Iteratively resolves a directory into its sub components +#[tracing::instrument(level = "debug")] +async fn resolve_subdir(entry: DirEntry) -> PluginResult> { + let mut entries = vec![entry]; + + let mut i = 0; + + while i < entries.len() { + let entry = &entries[i]; + + if entry.path().is_dir() { + let mut read_dir = fs::read_dir(entry.path()).await?; + while let Some(entry) = read_dir.next_entry().await? { + entries.push(entry); + } + } + i += 1; + } + + Ok(entries) +} + +/// Retrieves information about a path that MUST be a file and returns +/// metadata for it +#[tracing::instrument(level = "trace")] +async fn retrieve_file_information(path: PathBuf) -> PluginResult { + let mime = mime_guess::from_path(&path).first(); + let metadata = fs::metadata(&path).await?; + let creation_time = metadata.created().unwrap_or(SystemTime::now()); + let change_time = metadata.modified().unwrap_or(SystemTime::now()); + let name = path + .file_name() + .ok_or_else(|| "Could not retrieve file name")?; + + let os_metadata = FileOSMetadata { + path: path.to_string_lossy().to_string(), + name: name.to_string_lossy().to_string(), + mime_type: mime.map(|m| m.to_string()), + creation_time: system_time_to_naive_date_time(creation_time), + change_time: system_time_to_naive_date_time(change_time), + }; + + Ok(os_metadata) +} diff --git a/mediarepo-api/src/tauri_plugin/commands/job.rs b/mediarepo-api/src/tauri_plugin/commands/job.rs new file mode 100644 index 0000000..8866b8b --- /dev/null +++ b/mediarepo-api/src/tauri_plugin/commands/job.rs @@ -0,0 +1,11 @@ +use crate::tauri_plugin::commands::ApiAccess; +use crate::tauri_plugin::error::PluginResult; +use crate::types::jobs::JobType; + +#[tauri::command] +pub async fn run_job(api_state: ApiAccess<'_>, job_type: JobType) -> PluginResult<()> { + let api = api_state.api().await?; + api.job.run_job(job_type).await?; + + Ok(()) +} diff --git a/mediarepo-api/src/tauri_plugin/commands/mod.rs b/mediarepo-api/src/tauri_plugin/commands/mod.rs new file mode 100644 index 0000000..bd6a259 --- /dev/null +++ b/mediarepo-api/src/tauri_plugin/commands/mod.rs @@ -0,0 +1,19 @@ +use tauri::State; + +pub use daemon::*; +pub use file::*; +pub use job::*; +pub use repo::*; +pub use tag::*; + +use crate::tauri_plugin::state::{ApiState, AppState, BufferState}; + +pub mod daemon; +pub mod file; +pub mod job; +pub mod repo; +pub mod tag; + +pub type ApiAccess<'a> = State<'a, ApiState>; +pub type AppAccess<'a> = State<'a, AppState>; +pub type BufferAccess<'a> = State<'a, BufferState>; diff --git a/mediarepo-api/src/tauri_plugin/commands/repo.rs b/mediarepo-api/src/tauri_plugin/commands/repo.rs new file mode 100644 index 0000000..beca33a --- /dev/null +++ b/mediarepo-api/src/tauri_plugin/commands/repo.rs @@ -0,0 +1,267 @@ +use crate::client_api::protocol::ApiProtocolListener; +use crate::client_api::ApiClient; +use crate::tauri_plugin::commands::{ApiAccess, AppAccess, BufferAccess}; +use crate::tauri_plugin::error::{PluginError, PluginResult}; +use crate::tauri_plugin::settings::{save_settings, Repository}; +use crate::types::repo::{FrontendState, RepositoryMetadata, SizeMetadata, SizeType}; +use serde::{Deserialize, Serialize}; +use std::mem; +use std::path::PathBuf; +use std::time::{SystemTime, UNIX_EPOCH}; +use tokio::fs; +use tokio::time::Duration; + +static REPO_CONFIG_FILE: &str = "repo.toml"; + +#[derive(Clone, Debug, Deserialize, Serialize)] +pub struct RepoConfig { + pub listen_address: String, + pub database_path: String, + pub default_file_store: String, +} + +#[tauri::command] +pub async fn get_repositories(app_state: AppAccess<'_>) -> PluginResult> { + let settings = app_state.settings.read().await; + let mut repositories: Vec = settings.repositories.values().cloned().collect(); + repositories.sort_by_key(|r| r.last_opened.unwrap_or(0)); + repositories.reverse(); // the last opened repository should always be on top + + Ok(repositories) +} + +#[tauri::command] +pub async fn get_active_repository(app_state: AppAccess<'_>) -> PluginResult> { + let repo = app_state.active_repo.read().await; + Ok(repo.clone()) +} + +#[tauri::command] +pub async fn add_repository( + name: String, + path: Option, + address: Option, + local: bool, + app_state: AppAccess<'_>, +) -> PluginResult> { + if path.is_none() && address.is_none() { + return Err(PluginError::from( + "Either a path or an address needs to be specified for the repository", + )); + } + let repo = Repository { + name, + path, + address, + local, + last_opened: None, + }; + + let mut repositories = Vec::new(); + { + let mut settings = app_state.settings.write().await; + settings.repositories.insert(repo.name.clone(), repo); + save_settings(&settings)?; + repositories.append(&mut settings.repositories.values().cloned().collect()); + } + + Ok(repositories) +} + +#[tauri::command] +pub async fn remove_repository(app_state: AppAccess<'_>, name: String) -> PluginResult<()> { + let mut settings = app_state.settings.write().await; + + if let Some(_repo) = settings.repositories.remove(&name) { + save_settings(&settings)?; + Ok(()) + } else { + Err(PluginError::from(format!( + "The repository '{}' does not exist.", + name + ))) + } +} + +#[tauri::command] +pub async fn delete_repository(app_state: AppAccess<'_>, name: String) -> PluginResult<()> { + let settings = app_state.settings.read().await; + + if let Some(repository) = settings.repositories.get(&name) { + if let Some(path) = &repository.path { + fs::remove_dir_all(PathBuf::from(path)).await?; + + Ok(()) + } else { + Err(PluginError::from(format!( + "The repository '{}' is a remote repository", + name + ))) + } + } else { + Err(PluginError::from(format!( + "The repository '{}' does not exist.", + name + ))) + } +} + +#[tauri::command] +pub async fn check_local_repository_exists(path: String) -> PluginResult { + let config_path = PathBuf::from(path).join(REPO_CONFIG_FILE); + + if !config_path.exists() { + Ok(false) + } else { + Ok(true) + } +} + +#[tauri::command] +pub async fn disconnect_repository( + app_state: AppAccess<'_>, + api_state: ApiAccess<'_>, + buffer_state: BufferAccess<'_>, +) -> PluginResult<()> { + api_state.disconnect().await; + let mut active_repo = app_state.active_repo.write().await; + mem::take(&mut *active_repo); + buffer_state.clear(); + + Ok(()) +} + +#[tauri::command] +pub async fn close_local_repository( + app_state: AppAccess<'_>, + api_state: ApiAccess<'_>, + buffer_state: BufferAccess<'_>, +) -> PluginResult<()> { + let mut active_repo = app_state.active_repo.write().await; + + if let Some(path) = mem::take(&mut *active_repo).and_then(|r| r.path) { + if let Ok(api) = api_state.api().await { + if let Err(e) = api.shutdown_daemon().await { + tracing::error!("failed to ask the daemon to shut down daemon {:?}", e); + } + // allow the repository to gracefully stop within 1 second + tokio::time::sleep(Duration::from_secs(1)).await; + } + app_state.stop_running_daemon(&path).await?; + } + api_state.disconnect().await; + mem::take(&mut *active_repo); + buffer_state.clear(); + + Ok(()) +} + +#[tauri::command] +pub async fn select_repository( + name: String, + app_state: AppAccess<'_>, + api_state: ApiAccess<'_>, +) -> PluginResult<()> { + let mut settings = app_state.settings.write().await; + let repo = settings + .repositories + .get_mut(&name) + .ok_or(PluginError::from( + format!("Repository '{}' not found", name).as_str(), + ))?; + close_selected_repository(&app_state).await?; + let address = if let Some(address) = &repo.address { + address.clone() + } else { + tracing::debug!("Reading repo address from local file."); + let path = repo + .path + .clone() + .ok_or_else(|| PluginError::from("Missing repo path or address in config."))?; + get_repo_address(path).await? + }; + let client = ApiClient::connect::(address).await?; + api_state.set_api(client).await; + + let mut active_repo = app_state.active_repo.write().await; + repo.last_opened = Some( + SystemTime::now() + .duration_since(UNIX_EPOCH) + .unwrap() + .as_secs(), + ); + + *active_repo = Some(repo.clone()); + save_settings(&settings)?; + + Ok(()) +} + +#[tauri::command] +pub async fn get_repo_metadata(api_state: ApiAccess<'_>) -> PluginResult { + let api = api_state.api().await?; + let metadata = api.repo.get_repo_metadata().await?; + + Ok(metadata) +} + +#[tauri::command] +pub async fn get_size(api_state: ApiAccess<'_>, size_type: SizeType) -> PluginResult { + let api = api_state.api().await?; + let size = api.repo.get_size(size_type).await?; + + Ok(size) +} + +#[tauri::command] +pub async fn get_frontend_state(api_state: ApiAccess<'_>) -> PluginResult> { + let api = api_state.api().await?; + let state = api.repo.get_frontend_state().await?; + + Ok(state.state) +} + +#[tauri::command] +pub async fn set_frontend_state(api_state: ApiAccess<'_>, state: String) -> PluginResult<()> { + let api = api_state.api().await?; + api.repo + .set_frontend_state(FrontendState { state: Some(state) }) + .await?; + + Ok(()) +} + +async fn get_repo_address(path: String) -> PluginResult { + let tcp_path = PathBuf::from(&path).join("repo.tcp"); + let socket_path = PathBuf::from(&path).join("repo.sock"); + + let mut address = String::from("127.0.0.1:2400"); + for _ in 0..10 { + #[cfg(unix)] + if socket_path.exists() { + address = socket_path.to_str().unwrap().to_string(); + break; + } + if tcp_path.exists() { + address = fs::read_to_string(tcp_path).await?; + break; + } + tokio::time::sleep(Duration::from_millis(250)).await; + } + + Ok(address) +} + +async fn close_selected_repository(app_state: &AppAccess<'_>) -> PluginResult<()> { + if let Some(path) = app_state + .active_repo + .read() + .await + .clone() + .and_then(|r| r.path) + { + app_state.stop_running_daemon(&path).await?; + } + + Ok(()) +} diff --git a/mediarepo-api/src/tauri_plugin/commands/tag.rs b/mediarepo-api/src/tauri_plugin/commands/tag.rs new file mode 100644 index 0000000..809e5b0 --- /dev/null +++ b/mediarepo-api/src/tauri_plugin/commands/tag.rs @@ -0,0 +1,69 @@ +use crate::tauri_plugin::commands::ApiAccess; +use crate::tauri_plugin::error::PluginResult; +use crate::types::identifier::FileIdentifier; +use crate::types::tags::{NamespaceResponse, TagResponse}; + +#[tauri::command] +pub async fn get_all_tags(api_state: ApiAccess<'_>) -> PluginResult> { + let api = api_state.api().await?; + let all_tags = api.tag.get_all_tags().await?; + + Ok(all_tags) +} + +#[tauri::command] +pub async fn get_all_namespaces(api_state: ApiAccess<'_>) -> PluginResult> { + let api = api_state.api().await?; + let all_namespaces = api.tag.get_all_namespaces().await?; + + Ok(all_namespaces) +} + +#[tauri::command] +pub async fn get_tags_for_file( + id: i64, + api_state: ApiAccess<'_>, +) -> PluginResult> { + let api = api_state.api().await?; + let tags = api.tag.get_tags_for_file(FileIdentifier::ID(id)).await?; + + Ok(tags) +} + +#[tauri::command] +pub async fn get_tags_for_files( + cds: Vec, + api_state: ApiAccess<'_>, +) -> PluginResult> { + let api = api_state.api().await?; + let tags = api.tag.get_tags_for_files(cds).await?; + + Ok(tags) +} + +#[tauri::command] +pub async fn create_tags( + api_state: ApiAccess<'_>, + tags: Vec, +) -> PluginResult> { + let api = api_state.api().await?; + let tags = api.tag.create_tags(tags).await?; + + Ok(tags) +} + +#[tauri::command] +pub async fn change_file_tags( + api_state: ApiAccess<'_>, + id: i64, + added_tags: Vec, + removed_tags: Vec, +) -> PluginResult> { + let api = api_state.api().await?; + let tags = api + .tag + .change_file_tags(FileIdentifier::ID(id), added_tags, removed_tags) + .await?; + + Ok(tags) +} diff --git a/mediarepo-api/src/tauri_plugin/custom_schemes.rs b/mediarepo-api/src/tauri_plugin/custom_schemes.rs new file mode 100644 index 0000000..436b8f4 --- /dev/null +++ b/mediarepo-api/src/tauri_plugin/custom_schemes.rs @@ -0,0 +1,141 @@ +use crate::tauri_plugin::error::{PluginError, PluginResult}; +use crate::tauri_plugin::state::{ApiState, BufferState}; +use crate::types::identifier::FileIdentifier; +use std::borrow::Cow; +use std::collections::HashMap; +use std::sync::Arc; +use tauri::http::{Request, Response, ResponseBuilder}; +use tauri::{AppHandle, Builder, Manager, Runtime}; +use tokio::runtime::{Builder as TokioRuntimeBuilder, Runtime as TokioRuntime}; +use url::Url; + +type Result = std::result::Result>; + +pub fn register_custom_uri_schemes(builder: Builder) -> Builder { + let runtime = + Arc::new(build_uri_runtime().expect("Failed to build async runtime for custom schemes")); + builder + .register_uri_scheme_protocol("once", once_scheme) + .register_uri_scheme_protocol("content", { + let runtime = Arc::clone(&runtime); + move |a, r| runtime.block_on(content_scheme(a, r)) + }) + .register_uri_scheme_protocol("thumb", move |a, r| runtime.block_on(thumb_scheme(a, r))) +} + +fn build_uri_runtime() -> PluginResult { + let runtime = TokioRuntimeBuilder::new_current_thread() + .thread_name("custom-scheme") + .enable_all() + .build()?; + + Ok(runtime) +} + +#[tracing::instrument(level = "debug", skip_all)] +fn once_scheme(app: &AppHandle, request: &Request) -> Result { + let buf_state = app.state::(); + let resource_key = request.uri().trim_start_matches("once://"); + + let buffer = buf_state.get_entry(resource_key); + + if let Some(buffer) = buffer { + ResponseBuilder::new() + .mimetype(&buffer.mime) + .status(200) + .body(buffer.buf) + } else { + ResponseBuilder::new() + .mimetype("text/plain") + .status(404) + .body("Resource not found".as_bytes().to_vec()) + } +} + +#[tracing::instrument(level = "debug", skip_all)] +async fn content_scheme(app: &AppHandle, request: &Request) -> Result { + let api_state = app.state::(); + let buf_state = app.state::(); + let hash = request.uri().trim_start_matches("content://"); + + if let Some(buffer) = buf_state.get_entry(hash) { + tracing::debug!("Fetching content from cache"); + ResponseBuilder::new() + .status(200) + .mimetype(&buffer.mime) + .body(buffer.buf) + } else { + tracing::debug!("Fetching content from daemon"); + let api = api_state.api().await?; + let file = api + .file + .get_file(FileIdentifier::CD(hash.to_string())) + .await?; + let mime = file.mime_type; + let bytes = api + .file + .read_file(FileIdentifier::CD(hash.to_string())) + .await?; + tracing::debug!("Received {} content bytes", bytes.len()); + buf_state.add_entry(hash.to_string(), mime.clone(), bytes.clone()); + ResponseBuilder::new() + .mimetype(&mime) + .status(200) + .body(bytes) + } +} + +#[tracing::instrument(level = "debug", skip_all)] +async fn thumb_scheme(app: &AppHandle, request: &Request) -> Result { + let api_state = app.state::(); + let buf_state = app.state::(); + + let url = Url::parse(request.uri())?; + let hash = url + .domain() + .ok_or_else(|| PluginError::from("Missing Domain"))?; + + let query_pairs = url + .query_pairs() + .collect::, Cow<'_, str>>>(); + + let height = query_pairs + .get("height") + .and_then(|h| h.parse::().ok()) + .unwrap_or(250); + + let width = query_pairs + .get("width") + .and_then(|w| w.parse::().ok()) + .unwrap_or(250); + + if let Some(buffer) = buf_state.get_entry(request.uri()) { + tracing::debug!("Fetching content from cache"); + ResponseBuilder::new() + .status(200) + .mimetype(&buffer.mime) + .body(buffer.buf) + } else { + tracing::debug!("Fetching content from daemon"); + let api = api_state.api().await?; + let (thumb, bytes) = api + .file + .get_thumbnail_of_size( + FileIdentifier::CD(hash.to_string()), + ((height as f32 * 0.8) as u32, (width as f32 * 0.8) as u32), + ((height as f32 * 1.2) as u32, (width as f32 * 1.2) as u32), + ) + .await?; + tracing::debug!("Received {} content bytes", bytes.len()); + buf_state.add_entry( + request.uri().to_string(), + thumb.mime_type.clone(), + bytes.clone(), + ); + + ResponseBuilder::new() + .mimetype(&thumb.mime_type) + .status(200) + .body(bytes) + } +} diff --git a/mediarepo-api/src/tauri_plugin/error.rs b/mediarepo-api/src/tauri_plugin/error.rs new file mode 100644 index 0000000..01b21c7 --- /dev/null +++ b/mediarepo-api/src/tauri_plugin/error.rs @@ -0,0 +1,85 @@ +use crate::client_api::error::ApiError; +use crate::daemon_management::error::DaemonError; +use bromine::error::Error; +use serde::Serialize; +use std::fmt::{Display, Formatter}; + +pub type PluginResult = Result; + +#[derive(Clone, Debug, Serialize)] +pub struct PluginError { + message: String, +} + +impl Display for PluginError { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + self.message.fmt(f) + } +} + +impl std::error::Error for PluginError {} + +impl From<&str> for PluginError { + fn from(s: &str) -> Self { + Self { + message: s.to_string(), + } + } +} + +impl From for PluginError { + fn from(message: String) -> Self { + Self { message } + } +} + +impl From for PluginError { + fn from(e: ApiError) -> Self { + let message = match e { + ApiError::IPC(ipc_error) => match ipc_error { + Error::Message(message) => message, + Error::SendError => String::from("Failed to send event to daemon"), + Error::ErrorEvent(e) => { + format!("Received error: {}", e.to_string()) + } + e => { + format!("{:?}", e) + } + }, + ApiError::VersionMismatch { server, client } => { + format!("The servers API version ({}) is not supported by the client ({}). Please make sure both are up to date.", server, client) + } + }; + Self { message } + } +} + +impl From for PluginError { + fn from(e: std::io::Error) -> Self { + Self { + message: e.to_string(), + } + } +} + +impl From for PluginError { + fn from(e: toml::de::Error) -> Self { + Self { + message: format!("Deserialization failed: {:?}", e), + } + } +} + +impl From for PluginError { + fn from(e: toml::ser::Error) -> Self { + Self { + message: format!("Serialization failed: {:?}", e), + } + } +} + +impl From for PluginError { + fn from(e: DaemonError) -> Self { + Self { message: e.message } + } +} diff --git a/mediarepo-api/src/tauri_plugin/mod.rs b/mediarepo-api/src/tauri_plugin/mod.rs new file mode 100644 index 0000000..5779dbe --- /dev/null +++ b/mediarepo-api/src/tauri_plugin/mod.rs @@ -0,0 +1,111 @@ +use tauri::plugin::Plugin; +use tauri::{AppHandle, Builder, Invoke, Manager, Runtime}; + +use state::ApiState; + +use crate::tauri_plugin::state::{AppState, BufferState}; +use std::thread; +use std::time::Duration; + +pub(crate) mod commands; +pub mod custom_schemes; +pub mod error; +mod settings; +mod state; +mod utils; + +use commands::*; + +const MAX_BUFFER_SIZE: usize = 2 * 1024 * 1024 * 1024; + +pub fn register_plugin(builder: Builder) -> Builder { + let repo_plugin = MediarepoPlugin::new(); + + custom_schemes::register_custom_uri_schemes(builder.plugin(repo_plugin)) +} + +pub struct MediarepoPlugin { + invoke_handler: Box) + Send + Sync>, +} + +impl MediarepoPlugin { + pub fn new() -> Self { + Self { + invoke_handler: Box::new(tauri::generate_handler![ + get_all_files, + find_files, + get_file_thumbnails, + get_repositories, + get_all_tags, + get_tags_for_file, + get_tags_for_files, + get_active_repository, + add_repository, + select_repository, + init_repository, + start_daemon, + check_daemon_running, + stop_daemon, + disconnect_repository, + close_local_repository, + check_local_repository_exists, + remove_repository, + change_file_tags, + create_tags, + update_file_name, + resolve_paths_to_files, + add_local_file, + save_file_locally, + delete_thumbnails, + read_file, + delete_repository, + has_executable, + get_frontend_state, + set_frontend_state, + get_all_namespaces, + get_files, + get_repo_metadata, + get_size, + get_file_metadata, + run_job, + update_file_status, + delete_file + ]), + } + } +} + +impl Plugin for MediarepoPlugin { + fn name(&self) -> &'static str { + "mediarepo" + } + + #[tracing::instrument(skip(self, app, _config))] + fn initialize( + &mut self, + app: &AppHandle, + _config: serde_json::value::Value, + ) -> tauri::plugin::Result<()> { + let api_state = ApiState::new(); + app.manage(api_state); + + let buffer_state = BufferState::default(); + app.manage(buffer_state.clone()); + + let repo_state = AppState::load()?; + app.manage(repo_state); + + thread::spawn(move || loop { + thread::sleep(Duration::from_secs(10)); + buffer_state.clear_expired(); + buffer_state.trim_to_size(MAX_BUFFER_SIZE); + }); + + Ok(()) + } + + #[tracing::instrument(level = "trace", skip_all)] + fn extend_api(&mut self, message: Invoke) { + (self.invoke_handler)(message) + } +} diff --git a/mediarepo-api/src/tauri_plugin/settings.rs b/mediarepo-api/src/tauri_plugin/settings.rs new file mode 100644 index 0000000..b020c95 --- /dev/null +++ b/mediarepo-api/src/tauri_plugin/settings.rs @@ -0,0 +1,71 @@ +use crate::daemon_management::find_daemon_executable; +use crate::tauri_plugin::error::PluginResult; +use directories::ProjectDirs; +use serde::{Deserialize, Serialize}; +use serde_piecewise_default::DeserializePiecewiseDefault; +use std::collections::HashMap; +use std::fs; +use std::path::PathBuf; + +static SETTINGS_FILE: &str = "settings.toml"; + +#[derive(Serialize, Debug, Deserialize, Clone)] +pub struct Repository { + pub(crate) name: String, + pub(crate) path: Option, + pub(crate) address: Option, + pub(crate) local: bool, + pub(crate) last_opened: Option, +} + +#[derive(DeserializePiecewiseDefault, Debug, Serialize)] +pub struct Settings { + pub daemon_path: Option, + pub repositories: HashMap, +} + +impl Default for Settings { + fn default() -> Self { + Self { + daemon_path: find_daemon_executable().map(|e| e.to_string_lossy().to_string()), + repositories: HashMap::new(), + } + } +} + +fn get_settings_path() -> PathBuf { + let dirs = ProjectDirs::from("com", "trivernis", "mediarepo").unwrap(); + let config_path = dirs.config_dir().to_path_buf(); + + config_path.join(SETTINGS_FILE) +} + +/// Writes the settings to the file +#[tracing::instrument(level = "debug")] +pub fn save_settings(settings: &Settings) -> PluginResult<()> { + let settings_path = get_settings_path(); + let settings_string = toml::to_string(&settings)?; + fs::write(&settings_path, &settings_string.into_bytes())?; + + Ok(()) +} + +/// Loads the settings from the file +#[tracing::instrument(level = "debug")] +pub fn load_settings() -> PluginResult { + let dirs = ProjectDirs::from("com", "trivernis", "mediarepo") + .expect("Failed to get project directories"); + let config_path = dirs.config_dir().to_path_buf(); + if !config_path.exists() { + fs::create_dir_all(&config_path)?; + } + let settings_path = config_path.join(SETTINGS_FILE); + if !settings_path.exists() { + let settings = Settings::default(); + save_settings(&settings)?; + } + let config_str = fs::read_to_string(settings_path)?; + let settings = toml::from_str(&config_str)?; + + Ok(settings) +} diff --git a/mediarepo-api/src/tauri_plugin/state.rs b/mediarepo-api/src/tauri_plugin/state.rs new file mode 100644 index 0000000..e053325 --- /dev/null +++ b/mediarepo-api/src/tauri_plugin/state.rs @@ -0,0 +1,221 @@ +use std::collections::HashMap; +use std::mem; +use std::ops::Deref; +use std::sync::Arc; +use std::time::Duration; + +use parking_lot::Mutex; +use parking_lot::RwLock as ParkingRwLock; +use tauri::async_runtime::RwLock; +use tokio::time::Instant; + +use crate::client_api::ApiClient; +use crate::daemon_management::cli::DaemonCli; +use crate::daemon_management::find_daemon_executable; +use crate::tauri_plugin::error::{PluginError, PluginResult}; +use crate::tauri_plugin::settings::{load_settings, save_settings, Repository, Settings}; + +pub struct ApiState { + inner: Arc>>, +} + +unsafe impl Send for ApiState {} +unsafe impl Sync for ApiState {} + +impl ApiState { + pub fn new() -> Self { + Self { + inner: Arc::new(RwLock::new(None)), + } + } + + /// Sets the active api client and disconnects the old one + pub async fn set_api(&self, client: ApiClient) { + let mut inner = self.inner.write().await; + let old_client = mem::replace(&mut *inner, Some(client)); + + if let Some(client) = old_client { + let _ = client.exit().await; + } + } + + /// Disconnects the api client + pub async fn disconnect(&self) { + let mut inner = self.inner.write().await; + let old_client = mem::take(&mut *inner); + + if let Some(client) = old_client { + let _ = client.exit().await; + } + } + + pub async fn api(&self) -> PluginResult { + let inner = self.inner.read().await; + inner + .clone() + .ok_or_else(|| PluginError::from("Not connected")) + } +} + +#[derive(Clone)] +pub struct VolatileBuffer { + pub valid_until: Instant, + pub mime: String, + pub buf: Vec, +} + +impl VolatileBuffer { + pub fn new(mime: String, buf: Vec) -> Self { + Self { + valid_until: Instant::now() + Duration::from_secs(120), // buffers that weren't accessed get deleted after 2 minutes + mime, + buf, + } + } +} + +#[derive(Default, Clone)] +pub struct BufferState { + pub buffer: Arc>>>, +} + +impl BufferState { + /// Adds a cached buffer to the buffer state + pub fn add_entry(&self, key: String, mime: String, bytes: Vec) { + let mut buffers = self.buffer.write(); + let buffer = VolatileBuffer::new(mime, bytes); + buffers.insert(key, Mutex::new(buffer)); + } + + /// Returns the cloned buffer entry and flags it for expiration + pub fn get_entry(&self, key: &str) -> Option { + let buffers = self.buffer.read(); + let entry = buffers.get(key); + + if let Some(entry) = entry { + let mut entry = entry.lock(); + entry.valid_until = Instant::now() + Duration::from_secs(30); // ttl is 30 seconds after being accessed + + Some(entry.clone()) + } else { + None + } + } + + /// Clears all expired entries + pub fn clear_expired(&self) { + let keys: Vec = { + let buffer = self.buffer.read(); + buffer.keys().cloned().collect() + }; + + for key in keys { + let valid_until = { + let buffer = self.buffer.read(); + let entry = buffer.get(&key).unwrap().lock(); + entry.valid_until.clone() + }; + if valid_until < Instant::now() { + let mut buffer = self.buffer.write(); + buffer.remove(&key); + } + } + } + + /// Clears the buffer completely + pub fn clear(&self) { + let mut buffer = self.buffer.write(); + buffer.clear(); + } + + /// Trims the buffer to the given target size + pub fn trim_to_size(&self, target_size: usize) { + let mut size = self.get_size(); + if size < target_size { + return; + } + + let mut keys: Vec = { + let buffer = self.buffer.read(); + buffer.keys().cloned().collect() + }; + keys.reverse(); + + while size > target_size && keys.len() > 0 { + let key = keys.pop().unwrap(); + let mut buffers = self.buffer.write(); + + if let Some(entry) = buffers.remove(&key) { + size -= entry.lock().buf.len(); + } + } + } + + /// Calculates the size of the whole buffer + pub fn get_size(&self) -> usize { + let buffer = self.buffer.read(); + let mut size = 0; + + for value in buffer.deref().values() { + let value = value.lock(); + size += value.buf.len(); + } + + size + } +} + +pub struct AppState { + pub active_repo: Arc>>, + pub settings: Arc>, + pub running_daemons: Arc>>, +} + +impl AppState { + #[tracing::instrument(level = "debug")] + pub fn load() -> PluginResult { + let settings = load_settings()?; + + let state = Self { + active_repo: Default::default(), + settings: Arc::new(RwLock::new(settings)), + running_daemons: Default::default(), + }; + + Ok(state) + } + + /// Returns the daemon cli client + pub async fn get_daemon_cli(&self, repo_path: String) -> PluginResult { + let mut settings = self.settings.write().await; + if settings.daemon_path.is_none() { + settings.daemon_path = + find_daemon_executable().map(|p| p.to_string_lossy().to_string()); + save_settings(&settings)?; + } + let path = settings + .daemon_path + .clone() + .ok_or_else(|| PluginError::from("Missing daemon executable"))?; + let cli = DaemonCli::new(path, repo_path); + + Ok(cli) + } + + /// Adds a started daemon to the running daemons + pub async fn add_started_daemon(&self, daemon: DaemonCli) { + let mut daemons = self.running_daemons.write().await; + daemons.insert(daemon.repo_path().to_owned(), daemon); + } + + /// Tries to stop a running daemon + pub async fn stop_running_daemon(&self, repo_path: &String) -> PluginResult<()> { + let mut daemons = self.running_daemons.write().await; + + if let Some(mut daemon) = daemons.remove(repo_path) { + daemon.stop_daemon().await?; + } + + Ok(()) + } +} diff --git a/mediarepo-api/src/tauri_plugin/utils.rs b/mediarepo-api/src/tauri_plugin/utils.rs new file mode 100644 index 0000000..d3a4035 --- /dev/null +++ b/mediarepo-api/src/tauri_plugin/utils.rs @@ -0,0 +1,12 @@ +use chrono::NaiveDateTime; +use std::time::{SystemTime, UNIX_EPOCH}; + +/// Converts a system time timestamp to a NaiveDateTime object +pub fn system_time_to_naive_date_time(system_time: SystemTime) -> NaiveDateTime { + let epoch_duration = system_time.duration_since(UNIX_EPOCH).unwrap(); + + NaiveDateTime::from_timestamp( + epoch_duration.as_secs() as i64, + epoch_duration.subsec_nanos(), + ) +} diff --git a/mediarepo-api/src/test/mod.rs b/mediarepo-api/src/test/mod.rs new file mode 100644 index 0000000..ce36222 --- /dev/null +++ b/mediarepo-api/src/test/mod.rs @@ -0,0 +1,2 @@ +#[cfg(feature = "bromine")] +mod test_type_serialization; diff --git a/mediarepo-api/src/test/test_type_serialization.rs b/mediarepo-api/src/test/test_type_serialization.rs new file mode 100644 index 0000000..838c2d8 --- /dev/null +++ b/mediarepo-api/src/test/test_type_serialization.rs @@ -0,0 +1,65 @@ +use crate::types::files::GetFileThumbnailOfSizeRequest; +use crate::types::filtering::{ + FilterExpression, FilterQuery, SortDirection, SortKey, TagQuery, ValueComparator, +}; +use crate::types::identifier::FileIdentifier; +use bromine::payload::DynamicSerializer; +use bromine::prelude::IPCResult; +use chrono::NaiveDateTime; +use serde::de::DeserializeOwned; +use serde::Serialize; + +#[test] +fn it_serializes_file_identifier() { + test_serialization(FileIdentifier::ID(0)).unwrap(); +} + +#[test] +fn it_serializes_get_file_thumbnail_of_size_requests() { + test_serialization(GetFileThumbnailOfSizeRequest { + id: FileIdentifier::ID(0), + max_size: (u32::MAX, u32::MAX), + min_size: (0, 0), + }) + .unwrap(); +} + +#[test] +fn it_serializes_tag_queries() { + test_serialization(TagQuery { + tag: String::from("Hello"), + negate: true, + }) + .unwrap(); +} + +#[test] +fn it_serializes_filter_expressions() { + test_serialization(FilterExpression::Query(FilterQuery::Tag(TagQuery { + tag: String::from("World"), + negate: false, + }))) + .unwrap(); +} + +#[test] +fn it_serializes_sort_keys() { + test_serialization(SortKey::FileName(SortDirection::Descending)).unwrap(); +} + +#[test] +fn it_serializes_value_comparators() { + test_serialization(ValueComparator::Between(( + NaiveDateTime::from_timestamp(100, 0), + NaiveDateTime::from_timestamp(100, 10), + ))) + .unwrap(); +} + +fn test_serialization(data: T) -> IPCResult<()> { + let serializer = DynamicSerializer::first_available(); + let bytes = serializer.serialize(data)?; + let _: T = serializer.deserialize(&bytes[..])?; + + Ok(()) +} diff --git a/mediarepo-api/src/types/files.rs b/mediarepo-api/src/types/files.rs new file mode 100644 index 0000000..bb8146e --- /dev/null +++ b/mediarepo-api/src/types/files.rs @@ -0,0 +1,91 @@ +use crate::types::identifier::FileIdentifier; +use chrono::NaiveDateTime; +use serde::{Deserialize, Serialize}; +use std::fmt::Debug; + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct ReadFileRequest { + pub id: FileIdentifier, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct GetFileThumbnailsRequest { + pub id: FileIdentifier, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct GetFileThumbnailOfSizeRequest { + pub id: FileIdentifier, + pub min_size: (u32, u32), + pub max_size: (u32, u32), +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct GetFileTagsRequest { + pub id: FileIdentifier, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct GetFilesTagsRequest { + pub cds: Vec, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct FileBasicDataResponse { + pub id: i64, + pub status: FileStatus, + pub cd: String, + pub mime_type: String, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub enum FileStatus { + Imported, + Archived, + Deleted, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct FileMetadataResponse { + pub file_id: i64, + pub name: Option, + pub comment: Option, + pub creation_time: NaiveDateTime, + pub change_time: NaiveDateTime, + pub import_time: NaiveDateTime, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct FileOSMetadata { + pub path: String, + pub name: String, + pub mime_type: Option, + pub creation_time: NaiveDateTime, + pub change_time: NaiveDateTime, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct ThumbnailMetadataResponse { + pub file_hash: String, + pub height: u32, + pub width: u32, + pub mime_type: String, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct UpdateFileNameRequest { + pub file_id: FileIdentifier, + pub name: String, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct UpdateFileStatusRequest { + pub file_id: FileIdentifier, + pub status: FileStatus, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct AddFileRequestHeader { + pub metadata: FileOSMetadata, + pub tags: Vec, +} diff --git a/mediarepo-api/src/types/filtering.rs b/mediarepo-api/src/types/filtering.rs new file mode 100644 index 0000000..916db73 --- /dev/null +++ b/mediarepo-api/src/types/filtering.rs @@ -0,0 +1,73 @@ +use crate::types::files::FileStatus; +use chrono::NaiveDateTime; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct FindFilesRequest { + pub filters: Vec, + pub sort_expression: Vec, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub enum FilterExpression { + OrExpression(Vec), + Query(FilterQuery), +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub enum FilterQuery { + Tag(TagQuery), + Property(PropertyQuery), +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct TagQuery { + pub negate: bool, + pub tag: String, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub enum PropertyQuery { + Status(FileStatus), + FileSize(ValueComparator), + ImportedTime(ValueComparator), + ChangedTime(ValueComparator), + CreatedTime(ValueComparator), + TagCount(ValueComparator), + Cd(String), + Id(i64), +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub enum ValueComparator { + Less(T), + Equal(T), + Greater(T), + Between((T, T)), +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub enum SortKey { + Namespace(SortNamespace), + FileName(SortDirection), + FileSize(SortDirection), + FileImportedTime(SortDirection), + FileCreatedTime(SortDirection), + FileChangeTime(SortDirection), + FileType(SortDirection), + NumTags(SortDirection), +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct SortNamespace { + pub name: String, + pub direction: SortDirection, +} + +#[derive(Clone, Debug, Serialize, Deserialize, Ord, PartialOrd, PartialEq)] +pub enum SortDirection { + Ascending, + Descending, +} + +impl Eq for SortDirection {} diff --git a/mediarepo-api/src/types/identifier.rs b/mediarepo-api/src/types/identifier.rs new file mode 100644 index 0000000..3ec9929 --- /dev/null +++ b/mediarepo-api/src/types/identifier.rs @@ -0,0 +1,7 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub enum FileIdentifier { + ID(i64), + CD(String), +} diff --git a/mediarepo-api/src/types/jobs.rs b/mediarepo-api/src/types/jobs.rs new file mode 100644 index 0000000..b6260fd --- /dev/null +++ b/mediarepo-api/src/types/jobs.rs @@ -0,0 +1,14 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Serialize, Deserialize, Clone, Debug)] +pub struct RunJobRequest { + pub job_type: JobType, + pub sync: bool, +} + +#[derive(Serialize, Deserialize, Clone, Debug)] +pub enum JobType { + MigrateContentDescriptors, + CalculateSizes, + CheckIntegrity, +} diff --git a/mediarepo-api/src/types/misc.rs b/mediarepo-api/src/types/misc.rs new file mode 100644 index 0000000..cf04ed8 --- /dev/null +++ b/mediarepo-api/src/types/misc.rs @@ -0,0 +1,60 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct InfoResponse { + pub name: String, + pub version: String, + pub(crate) api_version: (u32, u32, u32), +} + +impl InfoResponse { + /// Creates a new info response + pub fn new(name: String, version: String) -> Self { + Self { + name, + version, + api_version: get_api_version(), + } + } + + /// Returns the api version of the crate + pub fn api_version(&self) -> (u32, u32, u32) { + self.api_version + } +} + +/// Retrieves the api version of the crate version in numbers +pub fn get_api_version() -> (u32, u32, u32) { + let mut major = env!("CARGO_PKG_VERSION_MAJOR").to_string(); + let mut minor = env!("CARGO_PKG_VERSION_MINOR").to_string(); + let mut patch = env!("CARGO_PKG_VERSION_PATCH").to_string(); + major.retain(char::is_numeric); + minor.retain(char::is_numeric); + patch.retain(char::is_numeric); + let major = major + .parse::() + .expect("Failed to parse major crate version"); + let minor = minor + .parse::() + .expect("Failed to parse minor crate version"); + let patch = patch + .parse::() + .expect("Failed to parse patch crate version"); + + (major, minor, patch) +} + +/// Checks if the api the client consumes is compatible to the one the server provides +pub fn check_apis_compatible( + client_version: (u32, u32, u32), + server_version: (u32, u32, u32), +) -> bool { + if client_version.0 == 0 { + // For the beta and alpha (major 0) compare the minor and patch level + client_version.1 == server_version.1 && client_version.2 <= server_version.2 + } else { + // the major version must be the same while the client minor version can be lower than the servers + // so that the client has access to all its supported functionality + client_version.0 == server_version.0 && client_version.1 <= server_version.1 + } +} diff --git a/mediarepo-api/src/types/mod.rs b/mediarepo-api/src/types/mod.rs new file mode 100644 index 0000000..f76121e --- /dev/null +++ b/mediarepo-api/src/types/mod.rs @@ -0,0 +1,7 @@ +pub mod files; +pub mod filtering; +pub mod identifier; +pub mod jobs; +pub mod misc; +pub mod repo; +pub mod tags; diff --git a/mediarepo-api/src/types/repo.rs b/mediarepo-api/src/types/repo.rs new file mode 100644 index 0000000..645f7dc --- /dev/null +++ b/mediarepo-api/src/types/repo.rs @@ -0,0 +1,30 @@ +use serde::{Deserialize, Serialize}; + +#[derive(Serialize, Deserialize, Clone, Debug)] +pub struct FrontendState { + pub state: Option, +} + +#[derive(Serialize, Deserialize, Clone, Debug)] +pub struct RepositoryMetadata { + pub version: String, + pub file_count: u64, + pub tag_count: u64, + pub namespace_count: u64, + pub mapping_count: u64, + pub hash_count: u64, +} + +#[derive(Serialize, Deserialize, Clone, Debug)] +pub struct SizeMetadata { + pub size_type: SizeType, + pub size: u64, +} + +#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, PartialOrd, Eq, Hash)] +pub enum SizeType { + Total, + FileFolder, + ThumbFolder, + DatabaseFile, +} diff --git a/mediarepo-api/src/types/tags.rs b/mediarepo-api/src/types/tags.rs new file mode 100644 index 0000000..ba34d59 --- /dev/null +++ b/mediarepo-api/src/types/tags.rs @@ -0,0 +1,22 @@ +use crate::types::identifier::FileIdentifier; +use serde::{Deserialize, Serialize}; + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct TagResponse { + pub id: i64, + pub namespace: Option, + pub name: String, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct NamespaceResponse { + pub id: i64, + pub name: String, +} + +#[derive(Clone, Debug, Serialize, Deserialize)] +pub struct ChangeFileTagsRequest { + pub file_id: FileIdentifier, + pub removed_tags: Vec, + pub added_tags: Vec, +}