Source code for tcms.core.views

# -*- coding: utf-8 -*-
import os
import subprocess  # nosec:B404:import_subprocess
import time

from django import http
from django.conf import settings
from django.contrib import messages
from django.contrib.auth.decorators import login_required
from django.contrib.sites.models import Site
from django.db import DEFAULT_DB_ALIAS, connections
from django.db.migrations.executor import MigrationExecutor
from django.db.models import Count, Q
from django.http import HttpResponseRedirect, StreamingHttpResponse
from django.template import loader
from django.urls import reverse
from django.utils import timezone, translation
from django.utils.decorators import method_decorator
from django.utils.safestring import mark_safe
from django.utils.translation import gettext_lazy as _
from django.utils.translation import trans_real
from django.views import i18n
from django.views.decorators.csrf import requires_csrf_token
from django.views.generic.base import TemplateView, View

from tcms.testplans.models import TestPlan
from tcms.testruns.models import TestRun

[docs] @method_decorator(login_required, name="dispatch") class DashboardView(TemplateView): # pylint: disable=missing-permission-required template_name = "dashboard.html"
[docs] def get_context_data(self, **kwargs): # Check if domain is configured site = Site.objects.get(pk=settings.SITE_ID) doc_url = ( "" "#configuration-of-kiwi-tcms-domain" ) if site.domain == "": messages.add_message( self.request, messages.ERROR, mark_safe( # nosec:B308:B703 _( "Base URL is not configured! " 'See <a href="%(doc_url)s">documentation</a> and ' '<a href="%(admin_url)s">change it</a>' ) % { "doc_url": doc_url, "admin_url": reverse("admin:sites_site_change", args=[]), } ), ) # Check for missing migrations doc_url = ( "" "installing_docker.html#initial-configuration-of-running-container" ) executor = MigrationExecutor(connections[DEFAULT_DB_ALIAS]) plan = executor.migration_plan(executor.loader.graph.leaf_nodes()) if plan: messages.add_message( self.request, messages.ERROR, mark_safe( # nosec:B308:B703 _( "You have %(unapplied_migration_count)s unapplied migration(s). " 'See <a href="%(doc_url)s">documentation</a>' ) % { "unapplied_migration_count": len(plan), "doc_url": doc_url, } ), ) # Check for SSL usage doc_url = ( "" "installing_docker.html#ssl-configuration" ) if not self.request.is_secure(): messages.add_message( self.request, messages.WARNING, mark_safe( # nosec:B308:B703 _( "You are not using a secure connection. " 'See <a href="%(doc_url)s">documentation</a> and enable SSL.' ) % { "doc_url": doc_url, } ), ) # List all recent TestPlans and TestRuns test_plans = ( TestPlan.objects.filter(author=self.request.user) .order_by("-pk") .select_related("product", "type") .annotate(num_runs=Count("run", distinct=True)) ) test_plans_disable_count = test_plans.filter(is_active=False).count() # pylint: disable=unsupported-binary-operation test_runs = ( TestRun.objects.filter( Q(manager=self.request.user) | Q(default_tester=self.request.user) | Q(executions__assignee=self.request.user), stop_date__isnull=True, ) .order_by("-pk") .distinct() ) return { "test_plans_count": test_plans.count(), "test_plans_disable_count": test_plans_disable_count, "last_15_test_plans": test_plans.filter(is_active=True)[:15], "last_15_test_runs": test_runs[:15], "test_runs_count": test_runs.count(), }
[docs] @requires_csrf_token def server_error(request): # pylint: disable=missing-permission-required """ Render the error page with request object which supports static URLs so we can load a nice picture. """ template = loader.get_template("500.html") return http.HttpResponseServerError(template.render({}, request))
[docs] class IterOpen(subprocess.Popen): # pylint: disable=missing-permission-required """ Popen which allows us to iterate over the output so we can stream it back to the browser with some extra eye candy! """ still_waiting = True has_completed = False @property def timestamp(self): return"T", " ") + " init-db: " def __iter__(self): os.set_blocking(self.stdout.fileno(), False) return self def __next__(self): line = self.stdout.readline() if not line: time.sleep(3) if self.still_waiting: return self.timestamp + "waiting for migrations to start\n" if "init-db is done" in line: self.has_completed = True return self.timestamp + "Complete!\n" if self.has_completed: raise StopIteration self.still_waiting = False return self.timestamp + line
[docs] class InitDBView(TemplateView): # pylint: disable=missing-permission-required template_name = "initdb.html"
[docs] def post(self, request): # pylint: disable=no-self-use # Default production installation manage_path = "/Kiwi/" if not os.path.exists(manage_path): # Development installation manage_path = os.path.join(settings.TCMS_ROOT_PATH, "..", "") if "init_db" in request.POST: # Perform migrations proc = IterOpen( [manage_path, "init_db"], stdout=subprocess.PIPE, stderr=subprocess.STDOUT, bufsize=1, # line buffered universal_newlines=True, ) response = StreamingHttpResponse( proc, content_type="text/plain; charset=utf-8" ) response["Cache-Control"] = "no-cache" return response return HttpResponseRedirect(reverse("init-db"))
[docs] class TranslationMode(View): # pylint: disable=missing-permission-required """ Turns on and off translation mode by switching language to Esperanto! """
[docs] @staticmethod def get_browser_language(request): """ Returns *ONLY* the language that is sent by the browser via the Accept-Language headers. Defaults to ``settings.LANGUAGE_CODE`` if that doesn't work! This is the language we switch back to when translation mode is turned off. Copied from the bottom half of ``django.utils.translation.trans_real.get_language_from_request()`` .. note:: Using ``get_language_from_request()`` doesn't work for us because it first inspects session and cookies and we've already set Esperanto in both the session and the cookie! """ accept = request.META.get("HTTP_ACCEPT_LANGUAGE", "") for accept_lang, _unused in trans_real.parse_accept_lang_header(accept): if accept_lang == "*": break if not continue try: return translation.get_supported_language_variant(accept_lang) except LookupError: continue try: return translation.get_supported_language_variant(settings.LANGUAGE_CODE) except LookupError: return settings.LANGUAGE_CODE
[docs] def get(self, request): """ In the HTML template we'd like to work with simple links however the view which actually switches the language needs to be called via POST so we simulate that here! If the URL doesn't explicitly specify language then we turn-off translation mode by switching back to browser preferred language. """ browser_lang = self.get_browser_language(request) _request_lang = request.GET.get(i18n.LANGUAGE_QUERY_PARAMETER, browser_lang) post_body = f"{i18n.LANGUAGE_QUERY_PARAMETER}={_request_lang}" request.META["REQUEST_METHOD"] = "POST" request.META["CONTENT_LENGTH"] = len(post_body) request.META["CONTENT_TYPE"] = "application/x-www-form-urlencoded" post_request = request.__class__(request.META) # pylint: disable=protected-access post_request._post = http.QueryDict(post_body, encoding=post_request._encoding) return i18n.set_language(post_request)