/
exporter.py
468 lines (385 loc) · 14 KB
/
exporter.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
# -*- coding: utf-8 -*-
# Copyright (C) 2017 Nyall Dawson (nyall.dawson@gmail.com)
#
# 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 2 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, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
import os
from datetime import datetime
import ftplib
from qgis.core import QgsProject
from qgis.PyQt.QtCore import QObject
from qgis.PyQt.QtWidgets import QFileDialog, QInputDialog, QDialog, QLineEdit
from .utils import tempFolder
from .feedbackDialog import Feedback
from .ui_ftp_configuration import Ui_FtpConfiguration
translator = QObject()
class Exporter(QObject):
"""
Generic base class for web map exporters
"""
def __init__(self):
super(QObject, self).__init__()
@classmethod
def type(cls):
"""
:return: Unique string for exporter type
"""
return ''
@classmethod
def name(cls):
"""
:return: Translated, user friendly name for exporter
"""
return ''
def configure(self):
"""
Opens a dialog allowing users to configure the exporter's settings
"""
pass
def exportDirectory(self):
"""
:return: Directory to create output HTML and associated
files in. For some exporters this will indicate the final
destination of the output, for others this will be a temporary
folder which is later copied to a final destination.
"""
return ''
def postProcess(self, results, feedback=None):
"""
Called after HTML output is created and written
to the exportDirectory(). Can be used to perform
steps such as uploading the exported files to a remote
location.
:param results: WriterResults from Writer generation
:param feedback: optional feedback object for progress reports
Returns True if processing was successful
"""
pass
def destinationUrl(self):
"""
:return: URL corresponding to final location for exported
web map. This URL should be accessible in a web browser.
"""
return ''
def writeToProject(self):
"""
Writes the exporter's settings to the current project.
"""
pass
def readFromProject(self):
"""
Reads the exporter's settings from the current project.
"""
pass
class FolderExporter(Exporter):
"""
Exporter for writing web map to a folder
"""
def __init__(self):
super(Exporter, self).__init__()
self.folder = tempFolder()
self.export_file = None
@classmethod
def type(cls):
return 'folder'
@classmethod
def name(cls):
return QObject.tr(translator, 'Export to folder')
def configure(self, parent_widget=None):
new_folder = \
QFileDialog.getExistingDirectory(parent_widget,
self.tr("Choose export folder"),
self.folder,
QFileDialog.ShowDirsOnly)
if new_folder:
self.folder = new_folder
def exportDirectory(self):
return self.folder
def postProcess(self, results, feedback=None):
if not feedback:
feedback = Feedback()
self.export_file = results.index_file
feedback.setCompleted('Exported to {}'.format(self.folder))
return True
def destinationUrl(self):
return self.export_file
def writeToProject(self):
QgsProject.instance().writeEntry("qgis2web",
"Exportfolder",
self.folder)
def readFromProject(self):
folder, ok = QgsProject.instance().readEntry("qgis2web",
"Exportfolder")
if ok and folder:
self.folder = folder
class FtpConfigurationDialog(QDialog, Ui_FtpConfiguration):
"""
A dialog for configuring FTP connection details such as host
and username
"""
def __init__(self, parent=None):
QDialog.__init__(self, parent)
self.setupUi(self)
def setHost(self, host):
"""
Sets the host name to initially show in the dialog
"""
self.hostLineEdit.setText(host)
def setPort(self, port):
"""
Sets the port to initially show in the dialog
"""
try:
port_number = int(port)
self.portSpinBox.setValue(port_number)
except Exception:
pass
def setUsername(self, username):
"""
Sets the username to initially show in the dialog
"""
self.usernameLineEdit.setText(username)
def setFolder(self, folder):
"""
Sets the folder to initially show in the dialog
"""
self.folderLineEdit.setText(folder)
def host(self):
"""
Returns the current host name from the dialog
"""
return self.hostLineEdit.text()
def username(self):
"""
Returns the current user name from the dialog
"""
return self.usernameLineEdit.text()
def folder(self):
"""
Returns the current folder from the dialog
"""
return self.folderLineEdit.text()
def port(self):
"""
Returns the current port from the dialog
"""
return self.portSpinBox.value()
class FtpExporter(Exporter):
"""
Exporter for writing web map to an FTP site
"""
def __init__(self):
super(Exporter, self).__init__()
# some default values
self.host = 'myhost.com'
self.username = 'user'
self.remote_folder = 'public_html/'
self.port = 21
# if none, user will be prompted for password
self.password = None
self.temp_folder = self.newTempFolder(tempFolder())
def newTempFolder(self, base):
stamp = datetime.now().strftime("%Y_%m_%d-%H_%M_%S_%f")
return os.path.join(base, 'qgis2web_' + stamp)
@classmethod
def type(cls):
return 'ftp'
@classmethod
def name(cls):
return QObject.tr(translator, 'Export to FTP site')
def configure(self, parent_widget=None):
dialog = FtpConfigurationDialog(parent_widget)
dialog.setHost(self.host)
dialog.setUsername(self.username)
dialog.setPort(self.port)
dialog.setFolder(self.remote_folder)
if dialog.exec_():
self.host = dialog.host()
self.username = dialog.username()
self.port = dialog.port()
self.remote_folder = dialog.folder()
def exportDirectory(self):
return self.temp_folder
def postProcess(self, results, feedback=None):
if not feedback:
feedback = Feedback()
self.export_file = results.index_file
file_count = max(len(results.files), 1)
# generate a new temp_folder for next export
self.temp_folder = self.newTempFolder(tempFolder())
source_folder = results.folder
if not self.host or not self.username or not self.port:
return False
# get password
password = self.password
if password is None:
password, ok = QInputDialog.getText(
None, 'Enter FTP password', 'Password', QLineEdit.Password)
if not password or not ok:
feedback.setFatalError('User cancelled')
return False
feedback.showFeedback(
'Connecting to {} on port {}...'.format(self.host, self.port))
ftp = ftplib.FTP()
try:
ftp.connect(self.host, self.port)
except Exception:
feedback.setFatalError('Could not connect to server!')
return False
feedback.showFeedback('Connected!')
feedback.showFeedback('Logging in as {}...'.format(self.username))
if feedback.cancelled():
feedback.acceptCancel()
return False
try:
ftp.login(self.username, password)
except Exception:
feedback.setFatalError("""Login failed for
user {}!""".format(self.username))
return False
feedback.showFeedback('Logged in to {}'.format(self.host))
def cwd_and_create(p):
"""
recursively changes directory to an ftp target,
creating new folders as required.
"""
if not p:
return
try:
ftp.cwd(p)
except Exception:
parent, base = os.path.split(p)
cwd_and_create(parent)
if base:
feedback.showFeedback('Creating {}'.format(base))
ftp.mkd(base)
ftp.cwd(base)
cwd_and_create(self.remote_folder)
feedback.uploaded_count = 0.0
def uploadPath(path):
if feedback.cancelled():
feedback.acceptCancel()
return False
files = os.listdir(path)
os.chdir(path)
for f in files:
if feedback.cancelled():
feedback.acceptCancel()
return False
current_path = os.path.join(path, f)
if os.path.isfile(current_path):
feedback.showFeedback('Uploading {}'.format(f))
fh = open(f, 'rb')
ftp.storbinary('STOR %s' % f, fh)
fh.close()
feedback.uploaded_count += 1
feedback.setProgress(
100 * feedback.uploaded_count / file_count)
elif os.path.isdir(current_path):
feedback.showFeedback('Creating folder {}'.format(f))
try:
ftp.mkd(f)
except Exception:
pass
ftp.cwd(f)
if not uploadPath(current_path):
return False
ftp.cwd('..')
os.chdir('..')
return True
if not uploadPath(os.path.join('.', source_folder)):
return False
feedback.setCompleted('Upload complete!')
ftp.close()
return True
def destinationUrl(self):
return self.export_file
def writeToProject(self):
QgsProject.instance().writeEntry("qgis2web",
"FtpHost",
self.host)
QgsProject.instance().writeEntry("qgis2web",
"FtpUser",
self.username)
QgsProject.instance().writeEntry("qgis2web",
"FtpFolder",
self.remote_folder)
QgsProject.instance().writeEntry("qgis2web",
"FtpPort",
self.port)
def readFromProject(self):
host, ok = QgsProject.instance().readEntry("qgis2web",
"FtpHost")
if ok and host:
self.host = host
user, ok = QgsProject.instance().readEntry("qgis2web",
"FtpUser")
if ok and user:
self.username = user
folder, ok = QgsProject.instance().readEntry("qgis2web",
"FtpFolder")
if ok and user:
self.remote_folder = folder
port, ok = QgsProject.instance().readNumEntry("qgis2web",
"FtpPort")
if ok and port:
self.port = port
class ExporterRegistry(QObject):
"""
Registry for managing the available exporter options.
This is not usually created directly but instead accessed
through to canonical EXPORTER_REGISTRY instance.
"""
def __init__(self, parent=None):
super(ExporterRegistry, self).__init__(parent)
self.exporters = {e.type(): e for e in
[FolderExporter, FtpExporter]}
def getExporters(self):
"""
:return: List of available exporters
"""
return self.exporters.values()
def createFromProject(self):
"""
Creates a new exporter by reading the corresponding exporter type
and settings from the current project.
:return: new exporter
"""
type, ok = QgsProject.instance().readEntry("qgis2web",
"Exporter")
exporter = None
if ok and type:
try:
exporter = self.exporters[type]()
except Exception:
pass
if not exporter:
exporter = FolderExporter() # default
exporter.readFromProject()
return exporter
def writeToProject(self, exporter):
"""
Writes an exporters settings to the current project and stores the
exporter type as the active exporter.
"""
QgsProject.instance().writeEntry("qgis2web",
"Exporter", exporter.type())
exporter.writeToProject()
def getOptions(self):
"""
:return: tuple for use within getParams call
"""
return tuple([e.name() for e in self.exporters.values()])
# canonical instance.
EXPORTER_REGISTRY = ExporterRegistry()