EVE Swagger Interface (#591)

FAT uses ESI tokens to get character location/ship
 - closes #564

 Pull corp memebrship data from ESI

Additional permissions for non-api viewing.
 - migration to convert permissions from old users.

Standardize EVE datasource responses.
 - allow different sources for EVE data types.

Allow empty values for character alliance id and name

Allow multiple corps and alliances to be considered 'members'

corputils/admin.py

@@ -1 +1,5 @@
 from __future__ import unicode_literals
+from corputils.models import CorpStats
+from django.contrib import admin
+
+admin.site.register(CorpStats)

corputils/forms.py

@@ -1,8 +0,0 @@
-from __future__ import unicode_literals
-from django import forms
-from django.utils.translation import ugettext_lazy as _
-
-
-class CorputilsSearchForm(forms.Form):
-    search_string = forms.CharField(max_length=254, required=True, label="",
-                                    widget=forms.TextInput(attrs={'placeholder': _('Search characters...')}))

corputils/managers.py

@@ -0,0 +1,42 @@
+from django.db import models
+from authentication.models import AuthServicesInfo
+from eveonline.models import EveCharacter
+
+
+class CorpStatsQuerySet(models.QuerySet):
+    def visible_to(self, user):
+        # superusers get all visible
+        if user.is_superuser:
+            return self
+
+        auth = AuthServicesInfo.objects.get_or_create(user=user)[0]
+        try:
+            char = EveCharacter.objects.get(character_id=auth.main_char_id)
+            # build all accepted queries
+            queries = []
+            if user.has_perm('corputils.view_corp_corpstats'):
+                queries.append(models.Q(corp__corporation_id=char.corporation_id))
+            if user.has_perm('corputils.view_alliance_corpstats'):
+                queries.append(models.Q(corp__alliance__alliance_id=char.alliance_id))
+            if user.has_perm('corputils.view_blue_corpstats'):
+                queries.append(models.Q(corp__is_blue=True))
+
+            # filter based on queries
+            if queries:
+                query = queries.pop()
+                for q in queries:
+                    query |= q
+                return self.filter(query)
+            else:
+                # not allowed to see any
+                return self.none()
+        except EveCharacter.DoesNotExist:
+            return self.none()        
+
+
+class CorpStatsManager(models.Manager):
+    def get_queryset(self):
+        return CorpStatsQuerySet(self.model, using=self._db)
+
+    def visible_to(self, user):
+        return self.get_queryset().visible_to(user)

corputils/migrations/0001_initial.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.10.1 on 2016-12-14 21:36
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('esi', '0002_scopes_20161208'),
+        ('eveonline', '0004_eveapikeypair_sso_verified'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='CorpStats',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('last_update', models.DateTimeField(auto_now=True)),
+                ('_members', models.TextField(default='{}')),
+                ('corp', models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, to='eveonline.EveCorporationInfo')),
+                ('token', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='esi.Token')),
+            ],
+            options={
+                'default_permissions': ('add', 'change', 'remove', 'view_corp', 'view_alliance', 'view_blue'),
+                'verbose_name': 'corp stats',
+                'verbose_name_plural': 'corp stats',
+                'permissions': (('corp_apis', 'Can view API keys of members of their corporation.'), ('alliance_apis', 'Can view API keys of members of their alliance.'), ('blue_apis', 'Can view API keys of members of blue corporations.')),
+            },
+        ),
+    ]

corputils/migrations/0002_migrate_permissions.py

@@ -0,0 +1,125 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.10.1 on 2016-12-14 21:48
+from __future__ import unicode_literals
+
+from django.db import migrations
+
+PERMISSIONS = {
+    'user': [
+        'corp_apis',
+        'alliance_apis',
+    ],
+    'corpstats': {
+        'corp_apis': 'Can view API keys of members of their corporation.',
+        'alliance_apis': 'Can view API keys of members of their alliance.',
+        'blue_apis': 'Can view API keys of members of blue corporations.',
+        'view_corp_corpstats': 'Can view_corp corpstats',
+        'view_alliance_corpstats': 'Can view_alliance corpstats',
+        'view_blue_corpstats': 'Can view_blue corpstats',
+    }
+}
+
+def user_permissions_dict(apps):
+    Permission = apps.get_model('auth', 'Permission')
+    ContentType = apps.get_model('contenttypes', 'ContentType')
+    User = apps.get_model('auth', 'User')
+    CorpStats = apps.get_model('corputils', 'CorpStats')
+
+    user_ct = ContentType.objects.get_for_model(User)
+    corpstats_ct = ContentType.objects.get_for_model(CorpStats)
+
+    return {
+        'user': {x: Permission.objects.get_or_create(name=x, codename=x, content_type=user_ct)[0] for x in PERMISSIONS['user']},
+        'corpstats': {x: Permission.objects.get_or_create(codename=x, content_type=corpstats_ct)[0] for x, y in PERMISSIONS['corpstats'].items()},
+    }
+
+def users_with_permission(apps, perm):
+    User = apps.get_model('auth', 'User')
+    return User.objects.filter(user_permissions=perm.pk)
+
+def groups_with_permission(apps, perm):
+    Group = apps.get_model('auth', 'Group')
+    return Group.objects.filter(permissions=perm.pk)
+
+def forward(apps, schema_editor):
+    perm_dict = user_permissions_dict(apps)
+
+    corp_users = users_with_permission(apps, perm_dict['user']['corp_apis'])
+    for u in corp_users:
+        u.user_permissions.add(perm_dict['corpstats']['corp_apis'].pk)
+        u.user_permissions.add(perm_dict['corpstats']['view_corp_corpstats'].pk)
+
+    alliance_users = users_with_permission(apps, perm_dict['user']['alliance_apis'])
+    for u in alliance_users:
+        u.user_permissions.add(perm_dict['corpstats']['alliance_apis'].pk)
+        u.user_permissions.add(perm_dict['corpstats']['view_alliance_corpstats'].pk)
+
+    corp_groups = groups_with_permission(apps, perm_dict['user']['corp_apis'])
+    for g in corp_groups:
+        g.permissions.add(perm_dict['corpstats']['corp_apis'].pk)
+        g.permissions.add(perm_dict['corpstats']['view_corp_corpstats'].pk)
+
+    alliance_groups = groups_with_permission(apps, perm_dict['user']['alliance_apis'])
+    for g in alliance_groups:
+        g.permissions.add(perm_dict['corpstats']['alliance_apis'].pk)
+        g.permissions.add(perm_dict['corpstats']['view_alliance_corpstats'].pk)
+
+    for name, perm in perm_dict['user'].items():
+        perm.delete()
+    
+def reverse(apps, schema_editor):        
+    perm_dict = user_permissions_dict(apps)
+
+    corp_users = users_with_permission(apps, perm_dict['corpstats']['view_corp_corpstats'])
+    corp_api_users = users_with_permission(apps, perm_dict['corpstats']['corp_apis'])
+    corp_us = corp_users | corp_api_users
+    for u in corp_us.distinct():
+        u.user_permissions.add(perm_dict['user']['corp_apis'].pk)
+    for u in corp_users:
+        u.user_permissions.remove(perm_dict['corpstats']['view_corp_corpstats'].pk)
+    for u in corp_api_users:
+        u.user_permissions.remove(perm_dict['corpstats']['corp_apis'].pk)
+        
+
+    alliance_users = users_with_permission(apps, perm_dict['corpstats']['view_alliance_corpstats'])
+    alliance_api_users = users_with_permission(apps, perm_dict['corpstats']['alliance_apis'])
+    alliance_us = alliance_users | alliance_api_users
+    for u in alliance_us.distinct():
+        u.user_permissions.add(perm_dict['user']['alliance_apis'].pk)
+    for u in alliance_users:
+        u.user_permissions.remove(perm_dict['corpstats']['view_alliance_corpstats'].pk)
+    for u in alliance_api_users:
+        u.user_permissions.remove(perm_dict['corpstats']['alliance_apis'].pk)
+
+    corp_groups = groups_with_permission(apps, perm_dict['corpstats']['view_corp_corpstats'])
+    corp_api_groups = groups_with_permission(apps, perm_dict['corpstats']['corp_apis'])
+    corp_gs = corp_groups | corp_api_groups
+    for g in corp_groups.distinct():
+        g.permissions.add(perm_dict['user']['corp_apis'].pk)
+    for g in corp_groups:
+        g.permissions.remove(perm_dict['corpstats']['view_corp_corpstats'].pk)
+    for g in corp_api_groups:
+        g.permissions.remove(perm_dict['corpstats']['corp_apis'].pk)
+
+    alliance_groups = groups_with_permission(apps, perm_dict['corpstats']['view_alliance_corpstats'])
+    alliance_api_groups = groups_with_permission(apps, perm_dict['corpstats']['alliance_apis'])
+    alliance_gs = alliance_groups | alliance_api_groups
+    for g in alliance_gs.distinct():
+        g.permissions.add(perm_dict['user']['alliance_apis'].pk)
+    for g in alliance_groups:
+        g.permissions.remove(perm_dict['corpstats']['view_alliance_corpstats'].pk)
+    for g in alliance_api_groups:
+        g.permissions.remove(perm_dict['corpstats']['alliance_apis'].pk)
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('corputils', '0001_initial'),
+        ('authentication', '0005_delete_perms'),
+        ('auth', '0008_alter_user_username_max_length'),
+    ]
+
+    operations = [
+        migrations.RunPython(forward, reverse),
+    ]

corputils/models.py

@@ -1 +1,174 @@
 from __future__ import unicode_literals
+from django.utils.encoding import python_2_unicode_compatible
+from django.db import models
+from eveonline.models import EveCorporationInfo, EveCharacter, EveApiKeyPair
+from esi.models import Token
+from esi.errors import TokenError
+from notifications import notify
+from authentication.models import AuthServicesInfo
+from bravado.exception import HTTPForbidden
+from corputils.managers import CorpStatsManager
+from operator import attrgetter
+import json
+import logging
+
+logger = logging.getLogger(__name__)
+
+@python_2_unicode_compatible
+class CorpStats(models.Model):
+    token = models.ForeignKey(Token, on_delete=models.CASCADE)
+    corp = models.OneToOneField(EveCorporationInfo)
+    last_update = models.DateTimeField(auto_now=True)
+    _members = models.TextField(default='{}')
+
+    class Meta:
+        permissions = (
+            ('corp_apis', 'Can view API keys of members of their corporation.'),
+            ('alliance_apis', 'Can view API keys of members of their alliance.'),
+            ('blue_apis', 'Can view API keys of members of blue corporations.'),
+        )
+        default_permissions = (
+            'add',
+            'change',
+            'remove',
+            'view_corp',
+            'view_alliance',
+            'view_blue',
+        )
+        verbose_name = "corp stats"
+        verbose_name_plural = "corp stats"
+
+    objects = CorpStatsManager()
+
+    def __str__(self):
+        return "%s for %s" % (self.__class__.__name__, self.corp)
+
+    def update(self):
+        try:
+            c = self.token.get_esi_client()
+            assert c.Character.get_characters_character_id(character_id=self.token.character_id).result()['corporation_id'] == int(self.corp.corporation_id)
+            members = c.Corporation.get_corporations_corporation_id_members(corporation_id=self.corp.corporation_id).result()
+            member_ids = [m['character_id'] for m in members]
+            member_names = c.Character.get_characters_names(character_ids=member_ids).result()
+            member_list = {m['character_id']:m['character_name'] for m in member_names}
+            self.members = member_list
+            self.save()
+        except TokenError as e:
+            logger.warning("%s failed to update: %s" % (self, e))
+            if self.token.user:
+                notify(self.token.user, "%s failed to update with your ESI token." % self, message="Your token has expired or is no longer valid. Please add a new one to create a new CorpStats.", level="error")
+            self.delete()
+        except HTTPForbidden as e:
+            logger.warning("%s failed to update: %s" % (self, e))
+            if self.token.user:
+                notify(self.token.user, "%s failed to update with your ESI token." % self, message="%s: %s" % (e.status_code, e.message), level="error")
+            self.delete()
+        except AssertionError:
+            logger.warning("%s token character no longer in corp." % self)
+            if self.token.user:
+                notify(self.token.user, "%s cannot update with your ESI token." % self, message="%s cannot update with your ESI token as you have left corp." % self, level="error")
+            self.delete()
+
+    @property
+    def members(self):
+        return json.loads(self._members)
+
+    @members.setter
+    def members(self, dict):
+        self._members = json.dumps(dict)
+
+    @property
+    def member_ids(self):
+        return [id for id, name in self.members.items()]
+
+    @property
+    def member_names(self):
+        return [name for id, name in self.members.items()]
+
+    def show_apis(self, user):
+        auth = AuthServicesInfo.objects.get_or_create(user=user)[0]
+        if auth.main_char_id:
+            try:
+                char = EveCharacter.objects.get(character_id=auth.main_char_id)
+                if char.corporation_id == self.corp.corporation_id and user.has_perm('corputils.corp_apis'):
+                    return True
+                if self.corp.alliance and char.alliance_id == self.corp.alliance.alliance_id and user.has_perm('corputils.alliance_apis'):
+                    return True
+                if user.has_perm('corputils.blue_apis') and self.corp.is_blue:
+                    return True
+            except EveCharacter.DoesNotExist:
+                pass
+        return user.is_superuser
+
+    def entered_apis(self):
+        return EveCharacter.objects.filter(character_id__in=self.member_ids).exclude(api_id__isnull=True).count()
+
+    def member_count(self):
+        return len(self.members)
+
+
+    @python_2_unicode_compatible
+    class MemberObject(object):
+        def __init__(self, character_id, character_name, show_apis=False):
+            self.character_id = character_id
+            self.character_name = character_name
+            try:
+                char = EveCharacter.objects.get(character_id=character_id)
+                auth = AuthServicesInfo.objects.get(user=char.user)
+                try:
+                    self.main = EveCharacter.objects.get(character_id=auth.main_char_id)
+                except EveCharacter.DoesNotExist:
+                    self.main = None
+                api = EveApiKeyPair.objects.get(api_id=char.api_id)
+                self.registered = True
+                if show_apis:
+                    self.api = api
+                else:
+                    self.api = None
+            except (EveCharacter.DoesNotExist, AuthServicesInfo.DoesNotExist):
+                self.main = None
+                self.api = None
+                self.registered = False
+            except EveApiKeyPair.DoesNotExist:
+                self.api = None
+                self.registered = False
+
+        def __str__(self):
+            return self.character_name
+
+        def portrait_url(self, size=32):
+            return "https://image.eveonline.com/Character/%s_%s.jpg" % (self.character_id, size)
+
+    def get_member_objects(self, user):
+        show_apis = self.show_apis(user)
+        return sorted([CorpStats.MemberObject(id, name, show_apis=show_apis) for id, name in self.members.items()], key=attrgetter('character_name'))
+
+    def can_update(self, user):
+        return user.is_superuser or user == self.token.user
+
+
+    @python_2_unicode_compatible
+    class ViewModel(object):
+        def __init__(self, corpstats, user):
+            self.corp = corpstats.corp
+            self.members = corpstats.get_member_objects(user)
+            self.can_update = corpstats.can_update(user)
+            self.total_members = len(self.members)
+            self.registered_members = corpstats.entered_apis()
+            self.show_apis = corpstats.show_apis(user)
+            self.last_updated = corpstats.last_update
+
+        def __str__(self):
+            return str(self.corp)
+
+        def corp_logo(self, size=128):
+            return "https://image.eveonline.com/Corporation/%s_%s.png" % (self.corp.corporation_id, size)
+
+        def alliance_logo(self, size=128):
+            if self.corp.alliance:
+                return "https://image.eveonline.com/Alliance/%s_%s.png" % (self.corp.alliance.alliance_id, size)
+            else:
+                return "https://image.eveonline.com/Alliance/1_%s.png" % size
+
+    def get_view_model(self, user):
+        return CorpStats.ViewModel(self, user)

corputils/templates/corputils/base.html

@@ -0,0 +1,39 @@
+{% extends 'public/base.html' %}
+{% load i18n %}
+{% block title %}{% trans "Corporation Member Data" %}{% endblock %}
+{% block page_title %}{% trans "Corporation Member Data" %}{% endblock %}
+{% block content %}
+    <div class="col-lg-12">
+        <h1 class="page-header text-center">{% trans "Corporation Member Data" %}</h1>
+        <div class="col-lg-10 col-lg-offset-1 container">
+            <nav class="navbar navbar-default">
+                <div class="container-fluid">
+                    <ul class="nav navbar-nav">
+                        <li class="dropdown">
+                            <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Corporations<span class="caret"></span></a>
+                            <ul class="dropdown-menu">
+                                {% for corpstat in available %}
+                                    <li>
+                                        <a href="{% url 'corputils:view_corp' corpstat.corp.corporation_id %}">{{ corpstat.corp.corporation_name }}</a>
+                                    </li>
+                                {% endfor %}
+                            </ul>
+                        </li>
+                        {% if perms.corputils.add_corpstats %}
+                            <li>
+                                <a href="{% url 'corputils:add' %}">Add</a>
+                            </li>
+                        {% endif %}
+                    </ul>
+                    <form class="navbar-form navbar-right" role="search" action="{% url 'corputils:search' %}" method="GET">
+                        <div class="form-group">
+                            <input type="text" class="form-control" name="search_string" placeholder="{% if search_string %}{{ search_string }}{% else %}Search characters...{% endif %}">
+                        </div>
+                    </form>
+                </div>
+            </nav>
+            {% block member_data %}{% endblock %}
+        </div>
+    </div>
+{% endblock %}
+

corputils/templates/corputils/corpstats.html

@@ -0,0 +1,92 @@
+{% extends 'corputils/base.html' %}
+{% load i18n %}
+{% load humanize %}
+{% load bootstrap_pagination %}
+{% block member_data %}
+            {% if corpstats %}
+                <div class="row">
+                    <div class="col-lg-12 text-center">
+                        <table class="table">
+                            <tr>
+                                <td class="text-center col-lg-6 {% if corpstats.corp.alliance %}{% else %}col-lg-offset-3{% endif %}"><img class="ra-avatar" src="{{ corpstats.corp_logo }}"></td>
+                                {% if corpstats.corp.alliance %}
+                                    <td class="text-center col-lg-6"><img class="ra-avatar" src="{{ corpstats.alliance_logo }}"></td>
+                                {% endif %}
+                            </tr>
+                            <tr>
+                                <td class="text-center"><h4>{{ corpstats.corp.corporation_name }}</h4></td>
+                                {% if corpstats.corp.alliance %}
+                                    <td class="text-center"><h4>{{ corpstats.corp.alliance.alliance_name }}</h4></td>
+                                {% endif %}
+                            </tr>
+                        </table>
+                    </div>
+                </div>
+                <div class="row">
+                    <div class="col-lg-12">
+                        <b>{% trans "API Index:" %}</b>
+                        <div class="progress">
+                            <div class="progress-bar" role="progressbar" aria-valuenow="{{ corpstats.registered_members }}" aria-valuemin="0" aria-valuemax="{{ corpstats.total_members }}" style="width: {% widthratio corpstats.registered_members corpstats.total_members 100 %}%;">
+                                {{ corpstats.registered_members }}/{{ corpstats.total_members }}
+                            </div>
+                        </div>
+                    </div>
+                </div>
+                <div class="row">
+                    <div class="col-lg-12">
+                        <div class="panel panel-default">
+                            <div class="panel-heading clearfix">
+                                <div class="panel-title pull-left">
+                                    <h4>Members</h4>
+                                </div>
+                                <div class="panel-title pull-right">
+                                    Last update: {{ corpstats.last_updated|naturaltime }}
+                                    {% if corpstats.can_update %}
+                                        <a class="btn btn-success" type="button" href="{% url 'corputils:update' corpstats.corp.corporation_id %}" title="Update Now">
+                                            <span class="glyphicon glyphicon-refresh"></span>
+                                        </a>
+                                    {% endif %}
+                                </div>
+                            </div>
+                            <div class="panel-body">
+                                <div class="text-center">
+                                    {% bootstrap_paginate members range=10 %}
+                                </div>
+                                <div class="table-responsive">
+                                    <table class="table table-hover">
+                                        <tr>
+                                            <th></th>
+                                            <th class="text-center">Character</th>
+                                            {% if corpstats.show_apis %}
+                                                <th class="text-center">API</th>
+                                            {% endif %}
+                                            <th class="text-center">zKillboard</th>
+                                            <th class="text-center">Main Character</th>
+                                            <th class="text-center">Main Corporation</th>
+                                            <th class="text-center">Main Alliance</th>
+                                        </tr>
+                                        {% for member in members %}
+                                            <tr {% if not member.registered %}class="danger"{% endif %}>
+                                                <td><img src="{{ member.portrait_url }}" class="img-circle"></td>
+                                                <td class="text-center">{{ member.character_name }}</td>
+                                                {% if corpstats.show_apis %}
+                                                    {% if member.api %}
+                                                        <td class="text-center"><a href="{{ JACK_KNIFE_URL }}?usid={{ member.api.api_id }}&apik={{ member.api.api_key }}" target="_blank" class="label label-primary">{{ member.api.api_id }}</td>
+                                                    {% else %}
+                                                        <td></td>
+                                                    {% endif %}
+                                                {% endif %}
+                                                <td class="text-center"><a href="https://zkillboard.com/character/{{ member.character_id }}/" class="label label-danger" target="_blank">{% trans "Killboard" %}</a></td>
+                                                <td class="text-center">{{ member.main.character_name }}</td>
+                                                <td class="text-center">{{ member.main.corporation_name }}</td>
+                                                <td class="text-center">{{ member.main.alliance_name }}</td>
+                                            </tr>
+                                        {% endfor %}
+                                    </table>
+                                </div>
+                            </div>
+                        </div>
+                    </div>
+                </div>
+            {% endif %}
+{% endblock %}

corputils/templates/corputils/search.html

@@ -0,0 +1,43 @@
+{% extends "corputils/base.html" %}
+{% load i18n %}
+{% load bootstrap_pagination %}
+{% block member_data %}
+    <div class="panel panel-default">
+        <div class="panel-heading clearfix">
+            <div class="panel-title pull-left">Search Results</div>
+        </div>
+        <div class="panel-body">
+            <div class="text-center">
+                {% bootstrap_paginate results range=10 %}
+            </div>
+            <table class="table table-hover">
+                <tr>
+                    <th class="text-center"></th>
+                    <th class="text-center">Character</th>
+                    <th class="text-center">Corporation</th>
+                    <th class="text-center">API</th>
+                    <th class="text-center">zKillboard</th>
+                    <th class="text-center">Main Character</th>
+                    <th class="text-center">Main Corporation</th>
+                    <th class="text-center">Main Alliance</th>
+                </tr>
+                {% for result in results %}
+                    <tr {% if not result.1.registered %}class="danger"{% endif %}>
+                        <td class="text-center"><img src="{{ result.1.portrait_url }}" class="img-circle"></td>
+                        <td class="text-center">{{ result.1.character_name }}</td>
+                        <td class="text-center">{{ result.0.corp.corporation_name }}</td>
+                        {% if result.1.api %}
+                            <td class="text-center"><a href="{{ JACK_KNIFE_URL }}?usid={{ result.1.api.api_id }}&apik={{ result.1.api.api_key }}" target="_blank" class="label label-primary">{{ result.1.api.api_id }}</td>
+                        {% else %}
+                            <td></td>
+                        {% endif %}
+                        <td class="text-center"><a href="https://zkillboard.com/character/{{ result.1.character_id }}/" class="label label-danger" target="_blank">{% trans "Killboard" %}</a></td>
+                        <td class="text-center">{{ result.1.main.character_name }}</td>
+                        <td class="text-center">{{ result.1.main.corporation_name }}</td>
+                        <td class="text-center">{{ result.1.main.alliance_name }}</td>
+                    </tr>
+                {% endfor %}
+            </table>
+        </div>
+    </div>
+{% endblock %}

corputils/urls.py

@@ -0,0 +1,11 @@
+from django.conf.urls import url
+import corputils.views
+
+app_name='corputils'
+urlpatterns = [
+    url(r'^$', corputils.views.corpstats_view, name='view'),
+    url(r'^add/$', corputils.views.corpstats_add, name='add'),
+    url(r'^(?P<corp_id>(\d)*)/$', corputils.views.corpstats_view, name='view_corp'),
+    url(r'^(?P<corp_id>(\d)+)/update/$', corputils.views.corpstats_update, name='update'),
+    url(r'^search/$', corputils.views.corpstats_search, name='search'),
+    ]

corputils/views.py

@@ -1,325 +1,124 @@
 from __future__ import unicode_literals
 from django.conf import settings
-from django.contrib.auth.decorators import login_required
-from django.shortcuts import render, redirect
+from django.contrib.auth.decorators import login_required, permission_required, user_passes_test
+from django.shortcuts import render, redirect, get_object_or_404
+from django.contrib import messages
+from django.core.exceptions import PermissionDenied
+from django.db import IntegrityError
+from django.core.paginator import Paginator, EmptyPage, PageNotAnInteger
+from django.conf import settings
+from eveonline.models import EveCharacter, EveCorporationInfo
+from corputils.models import CorpStats
+from esi.decorators import token_required
 
-from collections import namedtuple
+MEMBERS_PER_PAGE = int(getattr(settings, 'CORPSTATS_MEMBERS_PER_PAGE', 20))
 
-from authentication.models import AuthServicesInfo
-from services.managers.eve_api_manager import EveApiManager
-from services.managers.evewho_manager import EveWhoManager
-from eveonline.models import EveCorporationInfo
-from eveonline.models import EveAllianceInfo
-from eveonline.models import EveCharacter
-from eveonline.models import EveApiKeyPair
-from fleetactivitytracking.models import Fat
-from corputils.forms import CorputilsSearchForm
-from evelink.api import APIError
-
-import logging
-import datetime
-
-logger = logging.getLogger(__name__)
-
-
-class Player(object):
-    def __init__(self, main, user, maincorp, maincorpid, altlist, apilist, n_fats):
-        self.main = main
-        self.user = user
-        self.maincorp = maincorp
-        self.maincorpid = maincorpid
-        self.altlist = altlist
-        self.apilist = apilist
-        self.n_fats = n_fats
-
-
-def first_day_of_next_month(year, month):
-    if month == 12:
-        return datetime.datetime(year + 1, 1, 1)
-    else:
-        return datetime.datetime(year, month + 1, 1)
-
-
-def first_day_of_previous_month(year, month):
-    if month == 1:
-        return datetime.datetime(year - 1, 12, 1)
-    else:
-        return datetime.datetime(year, month - 1, 1)
+def get_page(model_list, page_num):
+    p = Paginator(model_list, MEMBERS_PER_PAGE)
+    try:
+        members = p.page(page_num)
+    except PageNotAnInteger:
+        members = p.page(1)
+    except EmptyPage:
+        members = p.page(p.num_pages)
+    return members
 
+def access_corpstats_test(user):
+    return user.has_perm('corputils.view_corp_corpstats') or user.has_perm('corputils.view_alliance_corpstats') or user.has_perm('corputils.view_blue_corpstats')
 
 @login_required
-def corp_member_view(request, corpid=None, year=datetime.date.today().year, month=datetime.date.today().month):
-    year = int(year)
-    month = int(month)
-    start_of_month = datetime.datetime(year, month, 1)
-    start_of_next_month = first_day_of_next_month(year, month)
-    start_of_previous_month = first_day_of_previous_month(year, month)
-    logger.debug("corp_member_view called by user %s" % request.user)
-
+@user_passes_test(access_corpstats_test)
+@permission_required('corputils.add_corpstats')
+@token_required(scopes='esi-corporations.read_corporation_membership.v1')
+def corpstats_add(request, token):
     try:
-        user_main = EveCharacter.objects.get(
-            character_id=AuthServicesInfo.objects.get_or_create(user=request.user)[0].main_char_id)
-        user_corp_id = user_main.corporation_id
-    except (ValueError, EveCharacter.DoesNotExist):
-        user_corp_id = settings.CORP_ID
-
-    if not settings.IS_CORP:
-        alliance = EveAllianceInfo.objects.get(alliance_id=settings.ALLIANCE_ID)
-        alliancecorps = EveCorporationInfo.objects.filter(alliance=alliance)
-        membercorplist = [(int(membercorp.corporation_id), str(membercorp.corporation_name)) for membercorp in
-                          alliancecorps]
-        membercorplist.sort(key=lambda tup: tup[1])
-        membercorp_id_list = [int(membercorp.corporation_id) for membercorp in alliancecorps]
-
-        bluecorps = EveCorporationInfo.objects.filter(is_blue=True)
-        bluecorplist = [(int(bluecorp.corporation_id), str(bluecorp.corporation_name)) for bluecorp in bluecorps]
-        bluecorplist.sort(key=lambda tup: tup[1])
-        bluecorp_id_list = [int(bluecorp.corporation_id) for bluecorp in bluecorps]
-
-        if not (user_corp_id in membercorp_id_list or user_corp_id not in bluecorp_id_list):
-            user_corp_id = None
-
-    if not corpid:
-        if settings.IS_CORP:
-            corpid = settings.CORP_ID
-        elif user_corp_id:
-            corpid = user_corp_id
+        if EveCharacter.objects.filter(character_id=token.character_id).exists():
+            corp_id = EveCharacter.objects.get(character_id=token.character_id).corporation_id
         else:
-            corpid = membercorplist[0][0]
-
-    corp = EveCorporationInfo.objects.get(corporation_id=corpid)
-    if request.user.has_perm('auth.alliance_apis') or (request.user.has_perm('auth.corp_apis') and user_corp_id == corpid):
-        logger.debug("Retreiving and sending API-information")
-
-        if settings.IS_CORP:
-            try:
-                member_list = EveApiManager.get_corp_membertracking(settings.CORP_API_ID, settings.CORP_API_VCODE)
-            except APIError:
-                logger.debug("Corp API does not have membertracking scope, using EveWho data instead.")
-                member_list = EveWhoManager.get_corporation_members(corpid)
-        else:
-            member_list = EveWhoManager.get_corporation_members(corpid)
-
-        characters_with_api = {}
-        characters_without_api = {}
-
-        num_registered_characters = 0
-        for char_id, member_data in member_list.items():
-            try:
-                char = EveCharacter.objects.get(character_id=char_id)
-                char_owner = char.user
-                try:
-                    if not char_owner:
-                        raise AttributeError("Character has no assigned user.")
-                    mainid = int(AuthServicesInfo.objects.get_or_create(user=char_owner)[0].main_char_id)
-                    mainchar = EveCharacter.objects.get(character_id=mainid)
-                    mainname = mainchar.character_name
-                    maincorp = mainchar.corporation_name
-                    maincorpid = mainchar.corporation_id
-                    api_pair = EveApiKeyPair.objects.get(api_id=char.api_id)
-                except (ValueError, EveCharacter.DoesNotExist, EveApiKeyPair.DoesNotExist):
-                    logger.debug("No main character seem to be set for character %s" % char.character_name)
-                    mainname = "User: " + char_owner.username
-                    mainchar = char
-                    maincorp = "Not set."
-                    maincorpid = None
-                    api_pair = None
-                except AttributeError:
-                    logger.debug("No associated user for character %s" % char.character_name)
-                    mainname = None
-                    mainchar = char
-                    maincorp = None
-                    maincorpid = None
-                    try:
-                        api_pair = EveApiKeyPair.objects.get(api_id=char.api_id)
-                    except EveApiKeyPair.DoesNotExist:
-                        api_pair = None
-                num_registered_characters += 1
-                characters_with_api.setdefault(mainname, Player(main=mainchar,
-                                                                user=char_owner,
-                                                                maincorp=maincorp,
-                                                                maincorpid=maincorpid,
-                                                                altlist=[],
-                                                                apilist=[],
-                                                                n_fats=0)
-                                               ).altlist.append(char)
-                if api_pair:
-                    characters_with_api[mainname].apilist.append(api_pair)
-
-            except EveCharacter.DoesNotExist:
-                characters_without_api.update({member_data["name"]: member_data["id"]})
-
-        for char in EveCharacter.objects.filter(corporation_id=corpid):
-            if not int(char.character_id) in member_list:
-                logger.debug("Character '%s' does not exist in EveWho dump." % char.character_name)
-                char_owner = char.user
-                try:
-                    if not char_owner:
-                        raise AttributeError("Character has no assigned user.")
-                    mainid = int(AuthServicesInfo.objects.get_or_create(user=char_owner)[0].main_char_id)
-                    mainchar = EveCharacter.objects.get(character_id=mainid)
-                    mainname = mainchar.character_name
-                    maincorp = mainchar.corporation_name
-                    maincorpid = mainchar.corporation_id
-                    api_pair = EveApiKeyPair.objects.get(api_id=char.api_id)
-                except (ValueError, EveCharacter.DoesNotExist, EveApiKeyPair.DoesNotExist):
-                    logger.debug("No main character seem to be set for character %s" % char.character_name)
-                    mainname = "User: " + char_owner.username
-                    mainchar = char
-                    maincorp = "Not set."
-                    maincorpid = None
-                    api_pair = None
-                except AttributeError:
-                    logger.debug("No associated user for character %s" % char.character_name)
-                    mainname = None
-                    mainchar = char
-                    maincorp = None
-                    maincorpid = None
-                    try:
-                        api_pair = EveApiKeyPair.objects.get(api_id=char.api_id)
-                    except EveApiKeyPair.DoesNotExist:
-                        api_pair = None
-                num_registered_characters += 1
-                characters_with_api.setdefault(mainname, Player(main=mainchar,
-                                                                user=char_owner,
-                                                                maincorp=maincorp,
-                                                                maincorpid=maincorpid,
-                                                                altlist=[],
-                                                                apilist=[],
-                                                                n_fats=0)
-                                               ).altlist.append(char)
-                if api_pair:
-                    characters_with_api[mainname].apilist.append(api_pair)
-
-        n_unacounted = corp.member_count - (num_registered_characters + len(characters_without_api))
-
-        for mainname, player in characters_with_api.items():
-            fats_this_month = Fat.objects.filter(user=player.user).filter(
-                fatlink__fatdatetime__gte=start_of_month).filter(fatlink__fatdatetime__lt=start_of_next_month)
-            characters_with_api[mainname].n_fats = len(fats_this_month)
-
-        if start_of_next_month > datetime.datetime.now():
-            start_of_next_month = None
-
-        if not settings.IS_CORP:
-            context = {"membercorplist": membercorplist,
-                       "corp": corp,
-                       "characters_with_api": sorted(characters_with_api.items()),
-                       'n_registered': num_registered_characters,
-                       'n_unacounted': n_unacounted,
-                       "characters_without_api": sorted(characters_without_api.items()),
-                       "search_form": CorputilsSearchForm()}
-        else:
-            logger.debug("corp_member_view running in corportation mode")
-            context = {"corp": corp,
-                       "characters_with_api": sorted(characters_with_api.items()),
-                       'n_registered': num_registered_characters,
-                       'n_unacounted': n_unacounted,
-                       "characters_without_api": sorted(characters_without_api.items()),
-                       "search_form": CorputilsSearchForm()}
-
-        context["next_month"] = start_of_next_month
-        context["previous_month"] = start_of_previous_month
-        context["this_month"] = start_of_month
-
-        return render(request, 'registered/corputils.html', context=context)
-    else:
-        logger.warn('User %s (%s) not authorized to view corp stats for corp id %s' % (request.user, user_corp_id, corpid))
-    return redirect("auth_dashboard")
-
-
-def can_see_api(user, character):
-    if user.has_perm('auth.alliance_apis'):
-        return True
-    try:
-        user_main = EveCharacter.objects.get(
-                    character_id=AuthServicesInfo.objects.get_or_create(user=user)[0].main_char_id)
-        if user.has_perm('auth.corp_apis') and user_main.corporation_id == character.corporation_id:
-            return True
-    except EveCharacter.DoesNotExist:
-        return False
-    return False
-
+            corp_id = token.get_esi_client().Character.get_characters_character_id(character_id=token.character_id).result()['corporation_id']
+        corp = EveCorporationInfo.objects.get(corporation_id=corp_id)
+        cs = CorpStats.objects.create(token=token, corp=corp)
+        cs.update()
+        assert cs.pk # ensure update was succesful
+        if CorpStats.objects.filter(pk=cs.pk).visible_to(request.user).exists():
+            return redirect('corputils:view_corp', corp_id=corp.corporation_id)
+    except EveCorporationInfo.DoesNotExist:
+        messages.error(request, 'Unrecognized corporation. Please ensure it is a member of the alliance or a blue.')
+    except IntegrityError:
+        messages.error(request, 'Selected corp already has a statistics module.')
+    except AssertionError:
+        messages.error(request, 'Failed to gather corporation statistics with selected token.')
+    return redirect('corputils:view')
 
 @login_required
-def corputils_search(request, corpid=settings.CORP_ID):
-    logger.debug("corputils_search called by user %s" % request.user)
+@user_passes_test(access_corpstats_test)
+def corpstats_view(request, corp_id=None):
+    corpstats = None
+    show_apis = False
 
-    corp = EveCorporationInfo.objects.get(corporation_id=corpid)
+    # get requested model
+    if corp_id:
+        corp = get_object_or_404(EveCorporationInfo, corporation_id=corp_id)
+        corpstats = get_object_or_404(CorpStats, corp=corp)
 
-    authorized = False
-    try:
-        user_main = EveCharacter.objects.get(
-            character_id=AuthServicesInfo.objects.get_or_create(user=request.user)[0].main_char_id)
-        if request.user.has_perm('auth.alliance_apis') or (
-                    request.user.has_perm('auth.corp_apis') and (user_main.corporation_id == corpid)):
-            logger.debug("Retreiving and sending API-information")
-            authorized = True
-    except (ValueError, EveCharacter.DoesNotExist):
-        if request.user.has_perm('auth.alliance_apis'):
-            logger.debug("Retrieving and sending API-information")
-            authorized = True
+    # get available models
+    available = CorpStats.objects.visible_to(request.user)
 
-    if authorized:
-        if request.method == 'POST':
-            form = CorputilsSearchForm(request.POST)
-            logger.debug("Request type POST contains form valid: %s" % form.is_valid())
-            if form.is_valid():
-                # Really dumb search and only checks character name
-                # This can be improved but it does the job for now
-                searchstring = form.cleaned_data['search_string']
-                logger.debug("Searching for player with character name %s for user %s" % (searchstring, request.user))
+    # ensure we can see the requested model
+    if corpstats and not corpstats in available:
+        raise PermissionDenied('You do not have permission to view the selected corporation statistics module.')
 
-                member_list = {}
-                if settings.IS_CORP:
-                    member_list = EveApiManager.get_corp_membertracking(settings.CORP_API_ID, settings.CORP_API_VCODE)
-                if not member_list:
-                    logger.debug('Unable to fetch members from API. Pulling from EveWho')
-                    member_list = EveWhoManager.get_corporation_members(corpid)
+    # get default model if none requested
+    if not corp_id and available.count() == 1:
+        corpstats = available[0]
 
-                SearchResult = namedtuple('SearchResult',
-                                          ['name', 'id', 'main', 'api_registered', 'character', 'apiinfo'])
+    context = {
+        'available': available,
+    }
 
-                searchresults = []
-                for memberid, member_data in member_list.items():
-                    if searchstring.lower() in member_data["name"].lower():
-                        try:
-                            char = EveCharacter.objects.get(character_name=member_data["name"])
-                            user = char.user
-                            mainid = int(AuthServicesInfo.objects.get_or_create(user=user)[0].main_char_id)
-                            main = EveCharacter.objects.get(character_id=mainid)
-                            if can_see_api(request.user, char):
-                                api_registered = True
-                                apiinfo = EveApiKeyPair.objects.get(api_id=char.api_id)
-                            else:
-                                api_registered = False
-                                apiinfo = None
-                        except EveCharacter.DoesNotExist:
-                            api_registered = False
-                            char = None
-                            main = ""
-                            apiinfo = None
+    # paginate
+    members = []
+    if corpstats:
+        page = request.GET.get('page', 1)
+        members = get_page(corpstats.get_member_objects(request.user), page)
 
-                        searchresults.append(SearchResult(name=member_data["name"], id=memberid, main=main,
-                                                          api_registered=api_registered,
-                                                          character=char, apiinfo=apiinfo))
+    if corpstats:
+        context.update({
+        'corpstats': corpstats.get_view_model(request.user),
+        'members': members,
+        })
 
-                logger.info("Found %s members for user %s matching search string %s" % (
-                    len(searchresults), request.user, searchstring))
+    return render(request, 'corputils/corpstats.html', context=context)
 
-                context = {'corp': corp, 'results': searchresults, 'search_form': CorputilsSearchForm(),
-                           "year": datetime.datetime.now().year, "month": datetime.datetime.now().month}
-
-                return render(request, 'registered/corputilssearchview.html',
-                              context=context)
-            else:
-                logger.debug("Form invalid - returning for user %s to retry." % request.user)
-                context = {'corp': corp, 'members': None, 'search_form': CorputilsSearchForm()}
-                return render(request, 'registered/corputilssearchview.html', context=context)
-
-        else:
-            logger.debug("Returning empty search form for user %s" % request.user)
-            return redirect("auth_corputils")
+@login_required
+@user_passes_test(access_corpstats_test)
+def corpstats_update(request, corp_id):
+    corp = get_object_or_404(EveCorporationInfo, corporation_id=corp_id)
+    corpstats = get_object_or_404(CorpStats, corp=corp)
+    if corpstats.can_update(request.user):
+        corpstats.update()
     else:
-        logger.warn('User %s not authorized to view corp stats for corp ID %s' % (request.user, corpid))
-    return redirect("auth_dashboard")
+        raise PermissionDenied('You do not have permission to update member data for the selected corporation statistics module.')
+    return redirect('corputils:view_corp', corp_id=corp.corporation_id)
+
+@login_required
+@user_passes_test(access_corpstats_test)
+def corpstats_search(request):
+    results = []
+    search_string = request.GET.get('search_string', None)
+    if search_string:
+        has_similar = CorpStats.objects.filter(_members__icontains=search_string).visible_to(request.user)
+        for corpstats in has_similar:
+            similar = [(member_id, corpstats.members[member_id]) for member_id in corpstats.members if search_string.lower() in corpstats.members[member_id].lower()]
+            for s in similar:
+                results.append((corpstats, CorpStats.MemberObject(s[0], s[1], show_apis=corpstats.show_apis(request.user))))
+        page = request.GET.get('page', 1)
+        results = sorted(results, key=lambda x: x[1].character_name)
+        results_page = get_page(results, page)
+        context = {
+            'available': CorpStats.objects.visible_to(request.user),
+            'results': results_page,
+            'search_string': search_string,
+        }
+        return render(request, 'corputils/search.html', context=context)
+    return redirect('corputils:view')