XBMC4Xbox/xbmc/PluginSettings.cpp

/*
 *      Copyright (C) 2005-2013 Team XBMC
 *      http://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, see
 *  <http://www.gnu.org/licenses/>.
 *
 */
#include "PluginSettings.h"
#include "utils/URIUtils.h"
#include "FileSystem/File.h"
#include "FileSystem/Directory.h"
#include "utils/log.h"


CBasicSettings::CBasicSettings()
{
}

CBasicSettings::~CBasicSettings()
{
}

bool CBasicSettings::SaveFromDefault(void)
{
  if (!GetPluginRoot()) //if scraper has no settings return false
    return false;

  TiXmlElement *setting = GetPluginRoot()->FirstChildElement("setting");
  while (setting)
  {
      CStdString id;
      if (setting->Attribute("id"))
          id = setting->Attribute("id");
      CStdString value;
      if (setting->Attribute("default"))
          value = setting->Attribute("default");
      Set(id,value);
      setting = setting->NextSiblingElement("setting");
  }
  return true;
}

void CBasicSettings::Clear()
{
  m_pluginXmlDoc.Clear();
  m_userXmlDoc.Clear();
}

void CBasicSettings::Set(const CStdString& key, const CStdString& value)
{
  if (key == "") return;

  // Try to find the setting and change its value
  if (!m_userXmlDoc.RootElement())
  {
    TiXmlElement node("settings");
    m_userXmlDoc.InsertEndChild(node);
  }
  TiXmlElement *setting = m_userXmlDoc.RootElement()->FirstChildElement("setting");
  while (setting)
  {
    const char *id = setting->Attribute("id");
    if (id && strcmpi(id, key) == 0)
    {
      setting->SetAttribute("value", value.c_str());
      return;
    }

    setting = setting->NextSiblingElement("setting");
  }
  
  // Setting not found, add it
  TiXmlElement nodeSetting("setting");
  nodeSetting.SetAttribute("id", key.c_str());
  nodeSetting.SetAttribute("value", value.c_str());
  m_userXmlDoc.RootElement()->InsertEndChild(nodeSetting);
}

CStdString CBasicSettings::Get(const CStdString& key) const
{
  if (m_userXmlDoc.RootElement())
  {
    // Try to find the setting and return its value
    const TiXmlElement *setting = m_userXmlDoc.RootElement()->FirstChildElement("setting");
    while (setting)
    {
      const char *id = setting->Attribute("id");
      if (id && strcmpi(id, key) == 0)
        return setting->Attribute("value");

      setting = setting->NextSiblingElement("setting");
    }
  }

  if (m_pluginXmlDoc.RootElement())
  {
    const TiXmlElement *category = m_pluginXmlDoc.RootElement()->FirstChildElement("category");
    // this makes grouping optional
    if (!category)
      category = m_pluginXmlDoc.RootElement();

    while (category)
    {
      // Try to find the setting in the plugin and return its default value
      const TiXmlElement* setting = category->FirstChildElement("setting");
      while (setting)
      {
        const char *id = setting->Attribute("id");
        if (id && strcmpi(id, key) == 0 && setting->Attribute("default"))
          return setting->Attribute("default");

        setting = setting->NextSiblingElement("setting");
      }
      category = category->NextSiblingElement("category");
    }
  }

  // Otherwise return empty string
  return "";
}

CPluginSettings::CPluginSettings()
{
}

CPluginSettings::~CPluginSettings()
{
}

bool CPluginSettings::Load(const CURL& url)
{
  m_url = url;

  // create the users filepath
  m_userFileName.Format("special://profile/plugin_data/%s/%s", url.GetHostName().c_str(), url.GetFileName().c_str());
  URIUtils::RemoveSlashAtEnd(m_userFileName);
  URIUtils::AddFileToFolder(m_userFileName, "settings.xml", m_userFileName);
  
  // Create our final path
  CStdString pluginFileName = "special://home/plugins/";

  URIUtils::AddFileToFolder(pluginFileName, url.GetHostName(), pluginFileName);
  URIUtils::AddFileToFolder(pluginFileName, url.GetFileName(), pluginFileName);

  URIUtils::AddFileToFolder(pluginFileName, "resources", pluginFileName);
  URIUtils::AddFileToFolder(pluginFileName, "settings.xml", pluginFileName);

  if (!m_pluginXmlDoc.LoadFile(pluginFileName))
  {
    CLog::Log(LOGERROR, "Unable to load: %s, Line %d\n%s", pluginFileName.c_str(), m_pluginXmlDoc.ErrorRow(), m_pluginXmlDoc.ErrorDesc());
    return false;
  }
  
  // Make sure that the plugin XML has the settings element
  TiXmlElement *setting = m_pluginXmlDoc.RootElement();
  if (!setting || strcmpi(setting->Value(), "settings") != 0)
  {
    CLog::Log(LOGERROR, "Error loading Settings %s: cannot find root element 'settings'", pluginFileName.c_str());
    return false;
  }  
  
  // Load the user saved settings. If it does not exist, create it
  if (!m_userXmlDoc.LoadFile(m_userFileName))
  {
    TiXmlDocument doc;
    TiXmlDeclaration decl("1.0", "UTF-8", "yes");
    doc.InsertEndChild(decl);
    
    TiXmlElement xmlRootElement("settings");
    doc.InsertEndChild(xmlRootElement);
    
    m_userXmlDoc = doc;
    
    // Don't worry about the actual settings, they will be set when the user clicks "Ok"
    // in the settings dialog
  }

  return true;
}

bool CPluginSettings::Save(void)
{
  // break down the path into directories
  CStdString strRoot, strType, strPlugin;
  URIUtils::GetDirectory(m_userFileName, strPlugin);
  URIUtils::RemoveSlashAtEnd(strPlugin);
  URIUtils::GetDirectory(strPlugin, strType);
  URIUtils::RemoveSlashAtEnd(strType);
  URIUtils::GetDirectory(strType, strRoot);
  URIUtils::RemoveSlashAtEnd(strRoot);

  // create the individual folders
  if (!XFILE::CDirectory::Exists(strRoot))
    XFILE::CDirectory::Create(strRoot);
  if (!XFILE::CDirectory::Exists(strType))
    XFILE::CDirectory::Create(strType);
  if (!XFILE::CDirectory::Exists(strPlugin))
    XFILE::CDirectory::Create(strPlugin);

  return m_userXmlDoc.SaveFile(m_userFileName);
}

TiXmlElement* CBasicSettings::GetPluginRoot()
{
  return m_pluginXmlDoc.RootElement();
}

bool CPluginSettings::SettingsExist(const CStdString& strPath)
{
  CURL url(strPath);
  CStdString pluginFileName = "special://home/plugins/";

  // Create our final path
  URIUtils::AddFileToFolder(pluginFileName, url.GetHostName(), pluginFileName);
  URIUtils::AddFileToFolder(pluginFileName, url.GetFileName(), pluginFileName);

  URIUtils::AddFileToFolder(pluginFileName, "resources", pluginFileName);
  URIUtils::AddFileToFolder(pluginFileName, "settings.xml", pluginFileName);

  // Load the settings file to verify it's valid
  TiXmlDocument xmlDoc;
  if (!xmlDoc.LoadFile(pluginFileName))
    return false;

  // Make sure that the plugin XML has the settings element
  TiXmlElement *setting = xmlDoc.RootElement();
  if (!setting || strcmpi(setting->Value(), "settings") != 0)
    return false;

  return true;
}

CPluginSettings& CPluginSettings::operator=(const CBasicSettings& settings)
{
  *((CBasicSettings*)this) = settings;

  return *this;
}

CPluginSettings g_currentPluginSettings;