Merge with all pull request sent.

.gitignore

@@ -4,3 +4,4 @@ docs/_build
 *.pyc
 .tox
 build
+.idea

docs/quickstart.rst

@@ -32,6 +32,8 @@ What you get
 
 * Password reset links that expire in two days (configurable).
 
+* Optionally invoke a captcha in the password reset page if django-simple-captcha (0.5.1 or higher) is installed and configured.
+
 What you can do
 ---------------
 

docs/views.rst

@@ -43,6 +43,10 @@ Attributes
 * ``email_template_name``: the template to use for sending the reset link by
   email. Default: ``password_reset/recovery_email.txt``.
 
+* ``email_html_template_name``: the HTML template to use for sending the reset link by
+  email. The content of this template will be sent as the text/html content type alternative.
+  Default: ``password_reset/recovery_email.html``.
+
 * ``email_subject_template_name``: the template to use for generating the
   email subject. Defaults to ``password_reset/recovery_email_subject.txt``.
 

password_reset/__init__.py

@@ -1 +1 @@
-__version__ = '1.0'
+__version__ = '1.0.0'

password_reset/compat/__init__.py

@@ -0,0 +1,34 @@
+# coding=utf-8
+
+def get_user_model():
+    """
+    Returns the User model that is active in this project.
+    """
+    try:
+        from django.contrib.auth import get_user_model
+        User = get_user_model()
+    except ImportError:
+        from django.contrib.auth.models import User
+    return User
+
+
+def get_username(user):
+    """
+    Returns the name of the username field
+    :param user: User object instance
+    :return: str
+    """
+    username_field = getattr(user, 'USERNAME_FIELD', 'username')
+    return getattr(user, username_field)
+
+
+def get_current_site(*args, **kwargs):
+    """
+    Checks if contrib.sites is installed and returns either the current
+    ``Site`` object or a ``RequestSite`` object based on the request.
+    """
+    try:
+        from django.contrib.sites.shortcuts import get_current_site as current_site
+    except ImportError:
+        from django.contrib.sites.models import get_current_site as current_site
+    return current_site(*args, **kwargs)

password_reset/compat/urls.py

@@ -0,0 +1,6 @@
+# coding=utf-8
+
+try:
+    from django.urls import reverse, reverse_lazy, NoReverseMatch
+except ImportError:
+    from django.core.urlresolvers import reverse, reverse_lazy, NoReverseMatch

password_reset/forms.py

@@ -1,17 +1,45 @@
 from django import forms
-from django.contrib.auth import get_user_model
+from django.core.exceptions import ImproperlyConfigured
 from django.core.validators import validate_email
 from django.db.models import Q
-from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import gettext_lazy as _
 from django.conf import settings
+from .compat import get_user_model
 
+error_messages = {
+    'not_found': _("Sorry, this user doesn't exist."),
+    'password_mismatch': _("The two passwords didn't match."),
+}
+
+try:
+    # must be installed before.
+    if 'captcha' not in settings.INSTALLED_APPS:
+        raise ImproperlyConfigured("captcha is not installed.")
+
+    # uses django-simple-captcha
+    from captcha.fields import CaptchaField
+
+
+    class CaptchaForm(forms.Form):
+        captcha = CaptchaField(label=_('Captcha'))  # Optional Captcha
+
+        def order_fields(self, field_order):
+            """https://docs.djangoproject.com/en/1.9/ref/forms/api/#django.forms.Form.order_fields"""
+            # Put the captcha at the bottom of the form
+            field_name = "captcha"
+            if field_order is None:
+                field_order = self.fields.keys()
+            field_order.pop(field_order.index(field_name))
+            field_order.append(field_name)
+            return super(CaptchaForm, self).order_fields(field_order)
 
-class PasswordRecoveryForm(forms.Form):
-    username_or_email = forms.CharField()
 
-    error_messages = {
-        'not_found': _("Sorry, this user doesn't exist."),
-    }
+except (ImproperlyConfigured, ImportError):
+    CaptchaForm = forms.Form
+
+
+class PasswordRecoveryForm(CaptchaForm):
+    username_or_email = forms.CharField()
 
     def __init__(self, *args, **kwargs):
         self.case_sensitive = kwargs.pop('case_sensitive', True)
@@ -52,17 +80,23 @@ def clean_username_or_email(self):
 
         if recovery_only_active_users and not user_is_active:
             raise forms.ValidationError(_("Sorry, inactive users can't "
-                                        "recover their password."))
+                                          "recover their password."))
 
         return username
 
+    def get_user(self, *args, **kwargs):
+        """ Method used to customize how to get the user into subclasses.
+        :rtype: User object
+        """
+        return get_user_model()._default_manager.get(*args, **kwargs)
+
     def get_user_by_username(self, username):
         key = 'username__%sexact' % ('' if self.case_sensitive else 'i')
         User = get_user_model()
         try:
-            user = User._default_manager.get(**{key: username})
+            user = self.get_user(**{key: username})
         except User.DoesNotExist:
-            raise forms.ValidationError(self.error_messages['not_found'],
+            raise forms.ValidationError(error_messages['not_found'],
                                         code='not_found')
         return user
 
@@ -71,24 +105,25 @@ def get_user_by_email(self, email):
         key = 'email__%sexact' % ('' if self.case_sensitive else 'i')
         User = get_user_model()
         try:
-            user = User._default_manager.get(**{key: email})
+            user = self.get_user(**{key: email})
         except User.DoesNotExist:
-            raise forms.ValidationError(self.error_messages['not_found'],
+            raise forms.ValidationError(error_messages['not_found'],
                                         code='not_found')
         return user
 
     def get_user_by_both(self, username):
         key = '__%sexact'
         key = key % '' if self.case_sensitive else key % 'i'
 
-        def f(field):
+        def f(field):  # to satisfy lint in Travis auto build on Github
             return Q(**{field + key: username})
+
         filters = f('username') | f('email')
         User = get_user_model()
         try:
-            user = User._default_manager.get(filters)
+            user = self.get_user(filters)
         except User.DoesNotExist:
-            raise forms.ValidationError(self.error_messages['not_found'],
+            raise forms.ValidationError(error_messages['not_found'],
                                         code='not_found')
         except User.MultipleObjectsReturned:
             raise forms.ValidationError(_("Unable to find user."))
@@ -106,10 +141,6 @@ class PasswordResetForm(forms.Form):
         widget=forms.PasswordInput,
     )
 
-    error_messages = {
-        'password_mismatch': _("The two passwords didn't match."),
-    }
-
     def __init__(self, *args, **kwargs):
         self.user = kwargs.pop('user')
         super(PasswordResetForm, self).__init__(*args, **kwargs)
@@ -119,7 +150,7 @@ def clean_password2(self):
         password2 = self.cleaned_data['password2']
         if not password1 == password2:
             raise forms.ValidationError(
-                self.error_messages['password_mismatch'],
+                error_messages['password_mismatch'],
                 code='password_mismatch')
         return password2
 

password_reset/locale/es/LC_MESSAGES/django.po

@@ -127,5 +127,5 @@ msgid ""
 "An email was sent to <strong>%(email)s</strong> %(ago)s ago. Use the link in "
 "it to set a new password."
 msgstr ""
-"Un email ha sido enviado a <strong>%(email)s</strong> hace %(ago)s minutos. "
+"Un email ha sido enviado a <strong>%(email)s</strong> hace %(ago)s. "
 "Use el enlace recibido para recuperar su clave"

password_reset/locale/zh

@@ -0,0 +1 @@
+zh-hans

password_reset/locale/zh/LC_MESSAGES/django.po → password_reset/locale/zh-hans/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2014-01-23 10:01+0800\n"
+"POT-Creation-Date: 2016-02-05 16:48+0800\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -17,35 +17,43 @@ msgstr ""
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 
-#: forms.py:26
+#: forms.py:14
+msgid "Captcha"
+msgstr "认证码"
+
+#: forms.py:17
+msgid "Sorry, this user doesn't exist."
+msgstr "抱歉,用户名不存在."
+
+#: forms.py:34
 msgid "Username"
 msgstr "用户名"
 
-#: forms.py:27
+#: forms.py:35
 msgid "Email"
 msgstr "邮箱"
 
-#: forms.py:28
+#: forms.py:36
 msgid "Username or Email"
 msgstr "用户名或者邮箱"
 
-#: forms.py:48 forms.py:58 forms.py:70
-msgid "Sorry, this user doesn't exist."
-msgstr "抱歉,用户名不存在."
+#: forms.py:58
+msgid "Sorry, inactive users can't recover their password."
+msgstr "非常抱歉，非活跃用户无法重置密码。"
 
-#: forms.py:72
+#: forms.py:96
 msgid "Unable to find user."
 msgstr "找不到指定用户"
 
-#: forms.py:78
+#: forms.py:103
 msgid "New password"
 msgstr "新密码"
 
-#: forms.py:82
+#: forms.py:107
 msgid "New password (confirm)"
-msgstr "新密码(确认)"
+msgstr "新密码（确认）"
 
-#: forms.py:94
+#: forms.py:112
 msgid "The two passwords didn't match."
 msgstr "两次输入的密码不一致"
 
@@ -57,19 +65,19 @@ msgstr "设置新密码"
 msgid ""
 "Your password has successfully been reset. You can use it right now on the "
 "login page."
-msgstr "您的密码已经重设成功,现在可以登录了."
+msgstr "您的密码已经重设成功，现在可以登录了。"
 
 #: templates/password_reset/recovery_email.txt:1
 #, python-format
 msgid "Dear %(username)s,"
-msgstr "您好 %(username)s,"
+msgstr "%(username)s，您好："
 
 #: templates/password_reset/recovery_email.txt:3
 #, python-format
 msgid ""
 "You -- or someone pretending to be you -- has requested a password reset on "
 "%(domain)s."
-msgstr "您或者其它的人在 %(domain)s 申请了密码重置."
+msgstr "您或某人在 %(domain)s 申请了密码重置。"
 
 #: templates/password_reset/recovery_email.txt:5
 msgid "You can set your new password by following this link:"
@@ -79,18 +87,30 @@ msgstr "您可以通过以下链接重置密码:"
 msgid ""
 "If you don't want to reset your password, simply ignore this email and it "
 "will stay unchanged."
-msgstr "如果您不想重设密码，可以忽略此邮箱."
+msgstr "若不想重设密码，可以忽略此邮件。"
+
+#: templates/password_reset/recovery_email.txt:11
+msgid "Yours Truly"
+msgstr "感谢您的惠顾"
+
+#: templates/password_reset/recovery_email.txt:12
+msgid "Administrator"
+msgstr "管理者"
 
 #: templates/password_reset/recovery_email_subject.txt:1
 #, python-format
 msgid "Password recovery on %(domain)s"
-msgstr "在 %(domain)s 上重设密码"
+msgstr "重设 %(domain)s 密码"
 
 #: templates/password_reset/recovery_form.html:5
 msgid "Password recovery"
 msgstr "重新设置密码"
 
-#: templates/password_reset/recovery_form.html:11
+#: templates/password_reset/recovery_form.html:8
+msgid "Recover Password"
+msgstr "重设密码"
+
+#: templates/password_reset/recovery_form.html:60
 msgid "Recover my password"
 msgstr "重设密码"
 
@@ -99,7 +119,8 @@ msgstr "重设密码"
 msgid ""
 "Sorry, this password reset link is invalid. You can still <a href="
 "\"%(recovery_url)s\">request a new one</a>."
-msgstr "抱歉，链接已经失效，您可以在 <a href=""\"%(recovery_url)s\">请求一个新链接</a>."
+msgstr ""
+"抱歉，链接已经失效，您可以在 <a href=\"%(recovery_url)s\">请求一个新链接</a>."
 
 #: templates/password_reset/reset.html:7
 #, python-format
@@ -114,9 +135,26 @@ msgstr "设置新密码"
 msgid "Password recovery sent"
 msgstr "发送重设密码"
 
-#: templates/password_reset/reset_sent.html:7
+#: templates/password_reset/reset_sent.html:8
 #, python-format
 msgid ""
 "An email was sent to <strong>%(email)s</strong> %(ago)s ago. Use the link in "
 "it to set a new password."
-msgstr "已经在%(ago)s以前向您的邮箱 <strong>%(email)s</strong>发送了邮件,根据邮件提示重新设置您的新密码."
+msgstr ""
+"已经在%(ago)s以前向您的邮箱 <strong>%(email)s</strong> 发送了邮件，请根据邮件"
+"提示重新设置您的新密码."
+
+#: templates/password_reset/reset_sent.html:11
+#: templates/password_reset/reset_sent_failed.html:9
+msgid "Return to Main Page"
+msgstr "回主页"
+
+#: templates/password_reset/reset_sent_failed.html:4
+msgid "Password recovery NOT successful"
+msgstr "发送重设密码"
+
+#: templates/password_reset/reset_sent_failed.html:7
+msgid ""
+"The email for this registered user is invalid, password reset information "
+"cannot be sent. Please contact our administrator for assistance."
+msgstr "此用户电邮地址无法接收密码重置信息。欢迎联系我们的客服部门。"

password_reset/locale/zh_Hans

@@ -0,0 +1 @@
+zh-hans

password_reset/signals.py

@@ -1,6 +1,4 @@
 from django.dispatch import Signal
 
 # signal sent when users successfully recover their passwords
-user_recovers_password = Signal(
-    providing_args=['user', 'request']
-)
+user_recovers_password = Signal()