commit bf0a44fa9fec315f16bb0f4b199768db3be86a10 Author: Manos Pitsidianakis Date: Tue Aug 3 18:00:28 2021 +0300 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..96ef6c0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/target +Cargo.lock diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..fe03dd7 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "libjmap" +version = "0.1.0" +authors = ["Manos Pitsidianakis "] +homepage = "https://meli.delivery" +description = "Provides serializable types for use with the JMAP protocol" +license-file = "LICENSE" +edition = "2018" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] +serde = { version = "1.0.71", features = ["rc", ] } +serde_derive = "1.0.71" +serde_json = { version = "1.0", features = ["raw_value",] } +smallvec = { version = "^1.5.0", features = ["serde", ] } diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..f1d560a --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,76 @@ +/* + * libjmap + * + * Copyright 2019 Manos Pitsidianakis + * + * This file is part of libjmap. + * + * libjmap 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. + * + * libjmap 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 libjmap. If not, see . + */ + +#[macro_use] +extern crate serde_derive; +extern crate serde; +extern crate serde_json; +extern crate smallvec; +use smallvec::SmallVec; + +#[macro_export] +macro_rules! _impl { + ($(#[$outer:meta])*$field:ident : $t:ty) => { + $(#[$outer])* + pub fn $field(mut self, new_val: $t) -> Self { + self.$field = new_val; + self + } + }; + (get_mut $(#[$outer:meta])*$method:ident, $field:ident : $t:ty) => { + $(#[$outer])* + pub fn $method(&mut self) -> &mut $t { + &mut self.$field + } + }; + (get $(#[$outer:meta])*$method:ident, $field:ident : $t:ty) => { + $(#[$outer])* + pub fn $method(&self) -> &$t { + &self.$field + } + } + } + +use serde_derive::{Deserialize, Serialize}; +pub mod objects; +pub mod protocol; +pub mod rfc8620; + +use rfc8620::*; +use std::sync::{Arc, Mutex}; + +pub(crate) fn bytes_find>(bytes: &[u8], needle: T) -> Option { + let needle = needle.as_ref(); + if needle.is_empty() { + return None; + } + bytes + .windows(needle.len()) + .position(|window| window == needle) +} + +#[cfg(test)] +mod tests { + #[test] + fn it_works() { + assert_eq!(2 + 2, 4); + } +} diff --git a/src/objects.rs b/src/objects.rs new file mode 100644 index 0000000..5fce0f1 --- /dev/null +++ b/src/objects.rs @@ -0,0 +1,27 @@ +/* + * libjmap. + * + * Copyright 2019 Manos Pitsidianakis + * + * This file is part of libjmap. + * + * libjmap 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. + * + * libjmap 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 libjmap. If not, see . + */ + +use super::*; + +mod email; +pub use email::*; +mod mailbox; +pub use mailbox::*; diff --git a/src/objects/email.rs b/src/objects/email.rs new file mode 100644 index 0000000..75f2b24 --- /dev/null +++ b/src/objects/email.rs @@ -0,0 +1,558 @@ +/* + * libjmap + * + * Copyright 2019 Manos Pitsidianakis + * + * This file is part of libjmap. + * + * libjmap 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. + * + * libjmap 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 libjmap. If not, see . + */ + +use super::*; +use crate::protocol::{Method, UtcDate}; +use crate::rfc8620::bool_false; +use core::marker::PhantomData; +use serde::de::{Deserialize, Deserializer}; +use serde_json::value::RawValue; +use serde_json::Value; +use std::collections::hash_map::DefaultHasher; +use std::collections::HashMap; +use std::hash::Hasher; + +mod import; +pub use import::*; + +pub type EnvelopeHash = u64; + +#[derive(Debug)] +pub struct ThreadObject; + +impl Object for ThreadObject { + const NAME: &'static str = "Thread"; +} + +impl Id { + pub fn into_hash(&self) -> EnvelopeHash { + let mut h = DefaultHasher::new(); + h.write(self.inner.as_bytes()); + h.finish() + } +} + +// 4.1.1. +// Metadata +// These properties represent metadata about the message in the mail +// store and are not derived from parsing the message itself. +// +// o id: "Id" (immutable; server-set) +// +// The id of the Email object. Note that this is the JMAP object id, +// NOT the Message-ID header field value of the message [RFC5322]. +// +// o blobId: "Id" (immutable; server-set) +// +// The id representing the raw octets of the message [RFC5322] for +// this Email. This may be used to download the raw original message +// or to attach it directly to another Email, etc. +// +// o threadId: "Id" (immutable; server-set) +// +// The id of the Thread to which this Email belongs. +// +// o mailboxIds: "Id[Boolean]" +// +// The set of Mailbox ids this Email belongs to. An Email in the +// mail store MUST belong to one or more Mailboxes at all times +// (until it is destroyed). The set is represented as an object, +// with each key being a Mailbox id. The value for each key in the +// object MUST be true. +// +// o keywords: "String[Boolean]" (default: {}) +// +// A set of keywords that apply to the Email. The set is represented +// as an object, with the keys being the keywords. The value for +// each key in the object MUST be true. +// +// Keywords are shared with IMAP. The six system keywords from IMAP +// get special treatment. The following four keywords have their +// first character changed from "\" in IMAP to "$" in JMAP and have +// particular semantic meaning: +// +// * "$draft": The Email is a draft the user is composing. +// +// * "$seen": The Email has been read. +// +// * "$flagged": The Email has been flagged for urgent/special +// attention. +// +// * "$answered": The Email has been replied to. +// +// The IMAP "\Recent" keyword is not exposed via JMAP. The IMAP +// "\Deleted" keyword is also not present: IMAP uses a delete+expunge +// model, which JMAP does not. Any message with the "\Deleted" +// keyword MUST NOT be visible via JMAP (and so are not counted in +// the "totalEmails", "unreadEmails", "totalThreads", and +// "unreadThreads" Mailbox properties). +// +// Users may add arbitrary keywords to an Email. For compatibility +// with IMAP, a keyword is a case-insensitive string of 1-255 +// characters in the ASCII subset %x21-%x7e (excludes control chars +// and space), and it MUST NOT include any of these characters: +// +// ( ) { ] % * " \ +// +// Because JSON is case sensitive, servers MUST return keywords in +// lowercase. +// +// The IANA "IMAP and JMAP Keywords" registry at +// as +// established in [RFC5788] assigns semantic meaning to some other +// keywords in common use. New keywords may be established here in +// the future. In particular, note: +// +// * "$forwarded": The Email has been forwarded. +// +// * "$phishing": The Email is highly likely to be phishing. +// Clients SHOULD warn users to take care when viewing this Email +// and disable links and attachments. +// +// * "$junk": The Email is definitely spam. Clients SHOULD set this +// flag when users report spam to help train automated spam- +// detection systems. +// +// * "$notjunk": The Email is definitely not spam. Clients SHOULD +// set this flag when users indicate an Email is legitimate, to +// help train automated spam-detection systems. +// +// o size: "UnsignedInt" (immutable; server-set) +// +// The size, in octets, of the raw data for the message [RFC5322] (as +// referenced by the "blobId", i.e., the number of octets in the file +// the user would download). +// +// o receivedAt: "UTCDate" (immutable; default: time of creation on +// server) +// +// The date the Email was received by the message store. This is the +// "internal date" in IMAP [RFC3501]./ + +#[derive(Deserialize, Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct EmailObject { + #[serde(default)] + pub id: Id, + #[serde(default)] + pub blob_id: Id, + #[serde(default)] + pub mailbox_ids: HashMap, bool>, + #[serde(default)] + pub size: u64, + #[serde(default)] + pub received_at: String, + #[serde(default)] + pub message_id: Vec, + #[serde(default)] + pub to: Option>, + #[serde(default)] + pub bcc: Option>, + #[serde(default)] + pub reply_to: Option>, + #[serde(default)] + pub cc: Option>, + #[serde(default)] + pub sender: Option>, + #[serde(default)] + pub from: Option>, + #[serde(default)] + pub in_reply_to: Option>, + #[serde(default)] + pub references: Option>, + #[serde(default)] + pub keywords: HashMap, + #[serde(default)] + pub attached_emails: Option>, + #[serde(default)] + pub attachments: Vec, + #[serde(default)] + pub has_attachment: bool, + #[serde(default)] + #[serde(deserialize_with = "deserialize_header")] + pub headers: HashMap, + #[serde(default)] + pub html_body: Vec, + #[serde(default)] + pub preview: Option, + #[serde(default)] + pub sent_at: Option, + #[serde(default)] + pub subject: Option, + #[serde(default)] + pub text_body: Vec, + #[serde(default)] + pub thread_id: Id, + #[serde(flatten)] + pub extra: HashMap, +} + +impl EmailObject { + _impl!(get keywords, keywords: HashMap); +} + +#[derive(Deserialize, Serialize, Debug, Default)] +#[serde(rename_all = "camelCase")] +pub struct Header { + pub name: String, + pub value: String, +} + +fn deserialize_header<'de, D>( + deserializer: D, +) -> std::result::Result, D::Error> +where + D: Deserializer<'de>, +{ + let v = >::deserialize(deserializer)?; + Ok(v.into_iter().map(|t| (t.name, t.value)).collect()) +} + +#[derive(Deserialize, Serialize, Debug, Default)] +#[serde(rename_all = "camelCase")] +pub struct EmailAddress { + pub email: String, + pub name: Option, +} + +impl std::fmt::Display for EmailAddress { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + if self.name.is_some() { + write!(f, "{} <{}>", self.name.as_ref().unwrap(), &self.email) + } else { + write!(f, "{}", &self.email) + } + } +} + +#[derive(Deserialize, Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct HtmlBody { + pub blob_id: Id, + #[serde(default)] + pub charset: String, + #[serde(default)] + pub cid: Option, + #[serde(default)] + pub disposition: Option, + #[serde(default)] + pub headers: Value, + #[serde(default)] + pub language: Option>, + #[serde(default)] + pub location: Option, + #[serde(default)] + pub name: Option, + #[serde(default)] + pub part_id: Option, + pub size: u64, + #[serde(alias = "type")] + pub content_type: String, + #[serde(default)] + pub sub_parts: Vec, +} + +#[derive(Deserialize, Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct TextBody { + pub blob_id: Id, + #[serde(default)] + pub charset: String, + #[serde(default)] + pub cid: Option, + #[serde(default)] + pub disposition: Option, + #[serde(default)] + pub headers: Value, + #[serde(default)] + pub language: Option>, + #[serde(default)] + pub location: Option, + #[serde(default)] + pub name: Option, + #[serde(default)] + pub part_id: Option, + pub size: u64, + #[serde(alias = "type")] + pub content_type: String, + #[serde(default)] + pub sub_parts: Vec, +} + +impl Object for EmailObject { + const NAME: &'static str = "Email"; +} + +#[derive(Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct EmailQuery { + #[serde(flatten)] + pub query_call: Query, EmailObject>, + //pub filter: EmailFilterCondition, /* "inMailboxes": [ mailbox.id ] },*/ + pub collapse_threads: bool, +} + +impl Method for EmailQuery { + const NAME: &'static str = "Email/query"; +} + +impl EmailQuery { + pub const RESULT_FIELD_IDS: ResultField = + ResultField:: { + field: "/ids", + _ph: PhantomData, + }; + + pub fn new(query_call: Query, EmailObject>) -> Self { + EmailQuery { + query_call, + collapse_threads: false, + } + } + + _impl!(collapse_threads: bool); +} + +#[derive(Deserialize, Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct EmailGet { + #[serde(flatten)] + pub get_call: Get, + #[serde(skip_serializing_if = "Vec::is_empty")] + pub body_properties: Vec, + #[serde(default = "bool_false")] + pub fetch_text_body_values: bool, + #[serde(default = "bool_false")] + #[serde(rename = "fetchHTMLBodyValues")] + pub fetch_html_body_values: bool, + #[serde(default = "bool_false")] + pub fetch_all_body_values: bool, + #[serde(default)] + #[serde(skip_serializing_if = "u64_zero")] + pub max_body_value_bytes: u64, +} + +impl Method for EmailGet { + const NAME: &'static str = "Email/get"; +} + +impl EmailGet { + pub fn new(get_call: Get) -> Self { + EmailGet { + get_call, + body_properties: Vec::new(), + fetch_text_body_values: false, + fetch_html_body_values: false, + fetch_all_body_values: false, + max_body_value_bytes: 0, + } + } + + _impl!(body_properties: Vec); + _impl!(fetch_text_body_values: bool); + _impl!(fetch_html_body_values: bool); + _impl!(fetch_all_body_values: bool); + _impl!(max_body_value_bytes: u64); +} + +#[derive(Serialize, Deserialize, Default, Debug)] +#[serde(rename_all = "camelCase")] +pub struct EmailFilterCondition { + #[serde(skip_serializing_if = "Option::is_none")] + pub in_mailbox: Option>, + #[serde(skip_serializing_if = "Vec::is_empty")] + pub in_mailbox_other_than: Vec>, + #[serde(skip_serializing_if = "String::is_empty")] + pub before: UtcDate, + #[serde(skip_serializing_if = "String::is_empty")] + pub after: UtcDate, + #[serde(default)] + #[serde(skip_serializing_if = "Option::is_none")] + pub min_size: Option, + #[serde(default)] + #[serde(skip_serializing_if = "Option::is_none")] + pub max_size: Option, + #[serde(skip_serializing_if = "String::is_empty")] + pub all_in_thread_have_keyword: String, + #[serde(skip_serializing_if = "String::is_empty")] + pub some_in_thread_have_keyword: String, + #[serde(skip_serializing_if = "String::is_empty")] + pub none_in_thread_have_keyword: String, + #[serde(skip_serializing_if = "String::is_empty")] + pub has_keyword: String, + #[serde(skip_serializing_if = "String::is_empty")] + pub not_keyword: String, + #[serde(skip_serializing_if = "Option::is_none")] + pub has_attachment: Option, + #[serde(skip_serializing_if = "String::is_empty")] + pub text: String, + #[serde(skip_serializing_if = "String::is_empty")] + pub from: String, + #[serde(skip_serializing_if = "String::is_empty")] + pub to: String, + #[serde(skip_serializing_if = "String::is_empty")] + pub cc: String, + #[serde(skip_serializing_if = "String::is_empty")] + pub bcc: String, + #[serde(skip_serializing_if = "String::is_empty")] + pub subject: String, + #[serde(skip_serializing_if = "String::is_empty")] + pub body: String, + #[serde(skip_serializing_if = "Vec::is_empty")] + pub header: Vec, +} + +impl EmailFilterCondition { + pub fn new() -> Self { + Self::default() + } + + _impl!(in_mailbox: Option>); + _impl!(in_mailbox_other_than: Vec>); + _impl!(before: UtcDate); + _impl!(after: UtcDate); + _impl!(min_size: Option); + _impl!(max_size: Option); + _impl!(all_in_thread_have_keyword: String); + _impl!(some_in_thread_have_keyword: String); + _impl!(none_in_thread_have_keyword: String); + _impl!(has_keyword: String); + _impl!(not_keyword: String); + _impl!(has_attachment: Option); + _impl!(text: String); + _impl!(from: String); + _impl!(to: String); + _impl!(cc: String); + _impl!(bcc: String); + _impl!(subject: String); + _impl!(body: String); + _impl!(header: Vec); +} + +impl FilterTrait for EmailFilterCondition {} + +impl From for FilterCondition { + fn from(val: EmailFilterCondition) -> FilterCondition { + FilterCondition { + cond: val, + _ph: PhantomData, + } + } +} + +#[derive(Deserialize, Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub enum MessageProperty { + ThreadId, + MailboxIds, + Keywords, + Size, + ReceivedAt, + IsUnread, + IsFlagged, + IsAnswered, + IsDraft, + HasAttachment, + From, + To, + Cc, + Bcc, + ReplyTo, + Subject, + SentAt, + Preview, + Id, + BlobId, + MessageId, + InReplyTo, + Sender, +} + +#[derive(Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct EmailSet { + #[serde(flatten)] + pub set_call: Set, +} + +impl Method for EmailSet { + const NAME: &'static str = "Email/set"; +} + +impl EmailSet { + pub fn new(set_call: Set) -> Self { + EmailSet { set_call } + } +} + +#[derive(Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct EmailChanges { + #[serde(flatten)] + pub changes_call: Changes, +} + +impl Method for EmailChanges { + const NAME: &'static str = "Email/changes"; +} + +impl EmailChanges { + pub fn new(changes_call: Changes) -> Self { + EmailChanges { changes_call } + } +} + +#[derive(Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct EmailQueryChanges { + #[serde(flatten)] + pub query_changes_call: QueryChanges, EmailObject>, +} + +impl Method for EmailQueryChanges { + const NAME: &'static str = "Email/queryChanges"; +} + +impl EmailQueryChanges { + pub fn new( + query_changes_call: QueryChanges, EmailObject>, + ) -> Self { + EmailQueryChanges { query_changes_call } + } +} + +#[derive(Deserialize, Serialize, Debug)] +pub struct EmailQueryChangesResponse { + ///o The "collapseThreads" argument that was used with "Email/query". + #[serde(default = "bool_false")] + pub collapse_threads: bool, + #[serde(flatten)] + pub query_changes_response: QueryChangesResponse, +} + +impl std::convert::TryFrom<&RawValue> for EmailQueryChangesResponse { + type Error = serde_json::error::Error; + fn try_from(t: &RawValue) -> Result { + let res: (String, EmailQueryChangesResponse, String) = serde_json::from_str(t.get())?; + assert_eq!(&res.0, "Email/queryChanges"); + Ok(res.1) + } +} diff --git a/src/objects/email/import.rs b/src/objects/email/import.rs new file mode 100644 index 0000000..a8b3d22 --- /dev/null +++ b/src/objects/email/import.rs @@ -0,0 +1,200 @@ +/* + * libjmap - + * + * Copyright Manos Pitsidianakis + * + * This file is part of libjmap. + * + * libjmap 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. + * + * libjmap 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 libjmap. If not, see . + */ + +use super::*; +use serde_json::value::RawValue; + +/// #`import` +/// +/// Objects of type `Foo` are imported via a call to `Foo/import`. +/// +/// It takes the following arguments: +/// +/// - `account_id`: "Id" +/// +/// The id of the account to use. +/// +#[derive(Deserialize, Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct ImportCall { + ///accountId: "Id" + ///The id of the account to use. + pub account_id: Id, + ///ifInState: "String|null" + ///This is a state string as returned by the "Email/get" method. If + ///supplied, the string must match the current state of the account + ///referenced by the accountId; otherwise, the method will be aborted + ///and a "stateMismatch" error returned. If null, any changes will + ///be applied to the current state. + #[serde(skip_serializing_if = "Option::is_none")] + pub if_in_state: Option>, + ///o emails: "Id[EmailImport]" + ///A map of creation id (client specified) to EmailImport objects. + pub emails: HashMap, EmailImport>, +} + +#[derive(Deserialize, Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct EmailImport { + ///o blobId: "Id" + ///The id of the blob containing the raw message [RFC5322]. + pub blob_id: Id, + ///o mailboxIds: "Id[Boolean]" + ///The ids of the Mailboxes to assign this Email to. At least one + ///Mailbox MUST be given. + pub mailbox_ids: HashMap, bool>, + ///o keywords: "String[Boolean]" (default: {}) + ///The keywords to apply to the Email. + pub keywords: HashMap, + + ///o receivedAt: "UTCDate" (default: time of most recent Received + ///header, or time of import on server if none) + ///The "receivedAt" date to set on the Email. + pub received_at: Option, +} + +impl ImportCall { + pub fn new() -> Self { + Self { + account_id: Id::new(), + if_in_state: None, + emails: HashMap::default(), + } + } + + _impl!( + /// - accountId: "Id" + /// + /// The id of the account to use. + /// + account_id: Id + ); + _impl!(if_in_state: Option>); + _impl!(emails: HashMap, EmailImport>); +} + +impl Method for ImportCall { + const NAME: &'static str = "Email/import"; +} + +impl EmailImport { + pub fn new() -> Self { + Self { + blob_id: Id::new(), + mailbox_ids: HashMap::default(), + keywords: HashMap::default(), + received_at: None, + } + } + + _impl!(blob_id: Id); + _impl!(mailbox_ids: HashMap, bool>); + _impl!(keywords: HashMap); + _impl!(received_at: Option); +} + +#[derive(Deserialize, Serialize, Debug)] +#[serde(rename_all = "camelCase")] +#[serde(tag = "type")] +pub enum ImportError { + ///The server MAY forbid two Email objects with the same exact content + /// [RFC5322], or even just with the same Message-ID [RFC5322], to + /// coexist within an account. In this case, it MUST reject attempts to + /// import an Email considered to be a duplicate with an "alreadyExists" + /// SetError. + AlreadyExists { + description: Option, + /// An "existingId" property of type "Id" MUST be included on + ///the SetError object with the id of the existing Email. If duplicates + ///are allowed, the newly created Email object MUST have a separate id + ///and independent mutable properties to the existing object. + existing_id: Id, + }, + ///If the "blobId", "mailboxIds", or "keywords" properties are invalid + ///(e.g., missing, wrong type, id not found), the server MUST reject the + ///import with an "invalidProperties" SetError. + InvalidProperties { + description: Option, + properties: Vec, + }, + ///If the Email cannot be imported because it would take the account + ///over quota, the import should be rejected with an "overQuota" + ///SetError. + OverQuota { description: Option }, + ///If the blob referenced is not a valid message [RFC5322], the server + ///MAY modify the message to fix errors (such as removing NUL octets or + ///fixing invalid headers). If it does this, the "blobId" on the + ///response MUST represent the new representation and therefore be + ///different to the "blobId" on the EmailImport object. Alternatively, + ///the server MAY reject the import with an "invalidEmail" SetError. + InvalidEmail { description: Option }, + ///An "ifInState" argument was supplied, and it does not match the current state. + StateMismatch, +} + +#[derive(Deserialize, Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct ImportResponse { + ///o accountId: "Id" + ///The id of the account used for this call. + pub account_id: Id, + + ///o oldState: "String|null" + ///The state string that would have been returned by "Email/get" on + ///this account before making the requested changes, or null if the + ///server doesn't know what the previous state string was. + pub old_state: Option>, + + ///o newState: "String" + ///The state string that will now be returned by "Email/get" on this + ///account. + pub new_state: Option>, + + ///o created: "Id[Email]|null" + ///A map of the creation id to an object containing the "id", + ///"blobId", "threadId", and "size" properties for each successfully + ///imported Email, or null if none. + pub created: HashMap, ImportEmailResult>, + + ///o notCreated: "Id[SetError]|null" + ///A map of the creation id to a SetError object for each Email that + ///failed to be created, or null if all successful. The possible + ///errors are defined above. + pub not_created: HashMap, ImportError>, +} + +impl std::convert::TryFrom<&RawValue> for ImportResponse { + type Error = serde_json::error::Error; + fn try_from(t: &RawValue) -> Result { + let res: (String, ImportResponse, String) = serde_json::from_str(t.get())?; + assert_eq!(&res.0, &ImportCall::NAME); + Ok(res.1) + } +} + +#[derive(Deserialize, Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct ImportEmailResult { + pub id: Id, + pub blob_id: Id, + pub thread_id: Id, + pub size: usize, +} diff --git a/src/objects/mailbox.rs b/src/objects/mailbox.rs new file mode 100644 index 0000000..d3d90cb --- /dev/null +++ b/src/objects/mailbox.rs @@ -0,0 +1,84 @@ +/* + * libjmap + * + * Copyright 2019 Manos Pitsidianakis + * + * This file is part of libjmap. + * + * libjmap 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. + * + * libjmap 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 libjmap. If not, see . + */ + +use super::*; +use crate::protocol::Method; +use std::collections::hash_map::DefaultHasher; +use std::hash::Hasher; + +pub type MailboxHash = u64; + +impl Id { + pub fn into_hash(&self) -> MailboxHash { + let mut h = DefaultHasher::new(); + h.write(self.inner.as_bytes()); + h.finish() + } +} + +#[derive(Deserialize, Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct MailboxObject { + pub id: Id, + pub is_subscribed: bool, + pub my_rights: JmapRights, + pub name: String, + pub parent_id: Option>, + pub role: Option, + pub sort_order: u64, + pub total_emails: u64, + pub total_threads: u64, + pub unread_emails: u64, + pub unread_threads: u64, +} + +impl Object for MailboxObject { + const NAME: &'static str = "Mailbox"; +} + +#[derive(Deserialize, Serialize, Debug, Clone)] +#[serde(rename_all = "camelCase")] +pub struct JmapRights { + pub may_add_items: bool, + pub may_create_child: bool, + pub may_delete: bool, + pub may_read_items: bool, + pub may_remove_items: bool, + pub may_rename: bool, + pub may_set_keywords: bool, + pub may_set_seen: bool, + pub may_submit: bool, +} +#[derive(Deserialize, Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct MailboxGet { + #[serde(flatten)] + pub get_call: Get, +} +impl MailboxGet { + pub fn new(get_call: Get) -> Self { + MailboxGet { get_call } + } +} + +impl Method for MailboxGet { + const NAME: &'static str = "Mailbox/get"; +} diff --git a/src/protocol.rs b/src/protocol.rs new file mode 100644 index 0000000..6c6f737 --- /dev/null +++ b/src/protocol.rs @@ -0,0 +1,83 @@ +/* + * libjmap + * + * Copyright 2019 Manos Pitsidianakis + * + * This file is part of libjmap. + * + * libjmap 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. + * + * libjmap 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 libjmap. If not, see . + */ + +use super::*; +use serde::Serialize; +use serde_json::Value; + +pub type UtcDate = String; + +use super::rfc8620::Object; + +macro_rules! get_request_no { + ($lock:expr) => {{ + let mut lck = $lock.lock().unwrap(); + let ret = *lck; + *lck += 1; + ret + }}; +} + +pub trait Response { + const NAME: &'static str; +} + +pub trait Method: Serialize { + const NAME: &'static str; +} + +static USING: &[&str] = &["urn:ietf:params:jmap:core", "urn:ietf:params:jmap:mail"]; + +#[derive(Serialize)] +#[serde(rename_all = "camelCase")] +pub struct Request { + using: &'static [&'static str], + /* Why is this Value instead of Box>? The Method trait cannot be made into a + * Trait object because its serialize() will be generic. */ + method_calls: Vec, + + #[serde(skip)] + request_no: Arc>, +} + +impl Request { + pub fn new(request_no: Arc>) -> Self { + Request { + using: USING, + method_calls: Vec::new(), + request_no, + } + } + + pub fn add_call, O: Object>(&mut self, call: &M) -> usize { + let seq = get_request_no!(self.request_no); + self.method_calls + .push(serde_json::to_value((M::NAME, call, &format!("m{}", seq))).unwrap()); + seq + } +} + +#[derive(Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct JsonResponse<'a> { + #[serde(borrow)] + method_responses: Vec>, +} diff --git a/src/rfc8620.rs b/src/rfc8620.rs new file mode 100644 index 0000000..b168c5c --- /dev/null +++ b/src/rfc8620.rs @@ -0,0 +1,1174 @@ +/* + * libjmap + * + * Copyright 2019 Manos Pitsidianakis + * + * This file is part of libjmap. + * + * libjmap 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. + * + * libjmap 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 libjmap. If not, see . + */ + +use crate::bytes_find; +use core::marker::PhantomData; +use serde::de::DeserializeOwned; +use serde::ser::{Serialize, SerializeStruct, Serializer}; +use serde_json::{value::RawValue, Value}; +use std::hash::{Hash, Hasher}; +use std::sync::Arc; + +mod filters; +pub use filters::*; +mod comparator; +pub use comparator::*; +mod argument; +pub use argument::*; + +use super::protocol::Method; +use std::collections::HashMap; +pub trait Object { + const NAME: &'static str; +} + +#[derive(Deserialize, Serialize)] +#[serde(transparent)] +pub struct Id { + pub inner: String, + #[serde(skip)] + pub _ph: PhantomData OBJ>, +} + +impl core::fmt::Debug for Id { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + f.debug_tuple(&format!("Id<{}>", OBJ::NAME)) + .field(&self.inner) + .finish() + } +} + +impl core::fmt::Debug for Id { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + f.debug_tuple("Id").field(&self.inner).finish() + } +} + +//, Hash, Eq, PartialEq, Default)] +impl Clone for Id { + fn clone(&self) -> Self { + Id { + inner: self.inner.clone(), + _ph: PhantomData, + } + } +} + +impl std::cmp::Eq for Id {} + +impl std::cmp::PartialEq for Id { + fn eq(&self, other: &Self) -> bool { + self.inner == other.inner + } +} + +impl Hash for Id { + fn hash(&self, state: &mut H) { + self.inner.hash(state); + } +} + +impl Default for Id { + fn default() -> Self { + Self::new() + } +} + +impl From for Id { + fn from(inner: String) -> Self { + Id { + inner, + _ph: PhantomData, + } + } +} + +impl core::fmt::Display for Id { + fn fmt(&self, fmt: &mut core::fmt::Formatter) -> core::fmt::Result { + core::fmt::Display::fmt(&self.inner, fmt) + } +} + +impl Id { + pub fn new() -> Self { + Self { + inner: String::new(), + _ph: PhantomData, + } + } + + pub fn as_str(&self) -> &str { + self.inner.as_str() + } + + pub fn len(&self) -> usize { + self.inner.len() + } + + pub fn is_empty(&self) -> bool { + self.inner.is_empty() + } +} + +#[derive(Deserialize, Serialize, Debug)] +#[serde(transparent)] +pub struct State { + pub inner: String, + #[serde(skip)] + pub _ph: PhantomData OBJ>, +} + +//, Hash, Eq, PartialEq, Default)] +impl Clone for State { + fn clone(&self) -> Self { + State { + inner: self.inner.clone(), + _ph: PhantomData, + } + } +} + +impl std::cmp::Eq for State {} + +impl std::cmp::PartialEq for State { + fn eq(&self, other: &Self) -> bool { + self.inner == other.inner + } +} + +impl Hash for State { + fn hash(&self, state: &mut H) { + self.inner.hash(state); + } +} + +impl Default for State { + fn default() -> Self { + Self::new() + } +} + +impl From for State { + fn from(inner: String) -> Self { + State { + inner, + _ph: PhantomData, + } + } +} + +impl core::fmt::Display for State { + fn fmt(&self, fmt: &mut core::fmt::Formatter) -> core::fmt::Result { + core::fmt::Display::fmt(&self.inner, fmt) + } +} + +impl State { + pub fn new() -> Self { + Self { + inner: String::new(), + _ph: PhantomData, + } + } + + pub fn as_str(&self) -> &str { + self.inner.as_str() + } + + pub fn len(&self) -> usize { + self.inner.len() + } + + pub fn is_empty(&self) -> bool { + self.inner.is_empty() + } +} + +#[derive(Deserialize, Serialize, Debug, Default)] +#[serde(rename_all = "camelCase")] +pub struct JmapSession { + pub capabilities: HashMap, + pub accounts: HashMap, Account>, + pub primary_accounts: HashMap>, + pub username: String, + pub api_url: Arc, + pub download_url: Arc, + + pub upload_url: Arc, + pub event_source_url: Arc, + pub state: State, + #[serde(flatten)] + pub extra_properties: HashMap, +} + +impl Object for JmapSession { + const NAME: &'static str = "Session"; +} + +#[derive(Deserialize, Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct CapabilitiesObject { + #[serde(default)] + max_size_upload: u64, + #[serde(default)] + max_concurrent_upload: u64, + #[serde(default)] + max_size_request: u64, + #[serde(default)] + max_concurrent_requests: u64, + #[serde(default)] + max_calls_in_request: u64, + #[serde(default)] + max_objects_in_get: u64, + #[serde(default)] + max_objects_in_set: u64, + #[serde(default)] + collation_algorithms: Vec, +} + +#[derive(Deserialize, Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct Account { + name: String, + is_personal: bool, + is_read_only: bool, + account_capabilities: HashMap, + #[serde(flatten)] + extra_properties: HashMap, +} + +impl Object for Account { + const NAME: &'static str = "Account"; +} + +#[derive(Debug)] +pub struct BlobObject; + +impl Object for BlobObject { + const NAME: &'static str = "Blob"; +} + +/// #`get` +/// +/// Objects of type `Foo` are fetched via a call to `Foo/get`. +/// +/// It takes the following arguments: +/// +/// - `account_id`: "Id" +/// +/// The id of the account to use. +/// +#[derive(Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct Get +where + OBJ: std::fmt::Debug + Serialize, +{ + pub account_id: Id, + #[serde(skip_serializing_if = "Option::is_none")] + #[serde(flatten)] + pub ids: Option>>>, + #[serde(skip_serializing_if = "Option::is_none")] + pub properties: Option>, + #[serde(skip)] + _ph: PhantomData OBJ>, +} + +impl Get +where + OBJ: std::fmt::Debug + Serialize, +{ + pub fn new() -> Self { + Self { + account_id: Id::new(), + ids: None, + properties: None, + _ph: PhantomData, + } + } + _impl!( + /// - accountId: "Id" + /// + /// The id of the account to use. + /// + account_id: Id + ); + _impl!( + /// - ids: `Option>>` + /// + /// The ids of the Foo objects to return. If `None`, then *all* records + /// of the data type are returned, if this is supported for that data + /// type and the number of records does not exceed the + /// "max_objects_in_get" limit. + /// + ids: Option>>> + ); + _impl!( + /// - properties: Option> + /// + /// If supplied, only the properties listed in the array are returned + /// for each `Foo` object. If `None`, all properties of the object are + /// returned. The `id` property of the object is *always* returned, + /// even if not explicitly requested. If an invalid property is + /// requested, the call WILL be rejected with an "invalid_arguments" + /// error. + properties: Option> + ); +} + +impl Serialize for Get { + fn serialize(&self, serializer: S) -> Result + where + S: Serializer, + { + let mut fields_no = 0; + if !self.account_id.is_empty() { + fields_no += 1; + } + if self.ids.is_some() { + fields_no += 1; + } + if self.properties.is_some() { + fields_no += 1; + } + + let mut state = serializer.serialize_struct("Get", fields_no)?; + if !self.account_id.is_empty() { + state.serialize_field("accountId", &self.account_id)?; + } + match self.ids.as_ref() { + None => {} + Some(JmapArgument::Value(ref v)) => state.serialize_field("ids", v)?, + Some(JmapArgument::ResultReference { + ref result_of, + ref name, + ref path, + }) => { + #[derive(Serialize)] + #[serde(rename_all = "camelCase")] + struct A<'a> { + result_of: &'a str, + name: &'a str, + path: &'a str, + } + + state.serialize_field( + "#ids", + &A { + result_of, + name, + path, + }, + )?; + } + } + + if self.properties.is_some() { + state.serialize_field("properties", self.properties.as_ref().unwrap())?; + } + + state.end() + } +} + +#[derive(Serialize, Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct MethodResponse<'a> { + #[serde(borrow)] + pub method_responses: Vec<&'a RawValue>, + #[serde(default)] + pub created_ids: HashMap, Id>, + #[serde(default)] + pub session_state: State, +} + +#[derive(Serialize, Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct GetResponse { + pub account_id: Id, + #[serde(default = "State::default")] + pub state: State, + pub list: Vec, + pub not_found: Vec>, +} + +impl std::convert::TryFrom<&RawValue> for GetResponse { + type Error = serde_json::error::Error; + fn try_from(t: &RawValue) -> Result, serde_json::error::Error> { + let res: (String, GetResponse, String) = serde_json::from_str(t.get())?; + assert_eq!(&res.0, &format!("{}/get", OBJ::NAME)); + Ok(res.1) + } +} + +impl GetResponse { + _impl!(get_mut account_id_mut, account_id: Id); + _impl!(get_mut state_mut, state: State); + _impl!(get_mut list_mut, list: Vec); + _impl!(get_mut not_found_mut, not_found: Vec>); +} + +#[derive(Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +enum JmapError { + RequestTooLarge, + InvalidArguments, + InvalidResultReference, +} + +#[derive(Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct Query, OBJ: Object> +where + OBJ: std::fmt::Debug + Serialize, +{ + account_id: Id, + filter: Option, + sort: Option>, + #[serde(default)] + position: u64, + #[serde(skip_serializing_if = "Option::is_none")] + anchor: Option, + #[serde(default)] + #[serde(skip_serializing_if = "u64_zero")] + anchor_offset: u64, + #[serde(skip_serializing_if = "Option::is_none")] + limit: Option, + #[serde(default = "bool_false")] + calculate_total: bool, + #[serde(skip)] + _ph: PhantomData OBJ>, +} + +impl, OBJ: Object> Query +where + OBJ: std::fmt::Debug + Serialize, +{ + pub fn new() -> Self { + Self { + account_id: Id::new(), + filter: None, + sort: None, + position: 0, + anchor: None, + anchor_offset: 0, + limit: None, + calculate_total: false, + _ph: PhantomData, + } + } + + _impl!(account_id: Id); + _impl!(filter: Option); + _impl!(sort: Option>); + _impl!(position: u64); + _impl!(anchor: Option); + _impl!(anchor_offset: u64); + _impl!(limit: Option); + _impl!(calculate_total: bool); +} + +pub fn u64_zero(num: &u64) -> bool { + *num == 0 +} + +pub fn bool_false() -> bool { + false +} + +pub fn bool_true() -> bool { + true +} + +#[derive(Serialize, Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct QueryResponse { + pub account_id: Id, + pub query_state: String, + pub can_calculate_changes: bool, + pub position: u64, + pub ids: Vec>, + #[serde(default)] + pub total: u64, + #[serde(default)] + pub limit: u64, + #[serde(skip)] + _ph: PhantomData OBJ>, +} + +impl std::convert::TryFrom<&RawValue> for QueryResponse { + type Error = serde_json::error::Error; + fn try_from(t: &RawValue) -> Result, serde_json::error::Error> { + let res: (String, QueryResponse, String) = serde_json::from_str(t.get())?; + assert_eq!(&res.0, &format!("{}/query", OBJ::NAME)); + Ok(res.1) + } +} + +impl QueryResponse { + _impl!(get_mut ids_mut, ids: Vec>); +} + +pub struct ResultField, OBJ: Object> { + pub field: &'static str, + pub _ph: PhantomData (OBJ, M)>, +} + +impl, OBJ: Object> ResultField { + pub fn new(field: &'static str) -> Self { + ResultField { + field, + _ph: PhantomData, + } + } +} + +// error[E0723]: trait bounds other than `Sized` on const fn parameters are unstable +// --> melib/src/backends/jmap/rfc8620.rs:626:6 +// | +// 626 | impl, OBJ: Object> ResultField { +// | ^ +// | +// = note: for more information, see issue https://github.com/rust-lang/rust/issues/57563 +// = help: add `#![feature(const_fn)]` to the crate attributes to enable +// impl, OBJ: Object> ResultField { +// pub const fn new(field: &'static str) -> Self { +// Self { +// field, +// _ph: PhantomData, +// } +// } +// } + +/// #`changes` +/// +/// The "Foo/changes" method allows a client to efficiently update the state of its Foo cache +/// to match the new state on the server. It takes the following arguments: +/// +/// - accountId: "Id" The id of the account to use. +/// - sinceState: "String" +/// The current state of the client. This is the string that was +/// returned as the "state" argument in the "Foo/get" response. The +/// server will return the changes that have occurred since this +/// state. +/// +/// - maxChanges: "UnsignedInt|null" +/// The maximum number of ids to return in the response. The server +/// MAY choose to return fewer than this value but MUST NOT return +/// more. If not given by the client, the server may choose how many +/// to return. If supplied by the client, the value MUST be a +/// positive integer greater than 0. If a value outside of this range +/// is given, the server MUST re +/// +#[derive(Deserialize, Serialize, Debug)] +#[serde(rename_all = "camelCase")] +/* ch-ch-ch-ch-ch-Changes */ +pub struct Changes +where + OBJ: std::fmt::Debug + Serialize, +{ + pub account_id: Id, + pub since_state: State, + #[serde(skip_serializing_if = "Option::is_none")] + pub max_changes: Option, + #[serde(skip)] + _ph: PhantomData OBJ>, +} + +impl Changes +where + OBJ: std::fmt::Debug + Serialize, +{ + pub fn new() -> Self { + Self { + account_id: Id::new(), + since_state: State::new(), + max_changes: None, + _ph: PhantomData, + } + } + _impl!( + /// - accountId: "Id" + /// + /// The id of the account to use. + /// + account_id: Id + ); + _impl!( + /// - since_state: "String" + /// The current state of the client. This is the string that was + /// returned as the "state" argument in the "Foo/get" response. The + /// server will return the changes that have occurred since this + /// state. + /// + /// + since_state: State + ); + _impl!( + /// - max_changes: "UnsignedInt|null" + /// The maximum number of ids to return in the response. The server + /// MAY choose to return fewer than this value but MUST NOT return + /// more. If not given by the client, the server may choose how many + /// to return. If supplied by the client, the value MUST be a + /// positive integer greater than 0. If a value outside of this range + /// is given, the server MUST re + max_changes: Option + ); +} + +#[derive(Serialize, Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct ChangesResponse { + pub account_id: Id, + pub old_state: State, + pub new_state: State, + pub has_more_changes: bool, + pub created: Vec>, + pub updated: Vec>, + pub destroyed: Vec>, + #[serde(skip)] + pub _ph: PhantomData OBJ>, +} + +impl std::convert::TryFrom<&RawValue> for ChangesResponse { + type Error = serde_json::error::Error; + fn try_from(t: &RawValue) -> Result, serde_json::error::Error> { + let res: (String, ChangesResponse, String) = serde_json::from_str(t.get())?; + assert_eq!(&res.0, &format!("{}/changes", OBJ::NAME)); + Ok(res.1) + } +} + +impl ChangesResponse { + _impl!(get_mut account_id_mut, account_id: Id); + _impl!(get_mut old_state_mut, old_state: State); + _impl!(get_mut new_state_mut, new_state: State); + _impl!(get has_more_changes, has_more_changes: bool); + _impl!(get_mut created_mut, created: Vec>); + _impl!(get_mut updated_mut, updated: Vec>); + _impl!(get_mut destroyed_mut, destroyed: Vec>); +} + +///#`set` +/// +///Modifying the state of Foo objects on the server is done via the +///"Foo/set" method. This encompasses creating, updating, and +///destroying Foo records. This allows the server to sort out ordering +///and dependencies that may exist if doing multiple operations at once +///(for example, to ensure there is always a minimum number of a certain +///record type). +#[derive(Deserialize, Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct Set +where + OBJ: std::fmt::Debug + Serialize, +{ + ///o accountId: "Id" + /// + /// The id of the account to use. + pub account_id: Id, + ///o ifInState: "String|null" + /// + /// This is a state string as returned by the "Foo/get" method + /// (representing the state of all objects of this type in the + /// account). If supplied, the string must match the current state; + /// otherwise, the method will be aborted and a "stateMismatch" error + /// returned. If null, any changes will be applied to the current + /// state. + pub if_in_state: Option>, + ///o create: "Id[Foo]|null" + /// + /// A map of a *creation id* (a temporary id set by the client) to Foo + /// objects, or null if no objects are to be created. + /// + /// The Foo object type definition may define default values for + /// properties. Any such property may be omitted by the client. + /// + /// The client MUST omit any properties that may only be set by the + /// server (for example, the "id" property on most object types). + /// + pub create: Option, OBJ>>, + ///o update: "Id[PatchObject]|null" + /// + /// A map of an id to a Patch object to apply to the current Foo + /// object with that id, or null if no objects are to be updated. + /// + /// A *PatchObject* is of type "String[*]" and represents an unordered + /// set of patches. The keys are a path in JSON Pointer format + /// [RFC6901], with an implicit leading "/" (i.e., prefix each key + /// with "/" before applying the JSON Pointer evaluation algorithm). + /// + /// All paths MUST also conform to the following restrictions; if + /// there is any violation, the update MUST be rejected with an + /// "invalidPatch" error: + /// * The pointer MUST NOT reference inside an array (i.e., you MUST + /// NOT insert/delete from an array; the array MUST be replaced in + /// its entirety instead). + /// + /// * All parts prior to the last (i.e., the value after the final + /// slash) MUST already exist on the object being patched. + /// + /// * There MUST NOT be two patches in the PatchObject where the + /// pointer of one is the prefix of the pointer of the other, e.g., + /// "alerts/1/offset" and "alerts". + /// + /// The value associated with each pointer determines how to apply + /// that patch: + /// + /// * If null, set to the default value if specified for this + /// property; otherwise, remove the property from the patched + /// object. If the key is not present in the parent, this a no-op. + /// + /// * Anything else: The value to set for this property (this may be + /// a replacement or addition to the object being patched). + /// + /// Any server-set properties MAY be included in the patch if their + /// value is identical to the current server value (before applying + /// the patches to the object). Otherwise, the update MUST be + /// rejected with an "invalidProperties" SetError. + /// + /// This patch definition is designed such that an entire Foo object + /// is also a valid PatchObject. The client may choose to optimise + /// network usage by just sending the diff or may send the whole + /// object; the server processes it the same either way. + pub update: Option, Value>>, + ///o destroy: "Id[]|null" + /// + /// A list of ids for Foo objects to permanently delete, or null if no + /// objects are to be destroyed. + pub destroy: Option>>, +} + +impl Set +where + OBJ: std::fmt::Debug + Serialize, +{ + pub fn new() -> Self { + Self { + account_id: Id::new(), + if_in_state: None, + create: None, + update: None, + destroy: None, + } + } + _impl!(account_id: Id); + _impl!( + ///o ifInState: "String|null" + /// + /// This is a state string as returned by the "Foo/get" method + /// (representing the state of all objects of this type in the + /// account). If supplied, the string must match the current state; + /// otherwise, the method will be aborted and a "stateMismatch" error + /// returned. If null, any changes will be applied to the current + /// state. + if_in_state: Option> + ); + _impl!(update: Option, Value>>); +} + +#[derive(Serialize, Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct SetResponse { + ///o accountId: "Id" + /// + /// The id of the account used for the call. + pub account_id: Id, + ///o oldState: "String|null" + /// + /// The state string that would have been returned by "Foo/get" before + /// making the requested changes, or null if the server doesn't know + /// what the previous state string was. + pub old_state: State, + ///o newState: "String" + /// + /// The state string that will now be returned by "Foo/get". + pub new_state: State, + ///o created: "Id[Foo]|null" + /// + /// A map of the creation id to an object containing any properties of + /// the created Foo object that were not sent by the client. This + /// includes all server-set properties (such as the "id" in most + /// object types) and any properties that were omitted by the client + /// and thus set to a default by the server. + /// + /// This argument is null if no Foo objects were successfully created. + pub created: Option, OBJ>>, + ///o updated: "Id[Foo|null]|null" + /// + /// The keys in this map are the ids of all Foos that were + /// successfully updated. + /// + /// The value for each id is a Foo object containing any property that + /// changed in a way *not* explicitly requested by the PatchObject + /// sent to the server, or null if none. This lets the client know of + /// any changes to server-set or computed properties. + /// + /// This argument is null if no Foo objects were successfully updated. + pub updated: Option, Option>>, + ///o destroyed: "Id[]|null" + /// + /// A list of Foo ids for records that were successfully destroyed, or + /// null if none. + pub destroyed: Option>>, + ///o notCreated: "Id[SetError]|null" + /// + /// A map of the creation id to a SetError object for each record that + /// failed to be created, or null if all successful. + pub not_created: Option>, + ///o notUpdated: "Id[SetError]|null" + /// + /// A map of the Foo id to a SetError object for each record that + /// failed to be updated, or null if all successful. + pub not_updated: Option>, + ///o notDestroyed: "Id[SetError]|null" + /// + /// A map of the Foo id to a SetError object for each record that + /// failed to be destroyed, or null if all successful.// + pub not_destroyed: Option>, +} + +impl std::convert::TryFrom<&RawValue> for SetResponse { + type Error = serde_json::error::Error; + fn try_from(t: &RawValue) -> Result, serde_json::error::Error> { + let res: (String, SetResponse, String) = serde_json::from_str(t.get())?; + assert_eq!(&res.0, &format!("{}/set", OBJ::NAME)); + Ok(res.1) + } +} + +#[derive(Deserialize, Serialize, Debug)] +#[serde(rename_all = "camelCase")] +#[serde(tag = "type", content = "description")] +pub enum SetError { + ///(create; update; destroy). The create/update/destroy would violate an ACL or other permissions policy. + Forbidden(Option), + ///(create; update). The create would exceed a server- defined limit on the number or total size of objects of this type. + OverQuota(Option), + + ///(create; update). The create/update would result in an object that exceeds a server-defined limit for the maximum size of a single object of this type. + TooLarge(Option), + + ///(create). Too many objects of this type have been created recently, and a server-defined rate limit has been reached. It may work if tried again later. + RateLimit(Option), + + ///(update; destroy). The id given to update/destroy cannot be found. + NotFound(Option), + + ///(update). The PatchObject given to update the record was not a valid patch (see the patch description). + InvalidPatch(Option), + + ///(update). The client requested that an object be both updated and destroyed in the same /set request, and the server has decided to therefore ignore the update. + WillDestroy(Option), + ///(create; update). The record given is invalid in some way. + InvalidProperties { + description: Option, + properties: Vec, + }, + ///(create; destroy). This is a singleton type, so you cannot create another one or destroy the existing one. + Singleton(Option), + RequestTooLarge(Option), + StateMismatch(Option), +} + +impl core::fmt::Display for SetError { + fn fmt(&self, fmt: &mut core::fmt::Formatter) -> core::fmt::Result { + use SetError::*; + match self { + Forbidden(Some(description)) => write!(fmt, "Forbidden: {}", description), + Forbidden(None) => write!(fmt, "Forbidden"), + OverQuota(Some(description)) => write!(fmt, "OverQuota: {}", description), + OverQuota(None) => write!(fmt, "OverQuota"), + TooLarge(Some(description)) => write!(fmt, "TooLarge: {}", description), + TooLarge(None) => write!(fmt, "TooLarge"), + RateLimit(Some(description)) => write!(fmt, "RateLimit: {}", description), + RateLimit(None) => write!(fmt, "RateLimit"), + NotFound(Some(description)) => write!(fmt, "NotFound: {}", description), + NotFound(None) => write!(fmt, "NotFound"), + InvalidPatch(Some(description)) => write!(fmt, "InvalidPatch: {}", description), + InvalidPatch(None) => write!(fmt, "InvalidPatch"), + WillDestroy(Some(description)) => write!(fmt, "WillDestroy: {}", description), + WillDestroy(None) => write!(fmt, "WillDestroy"), + InvalidProperties { + description: Some(description), + properties, + } => write!( + fmt, + "InvalidProperties: {}, {}", + description, + properties.join(",") + ), + InvalidProperties { + description: None, + properties, + } => write!(fmt, "InvalidProperties: {}", properties.join(",")), + Singleton(Some(description)) => write!(fmt, "Singleton: {}", description), + Singleton(None) => write!(fmt, "Singleton"), + RequestTooLarge(Some(description)) => write!(fmt, "RequestTooLarge: {}", description), + RequestTooLarge(None) => write!(fmt, "RequestTooLarge"), + StateMismatch(Some(description)) => write!(fmt, "StateMismatch: {}", description), + StateMismatch(None) => write!(fmt, "StateMismatch"), + } + } +} + +pub fn download_request_format( + download_url: &str, + account_id: &Id, + blob_id: &Id, + name: Option, +) -> String { + // https://jmap.fastmail.com/download/{accountId}/{blobId}/{name} + let mut ret = String::with_capacity( + download_url.len() + + blob_id.len() + + name.as_ref().map(|n| n.len()).unwrap_or(0) + + account_id.len(), + ); + let mut prev_pos = 0; + + while let Some(pos) = bytes_find(&download_url.as_bytes()[prev_pos..], b"{") { + ret.push_str(&download_url[prev_pos..prev_pos + pos]); + prev_pos += pos; + if download_url[prev_pos..].starts_with("{accountId}") { + ret.push_str(account_id.as_str()); + prev_pos += "{accountId}".len(); + } else if download_url[prev_pos..].starts_with("{blobId}") { + ret.push_str(blob_id.as_str()); + prev_pos += "{blobId}".len(); + } else if download_url[prev_pos..].starts_with("{name}") { + ret.push_str(name.as_deref().unwrap_or("")); + prev_pos += "{name}".len(); + } + } + if prev_pos != download_url.len() { + ret.push_str(&download_url[prev_pos..]); + } + ret +} + +pub fn upload_request_format(upload_url: &str, account_id: &Id) -> String { + //"uploadUrl": "https://jmap.fastmail.com/upload/{accountId}/", + let mut ret = String::with_capacity(upload_url.len() + account_id.len()); + let mut prev_pos = 0; + + while let Some(pos) = bytes_find(&upload_url.as_bytes()[prev_pos..], b"{") { + ret.push_str(&upload_url[prev_pos..prev_pos + pos]); + prev_pos += pos; + if upload_url[prev_pos..].starts_with("{accountId}") { + ret.push_str(account_id.as_str()); + prev_pos += "{accountId}".len(); + break; + } else { + ret.push('{'); + prev_pos += 1; + } + } + if prev_pos != upload_url.len() { + ret.push_str(&upload_url[prev_pos..]); + } + ret +} + +#[derive(Serialize, Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct UploadResponse { + ///o accountId: "Id" + /// + /// The id of the account used for the call. + pub account_id: Id, + ///o blobId: "Id" + /// + ///The id representing the binary data uploaded. The data for this id is immutable. + ///The id *only* refers to the binary data, not any metadata. + pub blob_id: Id, + ///o type: "String" + /// + ///The media type of the file (as specified in [RFC6838], + ///Section 4.2) as set in the Content-Type header of the upload HTTP + ///request. + + #[serde(rename = "type")] + pub _type: String, + + ///o size: "UnsignedInt" + /// + /// The size of the file in octets. + pub size: usize, +} + +/// #`queryChanges` +/// +/// The "Foo/queryChanges" method allows a client to efficiently update +/// the state of a cached query to match the new state on the server. It +/// takes the following arguments: +#[derive(Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct QueryChanges, OBJ: Object> +where + OBJ: std::fmt::Debug + Serialize, +{ + pub account_id: Id, + pub filter: Option, + pub sort: Option>, + ///sinceQueryState: "String" + /// + ///The current state of the query in the client. This is the string + ///that was returned as the "queryState" argument in the "Foo/query" + ///response with the same sort/filter. The server will return the + ///changes made to the query since this state. + pub since_query_state: String, + ///o maxChanges: "UnsignedInt|null" + /// + ///The maximum number of changes to return in the response. See + ///error descriptions below for more details. + pub max_changes: Option, + ///o upToId: "Id|null" + /// + ///The last (highest-index) id the client currently has cached from + ///the query results. When there are a large number of results, in a + ///common case, the client may have only downloaded and cached a + ///small subset from the beginning of the results. If the sort and + ///filter are both only on immutable properties, this allows the + ///server to omit changes after this point in the results, which can + ///significantly increase efficiency. If they are not immutable, + ///this argument is ignored. + pub up_to_id: Option>, + + ///o calculateTotal: "Boolean" (default: false) + /// + ///Does the client wish to know the total number of results now in + ///the query? This may be slow and expensive for servers to + ///calculate, particularly with complex filters, so clients should + ///take care to only request the total when needed. + #[serde(default = "bool_false")] + pub calculate_total: bool, + + #[serde(skip)] + _ph: PhantomData OBJ>, +} + +impl, OBJ: Object> QueryChanges +where + OBJ: std::fmt::Debug + Serialize, +{ + pub fn new(account_id: Id, since_query_state: String) -> Self { + Self { + account_id, + filter: None, + sort: None, + since_query_state, + max_changes: None, + up_to_id: None, + calculate_total: false, + _ph: PhantomData, + } + } + _impl!(filter: Option); + _impl!(sort: Option>); + _impl!(max_changes: Option); + _impl!(up_to_id: Option>); + _impl!(calculate_total: bool); +} + +#[derive(Serialize, Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct QueryChangesResponse { + /// The id of the account used for the call. + pub account_id: Id, + /// This is the "sinceQueryState" argument echoed back; that is, the state from which the server is returning changes. + pub old_query_state: String, + ///This is the state the query will be in after applying the set of changes to the old state. + pub new_query_state: String, + /// The total number of Foos in the results (given the "filter"). This argument MUST be omitted if the "calculateTotal" request argument is not true. + #[serde(default)] + pub total: Option, + ///The "id" for every Foo that was in the query results in the old + ///state and that is not in the results in the new state. + + ///If the server cannot calculate this exactly, the server MAY return + ///the ids of extra Foos in addition that may have been in the old + ///results but are not in the new results. + + ///If the sort and filter are both only on immutable properties and + ///an "upToId" is supplied and exists in the results, any ids that + ///were removed but have a higher index than "upToId" SHOULD be + ///omitted. + + ///If the "filter" or "sort" includes a mutable property, the server + ///MUST include all Foos in the current results for which this + ///property may have changed. The position of these may have moved + ///in the results, so they must be reinserted by the client to ensure + ///its query cache is correct. + pub removed: Vec>, + ///The id and index in the query results (in the new state) for every + ///Foo that has been added to the results since the old state AND + ///every Foo in the current results that was included in the + ///"removed" array (due to a filter or sort based upon a mutable + ///property). + + ///If the sort and filter are both only on immutable properties and + ///an "upToId" is supplied and exists in the results, any ids that + ///were added but have a higher index than "upToId" SHOULD be + ///omitted. + + ///The array MUST be sorted in order of index, with the lowest index + ///first. + + ///An *AddedItem* object has the following properties: + + ///* id: "Id" + + ///* index: "UnsignedInt" + + ///The result of this is that if the client has a cached sparse array of + ///Foo ids corresponding to the results in the old state, then: + + ///fooIds = [ "id1", "id2", null, null, "id3", "id4", null, null, null ] + + ///If it *splices out* all ids in the removed array that it has in its + ///cached results, then: + + /// removed = [ "id2", "id31", ... ]; + /// fooIds => [ "id1", null, null, "id3", "id4", null, null, null ] + + ///and *splices in* (one by one in order, starting with the lowest + ///index) all of the ids in the added array: + + ///added = [{ id: "id5", index: 0, ... }]; + ///fooIds => [ "id5", "id1", null, null, "id3", "id4", null, null, null ] + + ///and *truncates* or *extends* to the new total length, then the + ///results will now be in the new state. + + ///Note: splicing in adds the item at the given index, incrementing the + ///index of all items previously at that or a higher index. Splicing + ///out is the inverse, removing the item and decrementing the index of + ///every item after it in the array. + pub added: Vec>, +} + +#[derive(Serialize, Deserialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct AddedItem { + pub id: Id, + pub index: usize, +} diff --git a/src/rfc8620/argument.rs b/src/rfc8620/argument.rs new file mode 100644 index 0000000..283f89d --- /dev/null +++ b/src/rfc8620/argument.rs @@ -0,0 +1,53 @@ +/* + * libjmap + * + * Copyright 2019 Manos Pitsidianakis + * + * This file is part of libjmap. + * + * libjmap 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. + * + * libjmap 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 libjmap. If not, see . + */ + +use crate::protocol::Method; +use crate::rfc8620::Object; +use crate::rfc8620::ResultField; + +#[derive(Deserialize, Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub enum JmapArgument { + Value(T), + ResultReference { + result_of: String, + name: String, + path: String, + }, +} + +impl JmapArgument { + pub fn value(v: T) -> Self { + JmapArgument::Value(v) + } + + pub fn reference(result_of: usize, path: ResultField) -> Self + where + M: Method, + OBJ: Object, + { + JmapArgument::ResultReference { + result_of: format!("m{}", result_of), + name: M::NAME.to_string(), + path: path.field.to_string(), + } + } +} diff --git a/src/rfc8620/comparator.rs b/src/rfc8620/comparator.rs new file mode 100644 index 0000000..929076f --- /dev/null +++ b/src/rfc8620/comparator.rs @@ -0,0 +1,53 @@ +/* + * libjmap + * + * Copyright 2019 Manos Pitsidianakis + * + * This file is part of libjmap. + * + * libjmap 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. + * + * libjmap 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 libjmap. If not, see . + */ + +use super::*; + +#[derive(Serialize, Debug)] +#[serde(rename_all = "camelCase")] +pub struct Comparator { + property: String, + #[serde(default = "bool_true")] + is_ascending: bool, + //FIXME + collation: Option, + //#[serde(flatten)] + additional_properties: Vec, + + _ph: PhantomData OBJ>, +} + +impl Comparator { + pub fn new() -> Self { + Self { + property: String::new(), + is_ascending: true, + collation: None, + additional_properties: Vec::new(), + _ph: PhantomData, + } + } + + _impl!(property: String); + _impl!(is_ascending: bool); + _impl!(collation: Option); + _impl!(additional_properties: Vec); +} diff --git a/src/rfc8620/filters.rs b/src/rfc8620/filters.rs new file mode 100644 index 0000000..0580dd0 --- /dev/null +++ b/src/rfc8620/filters.rs @@ -0,0 +1,139 @@ +/* + * libjmap + * + * Copyright 2019 Manos Pitsidianakis + * + * This file is part of libjmap. + * + * libjmap 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. + * + * libjmap 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 libjmap. If not, see . + */ + +use super::*; + +pub trait FilterTrait: Default {} +#[derive(Serialize, Debug)] +#[serde(rename_all = "camelCase")] +#[serde(untagged)] +pub enum Filter, OBJ: Object> { + Operator { + operator: FilterOperator, + conditions: Vec>, + }, + Condition(FilterCondition), +} + +impl, OBJ: Object> FilterTrait for Filter {} +impl, OBJ: Object> FilterTrait for FilterCondition {} + +#[derive(Serialize, Debug)] +pub struct FilterCondition, OBJ: Object> { + #[serde(flatten)] + pub cond: F, + #[serde(skip)] + pub _ph: PhantomData OBJ>, +} + +#[derive(Serialize, Debug, PartialEq)] +#[serde(rename_all = "UPPERCASE")] +pub enum FilterOperator { + And, + Or, + Not, +} + +impl, OBJ: Object> FilterCondition { + pub fn new() -> Self { + FilterCondition { + cond: F::default(), + _ph: PhantomData, + } + } +} + +impl, OBJ: Object> Default for FilterCondition { + fn default() -> Self { + Self::new() + } +} + +impl, OBJ: Object> Default for Filter { + fn default() -> Self { + Filter::Condition(FilterCondition::default()) + } +} + +use std::ops::{BitAndAssign, BitOrAssign, Not}; + +impl, OBJ: Object> BitAndAssign for Filter { + fn bitand_assign(&mut self, rhs: Self) { + match self { + Filter::Operator { + operator: FilterOperator::And, + ref mut conditions, + } => { + conditions.push(rhs); + } + Filter::Condition(_) | Filter::Operator { .. } => { + *self = Filter::Operator { + operator: FilterOperator::And, + conditions: vec![ + std::mem::replace(self, Filter::Condition(FilterCondition::new())), + rhs, + ], + }; + } + } + } +} + +impl, OBJ: Object> BitOrAssign for Filter { + fn bitor_assign(&mut self, rhs: Self) { + match self { + Filter::Operator { + operator: FilterOperator::Or, + ref mut conditions, + } => { + conditions.push(rhs); + } + Filter::Condition(_) | Filter::Operator { .. } => { + *self = Filter::Operator { + operator: FilterOperator::Or, + conditions: vec![ + std::mem::replace(self, Filter::Condition(FilterCondition::new())), + rhs, + ], + }; + } + } + } +} + +impl, OBJ: Object> Not for Filter { + type Output = Self; + fn not(self) -> Self { + match self { + Filter::Operator { + operator, + conditions, + } if operator == FilterOperator::Not => Filter::Operator { + operator: FilterOperator::Or, + conditions, + }, + Filter::Condition(_) | Filter::Operator { .. } => Filter::Operator { + operator: FilterOperator::Not, + conditions: vec![self], + }, + } + } +}