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 "FileItem.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);
  63         if (m_headPos == std::string::npos)
  64           break;
  65
  66         bNfo  = GetDetails(details);
  67         infos++;
  68         m_headPos++;
  69       }
  70       if (details.m_iEpisode != episode)
  71       {
  72         bNfo = false;
  73         details.Reset();
  74         m_headPos = 0;
  75         if (infos == 1) // still allow differing nfo/file numbers for single ep nfo's
  76           bNfo = GetDetails(details);
  77       }
  78     }
  79   }
  80
  81   std::vector<ScraperPtr> vecScrapers = GetScrapers(m_type, m_info);
  82
  83   // search ..
  84   int res = -1;
  85   for (unsigned int i=0; i<vecScrapers.size(); ++i)
  86     if ((res = Scrape(vecScrapers[i], m_scurl, m_doc)) == 0 || res == 2)
  87       break;
  88
  89   if (res == 2)
  90     return CInfoScanner::ERROR_NFO;
  91   if (bNfo)
  92   {
  93     if (!m_scurl.HasUrls())
  94     {
  95       if (m_doc.find("[scrape url]") != std::string::npos)
  96         return CInfoScanner::OVERRIDE_NFO;
  97       else
  98         return CInfoScanner::FULL_NFO;
  99     }
 100     else
 101       return CInfoScanner::COMBINED_NFO;
 102   }
 103   return m_scurl.HasUrls() ? CInfoScanner::URL_NFO : CInfoScanner::NO_NFO;
 104 }
 105
 106 // return value: 0 - success; 1 - no result; skip; 2 - error
 107 int CNfoFile::Scrape(ScraperPtr& scraper, CScraperUrl& url,
 108                      const std::string& content)
 109 {
 110   if (scraper->IsNoop())
 111   {
 112     url = CScraperUrl();
 113     return 0;
 114   }
 115
 116   scraper->ClearCache();
 117
 118   try
 119   {
 120     url = scraper->NfoUrl(content);
 121   }
 122   catch (const CScraperError &sce)
 123   {
 124     CVideoInfoDownloader::ShowErrorDialog(sce);
 125     if (!sce.FAborted())
 126       return 2;
 127   }
 128
 129   return url.HasUrls() ? 0 : 1;
 130 }
 131
 132 int CNfoFile::Load(const std::string& strFile)
 133 {
 134   Close();
 135   XFILE::CFile file;
 136   std::vector<uint8_t> buf;
 137   if (file.LoadFile(strFile, buf) > 0)
 138   {
 139     m_doc.assign(reinterpret_cast<char*>(buf.data()), buf.size());
 140     m_headPos = 0;
 141     return 0;
 142   }
 143   m_doc.clear();
 144   return 1;
 145 }
 146
 147 void CNfoFile::Close()
 148 {
 149   m_doc.clear();
 150   m_headPos = 0;
 151   m_scurl.Clear();
 152 }
 153
 154 std::vector<ScraperPtr> CNfoFile::GetScrapers(AddonType type, const ScraperPtr& selectedScraper)
 155 {
 156   AddonPtr addon;
 157   ScraperPtr defaultScraper;
 158   if (CAddonSystemSettings::GetInstance().GetActive(type, addon))
 159     defaultScraper = std::dynamic_pointer_cast<CScraper>(addon);
 160
 161   std::vector<ScraperPtr> vecScrapers;
 162
 163   // add selected scraper - first priority
 164   if (selectedScraper)
 165     vecScrapers.push_back(selectedScraper);
 166
 167   // Add all scrapers except selected and default
 168   VECADDONS addons;
 169   CServiceBroker::GetAddonMgr().GetAddons(addons, type);
 170
 171   for (auto& addon : addons)
 172   {
 173     ScraperPtr scraper = std::dynamic_pointer_cast<CScraper>(addon);
 174
 175     // skip if scraper requires settings and there's nothing set yet
 176     if (scraper->RequiresSettings() && !scraper->HasUserSettings())
 177       continue;
 178
 179     if ((!selectedScraper || selectedScraper->ID() != scraper->ID()) &&
 180          (!defaultScraper || defaultScraper->ID() != scraper->ID()))
 181       vecScrapers.push_back(scraper);
 182   }
 183
 184   // add default scraper - not user selectable so it's last priority
 185   if (defaultScraper && (!selectedScraper ||
 186                           selectedScraper->ID() != defaultScraper->ID()) &&
 187       (!defaultScraper->RequiresSettings() || defaultScraper->HasUserSettings()))
 188     vecScrapers.push_back(defaultScraper);
 189
 190   return vecScrapers;
 191 }