def on_verify_token_finished(self, res):
if res == OAuth2Session.Success:
self.auth_session.save_creds()
# switch to next page
self.stackedWidget.slideInIdx(2)
self.pushButtonDropboxPathSelect.setFocus()
self.lineEditAuthCode.clear(
) # clear since we might come back on unlink
# start Maestral after linking to Dropbox account
self.mdbx = Maestral(self._config_name, run=False)
self.mdbx.get_account_info()
elif res == OAuth2Session.InvalidToken:
msg = "Please make sure that you entered the correct authentication token."
msg_box = UserDialog("Authentication failed.", msg, parent=self)
msg_box.open()
elif res == OAuth2Session.ConnectionFailed:
msg = "Please make sure that you are connected to the internet and try again."
msg_box = UserDialog("Connection failed.", msg, parent=self)
msg_box.open()
self.progressIndicator.stopAnimation()
self.pushButtonAuthPageLink.setEnabled(True)
self.lineEditAuthCode.setEnabled(True)
def unlink(config_name: str):
"""Unlinks your Dropbox account."""
if _is_maestral_linked(config_name):
from maestral.sync.main import Maestral
stop_daemon_with_cli_feedback(config_name)
m = Maestral(config_name, run=False)
m.unlink()
click.echo("Unlinked Maestral.")
def get_maestral_proxy(config_name="maestral", fallback=False):
"""
Returns a Pyro proxy of the a running Maestral instance. If ``fallback`` is
``True``, a new instance of Maestral will be returned when the daemon cannot be
reached.
:param str config_name: The name of the Maestral configuration to use.
:param bool fallback: If ``True``, a new instance of Maestral will be returned when
the daemon cannot be reached. Defaults to ``False``.
:returns: Pyro proxy of Maestral or a new instance.
:raises: ``Pyro5.errors.CommunicationError`` if the daemon cannot be reached and
``fallback`` is ``False``.
"""
pid = get_maestral_pid(config_name)
if pid:
sock_name = sockpath_for_config(config_name)
sys.excepthook = Pyro5.errors.excepthook
maestral_daemon = Proxy(URI.format(config_name, "./u:" + sock_name))
try:
maestral_daemon._pyroBind()
return maestral_daemon
except Pyro5.errors.CommunicationError:
maestral_daemon._pyroRelease()
if fallback:
from maestral.sync.main import Maestral
m = Maestral(config_name, run=False)
m._log_handler_stream.setLevel(logging.CRITICAL)
return m
else:
raise Pyro5.errors.CommunicationError
def start(config_name: str, foreground: bool):
"""Starts the Maestral as a daemon."""
from maestral.sync.daemon import get_maestral_pid
# do nothing if already running
if get_maestral_pid(config_name):
click.echo("Maestral daemon is already running.")
return
from maestral.sync.main import Maestral
pending_link = not _is_maestral_linked(config_name)
pending_folder = Maestral.pending_dropbox_folder(config_name)
# run setup if not yet done
if pending_link or pending_folder:
m = Maestral(config_name, run=False)
m.create_dropbox_directory()
m.set_excluded_folders()
m.sync.last_cursor = ""
m.sync.last_sync = 0
del m
# start daemon
if foreground:
from maestral.sync.daemon import run_maestral_daemon
run_maestral_daemon(config_name, run=True, log_to_stdout=True)
else:
start_daemon_subprocess_with_cli_feedback(config_name)
def set_dir(config_name: str, new_path: str):
"""Change the location of your Dropbox folder."""
if _is_maestral_linked(config_name):
from maestral.sync.main import Maestral
from maestral.sync.daemon import MaestralProxy
with MaestralProxy(config_name, fallback=True) as m:
if not new_path:
# don't use the remote instance because we need console interaction
new_path = Maestral._ask_for_path(config_name)
m.move_dropbox_directory(new_path)
click.echo("Dropbox folder moved to {}.".format(new_path))
def _is_maestral_linked(config_name):
"""
This does not create a Maestral instance and is therefore safe to call from anywhere
at any time.
"""
from maestral.sync.main import Maestral
from keyring.errors import KeyringLocked
try:
if Maestral.pending_link(config_name):
click.echo("No Dropbox account linked.")
return False
else:
return True
except KeyringLocked:
click.echo("Error: Cannot access user keyring to load Dropbox credentials.")
def __init__(self, config_name='maestral', pending_link=True, parent=None):
super(self.__class__, self).__init__(parent=parent)
# load user interface layout from .ui file
uic.loadUi(SETUP_DIALOG_PATH, self)
self._config_name = config_name
self._conf = MaestralConfig(config_name)
self.app_icon = QtGui.QIcon(APP_ICON_PATH)
self.labelIcon_0.setPixmap(icon_to_pixmap(self.app_icon, 150))
self.labelIcon_1.setPixmap(icon_to_pixmap(self.app_icon, 70))
self.labelIcon_2.setPixmap(icon_to_pixmap(self.app_icon, 70))
self.labelIcon_3.setPixmap(icon_to_pixmap(self.app_icon, 120))
self.mdbx = None
self.dbx_model = None
self.excluded_folders = []
# resize dialog buttons
width = self.pushButtonAuthPageCancel.width() * 1.1
for b in (self.pushButtonAuthPageLink,
self.pushButtonDropboxPathUnlink,
self.pushButtonDropboxPathSelect,
self.pushButtonFolderSelectionBack,
self.pushButtonFolderSelectionSelect,
self.pushButtonAuthPageCancel,
self.pushButtonDropboxPathCalcel, self.pushButtonClose):
b.setMinimumWidth(width)
b.setMaximumWidth(width)
# set up combobox
self.dropbox_location = osp.dirname(self._conf.get(
"main", "path")) or get_home_dir()
relative_path = self.rel_path(self.dropbox_location)
folder_icon = get_native_item_icon(self.dropbox_location)
self.comboBoxDropboxPath.addItem(folder_icon, relative_path)
self.comboBoxDropboxPath.insertSeparator(1)
self.comboBoxDropboxPath.addItem(QtGui.QIcon(), "Other...")
self.comboBoxDropboxPath.currentIndexChanged.connect(self.on_combobox)
self.dropbox_folder_dialog = QtWidgets.QFileDialog(self)
self.dropbox_folder_dialog.setAcceptMode(
QtWidgets.QFileDialog.AcceptOpen)
self.dropbox_folder_dialog.setFileMode(QtWidgets.QFileDialog.Directory)
self.dropbox_folder_dialog.setOption(
QtWidgets.QFileDialog.ShowDirsOnly, True)
self.dropbox_folder_dialog.fileSelected.connect(self.on_new_dbx_folder)
self.dropbox_folder_dialog.rejected.connect(
lambda: self.comboBoxDropboxPath.setCurrentIndex(0))
# connect buttons to callbacks
self.setAttribute(QtCore.Qt.WA_DeleteOnClose)
self.pushButtonLink.clicked.connect(self.on_link)
self.pushButtonAuthPageCancel.clicked.connect(self.on_reject_requested)
self.pushButtonAuthPageLink.clicked.connect(self.on_auth_clicked)
self.pushButtonDropboxPathCalcel.clicked.connect(
self.on_reject_requested)
self.pushButtonDropboxPathSelect.clicked.connect(
self.on_dropbox_location_selected)
self.pushButtonDropboxPathUnlink.clicked.connect(
self.unlink_and_go_to_start)
self.pushButtonFolderSelectionBack.clicked.connect(
self.stackedWidget.slideInPrev)
self.pushButtonFolderSelectionSelect.clicked.connect(
self.on_folders_selected)
self.pushButtonClose.clicked.connect(self.on_accept_requested)
self.selectAllCheckBox.clicked.connect(self.on_select_all_clicked)
default_dir_name = self._conf.get("main", "default_dir_name")
self.labelDropboxPath.setText(
self.labelDropboxPath.text().format(default_dir_name))
# check if we are already authenticated, skip authentication if yes
if not pending_link:
self.mdbx = Maestral(self._config_name, run=False)
self.mdbx.get_account_info()
self.labelDropboxPath.setText("""
<html><head/><body>
<p align="left">
Your Dropbox folder has been moved or deleted from its original location.
Maestral will not work properly until you move it back. It used to be located
at: </p><p align="left">{0}</p>
<p align="left">
To move it back, click "Quit" below, move the Dropbox folder back to its
original location, and launch Maestral again.
</p>
<p align="left">
To re-download your Dropbox, please select a location for your Dropbox
folder below. Maestral will create a new folder named "{1}" in the
selected location.</p>
<p align="left">
To unlink your Dropbox account from Maestral, click "Unlink" below.</p>
</body></html>
""".format(self._conf.get("main", "path"), default_dir_name))
self.pushButtonDropboxPathCalcel.setText("Quit")
self.stackedWidget.setCurrentIndex(2)
self.stackedWidgetButtons.setCurrentIndex(2)
else:
self.stackedWidget.setCurrentIndex(0)
self.stackedWidgetButtons.setCurrentIndex(0)
class SetupDialog(QtWidgets.QDialog):
"""A dialog to link and set up a new Dropbox account."""
auth_session = ""
auth_url = ""
accepted = False
def __init__(self, config_name='maestral', pending_link=True, parent=None):
super(self.__class__, self).__init__(parent=parent)
# load user interface layout from .ui file
uic.loadUi(SETUP_DIALOG_PATH, self)
self._config_name = config_name
self._conf = MaestralConfig(config_name)
self.app_icon = QtGui.QIcon(APP_ICON_PATH)
self.labelIcon_0.setPixmap(icon_to_pixmap(self.app_icon, 150))
self.labelIcon_1.setPixmap(icon_to_pixmap(self.app_icon, 70))
self.labelIcon_2.setPixmap(icon_to_pixmap(self.app_icon, 70))
self.labelIcon_3.setPixmap(icon_to_pixmap(self.app_icon, 120))
self.mdbx = None
self.dbx_model = None
self.excluded_folders = []
# resize dialog buttons
width = self.pushButtonAuthPageCancel.width() * 1.1
for b in (self.pushButtonAuthPageLink,
self.pushButtonDropboxPathUnlink,
self.pushButtonDropboxPathSelect,
self.pushButtonFolderSelectionBack,
self.pushButtonFolderSelectionSelect,
self.pushButtonAuthPageCancel,
self.pushButtonDropboxPathCalcel, self.pushButtonClose):
b.setMinimumWidth(width)
b.setMaximumWidth(width)
# set up combobox
self.dropbox_location = osp.dirname(self._conf.get(
"main", "path")) or get_home_dir()
relative_path = self.rel_path(self.dropbox_location)
folder_icon = get_native_item_icon(self.dropbox_location)
self.comboBoxDropboxPath.addItem(folder_icon, relative_path)
self.comboBoxDropboxPath.insertSeparator(1)
self.comboBoxDropboxPath.addItem(QtGui.QIcon(), "Other...")
self.comboBoxDropboxPath.currentIndexChanged.connect(self.on_combobox)
self.dropbox_folder_dialog = QtWidgets.QFileDialog(self)
self.dropbox_folder_dialog.setAcceptMode(
QtWidgets.QFileDialog.AcceptOpen)
self.dropbox_folder_dialog.setFileMode(QtWidgets.QFileDialog.Directory)
self.dropbox_folder_dialog.setOption(
QtWidgets.QFileDialog.ShowDirsOnly, True)
self.dropbox_folder_dialog.fileSelected.connect(self.on_new_dbx_folder)
self.dropbox_folder_dialog.rejected.connect(
lambda: self.comboBoxDropboxPath.setCurrentIndex(0))
# connect buttons to callbacks
self.setAttribute(QtCore.Qt.WA_DeleteOnClose)
self.pushButtonLink.clicked.connect(self.on_link)
self.pushButtonAuthPageCancel.clicked.connect(self.on_reject_requested)
self.pushButtonAuthPageLink.clicked.connect(self.on_auth_clicked)
self.pushButtonDropboxPathCalcel.clicked.connect(
self.on_reject_requested)
self.pushButtonDropboxPathSelect.clicked.connect(
self.on_dropbox_location_selected)
self.pushButtonDropboxPathUnlink.clicked.connect(
self.unlink_and_go_to_start)
self.pushButtonFolderSelectionBack.clicked.connect(
self.stackedWidget.slideInPrev)
self.pushButtonFolderSelectionSelect.clicked.connect(
self.on_folders_selected)
self.pushButtonClose.clicked.connect(self.on_accept_requested)
self.selectAllCheckBox.clicked.connect(self.on_select_all_clicked)
default_dir_name = self._conf.get("main", "default_dir_name")
self.labelDropboxPath.setText(
self.labelDropboxPath.text().format(default_dir_name))
# check if we are already authenticated, skip authentication if yes
if not pending_link:
self.mdbx = Maestral(self._config_name, run=False)
self.mdbx.get_account_info()
self.labelDropboxPath.setText("""
<html><head/><body>
<p align="left">
Your Dropbox folder has been moved or deleted from its original location.
Maestral will not work properly until you move it back. It used to be located
at: </p><p align="left">{0}</p>
<p align="left">
To move it back, click "Quit" below, move the Dropbox folder back to its
original location, and launch Maestral again.
</p>
<p align="left">
To re-download your Dropbox, please select a location for your Dropbox
folder below. Maestral will create a new folder named "{1}" in the
selected location.</p>
<p align="left">
To unlink your Dropbox account from Maestral, click "Unlink" below.</p>
</body></html>
""".format(self._conf.get("main", "path"), default_dir_name))
self.pushButtonDropboxPathCalcel.setText("Quit")
self.stackedWidget.setCurrentIndex(2)
self.stackedWidgetButtons.setCurrentIndex(2)
else:
self.stackedWidget.setCurrentIndex(0)
self.stackedWidgetButtons.setCurrentIndex(0)
# =============================================================================
# Main callbacks
# =============================================================================
def closeEvent(self, event):
if self.stackedWidget.currentIndex == 4:
self.on_accept_requested()
else:
self.on_reject_requested()
@QtCore.pyqtSlot()
def on_accept_requested(self):
del self.mdbx
self.accepted = True
self.accept()
@QtCore.pyqtSlot()
def on_reject_requested(self):
if self.mdbx:
self.mdbx.set_conf("main", "path", "")
del self.mdbx
self.accepted = False
self.reject()
def unlink_and_go_to_start(self, b):
self.mdbx.unlink()
self.stackedWidget.slideInIdx(0)
@QtCore.pyqtSlot()
def on_link(self):
self.auth_session = OAuth2Session(self._config_name)
self.auth_url = self.auth_session.get_auth_url()
prompt = self.labelAuthLink.text().format(self.auth_url)
self.labelAuthLink.setText(prompt)
self.stackedWidget.fadeInIdx(1)
self.pushButtonAuthPageLink.setFocus()
@QtCore.pyqtSlot()
def on_auth_clicked(self):
if self.lineEditAuthCode.text() == "":
msg = "Please enter an authentication token."
msg_box = UserDialog("Authentication failed.", msg, parent=self)
msg_box.open()
else:
self.progressIndicator.startAnimation()
self.pushButtonAuthPageLink.setEnabled(False)
self.lineEditAuthCode.setEnabled(False)
self.verify_token_async()
def verify_token_async(self):
token = self.lineEditAuthCode.text()
self.auth_task = BackgroundTask(
parent=self,
target=self.auth_session.verify_auth_token,
args=(token, ))
self.auth_task.sig_done.connect(self.on_verify_token_finished)
def on_verify_token_finished(self, res):
if res == OAuth2Session.Success:
self.auth_session.save_creds()
# switch to next page
self.stackedWidget.slideInIdx(2)
self.pushButtonDropboxPathSelect.setFocus()
self.lineEditAuthCode.clear(
) # clear since we might come back on unlink
# start Maestral after linking to Dropbox account
self.mdbx = Maestral(self._config_name, run=False)
self.mdbx.get_account_info()
elif res == OAuth2Session.InvalidToken:
msg = "Please make sure that you entered the correct authentication token."
msg_box = UserDialog("Authentication failed.", msg, parent=self)
msg_box.open()
elif res == OAuth2Session.ConnectionFailed:
msg = "Please make sure that you are connected to the internet and try again."
msg_box = UserDialog("Connection failed.", msg, parent=self)
msg_box.open()
self.progressIndicator.stopAnimation()
self.pushButtonAuthPageLink.setEnabled(True)
self.lineEditAuthCode.setEnabled(True)
@QtCore.pyqtSlot()
def on_dropbox_location_selected(self):
# reset sync status, we are starting fresh!
self.mdbx.sync.last_cursor = ""
self.mdbx.sync.last_sync = 0
self.mdbx.sync.dropbox_path = ""
# apply dropbox path
dropbox_path = osp.join(self.dropbox_location,
self.mdbx.get_conf("main", "default_dir_name"))
if osp.isdir(dropbox_path):
msg = ('The folder "{}" already exists. Would '
'you like to keep using it?').format(dropbox_path)
msg_box = UserDialog("Folder already exists", msg, parent=self)
msg_box.setAcceptButtonName("Keep")
msg_box.addSecondAcceptButton("Replace", icon="edit-clear")
msg_box.addCancelButton()
res = msg_box.exec_()
if res == 1:
pass
elif res == 2:
shutil.rmtree(dropbox_path, ignore_errors=True)
else:
return
elif osp.isfile(dropbox_path):
msg = (
'There already is a file named "{0}" at this location. Would '
'you like to replace it?'.format(
self.mdbx.get_conf("main", "default_dir_name")))
msg_box = UserDialog("File conflict", msg, parent=self)
msg_box.setAcceptButtonName("Replace")
msg_box.addCancelButton()
res = msg_box.exec_()
if res == 0:
return
else:
delete_file_or_folder(dropbox_path)
self.mdbx.create_dropbox_directory(path=dropbox_path, overwrite=False)
# switch to next page
self.mdbx.set_conf("main", "excluded_folders", [])
self.stackedWidget.slideInIdx(3)
self.treeViewFolders.setFocus()
# populate folder list
if not self.excluded_folders: # don't repopulate
self.populate_folders_list()
@QtCore.pyqtSlot()
def on_folders_selected(self):
self.apply_selection()
self.mdbx.set_conf("main", "excluded_folders", self.excluded_folders)
# if any excluded folders are currently on the drive, delete them
for folder in self.excluded_folders:
local_folder = self.mdbx.to_local_path(folder)
delete_file_or_folder(local_folder)
# switch to next page
self.stackedWidget.slideInIdx(4)
# =============================================================================
# Helper functions
# =============================================================================
@QtCore.pyqtSlot(int)
def on_combobox(self, idx):
if idx == 2:
self.dropbox_folder_dialog.open()
@QtCore.pyqtSlot(str)
def on_new_dbx_folder(self, new_location):
self.comboBoxDropboxPath.setCurrentIndex(0)
if not new_location == '':
self.comboBoxDropboxPath.setItemText(0,
self.rel_path(new_location))
self.comboBoxDropboxPath.setItemIcon(
0, get_native_item_icon(new_location))
self.dropbox_location = new_location
@handle_disconnect
def populate_folders_list(self, overload=None):
self.async_loader = AsyncLoadFolders(self.mdbx, self)
self.dbx_root = DropboxPathModel(self.mdbx, self.async_loader, "/")
self.dbx_model = TreeModel(self.dbx_root)
self.dbx_model.dataChanged.connect(self.update_select_all_checkbox)
self.treeViewFolders.setModel(self.dbx_model)
self.dbx_model.loading_done.connect(
lambda: self.pushButtonFolderSelectionSelect.setEnabled(True))
self.dbx_model.loading_failed.connect(
lambda: self.pushButtonFolderSelectionSelect.setEnabled(False))
self.dbx_model.loading_done.connect(
lambda: self.selectAllCheckBox.setEnabled(True))
self.dbx_model.loading_failed.connect(
lambda: self.selectAllCheckBox.setEnabled(False))
@QtCore.pyqtSlot()
def update_select_all_checkbox(self):
check_states = []
for irow in range(self.dbx_model._root_item.child_count_loaded()):
index = self.dbx_model.index(irow, 0, QModelIndex())
check_states.append(self.dbx_model.data(index, Qt.CheckStateRole))
if all(cs == 2 for cs in check_states):
self.selectAllCheckBox.setChecked(True)
else:
self.selectAllCheckBox.setChecked(False)
@QtCore.pyqtSlot(bool)
def on_select_all_clicked(self, checked):
checked_state = 2 if checked else 0
for irow in range(self.dbx_model._root_item.child_count_loaded()):
index = self.dbx_model.index(irow, 0, QModelIndex())
self.dbx_model.setCheckState(index, checked_state)
def apply_selection(self, index=QModelIndex()):
if index.isValid():
item = index.internalPointer()
item_dbx_path = item._root.lower()
# We have started with all folders included. Therefore just append excluded
# folders here.
if item.checkState == 0:
self.excluded_folders.append(item_dbx_path)
else:
item = self.dbx_model._root_item
for row in range(item.child_count_loaded()):
index_child = self.dbx_model.index(row, 0, index)
self.apply_selection(index=index_child)
@staticmethod
def rel_path(path):
"""
Returns the path relative to the users directory, or the absolute
path if not in a user directory.
"""
usr = osp.abspath(osp.join(get_home_dir(), osp.pardir))
if osp.commonprefix([path, usr]) == usr:
return osp.relpath(path, usr)
else:
return path
def changeEvent(self, QEvent):
if QEvent.type() == QtCore.QEvent.PaletteChange:
self.update_dark_mode()
def update_dark_mode(self):
if self.dbx_model:
self.dbx_model.reloadData([Qt.DecorationRole
]) # reload folder icons
# static method to create the dialog and return Maestral instance on success
@staticmethod
def configureMaestral(config_name='maestral',
pending_link=True,
parent=None):
fsd = SetupDialog(config_name, pending_link, parent)
fsd.exec_()
return fsd.accepted