mirror of
https://github.com/freedomofpress/dangerzone.git
synced 2025-04-29 02:12:36 +02:00
5a6c72f09e
These will be needed in for the GUI's settings. This also adds test
cases for these documents. The methods are the following:
- set_output_dir()
For changing the output directory of the safe file
- suffix setter and getter - for changing the suffix of the file
89 lines
2.7 KiB
Python
89 lines
2.7 KiB
Python
import functools
|
|
import logging
|
|
import sys
|
|
from typing import Any, Callable, Sequence, TypeVar, cast
|
|
|
|
import click
|
|
|
|
F = TypeVar("F", bound=Callable[..., Any])
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
class DocumentFilenameException(Exception):
|
|
"""Exception for document-related filename errors."""
|
|
|
|
|
|
class InputFileNotFoundException(DocumentFilenameException):
|
|
"""Exception for when an input file does not exist."""
|
|
|
|
def __init__(self) -> None:
|
|
super().__init__("Input file not found: make sure you typed it correctly.")
|
|
|
|
|
|
class InputFileNotReadableException(DocumentFilenameException):
|
|
"""Exception for when an input file exists but is not readable."""
|
|
|
|
def __init__(self) -> None:
|
|
super().__init__("You don't have permission to open the input file.")
|
|
|
|
|
|
class NonPDFOutputFileException(DocumentFilenameException):
|
|
"""Exception for when the output file is not a PDF."""
|
|
|
|
def __init__(self) -> None:
|
|
super().__init__("Safe PDF filename must end in '.pdf'")
|
|
|
|
|
|
class UnwriteableOutputDirException(DocumentFilenameException):
|
|
"""Exception for when the output file is not writeable."""
|
|
|
|
def __init__(self) -> None:
|
|
super().__init__("Safe PDF filename is not writable")
|
|
|
|
|
|
class NotSetInputFilenameException(DocumentFilenameException):
|
|
"""Exception for when the output filename is set before having an
|
|
associated input file."""
|
|
|
|
def __init__(self) -> None:
|
|
super().__init__("Input filename has not been set yet.")
|
|
|
|
|
|
class NotSetOutputFilenameException(DocumentFilenameException):
|
|
"""Exception for when the output filename is read before it has been set."""
|
|
|
|
def __init__(self) -> None:
|
|
super().__init__("Output filename has not been set yet.")
|
|
|
|
|
|
class NonExistantOutputDirException(DocumentFilenameException):
|
|
"""Exception for when the output dir does not exist."""
|
|
|
|
def __init__(self) -> None:
|
|
super().__init__("Output directory does not exist")
|
|
|
|
|
|
class OutputDirIsNotDirException(DocumentFilenameException):
|
|
"""Exception for when the specified output dir is not actually a dir."""
|
|
|
|
def __init__(self) -> None:
|
|
super().__init__("Specified output directory is actually not a directory")
|
|
|
|
|
|
def handle_document_errors(func: F) -> F:
|
|
"""Log document-related errors and exit gracefully."""
|
|
|
|
@functools.wraps(func)
|
|
def wrapper(*args, **kwargs): # type: ignore
|
|
try:
|
|
return func(*args, **kwargs)
|
|
except DocumentFilenameException as e:
|
|
if getattr(sys, "dangerzone_dev", False):
|
|
# Show the full traceback only on dev environments.
|
|
msg = "An exception occured while validating a document filename"
|
|
log.exception(msg)
|
|
click.echo(str(e))
|
|
exit(1)
|
|
|
|
return cast(F, wrapper)
|