"""
Code to get ip from request.
"""
from uuid import uuid4

from edx_django_utils import ip


def real_ip(group, request):  # pylint: disable=unused-argument
    """
    Get a client IP suitable for use in rate-limiting.

    To prevent evasion of rate-limiting, use the safest (rightmost) IP in the
    external IP chain.

    (Intended to be called by ``django-ratelimit``, hence the unused argument.)
    """
    return ip.get_safest_client_ip(request)


def request_post_email(group, request) -> str:  # pylint: disable=unused-argument
    """
    Return the the email post param if it exists, otherwise return a
    random id.

    If the request doesn't have an email post body param, treat it as
    a unique key. This will probably mean that it will not get rate limited.

    This ratelimit key function is meant to be used with the user_authn/views/login.py::login_user
    function.  To rate-limit any first party auth.  For 3rd party auth, there is separate rate limiting
    currently in place so we don't do any rate limiting for that case here.
    """

    email = request.POST.get('email')
    if not email:
        email = str(uuid4())

    return email


def request_data_email(group, request) -> str:  # pylint: disable=unused-argument
    """
    Return the the email data param if it exists, otherwise return a
    random id.
    """

    email = request.data.get('email')
    if not email:
        email = str(uuid4())

    return email


def request_post_email_or_username(group, request) -> str:  # pylint: disable=unused-argument
    """
    Return the the email or email_or_username post param if it exists, otherwise return a
    random id.

    If the request doesn't have an email or email_or_username post body param, treat it as
    a unique key. This will probably mean that it will not get rate limited.

    This ratelimit key function is meant to be used with the user_authn/views/login.py::login_user
    function.  To rate-limit any first party auth.  For 3rd party auth, there is separate rate limiting
    currently in place so we don't do any rate limiting for that case here.
    """

    email_or_username = request.POST.get('email_or_username') or request.POST.get('email')
    if not email_or_username:
        email_or_username = str(uuid4())

    return email_or_username