Linkcheck

This package contains views for the broken link checker

Link Replace View

class integreat_cms.cms.views.linkcheck.link_replace_view.LinkReplaceView(**kwargs)

Bases: TemplateView

View for link replace form

__init__(**kwargs)

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

content_type = None

dispatch(request, *args, **kwargs)

extra_context = {'current_menu_item': 'linkcheck'}

get(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse

Render link replace form

Parameters:

• request (HttpRequest) – Object representing the user call

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

The rendered template response

Return type:

HttpResponse

get_context_data(**kwargs)

get_template_names()

Return a list of template names to be used for the request. Must return a list. May not be called if render_to_response() is overridden.

http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']

http_method_not_allowed(request, *args, **kwargs)

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

post(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse

Applies link replace form

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Raises:

Http404 – HTTP status 404 if the edited URL does not exist

Returns:

Redirect to broken link list

Return type:

HttpResponse

render_to_response(context, **response_kwargs)

Return a response, using the response_class for this view, with a template rendered with the given context.

Pass response_kwargs to the constructor of the response class.

response_class

alias of TemplateResponse

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

template_engine = None

template_name = 'linkcheck/search_and_replace_link.html'

view_is_async = False

Linkcheck List View

class integreat_cms.cms.views.linkcheck.linkcheck_list_view.LinkcheckListView(**kwargs)

Bases: ListView

View for retrieving a list of urls grouped by their state

__init__(**kwargs)

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

allow_empty = True

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

content_type = None

context_object_name: str = 'filtered_urls'

Designates the name of the variable to use in the context (see MultipleObjectMixin)

dispatch(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse

Dispatch the view to either get() or post()

Parameters:

• request (HttpRequest) –

• args (Any) –

• kwargs (Any) –

Return type:

HttpResponse

extra_context: dict[str, str | int] = {'LINKCHECK_EMAIL_ENABLED': True, 'LINKCHECK_PHONE_ENABLED': True, 'current_menu_item': 'linkcheck'}

The context dict passed to the template (see ContextMixin)

form: EditUrlForm | None = None

The link edit form

get(request: HttpRequest, *args: Any, **kwargs: Any) → TemplateResponse

Return the get view and fall back to the last page if the requested page does not exist

Parameters:

• request (HttpRequest) – Object representing the user call

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Raises:

Http404 – When the view returns a 404 and already requests the last page

Returns:

The rendered linkcheck template or a redirect to the last page

Return type:

TemplateResponse

get_allow_empty()

Return True if the view should display empty lists and False if a 404 should be raised instead.

get_context_data(**kwargs: Any) → dict[str, Any]

Extend context by edit url form

Parameters:

**kwargs (Any) – The supplied keyword arguments

Returns:

The context dictionary

Return type:

dict[str, Any]

get_context_object_name(object_list)

Get the name of the item to be used in the context.

get_ordering()

Return the field or fields to use for ordering the queryset.

get_paginate_by(queryset: list[Url]) → int

Get the number of items to paginate by, or None for no pagination.

Parameters:

queryset (list[Url]) – The QuerySet of the filtered urls

Returns:

The pagination number

Return type:

int

get_paginate_orphans()

Return the maximum number of orphans extend the last page by when paginating.

get_pagination_params() → str

Get the urlencoded pagination GET parameters

Returns:

The URL params

Return type:

str

get_paginator(queryset, per_page, orphans=0, allow_empty_first_page=True, **kwargs)

Return an instance of the paginator for this view.

get_queryset() → list[Url]

Selects all urls for the current region Finally annotates queryset by the content_type title

Returns:

The QuerySet of the filtered urls

Return type:

list[Url]

get_template_names()

Return a list of template names to be used for the request. Must return a list. May not be called if render_to_response is overridden.

http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']

http_method_not_allowed(request, *args, **kwargs)

instance: Url | None = None

The currently edited instance

model = None

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

ordering = None

page_kwarg = 'page'

paginate_by = None

paginate_orphans = 0

paginate_queryset(queryset, page_size)

Paginate the queryset, if needed.

paginator_class

alias of Paginator

post(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse

Applies selected action for selected urls

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Raises:

Http404 – HTTP status 404 if the edited URL does not exist

Returns:

Redirect to current linkcheck tab

Return type:

HttpResponse

queryset = None

render_to_response(context, **response_kwargs)

Return a response, using the response_class for this view, with a template rendered with the given context.

Pass response_kwargs to the constructor of the response class.

static replace_link(old_url: str, new_url: str, link: str) → str

Replace the URL of a link

Parameters:

• old_url (str) – The old URL to be replaced

• new_url (str) – The new URL

• link (str) – The input link

Returns:

The replaced link

Return type:

str

response_class

alias of TemplateResponse

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

template_engine = None

template_name: str = 'linkcheck/links_by_filter.html'

The template to render (see TemplateResponseMixin)

template_name_suffix = '_list'

view_is_async = False

Linkcheck Redirect View

class integreat_cms.cms.views.linkcheck.linkcheck_redirect_view.LinkcheckRedirectView(**kwargs)

Bases: RedirectView

View for redirecting to main page of the broken link checker

__init__(**kwargs)

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

delete(request, *args, **kwargs)

dispatch(request, *args, **kwargs)

get(request, *args, **kwargs)

get_redirect_url(*args: Any, **kwargs: Any) → str

Retrieve url for redirection

Parameters:

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

url to redirect to

Return type:

str

head(request, *args, **kwargs)

http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']

http_method_not_allowed(request, *args, **kwargs)

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

patch(request, *args, **kwargs)

pattern_name = None

permanent = False

post(request, *args, **kwargs)

put(request, *args, **kwargs)

query_string = False

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

url = None

view_is_async = False

Linkcheck Stats View

class integreat_cms.cms.views.linkcheck.linkcheck_stats_view.LinkcheckStatsView(**kwargs)

Bases: View

Return the linkcheck counter stats

__init__(**kwargs)

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

dispatch(request, *args, **kwargs)

get(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse

Retrieve the stats about valid/invalid/unchecked/ignored links

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

The rendered template response

Return type:

HttpResponse

http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']

http_method_not_allowed(request, *args, **kwargs)

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

view_is_async = False