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
|
#
# Copyright 2021 Martin Owens <doctormo@gmail.com>
# Copyright 2022 Simon Duerr <dev@simonduerr.eu>
#
# 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/>
#
"""
Base module for all import web search source modules.
"""
import re
import os
import sys
import logging
import requests
import importlib
from cachecontrol import CacheControl, CacheControlAdapter
from cachecontrol.caches.file_cache import FileCache
from cachecontrol.heuristics import ExpiresAfter
from inkex.command import CommandNotFound, ProgramRunError, call
from collections import defaultdict
LICENSE_ICONS = os.path.join(os.path.dirname(__file__), 'licenses')
LICENSES = {
"cc-0": {
"name": "CC0",
"modules": ["nocopyright"],
"url": "https://creativecommons.org/publicdomain/zero/1.0/",
"overlay": "cc0.svg",
},
"cc-by-3.0": {
"name": "CC-BY 3.0 Unported",
"modules": ["by"],
"url": "https://creativecommons.org/licenses/by/3.0/",
"overlay": "cc-by.svg",
},
"cc-by-4.0": {
"name": "CC-BY 4.0 Unported",
"modules": ["by"],
"url": "https://creativecommons.org/licenses/by/4.0/",
"overlay": "cc-by.svg",
},
"cc-by-sa-4.0": {
"name": "CC-BY SA 4.0",
"modules": ["by", "sa"],
"url": "https://creativecommons.org/licenses/by-sa/4.0/",
"overlay": "cc-by-sa.svg",
},
"cc-by-sa-3.0": {
"name": "CC-BY SA 3.0",
"modules": ["by", "sa"],
"url": "https://creativecommons.org/licenses/by-sa/3.0/",
"overlay": "cc-by-sa.svg",
},
"cc-by-nc-sa-4.0": {
"name": "CC-BY NC SA 4.0",
"modules": ["by", "sa", "nc"],
"url": "https://creativecommons.org/licenses/by-nc-sa/4.0/",
"overlay": "cc-by-nc-sa.svg",
},
"cc-by-nc-sa-3.0": {
"name": "CC-BY NC SA 3.0",
"modules": ["by", "sa", "nc"],
"url": "https://creativecommons.org/licenses/by-nc-sa/3.0/",
"overlay": "cc-by-nc-sa.svg",
},
"cc-by-nc-3.0": {
"name": "CC-BY NC 3.0",
"modules": ["by", "nc"],
"url": "https://creativecommons.org/licenses/by-nc/3.0/",
"overlay": "cc-by-nc.svg",
},
"cc-by-nd-3.0": {
"name": "CC-BY ND 3.0",
"modules": ["by", "nd"],
"url": "https://creativecommons.org/licenses/by-nd/3.0/",
"overlay": "cc-by-nd.svg",
},
"gpl-2": {
"name": "GPLv2",
"modules": ["retaincopyrightnotice", "sa"],
"url": "https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt",
"overlay": "gpl.svg",
},
"gpl-3": {
"name": "GPLv3",
"modules": ["retaincopyrightnotice", "sa"],
"url": "https://www.gnu.org/licenses/gpl-3.0.txt",
"overlay": "gpl.svg",
},
"agpl-3": {
"name": "AGPLv3",
"modules": ["retaincopyrightnotice", "sa"],
"url": "https://www.gnu.org/licenses/agpl-3.0.txt",
"overlay": "gpl.svg",
},
"mit": {
"name": "MIT",
"modules": ["retaincopyrightnotice"],
"url": "https://mit-license.org/",
"overlay": "mit.svg",
},
"asl": {
"name": "Apache License",
"modules": ["retaincopyrightnotice"],
"url": "https://www.apache.org/licenses/LICENSE-2.0.txt",
"overlay": "asl.svg",
},
"bsd": {
"name": "BSD",
"modules": ["retaincopyrightnotice", "noendorsement"],
"url": "https://opensource.org/licenses/BSD-3-Clause",
"overlay": "bsd.svg",
},
}
class RemotePage:
"""Lazy access to paging systems"""
icon = "sources/next_page.svg"
string = property(lambda self: "Next Page")
def __init__(self, remote, func):
self.func = func
self.remote = remote
def get_next_page(self):
for info in self.func():
yield self.remote.result_to_cls(info)
class RemoteFile:
"""Lazy access to remote files"""
icon = property(lambda self: self.remote.to_local_file(self.info["thumbnail"]))
get_file = lambda self: self.remote.to_local_file(self.info["file"])
def __init__(self, remote, info):
for field in ("name", "thumbnail", "license", "file"):
if field not in info:
raise ValueError(f"Field {field} not provided in RemoteFile package")
self.info = info
self.remote = remote
@property
def string(self):
return self.info["name"]
@property
def license(self):
return self.info["license"]
def get_overlay(self):
return self.license_info["overlay"]
@property
def license_info(self):
return LICENSES.get(self.license, {
"name": "Unknown",
"url": self.info.get("descriptionurl", ""),
"modules": [],
"overlay": "unknown.svg",
})
@property
def author(self):
return self.info["author"]
class RemoteSource:
"""A remote source of svg images which can be searched and downloaded"""
# These are the properties that should be overridden in your class
name = None
icon = None
file_cls = RemoteFile
page_cls = RemotePage
is_default = False
is_enabled = True
@classmethod
def load(cls, name):
"""Load the file or directory of remote sources"""
if os.path.isfile(name):
sys.path, sys_path = [os.path.dirname(name)] + sys.path, sys.path
try:
importlib.import_module(os.path.basename(name).rsplit(".", 1)[0])
except ImportError:
logging.error(f"Failed to load module: {name}")
sys.path = sys_path
elif os.path.isdir(name):
for child in os.listdir(name):
if not child.startswith("_") and child.endswith(".py"):
cls.load(os.path.join(name, child))
def search(self, query, tags=[]):
"""
Search for the given query and yield basic informational blocks t hand to file_cls.
Required fields per yielded object are: name, license, thumbnail and file.
Optional fields are: id, summary, author, created, popularity
"""
raise NotImplementedError(
"You must implement a search function for this remote source!"
)
sources = {}
def __init_subclass__(cls):
if cls != RemoteSource:
cls.sources[cls.__name__] = cls
def __init__(self, cache_dir):
self.session = requests.session()
self.cache_dir = cache_dir
self.session.mount(
"https://",
CacheControlAdapter(
cache=FileCache(cache_dir),
heuristic=ExpiresAfter(days=5),
),
)
def __del__(self):
self.session.close()
def file_search(self, query):
"""Search for extension packages"""
for info in self.search(query):
yield self.result_to_cls(info)
def result_to_cls(self, info):
if callable(info):
return self.page_cls(self, info)
return self.file_cls(self, info)
def to_local_file(self, url):
"""Get a remote url and turn it into a local file"""
filepath = os.path.join(self.cache_dir, url.split("/")[-1])
headers = {"User-Agent": "Inkscape"}
try:
remote = self.session.get(
url, headers=headers
) # needs UserAgent otherwise many 403 or 429 for wiki commons
except requests.exceptions.RequestException as err:
return None
except ConnectionError as err:
return None
except requests.exceptions.RequestsWarning:
pass
if remote and remote.status_code == 200:
with open(filepath, "wb") as fhl:
# If we don't have data, return None (instead of empty file)
if fhl.write(remote.content):
return filepath
return None
|
