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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
|
/*
* Copyright (C) 2014-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.
*/
#include "VideoLibraryRefreshingJob.h"
#include "FileItem.h"
#include "ServiceBroker.h"
#include "TextureDatabase.h"
#include "URL.h"
#include "Util.h"
#include "addons/Scraper.h"
#include "dialogs/GUIDialogSelect.h"
#include "dialogs/GUIDialogYesNo.h"
#include "filesystem/PluginDirectory.h"
#include "guilib/GUIComponent.h"
#include "guilib/GUIKeyboardFactory.h"
#include "guilib/GUIWindowManager.h"
#include "guilib/LocalizeStrings.h"
#include "media/MediaType.h"
#include "messaging/helpers/DialogOKHelper.h"
#include "utils/StringUtils.h"
#include "utils/URIUtils.h"
#include "utils/log.h"
#include "video/VideoDatabase.h"
#include "video/VideoInfoDownloader.h"
#include "video/VideoInfoScanner.h"
#include "video/tags/IVideoInfoTagLoader.h"
#include "video/tags/VideoInfoTagLoaderFactory.h"
#include "video/tags/VideoTagLoaderPlugin.h"
#include <memory>
#include <utility>
using namespace KODI::MESSAGING;
using namespace VIDEO;
CVideoLibraryRefreshingJob::CVideoLibraryRefreshingJob(std::shared_ptr<CFileItem> item,
bool forceRefresh,
bool refreshAll,
bool ignoreNfo /* = false */,
const std::string& searchTitle /* = "" */)
: CVideoLibraryProgressJob(nullptr),
m_item(std::move(item)),
m_forceRefresh(forceRefresh),
m_refreshAll(refreshAll),
m_ignoreNfo(ignoreNfo),
m_searchTitle(searchTitle)
{ }
CVideoLibraryRefreshingJob::~CVideoLibraryRefreshingJob() = default;
bool CVideoLibraryRefreshingJob::operator==(const CJob* job) const
{
if (strcmp(job->GetType(), GetType()) != 0)
return false;
const CVideoLibraryRefreshingJob* refreshingJob = dynamic_cast<const CVideoLibraryRefreshingJob*>(job);
if (refreshingJob == nullptr)
return false;
return m_item->GetPath() == refreshingJob->m_item->GetPath();
}
bool CVideoLibraryRefreshingJob::Work(CVideoDatabase &db)
{
if (m_item == nullptr)
return false;
// determine the scraper for the item's path
VIDEO::SScanSettings scanSettings;
ADDON::ScraperPtr scraper = db.GetScraperForPath(m_item->GetPath(), scanSettings);
if (scraper == nullptr)
return false;
if (URIUtils::IsPlugin(m_item->GetPath()) && !XFILE::CPluginDirectory::IsMediaLibraryScanningAllowed(ADDON::TranslateContent(scraper->Content()), m_item->GetPath()))
{
CLog::Log(LOGINFO,
"CVideoLibraryRefreshingJob: Plugin '{}' does not support media library scanning and "
"refreshing",
CURL::GetRedacted(m_item->GetPath()));
return false;
}
// copy the scraper in case we need it again
ADDON::ScraperPtr originalScraper(scraper);
// get the item's correct title
std::string itemTitle = m_searchTitle;
if (itemTitle.empty())
itemTitle = m_item->GetMovieName(scanSettings.parent_name);
CScraperUrl scraperUrl;
bool needsRefresh = m_forceRefresh;
bool hasDetails = false;
bool ignoreNfo = m_ignoreNfo;
// run this in a loop in case we need to refresh again
bool failure = false;
do
{
std::unique_ptr<CVideoInfoTag> pluginTag;
std::unique_ptr<CGUIListItem::ArtMap> pluginArt;
if (!ignoreNfo)
{
std::unique_ptr<IVideoInfoTagLoader> loader;
loader.reset(CVideoInfoTagLoaderFactory::CreateLoader(*m_item, scraper,
scanSettings.parent_name_root, m_forceRefresh));
// check if there's an NFO for the item
CInfoScanner::INFO_TYPE nfoResult = CInfoScanner::NO_NFO;
if (loader)
{
std::unique_ptr<CVideoInfoTag> tag(new CVideoInfoTag());
nfoResult = loader->Load(*tag, false);
if (nfoResult == CInfoScanner::FULL_NFO && m_item->IsPlugin() && scraper->ID() == "metadata.local")
{
// get video info and art from plugin source with metadata.local scraper
if (scraper->Content() == CONTENT_TVSHOWS && !m_item->m_bIsFolder && tag->m_iIdShow < 0)
// preserve show_id for episode
tag->m_iIdShow = m_item->GetVideoInfoTag()->m_iIdShow;
pluginTag = std::move(tag);
CVideoTagLoaderPlugin* nfo = dynamic_cast<CVideoTagLoaderPlugin*>(loader.get());
if (nfo && nfo->GetArt())
pluginArt = std::move(nfo->GetArt());
}
else if (nfoResult == CInfoScanner::URL_NFO)
scraperUrl = loader->ScraperUrl();
}
// if there's no NFO remember it in case we have to refresh again
if (nfoResult == CInfoScanner::ERROR_NFO)
ignoreNfo = true;
else if (nfoResult != CInfoScanner::NO_NFO)
hasDetails = true;
// if we are performing a forced refresh ask the user to choose between using a valid NFO and a valid scraper
if (needsRefresh && IsModal() && !scraper->IsNoop()
&& nfoResult != CInfoScanner::ERROR_NFO)
{
int heading = 20159;
if (scraper->Content() == CONTENT_MOVIES)
heading = 13346;
else if (scraper->Content() == CONTENT_TVSHOWS)
heading = m_item->m_bIsFolder ? 20351 : 20352;
else if (scraper->Content() == CONTENT_MUSICVIDEOS)
heading = 20393;
if (CGUIDialogYesNo::ShowAndGetInput(heading, 20446))
{
hasDetails = false;
ignoreNfo = true;
scraperUrl.Clear();
scraper = originalScraper;
}
}
}
// no need to re-fetch the episode guide for episodes
if (scraper->Content() == CONTENT_TVSHOWS && !m_item->m_bIsFolder)
hasDetails = true;
// if we don't have an url or need to refresh anyway do the web search
if (!hasDetails && (needsRefresh || !scraperUrl.HasUrls()))
{
SetTitle(StringUtils::Format(g_localizeStrings.Get(197), scraper->Name()));
SetText(itemTitle);
SetProgress(0);
// clear any cached data from the scraper
scraper->ClearCache();
// create the info downloader for the scraper
CVideoInfoDownloader infoDownloader(scraper);
// try adding by filename identifier
if (scraper->IsPython() && CUtil::HasFilenameIdentifier(itemTitle))
{
CFileItemList items;
items.Add(m_item);
CVideoInfoScanner scanner;
if (scanner.RetrieveVideoInfo(items, scanSettings.parent_name, scraper->Content(),
!ignoreNfo, nullptr, m_refreshAll, GetProgressDialog()))
{
return true;
}
}
// try to find a matching item
MOVIELIST itemResultList;
int result = infoDownloader.FindMovie(itemTitle, -1, itemResultList, GetProgressDialog());
// close the progress dialog
MarkFinished();
if (result > 0)
{
// there are multiple matches for the item
if (!itemResultList.empty())
{
// choose the first match
if (!IsModal())
scraperUrl = itemResultList.at(0);
else
{
// ask the user what to do
CGUIDialogSelect* selectDialog = CServiceBroker::GetGUI()->GetWindowManager().GetWindow<CGUIDialogSelect>(WINDOW_DIALOG_SELECT);
selectDialog->Reset();
selectDialog->SetHeading(scraper->Content() == CONTENT_TVSHOWS ? 20356 : 196);
for (const auto& itemResult : itemResultList)
selectDialog->Add(itemResult.GetTitle());
selectDialog->EnableButton(true, 413); // "Manual"
selectDialog->Open();
// check if the user has chosen one of the results
int selectedItem = selectDialog->GetSelectedItem();
if (selectedItem >= 0)
scraperUrl = itemResultList.at(selectedItem);
// the user hasn't chosen one of the results and but has chosen to manually enter a title to use
else if (selectDialog->IsButtonPressed())
{
// ask the user to input a title to use
if (!CGUIKeyboardFactory::ShowAndGetInput(itemTitle, g_localizeStrings.Get(scraper->Content() == CONTENT_TVSHOWS ? 20357 : 16009), false))
return false;
// go through the whole process again
needsRefresh = true;
continue;
}
// nothing else we can do
else
return false;
}
CLog::Log(LOGDEBUG, "CVideoLibraryRefreshingJob: user selected item '{}' with URL '{}'",
scraperUrl.GetTitle(), scraperUrl.GetFirstThumbUrl());
}
}
else if (result < 0 || !VIDEO::CVideoInfoScanner::DownloadFailed(GetProgressDialog()))
{
failure = true;
break;
}
}
// if the URL is still empty, check whether or not we're allowed
// to prompt and ask the user to input a new search title
if (!hasDetails && !scraperUrl.HasUrls())
{
if (IsModal())
{
// ask the user to input a title to use
if (!CGUIKeyboardFactory::ShowAndGetInput(itemTitle, g_localizeStrings.Get(scraper->Content() == CONTENT_TVSHOWS ? 20357 : 16009), false))
return false;
// go through the whole process again
needsRefresh = true;
continue;
}
// nothing else we can do
failure = true;
break;
}
// before we start downloading all the necessary information cleanup any existing artwork and hashes
CTextureDatabase textureDb;
if (textureDb.Open())
{
for (const auto& artwork : m_item->GetArt())
textureDb.InvalidateCachedTexture(artwork.second);
textureDb.Close();
}
m_item->ClearArt();
// put together the list of items to refresh
std::string path = m_item->GetPath();
CFileItemList items;
if (m_item->HasVideoInfoTag() && m_item->GetVideoInfoTag()->m_iDbId > 0)
{
// for a tvshow we need to handle all paths of it
std::vector<std::string> tvshowPaths;
if (CMediaTypes::IsMediaType(m_item->GetVideoInfoTag()->m_type, MediaTypeTvShow) && m_refreshAll &&
db.GetPathsLinkedToTvShow(m_item->GetVideoInfoTag()->m_iDbId, tvshowPaths))
{
for (const auto& tvshowPath : tvshowPaths)
{
CFileItemPtr tvshowItem(new CFileItem(*m_item->GetVideoInfoTag()));
tvshowItem->SetPath(tvshowPath);
items.Add(tvshowItem);
}
}
// otherwise just add a copy of the item
else
items.Add(std::make_shared<CFileItem>(*m_item->GetVideoInfoTag()));
// update the path to the real path (instead of a videodb:// one)
path = m_item->GetVideoInfoTag()->m_strPath;
}
else
items.Add(std::make_shared<CFileItem>(*m_item));
// set the proper path of the list of items to lookup
items.SetPath(m_item->m_bIsFolder ? URIUtils::GetParentPath(path) : URIUtils::GetDirectory(path));
int headingLabel = 198;
if (scraper->Content() == CONTENT_TVSHOWS)
{
if (m_item->m_bIsFolder)
headingLabel = 20353;
else
headingLabel = 20361;
}
else if (scraper->Content() == CONTENT_MUSICVIDEOS)
headingLabel = 20394;
// prepare the progress dialog for downloading all the necessary information
SetTitle(g_localizeStrings.Get(headingLabel));
SetText(itemTitle);
SetProgress(0);
const bool hasAdditionalAssets{m_item->HasVideoVersions() || m_item->HasVideoExtras()};
const int origDbId{m_item->GetVideoInfoTag()->m_iDbId};
// remove any existing data for the item we're going to refresh
if (origDbId > 0)
{
if (scraper->Content() == CONTENT_MOVIES)
db.DeleteMovie(origDbId, false, DeleteMovieCascadeAction::DEFAULT_VERSION);
else if (scraper->Content() == CONTENT_MUSICVIDEOS)
db.DeleteMusicVideo(origDbId);
else if (scraper->Content() == CONTENT_TVSHOWS)
{
if (!m_item->m_bIsFolder)
db.DeleteEpisode(origDbId);
else if (m_item->GetVideoInfoTag()->m_type == MediaTypeSeason)
db.DeleteSeason(origDbId);
else if (m_refreshAll)
db.DeleteTvShow(origDbId);
else
db.DeleteDetailsForTvShow(origDbId);
}
}
if (pluginTag || pluginArt)
{
// set video info and art from plugin source with metadata.local scraper to items
for (auto &i: items)
{
if (pluginTag)
*i->GetVideoInfoTag() = *pluginTag;
if (pluginArt)
i->SetArt(*pluginArt);
}
}
// finally download the information for the item
CVideoInfoScanner scanner;
if (!scanner.RetrieveVideoInfo(items, scanSettings.parent_name,
scraper->Content(), !ignoreNfo,
scraperUrl.HasUrls() ? &scraperUrl : nullptr,
m_refreshAll, GetProgressDialog()))
{
// something went wrong
MarkFinished();
// check if the user cancelled
if (!IsCancelled() && IsModal())
HELPERS::ShowOKDialogText(CVariant{195}, CVariant{itemTitle});
return false;
}
// retrieve the updated information from the database
if (scraper->Content() == CONTENT_MOVIES)
db.GetMovieInfo(m_item->GetPath(), *m_item->GetVideoInfoTag());
else if (scraper->Content() == CONTENT_MUSICVIDEOS)
db.GetMusicVideoInfo(m_item->GetPath(), *m_item->GetVideoInfoTag());
else if (scraper->Content() == CONTENT_TVSHOWS)
{
// update tvshow/season info to get updated episode numbers
if (m_item->m_bIsFolder)
{
// Note: don't use any database ids (m_iDbId, m_idSeason, m_IdShow) of m_item's video
// info tag here. The db information might have been deleted and recreated afterwards,
// invalidating the old db ids and m_item is not (yet) updated at this point.
bool hasInfo = false;
const CVideoInfoTag* videoTag = m_item->GetVideoInfoTag();
if (videoTag && videoTag->m_type == MediaTypeSeason && videoTag->m_iSeason != -1)
hasInfo = db.GetSeasonInfo(m_item->GetPath(), videoTag->m_iSeason,
*m_item->GetVideoInfoTag(), m_item.get());
if (!hasInfo)
db.GetTvShowInfo(m_item->GetPath(), *m_item->GetVideoInfoTag());
}
else
db.GetEpisodeInfo(m_item->GetPath(), *m_item->GetVideoInfoTag());
}
if (hasAdditionalAssets)
{
const auto videoTag{m_item->GetVideoInfoTag()};
db.UpdateAssetsOwner(videoTag->m_type, origDbId, videoTag->m_iDbId);
}
// we're finally done
MarkFinished();
break;
} while (needsRefresh);
if (failure && IsModal())
HELPERS::ShowOKDialogText(CVariant{195}, CVariant{itemTitle});
return true;
}
|