commit efc7588c091ad2b0d129ade8f69671e5f1d6fcf7 Author: RunasSudo Date: Fri May 28 19:58:40 2021 +1000 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ea8c4bf --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/target diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/COPYING @@ -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/Cargo.lock b/Cargo.lock new file mode 100644 index 0000000..bc10c93 --- /dev/null +++ b/Cargo.lock @@ -0,0 +1,79 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +[[package]] +name = "autocfg" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cdb031dd78e28731d87d56cc8ffef4a8f36ca26c38fe2de700543e627f8a464a" + +[[package]] +name = "az" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "822d7d63e0c0260a050f6b1f0d316f5c79b9eab830aca526ed904e1011bd64ca" + +[[package]] +name = "gmp-mpfr-sys" +version = "1.4.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "18e70045792b1d584ef8d8ac5e890a98d9d6499d2d709cf2b23725b6dcb10064" +dependencies = [ + "libc", + "winapi", +] + +[[package]] +name = "libc" +version = "0.2.95" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "789da6d93f1b866ffe175afc5322a4d76c038605a1c3319bb57b06967ca98a36" + +[[package]] +name = "num-traits" +version = "0.2.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9a64b1ec5cda2586e284722486d802acf1f7dbdc623e2bfc57e65ca1cd099290" +dependencies = [ + "autocfg", +] + +[[package]] +name = "opentally" +version = "0.1.0" +dependencies = [ + "num-traits", + "rug", +] + +[[package]] +name = "rug" +version = "1.12.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32f75e07492c4d17d12f226d17e689fdb698db7a1e875fca0fac15626283bf24" +dependencies = [ + "az", + "gmp-mpfr-sys", + "libc", +] + +[[package]] +name = "winapi" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" +dependencies = [ + "winapi-i686-pc-windows-gnu", + "winapi-x86_64-pc-windows-gnu", +] + +[[package]] +name = "winapi-i686-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" + +[[package]] +name = "winapi-x86_64-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..4820012 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,13 @@ +[package] +name = "opentally" +version = "0.1.0" +authors = ["Lee Yingtong Li "] +edition = "2018" + +[dependencies] +num-traits = "0.2" + +[dependencies.rug] +version = "1.12" +default-features = false +features = ["integer", "rational", "float"] diff --git a/src/election.rs b/src/election.rs new file mode 100644 index 0000000..160139d --- /dev/null +++ b/src/election.rs @@ -0,0 +1,209 @@ +/* OpenTally: Open-source election vote counting + * Copyright © 2021 Lee Yingtong Li (RunasSudo) + * + * 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 . + */ + +use crate::numbers::Number; + +use std::collections::HashMap; +use std::io::{BufRead, Lines}; + +pub struct Election { + pub seats: usize, + pub candidates: Vec, + pub ballots: Vec>, +} + +impl Election { + pub fn from_blt(mut lines: Lines) -> Self { + // Read first line + let line = lines.next().expect("Unexpected EOF").expect("IO Error"); + let mut bits = line.split(" "); + let num_candidates = bits.next().expect("Syntax Error").parse().expect("Syntax Error"); + let seats: usize = bits.next().expect("Syntax Error").parse().expect("Syntax Error"); + + // Initialise the Election object + let mut election = Election { + seats: seats, + candidates: Vec::with_capacity(num_candidates), + ballots: Vec::new(), + }; + + // Read ballots + for line in &mut lines { + let line = line.expect("IO Error"); + if line == "0" { + break; + } + + let mut bits = line.split(" "); + let value = N::parse(bits.next().expect("Syntax Error")); + + let mut ballot = Ballot { + orig_value: value, + preferences: Vec::new(), + }; + + for preference in bits { + if preference != "0" { + let preference = preference.parse::().expect("Syntax Error"); + ballot.preferences.push(preference - 1); + } + } + + election.ballots.push(ballot); + } + + // Read candidates + for line in lines.take(num_candidates) { + let mut line = &line.expect("IO Error")[..]; + if line.starts_with("\"") && line.ends_with("\"") { + line = &line[1..line.len()-1]; + } + + election.candidates.push(Candidate { name: line.to_string() }); + } + + return election; + } +} + +#[derive(PartialEq, Eq, Hash)] +pub struct Candidate { + pub name: String, +} + +#[derive(Clone)] +pub struct CountState<'a, N> { + pub election: &'a Election, + + pub candidates: HashMap<&'a Candidate, CountCard<'a, N>>, + pub exhausted: CountCard<'a, N>, + + pub quota: N, + + pub num_elected: usize, + pub num_excluded: usize, +} + +impl<'a, N: Number> CountState<'a, N> { + pub fn new(election: &'a Election) -> Self { + let mut state = CountState { + election: &election, + candidates: HashMap::new(), + exhausted: CountCard::new(), + quota: N::new(), + num_elected: 0, + num_excluded: 0, + }; + + for candidate in election.candidates.iter() { + state.candidates.insert(candidate, CountCard::new()); + } + + return state; + } + + pub fn step_all(&mut self) { + for (_, count_card) in self.candidates.iter_mut() { + count_card.step(); + } + self.exhausted.step(); + } +} + +pub enum CountStateOrRef<'a, N> { + State(CountState<'a, N>), + Ref(&'a CountState<'a, N>), +} + +impl<'a, N> CountStateOrRef<'a, N> { + pub fn as_ref(&self) -> &CountState { + match self { + CountStateOrRef::State(state) => &state, + CountStateOrRef::Ref(state) => state, + } + } +} + +pub struct StageResult<'a, N> { + pub title: &'a str, + pub logs: Vec<&'a str>, + pub state: CountStateOrRef<'a, N>, +} + +#[derive(Clone)] +pub struct CountCard<'a, N> { + pub state: CandidateState, + pub order_elected: isize, + + pub orig_votes: N, + pub transfers: N, + pub votes: N, + + pub parcels: Vec>, +} + +impl<'a, N: Number> CountCard<'a, N> { + pub fn new() -> Self { + return CountCard { + state: CandidateState::HOPEFUL, + order_elected: 0, + orig_votes: N::new(), + transfers: N::new(), + votes: N::new(), + parcels: Vec::new(), + }; + } + + //pub fn votes(&'a self) -> N { + // return self.orig_votes.clone() + &self.transfers; + //} + + pub fn transfer(&mut self, transfer: &'_ N) { + self.transfers += transfer; + self.votes += transfer; + } + + pub fn step(&mut self) { + self.orig_votes = self.votes.clone(); + self.transfers = N::new(); + } +} + +pub type Parcel<'a, N> = Vec>; + +#[derive(Clone)] +pub struct Vote<'a, N> { + pub ballot: &'a Ballot, + pub value: N, + pub up_to_pref: usize, +} + +pub struct Ballot { + pub orig_value: N, + pub preferences: Vec, +} + +#[allow(dead_code)] +#[derive(PartialEq)] +#[derive(Clone)] +pub enum CandidateState { + HOPEFUL, + GUARDED, + ELECTED, + DOOMED, + EXCLUDED, +} diff --git a/src/main.rs b/src/main.rs new file mode 100644 index 0000000..7816085 --- /dev/null +++ b/src/main.rs @@ -0,0 +1,160 @@ +/* OpenTally: Open-source election vote counting + * Copyright © 2021 Lee Yingtong Li (RunasSudo) + * + * 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 . + */ + +mod election; +mod numbers; +mod stv; + +use crate::election::{CandidateState, CountState, CountStateOrRef, Election, StageResult}; +use crate::numbers::{Number, NumType}; + +use std::env; +use std::fs::File; +use std::io::{self, BufRead}; + +const DECIMAL_PLACES: usize = 0; + +fn print_stage(stage_num: usize, result: &StageResult) { + println!("{}. {}", stage_num, result.title); + println!("{}", result.logs.join(" ")); + + // Sort candidates + //let mut candidates: Vec<(&&Candidate, &CountCard)> = result.state.candidates.iter().collect(); + //candidates.sort_unstable_by(|a, b| a.1.votes.partial_cmp(&b.1.votes).unwrap()); + let candidates = result.state.as_ref().election.candidates.iter().map(|c| (c, result.state.as_ref().candidates.get(c).unwrap())); + + // Print candidates + //for (candidate, count_card) in candidates.into_iter().rev() { + for (candidate, count_card) in candidates { + if count_card.state == CandidateState::ELECTED { + println!("- {}: {:.dps$} ({:.dps$}) - ELECTED {}", candidate.name, count_card.votes, count_card.transfers, count_card.order_elected, dps=DECIMAL_PLACES); + } else if count_card.state == CandidateState::EXCLUDED { + println!("- {}: {:.dps$} ({:.dps$}) - Excluded {}", candidate.name, count_card.votes, count_card.transfers, -count_card.order_elected, dps=DECIMAL_PLACES); + } else { + println!("- {}: {:.dps$} ({:.dps$})", candidate.name, count_card.votes, count_card.transfers, dps=DECIMAL_PLACES); + } + } + + println!("Quota: {:.dps$}", result.state.as_ref().quota, dps=DECIMAL_PLACES); + + println!(""); +} + +fn main() { + // Read arguments + let file_name = env::args().skip(1).next().expect("First argument must be path to BLT file"); + + let should_clone_state = false; + + // Read BLT file + let file = File::open(file_name).expect("IO Error"); + let lines = io::BufReader::new(file).lines(); + let election: Election = Election::from_blt(lines); + + // Initialise count state + let mut state = CountState::new(&election); + + // Distribute first preferences + stv::distribute_first_preferences(&mut state); + stv::calculate_quota(&mut state); + stv::elect_meeting_quota(&mut state); + + // Display + // TODO: Add logs during count + let result = StageResult { + title: "First preferences", + logs: vec!["First preferences distributed."], + state: if should_clone_state { CountStateOrRef::State(state.clone()) } else { CountStateOrRef::Ref(&state) }, + }; + print_stage(1, &result); + + let mut stage_num = 1; + + loop { + state.step_all(); + stage_num += 1; + + // Finish count + if stv::finished_before_stage(&state) { + break; + } + + // Continue exclusions + if stv::continue_exclusion(&mut state) { + stv::elect_meeting_quota(&mut state); + let result = StageResult { + title: "Exclusion", + logs: vec!["Continuing exclusion."], + state: if should_clone_state { CountStateOrRef::State(state.clone()) } else { CountStateOrRef::Ref(&state) }, + }; + print_stage(stage_num, &result); + continue; + } + + // Distribute surpluses + if stv::distribute_surpluses(&mut state) { + stv::elect_meeting_quota(&mut state); + let result = StageResult { + title: "Surplus", + logs: vec!["Surplus distributed."], + state: if should_clone_state { CountStateOrRef::State(state.clone()) } else { CountStateOrRef::Ref(&state) }, + }; + print_stage(stage_num, &result); + continue; + } + + // Attempt bulk election + if stv::bulk_elect(&mut state) { + stv::elect_meeting_quota(&mut state); + let result = StageResult { + title: "Bulk election", + logs: vec!["Bulk election."], + state: if should_clone_state { CountStateOrRef::State(state.clone()) } else { CountStateOrRef::Ref(&state) }, + }; + print_stage(stage_num, &result); + continue; + } + + // Exclude lowest hopeful + if stv::exclude_hopefuls(&mut state) { + stv::elect_meeting_quota(&mut state); + let result = StageResult { + title: "Exclusion", + logs: vec!["Candidate excluded."], + state: if should_clone_state { CountStateOrRef::State(state.clone()) } else { CountStateOrRef::Ref(&state) }, + }; + print_stage(stage_num, &result); + continue; + } + + todo!(); + } + + println!("Count complete. The winning candidates are, in order of election:"); + + let mut winners = Vec::new(); + for (candidate, count_card) in state.candidates.iter() { + if count_card.state == CandidateState::ELECTED { + winners.push((candidate, count_card.order_elected)); + } + } + winners.sort_unstable_by(|a, b| a.1.partial_cmp(&b.1).unwrap()); + + for (i, (winner, _)) in winners.into_iter().enumerate() { + println!("{}. {}", i + 1, winner.name); + } +} diff --git a/src/numbers.rs b/src/numbers.rs new file mode 100644 index 0000000..07d0fe5 --- /dev/null +++ b/src/numbers.rs @@ -0,0 +1,305 @@ +/* OpenTally: Open-source election vote counting + * Copyright © 2021 Lee Yingtong Li (RunasSudo) + * + * 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 . + */ + +use num_traits::{Num, NumAssignRef, NumRef, One, Zero}; +use rug::{self, Assign, ops::Pow, rational::ParseRationalError}; + +use std::cmp::{Ordering, PartialEq, PartialOrd}; +use std::convert::TryInto; +use std::fmt; +use std::ops; + +//pub trait Number: NumRef + NumAssignRef + PartialOrd + Assign + Clone + fmt::Display where for<'a> &'a Self: RefNum<&'a Self> { +pub trait Number: NumRef + NumAssignRef + ops::Neg + PartialOrd + Assign + Clone + fmt::Display where for<'a> Self: Assign<&'a Self>{ + fn new() -> Self; + fn from(n: usize) -> Self; + + fn floor_mut(&mut self); + + fn parse(s: &str) -> Self { + if let Ok(value) = Self::from_str_radix(s, 10) { + return value; + } else { + panic!("Syntax Error"); + } + } +} + +pub struct Rational(rug::Rational); + +impl Number for Rational { + fn new() -> Self { Self(rug::Rational::new()) } + + fn from(n: usize) -> Self { Self(rug::Rational::from(n)) } + + fn floor_mut(&mut self) { self.0.floor_mut() } +} + +impl Num for Rational { + type FromStrRadixErr = ParseRationalError; + + fn from_str_radix(str: &str, radix: u32) -> Result { + match rug::Rational::parse_radix(str, radix.try_into().unwrap()) { + Ok(value) => Ok(Self(rug::Rational::from(value))), + Err(err) => Err(err) + } + } +} + +impl Assign for Rational { + fn assign(&mut self, src: Self) { self.0.assign(src.0) } +} + +impl Assign<&Rational> for Rational { + fn assign(&mut self, src: &Rational) { self.0.assign(&src.0) } +} + +impl Clone for Rational { + fn clone(&self) -> Self { Self(self.0.clone()) } +} + +impl fmt::Display for Rational { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + if let Some(precision) = f.precision() { + if precision == 0 { + let result = rug::Integer::from((&self.0).round_ref()).to_string(); + return f.write_str(&result); + } else { + let base = rug::Rational::from(10).pow(precision as u32); + let mut result = rug::Integer::from((&self.0 * base).round_ref()).to_string(); + + // Add leading 0s + result = format!("{0:0>1$}", result, precision + 1); + + // Add the decimal point + result.insert(result.len() - precision, '.'); + + return f.write_str(&result); + } + } else { + return self.0.fmt(f); + } + } +} + +impl One for Rational { + fn one() -> Self { Rational(rug::Rational::from(1)) } +} + +impl Zero for Rational { + fn zero() -> Self { Self::new() } + fn is_zero(&self) -> bool { self.0 == rug::Rational::new() } +} + +impl PartialEq for Rational { + fn eq(&self, _other: &Self) -> bool { + todo!() + } +} + +impl PartialOrd for Rational { + fn partial_cmp(&self, other: &Self) -> Option { self.0.partial_cmp(&other.0) } +} + +impl ops::Neg for Rational { + type Output = Rational; + fn neg(self) -> Self::Output { Rational(-self.0) } +} + +impl ops::Add for Rational { + type Output = Rational; + fn add(self, _rhs: Self) -> Self::Output { + todo!() + } +} + +impl ops::Sub for Rational { + type Output = Rational; + fn sub(self, _rhs: Self) -> Self::Output { + todo!() + } +} + +impl ops::Mul for Rational { + type Output = Rational; + fn mul(self, _rhs: Self) -> Self::Output { + todo!() + } +} + +impl ops::Div for Rational { + type Output = Rational; + fn div(self, _rhs: Self) -> Self::Output { + todo!() + } +} + +impl ops::Rem for Rational { + type Output = Rational; + + fn rem(self, _rhs: Self) -> Self::Output { + todo!() + } +} + +impl ops::Add<&Rational> for Rational { + type Output = Rational; + fn add(self, _rhs: &Rational) -> Self::Output { + todo!() + } +} + +impl ops::Sub<&Rational> for Rational { + type Output = Rational; + fn sub(self, _rhs: &Rational) -> Self::Output { + todo!() + } +} + +impl ops::Mul<&Rational> for Rational { + type Output = Rational; + fn mul(self, rhs: &Rational) -> Self::Output { Rational(self.0 * &rhs.0) } +} + +impl ops::Div<&Rational> for Rational { + type Output = Rational; + fn div(self, rhs: &Rational) -> Self::Output { Rational(self.0 / &rhs.0) } +} + +impl ops::Rem<&Rational> for Rational { + type Output = Rational; + fn rem(self, _rhs: &Rational) -> Self::Output { + todo!() + } +} + +impl ops::AddAssign for Rational { + fn add_assign(&mut self, rhs: Self) { self.0 += rhs.0 } +} + +impl ops::SubAssign for Rational { + fn sub_assign(&mut self, _rhs: Self) { + todo!() + } +} + +impl ops::MulAssign for Rational { + fn mul_assign(&mut self, _rhs: Self) { + todo!() + } +} + +impl ops::DivAssign for Rational { + fn div_assign(&mut self, rhs: Self) { + self.0 /= &rhs.0; + } +} + +impl ops::RemAssign for Rational { + fn rem_assign(&mut self, _rhs: Self) { + todo!() + } +} + +impl ops::AddAssign<&Rational> for Rational { + fn add_assign(&mut self, rhs: &Rational) { + self.0 += &rhs.0; + } +} + +impl ops::SubAssign<&Rational> for Rational { + fn sub_assign(&mut self, _rhs: &Rational) { + todo!() + } +} + +impl ops::MulAssign<&Rational> for Rational { + fn mul_assign(&mut self, _rhs: &Rational) { + todo!() + } +} + +impl ops::DivAssign<&Rational> for Rational { + fn div_assign(&mut self, _rhs: &Rational) { + todo!() + } +} + +impl ops::RemAssign<&Rational> for Rational { + fn rem_assign(&mut self, _rhs: &Rational) { + todo!() + } +} + +impl ops::Add<&Rational> for &Rational { + type Output = Rational; + fn add(self, _rhs: &Rational) -> Self::Output { + todo!() + } +} + +impl ops::Sub<&Rational> for &Rational { + type Output = Rational; + fn sub(self, rhs: &Rational) -> Self::Output { + return Rational(rug::Rational::from(&self.0 - &rhs.0)); + } +} + +impl ops::Mul<&Rational> for &Rational { + type Output = Rational; + fn mul(self, _rhs: &Rational) -> Self::Output { + todo!() + } +} + +impl ops::Div<&Rational> for &Rational { + type Output = Rational; + fn div(self, _rhs: &Rational) -> Self::Output { + todo!() + } +} + +impl ops::Rem<&Rational> for &Rational { + type Output = Rational; + fn rem(self, _rhs: &Rational) -> Self::Output { + todo!() + } +} + +/* +impl ops::Add<&&Rational> for &Rational { + +} + +impl ops::Sub<&&Rational> for &Rational { + +} + +impl ops::Mul<&&Rational> for &Rational { + +} + +impl ops::Div<&&Rational> for &Rational { + +} + +impl ops::Rem<&&Rational> for &Rational { + +} +*/ + +pub type NumType = Rational; diff --git a/src/stv/mod.rs b/src/stv/mod.rs new file mode 100644 index 0000000..c7cb92a --- /dev/null +++ b/src/stv/mod.rs @@ -0,0 +1,327 @@ +/* OpenTally: Open-source election vote counting + * Copyright © 2021 Lee Yingtong Li (RunasSudo) + * + * 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 . + */ + +#![allow(mutable_borrow_reservation_conflict)] + +use crate::numbers::Number; +use crate::election::{Candidate, CandidateState, CountCard, CountState, Parcel, Vote}; + +use std::collections::HashMap; +use std::ops::Sub; + +struct NextPreferencesResult<'a, N> { + candidates: HashMap<&'a Candidate, NextPreferencesEntry<'a, N>>, + exhausted: NextPreferencesEntry<'a, N>, + total_ballots: N, +} + +struct NextPreferencesEntry<'a, N> { + //count_card: Option<&'a CountCard<'a, N>>, + votes: Vec>, + num_ballots: N, + num_votes: N, +} + +fn next_preferences<'a, N: Number>(state: &CountState<'a, N>, votes: Vec>) -> NextPreferencesResult<'a, N> { + let mut result = NextPreferencesResult { + candidates: HashMap::new(), + exhausted: NextPreferencesEntry { + votes: Vec::new(), + num_ballots: N::new(), + num_votes: N::new(), + }, + total_ballots: N::new(), + }; + + for mut vote in votes.into_iter() { + result.total_ballots += &vote.ballot.orig_value; + + let mut next_candidate = None; + + for (i, preference) in vote.ballot.preferences.iter().enumerate().skip(vote.up_to_pref) { + let candidate = &state.election.candidates[*preference]; + let count_card = state.candidates.get(candidate).unwrap(); + + if let CandidateState::HOPEFUL | CandidateState::GUARDED = count_card.state { + next_candidate = Some(candidate); + vote.up_to_pref = i + 1; + break; + } + } + + // Have to structure like this to satisfy Rust's borrow checker + if let Some(candidate) = next_candidate { + if result.candidates.contains_key(candidate) { + let entry = result.candidates.get_mut(candidate).unwrap(); + entry.num_ballots += &vote.ballot.orig_value; + entry.num_votes += &vote.value; + entry.votes.push(vote); + } else { + let entry = NextPreferencesEntry { + num_ballots: vote.ballot.orig_value.clone(), + num_votes: vote.value.clone(), + votes: vec![vote], + }; + result.candidates.insert(candidate, entry); + } + } else { + result.exhausted.num_ballots += &vote.ballot.orig_value; + result.exhausted.num_votes += &vote.value; + result.exhausted.votes.push(vote); + } + } + + return result; +} + +pub fn distribute_first_preferences(state: &mut CountState) { + let mut votes = Vec::new(); + for ballot in state.election.ballots.iter() { + let vote = Vote { + ballot: ballot, + value: ballot.orig_value.clone(), + up_to_pref: 0, + }; + votes.push(vote); + } + + let result = next_preferences(state, votes); + + // Transfer candidate votes + for (candidate, entry) in result.candidates.into_iter() { + let parcel = entry.votes as Parcel; + let count_card = state.candidates.get_mut(candidate).unwrap(); + count_card.parcels.push(parcel); + count_card.transfer(&entry.num_votes); + } + + // Transfer exhausted votes + let parcel = result.exhausted.votes as Parcel; + state.exhausted.parcels.push(parcel); + state.exhausted.transfer(&result.exhausted.num_votes); +} + +pub fn calculate_quota(state: &mut CountState) { + // Calculate the total vote + state.quota = N::zero(); + for count_card in state.candidates.values() { + state.quota += &count_card.votes; + } + + // TODO: Different quotas + state.quota /= N::from(state.election.seats + 1); + + // TODO: Different rounding rules + state.quota += N::one(); + state.quota.floor_mut(); +} + +fn meets_quota(quota: &N, count_card: &CountCard) -> bool { + // TODO: Different quota rules + return count_card.votes >= *quota; +} + +pub fn elect_meeting_quota(state: &mut CountState) { + // Can't use filter(...) magic because of conflict with borrow checker + let mut cands_meeting_quota = Vec::new(); + for (candidate, count_card) in state.candidates.iter_mut() { + if count_card.state == CandidateState::HOPEFUL && meets_quota(&state.quota, count_card) { + cands_meeting_quota.push((candidate, count_card)); + } + } + + if cands_meeting_quota.len() > 0 { + // Sort by votes + cands_meeting_quota.sort_unstable_by(|a, b| a.1.votes.partial_cmp(&b.1.votes).unwrap()); + + // Declare elected in descending order of votes + for (_, count_card) in cands_meeting_quota.into_iter().rev() { + // TODO: Log + count_card.state = CandidateState::ELECTED; + state.num_elected += 1; + count_card.order_elected = state.num_elected as isize; + } + } +} + +pub fn distribute_surpluses(state: &mut CountState) -> bool where for<'r> &'r N: Sub<&'r N, Output=N> { + // As above regarding filter(...) + let mut has_surplus = Vec::new(); + for (candidate, count_card) in state.candidates.iter() { + if count_card.votes > state.quota { + has_surplus.push((candidate, count_card)); + } + } + + if has_surplus.len() > 0 { + // TODO: Different sorting orders + has_surplus.sort_unstable_by(|a, b| a.1.order_elected.partial_cmp(&b.1.order_elected).unwrap()); + + // Distribute top candidate's surplus + // TODO: Handle ties + let elected_candidate = has_surplus.first_mut().unwrap().0; + distribute_surplus(state, elected_candidate); + + return true; + } + return false; +} + +fn distribute_surplus(state: &mut CountState, elected_candidate: &Candidate) where for<'r> &'r N: Sub<&'r N, Output=N> { + let count_card = state.candidates.get(elected_candidate).unwrap(); + let surplus = &count_card.votes - &state.quota; + + // Inclusive Gregory + // TODO: Other methods + let votes = state.candidates.get(elected_candidate).unwrap().parcels.concat(); + + // Count next preferences + let result = next_preferences(state, votes); + + // Transfer candidate votes + // Unweighted inclusive Gregory + // TODO: Other methods + let transfer_value = surplus.clone() / &result.total_ballots; + + for (candidate, entry) in result.candidates.into_iter() { + let mut parcel = entry.votes as Parcel; + + // Reweight votes + for vote in parcel.iter_mut() { + vote.value = vote.ballot.orig_value.clone() * &transfer_value; + } + + let count_card = state.candidates.get_mut(candidate).unwrap(); + count_card.parcels.push(parcel); + + let mut total_transferred = entry.num_ballots * &surplus / &result.total_ballots; + // Round transfers + // TODO: Make configurable + total_transferred.floor_mut(); + count_card.transfer(&total_transferred); + } + + // Transfer exhausted votes + let parcel = result.exhausted.votes as Parcel; + state.exhausted.parcels.push(parcel); + state.exhausted.transfer(&result.exhausted.num_votes); + + // Finalise candidate votes + let count_card = state.candidates.get_mut(elected_candidate).unwrap(); + count_card.transfers = -surplus; + count_card.votes.assign(&state.quota); +} + +pub fn bulk_elect(state: &mut CountState) -> bool { + if state.election.candidates.len() - state.num_excluded <= state.election.seats { + // Bulk elect all remaining candidates + let mut hopefuls = Vec::new(); + for (candidate, count_card) in state.candidates.iter_mut() { + if count_card.state == CandidateState::HOPEFUL { + hopefuls.push((candidate, count_card)); + } + } + // TODO: Handle ties + hopefuls.sort_unstable_by(|a, b| a.1.votes.partial_cmp(&b.1.votes).unwrap()); + + for (_, count_card) in hopefuls.into_iter() { + count_card.state = CandidateState::ELECTED; + state.num_elected += 1; + count_card.order_elected = state.num_elected as isize; + } + + return true; + } + return false; +} + +pub fn exclude_hopefuls(state: &mut CountState) -> bool { + let mut hopefuls = Vec::new(); + for (candidate, count_card) in state.candidates.iter() { + if count_card.state == CandidateState::HOPEFUL { + hopefuls.push((candidate, count_card)); + } + } + + // Sort by votes + // TODO: Handle ties + hopefuls.sort_unstable_by(|a, b| a.1.votes.partial_cmp(&b.1.votes).unwrap()); + + // Exclude lowest ranked candidate + let excluded_candidate = hopefuls.first().unwrap().0; + exclude_candidate(state, excluded_candidate); + + return true; +} + +pub fn continue_exclusion(state: &mut CountState) -> bool { + let mut excluded_with_votes = Vec::new(); + for (candidate, count_card) in state.candidates.iter() { + if count_card.state == CandidateState::EXCLUDED && !count_card.votes.is_zero() { + excluded_with_votes.push((candidate, count_card)); + } + } + + if excluded_with_votes.len() > 0 { + excluded_with_votes.sort_unstable_by(|a, b| a.1.order_elected.partial_cmp(&b.1.order_elected).unwrap()); + let excluded_candidate = excluded_with_votes.first().unwrap().0; + exclude_candidate(state, excluded_candidate); + return true; + } + + return false; +} + +fn exclude_candidate(state: &mut CountState, excluded_candidate: &Candidate) { + let count_card = state.candidates.get_mut(excluded_candidate).unwrap(); + count_card.state = CandidateState::EXCLUDED; + state.num_excluded += 1; + count_card.order_elected = -(state.num_excluded as isize); + + // Exclude in one round + // TODO: Exclude by parcel + let votes = state.candidates.get(excluded_candidate).unwrap().parcels.concat(); + + // Count next preferences + let result = next_preferences(state, votes); + + // Transfer candidate votes + for (candidate, entry) in result.candidates.into_iter() { + let parcel = entry.votes as Parcel; + let count_card = state.candidates.get_mut(candidate).unwrap(); + count_card.parcels.push(parcel); + + count_card.transfer(&entry.num_votes); + } + + // Transfer exhausted votes + let parcel = result.exhausted.votes as Parcel; + state.exhausted.parcels.push(parcel); + state.exhausted.transfer(&result.exhausted.num_votes); + + // Finalise candidate votes + let count_card = state.candidates.get_mut(excluded_candidate).unwrap(); + count_card.transfers = -count_card.votes.clone(); + count_card.votes = N::new(); +} + +pub fn finished_before_stage(state: &CountState) -> bool { + if state.num_elected >= state.election.seats { + return true; + } + return false; +}