1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
/*
* Copyright (C) 2005-2018 Team Kodi
* This file is part of Kodi - https://kodi.tv
*
* SPDX-License-Identifier: GPL-2.0-or-later
* See LICENSES/README.md for more information.
*/
#pragma once
#include "XBDateTime.h"
#include "addons/Addon.h"
#include "utils/ScraperParser.h"
#include "utils/ScraperUrl.h"
#include "video/Episode.h"
#include <memory>
#include <string>
#include <vector>
class CAlbum;
class CArtist;
class CVideoInfoTag;
namespace MUSIC_GRABBER
{
class CMusicAlbumInfo;
class CMusicArtistInfo;
}
typedef enum
{
CONTENT_MOVIES,
CONTENT_TVSHOWS,
CONTENT_MUSICVIDEOS,
CONTENT_ALBUMS,
CONTENT_ARTISTS,
CONTENT_NONE,
} CONTENT_TYPE;
namespace XFILE
{
class CCurlFile;
}
class CScraperUrl;
namespace ADDON
{
class CScraper;
typedef std::shared_ptr<CScraper> ScraperPtr;
std::string TranslateContent(const CONTENT_TYPE &content, bool pretty=false);
CONTENT_TYPE TranslateContent(const std::string &string);
AddonType ScraperTypeFromContent(const CONTENT_TYPE& content);
// thrown as exception to signal abort or show error dialog
class CScraperError
{
public:
CScraperError() = default;
CScraperError(const std::string &sTitle, const std::string &sMessage) :
m_fAborted(false), m_sTitle(sTitle), m_sMessage(sMessage) {}
bool FAborted() const { return m_fAborted; }
const std::string &Title() const { return m_sTitle; }
const std::string &Message() const { return m_sMessage; }
private:
bool m_fAborted = true;
std::string m_sTitle;
std::string m_sMessage;
};
class CScraper : public CAddon
{
public:
explicit CScraper(const AddonInfoPtr& addonInfo, AddonType addonType);
/*! \brief Set the scraper settings for a particular path from an XML string
Loads the default and user settings (if not already loaded) and, if the given XML string is non-empty,
overrides the user settings with the XML.
\param content Content type of the path
\param xml string of XML with the settings. If non-empty this overrides any saved user settings.
\return true if settings are available, false otherwise
\sa GetPathSettings
*/
bool SetPathSettings(CONTENT_TYPE content, const std::string& xml);
/*! \brief Get the scraper settings for a particular path in the form of an XML string
Loads the default and user settings (if not already loaded) and returns the user settings in the
form or an XML string
\return a string containing the XML settings
\sa SetPathSettings
*/
std::string GetPathSettings();
/*! \brief Clear any previously cached results for this scraper
Any previously cached files are cleared if they have been cached for longer than the specified
cachepersistence.
*/
void ClearCache();
CONTENT_TYPE Content() const { return m_pathContent; }
bool RequiresSettings() const { return m_requiressettings; }
bool Supports(const CONTENT_TYPE &content) const;
bool IsInUse() const override;
bool IsNoop();
bool IsPython() const { return m_isPython; }
// scraper media functions
CScraperUrl NfoUrl(const std::string &sNfoContent);
/*! \brief Resolve an external ID (e.g. MusicBrainz IDs) to a URL using scrapers
If we have an ID in hand, e.g. MusicBrainz IDs or TheTVDB Season IDs
we can get directly to a URL instead of searching by name and choosing from
the search results. The correct scraper type should be used to get the right
URL for a given ID, so we can differentiate albums, artists, TV Seasons, etc.
\param externalID the external ID - e.g. MusicBrainzArtist/AlbumID
\return a populated URL pointing to the details page for the given ID or
an empty URL if we couldn't resolve the ID.
*/
CScraperUrl ResolveIDToUrl(const std::string &externalID);
std::vector<CScraperUrl> FindMovie(XFILE::CCurlFile &fcurl,
const std::string &movieTitle, int movieYear, bool fFirst);
std::vector<MUSIC_GRABBER::CMusicAlbumInfo> FindAlbum(XFILE::CCurlFile &fcurl,
const std::string &sAlbum, const std::string &sArtist = "");
std::vector<MUSIC_GRABBER::CMusicArtistInfo> FindArtist(
XFILE::CCurlFile &fcurl, const std::string &sArtist);
VIDEO::EPISODELIST GetEpisodeList(XFILE::CCurlFile &fcurl, const CScraperUrl &scurl);
bool GetVideoDetails(XFILE::CCurlFile &fcurl, const CScraperUrl &scurl,
bool fMovie/*else episode*/, CVideoInfoTag &video);
bool GetAlbumDetails(XFILE::CCurlFile &fcurl, const CScraperUrl &scurl,
CAlbum &album);
bool GetArtistDetails(XFILE::CCurlFile &fcurl, const CScraperUrl &scurl,
const std::string &sSearch, CArtist &artist);
bool GetArtwork(XFILE::CCurlFile &fcurl, CVideoInfoTag &details);
private:
CScraper(const CScraper &rhs) = delete;
CScraper& operator=(const CScraper&) = delete;
CScraper(CScraper&&) = delete;
CScraper& operator=(CScraper&&) = delete;
std::string SearchStringEncoding() const
{ return m_parser.GetSearchStringEncoding(); }
/*! \brief Get the scraper settings for a particular path in the form of a JSON string
Loads the default and user settings (if not already loaded) and returns the user settings in the
form of an JSON string. It is used in Python scrapers.
\return a string containing the JSON settings
\sa SetPathSettings
*/
std::string GetPathSettingsAsJSON();
bool Load();
std::vector<std::string> Run(const std::string& function,
const CScraperUrl& url,
XFILE::CCurlFile& http,
const std::vector<std::string>* extras = nullptr);
std::vector<std::string> RunNoThrow(const std::string& function,
const CScraperUrl& url,
XFILE::CCurlFile& http,
const std::vector<std::string>* extras = nullptr);
std::string InternalRun(const std::string& function,
const CScraperUrl& url,
XFILE::CCurlFile& http,
const std::vector<std::string>* extras);
bool m_fLoaded;
bool m_isPython = false;
bool m_requiressettings;
CDateTimeSpan m_persistence;
CONTENT_TYPE m_pathContent;
CScraperParser m_parser;
};
}
|
