├── LICENSE ├── README.md └── src └── git-split-file.sh /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | GNU GENERAL PUBLIC LICENSE 3 | Version 3, 29 June 2007 4 | 5 | Copyright (C) 2007 Free Software Foundation, Inc. 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The GNU General Public License is a free, copyleft license for 12 | software and other kinds of works. 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 | the GNU General Public License is 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. We, the Free Software Foundation, use the 19 | GNU General Public License for most of our software; it applies also to 20 | any other work released this way by its authors. You can apply it to 21 | your programs, too. 22 | 23 | When we speak of free software, we are referring to freedom, not 24 | price. Our General Public Licenses are designed to make sure that you 25 | have the freedom to distribute copies of free software (and charge for 26 | them if you wish), that you receive source code or can get it if you 27 | want it, that you can change the software or use pieces of it in new 28 | free programs, and that you know you can do these things. 29 | 30 | To protect your rights, we need to prevent others from denying you 31 | these rights or asking you to surrender the rights. Therefore, you have 32 | certain responsibilities if you distribute copies of the software, or if 33 | you modify it: responsibilities to respect the freedom of others. 34 | 35 | For example, if you distribute copies of such a program, whether 36 | gratis or for a fee, you must pass on to the recipients the same 37 | freedoms that you received. You must make sure that they, too, receive 38 | or can get the source code. And you must show them these terms so they 39 | know their rights. 40 | 41 | Developers that use the GNU GPL protect your rights with two steps: 42 | (1) assert copyright on the software, and (2) offer you this License 43 | giving you legal permission to copy, distribute and/or modify it. 44 | 45 | For the developers' and authors' protection, the GPL clearly explains 46 | that there is no warranty for this free software. For both users' and 47 | authors' sake, the GPL requires that modified versions be marked as 48 | changed, so that their problems will not be attributed erroneously to 49 | authors of previous versions. 50 | 51 | Some devices are designed to deny users access to install or run 52 | modified versions of the software inside them, although the manufacturer 53 | can do so. This is fundamentally incompatible with the aim of 54 | protecting users' freedom to change the software. The systematic 55 | pattern of such abuse occurs in the area of products for individuals to 56 | use, which is precisely where it is most unacceptable. Therefore, we 57 | have designed this version of the GPL to prohibit the practice for those 58 | products. If such problems arise substantially in other domains, we 59 | stand ready to extend this provision to those domains in future versions 60 | of the GPL, as needed to protect the freedom of users. 61 | 62 | Finally, every program is threatened constantly by software patents. 63 | States should not allow patents to restrict development and use of 64 | software on general-purpose computers, but in those that do, we wish to 65 | avoid the special danger that patents applied to a free program could 66 | make it effectively proprietary. To prevent this, the GPL assures that 67 | patents cannot be used to render the program non-free. 68 | 69 | The precise terms and conditions for copying, distribution and 70 | modification follow. 71 | 72 | TERMS AND CONDITIONS 73 | 74 | 0. Definitions. 75 | 76 | "This License" refers to version 3 of the GNU General Public License. 77 | 78 | "Copyright" also means copyright-like laws that apply to other kinds of 79 | works, such as semiconductor masks. 80 | 81 | "The Program" refers to any copyrightable work licensed under this 82 | License. Each licensee is addressed as "you". "Licensees" and 83 | "recipients" may be individuals or organizations. 84 | 85 | To "modify" a work means to copy from or adapt all or part of the work 86 | in a fashion requiring copyright permission, other than the making of an 87 | exact copy. The resulting work is called a "modified version" of the 88 | earlier work or a work "based on" the earlier work. 89 | 90 | A "covered work" means either the unmodified Program or a work based 91 | on the Program. 92 | 93 | To "propagate" a work means to do anything with it that, without 94 | permission, would make you directly or secondarily liable for 95 | infringement under applicable copyright law, except executing it on a 96 | computer or modifying a private copy. Propagation includes copying, 97 | distribution (with or without modification), making available to the 98 | public, and in some countries other activities as well. 99 | 100 | To "convey" a work means any kind of propagation that enables other 101 | parties to make or receive copies. Mere interaction with a user through 102 | a computer network, with no transfer of a copy, is not conveying. 103 | 104 | An interactive user interface displays "Appropriate Legal Notices" 105 | to the extent that it includes a convenient and prominently visible 106 | feature that (1) displays an appropriate copyright notice, and (2) 107 | tells the user that there is no warranty for the work (except to the 108 | extent that warranties are provided), that licensees may convey the 109 | work under this License, and how to view a copy of this License. If 110 | the interface presents a list of user commands or options, such as a 111 | menu, a prominent item in the list meets this criterion. 112 | 113 | 1. Source Code. 114 | 115 | The "source code" for a work means the preferred form of the work 116 | for making modifications to it. "Object code" means any non-source 117 | form of a work. 118 | 119 | A "Standard Interface" means an interface that either is an official 120 | standard defined by a recognized standards body, or, in the case of 121 | interfaces specified for a particular programming language, one that 122 | is widely used among developers working in that language. 123 | 124 | The "System Libraries" of an executable work include anything, other 125 | than the work as a whole, that (a) is included in the normal form of 126 | packaging a Major Component, but which is not part of that Major 127 | Component, and (b) serves only to enable use of the work with that 128 | Major Component, or to implement a Standard Interface for which an 129 | implementation is available to the public in source code form. A 130 | "Major Component", in this context, means a major essential component 131 | (kernel, window system, and so on) of the specific operating system 132 | (if any) on which the executable work runs, or a compiler used to 133 | produce the work, or an object code interpreter used to run it. 134 | 135 | The "Corresponding Source" for a work in object code form means all 136 | the source code needed to generate, install, and (for an executable 137 | work) run the object code and to modify the work, including scripts to 138 | control those activities. However, it does not include the work's 139 | System Libraries, or general-purpose tools or generally available free 140 | programs which are used unmodified in performing those activities but 141 | which are not part of the work. For example, Corresponding Source 142 | includes interface definition files associated with source files for 143 | the work, and the source code for shared libraries and dynamically 144 | linked subprograms that the work is specifically designed to require, 145 | such as by intimate data communication or control flow between those 146 | subprograms and other parts of the work. 147 | 148 | The Corresponding Source need not include anything that users 149 | can regenerate automatically from other parts of the Corresponding 150 | Source. 151 | 152 | The Corresponding Source for a work in source code form is that 153 | same work. 154 | 155 | 2. Basic Permissions. 156 | 157 | All rights granted under this License are granted for the term of 158 | copyright on the Program, and are irrevocable provided the stated 159 | conditions are met. This License explicitly affirms your unlimited 160 | permission to run the unmodified Program. The output from running a 161 | covered work is covered by this License only if the output, given its 162 | content, constitutes a covered work. This License acknowledges your 163 | rights of fair use or other equivalent, as provided by copyright law. 164 | 165 | You may make, run and propagate covered works that you do not 166 | convey, without conditions so long as your license otherwise remains 167 | in force. You may convey covered works to others for the sole purpose 168 | of having them make modifications exclusively for you, or provide you 169 | with facilities for running those works, provided that you comply with 170 | the terms of this License in conveying all material for which you do 171 | not control copyright. Those thus making or running the covered works 172 | for you must do so exclusively on your behalf, under your direction 173 | and control, on terms that prohibit them from making any copies of 174 | your copyrighted material outside their relationship with you. 175 | 176 | Conveying under any other circumstances is permitted solely under 177 | the conditions stated below. Sublicensing is not allowed; section 10 178 | makes it unnecessary. 179 | 180 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 181 | 182 | No covered work shall be deemed part of an effective technological 183 | measure under any applicable law fulfilling obligations under article 184 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 185 | similar laws prohibiting or restricting circumvention of such 186 | measures. 187 | 188 | When you convey a covered work, you waive any legal power to forbid 189 | circumvention of technological measures to the extent such circumvention 190 | is effected by exercising rights under this License with respect to 191 | the covered work, and you disclaim any intention to limit operation or 192 | modification of the work as a means of enforcing, against the work's 193 | users, your or third parties' legal rights to forbid circumvention of 194 | technological measures. 195 | 196 | 4. Conveying Verbatim Copies. 197 | 198 | You may convey verbatim copies of the Program's source code as you 199 | receive it, in any medium, provided that you conspicuously and 200 | appropriately publish on each copy an appropriate copyright notice; 201 | keep intact all notices stating that this License and any 202 | non-permissive terms added in accord with section 7 apply to the code; 203 | keep intact all notices of the absence of any warranty; and give all 204 | recipients a copy of this License along with the Program. 205 | 206 | You may charge any price or no price for each copy that you convey, 207 | and you may offer support or warranty protection for a fee. 208 | 209 | 5. Conveying Modified Source Versions. 210 | 211 | You may convey a work based on the Program, or the modifications to 212 | produce it from the Program, in the form of source code under the 213 | terms of section 4, provided that you also meet all of these conditions: 214 | 215 | a) The work must carry prominent notices stating that you modified 216 | it, and giving a relevant date. 217 | 218 | b) The work must carry prominent notices stating that it is 219 | released under this License and any conditions added under section 220 | 7. This requirement modifies the requirement in section 4 to 221 | "keep intact all notices". 222 | 223 | c) You must license the entire work, as a whole, under this 224 | License to anyone who comes into possession of a copy. This 225 | License will therefore apply, along with any applicable section 7 226 | additional terms, to the whole of the work, and all its parts, 227 | regardless of how they are packaged. This License gives no 228 | permission to license the work in any other way, but it does not 229 | invalidate such permission if you have separately received it. 230 | 231 | d) If the work has interactive user interfaces, each must display 232 | Appropriate Legal Notices; however, if the Program has interactive 233 | interfaces that do not display Appropriate Legal Notices, your 234 | work need not make them do so. 235 | 236 | A compilation of a covered work with other separate and independent 237 | works, which are not by their nature extensions of the covered work, 238 | and which are not combined with it such as to form a larger program, 239 | in or on a volume of a storage or distribution medium, is called an 240 | "aggregate" if the compilation and its resulting copyright are not 241 | used to limit the access or legal rights of the compilation's users 242 | beyond what the individual works permit. Inclusion of a covered work 243 | in an aggregate does not cause this License to apply to the other 244 | parts of the aggregate. 245 | 246 | 6. Conveying Non-Source Forms. 247 | 248 | You may convey a covered work in object code form under the terms 249 | of sections 4 and 5, provided that you also convey the 250 | machine-readable Corresponding Source under the terms of this License, 251 | in one of these ways: 252 | 253 | a) Convey the object code in, or embodied in, a physical product 254 | (including a physical distribution medium), accompanied by the 255 | Corresponding Source fixed on a durable physical medium 256 | customarily used for software interchange. 257 | 258 | b) Convey the object code in, or embodied in, a physical product 259 | (including a physical distribution medium), accompanied by a 260 | written offer, valid for at least three years and valid for as 261 | long as you offer spare parts or customer support for that product 262 | model, to give anyone who possesses the object code either (1) a 263 | copy of the Corresponding Source for all the software in the 264 | product that is covered by this License, on a durable physical 265 | medium customarily used for software interchange, for a price no 266 | more than your reasonable cost of physically performing this 267 | conveying of source, or (2) access to copy the 268 | Corresponding Source from a network server at no charge. 269 | 270 | c) Convey individual copies of the object code with a copy of the 271 | written offer to provide the Corresponding Source. This 272 | alternative is allowed only occasionally and noncommercially, and 273 | only if you received the object code with such an offer, in accord 274 | with subsection 6b. 275 | 276 | d) Convey the object code by offering access from a designated 277 | place (gratis or for a charge), and offer equivalent access to the 278 | Corresponding Source in the same way through the same place at no 279 | further charge. You need not require recipients to copy the 280 | Corresponding Source along with the object code. If the place to 281 | copy the object code is a network server, the Corresponding Source 282 | may be on a different server (operated by you or a third party) 283 | that supports equivalent copying facilities, provided you maintain 284 | clear directions next to the object code saying where to find the 285 | Corresponding Source. Regardless of what server hosts the 286 | Corresponding Source, you remain obligated to ensure that it is 287 | available for as long as needed to satisfy these requirements. 288 | 289 | e) Convey the object code using peer-to-peer transmission, provided 290 | you inform other peers where the object code and Corresponding 291 | Source of the work are being offered to the general public at no 292 | charge under subsection 6d. 293 | 294 | A separable portion of the object code, whose source code is excluded 295 | from the Corresponding Source as a System Library, need not be 296 | included in conveying the object code work. 297 | 298 | A "User Product" is either (1) a "consumer product", which means any 299 | tangible personal property which is normally used for personal, family, 300 | or household purposes, or (2) anything designed or sold for incorporation 301 | into a dwelling. In determining whether a product is a consumer product, 302 | doubtful cases shall be resolved in favor of coverage. For a particular 303 | product received by a particular user, "normally used" refers to a 304 | typical or common use of that class of product, regardless of the status 305 | of the particular user or of the way in which the particular user 306 | actually uses, or expects or is expected to use, the product. A product 307 | is a consumer product regardless of whether the product has substantial 308 | commercial, industrial or non-consumer uses, unless such uses represent 309 | the only significant mode of use of the product. 310 | 311 | "Installation Information" for a User Product means any methods, 312 | procedures, authorization keys, or other information required to install 313 | and execute modified versions of a covered work in that User Product from 314 | a modified version of its Corresponding Source. The information must 315 | suffice to ensure that the continued functioning of the modified object 316 | code is in no case prevented or interfered with solely because 317 | modification has been made. 318 | 319 | If you convey an object code work under this section in, or with, or 320 | specifically for use in, a User Product, and the conveying occurs as 321 | part of a transaction in which the right of possession and use of the 322 | User Product is transferred to the recipient in perpetuity or for a 323 | fixed term (regardless of how the transaction is characterized), the 324 | Corresponding Source conveyed under this section must be accompanied 325 | by the Installation Information. But this requirement does not apply 326 | if neither you nor any third party retains the ability to install 327 | modified object code on the User Product (for example, the work has 328 | been installed in ROM). 329 | 330 | The requirement to provide Installation Information does not include a 331 | requirement to continue to provide support service, warranty, or updates 332 | for a work that has been modified or installed by the recipient, or for 333 | the User Product in which it has been modified or installed. Access to a 334 | network may be denied when the modification itself materially and 335 | adversely affects the operation of the network or violates the rules and 336 | protocols for communication across the network. 337 | 338 | Corresponding Source conveyed, and Installation Information provided, 339 | in accord with this section must be in a format that is publicly 340 | documented (and with an implementation available to the public in 341 | source code form), and must require no special password or key for 342 | unpacking, reading or copying. 343 | 344 | 7. Additional Terms. 345 | 346 | "Additional permissions" are terms that supplement the terms of this 347 | License by making exceptions from one or more of its conditions. 348 | Additional permissions that are applicable to the entire Program shall 349 | be treated as though they were included in this License, to the extent 350 | that they are valid under applicable law. If additional permissions 351 | apply only to part of the Program, that part may be used separately 352 | under those permissions, but the entire Program remains governed by 353 | this License without regard to the additional permissions. 354 | 355 | When you convey a copy of a covered work, you may at your option 356 | remove any additional permissions from that copy, or from any part of 357 | it. (Additional permissions may be written to require their own 358 | removal in certain cases when you modify the work.) You may place 359 | additional permissions on material, added by you to a covered work, 360 | for which you have or can give appropriate copyright permission. 361 | 362 | Notwithstanding any other provision of this License, for material you 363 | add to a covered work, you may (if authorized by the copyright holders of 364 | that material) supplement the terms of this License with terms: 365 | 366 | a) Disclaiming warranty or limiting liability differently from the 367 | terms of sections 15 and 16 of this License; or 368 | 369 | b) Requiring preservation of specified reasonable legal notices or 370 | author attributions in that material or in the Appropriate Legal 371 | Notices displayed by works containing it; or 372 | 373 | c) Prohibiting misrepresentation of the origin of that material, or 374 | requiring that modified versions of such material be marked in 375 | reasonable ways as different from the original version; or 376 | 377 | d) Limiting the use for publicity purposes of names of licensors or 378 | authors of the material; or 379 | 380 | e) Declining to grant rights under trademark law for use of some 381 | trade names, trademarks, or service marks; or 382 | 383 | f) Requiring indemnification of licensors and authors of that 384 | material by anyone who conveys the material (or modified versions of 385 | it) with contractual assumptions of liability to the recipient, for 386 | any liability that these contractual assumptions directly impose on 387 | those licensors and authors. 388 | 389 | All other non-permissive additional terms are considered "further 390 | restrictions" within the meaning of section 10. If the Program as you 391 | received it, or any part of it, contains a notice stating that it is 392 | governed by this License along with a term that is a further 393 | restriction, you may remove that term. If a license document contains 394 | a further restriction but permits relicensing or conveying under this 395 | License, you may add to a covered work material governed by the terms 396 | of that license document, provided that the further restriction does 397 | not survive such relicensing or conveying. 398 | 399 | If you add terms to a covered work in accord with this section, you 400 | must place, in the relevant source files, a statement of the 401 | additional terms that apply to those files, or a notice indicating 402 | where to find the applicable terms. 403 | 404 | Additional terms, permissive or non-permissive, may be stated in the 405 | form of a separately written license, or stated as exceptions; 406 | the above requirements apply either way. 407 | 408 | 8. Termination. 409 | 410 | You may not propagate or modify a covered work except as expressly 411 | provided under this License. Any attempt otherwise to propagate or 412 | modify it is void, and will automatically terminate your rights under 413 | this License (including any patent licenses granted under the third 414 | paragraph of section 11). 415 | 416 | However, if you cease all violation of this License, then your 417 | license from a particular copyright holder is reinstated (a) 418 | provisionally, unless and until the copyright holder explicitly and 419 | finally terminates your license, and (b) permanently, if the copyright 420 | holder fails to notify you of the violation by some reasonable means 421 | prior to 60 days after the cessation. 422 | 423 | Moreover, your license from a particular copyright holder is 424 | reinstated permanently if the copyright holder notifies you of the 425 | violation by some reasonable means, this is the first time you have 426 | received notice of violation of this License (for any work) from that 427 | copyright holder, and you cure the violation prior to 30 days after 428 | your receipt of the notice. 429 | 430 | Termination of your rights under this section does not terminate the 431 | licenses of parties who have received copies or rights from you under 432 | this License. If your rights have been terminated and not permanently 433 | reinstated, you do not qualify to receive new licenses for the same 434 | material under section 10. 435 | 436 | 9. Acceptance Not Required for Having Copies. 437 | 438 | You are not required to accept this License in order to receive or 439 | run a copy of the Program. Ancillary propagation of a covered work 440 | occurring solely as a consequence of using peer-to-peer transmission 441 | to receive a copy likewise does not require acceptance. However, 442 | nothing other than this License grants you permission to propagate or 443 | modify any covered work. These actions infringe copyright if you do 444 | not accept this License. Therefore, by modifying or propagating a 445 | covered work, you indicate your acceptance of this License to do so. 446 | 447 | 10. Automatic Licensing of Downstream Recipients. 448 | 449 | Each time you convey a covered work, the recipient automatically 450 | receives a license from the original licensors, to run, modify and 451 | propagate that work, subject to this License. You are not responsible 452 | for enforcing compliance by third parties with this License. 453 | 454 | An "entity transaction" is a transaction transferring control of an 455 | organization, or substantially all assets of one, or subdividing an 456 | organization, or merging organizations. If propagation of a covered 457 | work results from an entity transaction, each party to that 458 | transaction who receives a copy of the work also receives whatever 459 | licenses to the work the party's predecessor in interest had or could 460 | give under the previous paragraph, plus a right to possession of the 461 | Corresponding Source of the work from the predecessor in interest, if 462 | the predecessor has it or can get it with reasonable efforts. 463 | 464 | You may not impose any further restrictions on the exercise of the 465 | rights granted or affirmed under this License. For example, you may 466 | not impose a license fee, royalty, or other charge for exercise of 467 | rights granted under this License, and you may not initiate litigation 468 | (including a cross-claim or counterclaim in a lawsuit) alleging that 469 | any patent claim is infringed by making, using, selling, offering for 470 | sale, or importing the Program or any portion of it. 471 | 472 | 11. Patents. 473 | 474 | A "contributor" is a copyright holder who authorizes use under this 475 | License of the Program or a work on which the Program is based. The 476 | work thus licensed is called the contributor's "contributor version". 477 | 478 | A contributor's "essential patent claims" are all patent claims 479 | owned or controlled by the contributor, whether already acquired or 480 | hereafter acquired, that would be infringed by some manner, permitted 481 | by this License, of making, using, or selling its contributor version, 482 | but do not include claims that would be infringed only as a 483 | consequence of further modification of the contributor version. For 484 | purposes of this definition, "control" includes the right to grant 485 | patent sublicenses in a manner consistent with the requirements of 486 | this License. 487 | 488 | Each contributor grants you a non-exclusive, worldwide, royalty-free 489 | patent license under the contributor's essential patent claims, to 490 | make, use, sell, offer for sale, import and otherwise run, modify and 491 | propagate the contents of its contributor version. 492 | 493 | In the following three paragraphs, a "patent license" is any express 494 | agreement or commitment, however denominated, not to enforce a patent 495 | (such as an express permission to practice a patent or covenant not to 496 | sue for patent infringement). To "grant" such a patent license to a 497 | party means to make such an agreement or commitment not to enforce a 498 | patent against the party. 499 | 500 | If you convey a covered work, knowingly relying on a patent license, 501 | and the Corresponding Source of the work is not available for anyone 502 | to copy, free of charge and under the terms of this License, through a 503 | publicly available network server or other readily accessible means, 504 | then you must either (1) cause the Corresponding Source to be so 505 | available, or (2) arrange to deprive yourself of the benefit of the 506 | patent license for this particular work, or (3) arrange, in a manner 507 | consistent with the requirements of this License, to extend the patent 508 | license to downstream recipients. "Knowingly relying" means you have 509 | actual knowledge that, but for the patent license, your conveying the 510 | covered work in a country, or your recipient's use of the covered work 511 | in a country, would infringe one or more identifiable patents in that 512 | country that you have reason to believe are valid. 513 | 514 | If, pursuant to or in connection with a single transaction or 515 | arrangement, you convey, or propagate by procuring conveyance of, a 516 | covered work, and grant a patent license to some of the parties 517 | receiving the covered work authorizing them to use, propagate, modify 518 | or convey a specific copy of the covered work, then the patent license 519 | you grant is automatically extended to all recipients of the covered 520 | work and works based on it. 521 | 522 | A patent license is "discriminatory" if it does not include within 523 | the scope of its coverage, prohibits the exercise of, or is 524 | conditioned on the non-exercise of one or more of the rights that are 525 | specifically granted under this License. You may not convey a covered 526 | work if you are a party to an arrangement with a third party that is 527 | in the business of distributing software, under which you make payment 528 | to the third party based on the extent of your activity of conveying 529 | the work, and under which the third party grants, to any of the 530 | parties who would receive the covered work from you, a discriminatory 531 | patent license (a) in connection with copies of the covered work 532 | conveyed by you (or copies made from those copies), or (b) primarily 533 | for and in connection with specific products or compilations that 534 | contain the covered work, unless you entered into that arrangement, 535 | or that patent license was granted, prior to 28 March 2007. 536 | 537 | Nothing in this License shall be construed as excluding or limiting 538 | any implied license or other defenses to infringement that may 539 | otherwise be available to you under applicable patent law. 540 | 541 | 12. No Surrender of Others' Freedom. 542 | 543 | If conditions are imposed on you (whether by court order, agreement or 544 | otherwise) that contradict the conditions of this License, they do not 545 | excuse you from the conditions of this License. If you cannot convey a 546 | covered work so as to satisfy simultaneously your obligations under this 547 | License and any other pertinent obligations, then as a consequence you may 548 | not convey it at all. For example, if you agree to terms that obligate you 549 | to collect a royalty for further conveying from those to whom you convey 550 | the Program, the only way you could satisfy both those terms and this 551 | License would be to refrain entirely from conveying the Program. 552 | 553 | 13. Use with the GNU Affero General Public License. 554 | 555 | Notwithstanding any other provision of this License, you have 556 | permission to link or combine any covered work with a work licensed 557 | under version 3 of the GNU Affero General Public License into a single 558 | combined work, and to convey the resulting work. The terms of this 559 | License will continue to apply to the part which is the covered work, 560 | but the special requirements of the GNU Affero General Public License, 561 | section 13, concerning interaction through a network will apply to the 562 | combination as such. 563 | 564 | 14. Revised Versions of this License. 565 | 566 | The Free Software Foundation may publish revised and/or new versions of 567 | the GNU General Public License from time to time. Such new versions will 568 | be similar in spirit to the present version, but may differ in detail to 569 | address new problems or concerns. 570 | 571 | Each version is given a distinguishing version number. If the 572 | Program specifies that a certain numbered version of the GNU General 573 | Public License "or any later version" applies to it, you have the 574 | option of following the terms and conditions either of that numbered 575 | version or of any later version published by the Free Software 576 | Foundation. If the Program does not specify a version number of the 577 | GNU General Public License, you may choose any version ever published 578 | by the Free Software Foundation. 579 | 580 | If the Program specifies that a proxy can decide which future 581 | versions of the GNU General Public License can be used, that proxy's 582 | public statement of acceptance of a version permanently authorizes you 583 | to choose that version for the Program. 584 | 585 | Later license versions may give you additional or different 586 | permissions. However, no additional obligations are imposed on any 587 | author or copyright holder as a result of your choosing to follow a 588 | later version. 589 | 590 | 15. Disclaimer of Warranty. 591 | 592 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 593 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 594 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 595 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 596 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 597 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 598 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 599 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 600 | 601 | 16. Limitation of Liability. 602 | 603 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 604 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 605 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 606 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 607 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 608 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 609 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 610 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 611 | SUCH DAMAGES. 612 | 613 | 17. Interpretation of Sections 15 and 16. 614 | 615 | If the disclaimer of warranty and limitation of liability provided 616 | above cannot be given local legal effect according to their terms, 617 | reviewing courts shall apply local law that most closely approximates 618 | an absolute waiver of all civil liability in connection with the 619 | Program, unless a warranty or assumption of liability accompanies a 620 | copy of the Program in return for a fee. 621 | 622 | END OF TERMS AND CONDITIONS 623 | 624 | How to Apply These Terms to Your New Programs 625 | 626 | If you develop a new program, and you want it to be of the greatest 627 | possible use to the public, the best way to achieve this is to make it 628 | free software which everyone can redistribute and change under these terms. 629 | 630 | To do so, attach the following notices to the program. It is safest 631 | to attach them to the start of each source file to most effectively 632 | state the exclusion of warranty; and each file should have at least 633 | the "copyright" line and a pointer to where the full notice is found. 634 | 635 | {one line to give the program's name and a brief idea of what it does.} 636 | Copyright (C) {year} {name of author} 637 | 638 | This program is free software: you can redistribute it and/or modify 639 | it under the terms of the GNU General Public License as published by 640 | the Free Software Foundation, either version 3 of the License, or 641 | (at your option) any later version. 642 | 643 | This program is distributed in the hope that it will be useful, 644 | but WITHOUT ANY WARRANTY; without even the implied warranty of 645 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 646 | GNU General Public License for more details. 647 | 648 | You should have received a copy of the GNU General Public License 649 | along with this program. If not, see . 650 | 651 | Also add information on how to contact you by electronic and paper mail. 652 | 653 | If the program does terminal interaction, make it output a short 654 | notice like this when it starts in an interactive mode: 655 | 656 | {project} Copyright (C) {year} {fullname} 657 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 658 | This is free software, and you are welcome to redistribute it 659 | under certain conditions; type `show c' for details. 660 | 661 | The hypothetical commands `show w' and `show c' should show the appropriate 662 | parts of the General Public License. Of course, your program's commands 663 | might be different; for a GUI interface, you would use an "about box". 664 | 665 | You should also get your employer (if you work as a programmer) or school, 666 | if any, to sign a "copyright disclaimer" for the program, if necessary. 667 | For more information on this, and how to apply and follow the GNU GPL, see 668 | . 669 | 670 | The GNU General Public License does not permit incorporating your program 671 | into proprietary programs. If your program is a subroutine library, you 672 | may consider it more useful to permit linking proprietary applications with 673 | the library. If this is what you want to do, use the GNU Lesser General 674 | Public License instead of this License. But first, please read 675 | . 676 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | --- 2 | permalink: / 3 | --- 4 | 5 | # [Git Split File](https://github.com/Potherca/git-split-file) 6 | 7 | Split a file in a git repository without losing the git history. 8 | 9 | ## Introduction 10 | 11 | Usually when a file in a git repository is split into several different files, 12 | the history gets lost. 13 | 14 | Often this is not desirable. 15 | 16 | `git-split-file` allows for split files to retain their history. 17 | 18 | Splitting a file still needs to be done manually but this script will take care 19 | of branching/moving/renaming/committing/merging/etc. the split files. 20 | 21 | See the usage section for details on how to do this. 22 | 23 | ## Installation 24 | 25 | Clone or download this repository or the single file `git-split-file.sh` 26 | 27 | ## Usage 28 | 29 | In short all that needs to be done is manually split a file and call `git-split-file` 30 | 31 | There are, however, some details to take into account. 32 | 33 | ### Manually splitting the file 34 | 35 | You have a file in a git repository that you would like to split into several 36 | files. 37 | 38 | First create a directory the split files can be placed in. This directory does 39 | not have to reside in the git repository the file to split is in. 40 | 41 | Next split that file into several different files. The more of the order and 42 | whitespace is left intact, the more of the history will also be left intact. 43 | 44 | Under some circumstances it is desirable to have a truncated version of the file 45 | that has been split, under other circumstances the file that has been split can 46 | be removed completely. Both scenarios are supported. 47 | 48 | In the scenario where the file is to be deleted, just leave the contents of that 49 | file as-is. `git-split-file` will simply remove the file for you. 50 | 51 | In the scenario where a change version of the file is to remain in the repository, 52 | add a version of the file as it should eventually be in the directory that also holds the other split files. 53 | `git-split-file` will commit the changes for you. It is possible to tell the 54 | script to either leave the file in the same location or move it to the same 55 | location as the other split files. 56 | 57 | 58 | ### Calling the script 59 | 60 | As the final result can live outside of the repository, the script can easily be 61 | run on a clone to verify everything works out as desired. 62 | 63 | In order to function, the script needs to know a few things: 64 | 65 | - The source file that is to be split (the source file) 66 | - The directory where the split files are located (the source directory) 67 | - The location where the split files should be placed in the repository (the target path) 68 | - Whether to delete or move the source file. (the split strategy) 69 | 70 | Currently moving the source file to another location than the target path is not 71 | supported. 72 | 73 | ## How it works 74 | 75 | As a picture might communicate matter more clearly than mere words, consider the 76 | following: 77 | 78 | A---bN--cN split branch N 79 | / \ 80 | A---B---C \ split branch one 81 | / \ \ 82 | A-------D---E---eN source branch 83 | / \ 84 | --A--------------------F-- root branch 85 | 86 | - `A` is the last known commit on the root branch. 87 | - A separate branch is made to function as the "source" to and from other branches are split off. 88 | - For each file in the source directory a copy of the source file is created (using `git mv $SOURCE $TARGET`) leading to commit `B` (and `bN`). 89 | - The content of the copied file is updated (using `cat $CONTENT > $TARGET` and `git add/commit $TARGET`) leading to commit `C` (and `cN`). 90 | - The content of the source file is updated leading to commit `D`. 91 | - Each split branch is then merged into the source branch, resolving any conflicts that occur, leading to commit `E` (and `eN`). 92 | - When all branches have been merged, everything is merged back to the root branch. Commit `F` now has all of the changes. 93 | 94 | ## Origin / Motivation 95 | 96 | When working in low-quality code-bases that have grown organically over time, it 97 | is not uncommon to encounter files that span several (tens of) thousands of lines. 98 | 99 | For various reasons it is desirable to split such files into smaller files. 100 | 101 | Instead of doing this by hand, it made more sense to automate parts of the process. 102 | 103 | ## Development 104 | 105 | There is currently only [one test, in a separate repo](https://github.com/potherca-bash/git-split-file-test). Yes, more tests _do_ need to be added. 106 | Feel free to contribute some! 😉 107 | 108 | 123 | 124 | ## License 125 | 126 | This project has been licensed under [GPL-3.0+ License](LICENSE). 127 | -------------------------------------------------------------------------------- /src/git-split-file.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | #=============================================================================== 4 | # @TODO: Use named parameters instead of relying on parameter order 5 | # ------------------------------------------------------------------------------ 6 | # @TODO: Add parameter to set author 7 | # ------------------------------------------------------------------------------ 8 | # @TODO: Add silent mode (-s / --silent) to suppress all output 9 | # ------------------------------------------------------------------------------ 10 | # @TODO: Add yes mode (-y / --yes) to run without questions 11 | # ------------------------------------------------------------------------------ 12 | # @FIXME: The cleanup gives errors if cleanup is run before/without the split being run 13 | # ------------------------------------------------------------------------------ 14 | # @FIXME: Add "aggressive" mode that creates a commit on the source branch (?before/after? merge) 15 | # of the source file with all of the lines from the split file removed. 16 | # - Using grep? 17 | # - Programmatically creating a git patch? 18 | # - Doing a "reverse" patch? (http://stackoverflow.com/questions/16059771/reverse-apply-a-commit-to-working-copy) 19 | # - Creating a reverse diff? (http://stackoverflow.com/a/3902431/153049) 20 | # - Use patch created with GNU diff and use patch --reverse? (http://www.gnu.org/software/diffutils/manual/html_node/Reversed-Patches.html) 21 | # So many options. 22 | # 23 | # grep -Fvxf 24 | #=============================================================================== 25 | 26 | #/============================================================================== 27 | #/ GIT SPLIT FILE 28 | #/------------------------------------------------------------------------------ 29 | ## Usage: git.split.sh 30 | ## 31 | ## Where: 32 | ## - is the file in a git repository you would like to be split 33 | ## - is the directory that holds the result of how you would like 34 | ## things to be after the file has been split. 35 | ## - is the directory where the split files should be committed to 36 | ## - is the strategy that should be applied to the source-file 37 | ## Can be one of DELETE | MOVE 38 | ## 39 | #/ Usually when you want to split a file into several files under git, you would 40 | #/ loose the git history of this file. Often this is not desirable. The goal of 41 | #/ this script is to enable splitting one file under Git revision control into 42 | #/ multiple files whilst keeping the file's git history intact. 43 | #/ 44 | #/ For this script to work, you need to first create a folder that contains the 45 | #/ end result you want. This means you need to manually split the content of the 46 | #/ file you want to keep into separate files. The more of the order and 47 | #/ whitespace you leave intact, the more of the history will also be left intact. 48 | # 49 | #/ Once you have everything to your liking, you point this script to the file you 50 | #/ want to split, the folder that holds the desired end result and the location 51 | #/ where the result should be placed. 52 | #/ 53 | #/ This script will then branch of from the branch the designated git repo is on 54 | #/ for each file to split into. It will then split the given root file, commit 55 | #/ the split result and merge it back to the branch it was originally on. 56 | #/ ------------------------------------------------------------------------------ 57 | #/ The following ExitCodes are used: 58 | #/ 59 | #/ 0 : Everything OK 60 | #/ 64 : Undefined Error 61 | #/ 62 | #/ 65 : Not enough parameters given 63 | #/ 66 : The given root file does not exist 64 | #/ 67 : The given root file is not part of a git repository 65 | #/ 68 : Given split directory path does not exist 66 | #/ 69 : Given split directory path is not a directory 67 | #/ 70 : Given split strategy is not supported 68 | #/ 69 | # Please note that g_iExitCode needs to be set *before* error() is called, 70 | # otherwise the ExitCode will default to 64. 71 | #============================================================================== 72 | 73 | 74 | # ============================================================================== 75 | # CONFIG VARS 76 | # ------------------------------------------------------------------------------ 77 | # DEBUG_LEVEL 0 = No Debugging 78 | # DEBUG_LEVEL 1 = Show Debug messages 79 | # DEBUG_LEVEL 2 = " and show Application Calls 80 | # DEBUG_LEVEL 3 = " and show called command 81 | # DEBUG_LEVEL 4 = " and show all other commands (=set +x) 82 | # DEBUG_LEVEL 5 = Show All Commands, without Debug Messages or Application Calls 83 | # ============================================================================== 84 | 85 | 86 | # ============================================================================== 87 | # APPLICATION VARS 88 | # ------------------------------------------------------------------------------ 89 | # For all options see http://www.tldp.org/LDP/abs/html/options.html 90 | set -o nounset # Exit script on use of an undefined variable, same as "set -u" 91 | set -o errexit # Exit script when a command exits with non-zero status, same as "set -e" 92 | set -o pipefail # Makes pipeline return the exit status of the last command in the pipe that failed 93 | 94 | declare g_bInsideGitRepo=false 95 | declare g_bShowHelp=false 96 | declare -a g_aErrorMessages 97 | declare -i g_iExitCode=0 98 | declare -i g_iErrorCount=0 99 | 100 | readonly g_sBranchPrefix='split-file' 101 | readonly g_sColorDim=$(tput dim) 102 | readonly g_sColorRestore=$(tput sgr0) 103 | 104 | : readonly "${GIT_AUTHOR:=Potherca-Bot }" 105 | # ============================================================================== 106 | 107 | 108 | # ============================================================================== 109 | # UTILITY FUNCTIONS 110 | # ============================================================================== 111 | # ============================================================================== 112 | # Store given message in the ErrorMessage array 113 | # ------------------------------------------------------------------------------ 114 | error() { 115 | if [[ ! -z "${2:-}" ]];then 116 | g_iExitCode=${2} 117 | elif [[ "${g_iExitCode}" -eq 0 ]];then 118 | g_iExitCode=64 119 | fi 120 | 121 | g_iErrorCount=$((g_iErrorCount+1)) 122 | 123 | g_aErrorMessages[${g_iErrorCount}]="${1}\n" 124 | 125 | return ${g_iExitCode}; 126 | } 127 | # ============================================================================== 128 | 129 | # ============================================================================== 130 | printMessage() { 131 | # ------------------------------------------------------------------------------ 132 | echo -e "# ${*}" >&1 133 | } 134 | # ============================================================================== 135 | 136 | # ============================================================================== 137 | # Output all given Messages to STDERR 138 | # ------------------------------------------------------------------------------ 139 | printErrorMessages() { 140 | echo -e "\nErrors occurred:\n\n ${*}" >&2 141 | } 142 | # ============================================================================== 143 | 144 | # ============================================================================== 145 | # ------------------------------------------------------------------------------ 146 | printStatus() { 147 | echo "-----> $*" 148 | } 149 | # ============================================================================== 150 | 151 | # ============================================================================== 152 | # ------------------------------------------------------------------------------ 153 | printTopic() { 154 | echo 155 | echo "=====> $*" 156 | } 157 | # ============================================================================== 158 | 159 | # ============================================================================== 160 | # Usage: 161 | # Displays all lines in main script that start with '##' 162 | # ------------------------------------------------------------------------------ 163 | shortUsage() { 164 | grep '^##' <"$0" | cut -c4- 165 | } 166 | # ============================================================================== 167 | 168 | 169 | # ============================================================================== 170 | # Usage: 171 | # Displays all lines in main script that start with '#/' 172 | # ------------------------------------------------------------------------------ 173 | fullUsage() { 174 | grep '^#/' <"$0" | cut -c4- 175 | 176 | shortUsage 177 | } 178 | # ============================================================================== 179 | 180 | 181 | # ============================================================================== 182 | 183 | 184 | # ============================================================================== 185 | # Sets script variables based on input, when valid. 186 | # 187 | # The following variables will be set: 188 | # 189 | # - g_bInsideGitRepo 190 | # - g_sRootBranch 191 | # - g_bShowHelp 192 | # - g_sSourceBranch 193 | # - g_sSourceFileName 194 | # - g_sSourceFilePath 195 | # - g_sSplitDirectory 196 | # - g_sStrategy 197 | # - g_sTargetDirectory 198 | # 199 | # ------------------------------------------------------------------------------ 200 | handleParams() { 201 | local iDebugLevel sParam sRootFile sSplitDirectory 202 | 203 | iDebugLevel=0 204 | 205 | for sParam in "$@";do 206 | if [[ "${sParam}" = "--help" ]];then 207 | g_bShowHelp=true 208 | elif [[ "${sParam}" = "--verbose" || "${sParam}" = "-v" ]];then 209 | iDebugLevel=1 210 | elif [[ "${sParam}" = "-vv" ]];then 211 | iDebugLevel=2 212 | elif [[ "${sParam}" = "-vvv" ]];then 213 | iDebugLevel=2 214 | fi 215 | done 216 | 217 | readonly DEBUG_LEVEL="${iDebugLevel}" 218 | 219 | if [[ "${g_bShowHelp}" = false && "$#" -lt 4 ]];then 220 | g_iExitCode=65 221 | error 'This script expects four command-line arguments' 222 | elif [[ "${g_bShowHelp}" = false ]];then 223 | 224 | sRootFile=$(readlink -f "${1}") 225 | sSplitDirectory=$(readlink -f "${2}") 226 | readonly g_sTargetDirectory=$(readlink -f "${3}") 227 | readonly g_sStrategy="${4}" 228 | 229 | if [[ ! -f "${sRootFile}" ]];then 230 | g_iExitCode=66 231 | error "The given root file '${1}' does not exist" 232 | else 233 | readonly g_sSourceFilePath="${sRootFile}" 234 | readonly g_sSourceFileName=$(basename "${g_sSourceFilePath}") 235 | 236 | # shellcheck disable=SC2086 237 | if [[ "$(git status ${g_sSourceFilePath} > /dev/null 2>&1 || echo '1')" ]];then 238 | g_iExitCode=67 239 | error "The given split file '${g_sSourceFilePath}' is not part of a git repository" 240 | else 241 | g_bInsideGitRepo=true 242 | readonly g_sRootBranch=$(getCurrentBranch) 243 | readonly g_sSourceBranch="${g_sBranchPrefix}_${g_sSourceFileName}" 244 | fi 245 | fi 246 | 247 | if [[ ! -e "${sSplitDirectory}" ]];then 248 | g_iExitCode=68 249 | error "The given split directory '${2}' does not exist" 250 | elif [[ ! -d "${sSplitDirectory}" ]];then 251 | g_iExitCode=69 252 | error "The given split directory '${2}' is not a directory" 253 | else 254 | readonly g_sSplitDirectory="${sSplitDirectory}" 255 | fi 256 | 257 | if [[ "${g_sStrategy}" != 'DELETE' && "${g_sStrategy}" != 'MOVE' ]];then 258 | g_iExitCode=71 259 | error "The given split strategy '${g_sStrategy}' is not one of supported DELETE | MOVE" 260 | fi 261 | fi 262 | 263 | return ${g_iExitCode} 264 | } 265 | # ============================================================================== 266 | 267 | # ############################################################################## 268 | # UTILITY FUNCTIONS 269 | # ############################################################################## 270 | printDebug() { 271 | local aCaller 272 | 273 | if [[ "${DEBUG_LEVEL}" -gt 0 && "${DEBUG_LEVEL}" -lt 5 ]];then 274 | aCaller=($(caller)) 275 | printf "${g_sColorDim}[DEBUG] (line %04d): %s${g_sColorRestore}\n" "${aCaller[0]}" "$*" >&2 276 | fi 277 | } 278 | 279 | getCurrentBranch() { 280 | git rev-parse --abbrev-ref HEAD 281 | } 282 | 283 | commit() { 284 | printStatus 'Creating commit' 285 | git commit --author="${GIT_AUTHOR}" --message="${1}." 286 | } 287 | 288 | git_merge() { 289 | 290 | local -r sBranch="${1?One parameter required: [merge-strategy]}" 291 | local -r sMergeStrategy="${2:-}" 292 | 293 | if [[ "${sMergeStrategy}" == '' ]];then 294 | git merge --no-ff --no-edit "${sBranch}" 295 | else 296 | git merge --no-ff --no-edit -X "${sMergeStrategy}" "${sBranch}" 297 | fi 298 | 299 | git commit --amend --author="${GIT_AUTHOR}" --no-edit 300 | } 301 | 302 | createBranch() { 303 | local sBranchName sStartBranch 304 | 305 | sBranchName="${1}" 306 | sStartBranch="${2}" 307 | 308 | #git checkout -b "${sBranchName}" "${sStartBranch}" 309 | git branch "${sBranchName}" "${sStartBranch}" 310 | } 311 | 312 | createSourceBranch() { 313 | printTopic 'Creating separate branch to merge split files back into' 314 | createBranch "${g_sSourceBranch}" "${g_sRootBranch}" 315 | } 316 | 317 | createBranchName() { 318 | local sFile 319 | 320 | sFile=$(basename "${1}") 321 | 322 | echo "${g_sSourceBranch}_${sFile}" 323 | } 324 | 325 | createSplitBranch() { 326 | printStatus "Creating separate branch to split file '${1}'" 327 | createBranch "$(createBranchName "${1}")" "${g_sSourceBranch}" 328 | } 329 | 330 | checkoutBranch() { 331 | printStatus "Switching to ${2} branch" 332 | git checkout "${1}" 333 | } 334 | 335 | checkoutSplitBranch() { 336 | local sBranchName sFile 337 | 338 | sFile="${1}" 339 | 340 | sBranchName=$(createBranchName "${sFile}") 341 | 342 | checkoutBranch "${sBranchName}" 'split' 343 | } 344 | 345 | checkoutRootBranch() { 346 | checkoutBranch "${g_sRootBranch}" 'root' 347 | } 348 | 349 | checkoutSourceBranch() { 350 | checkoutBranch "${g_sSourceBranch}" 'source' 351 | } 352 | 353 | mergeSplitBranch() { 354 | local sBranchName sFile 355 | local -i iResult=0 356 | sFile="${1}" 357 | 358 | sBranchName=$(createBranchName "${sFile}") 359 | 360 | printTopic "Merging branch '${sBranchName}' back into '$(getCurrentBranch)'" 361 | 362 | # shellcheck disable=SC2086 363 | if [[ -n "$(git show-ref refs/heads/${sBranchName})" ]];then 364 | printStatus "Branch '${sBranchName}' exists" 365 | 366 | ( 367 | git_merge "${sBranchName}" 'theirs' && printStatus 'No merge conflict' 368 | ) || ( 369 | printStatus 'Merge conflict occurred. Attempting to resolve.' 370 | git add -- "${g_sSourceFilePath}" \ 371 | && commit "Merging split file '${g_sSourceFileName}'" 372 | ) || ( 373 | printStatus 'Merge conflict remains. Attempting to resolve more aggressively.' 374 | git add $(git status | grep -o -E 'added by us: .*' | cut -d ':' -f 2) \ 375 | && commit "Merging split file '${g_sSourceFileName}'" 376 | ) 377 | else 378 | printStatus "Branch does not exist. No need to merge" 379 | fi 380 | } 381 | 382 | renameFile() { 383 | local sFile 384 | 385 | sFile="${1}" 386 | 387 | if [[ ! -f "${g_sSourceFilePath}" ]];then 388 | printStatus "File '${g_sSourceFilePath}' does not exist. Checking out from '${g_sRootBranch}'" 389 | git checkout "${g_sRootBranch}" -- "${g_sSourceFilePath}" 390 | fi 391 | 392 | if [[ ! -d "${g_sTargetDirectory}" ]];then 393 | printStatus "Target directory '${g_sTargetDirectory}' does not exist" 394 | printStatus "Creating target directory '${g_sTargetDirectory}'" 395 | mkdir -p "${g_sTargetDirectory}" 396 | fi 397 | 398 | if [[ "${sFile}" = "${g_sSourceFileName}" ]];then 399 | printStatus "File is root file '${g_sSourceFileName}', no need to rename" 400 | else 401 | printStatus "Creating separate file for '${sFile}'" 402 | git mv "${g_sSourceFilePath}" "${g_sTargetDirectory}/${sFile}" 403 | commit "Adds separate file for '${sFile}'" 404 | fi 405 | } 406 | 407 | commitFileContent() { 408 | local sFile sMessage sTargetFile 409 | 410 | sFile="${1}" 411 | 412 | if [[ "${sFile}" = "${g_sSourceFileName}" ]];then 413 | printStatus "Writing content to source file '${g_sSourceFileName}'" 414 | sMessage="Removes content that has been split of from '${sFile}'" 415 | sTargetFile="${g_sSourceFilePath}" 416 | else 417 | printStatus "Writing content to target file '${g_sTargetDirectory}/${sFile}'" 418 | sMessage="Changes content in separated file '${sFile}'" 419 | sTargetFile="${g_sTargetDirectory}/${sFile}" 420 | fi 421 | 422 | cat "${g_sSplitDirectory}/${sFile}" > "${sTargetFile}" 423 | git add "${sTargetFile}" 424 | commit "${sMessage}" 425 | } 426 | 427 | createSubBranches() { 428 | local sFile 429 | 430 | printTopic 'Creating sub-branches' 431 | for sFile in "${g_sSplitDirectory}/"*;do 432 | # if [[ "${sFile}" = "${g_sSourceFileName}" && "${g_sStrategy}" != "MOVE" ]];then 433 | # printStatus "Skipping branch for source file '${g_sSourceFileName}'" 434 | # else 435 | createSplitBranch "${sFile}" 436 | # fi 437 | done 438 | } 439 | 440 | splitFiles() { 441 | local sFile sFileName 442 | 443 | for sFile in "${g_sSplitDirectory}/"*;do 444 | sFileName=$(basename "${sFile}") 445 | if [[ "${sFileName}" = "${g_sSourceFileName}" ]];then 446 | printTopic "Skipping source file '${g_sSourceFileName}'" 447 | else 448 | printTopic "Running split processing for file '${sFile}'" 449 | 450 | printDebug "sFile = ${sFile}" 451 | printDebug "sFileName = ${sFileName}" 452 | 453 | checkoutSplitBranch "${sFile}" 454 | renameFile "${sFileName}" 455 | commitFileContent "${sFileName}" 456 | fi 457 | done 458 | } 459 | 460 | mergeSplitBranches() { 461 | local sFile 462 | 463 | printTopic 'Merging all the split branches into the source branch' 464 | 465 | checkoutSourceBranch 466 | 467 | for sFile in "${g_sSplitDirectory}/"*;do 468 | if [[ "$(basename ${sFile})" = "$(basename ${g_sSourceFileName})" ]];then 469 | printTopic "Skipping source file '${g_sSourceFileName}'" 470 | else 471 | printTopic "Running merge processing for file '${sFile}'" 472 | mergeSplitBranch "${sFile}" 473 | fi 474 | done 475 | 476 | printTopic 'All file-split branches have been merged into the main split branch' 477 | } 478 | 479 | runCleanup() { 480 | local sBranchName sFile 481 | 482 | if [[ "${g_sSourceBranch:-}" && "${g_sSplitDirectory:-}" ]];then 483 | read -n1 -p 'Cleanup all the things? (y/n) ' sContinue 484 | echo "" 485 | 486 | if [[ "${sContinue}" = 'y' ]];then 487 | printStatus 'Removing all the split branches that were created' 488 | 489 | if [[ ${g_bInsideGitRepo} = true && "${g_sRootBranch}" != "$(getCurrentBranch)" ]];then 490 | git merge --abort 491 | checkoutRootBranch 492 | fi 493 | 494 | git branch -D "${g_sSourceBranch}" 495 | 496 | for sFile in "${g_sSplitDirectory}/"*;do 497 | sBranchName=$(createBranchName "${sFile}") 498 | 499 | # shellcheck disable=SC2086 500 | if [[ -n "$(git show-ref refs/heads/${sBranchName})" ]];then 501 | # Branch exists 502 | git branch -D "${sBranchName}" 503 | fi 504 | done 505 | sBranchName=$(createBranchName "${g_sSourceFileName}") 506 | 507 | # shellcheck disable=SC2086 508 | if [[ -n "$(git show-ref refs/heads/${sBranchName})" ]];then 509 | # Branch exists 510 | git branch -D "${sBranchName}" 511 | fi 512 | 513 | else 514 | printStatus 'Leaving everything as-is.' 515 | fi 516 | fi 517 | 518 | printMessage '================================================================================' 519 | } 520 | 521 | printHeader() { 522 | printMessage " running $(basename $0)" 523 | printMessage " for source file ${g_sSourceFilePath}" 524 | printMessage " with source directory ${g_sSplitDirectory}" 525 | printMessage " to target directory ${g_sTargetDirectory}" 526 | printMessage " using split strategy ${g_sStrategy}" 527 | 528 | printDebug "g_sRootBranch = ${g_sRootBranch}" 529 | printDebug "g_sSourceBranch = ${g_sSourceBranch}" 530 | printDebug "g_sSourceFilePath = ${g_sSourceFilePath}" 531 | printDebug "g_sSourceFileName = ${g_sSourceFileName}" 532 | printDebug "g_sSplitDirectory = ${g_sSplitDirectory}" 533 | printDebug "g_sTargetDirectory = ${g_sTargetDirectory}" 534 | printDebug "g_sStrategy = ${g_sStrategy}" 535 | } 536 | 537 | run() { 538 | 539 | printHeader 540 | 541 | if [[ "${DEBUG_LEVEL}" -gt 0 ]];then 542 | printStatus "Debugging on - Debug Level : ${DEBUG_LEVEL}" 543 | fi 544 | 545 | read -n1 -p 'Does this look correct? (y/n) ' sContinue 546 | echo "" 547 | 548 | if [[ "${sContinue}" = 'y' ]];then 549 | createSourceBranch 550 | 551 | # Process all non-source files 552 | createSubBranches 553 | splitFiles 554 | mergeSplitBranches 555 | 556 | # Process the source file 557 | printTopic "Running split process for source file '${g_sSourceFileName}'" 558 | checkoutSourceBranch 559 | 560 | if [[ ${g_sStrategy} = 'MOVE' ]];then 561 | commitFileContent "${g_sSourceFileName}" 562 | mergeSplitBranch "${g_sSourceFileName}" 563 | elif [[ ${g_sStrategy} = 'DELETE' ]];then 564 | printStatus 'Nothing to do for DELETE as file has already been renamed.' 565 | # git rm "${g_sSourceFilePath}" 566 | # commit "Removes '${g_sSourceFilePath}' file that has been split." 567 | else 568 | error "Unsupported merge strategy '${g_sStrategy}'" 70 569 | fi 570 | 571 | printTopic "Merging source branch '${g_sSourceBranch}' into the root branch '${g_sRootBranch}'" 572 | checkoutRootBranch 573 | 574 | git_merge "${g_sSourceBranch}" 575 | else 576 | printMessage 'Aborting.' 577 | fi 578 | } 579 | 580 | finish() { 581 | if [[ ! "${bFinished:-}" ]];then 582 | 583 | readonly bFinished=true 584 | 585 | if [[ ! ${g_iExitCode} -eq 0 ]];then 586 | printErrorMessages "${g_aErrorMessages[*]}" 587 | 588 | if [[ ${g_iExitCode} -eq 65 ]];then 589 | shortUsage 590 | echo 'Call --help for more details' 591 | fi 592 | fi 593 | 594 | printDebug "Working Directory : $(pwd)" 595 | if [[ ${g_bInsideGitRepo} = true ]];then 596 | printDebug "Root branch : $g_sRootBranch" 597 | printDebug "Current branch : $(getCurrentBranch)" 598 | else 599 | printDebug "Not in a git repo" 600 | fi 601 | 602 | runCleanup 603 | 604 | printMessage 'Done.' 605 | fi 606 | 607 | exit ${g_iExitCode} 608 | } 609 | 610 | debugTrapMessage() { 611 | printDebug "${g_sColorDim}[${1}:${2}] ${3}${g_sColorRestore}" 612 | } 613 | 614 | registerTraps() { 615 | trap finish EXIT 616 | trap finish ERR 617 | } 618 | 619 | registerDebugTrap() { 620 | if [[ "${DEBUG_LEVEL}" -gt 1 && "${DEBUG_LEVEL}" -lt 5 ]];then 621 | # Trap function is defined inline so we get the correct line number 622 | #trap '(echo -e "#[DEBUG] [$(basename ${BASH_SOURCE[0]}):${LINENO[0]}] ${BASH_COMMAND}");' DEBUG 623 | trap '(debugTrapMessage "$(basename ${BASH_SOURCE[0]})" "${LINENO[0]}" "${BASH_COMMAND}");' DEBUG 624 | fi 625 | } 626 | # ============================================================================== 627 | 628 | 629 | # ============================================================================== 630 | # RUN LOGIC 631 | # ------------------------------------------------------------------------------ 632 | git-split-file() { 633 | export PS4='$(printf "%04d: " $LINENO)' 634 | 635 | registerTraps 636 | 637 | handleParams "${@}" 638 | 639 | registerDebugTrap 640 | 641 | if [[ "${DEBUG_LEVEL}" -gt 2 ]];then 642 | set -o xtrace # Similar to -v, but expands commands, same as "set -x" 643 | fi 644 | 645 | if [[ ${g_iExitCode} -eq 0 ]];then 646 | 647 | if [[ "${g_bShowHelp}" = true ]];then 648 | fullUsage 649 | else 650 | run 651 | fi 652 | fi 653 | } 654 | 655 | if [ "${BASH_SOURCE[0]}" != "$0" ]; then 656 | export -f git-split-file 657 | else 658 | git-split-file "${@}" 659 | exit $? 660 | fi 661 | # ============================================================================== 662 | 663 | #EOF 664 | --------------------------------------------------------------------------------