diff options
| -rw-r--r-- | .dir-locals.el | 16 | ||||
| -rw-r--r-- | .gitignore | 16 | ||||
| -rw-r--r-- | COPYING | 674 | ||||
| -rw-r--r-- | Makefile.am | 38 | ||||
| -rw-r--r-- | README.org | 1 | ||||
| -rw-r--r-- | VERSION | 1 | ||||
| -rw-r--r-- | assets/css/mvp.css | 482 | ||||
| -rw-r--r-- | assets/js/activity.js | 351 | ||||
| -rw-r--r-- | bffe/server.scm | 490 | ||||
| -rw-r--r-- | bffe/view/activity.scm | 338 | ||||
| -rw-r--r-- | bffe/view/home.scm | 14 | ||||
| -rw-r--r-- | bffe/view/util.scm | 268 | ||||
| -rwxr-xr-x | bootstrap.sh | 3 | ||||
| -rw-r--r-- | configure.ac | 35 | ||||
| -rw-r--r-- | guile.am | 21 | ||||
| -rw-r--r-- | guix-dev.scm | 67 | ||||
| -rw-r--r-- | pre-inst-env.in | 47 | ||||
| -rw-r--r-- | scripts/bffe.in | 124 | ||||
| -rw-r--r-- | templates/home.html | 1 |
19 files changed, 2987 insertions, 0 deletions
diff --git a/.dir-locals.el b/.dir-locals.el new file mode 100644 index 0000000..e98c426 --- /dev/null +++ b/.dir-locals.el @@ -0,0 +1,16 @@ +;;; Directory Local Variables +;;; For more information see (info "(emacs) Directory Variables") + +((nil + (fill-column . 78) + (tab-width . 8)) + (scheme-mode + (indent-tabs-mode) + (eval put 'with-time-logging 'scheme-indent-function 1) + (eval put 'make-parameter 'scheme-indent-function 1) + (eval put 'with-directory-excursion 'scheme-indent-function 1) + (eval put 'letpar 'scheme-indent-function 1) + (eval put 'letpar& 'scheme-indent-function 1)) + (texinfo-mode + (indent-tabs-mode) + (fill-column . 72))) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..edb2997 --- /dev/null +++ b/.gitignore @@ -0,0 +1,16 @@ +*.go +Makefile.in +Makefile +aclocal.m4 +autom4te.cache +config.log +config.status +configure + +build-aux/install-sh +build-aux/missing + +scripts/bffe +pre-inst-env + +.local.envrc @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<http://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/Makefile.am b/Makefile.am new file mode 100644 index 0000000..bcbec65 --- /dev/null +++ b/Makefile.am @@ -0,0 +1,38 @@ +# bffe +# +# Copyright © 2023 Christopher Baines <mail@cbaines.net> +# +# This file is part of bffe. +# +# bffe is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License as +# published by the Free Software Foundation; either version 3 of the +# License, or (at your option) any later version. +# +# bffe is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with the bffe. If not, see +# <http://www.gnu.org/licenses/>. + +include guile.am + +bin_SCRIPTS = \ + scripts/bffe + +moddir = $(prefix)/share/guile/site/$(GUILE_EFFECTIVE_VERSION) +godir = $(prefix)/lib/guile/$(GUILE_EFFECTIVE_VERSION)/site-ccache +assetsdir = $(datadir)/@PACKAGE@ + +SOURCES = \ + bffe/server.scm \ + bffe/view/util.scm \ + bffe/view/home.scm \ + bffe/view/activity.scm + +install-data-local: + mkdir -p "$(DESTDIR)$(pkgdatadir)" || exit 1; + cp -r assets "$(DESTDIR)$(pkgdatadir)/" || exit 1; diff --git a/README.org b/README.org new file mode 100644 index 0000000..31b7098 --- /dev/null +++ b/README.org @@ -0,0 +1 @@ +-*- mode: org -*- @@ -0,0 +1 @@ +0.0.0 diff --git a/assets/css/mvp.css b/assets/css/mvp.css new file mode 100644 index 0000000..6402648 --- /dev/null +++ b/assets/css/mvp.css @@ -0,0 +1,482 @@ +/* MVP.css v1.8 - https://github.com/andybrewer/mvp */ + +:root { + --active-brightness: 0.85; + --border-radius: 5px; + --box-shadow: 2px 2px 10px; + --color: #118bee; + --color-accent: #118bee15; + --color-bg: #fff; + --color-bg-secondary: #e9e9e9; + --color-link: #118bee; + --color-secondary: #920de9; + --color-secondary-accent: #920de90b; + --color-shadow: #f4f4f4; + --color-table: #118bee; + --color-text: #000; + --color-text-secondary: #999; + --font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif; + --hover-brightness: 1.2; + --justify-important: center; + --justify-normal: left; + --line-height: 1.5; + --width-card: 285px; + --width-card-medium: 460px; + --width-card-wide: 800px; + --width-content: 1080px; +} + +@media (prefers-color-scheme: dark) { + :root { + --color: #0097fc; + --color-accent: #0097fc4f; + --color-bg: #333; + --color-bg-secondary: #555; + --color-link: #0097fc; + --color-secondary: #e20de9; + --color-secondary-accent: #e20de94f; + --color-shadow: #bbbbbb20; + --color-table: #0097fc; + --color-text: #f7f7f7; + --color-text-secondary: #aaa; + } +} + +/* Layout */ +article aside { + background: var(--color-secondary-accent); + border-left: 4px solid var(--color-secondary); + padding: 0.01rem 0.8rem; +} + +body { + background: var(--color-bg); + color: var(--color-text); + font-family: var(--font-family); + line-height: var(--line-height); + margin: 0; + overflow-x: hidden; + padding: 0; +} + +footer, +header, +main { + margin: 0 auto; + max-width: var(--width-content); + padding: 3rem 1rem; +} + +hr { + background-color: var(--color-bg-secondary); + border: none; + height: 1px; + margin: 4rem 0; + width: 100%; +} + +section { + display: flex; + flex-wrap: wrap; + justify-content: var(--justify-important); +} + +section img, +article img { + max-width: 100%; +} + +section pre { + overflow: auto; +} + +section aside { + border: 1px solid var(--color-bg-secondary); + border-radius: var(--border-radius); + box-shadow: var(--box-shadow) var(--color-shadow); + margin: 1rem; + padding: 1.25rem; + width: var(--width-card); +} + +section aside:hover { + box-shadow: var(--box-shadow) var(--color-bg-secondary); +} + +[hidden] { + display: none; +} + +/* Headers */ +article header, +div header, +main header { + padding-top: 0; +} + +header { + text-align: var(--justify-important); +} + +header a b, +header a em, +header a i, +header a strong { + margin-left: 0.5rem; + margin-right: 0.5rem; +} + +header nav img { + margin: 1rem 0; +} + +section header { + padding-top: 0; + width: 100%; +} + +/* Nav */ +nav { + align-items: center; + display: flex; + font-weight: bold; + justify-content: space-between; + margin-bottom: 7rem; +} + +nav ul { + list-style: none; + padding: 0; +} + +nav ul li { + display: inline-block; + margin: 0 0.5rem; + position: relative; + text-align: left; +} + +/* Nav Dropdown */ +nav ul li:hover ul { + display: block; +} + +nav ul li ul { + background: var(--color-bg); + border: 1px solid var(--color-bg-secondary); + border-radius: var(--border-radius); + box-shadow: var(--box-shadow) var(--color-shadow); + display: none; + height: auto; + left: -2px; + padding: .5rem 1rem; + position: absolute; + top: 1.7rem; + white-space: nowrap; + width: auto; + z-index: 1; +} + +nav ul li ul::before { + /* fill gap above to make mousing over them easier */ + content: ""; + position: absolute; + left: 0; + right: 0; + top: -0.5rem; + height: 0.5rem; +} + +nav ul li ul li, +nav ul li ul li a { + display: block; +} + +/* Typography */ +code, +samp { + background-color: var(--color-accent); + border-radius: var(--border-radius); + color: var(--color-text); + display: inline-block; + margin: 0 0.1rem; + padding: 0 0.5rem; +} + +details { + margin: 1.3rem 0; +} + +details summary { + font-weight: bold; + cursor: pointer; +} + +h1, +h2, +h3, +h4, +h5, +h6 { + line-height: var(--line-height); +} + +mark { + padding: 0.1rem; +} + +ol li, +ul li { + padding: 0.2rem 0; +} + +p { + margin: 0.75rem 0; + padding: 0; + width: 100%; +} + +pre { + margin: 1rem 0; + max-width: var(--width-card-wide); + padding: 1rem 0; +} + +pre code, +pre samp { + display: block; + max-width: var(--width-card-wide); + padding: 0.5rem 2rem; + white-space: pre-wrap; +} + +small { + color: var(--color-text-secondary); +} + +sup { + background-color: var(--color-secondary); + border-radius: var(--border-radius); + color: var(--color-bg); + font-size: xx-small; + font-weight: bold; + margin: 0.2rem; + padding: 0.2rem 0.3rem; + position: relative; + top: -2px; +} + +/* Links */ +a { + color: var(--color-link); + display: inline-block; + font-weight: bold; + text-decoration: none; +} + +a:active { + filter: brightness(var(--active-brightness)); + text-decoration: underline; +} + +a:hover { + filter: brightness(var(--hover-brightness)); + text-decoration: underline; +} + +a b, +a em, +a i, +a strong, +button { + border-radius: var(--border-radius); + display: inline-block; + font-size: medium; + font-weight: bold; + line-height: var(--line-height); + margin: 0.5rem 0; + padding: 1rem 2rem; +} + +button { + font-family: var(--font-family); +} + +button:active { + filter: brightness(var(--active-brightness)); +} + +button:hover { + cursor: pointer; + filter: brightness(var(--hover-brightness)); +} + +a b, +a strong, +button { + background-color: var(--color-link); + border: 2px solid var(--color-link); + color: var(--color-bg); +} + +a em, +a i { + border: 2px solid var(--color-link); + border-radius: var(--border-radius); + color: var(--color-link); + display: inline-block; + padding: 1rem 2rem; +} + +article aside a { + color: var(--color-secondary); +} + +/* Images */ +figure { + margin: 0; + padding: 0; +} + +figure img { + max-width: 100%; +} + +figure figcaption { + color: var(--color-text-secondary); +} + +/* Forms */ + +button:disabled, +input:disabled { + background: var(--color-bg-secondary); + border-color: var(--color-bg-secondary); + color: var(--color-text-secondary); + cursor: not-allowed; +} + +button[disabled]:hover { + filter: none; +} + +form { + border: 1px solid var(--color-bg-secondary); + border-radius: var(--border-radius); + box-shadow: var(--box-shadow) var(--color-shadow); + display: block; + max-width: var(--width-card-wide); + min-width: var(--width-card); + padding: 1.5rem; + text-align: var(--justify-normal); +} + +form header { + margin: 1.5rem 0; + padding: 1.5rem 0; +} + +input, +label, +select, +textarea { + display: block; + font-size: inherit; + max-width: var(--width-card-wide); +} + +input[type="checkbox"], +input[type="radio"] { + display: inline-block; +} + +input[type="checkbox"]+label, +input[type="radio"]+label { + display: inline-block; + font-weight: normal; + position: relative; + top: 1px; +} + +input, +select, +textarea { + border: 1px solid var(--color-bg-secondary); + border-radius: var(--border-radius); + margin-bottom: 1rem; + padding: 0.4rem 0.8rem; +} + +input[readonly], +textarea[readonly] { + background-color: var(--color-bg-secondary); +} + +label { + font-weight: bold; + margin-bottom: 0.2rem; +} + +/* Tables */ +table { + border: 1px solid var(--color-bg-secondary); + border-radius: var(--border-radius); + border-spacing: 0; + display: inline-block; + max-width: 100%; + overflow-x: auto; + padding: 0; + white-space: nowrap; +} + +table td, +table th, +table tr { + padding: 0.4rem 0.8rem; + text-align: var(--justify-important); +} + +table thead { + background-color: var(--color-table); + border-collapse: collapse; + border-radius: var(--border-radius); + color: var(--color-bg); + margin: 0; + padding: 0; +} + +table thead th:first-child { + border-top-left-radius: var(--border-radius); +} + +table thead th:last-child { + border-top-right-radius: var(--border-radius); +} + +table thead th:first-child, +table tr td:first-child { + text-align: var(--justify-normal); +} + +table tr:nth-child(even) { + background-color: var(--color-accent); +} + +/* Quotes */ +blockquote { + display: block; + font-size: x-large; + line-height: var(--line-height); + margin: 1rem auto; + max-width: var(--width-card-medium); + padding: 1.5rem 1rem; + text-align: var(--justify-important); +} + +blockquote footer { + color: var(--color-text-secondary); + display: block; + font-size: small; + line-height: var(--line-height); + padding: 1.5rem 0; +} diff --git a/assets/js/activity.js b/assets/js/activity.js new file mode 100644 index 0000000..719ec47 --- /dev/null +++ b/assets/js/activity.js @@ -0,0 +1,351 @@ + +const recentActivityDiv = document.getElementById("recent-activity-body"); +const recentActivityDivLimit = 1000; + +function addRecentActivityEntry(event, content, timestamp) { + const eventRow = document.createElement('tr'); + eventRow.className = "event"; + eventRow.innerHTML = ` +<td width="10%">${event}</td> +<td>${content}</td> +<td width="10%">${timestamp}</td>`; + + recentActivityDiv.prepend(eventRow); + animateElementAddition(eventRow); + + const childCount = recentActivityDiv.childElementCount; + + if (childCount > recentActivityDivLimit) { + for (let index = recentActivityDivLimit; index < childCount; index++) { + recentActivityDiv.removeChild( + recentActivityDiv.children[index] + ) + } + } +} + +function animateElementAddition(e, color = "lightblue") { + e.style.backgroundColor = color; + e.style.lineHeight = "0px"; + e.style.overflow = "hidden"; + e.style.opacity = 0; + + setTimeout(function() { + e.style.transition = + "background-color 1.2s ease-out, line-height 6s, opacity 0.3s ease-out"; + e.style.backgroundColor = ""; + e.style.lineHeight = ""; + e.style.opacity = ""; + }, 50); +} + +function animateElementChange(e, color = "lightblue") { + e.style.transition = "background-color 0.6s ease-out"; + + setTimeout(function() { + e.style.backgroundColor = color; + + setTimeout(function() { + e.style.backgroundColor = ""; + }, 600); + }, 50); +} + +function animateElementAndRemove(e, color) { + // TODO: This needs more work, as it needs to fit in with keeping the + // related bits that reference the number of builds up to date + e.remove(); + + // e.style.borderWidth = "20px;"; + // e.style.borderStyle = "solid"; + // e.style.borderColor = color; + // e.style.transition = "border 10s"; + // e.addEventListener("transitionend", function() { + // e.remove(); + // }, {once: true}); + + // setTimeout(function() { + // e.style.borderColor = ""; + // }, 1000); +} + +function buildDetailsFromDom(id) { + return document.getElementById("build-" + id).dataset; +} + +function agentDetailsFromDom(id) { + return document.getElementById("agent-" + id).dataset; +} + +function updateAgentBuildRelatedElements(agentId) { + const agentBuildsElement = document.getElementById( + "agent-" + agentId + "-builds" + ); + const childCount = agentBuildsElement.childElementCount; + + const noAllocatedBuildsElement = document.getElementById( + "agent-" + agentId + "-no-allocated-builds" + ); + const plusXBuildsElement = document.getElementById( + "agent-" + agentId + "-plus-x-builds" + ); + + + if (childCount == 0) { + noAllocatedBuildsElement.style.display = "block"; + plusXBuildsElement.style.display = "none"; + + animateElementChange(noAllocatedBuildsElement); + } else { + for (let index = 0; index < Math.min(childCount, 4); index++) { + agentBuildsElement.children[index].style.display = "block"; + } + + if (childCount > 4) { + noAllocatedBuildsElement.style.display = "none"; + + plusXBuildsElement.style.display = "block"; + + const otherBuildCount = childCount - 4; + if (otherBuildCount == 1) { + plusXBuildsElement.textContent = "Plus 1 other build"; + } else { + plusXBuildsElement.textContent = + `Plus ${otherBuildCount} other builds`; + } + + animateElementChange(plusXBuildsElement); + } else { + noAllocatedBuildsElement.style.display = "none"; + plusXBuildsElement.style.display = "none"; + } + } +} + +function buildSubmittedHandler(e) { + const data = JSON.parse(e.data); + console.log("build-submitted", data); + + addRecentActivityEntry( + "Build submitted", + `${data.derivation.slice(44, -4)}`, + data.timestamp + ); +} + +function buildCanceledHandler(e) { + console.log("build-canceled", e); + + addRecentActivityEntry( + "Build canceled", + `${data.derivation.slice(44, -4)}, tags: ${data.tags}`, + data.timestamp + ); +} + +function buildSuccessHandler(e) { + const data = JSON.parse(e.data); + console.log("build-success", data); + + const buildElement = document.getElementById( + "build-" + data.build_id + ); + const buildDetails = buildDetailsFromDom(data.build_id); + + addRecentActivityEntry( + "Build success", + `${buildDetails.derivation.slice(44, -4)}`, + data.timestamp + ); + + animateElementAndRemove(buildElement, "green"); + + updateAgentBuildRelatedElements(data.agent_id); +} + +function buildFailureHandler(e) { + const data = JSON.parse(e.data); + + console.log("build-failure", data); + + const buildElement = document.getElementById( + "build-" + data.build_id + ); + + animateElementAndRemove(buildElement, "red"); + + updateAgentBuildRelatedElements(data.agent_id); +} + +function buildStartedHandler(e) { + const data = JSON.parse(e.data); + console.log("build-started", data); + + const buildDetails = buildDetailsFromDom(data.build_id); + const agentDetails = agentDetailsFromDom(data.agent_id); + + addRecentActivityEntry( + "Build started", + `${buildDetails.derivation.slice(44, -4)}, agent: ${agentDetails.name}`, + data.timestamp + ); +} + +function buildSetupFailureHandler(e) { + const data = JSON.parse(e.data); + console.log("build-setup-failure", data); + + const buildDetails = buildDetailsFromDom(data.build_id); + const agentDetails = agentDetailsFromDom(data.agent_id); + + addRecentActivityEntry( + "Build setup failure", + `${buildDetails.derivation.slice(44, -4)}, agent: ${agentDetails.name}`, + data.timestamp + ); + + // Remove from agent with setup failure animation +} + +function allocationPlanUpdateHandler(e) { + const data = JSON.parse(e.data); + + console.log("allocation-plan-update", data); + + for (const agentId in data.allocation_plan_counts) { + const planSizeElement = document.getElementById( + "agent-" + agentId + "-plan-size" + ); + + const updatedValue = data.allocation_plan_counts[agentId]; + if (updatedValue != planSizeElement.dataset.value) { + planSizeElement.textContent = `Plan size: ${data.allocation_plan_counts[agentId]}` + planSizeElement.dataset.value = updatedValue; + + animateElementChange(planSizeElement); + } + } +} + +function agentBuildsAllocatedHandler(e) { + const data = JSON.parse(e.data); + + console.log("agent-builds-allocated", data); + + const agentBuildsElement = document.getElementById( + "agent-" + data.agent_id + "-builds" + ); + + var newElements = []; + + data.builds.forEach(function(build) { + const buildElement = document.getElementById("build-" + build.uuid); + + if (!buildElement) { + const buildElement = document.createElement('div'); + buildElement.id = "build-" + build.uuid; + buildElement.className = "build"; + + buildElement.dataset.derivation = build.derivation_name; + const drv = build.derivation_name.slice(44, -4); + + buildElement.innerHTML = ` +<span class="monospace" style="display:block;">${drv}</span> +`; + + build.tags.sort(function(a, b) { + return a.key > b.key; + }).forEach(function(tag) { + var val; + + if (tag.value.length == 40) { + val = tag.value.substring(0, 8); + } else { + val = tag.value; + } + + buildElement.innerHTML += ` +<span class="build-tag">${tag.key}: ${val}</span> +`; + }); + + if (agentBuildsElement.childElementCount > 4) { + buildElement.style.display = "none"; + } + + agentBuildsElement.append(buildElement); + + newElements.push(buildElement); + } + }); + + if (agentBuildsElement.childElementCount > 4) { + document.getElementById( + "agent-" + data.agent_id + "-no-allocated-builds" + ).style.display = "none"; + + const plusBuilds = document.getElementById( + "agent-" + data.agent_id + "-plus-x-builds" + ) + plusBuilds.style.display = "block"; + + const otherBuildCount = agentBuildsElement.childElementCount - 4; + if (otherBuildCount == 1) { + plusBuilds.textContent = "Plus 1 other build"; + } else { + plusBuilds.textContent = + `Plus ${otherBuildCount} other builds`; + } + + animateElementChange(plusBuilds); + } + + for (const element of newElements) { + setTimeout( + function() { animateElementChange(element); }, + 50 + ); + } +} + +function agentStatusUpdateHandler(e) { + const data = JSON.parse(e.data); + + console.log("agent-status-update", data); + + const loadElement = document.getElementById( + "agent-" + data.agent_id + "-load" + ); + + const loadPercentage = Math.round((100 * data.load_average["1"]) / data.processor_count); + loadElement.textContent = `Load: ${loadPercentage}%`; + + var loadClass; + if (loadPercentage < 150) { + loadClass = "agent-load-normal"; + } else if (loadPercentage < 250) { + loadClass = "agent-load-medium"; + } else { + loadClass = "agent-load-high"; + } + loadElement.className = `agent-load ${loadClass}`; + + animateElementChange(loadElement); +} + +const lastEventId = document.getElementById("main").dataset.stateid; +const evtSource = new EventSource(`/events?last_event_id=${lastEventId}`); + +evtSource.addEventListener("build-submitted", buildSubmittedHandler); +evtSource.addEventListener("build-success", buildSuccessHandler); +evtSource.addEventListener("build-failure", buildFailureHandler); +evtSource.addEventListener("build-started", buildStartedHandler); +evtSource.addEventListener("build-setup-failure", buildSetupFailureHandler); +evtSource.addEventListener("allocation-plan-update", allocationPlanUpdateHandler); +evtSource.addEventListener("agent-builds-allocated", agentBuildsAllocatedHandler); +evtSource.addEventListener("agent-status-update", agentStatusUpdateHandler); + + +console.log("starting listening"); + + diff --git a/bffe/server.scm b/bffe/server.scm new file mode 100644 index 0000000..14d5d0a --- /dev/null +++ b/bffe/server.scm @@ -0,0 +1,490 @@ +;;; Build Farm Front-End +;;; +;;; Copyright © 2023 Christopher Baines <mail@cbaines.net> +;;; +;;; 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 +;;; <http://www.gnu.org/licenses/>. + +(define-module (bffe server) + #:use-module (srfi srfi-1) + #:use-module (srfi srfi-11) + #:use-module (srfi srfi-19) + #:use-module (srfi srfi-71) + #:use-module (ice-9 vlist) + #:use-module (ice-9 threads) + #:use-module (ice-9 match) + #:use-module (ice-9 atomic) + #:use-module (ice-9 textual-ports) + #:use-module (rnrs bytevectors) + #:use-module (web http) + #:use-module (web client) + #:use-module (web request) + #:use-module (web response) + #:use-module (web uri) + #:use-module (json) + #:use-module (prometheus) + #:use-module (system repl error-handling) + #:use-module (fibers) + #:use-module (fibers channels) + #:use-module (fibers conditions) + #:use-module (fibers web server) + #:use-module (guix store) + #:use-module ((guix build utils) #:select (dump-port)) + #:use-module (guix-data-service web util) + #:use-module ((guix-build-coordinator utils) + #:select (with-time-logging get-gc-metrics-updater + call-with-delay-logging)) + #:use-module ((guix-build-coordinator utils fibers) + #:select (run-server/patched call-with-sigint)) + #:use-module (guix-build-coordinator client-communication) + #:use-module (bffe view util) + #:use-module (bffe view home) + #:use-module (bffe view activity) + #:export (start-bffe-web-server)) + +(define (make-state-channel) + (let ((channel (make-channel))) + (call-with-new-thread + (lambda () + (let loop ((last-fetch-time #f) + (state #f)) + (let ((reply-channel (get-message channel)) + (state-age-seconds + (and last-fetch-time + (- (time-second (current-time)) + last-fetch-time)))) + (if (or (not state-age-seconds) + (> state-age-seconds + 120)) + (let ((response + body + (http-get + (string->uri "http://localhost:8746/state")))) + (let ((state + (json-string->scm + (utf8->string body)))) + (put-message reply-channel + state) + (loop (time-second (current-time)) + state))) + (begin + (put-message + reply-channel + state) + (loop last-fetch-time + state))))))) + + channel)) + +(define (get-state state-channel) + (let ((reply-channel (make-channel))) + (put-message state-channel + reply-channel) + + (get-message reply-channel))) + +(define (make-events-channel initial-state-id) + (let* ((submission-channel (make-channel)) + (listener-channels-box (make-atomic-box vlist-null)) + + (buffer-size 10000) + (event-buffer (make-vector buffer-size)) + + (current-state-id-and-event-buffer-index-box + (make-atomic-box (cons 0 -1)))) + + (define (get-state-id) + (match (atomic-box-ref + current-state-id-and-event-buffer-index-box) + ((current-state-id . event-buffer-index) + current-state-id))) + + (define (spawn-fiber-for-listener callback + after-state-id + submission-channel + listener-channel + listening-finished-channel) + (spawn-fiber + (lambda () + (let loop ((last-sent-state-id after-state-id)) + (let ((new-state-id + (with-exception-handler + (lambda (exn) + (simple-format + (current-error-port) + "exception listening for events: ~A\n" exn) + (put-message submission-channel + (list 'remove-listener + listener-channel)) + + (put-message listening-finished-channel #t) + + #f) + (lambda () + (with-throw-handler #t + (lambda () + (match (atomic-box-ref + current-state-id-and-event-buffer-index-box) + ((current-state-id . event-buffer-index) + (let ((event-count-to-send + (- current-state-id last-sent-state-id))) + (for-each + (lambda (index index-state-id) + (match (vector-ref event-buffer index) + ((event-state-id event-name data) + + (when (not (= event-state-id index-state-id)) + (error "listener behind")) + + (callback event-state-id event-name data)))) + (map (lambda (i) + (modulo i buffer-size)) + (iota event-count-to-send + (- event-buffer-index + (- event-count-to-send 1)))) + (iota event-count-to-send + (+ 1 last-sent-state-id)))) + + current-state-id))) + (lambda (key . args) + (peek "ERROR" key args) + (if (and + (eq? key 'system-error) + (match args + (("fport_write" "~A" ("Broken pipe") rest ...) + #t) + (_ #f))) + #f + (backtrace))))) + #:unwind? #t))) + + (unless (eq? #f new-state-id) + (get-message listener-channel) + (loop new-state-id))))) + #:parallel? #t)) + + (define (store-event id event-name data) + (match (atomic-box-ref + current-state-id-and-event-buffer-index-box) + ((current-state-id . event-buffer-index) + (let ((new-event-index + (modulo + (+ 1 event-buffer-index) + buffer-size))) + + (atomic-box-set! current-state-id-and-event-buffer-index-box + (cons id new-event-index)) + + (vector-set! event-buffer + new-event-index + (list id event-name data)))))) + + (spawn-fiber + (lambda () + (let* ((response + remote-port + (http-get + (string->uri "http://localhost:8746/events") + #:headers + `((last-event-id + . ,(number->string + (- initial-state-id + ;; Get some earlier events as well, as clients that + ;; are reconnecting might want them + 100)))) + #:streaming? #t))) + (setvbuf remote-port 'none) + + (let loop ((line (get-line remote-port))) + (or (eof-object? line) + ;; TODO: It would be good to replace this with a more general way + ;; of processing the event stream that handles + (begin + (when (string-prefix? "id: " line) + (let ((id + (string->number (string-drop line 4))) + (event-name + (string-drop + (get-line remote-port) + (string-length + "event: "))) + (data + (json-string->scm + (string-drop + (get-line remote-port) + (string-length "data: "))))) + (put-message + submission-channel + (list id event-name data)))) + + (loop (get-line remote-port))))))) + #:parallel? #t) + + (spawn-fiber + (lambda () + (while #t + (match (get-message submission-channel) + (('new-listener callback requested-after-state-id + listening-finished-channel) + + (let ((listener-channel (make-channel)) + (after-state-id + (match (atomic-box-ref + current-state-id-and-event-buffer-index-box) + ((current-state-id . event-buffer-index) + (if (and requested-after-state-id + (<= requested-after-state-id + current-state-id) + (match (vector-ref + event-buffer + (modulo + (+ event-buffer-index + (- requested-after-state-id + current-state-id)) + buffer-size)) + ((? unspecified? _) #f) + ((event-state-id event-name data) + (= event-state-id + requested-after-state-id)))) + requested-after-state-id + current-state-id))))) + (atomic-box-set! + listener-channels-box + (vhash-consq listener-channel + #t + (atomic-box-ref listener-channels-box))) + + (spawn-fiber-for-listener callback + after-state-id + submission-channel + listener-channel + listening-finished-channel))) + + (('remove-listener listener-channel) + (atomic-box-set! + listener-channels-box + (vhash-delq listener-channel + (atomic-box-ref listener-channels-box)))) + + ((id event-name data) + (store-event id event-name data) + + (vhash-fold + (lambda (listener-channel val res) + (spawn-fiber + (lambda () + (put-message listener-channel #t)) + #:parallel? #t) + #f) + #f + (atomic-box-ref listener-channels-box))))))) + + (values submission-channel + get-state-id))) + +(define* (listen-for-events events-channel callback + #:key after-state-id) + (let ((listening-finished-channel + (make-channel))) + (put-message + events-channel + (list 'new-listener + callback + after-state-id + listening-finished-channel)) + ;; This is designed to be useful in the controller, so this procedure + ;; shouldn't exit until callback has finished being called + (get-message listening-finished-channel))) + +(define* (make-controller assets-directory metrics-registry + events-channel state-channel + title + template-directory) + + (define handle-static-assets + (if (string-prefix? (%store-prefix) + assets-directory) + (static-asset-from-store-renderer assets-directory) + (static-asset-from-directory-renderer assets-directory))) + + (define gc-metrics-updater! + (get-gc-metrics-updater metrics-registry)) + + (define home-template-content + (call-with-input-file + (string-append + template-directory "/home.html") + get-string-all)) + + (lambda (request + method-and-path-components + mime-types + body) + + (define path + (uri-path (request-uri request))) + + (match method-and-path-components + (('GET) + (render-html + #:sxml (home title home-template-content))) + (('GET "activity") + (render-html + #:sxml (activity title (get-state state-channel)))) + (('GET "state") + (render-json + (get-state state-channel))) + (('GET "events") + (let ((headers (request-headers request)) + (query-parameters + (let lp ((lst (map uri-decode + (string-split (uri-query + (request-uri request)) + (char-set #\& #\=))))) + (match lst + ((key value . rest) + (cons (cons key value) (lp rest))) + (("") '()) + (() '()))))) + + (list (build-response + #:code 200 + #:headers '((content-type . (text/event-stream)))) + (lambda (port) + (listen-for-events + events-channel + (lambda (id event-name data) + (display + (simple-format #f "id: ~A\nevent: ~A\ndata: ~A\n\n" + id + event-name + (scm->json-string data)) + port) + (force-output port) + ;; TODO because the chunked output port doesn't call + ;; force-output on the underlying port, do that here. We + ;; want this event to be sent now, rather than when some + ;; buffer fills up. + (force-output (request-port request))) + #:after-state-id + (with-exception-handler + (lambda (exn) + (simple-format + (current-error-port) + "error: when processing Last-Event-ID header value: ~A\n" + (assoc-ref headers 'last-event-id)) + #f) + (lambda () + (or (and=> (assoc-ref headers 'last-event-id) + string->number) + (and=> (assoc-ref query-parameters "last_event_id") + string->number))) + #:unwind? #t)))))) + + (('GET "assets" rest ...) + (or (handle-static-assets (string-join rest "/") + (request-headers request)) + (list (build-response #:code 404) + (string-append + "Resource not found: " + (uri->string + (request-uri request)))))) + (('GET "metrics") + (gc-metrics-updater!) + (list (build-response + #:code 200 + #:headers '((content-type . (text/plain)) + (vary . (accept)))) + (lambda (port) + (write-metrics metrics-registry port)))) + ((method path ...) + (render-html + #:sxml (general-not-found + "Page not found" + "") + #:code 404))))) + +(define (handler request body controller) + (display + (format #f "~a ~a\n" + (request-method request) + (uri-path (request-uri request)))) + + (call-with-error-handling + (lambda () + (let-values (((request-components mime-types) + (request->path-components-and-mime-type request))) + (controller request + (cons (request-method request) + request-components) + mime-types + body))) + #:on-error 'backtrace + #:post-error (lambda args + (render-html #:sxml (error-page args) + #:code 100)))) + +(define* (start-bffe-web-server port host assets-directory + metrics-registry + #:key (controller-args '())) + (define state-channel + (make-state-channel)) + + (call-with-error-handling + (lambda () + (let ((finished? (make-condition))) + (call-with-sigint + (lambda () + (run-fibers + (lambda () + (let* ((initial-state-id + (assoc-ref + (get-state state-channel) + "state_id")) + (events-channel + get-state-id + (make-events-channel + initial-state-id)) + (controller + (apply make-controller assets-directory + metrics-registry + events-channel state-channel + controller-args))) + + ;; Wait until the events channel catches up + (while (< (get-state-id) initial-state-id) + (sleep 10)) + + (simple-format #t "Starting the server\n") + (run-server/patched (lambda (request body) + (apply values + (handler request body controller))) + #:host host + #:port port)) + + (wait finished?)))) + finished?))) + #:on-error 'backtrace + #:post-error (lambda (key . args) + (when (eq? key 'system-error) + (match args + (("bind" "~A" ("Address already in use") _) + (simple-format + (current-error-port) + "\n +error: bffe could not start, as it could not bind to port ~A + +Check if it's already running, or whether another process is using that +port. Also, the port used can be changed by passing the --port option.\n" + port))))))) diff --git a/bffe/view/activity.scm b/bffe/view/activity.scm new file mode 100644 index 0000000..484aa36 --- /dev/null +++ b/bffe/view/activity.scm @@ -0,0 +1,338 @@ +(define-module (bffe view activity) + #:use-module (srfi srfi-1) + #:use-module (srfi srfi-19) + #:use-module (ice-9 match) + #:use-module (ice-9 format) + #:use-module (bffe view util) + #:use-module ((guix store) #:select (%store-prefix)) + #:export (activity)) + +(define (activity title state) + (define categorised-agents + (let ((categories + '(("x86_64-linux" "i686-linux") + ("aarch64-linux" "armhf-linux") + ("powerpc64le-linux") + ("i586-gnu")))) + (map + (lambda (systems) + (cons systems + (sort + (filter + (lambda (agent) + (not + (null? + (lset-intersection + string=? + (vector->list + (assoc-ref agent "requested_systems")) + systems)))) + (vector->list + (assoc-ref state "agents"))) + (lambda (a b) + (string<? (or (assoc-ref a "name") "") + (or (assoc-ref b "name") "")))))) + categories))) + + (define (abbreviate-derivation drv) + (let ((base (string-drop + drv + (+ 1 (string-length (%store-prefix)))))) + (string-drop-right + (string-drop base (+ 32 1)) ;32 hash part + 1 hyphen + 4))) ;.drv + + (define (git-commit-hash-length? str) + (= (string-length str) 40)) + + (layout + #:title (string-append "Activity — " title) + #:head + `((style " +table tr:nth-child(even) { + background-color: var(--color-bg); +} + +.agents { + display: grid; + column-gap: 5px; + row-gap: 5px; + grid-template-columns: repeat(auto-fill, minmax(355px, 355px)); +} + +.agent { + border: 2px solid var(--color-bg-secondary); + border-radius: var(--border-radius); + padding: 8px; +} + +.agent h4 { + margin-block-start: 0px; + font-size: 22px; +} + +.agent-load { + border-width: 0px 12px 0px 0px; + border-style: solid; + padding-right: 3px; + + border-radius: 3px; +} + +.agent-load-normal { + border-color: #28a745; +} + +.agent-load-medium { + border-color: orange; +} + +.agent-load-high { + border-color: red; +} + +.agent-plan-size { + float: right; + clear: right; + + border-radius: 3px; +} + +.build-tag { + display: inline-block; + padding: .2em .4em .3em; + font-size: 77%; + font-weight: 700; + line-height: 1; + text-align: center; + white-space: nowrap; + vertical-align: baseline; + border-radius: .25em; + + background-color: var(--color-secondary-accent); +} + +.build { + overflow-x: auto; + white-space: nowrap; + + padding-top: 3px; + padding-bottom: 4px; + margin-bottom: 3px; +} + +.build:not(:first-child) { + border-top: 2px solid var(--color-bg-secondary); +} + +.hidden { + display: none; +} + +#recent-activity { + width: 100%; + height: 200px; + overflow-y: scroll; +} + +")) + #:body + `((main + (@ (id "main") + (data-stateid ,(assoc-ref state "state_id"))) + + (h2 "Recent activity") + (table + (@ (id "recent-activity")) + (tbody + (@ (id "recent-activity-body")))) + + (h2 "Agents") + ,@(append-map + (match-lambda + ((systems . agents) + `((h3 (@ (class "monospace")) + ,(string-join systems ", ")) + + (div + (@ (class "agents")) + + ,@(filter-map + (lambda (agent) + (if (assoc-ref agent "active") + (let ((all-builds + (vector->list + (assoc-ref agent "builds")))) + `(div + (@ (class "agent") + (id + ,(string-append + "agent-" + (assoc-ref agent "uuid"))) + (data-name + ,(assoc-ref agent "name"))) + ,(let ((last-status-update + (assoc-ref + agent + "last_status_update"))) + (if (and last-status-update + (and=> + (assoc-ref last-status-update + "timestamp") + (lambda (timestamp) + (let ((seconds + (time-second + (time-difference + (current-time time-utc) + (date->time-utc + (string->date + (string-append timestamp "Z") + "~Y-~m-~d ~H:~M:~S~z")))))) + (< seconds (* 60 5)))))) + (let* ((1min + (assoc-ref + last-status-update + "1min_load_average")) + (cores + (assoc-ref + last-status-update + "processor_count")) + (load-percentage + (/ (* 100 1min) + cores))) + `(span + (@ (style "float: right;") + (id + ,(string-append + "agent-" + (assoc-ref agent "uuid") + "-load")) + (class + ,(string-append + "agent-load " + (cond + ((< load-percentage 150) + "agent-load-normal") + ((< load-percentage 250) + "agent-load-medium") + (else + "agent-load-high")))) + (data-value + ,load-percentage)) + "Load: " + ,(number->string + (round load-percentage)) + "%")) + `(span + (@ (style "float: right;") + (id + ,(string-append + "agent-" + (assoc-ref agent "uuid") + "-load")) + (class "agent-load-unknown")) + "Status unknown"))) + (span + (@ (class "agent-plan-size") + (id + ,(string-append + "agent-" + (assoc-ref agent "uuid") + "-plan-size")) + (data-value + ,(assoc-ref + (assoc-ref agent "allocation_plan") + "count"))) + "Plan size: " + ,(assoc-ref + (assoc-ref agent "allocation_plan") + "count")) + (h4 (@ (style "display: block;")) + ,(assoc-ref agent "name")) + (div + (@ (class "agent-builds") + (id + ,(string-append + "agent-" + (assoc-ref agent "uuid") + "-builds"))) + ,@(map + (lambda (build index) + (let ((tags + (sort + (vector->list + (assoc-ref build "tags")) + (lambda (a b) + (string<? + (assoc-ref a "key") + (assoc-ref b "key")))))) + `(div + (@ (id + ,(string-append + "build-" + (assoc-ref build "uuid"))) + (data-derivation + ,(or (assoc-ref build "derivation_name") + (assoc-ref build "derivation-name"))) + (class + ,(string-append + "build" + (if (> index 3) + " hidden" + "")))) + (span + (@ (class "monospace") + (style "display: block;")) + ,(abbreviate-derivation + (or (assoc-ref build "derivation_name") + (assoc-ref build "derivation-name")))) + ,@(append-map + (lambda (tag) + `((span + (@ (class "build-tag")) + ,(assoc-ref tag "key") + ": " + ,(let ((val (assoc-ref + tag "value"))) + (if (git-commit-hash-length? val) + (string-take val 8) + val))) + (*ENTITY* nbsp))) + tags)))) + ;; TODO Sort builds by priority? + all-builds + (iota (length all-builds)))) + (span + (@ (id ,(string-append + "agent-" + (assoc-ref agent "uuid") + "-plus-x-builds")) + (style ,(string-append + (if (> (length all-builds) 4) + "display: block;" + "display: none;") + "margin-top: 10px; text-align: center;"))) + ,(let ((additional-builds + (- (length all-builds) + 4))) + (if (= additional-builds 1) + (simple-format #f "Plus ~A other build" + additional-builds) + (simple-format #f "Plus ~A other builds" + additional-builds)))) + (span + (@ (id ,(string-append + "agent-" + (assoc-ref agent "uuid") + "-no-allocated-builds")) + (style ,(string-append + (if (= 0 (length all-builds)) + "display: block;" + "display: none;") + "margin-top: 10px; text-align: center;"))) + "No allocated builds"))) + #f)) + agents))))) + categorised-agents) + + (script (@ (src "/assets/js/activity.js"))))))) diff --git a/bffe/view/home.scm b/bffe/view/home.scm new file mode 100644 index 0000000..820f75f --- /dev/null +++ b/bffe/view/home.scm @@ -0,0 +1,14 @@ +(define-module (bffe view home) + #:use-module (srfi srfi-1) + #:use-module (srfi srfi-19) + #:use-module (ice-9 match) + #:use-module (ice-9 format) + #:use-module (bffe view util) + #:export (home)) + +(define (home title template-content) + (layout + #:title title + #:body + `((main + (raw ,template-content))))) diff --git a/bffe/view/util.scm b/bffe/view/util.scm new file mode 100644 index 0000000..9b4a676 --- /dev/null +++ b/bffe/view/util.scm @@ -0,0 +1,268 @@ +;;; Build Farm Front-End +;;; +;;; Copyright © 2023 Christopher Baines <mail@cbaines.net> +;;; +;;; 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 +;;; <http://www.gnu.org/licenses/>. + +(define-module (bffe view util) + #:use-module (guix-data-service config) + #:use-module (guix-data-service web query-parameters) + #:use-module (guix-data-service web util) + #:use-module (guix-data-service web html-utils) + #:use-module ((guix-data-service web render) #:prefix guix-data-service:) + #:use-module (ice-9 ftw) + #:use-module (ice-9 vlist) + #:use-module (ice-9 match) + #:use-module (ice-9 binary-ports) + #:use-module (srfi srfi-1) + #:use-module (srfi srfi-19) + #:use-module (srfi srfi-26) + #:use-module (web uri) + #:use-module (web response) + #:use-module (texinfo) + #:use-module (texinfo html) + #:use-module (json) + #:export (layout + header + form-horizontal-control + + display-possible-store-item + display-store-item + display-store-item-short + + table/branches-with-most-recent-commits + + render-html + render-json + + general-not-found + error-page + + static-asset-from-store-renderer + static-asset-from-directory-renderer)) + +(define* (layout #:key + (head '()) + (body '()) + title + description) + `((doctype "html") + (html + (@ (lang "en")) + (head + (title ,(if title + (string-append title " — Build farm") + "Build farm")) + (meta (@ (http-equiv "Content-Type") + (content "text/html; charset=UTF-8"))) + (meta (@ (name "viewport") + (content "width=device-width, initial-scale=1"))) + ,@(if description + `((meta + (@ (name "description") + (content ,description)))) + '()) + (link + (@ (rel "stylesheet") + (media "screen") + (type "text/css") + (href "/assets/css/mvp.css"))) + (style + " + +:root { + --justify-important: left; + --justify-normal: center; + --line-height: 1.5; +} + +table td, +table th, +table tr { + text-align: center; +} + +header, main { + padding: 1rem; +} + +header { + border-bottom: 2px solid green; +} + +.monospace { + font-family: monospace; + font-size: 16px; +} + +@media (min-width: 700px) { + .large-screen-float-right { + float: right; + } +} + +.derivation { + display: block; + font-family: monospace; + font-size: 16px; +} + +@keyframes scale-move { + 0% { transform: scale(0.9,0); } + 100% { transform: scale(1,1); } +} + +.submitted-build { + animation: scale-move 0.8s; +} + +.tag { + display: inline-block; + border-radius: 10px; + background: var(--color-bg-secondary); + padding: 0.25em 0.4em; + margin-right: 0.25rem; + + font-family: monospace; + font-size: 14px; +} + +") + ,@head) + (body (header + (h1 ,title)) + ,@body)))) + +(define render-html + guix-data-service:render-html) + +(define render-json + guix-data-service:render-json) + +(define (general-not-found header-text body) + (layout + #:body + `((main + (h1 ,header-text) + (p ,body))))) + +(define* (error-page #:optional error) + (layout + #:body + `((main + (h1 "An error occurred") + (p "Sorry about that!") + ,@(if error + (match error + ((key . args) + `((b ,key) + (pre ,args)))) + '()))))) + +(define file-mime-types + '(("css" . (text/css)) + ("js" . (text/javascript)) + ("svg" . (image/svg+xml)) + ("png" . (image/png)) + ("gif" . (image/gif)) + ("woff" . (application/font-woff)) + ("ttf" . (application/octet-stream)) + ("html" . (text/html)))) + +(define (static-asset-from-store-renderer assets-directory) + (define last-modified + ;; Use the process start time as the last modified time, as the file + ;; metadata in the store is normalised. + (current-time)) + + (define files + (file-system-fold + (const #t) ; enter + (lambda (filename stat result) + (let ((relative-filename (string-drop filename + (+ 1 ; to account for the / + (string-length + assets-directory))))) + (cons (cons relative-filename + (call-with-input-file filename + get-bytevector-all)) + result))) + (lambda (name stat result) result) ; down + (lambda (name stat result) result) ; up + (lambda (name stat result) result) ; skip + (lambda (name stat errno result) + (error name)) + '() + assets-directory)) + + (define (send-file path contents) + (list `((content-type + . ,(assoc-ref file-mime-types + (file-extension path))) + (last-modified . ,(time-utc->date last-modified)) + (cache-control . (public + ;; Set the max-age at 5 minutes, as the files + ;; could change when the code changes + (max-age . ,(* 60 5))))) + contents)) + + (lambda (path headers) + (and=> (assoc-ref files path) + (lambda (contents) + (cond ((assoc-ref headers 'if-modified-since) + => + (lambda (client-date) + (if (time>? last-modified + (date->time-utc client-date)) + (send-file path contents) + (list (build-response #:code 304) ; "Not Modified" + #f)))) + (else + (send-file path contents))))))) + +(define (static-asset-from-directory-renderer assets-directory) + (lambda (path headers) + (render-static-file assets-directory path headers))) + +(define %not-slash + (char-set-complement (char-set #\/))) + +(define (render-static-file root path headers) + (let ((file-name (string-append root "/" path))) + (if (not (any (cut string-contains <> "..") + (string-tokenize path %not-slash))) + (let* ((stat (stat file-name #f)) + (modified (and stat + (make-time time-utc 0 (stat:mtime stat))))) + (define (send-file) + (list `((content-type + . ,(assoc-ref file-mime-types + (file-extension file-name))) + (last-modified . ,(time-utc->date modified)) + (cache-control . (no-cache))) + (call-with-input-file file-name get-bytevector-all))) + + (if (and stat (not (eq? 'directory (stat:type stat)))) + (cond ((assoc-ref headers 'if-modified-since) + => + (lambda (client-date) + (if (time>? modified (date->time-utc client-date)) + (send-file) + (list (build-response #:code 304) ;"Not Modified" + #f)))) + (else + (send-file))) + #f)) + #f))) diff --git a/bootstrap.sh b/bootstrap.sh new file mode 100755 index 0000000..872167c --- /dev/null +++ b/bootstrap.sh @@ -0,0 +1,3 @@ +#!/bin/sh + +autoreconf -vif diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..c660bc0 --- /dev/null +++ b/configure.ac @@ -0,0 +1,35 @@ +dnl -*- Autoconf -*- + +AC_INIT([bffe], [m4_translit(m4_esyscmd([cat VERSION]),m4_newline)]) +AC_CONFIG_AUX_DIR([build-aux]) +AM_INIT_AUTOMAKE([gnu color-tests -Wall -Wno-portability foreign]) +AM_SILENT_RULES([yes]) + +GUILE_PKG([3.0]) +GUILE_PROGS +if test "x$GUILD" = "x"; then + AC_MSG_ERROR(['guild' binary not found; please check your guile-2.2 installation.]) +fi + +GUILE_MODULE_AVAILABLE([have_json], [(json)]) +if test "x$have_json" != "xyes"; then + AC_MSG_ERROR([Guile-JSON is missing; please install it.]) +fi + +GUILE_MODULE_AVAILABLE([have_fibers], [(fibers web server)]) +if test "x$have_fibers" != "xyes"; then + AC_MSG_ERROR([Guile fibers is missing; please install it.]) +fi + +guilemoduledir="${datarootdir}/guile/site/${GUILE_EFFECTIVE_VERSION}" +AC_SUBST([guilemoduledir]) +AC_SUBST([GUILE_EFFECTIVE_VERSION]) + +AC_PATH_PROG([guix], [guix]) + +dnl Substitute placeholders to generate these target files +AC_CONFIG_FILES([Makefile]) +AC_CONFIG_FILES([scripts/bffe], [chmod +x scripts/bffe]) +AC_CONFIG_FILES([pre-inst-env], [chmod +x pre-inst-env]) + +AC_OUTPUT diff --git a/guile.am b/guile.am new file mode 100644 index 0000000..57062bd --- /dev/null +++ b/guile.am @@ -0,0 +1,21 @@ +ALL_SOURCES = $(SOURCES) $(TESTS) + +GOBJECTS = $(ALL_SOURCES:%.scm=%.go) + +nobase_mod_DATA = $(SOURCES) $(NOCOMP_SOURCES) +nobase_go_DATA = $(GOBJECTS) + +# Make sure source files are installed first, so that the mtime of +# installed compiled files is greater than that of installed source +# files. See +# <http://lists.gnu.org/archive/html/guile-devel/2010-07/msg00125.html> +# for details. +guile_install_go_files = install-nobase_goDATA +$(guile_install_go_files): install-nobase_modDATA + +CLEANFILES = $(GOBJECTS) +EXTRA_DIST = $(SOURCES) $(NOCOMP_SOURCES) +GUILE_WARNINGS = -Wunbound-variable -Warity-mismatch -Wformat +SUFFIXES = .scm .go +.scm.go: + $(AM_V_GEN)$(top_builddir)/pre-inst-env $(GUILE_TOOLS) compile $(GUILE_WARNINGS) -o "$@" "$<" diff --git a/guix-dev.scm b/guix-dev.scm new file mode 100644 index 0000000..417066b --- /dev/null +++ b/guix-dev.scm @@ -0,0 +1,67 @@ +;;; Build Farm Front-End +;;; +;;; Copyright © 2023 Christopher Baines <mail@cbaines.net> +;;; +;;; This file is part of bffe. +;;; +;;; bffe is free software; you can redistribute it and/or +;;; modify it under the terms of the GNU General Public License as +;;; published by the Free Software Foundation; either version 3 of the +;;; License, or (at your option) any later version. +;;; +;;; bffe is distributed in the hope that it will be +;;; useful, but WITHOUT ANY WARRANTY; without even the implied +;;; warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +;;; See the GNU General Public License for more details. +;;; +;;; You should have received a copy of the GNU General Public License +;;; along with the bffe. If not, see +;;; <http://www.gnu.org/licenses/>. + +;;; Run the following command to enter a development environment for +;;; the bffe: +;;; +;;; $ guix environment -l guix-dev.scm + +(use-modules ((guix licenses) #:prefix license:) + (guix packages) + (guix download) + (guix git-download) + (guix utils) + (guix build-system gnu) + (gnu packages) + (gnu packages autotools) + (gnu packages databases) + (gnu packages gnupg) + (gnu packages guile) + (gnu packages web) + (gnu packages guile-xyz) + (gnu packages package-management) + (gnu packages pkg-config) + (gnu packages texinfo) + (gnu packages ruby) + (srfi srfi-1)) + +(package + (name "bffe") + (version "0.0.0") + (source #f) + (build-system gnu-build-system) + (inputs + (list guix + guix-data-service + guile-json-4 + guile-fibers-next + guile-readline + guile-prometheus + guix-build-coordinator + guile-3.0-latest)) + (native-inputs + (list autoconf + automake + pkg-config + ruby-rerun)) + (synopsis "TODO") + (description "TODO") + (home-page "TODO") + (license license:gpl3+)) diff --git a/pre-inst-env.in b/pre-inst-env.in new file mode 100644 index 0000000..719e364 --- /dev/null +++ b/pre-inst-env.in @@ -0,0 +1,47 @@ +#!/bin/sh + +# Guix-Data-Service -- Information about Guix over time +# Copyright © 2012, 2013, 2014, 2015, 2017 Ludovic Courtès <ludo@gnu.org> +# Copyright © 2017 Eric Bavier <bavier@cray.com> +# Copyright © 2017 Ricardo Wurmus <rekado@elephly.net> +# Copyright © 2019 Christopher Baines <mail@cbaines.net> +# +# This file was adapted from GNU Guix and is part of Guix-Data-Service. +# +# Guix-Data-Service is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or (at +# your option) any later version. +# +# GNU Guix is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with GNU Guix. If not, see <http://www.gnu.org/licenses/>. + +# Usage: ./pre-inst-env COMMAND ARG... +# +# Run COMMAND in a pre-installation environment. Typical use is +# "./pre-inst-env guix build hello". + +# By default we may end up with absolute directory names that contain '..', +# which get into $GUILE_LOAD_PATH, leading to '..' in the module file names +# recorded by Guile. To avoid that, make sure we get a real absolute +# directory name. Additionally, use '-P' to get the canonical directory name +# so that Guile's 'relative' %file-port-name-canonicalization can actually +# work (see <http://bugs.gnu.org/17935>.) +abs_top_srcdir="`cd "@abs_top_srcdir@" > /dev/null; pwd -P`" +abs_top_builddir="`cd "@abs_top_builddir@" > /dev/null; pwd -P`" + +GUILE_LOAD_COMPILED_PATH="$abs_top_builddir${GUILE_LOAD_COMPILED_PATH:+:}$GUILE_LOAD_COMPILED_PATH" +GUILE_LOAD_PATH="$abs_top_builddir:$abs_top_srcdir${GUILE_LOAD_PATH:+:}$GUILE_LOAD_PATH" +export GUILE_LOAD_COMPILED_PATH GUILE_LOAD_PATH + +# Define $PATH so that `guix-data-service' and friends are easily found. + +PATH="$abs_top_builddir/scripts:$abs_top_builddir:$PATH" +export PATH + +exec "$@" diff --git a/scripts/bffe.in b/scripts/bffe.in new file mode 100644 index 0000000..d0ca978 --- /dev/null +++ b/scripts/bffe.in @@ -0,0 +1,124 @@ +#!@GUILE@ --no-auto-compile +-*- scheme -*- +-*- geiser-scheme-implementation: guile -*- +!# +;;; bffe - Build farm front-end +;;; Copyright © 2016, 2017 Ricardo Wurmus <rekado@elephly.net> +;;; Copyright © 2018 Arun Isaac <arunisaac@systemreboot.net> +;;; Copyright © 2019 Christopher Baines <mail@cbaines.net> +;;; +;;; This file is part of bffe. +;;; +;;; bffe is free software; you can redistribute it and/or modify it under the +;;; terms of the GNU General Public License as published by the Free Software +;;; Foundation; either version 3 of the License, or (at your option) any later +;;; version. +;;; +;;; bffe is distributed in the hope that it will be useful, but WITHOUT ANY +;;; WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS +;;; FOR A PARTICULAR PURPOSE. See the GNU General Public License for more +;;; details. +;;; +;;; You should have received a copy of the GNU General Public License along +;;; with the bffe. If not, see <http://www.gnu.org/licenses/>. + +(use-modules (srfi srfi-1) + (srfi srfi-37) + (ice-9 match) + (ice-9 textual-ports) + (system repl server) + (system repl repl) + (gcrypt pk-crypto) + (guix pki) + (prometheus) + (bffe server)) + +(define %options + ;; Specifications of the command-line options + (list (option '("repl") #f #t + (lambda (opt name arg result) + (alist-cons 'repl #t (alist-delete 'repl result)))) + (option '("pid-file") #t #f + (lambda (opt name arg result) + (alist-cons 'pid-file + arg + result))) + (option '("port") #t #f + (lambda (opt name arg result) + (alist-cons 'port + (string->number arg) + (alist-delete 'port result)))) + (option '("host") #t #f + (lambda (opt name arg result) + (alist-cons 'host + arg + (alist-delete 'host result)))) + (option '("title") #t #f + (lambda (opt name arg result) + (alist-cons 'title + arg + result))) + (option '("template-directory") #t #f + (lambda (opt name arg result) + (alist-cons 'template-directory + arg + result))))) + +(define %default-options + ;; Alist of default option values + `((port . 8767) + (host . "0.0.0.0") + + (assets-directory . ,(let ((install-dir + "@prefix@/share/bffe/assets") + (dev-dir + (string-append (getcwd) "/assets"))) + (if (file-exists? install-dir) + install-dir + dev-dir))) + (title . "Build farm") + (template-directory . ,(let ((install-dir + "@prefix@/share/bffe/templates") + (dev-dir + (string-append (getcwd) "/templates"))) + (if (file-exists? install-dir) + install-dir + dev-dir))))) + +(define (parse-options args) + (args-fold + args %options + (lambda (opt name arg result) + (error "unrecognized option" name)) + (lambda (arg result) + (error "extraneous argument" arg)) + %default-options)) + +(setvbuf (current-output-port) 'line) +(setvbuf (current-error-port) 'line) + +(let ((opts (parse-options (cdr (program-arguments))))) + (let ((pid-file (assq-ref opts 'pid-file))) + (when pid-file + (call-with-output-file pid-file + (lambda (port) + (simple-format port "~A\n" (getpid)))))) + + ;; Provide some visual space between the startup output and the + ;; server starting + (simple-format #t "\n\nStarting the server on http://~A:~A/\n\n" + (assq-ref opts 'host) + (assq-ref opts 'port)) + + (let* ((metrics-registry (make-metrics-registry + #:namespace + "bffe"))) + + (start-bffe-web-server + (assq-ref opts 'port) + (assq-ref opts 'host) + (assq-ref opts 'assets-directory) + metrics-registry + #:controller-args + (list (assq-ref opts 'title) + (assq-ref opts 'template-directory))))) diff --git a/templates/home.html b/templates/home.html new file mode 100644 index 0000000..b2a8d25 --- /dev/null +++ b/templates/home.html @@ -0,0 +1 @@ +Placeholder home template. |