diff --git a/Dockerfile b/Dockerfile index 5e78273..1d19565 100644 --- a/Dockerfile +++ b/Dockerfile @@ -20,4 +20,6 @@ RUN npm run build ENV NODE_ENV=production ENV DATA_DIR=/data -CMD ["node", "dist/index.js", "--cron"] +EXPOSE 3000 + +CMD ["node", "dist/cli.js", "serve"] diff --git a/LICENSE b/LICENSE index 9dcf28a..be3f7b2 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,661 @@ -MIT License - -Copyright (c) 2026 cablate - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md index b81acda..d9356ad 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,13 @@ # banini-tracker -追蹤「股海冥燈」巴逆逆（8zz）的 Facebook 社群貼文，透過 Apify 抓取、AI 反指標分析、多平台即時推送（Telegram / Discord / LINE），並自動追蹤預測準確度。 +> **AGPL-3.0** — 使用、修改或部署本專案，必須標明原作者 **[cablate](https://github.com/cablate)**、附上[本 repo 連結](https://github.com/cablate/banini-tracker)，並以相同授權公開原始碼。網路服務部署亦同。 +> +> 本專案於 2026/04/13 從 MIT 切換至 AGPL-3.0。此日期之前取得的版本仍適用 MIT 授權。 + +追蹤「股海冥燈」巴逆逆（8zz）的 Facebook 社群貼文，透過 AI 反指標分析、多平台即時推送（Telegram / Discord / LINE），並自動追蹤預測準確度。 - 辨識她提到的標的（個股、ETF、原物料） -- 判斷她的操作（買入 / 被套 / 停損） - 反轉推導（她停損 → 可能反彈、她買入 → 可能下跌） - 推導連鎖效應（油價跌 → 製造業利多 → 電子股受惠） - 自動記錄預測，追蹤 5 個交易日的實際走勢 @@ -31,78 +34,76 @@ --- -> **Claude Code 使用者？** 直接把 [`skill/SKILL.md`](skill/SKILL.md) 加到你的 `.claude/skills/` 就能用。Claude 自己當分析引擎，不需要額外 LLM。 +## 快速開始 -支援兩種使用模式： -- **常駐排程**：Docker 部署，自動盤中/盤後排程 + LLM 分析 + 多平台推送（Telegram / Discord / LINE） + 預測追蹤 -- **CLI 工具**：`npx @cablate/banini-tracker`，搭配 Claude Code 等 AI 手動執行分析 +四種使用方式，按推薦順序： -## 快速開始（常駐排程） +### 1. Zeabur 一鍵部署（推薦） -```bash -# 1. 複製設定 -cp .env.example .env -# 填入必要項目，並設定至少一個通知管道（Telegram / Discord / LINE） +[![Deploy on Zeabur](https://zeabur.com/button.svg)](https://zeabur.com/templates/banini-tracker) -# 2. Docker 部署 +部署後打開分配的網域，首次進入設定管理員帳密，然後在 Web UI 填入 API key 和通知管道。不需要手動設定環境變數。 + +### 2. Docker + +```bash docker build -t banini-tracker . -docker run -d --name banini --env-file .env -v banini-data:/data banini-tracker +docker run -d --name banini --env-file .env -v banini-data:/data -p 3000:3000 banini-tracker +``` + +部署後打開 `http://localhost:3000` 進入設定頁面。也可以直接用 `.env` 檔設定環境變數（見下方）。 + +### 3. npx 直接啟動 -# 3. 或本地直接跑 +```bash +npx @cablate/banini-tracker serve +npx @cablate/banini-tracker serve --port 8080 +``` + +不需 Docker，直接在本機啟動常駐服務（排程 + Web 設定頁面）。打開 `http://localhost:3000` 進入設定。適合有 Node.js 環境的使用者。 + +### 4. 本地開發 + +```bash +cp .env.example .env # 填入必要設定 npm install && npm run start ``` -### 排程規則 +## 排程規則 | 排程 | 時間 | 說明 | |------|------|------| -| 早晨補漏 | 每天 08:00 | 抓前一晚 22:00 後的貼文（3 篇） | -| 盤中 | 週一~五 09:07-13:07 每 30 分 | 抓 08:30 後的貼文（1 篇） | -| 追蹤更新 | 週一~五 15:00 | 更新預測追蹤（收盤後抓 OHLC） | -| 盤後 | 每天 23:03 | 抓 13:30 後的貼文（3 篇） | +| 早晨補漏 | 每天 08:00 | 抓前一晚的貼文（3 篇） | +| 盤中 | 週一~五 09:07-13:07 每 30 分 | 即時追蹤（1 篇） | +| 追蹤更新 | 週一~五 15:00 | 收盤後更新預測追蹤 | +| 盤後 | 每天 23:03 | 當日彙整（3 篇） | -每個排程只抓自己時間窗口內的貼文，搭配 seen.json 去重，確保無死角且不重複。 +## 設定 -### npm scripts +### Web UI（Zeabur / Docker） -| 指令 | 說明 | -|------|------| -| `npm run start` | 常駐排程模式（全部排程自動跑） | -| `npm run dev` | 單次執行（FB 3 篇） | -| `npm run dry` | 只抓取，不呼叫 LLM | -| `npm run market` | 盤中模式（FB 1 篇） | -| `npm run evening` | 盤後模式（FB 3 篇） | +常駐模式會在 port 3000 啟動設定頁面。首次進入建立管理員帳密，之後登入即可修改設定。修改後下次排程執行自動生效，不需重啟。 -### .env 設定 +### 環境變數（.env） -``` -APIFY_TOKEN=apify_api_... -LLM_BASE_URL=https://api.deepinfra.com/v1/openai -LLM_API_KEY=... -LLM_MODEL=MiniMaxAI/MiniMax-M2.5 -TG_BOT_TOKEN=... -TG_CHANNEL_ID=-100... - -# Discord Bot（選填，與 Telegram 擇一或同時使用） -DISCORD_BOT_TOKEN=... -DISCORD_CHANNEL_ID=... - -# LINE（選填，與其他通知管道同時使用） -LINE_CHANNEL_ACCESS_TOKEN=... -LINE_TO=target_user_or_group_id - -# 影片轉錄（選填，啟用後自動轉錄影片貼文） -TRANSCRIBER=groq -GROQ_API_KEY=gsk_... - -# FinMind API（選填，免費可用，註冊可提高額度） -FINMIND_TOKEN=... - -# 資料目錄（Docker 建議掛載 /data） -DATA_DIR=/data -``` +如果不使用 Web UI，也可以直接設定環境變數： + +| 變數 | 必填 | 說明 | +|------|------|------| +| `APIFY_TOKEN` | 是 | Apify API token | +| `LLM_API_KEY` | 是 | LLM API key | +| `LLM_BASE_URL` | — | 預設 DeepInfra | +| `LLM_MODEL` | — | 預設 MiniMax-M2.5 | +| `TG_BOT_TOKEN` + `TG_CHANNEL_ID` | 至少一組 | Telegram 通知 | +| `DISCORD_BOT_TOKEN` + `DISCORD_CHANNEL_ID` | 至少一組 | Discord 通知 | +| `LINE_CHANNEL_ACCESS_TOKEN` + `LINE_TO` | 至少一組 | LINE 通知（Free plan 200 則/月） | +| `TRANSCRIBER` | — | `noop`（預設）或 `groq` | +| `GROQ_API_KEY` | — | Groq Whisper 影片轉錄用 | +| `FINMIND_TOKEN` | — | 股價查詢（免費可用） | -## 預測追蹤系統 +Web UI 和環境變數可以混用，Web UI 的設定優先。 + +## 預測追蹤 LLM 分析出標的後，系統自動： @@ -111,113 +112,47 @@ LLM 分析出標的後，系統自動： 3. **追蹤 5 個交易日**：每天 15:00 收盤後抓 OHLC，記錄漲跌幅 4. **同股票取代**：新預測自動取代同標的舊預測（supersede 機制） -勝敗判定在查詢時決定，支援多維度分析（不同持有天數、信心度分群、操作類型）。 - -### 資料儲存 - -使用 SQLite（better-sqlite3），資料表： - -| 表 | 用途 | -|----|------| -| `posts` | 所有貼文原文（即時 + 歷史回測統一來源） | -| `predictions` | 預測記錄（標的、方向、基準價、狀態） | -| `price_snapshots` | 每日 OHLC 快照（5 天追蹤期） | - -資料庫位置：`$DATA_DIR/banini.db`（Docker 掛載 `/data`，本地 `~/.banini-tracker/`） - ### 公開資料集 -[`data/banini-public.db`](data/banini-public.db) 提供去識別化的預測資料，包含 345 筆預測記錄與對應的價格快照，不含原始貼文內容。可直接用於分析或驗證反指標勝率。 +[`data/banini-public.db`](data/banini-public.db) 提供去識別化的預測資料（345 筆預測 + 價格快照），不含原始貼文。 ```bash -# 快速查看 sqlite3 data/banini-public.db "SELECT symbol_name, reverse_view, base_price, status FROM predictions LIMIT 10" ``` -## CLI 工具模式 +## CLI 工具 -不需 clone repo，任何環境直接用： +不需 clone repo，搭配 Claude Code 等 AI 使用： ```bash -# 初始化設定 -npx @cablate/banini-tracker init \ - --apify-token YOUR_APIFY_TOKEN \ - --tg-bot-token YOUR_TG_BOT_TOKEN \ - --tg-channel-id YOUR_TG_CHANNEL_ID +# 啟動常駐服務（排程 + Web UI） +npx @cablate/banini-tracker serve -# 抓取 Facebook 最新 3 篇 -npx @cablate/banini-tracker fetch -s fb -n 3 --mark-seen +# 初始化 CLI 設定 +npx @cablate/banini-tracker init --apify-token YOUR_TOKEN -# 抓取指定日期區間（回測用） -npx @cablate/banini-tracker fetch --since 2025-04-01 --until 2025-05-01 -n 100 +# 抓取貼文 +npx @cablate/banini-tracker fetch -n 3 --mark-seen -# 推送結果到 Telegram +# 推送到 Telegram npx @cablate/banini-tracker push -f report.txt ``` -### CLI 指令 - -| 指令 | 說明 | -|------|------| -| `init` | 初始化設定檔（`~/.banini-tracker.json`） | -| `config` | 顯示目前設定 | -| `fetch` | 抓取貼文，輸出 JSON 到 stdout | -| `push` | 推送訊息到 Telegram | -| `seen list` | 列出已讀貼文 ID | -| `seen mark ` | 標記貼文為已讀 | -| `seen clear` | 清空已讀紀錄 | - -### fetch 選項 - -``` --s, --source 來源：fb（預設 fb） --n, --limit 每個來源抓幾篇（預設 3） ---since 只抓此時間之後的貼文（YYYY-MM-DD / ISO 時間戳 / 相對時間如 "2 months"） ---until 只抓此時間之前的貼文 ---no-dedup 不去重 ---mark-seen 輸出後自動標記已讀 -``` - -### push 選項 - -``` --m, --message 直接帶訊息 --f, --file 從檔案讀取（推薦多行內容用這個） ---parse-mode HTML / Markdown / none（預設 HTML） -``` - -不帶 `-m` 或 `-f` 時從 stdin 讀取。 - -### 搭配 Claude Code 使用 - -在 Claude Code 的 skill 中，Claude 自己就是分析引擎： - -1. `fetch` 抓貼文 → Claude 讀 JSON -2. Claude 分析 + WebSearch 查最新走勢 -3. Claude 組報告 → `push -f` 推送 Telegram +> **Claude Code 使用者？** 直接把 [`skill/SKILL.md`](skill/SKILL.md) 加到你的 `.claude/skills/` 就能用。Claude 自己當分析引擎，不需要額外 LLM。 -詳見 [`skill/SKILL.md`](skill/SKILL.md)。 +完整指令說明見 `npx @cablate/banini-tracker --help`。 ## 費用估算 -| 項目 | 單次費用 | 頻率 | 月估算 | -|------|---------|------|--------| -| Facebook 抓取（Apify） | ~$0.005/篇 | ~270 篇/月 | ~$1.35 | -| LLM 分析（常駐模式） | 依模型而定 | 同上 | 依模型定價 | -| 影片轉錄（Groq Whisper） | ~$0.006/分鐘 | 視影片數量 | 極低 | -| 股價查詢（FinMind） | 免費 | 每日收盤後 | $0 | -| 通知推送（TG / DC） | 免費 | — | $0 | -| LINE 推送 | Free plan 200 則/月 | 同上 | $0（一般用量） | - -> CLI 模式搭配 Claude Code 使用不需 LLM 費用，Claude 自己分析。 -> 回測歷史資料加日期篩選：~$7/千篇（$5 基本 + $2 date filter add-on）。 - -## 為什麼只用 Facebook？ - -早期版本同時支援 Threads 和 Facebook 爬取，後來基於兩個原因移除了 Threads： +| 項目 | 月估算 | +|------|--------| +| Facebook 抓取（Apify） | ~$1.35（~270 篇） | +| LLM 分析 | 依模型定價 | +| 通知推送（TG / DC） | 免費 | +| LINE 推送 | Free plan 200 則/月 | +| 股價查詢（FinMind） | 免費 | -1. **費用差距大**：Threads 每次抓取 ~$0.15（Pay-per-event），Facebook 只要 ~$0.02（CU 計費），差 7 倍以上 -2. **FB 參考價值更高**：巴逆逆的投資相關貼文（持倉截圖、操作心得）主要發在 Facebook 粉專，Threads 多為生活日常，反指標參考價值較低 +> CLI 模式搭配 Claude Code 不需 LLM 費用，Claude 自己分析。 ## Star History @@ -235,4 +170,4 @@ npx @cablate/banini-tracker push -f report.txt ## License -MIT +[AGPL-3.0](LICENSE) diff --git a/package-lock.json b/package-lock.json index d73b088..d0ccb00 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,10 +9,12 @@ "version": "2.0.19", "license": "MIT", "dependencies": { + "@hono/node-server": "^1.19.13", "better-sqlite3": "^12.8.0", "commander": "^13.0.0", "dotenv": "^16.4.0", "groq-sdk": "^1.1.2", + "hono": "^4.12.12", "node-cron": "^4.2.1", "openai": "^4.0.0" }, @@ -469,6 +471,18 @@ "node": ">=18" } }, + "node_modules/@hono/node-server": { + "version": "1.19.13", + "resolved": "https://registry.npmjs.org/@hono/node-server/-/node-server-1.19.13.tgz", + "integrity": "sha512-TsQLe4i2gvoTtrHje625ngThGBySOgSK3Xo2XRYOdqGN1teR8+I7vchQC46uLJi8OF62YTYA3AhSpumtkhsaKQ==", + "license": "MIT", + "engines": { + "node": ">=18.14.1" + }, + "peerDependencies": { + "hono": "^4" + } + }, "node_modules/@types/better-sqlite3": { "version": "7.6.13", "resolved": "https://registry.npmjs.org/@types/better-sqlite3/-/better-sqlite3-7.6.13.tgz", @@ -1022,6 +1036,15 @@ "node": ">= 0.4" } }, + "node_modules/hono": { + "version": "4.12.12", + "resolved": "https://registry.npmjs.org/hono/-/hono-4.12.12.tgz", + "integrity": "sha512-p1JfQMKaceuCbpJKAPKVqyqviZdS0eUxH9v82oWo1kb9xjQ5wA6iP3FNVAPDFlz5/p7d45lO+BpSk1tuSZMF4Q==", + "license": "MIT", + "engines": { + "node": ">=16.9.0" + } + }, "node_modules/humanize-ms": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/humanize-ms/-/humanize-ms-1.2.1.tgz", diff --git a/package.json b/package.json index 9a482c3..8c0d4be 100644 --- a/package.json +++ b/package.json @@ -26,12 +26,14 @@ "claude" ], "author": "cablate", - "license": "MIT", + "license": "AGPL-3.0-only", "dependencies": { + "@hono/node-server": "^1.19.13", "better-sqlite3": "^12.8.0", "commander": "^13.0.0", "dotenv": "^16.4.0", "groq-sdk": "^1.1.2", + "hono": "^4.12.12", "node-cron": "^4.2.1", "openai": "^4.0.0" }, diff --git a/src/auth.ts b/src/auth.ts new file mode 100644 index 0000000..8d7f0bd --- /dev/null +++ b/src/auth.ts @@ -0,0 +1,85 @@ +/** + * Auth module: first-run setup + login + session token. + * Password hashed with scrypt, session token in memory. + */ +import { scryptSync, randomBytes, timingSafeEqual } from 'crypto'; +import { getDb } from './db.js'; + +const SCRYPT_KEYLEN = 64; + +/** Ensure auth table exists */ +export function initAuthTable(): void { + const db = getDb(); + db.exec(` + CREATE TABLE IF NOT EXISTS auth ( + id INTEGER PRIMARY KEY CHECK (id = 1), + username TEXT NOT NULL, + password_hash TEXT NOT NULL + ) + `); +} + +/** Check if initial setup is done */ +export function isInitialized(): boolean { + initAuthTable(); + const db = getDb(); + const row = db.prepare('SELECT id FROM auth WHERE id = 1').get(); + return !!row; +} + +/** First-run: create admin account */ +export function setupAdmin(username: string, password: string): void { + if (isInitialized()) throw new Error('already initialized'); + if (!username || !password) throw new Error('username and password required'); + if (password.length < 6) throw new Error('password must be at least 6 characters'); + + const salt = randomBytes(16).toString('hex'); + const hash = scryptSync(password, salt, SCRYPT_KEYLEN).toString('hex'); + const stored = `${salt}:${hash}`; + + const db = getDb(); + db.prepare('INSERT INTO auth (id, username, password_hash) VALUES (1, ?, ?)').run(username, stored); +} + +/** Verify credentials, return session token or null */ +export function login(username: string, password: string): string | null { + initAuthTable(); + const db = getDb(); + const row = db.prepare('SELECT username, password_hash FROM auth WHERE id = 1').get() as + | { username: string; password_hash: string } + | undefined; + + if (!row) return null; + if (row.username !== username) return null; + + const [salt, storedHash] = row.password_hash.split(':'); + const hash = scryptSync(password, salt, SCRYPT_KEYLEN).toString('hex'); + + const storedBuf = Buffer.from(storedHash, 'hex'); + const hashBuf = Buffer.from(hash, 'hex'); + if (!timingSafeEqual(storedBuf, hashBuf)) return null; + + const token = randomBytes(32).toString('hex'); + sessions.set(token, { username, createdAt: Date.now() }); + return token; +} + +/** Validate session token */ +export function validateSession(token: string): boolean { + const session = sessions.get(token); + if (!session) return false; + // 24h expiry + if (Date.now() - session.createdAt > 24 * 60 * 60 * 1000) { + sessions.delete(token); + return false; + } + return true; +} + +/** Logout */ +export function logout(token: string): void { + sessions.delete(token); +} + +// In-memory session store (container restart = re-login, acceptable) +const sessions = new Map(); diff --git a/src/cli.ts b/src/cli.ts index dd79468..3986934 100644 --- a/src/cli.ts +++ b/src/cli.ts @@ -181,6 +181,17 @@ seenCmd console.error(`已清空: ${getSeenFile()}`); }); +// ── serve ──────────────────────────────────────────────── +program + .command('serve') + .description('啟動常駐服務（排程 + Web 設定頁面）') + .option('-p, --port ', 'Web UI port', '3000') + .action(async (opts) => { + if (opts.port) process.env.WEB_PORT = opts.port; + process.argv.push('--cron'); + await import('./index.js'); + }); + // ── push ───────────────────────────────────────────────── program .command('push') diff --git a/src/config-store.ts b/src/config-store.ts new file mode 100644 index 0000000..34b7ecd --- /dev/null +++ b/src/config-store.ts @@ -0,0 +1,111 @@ +/** + * DB-backed config store with env fallback + in-memory cache. + * Web UI writes here, cron reads here on every run(). + */ +import { getDb } from './db.js'; + +export interface ConfigEntry { + key: string; + value: string; +} + +const CONFIG_KEYS = [ + 'APIFY_TOKEN', + 'LLM_BASE_URL', + 'LLM_API_KEY', + 'LLM_MODEL', + 'TG_BOT_TOKEN', + 'TG_CHANNEL_ID', + 'DISCORD_BOT_TOKEN', + 'DISCORD_CHANNEL_ID', + 'LINE_CHANNEL_ACCESS_TOKEN', + 'LINE_TO', + 'TRANSCRIBER', + 'GROQ_API_KEY', + 'FINMIND_TOKEN', +] as const; + +export type ConfigKey = typeof CONFIG_KEYS[number]; + +const DEFAULTS: Partial> = { + LLM_BASE_URL: 'https://api.deepinfra.com/v1/openai', + LLM_MODEL: 'MiniMaxAI/MiniMax-M2.5', + TRANSCRIBER: 'noop', +}; + +let cache: Map | null = null; +let cacheVersion = 0; + +/** Ensure config table exists */ +export function initConfigTable(): void { + const db = getDb(); + db.exec(` + CREATE TABLE IF NOT EXISTS config ( + key TEXT PRIMARY KEY, + value TEXT NOT NULL DEFAULT '' + ) + `); +} + +/** Get a single config value: DB > env > default */ +export function getConfig(key: ConfigKey): string { + loadCache(); + return cache!.get(key) || process.env[key] || DEFAULTS[key] || ''; +} + +/** Get all config as object */ +export function getAllConfig(): Record { + loadCache(); + const result = {} as Record; + for (const key of CONFIG_KEYS) { + result[key] = cache!.get(key) || process.env[key] || DEFAULTS[key] || ''; + } + return result; +} + +/** Set a single config value in DB */ +export function setConfig(key: ConfigKey, value: string): void { + const db = getDb(); + initConfigTable(); + db.prepare( + 'INSERT INTO config (key, value) VALUES (?, ?) ON CONFLICT(key) DO UPDATE SET value = excluded.value', + ).run(key, value); + cache = null; // invalidate + cacheVersion++; +} + +/** Batch set multiple config values */ +export function setConfigs(entries: Partial>): void { + const db = getDb(); + initConfigTable(); + const upsert = db.prepare( + 'INSERT INTO config (key, value) VALUES (?, ?) ON CONFLICT(key) DO UPDATE SET value = excluded.value', + ); + db.transaction(() => { + for (const [key, value] of Object.entries(entries)) { + if (CONFIG_KEYS.includes(key as ConfigKey)) { + upsert.run(key, value ?? ''); + } + } + })(); + cache = null; // invalidate + cacheVersion++; +} + +/** Current cache version, can be used for hot-reload detection */ +export function getConfigVersion(): number { + return cacheVersion; +} + +/** Valid config keys list */ +export function getConfigKeys(): readonly string[] { + return CONFIG_KEYS; +} + +function loadCache(): void { + if (cache) return; + initConfigTable(); + const db = getDb(); + const rows = db.prepare('SELECT key, value FROM config').all() as ConfigEntry[]; + cache = new Map(rows.map((r) => [r.key, r.value])); +} diff --git a/src/index.ts b/src/index.ts index 293c31e..e16256f 100644 --- a/src/index.ts +++ b/src/index.ts @@ -19,6 +19,8 @@ import { withRetry } from './retry.js'; import { createTranscriber, transcribeVideoPosts, type TranscriberType } from './transcribe.js'; import { recordPredictions, updateTracking } from './tracker.js'; import { getDb } from './db.js'; +import { getConfig, initConfigTable, type ConfigKey } from './config-store.js'; +import { startWebServer } from './web.js'; // ── Config ────────────────────────────────────────────────── const FB_PAGE_URL = 'https://www.facebook.com/DieWithoutBang/'; @@ -26,9 +28,10 @@ const DATA_DIR = process.env.DATA_DIR || join(process.cwd(), 'data'); const isCronMode = process.argv.includes('--cron'); -function env(key: string, fallback?: string): string { - const val = process.env[key] ?? fallback; - if (!val) throw new Error(`Missing env: ${key}`); +/** Read config: DB > env > default (getConfig handles all three) */ +function env(key: ConfigKey, fallback?: string): string { + const val = getConfig(key) || fallback; + if (!val) throw new Error(`Missing config: ${key}`); return val; } @@ -95,11 +98,11 @@ async function runInner(opts: RunOptions) { const apifyToken = env('APIFY_TOKEN'); // 啟動預檢：提前警告設定問題，避免跑完抓取才炸 - if (!opts.isDryRun && !process.env.LLM_API_KEY) { + if (!opts.isDryRun && !getConfig('LLM_API_KEY')) { console.warn('⚠ LLM_API_KEY 未設定，AI 分析將會失敗（可用 --dry 跳過分析）'); } - const transcriberType = (process.env.TRANSCRIBER ?? 'noop') as TranscriberType; - if (transcriberType === 'groq' && !process.env.GROQ_API_KEY) { + const transcriberType = (getConfig('TRANSCRIBER') || 'noop') as TranscriberType; + if (transcriberType === 'groq' && !getConfig('GROQ_API_KEY')) { console.warn('⚠ TRANSCRIBER=groq 但 GROQ_API_KEY 未設定，影片轉錄將會失敗'); } @@ -328,7 +331,12 @@ async function runInner(opts: RunOptions) { } // ── 入口 ──────────────────────────────────────────────────── +// 初始化 config table（確保 DB schema ready） +initConfigTable(); + if (isCronMode) { + // 啟動 Web 設定頁面 + startWebServer(); // 早晨補漏：每天 08:00 cron.schedule('0 8 * * *', () => { run({ maxPosts: 3, isDryRun: false, label: '早晨' }) diff --git a/src/notifiers/index.ts b/src/notifiers/index.ts index de36fe4..a5fe087 100644 --- a/src/notifiers/index.ts +++ b/src/notifiers/index.ts @@ -2,20 +2,21 @@ import { createTelegramNotifier } from './telegram.js'; import { createDiscordNotifier } from './discord.js'; import { createLineNotifier } from './line.js'; import type { Notifier } from './types.js'; +import { getConfig } from '../config-store.js'; export type { Notifier, ReportData, PostSummary, AnalysisResult } from './types.js'; export { sendTelegramDirect } from './telegram.js'; /** - * 讀取環境變數，建立所有已設定的 notifier。 - * 常駐模式用：自動偵測哪些 channel 有設定。 + * 讀取設定，建立所有已設定的 notifier。 + * 每次呼叫都重新讀取（支援熱重載）。 */ export function createNotifiers(): Notifier[] { const notifiers: Notifier[] = []; // Telegram - const tgToken = process.env.TG_BOT_TOKEN; - const tgChannelId = process.env.TG_CHANNEL_ID; + const tgToken = getConfig('TG_BOT_TOKEN'); + const tgChannelId = getConfig('TG_CHANNEL_ID'); if (tgToken && tgChannelId) { notifiers.push(createTelegramNotifier({ botToken: tgToken, channelId: tgChannelId })); } else if (tgToken || tgChannelId) { @@ -23,8 +24,8 @@ export function createNotifiers(): Notifier[] { } // Discord - const dcToken = process.env.DISCORD_BOT_TOKEN; - const dcChannelId = process.env.DISCORD_CHANNEL_ID; + const dcToken = getConfig('DISCORD_BOT_TOKEN'); + const dcChannelId = getConfig('DISCORD_CHANNEL_ID'); if (dcToken && dcChannelId) { notifiers.push(createDiscordNotifier({ botToken: dcToken, channelId: dcChannelId })); } else if (dcToken || dcChannelId) { @@ -32,8 +33,8 @@ export function createNotifiers(): Notifier[] { } // LINE - const lineToken = process.env.LINE_CHANNEL_ACCESS_TOKEN; - const lineTo = process.env.LINE_TO; + const lineToken = getConfig('LINE_CHANNEL_ACCESS_TOKEN'); + const lineTo = getConfig('LINE_TO'); if (lineToken && lineTo) { notifiers.push(createLineNotifier({ channelAccessToken: lineToken, to: lineTo })); } else if (lineToken || lineTo) { diff --git a/src/web.ts b/src/web.ts new file mode 100644 index 0000000..8c968f3 --- /dev/null +++ b/src/web.ts @@ -0,0 +1,627 @@ +/** + * Web config panel: Hono server with auth + config CRUD. + * Single HTML page, no build step. + */ +import { Hono } from 'hono'; +import type { MiddlewareHandler } from 'hono'; +import { streamSSE } from 'hono/streaming'; +import { serve } from '@hono/node-server'; +import { getCookie, setCookie, deleteCookie } from 'hono/cookie'; +import { isInitialized, setupAdmin, login, logout, validateSession } from './auth.js'; +import { getAllConfig, setConfigs, getConfigKeys, getConfig, type ConfigKey } from './config-store.js'; +import { fetchFacebookPosts } from './facebook.js'; +import { analyzePosts } from './analyze.js'; +import { createNotifiers, type ReportData, type PostSummary } from './notifiers/index.js'; + +const app = new Hono(); + +const isProduction = process.env.NODE_ENV === 'production'; + +// -- Auth middleware -- +const requireAuth: MiddlewareHandler = async (c, next) => { + const token = getCookie(c, 'session'); + if (!token || !validateSession(token)) { + return c.json({ error: 'unauthorized' }, 401); + } + await next(); +}; + +// -- API routes -- + +app.get('/api/status', (c) => { + return c.json({ initialized: isInitialized() }); +}); + +app.post('/api/setup', async (c) => { + if (isInitialized()) return c.json({ error: 'already initialized' }, 400); + const { username, password } = await c.req.json(); + try { + setupAdmin(username, password); + const token = login(username, password); + if (token) setCookie(c, 'session', token, { httpOnly: true, sameSite: 'Lax', secure: isProduction, maxAge: 86400, path: '/' }); + return c.json({ ok: true }); + } catch (err: any) { + return c.json({ error: err.message }, 400); + } +}); + +app.post('/api/login', async (c) => { + const { username, password } = await c.req.json(); + const token = login(username, password); + if (!token) return c.json({ error: 'invalid credentials' }, 401); + setCookie(c, 'session', token, { httpOnly: true, sameSite: 'Lax', secure: isProduction, maxAge: 86400, path: '/' }); + return c.json({ ok: true }); +}); + +app.post('/api/logout', (c) => { + const token = getCookie(c, 'session'); + if (token) logout(token); + deleteCookie(c, 'session', { path: '/' }); + return c.json({ ok: true }); +}); + +app.get('/api/config', requireAuth, (c) => { + const config = getAllConfig(); + const masked: Record = {}; + for (const [key, value] of Object.entries(config)) { + if (value && (key.includes('TOKEN') || key.includes('KEY') || key.includes('SECRET'))) { + masked[key] = value.slice(0, 6) + '***'; + } else { + masked[key] = value; + } + } + return c.json({ config: masked, keys: getConfigKeys() }); +}); + +app.put('/api/config', requireAuth, async (c) => { + const body = await c.req.json(); + if (typeof body !== 'object' || body === null || Array.isArray(body)) { + return c.json({ error: 'invalid payload' }, 400); + } + const entries: Partial> = {}; + for (const [key, value] of Object.entries(body)) { + if (typeof value !== 'string') { + return c.json({ error: `invalid value for ${key}: expected string` }, 400); + } + entries[key as ConfigKey] = value; + } + setConfigs(entries); + return c.json({ ok: true }); +}); + +// Test pipeline (SSE streaming) +app.get('/api/test', requireAuth, (c) => { + const FB_PAGE_URL = 'https://www.facebook.com/DieWithoutBang/'; + + return streamSSE(c, async (stream) => { + const send = async (step: string, status: 'ok' | 'fail' | 'info', detail: string) => { + await stream.writeSSE({ data: JSON.stringify({ step, status, detail }) }); + }; + + const apifyToken = getConfig('APIFY_TOKEN'); + const llmApiKey = getConfig('LLM_API_KEY'); + if (!apifyToken) { await send('config', 'fail', 'APIFY_TOKEN 未設定'); return; } + if (!llmApiKey) { await send('config', 'fail', 'LLM_API_KEY 未設定'); return; } + await send('config', 'ok', '設定檢查通過'); + + let post: any; + try { + await send('fetch', 'info', '正在抓取貼文...'); + const posts = await fetchFacebookPosts(FB_PAGE_URL, apifyToken, 1); + if (posts.length === 0) { await send('fetch', 'fail', '沒有抓到貼文'); return; } + post = posts[0]; + const preview = (post.text || '（純圖片）').slice(0, 80); + await send('fetch', 'ok', preview); + } catch (err: any) { + await send('fetch', 'fail', err.message); return; + } + + let analysis: any; + try { + await send('analyze', 'info', '正在進行 AI 分析...'); + const localTime = new Date(post.timestamp).toLocaleString('zh-TW', { timeZone: 'Asia/Taipei' }); + let content = `[Facebook] ${post.text}`; + if (post.ocrText) content += `\n[圖片 OCR] ${post.ocrText}`; + if (post.captionText) content += `\n[影片轉錄] ${post.captionText}`; + analysis = await analyzePosts( + [{ text: content, timestamp: localTime, isToday: true }], + { + baseUrl: getConfig('LLM_BASE_URL') || 'https://api.deepinfra.com/v1/openai', + apiKey: llmApiKey, + model: getConfig('LLM_MODEL') || 'MiniMaxAI/MiniMax-M2.5', + }, + ); + await send('analyze', 'ok', analysis.summary || '分析完成'); + } catch (err: any) { + await send('analyze', 'fail', err.message); return; + } + + const notifiers = createNotifiers(); + if (notifiers.length === 0) { + await send('notify', 'fail', '未設定任何通知管道（Telegram / Discord / LINE）'); + return; + } + await send('notify', 'info', `正在推送至 ${notifiers.map(n => n.name).join(', ')}...`); + const postSummary: PostSummary = { + source: 'facebook', + timestamp: new Date(post.timestamp).toLocaleString('zh-TW', { timeZone: 'Asia/Taipei' }), + isToday: true, + text: (post.text || '').slice(0, 60), + url: post.url, + }; + const reportData: ReportData = { + analysis, postCount: { fb: 1 }, posts: [postSummary], isFallback: false, + }; + const results = await Promise.allSettled(notifiers.map((n) => n.send(reportData))); + const sent: string[] = []; + const failed: string[] = []; + for (let i = 0; i < results.length; i++) { + if (results[i].status === 'fulfilled') { + sent.push(notifiers[i].name); + } else { + const reason = (results[i] as PromiseRejectedResult).reason; + failed.push(`${notifiers[i].name}: ${reason instanceof Error ? reason.message : reason}`); + } + } + if (failed.length > 0) { + await send('notify', 'fail', `失敗：${failed.join('; ')}`); + } else { + await send('notify', 'ok', `已送出：${sent.join(', ')}`); + } + await send('done', 'ok', '測試完成'); + }); +}); + +// -- Frontend -- +app.get('/', (c) => { + return c.html(FRONTEND_HTML); +}); + +// -- Start server -- +const WEB_PORT = parseInt(process.env.WEB_PORT || '3000', 10); + +export function startWebServer(): void { + serve({ fetch: app.fetch, port: WEB_PORT }, () => { + console.log(`[Web] 設定頁面已啟動: http://localhost:${WEB_PORT}`); + }); +} + +// -- Inline frontend -- +const FRONTEND_HTML = /* html */ ` + + + + +banini-tracker + + + + + + + + + + + + + + + +`; diff --git a/zeabur-template.yaml b/zeabur-template.yaml index c017db1..61afd4d 100644 --- a/zeabur-template.yaml +++ b/zeabur-template.yaml @@ -13,18 +13,15 @@ spec: 追蹤「股海冥燈」巴逆逆（8zz）的 Facebook 貼文，透過 AI 反指標分析，自動推送到 Telegram / Discord / LINE。 - ## 必填設定 + ## 部署後設定 - | 變數 | 說明 | - |------|------| - | APIFY_TOKEN | Apify API token（Facebook 抓取用） | - | LLM_API_KEY | LLM API key（AI 分析用） | + 部署完成後，打開網頁設定頁面（Zeabur 會自動分配網域），首次進入需建立管理員帳密，然後在頁面上填入： - 至少設定一個通知管道： + - APIFY_TOKEN（必填） + - LLM_API_KEY（必填） + - 至少一個通知管道（Telegram / Discord / LINE） - - **Telegram**：TG_BOT_TOKEN + TG_CHANNEL_ID - - **Discord**：DISCORD_BOT_TOKEN + DISCORD_CHANNEL_ID - - **LINE**：LINE_CHANNEL_ACCESS_TOKEN + LINE_TO + 其餘設定皆有合理預設值，可按需調整。 ## 排程 @@ -38,47 +35,34 @@ spec: ## 詳細說明 [GitHub README](https://github.com/cablate/banini-tracker) - variables: [] + variables: + - key: PUBLIC_DOMAIN + type: DOMAIN + name: Domain + description: 設定頁面網域 services: - name: banini-tracker icon: https://raw.githubusercontent.com/cablate/banini-tracker/master/assets/banner.svg template: PREBUILT + domainKey: PUBLIC_DOMAIN spec: source: image: ghcr.io/cablate/banini-tracker:latest + ports: + - id: web + port: 3000 + type: HTTP volumes: - id: data dir: /data env: - APIFY_TOKEN: - default: "" - LLM_BASE_URL: - default: "https://api.deepinfra.com/v1/openai" - LLM_API_KEY: - default: "" - LLM_MODEL: - default: "MiniMaxAI/MiniMax-M2.5" - TG_BOT_TOKEN: - default: "" - TG_CHANNEL_ID: - default: "" - DISCORD_BOT_TOKEN: - default: "" - DISCORD_CHANNEL_ID: - default: "" - LINE_CHANNEL_ACCESS_TOKEN: - default: "" - LINE_TO: - default: "" - TRANSCRIBER: - default: "noop" - GROQ_API_KEY: - default: "" - FINMIND_TOKEN: - default: "" DATA_DIR: default: "/data" readonly: true locales: zh-TW: description: 巴逆逆（8zz）反指標追蹤器 — AI 分析 Facebook 貼文 + 多平台推送（Telegram / Discord / LINE） + variables: + - key: PUBLIC_DOMAIN + name: 網域 + description: 設定頁面的網域