def open(self, spider):
self.spider = spider
self.spider.set_logger(self.logger)
self.spider.set_redis(self.redis_conn)
self.spider.setup_stats()
self.create_queues()
self.setup_zookeeper()
self.dupefilter = RFPDupeFilter(self.redis_conn,
self.spider.name + ':dupefilter',
self.rfp_timeout)
def open(self, spider):
self.spider = spider
self.queue = self.queue_cls(self.server, spider, self.queue_key)
self.df = RFPDupeFilter(self.server,
self.dupefilter_key % {'spider': spider.name},
10)
if self.idle_before_close < 0:
self.idle_before_close = 0
# notice if there are requests already in the queue to resume the crawl
if len(self.queue):
spider.log("Resuming crawl (%d requests scheduled)" %
len(self.queue))
def open(self, spider):
self.spider = spider
self.spider.set_logger(self.logger)
self.spider.set_redis(self.redis_conn)
self.spider.setup_stats()
self.create_queues()
self.setup_zookeeper()
self.dupefilter = RFPDupeFilter(self.redis_conn, self.spider.name + ":dupefilter", self.rfp_timeout)
def open(self, spider):
self.spider = spider
self.queue = self.queue_cls(self.server, spider, self.queue_key)
self.df = RFPDupeFilter(self.server, self.dupefilter_key % {'spider': spider.name},10)
if self.idle_before_close < 0:
self.idle_before_close = 0
# notice if there are requests already in the queue to resume the crawl
if len(self.queue):
spider.log("Resuming crawl (%d requests scheduled)" % len(self.queue))
class DistributedScheduler(object):
'''
Scrapy request scheduler that utilizes Redis Throttled Priority Queues
to moderate different domain scrape requests within a distributed scrapy
cluster
'''
redis_conn = None # the redis connection
queue_dict = None # the dict of throttled queues
spider = None # the spider using this scheduler
queue_keys = None # the list of current queues
queue_class = None # the class to use for the queue
dupefilter = None # the redis dupefilter
update_time = 0 # the last time the queues were updated
update_ip_time = 0 # the last time the ip was updated
update_interval = 0 # how often to update the queues
extract = None # the tld extractor
hits = 0 # default number of hits for a queue
window = 0 # default window to calculate number of hits
my_ip = None # the ip address of the scheduler (if needed)
old_ip = None # the old ip for logging
ip_update_interval = 0 # the interval to update the ip address
add_type = None # add spider type to redis throttle queue key
add_ip = None # add spider public ip to redis throttle queue key
item_retries = 0 # the number of extra tries to get an item
my_uuid = None # the generated UUID for the particular scrapy process
# Zookeeper Dynamic Config Vars
domain_config = {} # The list of domains and their configs
my_id = None # The id used to read the throttle config
config_flag = False # Flag to reload queues if settings are wiped too
assign_path = None # The base assigned configuration path to read
zoo_client = None # The KazooClient to manage the config
my_assignment = None # Zookeeper path to read actual yml config
def __init__(self, server, persist, update_int, timeout, retries, logger,
hits, window, mod, ip_refresh, add_type, add_ip, ip_regex):
'''
Initialize the scheduler
'''
self.redis_conn = server
self.persist = persist
self.queue_dict = {}
self.update_interval = update_int
self.hits = hits
self.window = window
self.moderated = mod
self.rfp_timeout = timeout
self.ip_update_interval = ip_refresh
self.add_type = add_type
self.add_ip = add_ip
self.item_retries = retries
self.logger = logger
self.ip_regex = re.compile(ip_regex)
# set up tldextract
self.extract = tldextract.TLDExtract()
self.update_ipaddress()
# if we need better uuid's mod this line
self.my_uuid = str(uuid.uuid4()).split('-')[4]
# wrapper next_request
self.next_request = next_request_method_wrapper(self)(
self.next_request)
# add test by msc
#self.banned_pages = 0
def setup_zookeeper(self):
self.assign_path = settings.get('ZOOKEEPER_ASSIGN_PATH', "")
self.my_id = settings.get('ZOOKEEPER_ID', 'all')
self.logger.debug("Trying to establish Zookeeper connection")
try:
self.zoo_watcher = ZookeeperWatcher(
hosts=settings.get('ZOOKEEPER_HOSTS'),
filepath=self.assign_path + self.my_id,
config_handler=self.change_config,
error_handler=self.error_config,
pointer=False,
ensure=True,
valid_init=True)
except KazooTimeoutError:
self.logger.error("Could not connect to Zookeeper")
sys.exit(1)
if self.zoo_watcher.ping():
self.logger.debug("Successfully set up Zookeeper connection")
else:
self.logger.error("Could not ping Zookeeper")
sys.exit(1)
def change_config(self, config_string):
if config_string and len(config_string) > 0:
loaded_config = yaml.safe_load(config_string)
self.logger.info("Zookeeper config changed", extra=loaded_config)
self.load_domain_config(loaded_config)
self.update_domain_queues()
elif config_string is None or len(config_string) == 0:
self.error_config("Zookeeper config wiped")
self.create_queues()
def load_domain_config(self, loaded_config):
'''
Loads the domain_config and sets up queue_dict
@param loaded_config: the yaml loaded config dict from zookeeper
'''
self.domain_config = {}
# vetting process to ensure correct configs
if loaded_config and 'domains' in loaded_config:
for domain in loaded_config['domains']:
item = loaded_config['domains'][domain]
# check valid
if 'window' in item and 'hits' in item:
self.logger.debug(
"Added domain {dom} to loaded config".format(
dom=domain))
self.domain_config[domain] = item
self.config_flag = True
def update_domain_queues(self):
'''
Check to update existing queues already in memory
new queues are created elsewhere
'''
for key in self.domain_config:
final_key = "{name}:{domain}:queue".format(name=self.spider.name,
domain=key)
# we already have a throttled queue for this domain, update it to new settings
if final_key in self.queue_dict:
self.queue_dict[final_key].window = float(
self.domain_config[key]['window'])
self.logger.debug(
"Updated queue {q} with new config".format(q=final_key))
# if scale is applied, scale back; otherwise use updated hits
if 'scale' in self.domain_config[key]:
# round to int
hits = int(
self.domain_config[key]['hits'] *
self.fit_scale(self.domain_config[key]['scale']))
self.queue_dict[final_key].limit = float(hits)
else:
self.queue_dict[final_key].limit = float(
self.domain_config[key]['hits'])
def error_config(self, message):
extras = {}
extras['message'] = message
extras['revert_window'] = self.window
extras['revert_hits'] = self.hits
extras['spiderid'] = self.spider.name
self.logger.info("Lost config from Zookeeper", extra=extras)
# lost connection to zookeeper, reverting back to defaults
for key in self.domain_config:
final_key = "{name}:{domain}:queue".format(name=self.spider.name,
domain=key)
self.queue_dict[final_key].window = self.window
self.queue_dict[final_key].limit = self.hits
self.domain_config = {}
def fit_scale(self, scale):
'''
@return: a scale >= 0 and <= 1
'''
if scale >= 1:
return 1.0
elif scale <= 0:
return 0.0
else:
return scale
def create_queues(self):
'''
Updates the in memory list of the redis queues
Creates new throttled queue instances if it does not have them
'''
# new config could have loaded between scrapes
newConf = self.check_config()
self.queue_keys = self.redis_conn.keys(self.spider.name + ":*:queue")
for key in self.queue_keys:
# build final queue key, depending on type and ip bools
throttle_key = ""
if self.add_type:
throttle_key = self.spider.name + ":"
if self.add_ip:
throttle_key = throttle_key + self.my_ip + ":"
# add the tld from the key `type:tld:queue`
the_domain = re.split(':', key)[1]
throttle_key = throttle_key + the_domain
if key not in self.queue_dict or newConf:
self.logger.debug(
"Added new Throttled Queue {q}".format(q=key))
q = RedisPriorityQueue(self.redis_conn, key)
# use default window and hits
if the_domain not in self.domain_config:
self.queue_dict[key] = RedisThrottledQueue(
self.redis_conn, q, self.window, self.hits,
self.moderated, throttle_key, throttle_key)
# use custom window and hits
else:
window = self.domain_config[the_domain]['window']
hits = self.domain_config[the_domain]['hits']
# adjust the crawl rate based on the scale if exists
if 'scale' in self.domain_config[the_domain]:
hits = int(hits * self.fit_scale(
self.domain_config[the_domain]['scale']))
self.queue_dict[key] = RedisThrottledQueue(
self.redis_conn, q, window, hits, self.moderated,
throttle_key, throttle_key)
def check_config(self):
'''
Controls configuration for the scheduler
@return: True if there is a new configuration
'''
if self.config_flag:
self.config_flag = False
return True
return False
def update_ipaddress(self):
'''
Updates the scheduler so it knows its own ip address
'''
# assign local ip in case of exception
self.old_ip = self.my_ip
self.my_ip = get_raspberrypi_ip_address()
try:
obj = urllib2.urlopen(
settings.get('PUBLIC_IP_URL', 'http://ip.42.pl/raw'))
results = self.ip_regex.findall(obj.read())
if len(results) > 0:
self.my_ip = results[0]
else:
raise IOError("Could not get valid IP Address")
obj.close()
self.logger.debug("Current public ip: {ip}".format(ip=self.my_ip))
except IOError:
self.logger.error("Could not reach out to get public ip")
pass
if self.old_ip != self.my_ip:
self.logger.info("Changed Public IP: {old} -> {new}".format(
old=self.old_ip, new=self.my_ip))
def report_self(self):
'''
Reports the crawler uuid to redis
'''
self.logger.debug("Reporting self id", extra={'uuid': self.my_uuid})
key = "stats:crawler:{m}:{s}:{u}".format(m=socket.gethostname(),
s=self.spider.name,
u=self.my_uuid)
self.redis_conn.set(key, time.time())
self.redis_conn.expire(key, self.ip_update_interval * 2)
@classmethod
def from_settings(cls, settings, spidername):
server = redis.Redis(host=settings.get('REDIS_HOST'),
port=settings.get('REDIS_PORT'))
persist = settings.get('SCHEDULER_PERSIST', True)
up_int = settings.get('SCHEDULER_QUEUE_REFRESH', 10)
hits = settings.get('QUEUE_HITS', 10)
window = settings.get('QUEUE_WINDOW', 60)
mod = settings.get('QUEUE_MODERATED', False)
timeout = settings.get('DUPEFILTER_TIMEOUT', 600)
ip_refresh = settings.get('SCHEDULER_IP_REFRESH', 60)
add_type = settings.get('SCHEDULER_TYPE_ENABLED', False)
add_ip = settings.get('SCHEDULER_IP_ENABLED', False)
retries = settings.get('SCHEUDLER_ITEM_RETRIES', 3)
ip_regex = settings.get('IP_ADDR_REGEX', '.*')
my_level = settings.get('SC_LOG_LEVEL', 'DEBUG')
my_name = "%s_%s" % (spidername, get_raspberrypi_ip_address())
my_output = settings.get('SC_LOG_STDOUT', False)
my_json = settings.get('SC_LOG_JSON', True)
my_dir = settings.get('SC_LOG_DIR', 'logs')
my_bytes = settings.get('SC_LOG_MAX_BYTES', '10MB')
my_file = "%s_%s.log" % (spidername, get_raspberrypi_ip_address())
my_backups = settings.get('SC_LOG_BACKUPS', 5)
logger = CustomLogFactory.get_instance(json=my_json,
name=my_name,
stdout=my_output,
level=my_level,
dir=my_dir,
file=my_file,
bytes=my_bytes,
backups=my_backups)
return cls(server, persist, up_int, timeout, retries, logger, hits,
window, mod, ip_refresh, add_type, add_ip, ip_regex)
@classmethod
def from_crawler(cls, crawler):
return cls.from_settings(crawler.settings, crawler.spider.name)
def open(self, spider):
self.spider = spider
self.spider.set_logger(self.logger)
self.spider.set_redis(self.redis_conn)
self.spider.setup_stats()
self.create_queues()
self.setup_zookeeper()
self.dupefilter = RFPDupeFilter(self.redis_conn,
self.spider.name + ':dupefilter',
self.rfp_timeout)
# add by msc
# if self.spider.name == "amazon":
# self.count_per_minute = RedisDict(self.redis_conn, None, "%s_%s:count_per_minute"%(self.spider.name, self.spider.worker_id))
def close(self, reason):
self.logger.info("Closing Spider", {'spiderid': self.spider.name})
if not self.persist:
self.logger.warning("Clearing crawl queues")
self.dupefilter.clear()
for key in self.queue_keys:
self.queue_dict[key].clear()
def is_blacklisted(self, appid, crawlid):
'''
Checks the redis blacklist for crawls that should not be propagated
either from expiring or stopped
@return: True if the appid crawlid combo is blacklisted
'''
# key_check = '{appid}||{crawlid}'.format(appid=appid,
# crawlid=crawlid)
# redis_key = self.spider.name + ":blacklist"
# return self.redis_conn.sismember(redis_key, key_check)
# dont use the blacklist
return False
def enqueue_request(self, request):
'''
Pushes a request from the spider into the proper throttled queue
'''
if not request.dont_filter and self.dupefilter.request_seen(request):
self.logger.debug("Request not added back to redis")
return
req_dict = self.request_to_dict(request)
if not self.is_blacklisted(req_dict['meta']['appid'],
req_dict['meta']['crawlid']):
# grab the tld of the request
ex_res = self.extract(req_dict['url'])
key = "{sid}:{dom}.{suf}:queue".format(
sid=req_dict['meta']['spiderid'],
dom=ex_res.domain,
suf=ex_res.suffix)
curr_time = time.time()
# insert if crawl never expires (0) or time < expires
if req_dict['meta']['expires'] == 0 or \
curr_time < req_dict['meta']['expires']:
# we may already have the queue in memory
if key in self.queue_keys:
self.queue_dict[key].push(req_dict,
req_dict['meta']['priority'])
else:
# shoving into a new redis queue, negative b/c of sorted sets
# this will populate ourself and other schedulers when
# they call create_queues
self.redis_conn.zadd(key,
pickle.dumps(req_dict, protocol=-1),
-req_dict['meta']['priority'])
self.logger.debug(
"Crawlid: '{id}' Appid: '{appid}' Url: '{url}' added to queue"
.format(appid=req_dict['meta']['appid'],
id=req_dict['meta']['crawlid'],
url=req_dict['meta']['url']))
else:
self.logger.debug(
"Crawlid: '{id}' Appid: '{appid}' expired".format(
appid=req_dict['meta']['appid'],
id=req_dict['meta']['crawlid']))
else:
self.logger.debug(
"Crawlid: '{id}' Appid: '{appid}' blacklisted".format(
appid=req_dict['meta']['appid'],
id=req_dict['meta']['crawlid']))
def request_to_dict(self, request):
'''
Convert Request object to a dict.
modified from scrapy.utils.reqser
'''
req_dict = {
# urls should be safe (safe_string_url)
'url':
request.url.decode('ascii'),
'method':
request.method,
'headers':
dict(request.headers),
'body':
request.body,
'cookies':
request.cookies,
'meta':
request.meta,
'_encoding':
request._encoding,
'priority':
request.priority,
'dont_filter':
request.dont_filter,
# callback/errback are assumed to be a bound instance of the spider
'callback':
None if request.callback is None else request.callback.func_name,
'errback':
None if request.errback is None else request.errback.func_name,
}
return req_dict
def find_item(self):
'''
Finds an item from the throttled queues
'''
random.shuffle(self.queue_keys)
count = 0
while count <= self.item_retries:
for key in self.queue_keys:
# the throttled queue only returns an item if it is allowed
item = self.queue_dict[key].pop()
self.present_item = item
#self.spider.log('key: %s ' % key)
msgvalue = {
'queuename': key,
'lenthofqueue': (int(len(self.queue_dict[key])) or 0)
}
msg = "lenth of queue %s" % key
self.logger.info('key: %s ' % key)
self.logger.info('len(self.queue_dict[key]): %s ' %
len(self.queue_dict[key]))
self.logger.info(msg, msgvalue)
if item:
return item
# we want the spiders to get slightly out of sync
# with each other for better performance
time.sleep(random.random())
count = count + 1
return None
def next_request(self):
'''
Logic to handle getting a new url request, from a bunch of
different queues
'''
t = time.time()
# update the redis queues every so often
if t - self.update_time > self.update_interval:
self.update_time = t
self.create_queues()
item = self.find_item()
if item:
self.logger.info(
'distributed_scheduler.py::DistributedScheduler::next_request call find_item() result is : %s'
% (item["meta"]["url"] if 'meta' in item else item["url"]))
self.logger.debug("Found url to crawl {url}" \
.format(url=item['url']))
try:
req = Request(item['url'])
except ValueError:
# need absolute url
# need better url validation here
req = Request('http://' + item['url'])
if 'callback' in item:
cb = item['callback']
if cb and self.spider:
cb = get_method(self.spider, cb)
req.callback = cb
if 'errback' in item:
eb = item['errback']
if eb and self.spider:
eb = get_method(self.spider, eb)
req.errback = eb
if 'meta' in item:
item = item['meta']
# defaults not in schema
if 'curdepth' not in item:
item['curdepth'] = 0
if "retry_times" not in item:
item['retry_times'] = 0
for key in item.keys():
req.meta[key] = item[key]
# extra check to add items to request
if 'useragent' in item and item['useragent'] is not None:
req.headers['User-Agent'] = item['useragent']
if 'cookie' in item and item['cookie'] is not None:
if isinstance(item['cookie'], dict):
req.cookies = item['cookie']
elif isinstance(item['cookie'], basestring):
req.cookies = self.parse_cookie(item['cookie'])
return req
return None
def parse_cookie(self, string):
'''
Parses a cookie string like returned in a Set-Cookie header
@param string: The cookie string
@return: the cookie dict
'''
results = re.findall('([^=]+)=([^\;]+);?\s?', string)
my_dict = {}
for item in results:
my_dict[item[0]] = item[1]
return my_dict
def has_pending_requests(self):
'''
We never want to say we have pending requests
If this returns True scrapy sometimes hangs.
'''
return False
def open(self, spider):
self.spider = spider
self.setup()
self.dupefilter = RFPDupeFilter(self.redis_conn,
self.spider.name + ':dupefilter', self.rfp_timeout)
class DistributedScheduler(object):
'''
Scrapy request scheduler that utilizes Priority Queues
to moderate scrape requests within a distributed scrapy
cluster
'''
redis_conn = None # the redis connection
queue = None # the queue to use for crawling
spider = None # the spider using this scheduler
queue_class = None # the class to use for the queue
dupefilter = None # the redis dupefilter
item_retries = 0 # the number of extra tries to get an item
def __init__(self, server, persist, timeout, retries):
'''
Initialize the scheduler
'''
self.redis_conn = server
self.persist = persist
self.rfp_timeout = timeout
self.item_retires = retries
def setup(self):
'''
Used to initialize things when using mock
spider.name is not set yet
'''
self.queue = RedisPriorityQueue(self.redis_conn,
self.spider.name + ":queue")
@classmethod
def from_settings(cls, settings):
server = redis.Redis(host=settings.get('REDIS_HOST'),
port=settings.get('REDIS_PORT'))
persist = settings.get('SCHEDULER_PERSIST', True)
timeout = settings.get('DUPEFILTER_TIMEOUT', 600)
retries = settings.get('SCHEDULER_ITEM_RETRIES', 3)
return cls(server, persist, timeout, retries)
@classmethod
def from_crawler(cls, crawler):
return cls.from_settings(crawler.settings)
def open(self, spider):
self.spider = spider
self.setup()
self.dupefilter = RFPDupeFilter(self.redis_conn,
self.spider.name + ':dupefilter', self.rfp_timeout)
def close(self, reason):
if not self.persist:
self.dupefilter.clear()
self.queue.clear()
def is_blacklisted(self, appid, crawlid):
'''
Checks the redis blacklist for crawls that should not be propagated
either from expiring or stopped
@return: True if the appid crawlid combo is blacklisted
'''
key_check = '{appid}||{crawlid}'.format(appid=appid,
crawlid=crawlid)
redis_key = self.spider.name + ":blacklist"
return self.redis_conn.sismember(redis_key, key_check)
def enqueue_request(self, request):
'''
Pushes a request from the spider back into the queue
'''
if not request.dont_filter and self.dupefilter.request_seen(request):
return
req_dict = self.request_to_dict(request)
if not self.is_blacklisted(req_dict['meta']['appid'],
req_dict['meta']['crawlid']):
key = "{sid}:queue".format(sid=req_dict['meta']['spiderid'])
curr_time = time.time()
# insert if crawl never expires (0) or time < expires
if req_dict['meta']['expires'] == 0 or \
curr_time < req_dict['meta']['expires']:
self.queue.push(req_dict, req_dict['meta']['priority'])
def request_to_dict(self, request):
'''
Convert Request object to a dict.
modified from scrapy.utils.reqser
'''
req_dict = {
# urls should be safe (safe_string_url)
'url': request.url.decode('ascii'),
'method': request.method,
'headers': dict(request.headers),
'body': request.body,
'cookies': request.cookies,
'meta': request.meta,
'_encoding': request._encoding,
'priority': request.priority,
'dont_filter': request.dont_filter,
}
return req_dict
def find_item(self):
'''
Finds an item from the queue
'''
count = 0
while count <= self.item_retries:
item = self.queue.pop()
if item:
# very basic limiter
time.sleep(1)
return item
# we want the spiders to get slightly out of sync
# with each other for better performance
time.sleep(random.random())
count = count + 1
return None
def next_request(self):
'''
Logic to handle getting a new url request
'''
t = time.time()
item = self.find_item()
if item:
try:
req = Request(item['url'])
except ValueError:
# need absolute url
# need better url validation here
req = Request('http://' + item['url'])
if 'meta' in item:
item = item['meta']
# defaults
if "attrs" not in item:
item["attrs"] = {}
if "allowed_domains" not in item:
item["allowed_domains"] = ()
if "allow_regex" not in item:
item["allow_regex"] = ()
if "deny_regex" not in item:
item["deny_regex"] = ()
if "deny_extensions" not in item:
item["deny_extensions"] = None
if 'curdepth' not in item:
item['curdepth'] = 0
if "maxdepth" not in item:
item["maxdepth"] = 0
if "priority" not in item:
item['priority'] = 0
if "retry_times" not in item:
item['retry_times'] = 0
if "expires" not in item:
item['expires'] = 0
if "proxy" not in item:
item['proxy'] = ()
if "cookiejar" not in item:
item['cookiejar'] = None
for key in ('attrs', 'allowed_domains', 'curdepth', 'maxdepth',
'appid', 'crawlid', 'spiderid', 'priority', 'retry_times',
'expires', 'allow_regex', 'deny_regex', 'deny_extensions','proxy'):
req.meta[key] = item[key]
return req
return None
def has_pending_requests(self):
'''
We never want to say we have pending requests
If this returns True scrapy sometimes hangs.
'''
return False
class RedisScheduler(object):
"""Redis-based scheduler"""
def __init__(self, server, persist, queue_key, queue_cls, dupefilter_key, idle_before_close):
"""Initialize scheduler.
Parameters
----------
server : Redis instance
persist : bool
queue_key : str
queue_cls : queue class
dupefilter_key : str
idle_before_close : int
"""
self.server = server
self.persist = persist
self.queue_key = queue_key
self.queue_cls = queue_cls
self.dupefilter_key = dupefilter_key
self.idle_before_close = idle_before_close
self.stats = None
def __len__(self):
return len(self.queue)
@classmethod
def from_settings(cls, settings):
persist = settings.get('SCHEDULER_PERSIST', SCHEDULER_PERSIST)
queue_key = settings.get('SCHEDULER_QUEUE_KEY', QUEUE_KEY)
queue_cls = load_object(settings.get('SCHEDULER_QUEUE_CLASS', QUEUE_CLASS))
dupefilter_key = settings.get('DUPEFILTER_KEY', DUPEFILTER_KEY)
idle_before_close = settings.get('SCHEDULER_IDLE_BEFORE_CLOSE', IDLE_BEFORE_CLOSE)
server = redis.Redis('120.25.216.93','6379')
return cls(server, persist, queue_key, queue_cls, dupefilter_key, idle_before_close)
@classmethod
def from_crawler(cls, crawler):
instance = cls.from_settings(crawler.settings)
# FIXME: for now, stats are only supported from this constructor
instance.stats = crawler.stats
return instance
def open(self, spider):
self.spider = spider
self.queue = self.queue_cls(self.server, spider, self.queue_key)
self.df = RFPDupeFilter(self.server, self.dupefilter_key % {'spider': spider.name},10)
if self.idle_before_close < 0:
self.idle_before_close = 0
# notice if there are requests already in the queue to resume the crawl
if len(self.queue):
spider.log("Resuming crawl (%d requests scheduled)" % len(self.queue))
def close(self, reason):
if not self.persist:
self.df.clear()
self.queue.clear()
def enqueue_request(self, request):
if not request.dont_filter and self.df.request_seen(request):
return
if self.stats:
self.stats.inc_value('scheduler/enqueued/redis', spider=self.spider)
self.queue.push(request)
def next_request(self):
block_pop_timeout = self.idle_before_close
request = self.queue.pop(block_pop_timeout)
if request and self.stats:
self.stats.inc_value('scheduler/dequeued/redis', spider=self.spider)
return request
def has_pending_requests(self):
return len(self) > 0
class DistributedScheduler(object):
'''
Scrapy request scheduler that utilizes Redis Throttled Priority Queues
to moderate different domain scrape requests within a distributed scrapy
cluster
'''
redis_conn = None # the redis connection
queue_dict = None # the dict of throttled queues
spider = None # the spider using this scheduler
queue_keys = None # the list of current queues
queue_class = None # the class to use for the queue
dupefilter = None # the redis dupefilter
update_time = 0 # the last time the queues were updated
update_ip_time = 0 # the last time the ip was updated
update_interval = 0 # how often to update the queues
extract = None # the tld extractor
hits = 0 # default number of hits for a queue
window = 0 # default window to calculate number of hits
my_ip = None # the ip address of the scheduler (if needed)
old_ip = None # the old ip for logging
ip_update_interval = 0 # the interval to update the ip address
add_type = None # add spider type to redis throttle queue key
add_ip = None # add spider public ip to redis throttle queue key
item_retries = 0 # the number of extra tries to get an item
my_uuid = None # the generated UUID for the particular scrapy process
# Zookeeper Dynamic Config Vars
domain_config = {} # The list of domains and their configs
my_id = None # The id used to read the throttle config
config_flag = False # Flag to reload queues if settings are wiped too
assign_path = None # The base assigned configuration path to read
zoo_client = None # The KazooClient to manage the config
my_assignment = None # Zookeeper path to read actual yml config
def __init__(self, server, persist, update_int, timeout, retries, logger,
hits, window, mod, ip_refresh, add_type, add_ip, ip_regex):
'''
Initialize the scheduler
'''
self.redis_conn = server
self.persist = persist
self.queue_dict = {}
self.update_interval = update_int
self.hits = hits
self.window = window
self.moderated = mod
self.rfp_timeout = timeout
self.ip_update_interval = ip_refresh
self.add_type = add_type
self.add_ip = add_ip
self.item_retries = retries
self.logger = logger
self.ip_regex = re.compile(ip_regex)
# set up tldextract
self.extract = tldextract.TLDExtract()
self.update_ipaddress()
# if we need better uuid's mod this line
self.my_uuid = str(uuid.uuid4()).split('-')[4]
# wrapper next_request
self.next_request = next_request_method_wrapper(self)(self.next_request)
# add test by msc
#self.banned_pages = 0
def setup_zookeeper(self):
self.assign_path = settings.get('ZOOKEEPER_ASSIGN_PATH', "")
self.my_id = settings.get('ZOOKEEPER_ID', 'all')
self.logger.debug("Trying to establish Zookeeper connection")
try:
self.zoo_watcher = ZookeeperWatcher(
hosts=settings.get('ZOOKEEPER_HOSTS'),
filepath=self.assign_path + self.my_id,
config_handler=self.change_config,
error_handler=self.error_config,
pointer=False, ensure=True, valid_init=True)
except KazooTimeoutError:
self.logger.error("Could not connect to Zookeeper")
sys.exit(1)
if self.zoo_watcher.ping():
self.logger.debug("Successfully set up Zookeeper connection")
else:
self.logger.error("Could not ping Zookeeper")
sys.exit(1)
def change_config(self, config_string):
if config_string and len(config_string) > 0:
loaded_config = yaml.safe_load(config_string)
self.logger.info("Zookeeper config changed", extra=loaded_config)
self.load_domain_config(loaded_config)
self.update_domain_queues()
elif config_string is None or len(config_string) == 0:
self.error_config("Zookeeper config wiped")
self.create_queues()
def load_domain_config(self, loaded_config):
'''
Loads the domain_config and sets up queue_dict
@param loaded_config: the yaml loaded config dict from zookeeper
'''
self.domain_config = {}
# vetting process to ensure correct configs
if loaded_config and 'domains' in loaded_config:
for domain in loaded_config['domains']:
item = loaded_config['domains'][domain]
# check valid
if 'window' in item and 'hits' in item:
self.logger.debug("Added domain {dom} to loaded config"
.format(dom=domain))
self.domain_config[domain] = item
self.config_flag = True
def update_domain_queues(self):
'''
Check to update existing queues already in memory
new queues are created elsewhere
'''
for key in self.domain_config:
final_key = "{name}:{domain}:queue".format(
name=self.spider.name,
domain=key)
# we already have a throttled queue for this domain, update it to new settings
if final_key in self.queue_dict:
self.queue_dict[final_key].window = float(self.domain_config[key]['window'])
self.logger.debug("Updated queue {q} with new config"
.format(q=final_key))
# if scale is applied, scale back; otherwise use updated hits
if 'scale' in self.domain_config[key]:
# round to int
hits = int(self.domain_config[key]['hits'] * self.fit_scale(
self.domain_config[key]['scale']))
self.queue_dict[final_key].limit = float(hits)
else:
self.queue_dict[final_key].limit = float(self.domain_config[key]['hits'])
def error_config(self, message):
extras = {}
extras['message'] = message
extras['revert_window'] = self.window
extras['revert_hits'] = self.hits
extras['spiderid'] = self.spider.name
self.logger.info("Lost config from Zookeeper", extra=extras)
# lost connection to zookeeper, reverting back to defaults
for key in self.domain_config:
final_key = "{name}:{domain}:queue".format(
name=self.spider.name,
domain=key)
self.queue_dict[final_key].window = self.window
self.queue_dict[final_key].limit = self.hits
self.domain_config = {}
def fit_scale(self, scale):
'''
@return: a scale >= 0 and <= 1
'''
if scale >= 1:
return 1.0
elif scale <= 0:
return 0.0
else:
return scale
def create_queues(self):
'''
Updates the in memory list of the redis queues
Creates new throttled queue instances if it does not have them
'''
# new config could have loaded between scrapes
newConf = self.check_config()
self.queue_keys = self.redis_conn.keys(self.spider.name + ":*:queue")
for key in self.queue_keys:
# build final queue key, depending on type and ip bools
throttle_key = ""
if self.add_type:
throttle_key = self.spider.name + ":"
if self.add_ip:
throttle_key = throttle_key + self.my_ip + ":"
# add the tld from the key `type:tld:queue`
the_domain = re.split(':', key)[1]
throttle_key = throttle_key + the_domain
if key not in self.queue_dict or newConf:
self.logger.debug("Added new Throttled Queue {q}"
.format(q=key))
q = RedisPriorityQueue(self.redis_conn, key)
# use default window and hits
if the_domain not in self.domain_config:
self.queue_dict[key] = RedisThrottledQueue(self.redis_conn,
q, self.window, self.hits, self.moderated, throttle_key,
throttle_key)
# use custom window and hits
else:
window = self.domain_config[the_domain]['window']
hits = self.domain_config[the_domain]['hits']
# adjust the crawl rate based on the scale if exists
if 'scale' in self.domain_config[the_domain]:
hits = int(hits * self.fit_scale(self.domain_config[the_domain]['scale']))
self.queue_dict[key] = RedisThrottledQueue(self.redis_conn,
q, window, hits, self.moderated, throttle_key,
throttle_key)
def check_config(self):
'''
Controls configuration for the scheduler
@return: True if there is a new configuration
'''
if self.config_flag:
self.config_flag = False
return True
return False
def update_ipaddress(self):
'''
Updates the scheduler so it knows its own ip address
'''
# assign local ip in case of exception
self.old_ip = self.my_ip
self.my_ip = get_raspberrypi_ip_address()
try:
obj = urllib2.urlopen(settings.get('PUBLIC_IP_URL',
'http://ip.42.pl/raw'))
results = self.ip_regex.findall(obj.read())
if len(results) > 0:
self.my_ip = results[0]
else:
raise IOError("Could not get valid IP Address")
obj.close()
self.logger.debug("Current public ip: {ip}".format(ip=self.my_ip))
except IOError:
self.logger.error("Could not reach out to get public ip")
pass
if self.old_ip != self.my_ip:
self.logger.info("Changed Public IP: {old} -> {new}".format(
old=self.old_ip, new=self.my_ip))
def report_self(self):
'''
Reports the crawler uuid to redis
'''
self.logger.debug("Reporting self id", extra={'uuid':self.my_uuid})
key = "stats:crawler:{m}:{s}:{u}".format(
m=socket.gethostname(),
s=self.spider.name,
u=self.my_uuid)
self.redis_conn.set(key, time.time())
self.redis_conn.expire(key, self.ip_update_interval * 2)
@classmethod
def from_settings(cls, settings, spidername):
server = redis.Redis(host=settings.get('REDIS_HOST'),
port=settings.get('REDIS_PORT'))
persist = settings.get('SCHEDULER_PERSIST', True)
up_int = settings.get('SCHEDULER_QUEUE_REFRESH', 10)
hits = settings.get('QUEUE_HITS', 10)
window = settings.get('QUEUE_WINDOW', 60)
mod = settings.get('QUEUE_MODERATED', False)
timeout = settings.get('DUPEFILTER_TIMEOUT', 600)
ip_refresh = settings.get('SCHEDULER_IP_REFRESH', 60)
add_type = settings.get('SCHEDULER_TYPE_ENABLED', False)
add_ip = settings.get('SCHEDULER_IP_ENABLED', False)
retries = settings.get('SCHEUDLER_ITEM_RETRIES', 3)
ip_regex = settings.get('IP_ADDR_REGEX', '.*')
my_level = settings.get('SC_LOG_LEVEL', 'DEBUG')
my_name = "%s_%s"%(spidername, get_raspberrypi_ip_address())
my_output = settings.get('SC_LOG_STDOUT', False)
my_json = settings.get('SC_LOG_JSON', True)
my_dir = settings.get('SC_LOG_DIR', 'logs')
my_bytes = settings.get('SC_LOG_MAX_BYTES', '10MB')
my_file = "%s_%s.log"%(spidername, get_raspberrypi_ip_address())
my_backups = settings.get('SC_LOG_BACKUPS', 5)
logger = CustomLogFactory.get_instance(json=my_json,
name=my_name,
stdout=my_output,
level=my_level,
dir=my_dir,
file=my_file,
bytes=my_bytes,
backups=my_backups)
return cls(server, persist, up_int, timeout, retries, logger, hits,
window, mod, ip_refresh, add_type, add_ip, ip_regex)
@classmethod
def from_crawler(cls, crawler):
return cls.from_settings(crawler.settings, crawler.spider.name)
def open(self, spider):
self.spider = spider
self.spider.set_logger(self.logger)
self.spider.set_redis(self.redis_conn)
self.spider.setup_stats()
self.create_queues()
self.setup_zookeeper()
self.dupefilter = RFPDupeFilter(self.redis_conn,
self.spider.name + ':dupefilter',
self.rfp_timeout)
# add by msc
# if self.spider.name == "amazon":
# self.count_per_minute = RedisDict(self.redis_conn, None, "%s_%s:count_per_minute"%(self.spider.name, self.spider.worker_id))
def close(self, reason):
self.logger.info("Closing Spider", {'spiderid':self.spider.name})
if not self.persist:
self.logger.warning("Clearing crawl queues")
self.dupefilter.clear()
for key in self.queue_keys:
self.queue_dict[key].clear()
def is_blacklisted(self, appid, crawlid):
'''
Checks the redis blacklist for crawls that should not be propagated
either from expiring or stopped
@return: True if the appid crawlid combo is blacklisted
'''
# key_check = '{appid}||{crawlid}'.format(appid=appid,
# crawlid=crawlid)
# redis_key = self.spider.name + ":blacklist"
# return self.redis_conn.sismember(redis_key, key_check)
# dont use the blacklist
return False
def enqueue_request(self, request):
'''
Pushes a request from the spider into the proper throttled queue
'''
if not request.dont_filter and self.dupefilter.request_seen(request):
self.logger.debug("Request not added back to redis")
return
req_dict = self.request_to_dict(request)
if not self.is_blacklisted(req_dict['meta']['appid'],
req_dict['meta']['crawlid']):
# grab the tld of the request
ex_res = self.extract(req_dict['url'])
key = "{sid}:{dom}.{suf}:queue".format(
sid=req_dict['meta']['spiderid'],
dom=ex_res.domain,
suf=ex_res.suffix)
curr_time = time.time()
# insert if crawl never expires (0) or time < expires
if req_dict['meta']['expires'] == 0 or \
curr_time < req_dict['meta']['expires']:
# we may already have the queue in memory
if key in self.queue_keys:
self.queue_dict[key].push(req_dict,
req_dict['meta']['priority'])
else:
# shoving into a new redis queue, negative b/c of sorted sets
# this will populate ourself and other schedulers when
# they call create_queues
self.redis_conn.zadd(key, pickle.dumps(req_dict, protocol=-1),
-req_dict['meta']['priority'])
self.logger.debug("Crawlid: '{id}' Appid: '{appid}' Url: '{url}' added to queue"
.format(appid=req_dict['meta']['appid'],
id=req_dict['meta']['crawlid'],
url=req_dict['meta']['url']))
else:
self.logger.debug("Crawlid: '{id}' Appid: '{appid}' expired"
.format(appid=req_dict['meta']['appid'],
id=req_dict['meta']['crawlid']))
else:
self.logger.debug("Crawlid: '{id}' Appid: '{appid}' blacklisted"
.format(appid=req_dict['meta']['appid'],
id=req_dict['meta']['crawlid']))
def request_to_dict(self, request):
'''
Convert Request object to a dict.
modified from scrapy.utils.reqser
'''
req_dict = {
# urls should be safe (safe_string_url)
'url': request.url.decode('ascii'),
'method': request.method,
'headers': dict(request.headers),
'body': request.body,
'cookies': request.cookies,
'meta': request.meta,
'_encoding': request._encoding,
'priority': request.priority,
'dont_filter': request.dont_filter,
# callback/errback are assumed to be a bound instance of the spider
'callback': None if request.callback is None else request.callback.func_name,
'errback': None if request.errback is None else request.errback.func_name,
}
return req_dict
def find_item(self):
'''
Finds an item from the throttled queues
'''
random.shuffle(self.queue_keys)
count = 0
while count <= self.item_retries:
for key in self.queue_keys:
# the throttled queue only returns an item if it is allowed
item = self.queue_dict[key].pop()
self.present_item = item
#self.spider.log('key: %s ' % key)
msgvalue = {'queuename':key,'lenthofqueue':(int(len(self.queue_dict[key])) or 0)}
msg = "lenth of queue %s" % key
self.logger.info('key: %s ' % key)
self.logger.info('len(self.queue_dict[key]): %s ' % len(self.queue_dict[key]))
self.logger.info(msg,msgvalue)
if item:
return item
# we want the spiders to get slightly out of sync
# with each other for better performance
time.sleep(random.random())
count = count + 1
return None
def next_request(self):
'''
Logic to handle getting a new url request, from a bunch of
different queues
'''
t = time.time()
# update the redis queues every so often
if t - self.update_time > self.update_interval:
self.update_time = t
self.create_queues()
item = self.find_item()
if item:
self.logger.info(
'distributed_scheduler.py::DistributedScheduler::next_request call find_item() result is : %s' % (
item["meta"]["url"] if 'meta' in item else item["url"]))
self.logger.debug("Found url to crawl {url}" \
.format(url=item['url']))
try:
req = Request(item['url'])
except ValueError:
# need absolute url
# need better url validation here
req = Request('http://' + item['url'])
if 'callback' in item:
cb = item['callback']
if cb and self.spider:
cb = get_method(self.spider, cb)
req.callback = cb
if 'errback' in item:
eb = item['errback']
if eb and self.spider:
eb = get_method(self.spider, eb)
req.errback = eb
if 'meta' in item:
item = item['meta']
# defaults not in schema
if 'curdepth' not in item:
item['curdepth'] = 0
if "retry_times" not in item:
item['retry_times'] = 0
for key in item.keys():
req.meta[key] = item[key]
# extra check to add items to request
if 'useragent' in item and item['useragent'] is not None:
req.headers['User-Agent'] = item['useragent']
if 'cookie' in item and item['cookie'] is not None:
if isinstance(item['cookie'], dict):
req.cookies = item['cookie']
elif isinstance(item['cookie'], basestring):
req.cookies = self.parse_cookie(item['cookie'])
return req
return None
def parse_cookie(self, string):
'''
Parses a cookie string like returned in a Set-Cookie header
@param string: The cookie string
@return: the cookie dict
'''
results = re.findall('([^=]+)=([^\;]+);?\s?', string)
my_dict = {}
for item in results:
my_dict[item[0]] = item[1]
return my_dict
def has_pending_requests(self):
'''
We never want to say we have pending requests
If this returns True scrapy sometimes hangs.
'''
return False
def open(self, spider):
self.spider = spider
self.setup()
self.dupefilter = RFPDupeFilter(self.redis_conn,
self.spider.name + ':dupefilter',
self.rfp_timeout)
class DistributedScheduler(object):
'''
Scrapy request scheduler that utilizes Priority Queues
to moderate scrape requests within a distributed scrapy
cluster
'''
redis_conn = None # the redis connection
queue = None # the queue to use for crawling
spider = None # the spider using this scheduler
queue_class = None # the class to use for the queue
dupefilter = None # the redis dupefilter
item_retries = 0 # the number of extra tries to get an item
def __init__(self, server, persist, timeout, retries):
'''
Initialize the scheduler
'''
self.redis_conn = server
self.persist = persist
self.rfp_timeout = timeout
self.item_retires = retries
def setup(self):
'''
Used to initialize things when using mock
spider.name is not set yet
'''
self.queue = RedisPriorityQueue(self.redis_conn,
self.spider.name + ":queue")
@classmethod
def from_settings(cls, settings):
server = redis.Redis(host=settings.get('REDIS_HOST'),
port=settings.get('REDIS_PORT'))
persist = settings.get('SCHEDULER_PERSIST', True)
timeout = settings.get('DUPEFILTER_TIMEOUT', 600)
retries = settings.get('SCHEDULER_ITEM_RETRIES', 3)
return cls(server, persist, timeout, retries)
@classmethod
def from_crawler(cls, crawler):
return cls.from_settings(crawler.settings)
def open(self, spider):
self.spider = spider
self.setup()
self.dupefilter = RFPDupeFilter(self.redis_conn,
self.spider.name + ':dupefilter',
self.rfp_timeout)
def close(self, reason):
if not self.persist:
self.dupefilter.clear()
self.queue.clear()
def is_blacklisted(self, appid, crawlid):
'''
Checks the redis blacklist for crawls that should not be propagated
either from expiring or stopped
@return: True if the appid crawlid combo is blacklisted
'''
key_check = '{appid}||{crawlid}'.format(appid=appid, crawlid=crawlid)
redis_key = self.spider.name + ":blacklist"
return self.redis_conn.sismember(redis_key, key_check)
def enqueue_request(self, request):
'''
Pushes a request from the spider back into the queue
'''
if not request.dont_filter and self.dupefilter.request_seen(request):
return
req_dict = self.request_to_dict(request)
if not self.is_blacklisted(req_dict['meta']['appid'],
req_dict['meta']['crawlid']):
key = "{sid}:queue".format(sid=req_dict['meta']['spiderid'])
curr_time = time.time()
# insert if crawl never expires (0) or time < expires
if req_dict['meta']['expires'] == 0 or \
curr_time < req_dict['meta']['expires']:
self.queue.push(req_dict, req_dict['meta']['priority'])
def request_to_dict(self, request):
'''
Convert Request object to a dict.
modified from scrapy.utils.reqser
'''
req_dict = {
# urls should be safe (safe_string_url)
'url': request.url.decode('ascii'),
'method': request.method,
'headers': dict(request.headers),
'body': request.body,
'cookies': request.cookies,
'meta': request.meta,
'_encoding': request._encoding,
'priority': request.priority,
'dont_filter': request.dont_filter,
}
return req_dict
def find_item(self):
'''
Finds an item from the queue
'''
count = 0
while count <= self.item_retries:
item = self.queue.pop()
if item:
# very basic limiter
time.sleep(1)
return item
# we want the spiders to get slightly out of sync
# with each other for better performance
time.sleep(random.random())
count = count + 1
return None
def next_request(self):
'''
Logic to handle getting a new url request
'''
t = time.time()
item = self.find_item()
if item:
try:
req = Request(item['url'])
except ValueError:
# need absolute url
# need better url validation here
req = Request('http://' + item['url'])
if 'meta' in item:
item = item['meta']
# defaults
if "attrs" not in item:
item["attrs"] = {}
if "allowed_domains" not in item:
item["allowed_domains"] = ()
if "allow_regex" not in item:
item["allow_regex"] = ()
if "deny_regex" not in item:
item["deny_regex"] = ()
if "deny_extensions" not in item:
item["deny_extensions"] = None
if 'curdepth' not in item:
item['curdepth'] = 0
if "maxdepth" not in item:
item["maxdepth"] = 0
if "priority" not in item:
item['priority'] = 0
if "retry_times" not in item:
item['retry_times'] = 0
if "expires" not in item:
item['expires'] = 0
for key in ('attrs', 'allowed_domains', 'curdepth', 'maxdepth',
'appid', 'crawlid', 'spiderid', 'priority',
'retry_times', 'expires', 'allow_regex', 'deny_regex',
'deny_extensions'):
req.meta[key] = item[key]
return req
return None
def has_pending_requests(self):
'''
We never want to say we have pending requests
If this returns True scrapy sometimes hangs.
'''
return False
class DistributedScheduler(object):
"""
Scrapy request scheduler that utilizes Redis Throttled Priority Queues
to moderate different domain scrape requests within a distributed scrapy
cluster
"""
redis_conn = None # the redis connection
queue_dict = None # the dict of throttled queues
spider = None # the spider using this scheduler
queue_keys = None # the list of current queues
queue_class = None # the class to use for the queue
dupefilter = None # the redis dupefilter
update_time = 0 # the last time the queues were updated
update_ip_time = 0 # the last time the ip was updated
update_interval = 0 # how often to update the queues
extract = None # the tld extractor
hits = 0 # default number of hits for a queue
window = 0 # default window to calculate number of hits
my_ip = None # the ip address of the scheduler (if needed)
old_ip = None # the old ip for logging
ip_update_interval = 0 # the interval to update the ip address
add_type = None # add spider type to redis throttle queue key
add_ip = None # add spider public ip to redis throttle queue key
item_retries = 0 # the number of extra tries to get an item
my_uuid = None # the generated UUID for the particular scrapy process
# Zookeeper Dynamic Config Vars
domain_config = {} # The list of domains and their configs
my_id = None # The id used to read the throttle config
config_flag = False # Flag to reload queues if settings are wiped too
assign_path = None # The base assigned configuration path to read
zoo_client = None # The KazooClient to manage the config
my_assignment = None # Zookeeper path to read actual yml config
def __init__(
self,
server,
persist,
update_int,
timeout,
retries,
logger,
hits,
window,
mod,
ip_refresh,
add_type,
add_ip,
ip_regex,
):
"""
Initialize the scheduler
"""
self.redis_conn = server
self.persist = persist
self.queue_dict = {}
self.update_interval = update_int
self.hits = hits
self.window = window
self.moderated = mod
self.rfp_timeout = timeout
self.ip_update_interval = ip_refresh
self.add_type = add_type
self.add_ip = add_ip
self.item_retires = retries
self.logger = logger
self.ip_regex = re.compile(ip_regex)
# set up tldextract
self.extract = tldextract.TLDExtract()
self.update_ipaddress()
# if we need better uuid's mod this line
self.my_uuid = str(uuid.uuid4()).split("-")[4]
def setup_zookeeper(self):
self.assign_path = settings.get("ZOOKEEPER_ASSIGN_PATH", "")
self.my_id = settings.get("ZOOKEEPER_ID", "all")
self.logger.debug("Trying to establish Zookeeper connection")
try:
self.zoo_watcher = ZookeeperWatcher(
hosts=settings.get("ZOOKEEPER_HOSTS"),
filepath=self.assign_path + self.my_id,
config_handler=self.change_config,
error_handler=self.error_config,
pointer=False,
ensure=True,
valid_init=True,
)
except KazooTimeoutError:
self.logger.error("Could not connect to Zookeeper")
sys.exit(1)
if self.zoo_watcher.ping():
self.logger.debug("Successfully set up Zookeeper connection")
else:
self.logger.error("Could not ping Zookeeper")
sys.exit(1)
def change_config(self, config_string):
if config_string and len(config_string) > 0:
loaded_config = yaml.safe_load(config_string)
self.logger.info("Zookeeper config changed", extra=loaded_config)
self.load_domain_config(loaded_config)
self.update_domain_queues()
elif config_string is None or len(config_string) == 0:
self.error_config("Zookeeper config wiped")
self.create_queues()
def load_domain_config(self, loaded_config):
"""
Loads the domain_config and sets up queue_dict
@param loaded_config: the yaml loaded config dict from zookeeper
"""
self.domain_config = {}
# vetting process to ensure correct configs
if loaded_config and "domains" in loaded_config:
for domain in loaded_config["domains"]:
item = loaded_config["domains"][domain]
# check valid
if "window" in item and "hits" in item:
self.logger.debug("Added domain {dom} to loaded config".format(dom=domain))
self.domain_config[domain] = item
self.config_flag = True
def update_domain_queues(self):
"""
Check to update existing queues already in memory
new queues are created elsewhere
"""
for key in self.domain_config:
final_key = "{name}:{domain}:queue".format(name=self.spider.name, domain=key)
# we already have a throttled queue for this domain, update it to new settings
if final_key in self.queue_dict:
self.queue_dict[final_key].window = float(self.domain_config[key]["window"])
self.logger.debug("Updated queue {q} with new config".format(q=final_key))
# if scale is applied, scale back; otherwise use updated hits
if "scale" in self.domain_config[key]:
# round to int
hits = int(self.domain_config[key]["hits"] * self.fit_scale(self.domain_config[key]["scale"]))
self.queue_dict[final_key].limit = float(hits)
else:
self.queue_dict[final_key].limit = float(self.domain_config[key]["hits"])
def error_config(self, message):
extras = {}
extras["message"] = message
extras["revert_window"] = self.window
extras["revert_hits"] = self.hits
extras["spiderid"] = self.spider.name
self.logger.info("Lost config from Zookeeper", extra=extras)
# lost connection to zookeeper, reverting back to defaults
for key in self.domain_config:
final_key = "{name}:{domain}:queue".format(name=self.spider.name, domain=key)
self.queue_dict[final_key].window = self.window
self.queue_dict[final_key].limit = self.hits
self.domain_config = {}
def fit_scale(self, scale):
"""
@return: a scale >= 0 and <= 1
"""
if scale >= 1:
return 1.0
elif scale <= 0:
return 0.0
else:
return scale
def create_queues(self):
"""
Updates the in memory list of the redis queues
Creates new throttled queue instances if it does not have them
"""
# new config could have loaded between scrapes
newConf = self.check_config()
self.queue_keys = self.redis_conn.keys(self.spider.name + ":*:queue")
for key in self.queue_keys:
# build final queue key, depending on type and ip bools
throttle_key = ""
if self.add_type:
throttle_key = self.spider.name + ":"
if self.add_ip:
throttle_key = throttle_key + self.my_ip + ":"
# add the tld from the key `type:tld:queue`
the_domain = re.split(":", key)[1]
throttle_key = throttle_key + the_domain
if key not in self.queue_dict or newConf:
self.logger.debug("Added new Throttled Queue {q}".format(q=key))
q = RedisPriorityQueue(self.redis_conn, key)
# use default window and hits
if the_domain not in self.domain_config:
self.queue_dict[key] = RedisThrottledQueue(
self.redis_conn, q, self.window, self.hits, self.moderated, throttle_key, throttle_key
)
# use custom window and hits
else:
window = self.domain_config[the_domain]["window"]
hits = self.domain_config[the_domain]["hits"]
# adjust the crawl rate based on the scale if exists
if "scale" in self.domain_config[the_domain]:
hits = int(hits * self.fit_scale(self.domain_config[the_domain]["scale"]))
self.queue_dict[key] = RedisThrottledQueue(
self.redis_conn, q, window, hits, self.moderated, throttle_key, throttle_key
)
def check_config(self):
"""
Controls configuration for the scheduler
@return: True if there is a new configuration
"""
if self.config_flag:
self.config_flag = False
return True
return False
def update_ipaddress(self):
"""
Updates the scheduler so it knows its own ip address
"""
# assign local ip in case of exception
self.old_ip = self.my_ip
self.my_ip = "127.0.0.1"
try:
obj = urllib2.urlopen(settings.get("PUBLIC_IP_URL", "http://ip.42.pl/raw"))
results = self.ip_regex.findall(obj.read())
if len(results) > 0:
self.my_ip = results[0]
else:
raise IOError("Could not get valid IP Address")
obj.close()
self.logger.debug("Current public ip: {ip}".format(ip=self.my_ip))
except IOError:
self.logger.error("Could not reach out to get public ip")
pass
if self.old_ip != self.my_ip:
self.logger.info("Changed Public IP: {old} -> {new}".format(old=self.old_ip, new=self.my_ip))
def report_self(self):
"""
Reports the crawler uuid to redis
"""
self.logger.debug("Reporting self id", extra={"uuid": self.my_uuid})
key = "stats:crawler:{m}:{s}:{u}".format(m=socket.gethostname(), s=self.spider.name, u=self.my_uuid)
self.redis_conn.set(key, time.time())
self.redis_conn.expire(key, self.ip_update_interval * 2)
@classmethod
def from_settings(cls, settings):
server = redis.Redis(host=settings.get("REDIS_HOST"), port=settings.get("REDIS_PORT"))
persist = settings.get("SCHEDULER_PERSIST", True)
up_int = settings.get("SCHEDULER_QUEUE_REFRESH", 10)
hits = settings.get("QUEUE_HITS", 10)
window = settings.get("QUEUE_WINDOW", 60)
mod = settings.get("QUEUE_MODERATED", False)
timeout = settings.get("DUPEFILTER_TIMEOUT", 600)
ip_refresh = settings.get("SCHEDULER_IP_REFRESH", 60)
add_type = settings.get("SCHEDULER_TYPE_ENABLED", False)
add_ip = settings.get("SCHEDULER_IP_ENABLED", False)
retries = settings.get("SCHEUDLER_ITEM_RETRIES", 3)
ip_regex = settings.get("IP_ADDR_REGEX", ".*")
my_level = settings.get("SC_LOG_LEVEL", "INFO")
my_name = settings.get("SC_LOGGER_NAME", "sc-logger")
my_output = settings.get("SC_LOG_STDOUT", True)
my_json = settings.get("SC_LOG_JSON", False)
my_dir = settings.get("SC_LOG_DIR", "logs")
my_bytes = settings.get("SC_LOG_MAX_BYTES", "10MB")
my_file = settings.get("SC_LOG_FILE", "main.log")
my_backups = settings.get("SC_LOG_BACKUPS", 5)
logger = LogFactory.get_instance(
json=my_json,
name=my_name,
stdout=my_output,
level=my_level,
dir=my_dir,
file=my_file,
bytes=my_bytes,
backups=my_backups,
)
return cls(
server, persist, up_int, timeout, retries, logger, hits, window, mod, ip_refresh, add_type, add_ip, ip_regex
)
@classmethod
def from_crawler(cls, crawler):
return cls.from_settings(crawler.settings)
def open(self, spider):
self.spider = spider
self.spider.set_logger(self.logger)
self.spider.set_redis(self.redis_conn)
self.spider.setup_stats()
self.create_queues()
self.setup_zookeeper()
self.dupefilter = RFPDupeFilter(self.redis_conn, self.spider.name + ":dupefilter", self.rfp_timeout)
def close(self, reason):
self.logger.info("Closing Spider", {"spiderid": self.spider.name})
if not self.persist:
self.logger.warning("Clearing crawl queues")
self.dupefilter.clear()
for key in self.queue_keys:
self.queue_dict[key].clear()
def is_blacklisted(self, appid, crawlid):
"""
Checks the redis blacklist for crawls that should not be propagated
either from expiring or stopped
@return: True if the appid crawlid combo is blacklisted
"""
key_check = "{appid}||{crawlid}".format(appid=appid, crawlid=crawlid)
redis_key = self.spider.name + ":blacklist"
return self.redis_conn.sismember(redis_key, key_check)
def enqueue_request(self, request):
"""
Pushes a request from the spider into the proper throttled queue
"""
if not request.dont_filter and self.dupefilter.request_seen(request):
self.logger.debug("Request not added back to redis")
return
req_dict = self.request_to_dict(request)
if not self.is_blacklisted(req_dict["meta"]["appid"], req_dict["meta"]["crawlid"]):
# grab the tld of the request
ex_res = self.extract(req_dict["url"])
key = "{sid}:{dom}.{suf}:queue".format(
sid=req_dict["meta"]["spiderid"], dom=ex_res.domain, suf=ex_res.suffix
)
curr_time = time.time()
# insert if crawl never expires (0) or time < expires
if req_dict["meta"]["expires"] == 0 or curr_time < req_dict["meta"]["expires"]:
# we may already have the queue in memory
if key in self.queue_keys:
self.queue_dict[key].push(req_dict, req_dict["meta"]["priority"])
else:
# shoving into a new redis queue, negative b/c of sorted sets
# this will populate ourself and other schedulers when
# they call create_queues
self.redis_conn.zadd(key, pickle.dumps(req_dict, protocol=-1), -req_dict["meta"]["priority"])
self.logger.debug(
"Crawlid: '{id}' Appid: '{appid}' added to queue".format(
appid=req_dict["meta"]["appid"], id=req_dict["meta"]["crawlid"]
)
)
else:
self.logger.debug(
"Crawlid: '{id}' Appid: '{appid}' expired".format(
appid=req_dict["meta"]["appid"], id=req_dict["meta"]["crawlid"]
)
)
else:
self.logger.debug(
"Crawlid: '{id}' Appid: '{appid}' blacklisted".format(
appid=req_dict["meta"]["appid"], id=req_dict["meta"]["crawlid"]
)
)
def request_to_dict(self, request):
"""
Convert Request object to a dict.
modified from scrapy.utils.reqser
"""
req_dict = {
# urls should be safe (safe_string_url)
"url": request.url.decode("ascii"),
"method": request.method,
"headers": dict(request.headers),
"body": request.body,
"cookies": request.cookies,
"meta": request.meta,
"_encoding": request._encoding,
"priority": request.priority,
"dont_filter": request.dont_filter,
# callback/errback are assumed to be a bound instance of the spider
"callback": None if request.callback is None else request.callback.func_name,
"errback": None if request.errback is None else request.errback.func_name,
}
return req_dict
def find_item(self):
"""
Finds an item from the throttled queues
"""
random.shuffle(self.queue_keys)
count = 0
while count <= self.item_retries:
for key in self.queue_keys:
# the throttled queue only returns an item if it is allowed
item = self.queue_dict[key].pop()
if item:
return item
# we want the spiders to get slightly out of sync
# with each other for better performance
time.sleep(random.random())
count = count + 1
return None
def next_request(self):
"""
Logic to handle getting a new url request, from a bunch of
different queues
"""
t = time.time()
# update the redis queues every so often
if t - self.update_time > self.update_interval:
self.update_time = t
self.create_queues()
# update the ip address every so often
if t - self.update_ip_time > self.ip_update_interval:
self.update_ip_time = t
self.update_ipaddress()
self.report_self()
item = self.find_item()
if item:
self.logger.debug("Found url to crawl {url}".format(url=item["url"]))
try:
req = Request(item["url"])
except ValueError:
# need absolute url
# need better url validation here
req = Request("http://" + item["url"])
if "meta" in item:
item = item["meta"]
# defaults not in schema
if "curdepth" not in item:
item["curdepth"] = 0
if "retry_times" not in item:
item["retry_times"] = 0
for key in item.keys():
req.meta[key] = item[key]
# extra check to add items to request
if "useragent" in item and item["useragent"] is not None:
req.headers["User-Agent"] = item["useragent"]
if "cookie" in item and item["cookie"] is not None:
if isinstance(item["cookie"], dict):
req.cookies = item["cookie"]
elif isinstance(item["cookie"], basestring):
req.cookies = self.parse_cookie(item["cookie"])
return req
return None
def parse_cookie(self, string):
"""
Parses a cookie string like returned in a Set-Cookie header
@param string: The cookie string
@return: the cookie dict
"""
results = re.findall("([^=]+)=([^\;]+);?\s?", string)
my_dict = {}
for item in results:
my_dict[item[0]] = item[1]
return my_dict
def has_pending_requests(self):
"""
We never want to say we have pending requests
If this returns True scrapy sometimes hangs.
"""
return False
class RedisScheduler(object):
"""Redis-based scheduler"""
def __init__(self, server, persist, queue_key, queue_cls, dupefilter_key,
idle_before_close):
"""Initialize scheduler.
Parameters
----------
server : Redis instance
persist : bool
queue_key : str
queue_cls : queue class
dupefilter_key : str
idle_before_close : int
"""
self.server = server
self.persist = persist
self.queue_key = queue_key
self.queue_cls = queue_cls
self.dupefilter_key = dupefilter_key
self.idle_before_close = idle_before_close
self.stats = None
def __len__(self):
return len(self.queue)
@classmethod
def from_settings(cls, settings):
persist = settings.get('SCHEDULER_PERSIST', SCHEDULER_PERSIST)
queue_key = settings.get('SCHEDULER_QUEUE_KEY', QUEUE_KEY)
queue_cls = load_object(
settings.get('SCHEDULER_QUEUE_CLASS', QUEUE_CLASS))
dupefilter_key = settings.get('DUPEFILTER_KEY', DUPEFILTER_KEY)
idle_before_close = settings.get('SCHEDULER_IDLE_BEFORE_CLOSE',
IDLE_BEFORE_CLOSE)
server = redis.Redis('120.25.216.93', '6379')
return cls(server, persist, queue_key, queue_cls, dupefilter_key,
idle_before_close)
@classmethod
def from_crawler(cls, crawler):
instance = cls.from_settings(crawler.settings)
# FIXME: for now, stats are only supported from this constructor
instance.stats = crawler.stats
return instance
def open(self, spider):
self.spider = spider
self.queue = self.queue_cls(self.server, spider, self.queue_key)
self.df = RFPDupeFilter(self.server,
self.dupefilter_key % {'spider': spider.name},
10)
if self.idle_before_close < 0:
self.idle_before_close = 0
# notice if there are requests already in the queue to resume the crawl
if len(self.queue):
spider.log("Resuming crawl (%d requests scheduled)" %
len(self.queue))
def close(self, reason):
if not self.persist:
self.df.clear()
self.queue.clear()
def enqueue_request(self, request):
if not request.dont_filter and self.df.request_seen(request):
return
if self.stats:
self.stats.inc_value('scheduler/enqueued/redis',
spider=self.spider)
self.queue.push(request)
def next_request(self):
block_pop_timeout = self.idle_before_close
request = self.queue.pop(block_pop_timeout)
if request and self.stats:
self.stats.inc_value('scheduler/dequeued/redis',
spider=self.spider)
return request
def has_pending_requests(self):
return len(self) > 0