1 files changed, 233 insertions, 0 deletions
diff --git a/raphodo/filebrowse.py b/raphodo/filebrowse.py
new file mode 100644
index 0000000..4508d7c
--- /dev/null
+++ b/raphodo/filebrowse.py
@@ -0,0 +1,233 @@
+# Copyright (C) 2016 Damon Lynch <damonlynch@gmail.com>
+
+# This file is part of Rapid Photo Downloader.
+#
+# Rapid Photo Downloader is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Rapid Photo Downloader is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Rapid Photo Downloader.  If not,
+# see <http://www.gnu.org/licenses/>.
+
+"""
+Display file system folders and allow the user to select one
+"""
+
+__author__ = 'Damon Lynch'
+__copyright__ = "Copyright 2016, Damon Lynch"
+
+import os
+import pathlib
+from typing import List, Set
+import logging
+import shlex
+import subprocess
+
+from gettext import gettext as _
+
+from PyQt5.QtCore import (QDir, Qt, QModelIndex, QItemSelectionModel, QSortFilterProxyModel, QPoint)
+from PyQt5.QtWidgets import (QTreeView, QAbstractItemView, QFileSystemModel, QSizePolicy,
+                             QStyledItemDelegate, QStyleOptionViewItem, QMenu)
+from PyQt5.QtGui import QIcon
+from PyQt5.QtGui import (QPainter, QFont)
+
+import raphodo.qrc_resources as qrc_resources
+from raphodo.constants import (minPanelWidth, minFileSystemViewHeight, Roles)
+
+
+class FileSystemModel(QFileSystemModel):
+    """
+    Use Qt's built-in functionality to model the file system.
+
+    Augment it by displaying provisional subfolders in the photo and video
+    download destinations.
+    """
+
+    def __init__(self, parent) -> None:
+        super().__init__(parent)
+        # More filtering done in the FileSystemFilter
+        self.setFilter(QDir.AllDirs | QDir.NoDotAndDotDot )
+        self.folder_icon = QIcon(':/icons/folder.svg')
+        self.download_folder_icon = QIcon(':/icons/folder-filled.svg')
+        self.setRootPath('/')
+
+        # The next two values are set via FolderPreviewManager.update()
+        # They concern provisional folders that will be used if the
+        # download proceeds, and all files are downloaded.
+
+        # First value: subfolders we've created to demonstrate to the user
+        # where their files will be downloaded to
+        self.preview_subfolders = set()  # type: Set[str]
+        # Second value: subfolders that already existed, but that we still
+        # want to indicate to the user where their files will be downloaded to
+        self.download_subfolders = set()  # type: Set[str]
+
+        # Folders that were actually used to download files into
+        self.subfolders_downloaded_into = set()  # type: Set[str]
+
+    def data(self, index: QModelIndex, role=Qt.DisplayRole):
+        if role == Qt.DecorationRole:
+            path = index.data(QFileSystemModel.FilePathRole)  # type: str
+            if path in self.download_subfolders or path in self.subfolders_downloaded_into:
+                return self.download_folder_icon
+            else:
+                return self.folder_icon
+        if role == Roles.folder_preview:
+            path = index.data(QFileSystemModel.FilePathRole)
+            return path in self.preview_subfolders and path not in self.subfolders_downloaded_into
+
+        return super().data(index, role)
+
+    def add_subfolder_downloaded_into(self, path: str, download_folder: str) -> bool:
+        """
+        Add a path to the set of subfolders that indicate where files where
+        downloaded.
+        :param path: the full path to the folder
+        :return: True if the path was not added before, else False
+        """
+
+        if path not in self.subfolders_downloaded_into:
+            self.subfolders_downloaded_into.add(path)
+
+            pl_subfolders = pathlib.Path(path)
+            pl_download_folder = pathlib.Path(download_folder)
+
+            for subfolder in pl_subfolders.parents:
+                if not pl_download_folder in subfolder.parents:
+                    break
+                self.subfolders_downloaded_into.add(str(subfolder))
+            return True
+        return False
+
+
+class FileSystemView(QTreeView):
+    def __init__(self, model: FileSystemModel, rapidApp, parent=None) -> None:
+        super().__init__(parent)
+        self.rapidApp = rapidApp
+        self.fileSystemModel = model
+        self.setHeaderHidden(True)
+        self.setSelectionBehavior(QAbstractItemView.SelectRows)
+        self.setSelectionMode(QAbstractItemView.SingleSelection)
+        self.setSizePolicy(QSizePolicy.MinimumExpanding, QSizePolicy.MinimumExpanding)
+        self.setMinimumWidth(minPanelWidth())
+        self.setMinimumHeight(minFileSystemViewHeight())
+        self.setContextMenuPolicy(Qt.CustomContextMenu)
+        self.customContextMenuRequested.connect(self.onCustomContextMenu)
+        self.contextMenu = QMenu()
+        self.openInFileBrowserAct = self.contextMenu.addAction(_('Open in File Browser...'))
+        self.openInFileBrowserAct.triggered.connect(self.doOpenInFileBrowserAct)
+        self.openInFileBrowserAct.setEnabled(self.rapidApp.file_manager is not None)
+        self.clickedIndex = None   # type: QModelIndex
+
+    def hideColumns(self) -> None:
+        """
+        Call only after the model has been initialized
+        """
+        for i in (1,2,3):
+            self.hideColumn(i)
+
+    def goToPath(self, path: str, scrollTo: bool=True) -> None:
+        """
+        Select the path, expand its subfolders, and scroll to it
+        :param path:
+        :return:
+        """
+        if not path:
+            return
+        index = self.model().mapFromSource(self.fileSystemModel.index(path))
+        self.setExpanded(index, True)
+        selection = self.selectionModel()
+        selection.select(index, QItemSelectionModel.ClearAndSelect|QItemSelectionModel.Rows)
+        if scrollTo:
+            self.scrollTo(index, QAbstractItemView.PositionAtTop)
+
+    def expandPreviewFolders(self, path: str) -> bool:
+        """
+        Expand any unexpanded preview folders
+
+        :param path: path under which to expand folders
+        :return: True if path was expanded, else False
+        """
+
+        self.goToPath(path, scrollTo=True)
+        if not path:
+            return False
+
+        expanded = False
+        for path in self.fileSystemModel.download_subfolders:
+            # print('path', path)
+            index = self.model().mapFromSource(self.fileSystemModel.index(path))
+            if not self.isExpanded(index):
+                self.expand(index)
+                expanded = True
+        return expanded
+
+    def expandPath(self, path) -> None:
+        index = self.model().mapFromSource(self.fileSystemModel.index(path))
+        if not self.isExpanded(index):
+            self.expand(index)
+
+    def onCustomContextMenu(self, point: QPoint) -> None:
+        index = self.indexAt(point)
+        if index.isValid():
+            self.clickedIndex = index
+            self.contextMenu.exec(self.mapToGlobal(point))
+
+    def doOpenInFileBrowserAct(self):
+        index = self.clickedIndex
+        if index:
+            uri = self.fileSystemModel.filePath(index.model().mapToSource(index))
+            cmd = '{} "{}"'.format(self.rapidApp.file_manager, uri)
+            logging.debug("Launching: %s", cmd)
+            args = shlex.split(cmd)
+            subprocess.Popen(args)
+
+
+class FileSystemFilter(QSortFilterProxyModel):
+    """
+    Filter out the display of RPD's cache and temporary directories
+    """
+
+    def __init__(self, parent=None):
+        super().__init__(parent)
+        self.filtered_dir_names = set()
+
+    def setTempDirs(self, dirs: List[str]) -> None:
+        filters = [os.path.basename(path) for path in dirs]
+        self.filtered_dir_names = self.filtered_dir_names | set(filters)
+        self.invalidateFilter()
+
+    def filterAcceptsRow(self, sourceRow: int, sourceParent: QModelIndex=None) -> bool:
+        if not self.filtered_dir_names:
+            return True
+
+        index = self.sourceModel().index(sourceRow, 0, sourceParent)  # type: QModelIndex
+        file_name = index.data(QFileSystemModel.FileNameRole)
+        return file_name not in self.filtered_dir_names
+
+
+class FileSystemDelegate(QStyledItemDelegate):
+    """
+    Italicize provisional download folders that were not already created
+    """
+    def __init__(self, parent=None):
+        super().__init__(parent)
+
+    def paint(self, painter: QPainter, option: QStyleOptionViewItem, index: QModelIndex) -> None:
+        if index is None:
+            return
+
+        folder_preview = index.data(Roles.folder_preview)
+        if folder_preview:
+            font = QFont()
+            font.setItalic(True)
+            option.font = font
+
+        super().paint(painter, option, index)