├── doc ├── TODO ├── admin_watchdog_home.png ├── admin_watchdog_list.png └── admin_watchdog_view.png ├── admin_watchdog ├── __init__.py ├── tests │ ├── __init__.py │ ├── urls.py │ ├── mocks.py │ ├── settings.py │ └── tests.py ├── migrations │ ├── __init__.py │ ├── 0002_auto_20141029_1058.py │ └── 0001_initial.py ├── locale │ └── fr │ │ └── LC_MESSAGES │ │ ├── django.mo │ │ └── django.po ├── static │ └── admin_watchdog │ │ └── admin.css ├── models.py ├── admin.py └── handlers.py ├── .gitignore ├── .coveragerc ├── MANIFEST.in ├── CHANGES ├── runtests.py ├── tox.ini ├── setup.py ├── README.rst ├── .github └── workflows │ └── python-app.yml └── LICENSE /doc/TODO: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /admin_watchdog/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /admin_watchdog/tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /admin_watchdog/migrations/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /doc/admin_watchdog_home.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/makinacorpus/django-admin-watchdog/HEAD/doc/admin_watchdog_home.png -------------------------------------------------------------------------------- /doc/admin_watchdog_list.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/makinacorpus/django-admin-watchdog/HEAD/doc/admin_watchdog_list.png -------------------------------------------------------------------------------- /doc/admin_watchdog_view.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/makinacorpus/django-admin-watchdog/HEAD/doc/admin_watchdog_view.png -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | \#* 3 | *pyc 4 | .#* 5 | 6 | /dist 7 | /django_admin_watchdog.egg-info 8 | /.coverage 9 | /htmlcov 10 | -------------------------------------------------------------------------------- /admin_watchdog/locale/fr/LC_MESSAGES/django.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/makinacorpus/django-admin-watchdog/HEAD/admin_watchdog/locale/fr/LC_MESSAGES/django.mo -------------------------------------------------------------------------------- /.coveragerc: -------------------------------------------------------------------------------- 1 | [report] 2 | omit = 3 | admin_watchdog/tests/* 4 | admin_watchdog/migrations/* 5 | /home/*/.virtualenvs/* 6 | /home/travis/virtualenv/* -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include LICENSE 2 | include README.rst 3 | recursive-include admin_watchdog/static * 4 | recursive-include admin_watchdog/locale * 5 | recursive-include doc * 6 | -------------------------------------------------------------------------------- /CHANGES: -------------------------------------------------------------------------------- 1 | ========= 2 | CHANGELOG 3 | ========= 4 | 5 | 1.0.5 (unreleased) 6 | ================== 7 | 8 | - 9 | 10 | 1.0.4 (2022-03-25) 11 | ================== 12 | 13 | - Django 4.0 compatibility 14 | -------------------------------------------------------------------------------- /admin_watchdog/static/admin_watchdog/admin.css: -------------------------------------------------------------------------------- 1 | .field-show_message pre, .field-show_request_repr pre { 2 | color: #333; 3 | font-family: "Lucida Grande", Verdana, Arial, sans-serif; 4 | margin-left: 7em; 5 | padding-left: 30px; 6 | } -------------------------------------------------------------------------------- /admin_watchdog/tests/urls.py: -------------------------------------------------------------------------------- 1 | from django.contrib import admin 2 | from django.urls import path 3 | 4 | 5 | def test_view(request): 6 | raise AttributeError() 7 | 8 | 9 | urlpatterns = [ 10 | path('admin/', admin.site.urls), 11 | path('', test_view), 12 | ] 13 | -------------------------------------------------------------------------------- /admin_watchdog/migrations/0002_auto_20141029_1058.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | from __future__ import unicode_literals 3 | 4 | from django.db import migrations 5 | 6 | 7 | class Migration(migrations.Migration): 8 | 9 | dependencies = [ 10 | ('admin_watchdog', '0001_initial'), 11 | ] 12 | 13 | operations = [ 14 | migrations.AlterModelOptions( 15 | name='logentry', 16 | options={'verbose_name': 'Log entry', 'verbose_name_plural': 'Log entries'}, 17 | ), 18 | ] 19 | -------------------------------------------------------------------------------- /runtests.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | import os 3 | import sys 4 | 5 | import django 6 | from django.conf import settings 7 | from django.test.utils import get_runner 8 | 9 | if __name__ == '__main__': 10 | os.environ['DJANGO_SETTINGS_MODULE'] = 'admin_watchdog.tests.settings' 11 | django.setup() 12 | TestRunner = get_runner(settings) 13 | test_runner = TestRunner() 14 | tests = ['admin_watchdog.tests'] if len(sys.argv) == 1 else sys.argv[1:] 15 | failures = test_runner.run_tests(tests) 16 | sys.exit(bool(failures)) 17 | -------------------------------------------------------------------------------- /admin_watchdog/tests/mocks.py: -------------------------------------------------------------------------------- 1 | from django.http.request import QueryDict 2 | 3 | 4 | class RequestMock(object): 5 | path = "/" 6 | GET = QueryDict('') 7 | POST = QueryDict('') 8 | COOKIES = {} 9 | _post_parse_error = False 10 | 11 | 12 | class RecordMock(object): 13 | def __init__(self, request): 14 | if request is not None: 15 | self.request = request 16 | self.levelname = "ERROR" 17 | self.exc_info = (None, AttributeError(), None) 18 | self.exc_text = None 19 | self.stack_info = False 20 | 21 | def getMessage(self): 22 | return "Short Message Mock" 23 | -------------------------------------------------------------------------------- /admin_watchdog/models.py: -------------------------------------------------------------------------------- 1 | from django.db import models 2 | from django.utils.translation import gettext_lazy as _ 3 | 4 | 5 | class LogEntry(models.Model): 6 | class Meta: 7 | verbose_name = _("Log entry") 8 | verbose_name_plural = _("Log entries") 9 | app_label = "admin_watchdog" 10 | 11 | when = models.DateTimeField( 12 | _("When"), 13 | auto_now_add=True, 14 | editable=False, 15 | ) 16 | levelname = models.CharField( 17 | _("Level name"), 18 | max_length=20, 19 | editable=False, 20 | ) 21 | shortmessage = models.CharField( 22 | _("Short message"), 23 | max_length=256, 24 | editable=False, 25 | ) 26 | message = models.TextField( 27 | _("Message"), 28 | editable=False, 29 | ) 30 | request_repr = models.TextField( 31 | _("Request representation"), 32 | editable=False, 33 | ) 34 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | skipsdist = True 3 | envlist = 4 | {py35}-django-22 5 | {py36}-django-{22,30,31,32} 6 | {py37}-django-{22,30,31,32} 7 | {py38}-django-{22,30,31,32,40} 8 | {py39}-django-{22,30,31,32,40} 9 | {py310}-django-{32,40} 10 | py310-flake8 11 | 12 | [testenv] 13 | setenv = 14 | PYTHONPATH = {toxinidir}:{toxinidir} 15 | deps = 16 | coverage>=3,<4 17 | flake8: flake8>=2.0,<3.0 18 | django: coveralls 19 | django-22: Django>=2.2,<2.3 20 | django-30: Django>=3.0,<3.1 21 | django-31: Django>=3.1,<3.2 22 | django-32: Django>=3.2,<4.0 23 | django-40: Django>=4.0,<4.1 24 | commands = 25 | flake8: flake8 admin_watchdog --ignore=E501 26 | django: coverage run --parallel-mode {toxinidir}/runtests.py {posargs} 27 | django: - coveralls 28 | 29 | [testenv:docs] 30 | basepython = python 31 | changedir = doc 32 | deps = 33 | sphinx 34 | sphinx_rtd_theme 35 | Django>=3.2,<4.0 36 | commands = 37 | sphinx-build -W -b html -d build/doctrees . build/html 38 | -------------------------------------------------------------------------------- /admin_watchdog/migrations/0001_initial.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | from __future__ import unicode_literals 3 | 4 | from django.db import models, migrations 5 | 6 | 7 | class Migration(migrations.Migration): 8 | 9 | dependencies = [ 10 | ] 11 | 12 | operations = [ 13 | migrations.CreateModel( 14 | name='LogEntry', 15 | fields=[ 16 | ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)), 17 | ('when', models.DateTimeField(auto_now_add=True, verbose_name=b'When')), 18 | ('levelname', models.CharField(verbose_name=b'Level name', max_length=20, editable=False)), 19 | ('shortmessage', models.CharField(verbose_name=b'Short message', max_length=256, editable=False)), 20 | ('message', models.TextField(verbose_name=b'Message', editable=False)), 21 | ('request_repr', models.TextField(verbose_name=b'Request representation', editable=False)), 22 | ], 23 | options={ 24 | }, 25 | bases=(models.Model,), 26 | ), 27 | ] 28 | -------------------------------------------------------------------------------- /admin_watchdog/admin.py: -------------------------------------------------------------------------------- 1 | from django.contrib import admin 2 | from django.utils.html import format_html 3 | from django.utils.translation import gettext_lazy as _ 4 | 5 | from admin_watchdog.models import LogEntry 6 | 7 | 8 | class LogEntryAdmin(admin.ModelAdmin): 9 | class Media: 10 | css = { 11 | 'all': ['admin_watchdog/admin.css'] 12 | } 13 | 14 | date_hierarchy = 'when' 15 | list_display = ('when', 'levelname', 'shortmessage') 16 | list_filter = ('levelname',) 17 | readonly_fields = ( 18 | 'when', 'levelname', 'shortmessage', 19 | 'show_message', 'show_request_repr' 20 | ) 21 | search_fields = ( 22 | 'shortmessage', 'message', 'request_repr', 23 | ) 24 | 25 | def show_message(self, instance): 26 | return format_html('
{0}
', instance.message) 27 | show_message.short_description = _('Message') 28 | show_message.allow_tags = True 29 | 30 | def show_request_repr(self, instance): 31 | return format_html('
{0}
', instance.request_repr) 32 | show_request_repr.short_description = _('Request representation') 33 | show_request_repr.allow_tags = True 34 | 35 | 36 | admin.site.register(LogEntry, LogEntryAdmin) 37 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import os 2 | from setuptools import setup, find_packages 3 | 4 | with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as readme: 5 | README = readme.read() 6 | 7 | # allow setup.py to be run from any path 8 | os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir))) 9 | 10 | setup( 11 | name='django-admin-watchdog', 12 | version='1.0.5dev', 13 | packages=find_packages(), 14 | include_package_data=True, 15 | license='GPLv3+', 16 | description='A simple Django app to register logs in admin backoffice.', 17 | long_description=README, 18 | url='https://github.com/makinacorpus/django-admin-watchdog', 19 | author='Yann Fouillat', 20 | author_email='yann.fouillat@makina-corpus.com', 21 | classifiers=[ 22 | 'Environment :: Web Environment', 23 | 'Framework :: Django', 24 | 'Intended Audience :: Developers', 25 | 'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)', 26 | 'Operating System :: OS Independent', 27 | 'Programming Language :: Python', 28 | 'Programming Language :: Python :: 2.7', 29 | 'Topic :: Internet :: WWW/HTTP', 30 | 'Topic :: Internet :: WWW/HTTP :: Dynamic Content', 31 | ], 32 | ) 33 | -------------------------------------------------------------------------------- /admin_watchdog/locale/fr/LC_MESSAGES/django.po: -------------------------------------------------------------------------------- 1 | # SOME DESCRIPTIVE TITLE. 2 | # Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER 3 | # This file is distributed under the same license as the PACKAGE package. 4 | # FIRST AUTHOR , YEAR. 5 | # 6 | msgid "" 7 | msgstr "" 8 | "Project-Id-Version: django-admin-watchdog\n" 9 | "Report-Msgid-Bugs-To: \n" 10 | "POT-Creation-Date: 2014-10-29 09:55+0100\n" 11 | "PO-Revision-Date: 2014-10-29 09:56+0100\n" 12 | "Last-Translator: Gagaro \n" 13 | "Language-Team: django-admin-watchdog \n" 14 | "Language: fr\n" 15 | "MIME-Version: 1.0\n" 16 | "Content-Type: text/plain; charset=UTF-8\n" 17 | "Content-Transfer-Encoding: 8bit\n" 18 | "Plural-Forms: nplurals=2; plural=(n > 1);\n" 19 | "X-Generator: Poedit 1.5.4\n" 20 | 21 | #: admin.py:24 models.py:26 22 | msgid "Message" 23 | msgstr "Message" 24 | 25 | #: admin.py:29 models.py:30 26 | msgid "Request representation" 27 | msgstr "Représentation de la requête" 28 | 29 | #: models.py:7 30 | msgid "Log entry" 31 | msgstr "Entrée de journal" 32 | 33 | #: models.py:8 34 | #| msgid "LogEntries" 35 | msgid "Log entries" 36 | msgstr "Entrées de journal" 37 | 38 | #: models.py:11 39 | msgid "When" 40 | msgstr "Quand" 41 | 42 | #: models.py:16 43 | msgid "Level name" 44 | msgstr "Niveau" 45 | 46 | #: models.py:21 47 | msgid "Short message" 48 | msgstr "Message court" 49 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | ============== 2 | Admin watchdog 3 | ============== 4 | 5 | .. image:: https://travis-ci.org/makinacorpus/django-admin-watchdog.png 6 | :target: https://travis-ci.org/makinacorpus/django-admin-watchdog 7 | 8 | .. image:: https://coveralls.io/repos/makinacorpus/django-admin-watchdog/badge.png?branch=master 9 | :target: https://coveralls.io/r/makinacorpus/django-admin-watchdog?branch=master 10 | 11 | Admin watchdog is a simple Django app to register and view logs in the django admin backoffice. 12 | 13 | Tested with Django 2.2 through 4.0. 14 | 15 | Quick start 16 | ----------- 17 | 18 | 1. Add "admin_watchdog" to your INSTALLED_APPS settings. 19 | 20 | 2. Run `python manage.py migrate` to create the admin watchdog model. 21 | 22 | 3. Edit your LOGGING settings to use the admin watchdog handler. 23 | For example, to replace the default mail handler:: 24 | 25 | LOGGING = { 26 | 'version': 1, 27 | 'disable_existing_loggers': False, 28 | 'handlers': { 29 | 'admin_watchdog': { 30 | 'level': 'ERROR', 31 | 'class': 'admin_watchdog.handlers.AdminWatchdogHandler', 32 | } 33 | }, 34 | 'loggers': { 35 | 'django.request': { 36 | 'handlers': ['admin_watchdog'], 37 | 'level': 'ERROR', 38 | 'propagate': False, 39 | } 40 | } 41 | } 42 | 43 | 4. Your error logs will now be registered. Visit your admin backoffice to see the log entries. 44 | 45 | 5. You can run the tests by doing `make test`. 46 | 47 | Screenshots 48 | =========== 49 | 50 | .. image:: doc/admin_watchdog_home.png 51 | 52 | .. image:: doc/admin_watchdog_list.png 53 | 54 | .. image:: doc/admin_watchdog_view.png 55 | 56 | AUTHORS 57 | ======= 58 | 59 | * Yann FOUILLAT (alias Gagaro) 60 | 61 | |makinacom|_ 62 | 63 | .. |makinacom| image:: http://depot.makina-corpus.org/public/logo.gif 64 | .. _makinacom: http://www.makina-corpus.com 65 | 66 | 67 | ======= 68 | LICENSE 69 | ======= 70 | 71 | * GPLv3+ 72 | -------------------------------------------------------------------------------- /.github/workflows/python-app.yml: -------------------------------------------------------------------------------- 1 | # This workflow will install Python dependencies, run tests and lint with a single version of Python 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions 3 | 4 | name: Python application 5 | 6 | on: [push, pull_request] 7 | 8 | jobs: 9 | tests_python: 10 | name: Test on Python ${{ matrix.python_version }} and Django ${{ matrix.django_version }} 11 | runs-on: ubuntu-latest 12 | strategy: 13 | matrix: 14 | django_version: [ '2.2', '3.0', '3.1', '3.2', '4.0' ] 15 | python_version: [ '3.5', '3.6', '3.7', '3.8', '3.9', '3.10' ] 16 | exclude: 17 | 18 | - django_version: '2.2' 19 | python_version: '3.10' 20 | 21 | - django_version: '3.0' 22 | python_version: '3.5' 23 | 24 | - django_version: '3.0' 25 | python_version: '3.10' 26 | 27 | - django_version: '3.1' 28 | python_version: '3.5' 29 | 30 | - django_version: '3.1' 31 | python_version: '3.10' 32 | 33 | - django_version: '3.2' 34 | python_version: '3.5' 35 | 36 | - django_version: '4.0' 37 | python_version: '3.5' 38 | 39 | - django_version: '4.0' 40 | python_version: '3.6' 41 | 42 | - django_version: '4.0' 43 | python_version: '3.7' 44 | env: 45 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 46 | 47 | steps: 48 | - uses: actions/checkout@v2 49 | - name: Set up Python ${{ matrix.python_version }} 50 | uses: actions/setup-python@v2 51 | with: 52 | python-version: ${{ matrix.python_version }} 53 | - name: Cache pip 54 | uses: actions/cache@v2 55 | with: 56 | # This path is specific to Ubuntu 57 | path: ~/.cache/pip 58 | key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ matrix.django_version }} 59 | - name: Install dependencies 60 | run: | 61 | python -m pip install --upgrade pip 62 | pip install -e . 63 | pip install -U flake8 coveralls argparse 64 | pip install -U Django~=${{ matrix.django_version }} 65 | - name: Lint with flake8 66 | run: | 67 | flake8 --ignore=E501,W504 admin_watchdog 68 | - name: Test Django 69 | run: | 70 | python -W error::DeprecationWarning -W error::PendingDeprecationWarning \ 71 | -m coverage run `which django-admin` test --settings=admin_watchdog.tests.settings 72 | - name: Coverage 73 | if: ${{ success() }} 74 | run: | 75 | coveralls --service=github 76 | -------------------------------------------------------------------------------- /admin_watchdog/handlers.py: -------------------------------------------------------------------------------- 1 | import logging 2 | from pprint import pformat 3 | 4 | from django.utils.encoding import force_str 5 | 6 | 7 | def build_request_repr(request): 8 | """ 9 | FROM Django 1.8 10 | 11 | Builds and returns the request's representation string. The request's 12 | attributes may be overridden by pre-processed values. 13 | """ 14 | # Since this is called as part of error handling, we need to be very 15 | # robust against potentially malformed input. 16 | try: 17 | get = pformat(request.GET) 18 | except Exception: 19 | get = '' 20 | try: 21 | post = pformat(request.POST) 22 | except Exception: 23 | post = '' 24 | try: 25 | cookies = pformat(request.COOKIES) 26 | except Exception: 27 | cookies = '' 28 | try: 29 | meta = pformat(request.META) 30 | except Exception: 31 | meta = '' 32 | return force_str('<%s\npath:%s,\nGET:%s,\nPOST:%s,\nCOOKIES:%s,\nMETA:%s>' % 33 | (request.__class__.__name__, 34 | request.path, 35 | str(get), 36 | str(post), 37 | str(cookies), 38 | str(meta))) 39 | 40 | 41 | class AdminWatchdogHandler(logging.Handler): 42 | """An exception log handler that register exception for the site backend. 43 | """ 44 | 45 | def __init__(self): 46 | logging.Handler.__init__(self) 47 | 48 | def emit(self, record): 49 | from admin_watchdog.models import LogEntry 50 | 51 | # Get request specific info (location, ...) 52 | try: 53 | request = record.request 54 | request_repr = build_request_repr(request) 55 | except AttributeError: 56 | request = None 57 | request_repr = u"unavailable" 58 | 59 | LogEntry( 60 | levelname=record.levelname, 61 | shortmessage=record.getMessage(), 62 | message=self.format(record), 63 | request_repr=request_repr, 64 | ).save() 65 | 66 | # May be used for more advanced logging 67 | """ 68 | # Get ExceptionReporter parameters 69 | if record.exc_info: 70 | exc_info = record.exc_info 71 | else: 72 | exc_info = (None, record.getMessage(), None) 73 | 74 | 75 | message = "%s\n\nRequest repr(): %s" % ( 76 | self.format(record), request_repr 77 | ) 78 | reporter = ExceptionReporter(request, is_email=True, *exc_info) 79 | html_message = reporter.get_traceback_html() 80 | text_message = reporter.get_traceback_text() 81 | """ 82 | -------------------------------------------------------------------------------- /admin_watchdog/tests/settings.py: -------------------------------------------------------------------------------- 1 | """ 2 | Django settings for django_test project. 3 | 4 | For more information on this file, see 5 | https://docs.djangoproject.com/en/1.7/topics/settings/ 6 | 7 | For the full list of settings and their values, see 8 | https://docs.djangoproject.com/en/1.7/ref/settings/ 9 | """ 10 | 11 | # Build paths inside the project like this: os.path.join(BASE_DIR, ...) 12 | import os 13 | BASE_DIR = os.path.dirname(os.path.dirname(__file__)) 14 | 15 | 16 | # Quick-start development settings - unsuitable for production 17 | # See https://docs.djangoproject.com/en/1.7/howto/deployment/checklist/ 18 | 19 | # SECURITY WARNING: keep the secret key used in production secret! 20 | SECRET_KEY = '%h13inv2($))j26yv825+*0kpmes3sf4ohy*@#83a07^rck$kl' 21 | 22 | # SECURITY WARNING: don't run with debug turned on in production! 23 | DEBUG = True 24 | 25 | TEMPLATE_DEBUG = True 26 | 27 | ALLOWED_HOSTS = [] 28 | 29 | 30 | # Application definition 31 | 32 | INSTALLED_APPS = ( 33 | 'admin_watchdog', 34 | 'django.contrib.admin', 35 | 'django.contrib.auth', 36 | 'django.contrib.contenttypes', 37 | 'django.contrib.sessions', 38 | 'django.contrib.messages', 39 | 'django.contrib.staticfiles', 40 | ) 41 | 42 | MIDDLEWARE = ( 43 | 'django.contrib.sessions.middleware.SessionMiddleware', 44 | 'django.middleware.common.CommonMiddleware', 45 | 'django.middleware.csrf.CsrfViewMiddleware', 46 | 'django.contrib.auth.middleware.AuthenticationMiddleware', 47 | 'django.contrib.messages.middleware.MessageMiddleware', 48 | 'django.middleware.clickjacking.XFrameOptionsMiddleware', 49 | ) 50 | 51 | ROOT_URLCONF = 'admin_watchdog.tests.urls' 52 | 53 | WSGI_APPLICATION = 'django_test.wsgi.application' 54 | 55 | TEMPLATES = [ 56 | { 57 | 'BACKEND': 'django.template.backends.django.DjangoTemplates', 58 | 'DIRS': [], 59 | 'APP_DIRS': True, 60 | 'OPTIONS': { 61 | 'context_processors': [ 62 | 'django.template.context_processors.debug', 63 | 'django.template.context_processors.request', 64 | 'django.contrib.auth.context_processors.auth', 65 | 'django.contrib.messages.context_processors.messages', 66 | ], 67 | }, 68 | }, 69 | ] 70 | 71 | 72 | # Database 73 | # https://docs.djangoproject.com/en/1.7/ref/settings/#databases 74 | 75 | DATABASES = { 76 | 'default': { 77 | 'ENGINE': 'django.db.backends.sqlite3', 78 | 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'), 79 | } 80 | } 81 | 82 | # Internationalization 83 | # https://docs.djangoproject.com/en/1.7/topics/i18n/ 84 | 85 | LANGUAGE_CODE = 'en-us' 86 | 87 | TIME_ZONE = 'UTC' 88 | 89 | USE_I18N = True 90 | 91 | USE_TZ = True 92 | 93 | 94 | # Static files (CSS, JavaScript, Images) 95 | # https://docs.djangoproject.com/en/1.7/howto/static-files/ 96 | 97 | STATIC_URL = '/static/' 98 | 99 | LOGGING = { 100 | 'version': 1, 101 | 'disable_existing_loggers': False, 102 | 'handlers': { 103 | 'admin_watchdog': { 104 | 'level': 'ERROR', 105 | 'class': 'admin_watchdog.handlers.AdminWatchdogHandler', 106 | } 107 | }, 108 | 'loggers': { 109 | 'django.request': { 110 | 'handlers': ['admin_watchdog'], 111 | 'level': 'ERROR', 112 | 'propagate': False, 113 | } 114 | } 115 | } 116 | 117 | # Used to speed up testing 118 | PASSWORD_HASHERS = { 119 | 'django.contrib.auth.hashers.MD5PasswordHasher', 120 | } 121 | -------------------------------------------------------------------------------- /admin_watchdog/tests/tests.py: -------------------------------------------------------------------------------- 1 | from django.test import Client, TestCase 2 | from django.contrib.auth.models import User 3 | 4 | from admin_watchdog.handlers import AdminWatchdogHandler 5 | from admin_watchdog.models import LogEntry 6 | from admin_watchdog.tests import mocks 7 | 8 | 9 | class ModelTestCase(TestCase): 10 | def test_object_creation(self): 11 | """ Test a simple log entry creation. """ 12 | LogEntry.objects.create( 13 | levelname="DEBUG", 14 | shortmessage="shortmessage", 15 | message="longer message.", 16 | request_repr="request", 17 | ) 18 | log = LogEntry.objects.last() 19 | self.assertEqual(LogEntry.objects.all().count(), 1) 20 | self.assertEqual(log.levelname, "DEBUG") 21 | self.assertTrue(log.when) 22 | 23 | 24 | class HandlerTestCase(TestCase): 25 | def setUp(self): 26 | self.handler = AdminWatchdogHandler() 27 | 28 | def test_emit_with_request(self): 29 | request = mocks.RequestMock() 30 | record = mocks.RecordMock(request) 31 | self.handler.emit(record) 32 | self.assertEqual(LogEntry.objects.all().count(), 1) 33 | log = LogEntry.objects.last() 34 | self.assertEqual(log.levelname, u'ERROR') 35 | self.assertNotEqual(log.request_repr, u'unavailable') 36 | 37 | def test_emit_without_request(self): 38 | record = mocks.RecordMock(None) 39 | self.handler.emit(record) 40 | self.assertEqual(LogEntry.objects.all().count(), 1) 41 | log = LogEntry.objects.last() 42 | self.assertEqual(log.levelname, u'ERROR') 43 | self.assertEqual(log.request_repr, u'unavailable') 44 | 45 | 46 | class FunctionalTestCase(TestCase): 47 | def setUp(self): 48 | self.logentry = LogEntry.objects.create( 49 | levelname="DEBUG123", 50 | shortmessage="shortmessage123", 51 | message="longer message. 123", 52 | request_repr="request123", 53 | ) 54 | user = User.objects.create_superuser('admin', '', 'password') 55 | self.c = Client() 56 | self.c.force_login(user) 57 | 58 | def test_log_entries_list_view(self): 59 | """ Test the admin view listing all log entries. """ 60 | response = self.c.get('/admin/admin_watchdog/logentry/') 61 | self.assertEqual(response.status_code, 200) 62 | self.assertIn("DEBUG123", response.content.decode('utf8')) 63 | self.assertIn("shortmessage123", response.content.decode('utf8')) 64 | self.assertNotIn( 65 | "longer message. 123", 66 | response.content.decode('utf8') 67 | ) 68 | self.assertNotIn("request123", response.content.decode('utf8')) 69 | 70 | def test_log_entry_view(self): 71 | """ Test the admin view listing a single log entry. """ 72 | response = self.c.get('/admin/admin_watchdog/logentry/{}/change/'.format(self.logentry.pk), follow=True) 73 | self.assertEqual(response.status_code, 200) 74 | self.assertIn("DEBUG123", response.content.decode('utf8')) 75 | self.assertIn("shortmessage123", response.content.decode('utf8')) 76 | self.assertIn("longer message. 123", response.content.decode('utf8')) 77 | self.assertIn("request123", response.content.decode('utf8')) 78 | 79 | def test_error_page(self): 80 | """ Test a page raising an error. A log entry should be created. """ 81 | self.assertRaises(AttributeError, self.c.get, '/') 82 | self.assertEqual(LogEntry.objects.all().count(), 2) 83 | log = LogEntry.objects.last() 84 | self.assertEqual(log.levelname, u'ERROR') 85 | self.assertEqual(log.shortmessage, u'Internal Server Error: /') 86 | -------------------------------------------------------------------------------- /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 | 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 | . --------------------------------------------------------------------------------