"""Define :class:`WalkFSView` allowing users to walk through the file system."""
import logging
import os
from os import path, scandir
import fnmatch
import re
import string
from django.views import View
from django.shortcuts import render
from autowisp.exceptions import ViewError
[docs]
class WalkFSView(View):
"""Base class allowing user to walk through the file system."""
_logger = logging.getLogger(__name__)
_root_dir = (
("Computer", "Computer") if os.name == "nt" else ("/", "Computer")
)
if "AUTOWISP_ROOT" in os.environ:
_root_dir = (
path.abspath(os.environ["AUTOWISP_ROOT"]),
os.environ["AUTOWISP_ROOT"],
)
template = "core/walk_fs.html"
url_name = None
cancel_url_name = None
[docs]
def _add_fs_context(
self, search_dir, filename_check, dirname_check, result
):
"""Add filesystem entries and breadcrumb navigation to result context.
Populates result with:
- ``file_list``: sorted list of filenames in search_dir matching
filename_check.
- ``dir_list``: sorted list of subdirectory names in search_dir
matching dirname_check. On Windows with search_dir == "Computer",
lists available drive letters instead.
- ``parent_dir_list``: list of ``(path, display_name)`` tuples
representing the breadcrumb trail from ``_root_dir`` down to
search_dir, in top-to-bottom order.
"""
result["file_list"] = []
result["dir_list"] = []
if os.name == "nt" and search_dir == "Computer":
for d in string.ascii_uppercase:
drive_root = f"{d}:\\"
if os.path.exists(drive_root):
result["dir_list"].append(drive_root)
else:
with scandir(search_dir) as dir_entries:
for entry in dir_entries:
if entry.is_dir():
if dirname_check.match(entry.name):
result["dir_list"].append(entry.name)
elif filename_check.match(entry.name):
result["file_list"].append(entry.name)
result["file_list"].sort()
result["dir_list"].sort()
parent_dir_list = [self._root_dir]
if not search_dir == "Computer":
head = path.abspath(search_dir)
while head != self._root_dir[0]:
drive, tail = path.splitdrive(head)
if drive and tail in ["", "\\"]:
parent_dir_list.insert(
1, (f"{drive}\\", f"{drive[0]} Drive")
)
break
parent_dir_list.insert(1, (head, path.basename(head)))
head = path.dirname(head)
result["parent_dir_list"] = parent_dir_list
[docs]
def _get_context(self, config, search_dir):
"""Return the context required by the file system walk template."""
result = {
"url_name": self.url_name,
"cancel_url_name": self.cancel_url_name,
}
filename_check = config.get("filename_filter", "[^.]")
result["filename_filter"] = filename_check
result["filename_filter_type"] = config.get(
"filefilter_type", "Regular Expression"
)
if result["filename_filter_type"] != "Regular Expression":
filename_check = fnmatch.translate(filename_check)
try:
filename_check = re.compile(filename_check)
except re.error:
filename_check = re.compile("")
dirname_check = config.get("dirname_filter", "[^.]")
result["dirname_filter"] = dirname_check
result["dirname_filter_type"] = config.get(
"dirfilter_type", "Regular Expression"
)
if result["dirname_filter_type"] != "Regular Expression":
dirname_check = fnmatch.translate(dirname_check)
try:
dirname_check = re.compile(dirname_check)
except re.error:
print(f"Invalid REX: {dirname_check!r}")
dirname_check = re.compile("")
if search_dir is None:
search_dir = config.get(
"currentdir",
(
path.expanduser("~")
if self._root_dir[1] == "Computer"
else self._root_dir[0]
),
)
if "enter_dir" in config:
search_dir = path.join(search_dir, config["enter_dir"])
if search_dir != "Computer" and self._root_dir[1] != "Computer":
abs_search = path.abspath(search_dir)
if not (
abs_search == self._root_dir[0]
or abs_search.startswith(self._root_dir[0] + os.sep)
):
raise ViewError(
f"{search_dir!r} is outside root {self._root_dir[0]!r}"
)
result["currentdir"] = (
path.abspath(search_dir) if search_dir != "Computer" else "Computer"
)
self._add_fs_context(search_dir, filename_check, dirname_check, result)
self._logger.debug("Context: %s", repr(result))
return result
[docs]
def get(self, request, dirname=None):
"""Display the interface for selecting files."""
return render(
request,
self.template,
self._get_context(request.GET, dirname),
)