├── .gitignore ├── ChangeLog.md ├── LICENSE ├── README.md ├── Setup.hs ├── apfs-auto-snapshot.cabal ├── apfs-auto-snapshot.cfg ├── apfs-auto-snapshot.db └── src ├── ConfigParse.hs ├── Main.hs ├── SnapshotDatabase.hs ├── TMSnapshot.hs └── schema.db /.gitignore: -------------------------------------------------------------------------------- 1 | .cabal-sandbox 2 | cabal.sandbox.config 3 | dist/ 4 | -------------------------------------------------------------------------------- /ChangeLog.md: -------------------------------------------------------------------------------- 1 | # Revision history for apfs-auto-snapshot 2 | 3 | ## 0.0.0.1 -- YYYY-mm-dd 4 | 5 | * Under construction 6 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # apfs-auto-snapshot 2 | Tool to automatically create and delete APFS snapshots on a sliding timeline. 3 | 4 | # Shows Stopping Limitation 5 | Something (I'm guessing Time Machine) deletes snapshots out from under us. As 6 | `tmutil` seems to be the only way to make APFS snapshots at the moment, there 7 | isn't much that can be done about this I fear. See [#1](/../../issues/1) for 8 | the details. 9 | 10 | As it stands, I can't get more then 4 or 5 snapshots at a time 11 | before the invisible hand steps in and starts deleting older backups. 12 | Unless this is fixed or we find a new way around this, the sliding window 13 | feature of this project is basically unusable, and it would be simplier to 14 | just cron new snapshot creations with `tmutil`. Just don't expect them to 15 | stick around. 16 | 17 | ### Current Status 18 | Until the show stopping limitations get fix, this project is basically stalled. 19 | However, if we can get around that issue, development on this will continue in 20 | full force. The project is not solidified at all, everything in it is prone to 21 | change going forward. 22 | 23 | ### Gotchas 24 | When using APFS snapshots, if you delete a file and it is still in your snapshot, 25 | you will not get the space back from that file until all the snapshots that contain 26 | that file have been deleted. You can manually delete snapshots using `tmutil`. 27 | Perhaps there is a way to mount snapshots as Read/Write (like in BTRFS) so you 28 | can remove only the deisred file instead of the entire snapshot, but I haven't 29 | seen any information about this as of yet. 30 | 31 | ### Contributing 32 | Contributions are 100% welcome! I am ususally hanging out on freenode, feel 33 | free to PM me (vimalloc) if you want to discuss anything :) 34 | 35 | ### Running 36 | * Make sure haskell is installed 37 | * Clone this repo somewhere 38 | * Wherever you cloned the repo, run `cabal sandbox init` 39 | * Install the dependencies with `cabal install --only-dependencies` 40 | * Run `cabal build` or `cabal run` 41 | 42 | You can restore files from the created snapshots by using time machine. 43 | 44 | 45 | If you want to have this work on a schedule, here is a quick and dirty crontab 46 | you could use until something better is put in place. Note that this may 47 | break out from under you as development continues on this project: 48 | ```cron 49 | # NOTE: Make sure you properly set APFS_AUTO_SNAPSHOT_DIR to wherever you cloned 50 | # this project to 51 | 52 | APFS_AUTO_SNAPSHOT_DIR=/Users/lgbland/code/apfs-auto-snapshot 53 | 54 | # Run on the first day of the year at midnight 55 | 0 0 1 1 * cd $APFS_AUTO_SNAPSHOT_DIR; dist/build/apfs-auto-snapshot/apfs-auto-snapshot --quater-hourly --hourly --daily --monthly --yearly > /tmp/autosnap.log 2>&1 56 | 57 | # Run on the first day of the month for every month except january first (handled by yearly) 58 | 0 0 2-12 1 * cd $APFS_AUTO_SNAPSHOT_DIR; dist/build/apfs-auto-snapshot/apfs-auto-snapshot --quater-hourly --hourly --daily --monthly > /tmp/autosnap.log 2>&1 59 | 60 | # Run weekly on sunday 61 | 0 0 * * 0 cd $APFS_AUTO_SNAPSHOT_DIR; dist/build/apfs-auto-snapshot/apfs-auto-snapshot --quater-hourly --hourly --daily --weekly > /tmp/autosnap.log 2>&1 62 | 63 | # Run daily at midnight, except for sunday as that is handled above by weekly 64 | 0 0 * * 1-6 cd $APFS_AUTO_SNAPSHOT_DIR; dist/build/apfs-auto-snapshot/apfs-auto-snapshot --quater-hourly --hourly --daily > /tmp/autosnap.log 2>&1 65 | 66 | # Run hourly, excpet at midnight which is handled by one of the above jobs 67 | 0 1-23 * * * cd $APFS_AUTO_SNAPSHOT_DIR; dist/build/apfs-auto-snapshot/apfs-auto-snapshot --quater-hourly --hourly > /tmp/autosnap.log 2>&1 68 | 69 | # This will run on only the quater (that isn't already handled by an above job) 70 | 15,30,45 * * * * cd $APFS_AUTO_SNAPSHOT_DIR; dist/build/apfs-auto-snapshot/apfs-auto-snapshot --quater-hourly > /tmp/autosnap.log 2>&1 71 | ``` 72 | -------------------------------------------------------------------------------- /Setup.hs: -------------------------------------------------------------------------------- 1 | import Distribution.Simple 2 | main = defaultMain 3 | -------------------------------------------------------------------------------- /apfs-auto-snapshot.cabal: -------------------------------------------------------------------------------- 1 | -- Initial apfs-auto-snapshot.cabal generated by cabal init. For further 2 | -- documentation, see http://haskell.org/cabal/users-guide/ 3 | 4 | -- The name of the package. 5 | name: apfs-auto-snapshot 6 | 7 | -- The package version. See the Haskell package versioning policy (PVP) 8 | -- for standards guiding when and how versions should be incremented. 9 | -- https://wiki.haskell.org/Package_versioning_policy 10 | -- PVP summary: +-+------- breaking API changes 11 | -- | | +----- non-breaking API additions 12 | -- | | | +--- code changes with no API change 13 | version: 0.1.0.0 14 | 15 | -- A short (one-line) description of the package. 16 | synopsis: Automatically create and manage APFS snapshots 17 | 18 | -- A longer description of the package. 19 | -- description: 20 | 21 | -- The license under which the package is released. 22 | license: AGPL-3 23 | 24 | -- The file containing the license text. 25 | license-file: LICENSE 26 | 27 | -- The package author(s). 28 | author: Landon Gilbert-Bland 29 | 30 | -- An email address to which users can send suggestions, bug reports, and 31 | -- patches. 32 | maintainer: landogbland@gmail.com 33 | 34 | -- A copyright notice. 35 | -- copyright: 36 | 37 | -- category: 38 | 39 | build-type: Simple 40 | 41 | -- Extra files to be distributed with the package, such as examples or a 42 | -- README. 43 | extra-source-files: ChangeLog.md 44 | 45 | -- Constraint on the version of Cabal needed to build this package. 46 | cabal-version: >=1.10 47 | 48 | 49 | executable apfs-auto-snapshot 50 | -- .hs or .lhs file containing the Main module. 51 | main-is: Main.hs 52 | 53 | -- Modules included in this executable, other than Main. 54 | -- other-modules: 55 | 56 | -- LANGUAGE extensions used by modules in this package. 57 | -- other-extensions: 58 | 59 | -- Other library packages from which modules are imported. 60 | build-depends: base >=4.9 && <4.10 61 | , pcre-heavy 62 | , process 63 | , split 64 | , ConfigFile 65 | , MissingH 66 | , optparse-applicative 67 | , sqlite-simple 68 | , mtl 69 | , text 70 | 71 | -- Directories containing source files. 72 | hs-source-dirs: src 73 | 74 | -- Base language which the package is written in. 75 | default-language: Haskell2010 76 | 77 | -------------------------------------------------------------------------------- /apfs-auto-snapshot.cfg: -------------------------------------------------------------------------------- 1 | [TIMELINE] 2 | keep_quater_hourly = 4 3 | keep_hourly = 24 4 | keep_daily = 7 5 | keep_weekly = 4 6 | keep_monthly = 12 7 | keep_yearly = 3 8 | -------------------------------------------------------------------------------- /apfs-auto-snapshot.db: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/vimalloc/apfs-auto-snapshot/c38c3ad7060b4cec9e0e24a2b9e258a634a189e5/apfs-auto-snapshot.db -------------------------------------------------------------------------------- /src/ConfigParse.hs: -------------------------------------------------------------------------------- 1 | module ConfigParse where 2 | 3 | import qualified Data.ConfigFile as CP 4 | import Data.Either.Utils (forceEither) -- provided by MissingH 5 | 6 | data SnapshotLimitConfig = SnapshotLimitConfig 7 | { yearlyLimit :: !Int 8 | , monthlyLimit :: !Int 9 | , weeklyLimit :: !Int 10 | , dailyLimit :: !Int 11 | , hourlyLimit :: !Int 12 | , quaterHourlyLimit :: !Int 13 | } deriving (Show) 14 | 15 | -- TODO get rid of forceEither here 16 | getConfigParser :: String -> IO CP.ConfigParser 17 | getConfigParser filepath = forceEither <$> CP.readfile CP.emptyCP filepath 18 | 19 | getTimelineConfig :: CP.ConfigParser -> Either CP.CPError SnapshotLimitConfig 20 | getTimelineConfig cp = do 21 | keep_yearly <- CP.get cp "TIMELINE" "keep_yearly" 22 | keep_monthly <- CP.get cp "TIMELINE" "keep_monthly" 23 | keep_weekly <- CP.get cp "TIMELINE" "keep_weekly" 24 | keep_daily <- CP.get cp "TIMELINE" "keep_daily" 25 | keep_hourly <- CP.get cp "TIMELINE" "keep_hourly" 26 | keep_quater_hourly <- CP.get cp "TIMELINE" "keep_quater_hourly" 27 | return $ SnapshotLimitConfig keep_yearly keep_monthly keep_weekly 28 | keep_daily keep_hourly keep_quater_hourly 29 | 30 | -------------------------------------------------------------------------------- /src/Main.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE OverloadedStrings #-} 2 | {-# LANGUAGE FlexibleContexts #-} 3 | 4 | module Main where 5 | 6 | import ConfigParse 7 | import SnapshotDatabase 8 | import TMSnapshot 9 | 10 | import Control.Monad.Except 11 | import Database.SQLite.Simple 12 | import Data.Either.Utils (forceEither) -- provided by MissingH 13 | import Data.Semigroup ((<>)) 14 | import Options.Applicative 15 | import System.Exit (ExitCode (ExitSuccess, ExitFailure), exitWith) 16 | 17 | data RequestedSnapshots = RequestedSnapshots 18 | { yearly :: Bool 19 | , monthly :: Bool 20 | , weekly :: Bool 21 | , daily :: Bool 22 | , hourly :: Bool 23 | , quater_hourly :: Bool 24 | } deriving (Show) 25 | 26 | 27 | -- TODO better way to compare TMSnapshots and Database snapshots metadata 28 | 29 | 30 | reqToTypes :: RequestedSnapshots -> [SnapshotTimeline] 31 | reqToTypes req 32 | | yearly req = Yearly : (reqToTypes req { yearly = False }) 33 | | monthly req = Monthly : (reqToTypes req { monthly = False }) 34 | | weekly req = Weekly : (reqToTypes req { weekly = False }) 35 | | daily req = Daily : (reqToTypes req { daily = False }) 36 | | hourly req = Hourly : (reqToTypes req { hourly = False }) 37 | | quater_hourly req = QuaterHourly : (reqToTypes req { quater_hourly = False }) 38 | | otherwise = [] 39 | 40 | -- TODO use submcommands, so you can have other commands for explictly 41 | -- pruning, listing, purging, etc. 42 | cliParser :: Parser RequestedSnapshots 43 | cliParser = RequestedSnapshots 44 | <$> switch 45 | ( long "yearly" 46 | <> help "This snapshot is a yearly snapshot") 47 | <*> switch 48 | ( long "monthly" 49 | <> help "This snapshot is a monthly snapshot") 50 | <*> switch 51 | ( long "weekly" 52 | <> help "This snapshot is a weekly snapshot") 53 | <*> switch 54 | ( long "daily" 55 | <> help "This snapshot is a daily snapshot") 56 | <*> switch 57 | ( long "hourly" 58 | <> help "This snapshot is a hourly snapshot") 59 | <*> switch 60 | ( long "quater-hourly" 61 | <> help "This snapshot is a quater_hourly snapshot") 62 | 63 | handleCli :: (MonadError String m, MonadIO m) => [SnapshotTimeline] -> m () 64 | handleCli [] = throwError "Specify at least one snapshot type (see --help)" 65 | handleCli timelines = do 66 | -- Get our config file options about how many snapshots to keep 67 | cp <- liftIO $ getConfigParser "apfs-auto-snapshot.cfg" 68 | let timelineLimits = forceEither $ getTimelineConfig cp 69 | 70 | -- Open the database connection with foreign key support 71 | conn <- liftIO $ open "apfs-auto-snapshot.db" 72 | liftIO $ execute_ conn "PRAGMA foreign_keys = ON" 73 | 74 | -- Remove any snapshots from the database that don't exist in time machine 75 | -- any more (deleted outside of this program). 76 | -- TODO should maybe add logging if this finds a missing snapshot 77 | expectedSnaps <- liftIO $ getStoredSnapshots conn 78 | tmSnaps <- listTMSnapshots 79 | let tmSnapIds = map tmId tmSnaps 80 | let missingSnaps = filter (\s -> (snapshotName s) `notElem` tmSnapIds) expectedSnaps 81 | liftIO $ mapM_ (deleteStoredSnapshot conn) missingSnaps 82 | 83 | -- Create our new snapshot 84 | tmSnap <- createTMSnapshot 85 | storedSnap <- liftIO $ storeSnapshot conn tmSnap 86 | liftIO $ storeTimelines conn storedSnap timelines 87 | 88 | -- Slide the timeline windows 89 | liftIO $ deleteTimelines conn Yearly (yearlyLimit timelineLimits) 90 | liftIO $ deleteTimelines conn Monthly (monthlyLimit timelineLimits) 91 | liftIO $ deleteTimelines conn Weekly (weeklyLimit timelineLimits) 92 | liftIO $ deleteTimelines conn Daily (dailyLimit timelineLimits) 93 | liftIO $ deleteTimelines conn Hourly (hourlyLimit timelineLimits) 94 | liftIO $ deleteTimelines conn QuaterHourly (quaterHourlyLimit timelineLimits) 95 | 96 | -- Delete any backups that are now outside of the timeline window 97 | toDeleteFromDb <- liftIO $ snapshotsWithoutTimelines conn 98 | let toDeleteTmIds = map snapshotName toDeleteFromDb 99 | let toDeleteFromTM = filter (\s -> (tmId s) `elem` toDeleteTmIds) tmSnaps 100 | mapM_ deleteTMSnapshot toDeleteFromTM 101 | liftIO $ mapM_ (deleteStoredSnapshot conn) toDeleteFromDb 102 | 103 | printAndExit :: String -> IO () 104 | printAndExit errMsg = do 105 | putStrLn $ "Error: " ++ errMsg 106 | exitWith $ ExitFailure 1 107 | 108 | main :: IO () 109 | main = do 110 | let opts = info (cliParser <**> helper) 111 | ( fullDesc 112 | <> progDesc "Create a new snapshot in the given timelines" 113 | <> header "apfs-auto-snapshot - Automaticaaly craete and delete APFS snapshots") 114 | req <- execParser opts 115 | let snapshotTypes = reqToTypes req 116 | result <- runExceptT $ handleCli snapshotTypes 117 | case result of 118 | Right _ -> return () 119 | Left err -> printAndExit err 120 | -------------------------------------------------------------------------------- /src/SnapshotDatabase.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE OverloadedStrings #-} 2 | 3 | module SnapshotDatabase where 4 | 5 | import TMSnapshot 6 | 7 | import Database.SQLite.Simple 8 | import Database.SQLite.Simple.FromField 9 | import Database.SQLite.Simple.Internal (Field(..)) -- TODO not great... 10 | import Database.SQLite.Simple.Ok 11 | import Database.SQLite.Simple.ToField 12 | import Data.Text (unpack) 13 | 14 | -- TODO move from String to Text everywhere 15 | -- TODO make all imports explicit 16 | 17 | data SnapshotTimeline = Yearly 18 | | Monthly 19 | | Weekly 20 | | Daily 21 | | Hourly 22 | | QuaterHourly 23 | 24 | instance ToField SnapshotTimeline where 25 | toField Yearly = toField ("yearly" :: String) 26 | toField Monthly = toField ("monthly" :: String) 27 | toField Weekly = toField ("weekly" :: String) 28 | toField Daily = toField ("daily" :: String) 29 | toField Hourly = toField ("hourly" :: String) 30 | toField QuaterHourly = toField ("quater_hourly" :: String) 31 | 32 | data StoredSnapshot = StoredSnapshot 33 | { snapshotId :: Int 34 | , snapshotName :: String 35 | } 36 | 37 | instance FromRow StoredSnapshot where 38 | fromRow = StoredSnapshot <$> field <*> field 39 | 40 | data StoredTimeline = StoredTimeline 41 | { timelineId :: Int 42 | , snapshotId' :: Int 43 | , snapshotType :: String 44 | } 45 | 46 | instance FromRow StoredTimeline where 47 | fromRow = StoredTimeline <$> field <*> field <*> field 48 | 49 | data LastInsertedRowId = LastInsertedRowId 50 | { lastInsertedRowId :: Int 51 | } 52 | 53 | instance FromRow LastInsertedRowId where 54 | fromRow = LastInsertedRowId <$> field 55 | 56 | 57 | getStoredSnapshots :: Connection -> IO [StoredSnapshot] 58 | getStoredSnapshots conn = query_ conn "SELECT * FROM snapshots" 59 | 60 | storeSnapshot :: Connection -> TMSnapshot -> IO StoredSnapshot 61 | storeSnapshot conn tmSnap = do 62 | execute conn "INSERT INTO snapshots (name) VALUES (?)" (Only (tmId tmSnap)) 63 | lastRowIdRes <- query_ conn "SELECT last_insert_rowid()" 64 | let snapId = lastInsertedRowId $ head lastRowIdRes 65 | snapRes <- query conn "SELECT * FROM snapshots WHERE id = (?)" (Only snapId) 66 | return $ head snapRes 67 | 68 | storeTimelines :: Connection -> StoredSnapshot -> [SnapshotTimeline] -> IO () 69 | storeTimelines conn snap timelines = mapM_ (storeTimeline conn snap) timelines 70 | where 71 | storeTimeline :: Connection -> StoredSnapshot -> SnapshotTimeline -> IO () 72 | storeTimeline conn snap timeline = execute conn query args 73 | where 74 | query = "INSERT INTO timelines (snapshot_id, snapshot_type) VALUES (?, ?)" 75 | args = (snapshotId snap, timeline) 76 | 77 | deleteStoredSnapshot :: Connection -> StoredSnapshot -> IO () 78 | deleteStoredSnapshot conn snap = execute conn query args 79 | where 80 | query = "DELETE FROM snapshots WHERE id = (?)" 81 | args = (Only (snapshotId snap)) 82 | 83 | deleteTimelines :: Connection -> SnapshotTimeline -> Int -> IO () 84 | deleteTimelines conn timeline numToKeep = do 85 | let timelineQuery = "SELECT * FROM timelines WHERE snapshot_type = (?)\ 86 | \ ORDER BY snapshot_id DESC" 87 | timelines <- query conn timelineQuery (Only timeline) 88 | let toRemove = drop numToKeep timelines 89 | mapM_ (deleteTimeline conn) toRemove 90 | where 91 | deleteTimeline :: Connection -> StoredTimeline -> IO () 92 | deleteTimeline conn tl = execute conn query args 93 | where 94 | query = "DELETE FROM timelines WHERE id = (?)" 95 | args = (Only (timelineId tl)) 96 | 97 | snapshotsWithoutTimelines :: Connection -> IO [StoredSnapshot] 98 | snapshotsWithoutTimelines conn = query_ conn query 99 | where 100 | query = "SELECT snapshots.* FROM snapshots LEFT JOIN timelines \ 101 | \ON snapshots.id = timelines.snapshot_id \ 102 | \WHERE timelines.snapshot_id IS NULL" 103 | -------------------------------------------------------------------------------- /src/TMSnapshot.hs: -------------------------------------------------------------------------------- 1 | {-# LANGUAGE QuasiQuotes, FlexibleContexts #-} 2 | 3 | module TMSnapshot where 4 | 5 | import Control.Monad.Except (MonadError, MonadIO, throwError, liftIO) 6 | import Data.List.Split (splitOn) 7 | import System.Exit (ExitCode (ExitSuccess, ExitFailure)) 8 | import System.Process (readProcessWithExitCode) 9 | import Text.Regex.PCRE.Heavy (scan, re) 10 | 11 | -- Unique id (date) of snapshot as it is stored in time machine. As it 12 | -- currnelty stands, this can be derived from the data, but seperating 13 | -- them here helps make things more clear, and also easier for us if 14 | -- apple changes the id for these in the future (or allows us to 15 | -- label them ourselves) 16 | type TMSnapshotId = String 17 | 18 | -- Datetime that the time machine snapshot was created 19 | data TMSnapshotDate = TMSnapshotDate 20 | { year :: !Int 21 | , month :: !Int 22 | , day :: !Int 23 | , hour :: !Int 24 | , minute :: !Int 25 | , second :: !Int 26 | } deriving (Eq, Ord) 27 | 28 | -- Snapshot data we will be working with in our functions 29 | data TMSnapshot = TMSnapshot 30 | { date :: TMSnapshotDate 31 | , tmId :: TMSnapshotId 32 | } 33 | 34 | 35 | parseTMSnapshotDates :: (MonadError String m) => [String] -> m [TMSnapshot] 36 | parseTMSnapshotDates dates = sequence $ parseTMDate <$> dates 37 | 38 | parseTMDate :: (MonadError String m) => String -> m TMSnapshot 39 | parseTMDate dateStr = 40 | case scan dateRegex dateStr of 41 | (tmid, y:mo:d:h:mi:s:[]):[] -> do 42 | let tmDate = TMSnapshotDate (read y) (read mo) (read d) 43 | (read h) (read mi) (read s) 44 | let tmUniqueId = tmid 45 | return $ TMSnapshot tmDate tmUniqueId 46 | _ -> throwError badFormat 47 | where 48 | dateRegex = [re|(\d{4})-(\d{2})-(\d{2})-(\d{2})(\d{2})(\d{2})|] 49 | badFormat = concat [ "tmutil output " 50 | , dateStr 51 | , " is not in the format YYYY-MM-DD-HHMMSS." ] 52 | 53 | runSubprocess :: (MonadError String m, MonadIO m) => String -> [String] -> String -> m String 54 | runSubprocess binary args stdin = do 55 | (code, stdout, stderr) <- liftIO $ readProcessWithExitCode binary args stdin 56 | case code of 57 | ExitSuccess -> return stdout 58 | ExitFailure _ -> throwError $ concat [ binary 59 | , " exited with code " 60 | , show code 61 | , ": " 62 | , stderr ] 63 | 64 | listTMSnapshots :: (MonadError String m, MonadIO m) => m [TMSnapshot] 65 | listTMSnapshots = do 66 | -- Expected output should have a header, list of dates, and trailing 67 | -- newline. Strip out the header and trailing newline, and work on 68 | -- just the dates. 69 | stdout <- runSubprocess "/usr/bin/tmutil" ["listlocalsnapshotdates"] "" 70 | let split = splitOn "\n" stdout 71 | case split of 72 | _:_:_ -> parseTMSnapshotDates . tail . init $ split 73 | _ -> throwError $ concat [ "Unexpected output from tmutil: " 74 | , stdout 75 | , ". Expected header, dates, and newline" ] 76 | 77 | createTMSnapshot :: (MonadError String m, MonadIO m) => m TMSnapshot 78 | createTMSnapshot = runSubprocess "/usr/bin/tmutil" ["localsnapshot"] "" >>= parseTMDate 79 | 80 | deleteTMSnapshot :: (MonadError String m, MonadIO m) => TMSnapshot -> m () 81 | deleteTMSnapshot s = runSubprocess "/usr/bin/tmutil" args "" >>= \_ -> return () 82 | where 83 | args = ["deletelocalsnapshots", tmId s] 84 | -------------------------------------------------------------------------------- /src/schema.db: -------------------------------------------------------------------------------- 1 | CREATE TABLE snapshots ( 2 | id integer PRIMARY KEY AUTOINCREMENT, 3 | name text NOT NULL UNIQUE 4 | ); 5 | CREATE TABLE timelines ( 6 | id integer PRIMARY KEY AUTOINCREMENT, 7 | snapshot_id integer NOT NULL, 8 | snapshot_type text NOT NULL, 9 | FOREIGN KEY(snapshot_id) REFERENCES snapshots(id) ON DELETE CASCADE, 10 | UNIQUE (snapshot_id, snapshot_type) 11 | ); 12 | --------------------------------------------------------------------------------