diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..7ad8d77 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,21 @@ +name: CI + +on: [push] + +jobs: + build-test: + runs-on: ubuntu-latest + strategy: + matrix: + php-versions: ['7.4', '8.0', '8.4'] + + steps: + - uses: actions/checkout@v2 + - name: Set up php${{ matrix.php-versons }} + uses: shivammathur/setup-php@master + with: + php-version: ${{ matrix.php-versions }} + - name: Install dependencies + run: composer i + - name: PHPUnit + run: ./vendor/phpunit/phpunit/phpunit -c tests/phpunit.xml diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..2cd12eb --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,41 @@ +name: Php Lint +on: [push, pull_request] + +jobs: + php-linters: + runs-on: ubuntu-20.04 + strategy: + matrix: + php-versions: ['7.4', '8.0', '8.4'] + name: php${{ matrix.php-versions }} lint + steps: + - name: Checkout + uses: actions/checkout@master + - name: Set up php${{ matrix.php-versons }} + uses: shivammathur/setup-php@master + with: + php-version: ${{ matrix.php-versions }} + coverage: none + extensions: inotify + - name: Install dependencies + run: composer i + - name: Lint + run: composer run lint + + php-cs-fixer: + name: php-cs check + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@master + - name: Set up php${{ matrix.php-versions }} + uses: shivammathur/setup-php@master + with: + php-version: 7.4 + tools: composer:v1 + coverage: none + extensions: inotify + - name: Install dependencies + run: composer i + - name: Run coding standards check + run: composer run cs:check diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml new file mode 100644 index 0000000..b286401 --- /dev/null +++ b/.github/workflows/static-analysis.yml @@ -0,0 +1,36 @@ +name: Php Static analysis +on: [push, pull_request] + +jobs: + psalm: + runs-on: ubuntu-20.04 + steps: + - name: Checkout + uses: actions/checkout@master + - name: Set up php + uses: shivammathur/setup-php@master + with: + php-version: 7.4 + tools: composer:v1 + coverage: none + extensions: redis + - name: Install dependencies + run: composer i + - name: Run coding standards check + run: composer run psalm + phpstan: + runs-on: ubuntu-20.04 + steps: + - name: Checkout + uses: actions/checkout@master + - name: Set up php + uses: shivammathur/setup-php@master + with: + php-version: 7.4 + tools: composer:v1 + coverage: none + extensions: redis + - name: Install dependencies + run: composer i + - name: Run coding standards check + run: composer run psalm diff --git a/.gitignore b/.gitignore index 987e2a2..3ca03c7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,5 @@ composer.lock vendor +coverage.xml +.phpunit.result.cache +*.cache diff --git a/.php_cs.dist b/.php_cs.dist new file mode 100644 index 0000000..a2fdf19 --- /dev/null +++ b/.php_cs.dist @@ -0,0 +1,15 @@ +exclude('vendor') + ->in(__DIR__) +; +return PhpCsFixer\Config::create() + ->setRules([ + '@PSR2' => true, + 'array_syntax' => ['syntax' => 'short'], + 'braces' => ['position_after_functions_and_oop_constructs' => 'same'], + 'binary_operator_spaces' => ['align_double_arrow' => true, 'align_equals' => false], + ]) + ->setIndent("\t") + ->setFinder($finder) + ; diff --git a/.scrutinizer.yml b/.scrutinizer.yml new file mode 100644 index 0000000..884d059 --- /dev/null +++ b/.scrutinizer.yml @@ -0,0 +1,6 @@ +build: + nodes: + analysis: + tests: + override: + - php-scrutinizer-run diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..58f03a2 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,19 @@ +language: php +php: + - '7.2' + - '7.3' + - '7.4' + +cache: + directories: + - $HOME/.composer/cache/files + +install: + - composer install --no-interaction + +script: + - cd tests + - ../vendor/bin/phpunit --coverage-clover coverage.xml --configuration phpunit.xml + +after_success: + - bash <(curl -s https://codecov.io/bash) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..dbbe355 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md index 4f5c6d4..1ae78d1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # SearchDAV -A sabre/dav plugin to implement rfc5323 SEARCH +[![Build Status](https://travis-ci.org/icewind1991/SearchDAV.svg?branch=master)](https://travis-ci.org/icewind1991/SearchDAV) +[![codecov](https://codecov.io/gh/icewind1991/SearchDAV/branch/master/graph/badge.svg)](https://codecov.io/gh/icewind1991/SearchDAV) +[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/icewind1991/SearchDAV/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/icewind1991/SearchDAV/?branch=master) + +A sabre/dav plugin to implement [rfc5323](https://tools.ietf.org/search/rfc5323) SEARCH ## Usage @@ -44,9 +48,9 @@ the search schema that is supported and implements the actual search. For a full list of methods required and their description see [`ISearchBackend.php`](src/Backend/ISearchBackend.php) -### BasicSearch +### Query -The `BasicSearch` class defines the query that was made by the client and consists of four parts: +The `Query` class defines the query that was made by the client and consists of four parts: - select: the properties are requested. - from: the scope(s) in which the search should be made. @@ -54,5 +58,5 @@ The `BasicSearch` class defines the query that was made by the client and consis - orderBy: how the search results should be ordered. For further information about these elements see - [`BasicSearch.php`](src/XML/BasicSearch.php), [`Scope.php`](src/XML/Scope.php), - [`Operator.php`](src/XML/Operator.php) and [`Order.php`](src/XML/Order.php) + [`Query.php`](src/Query/Query.php), [`Scope.php`](src/Query/Scope.php), + [`Operator.php`](src/Query/Operator.php) and [`Order.php`](src/Query/Order.php) diff --git a/composer.json b/composer.json index 2d5da56..25e7143 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,7 @@ { "name": "icewind/searchdav", "description": "sabre/dav plugin to implement rfc5323 SEARCH", - "license": "AGPL", + "license": "AGPL-3.0-or-later", "authors": [ { "name": "Robin Appelman", @@ -9,16 +9,31 @@ } ], "require": { - "php": ">=5.6", - "sabre/dav": "^3.2.0" + "php": ">=7.3 || >=8.0", + "sabre/dav": "^4.0.0" }, "require-dev": { - "phpunit/phpunit": "^4.8" + "php-parallel-lint/php-parallel-lint": "^1.0", + "friendsofphp/php-cs-fixer": "^2", + "phpstan/phpstan": "^0.12", + "psalm/phar": "^4.3", + "phpunit/phpunit": "^8" }, "autoload": { "psr-4": { - "SearchDAV\\": "src/", + "SearchDAV\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { "SearchDAV\\Test\\": "tests/" } + }, + "scripts": { + "lint": "parallel-lint --exclude src --exclude vendor --exclude target --exclude build .", + "cs:check": "php-cs-fixer fix --dry-run --diff", + "cs:fix": "php-cs-fixer fix", + "psalm": "psalm.phar", + "phpstan": "phpstan analyse --level 5 src" } } diff --git a/psalm.xml b/psalm.xml new file mode 100644 index 0000000..30258a7 --- /dev/null +++ b/psalm.xml @@ -0,0 +1,15 @@ + + + + + + + + + diff --git a/src/Backend/ISearchBackend.php b/src/Backend/ISearchBackend.php index 8db8db6..277f284 100644 --- a/src/Backend/ISearchBackend.php +++ b/src/Backend/ISearchBackend.php @@ -1,4 +1,4 @@ - * @@ -22,14 +22,13 @@ namespace SearchDAV\Backend; use Sabre\DAV\INode; -use SearchDAV\XML\BasicSearch; -use SearchDAV\XML\Scope; +use SearchDAV\Query\Query; interface ISearchBackend { /** * Get the path of the search arbiter of this backend * - * The search arbiter is the URI that the client will send it's SEARCH requests to + * The search arbiter is the URI that the client will send its SEARCH requests to * Note that this is not required to be the same as the search scopes which determine what to search in * * The returned value should be a path relative the root of the dav server. @@ -39,10 +38,10 @@ interface ISearchBackend { * * @return string */ - public function getArbiterPath(); + public function getArbiterPath(): string; /** - * Whether or not the search backend supports search requests on this scope + * Whether the search backend supports search requests on this scope * * The scope defines the resource that it being searched, such as a folder or address book. * @@ -56,7 +55,7 @@ interface ISearchBackend { * @param string|null $path the path of the search scope relative to the dav server, or null if the scope is outside the dav server * @return bool */ - public function isValidScope($href, $depth, $path); + public function isValidScope(string $href, $depth, ?string $path): bool; /** * List the available properties that can be used in search @@ -70,7 +69,7 @@ interface ISearchBackend { * @param string|null $path the path of the search scope relative to the dav server, or null if the scope is outside the dav server * @return SearchPropertyDefinition[] */ - public function getPropertyDefinitionsForScope($href, $path); + public function getPropertyDefinitionsForScope(string $href, ?string $path): array; /** * Preform the search request @@ -79,8 +78,17 @@ interface ISearchBackend { * To return the properties requested by the query sabre's existing PropFind method is used, thus the search implementation * is not required to collect these properties and is free to ignore the `select` part of the query * - * @param BasicSearch $query + * @param Query $query * @return SearchResult[] */ - public function search(BasicSearch $query); + public function search(Query $query): array; + + /** + * Called by the search plugin once the nodes to be returned have been found. + * This can be used to more efficiently load the requested properties for the results. + * + * @param INode[] $nodes + * @param string[] $requestProperties + */ + public function preloadPropertyFor(array $nodes, array $requestProperties): void; } diff --git a/src/Backend/SearchPropertyDefinition.php b/src/Backend/SearchPropertyDefinition.php index d7de46a..4dca05b 100644 --- a/src/Backend/SearchPropertyDefinition.php +++ b/src/Backend/SearchPropertyDefinition.php @@ -1,4 +1,4 @@ - * @@ -26,6 +26,7 @@ class SearchPropertyDefinition { const DATATYPE_STRING = self::XS . 'string'; const DATATYPE_INTEGER = self::XS . 'integer'; const DATATYPE_NONNEGATIVE_INTEGER = self::XS . 'nonNegativeInteger'; + const DATATYPE_NON_NEGATIVE_INTEGER = self::XS . 'nonNegativeInteger'; const DATATYPE_DECIMAL = self::XS . 'decimal'; const DATATYPE_DATETIME = self::XS . 'dateTime'; const DATATYPE_BOOLEAN = self::XS . 'boolean'; @@ -48,13 +49,13 @@ class SearchPropertyDefinition { * SearchProperty constructor. * * @param string $name the name and namespace of the property in clark notation - * @param bool $searchable whether or not this property can be used as part of a search query - * @param bool $selectable whether or not this property can be returned as part of a search result - * @param bool $sortable whether or not this property can be used to sort the search result + * @param bool $searchable whether this property can be used as part of a search query + * @param bool $selectable whether this property can be returned as part of a search result + * @param bool $sortable whether this property can be used to sort the search result * @param string $dataType the datatype of the property, one of the SearchProperty::DATATYPE_ constants or any XSD datatype in clark notation - * @param bool $caseSensitive whether or not comparisons on the property are case sensitive, only applies to string propertries + * @param bool $caseSensitive whether comparisons on the property are case-sensitive, only applies to string properties */ - public function __construct($name, $searchable, $selectable, $sortable, $dataType = self::DATATYPE_STRING, $caseSensitive = true) { + public function __construct(string $name, bool $selectable, bool $searchable, bool $sortable, string $dataType = self::DATATYPE_STRING, bool $caseSensitive = true) { $this->searchable = $searchable; $this->selectable = $selectable; $this->sortable = $sortable; diff --git a/src/Backend/SearchResult.php b/src/Backend/SearchResult.php index 32f99a7..af48506 100644 --- a/src/Backend/SearchResult.php +++ b/src/Backend/SearchResult.php @@ -1,4 +1,4 @@ - * @@ -21,7 +21,6 @@ namespace SearchDAV\Backend; - use Sabre\DAV\INode; class SearchResult { @@ -36,7 +35,7 @@ class SearchResult { * @param INode $node * @param string $href */ - public function __construct(INode $node, $href) { + public function __construct(INode $node, string $href) { $this->node = $node; $this->href = $href; } diff --git a/src/DAV/DiscoverHandler.php b/src/DAV/DiscoverHandler.php new file mode 100644 index 0000000..811cfc7 --- /dev/null +++ b/src/DAV/DiscoverHandler.php @@ -0,0 +1,107 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace SearchDAV\DAV; + +use Sabre\DAV\Exception\BadRequest; +use Sabre\DAV\Xml\Response\MultiStatus; +use Sabre\HTTP\RequestInterface; +use Sabre\HTTP\ResponseInterface; +use SearchDAV\Backend\ISearchBackend; +use SearchDAV\Backend\SearchPropertyDefinition; +use SearchDAV\XML\BasicSearch; +use SearchDAV\XML\BasicSearchSchema; +use SearchDAV\XML\PropDesc; +use SearchDAV\XML\QueryDiscoverResponse; +use SearchDAV\XML\Scope; + +class DiscoverHandler { + /** @var ISearchBackend */ + private $searchBackend; + + /** @var PathHelper */ + private $pathHelper; + + /** @var QueryParser */ + private $queryParser; + + /** + * @param ISearchBackend $searchBackend + * @param PathHelper $pathHelper + * @param QueryParser $queryParser + */ + public function __construct(ISearchBackend $searchBackend, PathHelper $pathHelper, QueryParser $queryParser) { + $this->searchBackend = $searchBackend; + $this->pathHelper = $pathHelper; + $this->queryParser = $queryParser; + } + + public function handelDiscoverRequest($xml, RequestInterface $request, ResponseInterface $response): bool { + if (!isset($xml['{DAV:}basicsearch'])) { + $response->setStatus(400); + $response->setBody('Unexpected xml content for query-schema-discovery, expected basicsearch'); + return false; + } + /** @var BasicSearch $query */ + $query = $xml['{DAV:}basicsearch']; + $scopes = $query->from; + $results = array_map(function (Scope $scope) { + $scope->path = $this->pathHelper->getPathFromUri($scope->href); + if ($this->searchBackend->isValidScope($scope->href, $scope->depth, $scope->path)) { + $searchProperties = $this->searchBackend->getPropertyDefinitionsForScope($scope->href, $scope->path); + $searchSchema = $this->getBasicSearchForProperties($searchProperties); + return new QueryDiscoverResponse($scope->href, $searchSchema, 200); + } else { + return new QueryDiscoverResponse($scope->href, null, 404); // TODO something other than 404? 403 maybe + } + }, $scopes); + $multiStatus = new MultiStatus($results); + $response->setStatus(207); + $response->setHeader('Content-Type', 'application/xml; charset="utf-8"'); + $response->setBody($this->queryParser->write('{DAV:}multistatus', $multiStatus, $request->getUrl())); + return false; + } + + private function hashDefinition(SearchPropertyDefinition $definition): string { + return $definition->dataType + . (($definition->searchable) ? '1' : '0') + . (($definition->sortable) ? '1' : '0') + . (($definition->selectable) ? '1' : '0'); + } + + /** + * @param SearchPropertyDefinition[] $propertyDefinitions + * @return BasicSearchSchema + */ + private function getBasicSearchForProperties(array $propertyDefinitions): BasicSearchSchema { + /** @var PropDesc[] $groups */ + $groups = []; + foreach ($propertyDefinitions as $propertyDefinition) { + $key = $this->hashDefinition($propertyDefinition); + if (!isset($groups[$key])) { + $groups[$key] = new PropDesc($propertyDefinition); + } + $groups[$key]->properties[] = $propertyDefinition->name; + } + + return new BasicSearchSchema(array_values($groups)); + } +} diff --git a/src/DAV/PathHelper.php b/src/DAV/PathHelper.php new file mode 100644 index 0000000..04098c7 --- /dev/null +++ b/src/DAV/PathHelper.php @@ -0,0 +1,50 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace SearchDAV\DAV; + +use Sabre\DAV\Exception\Forbidden; +use Sabre\DAV\Server; + +class PathHelper { + /** @var Server */ + private $server; + + /** + * PathHelper constructor. + * + * @param Server $server + */ + public function __construct(Server $server) { + $this->server = $server; + } + + public function getPathFromUri(string $uri): ?string { + if (strpos($uri, '://') === false) { + return $uri; + } + try { + return ($uri === '' && $this->server->getBaseUri() === '/') ? '' : $this->server->calculateUri($uri); + } catch (Forbidden $e) { + return null; + } + } +} diff --git a/src/DAV/QueryParser.php b/src/DAV/QueryParser.php index 175be07..915184e 100644 --- a/src/DAV/QueryParser.php +++ b/src/DAV/QueryParser.php @@ -1,4 +1,4 @@ - * @@ -25,32 +25,36 @@ use Sabre\Xml\Element; use Sabre\Xml\Reader; use Sabre\Xml\Service; use SearchDAV\XML\BasicSearch; +use SearchDAV\XML\Limit; use SearchDAV\XML\Literal; use SearchDAV\XML\Operator; use SearchDAV\XML\Order; use SearchDAV\XML\Scope; +use function Sabre\Xml\Deserializer\keyValue; +use function Sabre\Xml\Deserializer\repeatingElements; class QueryParser extends Service { public $namespaceMap = [ - 'DAV:' => 'd', - 'http://sabredav.org/ns' => 's', - 'http://www.w3.org/2001/XMLSchema' => 'xs' + 'DAV:' => 'd', + 'http://sabredav.org/ns' => 's', + 'http://www.w3.org/2001/XMLSchema' => 'xs', + SearchPlugin::SEARCHDAV_NS => 'sd' ]; public function __construct() { $this->elementMap = [ - '{DAV:}literal' => Literal::class, - '{DAV:}searchrequest' => Element\KeyValue::class, + '{DAV:}literal' => Literal::class, + '{DAV:}searchrequest' => Element\KeyValue::class, '{DAV:}query-schema-discovery' => Element\KeyValue::class, - '{DAV:}basicsearch' => BasicSearch::class, - '{DAV:}select' => function (Reader $reader) { - return \Sabre\Xml\Deserializer\keyValue($reader, '{DAV:}scope')['{DAV:}prop']; + '{DAV:}basicsearch' => BasicSearch::class, + '{DAV:}select' => function (Reader $reader) { + return keyValue($reader, '{DAV:}scope')['{DAV:}prop']; }, '{DAV:}from' => function (Reader $reader) { - return \Sabre\Xml\Deserializer\repeatingElements($reader, '{DAV:}scope'); + return repeatingElements($reader, '{DAV:}scope'); }, '{DAV:}orderby' => function (Reader $reader) { - return \Sabre\Xml\Deserializer\repeatingElements($reader, '{DAV:}order'); + return repeatingElements($reader, '{DAV:}order'); }, '{DAV:}scope' => Scope::class, '{DAV:}where' => function (Reader $reader) { @@ -59,19 +63,21 @@ class QueryParser extends Service { }, $reader->parseGetElements()); return (isset($operators[0])) ? $operators[0] : null; }, - '{DAV:}prop' => Element\Elements::class, - '{DAV:}order' => Order::class, - '{DAV:}eq' => Operator::class, - '{DAV:}gt' => Operator::class, - '{DAV:}gte' => Operator::class, - '{DAV:}lt' => Operator::class, - '{DAV:}lte' => Operator::class, - '{DAV:}and' => Operator::class, - '{DAV:}or' => Operator::class, - '{DAV:}like' => Operator::class, - '{DAV:}contains' => Operator::class, - '{DAV:}not' => Operator::class, + '{DAV:}prop' => Element\Elements::class, + '{DAV:}order' => Order::class, + '{DAV:}eq' => Operator::class, + '{DAV:}gt' => Operator::class, + '{DAV:}gte' => Operator::class, + '{DAV:}lt' => Operator::class, + '{DAV:}lte' => Operator::class, + '{DAV:}and' => Operator::class, + '{DAV:}or' => Operator::class, + '{DAV:}like' => Operator::class, + '{DAV:}contains' => Operator::class, + '{DAV:}not' => Operator::class, '{DAV:}is-collection' => Operator::class, + '{DAV:}is-defined' => Operator::class, + '{DAV:}limit' => Limit::class, ]; } } diff --git a/src/DAV/SearchHandler.php b/src/DAV/SearchHandler.php new file mode 100644 index 0000000..a1fa5a7 --- /dev/null +++ b/src/DAV/SearchHandler.php @@ -0,0 +1,200 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace SearchDAV\DAV; + +use Sabre\DAV\Exception\BadRequest; +use Sabre\DAV\INode; +use Sabre\DAV\PropFind; +use Sabre\DAV\Server; +use Sabre\HTTP\ResponseInterface; +use SearchDAV\Backend\ISearchBackend; +use SearchDAV\Backend\SearchPropertyDefinition; +use SearchDAV\Backend\SearchResult; +use SearchDAV\Query\Operator; +use SearchDAV\Query\Order; +use SearchDAV\Query\Query; +use SearchDAV\XML\BasicSearch; + +class SearchHandler { + /** @var ISearchBackend */ + private $searchBackend; + + /** @var PathHelper */ + private $pathHelper; + + /** @var Server */ + private $server; + + /** + * @param ISearchBackend $searchBackend + * @param PathHelper $pathHelper + * @param Server $server + */ + public function __construct(ISearchBackend $searchBackend, PathHelper $pathHelper, Server $server) { + $this->searchBackend = $searchBackend; + $this->pathHelper = $pathHelper; + $this->server = $server; + } + + public function handleSearchRequest($xml, ResponseInterface $response): bool { + if (!isset($xml['{DAV:}basicsearch'])) { + $response->setStatus(400); + $response->setBody('Unexpected xml content for search request, expected basicsearch'); + return false; + } + /** @var BasicSearch $query */ + $query = $xml['{DAV:}basicsearch']; + if (!$query->select) { + $response->setStatus(400); + $response->setBody('Parse error: Missing {DAV:}select from {DAV:}basicsearch'); + return false; + } + $response->setStatus(207); + $response->setHeader('Content-Type', 'application/xml; charset="utf-8"'); + $allProps = []; + foreach ($query->from as $scope) { + $scope->path = $this->pathHelper->getPathFromUri($scope->href); + $props = $this->searchBackend->getPropertyDefinitionsForScope($scope->href, $scope->path); + foreach ($props as $prop) { + $allProps[$prop->name] = $prop; + } + } + try { + $results = $this->searchBackend->search($this->getQueryForXML($query, $allProps)); + } catch (BadRequest $e) { + $response->setStatus(400); + $response->setBody($e->getMessage()); + return false; + } + $data = $this->server->generateMultiStatus(iterator_to_array($this->getPropertiesIteratorResults( + $results, + $query->select + )), false); + $response->setBody($data); + return false; + } + + /** + * @param BasicSearch $xml + * @param SearchPropertyDefinition[] $allProps + * @return Query + * @throws BadRequest + */ + private function getQueryForXML(BasicSearch $xml, array $allProps): Query { + $orderBy = array_map(function (\SearchDAV\XML\Order $order) use ($allProps) { + if (!isset($allProps[$order->property])) { + throw new BadRequest('requested order by property is not a valid property for this scope'); + } + $prop = $allProps[$order->property]; + if (!$prop->sortable) { + throw new BadRequest('requested order by property is not sortable'); + } + return new Order($prop, $order->order); + }, $xml->orderBy); + $select = array_map(function ($propName) use ($allProps) { + if (!isset($allProps[$propName])) { + return null; + } + $prop = $allProps[$propName]; + if (!$prop->selectable) { + throw new BadRequest('requested property is not selectable'); + } + return $prop; + }, $xml->select); + $select = array_filter($select); + + $where = $xml->where ? $this->transformOperator($xml->where, $allProps) : null; + + return new Query($select, $xml->from, $where, $orderBy, $xml->limit); + } + + /** + * @param \SearchDAV\XML\Operator $operator + * @param SearchPropertyDefinition[] $allProps + * @return Operator + * @throws BadRequest + */ + private function transformOperator(\SearchDAV\XML\Operator $operator, array $allProps): Operator { + $arguments = array_map(function ($argument) use ($allProps) { + if (is_string($argument)) { + if (!isset($allProps[$argument])) { + throw new BadRequest('requested search property is not a valid property for this scope'); + } + $prop = $allProps[$argument]; + if (!$prop->searchable) { + throw new BadRequest('requested search property is not searchable'); + } + return $prop; + } else { + if ($argument instanceof \SearchDAV\XML\Operator) { + return $this->transformOperator($argument, $allProps); + } else { + return $argument; + } + } + }, $operator->arguments); + + return new Operator($operator->type, $arguments); + } + + /** + * Returns a list of properties for a given path + * + * The path that should be supplied should have the baseUrl stripped out + * The list of properties should be supplied in Clark notation. If the list is empty + * 'allprops' is assumed. + * + * If a depth of 1 is requested child elements will also be returned. + * + * @param SearchResult[] $results + * @param string[] $propertyNames + * @param int $depth + * @return \Iterator + */ + private function getPropertiesIteratorResults(array $results, array $propertyNames = [], int $depth = 0): \Iterator { + $propFindType = $propertyNames ? PropFind::NORMAL : PropFind::ALLPROPS; + + $this->searchBackend->preloadPropertyFor(array_map(function (SearchResult $result): INode { + return $result->node; + }, $results), $propertyNames); + + foreach ($results as $result) { + $node = $result->node; + $propFind = new PropFind($result->href, $propertyNames, $depth, $propFindType); + $r = $this->server->getPropertiesByNode($propFind, $node); + if ($r) { + $result = $propFind->getResultForMultiStatus(); + $result['href'] = $propFind->getPath(); + + // WebDAV recommends adding a slash to the path, if the path is + // a collection. + // Furthermore, iCal also demands this to be the case for + // principals. This is non-standard, but we support it. + $resourceType = $this->server->getResourceTypeForNode($node); + if (in_array('{DAV:}collection', $resourceType) || in_array('{DAV:}principal', $resourceType)) { + $result['href'] .= '/'; + } + yield $result; + } + } + } +} diff --git a/src/DAV/SearchPlugin.php b/src/DAV/SearchPlugin.php index 5695f27..7c03b5a 100644 --- a/src/DAV/SearchPlugin.php +++ b/src/DAV/SearchPlugin.php @@ -1,4 +1,4 @@ - * @@ -21,31 +21,18 @@ namespace SearchDAV\DAV; -use Sabre\DAV\Exception\BadRequest; -use Sabre\DAV\Exception\Forbidden; use Sabre\DAV\INode; -use Sabre\DAV\Node; use Sabre\DAV\PropFind; use Sabre\DAV\Server; use Sabre\DAV\ServerPlugin; -use Sabre\DAV\Xml\Element\Response; -use Sabre\DAV\Xml\Response\MultiStatus; use Sabre\HTTP\RequestInterface; use Sabre\HTTP\ResponseInterface; -use Sabre\Xml\Writer; +use Sabre\Xml\ParseException; use SearchDAV\Backend\ISearchBackend; -use SearchDAV\Backend\SearchPropertyDefinition; -use SearchDAV\Backend\SearchResult; -use SearchDAV\XML\BasicSearch; -use SearchDAV\XML\BasicSearchSchema; -use SearchDAV\XML\PropDesc; -use SearchDAV\XML\QueryDiscoverResponse; -use SearchDAV\XML\Scope; use SearchDAV\XML\SupportedQueryGrammar; class SearchPlugin extends ServerPlugin { - /** @var Server */ - private $server; + const SEARCHDAV_NS = 'https://github.com/icewind1991/SearchDAV/ns'; /** @var ISearchBackend */ private $searchBackend; @@ -53,43 +40,43 @@ class SearchPlugin extends ServerPlugin { /** @var QueryParser */ private $queryParser; + /** @var PathHelper */ + private $pathHelper; + + /** @var SearchHandler */ + private $search; + + /** @var DiscoverHandler */ + private $discover; + public function __construct(ISearchBackend $searchBackend) { $this->searchBackend = $searchBackend; + $this->queryParser = new QueryParser(); } - public function initialize(Server $server) { - $this->server = $server; - $this->queryParser = new QueryParser($this->server->xml); + public function initialize(Server $server): void { + $this->pathHelper = new PathHelper($server); + $this->search = new SearchHandler($this->searchBackend, $this->pathHelper, $server); + $this->discover = new DiscoverHandler($this->searchBackend, $this->pathHelper, $this->queryParser); $server->on('method:SEARCH', [$this, 'searchHandler']); $server->on('afterMethod:OPTIONS', [$this, 'optionHandler']); $server->on('propFind', [$this, 'propFindHandler']); } - public function propFindHandler(PropFind $propFind, INode $node) { + public function propFindHandler(PropFind $propFind, INode $node): void { if ($propFind->getPath() === $this->searchBackend->getArbiterPath()) { $propFind->handle('{DAV:}supported-query-grammar-set', new SupportedQueryGrammar()); } } - private function getPathFromUri($uri) { - if (strpos($uri, '://') === false) { - return $uri; - } - try { - return ($uri === '' && $this->server->getBaseUri() === '/') ? '' : $this->server->calculateUri($uri); - } catch (Forbidden $e) { - return null; - } - } - /** * SEARCH is allowed for users files * - * @param string $uri - * @return array + * @param string $path + * @return string[] */ - public function getHTTPMethods($uri) { - $path = $this->getPathFromUri($uri); + public function getHTTPMethods($path): array { + $path = $this->pathHelper->getPathFromUri($path); if ($this->searchBackend->getArbiterPath() === $path) { return ['SEARCH']; } else { @@ -97,134 +84,45 @@ class SearchPlugin extends ServerPlugin { } } - public function optionHandler(RequestInterface $request, ResponseInterface $response) { - if ($request->getPath() === '') { + public function optionHandler(RequestInterface $request, ResponseInterface $response): void { + if ($request->getPath() === $this->searchBackend->getArbiterPath()) { $response->addHeader('DASL', ''); } } - public function searchHandler(RequestInterface $request, ResponseInterface $response) { - $contentType = $request->getHeader('Content-Type'); + public function searchHandler(RequestInterface $request, ResponseInterface $response): bool { + $contentType = $request->getHeader('Content-Type') ?? ''; - // Currently we only support xml search queries + // Currently, we only support xml search queries if ((strpos($contentType, 'text/xml') === false) && (strpos($contentType, 'application/xml') === false)) { - return; + return true; } - $xml = $this->queryParser->parse( - $request->getBody(), - $request->getUrl(), - $documentType - ); + if ($request->getPath() !== $this->searchBackend->getArbiterPath()) { + return true; + } + + try { + $xml = $this->queryParser->parse( + $request->getBodyAsString(), + $request->getUrl(), + $documentType + ); + } catch (ParseException $e) { + $response->setStatus(400); + $response->setBody('Parse error: ' . $e->getMessage()); + return false; + } switch ($documentType) { case '{DAV:}searchrequest': - if (!$xml['{DAV:}basicsearch']) { - throw new BadRequest('Unexpected xml content for searchrequest, expected basicsearch'); - } - /** @var BasicSearch $query */ - $query = $xml['{DAV:}basicsearch']; - $response->setStatus(207); - $response->setHeader('Content-Type', 'application/xml; charset="utf-8"'); - foreach ($query->from as $scope) { - $scope->path = $this->getPathFromUri($scope->href); - } - $results = $this->searchBackend->search($query); - $data = $this->server->generateMultiStatus(iterator_to_array($this->getPropertiesIteratorResults($results, $query->select)), false); - $response->setBody($data); - return false; + return $this->search->handleSearchRequest($xml, $response); case '{DAV:}query-schema-discovery': - if (!$xml['{DAV:}basicsearch']) { - throw new BadRequest('Unexpected xml content for query-schema-discovery, expected basicsearch'); - } - /** @var BasicSearch $query */ - $query = $xml['{DAV:}basicsearch']; - $scopes = $query->from; - $results = array_map(function (Scope $scope) { - $scope->path = $this->getPathFromUri($scope->href); - if ($this->searchBackend->isValidScope($scope->href, $scope->depth, $scope->path)) { - $searchProperties = $this->searchBackend->getPropertyDefinitionsForScope($scope->href, $scope->path); - $searchSchema = $this->getBasicSearchForProperties($searchProperties); - return new QueryDiscoverResponse($scope->href, $searchSchema, 200); - } else { - return new QueryDiscoverResponse($scope->href, null, 404); // TODO something other than 404? 403 maybe - } - }, $scopes); - $multiStatus = new MultiStatus($results); - $response->setStatus(207); - $response->setHeader('Content-Type', 'application/xml; charset="utf-8"'); - $response->setBody($this->queryParser->write('{DAV:}multistatus', $multiStatus, $request->getUrl())); - return false; + return $this->discover->handelDiscoverRequest($xml, $request, $response); default: - throw new BadRequest('Unexpected document type: ' . $documentType . ' for this Content-Type'); + $response->setStatus(400); + $response->setBody('Unexpected document type: ' . $documentType . ' for this Content-Type, expected {DAV:}searchrequest or {DAV:}query-schema-discovery'); + return false; } } - - /** - * Returns a list of properties for a given path - * - * The path that should be supplied should have the baseUrl stripped out - * The list of properties should be supplied in Clark notation. If the list is empty - * 'allprops' is assumed. - * - * If a depth of 1 is requested child elements will also be returned. - * - * @param SearchResult[] $results - * @param array $propertyNames - * @param int $depth - * @return \Iterator - */ - function getPropertiesIteratorResults($results, $propertyNames = [], $depth = 0) { - $propFindType = $propertyNames ? PropFind::NORMAL : PropFind::ALLPROPS; - - foreach ($results as $result) { - $node = $result->node; - $propFind = new PropFind($result->href, (array)$propertyNames, $depth, $propFindType); - $r = $this->server->getPropertiesByNode($propFind, $node); - if ($r) { - $result = $propFind->getResultForMultiStatus(); - $result['href'] = $propFind->getPath(); - - // WebDAV recommends adding a slash to the path, if the path is - // a collection. - // Furthermore, iCal also demands this to be the case for - // principals. This is non-standard, but we support it. - $resourceType = $this->server->getResourceTypeForNode($node); - if (in_array('{DAV:}collection', $resourceType) || in_array('{DAV:}principal', $resourceType)) { - $result['href'] .= '/'; - } - yield $result; - } - } - } - - private function hashDefinition(SearchPropertyDefinition $definition) { - return $definition->dataType - . (($definition->searchable) ? '1' : '0') - . (($definition->sortable) ? '1' : '0') - . (($definition->selectable) ? '1' : '0'); - } - - /** - * @param SearchPropertyDefinition[] $propertyDefinitions - * @return BasicSearchSchema - */ - private function getBasicSearchForProperties(array $propertyDefinitions) { - /** @var PropDesc[] $groups */ - $groups = []; - foreach ($propertyDefinitions as $propertyDefinition) { - $key = $this->hashDefinition($propertyDefinition); - if (!isset($groups[$key])) { - $desc = new PropDesc(); - $desc->dataType = $propertyDefinition->dataType; - $desc->sortable = $propertyDefinition->sortable; - $desc->selectable = $propertyDefinition->selectable; - $desc->searchable = $propertyDefinition->searchable; - $groups[$key] = $desc; - } - $groups[$key]->properties[] = $propertyDefinition->name; - } - - return new BasicSearchSchema(array_values($groups)); - } } diff --git a/src/Query/Limit.php b/src/Query/Limit.php new file mode 100644 index 0000000..f59550f --- /dev/null +++ b/src/Query/Limit.php @@ -0,0 +1,39 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace SearchDAV\Query; + +class Limit { + /** + * @var integer + * + * The maximum number of results to be returned + * + * If set to 0 then no limit should be imposed + */ + public $maxResults = 0; + /** + * @var integer + * + * The index of the first result to be returned (offset) + */ + public $firstResult = 0; +} diff --git a/src/Query/Literal.php b/src/Query/Literal.php new file mode 100644 index 0000000..99ce07a --- /dev/null +++ b/src/Query/Literal.php @@ -0,0 +1,40 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace SearchDAV\Query; + +class Literal { + /** + * @var string|boolean|\DateTime|integer + * + * The value of the literal + */ + public $value; + + /** + * Literal constructor. + * + * @param bool|\DateTime|int|string $value + */ + public function __construct($value = '') { + $this->value = $value; + } +} diff --git a/src/Query/Operator.php b/src/Query/Operator.php new file mode 100644 index 0000000..182f264 --- /dev/null +++ b/src/Query/Operator.php @@ -0,0 +1,68 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace SearchDAV\Query; + +class Operator { + const OPERATION_AND = '{DAV:}and'; + const OPERATION_OR = '{DAV:}or'; + const OPERATION_NOT = '{DAV:}not'; + const OPERATION_EQUAL = '{DAV:}eq'; + const OPERATION_LESS_THAN = '{DAV:}lt'; + const OPERATION_LESS_OR_EQUAL_THAN = '{DAV:}lte'; + const OPERATION_GREATER_THAN = '{DAV:}gt'; + const OPERATION_GREATER_OR_EQUAL_THAN = '{DAV:}gte'; + const OPERATION_IS_COLLECTION = '{DAV:}is-collection'; + const OPERATION_IS_DEFINED = '{DAV:}is-defined'; + const OPERATION_IS_LIKE = '{DAV:}like'; + const OPERATION_CONTAINS = '{DAV:}contains'; + + /** + * @var string + * + * The type of operation, one of the Operator::OPERATION_* constants + */ + public $type; + + /** + * @var (Literal|\SearchDAV\Backend\SearchPropertyDefinition|Operator)[] + * + * The list of arguments for the operation + * + * - SearchPropDefinition: property for comparison + * - Literal: literal value for comparison + * - Operator: nested operation for and/or/not operations + * + * Which type and what number of argument an Operator takes depends on the operator type. + */ + public $arguments; + + /** + * Operator constructor. + * + * @param string $type + * @param (Literal|\SearchDAV\Backend\SearchPropertyDefinition|Operator)[] $arguments + */ + public function __construct(string $type = '', array $arguments = []) { + $this->type = $type; + $this->arguments = $arguments; + } +} diff --git a/src/Query/Order.php b/src/Query/Order.php new file mode 100644 index 0000000..20f69f6 --- /dev/null +++ b/src/Query/Order.php @@ -0,0 +1,52 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace SearchDAV\Query; + +use SearchDAV\Backend\SearchPropertyDefinition; + +class Order { + const ASC = 'ascending'; + const DESC = 'descending'; + + /** + * @var SearchPropertyDefinition + * + * The property that should be sorted on. + */ + public $property; + /** + * @var string 'ascending' or 'descending' + * + * The sort direction + */ + public $order; + + /** + * Order constructor. + * @param SearchPropertyDefinition $property + * @param string $order + */ + public function __construct(SearchPropertyDefinition $property, string $order) { + $this->property = $property; + $this->order = $order; + } +} diff --git a/src/Query/Query.php b/src/Query/Query.php new file mode 100644 index 0000000..82f237c --- /dev/null +++ b/src/Query/Query.php @@ -0,0 +1,78 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace SearchDAV\Query; + +use SearchDAV\Backend\SearchPropertyDefinition; + +class Query { + /** + * @var SearchPropertyDefinition[] + * + * The list of properties to be selected + */ + public $select; + /** + * @var Scope[] + * + * The collections to perform the search in + */ + public $from; + /** + * @var ?Operator + * + * The search operator, either a comparison ('gt', 'eq', ...) or a boolean operator ('and', 'or', 'not') + */ + public $where; + /** + * @var Order[] + * + * The list of order operations that should be used to order the results. + * + * Each order operations consists of a property to sort on and a sort direction. + * If more than one order operations are specified, the comparisons for ordering should + * be applied in the order that the order operations are defined in with the earlier comparisons being + * more significant. + */ + public $orderBy; + /** + * @var Limit + * + * The limit and offset for the search query + */ + public $limit; + + /** + * Query constructor. + * @param SearchPropertyDefinition[] $select + * @param Scope[] $from + * @param Operator|null $where + * @param Order[] $orderBy + * @param Limit $limit + */ + public function __construct(array $select, array $from, ?Operator $where, array $orderBy, Limit $limit) { + $this->select = $select; + $this->from = $from; + $this->where = $where; + $this->orderBy = $orderBy; + $this->limit = $limit; + } +} diff --git a/src/Query/Scope.php b/src/Query/Scope.php new file mode 100644 index 0000000..76b41ae --- /dev/null +++ b/src/Query/Scope.php @@ -0,0 +1,59 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace SearchDAV\Query; + +class Scope { + /** + * @var string + * + * The scope of the search, either as absolute uri or as a path relative to the + * search arbiter. + */ + public $href; + + /** + * @var string|int 0, 1 or 'infinite' + * + * How deep the search query should be with 0 being only the scope itself, + * 1 being all direct child entries of the scope and infinite being all entries + * in the scope collection at any depth. + */ + public $depth; + + /** + * @var string|null + * + * the path of the search scope relative to the dav server, or null if the scope is outside the dav server + */ + public $path; + + /** + * @param string $href + * @param int|string $depth + * @param string|null $path + */ + public function __construct(string $href = '', $depth = 1, ?string $path = null) { + $this->href = $href; + $this->depth = $depth; + $this->path = $path; + } +} diff --git a/src/XML/BasicSearch.php b/src/XML/BasicSearch.php index c4f0e1b..c5451ca 100644 --- a/src/XML/BasicSearch.php +++ b/src/XML/BasicSearch.php @@ -1,4 +1,4 @@ - * @@ -21,8 +21,10 @@ namespace SearchDAV\XML; +use Sabre\Xml\ParseException; use Sabre\Xml\Reader; use Sabre\Xml\XmlDeserializable; +use function Sabre\Xml\Deserializer\keyValue; /** * The object representation of a search query made by the client @@ -41,7 +43,7 @@ class BasicSearch implements XmlDeserializable { */ public $from; /** - * @var Operator + * @var ?Operator * * The search operator, either a comparison ('gt', 'eq', ...) or a boolean operator ('and', 'or', 'not') */ @@ -57,16 +59,40 @@ class BasicSearch implements XmlDeserializable { * more significant. */ public $orderBy; + /** + * @var Limit + * + * The limit and offset for the search query + */ + public $limit; - static function xmlDeserialize(Reader $reader) { - $search = new self(); + public function __construct(array $select, array $from, ?Operator $where, array $orderBy, Limit $limit) { + $this->select = $select; + $this->from = $from; + $this->where = $where; + $this->orderBy = $orderBy; + $this->limit = $limit; + } - $elements = \Sabre\Xml\Deserializer\keyValue($reader); - $search->select = isset($elements['{DAV:}select']) ? $elements['{DAV:}select'] : null; - $search->from = isset($elements['{DAV:}from']) ? $elements['{DAV:}from'] : null; - $search->where = isset($elements['{DAV:}where']) ? $elements['{DAV:}where'] : null; - $search->orderBy = isset($elements['{DAV:}orderby']) ? $elements['{DAV:}orderby'] : null; - return $search; + /** + * @param Reader $reader + * @return BasicSearch + * @throws ParseException + */ + public static function xmlDeserialize(Reader $reader): BasicSearch { + $elements = keyValue($reader); + + if (!isset($elements['{DAV:}from'])) { + throw new ParseException('Missing {DAV:}from when parsing {DAV:}basicsearch'); + } + + return new BasicSearch( + $elements['{DAV:}select'] ?? [], + $elements['{DAV:}from'], + $elements['{DAV:}where'] ?? null, + $elements['{DAV:}orderby'] ?? [], + $elements['{DAV:}limit'] ?? new Limit() + ); } } diff --git a/src/XML/BasicSearchSchema.php b/src/XML/BasicSearchSchema.php index 0e4c30d..c68aabe 100644 --- a/src/XML/BasicSearchSchema.php +++ b/src/XML/BasicSearchSchema.php @@ -1,4 +1,4 @@ - * @@ -21,7 +21,6 @@ namespace SearchDAV\XML; - use Sabre\Xml\Writer; use Sabre\Xml\XmlSerializable; @@ -38,10 +37,10 @@ class BasicSearchSchema implements XmlSerializable { $this->properties = $properties; } - function xmlSerialize(Writer $writer) { - $childs = array_map(function(PropDesc $propDesc) { + public function xmlSerialize(Writer $writer): void { + $childs = array_map(function (PropDesc $propDesc) { return [ - 'name' => '{DAV:}propdesc', + 'name' => '{DAV:}propdesc', 'value' => $propDesc ]; }, $this->properties); diff --git a/src/XML/Limit.php b/src/XML/Limit.php new file mode 100644 index 0000000..b00809f --- /dev/null +++ b/src/XML/Limit.php @@ -0,0 +1,45 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace SearchDAV\XML; + +use Sabre\Xml\Reader; +use Sabre\Xml\XmlDeserializable; +use SearchDAV\DAV\SearchPlugin; +use function Sabre\Xml\Deserializer\keyValue; + +/** + * The limit and offset of a search query + */ +class Limit extends \SearchDAV\Query\Limit implements XmlDeserializable { + public static function xmlDeserialize(Reader $reader): Limit { + $limit = new self(); + + $elements = keyValue($reader); + $namespace = SearchPlugin::SEARCHDAV_NS; + + $limit->maxResults = isset($elements['{DAV:}nresults']) ? $elements['{DAV:}nresults'] : 0; + $firstResult = '{' . $namespace . '}firstresult'; + $limit->firstResult = isset($elements[$firstResult]) ? $elements[$firstResult] : 0; + + return $limit; + } +} diff --git a/src/XML/Literal.php b/src/XML/Literal.php index 5564c3d..dc1f69d 100644 --- a/src/XML/Literal.php +++ b/src/XML/Literal.php @@ -1,4 +1,4 @@ - * @@ -21,32 +21,19 @@ namespace SearchDAV\XML; - use Sabre\Xml\Reader; use Sabre\Xml\XmlDeserializable; -class Literal implements XmlDeserializable { - /** - * @var string|boolean|\DateTime|integer - * - * The value of the literal - */ - public $value; - - /** - * Literal constructor. - * - * @param bool|\DateTime|int|string $value - */ - public function __construct($value = '') { - $this->value = $value; - } - - - static function xmlDeserialize(Reader $reader) { +class Literal extends \SearchDAV\Query\Literal implements XmlDeserializable { + public static function xmlDeserialize(Reader $reader): Literal { $literal = new self(); - $literal->value = $reader->readText(); + if ($reader->isEmptyElement) { + $literal->value = ''; + } else { + $literal->value = $reader->readText(); + } + $reader->read(); return $literal; diff --git a/src/XML/Operator.php b/src/XML/Operator.php index a9343f5..fb44ba8 100644 --- a/src/XML/Operator.php +++ b/src/XML/Operator.php @@ -1,4 +1,4 @@ - * @@ -21,32 +21,19 @@ namespace SearchDAV\XML; - use Sabre\Xml\Reader; use Sabre\Xml\XmlDeserializable; +use SearchDAV\Query\Operator as QueryOperator; class Operator implements XmlDeserializable { - const OPERATION_AND = '{DAV:}and'; - const OPERATION_OR = '{DAV:}or'; - const OPERATION_NOT = '{DAV:}not'; - const OPERATION_EQUAL = '{DAV:}eq'; - const OPERATION_LESS_THAN = '{DAV:}lt'; - const OPERATION_LESS_OR_EQUAL_THAN = '{DAV:}lte'; - const OPERATION_GREATER_THAN = '{DAV:}gt'; - const OPERATION_GREATER_OR_EQUAL_THAN = '{DAV:}gte'; - const OPERATION_IS_COLLECTION = '{DAV:}is-collection'; - const OPERATION_IS_DEFINED = '{DAV:}is-defined'; - const OPERATION_IS_LIKE = '{DAV:}like'; - const OPERATION_CONTAINS = '{DAV:}contains'; - /** * @var string * - * The type of operation, one of the Operation::OPERATION_* constants + * The type of operation, one of the Operator::OPERATION_* constants */ public $type; /** - * @var (Literal|string|Operation)[] + * @var (Literal|string|Operator)[] * * The list of arguments for the operation * @@ -62,33 +49,41 @@ class Operator implements XmlDeserializable { * Operator constructor. * * @param string $type - * @param array $arguments + * @param (Literal|string|Operator)[] $arguments */ - public function __construct($type = '', array $arguments = []) { + public function __construct(string $type = '', array $arguments = []) { $this->type = $type; $this->arguments = $arguments; } - - static function xmlDeserialize(Reader $reader) { + public static function xmlDeserialize(Reader $reader): Operator { $operator = new self(); - $operator->type = $reader->getClark(); + $operator->type = $reader->getClark() ?? ''; if ($reader->isEmptyElement) { $reader->next(); return $operator; } + + if ($operator->type === QueryOperator::OPERATION_CONTAINS) { + $operator->arguments[] = $reader->readString(); + $reader->next(); + return $operator; + } + $reader->read(); do { if ($reader->nodeType === Reader::ELEMENT) { $argument = $reader->parseCurrentElement(); if ($argument['name'] === '{DAV:}prop') { - $operator->arguments[] = $argument['value'][0]; + $operator->arguments[] = $argument['value'][0] ?? ''; } else { $operator->arguments[] = $argument['value']; } } else { - $reader->read(); + if (!$reader->read()) { + break; + } } } while ($reader->nodeType !== Reader::END_ELEMENT); diff --git a/src/XML/Order.php b/src/XML/Order.php index e1285d3..74eab7e 100644 --- a/src/XML/Order.php +++ b/src/XML/Order.php @@ -1,4 +1,4 @@ - * @@ -21,14 +21,11 @@ namespace SearchDAV\XML; - use Sabre\Xml\Reader; use Sabre\Xml\XmlDeserializable; +use function Sabre\Xml\Deserializer\keyValue; class Order implements XmlDeserializable { - const ASC = 'ascending'; - const DESC = 'descending'; - /** * @var string * @@ -48,17 +45,17 @@ class Order implements XmlDeserializable { * @param string $property * @param string $order */ - public function __construct($property = '', $order = self::ASC) { + public function __construct(string $property = '', string $order = \SearchDAV\Query\Order::ASC) { $this->property = $property; $this->order = $order; } - static function xmlDeserialize(Reader $reader) { + public static function xmlDeserialize(Reader $reader): Order { $order = new self(); - $childs = \Sabre\Xml\Deserializer\keyValue($reader); + $childs = keyValue($reader); - $order->order = isset($childs['{DAV:}descending']) ? self::DESC : self::ASC; + $order->order = array_key_exists('{DAV:}descending', $childs) ? \SearchDAV\Query\Order::DESC : \SearchDAV\Query\Order::ASC; $order->property = $childs['{DAV:}prop'][0]; return $order; diff --git a/src/XML/PropDesc.php b/src/XML/PropDesc.php index 8d62fcf..43ada6a 100644 --- a/src/XML/PropDesc.php +++ b/src/XML/PropDesc.php @@ -1,4 +1,4 @@ - * @@ -21,21 +21,40 @@ namespace SearchDAV\XML; - use Sabre\Xml\Writer; use Sabre\Xml\XmlSerializable; +use SearchDAV\Backend\SearchPropertyDefinition; class PropDesc implements XmlSerializable { /** * @var string[] */ public $properties = []; + /** + * @var string + */ public $dataType; + /** + * @var boolean + */ public $searchable; + /** + * @var boolean + */ public $selectable; + /** + * @var boolean + */ public $sortable; - function xmlSerialize(Writer $writer) { + public function __construct(SearchPropertyDefinition $propertyDefinition) { + $this->dataType = $propertyDefinition->dataType; + $this->sortable = $propertyDefinition->sortable; + $this->selectable = $propertyDefinition->selectable; + $this->searchable = $propertyDefinition->searchable; + } + + public function xmlSerialize(Writer $writer): void { $data = [ '{DAV:}dataType' => [$this->dataType => null] ]; @@ -50,7 +69,7 @@ class PropDesc implements XmlSerializable { } $writer->write(array_map(function ($propName) { return [ - 'name' => '{DAV:}prop', + 'name' => '{DAV:}prop', 'value' => $propName ]; }, $this->properties)); diff --git a/src/XML/QueryDiscoverResponse.php b/src/XML/QueryDiscoverResponse.php index 858c3da..0d8b6a2 100644 --- a/src/XML/QueryDiscoverResponse.php +++ b/src/XML/QueryDiscoverResponse.php @@ -1,4 +1,4 @@ - * @@ -21,11 +21,14 @@ namespace SearchDAV\XML; - use Sabre\DAV\Xml\Element\Response; use Sabre\Xml\Writer; +use function Sabre\HTTP\encodePath; class QueryDiscoverResponse extends Response { + /** + * @var BasicSearchSchema|null + */ protected $schema; /** @@ -35,21 +38,23 @@ class QueryDiscoverResponse extends Response { * @param BasicSearchSchema|null $schema * @param null|int|string $httpStatus */ - function __construct($href, BasicSearchSchema $schema = null, $httpStatus = null) { + public function __construct($href, ?BasicSearchSchema $schema = null, $httpStatus = null) { + if ($httpStatus !== null) { + $httpStatus = (string)$httpStatus; + } parent::__construct($href, [], $httpStatus); $this->schema = $schema; - } - function xmlSerialize(Writer $writer) { + public function xmlSerialize(Writer $writer): void { if ($status = $this->getHTTPStatus()) { $writer->writeElement('{DAV:}status', 'HTTP/1.1 ' . $status . ' ' . \Sabre\HTTP\Response::$statusCodes[$status]); } - $writer->writeElement('{DAV:}href', \Sabre\HTTP\encodePath($this->getHref())); + $writer->writeElement('{DAV:}href', encodePath($this->getHref())); if ($this->schema) { $writer->writeElement('{DAV:}query-schema', [ - '{DAV:basicsearchschema}' => $this->schema + '{DAV:}basicsearchschema' => $this->schema ]); } } diff --git a/src/XML/Scope.php b/src/XML/Scope.php index d4d29d0..90a2384 100644 --- a/src/XML/Scope.php +++ b/src/XML/Scope.php @@ -1,4 +1,4 @@ - * @@ -21,48 +21,15 @@ namespace SearchDAV\XML; - use Sabre\Xml\Reader; use Sabre\Xml\XmlDeserializable; +use function Sabre\Xml\Deserializer\keyValue; -class Scope implements XmlDeserializable { - /** - * @var string - * - * The scope of the search, either as absolute uri or as a path relative to the - * search arbiter. - */ - public $href; - - /** - * @var string|int 0, 1 or 'infinite' - * - * How deep the search query should be with 0 being only the scope itself, - * 1 being all direct child entries of the scope and infinite being all entries - * in the scope collection at any depth. - */ - public $depth; - - /** - * @var string|null - * - * the path of the search scope relative to the dav server, or null if the scope is outside the dav server - */ - public $path; - - /** - * @param string $href - * @param int|string $depth - */ - public function __construct($href = '', $depth = 1) { - $this->href = $href; - $this->depth = $depth; - } - - static function xmlDeserialize(Reader $reader) { +class Scope extends \SearchDAV\Query\Scope implements XmlDeserializable { + public static function xmlDeserialize(Reader $reader): Scope { $scope = new self(); - $values = \Sabre\Xml\Deserializer\keyValue($reader); + $values = keyValue($reader); $scope->href = $values['{DAV:}href']; $scope->depth = $values['{DAV:}depth']; diff --git a/src/XML/SupportedQueryGrammar.php b/src/XML/SupportedQueryGrammar.php index 9b17a9b..a24e7b1 100644 --- a/src/XML/SupportedQueryGrammar.php +++ b/src/XML/SupportedQueryGrammar.php @@ -1,4 +1,4 @@ - * @@ -21,19 +21,16 @@ namespace SearchDAV\XML; - use Sabre\Xml\Writer; use Sabre\Xml\XmlSerializable; class SupportedQueryGrammar implements XmlSerializable { - const GRAMMAR_BASICSEARCH = '{DAV:}basicsearch'; + const GRAMMAR_BASIC_SEARCH = '{DAV:}basicsearch'; - public $grammar = self::GRAMMAR_BASICSEARCH; - - function xmlSerialize(Writer $writer) { + public function xmlSerialize(Writer $writer): void { $writer->startElement('{DAV:}supported-query-grammar'); $writer->startElement('{DAV:}grammar'); - $writer->startElement($this->grammar); + $writer->startElement(self::GRAMMAR_BASIC_SEARCH); $writer->endElement(); $writer->endElement(); $writer->endElement(); diff --git a/tests/DummyBackend.php b/tests/DummyBackend.php index 623dd87..822a392 100644 --- a/tests/DummyBackend.php +++ b/tests/DummyBackend.php @@ -21,35 +21,38 @@ namespace SearchDAV\Test; - use Sabre\DAV\INode; use Sabre\DAV\SimpleFile; use SearchDAV\Backend\ISearchBackend; use SearchDAV\Backend\SearchResult; +use SearchDAV\Query\Query; use SearchDAV\XML\BasicSearch; use SearchDAV\Backend\SearchPropertyDefinition; class DummyBackend implements ISearchBackend { - public function getArbiterPath() { + public function getArbiterPath(): string { return ''; } - public function isValidScope($href, $depth) { + public function isValidScope(string $href, $depth, ?string $path): bool { return true; } - public function getPropertyDefinitionsForScope($href) { + public function getPropertyDefinitionsForScope($href, $path): array { return [ - new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), + new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER), new SearchPropertyDefinition('{DAV:}getcontenttype', true, true, true), new SearchPropertyDefinition('{DAV:}displayname', true, true, true), - new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), + new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true, SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER), ]; } - public function search(INode $searchNode, BasicSearch $query) { + public function search(Query $query): array { return [ new SearchResult(new SimpleFile('foo.txt', 'foobar', 'text/plain'), '/bar/foo.txt') ]; } + + public function preloadPropertyFor(array $nodes, array $requestProperties): void { + } } diff --git a/tests/PathHelperTest.php b/tests/PathHelperTest.php new file mode 100644 index 0000000..1a83a6a --- /dev/null +++ b/tests/PathHelperTest.php @@ -0,0 +1,52 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace SearchDAV\Test; + +use PHPUnit\Framework\TestCase; +use Sabre\DAV\Server; +use SearchDAV\DAV\PathHelper; + +class PathHelperTest extends TestCase { + public function uriProvider() { + return [ + ['/', '', ''], + ['/index.php/', 'foo', 'foo'], + ['/index.php/', 'http://example.com/index.php/foo', 'foo'], + ['/index.php/', 'http://example.com/foo', null] + ]; + } + + /** + * @dataProvider uriProvider + * + * @param $baseUri + * @param $uri + * @param $expected + */ + public function testGetPathFromUri($baseUri, $uri, $expected) { + $server = new Server(); + $server->setBaseUri($baseUri); + $pathHelper = new PathHelper($server); + + $this->assertEquals($expected, $pathHelper->getPathFromUri($uri)); + } +} diff --git a/tests/QueryParserTest.php b/tests/QueryParserTest.php index 40acee7..84e6b8c 100644 --- a/tests/QueryParserTest.php +++ b/tests/QueryParserTest.php @@ -21,16 +21,19 @@ namespace SearchDAV\Test; - +use PHPUnit\Framework\TestCase; +use Sabre\Xml\ParseException; +use Sabre\Xml\Service; use SearchDAV\DAV\QueryParser; use SearchDAV\XML\BasicSearch; +use SearchDAV\XML\Limit; use SearchDAV\XML\Literal; use SearchDAV\XML\Operator; use SearchDAV\XML\Order; use SearchDAV\XML\Scope; +use SearchDAV\XML\SupportedQueryGrammar; - -class QueryParserTest extends \PHPUnit_Framework_TestCase { +class QueryParserTest extends TestCase { public function testParseBasicQuery() { $query = file_get_contents(__DIR__ . '/basicquery.xml'); $parser = new QueryParser(); @@ -45,14 +48,136 @@ class QueryParserTest extends \PHPUnit_Framework_TestCase { $this->assertEquals(['{DAV:}getcontentlength'], $search->select); $this->assertEquals([ - new Scope('/container1/', 'infinity') + new Scope('/container1/', 'infinity'), ], $search->from); - $this->assertEquals(new Operator(Operator::OPERATION_GREATER_THAN, [ + $this->assertEquals(new Operator(\SearchDAV\Query\Operator::OPERATION_GREATER_THAN, [ '{DAV:}getcontentlength', - new Literal(10000) + new Literal(10000), ]), $search->where); $this->assertEquals([ - new Order('{DAV:}getcontentlength', Order::ASC) + new Order('{DAV:}getcontentlength', \SearchDAV\Query\Order::ASC), ], $search->orderBy); } + + public function testParseDescending() { + $query = file_get_contents(__DIR__ . '/descending.xml'); + $parser = new QueryParser(); + $xml = $parser->parse($query, null, $rootElementName); + + $this->assertEquals('{DAV:}searchrequest', $rootElementName); + $this->assertArrayHasKey('{DAV:}basicsearch', $xml); + + /** @var BasicSearch $search */ + $search = $xml['{DAV:}basicsearch']; + $this->assertInstanceOf(BasicSearch::class, $search); + + $this->assertEquals(['{DAV:}getcontentlength'], $search->select); + $this->assertEquals([ + new Scope('/container1/', 'infinity'), + ], $search->from); + $this->assertEquals(new Operator(\SearchDAV\Query\Operator::OPERATION_GREATER_THAN, [ + '{DAV:}getcontentlength', + new Literal(10000), + ]), $search->where); + $this->assertEquals([ + new Order('{DAV:}getcontentlength', \SearchDAV\Query\Order::DESC), + ], $search->orderBy); + } + + public function testParseNoOrder() { + $query = file_get_contents(__DIR__ . '/noorder.xml'); + $parser = new QueryParser(); + $xml = $parser->parse($query, null, $rootElementName); + + $this->assertEquals('{DAV:}searchrequest', $rootElementName); + $this->assertArrayHasKey('{DAV:}basicsearch', $xml); + + /** @var BasicSearch $search */ + $search = $xml['{DAV:}basicsearch']; + $this->assertInstanceOf(BasicSearch::class, $search); + + $this->assertEquals(['{DAV:}getcontentlength'], $search->select); + $this->assertEquals([ + new Scope('/container1/', 'infinity'), + new Scope('/container2/', 1), + ], $search->from); + $this->assertEquals(new Operator(\SearchDAV\Query\Operator::OPERATION_IS_COLLECTION, []), $search->where); + $this->assertEquals([], $search->orderBy); + } + + public function testParseNoFrom() { + $query = file_get_contents(__DIR__ . '/nofrom.xml'); + $parser = new QueryParser(); + $this->expectException(ParseException::class); + $parser->parse($query, null, $rootElementName); + } + + public function testSerializeSupportedGrammar() { + $supportedGrammar = new SupportedQueryGrammar(); + + $parser = new QueryParser(); + $serialized = $parser->write('{DAV:}supported-query-grammar-set', $supportedGrammar); + + $xml = new Service(); + $this->assertEquals($xml->parse(fopen(__DIR__ . '/supportedgrammar.xml', 'r')), $xml->parse($serialized)); + } + + public function testParseLimit() { + $query = file_get_contents(__DIR__ . '/limit.xml'); + $parser = new QueryParser(); + $xml = $parser->parse($query, null, $rootElementName); + + $this->assertEquals('{DAV:}searchrequest', $rootElementName); + $this->assertArrayHasKey('{DAV:}basicsearch', $xml); + + /** @var BasicSearch $search */ + $search = $xml['{DAV:}basicsearch']; + $this->assertInstanceOf(BasicSearch::class, $search); + + $this->assertEquals(['{DAV:}getcontentlength'], $search->select); + $limit = new Limit(); + $limit->firstResult = 20; + $limit->maxResults = 10; + $this->assertEquals($limit, $search->limit); + } + + public function testParseComplexQuery() { + $query = file_get_contents(__DIR__ . '/complexquery.xml'); + $parser = new QueryParser(); + $xml = $parser->parse($query, null, $rootElementName); + + $this->assertEquals('{DAV:}searchrequest', $rootElementName); + $this->assertArrayHasKey('{DAV:}basicsearch', $xml); + + /** @var BasicSearch $search */ + $search = $xml['{DAV:}basicsearch']; + $this->assertInstanceOf(BasicSearch::class, $search); + + $this->assertEquals(['{DAV:}getcontentlength'], $search->select); + $this->assertEquals([ + new Scope('/container1/', 'infinity'), + ], $search->from); + $this->assertEquals(new Operator(\SearchDAV\Query\Operator::OPERATION_AND, [ + new Operator(\SearchDAV\Query\Operator::OPERATION_GREATER_THAN, [ + '{DAV:}getcontentlength', + new Literal(10000), + ]), + new Operator(\SearchDAV\Query\Operator::OPERATION_LESS_THAN, [ + '{DAV:}getcontentlength', + new Literal(90000), + ]), + new Operator(\SearchDAV\Query\Operator::OPERATION_CONTAINS, [ + 'Peter Forsberg', + ]), + ]), $search->where); + $this->assertEquals([ + new Order('{DAV:}getcontentlength', \SearchDAV\Query\Order::ASC), + ], $search->orderBy); + } + + public function testParseWhereBroken() { + $query = file_get_contents(__DIR__ . '/invalidwherebroken.xml'); + $this->expectException(ParseException::class); + (new QueryParser())->parse($query, null, $rootElementName); + } } diff --git a/tests/SearchPluginTest.php b/tests/SearchPluginTest.php new file mode 100644 index 0000000..7ce28d6 --- /dev/null +++ b/tests/SearchPluginTest.php @@ -0,0 +1,613 @@ + + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +namespace SearchDAV\Test; + +use PHPUnit\Framework\TestCase; +use Sabre\DAV\FS\Directory; +use Sabre\DAV\INode; +use Sabre\DAV\PropFind; +use Sabre\DAV\Server; +use Sabre\DAV\Xml\Service; +use Sabre\HTTP\Request; +use Sabre\HTTP\Response; +use SearchDAV\Backend\ISearchBackend; +use SearchDAV\Backend\SearchPropertyDefinition; +use SearchDAV\Backend\SearchResult; +use SearchDAV\DAV\SearchPlugin; +use SearchDAV\Query\Query; +use SearchDAV\XML\Limit; +use SearchDAV\XML\Literal; +use SearchDAV\XML\Scope; +use SearchDAV\XML\SupportedQueryGrammar; + +class SearchPluginTest extends TestCase { + /** @var ISearchBackend|\PHPUnit_Framework_MockObject_MockObject */ + private $searchBackend; + + protected function setUp(): void { + parent::setUp(); + + $this->searchBackend = $this->getMockBuilder(ISearchBackend::class) + ->getMock(); + } + + public function testNoXmlBody() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $request = new Request('SEARCH', 'foo', [ + 'Content-Type' => 'text/plain', + ], fopen(__DIR__ . '/nofrom.xml', 'r')); + $response = new Response(); + + $plugin = new SearchPlugin($this->searchBackend); + + $this->assertNotEquals(false, $plugin->searchHandler($request, $response)); + } + + public function testNotArbiterPath() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $request = new Request('SEARCH', 'bar', [ + 'Content-Type' => 'text/xml', + ], fopen(__DIR__ . '/nofrom.xml', 'r')); + $response = new Response(); + + $plugin = new SearchPlugin($this->searchBackend); + + $this->assertNotEquals(false, $plugin->searchHandler($request, $response)); + } + + public function testInvalidType() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $request = new Request('SEARCH', 'foo', [ + 'Content-Type' => 'text/xml', + ], fopen(__DIR__ . '/invalidtype.xml', 'r')); + $response = new Response(); + + $plugin = new SearchPlugin($this->searchBackend); + + $plugin->searchHandler($request, $response); + + $this->assertEquals(400, $response->getStatus()); + } + + public function testHandleParseException() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $request = new Request('SEARCH', 'foo', [ + 'Content-Type' => 'text/xml', + ], fopen(__DIR__ . '/nofrom.xml', 'r')); + $response = new Response(); + + $plugin = new SearchPlugin($this->searchBackend); + + $plugin->searchHandler($request, $response); + + $this->assertEquals(400, $response->getStatus()); + } + + public function testHTTPMethods() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $plugin = new SearchPlugin($this->searchBackend); + $server = new Server(); + $server->setBaseUri('/index.php'); + $plugin->initialize($server); + + $this->assertEquals([], $plugin->getHTTPMethods('bar')); + + $this->assertEquals(['SEARCH'], $plugin->getHTTPMethods('foo')); + + $this->assertEquals([], $plugin->getHTTPMethods('http://example.com/index.php/bar')); + + $this->assertEquals(['SEARCH'], $plugin->getHTTPMethods('http://example.com/index.php/foo')); + } + + public function testOptionHandler() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $plugin = new SearchPlugin($this->searchBackend); + + $request = new Request('OPTIONS', '/index.php/bar'); + $request->setBaseUrl('/index.php'); + $response = new Response(); + + $plugin->optionHandler($request, $response); + + $this->assertEquals(false, $response->hasHeader('DASL')); + + $request = new Request('OPTIONS', '/index.php/foo'); + $request->setBaseUrl('/index.php'); + $response = new Response(); + + $plugin->optionHandler($request, $response); + + $this->assertEquals(true, $response->hasHeader('DASL')); + } + + public function testSchemaDiscovery() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $plugin = new SearchPlugin($this->searchBackend); + $server = new Server(); + $plugin->initialize($server); + + $request = new Request('SEARCH', '/index.php/foo', [ + 'Content-Type' => 'text/xml', + ]); + $request->setBaseUrl('/index.php'); + $request->setBody(fopen(__DIR__ . '/discover.xml', 'r')); + $response = new Response(); + + $this->searchBackend->expects($this->once()) + ->method('isValidScope') + ->willReturn(true); + + $this->searchBackend->expects($this->once()) + ->method('getPropertyDefinitionsForScope') + ->willReturn([ + new SearchPropertyDefinition( + '{DAV:}getcontentlength', + true, + true, + true, + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER + ), + new SearchPropertyDefinition('{DAV:}getcontenttype', true, true, true), + new SearchPropertyDefinition('{DAV:}displayname', true, true, true), + new SearchPropertyDefinition( + '{http://ns.nextcloud.com:}fileid', + false, + true, + true, + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER + ), + ]); + + $plugin->searchHandler($request, $response); + + $parser = new Service(); + $parsedResponse = $parser->parse($response->getBody()); + $expected = $parser->parse(fopen(__DIR__ . '/discoverresponse.xml', 'r')); + $this->assertEquals($expected, $parsedResponse); + } + + public function testSchemaDiscoveryInvalidScope() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $plugin = new SearchPlugin($this->searchBackend); + $server = new Server(); + $plugin->initialize($server); + + $request = new Request('SEARCH', '/index.php/foo', [ + 'Content-Type' => 'text/xml', + ]); + $request->setBaseUrl('/index.php'); + $request->setBody(fopen(__DIR__ . '/discover.xml', 'r')); + $response = new Response(); + + $this->searchBackend->expects($this->once()) + ->method('isValidScope') + ->willReturn(false); + + $this->searchBackend->expects($this->never()) + ->method('getPropertyDefinitionsForScope'); + + $plugin->searchHandler($request, $response); + + $parser = new Service(); + $parsedResponse = $parser->parse($response->getBody()); + $expected = $parser->parse(fopen(__DIR__ . '/invalidscoperesponse.xml', 'r')); + $this->assertEquals($expected, $parsedResponse); + } + + public function testSchemaDiscoveryInvalid() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $plugin = new SearchPlugin($this->searchBackend); + $server = new Server(); + $plugin->initialize($server); + + $request = new Request('SEARCH', '/index.php/foo', [ + 'Content-Type' => 'text/xml', + ]); + $request->setBaseUrl('/index.php'); + $request->setBody(fopen(__DIR__ . '/invaliddiscover.xml', 'r')); + $response = new Response(); + + $this->searchBackend->expects($this->never()) + ->method('isValidScope'); + + $this->searchBackend->expects($this->never()) + ->method('getPropertyDefinitionsForScope'); + + $plugin->searchHandler($request, $response); + + $this->assertEquals(400, $response->getStatus()); + } + + public function testSearchQuery() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $plugin = new SearchPlugin($this->searchBackend); + $server = new Server(); + $plugin->initialize($server); + + $request = new Request('SEARCH', '/index.php/foo', [ + 'Content-Type' => 'text/xml', + ]); + $request->setBaseUrl('/index.php'); + $request->setBody(fopen(__DIR__ . '/basicquery.xml', 'r')); + $response = new Response(); + + $this->searchBackend->expects($this->any()) + ->method('isValidScope') + ->willReturn(true); + + $lengthProp = new SearchPropertyDefinition( + '{DAV:}getcontentlength', + true, + true, + true, + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER + ); + $orderBy = [ + new \SearchDAV\Query\Order($lengthProp, \SearchDAV\Query\Order::ASC), + ]; + $select = [$lengthProp]; + $from = [ + new Scope('/container1/', 'infinity', '/container1/'), + ]; + $where = new \SearchDAV\Query\Operator(\SearchDAV\Query\Operator::OPERATION_GREATER_THAN, [ + $lengthProp, + new Literal(10000), + ]); + $limit = new Limit(); + $query = new Query($select, $from, $where, $orderBy, $limit); + + $this->searchBackend->expects($this->once()) + ->method('search') + ->with($query) + ->willReturn([ + new SearchResult( + new Directory('/foo'), + '/foo' + ), + ]); + + $this->searchBackend->expects($this->any()) + ->method('getPropertyDefinitionsForScope') + ->willReturn([ + $lengthProp, + ]); + + $plugin->searchHandler($request, $response); + + $parser = new Service(); + $parsedResponse = $parser->parse($response->getBody()); + $expected = $parser->parse(fopen(__DIR__ . '/searchresult.xml', 'r')); + $this->assertEquals($expected, $parsedResponse); + } + + public function testSearchQueryNoFrom() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $plugin = new SearchPlugin($this->searchBackend); + $server = new Server(); + $plugin->initialize($server); + + $request = new Request('SEARCH', '/index.php/foo', [ + 'Content-Type' => 'text/xml', + ]); + $request->setBaseUrl('/index.php'); + $request->setBody(fopen(__DIR__ . '/nofrom.xml', 'r')); + $response = new Response(); + + $this->searchBackend->expects($this->any()) + ->method('isValidScope') + ->willReturn(true); + + $this->searchBackend->expects($this->never()) + ->method('search'); + + $plugin->searchHandler($request, $response); + + $this->assertEquals(400, $response->getStatus()); + } + + public function testSearchQueryNoWhere() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $lengthProp = new SearchPropertyDefinition( + '{DAV:}getcontentlength', + true, + true, + true, + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER + ); + $plugin = new SearchPlugin($this->searchBackend); + $server = new Server(); + $plugin->initialize($server); + + $request = new Request('SEARCH', '/index.php/foo', [ + 'Content-Type' => 'text/xml', + ]); + $request->setBaseUrl('/index.php'); + $request->setBody(fopen(__DIR__ . '/nowhere.xml', 'r')); + $response = new Response(); + + $this->searchBackend->expects($this->any()) + ->method('isValidScope') + ->willReturn(true); + + $this->searchBackend->expects($this->any()) + ->method('getPropertyDefinitionsForScope') + ->willReturn([$lengthProp]); + + $this->searchBackend->expects($this->once()) + ->method('search') + ->willReturnCallback(function (Query $query) { + $this->assertNull($query->where); + return []; + }); + + $plugin->searchHandler($request, $response); + + $this->assertEquals(207, $response->getStatus()); + } + + public function testSearchQueryNoSelect() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $plugin = new SearchPlugin($this->searchBackend); + $server = new Server(); + $plugin->initialize($server); + + $request = new Request('SEARCH', '/index.php/foo', [ + 'Content-Type' => 'text/xml', + ]); + $request->setBaseUrl('/index.php'); + $request->setBody(fopen(__DIR__ . '/noselect.xml', 'r')); + $response = new Response(); + + $this->searchBackend->expects($this->any()) + ->method('isValidScope') + ->willReturn(true); + + $this->searchBackend->expects($this->never()) + ->method('search'); + + $plugin->searchHandler($request, $response); + + $this->assertEquals(400, $response->getStatus()); + } + + public function testSearchInvalid() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $plugin = new SearchPlugin($this->searchBackend); + $server = new Server(); + $plugin->initialize($server); + + $request = new Request('SEARCH', '/index.php/foo', [ + 'Content-Type' => 'text/xml', + ]); + $request->setBaseUrl('/index.php'); + $request->setBody(fopen(__DIR__ . '/invalid.xml', 'r')); + $response = new Response(); + + $this->searchBackend->expects($this->any()) + ->method('isValidScope') + ->willReturn(true); + + $this->searchBackend->expects($this->never()) + ->method('search'); + + $plugin->searchHandler($request, $response); + + $this->assertEquals(400, $response->getStatus()); + } + + public function testPropFindHandler() { + $propFind = new PropFind('bar', ['{DAV:}supported-query-grammar-set']); + + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $plugin = new SearchPlugin($this->searchBackend); + + /** @var INode $node */ + $node = $this->getMockBuilder(INode::class)->getMock(); + $plugin->propFindHandler($propFind, $node); + + $this->assertEquals(null, $propFind->get('{DAV:}supported-query-grammar-set')); + + $propFind = new PropFind('foo', ['{DAV:}supported-query-grammar-set']); + $plugin->propFindHandler($propFind, $node); + + $this->assertEquals(new SupportedQueryGrammar(), $propFind->get('{DAV:}supported-query-grammar-set')); + } + + public function testSearchQueryInvalidWhere() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $plugin = new SearchPlugin($this->searchBackend); + $server = new Server(); + $plugin->initialize($server); + + $request = new Request('SEARCH', '/index.php/foo', [ + 'Content-Type' => 'text/xml', + ]); + $request->setBaseUrl('/index.php'); + $request->setBody(fopen(__DIR__ . '/invalidwhere.xml', 'r')); + $response = new Response(); + + $this->searchBackend->expects($this->any()) + ->method('isValidScope') + ->willReturn(true); + + $this->searchBackend->expects($this->never()) + ->method('search'); + + $this->searchBackend->expects($this->once()) + ->method('getPropertyDefinitionsForScope') + ->willReturn([ + new SearchPropertyDefinition( + '{http://ns.nextcloud.com:}fileid', + false, + true, + true, + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER + ), + ]); + + $plugin->searchHandler($request, $response); + + $this->assertEquals(400, $response->getStatus()); + } + + public function testSearchQueryInvalidWhereNoProp() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $plugin = new SearchPlugin($this->searchBackend); + $server = new Server(); + $plugin->initialize($server); + + $request = new Request('SEARCH', '/index.php/foo', [ + 'Content-Type' => 'text/xml', + ]); + $request->setBaseUrl('/index.php'); + $request->setBody(fopen(__DIR__ . '/invalidwherenoprop.xml', 'r')); + $response = new Response(); + + $this->searchBackend->expects($this->any()) + ->method('isValidScope') + ->willReturn(true); + + $this->searchBackend->expects($this->never()) + ->method('search'); + + $this->searchBackend->expects($this->any()) + ->method('getPropertyDefinitionsForScope') + ->willReturn([ + new SearchPropertyDefinition( + '{http://ns.nextcloud.com:}fileid', + false, + true, + true, + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER + ), + new SearchPropertyDefinition( + '{DAV:}getcontentlength', + true, + true, + true, + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER + ), + ]); + + $plugin->searchHandler($request, $response); + + $this->assertEquals(400, $response->getStatus()); + } + + public function testSearchQueryInfiniteLoopEmptyLiteral() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $plugin = new SearchPlugin($this->searchBackend); + $server = new Server(); + $plugin->initialize($server); + + $request = new Request('SEARCH', '/index.php/foo', [ + 'Content-Type' => 'text/xml', + ]); + $request->setBaseUrl('/index.php'); + $request->setBody(fopen(__DIR__ . '/infiniteloopemptyliteral.xml', 'r')); + $response = new Response(); + + $this->searchBackend->expects($this->any()) + ->method('isValidScope') + ->willReturn(true); + + $this->searchBackend->expects($this->never()) + ->method('search'); + + $this->searchBackend->expects($this->any()) + ->method('getPropertyDefinitionsForScope') + ->willReturn([ + new SearchPropertyDefinition( + '{http://ns.nextcloud.com:}fileid', + false, + true, + true, + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER + ), + new SearchPropertyDefinition( + '{DAV:}getcontentlength', + true, + true, + true, + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER + ), + ]); + + $plugin->searchHandler($request, $response); + + $this->assertEquals(400, $response->getStatus()); + } +} diff --git a/tests/bootstrap.php b/tests/bootstrap.php new file mode 100644 index 0000000..d21c14d --- /dev/null +++ b/tests/bootstrap.php @@ -0,0 +1,3 @@ + + + + + + + + + + + /container1/ + infinity + + + + + + + + + 10000 + + + + + + 90000 + + Peter Forsberg + + + + + + + + + + + + diff --git a/tests/descending.xml b/tests/descending.xml new file mode 100644 index 0000000..0e4e361 --- /dev/null +++ b/tests/descending.xml @@ -0,0 +1,32 @@ + + + + + + + + + + + /container1/ + infinity + + + + + + + + 10000 + + + + + + + + + + + + diff --git a/tests/discover.xml b/tests/discover.xml new file mode 100644 index 0000000..53c27c1 --- /dev/null +++ b/tests/discover.xml @@ -0,0 +1,11 @@ + + + + + + /test + infinity + + + + diff --git a/tests/discoverresponse.xml b/tests/discoverresponse.xml new file mode 100644 index 0000000..bb65cb0 --- /dev/null +++ b/tests/discoverresponse.xml @@ -0,0 +1,41 @@ + + + + HTTP/1.1 200 OK + /test + + + + + {DAV:}getcontentlength + + + + + + + + + {DAV:}getcontenttype + {DAV:}displayname + + + + + + + + + {http://ns.nextcloud.com:}fileid + + + + + + + + + + + diff --git a/tests/infiniteloopemptyliteral.xml b/tests/infiniteloopemptyliteral.xml new file mode 100644 index 0000000..7fa428a --- /dev/null +++ b/tests/infiniteloopemptyliteral.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + + + + + + + + + /files/naofumi + infinity + + + + + + \ No newline at end of file diff --git a/tests/invalid.xml b/tests/invalid.xml new file mode 100644 index 0000000..5956e5d --- /dev/null +++ b/tests/invalid.xml @@ -0,0 +1,30 @@ + + + + + + + + + + /container1/ + infinity + + + + + + + + 10000 + + + + + + + + + + + diff --git a/tests/invaliddiscover.xml b/tests/invaliddiscover.xml new file mode 100644 index 0000000..be4c289 --- /dev/null +++ b/tests/invaliddiscover.xml @@ -0,0 +1,9 @@ + + + + + /test + infinity + + + diff --git a/tests/invalidscoperesponse.xml b/tests/invalidscoperesponse.xml new file mode 100644 index 0000000..e018adf --- /dev/null +++ b/tests/invalidscoperesponse.xml @@ -0,0 +1,8 @@ + + + + HTTP/1.1 404 Not Found + /test + + diff --git a/tests/invalidtype.xml b/tests/invalidtype.xml new file mode 100644 index 0000000..0d9acf0 --- /dev/null +++ b/tests/invalidtype.xml @@ -0,0 +1,22 @@ + + + + + + + + + + /container1/ + infinity + + + + + + + + + + + diff --git a/tests/invalidwhere.xml b/tests/invalidwhere.xml new file mode 100644 index 0000000..7cbc0e6 --- /dev/null +++ b/tests/invalidwhere.xml @@ -0,0 +1,32 @@ + + + + + + + + + + + /container1/ + infinity + + + + + + + + 5 + + + + + + + + + + + + diff --git a/tests/invalidwherebroken.xml b/tests/invalidwherebroken.xml new file mode 100644 index 0000000..04025dd --- /dev/null +++ b/tests/invalidwherebroken.xml @@ -0,0 +1,22 @@ + + + + + + + + + + + /container1/ + infinity + + + + + + 5 + + + + diff --git a/tests/invalidwherenoprop.xml b/tests/invalidwherenoprop.xml new file mode 100644 index 0000000..8613100 --- /dev/null +++ b/tests/invalidwherenoprop.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + /container1/ + infinity + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/tests/limit.xml b/tests/limit.xml new file mode 100644 index 0000000..25d2852 --- /dev/null +++ b/tests/limit.xml @@ -0,0 +1,37 @@ + + + + + + + + + + + /container1/ + infinity + + + + + + + + 10000 + + + + + + + + + + + + 10 + 20 + + + diff --git a/tests/nofrom.xml b/tests/nofrom.xml new file mode 100644 index 0000000..d4866af --- /dev/null +++ b/tests/nofrom.xml @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + 10000 + + + + + + + + + + + + diff --git a/tests/noorder.xml b/tests/noorder.xml new file mode 100644 index 0000000..bea72d3 --- /dev/null +++ b/tests/noorder.xml @@ -0,0 +1,23 @@ + + + + + + + + + + + /container1/ + infinity + + + /container2/ + 1 + + + + + + + diff --git a/tests/noselect.xml b/tests/noselect.xml new file mode 100644 index 0000000..b8f913f --- /dev/null +++ b/tests/noselect.xml @@ -0,0 +1,27 @@ + + + + + + /container1/ + infinity + + + + + + + + 10000 + + + + + + + + + + + + diff --git a/tests/nowhere.xml b/tests/nowhere.xml new file mode 100644 index 0000000..4ec36c6 --- /dev/null +++ b/tests/nowhere.xml @@ -0,0 +1,24 @@ + + + + + + + + + + + /container1/ + infinity + + + + + + + + + + + + diff --git a/tests/phpunit.xml b/tests/phpunit.xml new file mode 100644 index 0000000..cabfbf4 --- /dev/null +++ b/tests/phpunit.xml @@ -0,0 +1,11 @@ + + + + ./ + + + + ../src + + + diff --git a/tests/searchresult.xml b/tests/searchresult.xml new file mode 100644 index 0000000..0563d8b --- /dev/null +++ b/tests/searchresult.xml @@ -0,0 +1,12 @@ + + + + foo/ + + + + + HTTP/1.1 404 Not Found + + + diff --git a/tests/supportedgrammar.xml b/tests/supportedgrammar.xml new file mode 100644 index 0000000..37c2503 --- /dev/null +++ b/tests/supportedgrammar.xml @@ -0,0 +1,9 @@ + + + + + + + + diff --git a/tests/test.php b/tests/test.php deleted file mode 100644 index a93ba6c..0000000 --- a/tests/test.php +++ /dev/null @@ -1,9 +0,0 @@ -parse($body)['{DAV:}basicsearch']); diff --git a/tests/testserver.php b/tests/testserver.php deleted file mode 100644 index ec4bb9e..0000000 --- a/tests/testserver.php +++ /dev/null @@ -1,8 +0,0 @@ -addPlugin(new \SearchDAV\DAV\SearchPlugin(new \SearchDAV\Test\DummyBackend())); - -$server->exec();