Skip to content

Offer to init repo when adding existing repo fails (#1799) #2417

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SaurabhCodesAI wants to merge 1 commit into
base: master
Choose a base branch
from
+217 −85
Open

Offer to init repo when adding existing repo fails (#1799) #2417

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 73 additions & 42 deletions src/vorta/views/dialogs/repo/repo_add.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
QDialogButtonBox,
QFormLayout,
QLabel,
QMessageBox,
QSizePolicy,
)

Expand All @@ -15,7 +16,7 @@
from vorta.keyring.abc import VortaKeyring
from vorta.store.models import RepoModel
from vorta.utils import borg_compat, choose_file_dialog, get_asset, get_private_keys
from vorta.views.partials.password_input import PasswordInput, PasswordLineEdit
from vorta.views.partials.password_input import PasswordInput
from vorta.views.utils import get_colored_icon

uifile = get_asset('UI/dialogs/repo/repo_add.ui')
Expand Down Expand Up @@ -131,7 +132,8 @@ def values(self):
class AddRepoWindow(RepoWindow):
def __init__(self, parent=None):
super().__init__(parent)
self.setWindowTitle("Add New Repository")
self.setWindowTitle("Add Repository")
self.title.setText(self.tr('Add Repository'))

self.passwordInput = PasswordInput()
self.passwordInput.add_form_to_layout(self.repoDataFormLayout)
Expand All @@ -149,6 +151,9 @@ def __init__(self, parent=None):
self.display_backend_warning()
self.init_encryption()

# start in "connect" mode: hide init only widgets
self._set_init_widgets_visible(False)

def set_password(self, URL):
'''Autofill password from keyring only if current entry is empty'''
password = VortaKeyring.get_keyring().get_password('vorta-repo', URL)
Expand Down Expand Up @@ -209,48 +214,74 @@ def display_backend_warning(self):
if self.encryptionComboBox.currentData() != 'none':
self.passwordInput.set_error_label(VortaKeyring.get_keyring().get_backend_warning())

def validate(self):
return super().validate() and self.passwordInput.validate()

def run(self):
if self.validate():
params = BorgInitJob.prepare(self.values)
if params['ok']:
self.saveButton.setEnabled(False)
job = BorgInitJob(params['cmd'], params)
job.updated.connect(self._set_status)
job.result.connect(self.run_result)
QApplication.instance().jobs_manager.add_job(job)
else:
self._set_status(params['message'])


class ExistingRepoWindow(RepoWindow):
def __init__(self):
super().__init__()
self.title.setText(self.tr('Connect to existing Repository'))
self.setWindowTitle("Add Existing Repository")
def _set_init_widgets_visible(self, visible):
self.passwordInput.confirmLineEdit.setVisible(visible)
self.passwordInput._label_confirm.setVisible(visible)
self.encryptionLabel.setVisible(visible)
self.encryptionComboBox.setVisible(visible)
if not visible:
self.passwordInput.set_validation_enabled(False)

self.passwordLabel = QLabel(self.tr('Password:'))
self.passwordInput = PasswordLineEdit(placeholder_text=self.tr("Enter the encryption passphrase"))
self.repoDataFormLayout.addRow(self.passwordLabel, self.passwordInput)
def _validate_repo_fields(self):
return super().validate()

def set_password(self, URL):
'''Autofill password from keyring only if current entry is empty'''
password = VortaKeyring.get_keyring().get_password('vorta-repo', URL)
if password and self.passwordInput.get_password() == "":
self._set_status(self.tr("Autofilled password from password manager."))
self.passwordInput.setText(password)
def validate(self):
return self._validate_repo_fields() and self.passwordInput.validate()

def run(self):
if self.validate():
params = BorgInfoRepoJob.prepare(self.values)
if params['ok']:
self.saveButton.setEnabled(False)
job = BorgInfoRepoJob(params['cmd'], params)
job.updated.connect(self._set_status)
job.result.connect(self.run_result)
self.thread = job # Keep reference for tests
QApplication.instance().jobs_manager.add_job(job)
if not self._validate_repo_fields():
return

self.saveButton.setEnabled(False)
self._set_status(self.tr('Checking repository…'))
params = BorgInfoRepoJob.prepare(self.values)
if params['ok']:
job = BorgInfoRepoJob(params['cmd'], params)
job.updated.connect(self._set_status)
job.result.connect(self._probe_result)
QApplication.instance().jobs_manager.add_job(job)
else:
self.saveButton.setEnabled(True)
self._set_status(params['message'])

def _probe_result(self, result):
if result['returncode'] == 0:
self.saveButton.setEnabled(True)
self.added_repo.emit(result)
self.accept()
else:
error_msgs = ' '.join(msg for _, msg in result.get('errors', []))
if 'does not exist' in error_msgs.lower() or 'is not a valid repository' in error_msgs.lower():
reply = QMessageBox.question(
self,
self.tr('Repository not found'),
self.tr('No repository found at this location. Initialize a new one?'),
QMessageBox.StandardButton.Yes | QMessageBox.StandardButton.No,
QMessageBox.StandardButton.No,
)
if reply == QMessageBox.StandardButton.Yes:
self._set_init_widgets_visible(True)
self.passwordInput.set_validation_enabled(True)
self._set_status(self.tr('Please confirm your password and choose encryption to initialize.'))
if not self.passwordInput.validate():
self.saveButton.setEnabled(True)
return
self._init_repo()
else:
self.saveButton.setEnabled(True)
self._set_status(self.tr('Unable to add your repository.'))
else:
self._set_status(params['message'])
self.saveButton.setEnabled(True)
self._set_status(error_msgs if error_msgs else self.tr('Unable to add your repository.'))

def _init_repo(self):
self._set_status(self.tr('Initializing new repository…'))
params = BorgInitJob.prepare(self.values)
if params['ok']:
job = BorgInitJob(params['cmd'], params)
job.updated.connect(self._set_status)
job.result.connect(self.run_result)
QApplication.instance().jobs_manager.add_job(job)
else:
self.saveButton.setEnabled(True)
self._set_status(params['message'])
23 changes: 3 additions & 20 deletions src/vorta/views/repo_tab.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
from vorta.i18n.richtext import escape, format_richtext, link
from vorta.store.models import ArchiveModel, RepoModel
from vorta.utils import borg_compat, get_asset, get_private_keys, pretty_bytes
from vorta.views.dialogs.repo.repo_add import AddRepoWindow, ExistingRepoWindow
from vorta.views.dialogs.repo.repo_add import AddRepoWindow
from vorta.views.dialogs.repo.repo_change_passphrase import ChangeBorgPassphraseWindow
from vorta.views.dialogs.repo.ssh import SSHAddWindow

Expand All @@ -35,13 +35,7 @@ def __init__(self, parent=None, profile_provider=None):
# Populate dropdowns
self.copyURLbutton.clicked.connect(self.copy_URL_action)

# init repo add button
self.menuAddRepo = QMenu(self.bAddRepo)

self.menuAddRepo.addAction(self.tr("New Repository…"), self.new_repo)
self.menuAddRepo.addAction(self.tr("Existing Repository…"), self.add_existing_repo)

self.bAddRepo.setMenu(self.menuAddRepo)
self.bAddRepo.clicked.connect(self.add_repo)

# init repo util button
self.menuRepoUtil = QMenu(self.bRepoUtil)
Expand Down Expand Up @@ -267,22 +261,11 @@ def ssh_copy_to_clipboard_action(self):
def compression_select_action(self, index):
self.save_profile_attr('compression', self.repoCompression.currentData())

def new_repo(self):
"""Open a dialog to create a new repo and add it to vorta."""
def add_repo(self):
window = AddRepoWindow()
self._window = window # For tests
window.setParent(self, QtCore.Qt.WindowType.Sheet)
window.added_repo.connect(self.process_new_repo)
# window.rejected.connect(lambda: self.repoSelector.setCurrentIndex(0))
window.open()

def add_existing_repo(self):
"""Open a dialog to add a existing repo to vorta."""
window = ExistingRepoWindow()
self._window = window # For tests
window.setParent(self, QtCore.Qt.WindowType.Sheet)
window.added_repo.connect(self.process_new_repo)
# window.rejected.connect(lambda: self.repoSelector.setCurrentIndex(0))
window.open()

def repo_select_action(self):
Expand Down
7 changes: 5 additions & 2 deletions tests/integration/test_init.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
def test_create_repo(qapp, qtbot, monkeypatch, choose_file_dialog, tmpdir):
"""Test initializing a new repository"""
main = qapp.main_window
main.repoTab.new_repo()
main.repoTab.add_repo()
add_repo_window = main.repoTab._window
main.show()

Expand All @@ -44,6 +44,9 @@ def test_create_repo(qapp, qtbot, monkeypatch, choose_file_dialog, tmpdir):
qtbot.keyClicks(add_repo_window.passwordInput.passwordLineEdit, LONG_PASSWORD)
qtbot.keyClicks(add_repo_window.passwordInput.confirmLineEdit, LONG_PASSWORD)

# borg info fails for new/empty directories, triggering an init confirmation prompt
monkeypatch.setattr(QMessageBox, "question", lambda *args, **kwargs: QMessageBox.StandardButton.Yes)

initial_count = main.repoTab.repoSelector.count()
add_repo_window.run()

Expand Down Expand Up @@ -88,7 +91,7 @@ def test_add_existing_repo(qapp, qtbot, monkeypatch, choose_file_dialog):
)

# add existing repo again
main.repoTab.add_existing_repo()
main.repoTab.add_repo()
add_repo_window = main.repoTab._window

monkeypatch.setattr(
Expand Down
Loading
Loading