├── .github ├── dependabot.yml └── workflows │ ├── automerge-dependabot.yml │ ├── ci.yml │ ├── main.yml │ └── publish-to-docker.yml ├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── bin └── htaccess ├── composer.json ├── phpstan.neon ├── phpunit.xml.dist ├── src ├── Htaccess │ └── TableRenderer.php └── HtaccessCommand.php └── tests ├── HtaccessCommandTest.php └── MultipleUrlsTest.php /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: composer 4 | directory: "/" 5 | schedule: 6 | interval: daily 7 | time: "03:30" 8 | versioning-strategy: widen 9 | -------------------------------------------------------------------------------- /.github/workflows/automerge-dependabot.yml: -------------------------------------------------------------------------------- 1 | name: Enable automerge on dependabot PRs 2 | 3 | on: 4 | pull_request_target: 5 | 6 | jobs: 7 | automerge: 8 | name: Enable automerge on dependabot PRs 9 | runs-on: ubuntu-latest 10 | steps: 11 | - name: Enable automerge on dependabot PRs 12 | uses: daneden/enable-automerge-action@v1 13 | with: 14 | github-token: ${{ secrets.DEPENDABOT_AUTO_MERGE_PERSONAL_ACCESS_TOKEN }} 15 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: Continious Integration 2 | on: push 3 | 4 | jobs: 5 | phpstan: 6 | name: PHPStan 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@master 10 | - uses: shivammathur/setup-php@v2 11 | with: 12 | php-version: '8.0' 13 | tools: composer 14 | - name: Install dependencies 15 | run: composer update -n --prefer-dist 16 | - name: PHPStan 17 | run: vendor/bin/phpstan analyse 18 | 19 | phpunit: 20 | runs-on: ubuntu-latest 21 | strategy: 22 | matrix: 23 | php-versions: ['8.0', '8.1'] 24 | prefer-lowest: ['', '--prefer-lowest'] 25 | steps: 26 | - uses: actions/checkout@master 27 | - uses: shivammathur/setup-php@v2 28 | with: 29 | php-version: ${{ matrix.php-versions }} 30 | coverage: pcov 31 | tools: composer 32 | - name: Install dependencies 33 | if: matrix.php-versions != '8.1' 34 | run: composer update -n --prefer-dist ${{ matrix.prefer-lowest }} 35 | - name: Install dependencies 36 | if: matrix.php-versions == '8.1' 37 | run: composer install -n --prefer-dist --ignore-platform-req=php 38 | - name: Run PHPUnit unit tests 39 | run: vendor/bin/phpunit --coverage-clover=build/logs/clover.xml 40 | - uses: codecov/codecov-action@v1 41 | with: 42 | token: ${{ secrets.CODECOV_TOKEN }} 43 | if: matrix.php-versions == '8.0' 44 | 45 | run: 46 | name: Run current version 47 | runs-on: ubuntu-latest 48 | steps: 49 | - uses: actions/checkout@master 50 | - name: Install dependencies 51 | run: composer install -n --prefer-dist 52 | - name: Add a very basic htaccess file 53 | run: echo "RewriteRule .* /foo" >> .htaccess 54 | - name: Run current version of htaccess cli 55 | run: bin/htaccess https://example.com 56 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: Verify that main branch is installable and usable 2 | on: 3 | push: 4 | branches: 5 | - main 6 | 7 | jobs: 8 | install-and-test: 9 | name: Check that this is installable and usable 10 | runs-on: ubuntu-latest 11 | steps: 12 | - name: Wait for a bit before trying to fetch the new version 13 | run: sleep 300 14 | - name: Clear composer cache 15 | run: composer clear-cache 16 | - name: Require this version 17 | run: composer require madewithlove/htaccess-cli:dev-${GITHUB_REF##*/}#$GITHUB_SHA --prefer-source 18 | - name: Add a very basic htaccess file 19 | run: echo "RewriteRule .* /foo" >> .htaccess 20 | - name: Run the htaccess tester 21 | run: vendor/bin/htaccess http://localhost 22 | -------------------------------------------------------------------------------- /.github/workflows/publish-to-docker.yml: -------------------------------------------------------------------------------- 1 | name: Publish new tags to Docker Hub 2 | 3 | on: 4 | push: 5 | tags: 6 | - 'v*' 7 | 8 | jobs: 9 | docker-publish: 10 | name: Publish new tag to Docker 11 | runs-on: ubuntu-latest 12 | steps: 13 | - uses: actions/checkout@master 14 | - name: Do a docker login 15 | env: 16 | DOCKER_HUB_LOGIN: ${{ secrets.DOCKER_HUB_LOGIN }} 17 | DOCKER_HUB_PASS: ${{ secrets.DOCKER_HUB_PASS }} 18 | run: docker login -u ${DOCKER_HUB_LOGIN} -p ${DOCKER_HUB_PASS} 19 | - name: Get version name 20 | id: get_version 21 | run: echo ::set-output name=version::$(echo ${GITHUB_REF##*/} | cut -c2-) 22 | - name: Wait for package to become available on packagist 23 | run: sleep 300 24 | - name: Build docker container 25 | run: docker build --build-arg VERSION=${{ steps.get_version.outputs.version }} -f Dockerfile --tag madewithlove/htaccess-cli:${{ steps.get_version.outputs.version }} . 26 | - name: Publish docker container to Docker Hub 27 | run: docker push madewithlove/htaccess-cli:${{ steps.get_version.outputs.version }} 28 | - name: Build docker container as latest 29 | run: docker build --build-arg VERSION=${{ steps.get_version.outputs.version }} -f Dockerfile --tag madewithlove/htaccess-cli:latest . 30 | - name: Publish docker container to Docker Hub 31 | run: docker push madewithlove/htaccess-cli:latest 32 | - uses: 8398a7/action-slack@v2 33 | with: 34 | status: ${{ job.status }} 35 | author_name: Docker hub publish 36 | env: 37 | GITHUB_TOKEN: ${{ secrets.GITHUB_PERSONAL_TOKEN }} 38 | SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} 39 | if: always() 40 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .htaccess 2 | /vendor/ 3 | composer.lock 4 | *.cache 5 | coverage/ 6 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM php:cli-alpine 2 | 3 | ENV COMPOSER_HOME /composer 4 | ENV COMPOSER_ALLOW_SUPERUSER 1 5 | ENV PATH /composer/vendor/bin:$PATH 6 | 7 | COPY --from=composer:latest /usr/bin/composer /usr/bin/composer 8 | 9 | ARG VERSION 10 | 11 | RUN composer global require madewithlove/htaccess-cli:"$VERSION" 12 | 13 | VOLUME ["/app"] 14 | WORKDIR /app 15 | 16 | ENTRYPOINT ["htaccess"] 17 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # htaccess CLI 2 | 3 | [![Build status](https://github.com/madewithlove/htaccess-cli/workflows/Continious%20Integration/badge.svg)](https://github.com/madewithlove/htaccess-cli/actions?query=branch%3Amain) 4 | [![Latest Stable Version](https://poser.pugx.org/madewithlove/htaccess-cli/version)](https://packagist.org/packages/madewithlove/htaccess-cli) 5 | [![License](https://poser.pugx.org/madewithlove/htaccess-cli/license)](https://packagist.org/packages/madewithlove/htaccess-cli) 6 | [![codecov](https://codecov.io/gh/madewithlove/htaccess-cli/branch/main/graph/badge.svg)](https://codecov.io/gh/madewithlove/htaccess-cli) 7 | 8 | A CLI tool to test how .htaccess files behave. 9 | 10 | ## Installation 11 | 12 | To start performing analysis on your code, require htaccess CLI in Composer: 13 | 14 | ```bash 15 | composer require --dev madewithlove/htaccess-cli 16 | ``` 17 | 18 | Composer will install htaccess-cli's executable in its bin-dir, which defaults to vendor/bin. 19 | 20 | ### Global installation 21 | 22 | ```bash 23 | composer global require madewithlove/htaccess-cli 24 | ``` 25 | 26 | Then make sure you have the global Composer binaries directory in your ``PATH``. This directory is platform-dependent, see `Composer documentation `_ for details. 27 | This allows you to use the tool as `htaccess` from every location in your system. 28 | 29 | ## Usage 30 | 31 | Run the .htaccess CLI tester from a directory containing a .htaccess file. 32 | 33 | ```bash 34 | # using global installation 35 | htaccess http://localhost/foo 36 | 37 | # using project-specific installation 38 | vendor/bin/htaccess http://localhost/foo 39 | ``` 40 | 41 | Where the url is the request url you want to test your .htaccess file with. 42 | 43 | ![Output of the htaccess tester](https://user-images.githubusercontent.com/1398405/70325684-d8072600-1832-11ea-99f2-3182c0ac3906.png) 44 | 45 | ### Usage through Docker 46 | 47 | ```bash 48 | # install the container 49 | docker pull madewithlove/htaccess-cli 50 | 51 | # run the htaccess tester in the current folder 52 | docker run --rm -v $PWD:/app madewithlove/htaccess-cli [url] 53 | ``` 54 | 55 | ### Usage as a GitHub Action 56 | 57 | Check https://github.com/madewithlove/htaccess-cli-github-action if you want to verify how .htaccess files behave in a GitHub Action. 58 | 59 | ## CLI Options 60 | 61 | The following options are available: 62 | 63 | ``` 64 | -r, --referrer[=REFERRER] The referrer header, used as HTTP_REFERER in apache 65 | --http-user-agent[=HTTP_USER_AGENT] The User Agent header, used as HTTP_USER_AGENT in apache 66 | -s, --server-name[=SERVER-NAME] The configured server name, used as SERVER_NAME in apache 67 | -e, --expected-url[=EXPECTED-URL] When configured, errors when the output url does not equal this url 68 | --share When passed, you'll receive a share url for your test run 69 | -l, --url-list[=URL-LIST] Location of the yaml file containing your url list 70 | -p, --path[=WORKING_DIR] Path to the location of the .htaccess file you wish to test 71 | -h, --help Display a help message 72 | ``` 73 | 74 | ## Usages with multiple url's 75 | 76 | To test one htaccess file with multiple url's, you can use a yaml file that contains them. 77 | 78 | ```yaml 79 | - http://localhost/foo 80 | - http://localhost/bar 81 | ``` 82 | 83 | If you want to pass an expected url for every url you're testing, you can use this yaml structure, where each url maps to an expected url. 84 | 85 | ```yaml 86 | http://localhost/foo: http://localhost/test 87 | http://localhost/bar: http://localhost/test 88 | ``` 89 | 90 | You can then run the command using 91 | 92 | ```bash 93 | htaccess --url-list ./url-list.yaml 94 | ``` 95 | 96 | ## Testing against a working directory 97 | 98 | If you want to test for a `.htaccess` file outside of the current working directory, you can use the `-p ./path_to_directory` option in the command. For example, 99 | ```bash 100 | htaccess -p ./html http://localhost/ 101 | ``` 102 | 103 | ### Note 104 | 105 | The tool simulates only one pass through the server, while Apache will do multiple if you get back 106 | on the same domain. This is a feature we might still add in the future, but it's a limitation for now. 107 | -------------------------------------------------------------------------------- /bin/htaccess: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env php 2 | [ 28 | 'User-Agent' => 'HtaccessCli', 29 | ], 30 | ]), 31 | new ServerRequestFactory() 32 | ); 33 | 34 | $htaccessCommand = new HtaccessCommand($htaccessClient, new TableRenderer()); 35 | $application->add($htaccessCommand); 36 | $application->setDefaultCommand($htaccessCommand->getName(), true); 37 | 38 | $application->run(); 39 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "madewithlove/htaccess-cli", 3 | "description": "CLI interface for the best htaccess tester in the world.", 4 | "type": "package", 5 | "require": { 6 | "php": "^8.0", 7 | "symfony/console": "^3.0 || ^4.0 || ^5.0 || ^6.0 || ^7.0", 8 | "http-interop/http-factory-guzzle": "^1.0", 9 | "php-http/guzzle7-adapter": "^1.0", 10 | "madewithlove/htaccess-api-client": "^2.3", 11 | "symfony/yaml": "^3.0 || ^4.0 || ^5.0 || ^6.0 || ^7.0" 12 | }, 13 | "bin": [ 14 | "bin/htaccess" 15 | ], 16 | "autoload": { 17 | "psr-4": {"Madewithlove\\": "src/"} 18 | }, 19 | "autoload-dev": { 20 | "psr-4": {"Madewithlove\\": "tests/"} 21 | }, 22 | "license": "GPL-3.0-or-later", 23 | "require-dev": { 24 | "phpunit/phpunit": "^9.5", 25 | "phpstan/phpstan": "^1.0.0" 26 | }, 27 | "config": { 28 | "allow-plugins": { 29 | "composer/package-versions-deprecated": true 30 | } 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /phpstan.neon: -------------------------------------------------------------------------------- 1 | parameters: 2 | level: max 3 | paths: 4 | - src 5 | - bin 6 | - tests 7 | -------------------------------------------------------------------------------- /phpunit.xml.dist: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | tests 6 | 7 | 8 | 9 | ./src 10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /src/Htaccess/TableRenderer.php: -------------------------------------------------------------------------------- 1 | table( 14 | [ 15 | 'valid', 16 | 'reached', 17 | 'met', 18 | 'line', 19 | 'message', 20 | ], 21 | array_map( 22 | function (ResultLine $resultLine): array { 23 | return [ 24 | $resultLine->isSupported() 25 | ? $this->prettifyBoolean($resultLine->isValid()) 26 | : '?', 27 | $this->prettifyBoolean($resultLine->wasReached()), 28 | $this->prettifyBoolean($resultLine->isMet()), 29 | $resultLine->getLine(), 30 | $resultLine->getMessage(), 31 | ]; 32 | }, 33 | $result->getLines() 34 | ) 35 | ); 36 | } 37 | 38 | /** 39 | * @param array $results 40 | */ 41 | public function renderMultipleLineResult(array $results, SymfonyStyle $io): void 42 | { 43 | $hasExpectedUrl = !empty(array_filter( 44 | $results, 45 | function (array $result) { 46 | return isset($result['expected url']); 47 | } 48 | )); 49 | 50 | $headers = [ 'url', 'output url', 'status code' ]; 51 | if ($hasExpectedUrl) { 52 | $headers = array_merge($headers, ['expected url', 'matches']); 53 | } 54 | 55 | $io->table( 56 | $headers, 57 | array_map( 58 | function (array $result): array { 59 | if (isset($result['matches'])) { 60 | $result['matches'] = $this->prettifyBoolean($result['matches']); 61 | } 62 | 63 | return $result; 64 | }, 65 | $results 66 | ) 67 | ); 68 | } 69 | 70 | private function prettifyBoolean(bool $boolean): string 71 | { 72 | if ($boolean) { 73 | return '✓'; 74 | } 75 | 76 | return '✗'; 77 | } 78 | } 79 | -------------------------------------------------------------------------------- /src/HtaccessCommand.php: -------------------------------------------------------------------------------- 1 | addArgument('url', InputArgument::OPTIONAL, 'The request url to test your .htaccess file with'); 31 | $this->addOption('referrer', 'r', InputOption::VALUE_REQUIRED, 'The referrer header, used as HTTP_REFERER in apache'); 32 | $this->addOption('server-name', 's', InputOption::VALUE_REQUIRED, 'The configured server name, used as SERVER_NAME in apache'); 33 | $this->addOption('http-user-agent', null, InputOption::VALUE_REQUIRED, 'The User Agent header, used as HTTP_USER_AGENT in apache'); 34 | $this->addOption('expected-url', 'e', InputOption::VALUE_REQUIRED, 'When configured, errors when the output url does not equal this url'); 35 | $this->addOption('share', null, InputOption::VALUE_NONE, 'When passed, you\'ll receive a share url for your test run'); 36 | $this->addOption('url-list', 'l', InputOption::VALUE_REQUIRED, 'Location of the yaml file containing your url list'); 37 | $this->addOption('path', 'p', InputOption::VALUE_REQUIRED, 'Path to the working directory you want to test in.'); 38 | } 39 | 40 | protected function execute(InputInterface $input, OutputInterface $output): int 41 | { 42 | $io = new SymfonyStyle($input, $output); 43 | 44 | $this->validateInput($input); 45 | 46 | /** @var string $url */ 47 | $url = $input->getArgument('url'); 48 | 49 | /** @var string $path */ 50 | $path = $input->getOption('path') ? $input->getOption('path') : getcwd(); 51 | 52 | /** @var string $htaccess */ 53 | $htaccess = file_get_contents($path . '/.htaccess'); 54 | 55 | if ($url) { 56 | return $this->testSingleUrl($url, $htaccess, $input, $io); 57 | } else { 58 | /** @var string $urlListFile */ 59 | $urlListFile = $input->getOption('url-list'); 60 | /** @var string[] $urls */ 61 | $urls = Yaml::parse((string) file_get_contents($path . '/' . $urlListFile)); 62 | 63 | $results = []; 64 | 65 | foreach ($urls as $url => $expectedUrl) { 66 | $hasExpectedUrl = !is_int($url); 67 | if (!$hasExpectedUrl) { 68 | $url = $expectedUrl; 69 | } 70 | 71 | $htaccessResult = $this->test($url, $htaccess, $input); 72 | 73 | $result = [ 74 | 'url' => $url, 75 | 'output_url' => $htaccessResult->getOutputUrl(), 76 | 'status_code' => $htaccessResult->getOutputStatusCode(), 77 | ]; 78 | 79 | if ($hasExpectedUrl) { 80 | $result['expected url'] = $expectedUrl; 81 | $result['matches'] = $expectedUrl === $result['output_url']; 82 | } 83 | 84 | $results[] = $result; 85 | } 86 | 87 | $this->tableRenderer->renderMultipleLineResult($results, $io); 88 | 89 | $resultsFailingExpectations = array_filter( 90 | $results, 91 | function (array $result) { 92 | return isset($result['matches']) && $result['matches'] === false; 93 | } 94 | ); 95 | 96 | if (!empty($resultsFailingExpectations)) { 97 | $io->error('Not all output urls matched the expectations'); 98 | 99 | return 1; 100 | } 101 | } 102 | 103 | return 0; 104 | } 105 | 106 | private function testSingleUrl(string $url, string $htaccess, InputInterface $input, SymfonyStyle $io): int 107 | { 108 | try { 109 | $result = $this->test($url, $htaccess, $input, $io); 110 | } catch (HtaccessException $exception) { 111 | $io->error($exception->getMessage()); 112 | 113 | return 1; 114 | } 115 | 116 | if ($input->getOption('share')) { 117 | try { 118 | $share = $this->htaccessClient->share($url, $htaccess, $this->getServerVariables($input)); 119 | $io->text('You can share this test run on ' . $share->getShareUrl()); 120 | } catch (HtaccessException $exception) { 121 | // when sharing failed, just ignore it 122 | } 123 | } 124 | 125 | /** @var ?string $expectedUrl */ 126 | $expectedUrl = $input->getOption('expected-url'); 127 | 128 | if ($expectedUrl && $result->getOutputUrl() !== $expectedUrl) { 129 | $io->error('The output url is "' . $result->getOutputUrl() . '", while we expected "' . $expectedUrl . '"'); 130 | 131 | return 1; 132 | } 133 | 134 | $io->success('The output url is "' . $result->getOutputUrl() . '"'); 135 | 136 | return 0; 137 | } 138 | 139 | private function validateInput(InputInterface $input): void 140 | { 141 | /** @var ?string $url */ 142 | $url = $input->getArgument('url'); 143 | /** @var ?string $urlList */ 144 | $urlList = $input->getOption('url-list'); 145 | /** @var ?string $path */ 146 | $path = $input->getOption('path') ? $input->getOption('path') : getcwd(); 147 | 148 | 149 | if (is_null($urlList) && is_null($url)) { 150 | throw new SymfonyRuntimeException('Not enough arguments (missing: "url")'); 151 | } 152 | 153 | if ($urlList && $url) { 154 | throw new SymfonyRuntimeException('You cannot use a url list together with a regular url'); 155 | } 156 | 157 | if ($urlList) { 158 | $urlList = $path . '/' . $urlList; 159 | if (!file_exists($urlList)) { 160 | throw new SymfonyRuntimeException('We could not load the specified url list.'); 161 | } 162 | } 163 | 164 | $htaccessFile = $path . '/.htaccess'; 165 | if (!file_exists($htaccessFile)) { 166 | 167 | throw new RuntimeException('We could not find an .htaccess file in the current directory'); 168 | } 169 | } 170 | 171 | private function test(string $url, string $htaccess, InputInterface $input, ?SymfonyStyle $io = null): HtaccessResult 172 | { 173 | $result = $this->htaccessClient->test($url, $htaccess, $this->getServerVariables($input)); 174 | 175 | if ($io) { 176 | $this->tableRenderer->renderHtaccessResult($result, $io); 177 | } 178 | 179 | return $result; 180 | } 181 | 182 | private function getServerVariables(InputInterface $input): ServerVariables 183 | { 184 | $serverVariables = ServerVariables::default(); 185 | if ($referrer = $input->getOption('referrer')) { 186 | /** @var string $referrer */ 187 | $serverVariables = $serverVariables->with('HTTP_REFERER', $referrer); 188 | } 189 | 190 | if ($serverName = $input->getOption('server-name')) { 191 | /** @var string $serverName */ 192 | $serverVariables = $serverVariables->with('SERVER_NAME', $serverName); 193 | } 194 | 195 | if ($httpUserAgent = $input->getOption('http-user-agent')) { 196 | /** @var string $httpUserAgent */ 197 | $serverVariables = $serverVariables->with('HTTP_USER_AGENT', $httpUserAgent); 198 | } 199 | 200 | return $serverVariables; 201 | } 202 | } 203 | -------------------------------------------------------------------------------- /tests/HtaccessCommandTest.php: -------------------------------------------------------------------------------- 1 | [ 21 | 'User-Agent' => 'HtaccessCli', 22 | ], 23 | ]), 24 | new ServerRequestFactory() 25 | ); 26 | 27 | $this->command = new HtaccessCommand($htaccessClient, new TableRenderer()); 28 | } 29 | 30 | public function tearDown(): void 31 | { 32 | parent::tearDown(); 33 | 34 | @unlink(getcwd() . '/.htaccess'); 35 | @unlink(getcwd() . '/tests/.htaccess'); 36 | } 37 | 38 | /** @test */ 39 | public function it does not run without url argument(): void 40 | { 41 | $commandTester = new CommandTester($this->command); 42 | 43 | $this->expectException(RuntimeException::class); 44 | $this->expectExceptionMessage('Not enough arguments (missing: "url")'); 45 | $commandTester->execute([]); 46 | } 47 | 48 | /** @test */ 49 | public function it does not run without htaccess file available(): void 50 | { 51 | $commandTester = new CommandTester($this->command); 52 | 53 | $this->expectException(\RuntimeException::class); 54 | $this->expectExceptionMessage('We could not find an .htaccess file in the current directory'); 55 | $commandTester->execute([ 56 | 'url' => 'http://localhost', 57 | ]); 58 | } 59 | 60 | /** @test */ 61 | public function it does run(): void 62 | { 63 | file_put_contents( 64 | getcwd() . '/.htaccess', 65 | "InvalidRule\nRewriteRule .* /foo" 66 | ); 67 | 68 | $commandTester = new CommandTester($this->command); 69 | $commandTester->execute([ 70 | 'url' => 'http://localhost', 71 | ]); 72 | 73 | // it outputs the lines 74 | $this->assertStringContainsString( 75 | 'InvalidRule', 76 | $commandTester->getDisplay() 77 | ); 78 | $this->assertStringContainsString( 79 | 'This line is not supported by our tool', 80 | $commandTester->getDisplay() 81 | ); 82 | 83 | // it outputs the output url 84 | $this->assertStringContainsString( 85 | 'The output url is "http://localhost/foo"', 86 | $commandTester->getDisplay() 87 | ); 88 | } 89 | 90 | /** @test */ 91 | public function it has exit status zero when expected url is correct(): void 92 | { 93 | file_put_contents( 94 | getcwd() . '/.htaccess', 95 | "RewriteRule .* /foo" 96 | ); 97 | 98 | $commandTester = new CommandTester($this->command); 99 | $commandTester->execute([ 100 | 'url' => 'http://localhost', 101 | '--expected-url' => 'http://localhost/foo', 102 | ]); 103 | 104 | $this->assertEquals(0, $commandTester->getStatusCode()); 105 | } 106 | 107 | /** @test */ 108 | public function it has exit status one when expected url is incorrect(): void 109 | { 110 | file_put_contents( 111 | getcwd() . '/.htaccess', 112 | "RewriteRule .* /foo" 113 | ); 114 | 115 | $commandTester = new CommandTester($this->command); 116 | $commandTester->execute([ 117 | 'url' => 'http://localhost', 118 | '--expected-url' => 'http://localhost/bar', 119 | ]); 120 | 121 | $this->assertEquals(1, $commandTester->getStatusCode()); 122 | } 123 | 124 | /** @test */ 125 | public function it is possible to share a test run(): void 126 | { 127 | file_put_contents( 128 | getcwd() . '/.htaccess', 129 | "RewriteRule .* /foo" 130 | ); 131 | 132 | $commandTester = new CommandTester($this->command); 133 | $commandTester->execute([ 134 | 'url' => 'http://localhost', 135 | '--share' => true, 136 | ]); 137 | 138 | $this->assertStringContainsString( 139 | 'You can share this test run on https://htaccess.madewithlove.com?share=', 140 | $commandTester->getDisplay() 141 | ); 142 | } 143 | 144 | /** @test */ 145 | public function it can specify a custom path to the htaccess file(): void 146 | { 147 | file_put_contents( 148 | getcwd() . '/tests/.htaccess', 149 | "RewriteRule .* /foo [R=302]" 150 | ); 151 | 152 | $commandTester = new CommandTester($this->command); 153 | $commandTester->execute([ 154 | 'url' => 'http://localhost', 155 | '--path' => getcwd() . '/tests', 156 | ]); 157 | 158 | $this->assertStringContainsString( 159 | 'The output url is "http://localhost/foo"', 160 | $commandTester->getDisplay() 161 | ); 162 | } 163 | 164 | /** @test */ 165 | public function it does mark an unsupported line as potentially invalid(): void 166 | { 167 | file_put_contents( 168 | getcwd() . '/tests/.htaccess', 169 | "" 170 | ); 171 | 172 | $commandTester = new CommandTester($this->command); 173 | $commandTester->execute([ 174 | 'url' => 'http://localhost', 175 | '--path' => getcwd() . '/tests', 176 | ]); 177 | 178 | $this->assertStringContainsString( 179 | '?', 180 | $commandTester->getDisplay() 181 | ); 182 | } 183 | 184 | /** @test */ 185 | public function it supports http referrer(): void 186 | { 187 | file_put_contents( 188 | getcwd() . '/.htaccess', 189 | "RewriteCond %{HTTP_REFERER} https://example.com\nRewriteRule .* /foo" 190 | ); 191 | 192 | $commandTester = new CommandTester($this->command); 193 | $commandTester->execute([ 194 | 'url' => 'http://localhost', 195 | '--referrer' => 'https://example.com' 196 | ]); 197 | 198 | $this->assertStringContainsString( 199 | 'The output url is "http://localhost/foo"', 200 | $commandTester->getDisplay() 201 | ); 202 | } 203 | 204 | /** @test */ 205 | public function it supports server name(): void 206 | { 207 | file_put_contents( 208 | getcwd() . '/.htaccess', 209 | "RewriteCond %{SERVER_NAME} example.com\nRewriteRule .* /foo" 210 | ); 211 | 212 | $commandTester = new CommandTester($this->command); 213 | $commandTester->execute([ 214 | 'url' => 'http://localhost', 215 | '--server-name' => 'example.com' 216 | ]); 217 | 218 | $this->assertStringContainsString( 219 | 'The output url is "http://localhost/foo"', 220 | $commandTester->getDisplay() 221 | ); 222 | } 223 | 224 | /** @test */ 225 | public function it supports http user agent(): void 226 | { 227 | file_put_contents( 228 | getcwd() . '/.htaccess', 229 | "RewriteCond %{HTTP_USER_AGENT} iPhone\nRewriteRule .* /foo" 230 | ); 231 | 232 | $commandTester = new CommandTester($this->command); 233 | $commandTester->execute([ 234 | 'url' => 'http://localhost', 235 | '--http-user-agent' => 'iPhone' 236 | ]); 237 | 238 | $this->assertStringContainsString( 239 | 'The output url is "http://localhost/foo"', 240 | $commandTester->getDisplay() 241 | ); 242 | } 243 | } 244 | -------------------------------------------------------------------------------- /tests/MultipleUrlsTest.php: -------------------------------------------------------------------------------- 1 | [ 29 | 'User-Agent' => 'HtaccessCli', 30 | ], 31 | ]), 32 | new ServerRequestFactory() 33 | ); 34 | 35 | $this->command = new HtaccessCommand($htaccessClient, new TableRenderer()); 36 | } 37 | 38 | public function tearDown(): void 39 | { 40 | parent::tearDown(); 41 | 42 | @unlink(getcwd() . '/.htaccess'); 43 | @unlink(getcwd() . '/test-urls.yaml'); 44 | } 45 | 46 | /** @test */ 47 | public function it does work if the passed url list is not available(): void 48 | { 49 | $commandTester = new CommandTester($this->command); 50 | 51 | $this->expectException(RuntimeException::class); 52 | $this->expectExceptionMessage('We could not load the specified url list.'); 53 | $commandTester->execute([ 54 | '--url-list' => 'test-urls.yaml', 55 | ]); 56 | } 57 | 58 | /** @test */ 59 | public function it throws when passing both a url and a url list(): void 60 | { 61 | $commandTester = new CommandTester($this->command); 62 | 63 | $this->expectException(RuntimeException::class); 64 | $this->expectExceptionMessage('You cannot use a url list together with a regular url'); 65 | $commandTester->execute([ 66 | 'url' => 'http://localhost', 67 | '--url-list' => 'test-urls.yaml', 68 | ]); 69 | } 70 | 71 | /** @test */ 72 | public function it does run with multiple urls(): void 73 | { 74 | file_put_contents( 75 | getcwd() . '/.htaccess', 76 | "RewriteRule (.*) /foo/$1" 77 | ); 78 | file_put_contents( 79 | getcwd() . '/test-urls.yaml', 80 | "- http://localhost/test 81 | - http://localhost/bar" 82 | ); 83 | 84 | $commandTester = new CommandTester($this->command); 85 | $commandTester->execute([ 86 | '--url-list' => 'test-urls.yaml', 87 | ]); 88 | 89 | // it outputs the output urls 90 | $this->assertStringContainsString( 91 | 'http://localhost/foo/test', 92 | $commandTester->getDisplay() 93 | ); 94 | $this->assertStringContainsString( 95 | 'http://localhost/foo/bar', 96 | $commandTester->getDisplay() 97 | ); 98 | 99 | $this->assertEquals(0, $commandTester->getStatusCode()); 100 | } 101 | 102 | /** @test */ 103 | public function it renders status code with multiple urls(): void 104 | { 105 | file_put_contents( 106 | getcwd() . '/.htaccess', 107 | "RewriteRule (.*) /foo/$1 [R=302]" 108 | ); 109 | file_put_contents( 110 | getcwd() . '/test-urls.yaml', 111 | "- http://localhost/test 112 | - http://localhost/bar" 113 | ); 114 | 115 | $commandTester = new CommandTester($this->command); 116 | $commandTester->execute([ 117 | '--url-list' => 'test-urls.yaml', 118 | ]); 119 | 120 | // it outputs the output urls 121 | $this->assertStringContainsString( 122 | '302', 123 | $commandTester->getDisplay() 124 | ); 125 | 126 | $this->assertEquals(0, $commandTester->getStatusCode()); 127 | } 128 | 129 | /** @test */ 130 | public function it has exit status one when at least one expected url is incorrect(): void 131 | { 132 | file_put_contents( 133 | getcwd() . '/.htaccess', 134 | "RewriteRule (.*) /foo/$1" 135 | ); 136 | file_put_contents( 137 | getcwd() . '/test-urls.yaml', 138 | "http://localhost/test: http://localhost/foo/test 139 | http://localhost/bar: http://localhost/foo/test" 140 | ); 141 | 142 | $commandTester = new CommandTester($this->command); 143 | $commandTester->execute([ 144 | '--url-list' => 'test-urls.yaml', 145 | ]); 146 | 147 | $this->assertStringContainsString('✗', $commandTester->getDisplay()); 148 | $this->assertEquals(1, $commandTester->getStatusCode()); 149 | } 150 | } 151 | --------------------------------------------------------------------------------