1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
"""
ia_tasks.py
'ia' subcommand for retrieving information about archive.org catalog tasks.
"""
# Copyright (C) 2012-2024 Internet Archive
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import argparse
import sys
import warnings
from internetarchive.cli.cli_utils import PostDataAction, QueryStringAction
from internetarchive.utils import json
def setup(subparsers):
"""
Setup args for tasks command.
Args:
subparsers: subparser object passed from ia.py
"""
parser = subparsers.add_parser("tasks",
aliases=["ta"],
help="Retrieve information about your archive.org catalog tasks")
parser.add_argument("-t", "--task",
nargs="*",
help="Return information about the given task.")
parser.add_argument("-G", "--get-task-log",
help="Return the given tasks task log.")
parser.add_argument("-p", "--parameter",
nargs="+",
action=QueryStringAction,
default={},
metavar="KEY:VALUE",
help="URL parameters passed to catalog.php.")
parser.add_argument("-T", "--tab-output",
action="store_true",
help="Output task info in tab-delimited columns.")
parser.add_argument("-c", "--cmd",
type=str,
help="The task to submit (e.g., make_dark.php).")
parser.add_argument("-C", "--comment",
type=str,
help="A reasonable explanation for why a task is being submitted.")
parser.add_argument("-a", "--task-args",
nargs="+",
action=QueryStringAction,
default={},
metavar="KEY:VALUE",
help="Args to submit to the Tasks API.")
parser.add_argument("-d", "--data",
nargs="+",
action=PostDataAction,
metavar="KEY:VALUE",
default={},
help="Additional data to send when submitting a task.")
parser.add_argument("-r", "--reduced-priority",
action="store_true",
help="Submit task at a reduced priority.")
parser.add_argument("-l", "--get-rate-limit",
action="store_true",
help="Get rate limit info.")
parser.add_argument("identifier",
type=str,
nargs="?",
help="Identifier for tasks specific operations.")
parser.set_defaults(func=lambda args: main(args, parser))
def handle_task_submission_result(result, cmd):
"""
Handle the result of a task submission.
"""
if result.get("success"):
task_log_url = result.get("value", {}).get("log")
print(f"success: {task_log_url}", file=sys.stderr)
elif "already queued/running" in result.get("error", ""):
print(f"success: {cmd} task already queued/running", file=sys.stderr)
else:
print(f"error: {result.get('error')}", file=sys.stderr)
sys.exit(0 if result.get("success") else 1)
def main(args: argparse.Namespace, parser: argparse.ArgumentParser) -> None:
"""
Main entry point for 'ia tasks'.
"""
# Tasks write API.
if args.cmd:
if args.get_rate_limit:
r = args.session.get_tasks_api_rate_limit(args.cmd)
print(json.dumps(r))
sys.exit(0)
args.data["args"] = args.task_args
r = args.session.submit_task(args.identifier,
args.cmd,
comment=args.comment,
priority=int(args.data.get("priority", 0)),
reduced_priority=args.reduced_priority,
data=args.data)
handle_task_submission_result(r.json(), args.cmd)
sys.exit(0)
# Tasks read API.
if args.identifier:
_params = {"identifier": args.identifier, "catalog": 1, "history": 1}
_params.update(args.parameter)
args.parameter = _params
elif args.get_task_log:
log = args.session.get_task_log(args.get_task_log, **args.parameter)
print(log.encode("utf-8", errors="surrogateescape")
.decode("utf-8", errors="replace"))
sys.exit(0)
queryable_params = [
"identifier",
"task_id",
"server",
"cmd",
"args",
"submitter",
"priority",
"wait_admin",
"submittime",
]
if not (args.identifier
or args.parameter.get("task_id")):
_params = {"catalog": 1, "history": 0}
_params.update(args.parameter)
args.parameter = _params
if not any(x in args.parameter for x in queryable_params):
_params = {"submitter": args.session.user_email, "catalog": 1, "history": 0, "summary": 0}
_params.update(args.parameter)
args.parameter = _params
if args.tab_output:
warn_msg = ("tab-delimited output will be removed in a future release. "
"Please switch to the default JSON output.")
warnings.warn(warn_msg, stacklevel=2)
for t in args.session.get_tasks(params=args.parameter):
# Legacy support for tab-delimited output.
# Mypy is confused by CatalogTask members being created from kwargs
if args.tab_output:
color = t.color if t.color else "done"
task_args = "\t".join([f"{k}={v}" for k, v in t.args.items()]) # type: ignore
output = "\t".join([str(x) for x in [
t.identifier,
t.task_id,
t.server,
t.submittime,
t.cmd,
color,
t.submitter,
task_args,
] if x])
print(output, flush=True)
else:
print(t.json(), flush=True)
|
