--- a/eric6/Helpviewer/HelpDocsInstaller.py Sat Sep 07 14:45:27 2019 +0200
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,246 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2009 - 2019 Detlev Offenbach <detlev@die-offenbachs.de>
-#
-
-"""
-Module implementing a thread class populating and updating the QtHelp
-documentation database.
-"""
-
-from __future__ import unicode_literals
-
-import os
-
-from PyQt5.QtCore import pyqtSignal, QThread, Qt, QMutex, QDateTime, QDir, \
- QLibraryInfo, QFileInfo
-from PyQt5.QtHelp import QHelpEngineCore
-
-from eric6config import getConfig
-
-from Globals import qVersionTuple
-
-
-class HelpDocsInstaller(QThread):
- """
- Class implementing the worker thread populating and updating the QtHelp
- documentation database.
-
- @signal errorMessage(str) emitted, if an error occurred during
- the installation of the documentation
- @signal docsInstalled(bool) emitted after the installation has finished
- """
- errorMessage = pyqtSignal(str)
- docsInstalled = pyqtSignal(bool)
-
- def __init__(self, collection):
- """
- Constructor
-
- @param collection full pathname of the collection file (string)
- """
- super(HelpDocsInstaller, self).__init__()
-
- self.__abort = False
- self.__collection = collection
- self.__mutex = QMutex()
-
- def stop(self):
- """
- Public slot to stop the installation procedure.
- """
- if not self.isRunning():
- return
-
- self.__mutex.lock()
- self.__abort = True
- self.__mutex.unlock()
- self.wait()
-
- def installDocs(self):
- """
- Public method to start the installation procedure.
- """
- self.start(QThread.LowPriority)
-
- def run(self):
- """
- Public method executed by the thread.
- """
- engine = QHelpEngineCore(self.__collection)
- engine.setupData()
- changes = False
-
- qt4Docs = ["designer", "linguist", "qt"]
- qt5Docs = [
- "activeqt", "qdoc", "qmake", "qt3d", "qt3drenderer",
- "qtandroidextras", "qtassistant", "qtbluetooth", "qtcanvas3d",
- "qtconcurrent", "qtcore", "qtdbus", "qtdesigner", "qtdoc",
- "qtenginio", "qtenginiooverview", "qtenginoqml",
- "qtgraphicaleffects", "qtgui", "qthelp", "qtimageformats",
- "qtlabscontrols", "qtlinguist", "qtlocation", "qtmaxextras",
- "qtmultimedia", "qtmultimediawidgets", "qtnetwork", "qtnfc",
- "qtopengl", "qtplatformheaders", "qtpositioning", "qtprintsupport",
- "qtqml", "qtquick", "qtquickcontrols", "qtquickdialogs",
- "qtquickextras", "qtquicklayouts", "qtscript", "qtscripttools",
- "qtsensors", "qtserialbus", "qtserialport", "qtsql", "qtsvg",
- "qttestlib", "qtuitools", "qtwebchannel", "qtwebengine",
- "qtwebenginewidgets", "qtwebkit", "qtwebkitexamples",
- "qtwebsockets", "qtwebview", "qtwidgets", "qtwinextras",
- "qtx11extras", "qtxml", "qtxmlpatterns"]
- for qtDocs, version in [(qt4Docs, 4), (qt5Docs, 5)]:
- for doc in qtDocs:
- changes |= self.__installQtDoc(doc, version, engine)
- self.__mutex.lock()
- if self.__abort:
- engine = None
- self.__mutex.unlock()
- return
- self.__mutex.unlock()
-
- changes |= self.__installEric6Doc(engine)
- engine = None
- del engine
- self.docsInstalled.emit(changes)
-
- def __installQtDoc(self, name, version, engine):
- """
- Private method to install/update a Qt help document.
-
- @param name name of the Qt help document (string)
- @param version Qt version of the help documens (integer)
- @param engine reference to the help engine (QHelpEngineCore)
- @return flag indicating success (boolean)
- """
- versionKey = "qt_version_{0}@@{1}".format(version, name)
- info = engine.customValue(versionKey, "")
- lst = info.split('|')
-
- dt = QDateTime()
- if len(lst) and lst[0]:
- dt = QDateTime.fromString(lst[0], Qt.ISODate)
-
- qchFile = ""
- if len(lst) == 2:
- qchFile = lst[1]
-
- if version == 4:
- docsPath = QDir(
- QLibraryInfo.location(QLibraryInfo.DocumentationPath) +
- QDir.separator() + "qch")
- elif version == 5:
- docsPath = QLibraryInfo.location(QLibraryInfo.DocumentationPath)
- if not os.path.isdir(docsPath) or \
- len(QDir(docsPath).entryList(["*.qch"])) == 0:
- # Qt installer is a bit buggy; it's missing a symbolic link
- docsPathList = QDir.fromNativeSeparators(docsPath).split("/")
- docsPath = os.sep.join(
- docsPathList[:-3] +
- ["Docs", "Qt-{0}.{1}".format(*qVersionTuple())])
- docsPath = QDir(docsPath)
- else:
- # unsupported Qt version
- return False
-
- files = docsPath.entryList(["*.qch"])
- if not files:
- engine.setCustomValue(
- versionKey,
- QDateTime().toString(Qt.ISODate) + '|')
- return False
-
- for f in files:
- if f.startswith(name):
- fi = QFileInfo(docsPath.absolutePath() + QDir.separator() + f)
- namespace = QHelpEngineCore.namespaceName(
- fi.absoluteFilePath())
- if not namespace:
- continue
-
- if dt.isValid() and \
- namespace in engine.registeredDocumentations() and \
- fi.lastModified().toString(Qt.ISODate) == \
- dt.toString(Qt.ISODate) and \
- qchFile == fi.absoluteFilePath():
- return False
-
- if namespace in engine.registeredDocumentations():
- engine.unregisterDocumentation(namespace)
-
- if not engine.registerDocumentation(fi.absoluteFilePath()):
- self.errorMessage.emit(
- self.tr(
- """<p>The file <b>{0}</b> could not be"""
- """ registered. <br/>Reason: {1}</p>""")
- .format(fi.absoluteFilePath, engine.error())
- )
- return False
-
- engine.setCustomValue(
- versionKey,
- fi.lastModified().toString(Qt.ISODate) + '|' +
- fi.absoluteFilePath())
- return True
-
- return False
-
- def __installEric6Doc(self, engine):
- """
- Private method to install/update the eric6 help documentation.
-
- @param engine reference to the help engine (QHelpEngineCore)
- @return flag indicating success (boolean)
- """
- versionKey = "eric6_ide"
- info = engine.customValue(versionKey, "")
- lst = info.split('|')
-
- dt = QDateTime()
- if len(lst) and lst[0]:
- dt = QDateTime.fromString(lst[0], Qt.ISODate)
-
- qchFile = ""
- if len(lst) == 2:
- qchFile = lst[1]
-
- docsPath = QDir(getConfig("ericDocDir") + QDir.separator() + "Help")
-
- files = docsPath.entryList(["*.qch"])
- if not files:
- engine.setCustomValue(
- versionKey, QDateTime().toString(Qt.ISODate) + '|')
- return False
-
- for f in files:
- if f == "source.qch":
- fi = QFileInfo(docsPath.absolutePath() + QDir.separator() + f)
- if dt.isValid() and \
- fi.lastModified().toString(Qt.ISODate) == \
- dt.toString(Qt.ISODate) and \
- qchFile == fi.absoluteFilePath():
- return False
-
- namespace = QHelpEngineCore.namespaceName(
- fi.absoluteFilePath())
- if not namespace:
- continue
-
- if namespace in engine.registeredDocumentations():
- engine.unregisterDocumentation(namespace)
-
- if not engine.registerDocumentation(fi.absoluteFilePath()):
- self.errorMessage.emit(
- self.tr(
- """<p>The file <b>{0}</b> could not be"""
- """ registered. <br/>Reason: {1}</p>""")
- .format(fi.absoluteFilePath, engine.error())
- )
- return False
-
- engine.setCustomValue(
- versionKey,
- fi.lastModified().toString(Qt.ISODate) + '|' +
- fi.absoluteFilePath())
- return True
-
- return False
