datatracker/ietf/stats/models.py

# Copyright The IETF Trust 2017-2020, All Rights Reserved
# -*- coding: utf-8 -*-


from django.db import models

import debug                            # pyflakes:ignore

from ietf.meeting.models import Meeting
from ietf.name.models import CountryName
from ietf.person.models import Person
from ietf.utils.models import ForeignKey

### NOTE WELL: These models are expected to be removed and the stats app reimplemented.
#   A bare python file that should have been a management command was used to populate
#   these models when the app was first installed - it has been removed from main, but
#   can be seen at https://github.com/ietf-tools/datatracker/blob/f2b716fc052a0152c32b86b428ba6ebfdcdf5cd2/ietf/stats/backfill_data.py

class AffiliationAlias(models.Model):
    """Records that alias should be treated as name for statistical
    purposes."""

    alias = models.CharField(max_length=255, help_text="Note that aliases will be matched case-insensitive and both before and after some clean-up.", unique=True)
    name = models.CharField(max_length=255)

    def __str__(self):
        return "{} -> {}".format(self.alias, self.name)

    def save(self, *args, **kwargs):
        self.alias = self.alias.lower()
        update_fields = {"alias"}.union(kwargs.pop("update_fields", set()))
        super(AffiliationAlias, self).save(update_fields=update_fields, *args, **kwargs)

    class Meta:
        verbose_name_plural = "affiliation aliases"

class AffiliationIgnoredEnding(models.Model):
    """Records that ending should be stripped from the affiliation for statistical purposes."""

    ending = models.CharField(max_length=255, help_text="Regexp with ending, e.g. 'Inc\\.?' - remember to escape .!")

    def __str__(self):
        return self.ending

class CountryAlias(models.Model):
    """Records that alias should be treated as country for statistical
    purposes."""

    alias = models.CharField(max_length=255, help_text="Note that lower-case aliases are matched case-insensitive while aliases with at least one uppercase letter is matched case-sensitive. So 'United States' is best entered as 'united states' so it both matches 'United States' and 'United states' and 'UNITED STATES', whereas 'US' is best entered as 'US' so it doesn't accidentally match an ordinary word like 'us'.")
    country = ForeignKey(CountryName, max_length=255)

    def __str__(self):
        return "{} -> {}".format(self.alias, self.country.name)

    class Meta:
        verbose_name_plural = "country aliases"
    
class MeetingRegistration(models.Model):
    """Registration attendee records from the IETF registration system"""
    meeting = ForeignKey(Meeting)
    first_name = models.CharField(max_length=255)
    last_name = models.CharField(max_length=255)
    affiliation = models.CharField(blank=True, max_length=255)
    country_code = models.CharField(max_length=2)        # ISO 3166
    person = ForeignKey(Person, blank=True, null=True)
    email =  models.EmailField(blank=True, null=True)
    reg_type = models.CharField(blank=True, max_length=255)
    ticket_type = models.CharField(blank=True, max_length=255)
    # attended was used prior to the introduction of the ietf.meeting.Attended model and is still used by
    # Meeting.get_attendance() for older meetings. It should not be used except for dealing with legacy data.
    attended = models.BooleanField(default=False)
    # checkedin indicates that the badge was picked up
    checkedin = models.BooleanField(default=False)

    def __str__(self):
        return "{} {}".format(self.first_name, self.last_name)