django-multisite2 2.0.0__py3-none-any.whl

django_multisite2-2.0.0.dist-info/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, Ecometrica
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

django_multisite2-2.0.0.dist-info/METADATA

@@ -0,0 +1,246 @@
+Metadata-Version: 2.1
+Name: django-multisite2
+Version: 2.0.0
+Summary: Serve multiple sites from a single Django application
+Home-page: http://github.com/erikvw/django-multisite
+Author: Leonid S Shestera
+Author-email: leonid@shestera.ru
+Maintainer: Ecometrica
+Maintainer-email: dev@ecometrica.com
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: tldextract
+
+ |actions| |codecov| |downloads| |maintainability| |black|
+
+
+
+README
+======
+
+Python 3.11+ Django 4.2+
+
+Older versions of Django are supported by the original `django-multisite`_ project.
+
+.. _django-multisite: https://github.com/ecometrica/django-multisite
+
+
+Installation
+============
+
+Install with pip:
+
+.. code-block::
+
+    pip install django-multisite2 (no release yet)
+
+
+Replace your ``SITE_ID`` in ``settings.py`` to:
+
+.. code-block::
+
+    from multisite import SiteID
+    SITE_ID = SiteID(default=1)
+
+
+add to INSTALLED_APPS:
+
+.. code-block::
+
+    INSTALLED_APPS = [
+        ...
+        'django.contrib.sites',
+        'multisite',
+        ...
+    ]
+
+
+Edit settings.py MIDDLEWARE:
+
+.. code-block::
+
+    MIDDLEWARE = (
+        ...
+        'multisite.middleware.DynamicSiteMiddleware',
+        ...
+    )
+
+
+Using a custom cache
+--------------------
+Append to settings.py, in order to use a custom cache that can be
+safely cleared::
+
+    # The cache connection to use for django-multisite.
+    # Default: 'default'
+    CACHE_MULTISITE_ALIAS = 'multisite'
+
+    # The cache key prefix that django-multisite should use.
+    # If not set, defaults to the KEY_PREFIX used in the defined
+    # CACHE_MULTISITE_ALIAS or the default cache (empty string if not set)
+    CACHE_MULTISITE_KEY_PREFIX = ''
+
+If you have set CACHE\_MULTISITE\_ALIAS to a custom value, *e.g.*
+``'multisite'``, add a separate backend to settings.py CACHES::
+
+    CACHES = {
+        'default': {
+            ...
+        },
+        'multisite': {
+            'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',
+            'TIMEOUT': 60 * 60 * 24,  # 24 hours
+            ...
+        },
+    }
+
+
+Domain fallbacks
+----------------
+
+By default, if the domain name is unknown, multisite will respond with
+an HTTP 404 Not Found error. To change this behaviour, add to
+settings.py::
+
+    # The view function or class-based view that django-multisite will
+    # use when it cannot match the hostname with a Site. This can be
+    # the name of the function or the function itself.
+    # Default: None
+    MULTISITE_FALLBACK = 'django.views.generic.base.RedirectView
+
+    # Keyword arguments for the MULTISITE_FALLBACK view.
+    # Default: {}
+    MULTISITE_FALLBACK_KWARGS = {'url': 'http://example.com/',
+                                 'permanent': False}
+
+Templates
+---------
+If required, create template subdirectories for domain level templates (in a
+location specified in settings.TEMPLATES['DIRS'].
+
+Multisite's template loader will look for templates in folders with the names of
+domains, such as::
+
+    templates/example.com
+
+
+The template loader will also look for templates in a folder specified by the
+optional MULTISITE_DEFAULT_TEMPLATE_DIR setting, e.g.::
+
+    templates/multisite_templates
+
+
+Cross-domain cookies
+--------------------
+
+In order to support `cross-domain cookies`_,
+for purposes like single-sign-on,
+prepend the following to the top of
+settings.py MIDDLEWARE (MIDDLEWARE_CLASSES for Django < 1.10)::
+
+    MIDDLEWARE = (
+        'multisite.middleware.CookieDomainMiddleware',
+        ...
+    )
+
+CookieDomainMiddleware will consult the `Public Suffix List`_
+for effective top-level domains.
+It caches this file
+in the system's default temporary directory
+as ``effective_tld_names.dat``.
+To change this in settings.py::
+
+    MULTISITE_PUBLIC_SUFFIX_LIST_CACHE = '/path/to/multisite_tld.dat'
+
+By default,
+any cookies without a domain set
+will be reset to allow \*.domain.tld.
+To change this in settings.py::
+
+    MULTISITE_COOKIE_DOMAIN_DEPTH = 1  # Allow only *.subdomain.domain.tld
+
+In order to fetch a new version of the list,
+run::
+
+    manage.py update_public_suffix_list
+
+.. _cross-domain cookies: http://en.wikipedia.org/wiki/HTTP_cookie#Domain_and_Path
+.. _Public Suffix List: http://publicsuffix.org/
+
+Post-migrate signal: post_migrate_sync_alias
+--------------------------------------------
+The ``post-migrate`` signal ``post_migrate_sync_alias`` is registered in the ``apps.py``. ``post_migrate_sync_alias``
+ensures the ``domain`` in multisite's ``Alias`` model is updated to match that of django's ``Site`` model. This signal must
+run AFTER any ``post-migrate`` signals that manipulate Django's ``Site`` model. If you have an app that manipulates Django's
+``Site`` model, place it before ``multisite`` in `settings. INSTALLED_APPS`. If this is not possible, you may configure ``multisite``
+to not connect the ``post-migrate`` signal in ``apps.py`` so that you can do it somewhere else in your code.
+
+To configure `multisite` to not connect the `post-post_migrate_sync_alias` in the `apps.py`, update your settings::
+
+    MULTISITE_REGISTER_POST_MIGRATE_SYNC_ALIAS = False
+
+With the `settings` attribute set to `False`, it is your responsibility to connect the signal in your code. Note that if you do not sync the `Alias` and `Site`
+models after the `Site` model has changed, multisite may not recognize the domain and switch to the fallback view or
+raise a `Http404` error.
+
+Development Environments
+------------------------
+Multisite returns a valid Alias when in "development mode" (defaulting to the
+alias associated with the default SiteID.
+
+Development mode is either:
+    - Running tests, i.e. manage.py test
+    - Running locally in settings.DEBUG = True, where the hostname is a top-level name, i.e. localhost
+
+In order to have multisite use aliases in local environments, add entries to
+your local etc/hosts file to match aliases in your applications.  E.g. ::
+
+    127.0.0.1 example.com
+    127.0.0.1 examplealias.com
+
+And access your application at example.com:8000 or examplealias.com:8000 instead of
+the usual localhost:8000.
+
+Tests
+-----
+
+To run the tests::
+
+    python runtests.py
+
+
+
+.. |pypi| image:: https://img.shields.io/pypi/v/django-multisite2.svg
+  :target: https://pypi.python.org/pypi/django-multisite2
+
+.. |actions| image:: https://github.com/erikvw/django-multisite2/actions/workflows/build.yml/badge.svg
+  :target: https://github.com/erikvw/django-multisite2/actions/workflows/build.yml
+
+.. |codecov| image:: https://codecov.io/gh/erikvw/django-multisite2/branch/develop/graph/badge.svg
+  :target: https://codecov.io/gh/erikvw/django-multisite2
+
+.. |downloads| image:: https://pepy.tech/badge/django-multisite2
+   :target: https://pepy.tech/project/django-multisite2
+
+.. |maintainability| image:: https://api.codeclimate.com/v1/badges/4992e131641fc6929b1a/maintainability
+   :target: https://codeclimate.com/github/erikvw/django-multisite2/maintainability
+   :alt: Maintainability
+
+.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://github.com/ambv/black
+   :alt: Code Style
+

django_multisite2-2.0.0.dist-info/RECORD

@@ -0,0 +1,51 @@
+multisite/__init__.py,sha256=N5kF20yLIUBBJnzipFOibsoN3QTqP4qIIufdTmkw45U,45
+multisite/apps.py,sha256=K69kWIqoWaZfbhlLVSxfYLQd-AhojiLxxXmjd26ljbo,975
+multisite/exceptions.py,sha256=FwsrZfie71gUjiOlvDO9NYX8X58P1fTagfU-VBQ3qb8,1317
+multisite/forms.py,sha256=LKojjbDvy3Lfu1-Tgjt4XKuJBYLkYOTBa4oRUJ12-dg,681
+multisite/hacks.py,sha256=OZk7adtXOV37gzi8XETHMGr-cVVZkNbcWsAQrJT3h0E,5171
+multisite/threadlocals.py,sha256=oyyTnTgJbx6fs2CoqsZi3eof_4pILtNJosXX2QQW1y4,4140
+multisite/utils.py,sha256=dyvmg9USSMSZzuXJibsUPdLoBRZinV3uiTeI8H1iG5I,5544
+multisite/admin/__init__.py,sha256=ySKx0DadaIOLct0obZeMG5ADQkMR6Scg2bMdXYTf9kc,145
+multisite/admin/alias_admin.py,sha256=gL_1yrRN8otAijdTaK4WyJSeO40ZC3QD5PU-F818Fpk,1706
+multisite/admin/multisite_changelist.py,sha256=PViIYIQ6GLL5D_HbDxTqUJt3TBImc5uYo-8MS_sIWFM,2376
+multisite/admin/multisite_model_admin.py,sha256=2_p-M3jeTLmRlLR3D8KjQaBx_FB6CJWl_ZQdn0RT0bM,6414
+multisite/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+multisite/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+multisite/management/commands/update_public_suffix_list.py,sha256=lu5zhgE2TgzsjpUT1AHPYV4UxSW68MsVcSmQCtx3-U0,974
+multisite/middleware/__init__.py,sha256=77fFnj0H7FC-S81b62YfZMAfMPU4yKVp0JHmR0or6wk,183
+multisite/middleware/cookie_domain_middleware.py,sha256=dan8R8A-lUJuO-9me86pJH1LJ4e9gxBS4yvzDXiYD1g,2358
+multisite/middleware/dynamic_site_middleware.py,sha256=Y11ApIKxYHZJgxUVyvbcN5v9pHmBwwHgrO_fcL9ehWg,7515
+multisite/migrations/0001_initial.py,sha256=TaASQ-9L_eIRlAa8dmsT6Z1nbBih2wah2abq4C39Yrc,2273
+multisite/migrations/0002_alter_alias_id_alter_alias_is_canonical.py,sha256=V1Nc2K7nn8hwN8VdkgtUpwuU7z1lSajaPvhsuLLHvfk,911
+multisite/migrations/0003_alter_alias_options_alter_alias_unique_together_and_more.py,sha256=SByQOusXLdf3xaeYIUuhJ5fkXlWqxAvS-WgqQL1n38s,1252
+multisite/migrations/0004_alter_alias_managers.py,sha256=jZlYjSd-CkWGc3GE6hY6Kf8ZsCV6MQZkNbyFJ_gg_M4,649
+multisite/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+multisite/models/__init__.py,sha256=bDgmZZANxdN9-x_VjeHKvp6xOsAjJ4Ex9iv4OIKzmQg,165
+multisite/models/alias.py,sha256=xVWGKCxWBCuC52paOeS8QoZqy0PzYfLIKezH4cn3xng,3692
+multisite/models/managers.py,sha256=dBhWrzl7U6XH26_br5BKPi8jxCCCaWQaQDWPXZPPSzo,6929
+multisite/models/signals.py,sha256=LghEu50Vc2PlLBHecMoKO0qhJ62cetMk0RfdnZ3-G1U,1540
+multisite/models/validators.py,sha256=Cq4fkmrQG4rlTDaWCjcmt_me6qRsPlxv3G2y5O79i1U,380
+multisite/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+multisite/tests/get_test_allowed_hosts.py,sha256=lXcVJVbr37dmTKo3ajNYoqvDXw_G-JNWcP5iO-lmJgo,400
+multisite/tests/get_test_http_response.py,sha256=qDFqBLULpFjZ5D_MeAOzzW29UD9QEEFiYpNGJocnGKk,329
+multisite/tests/hosts.py,sha256=YXgD6VHu5SNGHVCkY8hQPy0YDSgE98rz5x12D5IVpWo,1212
+multisite/tests/test_settings.py,sha256=PaMu9ZaySI8X0AQQxDCvaYIbTLCo8TRtVDkn9vwc3Q8,575
+multisite/tests/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+multisite/tests/tests/request_factory.py,sha256=8pYWNc4ImtZU-GnMHnj2TzO0PByGrjDyYpZ3bBe8YfU,381
+multisite/tests/tests/test_alias.py,sha256=qZ9l0noPaxxbyddPqxV8tcfeWSJHcBFxUDhCwsUxRqw,10544
+multisite/tests/tests/test_contrib_site.py,sha256=jbVWfynr--_azY257ZMQWefukQF5RR0zJ-JgHOxgB28,638
+multisite/tests/tests/test_cookie_domain_middleware.py,sha256=4fqABR6ZMApJ4sUdjK0Y3j8-E6smowURMogVHthWZW4,9193
+multisite/tests/tests/test_dynamic_site_middleware.py,sha256=vweXWXP8vRJe5d_F4b2ujhvF6iX8IUs4qpcqvX-tOsU,10931
+multisite/tests/tests/test_site_cache.py,sha256=0ImbJj7_cSftfbCOGvhllLjB3--QuQB3LtxtX2miOsM,5139
+multisite/tests/tests/test_site_domain.py,sha256=5bdJSEbuzJSeVmoI92NGeHEFJgwCIfDwppJj_HRA25E,923
+multisite/tests/tests/test_site_id.py,sha256=PS3FqC2scTExOqn-pxVXwKjwrfuu5I7CE4Y3r1zQp6g,2889
+multisite/tests/tests/test_template_loader.py,sha256=ydlM3wTpUV1_r8__Su9kGacLYHLzHPY7JMjhKNb51BA,1798
+multisite_app/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+multisite_app/apps.py,sha256=Wtzh0ZFzebAdpxwSfZIjwDoOV_QB_9HrYimscmtZDo4,149
+multisite_app/urls.py,sha256=C3OZY9b3XjMuunawaMLVsRKRKHYFROZm94JVx1NFR6Q,129
+multisite_app/views.py,sha256=zGs26VicVANJm3HGjZ9Z4TvrWSn2V-f-FXr2AwVQRzY,217
+django_multisite2-2.0.0.dist-info/LICENSE,sha256=ZYRfLPXzj_EygRXJSr99HR6EQuo2UmYHjYjC9YECitE,1497
+django_multisite2-2.0.0.dist-info/METADATA,sha256=9WQfQS8b3bTC1hESliEt2mKtGK9agL1q1PyhDXZvJwk,7622
+django_multisite2-2.0.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+django_multisite2-2.0.0.dist-info/top_level.txt,sha256=7Kbmk1LiZaUMQBzaIITFXoAQKQLFaA0YaulQ7obUTMM,24
+django_multisite2-2.0.0.dist-info/RECORD,,

django_multisite2-2.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

django_multisite2-2.0.0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+multisite
+multisite_app

multisite/__init__.py

@@ -0,0 +1 @@
+from .threadlocals import SiteDomain, SiteID

multisite/admin/__init__.py

@@ -0,0 +1,3 @@
+from .alias_admin import AliasAdmin
+from .multisite_changelist import MultisiteChangeList
+from .multisite_model_admin import MultisiteModelAdmin

multisite/admin/alias_admin.py

@@ -0,0 +1,58 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django.contrib import admin
+from django.contrib.sites.admin import SiteAdmin
+from django.contrib.sites.models import Site
+from django.db import models
+
+from ..forms import SiteForm
+from ..models import Alias
+
+if TYPE_CHECKING:
+    from django.contrib.auth.models import User
+    from django.core.handlers.wsgi import WSGIRequest as BaseWSGIRequest
+    from django.db.models import QuerySet
+
+    class UserProfile(models.Model):
+        user = models.ForeignKey(User, on_delete=models.PROTECT)
+        sites = models.ManyToManyField(Site, blank=True)
+
+    class WSGIRequest(BaseWSGIRequest):
+        user: User
+
+
+@admin.register(Alias)
+class AliasAdmin(admin.ModelAdmin):
+    """Admin for Alias model."""
+
+    list_display = ("domain", "site", "is_canonical", "redirect_to_canonical")
+    list_filter = ("is_canonical", "redirect_to_canonical")
+    ordering = ("domain",)
+    raw_id_fields = ("site",)
+    readonly_fields = ("is_canonical",)
+    search_fields = ("domain",)
+
+
+class AliasInline(admin.TabularInline):
+    """Inline for Alias model, showing non-canonical aliases."""
+
+    model = Alias
+    extra = 1
+    ordering = ("domain",)
+
+    def get_queryset(self, request: WSGIRequest) -> QuerySet[Alias]:
+        """Returns only non-canonical aliases."""
+        qs = self.model.aliases.get_queryset()
+        ordering = self.ordering or ()
+        if ordering:
+            qs = qs.order_by(*ordering)
+        return qs
+
+
+# HACK: Monkeypatch AliasInline into SiteAdmin
+SiteAdmin.inlines = type(SiteAdmin.inlines)([AliasInline]) + SiteAdmin.inlines
+
+# HACK: Monkeypatch Alias validation into SiteForm
+SiteAdmin.form = SiteForm

multisite/admin/multisite_changelist.py

@@ -0,0 +1,64 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django.contrib.admin.views.main import ChangeList
+from django.contrib.sites.models import Site
+from django.db import models
+
+from ..utils import get_user_sites
+
+__all__ = ["MultisiteChangeList"]
+
+if TYPE_CHECKING:
+    from django.contrib.auth.models import User
+    from django.core.handlers.wsgi import WSGIRequest as BaseWSGIRequest
+
+    class UserProfile(models.Model):
+        user = models.ForeignKey(User, on_delete=models.PROTECT)
+        sites = models.ManyToManyField(Site, blank=True)
+
+    class WSGIRequest(BaseWSGIRequest):
+        user: User
+
+
+class MultisiteChangeList(ChangeList):
+    """
+    A ChangeList like the built-in admin one, but it excludes site filters for
+    sites you're not associated with, unless you're a super-user.
+
+    At this point, it's probably fragile, given its reliance on Django
+    internals.
+    """
+
+    def get_filters(self, request: WSGIRequest, *args, **kwargs) -> tuple[list, bool]:
+        """
+        This might be considered a fragile function, since it relies on a
+        fair bit of Django's internals.
+        """
+        get_filters = super().get_filters
+        filter_specs, has_filter_specs = get_filters(request)
+        if request.user.is_superuser or not has_filter_specs:
+            return filter_specs, has_filter_specs
+        new_filter_specs = []
+        user_sites = frozenset(get_user_sites(request).values_list("pk", "domain"))
+        for filter_spec in filter_specs:
+            try:
+                try:
+                    remote_model = filter_spec.field.remote_field.model
+                except AttributeError:
+                    remote_model = filter_spec.field.related_model
+            except AttributeError:
+                new_filter_specs.append(filter_spec)
+                continue
+            if remote_model is not Site:
+                new_filter_specs.append(filter_spec)
+                continue
+            lookup_choices = frozenset(filter_spec.lookup_choices) & user_sites
+            if len(lookup_choices) > 1:
+                # put the choices back into the form they came in
+                filter_spec.lookup_choices = list(lookup_choices)
+                filter_spec.lookup_choices.sort()
+                new_filter_specs.append(filter_spec)
+
+        return new_filter_specs, bool(new_filter_specs)

multisite/admin/multisite_model_admin.py

@@ -0,0 +1,161 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django.contrib import admin
+from django.contrib.sites.models import Site
+from django.db import models
+
+from ..utils import get_user_sites
+from .multisite_changelist import MultisiteChangeList
+
+__all__ = ["MultisiteModelAdmin"]
+
+if TYPE_CHECKING:
+    from django.contrib.auth.models import User
+    from django.core.handlers.wsgi import WSGIRequest as BaseWSGIRequest
+    from django.db.models import QuerySet
+
+    class UserProfile(models.Model):
+        user = models.ForeignKey(User, on_delete=models.PROTECT)
+        sites = models.ManyToManyField(Site, blank=True)
+
+    class WSGIRequest(BaseWSGIRequest):
+        user: User
+
+
+class MultisiteModelAdmin(admin.ModelAdmin):
+    """
+    A very helpful ModelAdmin class for handling multi-site django
+    applications.
+    """
+
+    filter_sites_by_current_object = False
+
+    def __init__(self, model, admin_site):
+        self.object_sites: tuple | None = None
+        super().__init__(model, admin_site)
+
+    def get_queryset(self, request: WSGIRequest) -> QuerySet:
+        """
+        Filters lists of items to items belonging to sites assigned to the
+        current member.
+
+        Additionally, for cases where the field containing a reference
+        to 'site' or 'sites' isn't immediate -- one can supply the
+        ModelAdmin class with a list of fields to check the site of:
+
+         - multisite_filter_fields
+            A list of paths to a 'site' or 'sites' field on a related model to
+            filter the queryset on.
+
+        (As long as you're not a superuser)
+        """
+        qs = super().get_queryset(request)
+        if request.user.is_superuser:
+            return qs
+        user_sites = get_user_sites(request)
+        if hasattr(qs.model, "site"):
+            qs = qs.filter(site__in=user_sites)
+        elif hasattr(qs.model, "sites"):
+            qs = qs.filter(sites__in=user_sites)
+
+        if hasattr(self, "multisite_filter_fields"):
+            for field in self.multisite_filter_fields:
+                qkwargs = {"{field}__in".format(field=field): user_sites}
+                qs = qs.filter(**qkwargs)
+
+        return qs
+
+    def add_view(self, request: WSGIRequest, form_url: str = "", extra_context: dict = None):
+        if self.filter_sites_by_current_object:
+            if hasattr(self.model, "site") or hasattr(self.model, "sites"):
+                self.object_sites = tuple()
+        return super().add_view(request, form_url, extra_context)
+
+    def change_view(
+        self, request: WSGIRequest, object_id, form_url: str = "", extra_context: dict = None
+    ):
+        if self.filter_sites_by_current_object:
+            object_instance = self.get_object(request, object_id)
+            try:
+                self.object_sites = object_instance.sites.values_list("pk", flat=True)
+            except AttributeError:
+                try:
+                    self.object_sites = (object_instance.site.pk,)
+                except AttributeError:
+                    pass  # assume the object doesn't belong to a site
+        return super().change_view(request, object_id, form_url, extra_context)
+
+    def handle_multisite_foreign_keys(self, db_field, request, **kwargs):
+        """
+        Filters the foreignkey queryset for fields referencing other models
+        to those models assigned to a site belonging to the current member
+        (if they aren't a superuser), and (optionally) belonging to the same
+        site as the current object.
+
+        Also prevents (non-super) users from assigning objects to sites that
+        they are not members of.
+
+        If the foreign key does not have a site/sites field directly, you can
+        specify a path to a site/sites field to filter on by setting the key:
+
+            - multisite_foreign_key_site_path
+
+        to a dictionary pointing specific foreign key field instances
+        from their model to the site field to filter on something
+        like:
+
+            multisite_indirect_foreign_key_path = {
+                    'plan_instance': 'plan__site'
+                }
+
+        for a field named 'plan_instance' referencing a model with a
+        foreign key named 'plan' having a foreign key to 'site'.
+
+        To filter the FK queryset to the same sites the current object belongs
+        to, simply set `filter_sites_by_current_object` to `True`.
+
+        Caveats:
+
+        1) If you're adding an object that belongs to a site (or sites),
+        and you've set `self.limit_sites_by_current_object = True`,
+        then the FK fields to objects that also belong to a site won't show
+        any objects. This is due to filtering on an empty queryset.
+        """
+        user_sites = get_user_sites(request)
+        try:
+            remote_model = db_field.remote_field.model
+        except AttributeError:
+            remote_model = db_field.related_model
+        if hasattr(remote_model, "site"):
+            kwargs["queryset"] = remote_model._default_manager.filter(site__in=user_sites)
+        if hasattr(remote_model, "sites"):
+            kwargs["queryset"] = remote_model._default_manager.filter(sites__in=user_sites)
+        if db_field.name == "site" or db_field.name == "sites":
+            kwargs["queryset"] = user_sites
+        if (
+            hasattr(self, "multisite_indirect_foreign_key_path")
+            and db_field.name in self.multisite_indirect_foreign_key_path.keys()
+        ):
+            fkey = self.multisite_indirect_foreign_key_path[db_field.name]
+            kwargs["queryset"] = remote_model._default_manager.filter(**{fkey: user_sites})
+
+        return kwargs
+
+    def formfield_for_foreignkey(self, db_field, request, **kwargs):
+        kwargs = self.handle_multisite_foreign_keys(db_field, request, **kwargs)
+        return super().formfield_for_foreignkey(db_field, request, **kwargs)
+
+    def formfield_for_manytomany(self, db_field, request, **kwargs):
+        kwargs = self.handle_multisite_foreign_keys(db_field, request, **kwargs)
+        return super().formfield_for_manytomany(db_field, request, **kwargs)
+
+    def get_changelist(self, request, **kwargs):
+        """
+        Restrict the site filter (if there is one) to sites you are
+        associated with, or remove it entirely if you're just
+        associated with one site. Unless you're a super-user, of
+        course.
+        """
+        return MultisiteChangeList

multisite/apps.py

@@ -0,0 +1,29 @@
+from django.apps import AppConfig as DjangoAppConfig
+from django.conf import settings
+from django.db.models.signals import post_migrate
+
+from multisite.hacks import use_framework_for_site_cache
+from multisite.utils import create_or_sync_canonical_from_all_sites
+
+
+def post_migrate_sync_alias(apps=None, **kwargs):
+    """Syncs canonical Alias objects for all existing Site objects."""
+    create_or_sync_canonical_from_all_sites(apps)
+
+
+class AppConfig(DjangoAppConfig):
+    name = "multisite"
+    verbose_name = "Multisite"
+    default_auto_field = "django.db.models.BigAutoField"
+
+    def import_models(self):
+        use_framework_for_site_cache()
+        super().import_models()
+
+    def ready(self):
+        if not getattr(settings, "MULTISITE_REGISTER_POST_MIGRATE_SYNC_ALIAS", True):
+            post_migrate.connect(
+                post_migrate_sync_alias,
+                sender=self,
+                dispatch_uid="multisite.post_migrate_sync_alias",
+            )