-
-
Notifications
You must be signed in to change notification settings - Fork 307
/
locdownload.py
531 lines (442 loc) · 16.9 KB
/
locdownload.py
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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
"""
@package startup.locdownload
@brief GRASS Location Download Management
Classes:
- LocationDownloadPanel
- LocationDownloadDialog
- DownloadError
(C) 2017 by Vaclav Petras the GRASS Development Team
This program is free software under the GNU General Public License
(>=v2). Read the file COPYING that comes with GRASS for details.
@author Vaclav Petras <wenzeslaus gmail com>
"""
import os
import sys
import shutil
import textwrap
import time
import wx
from wx.lib.newevent import NewEvent
from grass.script.utils import try_rmdir, legalize_vector_name
from grass.utils.download import download_and_extract, name_from_url, DownloadError
from grass.grassdb.checks import is_location_valid
from grass.script.setup import set_gui_path
set_gui_path()
from core.debug import Debug
from core.gthread import gThread
from gui_core.wrap import Button, StaticText
# TODO: labels (and descriptions) translatable?
LOCATIONS = [
{
"label": "Complete NC location",
"url": "https://grass.osgeo.org/sampledata/north_carolina/nc_spm_08_grass7.tar.gz",
},
{
"label": "Basic NC location",
"url": "https://grass.osgeo.org/sampledata/north_carolina/nc_basic_spm_grass7.tar.gz",
},
{
"label": "World location in LatLong/WGS84",
"url": "https://grass.osgeo.org/sampledata/worldlocation.tar.gz",
},
{
"label": "Spearfish (SD) location",
"url": "https://grass.osgeo.org/sampledata/spearfish_grass70data-0.3.tar.gz",
},
{
"label": "Piemonte, Italy data set",
"url": "http://geodati.fmach.it/gfoss_geodata/libro_gfoss/grassdata_piemonte_utm32n_wgs84_grass7.tar.gz",
},
{
"label": "Slovakia 3D precipitation voxel data set",
"url": "https://grass.osgeo.org/sampledata/slovakia3d_grass7.tar.gz",
},
{
"label": "Fire simulation sample data",
"url": "https://grass.osgeo.org/sampledata/fire_grass6data.tar.gz",
},
{
"label": "GISMentors location, Czech Republic",
"url": "http://training.gismentors.eu/geodata/grass/gismentors.zip",
},
{
"label": "Natural Earth Dataset in WGS84",
"url": "https://zenodo.org/record/3968936/files/natural-earth-dataset.tar.gz",
"size": "207 MB",
"epsg": "4326",
"license": "ODC Public Domain Dedication and License 1.0",
"maintainer": "Brendan Harmon (brendan.harmon@gmail.com)",
},
]
class RedirectText(object):
def __init__(self, window):
self.out = window
def write(self, string):
try:
if self.out:
string = self._wrap_string(string)
heigth = self._get_heigth(string)
wx.CallAfter(self.out.SetLabel, string)
self._resize(heigth)
except:
# window closed -> PyDeadObjectError
pass
def flush(self):
pass
def _wrap_string(self, string, width=40):
"""Wrap string
:param str string: input string
:param int width: maximum length allowed of the wrapped lines
:return str: newline-separated string
"""
wrapper = textwrap.TextWrapper(width=width)
return wrapper.fill(text=string)
def _get_heigth(self, string):
"""Get widget new heigth
:param str string: input string
:return int: widget heigth
"""
n_lines = string.count("\n")
attr = self.out.GetClassDefaultAttributes()
font_size = attr.font.GetPointSize()
heigth = int((n_lines + 2) * font_size // 0.75) # 1 px = 0.75 pt
return heigth
def _resize(self, heigth=-1):
"""Resize widget heigth
:param int heigth: widget heigth
"""
wx.CallAfter(self.out.GetParent().SetMinSize, (-1, -1))
wx.CallAfter(self.out.SetMinSize, (-1, heigth))
wx.CallAfter(
self.out.GetParent().parent.sizer.Fit,
self.out.GetParent().parent,
)
# based on https://blog.shichao.io/2012/10/04/progress_speed_indicator_for_urlretrieve_in_python.html
def reporthook(count, block_size, total_size):
global start_time
if count == 0:
start_time = time.time()
sys.stdout.write(
_("Download in progress, wait until it is finished 0%"),
)
return
if count % 100 != 0: # be less verbose
return
duration = time.time() - start_time
progress_size = int(count * block_size)
speed = int(progress_size / (1024 * duration))
percent = int(count * block_size * 100 / total_size)
sys.stdout.write(
_(
"Download in progress, wait until it is finished "
"{0}%, {1} MB, {2} KB/s, {3:.0f} seconds passed".format(
percent,
progress_size / (1024 * 1024),
speed,
duration,
),
),
)
def download_location(url, name, database):
"""Wrapper to return DownloadError by value
It also moves the location directory to the database.
"""
try:
# TODO: the unpacking could go right to the path (but less
# robust) or replace copytree here with move
directory = download_and_extract(source=url, reporthook=reporthook)
destination = os.path.join(database, name)
if not is_location_valid(directory):
return _("Downloaded location is not valid")
shutil.copytree(src=directory, dst=destination)
try_rmdir(directory)
except DownloadError as error:
return error
return None
def location_name_from_url(url):
"""Create location name from URL"""
return legalize_vector_name(name_from_url(url))
DownloadDoneEvent, EVT_DOWNLOAD_DONE = NewEvent()
class LocationDownloadPanel(wx.Panel):
"""Panel to select and initiate downloads of locations.
Has a place to report errors to user and also any potential problems
before the user hits the button.
In the future, it can potentially show also some details about what
will be downloaded. The choice widget can be also replaced.
For the future, there can be multiple panels with different methods
or sources, e.g. direct input of URL. These can be in separate tabs
of one panel (perhaps sharing the common background download and
message logic).
"""
def __init__(self, parent, database, locations=LOCATIONS):
"""
:param database: directory with G database to download to
:param locations: list of dictionaries with label and url
"""
wx.Panel.__init__(self, parent=parent)
self.parent = parent
self._last_downloaded_location_name = None
self._download_in_progress = False
self.database = database
self.locations = locations
self._abort_btn_label = _("Abort")
self._abort_btn_tooltip = _("Abort download location")
self.label = StaticText(
parent=self, label=_("Select sample location to download:")
)
choices = []
for item in self.locations:
choices.append(item["label"])
self.choice = wx.Choice(parent=self, choices=choices)
self.choice.Bind(wx.EVT_CHOICE, self.OnChangeChoice)
self.parent.download_button.Bind(wx.EVT_BUTTON, self.OnDownload)
# TODO: add button for a link to an associated website?
# TODO: add thumbnail for each location?
# TODO: messages copied from gis_set.py, need this as API?
self.message = StaticText(parent=self, size=(-1, 50))
sys.stdout = RedirectText(self.message)
# It is not clear if all wx versions supports color, so try-except.
# The color itself may not be correct for all platforms/system settings
# but in http://xoomer.virgilio.it/infinity77/wxPython/Widgets/wx.SystemSettings.html
# there is no 'warning' color.
try:
self.message.SetForegroundColour(wx.Colour(255, 0, 0))
except AttributeError:
pass
self._layout()
default = 0
self.choice.SetSelection(default)
self.CheckItem(self.locations[default])
self.thread = gThread()
def _layout(self):
"""Create and layout sizers"""
vertical = wx.BoxSizer(wx.VERTICAL)
self.sizer = vertical
vertical.Add(
self.label,
proportion=0,
flag=wx.EXPAND | wx.TOP | wx.LEFT | wx.RIGHT,
border=10,
)
vertical.Add(
self.choice,
proportion=0,
flag=wx.EXPAND | wx.TOP | wx.LEFT | wx.RIGHT,
border=10,
)
vertical.AddStretchSpacer()
vertical.Add(
self.message,
proportion=0,
flag=wx.ALIGN_LEFT | wx.ALL | wx.EXPAND,
border=10,
)
self.SetSizer(vertical)
vertical.Fit(self)
self.Layout()
self.SetMinSize(self.GetBestSize())
def _change_download_btn_label(
self, label=_("Do&wnload"), tooltip=_("Download selected location")
):
"""Change download button label/tooltip"""
if self.parent.download_button:
self.parent.download_button.SetLabel(label)
self.parent.download_button.SetToolTip(tooltip)
def OnDownload(self, event):
"""Handle user-initiated action of download"""
button_label = self.parent.download_button.GetLabel()
if button_label in (_("Download"), _("Do&wnload")):
self._change_download_btn_label(
label=self._abort_btn_label,
tooltip=self._abort_btn_tooltip,
)
Debug.msg(1, "OnDownload")
if self._download_in_progress:
self._warning(_("Download in progress, wait until it is finished"))
index = self.choice.GetSelection()
self.DownloadItem(self.locations[index])
else:
self.parent.OnCancel()
def DownloadItem(self, item):
"""Download the selected item"""
Debug.msg(1, "DownloadItem: %s" % item)
# similar code as in CheckItem
url = item["url"]
dirname = location_name_from_url(url)
destination = os.path.join(self.database, dirname)
if os.path.exists(destination):
self._error(
_("Location named <%s> already exists," " download canceled") % dirname
)
self._change_download_btn_label()
return
def download_complete_callback(event):
self._download_in_progress = False
errors = event.ret
if errors:
self._error(_("Download failed: %s") % errors)
else:
self._last_downloaded_location_name = dirname
self._warning(
_(
"Download completed. The downloaded sample data is listed "
"in the location/mapset tabs upon closing of this window"
)
)
self._change_download_btn_label()
def terminate_download_callback(event):
# Clean up after urllib urlretrieve which is used internally
# in grass.utils.
from urllib import request # pylint: disable=import-outside-toplevel
self._download_in_progress = False
request.urlcleanup()
sys.stdout.write("Download aborted")
self.thread = gThread()
self._change_download_btn_label()
self._download_in_progress = True
self._warning(_("Download in progress, wait until it is finished"))
self.thread.Run(
callable=download_location,
url=url,
name=dirname,
database=self.database,
ondone=download_complete_callback,
onterminate=terminate_download_callback,
)
def OnChangeChoice(self, event):
"""React to user changing the selection"""
index = self.choice.GetSelection()
self.CheckItem(self.locations[index])
def CheckItem(self, item):
"""Check what user selected and report potential issues"""
# similar code as in DownloadItem
url = item["url"]
dirname = location_name_from_url(url)
destination = os.path.join(self.database, dirname)
if os.path.exists(destination):
self._warning(
_("Location named <%s> already exists," " rename it first") % dirname
)
self.parent.download_button.SetLabel(label=_("Download"))
return
else:
self._clearMessage()
def GetLocation(self):
"""Get the name of the last location downloaded by the user"""
return self._last_downloaded_location_name
def _warning(self, text):
"""Displays a warning, hint or info message to the user.
This function can be used for all kinds of messages except for
error messages.
.. note::
There is no cleaning procedure. You should call
_clearMessage() when you know that there is everything
correct.
"""
sys.stdout.write(text)
self.sizer.Layout()
def _error(self, text):
"""Displays a error message to the user.
This function should be used only when something serious and unexpected
happens, otherwise _showWarning should be used.
.. note::
There is no cleaning procedure. You should call
_clearMessage() when you know that there is everything
correct.
"""
sys.stdout.write(_("Error: {text}").format(text=text))
self.sizer.Layout()
def _clearMessage(self):
"""Clears/hides the error message."""
# we do no hide widget
# because we do not want the dialog to change the size
self.message.SetLabel("")
self.sizer.Layout()
class LocationDownloadDialog(wx.Dialog):
"""Dialog for download of locations
Contains the panel and Cancel button.
"""
def __init__(self, parent, database, title=_("Location Download")):
"""
:param database: database to download the location to
:param title: window title if the default is not appropriate
"""
wx.Dialog.__init__(self, parent=parent, title=title)
cancel_button = Button(self, id=wx.ID_CANCEL)
self.download_button = Button(parent=self, id=wx.ID_ANY, label=_("Do&wnload"))
self.download_button.SetToolTip(_("Download selected location"))
self.panel = LocationDownloadPanel(parent=self, database=database)
cancel_button.Bind(wx.EVT_BUTTON, self.OnCancel)
self.Bind(wx.EVT_CLOSE, self.OnCancel)
self.sizer = wx.BoxSizer(wx.VERTICAL)
self.sizer.Add(self.panel, proportion=1, flag=wx.EXPAND)
button_sizer = wx.StdDialogButtonSizer()
button_sizer.Add(
cancel_button,
proportion=0,
flag=wx.EXPAND | wx.LEFT | wx.RIGHT,
border=5,
)
button_sizer.Add(
self.download_button,
proportion=0,
flag=wx.EXPAND | wx.LEFT | wx.RIGHT,
border=5,
)
button_sizer.Realize()
self.sizer.Add(
button_sizer,
proportion=0,
flag=wx.ALIGN_RIGHT | wx.TOP | wx.BOTTOM,
border=10,
)
self.SetSizer(self.sizer)
self.sizer.Fit(self)
self.Layout()
def GetLocation(self):
"""Get the name of the last location downloaded by the user"""
return self.panel.GetLocation()
def OnCancel(self, event=None):
if self.panel._download_in_progress:
# running thread
dlg = wx.MessageDialog(
parent=self,
message=_("Do you want to cancel location download?"),
caption=_("Abort download"),
style=wx.YES_NO | wx.NO_DEFAULT | wx.ICON_QUESTION | wx.CENTRE,
)
ret = dlg.ShowModal()
dlg.Destroy()
if ret == wx.ID_NO:
return
else:
self.panel.thread.Terminate()
self.panel._change_download_btn_label()
if event:
self.EndModal(wx.ID_CANCEL)
def main():
"""Tests the download dialog"""
if len(sys.argv) < 2:
sys.exit("Provide a test directory")
database = sys.argv[1]
app = wx.App()
if len(sys.argv) == 2 or sys.argv[2] == "dialog":
window = LocationDownloadDialog(parent=None, database=database)
window.ShowModal()
location = window.GetLocation()
if location:
print(location)
window.Destroy()
elif sys.argv[2] == "panel":
window = wx.Dialog(parent=None)
panel = LocationDownloadPanel(parent=window, database=database)
window.ShowModal()
location = panel.GetLocation()
if location:
print(location)
window.Destroy()
else:
print("Unknown settings: try dialog or panel")
app.MainLoop()
if __name__ == "__main__":
main()