"""
This file contains views that render a specific page for the gui.
"""
from django.shortcuts import redirect, render, reverse
from django.conf import settings
from django.contrib import messages
from django.views.generic import (View, ListView)
from handyhelpers.mixins.view_mixins import FilterByQueryParamsMixin
from braces.views import LoginRequiredMixin
from rest_framework.authtoken.models import Token
# import models
from userextensions.models import (UserRecent, UserFavorite, ServiceAccount)
# import forms
from userextensions.forms import (UserPreferenceForm)
[docs]class ListRecents(LoginRequiredMixin, FilterByQueryParamsMixin, ListView):
""" Displays a list of urls the user has recently visited, rendered in a paginated, searchable, sortable bootstrap
table. This view is filterable via query parameters. Includes links to delete individual entries.
"""
base_template = getattr(settings, 'BASE_TEMPLATE', 'handyhelpers/handyhelpers_base_bs5.htm')
template = 'handyhelpers/generic/bs5/generic_list.html'
def get(self, request, *args, **kwargs):
context = dict()
self.queryset = UserRecent.objects.filter(user=request.user).order_by('-updated_at')
context['base_template'] = self.base_template
context['queryset'] = self.filter_by_query_params()
context['title'] = 'Recents'
context['subtitle'] = request.user.username
context['table'] = 'userextensions/table/table_recents.htm'
return render(request, self.template, context=context)
[docs]class ListFavorites(LoginRequiredMixin, FilterByQueryParamsMixin, ListView):
""" Displays a list of urls user has set as favorites, rendered in a paginated, searchable, sortable bootstrap
table. This view is filterable via query parameters. Includes links to delete individual entries. """
base_template = getattr(settings, 'BASE_TEMPLATE', 'handyhelpers/handyhelpers_base_bs5.htm')
template = 'handyhelpers/generic/bs5/generic_list.html'
def get(self, request, *args, **kwargs):
context = dict()
self.queryset = UserFavorite.objects.filter(user=request.user).order_by('-updated_at')
context['base_template'] = self.base_template
context['queryset'] = self.filter_by_query_params()
context['title'] = 'Favorites'
context['subtitle'] = request.user.username
context['table'] = 'userextensions/table/table_favorites.htm'
context['modals'] = 'userextensions/form/edit_favorite.htm'
return render(request, self.template, context=context)
[docs]class DetailUser(LoginRequiredMixin, View):
""" Displays user details, including group configuration, API token, and configuration for theme, start page, and
recents count. Includes link to refresh API token and modal form to edit user preferences. """
base_template = getattr(settings, 'BASE_TEMPLATE', 'handyhelpers/handyhelpers_base_bs5.htm')
template = 'userextensions/detail/detail_user.html'
def get(self, request):
context = dict()
# include user preference form
form_data_user_preferences = dict()
form_data_user_preferences['form'] = UserPreferenceForm(request.POST or None, instance=request.user.preference)
form_data_user_preferences['action'] = 'Update'
form_data_user_preferences['action_url'] = reverse('userextensions:detail_user')
form_data_user_preferences['title'] = '<b>Update Preferences: </b><small> {} </small>'.format(request.user)
form_data_user_preferences['modal_name'] = 'update_user_preferences'
context['form_data_user_preferences'] = form_data_user_preferences
context['user'] = request.user
context['token'] = str(Token.objects.get_or_create(user=request.user)[0])
context['groups'] = request.user.groups.all().order_by('name')
context['base_template'] = self.base_template
return render(request, self.template, context=context)
def post(self, request):
redirect_url = request.META.get('HTTP_REFERER')
form = UserPreferenceForm(request.POST or None, instance=request.user.preference)
if form.is_valid():
form.save()
messages.add_message(request, messages.ERROR, 'Preferences updated!', extra_tags='alert-info', )
return redirect(redirect_url)
else:
for error in form.errors:
messages.add_message(request, messages.ERROR, 'Input error: {}'.format(error),
extra_tags='alert-danger', )
return self.get(request)
[docs]class ManageServiceAccounts(LoginRequiredMixin, View):
""" Displays service accounts this user can access (service accounts that are linked to groups this owner is a
member of). Provides mechanisms for users to create service accounts for applicable groups, refresh API tokens, and
enable/disable service accounts """
base_template = getattr(settings, 'BASE_TEMPLATE', 'handyhelpers/handyhelpers_base_bs5.htm')
template = 'userextensions/custom/manage_service_accounts.html'
def get(self, request):
context = dict()
# get all current service accounts
context['service_accounts'] = ServiceAccount.objects.filter(group__user=request.user).\
select_related('user', 'group', 'user__auth_token').order_by('group__name')
# get list of groups that do not have a service account
# If the SRV_ACCOUNT_GROUP_FILTER_LIST (list) settings variable is set, only include groups whose name matches a
# provided regex pattern, otherwise include all groups. Set the SRV_ACCOUNT_ENFORCE_MATCHING (bool) settings
# variable to False to allow all groups, but maintain naming of the service account based on regex patterns.
regex_list = getattr(settings, 'SRV_ACCOUNT_GROUP_FILTER_LIST', list())
if regex_list and getattr(settings, 'SRV_ACCOUNT_ENFORCE_MATCHING', True):
group_queryset = request.user.groups.none()
for regex in regex_list:
group_queryset = group_queryset | request.user.groups.filter(serviceaccount=None, name__regex=regex)
else:
group_queryset = request.user.groups.filter(serviceaccount=None)
context['groups'] = group_queryset.prefetch_related('user_set').order_by('name')
context['base_template'] = self.base_template
context['modals'] = 'userextensions/custom/create_custom_service_account.htm'
return render(request, self.template, context=context)