diff options
author | Adam House <a@context.town> | 2024-06-21 01:21:23 -0500 |
---|---|---|
committer | Adam House <a@context.town> | 2024-06-21 08:28:38 -0500 |
commit | e2026185a9b8fdd69dd9ce6ed4d4425977e12b18 (patch) | |
tree | e20f2e0d3002952525024952bfeda9a8316e8a91 |
-rw-r--r-- | .gitignore | 2 | ||||
-rw-r--r-- | COPYING | 674 | ||||
-rw-r--r-- | Makefile | 39 | ||||
-rw-r--r-- | README.md | 111 | ||||
-rw-r--r-- | config/config.ha | 316 | ||||
-rw-r--r-- | cron/daemon.ha | 252 | ||||
-rw-r--r-- | cron/job.ha | 512 | ||||
-rw-r--r-- | cron/term.ha | 187 | ||||
-rw-r--r-- | crore.1.scd | 195 | ||||
-rw-r--r-- | example/conf.example | 7 | ||||
-rw-r--r-- | example/conf.trad.example | 4 | ||||
-rw-r--r-- | main.ha | 112 | ||||
-rw-r--r-- | sv/openrc/crore | 11 | ||||
-rw-r--r-- | sv/runit/crore/config | 4 | ||||
-rw-r--r-- | sv/runit/crore/log/run | 2 | ||||
-rw-r--r-- | sv/runit/crore/run | 3 | ||||
-rw-r--r-- | sv/runit/crore/tab | 9 |
17 files changed, 2440 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..508bb7c --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/crore +/crore.1 @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://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 <https://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 +<https://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 +<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..d06cfa4 --- /dev/null +++ b/Makefile @@ -0,0 +1,39 @@ +VERSION=0.1.3 +PREFIX?=/usr +BINDIR?=$(PREFIX)/bin +MANDIR?=$(PREFIX)/share/man + +SVCDIR?=/etc/sv +.DEFAULT_GOAL=all + +crore: + hare build + +crore.1: crore.1.scd + scdoc < $< > $@ + +all: crore crore.1 + +clean: + rm crore crore.1 + +install: all + mkdir -p $(DESTDIR)$(BINDIR) $(DESTDIR)$(MANDIR)/man1 + install -m755 crore $(DESTDIR)$(BINDIR)/crore + install -m644 crore.1 $(DESTDIR)$(MANDIR)/man1/crore.1 + +install-runit: install + mkdir -p $(DESTDIR)$(SVCDIR)/crore + mkdir -p $(DESTDIR)$(SVCDIR)/crore/log + install -m755 sv/runit/crore/run $(DESTDIR)$(SVCDIR)/crore + install -m644 sv/runit/crore/config $(DESTDIR)$(SVCDIR)/crore + install -m644 sv/runit/crore/tab $(DESTDIR)$(SVCDIR)/crore + install -m755 sv/runit/crore/log/run $(DESTDIR)$(SVCDIR)/crore/log + +uninstall: + rm -f $(DESTDIR)$(BINDIR)/crore + rm -f $(DESTDIR)$(MANDIR)/man1/crore.1 + rm -rf $(DESTDIR)$(SVCDIR)/crore + +check: + hare test diff --git a/README.md b/README.md new file mode 100644 index 0000000..c08a39a --- /dev/null +++ b/README.md @@ -0,0 +1,111 @@ +# crore + +`crore` is a lightweight cron daemon written in less than 1400 lines of pure +Hare. It started as a fun way for me to learn Hare and has become my primary +cron daemon on Linux. + +## Design Priorities + +`crore` is designed to be: + +* Run without a filesystem +* Fast +* As light on system resources as possible + +In that order. + +`crore` is single-threaded, stays off the heap as much as it can, only reads +the filesystem at init to load the crontab (and even this is optional) and then +never again touches the disk. It only keeps enough in memory to know what and +when to execute, and it only ever has one child process executing at a time. +Its method of resolving the next execution time of a task avoids exhaustively +iterating through upcoming datetimes (except in some edge cases regarding +weekday resolution, for now) in an effort to reduce the load required when tasks +are rescheduled. + +On performance, it benefits from being written entirely with the Hare standard +library. At the moment, regexes are not used, but that may change in the future +depending on performance relative to the current technique of splitting strings +in various ways to parse expressions. + +Of course, if a spawned process is intensive on system resources, `crore` is +unable to address that. + +### Current Features + +* Validates every cron expression at init and shows you next trigger time +* Tells you at init how long it'll be sleeping until the next scheduled job +* Sleeps until the next job must run and does not wake every minute +* Logs in a sensible, observable way about what it's doing +* Clear, intuitive way to set environment variables and optional verification +they have been understood +* Supports all major cron syntax features (e.g. ranges, steps, wildcards) +* All functionality is available via command line arguments, so filesystem +access is optional; alternatively, all functionality can be configured from a +config file if you prefer + +`crore` also supports hooks, which are commands automatically run before and/or +after each cronjob executes. Using hooks, highly customized cron setups are +possible. + +### Differences From Other Cron Implementations + +* Executes jobs in one thread, sequentially, to minimize its footprint +* All times are in UTC all the time +* It functions from an in-memory copy of its crontab that it holds from when it +inits. It doesn't check again. This is deliberate to minimize interaction with +the filesystem. +* It looks in the current user's home directory (`$HOME/.config/crore/tab`) for +its crontab by default. You can make it look anywhere, though, or just feed it +expressions from the command line. + +For those who want a more standard cron experience, there is a commented +`conf.trad.example` example config in the repo. + +## Build + +You'll need [Hare](https://harelang.org/installation/) installed. + +``` +make +sudo make install +``` + +Note: If you use my Makefile, this installs to `/usr/bin` by default so the +default `runit` configuration can see it. Adjust PREFIX if you don't want that. + +You'll need to daemonize this yourself, however you prefer. On Void Linux I use +a simple runit config which is in the repo. If you use an applicable `runit` +setup with an `/etc/sv` directory, you can run `make install-runit` to put that +in place for you. + +There is also a default OpenRC configuration for use with applicable systems. + +See `crore(1)`. + +## Benchmarking + +This section is as of v0.1.2. + +By my own tests conducted via `valgrind(1)`, on my x86_64 Linux computer on 13 +Dec 2023, `crore` wants about 9.5 KiB plus ~0.5 KiB per expression, depending +on the length of the commands in each expression. At init, it allocates about +three times that on the heap before freeing it. Rescheduling a cronjob after +it executes causes a ~3KiB alloc which is then freed almost immediately. +As expected, the volume of cronjobs doesn't make that worse because the +rescheduling is done sequentially. + +The steady-state footprint is therefore a max of, conservatively, 13 KiB plus +<1KiB per expression. Pretty nice! + +For reference, this is about a 10x bigger footprint than `cronie`, but that's +the price we have to pay to run from memory. It's still vanishingly small! (The +price is also paid because of being able to report the next execution time of +things; without that, there'd be no reason to do anything but wake every minute +and execute whatever was applicable. There's certainly a performance trade-off +there, but I think it's worth it.) + +## Contributing + +I welcome patches or direct emails. Check out my lists or profile here on +sourcehut. diff --git a/config/config.ha b/config/config.ha new file mode 100644 index 0000000..8b57e29 --- /dev/null +++ b/config/config.ha @@ -0,0 +1,316 @@ +// Copyright (C) 2023-2024 Adam House +// +// This file is part of crore. +// +// crore 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. +// +// crore 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 +// crore. If not, see <https://www.gnu.org/licenses/>. + +use bufio; +use encoding::utf8; +use fmt; +use fs; +use errors; +use getopt; +use io; +use os; +use os::exec; +use shlex; +use strings; + +export type verbosity = enum uint { + SILENT = 0, + PRIVATE = 1, + NORMAL = 2, +}; + +export type config = struct { + no_tab: bool, + tab: str, + verbosity: verbosity, + envs: []keyval, + exprs: []str, + legacy: bool, + before: []str, + after: []str, +}; + +export type keyval = struct { + k: str, + v: str, +}; + +export fn build() (config | int) = { + const cmd = getopt::parse( + os::args, + "cron daemon", + ('a', "command", "execute this after each job"), + ('b', "command", "execute this before each job"), + ('e', "key=val", "env vars for cron env"), + ('l', "legacy mode (see crore(1))"), + ('n', "no crontab file"), + ('p', "privacy-conscious logging"), + ('s', "silent"), + ('t', "tabfile", "path to crontab"), + ('v', "print version and exit"), + ('x', "expression", "extra cron expressions"), + "configfile", + ); + defer getopt::finish(&cmd); + + let out = config { + legacy = false, + no_tab = false, + tab = "", + verbosity = verbosity::NORMAL, + envs = [], + exprs = [], + before = [], + after = [], + }; + + let lines: []str = []; + if (len(cmd.args) > 0) { + lines = parse_file(cmd.args[0]); + }; + + for (let i = 0z; i < len(lines); i += 1) { + if (len(lines[i]) == 0 || strings::hasprefix(lines[i], '#')) { + continue; + }; + + const kv = parse_keyval(lines[i]); + + if (len(kv.k) == 0) { + free(kv.v); + return i: int; + }; + + switch (kv.k) { + case "after" => { + match (shlex::split(kv.v)) { + case let c: []str => { + out.after = c; + }; + case => return i: int; + }; + }; + case "before" => { + match (shlex::split(kv.v)) { + case let c: []str => { + out.before = c; + }; + case => return i: int; + }; + }; + case "legacy" => { + out.legacy = true; + free(kv.v); + }; + case "notabfile" => { + out.no_tab = true; + free(kv.v); + }; + case "private" => { + if (out.verbosity > verbosity::PRIVATE) { + out.verbosity = verbosity::PRIVATE; + }; + free(kv.v); + }; + case "silent" => { + out.verbosity = verbosity::SILENT; + free(kv.v); + }; + case "tabfile" => { + out.tab = kv.v; + }; + case => { + // assume anything else is an env var + append(out.envs, kv); + }; + }; + }; + free(lines); + + for (let i = 0z; i < len(cmd.opts); i += 1) { + const opt = cmd.opts[i]; + switch (opt.0) { + case 'a' => { + match (shlex::split(opt.1)) { + case let c: []str => { + out.after = c; + }; + case => return i: int; + }; + }; + case 'b' => { + match (shlex::split(opt.1)) { + case let c: []str => { + out.before = c; + }; + case => return i: int; + }; + }; + case 'e' => { + let kv = parse_keyval(opt.1); + if (len(kv.k) == 0) { + free(kv.v); + return -1; + }; + append(out.envs, kv); + }; + case 'l' => { + let test_pipe = os::exec::pipe(); + out.legacy = true; + }; + case 'n' => { + out.no_tab = true; + }; + case 'p' => { + if (out.verbosity > verbosity::PRIVATE) { + out.verbosity = verbosity::PRIVATE; + }; + }; + case 's' => { + out.verbosity = verbosity::SILENT; + }; + case 't' => { + out.tab = opt.1; + }; + case 'v' => { + version(); + }; + case 'x' => { + append(out.exprs, opt.1); + }; + case => abort(); + }; + }; + + if (out.verbosity > verbosity::SILENT) { + for (let i = 0z; i < len(out.envs); i += 1) { + let v = out.envs[i].v; + if (out.verbosity <= verbosity::PRIVATE) { + v = "{redacted}"; + }; + fmt::printfln( + "crore: env: {}={}", out.envs[i].k, v + )!; + }; + + if (len(out.before) > 0) { + if (out.verbosity <= verbosity::PRIVATE) { + fmt::println("crore: registered before-hook")!; + } else { + const b = strings::join(" ", out.before...); + defer free(b); + + fmt::printfln( + "crore: registered before-hook: {}", + b, + )!; + }; + }; + + if (len(out.after) > 0) { + if (out.verbosity <= verbosity::PRIVATE) { + fmt::println("crore: registered after-hook")!; + } else { + const a = strings::join(" ", out.after...); + defer free(a); + + fmt::printfln( + "crore: registered after-hook: {}", + a, + )!; + }; + }; + + fmt::println("crore: config is good")!; + }; + return out; +}; + +// Gives the contents of a file, one string per line. The caller must free the +// return value. Aborts with fatal error if there is any read problem. +export fn parse_file(in: str) []str = { + const f = match (os::open(in, fs::flag::RDONLY)) { + case let f: io::file => + yield f; + case let err: fs::error => + fmt::fatalf( + "bad file at {}: {}", + in, + fs::strerror(err), + ); + }; + + let lines: []str = []; + for (true) { + const line = match (bufio::read_line(f)) { + case let l: []u8 => + yield match (strings::fromutf8(l)) { + case let s: str => + yield s; + case let err: utf8::invalid => + fmt::fatalf( + "bad file at {}: {}", + in, + utf8::strerror(err), + ); + }; + case io::EOF => + break; + case let err: io::error => + fmt::fatalf( + "bad file at {}: {}", + in, + io::strerror(err), + ); + }; + + append(lines, line); + }; + + io::close(f)!; + + return lines; +}; + +// Turns `key = val` into a key-value struct. Blank on value without = sign +// separated by spaces. +// +// The first such equal sign is the delimiter; the rest are treated as part of +// the value. The caller must free the returned `v` field on the struct. +fn parse_keyval(in: str) keyval = { + const kv = strings::split(in, " = "); + defer free(kv); + + let out = keyval { + k = "", + v = "", + }; + + if (len(kv) > 0) { + out.k = kv[0]; + }; + + if (len(kv) > 1) { + out.v = strings::join(" = ", kv[1..]...); + }; + + return out; +}; + +fn version() never = { + fmt::printfln("v0.2.2")!; + os::exit(0); +}; diff --git a/cron/daemon.ha b/cron/daemon.ha new file mode 100644 index 0000000..865c76f --- /dev/null +++ b/cron/daemon.ha @@ -0,0 +1,252 @@ +// Copyright (C) 2023-2024 Adam House +// +// This file is part of crore. +// +// crore 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. +// +// crore 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 +// crore. If not, see <https://www.gnu.org/licenses/>. + +use os::exec; +use fmt; +use strconv; +use strings; +use time; + +use config; + +// Continuously sleeps until the next time a cronjob is scheduled to trigger, +// executes the relevant jobs, reschedules them, and goes back to sleep. +// Additional params come from config: verbosity and legacy mode (see +// run_legacy() for details). +export fn serve(jobs: []cronjob, conf: *config::config) never = { + const now = unix_now(); + for (true) { + sleep(now, jobs, conf.verbosity); + + now = unix_now(); + let reschedulable: []*cronjob = []; + + // run all applicable jobs, then reschedule them all + for (let i = 0z; i < len(jobs); i += 1) { + if (jobs[i].next_run <= now) { + if (conf.legacy) { + run_legacy(&jobs[i], conf); + } else { + run(&jobs[i], conf); + }; + append(reschedulable, &jobs[i]); + }; + }; + + for (let i = 0z; i < len(reschedulable); i += 1) { + schedule(reschedulable[i])!; + }; + + free(reschedulable); + }; +}; + +// Executes the command associated with the cronjob, logging nonzero result. +fn run(j: *cronjob, conf: *config::config) void = { + if (len(conf.before) > 0) { + run_before_hook(conf); + }; + + const (res, dur) = exec(j.cmd, &conf.envs); + if (res is exec::error) { + fmt::println(exec::strerror(res: exec::error))!; + return; + }; + const res = res: exec::status; + const exit_s = exec::exit(&res); + + const cmdstr = cmd_str(j); + defer free(cmdstr); + + let res_int = 0; + match (exit_s) { + case let s: exec::exited => { + res_int = s: int; + if (s: int != 0 && + conf.verbosity > config::verbosity::SILENT + ) { + fmt::printfln( + "cronjob exited status {} ({})", + s: int, + cmdstr, + )!; + }; + }; + case let s: exec::signaled => { + res_int = s: int; + if (conf.verbosity > config::verbosity::SILENT) { + fmt::printfln( + "cronjob exited from signal {} ({})", + res_int, + cmdstr, + )!; + }; + }; + }; + + if (len(conf.after) > 0) { + run_after_hook(conf, strconv::itos(res_int), dur); + }; +}; + +// Executes the command associated with the cronjob in legacy mode. We capture +// the stdout and stderr of the proc, expecting nothing. If we get anything, we +// assume an error has occurred, log accordingly, then let the output continue +// along. Exit statuses are ignored. +// +// This is a somewhat arbitrary behavior that is designed specifically for +// compatibility with the prevailing way of doing cron. +// +// One layer deeper, this method calls exec::pipe(), which is less portable than +// everything else in this program. Elsewhere, we test this method doesn't abort +// on the system before we let the user select legacy mode. +// +// We also keep off the stack but intercept all stdout and stderr from the +// underlying process calls, so be mindful if anything logs a heavy amount. +// +// Seriously, just don't use this. +fn run_legacy(j: *cronjob, conf: *config::config) void = { + if (len(conf.before) > 0) { + run_before_hook(conf); + }; + + const (out, dur) = exec_legacy(j, &conf.envs); + if ((len(out.0) == 0 && len(out.1) == 0) || + conf.verbosity == config::verbosity::SILENT) { + + return; + }; + + if (conf.verbosity == config::verbosity::PRIVATE) { + fmt::println("crore: got non-empty output (check logs)")!; + return; + }; + + let cmdstr = cmd_str(j); + defer free(cmdstr); + + fmt::printfln( + "crore: got non-empty output from `{}`:", + cmdstr, + )!; + if (len(out.0) > 0) { + fmt::println("stdout:", out.0...)!; + }; + if (len(out.1) > 0) { + fmt::println("stderr:", out.1...)!; + }; + + if (len(conf.after) > 0) { + run_after_hook(conf, out.1, dur); + }; +}; + +fn run_before_hook(conf: *config::config) void = { + if (conf.verbosity > config::verbosity::SILENT) { + fmt::println("crore: before-hook")!; + }; + + let hook_envs: []config::keyval = [config::keyval { + k = "CRORE_COMMAND", + v = strings::join(" ", conf.before...), + }]; + defer free(hook_envs[0].v); + + const ignored = exec(conf.before, &conf.envs, &hook_envs); +}; + +fn run_after_hook(conf: *config::config, r: str, dur: time::duration) void = { + if (conf.verbosity > config::verbosity::SILENT) { + fmt::println("crore: after-hook")!; + }; + let hook_envs: []config::keyval = [ + config::keyval { + k = "CRORE_COMMAND", + v = strings::join(" ", conf.after...), + }, + config::keyval { + k = "CRORE_RESULT", + v = r, + }, + config::keyval { + k = "CRORE_DURATION", + v = strconv::i64tos(dur / 1000), + }, + ]; + defer free(hook_envs[0].v); + + const ignored = exec(conf.after, &conf.envs, &hook_envs); +}; + +// Sleeps until the first cronjob in the list must execute. Logs as it goes. +// Uses the `next_run` field of the cronjobs for convenience, NOT the cron +// expressions. +// +// If the next execution time of any job is indicated in the past, returns +// immediately without logging. +fn sleep(now: i64, jobs: []cronjob, v: config::verbosity) void = { + let earliest = jobs[0]; + let earliest_count = 0; + + for (let i = 0z; i < len(jobs); i += 1) { + if (jobs[i].next_run < earliest.next_run) { + earliest = jobs[i]; + earliest_count = 1; + } else if (jobs[i].next_run == earliest.next_run) { + earliest_count += 1; + }; + }; + + const secs = earliest.next_run - now; + if (secs <= 0) { + return; + }; + + switch (v) { + case config::verbosity::SILENT => { + time::sleep(secs * 1e9); + }; + case config::verbosity::PRIVATE => { + fmt::printfln("crore: sleeping {}s", secs)!; + time::sleep(secs * 1e9); + fmt::println("crore: awake")!; + }; + case config::verbosity::NORMAL => { + let cmd = strings::join(" ", earliest.cmd...); + if (earliest_count > 1) { + free(cmd); + cmd = fmt::asprintf( + "{} coincident jobs", earliest_count + ); + }; + + fmt::printfln( + "crore: sleeping {}s until: {}", secs, cmd + )!; + + time::sleep(secs * 1e9); + + fmt::printfln("crore: awake for: {}", cmd)!; + + free(cmd); + }; + }; +}; + +// Returns the current time as a Unix timestamp. +fn unix_now() i64 = { + return time::unix(time::now(time::clock::REALTIME)); +}; diff --git a/cron/job.ha b/cron/job.ha new file mode 100644 index 0000000..b8e1bfb --- /dev/null +++ b/cron/job.ha @@ -0,0 +1,512 @@ +// Copyright (C) 2023-2024 Adam House +// +// This file is part of crore. +// +// crore 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. +// +// crore 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 +// crore. If not, see <https://www.gnu.org/licenses/>. + +use errors; +use fmt; +use io; +use os; +use os::exec; +use shlex; +use sort; +use sort::cmp; +use strconv; +use strings; +use time; +use time::chrono; +use time::date; + +use config; + +// A single line of a crontab; a command to be executed on a schedule. +export type cronjob = struct { + expression: []str, + next_run: i64, // epoch timestamp + next_run_date: date::date, + cmd: []str +}; + +// Creates a new cronjob based on the passed cron expression and command. +// Expects input in the form of a full cron line, i.e. `* * * * * /bin/sh`. +export fn new(s: str) (cronjob | errors::invalid | shlex::syntaxerr) = { + const cron_item_split = strings::splitn(s, " ", 6); + + if (len(cron_item_split) != 6) { + return errors::invalid; + }; + + let c = cronjob { + expression = cron_item_split[0..5], + cmd = shlex::split(cron_item_split[5])?, + next_run = -1, + next_run_date = date::nowutc(), + }; + + if (schedule(&c) is void) { + return c; + } else { + return errors::invalid; + }; +}; + +// Schedules or reschedules the cronjob for the next applicable time, based on +// its cron expression. Will never fail if the cron expression is valid. +export fn schedule(j: *cronjob) (void | errors::invalid) = { + match (next(j)) { + case let n: date::date => { + j.next_run_date = n; + + const d = date::asformat("%s", &n)!; + j.next_run = strconv::stoi(d)!; + free(d); + }; + case => { + return errors::invalid; + }; + }; +}; + +// Executes the command represented by the given args. The first arg is +// expected to be the path to the executable. +export fn exec( + args: []str, + envs: *[]config::keyval... +) ((exec::status | exec::error), time::duration) = { + const cmd: exec::command = match (exec::cmd(args[0], args[1..]...)) { + case let c: exec::command => yield c; + case let err: exec::error => return (err, 0); + }; + + // set up env vars if any + for (let i = 0z; i < len(envs); i += 1) { + for (let j = 0z; j < len(envs[i]); j += 1) { + exec::setenv(&cmd, envs[i][j].k, envs[i][j].v)!; + }; + }; + + const start = time::now(time::clock::MONOTONIC); + const proc: exec::process = match (exec::start(&cmd)) { + case let p: exec::process => yield p; + case let err: exec::error => return (err, 0); + }; + + let out = exec::wait(&proc); + return (out, time::diff(start, time::now(time::clock::MONOTONIC))); +}; + +// Executes the command attached to the cronjob in legacy mode (see +// run_legacy() for details). The first return value is stdout, then stderr. +export fn exec_legacy( + j: *cronjob, envs: *[]config::keyval... +) ((str, str), time::duration) = { + const cmd: exec::command = match (exec::cmd(j.cmd[0], j.cmd[1..]...)) { + case let c: exec::command => yield c; + case let err: exec::error => { + return (("", exec::strerror(err)), 0); + }; + }; + + // set up env vars if any + for (let i = 0z; i < len(envs); i += 1) { + for (let j = 0z; j < len(envs[i]); j += 1) { + exec::setenv(&cmd, envs[i][j].k, envs[i][j].v)!; + }; + }; + + // intercept all output + let p = exec::pipe(); + exec::addfile(&cmd, os::stdout_file, p.1); + let q = exec::pipe(); + exec::addfile(&cmd, os::stderr_file, q.1); + + const start = time::now(time::clock::MONOTONIC); + const proc: exec::process = match (exec::start(&cmd)) { + case let p: exec::process => yield p; + case let err: exec::error => { + return (("", exec::strerror(err)), 0); + }; + }; + + io::close(p.1)!; + io::close(q.1)!; + + let stdout_data = io::drain(p.0)!; + let stderr_data = io::drain(q.0)!; + + defer free(stdout_data); + defer free(stderr_data); + + io::close(p.0)!; + io::close(q.0)!; + + let ignored = exec::wait(&proc); + let dur = time::diff(start, time::now(time::clock::MONOTONIC)); + + let b: []u8 = []; + let d: []u8 = []; + if (len(stdout_data) > 0) { + append(b, stdout_data...); + }; + + if (len(stderr_data) > 0) { + append(d, stderr_data...); + }; + + let out = (strings::fromutf8(b), strings::fromutf8(d)); + if (!(out.0 is str) || !(out.1 is str)) { + return (("", "output not valid utf-8"), dur); + }; + + return ((out.0: str, out.1: str), dur); +}; + +// Prints the contents of the cronjob. +export fn print(j: *cronjob) void = { + const s = date::asformat("%a %Y-%m-%dT%T%z", &j.next_run_date)!; + const expr = strings::join(" ", j.expression...); + const cmd = strings::join(" ", j.cmd...); + + defer free(s); + defer free(expr); + defer free(cmd); + + fmt::printfln( + "crore: expr: {}, cmd: {}, next: {} ({})", + expr, cmd, j.next_run, s, + )!; +}; + +// Reports the next datetime, in UTC, at which the cronjob will trigger. +export fn next(j: *cronjob) ( + date::date | date::error | errors::invalid | chrono::discontinuity +) = { + const minutes = parse_term(j.expression[0], 0, 59)?; + const hours = parse_term(j.expression[1], 0, 23)?; + const days = parse_term(j.expression[2], 1, 31)?; + const months = parse_term(j.expression[3], 1, 12)?; + const dows = parse_term(j.expression[4], 0, 6)?; + + defer free(minutes); + defer free(hours); + defer free(days); + defer free(months); + defer free(dows); + + const now = date::nowutc(); + + const next_date = next_applicable_date(&now, months, days, dows); + + return next_applicable_time(&now, &next_date, hours, minutes); + +}; + +// condense returns the next applicable number from a set of terms, and is a +// nasty one because it has the potential to wrap around. The second result is +// a bool indicating whether we wrapped around such that the next applicable +// value is lower than the input value (i.e. we are at hour 23 and matched +// after midnight). +fn condense( + t: []term, + global_min: int, + global_max: int, + in: int, + include_current: bool +) (int, bool) = { + + let outs: []int = []; + defer free(outs); + + for (let i = 0z; i < len(t); i += 1) { + append(outs, next_applicable(t[i], in, include_current)); + }; + + if (!include_current) { + in += 1; + if (in > global_max) { + in = global_min; + + let lowest = t[0].min; + for (let i = 0z; i < len(t); i += 1) { + if (t[i].min < lowest) { + lowest = t[i].min; + }; + }; + + return (lowest, true); + }; + }; + + // get the lowest that is higher than input value, + // then fall back to absolute lowest if not possible. + let lowest = 999; + let low_wraps_around = true; + + for (let i = 0z; i < len(outs); i += 1) { + if (outs[i] < in) { + continue; + }; + + if (outs[i] < lowest) { + lowest = outs[i]; + low_wraps_around = false; + }; + }; + + if (!low_wraps_around) { + return (lowest, false); + }; + + lowest = t[0].min; + for (let i = 0z; i < len(t); i += 1) { + if (t[i].min < lowest) { + lowest = t[i].min; + }; + }; + + return (lowest, true); +}; + +// Returns the value closest to in that matches the term. It will "wrap around" +// if necessary, i.e. if the term matches `1` only and `in == 4`. +fn next_applicable(t: term, in: int, include_current: bool) int = { + if (!include_current) { + in += 1; + if (in > t.max) { + in = t.min; + }; + }; + + if (in <= t.min || in > t.max) { + return t.min; + }; + + for (let i = t.step; i <= t.max; i += t.step) { + if (t.step > 1 && i >= in && i % t.step == 0) { + return i; + }; + + if (i == in) { + return i; + }; + }; + + return t.min; +}; + +fn next_applicable_date( + now: *date::date, m: []term, d: []term, dow: []term +) date::date = { + let cur_year = date::year(now); + let cur_doy = date::yearday(now); + + let (cand_day, day_wrapped) = condense(d, 1, 31, date::day(now), true); + + let (cand_month, month_wrapped) = condense( + m, 1, 12, date::month(now), !day_wrapped + ); + + // in cron, 0=Sun; in Hare, 0=Mon + const dow_list = to_slice(dow, -1); + defer free(dow_list); + + let candidate = date::new( + time::chrono::UTC, + 0, + cur_year, + cand_month, + cand_day, + )!; + + // failsafe to prevent matching in the past of current year + // TODO: This can be reworked. + if (date::yearday(&candidate) < cur_doy) { + cand_month = condense(m, 1, 12, 1, true).0; + cand_day = condense(d, 1, 31, 1, true).0; + + candidate = date::new( + time::chrono::UTC, + 0, + cur_year + 1, + cand_month, + cand_day, + )!; + }; + + if (len(dow_list) == 0) { + return candidate; + }; + + // TODO: Make this more efficient. Weekday params that are + // restrictive with month and day are silly and this really + // shouldn't have to iterate more than a few times in reality! + for (true) { + const cand_dow = date::weekday(&candidate); + + for (let i = 0z; i < len(dow_list); i += 1) { + if ( + dow_list[i] == cand_dow && + is_applicable(m, date::month(&candidate)) && + is_applicable(d, date::day(&candidate)) + ) { + return candidate; + }; + }; + + candidate = date::reckon( + candidate, + 0, + date::period { + days = 1, + ... + }, + ); + }; +}; + +fn next_applicable_time( + now: *date::date, cur: *date::date, h: []term, m: []term +) date::date = { + let cur_hr = 0; + let cur_min = 0; + let cur_day = date::day(cur); + + let cand_min = condense(m, 0, 59, cur_min, true).0; + let cand_hour = condense(h, 0, 23, cur_hr, true).0; + + if (date::year(now) == date::year(cur) && + date::month(now) == date::month(cur) && + date::day(now) == date::day(cur)) + { + const (new_min, min_wrapped) = condense( + m, 0, 59, date::minute(now), false + ); + const (new_hour, hour_wrapped) = condense( + h, 0, 23, date::hour(now), !min_wrapped + ); + + cand_min = new_min; + cand_hour = new_hour; + + if (hour_wrapped) { + cur_day += 1; + cand_min = condense(m, 0, 59, cur_min, true).0; + cand_hour = condense(h, 0, 23, cur_hr, true).0; + }; + }; + + return date::new( + time::chrono::UTC, + 0, + date::year(cur), + date::month(cur), + cur_day, + cand_hour, + cand_min + )!; +}; + +// Returns a bool indicating whether the given `in` value is applicable to any +// passed term. +fn is_applicable(terms: []term, in: int) bool = { + for (let i = 0z; i < len(terms); i += 1) { + const t = terms[i]; + if (in > t.max || in < t.min) { + continue; + }; + + if (in == t.min || in % t.step == 0) { + return true; + }; + }; + + return false; +}; + +// Returns slices for nums that meet the criteria for the term. Empty list +// means no restrictions exist based on this term. (The logic to check for +// this is currently lazy and only applies to days of week.) +fn to_slice(terms: []term, shift: int) []int = { + let out: []int = []; + + for (let t = 0z; t < len(terms); t += 1) { + if ( + terms[t].min == 0 && + terms[t].max == 6 && + terms[t].step == 1 + ) { + continue; + }; + + if (terms[t].min < terms[t].step) { + append(out, terms[t].min); + }; + + for ( + let i = terms[t].step; + i <= terms[t].max; + i += terms[t].step) + { + if (i < terms[t].min) { + continue; + }; + + let n = i + shift; + + if (n < terms[t].min) { + n = terms[t].max - (terms[t].min - n); + } else if (n > terms[t].max) { + n = terms[t].min + (n - terms[t].max); + }; + + append(out, n); + }; + }; + + return out; +}; + +// Returns a string representing the cronjob command. +// The caller must free the returned value. +fn cmd_str(j: *cronjob) str = { + return strings::join(" ", j.cmd...); +}; + +@test fn cronjob_parsing() void = { + // Because the current time is always changing, manual inspection + // is best for testing these. This is why this test prints. + const cases: []str = [ + "* * * * * /bin/sh", + "*/2 * * * * /bin/sh", + "* 2 * * * /bin/sh", + "8 * * * * /bin/sh", + "9-18 * * * * /bin/sh", + "10-18,5 * * * * /bin/sh", + "54,10-18 * * * * /bin/sh", + "4 5 6 7 4 /bin/sh", + "* * 23 12 3 /bin/sh" + "8-18/4 * * * * /bin/sh", + "8-18,5/2 * * * * /bin/sh", + "5,8-18/5 * * * * /bin/sh", + "4 5 6 7 4/2 /bin/sh", + "0 0 1 1 6 /bin/sh", + ]; + + for (let i = 0z; i < len(cases); i += 1) { + let j = new(cases[i])!; + fmt::printf("{}\n", cases[i])!; + print(&j); + fmt::println()!; + }; +}; diff --git a/cron/term.ha b/cron/term.ha new file mode 100644 index 0000000..0886a39 --- /dev/null +++ b/cron/term.ha @@ -0,0 +1,187 @@ +// Copyright (C) 2023-2024 Adam House +// +// This file is part of crore. +// +// crore 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. +// +// crore 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 +// crore. If not, see <https://www.gnu.org/licenses/>. + +use errors; +use fmt; +use strconv; +use strings; + +export type term = struct { + min: int, + max: int, + step: int +}; + +// Parses a single positional cron term into a collection of simplistic terms, +// such that the number of terms is the number of commas appearing in the cron +// term plus one. The caller must free the returned value. +export fn parse_term(in: str, min: int, max: int) ([]term | errors::invalid) = { + let output: []term = []; + + const comps = strings::split(in, ","); + defer free(comps); + + for (let i = 0z; i < len(comps); i += 1) { + append(output, parse_single_term(comps[i], min, max)?); + }; + + return output; +}; + +fn parse_single_term(in: str, min: int, max: int) (term | errors::invalid) = { + if (in == "*") { + return term { + min = min, + max = max, + step = 1 + }; + }; + + let out = term { + min = 0, + max = -1, + step = 1 + }; + + // The regex implementation is unexpectedly limited (so far), so we use + // manual string splitting. Hopefully we can use one regex someday. + const subbed = strings::replace(in, "*", "0"); + const input = strings::split(subbed, "/"); + const res = strings::split(input[0], "-"); + + defer free(subbed); + defer free(input); + defer free(res); + + if (len(res) > 0) { + let single = strconv::stoi(res[0]); + if (single is int) { + out.min = single as int; + out.max = single as int; + } else if (res[0] == "*") { + out.min = min; + out.max = max; + } else { + return errors::invalid; + }; + } else { + return errors::invalid; + }; + + // range cases, e.g. 5-10, 5-10/2, *-8/2 (nonstandard but fine), etc. + // (in the case of simple range e.g. 5-10, fifth match is empty string) + if (len(res) == 2) { + let end = strconv::stoi(res[1]); + if (end is int) { + out.max = end as int; + } else { + return errors::invalid; + }; + }; + + // any case with step value + if (len(input) == 2) { + if (len(input[1]) > 0) { + let step = strconv::stoi(input[1]); + if (step is int) { + out.step = step as int; + } else { + return errors::invalid; + }; + + // account properly for 5/5 etc. + if (out.max == -1 || out.max == out.min) { + out.max = max; + }; + } else { + return errors::invalid; + }; + }; + + if (out.min < min || out.max > max || min > max || out.step == 0) { + return errors::invalid; + }; + + return out; +}; + +@test fn parse_term() void = { + let cases: [](str, term) = [ + ("5", term { + min = 5, + max = 5, + step = 1 + }), + ("5-10", term { + min = 5, + max = 10, + step = 1 + }), + ("5/5", term { + min = 5, + max = 59, + step = 5 + }), + ("10-18/5", term { + min = 10, + max = 18, + step = 5 + }), + ("0", term { + min = 0, + max = 0, + step = 1 + }), + ("6/1", term { + min = 6, + max = 59, + step = 1 + }), + ("*", term { + min = 0, + max = 59, + step = 1 + }), + ("1/5", term { + min = 1, + max = 59, + step = 5 + }), + ("*/5", term { + min = 0, + max = 59, + step = 5 + }), + ("*-8/2", term { + min = 0, + max = 8, + step = 2 + }) + ]; + + for (let i = 0z; i < len(cases); i += 1) { + let parsed = parse_single_term(cases[i].0, 0, 59)!; + + fmt::printfln( + "case {}, parsed: min {} max {} step {}", + cases[i].0, parsed.min, parsed.max, parsed.step + )!; + + assert(parsed.min == cases[i].1.min); + assert(parsed.max == cases[i].1.max); + assert(parsed.step == cases[i].1.step); + }; +}; diff --git a/crore.1.scd b/crore.1.scd new file mode 100644 index 0000000..6729130 --- /dev/null +++ b/crore.1.scd @@ -0,0 +1,195 @@ +crore(1) + +# NAME + +*crore* - cron daemon + +# DESCRIPTION + +*crore* is a lightweight cron daemon, focused on (1) running without a +filesystem, (2) performance, and (3) minimizing system resource usage, in that +order. + +*crore* is single-threaded, stays off the heap as much as it can, only reads +the filesystem at init to load the crontab (and even this is optional) and then +never again touches the disk. It only keeps enough in memory to know what and +when to execute, and it only ever has one child process executing at a time. +Its method of resolving the next execution time of a task avoids exhaustively +iterating through upcoming datetimes (except in some edge cases regarding +weekday resolution, for now) in an effort to reduce the load required when tasks +are rescheduled. + +*crore* is extensible! See *HOOKS*. + +# USAGE + +*crore* accepts an optional single positional argument: a path to a config file. +This path can be relative to the current directory or fully qualified. If you +don't provide this, verbosity is set to maximum and it will look for its +crontab at _$HOME/.config/crore/tab_. + +Once started, *crore* will find and parse the crontab, failing if it can't find +anything to schedule. At the default verbosity, it will also report all the +cron expressions, associated commands, and environment variables it sees, then +sleep until the next scheduled job triggers. You can use this output to confirm +your setup. + +Once started, *crore* does not look at the crontab again. You must restart +*crore* for it to reflect changes that are made to the crontab. + +It is possible to run *crore* without a crontab, or even a config file, with +sufficiently comprehensive command line input. In this way you can run *crore* +without touching the local filesystem if you wish. + +*crore* does not fork itself into the background. Daemonize it however you +wish. If you use *runit*(8) or OpenRC, you can use a provided configuration if +you like. + +# CONFIGURATION + +Options can be loaded from the config file at a path indicated in the first +positional argument. By default, it looks in _$HOME/.config/crore/tab_. Most +options can also be selected via flags. In this section, the flag syntax is +separated by a "|" character from the config file syntax. + +If you select the same option with both the config file and flags in a +conflicting manner, the content of the flags will take precedence over the +config file. + +The config file syntax delimits the key and value parameters with an equal sign +separated by one space on each side, precisely as shown. This is true in all +cases. Some config parameters do not require a value; these are shown without +a value. + +*-a* _command_ | *after* = _command_ + Run the given command immediately after each job. See *HOOKS*. + +*-b* _command_ | *before* = _command_ + Run the given command immediately before each job. See *HOOKS*. + +*-e* _key=val_ | *KEY* = _value_ + Set the environment variable *KEY* to the specified _value_. You can + set any key as long as it does not have the same key as any config + parameter in this document. At the command prompt, you can provide this + flag multiple times with different keys. If you provide the same key, + the key provided last takes precedence. Keys do not have to be in + uppercase; the parser simply interprets anything other than a valid + config option as an environment variable. + +*-l* | *legacy* + Sets *crore* to legacy mode. In legacy mode, (1) all output is + intercepted by *crore*, buffered, assumed to indicate error, and + logged. Also, (2) exit codes are ignored. Be mindful of how much output + you want to buffer in legacy mode, as *crore* does not do a heap + allocation for the data it intercepts. This mode exists to provide a + cron interface more in line with other implementations. + +*-n* | *notabfile* + Tells *crore* not to try to find a tabfile. If set, you must provide + expressions manually via *-x*. + +*-p* | *private* + Set the log mode to not log any env vars or commands. Output from + commands is still logged. Use this if you are, for example, passing + passwords to a cronjob in plaintext or otherwise do not want your + commands broadcast to stdout. + +*-s* | *silent* + Set the log mode to log nothing. Fatal errors may still cause output. + +*-t* _tabfile_ | *tabfile* + Look for the crontab file at the provided path. The path can be + relative to the current directory, or absolute. + +*-v* + Print the current version and exit. + +*-x* _expression_ + Provide an additional cron expression in the form of a string, to be + parsed in the normal way as though it were a line in a crontab file. + If you provide *-n* | *notabfile*, this is the only way to provide + expressions, but you can also provide additional expressions this way + that are not expressed in your crontab in an additive manner. + +# BEHAVIOR + +*crore* continues operating indefinitely once started, as long as it has at +least one pending cronjob. Because it accepts cron expressions at init and +never again, this means it either fails immediately at init (if it has no +expressions) or runs indefinitely. + +At init, depending on verbosity, *crore* is able to log all expressions and +environment variables it sees, as well as the next timestamp at which each is +to be executed. *crore* then sleeps until the earliest such execution time and +informs the user of the length of that sleep. When it wakes up, it will log +(again, depending on verbosity) which job or how many jobs it woke for, +execute jobs as needed, re-queue them, sleep, and repeat. + +Cronjobs are executed sequentially, never simultaneously. This means a long- +running cronjob can block other ones from executing on time. If this happens, +they will be executed immediately upon completion of the long-running job. If a +late job is completed late, it will be rescheduled relative to the current +time, which may make it run less frequently than expected. These are intended +compromises to achieve a low-footprint design, but there is a planned config +option to allow simultaneous execution. In the meantime, intensive users of +*crore* are encouraged to avoid scheduling repeated long-running tasks close to +each other. + +## Deviations From Other Cron Implementations + +- As noted above, *crore* reads its crontab once at init and never again, so it + must be restarted to pick up changes to it. +- *crore* interprets all times in UTC. This is true even if the *legacy* option + is enabled. +- *crore* looks for its crontab at a nonstandard location by default. +- *crore* doesn't expect programs to stay quiet. +- *crore* does not send mail, interact with pam, or otherwise do anything with + the system behind the scenes other than what is precisely indicated in the + tab and config. If you need such features, you can use hooks. + +# HOOKS + +*crore* has a concept of hooks, which are commands run before and after each +cron command. There are two types of hooks available: (1) before, and (2) after. +Each of these is executed immediately adjacent to each cronjob. + +If multiple jobs are set to execute at the same time, these commands will be +executed prior to each of these in sequence. For example, if there is a +_before_ hook and an _after_ hook set and two scheduled tasks, the execution +order would be: + +. _before_ command +. first scheduled job +. _after_ command +. _before_ command +. second scheduled job +. _after_ command + +For your optional use, certain environment variables are inserted into the +execution environment of commands executed as hooks. All hooks have: + +*CRORE_COMMAND* + The command associated with the cronjob we're hooking onto. + +The _after_ hooks also have: + +*CRORE_DURATION* + The amount of time in integer microseconds that the cronjob ran before + exiting. + +*CRORE_RESULT* + The outcome of the cronjob we're hooking onto. In normal mode, this + equals the exit code or signal code of the cron command. In legacy + mode, this equals the stderr output from the cron command, if any. + +*crore* does not log the outcome of hooks themselves, although in non-silent +logging modes it will log appropriately that it is executing them. + +# EXAMPLES + +For example configs, see the _examples_ directory in the project repository. + +# CONTRIBUTING + +The *crore* author encourages constructive feedback, feature requests, and +patchsets submitted to him personally. diff --git a/example/conf.example b/example/conf.example new file mode 100644 index 0000000..3a7517a --- /dev/null +++ b/example/conf.example @@ -0,0 +1,7 @@ +# See crore(1) for more options. + +PATH = /usr/bin:/usr/local/bin +USER = joe +HOME = /home/joe + +private diff --git a/example/conf.trad.example b/example/conf.trad.example new file mode 100644 index 0000000..73ee27c --- /dev/null +++ b/example/conf.trad.example @@ -0,0 +1,4 @@ +# Note that all times are interpreted in UTC, even in legacy mode. + +tabfile = /var/spool/cron/MY_USERNAME +legacy @@ -0,0 +1,112 @@ +// Copyright (C) 2023-2024 Adam House +// +// This file is part of crore. +// +// crore 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. +// +// crore 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 +// crore. If not, see <https://www.gnu.org/licenses/>. + +use errors; +use fmt; +use os; +use os::exec; +use shlex; +use strings; +use time; + +use config; +use cron; + +export fn main() void = { + fmt::println("crore is GPLv3 free software; code is available from https://git.context.town/crore")!; + const conf: config::config = match (config::build()) { + case let c: config::config => yield c; + case let i: int => { + if (i < 0) { + fmt::fatal("invalid command line input"); + } else { + fmt::fatalf("invalid config (line {})", i + 1); + }; + }; + }; + + let lines = conf.exprs; + + if (!conf.no_tab) { + let tab_loc = conf.tab; + let needs_free = false; + + if (len(tab_loc) == 0) { + const env_home = os::getenv("HOME"); + if (env_home is str) { + tab_loc = strings::concat( + env_home: str, "/.config/crore/tab", + ); + needs_free = true; + }; + }; + + if (conf.verbosity > config::verbosity::SILENT) { + fmt::printfln("crore: reading tab at {}", tab_loc)!; + }; + + append(lines, config::parse_file(tab_loc)...); + + if (needs_free) { + free(tab_loc); + }; + }; + + let jobs: []cron::cronjob = []; + + for (let i = 0z; i < len(lines); i += 1) { + const item_raw = lines[i]; + + if (len(item_raw) == 0 || strings::hasprefix(item_raw, '#')) { + continue; + }; + + match (cron::new(item_raw)) { + case let c: cron::cronjob => { + append(jobs, c); + }; + case errors::invalid => { + fmt::fatalf( + "invalid cron expression (line {})", + i + 1 + ); + }; + case shlex::syntaxerr => { + fmt::fatalf( + "invalid sh command (line {})", + i + 1 + ); + }; + }; + }; + free(lines); + + if (len(jobs) == 0) { + fmt::fatal("crore: tab is empty"); + }; + + if (conf.verbosity == config::verbosity::NORMAL) { + for (let i = 0z; i < len(jobs); i += 1) { + cron::print(&jobs[i]); + }; + }; + + if (conf.verbosity > config::verbosity::SILENT) { + fmt::println("crore: tab is good")!; + }; + + cron::serve(jobs, &conf); +}; diff --git a/sv/openrc/crore b/sv/openrc/crore new file mode 100644 index 0000000..a6db3df --- /dev/null +++ b/sv/openrc/crore @@ -0,0 +1,11 @@ +#!/sbin/openrc-run + +# This will use the default conf locations from the documentation by default! +# To specify your own config location, use `command_args="/path/to/config"` + +name="crore" +description="cron daemon" +command="/usr/bin/crore" +command_user="YOUR_USERNAME" +command_background=true +pidfile="/run/${RC_SVCNAME}.pid" diff --git a/sv/runit/crore/config b/sv/runit/crore/config new file mode 100644 index 0000000..fcc7f18 --- /dev/null +++ b/sv/runit/crore/config @@ -0,0 +1,4 @@ +PATH = /usr/bin:/usr/local/bin + +tabfile = /etc/sv/crore/tab +private diff --git a/sv/runit/crore/log/run b/sv/runit/crore/log/run new file mode 100644 index 0000000..eb49735 --- /dev/null +++ b/sv/runit/crore/log/run @@ -0,0 +1,2 @@ +#!/bin/sh +exec vlogger -p crore diff --git a/sv/runit/crore/run b/sv/runit/crore/run new file mode 100644 index 0000000..cc5f381 --- /dev/null +++ b/sv/runit/crore/run @@ -0,0 +1,3 @@ +#!/bin/sh +exec 2>&1 +exec crore /etc/sv/crore/config diff --git a/sv/runit/crore/tab b/sv/runit/crore/tab new file mode 100644 index 0000000..977daf1 --- /dev/null +++ b/sv/runit/crore/tab @@ -0,0 +1,9 @@ +# Fill in this crontab! +# e.g. +# +# 0 * * * * /usr/bin/borgmatic +# */5 * * * * /usr/bin/mbsync -a +# +# And get rid of this placeholder! + +* * * * * echo 'hello world!' |