diff --git a/.dockerignore b/.dockerignore index ffd3c43a..7fd39f73 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,6 +1,10 @@ -node_modules -data +node_modules/ +data/ +*.env .gitignore +.github/ + **Dockerfile** .dockerignore + diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index 25470d5b..a54117c5 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -3,13 +3,17 @@ name: Build and push Docker image (amd64, arm64 to hub.docker.com and ghcr.io) on: workflow_dispatch: # allow manual trigger # https://github.com/orgs/community/discussions/26276 - push: # on every branch, but not for PRs from forks? - paths: + push: + branches: + - "main" + - "v*" + tags: + - "v*" + paths: # ignore changes to certain files - '**' - - '!README.md' - - '!.github/**' - - '.github/workflows/docker.yml' - pull_request: # includes PRs from forks but only triggers on creation, not pushes? + - '!*.md' + # - '!.github/**' + pull_request: # runs when opened/reopned or when the head branch is updated, see https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request branches: - "main" # only PRs against main @@ -25,6 +29,11 @@ jobs: run: | echo "BRANCH=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV echo "NOW=$(date -R)" >> $GITHUB_ENV # date -Iseconds; date +'%Y-%m-%dT%H:%M:%S' + if [[ "${{ env.BRANCH }}" == "main" ]]; then + echo "IMAGE_TAG=latest" >> $GITHUB_ENV + else + echo "IMAGE_TAG=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV + fi - name: Set up QEMU uses: docker/setup-qemu-action@v3 @@ -34,7 +43,7 @@ jobs: - name: Login to Docker Hub uses: docker/login-action@v3 - # if: ${{ secrets.DOCKERHUB_USERNAME && secrets.DOCKERHUB_TOKEN }} + if: github.event_name != 'pull_request' # TODO if DOCKERHUB_* are set? with: username: ${{ secrets.DOCKERHUB_USERNAME }} password: ${{ secrets.DOCKERHUB_TOKEN }} @@ -43,21 +52,23 @@ jobs: uses: docker/login-action@v3 with: registry: ghcr.io - username: ${{ github.repository_owner }} + username: ${{ github.actor }} # actor is user that opened PR, was repository_owner before password: ${{ secrets.GITHUB_TOKEN }} - name: Build and push uses: docker/build-push-action@v5 + # if: github.event_name != 'pull_request' # still want to build image with: context: . - push: true + push: ${{ github.event_name != 'pull_request' }} # TODO push for forks? build-args: | COMMIT=${{ github.sha }} BRANCH=${{ env.BRANCH }} NOW=${{ env.NOW }} platforms: linux/amd64,linux/arm64 # ,linux/arm/v7 + # TODO docker tag only if DOCKERHUB_* are set? tags: | - voglerr/free-games-claimer:latest - ghcr.io/vogler/free-games-claimer:latest + ${{ secrets.DOCKERHUB_USERNAME }}/free-games-claimer:${{env.IMAGE_TAG}} + ghcr.io/${{ github.actor }}/free-games-claimer:${{env.IMAGE_TAG}} cache-from: type=gha cache-to: type=gha,mode=max diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..aaf8218c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,6 @@ +# Contribute + +## Building and publishing docker images +Setup the secrets for DOCKERHUB_USERNAME and [DOCKERHUB_TOKEN](https://hub.docker.com/settings/security) in https://github.com/YOUR_USERNAME/free-games-claimer/settings/secrets/actions to be able to run the docker.yml workflows. + +Check if under Workflow Permissions in https://github.com/YOUR_USERNAME/free-games-claimer/settings/actions the radio button is set to "Read and write permissions". In case that's not set the push to ghcr.io will fail. \ No newline at end of file diff --git a/Dockerfile b/Dockerfile index 7a291b34..a8c5e244 100644 --- a/Dockerfile +++ b/Dockerfile @@ -36,8 +36,8 @@ RUN apt-get update \ libgdk-pixbuf-2.0-0 \ libdbus-glib-1-2 \ libxcursor1 \ - && apt-get autoclean -y \ && apt-get autoremove -y \ + && apt-get clean \ && rm -rf \ /tmp/* \ /usr/share/doc/* \ @@ -64,7 +64,7 @@ RUN npm install COPY . . # Shell scripts need Linux line endings. On Windows, git might be configured to check out dos/CRLF line endings, so we convert them for those people in case they want to build the image. They could also use --config core.autocrlf=input -RUN dos2unix *.sh && chmod +x *.sh +RUN dos2unix ./*.sh && chmod +x ./*.sh COPY docker-entrypoint.sh /usr/local/bin/ ARG COMMIT="" diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..0ad25db4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md index 7cb43932..18cf5208 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ Claims free games periodically on - [Epic Games Store](https://www.epicgames.com/store/free-games) - [Amazon Prime Gaming](https://gaming.amazon.com) - [GOG](https://www.gog.com) -- [Xbox Live Games with Gold](https://www.xbox.com/en-US/live/gold#gameswithgold) - planned - [Unreal Engine (Assets)](https://www.unrealengine.com/marketplace/en-US/assets?count=20&sortBy=effectiveDate&sortDir=DESC&start=0&tag=4910) ([experimental](https://github.com/vogler/free-games-claimer/issues/44), same login as Epic Games) + Pull requests welcome :) @@ -24,6 +24,9 @@ Easy option: [install Docker](https://docs.docker.com/get-docker/) (or [podman]( ``` docker run --rm -it -p 6080:6080 -v fgc:/fgc/data --pull=always ghcr.io/vogler/free-games-claimer ``` + +_This currently gives you a captcha challenge for epic-games. Until [issue #183](https://github.com/vogler/free-games-claimer/issues/183) is fixed, it is recommended to just run `node epic-games` without docker (see below)._ + This will run `node epic-games; node prime-gaming; node gog` - if you only want to claim games for one of the stores, you can override the default command by appending e.g. `node epic-games` at the end of the `docker run` command, or if you want several `bash -c "node epic-games.js; node gog.js"`. Data (including json files with claimed games, codes to redeem, screenshots) is stored in the Docker volume `fgc`. @@ -35,6 +38,7 @@ Data (including json files with claimed games, codes to redeem, screenshots) is 3. Run `npm install` 4. Run `pip install apprise` to install [apprise](https://github.com/caronc/apprise) if you want notifications 5. To get updates: `git pull; npm install` +6. Run `node epic-games`, `node prime-gaming`, `node gog`... During `npm install` Playwright will download its Firefox to a cache in home ([doc](https://playwright.dev/docs/browsers#managing-browser-binaries)). If you are missing some dependencies for the browser on your system, you can use `sudo npx playwright install firefox --with-deps`. @@ -114,6 +118,7 @@ To get the OTP key, it is easiest to follow the store's guide for adding an auth - **Epic Games**: visit [password & security](https://www.epicgames.com/account/password), enable 'third-party authenticator app', copy the 'Manual Entry Key' and use it to set `EG_OTPKEY`. - **Prime Gaming**: visit Amazon 'Your Account › Login & security', 2-step verification › Manage › Add new app › Can't scan the barcode, copy the bold key and use it to set `PG_OTPKEY` - **GOG**: only offers OTP via email + Beware that storing passwords and OTP keys as clear text may be a security risk. Use a unique/generated password! TODO: maybe at least offer to base64 encode for storage. @@ -131,14 +136,18 @@ Claiming the Amazon Games works out-of-the-box, however, for games on external s Keys and URLs are printed to the console, included in notifications and saved in `data/prime-gaming.json`. A screenshot of the page with the key is also saved to `data/screenshots`. [TODO](https://github.com/vogler/free-games-claimer/issues/5): ~~redeem keys on external stores.~~ + + + ### Run periodically #### How often? Epic Games usually has two free games *every week*, before Christmas every day. Prime Gaming has new games *every month* or more often during Prime days. GOG usually has one new game every couples of weeks. Unreal Engine has new assets to claim *every first Tuesday of a month*. + -It is save to run the scripts every day. +It is safe to run the scripts every day. #### How to schedule? The container/scripts will claim currently available games and then exit. diff --git a/config.js b/config.js index e604d0fb..f12f99e1 100644 --- a/config.js +++ b/config.js @@ -5,7 +5,7 @@ dotenv.config({ path: 'data/config.env' }); // loads env vars from file - will n // Options - also see table in README.md export const cfg = { - debug: process.env.PWDEBUG == '1', // runs non-headless and opens https://playwright.dev/docs/inspector + debug: process.env.DEBUG == '1' || process.env.PWDEBUG == '1', // runs non-headless and opens https://playwright.dev/docs/inspector record: process.env.RECORD == '1', // `recordHar` (network) + `recordVideo` time: process.env.TIME == '1', // log duration of each step dryrun: process.env.DRYRUN == '1', // don't claim anything @@ -39,7 +39,10 @@ export const cfg = { gog_password: process.env.GOG_PASSWORD || process.env.PASSWORD, gog_newsletter: process.env.GOG_NEWSLETTER == '1', // do not unsubscribe from newsletter after claiming a game // OTP only via GOG_EMAIL, can't add app... - + // auth xbox + xbox_email: process.env.XBOX_EMAIL || process.env.EMAIL, + xbox_password: process.env.XBOX_PASSWORD || process.env.PASSWORD, + xbox_otpkey: process.env.XBOX_OTPKEY, // experimmental - likely to change pg_redeem: process.env.PG_REDEEM == '1', // prime-gaming: redeem keys on external stores pg_claimdlc: process.env.PG_CLAIMDLC == '1', // prime-gaming: claim in-game content diff --git a/epic-games.js b/epic-games.js index 16984a39..4f70a6eb 100644 --- a/epic-games.js +++ b/epic-games.js @@ -29,7 +29,7 @@ const context = await firefox.launchPersistentContext(cfg.dir.browser, { // userAgent firefox (macOS): Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:106.0) Gecko/20100101 Firefox/106.0 // userAgent firefox (docker): Mozilla/5.0 (X11; Linux aarch64; rv:109.0) Gecko/20100101 Firefox/115.0 locale: "en-US", // ignore OS locale to be sure to have english text for locators - recordVideo: cfg.record ? { dir: path.resolve('data/record/'), size: { width: cfg.width, height: cfg.height } } : undefined, // will record a .webm video for each page navigated; without size, video would be scaled down to fit 800x800 + recordVideo: cfg.record ? { dir: 'data/record/', size: { width: cfg.width, height: cfg.height } } : undefined, // will record a .webm video for each page navigated; without size, video would be scaled down to fit 800x800 recordHar: cfg.record ? { path: `data/record/eg-${datetime()}.har` } : undefined, // will record a HAR file with network requests and responses; can be imported in Chrome devtools handleSIGINT: false, // have to handle ourselves and call context.close(), otherwise recordings from above won't be saved args: [ // https://peter.sh/experiments/chromium-command-line-switches @@ -72,7 +72,7 @@ try { // page.click('button:has-text("Accept All Cookies")').catch(_ => { }); // Not needed anymore since we set the cookie above. Clicking this did not always work since the message was animated in too slowly. - while (await page.locator('a[role="button"]:has-text("Sign In")').count() > 0) { + while (await page.locator('egs-navigation').getAttribute('isloggedin') != 'true') { console.error('Not signed in anymore. Please login in the browser or here in the terminal.'); if (cfg.novnc_port) console.info(`Open http://localhost:${cfg.novnc_port} to login inside the docker container.`); if (!cfg.debug) context.setDefaultTimeout(cfg.login_timeout); // give user some extra time to log in @@ -83,8 +83,9 @@ try { const email = cfg.eg_email || await prompt({message: 'Enter email'}); const password = email && (cfg.eg_password || await prompt({type: 'password', message: 'Enter password'})); if (email && password) { - await page.click('text=Sign in with Epic Games'); + // await page.click('text=Sign in with Epic Games'); await page.fill('#email', email); + await page.click('button[type="submit"]'); await page.fill('#password', password); await page.click('button[type="submit"]'); page.waitForSelector('#h_captcha_challenge_login_prod iframe').then(async () => { @@ -114,7 +115,7 @@ try { await page.waitForURL(URL_CLAIM); if (!cfg.debug) context.setDefaultTimeout(cfg.timeout); } - user = await page.locator('#user span').first().innerHTML(); + user = await page.locator('egs-navigation').getAttribute('displayname'); // 'null' if !isloggedin console.log(`Signed in as ${user}`); db.data[user] ||= {}; if (cfg.time) console.timeEnd('login'); @@ -122,7 +123,13 @@ try { // Detect free games const game_loc = page.locator('a:has(span:text-is("Free Now"))'); - await game_loc.last().waitFor(); + await game_loc.last().waitFor().catch(_ => { + // rarely there are no free games available -> catch Timeout + // TODO would be better to wait for alternative like 'coming soon' instead of waiting for timeout + // see https://github.com/vogler/free-games-claimer/issues/210#issuecomment-1727420943 + console.error('Seems like currently there are no free games available in your region...') + // urls below should then be an empty list + }); // clicking on `game_sel` sometimes led to a 404, see https://github.com/vogler/free-games-claimer/issues/25 // debug showed that in those cases the href was still correct, so we `goto` the urls instead of clicking. // Alternative: parse the json loaded to build the page https://store-site-backend-static-ipv4.ak.epicgames.com/freeGamesPromotions @@ -227,7 +234,7 @@ try { // console.info(' Saved a screenshot of hcaptcha challenge to', p); // console.error(' Got hcaptcha challenge. To avoid it, get a link from https://www.hcaptcha.com/accessibility'); // TODO save this link in config and visit it daily to set accessibility cookie to avoid captcha challenge? }).catch(_ => { }); // may time out if not shown - await page.waitForSelector('text=Thanks for your order!'); + await page.locator('text=Thanks for your order!').waitFor({state: 'attached'}); db.data[user][game_id].status = 'claimed'; db.data[user][game_id].time = datetime(); // claimed time overwrites failed/dryrun time console.log(' Claimed successfully!'); diff --git a/gog.js b/gog.js index be4514d3..aaffd7b6 100644 --- a/gog.js +++ b/gog.js @@ -1,5 +1,4 @@ import { firefox } from 'playwright-firefox'; // stealth plugin needs no outdated playwright-extra -import path from 'path'; import { resolve, jsonDb, datetime, filenamify, prompt, notify, html_game_list, handleSIGINT } from './util.js'; import { cfg } from './config.js'; @@ -16,7 +15,7 @@ const context = await firefox.launchPersistentContext(cfg.dir.browser, { headless: cfg.headless, viewport: { width: cfg.width, height: cfg.height }, locale: "en-US", // ignore OS locale to be sure to have english text for locators -> done via /en in URL - recordVideo: cfg.record ? { dir: path.resolve('data/record/'), size: { width: cfg.width, height: cfg.height } } : undefined, // will record a .webm video for each page navigated; without size, video would be scaled down to fit 800x800 + recordVideo: cfg.record ? { dir: 'data/record/', size: { width: cfg.width, height: cfg.height } } : undefined, // will record a .webm video for each page navigated; without size, video would be scaled down to fit 800x800 recordHar: cfg.record ? { path: `data/record/gog-${datetime()}.har` } : undefined, // will record a HAR file with network requests and responses; can be imported in Chrome devtools handleSIGINT: false, // have to handle ourselves and call context.close(), otherwise recordings from above won't be saved }); diff --git a/jsconfig.json b/jsconfig.json index 1b438cb5..2e21de9f 100644 --- a/jsconfig.json +++ b/jsconfig.json @@ -2,7 +2,7 @@ "compilerOptions": { "checkJs": true, "target": "es2021", - "module": "esnext", + "module": "NodeNext", "moduleResolution": "NodeNext", // https://github.com/typicode/lowdb/issues/554 }, "exclude": ["node_modules", "**/node_modules"] diff --git a/package-lock.json b/package-lock.json index 4f249f1c..b725f4d0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -7,14 +7,14 @@ "": { "name": "free-games-claimer", "version": "1.4.0", - "license": "MIT", + "license": "AGPL-3.0-only", "dependencies": { "cross-env": "^7.0.3", "dotenv": "^16.3.1", "enquirer": "^2.4.1", - "lowdb": "^6.0.1", + "lowdb": "^6.1.1", "otplib": "^12.0.1", - "playwright-firefox": "^1.38.0", + "playwright-firefox": "^1.39.0", "puppeteer-extra-plugin-stealth": "^2.11.2" }, "devDependencies": { @@ -1013,11 +1013,11 @@ "dev": true }, "node_modules/lowdb": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/lowdb/-/lowdb-6.0.1.tgz", - "integrity": "sha512-1ktuKYLlQzAWwl4/PQkIr8JzNXgcTM6rAhpXaQ6BR+VwI98Q8ZwMFhBOn9u0ldcW3K/WWzhYpS3xyGTshgVGzA==", + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/lowdb/-/lowdb-6.1.1.tgz", + "integrity": "sha512-HO13FCxI8SCwfj2JRXOKgXggxnmfSc+l0aJsZ5I34X3pwzG/DPBSKyKu3Zkgg/pNmx854SVgE2la0oUeh6wzNw==", "dependencies": { - "steno": "^3.0.0" + "steno": "^3.1.1" }, "engines": { "node": ">=16" @@ -1184,9 +1184,9 @@ } }, "node_modules/playwright-core": { - "version": "1.38.0", - "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.38.0.tgz", - "integrity": "sha512-f8z1y8J9zvmHoEhKgspmCvOExF2XdcxMW8jNRuX4vkQFrzV4MlZ55iwb5QeyiFQgOFCUolXiRHgpjSEnqvO48g==", + "version": "1.39.0", + "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.39.0.tgz", + "integrity": "sha512-+k4pdZgs1qiM+OUkSjx96YiKsXsmb59evFoqv8SKO067qBA+Z2s/dCzJij/ZhdQcs2zlTAgRKfeiiLm8PQ2qvw==", "bin": { "playwright-core": "cli.js" }, @@ -1195,12 +1195,12 @@ } }, "node_modules/playwright-firefox": { - "version": "1.38.0", - "resolved": "https://registry.npmjs.org/playwright-firefox/-/playwright-firefox-1.38.0.tgz", - "integrity": "sha512-uNXdvj17JHbKir/EmdLtYEHkzI0ttFMX/3+HO/TW5z1hRmN5CydDNINm9xL/0AwvFSa5unZPM7S7+mUa3EiniA==", + "version": "1.39.0", + "resolved": "https://registry.npmjs.org/playwright-firefox/-/playwright-firefox-1.39.0.tgz", + "integrity": "sha512-DFJRVL8mfOPyfiK8on34kYdvFeV0a0aNGRNUTPuHD2sv2+pMITPSosxRCgPvnFO3oWzEwVBVv/+c5E9fICY7gg==", "hasInstallScript": true, "dependencies": { - "playwright-core": "1.38.0" + "playwright-core": "1.39.0" }, "bin": { "playwright": "cli.js" @@ -1458,11 +1458,11 @@ } }, "node_modules/steno": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/steno/-/steno-3.0.0.tgz", - "integrity": "sha512-uZtn7Ht9yXLiYgOsmo8btj4+f7VxyYheMt8g6F1ANjyqByQXEE2Gygjgenp3otHH1TlHsS4JAaRGv5wJ1wvMNw==", + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/steno/-/steno-3.1.1.tgz", + "integrity": "sha512-B7c6EVH7oEiaMRW36SjUnktkDwp/qd4pQiduylyiqvcZEZDeX0IIFZRBZdwO/RaVo60M0wkDwC0e8yeKaR4VGg==", "engines": { - "node": ">=14.16" + "node": ">=16" }, "funding": { "url": "https://github.com/sponsors/typicode" @@ -2332,11 +2332,11 @@ "dev": true }, "lowdb": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/lowdb/-/lowdb-6.0.1.tgz", - "integrity": "sha512-1ktuKYLlQzAWwl4/PQkIr8JzNXgcTM6rAhpXaQ6BR+VwI98Q8ZwMFhBOn9u0ldcW3K/WWzhYpS3xyGTshgVGzA==", + "version": "6.1.1", + "resolved": "https://registry.npmjs.org/lowdb/-/lowdb-6.1.1.tgz", + "integrity": "sha512-HO13FCxI8SCwfj2JRXOKgXggxnmfSc+l0aJsZ5I34X3pwzG/DPBSKyKu3Zkgg/pNmx854SVgE2la0oUeh6wzNw==", "requires": { - "steno": "^3.0.0" + "steno": "^3.1.1" } }, "merge-deep": { @@ -2460,16 +2460,16 @@ "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==" }, "playwright-core": { - "version": "1.38.0", - "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.38.0.tgz", - "integrity": "sha512-f8z1y8J9zvmHoEhKgspmCvOExF2XdcxMW8jNRuX4vkQFrzV4MlZ55iwb5QeyiFQgOFCUolXiRHgpjSEnqvO48g==" + "version": "1.39.0", + "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.39.0.tgz", + "integrity": "sha512-+k4pdZgs1qiM+OUkSjx96YiKsXsmb59evFoqv8SKO067qBA+Z2s/dCzJij/ZhdQcs2zlTAgRKfeiiLm8PQ2qvw==" }, "playwright-firefox": { - "version": "1.38.0", - "resolved": "https://registry.npmjs.org/playwright-firefox/-/playwright-firefox-1.38.0.tgz", - "integrity": "sha512-uNXdvj17JHbKir/EmdLtYEHkzI0ttFMX/3+HO/TW5z1hRmN5CydDNINm9xL/0AwvFSa5unZPM7S7+mUa3EiniA==", + "version": "1.39.0", + "resolved": "https://registry.npmjs.org/playwright-firefox/-/playwright-firefox-1.39.0.tgz", + "integrity": "sha512-DFJRVL8mfOPyfiK8on34kYdvFeV0a0aNGRNUTPuHD2sv2+pMITPSosxRCgPvnFO3oWzEwVBVv/+c5E9fICY7gg==", "requires": { - "playwright-core": "1.38.0" + "playwright-core": "1.39.0" } }, "prelude-ls": { @@ -2601,9 +2601,9 @@ "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==" }, "steno": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/steno/-/steno-3.0.0.tgz", - "integrity": "sha512-uZtn7Ht9yXLiYgOsmo8btj4+f7VxyYheMt8g6F1ANjyqByQXEE2Gygjgenp3otHH1TlHsS4JAaRGv5wJ1wvMNw==" + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/steno/-/steno-3.1.1.tgz", + "integrity": "sha512-B7c6EVH7oEiaMRW36SjUnktkDwp/qd4pQiduylyiqvcZEZDeX0IIFZRBZdwO/RaVo60M0wkDwC0e8yeKaR4VGg==" }, "strip-ansi": { "version": "6.0.1", diff --git a/package.json b/package.json index c10bb1cf..6771ee4a 100644 --- a/package.json +++ b/package.json @@ -13,9 +13,9 @@ "cross-env": "^7.0.3", "dotenv": "^16.3.1", "enquirer": "^2.4.1", - "lowdb": "^6.0.1", + "lowdb": "^6.1.1", "otplib": "^12.0.1", - "playwright-firefox": "^1.38.0", + "playwright-firefox": "^1.39.0", "puppeteer-extra-plugin-stealth": "^2.11.2" }, "repository": { @@ -23,7 +23,7 @@ "url": "https://github.com/vogler/free-games-claimer.git" }, "author": "Ralf Vogler", - "license": "MIT", + "license": "AGPL-3.0-only", "devDependencies": { "eslint": "^8.50.0" } diff --git a/prime-gaming.js b/prime-gaming.js index 8fcfa2b9..5acdb062 100644 --- a/prime-gaming.js +++ b/prime-gaming.js @@ -1,6 +1,5 @@ import { firefox } from 'playwright-firefox'; // stealth plugin needs no outdated playwright-extra import { authenticator } from 'otplib'; -import path from 'path'; import { resolve, jsonDb, datetime, stealth, filenamify, prompt, confirm, notify, html_game_list, handleSIGINT } from './util.js'; import { cfg } from './config.js'; @@ -18,7 +17,7 @@ const context = await firefox.launchPersistentContext(cfg.dir.browser, { headless: cfg.headless, viewport: { width: cfg.width, height: cfg.height }, locale: "en-US", // ignore OS locale to be sure to have english text for locators - recordVideo: cfg.record ? { dir: path.resolve('data/record/'), size: { width: cfg.width, height: cfg.height } } : undefined, // will record a .webm video for each page navigated; without size, video would be scaled down to fit 800x800 + recordVideo: cfg.record ? { dir: 'data/record/', size: { width: cfg.width, height: cfg.height } } : undefined, // will record a .webm video for each page navigated; without size, video would be scaled down to fit 800x800 recordHar: cfg.record ? { path: `data/record/pg-${datetime()}.har` } : undefined, // will record a HAR file with network requests and responses; can be imported in Chrome devtools handleSIGINT: false, // have to handle ourselves and call context.close(), otherwise recordings from above won't be saved }); @@ -137,7 +136,7 @@ try { if (cfg.debug) await page.pause(); if (cfg.dryrun) continue; if (cfg.interactive && !await confirm()) continue; - await Promise.any([page.click('button:has-text("Get game")'), page.click('button:has-text("Claim now")'), page.click('button:has-text("Complete Claim")'), page.waitForSelector('div:has-text("Link game account")')]); // waits for navigation + await Promise.any([page.click('button:has-text("Get game")'), page.click('button:has-text("Claim now")'), page.click('button:has-text("Complete Claim")'), page.waitForSelector('div:has-text("Link game account")'), page.waitForSelector('.thank-you-title:has-text("Success")')]); // waits for navigation // TODO would be simpler than the below, but will block for linked stores without code // const redeem_text = await page.textContent('text=/ code on /'); // FAQ: How do I redeem my code? @@ -162,10 +161,16 @@ try { db.data[user][title] ||= { title, time: datetime(), url, store }; const notify_game = { title, url }; notify_games.push(notify_game); // status is updated below - if (await page.locator('div:has-text("Link game account")').count()) { + if (await page.locator('div:has-text("Link game account")').count() // TODO still needed? epic games store just has 'Link account' as the button text now. + || await page.locator('div:has-text("Link account")').count()) { console.error(' Account linking is required to claim this offer!'); notify_game.status = `failed: need account linking for ${store}`; db.data[user][title].status = 'failed: need account linking'; + // await page.pause(); + // await page.click('[data-a-target="LinkAccountModal"] [data-a-target="LinkAccountButton"]'); + // TODO login for epic games also needed if already logged in + // wait for https://www.epicgames.com/id/authorize?redirect_uri=https%3A%2F%2Fservice.link.amazon.gg... + // await page.click('button[aria-label="Allow"]'); } else { db.data[user][title].status = 'claimed'; // print code if there is one @@ -201,7 +206,7 @@ try { // {"reason":"Invalid or no captcha"} // {"reason":"code_used"} // {"reason":"code_not_found"} - if (reason && reason.includes('captcha')) { + if (reason?.includes('captcha')) { redeem_action = 'redeem (got captcha)'; console.error(' Got captcha; could not redeem!'); } else if (reason == 'code_used') { @@ -212,19 +217,18 @@ try { console.error(' Code was not found!'); } else { // TODO not logged in? need valid unused code to test. redeem_action = 'redeemed?'; - console.log(' Redeemed successfully? Please report your Responses (if new) in https://github.com/vogler/free-games-claimer/issues/5'); + // console.log(' Redeemed successfully? Please report your Responses (if new) in https://github.com/vogler/free-games-claimer/issues/5'); console.debug(` Response 1: ${r1t}`); // then after the click on Redeem there is a POST request which should return {} if claimed successfully const r2 = page2.waitForResponse(r => r.request().method() == 'POST' && r.url().startsWith('https://redeem.gog.com/')); await page2.click('[type="submit"]'); // click Redeem const r2t = await (await r2).text(); - console.debug(` Response 2: ${r2t}`); if (r2t == '{}') { redeem_action = 'redeemed'; console.log(' Redeemed successfully.'); db.data[user][title].status = 'claimed and redeemed'; } else { - redeem_action = 'redeemed?'; + console.debug(` Response 2: ${r2t}`); console.log(' Unknown Response 2 - please report in https://github.com/vogler/free-games-claimer/issues/5'); } } @@ -258,7 +262,7 @@ try { await page2.uncheck('[name=newsletter_sub]'); await page2.click('[type="submit"]'); try { - await page2.waitForResponse(r => r.url().startsWith('https://promo.legacygames.com/promotion-processing/order-management.php')); + // await page2.waitForResponse(r => r.url().startsWith('https://promo.legacygames.com/promotion-processing/order-management.php')); // status code 302 await page2.waitForSelector('h2:has-text("Thanks for redeeming")'); redeem_action = 'redeemed'; db.data[user][title].status = 'claimed and redeemed'; diff --git a/unrealengine.js b/unrealengine.js index f7ee6fae..64b9c554 100644 --- a/unrealengine.js +++ b/unrealengine.js @@ -24,7 +24,7 @@ const context = await firefox.launchPersistentContext(cfg.dir.browser, { userAgent: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/99.0.4844.83 Safari/537.36', // see replace of Headless in util.newStealthContext. TODO Windows UA enough to avoid 'device not supported'? update if browser is updated? // userAgent for firefox: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:106.0) Gecko/20100101 Firefox/106.0 locale: "en-US", // ignore OS locale to be sure to have english text for locators - recordVideo: cfg.record ? { dir: path.resolve('data/record/'), size: { width: cfg.width, height: cfg.height } } : undefined, // will record a .webm video for each page navigated; without size, video would be scaled down to fit 800x800 + recordVideo: cfg.record ? { dir: 'data/record/', size: { width: cfg.width, height: cfg.height } } : undefined, // will record a .webm video for each page navigated; without size, video would be scaled down to fit 800x800 recordHar: cfg.record ? { path: `data/record/ue-${datetime()}.har` } : undefined, // will record a HAR file with network requests and responses; can be imported in Chrome devtools handleSIGINT: false, // have to handle ourselves and call context.close(), otherwise recordings from above won't be saved }); diff --git a/util.js b/util.js index 94cccfdd..5b8bef04 100644 --- a/util.js +++ b/util.js @@ -11,14 +11,8 @@ export const dataDir = s => path.resolve(__dirname, 'data', s); export const resolve = (...a) => a.length && a[0] == '0' ? null : path.resolve(...a); // json database -import { Low } from 'lowdb'; -import { JSONFile } from 'lowdb/node'; -export const jsonDb = async (file, defaultData) => { - const db = new Low(new JSONFile(dataDir(file)), defaultData); - await db.read(); - return db; -}; - +import { JSONPreset } from 'lowdb/node'; +export const jsonDb = (file, defaultData) => JSONPreset(dataDir(file), defaultData); export const delay = ms => new Promise(resolve => setTimeout(resolve, ms)); // date and time as UTC (no timezone offset) in nicely readable and sortable format, e.g., 2022-10-06 12:05:27.313 @@ -33,21 +27,6 @@ export const handleSIGINT = (context = null) => process.on('SIGINT', async () => if (context) await context.close(); // in order to save recordings also on SIGINT, we need to disable Playwright's handleSIGINT and close the context ourselves }); -// stealth with playwright: https://github.com/berstend/puppeteer-extra/issues/454#issuecomment-917437212 -// gets userAgent and then removes "Headless" from it -const newStealthContext = async (browser, contextOptions = {}, debug = false) => { - if (!debug) { // only need to fix userAgent in headless mode - const dummyContext = await browser.newContext(); - const originalUserAgent = await (await dummyContext.newPage()).evaluate(() => navigator.userAgent); - await dummyContext.close(); - // console.log('originalUserAgent:', originalUserAgent); // Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/96.0.4664.110 Safari/537.36 - contextOptions = { - ...contextOptions, - userAgent: originalUserAgent.replace("Headless", ""), // HeadlessChrome -> Chrome, TODO needed? - }; - } -}; - export const stealth = async (context) => { // stealth with playwright: https://github.com/berstend/puppeteer-extra/issues/454#issuecomment-917437212 // https://github.com/berstend/puppeteer-extra/tree/master/packages/puppeteer-extra-plugin-stealth/evasions diff --git a/version.js b/version.js index 7b9ebef5..1df93a1c 100644 --- a/version.js +++ b/version.js @@ -13,7 +13,7 @@ const execp = (cmd) => new Promise((resolve, reject) => { if (error.message.includes('command not found')) { console.info('Install git to check for updates!'); } - return reject(); + return reject(error); } resolve(stdout.trim()); }); diff --git a/xbox.js b/xbox.js new file mode 100644 index 00000000..a2150f1a --- /dev/null +++ b/xbox.js @@ -0,0 +1,254 @@ +import { firefox } from "playwright-firefox"; // stealth plugin needs no outdated playwright-extra +import { authenticator } from "otplib"; +import { + datetime, + handleSIGINT, + html_game_list, + jsonDb, + notify, + prompt, +} from "./util.js"; +import { cfg } from "./config.js"; + +// ### SETUP +const URL_CLAIM = "https://www.xbox.com/en-US/live/gold"; // #gameswithgold"; + +console.log(datetime(), "started checking xbox"); + +const db = await jsonDb("xbox.json"); +db.data ||= {}; + +handleSIGINT(); + +// https://playwright.dev/docs/auth#multi-factor-authentication +const context = await firefox.launchPersistentContext(cfg.dir.browser, { + headless: cfg.headless, + viewport: { width: cfg.width, height: cfg.height }, + locale: "en-US", // ignore OS locale to be sure to have english text for locators -> done via /en in URL +}); + +if (!cfg.debug) context.setDefaultTimeout(cfg.timeout); + +const page = context.pages().length + ? context.pages()[0] + : await context.newPage(); // should always exist + +const notify_games = []; +let user; + +main(); + +async function main() { + try { + await performLogin(); + await getAndSaveUser(); + await redeemFreeGames(); + } catch (error) { + console.error(error); + process.exitCode ||= 1; + if (error.message && process.exitCode != 130) + notify(`xbox failed: ${error.message.split("\n")[0]}`); + } finally { + await db.write(); // write out json db + if (notify_games.filter((g) => g.status != "existed").length) { + // don't notify if all were already claimed + notify(`xbox (${user}):
${html_game_list(notify_games)}`); + } + await context.close(); + } +} + +async function performLogin() { + await page.goto(URL_CLAIM, { waitUntil: "domcontentloaded" }); // default 'load' takes forever + + const signInLocator = page + .getByRole("link", { + name: "Sign in to your account", + }) + .first(); + const usernameLocator = page + .getByRole("button", { + name: "Account manager for", + }) + .first(); + + await Promise.any([signInLocator.waitFor(), usernameLocator.waitFor()]); + + if (await usernameLocator.isVisible()) { + return; // logged in using saved cookie + } else if (await signInLocator.isVisible()) { + console.error("Not signed in anymore."); + await signInLocator.click(); + await signInToXbox(); + } else { + console.error("lost! where am i?"); + } +} + +async function signInToXbox() { + page.waitForLoadState("domcontentloaded"); + if (!cfg.debug) context.setDefaultTimeout(cfg.login_timeout); // give user some extra time to log in + console.info(`Login timeout is ${cfg.login_timeout / 1000} seconds!`); + + // ### FETCH EMAIL/PASS + if (cfg.xbox_email && cfg.xbox_password) + console.info("Using email and password from environment."); + else + console.info( + "Press ESC to skip the prompts if you want to login in the browser (not possible in headless mode)." + ); + const email = cfg.xbox_email || (await prompt({ message: "Enter email" })); + const password = + email && + (cfg.xbox_password || + (await prompt({ + type: "password", + message: "Enter password", + }))); + // ### FILL IN EMAIL/PASS + if (email && password) { + const usernameLocator = page + .getByPlaceholder("Email, phone, or Skype") + .first(); + const passwordLocator = page.getByPlaceholder("Password").first(); + + await Promise.any([ + usernameLocator.waitFor(), + passwordLocator.waitFor(), + ]); + + // username may already be saved from before, if so, skip to filling in password + if (await page.getByPlaceholder("Email, phone, or Skype").isVisible()) { + await usernameLocator.fill(email); + await page.getByRole("button", { name: "Next" }).click(); + } + + await passwordLocator.fill(password); + await page.getByRole("button", { name: "Sign in" }).click(); + + // handle MFA, but don't await it + page.locator('input[name="otc"]') + .waitFor() + .then(async () => { + console.log("Two-Step Verification - Enter security code"); + console.log( + await page + .locator('div[data-bind="text: description"]') + .innerText() + ); + const otp = + (cfg.xbox_otpkey && + authenticator.generate(cfg.xbox_otpkey)) || + (await prompt({ + type: "text", + message: "Enter two-factor sign in code", + validate: (n) => + n.toString().length == 6 || + "The code must be 6 digits!", + })); // can't use type: 'number' since it strips away leading zeros and codes sometimes have them + await page.type('input[name="otc"]', otp.toString()); + await page + .getByLabel("Don't ask me again on this device") + .check(); // Trust this Browser + await page.getByRole("button", { name: "Verify" }).click(); + }) + .catch((_) => {}); + + // Trust this browser, but don't await it + page.getByLabel("Don't show this again") + .waitFor() + .then(async () => { + await page.getByLabel("Don't show this again").check(); + await page.getByRole("button", { name: "Yes" }).click(); + }) + .catch((_) => {}); + } else { + console.log("Waiting for you to login in the browser."); + await notify( + "xbox: no longer signed in and not enough options set for automatic login." + ); + if (cfg.headless) { + console.log( + "Run `SHOW=1 node xbox` to login in the opened browser." + ); + await context.close(); + process.exit(1); + } + } + + // ### VERIFY SIGNED IN + await page.waitForURL(`${URL_CLAIM}**`); + + if (!cfg.debug) context.setDefaultTimeout(cfg.timeout); +} + +async function getAndSaveUser() { + user = await page.locator("#mectrl_currentAccount_primary").innerHTML(); + console.log(`Signed in as '${user}'`); + db.data[user] ||= {}; +} + +async function redeemFreeGames() { + const monthlyGamesLocator = await page.locator(".f-size-large").all(); + + const monthlyGamesPageLinks = await Promise.all( + monthlyGamesLocator.map( + async (el) => await el.locator("a").getAttribute("href") + ) + ); + console.log("Free games:", monthlyGamesPageLinks); + + for (const url of monthlyGamesPageLinks) { + await page.goto(url); + + const title = await page.locator("h1").first().innerText(); + const game_id = page.url().split("/").pop(); + db.data[user][game_id] ||= { title, time: datetime(), url: page.url() }; // this will be set on the initial run only! + console.log("Current free game:", title); + const notify_game = { title, url, status: "failed" }; + notify_games.push(notify_game); // status is updated below + + // SELECTORS + const getBtnLocator = page.getByText("GET", { exact: true }).first(); + const installToLocator = page + .getByText("INSTALL TO", { exact: true }) + .first(); + + await Promise.any([ + getBtnLocator.waitFor(), + installToLocator.waitFor(), + ]); + + if (await installToLocator.isVisible()) { + console.log(" Already in library! Nothing to claim."); + notify_game.status = "existed"; + db.data[user][game_id].status ||= "existed"; // does not overwrite claimed or failed + } else if (await getBtnLocator.isVisible()) { + console.log(" Not in library yet! Click GET."); + await getBtnLocator.click(); + + // wait for popup + await page + .locator('iframe[name="purchase-sdk-hosted-iframe"]') + .waitFor(); + const popupLocator = page.frameLocator( + "[name=purchase-sdk-hosted-iframe]" + ); + + const finalGetBtnLocator = popupLocator.getByText("GET"); + await finalGetBtnLocator.waitFor(); + await finalGetBtnLocator.click(); + + await page.getByText("Thank you for your purchase.").waitFor(); + notify_game.status = "claimed"; + db.data[user][game_id].status = "claimed"; + db.data[user][game_id].time = datetime(); // claimed time overwrites failed/dryrun time + console.log(" Claimed successfully!"); + } + + // notify_game.status = db.data[user][game_id].status; // claimed or failed + + // const p = path.resolve(cfg.dir.screenshots, playstation-plus', `${game_id}.png`); + // if (!existsSync(p)) await page.screenshot({ path: p, fullPage: false }); // fullPage is quite long... + } +}