models.py

import enum

from flask_sqlalchemy import BaseQuery, SQLAlchemy
from sqlalchemy import func
from sqlalchemy.types import TypeDecorator
from sqlalchemy_searchable import SearchQueryMixin
from sqlalchemy_utils import TSVectorType

import sqlalchemy
import json

db = SQLAlchemy()


class DictType(TypeDecorator):
    impl = sqlalchemy.Text()

    def process_bind_param(self, value, dialect):
        if value is not None:
            value = json.dumps(value)

        return value

    def process_result_value(self, value, dialect):
        if value is not None:
            value = json.loads(value)
        return value


class RoomMenu(db.Model):
    id = db.Column(db.Integer, primary_key=True, unique=True)
    room_id = db.Column(db.Integer)
    data = db.Column(DictType)  # This is a dict with keys in it for that type.
    # TODO: Figure out a suitable UI, maybe even using Javascript?


class Posters(db.Model):
    poster_id = db.Column(db.Integer, primary_key=True, unique=True)
    msg = db.Column(db.String(15), nullable=False)
    movie_id = db.Column(db.Integer, nullable=False)
    # While a maximum of 47 characters seems arbitrary, it is what it is.
    # It appears they mandate the last byte in their char array is null (and sprintf),
    # so perhaps the internal type is char[48]?
    title = db.Column(db.String(47), nullable=False)


class News(db.Model):
    id = db.Column(db.Integer, primary_key=True, unique=True)
    msg = db.Column(db.String(146), nullable=False)


class PayPosters(db.Model):
    poster_id = db.Column(db.Integer, primary_key=True, unique=True)
    msg = db.Column(db.String(15), nullable=False)
    title = db.Column(db.String(47), nullable=False)
    type = db.Column(db.Integer, nullable=False)
    aspect = db.Column(db.Boolean, nullable=False)


class ConciergeMiiActions(enum.Enum):
    NormalMaleA = 1
    NormalFemaleS = 2
    NormalMaleS = 3
    NormalFemaleS2 = 4
    NormalMaleS2 = 5
    CheerfulMaleA = 6
    CheerfulFemaleS = 7
    CheerfulMaleS = 8
    SaluteMaleA = 9
    SaluteFemaleS = 10
    SaluteMaleS = 11
    ForeignerA = 12
    ForeignerS = 13
    CelebrityA = 14
    CelebrityS = 15
    CelebrationA = 16
    CelebrationS = 17
    AmazingA = 18
    AmazingS = 19
    GreetingS = 20
    ApologyS = 21
    Zundoko = 24
    Takeshi = 25

    @classmethod
    def choices(cls):
        return [(choice, choice.name) for choice in cls]

    @classmethod
    def coerce(cls, item):
        return cls(int(item)) if not isinstance(item, cls) else item

    def __str__(self):
        return str(self.value)


class ConciergeMiis(db.Model):
    mii_id = db.Column(
        db.Integer, db.ForeignKey("mii_data.mii_id"), primary_key=True, unique=True
    )
    clothes = db.Column(db.Integer, nullable=False)
    action = db.Column(db.Enum(ConciergeMiiActions), nullable=False)
    prof = db.Column(db.String(129), nullable=False)
    movie_id = db.Column(db.Integer, nullable=False)
    voice = db.Column(db.Boolean, default=False, nullable=False)


# MiiData provides the genuine Mii alongside other common information.
class MiiData(db.Model):
    mii_id = db.Column(db.Integer, primary_key=True)
    data = db.Column(db.LargeBinary(74), nullable=False)
    name = db.Column(db.String(10), nullable=False)
    color1 = db.Column(db.String(6), nullable=False)
    color2 = db.Column(db.String(6), nullable=False)


class MiiMsgInfo(db.Model):
    # We make both the Mii's ID and message type unique, as to allow row
    # identification for SQLAlchemy.
    mii_id = db.Column(
        db.Integer, db.ForeignKey("mii_data.mii_id"), primary_key=True, nullable=False
    )
    type = db.Column(db.Integer, primary_key=True, nullable=False)
    seq = db.Column(db.Integer, primary_key=True, nullable=False)
    msg = db.Column(db.String(51), nullable=False)
    face = db.Column(db.Integer, nullable=False)


class FullTextSearchable(BaseQuery, SearchQueryMixin):
    pass


class MovieGenres(enum.Enum):
    """For localization’s sake, we use the colours rather than the meanings."""

    White = 0
    Gray = 1
    Green = 2
    Orange = 3
    Pink = 4
    Blue = 5

    @classmethod
    def choices(cls):
        return [(choice, choice.name) for choice in cls]

    @classmethod
    def coerce(cls, item):
        return cls(int(item)) if not isinstance(item, cls) else item

    def __str__(self):
        return str(self.value)


class Movies(db.Model):
    query_class = FullTextSearchable

    movie_id = db.Column(db.Integer, autoincrement=True, primary_key=True, unique=True)
    category_id = db.Column(
        db.Integer,
        db.ForeignKey("categories.category_id"),
        primary_key=True,
        nullable=False,
    )
    title = db.Column(db.String(47), nullable=False)
    length = db.Column(db.String(8), nullable=False)
    aspect = db.Column(db.Boolean, nullable=False)
    genre = db.Column(db.Enum(MovieGenres), nullable=False)
    sp_page_id = db.Column(db.Integer, nullable=False)
    ds_mov_id = db.Column(db.Integer, nullable=True)
    staff = db.Column(db.Boolean, nullable=False)
    date_added = db.Column(db.DateTime, nullable=False, server_default=func.now())

    search_vector = db.Column(TSVectorType("title"))


class PayMovies(db.Model):
    query_class = FullTextSearchable

    movie_id = db.Column(db.Integer, autoincrement=True, primary_key=True, unique=True)
    title = db.Column(db.String(47), nullable=False)
    length = db.Column(db.String, nullable=False)
    note = db.Column(db.String(76), nullable=False)
    price = db.Column(db.Integer, nullable=False)
    released = db.Column(db.String(10), nullable=False)
    category_id = db.Column(
        db.Integer,
        db.ForeignKey("pay_categories.category_id"),
        primary_key=True,
        nullable=False,
    )
    reference_id = db.Column(db.String(32), nullable=False)
    # Must be 7 digits long
    price_code = db.Column(db.Integer, autoincrement=True, nullable=False)
    date_added = db.Column(db.DateTime, nullable=False, server_default=func.now())
    search_vector = db.Column(TSVectorType("title", "note"))


class PayCategories(db.Model):
    category_id = db.Column(db.Integer, primary_key=True, unique=True)
    name = db.Column(db.String(61))
    # Starts at 10, goes up by 1 each time
    genre_id = db.Column(db.Integer)
    sp_page_id = db.Column(db.Integer)


class PayCategoryHeaders(db.Model):
    title = db.Column(db.String(30), primary_key=True, unique=True)


class Categories(db.Model):
    category_id = db.Column(db.Integer, primary_key=True, unique=True)
    name = db.Column(db.String(61))
    sp_page_id = db.Column(db.Integer)


class RoomBGMTypes(enum.Enum):
    SOFT_GUITAR = 1
    NORMAL = 2
    FOLK = 3
    JAZZY = 4
    TRUMPET = 5
    CHIMES = 6
    WESTERN = 7
    HARP = 8

    @classmethod
    def choices(cls):
        return [(choice, choice.name) for choice in cls]

    @classmethod
    def coerce(cls, item):
        return cls(int(item)) if not isinstance(item, cls) else item

    def __str__(self):
        return str(self.value)


class RoomContentBGMTypes(enum.Enum):
    Sadness = 1
    Upbeat = 2
    Relaxing = 3
    Classical = 4
    Playful = 5
    Chill = 6
    Adventurous = 7
    Jolly = 8
    Happiness = 9
    Casino = 10
    Parade = 11
    Excitement = 12
    idk = 13

    @classmethod
    def choices(cls):
        return [(choice, choice.name) for choice in cls]

    @classmethod
    def coerce(cls, item):
        return cls(int(item)) if not isinstance(item, cls) else item

    def __str__(self):
        return str(self.value)


class Rooms(db.Model):
    room_id = db.Column(db.Integer, autoincrement=True, primary_key=True, unique=True)
    bgm = db.Column(db.Enum(RoomBGMTypes))
    mascot = db.Column(db.Boolean)
    # Each message has a limit of 51. However, there can be 10 sequences. How we handle sequences is by splitting the
    # text by newline.
    intro_msg = db.Column(db.String)
    contact_data = db.Column(db.String(2599))
    news = db.Column(db.String(41))
    level = db.Column(db.Integer, default=1)


class RoomMiis(db.Model):
    room_id = db.Column(db.Integer, db.ForeignKey("rooms.room_id"), nullable=False)
    mii_id = db.Column(
        db.Integer, db.ForeignKey("mii_data.mii_id"), unique=True, primary_key=True
    )
    # Same thing as intro_msg in Rooms.
    mii_msg = db.Column(db.String)
    seq = db.Column(db.Integer, nullable=False)


class EvaluateData(db.Model):
    id = db.Column(db.Integer, autoincrement=True, primary_key=True, unique=True)
    movie_id = db.Column(db.Integer, index=True)
    gender = db.Column(db.Integer)
    blood = db.Column(db.Integer)
    age = db.Column(db.Integer)
    vote = db.Column(db.Integer)


class PollData(db.Model):
    id = db.Column(db.Integer, autoincrement=True, primary_key=True, unique=True)
    poll_id = db.Column(db.Integer, index=True)
    wii_num = db.Column(db.BigInteger)
    choice = db.Column(db.Integer)
    age = db.Column(db.Integer)
    gender = db.Column(db.Integer)


class ContentTypes(enum.Enum):
    Video = 0
    Image = 1

    @classmethod
    def choices(cls):
        return [(choice, choice.name) for choice in cls]

    @classmethod
    def coerce(cls, item):
        return cls(int(item)) if not isinstance(item, cls) else item

    def __str__(self):
        return str(self.value)


class LinkTypes(enum.Enum):
    Regular = 0
    TheatreMovie = 1
    TheatreCategory = 2
    Shop = 3
    Room = 4
    Category = 5

    @classmethod
    def choices(cls):
        return [(choice, choice.name) for choice in cls]

    @classmethod
    def coerce(cls, item):
        return cls(int(item)) if not isinstance(item, cls) else item

    def __str__(self):
        return str(self.value)


class IntroInfo(db.Model):
    cnt_id = db.Column(
        db.BigInteger, autoincrement=True, primary_key=True, nullable=False, unique=True
    )
    cnt_type = db.Column(db.Enum(ContentTypes))
    cat_name = db.Column(db.String(61))
    link_type = db.Column(db.Enum(LinkTypes))
    link_id = db.Column(db.Integer)


class Giveaways(db.Model):
    id = db.Column(
        db.Integer, autoincrement=True, primary_key=True, nullable=False, unique=True
    )
    giveaway_id = db.Column(db.Integer, nullable=False)
    wii_id = db.Column(db.String, nullable=False)
    email = db.Column(db.String, nullable=False)


class MovieCredits(db.Model):
    id = db.Column(
        db.Integer, autoincrement=True, primary_key=True, nullable=False, unique=True
    )
    movie_id = db.Column(db.Integer, db.ForeignKey("movies.movie_id"))
    role = db.Column(db.String(30), nullable=False)
    name = db.Column(db.String(30), nullable=False)
    order = db.Column(db.Integer, nullable=False)


class ConciergeMovies(db.Model):
    """Movies that are linked to a concierge."""

    id = db.Column(
        db.Integer, autoincrement=True, primary_key=True, nullable=False, unique=True
    )
    movie_id = db.Column(db.Integer, db.ForeignKey("movies.movie_id"), nullable=False)
    mii_id = db.Column(db.Integer, db.ForeignKey("mii_data.mii_id"), nullable=False)