src/eric7/Plugins/VcsPlugins/vcsMercurial/HgArchiveDialog.py

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

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

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

from PyQt6.QtCore import pyqtSlot
from PyQt6.QtWidgets import QDialog, QDialogButtonBox

from eric7.EricWidgets.EricPathPicker import EricPathPickerModes
from eric7.SystemUtilities import OSUtilities

from .Ui_HgArchiveDialog import Ui_HgArchiveDialog


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)
        @type Hg
        @param parent reference to the parent widget
        @type QWidget
        """
        super().__init__(parent)
        self.setupUi(self)

        self.archivePicker.setMode(EricPathPickerModes.SAVE_FILE_ENSURE_EXTENSION_MODE)

        self.typeComboBox.addItem(self.tr("Detect Automatically"), "")
        self.typeComboBox.addItem(self.tr("Directory of Files"), "files")
        self.typeComboBox.addItem(self.tr("Uncompressed TAR-Archive"), "tar")
        self.typeComboBox.addItem(self.tr("Bzip2 compressed TAR-Archive"), "tbz2")
        self.typeComboBox.addItem(self.tr("Gzip compressed TAR-Archive"), "tgz")
        self.typeComboBox.addItem(self.tr("Uncompressed ZIP-Archive"), "uzip")
        self.typeComboBox.addItem(self.tr("Compressed ZIP-Archive"), "zip")

        self.__unixFileFilters = [
            self.tr("Bzip2 compressed TAR-Archive (*.tar.bz2)"),
            self.tr("Gzip compressed TAR-Archive (*.tar.gz)"),
            self.tr("Uncompressed TAR-Archive (*.tar)"),
        ]
        self.__windowsFileFilters = [
            self.tr("Compressed ZIP-Archive (*.zip)"),
            self.tr("Uncompressed ZIP-Archive (*.uzip)"),
        ]
        fileFilters = (
            ";;".join(self.__windowsFileFilters + self.__unixFileFilters)
            if OSUtilities.isWindowsPlatform()
            else ";;".join(self.__unixFileFilters + self.__windowsFileFilters)
        )
        fileFilters += ";;" + self.tr("All Files (*)")

        self.archivePicker.setFilters(fileFilters)

        self.__typeFilters = {
            "tar": ["*.tar"],
            "tbz2": ["*.tar.bz2", "*.tbz2"],
            "tgz": ["*.tar.gz", "*.tgz"],
            "uzip": ["*.uzip", "*.zip"],
            "zip": ["*.zip"],
        }

        self.subReposCheckBox.setEnabled(vcs.hasSubrepositories())

        self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled(False)

        self.__projectPath = (
            vcs.getPlugin().getProjectHelper().getProject().getProjectPath()
        )

        msh = self.minimumSizeHint()
        self.resize(max(self.width(), msh.width()), msh.height())

    @pyqtSlot(str)
    def on_archivePicker_textChanged(self, archive):
        """
        Private slot to handle changes of the archive name.

        @param archive name of the archive
        @type str
        """
        self.buttonBox.button(QDialogButtonBox.StandardButton.Ok).setEnabled(
            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
        @type int
        """
        type_ = self.typeComboBox.itemData(index)
        if type_ == "files":
            self.archivePicker.setMode(EricPathPickerModes.DIRECTORY_MODE)
        else:
            self.archivePicker.setMode(
                EricPathPickerModes.SAVE_FILE_ENSURE_EXTENSION_MODE
            )
            if type_ in self.__typeFilters:
                self.archivePicker.setNameFilters(self.__typeFilters[type_])
            else:
                self.archivePicker.setNameFilters([])

    def getData(self):
        """
        Public method to retrieve the data.

        @return tuple giving the archive name, the archive type, the directory prefix
             and a flag indicating to recurse into subrepositories
        @rtype tuple of (str, str, str, bool)
        """
        return (
            self.archivePicker.text(),
            self.typeComboBox.itemData(self.typeComboBox.currentIndex()),
            self.prefixEdit.text(),
            self.subReposCheckBox.isChecked(),
        )