├── .github └── workflows │ └── rust.yml ├── .gitignore ├── CHANGELOG.md ├── Cargo.toml ├── LICENSE ├── README.md ├── fuzz ├── .gitignore ├── Cargo.lock ├── Cargo.toml └── fuzz_targets │ ├── escape.rs │ ├── round_trip.rs │ └── unescape.rs └── src ├── lib.rs └── testdata └── os-releases ├── fedora-19 ├── fedora-29 ├── fictional └── gentoo /.github/workflows/rust.yml: -------------------------------------------------------------------------------- 1 | name: Rust 2 | on: 3 | push: 4 | branches: [ master ] 5 | pull_request: 6 | branches: [ master ] 7 | 8 | env: 9 | CARGO_TERM_COLOR: always 10 | RUST_BACKTRACE: "1" 11 | jobs: 12 | build: 13 | runs-on: ubuntu-latest 14 | steps: 15 | - uses: actions/checkout@v2 16 | - name: Build 17 | run: cargo build --verbose --examples 18 | - name: Run tests 19 | run: cargo test --verbose --features unsafe_tests 20 | fuzz: 21 | runs-on: ubuntu-latest 22 | steps: 23 | - uses: actions/checkout@v2 24 | - name: Install latest nightly 25 | uses: actions-rs/toolchain@v1 26 | with: 27 | toolchain: nightly 28 | override: true 29 | - name: Run fuzzing 30 | run: | 31 | cargo install cargo-fuzz 32 | cargo fuzz run round_trip -- -runs=100000 33 | cargo fuzz run escape -- -runs=100000 34 | cargo fuzz run unescape -- -runs=100000 35 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /Cargo.lock 2 | /target 3 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## v0.3.1 2 | 3 | ### Changes 4 | 5 | * Additional characters that have special meanings in shells are now quoted. 6 | Specifically, the following characters will now trigger quoting: `;`, `~`, 7 | `(`, `)`, `&`, `$`, `#`, `>`, `<`, `|`. 8 | 9 | ## v0.3.0 10 | 11 | ### Changes 12 | 13 | * Errors compatible with the `std::error::Error` trait are returned as the 14 | error type in all results now. Previously all results used `String` for the 15 | error variant. This change is backwards incompatible, but allows handling 16 | errors from the library much more easily and correctly. Please consult the 17 | generated documentation for full details on the new error types. 18 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "snailquote" 3 | description = "Escape and unescape strings with shell-inspired quoting" 4 | version = "0.3.1" 5 | authors = ["Euan Kemp "] 6 | homepage = "https://github.com/euank/snailquote" 7 | repository = "https://github.com/euank/snailquote" 8 | readme = "README.md" 9 | keywords = ["quote", "escape", "shell-escape", "unescape"] 10 | license = "GPL-3.0-only" 11 | edition = "2018" 12 | 13 | [dependencies] 14 | unicode_categories = "0.1.1" 15 | thiserror = "1.0" 16 | 17 | [dev-dependencies] 18 | quickcheck = "0.9" 19 | quickcheck_macros = "0.9" 20 | 21 | [features] 22 | # This feature enables executing shell commands as part of tests. It's turned 23 | # off by default. 24 | unsafe_tests = [] 25 | 26 | -------------------------------------------------------------------------------- /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 | ## snailquote 2 | 3 | [![Build Status](https://github.com/euank/snailquote/actions/workflows/rust.yml/badge.svg?branch=master)](https://github.com/euank/snailquote/actions/workflows/rust.yml) 4 | 5 | [![Docs](https://docs.rs/snailquote/badge.svg)](https://docs.rs/snailquote) 6 | 7 | This library provides functions to escape and unescape strings. 8 | 9 | It escapes them in a roughly 'sh' compatible way (e.g. double quotes supporting 10 | backslash escapes, single quotes supporting no escapes). 11 | 12 | In addition, it provides support for common c-like ascii escapes (like `\n` for 13 | newline, `\v` for vertical tab, etc) and rust-string-like unicode (via 14 | `\u{12ff}` style escapes). 15 | 16 | More importantly, this library also provides the ability to un-escape a given 17 | escaped text to recover the original string. 18 | 19 | For more information on usage and what escape sequences will work, see the [docs](https://docs.rs/snailquote). 20 | 21 | ### Compatibility 22 | 23 | snailquote intends to explicitly be compatible with the following use-cases: 24 | 25 | 1. Readable encoding of arbitrary strings for user's editing; re-parsing of 26 | said strings after being edited. 27 | 1. Reading and writing the values of [`os-release`](https://www.freedesktop.org/software/systemd/man/os-release.html) files. 28 | 29 | Other files may have a similar shell-inspired format that snailescape works with, but it's up to you to verify it really is similar enough to be correct. 30 | 31 | snailquote is inspired by, but not compatible with, the following: 32 | 33 | 1. gnulib [quotearg](https://www.gnu.org/software/gnulib/manual/html_node/Quoting.html), as used for 'ls' output -- snailquote handles unicode escapes differently. 34 | 2. ANSI-c string literal quoting -- snailquote handles unicode differently and supports shell-related escapes, like '$'. 35 | 3. sh string quoting -- snailquote handles unicode differently and is more lax about shell special characters. 36 | 37 | ### Why not use \ 38 | 39 | Other libraries in rust I've found have one or more of the following problems: 40 | 41 | 1. The escaped text is not as easily human-editable 42 | 1. There is no way to un-escape text 43 | 1. NIH 44 | -------------------------------------------------------------------------------- /fuzz/.gitignore: -------------------------------------------------------------------------------- 1 | target 2 | corpus 3 | artifacts 4 | -------------------------------------------------------------------------------- /fuzz/Cargo.lock: -------------------------------------------------------------------------------- 1 | # This file is automatically @generated by Cargo. 2 | # It is not intended for manual editing. 3 | version = 3 4 | 5 | [[package]] 6 | name = "arbitrary" 7 | version = "1.1.2" 8 | source = "registry+https://github.com/rust-lang/crates.io-index" 9 | checksum = "25e0a02cf12f1b1f48b14cb7f8217b876d09992b39c816ffb3b1ba64dd979a87" 10 | 11 | [[package]] 12 | name = "cc" 13 | version = "1.0.73" 14 | source = "registry+https://github.com/rust-lang/crates.io-index" 15 | checksum = "2fff2a6927b3bb87f9595d67196a70493f627687a71d87a0d692242c33f58c11" 16 | 17 | [[package]] 18 | name = "libfuzzer-sys" 19 | version = "0.4.3" 20 | source = "registry+https://github.com/rust-lang/crates.io-index" 21 | checksum = "336244aaeab6a12df46480dc585802aa743a72d66b11937844c61bbca84c991d" 22 | dependencies = [ 23 | "arbitrary", 24 | "cc", 25 | "once_cell", 26 | ] 27 | 28 | [[package]] 29 | name = "once_cell" 30 | version = "1.12.0" 31 | source = "registry+https://github.com/rust-lang/crates.io-index" 32 | checksum = "7709cef83f0c1f58f666e746a08b21e0085f7440fa6a29cc194d68aac97a4225" 33 | 34 | [[package]] 35 | name = "proc-macro2" 36 | version = "1.0.40" 37 | source = "registry+https://github.com/rust-lang/crates.io-index" 38 | checksum = "dd96a1e8ed2596c337f8eae5f24924ec83f5ad5ab21ea8e455d3566c69fbcaf7" 39 | dependencies = [ 40 | "unicode-ident", 41 | ] 42 | 43 | [[package]] 44 | name = "quote" 45 | version = "1.0.20" 46 | source = "registry+https://github.com/rust-lang/crates.io-index" 47 | checksum = "3bcdf212e9776fbcb2d23ab029360416bb1706b1aea2d1a5ba002727cbcab804" 48 | dependencies = [ 49 | "proc-macro2", 50 | ] 51 | 52 | [[package]] 53 | name = "snailquote" 54 | version = "0.3.1" 55 | dependencies = [ 56 | "thiserror", 57 | "unicode_categories", 58 | ] 59 | 60 | [[package]] 61 | name = "snailquote-fuzz" 62 | version = "0.0.0" 63 | dependencies = [ 64 | "libfuzzer-sys", 65 | "snailquote", 66 | ] 67 | 68 | [[package]] 69 | name = "syn" 70 | version = "1.0.98" 71 | source = "registry+https://github.com/rust-lang/crates.io-index" 72 | checksum = "c50aef8a904de4c23c788f104b7dddc7d6f79c647c7c8ce4cc8f73eb0ca773dd" 73 | dependencies = [ 74 | "proc-macro2", 75 | "quote", 76 | "unicode-ident", 77 | ] 78 | 79 | [[package]] 80 | name = "thiserror" 81 | version = "1.0.31" 82 | source = "registry+https://github.com/rust-lang/crates.io-index" 83 | checksum = "bd829fe32373d27f76265620b5309d0340cb8550f523c1dda251d6298069069a" 84 | dependencies = [ 85 | "thiserror-impl", 86 | ] 87 | 88 | [[package]] 89 | name = "thiserror-impl" 90 | version = "1.0.31" 91 | source = "registry+https://github.com/rust-lang/crates.io-index" 92 | checksum = "0396bc89e626244658bef819e22d0cc459e795a5ebe878e6ec336d1674a8d79a" 93 | dependencies = [ 94 | "proc-macro2", 95 | "quote", 96 | "syn", 97 | ] 98 | 99 | [[package]] 100 | name = "unicode-ident" 101 | version = "1.0.1" 102 | source = "registry+https://github.com/rust-lang/crates.io-index" 103 | checksum = "5bd2fe26506023ed7b5e1e315add59d6f584c621d037f9368fea9cfb988f368c" 104 | 105 | [[package]] 106 | name = "unicode_categories" 107 | version = "0.1.1" 108 | source = "registry+https://github.com/rust-lang/crates.io-index" 109 | checksum = "39ec24b3121d976906ece63c9daad25b85969647682eee313cb5779fdd69e14e" 110 | -------------------------------------------------------------------------------- /fuzz/Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "snailquote-fuzz" 3 | version = "0.0.0" 4 | authors = ["Automatically generated"] 5 | publish = false 6 | edition = "2018" 7 | 8 | [package.metadata] 9 | cargo-fuzz = true 10 | 11 | [dependencies] 12 | libfuzzer-sys = "0.4" 13 | 14 | [dependencies.snailquote] 15 | path = ".." 16 | 17 | # Prevent this from interfering with workspaces 18 | [workspace] 19 | members = ["."] 20 | 21 | [[bin]] 22 | name = "unescape" 23 | path = "fuzz_targets/unescape.rs" 24 | test = false 25 | doc = false 26 | 27 | [[bin]] 28 | name = "escape" 29 | path = "fuzz_targets/escape.rs" 30 | test = false 31 | doc = false 32 | 33 | [[bin]] 34 | name = "round_trip" 35 | path = "fuzz_targets/round_trip.rs" 36 | test = false 37 | doc = false 38 | -------------------------------------------------------------------------------- /fuzz/fuzz_targets/escape.rs: -------------------------------------------------------------------------------- 1 | #![no_main] 2 | use libfuzzer_sys::fuzz_target; 3 | use snailquote; 4 | 5 | fuzz_target!(|data: &[u8]| { 6 | if let Ok(s) = std::str::from_utf8(data) { 7 | // test for no panics 8 | let _ = snailquote::escape(s); 9 | } 10 | }); 11 | -------------------------------------------------------------------------------- /fuzz/fuzz_targets/round_trip.rs: -------------------------------------------------------------------------------- 1 | #![no_main] 2 | use libfuzzer_sys::fuzz_target; 3 | use snailquote::{escape, unescape}; 4 | 5 | fuzz_target!(|data: &[u8]| { 6 | if let Ok(s) = std::str::from_utf8(data) { 7 | assert!(s == unescape(&escape(&s)).unwrap()) 8 | } 9 | }); 10 | -------------------------------------------------------------------------------- /fuzz/fuzz_targets/unescape.rs: -------------------------------------------------------------------------------- 1 | #![no_main] 2 | use libfuzzer_sys::fuzz_target; 3 | use snailquote; 4 | 5 | fuzz_target!(|data: &[u8]| { 6 | if let Ok(s) = std::str::from_utf8(data) { 7 | // test for no panics 8 | let _ = snailquote::unescape(s); 9 | } 10 | }); 11 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | #[cfg(test)] 2 | extern crate quickcheck; 3 | #[cfg(test)] 4 | #[macro_use(quickcheck)] 5 | extern crate quickcheck_macros; 6 | 7 | extern crate unicode_categories; 8 | 9 | use std::borrow::Cow; 10 | use std::num::ParseIntError; 11 | use std::{char, str}; 12 | use thiserror::Error; 13 | use unicode_categories::UnicodeCategories; 14 | 15 | /// Escape the provided string with shell-like quoting and escapes. 16 | /// Strings which do not need to be escaped will be returned unchanged. 17 | /// 18 | /// # Details 19 | /// 20 | /// Escape will prefer to avoid quoting when possible. When quotes are required, it will prefer 21 | /// single quotes (which have simpler semantics, namely no escaping). In all other cases it will 22 | /// use double quotes and escape whatever characters it needs to. 23 | /// 24 | /// For the full list of escapes which will be used, see the table in 25 | /// [unescape](unescape). 26 | /// 27 | /// # Examples 28 | /// ``` 29 | /// use snailquote::escape; 30 | /// # // The println/assert duplication is because I want to show the output you'd get without 31 | /// # // rust's string quoting/escaping getting in the way 32 | /// # // Ideally we could just assert on stdout, not duplicate, see 33 | /// # // https://github.com/rust-lang/rfcs/issues/2270 34 | /// println!("{}", escape("foo")); // no escapes needed 35 | /// // foo 36 | /// # assert_eq!(escape("foo"), "foo"); 37 | /// println!("{}", escape("String with spaces")); // single-quoteable 38 | /// // 'String with spaces' 39 | /// # assert_eq!(escape("String with spaces"), "'String with spaces'"); 40 | /// println!("{}", escape("東方")); // no escapes needed 41 | /// // 東方 42 | /// # assert_eq!(escape("東方"), "東方"); 43 | /// println!("{}", escape("\"new\nline\"")); // escape needed 44 | /// // "\"new\nline\"" 45 | /// # assert_eq!(escape("\"new\nline\""), "\"\\\"new\\nline\\\"\""); 46 | /// ``` 47 | // escape performs some minimal 'shell-like' escaping on a given string 48 | pub fn escape(s: &str) -> Cow { 49 | let mut needs_quoting = false; 50 | let mut single_quotable = true; 51 | 52 | for c in s.chars() { 53 | let quote = match c { 54 | // Special cases, can't be single quoted 55 | '\'' | '\\' => { 56 | single_quotable = false; 57 | true 58 | } 59 | // ' ' is up here before c.is_whitespace() because it's the only whitespace we can 60 | // single quote safely. Things like '\t' need to be escaped. 61 | '"' | ' ' => true, 62 | // Special characters in shells that can error out or expand if not quoted 63 | '(' | ')' | '&' | '~' | '$' | '#' | '`' | ';' => true, 64 | // sh globbing chars 65 | '*' | '?' | '!' | '[' => true, 66 | // redirects / pipes 67 | '>' | '<' | '|' => true, 68 | c if c.is_whitespace() || c.is_separator() || c.is_other() => { 69 | // we need to escape most whitespace (i.e. \t), so we need double quotes. 70 | single_quotable = false; 71 | true 72 | } 73 | _ => false, 74 | }; 75 | if quote { 76 | needs_quoting = true; 77 | } 78 | if needs_quoting && !single_quotable { 79 | // We know we'll need double quotes, no need to check further 80 | break; 81 | } 82 | } 83 | 84 | if !needs_quoting { 85 | return Cow::from(s); 86 | } 87 | if single_quotable { 88 | return format!("'{}'", s).into(); 89 | } 90 | // otherwise we need to double quote it 91 | 92 | let mut output = String::with_capacity(s.len()); 93 | output.push('"'); 94 | 95 | for c in s.chars() { 96 | if c == '"' { 97 | output += "\\\""; 98 | } else if c == '\\' { 99 | output += "\\\\"; 100 | } else if c == ' ' { 101 | // avoid 'escape_unicode' for ' ' even though it's a separator 102 | output.push(c); 103 | } else if c == '$' { 104 | output += "\\$"; 105 | } else if c == '`' { 106 | output += "\\`"; 107 | } else if c.is_other() || c.is_separator() { 108 | output += &escape_character(c); 109 | } else { 110 | output.push(c); 111 | } 112 | } 113 | 114 | output.push('"'); 115 | output.into() 116 | } 117 | 118 | // escape_character is an internal helper method which converts the given unicode character into an 119 | // escape sequence. It is assumed the character passed in *must* be escaped (e.g. it is some non-printable 120 | // or unusual character). 121 | // escape_character will prefer more human readable escapes (e.g. '\n' over '\u{0a}'), but will 122 | // fall back on dumb unicode escaping. 123 | // It is similar to rust's "char::escape_default", but supports additional escapes that rust does 124 | // not. For strings that don't contain these unusual characters, it's identical to 'escape_default'. 125 | fn escape_character(c: char) -> String { 126 | match c { 127 | '\u{07}' => "\\a".to_string(), 128 | '\u{08}' => "\\b".to_string(), 129 | '\u{0b}' => "\\v".to_string(), 130 | '\u{0c}' => "\\f".to_string(), 131 | '\u{1b}' => "\\e".to_string(), 132 | c => { 133 | // escape_default does the right thing for \t, \r, \n, and unicode 134 | c.escape_default().to_string() 135 | } 136 | } 137 | } 138 | 139 | /// Error type of [unescape](unescape). 140 | #[derive(Debug, Clone, PartialEq, Eq, Error)] 141 | pub enum UnescapeError { 142 | #[error("invalid escape {escape} at {index} in {string}")] 143 | InvalidEscape { 144 | escape: String, 145 | index: usize, 146 | string: String, 147 | }, 148 | #[error("\\u could not be parsed at {index} in {string}: {source}")] 149 | InvalidUnicode { 150 | #[source] 151 | source: ParseUnicodeError, 152 | index: usize, 153 | string: String, 154 | }, 155 | } 156 | 157 | /// Source error type of [UnescapeError::InvalidUnicode](UnescapeError::InvalidUnicode). 158 | #[derive(Debug, Clone, PartialEq, Eq, Error)] 159 | pub enum ParseUnicodeError { 160 | #[error("expected '{{' character in unicode escape")] 161 | BraceNotFound, 162 | #[error("could not parse {string} as u32 hex: {source}")] 163 | ParseHexFailed { 164 | #[source] 165 | source: ParseIntError, 166 | string: String, 167 | }, 168 | #[error("could not parse {value} as a unicode char")] 169 | ParseUnicodeFailed { value: u32 }, 170 | } 171 | 172 | /// Parse the provided shell-like quoted string, such as one produced by [escape](escape). 173 | /// 174 | /// # Details 175 | /// 176 | /// Unescape is able to handle single quotes (which cannot contain any additional escapes), double 177 | /// quotes (which may contain a set of escapes similar to ANSI-C, i.e. '\n', '\r', '\'', etc. 178 | /// Unescape will also parse unicode escapes of the form "\u{01ff}". See 179 | /// [char::escape_unicode](std::char::EscapeUnicode) in the Rust standard library for more 180 | /// information on these escapes. 181 | /// 182 | /// Multiple different quoting styles may be used in one string, for example, the following string 183 | /// is valid: `'some spaces'_some_unquoted_"and a \t tab"`. 184 | /// 185 | /// The full set of supported escapes between double quotes may be found below: 186 | /// 187 | /// | Escape | Unicode | Description | 188 | /// |--------|---------|-------------| 189 | /// | \a | \u{07} | Bell | 190 | /// | \b | \u{08} | Backspace | 191 | /// | \v | \u{0B} | Vertical tab | 192 | /// | \f | \u{0C} | Form feed | 193 | /// | \n | \u{0A} | Newline | 194 | /// | \r | \u{0D} | Carriage return | 195 | /// | \t | \u{09} | Tab 196 | /// | \e | \u{1B} | Escape | 197 | /// | \E | \u{1B} | Escape | 198 | /// | \\ | \u{5C} | Backslash | 199 | /// | \' | \u{27} | Single quote | 200 | /// | \" | \u{22} | Double quote | 201 | /// | \$ | \u{24} | Dollar sign (sh compatibility) | 202 | /// | \` | \u{60} | Backtick (sh compatibility) | 203 | /// | \u{XX} | \u{XX} | Unicode character with hex code XX | 204 | /// 205 | /// # Errors 206 | /// 207 | /// The returned result can display a human readable error if the string cannot be parsed as a 208 | /// valid quoted string. 209 | /// 210 | /// # Examples 211 | /// ``` 212 | /// use snailquote::unescape; 213 | /// # // The println/assert duplication is because I want to show the output you'd get without 214 | /// # // rust's string quoting/escaping getting in the way 215 | /// # // Ideally we could just assert on stdout, not duplicate, see 216 | /// # // https://github.com/rust-lang/rfcs/issues/2270 217 | /// println!("{}", unescape("foo").unwrap()); 218 | /// // foo 219 | /// # assert_eq!(unescape("foo").unwrap(), "foo"); 220 | /// println!("{}", unescape("'String with spaces'").unwrap()); 221 | /// // String with spaces 222 | /// # assert_eq!(unescape("'String with spaces'").unwrap(), "String with spaces"); 223 | /// println!("{}", unescape("\"new\\nline\"").unwrap()); 224 | /// // new 225 | /// // line 226 | /// # assert_eq!(unescape("\"new\\nline\"").unwrap(), "new\nline"); 227 | /// println!("{}", unescape("'some spaces'_some_unquoted_\"and a \\t tab\"").unwrap()); 228 | /// // some spaces_some_unquoted_and a tab 229 | /// # assert_eq!(unescape("'some spaces'_some_unquoted_\"and a \\t tab\"").unwrap(), "some spaces_some_unquoted_and a \t tab"); 230 | /// ``` 231 | pub fn unescape(s: &str) -> Result { 232 | let mut in_single_quote = false; 233 | let mut in_double_quote = false; 234 | 235 | let mut chars = s.chars().enumerate(); 236 | 237 | let mut res = String::with_capacity(s.len()); 238 | 239 | while let Some((idx, c)) = chars.next() { 240 | // when in a single quote, no escapes are possible 241 | if in_single_quote { 242 | if c == '\'' { 243 | in_single_quote = false; 244 | continue; 245 | } 246 | } else if in_double_quote { 247 | if c == '"' { 248 | in_double_quote = false; 249 | continue; 250 | } 251 | 252 | if c == '\\' { 253 | match chars.next() { 254 | None => { 255 | return Err(UnescapeError::InvalidEscape { 256 | escape: format!("{}", c), 257 | index: idx, 258 | string: String::from(s), 259 | }); 260 | } 261 | Some((idx, c2)) => { 262 | res.push(match c2 { 263 | 'a' => '\u{07}', 264 | 'b' => '\u{08}', 265 | 'v' => '\u{0B}', 266 | 'f' => '\u{0C}', 267 | 'n' => '\n', 268 | 'r' => '\r', 269 | 't' => '\t', 270 | 'e' | 'E' => '\u{1B}', 271 | '\\' => '\\', 272 | '\'' => '\'', 273 | '"' => '"', 274 | '$' => '$', 275 | '`' => '`', 276 | ' ' => ' ', 277 | 'u' => parse_unicode(&mut chars).map_err(|x| { 278 | UnescapeError::InvalidUnicode { 279 | source: x, 280 | index: idx, 281 | string: String::from(s), 282 | } 283 | })?, 284 | _ => { 285 | return Err(UnescapeError::InvalidEscape { 286 | escape: format!("{}{}", c, c2), 287 | index: idx, 288 | string: String::from(s), 289 | }); 290 | } 291 | }); 292 | continue; 293 | } 294 | }; 295 | } 296 | } else if c == '\'' { 297 | in_single_quote = true; 298 | continue; 299 | } else if c == '"' { 300 | in_double_quote = true; 301 | continue; 302 | } 303 | 304 | res.push(c); 305 | } 306 | 307 | Ok(res) 308 | } 309 | 310 | // parse_unicode takes an iterator over characters and attempts to extract a single unicode 311 | // character from it. 312 | // It parses escapes of the form '\u{65b9}', but this internal helper function expects the cursor 313 | // to be advanced to between the 'u' and '{'. 314 | // It also expects to be passed an iterator which includes the index for the purpose of advancing 315 | // it as well, such as is produced by enumerate. 316 | fn parse_unicode(chars: &mut I) -> Result 317 | where 318 | I: Iterator, 319 | { 320 | match chars.next() { 321 | Some((_, '{')) => {} 322 | _ => { 323 | return Err(ParseUnicodeError::BraceNotFound); 324 | } 325 | } 326 | 327 | let unicode_seq: String = chars 328 | .take_while(|&(_, c)| c != '}') 329 | .map(|(_, c)| c) 330 | .collect(); 331 | 332 | u32::from_str_radix(&unicode_seq, 16) 333 | .map_err(|e| ParseUnicodeError::ParseHexFailed { 334 | source: e, 335 | string: unicode_seq, 336 | }) 337 | .and_then(|u| { 338 | char::from_u32(u).ok_or_else(|| ParseUnicodeError::ParseUnicodeFailed { value: u }) 339 | }) 340 | } 341 | 342 | #[cfg(test)] 343 | mod test { 344 | use super::*; 345 | use std::io::Read; 346 | #[cfg(feature = "unsafe_tests")] 347 | use std::process::Command; 348 | 349 | #[test] 350 | fn test_escape() { 351 | let test_cases = vec![ 352 | ("東方", "東方"), 353 | ("\"'", r#""\"'""#), 354 | ("\\", "\"\\\\\""), 355 | ("spaces only", "'spaces only'"), 356 | ("some\ttabs", "\"some\\ttabs\""), 357 | ("💩", "💩"), 358 | ("\u{202e}RTL", "\"\\u{202e}RTL\""), 359 | ("no\u{202b}space", "\"no\\u{202b}space\""), 360 | ("cash $ money $$ \t", "\"cash \\$ money \\$\\$ \\t\""), 361 | ("back ` tick `` \t", "\"back \\` tick \\`\\` \\t\""), 362 | ( 363 | "\u{07}\u{08}\u{0b}\u{0c}\u{0a}\u{0d}\u{09}\u{1b}\u{1b}\u{5c}\u{27}\u{22}", 364 | "\"\\a\\b\\v\\f\\n\\r\\t\\e\\e\\\\'\\\"\"", 365 | ), 366 | ("semi;colon", "'semi;colon'"), 367 | ]; 368 | 369 | for (s, expected) in test_cases { 370 | assert_eq!(escape(s), expected); 371 | } 372 | } 373 | 374 | #[test] 375 | fn test_unescape() { 376 | assert_eq!(unescape("\"\\u{6771}\\u{65b9}\""), Ok("東方".to_string())); 377 | assert_eq!(unescape("東方"), Ok("東方".to_string())); 378 | assert_eq!(unescape("\"\\\\\"'\"\"'"), Ok("\\\"\"".to_string())); 379 | assert_eq!(unescape("'\"'"), Ok("\"".to_string())); 380 | assert_eq!(unescape("'\"'"), Ok("\"".to_string())); 381 | // Every escape between double quotes 382 | assert_eq!( 383 | unescape("\"\\a\\b\\v\\f\\n\\r\\t\\e\\E\\\\\\'\\\"\\u{09}\\$\\`\""), 384 | Ok( 385 | "\u{07}\u{08}\u{0b}\u{0c}\u{0a}\u{0d}\u{09}\u{1b}\u{1b}\u{5c}\u{27}\u{22}\u{09}$`" 386 | .to_string() 387 | ) 388 | ); 389 | } 390 | 391 | #[test] 392 | fn test_unescape_error() { 393 | assert_eq!( 394 | unescape("\"\\x\""), 395 | Err(UnescapeError::InvalidEscape { 396 | escape: "\\x".to_string(), 397 | index: 2, 398 | string: "\"\\x\"".to_string() 399 | }) 400 | ); 401 | assert_eq!( 402 | unescape("\"\\u6771}\""), 403 | Err(UnescapeError::InvalidUnicode { 404 | source: ParseUnicodeError::BraceNotFound, 405 | index: 2, 406 | string: "\"\\u6771}\"".to_string() 407 | }) 408 | ); 409 | // Can't compare ParseIntError directly until 'int_error_matching' becomes stable 410 | assert_eq!( 411 | format!("{}", unescape("\"\\u{qqqq}\"").err().unwrap()), 412 | "\\u could not be parsed at 2 in \"\\u{qqqq}\": could not parse qqqq as u32 hex: invalid digit found in string" 413 | ); 414 | assert_eq!( 415 | unescape("\"\\u{ffffffff}\""), 416 | Err(UnescapeError::InvalidUnicode { 417 | source: ParseUnicodeError::ParseUnicodeFailed { value: 0xffffffff }, 418 | index: 2, 419 | string: "\"\\u{ffffffff}\"".to_string() 420 | }) 421 | ); 422 | } 423 | 424 | #[test] 425 | fn test_round_trip() { 426 | let test_cases = vec![ 427 | "東方", 428 | "foo bar baz", 429 | "\\", 430 | "\0", 431 | "\"'", 432 | "\"'''''\"()())}{{}{}{{{!////", 433 | "foo;bar", 434 | ]; 435 | 436 | for case in test_cases { 437 | assert_eq!(unescape(&escape(case)), Ok(case.to_owned())); 438 | } 439 | } 440 | 441 | #[quickcheck] 442 | fn round_trips(s: String) -> bool { 443 | s == unescape(&escape(&s)).unwrap() 444 | } 445 | 446 | #[quickcheck] 447 | fn unescape_no_panics(s: String) { 448 | // a panic will fail the test 449 | let _ = unescape(&s); 450 | } 451 | 452 | #[cfg(feature = "unsafe_tests")] 453 | #[quickcheck] 454 | fn sh_quoting_round_trips(s: String) -> bool { 455 | let s = s.replace(|c: char| c.is_ascii_control() || !c.is_ascii(), ""); 456 | let escaped = escape(&s); 457 | println!("escaped '{}' as '{}'", s, escaped); 458 | let output = Command::new("sh") 459 | .args(vec!["-c", &format!("printf '%s' {}", escaped)]) 460 | .output() 461 | .unwrap(); 462 | if !output.status.success() { 463 | panic!("printf %s {} did not exit with success", escaped); 464 | } 465 | let echo_output = String::from_utf8(output.stdout).unwrap(); 466 | println!("printf gave it back as '{}'", echo_output); 467 | echo_output == s 468 | } 469 | 470 | #[test] 471 | fn test_os_release_parsing() { 472 | let tests = vec![ 473 | ("fedora-19", "Fedora 19 (Schrödinger’s Cat)"), 474 | ("fedora-29", "Fedora 29 (Twenty Nine)"), 475 | ("gentoo", "Gentoo/Linux"), 476 | ("fictional", "Fictional $ OS: ` edition"), 477 | ]; 478 | 479 | for (file, pretty_name) in tests { 480 | let mut data = String::new(); 481 | std::fs::File::open(format!("./src/testdata/os-releases/{}", file)) 482 | .unwrap() 483 | .read_to_string(&mut data) 484 | .unwrap(); 485 | 486 | let mut found_prettyname = false; 487 | // partial os-release parser 488 | for line in data.lines() { 489 | if line.trim().starts_with("#") { 490 | continue; 491 | } 492 | let mut iter = line.splitn(2, "="); 493 | let key = iter.next().unwrap(); 494 | let value = iter.next().unwrap(); 495 | // assert we can parse the value 496 | let unescaped = unescape(value).unwrap(); 497 | if key == "PRETTY_NAME" { 498 | assert_eq!(unescaped, pretty_name); 499 | found_prettyname = true; 500 | } 501 | } 502 | assert!( 503 | found_prettyname, 504 | "expected os-release to have 'PRETTY_NAME' key" 505 | ); 506 | } 507 | } 508 | } 509 | -------------------------------------------------------------------------------- /src/testdata/os-releases/fedora-19: -------------------------------------------------------------------------------- 1 | NAME=Fedora 2 | VERSION="19 (Schrödinger’s Cat)" 3 | ID=fedora 4 | VERSION_ID=19 5 | PRETTY_NAME="Fedora 19 (Schrödinger’s Cat)" 6 | ANSI_COLOR="0;34" 7 | CPE_NAME="cpe:/o:fedoraproject:fedora:19" 8 | HOME_URL="https://fedoraproject.org/" 9 | BUG_REPORT_URL="https://bugzilla.redhat.com/" 10 | REDHAT_BUGZILLA_PRODUCT="Fedora" 11 | REDHAT_BUGZILLA_PRODUCT_VERSION=19 12 | REDHAT_SUPPORT_PRODUCT="Fedora" 13 | REDHAT_SUPPORT_PRODUCT_VERSION=19 14 | -------------------------------------------------------------------------------- /src/testdata/os-releases/fedora-29: -------------------------------------------------------------------------------- 1 | NAME=Fedora 2 | VERSION="29 (Twenty Nine)" 3 | ID=fedora 4 | VERSION_ID=29 5 | PLATFORM_ID="platform:f29" 6 | PRETTY_NAME="Fedora 29 (Twenty Nine)" 7 | ANSI_COLOR="0;34" 8 | CPE_NAME="cpe:/o:fedoraproject:fedora:29" 9 | HOME_URL="https://fedoraproject.org/" 10 | DOCUMENTATION_URL="https://docs.fedoraproject.org/en-US/fedora/f29/system-administrators-guide/" 11 | SUPPORT_URL="https://fedoraproject.org/wiki/Communicating_and_getting_help" 12 | BUG_REPORT_URL="https://bugzilla.redhat.com/" 13 | REDHAT_BUGZILLA_PRODUCT="Fedora" 14 | REDHAT_BUGZILLA_PRODUCT_VERSION=29 15 | REDHAT_SUPPORT_PRODUCT="Fedora" 16 | REDHAT_SUPPORT_PRODUCT_VERSION=29 17 | PRIVACY_POLICY_URL="https://fedoraproject.org/wiki/Legal:PrivacyPolicy" 18 | -------------------------------------------------------------------------------- /src/testdata/os-releases/fictional: -------------------------------------------------------------------------------- 1 | NAME='Fictional os-release to use lots of escapes' 2 | VERSION="420" 3 | ID=1 4 | VERSION_ID=1 5 | PRETTY_NAME="Fictional \$ OS: \` edition" 6 | KEY='$' 7 | -------------------------------------------------------------------------------- /src/testdata/os-releases/gentoo: -------------------------------------------------------------------------------- 1 | NAME=Gentoo 2 | ID=gentoo 3 | PRETTY_NAME="Gentoo/Linux" 4 | ANSI_COLOR="1;32" 5 | HOME_URL="https://www.gentoo.org/" 6 | SUPPORT_URL="https://www.gentoo.org/support/" 7 | BUG_REPORT_URL="https://bugs.gentoo.org/" 8 | --------------------------------------------------------------------------------