/
VideoInfoScanner.cpp
1785 lines (1590 loc) · 60.5 KB
/
VideoInfoScanner.cpp
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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (C) 2005-2008 Team XBMC
* http://www.xbmc.org
*
* This Program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
*
* This Program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with XBMC; see the file COPYING. If not, write to
* the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
* http://www.gnu.org/copyleft/gpl.html
*
*/
#include "threads/SystemClock.h"
#include "FileItem.h"
#include "VideoInfoScanner.h"
#include "addons/AddonManager.h"
#include "filesystem/DirectoryCache.h"
#include "Util.h"
#include "NfoFile.h"
#include "utils/RegExp.h"
#include "utils/md5.h"
#include "pictures/Picture.h"
#include "filesystem/StackDirectory.h"
#include "VideoInfoDownloader.h"
#include "GUIInfoManager.h"
#include "filesystem/File.h"
#include "dialogs/GUIDialogProgress.h"
#include "dialogs/GUIDialogYesNo.h"
#include "dialogs/GUIDialogOK.h"
#include "interfaces/AnnouncementManager.h"
#include "settings/AdvancedSettings.h"
#include "settings/GUISettings.h"
#include "settings/Settings.h"
#include "utils/StringUtils.h"
#include "guilib/LocalizeStrings.h"
#include "utils/TimeUtils.h"
#include "utils/log.h"
#include "utils/URIUtils.h"
#include "utils/Variant.h"
using namespace std;
using namespace XFILE;
using namespace ADDON;
namespace VIDEO
{
CVideoInfoScanner::CVideoInfoScanner()
{
m_bRunning = false;
m_pObserver = NULL;
m_bCanInterrupt = false;
m_currentItem = 0;
m_itemCount = 0;
m_bClean = false;
m_scanAll = false;
}
CVideoInfoScanner::~CVideoInfoScanner()
{
}
void CVideoInfoScanner::Process()
{
try
{
unsigned int tick = XbmcThreads::SystemClockMillis();
m_database.Open();
if (m_pObserver)
m_pObserver->OnStateChanged(PREPARING);
m_bCanInterrupt = true;
CLog::Log(LOGNOTICE, "VideoInfoScanner: Starting scan ..");
// Reset progress vars
m_currentItem = 0;
m_itemCount = -1;
SetPriority(GetMinPriority());
// Database operations should not be canceled
// using Interupt() while scanning as it could
// result in unexpected behaviour.
m_bCanInterrupt = false;
bool bCancelled = false;
while (!bCancelled && m_pathsToScan.size())
{
/*
* A copy of the directory path is used because the path supplied is
* immediately removed from the m_pathsToScan set in DoScan(). If the
* reference points to the entry in the set a null reference error
* occurs.
*/
CStdString directory = *m_pathsToScan.begin();
if (!DoScan(directory))
bCancelled = true;
}
if (!bCancelled)
{
if (m_bClean)
m_database.CleanDatabase(m_pObserver,&m_pathsToClean);
else
{
if (m_pObserver)
m_pObserver->OnStateChanged(COMPRESSING_DATABASE);
m_database.Compress(false);
}
}
m_database.Close();
tick = XbmcThreads::SystemClockMillis() - tick;
CLog::Log(LOGNOTICE, "VideoInfoScanner: Finished scan. Scanning for video info took %s", StringUtils::SecondsToTimeString(tick / 1000).c_str());
m_bRunning = false;
if (m_pObserver)
m_pObserver->OnFinished();
}
catch (...)
{
CLog::Log(LOGERROR, "VideoInfoScanner: Exception while scanning.");
}
}
void CVideoInfoScanner::Start(const CStdString& strDirectory, bool scanAll)
{
m_strStartDir = strDirectory;
m_scanAll = scanAll;
m_pathsToScan.clear();
m_pathsToClean.clear();
if (strDirectory.IsEmpty())
{ // scan all paths in the database. We do this by scanning all paths in the db, and crossing them off the list as
// we go.
m_database.Open();
m_database.GetPaths(m_pathsToScan);
m_database.Close();
}
else
{
m_pathsToScan.insert(strDirectory);
}
m_bClean = g_advancedSettings.m_bVideoLibraryCleanOnUpdate;
StopThread();
Create();
m_bRunning = true;
}
bool CVideoInfoScanner::IsScanning()
{
return m_bRunning;
}
void CVideoInfoScanner::Stop()
{
if (m_bCanInterrupt)
m_database.Interupt();
StopThread();
}
void CVideoInfoScanner::SetObserver(IVideoInfoScannerObserver* pObserver)
{
m_pObserver = pObserver;
}
bool CVideoInfoScanner::DoScan(const CStdString& strDirectory)
{
if (m_pObserver)
{
m_pObserver->OnDirectoryChanged(strDirectory);
m_pObserver->OnSetTitle(g_localizeStrings.Get(20415));
}
/*
* Remove this path from the list we're processing. This must be done prior to
* the check for file or folder exclusion to prevent an infinite while loop
* in Process().
*/
set<CStdString>::iterator it = m_pathsToScan.find(strDirectory);
if (it != m_pathsToScan.end())
m_pathsToScan.erase(it);
// load subfolder
CFileItemList items;
bool foundDirectly = false;
bool bSkip = false;
SScanSettings settings;
ScraperPtr info = m_database.GetScraperForPath(strDirectory, settings, foundDirectly);
CONTENT_TYPE content = info ? info->Content() : CONTENT_NONE;
// exclude folders that match our exclude regexps
CStdStringArray regexps = content == CONTENT_TVSHOWS ? g_advancedSettings.m_tvshowExcludeFromScanRegExps
: g_advancedSettings.m_moviesExcludeFromScanRegExps;
if (CUtil::ExcludeFileOrFolder(strDirectory, regexps))
return true;
bool ignoreFolder = m_scanAll && settings.noupdate;
if (content == CONTENT_NONE || ignoreFolder)
return true;
CStdString hash, dbHash;
if (content == CONTENT_MOVIES ||content == CONTENT_MUSICVIDEOS)
{
if (m_pObserver)
m_pObserver->OnStateChanged(content == CONTENT_MOVIES ? FETCHING_MOVIE_INFO : FETCHING_MUSICVIDEO_INFO);
CStdString fastHash = GetFastHash(strDirectory);
if (m_database.GetPathHash(strDirectory, dbHash) && !fastHash.IsEmpty() && fastHash == dbHash)
{ // fast hashes match - no need to process anything
CLog::Log(LOGDEBUG, "VideoInfoScanner: Skipping dir '%s' due to no change (fasthash)", strDirectory.c_str());
hash = fastHash;
bSkip = true;
}
if (!bSkip)
{ // need to fetch the folder
CDirectory::GetDirectory(strDirectory, items, g_settings.m_videoExtensions);
items.Stack();
// compute hash
GetPathHash(items, hash);
if (hash != dbHash && !hash.IsEmpty())
{
if (dbHash.IsEmpty())
CLog::Log(LOGDEBUG, "VideoInfoScanner: Scanning dir '%s' as not in the database", strDirectory.c_str());
else
CLog::Log(LOGDEBUG, "VideoInfoScanner: Rescanning dir '%s' due to change (%s != %s)", strDirectory.c_str(), dbHash.c_str(), hash.c_str());
}
else
{ // they're the same or the hash is empty (dir empty/dir not retrievable)
if (hash.IsEmpty() && !dbHash.IsEmpty())
{
CLog::Log(LOGDEBUG, "VideoInfoScanner: Skipping dir '%s' as it's empty or doesn't exist - adding to clean list", strDirectory.c_str());
m_pathsToClean.push_back(m_database.GetPathId(strDirectory));
}
else
CLog::Log(LOGDEBUG, "VideoInfoScanner: Skipping dir '%s' due to no change", strDirectory.c_str());
bSkip = true;
if (m_pObserver)
m_pObserver->OnDirectoryScanned(strDirectory);
}
// update the hash to a fast hash if needed
if (CanFastHash(items) && !fastHash.IsEmpty())
hash = fastHash;
}
}
else if (content == CONTENT_TVSHOWS)
{
if (m_pObserver)
m_pObserver->OnStateChanged(FETCHING_TVSHOW_INFO);
if (foundDirectly && !settings.parent_name_root)
{
CDirectory::GetDirectory(strDirectory, items, g_settings.m_videoExtensions);
items.SetPath(strDirectory);
GetPathHash(items, hash);
bSkip = true;
if (!m_database.GetPathHash(strDirectory, dbHash) || dbHash != hash)
{
m_database.SetPathHash(strDirectory, hash);
bSkip = false;
}
else
items.Clear();
}
else
{
CFileItemPtr item(new CFileItem(URIUtils::GetFileName(strDirectory)));
item->SetPath(strDirectory);
item->m_bIsFolder = true;
items.Add(item);
items.SetPath(URIUtils::GetParentPath(item->GetPath()));
}
}
if (!bSkip)
{
if (RetrieveVideoInfo(items, settings.parent_name_root, content))
{
if (!m_bStop && (content == CONTENT_MOVIES || content == CONTENT_MUSICVIDEOS))
{
m_database.SetPathHash(strDirectory, hash);
m_pathsToClean.push_back(m_database.GetPathId(strDirectory));
CLog::Log(LOGDEBUG, "VideoInfoScanner: Finished adding information from dir %s", strDirectory.c_str());
}
}
else
{
m_pathsToClean.push_back(m_database.GetPathId(strDirectory));
CLog::Log(LOGDEBUG, "VideoInfoScanner: No (new) information was found in dir %s", strDirectory.c_str());
}
}
else if (hash != dbHash && (content == CONTENT_MOVIES || content == CONTENT_MUSICVIDEOS))
{ // update the hash either way - we may have changed the hash to a fast version
m_database.SetPathHash(strDirectory, hash);
}
if (m_pObserver)
m_pObserver->OnDirectoryScanned(strDirectory);
for (int i = 0; i < items.Size(); ++i)
{
CFileItemPtr pItem = items[i];
if (m_bStop)
break;
// if we have a directory item (non-playlist) we then recurse into that folder
// do not recurse for tv shows - we have already looked recursively for episodes
if (pItem->m_bIsFolder && !pItem->IsParentFolder() && !pItem->IsPlayList() && settings.recurse > 0 && content != CONTENT_TVSHOWS)
{
if (!DoScan(pItem->GetPath()))
{
m_bStop = true;
}
}
}
return !m_bStop;
}
bool CVideoInfoScanner::RetrieveVideoInfo(CFileItemList& items, bool bDirNames, CONTENT_TYPE content, bool useLocal, CScraperUrl* pURL, bool fetchEpisodes, CGUIDialogProgress* pDlgProgress)
{
if (pDlgProgress)
{
if (items.Size() > 1 || (items[0]->m_bIsFolder && fetchEpisodes))
{
pDlgProgress->ShowProgressBar(true);
pDlgProgress->SetPercentage(0);
}
else
pDlgProgress->ShowProgressBar(false);
pDlgProgress->Progress();
}
m_database.Open();
bool FoundSomeInfo = false;
vector<int> seenPaths;
for (int i = 0; i < (int)items.Size(); ++i)
{
m_nfoReader.Close();
CFileItemPtr pItem = items[i];
// we do this since we may have a override per dir
ScraperPtr info2 = m_database.GetScraperForPath(pItem->m_bIsFolder ? pItem->GetPath() : items.GetPath());
if (!info2) // skip
continue;
// Discard all exclude files defined by regExExclude
if (CUtil::ExcludeFileOrFolder(pItem->GetPath(), (content == CONTENT_TVSHOWS) ? g_advancedSettings.m_tvshowExcludeFromScanRegExps
: g_advancedSettings.m_moviesExcludeFromScanRegExps))
continue;
if (info2->Content() == CONTENT_MOVIES || info2->Content() == CONTENT_MUSICVIDEOS)
{
if (m_pObserver)
{
m_pObserver->OnSetCurrentProgress(i, items.Size());
if (!pItem->m_bIsFolder && m_itemCount)
m_pObserver->OnSetProgress(m_currentItem++, m_itemCount);
}
}
// clear our scraper cache
info2->ClearCache();
INFO_RET ret = INFO_CANCELLED;
if (info2->Content() == CONTENT_TVSHOWS)
ret = RetrieveInfoForTvShow(pItem, bDirNames, info2, useLocal, pURL, fetchEpisodes, pDlgProgress);
else if (info2->Content() == CONTENT_MOVIES)
ret = RetrieveInfoForMovie(pItem, bDirNames, info2, useLocal, pURL, pDlgProgress);
else if (info2->Content() == CONTENT_MUSICVIDEOS)
ret = RetrieveInfoForMusicVideo(pItem, bDirNames, info2, useLocal, pURL, pDlgProgress);
else
{
CLog::Log(LOGERROR, "VideoInfoScanner: Unknown content type %d (%s)", info2->Content(), pItem->GetPath().c_str());
FoundSomeInfo = false;
break;
}
if (ret == INFO_CANCELLED || ret == INFO_ERROR)
{
FoundSomeInfo = false;
break;
}
if (ret == INFO_ADDED || ret == INFO_HAVE_ALREADY)
FoundSomeInfo = true;
pURL = NULL;
// Keep track of directories we've seen
if (pItem->m_bIsFolder)
seenPaths.push_back(m_database.GetPathId(pItem->GetPath()));
}
if (content == CONTENT_TVSHOWS && ! seenPaths.empty())
{
vector<int> libPaths;
m_database.GetSubPaths(items.GetPath(), libPaths);
for (vector<int>::iterator i = libPaths.begin(); i < libPaths.end(); ++i)
{
if (find(seenPaths.begin(), seenPaths.end(), *i) == seenPaths.end())
m_pathsToClean.push_back(*i);
}
}
if(pDlgProgress)
pDlgProgress->ShowProgressBar(false);
g_infoManager.ResetLibraryBools();
m_database.Close();
return FoundSomeInfo;
}
INFO_RET CVideoInfoScanner::RetrieveInfoForTvShow(CFileItemPtr pItem, bool bDirNames, ScraperPtr &info2, bool useLocal, CScraperUrl* pURL, bool fetchEpisodes, CGUIDialogProgress* pDlgProgress)
{
long idTvShow = -1;
if (pItem->m_bIsFolder)
idTvShow = m_database.GetTvShowId(pItem->GetPath());
else
{
CStdString strPath;
URIUtils::GetDirectory(pItem->GetPath(),strPath);
idTvShow = m_database.GetTvShowId(strPath);
}
if (idTvShow > -1 && (fetchEpisodes || !pItem->m_bIsFolder))
{
INFO_RET ret = RetrieveInfoForEpisodes(pItem, idTvShow, info2, useLocal, pDlgProgress);
if (ret == INFO_ADDED)
m_database.SetPathHash(pItem->GetPath(), pItem->GetProperty("hash").asString());
return ret;
}
if (ProgressCancelled(pDlgProgress, pItem->m_bIsFolder ? 20353 : 20361, pItem->GetLabel()))
return INFO_CANCELLED;
CNfoFile::NFOResult result=CNfoFile::NO_NFO;
CScraperUrl scrUrl;
// handle .nfo files
if (useLocal)
result = CheckForNFOFile(pItem.get(), bDirNames, info2, scrUrl);
if (result != CNfoFile::NO_NFO && result != CNfoFile::ERROR_NFO)
{ // check for preconfigured scraper; if found, overwrite with interpreted scraper (from Nfofile)
// but keep current scan settings
SScanSettings settings;
if (m_database.GetScraperForPath(pItem->GetPath(), settings))
m_database.SetScraperForPath(pItem->GetPath(), info2, settings);
}
if (result == CNfoFile::FULL_NFO)
{
pItem->GetVideoInfoTag()->Reset();
m_nfoReader.GetDetails(*pItem->GetVideoInfoTag());
long lResult = AddVideo(pItem.get(), info2->Content(), bDirNames);
if (lResult < 0)
return INFO_ERROR;
GetArtwork(pItem.get(), info2->Content(), bDirNames, useLocal, pDlgProgress);
if (!fetchEpisodes && g_guiSettings.GetBool("videolibrary.seasonthumbs"))
FetchSeasonThumbs(lResult);
if (fetchEpisodes)
{
INFO_RET ret = RetrieveInfoForEpisodes(pItem, lResult, info2, useLocal, pDlgProgress);
if (ret == INFO_ADDED)
m_database.SetPathHash(pItem->GetPath(), pItem->GetProperty("hash").asString());
return ret;
}
return INFO_ADDED;
}
if (result == CNfoFile::URL_NFO || result == CNfoFile::COMBINED_NFO)
pURL = &scrUrl;
CScraperUrl url;
int retVal = 0;
if (pURL)
url = *pURL;
else if ((retVal = FindVideo(pItem->GetMovieName(bDirNames), info2, url, pDlgProgress)) <= 0)
return retVal < 0 ? INFO_CANCELLED : INFO_NOT_FOUND;
long lResult=-1;
if (GetDetails(pItem.get(), url, info2, result == CNfoFile::COMBINED_NFO ? &m_nfoReader : NULL, pDlgProgress))
{
if ((lResult = AddVideo(pItem.get(), info2->Content(), bDirNames)) < 0)
return INFO_ERROR;
GetArtwork(pItem.get(), info2->Content(), false, useLocal);
}
if (fetchEpisodes)
{
INFO_RET ret = RetrieveInfoForEpisodes(pItem, lResult, info2, useLocal, pDlgProgress);
if (ret == INFO_ADDED)
m_database.SetPathHash(pItem->GetPath(), pItem->GetProperty("hash").asString());
}
else
if (g_guiSettings.GetBool("videolibrary.seasonthumbs"))
FetchSeasonThumbs(lResult);
return INFO_ADDED;
}
INFO_RET CVideoInfoScanner::RetrieveInfoForMovie(CFileItemPtr pItem, bool bDirNames, ScraperPtr &info2, bool useLocal, CScraperUrl* pURL, CGUIDialogProgress* pDlgProgress)
{
if (pItem->m_bIsFolder || !pItem->IsVideo() || pItem->IsNFO() || pItem->IsPlayList())
return INFO_NOT_NEEDED;
if (ProgressCancelled(pDlgProgress, 198, pItem->GetLabel()))
return INFO_CANCELLED;
if (m_database.HasMovieInfo(pItem->GetPath()))
return INFO_HAVE_ALREADY;
CNfoFile::NFOResult result=CNfoFile::NO_NFO;
CScraperUrl scrUrl;
// handle .nfo files
if (useLocal)
result = CheckForNFOFile(pItem.get(), bDirNames, info2, scrUrl);
if (result == CNfoFile::FULL_NFO)
{
pItem->GetVideoInfoTag()->Reset();
m_nfoReader.GetDetails(*pItem->GetVideoInfoTag());
if (AddVideo(pItem.get(), info2->Content(), bDirNames) < 0)
return INFO_ERROR;
GetArtwork(pItem.get(), info2->Content(), bDirNames, true, pDlgProgress);
return INFO_ADDED;
}
if (result == CNfoFile::URL_NFO || result == CNfoFile::COMBINED_NFO)
pURL = &scrUrl;
CScraperUrl url;
int retVal = 0;
if (pURL)
url = *pURL;
else if ((retVal = FindVideo(pItem->GetMovieName(bDirNames), info2, url, pDlgProgress)) <= 0)
return retVal < 0 ? INFO_CANCELLED : INFO_NOT_FOUND;
if (GetDetails(pItem.get(), url, info2, result == CNfoFile::COMBINED_NFO ? &m_nfoReader : NULL, pDlgProgress))
{
if (AddVideo(pItem.get(), info2->Content(), bDirNames) < 0)
return INFO_ERROR;
GetArtwork(pItem.get(), info2->Content(), bDirNames, useLocal);
return INFO_ADDED;
}
// TODO: This is not strictly correct as we could fail to download information here or error, or be cancelled
return INFO_NOT_FOUND;
}
INFO_RET CVideoInfoScanner::RetrieveInfoForMusicVideo(CFileItemPtr pItem, bool bDirNames, ScraperPtr &info2, bool useLocal, CScraperUrl* pURL, CGUIDialogProgress* pDlgProgress)
{
if (pItem->m_bIsFolder || !pItem->IsVideo() || pItem->IsNFO() || pItem->IsPlayList())
return INFO_NOT_NEEDED;
if (ProgressCancelled(pDlgProgress, 20394, pItem->GetLabel()))
return INFO_CANCELLED;
if (m_database.HasMusicVideoInfo(pItem->GetPath()))
return INFO_HAVE_ALREADY;
CNfoFile::NFOResult result=CNfoFile::NO_NFO;
CScraperUrl scrUrl;
// handle .nfo files
if (useLocal)
result = CheckForNFOFile(pItem.get(), bDirNames, info2, scrUrl);
if (result == CNfoFile::FULL_NFO)
{
pItem->GetVideoInfoTag()->Reset();
m_nfoReader.GetDetails(*pItem->GetVideoInfoTag());
if (AddVideo(pItem.get(), info2->Content(), bDirNames) < 0)
return INFO_ERROR;
GetArtwork(pItem.get(), info2->Content(), bDirNames, true, pDlgProgress);
return INFO_ADDED;
}
if (result == CNfoFile::URL_NFO || result == CNfoFile::COMBINED_NFO)
pURL = &scrUrl;
CScraperUrl url;
int retVal = 0;
if (pURL)
url = *pURL;
else if ((retVal = FindVideo(pItem->GetMovieName(bDirNames), info2, url, pDlgProgress)) <= 0)
return retVal < 0 ? INFO_CANCELLED : INFO_NOT_FOUND;
if (GetDetails(pItem.get(), url, info2, result == CNfoFile::COMBINED_NFO ? &m_nfoReader : NULL, pDlgProgress))
{
if (AddVideo(pItem.get(), info2->Content(), bDirNames) < 0)
return INFO_ERROR;
GetArtwork(pItem.get(), info2->Content(), bDirNames, useLocal);
return INFO_ADDED;
}
// TODO: This is not strictly correct as we could fail to download information here or error, or be cancelled
return INFO_NOT_FOUND;
}
INFO_RET CVideoInfoScanner::RetrieveInfoForEpisodes(CFileItemPtr item, long showID, const ADDON::ScraperPtr &scraper, bool useLocal, CGUIDialogProgress *progress)
{
// enumerate episodes
EPISODES files;
EnumerateSeriesFolder(item.get(), files);
if (files.size() == 0) // no update or no files
return INFO_NOT_NEEDED;
if (m_bStop || (progress && progress->IsCanceled()))
return INFO_CANCELLED;
if (m_pObserver)
m_pObserver->OnDirectoryChanged(item->GetPath());
CStdString showTitle = m_database.GetTvShowTitleById(showID);
return OnProcessSeriesFolder(files, scraper, useLocal, showID, showTitle, progress);
}
void CVideoInfoScanner::EnumerateSeriesFolder(CFileItem* item, EPISODES& episodeList)
{
CFileItemList items;
if (item->m_bIsFolder)
{
CUtil::GetRecursiveListing(item->GetPath(), items, g_settings.m_videoExtensions, true);
CStdString hash, dbHash;
int numFilesInFolder = GetPathHash(items, hash);
if (m_database.GetPathHash(item->GetPath(), dbHash) && dbHash == hash)
{
m_currentItem += numFilesInFolder;
// notify our observer of our progress
if (m_pObserver)
{
if (m_itemCount>0)
{
m_pObserver->OnSetProgress(m_currentItem, m_itemCount);
m_pObserver->OnSetCurrentProgress(numFilesInFolder, numFilesInFolder);
}
m_pObserver->OnDirectoryScanned(item->GetPath());
}
return;
}
m_pathsToClean.push_back(m_database.GetPathId(item->GetPath()));
m_database.GetPathsForTvShow(m_database.GetTvShowId(item->GetPath()), m_pathsToClean);
item->SetProperty("hash", hash);
}
else
{
CFileItemPtr newItem(new CFileItem(*item));
items.Add(newItem);
}
/*
stack down any dvd folders
need to sort using the full path since this is a collapsed recursive listing of all subdirs
video_ts.ifo files should sort at the top of a dvd folder in ascending order
/foo/bar/video_ts.ifo
/foo/bar/vts_x_y.ifo
/foo/bar/vts_x_y.vob
*/
// since we're doing this now anyway, should other items be stacked?
items.Sort(SORT_METHOD_FULLPATH, SORT_ORDER_ASC);
int x = 0;
while (x < items.Size())
{
if (items[x]->m_bIsFolder)
continue;
CStdString strPathX, strFileX;
URIUtils::Split(items[x]->GetPath(), strPathX, strFileX);
//CLog::Log(LOGDEBUG,"%i:%s:%s", x, strPathX.c_str(), strFileX.c_str());
int y = x + 1;
if (strFileX.Equals("VIDEO_TS.IFO"))
{
while (y < items.Size())
{
CStdString strPathY, strFileY;
URIUtils::Split(items[y]->GetPath(), strPathY, strFileY);
//CLog::Log(LOGDEBUG," %i:%s:%s", y, strPathY.c_str(), strFileY.c_str());
if (strPathY.Equals(strPathX))
/*
remove everything sorted below the video_ts.ifo file in the same path.
understandbly this wont stack correctly if there are other files in the the dvd folder.
this should be unlikely and thus is being ignored for now but we can monitor the
where the path changes and potentially remove the items above the video_ts.ifo file.
*/
items.Remove(y);
else
break;
}
}
x = y;
}
// enumerate
CStdStringArray regexps = g_advancedSettings.m_tvshowExcludeFromScanRegExps;
for (int i=0;i<items.Size();++i)
{
if (items[i]->m_bIsFolder)
continue;
CStdString strPath;
URIUtils::GetDirectory(items[i]->GetPath(), strPath);
URIUtils::RemoveSlashAtEnd(strPath); // want no slash for the test that follows
if (URIUtils::GetFileName(strPath).Equals("sample"))
continue;
// Discard all exclude files defined by regExExcludes
if (CUtil::ExcludeFileOrFolder(items[i]->GetPath(), regexps))
continue;
/*
* Check if the media source has already set the season and episode or original air date in
* the VideoInfoTag. If it has, do not try to parse any of them from the file path to avoid
* any false positive matches.
*/
if (ProcessItemByVideoInfoTag(items[i], episodeList))
continue;
if (!EnumerateEpisodeItem(items[i], episodeList))
{
CStdString decode(items[i]->GetPath());
CURL::Decode(decode);
CLog::Log(LOGDEBUG, "VideoInfoScanner: Could not enumerate file %s", decode.c_str());
}
}
}
bool CVideoInfoScanner::ProcessItemByVideoInfoTag(const CFileItemPtr item, EPISODES &episodeList)
{
if (!item->HasVideoInfoTag())
return false;
CVideoInfoTag* tag = item->GetVideoInfoTag();
/*
* First check the season and episode number. This takes precedence over the original air
* date and episode title. Must be a valid season and episode number combination.
*/
if (tag->m_iSeason > -1 && tag->m_iEpisode > 0)
{
SEpisode episode;
episode.strPath = item->GetPath();
episode.iSeason = tag->m_iSeason;
episode.iEpisode = tag->m_iEpisode;
episode.isFolder = false;
episodeList.push_back(episode);
CLog::Log(LOGDEBUG, "%s - found match for: %s. Season %d, Episode %d", __FUNCTION__,
episode.strPath.c_str(), episode.iSeason, episode.iEpisode);
return true;
}
/*
* Next preference is the first aired date. If it exists use that for matching the TV Show
* information. Also set the title in case there are multiple matches for the first aired date.
*/
if (!tag->m_strFirstAired.IsEmpty())
{
SEpisode episode;
episode.strPath = item->GetPath();
episode.strTitle = tag->m_strTitle;
episode.isFolder = false;
/*
* Set season and episode to -1 to indicate to use the aired date.
*/
episode.iSeason = -1;
episode.iEpisode = -1;
/*
* The first aired date string must be parseable.
*/
episode.cDate.SetFromDateString(item->GetVideoInfoTag()->m_strFirstAired);
episodeList.push_back(episode);
CLog::Log(LOGDEBUG, "%s - found match for: '%s', firstAired: '%s' = '%s', title: '%s'",
__FUNCTION__, episode.strPath.c_str(), tag->m_strFirstAired.c_str(),
episode.cDate.GetAsLocalizedDate().c_str(), episode.strTitle.c_str());
return true;
}
/*
* Next preference is the episode title. If it exists use that for matching the TV Show
* information.
*/
if (!tag->m_strTitle.IsEmpty())
{
SEpisode episode;
episode.strPath = item->GetPath();
episode.strTitle = tag->m_strTitle;
episode.isFolder = false;
/*
* Set season and episode to -1 to indicate to use the title.
*/
episode.iSeason = -1;
episode.iEpisode = -1;
episodeList.push_back(episode);
CLog::Log(LOGDEBUG,"%s - found match for: '%s', title: '%s'", __FUNCTION__,
episode.strPath.c_str(), episode.strTitle.c_str());
return true;
}
/*
* There is no further episode information available if both the season and episode number have
* been set to 0. Return the match as true so no further matching is attempted, but don't add it
* to the episode list.
*/
if (tag->m_iSeason == 0 && tag->m_iEpisode == 0)
{
CLog::Log(LOGDEBUG,"%s - found exclusion match for: %s. Both Season and Episode are 0. Item will be ignored for scanning.",
__FUNCTION__, item->GetPath().c_str());
return true;
}
return false;
}
bool CVideoInfoScanner::EnumerateEpisodeItem(const CFileItemPtr item, EPISODES& episodeList)
{
SETTINGS_TVSHOWLIST expression = g_advancedSettings.m_tvshowEnumRegExps;
CStdString strLabel=item->GetPath();
// URLDecode in case an episode is on a http/https/dav/davs:// source and URL-encoded like foo%201x01%20bar.avi
CURL::Decode(strLabel);
strLabel.MakeLower();
for (unsigned int i=0;i<expression.size();++i)
{
CRegExp reg;
if (!reg.RegComp(expression[i].regexp))
continue;
int regexppos, regexp2pos;
//CLog::Log(LOGDEBUG,"running expression %s on %s",expression[i].regexp.c_str(),strLabel.c_str());
if ((regexppos = reg.RegFind(strLabel.c_str())) < 0)
continue;
SEpisode episode;
episode.strPath = item->GetPath();
episode.iSeason = -1;
episode.iEpisode = -1;
episode.cDate.SetValid(false);
episode.isFolder = false;
bool byDate = expression[i].byDate ? true : false;
if (byDate)
{
if (!GetAirDateFromRegExp(reg, episode))
continue;
CLog::Log(LOGDEBUG, "VideoInfoScanner: Found date based match %s (%s) [%s]", strLabel.c_str(),
episode.cDate.GetAsLocalizedDate().c_str(), expression[i].regexp.c_str());
}
else
{
if (!GetEpisodeAndSeasonFromRegExp(reg, episode))
continue;
CLog::Log(LOGDEBUG, "VideoInfoScanner: Found episode match %s (s%ie%i) [%s]", strLabel.c_str(),
episode.iSeason, episode.iEpisode, expression[i].regexp.c_str());
}
// Grab the remainder from first regexp run
// as second run might modify or empty it.
char *remainder = reg.GetReplaceString("\\3");
/*
* Check if the files base path is a dedicated folder that contains
* only this single episode. If season and episode match with the
* actual media file, we set episode.isFolder to true.
*/
CStdString strBasePath = item->GetBaseMoviePath(true);
URIUtils::RemoveSlashAtEnd(strBasePath);
strBasePath = URIUtils::GetFileName(strBasePath);
if (reg.RegFind(strBasePath.c_str()) > -1)
{
SEpisode parent;
if (byDate)
{
GetAirDateFromRegExp(reg, parent);
if (episode.cDate == parent.cDate)
episode.isFolder = true;
}
else
{
GetEpisodeAndSeasonFromRegExp(reg, parent);
if (episode.iSeason == parent.iSeason && episode.iEpisode == parent.iEpisode)
episode.isFolder = true;
}
}
// add what we found by now
episodeList.push_back(episode);
CRegExp reg2;
// check the remainder of the string for any further episodes.
if (!byDate && reg2.RegComp(g_advancedSettings.m_tvshowMultiPartEnumRegExp))
{
int offset = 0;
// we want "long circuit" OR below so that both offsets are evaluated
while (((regexp2pos = reg2.RegFind(remainder + offset)) > -1) | ((regexppos = reg.RegFind(remainder + offset)) > -1))
{
if (((regexppos <= regexp2pos) && regexppos != -1) ||
(regexppos >= 0 && regexp2pos == -1))
{
GetEpisodeAndSeasonFromRegExp(reg, episode);
CLog::Log(LOGDEBUG, "VideoInfoScanner: Adding new season %u, multipart episode %u [%s]",
episode.iSeason, episode.iEpisode,
g_advancedSettings.m_tvshowMultiPartEnumRegExp.c_str());
episodeList.push_back(episode);
free(remainder);
remainder = reg.GetReplaceString("\\3");
offset = 0;
}
else if (((regexp2pos < regexppos) && regexp2pos != -1) ||
(regexp2pos >= 0 && regexppos == -1))
{
char *ep = reg2.GetReplaceString("\\1");
episode.iEpisode = atoi(ep);
free(ep);
CLog::Log(LOGDEBUG, "VideoInfoScanner: Adding multipart episode %u [%s]",
episode.iEpisode, g_advancedSettings.m_tvshowMultiPartEnumRegExp.c_str());
episodeList.push_back(episode);
offset += regexp2pos + reg2.GetFindLen();
}
}
free(remainder);
}
return true;
}
return false;
}
bool CVideoInfoScanner::GetEpisodeAndSeasonFromRegExp(CRegExp ®, SEpisode &episodeInfo)
{
char* season = reg.GetReplaceString("\\1");
char* episode = reg.GetReplaceString("\\2");
if (season && episode)
{
if (strlen(season) == 0 && strlen(episode) > 0)
{ // no season specified -> assume season 1
episodeInfo.iSeason = 1;
if ((episodeInfo.iEpisode = CUtil::TranslateRomanNumeral(episode)) == -1)
episodeInfo.iEpisode = atoi(episode);
}
else if (strlen(season) > 0 && strlen(episode) == 0)
{ // no episode specification -> assume season 1
episodeInfo.iSeason = 1;
if ((episodeInfo.iEpisode = CUtil::TranslateRomanNumeral(season)) == -1)
episodeInfo.iEpisode = atoi(season);
}
else
{ // season and episode specified
episodeInfo.iSeason = atoi(season);
episodeInfo.iEpisode = atoi(episode);
}
}
free(season);
free(episode);
return (season && episode);
}
bool CVideoInfoScanner::GetAirDateFromRegExp(CRegExp ®, SEpisode &episodeInfo)
{
char* param1 = reg.GetReplaceString("\\1");
char* param2 = reg.GetReplaceString("\\2");
char* param3 = reg.GetReplaceString("\\3");
if (param1 && param2 && param3)
{
// regular expression by date
int len1 = strlen( param1 );
int len2 = strlen( param2 );
int len3 = strlen( param3 );
if (len1==4 && len2==2 && len3==2)
{
// yyyy mm dd format
episodeInfo.cDate.SetDate(atoi(param1), atoi(param2), atoi(param3));
}
else if (len1==2 && len2==2 && len3==4)
{
// mm dd yyyy format