From 0c9b98cab40fc9c739f0282a5965196bb8210b02 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Thu, 19 Dec 2024 08:37:16 +0100 Subject: [PATCH 01/35] Initial commit --- .gitignore | 25 ++ LICENSE | 674 +++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 + 3 files changed, 701 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6f72f89 --- /dev/null +++ b/.gitignore @@ -0,0 +1,25 @@ +# If you prefer the allow list template instead of the deny list, see community template: +# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore +# +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Test binary, built with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# Dependency directories (remove the comment below to include it) +# vendor/ + +# Go workspace file +go.work +go.work.sum + +# env file +.env diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 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 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..45229bb --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# steamsalty +A bot that notifies you about new Steam Profile comments on telegram From 6aa64b628717be3d94061f1d9df61d03fa20794c Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Thu, 19 Dec 2024 08:37:16 +0100 Subject: [PATCH 02/35] Initial commit --- .gitignore | 25 ++ LICENSE | 674 +++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 + 3 files changed, 701 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6f72f89 --- /dev/null +++ b/.gitignore @@ -0,0 +1,25 @@ +# If you prefer the allow list template instead of the deny list, see community template: +# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore +# +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Test binary, built with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# Dependency directories (remove the comment below to include it) +# vendor/ + +# Go workspace file +go.work +go.work.sum + +# env file +.env diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 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 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..45229bb --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +# steamsalty +A bot that notifies you about new Steam Profile comments on telegram From 8fecdee6b82bba64007a6f02338f29452b80c269 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Fri, 20 Dec 2024 02:09:07 +0100 Subject: [PATCH 03/35] v0.1 --- .github/workflows/docker-on-push.yml | 38 +++++++++++++++ Dockerfile | 16 +++++++ README.md | 2 +- bot.go | 10 ++++ botIO/authenticate.go | 20 ++++++++ botIO/sending.go | 71 ++++++++++++++++++++++++++++ config/config.go | 24 ++++++++++ config/types.go | 9 ++++ docker-compose.yaml | 11 +++++ go.mod | 17 +++++++ go.sum | 25 ++++++++++ main.go | 35 ++++++++++++++ steam/api.go | 17 +++++++ steam/http.go | 48 +++++++++++++++++++ steam/profile.go | 57 ++++++++++++++++++++++ steam/types.go | 9 ++++ 16 files changed, 408 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/docker-on-push.yml create mode 100644 Dockerfile create mode 100644 bot.go create mode 100644 botIO/authenticate.go create mode 100644 botIO/sending.go create mode 100644 config/config.go create mode 100644 config/types.go create mode 100644 docker-compose.yaml create mode 100644 go.mod create mode 100644 go.sum create mode 100644 main.go create mode 100644 steam/api.go create mode 100644 steam/http.go create mode 100644 steam/profile.go create mode 100644 steam/types.go diff --git a/.github/workflows/docker-on-push.yml b/.github/workflows/docker-on-push.yml new file mode 100644 index 0000000..57d2c42 --- /dev/null +++ b/.github/workflows/docker-on-push.yml @@ -0,0 +1,38 @@ +name: Build and Push to Docker Hub on changes to master branch + +on: + push: + branches: + - master + +jobs: + docker: + runs-on: ubuntu-latest + steps: + - name: Check out the repo + uses: actions/checkout@v3 + + - name: Set up QEMU + uses: docker/setup-qemu-action@v3 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Login to GitHub Container Registry + uses: docker/login-action@v3 + with: + registry: ghcr.io + username: ${{github.actor}} + password: ${{secrets.GHCR_TOKEN}} # needs read:packages, write:packages. delete:packages + + + - name: Build and push + uses: docker/build-push-action@v6 + with: + platforms: linux/amd64,linux/arm64 + push: true + tags: | + ghcr.io/${{ github.repository }}:master + ghcr.io/${{ github.repository }}:commit-${{ github.sha }} + + diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..a72a7e1 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,16 @@ +FROM golang:alpine AS builder + +WORKDIR /tmp/build + +COPY . . +RUN go mod download +RUN go build -o /tmp/build/bin/steamsalty + + + +FROM scratch +WORKDIR /app +COPY --from=builder /tmp/build/bin/steamsalty /app/steamsalty + + +ENTRYPOINT ["/app/steamsalty"] \ No newline at end of file diff --git a/README.md b/README.md index 45229bb..383a233 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,2 @@ # steamsalty -A bot that notifies you about new Steam Profile comments on telegram +Get notifications about Steam Comments on Telegram diff --git a/bot.go b/bot.go new file mode 100644 index 0000000..de8fc00 --- /dev/null +++ b/bot.go @@ -0,0 +1,10 @@ +package main + +import ( + "watn3y/steamsalty/botIO" + "watn3y/steamsalty/steam" +) + +func bot() { + steam.StartWatchers(botIO.Authenticate()) +} diff --git a/botIO/authenticate.go b/botIO/authenticate.go new file mode 100644 index 0000000..d940bfa --- /dev/null +++ b/botIO/authenticate.go @@ -0,0 +1,20 @@ +package botIO + +import ( + tgbotapi "github.com/go-telegram-bot-api/telegram-bot-api/v5" + "github.com/rs/zerolog/log" + "watn3y/steamsalty/config" +) + +func Authenticate() *tgbotapi.BotAPI { + bot, err := tgbotapi.NewBotAPI(config.BotConfig.TelegramAPIToken) + if err != nil { + log.Panic().Err(err).Msg("Failed to authenticate") + } + + bot.Debug = config.BotConfig.DebugMode + + log.Info().Int64("ID", bot.Self.ID).Str("username", bot.Self.UserName).Msg("Successfully authenticated to Telegram API") + + return bot +} diff --git a/botIO/sending.go b/botIO/sending.go new file mode 100644 index 0000000..4576603 --- /dev/null +++ b/botIO/sending.go @@ -0,0 +1,71 @@ +package botIO + +import ( + tgbotapi "github.com/go-telegram-bot-api/telegram-bot-api/v5" + "github.com/rs/zerolog/log" +) + +func SendMessage(message tgbotapi.MessageConfig, bot *tgbotapi.BotAPI) (result tgbotapi.Message) { + result, err := bot.Send(message) + if err != nil { + log.Error().Err(err).Msg("Failed to send message") + return + } + + log.Info().Int64("chat", result.Chat.ID).Str("msg", result.Text).Msg("Sent message") + log.Debug().Interface("msg", result).Msg("") + + return result +} + +func EditMessage(message tgbotapi.EditMessageTextConfig, bot *tgbotapi.BotAPI) (result tgbotapi.Message) { + result, err := bot.Send(message) + if err != nil { + log.Error().Err(err).Msg("Failed to edit message") + return + } + + log.Info().Int64("chat", result.Chat.ID).Str("msg", result.Text).Msg("Edited message") + log.Debug().Interface("msg", result).Msg("") + + return result +} + +func SendVideo(message tgbotapi.VideoConfig, bot *tgbotapi.BotAPI) (result tgbotapi.Message) { + result, err := bot.Send(message) + if err != nil { + log.Error().Err(err).Msg("Failed to send video") + return + } + + log.Info().Int64("chat", result.Chat.ID).Msg("Sent video") + log.Debug().Interface("video", result).Msg("") + + return result +} + +func SendPhoto(message tgbotapi.PhotoConfig, bot *tgbotapi.BotAPI) (result tgbotapi.Message) { + result, err := bot.Send(message) + if err != nil { + log.Error().Err(err).Msg("Failed to send photo") + return + } + + log.Info().Int64("chat", result.Chat.ID).Msg("Sent photo") + log.Debug().Interface("photo", result).Msg("") + + return result +} + +func SendSticker(message tgbotapi.StickerConfig, bot *tgbotapi.BotAPI) (result tgbotapi.Message) { + result, err := bot.Send(message) + if err != nil { + log.Error().Err(err).Msg("Failed to send sticker") + return + } + + log.Info().Int64("chat", result.Chat.ID).Msg("Sent sticker") + log.Debug().Interface("sticker", result).Msg("") + + return result +} diff --git a/config/config.go b/config/config.go new file mode 100644 index 0000000..1d8ce2e --- /dev/null +++ b/config/config.go @@ -0,0 +1,24 @@ +package config + +import ( + "context" + "github.com/rs/zerolog" + "github.com/rs/zerolog/log" + envconfig "github.com/sethvargo/go-envconfig" +) + +var BotConfig config + +func LoadConfig() { + if err := envconfig.Process(context.Background(), &BotConfig); err != nil { + log.Panic().Err(err).Msg("error parsing config from env variables") + } + + if !BotConfig.DebugMode { + zerolog.SetGlobalLevel(zerolog.InfoLevel) + } + + log.Info().Msg("Loaded config") + log.Debug().Interface("config", BotConfig).Msg("") + +} diff --git a/config/types.go b/config/types.go new file mode 100644 index 0000000..a80658c --- /dev/null +++ b/config/types.go @@ -0,0 +1,9 @@ +package config + +type config struct { + TelegramAPIToken string `env:"TELEGRAMAPITOKEN, required"` + SteamAPIKey string `env:"STEAMAPIKEY, required"` + DebugMode bool `env:"DEBUGMODE, default=false"` + ChatID int64 `env:"CHATID"` + Watchers []uint64 `env:"WATCHERS"` +} diff --git a/docker-compose.yaml b/docker-compose.yaml new file mode 100644 index 0000000..4245fb3 --- /dev/null +++ b/docker-compose.yaml @@ -0,0 +1,11 @@ +services: + steamsalty: + image: ghcr.io/watn3y/steamsalty:master + container_name: steamsalty + restart: unless-stopped + environment: + - TELEGRAMAPITOKEN= + - STEAMAPIKEY= + - DebugMode=false + - CHATID=123 + - WATCHERS=123,456,789 \ No newline at end of file diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..66ba8b4 --- /dev/null +++ b/go.mod @@ -0,0 +1,17 @@ +module watn3y/steamsalty + +go 1.23.4 + +require ( + github.com/go-telegram-bot-api/telegram-bot-api/v5 v5.5.1 + github.com/rs/zerolog v1.33.0 + github.com/sethvargo/go-envconfig v1.1.0 + github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1 +) + +require ( + + github.com/mattn/go-colorable v0.1.13 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + golang.org/x/sys v0.28.0 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..1a1a2d7 --- /dev/null +++ b/go.sum @@ -0,0 +1,25 @@ +github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1 h1:PD13eMe9XAgPQ0SYWyirqwyOJG90TlEWApCw8A699l0= +github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1/go.mod h1:eQR7Xf64m2ALDAQE7Nr9ylFZhav1izvF3zzysKPhb0I= +github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= +github.com/go-telegram-bot-api/telegram-bot-api/v5 v5.5.1 h1:wG8n/XJQ07TmjbITcGiUaOtXxdrINDz1b0J1w0SzqDc= +github.com/go-telegram-bot-api/telegram-bot-api/v5 v5.5.1/go.mod h1:A2S0CWkNylc2phvKXWBBdD3K0iGnDBGbzRpISP2zBl8= +github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= +github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= +github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA= +github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg= +github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= +github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/rs/xid v1.5.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg= +github.com/rs/zerolog v1.33.0 h1:1cU2KZkvPxNyfgEmhHAz/1A9Bz+llsdYzklWFzgp0r8= +github.com/rs/zerolog v1.33.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss= +github.com/sethvargo/go-envconfig v1.1.0 h1:cWZiJxeTm7AlCvzGXrEXaSTCNgip5oJepekh/BOQuog= +github.com/sethvargo/go-envconfig v1.1.0/go.mod h1:JLd0KFWQYzyENqnEPWWZ49i4vzZo/6nRidxI8YvGiHw= +golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA= +golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= diff --git a/main.go b/main.go new file mode 100644 index 0000000..5b52270 --- /dev/null +++ b/main.go @@ -0,0 +1,35 @@ +package main + +import ( + "fmt" + "os" + "time" + + "github.com/rs/zerolog" + "github.com/rs/zerolog/log" + + "watn3y/steamsalty/config" +) + +func main() { + fmt.Println("Starting SteamSalty...") + + configureLogger() + + config.LoadConfig() + + bot() + +} + +func configureLogger() { + output := zerolog.ConsoleWriter{Out: os.Stdout, TimeFormat: time.DateTime} + + log.Logger = zerolog.New(output).With().Timestamp().Caller().Logger() + + //! note that we overwrite the loglevel after loading the config in config/config.go. This is just the default + zerolog.SetGlobalLevel(zerolog.TraceLevel) + + log.Info().Msg("Started Logger") + +} diff --git a/steam/api.go b/steam/api.go new file mode 100644 index 0000000..db12e11 --- /dev/null +++ b/steam/api.go @@ -0,0 +1,17 @@ +package steam + +import ( + "github.com/Philipp15b/go-steamapi" + "github.com/rs/zerolog/log" + "watn3y/steamsalty/config" +) + +func getPlayerDetails(steamID uint64) (summary steamapi.PlayerSummary) { + + response, err := steamapi.GetPlayerSummaries([]uint64{steamID}, config.BotConfig.SteamAPIKey) + if err != nil { + log.Error().Err(err).Msg("Failed to get Player Summary") + } + + return response[0] +} diff --git a/steam/http.go b/steam/http.go new file mode 100644 index 0000000..28e883d --- /dev/null +++ b/steam/http.go @@ -0,0 +1,48 @@ +package steam + +import ( + "encoding/json" + "github.com/rs/zerolog/log" + "io" + "net/http" + "net/url" + "strconv" +) + +func getComments(steamID uint64, start int, count int) (comments CommentResponse) { + + baseURL := "https://steamcommunity.com/comment/Profile/render/" + + url, err := url.Parse(baseURL + strconv.FormatUint(steamID, 10)) + if err != nil { + log.Error().Err(err).Msg("Unable to Parse SteamID into URL") + return + } + + query := url.Query() + query.Set("start", strconv.Itoa(start)) + query.Set("count", strconv.Itoa(count)) + url.RawQuery = query.Encode() + + resp, err := http.Get(url.String()) + if err != nil || resp.StatusCode != http.StatusOK { + log.Error().Err(err).Int("Response Code", resp.StatusCode).Msg("Failed to get Comments") + } + + defer resp.Body.Close() + + // Read the response body + body, err := io.ReadAll(resp.Body) + if err != nil { + log.Error().Err(err).Msg("Failed to parse Comments") + log.Trace().Interface("Body", resp.Body) + } + + err = json.Unmarshal(body, &comments) + if err != nil { + log.Error().Err(err).Msg("Failed to parse Comments as JSON") + } + + log.Debug().Interface("CommentPage", comments).Msg("Successfully got Comment Page") + return comments +} diff --git a/steam/profile.go b/steam/profile.go new file mode 100644 index 0000000..b78f252 --- /dev/null +++ b/steam/profile.go @@ -0,0 +1,57 @@ +package steam + +import ( + "fmt" + tgbotapi "github.com/go-telegram-bot-api/telegram-bot-api/v5" + "github.com/rs/zerolog/log" + "math" + "sync" + "time" + "watn3y/steamsalty/botIO" + "watn3y/steamsalty/config" +) + +var sleeptime time.Duration = 10 * time.Second + +func StartWatchers(bot *tgbotapi.BotAPI) { + var wg sync.WaitGroup + + for _, steamID := range config.BotConfig.Watchers { + wg.Add(1) + go func(steamID uint64) { + defer wg.Done() + watcher(bot, steamID) + }(steamID) + } + + wg.Wait() +} + +func watcher(bot *tgbotapi.BotAPI, steamID uint64) { + log.Info().Uint64("SteamID", steamID).Msg("Started Watcher") + var previousCount int + for { + currentCount := getComments(steamID, math.MaxInt32, 0).TotalCount + if previousCount == 0 || currentCount <= previousCount { + previousCount = currentCount + time.Sleep(sleeptime) + continue + } + + log.Info().Int("NumComment", currentCount).Uint64("SteamID", steamID).Msg("Found new comment") + + player := getPlayerDetails(steamID) + + msg := tgbotapi.MessageConfig{ + BaseChat: tgbotapi.BaseChat{ChatID: config.BotConfig.ChatID}, + ParseMode: "html", + DisableWebPagePreview: false, + Text: fmt.Sprintf(`New comment on %s's profile`, player.ProfileURL, player.PersonaName), + } + + botIO.SendMessage(msg, bot) + + previousCount = currentCount + time.Sleep(sleeptime) + } +} diff --git a/steam/types.go b/steam/types.go new file mode 100644 index 0000000..4d3ae86 --- /dev/null +++ b/steam/types.go @@ -0,0 +1,9 @@ +package steam + +type CommentResponse struct { + Success bool `json:"success"` + Start int `json:"start"` + TotalCount int `json:"total_count"` + CommentsHTML string `json:"comments_html"` + Timelastpost int `json:"timelastpost"` +} From 3ec330e3a2bf7fc3fbc1c84969169d3eba8db345 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Fri, 20 Dec 2024 02:09:07 +0100 Subject: [PATCH 04/35] v0.1 --- .github/workflows/docker-on-push.yml | 38 +++++++++++++++ Dockerfile | 16 +++++++ README.md | 2 +- bot.go | 10 ++++ botIO/authenticate.go | 20 ++++++++ botIO/sending.go | 71 ++++++++++++++++++++++++++++ config/config.go | 24 ++++++++++ config/types.go | 9 ++++ docker-compose.yaml | 11 +++++ go.mod | 17 +++++++ go.sum | 25 ++++++++++ main.go | 35 ++++++++++++++ steam/api.go | 17 +++++++ steam/http.go | 48 +++++++++++++++++++ steam/profile.go | 57 ++++++++++++++++++++++ steam/types.go | 9 ++++ 16 files changed, 408 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/docker-on-push.yml create mode 100644 Dockerfile create mode 100644 bot.go create mode 100644 botIO/authenticate.go create mode 100644 botIO/sending.go create mode 100644 config/config.go create mode 100644 config/types.go create mode 100644 docker-compose.yaml create mode 100644 go.mod create mode 100644 go.sum create mode 100644 main.go create mode 100644 steam/api.go create mode 100644 steam/http.go create mode 100644 steam/profile.go create mode 100644 steam/types.go diff --git a/.github/workflows/docker-on-push.yml b/.github/workflows/docker-on-push.yml new file mode 100644 index 0000000..57d2c42 --- /dev/null +++ b/.github/workflows/docker-on-push.yml @@ -0,0 +1,38 @@ +name: Build and Push to Docker Hub on changes to master branch + +on: + push: + branches: + - master + +jobs: + docker: + runs-on: ubuntu-latest + steps: + - name: Check out the repo + uses: actions/checkout@v3 + + - name: Set up QEMU + uses: docker/setup-qemu-action@v3 + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v3 + + - name: Login to GitHub Container Registry + uses: docker/login-action@v3 + with: + registry: ghcr.io + username: ${{github.actor}} + password: ${{secrets.GHCR_TOKEN}} # needs read:packages, write:packages. delete:packages + + + - name: Build and push + uses: docker/build-push-action@v6 + with: + platforms: linux/amd64,linux/arm64 + push: true + tags: | + ghcr.io/${{ github.repository }}:master + ghcr.io/${{ github.repository }}:commit-${{ github.sha }} + + diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..a72a7e1 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,16 @@ +FROM golang:alpine AS builder + +WORKDIR /tmp/build + +COPY . . +RUN go mod download +RUN go build -o /tmp/build/bin/steamsalty + + + +FROM scratch +WORKDIR /app +COPY --from=builder /tmp/build/bin/steamsalty /app/steamsalty + + +ENTRYPOINT ["/app/steamsalty"] \ No newline at end of file diff --git a/README.md b/README.md index 45229bb..383a233 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,2 @@ # steamsalty -A bot that notifies you about new Steam Profile comments on telegram +Get notifications about Steam Comments on Telegram diff --git a/bot.go b/bot.go new file mode 100644 index 0000000..de8fc00 --- /dev/null +++ b/bot.go @@ -0,0 +1,10 @@ +package main + +import ( + "watn3y/steamsalty/botIO" + "watn3y/steamsalty/steam" +) + +func bot() { + steam.StartWatchers(botIO.Authenticate()) +} diff --git a/botIO/authenticate.go b/botIO/authenticate.go new file mode 100644 index 0000000..d940bfa --- /dev/null +++ b/botIO/authenticate.go @@ -0,0 +1,20 @@ +package botIO + +import ( + tgbotapi "github.com/go-telegram-bot-api/telegram-bot-api/v5" + "github.com/rs/zerolog/log" + "watn3y/steamsalty/config" +) + +func Authenticate() *tgbotapi.BotAPI { + bot, err := tgbotapi.NewBotAPI(config.BotConfig.TelegramAPIToken) + if err != nil { + log.Panic().Err(err).Msg("Failed to authenticate") + } + + bot.Debug = config.BotConfig.DebugMode + + log.Info().Int64("ID", bot.Self.ID).Str("username", bot.Self.UserName).Msg("Successfully authenticated to Telegram API") + + return bot +} diff --git a/botIO/sending.go b/botIO/sending.go new file mode 100644 index 0000000..4576603 --- /dev/null +++ b/botIO/sending.go @@ -0,0 +1,71 @@ +package botIO + +import ( + tgbotapi "github.com/go-telegram-bot-api/telegram-bot-api/v5" + "github.com/rs/zerolog/log" +) + +func SendMessage(message tgbotapi.MessageConfig, bot *tgbotapi.BotAPI) (result tgbotapi.Message) { + result, err := bot.Send(message) + if err != nil { + log.Error().Err(err).Msg("Failed to send message") + return + } + + log.Info().Int64("chat", result.Chat.ID).Str("msg", result.Text).Msg("Sent message") + log.Debug().Interface("msg", result).Msg("") + + return result +} + +func EditMessage(message tgbotapi.EditMessageTextConfig, bot *tgbotapi.BotAPI) (result tgbotapi.Message) { + result, err := bot.Send(message) + if err != nil { + log.Error().Err(err).Msg("Failed to edit message") + return + } + + log.Info().Int64("chat", result.Chat.ID).Str("msg", result.Text).Msg("Edited message") + log.Debug().Interface("msg", result).Msg("") + + return result +} + +func SendVideo(message tgbotapi.VideoConfig, bot *tgbotapi.BotAPI) (result tgbotapi.Message) { + result, err := bot.Send(message) + if err != nil { + log.Error().Err(err).Msg("Failed to send video") + return + } + + log.Info().Int64("chat", result.Chat.ID).Msg("Sent video") + log.Debug().Interface("video", result).Msg("") + + return result +} + +func SendPhoto(message tgbotapi.PhotoConfig, bot *tgbotapi.BotAPI) (result tgbotapi.Message) { + result, err := bot.Send(message) + if err != nil { + log.Error().Err(err).Msg("Failed to send photo") + return + } + + log.Info().Int64("chat", result.Chat.ID).Msg("Sent photo") + log.Debug().Interface("photo", result).Msg("") + + return result +} + +func SendSticker(message tgbotapi.StickerConfig, bot *tgbotapi.BotAPI) (result tgbotapi.Message) { + result, err := bot.Send(message) + if err != nil { + log.Error().Err(err).Msg("Failed to send sticker") + return + } + + log.Info().Int64("chat", result.Chat.ID).Msg("Sent sticker") + log.Debug().Interface("sticker", result).Msg("") + + return result +} diff --git a/config/config.go b/config/config.go new file mode 100644 index 0000000..1d8ce2e --- /dev/null +++ b/config/config.go @@ -0,0 +1,24 @@ +package config + +import ( + "context" + "github.com/rs/zerolog" + "github.com/rs/zerolog/log" + envconfig "github.com/sethvargo/go-envconfig" +) + +var BotConfig config + +func LoadConfig() { + if err := envconfig.Process(context.Background(), &BotConfig); err != nil { + log.Panic().Err(err).Msg("error parsing config from env variables") + } + + if !BotConfig.DebugMode { + zerolog.SetGlobalLevel(zerolog.InfoLevel) + } + + log.Info().Msg("Loaded config") + log.Debug().Interface("config", BotConfig).Msg("") + +} diff --git a/config/types.go b/config/types.go new file mode 100644 index 0000000..a80658c --- /dev/null +++ b/config/types.go @@ -0,0 +1,9 @@ +package config + +type config struct { + TelegramAPIToken string `env:"TELEGRAMAPITOKEN, required"` + SteamAPIKey string `env:"STEAMAPIKEY, required"` + DebugMode bool `env:"DEBUGMODE, default=false"` + ChatID int64 `env:"CHATID"` + Watchers []uint64 `env:"WATCHERS"` +} diff --git a/docker-compose.yaml b/docker-compose.yaml new file mode 100644 index 0000000..4245fb3 --- /dev/null +++ b/docker-compose.yaml @@ -0,0 +1,11 @@ +services: + steamsalty: + image: ghcr.io/watn3y/steamsalty:master + container_name: steamsalty + restart: unless-stopped + environment: + - TELEGRAMAPITOKEN= + - STEAMAPIKEY= + - DebugMode=false + - CHATID=123 + - WATCHERS=123,456,789 \ No newline at end of file diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..66ba8b4 --- /dev/null +++ b/go.mod @@ -0,0 +1,17 @@ +module watn3y/steamsalty + +go 1.23.4 + +require ( + github.com/go-telegram-bot-api/telegram-bot-api/v5 v5.5.1 + github.com/rs/zerolog v1.33.0 + github.com/sethvargo/go-envconfig v1.1.0 + github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1 +) + +require ( + + github.com/mattn/go-colorable v0.1.13 // indirect + github.com/mattn/go-isatty v0.0.20 // indirect + golang.org/x/sys v0.28.0 // indirect +) diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..1a1a2d7 --- /dev/null +++ b/go.sum @@ -0,0 +1,25 @@ +github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1 h1:PD13eMe9XAgPQ0SYWyirqwyOJG90TlEWApCw8A699l0= +github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1/go.mod h1:eQR7Xf64m2ALDAQE7Nr9ylFZhav1izvF3zzysKPhb0I= +github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= +github.com/go-telegram-bot-api/telegram-bot-api/v5 v5.5.1 h1:wG8n/XJQ07TmjbITcGiUaOtXxdrINDz1b0J1w0SzqDc= +github.com/go-telegram-bot-api/telegram-bot-api/v5 v5.5.1/go.mod h1:A2S0CWkNylc2phvKXWBBdD3K0iGnDBGbzRpISP2zBl8= +github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= +github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= +github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA= +github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg= +github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= +github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/rs/xid v1.5.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg= +github.com/rs/zerolog v1.33.0 h1:1cU2KZkvPxNyfgEmhHAz/1A9Bz+llsdYzklWFzgp0r8= +github.com/rs/zerolog v1.33.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss= +github.com/sethvargo/go-envconfig v1.1.0 h1:cWZiJxeTm7AlCvzGXrEXaSTCNgip5oJepekh/BOQuog= +github.com/sethvargo/go-envconfig v1.1.0/go.mod h1:JLd0KFWQYzyENqnEPWWZ49i4vzZo/6nRidxI8YvGiHw= +golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA= +golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= diff --git a/main.go b/main.go new file mode 100644 index 0000000..5b52270 --- /dev/null +++ b/main.go @@ -0,0 +1,35 @@ +package main + +import ( + "fmt" + "os" + "time" + + "github.com/rs/zerolog" + "github.com/rs/zerolog/log" + + "watn3y/steamsalty/config" +) + +func main() { + fmt.Println("Starting SteamSalty...") + + configureLogger() + + config.LoadConfig() + + bot() + +} + +func configureLogger() { + output := zerolog.ConsoleWriter{Out: os.Stdout, TimeFormat: time.DateTime} + + log.Logger = zerolog.New(output).With().Timestamp().Caller().Logger() + + //! note that we overwrite the loglevel after loading the config in config/config.go. This is just the default + zerolog.SetGlobalLevel(zerolog.TraceLevel) + + log.Info().Msg("Started Logger") + +} diff --git a/steam/api.go b/steam/api.go new file mode 100644 index 0000000..db12e11 --- /dev/null +++ b/steam/api.go @@ -0,0 +1,17 @@ +package steam + +import ( + "github.com/Philipp15b/go-steamapi" + "github.com/rs/zerolog/log" + "watn3y/steamsalty/config" +) + +func getPlayerDetails(steamID uint64) (summary steamapi.PlayerSummary) { + + response, err := steamapi.GetPlayerSummaries([]uint64{steamID}, config.BotConfig.SteamAPIKey) + if err != nil { + log.Error().Err(err).Msg("Failed to get Player Summary") + } + + return response[0] +} diff --git a/steam/http.go b/steam/http.go new file mode 100644 index 0000000..28e883d --- /dev/null +++ b/steam/http.go @@ -0,0 +1,48 @@ +package steam + +import ( + "encoding/json" + "github.com/rs/zerolog/log" + "io" + "net/http" + "net/url" + "strconv" +) + +func getComments(steamID uint64, start int, count int) (comments CommentResponse) { + + baseURL := "https://steamcommunity.com/comment/Profile/render/" + + url, err := url.Parse(baseURL + strconv.FormatUint(steamID, 10)) + if err != nil { + log.Error().Err(err).Msg("Unable to Parse SteamID into URL") + return + } + + query := url.Query() + query.Set("start", strconv.Itoa(start)) + query.Set("count", strconv.Itoa(count)) + url.RawQuery = query.Encode() + + resp, err := http.Get(url.String()) + if err != nil || resp.StatusCode != http.StatusOK { + log.Error().Err(err).Int("Response Code", resp.StatusCode).Msg("Failed to get Comments") + } + + defer resp.Body.Close() + + // Read the response body + body, err := io.ReadAll(resp.Body) + if err != nil { + log.Error().Err(err).Msg("Failed to parse Comments") + log.Trace().Interface("Body", resp.Body) + } + + err = json.Unmarshal(body, &comments) + if err != nil { + log.Error().Err(err).Msg("Failed to parse Comments as JSON") + } + + log.Debug().Interface("CommentPage", comments).Msg("Successfully got Comment Page") + return comments +} diff --git a/steam/profile.go b/steam/profile.go new file mode 100644 index 0000000..b78f252 --- /dev/null +++ b/steam/profile.go @@ -0,0 +1,57 @@ +package steam + +import ( + "fmt" + tgbotapi "github.com/go-telegram-bot-api/telegram-bot-api/v5" + "github.com/rs/zerolog/log" + "math" + "sync" + "time" + "watn3y/steamsalty/botIO" + "watn3y/steamsalty/config" +) + +var sleeptime time.Duration = 10 * time.Second + +func StartWatchers(bot *tgbotapi.BotAPI) { + var wg sync.WaitGroup + + for _, steamID := range config.BotConfig.Watchers { + wg.Add(1) + go func(steamID uint64) { + defer wg.Done() + watcher(bot, steamID) + }(steamID) + } + + wg.Wait() +} + +func watcher(bot *tgbotapi.BotAPI, steamID uint64) { + log.Info().Uint64("SteamID", steamID).Msg("Started Watcher") + var previousCount int + for { + currentCount := getComments(steamID, math.MaxInt32, 0).TotalCount + if previousCount == 0 || currentCount <= previousCount { + previousCount = currentCount + time.Sleep(sleeptime) + continue + } + + log.Info().Int("NumComment", currentCount).Uint64("SteamID", steamID).Msg("Found new comment") + + player := getPlayerDetails(steamID) + + msg := tgbotapi.MessageConfig{ + BaseChat: tgbotapi.BaseChat{ChatID: config.BotConfig.ChatID}, + ParseMode: "html", + DisableWebPagePreview: false, + Text: fmt.Sprintf(`New comment on %s's profile`, player.ProfileURL, player.PersonaName), + } + + botIO.SendMessage(msg, bot) + + previousCount = currentCount + time.Sleep(sleeptime) + } +} diff --git a/steam/types.go b/steam/types.go new file mode 100644 index 0000000..4d3ae86 --- /dev/null +++ b/steam/types.go @@ -0,0 +1,9 @@ +package steam + +type CommentResponse struct { + Success bool `json:"success"` + Start int `json:"start"` + TotalCount int `json:"total_count"` + CommentsHTML string `json:"comments_html"` + Timelastpost int `json:"timelastpost"` +} From 08127fd2f5b880489490695f9cb218111a146535 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Fri, 20 Dec 2024 02:22:30 +0100 Subject: [PATCH 05/35] Fix missing CA Authorities in scratch image --- Dockerfile | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index a72a7e1..d22d8c7 100644 --- a/Dockerfile +++ b/Dockerfile @@ -2,6 +2,8 @@ FROM golang:alpine AS builder WORKDIR /tmp/build +RUN apk update && apk add --no-cache ca-certificates + COPY . . RUN go mod download RUN go build -o /tmp/build/bin/steamsalty @@ -11,6 +13,7 @@ RUN go build -o /tmp/build/bin/steamsalty FROM scratch WORKDIR /app COPY --from=builder /tmp/build/bin/steamsalty /app/steamsalty - +COPY --from=builder /etc/ssl/certs /etc/ssl/certs +COPY --from=builder /usr/share/ca-certificates /usr/share/ca-certificates ENTRYPOINT ["/app/steamsalty"] \ No newline at end of file From b3caf8d8bfc3d7e843c74d63319bcb30e0f410ce Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Fri, 20 Dec 2024 02:22:30 +0100 Subject: [PATCH 06/35] Fix missing CA Authorities in scratch image --- Dockerfile | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index a72a7e1..d22d8c7 100644 --- a/Dockerfile +++ b/Dockerfile @@ -2,6 +2,8 @@ FROM golang:alpine AS builder WORKDIR /tmp/build +RUN apk update && apk add --no-cache ca-certificates + COPY . . RUN go mod download RUN go build -o /tmp/build/bin/steamsalty @@ -11,6 +13,7 @@ RUN go build -o /tmp/build/bin/steamsalty FROM scratch WORKDIR /app COPY --from=builder /tmp/build/bin/steamsalty /app/steamsalty - +COPY --from=builder /etc/ssl/certs /etc/ssl/certs +COPY --from=builder /usr/share/ca-certificates /usr/share/ca-certificates ENTRYPOINT ["/app/steamsalty"] \ No newline at end of file From 637745897d5ec64d18cd2c86285be24eec1775ea Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Fri, 20 Dec 2024 02:31:09 +0100 Subject: [PATCH 07/35] Maybe dont spam Steam that hard --- steam/profile.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/steam/profile.go b/steam/profile.go index b78f252..648ed60 100644 --- a/steam/profile.go +++ b/steam/profile.go @@ -11,7 +11,7 @@ import ( "watn3y/steamsalty/config" ) -var sleeptime time.Duration = 10 * time.Second +var sleeptime time.Duration = 1 * time.Minute func StartWatchers(bot *tgbotapi.BotAPI) { var wg sync.WaitGroup From b4782b30a146146fa8e5f37f555d84e27c0cc008 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Fri, 20 Dec 2024 02:31:09 +0100 Subject: [PATCH 08/35] Maybe dont spam Steam that hard --- steam/profile.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/steam/profile.go b/steam/profile.go index b78f252..648ed60 100644 --- a/steam/profile.go +++ b/steam/profile.go @@ -11,7 +11,7 @@ import ( "watn3y/steamsalty/config" ) -var sleeptime time.Duration = 10 * time.Second +var sleeptime time.Duration = 1 * time.Minute func StartWatchers(bot *tgbotapi.BotAPI) { var wg sync.WaitGroup From 07e0762f8ae9ccefbeaaee554ae21faaa8d04bc4 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Fri, 20 Dec 2024 13:59:46 +0100 Subject: [PATCH 09/35] Some docker changes --- Dockerfile | 8 +++++--- docker-compose.yaml | 2 ++ 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/Dockerfile b/Dockerfile index d22d8c7..0a744a3 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,19 +1,21 @@ FROM golang:alpine AS builder -WORKDIR /tmp/build +WORKDIR /steamsalty RUN apk update && apk add --no-cache ca-certificates COPY . . RUN go mod download -RUN go build -o /tmp/build/bin/steamsalty +RUN go build -o /app/steamsalty FROM scratch WORKDIR /app -COPY --from=builder /tmp/build/bin/steamsalty /app/steamsalty + COPY --from=builder /etc/ssl/certs /etc/ssl/certs COPY --from=builder /usr/share/ca-certificates /usr/share/ca-certificates +COPY --from=builder /app/steamsalty /app/steamsalty + ENTRYPOINT ["/app/steamsalty"] \ No newline at end of file diff --git a/docker-compose.yaml b/docker-compose.yaml index 4245fb3..4209b24 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -3,6 +3,8 @@ services: image: ghcr.io/watn3y/steamsalty:master container_name: steamsalty restart: unless-stopped + volumes: + - /etc/localtime:/etc/localtime:ro environment: - TELEGRAMAPITOKEN= - STEAMAPIKEY= From f80a6e50b1b87148f6fb8e4b5f52d2cb9ce6ff74 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Fri, 20 Dec 2024 13:59:46 +0100 Subject: [PATCH 10/35] Some docker changes --- Dockerfile | 8 +++++--- docker-compose.yaml | 2 ++ 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/Dockerfile b/Dockerfile index d22d8c7..0a744a3 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,19 +1,21 @@ FROM golang:alpine AS builder -WORKDIR /tmp/build +WORKDIR /steamsalty RUN apk update && apk add --no-cache ca-certificates COPY . . RUN go mod download -RUN go build -o /tmp/build/bin/steamsalty +RUN go build -o /app/steamsalty FROM scratch WORKDIR /app -COPY --from=builder /tmp/build/bin/steamsalty /app/steamsalty + COPY --from=builder /etc/ssl/certs /etc/ssl/certs COPY --from=builder /usr/share/ca-certificates /usr/share/ca-certificates +COPY --from=builder /app/steamsalty /app/steamsalty + ENTRYPOINT ["/app/steamsalty"] \ No newline at end of file diff --git a/docker-compose.yaml b/docker-compose.yaml index 4245fb3..4209b24 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -3,6 +3,8 @@ services: image: ghcr.io/watn3y/steamsalty:master container_name: steamsalty restart: unless-stopped + volumes: + - /etc/localtime:/etc/localtime:ro environment: - TELEGRAMAPITOKEN= - STEAMAPIKEY= From 4d833722704e0222674f1b013bdfcff994d99691 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sat, 21 Dec 2024 08:06:47 +0100 Subject: [PATCH 11/35] v0.2 - Include comment text in notification - Include commenter in notification - Use Timestamp to check if a comment is new - Set sleep interval between requests in env variable --- config/types.go | 1 + docker-compose.yaml | 3 +- go.mod | 6 ++-- go.sum | 67 +++++++++++++++++++++++++++++++++++++++++++++ steam/api.go | 2 +- steam/http.go | 50 ++++++++++++++++++++++++++++++--- steam/profile.go | 59 +++++++++++++++++++++++++++------------ steam/types.go | 12 ++++++-- 8 files changed, 172 insertions(+), 28 deletions(-) diff --git a/config/types.go b/config/types.go index a80658c..5abf464 100644 --- a/config/types.go +++ b/config/types.go @@ -6,4 +6,5 @@ type config struct { DebugMode bool `env:"DEBUGMODE, default=false"` ChatID int64 `env:"CHATID"` Watchers []uint64 `env:"WATCHERS"` + SleepInterval int `env:"SLEEPINTERVAL"` } diff --git a/docker-compose.yaml b/docker-compose.yaml index 4209b24..e3906bc 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -10,4 +10,5 @@ services: - STEAMAPIKEY= - DebugMode=false - CHATID=123 - - WATCHERS=123,456,789 \ No newline at end of file + - WATCHERS=123,456,789 + - SLEEPINTERVAL=60 \ No newline at end of file diff --git a/go.mod b/go.mod index 66ba8b4..e6693ba 100644 --- a/go.mod +++ b/go.mod @@ -3,15 +3,17 @@ module watn3y/steamsalty go 1.23.4 require ( + github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1 + github.com/PuerkitoBio/goquery v1.10.0 github.com/go-telegram-bot-api/telegram-bot-api/v5 v5.5.1 github.com/rs/zerolog v1.33.0 github.com/sethvargo/go-envconfig v1.1.0 - github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1 ) require ( - + github.com/andybalholm/cascadia v1.3.3 // indirect github.com/mattn/go-colorable v0.1.13 // indirect github.com/mattn/go-isatty v0.0.20 // indirect + golang.org/x/net v0.33.0 // indirect golang.org/x/sys v0.28.0 // indirect ) diff --git a/go.sum b/go.sum index 1a1a2d7..696f506 100644 --- a/go.sum +++ b/go.sum @@ -1,5 +1,9 @@ github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1 h1:PD13eMe9XAgPQ0SYWyirqwyOJG90TlEWApCw8A699l0= github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1/go.mod h1:eQR7Xf64m2ALDAQE7Nr9ylFZhav1izvF3zzysKPhb0I= +github.com/PuerkitoBio/goquery v1.10.0 h1:6fiXdLuUvYs2OJSvNRqlNPoBm6YABE226xrbavY5Wv4= +github.com/PuerkitoBio/goquery v1.10.0/go.mod h1:TjZZl68Q3eGHNBA8CWaxAN7rOU1EbDz3CWuolcO5Yu4= +github.com/andybalholm/cascadia v1.3.3 h1:AG2YHrzJIm4BZ19iwJ/DAua6Btl3IwJX+VI4kktS1LM= +github.com/andybalholm/cascadia v1.3.3/go.mod h1:xNd9bqTn98Ln4DwST8/nG+H0yuB8Hmgu1YHNnWw0GeA= github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= github.com/go-telegram-bot-api/telegram-bot-api/v5 v5.5.1 h1:wG8n/XJQ07TmjbITcGiUaOtXxdrINDz1b0J1w0SzqDc= github.com/go-telegram-bot-api/telegram-bot-api/v5 v5.5.1/go.mod h1:A2S0CWkNylc2phvKXWBBdD3K0iGnDBGbzRpISP2zBl8= @@ -18,8 +22,71 @@ github.com/rs/zerolog v1.33.0 h1:1cU2KZkvPxNyfgEmhHAz/1A9Bz+llsdYzklWFzgp0r8= github.com/rs/zerolog v1.33.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss= github.com/sethvargo/go-envconfig v1.1.0 h1:cWZiJxeTm7AlCvzGXrEXaSTCNgip5oJepekh/BOQuog= github.com/sethvargo/go-envconfig v1.1.0/go.mod h1:JLd0KFWQYzyENqnEPWWZ49i4vzZo/6nRidxI8YvGiHw= +github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc= +golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU= +golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8= +golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk= +golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= +golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/mod v0.15.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= +golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= +golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= +golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= +golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk= +golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44= +golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM= +golang.org/x/net v0.33.0 h1:74SYHlV8BIgHIFC/LrYkOGIwL19eTYXQ5wc6TBuO36I= +golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y= +golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA= golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/telemetry v0.0.0-20240228155512-f48c80bd79b2/go.mod h1:TeRTkGYfJXctD9OcfyVLyj2J3IxLnKwHJR8f4D8a3YE= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= +golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo= +golang.org/x/term v0.12.0/go.mod h1:owVbMEjm3cBLCHdkQu9b1opXd4ETQWc3BhuQGKgXgvU= +golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk= +golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY= +golang.org/x/term v0.27.0/go.mod h1:iMsnZpn0cago0GOrHO2+Y7u7JPn5AylBrcoWkElMTSM= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= +golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= +golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= +golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= +golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58= +golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/steam/api.go b/steam/api.go index db12e11..80bc253 100644 --- a/steam/api.go +++ b/steam/api.go @@ -12,6 +12,6 @@ func getPlayerDetails(steamID uint64) (summary steamapi.PlayerSummary) { if err != nil { log.Error().Err(err).Msg("Failed to get Player Summary") } - + log.Debug().Interface("Player", response[0]).Msg("Successfully got PlayerSummary from Steam API") return response[0] } diff --git a/steam/http.go b/steam/http.go index 28e883d..70b0337 100644 --- a/steam/http.go +++ b/steam/http.go @@ -2,14 +2,18 @@ package steam import ( "encoding/json" - "github.com/rs/zerolog/log" "io" "net/http" "net/url" + "slices" "strconv" + "strings" + + "github.com/PuerkitoBio/goquery" + "github.com/rs/zerolog/log" ) -func getComments(steamID uint64, start int, count int) (comments CommentResponse) { +func getComments(steamID uint64, start int, count int) (page CommentsPage) { baseURL := "https://steamcommunity.com/comment/Profile/render/" @@ -38,11 +42,49 @@ func getComments(steamID uint64, start int, count int) (comments CommentResponse log.Trace().Interface("Body", resp.Body) } - err = json.Unmarshal(body, &comments) + err = json.Unmarshal(body, &page) if err != nil { log.Error().Err(err).Msg("Failed to parse Comments as JSON") } - log.Debug().Interface("CommentPage", comments).Msg("Successfully got Comment Page") + log.Debug().Interface("CommentPage", page).Uint64("ProfileID", steamID).Msg("Successfully got Comment Page") + + return page +} + +func parseComments(rawComments CommentsPage) (comments []Comment) { + + doc, err := goquery.NewDocumentFromReader(strings.NewReader(rawComments.CommentsHTML)) + if err != nil { + log.Error().Err(err).Msg("Error while parsing CommentsHTML") + return + } + doc.Find(".commentthread_comment.responsive_body_text").Each(func(i int, s *goquery.Selection) { + var c Comment + + parsedID, err := strconv.ParseUint(strings.TrimPrefix(s.AttrOr("id", ""), "comment_"), 10, 64) + if err != nil { + log.Error().Err(err).Msg("Error while parsing Comment ID") + return + } + c.ID = parsedID + + c.Timestamp, err = strconv.ParseInt(s.Find(".commentthread_comment_timestamp").AttrOr("data-timestamp", ""), 10, 64) + if err != nil { + log.Error().Err(err).Msg("Error while parsing Comment Timestamp") + return + } + + c.Author = s.Find(".commentthread_comment_author .hoverunderline bdi").Text() + + c.AuthorProfileURL, _ = s.Find(".commentthread_comment_author .hoverunderline").Attr("href") + + c.Text = strings.TrimSpace(s.Find(".commentthread_comment_text").Text()) + + comments = append(comments, c) + }) + + slices.Reverse(comments) + log.Debug().Interface("Comments", comments).Msg("Successfully parsed Comment Page") return comments } diff --git a/steam/profile.go b/steam/profile.go index 648ed60..24ee41b 100644 --- a/steam/profile.go +++ b/steam/profile.go @@ -2,16 +2,21 @@ package steam import ( "fmt" - tgbotapi "github.com/go-telegram-bot-api/telegram-bot-api/v5" - "github.com/rs/zerolog/log" "math" + + "strings" "sync" "time" + "watn3y/steamsalty/botIO" "watn3y/steamsalty/config" + + tgbotapi "github.com/go-telegram-bot-api/telegram-bot-api/v5" + "github.com/rs/zerolog/log" ) -var sleeptime time.Duration = 1 * time.Minute +var sleeptime time.Duration = time.Duration(config.BotConfig.SleepInterval) * time.Second +var steamContentCheckText string = "This comment is awaiting analysis by our automated content check system. It will be temporarily hidden until we verify that it does not contain harmful content (e.g. links to websites that attempt to steal information)." func StartWatchers(bot *tgbotapi.BotAPI) { var wg sync.WaitGroup @@ -29,29 +34,47 @@ func StartWatchers(bot *tgbotapi.BotAPI) { func watcher(bot *tgbotapi.BotAPI, steamID uint64) { log.Info().Uint64("SteamID", steamID).Msg("Started Watcher") - var previousCount int + + var newestProcessedComment int64 = 0 + for { - currentCount := getComments(steamID, math.MaxInt32, 0).TotalCount - if previousCount == 0 || currentCount <= previousCount { - previousCount = currentCount + currentCommentsPage := getComments(steamID, 0, math.MaxInt32) + if newestProcessedComment == 0 || newestProcessedComment == currentCommentsPage.TimeLastPost { + newestProcessedComment = currentCommentsPage.TimeLastPost time.Sleep(sleeptime) continue } - log.Info().Int("NumComment", currentCount).Uint64("SteamID", steamID).Msg("Found new comment") - - player := getPlayerDetails(steamID) - - msg := tgbotapi.MessageConfig{ - BaseChat: tgbotapi.BaseChat{ChatID: config.BotConfig.ChatID}, - ParseMode: "html", - DisableWebPagePreview: false, - Text: fmt.Sprintf(`New comment on %s's profile`, player.ProfileURL, player.PersonaName), + if strings.Contains(currentCommentsPage.CommentsHTML, steamContentCheckText) { + log.Info().Uint64("ProfileID", steamID).Msg("Found new comment(s) still being checked by Steam, retrying in "+ sleeptime.String()) + time.Sleep(sleeptime) + continue } - botIO.SendMessage(msg, bot) + log.Info().Uint64("ProfileID", steamID).Msg("Found new comment(s)") - previousCount = currentCount + profileOwner := getPlayerDetails(steamID) + + for _, comment := range parseComments(currentCommentsPage) { + log.Debug().Interface("Comment", comment).Msg("Processing Comment") + if comment.Timestamp <= newestProcessedComment { + log.Debug().Uint64("CommentID", comment.ID).Msg("Skipping Comment") + continue + } + + msg := tgbotapi.MessageConfig{ + BaseChat: tgbotapi.BaseChat{ChatID: config.BotConfig.ChatID}, + ParseMode: "HTML", + DisableWebPagePreview: true, + Text: fmt.Sprintf(`%s just commented on %s's profile:`, comment.AuthorProfileURL, comment.Author, profileOwner.ProfileURL, profileOwner.PersonaName) + "\n" + + "
" + comment.Text + "
", + } + log.Info().Interface("Comment", comment).Msg("Notifying about new Comment") + botIO.SendMessage(msg, bot) + time.Sleep(time.Minute / 20) + } + + newestProcessedComment = currentCommentsPage.TimeLastPost time.Sleep(sleeptime) } } diff --git a/steam/types.go b/steam/types.go index 4d3ae86..1445262 100644 --- a/steam/types.go +++ b/steam/types.go @@ -1,9 +1,17 @@ package steam -type CommentResponse struct { +type CommentsPage struct { Success bool `json:"success"` Start int `json:"start"` TotalCount int `json:"total_count"` CommentsHTML string `json:"comments_html"` - Timelastpost int `json:"timelastpost"` + TimeLastPost int64 `json:"timelastpost"` +} + +type Comment struct { + ID uint64 + Timestamp int64 + Author string + AuthorProfileURL string + Text string } From 9c64a3e4b55150ee953d5835769a67aa45aa927e Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sat, 21 Dec 2024 08:06:47 +0100 Subject: [PATCH 12/35] v0.2 - Include comment text in notification - Include commenter in notification - Use Timestamp to check if a comment is new - Set sleep interval between requests in env variable --- config/types.go | 1 + docker-compose.yaml | 3 +- go.mod | 6 ++-- go.sum | 67 +++++++++++++++++++++++++++++++++++++++++++++ steam/api.go | 2 +- steam/http.go | 50 ++++++++++++++++++++++++++++++--- steam/profile.go | 59 +++++++++++++++++++++++++++------------ steam/types.go | 12 ++++++-- 8 files changed, 172 insertions(+), 28 deletions(-) diff --git a/config/types.go b/config/types.go index a80658c..5abf464 100644 --- a/config/types.go +++ b/config/types.go @@ -6,4 +6,5 @@ type config struct { DebugMode bool `env:"DEBUGMODE, default=false"` ChatID int64 `env:"CHATID"` Watchers []uint64 `env:"WATCHERS"` + SleepInterval int `env:"SLEEPINTERVAL"` } diff --git a/docker-compose.yaml b/docker-compose.yaml index 4209b24..e3906bc 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -10,4 +10,5 @@ services: - STEAMAPIKEY= - DebugMode=false - CHATID=123 - - WATCHERS=123,456,789 \ No newline at end of file + - WATCHERS=123,456,789 + - SLEEPINTERVAL=60 \ No newline at end of file diff --git a/go.mod b/go.mod index 66ba8b4..e6693ba 100644 --- a/go.mod +++ b/go.mod @@ -3,15 +3,17 @@ module watn3y/steamsalty go 1.23.4 require ( + github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1 + github.com/PuerkitoBio/goquery v1.10.0 github.com/go-telegram-bot-api/telegram-bot-api/v5 v5.5.1 github.com/rs/zerolog v1.33.0 github.com/sethvargo/go-envconfig v1.1.0 - github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1 ) require ( - + github.com/andybalholm/cascadia v1.3.3 // indirect github.com/mattn/go-colorable v0.1.13 // indirect github.com/mattn/go-isatty v0.0.20 // indirect + golang.org/x/net v0.33.0 // indirect golang.org/x/sys v0.28.0 // indirect ) diff --git a/go.sum b/go.sum index 1a1a2d7..696f506 100644 --- a/go.sum +++ b/go.sum @@ -1,5 +1,9 @@ github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1 h1:PD13eMe9XAgPQ0SYWyirqwyOJG90TlEWApCw8A699l0= github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1/go.mod h1:eQR7Xf64m2ALDAQE7Nr9ylFZhav1izvF3zzysKPhb0I= +github.com/PuerkitoBio/goquery v1.10.0 h1:6fiXdLuUvYs2OJSvNRqlNPoBm6YABE226xrbavY5Wv4= +github.com/PuerkitoBio/goquery v1.10.0/go.mod h1:TjZZl68Q3eGHNBA8CWaxAN7rOU1EbDz3CWuolcO5Yu4= +github.com/andybalholm/cascadia v1.3.3 h1:AG2YHrzJIm4BZ19iwJ/DAua6Btl3IwJX+VI4kktS1LM= +github.com/andybalholm/cascadia v1.3.3/go.mod h1:xNd9bqTn98Ln4DwST8/nG+H0yuB8Hmgu1YHNnWw0GeA= github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= github.com/go-telegram-bot-api/telegram-bot-api/v5 v5.5.1 h1:wG8n/XJQ07TmjbITcGiUaOtXxdrINDz1b0J1w0SzqDc= github.com/go-telegram-bot-api/telegram-bot-api/v5 v5.5.1/go.mod h1:A2S0CWkNylc2phvKXWBBdD3K0iGnDBGbzRpISP2zBl8= @@ -18,8 +22,71 @@ github.com/rs/zerolog v1.33.0 h1:1cU2KZkvPxNyfgEmhHAz/1A9Bz+llsdYzklWFzgp0r8= github.com/rs/zerolog v1.33.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss= github.com/sethvargo/go-envconfig v1.1.0 h1:cWZiJxeTm7AlCvzGXrEXaSTCNgip5oJepekh/BOQuog= github.com/sethvargo/go-envconfig v1.1.0/go.mod h1:JLd0KFWQYzyENqnEPWWZ49i4vzZo/6nRidxI8YvGiHw= +github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/crypto v0.13.0/go.mod h1:y6Z2r+Rw4iayiXXAIxJIDAJ1zMW4yaTpebo8fPOliYc= +golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU= +golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8= +golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ssk= +golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= +golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/mod v0.15.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= +golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= +golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= +golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= +golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk= +golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44= +golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM= +golang.org/x/net v0.33.0 h1:74SYHlV8BIgHIFC/LrYkOGIwL19eTYXQ5wc6TBuO36I= +golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.3.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y= +golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA= golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/telemetry v0.0.0-20240228155512-f48c80bd79b2/go.mod h1:TeRTkGYfJXctD9OcfyVLyj2J3IxLnKwHJR8f4D8a3YE= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= +golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo= +golang.org/x/term v0.12.0/go.mod h1:owVbMEjm3cBLCHdkQu9b1opXd4ETQWc3BhuQGKgXgvU= +golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk= +golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY= +golang.org/x/term v0.27.0/go.mod h1:iMsnZpn0cago0GOrHO2+Y7u7JPn5AylBrcoWkElMTSM= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= +golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= +golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= +golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= +golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58= +golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/steam/api.go b/steam/api.go index db12e11..80bc253 100644 --- a/steam/api.go +++ b/steam/api.go @@ -12,6 +12,6 @@ func getPlayerDetails(steamID uint64) (summary steamapi.PlayerSummary) { if err != nil { log.Error().Err(err).Msg("Failed to get Player Summary") } - + log.Debug().Interface("Player", response[0]).Msg("Successfully got PlayerSummary from Steam API") return response[0] } diff --git a/steam/http.go b/steam/http.go index 28e883d..70b0337 100644 --- a/steam/http.go +++ b/steam/http.go @@ -2,14 +2,18 @@ package steam import ( "encoding/json" - "github.com/rs/zerolog/log" "io" "net/http" "net/url" + "slices" "strconv" + "strings" + + "github.com/PuerkitoBio/goquery" + "github.com/rs/zerolog/log" ) -func getComments(steamID uint64, start int, count int) (comments CommentResponse) { +func getComments(steamID uint64, start int, count int) (page CommentsPage) { baseURL := "https://steamcommunity.com/comment/Profile/render/" @@ -38,11 +42,49 @@ func getComments(steamID uint64, start int, count int) (comments CommentResponse log.Trace().Interface("Body", resp.Body) } - err = json.Unmarshal(body, &comments) + err = json.Unmarshal(body, &page) if err != nil { log.Error().Err(err).Msg("Failed to parse Comments as JSON") } - log.Debug().Interface("CommentPage", comments).Msg("Successfully got Comment Page") + log.Debug().Interface("CommentPage", page).Uint64("ProfileID", steamID).Msg("Successfully got Comment Page") + + return page +} + +func parseComments(rawComments CommentsPage) (comments []Comment) { + + doc, err := goquery.NewDocumentFromReader(strings.NewReader(rawComments.CommentsHTML)) + if err != nil { + log.Error().Err(err).Msg("Error while parsing CommentsHTML") + return + } + doc.Find(".commentthread_comment.responsive_body_text").Each(func(i int, s *goquery.Selection) { + var c Comment + + parsedID, err := strconv.ParseUint(strings.TrimPrefix(s.AttrOr("id", ""), "comment_"), 10, 64) + if err != nil { + log.Error().Err(err).Msg("Error while parsing Comment ID") + return + } + c.ID = parsedID + + c.Timestamp, err = strconv.ParseInt(s.Find(".commentthread_comment_timestamp").AttrOr("data-timestamp", ""), 10, 64) + if err != nil { + log.Error().Err(err).Msg("Error while parsing Comment Timestamp") + return + } + + c.Author = s.Find(".commentthread_comment_author .hoverunderline bdi").Text() + + c.AuthorProfileURL, _ = s.Find(".commentthread_comment_author .hoverunderline").Attr("href") + + c.Text = strings.TrimSpace(s.Find(".commentthread_comment_text").Text()) + + comments = append(comments, c) + }) + + slices.Reverse(comments) + log.Debug().Interface("Comments", comments).Msg("Successfully parsed Comment Page") return comments } diff --git a/steam/profile.go b/steam/profile.go index 648ed60..24ee41b 100644 --- a/steam/profile.go +++ b/steam/profile.go @@ -2,16 +2,21 @@ package steam import ( "fmt" - tgbotapi "github.com/go-telegram-bot-api/telegram-bot-api/v5" - "github.com/rs/zerolog/log" "math" + + "strings" "sync" "time" + "watn3y/steamsalty/botIO" "watn3y/steamsalty/config" + + tgbotapi "github.com/go-telegram-bot-api/telegram-bot-api/v5" + "github.com/rs/zerolog/log" ) -var sleeptime time.Duration = 1 * time.Minute +var sleeptime time.Duration = time.Duration(config.BotConfig.SleepInterval) * time.Second +var steamContentCheckText string = "This comment is awaiting analysis by our automated content check system. It will be temporarily hidden until we verify that it does not contain harmful content (e.g. links to websites that attempt to steal information)." func StartWatchers(bot *tgbotapi.BotAPI) { var wg sync.WaitGroup @@ -29,29 +34,47 @@ func StartWatchers(bot *tgbotapi.BotAPI) { func watcher(bot *tgbotapi.BotAPI, steamID uint64) { log.Info().Uint64("SteamID", steamID).Msg("Started Watcher") - var previousCount int + + var newestProcessedComment int64 = 0 + for { - currentCount := getComments(steamID, math.MaxInt32, 0).TotalCount - if previousCount == 0 || currentCount <= previousCount { - previousCount = currentCount + currentCommentsPage := getComments(steamID, 0, math.MaxInt32) + if newestProcessedComment == 0 || newestProcessedComment == currentCommentsPage.TimeLastPost { + newestProcessedComment = currentCommentsPage.TimeLastPost time.Sleep(sleeptime) continue } - log.Info().Int("NumComment", currentCount).Uint64("SteamID", steamID).Msg("Found new comment") - - player := getPlayerDetails(steamID) - - msg := tgbotapi.MessageConfig{ - BaseChat: tgbotapi.BaseChat{ChatID: config.BotConfig.ChatID}, - ParseMode: "html", - DisableWebPagePreview: false, - Text: fmt.Sprintf(`New comment on %s's profile`, player.ProfileURL, player.PersonaName), + if strings.Contains(currentCommentsPage.CommentsHTML, steamContentCheckText) { + log.Info().Uint64("ProfileID", steamID).Msg("Found new comment(s) still being checked by Steam, retrying in "+ sleeptime.String()) + time.Sleep(sleeptime) + continue } - botIO.SendMessage(msg, bot) + log.Info().Uint64("ProfileID", steamID).Msg("Found new comment(s)") - previousCount = currentCount + profileOwner := getPlayerDetails(steamID) + + for _, comment := range parseComments(currentCommentsPage) { + log.Debug().Interface("Comment", comment).Msg("Processing Comment") + if comment.Timestamp <= newestProcessedComment { + log.Debug().Uint64("CommentID", comment.ID).Msg("Skipping Comment") + continue + } + + msg := tgbotapi.MessageConfig{ + BaseChat: tgbotapi.BaseChat{ChatID: config.BotConfig.ChatID}, + ParseMode: "HTML", + DisableWebPagePreview: true, + Text: fmt.Sprintf(`%s just commented on %s's profile:`, comment.AuthorProfileURL, comment.Author, profileOwner.ProfileURL, profileOwner.PersonaName) + "\n" + + "
" + comment.Text + "
", + } + log.Info().Interface("Comment", comment).Msg("Notifying about new Comment") + botIO.SendMessage(msg, bot) + time.Sleep(time.Minute / 20) + } + + newestProcessedComment = currentCommentsPage.TimeLastPost time.Sleep(sleeptime) } } diff --git a/steam/types.go b/steam/types.go index 4d3ae86..1445262 100644 --- a/steam/types.go +++ b/steam/types.go @@ -1,9 +1,17 @@ package steam -type CommentResponse struct { +type CommentsPage struct { Success bool `json:"success"` Start int `json:"start"` TotalCount int `json:"total_count"` CommentsHTML string `json:"comments_html"` - Timelastpost int `json:"timelastpost"` + TimeLastPost int64 `json:"timelastpost"` +} + +type Comment struct { + ID uint64 + Timestamp int64 + Author string + AuthorProfileURL string + Text string } From f3459a6ce262162217a1b6dbc32551c494e8baad Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sat, 21 Dec 2024 08:28:28 +0100 Subject: [PATCH 13/35] v0.3 - added start command - added info command --- bot.go | 28 +++++++++++++++++++- botIO/authenticate.go | 8 ++++-- commands/commands.go | 60 +++++++++++++++++++++++++++++++++++++++++++ steam/api.go | 5 ++-- steam/profile.go | 4 +-- 5 files changed, 98 insertions(+), 7 deletions(-) create mode 100644 commands/commands.go diff --git a/bot.go b/bot.go index de8fc00..2f57968 100644 --- a/bot.go +++ b/bot.go @@ -1,10 +1,36 @@ package main import ( + "time" + "watn3y/steamsalty/botIO" + "watn3y/steamsalty/commands" "watn3y/steamsalty/steam" + + "github.com/rs/zerolog/log" ) func bot() { - steam.StartWatchers(botIO.Authenticate()) + updates, bot := botIO.Authenticate() + + go steam.StartWatchers(bot) + + for update := range updates { + log.Debug().Interface("update", update).Msg("Received update") + + if update.Message == nil || update.Message.Text == "" { + log.Debug().Int("UpdateID", update.UpdateID).Msg("Unable to parse update") + continue + } + if update.Message.Time().UTC().Unix() < time.Now().UTC().Unix() { + log.Debug().Int("UpdateID", update.UpdateID).Msg("Skipping old update") + continue + } + + log.Info().Int64("ChatID", update.Message.Chat.ID).Int64("UserID", update.Message.From.ID).Str("Text", update.Message.Text).Msg("Recieved Message") + + if update.Message.IsCommand() { + commands.Commands(update, bot) + } + } } diff --git a/botIO/authenticate.go b/botIO/authenticate.go index d940bfa..64f5d13 100644 --- a/botIO/authenticate.go +++ b/botIO/authenticate.go @@ -6,7 +6,7 @@ import ( "watn3y/steamsalty/config" ) -func Authenticate() *tgbotapi.BotAPI { +func Authenticate() (tgbotapi.UpdatesChannel, *tgbotapi.BotAPI) { bot, err := tgbotapi.NewBotAPI(config.BotConfig.TelegramAPIToken) if err != nil { log.Panic().Err(err).Msg("Failed to authenticate") @@ -14,7 +14,11 @@ func Authenticate() *tgbotapi.BotAPI { bot.Debug = config.BotConfig.DebugMode + updates := tgbotapi.NewUpdate(0) + updates.Timeout = 60 + log.Info().Int64("ID", bot.Self.ID).Str("username", bot.Self.UserName).Msg("Successfully authenticated to Telegram API") - return bot + return bot.GetUpdatesChan(updates), bot + } diff --git a/commands/commands.go b/commands/commands.go new file mode 100644 index 0000000..70fe4b4 --- /dev/null +++ b/commands/commands.go @@ -0,0 +1,60 @@ +package commands + +import ( + "fmt" + "strings" + "watn3y/steamsalty/botIO" + "watn3y/steamsalty/config" + "watn3y/steamsalty/steam" + + tgbotapi "github.com/go-telegram-bot-api/telegram-bot-api/v5" + "github.com/rs/zerolog/log" +) + +func Commands(update tgbotapi.Update, bot *tgbotapi.BotAPI) { + + cmd := strings.ToLower(update.Message.Command()) + + log.Debug().Str("cmd", cmd).Msg("Matching command") + + switch cmd { + case "start": + start(update, bot) + case "info": + info(update, bot) + } +} + +func start(update tgbotapi.Update, bot *tgbotapi.BotAPI) { + message := tgbotapi.MessageConfig{ + BaseChat: tgbotapi.BaseChat{ChatID: update.Message.Chat.ID, ReplyToMessageID: update.Message.MessageID}, + ParseMode: "html", + DisableWebPagePreview: false, + Text: "https://github.com/watn3y/steamsalty", + } + botIO.SendMessage(message, bot) +} + +func info(update tgbotapi.Update, bot *tgbotapi.BotAPI) { + if update.Message.Chat.ID != config.BotConfig.ChatID { + return + } + + textInfo := "Watching profiles: " + "\n" + + for _, steamID := range config.BotConfig.Watchers { + profile := steam.GetPlayerDetails(steamID) + + textInfo += fmt.Sprintf(`- %s`, profile.ProfileURL, profile.PersonaName) + "\n" + + } + + message := tgbotapi.MessageConfig{ + BaseChat: tgbotapi.BaseChat{ChatID: update.Message.Chat.ID, ReplyToMessageID: update.Message.MessageID}, + ParseMode: "html", + DisableWebPagePreview: true, + Text: textInfo, + } + botIO.SendMessage(message, bot) + +} diff --git a/steam/api.go b/steam/api.go index 80bc253..e79f8b9 100644 --- a/steam/api.go +++ b/steam/api.go @@ -1,12 +1,13 @@ package steam import ( + "watn3y/steamsalty/config" + "github.com/Philipp15b/go-steamapi" "github.com/rs/zerolog/log" - "watn3y/steamsalty/config" ) -func getPlayerDetails(steamID uint64) (summary steamapi.PlayerSummary) { +func GetPlayerDetails(steamID uint64) (summary steamapi.PlayerSummary) { response, err := steamapi.GetPlayerSummaries([]uint64{steamID}, config.BotConfig.SteamAPIKey) if err != nil { diff --git a/steam/profile.go b/steam/profile.go index 24ee41b..1154020 100644 --- a/steam/profile.go +++ b/steam/profile.go @@ -46,14 +46,14 @@ func watcher(bot *tgbotapi.BotAPI, steamID uint64) { } if strings.Contains(currentCommentsPage.CommentsHTML, steamContentCheckText) { - log.Info().Uint64("ProfileID", steamID).Msg("Found new comment(s) still being checked by Steam, retrying in "+ sleeptime.String()) + log.Info().Uint64("ProfileID", steamID).Msg("Found new comment(s) still being checked by Steam, retrying in " + sleeptime.String()) time.Sleep(sleeptime) continue } log.Info().Uint64("ProfileID", steamID).Msg("Found new comment(s)") - profileOwner := getPlayerDetails(steamID) + profileOwner := GetPlayerDetails(steamID) for _, comment := range parseComments(currentCommentsPage) { log.Debug().Interface("Comment", comment).Msg("Processing Comment") From 453f03d832e09c076b1d891c5c927420f3ddf46f Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sat, 21 Dec 2024 08:28:28 +0100 Subject: [PATCH 14/35] v0.3 - added start command - added info command --- bot.go | 28 +++++++++++++++++++- botIO/authenticate.go | 8 ++++-- commands/commands.go | 60 +++++++++++++++++++++++++++++++++++++++++++ steam/api.go | 5 ++-- steam/profile.go | 4 +-- 5 files changed, 98 insertions(+), 7 deletions(-) create mode 100644 commands/commands.go diff --git a/bot.go b/bot.go index de8fc00..2f57968 100644 --- a/bot.go +++ b/bot.go @@ -1,10 +1,36 @@ package main import ( + "time" + "watn3y/steamsalty/botIO" + "watn3y/steamsalty/commands" "watn3y/steamsalty/steam" + + "github.com/rs/zerolog/log" ) func bot() { - steam.StartWatchers(botIO.Authenticate()) + updates, bot := botIO.Authenticate() + + go steam.StartWatchers(bot) + + for update := range updates { + log.Debug().Interface("update", update).Msg("Received update") + + if update.Message == nil || update.Message.Text == "" { + log.Debug().Int("UpdateID", update.UpdateID).Msg("Unable to parse update") + continue + } + if update.Message.Time().UTC().Unix() < time.Now().UTC().Unix() { + log.Debug().Int("UpdateID", update.UpdateID).Msg("Skipping old update") + continue + } + + log.Info().Int64("ChatID", update.Message.Chat.ID).Int64("UserID", update.Message.From.ID).Str("Text", update.Message.Text).Msg("Recieved Message") + + if update.Message.IsCommand() { + commands.Commands(update, bot) + } + } } diff --git a/botIO/authenticate.go b/botIO/authenticate.go index d940bfa..64f5d13 100644 --- a/botIO/authenticate.go +++ b/botIO/authenticate.go @@ -6,7 +6,7 @@ import ( "watn3y/steamsalty/config" ) -func Authenticate() *tgbotapi.BotAPI { +func Authenticate() (tgbotapi.UpdatesChannel, *tgbotapi.BotAPI) { bot, err := tgbotapi.NewBotAPI(config.BotConfig.TelegramAPIToken) if err != nil { log.Panic().Err(err).Msg("Failed to authenticate") @@ -14,7 +14,11 @@ func Authenticate() *tgbotapi.BotAPI { bot.Debug = config.BotConfig.DebugMode + updates := tgbotapi.NewUpdate(0) + updates.Timeout = 60 + log.Info().Int64("ID", bot.Self.ID).Str("username", bot.Self.UserName).Msg("Successfully authenticated to Telegram API") - return bot + return bot.GetUpdatesChan(updates), bot + } diff --git a/commands/commands.go b/commands/commands.go new file mode 100644 index 0000000..70fe4b4 --- /dev/null +++ b/commands/commands.go @@ -0,0 +1,60 @@ +package commands + +import ( + "fmt" + "strings" + "watn3y/steamsalty/botIO" + "watn3y/steamsalty/config" + "watn3y/steamsalty/steam" + + tgbotapi "github.com/go-telegram-bot-api/telegram-bot-api/v5" + "github.com/rs/zerolog/log" +) + +func Commands(update tgbotapi.Update, bot *tgbotapi.BotAPI) { + + cmd := strings.ToLower(update.Message.Command()) + + log.Debug().Str("cmd", cmd).Msg("Matching command") + + switch cmd { + case "start": + start(update, bot) + case "info": + info(update, bot) + } +} + +func start(update tgbotapi.Update, bot *tgbotapi.BotAPI) { + message := tgbotapi.MessageConfig{ + BaseChat: tgbotapi.BaseChat{ChatID: update.Message.Chat.ID, ReplyToMessageID: update.Message.MessageID}, + ParseMode: "html", + DisableWebPagePreview: false, + Text: "https://github.com/watn3y/steamsalty", + } + botIO.SendMessage(message, bot) +} + +func info(update tgbotapi.Update, bot *tgbotapi.BotAPI) { + if update.Message.Chat.ID != config.BotConfig.ChatID { + return + } + + textInfo := "Watching profiles: " + "\n" + + for _, steamID := range config.BotConfig.Watchers { + profile := steam.GetPlayerDetails(steamID) + + textInfo += fmt.Sprintf(`- %s`, profile.ProfileURL, profile.PersonaName) + "\n" + + } + + message := tgbotapi.MessageConfig{ + BaseChat: tgbotapi.BaseChat{ChatID: update.Message.Chat.ID, ReplyToMessageID: update.Message.MessageID}, + ParseMode: "html", + DisableWebPagePreview: true, + Text: textInfo, + } + botIO.SendMessage(message, bot) + +} diff --git a/steam/api.go b/steam/api.go index 80bc253..e79f8b9 100644 --- a/steam/api.go +++ b/steam/api.go @@ -1,12 +1,13 @@ package steam import ( + "watn3y/steamsalty/config" + "github.com/Philipp15b/go-steamapi" "github.com/rs/zerolog/log" - "watn3y/steamsalty/config" ) -func getPlayerDetails(steamID uint64) (summary steamapi.PlayerSummary) { +func GetPlayerDetails(steamID uint64) (summary steamapi.PlayerSummary) { response, err := steamapi.GetPlayerSummaries([]uint64{steamID}, config.BotConfig.SteamAPIKey) if err != nil { diff --git a/steam/profile.go b/steam/profile.go index 24ee41b..1154020 100644 --- a/steam/profile.go +++ b/steam/profile.go @@ -46,14 +46,14 @@ func watcher(bot *tgbotapi.BotAPI, steamID uint64) { } if strings.Contains(currentCommentsPage.CommentsHTML, steamContentCheckText) { - log.Info().Uint64("ProfileID", steamID).Msg("Found new comment(s) still being checked by Steam, retrying in "+ sleeptime.String()) + log.Info().Uint64("ProfileID", steamID).Msg("Found new comment(s) still being checked by Steam, retrying in " + sleeptime.String()) time.Sleep(sleeptime) continue } log.Info().Uint64("ProfileID", steamID).Msg("Found new comment(s)") - profileOwner := getPlayerDetails(steamID) + profileOwner := GetPlayerDetails(steamID) for _, comment := range parseComments(currentCommentsPage) { log.Debug().Interface("Comment", comment).Msg("Processing Comment") From 67fd0700b6ce66c8c38c4260c400b387a9d0a298 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sun, 22 Dec 2024 03:52:10 +0100 Subject: [PATCH 15/35] add cross-compile --- .github/workflows/docker-on-push.yml | 5 +---- Dockerfile | 11 +++++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/docker-on-push.yml b/.github/workflows/docker-on-push.yml index 57d2c42..8e5a593 100644 --- a/.github/workflows/docker-on-push.yml +++ b/.github/workflows/docker-on-push.yml @@ -12,9 +12,6 @@ jobs: - name: Check out the repo uses: actions/checkout@v3 - - name: Set up QEMU - uses: docker/setup-qemu-action@v3 - - name: Set up Docker Buildx uses: docker/setup-buildx-action@v3 @@ -29,7 +26,7 @@ jobs: - name: Build and push uses: docker/build-push-action@v6 with: - platforms: linux/amd64,linux/arm64 + platforms: linux/amd64,linux/386,linux/arm64,linux/arm/v7 push: true tags: | ghcr.io/${{ github.repository }}:master diff --git a/Dockerfile b/Dockerfile index 0a744a3..6259e3a 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,12 +1,15 @@ -FROM golang:alpine AS builder +FROM --platform=$BUILDPLATFORM golang:1.23.4-alpine AS builder WORKDIR /steamsalty RUN apk update && apk add --no-cache ca-certificates -COPY . . +COPY go.mod go.sum ./ RUN go mod download -RUN go build -o /app/steamsalty + +COPY . . +ARG TARGETOS TARGETARCH +RUN GOOS=$TARGETOS GOARCH=$TARGETARCH go build -o /app/steamsalty @@ -18,4 +21,4 @@ COPY --from=builder /usr/share/ca-certificates /usr/share/ca-certificates COPY --from=builder /app/steamsalty /app/steamsalty -ENTRYPOINT ["/app/steamsalty"] \ No newline at end of file +ENTRYPOINT ["/app/steamsalty"] From 96db61831cc1af8294a8ba02b8186c9bb9f6a190 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sun, 22 Dec 2024 03:52:10 +0100 Subject: [PATCH 16/35] add cross-compile --- .github/workflows/docker-on-push.yml | 5 +---- Dockerfile | 11 +++++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/docker-on-push.yml b/.github/workflows/docker-on-push.yml index 57d2c42..8e5a593 100644 --- a/.github/workflows/docker-on-push.yml +++ b/.github/workflows/docker-on-push.yml @@ -12,9 +12,6 @@ jobs: - name: Check out the repo uses: actions/checkout@v3 - - name: Set up QEMU - uses: docker/setup-qemu-action@v3 - - name: Set up Docker Buildx uses: docker/setup-buildx-action@v3 @@ -29,7 +26,7 @@ jobs: - name: Build and push uses: docker/build-push-action@v6 with: - platforms: linux/amd64,linux/arm64 + platforms: linux/amd64,linux/386,linux/arm64,linux/arm/v7 push: true tags: | ghcr.io/${{ github.repository }}:master diff --git a/Dockerfile b/Dockerfile index 0a744a3..6259e3a 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,12 +1,15 @@ -FROM golang:alpine AS builder +FROM --platform=$BUILDPLATFORM golang:1.23.4-alpine AS builder WORKDIR /steamsalty RUN apk update && apk add --no-cache ca-certificates -COPY . . +COPY go.mod go.sum ./ RUN go mod download -RUN go build -o /app/steamsalty + +COPY . . +ARG TARGETOS TARGETARCH +RUN GOOS=$TARGETOS GOARCH=$TARGETARCH go build -o /app/steamsalty @@ -18,4 +21,4 @@ COPY --from=builder /usr/share/ca-certificates /usr/share/ca-certificates COPY --from=builder /app/steamsalty /app/steamsalty -ENTRYPOINT ["/app/steamsalty"] \ No newline at end of file +ENTRYPOINT ["/app/steamsalty"] From b7907644d4388952dbc18e7e2f77699a40a520a1 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sun, 22 Dec 2024 04:06:08 +0100 Subject: [PATCH 17/35] Change from ghcr to dockerhub --- .github/workflows/docker-on-push.yml | 14 ++++---------- docker-compose.yaml | 2 +- 2 files changed, 5 insertions(+), 11 deletions(-) diff --git a/.github/workflows/docker-on-push.yml b/.github/workflows/docker-on-push.yml index 8e5a593..928f14b 100644 --- a/.github/workflows/docker-on-push.yml +++ b/.github/workflows/docker-on-push.yml @@ -2,8 +2,6 @@ name: Build and Push to Docker Hub on changes to master branch on: push: - branches: - - master jobs: docker: @@ -18,10 +16,8 @@ jobs: - name: Login to GitHub Container Registry uses: docker/login-action@v3 with: - registry: ghcr.io - username: ${{github.actor}} - password: ${{secrets.GHCR_TOKEN}} # needs read:packages, write:packages. delete:packages - + username: ${{secrets.DOCKERHUB_USERNAME}} + password: ${{secrets.DOCKERHUB_TOKEN}} - name: Build and push uses: docker/build-push-action@v6 @@ -29,7 +25,5 @@ jobs: platforms: linux/amd64,linux/386,linux/arm64,linux/arm/v7 push: true tags: | - ghcr.io/${{ github.repository }}:master - ghcr.io/${{ github.repository }}:commit-${{ github.sha }} - - + ${{ github.repository }}:${{ github.ref_name }} + ${{ github.repository }}:commit-${{ github.sha }} \ No newline at end of file diff --git a/docker-compose.yaml b/docker-compose.yaml index e3906bc..a782b61 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -1,6 +1,6 @@ services: steamsalty: - image: ghcr.io/watn3y/steamsalty:master + image: watn3y/steamsalty:master container_name: steamsalty restart: unless-stopped volumes: From 877852aa67541b559099a199f1a5eb0900b6a57c Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sun, 22 Dec 2024 04:06:08 +0100 Subject: [PATCH 18/35] Change from ghcr to dockerhub --- .github/workflows/docker-on-push.yml | 14 ++++---------- docker-compose.yaml | 2 +- 2 files changed, 5 insertions(+), 11 deletions(-) diff --git a/.github/workflows/docker-on-push.yml b/.github/workflows/docker-on-push.yml index 8e5a593..928f14b 100644 --- a/.github/workflows/docker-on-push.yml +++ b/.github/workflows/docker-on-push.yml @@ -2,8 +2,6 @@ name: Build and Push to Docker Hub on changes to master branch on: push: - branches: - - master jobs: docker: @@ -18,10 +16,8 @@ jobs: - name: Login to GitHub Container Registry uses: docker/login-action@v3 with: - registry: ghcr.io - username: ${{github.actor}} - password: ${{secrets.GHCR_TOKEN}} # needs read:packages, write:packages. delete:packages - + username: ${{secrets.DOCKERHUB_USERNAME}} + password: ${{secrets.DOCKERHUB_TOKEN}} - name: Build and push uses: docker/build-push-action@v6 @@ -29,7 +25,5 @@ jobs: platforms: linux/amd64,linux/386,linux/arm64,linux/arm/v7 push: true tags: | - ghcr.io/${{ github.repository }}:master - ghcr.io/${{ github.repository }}:commit-${{ github.sha }} - - + ${{ github.repository }}:${{ github.ref_name }} + ${{ github.repository }}:commit-${{ github.sha }} \ No newline at end of file diff --git a/docker-compose.yaml b/docker-compose.yaml index e3906bc..a782b61 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -1,6 +1,6 @@ services: steamsalty: - image: ghcr.io/watn3y/steamsalty:master + image: watn3y/steamsalty:master container_name: steamsalty restart: unless-stopped volumes: From 51d849c967ca53a1c76cda430ab080580fb04c25 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sun, 22 Dec 2024 04:08:03 +0100 Subject: [PATCH 19/35] fix typos --- .github/workflows/docker-on-push.yml | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docker-on-push.yml b/.github/workflows/docker-on-push.yml index 928f14b..40d6edc 100644 --- a/.github/workflows/docker-on-push.yml +++ b/.github/workflows/docker-on-push.yml @@ -1,8 +1,11 @@ -name: Build and Push to Docker Hub on changes to master branch +name: Build and Push to Docker Hub on push to any branch on: push: - + paths: + - '**.go' + - 'go.mod' + - 'go.sum' jobs: docker: runs-on: ubuntu-latest @@ -13,7 +16,7 @@ jobs: - name: Set up Docker Buildx uses: docker/setup-buildx-action@v3 - - name: Login to GitHub Container Registry + - name: Login to Docker Hub uses: docker/login-action@v3 with: username: ${{secrets.DOCKERHUB_USERNAME}} From c800be186ff8835afeea7d2b14041bfd11da9f96 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sun, 22 Dec 2024 04:08:03 +0100 Subject: [PATCH 20/35] fix typos --- .github/workflows/docker-on-push.yml | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docker-on-push.yml b/.github/workflows/docker-on-push.yml index 928f14b..40d6edc 100644 --- a/.github/workflows/docker-on-push.yml +++ b/.github/workflows/docker-on-push.yml @@ -1,8 +1,11 @@ -name: Build and Push to Docker Hub on changes to master branch +name: Build and Push to Docker Hub on push to any branch on: push: - + paths: + - '**.go' + - 'go.mod' + - 'go.sum' jobs: docker: runs-on: ubuntu-latest @@ -13,7 +16,7 @@ jobs: - name: Set up Docker Buildx uses: docker/setup-buildx-action@v3 - - name: Login to GitHub Container Registry + - name: Login to Docker Hub uses: docker/login-action@v3 with: username: ${{secrets.DOCKERHUB_USERNAME}} From d50b02654560e0601fe5d67d3420f8615cbb7086 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sun, 22 Dec 2024 04:13:37 +0100 Subject: [PATCH 21/35] Build when Dockerfile changes --- .github/workflows/docker-on-push.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/docker-on-push.yml b/.github/workflows/docker-on-push.yml index 40d6edc..34adc4b 100644 --- a/.github/workflows/docker-on-push.yml +++ b/.github/workflows/docker-on-push.yml @@ -6,6 +6,8 @@ on: - '**.go' - 'go.mod' - 'go.sum' + - 'Dockerfile' + - '.github/workflows/**' jobs: docker: runs-on: ubuntu-latest From eb0482b8e02ce7151b6b2e6c6bb726861be9ad0a Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sun, 22 Dec 2024 04:13:37 +0100 Subject: [PATCH 22/35] Build when Dockerfile changes --- .github/workflows/docker-on-push.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/docker-on-push.yml b/.github/workflows/docker-on-push.yml index 40d6edc..34adc4b 100644 --- a/.github/workflows/docker-on-push.yml +++ b/.github/workflows/docker-on-push.yml @@ -6,6 +6,8 @@ on: - '**.go' - 'go.mod' - 'go.sum' + - 'Dockerfile' + - '.github/workflows/**' jobs: docker: runs-on: ubuntu-latest From 6c733c6e41d8aefb17967a0d533aee10d0bedf15 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sun, 22 Dec 2024 07:13:19 +0100 Subject: [PATCH 23/35] v1.0 - Fixed SLEEPTIME not working (always 0) - Refined logging - Added metadata to /info command - Bot now automatically sets own commands for autocompletion --- .../{docker-on-push.yml => on-push.yml} | 2 +- .gitignore | 3 ++ Dockerfile | 4 +- README.md | 42 ++++++++++++++++++- bot.go | 2 + botIO/authenticate.go | 7 +++- commands/commands.go | 37 +++++++++++++--- config/config.go | 8 ++-- config/types.go | 12 +++--- docker-compose.yaml | 14 ------- main.go | 22 ++++++---- steam/api.go | 2 +- steam/http.go | 6 +-- steam/profile.go | 8 ++-- 14 files changed, 116 insertions(+), 53 deletions(-) rename .github/workflows/{docker-on-push.yml => on-push.yml} (97%) delete mode 100644 docker-compose.yaml diff --git a/.github/workflows/docker-on-push.yml b/.github/workflows/on-push.yml similarity index 97% rename from .github/workflows/docker-on-push.yml rename to .github/workflows/on-push.yml index 34adc4b..cd0ef2e 100644 --- a/.github/workflows/docker-on-push.yml +++ b/.github/workflows/on-push.yml @@ -27,7 +27,7 @@ jobs: - name: Build and push uses: docker/build-push-action@v6 with: - platforms: linux/amd64,linux/386,linux/arm64,linux/arm/v7 + platforms: linux/amd64,linux/386,linux/arm64,linux/arm/v7,linux/riscv64 push: true tags: | ${{ github.repository }}:${{ github.ref_name }} diff --git a/.gitignore b/.gitignore index 6f72f89..3d428ed 100644 --- a/.gitignore +++ b/.gitignore @@ -23,3 +23,6 @@ go.work.sum # env file .env + +# Build ouput +build/ \ No newline at end of file diff --git a/Dockerfile b/Dockerfile index 6259e3a..e28b370 100644 --- a/Dockerfile +++ b/Dockerfile @@ -9,7 +9,7 @@ RUN go mod download COPY . . ARG TARGETOS TARGETARCH -RUN GOOS=$TARGETOS GOARCH=$TARGETARCH go build -o /app/steamsalty +RUN GOOS=$TARGETOS GOARCH=$TARGETARCH go build -o ./steamsalty @@ -19,6 +19,6 @@ WORKDIR /app COPY --from=builder /etc/ssl/certs /etc/ssl/certs COPY --from=builder /usr/share/ca-certificates /usr/share/ca-certificates -COPY --from=builder /app/steamsalty /app/steamsalty +COPY --from=builder /steamsalty/steamsalty /app/steamsalty ENTRYPOINT ["/app/steamsalty"] diff --git a/README.md b/README.md index 383a233..54840c9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,40 @@ -# steamsalty -Get notifications about Steam Comments on Telegram +# SteamSalty +SteamSalty notifies you on telegram about new comments on any steam profile. + +## Running with Docker Compose + +Docker image: https://hub.docker.com/r/watn3y/steamsalty + +Example compose file: + +```yaml +services: + steamsalty: + image: watn3y/steamsalty:latest # use : to be up-to-date with any branch + container_name: steamsalty + restart: unless-stopped + volumes: + - /etc/localtime:/etc/localtime:ro + environment: + #- STEAMSALTY_LOGLEVEL= + - STEAMSALTY_TELEGRAMAPITOKEN= + - STEAMSALTY_STEAMAPIKEY= + - STEAMSALTY_CHATID= + - STEAMSALTY_WATCHERS= + #- STEAMSALTY_SLEEPINTERVAL= +``` + +## Running on Linux + +Grab a release from the [releases page](https://github.com/watn3y/steamsalty/releases). Make sure to set your **environment variables** accordingly. + +## Environment Variables + +| Variable | Description | Default | +| ----------------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------------ | +| `STEAMSALTY_LOGLEVEL` | LogLevel as described [here](https://pkg.go.dev/github.com/rs/zerolog@v1.33.0#readme-simple-leveled-logging-example) | 1 (Info) | +| `STEAMSALTY_TELEGRAMAPITOKEN` | Telegram Bot Token, get from @BotFather | None, **required** | +| `STEAMSALTY_STEAMAPIKEY` | Steam API Key, get from https://steamcommunity.com/dev/apikey | None, **required** | +| `STEAMSALTY_CHATID` | Chat to notify about new Comments | None, **required** | +| `STEAMSALTY_WATCHERS` | SteamIDs (in SteamID64 format) to check for new Profile Comments | None, **required** | +| `STEAMSALTY_SLEEPINTERVAL` | Amount of time to wait between requests to Steam in seconds | 60 | diff --git a/bot.go b/bot.go index 2f57968..66eaa36 100644 --- a/bot.go +++ b/bot.go @@ -13,6 +13,8 @@ import ( func bot() { updates, bot := botIO.Authenticate() + go commands.SetBotCommands(bot) + go steam.StartWatchers(bot) for update := range updates { diff --git a/botIO/authenticate.go b/botIO/authenticate.go index 64f5d13..747f8b6 100644 --- a/botIO/authenticate.go +++ b/botIO/authenticate.go @@ -12,12 +12,15 @@ func Authenticate() (tgbotapi.UpdatesChannel, *tgbotapi.BotAPI) { log.Panic().Err(err).Msg("Failed to authenticate") } - bot.Debug = config.BotConfig.DebugMode + bot.Debug = false + if config.BotConfig.LogLevel == -1 { + bot.Debug = true + } updates := tgbotapi.NewUpdate(0) updates.Timeout = 60 - log.Info().Int64("ID", bot.Self.ID).Str("username", bot.Self.UserName).Msg("Successfully authenticated to Telegram API") + log.Info().Int64("ID", bot.Self.ID).Str("username", bot.Self.UserName).Msg("Authenticated to Telegram API") return bot.GetUpdatesChan(updates), bot diff --git a/commands/commands.go b/commands/commands.go index 70fe4b4..2291e6d 100644 --- a/commands/commands.go +++ b/commands/commands.go @@ -2,7 +2,10 @@ package commands import ( "fmt" + "strconv" "strings" + "time" + "watn3y/steamsalty/botIO" "watn3y/steamsalty/config" "watn3y/steamsalty/steam" @@ -11,26 +14,41 @@ import ( "github.com/rs/zerolog/log" ) +func SetBotCommands(bot *tgbotapi.BotAPI) { + github := tgbotapi.BotCommand{Command: "github", Description: "Source GitHub repo"} + info := tgbotapi.BotCommand{Command: "info", Description: "Summary of watched profiles"} + + commands := tgbotapi.NewSetMyCommands(github, info) + + result, err := bot.Request(commands) + if err != nil { + log.Error().Err(err).Msg("Failed to set own commands") + return + } + + log.Debug().Interface("commands", result).Msg("Set own commands") +} + func Commands(update tgbotapi.Update, bot *tgbotapi.BotAPI) { cmd := strings.ToLower(update.Message.Command()) - log.Debug().Str("cmd", cmd).Msg("Matching command") - switch cmd { case "start": - start(update, bot) + startGithub(update, bot) + case "github": + startGithub(update, bot) case "info": info(update, bot) } } -func start(update tgbotapi.Update, bot *tgbotapi.BotAPI) { +func startGithub(update tgbotapi.Update, bot *tgbotapi.BotAPI) { message := tgbotapi.MessageConfig{ BaseChat: tgbotapi.BaseChat{ChatID: update.Message.Chat.ID, ReplyToMessageID: update.Message.MessageID}, ParseMode: "html", DisableWebPagePreview: false, - Text: "https://github.com/watn3y/steamsalty", + Text: "Check out: https://github.com/watn3y/steamsalty", } botIO.SendMessage(message, bot) } @@ -44,9 +62,16 @@ func info(update tgbotapi.Update, bot *tgbotapi.BotAPI) { for _, steamID := range config.BotConfig.Watchers { profile := steam.GetPlayerDetails(steamID) + comments := steam.GetComments(steamID, 0, 0) - textInfo += fmt.Sprintf(`- %s`, profile.ProfileURL, profile.PersonaName) + "\n" + lastComment := "never :(" + if comments.TimeLastPost > 0 { + lastComment = time.Unix(comments.TimeLastPost, 0).Format(time.RFC1123) + } + textInfo += fmt.Sprintf(`%s:`, profile.ProfileURL, profile.PersonaName) + "\n" + + fmt.Sprintf(`Last Comment: %s`, lastComment) + "\n" + + fmt.Sprintf(`Number of Comments: %s`, strconv.Itoa(comments.TotalCount)) + "\n\n" } message := tgbotapi.MessageConfig{ diff --git a/config/config.go b/config/config.go index 1d8ce2e..53e9257 100644 --- a/config/config.go +++ b/config/config.go @@ -2,6 +2,7 @@ package config import ( "context" + "github.com/rs/zerolog" "github.com/rs/zerolog/log" envconfig "github.com/sethvargo/go-envconfig" @@ -11,12 +12,9 @@ var BotConfig config func LoadConfig() { if err := envconfig.Process(context.Background(), &BotConfig); err != nil { - log.Panic().Err(err).Msg("error parsing config from env variables") - } - - if !BotConfig.DebugMode { - zerolog.SetGlobalLevel(zerolog.InfoLevel) + log.Panic().Err(err).Msg("Error parsing config from env variables") } + zerolog.SetGlobalLevel(zerolog.Level(BotConfig.LogLevel)) log.Info().Msg("Loaded config") log.Debug().Interface("config", BotConfig).Msg("") diff --git a/config/types.go b/config/types.go index 5abf464..63f916b 100644 --- a/config/types.go +++ b/config/types.go @@ -1,10 +1,10 @@ package config type config struct { - TelegramAPIToken string `env:"TELEGRAMAPITOKEN, required"` - SteamAPIKey string `env:"STEAMAPIKEY, required"` - DebugMode bool `env:"DEBUGMODE, default=false"` - ChatID int64 `env:"CHATID"` - Watchers []uint64 `env:"WATCHERS"` - SleepInterval int `env:"SLEEPINTERVAL"` + LogLevel int `env:"STEAMSALTY_LOGLEVEL, default=1"` + TelegramAPIToken string `env:"STEAMSALTY_TELEGRAMAPITOKEN, required"` + SteamAPIKey string `env:"STEAMSALTY_STEAMAPIKEY, required"` + ChatID int64 `env:"STEAMSALTY_CHATID, required"` + Watchers []uint64 `env:"STEAMSALTY_WATCHERS, required"` + SleepInterval int `env:"STEAMSALTY_SLEEPINTERVAL, default=60"` } diff --git a/docker-compose.yaml b/docker-compose.yaml deleted file mode 100644 index a782b61..0000000 --- a/docker-compose.yaml +++ /dev/null @@ -1,14 +0,0 @@ -services: - steamsalty: - image: watn3y/steamsalty:master - container_name: steamsalty - restart: unless-stopped - volumes: - - /etc/localtime:/etc/localtime:ro - environment: - - TELEGRAMAPITOKEN= - - STEAMAPIKEY= - - DebugMode=false - - CHATID=123 - - WATCHERS=123,456,789 - - SLEEPINTERVAL=60 \ No newline at end of file diff --git a/main.go b/main.go index 5b52270..fcc9cfb 100644 --- a/main.go +++ b/main.go @@ -1,18 +1,19 @@ package main import ( - "fmt" "os" + "strconv" + "strings" "time" "github.com/rs/zerolog" "github.com/rs/zerolog/log" - + "watn3y/steamsalty/config" ) func main() { - fmt.Println("Starting SteamSalty...") + println("Starting SteamSalty...") configureLogger() @@ -23,13 +24,20 @@ func main() { } func configureLogger() { + + zerolog.CallerMarshalFunc = func(pc uintptr, file string, line int) string { + const prefix = "steamsalty/" + + index := strings.Index(file, prefix) + if index != -1 { + return file[index+len(prefix):] + ":" + strconv.Itoa(line) + } + return file + ":" + strconv.Itoa(line) + } + output := zerolog.ConsoleWriter{Out: os.Stdout, TimeFormat: time.DateTime} log.Logger = zerolog.New(output).With().Timestamp().Caller().Logger() - - //! note that we overwrite the loglevel after loading the config in config/config.go. This is just the default - zerolog.SetGlobalLevel(zerolog.TraceLevel) - log.Info().Msg("Started Logger") } diff --git a/steam/api.go b/steam/api.go index e79f8b9..9a41911 100644 --- a/steam/api.go +++ b/steam/api.go @@ -13,6 +13,6 @@ func GetPlayerDetails(steamID uint64) (summary steamapi.PlayerSummary) { if err != nil { log.Error().Err(err).Msg("Failed to get Player Summary") } - log.Debug().Interface("Player", response[0]).Msg("Successfully got PlayerSummary from Steam API") + log.Debug().Interface("Player", response[0]).Msg("Got PlayerSummary from Steam API") return response[0] } diff --git a/steam/http.go b/steam/http.go index 70b0337..2c734fa 100644 --- a/steam/http.go +++ b/steam/http.go @@ -13,7 +13,7 @@ import ( "github.com/rs/zerolog/log" ) -func getComments(steamID uint64, start int, count int) (page CommentsPage) { +func GetComments(steamID uint64, start int, count int) (page CommentsPage) { baseURL := "https://steamcommunity.com/comment/Profile/render/" @@ -47,7 +47,7 @@ func getComments(steamID uint64, start int, count int) (page CommentsPage) { log.Error().Err(err).Msg("Failed to parse Comments as JSON") } - log.Debug().Interface("CommentPage", page).Uint64("ProfileID", steamID).Msg("Successfully got Comment Page") + log.Trace().Interface("CommentPage", page).Uint64("ProfileID", steamID).Msg("Got Comment Page") return page } @@ -85,6 +85,6 @@ func parseComments(rawComments CommentsPage) (comments []Comment) { }) slices.Reverse(comments) - log.Debug().Interface("Comments", comments).Msg("Successfully parsed Comment Page") + log.Trace().Interface("Comments", comments).Msg("Parsed Comment Page") return comments } diff --git a/steam/profile.go b/steam/profile.go index 1154020..ec0b1b0 100644 --- a/steam/profile.go +++ b/steam/profile.go @@ -15,30 +15,30 @@ import ( "github.com/rs/zerolog/log" ) -var sleeptime time.Duration = time.Duration(config.BotConfig.SleepInterval) * time.Second var steamContentCheckText string = "This comment is awaiting analysis by our automated content check system. It will be temporarily hidden until we verify that it does not contain harmful content (e.g. links to websites that attempt to steal information)." func StartWatchers(bot *tgbotapi.BotAPI) { + var wg sync.WaitGroup for _, steamID := range config.BotConfig.Watchers { wg.Add(1) go func(steamID uint64) { defer wg.Done() - watcher(bot, steamID) + watcher(bot, steamID, time.Duration(config.BotConfig.SleepInterval)*time.Second) }(steamID) } wg.Wait() } -func watcher(bot *tgbotapi.BotAPI, steamID uint64) { +func watcher(bot *tgbotapi.BotAPI, steamID uint64, sleeptime time.Duration) { log.Info().Uint64("SteamID", steamID).Msg("Started Watcher") var newestProcessedComment int64 = 0 for { - currentCommentsPage := getComments(steamID, 0, math.MaxInt32) + currentCommentsPage := GetComments(steamID, 0, math.MaxInt32) if newestProcessedComment == 0 || newestProcessedComment == currentCommentsPage.TimeLastPost { newestProcessedComment = currentCommentsPage.TimeLastPost time.Sleep(sleeptime) From 6be403fc5874dced53d78fca1bdaa28b10f3d3dd Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sun, 22 Dec 2024 07:13:19 +0100 Subject: [PATCH 24/35] v1.0 - Fixed SLEEPTIME not working (always 0) - Refined logging - Added metadata to /info command - Bot now automatically sets own commands for autocompletion --- .../{docker-on-push.yml => on-push.yml} | 2 +- .gitignore | 3 ++ Dockerfile | 4 +- README.md | 42 ++++++++++++++++++- bot.go | 2 + botIO/authenticate.go | 7 +++- commands/commands.go | 37 +++++++++++++--- config/config.go | 8 ++-- config/types.go | 12 +++--- docker-compose.yaml | 14 ------- main.go | 22 ++++++---- steam/api.go | 2 +- steam/http.go | 6 +-- steam/profile.go | 8 ++-- 14 files changed, 116 insertions(+), 53 deletions(-) rename .github/workflows/{docker-on-push.yml => on-push.yml} (97%) delete mode 100644 docker-compose.yaml diff --git a/.github/workflows/docker-on-push.yml b/.github/workflows/on-push.yml similarity index 97% rename from .github/workflows/docker-on-push.yml rename to .github/workflows/on-push.yml index 34adc4b..cd0ef2e 100644 --- a/.github/workflows/docker-on-push.yml +++ b/.github/workflows/on-push.yml @@ -27,7 +27,7 @@ jobs: - name: Build and push uses: docker/build-push-action@v6 with: - platforms: linux/amd64,linux/386,linux/arm64,linux/arm/v7 + platforms: linux/amd64,linux/386,linux/arm64,linux/arm/v7,linux/riscv64 push: true tags: | ${{ github.repository }}:${{ github.ref_name }} diff --git a/.gitignore b/.gitignore index 6f72f89..3d428ed 100644 --- a/.gitignore +++ b/.gitignore @@ -23,3 +23,6 @@ go.work.sum # env file .env + +# Build ouput +build/ \ No newline at end of file diff --git a/Dockerfile b/Dockerfile index 6259e3a..e28b370 100644 --- a/Dockerfile +++ b/Dockerfile @@ -9,7 +9,7 @@ RUN go mod download COPY . . ARG TARGETOS TARGETARCH -RUN GOOS=$TARGETOS GOARCH=$TARGETARCH go build -o /app/steamsalty +RUN GOOS=$TARGETOS GOARCH=$TARGETARCH go build -o ./steamsalty @@ -19,6 +19,6 @@ WORKDIR /app COPY --from=builder /etc/ssl/certs /etc/ssl/certs COPY --from=builder /usr/share/ca-certificates /usr/share/ca-certificates -COPY --from=builder /app/steamsalty /app/steamsalty +COPY --from=builder /steamsalty/steamsalty /app/steamsalty ENTRYPOINT ["/app/steamsalty"] diff --git a/README.md b/README.md index 383a233..54840c9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,40 @@ -# steamsalty -Get notifications about Steam Comments on Telegram +# SteamSalty +SteamSalty notifies you on telegram about new comments on any steam profile. + +## Running with Docker Compose + +Docker image: https://hub.docker.com/r/watn3y/steamsalty + +Example compose file: + +```yaml +services: + steamsalty: + image: watn3y/steamsalty:latest # use : to be up-to-date with any branch + container_name: steamsalty + restart: unless-stopped + volumes: + - /etc/localtime:/etc/localtime:ro + environment: + #- STEAMSALTY_LOGLEVEL= + - STEAMSALTY_TELEGRAMAPITOKEN= + - STEAMSALTY_STEAMAPIKEY= + - STEAMSALTY_CHATID= + - STEAMSALTY_WATCHERS= + #- STEAMSALTY_SLEEPINTERVAL= +``` + +## Running on Linux + +Grab a release from the [releases page](https://github.com/watn3y/steamsalty/releases). Make sure to set your **environment variables** accordingly. + +## Environment Variables + +| Variable | Description | Default | +| ----------------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------------ | +| `STEAMSALTY_LOGLEVEL` | LogLevel as described [here](https://pkg.go.dev/github.com/rs/zerolog@v1.33.0#readme-simple-leveled-logging-example) | 1 (Info) | +| `STEAMSALTY_TELEGRAMAPITOKEN` | Telegram Bot Token, get from @BotFather | None, **required** | +| `STEAMSALTY_STEAMAPIKEY` | Steam API Key, get from https://steamcommunity.com/dev/apikey | None, **required** | +| `STEAMSALTY_CHATID` | Chat to notify about new Comments | None, **required** | +| `STEAMSALTY_WATCHERS` | SteamIDs (in SteamID64 format) to check for new Profile Comments | None, **required** | +| `STEAMSALTY_SLEEPINTERVAL` | Amount of time to wait between requests to Steam in seconds | 60 | diff --git a/bot.go b/bot.go index 2f57968..66eaa36 100644 --- a/bot.go +++ b/bot.go @@ -13,6 +13,8 @@ import ( func bot() { updates, bot := botIO.Authenticate() + go commands.SetBotCommands(bot) + go steam.StartWatchers(bot) for update := range updates { diff --git a/botIO/authenticate.go b/botIO/authenticate.go index 64f5d13..747f8b6 100644 --- a/botIO/authenticate.go +++ b/botIO/authenticate.go @@ -12,12 +12,15 @@ func Authenticate() (tgbotapi.UpdatesChannel, *tgbotapi.BotAPI) { log.Panic().Err(err).Msg("Failed to authenticate") } - bot.Debug = config.BotConfig.DebugMode + bot.Debug = false + if config.BotConfig.LogLevel == -1 { + bot.Debug = true + } updates := tgbotapi.NewUpdate(0) updates.Timeout = 60 - log.Info().Int64("ID", bot.Self.ID).Str("username", bot.Self.UserName).Msg("Successfully authenticated to Telegram API") + log.Info().Int64("ID", bot.Self.ID).Str("username", bot.Self.UserName).Msg("Authenticated to Telegram API") return bot.GetUpdatesChan(updates), bot diff --git a/commands/commands.go b/commands/commands.go index 70fe4b4..2291e6d 100644 --- a/commands/commands.go +++ b/commands/commands.go @@ -2,7 +2,10 @@ package commands import ( "fmt" + "strconv" "strings" + "time" + "watn3y/steamsalty/botIO" "watn3y/steamsalty/config" "watn3y/steamsalty/steam" @@ -11,26 +14,41 @@ import ( "github.com/rs/zerolog/log" ) +func SetBotCommands(bot *tgbotapi.BotAPI) { + github := tgbotapi.BotCommand{Command: "github", Description: "Source GitHub repo"} + info := tgbotapi.BotCommand{Command: "info", Description: "Summary of watched profiles"} + + commands := tgbotapi.NewSetMyCommands(github, info) + + result, err := bot.Request(commands) + if err != nil { + log.Error().Err(err).Msg("Failed to set own commands") + return + } + + log.Debug().Interface("commands", result).Msg("Set own commands") +} + func Commands(update tgbotapi.Update, bot *tgbotapi.BotAPI) { cmd := strings.ToLower(update.Message.Command()) - log.Debug().Str("cmd", cmd).Msg("Matching command") - switch cmd { case "start": - start(update, bot) + startGithub(update, bot) + case "github": + startGithub(update, bot) case "info": info(update, bot) } } -func start(update tgbotapi.Update, bot *tgbotapi.BotAPI) { +func startGithub(update tgbotapi.Update, bot *tgbotapi.BotAPI) { message := tgbotapi.MessageConfig{ BaseChat: tgbotapi.BaseChat{ChatID: update.Message.Chat.ID, ReplyToMessageID: update.Message.MessageID}, ParseMode: "html", DisableWebPagePreview: false, - Text: "https://github.com/watn3y/steamsalty", + Text: "Check out: https://github.com/watn3y/steamsalty", } botIO.SendMessage(message, bot) } @@ -44,9 +62,16 @@ func info(update tgbotapi.Update, bot *tgbotapi.BotAPI) { for _, steamID := range config.BotConfig.Watchers { profile := steam.GetPlayerDetails(steamID) + comments := steam.GetComments(steamID, 0, 0) - textInfo += fmt.Sprintf(`- %s`, profile.ProfileURL, profile.PersonaName) + "\n" + lastComment := "never :(" + if comments.TimeLastPost > 0 { + lastComment = time.Unix(comments.TimeLastPost, 0).Format(time.RFC1123) + } + textInfo += fmt.Sprintf(`%s:`, profile.ProfileURL, profile.PersonaName) + "\n" + + fmt.Sprintf(`Last Comment: %s`, lastComment) + "\n" + + fmt.Sprintf(`Number of Comments: %s`, strconv.Itoa(comments.TotalCount)) + "\n\n" } message := tgbotapi.MessageConfig{ diff --git a/config/config.go b/config/config.go index 1d8ce2e..53e9257 100644 --- a/config/config.go +++ b/config/config.go @@ -2,6 +2,7 @@ package config import ( "context" + "github.com/rs/zerolog" "github.com/rs/zerolog/log" envconfig "github.com/sethvargo/go-envconfig" @@ -11,12 +12,9 @@ var BotConfig config func LoadConfig() { if err := envconfig.Process(context.Background(), &BotConfig); err != nil { - log.Panic().Err(err).Msg("error parsing config from env variables") - } - - if !BotConfig.DebugMode { - zerolog.SetGlobalLevel(zerolog.InfoLevel) + log.Panic().Err(err).Msg("Error parsing config from env variables") } + zerolog.SetGlobalLevel(zerolog.Level(BotConfig.LogLevel)) log.Info().Msg("Loaded config") log.Debug().Interface("config", BotConfig).Msg("") diff --git a/config/types.go b/config/types.go index 5abf464..63f916b 100644 --- a/config/types.go +++ b/config/types.go @@ -1,10 +1,10 @@ package config type config struct { - TelegramAPIToken string `env:"TELEGRAMAPITOKEN, required"` - SteamAPIKey string `env:"STEAMAPIKEY, required"` - DebugMode bool `env:"DEBUGMODE, default=false"` - ChatID int64 `env:"CHATID"` - Watchers []uint64 `env:"WATCHERS"` - SleepInterval int `env:"SLEEPINTERVAL"` + LogLevel int `env:"STEAMSALTY_LOGLEVEL, default=1"` + TelegramAPIToken string `env:"STEAMSALTY_TELEGRAMAPITOKEN, required"` + SteamAPIKey string `env:"STEAMSALTY_STEAMAPIKEY, required"` + ChatID int64 `env:"STEAMSALTY_CHATID, required"` + Watchers []uint64 `env:"STEAMSALTY_WATCHERS, required"` + SleepInterval int `env:"STEAMSALTY_SLEEPINTERVAL, default=60"` } diff --git a/docker-compose.yaml b/docker-compose.yaml deleted file mode 100644 index a782b61..0000000 --- a/docker-compose.yaml +++ /dev/null @@ -1,14 +0,0 @@ -services: - steamsalty: - image: watn3y/steamsalty:master - container_name: steamsalty - restart: unless-stopped - volumes: - - /etc/localtime:/etc/localtime:ro - environment: - - TELEGRAMAPITOKEN= - - STEAMAPIKEY= - - DebugMode=false - - CHATID=123 - - WATCHERS=123,456,789 - - SLEEPINTERVAL=60 \ No newline at end of file diff --git a/main.go b/main.go index 5b52270..fcc9cfb 100644 --- a/main.go +++ b/main.go @@ -1,18 +1,19 @@ package main import ( - "fmt" "os" + "strconv" + "strings" "time" "github.com/rs/zerolog" "github.com/rs/zerolog/log" - + "watn3y/steamsalty/config" ) func main() { - fmt.Println("Starting SteamSalty...") + println("Starting SteamSalty...") configureLogger() @@ -23,13 +24,20 @@ func main() { } func configureLogger() { + + zerolog.CallerMarshalFunc = func(pc uintptr, file string, line int) string { + const prefix = "steamsalty/" + + index := strings.Index(file, prefix) + if index != -1 { + return file[index+len(prefix):] + ":" + strconv.Itoa(line) + } + return file + ":" + strconv.Itoa(line) + } + output := zerolog.ConsoleWriter{Out: os.Stdout, TimeFormat: time.DateTime} log.Logger = zerolog.New(output).With().Timestamp().Caller().Logger() - - //! note that we overwrite the loglevel after loading the config in config/config.go. This is just the default - zerolog.SetGlobalLevel(zerolog.TraceLevel) - log.Info().Msg("Started Logger") } diff --git a/steam/api.go b/steam/api.go index e79f8b9..9a41911 100644 --- a/steam/api.go +++ b/steam/api.go @@ -13,6 +13,6 @@ func GetPlayerDetails(steamID uint64) (summary steamapi.PlayerSummary) { if err != nil { log.Error().Err(err).Msg("Failed to get Player Summary") } - log.Debug().Interface("Player", response[0]).Msg("Successfully got PlayerSummary from Steam API") + log.Debug().Interface("Player", response[0]).Msg("Got PlayerSummary from Steam API") return response[0] } diff --git a/steam/http.go b/steam/http.go index 70b0337..2c734fa 100644 --- a/steam/http.go +++ b/steam/http.go @@ -13,7 +13,7 @@ import ( "github.com/rs/zerolog/log" ) -func getComments(steamID uint64, start int, count int) (page CommentsPage) { +func GetComments(steamID uint64, start int, count int) (page CommentsPage) { baseURL := "https://steamcommunity.com/comment/Profile/render/" @@ -47,7 +47,7 @@ func getComments(steamID uint64, start int, count int) (page CommentsPage) { log.Error().Err(err).Msg("Failed to parse Comments as JSON") } - log.Debug().Interface("CommentPage", page).Uint64("ProfileID", steamID).Msg("Successfully got Comment Page") + log.Trace().Interface("CommentPage", page).Uint64("ProfileID", steamID).Msg("Got Comment Page") return page } @@ -85,6 +85,6 @@ func parseComments(rawComments CommentsPage) (comments []Comment) { }) slices.Reverse(comments) - log.Debug().Interface("Comments", comments).Msg("Successfully parsed Comment Page") + log.Trace().Interface("Comments", comments).Msg("Parsed Comment Page") return comments } diff --git a/steam/profile.go b/steam/profile.go index 1154020..ec0b1b0 100644 --- a/steam/profile.go +++ b/steam/profile.go @@ -15,30 +15,30 @@ import ( "github.com/rs/zerolog/log" ) -var sleeptime time.Duration = time.Duration(config.BotConfig.SleepInterval) * time.Second var steamContentCheckText string = "This comment is awaiting analysis by our automated content check system. It will be temporarily hidden until we verify that it does not contain harmful content (e.g. links to websites that attempt to steal information)." func StartWatchers(bot *tgbotapi.BotAPI) { + var wg sync.WaitGroup for _, steamID := range config.BotConfig.Watchers { wg.Add(1) go func(steamID uint64) { defer wg.Done() - watcher(bot, steamID) + watcher(bot, steamID, time.Duration(config.BotConfig.SleepInterval)*time.Second) }(steamID) } wg.Wait() } -func watcher(bot *tgbotapi.BotAPI, steamID uint64) { +func watcher(bot *tgbotapi.BotAPI, steamID uint64, sleeptime time.Duration) { log.Info().Uint64("SteamID", steamID).Msg("Started Watcher") var newestProcessedComment int64 = 0 for { - currentCommentsPage := getComments(steamID, 0, math.MaxInt32) + currentCommentsPage := GetComments(steamID, 0, math.MaxInt32) if newestProcessedComment == 0 || newestProcessedComment == currentCommentsPage.TimeLastPost { newestProcessedComment = currentCommentsPage.TimeLastPost time.Sleep(sleeptime) From 60fd4b963cc708de1b98b5db2674f10a7b523d40 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sun, 22 Dec 2024 07:41:48 +0100 Subject: [PATCH 25/35] add build script --- build.sh | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 build.sh diff --git a/build.sh b/build.sh new file mode 100644 index 0000000..49d6e91 --- /dev/null +++ b/build.sh @@ -0,0 +1,54 @@ +#!/usr/bin/env bash + + +# Get the current directory name as the project name +PROJECT_NAME=$(basename "$PWD") + +# Change to the Go project directory (current directory) +cd "$PWD" || exit + +# List of target architectures +architectures=( + "linux/amd64" + "linux/386" + "linux/arm64" + "linux/arm/v7" + "linux/riscv64" + "windows/amd64" + "darwin/amd64" + "darwin/arm64" +) + +# Create a build directory if it doesn't exist +mkdir -p build + +# Loop over architectures and build for each one +for arch in "${architectures[@]}"; do + os=$(echo $arch | cut -d '/' -f 1) + arch_type=$(echo $arch | cut -d '/' -f 2) + + # Set the output file name using the project name, os, and arch + output_file="build/$PROJECT_NAME-$os-$arch_type" + + # Build the app for the specific architecture + GOARCH=$arch_type GOOS=$os go build -o "$output_file" + + # Provide feedback to the user + if [ $? -eq 0 ]; then + echo "Successfully built for $arch: $output_file" + + # Create a tar.gz archive for the individual build + tar -czf "$output_file.tar.gz" -C build $(basename "$output_file") + if [ $? -eq 0 ]; then + echo "Successfully created archive: $output_file.tar.gz" + + # Delete the executable after archiving + rm "$output_file" + echo "Deleted executable: $output_file" + else + echo "Failed to create archive for $output_file" + fi + else + echo "Failed to build for $arch" + fi +done \ No newline at end of file From a2c4c43eaa553bf1caa316b6b70edf60ca0e4cde Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sun, 22 Dec 2024 07:41:48 +0100 Subject: [PATCH 26/35] add build script --- build.sh | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 build.sh diff --git a/build.sh b/build.sh new file mode 100644 index 0000000..49d6e91 --- /dev/null +++ b/build.sh @@ -0,0 +1,54 @@ +#!/usr/bin/env bash + + +# Get the current directory name as the project name +PROJECT_NAME=$(basename "$PWD") + +# Change to the Go project directory (current directory) +cd "$PWD" || exit + +# List of target architectures +architectures=( + "linux/amd64" + "linux/386" + "linux/arm64" + "linux/arm/v7" + "linux/riscv64" + "windows/amd64" + "darwin/amd64" + "darwin/arm64" +) + +# Create a build directory if it doesn't exist +mkdir -p build + +# Loop over architectures and build for each one +for arch in "${architectures[@]}"; do + os=$(echo $arch | cut -d '/' -f 1) + arch_type=$(echo $arch | cut -d '/' -f 2) + + # Set the output file name using the project name, os, and arch + output_file="build/$PROJECT_NAME-$os-$arch_type" + + # Build the app for the specific architecture + GOARCH=$arch_type GOOS=$os go build -o "$output_file" + + # Provide feedback to the user + if [ $? -eq 0 ]; then + echo "Successfully built for $arch: $output_file" + + # Create a tar.gz archive for the individual build + tar -czf "$output_file.tar.gz" -C build $(basename "$output_file") + if [ $? -eq 0 ]; then + echo "Successfully created archive: $output_file.tar.gz" + + # Delete the executable after archiving + rm "$output_file" + echo "Deleted executable: $output_file" + else + echo "Failed to create archive for $output_file" + fi + else + echo "Failed to build for $arch" + fi +done \ No newline at end of file From 20b5287675fe1489ecbd1c9db1728e074a07302d Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sun, 22 Dec 2024 08:20:51 +0100 Subject: [PATCH 27/35] gitignore vscode config --- .gitignore | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 3d428ed..14beab4 100644 --- a/.gitignore +++ b/.gitignore @@ -25,4 +25,7 @@ go.work.sum .env # Build ouput -build/ \ No newline at end of file +build/ + +# vscode config +.vscode/ \ No newline at end of file From b0d49ab3c4678cd40af02627f42bd4877cbf3cae Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sun, 22 Dec 2024 08:20:51 +0100 Subject: [PATCH 28/35] gitignore vscode config --- .gitignore | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 3d428ed..14beab4 100644 --- a/.gitignore +++ b/.gitignore @@ -25,4 +25,7 @@ go.work.sum .env # Build ouput -build/ \ No newline at end of file +build/ + +# vscode config +.vscode/ \ No newline at end of file From 0e278d87ec5008f9e1affe317b067320108ffcd6 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sun, 22 Dec 2024 08:21:02 +0100 Subject: [PATCH 29/35] Don't log every received message --- bot.go | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/bot.go b/bot.go index 66eaa36..e2e15b9 100644 --- a/bot.go +++ b/bot.go @@ -29,9 +29,8 @@ func bot() { continue } - log.Info().Int64("ChatID", update.Message.Chat.ID).Int64("UserID", update.Message.From.ID).Str("Text", update.Message.Text).Msg("Recieved Message") - if update.Message.IsCommand() { + log.Info().Int64("ChatID", update.Message.Chat.ID).Int64("UserID", update.Message.From.ID).Str("Text", update.Message.Text).Msg("Received Command") commands.Commands(update, bot) } } From b0d68f3a8371ea39aab2dca2bdf4e40b1e05525c Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sun, 22 Dec 2024 08:21:02 +0100 Subject: [PATCH 30/35] Don't log every received message --- bot.go | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/bot.go b/bot.go index 66eaa36..e2e15b9 100644 --- a/bot.go +++ b/bot.go @@ -29,9 +29,8 @@ func bot() { continue } - log.Info().Int64("ChatID", update.Message.Chat.ID).Int64("UserID", update.Message.From.ID).Str("Text", update.Message.Text).Msg("Recieved Message") - if update.Message.IsCommand() { + log.Info().Int64("ChatID", update.Message.Chat.ID).Int64("UserID", update.Message.From.ID).Str("Text", update.Message.Text).Msg("Received Command") commands.Commands(update, bot) } } From e654f8449ca1d7f7c9dfd901c50234898ba46d90 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Fri, 8 Aug 2025 01:19:10 +0200 Subject: [PATCH 31/35] bump golang.org/x/net to v0.43.0 for security fixes - Upgraded golang.org/x/net from v0.33.0 to v0.43.0 - Addresses: CVE-2025-22870 and CVE-2025-22872 - No functional changes or breaking updates --- Dockerfile | 2 +- README.md | 19 ++++++++++--------- go.mod | 14 +++++++------- go.sum | 23 +++++++++++++---------- 4 files changed, 31 insertions(+), 27 deletions(-) diff --git a/Dockerfile b/Dockerfile index e28b370..a8bc03b 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,4 @@ -FROM --platform=$BUILDPLATFORM golang:1.23.4-alpine AS builder +FROM --platform=$BUILDPLATFORM golang:1.24.6-alpine AS builder WORKDIR /steamsalty diff --git a/README.md b/README.md index 54840c9..aa69129 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ # SteamSalty + SteamSalty notifies you on telegram about new comments on any steam profile. ## Running with Docker Compose -Docker image: https://hub.docker.com/r/watn3y/steamsalty +Docker image: Example compose file: @@ -30,11 +31,11 @@ Grab a release from the [releases page](https://github.com/watn3y/steamsalty/rel ## Environment Variables -| Variable | Description | Default | -| ----------------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------------ | -| `STEAMSALTY_LOGLEVEL` | LogLevel as described [here](https://pkg.go.dev/github.com/rs/zerolog@v1.33.0#readme-simple-leveled-logging-example) | 1 (Info) | -| `STEAMSALTY_TELEGRAMAPITOKEN` | Telegram Bot Token, get from @BotFather | None, **required** | -| `STEAMSALTY_STEAMAPIKEY` | Steam API Key, get from https://steamcommunity.com/dev/apikey | None, **required** | -| `STEAMSALTY_CHATID` | Chat to notify about new Comments | None, **required** | -| `STEAMSALTY_WATCHERS` | SteamIDs (in SteamID64 format) to check for new Profile Comments | None, **required** | -| `STEAMSALTY_SLEEPINTERVAL` | Amount of time to wait between requests to Steam in seconds | 60 | +| Variable | Description | Default | +| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------| ------------------ | +| `STEAMSALTY_LOGLEVEL` | LogLevel as described [in the zerolog documentation](https://pkg.go.dev/github.com/rs/zerolog@v1.34.0#readme-simple-leveled-logging-example) | 1 (Info) | +| `STEAMSALTY_TELEGRAMAPITOKEN` | Telegram Bot Token, get from @BotFather | None, **required** | +| `STEAMSALTY_STEAMAPIKEY` | Steam API Key, get from [steamcommunity.com/dev/apikey](https://steamcommunity.com/dev/apikey) | None, **required** | +| `STEAMSALTY_CHATID` | Chat to notify about new Comments | None, **required** | +| `STEAMSALTY_WATCHERS` | SteamIDs (in SteamID64 format) to check for new Profile Comments | None, **required** | +| `STEAMSALTY_SLEEPINTERVAL` | Amount of time to wait between requests to Steam in seconds | 60 | diff --git a/go.mod b/go.mod index e6693ba..c067f00 100644 --- a/go.mod +++ b/go.mod @@ -1,19 +1,19 @@ module watn3y/steamsalty -go 1.23.4 +go 1.24.6 require ( github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1 - github.com/PuerkitoBio/goquery v1.10.0 + github.com/PuerkitoBio/goquery v1.10.3 github.com/go-telegram-bot-api/telegram-bot-api/v5 v5.5.1 - github.com/rs/zerolog v1.33.0 - github.com/sethvargo/go-envconfig v1.1.0 + github.com/rs/zerolog v1.34.0 + github.com/sethvargo/go-envconfig v1.3.0 ) require ( github.com/andybalholm/cascadia v1.3.3 // indirect - github.com/mattn/go-colorable v0.1.13 // indirect + github.com/mattn/go-colorable v0.1.14 // indirect github.com/mattn/go-isatty v0.0.20 // indirect - golang.org/x/net v0.33.0 // indirect - golang.org/x/sys v0.28.0 // indirect + golang.org/x/net v0.43.0 // indirect + golang.org/x/sys v0.35.0 // indirect ) diff --git a/go.sum b/go.sum index 696f506..c9b21ee 100644 --- a/go.sum +++ b/go.sum @@ -1,7 +1,7 @@ github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1 h1:PD13eMe9XAgPQ0SYWyirqwyOJG90TlEWApCw8A699l0= github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1/go.mod h1:eQR7Xf64m2ALDAQE7Nr9ylFZhav1izvF3zzysKPhb0I= -github.com/PuerkitoBio/goquery v1.10.0 h1:6fiXdLuUvYs2OJSvNRqlNPoBm6YABE226xrbavY5Wv4= -github.com/PuerkitoBio/goquery v1.10.0/go.mod h1:TjZZl68Q3eGHNBA8CWaxAN7rOU1EbDz3CWuolcO5Yu4= +github.com/PuerkitoBio/goquery v1.10.3 h1:pFYcNSqHxBD06Fpj/KsbStFRsgRATgnf3LeXiUkhzPo= +github.com/PuerkitoBio/goquery v1.10.3/go.mod h1:tMUX0zDMHXYlAQk6p35XxQMqMweEKB7iK7iLNd4RH4Y= github.com/andybalholm/cascadia v1.3.3 h1:AG2YHrzJIm4BZ19iwJ/DAua6Btl3IwJX+VI4kktS1LM= github.com/andybalholm/cascadia v1.3.3/go.mod h1:xNd9bqTn98Ln4DwST8/nG+H0yuB8Hmgu1YHNnWw0GeA= github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= @@ -10,18 +10,19 @@ github.com/go-telegram-bot-api/telegram-bot-api/v5 v5.5.1/go.mod h1:A2S0CWkNylc2 github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= -github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA= github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg= +github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE= +github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8= github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= -github.com/rs/xid v1.5.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg= -github.com/rs/zerolog v1.33.0 h1:1cU2KZkvPxNyfgEmhHAz/1A9Bz+llsdYzklWFzgp0r8= -github.com/rs/zerolog v1.33.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss= -github.com/sethvargo/go-envconfig v1.1.0 h1:cWZiJxeTm7AlCvzGXrEXaSTCNgip5oJepekh/BOQuog= -github.com/sethvargo/go-envconfig v1.1.0/go.mod h1:JLd0KFWQYzyENqnEPWWZ49i4vzZo/6nRidxI8YvGiHw= +github.com/rs/xid v1.6.0/go.mod h1:7XoLgs4eV+QndskICGsho+ADou8ySMSjJKDIan90Nz0= +github.com/rs/zerolog v1.34.0 h1:k43nTLIwcTVQAncfCw4KZ2VY6ukYoZaBPNOE8txlOeY= +github.com/rs/zerolog v1.34.0/go.mod h1:bJsvje4Z08ROH4Nhs5iH600c3IkWhwp44iRc54W6wYQ= +github.com/sethvargo/go-envconfig v1.3.0 h1:gJs+Fuv8+f05omTpwWIu6KmuseFAXKrIaOZSh8RMt0U= +github.com/sethvargo/go-envconfig v1.3.0/go.mod h1:JLd0KFWQYzyENqnEPWWZ49i4vzZo/6nRidxI8YvGiHw= github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= @@ -42,8 +43,9 @@ golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk= golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44= golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM= -golang.org/x/net v0.33.0 h1:74SYHlV8BIgHIFC/LrYkOGIwL19eTYXQ5wc6TBuO36I= golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4= +golang.org/x/net v0.43.0 h1:lat02VYK2j4aLzMzecihNvTlJNQUq316m2Mr9rnM6YE= +golang.org/x/net v0.43.0/go.mod h1:vhO1fvI4dGsIjh73sWfUVjj3N7CA9WkKJNQm2svM6Jg= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= @@ -63,8 +65,9 @@ golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= -golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA= golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.35.0 h1:vz1N37gP5bs89s7He8XuIYXpyY0+QlsKmzipCbUtyxI= +golang.org/x/sys v0.35.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= golang.org/x/telemetry v0.0.0-20240228155512-f48c80bd79b2/go.mod h1:TeRTkGYfJXctD9OcfyVLyj2J3IxLnKwHJR8f4D8a3YE= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= From 3cf9c8eea43a4c30b68755f6a88aa1c85c2f7d57 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Fri, 8 Aug 2025 01:19:10 +0200 Subject: [PATCH 32/35] bump golang.org/x/net to v0.43.0 for security fixes - Upgraded golang.org/x/net from v0.33.0 to v0.43.0 - Addresses: CVE-2025-22870 and CVE-2025-22872 - No functional changes or breaking updates --- Dockerfile | 2 +- README.md | 19 ++++++++++--------- go.mod | 14 +++++++------- go.sum | 23 +++++++++++++---------- 4 files changed, 31 insertions(+), 27 deletions(-) diff --git a/Dockerfile b/Dockerfile index e28b370..a8bc03b 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,4 @@ -FROM --platform=$BUILDPLATFORM golang:1.23.4-alpine AS builder +FROM --platform=$BUILDPLATFORM golang:1.24.6-alpine AS builder WORKDIR /steamsalty diff --git a/README.md b/README.md index 54840c9..aa69129 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ # SteamSalty + SteamSalty notifies you on telegram about new comments on any steam profile. ## Running with Docker Compose -Docker image: https://hub.docker.com/r/watn3y/steamsalty +Docker image: Example compose file: @@ -30,11 +31,11 @@ Grab a release from the [releases page](https://github.com/watn3y/steamsalty/rel ## Environment Variables -| Variable | Description | Default | -| ----------------------------- | -------------------------------------------------------------------------------------------------------------------- | ------------------ | -| `STEAMSALTY_LOGLEVEL` | LogLevel as described [here](https://pkg.go.dev/github.com/rs/zerolog@v1.33.0#readme-simple-leveled-logging-example) | 1 (Info) | -| `STEAMSALTY_TELEGRAMAPITOKEN` | Telegram Bot Token, get from @BotFather | None, **required** | -| `STEAMSALTY_STEAMAPIKEY` | Steam API Key, get from https://steamcommunity.com/dev/apikey | None, **required** | -| `STEAMSALTY_CHATID` | Chat to notify about new Comments | None, **required** | -| `STEAMSALTY_WATCHERS` | SteamIDs (in SteamID64 format) to check for new Profile Comments | None, **required** | -| `STEAMSALTY_SLEEPINTERVAL` | Amount of time to wait between requests to Steam in seconds | 60 | +| Variable | Description | Default | +| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------| ------------------ | +| `STEAMSALTY_LOGLEVEL` | LogLevel as described [in the zerolog documentation](https://pkg.go.dev/github.com/rs/zerolog@v1.34.0#readme-simple-leveled-logging-example) | 1 (Info) | +| `STEAMSALTY_TELEGRAMAPITOKEN` | Telegram Bot Token, get from @BotFather | None, **required** | +| `STEAMSALTY_STEAMAPIKEY` | Steam API Key, get from [steamcommunity.com/dev/apikey](https://steamcommunity.com/dev/apikey) | None, **required** | +| `STEAMSALTY_CHATID` | Chat to notify about new Comments | None, **required** | +| `STEAMSALTY_WATCHERS` | SteamIDs (in SteamID64 format) to check for new Profile Comments | None, **required** | +| `STEAMSALTY_SLEEPINTERVAL` | Amount of time to wait between requests to Steam in seconds | 60 | diff --git a/go.mod b/go.mod index e6693ba..c067f00 100644 --- a/go.mod +++ b/go.mod @@ -1,19 +1,19 @@ module watn3y/steamsalty -go 1.23.4 +go 1.24.6 require ( github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1 - github.com/PuerkitoBio/goquery v1.10.0 + github.com/PuerkitoBio/goquery v1.10.3 github.com/go-telegram-bot-api/telegram-bot-api/v5 v5.5.1 - github.com/rs/zerolog v1.33.0 - github.com/sethvargo/go-envconfig v1.1.0 + github.com/rs/zerolog v1.34.0 + github.com/sethvargo/go-envconfig v1.3.0 ) require ( github.com/andybalholm/cascadia v1.3.3 // indirect - github.com/mattn/go-colorable v0.1.13 // indirect + github.com/mattn/go-colorable v0.1.14 // indirect github.com/mattn/go-isatty v0.0.20 // indirect - golang.org/x/net v0.33.0 // indirect - golang.org/x/sys v0.28.0 // indirect + golang.org/x/net v0.43.0 // indirect + golang.org/x/sys v0.35.0 // indirect ) diff --git a/go.sum b/go.sum index 696f506..c9b21ee 100644 --- a/go.sum +++ b/go.sum @@ -1,7 +1,7 @@ github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1 h1:PD13eMe9XAgPQ0SYWyirqwyOJG90TlEWApCw8A699l0= github.com/Philipp15b/go-steamapi v0.0.0-20210114153316-ec4fdd23b4c1/go.mod h1:eQR7Xf64m2ALDAQE7Nr9ylFZhav1izvF3zzysKPhb0I= -github.com/PuerkitoBio/goquery v1.10.0 h1:6fiXdLuUvYs2OJSvNRqlNPoBm6YABE226xrbavY5Wv4= -github.com/PuerkitoBio/goquery v1.10.0/go.mod h1:TjZZl68Q3eGHNBA8CWaxAN7rOU1EbDz3CWuolcO5Yu4= +github.com/PuerkitoBio/goquery v1.10.3 h1:pFYcNSqHxBD06Fpj/KsbStFRsgRATgnf3LeXiUkhzPo= +github.com/PuerkitoBio/goquery v1.10.3/go.mod h1:tMUX0zDMHXYlAQk6p35XxQMqMweEKB7iK7iLNd4RH4Y= github.com/andybalholm/cascadia v1.3.3 h1:AG2YHrzJIm4BZ19iwJ/DAua6Btl3IwJX+VI4kktS1LM= github.com/andybalholm/cascadia v1.3.3/go.mod h1:xNd9bqTn98Ln4DwST8/nG+H0yuB8Hmgu1YHNnWw0GeA= github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc= @@ -10,18 +10,19 @@ github.com/go-telegram-bot-api/telegram-bot-api/v5 v5.5.1/go.mod h1:A2S0CWkNylc2 github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= -github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA= github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg= +github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE= +github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8= github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= -github.com/rs/xid v1.5.0/go.mod h1:trrq9SKmegXys3aeAKXMUTdJsYXVwGY3RLcfgqegfbg= -github.com/rs/zerolog v1.33.0 h1:1cU2KZkvPxNyfgEmhHAz/1A9Bz+llsdYzklWFzgp0r8= -github.com/rs/zerolog v1.33.0/go.mod h1:/7mN4D5sKwJLZQ2b/znpjC3/GQWY/xaDXUM0kKWRHss= -github.com/sethvargo/go-envconfig v1.1.0 h1:cWZiJxeTm7AlCvzGXrEXaSTCNgip5oJepekh/BOQuog= -github.com/sethvargo/go-envconfig v1.1.0/go.mod h1:JLd0KFWQYzyENqnEPWWZ49i4vzZo/6nRidxI8YvGiHw= +github.com/rs/xid v1.6.0/go.mod h1:7XoLgs4eV+QndskICGsho+ADou8ySMSjJKDIan90Nz0= +github.com/rs/zerolog v1.34.0 h1:k43nTLIwcTVQAncfCw4KZ2VY6ukYoZaBPNOE8txlOeY= +github.com/rs/zerolog v1.34.0/go.mod h1:bJsvje4Z08ROH4Nhs5iH600c3IkWhwp44iRc54W6wYQ= +github.com/sethvargo/go-envconfig v1.3.0 h1:gJs+Fuv8+f05omTpwWIu6KmuseFAXKrIaOZSh8RMt0U= +github.com/sethvargo/go-envconfig v1.3.0/go.mod h1:JLd0KFWQYzyENqnEPWWZ49i4vzZo/6nRidxI8YvGiHw= github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= @@ -42,8 +43,9 @@ golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk= golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44= golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM= -golang.org/x/net v0.33.0 h1:74SYHlV8BIgHIFC/LrYkOGIwL19eTYXQ5wc6TBuO36I= golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4= +golang.org/x/net v0.43.0 h1:lat02VYK2j4aLzMzecihNvTlJNQUq316m2Mr9rnM6YE= +golang.org/x/net v0.43.0/go.mod h1:vhO1fvI4dGsIjh73sWfUVjj3N7CA9WkKJNQm2svM6Jg= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= @@ -63,8 +65,9 @@ golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= -golang.org/x/sys v0.28.0 h1:Fksou7UEQUWlKvIdsqzJmUmCX3cZuD2+P3XyyzwMhlA= golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.35.0 h1:vz1N37gP5bs89s7He8XuIYXpyY0+QlsKmzipCbUtyxI= +golang.org/x/sys v0.35.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= golang.org/x/telemetry v0.0.0-20240228155512-f48c80bd79b2/go.mod h1:TeRTkGYfJXctD9OcfyVLyj2J3IxLnKwHJR8f4D8a3YE= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= From 99a81a201b58c20c6ab46ace731215e79b480d53 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sun, 31 Aug 2025 03:49:57 +0200 Subject: [PATCH 33/35] feat: Parse environment variables from .env file --- config/config.go | 12 ++++++++++-- go.mod | 1 + go.sum | 2 ++ 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/config/config.go b/config/config.go index 53e9257..dec9dbb 100644 --- a/config/config.go +++ b/config/config.go @@ -5,18 +5,26 @@ import ( "github.com/rs/zerolog" "github.com/rs/zerolog/log" + "github.com/joho/godotenv" envconfig "github.com/sethvargo/go-envconfig" ) var BotConfig config func LoadConfig() { + + if err := godotenv.Load(); err != nil { + log.Info().Err(err).Msg("Failed to load .env file, using the system environment") + } else { + log.Info().Err(err).Msg(".env file loaded successfully") + } + if err := envconfig.Process(context.Background(), &BotConfig); err != nil { - log.Panic().Err(err).Msg("Error parsing config from env variables") + log.Panic().Err(err).Msg("Failed to parse config from env variables") } zerolog.SetGlobalLevel(zerolog.Level(BotConfig.LogLevel)) - log.Info().Msg("Loaded config") + log.Info().Msg("Config loaded successfully") log.Debug().Interface("config", BotConfig).Msg("") } diff --git a/go.mod b/go.mod index c067f00..8502be1 100644 --- a/go.mod +++ b/go.mod @@ -12,6 +12,7 @@ require ( require ( github.com/andybalholm/cascadia v1.3.3 // indirect + github.com/joho/godotenv v1.5.1 // indirect github.com/mattn/go-colorable v0.1.14 // indirect github.com/mattn/go-isatty v0.0.20 // indirect golang.org/x/net v0.43.0 // indirect diff --git a/go.sum b/go.sum index c9b21ee..2fd7de9 100644 --- a/go.sum +++ b/go.sum @@ -10,6 +10,8 @@ github.com/go-telegram-bot-api/telegram-bot-api/v5 v5.5.1/go.mod h1:A2S0CWkNylc2 github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI= github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= +github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0= +github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4= github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg= github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE= github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8= From 38db97bdcf10df7f2dab32812bad9f82c5173e2b Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sun, 31 Aug 2025 03:51:36 +0200 Subject: [PATCH 34/35] refactor: Standardized logging to be more uniform --- bot.go | 6 +++--- botIO/authenticate.go | 4 ++-- botIO/sending.go | 10 +++++----- commands/commands.go | 4 ++-- main.go | 2 +- steam/api.go | 4 ++-- steam/http.go | 18 +++++++++--------- steam/profile.go | 8 ++++---- 8 files changed, 28 insertions(+), 28 deletions(-) diff --git a/bot.go b/bot.go index e2e15b9..c6fe072 100644 --- a/bot.go +++ b/bot.go @@ -18,10 +18,10 @@ func bot() { go steam.StartWatchers(bot) for update := range updates { - log.Debug().Interface("update", update).Msg("Received update") + log.Debug().Interface("update", update).Msg("Update received") if update.Message == nil || update.Message.Text == "" { - log.Debug().Int("UpdateID", update.UpdateID).Msg("Unable to parse update") + log.Debug().Int("UpdateID", update.UpdateID).Msg("Failed to parse update") continue } if update.Message.Time().UTC().Unix() < time.Now().UTC().Unix() { @@ -30,7 +30,7 @@ func bot() { } if update.Message.IsCommand() { - log.Info().Int64("ChatID", update.Message.Chat.ID).Int64("UserID", update.Message.From.ID).Str("Text", update.Message.Text).Msg("Received Command") + log.Info().Int64("ChatID", update.Message.Chat.ID).Int64("UserID", update.Message.From.ID).Str("Text", update.Message.Text).Msg("Command received") commands.Commands(update, bot) } } diff --git a/botIO/authenticate.go b/botIO/authenticate.go index 747f8b6..65ce465 100644 --- a/botIO/authenticate.go +++ b/botIO/authenticate.go @@ -9,7 +9,7 @@ import ( func Authenticate() (tgbotapi.UpdatesChannel, *tgbotapi.BotAPI) { bot, err := tgbotapi.NewBotAPI(config.BotConfig.TelegramAPIToken) if err != nil { - log.Panic().Err(err).Msg("Failed to authenticate") + log.Panic().Err(err).Msg("Failed to authenticate to Telegram") } bot.Debug = false @@ -20,7 +20,7 @@ func Authenticate() (tgbotapi.UpdatesChannel, *tgbotapi.BotAPI) { updates := tgbotapi.NewUpdate(0) updates.Timeout = 60 - log.Info().Int64("ID", bot.Self.ID).Str("username", bot.Self.UserName).Msg("Authenticated to Telegram API") + log.Info().Int64("ID", bot.Self.ID).Str("username", bot.Self.UserName).Msg("Authenticated to Telegram successfully") return bot.GetUpdatesChan(updates), bot diff --git a/botIO/sending.go b/botIO/sending.go index 4576603..297b3e5 100644 --- a/botIO/sending.go +++ b/botIO/sending.go @@ -12,7 +12,7 @@ func SendMessage(message tgbotapi.MessageConfig, bot *tgbotapi.BotAPI) (result t return } - log.Info().Int64("chat", result.Chat.ID).Str("msg", result.Text).Msg("Sent message") + log.Info().Int64("chat", result.Chat.ID).Str("msg", result.Text).Msg("Sent message successfully") log.Debug().Interface("msg", result).Msg("") return result @@ -25,7 +25,7 @@ func EditMessage(message tgbotapi.EditMessageTextConfig, bot *tgbotapi.BotAPI) ( return } - log.Info().Int64("chat", result.Chat.ID).Str("msg", result.Text).Msg("Edited message") + log.Info().Int64("chat", result.Chat.ID).Str("msg", result.Text).Msg("Edited message successfully") log.Debug().Interface("msg", result).Msg("") return result @@ -38,7 +38,7 @@ func SendVideo(message tgbotapi.VideoConfig, bot *tgbotapi.BotAPI) (result tgbot return } - log.Info().Int64("chat", result.Chat.ID).Msg("Sent video") + log.Info().Int64("chat", result.Chat.ID).Msg("Sent video successfully") log.Debug().Interface("video", result).Msg("") return result @@ -51,7 +51,7 @@ func SendPhoto(message tgbotapi.PhotoConfig, bot *tgbotapi.BotAPI) (result tgbot return } - log.Info().Int64("chat", result.Chat.ID).Msg("Sent photo") + log.Info().Int64("chat", result.Chat.ID).Msg("Sent photo successfully") log.Debug().Interface("photo", result).Msg("") return result @@ -64,7 +64,7 @@ func SendSticker(message tgbotapi.StickerConfig, bot *tgbotapi.BotAPI) (result t return } - log.Info().Int64("chat", result.Chat.ID).Msg("Sent sticker") + log.Info().Int64("chat", result.Chat.ID).Msg("Sent sticker successfully") log.Debug().Interface("sticker", result).Msg("") return result diff --git a/commands/commands.go b/commands/commands.go index 2291e6d..7fdcbe6 100644 --- a/commands/commands.go +++ b/commands/commands.go @@ -22,11 +22,11 @@ func SetBotCommands(bot *tgbotapi.BotAPI) { result, err := bot.Request(commands) if err != nil { - log.Error().Err(err).Msg("Failed to set own commands") + log.Error().Err(err).Msg("Failed to publish commands to Telegram") return } - log.Debug().Interface("commands", result).Msg("Set own commands") + log.Debug().Interface("commands", result).Msg("Published commands to Telegram successfully") } func Commands(update tgbotapi.Update, bot *tgbotapi.BotAPI) { diff --git a/main.go b/main.go index fcc9cfb..345adc1 100644 --- a/main.go +++ b/main.go @@ -38,6 +38,6 @@ func configureLogger() { output := zerolog.ConsoleWriter{Out: os.Stdout, TimeFormat: time.DateTime} log.Logger = zerolog.New(output).With().Timestamp().Caller().Logger() - log.Info().Msg("Started Logger") + log.Info().Msg("Logger started successfully") } diff --git a/steam/api.go b/steam/api.go index 9a41911..f73f19b 100644 --- a/steam/api.go +++ b/steam/api.go @@ -11,8 +11,8 @@ func GetPlayerDetails(steamID uint64) (summary steamapi.PlayerSummary) { response, err := steamapi.GetPlayerSummaries([]uint64{steamID}, config.BotConfig.SteamAPIKey) if err != nil { - log.Error().Err(err).Msg("Failed to get Player Summary") + log.Error().Err(err).Msg("Failed to retrive player summary") } - log.Debug().Interface("Player", response[0]).Msg("Got PlayerSummary from Steam API") + log.Debug().Interface("Player", response[0]).Msg("Retrived player summary from SteamAPI successfully") return response[0] } diff --git a/steam/http.go b/steam/http.go index 2c734fa..8fca3d0 100644 --- a/steam/http.go +++ b/steam/http.go @@ -19,7 +19,7 @@ func GetComments(steamID uint64, start int, count int) (page CommentsPage) { url, err := url.Parse(baseURL + strconv.FormatUint(steamID, 10)) if err != nil { - log.Error().Err(err).Msg("Unable to Parse SteamID into URL") + log.Error().Err(err).Msg("Failed to parse SteamID into URL") return } @@ -30,7 +30,7 @@ func GetComments(steamID uint64, start int, count int) (page CommentsPage) { resp, err := http.Get(url.String()) if err != nil || resp.StatusCode != http.StatusOK { - log.Error().Err(err).Int("Response Code", resp.StatusCode).Msg("Failed to get Comments") + log.Error().Err(err).Int("Response Code", resp.StatusCode).Msg("Failed to retrieve comments") } defer resp.Body.Close() @@ -38,16 +38,16 @@ func GetComments(steamID uint64, start int, count int) (page CommentsPage) { // Read the response body body, err := io.ReadAll(resp.Body) if err != nil { - log.Error().Err(err).Msg("Failed to parse Comments") + log.Error().Err(err).Msg("Failed to parse comments") log.Trace().Interface("Body", resp.Body) } err = json.Unmarshal(body, &page) if err != nil { - log.Error().Err(err).Msg("Failed to parse Comments as JSON") + log.Error().Err(err).Msg("Failed to parse comments as JSON") } - log.Trace().Interface("CommentPage", page).Uint64("ProfileID", steamID).Msg("Got Comment Page") + log.Trace().Interface("CommentPage", page).Uint64("ProfileID", steamID).Msg("Retrieved Comment Page successfully") return page } @@ -56,7 +56,7 @@ func parseComments(rawComments CommentsPage) (comments []Comment) { doc, err := goquery.NewDocumentFromReader(strings.NewReader(rawComments.CommentsHTML)) if err != nil { - log.Error().Err(err).Msg("Error while parsing CommentsHTML") + log.Error().Err(err).Msg("Failed to parse CommentsHTML") return } doc.Find(".commentthread_comment.responsive_body_text").Each(func(i int, s *goquery.Selection) { @@ -64,14 +64,14 @@ func parseComments(rawComments CommentsPage) (comments []Comment) { parsedID, err := strconv.ParseUint(strings.TrimPrefix(s.AttrOr("id", ""), "comment_"), 10, 64) if err != nil { - log.Error().Err(err).Msg("Error while parsing Comment ID") + log.Error().Err(err).Msg("Failed to parse Comment ID") return } c.ID = parsedID c.Timestamp, err = strconv.ParseInt(s.Find(".commentthread_comment_timestamp").AttrOr("data-timestamp", ""), 10, 64) if err != nil { - log.Error().Err(err).Msg("Error while parsing Comment Timestamp") + log.Error().Err(err).Msg("Failed to parse Comment Timestamp") return } @@ -85,6 +85,6 @@ func parseComments(rawComments CommentsPage) (comments []Comment) { }) slices.Reverse(comments) - log.Trace().Interface("Comments", comments).Msg("Parsed Comment Page") + log.Trace().Interface("Comments", comments).Msg("Parsed comment page successfully") return comments } diff --git a/steam/profile.go b/steam/profile.go index ec0b1b0..2711cce 100644 --- a/steam/profile.go +++ b/steam/profile.go @@ -33,7 +33,7 @@ func StartWatchers(bot *tgbotapi.BotAPI) { } func watcher(bot *tgbotapi.BotAPI, steamID uint64, sleeptime time.Duration) { - log.Info().Uint64("SteamID", steamID).Msg("Started Watcher") + log.Info().Uint64("SteamID", steamID).Msg("Starting Watcher") var newestProcessedComment int64 = 0 @@ -56,9 +56,9 @@ func watcher(bot *tgbotapi.BotAPI, steamID uint64, sleeptime time.Duration) { profileOwner := GetPlayerDetails(steamID) for _, comment := range parseComments(currentCommentsPage) { - log.Debug().Interface("Comment", comment).Msg("Processing Comment") + log.Debug().Interface("Comment", comment).Msg("Processing comment") if comment.Timestamp <= newestProcessedComment { - log.Debug().Uint64("CommentID", comment.ID).Msg("Skipping Comment") + log.Debug().Uint64("CommentID", comment.ID).Msg("Skipping comment") continue } @@ -69,7 +69,7 @@ func watcher(bot *tgbotapi.BotAPI, steamID uint64, sleeptime time.Duration) { Text: fmt.Sprintf(`%s just commented on %s's profile:`, comment.AuthorProfileURL, comment.Author, profileOwner.ProfileURL, profileOwner.PersonaName) + "\n" + "
" + comment.Text + "
", } - log.Info().Interface("Comment", comment).Msg("Notifying about new Comment") + log.Info().Interface("Comment", comment).Msg("Notifying about new comment") botIO.SendMessage(msg, bot) time.Sleep(time.Minute / 20) } From 17ca2cff1bbd358088c57806a045aaa10b0746e4 Mon Sep 17 00:00:00 2001 From: Noah Theus Date: Sun, 31 Aug 2025 04:12:04 +0200 Subject: [PATCH 35/35] docs: README changes --- README.md | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index aa69129..8a6c28d 100644 --- a/README.md +++ b/README.md @@ -27,15 +27,18 @@ services: ## Running on Linux -Grab a release from the [releases page](https://github.com/watn3y/steamsalty/releases). Make sure to set your **environment variables** accordingly. +Grab a release from the [releases page](https://github.com/watn3y/steamsalty/releases). Make sure to set your [environment variables](#environment-variables) accordingly. ## Environment Variables -| Variable | Description | Default | -| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------| ------------------ | -| `STEAMSALTY_LOGLEVEL` | LogLevel as described [in the zerolog documentation](https://pkg.go.dev/github.com/rs/zerolog@v1.34.0#readme-simple-leveled-logging-example) | 1 (Info) | -| `STEAMSALTY_TELEGRAMAPITOKEN` | Telegram Bot Token, get from @BotFather | None, **required** | -| `STEAMSALTY_STEAMAPIKEY` | Steam API Key, get from [steamcommunity.com/dev/apikey](https://steamcommunity.com/dev/apikey) | None, **required** | -| `STEAMSALTY_CHATID` | Chat to notify about new Comments | None, **required** | -| `STEAMSALTY_WATCHERS` | SteamIDs (in SteamID64 format) to check for new Profile Comments | None, **required** | -| `STEAMSALTY_SLEEPINTERVAL` | Amount of time to wait between requests to Steam in seconds | 60 | +> [!NOTE] +> For development purposes, SteamSalty supports loading environment variables from a .env file placed in the project root directory. + +| Variable | Description | Default | Required | +| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------| ------------------ | -------------- | +| `STEAMSALTY_LOGLEVEL` | LogLevel as described [in the zerolog documentation](https://pkg.go.dev/github.com/rs/zerolog@v1.34.0#readme-simple-leveled-logging-example) | 1 (Info) | ❌ | +| `STEAMSALTY_TELEGRAMAPITOKEN` | Telegram BotToken, get it from [@BotFather on Telegram](https://t.me/BotFather) | None | ✅ | +| `STEAMSALTY_STEAMAPIKEY` | Steam API Key, get it from [steamcommunity.com/dev/apikey](https://steamcommunity.com/dev/apikey) | None | ✅ | +| `STEAMSALTY_CHATID` | Chat to notify about new comments | None | ✅ | +| `STEAMSALTY_WATCHERS` | SteamIDs (in SteamID64 format) to check for new profile comments | None | ✅ | +| `STEAMSALTY_SLEEPINTERVAL` | Amount of time to wait between requests to Steam in seconds | 60 | ❌ |