{% extends "conntrackt/base.html" %}

{# For html_link #}

{% load conntrackt_tags %}

{% block content %}

<div class="row">

  <h1 class="span12">{{project.name}}</h1>

</div>

<hr>

{% if project.description %}

<div class="row">

  <div class="span12">

    {{project.description}}

  </div>

</div>

<hr>

{% endif %}

<div class="row">

  <div class="span12">

    {% html_link "Edit" "project_update" project.id class="btn btn-primary" %}

    {% html_link "Remove" "project_delete" project.id class="btn btn-primary" %}

    {% with project_id=project.id|slugify %}

    {% html_link "Add entity" "entity_create" class="btn btn-primary" get="project="|add:project_id|add:"&next="|add:request.path %}

    {% html_link "Add communication" "communication_create" class="btn btn-primary" get="project="|add:project_id|add:"&next="|add:request.path %}

    {% endwith %}

    {% html_link "Get Iptables" 'project_iptables' project.id class="btn btn-primary" %}

  </div>

</div>

<hr>

{% if location_entities %}

<div class="row">

  {% for location, entities in location_entities %}

  <div class="span4">

    <div class="well">{% include "conntrackt/location_widget.html" with location=location entities=entities %}</div>

  </div>

  {% endfor %}

</div>

<div class="row">

  <div class="span12">

    <h2>Communications diagram</h2>

    <img src="{% url "project_diagram" project.id %}" width="100%">

  </div>

</div>

{% endif %}

{% endblock %}

    RelatedCollectorMixin.get_dependant_objects_representation method

    """

    def get_context_data(self, **kwargs):

        """

        Adds the related items of a reference model object to context data.

        Returns:

          Context data.

        """

        # Set the context using the parent class.

        context = super(RelatedItemsMixin, self).get_context_data(**kwargs)

        # Add to context the nested list of string representations of related

        # items.

        context["related_items"] = self.object.get_dependant_objects_representation()

        return context

class IndexView(MultiplePermissionsRequiredMixin, TemplateView):

    """

    Custom view used for rendering the index page.

    """

    template_name = 'conntrackt/index.html'

    # Required permissions.

    permissions = {

        "all": ("conntrackt.view",),

        }

    # Raise authorisation denied exception for unmet permissions.

    raise_exception = True

    def get_context_data(self, **kwargs):

        """

        Returns the context data that should be used for rendering of the

        template.

        Adds the 'projects' context object containing all of the projects

        available sorted aplhabetically by name.

        """

        # Set the context using the parent class.

        context = super(IndexView, self).get_context_data(**kwargs)

        # Store information about all projcts in context.

        context['projects'] = Project.objects.all().order_by('name')

        # Store information about all locations in context.

        context['locations'] = Location.objects.all().order_by('name')

        return context

class ProjectView(MultiplePermissionsRequiredMixin, DetailView):

    """

    Custom view for presenting the project information.

    """

    model = Project

    permissions = {

        "all": ("conntrackt.view",),

        }

    # Raise authorisation denied exception for unmet permissions.

    raise_exception = True

    def get_context_data(self, **kwargs):

        """

        Returns the context data that should be used for rendering of the

        template.

        Adds the 'location_entities' context object that contains tuples of the

        form '(location, entities)', where location is an instance of a

        Location, and entities is a query set of entities that belong to that

        particular location, and to related project.

        """

        # Set the context using the parent class.

        context = super(ProjectView, self).get_context_data(**kwargs)

        # Set-up an array that will contaion (location, entities) tuples.

        location_entities = []

        # Add the (location, entities) tuple for each location that has entities

        # belonging to the related project.

        for location in Location.objects.filter(entity__project=self.object).distinct().order_by("name"):

            entities = Entity.objects.filter(project=self.object, location=location)

            location_entities.append((location, entities))

        # Add the (location, entities) tuples to context.

        context['location_entities'] = location_entities

        # Finally return the context.

        return context

class EntityView(MultiplePermissionsRequiredMixin, DetailView):

    """

    Custom view for presenting entity information.

    """

    # Optimise the query to fetch the related data from reverse relationships.

    queryset = Entity.objects.all()

    queryset = queryset.prefetch_related('interface_set__destination_set__source__entity')

    queryset = queryset.prefetch_related('interface_set__destination_set__destination__entity')

    queryset = queryset.prefetch_related('interface_set__source_set__source__entity')

    queryset = queryset.prefetch_related('interface_set__source_set__destination__entity')

    # Required permissions.

    permissions = {

        "all": ("conntrackt.view",),

        }

    # Raise authorisation denied exception for unmet permissions.

    raise_exception = True

    def get_context_data(self, **kwargs):

        """

        Returns the context data that should be used for rendering of the

        template.

        Adds the 'entity_iptables' context object that contains full iptables

        rules generated for the entity.

        """

        # Call the parent class method.

        context = super(EntityView, self).get_context_data(**kwargs)

        # Add the rendered iptables rules to the context.

        context['entity_iptables'] = generate_entity_iptables(self.object)

        # Add the incoming and outgoing commmunication to the context.

        context["incoming_communications"] = self.object.incoming_communications()

        context["outgoing_communications"] = self.object.outgoing_communications()

        # Add the interfaces to the context.

        context["interfaces"] = self.object.interface_set.all().order_by("name")

        # Add project/location to the context.

        context["project"] = self.object.project

        context["location"] = self.object.location

        return context

@permission_required("conntrackt.view", raise_exception=True)

def entity_iptables(request, pk):

    """

    Custom view that returns response containing iptables rules generated for an

    entity.

    Makes sure to set the Content-Disposition of a response in order to

    signal the browser it should start download of this view's response

    immediately. Also sets the suggested filename for it.

    Arguments:

        pk - Primary key of the Entity object for which the rules should be

        generated.

    Returns:

        Response object that contains the iptables rules for specified entity.

    """

    # Fetch the entity, and construct the response with iptables rules as

    # content.

    entity = get_object_or_404(Entity, pk=pk)

    content = generate_entity_iptables(entity)

    response = HttpResponse(content, mimetype='text/plain')

    # Add the Content-Disposition information for the browser, telling the

    # browser to download the file with suggested filename.

    response['Content-Disposition'] = "attachment; filename=%s-iptables.conf" % entity.name.lower().replace(" ", "_")

    return response

@permission_required("conntrackt.view", raise_exception=True)

def project_iptables(request, project_id, location_id=None):

    """

    Custom view for obtaining iptables for all entities of a project or project

    location in a single ZIP file.

    Arguments:

        request - Request object.

        project_id - Unique ID of the project for whose entities the iptables