xbmc/NfoFile.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 // NfoFile.cpp: implementation of the CNfoFile class.
   9 //
  10 //////////////////////////////////////////////////////////////////////
  11
  12 #include "NfoFile.h"
  13
  14 #include "FileItemList.h"
  15 #include "ServiceBroker.h"
  16 #include "addons/AddonManager.h"
  17 #include "addons/AddonSystemSettings.h"
  18 #include "addons/addoninfo/AddonType.h"
  19 #include "filesystem/File.h"
  20 #include "music/Album.h"
  21 #include "music/Artist.h"
  22 #include "video/VideoInfoDownloader.h"
  23
  24 #include <string>
  25 #include <vector>
  26
  27 using namespace XFILE;
  28 using namespace ADDON;
  29
  30 CInfoScanner::INFO_TYPE CNfoFile::Create(const std::string& strPath,
  31                                          const ScraperPtr& info, int episode)
  32 {
  33   m_info = info; // assume we can use these settings
  34   m_type = ScraperTypeFromContent(info->Content());
  35   if (Load(strPath) != 0)
  36     return CInfoScanner::NO_NFO;
  37
  38   CFileItemList items;
  39   bool bNfo=false;
  40
  41   if (m_type == AddonType::SCRAPER_ALBUMS)
  42   {
  43     CAlbum album;
  44     bNfo = GetDetails(album);
  45   }
  46   else if (m_type == AddonType::SCRAPER_ARTISTS)
  47   {
  48     CArtist artist;
  49     bNfo = GetDetails(artist);
  50   }
  51   else if (m_type == AddonType::SCRAPER_TVSHOWS || m_type == AddonType::SCRAPER_MOVIES ||
  52            m_type == AddonType::SCRAPER_MUSICVIDEOS)
  53   {
  54     // first check if it's an XML file with the info we need
  55     CVideoInfoTag details;
  56     bNfo = GetDetails(details);
  57     if (episode > -1 && bNfo && m_type == AddonType::SCRAPER_TVSHOWS)
  58     {
  59       int infos=0;
  60       while (m_headPos != std::string::npos && details.m_iEpisode != episode)
  61       {
  62         m_headPos = m_doc.find("<episodedetails", m_headPos + 1);
  63         if (m_headPos == std::string::npos)
  64           break;
  65
  66         bNfo  = GetDetails(details);
  67         infos++;
  68       }
  69       if (details.m_iEpisode != episode)
  70       {
  71         bNfo = false;
  72         details.Reset();
  73         m_headPos = 0;
  74         if (infos == 1) // still allow differing nfo/file numbers for single ep nfo's
  75           bNfo = GetDetails(details);
  76       }
  77     }
  78   }
  79
  80   std::vector<ScraperPtr> vecScrapers = GetScrapers(m_type, m_info);
  81
  82   // search ..
  83   int res = -1;
  84   for (unsigned int i=0; i<vecScrapers.size(); ++i)
  85     if ((res = Scrape(vecScrapers[i], m_scurl, m_doc)) == 0 || res == 2)
  86       break;
  87
  88   if (res == 2)
  89     return CInfoScanner::ERROR_NFO;
  90   if (bNfo)
  91   {
  92     if (!m_scurl.HasUrls())
  93     {
  94       if (m_doc.find("[scrape url]") != std::string::npos)
  95         return CInfoScanner::OVERRIDE_NFO;
  96       else
  97         return CInfoScanner::FULL_NFO;
  98     }
  99     else
 100       return CInfoScanner::COMBINED_NFO;
 101   }
 102   return m_scurl.HasUrls() ? CInfoScanner::URL_NFO : CInfoScanner::NO_NFO;
 103 }
 104
 105 // return value: 0 - success; 1 - no result; skip; 2 - error
 106 int CNfoFile::Scrape(ScraperPtr& scraper, CScraperUrl& url,
 107                      const std::string& content)
 108 {
 109   if (scraper->IsNoop())
 110   {
 111     url = CScraperUrl();
 112     return 0;
 113   }
 114
 115   scraper->ClearCache();
 116
 117   try
 118   {
 119     url = scraper->NfoUrl(content);
 120   }
 121   catch (const CScraperError &sce)
 122   {
 123     CVideoInfoDownloader::ShowErrorDialog(sce);
 124     if (!sce.FAborted())
 125       return 2;
 126   }
 127
 128   return url.HasUrls() ? 0 : 1;
 129 }
 130
 131 int CNfoFile::Load(const std::string& strFile)
 132 {
 133   Close();
 134   XFILE::CFile file;
 135   std::vector<uint8_t> buf;
 136   if (file.LoadFile(strFile, buf) > 0)
 137   {
 138     m_doc.assign(reinterpret_cast<char*>(buf.data()), buf.size());
 139     m_headPos = 0;
 140     return 0;
 141   }
 142   m_doc.clear();
 143   return 1;
 144 }
 145
 146 void CNfoFile::Close()
 147 {
 148   m_doc.clear();
 149   m_headPos = 0;
 150   m_scurl.Clear();
 151 }
 152
 153 std::vector<ScraperPtr> CNfoFile::GetScrapers(AddonType type, const ScraperPtr& selectedScraper)
 154 {
 155   AddonPtr addon;
 156   ScraperPtr defaultScraper;
 157   if (CAddonSystemSettings::GetInstance().GetActive(type, addon))
 158     defaultScraper = std::dynamic_pointer_cast<CScraper>(addon);
 159
 160   std::vector<ScraperPtr> vecScrapers;
 161
 162   // add selected scraper - first priority
 163   if (selectedScraper)
 164     vecScrapers.push_back(selectedScraper);
 165
 166   // Add all scrapers except selected and default
 167   VECADDONS addons;
 168   CServiceBroker::GetAddonMgr().GetAddons(addons, type);
 169
 170   for (auto& addon : addons)
 171   {
 172     ScraperPtr scraper = std::dynamic_pointer_cast<CScraper>(addon);
 173
 174     // skip if scraper requires settings and there's nothing set yet
 175     if (scraper->RequiresSettings() && !scraper->HasUserSettings())
 176       continue;
 177
 178     if ((!selectedScraper || selectedScraper->ID() != scraper->ID()) &&
 179          (!defaultScraper || defaultScraper->ID() != scraper->ID()))
 180       vecScrapers.push_back(scraper);
 181   }
 182
 183   // add default scraper - not user selectable so it's last priority
 184   if (defaultScraper && (!selectedScraper ||
 185                           selectedScraper->ID() != defaultScraper->ID()) &&
 186       (!defaultScraper->RequiresSettings() || defaultScraper->HasUserSettings()))
 187     vecScrapers.push_back(defaultScraper);
 188
 189   return vecScrapers;
 190 }