#!/usr/bin/env python
# Copyright 2013-2018 CERN for the benefit of the ATLAS collaboration.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Authors:
# - Mario Lassnig, <mario.lassnig@cern.ch>, 2013-2015
# - Cedric Serfon, <cedric.serfon@cern.ch>, 2013-2019
# - Wen Guan, <wguan.icedew@gmail.com>, 2014-2016
# - Vincent Garonne, <vgaronne@gmail.com>, 2016-2018
# - Hannes Hansen, <hannes.jakob.hansen@cern.ch>, 2018-2019
#
# PY3K COMPATIBLE

"""
Conveyor is a daemon to manage file transfers.
"""

import argparse
import signal

from rucio.daemons.conveyor.submitter import run, stop


def get_parser():
    """
    Returns the argparse parser.
    """
    parser = argparse.ArgumentParser(description="The Conveyor-Submitter daemon is responsible for managing non-tape file transfers. It prepares transfer jobs and submits them to the transfertool.", epilog='''
Upload a file and create a replication rule::

  $ rucio upload --scope mock --rse MOCK --name file filename.txt
  $ rucio add-rule mock:file 1 MOCK2
  $ rucio-admin rse add-distance MOCK2 MOCK --distance 1 --ranking 1

The rule should replicate the file from RSE MOCK to RSE MOCK2. Therefor a distance between these RSEs is needed.

Check transfer requests for the DID::

    $ python
    from rucio.db.sqla import session,models
    session.get_session().query(models.Request).filter_by(scope='mock', name='file').first()
    # {'request_type': TRANSFER, 'state': QUEUED', ...}

A queued request was created which can be picked uped by the Conveyor-Submiter daemon.

Run the daemon::

  $ rucio-conveyor-submitter --run-once

Check again the transfer requests for the DID::

    $ python
    from rucio.db.sqla import session,models
    session.get_session().query(models.Request).filter_by(scope='mock', name='file').first()
    # {'request_type': TRANSFER, 'state': SUBMITTED', ...}

A tranfer request got created by executing the transfer. Depending on the transfer submission, the request state can be different. In this example the transfer got submitted successfully.
    ''')
    parser.add_argument("--run-once", action="store_true", default=False,
                        help='One iteration only')
    parser.add_argument("--total-threads", action="store", default=1, type=int,
                        help='Concurrency control: total number of threads per process')
    parser.add_argument("--bulk", action="store", default=100, type=int,
                        help='Bulk control: number of requests')
    parser.add_argument("--group-bulk", action="store", default=1, type=int,
                        help='Group control: number of requests per group')
    parser.add_argument("--group-policy", action="store", default='rule', type=str,
                        help='Group control: policy used to group. enum{rule, dest, src_dest, rule_src_dest, activity_dest, activity_src_dest}')
    parser.add_argument("--mock", action="store_true", default=False,
                        help='Fake source replicas for requests')
    parser.add_argument('--source-strategy', action="store", default=None, type=str,
                        help='Source strategy. Overload the strategy defined in config DB.')
    parser.add_argument('--exclude-rses', action="store", default=None, type=str,
                        help='RSE expression to exclude')
    parser.add_argument('--include-rses', action="store", default=None, type=str,
                        help='RSE expression to include')
    parser.add_argument('--rses', nargs='+', type=str,
                        help='Explicit list of RSEs to include')
    parser.add_argument('--activities', nargs='+', type=str,
                        help='Explicit list of activities to include')
    parser.add_argument('--exclude-activities', nargs='+', type=str,
                        help='Explicit list of activities to exclude')
    parser.add_argument('--sleep-time', action="store", default=600, type=int,
                        help='Seconds to sleep if few requests')
    parser.add_argument('--max-sources', action="store", default=4, type=int,
                        help='Maximum source replicas per FTS job')
    parser.add_argument("--retry-other-fts", action="store_true", default=False,
                        help='retry on a different FTS')
    return parser


if __name__ == "__main__":

    signal.signal(signal.SIGTERM, stop)
    parser = get_parser()
    args = parser.parse_args()
    try:
        run(once=args.run_once,
            bulk=args.bulk,
            group_bulk=args.group_bulk,
            group_policy=args.group_policy,
            mock=args.mock,
            include_rses=args.include_rses,
            exclude_rses=args.exclude_rses,
            rses=args.rses,
            source_strategy=args.source_strategy,
            activities=args.activities,
            exclude_activities=args.exclude_activities,
            sleep_time=args.sleep_time,
            max_sources=args.max_sources,
            retry_other_fts=args.retry_other_fts,
            total_threads=args.total_threads)
    except KeyboardInterrupt:
        stop()
