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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
|
###############################################################################
#
# CSW Client
# ---------------------------------------------------------
# QGIS Catalog Service client.
#
# Copyright (C) 2024 Tom Kralidis (tomkralidis@gmail.com)
#
# This source 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 2 of the License, or (at your option)
# any later version.
#
# This code 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, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
###############################################################################
import warnings
import owslib
from owslib.fes import BBox, PropertyIsLike
from MetaSearch.util import log_message
with warnings.catch_warnings():
warnings.filterwarnings("ignore", category=ResourceWarning)
warnings.filterwarnings("ignore", category=ImportWarning)
from owslib.csw import CatalogueServiceWeb # spellok
from qgis.core import Qgis
if owslib.__version__ < "0.25":
OWSLIB_OAREC_SUPPORTED = False
else:
OWSLIB_OAREC_SUPPORTED = True
CATALOG_TYPES = ["OGC CSW 2.0.2", "OGC API - Records"]
class SearchBase:
def __init__(self, url, timeout, username=None, password=None, auth=None):
self.url = url
self.timeout = timeout
self.username = username
self.password = password
self.auth = auth
self.service_info_template = None
self.record_info_template = None
self.request = None
self.response = None
self.matches = 0
self.returned = 0
self.format = None
def get_service_info(self):
pass
def query_records(self):
pass
def records(self):
pass
def get_record(self, identifier):
pass
def parse_link(self, link):
return link
class CSW202Search(SearchBase):
def __init__(self, url, timeout, username, password, auth):
super().__init__(url, timeout, username, password, auth)
self.type = CATALOG_TYPES[0]
self.format = "xml"
self.service_info_template = "csw_service_metadata.html"
self.record_info_template = "record_metadata_dc.html"
self.constraints = []
log_message(f"Connecting to CSW: {self.url}", Qgis.MessageLevel.Info)
self.conn = CatalogueServiceWeb(
self.url, # spellok
timeout=self.timeout,
username=self.username,
password=self.password,
auth=self.auth,
)
self.request = self.conn.request
self.response = self.conn.response
def query_records(self, bbox=[], keywords=None, limit=10, offset=1):
self.constraints = []
# only apply spatial filter if bbox is not global
# even for a global bbox, if a spatial filter is applied, then
# the CSW server will skip records without a bbox
if bbox and bbox != ["-180", "-90", "180", "90"]:
log_message(f"Setting bbox filter ({bbox})", Qgis.MessageLevel.Info)
minx, miny, maxx, maxy = bbox
self.constraints.append(
BBox([miny, minx, maxy, maxx], crs="urn:ogc:def:crs:EPSG::4326")
)
# keywords
if keywords:
# TODO: handle multiple word searches
log_message(
f"Setting csw:AnyText filter {keywords}", Qgis.MessageLevel.Info
)
self.constraints.append(PropertyIsLike("csw:AnyText", keywords))
if len(self.constraints) > 1: # exclusive search (a && b)
self.constraints = [self.constraints]
log_message("Searching CSW: {self.url}", Qgis.MessageLevel.Info)
self.conn.getrecords2(
constraints=self.constraints,
maxrecords=limit,
startposition=offset,
esn="full",
)
self.matches = self.conn.results["matches"]
self.returned = self.conn.results["returned"]
log_message(f"Matches: {self.matches}", Qgis.MessageLevel.Info)
log_message(f"Returned: {self.returned}", Qgis.MessageLevel.Info)
self.request = self.conn.request
self.response = self.conn.response
def records(self):
recs = []
for record in self.conn.records:
rec = {"identifier": None, "type": None, "title": None, "bbox": None}
if self.conn.records[record].identifier:
rec["identifier"] = self.conn.records[record].identifier
if self.conn.records[record].type:
rec["type"] = self.conn.records[record].type
if self.conn.records[record].title:
rec["title"] = self.conn.records[record].title
if self.conn.records[record].bbox:
rec["bbox"] = bbox_list_to_dict(self.conn.records[record].bbox)
rec["links"] = (
self.conn.records[record].uris + self.conn.records[record].references
)
recs.append(rec)
return recs
def get_record(self, identifier):
log_message(f"Searching CSW for record: {identifier}", Qgis.MessageLevel.Info)
self.conn.getrecordbyid([identifier])
return self.conn.records[identifier]
class OARecSearch(SearchBase):
def __init__(self, url, timeout, auth):
try:
from owslib.ogcapi.records import Records
except ModuleNotFoundError:
# OWSLIB_OAREC_SUPPORTED already set to False
pass
super().__init__(url, timeout, auth)
self.type = CATALOG_TYPES[1]
self.format = "json"
self.service_info_template = "oarec_service_metadata.html"
self.record_info_template = "record_metadata_oarec.html"
self.base_url = None
self.record_collection = None
if "/collections/" in self.url: # catalog is a collection
log_message("OARec endpoint is a collection", Qgis.MessageLevel.Info)
self.base_url, self.record_collection = self.url.split(
"/collections/"
) # noqa
self.conn = Records(self.base_url, timeout=self.timeout, auth=self.auth)
c = self.conn.collection(self.record_collection)
try:
self.conn.links = c["links"]
self.conn.title = c["title"]
self.conn.description = c["description"]
except KeyError:
pass
self.request = self.conn.request
else:
log_message("OARec endpoint is not a collection", Qgis.MessageLevel.Info)
self.conn = Records(self.url, timeout=self.timeout, auth=self.auth)
self.request = None
self.response = self.conn.response
def query_records(self, bbox=[], keywords=None, limit=10, offset=1):
# set zero-based offset (default MetaSearch behavior is CSW-based
# offset of 1
offset2 = offset - 1
params = {
"collection_id": self.record_collection,
"limit": limit,
"offset": offset2,
}
if keywords:
log_message(f"Setting keyword search {keywords}", Qgis.MessageLevel.Info)
params["q"] = keywords
if bbox and bbox != ["-180", "-90", "180", "90"]:
log_message(f"Setting bbox search {bbox}", Qgis.MessageLevel.Info)
params["bbox"] = bbox
log_message(f"Searching OARec: {self.url}", Qgis.MessageLevel.Info)
self.response = self.conn.collection_items(**params)
self.matches = self.response.get("numberMatched", 0)
self.returned = self.response.get("numberReturned", 0)
self.request = self.conn.request
log_message(f"Matches: {self.matches}", Qgis.MessageLevel.Info)
log_message(f"Returned: {self.returned}", Qgis.MessageLevel.Info)
def records(self):
recs = []
for rec in self.response["features"]:
rec1 = {
"identifier": rec["id"],
"type": rec["properties"]["type"],
"bbox": None,
"title": rec["properties"]["title"],
"links": rec.get("links", []),
}
try:
if rec.get("geometry") is not None:
rec1["bbox"] = bbox_list_to_dict(
[
rec["geometry"]["coordinates"][0][0][0],
rec["geometry"]["coordinates"][0][0][1],
rec["geometry"]["coordinates"][0][2][0],
rec["geometry"]["coordinates"][0][2][1],
]
)
except KeyError:
pass
recs.append(rec1)
return recs
def get_record(self, identifier):
log_message(
f"Searching OARec endpoint for item {identifier}", Qgis.MessageLevel.Info
)
return self.conn.collection_item(self.record_collection, identifier)
def parse_link(self, link):
link2 = {}
if "href" in link:
link2["url"] = link["href"]
if "type" in link:
link2["protocol"] = link["type"]
if "title" in link:
link2["title"] = link["title"]
if "id" in link:
link2["name"] = link["id"]
return link2
def get_catalog_service(url, catalog_type, timeout, username, password, auth=None):
if catalog_type in [None, CATALOG_TYPES[0]]:
log_message("CSW endpoint detected", Qgis.MessageLevel.Info)
return CSW202Search(url, timeout, username, password, auth)
elif catalog_type == CATALOG_TYPES[1]:
log_message("OARec endpoint detected", Qgis.MessageLevel.Info)
if not OWSLIB_OAREC_SUPPORTED:
raise ValueError("OGC API - Records requires OWSLib 0.25 or above")
return OARecSearch(url, timeout, auth)
def bbox_list_to_dict(bbox):
if isinstance(bbox, list):
dict_ = {"minx": bbox[0], "maxx": bbox[2], "miny": bbox[1], "maxy": bbox[3]}
else:
dict_ = {
"minx": bbox.minx,
"maxx": bbox.maxx,
"miny": bbox.miny,
"maxy": bbox.maxy,
}
return dict_
|
