mediawiki2latexguipyqt 1.5-1 / usr / bin / mediawiki2latex-pyqt

#! /usr/bin/python3
# -*- coding: utf-8 -*-
# 	$Id$

License="""\
mediawiki2latex-pyqt version {version}:

a gui for mediawiki2latex

{authors}

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, see
<http://www.gnu.org/licenses/>.
"""

version="1.2"

authors="""Copyright © 2014 Dirk Hünniger <dirk.hunniger@googlemail.com>
Copyright © 2014 Georges Khaznadar <georgesk@debian.org>"""

import sys
from PyQt5.QtGui import QIcon
from PyQt5.QtWidgets import QLabel, QApplication, qApp, QMainWindow, QLineEdit
from PyQt5.QtWidgets import QProgressBar, QPushButton, QGridLayout, QComboBox
from PyQt5.QtWidgets import QMessageBox, QDialog
from PyQt5.QtCore import QTimer, pyqtSignal, QProcess, Qt
from PyQt5.QtCore import QTranslator, QLibraryInfo, qDebug
from PyQt5.QtCore import QByteArray
import webbrowser
import os
import tempfile
import time
import math
# access custom modules
sys.path = sys.path + ['/usr/share/mediawiki2latex']
from Ui_MainWindow import Ui_MainWindow
#from Ui_about import Ui_Dialog as Ui_about
from processes import bashProcess
from processTimer import processTimer

# i18n and l10n stuff
from locale import getdefaultlocale
locale = getdefaultlocale()

try:
  _encoding = QApplication.UnicodeUTF8
  def _translate(context, text, disambig=None):
    return text
    return QApplication.translate(context, text, disambig, _encoding)
except AttributeError:
  def _translate(context, text, disambig=None):
    return text
    return QApplication.translate(context, text, disambig)

class Progressor:
  def __init__(self):
    self.expectedRuntime=60.0
    self.lastReachedKnownRelativeProgress=0.0
    self.timeOfLastReachedKnownRelativeProgress=time.time()
    self.expectedRealiveProgresses=[
      (_translate("MainWindow",'downloading article and contributor information'), 
       0.02540431143798292),
      (_translate("MainWindow",'parsing article text'), 
       0.057625916241286344),
      (_translate("MainWindow",'forking threads to download of images and contributor information on them'),
       0.058045207449988465),
      (_translate("MainWindow",'precompiling table columns'), 
       0.08075814224942594),
      (_translate("MainWindow",'joining threads to download the images and contributor information on them'),
       0.37003149457779727),
      (_translate("MainWindow",'preparing for PDF generation'),
       0.5479855803098518),
      (_translate("MainWindow",'preparing images for LaTeX document'),
       0.637605216120732),
      (_translate("MainWindow",'generating PDF file. LaTeX run 1 of 4'), 
       0.6911489294291799),
      (_translate("MainWindow",'generating PDF file. LaTeX run 2 of 4'), 
       0.7673758195622185),
      (_translate("MainWindow",'generating PDF file. LaTeX run 3 of 4'), 
       0.8463397892914045),
      (_translate("MainWindow",'generating PDF file. LaTeX run 4 of 4'),
       0.9231746180088297),
      (_translate("MainWindow",'finished'), 
         1.0)
       ]
    self.startTime=time.time()
    self.progressBarValue=0.0
    self.estimatedRelativeProgress=0.0
    self.lastRuntime=0.0
    self.nextKnownRelativeProgressToBeReached=self.expectedRealiveProgresses[0][1]
  def __call__(self,line):
    for (k,v) in self.expectedRealiveProgresses:
      if str(k) in str(line):
        if k=='finished': 
          self.progressBarValue=1.0
          return 100
        self.lastReachedKnownRelativeProgress=v
        for i,(kk,vv) in enumerate(self.expectedRealiveProgresses):
          if kk==k: n=i
        n=min(max(0,n+1),len(self.expectedRealiveProgresses)-1)
        self.nextKnownRelativeProgressToBeReached=self.expectedRealiveProgresses[n][1]
        self.timeOfLastReachedKnownRelativeProgress=time.time()
        self.expectedRuntime=(time.time()-self.startTime)/self.lastReachedKnownRelativeProgress
    self.runtime=time.time()-self.startTime
    self.p=self.lastReachedKnownRelativeProgress+(1-math.exp(-(time.time()-self.timeOfLastReachedKnownRelativeProgress)/(self.expectedRuntime*(self.nextKnownRelativeProgressToBeReached-self.lastReachedKnownRelativeProgress))))*(self.nextKnownRelativeProgressToBeReached-self.lastReachedKnownRelativeProgress)
    self.progressBarValue=self.progressBarValue+(max((self.p-self.progressBarValue)*(self.runtime-self.lastRuntime)/5.0,0.0))
    self.progressBarValue=self.p
    self.lastRuntime=self.runtime
    return int(self.progressBarValue*100.0)

class sequenceApp (QApplication):
    """
    implements a particular qt4 Application which allows to
    manage sequencial procedure lists coupled with a monitor : 
    informations about the pending procedure, progress bar, and
    text browsers for the stdout and stderr streams.
    """
    def outBrowser(self):
        """
        abstract function to overload. Should return a widget where
        stdout can be fed in.
        """
        return None

    def errBrowser(self):
        """
        abstract function to overload. Should return a widget where
        stderr can be fed in.
        """
        return None

    def registerProgress(self,n):
        """
        abstract function to overload. Should update a progress bar.
        @param n a numeric value between 0 and 100
        """
        self.pbar.setValue(n)
        return None

    def nextProcess(self, finished="echo 'abstract command line'"):
        """
        abstract function to overload. Registers that a process is finished
        @param finished the text of a shell command line which was processed
        """
        return None


class MainWindow (QMainWindow,sequenceApp):
    """
    the main window of the GUI.
    """

    """
    specific signal which will be triggered by the processTimer object
    """
    idleTick          = pyqtSignal()
    idleDetailProgress = pyqtSignal(int)

    def outBrowser(self):
        """
        @return a QPlainTextEdit instance to be fed with stdout
        """
        return self.ui.plainTextEdit
    
    def errBrowser(self):
        """
        @return a QPlainTextEdit instance to be fed with stderr
        """
        return self.ui.plainTextEdit_2
    
    def registerProgress(self,n):
        """
        Update the progress bar.
        @param n a numeric value between 0 and 100
        """
        n=float(n) # might be something more complex
        if n > 100:
            n=100
        if n < 0:
            n=0
        self.pbar.setValue(n)
        return

    def nextProcess(self, finished=None):
        """
        increments the pointer to the list of processes to deal with
        @param finished the text of a shell command line which was processed
        """
        if finished==None:
          finished=_translate("MainWindow","echo 'default message; you should not see it'")
        self.pending = self.pending +1
        message = "`{0}' done.".format(finished)
        self.ui.statusbar.showMessage(message,1000)
        return

    def __init__ (self, preferences):
        """
        constructor of the main window
        @param preferences an instance of Preferences
        """
        QMainWindow.__init__ (self)
        sequenceApp.__init__ (self)
        self.processList=[]        # list of bashProcess instances
        self.pending=0             # pointer to self.processList
        self.t=processTimer(self)  # this timer will triggers idleTick.emit()
        self.idleTick.connect(self.tick)
        self.idleDetailProgress.connect(self.registerProgress)
        outFile=tempfile.NamedTemporaryFile(suffix='.pdf',prefix='m2l_',delete=False)
        self.outFilename=outFile.name
        outFile.close()

        self.ui = Ui_MainWindow()
        self.ui.setupUi(self)
        self.edit = self.ui.lineEdit
        self.edit.setText(preferences.mwSource)

        self.combo = self.ui.comboBox
        self.papercombo = self.ui.comboBox_2
        self.rastercombo = self.ui.comboBox_3
        self.inccombo = self.ui.comboBox_4
        self.button = self.ui.runButton
        self.ui.runButton.clicked.connect(self.callbackrun)
        self.ui.actionQuit.triggered.connect(self.close)
        self.ui.actionSave_preferences.triggered.connect(self.savePrefs)
        self.ui.actionHelp.triggered.connect(self.help)
        self.ui.actionAbout_F1.triggered.connect(self.about)
        self.pbar = self.ui.progressBar
        self.pbar.setValue(0)
        self.ui_about()
        self.resize(700,400)
        self.ui.plainTextEdit.setReadOnly(True)

    def ui_about(self):
      """
      create the about dialog
      """
      self.about=QDialog(self, Qt.CustomizeWindowHint|Qt.WindowTitleHint) # no close button in the window's top
      self.about.ui=QDialog(self)#Ui_about()
      #self.about.ui.setupUi(self.about)
      #self.about.ui.textAuthors.setText(authors)
      theLicense=_translate("MainWindow","""\
mediawiki2latex-pyqt version {version}:

a gui for mediawiki2latex

{authors}

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, see
<http://www.gnu.org/licenses/>.
""")
      #self.about.ui.textLicense.setText(theLicense.format(version=version, authors=""))
      #self.about.ui.textTranslations.setText(_translate("MainWindow","""French translation: (c) 2014 Georges Khaznadar <georgesk@debian.org>
#"""))
      self.about.hide()
      return

    def about(self):
      """
      raise the "about" dialog
      """
      #self.about.show()
      #result = self.about.exec_()
      #self.about.hide()
      qDebug("about not yet implemented")
      return

    def help(self):
      """
      raise a help window
      """
      qDebug("help not yet implemented")
      return

    def savePrefs(self):
      """
      callback function to save preferences
      """
      qDebug("savePrefs not yet implemented")
      return

    def pdfFile(self):
        """
        returns the path to the output file
        @return the path to the PDF file
        """
        if self.getZip(self.inccombo.currentText())=="-z":
          return ".".join(self.outFilename.split(".")[:-1])+".zip"             
        if self.getZip(self.inccombo.currentText())=="-d":
          return ".".join(self.outFilename.split(".")[:-1])+".odt"             
        if self.getZip(self.inccombo.currentText())=="-b":
          return ".".join(self.outFilename.split(".")[:-1])+".epub"             
        return self.outFilename
 
    def callbackrun(self):
        """
        Callback function that is called when the user clicks the run button.
        """
        try:
            if os.path.exists(self.pdfFile()):
                mainfile = open(self.pdfFile(), "ab")
                mainfile.close()
        except:
            QMessageBox.about(self, _translate("MainWindow","File still open"), 
              _translate("MainWindow","""Please close your PDF viewer before pressing the run button!
This program need writing permission on the PDF file!"""))
            return

        self.pending = 0
        self.processList=[]
        self.button.setEnabled(False)
        logBrowserTab=1 # displays stdout
        self.outBrowser().appendPlainText(_translate("MainWindow","Mediawiki to Latex started..."))
        self.ui.tabWidget.setCurrentIndex(logBrowserTab)
        self.scheduleM2L()
        # more processes can be scheduled, the module processes.py allows it.
        self.t.start()

    def tick(self):
        """
        callback procedure triggered by processTimer's ticks
        """
        if self.pending < len(self.processList):
            pp = self.processList[self.pending]
            if pp and pp.state()==QProcess.NotRunning:
                pp.start()
                self.ui.statusbar.showMessage(pp.message)
                #self.setDetailProgress(0)
                #self.setProgress()
        else:
            # no more processes to run
            self.bailOut()

    def getSwitch(self, switch):
        if switch==_translate("MainWindow","MediaWiki"): return " -m "
        if switch==_translate("MainWindow","Normal"): return " -i "
        return ""
    def getVector(self, switch):
        if switch==_translate("MainWindow","Rasterize"): return ""
        return "-g"
    def getZip(self, switch):
        if switch==_translate("MainWindow","LaTeX Source Zip"): return "-z"
        if switch==_translate("MainWindow","ODT (Word Processor)"): return "-d"
        if switch==_translate("MainWindow","EPUB"): return "-b"
        return ""

    def scheduleM2L(self):
        """
        Schedules mediawiki2latex with the right arguments, redirecting
        stdout and stderr to browsers.
        """
        cmd = "mediawiki2latex -u {0} {1} {2} {3} -o {4}".format(
            self.edit.text(),
            self.getSwitch(self.combo.currentText()),
            self.getVector(self.rastercombo.currentText()),
            self.getZip(self.inccombo.currentText()),
            self.pdfFile(),
            )
        # the parameter expect=10000 means that 10000 lines are expected in
        # stdout. This parameter can be also a pattern compiled as a regular
        # expression or a callable to filter lines of stdout.
        self.bp=bashProcess(self, cmd=cmd, message=_translate("MainWindow","running mediawiki2latex"),
                       expect=Progressor())
        self.processList.append(self.bp)
        return

    def closeEvent(self, event):
        """
        callback function called when this window is closed.
        may raise a warning dialog if a process is still running.
        """
        # try to erase the temporary PDF file
        if os.path.exists(self.pdfFile()):
            try:
                os.unlink(self.pdfFile());
            except:
                pass
        QMainWindow.closeEvent(self,event);

    def bailOut(self):
        """
        Notifies the end of the sequence of processes. Launches a
        viewer for the output PDF file.
        """
        self.ui.statusbar.showMessage(_translate("MainWindow","The sequence of processes is finished. You can close the window."))
        self.t.stop() # end of tick service
        self.button.setEnabled(True)
        self.ui.tabWidget.setCurrentIndex(0)
        self.pbar.setValue(100)
        webbrowser.open('file://{0}'.format(os.path.abspath(self.pdfFile())))
        return

class Preferences(object):
    """
    User preferences for Mediawiki2latex
    """
    def __init__(self,
                 mwSource="https://en.wikipedia.org/wiki/Homomorphism",
                 ):
        """
        the constructor
        @param mwSource the URL to use as a source, defaults to "http://en.wikipedia.org/wiki/Homomorphism"
        """
        self.mwSource=mwSource
        return

def translationStuff():
  """
  Installs translators
  """
  translationPaths=[QLibraryInfo.location(QLibraryInfo.TranslationsPath),
                    '/usr/share/mediawiki2latex/translations',
                    'lang/translations']
  for transFile in ("qt_{locale}", "mediawiki2latex-gui-{locale}"):
    transFile=transFile.format(locale=locale[0])
    translator = QTranslator()
    for path in translationPaths:
      if translator.load(transFile, path):
        qApp.installTranslator(translator)
        break
  return

#--------------- main ------------------
if __name__ == '__main__':
  APP = QApplication(sys.argv)
  #translationStuff()
  translationPaths=[QLibraryInfo.location(QLibraryInfo.TranslationsPath),
                    '/usr/share/mediawiki2latex/translations',
                    'lang/translations']
  for transFile in ("qt_{locale}", "mediawiki2latex-gui-{locale}"):
    transFile=transFile.format(locale=locale[0])
    translator = QTranslator()
    for path in translationPaths:
      if translator.load(transFile, path):
        APP.installTranslator(translator)
        break

  # style = QStyleFactory.create('Cleanlooks')
  # APP.setStyle(style)
      
  preferences = Preferences() # should read some user config file
  MAINWINDOW = MainWindow (preferences)
  MAINWINDOW.setWindowIcon(QIcon('logo.ico'))
  MAINWINDOW.show ()
  APP.exec_ ()

### for Emacs ###
# Local Variables:
# mode: python
# End: