xbmc/video/VideoInfoDownloader.cpp

   1 /*
   2  *  Copyright (C) 2005-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #include "VideoInfoDownloader.h"
  10
  11 #include "dialogs/GUIDialogProgress.h"
  12 #include "filesystem/CurlFile.h"
  13 #include "messaging/helpers/DialogOKHelper.h"
  14 #include "utils/Variant.h"
  15 #include "utils/log.h"
  16
  17 using namespace VIDEO;
  18 using namespace KODI::MESSAGING;
  19 using namespace std::chrono_literals;
  20
  21 #ifndef __GNUC__
  22 #pragma warning (disable:4018)
  23 #endif
  24
  25 CVideoInfoDownloader::CVideoInfoDownloader(const ADDON::ScraperPtr &scraper) :
  26   CThread("VideoInfoDownloader"), m_state(DO_NOTHING), m_found(0), m_info(scraper)
  27 {
  28   m_http = new XFILE::CCurlFile;
  29 }
  30
  31 CVideoInfoDownloader::~CVideoInfoDownloader()
  32 {
  33   delete m_http;
  34 }
  35
  36 // return value: 0 = we failed, -1 = we failed and reported an error, 1 = success
  37 int CVideoInfoDownloader::InternalFindMovie(const std::string &movieTitle, int movieYear,
  38                                             MOVIELIST& movielist,
  39                                             bool cleanChars /* = true */)
  40 {
  41   try
  42   {
  43     movielist = m_info->FindMovie(*m_http, movieTitle, movieYear, cleanChars);
  44   }
  45   catch (const ADDON::CScraperError &sce)
  46   {
  47     ShowErrorDialog(sce);
  48     return sce.FAborted() ? 0 : -1;
  49   }
  50   return 1;  // success
  51 }
  52
  53 void CVideoInfoDownloader::ShowErrorDialog(const ADDON::CScraperError &sce)
  54 {
  55   if (!sce.Title().empty())
  56     HELPERS::ShowOKDialogText(CVariant{ sce.Title() }, CVariant{ sce.Message() });
  57 }
  58
  59 // threaded functions
  60 void CVideoInfoDownloader::Process()
  61 {
  62   // note here that we're calling our external functions but we're calling them with
  63   // no progress bar set, so they're effectively calling our internal functions directly.
  64   m_found = 0;
  65   if (m_state == FIND_MOVIE)
  66   {
  67     if (!(m_found=FindMovie(m_movieTitle, m_movieYear, m_movieList)))
  68       CLog::Log(LOGERROR, "{}: Error looking up item {} ({})", __FUNCTION__, m_movieTitle,
  69                 m_movieYear);
  70     m_state = DO_NOTHING;
  71     return;
  72   }
  73
  74   if (!m_url.HasUrls())
  75   {
  76     // empty url when it's not supposed to be..
  77     // this might happen if the previously scraped item was removed from the site (see ticket #10537)
  78     CLog::Log(LOGERROR, "{}: Error getting details for {} ({}) due to an empty url", __FUNCTION__,
  79               m_movieTitle, m_movieYear);
  80   }
  81   else if (m_state == GET_DETAILS)
  82   {
  83     if (!GetDetails(m_url, m_movieDetails))
  84       CLog::Log(LOGERROR, "{}: Error getting details from {}", __FUNCTION__,
  85                 m_url.GetFirstThumbUrl());
  86   }
  87   else if (m_state == GET_EPISODE_DETAILS)
  88   {
  89     if (!GetEpisodeDetails(m_url, m_movieDetails))
  90       CLog::Log(LOGERROR, "{}: Error getting episode details from {}", __FUNCTION__,
  91                 m_url.GetFirstThumbUrl());
  92   }
  93   else if (m_state == GET_EPISODE_LIST)
  94   {
  95     if (!GetEpisodeList(m_url, m_episode))
  96       CLog::Log(LOGERROR, "{}: Error getting episode list from {}", __FUNCTION__,
  97                 m_url.GetFirstThumbUrl());
  98   }
  99   m_found = 1;
 100   m_state = DO_NOTHING;
 101 }
 102
 103 int CVideoInfoDownloader::FindMovie(const std::string &movieTitle, int movieYear,
 104                                     MOVIELIST& movieList,
 105                                     CGUIDialogProgress *pProgress /* = NULL */)
 106 {
 107   //CLog::Log(LOGDEBUG,"CVideoInfoDownloader::FindMovie({})", strMovie);
 108
 109   if (pProgress)
 110   { // threaded version
 111     m_state = FIND_MOVIE;
 112     m_movieTitle = movieTitle;
 113     m_movieYear = movieYear;
 114     m_found = 0;
 115     if (IsRunning())
 116       StopThread();
 117     Create();
 118     while (m_state != DO_NOTHING)
 119     {
 120       pProgress->Progress();
 121       if (pProgress->IsCanceled())
 122       {
 123         CloseThread();
 124         return 0;
 125       }
 126       CThread::Sleep(1ms);
 127     }
 128     // transfer to our movielist
 129     m_movieList.swap(movieList);
 130     int found=m_found;
 131     CloseThread();
 132     return found;
 133   }
 134
 135   // unthreaded
 136   int success = InternalFindMovie(movieTitle, movieYear, movieList);
 137   // NOTE: this might be improved by rescraping if the match quality isn't high?
 138   if (success == 1 && movieList.empty())
 139   { // no results. try without cleaning chars like '.' and '_'
 140     success = InternalFindMovie(movieTitle, movieYear, movieList, false);
 141   }
 142   return success;
 143 }
 144
 145 bool CVideoInfoDownloader::GetArtwork(CVideoInfoTag &details)
 146 {
 147   return m_info->GetArtwork(*m_http, details);
 148 }
 149
 150 bool CVideoInfoDownloader::GetDetails(const CScraperUrl &url,
 151                                       CVideoInfoTag &movieDetails,
 152                                       CGUIDialogProgress *pProgress /* = NULL */)
 153 {
 154   //CLog::Log(LOGDEBUG,"CVideoInfoDownloader::GetDetails({})", url.m_strURL);
 155   m_url = url;
 156   m_movieDetails = movieDetails;
 157
 158   // fill in the defaults
 159   movieDetails.Reset();
 160   if (pProgress)
 161   { // threaded version
 162     m_state = GET_DETAILS;
 163     m_found = 0;
 164     if (IsRunning())
 165       StopThread();
 166     Create();
 167     while (!m_found)
 168     {
 169       pProgress->Progress();
 170       if (pProgress->IsCanceled())
 171       {
 172         CloseThread();
 173         return false;
 174       }
 175       CThread::Sleep(1ms);
 176     }
 177     movieDetails = m_movieDetails;
 178     CloseThread();
 179     return true;
 180   }
 181   else  // unthreaded
 182     return m_info->GetVideoDetails(*m_http, url, true/*fMovie*/, movieDetails);
 183 }
 184
 185 bool CVideoInfoDownloader::GetEpisodeDetails(const CScraperUrl &url,
 186                                              CVideoInfoTag &movieDetails,
 187                                              CGUIDialogProgress *pProgress /* = NULL */)
 188 {
 189   //CLog::Log(LOGDEBUG,"CVideoInfoDownloader::GetDetails({})", url.m_strURL);
 190   m_url = url;
 191   m_movieDetails = movieDetails;
 192
 193   // fill in the defaults
 194   movieDetails.Reset();
 195   if (pProgress)
 196   { // threaded version
 197     m_state = GET_EPISODE_DETAILS;
 198     m_found = 0;
 199     if (IsRunning())
 200       StopThread();
 201     Create();
 202     while (!m_found)
 203     {
 204       pProgress->Progress();
 205       if (pProgress->IsCanceled())
 206       {
 207         CloseThread();
 208         return false;
 209       }
 210       CThread::Sleep(1ms);
 211     }
 212     movieDetails = m_movieDetails;
 213     CloseThread();
 214     return true;
 215   }
 216   else  // unthreaded
 217     return m_info->GetVideoDetails(*m_http, url, false/*fMovie*/, movieDetails);
 218 }
 219
 220 bool CVideoInfoDownloader::GetEpisodeList(const CScraperUrl& url,
 221                                           EPISODELIST& movieDetails,
 222                                           CGUIDialogProgress *pProgress /* = NULL */)
 223 {
 224   //CLog::Log(LOGDEBUG,"CVideoInfoDownloader::GetDetails({})", url.m_strURL);
 225   m_url = url;
 226   m_episode = movieDetails;
 227
 228   // fill in the defaults
 229   movieDetails.clear();
 230   if (pProgress)
 231   { // threaded version
 232     m_state = GET_EPISODE_LIST;
 233     m_found = 0;
 234     if (IsRunning())
 235       StopThread();
 236     Create();
 237     while (!m_found)
 238     {
 239       pProgress->Progress();
 240       if (pProgress->IsCanceled())
 241       {
 242         CloseThread();
 243         return false;
 244       }
 245       CThread::Sleep(1ms);
 246     }
 247     movieDetails = m_episode;
 248     CloseThread();
 249     return true;
 250   }
 251   else  // unthreaded
 252     return !(movieDetails = m_info->GetEpisodeList(*m_http, url)).empty();
 253 }
 254
 255 void CVideoInfoDownloader::CloseThread()
 256 {
 257   m_http->Cancel();
 258   StopThread();
 259   m_http->Reset();
 260   m_state = DO_NOTHING;
 261   m_found = 0;
 262 }
 263