├── TODO ├── debian ├── compat ├── source │ └── format ├── install ├── copyright ├── apt-btrfs-snapshot.cron.weekly ├── rules ├── control └── changelog ├── setup.cfg ├── .bzr-builddeb └── default.conf ├── po └── POTFILES.in ├── test ├── data │ ├── fstab.bug833980 │ ├── fstab.bug872145 │ ├── fstab.no-btrfs │ ├── fstab │ └── fstab.bug806065 ├── test_pyflakes.py └── test_apt_btrfs_snapshot.py ├── data └── 80-btrfs-snapshot ├── setup.py ├── apt-btrfs-snapshot ├── apt_btrfs_snapshot.py └── GPL /TODO: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /debian/compat: -------------------------------------------------------------------------------- 1 | 7 2 | -------------------------------------------------------------------------------- /debian/source/format: -------------------------------------------------------------------------------- 1 | 3.0 (native) 2 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [build] 2 | i18n=True 3 | -------------------------------------------------------------------------------- /.bzr-builddeb/default.conf: -------------------------------------------------------------------------------- 1 | [BUILDDEB] 2 | native = True 3 | -------------------------------------------------------------------------------- /debian/install: -------------------------------------------------------------------------------- 1 | data/80-btrfs-snapshot etc/apt/apt.conf.d/ 2 | -------------------------------------------------------------------------------- /po/POTFILES.in: -------------------------------------------------------------------------------- 1 | apt-btrfs-snapshot 2 | apt_btrfs_snapshot.py 3 | -------------------------------------------------------------------------------- /test/data/fstab.bug833980: -------------------------------------------------------------------------------- 1 | # random header 2 | 3 | # line with comment in it 4 | UUID=yyy-5a64-4ce1-905f-xxx / btrfs defaults,noatime,subvol=@ 0 1 -------------------------------------------------------------------------------- /data/80-btrfs-snapshot: -------------------------------------------------------------------------------- 1 | DPkg::Pre-Invoke {"if [ -x /usr/bin/apt-btrfs-snapshot ] && apt-btrfs-snapshot supported; then apt-btrfs-snapshot snapshot; fi "; }; 2 | -------------------------------------------------------------------------------- /test/data/fstab.bug872145: -------------------------------------------------------------------------------- 1 | # random header 2 | 3 | # line with comment in it 4 | UUID=yyy-5a64-4ce1-905f-xxx / btrfs defaults,subvol=@ 0 1 #/dev/sda2 5 | 6 | # line with additional data at the end (c.f. #873411 comment #7 7 | UUID=yyy-5a64-4ce1-905f-xxx / btrfs defaults,subvol=@ 0 1 0 0 -------------------------------------------------------------------------------- /test/test_pyflakes.py: -------------------------------------------------------------------------------- 1 | import subprocess 2 | import unittest 3 | 4 | class TestPyflakesClean(unittest.TestCase): 5 | """ ensure that the tree is pyflakes clean """ 6 | 7 | def test_pyflakes_clean(self): 8 | self.assertEqual(subprocess.call(["pyflakes", "."]), 0) 9 | 10 | 11 | if __name__ == "__main__": 12 | unittest.main() 13 | -------------------------------------------------------------------------------- /debian/copyright: -------------------------------------------------------------------------------- 1 | This package was debianized by Michael Vogt on Fri, 2 | 16 Feb 2011 10:10:41 +0100. 3 | 4 | It was downloaded via bzr from 5 | https://launchpad.net/apt-btrfs-snapshot 6 | 7 | Upstream Author: Michael Vogt 8 | 9 | Copyright (c) 2011 Canonical Ltd 10 | 11 | Copyright: GPL, see /usr/share/common-licenses/GPL 12 | 13 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from distutils.core import setup 4 | from DistUtilsExtra.command import build_i18n, build_extra 5 | 6 | setup(name='apt-btrfs-snapshot', 7 | version='0.1', 8 | author='Michael Vogt', 9 | url='http://launchpad.net/apt-btrfs-snapshot', 10 | scripts=['apt-btrfs-snapshot'], 11 | py_modules=['apt_btrfs_snapshot'], 12 | cmdclass = { 13 | "build" : build_extra.build_extra, 14 | "build_i18n" : build_i18n.build_i18n, 15 | } 16 | ) 17 | -------------------------------------------------------------------------------- /debian/apt-btrfs-snapshot.cron.weekly: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | set -e 4 | 5 | # check if its there 6 | if [ ! -x /usr/bin/apt-btrfs-snapshot ]; then 7 | exit 0 8 | fi 9 | 10 | # check if its usable, if list returns a non-zero exit code, 11 | # we probably run on a system with no snapshot support 12 | if ! /usr/bin/apt-btrfs-snapshot list > /dev/null 2>&1; then 13 | exit 0 14 | fi 15 | 16 | # allow the user to set MaxAge (in days) 17 | MaxAge=90 18 | eval $(apt-config shell MaxAge APT::Snapshots::MaxAge) 19 | 20 | # delete old snapshots 21 | apt-btrfs-snapshot delete-older-than "${MaxAge}d" 22 | 23 | -------------------------------------------------------------------------------- /debian/rules: -------------------------------------------------------------------------------- 1 | #!/usr/bin/make -f 2 | PYTHON2:=$(shell pyversions -r) 3 | PYTHON3:=$(shell py3versions -r) 4 | py3sdo=set -e; $(foreach py, $(PYTHON3), $(py) $(1);) 5 | pyalldo=set -e; $(foreach py, $(PYTHON2) $(PYTHON3), $(py) $(1);) 6 | 7 | %: 8 | dh $@ --with python2,python3 9 | 10 | ifeq (,$(filter nocheck,$(DEB_BUILD_OPTIONS))) 11 | override_dh_auto_test: 12 | $(call pyalldo, -m unittest discover -vv test/) 13 | endif 14 | 15 | override_dh_auto_build: 16 | dh_auto_build 17 | $(call py3sdo, setup.py build) 18 | 19 | override_dh_auto_install: 20 | dh_auto_install 21 | $(call py3sdo, setup.py install --root=$(CURDIR)/debian/apt-btrfs-snapshot --install-layout=deb) 22 | 23 | override_dh_auto_clean: 24 | dh_auto_clean 25 | rm -rf build 26 | rm -rf *.egg-info 27 | 28 | -------------------------------------------------------------------------------- /test/data/fstab.no-btrfs: -------------------------------------------------------------------------------- 1 | # /etc/fstab: static file system information. 2 | # 3 | # Use 'blkid -o value -s UUID' to print the universally unique identifier 4 | # for a device; this may be used with UUID= as a more robust way to name 5 | # devices that works even if disks are added and removed. See fstab(5). 6 | # 7 | # 8 | proc /proc proc nodev,noexec,nosuid 0 0 9 | # / was on /dev/sdb1 during installation 10 | UUID=2de624aa-76e7-4495-bb51-57a4f6be4cf6 / ext4 errors=remount-ro 0 1 11 | # swap was on /dev/sda5 during installation 12 | UUID=3e8ca557-3c47-4c9f-b210-a2ace692dec3 none swap sw 0 0 13 | 14 | # space 15 | UUID=e47814ee-ba9f-4c65-98cd-6f92a7fe26ba /space ext4 defaults 0 0 16 | -------------------------------------------------------------------------------- /test/data/fstab: -------------------------------------------------------------------------------- 1 | # /etc/fstab: static file system information. 2 | # 3 | # Use 'blkid -o value -s UUID' to print the universally unique identifier 4 | # for a device; this may be used with UUID= as a more robust way to name 5 | # devices that works even if disks are added and removed. See fstab(5). 6 | # 7 | # 8 | proc /proc proc nodev,noexec,nosuid 0 0 9 | # / was on /dev/sda1 during installation 10 | UUID=fe63f598-1906-478e-acc7-f74740e78d1f / btrfs defaults,subvol=@ 0 1 11 | # /home was on /dev/sda1 during installation 12 | UUID=fe63f598-1906-478e-acc7-f74740e78d1f /home btrfs defaults,subvol=@home 0 2 13 | # swap was on /dev/sda5 during installation 14 | UUID=c0c840b3-8e08-4152-b91e-512e03cf39d4 none swap sw 0 0 15 | 16 | 17 | 18 | UUID=fe63f598-1906-478e-acc7-f74740e78d1f /btrfs-root btrfs defaults 0 1 19 | -------------------------------------------------------------------------------- /debian/control: -------------------------------------------------------------------------------- 1 | Source: apt-btrfs-snapshot 2 | Section: admin 3 | Priority: optional 4 | Maintainer: Michael Vogt 5 | Build-Depends: debhelper (>= 7.0.50~), 6 | python3, 7 | python3-distutils-extra, 8 | python3-mock, 9 | pyflakes, 10 | python (>= 2.6.5-2~), 11 | python-distutils-extra, 12 | python-mock, 13 | X-Python-Version: all 14 | X-Python3-Version: >= 3.2 15 | Standards-Version: 3.9.3 16 | Vcs-Bzr: https://code.launchpad.net/apt-btrfs-snapshot 17 | 18 | Package: apt-btrfs-snapshot 19 | Architecture: all 20 | Depends: ${python:Depends}, 21 | ${python3:Depends}, 22 | ${misc:Depends}, 23 | btrfs-tools 24 | Description: Automatically create snapshot on apt operations 25 | This will create a btrfs snapshot of the root filesystem each time 26 | that apt installs/removes/upgrades a software package. 27 | . 28 | A commandline tool called "apt-btrfs-snapshot" is also provided 29 | for easy access create/list/delete snapshots. 30 | -------------------------------------------------------------------------------- /test/data/fstab.bug806065: -------------------------------------------------------------------------------- 1 | # /etc/fstab: static file system information. 2 | # 3 | # Use 'blkid -o value -s UUID' to print the universally unique identifier 4 | # for a device; this may be used with UUID= as a more robust way to name 5 | # devices that works even if disks are added and removed. See fstab(5). 6 | # 7 | # 8 | proc /proc proc nodev,noexec,nosuid 0 0 9 | # / was on /dev/sda4 during installation 10 | UUID=5af64eac-35f3-4e4a-b9d1-083a9505ea5a / ext4 errors=remount-ro 0 1 11 | # swap was on /dev/sda5 during installation 12 | UUID=938ee3cd-50c4-4a3a-a26b-8019cbba537f none swap sw 0 0 13 | 192.168.0.150:/srv/Media /home/p-i/NASMedia nfs rsize=8192,wsize=8192,timeo=14,intr 14 | 192.168.0.150:/srv/Anvandare/p-i/NASDokument /home/p-i/NASDokument nfs rsize=8192,wsize=8192,timeo=14,intr 15 | 192.168.0.150:/srv/Anvandare/p-i/NASMail /home/p-i/NASMail nfs rsize=8192,wsize=8192,timeo=14,intr 16 | /dev/sr0 /media/cdrw udf,iso9660 users,noauto,rw 0 0 17 | -------------------------------------------------------------------------------- /debian/changelog: -------------------------------------------------------------------------------- 1 | apt-btrfs-snapshot (0.3.1) quantal; urgency=low 2 | 3 | * Add missing build dependency on pyflakes for test_pyflakes.py 4 | 5 | -- Dmitrijs Ledkovs Tue, 12 Jun 2012 12:10:17 +0100 6 | 7 | apt-btrfs-snapshot (0.3) quantal; urgency=low 8 | 9 | [ Michael Vogt ] 10 | * apt_btrfs_snapshot.py, test/test_apt_btrfs_snapshot.py: 11 | - disable "delete-older-than" command if noatime is in use on 12 | the snapshot fs (LP: #833980) 13 | * merge lp:~brian-murray/apt-btrfs-snapshot/fix-vcs/, many thanks! 14 | * apt_btrfs_snapshot.py: 15 | - be even more robust against invalid fstab entries 16 | (LP: #873411 comment #7) 17 | * test/test_pyflakes.py: 18 | - add test that ensures that its pyflakes clean 19 | 20 | [ Dmitrijs Ledkovs ] 21 | * apt_btrfs_snapshot.py, apt-btrfs-snapshot: 22 | - port to python3 23 | * apt_btrfs_snapshot.py: 24 | - fix pyflakes warning use 'AptBtrfsNotSupportedError' instead of 25 | undefined name 'AptBtrfsSnapshotNotSupportedError' 26 | * test/test_apt_btrfs_snapshot.py: 27 | - remove unused imports 'LowLevelCommands' and 'apt_btrfs_snapshot' 28 | - mock sys.stdout and sys.stderr to avoid confusing and spurious output 29 | - mock /sbin/btrfs to allow running unit-tests without btrfs-tools 30 | * debian/rules: 31 | - build with supported versions of python2 and python3 32 | - run unittests at build time, honoring nocheck 33 | * debian/control: 34 | - adjust dependencies for python3 support 35 | - bump standards version to 3.9.3 36 | 37 | -- Michael Vogt Tue, 12 Jun 2012 12:06:31 +0200 38 | 39 | apt-btrfs-snapshot (0.2.1build1) precise; urgency=low 40 | 41 | * Rebuild to drop python2.6 dependencies. 42 | 43 | -- Matthias Klose Sat, 31 Dec 2011 02:00:37 +0000 44 | 45 | apt-btrfs-snapshot (0.2.1) oneiric; urgency=low 46 | 47 | * test/test_apt_btrfs_snapshot.py, test/data/fstab.bug872145: 48 | - fix crash in fstab parsing (LP: #872145) 49 | * apt_btrfs_snapshot.py: 50 | - test for /sbin/btrfs in snapshot_supported() as well (LP: #800908) 51 | 52 | -- Michael Vogt Tue, 11 Oct 2011 10:17:41 +0200 53 | 54 | apt-btrfs-snapshot (0.2) oneiric; urgency=low 55 | 56 | * return the right exit status when apt-btrfs-snapshot 57 | set-default is used 58 | * use argparse instead of home grown parser and add help 59 | * add i18n 60 | 61 | -- Michael Vogt Wed, 20 Jul 2011 09:14:17 +0200 62 | 63 | apt-btrfs-snapshot (0.1.3) oneiric; urgency=low 64 | 65 | * apt-btrfs-snapshot: 66 | - add "delete-older-than" command 67 | * debian/apt-btrfs-snapshot.cron.weekly: 68 | - add cronjob to allow deleting old snapshots, defaulting to 69 | 90 days (but overridable with the apt config variable 70 | APT::Snapshots::MaxAge) 71 | 72 | -- Michael Vogt Tue, 19 Jul 2011 10:44:15 +0200 73 | 74 | apt-btrfs-snapshot (0.1.2) oneiric; urgency=low 75 | 76 | * ignore fs_freq and fs_passno in fstab if they don't exit, 77 | and add regression test (LP: #806065) 78 | 79 | -- Michael Vogt Wed, 06 Jul 2011 17:06:36 +0200 80 | 81 | apt-btrfs-snapshot (0.1.1) natty; urgency=low 82 | 83 | * added TODO 84 | * move functionality into module for easy import from e.g. 85 | update-manager 86 | * apt-btrfs-snapshot: 87 | - add supported argument 88 | - fix exit codes 89 | * data/80-btrfs-snapshot: 90 | - only snapshot if the system supports snapshots 91 | 92 | -- Michael Vogt Wed, 16 Feb 2011 17:52:48 +0100 93 | 94 | apt-btrfs-snapshot (0.1) natty; urgency=low 95 | 96 | * Initial Release. 97 | 98 | -- Michael Vogt Wed, 16 Feb 2011 15:36:10 +0100 99 | 100 | -------------------------------------------------------------------------------- /apt-btrfs-snapshot: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python3 2 | # Copyright (C) 2011 Canonical 3 | # 4 | # Author: 5 | # Michael Vogt 6 | # 7 | # This program is free software; you can redistribute it and/or modify it under 8 | # the terms of the GNU General Public License as published by the Free Software 9 | # Foundation; version 3. 10 | # 11 | # This program is distributed in the hope that it will be useful, but WITHOUT 12 | # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 13 | # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 14 | # details. 15 | # 16 | # You should have received a copy of the GNU General Public License along with 17 | # this program; if not, write to the Free Software Foundation, Inc., 18 | # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 19 | 20 | import argparse 21 | import datetime 22 | import logging 23 | import os 24 | import string 25 | import subprocess 26 | import sys 27 | import tempfile 28 | 29 | import gettext 30 | from gettext import gettext as _ 31 | 32 | from apt_btrfs_snapshot import AptBtrfsSnapshot 33 | 34 | if __name__ == "__main__": 35 | 36 | gettext.bindtextdomain("apt-btrfs-snapshot") 37 | 38 | # command line parser 39 | description = _("Filesystem snapshot support for apt") 40 | parser = argparse.ArgumentParser(description=description) 41 | parser.add_argument("--debug", action="store_true", default=False, 42 | help="enable debug output") 43 | subparser = parser.add_subparsers(title="Commands") 44 | # supported 45 | command = subparser.add_parser( 46 | "supported", help=_("Print if snapshots are supported")) 47 | command.set_defaults(command="supported") 48 | # list 49 | command = subparser.add_parser( 50 | "list", help=_("List available snapshots")) 51 | command.set_defaults(command="list") 52 | # snapshot 53 | command = subparser.add_parser( 54 | "snapshot", help=_("Create a new snapshot")) 55 | command.set_defaults(command="snapshot") 56 | # set-default 57 | command = subparser.add_parser( 58 | "set-default", help=_("Revert to previous snapshot")) 59 | command.add_argument("snapshot") 60 | command.set_defaults(command="set-default") 61 | # delete 62 | command = subparser.add_parser( 63 | "delete", help=_("Delete snapshot")) 64 | command.add_argument("snapshot") 65 | command.set_defaults(command="delete") 66 | # list-older-than 67 | command = subparser.add_parser( 68 | "list-older-than", help=_("Show snapshots older than N days")) 69 | command.add_argument("time") 70 | command.set_defaults(command="list-older-than") 71 | # delete-older-than 72 | command = subparser.add_parser( 73 | "delete-older-than", help=_("Delete snapshots older than N days")) 74 | command.add_argument("time") 75 | command.set_defaults(command="delete-older-than") 76 | 77 | # parse args 78 | args = parser.parse_args() 79 | 80 | # global options 81 | if args.debug: 82 | logging.basicConfig(level=logging.DEBUG) 83 | else: 84 | logging.basicConfig(level=logging.INFO) 85 | 86 | if os.getuid() != 0: 87 | print(_("Sorry, you need to be root to run this program")) 88 | sys.exit(1) 89 | 90 | apt_btrfs = AptBtrfsSnapshot() 91 | if not apt_btrfs.snapshots_supported(): 92 | print(_("Sorry, your system lacks support for the snapshot feature")) 93 | sys.exit(1) 94 | 95 | res = False 96 | if args.command == "supported": 97 | res = apt_btrfs.snapshots_supported() 98 | if res: 99 | print(_("Supported")) 100 | else: 101 | print(_("Not supported")) 102 | elif args.command == "snapshot": 103 | res = apt_btrfs.create_btrfs_root_snapshot() 104 | elif args.command == "list": 105 | res = apt_btrfs.print_btrfs_root_snapshots() 106 | elif args.command == "set-default": 107 | res = apt_btrfs.command_set_default(args.snapshot) 108 | elif args.command == "delete": 109 | res = apt_btrfs.delete_snapshot(args.snapshot) 110 | elif args.command == "list-older-than": 111 | res = apt_btrfs.print_btrfs_root_snapshots_older_than(args.time) 112 | elif args.command == "delete-older-than": 113 | res = apt_btrfs.clean_btrfs_root_snapshots_older_than(args.time) 114 | else: 115 | print(_("ERROR: Unhandled command: '%s'") % args.command) 116 | 117 | # return the right exit code 118 | if res: 119 | sys.exit(0) 120 | else: 121 | sys.exit(1) 122 | 123 | 124 | 125 | 126 | -------------------------------------------------------------------------------- /test/test_apt_btrfs_snapshot.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | try: 4 | from StringIO import StringIO 5 | StringIO # pyflakes 6 | except ImportError: 7 | from io import StringIO 8 | import mock 9 | import os 10 | import sys 11 | import time 12 | import unittest 13 | 14 | sys.path.insert(0, "..") 15 | sys.path.insert(0, ".") 16 | from apt_btrfs_snapshot import ( 17 | AptBtrfsSnapshot, 18 | AptBtrfsRootWithNoatimeError, 19 | ) 20 | 21 | class TestFstab(unittest.TestCase): 22 | 23 | def setUp(self): 24 | self.testdir = os.path.dirname(os.path.abspath(__file__)) 25 | 26 | @mock.patch('os.path.exists') 27 | def test_fstab_detect_snapshot(self, mock_commands): 28 | #Using python-mock 0.7 style, for precise compatibility 29 | mock_commands.side_effect = lambda f: f in ('/sbin/btrfs') 30 | apt_btrfs = AptBtrfsSnapshot( 31 | fstab=os.path.join(self.testdir, "data", "fstab")) 32 | self.assertTrue(apt_btrfs.snapshots_supported()) 33 | apt_btrfs = AptBtrfsSnapshot( 34 | fstab=os.path.join(self.testdir, "data", "fstab.no-btrfs")) 35 | self.assertFalse(apt_btrfs.snapshots_supported()) 36 | apt_btrfs = AptBtrfsSnapshot( 37 | fstab=os.path.join(self.testdir, "data", "fstab.bug806065")) 38 | self.assertFalse(apt_btrfs.snapshots_supported()) 39 | apt_btrfs = AptBtrfsSnapshot( 40 | fstab=os.path.join(self.testdir, "data", "fstab.bug872145")) 41 | self.assertTrue(apt_btrfs.snapshots_supported()) 42 | 43 | def test_fstab_get_uuid(self): 44 | apt_btrfs = AptBtrfsSnapshot( 45 | fstab=os.path.join(self.testdir, "data", "fstab")) 46 | self.assertEqual(apt_btrfs._uuid_for_mountpoint("/"), 47 | "UUID=fe63f598-1906-478e-acc7-f74740e78d1f") 48 | 49 | @mock.patch('sys.stdout') 50 | @mock.patch('sys.stderr') 51 | def test_fstab_noatime(self, mock_stdout, mock_stderr): 52 | mock_stdout.side_effect = StringIO() 53 | mock_stderr.side_effect = StringIO() 54 | apt_btrfs = AptBtrfsSnapshot( 55 | fstab=os.path.join(self.testdir, "data", "fstab.bug833980")) 56 | # ensure our test is right 57 | entry = apt_btrfs._get_supported_btrfs_root_fstab_entry() 58 | self.assertTrue("noatime" in entry.options) 59 | # ensure we get the right exception 60 | self.assertRaises(AptBtrfsRootWithNoatimeError, 61 | apt_btrfs.get_btrfs_root_snapshots_list, 62 | "1d") 63 | # and the right return codes from the commands 64 | self.assertEqual(apt_btrfs.clean_btrfs_root_snapshots_older_than("1d"), 65 | False) 66 | self.assertEqual(apt_btrfs.print_btrfs_root_snapshots_older_than("1d"), 67 | False) 68 | 69 | @mock.patch('apt_btrfs_snapshot.LowLevelCommands') 70 | def test_mount_btrfs_root_volume(self, mock_commands): 71 | apt_btrfs = AptBtrfsSnapshot( 72 | fstab=os.path.join(self.testdir, "data", "fstab")) 73 | mock_commands.mount.return_value = True 74 | mock_commands.umount.return_value = True 75 | mp = apt_btrfs.mount_btrfs_root_volume() 76 | self.assertTrue("apt-btrfs-snapshot-mp-" in mp) 77 | self.assertTrue(apt_btrfs.umount_btrfs_root_volume()) 78 | self.assertFalse(os.path.exists(mp)) 79 | 80 | @mock.patch('apt_btrfs_snapshot.LowLevelCommands') 81 | def test_btrfs_create_snapshot(self, mock_commands): 82 | # setup mock 83 | mock_commands.btrfs_subvolume_snapshot.return_value = True 84 | mock_commands.mount.return_value = True 85 | mock_commands.umount.return_value = True 86 | # do it 87 | apt_btrfs = AptBtrfsSnapshot( 88 | fstab=os.path.join(self.testdir, "data", "fstab")) 89 | res = apt_btrfs.create_btrfs_root_snapshot() 90 | # check results 91 | self.assertTrue(apt_btrfs.commands.mount.called) 92 | self.assertTrue(apt_btrfs.commands.umount.called) 93 | self.assertTrue(res) 94 | self.assertTrue(apt_btrfs.commands.btrfs_subvolume_snapshot.called) 95 | (args, kwargs) = apt_btrfs.commands.btrfs_subvolume_snapshot.call_args 96 | self.assertTrue(len(args), 2) 97 | self.assertTrue(args[0].endswith("@")) 98 | self.assertTrue("@apt-snapshot-" in args[1]) 99 | # again with a additional prefix for the snapshot 100 | res = apt_btrfs.create_btrfs_root_snapshot("release-upgrade-natty-") 101 | (args, kwargs) = apt_btrfs.commands.btrfs_subvolume_snapshot.call_args 102 | self.assertTrue("@apt-snapshot-release-upgrade-natty-" in args[1]) 103 | 104 | @mock.patch('apt_btrfs_snapshot.LowLevelCommands') 105 | def test_btrfs_delete_snapshot(self, mock_commands): 106 | # setup mock 107 | mock_commands.btrfs_delete_snapshot.return_value = True 108 | mock_commands.mount.return_value = True 109 | mock_commands.umount.return_value = True 110 | # do it 111 | apt_btrfs = AptBtrfsSnapshot( 112 | fstab=os.path.join(self.testdir, "data", "fstab")) 113 | res = apt_btrfs.delete_snapshot("lala") 114 | self.assertTrue(res) 115 | self.assertTrue(apt_btrfs.commands.mount.called) 116 | self.assertTrue(apt_btrfs.commands.umount.called) 117 | self.assertTrue(apt_btrfs.commands.btrfs_delete_snapshot.called) 118 | (args, kwargs) = apt_btrfs.commands.btrfs_delete_snapshot.call_args 119 | self.assertTrue(args[0].endswith("/lala")) 120 | 121 | def test_parser_older_than_to_unixtime(self): 122 | apt_btrfs = AptBtrfsSnapshot( 123 | fstab=os.path.join(self.testdir, "data", "fstab")) 124 | t = apt_btrfs._parse_older_than_to_unixtime("5d") 125 | self.assertTrue( t < time.time() - 5*60*60*24) 126 | 127 | if __name__ == "__main__": 128 | unittest.main() 129 | -------------------------------------------------------------------------------- /apt_btrfs_snapshot.py: -------------------------------------------------------------------------------- 1 | # Copyright (C) 2011 Canonical 2 | # 3 | # Author: 4 | # Michael Vogt 5 | # 6 | # This program is free software; you can redistribute it and/or modify it under 7 | # the terms of the GNU General Public License as published by the Free Software 8 | # Foundation; version 3. 9 | # 10 | # This program is distributed in the hope that it will be useful, but WITHOUT 11 | # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 12 | # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more 13 | # details. 14 | # 15 | # You should have received a copy of the GNU General Public License along with 16 | # this program; if not, write to the Free Software Foundation, Inc., 17 | # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 18 | 19 | from __future__ import print_function, unicode_literals 20 | 21 | import datetime 22 | import os 23 | import subprocess 24 | import sys 25 | import time 26 | import tempfile 27 | 28 | 29 | class AptBtrfsSnapshotError(Exception): 30 | pass 31 | 32 | 33 | class AptBtrfsNotSupportedError(AptBtrfsSnapshotError): 34 | pass 35 | 36 | 37 | class AptBtrfsRootWithNoatimeError(AptBtrfsSnapshotError): 38 | pass 39 | 40 | 41 | class FstabEntry(object): 42 | """ a single fstab entry line """ 43 | @classmethod 44 | def from_line(cls, line): 45 | # split up 46 | args = line.partition("#")[0].split() 47 | # use only the first 7 args and ignore anything after them, mount 48 | # seems to do the same, see bug #873411 comment #7 49 | return FstabEntry(*args[0:6]) 50 | 51 | def __init__(self, fs_spec, mountpoint, fstype, options, dump=0, passno=0): 52 | # uuid or device 53 | self.fs_spec = fs_spec 54 | self.mountpoint = mountpoint 55 | self.fstype = fstype 56 | self.options = options 57 | self.dump = dump 58 | self.passno = passno 59 | 60 | def __repr__(self): 61 | return "" % ( 62 | self.fs_spec, self.mountpoint, self.fstype, 63 | self.options, self.dump, self.passno) 64 | 65 | 66 | class Fstab(list): 67 | """ a list of FstabEntry items """ 68 | def __init__(self, fstab="/etc/fstab"): 69 | super(Fstab, self).__init__() 70 | 71 | with open(fstab) as fstab_file: 72 | for line in (l.strip() for l in fstab_file): 73 | if line == "" or line.startswith("#"): 74 | continue 75 | try: 76 | entry = FstabEntry.from_line(line) 77 | except ValueError: 78 | continue 79 | self.append(entry) 80 | 81 | 82 | class LowLevelCommands(object): 83 | """ lowlevel commands invoked to perform various tasks like 84 | interact with mount and btrfs tools 85 | """ 86 | def mount(self, fs_spec, mountpoint): 87 | ret = subprocess.call(["mount", fs_spec, mountpoint]) 88 | return ret == 0 89 | 90 | def umount(self, mountpoint): 91 | ret = subprocess.call(["umount", mountpoint]) 92 | return ret == 0 93 | 94 | def btrfs_subvolume_snapshot(self, source, dest): 95 | ret = subprocess.call(["btrfs", "subvolume", "snapshot", 96 | source, dest]) 97 | return ret == 0 98 | 99 | def btrfs_delete_snapshot(self, snapshot): 100 | ret = subprocess.call(["btrfs", "subvolume", "delete", snapshot]) 101 | return ret == 0 102 | 103 | 104 | class AptBtrfsSnapshot(object): 105 | """ the high level object that interacts with the snapshot system """ 106 | 107 | # normal snapshot 108 | SNAP_PREFIX = "@apt-snapshot-" 109 | # backname when changing 110 | BACKUP_PREFIX = SNAP_PREFIX+"old-root-" 111 | 112 | def __init__(self, fstab="/etc/fstab"): 113 | self.fstab = Fstab(fstab) 114 | self.commands = LowLevelCommands() 115 | self._btrfs_root_mountpoint = None 116 | 117 | def snapshots_supported(self): 118 | """ verify that the system supports apt btrfs snapshots 119 | by checking if the right fs layout is used etc 120 | """ 121 | # check for the helper binary 122 | if not os.path.exists("/sbin/btrfs"): 123 | return False 124 | # check the fstab 125 | entry = self._get_supported_btrfs_root_fstab_entry() 126 | return entry != None 127 | 128 | def _get_supported_btrfs_root_fstab_entry(self): 129 | """ return the supported btrfs root FstabEntry or None """ 130 | for entry in self.fstab: 131 | if (entry.mountpoint == "/" and 132 | entry.fstype == "btrfs" and 133 | "subvol=@" in entry.options): 134 | return entry 135 | return None 136 | 137 | def _uuid_for_mountpoint(self, mountpoint, fstab="/etc/fstab"): 138 | """ return the device or UUID for the given mountpoint """ 139 | for entry in self.fstab: 140 | if entry.mountpoint == mountpoint: 141 | return entry.fs_spec 142 | return None 143 | 144 | def mount_btrfs_root_volume(self): 145 | uuid = self._uuid_for_mountpoint("/") 146 | mountpoint = tempfile.mkdtemp(prefix="apt-btrfs-snapshot-mp-") 147 | if not self.commands.mount(uuid, mountpoint): 148 | return None 149 | self._btrfs_root_mountpoint = mountpoint 150 | return self._btrfs_root_mountpoint 151 | 152 | def umount_btrfs_root_volume(self): 153 | res = self.commands.umount(self._btrfs_root_mountpoint) 154 | os.rmdir(self._btrfs_root_mountpoint) 155 | self._btrfs_root_mountpoint = None 156 | return res 157 | 158 | def _get_now_str(self): 159 | return datetime.datetime.now().replace(microsecond=0).isoformat(str('_')) 160 | 161 | def create_btrfs_root_snapshot(self, additional_prefix=""): 162 | mp = self.mount_btrfs_root_volume() 163 | snap_id = self._get_now_str() 164 | res = self.commands.btrfs_subvolume_snapshot( 165 | os.path.join(mp, "@"), 166 | os.path.join(mp, self.SNAP_PREFIX+additional_prefix+snap_id)) 167 | self.umount_btrfs_root_volume() 168 | return res 169 | 170 | def get_btrfs_root_snapshots_list(self, older_than=0): 171 | """ get the list of available snapshot 172 | If "older_then" is given (in unixtime format) it will only include 173 | snapshots that are older then the given date) 174 | """ 175 | l = [] 176 | # if older_than is used, ensure that the rootfs does not use 177 | # "noatime" 178 | if older_than != 0: 179 | entry = self._get_supported_btrfs_root_fstab_entry() 180 | if not entry: 181 | raise AptBtrfsNotSupportedError() 182 | if "noatime" in entry.options: 183 | raise AptBtrfsRootWithNoatimeError() 184 | # if there is no older than, interpret that as "now" 185 | if older_than == 0: 186 | older_than = time.time() 187 | mp = self.mount_btrfs_root_volume() 188 | for e in os.listdir(mp): 189 | if e.startswith(self.SNAP_PREFIX): 190 | # fstab is read when it was booted and when a snapshot is 191 | # created (to check if there is support for btrfs) 192 | atime = os.path.getatime(os.path.join(mp, e, "etc", "fstab")) 193 | if atime < older_than: 194 | l.append(e) 195 | self.umount_btrfs_root_volume() 196 | return l 197 | 198 | def print_btrfs_root_snapshots(self): 199 | print("Available snapshots:") 200 | print(" \n".join(self.get_btrfs_root_snapshots_list())) 201 | return True 202 | 203 | def _parse_older_than_to_unixtime(self, timefmt): 204 | now = time.time() 205 | if not timefmt.endswith("d"): 206 | raise Exception("Please specify time in days (e.g. 10d)") 207 | days = int(timefmt[:-1]) 208 | return now - (days * 24 * 60 * 60) 209 | 210 | def print_btrfs_root_snapshots_older_than(self, timefmt): 211 | older_than_unixtime = self._parse_older_than_to_unixtime(timefmt) 212 | try: 213 | print("Available snapshots older than '%s':" % timefmt) 214 | print(" \n".join(self.get_btrfs_root_snapshots_list( 215 | older_than=older_than_unixtime))) 216 | except AptBtrfsRootWithNoatimeError: 217 | sys.stderr.write("Error: fstab option 'noatime' incompatible with option") 218 | return False 219 | return True 220 | 221 | def clean_btrfs_root_snapshots_older_than(self, timefmt): 222 | res = True 223 | older_than_unixtime = self._parse_older_than_to_unixtime(timefmt) 224 | try: 225 | for snap in self.get_btrfs_root_snapshots_list( 226 | older_than=older_than_unixtime): 227 | res &= self.delete_snapshot(snap) 228 | except AptBtrfsRootWithNoatimeError: 229 | sys.stderr.write("Error: fstab option 'noatime' incompatible with option") 230 | return False 231 | return res 232 | 233 | def command_set_default(self, snapshot_name): 234 | res = self.set_default(snapshot_name) 235 | return res 236 | 237 | def set_default(self, snapshot_name, backup=True): 238 | """ set new default """ 239 | mp = self.mount_btrfs_root_volume() 240 | new_root = os.path.join(mp, snapshot_name) 241 | if os.path.isdir(new_root) and snapshot_name.startswith("@") and snapshot_name != "@": 242 | default_root = os.path.join(mp, "@") 243 | backup = os.path.join(mp, self.BACKUP_PREFIX + self._get_now_str()) 244 | os.rename(default_root, backup) 245 | os.rename(new_root, default_root) 246 | print("Default changed to %s, please reboot for changes to take effect." % snapshot_name) 247 | else: 248 | print("You have selected an invalid snapshot. Please make sure that it exists, and that it is not \"@\".") 249 | self.umount_btrfs_root_volume() 250 | return True 251 | 252 | def delete_snapshot(self, snapshot_name): 253 | mp = self.mount_btrfs_root_volume() 254 | res = self.commands.btrfs_delete_snapshot( 255 | os.path.join(mp, snapshot_name)) 256 | self.umount_btrfs_root_volume() 257 | return res 258 | -------------------------------------------------------------------------------- /GPL: -------------------------------------------------------------------------------- 1 | 2 | GNU GENERAL PUBLIC LICENSE 3 | Version 3, 29 June 2007 4 | 5 | Copyright (C) 2007 Free Software Foundation, Inc. 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The GNU General Public License is a free, copyleft license for 12 | software and other kinds of works. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | the GNU General Public License is intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. We, the Free Software Foundation, use the 19 | GNU General Public License for most of our software; it applies also to 20 | any other work released this way by its authors. You can apply it to 21 | your programs, too. 22 | 23 | When we speak of free software, we are referring to freedom, not 24 | price. Our General Public Licenses are designed to make sure that you 25 | have the freedom to distribute copies of free software (and charge for 26 | them if you wish), that you receive source code or can get it if you 27 | want it, that you can change the software or use pieces of it in new 28 | free programs, and that you know you can do these things. 29 | 30 | To protect your rights, we need to prevent others from denying you 31 | these rights or asking you to surrender the rights. Therefore, you have 32 | certain responsibilities if you distribute copies of the software, or if 33 | you modify it: responsibilities to respect the freedom of others. 34 | 35 | For example, if you distribute copies of such a program, whether 36 | gratis or for a fee, you must pass on to the recipients the same 37 | freedoms that you received. You must make sure that they, too, receive 38 | or can get the source code. And you must show them these terms so they 39 | know their rights. 40 | 41 | Developers that use the GNU GPL protect your rights with two steps: 42 | (1) assert copyright on the software, and (2) offer you this License 43 | giving you legal permission to copy, distribute and/or modify it. 44 | 45 | For the developers' and authors' protection, the GPL clearly explains 46 | that there is no warranty for this free software. For both users' and 47 | authors' sake, the GPL requires that modified versions be marked as 48 | changed, so that their problems will not be attributed erroneously to 49 | authors of previous versions. 50 | 51 | Some devices are designed to deny users access to install or run 52 | modified versions of the software inside them, although the manufacturer 53 | can do so. This is fundamentally incompatible with the aim of 54 | protecting users' freedom to change the software. The systematic 55 | pattern of such abuse occurs in the area of products for individuals to 56 | use, which is precisely where it is most unacceptable. Therefore, we 57 | have designed this version of the GPL to prohibit the practice for those 58 | products. If such problems arise substantially in other domains, we 59 | stand ready to extend this provision to those domains in future versions 60 | of the GPL, as needed to protect the freedom of users. 61 | 62 | Finally, every program is threatened constantly by software patents. 63 | States should not allow patents to restrict development and use of 64 | software on general-purpose computers, but in those that do, we wish to 65 | avoid the special danger that patents applied to a free program could 66 | make it effectively proprietary. To prevent this, the GPL assures that 67 | patents cannot be used to render the program non-free. 68 | 69 | The precise terms and conditions for copying, distribution and 70 | modification follow. 71 | 72 | TERMS AND CONDITIONS 73 | 74 | 0. Definitions. 75 | 76 | "This License" refers to version 3 of the GNU General Public License. 77 | 78 | "Copyright" also means copyright-like laws that apply to other kinds of 79 | works, such as semiconductor masks. 80 | 81 | "The Program" refers to any copyrightable work licensed under this 82 | License. Each licensee is addressed as "you". "Licensees" and 83 | "recipients" may be individuals or organizations. 84 | 85 | To "modify" a work means to copy from or adapt all or part of the work 86 | in a fashion requiring copyright permission, other than the making of an 87 | exact copy. The resulting work is called a "modified version" of the 88 | earlier work or a work "based on" the earlier work. 89 | 90 | A "covered work" means either the unmodified Program or a work based 91 | on the Program. 92 | 93 | To "propagate" a work means to do anything with it that, without 94 | permission, would make you directly or secondarily liable for 95 | infringement under applicable copyright law, except executing it on a 96 | computer or modifying a private copy. Propagation includes copying, 97 | distribution (with or without modification), making available to the 98 | public, and in some countries other activities as well. 99 | 100 | To "convey" a work means any kind of propagation that enables other 101 | parties to make or receive copies. Mere interaction with a user through 102 | a computer network, with no transfer of a copy, is not conveying. 103 | 104 | An interactive user interface displays "Appropriate Legal Notices" 105 | to the extent that it includes a convenient and prominently visible 106 | feature that (1) displays an appropriate copyright notice, and (2) 107 | tells the user that there is no warranty for the work (except to the 108 | extent that warranties are provided), that licensees may convey the 109 | work under this License, and how to view a copy of this License. If 110 | the interface presents a list of user commands or options, such as a 111 | menu, a prominent item in the list meets this criterion. 112 | 113 | 1. Source Code. 114 | 115 | The "source code" for a work means the preferred form of the work 116 | for making modifications to it. "Object code" means any non-source 117 | form of a work. 118 | 119 | A "Standard Interface" means an interface that either is an official 120 | standard defined by a recognized standards body, or, in the case of 121 | interfaces specified for a particular programming language, one that 122 | is widely used among developers working in that language. 123 | 124 | The "System Libraries" of an executable work include anything, other 125 | than the work as a whole, that (a) is included in the normal form of 126 | packaging a Major Component, but which is not part of that Major 127 | Component, and (b) serves only to enable use of the work with that 128 | Major Component, or to implement a Standard Interface for which an 129 | implementation is available to the public in source code form. A 130 | "Major Component", in this context, means a major essential component 131 | (kernel, window system, and so on) of the specific operating system 132 | (if any) on which the executable work runs, or a compiler used to 133 | produce the work, or an object code interpreter used to run it. 134 | 135 | The "Corresponding Source" for a work in object code form means all 136 | the source code needed to generate, install, and (for an executable 137 | work) run the object code and to modify the work, including scripts to 138 | control those activities. However, it does not include the work's 139 | System Libraries, or general-purpose tools or generally available free 140 | programs which are used unmodified in performing those activities but 141 | which are not part of the work. For example, Corresponding Source 142 | includes interface definition files associated with source files for 143 | the work, and the source code for shared libraries and dynamically 144 | linked subprograms that the work is specifically designed to require, 145 | such as by intimate data communication or control flow between those 146 | subprograms and other parts of the work. 147 | 148 | The Corresponding Source need not include anything that users 149 | can regenerate automatically from other parts of the Corresponding 150 | Source. 151 | 152 | The Corresponding Source for a work in source code form is that 153 | same work. 154 | 155 | 2. Basic Permissions. 156 | 157 | All rights granted under this License are granted for the term of 158 | copyright on the Program, and are irrevocable provided the stated 159 | conditions are met. This License explicitly affirms your unlimited 160 | permission to run the unmodified Program. The output from running a 161 | covered work is covered by this License only if the output, given its 162 | content, constitutes a covered work. This License acknowledges your 163 | rights of fair use or other equivalent, as provided by copyright law. 164 | 165 | You may make, run and propagate covered works that you do not 166 | convey, without conditions so long as your license otherwise remains 167 | in force. You may convey covered works to others for the sole purpose 168 | of having them make modifications exclusively for you, or provide you 169 | with facilities for running those works, provided that you comply with 170 | the terms of this License in conveying all material for which you do 171 | not control copyright. Those thus making or running the covered works 172 | for you must do so exclusively on your behalf, under your direction 173 | and control, on terms that prohibit them from making any copies of 174 | your copyrighted material outside their relationship with you. 175 | 176 | Conveying under any other circumstances is permitted solely under 177 | the conditions stated below. Sublicensing is not allowed; section 10 178 | makes it unnecessary. 179 | 180 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 181 | 182 | No covered work shall be deemed part of an effective technological 183 | measure under any applicable law fulfilling obligations under article 184 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 185 | similar laws prohibiting or restricting circumvention of such 186 | measures. 187 | 188 | When you convey a covered work, you waive any legal power to forbid 189 | circumvention of technological measures to the extent such circumvention 190 | is effected by exercising rights under this License with respect to 191 | the covered work, and you disclaim any intention to limit operation or 192 | modification of the work as a means of enforcing, against the work's 193 | users, your or third parties' legal rights to forbid circumvention of 194 | technological measures. 195 | 196 | 4. Conveying Verbatim Copies. 197 | 198 | You may convey verbatim copies of the Program's source code as you 199 | receive it, in any medium, provided that you conspicuously and 200 | appropriately publish on each copy an appropriate copyright notice; 201 | keep intact all notices stating that this License and any 202 | non-permissive terms added in accord with section 7 apply to the code; 203 | keep intact all notices of the absence of any warranty; and give all 204 | recipients a copy of this License along with the Program. 205 | 206 | You may charge any price or no price for each copy that you convey, 207 | and you may offer support or warranty protection for a fee. 208 | 209 | 5. Conveying Modified Source Versions. 210 | 211 | You may convey a work based on the Program, or the modifications to 212 | produce it from the Program, in the form of source code under the 213 | terms of section 4, provided that you also meet all of these conditions: 214 | 215 | a) The work must carry prominent notices stating that you modified 216 | it, and giving a relevant date. 217 | 218 | b) The work must carry prominent notices stating that it is 219 | released under this License and any conditions added under section 220 | 7. This requirement modifies the requirement in section 4 to 221 | "keep intact all notices". 222 | 223 | c) You must license the entire work, as a whole, under this 224 | License to anyone who comes into possession of a copy. This 225 | License will therefore apply, along with any applicable section 7 226 | additional terms, to the whole of the work, and all its parts, 227 | regardless of how they are packaged. This License gives no 228 | permission to license the work in any other way, but it does not 229 | invalidate such permission if you have separately received it. 230 | 231 | d) If the work has interactive user interfaces, each must display 232 | Appropriate Legal Notices; however, if the Program has interactive 233 | interfaces that do not display Appropriate Legal Notices, your 234 | work need not make them do so. 235 | 236 | A compilation of a covered work with other separate and independent 237 | works, which are not by their nature extensions of the covered work, 238 | and which are not combined with it such as to form a larger program, 239 | in or on a volume of a storage or distribution medium, is called an 240 | "aggregate" if the compilation and its resulting copyright are not 241 | used to limit the access or legal rights of the compilation's users 242 | beyond what the individual works permit. Inclusion of a covered work 243 | in an aggregate does not cause this License to apply to the other 244 | parts of the aggregate. 245 | 246 | 6. Conveying Non-Source Forms. 247 | 248 | You may convey a covered work in object code form under the terms 249 | of sections 4 and 5, provided that you also convey the 250 | machine-readable Corresponding Source under the terms of this License, 251 | in one of these ways: 252 | 253 | a) Convey the object code in, or embodied in, a physical product 254 | (including a physical distribution medium), accompanied by the 255 | Corresponding Source fixed on a durable physical medium 256 | customarily used for software interchange. 257 | 258 | b) Convey the object code in, or embodied in, a physical product 259 | (including a physical distribution medium), accompanied by a 260 | written offer, valid for at least three years and valid for as 261 | long as you offer spare parts or customer support for that product 262 | model, to give anyone who possesses the object code either (1) a 263 | copy of the Corresponding Source for all the software in the 264 | product that is covered by this License, on a durable physical 265 | medium customarily used for software interchange, for a price no 266 | more than your reasonable cost of physically performing this 267 | conveying of source, or (2) access to copy the 268 | Corresponding Source from a network server at no charge. 269 | 270 | c) Convey individual copies of the object code with a copy of the 271 | written offer to provide the Corresponding Source. This 272 | alternative is allowed only occasionally and noncommercially, and 273 | only if you received the object code with such an offer, in accord 274 | with subsection 6b. 275 | 276 | d) Convey the object code by offering access from a designated 277 | place (gratis or for a charge), and offer equivalent access to the 278 | Corresponding Source in the same way through the same place at no 279 | further charge. You need not require recipients to copy the 280 | Corresponding Source along with the object code. If the place to 281 | copy the object code is a network server, the Corresponding Source 282 | may be on a different server (operated by you or a third party) 283 | that supports equivalent copying facilities, provided you maintain 284 | clear directions next to the object code saying where to find the 285 | Corresponding Source. Regardless of what server hosts the 286 | Corresponding Source, you remain obligated to ensure that it is 287 | available for as long as needed to satisfy these requirements. 288 | 289 | e) Convey the object code using peer-to-peer transmission, provided 290 | you inform other peers where the object code and Corresponding 291 | Source of the work are being offered to the general public at no 292 | charge under subsection 6d. 293 | 294 | A separable portion of the object code, whose source code is excluded 295 | from the Corresponding Source as a System Library, need not be 296 | included in conveying the object code work. 297 | 298 | A "User Product" is either (1) a "consumer product", which means any 299 | tangible personal property which is normally used for personal, family, 300 | or household purposes, or (2) anything designed or sold for incorporation 301 | into a dwelling. In determining whether a product is a consumer product, 302 | doubtful cases shall be resolved in favor of coverage. For a particular 303 | product received by a particular user, "normally used" refers to a 304 | typical or common use of that class of product, regardless of the status 305 | of the particular user or of the way in which the particular user 306 | actually uses, or expects or is expected to use, the product. A product 307 | is a consumer product regardless of whether the product has substantial 308 | commercial, industrial or non-consumer uses, unless such uses represent 309 | the only significant mode of use of the product. 310 | 311 | "Installation Information" for a User Product means any methods, 312 | procedures, authorization keys, or other information required to install 313 | and execute modified versions of a covered work in that User Product from 314 | a modified version of its Corresponding Source. The information must 315 | suffice to ensure that the continued functioning of the modified object 316 | code is in no case prevented or interfered with solely because 317 | modification has been made. 318 | 319 | If you convey an object code work under this section in, or with, or 320 | specifically for use in, a User Product, and the conveying occurs as 321 | part of a transaction in which the right of possession and use of the 322 | User Product is transferred to the recipient in perpetuity or for a 323 | fixed term (regardless of how the transaction is characterized), the 324 | Corresponding Source conveyed under this section must be accompanied 325 | by the Installation Information. But this requirement does not apply 326 | if neither you nor any third party retains the ability to install 327 | modified object code on the User Product (for example, the work has 328 | been installed in ROM). 329 | 330 | The requirement to provide Installation Information does not include a 331 | requirement to continue to provide support service, warranty, or updates 332 | for a work that has been modified or installed by the recipient, or for 333 | the User Product in which it has been modified or installed. Access to a 334 | network may be denied when the modification itself materially and 335 | adversely affects the operation of the network or violates the rules and 336 | protocols for communication across the network. 337 | 338 | Corresponding Source conveyed, and Installation Information provided, 339 | in accord with this section must be in a format that is publicly 340 | documented (and with an implementation available to the public in 341 | source code form), and must require no special password or key for 342 | unpacking, reading or copying. 343 | 344 | 7. Additional Terms. 345 | 346 | "Additional permissions" are terms that supplement the terms of this 347 | License by making exceptions from one or more of its conditions. 348 | Additional permissions that are applicable to the entire Program shall 349 | be treated as though they were included in this License, to the extent 350 | that they are valid under applicable law. If additional permissions 351 | apply only to part of the Program, that part may be used separately 352 | under those permissions, but the entire Program remains governed by 353 | this License without regard to the additional permissions. 354 | 355 | When you convey a copy of a covered work, you may at your option 356 | remove any additional permissions from that copy, or from any part of 357 | it. (Additional permissions may be written to require their own 358 | removal in certain cases when you modify the work.) You may place 359 | additional permissions on material, added by you to a covered work, 360 | for which you have or can give appropriate copyright permission. 361 | 362 | Notwithstanding any other provision of this License, for material you 363 | add to a covered work, you may (if authorized by the copyright holders of 364 | that material) supplement the terms of this License with terms: 365 | 366 | a) Disclaiming warranty or limiting liability differently from the 367 | terms of sections 15 and 16 of this License; or 368 | 369 | b) Requiring preservation of specified reasonable legal notices or 370 | author attributions in that material or in the Appropriate Legal 371 | Notices displayed by works containing it; or 372 | 373 | c) Prohibiting misrepresentation of the origin of that material, or 374 | requiring that modified versions of such material be marked in 375 | reasonable ways as different from the original version; or 376 | 377 | d) Limiting the use for publicity purposes of names of licensors or 378 | authors of the material; or 379 | 380 | e) Declining to grant rights under trademark law for use of some 381 | trade names, trademarks, or service marks; or 382 | 383 | f) Requiring indemnification of licensors and authors of that 384 | material by anyone who conveys the material (or modified versions of 385 | it) with contractual assumptions of liability to the recipient, for 386 | any liability that these contractual assumptions directly impose on 387 | those licensors and authors. 388 | 389 | All other non-permissive additional terms are considered "further 390 | restrictions" within the meaning of section 10. If the Program as you 391 | received it, or any part of it, contains a notice stating that it is 392 | governed by this License along with a term that is a further 393 | restriction, you may remove that term. If a license document contains 394 | a further restriction but permits relicensing or conveying under this 395 | License, you may add to a covered work material governed by the terms 396 | of that license document, provided that the further restriction does 397 | not survive such relicensing or conveying. 398 | 399 | If you add terms to a covered work in accord with this section, you 400 | must place, in the relevant source files, a statement of the 401 | additional terms that apply to those files, or a notice indicating 402 | where to find the applicable terms. 403 | 404 | Additional terms, permissive or non-permissive, may be stated in the 405 | form of a separately written license, or stated as exceptions; 406 | the above requirements apply either way. 407 | 408 | 8. Termination. 409 | 410 | You may not propagate or modify a covered work except as expressly 411 | provided under this License. Any attempt otherwise to propagate or 412 | modify it is void, and will automatically terminate your rights under 413 | this License (including any patent licenses granted under the third 414 | paragraph of section 11). 415 | 416 | However, if you cease all violation of this License, then your 417 | license from a particular copyright holder is reinstated (a) 418 | provisionally, unless and until the copyright holder explicitly and 419 | finally terminates your license, and (b) permanently, if the copyright 420 | holder fails to notify you of the violation by some reasonable means 421 | prior to 60 days after the cessation. 422 | 423 | Moreover, your license from a particular copyright holder is 424 | reinstated permanently if the copyright holder notifies you of the 425 | violation by some reasonable means, this is the first time you have 426 | received notice of violation of this License (for any work) from that 427 | copyright holder, and you cure the violation prior to 30 days after 428 | your receipt of the notice. 429 | 430 | Termination of your rights under this section does not terminate the 431 | licenses of parties who have received copies or rights from you under 432 | this License. If your rights have been terminated and not permanently 433 | reinstated, you do not qualify to receive new licenses for the same 434 | material under section 10. 435 | 436 | 9. Acceptance Not Required for Having Copies. 437 | 438 | You are not required to accept this License in order to receive or 439 | run a copy of the Program. Ancillary propagation of a covered work 440 | occurring solely as a consequence of using peer-to-peer transmission 441 | to receive a copy likewise does not require acceptance. However, 442 | nothing other than this License grants you permission to propagate or 443 | modify any covered work. These actions infringe copyright if you do 444 | not accept this License. Therefore, by modifying or propagating a 445 | covered work, you indicate your acceptance of this License to do so. 446 | 447 | 10. Automatic Licensing of Downstream Recipients. 448 | 449 | Each time you convey a covered work, the recipient automatically 450 | receives a license from the original licensors, to run, modify and 451 | propagate that work, subject to this License. You are not responsible 452 | for enforcing compliance by third parties with this License. 453 | 454 | An "entity transaction" is a transaction transferring control of an 455 | organization, or substantially all assets of one, or subdividing an 456 | organization, or merging organizations. If propagation of a covered 457 | work results from an entity transaction, each party to that 458 | transaction who receives a copy of the work also receives whatever 459 | licenses to the work the party's predecessor in interest had or could 460 | give under the previous paragraph, plus a right to possession of the 461 | Corresponding Source of the work from the predecessor in interest, if 462 | the predecessor has it or can get it with reasonable efforts. 463 | 464 | You may not impose any further restrictions on the exercise of the 465 | rights granted or affirmed under this License. For example, you may 466 | not impose a license fee, royalty, or other charge for exercise of 467 | rights granted under this License, and you may not initiate litigation 468 | (including a cross-claim or counterclaim in a lawsuit) alleging that 469 | any patent claim is infringed by making, using, selling, offering for 470 | sale, or importing the Program or any portion of it. 471 | 472 | 11. Patents. 473 | 474 | A "contributor" is a copyright holder who authorizes use under this 475 | License of the Program or a work on which the Program is based. The 476 | work thus licensed is called the contributor's "contributor version". 477 | 478 | A contributor's "essential patent claims" are all patent claims 479 | owned or controlled by the contributor, whether already acquired or 480 | hereafter acquired, that would be infringed by some manner, permitted 481 | by this License, of making, using, or selling its contributor version, 482 | but do not include claims that would be infringed only as a 483 | consequence of further modification of the contributor version. For 484 | purposes of this definition, "control" includes the right to grant 485 | patent sublicenses in a manner consistent with the requirements of 486 | this License. 487 | 488 | Each contributor grants you a non-exclusive, worldwide, royalty-free 489 | patent license under the contributor's essential patent claims, to 490 | make, use, sell, offer for sale, import and otherwise run, modify and 491 | propagate the contents of its contributor version. 492 | 493 | In the following three paragraphs, a "patent license" is any express 494 | agreement or commitment, however denominated, not to enforce a patent 495 | (such as an express permission to practice a patent or covenant not to 496 | sue for patent infringement). To "grant" such a patent license to a 497 | party means to make such an agreement or commitment not to enforce a 498 | patent against the party. 499 | 500 | If you convey a covered work, knowingly relying on a patent license, 501 | and the Corresponding Source of the work is not available for anyone 502 | to copy, free of charge and under the terms of this License, through a 503 | publicly available network server or other readily accessible means, 504 | then you must either (1) cause the Corresponding Source to be so 505 | available, or (2) arrange to deprive yourself of the benefit of the 506 | patent license for this particular work, or (3) arrange, in a manner 507 | consistent with the requirements of this License, to extend the patent 508 | license to downstream recipients. "Knowingly relying" means you have 509 | actual knowledge that, but for the patent license, your conveying the 510 | covered work in a country, or your recipient's use of the covered work 511 | in a country, would infringe one or more identifiable patents in that 512 | country that you have reason to believe are valid. 513 | 514 | If, pursuant to or in connection with a single transaction or 515 | arrangement, you convey, or propagate by procuring conveyance of, a 516 | covered work, and grant a patent license to some of the parties 517 | receiving the covered work authorizing them to use, propagate, modify 518 | or convey a specific copy of the covered work, then the patent license 519 | you grant is automatically extended to all recipients of the covered 520 | work and works based on it. 521 | 522 | A patent license is "discriminatory" if it does not include within 523 | the scope of its coverage, prohibits the exercise of, or is 524 | conditioned on the non-exercise of one or more of the rights that are 525 | specifically granted under this License. You may not convey a covered 526 | work if you are a party to an arrangement with a third party that is 527 | in the business of distributing software, under which you make payment 528 | to the third party based on the extent of your activity of conveying 529 | the work, and under which the third party grants, to any of the 530 | parties who would receive the covered work from you, a discriminatory 531 | patent license (a) in connection with copies of the covered work 532 | conveyed by you (or copies made from those copies), or (b) primarily 533 | for and in connection with specific products or compilations that 534 | contain the covered work, unless you entered into that arrangement, 535 | or that patent license was granted, prior to 28 March 2007. 536 | 537 | Nothing in this License shall be construed as excluding or limiting 538 | any implied license or other defenses to infringement that may 539 | otherwise be available to you under applicable patent law. 540 | 541 | 12. No Surrender of Others' Freedom. 542 | 543 | If conditions are imposed on you (whether by court order, agreement or 544 | otherwise) that contradict the conditions of this License, they do not 545 | excuse you from the conditions of this License. If you cannot convey a 546 | covered work so as to satisfy simultaneously your obligations under this 547 | License and any other pertinent obligations, then as a consequence you may 548 | not convey it at all. For example, if you agree to terms that obligate you 549 | to collect a royalty for further conveying from those to whom you convey 550 | the Program, the only way you could satisfy both those terms and this 551 | License would be to refrain entirely from conveying the Program. 552 | 553 | 13. Use with the GNU Affero General Public License. 554 | 555 | Notwithstanding any other provision of this License, you have 556 | permission to link or combine any covered work with a work licensed 557 | under version 3 of the GNU Affero General Public License into a single 558 | combined work, and to convey the resulting work. The terms of this 559 | License will continue to apply to the part which is the covered work, 560 | but the special requirements of the GNU Affero General Public License, 561 | section 13, concerning interaction through a network will apply to the 562 | combination as such. 563 | 564 | 14. Revised Versions of this License. 565 | 566 | The Free Software Foundation may publish revised and/or new versions of 567 | the GNU General Public License from time to time. Such new versions will 568 | be similar in spirit to the present version, but may differ in detail to 569 | address new problems or concerns. 570 | 571 | Each version is given a distinguishing version number. If the 572 | Program specifies that a certain numbered version of the GNU General 573 | Public License "or any later version" applies to it, you have the 574 | option of following the terms and conditions either of that numbered 575 | version or of any later version published by the Free Software 576 | Foundation. If the Program does not specify a version number of the 577 | GNU General Public License, you may choose any version ever published 578 | by the Free Software Foundation. 579 | 580 | If the Program specifies that a proxy can decide which future 581 | versions of the GNU General Public License can be used, that proxy's 582 | public statement of acceptance of a version permanently authorizes you 583 | to choose that version for the Program. 584 | 585 | Later license versions may give you additional or different 586 | permissions. However, no additional obligations are imposed on any 587 | author or copyright holder as a result of your choosing to follow a 588 | later version. 589 | 590 | 15. Disclaimer of Warranty. 591 | 592 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 593 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 594 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 595 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 596 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 597 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 598 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 599 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 600 | 601 | 16. Limitation of Liability. 602 | 603 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 604 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 605 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 606 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 607 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 608 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 609 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 610 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 611 | SUCH DAMAGES. 612 | 613 | 17. Interpretation of Sections 15 and 16. 614 | 615 | If the disclaimer of warranty and limitation of liability provided 616 | above cannot be given local legal effect according to their terms, 617 | reviewing courts shall apply local law that most closely approximates 618 | an absolute waiver of all civil liability in connection with the 619 | Program, unless a warranty or assumption of liability accompanies a 620 | copy of the Program in return for a fee. 621 | 622 | END OF TERMS AND CONDITIONS 623 | 624 | How to Apply These Terms to Your New Programs 625 | 626 | If you develop a new program, and you want it to be of the greatest 627 | possible use to the public, the best way to achieve this is to make it 628 | free software which everyone can redistribute and change under these terms. 629 | 630 | To do so, attach the following notices to the program. It is safest 631 | to attach them to the start of each source file to most effectively 632 | state the exclusion of warranty; and each file should have at least 633 | the "copyright" line and a pointer to where the full notice is found. 634 | 635 | 636 | Copyright (C) 637 | 638 | This program is free software: you can redistribute it and/or modify 639 | it under the terms of the GNU General Public License as published by 640 | the Free Software Foundation, either version 3 of the License, or 641 | (at your option) any later version. 642 | 643 | This program is distributed in the hope that it will be useful, 644 | but WITHOUT ANY WARRANTY; without even the implied warranty of 645 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 646 | GNU General Public License for more details. 647 | 648 | You should have received a copy of the GNU General Public License 649 | along with this program. If not, see . 650 | 651 | Also add information on how to contact you by electronic and paper mail. 652 | 653 | If the program does terminal interaction, make it output a short 654 | notice like this when it starts in an interactive mode: 655 | 656 | Copyright (C) 657 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 658 | This is free software, and you are welcome to redistribute it 659 | under certain conditions; type `show c' for details. 660 | 661 | The hypothetical commands `show w' and `show c' should show the appropriate 662 | parts of the General Public License. Of course, your program's commands 663 | might be different; for a GUI interface, you would use an "about box". 664 | 665 | You should also get your employer (if you work as a programmer) or school, 666 | if any, to sign a "copyright disclaimer" for the program, if necessary. 667 | For more information on this, and how to apply and follow the GNU GPL, see 668 | . 669 | 670 | The GNU General Public License does not permit incorporating your program 671 | into proprietary programs. If your program is a subroutine library, you 672 | may consider it more useful to permit linking proprietary applications with 673 | the library. If this is what you want to do, use the GNU Lesser General 674 | Public License instead of this License. But first, please read 675 | . 676 | 677 | --------------------------------------------------------------------------------