Source code for uid.views

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Created on Tue Feb  6 15:04:07 2018

@author: Paolo Cozzi <paolo.cozzi@ptp.it>
"""

import os
import logging
import mimetypes

from django.utils.encoding import smart_str
from django.contrib.auth.decorators import login_required
from django.contrib.auth.mixins import LoginRequiredMixin
from django.shortcuts import get_object_or_404
from django.views.generic import TemplateView, UpdateView
from django.conf import settings
from django.urls import reverse_lazy
from django.http import HttpResponse

from common.storage import ProtectedFileSystemStorage
from common.constants import COMPLETED, BIOSAMPLE_URL
from common.views import FormInvalidMixin

from .models import Submission, Organization, uid_report
from .forms import OrganizationForm

# Get an instance of a logger
logger = logging.getLogger(__name__)


class IndexView(TemplateView):
    # Just set this Class Object Attribute to the template page.
    # template_name = 'app_name/site.html'
    template_name = 'uid/index.html'


class AboutView(TemplateView):
    # Just set this Class Object Attribute to the template page.
    # template_name = 'app_name/site.html'
    template_name = 'uid/about.html'


class PrivacyView(TemplateView):
    template_name = "uid/privacy_policy.html"


class TermsView(TemplateView):
    template_name = "uid/terms_and_conditions.html"


class AboutUploadingView(TemplateView):
    template_name = "uid/uploading_data.html"


class AboutSubmissionView(TemplateView):
    template_name = "uid/about_submission.html"


class DashBoardView(LoginRequiredMixin, TemplateView):
    template_name = "uid/dashboard.html"

    def get_context_data(self, **kwargs):
        # Call the base implementation first to get a context
        context = super().get_context_data(**kwargs)

        # add the base biosample urls to context
        context["biosample_url"] = BIOSAMPLE_URL + "?filter=attr:project:IMAGE"

        return context


class SummaryView(LoginRequiredMixin, TemplateView):
    template_name = "uid/summary.html"

    def get_context_data(self, **kwargs):
        # Call the base implementation first to get a context
        context = super(SummaryView, self).get_context_data(**kwargs)
        # add content to context

        # Add info for datasource
        # count object for a certain user
        context['datasource_count'] = Submission.objects.filter(
            owner=self.request.user).count()

        # count loaded objects into biosample
        context['datasource_completed'] = Submission.objects.filter(
            status=COMPLETED, owner=self.request.user).count()

        # call report from UID model
        context["uid_report"] = uid_report(self.request.user)

        return context


# https://gist.github.com/cobusc/ea1d01611ef05dacb0f33307e292abf4
@login_required
def protected_view(request, path):
    """
    Redirect the request to the path used by nginx for protected media.
    """

    logger.debug("Received path %s for download" % (path))

    # test for submission ownership
    dirname = os.path.dirname(path)

    if dirname == 'data_source':
        # I got a submission. Get a submission belonging to owner or 404
        submission = get_object_or_404(
            Submission,
            owner=request.user,
            uploaded_file=path)

        logger.debug("Got submission %s" % (submission))

    # derive downloadable path. Applies to any protected file
    full_path = os.path.join(
        settings.PROTECTED_MEDIA_LOCATION_PREFIX, path
    )

    file_name = os.path.basename(path)

    # try to determine file type
    file_type, encoding = mimetypes.guess_type(path)

    logger.debug("Detected content type: %s" % (file_type))

    # get file size using protected storage
    storage = ProtectedFileSystemStorage()
    file_size = storage.size(path)

    # try to set file type to response
    # https://djangosnippets.org/snippets/1710/
    if file_type is None:
        file_type = 'application/octet-stream'

    # force django to attach file in response
    response = HttpResponse(content_type=file_type)

    if encoding is not None:
        response['Content-Encoding'] = encoding

    # https://stackoverflow.com/a/1158750/4385116
    response["X-Accel-Redirect"] = smart_str(full_path)
    response['Content-Disposition'] = 'attachment; filename="{}"'.format(
        file_name)
    response['Content-Length'] = file_size

    return response


class UpdateOrganizationView(FormInvalidMixin, LoginRequiredMixin, UpdateView):
    form_class = OrganizationForm
    model = Organization
    success_url = reverse_lazy('uid:dashboard')
    template_name = 'uid/organization_form.html'

    def get_object(self):
        """Get the organization which this user belongs to"""

        return self.request.user.person.affiliation