--- a/eric6/Helpviewer/SpeedDial/SpeedDial.py Sat Sep 07 14:45:27 2019 +0200
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,457 +0,0 @@
-# -*- coding: utf-8 -*-
-
-# Copyright (c) 2012 - 2019 Detlev Offenbach <detlev@die-offenbachs.de>
-#
-
-"""
-Module implementing the speed dial.
-"""
-
-from __future__ import unicode_literals
-try:
- str = unicode
-except NameError:
- pass
-
-import os
-
-from PyQt5.QtCore import pyqtSignal, pyqtSlot, QObject, QCryptographicHash, \
- QByteArray, QUrl, qWarning
-from PyQt5.QtWebKitWidgets import QWebPage
-
-from E5Gui import E5MessageBox
-
-from Utilities.AutoSaver import AutoSaver
-import Utilities
-
-
-class SpeedDial(QObject):
- """
- Class implementing the speed dial.
-
- @signal pagesChanged() emitted after the list of pages changed
- @signal speedDialSaved() emitted after the speed dial data was saved
- """
- pagesChanged = pyqtSignal()
- speedDialSaved = pyqtSignal()
-
- def __init__(self, parent=None):
- """
- Constructor
-
- @param parent reference to the parent object (QObject)
- """
- super(SpeedDial, self).__init__(parent)
-
- self.__regenerateScript = True
-
- self.__webPages = []
- self.__webFrames = []
-
- self.__initialScript = ""
- self.__thumbnailsDirectory = ""
-
- self.__thumbnailers = []
-
- self.__initialize()
-
- self.pagesChanged.connect(self.__pagesChanged)
-
- self.__saveTimer = AutoSaver(self, self.save)
- self.pagesChanged.connect(self.__saveTimer.changeOccurred)
-
- def addWebFrame(self, frame):
- """
- Public method to add a web frame.
-
- @param frame reference to the frame to be added (QWebFrame)
- """
- if frame not in self.__webFrames:
- self.__webFrames.append(frame)
-
- def addPage(self, url, title):
- """
- Public method to add a page for the given data.
-
- @param url URL of the page (QUrl)
- @param title title of the page (string)
- """
- if url.isEmpty():
- return
-
- from .Page import Page
- page = Page(url.toString(), title)
- self.__webPages.append(page)
-
- self.pagesChanged.emit()
-
- def removePage(self, url):
- """
- Public method to remove a page.
-
- @param url URL of the page (QUrl)
- """
- page = self.pageForUrl(url)
- if not page.url:
- return
-
- self.removeImageForUrl(page.url)
- self.__webPages.remove(page)
-
- self.pagesChanged.emit()
-
- def __imageFileName(self, url):
- """
- Private method to generate the image file name for a URL.
-
- @param url URL to generate the file name from (string)
- @return name of the image file (string)
- """
- return os.path.join(
- self.__thumbnailsDirectory,
- str(QCryptographicHash.hash(QByteArray(url.encode("utf-8")),
- QCryptographicHash.Md5).toHex(), encoding="utf-8") + ".png")
-
- def initialScript(self):
- """
- Public method to get the 'initial' JavaScript script.
-
- @return initial JavaScript script (string)
- """
- if self.__regenerateScript:
- self.__regenerateScript = False
- self.__initialScript = ""
-
- for page in self.__webPages:
- if page.broken:
- imgSource = "qrc:icons/brokenPage.png"
- else:
- imgSource = self.__imageFileName(page.url)
- if not os.path.exists(imgSource):
- self.loadThumbnail(page.url)
- imgSource = "qrc:icons/loading.gif"
-
- if not page.url:
- imgSource = ""
- else:
- imgSource = QUrl.fromLocalFile(imgSource).toString()
-
- self.__initialScript += \
- "addBox('{0}', '{1}', '{2}');\n".format(
- page.url, Utilities.html_uencode(page.title),
- imgSource)
-
- return self.__initialScript
-
- def getFileName(self):
- """
- Public method to get the file name of the user agents file.
-
- @return name of the user agents file (string)
- """
- return os.path.join(
- Utilities.getConfigDir(), "browser", "speedDial.xml")
-
- def __initialize(self):
- """
- Private method to initialize the speed dial.
- """
- self.__thumbnailsDirectory = os.path.join(
- Utilities.getConfigDir(), "browser", "thumbnails")
- # Create directory if it does not exist yet
- if not os.path.exists(self.__thumbnailsDirectory):
- os.makedirs(self.__thumbnailsDirectory)
-
- self.__load()
-
- def reload(self):
- """
- Public method to reload the speed dial data.
- """
- self.__load()
-
- def __load(self):
- """
- Private method to load the speed dial configuration.
- """
- allPages, pagesPerRow, speedDialSize = [], 0, 0
-
- speedDialFile = self.getFileName()
- if os.path.exists(speedDialFile):
- from .SpeedDialReader import SpeedDialReader
- reader = SpeedDialReader()
- allPages, pagesPerRow, speedDialSize = reader.read(speedDialFile)
-
- self.__pagesPerRow = pagesPerRow if pagesPerRow else 4
- self.__speedDialSize = speedDialSize if speedDialSize else 231
-
- if allPages:
- self.__webPages = allPages
- self.pagesChanged.emit()
- else:
- allPages = \
- 'url:"https://eric-ide.python-projects.org/"|'\
- 'title:"Eric Web Site";'\
- 'url:"https://www.riverbankcomputing.com/"|'\
- 'title:"PyQt Web Site";'\
- 'url:"http://www.qt.io/"|title:"Qt Web Site";'\
- 'url:"http://blog.qt.io/"|title:"Qt Blog";'\
- 'url:"https://www.python.org"|'\
- 'title:"Python Language Website";'\
- 'url:"http://www.google.com"|title:"Google";'
- self.changed(allPages)
-
- def save(self):
- """
- Public method to save the speed dial configuration.
- """
- from .SpeedDialWriter import SpeedDialWriter
- speedDialFile = self.getFileName()
- writer = SpeedDialWriter()
- if not writer.write(speedDialFile, self.__webPages,
- self.__pagesPerRow, self.__speedDialSize):
- E5MessageBox.critical(
- None,
- self.tr("Saving Speed Dial data"),
- self.tr(
- """<p>Speed Dial data could not be saved to"""
- """ <b>{0}</b></p>""").format(speedDialFile))
- else:
- self.speedDialSaved.emit()
-
- def resetDials(self):
- """
- Public method to reset the speed dials to the default values.
- """
- ok = E5MessageBox.yesNo(
- None,
- self.tr("Reset Speed Dials"),
- self.tr("""Are you sure you want to reset the speed dials to"""
- """ the default pages?"""))
- if ok:
- speedDialFile = self.getFileName()
- if os.path.exists(speedDialFile):
- os.remove(speedDialFile)
-
- self.__load()
-
- def close(self):
- """
- Public method to close the user agents manager.
- """
- self.__saveTimer.saveIfNeccessary()
-
- def pageForUrl(self, url):
- """
- Public method to get the page for the given URL.
-
- @param url URL to be searched for (QUrl)
- @return page for the URL (Page)
- """
- urlString = url.toString()
- for page in self.__webPages:
- if page.url == urlString:
- return page
-
- from .Page import Page
- return Page()
-
- def urlForShortcut(self, key):
- """
- Public method to get the URL for the given shortcut key.
-
- @param key shortcut key (integer)
- @return URL for the key (QUrl)
- """
- if key < 0 or len(self.__webPages) <= key:
- return QUrl()
-
- return QUrl.fromEncoded(self.__webPages[key].url.encode("utf-8"))
-
- @pyqtSlot(str)
- def changed(self, allPages):
- """
- Public slot to react on changed pages.
-
- @param allPages string giving all pages (string)
- """
- if not allPages:
- return
-
- entries = allPages.split('";')
- self.__webPages = []
-
- from .Page import Page
- for entry in entries:
- if not entry:
- continue
-
- tmp = entry.split('"|')
- if len(tmp) == 2:
- broken = False
- elif len(tmp) == 3:
- broken = "brokenPage" in tmp[2][5:]
- else:
- continue
-
- page = Page(tmp[0][5:], tmp[1][7:], broken)
- self.__webPages.append(page)
-
- self.pagesChanged.emit()
-
- @pyqtSlot(str)
- @pyqtSlot(str, bool)
- def loadThumbnail(self, url, loadTitle=False):
- """
- Public slot to load a thumbnail of the given URL.
-
- @param url URL of the thumbnail (string)
- @param loadTitle flag indicating to get the title for the thumbnail
- from the site (boolean)
- """
- if not url:
- return
-
- from .PageThumbnailer import PageThumbnailer
- thumbnailer = PageThumbnailer(self)
- thumbnailer.setUrl(QUrl.fromEncoded(url.encode("utf-8")))
- thumbnailer.setLoadTitle(loadTitle)
- thumbnailer.thumbnailCreated.connect(
- lambda imag: self.__thumbnailCreated(imag, thumbnailer))
- self.__thumbnailers.append(thumbnailer)
-
- thumbnailer.start()
-
- @pyqtSlot(str)
- def removeImageForUrl(self, url):
- """
- Public slot to remove the image for a URL.
-
- @param url URL to remove the image for (string)
- """
- fileName = self.__imageFileName(url)
- if os.path.exists(fileName):
- os.remove(fileName)
-
- @pyqtSlot(str, result=str)
- def urlFromUserInput(self, url):
- """
- Public slot to get the URL from user input.
-
- @param url URL entered by the user (string)
- @return sanitized URL (string)
- """
- return QUrl.fromUserInput(url).toString()
-
- @pyqtSlot(str, result=str)
- def unescapeTitle(self, title):
- """
- Public slot to unescape the titel string.
-
- @param title escaped title (string)
- @return un-escaped title (string)
- """
- return Utilities.html_udecode(title)
-
- @pyqtSlot(int)
- def setPagesInRow(self, count):
- """
- Public slot to set the number of pages per row.
-
- @param count number of pages per row (integer)
- """
- self.__pagesPerRow = count
- self.__saveTimer.changeOccurred()
-
- def pagesInRow(self):
- """
- Public method to get the number of dials per row.
-
- @return number of dials per row (integer)
- """
- return self.__pagesPerRow
-
- @pyqtSlot(int)
- def setSdSize(self, size):
- """
- Public slot to set the size of the speed dial.
-
- @param size size of the speed dial (integer)
- """
- self.__speedDialSize = size
- self.__saveTimer.changeOccurred()
-
- def sdSize(self):
- """
- Public method to get the speed dial size.
-
- @return speed dial size (integer)
- """
- return self.__speedDialSize
-
- def __thumbnailCreated(self, image, thumbnailer):
- """
- Private slot to handle the creation of a thumbnail image.
-
- @param image thumbnail image
- @type QPixmap
- @param thumbnailer reference to the page thumbnailer
- @type PageThumbnailer
- """
- if thumbnailer in self.__thumbnailers:
- loadTitle = thumbnailer.loadTitle()
- title = thumbnailer.title()
- url = thumbnailer.url().toString()
- fileName = self.__imageFileName(url)
-
- if image.isNull():
- fileName = "qrc:icons/brokenPage.png"
- title = self.tr("Unable to load")
- loadTitle = True
- page = self.pageForUrl(thumbnailer.url())
- page.broken = True
- else:
- if not image.save(fileName):
- qWarning(
- "SpeedDial.__thumbnailCreated: Cannot save thumbnail"
- " to {0}".format(fileName))
-
- fileName = QUrl.fromLocalFile(fileName).toString()
-
- self.__regenerateScript = True
-
- for frame in self.__cleanFrames():
- frame.evaluateJavaScript("setImageToUrl('{0}', '{1}');".format(
- url, fileName))
- if loadTitle:
- frame.evaluateJavaScript(
- "setTitleToUrl('{0}', '{1}');".format(
- url, Utilities.html_uencode(title)))
-
- thumbnailer.deleteLater()
- self.__thumbnailers.remove(thumbnailer)
-
- def __cleanFrames(self):
- """
- Private method to clean all frames.
-
- @return list of speed dial frames (list of QWebFrame)
- """
- frames = []
-
- for frame in self.__webFrames[:]:
- if frame.url().toString() == "eric:speeddial":
- frames.append(frame)
- else:
- self.__webFrames.remove(frame)
-
- return frames
-
- def __pagesChanged(self):
- """
- Private slot to react on a change of the pages configuration.
- """
- # update all speed dial pages
- self.__regenerateScript = True
- for frame in self.__cleanFrames():
- frame.page().triggerAction(QWebPage.Reload)
