o hP@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. cCtd)zT Return `True` if the request should be allowed, `False` otherwise. z#.allow_request() must be overriddenNotImplementedErrorselfrequestviewr a/var/www/html/magazine_api/magazine_env/lib/python3.10/site-packages/rest_framework/throttling.py allow_requestszBaseThrottle.allow_requestcCsv|jd}|jd}tj}|dur0|dks|dur|S|d}|t|t| }|S|r9d|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_identcCdS)zm Optionally, return a recommended number of seconds to wait before the next request. Nr r r r rwait*szBaseThrottle.waitN)__name__ __module__ __qualname____doc__rrrr r r rr s  rc@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__cCr)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 overriddenrr r r r get_cache_keyIsz SimpleRateThrottle.get_cache_keycCsPt|ddsd|jj}t|z|j|jWSty'd|j}t|w)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 rr%Rs   zSimpleRateThrottle.get_ratecCs@|durdS|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 rr&as zSimpleRateThrottle.parse_ratecCs|jdurdS||||_|jdurdS|j|jg|_||_|jrD|jd|j|jkrD|j |jrD|jd|j|jks1t |j|j krP| 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_successr r r rrms    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)r;insertr=rsetr:r(rr r rr@sz#SimpleRateThrottle.throttle_successcCr)zP Called when a request to the API has failed due to throttling. Fr rr r rr?sz#SimpleRateThrottle.throttle_failurecCsP|jr|j|j|jd}n|j}|jt|jd}|dkr"dS|t|S)zG Returns the recommended next request time in seconds. r9r1rN)r;r(r=r'rfloat)r Zremaining_durationZavailable_requestsr r rrs zSimpleRateThrottle.wait)rrr r! default_cachertimer< cache_formatr+rZDEFAULT_THROTTLE_RATESr-r)r*r%r&rr@r?rr r r rr"2s    r"c@eZdZdZdZddZdS)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$|jjrdS|j|j||dSNr+ident)useris_authenticatedrFr+rr r r rr*s zAnonRateThrottle.get_cache_keyNrrr r!r+r*r r r rrHs rHc@rG)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. rLcC.|jjr |jj}n||}|j|j|dSrIrLrMpkrrFr+r r r rKr r rr*s  zUserRateThrottle.get_cache_keyNrNr r r rrOs rOcs4eZdZdZdZddZfddZddZZS) 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 rr)szScopedRateThrottle.__init__csFt||jd|_|js dS||_||j\|_|_t ||S)NT) r$ scope_attrr+r%r#r&r'r(superrr r,r rrs  z ScopedRateThrottle.allow_requestcCrP)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. rJrQrSr r rr*s  z ScopedRateThrottle.get_cache_key) rrr r!rUr)rr* __classcell__r r rWrrTs  rT)r!rEZdjango.core.cacherrDZdjango.core.exceptionsrZrest_framework.settingsrrr"rHrOrTr r r rs   &s