From 273ea3277d77218de4854b114baa5e45485749d5 Mon Sep 17 00:00:00 2001 From: Alexander Cobleigh Date: Wed, 3 Feb 2021 18:56:45 +0100 Subject: [PATCH 01/18] Create LICENSE --- LICENSE | 661 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 661 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/LICENSE @@ -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 +. From 5fadf5b12b1def03d212b716193652a57b60dfce Mon Sep 17 00:00:00 2001 From: cblgh Date: Wed, 3 Feb 2021 19:00:40 +0100 Subject: [PATCH 02/18] include html ':) --- .gitignore | 1 - html/about-template.html | 28 ++++++++++++++++++++++++++++ html/index-template.html | 19 +++++++++++++++++++ html/list-template.html | 20 ++++++++++++++++++++ html/search-template.html | 22 ++++++++++++++++++++++ html/webring-template.html | 19 +++++++++++++++++++ 6 files changed, 108 insertions(+), 1 deletion(-) create mode 100644 html/about-template.html create mode 100644 html/index-template.html create mode 100644 html/list-template.html create mode 100644 html/search-template.html create mode 100644 html/webring-template.html diff --git a/.gitignore b/.gitignore index 63ef458..4ae5b97 100755 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,6 @@ node_modules/ *.vim *bundle*.js -/html/*.html *.sw[a-z] config.conf config.js diff --git a/html/about-template.html b/html/about-template.html new file mode 100644 index 0000000..9101f59 --- /dev/null +++ b/html/about-template.html @@ -0,0 +1,28 @@ + + + + Lieu—webring search engine + + + About +
+

Lieu

+

the search for the new—endless

+

+ Lieu—an alternative search engine. Created in response to the environs of + apathy concerning the use of hypertext search and discovery. In Lieu, the + internet is not what is made searchable, but instead one's own neighbourhood. Put differently, + Lieu is a neighbourhood search engine, a way for personal webrings to increase + serendipitous connexions. +

+

+ This instance indexes the {{.InstanceName}}—{{ .DomainCount }} domains, + {{ .PageCount }} pages, {{ .TermCount }} search terms. + Some domains of the webring have been filtered out for a better search experience, + see the filtered list. Visit a random page. +

+

Lieu was created by cblgh at the onset of 2021.

+

For Lieu's AGPL licensed source code, the repository.

+
+ + diff --git a/html/index-template.html b/html/index-template.html new file mode 100644 index 0000000..3729548 --- /dev/null +++ b/html/index-template.html @@ -0,0 +1,19 @@ + + + + Lieu—webring search engine + + + About +
+
+

Lieu

+

the search for the new—endless

+
+ + +
+
+
+ + diff --git a/html/list-template.html b/html/list-template.html new file mode 100644 index 0000000..c206d25 --- /dev/null +++ b/html/list-template.html @@ -0,0 +1,20 @@ + + + + {{ .Title }}—Lieu + + + About +

Lieu

+

{{ .Title }}

+
+ +
+ + diff --git a/html/search-template.html b/html/search-template.html new file mode 100644 index 0000000..0c3a173 --- /dev/null +++ b/html/search-template.html @@ -0,0 +1,22 @@ + + + + {{ .Query }}—Lieu + + + About +

Lieu

+
+ + +
+
+ {{ range .Pages }} +
+ {{ .Title }} +

{{ .About }}

+
+ {{ end }} +
+ + diff --git a/html/webring-template.html b/html/webring-template.html new file mode 100644 index 0000000..7b529c5 --- /dev/null +++ b/html/webring-template.html @@ -0,0 +1,19 @@ + + + + + indexed domains—Lieu + + +

Lieu

+ About +
+ {{ range .Domains }} +
+ {{ .Title }} +

{{ .About }}

+
+ {{ end }} +
+ + From 5bedcac01ee42348d623383feb08a1d845c48aa1 Mon Sep 17 00:00:00 2001 From: cblgh Date: Wed, 3 Feb 2021 21:59:04 +0100 Subject: [PATCH 03/18] fix crash on empty query --- server/server.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server/server.go b/server/server.go index 10d9d51..f0b1129 100644 --- a/server/server.go +++ b/server/server.go @@ -36,7 +36,7 @@ func searchRoute(res http.ResponseWriter, req *http.Request, config types.Config if req.Method == http.MethodGet { params := req.URL.Query() words, exists := params["q"] - if !exists { + if !exists || words[0] == "" { view := template.Must(template.ParseFiles("html/index-template.html")) var empty interface{} view.Execute(res, empty) From 6cdffc79fb65b770dce586b44d0232b2a042ea1e Mon Sep 17 00:00:00 2001 From: cblgh Date: Thu, 4 Feb 2021 09:41:42 +0100 Subject: [PATCH 04/18] add logo by devine, input validation --- html/about-template.html | 2 ++ html/assets/base.css | 7 ++++++- html/assets/logo.svg | 1 + html/index-template.html | 6 ++++-- html/list-template.html | 2 ++ html/search-template.html | 4 +++- 6 files changed, 18 insertions(+), 4 deletions(-) create mode 100644 html/assets/logo.svg diff --git a/html/about-template.html b/html/about-template.html index 9101f59..804138c 100644 --- a/html/about-template.html +++ b/html/about-template.html @@ -2,6 +2,8 @@ Lieu—webring search engine + + About diff --git a/html/assets/base.css b/html/assets/base.css index 0ebca74..0792dab 100644 --- a/html/assets/base.css +++ b/html/assets/base.css @@ -110,13 +110,18 @@ p { } .search-button { + background-image: url("logo.svg"); font-size: 2rem; color: var(--primary); - background: var(--secondary); border: 0; cursor: pointer; border-radius: 2px; transition: opacity 150ms; + + height: 2rem; + width: auto; + background-size: cover; + background-position: center; } .search-button:hover { diff --git a/html/assets/logo.svg b/html/assets/logo.svg new file mode 100644 index 0000000..7dadfe9 --- /dev/null +++ b/html/assets/logo.svg @@ -0,0 +1 @@ + diff --git a/html/index-template.html b/html/index-template.html index 3729548..ec3fca1 100644 --- a/html/index-template.html +++ b/html/index-template.html @@ -2,6 +2,8 @@ Lieu—webring search engine + + About @@ -10,8 +12,8 @@

Lieu

the search for the new—endless

- - + +
diff --git a/html/list-template.html b/html/list-template.html index c206d25..f27ebbe 100644 --- a/html/list-template.html +++ b/html/list-template.html @@ -2,6 +2,8 @@ {{ .Title }}—Lieu + + About diff --git a/html/search-template.html b/html/search-template.html index 0c3a173..d9e083e 100644 --- a/html/search-template.html +++ b/html/search-template.html @@ -2,13 +2,15 @@ {{ .Query }}—Lieu + + About

Lieu

- +
{{ range .Pages }} From 98c03cb95512473456f37cdf38f3cf544f26d87c Mon Sep 17 00:00:00 2001 From: cblgh Date: Thu, 4 Feb 2021 09:50:59 +0100 Subject: [PATCH 05/18] tweak favicon for better proportions --- html/about-template.html | 4 ++-- html/assets/favicon.png | Bin 0 -> 7180 bytes html/index-template.html | 4 ++-- html/list-template.html | 4 ++-- html/search-template.html | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) create mode 100644 html/assets/favicon.png diff --git a/html/about-template.html b/html/about-template.html index 804138c..263300d 100644 --- a/html/about-template.html +++ b/html/about-template.html @@ -2,8 +2,8 @@ Lieu—webring search engine - - + + About diff --git a/html/assets/favicon.png b/html/assets/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..4cfd36c09b7961208f0b25a88761663ad62627c9 GIT binary patch literal 7180 zcmcIp^;cBS-=|r6X^;j<>28Uo5m;DM8eF82P(VP5rIzjxLAs@pu0^C%x=ZO;dI5oF zKYzn>zCYYM=gygX?>RH`e$_-8=xLA;J|V=wz#!4m1R0{+U+AkBfQP;d+5R;~Hw5mQ zChsvYh$#QNFflT-=+K>*?+rCnFsjBF_s|bG_R24mF)(W5iT>H(Vqh@jX@Qg>A2E-z z@e?3wl>Ix?WSl%v)@4CYQ&}?%FsU&oDS)_;d>S|_RunFsQtum)^gKudC`p?_D+(5r zi&M$YQK~uS4o?!x*!F)syFbxrkqcdYpG-r(%@j;+ zAdWCnoD-nJ1)_pkv*iPEh{(fOU&DED5Go)x01Z2#at#m+fQ7+Tfc*cHA)d;nrkO(| zsGGx8je@xC~_p{CA8sK>n@{|+ASPXfzr2b1>O&&P~X zpS^mi7EL3u_8dKKhBMtfUprl}QagpmMmv#RZ8}diVmcTbf4cMY-E^bt62#B1Ro3$l z+*kio;Qj68c1s98S$Wsv!_p@~3YyO1an*Sk;tn}SxC-Z~3zn7lx^jRi*=v*tS#`GW z9j03aw3HhbMU@-m!DJ7<*X#1W{GQ>38c=J7P_e$(Dd6BPc->4ZEsFN6X_<4D)c+Jsc zX89kts553T9ny#R7{X)&8pa%n;-e#p@W&Ia10L^vE{BD>O2dd~%V#QHRj>r0l#f>0 zq>_bqcfv}E`H}epj?=eJHjk(MTxYhc6`is_SFp1M?rrdZRb-K0vW7&=`m$>&i zdC4y9brxwp6US@0Hsw~;2vWa=y0?q;3O}ZNFRTLZi?W%R&m{;u)d@II%P4=;n#$u^ zhkw&IN!LtoJj|oRB*%U((MyVAZ(YyG!V6uS>K`qWepd_j73IbiDb>?cAYQv4ITc?E~^8;^0C)0@AdXD;@pW~BdMjNZ|7qM#Ir!IqU*o$0hhUjM82E$?06ga)> zhilIEv|Q1ZthT=z3$oq=#WJMZ+;3yV#(?0^7IEiUUG#n*uL6D~2ZQ=)aB2I|yR*!B z_B(xffI%)u`M_)hz=LWv$Wys(TzWS}M8iL!vWnpm!zB0eRmDpIBZdin3eT?`6i(n= z%z<}Gs*q|+3;k@_nQZ#dc5E>M;xnIBUkxjF1a6gZ>5HD}co%T!q8H;*$h=dp*13*Q zM`6|iqS+?YV@cdax>a~-aiz^is_H3|oHt}lmwaYVL^ta=<(8iFgR~CkOuib?SH!fAToBX)N`VO*qayFL9m_A|oc!@jQKL_mbAP&*RlcQ(j9 z%Es7kB4X%!pOqkG;GcU8Ugz;0SGdmDd0Az?*P06aL_^@dG}8Z^oVxo56aBcYP&fQ1 zbfYKi5}QmuH(Of@kEP`qoMc0&p&-K5tzo#`_k3i7rLnh+qy@}u-Nr$&`2ej|V&n2g5)KnesRCxR9oo^7B+X`iH6UeYNVZL3 z9?T=K#ph(z3Av6a_H40WyHa&WI*~O{;)yRC_GYIj_+Mo_t9MttxNQjn@`H1+Zc5{I z6gf2FAlGYwfyE2T09uD(!y@gnCAY2>^S>6gZ^8(ED}|VKFM0)7E5?4lBchgeT@*Ji z(PR38YlzXnc3j)!wr2SvOM23LeRCW)vKtOdd+~u)-0}C*zga2T(~(rzSnl3M({omV zu2r|2jnE0C>rL-mwz#2n{~Hu?qg*4NxleP;sA8UEBVsYZE>`ZOeaie=Z90*XTQB3} zXWSp}A~KY{5ppc9+O2huORRFX%3{f7ZUJ9`9q#@U7je=C^^Gx59!?jMYBLJD4cG5M z&J}mF#A5{(@fsCp7&*z}rV8_ykz^~_yvG&mE6E9P((9ePvYfL%r?gTFW-3zrd|N64 z?aSDsO2`wCdr?N>I%kN|N4*%$mYX9^SPmRbA1^*5SRLeb@6J^YneGn8Ha^|_wKA8$ z63d@%$lzq<^qx3;{7s7WCs}GZEPRq?6x(5UrRo(|}Z zk6C17NVWSTvp_i1V}#ABa9RK4Cp;C`d4nBn?)x`&n;-iX zpxNKgGNB~jVXi9M@1U|tmy1P!{zIsAUWoa=+-pB*P}rQRWfBDJUO?|ZdeU+IjbUi@ z+ZBjWMQ=hhD#rtX3>V&?sYu`R8hq;5rf)00C0^$|SH;zX=c}|x8`2vN^z1o)*51Wh zYq!$sH5$fgYtOzVuZ8V;)@WNcb$z&C)ba0ZxNkUhHh>+A?Mp)X(WungcS+a9LP?kT zgb`b@!G)wEy~hELc)BJM3Y_s=4nRvVBW}y7MX@eDwEj)o^DmvA1YOArXVAfmMdxbz zf=ssx52)4v6K)HsgwD#yE7re5sYa^d#3GXFb>?9dri!Ot%qlMxPkSkki4kJkaFWv# zQbMvF72m2GCB#8^8m4%gC)-EP1RL?80+*LLYPSLWLdh)R;C@MqgQde*62@6Zr(kMTv*yTk?{QQcvLL+D|uU+du7yhY3lndN<0l4t5zA! zw~n9x43I}|J;4@-379qv{PEDV#ZbY9h9|Z&Ed1PBI9{mNkaC#lj#XyV__sK3PdEhG zqMNak-Pup!Rgf*MuxRt%(@y2%lrP%aVO)B_BKu)Lym_7EQf-=?Sp;fb%n9z5HR^5P z)KT|J7qrkt`O^huwtR9HsVczw={sEtb{b9-Ai$+A{_NYl!qMKbY%$I}s@FvB=`~+t z!}ZNoUM^Q;MmRvZ>D|gSgIl{zqeTk<1Y8KQ;Oea#I%*Wp_ul#p{AGshWBxE9iF5zdh}e znhzo@h0>&3sC3thzA6UdxWLi!Zk6P%=J;R|ulGdcdo%mYUp=NjoKh*?M67N8934li z&el%DNxaKaG2CKy+x$ErDsv??iJsltAx%>~JMTC2+dH5R8-RaO+T#KVLA%APbu#nZ*}f zbYC|8qom)IpntE$U@#!04QE^eVoUI0s zXF6n`=BP40)qPZPnHR&Ul9I+RlTnwrrox>y`?E>xeY{+D+;MHmL0tDNbY3Y6^DvQH z)(Dvs5*vZd%jRu8r3}6cj90eAYhyr{|76mCQOHRbC47 zZA87B%vT$IgmyrC&Ji2rv{&HAx(~6Wm&Sg*Nsn9c&m|L&5~1<8VkdK!w*GnumPz3Z zKUuGR+cXH3iUm%h7+@QBX(X=rm@`KFnISW?hq}0RH->TR2S=0EZHyBn+~nVg*to5> zEPaIqBUnTh$IwF$aEVrMqxTq|gjDTpLMF`%&o3ratLE&)n>HcY3INpBuv{^PA}t3i{ik|7KV1ai<4E9IE;A9^cDW zvEboq$xW6b(xG1uNu_qQ_~Q~z&T$b*$t}8KmtrC#W_dqW%Vy4IuyPi_5Y6*j6eObb z3$sg_)V=}@3+2zMntLSLIVr&(#M|5|O>7BC!#vq~H-0nJF_ohA+^kF6rY<{eTOl@O zxoftE31b)CB&EB_r@h}r?_L^-bQTm;G7`6g%a9XFDj!PYYRsZ6idQ@Q+qh?1=rt*B zwd4Ys#zagTT^z?mP?|ipVQ&3~1&d}4R5#cI{2L^fB8(#&6tq=R*6ERQ)m+*t&qtd& zP%?O-!Sp{L3~of;hl1gjI^1UlG<7{o8Ft& zk@e91;~pRIO%Ludbnu<`@)xbucjxI+wvv6tdXFu2iv|aOU^16;@N|b9Qb2*`_q@@+nFH``15h<-HTo=bAw{59T`wx3^ z=U}=FDoVsQDnwECw7%o{KcwpAZb5t|H6T#28eS@Iz!kzWZAWZC-`fTZ;8=^(K$A|k?v|BD-LC;V5T(yDx{3Drxnz37JZGseVHcKf4iEBI&IZaq!%3!!bkZeZyK7xt41Y|Jv`)`<+Lff- zR+k%|rx}U^`<7N6j2f;d@>IS4Q(v7aL37UTARAhWa93!;b%_P|>ilCC+Mdyi2;WH? zmEri30=?b04ywBpr(zIGQx%nmJK*()ScH&XL?;ps%U4X+xq#sk#hilre8kZZFM$(G z*mI`@Y_Q!-?DF}nIo_r(H}WZ7 zRF?7!AwNSBppdWhSgE0Rfc|)vbdU(<&u76y=v-jLFe+48GW?bQ6n_YeJ|AtDj#ro( z{I$oZ=w#P?&E6&5Atv(Eui74fgg|Ap9Ld~3$H;`od~zg8pi#?|c` zCFfgvLaMvp_z$mRSer|2tqgh|OZ2kKbR-jtIlfpFq&e08eQQd+A|lQ=zUSH^-k%(xZ+ZgCx?w*XrC zply8G;MO&oKgxsFb9g=?t*Lqse2-gp^0~fJDTgw&DG)SgaqQsPMOT_N;jy{@{DfBg zPeg=cH~VN@0EHA&%$Ve%(}>RCNMj7FeQ>8UA>R>qXCzhut~$X^p=rm>_E)s{BWJHZ zz9B>?*9ZB11a&%tcDlpF6)RA|Ze8@Lu&UPtODe+2Qp3FTGJ2hq(tvPHqU|BwIyZ)7$M z;#K~lSfl=}CH>82>5+C{50dFch-!ntH3(l^V%H0zb)&!mD=^Z6^EM=1$m*SXL^ugU z=J)Sc=PLU>QzR}+jW4`*CzJ)unsEAPBJZe#r;Nf6FsKn}z!)*qq!v(1*TX;JEmc9>PIANJnh1WVUq!WmC;cu-(P zfeK)P?^@?)yBt%Om}$JD4&QUTdWq+5tL?g9g}eK)%>$XR9Mf2l5qh_vEV15yH|L{BfzKdpw@HrE>0nc2**-Ne<&!glF#sX6=@`^awu2O2|4<&#Pj@!Z`7R=xjanU* z9L@pO7ntq1(g8C}IH$;;WDLsg3@~$9tQu+^933i4NxbgFE;M3DJjs<1Ig@}o`ix4< z;do;Q)!kj}&*&JJ8YrjooBZ}_#ko2CBJy#52RQ$hFqgz;YmKuYYh4mg-OgNP4{Z)a zde5DCQ@0bP3-xmp?R@x^ILsjEkS;wXR3In}fl z@YS)H@Rr8kS}nM*pooGs@DAO#gd;UTW@FGDx=?Rlf%Y&A)s{gkH5gg#>bPEEtsGW$ zXctgMBVd~GmiSs|SZ95Fw!zUzOm%+PU=c#V7d+M%w}6=tuV8$PW`Y;tx^zh?4)XLI ztOW4^ET})p`j9s7qY+|6&h_1pt@p%P((EPA!Cdt#Gz%J`ZKXtYURTIr{4#7!t&8l+ zsz5zSK(xVMulFsEWI+0366|1M}2mR z*p~u{zXlo>8$Q-z?BAKk^BmubQk3Phg(E`nD<1CeDvV0>I4d_DY0#A#z95pvN!8@h zgJ*H7wonU=a9V1ttQAqJBb`7pOS`DqK~Oc5{Q6zbb$b9a6ZX|=ler;yB%+ddq&J>K zUf4c`^szk=&wLw?h5!pY(pn1&k9(8E}jntWssv$jnbkgp*GV9U5c(zF- z-wsi6{1;n?uZ9m0Fst(@D6C|08t}ggP!oUBuvddtH8ZtP4GEv)|2muY=Tp0nk~!=nlV z$=~O_;NljVttuuFhmrtOmdJXLijdsKFG%OPU8?K|?5vRxDKH4rAJ`qe#kz4o34W2g|H-OLci#}s&*u7wl33E=s!p-KA(yS?)y*L z?60&nosMIQQxx}@N|O)tv9@8V66vB}Y>lz#W5gXi_ zH1<6=dqFjw*QjrFDl1Lt3<0U(&7WaV$RFc-Rpo-t8W>-^T5InM)>4!sKN}!-9T0gedAblL z?+}9bJXOzDa(ZMZI+|nhnuvk7Yvqj;tHir}LB>XXh{0q_`*8OG?~E(pE0&GXQ-;=g z+cqg2+&cULxtDM Lieu—webring search engine - - + + About diff --git a/html/list-template.html b/html/list-template.html index f27ebbe..8d9469f 100644 --- a/html/list-template.html +++ b/html/list-template.html @@ -2,8 +2,8 @@ {{ .Title }}—Lieu - - + + About diff --git a/html/search-template.html b/html/search-template.html index d9e083e..1b9a470 100644 --- a/html/search-template.html +++ b/html/search-template.html @@ -2,8 +2,8 @@ {{ .Query }}—Lieu - - + + About From 3bf70aeac57aa26df5dbb2aa3c4cc6946e93530a Mon Sep 17 00:00:00 2001 From: cblgh Date: Thu, 4 Feb 2021 15:53:03 +0100 Subject: [PATCH 06/18] handle more errors, close sql.Rows --- database/database.go | 5 +++++ server/server.go | 44 +++++++++++++++++++++++++------------------- 2 files changed, 30 insertions(+), 19 deletions(-) diff --git a/database/database.go b/database/database.go index 861891c..ee467a7 100644 --- a/database/database.go +++ b/database/database.go @@ -113,6 +113,7 @@ func GetWordCount(db *sql.DB) int { func GetRandomPage(db *sql.DB) string { rows, err := db.Query("SELECT url FROM pages ORDER BY RANDOM() LIMIT 1;") util.Check(err) + defer rows.Close() var link string for rows.Next() { @@ -125,6 +126,8 @@ func GetRandomPage(db *sql.DB) string { func countQuery(db *sql.DB, table string) int { rows, err := db.Query(fmt.Sprintf("SELECT COUNT(*) FROM %s;", table)) util.Check(err) + defer rows.Close() + var count int for rows.Next() { err = rows.Scan(&count) @@ -162,6 +165,8 @@ func searchWords(db *sql.DB, words []string, searchByScore bool) []types.PageDat rows, err := stmt.Query(args...) util.Check(err) + defer rows.Close() + var pageData types.PageData var pages []types.PageData for rows.Next() { diff --git a/server/server.go b/server/server.go index f0b1129..c5e9971 100644 --- a/server/server.go +++ b/server/server.go @@ -5,6 +5,7 @@ import ( "net/http" "net/url" "strings" + "database/sql" "lieu/database" "lieu/types" @@ -30,7 +31,7 @@ type AboutData struct { const useURLTitles = true -func searchRoute(res http.ResponseWriter, req *http.Request, config types.Config) { +func searchRoute(res http.ResponseWriter, req *http.Request, config types.Config, db *sql.DB) { var query string if req.Method == http.MethodGet { @@ -39,18 +40,19 @@ func searchRoute(res http.ResponseWriter, req *http.Request, config types.Config if !exists || words[0] == "" { view := template.Must(template.ParseFiles("html/index-template.html")) var empty interface{} - view.Execute(res, empty) + err := view.Execute(res, empty) + util.Check(err) return } query = words[0] } else { view := template.Must(template.ParseFiles("html/index-template.html")) var empty interface{} - view.Execute(res, empty) + err := view.Execute(res, empty) + util.Check(err) return } - db := database.InitDB(config.Data.Database) pages := database.SearchWordsByScore(db, util.Inflect(strings.Fields(query))) if useURLTitles { @@ -67,11 +69,11 @@ func searchRoute(res http.ResponseWriter, req *http.Request, config types.Config Query: query, Pages: pages, } - view.Execute(res, data) + err := view.Execute(res, data) + util.Check(err) } -func aboutRoute(res http.ResponseWriter, req *http.Request, config types.Config) { - db := database.InitDB(config.Data.Database) +func aboutRoute(res http.ResponseWriter, req *http.Request, config types.Config, db *sql.DB) { pageCount := util.Humanize(database.GetPageCount(db)) wordCount := util.Humanize(database.GetWordCount(db)) domainCount := database.GetDomainCount(db) @@ -85,7 +87,8 @@ func aboutRoute(res http.ResponseWriter, req *http.Request, config types.Config) FilteredLink: "/filtered", RingLink: config.General.URL, } - view.Execute(res, data) + err := view.Execute(res, data) + util.Check(err) } type ListData struct { @@ -93,7 +96,7 @@ type ListData struct { URLs []types.PageData } -func filteredRoute(res http.ResponseWriter, req *http.Request, config types.Config) { +func filteredRoute(res http.ResponseWriter, req *http.Request, config types.Config, db *sql.DB) { view := template.Must(template.ParseFiles("html/list-template.html")) var URLs []types.PageData for _, domain := range util.ReadList(config.Crawler.BannedDomains, "\n") { @@ -109,30 +112,33 @@ func filteredRoute(res http.ResponseWriter, req *http.Request, config types.Conf Title: "Filtered Domains", URLs: URLs, } - view.Execute(res, data) + err := view.Execute(res, data) + util.Check(err) } -func randomRoute(res http.ResponseWriter, req *http.Request, config types.Config) { - db := database.InitDB(config.Data.Database) +func randomRoute(res http.ResponseWriter, req *http.Request, config types.Config, db *sql.DB) { link := database.GetRandomPage(db) http.Redirect(res, req, link, http.StatusSeeOther) } func Serve(config types.Config) { + db := database.InitDB(config.Data.Database) + http.HandleFunc("/about", func(res http.ResponseWriter, req *http.Request) { - aboutRoute(res, req, config) + aboutRoute(res, req, config, db) }) http.HandleFunc("/", func(res http.ResponseWriter, req *http.Request) { - searchRoute(res, req, config) - }) - - http.HandleFunc("/filtered", func(res http.ResponseWriter, req *http.Request) { - filteredRoute(res, req, config) + searchRoute(res, req, config, db) }) http.HandleFunc("/random", func(res http.ResponseWriter, req *http.Request) { - randomRoute(res, req, config) + randomRoute(res, req, config, db) }) + + http.HandleFunc("/filtered", func(res http.ResponseWriter, req *http.Request) { + filteredRoute(res, req, config, db) + }) + fileserver := http.FileServer(http.Dir("html/assets/")) http.Handle("/links/", http.StripPrefix("/links/", fileserver)) From 3b7d89ab5e022b310303b29efc976ded75851f34 Mon Sep 17 00:00:00 2001 From: cblgh Date: Thu, 4 Feb 2021 17:44:58 +0100 Subject: [PATCH 07/18] go fmt --- database/database.go | 22 +++++++++++----------- server/server.go | 29 ++++++++++++++--------------- 2 files changed, 25 insertions(+), 26 deletions(-) diff --git a/database/database.go b/database/database.go index ee467a7..a76c50b 100644 --- a/database/database.go +++ b/database/database.go @@ -111,22 +111,22 @@ func GetWordCount(db *sql.DB) int { } func GetRandomPage(db *sql.DB) string { - rows, err := db.Query("SELECT url FROM pages ORDER BY RANDOM() LIMIT 1;") - util.Check(err) - defer rows.Close() + rows, err := db.Query("SELECT url FROM pages ORDER BY RANDOM() LIMIT 1;") + util.Check(err) + defer rows.Close() - var link string - for rows.Next() { - err = rows.Scan(&link) - util.Check(err) - } - return link + var link string + for rows.Next() { + err = rows.Scan(&link) + util.Check(err) + } + return link } func countQuery(db *sql.DB, table string) int { rows, err := db.Query(fmt.Sprintf("SELECT COUNT(*) FROM %s;", table)) util.Check(err) - defer rows.Close() + defer rows.Close() var count int for rows.Next() { @@ -165,7 +165,7 @@ func searchWords(db *sql.DB, words []string, searchByScore bool) []types.PageDat rows, err := stmt.Query(args...) util.Check(err) - defer rows.Close() + defer rows.Close() var pageData types.PageData var pages []types.PageData diff --git a/server/server.go b/server/server.go index c5e9971..34c9be5 100644 --- a/server/server.go +++ b/server/server.go @@ -1,18 +1,17 @@ package server import ( + "database/sql" "fmt" "net/http" "net/url" "strings" - "database/sql" + "html/template" "lieu/database" "lieu/types" "lieu/util" - "html/template" - - // "github.com/shurcooL/vfsgen" + // "github.com/shurcooL/vfsgen" ) type SearchData struct { @@ -40,8 +39,8 @@ func searchRoute(res http.ResponseWriter, req *http.Request, config types.Config if !exists || words[0] == "" { view := template.Must(template.ParseFiles("html/index-template.html")) var empty interface{} - err := view.Execute(res, empty) - util.Check(err) + err := view.Execute(res, empty) + util.Check(err) return } query = words[0] @@ -49,7 +48,7 @@ func searchRoute(res http.ResponseWriter, req *http.Request, config types.Config view := template.Must(template.ParseFiles("html/index-template.html")) var empty interface{} err := view.Execute(res, empty) - util.Check(err) + util.Check(err) return } @@ -70,7 +69,7 @@ func searchRoute(res http.ResponseWriter, req *http.Request, config types.Config Pages: pages, } err := view.Execute(res, data) - util.Check(err) + util.Check(err) } func aboutRoute(res http.ResponseWriter, req *http.Request, config types.Config, db *sql.DB) { @@ -88,7 +87,7 @@ func aboutRoute(res http.ResponseWriter, req *http.Request, config types.Config, RingLink: config.General.URL, } err := view.Execute(res, data) - util.Check(err) + util.Check(err) } type ListData struct { @@ -113,12 +112,12 @@ func filteredRoute(res http.ResponseWriter, req *http.Request, config types.Conf URLs: URLs, } err := view.Execute(res, data) - util.Check(err) + util.Check(err) } func randomRoute(res http.ResponseWriter, req *http.Request, config types.Config, db *sql.DB) { - link := database.GetRandomPage(db) - http.Redirect(res, req, link, http.StatusSeeOther) + link := database.GetRandomPage(db) + http.Redirect(res, req, link, http.StatusSeeOther) } func Serve(config types.Config) { @@ -131,9 +130,9 @@ func Serve(config types.Config) { searchRoute(res, req, config, db) }) - http.HandleFunc("/random", func(res http.ResponseWriter, req *http.Request) { - randomRoute(res, req, config, db) - }) + http.HandleFunc("/random", func(res http.ResponseWriter, req *http.Request) { + randomRoute(res, req, config, db) + }) http.HandleFunc("/filtered", func(res http.ResponseWriter, req *http.Request) { filteredRoute(res, req, config, db) From e985db9c9c66332190b759e00b037c9f9d5286e6 Mon Sep 17 00:00:00 2001 From: cblgh Date: Thu, 4 Feb 2021 19:48:50 +0100 Subject: [PATCH 08/18] remove errant corners on button --- html/assets/base.css | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/html/assets/base.css b/html/assets/base.css index 0792dab..6c76173 100644 --- a/html/assets/base.css +++ b/html/assets/base.css @@ -111,13 +111,9 @@ p { .search-button { background-image: url("logo.svg"); - font-size: 2rem; - color: var(--primary); - border: 0; cursor: pointer; - border-radius: 2px; + border: 0; transition: opacity 150ms; - height: 2rem; width: auto; background-size: cover; From 63f0fc22a9846185e51d863e7fabe2e50b86579e Mon Sep 17 00:00:00 2001 From: cblgh Date: Thu, 4 Feb 2021 19:49:23 +0100 Subject: [PATCH 09/18] add type=search to search inputs --- html/index-template.html | 2 +- html/search-template.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/html/index-template.html b/html/index-template.html index 2e102d9..1788a79 100644 --- a/html/index-template.html +++ b/html/index-template.html @@ -12,7 +12,7 @@

Lieu

the search for the new—endless

- +
diff --git a/html/search-template.html b/html/search-template.html index 1b9a470..cec0223 100644 --- a/html/search-template.html +++ b/html/search-template.html @@ -9,7 +9,7 @@ About

Lieu

- +
From 5a3c1d5a80d94d2f63cba55d8b041e6067c59692 Mon Sep 17 00:00:00 2001 From: Alexander Cobleigh Date: Sat, 6 Feb 2021 11:29:19 +0100 Subject: [PATCH 10/18] add screenshot --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 7192d8b..5aaa335 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ search and discovery. In Lieu, the internet is not what is made searchable, but instead one's own neighbourhood. Put differently, Lieu is a neighbourhood search engine, a way for personal webrings to increase serendipitous connexions. +![lieu screenshot](https://user-images.githubusercontent.com/3862362/107115659-75624d80-686e-11eb-81c8-0c6bdec07082.png) + ## Goals * Enable serendipitous discovery From 4c4705af43c5e82a135b59e1251055f26ee77e3f Mon Sep 17 00:00:00 2001 From: cblgh Date: Fri, 12 Mar 2021 18:00:24 +0100 Subject: [PATCH 11/18] improve results from /random --- cli.go | 7 +++++++ database/database.go | 21 +++++++++++++++++++-- 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/cli.go b/cli.go index ce718cc..00287a7 100644 --- a/cli.go +++ b/cli.go @@ -90,6 +90,13 @@ func main() { util.DatabaseDoesNotExist(config.Data.Database) } interactiveMode(config.Data.Database) + case "random": + exists := util.CheckFileExists(config.Data.Database) + if !exists { + util.DatabaseDoesNotExist(config.Data.Database) + } + db := database.InitDB(config.Data.Database) + fmt.Println(database.GetRandomPage(db)) case "host": exists := util.CheckFileExists(config.Data.Database) if !exists { diff --git a/database/database.go b/database/database.go index a76c50b..dd525dc 100644 --- a/database/database.go +++ b/database/database.go @@ -110,11 +110,28 @@ func GetWordCount(db *sql.DB) int { return countQuery(db, "inv_index") } -func GetRandomPage(db *sql.DB) string { - rows, err := db.Query("SELECT url FROM pages ORDER BY RANDOM() LIMIT 1;") +func GetRandomDomain(db *sql.DB) string { + rows, err := db.Query("SELECT domain FROM domains ORDER BY RANDOM() LIMIT 1;") util.Check(err) defer rows.Close() + var domain string + for rows.Next() { + err = rows.Scan(&domain) + util.Check(err) + } + return domain +} + +func GetRandomPage(db *sql.DB) string { + domain := GetRandomDomain(db) + stmt, err := db.Prepare("SELECT url FROM pages WHERE domain = ? ORDER BY RANDOM() LIMIT 1;") + defer stmt.Close() + util.Check(err) + + rows, err := stmt.Query(domain) + defer rows.Close() + var link string for rows.Next() { err = rows.Scan(&link) From 2f5a6b1cf46338f9739aff49375442fe10ca86ab Mon Sep 17 00:00:00 2001 From: basebuilder Date: Tue, 13 Apr 2021 22:29:38 +0000 Subject: [PATCH 12/18] convert HTML files to include templates --- html/about-template.html | 30 ------------------------------ html/about.html | 21 +++++++++++++++++++++ html/footer.html | 4 ++++ html/head.html | 10 ++++++++++ html/index-template.html | 21 --------------------- html/index.html | 12 ++++++++++++ html/list-template.html | 22 ---------------------- html/list.html | 12 ++++++++++++ html/nav.html | 10 ++++++++++ html/search-template.html | 24 ------------------------ html/search.html | 14 ++++++++++++++ html/webring-template.html | 19 ------------------- html/webring.html | 9 +++++++++ 13 files changed, 92 insertions(+), 116 deletions(-) delete mode 100644 html/about-template.html create mode 100644 html/about.html create mode 100644 html/footer.html create mode 100644 html/head.html delete mode 100644 html/index-template.html create mode 100644 html/index.html delete mode 100644 html/list-template.html create mode 100644 html/list.html create mode 100644 html/nav.html delete mode 100644 html/search-template.html create mode 100644 html/search.html delete mode 100644 html/webring-template.html create mode 100644 html/webring.html diff --git a/html/about-template.html b/html/about-template.html deleted file mode 100644 index 263300d..0000000 --- a/html/about-template.html +++ /dev/null @@ -1,30 +0,0 @@ - - - - Lieu—webring search engine - - - - - About -
-

Lieu

-

the search for the new—endless

-

- Lieu—an alternative search engine. Created in response to the environs of - apathy concerning the use of hypertext search and discovery. In Lieu, the - internet is not what is made searchable, but instead one's own neighbourhood. Put differently, - Lieu is a neighbourhood search engine, a way for personal webrings to increase - serendipitous connexions. -

-

- This instance indexes the {{.InstanceName}}—{{ .DomainCount }} domains, - {{ .PageCount }} pages, {{ .TermCount }} search terms. - Some domains of the webring have been filtered out for a better search experience, - see the filtered list. Visit a random page. -

-

Lieu was created by cblgh at the onset of 2021.

-

For Lieu's AGPL licensed source code, the repository.

-
- - diff --git a/html/about.html b/html/about.html new file mode 100644 index 0000000..3659bb2 --- /dev/null +++ b/html/about.html @@ -0,0 +1,21 @@ +{{ template "head" . }} +{{ template "nav". }} +
+

+ Lieu—an alternative search engine. Created in response to the environs of + apathy concerning the use of hypertext search and discovery. In Lieu, the + internet is not what is made searchable, but instead one's own neighbourhood. Put differently, + Lieu is a neighbourhood search engine, a way for personal webrings to increase + serendipitous connexions. +

+

+ This instance indexes the {{ .Data.InstanceName }} - {{ .Data.DomainCount }} domains, + {{ .Data.PageCount }} pages, {{ .Data.TermCount }} search terms. + Some domains of the webring have been filtered out for a better search experience, + see the filtered list. + Visit a random page. +

+

Lieu was created by cblgh at the onset of 2021.

+

For Lieu's AGPL licensed source code, the repository.

+
+{{ template "footer" . }} diff --git a/html/footer.html b/html/footer.html new file mode 100644 index 0000000..f2e2d31 --- /dev/null +++ b/html/footer.html @@ -0,0 +1,4 @@ +{{ define "footer" }} + + +{{ end }} diff --git a/html/head.html b/html/head.html new file mode 100644 index 0000000..43b9f25 --- /dev/null +++ b/html/head.html @@ -0,0 +1,10 @@ +{{ define "head" }} + + + + Lieu—webring search engine + + + + +{{ end }} diff --git a/html/index-template.html b/html/index-template.html deleted file mode 100644 index 1788a79..0000000 --- a/html/index-template.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - Lieu—webring search engine - - - - - About -
-
-

Lieu

-

the search for the new—endless

-
- - -
-
-
- - diff --git a/html/index.html b/html/index.html new file mode 100644 index 0000000..73acb0a --- /dev/null +++ b/html/index.html @@ -0,0 +1,12 @@ +{{ template "head" . }} +{{ template "nav" . }} +
+

+ Lieu the search for the new—endless +

+
+ + +
+
+{{ template "footer" . }} diff --git a/html/list-template.html b/html/list-template.html deleted file mode 100644 index 8d9469f..0000000 --- a/html/list-template.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - {{ .Title }}—Lieu - - - - - About -

Lieu

-

{{ .Title }}

-
- -
- - diff --git a/html/list.html b/html/list.html new file mode 100644 index 0000000..3c9a467 --- /dev/null +++ b/html/list.html @@ -0,0 +1,12 @@ +{{ template "head" . }} +{{ template "nav" . }} +
+ +
+{{ template "footer" . }} diff --git a/html/nav.html b/html/nav.html new file mode 100644 index 0000000..5df1a07 --- /dev/null +++ b/html/nav.html @@ -0,0 +1,10 @@ +{{ define "nav" }} +

+ {{ .SiteName }} +

+ +{{ end }} diff --git a/html/search-template.html b/html/search-template.html deleted file mode 100644 index cec0223..0000000 --- a/html/search-template.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - {{ .Query }}—Lieu - - - - - About -

Lieu

-
- - -
-
- {{ range .Pages }} -
- {{ .Title }} -

{{ .About }}

-
- {{ end }} -
- - diff --git a/html/search.html b/html/search.html new file mode 100644 index 0000000..a1605a2 --- /dev/null +++ b/html/search.html @@ -0,0 +1,14 @@ +{{ template "head" . }} +{{ template "nav" . }} +
+ + +
+
+ {{ range .Data.Pages }} +
+ {{ .Title }} +

{{ .About }}

+
+ {{ end }} +{{ template "footer" . }} diff --git a/html/webring-template.html b/html/webring-template.html deleted file mode 100644 index 7b529c5..0000000 --- a/html/webring-template.html +++ /dev/null @@ -1,19 +0,0 @@ - - - - - indexed domains—Lieu - - -

Lieu

- About -
- {{ range .Domains }} -
- {{ .Title }} -

{{ .About }}

-
- {{ end }} -
- - diff --git a/html/webring.html b/html/webring.html new file mode 100644 index 0000000..da67bb3 --- /dev/null +++ b/html/webring.html @@ -0,0 +1,9 @@ +{{ template "head" . }} +{{ template "nav" . }} + {{ range .Data.Domains }} +
+ {{ .Title }} +

{{ .About }}

+
+ {{ end }} +{{ template "footer" . }} From 19ce97e6dc36e937b0ab417e9c5b82db7bc41449 Mon Sep 17 00:00:00 2001 From: basebuilder Date: Tue, 13 Apr 2021 22:32:53 +0000 Subject: [PATCH 13/18] make Handlers render termplates with partials --- .gitignore | 3 ++ server/server.go | 84 +++++++++++++++++++++++++++++++----------------- 2 files changed, 57 insertions(+), 30 deletions(-) diff --git a/.gitignore b/.gitignore index 4ae5b97..160784c 100755 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +# Lieu +searchengine.db + #~top ignores~ node_modules/ *.vim diff --git a/server/server.go b/server/server.go index 34c9be5..07234ba 100644 --- a/server/server.go +++ b/server/server.go @@ -3,6 +3,8 @@ package server import ( "database/sql" "fmt" + "io/ioutil" + "log" "net/http" "net/url" "strings" @@ -11,14 +13,25 @@ import ( "lieu/database" "lieu/types" "lieu/util" - // "github.com/shurcooL/vfsgen" ) +type Page struct { + SiteName string + Title string + Body []byte + Data interface{} +} + type SearchData struct { Query string Pages []types.PageData } +type ListData struct { + Title string + URLs []types.PageData +} + type AboutData struct { DomainCount int InstanceName string @@ -30,25 +43,26 @@ type AboutData struct { const useURLTitles = true +var templates = template.Must(template.ParseFiles( + "html/head.html", "html/nav.html", "html/footer.html", + "html/about.html", "html/index.html", "html/list.html", "html/search.html", "html/webring.html")) + func searchRoute(res http.ResponseWriter, req *http.Request, config types.Config, db *sql.DB) { var query string + p := &Page{} if req.Method == http.MethodGet { params := req.URL.Query() words, exists := params["q"] if !exists || words[0] == "" { - view := template.Must(template.ParseFiles("html/index-template.html")) - var empty interface{} - err := view.Execute(res, empty) - util.Check(err) + p.Data = SearchData{} + renderTemplate(res, config, "index", p) return } query = words[0] } else { - view := template.Must(template.ParseFiles("html/index-template.html")) - var empty interface{} - err := view.Execute(res, empty) - util.Check(err) + p.Data = SearchData{} + renderTemplate(res, config, "index", p) return } @@ -63,22 +77,21 @@ func searchRoute(res http.ResponseWriter, req *http.Request, config types.Config } } - view := template.Must(template.ParseFiles("html/search-template.html")) - data := SearchData{ + p.Data = SearchData{ Query: query, Pages: pages, } - err := view.Execute(res, data) - util.Check(err) + renderTemplate(res, config, "search", p) } func aboutRoute(res http.ResponseWriter, req *http.Request, config types.Config, db *sql.DB) { + p := &Page{} + pageCount := util.Humanize(database.GetPageCount(db)) wordCount := util.Humanize(database.GetWordCount(db)) domainCount := database.GetDomainCount(db) - view := template.Must(template.ParseFiles("html/about-template.html")) - data := AboutData{ + p.Data = AboutData{ InstanceName: config.General.Name, DomainCount: domainCount, PageCount: pageCount, @@ -86,17 +99,12 @@ func aboutRoute(res http.ResponseWriter, req *http.Request, config types.Config, FilteredLink: "/filtered", RingLink: config.General.URL, } - err := view.Execute(res, data) - util.Check(err) -} -type ListData struct { - Title string - URLs []types.PageData + renderTemplate(res, config, "about", p) } func filteredRoute(res http.ResponseWriter, req *http.Request, config types.Config, db *sql.DB) { - view := template.Must(template.ParseFiles("html/list-template.html")) + p := &Page{} var URLs []types.PageData for _, domain := range util.ReadList(config.Crawler.BannedDomains, "\n") { u, err := url.Parse(domain) @@ -107,12 +115,11 @@ func filteredRoute(res http.ResponseWriter, req *http.Request, config types.Conf p := types.PageData{Title: domain, URL: u.String()} URLs = append(URLs, p) } - data := ListData{ + p.Data = ListData{ Title: "Filtered Domains", URLs: URLs, } - err := view.Execute(res, data) - util.Check(err) + renderTemplate(res, config, "list", p) } func randomRoute(res http.ResponseWriter, req *http.Request, config types.Config, db *sql.DB) { @@ -120,16 +127,33 @@ func randomRoute(res http.ResponseWriter, req *http.Request, config types.Config http.Redirect(res, req, link, http.StatusSeeOther) } +func renderTemplate(res http.ResponseWriter, config types.Config, tmpl string, p *Page) { + filename := "html/" + tmpl + ".html" + body, err := ioutil.ReadFile(filename) + if err != nil { + fmt.Println("Error loading template: " + filename) + log.Fatalln(err) + } + + p.Title = tmpl + p.Body = body + p.SiteName = config.General.Name + + errTemp := templates.ExecuteTemplate(res, tmpl+".html", p) + util.Check(errTemp) +} + func Serve(config types.Config) { db := database.InitDB(config.Data.Database) - http.HandleFunc("/about", func(res http.ResponseWriter, req *http.Request) { - aboutRoute(res, req, config, db) - }) http.HandleFunc("/", func(res http.ResponseWriter, req *http.Request) { searchRoute(res, req, config, db) }) + http.HandleFunc("/about", func(res http.ResponseWriter, req *http.Request) { + aboutRoute(res, req, config, db) + }) + http.HandleFunc("/random", func(res http.ResponseWriter, req *http.Request) { randomRoute(res, req, config, db) }) @@ -139,10 +163,10 @@ func Serve(config types.Config) { }) fileserver := http.FileServer(http.Dir("html/assets/")) - http.Handle("/links/", http.StripPrefix("/links/", fileserver)) + http.Handle("/assets/", http.StripPrefix("/assets/", fileserver)) portstr := fmt.Sprintf(":%d", config.General.Port) - fmt.Println("listening on", portstr) + fmt.Println("Listening on port: ", portstr) http.ListenAndServe(portstr, nil) } From 8eb7d281d7754c6e6df0b686321a2275b5248e44 Mon Sep 17 00:00:00 2001 From: basebuilder Date: Thu, 22 Apr 2021 10:21:51 +0000 Subject: [PATCH 14/18] use single CSS file --- html/assets/NotoSerif-Bold.ttf | Bin html/assets/NotoSerif-Italic.ttf | Bin html/assets/NotoSerif-Regular.ttf | Bin html/assets/about.css | 24 -------- html/assets/search.css | 27 --------- html/assets/startpage.css | 24 -------- html/assets/style.css | 91 ++++++++++++++++++++++++++++++ html/head.html | 4 +- 8 files changed, 93 insertions(+), 77 deletions(-) mode change 100755 => 100644 html/assets/NotoSerif-Bold.ttf mode change 100755 => 100644 html/assets/NotoSerif-Italic.ttf mode change 100755 => 100644 html/assets/NotoSerif-Regular.ttf delete mode 100644 html/assets/about.css delete mode 100644 html/assets/search.css delete mode 100644 html/assets/startpage.css create mode 100644 html/assets/style.css diff --git a/html/assets/NotoSerif-Bold.ttf b/html/assets/NotoSerif-Bold.ttf old mode 100755 new mode 100644 diff --git a/html/assets/NotoSerif-Italic.ttf b/html/assets/NotoSerif-Italic.ttf old mode 100755 new mode 100644 diff --git a/html/assets/NotoSerif-Regular.ttf b/html/assets/NotoSerif-Regular.ttf old mode 100755 new mode 100644 diff --git a/html/assets/about.css b/html/assets/about.css deleted file mode 100644 index 51ffbf0..0000000 --- a/html/assets/about.css +++ /dev/null @@ -1,24 +0,0 @@ -@import url("base.css"); - -html { - max-width: 31rem; -} - -h1 { - font-size: 3rem; - margin-bottom: 0.5rem; -} - -h2 { - font-family: "Noto Serif"; - font-style: italic; - font-weight: 400; - font-size: 1.5rem; - margin-top: 0; - margin-bottom: 2rem; -} - -.lieu { - font-family: "Noto Serif"; - font-weight: 400; -} diff --git a/html/assets/search.css b/html/assets/search.css deleted file mode 100644 index 817d834..0000000 --- a/html/assets/search.css +++ /dev/null @@ -1,27 +0,0 @@ -@import url('base.css'); - -main { - columns: 2; -} - -.entry { - -webkit-column-break-inside: avoid; - -moz-column-break-inside:avoid; - -moz-page-break-inside:avoid; - page-break-inside: avoid; - break-inside: avoid-column; -} - -.link { - font-style: italic; -} - -@media -only screen -and (min-device-width : 320px) -and (max-device-width : 720px) -{ - main { - columns: 1 !important; - } -} diff --git a/html/assets/startpage.css b/html/assets/startpage.css deleted file mode 100644 index da87f3f..0000000 --- a/html/assets/startpage.css +++ /dev/null @@ -1,24 +0,0 @@ -@import url("about.css"); - -html { - max-width: 100vw; -} - -h2 { - margin-bottom: 1rem; -} - -main { - display: grid; - justify-items: center; - align-items: center; - margin-top: 10rem; -} - -.search-container { - grid-template-columns: 19rem 3rem; -} - -.lieu-container { - justify-items: start; -} diff --git a/html/assets/style.css b/html/assets/style.css new file mode 100644 index 0000000..caa5a66 --- /dev/null +++ b/html/assets/style.css @@ -0,0 +1,91 @@ +@import url("base.css"); + +html { + max-width: 31rem; + max-width: 100%; +} + +h1 { + font-size: 3rem; + margin-bottom: 0.5rem; +} + +h2 { + font-family: "Noto Serif"; + font-style: italic; + font-weight: 400; + font-size: 1.5rem; + margin-top: 0; + margin-bottom: 2rem; +} + +header { + clear: both; + display: block; +} + +header h1 { + float: left; +} + +header ul { + float: right; + display: block; + margin-top: 2rem; + margin-right: 2rem; +} + +header ul li { + margin-right: 1.5rem; + display: inline-block; +} + +main { + display: grid; + justify-items: left; + align-items: left; + margin-top: 1rem; +} + +.clear { + clear: both; +} + +.lieu { + font-family: "Noto Serif"; + font-weight: 400; +} + +.search-container { + grid-template-columns: 19rem 3rem; +} + +.lieu-container { + justify-items: start; +} + + +.entry { + -webkit-column-break-inside: avoid; + -moz-column-break-inside:avoid; + -moz-page-break-inside:avoid; + page-break-inside: avoid; + break-inside: avoid-column; + margin-bottom: 1rem; +} + +.entry p { + color: #777777; +} + +.link { + font-style: italic; +} + +@media only screen and (min-device-width : 320px) and (max-device-width : 720px) { + + main { + columns: 1 !important; + } +} + diff --git a/html/head.html b/html/head.html index 43b9f25..2b81ba0 100644 --- a/html/head.html +++ b/html/head.html @@ -1,8 +1,8 @@ {{ define "head" }} - - Lieu—webring search engine + + Lieu—webring search engine From 96cf3d915fe97c2c28a93b621c33189370d4a7ee Mon Sep 17 00:00:00 2001 From: basebuilder Date: Thu, 22 Apr 2021 10:22:57 +0000 Subject: [PATCH 15/18] standardize
tag layouts --- html/index.html | 20 +++++++++++--------- html/nav.html | 19 +++++++++++-------- html/search.html | 10 +++++----- 3 files changed, 27 insertions(+), 22 deletions(-) diff --git a/html/index.html b/html/index.html index 73acb0a..81fc2cd 100644 --- a/html/index.html +++ b/html/index.html @@ -1,12 +1,14 @@ {{ template "head" . }} {{ template "nav" . }} -
-

- Lieu the search for the new—endless -

-
- - -
-
+
+
+

+ Lieu the search for the new—endless +

+
+ + +
+
+
{{ template "footer" . }} diff --git a/html/nav.html b/html/nav.html index 5df1a07..52db4d0 100644 --- a/html/nav.html +++ b/html/nav.html @@ -1,10 +1,13 @@ {{ define "nav" }} -

- {{ .SiteName }} -

- +
+

+ {{ .SiteName }} +

+ +
+
{{ end }} diff --git a/html/search.html b/html/search.html index a1605a2..f209471 100644 --- a/html/search.html +++ b/html/search.html @@ -1,14 +1,14 @@ {{ template "head" . }} {{ template "nav" . }} +
-
{{ range .Data.Pages }} -
- {{ .Title }} -

{{ .About }}

-
+
+ {{ .Title }} +

{{ .About }}

+
{{ end }} {{ template "footer" . }} From 4533344652d4e587588d4add989ca60d6bcbab7d Mon Sep 17 00:00:00 2001 From: basebuilder Date: Sat, 1 May 2021 12:08:09 +0000 Subject: [PATCH 16/18] ignore data/ dir, clarify instructions in README, update go.sum --- .gitignore | 1 + README.md | 11 ++++++++++- go.sum | 9 +++++++++ 3 files changed, 20 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 160784c..0b898b7 100755 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ # Lieu +data/ searchengine.db #~top ignores~ diff --git a/README.md b/README.md index 5aaa335..4e222ae 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # Lieu + _an alternative search engine_ Created in response to the environs of apathy concerning the use of hypertext @@ -10,11 +11,13 @@ engine, a way for personal webrings to increase serendipitous connexions. ## Goals + * Enable serendipitous discovery * Support personal communities * Be reusable, easily ## Usage + ``` $ lieu help Lieu: neighbourhood search engine @@ -28,6 +31,7 @@ Commands Example: lieu precrawl > data/webring.txt + lieu crawl > data/crawled.txt lieu ingest lieu host ``` @@ -39,12 +43,13 @@ the files Lieu reads from, as defined in the config file. See below for a typical workflow. ### Workflow + * Edit the config * Add domains to crawl in `config.crawler.webring` * **If you have a webpage with links you want to crawl:** * Set the config's `url` field to that page * Populate the list of domains to crawl with `precrawl`: `lieu precrawl > data/webring.txt` -* Crawl: `lieu crawl > data/source.txt` +* Crawl: `lieu crawl > data/crawled.txt` * Create database: `lieu ingest` * Host engine: `lieu host` @@ -52,6 +57,7 @@ After ingesting the data with `lieu ingest`, you can also use lieu to search the corpus in the terminal with `lieu search`. ## Config + The config file is written in [TOML](https://toml.io/en/). ```toml @@ -85,6 +91,7 @@ boringDomains = "data/boring-domains.txt" ``` For your own use, the following config fields should be customized: + * `name` * `url ` * `port` @@ -93,6 +100,7 @@ For your own use, the following config fields should be customized: * `bannedDomains` The following config-defined files can stay as-is unless you have specific requirements: + * `database` * `heuristics` * `wordlist` @@ -102,5 +110,6 @@ For a full rundown of the files and their various jobs, see the [files description](docs/files.md). ### License + Source code `AGPL-3.0-or-later`, Inter is available under `SIL OPEN FONT LICENSE Version 1.1`, Noto Serif is licensed as `Apache License, Version 2.0`. diff --git a/go.sum b/go.sum index 7278df0..3f96fb3 100644 --- a/go.sum +++ b/go.sum @@ -66,6 +66,7 @@ github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UV github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/temoto/robotstxt v1.1.1 h1:Gh8RCs8ouX3hRSxxK7B1mO5RFByQ4CmJZDwgom++JaA= github.com/temoto/robotstxt v1.1.1/go.mod h1:+1AmkuG3IYkh1kv0d2qEB9Le88ehNO0zwOr3ujewlOo= +github.com/yuin/goldmark v1.2.1 h1:ruQGxdhGHe7FWOJPT0mKs5+pD2Xs1Bm/kdGlHO04FmM= github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20190605123033-f99c8df09eb5/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= @@ -75,6 +76,7 @@ golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE= golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU= golang.org/x/lint v0.0.0-20190313153728-d0100b6bd8b3/go.mod h1:6SW0HCj/g11FgYtHlgUYUwCkIfeOF89ocIRzGO/8vkc= +golang.org/x/mod v0.3.0 h1:RM4zey1++hCTbCVQfnWeKs9/IEsaBLA8vTkd0WVtmH4= golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= golang.org/x/net v0.0.0-20180218175443-cbe0f9307d01/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= @@ -101,6 +103,8 @@ golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5h golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4 h1:myAQVi0cGEoqQVR5POX+8RR2mrocKqNN1hmeMqhX27k= +golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.2 h1:tW2bmiBqwgJj/UpqtC8EpXEZVYOwU0yG4iWbprSVAcs= golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= @@ -114,9 +118,14 @@ golang.org/x/tools v0.0.0-20190524140312-2c0ae7006135/go.mod h1:RgjU9mgBXZiqYHBn golang.org/x/tools v0.0.0-20190606124116-d0a3d012864b/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20210114065538-d78b04bdf963/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA= +golang.org/x/tools v0.1.0 h1:po9/4sTYwZU9lPhi1tOrb4hCv3qrhiQ77LZfGa2OjwY= +golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0= +golang.org/x/tour v0.0.0-20210317163553-0a3a62c5e5c0 h1:u0bliLHgSO64Pb0xbhtwNIHspZc11X8M1bJqBkYl4Co= +golang.org/x/tour v0.0.0-20210317163553-0a3a62c5e5c0/go.mod h1:bWzMdWN2SiLomDzvESYfljDnNu60fUM2ATO8j09tZ5Y= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE= golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM= google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4= From fc14bad76c3e2b2b249eb25e396dc3aaa652c128 Mon Sep 17 00:00:00 2001 From: cblgh Date: Tue, 11 May 2021 19:46:18 +0200 Subject: [PATCH 17/18] tweak eotl's changes to fit original design --- html/about.html | 4 +-- html/assets/base.css | 7 +++-- html/assets/style.css | 59 +++++++++++++++++++++++++++---------------- html/index.html | 14 ++++++++-- html/nav.html | 5 ++-- html/search.html | 10 ++++---- 6 files changed, 63 insertions(+), 36 deletions(-) diff --git a/html/about.html b/html/about.html index 3659bb2..b7ee919 100644 --- a/html/about.html +++ b/html/about.html @@ -1,6 +1,6 @@ {{ template "head" . }} -{{ template "nav". }} -
+{{ template "nav" . }} +

Lieu—an alternative search engine. Created in response to the environs of apathy concerning the use of hypertext search and discovery. In Lieu, the diff --git a/html/assets/base.css b/html/assets/base.css index 6c76173..71d3224 100644 --- a/html/assets/base.css +++ b/html/assets/base.css @@ -42,9 +42,9 @@ html { font-family: "Inter UI", sans-serif; background: var(--secondary); color: var(--primary); - max-width: 650px; padding-bottom: 2rem; padding-left: 2rem; + padding-right: 2rem; margin-top: 2rem; } @@ -141,7 +141,10 @@ and (max-device-width : 720px) padding-left: 0.75rem; padding-right: 0.75rem; font-size: 30pt; - max-width: 100vw; + max-width: 100vw !important; + } + #results { + display: grid; } } diff --git a/html/assets/style.css b/html/assets/style.css index caa5a66..cf5f98f 100644 --- a/html/assets/style.css +++ b/html/assets/style.css @@ -1,45 +1,50 @@ @import url("base.css"); -html { - max-width: 31rem; - max-width: 100%; -} - h1 { font-size: 3rem; - margin-bottom: 0.5rem; + margin-bottom: 0rem; } h2 { font-family: "Noto Serif"; - font-style: italic; font-weight: 400; font-size: 1.5rem; margin-top: 0; - margin-bottom: 2rem; + margin-bottom: 1rem; +} + +.lieu-container h2 { + font-style: italic; } header { clear: both; - display: block; + display: grid; + grid-auto-flow: column; + grid-template-columns: max-content max-content 1fr; + grid-column-gap: 1rem; + align-items: start; } -header h1 { - float: left; +header h2 a, header h2 a:hover { + border-bottom: none; } header ul { - float: right; - display: block; - margin-top: 2rem; - margin-right: 2rem; + justify-self: end; + margin-top: 0.5rem; + grid-column-start: 3; } header ul li { - margin-right: 1.5rem; + margin-left: 1.5rem; display: inline-block; } +header ul li:first-of-type { + margin-left: 0; +} + main { display: grid; justify-items: left; @@ -47,8 +52,15 @@ main { margin-top: 1rem; } -.clear { - clear: both; +main#results { + display: block; + margin-top: 4rem; + columns: 2; + max-width: 1200px; +} + +main#about { + max-width: 600px; } .lieu { @@ -61,10 +73,13 @@ main { } .lieu-container { - justify-items: start; + display: grid; + justify-items: center; + align-items: center; + margin-top: 5rem; + width: 100%; } - .entry { -webkit-column-break-inside: avoid; -moz-column-break-inside:avoid; @@ -75,7 +90,8 @@ main { } .entry p { - color: #777777; + color: var(--primary); + opacity: 0.45; } .link { @@ -83,7 +99,6 @@ main { } @media only screen and (min-device-width : 320px) and (max-device-width : 720px) { - main { columns: 1 !important; } diff --git a/html/index.html b/html/index.html index 81fc2cd..7eca400 100644 --- a/html/index.html +++ b/html/index.html @@ -1,9 +1,19 @@ {{ template "head" . }} -{{ template "nav" . }} +

+

Lieu

+ +
+
+

+ {{ .SiteName }} +

- Lieu the search for the new—endless + the search for the new—endless

diff --git a/html/nav.html b/html/nav.html index 52db4d0..3dbe188 100644 --- a/html/nav.html +++ b/html/nav.html @@ -1,13 +1,12 @@ {{ define "nav" }}
-

+

{{ .SiteName }} -

+
-
{{ end }} diff --git a/html/search.html b/html/search.html index f209471..0c20709 100644 --- a/html/search.html +++ b/html/search.html @@ -1,10 +1,10 @@ {{ template "head" . }} {{ template "nav" . }} -
- - - - +
+ + +
+
{{ range .Data.Pages }}
{{ .Title }} From 5fa910615332f1acd6ba4f9cbde532c4e2eb1bfa Mon Sep 17 00:00:00 2001 From: cblgh Date: Tue, 11 May 2021 20:13:50 +0200 Subject: [PATCH 18/18] refactor: remove unused fields, rename struct --- server/server.go | 48 +++++++++++++++++------------------------------- 1 file changed, 17 insertions(+), 31 deletions(-) diff --git a/server/server.go b/server/server.go index 07234ba..093f039 100644 --- a/server/server.go +++ b/server/server.go @@ -3,8 +3,6 @@ package server import ( "database/sql" "fmt" - "io/ioutil" - "log" "net/http" "net/url" "strings" @@ -15,10 +13,8 @@ import ( "lieu/util" ) -type Page struct { +type TemplateView struct { SiteName string - Title string - Body []byte Data interface{} } @@ -49,20 +45,20 @@ var templates = template.Must(template.ParseFiles( func searchRoute(res http.ResponseWriter, req *http.Request, config types.Config, db *sql.DB) { var query string - p := &Page{} + view := &TemplateView{} if req.Method == http.MethodGet { params := req.URL.Query() words, exists := params["q"] if !exists || words[0] == "" { - p.Data = SearchData{} - renderTemplate(res, config, "index", p) + view.Data = SearchData{} + renderView(res, config, "index", view) return } query = words[0] } else { - p.Data = SearchData{} - renderTemplate(res, config, "index", p) + view.Data = SearchData{} + renderView(res, config, "index", view) return } @@ -77,21 +73,21 @@ func searchRoute(res http.ResponseWriter, req *http.Request, config types.Config } } - p.Data = SearchData{ + view.Data = SearchData{ Query: query, Pages: pages, } - renderTemplate(res, config, "search", p) + renderView(res, config, "search", view) } func aboutRoute(res http.ResponseWriter, req *http.Request, config types.Config, db *sql.DB) { - p := &Page{} + view := &TemplateView{} pageCount := util.Humanize(database.GetPageCount(db)) wordCount := util.Humanize(database.GetWordCount(db)) domainCount := database.GetDomainCount(db) - p.Data = AboutData{ + view.Data = AboutData{ InstanceName: config.General.Name, DomainCount: domainCount, PageCount: pageCount, @@ -100,11 +96,11 @@ func aboutRoute(res http.ResponseWriter, req *http.Request, config types.Config, RingLink: config.General.URL, } - renderTemplate(res, config, "about", p) + renderView(res, config, "about", view) } func filteredRoute(res http.ResponseWriter, req *http.Request, config types.Config, db *sql.DB) { - p := &Page{} + view := &TemplateView{} var URLs []types.PageData for _, domain := range util.ReadList(config.Crawler.BannedDomains, "\n") { u, err := url.Parse(domain) @@ -115,11 +111,11 @@ func filteredRoute(res http.ResponseWriter, req *http.Request, config types.Conf p := types.PageData{Title: domain, URL: u.String()} URLs = append(URLs, p) } - p.Data = ListData{ + view.Data = ListData{ Title: "Filtered Domains", URLs: URLs, } - renderTemplate(res, config, "list", p) + renderView(res, config, "list", view) } func randomRoute(res http.ResponseWriter, req *http.Request, config types.Config, db *sql.DB) { @@ -127,19 +123,9 @@ func randomRoute(res http.ResponseWriter, req *http.Request, config types.Config http.Redirect(res, req, link, http.StatusSeeOther) } -func renderTemplate(res http.ResponseWriter, config types.Config, tmpl string, p *Page) { - filename := "html/" + tmpl + ".html" - body, err := ioutil.ReadFile(filename) - if err != nil { - fmt.Println("Error loading template: " + filename) - log.Fatalln(err) - } - - p.Title = tmpl - p.Body = body - p.SiteName = config.General.Name - - errTemp := templates.ExecuteTemplate(res, tmpl+".html", p) +func renderView(res http.ResponseWriter, config types.Config, tmpl string, view *TemplateView) { + view.SiteName = config.General.Name + errTemp := templates.ExecuteTemplate(res, tmpl+".html", view) util.Check(errTemp) }