<?php

// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the GNU Affero General Public License v3.0.
// See the LICENCE file in the repository root for full licence text.

namespace App\Models;

use App\Libraries\Transactions\AfterCommit;

/**
 * @property string|null $colour
 * @property int $display_order
 * @property string $group_avatar
 * @property int $group_avatar_height
 * @property int $group_avatar_type
 * @property int $group_avatar_width
 * @property string $group_colour
 * @property string|null $group_desc
 * @property string $group_desc_bitfield
 * @property int $group_desc_options
 * @property string $group_desc_uid
 * @property int $group_display
 * @property int $group_founder_manage
 * @property int $group_id
 * @property int $group_legend
 * @property int $group_message_limit
 * @property string $group_name
 * @property int $group_rank
 * @property int $group_receive_pm
 * @property int $group_sig_chars
 * @property int $group_type
 * @property bool $has_playmodes
 * @property string $identifier
 * @property string $short_name
 */
class Group extends Model implements AfterCommit
{
    // Identifier of groups which involved in permission checks
    // and assumed to always exist in database.
    const PRIV_IDENTIFIERS = [
        'admin',
        'alumni',
        'announce',
        'bng',
        'bng_limited',
        'bot',
        'default',
        'dev',
        'gmt',
        'loved',
        'nat',
        'no_profile',
    ];

    public $timestamps = false;

    protected $casts = [
        'has_playmodes' => 'boolean',
    ];
    protected $primaryKey = 'group_id';
    protected $table = 'phpbb_groups';

    public function getAttribute($key)
    {
        return match ($key) {
            'display_order',
            'group_avatar',
            'group_avatar_height',
            'group_avatar_type',
            'group_avatar_width',
            'group_colour',
            'group_desc_bitfield',
            'group_desc_options',
            'group_desc_uid',
            'group_display',
            'group_founder_manage',
            'group_id',
            'group_legend',
            'group_message_limit',
            'group_name',
            'group_rank',
            'group_receive_pm',
            'group_sig_chars',
            'group_type',
            'identifier',
            'short_name' => $this->getRawAttribute($key),

            'has_playmodes' => (bool) $this->getRawAttribute($key),

            'colour' => $this->getColour(),

            'group_desc' => presence($this->getRawAttribute($key)),
        };
    }

    public function descriptionHtml(): ?string
    {
        return $this->group_desc === null ? null : markdown($this->group_desc, 'group');
    }

    public function hasBadge(): bool
    {
        return $this->display_order !== null;
    }

    public function hasListing(): bool
    {
        return $this->group_type === 1;
    }

    public function isProbationary(): bool
    {
        // TODO: move this to a DB field or something if other groups end up needing 'probation'
        return $this->identifier === 'bng_limited';
    }

    public function users()
    {
        // 'cuz hasManyThrough is derp
        $userIds = UserGroup::where('group_id', $this->group_id)->pluck('user_id');

        return User::whereIn('user_id', $userIds);
    }

    public function rename(string $name, ?User $actor = null): void
    {
        if ($this->group_name === $name) {
            return;
        }

        $this->getConnection()->transaction(function () use ($actor, $name) {
            UserGroupEvent::logGroupRename($actor, $this, $this->group_name, $name);
            $this->update(['group_name' => $name]);
        });
    }

    public function afterCommit()
    {
        app('groups')->resetMemoized();
    }

    private function getColour(): ?string
    {
        $value = $this->getRawAttribute('colour');

        return $value === null ? null : "#{$value}";
    }
}