Skip to content

Utils

hypha.apply.users.utils

get_user_by_email 

get_user_by_email(email)
Source code in hypha/apply/users/utils.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
def get_user_by_email(email):
    UserModel = get_user_model()
    qs = UserModel.objects.filter(email__iexact=email)  # case insensitive matching

    # if multiple accounts then check with case sensitive search
    if len(qs) > 1:
        qs = qs.filter(email=email)  # case sensitive matching

    if len(qs) == 0:
        return

    user = qs[0]
    return user

is_user_already_registered 

is_user_already_registered(email)

Checks if a specified user is already registered. Returns a tuple containing a boolean value that indicates if the user exists and in case he does whats the duplicated attribute

Source code in hypha/apply/users/utils.py 
30
31
32
33
34
35
36
37
38
39
40
41
def is_user_already_registered(email: str) -> (bool, str):
    """
    Checks if a specified user is already registered.
    Returns a tuple containing a boolean value that indicates if the user exists
    and in case he does whats the duplicated attribute
    """

    user_model = get_user_model()
    if user_model.objects.filter(email__iexact=email):
        return (True, _("Email is already in use."))

    return (False, "")

can_use_oauth_check 

can_use_oauth_check(user)

Checks that the user belongs to the whitelisted domains. Anonymous or non-whitelisted email domains cannot log in or associate OAuth accounts

Source code in hypha/apply/users/utils.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
def can_use_oauth_check(user):
    """
    Checks that the user belongs to the whitelisted domains.
    Anonymous or non-whitelisted email domains cannot log in
    or associate OAuth accounts
    """
    try:
        domain = user.email.split("@")[-1]
        return domain in settings.SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS
    except AttributeError:
        # Anonymous user or setting not defined
        pass
    return False

send_activation_email 

send_activation_email(user, site=None, email_template='users/activation/email.txt', email_subject_template='users/activation/email_subject.txt', redirect_url='')

Send the activation email. The activation key is the username, signed using TimestampSigner.

Source code in hypha/apply/users/utils.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
def send_activation_email(
    user,
    site=None,
    email_template="users/activation/email.txt",
    email_subject_template="users/activation/email_subject.txt",
    redirect_url="",
):
    """
    Send the activation email. The activation key is the username,
    signed using TimestampSigner.
    """
    token_generator = PasswordResetTokenGenerator()
    token = token_generator.make_token(user)

    uid = urlsafe_base64_encode(force_bytes(user.pk))

    activation_path = reverse("users:activate", kwargs={"uidb64": uid, "token": token})
    if redirect_url:
        activation_path = f"{activation_path}?next={redirect_url}"

    timeout_days = settings.PASSWORD_RESET_TIMEOUT // (24 * 3600)

    context = {
        "user": user,
        "name": user.get_full_name(),
        "username": user.get_username(),
        "activation_path": activation_path,
        "timeout_days": timeout_days,
        "org_long_name": settings.ORG_LONG_NAME,
        "org_short_name": settings.ORG_SHORT_NAME,
    }

    if site:
        context.update(site=site)

    subject = render_to_string(email_subject_template, context)
    # Force subject to a single line to avoid header-injection issues.
    subject = "".join(subject.splitlines())
    message = render_to_string(email_template, context)
    user.email_user(subject, message, settings.DEFAULT_FROM_EMAIL)

send_confirmation_email 

send_confirmation_email(user, token, updated_email=None, site=None)

Send the confirmation email. The confirmation token is the update email, signed using TimestampSigner.

Source code in hypha/apply/users/utils.py 
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
def send_confirmation_email(user, token, updated_email=None, site=None):
    """
    Send the confirmation email. The confirmation token is the update email,
    signed using TimestampSigner.
    """

    uid = urlsafe_base64_encode(force_bytes(user.pk))

    activation_path = reverse(
        "users:confirm_email", kwargs={"uidb64": uid, "token": token}
    )

    timeout_days = settings.PASSWORD_RESET_TIMEOUT // (24 * 3600)

    context = {
        "user": user,
        "name": user.get_full_name(),
        "username": user.get_username(),
        "unverified_email": updated_email,
        "activation_path": activation_path,
        "timeout_days": timeout_days,
        "org_long_name": settings.ORG_LONG_NAME,
        "org_short_name": settings.ORG_SHORT_NAME,
    }

    if site:
        context.update(site=site)

    subject = "Confirmation email for {unverified_email} at {org_long_name}".format(
        **context
    )
    # Force subject to a single line to avoid header-injection issues.
    subject = "".join(subject.splitlines())
    message = render_to_string("users/email_change/confirm_email.txt", context)
    if updated_email:
        send_mail(subject, message, settings.DEFAULT_FROM_EMAIL, [updated_email])
    else:
        user.email_user(subject, message, settings.DEFAULT_FROM_EMAIL)

get_redirect_url 

get_redirect_url(request, redirect_field, success_url_allowed_hosts=None)

Return the user-originating redirect URL if it's safe.

Parameters:

  • request (HttpRequest) –

    The request object.

  • redirect_field (str) –

    The name of a field containing the redirect URL.

  • success_url_allowed_hosts (set, default: None ) –

    A set of allowed hosts for the redirect URL.

Source code in hypha/apply/users/utils.py 
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
def get_redirect_url(
    request, redirect_field: str, success_url_allowed_hosts=None
) -> str:
    """
    Return the user-originating redirect URL if it's safe.

    Args:
        request (HttpRequest): The request object.
        redirect_field (str): The name of a field containing the redirect URL.
        success_url_allowed_hosts (set): A set of allowed hosts for the redirect URL.
    """
    # If no allowed hosts are provided, use settings.ALLOWED_HOSTS
    if success_url_allowed_hosts is None:
        success_url_allowed_hosts = set(settings.ALLOWED_HOSTS)

    # Try to get the redirect URL from the request's POST data, and if it's not
    # there, try to get it from the request's GET data. If it's not in either,
    # default to an empty string.
    redirect_to = request.POST.get(redirect_field, request.GET.get(redirect_field, ""))

    # Check if the redirect URL is safe. If it is, return it. Otherwise, return
    # an empty string.
    url_is_safe = url_has_allowed_host_and_scheme(
        url=redirect_to,
        allowed_hosts={request.get_host(), *success_url_allowed_hosts},
        require_https=request.is_secure(),
    )
    return redirect_to if url_is_safe else ""

generate_numeric_token 

generate_numeric_token(length=6)

Generate a random 6 digit string of numbers. We use this formatting to allow leading 0s.

Source code in hypha/apply/users/utils.py 
171
172
173
174
175
176
def generate_numeric_token(length=6):
    """
    Generate a random 6 digit string of numbers.
    We use this formatting to allow leading 0s.
    """
    return get_random_string(length, allowed_chars=string.digits)