├── log └── .empty ├── cronitor ├── __init__.py ├── config.py └── model.py ├── .gitignore ├── AUTHORS ├── requirements.txt ├── doc └── dashboard.png ├── init ├── upstart.conf └── systemd.service ├── Dockerfile ├── templates ├── index.html ├── log.html └── log-list.html ├── assets └── style.css ├── docker-compose.yml ├── server.yaml ├── cfg └── rules.yaml ├── cronitor-server ├── cronitor-run ├── README.rst └── COPYING /log/.empty: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /cronitor/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | logs -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | Joshua J. Berry 2 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | PyYAML>=3.10 2 | tornado>=2.1 3 | -------------------------------------------------------------------------------- /doc/dashboard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/josh-berry/cronitor/HEAD/doc/dashboard.png -------------------------------------------------------------------------------- /init/upstart.conf: -------------------------------------------------------------------------------- 1 | description "Cronitor cron-job monitoring server" 2 | author "Joshua J. Berry " 3 | 4 | start on filesystem and runlevel [2345] 5 | 6 | respawn 7 | 8 | setuid cronitor 9 | setgid cronitor 10 | 11 | exec /opt/cronitor/cronitor-server -c /opt/cronitor/server.yaml 12 | -------------------------------------------------------------------------------- /init/systemd.service: -------------------------------------------------------------------------------- 1 | # Drop this file in /etc/systemd/system, and symlink it into an appropriate 2 | # *.target directory. Make sure you have setup a "cronitor" user, and that it 3 | # can write to your logs directory (as specified in server.yaml). 4 | 5 | [Unit] 6 | Description=Cronitor Cron-Job Monitor 7 | After=network.target 8 | 9 | [Service] 10 | Type=simple 11 | ExecStart=/srv/cronitor/cronitor-server -c /srv/cronitor/server.yaml 12 | Restart=always 13 | User=cronitor -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # Directories where Cronitor expects to find things (unless you modify this 2 | # file and/or server.yaml): 3 | # 4 | # - /app - static application files for Cronitor itself 5 | # - /cfg - directory containing rules.yaml file 6 | # - /log - log files collected from jobs 7 | 8 | FROM python:3-alpine 9 | # Consider python:2-slim if there are libc problems 10 | 11 | RUN apk add --no-cache tzdata 12 | 13 | COPY requirements.txt /app/requirements.txt 14 | RUN pip install --no-cache-dir -r /app/requirements.txt 15 | 16 | COPY assets /app/assets 17 | COPY templates /app/templates 18 | COPY cronitor /app/cronitor 19 | COPY cronitor-server /app/cronitor-server 20 | COPY server.yaml /app/server.yaml 21 | 22 | COPY cfg /cfg 23 | VOLUME /cfg 24 | 25 | VOLUME /log 26 | 27 | EXPOSE 8434 28 | 29 | ENV PYTHONPATH=/app 30 | CMD [ "python", "/app/cronitor-server", "-c", "/app/server.yaml" ] 31 | -------------------------------------------------------------------------------- /templates/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | Cronitor 4 | 5 | 6 | 7 |

Cronitor Job Dashboard

8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | {% for job in jobs.jobs %} 16 | {% set ent = job.latest_entry %} 17 | 18 | 19 | 20 | 21 | 25 | {% end %} 26 |
NameLast RunStatusLog
{{ job.name }}{{ ent.timestamp }}{{ job.status }} 22 | newest 23 | all... 24 |
27 | 28 | 29 | -------------------------------------------------------------------------------- /assets/style.css: -------------------------------------------------------------------------------- 1 | TABLE { 2 | margin: 20px 6px; 3 | background-color: #e0e0e0; 4 | border: solid 1px #c0c0c0; 5 | font-family: sans-serif; 6 | } 7 | TH { 8 | background-color: #d0d0d0; 9 | padding: 4px; 10 | } 11 | TD { 12 | padding: 4px; 13 | } 14 | 15 | .config TH { 16 | text-align: left; 17 | } 18 | 19 | .job_ok { 20 | //background-color: #c0ffc0; 21 | } 22 | .job_overdue { 23 | background-color: #ffff00; 24 | } 25 | .job_failed, .job_error { 26 | background-color: #ff8080; 27 | } 28 | 29 | .job_overdue_warning { 30 | background-color: #ffff00; 31 | font-weight: bold; 32 | text-align: center; 33 | } 34 | 35 | .log_metadata TH, .log_metadata TD { 36 | padding: 2px; 37 | } 38 | 39 | .log_metadata TH { 40 | text-align: left; 41 | } 42 | 43 | .log_text, .log_metadata TD { 44 | white-space: pre; 45 | font-family: monospace; 46 | } 47 | 48 | .log_error { 49 | font-weight: bold; 50 | color: white; 51 | background-color: red; 52 | } 53 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | # This is an example docker-compose file for exposing Cronitor on localhost port 2 | # 4217 (= 8434 / 2, where 8434 is the default Cronitor port). You should 3 | # copy/write your own docker-compose file which suits your needs. 4 | # 5 | # You can use it for development/testing like this: 6 | # 7 | # $ docker-compose build 8 | # $ docker stack deploy -c docker-compose.yml teststack 9 | 10 | services: 11 | cronitor: 12 | build: . 13 | image: cronitor:latest 14 | 15 | # In production, we recommend something like the following: 16 | # 17 | #environment: 18 | # - TZ=$(cat /etc/timezone) 19 | 20 | volumes: 21 | - ./cfg:/cfg:ro 22 | - ./log:/log 23 | 24 | ports: 25 | - 4217:8434 26 | 27 | deploy: 28 | replicas: 1 29 | resources: 30 | limits: 31 | # Reasonable for a small-to-medium Cronitor deployment. Note that 32 | # Cronitor is single-threaded so bumping up the cpus won't help. 33 | cpus: "1" 34 | memory: 256M 35 | restart_policy: 36 | condition: on-failure 37 | -------------------------------------------------------------------------------- /templates/log.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | Log: {{ entry.job.name }} at {{ entry.timestamp }} 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 |
Command:{{ entry.command }}
Timestamp:{{ entry.timestamp }}
Return Code:{{ entry.rc }}
22 | 23 | 24 | {% set sorted_env = list(entry.env.items()) %} 25 | 26 | {% for k, v in sorted_env %} 27 | 28 | 29 | 30 | 31 | {% end %} 32 |
{{ k }}{{ v }}
33 | 34 |
{% for line, is_err in entry.scan_text() %}{% if is_err %}{{ line.rstrip() }}{% else %}{{ line.rstrip() }}{% end %} 35 | {% end %}
36 | 37 | 38 | -------------------------------------------------------------------------------- /server.yaml: -------------------------------------------------------------------------------- 1 | # Controls the Cronitor server process. It's read once on startup, so if you 2 | # want to change anything here, you have to restart the server. The defaults 3 | # are designed for Docker deployments, assuming you have Docker volumes 4 | # mounted in the container at /cfg and /log. 5 | # 6 | # Any relative path will be interpreted relative to this config file. 7 | 8 | 9 | # The directory used to hold log files from jobs. Must be writable by the 10 | # server. 11 | job_dir: /log 12 | 13 | # The directory where templates are stored. Must ONLY be readable by the 14 | # server. The templates contain executable code. 15 | template_dir: templates 16 | 17 | # Static files that will be served up by the server (CSS, images, etc.) 18 | asset_dir: assets 19 | 20 | # Rules file that describes the jobs we expect and their policies. This is 21 | # re-read by the server as needed, so there's no need to restart it if you 22 | # change something here. 23 | rules_file: /cfg/rules.yaml 24 | 25 | # If you want to change the interfaces/ports that cronitor-server listens on, 26 | # uncomment this; the default is port 8434 on all interfaces: 27 | #listen_on: 28 | # - "*:8434" 29 | # - "localhost:8434" 30 | # - ... 31 | -------------------------------------------------------------------------------- /templates/log-list.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | Logs for: {{ job.name }} 4 | 5 | 6 | 7 |

Logs for: {{ job.name }}

8 | 9 | 10 | 11 | 12 | 13 | 14 | {% if job.is_overdue %} 15 | 16 | 19 | 20 | {% end %} 21 | {% for entry in job.log_entries %} 22 | 23 | 24 | 25 | 26 | 27 | {% end %} 28 |
TimestampStatusLog
17 | This job is overdue by {{ job.is_overdue }}. 18 |
{{ entry.timestamp }}{{ entry.status }}log
29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 |
New logs expected every:{{ job.rules.due_every }}
Logs deleted after:{{ job.rules.keep }}
40 | 41 | 42 | -------------------------------------------------------------------------------- /cfg/rules.yaml: -------------------------------------------------------------------------------- 1 | # Each entry in this list is a rule describes a job, or set of jobs matched by 2 | # shell-style wildcard. 3 | # 4 | # Rules are processed in order, so the first entry that matches a 5 | # particular job name is used. However, if a parameter (such as /errors/ 6 | # or /ignores/) takes a list of values, the lists from all rules matching a 7 | # job will be concatenated. 8 | # 9 | # Each rule can have several parameters: 10 | # 11 | # "match" is a shell-style wildcard pattern. Job names are tested against 12 | # this pattern to see if the rule matches the job. 13 | # 14 | # "keep" is a duration -- we will keep logs from matching jobs for at least 15 | # this long. 16 | # 17 | # "due_every" is a duration -- we expect matching jobs to run at least this 18 | # frequently. If a job has not reported in more than /due_every/ 19 | # minutes/hours/days/etc. after it last ran, the job is considered 20 | # "overdue". 21 | # 22 | # Additionally, each rule has several lists of regexes, which are matched 23 | # against lines from a job's output. 24 | # 25 | # Lines which match "errors" and "errors_i" regexes are considered errors. If 26 | # there are any such matches in a job's output, the entire job is considered 27 | # to have failed. 28 | # 29 | # Lines which match "ignores" and "ignores_i" regexes are exceptions to the 30 | # error regexes. Even if a line matches an error regex, if it ALSO matches an 31 | # ignore regex it will not be considered an error. 32 | # 33 | # The *_i variants of "errors" and "ignores" are case-insensitive. 34 | 35 | 36 | - match: "email-archive" 37 | due_every: 10sec 38 | 39 | - match: "*dr-backup*" 40 | due_every: 1d 1h 41 | 42 | - match: "*unison*fast*" 43 | due_every: 1h 15min 44 | 45 | - match: "*unison*" 46 | due_every: 1d 1hr 47 | ignores: 48 | - " 0 failed" 49 | 50 | - match: "*lj-backup*" 51 | due_every: 1d 1h 52 | 53 | - match: "*scrub*" 54 | due_every: 1mo 1d 55 | keep: 1yr 56 | 57 | - match: "*" 58 | due_every: 1h 59 | errors_i: 60 | - "error" 61 | - "failed" 62 | - "timed out" 63 | - "timeout" 64 | -------------------------------------------------------------------------------- /cronitor-server: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # 3 | # Author:: Joshua J. Berry 4 | # Copyright:: Copyright (c) 2013, Joshua J. Berry 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or (at 9 | # your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, but 12 | # WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 | # General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | # 19 | 20 | from datetime import datetime 21 | 22 | import optparse 23 | 24 | import tornado.ioloop 25 | import tornado.httpserver 26 | import tornado.web 27 | import tornado.template 28 | 29 | from cronitor.model import JobSet 30 | from cronitor.config import CronitorConfig 31 | 32 | 33 | 34 | def main(): 35 | optp = optparse.OptionParser() 36 | optp.add_option("-c", "--config", dest="config", metavar="FILE", 37 | help="The configuration file to use.") 38 | opts, args = optp.parse_args() 39 | assert not args 40 | 41 | config = CronitorConfig(opts.config) 42 | jobset = JobSet(config) 43 | application = make_app(config.template_dir, config.asset_dir, jobset) 44 | 45 | server = tornado.httpserver.HTTPServer(application) 46 | for addr, port in config.listen_on: 47 | server.bind(port, address=addr) 48 | server.start() 49 | 50 | tornado.ioloop.IOLoop.instance().start() 51 | 52 | 53 | 54 | def make_app(template_dir: str, asset_dir: str, jobset: JobSet) -> tornado.web.Application: 55 | return tornado.web.Application( 56 | handlers=[ 57 | (r"/", MainHandler(jobset)), 58 | (r"/submit/([a-zA-Z0-9_-]*)", LogSubmitHandler(jobset)), 59 | (r"/log/([a-zA-Z0-9._-]*)/?", LogListHandler(jobset)), 60 | (r"/log/([a-zA-Z0-9_-]*)/([^/]*)", LogRetrieveHandler(jobset)), 61 | ], 62 | template_path=template_dir, 63 | static_path=asset_dir) 64 | 65 | 66 | 67 | def MainHandler(jobset: JobSet) -> tornado.web.RequestHandler: 68 | class h(tornado.web.RequestHandler): 69 | def get(self): 70 | for job in jobset.jobs: 71 | job.rotate() 72 | self.render("index.html", jobs=jobset) 73 | return h 74 | 75 | def LogSubmitHandler(jobset: JobSet) -> tornado.web.RequestHandler: 76 | class h(tornado.web.RequestHandler): 77 | def post(self, job_name: str): 78 | job = jobset[job_name] 79 | job.record_log_entry(datetime.now(), self.request.body.decode('utf-8')) 80 | return h 81 | 82 | def LogListHandler(jobset: JobSet) -> tornado.web.RequestHandler: 83 | class h(tornado.web.RequestHandler): 84 | @tornado.web.addslash 85 | def get(self, job_name: str): 86 | job = jobset[job_name] 87 | if not job.has_entries(): 88 | raise tornado.web.HTTPError(404) 89 | 90 | self.render("log-list.html", job=job) 91 | return h 92 | 93 | def LogRetrieveHandler(jobset: JobSet) -> tornado.web.RequestHandler: 94 | class h(tornado.web.RequestHandler): 95 | def get(self, job_name: str, ts: str): 96 | try: 97 | job = jobset[job_name] 98 | entry = job[ts] 99 | except KeyError: 100 | raise tornado.web.HTTPError(404) 101 | 102 | self.render("log.html", entry=entry) 103 | return h 104 | 105 | 106 | 107 | if __name__ == "__main__": 108 | main() 109 | -------------------------------------------------------------------------------- /cronitor-run: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # 3 | # Author:: Joshua J. Berry 4 | # Copyright:: Copyright 2013-2019, Joshua J. Berry 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or (at 9 | # your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, but 12 | # WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 | # General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | # 19 | 20 | # NOTE: This code tries to be compatible with both Python 2 and 3. 21 | 22 | import optparse 23 | import subprocess 24 | import pty 25 | import os 26 | import sys 27 | import socket 28 | import traceback 29 | 30 | from urllib.request import Request, HTTPSHandler, \ 31 | HTTPBasicAuthHandler, HTTPPasswordMgrWithDefaultRealm, \ 32 | build_opener 33 | from urllib.error import HTTPError, URLError 34 | import ssl 35 | 36 | usage = "Usage: cronitor-run [options] -j job-name -- command ..." 37 | descr = """Runs a command, capturing its output, environment and return code, 38 | and reports the outcome to a Cronitor server, specified using the -p option or 39 | the CRONITOR_URL environment variable. """ 40 | 41 | optp = optparse.OptionParser(usage=usage, description=descr) 42 | optp.add_option("-j", "--job", dest="job", metavar="NAME", default=None, 43 | help="The name of the job we are running [required]") 44 | optp.add_option("-p", "--post-to", dest="post_url", metavar="URL", 45 | default=os.environ.get('CRONITOR_URL', None), 46 | help="HTTP URL of the cronitor-server") 47 | optp.add_option('-q', '--quiet', dest='quiet', action='store_true', 48 | default=False, help="Don't echo the command's output to stdout") 49 | optp.add_option("-U", "--user", dest="user", metavar="USERNAME", 50 | default=os.environ.get('CRONITOR_USER', None), 51 | help="""The username to use for authentication 52 | (can also be set via the CRONITOR_USER environment variable)""") 53 | optp.add_option("-P", "--password", dest="password", metavar="PASSWORD", 54 | default=os.environ.get('CRONITOR_PASSWORD', None), 55 | help="""The password to use for authentication 56 | (can also be set via the CRONITOR_PASSWORD environment variable)""") 57 | opts, args = optp.parse_args() 58 | 59 | if not opts.post_url: 60 | sys.stderr.write("No post URL specified; set CRONITOR_URL or use -p\n") 61 | sys.exit(1) 62 | if not opts.job: 63 | sys.stderr.write("No job name specified; set with -j\n") 64 | sys.exit(1) 65 | 66 | submit_url = opts.post_url 67 | if not submit_url.endswith("/"): submit_url += "/" 68 | submit_url += "submit/" + opts.job 69 | 70 | auth = HTTPBasicAuthHandler(HTTPPasswordMgrWithDefaultRealm()) 71 | if opts.user and opts.password: 72 | auth.add_password(realm=None, uri=submit_url, 73 | user=opts.user, passwd=opts.password) 74 | opener = build_opener(HTTPSHandler(context=ssl.create_default_context()), auth) 75 | 76 | # Capture and report on the environment 77 | meta = { 78 | 'Directory': os.getcwd(), 79 | 'Command': " ".join(args), 80 | 'Host': socket.gethostname(), 81 | } 82 | for k, v in os.environ.items(): 83 | meta['ENV.%s' % k] = v.replace('\n', ' ').replace('\r', ' ') 84 | 85 | lines: list[str] = [] 86 | try: 87 | # Control the child process with a TTY so the child process will use line 88 | # buffering for its output (and stdout/stderr won't get interleaved in weird 89 | # ways) 90 | read_fd, write_fd = pty.openpty() 91 | read_file = os.fdopen(read_fd) 92 | 93 | proc = subprocess.Popen(args, stdin=None, stdout=write_fd, 94 | stderr=subprocess.STDOUT, close_fds=True, 95 | shell=False) 96 | 97 | os.fdopen(write_fd).close() 98 | try: 99 | for line in read_file: 100 | if not opts.quiet: print(line.rstrip('\n')) 101 | lines.append(line) 102 | except IOError: 103 | # We're on Linux, and the child just closed its terminal 104 | pass 105 | 106 | rc = proc.wait() 107 | 108 | except: 109 | rc = -1 110 | err = [ 111 | "\n\n\n***** CRONITOR FAILED:\n\n", 112 | traceback.format_exc(), 113 | "\n" 114 | ] 115 | lines += err 116 | sys.stderr.write(''.join(err)) 117 | 118 | meta['Return-Code'] = str(rc) 119 | 120 | data = "\n".join(["%s: %s" % (k, v) for k, v in meta.items()]) 121 | data += "\n\n" 122 | data += ''.join(lines) 123 | 124 | def oops(err: str): 125 | sys.stderr.write('\ncronitor-run: Failed to submit job log to server\n') 126 | sys.stderr.write(err) 127 | sys.stderr.write('\n') 128 | if opts.quiet: 129 | sys.stderr.write('\n----- Job output and metadata follows -----\n\n') 130 | sys.stderr.write(data) 131 | sys.stderr.write('\n') 132 | 133 | try: 134 | res = opener.open(Request(submit_url, data=data.encode('utf-8'))) 135 | if res.getcode() != 200: 136 | raise res.getcode() 137 | 138 | except HTTPError as e: 139 | rc = -1 140 | oops('%s: HTTP %d: %s\n' % (submit_url, e.code, e.reason)) 141 | except URLError as e: 142 | rc = -1 143 | oops('%s: %s' % (submit_url, e.reason)) 144 | except: 145 | rc = -1 146 | oops(traceback.format_exc()) 147 | 148 | sys.exit(rc) 149 | -------------------------------------------------------------------------------- /cronitor/config.py: -------------------------------------------------------------------------------- 1 | # 2 | # Author:: Joshua J. Berry 3 | # Copyright:: Copyright (c) 2013, Joshua J. Berry 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 3 of the License, or (at 8 | # your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, but 11 | # WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 | # General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with this program. If not, see . 17 | # 18 | 19 | from datetime import timedelta 20 | import fnmatch 21 | from typing import Generator, Optional, TypedDict, cast 22 | import yaml 23 | import os 24 | import re 25 | 26 | __all__ = ['CronitorConfig'] 27 | 28 | ServerYAML = TypedDict('ServerYAML', { 29 | 'job_dir': str, 30 | 'template_dir': str, 31 | 'asset_dir': str, 32 | 'rules_file': str, 33 | 'listen_on': list[str], 34 | }) 35 | 36 | RuleYAML = TypedDict('RuleYAML', { 37 | 'match': str, 38 | 'keep': Optional[str], 39 | 'due_every': Optional[str], 40 | 'ignores': Optional[list[str]], 41 | 'errors': Optional[list[str]], 42 | }) 43 | 44 | SERVER_DEFAULTS = cast(ServerYAML, { 45 | # These must be specified: 46 | #"job_dir": None, 47 | #"template_dir": None, 48 | #"rules_file": None, 49 | "listen_on": ['*:8434'], # 8 for port 80, 434 == sum(bytes of "cron") :) 50 | }) 51 | 52 | RULE_DEFAULTS = cast(RuleYAML, { 53 | #"matches": glob, 54 | "keep": "30d", 55 | "due_every": "1000y", 56 | # "errors": [regexp, regexp, ...] 57 | # "ignores": [regexp, regexp, ...] 58 | }) 59 | 60 | 61 | 62 | class CronitorConfig(object): 63 | def __init__(self, server_file: str) -> None: 64 | self.__server_path = server_file 65 | 66 | with open(server_file, 'r') as f: 67 | self.__server = cast(ServerYAML, yaml.safe_load(f)) 68 | 69 | def _server_get(self, key: str) -> str | list[str]: 70 | try: 71 | return self.__server[key] # type: ignore 72 | except KeyError: 73 | return SERVER_DEFAULTS[key] # type: ignore 74 | 75 | def _path(self, key: str) -> str: 76 | # This path is relative to the configuration file 77 | path = cast(str, self._server_get(key)) 78 | return os.path.abspath(os.path.join(os.path.dirname(self.__server_path), 79 | path)) 80 | 81 | def rules_for(self, job_name: str) -> 'RuleSet': 82 | with open(self._path('rules_file'), 'r') as f: 83 | return RuleSet(yaml.safe_load(f), job_name) 84 | 85 | @property 86 | def rules_file(self) -> str: 87 | return self._path('rules_file') 88 | 89 | @property 90 | def job_dir(self) -> str: 91 | return self._path('job_dir') 92 | 93 | @property 94 | def template_dir(self) -> str: 95 | return self._path('template_dir') 96 | 97 | @property 98 | def asset_dir(self) -> str: 99 | return self._path('asset_dir') 100 | 101 | @property 102 | def listen_on(self) -> Generator[tuple[str, int], None, None]: 103 | vals = self._server_get('listen_on') 104 | for v in vals: 105 | addr, port = v.split(":") 106 | if addr == "*": 107 | addr = '' 108 | yield addr, int(port) 109 | 110 | 111 | 112 | class RuleSet(object): 113 | def __init__(self, rules_data: list[RuleYAML], job_name: str) -> None: 114 | rules = [Rule(**r) for r in rules_data] 115 | self.__rules = [r for r in rules if r.matches(job_name)] 116 | 117 | @property 118 | def keep(self) -> timedelta: 119 | for r in self.__rules: 120 | if r.keep is not None: 121 | return r.keep 122 | return parse_duration(cast(str, RULE_DEFAULTS['keep'])) 123 | 124 | @property 125 | def due_every(self) -> timedelta: 126 | for r in self.__rules: 127 | if r.due_every is not None: 128 | return r.due_every 129 | return parse_duration(cast(str, RULE_DEFAULTS['due_every'])) 130 | 131 | def is_error_line(self, line: str) -> bool: 132 | # To get rid of newlines and trailing whitepsace that will confound 133 | # regexes using '$' 134 | line = line.rstrip() 135 | for r in self.__rules: 136 | for i in r.ignores: 137 | if i.search(line): 138 | return False 139 | 140 | for r in self.__rules: 141 | for e in r.errors: 142 | if e.search(line): 143 | return True 144 | 145 | return False 146 | 147 | 148 | 149 | class Rule(object): 150 | def __init__(self, match: str, 151 | keep: Optional[str] = None, due_every: Optional[str] = None, 152 | ignores: Optional[list[str]] = None, 153 | errors: Optional[list[str]] = None, 154 | ignores_i: Optional[list[str]] = None, 155 | errors_i: Optional[list[str]] = None) -> None: 156 | self.pattern = match 157 | self.keep = parse_duration(keep) if keep else None 158 | self.due_every = parse_duration(due_every) if due_every else None 159 | self.ignores = self._to_relist(ignores, ignores_i) 160 | self.errors = self._to_relist(errors, errors_i) 161 | 162 | def _to_relist(self, case: Optional[list[str]], nocase: Optional[list[str]]) -> list[re.Pattern[str]]: 163 | l: list[re.Pattern[str]] = [] 164 | if case: 165 | l += [re.compile(r) for r in case] 166 | if nocase: 167 | l += [re.compile(r, re.IGNORECASE) for r in nocase] 168 | return l 169 | 170 | def matches(self, job_name: str) -> bool: 171 | return fnmatch.fnmatch(job_name, self.pattern) 172 | 173 | 174 | # 175 | # Utility function for parsing durations 176 | # 177 | 178 | MIN = 60 179 | HOURS = 60*60 180 | DAYS = 24*HOURS 181 | WEEKS = 7*DAYS 182 | MONTHS = 30*DAYS 183 | YEARS = 365*DAYS 184 | DURATIONS = { 185 | '': 1, 's': 1, 'sec': 1, 186 | 'min': MIN, 187 | 'h': HOURS, 'hr': HOURS, 'hrs': HOURS, 188 | 'd': DAYS, 'day': DAYS, 'days': DAYS, 189 | 'w': WEEKS, 'wk': WEEKS, 'wks': WEEKS, 190 | 'm': MONTHS, 'mo': MONTHS, 'mos': MONTHS, 191 | 'y': YEARS, 'yr': YEARS, 'yrs': YEARS 192 | } 193 | 194 | def parse_duration(dur: str) -> timedelta: 195 | secs = 0 196 | 197 | for e in re.split(' +', dur): 198 | m = re.match('([0-9]+)([a-zA-Z]*)', e) 199 | if not m: raise ValueError(dur) 200 | secs += int(m.group(1)) * DURATIONS[m.group(2).lower()] 201 | 202 | return timedelta(seconds=secs) 203 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | ====================================== 2 | Cronitor: Simple Cron-Job Monitoring 3 | ====================================== 4 | :Author: Joshua J. Berry 5 | :Homepage: https://github.com/josh-berry/cronitor 6 | :License: GNU General Public License, version 3 7 | 8 | Introduction 9 | ============ 10 | 11 | Cronitor is a simple HTTP-based service for monitoring and capturing logs from 12 | Cron jobs or other tasks across multiple machines. It provides a few important 13 | benefits over regular cron emails: 14 | 15 | 1. Collect output from all jobs across all machines in one place. 16 | 2. Report job status in a convenient web dashboard, so you can see 17 | immediately if any jobs failed. 18 | 3. Highlight overdue jobs that didn't run when scheduled. 19 | 4. Scan job output looking for (configurable) error messages. 20 | 21 | .. image:: doc/dashboard.png 22 | 23 | Cronitor is a client/server system. The server is a lightweight HTTP server, 24 | which collects logs from jobs as they run on local or remote systems, scans them 25 | for errors and provides a dashboard showing all jobs that were reported. 26 | 27 | The client is a simple Python script that runs a job, captures its output and 28 | sends it to the server. The client script is standalone, requiring only 29 | standard Python 2 or Python 3 libraries to run. Installing it is as simple as 30 | ``scp``. 31 | 32 | Dependencies 33 | ============ 34 | 35 | The client requires only a recent version of Python 2. 36 | 37 | The server requires the following extra dependencies: 38 | 39 | * `PyYAML` >= 3.10 (``pip install PyYAML``) 40 | 41 | * Known to work with 3.10 42 | 43 | * `Tornado` >= 2.1 (``pip install tornado``) 44 | 45 | * Known to work with 2.1 and 3.0.1 46 | 47 | .. PyYAML: https://pypi.python.org/pypi/PyYAML 48 | .. Tornado: https://pypi.python.org/pypi/tornado 49 | 50 | Older versions of these packages may work but have been untested. Newer 51 | versions will most likely work (known-good versions are noted above). 52 | 53 | Setting up the Server 54 | ===================== 55 | 56 | The following instructions are for Linux. You may need to adapt them to your 57 | specific platform. 58 | 59 | 1. Install dependencies: 60 | :: 61 | $ pip install -r requirements.txt 62 | 63 | 2. Grab the Cronitor repository, and put it somewhere useful: 64 | :: 65 | $ git clone git://github.com/josh-berry/cronitor.git /opt/cronitor 66 | $ cd /opt/cronitor 67 | 68 | 3. Create a user/group for the `cronitor-server` process: 69 | :: 70 | $ sudo groupadd -r cronitor 71 | $ sudo useradd -r -s /usr/sbin/nologin -g cronitor \ 72 | -d /opt/cronitor cronitor 73 | 74 | 4. Choose where to store your Cronitor log files: 75 | :: 76 | $ emacs /opt/cronitor/server.yaml 77 | $ mkdir /your/log/dir 78 | $ chmod u=rwx,go= /your/log/dir 79 | $ sudo chown cronitor:cronitor /your/log/dir 80 | 81 | 5. Set up some rules for the jobs you're running: 82 | :: 83 | $ emacs /opt/cronitor/rules.yaml 84 | 85 | 6. Configure Cronitor to start when your system does: 86 | :: 87 | $ sudo cp /opt/cronitor/init/ /etc/init.d/cronitor 88 | # This varies by distro; right now only upstart is available. 89 | # Patches to add more init scripts are welcome. :) 90 | 91 | 7. Start Cronitor: 92 | :: 93 | $ sudo start cronitor 94 | 95 | If you would prefer to store your config, logs, and executable code separately, 96 | a few extra steps are required. 97 | 98 | 1. Copy your ``server.yaml`` and ``rules.yaml`` files elsewhere: 99 | :: 100 | $ mkdir /etc/cronitor 101 | $ cp *.yaml /etc/cronitor 102 | 103 | 2. Change your ``server.yaml`` file to use absolute paths: 104 | :: 105 | job_dir: /var/log/cronitor 106 | template_dir: /opt/cronitor/templates 107 | asset_dir: /opt/cronitor/assets 108 | 109 | # Or, if you're lazy, leave these as-is and make symlinks ;) 110 | 111 | 3. When you start ``cronitor-server``, pass the location of your 112 | ``server.yaml`` file with ``-c``: 113 | :: 114 | $ cronitor-server -c /etc/cronitor/server.yaml 115 | 116 | Setting up a Client 117 | =================== 118 | 119 | Setting up a client can be as simple as:: 120 | 121 | scp cronitor-run user@host:/path/to/a/bin_dir 122 | 123 | Then setup your crontab to look like this:: 124 | 125 | CRONITOR_URL=http://your.cronitor.server:8434/ 126 | 127 | 0 1 2 3 4 5 cronitor-run -q -j my-job-name -- do_something --verbose 128 | 129 | See ``cronitor-run --help`` for more details about how to invoke it. 130 | 131 | Cronitor and Security 132 | ===================== 133 | 134 | Since Cronitor uses the lightweight Tornado web server, there is no support for 135 | SSL or authentication of any kind. You may wish to run your Cronitor server 136 | behind a more full-featured proxy server such as Apache or nginx. 137 | 138 | Here is an example Apache configuration snippet which exposes the local 139 | cronitor-server under the /cronitor/ path, and enables HTTP Basic Authentication 140 | (you must have the *auth_basic*, *authn_file*, *authz_user*, *proxy*, and 141 | *proxy_http* modules loaded): 142 | 143 | :: 144 | 145 | AuthType Basic 146 | AuthName "Cronitor" 147 | AuthUserFile /home/www-data/passwd 148 | Require valid-user 149 | 150 | ProxyPass "/cronitor/" "http://127.0.0.1:8434/" 151 | ProxyPassReverse "/cronitor/" "http://127.0.0.1:8434/" 152 | 153 | If you run Cronitor behind a proxy server to provide encryption and/or 154 | authentication, ``cronitor-run`` will check the server's SSL certificate (if 155 | using HTTPS) against the certificate authorities recognized by the local system. 156 | It can also perform HTTP Basic authentication to provide a username/password to 157 | the proxy server (pass the ``-U`` and ``-P`` options, or set the 158 | ``CRONITOR_USER`` and ``CRONITOR_PASSWORD`` environment variables), so the 159 | server can authenticate the client. 160 | 161 | This is sufficient to cover most common security needs. However, note that 162 | ``cronitor-run`` does not presently support HSTS, certificate pinning, or 163 | self-signed certificates. You should use Let's Encrypt or a similar signing 164 | service to get a properly-signed SSL certificate. 165 | 166 | Additionally, since ``cronitor-run`` operates in a non-interactive context, you 167 | will likely need to store any username/password combination in plain text. Do 168 | not reuse the username/password for anything other than Cronitor, and consider 169 | giving each client system/application its own credentials, to limit your 170 | exposure should one of your systems/applications become compromised. 171 | 172 | Legalese 173 | ======== 174 | 175 | Cronitor: Simple Cron-Job Monitoring 176 | Copyright 2013-2019 Joshua J. Berry, and others listed in the AUTHORS file 177 | 178 | This program is free software: you can redistribute it and/or modify it under 179 | the terms of the GNU General Public License as published by the Free Software 180 | Foundation, either version 3 of the License, or (at your option) any later 181 | version. 182 | 183 | This program is distributed in the hope that it will be useful, but WITHOUT ANY 184 | WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A 185 | PARTICULAR PURPOSE. See the GNU General Public License for more details. 186 | 187 | A copy of the GNU General Public License is available in the COPYING file 188 | distributed with this software. You can also obtain a copy at 189 | http://www.gnu.org/licenses/ . 190 | -------------------------------------------------------------------------------- /cronitor/model.py: -------------------------------------------------------------------------------- 1 | # 2 | # Author:: Joshua J. Berry 3 | # Copyright:: Copyright (c) 2013, Joshua J. Berry 4 | # 5 | # This program is free software: you can redistribute it and/or modify 6 | # it under the terms of the GNU General Public License as published by 7 | # the Free Software Foundation, either version 2 of the License, or (at 8 | # your option) any later version. 9 | # 10 | # This program is distributed in the hope that it will be useful, but 11 | # WITHOUT ANY WARRANTY; without even the implied warranty of 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 13 | # General Public License for more details. 14 | # 15 | # You should have received a copy of the GNU General Public License 16 | # along with this program. If not, see . 17 | # 18 | 19 | from datetime import datetime, timedelta 20 | import os 21 | import re 22 | from typing import Generator, Optional, cast 23 | 24 | import cronitor.config as config 25 | 26 | TS_FORMAT = '%Y-%m-%dT%H:%M:%S.%f' 27 | 28 | 29 | 30 | class JobSet(object): 31 | def __init__(self, config: config.CronitorConfig) -> None: 32 | self.__config = config 33 | 34 | def _config(self) -> config.CronitorConfig: 35 | return self.__config 36 | 37 | def _job_dir(self, name: str) -> str: 38 | return os.path.join(self.__config.job_dir, name) 39 | 40 | def __getitem__(self, name: str) -> 'Job': 41 | return Job(self, name) 42 | 43 | @property 44 | def jobs(self) -> Generator['Job', None, None]: 45 | names = safe_listdir(self.__config.job_dir) 46 | names.sort() 47 | for name in names: 48 | if os.path.isdir(self._job_dir(name)): 49 | j = Job(self, name) 50 | try: 51 | j.latest_entry 52 | yield j 53 | except IndexError: 54 | os.rmdir(self._job_dir(name)) 55 | 56 | 57 | 58 | class Job(object): 59 | def __init__(self, jobset: JobSet, name: str) -> None: 60 | # because files with extensions (including ".") are private 61 | assert re.match('[0-9A-Za-z_-]*', name) 62 | 63 | self.__name = name 64 | self.__log_path = jobset._job_dir(name) 65 | self.__rules = jobset._config().rules_for(name) 66 | 67 | @property 68 | def name(self) -> str: 69 | return self.__name 70 | 71 | @property 72 | def path(self) -> str: 73 | return self.__log_path 74 | 75 | @property 76 | def rules(self) -> config.RuleSet: 77 | return self.__rules 78 | 79 | def record_log_entry(self, ts: datetime, logdata: str) -> 'LogEntry': 80 | if not os.path.isdir(self.__log_path): 81 | os.makedirs(self.__log_path) 82 | 83 | log_path = os.path.join(self.__log_path, ts.strftime(TS_FORMAT)) 84 | with open(log_path, 'w') as f: 85 | f.write(logdata) 86 | 87 | self.rotate() 88 | 89 | return LogEntry(self, ts.strftime(TS_FORMAT)) 90 | 91 | def rotate(self) -> None: 92 | oldest_age = datetime.now() - self.__rules.keep 93 | 94 | entries = safe_listdir(self.__log_path) 95 | for e in entries: 96 | try: 97 | ts = datetime.strptime(e, TS_FORMAT) 98 | except ValueError: 99 | # Ignore things we don't recognize. 100 | continue 101 | 102 | if ts < oldest_age: 103 | os.unlink(os.path.join(self.__log_path, e)) 104 | 105 | def __getitem__(self, entry: datetime | str) -> 'LogEntry': 106 | if isinstance(entry, datetime): 107 | entry = datetime.strftime(entry, TS_FORMAT) 108 | 109 | if not os.path.isfile(os.path.join(self.__log_path, entry)): 110 | raise KeyError(entry) 111 | 112 | return LogEntry(self, entry) 113 | 114 | @property 115 | def log_entries(self): 116 | entries = safe_listdir(self.__log_path) 117 | entries.sort() 118 | entries.reverse() 119 | for e in entries: 120 | try: 121 | yield LogEntry(self, e) 122 | except ValueError: 123 | # Skip things we don't recognize. 124 | pass 125 | 126 | def has_entries(self) -> bool: 127 | ents = self.log_entries 128 | try: 129 | next(ents) 130 | return True 131 | except StopIteration: 132 | return False 133 | 134 | @property 135 | def latest_entry(self): 136 | entries = safe_listdir(self.__log_path) 137 | entries.sort() 138 | return LogEntry(self, entries[-1]) 139 | 140 | @property 141 | def is_overdue(self): 142 | late_before = datetime.now() - self.__rules.due_every 143 | late_by = self.latest_entry.timestamp - late_before 144 | if late_by < timedelta(0): 145 | return abs(late_by) 146 | return False 147 | 148 | @property 149 | def status(self): 150 | if self.is_overdue: 151 | return 'overdue' 152 | else: 153 | return self.latest_entry.status 154 | 155 | 156 | 157 | class LogEntry(object): 158 | def __init__(self, job: Job, timestamp: str) -> None: 159 | self.job = job 160 | self.path = os.path.join(self.job.path, timestamp) 161 | self.timestamp = datetime.strptime(timestamp, TS_FORMAT) 162 | 163 | self.__header: Optional[dict[str, str]] = None 164 | self.__lines: Optional[list[str]] = None 165 | 166 | def _read(self) -> None: 167 | if self.__header: return 168 | 169 | header: dict[str, str] = {} 170 | with open(self.path, 'r') as f: 171 | # Read the header, up to the first blank line 172 | line = f.readline().strip() 173 | while line: 174 | m = re.match('([a-zA-Z0-9_.-]*):\\s*(.*)', line) 175 | if not m: 176 | # This shouldn't happen unless the log file is 177 | # poorly-formatted for some reason. If this happens, just 178 | # assume the rest of the file is the log itself -- this is 179 | # probably the least-bad failure case since it gives the 180 | # user the contents of the file and lets them see what might 181 | # have happened. 182 | break 183 | 184 | header[m.group(1)] = m.group(2) 185 | line = f.readline().strip() 186 | 187 | # Everything after the blank line is the log text 188 | lines = f.readlines() 189 | 190 | self.__header = header 191 | self.__lines = lines 192 | 193 | @property 194 | def status(self) -> str: 195 | if self.rc != 0: 196 | return 'failed' 197 | 198 | # Make sure nothing weird or nasty appears in the log 199 | for _line, is_err in self.scan_text(): 200 | if is_err: 201 | return 'error' 202 | 203 | return 'ok' 204 | 205 | @property 206 | def metadata(self) -> dict[str, str]: 207 | self._read() 208 | return cast(dict[str, str], self.__header) 209 | 210 | @property 211 | def command(self) -> str: 212 | return self.metadata.get('Command', '') 213 | 214 | @property 215 | def rc(self) -> int: 216 | return int(self.metadata.get('Return-Code', -1)) 217 | 218 | @property 219 | def pwd(self) -> str: 220 | return self.metadata.get('Directory', '') 221 | 222 | @property 223 | def env(self) -> dict[str, str]: 224 | env: dict[str, str] = {} 225 | for k, v in self.metadata.items(): 226 | if k.startswith("ENV."): 227 | env[k[4:]] = v 228 | return env 229 | 230 | @property 231 | def text(self) -> str: 232 | self._read() 233 | return ''.join(cast(list[str], self.__lines)) 234 | 235 | def scan_text(self) -> Generator[tuple[str, bool], None, None]: 236 | self._read() 237 | rules = self.job.rules 238 | for line in cast(list[str], self.__lines): 239 | is_err = rules.is_error_line(line) 240 | yield line, is_err 241 | 242 | 243 | 244 | def safe_listdir(path: str) -> list[str]: 245 | if os.path.isdir(path): 246 | return os.listdir(path) 247 | else: 248 | return [] 249 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------