Merge pull request #3475 from Karlson2k/http_charset_01a
[vuplus_xbmc] / xbmc / guilib / GUIIncludes.cpp
1 /*
2  *      Copyright (C) 2005-2013 Team XBMC
3  *      http://xbmc.org
4  *
5  *  This Program is free software; you can redistribute it and/or modify
6  *  it under the terms of the GNU General Public License as published by
7  *  the Free Software Foundation; either version 2, or (at your option)
8  *  any later version.
9  *
10  *  This Program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  *  GNU General Public License for more details.
14  *
15  *  You should have received a copy of the GNU General Public License
16  *  along with XBMC; see the file COPYING.  If not, see
17  *  <http://www.gnu.org/licenses/>.
18  *
19  */
20
21 #include "GUIIncludes.h"
22 #include "addons/Skin.h"
23 #include "GUIInfoManager.h"
24 #include "utils/log.h"
25 #include "utils/XBMCTinyXML.h"
26 #include "utils/StringUtils.h"
27 #include "interfaces/info/SkinVariable.h"
28
29 using namespace std;
30
31 CGUIIncludes::CGUIIncludes()
32 {
33   m_constantAttributes.insert("x");
34   m_constantAttributes.insert("y");
35   m_constantAttributes.insert("width");
36   m_constantAttributes.insert("height");
37   m_constantAttributes.insert("center");
38   m_constantAttributes.insert("max");
39   m_constantAttributes.insert("min");
40   m_constantAttributes.insert("w");
41   m_constantAttributes.insert("h");
42   m_constantAttributes.insert("time");
43   m_constantAttributes.insert("acceleration");
44   m_constantAttributes.insert("delay");
45   m_constantAttributes.insert("start");
46   m_constantAttributes.insert("end");
47   m_constantAttributes.insert("center");
48   m_constantAttributes.insert("border");
49   
50   m_constantNodes.insert("posx");
51   m_constantNodes.insert("posy");
52   m_constantNodes.insert("left");
53   m_constantNodes.insert("right");
54   m_constantNodes.insert("centerx");
55   m_constantNodes.insert("top");
56   m_constantNodes.insert("bottom");
57   m_constantNodes.insert("centery");
58   m_constantNodes.insert("width");
59   m_constantNodes.insert("height");
60   m_constantNodes.insert("offsetx");
61   m_constantNodes.insert("offsety");
62   m_constantNodes.insert("textoffsetx");
63   m_constantNodes.insert("textoffsety");  
64   m_constantNodes.insert("textwidth");
65   m_constantNodes.insert("spinposx");
66   m_constantNodes.insert("spinposy");
67   m_constantNodes.insert("spinwidth");
68   m_constantNodes.insert("spinheight");
69   m_constantNodes.insert("radioposx");
70   m_constantNodes.insert("radioposy");
71   m_constantNodes.insert("radiowidth");
72   m_constantNodes.insert("radioheight");
73   m_constantNodes.insert("markwidth");
74   m_constantNodes.insert("markheight");
75   m_constantNodes.insert("sliderwidth");
76   m_constantNodes.insert("sliderheight");
77   m_constantNodes.insert("itemgap");
78   m_constantNodes.insert("bordersize");
79   m_constantNodes.insert("timeperimage");
80   m_constantNodes.insert("fadetime");
81   m_constantNodes.insert("pauseatend");
82 }
83
84 CGUIIncludes::~CGUIIncludes()
85 {
86 }
87
88 void CGUIIncludes::ClearIncludes()
89 {
90   m_includes.clear();
91   m_defaults.clear();
92   m_constants.clear();
93   m_skinvariables.clear();
94   m_files.clear();
95 }
96
97 bool CGUIIncludes::LoadIncludes(const CStdString &includeFile)
98 {
99   // check to see if we already have this loaded
100   if (HasIncludeFile(includeFile))
101     return true;
102
103   CXBMCTinyXML doc;
104   if (!doc.LoadFile(includeFile))
105   {
106     CLog::Log(LOGINFO, "Error loading includes.xml file (%s): %s (row=%i, col=%i)", includeFile.c_str(), doc.ErrorDesc(), doc.ErrorRow(), doc.ErrorCol());
107     return false;
108   }
109   // success, load the tags
110   if (LoadIncludesFromXML(doc.RootElement()))
111   {
112     m_files.push_back(includeFile);
113     return true;
114   }
115   return false;
116 }
117
118 bool CGUIIncludes::LoadIncludesFromXML(const TiXmlElement *root)
119 {
120   if (!root || strcmpi(root->Value(), "includes"))
121   {
122     CLog::Log(LOGERROR, "Skin includes must start with the <includes> tag");
123     return false;
124   }
125   const TiXmlElement* node = root->FirstChildElement("include");
126   while (node)
127   {
128     if (node->Attribute("name") && node->FirstChild())
129     {
130       CStdString tagName = node->Attribute("name");
131       m_includes.insert(pair<CStdString, TiXmlElement>(tagName, *node));
132     }
133     else if (node->Attribute("file"))
134     { // load this file in as well
135       LoadIncludes(g_SkinInfo->GetSkinPath(node->Attribute("file")));
136     }
137     node = node->NextSiblingElement("include");
138   }
139   // now defaults
140   node = root->FirstChildElement("default");
141   while (node)
142   {
143     if (node->Attribute("type") && node->FirstChild())
144     {
145       CStdString tagName = node->Attribute("type");
146       m_defaults.insert(pair<CStdString, TiXmlElement>(tagName, *node));
147     }
148     node = node->NextSiblingElement("default");
149   }
150   // and finally constants
151   node = root->FirstChildElement("constant");
152   while (node)
153   {
154     if (node->Attribute("name") && node->FirstChild())
155     {
156       CStdString tagName = node->Attribute("name");
157       m_constants.insert(make_pair(tagName, node->FirstChild()->ValueStr()));
158     }
159     node = node->NextSiblingElement("constant");
160   }
161
162   node = root->FirstChildElement("variable");
163   while (node)
164   {
165     if (node->Attribute("name") && node->FirstChild())
166     {
167       CStdString tagName = node->Attribute("name");
168       m_skinvariables.insert(make_pair(tagName, *node));
169     }
170     node = node->NextSiblingElement("variable");
171   }
172
173   return true;
174 }
175
176 bool CGUIIncludes::HasIncludeFile(const CStdString &file) const
177 {
178   for (iFiles it = m_files.begin(); it != m_files.end(); ++it)
179     if (*it == file) return true;
180   return false;
181 }
182
183 void CGUIIncludes::ResolveIncludes(TiXmlElement *node, std::map<int, bool>* xmlIncludeConditions /* = NULL */)
184 {
185   if (!node)
186     return;
187   ResolveIncludesForNode(node, xmlIncludeConditions);
188
189   TiXmlElement *child = node->FirstChildElement();
190   while (child)
191   {
192     ResolveIncludes(child, xmlIncludeConditions);
193     child = child->NextSiblingElement();
194   }
195 }
196
197 void CGUIIncludes::ResolveIncludesForNode(TiXmlElement *node, std::map<int, bool>* xmlIncludeConditions /* = NULL */)
198 {
199   // we have a node, find any <include file="fileName">tagName</include> tags and replace
200   // recursively with their real includes
201   if (!node) return;
202
203   // First add the defaults if this is for a control
204   CStdString type;
205   if (node->ValueStr() == "control")
206   {
207     type = node->Attribute("type");
208     map<CStdString, TiXmlElement>::const_iterator it = m_defaults.find(type);
209     if (it != m_defaults.end())
210     {
211       const TiXmlElement &element = (*it).second;
212       const TiXmlElement *tag = element.FirstChildElement();
213       while (tag)
214       {
215         // we insert at the end of block
216         node->InsertEndChild(*tag);
217         tag = tag->NextSiblingElement();
218       }
219     }
220   }
221
222   TiXmlElement *include = node->FirstChildElement("include");
223   while (include && include->FirstChild())
224   {
225     // have an include tag - grab it's tag name and replace it with the real tag contents
226     const char *file = include->Attribute("file");
227     if (file)
228     { // we need to load this include from the alternative file
229       LoadIncludes(g_SkinInfo->GetSkinPath(file));
230     }
231     const char *condition = include->Attribute("condition");
232     if (condition)
233     { // check this condition
234       int conditionID = g_infoManager.Register(condition);
235       bool value = g_infoManager.GetBoolValue(conditionID);
236
237       if (xmlIncludeConditions)
238         (*xmlIncludeConditions)[conditionID] = value;
239
240       if (!value)
241       {
242         include = include->NextSiblingElement("include");
243         continue;
244       }
245     }
246     CStdString tagName = include->FirstChild()->Value();
247     map<CStdString, TiXmlElement>::const_iterator it = m_includes.find(tagName);
248     if (it != m_includes.end())
249     { // found the tag(s) to include - let's replace it
250       const TiXmlElement &element = (*it).second;
251       const TiXmlElement *tag = element.FirstChildElement();
252       while (tag)
253       {
254         // we insert before the <include> element to keep the correct
255         // order (we render in the order given in the xml file)
256         node->InsertBeforeChild(include, *tag);
257         tag = tag->NextSiblingElement();
258       }
259       // remove the <include>tagName</include> element
260       node->RemoveChild(include);
261       include = node->FirstChildElement("include");
262     }
263     else
264     { // invalid include
265       CLog::Log(LOGWARNING, "Skin has invalid include: %s", tagName.c_str());
266       include = include->NextSiblingElement("include");
267     }
268   }
269
270   // run through this element's attributes, resolving any constants
271   TiXmlAttribute *attribute = node->FirstAttribute();
272   while (attribute)
273   { // check the attribute against our set
274     if (m_constantAttributes.count(attribute->Name()))
275       attribute->SetValue(ResolveConstant(attribute->ValueStr()));
276     attribute = attribute->Next();
277   }
278   // also do the value
279   if (node->FirstChild() && node->FirstChild()->Type() == TiXmlNode::TINYXML_TEXT && m_constantNodes.count(node->ValueStr()))
280     node->FirstChild()->SetValue(ResolveConstant(node->FirstChild()->ValueStr()));
281 }
282
283 CStdString CGUIIncludes::ResolveConstant(const CStdString &constant) const
284 {
285   CStdStringArray values;
286   StringUtils::SplitString(constant, ",", values);
287   for (unsigned int i = 0; i < values.size(); ++i)
288   {
289     map<CStdString, CStdString>::const_iterator it = m_constants.find(values[i]);
290     if (it != m_constants.end())
291       values[i] = it->second;
292   }
293   CStdString value;
294   StringUtils::JoinString(values, ",", value);
295   return value;
296 }
297
298 const INFO::CSkinVariableString* CGUIIncludes::CreateSkinVariable(const CStdString& name, int context)
299 {
300   map<CStdString, TiXmlElement>::const_iterator it = m_skinvariables.find(name);
301   if (it != m_skinvariables.end())
302     return INFO::CSkinVariable::CreateFromXML(it->second, context);
303   return NULL;
304 }