From 0a8d74e0d6540f754267c6aa60e4a9f45457dca8 Mon Sep 17 00:00:00 2001 From: "R. Eric Wheeler" Date: Sat, 4 Nov 2017 11:33:44 -0700 Subject: [PATCH] Initial commit --- .gitignore | 9 + .php_cs | 50 ++ LICENSE | 674 ++++++++++++++++++ README.md | 18 + bin/console | 45 ++ composer.json | 50 ++ config/config.json | 16 + grumphp.yml | 41 ++ header.txt | 14 + phpcs.xml.dist | 48 ++ phpunit.xml.dist | 27 + response.code.txt | 10 + src/Sikofitt/.keep | 0 src/Sikofitt/Yamaha/AV/Client/Client.php | 127 ++++ src/Sikofitt/Yamaha/AV/Client/System.php | 63 ++ src/Sikofitt/Yamaha/AV/Client/Zone.php | 239 +++++++ .../Yamaha/AV/Command/CommandInterface.php | 37 + .../AV/Command/ConfigurationCommand.php | 204 ++++++ .../Yamaha/AV/Command/MuteCommand.php | 56 ++ .../AV/Command/ToggleCommandInterface.php | 27 + .../Console/Command/CreateApiTokenCommand.php | 88 +++ .../Console/Command/CreateDatabaseCommand.php | 152 ++++ .../AV/Console/Command/CreateUserCommand.php | 237 ++++++ .../AV/Console/Command/InputCommand.php | 77 ++ .../Yamaha/AV/Console/Command/MuteCommand.php | 86 +++ .../AV/Console/Command/StatusCommand.php | 88 +++ .../AV/Console/Command/VolumeCommand.php | 81 +++ .../Yamaha/AV/Controller/SystemController.php | 72 ++ .../Yamaha/AV/Controller/UserController.php | 57 ++ .../AV/Provider/AuthenticationProvider.php | 75 ++ .../Yamaha/AV/Repository/UserRepository.php | 167 +++++ .../Yamaha/AV/Security/UserAuthChecker.php | 79 ++ tests/Sikofitt/Tests/.keep | 0 web/index.php | 94 +++ 34 files changed, 3108 insertions(+) create mode 100644 .gitignore create mode 100644 .php_cs create mode 100644 LICENSE create mode 100644 README.md create mode 100755 bin/console create mode 100644 composer.json create mode 100644 config/config.json create mode 100644 grumphp.yml create mode 100644 header.txt create mode 100644 phpcs.xml.dist create mode 100644 phpunit.xml.dist create mode 100644 response.code.txt create mode 100644 src/Sikofitt/.keep create mode 100644 src/Sikofitt/Yamaha/AV/Client/Client.php create mode 100644 src/Sikofitt/Yamaha/AV/Client/System.php create mode 100644 src/Sikofitt/Yamaha/AV/Client/Zone.php create mode 100644 src/Sikofitt/Yamaha/AV/Command/CommandInterface.php create mode 100644 src/Sikofitt/Yamaha/AV/Command/ConfigurationCommand.php create mode 100644 src/Sikofitt/Yamaha/AV/Command/MuteCommand.php create mode 100644 src/Sikofitt/Yamaha/AV/Command/ToggleCommandInterface.php create mode 100644 src/Sikofitt/Yamaha/AV/Console/Command/CreateApiTokenCommand.php create mode 100644 src/Sikofitt/Yamaha/AV/Console/Command/CreateDatabaseCommand.php create mode 100644 src/Sikofitt/Yamaha/AV/Console/Command/CreateUserCommand.php create mode 100644 src/Sikofitt/Yamaha/AV/Console/Command/InputCommand.php create mode 100644 src/Sikofitt/Yamaha/AV/Console/Command/MuteCommand.php create mode 100644 src/Sikofitt/Yamaha/AV/Console/Command/StatusCommand.php create mode 100644 src/Sikofitt/Yamaha/AV/Console/Command/VolumeCommand.php create mode 100644 src/Sikofitt/Yamaha/AV/Controller/SystemController.php create mode 100644 src/Sikofitt/Yamaha/AV/Controller/UserController.php create mode 100644 src/Sikofitt/Yamaha/AV/Provider/AuthenticationProvider.php create mode 100644 src/Sikofitt/Yamaha/AV/Repository/UserRepository.php create mode 100644 src/Sikofitt/Yamaha/AV/Security/UserAuthChecker.php create mode 100644 tests/Sikofitt/Tests/.keep create mode 100644 web/index.php diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c15d2dd --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +.idea/ +*~ +vendor/ +composer.lock +.php_cs.cache + +logs + +config/app.db diff --git a/.php_cs b/.php_cs new file mode 100644 index 0000000..0fa2ece --- /dev/null +++ b/.php_cs @@ -0,0 +1,50 @@ +setRiskyAllowed(true) + ->setRules( + [ + '@PSR2' => true, + '@PHP70Migration' => true, + '@PHP70Migration:risky' => true, + '@PHP71Migration' => true, + '@PHP71Migration:risky' => true, + 'header_comment' => ['header' => $header], + 'ordered_class_elements' => true, + 'ordered_imports' => true, + 'no_mixed_echo_print' => ['use' => 'print'], + 'strict_param' => true, + 'strict_comparison' => true, + 'single_import_per_statement' => false, + 'phpdoc_order' => true, + 'array_syntax' => ['syntax' => 'short'], + 'phpdoc_add_missing_param_annotation' => true, + 'psr4' => true, + 'phpdoc_var_without_name' => false, + 'no_extra_consecutive_blank_lines' => [ + 'break', + 'continue', + 'extra', + 'return', + 'throw', + 'parenthesis_brace_block', + 'square_brace_block', + 'curly_brace_block', + ], + ] + )->setFinder( + PhpCsFixer\Finder::create() + ->ignoreDotFiles(true) + ->ignoreVCS(true) + ->name('*.php') + ->in([ + 'src', + 'tests', + ]) + ); \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..eebb53d --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + atom-parser + Copyright (C) 2017 R. Eric Wheeler + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + sikofitt/atom-parser Copyleft (C) 2017 R. Eric Wheeler + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..63b3df8 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# sikofitt/skeleton + +This is a project you are probably not interested in. +It is just a simple skeleton that has preset dev dependencies and configuration files. + +Feel free to use it. You just have to change the namespace, package name and description. + +### Composer +`curl -LSs https://getcomposer.org/installer|php` + +`composer.phar create-project sikofitt/skeleton:dev-master dir/` + +### License +[GPL-3.0](https://repos.bgemi.net/sikofitt/skeleton/blob/master/LICENSE) + +### Contribute + +Go for it. diff --git a/bin/console b/bin/console new file mode 100755 index 0000000..2b7f193 --- /dev/null +++ b/bin/console @@ -0,0 +1,45 @@ +#!/usr/bin/env php +getParameterOption(['--env', '-e'], getenv('SILEX_ENV') ?: 'dev'); +$debug = getenv('SILEX_DEBUG') !== '0' && !$input->hasParameterOption(['--no-debug', '']) && $env !== 'prod'; +if($debug){ + Debug::enable(); +} + +$application = new Application('Yamaha AV Console', '0.0.x-dev'); +$connection = new \Doctrine\DBAL\Connection([ + 'driver' => 'pdo_sqlite', + 'path' => __DIR__.'/../config/app.db', + 'charset' => 'utf8mb4', + 'collate' => 'utf8mb4_unicode_ci', +], new Doctrine\DBAL\Driver\PDOSqlite\Driver()); +\Doctrine\DBAL\Types\Type::addType('uuid', \Ramsey\Uuid\Doctrine\UuidType::class); + +$application->getDefinition() + ->addOptions([new \Symfony\Component\Console\Input\InputOption('zone', 'z', \Symfony\Component\Console\Input\InputOption::VALUE_REQUIRED, 'Which zone to interact with', 'main')]); +$application->add(new \Sikofitt\Yamaha\AV\Console\Command\MuteCommand()); +$application->add(new \Sikofitt\Yamaha\AV\Console\Command\VolumeCommand()); +$application->add(new \Sikofitt\Yamaha\AV\Console\Command\StatusCommand($connection)); +$application->add(new \Sikofitt\Yamaha\AV\Console\Command\InputCommand()); +$application->add(new \Sikofitt\Yamaha\AV\Command\ConfigurationCommand(__DIR__.'/..')); +$application->add(new \Sikofitt\Yamaha\AV\Console\Command\CreateDatabaseCommand($connection)); +$application->add(new \Sikofitt\Yamaha\AV\Console\Command\CreateUserCommand($connection)); +$application->add(new \Sikofitt\Yamaha\AV\Console\Command\CreateApiTokenCommand(new \Sikofitt\Yamaha\AV\Repository\UserRepository($connection))); +$application->run($input); diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..0deae6b --- /dev/null +++ b/composer.json @@ -0,0 +1,50 @@ +{ + "name": "sikofitt/yamaha-av", + "description": "Skeleton PHP project set up with some default dev stuff.", + "type": "project", + "require": { + "php": ">=7.1", + "ext-sqlite3": ">=7.1", + "dflydev/dot-access-data": "^1.1", + "doctrine/dbal": "~2.2", + "guzzlehttp/guzzle": "^6.3", + "monolog/monolog": "^1.23", + "ramsey/uuid-doctrine": "^1.4", + "symfony/cache": "^3.3|^4.0" + }, + "autoload": { + "psr-4": { + "Sikofitt\\Yamaha\\AV\\": "src/Sikofitt/Yamaha/AV" + } + }, + "require-dev": { + "friendsofphp/php-cs-fixer": "^2.6", + "phpro/grumphp": "^0.12.0", + "phpstan/phpstan": "^0.8.5", + "phpunit/phpunit": "~5.7|~6.3", + "sensiolabs/security-checker": "^4.1", + "squizlabs/php_codesniffer": "^3.1", + "symfony/var-dumper": "^3.3" + }, + "autoload-dev": { + "psr-4": { + "Sikofitt\\Tests\\": "tests/Sikofitt/Tests" + } + }, + "license": "GPL-3.0", + "authors": [ + { + "name": "R. Eric Wheeler", + "email": "sikofitt@gmail.com", + "homepage": "https://sikofitt.com", + "role": "developer" + } + ], + "extra": { + + }, + "config": { + "sort-packages": true + } + +} diff --git a/config/config.json b/config/config.json new file mode 100644 index 0000000..ff27816 --- /dev/null +++ b/config/config.json @@ -0,0 +1,16 @@ +{ + "settings": { + "volume": "40", + "zone": "main", + "address": "10.5.7.230" + }, + "mappings": { + "audio2": "tv", + "hdmi4": "chromecast", + "chromecast": "hdmi4", + "nexus": "hdmi5", + "chromecastAudio": "av5", + "audio1": "phono", + "phono": "audio1" + } +} \ No newline at end of file diff --git a/grumphp.yml b/grumphp.yml new file mode 100644 index 0000000..a5509b1 --- /dev/null +++ b/grumphp.yml @@ -0,0 +1,41 @@ +parameters: + git_dir: . + bin_dir: vendor/bin + tasks: + composer: + file: ./composer.json + no_check_all: false + no_check_lock: false + no_check_publish: false + no_local_repository: false + with_dependencies: false + strict: false + phpcsfixer2: + allow_risky: true + cache_file: ~ + config: .php_cs + rules: [] + using_cache: false + config_contains_finder: true + verbose: true + diff: false + triggered_by: ['php'] + phpunit: + always_execute: true + phpstan: + autoload_file: vendor/autoload.php + level: 7 + triggered_by: ['php'] + phpversion: + project: '7.1' + phpcs: + standard: PSR2 + show_warnings: true + encoding: UTF8 + triggered_by: [php] + securitychecker: + run_always: false + xmllint: + dtd_validation: true + scheme_validation: true + triggered_by: ['xml'] diff --git a/header.txt b/header.txt new file mode 100644 index 0000000..e0e74a0 --- /dev/null +++ b/header.txt @@ -0,0 +1,14 @@ + Copyleft (C) 2017 http://sikofitt.com sikofitt@gmail.com + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . \ No newline at end of file diff --git a/phpcs.xml.dist b/phpcs.xml.dist new file mode 100644 index 0000000..fe08548 --- /dev/null +++ b/phpcs.xml.dist @@ -0,0 +1,48 @@ + + + The coding standard for PHP_CodeSniffer itself. + + vendor/autoload.php + bin + src + tests + + */Standards/*/Tests/*\.(inc|css|js) + + + + + + + + + error + + + + error + + + + + error + + + + + + + + + 0 + + + + + + + + + + + diff --git a/phpunit.xml.dist b/phpunit.xml.dist new file mode 100644 index 0000000..2ec6f6e --- /dev/null +++ b/phpunit.xml.dist @@ -0,0 +1,27 @@ + + + + + + + + + + + + tests + + + + + + src + + + diff --git a/response.code.txt b/response.code.txt new file mode 100644 index 0000000..dcfdc8a --- /dev/null +++ b/response.code.txt @@ -0,0 +1,10 @@ +0 Successful request +1 Initializing +2 Internal Error +3 Invalid Request (A method did not exist, a method wasn’t appropriate etc.) +4 Invalid Parameter (Out of range, invalid characters etc.) +5 Guarded (Unable to setup in current status etc.) +6 Time Out +99 Firmware Updating +(100s are Streaming Service related errors) +100 Access Error \ No newline at end of file diff --git a/src/Sikofitt/.keep b/src/Sikofitt/.keep new file mode 100644 index 0000000..e69de29 diff --git a/src/Sikofitt/Yamaha/AV/Client/Client.php b/src/Sikofitt/Yamaha/AV/Client/Client.php new file mode 100644 index 0000000..43f6982 --- /dev/null +++ b/src/Sikofitt/Yamaha/AV/Client/Client.php @@ -0,0 +1,127 @@ +. + */ + +namespace Sikofitt\Yamaha\AV\Client; + +use Psr\Http\Message\ResponseInterface; + +class Client extends \GuzzleHttp\Client +{ + public const SUCCESS = 0; + public const INITIALIZING = 1; + public const INTERNAL_ERROR = 2; + public const INVALID_REQUEST = 3; + public const INVALID_PARAM = 4; + public const GUARDED = 5; + public const TIMEOUT = 6; + public const FIRMWARE_UPDATING = 99; + public const ACCESS_ERROR = 100; + public const OTHER_ERRORS = 101; + public const WRONG_USER_NAME = 102; + public const WRONG_PASSWORD = 103; + public const ACCOUNT_EXPIRED = 104; + public const ACCOUNT_DISCONNECTED = 105; + public const ACCOUNT_REACHED_LIMIT = 106; + public const SERVER_MAINTENANCE = 107; + public const INVALID_ACCOUNT = 108; + public const LICENSE_ERROR = 109; + public const READ_ONLY_MODE = 110; + public const MAX_STATIONS = 111; + public const ACCESS_DENIED = 112; + public const UNKNOWN_ERROR = 36200; + public const INVALID_RECEIVER_INPUT = 36201; + + public const RESPONSE_MAP = [ + self::SUCCESS => 'Successful request', + self::INITIALIZING => 'Initializing', + self::INTERNAL_ERROR => 'Internal Error', + self::INVALID_REQUEST => 'Invalid Request (A method does not exist, or was not appropriate.)', + self::INVALID_PARAM => 'Invalid Parameter (Out of range, invalid characters etc.)', + self::GUARDED => 'Guarded (Unable to setup in current status.)', + self::TIMEOUT => 'Time Out', + self::FIRMWARE_UPDATING => 'Firmware Updating', + self::ACCESS_ERROR => 'Access Error', + self::OTHER_ERRORS => 'Other Errors', + self::WRONG_USER_NAME => 'Wrong User Name', + self::WRONG_PASSWORD => 'Wrong Password', + self::ACCOUNT_EXPIRED => 'Account Expired', + self::ACCOUNT_DISCONNECTED => 'Account Disconnected / Gone Off / Shut Down', + self::ACCOUNT_REACHED_LIMIT => 'Account Number Reached to the Limit', + self::SERVER_MAINTENANCE => 'Server Maintenance', + self::INVALID_ACCOUNT => 'Invalid Account', + self::LICENSE_ERROR => 'License Error', + self::READ_ONLY_MODE => 'Read Only Mode', + self::MAX_STATIONS => 'Max Stations', + self::ACCESS_DENIED => 'Access Denied', + self::UNKNOWN_ERROR => 'Unknown Error', + self::INVALID_RECEIVER_INPUT => 'Input channel does not exist.', + ]; + + public const VOLUME_DIRECTION_UP = 'up'; + public const VOLUME_DIRECTION_DOWN = 'down'; + private const APIBASE = '/YamahaExtendedControl/v2/'; + + private $cacheTimeout; + + public function __construct(string $receiverBaseUri, $cacheTimeout = null) + { + $this->cacheTimeout = $cacheTimeout; + + if (null === $cacheTimeout) { + $this->cacheTimeout = new \DateTime('now +1 hour'); + } + + $baseUri = sprintf('%s', rtrim($receiverBaseUri, '/')); + $baseUri .= self::APIBASE; + + if (false === strpos($baseUri, '://')) { + $baseUri = sprintf('http://%s', $baseUri); + } + + parent::__construct([ + 'base_uri' => $baseUri, + 'http_errors' => false, + ]); + } + + public function boolToStr(bool $value): string + { + return $value ? 'true' : 'false'; + } + + public function getCacheTimeOut(): \DateTime + { + return $this->cacheTimeout; + } + + protected function checkResponse(ResponseInterface $response): bool + { + return 200 === $response->getStatusCode(); + } + + private function floatToStr(float $value): string + { + return (string)$value; + } + + private function intToStr(int $value): string + { + return (string)$value; + } +} diff --git a/src/Sikofitt/Yamaha/AV/Client/System.php b/src/Sikofitt/Yamaha/AV/Client/System.php new file mode 100644 index 0000000..513dee0 --- /dev/null +++ b/src/Sikofitt/Yamaha/AV/Client/System.php @@ -0,0 +1,63 @@ +. + */ + +namespace Sikofitt\Yamaha\AV\Client; + +use Psr\Http\Message\ResponseInterface; + +class System +{ + private $client; + + public function __construct(Client $client) + { + $this->client = $client; + } + + public function getFeatures(): array + { + $cache = null; + + if (file_exists(sys_get_temp_dir() . '/yamaha-av-features.array')) { + $cache = unserialize(base64_decode(file_get_contents(sys_get_temp_dir() .'/yamaha-av-features.array'), true), [__CLASS__]); + } + + if (null !== $cache && $this->client->getCacheTimeOut() < $cache['date']) { + print 'Returning Cache'; + return $cache['features']; + } + + $features = $this->client->get('system/getFeatures'); + + if ($this->checkResponse($features)) { + $features = \json_decode($features->getBody()->getContents(), true); + $cache['date'] = new \DateTime('now'); + $cache['features'] = $features; + file_put_contents(sys_get_temp_dir() . '/yamaha-av-features.array', base64_encode(serialize($cache))); + return $features; + } + + return []; + } + + protected function checkResponse(ResponseInterface $response): bool + { + return 200 === $response->getStatusCode(); + } +} diff --git a/src/Sikofitt/Yamaha/AV/Client/Zone.php b/src/Sikofitt/Yamaha/AV/Client/Zone.php new file mode 100644 index 0000000..2deac06 --- /dev/null +++ b/src/Sikofitt/Yamaha/AV/Client/Zone.php @@ -0,0 +1,239 @@ +. + */ + +namespace Sikofitt\Yamaha\AV\Client; + +use Psr\Http\Message\ResponseInterface; + +class Zone +{ + private $client; + private $zone; + + public function __construct(Client $client, string $zone = 'main') + { + $this->client = $client; + $this->zone = $zone; + } + + public function setZone(string $zone = 'main'): Zone + { + $this->zone = $zone; + + return $this; + } + + public function getZone(): string + { + return $this->zone; + } + + public function getStatus(): array + { + $response = $this->client->get($this->zone . '/getStatus'); + if (200 === $response->getStatusCode()) { + return \json_decode($response->getBody()->getContents(), true); + } + + return []; + } + + public function getZoneInfo(string $zone = 'main'): array + { + $system = new System($this->client); + $features = $system->getFeatures(); + foreach ($features['zone'] as $key => $value) { + if (isset($value['id']) && $zone === $value['id']) { + return $value; + } + } + + return []; + } + + public function getInputsForZone(string $zone = 'main'): array + { + $zoneInfo = $this->getZoneInfo($zone); + + if (false === empty($zoneInfo)) { + return $zoneInfo['input_list']; + } + + return []; + } + + public function setPower(string $setting = null): int + { + if(null === $setting) { + return Client::INVALID_PARAM; + } + + $setting = strtolower($setting); + + if (false === in_array($setting, ['on', 'standby', 'off'], true)) { + throw new \InvalidArgumentException('Accepted values for power are "on, standby, and off".'); + } + + if ('off' === $setting) { + $setting = 'standby'; + } + + $response = $this->client->get($this->zone . '/setPower', [ + 'query' => [ + 'power' => $setting, + ] + ]); + + if ($this->checkResponse($response)) { + $body = json_decode($response->getBody()->getContents(), true); + return (int)$body['response_code']; + } + + return Client::UNKNOWN_ERROR; + } + + public function setInput(string $input): int + { + $inputs = $this->getInputsForZone($this->zone); + + if (array_key_exists($input, array_flip($inputs))) { + $response = $this->client->get($this->zone . '/setInput', [ + 'query' => [ + 'input' => $input, + ], + ]); + + if ($this->checkResponse($response)) { + $body = json_decode($response->getBody()->getContents(), true); + return (int)$body['response_code']; + } + + return Client::UNKNOWN_ERROR; + } + + return Client::INVALID_RECEIVER_INPUT; + } + + public function setMute(bool $enable = true): int + { + $response = $this->client->get($this->zone . '/setMute', [ + 'query' => [ + 'enable' => $this->client->boolToStr($enable) + ] + ]); + + if (200 === $response->getStatusCode()) { + $body = json_decode($response->getBody()->getContents(), true); + return (int)$body['response_code']; + } + + return Client::UNKNOWN_ERROR; + } + + public function changeVolume(int $level = 81): int + { + $status = $this->getStatus(); + + $levels = range(1, (int)$status['max_volume']); + $levels2 = range(80, 0, 0.5); + $volumeMap = array_combine(array_values($levels), $levels2); + $volumeMap = array_map(function ($value) { + return (string)$value; + }, $volumeMap); + + $volumeMap = array_flip($volumeMap); + $volume = $volumeMap[(string)$level] ?? null; + + if (null === $volumeMap) { + throw new \Exception('Volume setting doesn\'t exist'); + } + + $volume = $volume > (int)$status['max_volume'] ? (int)$status['max_volume'] : $volume; + + $response = $this->client->get($this->zone . '/setVolume', [ + 'query' => [ + 'volume' => $volume, + ], + ]); + + if ($this->checkResponse($response)) { + $body = json_decode($response->getBody()->getContents(), true); + return (int)$body['response_code']; + } + + return Client::UNKNOWN_ERROR; + } + + public function changeVolumeByPercent(float $percent): int + { + $status = $this->getStatus(); + $volume = ceil(($percent / 100) * $status['max_volume']); + $response = $this->client->get($this->zone . '/setVolume', [ + 'query' => [ + 'volume' => $volume, + ], + ]); + + if ($this->checkResponse($response)) { + $body = json_decode($response->getBody()->getContents(), true); + return (int)$body['response_code']; + } + + return Client::UNKNOWN_ERROR; + } + + public function increaseVolume(float $step = 1): int + { + $response = $this->client->get($this->zone . '/setVolume', [ + 'query' => [ + 'volume' => 'up', + 'step' => $step, + ], + ]); + + if ($this->checkResponse($response)) { + $body = json_decode($response->getBody()->getContents(), true); + return (int)$body['response_code']; + } + + return Client::UNKNOWN_ERROR; + } + + public function decreaseVolume(float $step = 1): int + { + $response = $this->client->get($this->zone . '/setVolume', [ + 'query' => [ + 'volume' => 'down', + 'step' => $step, + ], + ]); + + if ($this->checkResponse($response)) { + $body = json_decode($response->getBody()->getContents(), true); + return (int)$body['response_code']; + } + + return Client::UNKNOWN_ERROR; + } + + protected function checkResponse(ResponseInterface $response): bool + { + return 200 === $response->getStatusCode(); + } +} diff --git a/src/Sikofitt/Yamaha/AV/Command/CommandInterface.php b/src/Sikofitt/Yamaha/AV/Command/CommandInterface.php new file mode 100644 index 0000000..a91b142 --- /dev/null +++ b/src/Sikofitt/Yamaha/AV/Command/CommandInterface.php @@ -0,0 +1,37 @@ +. + */ + +namespace Sikofitt\Yamaha\AV\Command; + +interface CommandInterface +{ + public const TOGGLE = 1; + + /** + * This should be the endpoint without the YamahaExtendedControl/v? + * It could be 'main/setMute' for example. + * + * You can use {zone} as a replacement for the current zone. + * + * @return string + */ + public static function getEndPoint(): string; + + public static function getType(): string; +} diff --git a/src/Sikofitt/Yamaha/AV/Command/ConfigurationCommand.php b/src/Sikofitt/Yamaha/AV/Command/ConfigurationCommand.php new file mode 100644 index 0000000..e057a86 --- /dev/null +++ b/src/Sikofitt/Yamaha/AV/Command/ConfigurationCommand.php @@ -0,0 +1,204 @@ +. + */ + +namespace Sikofitt\Yamaha\AV\Command; + +use Dflydev\DotAccessData\Data; +use Symfony\Component\Console\Command\Command; +use Symfony\Component\Console\Exception\InvalidArgumentException; +use Symfony\Component\Console\Exception\LogicException; +use Symfony\Component\Console\Exception\RuntimeException; +use Symfony\Component\Console\Input\InputArgument; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Output\OutputInterface; +use Symfony\Component\Console\Style\SymfonyStyle; +use Symfony\Component\Filesystem\Filesystem; + +/** + * Sets, Deletes, and Gets configuration values. + */ +class ConfigurationCommand extends Command +{ + private $directory; + + /** + * @var SymfonyStyle + */ + private $io; + + /** + * @var string + */ + private $configFile; + + /** + * {@inheritDoc} + * + * @throws \Symfony\Component\Console\Exception\RuntimeException + */ + public function __construct(string $directory) + { + if (false === is_dir($directory)) { + throw new RuntimeException(sprintf('%s does not exist', $directory)); + } + + $this->directory = $directory; + $this->configFile = sprintf('%s/config/config.json', $this->directory); + + parent::__construct(); + } + + /** + * {@inheritDoc} + * + * @throws \Symfony\Component\Console\Exception\InvalidArgumentException + */ + public function configure(): void + { + $this->setName('config') + ->setDescription('set and get config items') + ->addArgument('action', InputArgument::REQUIRED, 'This can either be set or get') + ->addArgument('key', InputArgument::REQUIRED, 'Item key') + ->addArgument('value', InputArgument::OPTIONAL, 'Value to set.'); + } + + /** + * {@inheritDoc} + * + * @throws \Symfony\Component\Console\Exception\InvalidArgumentException + * @throws \Symfony\Component\Console\Exception\LogicException + */ + public function interact(InputInterface $input, OutputInterface $output): void + { + $this->ensureActionExists($input->getArgument('action')); + $this->setIo($input, $output); + + if (strtolower($input->getArgument('action')) === 'set') { + if (null === $input->getArgument('value')) { + throw new LogicException('Can\'t set an item without a value'); + } + } + } + + /** + * {@inheritDoc} + * + * @throws \Symfony\Component\Console\Exception\InvalidArgumentException + * @throws \Symfony\Component\Console\Exception\RuntimeException + * @throws \Symfony\Component\Filesystem\Exception\IOException + */ + public function execute(InputInterface $input, OutputInterface $output) + { + $action = $input->getArgument('action'); + $key = $input->getArgument('key'); + $value = $input->getArgument('value'); + + $this->createConfigIfNotExists(); + + $configData = \json_decode(file_get_contents($this->configFile), true); + + if (null === $configData) { + throw new RuntimeException('jSON : ' . json_last_error_msg(), json_last_error()); + } + + $config = new Data($configData); + + switch (strtolower($action)) { + case 'set': + $config->set($key, $value); + $result = file_put_contents($this->configFile, \json_encode($config->export(), JSON_PRETTY_PRINT)); + return is_bool($result) ? (int)$result : $result; + break; + case 'get': + $this->io->writeln($config->get($key)); + return 0; + break; + case 'del': + case 'delete': + case 'remove': + $config->remove($key); + $result = file_put_contents($this->configFile, \json_encode($config->export(), JSON_PRETTY_PRINT)); + return is_bool($result) ? (int)$result : $result; + break; + default: + throw new InvalidArgumentException('Action ' . $action . ' does not exist. Actions are set, get and del'); + break; + } + } + + /** + * @param \Symfony\Component\Console\Input\InputInterface $input + * @param \Symfony\Component\Console\Output\OutputInterface $output + */ + public function setIo(InputInterface $input, OutputInterface $output): void + { + $this->io = new SymfonyStyle($input, $output); + } + + /** + * @throws \Symfony\Component\Console\Exception\RuntimeException + * @throws \Symfony\Component\Filesystem\Exception\IOException + * @return bool + * + */ + private function createConfigIfNotExists(): bool + { + $fileSystem = new Filesystem(); + + if (false === $fileSystem->exists($this->configFile)) { + $this->io->warning(sprintf('Config file %s does not exist.', $this->configFile)); + $this->io->note('Trying to create ...'); + $fileSystem->mkdir([$this->directory . '/config']); + $fileSystem->dumpFile($this->configFile, '{}'); + } + + if (false === file_exists($this->configFile)) { + throw new RuntimeException( + sprintf( + 'Could not create config file in %s/config/config.json', + $this->directory + ) + ); + } + + return true; + } + + /** + * @param string $action + * + * @return bool + */ + private function ensureActionExists(string $action): bool + { + $actions = [ + 'set', + 'get', + 'del', + 'delete', + 'remove', + ]; + + if (array_key_exists($action, array_flip($actions))) { + return true; + } + + return false; + } +} diff --git a/src/Sikofitt/Yamaha/AV/Command/MuteCommand.php b/src/Sikofitt/Yamaha/AV/Command/MuteCommand.php new file mode 100644 index 0000000..f4a6e07 --- /dev/null +++ b/src/Sikofitt/Yamaha/AV/Command/MuteCommand.php @@ -0,0 +1,56 @@ +. + */ + +namespace Sikofitt\Yamaha\AV\Command; + +class MuteCommand implements ToggleCommandInterface +{ + public static function getParam(): string + { + return 'enable'; + } + + public static function on(): string + { + return 'true'; + } + + public static function off(): string + { + return 'false'; + } + + /** + * This should be the endpoint without the YamahaExtendedControl/v? + * It could be 'main/setMute' for example. + * + * You can use {zone} as a replacement for the current zone. + * + * @return string + */ + public static function getEndPoint(): string + { + return '{zone}/setMute'; + } + + public static function getType(): string + { + return CommandInterface::TOGGLE; + } +} diff --git a/src/Sikofitt/Yamaha/AV/Command/ToggleCommandInterface.php b/src/Sikofitt/Yamaha/AV/Command/ToggleCommandInterface.php new file mode 100644 index 0000000..4f2593e --- /dev/null +++ b/src/Sikofitt/Yamaha/AV/Command/ToggleCommandInterface.php @@ -0,0 +1,27 @@ +. + */ + +namespace Sikofitt\Yamaha\AV\Command; + +interface ToggleCommandInterface extends CommandInterface +{ + public static function getParam(): string; + public static function on(): string; + public static function off(): string; +} diff --git a/src/Sikofitt/Yamaha/AV/Console/Command/CreateApiTokenCommand.php b/src/Sikofitt/Yamaha/AV/Console/Command/CreateApiTokenCommand.php new file mode 100644 index 0000000..41ce9f1 --- /dev/null +++ b/src/Sikofitt/Yamaha/AV/Console/Command/CreateApiTokenCommand.php @@ -0,0 +1,88 @@ +. + */ + +namespace Sikofitt\Yamaha\AV\Console\Command; + +use Doctrine\DBAL\Connection; +use Sikofitt\Yamaha\AV\Repository\UserRepository; +use Symfony\Component\Console\Command\Command; +use Symfony\Component\Console\Input\InputArgument; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Output\OutputInterface; +use Symfony\Component\Console\Style\SymfonyStyle; + +/** + * Creates an api token for a user. + * + * {@inheritDoc} + */ +class CreateApiTokenCommand extends Command +{ + /** + * @var UserRepository + */ + private $userRepository; + + /** + * CreateApiTokenCommand constructor. + * + * @param \Sikofitt\Yamaha\AV\Repository\UserRepository $userRepository + * + * @throws \Symfony\Component\Console\Exception\LogicException + */ + public function __construct(UserRepository $userRepository) + { + $this->userRepository = $userRepository; + + parent::__construct(); + } + + /** + * {@inheritDoc} + * + * @throws \Symfony\Component\Console\Exception\InvalidArgumentException + */ + public function configure(): void + { + $this->setName('user:token') + ->setDescription('Creates an api token for the given user.') + ->addArgument('username', InputArgument::REQUIRED, 'The user to create the token for.'); + } + + /** + * {@inheritDoc} + * + * @throws \Symfony\Component\Console\Exception\InvalidArgumentException + */ + public function execute(InputInterface $input, OutputInterface $output): ?int + { + $io = new SymfonyStyle($input, $output); + + $userName = $input->getArgument('username'); + + if (false === $this->userRepository->createApiTokenForUser($userName)) { + $io->error('Failed to created token for user ' . $userName . '. Are you sure the user exists?'); + return 1; + } + + $io->success('Created token for user ' . $userName . '.'); + + return 0; + } +} diff --git a/src/Sikofitt/Yamaha/AV/Console/Command/CreateDatabaseCommand.php b/src/Sikofitt/Yamaha/AV/Console/Command/CreateDatabaseCommand.php new file mode 100644 index 0000000..2362910 --- /dev/null +++ b/src/Sikofitt/Yamaha/AV/Console/Command/CreateDatabaseCommand.php @@ -0,0 +1,152 @@ +. + */ + +namespace Sikofitt\Yamaha\AV\Console\Command; + +use Doctrine\DBAL\Connection; +use Doctrine\DBAL\Exception\TableExistsException; +use Doctrine\DBAL\Schema\Column; +use Doctrine\DBAL\Schema\SchemaConfig; +use Doctrine\DBAL\Schema\Table; +use Doctrine\DBAL\Types\Type; +use Ramsey\Uuid\Doctrine\UuidType; +use Symfony\Component\Console\Command\Command; +use Symfony\Component\Console\Exception\RuntimeException; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Input\InputOption; +use Symfony\Component\Console\Output\OutputInterface; +use Symfony\Component\Console\Question\ConfirmationQuestion; +use Symfony\Component\Console\Style\SymfonyStyle; + +/** + * Creates the database. + */ +class CreateDatabaseCommand extends Command +{ + /** + * @var \Doctrine\DBAL\Connection + */ + private $connection; + + /** + * @param \Doctrine\DBAL\Connection $connection + * + * @throws \Symfony\Component\Console\Exception\LogicException + */ + public function __construct(Connection $connection) + { + $this->connection = $connection; + + parent::__construct($this->getName()); + } + + /** + * {@inheritDoc} + * + * @throws \Symfony\Component\Console\Exception\InvalidArgumentException + */ + public function configure(): void + { + $this + ->setName('db:create') + ->setDescription('Creates the database') + ->addOption( + 'force', + 'f', + InputOption::VALUE_NONE, + 'Force creation if database already exists.' + ); + } + + /** + * {@inheritDoc} + * + * @throws \Symfony\Component\Console\Exception\RuntimeException + * @throws \Symfony\Component\Console\Exception\InvalidArgumentException + */ + public function interact(InputInterface $input, OutputInterface $output): void + { + if (false === extension_loaded('sqlite3')) { + throw new RuntimeException('The sqlite3 extension is required.'); + } + + if (true === $input->getOption('force') && file_exists(realpath($this->connection->getDatabase()))) { + $io = new SymfonyStyle($input, $output); + + $answer = $io->askQuestion(new ConfirmationQuestion( + 'Are you sure you want to remove the database?', + false + )); + if (false === $answer) { + exit(0); + } + + $this->connection->getSchemaManager()->dropTable('users'); + } + } + + /** + * {@inheritDoc} + * + * @throws \Symfony\Component\Console\Exception\InvalidArgumentException + * + * @throws \Doctrine\DBAL\DBALException + */ + public function execute(InputInterface $input, OutputInterface $output): ?int + { + if (true === $input->getOption('force') && true === $input->getOption('no-interaction')) { + $this->connection->getSchemaManager()->dropTable('users'); + } + + $uniqueOption = [ + 'customSchemaOptions' => [ + 'unique' => true, + ] + ]; + $io = new SymfonyStyle($input, $output); + $table = new Table('users'); + $table->addColumn('id', 'uuid', array_merge($uniqueOption)); + $table->addColumn('user_name', Type::STRING, array_merge($uniqueOption, ['length' => 32])); + $table->addColumn('password', Type::STRING, array_merge($uniqueOption, ['length' => 64])); + $table->addColumn('api_key', Type::STRING, array_merge($uniqueOption, ['length' => 128])); + $table->addColumn('api_secret', Type::STRING, array_merge($uniqueOption, ['length' => 192])); + $table->addColumn('api_token', Type::STRING, array_merge($uniqueOption, ['notnull' => false, 'length' => 240])); + $table->addColumn('api_token_expire', Type::DATETIME, ['notnull' => false]); + $table->addColumn('created_at', Type::DATETIME); + $table->addColumn('updated_at', Type::DATETIME, ['default' => 'CURRENT_TIMESTAMP']); + $table->addUniqueIndex(['id'], 'id_idx'); + $table->addUniqueIndex(['user_name', 'api_key', 'api_secret', 'api_token'], 'uniq_idx'); + $table->addIndex(['id', 'user_name', 'api_key', 'api_secret', 'api_token'], 'search_idx'); + + try { + $this + ->connection + ->getSchemaManager() + ->createTable($table); + } catch (TableExistsException $t) { + $io->error([$t->getMessage(), 'Try the command again using the --force switch or remove the database.']); + return $t->getErrorCode(); + } catch (\Exception $e) { + $io->error($e->getMessage()); + return 1; + } + + return 0; + } +} diff --git a/src/Sikofitt/Yamaha/AV/Console/Command/CreateUserCommand.php b/src/Sikofitt/Yamaha/AV/Console/Command/CreateUserCommand.php new file mode 100644 index 0000000..69233e1 --- /dev/null +++ b/src/Sikofitt/Yamaha/AV/Console/Command/CreateUserCommand.php @@ -0,0 +1,237 @@ +. + */ + +namespace Sikofitt\Yamaha\AV\Console\Command; + +use Doctrine\DBAL\Connection; +use Doctrine\DBAL\Exception\NotNullConstraintViolationException; +use Doctrine\DBAL\Exception\UniqueConstraintViolationException; +use Ramsey\Uuid\Uuid; +use Symfony\Component\Console\Command\Command; +use Symfony\Component\Console\Exception\InvalidArgumentException; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Input\InputOption; +use Symfony\Component\Console\Output\OutputInterface; +use Symfony\Component\Console\Style\SymfonyStyle; + +/** + * Creates a user. + */ +class CreateUserCommand extends Command +{ + /** + * @var \Doctrine\DBAL\Connection + */ + private $connection; + + /** + * @var string + */ + private $userName; + + /** + * @var string + */ + private $password; + + /** + * @param \Doctrine\DBAL\Connection $connection + * + * @throws \Symfony\Component\Console\Exception\LogicException + */ + public function __construct(Connection $connection) + { + $this->connection = $connection; + parent::__construct(); + } + + /** + * {@inheritDoc} + * + * @throws \Symfony\Component\Console\Exception\InvalidArgumentException + */ + public function configure(): void + { + $this + ->setName('user:create') + ->setDescription('Create a new user.') + ->addOption( + 'username', + 'u', + InputOption::VALUE_REQUIRED, + 'The username for the account' + ) + ->addOption( + 'password', + 'p', + InputOption::VALUE_REQUIRED, + 'The password for the account' + ) + ; + } + + /** + * {@inheritDoc} + * + * @throws \Symfony\Component\Console\Exception\InvalidArgumentException + */ + public function interact(InputInterface $input, OutputInterface $output): void + { + $io = new SymfonyStyle($input, $output); + + if (null === $input->getOption('username')) { + $this->userName = $io->ask( + 'Username ', + null, + function ($value) { + return $this->validateUserName($value); + } + ); + } else { + $this->userName = $this->validateUserName($input->getOption('username')); + } + + if (null === $input->getOption('password')) { + $password = $io->askHidden( + 'Password ', + function ($value) { + return $this->validatePassword($value); + } + ); + $this->password = $this->hashPassword($password); + } else { + $password = $this->validatePassword($input->getOption('password')); + $this->password = $this->hashPassword($password); + } + } + + /** + * {@inheritDoc} + * + * @throws \Symfony\Component\Console\Exception\InvalidArgumentException + * @throws \Doctrine\DBAL\DBALException + */ + public function execute(InputInterface $input, OutputInterface $output): ?int + { + if (true === $input->getOption('no-interaction') && + (null === $input->getOption('username') || + null === $input->getOption('password')) + ) { + throw new InvalidArgumentException('The options username and password are required when running in non-interactive mode.'); + } + + if (true === $input->getOption('no-interaction')) { + $this->userName = $this->validateUserName($input->getOption('username')); + $password = $this->validatePassword($input->getOption('password')); + $this->password = $this->hashPassword($password); + } + + $io = new SymfonyStyle($input, $output); + /* + * (user_name, password, api_key, api_secret, created_at); + */ + $sql = + 'INSERT INTO users ' . + '(id, user_name, password, api_key, api_secret, created_at) ' . + 'VALUES(:id, :userName, :password, :apiKey, :apiSecret, CURRENT_TIMESTAMP)'; + + $stmt = $this + ->connection + ->prepare($sql); + + try { + $stmt->execute([ + 'id' => Uuid::uuid4(), + 'userName' => $this->userName, + 'password' => $this->password, + 'apiKey' => $this->generateKey(128), + 'apiSecret' => $this->generateKey(192), + ]); + } catch (UniqueConstraintViolationException $e) { + $message = explode(PHP_EOL, $e->getMessage()); + $io->error([get_class($e), $message[count($message) - 1]]); + return 1; + } catch (NotNullConstraintViolationException $e) { + $message = explode(PHP_EOL, $e->getMessage()); + $io->error([get_class($e), $message[count($message) - 1]]); + return 1; + } catch (\Exception $e) { + $io->error([get_class($e), $e->getMessage()]); + return 1; + } + + return 0; + } + + /** + * Generates a key for the api_key and api_secret. + * + * @param int $length + * + * @return string + */ + private function generateKey(int $length): string + { + $result = base64_encode(bin2hex(random_bytes($length*12))); + return substr($result, 32, $length); + } + + /** + * @param string $value + * + * @throws \Symfony\Component\Console\Exception\InvalidArgumentException + * @return string + * + */ + private function validatePassword(string $value): string + { + if (strlen($value) < 12) { + throw new InvalidArgumentException('Password must be at least 12 characters.'); + } + + return $value; + } + + private function hashPassword(string $password): string + { + /** @noinspection PhpUndefinedConstantInspection */ + $hashingAlgorithm = true === defined('PASSWORD_ARGON2I') + ? PASSWORD_ARGON2I + : PASSWORD_DEFAULT; + + return password_hash($password, $hashingAlgorithm); + } + /** + * @param string $value + * + * @throws \Symfony\Component\Console\Exception\InvalidArgumentException + * @return string + * + */ + private function validateUserName(string $value): string + { + if (strlen($value) > 32) { + throw new InvalidArgumentException('User name must be less than 32 characters.'); + } + if (strlen($value) < 5) { + throw new InvalidArgumentException('User name must be more than 4 characters.'); + } + return $value; + } +} diff --git a/src/Sikofitt/Yamaha/AV/Console/Command/InputCommand.php b/src/Sikofitt/Yamaha/AV/Console/Command/InputCommand.php new file mode 100644 index 0000000..73c3e6f --- /dev/null +++ b/src/Sikofitt/Yamaha/AV/Console/Command/InputCommand.php @@ -0,0 +1,77 @@ +. + */ + +namespace Sikofitt\Yamaha\AV\Console\Command; + +use Sikofitt\Yamaha\AV\Client\Client; +use Sikofitt\Yamaha\AV\Client\Zone; +use Symfony\Component\Console\Command\Command; +use Symfony\Component\Console\Exception\LogicException; +use Symfony\Component\Console\Input\InputArgument; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Output\OutputInterface; + +class InputCommand extends Command +{ + /** + * Configures the current command. + * + * @throws \Symfony\Component\Console\Exception\InvalidArgumentException + */ + public function configure(): void + { + $this->setName('input') + ->setDescription('Sets the receiver input to the specified input.'.PHP_EOL.'Use \'list\' to get a list of available inputs.') + ->addArgument('input', InputArgument::REQUIRED, 'Set the input on the receiver.'); + } + + /** + * Executes the current command. + * + * This method is not abstract because you can use this class + * as a concrete class. In this case, instead of defining the + * execute() method, you set the code to execute by passing + * a Closure to the setCode() method. + * + * @param InputInterface $input An InputInterface instance + * @param OutputInterface $output An OutputInterface instance + * + * @throws \Symfony\Component\Console\Exception\InvalidArgumentException + * @throws LogicException When this abstract method is not implemented + * @return null|int null or 0 if everything went fine, or an error code + * + * + * @see setCode() + */ + public function execute(InputInterface $input, OutputInterface $output): ?int + { + $receiverInput = strtolower($input->getArgument('input')); + $client = new Client('10.5.7.230'); + $zoneClient = new Zone($client, $input->getOption('zone')); + if ('list' === $receiverInput) { + $inputChannels = $zoneClient->getInputsForZone($input->getOption('zone')); + $output->writeln(sprintf('Available channels are : %s', implode(', ', $inputChannels))); + return 0; + } + + $result = $zoneClient->setInput($input->getArgument('input')); + $output->writeln(Client::RESPONSE_MAP[$result]); + return $result; + } +} diff --git a/src/Sikofitt/Yamaha/AV/Console/Command/MuteCommand.php b/src/Sikofitt/Yamaha/AV/Console/Command/MuteCommand.php new file mode 100644 index 0000000..a3d4abb --- /dev/null +++ b/src/Sikofitt/Yamaha/AV/Console/Command/MuteCommand.php @@ -0,0 +1,86 @@ +. + */ + +namespace Sikofitt\Yamaha\AV\Console\Command; + +use PHP_CodeSniffer\Tests\Core\File\testFECNNonExtendedClass; +use Sikofitt\Yamaha\AV\Client\Client; +use Sikofitt\Yamaha\AV\Client\Zone; +use Symfony\Component\Console\Command\Command; +use Symfony\Component\Console\Exception\LogicException; +use Symfony\Component\Console\Input\InputArgument; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Input\InputOption; +use Symfony\Component\Console\Output\OutputInterface; + +class MuteCommand extends Command +{ + /** + * Configures the current command. + * + * @throws \Symfony\Component\Console\Exception\InvalidArgumentException + */ + public function configure(): void + { + $this->setName('mute') + ->setDescription('Mute the AV Receiver.') + ->addArgument('uri', InputArgument::REQUIRED, 'Yamaha Receiver URI') + ->addOption('disable', 'd', InputOption::VALUE_NONE, 'disable mute.'); + } + + /** + * Executes the current command. + * + * This method is not abstract because you can use this class + * as a concrete class. In this case, instead of defining the + * execute() method, you set the code to execute by passing + * a Closure to the setCode() method. + * + * @param InputInterface $input An InputInterface instance + * @param OutputInterface $output An OutputInterface instance + * + * @throws \Symfony\Component\Console\Exception\InvalidArgumentException + * @throws LogicException When this abstract method is not implemented + * @return null|int null or 0 if everything went fine, or an error code + * + * + * @see setCode() + */ + public function execute(InputInterface $input, OutputInterface $output): ?int + { + try { + $zoneOption = strtolower($input->getOption('zone')); + } catch (\Exception $e) { + $zoneOption = 'main'; + } + + $avClient = new Client($input->getArgument('uri')); + $client = new Zone($avClient, $input->getOption('zone')); + $status = $client->getStatus(); + if (isset($status['mute'])) { + $commandResult = $client->setMute(!$status['mute']); + if (isset(Client::RESPONSE_MAP[$commandResult])) { + $output->writeln(Client::RESPONSE_MAP[$commandResult]); + return $commandResult; + } + } + + return Client::UNKNOWN_ERROR; + } +} diff --git a/src/Sikofitt/Yamaha/AV/Console/Command/StatusCommand.php b/src/Sikofitt/Yamaha/AV/Console/Command/StatusCommand.php new file mode 100644 index 0000000..6cfb32c --- /dev/null +++ b/src/Sikofitt/Yamaha/AV/Console/Command/StatusCommand.php @@ -0,0 +1,88 @@ +. + */ + +namespace Sikofitt\Yamaha\AV\Console\Command; + +use Doctrine\DBAL\Connection; +use Sikofitt\Yamaha\AV\Client\Client; +use Sikofitt\Yamaha\AV\Client\System; +use Sikofitt\Yamaha\AV\Client\Zone; +use Sikofitt\Yamaha\AV\Repository\UserRepository; +use Symfony\Component\Console\Command\Command; +use Symfony\Component\Console\Input\InputArgument; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Output\OutputInterface; +use Symfony\Component\Console\Style\SymfonyStyle; + +class StatusCommand extends Command +{ + private $uri; + private $connection; + + public function __construct(Connection $connection) + { + $this->connection = $connection; + + parent::__construct(); + } + + public function configure(): void + { + $this->setName('status') + ->setDescription('Get current status information.') + ->addArgument('uri', InputArgument::REQUIRED, 'Yamaha AV Receiver Host or IP Address.'); + } + + public function interact(InputInterface $input, OutputInterface $output): void + { + $this->uri = strtolower($input->getArgument('uri')); + if (false === strpos($this->uri, '://')) { + $this->uri = sprintf('http://%s', $this->uri); + } + } + + /** + * @param \Symfony\Component\Console\Input\InputInterface $input + * @param \Symfony\Component\Console\Output\OutputInterface $output + * 10.5.7.230 + * + * @throws \Symfony\Component\Console\Exception\InvalidArgumentException + * + * @return int|null + */ + public function execute(InputInterface $input, OutputInterface $output): ?int + { + $io = new SymfonyStyle($input, $output); + $client = new Client($this->uri); + $zoneClient = new Zone($client, $input->getOption('zone')); + $systemClient = new System($client); + $status = $zoneClient->getStatus(); + $mainZone = $zoneClient->getInputsForZone(); + $features = $systemClient->getFeatures(); + //$io->listing($status); + $io->title('Zone Inputs'); + $io->block($mainZone); + //$io->listing($features); + //dump($status); + //dump($mainZone); + $repo = new UserRepository($this->connection); + dump($repo->getApiToken('sikofitt')); + return 0; + } +} diff --git a/src/Sikofitt/Yamaha/AV/Console/Command/VolumeCommand.php b/src/Sikofitt/Yamaha/AV/Console/Command/VolumeCommand.php new file mode 100644 index 0000000..c789fe8 --- /dev/null +++ b/src/Sikofitt/Yamaha/AV/Console/Command/VolumeCommand.php @@ -0,0 +1,81 @@ +. + */ + +namespace Sikofitt\Yamaha\AV\Console\Command; + +use Sikofitt\Yamaha\AV\Client\Client; +use Sikofitt\Yamaha\AV\Client\Zone; +use Symfony\Component\Console\Command\Command; +use Symfony\Component\Console\Input\InputArgument; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Input\InputOption; +use Symfony\Component\Console\Output\OutputInterface; + +class VolumeCommand extends Command +{ + public function configure(): void + { + $this->setName('volume') + ->setDescription('Control the volume') + ->addArgument('step', InputArgument::OPTIONAL, 'How much to increase or decrease the volume', 0.5) + ->addOption('up', 'u', InputOption::VALUE_NONE, 'Turn the volume up.') + ->addOption('down', 'd', InputOption::VALUE_NONE, 'Turn the volume down'); + } + + public function execute(InputInterface $input, OutputInterface $output) + { + $up = $input->getOption('up'); + $down = $input->getOption('down'); + $step = $input->getArgument('step'); + + $avClient = new Client('10.5.7.230'); + $client = new Zone($avClient, $input->getOption('zone')); + + if (false === $up && false === $down) { + $percent = (bool)strpos($step, '%'); + + if ($percent) { + $result = $client->changeVolumeByPercent((float)$step); + } else { + $result = $client->changeVolume((int)$step); + } + + $output->writeln(Client::RESPONSE_MAP[$result]); + + return $result; + } + + if (true === $up && true === $down) { + $output->writeln('Can only choose up or down.'); + exit; + } + + if (true === $up) { + $result = $client->increaseVolume($step); + $output->writeln(Client::RESPONSE_MAP[$result]); + return $result; + } + + if (true === $down) { + $result = $client->decreaseVolume($step); + $output->writeln(Client::RESPONSE_MAP[$result]); + return $result; + } + } +} diff --git a/src/Sikofitt/Yamaha/AV/Controller/SystemController.php b/src/Sikofitt/Yamaha/AV/Controller/SystemController.php new file mode 100644 index 0000000..6792ce5 --- /dev/null +++ b/src/Sikofitt/Yamaha/AV/Controller/SystemController.php @@ -0,0 +1,72 @@ +userRepository = $userRepository; + } + + public function statusCommand(Request $request, Application $app) + { + $content = \json_decode($request->getContent(), true); + + if(null === $content) { + $app->abort(Response::HTTP_EXPECTATION_FAILED); + } + + if(isset($content['api_key'], $content['api_secret'])) { + $user = $this->userRepository->getUserByKeyAndSecret($content['api_key'], $content['api_secret']); + } + + if(isset($content['username'], $content['password'])) { + $user = $this->userRepository->getUserByUserName($content['username']); + dump($user); + if(false === password_verify($content['password'], (string)$user['password'])) + { + $app->abort(Response::HTTP_UNAUTHORIZED, 'Either your username or password is incorrect. Please try again.'); + } + } + + if(isset($content['api_token'])) { + $user = $this->userRepository->getUserByToken($content['api_token']); + if(true === $this->userRepository->isTokenExpired($user)) { + $app->abort(Response::HTTP_EXPECTATION_FAILED, 'Your token has expired.'); + } + } + + if(empty($user)) { + $app->abort(Response::HTTP_UNAUTHORIZED, 'Could not validate the user.'); + } + + $client = new Client('10.5.7.230'); + $system = new System($client); + + return new JsonResponse([ + 'status' => 200, + 'features' => $system->getFeatures(), + ]); + + } +} \ No newline at end of file diff --git a/src/Sikofitt/Yamaha/AV/Controller/UserController.php b/src/Sikofitt/Yamaha/AV/Controller/UserController.php new file mode 100644 index 0000000..0e64a8c --- /dev/null +++ b/src/Sikofitt/Yamaha/AV/Controller/UserController.php @@ -0,0 +1,57 @@ +userRepository = $userRepository; + } + + public function updateTokenAction(Request $request, Application $app) + { + $json = \json_decode($request->getContent()); + if(null === $json) { + $app->abort(Response::HTTP_EXPECTATION_FAILED, json_last_error_msg()); + } + + if(false === isset($json['username'], $json['password'])) { + $app->abort(Response::HTTP_UNAUTHORIZED, 'Required values \'username\' or \'password\' were not found.'); + } + $success = $this->userRepository->createApiTokenForUser($json['username']); + $token = $this->userRepository->getApiToken($json['username']); + if(null === $token) { + $data = null; + } else { + $data = [ + 'api_token' => $token['api_token'], + 'api_token_expire' => $token['api_token_expire'], + ]; + } + dump($data); + return new JsonResponse([ + 'success' => $success, + $data, + ]); + + + } + + +} \ No newline at end of file diff --git a/src/Sikofitt/Yamaha/AV/Provider/AuthenticationProvider.php b/src/Sikofitt/Yamaha/AV/Provider/AuthenticationProvider.php new file mode 100644 index 0000000..4f089e0 --- /dev/null +++ b/src/Sikofitt/Yamaha/AV/Provider/AuthenticationProvider.php @@ -0,0 +1,75 @@ +addListener(KernelEvents::REQUEST, function(FilterResponseEvent $event) use ($app) { + $json = \json_decode($event->getRequest()->getContent(), true); + if(null === $json) { + $response = new JsonResponse([ + 'success' => false, + 'code' => Response::HTTP_UNAUTHORIZED, + 'message' => Response::$statusTexts[Response::HTTP_UNAUTHORIZED], + ]); + + $event->setResponse($response); + } + + }); + } +} \ No newline at end of file diff --git a/src/Sikofitt/Yamaha/AV/Repository/UserRepository.php b/src/Sikofitt/Yamaha/AV/Repository/UserRepository.php new file mode 100644 index 0000000..976bb49 --- /dev/null +++ b/src/Sikofitt/Yamaha/AV/Repository/UserRepository.php @@ -0,0 +1,167 @@ +. + */ + +namespace Sikofitt\Yamaha\AV\Repository; + +use Doctrine\DBAL\Connection; +use Doctrine\DBAL\Types\Type; +use Doctrine\ORM\EntityRepository; +use Doctrine\ORM\Mapping; + +class UserRepository +{ + private $connection; + + public function __construct(Connection $connection) + { + $this->connection = $connection; + } + public function getUserById(string $id): array + { + $result = $this + ->connection + ->createQueryBuilder() + ->select($this->getResultValues()) + ->from('users') + ->where('id = :id') + ->setParameter('id', $id) + ->execute() + ->fetch(); + + return false === $result ? [] : $result; + } + + public function getUserByUserName(string $userName): array + { + $result = $this + ->connection + ->createQueryBuilder() + ->select($this->getResultValues()) + ->from('users') + ->where('user_name = :user_name') + ->setParameter('user_name', $userName) + ->execute()->fetch(); + + return false === $result ? [] : $result; + } + + public function getUserByKeyAndSecret(string $key, string $secret): array + { + $result = $this + ->connection + ->createQueryBuilder() + ->select($this->getResultValues()) + ->from('users') + ->where('api_key = :api_key', 'api_secret = :api_secret') + ->setParameter('api_key', $key) + ->setParameter('api_secret', $secret) + ->execute() + ->fetch(); + + return false === $result ? [] : $result; + } + + public function getUserByToken(string $token): array + { + $result = $this + ->connection + ->createQueryBuilder() + ->select($this->getResultValues()) + ->from('users') + ->where('api_token = :api_token') + ->setParameter('api_token', $token) + ->execute() + ->fetch(); + + return false === $result ? [] : $result; + } + + + public function isTokenExpired(array $user): bool + { + + if (false === empty($user)) { + if (null === $user['api_token_expire'] || null === $user['api_token']) { + return true; + } + + $expireDate = $this->connection->convertToPHPValue($user['api_token_expire'], Type::DATETIME); + $currentDate = new \DateTime('now'); + + return $currentDate->format('U') > $expireDate->format('U'); + } + + return true; + } + + public function getApiToken(string $userName): ?array + { + $statement = $this->connection->prepare('SELECT api_token, api_token_expire FROM users WHERE user_name = :user_name'); + $statement->bindValue('user_name', $userName); + $statement->execute(); + $result = $statement->fetch(); + if(false === $result) { + return null; + } + $result['api_token_expire'] = $this->connection->convertToPHPValue($result['api_token_expire'], Type::DATETIME); + return $result; + } + + public function createApiTokenForUser(string $userName): bool + { + $this->connection->beginTransaction(); + + $statement = $this->connection->prepare('UPDATE users set api_token=:api_token, api_token_expire=:api_token_expire where user_name = :user_name'); + $expire = new \DateTime('now + 1 day'); + $expire = $this->connection->convertToDatabaseValue($expire, Type::DATETIME); + + try { + $statement->execute([ + 'api_token' => $this->generateKey(240), + 'api_token_expire' => $expire, + 'user_name' => $userName, + ]); + } catch (\Exception $e) { + trigger_error($e->getMessage(), E_ERROR); + return false; + } + + $this->connection->commit(); + + return (bool)$statement->rowCount(); + } + + private function getResultValues(): array + { + return ['id','user_name', 'password', 'api_token','api_key','api_secret','api_token_expire','created_at','updated_at']; + } + + /** + * Generates a key for the api_key and api_secret. + * + * @param int $length + * + * @return string + */ + private function generateKey(int $length): string + { + $result = base64_encode(bin2hex(random_bytes($length*12))); + return substr($result, 32, $length); + } +} diff --git a/src/Sikofitt/Yamaha/AV/Security/UserAuthChecker.php b/src/Sikofitt/Yamaha/AV/Security/UserAuthChecker.php new file mode 100644 index 0000000..72a4f52 --- /dev/null +++ b/src/Sikofitt/Yamaha/AV/Security/UserAuthChecker.php @@ -0,0 +1,79 @@ +userRepository = $userRepository; + } + + public function check(array $postData): bool + { + if(isset($postData['api_token'])) { + return $this->isTokenValid($postData['api_token']); + } + + if(isset($postData['api_key'], $postData['api_secret'])) { + return $this->checkApiKey($postData['api_key'], $postData['api_secret']); + } + + if(isset($postData['user_name'], $postData['password'])) { + return $this->checkUserPassword($postData['user_name'], $postData['password']); + } + + } + + public function isTokenValid($apiToken): bool + { + $user = $this->userRepository->getUserByToken($apiToken); + + if(false === isset($user['api_token_expire']) && null === $user['api_token_expire']) { + return false; + } + + if(true === $this->isTokenExpired((string)$user['api_token_expire'])) + { + return false; + } + + return true; + } + + public function checkApiKey($apiKey, $apiSecret): bool + { + + } + + public function checkUserPassword($userName, $password): bool + { + + } + + public function isTokenExpired(string $tokenExpire): bool + { + $expireDate = Type::getType(Type::DATETIME) + ->convertToPHPValue($tokenExpire, new SqlitePlatform()); + + $currentDate = new \DateTime('now'); + + return $currentDate->format('U') > $expireDate->format('U'); + } + +} \ No newline at end of file diff --git a/tests/Sikofitt/Tests/.keep b/tests/Sikofitt/Tests/.keep new file mode 100644 index 0000000..e69de29 diff --git a/web/index.php b/web/index.php new file mode 100644 index 0000000..8598d3d --- /dev/null +++ b/web/index.php @@ -0,0 +1,94 @@ +connect('localhost'); +$app['debug'] = 'dev' === $env; + +$app + ->register(new \Silex\Provider\HttpFragmentServiceProvider()) + ->register(new Silex\Provider\SerializerServiceProvider()) + ->register(new Silex\Provider\ServiceControllerServiceProvider()) + ->register(new \Silex\Provider\VarDumperServiceProvider(), [ + 'var_dumper.dump_destination' => fopen('php://stdout', 'w'), + ]) + ->register(new Silex\Provider\DoctrineServiceProvider(), array( + 'db.options' => array( + 'driver' => 'pdo_sqlite', + 'path' => __DIR__.'/../config/app.db', + 'charset' => 'utf8mb4', + 'collate' => 'utf8mb4_unicode_ci', + ), + )) + ->register(new \Silex\Provider\MonologServiceProvider(), [ + 'monolog.logfile' => __DIR__.'/../logs/app.log', + 'monolog.level' => 'dev' === $env ? \Monolog\Logger::DEBUG : \Monolog\Logger::INFO, + ]) + ->register(new Moust\Silex\Provider\CacheServiceProvider(), array( + 'cache.options' => array( + 'driver' => 'redis', + 'redis' => $redis, + ) + )) + ; +$app->extend('monolog', function(Monolog\Logger $monolog, $app) use($redis) { + $monolog->pushHandler(new Monolog\Handler\RotatingFileHandler(__DIR__.'/../logs/app.log',20,Monolog\Logger::DEBUG)); + $monolog->pushHandler(new \Monolog\Handler\SyslogHandler('app')); + $monolog->pushHandler(new \Monolog\Handler\RedisHandler($redis, 'app')); + return $monolog; +}); + +\Doctrine\DBAL\Types\Type::addType('uuid', \Ramsey\Uuid\Doctrine\UuidType::class); + +/** @var \Doctrine\DBAL\Connection $db */ +$db = $app['db']; + + +if('dev' !== $env) { + $app->register(new \Silex\Provider\HttpCacheServiceProvider(),[ + 'http_cache.cache_dir' => __DIR__.'/../cache/http/', + 'http_cache.esi' => null, + ]); +} + +$app->error(function (\Exception $e, Request $request, int $code) { + + return new JsonResponse([ + 'success' => false, + 'status' => Response::$statusTexts[$code], + 'code' => $code, + 'message' => $e->getMessage(), + ], $code); +}); +$app['user.repository'] = function() use($app) { + return new \Sikofitt\Yamaha\AV\Repository\UserRepository($app['db']); +}; +$app['system.controller'] = function() use($app) { + return new \Sikofitt\Yamaha\AV\Controller\SystemController($app['user.repository']); +}; + +$app->post('/system/features', 'system.controller:statusCommand'); + +/** @var Request $request */ +//$request = $app['request_stack']->getMasterRequest(); +$app->options('/', function() { + $response = new Response(); + $response->setStatusCode(Response::HTTP_NO_CONTENT); + $response->headers->set('Allow', 'GET, OPTIONS'); + return $response; +}); + +Request::setTrustedProxies(array('127.0.0.1')); + +if('dev' !== $env) { + $app['http_cache']->run(); +} else { + $app->run(); +} \ No newline at end of file