commit 66305a6c4d5b23bd4d7bfb9e92c9513a17da170f Author: Jeroen De Meerleer Date: Thu Jan 12 18:58:13 2023 +0100 Initial commit This commit: - Creates the repository - Forks libpairtwo - Removes the unrelated files - Moves the namespaces to a new namespace - Uses native 8.1 enums instead of a thirdparty-library diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..e9a9bff --- /dev/null +++ b/.editorconfig @@ -0,0 +1,13 @@ +# editorconfig.org +root = true + +[*] +indent_style = space +indent_size = 4 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.md] +trim_trailing_whitespace = false diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..491f666 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/vendor/ +.idea/ diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..0531e17 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,62 @@ +# CHANGELOG + +## v2.0 (Release: aa-bbb-cccc) +* NEW FEATURE: `Game::Board` for getting the board number of the game +* MAJOR CHANGE: Getter and setter methods have been removed. (Please see [0d8a325](https://github.com/JeroenED/libpairtwo/commit/0d8a325eb501b775830f68fa6f600f9f4ca5588c) for more info) +* MAJOR CHANGE: Changed license to AGPL-3.0 +* CHANGE: Some fields has been renamed to match coding guideline (Please see [1ab96fa](https://github.com/JeroenED/libpairtwo/commit/1ab96fa04782c1b0f2b6bb9d1bac8397a74ab38e) for more info) +* CHANGE: Logo has been redesigned +* CHANGE: Phpdoc is used again for docs generation +* CHANGE: `Tiebreak::American` and all its uses were removed (Please see [a6015ae](https://github.com/JeroenED/libpairtwo/commit/a6015ae8169f0973f4937605d0f807aacc233630) for more info) +* CHANGE: `Tournament::calculateSonneborn()` did not use a virtual opponent for bye results +* BUGFIX: `Tournament::calculateMutualResult()` returned a value even it not all players did not play each other + +## v1.2 (Release: 28-sep-2019) +* NEW READER: `Readers\Swar-4` for reading out files created with SWAR version 4. +* NEW FEATURE: `Tournament::getArbiters()` for multiple arbiters in 1 tournament +* ENHANCEMENT: `Class::getBinaryData()` methods return null if field is non-existent +* ENHANCEMENT: The template in distributions provides a more usable starting implementation +* ENHANCEMENT: The template in distributions is renamed to template.php +* CHANGE: `Tournament::getArbiter()` accepts a `int` parameter representing the order of the arbiters +* BUGFIX: `Player:getId()` returned elo instead of id +* BUGFIX: `Tournament::calculateBuchholz()` did not return the correct score when player had unplayed rounds +* BUGFIX: `Tournament::calculateMutualResult()` returned NULL if result was invalid +* BUGFIX: `Tournament::calculateBaumbach()` treated bye as won +* BUGFIX: `Tournament::calculateAverageRating()` returned NaN if no games were played +* BUGFIX: Distributions could be created from a branch other than master + +## v1.1.2 (Release: 21-jun-2019) +* ENHANCEMENT: Added update section to dist/readme.md +* MAJOR BUGFIX: `Game::GetResult` threw fatal error `Cannot access parent:: when current class scope has no parent` + +## v1.1.1 (Released: 20-jun-2019) +* NEW FEATURE: Added clean-dist and clean-dev targets +* ENHANCEMENT: Better Docs generation +* ENHANCEMENT: Resized logo in Doxygen for better fit +* ENHANCEMENT: Doxygen takes branch name or version tag as `PROJECT_NUMBER` +* CHANGE: Version tag directly put in distribution filename +* CHANGE: `Tournament::GameExists()` renamed to `Tournament::gameExists()` +* CHANGE: Updated composer metadata +* CHANGE: Some setters changed to fluent setters. (More info: [7aca350](https://github.com/JeroenED/libpairtwo/commit/7aca35057c10d2b982f93a698499c0c01df2fdc5)) +* CHANGE: Kashdan and Soccer Kashdan are combined in 1 function +* BUGFIX: Tagging did not work + +## v1.1 (Released: 20-jun-2019) +* NEW FEATURE: Libpairtwo distribution releases (use these if you don't have knowledge of composer or dependency management) +* NEW FEATURE: Soccer Kashdan (aka: kashdan using 3-1-0 scoring) +* MAJOR CHANGE: Model Classes has been removed +* CHANGE: Deprecated `sws::class` was removed +* CHANGE: Added a logo to the project +* CHANGE: Replaced PhpDoc with Doxygen +* BUGFIX: `Tournament::getParticipants()` did not return a correct value + +## v1.0.2 (Released: 05-jun-2019) +* NEW FEATURE: `Player::getPlayedGames()` to return the number of played games +* BUGFIX: `Tournament::calculateBuchholz()` always returned 0 +* BUGFIX: `Tournament::calculateMutualResult()` only took account of last tiebreak instead all previous + +## v1.0.1 (Released: 04-jun-2019) +* BUGFIX: `Round::getBye()` did not return bye players + +## v1.0 (Released: 03-jun-2019) +* Initial release diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..4ef32f0 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,651 @@ +GNU Affero General Public License +================================= + +_Version 3, 19 November 2007_ +_Copyright © 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 new file mode 100644 index 0000000..ac51d64 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Blackbird Chess (Import service) +## Part of Blackbird Chess +Copyright (C) 2018-2022 Jeroen De Meerleer +Copyright (C) 2023- Blackbird Chess Contributors + +*Forked from [Libpairtwo](https://www.github.com/JeroenED/libpairtwo)* + +This service provides the necessary code to import tournament files created in other tournament management programs + +## Licence + +``` +Copyright (C) 2018- Jeroen De Meerleer +Copyright (C) 2023- Blackbird Chess Contributors + +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 . +``` diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..79598a0 --- /dev/null +++ b/composer.json @@ -0,0 +1,36 @@ +{ + "name": "blakcbirdchess/blackbirdchess-service-import", + "type": "library", + "description": "Service to import other apps files into blackbird chess", + "keywords": [ + "chess", + "pairing", + "blackbirdchess" + ], + "license": "AGPL-3.0-or-later", + "authors": [ + { + "name": "Jeroen De Meerleer", + "email": "schaak@jeroened.be", + "homepage": "https://www.jeroened.be", + "role": "Developer" + } + ], + "require": { + "php": "^8.1", + "ext-iconv": "*" + }, + "require-dev": { + }, + "autoload": { + "psr-4": { + "Blackbirdchess\\Service\\Import\\": "src/" + } + }, + "config": { + "platform": { + "php": "7.1" + }, + "sort-packages": true + } +} diff --git a/src/.gitkeep b/src/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/src/Exceptions/IncompatibleReaderException.php b/src/Exceptions/IncompatibleReaderException.php new file mode 100644 index 0000000..9cd7d2b --- /dev/null +++ b/src/Exceptions/IncompatibleReaderException.php @@ -0,0 +1,30 @@ + + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ + +namespace Blackbirdchess\Service\Import\Exceptions; + +use Blackbirdchess\Service\Results\Exceptions\LibpairtwoException; + +/** + * Exception IncompatibleReaderException + * + * Exception to be raised when a reader is used that is incompatible + * + * @author Jeroen De Meerleer + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ +class IncompatibleReaderException extends LibpairtwoException +{ +} diff --git a/src/IOFactory.php b/src/IOFactory.php new file mode 100644 index 0000000..c074dc8 --- /dev/null +++ b/src/IOFactory.php @@ -0,0 +1,64 @@ + + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ + +namespace Blackbirdchess\Service\Import; + +use Blackbirdchess\Service\Results\Exceptions\LibpairtwoException; +use Blackbirdchess\Service\Results\Interfaces\ReaderInterface; + +/** + * Class IOFactory + * + * Class for creating readers for pairing files + * + * @author Jeroen De Meerleer + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ +abstract class IOFactory +{ + /** + * Compatible readers + * + * @var array + */ + private static $Readers = [ + 'Swar-4' => Blackbirdchess\Service\Import\Readers\Swar4::class, + 'Swar-5' => Blackbirdchess\Service\Import\Readers\Swar5::class, + 'Pairtwo-6' => Blackbirdchess\Service\Import\Readers\Pairtwo6::class, + 'Pairtwo-5' => Blackbirdchess\Service\Import\Readers\Pairtwo6::class // File structure identical + ]; + + /** + * Creates a reader for $type + * + * Compatible types are Swar-4, Pairtwo-5, Pairtwo-6 + * + * @param string $type + * + * @return ReaderInterface + * @throws LibpairtwoException + */ + public static function createReader(string $type): ReaderInterface + { + if (!isset(self::$Readers[ $type ])) { + throw new LibpairtwoException("Cannot read type $type"); + } + + // create reader class + $readerClass = self::$Readers[ $type ]; + + return new $readerClass(); + } +} diff --git a/src/Interfaces/ReaderInterface.php b/src/Interfaces/ReaderInterface.php new file mode 100644 index 0000000..91f88a0 --- /dev/null +++ b/src/Interfaces/ReaderInterface.php @@ -0,0 +1,36 @@ + + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ + +namespace Blackbirdchess\Service\Import\Interfaces; + +/** + * Interface ReaderInterface + * + * Sets the methods a reader needs to implement + * + * @author Jeroen De Meerleer + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ +interface ReaderInterface +{ + /** + * Reads out $filename + * + * @param $filename + * + * @return void + */ + public function read(string $filename): void; +} diff --git a/src/Readers/Pairtwo6.php b/src/Readers/Pairtwo6.php new file mode 100644 index 0000000..3cd90c7 --- /dev/null +++ b/src/Readers/Pairtwo6.php @@ -0,0 +1,876 @@ + + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ + +namespace Blackbirdchess\Service\Import\Readers; + +use DateTime; +use InvalidArgumentException; +use Blackbirdchess\Service\Results\Enums\Color; +use Blackbirdchess\Service\Results\Enums\Gender; +use Blackbirdchess\Service\Results\Enums\Result; +use Blackbirdchess\Service\Results\Enums\Tiebreak; +use Blackbirdchess\Service\Results\Enums\Title; +use Blackbirdchess\Service\Results\Enums\TournamentSystem; +use Blackbirdchess\Service\Results\Exceptions\IncompatibleReaderException; +use Blackbirdchess\Service\Results\Interfaces\ReaderInterface; +use Blackbirdchess\Service\Results\Pairing; +use Blackbirdchess\Service\Results\Player; +use Blackbirdchess\Service\Results\Round; +use Blackbirdchess\Service\Results\Tournament; + +/** + * Reader Pairtwo6 + * + * Reads out Pairtwo-6 files + * + * @author Jeroen De Meerleer + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ +class Pairtwo6 implements ReaderInterface +{ + public const COMPATIBLE_VERSIONS = ['6.', '5.']; + + public const PT_DAYFACTOR = 32; + + public const PT_MONTHFACTOR = 16; + + public const PT_PASTOFFSET = 117; + + public const PT_YEARFACTOR = 512; + + /** + * Binary data that was read out of the pairing file + * + * @var bool|DateTime|int|string[] + */ + private $BinaryData; + + /** + * Version of Pairtwo this file was created with + * + * @var string + */ + public $Release; + + /** + * The tournament + * + * @var Tournament + */ + public $Tournament; + + /** + * Returns binary data that was read out the pairtwo file but was not needed immediately + * + * @param string $key + * + * @return bool|DateTime|int|string|null + */ + public function __get(string $key) + { + if (isset($this->BinaryData[ $key ])) { + return $this->BinaryData[ $key ]; + } + + return null; + } + + /** + * Sets binary data that is read out the pairtwo file but is not needed immediately + * + * @param string $key + * @param bool|int|DateTime|string $value + */ + public function __set(string $key, $value): void + { + $this->BinaryData[ $key ] = $value; + } + + /** + * Adds the first tiebreak to the tournament + */ + private function addTiebreaks(): void + { + switch ($this->Tournament->System) { + case TournamentSystem::KEIZER: + $firstElement = Tiebreak::KEIZER; + break; + case TournamentSystem::AMERICAN: + case TournamentSystem::CLOSED: + case TournamentSystem::SWISS: + $firstElement = Tiebreak::POINTS; + break; + } + $tiebreaks = $this->Tournament->Tiebreaks; + array_unshift($tiebreaks, $firstElement); + $this->Tournament->Tiebreaks = $tiebreaks; + } + + /** + * Converts integer value to a date representation + * + * @param int $date + * + * @return bool|DateTime + */ + private function convertUIntToTimestamp(int $date) + { + $curyear = date('Y'); + $yearoffset = $curyear - self::PT_PASTOFFSET; + + // Day + $day = $date % self::PT_DAYFACTOR; + if ($day < 1) { + $day = 1; + } + + // Month + $month = ($date / self::PT_DAYFACTOR) % self::PT_MONTHFACTOR; + if ($month < 1) { + $month = 1; + } + + // Year + $year = ($date / self::PT_YEARFACTOR) + $yearoffset; + + $concat = $month . '/' . $day . '/' . intval($year); + $format = 'm/d/Y'; + + return DateTime::createFromFormat($format, $concat); + } + + /** + * Actually reads the Swar-File + * + * @param string $filename + * + * @throws IncompatibleReaderException + */ + public function read(string $filename): void + { + $swshandle = fopen($filename, 'rb'); + $swscontents = fread($swshandle, filesize($filename)); + fclose($swshandle); + + $offset = 0; + + $length = 4; + $this->Release = $this->readData('String', substr($swscontents, $offset, $length)); + $offset += $length; + + if (array_search(substr($this->Release, 0, 2), self::COMPATIBLE_VERSIONS) === false) { + throw new IncompatibleReaderException("This file was not created with Pairtwo 5 or higher"); + } + + $this->Tournament = new Tournament(); + $this->Tournament->PriorityElo = 'Nation'; + $this->Tournament->PriorityId = 'Nation'; + // UserCountry + $length = 4; + $this->UserCountry = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // SavedOffset + $length = 4; + $this->SavedOffset = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // NewPlayer + $length = 4; + $this->NewPlayer = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // AmericanHandicap + $length = 4; + $this->AmericanHandicap = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // LowOrder + $length = 4; + $this->LowOrder = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // PairingMethod + $length = 4; + $this->PairingMethod = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // AmericanPresence + $length = 4; + $this->AmericanPresence = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // CheckSameClub + $length = 4; + $this->CheckSameClub = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // NoColorCheck + $length = 4; + $this->NoColorCheck = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // SeparateCategories + $length = 4; + $this->SeparateCategories = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // EloUsed + $length = 4; + $this->EloUsed = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // AlternateColors + $length = 4; + $this->AlternateColors = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // MaxMeetings + $length = 4; + $this->MaxMeetings = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // MaxDistance + $length = 4; + $this->MaxDistance = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // MinimizeKeizer + $length = 4; + $this->MinimizeKeizer = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // MinRoundsMeetings + $length = 4; + $this->MinRoundsMeetings = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // MaxRoundsAbsent + $length = 4; + $this->MaxRoundsAbsent = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // SpecialPoints + $length = 4 * 6; + $this->SpecialPoints = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // NewNamePos + $length = 4; + $this->NewNamePos = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // CurrentRound + $length = 4; + $this->CurrentRound = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // CreatedRounds + $length = 4; + $this->CreatedRounds = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // CreatedPlayers + $length = 4; + $this->CreatedPlayers = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // MaxSelection + $length = 4; + $this->MaxSelection = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // NumberOfRounds + $length = 4; + $this->NumberOfRounds = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // NumberOfPairings + $length = 4; + $this->NumberOfPairings = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // CreatedPairings + $length = 4; + $this->CreatedPairings = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // PairingElems + $length = 4; + $this->PairingElems = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // RandomSeed + $length = 4; + $this->RandomSeed = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // TieOrder + for ($i = 0; $i < 5; $i++) { + $length = 4; + switch ($this->readData('Int', substr($swscontents, $offset, $length))) { + case 1: + $tiebreak = Tiebreak::BUCHHOLZ; + break; + case 2: + $tiebreak = Tiebreak::BUCHHOLZ_MED; + break; + case 3: + $tiebreak = Tiebreak::BUCHHOLZ_CUT; + break; + case 4: + $tiebreak = Tiebreak::SONNEBORN; + break; + case 5: + $tiebreak = Tiebreak::KASHDAN; + break; + case 6: + $tiebreak = Tiebreak::CUMULATIVE; + break; + case 7: + $tiebreak = Tiebreak::BETWEEN; + break; + case 8: + $tiebreak = Tiebreak::KOYA; + break; + case 9: + $tiebreak = Tiebreak::BAUMBACH; + break; + case 10: + $tiebreak = Tiebreak::PERFORMANCE; + break; + case 11: + $tiebreak = Tiebreak::ARO; + break; + case 12: + $tiebreak = Tiebreak::AROCUT; + break; + case 13: + $tiebreak = Tiebreak::BLACK_PLAYED; + break; + case 14: + $tiebreak = Tiebreak::TESTMATCH; + break; + case 15: + $tiebreak = Tiebreak::DRAWING_OF_LOT; + break; + case 0: + default: + $tiebreak = Tiebreak::NONE; + break; + } + $this->Tournament->addTieBreak($tiebreak); + $offset += $length; + } + + // Categorie + for ($i = 0; $i < 10; $i++) { + $length = 4; + $category = $this->readData('Int', substr($swscontents, $offset, $length)); + if ($category != 0) { + $this->Tournament->addCategory('+' . $category); + } + $offset += $length; + } + + // ExtraPoints + $length = 4 * 20; + $this->ExtraPoints = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // SelectP + $length = 4 * 20; + $this->SelectP = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // Players + for ($i = 0; $i < $this->NewPlayer; $i++) { + $player = new Player(); + + // Rank (Unused value) + $length = 4; + $player->Rank = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + $length = 4; + $player->NamePos = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + $length = 4; + $player->setId('Fide', $this->readData('Int', substr($swscontents, $offset, $length))); + $offset += $length; + + $length = 4; + $player->ExtraPts = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + $length = 4; + $player->setElo('Nation', $this->readData('Int', substr($swscontents, $offset, $length))); + $offset += $length; + + $length = 4; + $player->DateOfBirth = $this->readData('Date', substr($swscontents, $offset, $length)); + $offset += $length; + + $length = 4; + $player->setId('Nation', $this->readData('Int', substr($swscontents, $offset, $length))); + $offset += $length; + + $length = 4; + $player->Points = $this->readData('Int', substr($swscontents, $offset, $length)) / 2; + $offset += $length; + + $length = 4; + $player->setId('Club', $this->readData('Int', substr($swscontents, $offset, $length))); + $offset += $length; + + $length = 4; + $player->ScoreBuchholz = $this->readData('Int', substr($swscontents, $offset, $length)) / 2; + $offset += $length; + + $length = 4; + $player->ScoreAmerican = $this->readData('Int', substr($swscontents, $offset, $length)) / 2; + $offset += $length; + + $length = 4; + $player->HelpValue = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + $length = 4; + $player->setElo('Fide', $this->readData('Int', substr($swscontents, $offset, $length))); + $offset += $length; + + $length = 1; + $player->NameLength = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + $length = 3; + $player->Nation = $this->readData('String', substr($swscontents, $offset, $length)); + $offset += $length; + + $length = 1; + $categoryindex = $this->readData('Int', substr($swscontents, $offset, $length)); + $player->Category = $categoryindex != 0 ? $this->Tournament->Categories[ $categoryindex ] : NULL; + $offset += $length; + + $length = 1; + switch ($this->readData('Int', substr($swscontents, $offset, $length))) { + case 1: + $title = Title::ELO; + break; + case 2: + $title = Title::NM; + break; + case 3: + $title = Title::WCM; + break; + case 4: + $title = Title::WFM; + break; + case 5: + $title = Title::CM; + break; + case 6: + $title = Title::WIM; + break; + case 7: + $title = Title::FM; + break; + case 8: + $title = Title::WGM; + break; + case 9: + $title = Title::HM; + break; + case 10: + $title = Title::IM; + break; + case 11: + $title = Title::HG; + break; + case 12: + $title = Title::GM; + break; + case 0: + default: + $title = Title::NONE; + break; + } + $player->Title = $title; + $offset += $length; + + $length = 1; + switch ($this->readData('Int', substr($swscontents, $offset, $length))) { + case 1: + $gender = Gender::MALE; + break; + case 2: + $gender = Gender::FEMALE; + break; + default: + $gender = Gender::NEUTRAL; + break; + } + $player->Gender = $gender; + $offset += $length; + + $length = 1; + $player->NumberOfTies = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + $length = 1; + $player->Absent = $this->readData('Bool', substr($swscontents, $offset, $length)); + $offset += $length; + + $length = 1; + $player->ColorDiff = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + $length = 1; + $player->ColorPref = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + $length = 1; + $player->Paired = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + $length = 1; + $player->Float = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + $length = 1; + $player->FloatPrev = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + $length = 1; + $player->FloatBefore = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + $length = 1; + $player->TieMatch = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + $this->Tournament->addPlayer($player); + } + // PlayerNames + $length = (int)$this->NewNamePos + 0; + $this->PlayerNames = substr($swscontents, $offset, $length); + $offset += $length; + + for ($i = 0; $i < $this->NewPlayer; $i++) { + $player = $this->Tournament->playerById($i); + $namelength = $player->NameLength; + $nameoffset = $player->NamePos; + $player->Name = $this->readData("String", substr($this->PlayerNames, $nameoffset, $namelength)); + + $this->Tournament->updatePlayer($i, $player); + } + + // TournamentName + $length = 80; + $this->Tournament->Name = $this->readData('String', substr($swscontents, $offset, $length)); + $offset += $length; + + // TournamentOrganiser + $length = 50; + $this->Tournament->Organiser = $this->readData('String', substr($swscontents, $offset, $length)); + $offset += $length; + + // TournamentTempo + $length = 50; + $this->Tournament->Tempo = $this->readData('String', substr($swscontents, $offset, $length)); + $offset += $length; + + // TournamentCountry + $length = 32; + $this->Tournament->OrganiserCountry = $this->readData('String', substr($swscontents, $offset, $length)); + $offset += $length; + + // Arbiters + $length = 128; + $this->Tournament->addArbiter($this->readData('String', substr($swscontents, $offset, $length))); + $offset += $length; + + // Rounds + $length = 4; + $this->Tournament->NoOfRounds = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // Participants + $length = 4; + $this->Participants = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // Fidehomol + $length = 4; + $this->Tournament->FideHomol = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // StartDate + $length = 4; + $this->Tournament->StartDate = $this->readData('Date', substr($swscontents, $offset, $length)); + $offset += $length; + + // EndDate + $length = 4; + $this->Tournament->EndDate = $this->readData('Date', substr($swscontents, $offset, $length)); + $offset += $length; + + // Place + $length = 36; + $this->Tournament->OrganiserPlace = $this->readData('String', substr($swscontents, $offset, $length)); + $offset += $length; + + // First period + $length = 32; + $this->Tournament->FirstPeriod = $this->readData('String', substr($swscontents, $offset, $length)); + $offset += $length; + + // Second period + $length = 32; + $this->Tournament->SecondPeriod = $this->readData('String', substr($swscontents, $offset, $length)); + $offset += $length; + + // Unrated Elo + $length = 4; + $this->Tournament->NonRatedElo = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // Type + $length = 4; + switch ($this->readData('Int', substr($swscontents, $offset, $length))) { + case 2: + $system = TournamentSystem::CLOSED; + break; + case 4: + $system = TournamentSystem::AMERICAN; + break; + case 6: + $system = TournamentSystem::KEIZER; + break; + case 0: + default: + $system = TournamentSystem::SWISS; + break; + } + $this->Tournament->System = $system; + $offset += $length; + + // Federation + $length = 12; + $this->Tournament->Federation = $this->readData('String', substr($swscontents, $offset, $length)); + $offset += $length; + + // Soustype + /* + * 32 Bits: + * 1 bit = Libre? + * 6 bits = First round sent to FIDE + * 6 bits = First round sent to FRBE-KBSB + * 6 bits = Last round sent to FIDE + * 6 bits = Last round sent to FRBE-KBSB + * 6 bits = Number of the First board + * 1 bit = Double round robin + */ + $length = 4; + $this->SousType = $this->readData('Hex', substr($swscontents, $offset, $length)); + $offset += $length; + + // Organising club no + $length = 4; + $this->Tournament->OrganiserClubNo = $this->readData('String', substr($swscontents, $offset, $length), 0); + $offset += $length; + + // Organising club + $length = 8; + $this->Tournament->OrganiserClub = $this->readData('String', substr($swscontents, $offset, $length)); + $offset += $length; + + // Tournament year + $length = 4; + $this->Tournament->Year = $this->readData('Int', substr($swscontents, $offset, $length)); + $offset += $length; + + // Round dates + for ($i = 0; $i < $this->Tournament->NoOfRounds; $i++) { + $length = 4; + $round = new Round(); + $round->RoundNo = $i; + $round->Date = $this->readData('Date', substr($swscontents, $offset, $length)); + $this->Tournament->addRound($round); + $offset += $length; + } + + if ($this->CurrentRound > 0) { + for ($i = 0; $i < $this->NewPlayer; $i++) { + for ($x = 0; $x < $this->CreatedRounds; $x++) { + $pairing = new Pairing(); + + $pairing->Player = $this->Tournament->playerById($i); + + $length = 4; + $opponent = $this->readData('Int', substr($swscontents, $offset, $length)); + if ($opponent != 4294967295) { + $pairing->Opponent = $this->Tournament->playerById($opponent); + } + $offset += $length; + + $length = 1; + + switch ($this->readData('Int', substr($swscontents, $offset, $length))) { + case 255: + case 253: + $color = Color::BLACK; + break; + case 1: + case 3: + $color = Color::WHITE; + break; + case 0: + default: + $color = Color::NONE; + break; + } + $pairing->Color = $color; + $offset += $length; + + $length = 1; + switch ($this->readData('Int', substr($swscontents, $offset, $length))) { + case 1: + $result = Result::LOST; + break; + case 2: + $result = Result::ABSENT; + break; + case 3: + $result = Result::ADJOURNED; + break; + case 4: + $result = Result::BYE; + break; + case 6: + $result = Result::DRAW; + break; + case 8: + $result = Result::DRAW_ADJOURNED; + break; + case 11: + $result = Result::WON; + break; + case 12: + $result = Result::WON_FORFAIT; + break; + case 13: + $result = Result::WON_ADJOURNED; + break; + case 14: + $result = Result::WON_BYE; + break; + case 0: + default: + $result = Result::NONE; + break; + } + $pairing->Result = $result; + $offset += $length; + + $pairing->Round = $x; + $offset += 2; + + $pairing->Board = -1; + if ($x < $this->CurrentRound) { + $this->Tournament->addPairing($pairing); + } + } + } + } + + $this->addTiebreaks(); + + $this->Tournament->pairingsToRounds(); + } + + /** + * Converts $data to $type and defaults to $default if given + * + * Possible types for $type are: + * * String (UTF-8 String representation of $data. Default: empty string '') + * * Hex (Capitalized Hex Value of $data. Default: 00) + * * Int (Unsigned Integer value of $data Default: 0) + * * Bool (Boolean representation of $data. Default: false) + * * Date (Date representation of $data. Default: 1902/01/01) + * + * @param string $type + * @param string $data + * @param mixed $default + * + * @return bool|DateTime|int|string + */ + private function readData(string $type, string $data, $default = null) + { + switch ($type) { + case 'String': + $data = trim($data); + if ($data == '') { + return (is_null($default)) ? '' : $default; + } + + return iconv('windows-1252', 'utf-8', $data); + case 'Hex': + case 'Int': + case 'Bool': + case 'Date': + $hex = implode(unpack("H*", $data)); + $hex = array_reverse(str_split($hex, 2)); + + foreach ($hex as $key => $item) { + if ($item == "00") { + $hex[ $key ] = ""; + } else { + break; + } + } + + $hex = implode($hex); + $hex = ($hex == "") ? "00" : $hex; + if ($type == 'Hex') { + if ($hex == '00') { + return (is_null($default)) ? '00' : $default; + } + + return $hex; + } elseif ($type == 'Int') { + if ($hex == '00') { + return (is_null($default)) ? 0 : $default; + } + + return hexdec($hex); + } elseif ($type == 'Date') { + if ($hex == '00') { + return (is_null($default)) ? $this->convertUIntToTimestamp(0) : $default; + } + + return $this->convertUIntToTimestamp(hexdec($hex)); + } elseif ($type == 'Bool') { + return ($hex == "01"); + } + break; + default: + throw new InvalidArgumentException("Datatype not known"); + } + + return false; + } +} diff --git a/src/Readers/Swar4.php b/src/Readers/Swar4.php new file mode 100644 index 0000000..6c10462 --- /dev/null +++ b/src/Readers/Swar4.php @@ -0,0 +1,669 @@ + + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ + +namespace Blackbirdchess\Service\Import\Readers; + +use DateTime; +use InvalidArgumentException; +use Blackbirdchess\Service\Results\Enums\Color; +use Blackbirdchess\Service\Results\Enums\Gender; +use Blackbirdchess\Service\Results\Enums\Result; +use Blackbirdchess\Service\Results\Enums\Tiebreak; +use Blackbirdchess\Service\Results\Enums\Title; +use Blackbirdchess\Service\Results\Enums\TournamentSystem; +use Blackbirdchess\Service\Results\Exceptions\IncompatibleReaderException; +use Blackbirdchess\Service\Results\Interfaces\ReaderInterface; +use Blackbirdchess\Service\Results\Pairing; +use Blackbirdchess\Service\Results\Player; +use Blackbirdchess\Service\Results\Round; +use Blackbirdchess\Service\Results\Tournament; + +/** + * Reader Swar4 + * + * Reads out Swar-4 files + * + * @author Jeroen De Meerleer + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ +class Swar4 implements ReaderInterface +{ + /** + * @var array + */ + public const COMPATIBLE_VERSIONS = ['v4.']; + + public const TEMPOS = [ + [ + '105 min/40 moves + 15 min. QPF', + '120 min/40 moves + 15 min. with incr. 30" starting from 40th move', + '120 min/40 moves + 30 min. QPF', + '120 min/10 moves + 30 min. avec incr. 30" starting from 40th move', + '120 min QPF', + '150 min QPF', + '60 min QPF', + '60 min with incr. 30"', + '65 min QPF', + '75 min with incr. 30"', + '90 min/40 moves + 15 min with incr. 30" starting from 1st move', + '90 min/40 moves + 30 min with incr. 30" starting from 1st move', + '90 min with incr. 30"', + '50 min with incr. 10"', + 'other' + ], + [ + '10 min. with incr. 10"', + '10 min. with incr. 15"', + '10 min. with incr.5"', + '11 min. QPF', + '12 min. QPF', + '13 min. with incr.3"', + '13 min. with incr.5"', + '15 min. QPF', + '15 min. with incr. 10"', + '15 min. with incr. 15"', + '15 min. with incr.5"', + '20 min. QPF', + '20 min. with incr. 10"', + '20 min. with incr. 15"', + '20 min. with incr.5"', + '25 min. QPF', + '25 min. with incr. 10"', + '25 min. with incr. 15"', + '25 min. with incr.5"', + '30 min. QPF', + '45 min. QPF', + '8 min. with incr.4"', + 'other' + ], + [ + '3 min. with incr. 2"', + '3 min. with incr. 3"', + '4 min. with incr. 2"', + '4 min. with incr. 3"', + '5 min. QPF', + '5 min. with incr. 2"', + '5 min. with incr. 3"', + '6 min. with incr. 2"', + '6 min. with incr. 3"', + '7 min. with incr. 2"', + '7 min. with incr. 3"', + '8 min. with incr. 2"', + '10 min. QPF', + 'other' + ] + ]; + + /** + * Binary data that was read out of the pairing file + * + * @var bool|DateTime|int|string[] + */ + private $BinaryData; + + /** + * Version of Pairtwo this file was created with + * + * @var string + */ + public $Release; + + /** + * The tournament + * + * @var Tournament + */ + public $Tournament; + + /** + * Returns binary data that was read out the swar file but was not needed immediately + * + * @param string $key + * + * @return bool|DateTime|int|string|null + */ + public function __get(string $key) + { + if (isset($this->BinaryData[ $key ])) { + return $this->BinaryData[ $key ]; + } + + return null; + } + + /** + * Sets binary data that is read out the swar file but is not needed immediately + * + * @param string $key + * @param bool|int|DateTime|string $value + */ + public function __set(string $key, $value): void + { + $this->BinaryData[ $key ] = $value; + } + + /** + * Adds the first tiebreak to the tournament + */ + private function addTiebreaks(): void + { + switch ($this->Tournament->System) { + case TournamentSystem::AMERICAN: + case TournamentSystem::CLOSED: + case TournamentSystem::SWISS: + default: + $firstElement = new Tiebreak(Tiebreak::POINTS); + } + $tiebreaks = $this->Tournament->Tiebreaks; + array_unshift($tiebreaks, $firstElement); + $this->Tournament->Tiebreaks = $tiebreaks; + } + + /** + * Converts a swar-4 string to a \DateTime object + * + * @param string $string + * + * @return DateTime + */ + public function convertStringToDate(string $string): DateTime + { + if (strlen($string) == 10) { + return DateTime::createFromFormat('d/m/Y', $string); + } elseif (strlen($string) == 8) { + return DateTime::createFromFormat('Ymd', $string); + } else { + $default = new DateTime(); + $default->setTimestamp(0); + + return $default; + } + } + + /** + * Actually reads the Swar-File + * + * @param string $filename + * + * @throws IncompatibleReaderException + */ + public function read(string $filename): void + { + $swshandle = fopen($filename, 'rb'); + + $this->Release = $this->readData('String', $swshandle); + if (array_search(substr($this->Release, 0, 3), self::COMPATIBLE_VERSIONS) === false) { + throw new IncompatibleReaderException("This file was not created with Swar 4"); + } + + $this->Tournament = new Tournament(); + + $this->Guid = $this->readData('String', $swshandle); + $this->MacAddress = $this->readData('String', $swshandle); + + // [Tournoi] + $this->readData('String', $swshandle); + + $this->Tournament->Name = $this->readData('String', $swshandle); + $this->Tournament->Organiser = $this->readData('String', $swshandle); + $this->Tournament->OrganiserClub = $this->readData('String', $swshandle); + $this->Tournament->OrganiserPlace = $this->readData('String', $swshandle); + + $this->Tournament->addArbiter($this->readData('String', $swshandle)); + $this->Tournament->addArbiter($this->readData('String', $swshandle)); + + $this->Tournament->StartDate = $this->readData('Date', $swshandle); + $this->Tournament->EndDate = $this->readData('Date', $swshandle); + + // Tempo string is not variable and dependant on kind of tournament + $this->Tournament->TempoIndex = $this->readData('Int', $swshandle); + + $this->Tournament->NoOfRounds = $this->readData('Int', $swshandle); + + $this->Tournament->FRBEfrom = $this->readData('Int', $swshandle); + $this->Tournament->FRBEto = $this->readData('Int', $swshandle); + $this->Tournament->FIDEfrom = $this->readData('Int', $swshandle); + $this->Tournament->FIDEto = $this->readData('Int', $swshandle); + $this->Tournament->CatSepares = $this->readData('Int', $swshandle); + $this->Tournament->AfficherEloOuPays = $this->readData('Int', $swshandle); + + $this->Tournament->FideHomol = $this->readData('Int', $swshandle); + + $this->Tournament->FideId = $this->readData('String', $swshandle); + $this->Tournament->FideArbitre1 = $this->readData('String', $swshandle); + $this->Tournament->FideArbitre2 = $this->readData('String', $swshandle); + $this->Tournament->FideEmail = $this->readData('String', $swshandle); + $this->Tournament->FideRemarques = $this->readData('String', $swshandle); + + switch ($this->readData('Int', $swshandle)) { + case 0: + case 1: + case 2: + case 3: + case 4: + default: + $system = TournamentSystem::SWISS; + break; + case 5: + case 6: + case 7: + $system = TournamentSystem::CLOSED; + break; + case 8: + case 9: + $system = TournamentSystem::AMERICAN; + break; + } + $this->Tournament->System = $system; + + $this->Tournament->Dummy1 = $this->readData('Int', $swshandle); + $this->Tournament->Dummy2 = $this->readData('Int', $swshandle); + $this->Tournament->SW_AmerPresence = $this->readData('Int', $swshandle); + $this->Tournament->Plusieurs = $this->readData('Int', $swshandle); + $this->Tournament->FirstTable = $this->readData('Int', $swshandle); + $this->Tournament->SW321_Win = $this->readData('Int', $swshandle); + $this->Tournament->SW321_Nul = $this->readData('Int', $swshandle); + $this->Tournament->SW321_Los = $this->readData('Int', $swshandle); + $this->Tournament->SW321_Bye = $this->readData('Int', $swshandle); + $this->Tournament->SW321_Pre = $this->readData('Int', $swshandle); + $this->Tournament->EloUsed = $this->readData('Int', $swshandle); + $this->Tournament->TournoiStd = $this->readData('Int', $swshandle); + $this->Tournament->TbPersonel = $this->readData('Int', $swshandle); + $this->Tournament->ApparOrder = $this->readData('Int', $swshandle); + $this->Tournament->EloEqual = $this->readData('Int', $swshandle); + $this->Tournament->ByeValue = $this->readData('Int', $swshandle); + $this->Tournament->AbsValue = $this->readData('Int', $swshandle); + $this->Tournament->FF_Value = $this->readData('Int', $swshandle); + + switch ($this->readData('Int', $swshandle)) { + case 0: + default: + $federation = ''; + break; + case 1: + $federation = 'FRBE'; + break; + case 2: + $federation = 'KBSB'; + break; + case 3: + $federation = 'FEFB'; + break; + case 4: + $federation = 'VSF'; + break; + case 5: + $federation = 'SVDB'; + break; + case 6: + $federation = 'FIDE'; + break; + } + $this->Tournament->Federation = $federation; + $this->Tournament->NonRatedElo = 0; + $this->Tournament->OrganiserClubNo = 0; + // [DATES] + $this->readData('String', $swshandle); + + $this->Tournament->Tempo = self::TEMPOS[ $this->Tournament->TournoiStd ][ $this->Tournament->TempoIndex ]; + + for ($i = 0; $i < $this->Tournament->NoOfRounds; $i++) { + $round = new Round(); + $round->RoundNo = $i; + $round->Date = $this->readData('Date', $swshandle); + $this->Tournament->addRound($round); + } + + // [TIE_BREAK] + $this->readData('String', $swshandle); + + $tiebreaks = []; + for ($i = 0; $i < 5; $i++) { + switch ($this->readData('Int', $swshandle)) { + case 0: + default: + $tiebreak = Tiebreak::NONE; + break; + case 1: + $tiebreak = Tiebreak::BUCHHOLZ; + break; + case 2: + $tiebreak = Tiebreak::BUCHHOLZ_MED; + break; + case 3: + $tiebreak = Tiebreak::BUCHHOLZ_MED_2; + break; + case 4: + $tiebreak = Tiebreak::BUCHHOLZ_CUT; + break; + case 5: + $tiebreak = Tiebreak::BUCHHOLZ_CUT_2; + break; + case 6: + $tiebreak = Tiebreak::SONNEBORN; + break; + case 7: + $tiebreak = Tiebreak::CUMULATIVE; + break; + case 8: + $tiebreak = Tiebreak::BETWEEN; + break; + case 9: + $tiebreak = Tiebreak::KOYA; + break; + case 10: + $tiebreak = Tiebreak::BAUMBACH; + break; + case 11: + $tiebreak = Tiebreak::AVERAGE_PERFORMANCE; + break; + case 12: + $tiebreak = Tiebreak::ARO; + break; + case 13: + $tiebreak = Tiebreak::AROCUT; + break; + case 14: + $tiebreak = Tiebreak::BLACK_PLAYED; + break; + case 15: + $tiebreak = Tiebreak::BLACK_WIN; + break; + } + $tiebreaks[] = new Tiebreak($tiebreak); + } + $this->Tournament->Tiebreaks = $tiebreaks; + + // [EXCLUSION] + $this->readData('String', $swshandle); + $this->Tournament->ExclusionType = $this->readData('Int', $swshandle); + $this->Tournament->ExclusionValue = $this->readData('String', $swshandle); + + // [CATEGORIES] + $this->readData('String', $swshandle); + + $this->Tournament->Catogory_type = $this->readData('Int', $swshandle); + for ($i = 0; $i <= 12; $i++) { + $category[ $i ][ 'Cat1' ] = $this->readData('String', $swshandle); + } + + for ($i = 0; $i <= 12; $i++) { + $category[ $i ][ 'Cat2' ] = $this->readData('String', $swshandle); + } + $this->Tournament->Category = $category; + // [XTRA_POINTS] + $this->readData('String', $swshandle); + + for ($i = 0; $i < 4; $i++) { + $extrapoints[ $i ][ 'pts' ] = $this->readData('Int', $swshandle); + $extrapoints[ $i ][ 'elo' ] = $this->readData('Int', $swshandle); + } + $this->Tournament->Extrapoints = $extrapoints; + + // [JOUEURS] + $this->readData('String', $swshandle); + + $roundNo = 0; + $playerNo = 0; + $this->Tournament->NumberOfPlayers = $this->readData('Int', $swshandle); + + $pt = 0; + for ($i = 0; $i < $this->Tournament->NumberOfPlayers; $i++) { + $player = new Player(); + $player->Classement = $this->readData('Int', $swshandle); + $player->Name = $this->readData('String', $swshandle); + $inscriptionNos[ $this->readData('Int', $swshandle) ] = $i; + $player->Rank = $this->readData('Int', $swshandle); + $player->CatIndex = $this->readData('Int', $swshandle); + $player->DateOfBirth = $this->readData('Date', $swshandle); + switch ($this->readData('Int', $swshandle)) { + case 1: + $gender = Gender::MALE; + break; + case 2: + $gender = Gender::FEMALE; + break; + default: + $gender = Gender::NEUTRAL; + break; + } + $player->Gender = new Gender($gender); + + $player->Nation = $this->readData('String', $swshandle); + $player->setId('Nation', $this->readData('Int', $swshandle)); + $player->setId('Fide', $this->readData('Int', $swshandle)); + $player->Affliation = $this->readData('Int', $swshandle); + $player->setElo('Nation', $this->readData('Int', $swshandle)); + $player->setElo('Fide', $this->readData('Int', $swshandle)); + switch ($this->readData('Int', $swshandle)) { + case 1: + $title = Title::WCM; + break; + case 2: + $title = Title::WFM; + break; + case 3: + $title = Title::CM; + break; + case 4: + $title = Title::WIM; + break; + case 5: + $title = Title::FM; + break; + case 6: + $title = Title::WGM; + break; + case 7: + $title = Title::HM; + break; + case 8: + $title = Title::IM; + break; + case 9: + $title = Title::HG; + break; + case 10: + $title = Title::GM; + break; + case 0: + default: + $title = Title::NONE; + break; + } + $player->Title = new Title($title); + + $player->setId('Club', $this->readData('Int', $swshandle)); + $player->ClubName = $this->readData('String', $swshandle); + $player->NoOfMatchesNoBye = $this->readData('Int', $swshandle); + $player->Points = $this->readData('Int', $swshandle); // To Calculate by libpairtwo + $player->AmericanPoints = $this->readData('Int', $swshandle); // To Calculate by libpairtwo + for ($t = 0; $t < 5; $t++) { + $tiebreaks[ $t ] = $this->readData('Int', $swshandle); // To Calculate by libpairtwo + } + $player->Tiebreak = $tiebreaks; + $player->Performance = $this->readData('Int', $swshandle); // To Calculate by libpairtwo + $player->Absent = $this->readData('Int', $swshandle); + $player->AbsentRounds = $this->readData('String', $swshandle); + $player->ExtraPoints = $this->readData('Int', $swshandle); + $player->SpecialPoints = $this->readData('Int', $swshandle); + $player->AllocatedRounds = $this->readData('Int', $swshandle); + // [RONDE] + $this->readData('String', $swshandle); + + if ($player->AllocatedRounds != 0) { + for ($j = 0; $j < $player->AllocatedRounds; $j++) { + $pairing[ $pt ][ 'player' ] = $i; + $pairing[ $pt ][ 'round' ] = $this->readData('Int', $swshandle) - 1; + $pairing[ $pt ][ 'table' ] = $this->readData('Int', $swshandle) - 1; + $pairing[ $pt ][ 'opponent' ] = $this->readData('Int', $swshandle); + $pairing[ $pt ][ 'result' ] = $this->readData('Hex', $swshandle); + $pairing[ $pt ][ 'color' ] = $this->readData('Int', $swshandle); + $pairing[ $pt ][ 'float' ] = $this->readData('Int', $swshandle); + $pairing[ $pt ][ 'extrapoints' ] = $this->readData('Int', $swshandle); + + $pt++; + } + $this->Tournament->Pairing = $pairing; + } + + $this->Tournament->addPlayer($player); + } + + $ptn = 0; + while (isset($this->Tournament->Pairing[ $ptn ][ 'round' ])) { + $pairing = new Pairing(); + + $pairing->Player = $this->Tournament->playerById($this->Tournament->Pairing[ $ptn ][ 'player' ]); + $pairing->Round = $this->Tournament->Pairing[ $ptn ][ 'round' ]; + if ($this->Tournament->Pairing[ $ptn ][ 'opponent' ] != 4294967295) { + $pairing->Opponent = + $this->Tournament->playerById($inscriptionNos[ $this->Tournament->Pairing[ $ptn ][ 'opponent' ] ]); + } + switch ($this->Tournament->Pairing[ $ptn ][ 'result' ]) { + case '1000': + $result = Result::LOST; + break; + case '01': + $result = Result::ABSENT; + break; + case '0010': + $result = Result::BYE; + break; + case '2000': + $result = Result::DRAW; + break; + case '4000': + $result = Result::WON; + break; + case '04': + $result = Result::WON_FORFAIT; + break; + case '40': + $result = Result::WON_BYE; + break; + case '00': + default: + $result = Result::NONE; + break; + } + if (array_search($this->Tournament->Pairing[ $ptn ][ 'table' ], [16383, 8191]) !== false) { + $result = Result::ABSENT; + } + $pairing->Result = new Result($result); + + switch ($this->Tournament->Pairing[ $ptn ][ 'color' ]) { + case 4294967295: + $color = Color::BLACK; + break; + case 1: + $color = Color::WHITE; + break; + case 0: + default: + $color = Color::NONE; + break; + } + $pairing->Color = new Color($color); + + $pairing->Board = $this->Tournament->Pairing[ $ptn ][ 'table' ]; + $ptn++; + $this->Tournament->addPairing($pairing); + } + fclose($swshandle); + $this->Tournament->pairingsToRounds(); + $this->addTiebreaks(); + } + + /** + * Reads data of the filehandle and converts to $type. defaults to $default if given + * + * Possible types for $type are: + * * String (UTF-8 String representation of $data. Default: empty string '') + * * Hex (Capitalized Hex Value of $data. Default: 00) + * * Int (Unsigned Integer value of $data Default: 0) + * * Bool (Boolean representation of $data. Default: false) + * * Date (Date representation of $data. Default: 1902/01/01) + * + * @param string $type + * @param $handle + * @param null $default + * + * @return array|bool|DateTime|false|float|int|string|null + */ + private function readData(string $type, $handle, $default = null) + { + switch ($type) { + case 'String': + case 'Date': + $length = $this->readData('Int', $handle); + if ($length == 0) { + return ''; + } + $data = fread($handle, $length); + if ($type == 'String') { + if ($data == '') { + return (is_null($default)) ? '' : $default; + } + + return iconv('windows-1252', 'utf-8', $data); + } elseif ($type == 'Date') { + if ($data == '') { + return (is_null($default)) ? $this->convertStringToDate('01/01/1900') : $default; + } + + return $this->convertStringToDate($data); + } + break; + case 'Hex': + case 'Int': + case 'Bool': + $data = fread($handle, 4); + $hex = implode(unpack("H*", $data)); + $hex = array_reverse(str_split($hex, 2)); + + foreach ($hex as $key => $item) { + if ($item == "00") { + $hex[ $key ] = ""; + } else { + break; + } + } + + $hex = implode($hex); + $hex = ($hex == "") ? "00" : $hex; + if ($type == 'Hex') { + if ($hex == '00') { + return (is_null($default)) ? '00' : $default; + } + + return $hex; + } elseif ($type == 'Int') { + if ($hex == '00') { + return (is_null($default)) ? 0 : $default; + } + + return hexdec($hex); + } elseif ($type == 'Bool') { + return ($hex == "01"); + } + break; + default: + throw new InvalidArgumentException("Datatype not known"); + } + + return false; + } +} diff --git a/src/Readers/Swar5.php b/src/Readers/Swar5.php new file mode 100644 index 0000000..3d76bfa --- /dev/null +++ b/src/Readers/Swar5.php @@ -0,0 +1,691 @@ + + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2019 Jeroen De Meerleer + */ + +namespace Blackbirdchess\Service\Import\Readers; + +use DateTime; +use InvalidArgumentException; +use Blackbirdchess\Service\Results\Enums\Color; +use Blackbirdchess\Service\Results\Enums\Gender; +use Blackbirdchess\Service\Results\Enums\Result; +use Blackbirdchess\Service\Results\Enums\Tiebreak; +use Blackbirdchess\Service\Results\Enums\Title; +use Blackbirdchess\Service\Results\Enums\TournamentSystem; +use Blackbirdchess\Service\Import\Exceptions\IncompatibleReaderException; +use Blackbirdchess\Service\Import\Interfaces\ReaderInterface; +use Blackbirdchess\Service\Results\Pairing; +use Blackbirdchess\Service\Results\Player; +use Blackbirdchess\Service\Results\Round; +use Blackbirdchess\Service\Results\Tournament; + +/** + * Reader Swar5 + * + * Reads out Swar-5 files + * + * @author Jeroen De Meerleer + * @category Main + * @package Libpairtwo + * @copyright Copyright (c) 2018-2021 Jeroen De Meerleer + */ +class Swar5 implements ReaderInterface +{ + /** + * @var array + */ + public const COMPATIBLE_VERSIONS = ['v5.']; + + public const TEMPOS = [ + [ + '105 min/40 moves + 15 min. QPF', + '120 min/40 moves + 15 min. with incr. 30" starting from 40th move', + '120 min/40 moves + 30 min. QPF', + '120 min/10 moves + 30 min. avec incr. 30" starting from 40th move', + '120 min QPF', + '150 min QPF', + '60 min QPF', + '60 min with incr. 30"', + '65 min QPF', + '75 min with incr. 30"', + '90 min/40 moves + 15 min with incr. 30" starting from 1st move', + '90 min/40 moves + 30 min with incr. 30" starting from 1st move', + '90 min with incr. 30"', + '50 min with incr. 10"', + 'other' + ], + [ + '10 min. with incr. 10"', + '10 min. with incr. 15"', + '10 min. with incr.5"', + '11 min. QPF', + '12 min. QPF', + '13 min. with incr.3"', + '13 min. with incr.5"', + '15 min. QPF', + '15 min. with incr. 10"', + '15 min. with incr. 15"', + '15 min. with incr.5"', + '20 min. QPF', + '20 min. with incr. 10"', + '20 min. with incr. 15"', + '20 min. with incr.5"', + '25 min. QPF', + '25 min. with incr. 10"', + '25 min. with incr. 15"', + '25 min. with incr.5"', + '30 min. QPF', + '45 min. QPF', + '8 min. with incr.4"', + 'other' + ], + [ + '3 min. with incr. 2"', + '3 min. with incr. 3"', + '4 min. with incr. 2"', + '4 min. with incr. 3"', + '5 min. QPF', + '5 min. with incr. 2"', + '5 min. with incr. 3"', + '6 min. with incr. 2"', + '6 min. with incr. 3"', + '7 min. with incr. 2"', + '7 min. with incr. 3"', + '8 min. with incr. 2"', + '10 min. QPF', + 'other' + ] + ]; + + /** + * Binary data that was read out of the pairing file + * + * @var bool|DateTime|int|string[] + */ + private $BinaryData; + + /** + * Version of Pairtwo this file was created with + * + * @var string + */ + public $Release; + + /** + * The tournament + * + * @var Tournament + */ + public $Tournament; + + /** + * Returns binary data that was read out the swar file but was not needed immediately + * + * @param string $key + * + * @return bool|DateTime|int|string|null + */ + public function __get(string $key) + { + if (isset($this->BinaryData[ $key ])) { + return $this->BinaryData[ $key ]; + } + + return null; + } + + /** + * Sets binary data that is read out the swar file but is not needed immediately + * + * @param string $key + * @param bool|int|DateTime|string $value + */ + public function __set(string $key, $value): void + { + $this->BinaryData[ $key ] = $value; + } + + /** + * Adds the first tiebreak to the tournament + */ + private function addTiebreaks(): void + { + switch ($this->Tournament->System) { + case TournamentSystem::AMERICAN: + case TournamentSystem::CLOSED: + case TournamentSystem::SWISS: + default: + $firstElement = Tiebreak::POINTS; + } + $tiebreaks = $this->Tournament->Tiebreaks; + array_unshift($tiebreaks, $firstElement); + $this->Tournament->Tiebreaks = $tiebreaks; + } + + /** + * Converts a swar-4 string to a \DateTime object + * + * @param string $string + * + * @return DateTime + */ + public function convertStringToDate(string $string): DateTime + { + if (strlen($string) == 10) { + return DateTime::createFromFormat('d/m/Y', $string); + } elseif (strlen($string) == 8) { + return DateTime::createFromFormat('Ymd', $string); + } else { + $default = new DateTime(); + $default->setTimestamp(0); + + return $default; + } + } + + /** + * Actually reads the Swar-File + * + * @param string $filename + * + * @throws IncompatibleReaderException + */ + public function read(string $filename, string $compatversion = ''): void + { + $swshandle = fopen($filename, 'rb'); + + $this->Release = $this->readData('String', $swshandle); + + if($compatversion != '') { + $this->Release == $compatversion; + } + if (array_search(substr($this->Release, 0, 3), self::COMPATIBLE_VERSIONS) === false) { + throw new IncompatibleReaderException("This file was not created with Swar 5"); + } + + $this->Tournament = new Tournament(); + + $this->Guid = $this->readData('String', $swshandle); + $this->MacAddress = $this->readData('String', $swshandle); + + // [Tournoi] + $this->readData('String', $swshandle); + + $this->Tournament->Name = $this->readData('String', $swshandle); + $this->Tournament->Organiser = $this->readData('String', $swshandle); + $this->Tournament->OrganiserClub = $this->readData('String', $swshandle); + $this->Tournament->OrganiserPlace = $this->readData('String', $swshandle); + + $this->Tournament->addArbiter($this->readData('String', $swshandle)); + $this->Tournament->addArbiter($this->readData('String', $swshandle)); + + $this->Tournament->StartDate = $this->readData('Date', $swshandle); + $this->Tournament->EndDate = $this->readData('Date', $swshandle); + + // Tempo string is not variable and dependant on kind of tournament + $this->Tournament->TempoIndex = $this->readData('Int', $swshandle); + + $this->readData('String', $swshandle); // some unknown data + $this->Tournament->NoOfRounds = $this->readData('Int', $swshandle); + + $this->Tournament->FRBEfrom = $this->readData('Int', $swshandle); + $this->Tournament->FRBEto = $this->readData('Int', $swshandle); + $this->Tournament->FIDEfrom = $this->readData('Int', $swshandle); + $this->Tournament->FIDEto = $this->readData('Int', $swshandle); + $this->Tournament->CatSepares = $this->readData('Int', $swshandle); + $this->Tournament->AfficherEloOuPays = $this->readData('Int', $swshandle); + + $this->Tournament->FideHomol = $this->readData('Int', $swshandle); + + if (version_compare($this->Release, '5.24', ">=")) { + $this->Tournament->FideId = $this->readData('Int', $swshandle); + } else { + for ($i = 0; $i <= 15; $i++) { + // First round + $this->readData('Int', $swshandle); + //last round + $this->readData('Int', $swshandle); + //fide ID + $this->readData('Int', $swshandle); + } + } + $this->Tournament->FideArbitre1 = $this->readData('String', $swshandle); + $this->Tournament->FideArbitre2 = $this->readData('String', $swshandle); + $this->Tournament->FideEmail = $this->readData('String', $swshandle); + $this->Tournament->FideRemarques = $this->readData('String', $swshandle); + + $applycustompoints = false; + switch ($this->readData('Int', $swshandle)) { + case 4: + case 5: + case 6: + $system = TournamentSystem::CLOSED; + break; + case 7: + case 8: + $system = TournamentSystem::AMERICAN; + break; + case 3: + $applycustompoints = true; + case 0: + case 1: + case 2: + default: + $system = TournamentSystem::SWISS; + break; + } + $this->Tournament->System = $system; + + $this->Tournament->Dummy1 = $this->readData('Int', $swshandle); + $this->Tournament->Dummy2 = $this->readData('Int', $swshandle); + $this->Tournament->SW_AmerPresence = $this->readData('Int', $swshandle); + $this->Tournament->Plusieurs = $this->readData('Int', $swshandle); + $this->Tournament->FirstTable = $this->readData('Int', $swshandle); + $custompoints['win'] = $this->readData('Int', $swshandle) / 4; + $custompoints['draw'] = $this->readData('Int', $swshandle) / 4; + $custompoints['loss'] = $this->readData('Int', $swshandle) / 4; + $custompoints['bye'] = $this->readData('Int', $swshandle) / 4; + $custompoints['absent'] = $this->readData('Int', $swshandle) / 4; + if($applycustompoints) $this->Tournament->CustomPoints = $custompoints; + $this->Tournament->EloUsed = $this->readData('Int', $swshandle); + $this->Tournament->TournoiStd = $this->readData('Int', $swshandle); + $this->Tournament->TbPersonel = $this->readData('Int', $swshandle); + $this->Tournament->ApparOrder = $this->readData('Int', $swshandle); + $this->Tournament->EloEqual = $this->readData('Int', $swshandle); + $this->Tournament->ByeValue = $this->readData('Int', $swshandle); + $this->Tournament->AbsValue = $this->readData('Int', $swshandle); + $this->Tournament->FF_Value = $this->readData('Int', $swshandle); + + switch ($this->readData('Int', $swshandle)) { + case 0: + default: + $federation = ''; + break; + case 1: + $federation = 'FRBE'; + break; + case 2: + $federation = 'KBSB'; + break; + case 3: + $federation = 'FEFB'; + break; + case 4: + $federation = 'VSF'; + break; + case 5: + $federation = 'SVDB'; + break; + case 6: + $federation = 'FIDE'; + break; + } + $this->Tournament->Federation = $federation; + $this->Tournament->NonRatedElo = 0; + $this->Tournament->OrganiserClubNo = 0; + + // [DATES] + $this->readData('String', $swshandle); + + $this->Tournament->Tempo = self::TEMPOS[ $this->Tournament->TournoiStd ][ $this->Tournament->TempoIndex ]; + + for ($i = 0; $i < $this->Tournament->NoOfRounds; $i++) { + $round = new Round(); + $round->RoundNo = $i; + $round->Date = $this->readData('Date', $swshandle); + $this->Tournament->addRound($round); + } + + // [TIE_BREAK] + $this->readData('String', $swshandle); + + $tiebreaks = []; + for ($i = 0; $i < 5; $i++) { + switch ($this->readData('Int', $swshandle)) { + case 0: + default: + $tiebreak = Tiebreak::NONE; + break; + case 1: + $tiebreak = Tiebreak::BUCHHOLZ; + break; + case 2: + $tiebreak = Tiebreak::BUCHHOLZ_MED; + break; + case 3: + $tiebreak = Tiebreak::BUCHHOLZ_MED_2; + break; + case 4: + $tiebreak = Tiebreak::BUCHHOLZ_CUT; + break; + case 5: + $tiebreak = Tiebreak::BUCHHOLZ_CUT_2; + break; + case 6: + $tiebreak = Tiebreak::SONNEBORN; + break; + case 7: + $tiebreak = Tiebreak::CUMULATIVE; + break; + case 8: + $tiebreak = Tiebreak::BETWEEN; + break; + case 9: + $tiebreak = Tiebreak::KOYA; + break; + case 10: + $tiebreak = Tiebreak::BAUMBACH; + break; + case 11: + $tiebreak = Tiebreak::AVERAGE_PERFORMANCE; + break; + case 12: + $tiebreak = Tiebreak::ARO; + break; + case 13: + $tiebreak = Tiebreak::AROCUT; + break; + case 14: + $tiebreak = Tiebreak::BLACK_PLAYED; + break; + case 15: + $tiebreak = Tiebreak::BLACK_WIN; + break; + } + $tiebreaks[] = $tiebreak; + } + $this->Tournament->Tiebreaks = $tiebreaks; + + // [EXCLUSION] + $this->readData('String', $swshandle); + $this->Tournament->ExclusionType = $this->readData('Int', $swshandle); + $this->Tournament->ExclusionValue = $this->readData('String', $swshandle); + + // [CATEGORIES] + $this->readData('String', $swshandle); + + $this->Tournament->Catogory_type = $this->readData('Int', $swshandle); + for ($i = 0; $i <= 12; $i++) { + $category[ $i ][ 'Cat1' ] = $this->readData('String', $swshandle); + } + + for ($i = 0; $i <= 12; $i++) { + $category[ $i ][ 'Cat2' ] = $this->readData('String', $swshandle); + } + $this->Tournament->Category = $category; + // [XTRA_POINTS] + $this->readData('String', $swshandle); + + for ($i = 0; $i < 4; $i++) { + $extrapoints[ $i ][ 'pts' ] = $this->readData('Int', $swshandle); + $extrapoints[ $i ][ 'elo' ] = $this->readData('Int', $swshandle); + } + $this->Tournament->Extrapoints = $extrapoints; + + // [JOUEURS] + $this->readData('String', $swshandle); + + $roundNo = 0; + $playerNo = 0; + $this->Tournament->NumberOfPlayers = $this->readData('Int', $swshandle); + + $pt = 0; + for ($i = 0; $i < $this->Tournament->NumberOfPlayers; $i++) { + $player = new Player(); + + $player->Classement = $this->readData('Int', $swshandle); + $player->Name = $this->readData('String', $swshandle); + $inscriptionNos[ $this->readData('Int', $swshandle) ] = $i; + $player->Rank = $this->readData('Int', $swshandle); + $player->CatIndex = $this->readData('Int', $swshandle); + $player->DateOfBirth = $this->readData('Date', $swshandle); + switch ($this->readData('Int', $swshandle)) { + case 1: + $gender = Gender::MALE; + break; + case 2: + $gender = Gender::FEMALE; + break; + default: + $gender = Gender::NEUTRAL; + break; + } + $player->Gender = $gender; + + $player->Nation = $this->readData('String', $swshandle); + $player->setId('Nation', $this->readData('Int', $swshandle)); + $player->setId('Fide', $this->readData('Int', $swshandle)); + $player->Affliation = $this->readData('Int', $swshandle); + $player->setElo('Nation', $this->readData('Int', $swshandle)); + $player->setElo('Fide', $this->readData('Int', $swshandle)); + switch ($this->readData('Int', $swshandle)) { + case 1: + $title = Title::WCM; + break; + case 2: + $title = Title::WFM; + break; + case 3: + $title = Title::CM; + break; + case 4: + $title = Title::WIM; + break; + case 5: + $title = Title::FM; + break; + case 6: + $title = Title::WGM; + break; + case 7: + $title = Title::HM; + break; + case 8: + $title = Title::IM; + break; + case 9: + $title = Title::HG; + break; + case 10: + $title = Title::GM; + break; + case 0: + default: + $title = Title::NONE; + break; + } + $player->Title = $title; + + $player->setId('Club', $this->readData('Int', $swshandle)); + $player->ClubName = $this->readData('String', $swshandle); + $player->NoOfMatchesNoBye = $this->readData('Int', $swshandle); + $player->Points = $this->readData('Int', $swshandle); // To Calculate by libpairtwo + $player->AmericanPoints = $this->readData('Int', $swshandle); // To Calculate by libpairtwo + for ($t = 0; $t < 5; $t++) { + $tiebreaks[ $t ] = $this->readData('Int', $swshandle); // To Calculate by libpairtwo + } + $player->Tiebreak = $tiebreaks; + $player->Performance = $this->readData('Int', $swshandle); // To Calculate by libpairtwo + $player->Absent = $this->readData('Int', $swshandle); + $player->AbsentRounds = $this->readData('Int', $swshandle); + if(version_compare($this->Release, '5.53', "<=")) $player->Paid = $this->readData('Int', $swshandle); + $player->ExtraPoints = $this->readData('Int', $swshandle); + $player->SpecialPoints = $this->readData('Int', $swshandle); + $player->AllocatedRounds = $this->readData('Int', $swshandle); + // [RONDE] + $this->readData('String', $swshandle); + + if ($player->AllocatedRounds != 0) { + for ($j = 0; $j < $player->AllocatedRounds; $j++) { + $pairing[ $pt ][ 'player' ] = $i; + $pairing[ $pt ][ 'round' ] = $this->readData('Int', $swshandle) - 1; + $pairing[ $pt ][ 'table' ] = $this->readData('Int', $swshandle) - 1; + $pairing[ $pt ][ 'opponent' ] = $this->readData('Int', $swshandle); + $pairing[ $pt ][ 'result' ] = $this->readData('Hex', $swshandle); + $pairing[ $pt ][ 'color' ] = $this->readData('Int', $swshandle); + $pairing[ $pt ][ 'float' ] = $this->readData('Int', $swshandle); + $pairing[ $pt ][ 'extrapoints' ] = $this->readData('Int', $swshandle); + + $pt++; + } + + $this->Tournament->Pairing = $pairing; + } + + $this->Tournament->addPlayer($player); + } + + $ptn = 0; + while (isset($this->Tournament->Pairing[ $ptn ][ 'round' ])) { + $pairing = new Pairing(); + + $pairing->Player = $this->Tournament->playerById($this->Tournament->Pairing[ $ptn ][ 'player' ]); + $pairing->Round = $this->Tournament->Pairing[ $ptn ][ 'round' ]; + if ($this->Tournament->Pairing[ $ptn ][ 'opponent' ] != 4294967295) { + $pairing->Opponent = + $this->Tournament->playerById($inscriptionNos[ $this->Tournament->Pairing[ $ptn ][ 'opponent' ] ]); + } + switch ($this->Tournament->Pairing[ $ptn ][ 'result' ]) { + case '1000': + $result = Result::LOST; + break; + case '01': + $result = Result::ABSENT; + break; + case '0010': + $result = Result::BYE; + break; + case '2000': + $result = Result::DRAW; + break; + case '4000': + $result = Result::WON; + break; + case '04': + $result = Result::WON_FORFAIT; + break; + case '40': + $result = Result::WON_BYE; + break; + case '00': + default: + $result = Result::NONE; + break; + } + if (array_search($this->Tournament->Pairing[ $ptn ][ 'table' ], [16383, 8191]) !== false) { + $result = Result::ABSENT; + } + $pairing->Result = $result; + + switch ($this->Tournament->Pairing[ $ptn ][ 'color' ]) { + case 4294967295: + $color = Color::BLACK; + break; + case 1: + $color = Color::WHITE; + break; + case 0: + default: + $color = Color::NONE; + break; + } + $pairing->Color = $color; + + $pairing->Board = $this->Tournament->Pairing[ $ptn ][ 'table' ]; + $ptn++; + $this->Tournament->addPairing($pairing); + } + fclose($swshandle); + $this->Tournament->pairingsToRounds(); + $this->addTiebreaks(); + } + + /** + * Reads data of the filehandle and converts to $type. defaults to $default if given + * + * Possible types for $type are: + * * String (UTF-8 String representation of $data. Default: empty string '') + * * Hex (Capitalized Hex Value of $data. Default: 00) + * * Int (Unsigned Integer value of $data Default: 0) + * * Bool (Boolean representation of $data. Default: false) + * * Date (Date representation of $data. Default: 1902/01/01) + * + * @param string $type + * @param $handle + * @param null $default + * + * @return array|bool|DateTime|false|float|int|string|null + */ + private function readData(string $type, $handle, $default = null) + { + switch ($type) { + case 'String': + case 'Date': + $length = $this->readData('Int', $handle); + if ($length == 0) { + return ''; + } + $data = fread($handle, $length); + if ($type == 'String') { + if ($data == '') { + return (is_null($default)) ? '' : $default; + } + + return iconv('windows-1252', 'utf-8', $data); + } elseif ($type == 'Date') { + if ($data == '') { + return (is_null($default)) ? $this->convertStringToDate('01/01/1900') : $default; + } + + return $this->convertStringToDate($data); + } + break; + case 'Hex': + case 'Int': + case 'Bool': + $data = fread($handle, 4); + $hex = implode(unpack("H*", $data)); + $hex = array_reverse(str_split($hex, 2)); + + foreach ($hex as $key => $item) { + if ($item == "00") { + $hex[ $key ] = ""; + } else { + break; + } + } + + $hex = implode($hex); + $hex = ($hex == "") ? "00" : $hex; + if ($type == 'Hex') { + if ($hex == '00') { + return (is_null($default)) ? '00' : $default; + } + + return $hex; + } elseif ($type == 'Int') { + if ($hex == '00') { + return (is_null($default)) ? 0 : $default; + } + + return hexdec($hex); + } elseif ($type == 'Bool') { + return ($hex == "01"); + } + break; + default: + throw new InvalidArgumentException("Datatype not known"); + } + + return false; + } +} diff --git a/tests/.gitkeep b/tests/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/tests/ReadSws_test.php b/tests/ReadSws_test.php new file mode 100644 index 0000000..2298517 --- /dev/null +++ b/tests/ReadSws_test.php @@ -0,0 +1,105 @@ +. + * + * 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. + */ + +use Blackbirdchess\Service\Import\IOFactory; + +require_once '../vendor/autoload.php'; + +$sws = IOFactory::createReader('Swar-4'); +$sws->read('../res/testswar.swar'); + +echo "Release: " . $sws->Release . PHP_EOL; +echo "Name: " . $sws->Tournament->Name . PHP_EOL; +echo "Organiser: " . $sws->Tournament->Organiser . PHP_EOL; +echo "TempoIndex: " . $sws->Tournament->TempoIndex . PHP_EOL; +echo "TempoType: " . $sws->Tournament->TournoiStd . PHP_EOL; +echo "Tempo: " . $sws->Tournament->Tempo . PHP_EOL; +echo "Place: " . $sws->Tournament->OrganiserPlace . PHP_EOL; +echo "Arbiter 1: " . $sws->Tournament->Arbiters[ 0 ] . PHP_EOL; +echo "Arbiter 2: " . $sws->Tournament->Arbiters[ 1 ] . PHP_EOL; +echo "Rounds: " . $sws->Tournament->NoOfRounds . PHP_EOL; +echo "Fidehomol: " . $sws->Tournament->FideHomol . PHP_EOL; +echo "Start-Date: " . $sws->Tournament->StartDate->format('d/m/Y') . PHP_EOL; +echo "End-Date: " . $sws->Tournament->EndDate->format('d/m/Y') . PHP_EOL; +echo "System: " . $sws->Tournament->System->getKey() . PHP_EOL; +echo "Place: " . $sws->Tournament->OrganiserPlace . PHP_EOL; +echo "Unrated-Elo: " . $sws->Tournament->NonRatedElo . PHP_EOL; +echo "Federation: " . $sws->Tournament->Federation . PHP_EOL; +echo "Organiser: " . $sws->Tournament->OrganiserClubNo . PHP_EOL; +echo "Fide Elo P1: " . $sws->Tournament->PlayerById(0)->getElo('Fide') . PHP_EOL; +echo "Fide Elo P2: " . $sws->Tournament->PlayerById(1)->getElo('Fide') . PHP_EOL; +echo "Fide Elo P3: " . $sws->Tournament->PlayerById(2)->getElo('Fide') . PHP_EOL; +echo "KBSB Elo P1: " . $sws->Tournament->PlayerById(0)->getElo('Nation') . PHP_EOL; +echo "KBSB Elo P2: " . $sws->Tournament->PlayerById(1)->getElo('Nation') . PHP_EOL; +echo "KBSB Elo P3: " . $sws->Tournament->PlayerById(2)->getElo('Nation') . PHP_EOL; +echo "Name P1: " . $sws->Tournament->PlayerById(0)->Name . PHP_EOL; +echo "Name P2: " . $sws->Tournament->PlayerById(1)->Name . PHP_EOL; +echo "Name P3: " . $sws->Tournament->PlayerById(2)->Name . PHP_EOL; +echo "Gender P1: " . $sws->Tournament->PlayerById(0)->Gender->getKey() . PHP_EOL; +echo "Gender P2: " . $sws->Tournament->PlayerById(1)->Gender->getKey() . PHP_EOL; +echo "Gender P3: " . $sws->Tournament->PlayerById(2)->Gender->getKey() . PHP_EOL; +echo "Absent P1: " . $sws->Tournament->PlayerById(0)->Absent . PHP_EOL; +echo "Absent P2: " . $sws->Tournament->PlayerById(1)->Absent . PHP_EOL; +echo "Absent P3: " . $sws->Tournament->PlayerById(2)->Absent . PHP_EOL; +echo "Category P1: " . $sws->Tournament->PlayerById(0)->Category . PHP_EOL; +echo "Category P2: " . $sws->Tournament->PlayerById(1)->Category . PHP_EOL; +echo "Category P3: " . $sws->Tournament->PlayerById(2)->Category . PHP_EOL; +echo "Date Round 1: " . $sws->Tournament->RoundByNo(0)->Date->format('d/m/Y') . PHP_EOL; +echo "Date Round 2: " . $sws->Tournament->RoundByNo(1)->Date->format('d/m/Y') . PHP_EOL; +echo "Date Round 3: " . $sws->Tournament->RoundByNo(2)->Date->format('d/m/Y') . PHP_EOL; +echo "Game Round 1: " . $sws->Tournament->RoundByNo(0)->Games[ 0 ]->Result->getValue() . PHP_EOL; +echo "Game Round 2: " . $sws->Tournament->RoundByNo(1)->Games[ 0 ]->Result->getValue() . PHP_EOL; +echo "Game Round 3: " . $sws->Tournament->RoundByNo(2)->Games[ 0 ]->Result->getValue() . PHP_EOL; +echo "Color Pairing 1: " . $sws->Tournament->Pairings[ 1 ]->Color->getKey() . PHP_EOL; +echo "Color Pairing 2: " . $sws->Tournament->Pairings[ 2 ]->Color->getKey() . PHP_EOL; +echo "Color Pairing 3: " . $sws->Tournament->Pairings[ 3 ]->Color->getKey() . PHP_EOL; +echo "Player Pairing 1: " . $sws->Tournament->Pairings[ 0 ]->Player->Name . PHP_EOL; +echo "Player Pairing 2: " . $sws->Tournament->Pairings[ 1 ]->Player->Name . PHP_EOL; +echo "Player Pairing 3: " . $sws->Tournament->Pairings[ 2 ]->Player->Name . PHP_EOL; +echo "Bye Round 1: " . $sws->Tournament->RoundByNo(2)->Bye[ 0 ]->Player->Name . PHP_EOL; +echo "Absent Round 1: " . $sws->Tournament->RoundByNo(2)->Absent[ 0 ]->Player->Name . PHP_EOL; +echo "Tiebreak 1: " . $sws->Tournament->Tiebreaks[ 0 ]->getValue() . PHP_EOL; +echo "Tiebreak 2: " . $sws->Tournament->Tiebreaks[ 1 ]->getValue() . PHP_EOL; +echo "Tiebreak 3: " . $sws->Tournament->Tiebreaks[ 2 ]->getValue() . PHP_EOL; +echo "Tiebreak 4: " . $sws->Tournament->Tiebreaks[ 3 ]->getValue() . PHP_EOL; +echo "Tiebreak 5: " . $sws->Tournament->Tiebreaks[ 4 ]->getValue() . PHP_EOL; +echo "Tiebreak 6: " . $sws->Tournament->Tiebreaks[ 5 ]->getValue() . PHP_EOL; +echo "Average Elo: " . $sws->Tournament->AverageElo . PHP_EOL; +foreach ($sws->Tournament->RankingForCategory('+2500') as $player) { + echo str_pad($player->Name . '(' . $player->getElo($sws->Tournament->PriorityElo) . ') ', 35) . + implode_pad(' ', $player->Tiebreaks, 5, ' ') . + PHP_EOL; +} + +function implode_pad($glue, $collection, $padlength, $padstring): string +{ + $newarray = []; + foreach ($collection as $elem) { + $newarray[] = str_pad($elem, $padlength, $padstring); + } + + return implode($glue, $newarray); +}