如何使用django allauth实现一个邀请流来进行注册/签名?

时间:2014-06-04 09:59:45

标签: python django django-allauth

背景

我正在构建一个应用,用户可以邀请其他人在不同的资源上进行协作。被邀请的人可能已经是该应用的用户,或者可能是全新的用户。当我使用allauth进行注册/签名时,被邀请者可以通过标准注册/签名表单或通过三个社交帐户(fb,twitter,google)中的一个回复邀请。

由于这些要求,如果现有用户接受邀请,则子类化DefaultAccountAdapter并覆盖is_open_for_signup方法将不起作用,因为这不是登录流程的一部分。


流量

  • 用户提交邀请表单,指定收件人的电子邮件地址
  • 邀请电子邮件已发送,其中包含邀请接受表格的链接
  • 用户点击指向接受表单的链接 - 他们可能已经拥有或可能没有自己的应用用户帐户
  • 由于邀请接受链接包含此邀请的唯一键,视图会将“invite_key”添加到会话中
  • 被邀请者会看到注册或登录现有用户帐户以接受邀请的选项
  • 一旦被邀请者完成注册/登录,就会收到'user_signed_up'或'user_signed_in'信号,并检查会话是否有'invite_key'以确认新用户刚刚接受了邀请
  • 使用密钥检索邀请,并针对新用户
  • 处理邀请


逻辑

接受视图的网址格式

url(r'^invitation/(?P<invite_key>[\w\d]+)/$', views.ResourceInviteAcceptanceView.as_view(), name='resource-invite-accept'),

这些是我视图的基类

https://gist.github.com/jamesbrobb/748c47f46b9bd224b07f

这是邀请接受视图的视图逻辑

from django.contrib.auth.models import User
from django.shortcuts import get_object_or_404
from django.dispatch import receiver

from allauth.account import app_settings
from allauth.account.forms import LoginForm, SignupForm
from allauth.account.utils import get_next_redirect_url, complete_signup
from allauth.account.signals import user_signed_up, user_logged_in

from forms.views import MultiFormsView
from api.models import ResourceInvite

class ResourceInviteAcceptanceView(MultiFormsView):
    template_name = 'public/resource_invite_accept.html'
    form_classes = {'login': LoginForm,
                    'signup': SignupForm}
    redirect_field_name = "next"

    def get_invite(self):
        invite_key = self.kwargs['invite_key']
        invite = get_object_or_404(ResourceInvite, key=invite_key)
        return invite

    def get_login_initial(self):
        invite = self.get_invite()
        return {'login':invite.email}

    def get_signup_initial(self):
        invite = self.get_invite()
        return {'email':invite.email}

    def get_context_data(self, **kwargs):
        context = super(ResourceInviteAcceptanceView, self).get_context_data(**kwargs)
        context.update({"redirect_field_name": self.redirect_field_name,
                        "redirect_field_value": self.request.REQUEST.get(self.redirect_field_name)})
        return context

    def get_success_url(self):
        # Explicitly passed ?next= URL takes precedence
        ret = (get_next_redirect_url(self.request,
                                     self.redirect_field_name)
               or self.success_url)
        return ret

    def login_form_valid(self, form):
        return form.login(self.request, redirect_url=self.get_success_url())

    def signup_form_valid(self, form):
        user = form.save(self.request)
        return complete_signup(self.request, user,
                               app_settings.EMAIL_VERIFICATION,
                               self.get_success_url())

    def get(self, request, *args, **kwargs):
        session = request.session
        session['invite_key'] = self.kwargs['invite_key'] 
        return super(ResourceInviteAcceptanceView, self).get(request, *args, **kwargs)


@receiver ([user_signed_up, user_logged_in], sender=User)
def check_for_invite(sender, **kwargs):
    signal = kwargs.get('signal', None)
    user = kwargs.get('user', None)
    request = kwargs.get('request', None)
    session = request.session
    invite_key = session.get('invite_key')
    if invite_key:
        invite = get_object_or_404(ResourceInvite, key=invite_key)
        """ logic to process invite goes here """
        del session['invite_key']


问题

只要被邀请者点击链接并完成邀请接受流程,这一切都可以正常工作。

但是...

如果他们在该过程中的任何时候保释(明确地或由于错误),会话中仍然存在'invite_key',因此当下一个人(他们或其他人)报名或登录时会被处理


问题

处理这个问题的最佳方法是什么?是否可以将“invite_key”添加到会话中,这可以保证用户已经实际接受了邀请?

对于标准注册/签名,这可能是覆盖'forms_valid'方法,因为我们知道此时用户已完成其中任何一个进程。但我不知道在使用社交注册/签名时在哪里/如何添加'invite_key'?


- 更新 -

可能的解决方案#1

通过社交登录,向会话添加邀请密钥的最佳位置 - 确保用户正在通过社交登录接受邀请 - 似乎是通过在'pre_social_login'信号中添加接收器。我遇到的问题是如何确保在触发信号时仍然可以访问密钥,以便将其添加到会话中?

一个失败的解决方案是简单地访问接收器函数中的HTTP_REFERER,可以包含邀请URL。密钥可以从中删除,然后添加到会话中。但是如果用户是应用程序的新用户或当前没有登录到他们的社交帐户,则会失败,因为他们首先被重定向到社交帐户登录页面(在社交帐户域上),然后当回调重定向发生时和信号触发后,HTTP_REFERER的值不再存在。

我无法找到一种好方法,可以在信号接收器功能中访问邀请键值,而不会产生相同的原始问题?

2 个答案:

答案 0 :(得分:2)

我已经提出了一个解决方案,但我并不是百分之百满意,因为它涉及在state_from_request上修补allauth.socialaccount.models.SocialLogin类方法。

原因是

  • 这是所有提供商在启动社交身份验证过程时调用的单一共享逻辑点

  • SocialLogin的'state'属性已在社交登录过程中存储在会话中,然后在完成时检索并通过'pre_social_login'信号传递

这是从请求中检索特定值的原始方法,然后将其存储在会话中,供进程完成后由allauth使用

@classmethod
def state_from_request(cls, request):
    state = {}
    next_url = get_next_redirect_url(request)
    if next_url:
        state['next'] = next_url
    state['process'] = request.REQUEST.get('process', 'login')
    return state

这是补丁

def state_from_request_wrapper(wrapped_func):
    wrapped_func = wrapped_func.__func__
    def _w(cls, request):
        state = wrapped_func(cls, request)
        invite_key = extract_invite_key(request)
        if invite_key:
            state['invite_key'] = invite_key
        return state
    return classmethod(_w)

def extract_invitation_key(request):
    referer = request.META.get('HTTP_REFERER')
    if not referer:
        return None
    p = re.compile('iv/(?P<invite_key>[\w\d]+)/$')
    match = p.search(referer)
    if not match:
        return None
    return match.group(1)

SocialLogin.state_from_request = state_from_request_wrapper(SocialLogin.state_from_request)

我已从视图中删除了覆盖get方法并覆盖了forms_valid方法,而是将邀请密钥添加到会话中,因为此时在标准登录/注册期间我们知道邀请已被接受

def forms_valid(self, forms, form_name):
    session = self.request.session
    session['invite_key'] = self.get_invite().key
    return super(ResourceInviteAcceptanceView, self).forms_valid(forms, form_name)

这些是信号接收器功能

@receiver (pre_social_login, sender=SocialLogin)    
def check_pre_social_login(sender, **kwargs):
    social_login = kwargs['sociallogin']
    request = kwargs['request']
    session = request.session
    invite_key = social_login.state.get('invite_key')
    if invite_key:
        session['invite_key'] = invite_key


@receiver ([user_signed_up, user_logged_in], sender=User)
def check_for_invite(sender, **kwargs): 
    request = kwargs['request']
    session = request.session
    invite_key = session.get('invite_key')
    if invite_key:
        invite = get_object_or_404(ResourceInvite, key=invite_key)
        process_invite(kwargs['user'], invite, True)
        del session['invite_key']


def process_invite(user, invite, accept):
    ...
    # process invite here

答案 1 :(得分:0)

与此同时,有人刚刚建立了一个python包(django-invitations),它可以很好地完成这项工作并且不需要修补猴子。

在Github上查看:enter link description here