[TvShow] Introduce SeasonNumber type

Komet · Sep 25, 2018 · 3b4367c · 3b4367c
1 parent f2f142f
commit 3b4367c
Show file tree

Hide file tree

Showing 54 changed files with 453 additions and 332 deletions.
diff --git a/MediaElch.pro b/MediaElch.pro
@@ -234,7 +234,8 @@ SOURCES += src/main.cpp \
     src/xbmc/XbmcSync.cpp \
     src/data/ImdbId.cpp \
     src/data/TmdbId.cpp \
-    src/data/EpisodeNumber.cpp
+    src/data/EpisodeNumber.cpp \
+    src/data/SeasonNumber.cpp
 
 macx {
     OBJECTIVE_SOURCES += src/notifications/MacNotificationHandler.mm
@@ -422,7 +423,8 @@ HEADERS  += Version.h \
     src/xbmc/XbmcSync.h \
     src/data/ImdbId.h \
     src/data/TmdbId.h \
-    src/data/EpisodeNumber.h
+    src/data/EpisodeNumber.h \
+    src/data/SeasonNumber.h
 
 FORMS    += src/main/MainWindow.ui \
     src/concerts/ConcertFilesWidget.ui \

diff --git a/src/data/Database.cpp b/src/data/Database.cpp
@@ -639,11 +639,11 @@ void Database::add(TvShowEpisode *episode, QString path, int idShow)
     query.bindValue(":content", episode->nfoContent().isEmpty() ? "" : episode->nfoContent().toUtf8());
     query.bindValue(":idShow", idShow);
     query.bindValue(":path", path.toUtf8());
-    query.bindValue(":seasonNumber", episode->season());
+    query.bindValue(":seasonNumber", episode->season().toInt());
     query.bindValue(":episodeNumber", episode->episode().toInt());
     query.exec();
     int insertId = query.lastInsertId().toInt();
-    foreach (const QString &file, episode->files()) {
+    for (const QString &file : episode->files()) {
         query.prepare("INSERT INTO episodeFiles(idEpisode, file) VALUES(:idEpisode, :file)");
         query.bindValue(":idEpisode", insertId);
         query.bindValue(":file", file.toUtf8());
@@ -740,7 +740,7 @@ QList<TvShowEpisode *> Database::episodes(int idShow)
         }
 
         TvShowEpisode *episode = new TvShowEpisode(files);
-        episode->setSeason(query.value(query.record().indexOf("seasonNumber")).toInt());
+        episode->setSeason(SeasonNumber(query.value(query.record().indexOf("seasonNumber")).toInt()));
         episode->setEpisode(EpisodeNumber(query.value(query.record().indexOf("episodeNumber")).toInt()));
         episode->setDatabaseId(query.value(query.record().indexOf("idEpisode")).toInt());
         episode->setNfoContent(QString::fromUtf8(query.value(query.record().indexOf("content")).toByteArray()));
@@ -857,15 +857,15 @@ void Database::addEpisodeToShowList(TvShowEpisode *episode, int showsSettingsId,
                       "content=:content WHERE idEpisode=:idEpisode");
         query.bindValue(":content", xmlContent.isEmpty() ? "" : xmlContent);
         query.bindValue(":idEpisode", idEpisode);
-        query.bindValue(":seasonNumber", episode->season());
+        query.bindValue(":seasonNumber", episode->season().toInt());
         query.bindValue(":episodeNumber", episode->episode().toInt());
         query.exec();
     } else {
         query.prepare("INSERT INTO showsEpisodes(content, idShow, seasonNumber, episodeNumber, tvdbid, updated) "
                       "VALUES(:content, :idShow, :seasonNumber, :episodeNumber, :tvdbid, 1)");
         query.bindValue(":content", xmlContent.isEmpty() ? "" : xmlContent);
         query.bindValue(":idShow", showsSettingsId);
-        query.bindValue(":seasonNumber", episode->season());
+        query.bindValue(":seasonNumber", episode->season().toInt());
         query.bindValue(":episodeNumber", episode->episode().toInt());
         query.bindValue(":tvdbid", tvdbid);
         query.exec();
@@ -890,7 +890,7 @@ QList<TvShowEpisode *> Database::showsEpisodes(TvShow *show)
     query.exec();
     while (query.next()) {
         TvShowEpisode *episode = new TvShowEpisode(QStringList(), show);
-        episode->setSeason(query.value(query.record().indexOf("seasonNumber")).toInt());
+        episode->setSeason(SeasonNumber(query.value(query.record().indexOf("seasonNumber")).toInt()));
         episode->setEpisode(EpisodeNumber(query.value(query.record().indexOf("episodeNumber")).toInt()));
         episode->setNfoContent(QString::fromUtf8(query.value(query.record().indexOf("content")).toByteArray()));
         episodes.append(episode);

diff --git a/src/data/EpisodeNumber.cpp b/src/data/EpisodeNumber.cpp
@@ -11,23 +11,23 @@ EpisodeNumber::EpisodeNumber(int episodeNumber) :
 
 const EpisodeNumber EpisodeNumber::NoEpisode = EpisodeNumber(-2);
 
-bool EpisodeNumber::operator==(const EpisodeNumber &other)
+bool EpisodeNumber::operator==(const EpisodeNumber &other) const
 {
     // Only valid IMDb id's are comparable
     return m_episodeNumber == other.m_episodeNumber;
 }
 
-bool EpisodeNumber::operator!=(const EpisodeNumber &other)
+bool EpisodeNumber::operator!=(const EpisodeNumber &other) const
 {
     return !(*this == other);
 }
 
-bool EpisodeNumber::operator>(const EpisodeNumber &other)
+bool EpisodeNumber::operator>(const EpisodeNumber &other) const
 {
     return m_episodeNumber > other.m_episodeNumber;
 }
 
-bool EpisodeNumber::operator<(const EpisodeNumber &other)
+bool EpisodeNumber::operator<(const EpisodeNumber &other) const
 {
     return m_episodeNumber < other.m_episodeNumber;
 }
@@ -39,6 +39,9 @@ int EpisodeNumber::toInt() const
 
 QString EpisodeNumber::toPaddedString() const
 {
+    if (m_episodeNumber == EpisodeNumber::NoEpisode.toInt()) {
+        return QStringLiteral("xx");
+    }
     return QString::number(m_episodeNumber).prepend((m_episodeNumber < 10) ? "0" : "");
 }
 

diff --git a/src/data/EpisodeNumber.h b/src/data/EpisodeNumber.h
@@ -9,10 +9,10 @@ class EpisodeNumber
     EpisodeNumber() = default;
     explicit EpisodeNumber(int episodeNumber);
 
-    bool operator==(const EpisodeNumber &other);
-    bool operator!=(const EpisodeNumber &other);
-    bool operator>(const EpisodeNumber &other);
-    bool operator<(const EpisodeNumber &other);
+    bool operator==(const EpisodeNumber &other) const;
+    bool operator!=(const EpisodeNumber &other) const;
+    bool operator>(const EpisodeNumber &other) const;
+    bool operator<(const EpisodeNumber &other) const;
 
     int toInt() const;
     QString toPaddedString() const;

diff --git a/src/data/ImageProviderInterface.h b/src/data/ImageProviderInterface.h
@@ -7,7 +7,9 @@
 #include <QString>
 
 #include "data/Concert.h"
+#include "data/EpisodeNumber.h"
 #include "data/Movie.h"
+#include "data/SeasonNumber.h"
 #include "data/TvShow.h"
 #include "globals/Globals.h"
 
@@ -41,11 +43,11 @@ class ImageProviderInterface : public QObject
     virtual void tvShowClearArts(QString tvdbId) = 0;
     virtual void tvShowCharacterArts(QString tvdbId) = 0;
     virtual void tvShowBanners(QString tvdbId) = 0;
-    virtual void tvShowEpisodeThumb(QString tvdbId, int season, EpisodeNumber episode) = 0;
-    virtual void tvShowSeason(QString tvdbId, int season) = 0;
-    virtual void tvShowSeasonBanners(QString tvdbId, int season) = 0;
-    virtual void tvShowSeasonBackdrops(QString tvdbId, int season) = 0;
-    virtual void tvShowSeasonThumbs(QString tvdbId, int season) = 0;
+    virtual void tvShowEpisodeThumb(QString tvdbId, SeasonNumber season, EpisodeNumber episode) = 0;
+    virtual void tvShowSeason(QString tvdbId, SeasonNumber season) = 0;
+    virtual void tvShowSeasonBanners(QString tvdbId, SeasonNumber season) = 0;
+    virtual void tvShowSeasonBackdrops(QString tvdbId, SeasonNumber season) = 0;
+    virtual void tvShowSeasonThumbs(QString tvdbId, SeasonNumber season) = 0;
     virtual void tvShowThumbs(QString tvdbId) = 0;
     virtual void artistFanarts(QString mbId) = 0;
     virtual void artistLogos(QString mbId) = 0;

diff --git a/src/data/MediaCenterInterface.h b/src/data/MediaCenterInterface.h
@@ -1,6 +1,7 @@
 #ifndef MEDIACENTERINTERFACE_H
 #define MEDIACENTERINTERFACE_H
 
+#include "data/SeasonNumber.h"
 #include "globals/Globals.h"
 #include "settings/DataFile.h"
 
@@ -61,9 +62,9 @@ class MediaCenterInterface : public QObject
     virtual QString imageFileName(const Movie *movie,           ImageType type, QList<DataFile> dataFiles = QList<DataFile>(), bool constructName = false) = 0;
     virtual QString imageFileName(const Concert *concert,       ImageType type, QList<DataFile> dataFiles = QList<DataFile>(), bool constructName = false) = 0;
     virtual QString imageFileName(const TvShowEpisode *episode, ImageType type, QList<DataFile> dataFiles = QList<DataFile>(), bool constructName = false) = 0;
-    virtual QString imageFileName(const TvShow *show,           ImageType type, int season = -2, QList<DataFile> dataFiles = QList<DataFile>(), bool constructName = false) = 0;
     virtual QString imageFileName(const Artist *artist,         ImageType type, QList<DataFile> dataFiles = QList<DataFile>(), bool constructName = false) = 0;
     virtual QString imageFileName(const Album *album,           ImageType type, QList<DataFile> dataFiles = QList<DataFile>(), bool constructName = false) = 0;
+    virtual QString imageFileName(const TvShow *show,           ImageType type, SeasonNumber season = SeasonNumber::NoSeason, QList<DataFile> dataFiles = QList<DataFile>(), bool constructName = false) = 0;
     // clang-format on
 
     virtual void loadBooklets(Album *album) = 0;

diff --git a/src/data/SeasonNumber.cpp b/src/data/SeasonNumber.cpp
@@ -0,0 +1,52 @@
+#include "SeasonNumber.h"
+
+#include <QRegExp>
+#include <QString>
+
+SeasonNumber::SeasonNumber(int seasonNumber) :
+    // Any number lower than 0 is regarded invalid => no episode number
+    m_seasonNumber(seasonNumber > -1 ? seasonNumber : SeasonNumber::NoSeason.toInt())
+{
+}
+
+const SeasonNumber SeasonNumber::NoSeason = SeasonNumber(-1);
+const SeasonNumber SeasonNumber::SpecialsSeason = SeasonNumber(0);
+
+bool SeasonNumber::operator==(const SeasonNumber &other) const
+{
+    // Only valid IMDb id's are comparable
+    return m_seasonNumber == other.m_seasonNumber;
+}
+
+bool SeasonNumber::operator!=(const SeasonNumber &other) const
+{
+    return !(*this == other);
+}
+
+bool SeasonNumber::operator>(const SeasonNumber &other) const
+{
+    return m_seasonNumber > other.m_seasonNumber;
+}
+
+bool SeasonNumber::operator<(const SeasonNumber &other) const
+{
+    return m_seasonNumber < other.m_seasonNumber;
+}
+
+int SeasonNumber::toInt() const
+{
+    return m_seasonNumber;
+}
+
+QString SeasonNumber::toPaddedString() const
+{
+    if (m_seasonNumber == SeasonNumber::NoSeason.toInt()) {
+        return QStringLiteral("xx");
+    }
+    return QString::number(m_seasonNumber).prepend((m_seasonNumber < 10) ? "0" : "");
+}
+
+QString SeasonNumber::toString() const
+{
+    return QString::number(m_seasonNumber);
+}
diff --git a/src/data/SeasonNumber.h b/src/data/SeasonNumber.h
@@ -0,0 +1,28 @@
+#ifndef DATA_SEASON_NUMBER
+#define DATA_SEASON_NUMBER
+
+#include <QString>
+
+class SeasonNumber
+{
+public:
+    SeasonNumber() = default;
+    explicit SeasonNumber(int seasonNumber);
+
+    bool operator==(const SeasonNumber &other) const;
+    bool operator!=(const SeasonNumber &other) const;
+    bool operator>(const SeasonNumber &other) const;
+    bool operator<(const SeasonNumber &other) const;
+
+    int toInt() const;
+    QString toPaddedString() const;
+    QString toString() const;
+
+    static const SeasonNumber NoSeason;
+    static const SeasonNumber SpecialsSeason;
+
+private:
+    int m_seasonNumber;
+};
+
+#endif // DATA_SEASON_NUMBER