LinuxRendererGLES.h: correct path to `DVDVideoCodec.h`
[vuplus_xbmc] / xbmc / filesystem / VideoDatabaseDirectory / DirectoryNode.cpp
1 /*
2  *      Copyright (C) 2005-2008 Team XBMC
3  *      http://www.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, write to
17  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
18  *  http://www.gnu.org/copyleft/gpl.html
19  *
20  */
21
22 #include "DirectoryNode.h"
23 #include "utils/URIUtils.h"
24 #include "QueryParams.h"
25 #include "DirectoryNodeRoot.h"
26 #include "DirectoryNodeOverview.h"
27 #include "DirectoryNodeGenre.h"
28 #include "DirectoryNodeCountry.h"
29 #include "DirectoryNodeSets.h"
30 #include "DirectoryNodeTitleMovies.h"
31 #include "DirectoryNodeTitleTvShows.h"
32 #include "DirectoryNodeYear.h"
33 #include "DirectoryNodeActor.h"
34 #include "DirectoryNodeDirector.h"
35 #include "DirectoryNodeMoviesOverview.h"
36 #include "DirectoryNodeTvShowsOverview.h"
37 #include "DirectoryNodeSeasons.h"
38 #include "DirectoryNodeEpisodes.h"
39 #include "DirectoryNodeRecentlyAddedMovies.h"
40 #include "DirectoryNodeRecentlyAddedEpisodes.h"
41 #include "DirectoryNodeStudio.h"
42 #include "DirectoryNodeMusicVideosOverview.h"
43 #include "DirectoryNodeRecentlyAddedMusicVideos.h"
44 #include "DirectoryNodeTitleMusicVideos.h"
45 #include "DirectoryNodeMusicVideoAlbum.h"
46 #include "video/VideoInfoTag.h"
47 #include "URL.h"
48 #include "settings/AdvancedSettings.h"
49 #include "FileItem.h"
50 #include "filesystem/File.h"
51 #include "utils/StringUtils.h"
52 #include "guilib/LocalizeStrings.h"
53
54 using namespace std;
55 using namespace XFILE::VIDEODATABASEDIRECTORY;
56
57 //  Constructor is protected use ParseURL()
58 CDirectoryNode::CDirectoryNode(NODE_TYPE Type, const CStdString& strName, CDirectoryNode* pParent)
59 {
60   m_Type=Type;
61   m_strName=strName;
62   m_pParent=pParent;
63 }
64
65 CDirectoryNode::~CDirectoryNode()
66 {
67   delete m_pParent;
68 }
69
70 //  Parses a given path and returns the current node of the path
71 CDirectoryNode* CDirectoryNode::ParseURL(const CStdString& strPath)
72 {
73   CURL url(strPath);
74
75   CStdString strDirectory=url.GetFileName();
76   URIUtils::RemoveSlashAtEnd(strDirectory);
77
78   CStdStringArray Path;
79   StringUtils::SplitString(strDirectory, "/", Path);
80   if (!strDirectory.IsEmpty())
81     Path.insert(Path.begin(), "");
82
83   CDirectoryNode* pNode=NULL;
84   CDirectoryNode* pParent=NULL;
85   NODE_TYPE NodeType=NODE_TYPE_ROOT;
86
87   for (int i=0; i<(int)Path.size(); ++i)
88   {
89     pNode=CDirectoryNode::CreateNode(NodeType, Path[i], pParent);
90     NodeType= pNode ? pNode->GetChildType() : NODE_TYPE_NONE;
91     pParent=pNode;
92   }
93
94   return pNode;
95 }
96
97 //  returns the database ids of the path,
98 void CDirectoryNode::GetDatabaseInfo(const CStdString& strPath, CQueryParams& params)
99 {
100   auto_ptr<CDirectoryNode> pNode(CDirectoryNode::ParseURL(strPath));
101
102   if (!pNode.get())
103     return;
104
105   pNode->CollectQueryParams(params);
106 }
107
108 //  Create a node object
109 CDirectoryNode* CDirectoryNode::CreateNode(NODE_TYPE Type, const CStdString& strName, CDirectoryNode* pParent)
110 {
111   switch (Type)
112   {
113   case NODE_TYPE_ROOT:
114     return new CDirectoryNodeRoot(strName, pParent);
115   case NODE_TYPE_OVERVIEW:
116     return new CDirectoryNodeOverview(strName, pParent);
117   case NODE_TYPE_GENRE:
118     return new CDirectoryNodeGenre(strName, pParent);
119   case NODE_TYPE_COUNTRY:
120     return new CDirectoryNodeCountry(strName, pParent);
121   case NODE_TYPE_SETS:
122     return new CDirectoryNodeSets(strName, pParent);
123   case NODE_TYPE_YEAR:
124     return new CDirectoryNodeYear(strName, pParent);
125   case NODE_TYPE_ACTOR:
126     return new CDirectoryNodeActor(strName, pParent);
127   case NODE_TYPE_DIRECTOR:
128     return new CDirectoryNodeDirector(strName, pParent);
129   case NODE_TYPE_TITLE_MOVIES:
130     return new CDirectoryNodeTitleMovies(strName, pParent);
131   case NODE_TYPE_TITLE_TVSHOWS:
132     return new CDirectoryNodeTitleTvShows(strName, pParent);
133   case NODE_TYPE_MOVIES_OVERVIEW:
134     return new CDirectoryNodeMoviesOverview(strName, pParent);
135   case NODE_TYPE_TVSHOWS_OVERVIEW:
136     return new CDirectoryNodeTvShowsOverview(strName, pParent);
137   case NODE_TYPE_SEASONS:
138     return new CDirectoryNodeSeasons(strName, pParent);
139   case NODE_TYPE_EPISODES:
140     return new CDirectoryNodeEpisodes(strName, pParent);
141   case NODE_TYPE_RECENTLY_ADDED_MOVIES:
142     return new CDirectoryNodeRecentlyAddedMovies(strName,pParent);
143   case NODE_TYPE_RECENTLY_ADDED_EPISODES:
144     return new CDirectoryNodeRecentlyAddedEpisodes(strName,pParent);
145   case NODE_TYPE_STUDIO:
146     return new CDirectoryNodeStudio(strName,pParent);
147   case NODE_TYPE_MUSICVIDEOS_OVERVIEW:
148     return new CDirectoryNodeMusicVideosOverview(strName,pParent);
149   case NODE_TYPE_RECENTLY_ADDED_MUSICVIDEOS:
150     return new CDirectoryNodeRecentlyAddedMusicVideos(strName,pParent);
151   case NODE_TYPE_TITLE_MUSICVIDEOS:
152     return new CDirectoryNodeTitleMusicVideos(strName,pParent);
153   case NODE_TYPE_MUSICVIDEOS_ALBUM:
154     return new CDirectoryNodeMusicVideoAlbum(strName,pParent);
155   default:
156     break;
157   }
158
159   return NULL;
160 }
161
162 //  Current node name
163 const CStdString& CDirectoryNode::GetName()
164 {
165   return m_strName;
166 }
167
168 //  Current node type
169 NODE_TYPE CDirectoryNode::GetType()
170 {
171   return m_Type;
172 }
173
174 //  Return the parent directory node or NULL, if there is no
175 CDirectoryNode* CDirectoryNode::GetParent()
176 {
177   return m_pParent;
178 }
179
180 void CDirectoryNode::RemoveParent()
181 {
182   m_pParent=NULL;
183 }
184
185 //  should be overloaded by a derived class
186 //  to get the content of a node. Will be called
187 //  by GetChilds() of a parent node
188 bool CDirectoryNode::GetContent(CFileItemList& items)
189 {
190   return false;
191 }
192
193 //  Creates a videodb url
194 CStdString CDirectoryNode::BuildPath()
195 {
196   CStdStringArray array;
197
198   if (!m_strName.IsEmpty())
199     array.insert(array.begin(), m_strName);
200
201   CDirectoryNode* pParent=m_pParent;
202   while (pParent!=NULL)
203   {
204     const CStdString& strNodeName=pParent->GetName();
205     if (!strNodeName.IsEmpty())
206       array.insert(array.begin(), strNodeName);
207
208     pParent=pParent->GetParent();
209   }
210
211   CStdString strPath="videodb://";
212   for (int i=0; i<(int)array.size(); ++i)
213     strPath+=array[i]+"/";
214
215   return strPath;
216 }
217
218 //  Collects Query params from this and all parent nodes. If a NODE_TYPE can
219 //  be used as a database parameter, it will be added to the
220 //  params object.
221 void CDirectoryNode::CollectQueryParams(CQueryParams& params)
222 {
223   params.SetQueryParam(m_Type, m_strName);
224
225   CDirectoryNode* pParent=m_pParent;
226   while (pParent!=NULL)
227   {
228     params.SetQueryParam(pParent->GetType(), pParent->GetName());
229     pParent=pParent->GetParent();
230   }
231 }
232
233 //  Should be overloaded by a derived class.
234 //  Returns the NODE_TYPE of the child nodes.
235 NODE_TYPE CDirectoryNode::GetChildType()
236 {
237   return NODE_TYPE_NONE;
238 }
239
240 //  Get the child fileitems of this node
241 bool CDirectoryNode::GetChilds(CFileItemList& items)
242 {
243   if (CanCache() && items.Load())
244     return true;
245
246   auto_ptr<CDirectoryNode> pNode(CDirectoryNode::CreateNode(GetChildType(), "", this));
247
248   bool bSuccess=false;
249   if (pNode.get())
250   {
251     bSuccess=pNode->GetContent(items);
252     if (bSuccess)
253     {
254       AddQueuingFolder(items);
255       if (CanCache())
256         items.SetCacheToDisc(CFileItemList::CACHE_ALWAYS);
257     }
258     else
259       items.Clear();
260
261     pNode->RemoveParent();
262   }
263
264   return bSuccess;
265 }
266
267 //  Add an "* All ..." folder to the CFileItemList
268 //  depending on the child node
269 void CDirectoryNode::AddQueuingFolder(CFileItemList& items)
270 {
271   CFileItemPtr pItem;
272
273   // always hide "all" items
274   if (g_advancedSettings.m_bVideoLibraryHideAllItems)
275     return;
276
277   // no need for "all" item when only one item
278   if (items.GetObjectCount() <= 1)
279     return;
280
281   // hack - as the season node might return episodes
282   auto_ptr<CDirectoryNode> pNode(ParseURL(items.m_strPath));
283
284   switch (pNode->GetChildType())
285   {
286     case NODE_TYPE_SEASONS:
287       {
288         CStdString strLabel = g_localizeStrings.Get(20366);
289         pItem.reset(new CFileItem(strLabel));  // "All Seasons"
290         pItem->m_strPath = BuildPath() + "-1/";
291         // set the number of watched and unwatched items accordingly
292         int watched = 0;
293         int unwatched = 0;
294         for (int i = 0; i < items.Size(); i++)
295         {
296           CFileItemPtr item = items[i];
297           watched += item->GetPropertyInt("watchedepisodes");
298           unwatched += item->GetPropertyInt("unwatchedepisodes");
299         }
300         pItem->SetProperty("totalepisodes", watched + unwatched);
301         pItem->SetProperty("numepisodes", watched + unwatched); // will be changed later to reflect watchmode setting
302         pItem->SetProperty("watchedepisodes", watched);
303         pItem->SetProperty("unwatchedepisodes", unwatched);
304         if (items.Size() && items[0]->GetVideoInfoTag())
305         {
306           *pItem->GetVideoInfoTag() = *items[0]->GetVideoInfoTag();
307           pItem->GetVideoInfoTag()->m_iSeason = -1;
308         }
309         pItem->GetVideoInfoTag()->m_strTitle = strLabel;
310         pItem->GetVideoInfoTag()->m_iEpisode = watched + unwatched;
311         pItem->GetVideoInfoTag()->m_playCount = (unwatched == 0) ? 1 : 0;
312         if (XFILE::CFile::Exists(pItem->GetCachedSeasonThumb()))
313           pItem->SetThumbnailImage(pItem->GetCachedSeasonThumb());
314       }
315       break;
316     default:
317       break;
318   }
319
320   if (pItem)
321   {
322     pItem->m_bIsFolder = true;
323     pItem->SetSpecialSort(g_advancedSettings.m_bVideoLibraryAllItemsOnBottom ? SORT_ON_BOTTOM : SORT_ON_TOP);
324     pItem->SetCanQueue(false);
325     items.Add(pItem);
326   }
327 }
328
329 bool CDirectoryNode::CanCache()
330 {
331   //  Only cache the directorys in the root
332   //NODE_TYPE childnode=GetChildType();
333   //NODE_TYPE node=GetType();
334
335   // something should probably be cached
336   return true;//(childnode==NODE_TYPE_TITLE_MOVIES || childnode==NODE_TYPE_EPISODES || childnode == NODE_TYPE_SEASONS || childnode == NODE_TYPE_TITLE_TVSHOWS);
337 }