#

# -*- coding: utf-8 -*-

#

# Copyright (C) 2013 Branko Majic

#

# This file is part of Django Conntrackt.

#

# Django Conntrackt is free software: you can redistribute it and/or modify it

# under the terms of the GNU General Public License as published by the Free

# Software Foundation, either version 3 of the License, or (at your option) any

# later version.

#

# Django Conntrackt is distributed in the hope that it will be useful, but

# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more

# details.

#

# You should have received a copy of the GNU General Public License along with

# Django Conntrackt.  If not, see <http://www.gnu.org/licenses/>.

#

# Django imports.

from django.contrib import admin

from django.urls import resolve

# Application imports.

from .models import Project, Location, Entity, Interface, Communication

class InterfaceInline(admin.StackedInline):

    """

    This class implements the inline admin view of the Interface instances. This

    is used when adding the entities (since it's easier to specify interface for

    an entity right away).

    Properties:

      - model - Model that this admin class refers to.

      - extra - Number of interfaces that should be show inline for

        adding/editing.

    """

    model = Interface

    extra = 1

    list_display = ('source', 'destination', 'protocol', 'port', 'edit_link')

    # Make the extra edit link the main link for bringing-up admin page for

    # editing the communication.

    list_display_links = ('edit_link',)

    # All of the fields should be editable inline for ease-of-use purposes.

    list_editable = ('source', 'destination', 'protocol', 'port')

    # Add filters for project/location.

    list_filter = (CommunicationProjectListFilter, CommunicationLocationListFilter)

    def formfield_for_foreignkey(self, db_field, request, **kwargs):

        """

        Overrides the default queryset for the foreign key fields. This lets us

        limit the specification of communication to specific project and/or

        location. These are in turn passed through the GET parameters.

        Arguments:

          db_field - Name of the model field for which this method is called.

          request - Request associated with the calling view.

          kwargs - Additional keyword arguments

        """

        # Only process the source and destination fields that point to

        # interfaces.

        if db_field.name == "source" or db_field.name == "destination":

            # Perform no filtering by default.

            interface_filter = {}

            if interface_filter:

                kwargs["queryset"] = Interface.objects.filter(**interface_filter)

        # Call the parent's method so it would do any of its magic.

        return super(CommunicationAdmin, self).formfield_for_foreignkey(db_field, request, **kwargs)

class EntityAdmin(admin.ModelAdmin):

    """

    This class implements the admin view of the entity instances. It adds some

    inline capability that can be edited for the entity, and also adds inline

    editing of interfaces related to the entity.

    """

    # Show the interfaces inline when editing an entity.

    inlines = [InterfaceInline]

    # Specify what should be viewed in a list display.

    list_display = ('name', 'project', 'location')

    # Allow the user to change project and location directly in the list.

    list_editable = ('project', 'location')

    # Enable filtering based on project and location.

    list_filter = ['project', 'location']