tpds-application 2.2.6__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
tpds/app/main.py ADDED
@@ -0,0 +1,530 @@
1
+ import os
2
+ import sys
3
+ import markdown
4
+ import requests
5
+ import webbrowser
6
+ from pathlib import Path
7
+
8
+ from .pyside_check import pyside2_check
9
+ # Checks if pyside2 is installed, if it is not installs it
10
+ pyside2_check()
11
+ from PySide2.QtCore import Slot, QSettings, QTimer, QUrl, Qt, QFileInfo, QDir
12
+ from PySide2.QtGui import QCloseEvent
13
+ from PySide2.QtWidgets import (
14
+ QMainWindow, QMessageBox, QInputDialog, QAction)
15
+ from PySide2.QtWebEngineWidgets import (
16
+ QWebEngineView, QWebEnginePage, QWebEngineSettings,
17
+ QWebEngineDownloadItem, QWebEngineProfile)
18
+
19
+ from urllib import parse
20
+ from bs4 import BeautifulSoup
21
+ from datetime import datetime
22
+
23
+ from tpds.helper import LogFacility, log, make_dir
24
+ from tpds.settings import TrustPlatformSettings
25
+ from tpds.update import get_pkg_versions, CheckUpdates
26
+
27
+ from .ui import SettingsDialog, PackageManagerUi
28
+ from .control import shutdown
29
+ from .docks import LoggerDock
30
+ from .tools import WebViewStacked
31
+ from .network import NetworkTools
32
+ from .vars import get_app_ref, get_url_base, dict_pckg, SETTING_GEOMETRY
33
+
34
+ class WebEnginePage(QWebEnginePage):
35
+ def __init__(self, *args, **kwargs):
36
+ QWebEnginePage.__init__(self, *args, **kwargs)
37
+ self.profile().setHttpCacheType(QWebEngineProfile.NoCache)
38
+ self.profile().downloadRequested.connect(self.on_downloadRequested)
39
+
40
+ def javaScriptConsoleMessage(self, level, msg, line, sourceID):
41
+ log(
42
+ f'''JS:{sourceID} Line#{line}: '''
43
+ f'''{msg.encode('ascii', 'ignore')}''')
44
+
45
+ @Slot(QWebEngineDownloadItem)
46
+ def on_downloadRequested(self, download):
47
+ directory = os.path.join(
48
+ str(QDir.homePath()),
49
+ 'Downloads',
50
+ 'TPDS_Downloads')
51
+ make_dir(directory)
52
+ filename = \
53
+ QFileInfo(download.path()).baseName() + \
54
+ '_' + datetime.now().strftime("%m%d%H%M%S") + \
55
+ '.' + QFileInfo(download.path()).suffix()
56
+ download.setPath(QDir(directory).filePath(filename))
57
+ download.accept()
58
+
59
+
60
+ class CustomWebView(QWebEngineView):
61
+ def __init__(self, mainwindow, main=False):
62
+ super(CustomWebView, self).__init__(None)
63
+ self._log = LogFacility()
64
+ self.parent = mainwindow
65
+ self.tabIndex = -1
66
+ self.main = main
67
+ self.setPage(WebEnginePage(self))
68
+ self.loadedPage = None
69
+ self.urlChanged.connect(self._handle_url_change)
70
+ self.loadStarted.connect(self.loadingpage)
71
+ self.loadFinished.connect(self.onpagechange)
72
+ self._web_address = ''
73
+ self.settings().setAttribute(
74
+ QWebEngineSettings.PluginsEnabled, True)
75
+ self.settings().setAttribute(
76
+ QWebEngineSettings.JavascriptEnabled, True)
77
+ self.settings().setAttribute(
78
+ QWebEngineSettings.PdfViewerEnabled, True)
79
+
80
+ def set_jupyter_address(self, web_address):
81
+ self._web_address = web_address
82
+
83
+ def getPageTitle(self, url):
84
+ reqs = requests.get(url)
85
+ parse = BeautifulSoup(reqs.text, 'html.parser')
86
+ title_list = parse.find_all('title')
87
+ filename = self.url().fileName()
88
+ if len(title_list):
89
+ filename = title_list[0].get_text()
90
+ return filename
91
+
92
+ def checkInstance(self, name):
93
+ for i in range(self.parent.viewstack.count()):
94
+ window = self.parent.viewstack.widget(i)
95
+ tab = window.url().toString()
96
+ if tab.startswith('http'):
97
+ filename = self.getPageTitle(tab)
98
+ else:
99
+ filename = window.url().fileName()
100
+ if filename == name:
101
+ self.parent.viewstack.activateWebView(
102
+ self.parent.viewstack.wpage.index(window), False)
103
+ return True
104
+ return False
105
+
106
+ @Slot()
107
+ def loadingpage(self):
108
+ if get_app_ref().backend._config.settings.develop:
109
+ # Dont load voila page from Notebook window
110
+ for js in get_app_ref().backend._voila:
111
+ nb_voila = f'{js._web_address}voila'
112
+ if nb_voila in self.url().toString():
113
+ QTimer.singleShot(0, self.close)
114
+
115
+ @Slot(bool)
116
+ def onpagechange(self, ok):
117
+ self._log.log(f'onpagechange {self.url().toString()}, {self.url().host()}')
118
+ if self.url().fileName().find('ipynb') > 0:
119
+ is_notebook = True
120
+ else:
121
+ is_notebook = False
122
+
123
+ view_title = self.title()
124
+ if view_title is None:
125
+ view_title, _ = os.path.splitext(self.url().fileName())
126
+
127
+ if is_notebook:
128
+ self.parent.viewstack.updateView(
129
+ view_title,
130
+ self.parent.viewstack.npage.index(self),
131
+ is_notebook)
132
+ else:
133
+ self.parent.viewstack.updateView(
134
+ view_title,
135
+ self.parent.viewstack.wpage.index(self),
136
+ is_notebook)
137
+ if self.url().hasQuery() is True:
138
+ if self.loadedPage is not None:
139
+ self._log.log("disconnecting on close and link clicked signal")
140
+ self.loadedPage.windowCloseRequested.disconnect(self.close)
141
+ self.loadedPage = self.page()
142
+ self.loadedPage.windowCloseRequested.connect(self.close)
143
+ self.setWindowTitle(self.title())
144
+ if not self.main:
145
+ pass
146
+ if not ok:
147
+ QMessageBox.information(
148
+ self,
149
+ "Error",
150
+ "Error loading page!",
151
+ QMessageBox.Ok)
152
+
153
+ for i in range(self.parent.viewstack.count()):
154
+ window = self.parent.viewstack.widget(i)
155
+ if(self == window):
156
+ break
157
+ elif(window.url().fileName() == self.url().fileName()):
158
+ if self.parent.viewstack.ordPages[window]:
159
+ self.parent.viewstack.removeWebView(
160
+ self.parent.viewstack.npage.index(self), True)
161
+ self.parent.viewstack.activateWebView(
162
+ self.parent.viewstack.npage.index(window), True)
163
+ else:
164
+ self._log.log(f'{repr(self.parent.viewstack.wpage)} - {repr(self)}')
165
+ self.parent.viewstack.removeWebView(
166
+ self.parent.viewstack.wpage.index(self), False)
167
+ self.parent.viewstack.activateWebView(
168
+ self.parent.viewstack.wpage.index(window), False)
169
+ QTimer.singleShot(0, self.close)
170
+ break
171
+
172
+ @Slot(QUrl)
173
+ def _handle_url_change(self, url: QUrl):
174
+ if url.scheme() != 'file':
175
+ host = url.host()
176
+ if host.lower() not in ['127.0.0.1', 'localhost']:
177
+ try:
178
+ webbrowser.open(self.url().toString(), new=2)
179
+ QTimer.singleShot(0, self.close)
180
+ except Exception as e:
181
+ self._log.log(str(e))
182
+
183
+ @Slot(QUrl)
184
+ def handlelink(self, url: QUrl):
185
+ urlstr = url.toString()
186
+ self._log.log("handling link : %s" % urlstr)
187
+ # check if url is for the current page
188
+ if url.hasQuery() is True:
189
+ parsed_url = parse.urlparse(urlstr)
190
+ query = parse.parse_qs(parsed_url.query)
191
+ self._log.log('handlelink - quer: %s' % query)
192
+ if url.matches(self.url(),
193
+ QUrl.FormattingOptions(QUrl.RemoveFragment)):
194
+ # do nothing, probably a JS link
195
+ return True
196
+ # check other windows to see if url is loaded there
197
+ for i in range(self.parent.viewstack.count()):
198
+ window = self.parent.viewstack.widget(i)
199
+ if url.matches(window.url(),
200
+ QUrl.FormattingOptions(QUrl.RemoveFragment)):
201
+ # self.parent.viewstack.setCurrentIndex(i)
202
+ # if this is a tree window and not the main one, close it
203
+ if self.url().toString().startswith(
204
+ self.parent.homepage.toString() + "tree") and \
205
+ not self.main:
206
+ QTimer.singleShot(0, self.close) # don't call self.close()
207
+ return True
208
+
209
+ if "/files/" in urlstr:
210
+ # save, don't load new page
211
+ self.parent.savefile(url)
212
+ elif "/tree/" in urlstr or urlstr.startswith(
213
+ self.parent.homepage.toString() + "tree"):
214
+ # keep in same window
215
+ self.load(url)
216
+ elif "https" in urlstr:
217
+ newwindow = self.parent.createBrowserTab(
218
+ QWebEnginePage.WebBrowserWindow,
219
+ js=False, notebook=False)
220
+ newwindow.load(url)
221
+ elif ".html" in urlstr:
222
+ newwindow = self.parent.createBrowserTab(
223
+ QWebEnginePage.WebBrowserWindow,
224
+ js=False, notebook=False)
225
+ newwindow.load(url)
226
+ else:
227
+ # open in new window
228
+ # the link is a notebook
229
+ newwindow = self.parent.createBrowserTab(
230
+ QWebEnginePage.WebBrowserWindow,
231
+ js=False, notebook=True)
232
+ newwindow.load(url)
233
+ # if this is a tree window and not the main one, close it
234
+
235
+ if self.url().toString().startswith(
236
+ self.parent.homepage.toString() + "/tree") and not self.main:
237
+ QTimer.singleShot(0, self.close) # calling self.close() is no good
238
+ return True
239
+
240
+ def createWindow(self, windowtype):
241
+ return self.parent.createBrowserTab(windowtype, js=True)
242
+
243
+ def closeEvent(self, event):
244
+ if self.loadedPage is not None:
245
+ # helper.log("disconnecting on close and linkClicked signals")
246
+ self.loadedPage.windowCloseRequested.disconnect(self.close)
247
+
248
+ if not self.main:
249
+ if self in self.parent.windows:
250
+ if self.parent.viewstack.ordPages[self]:
251
+ self.parent.viewstack.removeWebView(
252
+ self.parent.viewstack.npage.index(self), True)
253
+ else:
254
+ self.parent.viewstack.removeWebView(
255
+ self.parent.viewstack.wpage.index(self), False)
256
+ self.parent.viewstack.removeWebView(
257
+ self.parent.viewstack.indexOf(self))
258
+ self.parent.windows.remove(self)
259
+ event.accept()
260
+
261
+
262
+ class MainWindow(QMainWindow):
263
+ def __init__(self, parent=None, homepage=None, log_view=True):
264
+ super(MainWindow, self).__init__(parent)
265
+ self._log = LogFacility()
266
+ self.homepage = homepage
267
+ self.windows = []
268
+ if log_view is True:
269
+ self.loggerdock = LoggerDock("Log Message", self)
270
+ self.addDockWidget(Qt.BottomDockWidgetArea, self.loggerdock)
271
+ self.viewstack = WebViewStacked(self)
272
+ self.settings = QSettings()
273
+ self.network = NetworkTools()
274
+ """ Check whether the TPDS application has valid settings
275
+ If not prompt for fixing them.
276
+ By the time we get here, settings must have been created and checked.
277
+ If they are still missing, bail out..
278
+ """
279
+ try:
280
+ self.tpds_settings_root = TrustPlatformSettings()
281
+ self.tpds_settings = self.tpds_settings_root.settings
282
+ except FileNotFoundError:
283
+ # TODO: copy a default file into the $HOME/.trustplatform folder
284
+ # and retry
285
+ QMessageBox.critical(
286
+ self,
287
+ "Settings",
288
+ "Configuration file missing. Please re-install the software\n")
289
+ sys.exit()
290
+
291
+ val = self.settings.value(SETTING_GEOMETRY, None)
292
+ if val is not None:
293
+ self.restoreGeometry(val)
294
+ self.initUI()
295
+
296
+ def initUI(self):
297
+ self.basewebview = CustomWebView(self, main=True)
298
+ self.windows.append(self.basewebview)
299
+ self.setCentralWidget(self.viewstack)
300
+ self.viewstack.addWebView(
301
+ "Home",
302
+ self.basewebview,
303
+ False)
304
+ self._web_address = ''
305
+
306
+ # Status Bar
307
+ self.statusbar = self.statusBar()
308
+
309
+ # Menu Bar
310
+ self.menubar = self.menuBar()
311
+ self.menubar.setNativeMenuBar(False)
312
+
313
+ # Add File menu entry
314
+ self.file_menu = self.menubar.addMenu("&File")
315
+ # Add Preferences menu entry to File
316
+ self.settings_action = QAction('&Preferences', self)
317
+ self.settings_action.setShortcut('Ctrl+P')
318
+ self.settings_action.triggered.connect(self.open_settings)
319
+ self.file_menu.addAction(self.settings_action)
320
+ # Add Quit menu entry into File
321
+ self.exit_action = QAction('&Quit', self)
322
+ self.exit_action.setShortcut('Ctrl+Q')
323
+ self.exit_action.triggered.connect(shutdown)
324
+ self.file_menu.addAction(self.exit_action)
325
+
326
+ # Add Packages menu entry
327
+ self.packages_menu = self.menubar.addMenu("&Packages")
328
+ # Add Check for Updates menu entry into Help
329
+ self.package_manager = QAction('&Package Manager', self)
330
+ self.packages_menu.addAction(self.package_manager)
331
+ self.package_manager.triggered.connect(self.package_manager_action)
332
+ #Add Check for Updates menu entry into Help
333
+ self.check_updates = QAction('&Check for Updates...', self)
334
+ self.packages_menu.addAction(self.check_updates)
335
+ self.check_updates.triggered.connect(self.check_updates_action)
336
+
337
+ # Add Help menu entry
338
+ self.help_menu = self.menubar.addMenu("&Help")
339
+ # Add help documentation though markdown docs
340
+ self.help_doc = QAction('&Documentation', self)
341
+ self.help_menu.addAction(self.help_doc)
342
+ self.help_doc.triggered.connect(self.process_documentation)
343
+ # Add api documentation
344
+ if self.tpds_settings.develop:
345
+ self.api_doc = QAction('&API Documentation', self)
346
+ self.help_menu.addAction(self.api_doc)
347
+ self.api_doc.triggered.connect(self.process_api_docs)
348
+ # Add Release Notes
349
+ self.release_notes = QAction('&Release Notes', self)
350
+ self.help_menu.addAction(self.release_notes)
351
+ self.release_notes.triggered.connect(self.open_release_notes)
352
+ # Add Report Issue
353
+ self.report_issue = QAction('&Report Issue', self)
354
+ self.help_menu.addAction(self.report_issue)
355
+ self.report_issue.triggered.connect(self.process_report_issue)
356
+ # Add view license
357
+ self.view_license = QAction('&View License', self)
358
+ self.help_menu.addAction(self.view_license)
359
+ self.view_license.triggered.connect(self.process_view_license)
360
+ # Add About menu entry into Help
361
+ self.about = QAction('&About', self)
362
+ self.help_menu.addAction(self.about)
363
+ self.about.triggered.connect(self.about_action)
364
+
365
+ self.statusbar = self.statusBar()
366
+ self.show()
367
+
368
+ def open_settings(self):
369
+ self._log.log('open settings dialog')
370
+ self.settings_dlg = SettingsDialog(
371
+ TrustPlatformSettings())
372
+ self.settings_dlg.exec()
373
+
374
+ def set_jupyter_address(self, web_address):
375
+ self._web_address = web_address
376
+ self.basewebview.set_jupyter_address(web_address)
377
+
378
+ def loadmain(self, homepage):
379
+ self.homepage = homepage
380
+ QTimer.singleShot(0, self.initialload)
381
+
382
+ def createBrowserTab(self, windowtype, js=True, notebook=False):
383
+ v = CustomWebView(self)
384
+ v.set_jupyter_address(v.url().fileName())
385
+ self.windows.append(v)
386
+ self.viewstack.addWebView(
387
+ v.url().fileName(), v, notebook)
388
+ return v
389
+
390
+ def open_release_notes(self):
391
+ newwindow = self.createBrowserTab(
392
+ QWebEnginePage.WebBrowserWindow,
393
+ js=False, notebook=False)
394
+ newwindow.setUrl(QUrl(f'{get_url_base()}/ReleaseNotes.html'))
395
+
396
+ def about_action(self):
397
+ self._log.log('Open About dialog')
398
+ pkg_versions = get_pkg_versions()
399
+ version_info = (
400
+ '''<font color=#0000ff><b>Trust Platform Design Suite</b></font><br>
401
+ <br>Package versions:<br>'''
402
+ )
403
+ msg_box = QMessageBox()
404
+ if pkg_versions:
405
+ for package in pkg_versions:
406
+ version_info += (
407
+ f'''&emsp;{package.name}'''
408
+ f'''({package.channel}): '''
409
+ f'''<b>{package.installed}</b><br>''')
410
+ msg_box.setIcon(QMessageBox.Information)
411
+ msg_box.setText(version_info)
412
+ else:
413
+ msg_box.setIcon(QMessageBox.Critical)
414
+ msg_box.setText(
415
+ 'Fetching version details... Try after few seconds!')
416
+ msg_box.setStandardButtons(QMessageBox.Ok)
417
+ msg_box.setWindowTitle('About - Trust Platform Design Suite')
418
+ msg_box.exec_()
419
+
420
+ def check_updates_action(self):
421
+ self._log.log('Open Check for Updates dialog')
422
+ self.network.network_check_thread(self.check_updates_routine)
423
+
424
+ def check_updates_routine(self, internet_available):
425
+ if internet_available:
426
+ CheckUpdates(prompt_for_no_updates=True)
427
+ else:
428
+ nw_message = QMessageBox()
429
+ nw_message.setIcon(QMessageBox.Warning)
430
+ nw_message.setWindowTitle('Network')
431
+ nw_message.setText((
432
+ '''<font color=#0000ff><b>Internet connection is down</b></font><br>
433
+ <br>Check connection and try again<br>'''
434
+ ))
435
+ nw_message.setStandardButtons(QMessageBox.Ok)
436
+ nw_message.exec()
437
+
438
+ def package_manager_action(self):
439
+ self.pkg_manager_ui = PackageManagerUi()
440
+ self.pkg_manager_ui.show()
441
+
442
+ def process_documentation(self):
443
+ newwindow = self.createBrowserTab(
444
+ QWebEnginePage.WebBrowserWindow,
445
+ js=False, notebook=False)
446
+ newwindow.setUrl(QUrl(f'{get_url_base()}/Documentation.html'))
447
+
448
+ def process_api_docs(self):
449
+ newwindow = self.createBrowserTab(
450
+ QWebEnginePage.WebBrowserWindow,
451
+ js=True, notebook=False)
452
+ newwindow.setUrl(QUrl(f'{get_url_base()}/docs'))
453
+
454
+ def process_report_issue(self):
455
+ pkg_versions = get_pkg_versions()
456
+ if pkg_versions:
457
+ items = ['Bug Report', 'Feature Request']
458
+ label_description = (
459
+ '''<font color=#0000ff><b>Report Issue on GItHub TPDS Issue Tracker</b></font><br>
460
+ <br>Select report type and Click OK to report issue.
461
+ <br><br>GitHub TPDS Issue Tracker requires User to Signin to GitHub account.
462
+ <br>If GitHub account is unavailable, Click on 'Create an account' in next step and follow instructions. <br>''')
463
+ item, ok = QInputDialog.getItem(
464
+ None, 'Report Issue', label_description,
465
+ items, 0, False)
466
+ version_info = ''
467
+ for package in pkg_versions:
468
+ version_info += f'#### {package.name}: {package.installed}\n'
469
+
470
+ if ok and item:
471
+ github_link = (
472
+ 'https://github.com/Microchip-TrustPlatformDesignSuite/'
473
+ 'TPDS-Issue-Tracker/issues/new?')
474
+ custom_info = {
475
+ 'body': (
476
+ f'''Issue Type: <b>{item}</b>\n'''
477
+ f'''{version_info}\n\n'''
478
+ f'''<!-- Add Issue description below -->\n'''
479
+ )}
480
+ custom_link = parse.urlencode(custom_info)
481
+ newwindow = self.createBrowserTab(
482
+ QWebEnginePage.WebBrowserWindow,
483
+ js=False, notebook=False)
484
+ newwindow.setUrl(QUrl(f'{github_link}{custom_link}'))
485
+ else:
486
+ msg_box = QMessageBox()
487
+ msg_box.setIcon(QMessageBox.Critical)
488
+ msg_box.setStandardButtons(QMessageBox.Ok)
489
+ msg_box.setWindowTitle('Report Issue')
490
+ msg_box.setText('Fetching version details... Try after few seconds!')
491
+ msg_box.exec_()
492
+
493
+ def process_view_license(self):
494
+ import tpds
495
+ render_path = os.path.join(tpds.__path__[0], 'licenses.txt')
496
+ newwindow = self.createBrowserTab(
497
+ QWebEnginePage.WebBrowserWindow,
498
+ js=False, notebook=False)
499
+ newwindow.setUrl(QUrl('file:///'+render_path.replace("\\", "/")))
500
+
501
+ @Slot(int)
502
+ def destroyBrowserTab(self, which):
503
+ closeevent = QCloseEvent()
504
+ win = self.tabs.widget(which)
505
+ if win.main:
506
+ self.close()
507
+ else:
508
+ win.closeEvent(closeevent)
509
+ if closeevent.isAccepted():
510
+ self.tabs.removeTab(which)
511
+
512
+ @Slot()
513
+ def initialload(self):
514
+ if self.homepage:
515
+ self.basewebview.load(QUrl(self.homepage))
516
+ self.show()
517
+
518
+ def savefile(self, url):
519
+ pass
520
+
521
+ def closeEvent(self, event):
522
+ settings = QSettings()
523
+ settings.setValue(SETTING_GEOMETRY, self.saveGeometry())
524
+ if len(self.windows) >= 1:
525
+ if not shutdown():
526
+ event.ignore()
527
+ return
528
+ else:
529
+ event.accept()
530
+
tpds/app/network.py ADDED
@@ -0,0 +1,28 @@
1
+ import requests
2
+
3
+ from PySide2.QtCore import QThreadPool
4
+
5
+ from tpds.worker import Worker
6
+
7
+ class NetworkTools():
8
+ def __init__(self):
9
+ pass
10
+
11
+ @staticmethod
12
+ def network_check():
13
+ urls_to_ping = [
14
+ "https://www.google.com/", "https://www.google.com.hk/",
15
+ "https://github.com/", "https://gitee.com/",
16
+ "https://www.microchip.com/"]
17
+ for url in urls_to_ping:
18
+ try:
19
+ r = requests.head(url, timeout=3)
20
+ return True
21
+ except requests.ConnectionError as ex:
22
+ pass
23
+ return False
24
+
25
+ def network_check_thread(self, fn):
26
+ self.worker_obj = Worker(self.network_check)
27
+ self.worker_obj.signals.result.connect(fn)
28
+ QThreadPool.globalInstance().start(self.worker_obj)