Exclude If Present #2016
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| from PyQt6 import uic | ||
| from PyQt6.QtCore import QModelIndex, QObject, Qt | ||
| from PyQt6.QtGui import QCursor, QStandardItem, QStandardItemModel | ||
| from PyQt6.QtWidgets import ( | ||
| QAbstractItemView, | ||
| QApplication, | ||
|
|
@@ -85,8 +85,12 @@ def __init__(self, profile, parent=None): | |
| self.bRemovePattern.setIcon(get_colored_icon('minus')) | ||
| self.bPreviewCopy.clicked.connect(self.copy_preview_to_clipboard) | ||
| self.bPreviewCopy.setIcon(get_colored_icon('copy')) | ||
| self.bAddPattern.clicked.connect(self.add_pattern_custom_exclusion) | ||
| self.bAddPattern.setIcon(get_colored_icon('plus')) | ||
| self.bAddPatternExcludeIfPresent.setIcon(get_colored_icon('plus')) | ||
| self.bAddPatternExcludeIfPresent.clicked.connect(self.add_pattern_exclude_if_present) | ||
| self.bRemovePatternExcludeIfPresent.setIcon(get_colored_icon('minus')) | ||
| self.bRemovePatternExcludeIfPresent.clicked.connect(self.remove_pattern_exclude_if_present) | ||
|
|
||
| # help text | ||
| self.customPresetsHelpText.setOpenExternalLinks(True) | ||
|
|
@@ -114,11 +118,33 @@ def __init__(self, profile, parent=None): | |
| "This is a preview of the patterns that will be used to exclude files and folders from the backup.", | ||
| ) | ||
| ) | ||
| self.excludeIfPresentHelpText.setText( | ||
| translate( | ||
| "ExcludeIfPresentHelp", | ||
| "Folders that contain the following files will be excluded from backups.", | ||
| ) | ||
| ) | ||
|
|
||
| # Add the Exclude If Present tab | ||
| self.excludeIfPresentModel = MandatoryInputItemModel(profile=profile) | ||
| self.excludeIfPresentList.setModel(self.excludeIfPresentModel) | ||
| self.excludeIfPresentList.setEditTriggers(QAbstractItemView.EditTrigger.NoEditTriggers) | ||
| self.excludeIfPresentList.setSelectionMode(QAbstractItemView.SelectionMode.ExtendedSelection) | ||
| self.excludeIfPresentList.setFocusPolicy(Qt.FocusPolicy.NoFocus) | ||
| self.excludeIfPresentList.setAlternatingRowColors(True) | ||
| self.excludeIfPresentListDelegate = QStyledItemDelegate() | ||
| self.excludeIfPresentList.setItemDelegate(self.excludeIfPresentListDelegate) | ||
| self.excludeIfPresentListDelegate.closeEditor.connect(self.exclude_if_present_pattern_editing_finished) | ||
| self.excludeIfPresentList.setContextMenuPolicy(Qt.ContextMenuPolicy.CustomContextMenu) | ||
| self.excludeIfPresentList.customContextMenuRequested.connect(self.exclude_if_present_context_menu) | ||
|
|
||
| self.excludeIfPresentModel.itemChanged.connect(self.exclude_if_present_item_changed) | ||
|
|
||
| self.populate_custom_exclusions_list() | ||
| self.populate_presets_list() | ||
| self.populate_raw_exclusions_text() | ||
| self.populate_preview_tab() | ||
| self.populate_exclude_if_present_patterns() | ||
|
|
||
| def populate_custom_exclusions_list(self): | ||
| user_excluded_patterns = { | ||
|
|
@@ -134,37 +160,41 @@ def populate_custom_exclusions_list(self): | |
| item.setCheckState(Qt.CheckState.Checked if enabled else Qt.CheckState.Unchecked) | ||
| self.customExclusionsModel.appendRow(item) | ||
|
|
||
| def create_context_menu(self, list_widget, remove_method, toggle_method=None): | ||
| pos = list_widget.viewport().mapFromGlobal(QCursor.pos()) | ||
| index = list_widget.indexAt(pos) | ||
| if not index.isValid(): | ||
| return | ||
|
|
||
| selected_rows = list_widget.selectedIndexes() | ||
|
|
||
| if selected_rows and index not in selected_rows: | ||
| return | ||
|
|
||
| menu = QMenu(list_widget) | ||
| menu.addAction( | ||
| get_colored_icon('copy'), | ||
| self.tr('Copy'), | ||
| lambda: QApplication.clipboard().setText(index.data()), | ||
| ) | ||
|
|
||
| menu.addAction( | ||
| get_colored_icon('minus'), | ||
| self.tr('Remove'), | ||
| lambda: remove_method(index if not selected_rows else None), | ||
| ) | ||
|
|
||
| if toggle_method: | ||
| menu.addAction( | ||
| get_colored_icon('check-circle'), | ||
| self.tr('Toggle'), | ||
| lambda: toggle_method(index if not selected_rows else None), | ||
| ) | ||
|
|
||
| menu.popup(list_widget.viewport().mapToGlobal(pos)) | ||
|
|
||
| def custom_exclusions_context_menu(self, pos): | ||
| self.create_context_menu(self.customExclusionsList, self.remove_pattern, self.toggle_custom_pattern) | ||
|
|
||
| def populate_presets_list(self): | ||
| for preset_slug in self.allPresets.keys(): | ||
|
|
@@ -190,8 +220,14 @@ def populate_raw_exclusions_text(self): | |
| self.rawExclusionsText.setPlainText(raw_excludes) | ||
|
|
||
| def populate_preview_tab(self): | ||
| preview = self.profile.get_combined_exclusion_string() | ||
| if self.profile.exclude_if_present: | ||
| preview += '\n# Exclude if present' | ||
| for f in self.profile.exclude_if_present.split('\n'): | ||
| f = f.strip() | ||
| if f.startswith('[x]'): | ||
| preview += '\n' + f[3:].strip() | ||
| self.exclusionsPreviewText.setPlainText(preview) | ||
|
|
||
| def copy_preview_to_clipboard(self): | ||
| cb = QApplication.clipboard() | ||
|
|
@@ -242,29 +278,35 @@ def toggle_custom_pattern(self, index=None): | |
| else: | ||
| item.setCheckState(Qt.CheckState.Checked) | ||
|
|
||
| def add_pattern(self, list_widget, model): | ||
| ''' | ||
| Add an empty item to the list in editable mode. | ||
| Don't add an item if the user is already editing an item. | ||
| ''' | ||
| if list_widget.state() == QAbstractItemView.State.EditingState: | ||
| return | ||
| item = QStandardItem('') | ||
| item.setCheckable(True) | ||
| item.setCheckState(Qt.CheckState.Checked) | ||
| model.appendRow(item) | ||
| list_widget.edit(item.index()) | ||
| list_widget.scrollToBottom() | ||
|
|
||
| def add_pattern_custom_exclusion(self): | ||
| self.add_pattern(self.customExclusionsList, self.customExclusionsModel) | ||
|
|
||
| def text_editing_finished(self, model): | ||
| ''' | ||
| Go through all items in the list and if any of them are empty, remove them. | ||
| Handles the case where the user presses the escape key to cancel editing. | ||
| ''' | ||
| for row in range(model.rowCount()): | ||
| item = model.item(row) | ||
| if item.text() == '': | ||
| model.removeRow(row) | ||
|
|
||
| def custom_pattern_editing_finished(self, editor): | ||
| self.text_editing_finished(self.customExclusionsModel) | ||
|
|
||
| def custom_item_changed(self, item): | ||
| ''' | ||
|
|
@@ -310,6 +352,73 @@ def preset_item_changed(self, item): | |
|
|
||
| self.populate_preview_tab() | ||
|
|
||
| def exclude_if_present_item_changed(self, item): | ||
| self.save_exclude_if_present_patterns() | ||
|
|
||
| def exclude_if_present_context_menu(self, pos): | ||
| self.create_context_menu(self.excludeIfPresentList, self.remove_pattern_exclude_if_present) | ||
|
|
||
| def remove_pattern_exclude_if_present(self, index=None): | ||
| if not index: | ||
| indexes = self.excludeIfPresentList.selectedIndexes() | ||
| for index in reversed(sorted(indexes)): | ||
| self.excludeIfPresentModel.removeRow(index.row()) | ||
| else: | ||
| self.excludeIfPresentModel.removeRow(index.row()) | ||
| self.save_exclude_if_present_patterns() | ||
|
|
||
| def add_pattern_exclude_if_present(self): | ||
| self.add_pattern(self.excludeIfPresentList, self.excludeIfPresentModel) | ||
| self.save_exclude_if_present_patterns() | ||
|
|
||
| def exclude_if_present_pattern_editing_finished(self, editor): | ||
| self.text_editing_finished(self.customExclusionsModel) | ||
| self.save_exclude_if_present_patterns() | ||
|
|
||
| def save_exclude_if_present_patterns(self): | ||
| ''' | ||
| Save Exclude If Present files to profile. | ||
| ''' | ||
| patterns = [] | ||
| for row in range(self.excludeIfPresentModel.rowCount()): | ||
| item = self.excludeIfPresentModel.item(row) | ||
| text = item.text().strip() | ||
|
|
||
| # Remove any existing prefix | ||
| if text.startswith('[x] '): | ||
| text = text[4:] | ||
| elif text.startswith('[] '): | ||
| text = text[3:] | ||
|
|
||
| # Add the correct prefix based on the check state | ||
| prefix = '[x] ' if item.checkState() == Qt.CheckState.Checked else '[] ' | ||
| patterns.append(prefix + text) | ||
|
|
||
| self.profile.exclude_if_present = '\n'.join(patterns) | ||
| self.profile.save() | ||
| self.populate_preview_tab() | ||
|
|
||
| def populate_exclude_if_present_patterns(self): | ||
| ''' | ||
| Populate the 'Exclude If Present' list from the profile. | ||
| ''' | ||
| patterns = self.profile.exclude_if_present.split('\n') if self.profile.exclude_if_present else [] | ||
| for pattern in patterns: | ||
| item = QStandardItem() | ||
| if pattern.startswith('[x]'): | ||
| item.setText(pattern[4:]) | ||
| item.setCheckable(True) | ||
| item.setCheckState(Qt.CheckState.Checked) | ||
| elif pattern.startswith('[]'): | ||
| item.setText(pattern[3:]) | ||
| item.setCheckable(True) | ||
| item.setCheckState(Qt.CheckState.Unchecked) | ||
| else: | ||
| item.setText(pattern) | ||
| item.setCheckable(True) | ||
| item.setCheckState(Qt.CheckState.Unchecked) | ||
|
There was a problem hiding this comment. Doesn't this mean that all existing exclude settings the user had are now disabled? There was a problem hiding this comment. @m3nu That's true, I didn't take the existing ones into account. Should I try to make them checked by default? There was a problem hiding this comment. Yes, I would check them by default. |
||
| self.excludeIfPresentModel.appendRow(item) | ||
|
|
||
| def raw_exclusions_saved(self): | ||
| ''' | ||
| When the user saves changes in the raw exclusions text box, add it to the database. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe we don't need a migration here, since the default comes from
models.py. This also avoids duplicating the same content.