U ڲg@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 overriddenNNotImplementedErrorselfrequestviewr =/tmp/pip-unpacked-wheel-11h17kvo/rest_framework/throttling.py allow_requestszBaseThrottle.allow_requestcCsv|jd}|jd}tj}|dk r`|dks6|dkr:|S|d}|t|t| }|S|rrd|S|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)r r ZxffZ 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 r r r r wait*szBaseThrottle.waitN)__name__ __module__ __qualname____doc__rrrr 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 Throttle 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\|_|_dS)Nrate)getattrget_rater! parse_rate num_requestsdurationrr 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 overriddenNrrr r r get_cache_keyIsz SimpleRateThrottle.get_cache_keycCsZt|dds d|jj}t|z|j|jWStk rTd|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)r msgr r r r#Rs  zSimpleRateThrottle.get_ratecCs@|dkr dS|d\}}t|}ddddd|d }||fS) z Given the request rate string, return a two tuple of: , N)NN/<iiQ)smhdr)rint)r r!numZperiodr%r&r r r r$as zSimpleRateThrottle.parse_ratecCs|jdkrdS||||_|jdkr*dS|j|jg|_||_|jrn|jd|j|jkrn|j qFt |j|j kr| S| S)z Implement the check to see if the request should be throttled. On success calls `throttle_success`. On failure calls `throttle_failure`. NT)r!r(keyrrhistorytimernowr&poprr%throttle_failurethrottle_successrr r r rms    z SimpleRateThrottle.allow_requestcCs*|jd|j|j|j|j|jdS)zd Inserts the current request's timestamp along with the key into the cache. rT)r9insertr;rsetr8r&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. r7r/rN)r9r&r;r%rfloat)r Zremaining_durationZavailable_requestsr r r rszSimpleRateThrottle.wait)rrrr default_cachertimer: cache_formatr)rZDEFAULT_THROTTLE_RATESr+r'r(r#r$rr>r=rr r r r r 2s    r c@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*|jr|jjrdS|j|j||dSNr)ident)useris_authenticatedrDr)rrr r r r(s zAnonRateThrottle.get_cache_keyNrrrrr)r(r r r r rEsrEc@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. rIcCs4|jr|jjr|jj}n ||}|j|j|dSrFrIrJpkrrDr)r r r rHr r r r(s  zUserRateThrottle.get_cache_keyNrKr r r r rLsrLcs4eZdZdZdZddZfddZddZZS) 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\|_|_t ||S)NT) r" scope_attrr)r#r!r$r%r&superrrr*r r rs  z ScopedRateThrottle.allow_requestcCs4|jr|jjr|jj}n ||}|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. rGrMrOr r r r(s  z ScopedRateThrottle.get_cache_key) rrrrrQr'rr( __classcell__r r rSr rPs  rP)rrCZdjango.core.cacherrBZdjango.core.exceptionsrZrest_framework.settingsrrr rErLrPr r r r s   &s