3 Ah`L@sdZddlZddlmZddlmZddlmZGdddZ Gdd d e Z Gd d d e Z Gd d d e Z Gddde Z dS)z' Provides various throttling policies. N)cache)ImproperlyConfigured) api_settingsc@s(eZdZdZddZddZddZdS) BaseThrottlez& Rate throttling of requests. cCs tddS)zT Return `True` if the request should be allowed, `False` otherwise. z#.allow_request() must be overriddenN)NotImplementedError)selfrequestviewr H/tmp/pip-build-9m32_hle/djangorestframework/rest_framework/throttling.py allow_requestszBaseThrottle.allow_requestcCsv|jjd}|jjd}tj}|dk r`|dks6|dkr:|S|jd}|t|t| }|jS|rrdj|jS|S)z Identify the machine making the request by parsing HTTP_X_FORWARDED_FOR if present and number of proxies is > 0. If not use all of HTTP_X_FORWARDED_FOR if it is available, if not use REMOTE_ADDR. ZHTTP_X_FORWARDED_FORZ REMOTE_ADDRNr,) ZMETAgetrZ NUM_PROXIESsplitminlenstripjoin)rrZxffZ remote_addrZ num_proxiesaddrs client_addrr r r get_idents   zBaseThrottle.get_identcCsdS)zm Optionally, return a recommended number of seconds to wait before the next request. Nr )rr r r wait*szBaseThrottle.waitN)__name__ __module__ __qualname____doc__r rrr r r r r src@sheZdZdZeZejZdZdZ e j Z ddZ ddZdd Zd d Zd d ZddZddZddZdS)SimpleRateThrottlea A simple cache implementation, that only requires `.get_cache_key()` to be overridden. The rate (requests / seconds) is set by a `rate` attribute on the View class. The attribute is a string of the form 'number_of_requests/period'. Period should be one of: ('s', 'sec', 'm', 'min', 'h', 'hour', 'd', 'day') Previous request information used for throttling is stored in the cache. zthrottle_%(scope)s_%(ident)sNcCs.t|dds|j|_|j|j\|_|_dS)Nrate)getattrget_rater parse_rate num_requestsduration)rr r r __init__Ds  zSimpleRateThrottle.__init__cCs tddS)z Should return a unique cache-key which can be used for throttling. Must be overridden. May return `None` if the request should not be throttled. z#.get_cache_key() must be overriddenN)r)rrr r r r get_cache_keyIsz SimpleRateThrottle.get_cache_keyc CsXt|dds d|jj}t|y |j|jStk rRd|j}t|YnXdS)zR Determine the string representation of the allowed request rate. scopeNz9You must set either `.scope` or `.rate` for '%s' throttlez+No default throttle rate set for '%s' scope)r __class__rrTHROTTLE_RATESr&KeyError)rmsgr r r r Rs    zSimpleRateThrottle.get_ratecCs@|dkr d S|jd\}}t|}ddddd|d}||fS) z Given the request rate string, return a two tuple of: , N/<iiQ)smhdr)NN)rint)rrnumZperiodr"r#r r r r!as zSimpleRateThrottle.parse_ratecCs|jdkrdS|j|||_|jdkr*dS|jj|jg|_|j|_x*|jrp|jd|j|jkrp|jj qHWt |j|j kr|j S|j S)z Implement the check to see if the request should be throttled. On success calls `throttle_success`. On failure calls `throttle_failure`. NTr,)rr%keyrrhistorytimernowr#poprr"throttle_failurethrottle_success)rrr r r r r ms   z SimpleRateThrottle.allow_requestcCs*|jjd|j|jj|j|j|jdS)zd Inserts the current request's timestamp along with the key into the cache. rT)r6insertr8rsetr5r#)rr r r r;sz#SimpleRateThrottle.throttle_successcCsdS)zP Called when a request to the API has failed due to throttling. Fr )rr r r r:sz#SimpleRateThrottle.throttle_failurecCsP|jr|j|j|jd}n|j}|jt|jd}|dkrDdS|t|S)zG Returns the recommended next request time in seconds. r,rNr4)r6r#r8r"rfloat)rZremaining_durationZavailable_requestsr r r rszSimpleRateThrottle.wait)rrrr default_cachertimer7 cache_formatr&rZDEFAULT_THROTTLE_RATESr(r$r%r r!r r;r:rr r r r r2s    rc@seZdZdZdZddZdS)AnonRateThrottlez Limits the rate of API calls that may be made by a anonymous users. The IP address of the request will be used as the unique cache key. ZanoncCs$|jjr dS|j|j|j|dS)N)r&ident)useris_authenticatedrAr&r)rrr r r r r%s zAnonRateThrottle.get_cache_keyN)rrrrr&r%r r r r rBsrBc@seZdZdZdZddZdS)UserRateThrottlez Limits the rate of API calls that may be made by a given user. The user id will be used as a unique cache key if the user is authenticated. For anonymous requests, the IP address of the request will be used. rDcCs.|jjr|jj}n |j|}|j|j|dS)N)r&rC)rDrEpkrrAr&)rrr rCr r r r%s   zUserRateThrottle.get_cache_keyN)rrrrr&r%r r r r rFsrFcs4eZdZdZdZddZfddZddZZS) ScopedRateThrottlea, Limits the rate of API calls by different amounts for various parts of the API. Any view that has the `throttle_scope` property set will be throttled. The unique cache key will be generated by concatenating the user id of the request, and the scope of the view being accessed. Zthrottle_scopecCsdS)Nr )rr r r r$szScopedRateThrottle.__init__csFt||jd|_|jsdS|j|_|j|j\|_|_tj ||S)NT) r scope_attrr&r rr!r"r#superr )rrr )r'r r r s  z ScopedRateThrottle.allow_requestcCs.|jjr|jj}n |j|}|j|j|dS)z If `view.throttle_scope` is not set, don't apply this throttle. Otherwise generate the unique cache key by concatenating the user id with the '.throttle_scope` property of the view. )r&rC)rDrErGrrAr&)rrr rCr r r r%s   z ScopedRateThrottle.get_cache_key) rrrrrIr$r r% __classcell__r r )r'r rHs  rH)rr@Zdjango.core.cacherr?Zdjango.core.exceptionsrZrest_framework.settingsrrrrBrFrHr r r r s   &s