divio / aldryn-sites Goto Github PK

View Code? Open in Web Editor NEW

6.0 13.0 4.0 56 KB

Extensions to django.contrib.sites

License: BSD 3-Clause "New" or "Revised" License

Python 100.00%

aldryn-sites's Introduction

aldryn-sites

Extensions to django.contrib.sites.

Features

Domain redirects: handles smart redirecting to a main domain from alias domains. Taking http/https into consideration.
Site auto-population: automatically populates the Domain name in django.contrib.sites.Site.domain based on the ALDRYN_SITES_DOMAINS setting.

Installation

add aldryn_sites to INSTALLED_APPS.
add aldryn_sites.middleware.SiteMiddleware to MIDDLEWARE_CLASSES (place it before djangosecure.middleware.SecurityMiddleware if redirects should be smart about alias domains possibly not having a valid certificate of their own. The middleware will pick up on SECURE_SSL_REDIRECT from django-secure.)

configure ALDRYN_SITES_DOMAINS:

ALDRYN_SITES_DOMAINS = {
    1: {  # matches SITE_ID
        'domain': 'www.example.com',  # main domain that all domains in redirects will redirect to.
                                      # Auto populates ``django.contrib.sites.Site.domain``
        'aliases': [                  # these domains will be accessible like the main domain (no redirect).
            'an.other.domain.com',
            r'^[a-z0-9-]+\.anysub\.com$',  # regexes are supported
        ],
        'redirects': [                # these domains will be redirected to the main domain.
            'example.com',            # add ``'*'`` to redirect all non-main domains to the main one.
            'example.ch',
            'www.example.ch',
            r'^[a-z0-9-]+\.my-redirect-domain\.com$',  # regexes are supported
            r'.*',  # matches any domain (Makes the above rules useless. It's just an example)
        ],
    }
}

When using regexes:

exact matches win over pattern matches
pattern redirect matches win over pattern alias matches

Further Settings

set ALDRYN_SITES_SET_DOMAIN_NAME to False if you don't want django.contrib.sites.Site.domain to be auto-populated (default: True).

TODOS

validate settings
test settings validators
log warning if there are Sites in the database that are not in the settings
pretty display of how redirects will work (in admin and as a simple util)
regex support for aliases
form to test redirect logic
pre-compile and cache regexes

aldryn-sites's People

Contributors

Stargazers

Watchers

Forkers

yakky hzlf legionmarket zorkhax

aldryn-sites's Issues

SET_DOMAIN_NAME setting is not used

Setting it to False should prevent the auto-population of django.contrib.sites.Site.

smart auto-populating of site name

currently only the domain is updated with the domain name. By default both the domain name and the name of a site is example.com.

If domain and name are identical to begin with, it would make sense to update both with the domain name.

Failsafe when changing domains

Switch the domain settings in the control panel and save
Restore an older backup
Re-deploy the site on live and you may get a database error

don't redirect to http from https if SECURE_SSL_REDIRECT is False

In the case of SECURE_SSL_REDIRECT=False (the default) and if the url already is https, aldryn-sites tries to redirect to http. The correct behaviour would be to stay on https.

allow excluding certain paths from redirects

find a better solution for populating ALLOWED_HOSTS (no regexes!)

Maybe just include the ALLOWED_HOSTS functionality in our middleware and always put '*' in for djangos check?

The setting ALDRYN_SITES_SET_DOMAIN_NAME is never used

The setting ALDRYN_SITES_SET_DOMAIN_NAME is and never has been used since the change that introduced it. It should be removed.

Introduced here: 94fefde

Does not work on Django 1.7

A few tests fail because of differences in ORM behaviour in Django 1.7 and ALLOWED_HOSTS being unset. Needs further investigation.

======================================================================
ERROR: test_auto_configure_site_domain (aldryn_sites.tests.AldrynSitesTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "./aldryn_sites/tests.py", line 150, in test_auto_configure_site_domain
    Site.objects.all().delete()
  File "[...]/projects/aldryn/aldryn-sites/.tox/py27-dj17/lib/python2.7/site-packages/django/db/models/manager.py", line 92, in manager_method
    return getattr(self.get_queryset(), name)(*args, **kwargs)
  File "[...]/projects/aldryn/aldryn-sites/.tox/py27-dj17/lib/python2.7/site-packages/django/db/models/query.py", line 361, in get
    num if num <= MAX_GET_RESULTS else 'more than %s' % MAX_GET_RESULTS
MultipleObjectsReturned: get() returned more than one Site -- it returned 2!

======================================================================
ERROR: test_auto_configure_site_domain_and_name_if_same (aldryn_sites.tests.AldrynSitesTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "./aldryn_sites/tests.py", line 162, in test_auto_configure_site_domain_and_name_if_same
    s = Site.objects.get()
  File "[...]/projects/aldryn/aldryn-sites/.tox/py27-dj17/lib/python2.7/site-packages/django/db/models/manager.py", line 92, in manager_method
    return getattr(self.get_queryset(), name)(*args, **kwargs)
  File "[...]/projects/aldryn/aldryn-sites/.tox/py27-dj17/lib/python2.7/site-packages/django/db/models/query.py", line 361, in get
    num if num <= MAX_GET_RESULTS else 'more than %s' % MAX_GET_RESULTS
MultipleObjectsReturned: get() returned more than one Site -- it returned 2!

======================================================================
FAIL: test_auto_configure_allowed_hosts (aldryn_sites.tests.AldrynSitesTestCase)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "./aldryn_sites/tests.py", line 144, in test_auto_configure_allowed_hosts
    self.assertTrue(domain in settings.ALLOWED_HOSTS, '{} not in ALLOWED_HOSTS'.format(domain))
AssertionError: www.example.com not in ALLOWED_HOSTS

----------------------------------------------------------------------