# -*- coding: iso-8859-1 -*- # Copyright (C) 2008-2012 Bastian Kleineidam # # 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 import sys import re import webbrowser from PyQt4 import QtCore, QtGui from .linkchecker_ui_main import Ui_MainWindow from .properties import set_properties, clear_properties from .statistics import set_statistics, clear_statistics from .debug import LinkCheckerDebug from .logger import GuiLogger, GuiLogHandler, StatusLogger from .help import HelpWindow from .options import LinkCheckerOptions from .checker import CheckerThread from .contextmenu import ContextMenu from .editor import EditorWindow from .updater import UpdateDialog from .urlmodel import UrlItemModel from .urlsave import urlsave from .settings import Settings from .recentdocs import RecentDocumentModel from .. import configuration, checker, director, add_intern_pattern, \ strformat, fileutil, LinkCheckerError, get_link_pat from ..containers import enum from .. import url as urlutil from ..checker import httpheaders DocBaseUrl = "qthelp://bfk.app.linkchecker/doc/" RegistryBase = "Bastian" Status = enum('idle', 'checking') def get_app_style (): """Return appropriate QStyle object for the current platform to be used in QApplication.setStyle(). Currently prefers Macintosh on OS X, else Plastique. Style names are case insensitive. See also http://doc.trolltech.com/latest/gallery-macintosh.html and http://doc.trolltech.com/latest/gallery-plastique.html """ if sys.platform == 'darwin': style = "Macintosh" else: style = "Plastique" return QtGui.QStyleFactory.create(style) def get_icon (name): """Return QIcon with given pixmap resource name.""" icon = QtGui.QIcon() icon.addPixmap(QtGui.QPixmap(name), QtGui.QIcon.Normal, QtGui.QIcon.Off) return icon def warninglines2regex(lines): """Convert a list of strings to a regular expression matching any of the given strings.""" return u"|".join([re.escape(line) for line in lines]) class LinkCheckerMain (QtGui.QMainWindow, Ui_MainWindow): """The main window displaying checked URLs.""" log_url_signal = QtCore.pyqtSignal(object) log_status_signal = QtCore.pyqtSignal(int, int, int, float) log_stats_signal = QtCore.pyqtSignal(object) error_signal = QtCore.pyqtSignal(str) def __init__(self, parent=None, url=None): """Initialize UI.""" super(LinkCheckerMain, self).__init__(parent) self.setupUi(self) self.setWindowFlags(self.windowFlags() | QtCore.Qt.WindowContextHelpButtonHint) self.setWindowTitle(configuration.App) # app settings self.settings = Settings(RegistryBase, configuration.AppName) # init subdialogs self.options = LinkCheckerOptions(parent=self) self.debug = LinkCheckerDebug(parent=self) self.checker = CheckerThread(parent=self) self.contextmenu = ContextMenu(parent=self) self.editor = EditorWindow(parent=self) # Note: do not use QT assistant here because of the .exe packaging self.assistant = HelpWindow(self, self.get_qhcpath()) self.config_error = None self.icon_start = get_icon(":/icons/start.png") self.icon_stop = get_icon(":/icons/stop.png") self.movie = QtGui.QMovie(":/icons/busy.gif") self.movie.setCacheMode(QtGui.QMovie.CacheAll) self.label_busy.setText(u"") self.label_busy.setMovie(self.movie) # init the rest self.init_url(url) self.init_treeview() self.connect_widgets() self.init_config() self.read_config() self.init_menu() self.init_app() def init_url (self, url): """Initialize URL input.""" documents = self.settings.read_recent_documents() self.recent = RecentDocumentModel(parent=self, documents=documents) self.urlinput.setModel(self.recent) if url: self.urlinput.setText(url) elif documents: self.urlinput.setText(documents[0]) def init_menu (self): """Add menu entries for bookmark file checking.""" self.urlinput.addMenuEntries(self.menuEdit) def init_app (self): """Set window size and position, GUI options and reset status.""" data = self.settings.read_geometry() if data["size"] is not None: self.resize(data["size"]) if data["pos"] is not None: self.move(data["pos"]) self.options.set_options(self.settings.read_options()) self.status = Status.idle self.actionSave.setEnabled(False) msg = self.config_error or _("Ready.") self.set_statusmsg(msg) def get_qhcpath (self): """Helper function to search for the QHC help file in different locations.""" paths = [ # when developing os.path.join(configuration.configdata.install_data, "doc", "html"), # when running under py2exe os.path.join(os.path.dirname(os.path.abspath(sys.executable)), "share", "linkchecker"), # after installing as a package configuration.configdata.config_dir, ] for path in paths: qhcfile = os.path.join(path, "lccollection.qhc") if os.path.isfile(qhcfile): break return qhcfile def connect_widgets (self): """Connect widget signals. Some signals use the AutoConnect feature. Autoconnected methods have the form on__. """ def set_idle (): """Set application status to idle.""" self.status = Status.idle self.set_statusmsg(_("Check finished.")) self.controlButton.clicked.disconnect(self.checker.cancel) self.checker.finished.connect(set_idle) self.checker.terminated.connect(set_idle) self.log_url_signal.connect(self.model.log_url) self.log_stats_signal.connect(self.log_stats) self.error_signal.connect(self.internal_error) self.options.editor.saved.connect(self.read_config) self.log_status_signal.connect(self.log_status) def init_treeview (self): """Set treeview model and layout.""" self.model = UrlItemModel() self.treeView.setModel(self.model) data = self.settings.read_treeviewcols() self.treeView.setColumnWidth(0, data["col1"]) self.treeView.setColumnWidth(1, data["col2"]) self.treeView.setColumnWidth(2, data["col3"]) selectionModel = self.treeView.selectionModel() selectionModel.selectionChanged.connect(self.set_properties) def get_treeviewcols (self): """Return URL treeview column widths.""" return dict( col1=self.treeView.columnWidth(0), col2=self.treeView.columnWidth(1), col3=self.treeView.columnWidth(2), ) def init_config (self): """Create a configuration object.""" self.config = configuration.Configuration() # dictionary holding overwritten values self.config_backup = {} # set standard GUI configuration values self.config.logger_add("gui", GuiLogger) self.config["logger"] = self.config.logger_new('gui', signal=self.log_url_signal, stats=self.log_stats_signal) self.config["status"] = True self.config["status_wait_seconds"] = 2 self.handler = GuiLogHandler(self.debug.log_msg_signal) status = StatusLogger(self.log_status_signal) self.config.init_logging(status, handler=self.handler) def read_config (self, filename=None): """Read user and system configuration file.""" try: self.config.read() except LinkCheckerError, msg: self.config_error = unicode(msg) def set_config (self): """Set configuration.""" data = self.options.get_options() self.config["recursionlevel"] = data["recursionlevel"] self.config["verbose"] = data["verbose"] if data["debug"]: self.config.set_debug(["all"]) # make sure at least one thread is used self.config["threads"] = 1 else: self.config.reset_loglevel() if data["warninglines"]: lines = data["warninglines"].splitlines() ro = re.compile(warninglines2regex(lines)) self.backup_config("warningregex", ro) # set ignore patterns ignorepats = data["ignorelines"].strip() if ignorepats: self.backup_config("externlinks") lines = ignorepats.splitlines() for line in lines: pat = get_link_pat(line, strict=1) self.config["externlinks"].append(pat) def backup_config (self, key, value=None): """Backup config key if not already done and set given value.""" if key not in self.config_backup: confvalue = self.config[key] if isinstance(confvalue, list): # make copy of lists to avoid unwanted inserted items confvalue = list(confvalue) self.config_backup[key] = confvalue if value is not None: self.config[key] = value def restore_config (self): """Restore config from backup.""" for key in self.config_backup: self.config[key] = self.config_backup[key] def get_status (self): """Return current application status.""" return self._status def set_status (self, status): """Set application status.""" self._status = status if status == Status.idle: self.aggregate = None self.controlButton.setText(_("Start")) self.controlButton.setIcon(self.icon_start) self.controlButton.setEnabled(True) self.actionSave.setEnabled(True) self.actionDebug.setEnabled(self.options.get_options()["debug"]) self.treeView.sortByColumn(0, QtCore.Qt.AscendingOrder) self.treeView.setSortingEnabled(True) self.treeView.scrollToTop() self.movie.stop() # Reset progress information. self.label_active.setText(u"0") self.label_queued.setText(u"0") self.label_checked.setText(u"0") self.label_busy.hide() self.menubar.setEnabled(True) self.urlinput.setEnabled(True) self.restore_config() elif status == Status.checking: self.treeView.setSortingEnabled(False) self.debug.reset() self.set_statusmsg(u"Checking site...") # disable commands self.menubar.setEnabled(False) self.urlinput.setEnabled(False) # reset widgets self.controlButton.setText(_("Stop")) self.controlButton.setIcon(self.icon_stop) self.controlButton.clicked.connect(self.checker.cancel) self.movie.start() self.label_busy.show() status = property(get_status, set_status) @QtCore.pyqtSlot() def on_actionHelp_triggered (self): """Show help page.""" url = QtCore.QUrl("%sindex.html" % DocBaseUrl) self.assistant.showDocumentation(url) @QtCore.pyqtSlot() def on_actionOptions_triggered (self): """Show option dialog.""" self.options.exec_() @QtCore.pyqtSlot() def on_actionQuit_triggered (self): """Quit application.""" self.close() def closeEvent (self, e=None): """Save settings and remove registered logging handler""" self.settings.save_geometry(dict(size=self.size(), pos=self.pos())) self.settings.save_treeviewcols(self.get_treeviewcols()) self.settings.save_options(self.options.get_options()) self.settings.save_recent_documents(self.recent.get_documents()) self.settings.sync() self.config.remove_loghandler(self.handler) if e is not None: e.accept() @QtCore.pyqtSlot() def on_actionAbout_triggered (self): """Display about dialog.""" modules = u"
\n".join(configuration.get_modules_info()) d = { "app": configuration.App, "appname": configuration.AppName, "copyright": configuration.HtmlCopyright, "donateurl": configuration.DonateUrl, "pyver": u"%d.%d.%d" % sys.version_info[:3], "modules": modules, "releasedate": configuration.ReleaseDate, } QtGui.QMessageBox.about(self, _(u"About %(appname)s") % d, _(u"""

%(app)s

Released on %(releasedate)s

Python: %(pyver)s
%(modules)s

%(copyright)s
%(appname)s is licensed under the GPL Version 2 or later.

If you like %(appname)s, consider one of several ways to donate. Thanks!

""") % d) @QtCore.pyqtSlot() def on_actionDonate_triggered (self): """Open donation URL.""" webbrowser.open(configuration.DonateUrl) @QtCore.pyqtSlot() def on_actionDebug_triggered (self): """Display debug dialog.""" self.debug.show() @QtCore.pyqtSlot() def on_actionSave_triggered (self): """Quit application.""" urlsave(self, self.config, self.model.urls) @QtCore.pyqtSlot() def on_actionCheckUpdates_triggered (self): """Display update check result.""" dialog = UpdateDialog(self) dialog.reset() dialog.show() def start (self): """Start a new check.""" if self.status == Status.idle: self.check() on_urlinput_returnPressed = start def cancel (self): """Note that checking is canceled.""" self.controlButton.setEnabled(False) self.set_statusmsg(_(u"Closing pending connections...")) @QtCore.pyqtSlot() def on_controlButton_clicked (self): """Start or Cancel has been clicked.""" if self.status == Status.idle: self.start() elif self.status == Status.checking: self.cancel() else: raise ValueError("Invalid application status %r" % self.status) def get_url (self): """Return URL to check from the urlinput widget.""" url = strformat.stripurl(unicode(self.urlinput.text())) if url.startswith(u"www."): url = u"http://%s" % url elif url.startswith(u"ftp."): url = u"ftp://%s" % url elif url and u":" not in url: # Look for local file, else assume it's an HTTP URL. if not os.path.exists(url): url = u"http://%s" % url return url def check (self): """Check given URL.""" self.model.clear() clear_properties(self) clear_statistics(self) self.set_config() aggregate = director.get_aggregate(self.config) url = self.get_url() if not url: self.set_statusmsg(_("Error, empty URL")) return self.set_statusmsg(_("Checking '%s'.") % strformat.limit(url, 40)) url_data = checker.get_url_from(url, 0, aggregate) try: self.backup_config('internlinks') add_intern_pattern(url_data, self.config) except UnicodeError: self.set_statusmsg(_("Error, invalid URL `%s'.") % strformat.limit(url, 40)) return self.recent.add_document(url) aggregate.urlqueue.put(url_data) self.aggregate = aggregate # check in background self.checker.check(self.aggregate) self.status = Status.checking def set_properties (self, selected, deselected): """Set URL properties for selected item.""" indexes = selected.indexes() if len(indexes): index = indexes[0] urlitem = self.model.getUrlItem(index) if urlitem is not None: set_properties(self, urlitem.url_data) selected_rows = len(self.treeView.selectionModel().selectedRows()) if selected_rows: self.set_statusmsg(_n("%d URL selected.", "%d URLs selected", selected_rows) % selected_rows) else: self.set_statusmsg(_("Ready.")) def on_treeView_customContextMenuRequested (self, point): """Show item context menu.""" urlitem = self.model.getUrlItem(self.treeView.currentIndex()) if urlitem is not None: self.contextmenu.enableFromItem(urlitem) self.contextmenu.popup(QtGui.QCursor.pos()) @QtCore.pyqtSlot() def on_actionViewOnline_triggered (self): """View item URL online.""" urlitem = self.model.getUrlItem(self.treeView.currentIndex()) if urlitem is not None: webbrowser.open(urlitem.url_data.url) @QtCore.pyqtSlot() def on_actionViewParentOnline_triggered (self): """View item parent URL online.""" urlitem = self.model.getUrlItem(self.treeView.currentIndex()) if urlitem is not None: webbrowser.open(urlitem.url_data.parent_url) @QtCore.pyqtSlot() def on_actionViewParentSource_triggered (self): """View item parent URL source in local text editor (read-only).""" urlitem = self.model.getUrlItem(self.treeView.currentIndex()) if urlitem is not None: self.view_source(urlitem.url_data.parent_url, urlitem.url_data.line, urlitem.url_data.column) def view_source (self, url, line, col): """View URL source in editor window.""" self.editor.setWindowTitle(u"View %s" % url) self.editor.setUrl(url) info, data = urlutil.get_content(url, proxy=self.config["proxy"]) if (info, data) == (None, None): self.editor.setText(u"An error occurred retreiving URL `%s'." % url) else: content_type = httpheaders.get_content_type(info) if not content_type: # read function for content type guessing read = lambda: data content_type = fileutil.guess_mimetype(url, read=read) self.editor.setContentType(content_type) self.editor.setText(data, line=line, col=col) self.editor.show() @QtCore.pyqtSlot() def on_actionCopyToClipboard_triggered (self): """Copy item URL to clipboard.""" urlitem = self.model.getUrlItem(self.treeView.currentIndex()) if urlitem: clipboard = QtGui.QApplication.clipboard() clipboard.setText(urlitem.url_data.url) event = QtCore.QEvent(QtCore.QEvent.Clipboard) QtGui.QApplication.sendEvent(clipboard, event) def set_statusmsg (self, msg): """Show given status message.""" if len(msg) > 30: self.label_status.setToolTip(msg) msg = msg[:27]+u"..." self.label_status.setText(msg) def log_status (self, checked, in_progress, queued, duration): """Update number of checked, active and queued URLs.""" self.label_checked.setText(u"%d" % checked) self.label_active.setText(u"%d" % in_progress) self.label_queued.setText(u"%d" % queued) def log_stats (self, statistics): """Set statistic information for selected URL.""" set_statistics(self, statistics) def internal_error (self, msg): """Display internal error message. Triggered by sys.excepthook().""" QtGui.QMessageBox.warning(self, _(u"LinkChecker internal error"), msg)