From fe11500d2ecec86cf8056f9268e381112460dc2e Mon Sep 17 00:00:00 2001 From: someodd Date: Sat, 2 Mar 2024 21:29:15 -0800 Subject: [PATCH] working proof of concept --- .gitignore | 9 ++ CHANGELOG.md | 27 ++++++ LICENSE | 209 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 39 +++++++++ app/Main.hs | 4 + gopherden.cabal | 65 ++++++++++++++ src/CLI.hs | 77 +++++++++++++++++ src/Config.hs | 175 +++++++++++++++++++++++++++++++++++++ src/Database.hs | 200 +++++++++++++++++++++++++++++++++++++++++++ src/Handle.hs | 182 +++++++++++++++++++++++++++++++++++++++ src/MenuBuild.hs | 126 +++++++++++++++++++++++++++ src/MenuViews.hs | 129 ++++++++++++++++++++++++++++ src/Server.hs | 15 ++++ src/TextBuild.hs | 34 ++++++++ src/TextViews.hs | 31 +++++++ src/ViewHelpers.hs | 10 +++ 16 files changed, 1332 insertions(+) create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 LICENSE create mode 100644 README.md create mode 100644 app/Main.hs create mode 100644 gopherden.cabal create mode 100644 src/CLI.hs create mode 100644 src/Config.hs create mode 100644 src/Database.hs create mode 100644 src/Handle.hs create mode 100644 src/MenuBuild.hs create mode 100644 src/MenuViews.hs create mode 100644 src/Server.hs create mode 100644 src/TextBuild.hs create mode 100644 src/TextViews.hs create mode 100644 src/ViewHelpers.hs diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..87531b4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +dist-newstyle/ +*.swp +dashboard +querytest.log +result/ +result +gopherdashboard-deb/ +*.deb +gopherdashboard-*.zip diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..b30f6a2 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,27 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +... + +### Fixed + +... + +### Changed + +... + +## [0.1.0.0] - 2024-03-04 + +First release, a proof of concept. + +[unreleased]: https://github.com/someodd/gopherden/compare/v0.1.0.0...HEAD +[0.1.0.0]: https://github.com/someodd/gopherden/release/v0.1.0.0 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..91dc495 --- /dev/null +++ b/LICENSE @@ -0,0 +1,209 @@ + +GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright © 2007 Free Software Foundation, Inc. + +Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. + +Preamble + +The GNU General Public License is a free, copyleft license for software and other kinds of works. + +The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. + +For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. + +Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. + +Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. + +Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and modification follow. +TERMS AND CONDITIONS + +0. Definitions. + +“This License” refers to version 3 of the GNU General Public License. + +“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. + +“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations. + +To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work. + +A “covered work” means either the unmodified Program or a work based on the Program. + +To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. + +To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. + +An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. + +1. Source Code. + +The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work. + +A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. + +The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. + +The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same work. + +2. Basic Permissions. + +All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. + +3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. + +When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. + +4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. + +5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified it, and giving a relevant date. + b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”. + c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. + d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. + +A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. + +6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: + + a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. + b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. + c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. + d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. + e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. + +A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. + +“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. + +If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). + +The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. + +Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. + +7. Additional Terms. + +“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or + b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or + c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or + d) Limiting the use for publicity purposes of names of licensors or authors of the material; or + e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or + f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. + +All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. + +8. Termination. + +You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). + +However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. + +Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. + +9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. + +10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. + +An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. + +11. Patents. + +A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”. + +A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. + +In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. + +If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. + +A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. + +12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. + +13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. + +14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. + +Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. + +15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. + +END OF TERMS AND CONDITION \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..9e46240 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# gopherden: Gopher Protocol BBS + +An anonymous, ephemeral text bulletin board system for the Gopher Protocol written in Haskell. + +## Try it out + +Run the server: + +``` +cabal run . -- launch +``` + +Visit the gopherhole: + +``` +gopher -p "/" localhost 7000 +``` + +Here are some commands related to banning: + + * `cabal run . -- ban --post 1 --delete --reason "rule violation"`: ban user for post #1 and delete said post for the `--reason` supplied. + * `cabal run . -- unban --ip someipv6addr`: remove the ipv6 address from the ban table + +## Features + + * View threads as an ASCII-art text file + * Navigate the board as a menu + * Post threads and replies + * Ban system + +## Features probably coming soon + + * Currently has a `Config.hs` with many configurable parameters. Coming soon is a config + file to set these parameters. This also allows for internationalization. This config + file will also allow you to set some server parameters. + * Text wrapping + * Captcha-like system + * Build with nix + * Debian package + systemd daemon \ No newline at end of file diff --git a/app/Main.hs b/app/Main.hs new file mode 100644 index 0000000..f2cdfd5 --- /dev/null +++ b/app/Main.hs @@ -0,0 +1,4 @@ +import CLI + +main :: IO () +main = entryPoint \ No newline at end of file diff --git a/gopherden.cabal b/gopherden.cabal new file mode 100644 index 0000000..70901fb --- /dev/null +++ b/gopherden.cabal @@ -0,0 +1,65 @@ +cabal-version: 1.12 + +-- This file has been generated from package.yaml by hpack version 0.36.0. +-- +-- see: https://github.com/sol/hpack + +name: gopherden +version: 0.5.0.0 +description: Please see the README on GitHub at +homepage: https://github.com/someodd/gopherden#readme +bug-reports: https://github.com/someodd/gopherden/issues +author: Someodd +maintainer: someodd@pm.me +copyright: 2024 Someodd +license: BSD3 +license-file: LICENSE +build-type: Simple +extra-source-files: + README.md + CHANGELOG.md + +source-repository head + type: git + location: https://github.com/someodd/gopherden + +executable gopherden-exe + main-is: Main.hs + other-modules: + Paths_gopherden + hs-source-dirs: + app + ghc-options: -Wall -Wcompat -Widentities -Wincomplete-record-updates -Wincomplete-uni-patterns -Wmissing-export-lists -Wmissing-home-modules -Wpartial-fields -Wredundant-constraints -threaded -rtsopts -with-rtsopts=-N + build-depends: + base, + gopherden, + spacecookie + default-language: GHC2021 + +library + exposed-modules: + Config, + Database, + Handle, + Server, + MenuViews, + MenuBuild, + TextViews, + TextBuild, + ViewHelpers, + CLI + other-modules: + Paths_gopherden + 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 + build-depends: + base, + spacecookie, + optparse-applicative, + bytestring, + postgresql-simple, + regex-posix, + time + default-language: GHC2021 + --default-language: Haskell2010 \ No newline at end of file diff --git a/src/CLI.hs b/src/CLI.hs new file mode 100644 index 0000000..112f4bb --- /dev/null +++ b/src/CLI.hs @@ -0,0 +1,77 @@ +{- | Command line interface. + +-} +{-# LANGUAGE OverloadedStrings #-} + +module CLI (entryPoint) where + +import Server (runServer) +import Database (banIP, unbanIP, listBannedIPs) + +import Options.Applicative + +-- Some say partials are bad, but I'm lazy and I frankly just generate a lot of the CLI stuff. +data Command + = LaunchServer + | BanIP { postId :: Integer, reason :: String, deletePost :: Bool } + | UnbanIP { ipAddr :: String } + | ListBans + +parseListBans :: Parser Command +parseListBans = pure ListBans + +parseLaunchServer :: Parser Command +parseLaunchServer = pure LaunchServer + +parseUnbanIP :: Parser Command +parseUnbanIP = UnbanIP + <$> strOption + ( long "ip" + <> metavar "IPADDRESS" + <> help "IP address to unban" ) + +parseBanIP :: Parser Command +parseBanIP = BanIP + <$> option auto + ( long "post" + <> metavar "POSTID" + <> help "ID of the post associated with the IP to ban" ) + <*> strOption + ( long "reason" + <> metavar "REASON" + <> help "Reason for banning the IP" ) + <*> switch + ( long "delete" + <> help "Delete the post as well as banning the IP" ) + +entryPoint :: IO () +entryPoint = runCLI =<< execParser opts + where + opts = info (commands <**> helper) + ( fullDesc + <> progDesc "Run server or ban an IP" + <> header "server-cli - a simple CLI for managing your server" ) + +commands :: Parser Command +commands = subparser + ( command "launch" (info parseLaunchServer (progDesc "Launch the server")) + <> command "ban" (info parseBanIP (progDesc "Ban an IP by post ID")) + <> command "unban" (info parseUnbanIP (progDesc "Unban an IP address")) + <> command "list_bans" (info parseListBans (progDesc "List all banned IPs")) + ) + +runCLI :: Command -> IO () +runCLI LaunchServer = runServer +runCLI (BanIP postId reason delete) = do + putStrLn $ "Banning IP for post: " ++ show postId ++ " for reason: " ++ reason + banIP postId reason delete + putStrLn "Done." +runCLI (UnbanIP ipAddr) = do + putStrLn $ "Unbanning IP: " ++ ipAddr + unbanIP ipAddr + putStrLn "IP unbanned successfully." +runCLI ListBans = do + putStrLn "Listing all banned IPs:" + bannedIPs <- listBannedIPs + mapM_ (\(ip, reason) -> putStrLn $ ip ++ " - " ++ reason) bannedIPs + diff --git a/src/Config.hs b/src/Config.hs new file mode 100644 index 0000000..af7033f --- /dev/null +++ b/src/Config.hs @@ -0,0 +1,175 @@ +{- | Customization options and possibly internationalization. + +Language/internationalization options begin with `language`. + +Style settings begin with `style` (or will soon in the future). + +-} + +module Config where + +maximumPostLength = undefined + + + +maximumRepliesPerThread = 10 + +maximumThreads :: Integer +maximumThreads = 10 + +-- | The max width used for wrapping infolines when converting blocks of texts into info +-- lines. UNIMPLEMENTED +maxWidth = 50 + +-- COMMON/SHARED + +-- | The text to view an item as a file. +languageViewAsFile :: String +languageViewAsFile = "View as File" + +-- | The text to view an item as a menu. +languageViewAsMenu :: String +languageViewAsMenu = "View as Menu" + +-- | The text to display when a user was banned for a post. +languageUserWasBannedForThisPost :: String +languageUserWasBannedForThisPost = "USER WAS BANNED FOR THIS POST" + +-- ERRORS ("FRONTEND") + +-- | The text to display to a user as an error when they try to post and are banned, the +-- text which follows is the actual ban reason/message. +languageYouWereBannedLabel :: String +languageYouWereBannedLabel = "You were banned. Reason: " + +-- | Ambiguous error/post insertion failure. +languageFailedToInsertPost :: String +languageFailedToInsertPost = "Failed to insert post." + +-- CLI + +-- | Text to display when successfully delted a thread by id (the actual post ID will follow). +languageDeletedThreadWithId :: String +languageDeletedThreadWithId = "Deleted thread with ID: " + +-- | The text to display upon successfully unbanning an IPv6 address. +languageIpUnbannedSuccess :: String +languageIpUnbannedSuccess = "IP unbanned successfully: " + +-- | If trying to ban a post and the post is not found or the IP is missing, this is the error message. +languagePostNotFoundOrIpMissing :: String +languagePostNotFoundOrIpMissing = "Post not found or IP missing." + +-- | The success message for adding a given IPv6 address to the ban list. Following is the actual IP address. +languageIpBannedSuccessfully :: String +languageIpBannedSuccessfully = "IP banned successfully: " + +-- FILE VIEWS: THREAD VIEW + +fileThreadOpBorderHorizontal :: Char +fileThreadOpBorderHorizontal = '=' + +fileThreadOpBorderVertical :: Char +fileThreadOpBorderVertical = '#' + +fileThreadOpBorderCorner :: Char +fileThreadOpBorderCorner = '@' + +fileThreadOpMinimumWidth :: Int +fileThreadOpMinimumWidth = 40 + +fileThreadOpMaximumWidth :: Int +fileThreadOpMaximumWidth = 69 + +fileThreadOpPadding :: Int +fileThreadOpPadding = 2 + +fileThreadReplyBorderHorizontal :: Char +fileThreadReplyBorderHorizontal = '-' + +fileThreadReplyBorderVertical :: Char +fileThreadReplyBorderVertical = '|' + +fileThreadReplyBorderCorner :: Char +fileThreadReplyBorderCorner = '+' + +fileThreadReplyMinimumWidth :: Int +fileThreadReplyMinimumWidth = 40 + +fileThreadReplyMaximumWidth :: Int +fileThreadReplyMaximumWidth = 69 + +fileThreadReplyPadding :: Int +fileThreadReplyPadding = 2 + +-- MENU VIEWS: INDEX VIEW + +indexReplyLeadingBreak = True + +indexReplyTrailingBreak = False + +-- | The left side of the heading for the original post in the index view. +indexOpHeadingDecorLeft :: String +indexOpHeadingDecorLeft = "### " + +-- | The right side of the heading for the original post in the index view. +indexOpHeadingDecorRight :: String +indexOpHeadingDecorRight = " ###" + +-- | The threshold for the number of replies in a thread before they are omitted from the index view. +ommittedRepliesThreshold :: Integer +ommittedRepliesThreshold = 3 + +languageThreadIndexOpNumberLabel :: String +languageThreadIndexOpNumberLabel = "No. " + +languageSingleReplyOmitted :: String +languageSingleReplyOmitted = "1 reply omitted, view thread to see it." + +-- | In the index view a threads replies are omitted from the view if there's more than `n`. +languagePluralRepliesOmitted :: String +languagePluralRepliesOmitted = " replies omitted, view thread to see them all." + +-- | The text for the index search item used to creating a new thread. +languageCreateThread :: String +languageCreateThread = "Create Thread" + +-- | Feel free to use \n! Use ASCII art or whatever! Displayed at the top of the thread index. +indexPreamble :: String +indexPreamble = "Welcome to the Gopher Den!" + +-- | The left side of the heading for a reply in a thread view. +indexReplyHeadingDecorLeft :: String +indexReplyHeadingDecorLeft = "* " + +-- | The right side of the heading for a reply in a thread view. +indexReplyHeadingDecorRight :: String +indexReplyHeadingDecorRight = "" + +-- MENU VIEWS: THREAD VIEW + +-- | The text/link/query item for for replying to a thread. +languageThreadReply :: String +languageThreadReply = "Reply to Thread" + +-- | The text for the directory item that links back to the index view. +languageReturnToIndex :: String +languageReturnToIndex = "Return to Index" + +-- | The left side of the heading for the original post in a thread view. +threadOpHeadingDecorLeft :: String +threadOpHeadingDecorLeft = "### " + +-- | The right side of the heading for the original post in a thread view. +threadOpHeadingDecorRight :: String +threadOpHeadingDecorRight = " ###" + +-- | The label for the thread number in a thread view. +threadOpThreadNumberLabel :: String +threadOpThreadNumberLabel = "Viewing Thread #" + +threadReplyNumberLabel :: String +threadReplyNumberLabel = "Reply #" + +threadReplyHeadingDecorLeft :: String +threadReplyHeadingDecorLeft = "---" diff --git a/src/Database.hs b/src/Database.hs new file mode 100644 index 0000000..9803fdc --- /dev/null +++ b/src/Database.hs @@ -0,0 +1,200 @@ +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE OverloadedRecordDot #-} +{-# LANGUAGE DuplicateRecordFields #-} + +module Database where + +import Database.PostgreSQL.Simple +import Database.PostgreSQL.Simple.ToField +import Database.PostgreSQL.Simple.ToRow +import Control.Exception (bracket) +import Control.Monad (when) +import Data.Maybe (listToMaybe) +import Database.PostgreSQL.Simple.FromRow +import Data.Time (LocalTime) + + +import Config +import Data.Functor (void) + +-- FIXME: just define PostDB +data PostInsert = PostInsert { + message :: String, + replyTo :: Maybe Integer, + postIP :: String -- New field for IP address +} deriving (Show) + +data PostDB = PostDB { + postId :: Integer, + message :: String, + replyTo :: Maybe Integer, + postIP :: String, + createdAt :: LocalTime, + bannedForPost :: Bool +} deriving (Show) + +-- FIXME: could all be more generic, right? +-- Making Post an instance of ToRow to facilitate insertion +-- Adjust the ToRow instance to include the new fields +instance ToRow PostInsert where + toRow p = [toField (p.message), toField (p.replyTo), toField (p.postIP)] + +instance FromRow PostDB where + fromRow = PostDB <$> field <*> field <*> field <*> field <*> field <*> field + +-- Function to connect to your specific database +connectDb :: IO Connection +connectDb = connect defaultConnectInfo { + connectHost = "localhost", + connectPort = 5432, + connectUser = "your_username", + connectPassword = "your_password", + connectDatabase = "your_database" +} + +-- Function to get all threads, sorted by the freshest activity +getThreadsSortedByFreshest :: IO [PostDB] +getThreadsSortedByFreshest = bracket connectDb close $ \conn -> do + query_ conn $ + "WITH ThreadActivity AS ( \ + \ SELECT \ + \ COALESCE(replyTo, id) AS thread_id, \ + \ MAX(id) OVER (PARTITION BY COALESCE(replyTo, id)) AS max_id \ + \ FROM app_schema.posts \ + \), RankedThreads AS ( \ + \ SELECT \ + \ thread_id, \ + \ RANK() OVER (ORDER BY max_id DESC) \ + \ FROM ThreadActivity \ + \ GROUP BY thread_id, max_id \ + \) \ + \SELECT p.id, p.message, p.replyTo, p.postIP, p.createdAt, p.bannedForPost \ + \FROM app_schema.posts p \ + \JOIN RankedThreads rt ON p.id = rt.thread_id \ + \WHERE p.replyTo IS NULL \ + \ORDER BY rt.rank" :: IO [PostDB] + +-- Function to check and maintain the maximum number of threads +maintainMaximumThreads :: IO () +maintainMaximumThreads = bracket connectDb close $ \conn -> do + -- Count the number of threads (posts with replyTo IS NULL) + [Only threadCount] <- query_ conn "SELECT COUNT(*) FROM app_schema.posts WHERE replyTo IS NULL" :: IO [Only Integer] + when (threadCount > maximumThreads) $ do + -- Find the thread with the smallest ID (oldest thread) + [Only smallestThreadId] <- query_ conn "SELECT id FROM app_schema.posts WHERE replyTo IS NULL ORDER BY id ASC LIMIT 1" :: IO [Only Integer] + -- Delete all replies to the thread about to be deleted. not needed because cascade. FIXME + --execute conn "DELETE FROM posts WHERE replyTo = ?" (Only smallestThreadId) + -- Delete the thread with the smallest ID + execute conn "DELETE FROM app_schema.posts WHERE id = ?" (Only smallestThreadId) + putStrLn $ languageDeletedThreadWithId ++ show smallestThreadId + +-- Counts the number of replies to a given thread ID +countReplies :: Integer -> IO Int +countReplies threadId = bracket connectDb close $ \conn -> do + [Only count] <- query conn "SELECT COUNT(*) FROM app_schema.posts WHERE replyTo = ?" (Only threadId) :: IO [Only Int] + return count + +{- | Get three latest replies to a given thread, but return them in ascending order (freshest last). + +-} +getThreeLatestReplies :: Integer -> IO [PostDB] +getThreeLatestReplies threadId = bracket connectDb close $ \conn -> do + query conn "SELECT id, message, replyTo, postIP, createdAt, bannedForPost FROM ( \ + \SELECT id, message, replyTo, postIP, createdAt, bannedForPost \ + \FROM app_schema.posts \ + \WHERE replyTo = ? \ + \ORDER BY id DESC \ + \LIMIT 3) AS latest_replies \ + \ORDER BY id ASC" (Only threadId) :: IO [PostDB] + + +-- Function to insert a new Post into the database +insertPost :: PostInsert -> IO (Either String Integer) +insertPost post = bracket connectDb close $ \conn -> do + -- Check if the postIP is in the banned_ips table + bannedIps <- query conn "SELECT reason FROM app_schema.banned_ips WHERE ip = ?" (Only (post.postIP)) :: IO [Only String] + if null bannedIps + then do + -- IP is not banned, proceed with insertion + result <- query conn "INSERT INTO app_schema.posts (message, replyTo, postIP) VALUES (?, ?, ?) RETURNING id" post :: IO [Only Integer] + case result of + [Only i] -> return $ Right i + _ -> return $ Left languageFailedToInsertPost + else return $ Left $ languageYouWereBannedLabel ++ (fromOnly $ head bannedIps) + +-- Function to get a thread by ID (replyTo must be NULL) +getThreadById :: Integer -> IO (Maybe PostDB) +getThreadById postId = bracket connectDb close $ \conn -> do + -- Query to select the post where id matches and replyTo is NULL + posts <- query conn "SELECT id, message, replyTo, postIP, createdAt, bannedForPost FROM app_schema.posts WHERE id = ? AND replyTo IS NULL" (Only postId) :: IO [PostDB] + -- Convert the list to Maybe Post (Nothing if the list is empty, Just post if not) + return $ listToMaybe posts + +-- Function to get all replies to a specific thread ID +getRepliesByThreadId :: Integer -> IO [PostDB] +getRepliesByThreadId threadId = bracket connectDb close $ \conn -> do + -- Query to select all posts where replyTo matches the given thread ID + query conn "SELECT id, message, replyTo, postIP, createdAt, bannedForPost FROM app_schema.posts WHERE replyTo = ?" (Only threadId) :: IO [PostDB] + +-- Function to get all original threads +getAllThreads :: IO [PostDB] +getAllThreads = bracket connectDb close $ \conn -> do + -- Query to select all posts where replyTo is NULL + query_ conn "SELECT id, message, replyTo, postIP, createdAt, bannedForPost FROM app_schema.posts WHERE replyTo IS NULL" :: IO [PostDB] + +banIP :: Integer -> String -> Bool -> IO () +banIP postId reason delete = bracket connectDb close $ \conn -> do + -- Fetch the post's IP using postId + post <- query conn "SELECT postIP FROM app_schema.posts WHERE id = ?" (Only postId) :: IO [Only String] + case post of + [Only ip] -> do + -- Insert into banned_ips (assume reason is a placeholder here) + execute conn "INSERT INTO app_schema.banned_ips (ip, reason) VALUES (?, ?) ON CONFLICT (ip) DO NOTHING" (ip, reason) + if delete + then -- Delete the post + void $ execute conn "DELETE FROM app_schema.posts WHERE id = ?" (Only postId) + else -- Mark the post as bannedForPost + void $ execute conn "UPDATE app_schema.posts SET bannedForPost = TRUE WHERE id = ?" (Only postId) + putStrLn $ languageIpBannedSuccessfully ++ ip + _ -> putStrLn languagePostNotFoundOrIpMissing + +-- Function to unban an IP +unbanIP :: String -> IO () +unbanIP ip = bracket connectDb close $ \conn -> do + -- Remove the IP from the banned_ips table + void $ execute conn "DELETE FROM app_schema.banned_ips WHERE ip = ?" (Only ip) + + -- Optionally, reset the bannedForPost flag for posts associated with this IP + -- This step depends on your application's logic and whether you want to retain + -- the information that a post was once associated with a banned IP. + void $ execute conn "UPDATE app_schema.posts SET bannedForPost = FALSE WHERE postIP = ?" (Only ip) + + putStrLn $ languageIpUnbannedSuccess ++ ip + +-- Assuming the import of necessary modules and definitions above +listBannedIPs :: IO [(String, String)] +listBannedIPs = bracket connectDb close $ \conn -> do + query_ conn "SELECT ip, reason FROM app_schema.banned_ips" :: IO [(String, String)] + + +initializeDatabase :: IO () +initializeDatabase = bracket connectDb close $ \conn -> do + execute_ conn "CREATE SCHEMA IF NOT EXISTS app_schema;" + execute_ conn "SET search_path TO app_schema;" + + let createPostsTableSQL = "CREATE TABLE IF NOT EXISTS app_schema.posts (\ + \id SERIAL PRIMARY KEY, \ + \message VARCHAR(240) NOT NULL, \ + \replyTo INTEGER, \ + \postIP VARCHAR(60), \ + \createdAt TIMESTAMP WITHOUT TIME ZONE DEFAULT NOW() NOT NULL, \ + \bannedForPost BOOLEAN DEFAULT FALSE, \ + \FOREIGN KEY (replyTo) REFERENCES posts(id) ON DELETE CASCADE)" + execute_ conn createPostsTableSQL + + let createBannedIPsTableSQL = "CREATE TABLE IF NOT EXISTS app_schema.banned_ips (\ + \ip VARCHAR(60) PRIMARY KEY, \ + \reason TEXT)" + execute_ conn createBannedIPsTableSQL + + putStrLn "Database initialized: Tables created or already exist in app_schema." diff --git a/src/Handle.hs b/src/Handle.hs new file mode 100644 index 0000000..a53bd0a --- /dev/null +++ b/src/Handle.hs @@ -0,0 +1,182 @@ +-- FIXME: better naming convention. +{- | Handle Gopher Protocol requests. + +-} + +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE OverloadedRecordDot #-} +{-# LANGUAGE DuplicateRecordFields #-} +module Handle where + +import Database +import MenuBuild +import Config +import MenuViews +import TextViews + +import Control.Exception (SomeException, catch) +import Data.ByteString.Char8 qualified as BC +import Data.ByteString.Lazy qualified as B +import Data.Char (isAlphaNum, isSpace) +import Data.List (intercalate, isPrefixOf) +import Data.Maybe (fromMaybe, listToMaybe) +import GHC.Generics (Generic) +import Network.Gopher hiding (GopherFileType (..), GopherMenuItem (..)) +import Network.Gopher qualified as Gopher (GopherFileType (..), GopherMenuItem (..)) +import Text.Regex.Posix +import Data.Maybe (listToMaybe) +import Data.List (isSuffixOf) +import Data.Word (Word16) +import Text.Printf (printf) +import Data.List (intercalate) + + +-- Define a data type for the different actions +data Action = ThreadIndex + | NewThread + | ViewThreadMenu Integer + | ViewThreadFile Integer + | ReplyToThread Integer + | ViewReplyFile Integer Integer + | ViewReplyMenu Integer Integer + | ReplyToReply Integer Integer + deriving (Show) + +-- Function to extract numbers from a string +extractNumbers :: String -> [Integer] +extractNumbers input = map read $ getAllTextMatches $ input =~ ("[0-9]+" :: String) :: [Integer] + +{- | Returns the "parts" of a selector we are concerned with. + +There are only a few allowed selectors with associated actions + + - `/` - the thread index + - `/newthread` - query for creating a new thread. + - `//menu` - for simply viewing the thread and all its replies as a menu + - `//file` - for viewing the thread and all its replies as a text file + - `//reply` - for replying to the thread with a query + - `///file` - for viewing a reply as a text file. + - `///menu` - for viewing a reply as a menu. + - `///reply - reply to a reply (quotes) + +Note that threads and replies share the same ID system--a post is a post, kinda. + +-} +decipherSelector :: String -> Maybe Action +decipherSelector selector = case selector of + "/" -> Just ThreadIndex + "/newthread" -> Just NewThread + _ -> case extractNumbers selector of + [threadNum] -> case () of + _ | "/menu" `isSuffixOf` selector -> Just $ ViewThreadMenu threadNum + | "/file" `isSuffixOf` selector -> Just $ ViewThreadFile threadNum + | "/reply" `isSuffixOf` selector -> Just $ ReplyToThread threadNum + | otherwise -> Nothing + [threadNum, replyNum] -> case () of + _ | "/file" `isSuffixOf` selector -> Just $ ViewReplyFile threadNum replyNum + | "/menu" `isSuffixOf` selector -> Just $ ViewReplyMenu threadNum replyNum + | "/reply" `isSuffixOf` selector -> Just $ ReplyToReply threadNum replyNum + | otherwise -> Nothing + _ -> Nothing + +-- | Things prefixed by "view*Of" are a view for something. they create responses. +viewMenuOfThread :: Integer -> IO GopherResponse +viewMenuOfThread threadId = do + maybeThread <- getThreadById threadId + case maybeThread of + Just post -> do + replies <- getRepliesByThreadId threadId + return $ MenuResponse $ menuViewThread post replies + Nothing -> + return $ ErrorResponse $ BC.pack $ "There is no thread #" ++ show threadId + +{- | Handle creating a response in the form of a text file representing a thread view. + +-} +handleThreadFile :: Integer -> IO GopherResponse +handleThreadFile threadId = do + maybeThread <- getThreadById threadId + case maybeThread of + Just post -> do + replies <- getRepliesByThreadId threadId + return $ FileResponse $ BC.pack $ textViewThread post replies + Nothing -> do + print "print is not thread?!" + return $ ErrorResponse $ BC.pack $ "There is no thread #" ++ show threadId + +-- | Things prefixed by "handleQuery" directly are responding to a request of a broken down selector... +handleQueryNewThread :: GopherRequest -> IO GopherResponse +handleQueryNewThread request = do + case requestSearchString request of + Just queryPartTheMessage -> do + -- may throw error if too long! fixme to return error if so... return (ErrorResponse $ BC.pack "Client sent an empty query.") + newThreadIdOrFailure <- insertPost $ PostInsert (BC.unpack queryPartTheMessage) Nothing (tupleToIPv6String $ requestClientAddr request) + case newThreadIdOrFailure of + Right newThreadId -> + viewMenuOfThread newThreadId + Left failureMessage -> + return (ErrorResponse $ BC.pack failureMessage) + Nothing -> + return (ErrorResponse $ BC.pack "Client sent an empty query.") -- FIXME: should be a gophermap! + +-- Converts a Word16 value to a 4-character hexadecimal string +word16ToHex :: Word16 -> String +word16ToHex = printf "%04x" + +-- Converts a tuple representing an IPv6 address into its string representation +tupleToIPv6String :: (Word16, Word16, Word16, Word16, Word16, Word16, Word16, Word16) -> String +tupleToIPv6String (w1, w2, w3, w4, w5, w6, w7, w8) = + intercalate ":" $ map word16ToHex [w1, w2, w3, w4, w5, w6, w7, w8] + +-- no validation that replying to real thread? +-- | Things prefixed by "handleQuery" directly are responding to a request of a broken down selector... +handleQueryReplyToThread :: Integer -> GopherRequest -> IO GopherResponse +handleQueryReplyToThread threadId request = do + case requestSearchString request of + Just queryPartTheMessage -> do + -- may throw error if too long! fixme to return error if so... return (ErrorResponse $ BC.pack "Client sent an empty query.") + postIdOrFailure <- insertPost $ PostInsert (BC.unpack queryPartTheMessage) (Just threadId) (tupleToIPv6String $ requestClientAddr request) + case postIdOrFailure of + Right _ -> + viewMenuOfThread threadId + Left failureMessage -> + return (ErrorResponse $ BC.pack failureMessage) + Nothing -> + return (ErrorResponse $ BC.pack "Client sent an empty query.") -- FIXME: should be a gophermap! + +handleThreadIndex :: IO GopherResponse +handleThreadIndex = do + threadPosts <- getThreadsSortedByFreshest + threadIndex <- menuViewIndex threadPosts + return $ MenuResponse $ threadIndex + +handler :: GopherRequest -> IO GopherResponse +handler request = do + let selector = BC.unpack $ requestSelector request + case decipherSelector selector of + Just (ThreadIndex) -> do + handleThreadIndex + Just (NewThread) -> + handleQueryNewThread request + Just (ViewThreadMenu threadNumber) -> + -- handleViewThreadMenu postNumber + viewMenuOfThread threadNumber + Just (ViewThreadFile threadNumber) -> + handleThreadFile threadNumber + Just (ReplyToThread threadNumber) -> + handleQueryReplyToThread threadNumber request + --return (ErrorResponse $ BC.pack "Not yet implemented.") + Just (ViewReplyFile threadNumber replyNumber) -> + --handleViewReplyFile threadNumber replyNumber + return (ErrorResponse $ BC.pack "Not yet implemented.") + Just (ViewReplyMenu threadNumber replyNumber) -> + --handleViewReplyMenu threadNumber replyNumber + return (ErrorResponse $ BC.pack "Not yet implemented.") + Just (ReplyToReply threadNumber replyNumber) -> + --handleQueryReplyToReply threadNumber replyNumber request + return (ErrorResponse $ BC.pack "Not yet implemented.") + Nothing -> + return (ErrorResponse $ BC.pack $ "Invalid request:" ++ show selector) \ No newline at end of file diff --git a/src/MenuBuild.hs b/src/MenuBuild.hs new file mode 100644 index 0000000..cd2cccf --- /dev/null +++ b/src/MenuBuild.hs @@ -0,0 +1,126 @@ +{- | Tools for constructing Gopher menus. + +-} + +module MenuBuild where + +import Network.Gopher hiding (GopherFileType (..), GopherMenuItem (..)) +import Network.Gopher qualified as Gopher (GopherFileType (..), GopherMenuItem (..)) +import Data.ByteString.Char8 qualified as BC +import Data.List (intercalate, isPrefixOf) +import Data.Maybe (fromMaybe) + +toGopherMenuItems :: [GopherLine] -> [Gopher.GopherMenuItem] +toGopherMenuItems = map (\(GopherLine itemType menuText selector maybeServerName maybePort) -> Gopher.Item (toGopherFileType itemType) (BC.pack menuText) (BC.pack selector) (BC.pack <$> maybeServerName) (read <$> maybePort)) + +toGopherFileType :: ItemType -> Gopher.GopherFileType +toGopherFileType itemType = case itemType of + File -> Gopher.File + Directory -> Gopher.Directory + PhoneBookServer -> Gopher.PhoneBookServer + Error -> Gopher.Error + BinHexMacintoshFile -> Gopher.BinHexMacintoshFile + DOSArchive -> Gopher.DOSArchive + UnixUuencodedFile -> Gopher.UnixUuencodedFile + IndexSearchServer -> Gopher.IndexSearchServer + TelnetSession -> Gopher.TelnetSession + BinaryFile -> Gopher.BinaryFile + RedundantServer -> Gopher.RedundantServer + Tn3270Session -> Gopher.Tn3270Session + GifFile -> Gopher.GifFile + ImageFile -> Gopher.ImageFile + InfoLine -> Gopher.InfoLine + Html -> Gopher.Html + +data ItemType + = File + | Directory + | PhoneBookServer + | Error + | BinHexMacintoshFile + | DOSArchive + | UnixUuencodedFile + | IndexSearchServer + | TelnetSession + | BinaryFile + | RedundantServer + | Tn3270Session + | GifFile + | ImageFile + | InfoLine + | Html + deriving (Eq, Ord, Enum) + +instance Show ItemType where + show item = case item of + File -> "0" + Directory -> "1" + PhoneBookServer -> "2" + Error -> "3" + BinHexMacintoshFile -> "4" + DOSArchive -> "5" + UnixUuencodedFile -> "6" + IndexSearchServer -> "7" + TelnetSession -> "8" + BinaryFile -> "9" + RedundantServer -> "+" + Tn3270Session -> "T" + GifFile -> "g" + ImageFile -> "I" + InfoLine -> "i" + Html -> "h" + +{- | A GopherMenuItem is a line in a gopher menu/directory. + +I use this for building the dashboard. + +File type, menu text, selector, server name (optional), port (optional). + +None of the fields may use tabs. +-} +data GopherLine = GopherLine ItemType String String (Maybe String) (Maybe String) + +instance Show GopherLine where + show (GopherLine itemType menuText selector maybeServerName maybePort) = + show itemType ++ intercalate "\t" [menuText, selector, fromMaybe "" maybeServerName, fromMaybe "" maybePort] + +menuBuildHeading :: String -> GopherLine +menuBuildHeading title = GopherLine InfoLine ("### " ++ title ++ " ###") "" Nothing Nothing + +menuBuildHeadingParticular :: String -> String -> String -> Bool -> Bool -> [GopherLine] +menuBuildHeadingParticular title decorLeft decorRight leadingBreak trailingBreak = do + (if leadingBreak then [menuBuildBlankLine] else []) ++ [GopherLine InfoLine (decorLeft ++ title ++ decorRight) "" Nothing Nothing] ++ (if trailingBreak then [menuBuildBlankLine] else []) + +menuBuildQueryLine :: String -> String -> GopherLine +menuBuildQueryLine string selector = GopherLine IndexSearchServer string selector Nothing Nothing + +menuBuildMenuLine :: String -> String -> GopherLine +menuBuildMenuLine label selector = GopherLine Directory label selector Nothing Nothing + +menuBuildFileLine :: String -> String -> GopherLine +menuBuildFileLine label selector = GopherLine File label selector Nothing Nothing + +menuBuildBlankLine :: GopherLine +menuBuildBlankLine = GopherLine InfoLine "" "" Nothing Nothing + +menuBuildSection :: Bool -> String -> Maybe [GopherLine] -> [GopherLine] -> [GopherLine] +menuBuildSection leadingNewLine sectionName maybePreambleList menuItems = + [menuBuildBlankLine | leadingNewLine] + ++ [menuBuildHeading sectionName] + ++ fromMaybe [] maybePreambleList + ++ menuItems + +menuBuildInfoLine :: String -> GopherLine +menuBuildInfoLine string = GopherLine InfoLine string "" Nothing Nothing + +menuBuildInfoLines :: String -> [GopherLine] +menuBuildInfoLines = map menuBuildInfoLine . lines + +menuBuildInfoLinesQuoted :: String -> [GopherLine] +menuBuildInfoLinesQuoted = map menuBuildInfoLine . map (">" ++) . lines + +data GopherMenu = GopherMenu [GopherLine] + +instance Show GopherMenu where + show (GopherMenu lines) = intercalate "\n" $ map show lines + diff --git a/src/MenuViews.hs b/src/MenuViews.hs new file mode 100644 index 0000000..fa37c58 --- /dev/null +++ b/src/MenuViews.hs @@ -0,0 +1,129 @@ +{- | Gophermap/menu presentations. + +Creates a Gopher menu that can be used as a response to a Gopher request. + +Relatedly, please see the `Build` module. + +The "menu views" that get exported should have a type of `[Gopher.GopherMenuItem]` or similar. + +This also contains gopher menu representations of `PostDB` in certain contexts (functions starting with `menuRepresent`). + +Only exports menu views, which are indicated by function names beginning with `menuView`. + +-} +{-# LANGUAGE OverloadedRecordDot #-} +{-# LANGUAGE DuplicateRecordFields #-} + +module MenuViews + ( menuViewIndex + , menuViewThread + ) where + +import Network.Gopher qualified as Gopher (GopherMenuItem (..)) + +import ViewHelpers +import Database +import MenuBuild +import Config +import qualified MenuBuild as Gopher + +{- | A helper function for displaying the `userWasBannedForThisPost` message. + +-} +wasBannedHelper :: Bool -> [GopherLine] +wasBannedHelper True = menuBuildInfoLines languageUserWasBannedForThisPost +wasBannedHelper False = menuBuildInfoLines "" + +{- | A menu representation of a `PostDB` original/top/first post for the thread view. + +Not a reply. + +-} +menuRepresentOriginalPost :: PostDB -> [Gopher.GopherMenuItem] +menuRepresentOriginalPost post = + let + threadHeading = menuBuildHeadingParticular (threadOpThreadNumberLabel ++ show post.postId) threadOpHeadingDecorLeft threadOpHeadingDecorRight False False + threadMessage = menuBuildInfoLines post.message + wasBanned = wasBannedHelper post.bannedForPost + in + toGopherMenuItems $ threadHeading ++ threadMessage ++ wasBanned + +{- | A menu representation of a `PostDB` reply for the thread view. + +-} +menuRepresentThreadReply :: PostDB -> [Gopher.GopherMenuItem] +menuRepresentThreadReply post = + let + replyHeading = menuBuildHeadingParticular (threadReplyNumberLabel ++ show post.postId) threadReplyHeadingDecorLeft "" False False + replyMessage = menuBuildInfoLines post.message + in + toGopherMenuItems $ replyHeading ++ replyMessage + +{- | A menu representation of a `PostDB` reply for the index view. + +-} +menuRepresentIndexReply :: PostDB -> [Gopher.GopherMenuItem] +menuRepresentIndexReply post = + let + replyMeta = ("No. " ++ show post.postId) ++ ", " ++ show post.createdAt + replyHeading = menuBuildHeadingParticular replyMeta indexReplyHeadingDecorLeft indexReplyHeadingDecorRight indexReplyLeadingBreak indexReplyTrailingBreak + replyMessage = menuBuildInfoLines post.message + in + toGopherMenuItems $ replyHeading ++ replyMessage + +{- | Menu view for a thread, displaying the original post and all of its replies. + +-} +menuViewThread :: PostDB -> [PostDB] -> [Gopher.GopherMenuItem] +menuViewThread post replies = + let + originalPostLines = menuRepresentOriginalPost post + repliesLines = concatMap menuRepresentThreadReply replies + -- fromJust here bad?! this kind of sucks very bad type handling or whatever + createReply = toGopherMenuItems $ [menuBuildQueryLine languageThreadReply ("/" ++ show post.postId ++ "/reply")] + returnToIndex = toGopherMenuItems [menuBuildMenuLine languageReturnToIndex "/"] + viewThreadFileLink = toGopherMenuItems [menuBuildFileLine languageViewAsFile ("/" ++ show post.postId ++ "/file")] + in + originalPostLines ++ repliesLines ++ createReply ++ viewThreadFileLink ++ returnToIndex + +{- | Menu view for the thread index, displaying each thread and the latest three replies +for each, along with how many replies were omitted. + +-} +menuViewIndex :: [PostDB] -> IO [Gopher.GopherMenuItem] +menuViewIndex posts = do + summaries <- concatMapM menuRepresentIndexThreadSummary posts + let + preamble = toGopherMenuItems $ menuBuildInfoLines indexPreamble + newThread = toGopherMenuItems [menuBuildQueryLine languageCreateThread "/newthread"] + + pure $ preamble ++ summaries ++ newThread + +concatMapM f xs = concat <$> traverse f xs + +{- | Basic template logic for the "replies omitted" message for the index. + +-} +repliesOmitted :: Int -> [GopherLine] +repliesOmitted omitted + | omitted == 1 = menuBuildInfoLines $ languageSingleReplyOmitted + | omitted > 1 = menuBuildInfoLines $ show omitted ++ languagePluralRepliesOmitted + | otherwise = [] + +{- | A representation of a `PostDB` (post from the database, namely a thread) for the index view. + +-} +menuRepresentIndexThreadSummary :: PostDB -> IO [Gopher.GopherMenuItem] +menuRepresentIndexThreadSummary post = do + replyCount <- countReplies post.postId + latestReplies <- getThreeLatestReplies post.postId + let + threadMetaInfo = helperPostMeta post + threadHeading = menuBuildHeadingParticular threadMetaInfo indexOpHeadingDecorLeft indexOpHeadingDecorRight True False + viewThreadMenuLink = menuBuildMenuLine languageViewAsMenu ("/" ++ show post.postId ++ "/menu") + viewThreadFileLink = menuBuildFileLine languageViewAsFile ("/" ++ show post.postId ++ "/file") + threadMessage = menuBuildInfoLines $ "\n" ++ post.message ++ "\n" + totalRepliesStatus = repliesOmitted $ replyCount - (length latestReplies) + latestRepliesLines = concatMap menuRepresentIndexReply latestReplies + + pure $ (toGopherMenuItems $ threadHeading ++ [viewThreadMenuLink, viewThreadFileLink] ++ threadMessage ++ totalRepliesStatus) ++ latestRepliesLines \ No newline at end of file diff --git a/src/Server.hs b/src/Server.hs new file mode 100644 index 0000000..0be39f3 --- /dev/null +++ b/src/Server.hs @@ -0,0 +1,15 @@ +module Server (runServer) where +import Handle +import Database +import Network.Gopher (runGopher, defaultConfig, cServerPort, cLogHandler, GopherLogHandler, fromGopherLogStr) + +logHandler :: GopherLogHandler +logHandler level str = do + putStr $ show level ++ ": " + putStrLn $ fromGopherLogStr str + +runServer :: IO () +runServer = do + _ <- initializeDatabase + putStrLn "Starting spacecookie server" + runGopher (defaultConfig { cServerPort = 7000, cLogHandler = Just logHandler }) handler \ No newline at end of file diff --git a/src/TextBuild.hs b/src/TextBuild.hs new file mode 100644 index 0000000..b858d6b --- /dev/null +++ b/src/TextBuild.hs @@ -0,0 +1,34 @@ +{- | Basically tools for building the ASCII art representations of things for a text file. + +-} +{-# LANGUAGE OverloadedRecordDot #-} +{-# LANGUAGE DuplicateRecordFields #-} +module TextBuild where + +{- | Create a fancy ASCII-art style text box for content. + +Features: + - Centered header (within the top border) + - Body + - ASCII art box; contents are enclosed in a border + - Configurable padding + - fileMinimumWidth + - fileMaximumWidth + - Configurable characters for the horizontal, vertical, and corner border components + +-} +textBuildBox :: String -> String -> Char -> Char -> Char -> Int -> Int -> Int -> String +textBuildBox header body horizontalBorder verticalBorder cornerDecor fileMinimumWidth fileMaximumWidth padding = + let bodyLines = lines body + initialBoxWidth = maximum (map length bodyLines) + (padding * 2) + 2 -- +2 for the vertical borders + boxWidth = max initialBoxWidth fileMinimumWidth + finalBoxWidth = min boxWidth fileMaximumWidth + headerSpace = finalBoxWidth - length header - 2 -- -2 for the corner decorations + leftHeaderPadding = (headerSpace `div` 2) + rightHeaderPadding = headerSpace - leftHeaderPadding + topBorder = cornerDecor : replicate leftHeaderPadding horizontalBorder ++ header ++ replicate rightHeaderPadding horizontalBorder ++ [cornerDecor] + bottomBorder = [cornerDecor] ++ replicate (finalBoxWidth - 2) horizontalBorder ++ [cornerDecor] + paddedBody = map (\line -> verticalBorder : ' ' : line ++ replicate (finalBoxWidth - length line - 4) ' ' ++ [' ', verticalBorder]) bodyLines + emptyLine = [verticalBorder] ++ replicate (finalBoxWidth - 2) ' ' ++ [verticalBorder] + in unlines (topBorder : emptyLine : paddedBody ++ [emptyLine, bottomBorder]) + diff --git a/src/TextViews.hs b/src/TextViews.hs new file mode 100644 index 0000000..d2d847d --- /dev/null +++ b/src/TextViews.hs @@ -0,0 +1,31 @@ +-- FIXME: rename FileViews? +{- | Text file presentations which are used as responses to Gopher requests. + +Represent things like index view and thread view. + +-} + +{-# LANGUAGE OverloadedRecordDot #-} +{-# LANGUAGE DuplicateRecordFields #-} +module TextViews + ( textViewThread + ) where + +import Database +import TextBuild +import Config +import ViewHelpers + +{- | Fancy text file presentation for a thread, displaying the original post and all of its replies. + +Lots of ASCII art involved. + +-} +textViewThread :: PostDB -> [PostDB] -> String +textViewThread op replies = + let + threadMetaInfo = helperPostMeta op + opBox = textBuildBox threadMetaInfo op.message fileThreadOpBorderHorizontal fileThreadOpBorderVertical fileThreadOpBorderCorner fileThreadOpMinimumWidth fileThreadOpMaximumWidth fileThreadOpPadding + replyBoxes = map (\reply -> textBuildBox (helperPostMeta reply) reply.message fileThreadReplyBorderHorizontal fileThreadReplyBorderVertical fileThreadReplyBorderCorner fileThreadReplyMinimumWidth fileThreadReplyMaximumWidth fileThreadReplyPadding) replies + in + unlines $ opBox : replyBoxes \ No newline at end of file diff --git a/src/ViewHelpers.hs b/src/ViewHelpers.hs new file mode 100644 index 0000000..c8992d9 --- /dev/null +++ b/src/ViewHelpers.hs @@ -0,0 +1,10 @@ +{- | Helper functions that are agnostic/used by both MenuViews and TextViews. + +-} +{-# LANGUAGE OverloadedRecordDot #-} +{-# LANGUAGE DuplicateRecordFields #-} +module ViewHelpers where + +import Config + +helperPostMeta post = (languageThreadIndexOpNumberLabel ++ show post.postId) ++ ", " ++ show post.createdAt \ No newline at end of file