diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,9 @@ +# 1.0.0.2 +- add version bounds on deps +- add changelog + +# 1.0.0.1 +- add more package metadata + +# 1.0.0.0 +- initial stable release diff --git a/LICENSE.agpl b/LICENSE.agpl new file mode 100644 --- /dev/null +++ b/LICENSE.agpl @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +# signal-messaging-dbus +Library for connecting a haskell program to a [signal-cli](https://github.com/AsamK/signal-cli)-instance running in daemon mode, using its DBus interface. + +Support exists for almost the whole api, which should be sufficient for your bot-writing needs. + +The library is fully documented with haddock, and mostly tested. +You can either build the documentation yourself with `stack haddock --open signal-messaging-dbus`, or look at it on hackage. +For an a small code example, see `example/Main.hs`. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/example/Main.hs b/example/Main.hs new file mode 100644 --- /dev/null +++ b/example/Main.hs @@ -0,0 +1,30 @@ +{-# LANGUAGE LambdaCase #-} + +module Main (main) where + +import Control.Monad (forever, when) +import SignalDBus + +reactWithSkull :: Timestamp -> String -> Maybe Group -> SignalConn -> IO Timestamp +reactWithSkull ts n mayG sc = + case mayG of + Nothing -> sendMessageReaction "💀" False n ts n sc + Just g -> sendGroupMessageReaction "💀" False n ts g sc + +-- react with 💀 to every message received by a specific user +main :: IO () +main = do + let targetNumber = "[insert phone number with country code]" + + withConn $ \sc -> do + myNumber <- getSelfNumber sc + putStrLn $ "Running on: " ++ show myNumber + + withReceiveMessages sc $ \getMsg -> forever $ do + getMsg >>= \case + Message ts n g _ _ -> when (n == targetNumber) $ do + reactWithSkull ts targetNumber g sc + return () + _ -> return () + + return () diff --git a/signal-messaging-dbus.cabal b/signal-messaging-dbus.cabal new file mode 100644 --- /dev/null +++ b/signal-messaging-dbus.cabal @@ -0,0 +1,57 @@ +cabal-version: 1.12 + +-- This file has been generated from package.yaml by hpack version 0.35.0. +-- +-- see: https://github.com/sol/hpack + +name: signal-messaging-dbus +version: 1.0.0.2 +synopsis: Bindings for signal-cli's DBus interface +description: This library aims provides a way to interact programmatically with the private messenger signal . To use this, you need an instance of [signal-cli] (https://github.com/AsamK/signal-cli) running in daemon mode, with the DBus interface enabled. Support exists for almost the whole api, which should be sufficient for your bot-writing needs. +category: web +homepage: https://codeberg.org/lialenck/signal-messaging-dbus +author: Lia Lenckowski +maintainer: lialenck@protonmail.com +copyright: 2022 Lia Lenckowski +license: AGPL +license-file: LICENSE.agpl +build-type: Simple +extra-source-files: + README.md + CHANGELOG.md + +source-repository head + type: git + location: https://codeberg.org/lialenck/signal-messaging-dbus.git + +library + exposed-modules: + SignalDBus + SignalDBus.Interface + SignalDBus.Types + other-modules: + Paths_signal_messaging_dbus + hs-source-dirs: + src + ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints -Wno-type-defaults -Wno-unused-do-bind + build-depends: + base >=4.7 && <5 + , bytestring <0.12 + , dbus >=1.2.12 && <1.3 + , unliftio ==0.2.* + default-language: Haskell2010 + +executable signal-dbus-example + main-is: Main.hs + other-modules: + Paths_signal_messaging_dbus + hs-source-dirs: + example + ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints -Wno-type-defaults -Wno-unused-do-bind -threaded -rtsopts -with-rtsopts=-N + build-depends: + base >=4.7 && <5 + , bytestring <0.12 + , dbus >=1.2.12 && <1.3 + , signal-messaging-dbus + , unliftio ==0.2.* + default-language: Haskell2010 diff --git a/src/SignalDBus.hs b/src/SignalDBus.hs new file mode 100644 --- /dev/null +++ b/src/SignalDBus.hs @@ -0,0 +1,579 @@ +{-# LANGUAGE OverloadedStrings #-} + +{-| +Module: SignalDBus +Description: Bindings for the DBus interface of signal-cli +Copyright: (c) Lia Lenckowski, 2022 +License: AGPL +Maintainer: lialenck@protonmail.com +Stability: stable +Portability: GNU/Linux, MacOS + +This module is the main entry point for this library. + +To get started, install and set up [signal-cli](https://github.com/asamk/signal-cli), +and make sure it's running in daemon mode, with the dbus interface enabled. Then, as +an example, you could use the following code to react with "💀" to every message +received from a specific user either via PM or in groups you're a member of: + +> import Control.Monad (forever, when) +> import SignalDBus +> +> reactWithSkull :: Timestamp -> String -> Maybe Group -> SignalConn -> IO Timestamp +> reactWithSkull ts n mayG sc = +> case mayG of +> Nothing -> sendMessageReaction "💀" False n ts n sc +> Just g -> sendGroupMessageReaction "💀" False n ts g sc +> +> -- react with 💀 to every message received by a specific user +> main :: IO () +> main = do +> let num = "[insert phone number with country code]" +> withConn $ \sc -> do +> n <- getSelfNumber sc +> putStrLn $ "Running on: " ++ show n +> withReceiveMessages sc $ \getMsg -> forever $ do +> getMsg >>= \case +> Receipt _ _ -> return () +> SyncMessage _ _ _ _ _ -> return () +> Message ts n g _ _ -> when (n == num) $ do +> reactWithSkull ts num g sc +> return () +> +> return () + +All of the functions exported may fail with a 'DBus.Client.ClientError' if something +goes wrong. None of the functions should throw any other exception. + +Quite a few of these functions have a scary-looking \"UNTESTED\" in their documentation. +If you end up using any of those, and they work, please tell me so I can remove that +disclaimer. + +This package aims to provide somewhat direct bindings for all methods described by +. In cases +where methods are overloaded, this library almost always chooses to implement the more +general ones. Some functionality of the dbus interface of signal-cli isn't implemented, +as it's either not documented or not often useful; if you require any of that, I'd +recommend looking at SignalDBus.Interface. +-} + +module SignalDBus ( + -- * Opening connections + SignalDBus.Interface.withConn, + SignalDBus.Interface.withConnNum, + + -- * Receiving Messages + SignalDBus.Interface.withReceiveMessages, + + -- * Control interface + -- $control + link, + listAccounts, + register, + registerWithCaptcha, + verify, + verifyWithPin, + + -- * Account interface + -- $signal + getContactName, + getContactNumber, + getSelfNumber, + isContactBlocked, + isRegistered, + listNumbers, + removePin, + sendEndSessionMessage, + sendMessage, + sendMessageReaction, + sendNoteToSelfMessage, + sendReadReceipt, + sendViewedReceipt, + sendRemoteDeleteMessage, + sendTyping, + setContactBlocked, + setContactName, + deleteContact, + deleteRecipient, + setExpirationTimer, + setPin, + submitRateLimitChallenge, + updateProfile, + uploadStickerPack, + version, + createGroup, + getGroup, + joinGroup, + listGroups, + sendGroupMessage, + sendGroupTyping, + sendGroupMessageReaction, + sendGroupRemoteDeleteMessage, + addDevice, + getDevice, + listDevices, + + -- * Group interface + getGroupId, + getGroupName, + getGroupDescription, + getGroupIsBlocked, + getGroupIsAdmin, + getGroupMessageExpirationTimer, + getGroupMembers, + getGroupPendingMembers, + getGroupRequestingMembers, + getGroupAdmins, + getGroupPermissionAddMember, + getGroupPermissionEditDetails, + getGroupPermissionSendMessage, + -- could've been 'getGroupGroupInviteLink' for consistency, but eww. + getGroupInviteLink, + + setGroupName, + setGroupDescription, + setGroupAvatar, + setGroupIsBlocked, + setGroupMessageExpirationTimer, + setGroupPermissionAddMember, + setGroupPermissionEditDetails, + setGroupPermissionSendMessage, + + groupAddAdmins, + groupAddMembers, + groupDisableLink, + groupEnableLink, + groupQuit, + groupRemoveAdmins, + groupRemoveMembers, + groupResetLink, + + -- TODO: * Device interface + + -- * Types + SignalDBus.Types.SignalConn, + SignalDBus.Types.Timestamp, + SignalDBus.Types.Device, + SignalDBus.Types.Group, + SignalDBus.Types.ReceivedMessage(..), +) where + +import Data.ByteString (ByteString) +import Data.Int (Int32, Int64) +import DBus.Internal.Types (toVariant, ObjectPath(..)) +import SignalDBus.Interface +import SignalDBus.Types +import UnliftIO (MonadIO) + +-- $control +-- +-- These methods are only available if the signal-cli daemon was started in +-- multi-account mode. + +-- |UNTESTED. Link this as a new device, identified by the given string. +link :: MonadIO m => String -> SignalConn -> m String +link name = callControl "link" [toVariant name] + +-- |List accounts attached to this signal-cli instance +listAccounts :: MonadIO m => SignalConn -> m [String] +listAccounts sc = do + obs <- callControl "listAccounts" [] sc + return $! flip map obs $ \(ObjectPath s) + -> '+' : drop (length ("/org/asamk/Signal/_" :: String)) s + +-- |UNTESTED. Register this as the primary device for the given number. Set the +-- second argument to 'True' to request voice verification instead of SMS verification. +register :: MonadIO m => String -> Bool -> SignalConn -> m () +register name b = callControl_ "register" [toVariant name, toVariant b] + +-- |UNTESTED. Same as 'register', but include a Captcha string. +registerWithCaptcha :: MonadIO m => String -> Bool -> String -> SignalConn -> m () +registerWithCaptcha name b c = callControl_ "registerWithCaptcha" + $ [toVariant name, toVariant b, toVariant c] + +-- | UNTESTED. Verify your phone number after requesting registration via 'register' +-- or 'registerWithCaptcha' +verify :: MonadIO m + => String -- ^ Phone number + -> String -- ^ Verification code + -> SignalConn -- ^ Connection object + -> m () +verify n c = callControl_ "verify" [toVariant n, toVariant c] + +-- | UNTESTED. Same as 'verify', but include a registration pin for protected accounts +verifyWithPin :: MonadIO m + => String -- ^ Phone number + -> String -- ^ Verification code + -> String -- ^ Pin + -> SignalConn -- ^ Connection object + -> m () +verifyWithPin n c p = callControl_ "verifyWithPin" + $ [toVariant n, toVariant c, toVariant p] + +-- $signal +-- +-- These methods may only be called on a connection object that knows which account to +-- use; that is, either the signal daemon has a default account, and you've used +-- 'withConn', or it doesn't, and you've used 'withConnNum'. + +-- |Takes a number, and returns the name of the contact, empty if unknown +getContactName :: MonadIO m => String -> SignalConn -> m String +getContactName n = callSC "getContactName" [toVariant n] + +-- |Takes a contact name, and returns known numbers, both as strings +getContactNumber :: MonadIO m => String -> SignalConn -> m [String] +getContactNumber name = callSC "getContactNumber" [toVariant name] + +-- |Returns your own number +getSelfNumber :: MonadIO m => SignalConn -> m String +getSelfNumber = callSC "getSelfNumber" [] + +-- |Returns true if you blocked this number +isContactBlocked :: MonadIO m => String -> SignalConn -> m Bool +isContactBlocked number = callSC "isContactBlocked" [toVariant number] + +-- |For each given number, returns whether that user is registered on Signal +isRegistered :: MonadIO m => [String] -> SignalConn -> m [Bool] +isRegistered nums = callSC "isRegistered" [toVariant nums] + +-- |List all known numbers (e.g. group members and senders of received messages) +listNumbers :: MonadIO m => SignalConn -> m [String] +listNumbers = callSC "listNumbers" [] + +-- |UNTESTED. Removes registration pin protection. +removePin :: MonadIO m => SignalConn -> m () +removePin = callSC_ "removePin" [] + +-- |UNTESTED. No idea what this accomplishes, so hmu if you know. It's implemented though +sendEndSessionMessage :: MonadIO m => SignalConn -> m () +sendEndSessionMessage = callSC_ "sendEndSessionMessage" [] + +-- |Sends a message, possibly with attachments, to a number of recipients +sendMessage :: MonadIO m + => String -- ^ Message content + -> [String] -- ^ Paths to attachments. Resolves using the working dir of the signal-cli daemon, not this process + -> [String] -- ^ Recipients + -> SignalConn -- ^ Connection object + -> m Timestamp -- ^ Timestamp of sent message +sendMessage m as rs = callSC "sendMessage" + [toVariant m, toVariant as, toVariant rs] + +-- |Reacts to a message +sendMessageReaction :: MonadIO m + => String -- ^ Unicode grapheme cluster. Only tested with "😂" + -> Bool -- ^ Whether to remove a previously sent reaction instead of adding one + -> String -- ^ Author of the message you want to react to + -> Timestamp -- ^ Timestamp of message to react to + -> String -- ^ Phone numbers of recipient + -> SignalConn -- ^ Connection object + -> m Timestamp -- ^ Timestamp of reaction +sendMessageReaction emoji rm n ts r = callSC "sendMessageReaction" + $ [toVariant emoji, toVariant rm, toVariant n, toVariant ts, toVariant r] + +-- |Sends a message to yourself +sendNoteToSelfMessage :: MonadIO m + => String -- ^ Message + -> [String] -- ^ Paths to attachments. Resolves using the working dir of the signal-cli daemon, not this process + -> SignalConn -- ^ Connection object + -> m Timestamp -- ^ Timestamp of sent message +sendNoteToSelfMessage m as = callSC "sendNoteToSelfMessage" + $ [toVariant m, toVariant as] + +-- |Sends read receipts for the messages with the specified timestamps to the given phone +-- number. These timestamps must belong to messages you received from that number. +sendReadReceipt :: MonadIO m => String -> [Timestamp] -> SignalConn -> m () +sendReadReceipt r ts = callSC_ "sendReadReceipt" [toVariant r, toVariant ts] + +-- |Sends viewed receipts for the messages with the specified timestamps to the given phone +-- number. This is probably not what you want; 'sendReadReceipt' seems to be the way to go. +sendViewedReceipt :: MonadIO m => String -> [Timestamp] -> SignalConn -> m () +sendViewedReceipt r ts = callSC_ "sendViewedReceipt" [toVariant r, toVariant ts] + +-- |Delete one of you own private messages; also deletes them remotely on supported +-- clients (Signal-desktop, Android/IOS apps, ...) +sendRemoteDeleteMessage :: MonadIO m + => Timestamp -- ^ Timestamp of message to delete + -> [String] -- ^ Recipients + -> SignalConn -- ^ Connection object + -> m Timestamp -- ^ Timestamp, can be used to identify corresponding replies +sendRemoteDeleteMessage ts rs = callSC "sendRemoteDeleteMessage" + $ [toVariant ts, toVariant rs] + +-- |Send updates about whether you're typing to the given number. +-- NOTE: the boolean argument should be False to indicate you're typing, and True to +-- clear the typing state +sendTyping :: MonadIO m => String -> Bool -> SignalConn -> m () +sendTyping n b = callSC_ "sendTyping" [toVariant n, toVariant b] + +-- |UNTESTED. Sets whether a contact is blocked. This is only done locally, so this just +-- disabled messages from that number from being forwarded via DBus. +setContactBlocked :: MonadIO m => String -> Bool -> SignalConn -> m () +setContactBlocked n b = callSC_ "setContactBlocked" [toVariant n, toVariant b] + +-- |Not implemented, as the documentation doesn't state the type of the name +-- (probably a String, but I dont feel like testing stuff rn) +setContactName :: a +setContactName = error "Not implemented due to documentation succ" + +-- |UNTESTED. Probably deletes a contact, given by a phone number, or something. +deleteContact :: MonadIO m => String -> SignalConn -> m () +deleteContact n = callSC_ "deleteContact" [toVariant n] + +-- |UNTESTED. Idk what this does, but tell me if you know/have used this. +deleteRecipient :: MonadIO m => String -> SignalConn -> m () +deleteRecipient n = callSC_ "deleteRecipient" [toVariant n] + +-- |Set seconds until messages to this recipient dissapear (on supported clients). Set to +-- 0 to disable. +setExpirationTimer :: (MonadIO m, Integral i) => String -> i -> SignalConn -> m () +setExpirationTimer n i = callSC_ "setExpirationTimer" + $ [toVariant n, toVariant (fromIntegral i :: Int32)] + +-- |UNTESTED. Set registration pin to prevent others from registering your number. +setPin :: MonadIO m => String -> SignalConn -> m () +setPin p = callSC_ "setPin" [toVariant p] + +-- |UNTESTED. Idk but seems to be useful for lifting rate limits +submitRateLimitChallenge :: MonadIO m => String -> String -> SignalConn -> m () +submitRateLimitChallenge ch cap = callSC_ "submitRateLimitChallenge" + $ [toVariant ch, toVariant cap] + +-- |Update parts of your profile. You can leave any string field empty to keep the old +-- value. +updateProfile :: MonadIO m + => String -- ^ Given name + -> String -- ^ Family name + -> String -- ^ About message + -> String -- ^ Emoji for profile + -> String -- ^ Avatar file name. Resolves using the working dir of the signal-cli daemon, not this process + -> Bool -- ^ True if the avatar should be removed + -> SignalConn -- ^ Connection object + -> m () +updateProfile gn fn ab em fp rm = callSC_ "updateProfile" + $ [toVariant gn, toVariant fn, toVariant ab, toVariant em, toVariant fp, toVariant rm] + +-- |UNTESTED. Uploads a sticker pack, given by the path to a manifest.json or zip file, +-- and return the URL of the pack. +uploadStickerPack :: MonadIO m => String -> SignalConn -> m String +uploadStickerPack fp = callSC "uploadStickerPack" [toVariant fp] + +-- |Return version string of signal-cli. This also works for multi-account connections. +version :: MonadIO m => SignalConn -> m String +version = callSC "version" [] + +-- |Create a group +createGroup :: MonadIO m + => String -- ^ Group name + -> [String] -- ^ Initial members + -> String -- ^ Avatar file name. Resolves using the working dir of the signal-cli daemon, not this process + -> SignalConn -- ^ Connection object + -> m Group -- ^ Group object +createGroup n ms f sc = do + gId <- callSC "createGroup" [toVariant n, toVariant ms, toVariant f] sc + getGroup gId sc + +-- |Get DBus object path for a group, given by its signal-internal binary identifier. +getGroup :: MonadIO m => ByteString -> SignalConn -> m Group +getGroup g = callSC "getGroup" [toVariant g] + +-- |UNTESTED. Join a group given by an invite link. Behaviour of this depends on +-- properties of the group; see "joinGroup" on +-- https://github.com/AsamK/signal-cli/blob/master/man/signal-cli-dbus.5.adoc +-- (latest commit while writing this: 34cc64f8ce97a63c859bd95faf6783422f14df61) +joinGroup :: MonadIO m => String -> SignalConn -> m () +joinGroup l = callSC_ "joinGroup" [toVariant l] + +-- |List known groups, represented as (group object, internal identifier, group name) +listGroups :: MonadIO m => SignalConn -> m [(Group, ByteString, String)] +listGroups = callSC "listGroups" [] + +-- |Sends a message, possibly with attachments, to a group +sendGroupMessage :: MonadIO m + => String -- ^ Message content + -> [String] -- ^ Paths to attachments. Resolves using the working dir of the signal-cli daemon, not this process + -> Group -- ^ Group in which to send a message + -> SignalConn -- ^ Connection object + -> m Timestamp -- ^ Timestamp of sent message +sendGroupMessage m as g sc = do + gId <- getGroupProp "Id" g sc + callSC "sendGroupMessage" + [toVariant m, toVariant as, toVariant (gId :: ByteString)] sc + +-- |Send updates about whether you're typing to the given group. +-- NOTE: the boolean argument should be False to indicate you're typing, and True to +-- clear the typing state +sendGroupTyping :: MonadIO m => Group -> Bool -> SignalConn -> m () +sendGroupTyping g b sc = do + gId <- getGroupId g sc + callSC_ "sendGroupTyping" [toVariant gId, toVariant b] sc + +-- |Reacts to a message +sendGroupMessageReaction :: MonadIO m + => String -- ^ Unicode grapheme cluster. Only tested with "😂" + -> Bool -- ^ Whether to remove a previously sent reaction instead of adding one + -> String -- ^ Author of the message you want to react to + -> Timestamp -- ^ Timestamp of message to react to + -> Group -- ^ Group in which to react + -> SignalConn -- ^ Connection object + -> m Timestamp -- ^ Timestamp of reaction +sendGroupMessageReaction emoji rm n ts g sc = do + gId <- getGroupId g sc + callSC "sendGroupMessageReaction" [toVariant emoji, toVariant rm, toVariant n, + toVariant ts, toVariant gId] sc + +-- |Delete one of you own group messages; also deletes them remotely on supported +-- clients (Signal-desktop, Android/IOS apps, ...) +sendGroupRemoteDeleteMessage :: MonadIO m + => Timestamp -- ^ Timestamp of message to delete + -> Group -- ^ Group in which to delete your message + -> SignalConn -- ^ Connection object + -> m Timestamp -- ^ Timestamp, can be used to identify corresponding replies +sendGroupRemoteDeleteMessage ts g sc = do + gId <- getGroupId g sc + callSC "sendGroupRemoteDeleteMessage" [toVariant ts, toVariant gId] sc + +-- |UNTESTED. Add a device that wants to link to this account using a link +addDevice :: MonadIO m => String -> SignalConn -> m () +addDevice l = callSC_ "addDevice" [toVariant l] + +-- |Get DBus object path for a device given by a device ID +getDevice :: MonadIO m => Int64 -> SignalConn -> m ObjectPath +getDevice d = callSC "getDevice" [toVariant d] + +-- |List devices linked with this account, represented as +-- (object path, device id, device name) +listDevices :: MonadIO m => SignalConn -> m [(ObjectPath, Int64, String)] +listDevices = callSC "listDevices" [] + +-- |Byte array representing the internal group identifier +getGroupId :: MonadIO m => Group -> SignalConn -> m ByteString +getGroupId = getGroupProp "Id" + +-- |Display name +getGroupName :: MonadIO m => Group -> SignalConn -> m String +getGroupName = getGroupProp "Name" + +-- |Description +getGroupDescription :: MonadIO m => Group -> SignalConn -> m String +getGroupDescription = getGroupProp "Description" + +-- |UNTESTED. If true, messages won't be forwarded via DBus +getGroupIsBlocked :: MonadIO m => Group -> SignalConn -> m Bool +getGroupIsBlocked = getGroupProp "IsBlocked" + +-- |Whether this account is a group admin +getGroupIsAdmin :: MonadIO m => Group -> SignalConn -> m Bool +getGroupIsAdmin = getGroupProp "IsAdmin" + +-- |Message expiration timer. 0 if disabled +getGroupMessageExpirationTimer :: MonadIO m => Group -> SignalConn -> m Int +getGroupMessageExpirationTimer g sc = do + i <- getGroupProp "MessageExpirationTimer" g sc + return $! fromIntegral (i :: Int32) + +-- |List of group members' phone numbers +getGroupMembers :: MonadIO m => Group -> SignalConn -> m [String] +getGroupMembers = getGroupProp "Members" + +-- |UNTESTED. List of pending group members; I don't know what this does, but I +-- imagine you're probably looking for 'getGroupRequestingMembers' +getGroupPendingMembers :: MonadIO m => Group -> SignalConn -> m [String] +getGroupPendingMembers = getGroupProp "PendingMembers" + +-- |List of phone numbers requesting to join the group, if theres an invite link set +-- to require admin approval +getGroupRequestingMembers :: MonadIO m => Group -> SignalConn -> m [String] +getGroupRequestingMembers = getGroupProp "RequestingMembers" + +-- |List of group admins' phone numbers +getGroupAdmins :: MonadIO m => Group -> SignalConn -> m [String] +getGroupAdmins = getGroupProp "Admins" + +-- |String representing who has permission to add members +-- (one of "ONLY_ADMINS", "EVERY_MEMBER") +getGroupPermissionAddMember :: MonadIO m => Group -> SignalConn -> m String +getGroupPermissionAddMember = getGroupProp "PermissionAddMember" + +-- |String representing who has permission to edit group description +-- (one of "ONLY_ADMINS", "EVERY_MEMBER") +getGroupPermissionEditDetails :: MonadIO m => Group -> SignalConn -> m String +getGroupPermissionEditDetails = getGroupProp "PermissionEditDetails" + +-- |String representing who has permission to send messages +-- (one of "ONLY_ADMINS", "EVERY_MEMBER") +getGroupPermissionSendMessage :: MonadIO m => Group -> SignalConn -> m String +getGroupPermissionSendMessage = getGroupProp "PermissionSendMessage" + +-- |Group invitation link. Empty if disabled +getGroupInviteLink :: MonadIO m => Group -> SignalConn -> m String +getGroupInviteLink = getGroupProp "GroupInviteLink" + +-- |Display name +setGroupName :: MonadIO m => String -> Group -> SignalConn -> m () +setGroupName s = setGroupProp "Name" s + +-- |Description +setGroupDescription :: MonadIO m => String -> Group -> SignalConn -> m () +setGroupDescription s = setGroupProp "Description" s + +-- |Filename of group avatar. Resolves using the working dir of the signal-cli daemon, not this process +setGroupAvatar :: MonadIO m => String -> Group -> SignalConn -> m () +setGroupAvatar s = setGroupProp "Avatar" s + +-- |UNTESTED. If true, messages won't be forwarded via DBus +setGroupIsBlocked :: MonadIO m => Bool -> Group -> SignalConn -> m () +setGroupIsBlocked b = setGroupProp "IsBlocked" b + +-- |Message expiration timer. 0 to disable +setGroupMessageExpirationTimer :: MonadIO m => Int -> Group -> SignalConn -> m () +setGroupMessageExpirationTimer i = setGroupProp "MessageExpirationTimer" + $ (fromIntegral i :: Int32) + +-- |String representing who has permission to add members +-- (one of "ONLY_ADMINS", "EVERY_MEMBER") +setGroupPermissionAddMember :: MonadIO m => String -> Group -> SignalConn -> m () +setGroupPermissionAddMember s = setGroupProp "PermissionAddMember" s + +-- |String representing who has permission to edit group description +-- (one of "ONLY_ADMINS", "EVERY_MEMBER") +setGroupPermissionEditDetails :: MonadIO m => String -> Group -> SignalConn -> m () +setGroupPermissionEditDetails s = setGroupProp "PermissionEditDetails" s + +-- |String representing who has permission to send messages +-- (one of "ONLY_ADMINS", "EVERY_MEMBER") +setGroupPermissionSendMessage :: MonadIO m => String -> Group -> SignalConn -> m () +setGroupPermissionSendMessage s = setGroupProp "PermissionSendMessage" s + +-- |Add admins +groupAddAdmins :: MonadIO m => [String] -> Group -> SignalConn -> m () +groupAddAdmins ns = callGroup_ "addAdmins" [toVariant ns] + +-- |Add numbers who are pending members to the group, and other numbers to requesting +-- members list +groupAddMembers :: MonadIO m => [String] -> Group -> SignalConn -> m () +groupAddMembers ns = callGroup_ "addMembers" [toVariant ns] + +-- |Disable group invitation link +groupDisableLink :: MonadIO m => Group -> SignalConn -> m () +groupDisableLink = callGroup_ "disableLink" [] + +-- |Enable group invitation link. If the argument is true, users cannot join directly, +-- but are added to the requesting members list first. +groupEnableLink :: MonadIO m => Bool -> Group -> SignalConn -> m () +groupEnableLink b = callGroup_ "enableLink" [toVariant b] + +-- |Quit the group +groupQuit :: MonadIO m => Group -> SignalConn -> m () +groupQuit = callGroup_ "quitGroup" [] + +-- |Remove admins +groupRemoveAdmins :: MonadIO m => [String] -> Group -> SignalConn -> m () +groupRemoveAdmins ns = callGroup_ "removeAdmins" [toVariant ns] + +-- |Remove numbers from the group +groupRemoveMembers :: MonadIO m => [String] -> Group -> SignalConn -> m () +groupRemoveMembers ns = callGroup_ "removeMembers" [toVariant ns] + +-- |Reset the group invitation link +groupResetLink :: MonadIO m => Group -> SignalConn -> m () +groupResetLink = callGroup_ "resetLink" [] diff --git a/src/SignalDBus/Interface.hs b/src/SignalDBus/Interface.hs new file mode 100644 --- /dev/null +++ b/src/SignalDBus/Interface.hs @@ -0,0 +1,163 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE ScopedTypeVariables #-} + +{-| +Module: SignalDBus.Interface +Description: Low-Level IO with DBus +Copyright: (c) Lia Lenckowski, 2022 +License: AGPL +Maintainer: lialenck@protonmail.com +Stability: experimental +Portability: GNU/Linux, MacOS + +Except for things reexported elsewhere, this module is mainly meant for internal usage. +However, if you require APIs not implemented by the main module, you may use these functions +to implement them. +-} + +module SignalDBus.Interface ( + withConn, + withConnNum, + withReceiveMessages, + + callSC, + callSC_, + callControl, + callControl_, + + getGroupProp, + setGroupProp, + callGroup_, +) where + +import Data.String (fromString) +import DBus hiding (ReceivedMessage(..)) +import DBus.Client +import UnliftIO.Chan +import UnliftIO.Exception (bracket, catch) +import UnliftIO (MonadIO, MonadUnliftIO, liftIO, toIO, throwIO) + +import SignalDBus.Types + +withConnS :: MonadUnliftIO m => String -> (SignalConn -> m a) -> m a +withConnS s = bracket + (SignalConn (fromString $ "/org/asamk/Signal" ++ s) <$> liftIO connectSession) + $ \(SignalConn _ c) -> liftIO $ disconnect c + +-- |Run an action that requires a signal connection, and return its result +withConn :: MonadUnliftIO m => (SignalConn -> m a) -> m a +withConn = withConnS "" + +-- |Like 'withConn', but you have to manually specify a phone number to use, which is +-- useful if the signal daemon doesn't have a default number. +-- This may not be used with a signal-cli daemon that has a default number configured. +withConnNum :: MonadUnliftIO m => String -> (SignalConn -> m a) -> m a +withConnNum n = withConnS $ fromString "/_" ++ tail n +-- above usage of 'tail' because signal-cli doesn't want a '+' in front + +-- |Run an action that receives a callback to receive new messages, and return its +-- result. This will /not/ yield messages that were received prior to calling this. +withReceiveMessages :: MonadUnliftIO m + => SignalConn + -> (m ReceivedMessage -> m a) + -> m a +withReceiveMessages sc@(SignalConn _ c) cb = do + ch <- newChan + action <- toIO $ cb $ readChan ch + liftIO $ bracket + (addMatch c match $ processSig $ writeChan ch) + (removeMatch c) + $ const action + + where match = matchAny { matchInterface = Just "org.asamk.Signal" } + + getGroup :: MonadUnliftIO m => Variant -> m (Maybe Group) + getGroup g = fmap Just (callSC "getGroup" [g] sc) + `catch` \e -> const (return Nothing) (e :: ClientError) + + processSig fwd s = do + let memb = signalMember s + body = signalBody s + + m <- case (memb, body) of + ("SyncMessageReceived", [ts, n, _, g, msg, as]) -> do + may_g <- getGroup g + return $! SyncMessage <$> fromVariant ts <*> fromVariant n + <*> return may_g <*> fromVariant msg <*> fromVariant as + + ("ReceiptReceived", [ts, n]) -> + return $! Receipt <$> fromVariant ts <*> fromVariant n + + ("MessageReceived", [ts, n, g, msg, as]) -> do + may_g <- getGroup g + return $! Message <$> fromVariant ts <*> fromVariant n + <*> return may_g <*> fromVariant msg <*> fromVariant as + + _ -> return $! Nothing + + case m of + Just x -> fwd x + Nothing -> return () + +-- |INTERNAL. Call method from the Signal.Control interface, and return its result. +callControl :: (MonadIO m, IsVariant a) => MemberName -> [Variant] -> SignalConn -> m a +callControl meth args (SignalConn _ c) = callSC meth args + $ SignalConn "/org/asamk/Signal" c + +-- |INTERNAL. Call method from the Signal.Control interface, expecting no return value. +callControl_ :: MonadIO m => MemberName -> [Variant] -> SignalConn -> m () +callControl_ meth args (SignalConn _ c) = callSC_ meth args + $ SignalConn "/org/asamk/Signal" c + +-- |INTERNAL. Call method from the main Signal interface, and return its result. +callSC :: (MonadIO m, IsVariant a) => MemberName -> [Variant] -> SignalConn -> m a +callSC meth args (SignalConn p c) = do + r <- liftIO $ call_ c + (methodCall p "org.asamk.Signal" meth) + { methodCallDestination = Just "org.asamk.Signal", + methodCallBody = args } + + case map fromVariant $ methodReturnBody r of + [Just x] -> return x + _ -> throwIO $ clientError $ "Unexpected reply: " ++ show r + +-- |INTERNAL. Call method from the main Signal interface, expecting no return value. +callSC_ :: MonadIO m => MemberName -> [Variant] -> SignalConn -> m () +callSC_ meth args (SignalConn p c) = do + _ <- liftIO $ call_ c + (methodCall p "org.asamk.Signal" meth) + { methodCallDestination = Just "org.asamk.Signal", + methodCallBody = args } + return () + +-- |INTERNAL. Get group proptery +getGroupProp :: (MonadIO m, IsValue a) => MemberName -> Group -> SignalConn -> m a +getGroupProp prop (Group p) (SignalConn _ c) = do + r <- liftIO $ getPropertyValue c + (methodCall p "org.asamk.Signal.Group" prop) + { methodCallDestination = Just "org.asamk.Signal" } + + case r of + Right x -> return x + Left e -> throwIO $ clientError $ "Error getting property: " ++ show e + +-- |INTERNAL. Set group proptery +setGroupProp :: (MonadIO m, IsValue a) => MemberName -> a -> Group -> SignalConn -> m () +setGroupProp prop x (Group p) (SignalConn _ c) = do + r <- liftIO $ setPropertyValue c + (methodCall p "org.asamk.Signal.Group" prop) + { methodCallDestination = Just "org.asamk.Signal" } + $ toVariant x + + case r of + Nothing -> return () + Just e -> throwIO $ clientError $ "Error setting property: " ++ show e + +-- |INTERNAL. Call method from the Signal.Group interface, expecting no return value. +callGroup_ :: MonadIO m => MemberName -> [Variant] -> Group -> SignalConn -> m () +callGroup_ meth args (Group p) (SignalConn _ c) = do + _ <- liftIO $ call_ c + (methodCall p "org.asamk.Signal.Group" meth) + { methodCallDestination = Just "org.asamk.Signal", + methodCallBody = args } + return () diff --git a/src/SignalDBus/Types.hs b/src/SignalDBus/Types.hs new file mode 100644 --- /dev/null +++ b/src/SignalDBus/Types.hs @@ -0,0 +1,92 @@ +{-# OPTIONS_GHC -Wno-orphans #-} -- :/ + +{-| +Module: SignalDBus.Types +Description: Types used by this package +Copyright: (c) Lia Lenckowski, 2022 +License: AGPL +Maintainer: lialenck@protonmail.com +Stability: experimental +Portability: GNU/Linux, MacOS + +This module contains types used by this package. Please import SignalDBus instead. +-} + +module SignalDBus.Types ( + SignalConn(..), + Timestamp, + Device(..), + Group(..), + ReceivedMessage(..), +) where + +import Data.Int (Int64) +import DBus.Client (Client) +import DBus.Internal.Types +import Text.Read (readPrec) + +-- |Opaque connection object, aquired by 'SignalDBus.withConn' or +-- 'SignalDBus.withConnNum' +data SignalConn = SignalConn !ObjectPath !Client + +-- |Timestamp, represented as an ms-precision unix timestamp +newtype Timestamp = Timestamp Int64 deriving (Show, Read, Eq, Ord) + +instance IsVariant Timestamp where + toVariant (Timestamp ts) = toVariant ts + fromVariant v = Timestamp <$> fromVariant v + +instance IsValue Timestamp where + typeOf_ _ = TypeInt64 + toValue (Timestamp ts) = toValue ts + fromValue v = Timestamp <$> fromValue v + +-- |Opaque object representing a linked device +newtype Device = Device Int64 deriving (Show, Read, Eq) +instance IsVariant Device where + toVariant (Device i) = toVariant i + fromVariant v = Device <$> fromVariant v + +instance IsValue Device where + typeOf_ _ = TypeInt64 + toValue (Device i) = toValue i + fromValue v = Device <$> fromValue v + +instance Read ObjectPath where -- :/ + readPrec = ObjectPath <$> readPrec + +-- |Opaque Group object, aquired by 'SignalDBus.listGroups' or 'SignalDBus.getGroup' +newtype Group = Group ObjectPath deriving (Show, Read, Eq, Ord) +instance IsVariant Group where + toVariant (Group i) = toVariant i + fromVariant v = Group <$> fromVariant v + +instance IsValue Group where + typeOf_ _ = TypeObjectPath + toValue (Group i) = toValue i + fromValue v = Group <$> fromValue v + +-- |Received message +data ReceivedMessage = + -- |Message sent by a linked device to someone else + SyncMessage + Timestamp -- ^ When this message was sent + String -- ^ Message sender (TODO: always yourself?) + (Maybe Group) -- ^ If sent in a group, corresponding group object + String -- ^ Message text + [String] -- ^ Paths to stored attachments + + -- |Read receipt sent by someone else in response to one of your messages + | Receipt + Timestamp -- ^ Which message was read + String -- ^ Phone number of the receipt sender + + -- |Message sent to you by someone else + | Message + Timestamp -- ^ When this message was sent + String -- ^ Message sender + (Maybe Group) -- ^ If sent in a group, corresponding group object + String -- ^ Message text + [String] -- ^ Paths to stored attachments + + deriving (Show, Read, Eq, Ord)