Plugins/VcsPlugins/vcsMercurial/HgArchiveDialog.py

# -*- coding: utf-8 -*-

# Copyright (c) 2013 Detlev Offenbach <detlev@die-offenbachs.de>
#

"""
Module implementing a dialog to enter the archive data.
"""

from PyQt4.QtCore import pyqtSlot, QFileInfo
from PyQt4.QtGui import QDialog, QDialogButtonBox

from E5Gui.E5Completers import E5FileCompleter, E5DirCompleter
from E5Gui import E5FileDialog

from .Ui_HgArchiveDialog import Ui_HgArchiveDialog

import Utilities


class HgArchiveDialog(QDialog, Ui_HgArchiveDialog):
    """
    Class implementing a dialog to enter the archive data.
    """
    def __init__(self, vcs, parent=None):
        """
        Constructor
        
        @param vcs reference to the Mercurial object (Hg)
        @param parent reference to the parent widget (QWidget)
        """
        super().__init__(parent)
        self.setupUi(self)
        
        self.__archiveFileCompleter = E5FileCompleter()
        self.__archiveDirCompleter = E5DirCompleter()
        self.__activeCompleter = self.__archiveFileCompleter
        self.archiveEdit.setCompleter(self.__activeCompleter)
        
        self.typeComboBox.addItem(self.trUtf8("Detect Automatically"), "")
        self.typeComboBox.addItem(self.trUtf8("Directory of Files"), "files")
        self.typeComboBox.addItem(self.trUtf8("Uncompressed TAR-Archive"), "tar")
        self.typeComboBox.addItem(self.trUtf8("Bzip2 compressed TAR-Archive"), "tbz2")
        self.typeComboBox.addItem(self.trUtf8("Gzip compressed TAR-Archive"), "tgz")
        self.typeComboBox.addItem(self.trUtf8("Uncompressed ZIP-Archive"), "uzip")
        self.typeComboBox.addItem(self.trUtf8("Compressed ZIP-Archive"), "zip")
        
        self.__unixFileFilters = [
            self.trUtf8("Bzip2 compressed TAR-Archive (*.tar.bz2)"),
            self.trUtf8("Gzip compressed TAR-Archive (*.tar.gz)"),
            self.trUtf8("Uncompressed TAR-Archive (*.tar)"),
        ]
        self.__windowsFileFilters = [
            self.trUtf8("Compressed ZIP-Archive (*.zip)"),
            self.trUtf8("Uncompressed ZIP-Archive (*.uzip)")
        ]
        if Utilities.isWindowsPlatform():
            self.__fileFilters = ";;".join(
                self.__windowsFileFilters + self.__unixFileFilters)
        else:
            self.__fileFilters = ";;".join(
                self.__unixFileFilters + self.__windowsFileFilters)
        self.__fileFilters += ";;" + self.trUtf8("All Files (*)")
        
        self.subReposCheckBox.setEnabled(vcs.hasSubrepositories())
        
        self.buttonBox.button(QDialogButtonBox.Ok).setEnabled(False)
        
        self.__projectPath = \
            vcs.getPlugin().getProjectHelper().getProject().getProjectPath()
    
    @pyqtSlot(str)
    def on_archiveEdit_textChanged(self, archive):
        """
        Private slot to handle changes of the archive name.
        """
        self.buttonBox.button(QDialogButtonBox.Ok).setEnabled(archive != "")
    
    @pyqtSlot()
    def on_archiveButton_clicked(self):
        """
        Private slot to select the archive name via a file selection dialog.
        """
        type_ = self.typeComboBox.itemData(self.typeComboBox.currentIndex())
        
        archive = Utilities.fromNativeSeparators(self.archiveEdit.text())
        if not archive:
            archive = self.__projectPath
        
        if type_ == "files":
            archive = E5FileDialog.getExistingDirectory(
                self,
                self.trUtf8("Select Archive Directory"),
                archive,
                E5FileDialog.Options(E5FileDialog.ShowDirsOnly))
        else:
            archive, selectedFilter = E5FileDialog.getSaveFileNameAndFilter(
                self,
                self.trUtf8("Select Archive File"),
                archive,
                self.__fileFilters,
                None,
                E5FileDialog.Options(E5FileDialog.DontConfirmOverwrite))
            if archive:
                ext = QFileInfo(archive).suffix()
                if not ext:
                    ex = selectedFilter.split("(*")[1].split(")")[0]
                    if ex:
                        archive += ex
        
        if archive:
            self.archiveEdit.setText(Utilities.toNativeSeparators(archive))
    
    @pyqtSlot(int)
    def on_typeComboBox_activated(self, index):
        """
        Private slot to react on changes of the selected archive type.
        
        @param index index of the selected type (integer)
        """
        type_ = self.typeComboBox.itemData(index)
        if type_ == "files":
            if self.__activeCompleter != self.__archiveDirCompleter:
                self.__activeCompleter = self.__archiveDirCompleter
                self.archiveEdit.setCompleter(self.__activeCompleter)
        else:
            # TODO: add name filter to completer based upon selected type
            if self.__activeCompleter != self.__archiveFileCompleter:
                self.__activeCompleter = self.__archiveFileCompleter
                self.archiveEdit.setCompleter(self.__activeCompleter)
    
    def getData(self):
        """
        Public method to retrieve the data.
        
        @return tuple giving the archive name (string), the archive type (string),
            the directory prefix 8string) and a flag indicating to recurse into
            subrepositories (boolean)
        """
        return (
            self.archiveEdit.text(),
            self.typeComboBox.itemData(self.typeComboBox.currentIndex()),
            self.prefixEdit.text(),
            self.subReposCheckBox.isChecked(),
        )