django-tos 1.1.0

优点

• 可选地使用单独的缓存来存储 TOS 协议（如果默认缓存不支持原子递增操作则必须使用）

• 允许某些用户跳过 TOS 检查（例如：开发者、员工、管理员、超级用户、员工）

• 使用信号来使缓存的协议无效

• 当用户匿名或未登录时跳过协议检查

• 当请求是 AJAX 时跳过协议检查

• 当请求不是 GET 请求时跳过协议检查（以避免干扰数据更改）

缺点

• 需要为每个已登录用户创建一个缓存键

• 需要为每个员工用户创建一个额外的缓存键

• 当活跃的 TermsOfService 发生变化时，可能留下缓存中的键

效率

• 员工用户最佳情况：2 次缓存命中

• 非员工用户最佳情况：1 次缓存未命中，2 次缓存命中

• 最坏情况：1 次缓存命中，2 次缓存未命中，1 次数据库查询，1 次缓存设置（这仅在用户登录时发生）

选项 2 配置

1. 在您的根 URL 配置文件 urls.py 中仅添加 TOS URL

   # terms of service links
   urlpatterns += patterns('',
       url(r'^terms-of-service/', include('tos.urls')),
   )

2. 可选：由于 TOS 使用的缓存将主要进行读取操作，您可以使用专门用于 TOS 的单独缓存。为此，在项目的 settings.py 中创建一个新的缓存

   CACHES = {
       ...
       # The cache specifically for django-tos
       'tos': {  # Can use any name here
           'BACKEND': ...,
           'LOCATION': ...,
           'NAME': 'tos-cache',  # Can use any name here
       },
   }

   并配置 django-tos 使用新缓存

   TOS_CACHE_NAME = 'tos'  # Must match the key name in in CACHES

   此设置默认为 default 缓存。

4. 然后在您的项目的 settings.py 中添加中间件到 MIDDLEWARE_CLASSES

   MIDDLEWARE_CLASSES = (
       ...
       # Terms of service checks
       'tos.middleware.UserAgreementMiddleware',
   )

5. 可选：要允许用户跳过 TOS 检查，您需要在 TOS 缓存中为它们设置相应的缓存键。每个用户的缓存键需要以 django:tos:skip_tos_check: 为前缀，并附加用户 ID。

   以下是一个示例应用程序配置，允许员工用户和超级用户跳过 TOS 协议检查

   from django.apps import AppConfig, apps
   from django.conf import settings
   from django.contrib.auth import get_user_model
   from django.core.cache import caches
   from django.db.models import Q
   from django.db.models.signals import post_save, pre_save
   from django.dispatch import receiver
   
   class MyAppConfig(AppConfig):
       name = 'myapp'
   
       def ready(self):
           if 'tos' in settings.INSTALLED_APPS:
               cache = caches[getattr(settings, 'TOS_CACHE_NAME', 'default')]
               tos_app = apps.get_app_config('tos')
               TermsOfService = tos_app.get_model('TermsOfService')
   
               @receiver(post_save, sender=get_user_model(), dispatch_uid='set_staff_in_cache_for_tos')
               def set_staff_in_cache_for_tos(user, instance, **kwargs):
                   if kwargs.get('raw', False):
                       return
   
                   # Get the cache prefix
                   key_version = cache.get('django:tos:key_version')
   
                   # If the user is staff allow them to skip the TOS agreement check
                   if instance.is_staff or instance.is_superuser:
                       cache.set('django:tos:skip_tos_check:{}'.format(instance.id), version=key_version)
   
                   # But if they aren't make sure we invalidate them from the cache
                   elif cache.get('django:tos:skip_tos_check:{}'.format(instance.id), False):
                       cache.delete('django:tos:skip_tos_check:{}'.format(instance.id), version=key_version)
   
               @receiver(post_save, sender=TermsOfService, dispatch_uid='add_staff_users_to_tos_cache')
               def add_staff_users_to_tos_cache(*args, **kwargs):
                   if kwargs.get('raw', False):
                       return
   
                   # Get the cache prefix
                   key_version = cache.get('django:tos:key_version')
   
                   # Efficiently cache all of the users who are allowed to skip the TOS
                   # agreement check
                   cache.set_many({
                       'django:tos:skip_tos_check:{}'.format(staff_user.id): True
                       for staff_user in get_user_model().objects.filter(
                           Q(is_staff=True) | Q(is_superuser=True))
                   }, version=key_version)
   
               # Immediately add staff users to the cache
               add_staff_users_to_tos_cache()