├── .gitignore ├── LICENSE ├── README.md ├── completion.bash ├── completion.fish ├── completion.zsh ├── gec.sh └── sample.png /.gitignore: -------------------------------------------------------------------------------- 1 | # IDE 2 | .idea/ 3 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # gec 2 | 3 | **`gec`** is a command-line utility written in Bash with convenience commands for using [gocryptfs](https://github.com/rfjakob/gocryptfs) with git, specifically with GitHub. 4 | It refrains from doing anything clever, making it possible to naively fallback to the underlying gocryptfs or git commands if a need should arise. 5 | 6 | It transparently uses data encryption, both at rest and on the remotes. It uses version control and leverages redundant remote storage. 7 | The implemented remote commands require GitHub. Git users will be at home with it. 8 | 9 | > **:warning: Before continuing, save the link to the official [Gitee mirror](https://gitee.com/impredicative/gec) of this repo.** 10 | 11 | ## Contents 12 | * [Screenshot](#screenshot) 13 | * [Links](#links) 14 | * [Limitations](#limitations) 15 | * [Requirements](#requirements) 16 | * [Installation](#installation) 17 | * [Development](#development) 18 | * [Setup](#setup) 19 | * [Directories](#directories) 20 | * [Workflow](#workflow) 21 | * [Commands](#commands) 22 | * [Migration](#migration) 23 | 24 | ## Screenshot 25 | ![](sample.png) 26 | 27 | ## Links 28 | | Caption | Link | 29 | |-----------|-----------------------------------------------| 30 | | Repo | https://github.com/impredicative/gec | 31 | | Changelog | https://github.com/impredicative/gec/releases | 32 | | Mirror | https://gitee.com/impredicative/gec | 33 | 34 | ## Limitations 35 | The known applicable size limits for [GitHub](https://stackoverflow.com/a/59479166/) is tabulated below. 36 | If a hard limit is violated during a `commit`, `gec` will attempt to check it and error early, otherwise a `push` will fail. 37 | 38 | | Size of | SI Value | Type | Enforcer | Action by `gec` | 39 | |---------|-----------------------|------|----------|-----------------| 40 | | File | 100M | Hard | GitHub | Error | 41 | | Push | 2G | Hard | GitHub | Error | 42 | | Repo | 5G | Soft | GitHub | Warning | 43 | | Repo | 100G (*presumed*) | Hard | GitHub | Error | 44 | 45 | Due to the use of the gocryptfs `-sharedstorage` option, a hardlink cannot be created in a decrypted repo. 46 | 47 | ## Requirements 48 | Linux is required, along with a few tools which are covered in the [**Installation**](#installation) section. 49 | 50 | A dedicated [GitHub](https://github.com/) account is required. 51 | If using Firefox, the [Multi-Account Containers](https://addons.mozilla.org/en-US/firefox/addon/multi-account-containers/) add-on can be very useful to separate them from your primary accounts on these sites. 52 | 53 | ## Installation 54 | 55 | ### Linux 56 | These steps were tested on Ubuntu. On other distros, ensure that the executables are available in the PATH. 57 | 58 | Ensure `curl` ≥7.74.0, `git` ≥2.25.1, [`jq`](https://github.com/stedolan/jq/releases) ≥1.5: 59 | ```shell 60 | sudo apt install curl git jq 61 | ``` 62 | 63 | Install [`gocryptfs`](https://github.com/rfjakob/gocryptfs/releases) ≥2.2.1: 64 | ```shell 65 | # Install on amd64: 66 | RELEASE=$(curl https://api.github.com/repos/rfjakob/gocryptfs/releases | jq -r .[0].tag_name) 67 | wget -qO- https://github.com/rfjakob/gocryptfs/releases/download/${RELEASE}/gocryptfs_${RELEASE}_linux-static_amd64.tar.gz | sudo tar -xz -f - -C /usr/local/sbin/ gocryptfs gocryptfs-xray 68 | 69 | # Install on arm64 on Ubuntu: 70 | sudo apt install gocryptfs 71 | ``` 72 | 73 | Install [`git-sizer`](https://github.com/github/git-sizer/releases) ≥1.3.0: 74 | ```shell 75 | # Install on amd64: 76 | VERSION=$(curl https://api.github.com/repos/github/git-sizer/releases | jq -r .[0].tag_name | tr -d v) 77 | wget -qO- https://github.com/github/git-sizer/releases/download/v${VERSION}/git-sizer-${VERSION}-linux-amd64.zip | sudo busybox unzip - git-sizer -d /usr/local/sbin/ 78 | sudo chmod +x /usr/local/sbin/git-sizer 79 | 80 | # Install on arm64 on Ubuntu: 81 | sudo apt install git-sizer 82 | ``` 83 | 84 | Install `gec`: 85 | ```shell 86 | # Install program 87 | RELEASE=$(curl https://api.github.com/repos/impredicative/gec/releases | jq -r .[0].tag_name) 88 | sudo wget https://raw.githubusercontent.com/impredicative/gec/${RELEASE}/gec.sh -O /usr/local/sbin/gec 89 | sudo chmod +x /usr/local/sbin/gec 90 | 91 | # Install completion script if using Bash on Linux: 92 | mkdir -p ~/.local/share/bash-completion/completions 93 | wget https://raw.githubusercontent.com/impredicative/gec/${RELEASE}/completion.bash -O ~/.local/share/bash-completion/completions/gec 94 | source ~/.local/share/bash-completion/completions/gec # This is automatic if bash-completion is installed, but can do manually for current terminal only. 95 | 96 | # Install completion script if using Fish on Linux: 97 | mkdir -p ~/.config/fish/completions 98 | wget https://raw.githubusercontent.com/impredicative/gec/${RELEASE}/completion.fish -O ~/.config/fish/completions/gec.fish 99 | source ~/.config/fish/completions/gec.fish # This is automatic, but can do manually for current terminal only. 100 | ``` 101 | For future updates to `gec`, running `gec install` will install its latest release. 102 | 103 | ## Development 104 | This section is for `gec` development only; it is not applicable for routine use. 105 | 106 | ```shell 107 | # Clone repo 108 | git clone git@github.com:impredicative/gec.git 109 | cd ./gec 110 | 111 | # Link program if on Linux 112 | sudo ln -s "${PWD}/gec.sh" /usr/local/sbin/gec 113 | ``` 114 | 115 | ## Setup 116 | In the steps below, `` refers to a username in GitHub. 117 | 118 | On each device: 119 | 1. Run `gec config core.owner ` once for all future repos. 120 | 2. Run `ssh-keygen -f ~/.ssh/id_gec` once to create a new SSH key. Optionally use and securely save a passphrase for this key to minimize the risk of any unauthorized push. 121 | 3. Add the `~/.ssh/id_gec.pub` file for the key created above into the `` account in GitHub. 122 | 4. Create or prepend (not append) to `~/.ssh/config` the specific contents: 123 | ```shell 124 | Match host github.com exec "[[ $(git config user.name) = gec ]]" 125 | IdentityFile ~/.ssh/id_gec 126 | ``` 127 | 5. Run `chmod go-rw ~/.ssh/config` to tighten permissions of the file as is advised in `man ssh_config`. 128 | 6. Run `gec test.ssh` to test GitHub access via SSH, ensuring that the `` name is printed for both. 129 | 7. Run `gec test.token` to test GitHub access via a personal access token for each. 130 | The GitHub token must have access to the `repo` and `delete_repo` scopes. 131 | 132 | ## Directories 133 | Storage repos are created in `~/gec/`. This location is created automatically. Both encrypted and decrypted repos and their files are organized in this location. 134 | Although this location is not currently configurable, a softlink or hardlink can be used to redirect it elsewhere if needed. 135 | 136 | For each repo, these directories are created and used: 137 | 138 | | Location | Description | 139 | |-------------------------------|-----------------------------------------------| 140 | | `~/gec/encrypted/` | git repo contents | 141 | | `~/gec/encrypted//.git` | .git directory of git repo | 142 | | `~/gec/encrypted//fs` | encrypted filesystem contents within git repo | 143 | | `~/gec/decrypted/` | decrypted filesystem mountpoint | 144 | 145 | ## Workflow 146 | 147 | To create and provision a new repo: 148 | * `gec init ` 149 | * `gec use ` 150 | * `touch .Trash-${UID}` (_Avoids deleting files to Trash on Ubuntu_) 151 | 152 | To provision an existing repo: 153 | * `gec clone ` 154 | 155 | To use a provisioned repo, these are some of the many commands: 156 | * `gec pull []` (_If and when changed on remote_) 157 | * `gec use []` (_Remember to `exit` the shell after using_) 158 | * `gec status []` 159 | * `gec done "a non-secret commit message"` (_If files changed_) 160 | * `gec umount ` 161 | 162 | Refer to the [repo-specific commands](#repo-specific) section for details on using the commands in the workflows above. 163 | 164 | ## Commands 165 | ### Repo-agnostic 166 | * **`config []`**: Get or set a value of key from configuration file `~/.gec`. To list all values, specify `-l`. 167 | * **`install []`**: Update to the named or latest release of `gec`. 168 | * **`list`**: Alias of `ls`. 169 | * **`ls [pattern]`**: List the output of the `state` command for matching repos in `~/gec/encrypted`. If specifying a pattern, it may need to be quoted. 170 | * **`lock`**: Unmount all mounted repos. 171 | * **`test.ssh`**: Test access to GitHub via SSH. 172 | * **`test.token`**: Test access to GitHub via a personal access token for each. 173 | 174 | ### Repo-specific 175 | In the commands below, `` refers to an identical repository name, e.g. "travel-ak", in GitHub. 176 | It can be auto-determined if a command is run from its encrypted or decrypted directory. 177 | When it can be auto-determined, to disambiguate a command's arguments that follow, it can alternatively be specified as a period. 178 | 179 | The minimally relevant repo-specific commands are listed in the [**Workflow**](#workflow) section. 180 | 181 | #### Informational 182 | * **`check.dec []`**: Check decrypted file sizes. Error if a size limit is exceeded. The repo must be in a mounted state. 183 | It is run automatically by `commit` when needed if mounted. 184 | * **`check.git []`**: Check encrypted file sizes, and use `git-sizer` to check the size of the git repo. Error if a size limit is exceeded. 185 | It is run automatically by `commit` when needed. 186 | * **`du []`**: Print the human-friendly disk usage of the git repo directory for a depth of one. 187 | * **`du.dec []`**: Print the human-friendly disk usage of the decrypted directory for a depth of one. The repo must be in a mounted state. 188 | * **`du.enc []`**: Print the human-friendly disk usage of the encrypted filesystem directory for a depth of one. 189 | * **`info []`**: Alias of `status`. 190 | * **`log [] [options]`**: Print the git log for the last ten commits. Options, if any, are forwarded to `git log`. 191 | If specifying any options, to auto-determine ``, specify a period in its place. 192 | * **`logs []`**: Alias of `log`. 193 | * **`state []`**: Print the repo mount state, .git directory disk usage, encrypted filesystem directory disk usage, total disk usage, and repo name. 194 | * **`status []`**: Print the repo name, mount state, and short git status. If mounted, also print the change status of decrypted paths plus the mount information. 195 | 196 | #### Remote oriented 197 | A [GitHub token](https://github.com/settings/tokens/new) is required for these commands. 198 | For your security, the tokens are not saved by `gec`. 199 | * **`create `**: Idempotently create the repo in GitHub. 200 | The required GitHub token must have access to the `repo` scope. 201 | * **`del []`**: Delete an existing repo in GitHub. 202 | The required GitHub token must have access to their `delete_repo` and `repository:delete` scopes respectively. 203 | Also see the `rm` and `destroy` commands. 204 | 205 | #### git oriented 206 | * **`amend [] [""]`**: Add and amend all changes to most recent commit. If `` is not specified, it is kept unchanged. `` is not encrypted. 207 | To auto-determine ``, specify a period in its place. 208 | * **`clone `**: Clone and configure a preexisting repo from GitHub into its git repo directory. 209 | * **`commit ""`**: Add and commit all changes. `` is not encrypted. To auto-determine ``, specify a period in its place. 210 | * **`gc [] [options]`**: Run git garbage collection on the repo. Options, if any, are forwarded to `git gc`. 211 | If specifying any options, to auto-determine ``, specify a period in its place. 212 | * **`pull []`**: Pull commits from remote. For safety, only a fast-forward pull is made, and a prerequisite is that the repo must be in a dismounted state. 213 | * **`push []`**: Push commits to remote. 214 | * **`reset.url []`**: Update the locally configured remote URLs for the repo to the expected one for GitHub, removing all other URLs. 215 | * **`send ""`**: (`commit`+`push`) Add, commit, and push all changes. `` is not encrypted. To auto-determine ``, specify a period in its place. 216 | Also see the `done` command. 217 | 218 | #### gocryptfs oriented 219 | * **`dismount`**: Alias of `umount`. 220 | * **`init.fs []`**: Initialize the encrypted filesystem for an empty repo. No commit or push is made. A new password is requested. 221 | The password and a printed master key must be securely saved. 222 | * **`mount []`**: Mount a repo in read-write mode into its decrypted mountpoint if not already mounted as such. Also see the `use` command. 223 | * **`mount.ro []`**: Mount a repo in read-only mode into its decrypted mountpoint if not already mounted as such. Also see the `use.ro` command. 224 | * **`mount.rw`**: Alias of `mount`. Also see the `use.rw` command. 225 | * **`umount [] [-f]`**: Unmount a repo if it is mounted. To force an unmount, specify `-f`. 226 | * **`unmount`**: Alias of `umount`. 227 | 228 | #### System 229 | * **`rm `**: Interactively remove all local directories of the repo. Also see the `del` and `destroy` commands. 230 | * **`shell []`**: Provide a shell into the git repo directory. 231 | * **`shell.dec []`**: Provide a shell into the decrypted mountpoint of a mounted repo. 232 | * **`shell.enc []`**: Provide a shell into the encrypted filesystem directory. 233 | 234 | #### Compound 235 | * **`init `**: (`create`+`clone`+`init.fs`+`send`) Create new repo remotely, clone it locally, initialize encrypted filesystem, commit, and push. 236 | A new password is requested. The password and a printed master key must be securely saved. 237 | The required GitHub token must have access to the `repo` scope. 238 | * **`destroy `**: (`rm`+`del`) Interactively remove all local repo directories, and delete repo from GitHub. 239 | * **`done ""`**: (`check.dec`+`umount`+`send`) Add, commit, and push all changes. Unmount repo if mounted. `` is not encrypted. 240 | To auto-determine ``, specify a period in its place. 241 | * **`rename `**: Rename repo remotely and locally, and update its locally configured remotes. The repo must be in a dismounted state. 242 | The new name must not already be in use. 243 | The required GitHub token must have access to their `repo` and `repository:admin` scopes respectively. 244 | After renaming, remember to store the password for the repo under its new name. 245 | * **`use []`**: (`mount`+`shell.dec`) Mount read-write if not already mounted as such, and provide a shell into the decrypted mountpoint. 246 | * **`use.ro []`**: (`mount.ro`+`shell.dec`) Mount read-only if not already mounted as such, and provide a shell into the decrypted mountpoint. 247 | * **`use.rw`**: Alias of `use`. 248 | 249 | ## Migration 250 | To migrate from v0.5, for each local repo, run this sequence once: 251 | 252 | ```shell 253 | gec shell # Enters repo shell 254 | gec reset.url # Ensures GitHub remote and removes obsolete remotes. 255 | exit # Exits repo shell. 256 | ``` -------------------------------------------------------------------------------- /completion.bash: -------------------------------------------------------------------------------- 1 | _gec_completion() 2 | { 3 | if [ $COMP_CWORD -eq 1 ]; then 4 | COMPREPLY=($(compgen -W "$(gec _list_commands)" "${COMP_WORDS[1]}")) 5 | elif [ $COMP_CWORD -eq 2 ]; then 6 | COMPREPLY=($(compgen -W "$(gec _list_repos)" "${COMP_WORDS[2]}")) 7 | fi 8 | } 9 | 10 | complete -F _gec_completion gec 11 | 12 | # References: 13 | # https://iridakos.com/programming/2018/03/01/bash-programmable-completion-tutorial 14 | # https://www.gnu.org/software/bash/manual/bash.html#Programmable-Completion 15 | # https://github.com/scop/bash-completion/blob/master/README.md 16 | # https://serverfault.com/questions/506612/ 17 | # https://askubuntu.com/questions/68175/ 18 | # https://stackoverflow.com/questions/39624071/ 19 | -------------------------------------------------------------------------------- /completion.fish: -------------------------------------------------------------------------------- 1 | function __gec_needs_commands 2 | return ([ (count (commandline -opc)) -eq 1 ]) 3 | end 4 | 5 | function __gec_needs_repos 6 | return ([ (count (commandline -opc)) -eq 2 ]) 7 | end 8 | 9 | function __gec_needs_nothing 10 | return ([ (count (commandline -opc)) -ge 3 ]) 11 | end 12 | 13 | complete -f -c gec -n "__gec_needs_commands" -a "(gec _list_commands)" 14 | complete -f -c gec -n "__gec_needs_repos" -a "(gec _list_repos)" 15 | complete -f -c gec -n "__gec_needs_nothing" 16 | 17 | # References: 18 | # https://fishshell.com/docs/current/index.html#writing-your-own-completions 19 | # https://stackoverflow.com/questions/16657803/ 20 | # https://stackoverflow.com/questions/20838284/ 21 | -------------------------------------------------------------------------------- /completion.zsh: -------------------------------------------------------------------------------- 1 | #compdef gec 2 | 3 | _gec_completion() { 4 | case $CURRENT in 5 | 2) 6 | _values 'command' $(gec _list_commands) 7 | ;; 8 | 3) 9 | _values 'repo' $(gec _list_repos) 10 | ;; 11 | *) 12 | ;; 13 | esac 14 | } 15 | 16 | compdef _gec_completion gec 17 | -------------------------------------------------------------------------------- /gec.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -euo pipefail # Note the use of `set` elsewhere in the file. 3 | 4 | # Define repo-agnostic vars 5 | TOOL="$(basename "$0")" 6 | TPUT_BOLD=$(tput bold) 7 | TPUT_RED=$(tput setaf 1) 8 | TPUT_GREEN=$(tput setaf 2) 9 | TPUT_YELLOW=$(tput setaf 3) 10 | TPUT_BLUE=$(tput setaf 4) 11 | TPUT_MAGENTA=$(tput setaf 5) 12 | TPUT_CYAN=$(tput setaf 6) 13 | TPUT_WHITE=$(tput setaf 7) 14 | TPUT_RESET=$(tput sgr0) 15 | 16 | # Define repo-agnostic logging functions 17 | logr () { echo "[${TOOL}] ${1}" ; } # Log raw 18 | log () { logr "${1}." ; } # Log 19 | logn () { echo; log "$1" ; } # Log after newline 20 | loge () { log "Error: $1" >&2 ; } # Log error 21 | logw () { log "warning: $1" >&2 ; } # Log warning 22 | 23 | # Define additional repo-agnostic vars 24 | if [ "$#" -ge 1 ]; then 25 | CMD="$1" 26 | else 27 | loge "Provide a command as a positional argument" 28 | exit 1 29 | fi 30 | CONFIGFILE="${HOME}/.gec" 31 | _APPDIR="${HOME}/gec" 32 | _GITDIR="${_APPDIR}/encrypted" 33 | _DECDIR="${_APPDIR}/decrypted" 34 | _SOCKDIR="/run/user/${UID}/gec" 35 | LS_FORMAT="all=${TPUT_CYAN}%4s${TPUT_RESET} enc=${TPUT_MAGENTA}${TPUT_BOLD}%4s${TPUT_RESET} .git=${TPUT_CYAN}${TPUT_BOLD}%4s${TPUT_RESET} %s ${TPUT_BLUE}${TPUT_BOLD}%s${TPUT_RESET}\n" 36 | 37 | touch -a "${CONFIGFILE}" 38 | 39 | # Define repo-agnostic utility functions 40 | _contains () { # Space-separated list $1 contains line $2. `grep -x` enforces an exact match. 41 | echo "$1" | tr ' ' '\n' | grep -F -x -q "$2" 42 | } 43 | _du_hs () { # Disk usage for single match 44 | # Note: Using -h is avoided because it returns variable length output such as 1002M and 402M. 45 | du -B1 -s "$@" | cut -f1 | numfmt --to=si 46 | } 47 | _du_hsc () { # Total disk usage for single or multiple matches 48 | # Note: Using -h is avoided because it returns variable length output such as 1002M and 402M. 49 | du -B1 -s -c "$@" | tail -1 | cut -f1 | numfmt --to=si 50 | } 51 | _du_hcd () { # CD and disk usage for depth of 1 52 | cd "$1" 53 | du -h -c -d 1 54 | } 55 | _shell () { # Shell into dir 56 | cd "$1" 57 | local user_shell=$(getent passwd $USER | cut -d : -f 7) 58 | $user_shell 59 | } 60 | min_num () { # Min of numbers 61 | # Ref: https://stackoverflow.com/a/25268449/ 62 | printf "%s\n" "$@" | sort -g | head -n1 63 | } 64 | 65 | # Run repo-agnostic command 66 | case "${CMD}" in 67 | _list_commands) # Used by completion script. 68 | echo "$(grep -Eo "^ [a-z\.]+[|)]" "$0" | tr -d ' |)')" 69 | exit 70 | ;; 71 | _list_repos) # Used by completion script. 72 | if [ -d "$_GITDIR" ]; then 73 | ls -1 "$_GITDIR" 74 | fi 75 | exit 76 | ;; 77 | config) 78 | shift 79 | git config -f "${CONFIGFILE}" "$@" 80 | exit 81 | ;; 82 | install) 83 | if [ "$#" -ge 2 ]; then 84 | release="$2" 85 | else 86 | release=$(curl -sS -f -H "Accept: application/vnd.github.v3+json" https://api.github.com/repos/impredicative/gec/releases | jq -r .[0].tag_name) 87 | fi 88 | source_file="https://raw.githubusercontent.com/impredicative/gec/${release}/gec.sh" 89 | dest_file="$0" 90 | # sudo wget -q "${source_file}" -O "${dest_file}" 91 | sudo curl -s -o "${dest_file}" "${source_file}" 92 | sudo chmod +x "${dest_file}" 93 | log "Installed ${release} from ${source_file} to ${dest_file}" 94 | exit 95 | ;; 96 | lock) 97 | mkdir -p "${_DECDIR}" 98 | log "Unmounting all mounted repos" 99 | if findmnt -t fuse.gocryptfs -n -o target | grep "^${_DECDIR}/" | xargs -I {} basename "{}" | xargs -I {} ${TOOL} umount {}; then 100 | # Note: grep returns nonzero exitcode if there are no matching lines. To force 0 exitcode, use { grep "^${_DECDIR}/" || :; } 101 | log "Unmounted all mounted repos" 102 | else 103 | log "No repo is mounted" 104 | fi 105 | # mkdir -p "${_GITDIR}" 106 | # cd "${_GITDIR}" 107 | # ls -1 | xargs -I {} ${TOOL} umount {} 108 | exit 109 | ;; 110 | ls|list) 111 | mkdir -p "${_GITDIR}" 112 | cd "${_GITDIR}" 113 | PATTERN=${2:-*} 114 | 115 | # Print individual state 116 | ls -1d ${PATTERN} | uniq | xargs -I {} ${TOOL} state {} 117 | 118 | # Print cumulative disk usage 119 | alldirs_size=$(_du_hsc ./${PATTERN}) 120 | encdirs_size=$(_du_hsc ./${PATTERN}/fs) 121 | gitdirs_size=$(_du_hsc ./${PATTERN}/.git) 122 | printf "${LS_FORMAT}" ${alldirs_size} ${encdirs_size} ${gitdirs_size} " " "(total)" 123 | exit 124 | ;; 125 | test.ssh) 126 | # Ref: https://stackoverflow.com/a/70585901/ 127 | log "Testing SSH access to GitHub" 128 | set +e 129 | ssh -i ~/.ssh/id_gec -T git@github.com # Expected exit status is 1. 130 | exit_status=$? 131 | set -e 132 | if [ ${exit_status} -ne 1 ] && [ ${exit_status} -ne 0 ]; then 133 | loge "GitHub SSH exit status was ${exit_status} but the expected status was 0 or 1" 134 | exit ${exit_status} 135 | fi 136 | log "GitHub SSH exit status was ${exit_status} as was expected" 137 | exit 138 | ;; 139 | test.token) 140 | read -p "GitHub token with access to 'repo' and 'delete_repo' scopes: " GITHUB_TOKEN 141 | logn "Testing token access to GitHub" 142 | # Ref: https://stackoverflow.com/a/70588035/ 143 | authorized_scopes=$(curl -sS -f -I -H "Authorization: token ${GITHUB_TOKEN}" https://api.github.com | grep ^x-oauth-scopes: | cut -d' ' -f2- | tr -d "[:space:]" | sed 's/,/ /g') 144 | logr "GitHub token has access to the scopes: ${authorized_scopes}" 145 | for required_scope in repo delete_repo; do 146 | if _contains "${authorized_scopes}" "${required_scope}"; then 147 | log "GitHub token has access to the required '${required_scope}' scope" 148 | else 149 | loge "GitHub token does not have access to the required '${required_scope}' scope" 150 | exit 11 151 | fi 152 | done 153 | exit 154 | ;; 155 | esac 156 | 157 | # Define repo-specific vars 158 | if [ "$#" -ge 2 ] && [ "$2" != '.' ]; then 159 | REPO="$2" 160 | else 161 | case "${PWD}"/ in 162 | ${_GITDIR}/*/*) REPO=$(realpath --relative-to="${_GITDIR}" "${PWD}" | cut -d/ -f1);; 163 | ${_DECDIR}/*/*) REPO=$(realpath --relative-to="${_DECDIR}" "${PWD}" | cut -d/ -f1);; 164 | *) 165 | loge "Failed to identify repo. Provide it as a positional argument or change to its directory" 166 | exit 1 167 | ;; 168 | esac 169 | fi 170 | GITDIR="${_GITDIR}/${REPO}" 171 | DOTGITDIR="${GITDIR}/.git" 172 | ENCDIR="${GITDIR}/fs" 173 | DECDIR="${_DECDIR}/${REPO}" 174 | SOCKFILE="${_SOCKDIR}/${REPO}.socket" 175 | 176 | # Define repo-specific logging functions 177 | logr () { echo "[${TOOL}:${REPO}] ${1}" ; } # Log raw 178 | logrn () { echo; logr "$1" ; } # Log raw after newline 179 | log () { logr "${1}." ; } # Log 180 | logn () { echo; log "$1" ; } # Log after newline 181 | loge () { log "Failed ${CMD}. $1" >&2 ; } # Log error 182 | logw () { log "warning: $1" >&2 ; } # Log warning 183 | 184 | # Define repo-specific utility functions 185 | _decrypt_paths () { # Decrypted gocryptfs paths 186 | # Note: The input paths are over stdin, and must be relative to ENCDIR. 187 | cat - | grep -v '/gocryptfs.diriv$' | gocryptfs-xray -decrypt-paths "${SOCKFILE}" 2>&- || : 188 | # Note: "|| :" is used because gocryptfs-xray sometimes outputs: "errno 2: no such file or directory" 189 | } 190 | 191 | # Validate repo name 192 | # Ref: https://stackoverflow.com/a/59082561/ 193 | repo_valid_pattern="^[a-zA-Z0-9_][a-zA-Z0-9_-]{0,99}$" 194 | if [[ ! "$REPO" =~ $repo_valid_pattern ]]; then 195 | loge "Repo name must match pattern ${repo_valid_pattern} so as to ensure broad compatibility" 196 | exit 1 197 | fi 198 | repo_invalid_pattern="--" 199 | if [[ "$REPO" =~ $repo_invalid_pattern ]]; then 200 | loge "Repo name must not match pattern ${repo_invalid_pattern} so as to ensure broad compatibility" 201 | exit 1 202 | fi 203 | 204 | # Validate repo existence 205 | # Ref: https://stackoverflow.com/a/64945650/ 206 | mkdir -p "${_GITDIR}" 207 | known_repos=$(ls -1 "${_GITDIR}") 208 | if _contains "${known_repos}" "${REPO}"; then 209 | if _contains "clone init" "${CMD}"; then 210 | loge "Repo already exists locally" 211 | exit 1 212 | fi 213 | else 214 | if ! _contains "clone create del init init.fs" "${CMD}"; then 215 | loge "Repo doesn't exist locally" 216 | exit 1 217 | fi 218 | fi 219 | 220 | # Run repo-specific command 221 | case "${CMD}" in 222 | amend) 223 | cd "${GITDIR}" 224 | 225 | log "Adding changes" 226 | git add -A 227 | 228 | if ! git diff-index --quiet @; then 229 | log "Added changes" 230 | # Ref: https://stackoverflow.com/a/34093391/ 231 | if [ "$#" -ge 3 ]; then 232 | COMMIT_MESSAGE="${3}" 233 | logr "Amending commit: ${COMMIT_MESSAGE}" 234 | git commit --amend -m "${COMMIT_MESSAGE}" 235 | logr "Amended commit: ${COMMIT_MESSAGE}" 236 | else 237 | COMMIT_MESSAGE=$(git log -1 --format=%s) 238 | logr "Amending commit: ${COMMIT_MESSAGE}" 239 | git commit --amend --no-edit 240 | logr "Amended commit: ${COMMIT_MESSAGE}" 241 | fi 242 | echo 243 | git log --color=always --decorate -1 | grep -v '^Author: ' 244 | else 245 | log "No changes to amend" 246 | fi 247 | ;; 248 | check.dec) 249 | if ! mountpoint -q "${DECDIR}"; then 250 | loge "Mount first" 251 | exit 3 252 | fi 253 | cd ${DECDIR} 254 | log "Checking decrypted file sizes" 255 | large_files=$(find -type f -size +100000000c -exec ls -lh --si '{}' \;) 256 | if [[ "$large_files" != "" ]]; then 257 | loge "The decrypted files listed below exceed GitHub's file size hard limit of 100M" 258 | echo "${large_files}" >&2 259 | exit 4 260 | fi 261 | log "Decrypted files sizes are not over GitHub's hard limit of 100M" 262 | ;; 263 | check.git) 264 | cd ${GITDIR} 265 | log "Checking sizes of git repo" 266 | 267 | # Check for large files 268 | large_files=$(find ./fs -type f -size +100000000c -exec ls -lh --si '{}' \;) 269 | if [[ "$large_files" != "" ]]; then 270 | loge "The encrypted files listed below exceed GitHub's file size hard limit of 100M" 271 | echo "${large_files}" >&2 272 | logr "To list the decrypted analogs of the above files, run: ${TOOL} check.dec ${REPO}" 273 | exit 4 274 | else 275 | log "Encrypted files sizes are not over GitHub's hard limit of 100M" 276 | fi 277 | 278 | git_sizer_json=$(git-sizer -j --json-version 2 --no-progress) 279 | 280 | # # Check approximation of largest file size using git-sizer 281 | # max_blob_size=$(echo "${git_sizer_json}" | jq '.maxBlobSize.value') 282 | # max_blob_size_fmt=$(numfmt --to=si $max_blob_size) 283 | # if (( $max_blob_size > 100000000 )); then 284 | # loge "Largest blob size of ${max_blob_size_fmt} is over GitHub's file size hard limit of 100M" 285 | # exit 4 286 | # else 287 | # log "Largest blob size of ${max_blob_size_fmt} is not over GitHub's file size hard limit of 100M" 288 | # fi 289 | # Note: This check is disabled because it is obsoleted by the previous check for large files. 290 | 291 | # Check approximation of total repo size using git-sizer 292 | repo_size=$(echo "${git_sizer_json}" | jq '.uniqueBlobSize.value+.uniqueTreeSize.value+.uniqueCommitSize.value') 293 | repo_size_fmt=$(numfmt --to=si $repo_size) 294 | if (( $repo_size > 100000000000 )); then 295 | loge "Repo size of ${repo_size_fmt} is over GitHub's presumed hard limit of 100G" 296 | exit 4 297 | else 298 | log "Repo size of ${repo_size_fmt} is not over GitHub's presumed hard limit of 100G" 299 | fi 300 | if (( $repo_size > 5000000000 )); then 301 | logw "Repo size of ${repo_size_fmt} is over GitHub's soft limit of 5G" 302 | else 303 | log "Repo size of ${repo_size_fmt} is not over GitHub's soft limit of 5G" 304 | fi 305 | 306 | # Check commit size using git-sizer if pre-commit repo size was given 307 | if (( $# >= 3 )); then 308 | pre_commit_repo_size="${3}" 309 | commit_size=$((repo_size-pre_commit_repo_size)) 310 | commit_size_fmt=$(numfmt --to=si $commit_size) 311 | if (( $commit_size > 2000000000 )); then 312 | loge "Commit size of ${commit_size_fmt} is over GitHub's push size hard limit of 2G" 313 | exit 4 314 | else 315 | log "Commit size of ${commit_size_fmt} is not over GitHub's push size hard limit of 2G" 316 | fi 317 | fi 318 | 319 | log "Checked sizes of git repo" 320 | ;; 321 | clone) 322 | log "Cloning and configuring repo" 323 | 324 | GITUSER=$(${TOOL} config core.owner) 325 | mkdir -p "${GITDIR}" && cd "$_" 326 | logn "Cloning repo from GitHub" 327 | git clone -c http.postBuffer=2147483648 -c user.name=gec -c user.email=gec@users.noreply.git.com git@github.com:${GITUSER}/${REPO}.git . 328 | log "Cloned repo from GitHub" 329 | 330 | logn "Cloned and configured repo" 331 | ;; 332 | commit) 333 | COMMIT_MESSAGE="${3:?'Provide a commit message as a positional argument.'}" 334 | cd "${GITDIR}" 335 | 336 | if mountpoint -q "${DECDIR}"; then 337 | ${TOOL} check.dec ${REPO} 338 | echo 339 | fi 340 | 341 | log "Adding changes" 342 | git add -A -v 343 | log "Added changes" 344 | 345 | if ! git diff-index --quiet @; then 346 | # Ref: https://stackoverflow.com/a/34093391/ 347 | 348 | logn "Committing changes" 349 | pre_commit_repo_size=$(git-sizer -j --json-version 2 --no-progress | jq '.uniqueBlobSize.value+.uniqueTreeSize.value+.uniqueCommitSize.value') 350 | git commit -m "${COMMIT_MESSAGE}" 351 | git log --color=always --decorate -1 | grep -v '^Author: ' 352 | log "Committed changes" 353 | 354 | logn "Running git garbage collection as necessary" 355 | git gc --auto 356 | log "Ran git garbage collection as necessary" 357 | 358 | echo 359 | ${TOOL} check.git ${REPO} ${pre_commit_repo_size} 360 | 361 | else 362 | log "No changes to commit" 363 | fi 364 | ;; 365 | create) 366 | GITUSER=$(${TOOL} config core.owner) 367 | log "Idempotently creating repo in GitHub" 368 | 369 | # Idempotently create GitHub repo 370 | read -p "GitHub token with access to 'repo' scope: " GITHUB_TOKEN 371 | # Ref: https://docs.github.com/en/rest/repos/repos#get-a-repository 372 | if curl -s -f -o /dev/null -H "Accept: application/vnd.github+json" -H "Authorization: token ${GITHUB_TOKEN}" "https://api.github.com/repos/${GITUSER}/${REPO}"; then 373 | log "Repo already exists in GitHub" 374 | else 375 | # Create GitHub repo 376 | # Ref: https://stackoverflow.com/a/64636218/ 377 | log "Creating repo in GitHub" 378 | curl -sS -f -X POST -o /dev/null \ 379 | -H "Authorization: token ${GITHUB_TOKEN}" -H "Accept: application/vnd.github.v3+json" \ 380 | https://api.github.com/user/repos -d "{\"name\": \"${REPO}\", \"private\": true}" 381 | log "Created repo in GitHub" 382 | fi 383 | 384 | logn "Idempotently created repo in GitHub" 385 | ;; 386 | del) 387 | GITUSER=$(${TOOL} config core.owner) 388 | log "Deleting repo from GitHub" 389 | 390 | # Delete GitHub repo 391 | # Ref: https://stackoverflow.com/a/30644156/ 392 | logn "Deleting repo in GitHub" 393 | read -p "GitHub token with access to 'delete_repo' scope: " GITHUB_TOKEN 394 | curl -sS -f -X DELETE -o /dev/null \ 395 | -H "Authorization: token ${GITHUB_TOKEN}" -H "Accept: application/vnd.github.v3+json" \ 396 | https://api.github.com/repos/${GITUSER}/${REPO} 397 | log "Deleted repo in GitHub" 398 | 399 | logn "Deleted repo from GitHub" 400 | ;; 401 | destroy) 402 | ${TOOL} rm ${REPO} 403 | ${TOOL} del ${REPO} 404 | ;; 405 | done) 406 | if mountpoint -q "${DECDIR}"; then 407 | echo 408 | ${TOOL} check.dec ${REPO} 409 | fi 410 | echo 411 | ${TOOL} umount ${REPO} 412 | echo 413 | ${TOOL} send ${REPO} "${@:3}" 414 | ;; 415 | du) 416 | _du_hcd "${GITDIR}" 417 | ;; 418 | du.dec) 419 | if mountpoint -q "${DECDIR}"; then 420 | _du_hcd "${DECDIR}" 421 | else 422 | loge "Mount first" 423 | exit 3 424 | fi 425 | ;; 426 | du.enc) 427 | _du_hcd "${ENCDIR}" 428 | ;; 429 | gc) 430 | cd ${GITDIR} 431 | shift $(min_num 2 $#) 432 | repo_size=$(_du_hs "${DOTGITDIR}") 433 | pack_size=$(_du_hs "${DOTGITDIR}/objects/pack") 434 | logr "Running git garbage collection having pre-gc sizes: .git=${repo_size} pack=${pack_size}" 435 | git gc "$@" 436 | repo_size=$(_du_hs "${DOTGITDIR}") 437 | pack_size=$(_du_hs "${DOTGITDIR}/objects/pack") 438 | logr "Ran git garbage collection having post-gc sizes: .git=${repo_size} pack=${pack_size}" 439 | ;; 440 | init) 441 | ${TOOL} create ${REPO} 442 | ${TOOL} clone ${REPO} 443 | ${TOOL} init.fs ${REPO} 444 | ${TOOL} send ${REPO} "Initialized" 445 | ;; 446 | init.fs) 447 | log "Initializing encrypted filesystem" 448 | mkdir -p "${ENCDIR}" 449 | gocryptfs -init "${ENCDIR}" 450 | mkdir -p "${DECDIR}" 451 | logn "Initialized encrypted filesystem" 452 | ;; 453 | log|logs) 454 | cd "${GITDIR}" 455 | shift $(min_num 2 $#) 456 | git log --color=always --decorate -10 "$@" | grep -v '^Author: gec $' 457 | ;; 458 | mount|mount.rw) 459 | if mountpoint -q "${DECDIR}"; then 460 | MOUNT_OPTION=$(findmnt -fn -o options "${DECDIR}" | cut -d, -f1) 461 | if [ "${MOUNT_OPTION}" = "rw" ]; then 462 | log "Repo is mounted read-write" 463 | else 464 | log "Repo is mounted but not read-write" 465 | ${TOOL} umount ${REPO} 466 | ${TOOL} mount ${REPO} 467 | fi 468 | else 469 | mkdir -p "${DECDIR}" 470 | mkdir -p "${_SOCKDIR}" 471 | rm -f "${SOCKFILE}" # Workaround for https://github.com/rfjakob/gocryptfs/issues/634 472 | log "Mounting repo read-write" 473 | gocryptfs -nofail -sharedstorage -ctlsock "${SOCKFILE}" -rw "${ENCDIR}" "${DECDIR}" 474 | log "Mounted repo read-write" 475 | fi 476 | ;; 477 | mount.ro) 478 | if mountpoint -q "${DECDIR}"; then 479 | MOUNT_OPTION=$(findmnt -fn -o options "${DECDIR}" | cut -d, -f1) 480 | if [ "${MOUNT_OPTION}" = "ro" ]; then 481 | log "Repo is mounted read-only" 482 | else 483 | log "Repo is mounted but not read-only" 484 | ${TOOL} umount ${REPO} 485 | ${TOOL} mount.ro ${REPO} 486 | fi 487 | else 488 | mkdir -p "${DECDIR}" 489 | mkdir -p "${_SOCKDIR}" 490 | rm -f "${SOCKFILE}" # Workaround for https://github.com/rfjakob/gocryptfs/issues/634 491 | log "Mounting repo read-only" 492 | gocryptfs -nofail -sharedstorage -ctlsock "${SOCKFILE}" -ro "${ENCDIR}" "${DECDIR}" 493 | log "Mounted repo read-only" 494 | fi 495 | ;; 496 | pull) 497 | if ! mountpoint -q "${DECDIR}"; then 498 | cd "${GITDIR}" 499 | log "Pulling commits (fast-forward only)" 500 | git pull --ff-only origin 501 | log "Pulled commits (fast-forward only)" 502 | else 503 | loge "Unmount first" 504 | exit 2 505 | fi 506 | ;; 507 | push) 508 | cd "${GITDIR}" 509 | log "Pushing commits" 510 | git push -v 511 | log "Pushed commits" 512 | ;; 513 | rename) 514 | old_name="${REPO}" 515 | new_name="${3:?'Provide a new repo name as a positional argument.'}" 516 | log "Renaming remotely and locally to ${new_name}" 517 | GITUSER=$(${TOOL} config core.owner) 518 | 519 | # Check if mounted 520 | if mountpoint -q "${DECDIR}"; then 521 | loge "Unmount first" 522 | exit 2 523 | fi 524 | 525 | # Rename GitHub repo 526 | # Ref: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos#update-a-repository 527 | logn "Renaming repo in GitHub" 528 | read -p "GitHub token with access to 'repo' scope: " GITHUB_TOKEN 529 | curl -sS -f -X PATCH -o /dev/null \ 530 | -H "Authorization: token ${GITHUB_TOKEN}" -H "Accept: application/vnd.github.v3+json" \ 531 | https://api.github.com/repos/${GITUSER}/${REPO} -d "{\"name\": \"${new_name}\"}" 532 | log "Renamed repo in GitHub" 533 | 534 | # Move decryption directory 535 | if [ -d "${DECDIR}" ]; then 536 | new_decdir=$(realpath -ms "${DECDIR}/../${new_name}") 537 | if [ ! -d "${new_decdir}" ]; then 538 | logn "Moving decryption directory" 539 | mv -v "${DECDIR}" "${new_decdir}" 540 | log "Moved decryption directory" 541 | else 542 | loge "Aborting because new decryption directory ${new_decdir} already exists" 543 | exit 5 544 | fi 545 | else 546 | logw "Decryption directory ${DECDIR} cannot be moved because it does not exist" 547 | fi 548 | 549 | # Move git directory 550 | if [ -d "${GITDIR}" ]; then 551 | new_gitdir=$(realpath -ms "${GITDIR}/../${new_name}") 552 | if [ ! -d "${new_gitdir}" ]; then 553 | logn "Moving git directory" 554 | mv -v "${GITDIR}" "${new_gitdir}" 555 | log "Moved git directory" 556 | else 557 | loge "Aborting because new git directory ${new_gitdir} already exists" 558 | exit 5 559 | fi 560 | else 561 | logw "Git directory ${GITDIR} cannot be moved because it does not exist" 562 | fi 563 | 564 | # Update origin URLs 565 | new_dotgitdir="${new_gitdir}/.git" 566 | if [ -d "${new_dotgitdir}" ]; then 567 | cd "${new_gitdir}" 568 | logrn "Updating origin URLs from:" 569 | git remote get-url --all origin | sed 's/^/ /' 570 | git remote set-url --delete origin git@github.com:${GITUSER}/${old_name}.git 571 | git remote set-url --add origin git@github.com:${GITUSER}/${new_name}.git 572 | logr "Updated origin URLs to:" 573 | git remote get-url --all origin | sed 's/^/ /' 574 | else 575 | logw "Origin URLs cannot be updated because the .git directory ${new_dotgitdir} does not exist" 576 | fi 577 | 578 | logn "Renamed remotely and locally to ${new_name}" 579 | ;; 580 | reset.url) 581 | GITUSER=$(${TOOL} config core.owner) 582 | 583 | if [ -d "${DOTGITDIR}" ]; then 584 | cd "${GITDIR}" 585 | 586 | # Log old URLs 587 | logr "Resetting origin URLs from:" 588 | git remote get-url --all origin | sed 's/^/ /' 589 | old_urls=$(git remote get-url --all origin | tr '\n' ' ') 590 | expected_urls="git@github.com:${GITUSER}/${REPO}.git" 591 | 592 | # Add missing URLs 593 | for expected_url in $expected_urls; do 594 | if ! _contains "${old_urls}" "${expected_url}"; then 595 | git remote set-url --add origin "${expected_url}" 596 | logr "Added origin URL: ${expected_url}" 597 | fi 598 | done 599 | 600 | # Remove extra URLs 601 | for old_url in $old_urls; do 602 | if ! _contains "${expected_urls}" ${old_url}; then 603 | git remote set-url --delete origin "${old_url}" 604 | logr "Removed origin URL: ${old_url}" 605 | fi 606 | done 607 | 608 | # Log new URLs 609 | new_urls=$(git remote get-url --all origin | tr '\n' ' ') 610 | if [ "${old_urls}" = "${new_urls}" ]; then 611 | log "Origin URLs remain unchanged" 612 | else 613 | logr "Reset origin URLs to:" 614 | git remote get-url --all origin | sed 's/^/ /' 615 | fi 616 | 617 | else 618 | logw "Origin URLs cannot be reset because the .git directory ${DOTGITDIR} does not exist" 619 | fi 620 | ;; 621 | rm) 622 | if mountpoint -q "${DECDIR}"; then 623 | ${TOOL} umount ${REPO} 624 | echo 625 | fi 626 | 627 | log "Interactively removing local directories" 628 | 629 | if [ -d "${DECDIR}" ]; then 630 | logrn "Removing local decryption directory: ${DECDIR}" 631 | rm -rfI "${DECDIR}" 632 | logr "Removed local decryption directory: ${DECDIR}" 633 | else 634 | logw "Decryption directory ${DECDIR} cannot be removed because it does not exist" 635 | fi 636 | 637 | if [ -d "${DOTGITDIR}" ]; then 638 | logrn "Removing local .git directory: ${DOTGITDIR}" 639 | rm -rf "${DOTGITDIR}" 640 | # Note: -I is not used above to prevent numerous prompts of: "rm: remove write-protected regular file" 641 | logr "Removed local .git directory: ${DOTGITDIR}" 642 | else 643 | logw ".git directory ${DOTGITDIR} cannot be removed because it does not exist" 644 | fi 645 | 646 | if [ -d "${GITDIR}" ]; then 647 | logrn "Removing local git repo directory: ${GITDIR}" 648 | rm -rfI "${GITDIR}" 649 | logr "Removed local git repo directory: ${GITDIR}" 650 | else 651 | logw "Git repo directory ${GITDIR} cannot be removed because it does not exist" 652 | fi 653 | 654 | log "Interactively removed local directories" 655 | ;; 656 | send) 657 | ${TOOL} commit ${REPO} "${@:3}" 658 | echo 659 | ${TOOL} push ${REPO} 660 | ;; 661 | shell) 662 | _shell "${GITDIR}" 663 | ;; 664 | shell.dec) # Remember to exit the shell after using, otherwise umount won't work. 665 | if mountpoint -q "${DECDIR}"; then 666 | _shell "${DECDIR}" 667 | else 668 | loge "Mount first" 669 | exit 2 670 | fi 671 | ;; 672 | shell.enc) 673 | _shell "${ENCDIR}" 674 | ;; 675 | state) 676 | # Get mount state 677 | if mountpoint -q "${DECDIR}"; then 678 | MOUNT_OPTION=$(findmnt -fn -o options "${DECDIR}" | cut -d, -f1) 679 | MOUNT_STATE="${TPUT_GREEN}${TPUT_BOLD}mounted ${MOUNT_OPTION}${TPUT_RESET}" 680 | else 681 | MOUNT_STATE="dismounted" 682 | fi 683 | 684 | # Measure disk usage 685 | ALLDIR_SIZE=$(_du_hs "${GITDIR}") 686 | ENCDIR_SIZE=$(_du_hs "${ENCDIR}") 687 | DOTGITDIR_SIZE=$(_du_hs "${DOTGITDIR}") 688 | 689 | # Print state 690 | printf "${LS_FORMAT}" ${ALLDIR_SIZE} ${ENCDIR_SIZE} ${DOTGITDIR_SIZE} "${MOUNT_STATE}" ${REPO} 691 | ;; 692 | status|info) 693 | ${TOOL} state ${REPO} 694 | echo 695 | cd "${GITDIR}" 696 | git status -bs 697 | mkdir -p "${DECDIR}" 698 | if mountpoint -q "${DECDIR}"; then 699 | cd "${ENCDIR}" 700 | if [[ $(git ls-files -dmo) != "" ]]; then 701 | echo 702 | git ls-files -d | _decrypt_paths | sed "s/^/[${TPUT_RED}del${TPUT_RESET}] /" 703 | git ls-files -m | _decrypt_paths | sed "s/^/[${TPUT_CYAN}mod${TPUT_RESET}] /" 704 | git ls-files -o | _decrypt_paths | sed "s/^/[${TPUT_GREEN}new${TPUT_RESET}] /" 705 | fi 706 | echo 707 | findmnt -f "${DECDIR}" || : 708 | fi 709 | ;; 710 | umount|unmount|dismount) 711 | if mountpoint -q "${DECDIR}" || [ "${3:-''}" = "-f" ]; then 712 | # log "Unmounting repo" 713 | fusermount -u "${DECDIR}" 714 | log "Unmounted repo" 715 | else 716 | log "Repo is unmounted" 717 | fi 718 | ;; 719 | use|use.rw) 720 | if mountpoint -q "${DECDIR}"; then 721 | MOUNT_OPTION=$(findmnt -fn -o options "${DECDIR}" | cut -d, -f1) 722 | if [ "${MOUNT_OPTION}" != "rw" ]; then 723 | ${TOOL} umount ${REPO} 724 | ${TOOL} mount ${REPO} 725 | fi 726 | else 727 | ${TOOL} mount ${REPO} 728 | fi 729 | ${TOOL} shell.dec ${REPO} 730 | ;; 731 | use.ro) 732 | if mountpoint -q "${DECDIR}"; then 733 | MOUNT_OPTION=$(findmnt -fn -o options "${DECDIR}" | cut -d, -f1) 734 | if [ "${MOUNT_OPTION}" != "ro" ]; then 735 | ${TOOL} umount ${REPO} 736 | ${TOOL} mount ${REPO} 737 | fi 738 | else 739 | ${TOOL} mount ${REPO} 740 | fi 741 | ${TOOL} shell.dec ${REPO} 742 | ;; 743 | *) 744 | loge "Invalid command" 745 | exit 1 746 | ;; 747 | esac 748 | -------------------------------------------------------------------------------- /sample.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/impredicative/gec/57f9f1138ed3eb9433c26f9e1894868008493475/sample.png --------------------------------------------------------------------------------