management.views.logging

Logging setting specific views.

Attributes

_LOG_FILENAME_RE
_CONTROL_CHAR_THRESHOLD

Classes

IndexView	Index view.
LoggingFilesTableView	View to display all log files in the log directory in a table.
LoggingFilesDetailsView	Log file detail view, allows to view the content of a single log file without download.
LoggingFilesDownloadView	View to download a single log file.
LoggingFilesDownloadMultipleView	View to download multiple log files as a single archive.

Functions

_secure_log_filename(filename)	Secure a log filename by removing any potentially dangerous characters.
_validate_log_filename(filename)	Validate a log filename and return the resolved path if valid.
language(request)	Handle language Configuration.

Module Contents

management.views.logging._LOG_FILENAME_RE

management.views.logging._CONTROL_CHAR_THRESHOLD = 32

management.views.logging._secure_log_filename(filename)

Secure a log filename by removing any potentially dangerous characters.

Parameters:

filename (str) – The filename to secure

Returns:

The secured filename with dangerous characters removed

Raises:

Http404 – If the filename is invalid

Return type:

str

management.views.logging._validate_log_filename(filename)

Validate a log filename and return the resolved path if valid.

Parameters:

filename (str) – The filename to validate

Returns:

The resolved Path object if valid

Raises:

Http404 – If the filename is invalid or not found

Return type:

pathlib.Path

class management.views.logging.IndexView(**kwargs)

Bases: django.views.generic.base.RedirectView

Index view.

permanent = True

pattern_name = 'management:language'

management.views.logging.language(request)

Handle language Configuration.

Returns: HTTPResponse

Parameters:

request (django.http.HttpRequest)

Return type:

django.http.HttpResponse

class management.views.logging.LoggingFilesTableView(**kwargs)

Bases: trustpoint.page_context.PageContextMixin, trustpoint.logger.LoggerMixin, trustpoint.views.base.SortableTableFromListMixin, django.views.generic.list.ListView

View to display all log files in the log directory in a table.

http_method_names = ('get',)

template_name = 'management/logging/logging_files.html'

context_object_name = 'log_files'

default_sort_param = 'updated_at'

paginate_by = None

page_category = 'management'

page_name = 'logging'

static _get_first_and_last_entry_date(log_file_path)

Parameters:

log_file_path (pathlib.Path)

Return type:

tuple[None | datetime.datetime, None | datetime.datetime]

classmethod _get_log_file_data(log_filename)

Parameters:

log_filename (str)

Return type:

dict[str, str]

get_queryset()

Gets a queryset of all valid Trustpoint log files in the log directory.

Return type:

list[dict[str, str]]

class management.views.logging.LoggingFilesDetailsView(**kwargs)

Bases: trustpoint.page_context.PageContextMixin, trustpoint.logger.LoggerMixin, django.views.generic.TemplateView

Log file detail view, allows to view the content of a single log file without download.

http_method_names = ('get',)

template_name = 'management/logging/logging_files_details.html'

log_directory

page_category = 'settings'

page_name = 'logging'

get_context_data(**kwargs)

Get the context data for the view.

Parameters:

kwargs (Any)

Return type:

dict[str, Any]

class management.views.logging.LoggingFilesDownloadView(**kwargs)

Bases: trustpoint.page_context.PageContextMixin, trustpoint.logger.LoggerMixin, django.views.generic.TemplateView

View to download a single log file.

http_method_names = ('get',)

page_category = 'settings'

page_name = 'logging'

get(*_args, **kwargs)

The HTTP GET method for the view.

Parameters:

• _args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponse

class management.views.logging.LoggingFilesDownloadMultipleView(**kwargs)

Bases: trustpoint.page_context.PageContextMixin, trustpoint.logger.LoggerMixin, django.views.generic.View

View to download multiple log files as a single archive.

http_method_names = ('get',)

page_category = 'settings'

page_name = 'logging'

classmethod get(*_args, **kwargs)

The HTTP GET method for the view.

Parameters:

• _args (Any)

• kwargs (Any)

Return type:

django.http.HttpResponse