├── requirements.txt ├── tunasync ├── __init__.py ├── hook.py ├── clt_server.py ├── btrfs_snapshot.py ├── jobs.py ├── loglimit.py ├── status_manager.py ├── mirror_config.py ├── mirror_provider.py └── tunasync.py ├── examples ├── shell_provider.sh └── tunasync.conf ├── scripts ├── android.sh ├── pypi.sh ├── linux.sh ├── homebrew.sh ├── gen_debian_exclude.py └── repo-ck.sh ├── systemd ├── tunasync-snapshot-gc.timer ├── tunasync-snapshot-gc.service └── tunasync.service ├── README.md ├── tunasync.py ├── .gitignore ├── tunasynctl.py ├── tunasync_snapshot_gc.py └── LICENSE /requirements.txt: -------------------------------------------------------------------------------- 1 | setproctitle==1.1.8 2 | sh==1.09 3 | toml==0.8.2 4 | wsgiref==0.1.2 5 | -------------------------------------------------------------------------------- /tunasync/__init__.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python2 2 | # -*- coding:utf-8 -*- 3 | from .tunasync import TUNASync 4 | # vim: ts=4 sw=4 sts=4 expandtab 5 | -------------------------------------------------------------------------------- /examples/shell_provider.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | echo $TUNASYNC_WORKING_DIR 3 | echo $TUNASYNC_LOG_FILE 4 | echo $TUNASYNC_UPSTREAM_URL 5 | sleep 5 6 | exit 1 7 | -------------------------------------------------------------------------------- /scripts/android.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | function sync_android() { 4 | cd $TUNASYNC_WORKING_DIR 5 | /usr/local/bin/android-repo sync 6 | } 7 | 8 | sync_android 9 | -------------------------------------------------------------------------------- /systemd/tunasync-snapshot-gc.timer: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=TUNAsync GC every 10 minutes 3 | 4 | [Timer] 5 | OnUnitActiveSec=10min 6 | 7 | [Install] 8 | WantedBy=multi-user.target 9 | -------------------------------------------------------------------------------- /scripts/pypi.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | if [ ! -d "$TUNASYNC_WORKING_DIR" ]; then 3 | echo "Directory not exists, fail" 4 | exit 1 5 | fi 6 | 7 | /usr/bin/timeout -s INT 3600 /home/tuna/.virtualenvs/bandersnatch/bin/bandersnatch -c /etc/bandersnatch.conf mirror 8 | -------------------------------------------------------------------------------- /scripts/linux.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | if [ ! -d "$TUNASYNC_WORKING_DIR" ]; then 3 | echo "Directory not exists, fail" 4 | exit 1 5 | fi 6 | 7 | function update_linux_git() { 8 | cd $TUNASYNC_WORKING_DIR 9 | /usr/bin/timeout -s INT 3600 git remote -v update 10 | } 11 | 12 | update_linux_git 13 | -------------------------------------------------------------------------------- /scripts/homebrew.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | if [ ! -d "$TUNASYNC_WORKING_DIR" ]; then 3 | echo "Directory not exists, fail" 4 | exit 1 5 | fi 6 | 7 | function update_homebrew_git() { 8 | cd $TUNASYNC_WORKING_DIR 9 | /usr/bin/timeout -s INT 3600 git remote -v update 10 | } 11 | 12 | update_homebrew_git 13 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | tunasync 2 | ======== 3 | 4 | ## TODO 5 | 6 | - [ ] implement `tunasynctl tail` and `tunasynctl log` or equivalent feature 7 | - [x] status file 8 | - [ ] mirror size 9 | - [ ] upstream 10 | - [x] btrfs backend (create snapshot before syncing) 11 | - [x] add mirror job online 12 | - [x] use toml as configuration 13 | -------------------------------------------------------------------------------- /tunasync/hook.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python2 2 | # -*- coding:utf-8 -*- 3 | 4 | 5 | class JobHook(object): 6 | 7 | def before_job(self, *args, **kwargs): 8 | raise NotImplementedError("") 9 | 10 | def after_job(self, *args, **kwargs): 11 | raise NotImplementedError("") 12 | 13 | # vim: ts=4 sw=4 sts=4 expandtab 14 | -------------------------------------------------------------------------------- /systemd/tunasync-snapshot-gc.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Delete garbage subvolumes generated by tunasync 3 | Requires = network.target 4 | After = network.target 5 | 6 | [Service] 7 | Type=oneshot 8 | ExecStart=/home/tuna/.virtualenvs/tunasync/bin/python -u /home/tuna/tunasync/tunasync_snapshot_gc.py -c /etc/tunasync.ini 9 | 10 | [Install] 11 | WantedBy = multi-user.target 12 | -------------------------------------------------------------------------------- /systemd/tunasync.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description = TUNA mirrors sync daemon 3 | Requires = network.target 4 | After = network.target 5 | 6 | [Service] 7 | ExecStart = /home/tuna/.virtualenvs/tunasync/bin/python -u /home/tuna/tunasync/tunasync.py -c /etc/tunasync.ini 8 | KillSignal = SIGTERM 9 | ExecReload = /bin/kill -SIGUSR1 $MAINPID 10 | Environment = "HOME=/home/tuna" 11 | 12 | [Install] 13 | WantedBy = multi-user.target 14 | -------------------------------------------------------------------------------- /scripts/gen_debian_exclude.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | ARCH_EXCLUDE = ['armel', 'arm64', 'alpha', 'hurd-i386', 'ia64', 'kfreebsd-amd64', 'kfreebsd-i386', 'mips', 'powerpc', 'ppc64el', 's390', 's390x', 'sparc'] 4 | 5 | CONTENT_EXCLUDE = ['binary-{arch}', 'installer-{arch}', 'Contents-{arch}.gz', 'Contents-udeb-{arch}.gz', 'Contents-{arch}.diff', 'arch-{arch}.files', 'arch-{arch}.list.gz', '*_{arch}.deb', '*_{arch}.udeb', '*_{arch}.changes'] 6 | 7 | with open("debian-exclude.txt", 'wb') as f: 8 | for arch in ARCH_EXCLUDE: 9 | for content in CONTENT_EXCLUDE: 10 | f.write(content.format(arch=arch)) 11 | f.write('\n') 12 | -------------------------------------------------------------------------------- /scripts/repo-ck.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | function sync_repo_ck() { 4 | repo_url="$1" 5 | repo_dir="$2" 6 | 7 | [ ! -d "$repo_dir" ] && mkdir -p "$repo_dir" 8 | cd $repo_dir 9 | lftp "${repo_url}/" -e 'mirror -v -P 5 --delete --only-missing --only-newer --no-recursion; bye' || return 1 10 | wget "${repo_url}/repo-ck.db" -O "repo-ck.db" || return 1 11 | wget "${repo_url}/repo-ck.files" -O "repo-ck.files" 12 | } 13 | 14 | stat=0 15 | sync_repo_ck "${TUNASYNC_UPSTREAM_URL}/x86_64" "${TUNASYNC_WORKING_DIR}/x86_64" || stat=1 16 | sync_repo_ck "${TUNASYNC_UPSTREAM_URL}/i686" "${TUNASYNC_WORKING_DIR}/i686" || stat=1 17 | exit $stat 18 | -------------------------------------------------------------------------------- /tunasync.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python2 2 | # -*- coding:utf-8 -*- 3 | import os 4 | import argparse 5 | 6 | from tunasync import TUNASync 7 | 8 | 9 | if __name__ == "__main__": 10 | here = os.path.abspath(os.path.dirname(__file__)) 11 | 12 | parser = argparse.ArgumentParser(prog="tunasync") 13 | parser.add_argument("-c", "--config", 14 | default="tunasync.ini", help="config file") 15 | parser.add_argument("--pidfile", default="/var/run/tunasync.pid", 16 | help="pidfile") 17 | 18 | args = parser.parse_args() 19 | 20 | with open(args.pidfile, 'w') as f: 21 | f.write("{}".format(os.getpid())) 22 | 23 | tunaSync = TUNASync() 24 | tunaSync.read_config(args.config) 25 | 26 | tunaSync.run_jobs() 27 | 28 | # vim: ts=4 sw=4 sts=4 expandtab 29 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | 5 | # C extensions 6 | *.so 7 | 8 | # Distribution / packaging 9 | .Python 10 | env/ 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | lib/ 17 | lib64/ 18 | parts/ 19 | sdist/ 20 | var/ 21 | *.egg-info/ 22 | .installed.cfg 23 | *.egg 24 | 25 | # PyInstaller 26 | # Usually these files are written by a python script from a template 27 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 28 | *.manifest 29 | *.spec 30 | 31 | # Installer logs 32 | pip-log.txt 33 | pip-delete-this-directory.txt 34 | 35 | # Unit test / coverage reports 36 | htmlcov/ 37 | .tox/ 38 | .coverage 39 | .cache 40 | nosetests.xml 41 | coverage.xml 42 | 43 | # Translations 44 | *.mo 45 | *.pot 46 | 47 | # Django stuff: 48 | *.log 49 | 50 | # Sphinx documentation 51 | docs/_build/ 52 | 53 | # PyBuilder 54 | target/ 55 | 56 | *.swp 57 | *~ 58 | /examples/tunasync.json 59 | -------------------------------------------------------------------------------- /tunasynctl.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python2 2 | # -*- coding:utf-8 -*- 3 | import sys 4 | import socket 5 | import argparse 6 | import json 7 | import struct 8 | 9 | if __name__ == "__main__": 10 | parser = argparse.ArgumentParser(prog="tunasynctl") 11 | parser.add_argument("-s", "--socket", 12 | default="/var/run/tunasync.sock", help="socket file") 13 | parser.add_argument("command", help="command") 14 | parser.add_argument("target", nargs="?", default="__ALL__", help="target") 15 | 16 | args = parser.parse_args() 17 | 18 | sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) 19 | 20 | try: 21 | sock.connect(args.socket) 22 | except socket.error as msg: 23 | print(msg) 24 | sys.exit(1) 25 | 26 | pack = json.dumps({ 27 | 'cmd': args.command, 28 | 'target': args.target, 29 | }) 30 | 31 | try: 32 | sock.sendall(struct.pack('!H', len(pack)) + pack) 33 | length = struct.unpack('!H', sock.recv(2))[0] 34 | print(sock.recv(length)) 35 | 36 | except Exception as e: 37 | print(e) 38 | finally: 39 | sock.close() 40 | 41 | # vim: ts=4 sw=4 sts=4 expandtab 42 | -------------------------------------------------------------------------------- /examples/tunasync.conf: -------------------------------------------------------------------------------- 1 | [global] 2 | log_dir = "/var/log/tunasync" 3 | # mirror_root = /srv/mirror_disk 4 | mirror_root = "/mnt/sdb1/mirror" 5 | use_btrfs = false 6 | local_dir = "{mirror_root}/_working/{mirror_name}/" 7 | status_file = "/tmp/tunasync.json" 8 | # maximum numbers of running jobs 9 | concurrent = 2 10 | # interval in minutes 11 | interval = 1 12 | max_retry = 2 13 | ctrl_addr = "/tmp/tunasync.sock" 14 | 15 | [btrfs] 16 | service_dir = "{mirror_root}/_current/{mirror_name}" 17 | working_dir = "{mirror_root}/_working/{mirror_name}" 18 | gc_root = "{mirror_root}/_garbage/" 19 | gc_dir = "{mirror_root}/_garbage/_gc_{mirror_name}_{{timestamp}}" 20 | 21 | # [[mirrors]] 22 | # name = "archlinux" 23 | # provider = "rsync" 24 | # upstream = "rsync://mirror.us.leaseweb.net/archlinux/" 25 | # log_file = "/tmp/archlinux-{date}.log" 26 | # use_ipv6 = true 27 | 28 | [[mirrors]] 29 | name = "arch1" 30 | provider = "shell" 31 | command = "sleep 10" 32 | local_dir = "/mnt/sdb1/mirror/archlinux/current/" 33 | # log_file = "/dev/null" 34 | 35 | [[mirrors]] 36 | name = "arch2" 37 | provider = "shell" 38 | command = "sleep 20" 39 | local_dir = "/mnt/sdb1/mirror/archlinux/current/" 40 | # log_file = "/dev/null" 41 | 42 | [[mirrors]] 43 | name = "arch4" 44 | provider = "shell" 45 | command = "./shell_provider.sh" 46 | upstream = "https://pypi.python.org/" 47 | # log_file = "/tmp/arch4-{date}.log" 48 | use_btrfs = false 49 | 50 | # vim: ft=toml 51 | -------------------------------------------------------------------------------- /tunasync_snapshot_gc.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python2 2 | # -*- coding:utf-8 -*- 3 | import re 4 | import sh 5 | import os 6 | import argparse 7 | import toml 8 | 9 | if __name__ == "__main__": 10 | parser = argparse.ArgumentParser(prog="tunasync_snapshot_gc") 11 | parser.add_argument("--max-level", type=int, default=1, help="max walk level to find garbage snapshots") 12 | parser.add_argument("--pattern", default=r"^_gc_\d+", help="pattern to match garbage snapshots") 13 | parser.add_argument("-c", "--config", help="tunasync config file") 14 | 15 | args = parser.parse_args() 16 | 17 | pattern = re.compile(args.pattern) 18 | 19 | def walk(_dir, level=1): 20 | if level > args.max_level: 21 | return 22 | 23 | for fname in os.listdir(_dir): 24 | abs_fname = os.path.join(_dir, fname) 25 | if os.path.isdir(abs_fname): 26 | if pattern.match(fname): 27 | print("GC: {}".format(abs_fname)) 28 | try: 29 | sh.btrfs("subvolume", "delete", abs_fname) 30 | except sh.ErrorReturnCode, e: 31 | print("Error: {}".format(e.stderr)) 32 | else: 33 | walk(abs_fname, level+1) 34 | 35 | with open(args.config) as f: 36 | settings = toml.loads(f.read()) 37 | 38 | mirror_root = settings["global"]["mirror_root"] 39 | gc_root = settings["btrfs"]["gc_root"].format(mirror_root=mirror_root) 40 | 41 | walk(gc_root) 42 | 43 | # vim: ts=4 sw=4 sts=4 expandtab 44 | -------------------------------------------------------------------------------- /tunasync/clt_server.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python2 2 | # -*- coding:utf-8 -*- 3 | import socket 4 | import os 5 | import json 6 | import struct 7 | 8 | 9 | class ControlServer(object): 10 | 11 | def __init__(self, address, mgr_chan, cld_chan): 12 | self.address = address 13 | self.mgr_chan = mgr_chan 14 | self.cld_chan = cld_chan 15 | try: 16 | os.unlink(self.address) 17 | except OSError: 18 | if os.path.exists(self.address): 19 | raise Exception("file exists: {}".format(self.address)) 20 | self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) 21 | self.sock.bind(self.address) 22 | os.chmod(address, 0700) 23 | 24 | print("Control Server listening on: {}".format(self.address)) 25 | self.sock.listen(1) 26 | 27 | def serve_forever(self): 28 | while 1: 29 | conn, _ = self.sock.accept() 30 | 31 | try: 32 | length = struct.unpack('!H', conn.recv(2))[0] 33 | content = conn.recv(length) 34 | cmd = json.loads(content) 35 | self.mgr_chan.put(("CMD", (cmd['cmd'], cmd['target']))) 36 | except Exception as e: 37 | print(e) 38 | res = "Invalid Command" 39 | else: 40 | res = self.cld_chan.get() 41 | 42 | conn.sendall(struct.pack('!H', len(res))) 43 | conn.sendall(res) 44 | conn.close() 45 | 46 | 47 | def run_control_server(address, mgr_chan, cld_chan): 48 | cs = ControlServer(address, mgr_chan, cld_chan) 49 | cs.serve_forever() 50 | 51 | # vim: ts=4 sw=4 sts=4 expandtab 52 | -------------------------------------------------------------------------------- /tunasync/btrfs_snapshot.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python2 2 | # -*- coding:utf-8 -*- 3 | import sh 4 | import os 5 | from datetime import datetime 6 | from .hook import JobHook 7 | 8 | 9 | class BtrfsVolumeError(Exception): 10 | pass 11 | 12 | 13 | class BtrfsHook(JobHook): 14 | 15 | def __init__(self, service_dir, working_dir, gc_dir): 16 | self.service_dir = service_dir 17 | self.working_dir = working_dir 18 | self.gc_dir = gc_dir 19 | 20 | def before_job(self, ctx={}, *args, **kwargs): 21 | self._create_working_snapshot() 22 | ctx['current_dir'] = self.working_dir 23 | 24 | def after_job(self, status=None, ctx={}, *args, **kwargs): 25 | if status == "success": 26 | self._commit_changes() 27 | ctx['current_dir'] = self.service_dir 28 | 29 | def _ensure_subvolume(self): 30 | # print(self.service_dir) 31 | try: 32 | ret = sh.btrfs("subvolume", "show", self.service_dir) 33 | except Exception, e: 34 | print(e) 35 | raise BtrfsVolumeError("Invalid subvolume") 36 | 37 | if ret.stderr != '': 38 | raise BtrfsVolumeError("Invalid subvolume") 39 | 40 | def _create_working_snapshot(self): 41 | self._ensure_subvolume() 42 | if os.path.exists(self.working_dir): 43 | print("Warning: working dir existed, are you sure no rsync job is running?") 44 | else: 45 | # print("btrfs subvolume snapshot {} {}".format(self.service_dir, self.working_dir)) 46 | sh.btrfs("subvolume", "snapshot", self.service_dir, self.working_dir) 47 | 48 | def _commit_changes(self): 49 | self._ensure_subvolume() 50 | self._ensure_subvolume() 51 | gc_dir = self.gc_dir.format(timestamp=datetime.now().strftime("%s")) 52 | 53 | out = sh.mv(self.service_dir, gc_dir) 54 | assert out.exit_code == 0 and out.stderr == "" 55 | out = sh.mv(self.working_dir, self.service_dir) 56 | assert out.exit_code == 0 and out.stderr == "" 57 | # print("btrfs subvolume delete {}".format(self.tmp_dir)) 58 | # sh.sleep(3) 59 | # out = sh.btrfs("subvolume", "delete", self.tmp_dir) 60 | # assert out.exit_code == 0 and out.stderr == "" 61 | 62 | # vim: ts=4 sw=4 sts=4 expandtab 63 | -------------------------------------------------------------------------------- /tunasync/jobs.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python2 2 | # -*- coding:utf-8 -*- 3 | import sh 4 | import sys 5 | from setproctitle import setproctitle 6 | import signal 7 | import Queue 8 | 9 | 10 | def run_job(sema, child_q, manager_q, provider, **settings): 11 | aquired = False 12 | setproctitle("tunasync-{}".format(provider.name)) 13 | 14 | def before_quit(*args): 15 | provider.terminate() 16 | if aquired: 17 | print("{} release semaphore".format(provider.name)) 18 | sema.release() 19 | sys.exit(0) 20 | 21 | signal.signal(signal.SIGTERM, before_quit) 22 | 23 | max_retry = settings.get("max_retry", 1) 24 | while 1: 25 | try: 26 | sema.acquire(True) 27 | except: 28 | break 29 | aquired = True 30 | 31 | status = "syncing" 32 | manager_q.put(("UPDATE", (provider.name, status))) 33 | ctx = {} # put context info in it 34 | ctx['current_dir'] = provider.local_dir 35 | 36 | try: 37 | for hook in provider.hooks: 38 | hook.before_job(provider=provider, ctx=ctx) 39 | except Exception: 40 | import traceback 41 | traceback.print_exc() 42 | status = "fail" 43 | else: 44 | for retry in range(max_retry): 45 | print("start syncing {}, retry: {}".format(provider.name, retry)) 46 | provider.run(ctx=ctx) 47 | 48 | status = "success" 49 | try: 50 | provider.wait() 51 | except sh.ErrorReturnCode: 52 | status = "fail" 53 | 54 | if status == "success": 55 | break 56 | 57 | try: 58 | for hook in provider.hooks[::-1]: 59 | hook.after_job(provider=provider, status=status, ctx=ctx) 60 | except Exception: 61 | import traceback 62 | traceback.print_exc() 63 | status = "fail" 64 | 65 | sema.release() 66 | aquired = False 67 | 68 | print("syncing {} finished, sleep {} minutes for the next turn".format( 69 | provider.name, provider.interval 70 | )) 71 | 72 | manager_q.put(("UPDATE", (provider.name, status))) 73 | 74 | try: 75 | msg = child_q.get(timeout=provider.interval * 60) 76 | if msg == "terminate": 77 | manager_q.put(("CONFIG_ACK", (provider.name, "QUIT"))) 78 | break 79 | except Queue.Empty: 80 | pass 81 | 82 | 83 | # vim: ts=4 sw=4 sts=4 expandtab 84 | -------------------------------------------------------------------------------- /tunasync/loglimit.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python2 2 | # -*- coding:utf-8 -*- 3 | import sh 4 | import os 5 | from .hook import JobHook 6 | from datetime import datetime 7 | 8 | 9 | class LogLimitHook(JobHook): 10 | 11 | def __init__(self, limit=10): 12 | self.limit = limit 13 | 14 | def before_job(self, provider, ctx={}, *args, **kwargs): 15 | log_dir = provider.log_dir 16 | self.ensure_log_dir(log_dir) 17 | log_file = provider.log_file.format( 18 | date=datetime.now().strftime("%Y-%m-%d_%H-%M")) 19 | ctx['log_file'] = log_file 20 | if log_file == "/dev/null": 21 | return 22 | 23 | log_link = os.path.join(log_dir, "latest") 24 | ctx['log_link'] = log_link 25 | 26 | lfiles = [os.path.join(log_dir, lfile) 27 | for lfile in os.listdir(log_dir) 28 | if lfile.startswith(provider.name)] 29 | 30 | lfiles_set = set(lfiles) 31 | # sort to get the newest 10 files 32 | lfiles_ts = sorted( 33 | [(os.path.getmtime(lfile), lfile) for lfile in lfiles], 34 | key=lambda x: x[0], 35 | reverse=True) 36 | lfiles_keep = set([x[1] for x in lfiles_ts[:self.limit]]) 37 | lfiles_rm = lfiles_set - lfiles_keep 38 | # remove old files 39 | for lfile in lfiles_rm: 40 | try: 41 | sh.rm(lfile) 42 | except: 43 | pass 44 | 45 | # create a soft link 46 | self.create_link(log_link, log_file) 47 | 48 | def after_job(self, status=None, ctx={}, *args, **kwargs): 49 | log_file = ctx.get('log_file', None) 50 | log_link = ctx.get('log_link', None) 51 | if log_file == "/dev/null": 52 | return 53 | if status == "fail": 54 | log_file_save = log_file + ".fail" 55 | try: 56 | sh.mv(log_file, log_file_save) 57 | except: 58 | pass 59 | self.create_link(log_link, log_file_save) 60 | 61 | def ensure_log_dir(self, log_dir): 62 | if not os.path.exists(log_dir): 63 | sh.mkdir("-p", log_dir) 64 | 65 | def create_link(self, log_link, log_file): 66 | if log_link == log_file: 67 | return 68 | if not (log_link and log_file): 69 | return 70 | 71 | if os.path.lexists(log_link): 72 | try: 73 | sh.rm(log_link) 74 | except: 75 | return 76 | try: 77 | sh.ln('-s', log_file, log_link) 78 | except: 79 | return 80 | 81 | 82 | # vim: ts=4 sw=4 sts=4 expandtab 83 | -------------------------------------------------------------------------------- /tunasync/status_manager.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python2 2 | # -*- coding:utf-8 -*- 3 | import json 4 | from datetime import datetime 5 | 6 | 7 | class StatusManager(object): 8 | 9 | def __init__(self, parent, dbfile): 10 | self.parent = parent 11 | self.dbfile = dbfile 12 | self.init_mirrors() 13 | 14 | def init_mirrors(self): 15 | mirrors = {} 16 | try: 17 | with open(self.dbfile) as f: 18 | _mirrors = json.load(f) 19 | for m in _mirrors: 20 | mirrors[m["name"]] = m 21 | except: 22 | for name, _ in self.parent.mirrors.iteritems(): 23 | mirrors[name] = { 24 | 'name': name, 25 | 'last_update': '-', 26 | 'status': 'unknown', 27 | } 28 | self.mirrors = mirrors 29 | 30 | def update_status(self, name, status): 31 | 32 | _m = self.mirrors.get(name, { 33 | 'name': name, 34 | 'last_update': '-', 35 | 'status': '-', 36 | }) 37 | 38 | if status in ("syncing", "fail"): 39 | update_time = _m["last_update"] 40 | elif status == "success": 41 | update_time = datetime.now().strftime("%Y-%m-%d %H:%M:%S") 42 | else: 43 | print("Invalid status: {}, from {}".format(status, name)) 44 | 45 | self.mirrors[name] = { 46 | 'name': name, 47 | 'last_update': update_time, 48 | 'status': status, 49 | } 50 | 51 | with open(self.dbfile, 'wb') as f: 52 | _mirrors = self.list_status() 53 | print("Updated status file, {}:{}".format(name, status)) 54 | json.dump(_mirrors, f) 55 | 56 | def list_status(self, _format=False): 57 | _mirrors = sorted( 58 | [m for _, m in self.mirrors.items()], 59 | key=lambda x: x['name'] 60 | ) 61 | if not _format: 62 | return _mirrors 63 | 64 | name_len = max([len(_m['name']) for _m in _mirrors]) 65 | update_len = max([len(_m['last_update']) for _m in _mirrors]) 66 | status_len = max([len(_m['status']) for _m in _mirrors]) 67 | heading = ' '.join([ 68 | 'name'.ljust(name_len), 69 | 'last update'.ljust(update_len), 70 | 'status'.ljust(status_len) 71 | ]) 72 | line = ' '.join(['-'*name_len, '-'*update_len, '-'*status_len]) 73 | tabular = '\n'.join( 74 | [ 75 | ' '.join( 76 | (_m['name'].ljust(name_len), 77 | _m['last_update'].ljust(update_len), 78 | _m['status'].ljust(status_len)) 79 | ) for _m in _mirrors 80 | ] 81 | ) 82 | return '\n'.join((heading, line, tabular)) 83 | 84 | def get_status(self, name, _format=False): 85 | if name not in self.mirrors: 86 | return None 87 | 88 | mir = self.mirrors[name] 89 | if not _format: 90 | return mir 91 | 92 | tmpl = "{name} last_update: {last_update} status: {status}" 93 | return tmpl.format(**mir) 94 | 95 | 96 | # vim: ts=4 sw=4 sts=4 expandtab 97 | -------------------------------------------------------------------------------- /tunasync/mirror_config.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python2 2 | # -*- coding:utf-8 -*- 3 | import os 4 | from .mirror_provider import RsyncProvider, ShellProvider 5 | from .btrfs_snapshot import BtrfsHook 6 | from .loglimit import LogLimitHook 7 | 8 | 9 | class MirrorConfig(object): 10 | 11 | _valid_providers = set(("rsync", "debmirror", "shell", )) 12 | 13 | def __init__(self, parent, options): 14 | self._parent = parent 15 | self._popt = self._parent._settings 16 | self.options = dict(options.items()) # copy 17 | self._validate() 18 | 19 | def _validate(self): 20 | provider = self.options.get("provider", None) 21 | assert provider in self._valid_providers 22 | 23 | if provider == "rsync": 24 | assert "upstream" in self.options 25 | 26 | elif provider == "shell": 27 | assert "command" in self.options 28 | 29 | local_dir_tmpl = self.options.get( 30 | "local_dir", self._popt["global"]["local_dir"]) 31 | 32 | self.options["local_dir"] = local_dir_tmpl.format( 33 | mirror_root=self._popt["global"]["mirror_root"], 34 | mirror_name=self.name, 35 | ) 36 | 37 | if "interval" not in self.options: 38 | self.options["interval"] = self._popt["global"]["interval"] 39 | 40 | assert isinstance(self.options["interval"], int) 41 | 42 | log_dir = self.options.get( 43 | "log_dir", self._popt["global"]["log_dir"]) 44 | if "log_file" not in self.options: 45 | self.options["log_file"] = os.path.join( 46 | log_dir, self.name, self.name + "_{date}.log") 47 | 48 | self.log_dir = os.path.dirname(self.log_file) 49 | 50 | if "use_btrfs" not in self.options: 51 | self.options["use_btrfs"] = self._parent.use_btrfs 52 | assert self.options["use_btrfs"] in (True, False) 53 | 54 | def __getattr__(self, key): 55 | if key in self.__dict__: 56 | return self.__dict__[key] 57 | else: 58 | return self.__dict__["options"].get(key, None) 59 | 60 | def to_provider(self, hooks=[]): 61 | if self.provider == "rsync": 62 | provider = RsyncProvider( 63 | name=self.name, 64 | upstream_url=self.upstream, 65 | local_dir=self.local_dir, 66 | log_dir=self.log_dir, 67 | useIPv6=self.use_ipv6, 68 | password=self.password, 69 | exclude_file=self.exclude_file, 70 | log_file=self.log_file, 71 | interval=self.interval, 72 | hooks=hooks, 73 | ) 74 | elif self.options["provider"] == "shell": 75 | provider = ShellProvider( 76 | name=self.name, 77 | command=self.command, 78 | upstream_url=self.upstream, 79 | local_dir=self.local_dir, 80 | log_dir=self.log_dir, 81 | log_file=self.log_file, 82 | interval=self.interval, 83 | hooks=hooks 84 | ) 85 | 86 | return provider 87 | 88 | def compare(self, other): 89 | assert self.name == other.name 90 | 91 | for key, val in self.options.iteritems(): 92 | if other.options.get(key, None) != val: 93 | return False 94 | 95 | return True 96 | 97 | def hooks(self): 98 | hooks = [] 99 | parent = self._parent 100 | if self.options["use_btrfs"]: 101 | working_dir = parent.btrfs_working_dir_tmpl.format( 102 | mirror_root=parent.mirror_root, 103 | mirror_name=self.name 104 | ) 105 | service_dir = parent.btrfs_service_dir_tmpl.format( 106 | mirror_root=parent.mirror_root, 107 | mirror_name=self.name 108 | ) 109 | gc_dir = parent.btrfs_gc_dir_tmpl.format( 110 | mirror_root=parent.mirror_root, 111 | mirror_name=self.name 112 | ) 113 | hooks.append(BtrfsHook(service_dir, working_dir, gc_dir)) 114 | 115 | hooks.append(LogLimitHook()) 116 | return hooks 117 | 118 | # vim: ts=4 sw=4 sts=4 expandtab 119 | -------------------------------------------------------------------------------- /tunasync/mirror_provider.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python2 2 | # -*- coding:utf-8 -*- 3 | import sh 4 | import os 5 | from datetime import datetime 6 | 7 | 8 | class MirrorProvider(object): 9 | ''' 10 | Mirror method class, can be `rsync', `debmirror', etc. 11 | ''' 12 | 13 | def __init__(self, name, local_dir, log_dir, log_file="/dev/null", 14 | interval=120, hooks=[]): 15 | self.name = name 16 | self.local_dir = local_dir 17 | self.log_file = log_file 18 | self.log_dir = log_dir 19 | self.interval = interval 20 | self.hooks = hooks 21 | self.p = None 22 | 23 | # deprecated 24 | def ensure_log_dir(self): 25 | log_dir = os.path.dirname(self.log_file) 26 | if not os.path.exists(log_dir): 27 | sh.mkdir("-p", log_dir) 28 | 29 | def get_log_file(self, ctx={}): 30 | if 'log_file' in ctx: 31 | log_file = ctx['log_file'] 32 | else: 33 | now = datetime.now().strftime("%Y-%m-%d_%H") 34 | log_file = self.log_file.format(date=now) 35 | ctx['log_file'] = log_file 36 | return log_file 37 | 38 | def run(self, ctx={}): 39 | raise NotImplementedError("run method should be implemented") 40 | 41 | def terminate(self): 42 | if self.p is not None: 43 | self.p.process.terminate() 44 | print("{} terminated".format(self.name)) 45 | self.p = None 46 | 47 | def wait(self): 48 | if self.p is not None: 49 | self.p.wait() 50 | self.p = None 51 | 52 | 53 | class RsyncProvider(MirrorProvider): 54 | 55 | _default_options = ['-aHvh', '--no-o', '--no-g', '--stats', 56 | '--delete', '--delete-delay', '--safe-links', 57 | '--timeout=120', '--contimeout=120'] 58 | 59 | def __init__(self, name, upstream_url, local_dir, log_dir, 60 | useIPv6=True, password=None, exclude_file=None, 61 | log_file="/dev/null", interval=120, hooks=[]): 62 | super(RsyncProvider, self).__init__(name, local_dir, log_dir, log_file, 63 | interval, hooks) 64 | 65 | self.upstream_url = upstream_url 66 | self.useIPv6 = useIPv6 67 | self.exclude_file = exclude_file 68 | self.password = password 69 | 70 | @property 71 | def options(self): 72 | 73 | _options = [o for o in self._default_options] # copy 74 | 75 | if self.useIPv6: 76 | _options.append("-6") 77 | 78 | if self.exclude_file: 79 | _options.append("--exclude-from") 80 | _options.append(self.exclude_file) 81 | 82 | return _options 83 | 84 | def run(self, ctx={}): 85 | _args = self.options 86 | _args.append(self.upstream_url) 87 | 88 | working_dir = ctx.get("current_dir", self.local_dir) 89 | _args.append(working_dir) 90 | 91 | log_file = self.get_log_file(ctx) 92 | new_env = os.environ.copy() 93 | if self.password is not None: 94 | new_env["RSYNC_PASSWORD"] = self.password 95 | 96 | self.p = sh.rsync(*_args, _env=new_env, _out=log_file, _err=log_file, 97 | _out_bufsize=1, _bg=True) 98 | 99 | 100 | class ShellProvider(MirrorProvider): 101 | 102 | def __init__(self, name, command, upstream_url, local_dir, log_dir, 103 | log_file="/dev/null", interval=120, hooks=[]): 104 | 105 | super(ShellProvider, self).__init__(name, local_dir, log_dir, log_file, 106 | interval, hooks) 107 | self.upstream_url = str(upstream_url) 108 | self.command = command.split() 109 | 110 | def run(self, ctx={}): 111 | 112 | log_file = self.get_log_file(ctx) 113 | 114 | new_env = os.environ.copy() 115 | new_env["TUNASYNC_MIRROR_NAME"] = self.name 116 | new_env["TUNASYNC_LOCAL_DIR"] = self.local_dir 117 | new_env["TUNASYNC_WORKING_DIR"] = ctx.get("current_dir", self.local_dir) 118 | new_env["TUNASYNC_UPSTREAM_URL"] = self.upstream_url 119 | new_env["TUNASYNC_LOG_FILE"] = log_file 120 | 121 | _cmd = self.command[0] 122 | _args = [] if len(self.command) == 1 else self.command[1:] 123 | 124 | cmd = sh.Command(_cmd) 125 | self.p = cmd(*_args, _env=new_env, _out=log_file, 126 | _err=log_file, _out_bufsize=1, _bg=True) 127 | 128 | 129 | # vim: ts=4 sw=4 sts=4 expandtab 130 | -------------------------------------------------------------------------------- /tunasync/tunasync.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python2 2 | # -*- coding:utf-8 -*- 3 | import signal 4 | import sys 5 | import toml 6 | 7 | from multiprocessing import Process, Semaphore, Queue 8 | from . import jobs 9 | from .hook import JobHook 10 | from .mirror_config import MirrorConfig 11 | from .status_manager import StatusManager 12 | from .clt_server import run_control_server 13 | 14 | 15 | class TUNASync(object): 16 | 17 | _instance = None 18 | _settings = None 19 | _inited = False 20 | 21 | def __new__(cls, *args, **kwargs): 22 | if not cls._instance: 23 | cls._instance = super(TUNASync, cls).__new__(cls, *args, **kwargs) 24 | 25 | return cls._instance 26 | 27 | def read_config(self, config_file): 28 | self._config_file = config_file 29 | with open(self._config_file) as f: 30 | self._settings = toml.loads(f.read()) 31 | 32 | self._inited = True 33 | self._mirrors = {} 34 | self._providers = {} 35 | self.processes = {} 36 | self.semaphore = Semaphore(self._settings["global"]["concurrent"]) 37 | self.channel = Queue() 38 | self._hooks = [] 39 | 40 | self.mirror_root = self._settings["global"]["mirror_root"] 41 | 42 | self.use_btrfs = self._settings["global"]["use_btrfs"] 43 | self.btrfs_service_dir_tmpl = self._settings["btrfs"]["service_dir"] 44 | self.btrfs_working_dir_tmpl = self._settings["btrfs"]["working_dir"] 45 | self.btrfs_gc_dir_tmpl = self._settings["btrfs"]["gc_dir"] 46 | 47 | self.status_file = self._settings["global"]["status_file"] 48 | self.status_manager = StatusManager(self, self.status_file) 49 | 50 | self.ctrl_addr = self._settings["global"]["ctrl_addr"] 51 | self.ctrl_channel = Queue() 52 | p = Process( 53 | target=run_control_server, 54 | args=(self.ctrl_addr, self.channel, self.ctrl_channel), 55 | ) 56 | p.start() 57 | self.processes["CTRL_SERVER"] = (self.ctrl_channel, p) 58 | 59 | def add_hook(self, h): 60 | assert isinstance(h, JobHook) 61 | self._hooks.append(h) 62 | 63 | def hooks(self): 64 | return self._hooks 65 | 66 | @property 67 | def mirrors(self): 68 | if self._mirrors: 69 | return self._mirrors 70 | 71 | for mirror_opt in self._settings["mirrors"]: 72 | name = mirror_opt["name"] 73 | self._mirrors[name] = \ 74 | MirrorConfig(self, mirror_opt) 75 | 76 | return self._mirrors 77 | 78 | @property 79 | def providers(self): 80 | if self._providers: 81 | return self._providers 82 | 83 | for name, mirror in self.mirrors.iteritems(): 84 | hooks = mirror.hooks() + self.hooks() 85 | provider = mirror.to_provider(hooks) 86 | self._providers[name] = provider 87 | 88 | return self._providers 89 | 90 | def run_jobs(self): 91 | for name in self.providers: 92 | self.run_provider(name) 93 | 94 | def sig_handler(*args): 95 | print("terminate subprocesses") 96 | for _, np in self.processes.iteritems(): 97 | _, p = np 98 | p.terminate() 99 | print("Good Bye") 100 | sys.exit(0) 101 | 102 | signal.signal(signal.SIGINT, sig_handler) 103 | signal.signal(signal.SIGTERM, sig_handler) 104 | signal.signal(signal.SIGUSR1, self.reload_mirrors) 105 | signal.signal(signal.SIGUSR2, self.reload_mirrors_force) 106 | 107 | self.run_forever() 108 | 109 | def run_provider(self, name): 110 | if name not in self.providers: 111 | print("{} doesnot exist".format(name)) 112 | return 113 | 114 | provider = self.providers[name] 115 | child_queue = Queue() 116 | p = Process( 117 | target=jobs.run_job, 118 | args=(self.semaphore, child_queue, self.channel, provider, ), 119 | kwargs={'max_retry': self._settings['global']['max_retry']} 120 | ) 121 | p.start() 122 | self.processes[name] = (child_queue, p) 123 | 124 | def reload_mirrors(self, signum, frame): 125 | try: 126 | return self._reload_mirrors(signum, frame, force=False) 127 | except Exception, e: 128 | print(e) 129 | 130 | def reload_mirrors_force(self, signum, frame): 131 | try: 132 | return self._reload_mirrors(signum, frame, force=True) 133 | except Exception, e: 134 | print(e) 135 | 136 | def _reload_mirrors(self, signum, frame, force=False): 137 | print("reload mirror configs, force restart: {}".format(force)) 138 | 139 | with open(self._config_file) as f: 140 | self._settings = toml.loads(f.read()) 141 | 142 | for mirror_opt in self._settings["mirrors"]: 143 | name = mirror_opt["name"] 144 | newMirCfg = MirrorConfig(self, mirror_opt) 145 | 146 | if name in self._mirrors: 147 | if newMirCfg.compare(self._mirrors[name]): 148 | continue 149 | 150 | self._mirrors[name] = newMirCfg 151 | 152 | hooks = newMirCfg.hooks() + self.hooks() 153 | newProvider = newMirCfg.to_provider(hooks) 154 | self._providers[name] = newProvider 155 | 156 | if name in self.processes: 157 | q, p = self.processes[name] 158 | 159 | if force: 160 | p.terminate() 161 | print("Terminated Job: {}".format(name)) 162 | self.run_provider(name) 163 | else: 164 | q.put("terminate") 165 | print("New configuration queued to {}".format(name)) 166 | else: 167 | print("New mirror: {}".format(name)) 168 | self.run_provider(name) 169 | 170 | def run_forever(self): 171 | while 1: 172 | 173 | try: 174 | msg_hdr, msg_body = self.channel.get() 175 | except IOError: 176 | continue 177 | 178 | if msg_hdr == "UPDATE": 179 | name, status = msg_body 180 | try: 181 | self.status_manager.update_status(name, status) 182 | except Exception as e: 183 | print(e) 184 | 185 | elif msg_hdr == "CONFIG_ACK": 186 | name, status = msg_body 187 | if status == "QUIT": 188 | print("New configuration applied to {}".format(name)) 189 | self.run_provider(name) 190 | 191 | elif msg_hdr == "CMD": 192 | cmd, name = msg_body 193 | if (name not in self.mirrors) and (name != "__ALL__"): 194 | self.ctrl_channel.put("Invalid target") 195 | continue 196 | 197 | if cmd == "restart": 198 | _, p = self.processes[name] 199 | p.terminate() 200 | self.run_provider(name) 201 | res = "Restarted Job: {}".format(name) 202 | 203 | elif cmd == "stop": 204 | if name not in self.processes: 205 | res = "{} not running".format(name) 206 | self.ctrl_channel.put(res) 207 | continue 208 | 209 | _, p = self.processes.pop(name) 210 | p.terminate() 211 | res = "Stopped Job: {}".format(name) 212 | 213 | elif cmd == "start": 214 | if name in self.processes: 215 | res = "{} already running".format(name) 216 | self.ctrl_channel.put(res) 217 | continue 218 | 219 | self.run_provider(name) 220 | res = "Started Job: {}".format(name) 221 | elif cmd == "status": 222 | if name == "__ALL__": 223 | res = self.status_manager.list_status(_format=True) 224 | else: 225 | res = self.status_manager.get_status(name, _format=True) 226 | else: 227 | res = "Invalid command" 228 | 229 | self.ctrl_channel.put(res) 230 | # vim: ts=4 sw=4 sts=4 expandtab 231 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 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 | {project} Copyright (C) {year} {fullname} 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 | 676 | --------------------------------------------------------------------------------