--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Plugins/VcsPlugins/vcsGit/GitDialog.py Sun Dec 10 17:42:11 2017 +0100
@@ -0,0 +1,311 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2014 - 2017 Detlev Offenbach <detlev@die-offenbachs.de>
+#
+
+"""
+Module implementing a dialog starting a process and showing its output.
+"""
+
+from __future__ import unicode_literals
+try:
+ str = unicode
+except NameError:
+ pass
+
+import os
+
+from PyQt5.QtCore import QProcess, QTimer, pyqtSlot, Qt, QCoreApplication, \
+ QProcessEnvironment
+from PyQt5.QtWidgets import QDialog, QDialogButtonBox, QLineEdit
+
+from E5Gui import E5MessageBox
+
+from .Ui_GitDialog import Ui_GitDialog
+
+from .GitUtilities import strToQByteArray
+
+import Preferences
+
+
+class GitDialog(QDialog, Ui_GitDialog):
+ """
+ Class implementing a dialog starting a process and showing its output.
+
+ It starts a QProcess and displays a dialog that
+ shows the output of the process. The dialog is modal,
+ which causes a synchronized execution of the process.
+ """
+ def __init__(self, text, git=None, parent=None):
+ """
+ Constructor
+
+ @param text text to be shown by the label (string)
+ @param git reference to the Git interface object (Git)
+ @param parent parent widget (QWidget)
+ """
+ super(GitDialog, self).__init__(parent)
+ self.setupUi(self)
+
+ self.buttonBox.button(QDialogButtonBox.Close).setEnabled(False)
+ self.buttonBox.button(QDialogButtonBox.Cancel).setDefault(True)
+
+ self.process = None
+ self.username = ''
+ self.password = ''
+ self.vcs = git
+
+ self.outputGroup.setTitle(text)
+
+ self.show()
+ QCoreApplication.processEvents()
+
+ def __finish(self):
+ """
+ Private slot called when the process finished or the user pressed
+ the button.
+ """
+ if self.process is not None and \
+ self.process.state() != QProcess.NotRunning:
+ self.process.terminate()
+ QTimer.singleShot(2000, self.process.kill)
+ self.process.waitForFinished(3000)
+
+ self.inputGroup.setEnabled(False)
+ self.inputGroup.hide()
+
+ self.process = None
+
+ self.buttonBox.button(QDialogButtonBox.Close).setEnabled(True)
+ self.buttonBox.button(QDialogButtonBox.Cancel).setEnabled(False)
+ self.buttonBox.button(QDialogButtonBox.Close).setDefault(True)
+ self.buttonBox.button(QDialogButtonBox.Close).setFocus(
+ Qt.OtherFocusReason)
+
+ if self.normal and self.errors.toPlainText():
+ self.errorGroup.setTitle(self.tr("Additional Output"))
+
+ if Preferences.getVCS("AutoClose") and \
+ self.normal and \
+ self.errors.toPlainText() == "":
+ self.accept()
+
+ def on_buttonBox_clicked(self, button):
+ """
+ Private slot called by a button of the button box clicked.
+
+ @param button button that was clicked (QAbstractButton)
+ """
+ if button == self.buttonBox.button(QDialogButtonBox.Close):
+ self.close()
+ elif button == self.buttonBox.button(QDialogButtonBox.Cancel):
+ self.statusLabel.setText(self.tr("Process canceled."))
+ self.__finish()
+
+ def __procFinished(self, exitCode, exitStatus):
+ """
+ Private slot connected to the finished signal.
+
+ @param exitCode exit code of the process (integer)
+ @param exitStatus exit status of the process (QProcess.ExitStatus)
+ """
+ self.normal = (exitStatus == QProcess.NormalExit) and (exitCode == 0)
+ if self.normal:
+ self.statusLabel.setText(self.tr("Process finished successfully."))
+ elif exitStatus == QProcess.CrashExit:
+ self.statusLabel.setText(self.tr("Process crashed."))
+ else:
+ self.statusLabel.setText(
+ self.tr("Proces finished with exit code {0}").format(exitCode))
+ self.__finish()
+
+ def startProcess(self, args, workingDir=None, showArgs=True,
+ environment=None):
+ """
+ Public slot used to start the process.
+
+ @param args list of arguments for the process (list of strings)
+ @keyparam workingDir working directory for the process (string)
+ @keyparam showArgs flag indicating to show the arguments (boolean)
+ @keyparam environment dictionary of environment settings to add
+ or change for the git process (dict of string and string)
+ @return flag indicating a successful start of the process (boolean)
+ """
+ self.errorGroup.hide()
+ self.normal = False
+ self.intercept = False
+
+ if environment is None:
+ environment = {}
+
+ self.__hasAddOrDelete = False
+ if args[0] in ["checkout", "fetch", "pull", "rebase", "reset",
+ "merge", "cherry-pick", "stash"]:
+ self.__updateCommand = True
+ else:
+ self.__updateCommand = False
+
+ if showArgs:
+ self.resultbox.append(' '.join(args))
+ self.resultbox.append('')
+
+ self.process = QProcess()
+ if environment:
+ env = QProcessEnvironment.systemEnvironment()
+ for key, value in environment.items():
+ env.insert(key, value)
+ self.process.setProcessEnvironment(env)
+
+ self.process.finished.connect(self.__procFinished)
+ self.process.readyReadStandardOutput.connect(self.__readStdout)
+ self.process.readyReadStandardError.connect(self.__readStderr)
+
+ if workingDir:
+ self.process.setWorkingDirectory(workingDir)
+ self.process.start('git', args)
+ procStarted = self.process.waitForStarted(5000)
+ if not procStarted:
+ self.buttonBox.setFocus()
+ self.inputGroup.setEnabled(False)
+ E5MessageBox.critical(
+ self,
+ self.tr('Process Generation Error'),
+ self.tr(
+ 'The process {0} could not be started. '
+ 'Ensure, that it is in the search path.'
+ ).format('git'))
+ else:
+ self.inputGroup.setEnabled(True)
+ self.inputGroup.show()
+ return procStarted
+
+ def normalExit(self):
+ """
+ Public method to check for a normal process termination.
+
+ @return flag indicating normal process termination (boolean)
+ """
+ return self.normal
+
+ def normalExitWithoutErrors(self):
+ """
+ Public method to check for a normal process termination without
+ error messages.
+
+ @return flag indicating normal process termination (boolean)
+ """
+ return self.normal and self.errors.toPlainText() == ""
+
+ def __readStdout(self):
+ """
+ Private slot to handle the readyReadStandardOutput signal.
+
+ It reads the output of the process, formats it and inserts it into
+ the contents pane.
+ """
+ if self.process is not None:
+ s = str(self.process.readAllStandardOutput(),
+ Preferences.getSystem("IOEncoding"),
+ 'replace')
+ self.__showOutput(s)
+
+ def __showOutput(self, out):
+ """
+ Private slot to show some output.
+
+ @param out output to be shown (string)
+ """
+ self.resultbox.insertPlainText(out)
+ self.resultbox.ensureCursorVisible()
+
+ # check for a changed project file
+ if self.__updateCommand:
+ for line in out.splitlines():
+ if '.e4p' in line or '.e6p' in line:
+ self.__hasAddOrDelete = True
+ break
+
+ QCoreApplication.processEvents()
+
+ def __readStderr(self):
+ """
+ Private slot to handle the readyReadStandardError signal.
+
+ It reads the error output of the process and inserts it into the
+ error pane.
+ """
+ if self.process is not None:
+ s = str(self.process.readAllStandardError(),
+ Preferences.getSystem("IOEncoding"),
+ 'replace')
+ self.__showError(s)
+
+ def __showError(self, out):
+ """
+ Private slot to show some error.
+
+ @param out error to be shown (string)
+ """
+ self.errorGroup.show()
+ self.errors.insertPlainText(out)
+ self.errors.ensureCursorVisible()
+
+ QCoreApplication.processEvents()
+
+ def on_passwordCheckBox_toggled(self, isOn):
+ """
+ Private slot to handle the password checkbox toggled.
+
+ @param isOn flag indicating the status of the check box (boolean)
+ """
+ if isOn:
+ self.input.setEchoMode(QLineEdit.Password)
+ else:
+ self.input.setEchoMode(QLineEdit.Normal)
+
+ @pyqtSlot()
+ def on_sendButton_clicked(self):
+ """
+ Private slot to send the input to the git process.
+ """
+ inputTxt = self.input.text()
+ inputTxt += os.linesep
+
+ if self.passwordCheckBox.isChecked():
+ self.errors.insertPlainText(os.linesep)
+ self.errors.ensureCursorVisible()
+ else:
+ self.errors.insertPlainText(inputTxt)
+ self.errors.ensureCursorVisible()
+
+ self.process.write(strToQByteArray(inputTxt))
+
+ self.passwordCheckBox.setChecked(False)
+ self.input.clear()
+
+ def on_input_returnPressed(self):
+ """
+ Private slot to handle the press of the return key in the input field.
+ """
+ self.intercept = True
+ self.on_sendButton_clicked()
+
+ def keyPressEvent(self, evt):
+ """
+ Protected slot to handle a key press event.
+
+ @param evt the key press event (QKeyEvent)
+ """
+ if self.intercept:
+ self.intercept = False
+ evt.accept()
+ return
+ super(GitDialog, self).keyPressEvent(evt)
+
+ def hasAddOrDelete(self):
+ """
+ Public method to check, if the last action contained an add or delete.
+
+ @return flag indicating the presence of an add or delete (boolean)
+ """
+ return self.__hasAddOrDelete
