pipeline.py

# encoding=utf8
# import datetime
from distutils.version import StrictVersion
import hashlib
import os.path
import argparse
from seesaw.config import realize, NumberConfigValue
from seesaw.externalprocess import ExternalProcess
from seesaw.item import ItemInterpolation, ItemValue
from seesaw.task import SimpleTask, LimitConcurrent
from seesaw.tracker import GetItemFromTracker, PrepareStatsForTracker, \
    UploadWithTracker, SendDoneToTracker
import shutil
import socket
# import subprocess
import sys
import time
# import string

from tornado import httpclient

import seesaw
# from seesaw.externalprocess import WgetDownload
from seesaw.pipeline import Pipeline
from seesaw.project import Project
from seesaw.util import find_executable

# TODO
import json
# import warcio
# import requests

# check the seesaw version
if StrictVersion(seesaw.__version__) < StrictVersion('0.10.3'):
    raise Exception('This pipeline needs seesaw version 0.10.3 or higher.')

###########################################################################
# Find a useful Wget+Lua executable.
#
# WGET_LUA will be set to the first path that
# 1. does not crash with --version, and
# 2. prints the required version string
# TODO
PYTHON = find_executable(
    'Python3',
    [
        'Python 3.8',
        'Python 3.7',
        'Python 3.6',
        'Python 3.5'
    ],
    [
        '/usr/bin/python3',
        '/usr/local/bin/python3',
        './python3',
    ]
)

if not PYTHON:
    raise Exception('No usable Python 3 found.')

###########################################################################
# The version number of this pipeline definition.
#
# Update this each time you make a non-cosmetic change.
# It will be added to the WARC files and reported to the tracker.
VERSION = '20191202.02'
USER_AGENT = 'ArchiveTeam'
TRACKER_ID = 'yahoo-groups-api'
# TRACKER_HOST = 'tracker.archiveteam.org'  #prod-env
TRACKER_HOST = 'tracker-test.ddns.net'  # dev-env


###########################################################################
# This section defines project-specific tasks.
#
# Simple tasks (tasks that do not need any concurrency) are based on the
# SimpleTask class and have a process(item) method that is called for
# each item.
class CheckIP(SimpleTask):
    def __init__(self):
        SimpleTask.__init__(self, 'CheckIP')
        self._counter = 0

    def process(self, item):
        # NEW for 2014! Check if we are behind firewall/proxy

        if self._counter <= 0:
            item.log_output('Checking IP address.')
            ip_set = set()

            ip_set.add(socket.gethostbyname('twitter.com'))
            ip_set.add(socket.gethostbyname('facebook.com'))
            ip_set.add(socket.gethostbyname('youtube.com'))
            ip_set.add(socket.gethostbyname('microsoft.com'))
            ip_set.add(socket.gethostbyname('icanhas.cheezburger.com'))
            ip_set.add(socket.gethostbyname('archiveteam.org'))

            if len(ip_set) != 6:
                item.log_output('Got IP addresses: {0}'.format(ip_set))
                item.log_output(
                    'Are you behind a firewall/proxy? That is a big no-no!')
                raise Exception(
                    'Are you behind a firewall/proxy? That is a big no-no!')

        # Check only occasionally
        if self._counter <= 0:
            self._counter = 10
        else:
            self._counter -= 1


class CheckBan(SimpleTask):
    def __init__(self):
        SimpleTask.__init__(self, 'CheckBan')

    def process(self, item):
        msg = None
        httpclient.AsyncHTTPClient.configure(None, defaults=dict(user_agent=USER_AGENT))
        http_client = httpclient.HTTPClient()
        try:
            response = http_client.fetch("https://groups.yahoo.com/neo/search")  # dynamic
        except httpclient.HTTPError as e:
            msg = "Failed to get CheckBan URL: " + str(e)
            item.log_output(msg)
            item.log_output("Sleeping 60...")
            time.sleep(60)
        http_client.close()
        if msg != None:
            raise Exception(msg)


class PrepareDirectories(SimpleTask):
    def __init__(self, warc_prefix):
        SimpleTask.__init__(self, 'PrepareDirectories')
        self.warc_prefix = warc_prefix

    def process(self, item):
        start_time = time.strftime('%Y%m%d-%H%M%S')

        item_name = item['item_name']
        escaped_item_name = item_name.replace(':', '_').replace('/', '_').replace('~', '_')
        dirname = '/'.join((item['data_dir'], escaped_item_name))

        if os.path.isdir(dirname):
            shutil.rmtree(dirname)

        os.makedirs(dirname)

        item['item_dir'] = dirname
        item['start_time'] = start_time
        item['warc_file_base'] = '%s-%s-%s-%s' % (self.warc_prefix, escaped_item_name[:50], VERSION, start_time)

        # open('%(item_dir)s/%(warc_file_base)s.warc.gz' % item, 'w').close()
        # open('%(item_dir)s/%(warc_file_base)s.defer-urls.txt' % item, 'w').close()


class MoveFiles(SimpleTask):
    def __init__(self):
        SimpleTask.__init__(self, 'MoveFiles')

    def process(self, item):
        # NEW for 2014! Check if wget was compiled with zlib support
        if os.path.exists('%(item_dir)s/%(warc_file_base)s.warc' % item):
            raise Exception('Please compile wget with zlib support!')

        print('Move from -> to')
        print('%(item_dir)s / %(item_value)s / data.warc.gz' % item)
        print('%(data_dir)s/%(warc_file_base)s.warc.gz' % item)

        os.rename('%(item_dir)s/%(item_value)s/data.warc.gz' % item,
                  '%(data_dir)s/%(warc_file_base)s.warc.gz' % item)
        os.rename('%(item_dir)s/%(item_value)s/archive.log' % item,
                  '%(data_dir)s/%(warc_file_base)s.log' % item)

        shutil.rmtree('%(item_dir)s' % item)
        item['files'] = [
            ItemInterpolation('%(data_dir)s/%(warc_file_base)s.log'),
            ItemInterpolation('%(data_dir)s/%(warc_file_base)s.warc.gz')
        ]


def get_hash(filename):
    with open(filename, 'rb') as in_file:
        return hashlib.sha1(in_file.read()).hexdigest()


CWD = os.getcwd()
PIPELINE_SHA1 = get_hash(os.path.join(CWD, 'pipeline.py'))
YP_SHA1 = get_hash(os.path.join(CWD, 'yahoo.py'))
YGAP_SHA1 = get_hash(os.path.join(CWD, 'yahoogroupsapi.py'))


def stats_id_function(item):
    # NEW for 2014! Some accountability hashes and stats.
    d = {
        'pipeline_hash': PIPELINE_SHA1,
        'yp_hash': YP_SHA1,
        'ygap_hash': YGAP_SHA1,
        'python_version': sys.version,
    }

    return d


class YgaArgs(object):
    def realize(self, item):
        http_client = httpclient.HTTPClient()

        yga_args = [
            PYTHON,
            '../../../yahoo.py',
            '-w'
        ]

        item_name = item['item_name']
        assert ':' in item_name
        item_fields = item_name.split(':')
        item_type, item_value = item_fields[0:2]

        item['item_type'] = item_type
        item['item_value'] = item_value

        if len(item_fields) > 2:
            for flag in item_fields[2].split('-'):
                yga_args.append('-' + flag)
        else:
            yga_args.extend(['-a', '-t'])

        if item_type == 'group':
            yga_args.append(item_value)
        elif item_type == 'group_cookie':
            cookie_json = http_client.fetch(
                'https://df58.host.cs.st-andrews.ac.uk/yahoogroups/cookieget/' + item_value + '/', method='GET')
            if cookie_json.code != 200:
                raise ValueError('Got bad status code {}.'.format(cookie_json.code))

            cookies = json.loads(cookie_json.body.decode('utf-8', 'ignore'))
            yga_args.extend(['-cy', "%s" % cookies["cookie_Y"]])
            yga_args.extend(['-ct', "%s" % cookies["cookie_T"]])
            yga_args.append(item_value)
        else:
            raise Exception('Unknown item')

        return realize(yga_args, item)


class YgaDownload(ExternalProcess):
    '''Download with process runner.'''

    def __init__(self, args, max_tries=1, accept_on_exit_code=None,
                 retry_on_exit_code=None, env=None, stdin_data_function=None):
        ExternalProcess.__init__(
            self, "YgaDownload",
            args=args, max_tries=max_tries,
            accept_on_exit_code=(accept_on_exit_code
                                 if accept_on_exit_code is not None else [0]),
            retry_on_exit_code=retry_on_exit_code,
            env=env)
        self.stdin_data_function = stdin_data_function

    def stdin_data(self, item):
        if self.stdin_data_function:
            return self.stdin_data_function(item)
        else:
            return b""

    def process(self, item):
        self.cwd = item['item_dir']
        super(YgaDownload, self).process(item)


###########################################################################
# Initialize the project.
#
# This will be shown in the warrior management panel. The logo should not
# be too big. The deadline is optional.
project = Project(
    title=TRACKER_ID,
    project_html='''
<img class="project-logo" alt="logo" src="https://upload.wikimedia.org/wikipedia/commons/f/f2/Yahoo_Groups.png" height="50px"/>
<h2>https://groups.yahoo.com/
 <span class="links">
  <a href="https://groups.yahoo.com/">Website</a>
  &middot;
  <a href="http://{0}/{1}/">Leaderboard</a>
 </span>
</h2>
    '''.format(TRACKER_HOST, TRACKER_ID)
)  # TODO

p = argparse.ArgumentParser()
pa = p.add_argument_group(title='Authentication Options')
pa.add_argument('-ct', '--cookie_t', type=str,
                help='T authentication cookie from yahoo.com')

pipeline = Pipeline(
    CheckIP(),
    GetItemFromTracker('http://%s/%s' % (TRACKER_HOST, TRACKER_ID), downloader, VERSION),  # noqa: F821
    PrepareDirectories(warc_prefix='yg-api'),
    YgaDownload(
        YgaArgs(),
        max_tries=0,  # 2,          #changed
        accept_on_exit_code=[0],  # [0, 4, 8],  #changed
        env={
            'item_dir': ItemValue('item_dir'),
            'item_value': ItemValue('item_value'),
            'item_type': ItemValue('item_type'),
            'warc_file_base': ItemValue('warc_file_base'),
        }
    ),
    MoveFiles(),
    PrepareStatsForTracker(
        defaults={'downloader': downloader, 'version': VERSION},  # noqa: F821
        file_groups={
            'data': [
                ItemInterpolation('%(data_dir)s/%(warc_file_base)s.warc.gz')  # TODO ?
            ]
        },
        id_function=stats_id_function,
    ),
    LimitConcurrent(NumberConfigValue(min=1, max=20, default='20',
                                      name='shared:rsync_threads', title='Rsync threads',
                                      description='The maximum number of concurrent uploads.'),
                    UploadWithTracker('http://%s/%s' % (TRACKER_HOST, TRACKER_ID),
                                      downloader=downloader,  # noqa: F821
                                      version=VERSION,
                                      files=ItemValue('files'),
                                      rsync_target_source_path=ItemInterpolation('%(data_dir)s/'),
                                      rsync_extra_args=[
                                          '--recursive',
                                          '--partial',
                                          '--partial-dir', '.rsync-tmp',
                                      ]), ),
    SendDoneToTracker(
        tracker_url='http://%s/%s' % (TRACKER_HOST, TRACKER_ID),
        stats=ItemValue('stats')
    )
)