diff --git a/.github/workflows/beatoraja-ir.yml b/.github/workflows/beatoraja-ir.yml new file mode 100644 index 000000000..255bfcfa6 --- /dev/null +++ b/.github/workflows/beatoraja-ir.yml @@ -0,0 +1,64 @@ +name: Beatoraja IR CI + +on: + push: + branches: + - "main" + paths: + - "java/beatoraja-ir/**" + - ".github/workflows/beatoraja-ir.yml" + + pull_request: + branches: + - "main" + paths: + - "java/beatoraja-ir/**" + - ".github/workflows/beatoraja-ir.yml" + workflow_dispatch: + +permissions: + contents: read + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: read + steps: + - name: Checkout + uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 + with: + persist-credentials: false + + - name: Set up JDK 17 + uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5.2.0 + with: + distribution: temurin + java-version: "17" + + - name: Set up Gradle + uses: gradle/actions/setup-gradle@50e97c2cd7a37755bbfafc9c5b7cafaece252f6e # v6.1.0 + with: + cache-read-only: ${{ github.event_name == 'pull_request' }} + + - name: Build shadow jar + working-directory: java/beatoraja-ir + run: ./gradlew --no-daemon shadowJar + env: + TCHIR_NAME: Bokutachi IR + TCHIR_HOME: https://boku.tachi.ac + TCHIR_BASE_URL: https://boku.tachi.ac + + - name: Stash jar for upload + if: ${{ github.event_name != 'pull_request' && github.ref == 'refs/heads/main' }} + run: | + mkdir -p /tmp/ir-jar + cp java/beatoraja-ir/build/libs/bokutachiIR-*-all.jar /tmp/ir-jar/ + + - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 + if: ${{ github.event_name != 'pull_request' && github.ref == 'refs/heads/main' }} + with: + name: bokutachiIR-jar + path: /tmp/ir-jar/bokutachiIR-*-all.jar + retention-days: 7 + if-no-files-found: error diff --git a/.gitignore b/.gitignore index 9e91a81fb..9418d13c5 100644 --- a/.gitignore +++ b/.gitignore @@ -39,4 +39,8 @@ _SETUP_OK # Local debugging: `just db-schema` (see Justfile-db) db/schema.sql -datasets/ \ No newline at end of file +datasets/ + +# java/beatoraja-ir (Gradle) +java/**/.gradle +java/**/build \ No newline at end of file diff --git a/Justfile b/Justfile index a765fbd09..0773ca8a5 100644 --- a/Justfile +++ b/Justfile @@ -1,5 +1,6 @@ import "Justfile-gen" import "Justfile-apps" +import "Justfile-java" import "Justfile-db" import "Justfile-backup" import "Justfile-misc" diff --git a/Justfile-java b/Justfile-java new file mode 100644 index 000000000..8303bf512 --- /dev/null +++ b/Justfile-java @@ -0,0 +1,6 @@ +_beatoraja-ir-gradle TASK NAME HOME BASE_URL: + cd java/beatoraja-ir && TCHIR_NAME={{ NAME }} TCHIR_HOME={{ HOME }} TCHIR_BASE_URL={{ BASE_URL }} ./gradlew {{ TASK }} + +beatoraja-ir TASK="shadowJar": (_beatoraja-ir-gradle TASK '"Tachi LocalDev IR"' 'https://127.0.0.1:3000' 'http://127.0.0.1:8080') + +beatoraja-ir-bokutachi TASK="shadowJar": (_beatoraja-ir-gradle TASK '"Bokutachi IR"' 'https://boku.tachi.ac' 'https://boku.tachi.ac') diff --git a/README.md b/README.md index 7c24c5c5c..3b3439252 100644 --- a/README.md +++ b/README.md @@ -57,3 +57,5 @@ This is also published to NPM when it hits production. - `docs/`, Which contains Tachi documentation. (MIT) - `typescript/sieglinde/`, Which contains our BMS/PMS analysis functions. (MIT) + +- `java/beatoraja-ir/`, Which is the Tachi Internet Ranking implementation for the LR2oraja variant of beatoraja. (MIT) Formerly `zkldi/tachi-beatoraja-ir`, brought into the monorepo per #1515. diff --git a/java/beatoraja-ir/.gitignore b/java/beatoraja-ir/.gitignore new file mode 100755 index 000000000..acac8fa0c --- /dev/null +++ b/java/beatoraja-ir/.gitignore @@ -0,0 +1,9 @@ +.DS_Store +/build +/target + +*.settings +.classpath +.project +.vscode +.gradle diff --git a/java/beatoraja-ir/LICENSE b/java/beatoraja-ir/LICENSE new file mode 100644 index 000000000..044b9a469 --- /dev/null +++ b/java/beatoraja-ir/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 Team NG + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/java/beatoraja-ir/README.md b/java/beatoraja-ir/README.md new file mode 100644 index 000000000..6b9939083 --- /dev/null +++ b/java/beatoraja-ir/README.md @@ -0,0 +1,27 @@ +# Tachi Beatoraja IR +This is the [Tachi](https://github.com/TNG-dev/Tachi) Internet Ranking implementation for the LR2oraja variant of beatoraja. + +## Downloads + +Check the sidebar. When a new version of this is created, `.jar` files will be compiled for you and available there. + +## Setup + +Follow the instructions on [Bokutachi](https://boku.tachi.ac/import/lr2oraja-ir). + +## Compiling + +- Copy the relevant build of `beatoraja.jar` into `external/beatoraja.jar`. +- Set the TCHIR_HOME, TCHIR_NAME and TCHIR_BASE_URL environment variables to what they need to be. +- Use `./gradlew build`. This will compile it into a single transferable `buildlibs/bokutachiIR-X.X.X-all.jar` +- There is another file in here, called `BokutachiIR-X.X.X.jar`. This is not what you want, so don't use it. + +## Acknowledgements + +The baseline for this implementation was provided by [Seraphin-](https://github.com/Seraphin-). + +## Contribution + +I do not like writing Java. Any contributions to this repository are massively appreciated, as it reduces the amount of time I have to spend writing Java. + +Despite this being a separate language, you should still read the [Tachi Contribution Guide](https://docs.tachi.ac/contributing/). diff --git a/java/beatoraja-ir/build.gradle.kts b/java/beatoraja-ir/build.gradle.kts new file mode 100644 index 000000000..7a8750bde --- /dev/null +++ b/java/beatoraja-ir/build.gradle.kts @@ -0,0 +1,41 @@ +plugins { + id("java") + id("com.gradleup.shadow") version "9.3.1" +} + +java { + sourceCompatibility = JavaVersion.VERSION_17 + targetCompatibility = JavaVersion.VERSION_17 +} + +group = "xyz.zkldi.bokutachiIR" +version = "3.1.2" + +repositories { + mavenCentral() +} + +dependencies { + implementation("com.squareup.okhttp3:mockwebserver:4.9.0") + implementation("com.fasterxml.jackson.core:jackson-databind:2.10.0") + compileOnly(files("external/beatoraja.jar")) +} + +tasks.processResources { + val env = mapOf( + "TCHIR_VERSION" to "v$version", + "TCHIR_NAME" to (providers.environmentVariable("TCHIR_NAME").orNull ?: "Tachi LocalDev IR"), + "TCHIR_HOME" to (providers.environmentVariable("TCHIR_HOME").orNull ?: "https://127.0.0.1:3000"), + "TCHIR_BASE_URL" to (providers.environmentVariable("TCHIR_BASE_URL").orNull ?: "https://127.0.0.1:3000"), + ) + // ensure rerun if env changes + env.forEach { (key, value) -> inputs.property(key, value) } + + filesMatching("tachi.properties") { + expand(env) + } +} + +tasks.shadowJar { + minimize() +} diff --git a/java/beatoraja-ir/external/LICENSE.beatoraja b/java/beatoraja-ir/external/LICENSE.beatoraja new file mode 100644 index 000000000..076c717c9 --- /dev/null +++ b/java/beatoraja-ir/external/LICENSE.beatoraja @@ -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. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see. + +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: + + {project} Copyright (C) {year} {fullname} + 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/java/beatoraja-ir/external/NOTICE.md b/java/beatoraja-ir/external/NOTICE.md new file mode 100644 index 000000000..9f4f38d68 --- /dev/null +++ b/java/beatoraja-ir/external/NOTICE.md @@ -0,0 +1,30 @@ +# external/beatoraja.jar + +This directory vendors `beatoraja.jar` from the **LR2oraja** project so the +Tachi Beatoraja IR can be compiled (and CI can produce shadow jars) without +any out-of-band download. + +- **Upstream**: https://github.com/wcko87/lr2oraja +- **Release**: `build11611350155` ("LR2oraja Build 11611350155 (beatoraja 0.8.8)") +- **Source release artifact**: `LR2oraja.zip` +- **`LR2oraja.zip` SHA-256**: `3cdbe4ecabd7937003fc721cd2eb53af88e52881fc4920480526df6d70b9932b` +- **Original project**: https://github.com/exch-bms2/beatoraja (LR2oraja is a + judge/gauge fork that ships only a replacement `beatoraja.jar`). + +## Licensing + +`beatoraja.jar` is licensed under the **GNU General Public License v3** +(see [`LICENSE.beatoraja`](LICENSE.beatoraja)). It is consumed by +`java/beatoraja-ir/` as a `compileOnly` Gradle dependency (see +[`../build.gradle.kts`](../build.gradle.kts)); the IR shadow jar that we +ship does **not** embed any beatoraja class files. Source for the bundled +binary is available at the upstream repositories above. + +## Bumping + +To update to a newer LR2oraja release: + +1. Pick a release from https://github.com/wcko87/lr2oraja/releases. +2. Download its `LR2oraja.zip`, verify the SHA-256, extract `beatoraja.jar`. +3. Replace `beatoraja.jar` in this folder and update the release tag, + archive SHA-256, and any version notes above. diff --git a/java/beatoraja-ir/external/beatoraja.jar b/java/beatoraja-ir/external/beatoraja.jar new file mode 100644 index 000000000..f9c71109b Binary files /dev/null and b/java/beatoraja-ir/external/beatoraja.jar differ diff --git a/java/beatoraja-ir/gradle/wrapper/gradle-wrapper.jar b/java/beatoraja-ir/gradle/wrapper/gradle-wrapper.jar new file mode 100755 index 000000000..249e5832f Binary files /dev/null and b/java/beatoraja-ir/gradle/wrapper/gradle-wrapper.jar differ diff --git a/java/beatoraja-ir/gradle/wrapper/gradle-wrapper.properties b/java/beatoraja-ir/gradle/wrapper/gradle-wrapper.properties new file mode 100755 index 000000000..5dc98dbcf --- /dev/null +++ b/java/beatoraja-ir/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-9.3.0-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/java/beatoraja-ir/gradlew b/java/beatoraja-ir/gradlew new file mode 100755 index 000000000..1b6c78733 --- /dev/null +++ b/java/beatoraja-ir/gradlew @@ -0,0 +1,234 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/java/beatoraja-ir/gradlew.bat b/java/beatoraja-ir/gradlew.bat new file mode 100755 index 000000000..107acd32c --- /dev/null +++ b/java/beatoraja-ir/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/java/beatoraja-ir/settings.gradle.kts b/java/beatoraja-ir/settings.gradle.kts new file mode 100644 index 000000000..dd00dbd65 --- /dev/null +++ b/java/beatoraja-ir/settings.gradle.kts @@ -0,0 +1 @@ +rootProject.name = "bokutachiIR" diff --git a/java/beatoraja-ir/src/main/java/bms/player/beatoraja/ir/TachiIR.java b/java/beatoraja-ir/src/main/java/bms/player/beatoraja/ir/TachiIR.java new file mode 100755 index 000000000..aa5fb6b5f --- /dev/null +++ b/java/beatoraja-ir/src/main/java/bms/player/beatoraja/ir/TachiIR.java @@ -0,0 +1,509 @@ +package bms.player.beatoraja.ir; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Properties; + +import javax.swing.JDialog; +import javax.swing.JOptionPane; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.ObjectWriter; + +import bms.player.beatoraja.MainController; +import bms.player.beatoraja.ScoreData; +import okhttp3.MediaType; +import okhttp3.OkHttpClient; +import okhttp3.Request; +import okhttp3.RequestBody; +import okhttp3.Response; + +// thank you to Seraphin- for this code. +// I have modified it for my own ends, but the same base is here. + +public class TachiIR implements IRConnection { + + public static final String BEATORAJA_CLIENT_VERSION = MainController.getVersion(); + + // These variables need to be static and have those specific visibilities + // They're read by beatoraja through reflection + public static final String NAME; + public static final String HOME; + public static final String VERSION; + private static final String BASE_URL; + + static { + var properties = new Properties(); + var classLoader = Thread.currentThread().getContextClassLoader(); + try (var inputStream = classLoader.getResourceAsStream("tachi.properties")) { + properties.load(inputStream); + } catch (IOException ex) { + panic(); + } + NAME = properties.getProperty("tachi.ir.name"); + HOME = properties.getProperty("tachi.ir.home"); + VERSION = properties.getProperty("tachi.ir.version"); + BASE_URL = properties.getProperty("tachi.ir.baseUrl"); + } + + enum Importance { + DEBUG, + INFO, + WARNING, + ERROR + } + + private String apiToken = ""; + + class ResponseCreator { + public IRResponse create(final boolean success, final String msg, final T data) { + return new IRResponse() { + public boolean isSucceeded() { + return success; + } + + public String getMessage() { + return msg; + } + + public T getData() { + return data; + } + }; + } + } + + class TachiResponse { + boolean success; + String description; + JsonNode body; + int statusCode; + + TachiResponse(JsonNode actualObj, int code) { + success = actualObj.get("success").asBoolean(); + description = actualObj.get("description").asText(); + body = actualObj.get("body"); + statusCode = code; + } + } + + class FailedTachiResponse { + boolean success; + String description; + + FailedTachiResponse(JsonNode actualObj) { + success = actualObj.get("success").asBoolean(); + description = actualObj.get("description").asText(); + } + } + + /** + * Makes a GET request to BASE_URL + url. + */ + TachiResponse GETRequest(String url) throws Exception { + OkHttpClient client = new OkHttpClient(); + + Request request = new Request.Builder().url(BASE_URL + url).header("User-Agent", "OKHTTP") + .header("X-TachiIR-Version", VERSION).addHeader("Authorization", "Bearer " + apiToken) + .addHeader("Accept", "application/json").build(); + + try (Response response = client.newCall(request).execute()) { + int code = response.code(); + ObjectMapper mapper = new ObjectMapper(); + JsonNode actualObj = mapper.readTree(response.body().string()); + + return new TachiResponse(actualObj, code); + } + } + + /** + * Makes a POST request to BASE_URL + url. Sends the 2nd argument as the request + * body. + */ + TachiResponse POSTRequest(String url, String JSON) throws Exception { + OkHttpClient client = new OkHttpClient(); + // charset=utf-8 is redundant, but is here just incase. + RequestBody body = RequestBody.create(MediaType.get("application/json; charset=utf-8"), JSON); + + Request request = new Request.Builder().url(BASE_URL + url).header("User-Agent", "OKHTTP") + .header("X-TachiIR-Version", VERSION).addHeader("Accept", "application/json") + .addHeader("Authorization", "Bearer " + apiToken).post(body).build(); + + try (Response response = client.newCall(request).execute()) { + int code = response.code(); + ObjectMapper mapper = new ObjectMapper(); + JsonNode actualObj = mapper.readTree(response.body().string()); + + return new TachiResponse(actualObj, code); + } + } + + /** + * Utility wrapper for logging to stdout. + */ + private void log(String message, Importance imp) { + String msg = "[" + NAME + "] (" + VERSION + ") " + message; + System.out.println(msg); + + // COMMENTED OUT: This does not work -- it's impossible to obtain a reference to + // the in game + // message renderer. + // // if worse than debug + // if (imp.compareTo(Importance.DEBUG) > 0) { + // Color colour; + + // if (imp == Importance.ERROR) { + // colour = Color.RED; + // } else if (imp == Importance.WARNING) { + // colour = Color.GOLD; + // } else if (imp == Importance.DEBUG) { + // colour = Color.BLUE; + // } else { + // colour = Color.GRAY; + // } + + // msgRenderer.addMessage(msg, colour, 0); + // } + } + + /** + * Utility wrapper for throwing a generic exception. + */ + private void _throw() throws Exception { + throw new Exception("An internal error has occured."); + } + + /** + * Since we extend/implement a class with the IR, we're not allowed to use the + * "throws exception" function signature modifier. + * + * This is the only way to throw errors, and is generally a horrific idea. Ah + * well. + */ + private static void panic() { + throw new RuntimeException( + "This build of TachiIR is critically broken. Report this, or check the logs above to see if it was your fault."); + } + + public IRResponse register(IRAccount account) { + return null; + } + + private String username; + + /** + * Basically does nothing. Performs some init and status checks for the IR. + * + * Authentication is already handled with API keys, and users are expected to + * place their relevant API key inside `password`. + */ + public IRResponse login(IRAccount account) { + if (BASE_URL.equals("")) { + log("No BASE_URL. This build of TachiIR is likely to be broken. Report this.", Importance.ERROR); + panic(); + } + + Boolean isWindows = System.getProperty("os.name").startsWith("Windows"); + String fixInfo = isWindows ? "You can skip this warning by adding 'set SHUT_UP_TACHI=yes' to your .bat file." + : "You can skip this warning by adding 'export SHUT_UP_TACHI=yes' to your .command file."; + + String jdkVendor = System.getProperty("java.vendor").toLowerCase(); + + if (System.getenv("SHUT_UP_TACHI") == null && + !jdkVendor.contains("liberica")) { + final JDialog dialogThatForcesAlwaysOnTop = new JDialog(); + dialogThatForcesAlwaysOnTop.setAlwaysOnTop(true); + + if (BEATORAJA_CLIENT_VERSION.toLowerCase().startsWith("beatoraja")) { + String msg = "You are playing on beatoraja.\n" + + "PMS (9KEY) scores will submit to the " + NAME + ".\n" + + "BMS (7KEY and 14KEY) scores WILL NOT SUBMIT to the " + NAME + + ", as the only allowed client is lr2oraja.\nIf confused, google 'lr2oraja' for install instructions.\n" + + fixInfo; + + log(msg, Importance.WARNING); + JOptionPane.showMessageDialog(dialogThatForcesAlwaysOnTop, msg, "IR Client Warning", + JOptionPane.WARNING_MESSAGE); + } else if (BEATORAJA_CLIENT_VERSION.toLowerCase().startsWith("lr2oraja")) { + String msg = "You are playing on LR2oraja.\n" + + "BMS (7KEY, 14KEY) scores will submit to the " + NAME + ".\n" + + "PMS (9KEY) scores WILL NOT SUBMIT to the " + NAME + + ", as the only allowed client is beatoraja.\n" + + fixInfo; + + log(msg, Importance.WARNING); + JOptionPane.showMessageDialog(dialogThatForcesAlwaysOnTop, msg, "IR Client Warning", + JOptionPane.WARNING_MESSAGE); + } + } + + ResponseCreator rc = new ResponseCreator(); + + // We grab the apiToken from the users password. Their username doesn't actually + // matter. + // This is for separation of authentication concerns. + apiToken = account.password; + + try { + TachiResponse resp = GETRequest("/api/v1/status?echo=lr2oraja-ir"); + + if (resp.success) { + log("Connected to " + BASE_URL + ".", Importance.DEBUG); + + username = resp.body.get("whoami").asText(); + + TachiResponse userResp = GETRequest("/api/v1/users/" + username); + log("Sending request to /api/v1/users/" + username, Importance.INFO); + + if (userResp.success) { + log("Authenticated as " + userResp.body.get("username").asText() + ".", Importance.INFO); + } else { + log("Failed to find out who you are. Can't login!", Importance.ERROR); + _throw(); + } + } else { + log("An error has occured in logging in. Please make sure that you are putting an API Key in your password field, and not your site login password.", + Importance.ERROR); + _throw(); + } + + return rc.create(resp.success, resp.description, null); + } catch (Exception e) { + System.out.println(e.toString()); + return rc.create(false, "Internal Exception", null); + } + } + + class PlayData { + public IRChartData chart; + public IRScoreData score; + public String client; + + PlayData(IRChartData model, IRScoreData scoreData) { + chart = model; + score = scoreData; + client = MainController.getVersion(); + } + } + + /** + * Submits a score to the IR. This POSTs data out to submit-score. + * + * @warn This basically just serialises IRScoreData. If a beatoraja update + * causes this to collapse in on itself, that sucks. + */ + public IRResponse sendPlayData(IRChartData model, IRScoreData score) { + ResponseCreator rc = new ResponseCreator(); + + PlayData playData = new PlayData(model, score); + + try { + ObjectWriter ow = new ObjectMapper().writer(); + String json = ow.writeValueAsString(playData); + + TachiResponse resp = POSTRequest("/ir/beatoraja/submit-score", json); + + if (resp.statusCode == 202) { + log(resp.description, Importance.INFO); + } else if (resp.statusCode >= 500) { + log(resp.description, Importance.ERROR); + } else if (resp.statusCode >= 400) { + log(resp.description, Importance.WARNING); + } + + return rc.create(resp.success, resp.description, null); + } catch (Exception e) { + System.out.println(e.toString()); + return rc.create(false, "Internal Exception", null); + } + } + + class CourseData { + public IRCourseData course; + public IRScoreData score; + + CourseData(IRCourseData crs, IRScoreData scr) { + score = scr; + course = crs; + } + } + + /** + * Sends course play info to the server via submit-course. + */ + public IRResponse sendCoursePlayData(IRCourseData course, IRScoreData score) { + ResponseCreator rc = new ResponseCreator(); + + CourseData courseData = new CourseData(course, score); + + try { + ObjectWriter ow = new ObjectMapper().writer(); + String json = ow.writeValueAsString(courseData); + + TachiResponse resp = POSTRequest("/ir/beatoraja/submit-course", json); + + if (resp.statusCode >= 500) { + log(resp.description, Importance.ERROR); + } else if (resp.statusCode >= 400) { + log(resp.description, Importance.WARNING); + } + + return rc.create(resp.success, resp.description, null); + } catch (Exception e) { + System.out.println(e.toString()); + return rc.create(false, "Internal Exception", null); + } + } + + /** + * Retrieves other scores on this chart. + * + * @warn Beatoraja MANDATES that every single record on this chart is returned. + * If Tachi ever blows up to LR2IR scale, this function will obliterate + * both the IR and itself, and aggressive caching will have to be invoked. + * This is a future problem, though. + */ + public IRResponse getPlayData(IRPlayerData irpd, IRChartData model) { + ResponseCreator rc = new ResponseCreator(); + + try { + TachiResponse resp = GETRequest("/ir/beatoraja/charts/" + model.sha256 + "/scores"); + + if (!resp.success) { + return rc.create(false, "No chart data.", null); + } + + ArrayList irScoreDatum = new ArrayList(); + + for (final JsonNode objNode : resp.body) { + ScoreData scoreData = new ScoreData(); + + // Yeah, this is just java. + scoreData.setDate(Long.valueOf(objNode.get("date").asInt())); + scoreData.setPlayer(objNode.get("player").asText()); + scoreData.setSha256(objNode.get("sha256").asText()); + scoreData.setGauge(objNode.get("gauge").asInt()); + scoreData.setEpg(objNode.get("epg").asInt()); + scoreData.setLpg(objNode.get("lpg").asInt()); + scoreData.setEgr(objNode.get("egr").asInt()); + scoreData.setLgr(objNode.get("lgr").asInt()); + scoreData.setEgd(objNode.get("egd").asInt()); + scoreData.setLgd(objNode.get("lgd").asInt()); + scoreData.setEbd(objNode.get("ebd").asInt()); + scoreData.setLbd(objNode.get("lbd").asInt()); + scoreData.setEpr(objNode.get("epr").asInt()); + scoreData.setLpr(objNode.get("lpr").asInt()); + scoreData.setEms(objNode.get("ems").asInt()); + scoreData.setLms(objNode.get("lms").asInt()); + scoreData.setNotes(objNode.get("notes").asInt()); + scoreData.setPassnotes(objNode.get("passnotes").asInt()); + scoreData.setClear(objNode.get("clear").asInt()); + scoreData.setPlaycount(objNode.get("playcount").asInt()); + scoreData.setRandom(objNode.get("random").asInt()); + scoreData.setMinbp(objNode.get("minbp").asInt()); + scoreData.setCombo(objNode.get("maxcombo").asInt()); + scoreData.setMode(0); + + IRScoreData irsc = new IRScoreData(scoreData); + + irScoreDatum.add(irsc); + } + + // weird java oddities: [0] instantiates a list faster than prealloc + IRScoreData[] irScoreArr = irScoreDatum.toArray(new IRScoreData[0]); + + // Beatoraja expects these to be sorted. + Arrays.sort(irScoreArr, (a, b) -> b.getExscore() - a.getExscore()); + + return rc.create(resp.success, resp.description, irScoreArr); + } catch (Exception e) { + log("An error has occured while fetching scores for " + model.title + " (" + model.sha256 + ")", + Importance.ERROR); + e.printStackTrace(System.out); + return rc.create(false, "Internal Exception", null); + } + } + + public IRResponse getRivals() { + // Apparently too much strain on the backend for this to work as intended + ResponseCreator rc = new ResponseCreator(); + return rc.create(false, "Unimplemented.", new IRPlayerData[0]); + } + + public IRResponse getTableDatas() { + // Not entirely sure what this method is for. No todo here.* + ResponseCreator rc = new ResponseCreator(); + return rc.create(false, "Unimplemented.", new IRTableData[0]); + } + + public IRResponse getCoursePlayData(IRPlayerData irpd, IRCourseData course) { + // This will never be possible in Tachi. + ResponseCreator rc = new ResponseCreator(); + return rc.create(false, "Unimplemented.", new IRScoreData[0]); + } + + class ChartResolveRequest { + public String matchType; + public String identifier; + + ChartResolveRequest(String matchType, String identifier) { + this.matchType = matchType; + this.identifier = identifier; + } + } + + public String getSongURL(IRChartData chart) { + String game; + String playtype; + + switch (chart.mode) { + case BEAT_7K: + game = "bms"; + playtype = "7K"; + break; + case BEAT_14K: + game = "bms"; + playtype = "14K"; + break; + case POPN_9K: + // There's no match type for getting a PMS chart from + // its sha256, unfortunately. + return null; + default: + return null; + } + + try { + ObjectWriter ow = new ObjectMapper().writer(); + String json = ow.writeValueAsString(new ChartResolveRequest("bmsChartHash", chart.sha256)); + + TachiResponse resp = POSTRequest("/api/v1/games/" + game + "/" + playtype + "/charts/resolve", json); + + if (!resp.success) { + return null; + } + + int songID = resp.body.get("song").get("id").asInt(); + String difficulty = resp.body.get("chart").get("difficulty").asText(); + + return BASE_URL + "/games/" + game + "/" + playtype + "/songs/" + songID + "/" + difficulty; + } catch (Exception e) { + log(e.toString(), Importance.ERROR); + } + + return null; + } + + public String getCourseURL(IRCourseData course) { + return null; + } + + public String getPlayerURL(IRPlayerData irpd) { + // @warn It's not possible for us to infer what context of + // playtype this user was referred from. This will have + // to do. + return BASE_URL + "/users/" + irpd.name + "/games/bms-7k"; + } +} diff --git a/java/beatoraja-ir/src/main/resources/tachi.properties b/java/beatoraja-ir/src/main/resources/tachi.properties new file mode 100644 index 000000000..e888521f3 --- /dev/null +++ b/java/beatoraja-ir/src/main/resources/tachi.properties @@ -0,0 +1,4 @@ +tachi.ir.name=${TCHIR_NAME} +tachi.ir.home=${TCHIR_HOME} +tachi.ir.version=${TCHIR_VERSION} +tachi.ir.baseUrl=${TCHIR_BASE_URL}