#!/usr/bin/env python2

# THIS FILE IS PART OF THE CYLC SUITE ENGINE.
# Copyright (C) 2008-2019 NIWA & British Crown (Met Office) & Contributors.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""cylc [control] hold [OPTIONS] ARGS

Hold one or more waiting tasks (cylc hold REG TASKID ...), or
a whole suite (cylc hold REG).

Held tasks do not submit even if they are ready to run.

See also 'cylc [control] release'.
"""

import sys
if '--use-ssh' in sys.argv[1:]:
    sys.argv.remove('--use-ssh')
    from cylc.remote import remrun
    if remrun():
        sys.exit(0)

import cylc.flags
from cylc.prompt import prompt
from cylc.option_parsers import CylcOptionParser as COP
from cylc.network.httpclient import SuiteRuntimeServiceClient


def main():
    parser = COP(
        __doc__, comms=True, multitask=True,
        argdoc=[
            ("REG", "Suite name"),
            ('[TASKID ...]', 'Task identifiers')])

    parser.add_option(
        "--after",
        help="Hold whole suite AFTER this cycle point.",
        metavar="CYCLE_POINT", action="store", dest="hold_point_string")

    options, args = parser.parse_args()

    suite = args.pop(0)
    if args:
        prompt('Hold task(s) %s in %s' % (args, suite), options.force)
    elif options.hold_point_string:
        prompt(
            'Hold suite after %s' % options.hold_point_string, options.force)
    else:
        prompt('Hold suite %s' % suite, options.force)
    pclient = SuiteRuntimeServiceClient(
        suite, options.owner, options.host, options.port,
        options.comms_timeout, my_uuid=options.set_uuid,
        print_uuid=options.print_uuid)
    if args:
        items = parser.parse_multitask_compat(options, args)
        pclient.put_command('hold_tasks', items=items)
    elif options.hold_point_string:
        pclient.put_command(
            'hold_after_point_string',
            point_string=options.hold_point_string
        )
    else:
        pclient.put_command('hold_suite')


if __name__ == "__main__":
    try:
        main()
    except Exception as exc:
        if cylc.flags.debug:
            raise
        sys.exit(str(exc))
