├── COPYING.txt ├── README.txt ├── backup.py ├── config.cfg.example ├── config.py ├── lock.py └── portalocker.py /COPYING.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.txt: -------------------------------------------------------------------------------- 1 | Dupinanny backup script 2 | ======================= 3 | 4 | INTRODUCTION 5 | ============ 6 | 7 | Dupinanny is a simple backup script that drives the duplicity [1] backup 8 | software. Duplicity is an encrypted bandwidth-efficient backup that 9 | supports a number of remote backends such as rsync, Amazon S3 and others. 10 | 11 | Dupinanny is released under the GPL, and the latest source code is 12 | available at http://github.com/TTimo/dupinanny/tree/master [2] 13 | 14 | Dupinanny was born out of my own need for an automated backup solution 15 | to be deployed on several of my systems. I wanted to do offsite, 16 | whole-system backups, to a windows-based remote storage running rsync. 17 | 18 | I realized that I needed to work around some of duplicity's kinks, so 19 | dupinanny was born to provide the following: 20 | 21 | - Easily break down a whole-system backup into independent smaller 22 | backups. Due to bandwidth constraints, a full backup to the offsite 23 | location can take several days. If the connection is lost the whole 24 | backup has to be restarted. Through dupinanny's configuration file 25 | you can break your backups into several smaller pieces that are more 26 | likely to backup completely without being interrupted. 27 | 28 | - Easy to invoke from cron, with a full backup every once in a while 29 | and smaller incremental backups in between. Duplicity does not support 30 | "rolling incremental" backups so a full backup is needed on a regular 31 | basis. 32 | 33 | - Automatic cleanup of old/outdated backups on the backend. 34 | 35 | It is likely that duplicity will support backup checkpoints, and rolling 36 | incrementals at some point in the future. That will likely make this 37 | script quite a bit less useful. 38 | 39 | LICENSE 40 | ======= 41 | 42 | Copyright (C) 2008 Timothee Besset 43 | This software is released under the GNU GPL v3. See COPYING.txt. 44 | 45 | USAGE 46 | ===== 47 | 48 | $ ./backup.py --help 49 | Usage: backup.py [options] 50 | 51 | Options: 52 | -h, --help show this help message and exit 53 | --dry-run show commands, do not execute except collection-status 54 | --cleanup cleanup only, implies --dry-run 55 | --remove-older=REMOVE_OLDER 56 | run remove_old only, with the given value. implies 57 | --dry-run (set the value in the config to customize 58 | for each run and do other operations) 59 | --config=CONFIGFILE use this config file 60 | --full do a full backup 61 | 62 | You will need to setup a configuration file, see config.cfg.example for 63 | inspiration. 64 | 65 | Last but not least: READ THE SOURCE (backup.py mostly) 66 | 67 | Python isn't particularly hard to learn, and the script was designed to be 68 | easy to extend. Dupinanny was mostly written to cover the features I needed 69 | immediately, patches to make it more general and improve support for other 70 | backends than rsync are most welcome. 71 | 72 | LINKS 73 | ===== 74 | 75 | [1] duplicity web site: http://duplicity.nongnu.org/ 76 | [2] dupinanny web site: http://github.com/TTimo/dupinanny/tree/master 77 | -------------------------------------------------------------------------------- /backup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | ########################################################################## 4 | # dupinanny backup scripts for duplicity 5 | # Copyright (C) 2008 Timothee Besset 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | ########################################################################## 20 | 21 | from __future__ import with_statement 22 | from contextlib import contextmanager 23 | 24 | import sys, commands, os, subprocess, pickle, datetime 25 | 26 | import config, lock 27 | 28 | class Backup( config.ConfigBase ): 29 | def __init__( self, conf ): 30 | config.ConfigBase.__init__( self, conf ) 31 | 32 | @contextmanager 33 | def ManageLock( self ): 34 | filelock = lock.lock( self.lockfile, 'dupinanny backup' ) 35 | filelock.acquire( wait = None, expire = None ) 36 | yield 37 | filelock.release() 38 | 39 | def Prepare( self ): 40 | if ( self.dupi.has_key( 'prepare' ) ): 41 | for p in self.dupi['prepare']: 42 | p.Prepare( self ) 43 | 44 | def Posthook( self ): 45 | if ( self.dupi.has_key( 'posthook' ) ): 46 | for p in self.dupi['posthook']: 47 | p.Posthook( self ) 48 | 49 | def ProcessBackups( self ): 50 | backup_time_filename = os.path.join( os.path.dirname( self.lockfile ), 'dupinnany_backup_info.pickle' ) 51 | if ( not self.dry_run and self.config.has_key( 'backup_every' ) and os.path.exists( backup_time_filename ) ): 52 | # check last backup information, early out if we haven't reached that point yet 53 | backup_time_file = file( backup_time_filename ) 54 | last_backup = pickle.load( backup_time_file ) 55 | backup_time_file.close() 56 | delta = datetime.datetime.now() - last_backup 57 | if ( delta.days < self.config['backup_every'] ): 58 | print( 'Last backup is %d days old, no new backup needed.' % delta.days ) 59 | return 60 | 61 | if ( not self.dupi.has_key( 'items' ) ): 62 | raise Exception( 'no backups defined (\'items\' entry in the DupiConfig dictionary)' ) 63 | 64 | # setup first so we can flag 'full backup' 65 | # and do the cleanup and status summary at the end too 66 | 67 | print '###########################################################################' 68 | print 'setup' 69 | print '###########################################################################' 70 | 71 | for b in self.dupi['items']: 72 | b.Setup( self ) 73 | 74 | for b in self.dupi['items']: 75 | print '###########################################################################' 76 | print 'run %s' % b.root 77 | print '###########################################################################' 78 | b.Run() 79 | 80 | for b in self.dupi['items']: 81 | print '###########################################################################' 82 | print 'finish %s' % b.root 83 | print '###########################################################################' 84 | b.Finish() 85 | 86 | if ( not self.dry_run ): 87 | # write out a global flag to mark the time of the last successful backup run 88 | # place this in the same folder as the pid file 89 | backup_time_file = file( backup_time_filename, 'w' ) 90 | pickle.dump( datetime.datetime.now(), backup_time_file ) 91 | backup_time_file.close() 92 | 93 | def Run( self ): 94 | with self.ManageLock(): 95 | self.Prepare() 96 | self.ProcessBackups() 97 | self.Posthook() 98 | 99 | class CheckMount( object ): 100 | def __init__( self, directory ): 101 | self.directory = directory 102 | 103 | def Prepare( self, backup ): 104 | print 'CheckMount.Prepare' 105 | cmd = 'cat /etc/mtab | grep "%s"' % self.directory 106 | print cmd 107 | ( status, output ) = commands.getstatusoutput( cmd ) 108 | if ( status != 0 ): 109 | print repr( ( status, output ) ) 110 | cmd = 'mount "%s"' % self.directory 111 | print cmd 112 | ( status, output ) = commands.getstatusoutput( cmd ) 113 | print repr( ( status, output ) ) 114 | if ( status != 0 ): 115 | raise Exception( 'CheckMount: %s is not mounted' % self.directory ) 116 | 117 | class BackupTarget( object ): 118 | def __init__( self, root, destination, exclude = [], shortFilenames = False , include = [] ): 119 | self.root = root 120 | self.destination = destination 121 | self.exclude = exclude 122 | self.include = include 123 | self.backup = None 124 | self.shortFilenames = shortFilenames 125 | self.fullFileFlag = os.path.normpath( '%s.full' % root.replace( '/', '_' ) ) 126 | 127 | def Setup( self, backup ): 128 | self.backup = backup 129 | print 'BackupTarget.Setup %s' % repr( ( self.root, self.destination, self.exclude, self.include ) ) 130 | 131 | if ( self.backup.full ): 132 | subprocess.check_call( [ 'touch', self.fullFileFlag ] ) 133 | 134 | if ( os.path.exists( self.fullFileFlag ) ): 135 | full = 'full backup enabled' 136 | else: 137 | full = 'not present' 138 | print 'full backup indicator file: %s - %s' % ( repr( self.fullFileFlag ), full ) 139 | 140 | def Run( self, recursed = False ): 141 | 142 | # we do it that way so a full backup that fails keeps getting retried until it works 143 | backup_type = 'incremental' 144 | if ( os.path.exists( self.fullFileFlag ) ): 145 | backup_type = 'full' 146 | 147 | if ( self.backup.config.has_key( 'password' ) ): 148 | os.environ['PASSPHRASE'] = self.backup.config['password'] 149 | 150 | option_string = [] 151 | for e in self.exclude: 152 | option_string.append( '--exclude=%s' % e ) 153 | for e in self.include: 154 | option_string.append( '--include=%s' % e ) 155 | if ( self.shortFilenames ): 156 | option_string.append( '--short-filenames' ) 157 | if ( self.backup.config.has_key('duplicity_args') ): 158 | option_string += self.backup.config['duplicity_args'] 159 | 160 | tempdir = '/tmp' 161 | try: 162 | tempdir = os.environ['TEMP'] 163 | except: 164 | pass 165 | if ( self.backup.config.has_key('tempdir') ): 166 | tempdir = self.backup.config['tempdir'] 167 | # need to make it explicit then 168 | option_string += [ '--tempdir', tempdir ] 169 | 170 | # avoid a bad recursion problem in 5.0.2 - make sure to skip the tempdir 171 | # I don't know if this has been fixed in newer releases of duplicity, would be worth checking 172 | # additional difficulty: can only do this if the directory is actually in the path 173 | if ( tempdir.find( self.root ) != -1 ): 174 | if ( tempdir is None ): 175 | option_string.append( '--exclude=/tmp' ) 176 | else: 177 | option_string.append( '--exclude=%s' % tempdir ) 178 | 179 | cmd = [ self.backup.duplicity, backup_type, '--asynchronous-upload' ] 180 | cmd += option_string 181 | cmd.append( self.root ) 182 | cmd.append( self.destination ) 183 | print repr( cmd ) 184 | 185 | if ( not self.backup.dry_run ): 186 | p = subprocess.Popen( cmd, stdin = None, stdout = subprocess.PIPE, stderr = subprocess.STDOUT, shell = False ) 187 | # p.communicate is nice, but I want to print output as we go 188 | # NOTE: using a tee class would be a better way to do this clearly 189 | failed_incremental = False 190 | ret = None 191 | while ( ret is None ): 192 | out = p.stdout.read() 193 | if ( len( out ) != 0 ): 194 | sys.stdout.write( out ) 195 | if ( out.find( 'Old signatures not found and incremental specified' ) != -1 ): 196 | failed_incremental = True 197 | ret = p.poll() 198 | print repr( ret ) 199 | if ( ret != 0 ): 200 | if ( failed_incremental ): 201 | print 'no incremental found, forcing full backup' 202 | if ( recursed ): 203 | raise Exception( 'already recursed while forcing full backup' ) 204 | subprocess.check_call( [ 'touch', self.fullFileFlag ] ) 205 | self.Run( recursed = True ) 206 | return 207 | raise Exception( 'backup failed' ) 208 | 209 | # clear the full flag if needed 210 | if ( backup_type == 'full' ): 211 | os.unlink( self.fullFileFlag ) 212 | 213 | option_string = [ '--extra-clean' ] 214 | if ( self.shortFilenames ): 215 | option_string.append( '--short-filenames' ) 216 | if ( self.backup.config.has_key('duplicity_args') ): 217 | option_string += self.backup.config['duplicity_args'] 218 | 219 | cmd = [ self.backup.duplicity, 'cleanup' ] 220 | cmd += option_string 221 | cmd.append( '--force' ) 222 | cmd.append( self.destination ) 223 | print( repr( cmd ) ) 224 | if ( self.backup.cleanup or not self.backup.dry_run ): 225 | subprocess.check_call( cmd ) 226 | 227 | if ( self.backup.remove_older != 0 ): 228 | cmd = [ self.backup.duplicity, 'remove-older-than', '%dD' % self.backup.remove_older, '--force' ] 229 | cmd += option_string 230 | cmd.append( self.destination ) 231 | print( repr( cmd ) ) 232 | if ( self.backup.force_remove_older or not self.backup.dry_run ): 233 | subprocess.check_call( cmd ) 234 | 235 | def Finish( self ): 236 | option_string = [] 237 | if ( self.shortFilenames ): 238 | option_string.append( '--short-filenames' ) 239 | if ( self.backup.config.has_key('duplicity_args') ): 240 | option_string += self.backup.config['duplicity_args'] 241 | cmd = [ self.backup.duplicity, 'collection-status' ] 242 | cmd += option_string 243 | cmd.append( self.destination ) 244 | print( repr( cmd ) ) 245 | subprocess.check_call( cmd ) 246 | 247 | class LVMBackupTarget( BackupTarget ): 248 | def __init__( self, root, destination, lvmpath, snapsize, snapshot_name, snapshot_path, exclude = [], shortFilenames = False ): 249 | BackupTarget.__init__( self, root, destination, exclude = exclude, shortFilenames = shortFilenames ) 250 | self.lvmpath = lvmpath 251 | self.snapsize = snapsize 252 | self.snapshot_name = snapshot_name 253 | self.snapshot_path = snapshot_path 254 | # otherwrite the parent class's name to avoid collisions 255 | self.fullFileFlag = os.path.normpath( '%s.full' % lvmpath.replace( '/', '_' ) ) 256 | 257 | def Run( self, recursed = False ): 258 | # create snapshot 259 | if ( not recursed ): # only done once at top level, recursed is the path for 'try again with a full backup' 260 | cmd = [ 'lvcreate', '-s', '-L', self.snapsize, '-n', self.snapshot_name, self.lvmpath ] 261 | print cmd 262 | subprocess.check_call( cmd ) 263 | cmd = [ 'mount', '-t', 'auto', self.snapshot_path, self.root ] 264 | print cmd 265 | subprocess.check_call( cmd ) 266 | try: 267 | BackupTarget.Run( self, recursed = recursed ) 268 | finally: 269 | if ( not recursed ): # only done once at top level, recursed is the path for 'try again with a full backup' 270 | # release snapshot - making sure to do that in a cleanup handler so we release the snap no matter what 271 | cmd = [ 'umount', self.root ] 272 | print cmd 273 | subprocess.check_call( cmd ) 274 | cmd = [ 'lvremove', '-f', self.snapshot_path ] 275 | print cmd 276 | subprocess.check_call( cmd ) 277 | 278 | if ( __name__ == '__main__' ): 279 | import config 280 | backup = config.readConfig( sys.argv ) 281 | backup['backup'].Run() 282 | -------------------------------------------------------------------------------- /config.cfg.example: -------------------------------------------------------------------------------- 1 | # -*- mode: python -*- 2 | 3 | # example configuration file for dupinanny: 4 | # this is evaluated as python code. 5 | # you can import modules, declare classes, do all the usual python things 6 | # dupinnany will work from the 'DupiConfig' dictionary you setup 7 | 8 | DupiConfig = {} 9 | 10 | ######################################### 11 | # general options: 12 | ######################################### 13 | 14 | config = { 15 | 'lockfile' : 'lockfile_path', # where to store the lock/pid file 16 | 'password' : 'mypass', # password for PGP (use --no-encryption in duplicity_args if you do not wish to encrypt) 17 | # 'dry_run' : True, # optional, can also use --dry-run on command line 18 | # 'duplicity' : 'duplicity', # optional, path to duplicity script 19 | # 'backup_every' : 7, # optional, really do a backup every n days only (keep retrying on every invocation until operation is successful) 20 | # 'remove_older' : 4, # optional, remove backups older than n days (4 by default, set to 0 to disable) 21 | # 'tempdir' : '/alternate/tmp', # optional, alternate temporary storage directory 22 | # 'duplicity_args' : [ '--s3-use-new-style' ], # optional, extra arguments to use when calling duplicity (this example in particular may be needed when using S3) 23 | } 24 | 25 | ######################################### 26 | # backup targets: 27 | ######################################### 28 | 29 | # this shows how to breakdown a backup over rsync into multiple independent pieces 30 | # we also show how to exclude some paths, there is also an include option available 31 | 32 | destination_root = 'rsync://@my_host::my_backup_path' 33 | 34 | # S3 NOTE - use the following: 35 | # destination_root = 's3+http://my_bucket_name' 36 | # don't use --s3-use-new-style 37 | 38 | from backup import BackupTarget 39 | DupiConfig['items'] = [ 40 | BackupTarget( root = '/', destination = destination_root, exclude = [ '/usr/local/games' ], shortFilenames = True ), 41 | # (dupinanny calls duplicity with --exclude-other-filesystems, so you may need to add more) 42 | BackupTarget( root = '/var', destination = '%s/var' % destination_root, shortFilenames = True ), 43 | ] 44 | 45 | ######################################### 46 | # LVM support (EXPERIMENTAL): 47 | ######################################### 48 | 49 | # if you use LVM, you can use LVM snapshots to make sure you're backing up a consistent image 50 | # use LVMBackupTarget for that purpose, you need a path to mount the snapshot to, and that's what you use as the root of the backup 51 | # you also need to pass the name of the snapshot LVM volume that is created, the LVM path for it, and it's size 52 | 53 | DupiConfig['items'].append( 54 | LVMBackupTarget( root = '/mnt/dupinanny', destination = 'rsync://@my_host::my_lvm_backup_path', lvmpath = '/dev/lvmvolume/volumename', snapsize = '20G', snapshot_name = 'dupinanny', snapshot_path = '/dev/lvmvolume/dupinanny' ) 55 | ) 56 | 57 | ######################################### 58 | # optional stuff: 59 | ######################################### 60 | 61 | # define your backup class if you need to override it 62 | # by default the system will instanciate the main class for you 63 | #from backup import Backup 64 | #DupiConfig['backup'] = Backup( DupiConfig ) 65 | 66 | # adding pre-backup steps - write your own class, or use some of the provided utilities 67 | # for instance, this checks that a particular filesystem is mounted 68 | #from backup import CheckMount 69 | #DupiConfig['prepare'] = [ CheckMount( '/mnt/backup' ) ] 70 | 71 | # adding post-backup steps - write your own class, or use some of the provided utilities 72 | # for instance, this displays the disk usage 73 | #class SFTPDiskSpace( object ): 74 | # def __init__( self, server ): 75 | # self.server = server 76 | # 77 | # def Posthook( self, backup ): 78 | # print 'SFTPDiskSpace.Posthook' 79 | # cmd = 'echo df -h | sftp "%s"' % self.server 80 | # print cmd 81 | # p = subprocess.Popen( cmd, stdin = None, shell = True ) 82 | # p.wait() 83 | # 84 | #DupiConfig['posthook'] = [ SFTPDiskSpace('user@server') ] 85 | 86 | DupiConfig['config'] = config 87 | 88 | -------------------------------------------------------------------------------- /config.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | ########################################################################## 4 | # dupinanny backup scripts for duplicity 5 | # Copyright (C) 2008 Timothee Besset 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | ########################################################################## 20 | 21 | import os, re 22 | 23 | from optparse import OptionParser 24 | 25 | class ConfigBase: 26 | def __init__( self, dupi ): 27 | self.dupi = dupi 28 | self.config = dupi['config'] 29 | 30 | self.lockfile = self.config['lockfile'] 31 | 32 | # NOTE: may get an override from command line 33 | self.dry_run = False 34 | try: 35 | self.dry_run = self.config['dry_run'] 36 | except: 37 | pass 38 | 39 | self.duplicity = 'duplicity' 40 | try: 41 | self.duplicity = self.config['duplicity'] 42 | except: 43 | pass 44 | 45 | self.remove_older = 4 46 | try: 47 | self.remove_older = self.config['remove_older'] 48 | except: 49 | pass 50 | 51 | def commandLineOverrides( self, options ): 52 | if ( options.dry_run ): 53 | self.dry_run = options.dry_run 54 | 55 | self.cleanup = options.cleanup 56 | if ( self.cleanup ): 57 | self.dry_run = True 58 | 59 | self.force_remove_older = False 60 | if ( not options.remove_older is None ): 61 | self.remove_older = options.remove_older 62 | print '*** command line override for remove_older: %d ***' % self.remove_older 63 | self.force_remove_older = True 64 | self.dry_run = True 65 | 66 | if ( self.dry_run ): 67 | print '*** running in test mode ***' 68 | 69 | self.full = options.full 70 | if ( self.full ): 71 | print '*** FLAGING FULL BACKUP ***' 72 | 73 | def readConfig( cmdargs ): 74 | 75 | parser = OptionParser() 76 | parser.add_option( '--dry-run', action = 'store_true', dest = 'dry_run', help = 'show commands, do not execute except collection-status' ) 77 | parser.add_option( '--cleanup', action = 'store_true', dest = 'cleanup', help = 'cleanup only, implies --dry-run' ) 78 | parser.add_option( '--remove-older', action = 'store', type = 'int', dest = 'remove_older', default = None, help = 'run remove_old only, with the given value. implies --dry-run (set the value in the config to customize for each run and do other operations)' ) 79 | parser.add_option( '--config', action = 'store', type = 'string', dest = 'configFile', default = 'config.cfg.example', help = 'use this config file' ) 80 | parser.add_option( '--full', action = 'store_true', dest = 'full', help = 'force a full backup. will retry for each backup target if necessary until full backups are done' ) 81 | ( options, args ) = parser.parse_args( cmdargs ) 82 | 83 | globals = {} 84 | locals = {} 85 | try: 86 | execfile( options.configFile, globals, locals ) 87 | except: 88 | print 'exception raised while reading config file %s' % options.configFile 89 | raise 90 | if ( not locals.has_key( 'DupiConfig' ) ): 91 | raise 'DupiConfig dictionary was not defined' 92 | DupiConfig = locals['DupiConfig'] 93 | 94 | # setup default backup class if needed 95 | if ( not DupiConfig.has_key( 'backup' ) ): 96 | from backup import Backup 97 | DupiConfig['backup'] = Backup( DupiConfig ) 98 | 99 | DupiConfig['backup'].commandLineOverrides( options ) 100 | 101 | return DupiConfig 102 | 103 | if ( __name__ == '__main__' ): 104 | readConfig() 105 | 106 | -------------------------------------------------------------------------------- /lock.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | ########################################################################## 4 | # dupinanny backup scripts for duplicity 5 | # Copyright (C) 2008 Timothee Besset 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | ########################################################################## 20 | 21 | # a class version for easy lock operation based on the portalocker module 22 | # NOTE: the lock has to be released and does not expire 23 | # when the object goes out of scope it will try to release 24 | 25 | import sys, os, pickle, portalocker, datetime, time, platform, subprocess 26 | 27 | class lock( object ): 28 | def __init__( self, lockfile, lockinfo, debug = True ): 29 | self.lockfile = lockfile 30 | self.lockinfo = lockinfo 31 | self.handle = None 32 | self.debug = debug 33 | 34 | def checkProcessExists( self, pid ): 35 | if ( platform.system() == 'Linux' ): 36 | return os.path.exists( '/proc/%d' % pid ) 37 | if ( platform.system() == 'Darwin' ): 38 | # surely there's a better way.. 39 | try: 40 | subprocess.check_call( [ 'ps', '-p', '%d' % pid ], stdout = subprocess.PIPE, stderr = subprocess.PIPE ) 41 | # if this succeeded, then there is a process 42 | return True 43 | except: 44 | return False 45 | raise Exception( 'Need support for checking for process existence on platform %s' % platform.system() ) 46 | 47 | def checkValidLock( self ): 48 | if ( not os.path.exists( self.lockfile ) ): 49 | return False 50 | handle = file( self.lockfile ) 51 | lock_pid = pickle.load( handle ) 52 | lock_expire = pickle.load( handle ) 53 | lock_info = pickle.load( handle ) 54 | handle.close() 55 | if ( not self.checkProcessExists( lock_pid ) ): 56 | if ( self.debug ): 57 | print '%s: stale lock, no such pid %d (%s)' % ( self.lockfile, lock_pid, repr( lock_info ) ) 58 | os.unlink( self.lockfile ) 59 | return False 60 | if ( lock_expire is None ): 61 | if ( self.debug ): 62 | print '%s: active lock pid %d, does not expire (%s)' % ( self.lockfile, lock_pid, repr( lock_info ) ) 63 | return True 64 | s_lock_expire = lock_expire.ctime() 65 | if ( datetime.datetime.now() > lock_expire ): 66 | if ( self.debug ): 67 | print '%s: active lock pid %d, expired at %s (%s)' % ( self.lockfile, lock_pid, s_lock_expire, repr( lock_info ) ) 68 | # TODO: what now 69 | # we reply that the lock is active however (could recurse a call to checkValidLock again) 70 | # if I own the lock however, nuke it now 71 | if ( lock_pid == os.getpid() ): 72 | print 'my own lock - remove' 73 | os.unlink( self.lockfile ) 74 | return True 75 | if ( self.debug ): 76 | print '%s: active lock pid %d, expires at %s (%s)' % ( self.lockfile, lock_pid, s_lock_expire, repr( lock_info ) ) 77 | return True 78 | 79 | # pass a total time to wait, 0 for forever, None for abort right away on lock 80 | # expire indicates when the lock will expire, meaning we allow some other process to steal it, possibly after making sure to kill a stalled AB process 81 | # pass None as expire for no expiration 82 | # NOTE: we may need functionality to extend the expiration on an acquired lock 83 | def acquire( self, wait = 5 * 60, waitInterval = 5, expire = 10 * 60 ): 84 | waitTotal = 0 85 | while ( self.checkValidLock() ): 86 | if ( wait is None ): 87 | raise Exception( 'lock is busy' ) 88 | else: 89 | if ( wait != 0 ): 90 | waitTotal += waitInterval 91 | if ( self.debug ): 92 | print( 'waitTotal: %d wait: %d waitInterval: %d' % ( waitTotal, wait, waitInterval ) ) 93 | if ( waitTotal > wait ): 94 | raise Exception( 'exceeded max wait time on the lock' ) 95 | time.sleep( waitInterval ) 96 | 97 | # don't want blocking on acquired locks - even with the loop, there is still a possibility of stolen lock and exception here 98 | self.handle = file( self.lockfile, 'w' ) 99 | portalocker.lock( self.handle, portalocker.LOCK_EX | portalocker.LOCK_NB ) 100 | if ( self.debug ): 101 | print( 'acquired lock %s' % self.lockfile ) 102 | pickle.dump( os.getpid(), self.handle ) 103 | if ( expire is None ): 104 | expire_time = None 105 | else: 106 | expire_time = datetime.datetime.now() 107 | expire_time += datetime.timedelta( seconds = expire ) 108 | pickle.dump( expire_time, self.handle ) 109 | pickle.dump( self.lockinfo, self.handle ) 110 | self.handle.flush() 111 | 112 | def release( self ): 113 | if ( not self.handle is None ): 114 | # possible that some other script would print a message about the lock in between the close and the unlink 115 | self.handle.close() 116 | os.unlink( self.lockfile ) 117 | self.handle = None 118 | 119 | # don't rely on this - from the python documentation: 120 | # "It is not guaranteed that __del__() methods are called for objects that still exist when the interpreter exits." 121 | def __del__( self ): 122 | self.release() 123 | 124 | if ( __name__ == '__main__' ): 125 | l = lock( os.path.expanduser( '~/testlock' ), 'testlock' ) 126 | l.acquire( wait = 60 ) 127 | print 'acquired. press enter' 128 | sys.stdin.readline() 129 | # doing the release in the __del__ doesn't seem to work too well 130 | l.release() 131 | -------------------------------------------------------------------------------- /portalocker.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # portalocker.py - Cross-platform (posix/nt) API for flock-style file locking. 3 | # Requires python 1.5.2 or better. 4 | # See http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/65203/index_txt 5 | # Except where otherwise noted, recipes in the Python Cookbook are 6 | # published under the Python license. 7 | 8 | """Cross-platform (posix/nt) API for flock-style file locking. 9 | 10 | Synopsis: 11 | 12 | import portalocker 13 | file = open("somefile", "r+") 14 | portalocker.lock(file, portalocker.LOCK_EX) 15 | file.seek(12) 16 | file.write("foo") 17 | file.close() 18 | 19 | If you know what you're doing, you may choose to 20 | 21 | portalocker.unlock(file) 22 | 23 | before closing the file, but why? 24 | 25 | Methods: 26 | 27 | lock( file, flags ) 28 | unlock( file ) 29 | 30 | Constants: 31 | 32 | LOCK_EX 33 | LOCK_SH 34 | LOCK_NB 35 | 36 | I learned the win32 technique for locking files from sample code 37 | provided by John Nielsen in the documentation 38 | that accompanies the win32 modules. 39 | 40 | Author: Jonathan Feinberg 41 | Version: $Id: portalocker.py,v 1.3 2001/05/29 18:47:55 Administrator Exp $ 42 | """ 43 | import os 44 | 45 | if os.name == 'nt': 46 | import win32con 47 | import win32file 48 | import pywintypes 49 | LOCK_EX = win32con.LOCKFILE_EXCLUSIVE_LOCK 50 | LOCK_SH = 0 # the default 51 | LOCK_NB = win32con.LOCKFILE_FAIL_IMMEDIATELY 52 | # is there any reason not to reuse the following structure? 53 | __overlapped = pywintypes.OVERLAPPED() 54 | elif os.name == 'posix': 55 | import fcntl 56 | LOCK_EX = fcntl.LOCK_EX 57 | LOCK_SH = fcntl.LOCK_SH 58 | LOCK_NB = fcntl.LOCK_NB 59 | else: 60 | raise RuntimeError("PortaLocker only defined for nt and posix platforms") 61 | 62 | if os.name == 'nt': 63 | def lock(file, flags): 64 | hfile = win32file._get_osfhandle(file.fileno()) 65 | win32file.LockFileEx(hfile, flags, 0, -0x10000, __overlapped) 66 | 67 | def unlock(file): 68 | hfile = win32file._get_osfhandle(file.fileno()) 69 | win32file.UnlockFileEx(hfile, 0, -0x10000, __overlapped) 70 | 71 | elif os.name =='posix': 72 | def lock(file, flags): 73 | fcntl.flock(file.fileno(), flags) 74 | 75 | def unlock(file): 76 | fcntl.flock(file.fileno(), fcntl.LOCK_UN) 77 | 78 | if __name__ == '__main__': 79 | from time import time, strftime, localtime 80 | import sys 81 | import portalocker 82 | 83 | log = open('log.txt', "a+") 84 | portalocker.lock(log, portalocker.LOCK_EX) 85 | 86 | timestamp = strftime("%m/%d/%Y %H:%M:%S\n", localtime(time())) 87 | log.write( timestamp ) 88 | 89 | print "Wrote lines. Hit enter to release lock." 90 | dummy = sys.stdin.readline() 91 | 92 | log.close() 93 | 94 | --------------------------------------------------------------------------------