-
Notifications
You must be signed in to change notification settings - Fork 260
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #308 from austinmatherne-wk/247-arellegui-fails-to…
…-download-update Fix Updater module
- Loading branch information
Showing
6 changed files
with
486 additions
and
89 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,86 +1,159 @@ | ||
| ''' | ||
| """ | ||
| Created on May 30, 2010 | ||
| @author: Mark V Systems Limited | ||
| (c) Copyright 2011 Mark V Systems Limited, All rights reserved. | ||
| ''' | ||
| import tkinter.messagebox, webbrowser, os, threading | ||
|
|
||
| def checkForUpdates(cntlr): | ||
| if not cntlr.webCache.workOffline: | ||
| # check for updates in background | ||
| import threading | ||
| thread = threading.Thread(target=lambda c=cntlr: backgroundCheckForUpdates(c)) | ||
| thread.daemon = True | ||
| thread.start() | ||
|
|
||
| def backgroundCheckForUpdates(cntlr): | ||
| actualUrl = None | ||
| """ | ||
| from __future__ import annotations | ||
|
|
||
| import gettext | ||
| import os | ||
| import subprocess | ||
| import sys | ||
| import threading | ||
| import tkinter.messagebox | ||
| import typing | ||
| from datetime import date | ||
|
|
||
| import regex | ||
|
|
||
| from arelle import Version | ||
|
|
||
| if typing.TYPE_CHECKING: | ||
| from arelle.CntlrWinMain import CntlrWinMain | ||
|
|
||
| _ = gettext.gettext | ||
|
|
||
| _MESSAGE_HEADER = "arelle\u2122 - Updater" | ||
| _ISO_DATE_PATTERN = regex.compile( | ||
| r"(?P<date>(?P<year>[0-9]{4})-(?P<month>0[1-9]|1[0-2])-(?P<day>0[1-9]|[12][0-9]|3[01]))" | ||
| ) | ||
|
|
||
|
|
||
| def checkForUpdates(cntlr: CntlrWinMain) -> None: | ||
| thread = threading.Thread(daemon=True, target=lambda c=cntlr: _checkForUpdates(c)) | ||
| thread.start() | ||
|
|
||
|
|
||
| def _checkForUpdates(cntlr: CntlrWinMain) -> None: | ||
| if cntlr.updateURL is None: | ||
| _showInfo( | ||
| cntlr, | ||
| _( | ||
| """ | ||
| Operating system not supported by update checker. | ||
| Please go to arelle.org to check for updates. | ||
| """ | ||
| ), | ||
| ) | ||
| return | ||
| if cntlr.webCache.workOffline: | ||
| _showInfo(cntlr, _("Disable offline mode to check for updates.")) | ||
| return | ||
| cntlr.showStatus(_("Checking for updates to Arelle")) | ||
| try: | ||
| attachmentFileName = cntlr.webCache.getAttachmentFilename(cntlr.updateURL) | ||
| if attachmentFileName: | ||
| cntlr.showStatus("") # clear web loading status entry | ||
| cntlr.uiThreadQueue.put((checkUpdateUrl, [cntlr, attachmentFileName])) | ||
| except: | ||
| pass | ||
| cntlr.showStatus("") # clear web loading status entry | ||
|
|
||
| def checkUpdateUrl(cntlr, attachmentFileName): | ||
| # get latest header file | ||
| except RuntimeError as e: | ||
| _showWarning( | ||
| cntlr, | ||
| _("Failed to check for updates. URL {0}, {1}").format(cntlr.updateURL, e), | ||
| ) | ||
| return | ||
| finally: | ||
| cntlr.showStatus("") # clear web loading status entry | ||
| cntlr.uiThreadQueue.put((_checkUpdateUrl, [cntlr, attachmentFileName])) | ||
|
|
||
|
|
||
| def _checkUpdateUrl(cntlr: CntlrWinMain, attachmentFileName: str) -> None: | ||
| filename = os.path.basename(attachmentFileName) | ||
| try: | ||
| from arelle import WebCache, Version | ||
| filename = os.path.basename(attachmentFileName) | ||
| if filename and "-20" in filename: | ||
| i = filename.index("-20") + 1 | ||
| filenameDate = filename[i:i+10] | ||
| versionDate = Version.version[0:10] | ||
| if filenameDate > versionDate: | ||
| # newer | ||
| reply = tkinter.messagebox.askyesnocancel( | ||
| _("arelle\u2122 - Updater"), | ||
| _("Update {0} is available, running version is {1}. \n\nDownload now? \n\n(Arelle will exit before installing.)").format( | ||
| filenameDate, versionDate), | ||
| parent=cntlr.parent) | ||
| if reply is None: | ||
| return False | ||
| if reply: | ||
| thread = threading.Thread(target=lambda u=actualUrl: backgroundDownload(cntlr, u)) | ||
| thread.daemon = True | ||
| thread.start() | ||
| else: | ||
| if filenameDate < versionDate: | ||
| msg = _("Arelle running version, {0}, is newer than the downloadable version, {1}.").format( | ||
| versionDate, filenameDate) | ||
| else: | ||
| msg = _("Arelle running version, {0}, is the same as the downloadable version.").format( | ||
| versionDate) | ||
| tkinter.messagebox.showwarning(_("arelle\u2122 - Updater"), msg, parent=cntlr.parent) | ||
|
|
||
| except: | ||
| pass | ||
|
|
||
| return | ||
|
|
||
| def backgroundDownload(cntlr, url): | ||
| filepathtmp = cntlr.webCache.getfilename(cntlr.updateURL, reload=True) | ||
| cntlr.modelManager.showStatus(_("Download ompleted"), 5000) | ||
| filepath = os.path.join(os.path.dirname(filepathtmp), os.path.basename(url)) | ||
| os.rename(filepathtmp, filepath) | ||
| cntlr.uiThreadQueue.put((install, [cntlr,filepath])) | ||
|
|
||
| def install(cntlr,filepath): | ||
| import sys | ||
| if sys.platform.startswith("win"): | ||
| os.startfile(filepath) | ||
| currentVersion = _parseVersion(Version.version) | ||
| except ValueError: | ||
| _showWarning(cntlr, _("Unable to determine current version of Arelle.")) | ||
| return | ||
| try: | ||
| updateVersion = _parseVersion(filename) | ||
| except ValueError: | ||
| _showWarning(cntlr, _("Unable to determine version of Arelle update.")) | ||
| return | ||
| if updateVersion > currentVersion: | ||
| reply = tkinter.messagebox.askokcancel( | ||
| _(_MESSAGE_HEADER), | ||
| _( | ||
| """ | ||
| Update {0} is available, current version is {1}. | ||
| Download now? | ||
| (Arelle will exit before installing.) | ||
| """ | ||
| ).format(updateVersion, currentVersion), | ||
| parent=cntlr.parent, | ||
| ) | ||
| if reply: | ||
| _backgroundDownload(cntlr, attachmentFileName) | ||
| elif updateVersion < currentVersion: | ||
| _showInfo( | ||
| cntlr, | ||
| _("Current Arelle version {0} is newer than update {1}.").format( | ||
| currentVersion, updateVersion | ||
| ), | ||
| ) | ||
| else: | ||
| if sys.platform in ("darwin", "macos"): | ||
| command = 'open' | ||
| else: # linux/unix | ||
| command = 'xdg-open' | ||
| _showInfo( | ||
| cntlr, | ||
| _("Arelle is already running the latest version {0}.").format( | ||
| currentVersion | ||
| ), | ||
| ) | ||
|
|
||
|
|
||
| def _parseVersion(versionStr: str) -> date: | ||
| versionDateMatch = _ISO_DATE_PATTERN.search(versionStr) | ||
| if versionDateMatch is None: | ||
| raise ValueError(f"Unable to parse version date from {versionStr}") | ||
| return date.fromisoformat(versionDateMatch.group("date")) | ||
|
|
||
|
|
||
| def _backgroundDownload(cntlr: CntlrWinMain, attachmentFileName: str) -> None: | ||
| thread = threading.Thread( | ||
| daemon=True, target=lambda u=attachmentFileName: _download(cntlr, u) | ||
| ) | ||
| thread.start() | ||
|
|
||
|
|
||
| def _download(cntlr: CntlrWinMain, url: str) -> None: | ||
| filepathTmp = cntlr.webCache.getfilename(cntlr.updateURL, reload=True) | ||
| if not filepathTmp: | ||
| _showWarning(cntlr, _("Failed to download update.")) | ||
| return | ||
| cntlr.showStatus(_("Download completed"), 5000) | ||
| filepath = os.path.join(os.path.dirname(filepathTmp), os.path.basename(url)) | ||
| try: | ||
| os.rename(filepathTmp, filepath) | ||
| except OSError: | ||
| _showWarning(cntlr, _("Failed to process update.")) | ||
| return | ||
| cntlr.uiThreadQueue.put((_install, [cntlr, filepath])) | ||
|
|
||
|
|
||
| def _install(cntlr: CntlrWinMain, filepath: str) -> None: | ||
| if sys.platform == "win32": | ||
| os.startfile(filepath) | ||
| elif sys.platform == "darwin": | ||
| try: | ||
| import subprocess | ||
| subprocess.Popen([command,filepath]) | ||
| except: | ||
| pass | ||
| subprocess.Popen(["open", filepath]) | ||
| except (OSError, subprocess.SubprocessError): | ||
| _showWarning(cntlr, _("Failed to start updated Arelle instance.")) | ||
| return | ||
| else: | ||
| raise RuntimeError("Tried to install update on unsupported platform.") | ||
| cntlr.uiThreadQueue.put((cntlr.quit, [])) | ||
|
|
||
|
|
||
| def _showInfo(cntlr: CntlrWinMain, msg: str) -> None: | ||
| tkinter.messagebox.showinfo(_(_MESSAGE_HEADER), msg, parent=cntlr.parent) | ||
|
|
||
|
|
||
| def _showWarning(cntlr: CntlrWinMain, msg: str) -> None: | ||
| tkinter.messagebox.showwarning(_(_MESSAGE_HEADER), msg, parent=cntlr.parent) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.