xbmc/playlists/PlayListASX.cpp

   1 /*
   2  *  Copyright (C) 2024 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 "PlayListASX.h"
  10
  11 #include "FileItem.h"
  12 #include "PlayListFactory.h"
  13 #include "filesystem/File.h"
  14 #include "utils/StringUtils.h"
  15 #include "utils/XBMCTinyXML2.h"
  16 #include "utils/XMLUtils.h"
  17 #include "utils/log.h"
  18 #include "video/VideoFileItemClassify.h"
  19 #include "video/VideoInfoTag.h"
  20
  21 #include <iostream>
  22 #include <string>
  23
  24 #include <tinyxml2.h>
  25
  26 using namespace XFILE;
  27
  28 namespace KODI::PLAYLIST
  29 {
  30
  31 bool CPlayListASX::LoadAsxIniInfo(std::istream& stream)
  32 {
  33   CLog::Log(LOGINFO, "Parsing INI style ASX");
  34
  35   std::string name, value;
  36
  37   while (stream.good())
  38   {
  39     // consume blank rows, and blanks
  40     while ((stream.peek() == '\r' || stream.peek() == '\n' || stream.peek() == ' ') &&
  41            stream.good())
  42       stream.get();
  43
  44     if (stream.peek() == '[')
  45     {
  46       // this is an [section] part, just ignore it
  47       while (stream.good() && stream.peek() != '\r' && stream.peek() != '\n')
  48         stream.get();
  49       continue;
  50     }
  51     name = "";
  52     value = "";
  53     // consume name
  54     while (stream.peek() != '\r' && stream.peek() != '\n' && stream.peek() != '=' && stream.good())
  55       name += stream.get();
  56
  57     // consume =
  58     if (stream.get() != '=')
  59       continue;
  60
  61     // consume value
  62     while (stream.peek() != '\r' && stream.peek() != '\n' && stream.good())
  63       value += stream.get();
  64
  65     CLog::Log(LOGINFO, "Adding element {}={}", name, value);
  66     CFileItemPtr newItem(new CFileItem(value));
  67     newItem->SetPath(value);
  68     if (VIDEO::IsVideo(*newItem) &&
  69         !newItem->HasVideoInfoTag()) // File is a video and needs a VideoInfoTag
  70       newItem->GetVideoInfoTag()->Reset(); // Force VideoInfoTag creation
  71     Add(newItem);
  72   }
  73
  74   return true;
  75 }
  76
  77 bool CPlayListASX::LoadData(std::istream& stream)
  78 {
  79   CLog::Log(LOGINFO, "Parsing ASX");
  80
  81   if (stream.peek() == '[')
  82   {
  83     return LoadAsxIniInfo(stream);
  84   }
  85   else
  86   {
  87     std::string asxStream(std::istreambuf_iterator<char>(stream), {});
  88
  89     CXBMCTinyXML2 xmlDoc;
  90     xmlDoc.Parse(asxStream);
  91
  92     if (xmlDoc.Error())
  93     {
  94       CLog::Log(LOGERROR, "Unable to parse ASX info Error: {}", xmlDoc.ErrorStr());
  95       return false;
  96     }
  97
  98     auto* srcRootElement = xmlDoc.RootElement();
  99
 100     if (!srcRootElement)
 101       return false;
 102
 103     // lowercase every element - copy to second  temp doc
 104     tinyxml2::XMLDocument targetDoc;
 105     std::string value = srcRootElement->Value();
 106
 107     StringUtils::ToLower(value);
 108     auto targetRootElement = targetDoc.NewElement(value.c_str());
 109
 110     auto* rootAttrib = srcRootElement->ToElement()->FirstAttribute();
 111     while (rootAttrib)
 112     {
 113       std::string attribName = rootAttrib->Name();
 114       auto attribValue = rootAttrib->Value();
 115       StringUtils::ToLower(attribName);
 116       targetRootElement->SetAttribute(attribName.c_str(), attribValue);
 117       rootAttrib = rootAttrib->Next();
 118     }
 119
 120     auto* sourceNode = srcRootElement->FirstChild();
 121     while (sourceNode)
 122     {
 123       // Function to check all child elements and lowercase the elem/attrib names
 124       recurseLowercaseNames(*targetRootElement, sourceNode);
 125
 126       sourceNode = sourceNode->NextSiblingElement();
 127     }
 128
 129     targetDoc.InsertFirstChild(targetRootElement);
 130
 131     // now data is lowercased, we can parse contents
 132     std::string roottitle;
 133     auto* element = targetDoc.RootElement()->FirstChildElement();
 134     while (element)
 135     {
 136       value = element->Value();
 137       if (value == "title" && !element->NoChildren())
 138       {
 139         roottitle = element->FirstChild()->Value();
 140       }
 141       else if (value == "entry")
 142       {
 143         std::string title(roottitle);
 144
 145         auto* refElement = element->FirstChildElement("ref");
 146         auto* titleElement = element->FirstChildElement("title");
 147
 148         if (titleElement && !titleElement->NoChildren())
 149           title = titleElement->FirstChild()->Value();
 150
 151         while (refElement)
 152         { // multiple references may appear for one entry
 153           // duration may exist on this level too
 154           value = XMLUtils::GetAttribute(refElement, "href");
 155           if (!value.empty())
 156           {
 157             if (title.empty())
 158               title = value;
 159
 160             CLog::Log(LOGINFO, "Adding element {}, {}", title, value);
 161             CFileItemPtr newItem(new CFileItem(title));
 162             newItem->SetPath(value);
 163             Add(newItem);
 164           }
 165           refElement = refElement->NextSiblingElement("ref");
 166         }
 167       }
 168       else if (value == "entryref")
 169       {
 170         value = XMLUtils::GetAttribute(element, "href");
 171         if (!value.empty())
 172         { // found an entryref, let's try loading that url
 173           std::unique_ptr<CPlayList> playlist(CPlayListFactory::Create(value));
 174           if (nullptr != playlist)
 175             if (playlist->Load(value))
 176               Add(*playlist);
 177         }
 178       }
 179       element = element->NextSiblingElement();
 180     }
 181   }
 182
 183   return true;
 184 }
 185
 186 void CPlayListASX::recurseLowercaseNames(tinyxml2::XMLNode& targetNode,
 187                                          tinyxml2::XMLNode* sourceNode)
 188 {
 189   if (sourceNode->ToElement())
 190   {
 191     std::string strNodeValue = sourceNode->Value();
 192     StringUtils::ToLower(strNodeValue);
 193     auto* targetElement = targetNode.GetDocument()->NewElement(strNodeValue.c_str());
 194
 195     auto* attrib = sourceNode->ToElement()->FirstAttribute();
 196     while (attrib)
 197     {
 198       std::string attribName = attrib->Name();
 199       auto attribValue = attrib->Value();
 200       StringUtils::ToLower(attribName);
 201       targetElement->SetAttribute(attribName.c_str(), attribValue);
 202       attrib = attrib->Next();
 203     }
 204
 205     if (!sourceNode->NoChildren())
 206     {
 207       for (auto* child = sourceNode->FirstChild(); child != nullptr; child = child->NextSibling())
 208       {
 209         recurseLowercaseNames(*targetElement, child);
 210       }
 211     }
 212
 213     targetNode.InsertEndChild(targetElement);
 214     return;
 215   }
 216   else if (sourceNode->ToText())
 217   {
 218     auto* sourceTextElement = sourceNode->ToText();
 219     auto* sourceText = sourceTextElement->Value();
 220     auto* targetText = targetNode.GetDocument()->NewText(sourceText);
 221
 222     if (!sourceNode->NoChildren())
 223     {
 224       for (auto* child = sourceNode->FirstChildElement(); child != nullptr;
 225            child = child->NextSiblingElement())
 226       {
 227         recurseLowercaseNames(*targetText, child);
 228       }
 229     }
 230
 231     targetNode.InsertEndChild(targetText);
 232     return;
 233   }
 234 }
 235
 236 } // namespace KODI::PLAYLIST