harbour-sailfin/core/include/JellyfinQt/viewmodel/itemmodel.h

/*
 * Sailfin: a Jellyfin client written using Qt
 * Copyright (C) 2021 Chris Josten and the Sailfin Contributors.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
#ifndef JELLYFIN_VIEWMODEL_ITEMMODEL_H
#define JELLYFIN_VIEWMODEL_ITEMMODEL_H

#include <QAbstractListModel>
#include <QObject>
#include <QScopedPointer>
#include <QVariantList>

#include "../dto/baseitemdto.h"
#include "../dto/baseitemdtoqueryresult.h"
#include "../loader/requesttypes.h"
#include "../model/item.h"
#include "../viewmodel/item.h"
#include "../apimodel.h"
#include "modelstatus.h"
#include "propertyhelper.h"

// Jellyfin Forward Read/Write Property
#define FWDPROP(type, propName, propSetName) \
    public: \
        Q_PROPERTY(type propName READ propName WRITE set##propSetName NOTIFY propName##Changed) \
        type propName() const { return this->m_parameters.propName(); } \
        void set##propSetName(type newValue) { \
            this->m_parameters.set##propSetName( newValue ); \
            emit propName##Changed(); \
            autoReloadIfNeeded(); \
        } \
    Q_SIGNALS: \
        void propName##Changed();

#define FWDLISTPROP(type, propName, propSetName) \
    public: \
        Q_PROPERTY(QVariantList propName READ propName WRITE set##propSetName NOTIFY propName##Changed) \
        QVariantList propName() const { \
            QVariantList result; \
            QList<type> list; \
            result.reserve(list.size()); \
            for (auto it = list.cbegin(); it != list.cend(); it++) { \
                result.append(QVariant::fromValue<type>(*it)); \
            } \
            return result; \
        } \
        void set##propSetName(const QVariantList &newValue) { \
            QList<type> list;\
            list.reserve(newValue.size()); \
            for(auto it = newValue.cbegin(); it != newValue.cend(); it++) { \
                list.append(it->value<type>()); \
            } \
            this->m_parameters.set##propSetName(list); \
            emit propName##Changed(); \
            autoReloadIfNeeded(); \
        } \
    Q_SIGNALS: \
        void propName##Changed();

namespace Jellyfin {

namespace ViewModel {

// JellyFinRoleName
#define JFRN(name) {RoleNames::name, #name}

// This file contains all models that expose a Model::Item

/**
 * @brief Class intended for models which have a mandatory userId property, which can be extracted from the
 * ApiClient.
 */
template <class T, class D, class R, class P>
class AbstractUserParameterLoader :  public LoaderModelLoader<T, D, R, P> {
public:
    explicit AbstractUserParameterLoader(Support::Loader<R, P> *loader, QObject *parent = nullptr)
            : LoaderModelLoader<T, D, R, P>(loader, parent) {
        this->connect(this, &BaseModelLoader::apiClientChanged, this, &AbstractUserParameterLoader<T, D, R, P>::apiClientChanged);
    }
protected:
    virtual bool canReload() const override {
        return BaseModelLoader::canReload() && !this->m_parameters.userId().isNull();
    }
private:
    void apiClientChanged(ApiClient *newApiClient) {
        if (this->m_apiClient != nullptr) {
            this->disconnect(this->m_apiClient, &ApiClient::userIdChanged, this, &AbstractUserParameterLoader<T, D, R, P>::userIdChanged);
        }
        if (newApiClient != nullptr) {
            this->connect(newApiClient, &ApiClient::userIdChanged, this, &AbstractUserParameterLoader<T, D, R, P>::userIdChanged);
            if (!newApiClient->userId().isNull()) {
                this->m_parameters.setUserId(newApiClient->userId());
            }
        }
    }

    void userIdChanged(const QString &newUserId) {
        this->m_parameters.setUserId(newUserId);
        this->autoReloadIfNeeded();
    }
};

/**
 * Loads the views of an user, such as "Videos", "Music" and so on.
 */
using UserViewsLoaderBase = AbstractUserParameterLoader<Model::Item, DTO::BaseItemDto, DTO::BaseItemDtoQueryResult, Jellyfin::Loader::GetUserViewsParams>;
class UserViewsLoader : public UserViewsLoaderBase {
    Q_OBJECT
public:
    explicit UserViewsLoader(QObject *parent = nullptr);

    FWDPROP(bool, includeExternalContent, IncludeExternalContent)
    FWDPROP(bool, includeHidden, IncludeHidden)
    FWDPROP(QStringList, presetViews, PresetViews)
};

using LatestMediaBase = AbstractUserParameterLoader<Model::Item, DTO::BaseItemDto, QList<DTO::BaseItemDto>, Jellyfin::Loader::GetLatestMediaParams>;
class LatestMediaLoader : public LatestMediaBase {
    Q_OBJECT
public:
    explicit LatestMediaLoader(QObject *parent = nullptr);

    // Optional
    FWDPROP(QList<Jellyfin::DTO::ImageTypeClass::Value>, enableImageTypes, EnableImageTypes)
    FWDPROP(bool, enableImages, EnableImages)
    FWDPROP(bool, enableUserData, EnableUserData)
    FWDLISTPROP(Jellyfin::DTO::ItemFieldsClass::Value, fields, Fields)
    FWDPROP(bool, groupItems, GroupItems)
    FWDPROP(qint32, imageTypeLimit, ImageTypeLimit)
    FWDPROP(QStringList, includeItemTypes, IncludeItemTypes)
    FWDPROP(bool, isPlayed, IsPlayed)
    FWDPROP(QString, parentId, ParentId)
};

using UserItemsLoaderBase = AbstractUserParameterLoader<Model::Item, DTO::BaseItemDto, DTO::BaseItemDtoQueryResult, Jellyfin::Loader::GetItemsByUserIdParams>;
class UserItemsLoader : public UserItemsLoaderBase {
    Q_OBJECT
public:
    explicit UserItemsLoader(QObject *parent = nullptr);

    FWDPROP(QString, adjacentTo, AdjacentTo)
    FWDPROP(QStringList, albumArtistIds, AlbumArtistIds)
    FWDPROP(QStringList, albumIds, AlbumIds)
    FWDPROP(QStringList, albums, Albums)
    FWDPROP(QStringList, artistIds, ArtistIds)
    FWDPROP(QStringList, artists, Artists)
    FWDPROP(bool, collapseBoxSetItems, CollapseBoxSetItems)
    FWDPROP(QStringList, contributingArtistIds, ContributingArtistIds)
    FWDLISTPROP(Jellyfin::DTO::ImageTypeClass::Value, enableImageTypes, EnableImageTypes);
    FWDPROP(bool, enableImages, EnableImages)
    FWDPROP(bool, enableTotalRecordCount, EnableTotalRecordCount)
    FWDPROP(bool, enableUserData, EnableUserData)
    FWDPROP(QStringList, excludeArtistIds, ExcludeArtistIds)
    FWDPROP(QStringList, excludeItemIds, ExcludeItemIds)
    FWDPROP(QStringList, excludeItemTypes, ExcludeItemTypes)
    FWDPROP(QList<Jellyfin::DTO::LocationTypeClass::Value>, excludeLocationTypes, ExcludeLocationTypes)
    FWDLISTPROP(Jellyfin::DTO::ItemFieldsClass::Value, fields, Fields)
    FWDLISTPROP(Jellyfin::DTO::ItemFilterClass::Value, filters, Filters)
    FWDPROP(QStringList, genreIds, GenreIds)
    FWDPROP(QStringList, genres, Genres)
    FWDPROP(bool, hasImdbId, HasImdbId)
    FWDPROP(bool, hasOfficialRating, HasOfficialRating)
    FWDPROP(bool, hasOverview, HasOverview)
    FWDPROP(bool, hasParentalRating, HasParentalRating)
    FWDPROP(bool, hasSpecialFeature, HasSpecialFeature)
    FWDPROP(bool, hasSubtitles, HasSubtitles)
    FWDPROP(bool, hasThemeSong, HasThemeSong)
    FWDPROP(bool, hasThemeVideo, HasThemeVideo)
    FWDPROP(bool, hasTmdbId, HasTmdbId)
    FWDPROP(bool, hasTrailer, HasTrailer)
    FWDPROP(bool, hasTvdbId, HasTvdbId)
    FWDPROP(QStringList, ids, Ids)
    FWDPROP(qint32, imageTypeLimit, ImageTypeLimit)
    FWDLISTPROP(Jellyfin::DTO::ImageTypeClass::Value, imageTypes, ImageTypes)
    FWDPROP(QStringList, includeItemTypes, IncludeItemTypes)
    FWDPROP(bool, is3D, Is3D)
    FWDPROP(bool, is4K, Is4K)
    FWDPROP(bool, isFavorite, IsFavorite)
    FWDPROP(bool, isHd, IsHd)
    FWDPROP(bool, isLocked, IsLocked)
    FWDPROP(bool, isMissing, IsMissing)
    FWDPROP(bool, isPlaceHolder, IsPlaceHolder)
    FWDPROP(bool, isPlayed, IsPlayed)
    FWDPROP(bool, isUnaired, IsUnaired)
    FWDLISTPROP(Jellyfin::DTO::LocationTypeClass::Value, locationTypes, LocationTypes)
    FWDPROP(qint32, maxHeight, MaxHeight)
    FWDPROP(QString, maxOfficialRating, MaxOfficialRating)
    FWDPROP(QDateTime, maxPremiereDate, MaxPremiereDate)
    FWDPROP(qint32, maxWidth, MaxWidth)
    FWDPROP(QStringList, mediaTypes, MediaTypes)
    FWDPROP(qint32, minHeight, MinHeight)
    FWDPROP(QString, minOfficialRating, MinOfficialRating)
    FWDPROP(QDateTime, minPremiereDate, MinPremiereDate)
    FWDPROP(qint32, minWidth, MinWidth)
    FWDPROP(QString, sortBy, SortBy)
    FWDPROP(QString, sortOrder, SortOrder)
    FWDPROP(QStringList, tags, Tags)
    FWDPROP(QList<qint32>, years, Years)

    FWDPROP(QString, parentId, ParentId)
    FWDPROP(bool, recursive, Recursive)
    FWDPROP(QString, searchTerm, SearchTerm)
    //FWDPROP(bool, collapseBoxSetItems)
};

using ResumeItemsLoaderBase = AbstractUserParameterLoader<Model::Item, DTO::BaseItemDto, DTO::BaseItemDtoQueryResult, Jellyfin::Loader::GetResumeItemsParams>;
class ResumeItemsLoader : public ResumeItemsLoaderBase {
    Q_OBJECT
public:
    explicit ResumeItemsLoader(QObject *parent = nullptr);

    FWDLISTPROP(Jellyfin::DTO::ImageTypeClass::Value, enableImageTypes, EnableImageTypes);
    FWDPROP(bool, enableImages, EnableImages)
    FWDPROP(bool, enableTotalRecordCount, EnableTotalRecordCount)
    FWDPROP(bool, enableUserData, EnableUserData)
    FWDPROP(QStringList, excludeItemTypes, ExcludeItemTypes)
    FWDLISTPROP(Jellyfin::DTO::ItemFieldsClass::Value, fields, Fields)
    FWDPROP(qint32, imageTypeLimit, ImageTypeLimit)
    FWDPROP(QStringList, includeItemTypes, IncludeItemTypes)
    FWDPROP(QStringList, mediaTypes, MediaTypes)
    FWDPROP(QString, parentId, ParentId)
    FWDPROP(QString, searchTerm, SearchTerm)
};

using ShowSeasonsLoaderBase = AbstractUserParameterLoader<Model::Item, DTO::BaseItemDto, DTO::BaseItemDtoQueryResult, Jellyfin::Loader::GetSeasonsParams>;
class ShowSeasonsLoader : public ShowSeasonsLoaderBase {
    Q_OBJECT
public:
    explicit ShowSeasonsLoader(QObject *parent = nullptr);

    FWDPROP(QString, seriesId, SeriesId)
    FWDPROP(QString, adjacentTo, AdjacentTo)
    FWDLISTPROP(Jellyfin::DTO::ImageTypeClass::Value, enableImageTypes, EnableImageTypes)
    FWDPROP(bool, enableImages, EnableImages)
    FWDPROP(bool, enableUserData, EnableUserData)
    FWDLISTPROP(Jellyfin::DTO::ItemFieldsClass::Value, fields, Fields)
    FWDPROP(qint32, imageTypeLimit, ImageTypeLimit)
    FWDPROP(bool, isMissing, IsMissing)
    FWDPROP(bool, isSpecialSeason, IsSpecialSeason)

};

using ShowEpisodesLoaderBase = AbstractUserParameterLoader<Model::Item, DTO::BaseItemDto, DTO::BaseItemDtoQueryResult, Jellyfin::Loader::GetEpisodesParams>;
class ShowEpisodesLoader : public ShowEpisodesLoaderBase {
    Q_OBJECT
public:
    explicit ShowEpisodesLoader(QObject *parent = nullptr);

    FWDPROP(QString, seriesId, SeriesId)
    FWDPROP(QString, adjacentTo, AdjacentTo)
    FWDPROP(bool, enableImages, EnableImages)
    FWDPROP(bool, enableUserData, EnableUserData)
    FWDLISTPROP(Jellyfin::DTO::ItemFieldsClass::Value, fields, Fields)
    FWDPROP(qint32, imageTypeLimit, ImageTypeLimit)
    FWDPROP(bool, isMissing, IsMissing)
    FWDPROP(qint32, season, Season)
    FWDPROP(QString, seasonId, SeasonId)
    FWDPROP(QString, sortBy, SortBy)
    FWDPROP(QString, startItemId, StartItemId)
};

using NextUpLoaderBase = AbstractUserParameterLoader<Model::Item, DTO::BaseItemDto, DTO::BaseItemDtoQueryResult, Jellyfin::Loader::GetNextUpParams>;
class NextUpLoader : public NextUpLoaderBase {
    Q_OBJECT
public:
    explicit NextUpLoader(QObject *parent = nullptr);

    FWDPROP(bool, disableFirstEpisode, DisableFirstEpisode)
    FWDLISTPROP(Jellyfin::DTO::ImageTypeClass::Value, enableImageTypes, EnableImageTypes);
    FWDPROP(bool, enableImges, EnableImges)
    FWDPROP(bool, enableTotalRecordCount, EnableTotalRecordCount)
    FWDPROP(bool, enableUserData, EnableUserData)
    FWDLISTPROP(Jellyfin::DTO::ItemFieldsClass::Value, fields, Fields)
    FWDPROP(qint32, imageTypeLimit, ImageTypeLimit)
    FWDPROP(QString, parentId, ParentId)
    FWDPROP(QString, seriesId, SeriesId)
};

using AlbumArtistLoaderBase = AbstractUserParameterLoader<Model::Item, DTO::BaseItemDto, DTO::BaseItemDtoQueryResult, Jellyfin::Loader::GetAlbumArtistsParams>;
class AlbumArtistLoader : public AlbumArtistLoaderBase {
    Q_OBJECT
public:
    explicit AlbumArtistLoader(QObject *parent = nullptr);

    FWDLISTPROP(Jellyfin::DTO::ImageTypeClass::Value, enableImageTypes, EnableImageTypes);
    FWDPROP(bool, enableImages, EnableImages)
    FWDPROP(bool, enableTotalRecordCount, EnableTotalRecordCount)
    FWDPROP(bool, enableUserData, EnableUserData)
    FWDPROP(QStringList, excludeItemTypes, ExcludeItemTypes)
    FWDLISTPROP(Jellyfin::DTO::ItemFieldsClass::Value, fields, Fields)
    FWDLISTPROP(Jellyfin::DTO::ItemFilterClass::Value, filters, Filters)
    FWDPROP(QStringList, genreIds, GenreIds)
    FWDPROP(QStringList, genres, Genres)
    FWDPROP(qint32, imageTypeLimit, ImageTypeLimit)
    FWDPROP(QStringList, includeItemTypes, IncludeItemTypes)
    FWDPROP(bool, isFavorite, IsFavorite)
    FWDPROP(int, limit, Limit)
    FWDPROP(QStringList, mediaTypes, MediaTypes)
    FWDPROP(double, minCommunityRating, MinCommunityRating)
    FWDPROP(QString, nameLessThan, NameLessThan)
    FWDPROP(QString, nameStartsWith, NameStartsWith)
    FWDPROP(QString, nameStartsWithOrGreater, NameStartsWithOrGreater)
    FWDPROP(QStringList, officialRatings, OfficialRatings)
    FWDPROP(QString, parentId, ParentId)
    FWDPROP(QStringList, personIds, PersonIds)
    FWDPROP(QStringList, personTypes, PersonTypes)
    FWDPROP(QString, searchTerm, SearchTerm)
    FWDPROP(int, startIndex, StartIndex)
    FWDPROP(QStringList, studioIds, StudioIds)
    FWDPROP(QStringList, studios, Studios)
    FWDPROP(QStringList, tags, Tags)
    FWDPROP(QString, userId, UserId)
    FWDLISTPROP(int, years, Years);
};

/**
 * @brief Base class for each model that works with items.
 */

class ItemModel : public ApiModel<Model::Item> {
    Q_OBJECT
public:
    enum RoleNames {
        jellyfinId = Qt::UserRole + 1,
        name,
        originalTitle,
        serverId,
        etag,
        sourceType,
        playlistItemId,
        dateCreated,
        dateLastMediaAdded,
        extraType,

        // Hand-picked, important ones
        imageTags,
        imageBlurHashes,
        mediaType,
        type,
        collectionType,
        indexNumber,
        runTimeTicks,
        artists,
        isFolder,
        overview,
        parentIndexNumber,
        userDataRating,
        userDataPlayedPercentage,
        userDataUnplayedItemCount,
        userDataPlaybackPositionTicks,
        userDataPlayCount,
        userDataFavorite,
        userDataLikes,
        userDataLastPlayedDate,
        userDataPlayed,
        userDataKey,

        jellyfinExtendModelAfterHere = Qt::UserRole + 300 // Should be enough for now
    };

    explicit ItemModel (QObject *parent = nullptr);

    virtual QHash<int, QByteArray> roleNames() const override {
        return {
            JFRN(jellyfinId),
            JFRN(name),
            JFRN(originalTitle),
            JFRN(serverId),
            JFRN(etag),
            JFRN(sourceType),
            JFRN(playlistItemId),
            JFRN(dateCreated),
            JFRN(dateLastMediaAdded),
            JFRN(extraType),
            // Handpicked, important ones
            JFRN(imageTags),
            JFRN(imageBlurHashes),
            JFRN(mediaType),
            JFRN(type),
            JFRN(collectionType),
            JFRN(indexNumber),
            JFRN(runTimeTicks),
            JFRN(artists),
            JFRN(isFolder),
            JFRN(overview),
            JFRN(parentIndexNumber),
            JFRN(userDataRating),
            JFRN(userDataPlayedPercentage),
            JFRN(userDataUnplayedItemCount),
            JFRN(userDataPlaybackPositionTicks),
            JFRN(userDataPlayCount),
            JFRN(userDataFavorite),
            JFRN(userDataLikes),
            JFRN(userDataLastPlayedDate),
            JFRN(userDataPlayed),
            JFRN(userDataKey),
        };
    }
    QVariant data(const QModelIndex &index, int role) const override;
    QSharedPointer<Model::Item> itemAt(int index);
private slots:
    void onInsertItems(const QModelIndex &parent, int start, int end);
    void onUserDataUpdated(const DTO::UserItemDataDto &newUserData);
};
#undef JFRN

} // NS Jellyfin
} // NS ViewModel

#undef FWDPROP

#endif // JELLYFIN_VIEWMODEL_ITEMMODEL_H