├── .gitignore ├── ChangeLog ├── LICENSE ├── README.rst ├── VERSION ├── bin └── php-sqllint ├── build.xml ├── composer.json ├── composer.lock ├── src ├── phpsqllint │ ├── Autoloader.php │ ├── Cli.php │ ├── Renderer.php │ └── Renderer │ │ ├── Emacs.php │ │ └── Text.php └── stub-phar.php └── tests └── files ├── create-missingcomma.sql ├── create-nocoldef.sql ├── create-noname.sql ├── create-ok.sql ├── multiple.sql ├── select-unformatted.sql └── unicode-error.sql /.gitignore: -------------------------------------------------------------------------------- 1 | /vendor 2 | /README.html 3 | /dist 4 | /bin/phar-php-sqllint.php 5 | -------------------------------------------------------------------------------- /ChangeLog: -------------------------------------------------------------------------------- 1 | 2020-04-14 Christian Weiske 2 | 3 | * Fix reported error position in SQL with unicode characters (#14) 4 | * Release 0.2.3 5 | 6 | 2018-03-02 Christian Weiske 7 | 8 | * Fix autoloading on composer installation 9 | * Release 0.2.2 10 | 11 | 2017-07-27 Christian Weiske 12 | 13 | * Re-order autoloader calls, fixes #11 14 | * Release 0.2.1 15 | 16 | 2017-07-27 Christian Weiske 17 | 18 | * Update to phpmyadmin/sql-parser 4.1.9 19 | * Release 0.2.0 20 | 21 | 2016-10-09 Christian Weiske 22 | 23 | * Use latest phpmyadmin/sql-parser lib 24 | * Release 0.1.3 25 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 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 Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | *********** 2 | PHP-SQLlint 3 | *********** 4 | 5 | Command line tool to validate (syntax check) SQL files. 6 | Primarily for MySQL ``.sql`` files. 7 | 8 | Can be used in git pre-commit hooks to catch errors. 9 | Use it from your shell, offline and without any SQL server. 10 | 11 | You can also use it to format SQL queries. 12 | 13 | 14 | ===== 15 | Usage 16 | ===== 17 | Syntax check:: 18 | 19 | $ php-sqllint tests/files/create-missingcomma.sql 20 | Checking SQL syntax of tests/files/create-missingcomma.sql 21 | Line 3, col 5 at "pid": A comma or a closing bracket was expected. 22 | Line 3, col 13 at "11": Unexpected beginning of statement. 23 | Line 3, col 17 at "DEFAULT": Unrecognized statement type. 24 | 25 | Emacs mode:: 26 | 27 | $ php-sqllint -r emacs tests/files/create-noname.sql 28 | tests/files/create-noname.sql:1.12:Error: The name of the entity was expected. 29 | tests/files/create-noname.sql:1.13:Error: A closing bracket was expected. 30 | tests/files/create-noname.sql:1.13:Error: At least one column definition was expected. 31 | 32 | 33 | Formatting:: 34 | 35 | $ php-sqllint --format tests/files/select-unformatted.sql 36 | SELECT 37 | id, 38 | NAME, 39 | url 40 | FROM 41 | users 42 | WHERE 43 | DATE > NOW() AND id != 0 44 | ORDER BY NAME 45 | LIMIT 10 46 | 47 | 48 | Syntax highlighting 49 | =================== 50 | ANSI colors are applied automatically when not piping; you can use the 51 | ``--highlight`` option to override the automatism. 52 | 53 | ``--highlight`` option values: 54 | 55 | ``none`` 56 | No highlighting. Use it to disable automatic highlighting 57 | ``ansi`` 58 | ANSI escape codes for your shell 59 | ``html`` 60 | HTML tags 61 | 62 | 63 | ==== 64 | Bugs 65 | ==== 66 | Does ``php-sqllint`` not detect a syntax error, or doesn't support a certain 67 | SQL statement? 68 | Then please report a bug at `phpmyadmin/sql-parser`__. 69 | 70 | __ https://github.com/phpmyadmin/sql-parser 71 | 72 | 73 | ====================== 74 | Install using composer 75 | ====================== 76 | Run ``composer require cweiske/php-sqllint``, the package is hosted on `packagist `__ 77 | 78 | 79 | ======== 80 | Download 81 | ======== 82 | The download files are equipped with all dependencies. 83 | Just download and run. 84 | 85 | .. LATESTRELEASE 86 | 87 | See `php-sqllint downloads page `_ 88 | for all released versions. 89 | 90 | 91 | ============ 92 | Dependencies 93 | ============ 94 | - PEAR's `Console_Commandline`__ 95 | - `phpMyAdmin's SqlParser`__ 96 | 97 | __ http://pear.php.net/package/Console_CommandLine 98 | __ https://github.com/phpmyadmin/sql-parser 99 | 100 | 101 | Dependency installation 102 | ======================= 103 | :: 104 | 105 | $ composer install 106 | 107 | Now you can use ``./bin/php-sqllint`` without building the phar yourself. 108 | 109 | 110 | ======== 111 | Building 112 | ======== 113 | 114 | Preparation 115 | =========== 116 | 1. Write new version number into ``VERSION`` 117 | 118 | 119 | Create the release 120 | ================== 121 | You'll need `phing`__, the PHP build tool:: 122 | 123 | $ phing 124 | 125 | __ https://www.phing.info/ 126 | 127 | The result are ``.phar`` files in ``dist/`` directory that you can execute:: 128 | 129 | $ ./dist/php-sqllint-0.0.1.phar tests/files/create-noname.sql 130 | Checking SQL syntax of tests/files/create-noname.sql 131 | Line 1, col 12 at "(": The name of the entity was expected. 132 | 133 | 134 | ================= 135 | About PHP-SQLlint 136 | ================= 137 | 138 | License 139 | ======= 140 | ``php-sqllint`` is licensed under the `AGPL v3`__ or later. 141 | 142 | __ http://www.gnu.org/licenses/agpl.html 143 | 144 | 145 | Homepage 146 | ======== 147 | Home page 148 | http://cweiske.de/php-sqllint.htm 149 | Source code 150 | http://git.cweiske.de/php-sqllint.git 151 | 152 | Mirror: https://github.com/cweiske/php-sqllint 153 | 154 | 155 | Author 156 | ====== 157 | Written by `Christian Weiske`__, cweiske+php-sqllint@cweiske.de 158 | 159 | __ http://cweiske.de/ 160 | -------------------------------------------------------------------------------- /VERSION: -------------------------------------------------------------------------------- 1 | 0.2.3 2 | -------------------------------------------------------------------------------- /bin/php-sqllint: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env php 2 | 11 | * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 12 | * @link http://cweiske.de/php-sqllint.htm 13 | */ 14 | namespace phpsqllint; 15 | 16 | if (file_exists(__DIR__ . '/../vendor/autoload.php')) { 17 | //local git checkout 18 | include_once __DIR__ . '/../vendor/autoload.php'; 19 | } else if (file_exists('vendor/autoload.php')) { 20 | //dependency composer installation 21 | include_once 'vendor/autoload.php'; 22 | } 23 | 24 | if (file_exists(__DIR__ . '/../src/phpsqllint/Autoloader.php')) { 25 | include_once __DIR__ . '/../src/phpsqllint/Autoloader.php'; 26 | Autoloader::register(); 27 | } 28 | 29 | $cli = new Cli(); 30 | $cli->run(); 31 | ?> -------------------------------------------------------------------------------- /build.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 55 | 56 | 57 | 58 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 103 | 104 | 105 | 106 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "cweiske/php-sqllint", 3 | "description": "Command line tool to validate (syntax check) SQL files", 4 | "type": "project", 5 | "bin": ["bin/php-sqllint"], 6 | "require": { 7 | "phpmyadmin/sql-parser": "^4.1.1", 8 | "pear/console_commandline": "^1.2", 9 | "ext-mbstring": "*" 10 | }, 11 | "homepage": "http://cweiske.de/php-sqllint.htm", 12 | "license": "AGPL-3.0-or-later", 13 | "authors": [ 14 | { 15 | "name": "Christian Weiske", 16 | "email": "cweiske@cweiske.de", 17 | "homepage": "http://cweiske.de/" 18 | } 19 | ], 20 | "support": { 21 | "issues": "https://github.com/cweiske/php-sqllint/issues" 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /composer.lock: -------------------------------------------------------------------------------- 1 | { 2 | "_readme": [ 3 | "This file locks the dependencies of your project to a known state", 4 | "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", 5 | "This file is @generated automatically" 6 | ], 7 | "content-hash": "b75c33e07bfbe6757463c7919f4adff6", 8 | "packages": [ 9 | { 10 | "name": "pear/console_commandline", 11 | "version": "v1.2.2", 12 | "source": { 13 | "type": "git", 14 | "url": "https://github.com/pear/Console_CommandLine.git", 15 | "reference": "7a8afa50bdc8dbfdc0cf394f1101106e8b8f8e67" 16 | }, 17 | "dist": { 18 | "type": "zip", 19 | "url": "https://api.github.com/repos/pear/Console_CommandLine/zipball/7a8afa50bdc8dbfdc0cf394f1101106e8b8f8e67", 20 | "reference": "7a8afa50bdc8dbfdc0cf394f1101106e8b8f8e67", 21 | "shasum": "" 22 | }, 23 | "require": { 24 | "ext-dom": "*", 25 | "ext-xml": "*", 26 | "pear/pear_exception": "^1.0.0", 27 | "php": ">=5.3.0" 28 | }, 29 | "require-dev": { 30 | "phpunit/phpunit": "*" 31 | }, 32 | "type": "library", 33 | "autoload": { 34 | "psr-0": { 35 | "Console": "./" 36 | } 37 | }, 38 | "notification-url": "https://packagist.org/downloads/", 39 | "include-path": [ 40 | "" 41 | ], 42 | "license": [ 43 | "MIT" 44 | ], 45 | "authors": [ 46 | { 47 | "name": "Richard Quadling", 48 | "email": "rquadling@gmail.com" 49 | }, 50 | { 51 | "name": "David Jean Louis", 52 | "email": "izimobil@gmail.com" 53 | } 54 | ], 55 | "description": "A full featured command line options and arguments parser.", 56 | "homepage": "https://github.com/pear/Console_CommandLine", 57 | "keywords": [ 58 | "console" 59 | ], 60 | "time": "2016-07-14T06:00:57+00:00" 61 | }, 62 | { 63 | "name": "pear/pear_exception", 64 | "version": "v1.0.1", 65 | "source": { 66 | "type": "git", 67 | "url": "https://github.com/pear/PEAR_Exception.git", 68 | "reference": "dbb42a5a0e45f3adcf99babfb2a1ba77b8ac36a7" 69 | }, 70 | "dist": { 71 | "type": "zip", 72 | "url": "https://api.github.com/repos/pear/PEAR_Exception/zipball/dbb42a5a0e45f3adcf99babfb2a1ba77b8ac36a7", 73 | "reference": "dbb42a5a0e45f3adcf99babfb2a1ba77b8ac36a7", 74 | "shasum": "" 75 | }, 76 | "require": { 77 | "php": ">=4.4.0" 78 | }, 79 | "require-dev": { 80 | "phpunit/phpunit": "*" 81 | }, 82 | "type": "class", 83 | "extra": { 84 | "branch-alias": { 85 | "dev-master": "1.0.x-dev" 86 | } 87 | }, 88 | "autoload": { 89 | "classmap": [ 90 | "PEAR/" 91 | ] 92 | }, 93 | "notification-url": "https://packagist.org/downloads/", 94 | "include-path": [ 95 | "." 96 | ], 97 | "license": [ 98 | "BSD-2-Clause" 99 | ], 100 | "authors": [ 101 | { 102 | "name": "Helgi Thormar", 103 | "email": "dufuz@php.net" 104 | }, 105 | { 106 | "name": "Greg Beaver", 107 | "email": "cellog@php.net" 108 | } 109 | ], 110 | "description": "The PEAR Exception base class.", 111 | "homepage": "https://github.com/pear/PEAR_Exception", 112 | "keywords": [ 113 | "exception" 114 | ], 115 | "time": "2019-12-10T10:24:42+00:00" 116 | }, 117 | { 118 | "name": "phpmyadmin/sql-parser", 119 | "version": "4.6.1", 120 | "source": { 121 | "type": "git", 122 | "url": "https://github.com/phpmyadmin/sql-parser.git", 123 | "reference": "fd339b2b40b7910659c842891eb36d1d15079fcb" 124 | }, 125 | "dist": { 126 | "type": "zip", 127 | "url": "https://api.github.com/repos/phpmyadmin/sql-parser/zipball/fd339b2b40b7910659c842891eb36d1d15079fcb", 128 | "reference": "fd339b2b40b7910659c842891eb36d1d15079fcb", 129 | "shasum": "" 130 | }, 131 | "require": { 132 | "php": ">=5.3.0", 133 | "symfony/polyfill-mbstring": "^1.3" 134 | }, 135 | "conflict": { 136 | "phpmyadmin/motranslator": "<3.0" 137 | }, 138 | "require-dev": { 139 | "phpunit/php-code-coverage": "*", 140 | "phpunit/phpunit": "~4.8 || ~5.7 || ~6.5 || ^7.0", 141 | "sami/sami": "^4.0", 142 | "squizlabs/php_codesniffer": "~2.9 || ~3.4" 143 | }, 144 | "suggest": { 145 | "ext-mbstring": "For best performance", 146 | "phpmyadmin/motranslator": "Translate messages to your favorite locale" 147 | }, 148 | "bin": [ 149 | "bin/highlight-query", 150 | "bin/lint-query", 151 | "bin/tokenize-query" 152 | ], 153 | "type": "library", 154 | "autoload": { 155 | "psr-4": { 156 | "PhpMyAdmin\\SqlParser\\": "src" 157 | } 158 | }, 159 | "notification-url": "https://packagist.org/downloads/", 160 | "license": [ 161 | "GPL-2.0-or-later" 162 | ], 163 | "authors": [ 164 | { 165 | "name": "The phpMyAdmin Team", 166 | "email": "developers@phpmyadmin.net", 167 | "homepage": "https://www.phpmyadmin.net/team/" 168 | } 169 | ], 170 | "description": "A validating SQL lexer and parser with a focus on MySQL dialect.", 171 | "homepage": "https://github.com/phpmyadmin/sql-parser", 172 | "keywords": [ 173 | "analysis", 174 | "lexer", 175 | "parser", 176 | "sql" 177 | ], 178 | "time": "2020-03-21T00:16:38+00:00" 179 | }, 180 | { 181 | "name": "symfony/polyfill-mbstring", 182 | "version": "v1.15.0", 183 | "source": { 184 | "type": "git", 185 | "url": "https://github.com/symfony/polyfill-mbstring.git", 186 | "reference": "81ffd3a9c6d707be22e3012b827de1c9775fc5ac" 187 | }, 188 | "dist": { 189 | "type": "zip", 190 | "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/81ffd3a9c6d707be22e3012b827de1c9775fc5ac", 191 | "reference": "81ffd3a9c6d707be22e3012b827de1c9775fc5ac", 192 | "shasum": "" 193 | }, 194 | "require": { 195 | "php": ">=5.3.3" 196 | }, 197 | "suggest": { 198 | "ext-mbstring": "For best performance" 199 | }, 200 | "type": "library", 201 | "extra": { 202 | "branch-alias": { 203 | "dev-master": "1.15-dev" 204 | } 205 | }, 206 | "autoload": { 207 | "psr-4": { 208 | "Symfony\\Polyfill\\Mbstring\\": "" 209 | }, 210 | "files": [ 211 | "bootstrap.php" 212 | ] 213 | }, 214 | "notification-url": "https://packagist.org/downloads/", 215 | "license": [ 216 | "MIT" 217 | ], 218 | "authors": [ 219 | { 220 | "name": "Nicolas Grekas", 221 | "email": "p@tchwork.com" 222 | }, 223 | { 224 | "name": "Symfony Community", 225 | "homepage": "https://symfony.com/contributors" 226 | } 227 | ], 228 | "description": "Symfony polyfill for the Mbstring extension", 229 | "homepage": "https://symfony.com", 230 | "keywords": [ 231 | "compatibility", 232 | "mbstring", 233 | "polyfill", 234 | "portable", 235 | "shim" 236 | ], 237 | "funding": [ 238 | { 239 | "url": "https://symfony.com/sponsor", 240 | "type": "custom" 241 | }, 242 | { 243 | "url": "https://github.com/fabpot", 244 | "type": "github" 245 | }, 246 | { 247 | "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", 248 | "type": "tidelift" 249 | } 250 | ], 251 | "time": "2020-03-09T19:04:49+00:00" 252 | } 253 | ], 254 | "packages-dev": [], 255 | "aliases": [], 256 | "minimum-stability": "stable", 257 | "stability-flags": [], 258 | "prefer-stable": false, 259 | "prefer-lowest": false, 260 | "platform": { 261 | "ext-mbstring": "*" 262 | }, 263 | "platform-dev": [], 264 | "plugin-api-version": "1.1.0" 265 | } 266 | -------------------------------------------------------------------------------- /src/phpsqllint/Autoloader.php: -------------------------------------------------------------------------------- 1 | 10 | * @copyright 2014 Christian Weiske 11 | * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 12 | * @link http://cweiske.de/php-sqllint.htm 13 | */ 14 | namespace phpsqllint; 15 | 16 | /** 17 | * Class autoloader, PSR-0 compliant. 18 | * 19 | * @category Tools 20 | * @package PHP-SQLlint 21 | * @author Christian Weiske 22 | * @copyright 2014 Christian Weiske 23 | * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 24 | * @version Release: @package_version@ 25 | * @link http://cweiske.de/php-sqllint.htm 26 | */ 27 | class Autoloader 28 | { 29 | /** 30 | * Load the given class 31 | * 32 | * @param string $class Class name 33 | * 34 | * @return void 35 | */ 36 | public function load($class) 37 | { 38 | $file = strtr($class, '_\\', '//') . '.php'; 39 | if (stream_resolve_include_path($file)) { 40 | include $file; 41 | } 42 | } 43 | 44 | /** 45 | * Register this autoloader 46 | * 47 | * @return void 48 | */ 49 | public static function register() 50 | { 51 | set_include_path( 52 | get_include_path() . PATH_SEPARATOR . __DIR__ . '/../' 53 | ); 54 | spl_autoload_register(array(new self(), 'load')); 55 | } 56 | } 57 | ?> -------------------------------------------------------------------------------- /src/phpsqllint/Cli.php: -------------------------------------------------------------------------------- 1 | 10 | * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 11 | * @link http://cweiske.de/php-sqllint.htm 12 | */ 13 | namespace phpsqllint; 14 | use PhpMyAdmin\SqlParser\Parser; 15 | 16 | /** 17 | * Command line interface 18 | * 19 | * @category Tools 20 | * @package PHP-SQLlint 21 | * @author Christian Weiske 22 | * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 23 | * @link http://www.emacswiki.org/emacs/CreatingYourOwnCompileErrorRegexp 24 | */ 25 | class Cli 26 | { 27 | protected $renderer; 28 | 29 | protected $format = false; 30 | 31 | /** 32 | * What syntax highlighting mode should be used 33 | * 34 | * none, ansi, html 35 | */ 36 | protected $highlight = 'none'; 37 | 38 | 39 | /** 40 | * Start processing. 41 | * 42 | * @return void 43 | */ 44 | public function run() 45 | { 46 | try { 47 | $parser = $this->loadOptionParser(); 48 | $files = $this->parseParameters($parser); 49 | 50 | $allfine = true; 51 | foreach ($files as $filename) { 52 | if ($this->format) { 53 | $allfine &= $this->formatFile($filename); 54 | } else { 55 | $allfine &= $this->checkFile($filename); 56 | } 57 | } 58 | 59 | if ($allfine == true) { 60 | exit(0); 61 | } else { 62 | exit(10); 63 | } 64 | } catch (\Exception $e) { 65 | echo 'Error: ' . $e->getMessage() . "\n"; 66 | exit(1); 67 | } 68 | } 69 | 70 | /** 71 | * Check a .sql file for syntax errors 72 | * 73 | * @param string $filename File path 74 | * 75 | * @return boolean True if there were no errors, false if there were some 76 | */ 77 | public function checkFile($filename) 78 | { 79 | $this->renderer->startRendering($filename); 80 | $sql = $this->loadSql($filename); 81 | if ($sql === false) { 82 | return false; 83 | } 84 | 85 | $parser = new \PhpMyAdmin\SqlParser\Parser($sql); 86 | if (count($parser->errors) == 0) { 87 | $this->renderer->finishOk(); 88 | return true; 89 | } 90 | 91 | $lines = array(1 => 0); 92 | $pos = -1; 93 | $line = 1; 94 | while (false !== $pos = mb_strpos($sql, "\n", ++$pos)) { 95 | $lines[++$line] = $pos; 96 | } 97 | 98 | foreach ($parser->errors as $error) { 99 | /* @var PhpMyAdmin\SqlParser\Exceptions\ParserException $error) */ 100 | reset($lines); 101 | $line = 1; 102 | while (next($lines) && $error->token->position >= current($lines)) { 103 | ++$line; 104 | } 105 | $col = $error->token->position - $lines[$line]; 106 | 107 | $this->renderer->displayError( 108 | $error->getMessage(), 109 | //FIXME: ->token or ->value? 110 | $error->token->token, 111 | $line, 112 | $col 113 | ); 114 | } 115 | 116 | return false; 117 | } 118 | 119 | /** 120 | * Reformat the given file 121 | */ 122 | protected function formatFile($filename) 123 | { 124 | $this->renderer->startRendering($filename); 125 | $sql = $this->loadSql($filename); 126 | if ($sql === false) { 127 | return false; 128 | } 129 | 130 | $typeMap = array( 131 | 'none' => 'text', 132 | 'ansi' => 'cli', 133 | 'html' => 'html', 134 | ); 135 | $options = array( 136 | 'type' => $typeMap[$this->highlight], 137 | ); 138 | echo \PhpMyAdmin\SqlParser\Utils\Formatter::format($sql, $options) . "\n"; 139 | } 140 | 141 | protected function loadSql($filename) 142 | { 143 | if ($filename == '-') { 144 | $sql = file_get_contents('php://stdin'); 145 | } else { 146 | $sql = file_get_contents($filename); 147 | } 148 | if (trim($sql) == '') { 149 | $this->renderer->displayError('SQL file empty', '', 0, 0); 150 | return false; 151 | } 152 | return $sql; 153 | } 154 | 155 | /** 156 | * Load parameters for the CLI option parser. 157 | * 158 | * @return \Console_CommandLine CLI option parser 159 | */ 160 | protected function loadOptionParser() 161 | { 162 | $parser = new \Console_CommandLine(); 163 | $parser->description = 'php-sqllint'; 164 | $parser->version = 'dev'; 165 | $parser->avoid_reading_stdin = true; 166 | 167 | $versionFile = __DIR__ . '/../../VERSION'; 168 | if (file_exists($versionFile)) { 169 | $parser->version = trim(file_get_contents($versionFile)); 170 | } 171 | 172 | $parser->addOption( 173 | 'format', 174 | array( 175 | 'short_name' => '-f', 176 | 'long_name' => '--format', 177 | 'description' => 'Reformat SQL instead of checking', 178 | 'action' => 'StoreTrue', 179 | 'default' => false, 180 | ) 181 | ); 182 | $parser->addOption( 183 | 'highlight', 184 | array( 185 | 'short_name' => '-h', 186 | 'long_name' => '--highlight', 187 | 'description' => 'Highlighting mode (when using --format)', 188 | 'action' => 'StoreString', 189 | 'choices' => array( 190 | 'none', 191 | 'ansi', 192 | 'html', 193 | 'auto', 194 | ), 195 | 'default' => 'auto', 196 | 'add_list_option' => true, 197 | ) 198 | ); 199 | $parser->addOption( 200 | 'renderer', 201 | array( 202 | 'short_name' => '-r', 203 | 'long_name' => '--renderer', 204 | 'description' => 'Output mode', 205 | 'action' => 'StoreString', 206 | 'choices' => array( 207 | 'emacs', 208 | 'text', 209 | ), 210 | 'default' => 'text', 211 | 'add_list_option' => true, 212 | ) 213 | ); 214 | 215 | $parser->addArgument( 216 | 'sql_files', 217 | array( 218 | 'description' => 'SQL files, "-" for stdin', 219 | 'multiple' => true 220 | ) 221 | ); 222 | 223 | return $parser; 224 | } 225 | 226 | /** 227 | * Let the CLI option parser parse the options. 228 | * 229 | * @param object $parser Option parser 230 | * 231 | * @return array Array of file names 232 | */ 233 | protected function parseParameters(\Console_CommandLine $parser) 234 | { 235 | try { 236 | $result = $parser->parse(); 237 | 238 | $rendClass = '\\phpsqllint\\Renderer_' 239 | . ucfirst($result->options['renderer']); 240 | $this->renderer = new $rendClass(); 241 | 242 | $this->format = $result->options['format']; 243 | 244 | $this->highlight = $result->options['highlight']; 245 | if ($this->highlight == 'auto') { 246 | if (php_sapi_name() == 'cli') { 247 | //default coloring to enabled, except 248 | // when piping | to another tool 249 | $this->highlight = 'ansi'; 250 | if (function_exists('posix_isatty') 251 | && !posix_isatty(STDOUT) 252 | ) { 253 | $this->highlight = 'none'; 254 | } 255 | } else { 256 | //no idea where we are, so do not highlight 257 | $this->highlight = 'none'; 258 | } 259 | } 260 | 261 | foreach ($result->args['sql_files'] as $filename) { 262 | if ($filename == '-') { 263 | continue; 264 | } 265 | if (!file_exists($filename)) { 266 | throw new \Exception('File does not exist: ' . $filename); 267 | } 268 | if (!is_file($filename)) { 269 | throw new \Exception('Not a file: ' . $filename); 270 | } 271 | } 272 | 273 | return $result->args['sql_files']; 274 | } catch (\Exception $exc) { 275 | $parser->displayError($exc->getMessage()); 276 | } 277 | } 278 | 279 | } 280 | ?> 281 | -------------------------------------------------------------------------------- /src/phpsqllint/Renderer.php: -------------------------------------------------------------------------------- 1 | 10 | * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 11 | * @link http://cweiske.de/php-sqllint.htm 12 | */ 13 | namespace phpsqllint; 14 | 15 | /** 16 | * What every renderer has to implement 17 | * 18 | * @category Tools 19 | * @package PHP-SQLlint 20 | * @author Christian Weiske 21 | * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 22 | * @link http://www.emacswiki.org/emacs/CreatingYourOwnCompileErrorRegexp 23 | */ 24 | interface Renderer 25 | { 26 | /** 27 | * Begin syntax check output rendering 28 | * 29 | * @param string $filename Path to the SQL file 30 | * 31 | * @return void 32 | */ 33 | public function startRendering($filename); 34 | 35 | /** 36 | * Output errors in GNU style; see emacs compilation.txt 37 | * 38 | * @param string $msg Error message 39 | * @param string $token Character which caused the error 40 | * @param integer $line Line at which the error occured 41 | * @param integer $col Column at which the error occured 42 | * 43 | * @return void 44 | */ 45 | public function displayError($msg, $token, $line, $col); 46 | 47 | /** 48 | * Finish syntax check output rendering; no syntax errors found 49 | * 50 | * @return void 51 | */ 52 | public function finishOk(); 53 | } 54 | ?> 55 | -------------------------------------------------------------------------------- /src/phpsqllint/Renderer/Emacs.php: -------------------------------------------------------------------------------- 1 | 10 | * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 11 | * @link http://cweiske.de/php-sqllint.htm 12 | */ 13 | namespace phpsqllint; 14 | 15 | /** 16 | * Output for emacs' compilation mode 17 | * 18 | * @category Tools 19 | * @package PHP-SQLlint 20 | * @author Christian Weiske 21 | * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 22 | * @link http://www.emacswiki.org/emacs/CreatingYourOwnCompileErrorRegexp 23 | */ 24 | class Renderer_Emacs implements Renderer 25 | { 26 | protected $filename; 27 | 28 | /** 29 | * Begin syntax check output rendering 30 | * 31 | * @param string $filename Path to the SQL file 32 | * 33 | * @return void 34 | */ 35 | public function startRendering($filename) 36 | { 37 | $this->filename = $filename; 38 | } 39 | 40 | /** 41 | * Output errors in GNU style; see emacs compilation.txt 42 | * 43 | * @param string $msg Error message 44 | * @param string $token Character which caused the error 45 | * @param integer $line Line at which the error occured 46 | * @param integer $col Column at which the error occured 47 | * 48 | * @return void 49 | */ 50 | public function displayError($msg, $token, $line, $col) 51 | { 52 | echo $this->filename 53 | . ':' . $line 54 | . '.' . $col 55 | . ':Error:' 56 | . ' '. $msg 57 | . "\n"; 58 | } 59 | 60 | /** 61 | * Finish syntax check output rendering; no syntax errors found 62 | * 63 | * @return void 64 | */ 65 | public function finishOk() 66 | { 67 | //do nothing 68 | } 69 | } 70 | ?> 71 | -------------------------------------------------------------------------------- /src/phpsqllint/Renderer/Text.php: -------------------------------------------------------------------------------- 1 | 10 | * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 11 | * @link http://cweiske.de/php-sqllint.htm 12 | */ 13 | namespace phpsqllint; 14 | 15 | /** 16 | * Textual output, easily readable by humans. 17 | * 18 | * @category Tools 19 | * @package PHP-SQLlint 20 | * @author Christian Weiske 21 | * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 22 | * @link http://www.emacswiki.org/emacs/CreatingYourOwnCompileErrorRegexp 23 | */ 24 | class Renderer_Text implements Renderer 25 | { 26 | protected $fileshown = false; 27 | protected $filename = null; 28 | 29 | /** 30 | * Begin syntax check output rendering 31 | * 32 | * @param string $filename Path to the SQL file 33 | * 34 | * @return void 35 | */ 36 | public function startRendering($filename) 37 | { 38 | $this->filename = $filename; 39 | $this->fileshown = false; 40 | } 41 | 42 | 43 | protected function showFile() 44 | { 45 | if ($this->fileshown) { 46 | return; 47 | } 48 | 49 | echo "Checking SQL syntax of " . $this->filename . "\n"; 50 | $this->fileshown = true; 51 | } 52 | 53 | /** 54 | * Show the error to the user. 55 | * 56 | * @param string $msg Error message 57 | * @param string $token Character which caused the error 58 | * @param integer $line Line at which the error occured 59 | * @param integer $col Column at which the error occured 60 | * 61 | * @return void 62 | */ 63 | public function displayError($msg, $token, $line, $col) 64 | { 65 | $this->showFile(); 66 | echo ' Line ' . $line 67 | . ', col ' . $col 68 | . ' at "' . $this->niceToken($token) . '":' 69 | . ' ' . $msg 70 | . "\n"; 71 | } 72 | 73 | /** 74 | * Finish syntax check output rendering; no syntax errors found 75 | * 76 | * @return void 77 | */ 78 | public function finishOk() 79 | { 80 | if ($this->fileshown) { 81 | echo " OK\n"; 82 | } 83 | } 84 | 85 | /** 86 | * Convert the token string to a readable one, especially special 87 | * characters like newline and tabs 88 | * 89 | * @param string $str String with possibly special characters 90 | * 91 | * @return string Escaped string 92 | */ 93 | protected function niceToken($str) 94 | { 95 | return str_replace( 96 | ["\n", "\r", "\t"], 97 | ['\n', '\r', '\t'], 98 | $str 99 | ); 100 | } 101 | } 102 | ?> 103 | -------------------------------------------------------------------------------- /src/stub-phar.php: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env php 2 | 11 | * @copyright 2015 Christian Weiske 12 | * @license http://www.gnu.org/licenses/agpl.html GNU AGPL v3 13 | * @link http://cweiske.de/php-sqllint.htm 14 | */ 15 | Phar::mapPhar('php-sqllint.phar'); 16 | require 'phar://php-sqllint.phar/bin/phar-php-sqllint.php'; 17 | __HALT_COMPILER(); 18 | ?> 19 | -------------------------------------------------------------------------------- /tests/files/create-missingcomma.sql: -------------------------------------------------------------------------------- 1 | CREATE TABLE test ( 2 | uid INT(11) DEFAULT 0 NOT NULL 3 | pid INT(11) DEFAULT 0 NOT NULL 4 | ); 5 | -------------------------------------------------------------------------------- /tests/files/create-nocoldef.sql: -------------------------------------------------------------------------------- 1 | CREATE TABLE foo ( 2 | ); 3 | -------------------------------------------------------------------------------- /tests/files/create-noname.sql: -------------------------------------------------------------------------------- 1 | CREATE TABLE(); 2 | -------------------------------------------------------------------------------- /tests/files/create-ok.sql: -------------------------------------------------------------------------------- 1 | CREATE TABLE test ( 2 | uid INT(11) DEFAULT 0 NOT NULL, 3 | pid INT(11) DEFAULT 0 NOT NULL 4 | ); 5 | -------------------------------------------------------------------------------- /tests/files/multiple.sql: -------------------------------------------------------------------------------- 1 | SELECT * FROM foo WHERE; 2 | SELECT foo FROM bar baz bat; 3 | -------------------------------------------------------------------------------- /tests/files/select-unformatted.sql: -------------------------------------------------------------------------------- 1 | SELECT id, name, url FROM users WHERE date > NOW() and id != 0 ORDER BY name LIMIT 10 2 | -------------------------------------------------------------------------------- /tests/files/unicode-error.sql: -------------------------------------------------------------------------------- 1 | SELECT 'äö' 2 | SELECT 1 3 | --------------------------------------------------------------------------------