Tournaments

class ProjectTypes(models.TextChoices):
    TOURNAMENT = "tournament"
    QUESTION_SERIES = "question_series"
    INDEX = "index"
    # ... other types

class Project(TimeStampedModel, TranslatedModel):
    type = models.CharField(max_length=32, choices=ProjectTypes.choices)
    
    # Tournament-specific fields
    prize_pool = models.DecimalField(
        default=None,
        decimal_places=2,
        max_digits=15,
        null=True,
        blank=True
    )
    
    start_date = models.DateTimeField(null=True, blank=True)
    
    close_date = models.DateTimeField(
        help_text=(
            "The date the tournament wraps up and prizes will be paid. "
            "All questions that should be included in the leaderboard must "
            "close and resolve before this date. "
            "This is displayed on the front end as the 'Winners announced date'"
        ),
    )
    
    forecasting_end_date = models.DateTimeField(
        help_text=(
            "The date the last scored question that counts for the tournament closes. "
            "The date shown is the latest of the Forecasting end date "
            "and the latest question close date closing and resolving before the Close date."
        ),
    )
    
    sign_up_fields = models.JSONField(
        default=list,
        blank=True,
        help_text="Used during tournament onboarding."
    )

@property
def is_ongoing(self):
    if self.type in (
        self.ProjectTypes.TOURNAMENT,
        self.ProjectTypes.QUESTION_SERIES,
        self.ProjectTypes.INDEX,
    ):
        return self.close_date > django_timezone.now() if self.close_date else True

post = models.ForeignKey(
    "posts.Post",
    on_delete=models.CASCADE,
    related_name="questions",
)

# Post has:
default_project = models.ForeignKey(Project, on_delete=models.CASCADE)
projects = models.ManyToManyField(Project, related_name="posts")

primary_leaderboard = models.ForeignKey(
    "scoring.Leaderboard",
    null=True,
    on_delete=models.SET_NULL,
    related_name="primary_project",
    blank=True,
)

def save(self, *args, **kwargs):
    creating = not self.pk
    super().save(*args, **kwargs)
    
    if creating and not self.primary_leaderboard and self.type in (
        self.ProjectTypes.TOURNAMENT,
        self.ProjectTypes.QUESTION_SERIES,
        self.ProjectTypes.COMMUNITY,
    ):
        from scoring.models import Leaderboard
        
        leaderboard = Leaderboard.objects.create(
            project=self,
            score_type=LeaderboardScoreTypes.PEER_TOURNAMENT,
        )
        Project.objects.filter(pk=self.pk).update(primary_leaderboard=leaderboard)

prize_pool = models.DecimalField(
    default=None, decimal_places=2, max_digits=15, null=True, blank=True
)

class Leaderboard(TimeStampedModel):
    prize_pool = models.DecimalField(
        help_text="""Optional. If not set, the Project's prize_pool will be used.
        If the Project has a prize pool, but this leaderboard has none, set this to 0.
        """,
    )
    
    minimum_prize_amount = models.DecimalField(
        default=50.00,
        decimal_places=2,
        max_digits=15,
        help_text="""The minimum amount a user can win in this leaderboard.
        Any remaining money is redistributed. Tournaments that close before June 2025
        will have a value of 0.00.
        """,
    )

sign_up_fields = models.JSONField(
    default=list, blank=True, help_text="Used during tournament onboarding."
)

[
  {"field": "affiliation", "label": "University or Organization", "required": true},
  {"field": "experience", "label": "Forecasting Experience", "required": false}
]

followers_count = models.PositiveIntegerField(
    default=0, db_index=True, editable=False
)
forecasts_count = models.PositiveIntegerField(default=0, editable=False)
forecasters_count = models.PositiveIntegerField(default=0, editable=False)

class BotLeaderboardStatus(models.TextChoices):
    EXCLUDE_AND_HIDE = "exclude_and_hide"
    EXCLUDE_AND_SHOW = "exclude_and_show"
    INCLUDE = "include"
    BOTS_ONLY = "bots_only"

bot_leaderboard_status = models.CharField(
    max_length=32,
    choices=BotLeaderboardStatus.choices,
    default=BotLeaderboardStatus.EXCLUDE_AND_SHOW,
    help_text="""Sets the status of bots in any leaderboard associated with this project.
    exclude_and_hide: Bots excluded from ranks/prizes/medals and hidden from leaderboard.
    exclude_and_show: Bots excluded from ranks/prizes/medals but shown on leaderboard.
    include: Bots included in ranks/prizes/medals and shown on leaderboard.
    bots_only: Only Bots included in ranks/prizes/medals. Non-bots still shown.
    """,
)

class Visibility(models.TextChoices):
    NORMAL = "normal"
    NOT_IN_MAIN_FEED = "not_in_main_feed"
    UNLISTED = "unlisted"

visibility = models.CharField(
    choices=Visibility.choices,
    default=Visibility.NOT_IN_MAIN_FEED,
    help_text=(
        "Sets the visibility of this project:\n"
        "Normal: Visible on main feed, contributes to global leaderboards/medals, "
        "lists the project in tournaments/question series page.\n"
        "Not In Main Feed: Not visible in main feed but searchable, doesn't contribute "
        "to global leaderboards/medals, lists in tournaments page.\n"
        "Unlisted: Not visible in main feed, not searchable, doesn't contribute "
        "to global leaderboards/medals. Default for newly created Tournaments/Question Series."
    ),
)

show_on_homepage = models.BooleanField(default=False, db_index=True)
show_on_services_page = models.BooleanField(
    default=False, db_index=True, help_text="Show project on the Services page."
)

name = models.CharField(max_length=200)
slug = models.CharField(max_length=200, validators=[validate_alpha_slug])
subtitle = models.CharField(max_length=255, blank=True, default="")
description = models.TextField(blank=True, default="")
header_image = models.ImageField(null=True, blank=True)
header_logo = models.ImageField(null=True, blank=True)
emoji = models.CharField(max_length=10, default="", blank=True)

html_metadata_json = models.JSONField(
    help_text="Custom JSON for HTML meta tags. Supported fields are: title, description",
    null=True,
    blank=True,
    default=None,
)

forecasts_flow_enabled = models.BooleanField(
    default=True, help_text="Enables new forecast flow for tournaments"
)

default_permission = models.CharField(
    choices=ObjectPermission.choices,
    null=True,
    blank=True,
    default=ObjectPermission.FORECASTER,
    db_index=True,
)

override_permissions = models.ManyToManyField(User, through="ProjectUserPermission")

class ProjectUserPermission(TimeStampedModel):
    user = models.ForeignKey(User, on_delete=models.CASCADE)
    project = models.ForeignKey(Project, on_delete=models.CASCADE)
    permission = models.CharField(choices=ObjectPermission.choices)