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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
"""
ia_search.py
'ia' subcommand for searching items on archive.org.
"""
# 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/>.
from __future__ import annotations
import argparse
import sys
from itertools import chain
from requests.exceptions import ConnectTimeout, ReadTimeout
from internetarchive.cli.cli_utils import FlattenListAction, QueryStringAction
from internetarchive.exceptions import AuthenticationError
from internetarchive.utils import json
def setup(subparsers):
"""
Setup args for search command.
Args:
subparsers: subparser object passed from ia.py
"""
parser = subparsers.add_parser("search",
aliases=["se"],
help="Search items on archive.org")
# Positional arguments
parser.add_argument("query",
type=str,
help="Search query or queries.")
# Optional arguments
parser.add_argument("-p", "--parameters",
nargs="+",
action=QueryStringAction,
metavar="KEY:VALUE",
help="Parameters to send with your query.")
parser.add_argument("-H", "--header",
nargs="+",
action=QueryStringAction,
metavar="KEY:VALUE",
help="Add custom headers to your search request.")
parser.add_argument("-s", "--sort",
action="append",
help=("Sort search results by specified fields. "
"See https://archive.org/advancedsearch.php "
"for full list of sort values"
" (e.g. --sort 'date desc', --sort 'date asc', etc.)."))
parser.add_argument("-i", "--itemlist",
action="store_true",
help="Output identifiers only.")
parser.add_argument("-f", "--field",
nargs="+",
action=FlattenListAction,
help="Metadata fields to return.")
parser.add_argument("-n", "--num-found",
action="store_true",
help="Print the number of results to stdout.")
parser.add_argument("-F", "--fts",
action="store_true",
help="Beta support for querying the archive.org full text search API.")
parser.add_argument("-D", "--dsl-fts",
action="store_true",
help="Submit --fts query in dsl.")
parser.add_argument("-t", "--timeout",
type=float,
default=300,
help="Set the timeout in seconds.")
parser.set_defaults(func=lambda args: main(args, parser))
def prepare_values(value):
"""
Prepare comma-separated values based on the input value.
"""
if value:
return list(chain.from_iterable([x.split(",") for x in value]))
return None
def perform_search(args, fields, sorts, r_kwargs):
"""
Perform the search using the provided arguments and request kwargs.
"""
return args.session.search_items(args.query, # type: ignore
fields=fields,
sorts=sorts,
params=args.parameters,
full_text_search=args.fts,
dsl_fts=args.dsl_fts,
request_kwargs=r_kwargs)
def handle_search_results(args, search):
"""
Handle search results based on command-line arguments.
"""
if args.num_found:
print(search.num_found)
sys.exit(0)
for result in search:
if args.itemlist:
if args.fts or args.dsl_fts:
print("\n".join(result.get("fields", {}).get("identifier")))
else:
print(result.get("identifier", ""))
else:
print(json.dumps(result))
if result.get("error"):
sys.exit(1)
def handle_value_error(exc):
"""
Handle ValueError exception.
"""
return f"error: {exc}"
def handle_connect_timeout():
"""
Handle ConnectTimeout exception.
"""
return "error: Request timed out. Increase the --timeout and try again."
def handle_read_timeout():
"""
Handle ReadTimeout exception.
"""
return "error: The server timed out and failed to return all search results, please try again"
def handle_authentication_error(exc):
"""
Handle AuthenticationError exception.
"""
return f"error: {exc}"
def main(args: argparse.Namespace, parser: argparse.ArgumentParser) -> None:
"""
Main entry point for 'ia search'.
"""
try:
# Prepare fields and sorts.
fields = prepare_values(args.field)
sorts = prepare_values(args.sort)
# Prepare request kwargs.
r_kwargs = {
"headers": args.header,
"timeout": args.timeout,
}
# Perform search.
search = perform_search(args, fields, sorts, r_kwargs)
# Handle search results.
handle_search_results(args, search)
except ValueError as exc:
error_message = handle_value_error(exc)
print(error_message, file=sys.stderr)
sys.exit(1)
except ConnectTimeout:
error_message = handle_connect_timeout()
print(error_message, file=sys.stderr)
sys.exit(1)
except ReadTimeout:
error_message = handle_read_timeout()
print(error_message, file=sys.stderr)
sys.exit(1)
except AuthenticationError as exc:
error_message = handle_authentication_error(exc)
print(error_message, file=sys.stderr)
sys.exit(1)
|
