2 * Copyright (C) 2005-2013 Team XBMC
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)
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.
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/>.
22 #include "guilib/LocalizeStrings.h"
23 #include "utils/StringUtils.h"
24 #include "utils/URIUtils.h"
26 #include "playlists/PlayListFactory.h"
27 #include "utils/Crc32.h"
28 #include "filesystem/Directory.h"
29 #include "filesystem/StackDirectory.h"
30 #include "filesystem/CurlFile.h"
31 #include "filesystem/MultiPathDirectory.h"
32 #include "filesystem/MusicDatabaseDirectory.h"
33 #include "filesystem/VideoDatabaseDirectory.h"
34 #include "filesystem/VideoDatabaseDirectory/QueryParams.h"
35 #include "music/tags/MusicInfoTagLoaderFactory.h"
36 #include "CueDocument.h"
37 #include "video/VideoDatabase.h"
38 #include "music/MusicDatabase.h"
39 #include "utils/TuxBoxUtil.h"
41 #include "pvr/channels/PVRChannel.h"
42 #include "pvr/recordings/PVRRecording.h"
43 #include "pvr/timers/PVRTimerInfoTag.h"
44 #include "utils/Observer.h"
45 #include "video/VideoInfoTag.h"
46 #include "threads/SingleLock.h"
47 #include "music/tags/MusicInfoTag.h"
48 #include "pictures/PictureInfoTag.h"
49 #include "music/Artist.h"
50 #include "music/Album.h"
51 #include "music/Song.h"
53 #include "settings/AdvancedSettings.h"
54 #include "settings/Settings.h"
55 #include "utils/RegExp.h"
56 #include "utils/log.h"
57 #include "utils/Variant.h"
58 #include "music/karaoke/karaokelyricsfactory.h"
59 #include "utils/Mime.h"
61 #include "cores/paplayer/ASAPCodec.h"
65 using namespace XFILE;
66 using namespace PLAYLIST;
67 using namespace MUSIC_INFO;
71 CFileItem::CFileItem(const CSong& song)
73 m_musicInfoTag = NULL;
74 m_videoInfoTag = NULL;
76 m_pvrChannelInfoTag = NULL;
77 m_pvrRecordingInfoTag = NULL;
78 m_pvrTimerInfoTag = NULL;
79 m_pictureInfoTag = NULL;
85 CFileItem::CFileItem(const CStdString &path, const CAlbum& album)
87 m_musicInfoTag = NULL;
88 m_videoInfoTag = NULL;
90 m_pvrChannelInfoTag = NULL;
91 m_pvrRecordingInfoTag = NULL;
92 m_pvrTimerInfoTag = NULL;
93 m_pictureInfoTag = NULL;
97 URIUtils::AddSlashAtEnd(m_strPath);
101 CFileItem::CFileItem(const CMusicInfoTag& music)
103 m_musicInfoTag = NULL;
104 m_videoInfoTag = NULL;
106 m_pvrChannelInfoTag = NULL;
107 m_pvrRecordingInfoTag = NULL;
108 m_pvrTimerInfoTag = NULL;
109 m_pictureInfoTag = NULL;
111 SetLabel(music.GetTitle());
112 m_strPath = music.GetURL();
113 m_bIsFolder = URIUtils::HasSlashAtEnd(m_strPath);
114 *GetMusicInfoTag() = music;
116 FillInMimeType(false);
119 CFileItem::CFileItem(const CVideoInfoTag& movie)
121 m_musicInfoTag = NULL;
122 m_videoInfoTag = NULL;
124 m_pvrChannelInfoTag = NULL;
125 m_pvrRecordingInfoTag = NULL;
126 m_pvrTimerInfoTag = NULL;
127 m_pictureInfoTag = NULL;
130 SetFromVideoInfoTag(movie);
133 CFileItem::CFileItem(const CEpgInfoTag& tag)
135 m_musicInfoTag = NULL;
136 m_videoInfoTag = NULL;
138 m_pvrChannelInfoTag = NULL;
139 m_pvrRecordingInfoTag = NULL;
140 m_pvrTimerInfoTag = NULL;
141 m_pictureInfoTag = NULL;
145 m_strPath = tag.Path();
147 *GetEPGInfoTag() = tag;
148 SetLabel(tag.Title());
149 m_strLabel2 = tag.Plot();
150 m_dateTime = tag.StartAsLocalTime();
152 if (!tag.Icon().empty())
153 SetIconImage(tag.Icon());
154 else if (tag.HasPVRChannel() && !tag.ChannelTag()->IconPath().empty())
155 SetIconImage(tag.ChannelTag()->IconPath());
157 FillInMimeType(false);
160 CFileItem::CFileItem(const CPVRChannel& channel)
162 m_musicInfoTag = NULL;
163 m_videoInfoTag = NULL;
165 m_pvrChannelInfoTag = NULL;
166 m_pvrRecordingInfoTag = NULL;
167 m_pvrTimerInfoTag = NULL;
168 m_pictureInfoTag = NULL;
172 bool bHasEpgNow = channel.GetEPGNow(epgNow);
174 m_strPath = channel.Path();
176 *GetPVRChannelInfoTag() = channel;
177 SetLabel(channel.ChannelName());
178 m_strLabel2 = bHasEpgNow ? epgNow.Title() :
179 CSettings::Get().GetBool("epg.hidenoinfoavailable") ?
180 StringUtils::EmptyString :
181 g_localizeStrings.Get(19055); // no information available
183 if (channel.IsRadio())
185 CMusicInfoTag* musictag = GetMusicInfoTag();
188 musictag->SetURL(channel.Path());
189 musictag->SetTitle(m_strLabel2);
190 musictag->SetArtist(channel.ChannelName());
191 musictag->SetAlbumArtist(channel.ChannelName());
193 musictag->SetGenre(epgNow.Genre());
194 musictag->SetDuration(bHasEpgNow ? epgNow.GetDuration() : 3600);
195 musictag->SetLoaded(true);
196 musictag->SetComment("");
197 musictag->SetLyrics("");
201 if (!channel.IconPath().empty())
202 SetIconImage(channel.IconPath());
204 SetProperty("channelid", channel.ChannelID());
205 SetProperty("path", channel.Path());
206 SetArt("thumb", channel.IconPath());
208 FillInMimeType(false);
211 CFileItem::CFileItem(const CPVRRecording& record)
213 m_musicInfoTag = NULL;
214 m_videoInfoTag = NULL;
216 m_pvrChannelInfoTag = NULL;
217 m_pvrRecordingInfoTag = NULL;
218 m_pvrTimerInfoTag = NULL;
219 m_pictureInfoTag = NULL;
223 m_strPath = record.m_strFileNameAndPath;
225 *GetPVRRecordingInfoTag() = record;
226 SetLabel(record.m_strTitle);
227 m_strLabel2 = record.m_strPlot;
229 FillInMimeType(false);
232 CFileItem::CFileItem(const CPVRTimerInfoTag& timer)
234 m_musicInfoTag = NULL;
235 m_videoInfoTag = NULL;
237 m_pvrChannelInfoTag = NULL;
238 m_pvrRecordingInfoTag = NULL;
239 m_pvrTimerInfoTag = NULL;
240 m_pictureInfoTag = NULL;
244 m_strPath = timer.Path();
246 *GetPVRTimerInfoTag() = timer;
247 SetLabel(timer.Title());
248 m_strLabel2 = timer.Summary();
249 m_dateTime = timer.StartAsLocalTime();
251 if (!timer.ChannelIcon().empty())
252 SetIconImage(timer.ChannelIcon());
254 FillInMimeType(false);
257 CFileItem::CFileItem(const CArtist& artist)
259 m_musicInfoTag = NULL;
260 m_videoInfoTag = NULL;
262 m_pvrChannelInfoTag = NULL;
263 m_pvrRecordingInfoTag = NULL;
264 m_pvrTimerInfoTag = NULL;
265 m_pictureInfoTag = NULL;
267 SetLabel(artist.strArtist);
268 m_strPath = artist.strArtist;
270 URIUtils::AddSlashAtEnd(m_strPath);
271 GetMusicInfoTag()->SetArtist(artist.strArtist);
272 FillInMimeType(false);
275 CFileItem::CFileItem(const CGenre& genre)
277 m_musicInfoTag = NULL;
278 m_videoInfoTag = NULL;
280 m_pvrChannelInfoTag = NULL;
281 m_pvrRecordingInfoTag = NULL;
282 m_pvrTimerInfoTag = NULL;
283 m_pictureInfoTag = NULL;
285 SetLabel(genre.strGenre);
286 m_strPath = genre.strGenre;
288 URIUtils::AddSlashAtEnd(m_strPath);
289 GetMusicInfoTag()->SetGenre(genre.strGenre);
290 FillInMimeType(false);
293 CFileItem::CFileItem(const CFileItem& item): CGUIListItem()
295 m_musicInfoTag = NULL;
296 m_videoInfoTag = NULL;
298 m_pvrChannelInfoTag = NULL;
299 m_pvrRecordingInfoTag = NULL;
300 m_pvrTimerInfoTag = NULL;
301 m_pictureInfoTag = NULL;
305 CFileItem::CFileItem(const CGUIListItem& item)
307 m_musicInfoTag = NULL;
308 m_videoInfoTag = NULL;
310 m_pvrChannelInfoTag = NULL;
311 m_pvrRecordingInfoTag = NULL;
312 m_pvrTimerInfoTag = NULL;
313 m_pictureInfoTag = NULL;
315 // not particularly pretty, but it gets around the issue of Reset() defaulting
316 // parameters in the CGUIListItem base class.
317 *((CGUIListItem *)this) = item;
319 FillInMimeType(false);
322 CFileItem::CFileItem(void)
324 m_musicInfoTag = NULL;
325 m_videoInfoTag = NULL;
327 m_pvrChannelInfoTag = NULL;
328 m_pvrRecordingInfoTag = NULL;
329 m_pvrTimerInfoTag = NULL;
330 m_pictureInfoTag = NULL;
334 CFileItem::CFileItem(const CStdString& strLabel)
337 m_musicInfoTag = NULL;
338 m_videoInfoTag = NULL;
340 m_pvrChannelInfoTag = NULL;
341 m_pvrRecordingInfoTag = NULL;
342 m_pvrTimerInfoTag = NULL;
343 m_pictureInfoTag = NULL;
348 CFileItem::CFileItem(const CStdString& strPath, bool bIsFolder)
350 m_musicInfoTag = NULL;
351 m_videoInfoTag = NULL;
353 m_pvrChannelInfoTag = NULL;
354 m_pvrRecordingInfoTag = NULL;
355 m_pvrTimerInfoTag = NULL;
356 m_pictureInfoTag = NULL;
359 m_bIsFolder = bIsFolder;
360 // tuxbox urls cannot have a / at end
361 if (m_bIsFolder && !m_strPath.empty() && !IsFileFolder() && !URIUtils::IsTuxBox(m_strPath))
362 URIUtils::AddSlashAtEnd(m_strPath);
363 FillInMimeType(false);
366 CFileItem::CFileItem(const CMediaSource& share)
368 m_musicInfoTag = NULL;
369 m_videoInfoTag = NULL;
371 m_pvrChannelInfoTag = NULL;
372 m_pvrRecordingInfoTag = NULL;
373 m_pvrTimerInfoTag = NULL;
374 m_pictureInfoTag = NULL;
377 m_bIsShareOrDrive = true;
378 m_strPath = share.strPath;
379 if (!IsRSS()) // no slash at end for rss feeds
380 URIUtils::AddSlashAtEnd(m_strPath);
381 CStdString label = share.strName;
382 if (!share.strStatus.empty())
383 label = StringUtils::Format("%s (%s)", share.strName.c_str(), share.strStatus.c_str());
385 m_iLockMode = share.m_iLockMode;
386 m_strLockCode = share.m_strLockCode;
387 m_iHasLock = share.m_iHasLock;
388 m_iBadPwdCount = share.m_iBadPwdCount;
389 m_iDriveType = share.m_iDriveType;
390 SetArt("thumb", share.m_strThumbnailImage);
391 SetLabelPreformated(true);
393 GetVideoInfoTag()->m_strFileNameAndPath = share.strDiskUniqueId; // share.strDiskUniqueId contains disc unique id
394 FillInMimeType(false);
397 CFileItem::~CFileItem(void)
399 delete m_musicInfoTag;
400 delete m_videoInfoTag;
402 delete m_pvrChannelInfoTag;
403 delete m_pvrRecordingInfoTag;
404 delete m_pvrTimerInfoTag;
405 delete m_pictureInfoTag;
407 m_musicInfoTag = NULL;
408 m_videoInfoTag = NULL;
410 m_pvrChannelInfoTag = NULL;
411 m_pvrRecordingInfoTag = NULL;
412 m_pvrTimerInfoTag = NULL;
413 m_pictureInfoTag = NULL;
416 const CFileItem& CFileItem::operator=(const CFileItem& item)
418 if (this == &item) return * this;
419 CGUIListItem::operator=(item);
420 m_bLabelPreformated=item.m_bLabelPreformated;
422 m_strPath = item.GetPath();
423 m_bIsParentFolder = item.m_bIsParentFolder;
424 m_iDriveType = item.m_iDriveType;
425 m_bIsShareOrDrive = item.m_bIsShareOrDrive;
426 m_dateTime = item.m_dateTime;
427 m_dwSize = item.m_dwSize;
428 if (item.HasMusicInfoTag())
430 m_musicInfoTag = GetMusicInfoTag();
432 *m_musicInfoTag = *item.m_musicInfoTag;
436 delete m_musicInfoTag;
437 m_musicInfoTag = NULL;
440 if (item.HasVideoInfoTag())
442 m_videoInfoTag = GetVideoInfoTag();
444 *m_videoInfoTag = *item.m_videoInfoTag;
448 delete m_videoInfoTag;
449 m_videoInfoTag = NULL;
452 if (item.HasEPGInfoTag())
454 m_epgInfoTag = GetEPGInfoTag();
456 *m_epgInfoTag = *item.m_epgInfoTag;
466 if (item.HasPVRChannelInfoTag())
468 m_pvrChannelInfoTag = GetPVRChannelInfoTag();
469 if (m_pvrChannelInfoTag)
470 *m_pvrChannelInfoTag = *item.m_pvrChannelInfoTag;
474 if (m_pvrChannelInfoTag)
475 delete m_pvrChannelInfoTag;
477 m_pvrChannelInfoTag = NULL;
480 if (item.HasPVRRecordingInfoTag())
482 m_pvrRecordingInfoTag = GetPVRRecordingInfoTag();
483 if (m_pvrRecordingInfoTag)
484 *m_pvrRecordingInfoTag = *item.m_pvrRecordingInfoTag;
488 if (m_pvrRecordingInfoTag)
489 delete m_pvrRecordingInfoTag;
491 m_pvrRecordingInfoTag = NULL;
494 if (item.HasPVRTimerInfoTag())
496 m_pvrTimerInfoTag = GetPVRTimerInfoTag();
497 if (m_pvrTimerInfoTag)
498 *m_pvrTimerInfoTag = *item.m_pvrTimerInfoTag;
502 if (m_pvrTimerInfoTag)
503 delete m_pvrTimerInfoTag;
505 m_pvrTimerInfoTag = NULL;
508 if (item.HasPictureInfoTag())
510 m_pictureInfoTag = GetPictureInfoTag();
511 if (m_pictureInfoTag)
512 *m_pictureInfoTag = *item.m_pictureInfoTag;
516 delete m_pictureInfoTag;
517 m_pictureInfoTag = NULL;
520 m_lStartOffset = item.m_lStartOffset;
521 m_lStartPartNumber = item.m_lStartPartNumber;
522 m_lEndOffset = item.m_lEndOffset;
523 m_strDVDLabel = item.m_strDVDLabel;
524 m_strTitle = item.m_strTitle;
525 m_iprogramCount = item.m_iprogramCount;
526 m_idepth = item.m_idepth;
527 m_iLockMode = item.m_iLockMode;
528 m_strLockCode = item.m_strLockCode;
529 m_iHasLock = item.m_iHasLock;
530 m_iBadPwdCount = item.m_iBadPwdCount;
531 m_bCanQueue=item.m_bCanQueue;
532 m_mimetype = item.m_mimetype;
533 m_extrainfo = item.m_extrainfo;
534 m_specialSort = item.m_specialSort;
535 m_bIsAlbum = item.m_bIsAlbum;
539 void CFileItem::Reset()
543 m_bLabelPreformated=false;
545 m_overlayIcon = ICON_OVERLAY_NONE;
548 m_strDVDLabel.clear();
553 m_bIsParentFolder=false;
554 m_bIsShareOrDrive = false;
556 m_iDriveType = CMediaSource::SOURCE_TYPE_UNKNOWN;
558 m_lStartPartNumber = 1;
562 m_iLockMode = LOCK_MODE_EVERYONE;
568 delete m_musicInfoTag;
570 delete m_videoInfoTag;
574 delete m_pvrChannelInfoTag;
575 m_pvrChannelInfoTag=NULL;
576 delete m_pvrRecordingInfoTag;
577 m_pvrRecordingInfoTag=NULL;
578 delete m_pvrTimerInfoTag;
579 m_pvrTimerInfoTag=NULL;
580 delete m_pictureInfoTag;
581 m_pictureInfoTag=NULL;
583 m_specialSort = SortSpecialNone;
588 void CFileItem::Archive(CArchive& ar)
590 CGUIListItem::Archive(ar);
594 ar << m_bIsParentFolder;
595 ar << m_bLabelPreformated;
597 ar << m_bIsShareOrDrive;
603 ar << m_iprogramCount;
605 ar << m_lStartOffset;
606 ar << m_lStartPartNumber;
610 ar << m_iBadPwdCount;
620 ar << *m_musicInfoTag;
627 ar << *m_videoInfoTag;
631 if (m_pictureInfoTag)
634 ar << *m_pictureInfoTag;
641 ar >> m_bIsParentFolder;
642 ar >> m_bLabelPreformated;
644 ar >> m_bIsShareOrDrive;
650 ar >> m_iprogramCount;
652 ar >> m_lStartOffset;
653 ar >> m_lStartPartNumber;
657 m_iLockMode = (LockType)temp;
659 ar >> m_iBadPwdCount;
665 m_specialSort = (SortSpecial)temp;
670 ar >> *GetMusicInfoTag();
673 ar >> *GetVideoInfoTag();
676 ar >> *GetPictureInfoTag();
682 void CFileItem::Serialize(CVariant& value) const
684 //CGUIListItem::Serialize(value["CGUIListItem"]);
686 value["strPath"] = m_strPath;
687 value["dateTime"] = (m_dateTime.IsValid()) ? m_dateTime.GetAsRFC1123DateTime() : "";
688 value["lastmodified"] = m_dateTime.IsValid() ? m_dateTime.GetAsDBDateTime() : "";
689 value["size"] = m_dwSize;
690 value["DVDLabel"] = m_strDVDLabel;
691 value["title"] = m_strTitle;
692 value["mimetype"] = m_mimetype;
693 value["extrainfo"] = m_extrainfo;
696 (*m_musicInfoTag).Serialize(value["musicInfoTag"]);
699 (*m_videoInfoTag).Serialize(value["videoInfoTag"]);
701 if (m_pictureInfoTag)
702 (*m_pictureInfoTag).Serialize(value["pictureInfoTag"]);
705 void CFileItem::ToSortable(SortItem &sortable, Field field) const
709 case FieldPath: sortable[FieldPath] = m_strPath; break;
710 case FieldDate: sortable[FieldDate] = (m_dateTime.IsValid()) ? m_dateTime.GetAsDBDateTime() : ""; break;
711 case FieldSize: sortable[FieldSize] = m_dwSize; break;
712 case FieldDriveType: sortable[FieldDriveType] = m_iDriveType; break;
713 case FieldStartOffset: sortable[FieldStartOffset] = m_lStartOffset; break;
714 case FieldEndOffset: sortable[FieldEndOffset] = m_lEndOffset; break;
715 case FieldProgramCount: sortable[FieldProgramCount] = m_iprogramCount; break;
716 case FieldBitrate: sortable[FieldBitrate] = m_dwSize; break;
717 case FieldTitle: sortable[FieldTitle] = m_strTitle; break;
718 // If there's ever a need to convert more properties from CGUIListItem it might be
719 // worth to make CGUIListItem implement ISortable as well and call it from here
723 if (HasMusicInfoTag())
724 GetMusicInfoTag()->ToSortable(sortable, field);
726 if (HasVideoInfoTag())
728 GetVideoInfoTag()->ToSortable(sortable, field);
730 if (GetVideoInfoTag()->m_type == "tvshow")
732 if (field == FieldNumberOfEpisodes && HasProperty("totalepisodes"))
733 sortable[FieldNumberOfEpisodes] = GetProperty("totalepisodes");
734 if (field == FieldNumberOfWatchedEpisodes && HasProperty("unwatchedepisodes"))
735 sortable[FieldNumberOfWatchedEpisodes] = GetProperty("unwatchedepisodes");
739 if (HasPictureInfoTag())
740 GetPictureInfoTag()->ToSortable(sortable, field);
742 if (HasPVRChannelInfoTag())
743 GetPVRChannelInfoTag()->ToSortable(sortable, field);
746 void CFileItem::ToSortable(SortItem &sortable, const Fields &fields) const
748 Fields::const_iterator it;
749 for (it = fields.begin(); it != fields.end(); it++)
750 ToSortable(sortable, *it);
752 /* FieldLabel is used as a fallback by all sorters and therefore has to be present as well */
753 sortable[FieldLabel] = GetLabel();
754 /* FieldSortSpecial and FieldFolder are required in conjunction with all other sorters as well */
755 sortable[FieldSortSpecial] = m_specialSort;
756 sortable[FieldFolder] = m_bIsFolder;
759 bool CFileItem::Exists(bool bUseCache /* = true */) const
761 if (m_strPath.empty()
762 || m_strPath.Equals("add")
763 || IsInternetStream()
765 || IsVirtualDirectoryRoot()
769 if (IsVideoDb() && HasVideoInfoTag())
771 CFileItem dbItem(m_bIsFolder ? GetVideoInfoTag()->m_strPath : GetVideoInfoTag()->m_strFileNameAndPath, m_bIsFolder);
772 return dbItem.Exists();
775 CStdString strPath = m_strPath;
777 if (URIUtils::IsMultiPath(strPath))
778 strPath = CMultiPathDirectory::GetFirstPath(strPath);
780 if (URIUtils::IsStack(strPath))
781 strPath = CStackDirectory::GetFirstStackedFile(strPath);
784 return CDirectory::Exists(strPath);
786 return CFile::Exists(strPath, bUseCache);
791 bool CFileItem::IsVideo() const
793 /* check preset mime type */
794 if( StringUtils::StartsWithNoCase(m_mimetype, "video/") )
797 if (HasVideoInfoTag()) return true;
798 if (HasMusicInfoTag()) return false;
799 if (HasPictureInfoTag()) return false;
800 if (IsPVRRecording()) return true;
802 if (IsHDHomeRun() || IsTuxBox() || URIUtils::IsDVD(m_strPath) || IsSlingbox())
805 CStdString extension;
806 if( StringUtils::StartsWithNoCase(m_mimetype, "application/") )
807 { /* check for some standard types */
808 extension = m_mimetype.substr(12);
809 if( extension.Equals("ogg")
810 || extension.Equals("mp4")
811 || extension.Equals("mxf") )
815 return URIUtils::HasExtension(m_strPath, g_advancedSettings.m_videoExtensions);
818 bool CFileItem::IsEPG() const
820 if (HasEPGInfoTag()) return true; /// is this enough?
824 bool CFileItem::IsPVRChannel() const
826 if (HasPVRChannelInfoTag()) return true; /// is this enough?
830 bool CFileItem::IsPVRRecording() const
832 if (HasPVRRecordingInfoTag()) return true; /// is this enough?
836 bool CFileItem::IsPVRTimer() const
838 if (HasPVRTimerInfoTag()) return true; /// is this enough?
842 bool CFileItem::IsDiscStub() const
844 if (IsVideoDb() && HasVideoInfoTag())
846 CFileItem dbItem(m_bIsFolder ? GetVideoInfoTag()->m_strPath : GetVideoInfoTag()->m_strFileNameAndPath, m_bIsFolder);
847 return dbItem.IsDiscStub();
850 return URIUtils::HasExtension(m_strPath, g_advancedSettings.m_discStubExtensions);
853 bool CFileItem::IsAudio() const
855 /* check preset mime type */
856 if( StringUtils::StartsWithNoCase(m_mimetype, "audio/") )
859 if (HasMusicInfoTag()) return true;
860 if (HasVideoInfoTag()) return false;
861 if (HasPictureInfoTag()) return false;
862 if (IsCDDA()) return true;
864 if( StringUtils::StartsWithNoCase(m_mimetype, "application/") )
865 { /* check for some standard types */
866 CStdString extension = m_mimetype.substr(12);
867 if( extension.Equals("ogg")
868 || extension.Equals("mp4")
869 || extension.Equals("mxf") )
873 return URIUtils::HasExtension(m_strPath, g_advancedSettings.m_musicExtensions);
876 bool CFileItem::IsKaraoke() const
881 return CKaraokeLyricsFactory::HasLyrics( m_strPath );
884 bool CFileItem::IsPicture() const
886 if( StringUtils::StartsWithNoCase(m_mimetype, "image/") )
889 if (HasPictureInfoTag()) return true;
890 if (HasMusicInfoTag()) return false;
891 if (HasVideoInfoTag()) return false;
893 return CUtil::IsPicture(m_strPath);
896 bool CFileItem::IsLyrics() const
898 return URIUtils::HasExtension(m_strPath, ".cdg|.lrc");
901 bool CFileItem::IsCUESheet() const
903 return URIUtils::HasExtension(m_strPath, ".cue");
906 bool CFileItem::IsInternetStream(const bool bStrictCheck /* = false */) const
908 if (HasProperty("IsHTTPDirectory"))
911 return URIUtils::IsInternetStream(m_strPath, bStrictCheck);
914 bool CFileItem::IsFileFolder(EFileFolderType types) const
916 EFileFolderType always_type = EFILEFOLDER_TYPE_ALWAYS;
918 /* internet streams are not directly expanded */
919 if(IsInternetStream())
920 always_type = EFILEFOLDER_TYPE_ONCLICK;
923 if(types & always_type)
925 if( IsSmartPlayList()
926 || (IsPlayList() && g_advancedSettings.m_playlistAsFolders)
931 || IsType(".ogg|.oga|.nsf|.sid|.sap|.xsp")
932 #if defined(TARGET_ANDROID)
935 #ifdef HAS_ASAP_CODEC
936 || ASAPCodec::IsSupportedFormat(URIUtils::GetExtension(m_strPath))
942 if(types & EFILEFOLDER_TYPE_ONBROWSE)
944 if((IsPlayList() && !g_advancedSettings.m_playlistAsFolders)
953 bool CFileItem::IsSmartPlayList() const
955 if (HasProperty("library.smartplaylist") && GetProperty("library.smartplaylist").asBoolean())
958 return URIUtils::HasExtension(m_strPath, ".xsp");
961 bool CFileItem::IsLibraryFolder() const
963 if (HasProperty("library.filter") && GetProperty("library.filter").asBoolean())
966 return URIUtils::IsLibraryFolder(m_strPath);
969 bool CFileItem::IsPlayList() const
971 return CPlayListFactory::IsPlaylist(*this);
974 bool CFileItem::IsPythonScript() const
976 return URIUtils::HasExtension(m_strPath, ".py");
979 bool CFileItem::IsType(const char *ext) const
981 return URIUtils::HasExtension(m_strPath, ext);
984 bool CFileItem::IsNFO() const
986 return URIUtils::HasExtension(m_strPath, ".nfo");
989 bool CFileItem::IsDVDImage() const
991 return URIUtils::HasExtension(m_strPath, ".img|.iso|.nrg");
994 bool CFileItem::IsOpticalMediaFile() const
996 bool found = IsDVDFile(false, true);
1002 bool CFileItem::IsDVDFile(bool bVobs /*= true*/, bool bIfos /*= true*/) const
1004 CStdString strFileName = URIUtils::GetFileName(m_strPath);
1007 if (strFileName.Equals("video_ts.ifo")) return true;
1008 if (StringUtils::StartsWithNoCase(strFileName, "vts_") && StringUtils::EndsWithNoCase(strFileName, "_0.ifo") && strFileName.length() == 12) return true;
1012 if (strFileName.Equals("video_ts.vob")) return true;
1013 if (StringUtils::StartsWithNoCase(strFileName, "vts_") && StringUtils::EndsWithNoCase(strFileName, ".vob")) return true;
1019 bool CFileItem::IsBDFile() const
1021 CStdString strFileName = URIUtils::GetFileName(m_strPath);
1022 return (strFileName.Equals("index.bdmv"));
1025 bool CFileItem::IsRAR() const
1027 return URIUtils::IsRAR(m_strPath);
1030 bool CFileItem::IsAPK() const
1032 return URIUtils::IsAPK(m_strPath);
1035 bool CFileItem::IsZIP() const
1037 return URIUtils::IsZIP(m_strPath);
1040 bool CFileItem::IsCBZ() const
1042 return URIUtils::HasExtension(m_strPath, ".cbz");
1045 bool CFileItem::IsCBR() const
1047 return URIUtils::HasExtension(m_strPath, ".cbr");
1050 bool CFileItem::IsRSS() const
1052 return StringUtils::StartsWithNoCase(m_strPath, "rss://") || URIUtils::HasExtension(m_strPath, ".rss")
1053 || m_mimetype == "application/rss+xml";
1056 bool CFileItem::IsAndroidApp() const
1058 return URIUtils::IsAndroidApp(m_strPath);
1061 bool CFileItem::IsStack() const
1063 return URIUtils::IsStack(m_strPath);
1066 bool CFileItem::IsPlugin() const
1068 return URIUtils::IsPlugin(m_strPath);
1071 bool CFileItem::IsScript() const
1073 return URIUtils::IsScript(m_strPath);
1076 bool CFileItem::IsAddonsPath() const
1078 return URIUtils::IsAddonsPath(m_strPath);
1081 bool CFileItem::IsSourcesPath() const
1083 return URIUtils::IsSourcesPath(m_strPath);
1086 bool CFileItem::IsMultiPath() const
1088 return URIUtils::IsMultiPath(m_strPath);
1091 bool CFileItem::IsCDDA() const
1093 return URIUtils::IsCDDA(m_strPath);
1096 bool CFileItem::IsDVD() const
1098 return URIUtils::IsDVD(m_strPath) || m_iDriveType == CMediaSource::SOURCE_TYPE_DVD;
1101 bool CFileItem::IsOnDVD() const
1103 return URIUtils::IsOnDVD(m_strPath) || m_iDriveType == CMediaSource::SOURCE_TYPE_DVD;
1106 bool CFileItem::IsNfs() const
1108 return URIUtils::IsNfs(m_strPath);
1111 bool CFileItem::IsAfp() const
1113 return URIUtils::IsAfp(m_strPath);
1116 bool CFileItem::IsOnLAN() const
1118 return URIUtils::IsOnLAN(m_strPath);
1121 bool CFileItem::IsISO9660() const
1123 return URIUtils::IsISO9660(m_strPath);
1126 bool CFileItem::IsRemote() const
1128 return URIUtils::IsRemote(m_strPath);
1131 bool CFileItem::IsSmb() const
1133 return URIUtils::IsSmb(m_strPath);
1136 bool CFileItem::IsURL() const
1138 return URIUtils::IsURL(m_strPath);
1141 bool CFileItem::IsDAAP() const
1143 return URIUtils::IsDAAP(m_strPath);
1146 bool CFileItem::IsTuxBox() const
1148 return URIUtils::IsTuxBox(m_strPath);
1151 bool CFileItem::IsMythTV() const
1153 return URIUtils::IsMythTV(m_strPath);
1156 bool CFileItem::IsHDHomeRun() const
1158 return URIUtils::IsHDHomeRun(m_strPath);
1161 bool CFileItem::IsSlingbox() const
1163 return URIUtils::IsSlingbox(m_strPath);
1166 bool CFileItem::IsVTP() const
1168 return URIUtils::IsVTP(m_strPath);
1171 bool CFileItem::IsPVR() const
1173 return CUtil::IsPVR(m_strPath);
1176 bool CFileItem::IsLiveTV() const
1178 return URIUtils::IsLiveTV(m_strPath);
1181 bool CFileItem::IsHD() const
1183 return URIUtils::IsHD(m_strPath);
1186 bool CFileItem::IsMusicDb() const
1188 CURL url(m_strPath);
1189 return url.GetProtocol().Equals("musicdb");
1192 bool CFileItem::IsVideoDb() const
1194 CURL url(m_strPath);
1195 return url.GetProtocol().Equals("videodb");
1198 bool CFileItem::IsVirtualDirectoryRoot() const
1200 return (m_bIsFolder && m_strPath.empty());
1203 bool CFileItem::IsRemovable() const
1205 return IsOnDVD() || IsCDDA() || m_iDriveType == CMediaSource::SOURCE_TYPE_REMOVABLE;
1208 bool CFileItem::IsReadOnly() const
1210 if (IsParentFolder()) return true;
1211 if (m_bIsShareOrDrive) return true;
1212 return !CUtil::SupportsWriteFileOperations(m_strPath);
1215 void CFileItem::FillInDefaultIcon()
1217 //CLog::Log(LOGINFO, "FillInDefaultIcon(%s)", pItem->GetLabel().c_str());
1218 // find the default icon for a file or folder item
1219 // for files this can be the (depending on the file type)
1220 // default picture for photo's
1221 // default picture for songs
1222 // default picture for videos
1223 // default picture for shortcuts
1224 // default picture for playlists
1225 // or the icon embedded in an .xbe
1228 // for .. folders the default picture for parent folder
1229 // for other folders the defaultFolder.png
1231 if (GetIconImage().empty())
1235 /* To reduce the average runtime of this code, this list should
1236 * be ordered with most frequently seen types first. Also bear
1237 * in mind the complexity of the code behind the check in the
1238 * case of IsWhatater() returns false.
1242 if (GetPVRChannelInfoTag()->IsRadio())
1243 SetIconImage("DefaultAudio.png");
1245 SetIconImage("DefaultVideo.png");
1247 else if ( IsLiveTV() )
1250 SetIconImage("DefaultVideo.png");
1252 else if ( URIUtils::IsArchive(m_strPath) )
1254 SetIconImage("DefaultFile.png");
1256 else if ( IsAudio() )
1259 SetIconImage("DefaultAudio.png");
1261 else if ( IsVideo() )
1264 SetIconImage("DefaultVideo.png");
1266 else if (IsPVRRecording())
1268 SetIconImage("DefaultVideo.png");
1270 else if (IsPVRTimer())
1272 SetIconImage("DefaultVideo.png");
1274 else if ( IsPicture() )
1277 SetIconImage("DefaultPicture.png");
1279 else if ( IsPlayList() )
1281 SetIconImage("DefaultPlaylist.png");
1283 else if ( IsPythonScript() )
1285 SetIconImage("DefaultScript.png");
1289 // default icon for unknown file type
1290 SetIconImage("DefaultFile.png");
1297 SetIconImage("DefaultPlaylist.png");
1299 else if (IsParentFolder())
1301 SetIconImage("DefaultFolderBack.png");
1305 SetIconImage("DefaultFolder.png");
1309 // Set the icon overlays (if applicable)
1312 if (URIUtils::IsInRAR(m_strPath))
1313 SetOverlayImage(CGUIListItem::ICON_OVERLAY_RAR);
1314 else if (URIUtils::IsInZIP(m_strPath))
1315 SetOverlayImage(CGUIListItem::ICON_OVERLAY_ZIP);
1319 void CFileItem::RemoveExtension()
1323 CStdString strLabel = GetLabel();
1324 URIUtils::RemoveExtension(strLabel);
1328 void CFileItem::CleanString()
1333 CStdString strLabel = GetLabel();
1334 CStdString strTitle, strTitleAndYear, strYear;
1335 CUtil::CleanString(strLabel, strTitle, strTitleAndYear, strYear, true );
1336 SetLabel(strTitleAndYear);
1339 void CFileItem::SetLabel(const CStdString &strLabel)
1343 m_bIsParentFolder=true;
1345 m_specialSort = SortSpecialOnTop;
1346 SetLabelPreformated(true);
1348 CGUIListItem::SetLabel(strLabel);
1351 void CFileItem::SetFileSizeLabel()
1353 if( m_bIsFolder && m_dwSize == 0 )
1356 SetLabel2(StringUtils::SizeToString(m_dwSize));
1359 CURL CFileItem::GetAsUrl() const
1361 return CURL(m_strPath);
1364 bool CFileItem::CanQueue() const
1369 void CFileItem::SetCanQueue(bool bYesNo)
1374 bool CFileItem::IsParentFolder() const
1376 return m_bIsParentFolder;
1379 void CFileItem::FillInMimeType(bool lookup /*= true*/)
1381 // TODO: adapt this to use CMime::GetMimeType()
1382 if (m_mimetype.empty())
1385 m_mimetype = "x-directory/normal";
1386 else if( m_pvrChannelInfoTag )
1387 m_mimetype = m_pvrChannelInfoTag->InputFormat();
1388 else if( StringUtils::StartsWithNoCase(m_strPath, "shout://")
1389 || StringUtils::StartsWithNoCase(m_strPath, "http://")
1390 || StringUtils::StartsWithNoCase(m_strPath, "https://"))
1392 // If lookup is false, bail out early to leave mime type empty
1396 CCurlFile::GetMimeType(GetAsUrl(), m_mimetype);
1398 // try to get mime-type again but with an NSPlayer User-Agent
1399 // in order for server to provide correct mime-type. Allows us
1400 // to properly detect an MMS stream
1401 if (StringUtils::StartsWithNoCase(m_mimetype, "video/x-ms-"))
1402 CCurlFile::GetMimeType(GetAsUrl(), m_mimetype, "NSPlayer/11.00.6001.7000");
1404 // make sure there are no options set in mime-type
1405 // mime-type can look like "video/x-ms-asf ; charset=utf8"
1406 size_t i = m_mimetype.find(';');
1407 if(i != std::string::npos)
1408 m_mimetype.erase(i, m_mimetype.length() - i);
1409 StringUtils::Trim(m_mimetype);
1412 m_mimetype = CMime::GetMimeType(*this);
1414 // if it's still empty set to an unknown type
1415 if (m_mimetype.empty())
1416 m_mimetype = "application/octet-stream";
1419 // change protocol to mms for the following mime-type. Allows us to create proper FileMMS.
1420 if( StringUtils::StartsWithNoCase(m_mimetype, "application/vnd.ms.wms-hdr.asfv1") || StringUtils::StartsWithNoCase(m_mimetype, "application/x-mms-framed") )
1421 StringUtils::Replace(m_strPath, "http:", "mms:");
1424 bool CFileItem::IsSamePath(const CFileItem *item) const
1429 if (item->GetPath() == m_strPath)
1431 if (item->HasProperty("item_start") || HasProperty("item_start"))
1432 return (item->GetProperty("item_start") == GetProperty("item_start"));
1435 if (IsMusicDb() && HasMusicInfoTag())
1437 CFileItem dbItem(m_musicInfoTag->GetURL(), false);
1438 if (HasProperty("item_start"))
1439 dbItem.SetProperty("item_start", GetProperty("item_start"));
1440 return dbItem.IsSamePath(item);
1442 if (IsVideoDb() && HasVideoInfoTag())
1444 CFileItem dbItem(m_videoInfoTag->m_strFileNameAndPath, false);
1445 if (HasProperty("item_start"))
1446 dbItem.SetProperty("item_start", GetProperty("item_start"));
1447 return dbItem.IsSamePath(item);
1449 if (item->IsMusicDb() && item->HasMusicInfoTag())
1451 CFileItem dbItem(item->m_musicInfoTag->GetURL(), false);
1452 if (item->HasProperty("item_start"))
1453 dbItem.SetProperty("item_start", item->GetProperty("item_start"));
1454 return IsSamePath(&dbItem);
1456 if (item->IsVideoDb() && item->HasVideoInfoTag())
1458 CFileItem dbItem(item->m_videoInfoTag->m_strFileNameAndPath, false);
1459 if (item->HasProperty("item_start"))
1460 dbItem.SetProperty("item_start", item->GetProperty("item_start"));
1461 return IsSamePath(&dbItem);
1463 if (HasProperty("original_listitem_url"))
1464 return (GetProperty("original_listitem_url") == item->GetPath());
1468 bool CFileItem::IsAlbum() const
1473 void CFileItem::UpdateInfo(const CFileItem &item, bool replaceLabels /*=true*/)
1475 if (item.HasVideoInfoTag())
1476 { // copy info across (TODO: premiered info is normally stored in m_dateTime by the db)
1477 *GetVideoInfoTag() = *item.GetVideoInfoTag();
1478 // preferably use some information from PVR info tag if available
1479 if (HasPVRRecordingInfoTag())
1480 GetPVRRecordingInfoTag()->CopyClientInfo(GetVideoInfoTag());
1481 SetOverlayImage(ICON_OVERLAY_UNWATCHED, GetVideoInfoTag()->m_playCount > 0);
1484 if (item.HasMusicInfoTag())
1486 *GetMusicInfoTag() = *item.GetMusicInfoTag();
1489 if (item.HasPictureInfoTag())
1491 *GetPictureInfoTag() = *item.GetPictureInfoTag();
1494 if (replaceLabels && !item.GetLabel().empty())
1495 SetLabel(item.GetLabel());
1496 if (replaceLabels && !item.GetLabel2().empty())
1497 SetLabel2(item.GetLabel2());
1498 if (!item.GetArt("thumb").empty())
1499 SetArt("thumb", item.GetArt("thumb"));
1500 if (!item.GetIconImage().empty())
1501 SetIconImage(item.GetIconImage());
1502 AppendProperties(item);
1505 void CFileItem::SetFromVideoInfoTag(const CVideoInfoTag &video)
1507 if (!video.m_strTitle.empty())
1508 SetLabel(video.m_strTitle);
1509 if (video.m_strFileNameAndPath.empty())
1511 m_strPath = video.m_strPath;
1512 URIUtils::AddSlashAtEnd(m_strPath);
1517 m_strPath = video.m_strFileNameAndPath;
1518 m_bIsFolder = false;
1521 *GetVideoInfoTag() = video;
1522 if (video.m_iSeason == 0)
1523 SetProperty("isspecial", "true");
1524 FillInDefaultIcon();
1525 FillInMimeType(false);
1528 void CFileItem::SetFromAlbum(const CAlbum &album)
1530 if (!album.strAlbum.empty())
1531 SetLabel(album.strAlbum);
1533 m_strLabel2 = StringUtils::Join(album.artist, g_advancedSettings.m_musicItemSeparator);
1534 GetMusicInfoTag()->SetAlbum(album);
1536 CMusicDatabase::SetPropertiesFromAlbum(*this,album);
1537 FillInMimeType(false);
1540 void CFileItem::SetFromSong(const CSong &song)
1542 if (!song.strTitle.empty())
1543 SetLabel(song.strTitle);
1544 if (!song.strFileName.empty())
1545 m_strPath = song.strFileName;
1546 GetMusicInfoTag()->SetSong(song);
1547 m_lStartOffset = song.iStartOffset;
1548 m_lStartPartNumber = 1;
1549 SetProperty("item_start", song.iStartOffset);
1550 m_lEndOffset = song.iEndOffset;
1551 if (!song.strThumb.empty())
1552 SetArt("thumb", song.strThumb);
1553 FillInMimeType(false);
1556 std::string CFileItem::GetOpticalMediaPath() const
1559 std::string dvdPath;
1560 path = URIUtils::AddFileToFolder(GetPath(), "VIDEO_TS.IFO");
1561 if (CFile::Exists(path))
1565 dvdPath = URIUtils::AddFileToFolder(GetPath(), "VIDEO_TS");
1566 path = URIUtils::AddFileToFolder(dvdPath, "VIDEO_TS.IFO");
1568 if (CFile::Exists(path))
1571 #ifdef HAVE_LIBBLURAY
1572 if (dvdPath.empty())
1574 path = URIUtils::AddFileToFolder(GetPath(), "index.bdmv");
1575 if (CFile::Exists(path))
1579 dvdPath = URIUtils::AddFileToFolder(GetPath(), "BDMV");
1580 path = URIUtils::AddFileToFolder(dvdPath, "index.bdmv");
1582 if (CFile::Exists(path))
1590 /////////////////////////////////////////////////////////////////////////////////
1594 //////////////////////////////////////////////////////////////////////////////////
1596 CFileItemList::CFileItemList()
1598 m_fastLookup = false;
1600 m_cacheToDisc = CACHE_IF_SLOW;
1601 m_sortIgnoreFolders = false;
1602 m_replaceListing = false;
1605 CFileItemList::CFileItemList(const CStdString& strPath) : CFileItem(strPath, true)
1607 m_fastLookup = false;
1608 m_cacheToDisc = CACHE_IF_SLOW;
1609 m_sortIgnoreFolders = false;
1610 m_replaceListing = false;
1613 CFileItemList::~CFileItemList()
1618 CFileItemPtr CFileItemList::operator[] (int iItem)
1623 const CFileItemPtr CFileItemList::operator[] (int iItem) const
1628 CFileItemPtr CFileItemList::operator[] (const CStdString& strPath)
1630 return Get(strPath);
1633 const CFileItemPtr CFileItemList::operator[] (const CStdString& strPath) const
1635 return Get(strPath);
1638 void CFileItemList::SetFastLookup(bool fastLookup)
1640 CSingleLock lock(m_lock);
1642 if (fastLookup && !m_fastLookup)
1643 { // generate the map
1645 for (unsigned int i=0; i < m_items.size(); i++)
1647 CFileItemPtr pItem = m_items[i];
1648 m_map.insert(MAPFILEITEMSPAIR(pItem->GetPath(), pItem));
1651 if (!fastLookup && m_fastLookup)
1653 m_fastLookup = fastLookup;
1656 bool CFileItemList::Contains(const CStdString& fileName) const
1658 CSingleLock lock(m_lock);
1661 return m_map.find(fileName) != m_map.end();
1664 for (unsigned int i = 0; i < m_items.size(); i++)
1666 const CFileItemPtr pItem = m_items[i];
1667 if (pItem->GetPath().Equals(fileName))
1673 void CFileItemList::Clear()
1675 CSingleLock lock(m_lock);
1678 m_sortDescription.sortBy = SortByNone;
1679 m_sortDescription.sortOrder = SortOrderNone;
1680 m_sortDescription.sortAttributes = SortAttributeNone;
1681 m_sortIgnoreFolders = false;
1682 m_cacheToDisc = CACHE_IF_SLOW;
1683 m_sortDetails.clear();
1684 m_replaceListing = false;
1688 void CFileItemList::ClearItems()
1690 CSingleLock lock(m_lock);
1691 // make sure we free the memory of the items (these are GUIControls which may have allocated resources)
1693 for (unsigned int i = 0; i < m_items.size(); i++)
1695 CFileItemPtr item = m_items[i];
1702 void CFileItemList::Add(const CFileItemPtr &pItem)
1704 CSingleLock lock(m_lock);
1706 m_items.push_back(pItem);
1709 m_map.insert(MAPFILEITEMSPAIR(pItem->GetPath(), pItem));
1713 void CFileItemList::AddFront(const CFileItemPtr &pItem, int itemPosition)
1715 CSingleLock lock(m_lock);
1717 if (itemPosition >= 0)
1719 m_items.insert(m_items.begin()+itemPosition, pItem);
1723 m_items.insert(m_items.begin()+(m_items.size()+itemPosition), pItem);
1727 m_map.insert(MAPFILEITEMSPAIR(pItem->GetPath(), pItem));
1731 void CFileItemList::Remove(CFileItem* pItem)
1733 CSingleLock lock(m_lock);
1735 for (IVECFILEITEMS it = m_items.begin(); it != m_items.end(); ++it)
1737 if (pItem == it->get())
1742 m_map.erase(pItem->GetPath());
1749 void CFileItemList::Remove(int iItem)
1751 CSingleLock lock(m_lock);
1753 if (iItem >= 0 && iItem < (int)Size())
1755 CFileItemPtr pItem = *(m_items.begin() + iItem);
1758 m_map.erase(pItem->GetPath());
1760 m_items.erase(m_items.begin() + iItem);
1764 void CFileItemList::Append(const CFileItemList& itemlist)
1766 CSingleLock lock(m_lock);
1768 for (int i = 0; i < itemlist.Size(); ++i)
1772 void CFileItemList::Assign(const CFileItemList& itemlist, bool append)
1774 CSingleLock lock(m_lock);
1778 SetPath(itemlist.GetPath());
1779 SetLabel(itemlist.GetLabel());
1780 m_sortDetails = itemlist.m_sortDetails;
1781 m_sortDescription = itemlist.m_sortDescription;
1782 m_replaceListing = itemlist.m_replaceListing;
1783 m_content = itemlist.m_content;
1784 m_mapProperties = itemlist.m_mapProperties;
1785 m_cacheToDisc = itemlist.m_cacheToDisc;
1788 bool CFileItemList::Copy(const CFileItemList& items, bool copyItems /* = true */)
1790 // assign all CFileItem parts
1791 *(CFileItem*)this = *(CFileItem*)&items;
1793 // assign the rest of the CFileItemList properties
1794 m_replaceListing = items.m_replaceListing;
1795 m_content = items.m_content;
1796 m_mapProperties = items.m_mapProperties;
1797 m_cacheToDisc = items.m_cacheToDisc;
1798 m_sortDetails = items.m_sortDetails;
1799 m_sortDescription = items.m_sortDescription;
1800 m_sortIgnoreFolders = items.m_sortIgnoreFolders;
1804 // make a copy of each item
1805 for (int i = 0; i < items.Size(); i++)
1807 CFileItemPtr newItem(new CFileItem(*items[i]));
1815 CFileItemPtr CFileItemList::Get(int iItem)
1817 CSingleLock lock(m_lock);
1819 if (iItem > -1 && iItem < (int)m_items.size())
1820 return m_items[iItem];
1822 return CFileItemPtr();
1825 const CFileItemPtr CFileItemList::Get(int iItem) const
1827 CSingleLock lock(m_lock);
1829 if (iItem > -1 && iItem < (int)m_items.size())
1830 return m_items[iItem];
1832 return CFileItemPtr();
1835 CFileItemPtr CFileItemList::Get(const CStdString& strPath)
1837 CSingleLock lock(m_lock);
1841 IMAPFILEITEMS it=m_map.find(strPath);
1842 if (it != m_map.end())
1845 return CFileItemPtr();
1848 for (unsigned int i = 0; i < m_items.size(); i++)
1850 CFileItemPtr pItem = m_items[i];
1851 if (pItem->GetPath().Equals(strPath))
1855 return CFileItemPtr();
1858 const CFileItemPtr CFileItemList::Get(const CStdString& strPath) const
1860 CSingleLock lock(m_lock);
1864 map<CStdString, CFileItemPtr>::const_iterator it=m_map.find(strPath);
1865 if (it != m_map.end())
1868 return CFileItemPtr();
1871 for (unsigned int i = 0; i < m_items.size(); i++)
1873 CFileItemPtr pItem = m_items[i];
1874 if (pItem->GetPath().Equals(strPath))
1878 return CFileItemPtr();
1881 int CFileItemList::Size() const
1883 CSingleLock lock(m_lock);
1884 return (int)m_items.size();
1887 bool CFileItemList::IsEmpty() const
1889 CSingleLock lock(m_lock);
1890 return (m_items.size() <= 0);
1893 void CFileItemList::Reserve(int iCount)
1895 CSingleLock lock(m_lock);
1896 m_items.reserve(iCount);
1899 void CFileItemList::Sort(FILEITEMLISTCOMPARISONFUNC func)
1901 CSingleLock lock(m_lock);
1902 std::stable_sort(m_items.begin(), m_items.end(), func);
1905 void CFileItemList::FillSortFields(FILEITEMFILLFUNC func)
1907 CSingleLock lock(m_lock);
1908 std::for_each(m_items.begin(), m_items.end(), func);
1911 void CFileItemList::Sort(SortBy sortBy, SortOrder sortOrder, SortAttribute sortAttributes /* = SortAttributeNone */)
1913 if (sortBy == SortByNone ||
1914 (m_sortDescription.sortBy == sortBy && m_sortDescription.sortOrder == sortOrder &&
1915 m_sortDescription.sortAttributes == sortAttributes))
1918 SortDescription sorting;
1919 sorting.sortBy = sortBy;
1920 sorting.sortOrder = sortOrder;
1921 sorting.sortAttributes = sortAttributes;
1924 m_sortDescription = sorting;
1927 void CFileItemList::Sort(SortDescription sortDescription)
1929 if (sortDescription.sortBy == SortByFile ||
1930 sortDescription.sortBy == SortBySortTitle ||
1931 sortDescription.sortBy == SortByDateAdded ||
1932 sortDescription.sortBy == SortByRating ||
1933 sortDescription.sortBy == SortByYear ||
1934 sortDescription.sortBy == SortByPlaylistOrder ||
1935 sortDescription.sortBy == SortByLastPlayed ||
1936 sortDescription.sortBy == SortByPlaycount)
1937 sortDescription.sortAttributes = (SortAttribute)((int)sortDescription.sortAttributes | SortAttributeIgnoreFolders);
1939 if (sortDescription.sortBy == SortByNone ||
1940 (m_sortDescription.sortBy == sortDescription.sortBy && m_sortDescription.sortOrder == sortDescription.sortOrder &&
1941 m_sortDescription.sortAttributes == sortDescription.sortAttributes))
1944 if (m_sortIgnoreFolders)
1945 sortDescription.sortAttributes = (SortAttribute)((int)sortDescription.sortAttributes | SortAttributeIgnoreFolders);
1947 const Fields fields = SortUtils::GetFieldsForSorting(sortDescription.sortBy);
1948 SortItems sortItems((size_t)Size());
1949 for (int index = 0; index < Size(); index++)
1951 sortItems[index] = boost::shared_ptr<SortItem>(new SortItem);
1952 m_items[index]->ToSortable(*sortItems[index], fields);
1953 (*sortItems[index])[FieldId] = index;
1957 SortUtils::Sort(sortDescription, sortItems);
1959 // apply the new order to the existing CFileItems
1960 VECFILEITEMS sortedFileItems;
1961 sortedFileItems.reserve(Size());
1962 for (SortItems::const_iterator it = sortItems.begin(); it != sortItems.end(); it++)
1964 CFileItemPtr item = m_items[(int)(*it)->at(FieldId).asInteger()];
1965 // Set the sort label in the CFileItem
1966 item->SetSortLabel(CStdStringW((*it)->at(FieldSort).asWideString()));
1968 sortedFileItems.push_back(item);
1971 // replace the current list with the re-ordered one
1972 m_items.assign(sortedFileItems.begin(), sortedFileItems.end());
1975 void CFileItemList::Randomize()
1977 CSingleLock lock(m_lock);
1978 random_shuffle(m_items.begin(), m_items.end());
1981 void CFileItemList::Archive(CArchive& ar)
1983 CSingleLock lock(m_lock);
1986 CFileItem::Archive(ar);
1989 if (m_items.size() > 0 && m_items[0]->IsParentFolder())
1992 ar << (int)(m_items.size() - i);
1996 ar << (int)m_sortDescription.sortBy;
1997 ar << (int)m_sortDescription.sortOrder;
1998 ar << (int)m_sortDescription.sortAttributes;
1999 ar << m_sortIgnoreFolders;
2000 ar << (int)m_cacheToDisc;
2002 ar << (int)m_sortDetails.size();
2003 for (unsigned int j = 0; j < m_sortDetails.size(); ++j)
2005 const SORT_METHOD_DETAILS &details = m_sortDetails[j];
2006 ar << (int)details.m_sortDescription.sortBy;
2007 ar << (int)details.m_sortDescription.sortOrder;
2008 ar << (int)details.m_sortDescription.sortAttributes;
2009 ar << details.m_buttonLabel;
2010 ar << details.m_labelMasks.m_strLabelFile;
2011 ar << details.m_labelMasks.m_strLabelFolder;
2012 ar << details.m_labelMasks.m_strLabel2File;
2013 ar << details.m_labelMasks.m_strLabel2Folder;
2018 for (; i < (int)m_items.size(); ++i)
2020 CFileItemPtr pItem = m_items[i];
2026 CFileItemPtr pParent;
2029 CFileItemPtr pItem=m_items[0];
2030 if (pItem->IsParentFolder())
2031 pParent.reset(new CFileItem(*pItem));
2034 SetFastLookup(false);
2038 CFileItem::Archive(ar);
2047 m_items.reserve(iSize + 1);
2048 m_items.push_back(pParent);
2051 m_items.reserve(iSize);
2053 bool fastLookup=false;
2057 ar >> (int&)tempint;
2058 m_sortDescription.sortBy = (SortBy)tempint;
2059 ar >> (int&)tempint;
2060 m_sortDescription.sortOrder = (SortOrder)tempint;
2061 ar >> (int&)tempint;
2062 m_sortDescription.sortAttributes = (SortAttribute)tempint;
2063 ar >> m_sortIgnoreFolders;
2064 ar >> (int&)tempint;
2065 m_cacheToDisc = CACHE_TYPE(tempint);
2067 unsigned int detailSize = 0;
2069 for (unsigned int j = 0; j < detailSize; ++j)
2071 SORT_METHOD_DETAILS details;
2072 ar >> (int&)tempint;
2073 details.m_sortDescription.sortBy = (SortBy)tempint;
2074 ar >> (int&)tempint;
2075 details.m_sortDescription.sortOrder = (SortOrder)tempint;
2076 ar >> (int&)tempint;
2077 details.m_sortDescription.sortAttributes = (SortAttribute)tempint;
2078 ar >> details.m_buttonLabel;
2079 ar >> details.m_labelMasks.m_strLabelFile;
2080 ar >> details.m_labelMasks.m_strLabelFolder;
2081 ar >> details.m_labelMasks.m_strLabel2File;
2082 ar >> details.m_labelMasks.m_strLabel2Folder;
2083 m_sortDetails.push_back(details);
2088 for (int i = 0; i < iSize; ++i)
2090 CFileItemPtr pItem(new CFileItem);
2095 SetFastLookup(fastLookup);
2099 void CFileItemList::FillInDefaultIcons()
2101 CSingleLock lock(m_lock);
2102 for (int i = 0; i < (int)m_items.size(); ++i)
2104 CFileItemPtr pItem = m_items[i];
2105 pItem->FillInDefaultIcon();
2109 int CFileItemList::GetFolderCount() const
2111 CSingleLock lock(m_lock);
2112 int nFolderCount = 0;
2113 for (int i = 0; i < (int)m_items.size(); i++)
2115 CFileItemPtr pItem = m_items[i];
2116 if (pItem->m_bIsFolder)
2120 return nFolderCount;
2123 int CFileItemList::GetObjectCount() const
2125 CSingleLock lock(m_lock);
2127 int numObjects = (int)m_items.size();
2128 if (numObjects && m_items[0]->IsParentFolder())
2134 int CFileItemList::GetFileCount() const
2136 CSingleLock lock(m_lock);
2138 for (int i = 0; i < (int)m_items.size(); i++)
2140 CFileItemPtr pItem = m_items[i];
2141 if (!pItem->m_bIsFolder)
2148 int CFileItemList::GetSelectedCount() const
2150 CSingleLock lock(m_lock);
2152 for (int i = 0; i < (int)m_items.size(); i++)
2154 CFileItemPtr pItem = m_items[i];
2155 if (pItem->IsSelected())
2162 void CFileItemList::FilterCueItems()
2164 CSingleLock lock(m_lock);
2165 // Handle .CUE sheet files...
2166 VECSONGS itemstoadd;
2167 CStdStringArray itemstodelete;
2168 for (int i = 0; i < (int)m_items.size(); i++)
2170 CFileItemPtr pItem = m_items[i];
2171 if (!pItem->m_bIsFolder)
2172 { // see if it's a .CUE sheet
2173 if (pItem->IsCUESheet())
2175 CCueDocument cuesheet;
2176 if (cuesheet.Parse(pItem->GetPath()))
2179 cuesheet.GetSongs(newitems);
2181 std::vector<CStdString> MediaFileVec;
2182 cuesheet.GetMediaFiles(MediaFileVec);
2184 // queue the cue sheet and the underlying media file for deletion
2185 for(std::vector<CStdString>::iterator itMedia = MediaFileVec.begin(); itMedia != MediaFileVec.end(); itMedia++)
2187 CStdString strMediaFile = *itMedia;
2188 CStdString fileFromCue = strMediaFile; // save the file from the cue we're matching against,
2189 // as we're going to search for others here...
2190 bool bFoundMediaFile = CFile::Exists(strMediaFile);
2191 // queue the cue sheet and the underlying media file for deletion
2192 if (!bFoundMediaFile)
2194 // try file in same dir, not matching case...
2195 if (Contains(strMediaFile))
2197 bFoundMediaFile = true;
2201 // try removing the .cue extension...
2202 strMediaFile = pItem->GetPath();
2203 URIUtils::RemoveExtension(strMediaFile);
2204 CFileItem item(strMediaFile, false);
2205 if (item.IsAudio() && Contains(strMediaFile))
2207 bFoundMediaFile = true;
2210 { // try replacing the extension with one of our allowed ones.
2211 CStdStringArray extensions;
2212 StringUtils::SplitString(g_advancedSettings.m_musicExtensions, "|", extensions);
2213 for (unsigned int i = 0; i < extensions.size(); i++)
2215 strMediaFile = URIUtils::ReplaceExtension(pItem->GetPath(), extensions[i]);
2216 CFileItem item(strMediaFile, false);
2217 if (!item.IsCUESheet() && !item.IsPlayList() && Contains(strMediaFile))
2219 bFoundMediaFile = true;
2226 if (bFoundMediaFile)
2228 itemstodelete.push_back(pItem->GetPath());
2229 itemstodelete.push_back(strMediaFile);
2230 // get the additional stuff (year, genre etc.) from the underlying media files tag.
2232 auto_ptr<IMusicInfoTagLoader> pLoader (CMusicInfoTagLoaderFactory::CreateLoader(strMediaFile));
2233 if (NULL != pLoader.get())
2236 pLoader->Load(strMediaFile, tag);
2238 // fill in any missing entries from underlying media file
2239 for (int j = 0; j < (int)newitems.size(); j++)
2241 CSong song = newitems[j];
2242 // only for songs that actually match the current media file
2243 if (song.strFileName == fileFromCue)
2245 // we might have a new media file from the above matching code
2246 song.strFileName = strMediaFile;
2249 if (song.strAlbum.empty() && !tag.GetAlbum().empty()) song.strAlbum = tag.GetAlbum();
2250 if (song.albumArtist.empty() && !tag.GetAlbumArtist().empty()) song.albumArtist = tag.GetAlbumArtist();
2251 if (song.genre.empty() && !tag.GetGenre().empty()) song.genre = tag.GetGenre();
2252 if (song.artist.empty() && !tag.GetArtist().empty()) song.artist = tag.GetArtist();
2253 if (tag.GetDiscNumber()) song.iTrack |= (tag.GetDiscNumber() << 16); // see CMusicInfoTag::GetDiscNumber()
2254 SYSTEMTIME dateTime;
2255 tag.GetReleaseDate(dateTime);
2256 if (dateTime.wYear) song.iYear = dateTime.wYear;
2257 if (song.embeddedArt.empty() && !tag.GetCoverArtInfo().empty())
2258 song.embeddedArt = tag.GetCoverArtInfo();
2260 if (!song.iDuration && tag.GetDuration() > 0)
2261 { // must be the last song
2262 song.iDuration = (tag.GetDuration() * 75 - song.iStartOffset + 37) / 75;
2264 // add this item to the list
2265 itemstoadd.push_back(song);
2270 { // remove the .cue sheet from the directory
2271 itemstodelete.push_back(pItem->GetPath());
2276 { // remove the .cue sheet from the directory (can't parse it - no point listing it)
2277 itemstodelete.push_back(pItem->GetPath());
2282 // now delete the .CUE files and underlying media files.
2283 for (int i = 0; i < (int)itemstodelete.size(); i++)
2285 for (int j = 0; j < (int)m_items.size(); j++)
2287 CFileItemPtr pItem = m_items[j];
2288 if (stricmp(pItem->GetPath().c_str(), itemstodelete[i].c_str()) == 0)
2289 { // delete this item
2290 m_items.erase(m_items.begin() + j);
2295 // and add the files from the .CUE sheet
2296 for (int i = 0; i < (int)itemstoadd.size(); i++)
2298 // now create the file item, and add to the item list.
2299 CFileItemPtr pItem(new CFileItem(itemstoadd[i]));
2300 m_items.push_back(pItem);
2304 // Remove the extensions from the filenames
2305 void CFileItemList::RemoveExtensions()
2307 CSingleLock lock(m_lock);
2308 for (int i = 0; i < Size(); ++i)
2309 m_items[i]->RemoveExtension();
2312 void CFileItemList::Stack(bool stackFiles /* = true */)
2314 CSingleLock lock(m_lock);
2317 if (IsVirtualDirectoryRoot() || IsLiveTV() || IsSourcesPath())
2320 SetProperty("isstacked", true);
2322 // items needs to be sorted for stuff below to work properly
2323 Sort(SortByLabel, SortOrderAscending);
2331 void CFileItemList::StackFolders()
2333 // Precompile our REs
2334 VECCREGEXP folderRegExps;
2335 CRegExp folderRegExp(true, CRegExp::autoUtf8);
2336 const CStdStringArray& strFolderRegExps = g_advancedSettings.m_folderStackRegExps;
2338 CStdStringArray::const_iterator strExpression = strFolderRegExps.begin();
2339 while (strExpression != strFolderRegExps.end())
2341 if (!folderRegExp.RegComp(*strExpression))
2342 CLog::Log(LOGERROR, "%s: Invalid folder stack RegExp:'%s'", __FUNCTION__, strExpression->c_str());
2344 folderRegExps.push_back(folderRegExp);
2350 for (int i = 0; i < Size(); i++)
2352 CFileItemPtr item = Get(i);
2353 // combined the folder checks
2354 if (item->m_bIsFolder)
2356 // only check known fast sources?
2358 // 1. rars and zips may be on slow sources? is this supposed to be allowed?
2359 if( !item->IsRemote()
2363 || URIUtils::IsInRAR(item->GetPath())
2364 || URIUtils::IsInZIP(item->GetPath())
2365 || URIUtils::IsOnLAN(item->GetPath())
2368 // stack cd# folders if contains only a single video file
2372 VECCREGEXP::iterator expr = folderRegExps.begin();
2373 while (!bMatch && expr != folderRegExps.end())
2375 //CLog::Log(LOGDEBUG,"%s: Running expression %s on %s", __FUNCTION__, expr->GetPattern().c_str(), item->GetLabel().c_str());
2376 bMatch = (expr->RegFind(item->GetLabel().c_str()) != -1);
2379 CFileItemList items;
2380 CDirectory::GetDirectory(item->GetPath(),items,g_advancedSettings.m_videoExtensions);
2381 // optimized to only traverse listing once by checking for filecount
2382 // and recording last file item for later use
2385 for (int j = 0; j < items.Size(); j++)
2387 if (!items[j]->m_bIsFolder)
2398 *item = *items[index];
2403 // check for dvd folders
2406 std::string dvdPath = item->GetOpticalMediaPath();
2408 if (!dvdPath.empty())
2410 // NOTE: should this be done for the CD# folders too?
2411 item->m_bIsFolder = false;
2412 item->SetPath(dvdPath);
2413 item->SetLabel2("");
2414 item->SetLabelPreformated(true);
2415 m_sortDescription.sortBy = SortByNone; /* sorting is now broken */
2423 void CFileItemList::StackFiles()
2425 // Precompile our REs
2426 VECCREGEXP stackRegExps;
2427 CRegExp tmpRegExp(true, CRegExp::autoUtf8);
2428 const CStdStringArray& strStackRegExps = g_advancedSettings.m_videoStackRegExps;
2429 CStdStringArray::const_iterator strRegExp = strStackRegExps.begin();
2430 while (strRegExp != strStackRegExps.end())
2432 if (tmpRegExp.RegComp(*strRegExp))
2434 if (tmpRegExp.GetCaptureTotal() == 4)
2435 stackRegExps.push_back(tmpRegExp);
2437 CLog::Log(LOGERROR, "Invalid video stack RE (%s). Must have 4 captures.", strRegExp->c_str());
2442 // now stack the files, some of which may be from the previous stack iteration
2446 CFileItemPtr item1 = Get(i);
2448 // skip folders, nfo files, playlists
2449 if (item1->m_bIsFolder
2450 || item1->IsParentFolder()
2452 || item1->IsPlayList()
2462 CStdString stackName;
2464 CStdString filePath;
2466 VECCREGEXP::iterator expr = stackRegExps.begin();
2468 URIUtils::Split(item1->GetPath(), filePath, file1);
2469 if (URIUtils::ProtocolHasEncodedFilename(CURL(filePath).GetProtocol() ) )
2470 file1 = CURL::Decode(file1);
2473 while (expr != stackRegExps.end())
2475 if (expr->RegFind(file1, offset) != -1)
2477 CStdString Title1 = expr->GetMatch(1),
2478 Volume1 = expr->GetMatch(2),
2479 Ignore1 = expr->GetMatch(3),
2480 Extension1 = expr->GetMatch(4);
2482 Title1 = file1.substr(0, expr->GetSubStart(2));
2486 CFileItemPtr item2 = Get(j);
2488 // skip folders, nfo files, playlists
2489 if (item2->m_bIsFolder
2490 || item2->IsParentFolder()
2492 || item2->IsPlayList()
2500 CStdString file2, filePath2;
2501 URIUtils::Split(item2->GetPath(), filePath2, file2);
2502 if (URIUtils::ProtocolHasEncodedFilename(CURL(filePath2).GetProtocol() ) )
2503 file2 = CURL::Decode(file2);
2505 if (expr->RegFind(file2, offset) != -1)
2507 CStdString Title2 = expr->GetMatch(1),
2508 Volume2 = expr->GetMatch(2),
2509 Ignore2 = expr->GetMatch(3),
2510 Extension2 = expr->GetMatch(4);
2512 Title2 = file2.substr(0, expr->GetSubStart(2));
2513 if (Title1.Equals(Title2))
2515 if (!Volume1.Equals(Volume2))
2517 if (Ignore1.Equals(Ignore2) && Extension1.Equals(Extension2))
2519 if (stack.size() == 0)
2521 stackName = Title1 + Ignore1 + Extension1;
2523 size += item1->m_dwSize;
2526 size += item2->m_dwSize;
2535 else if (!Ignore1.Equals(Ignore2)) // False positive, try again with offset
2537 offset = expr->GetSubStart(3);
2540 else // Extension mismatch
2547 else // Title mismatch
2554 else // No match 2, next expression
2563 expr = stackRegExps.end();
2570 if (stack.size() > 1)
2572 // have a stack, remove the items and add the stacked item
2573 // dont actually stack a multipart rar set, just remove all items but the first
2574 CStdString stackPath;
2575 if (Get(stack[0])->IsRAR())
2576 stackPath = Get(stack[0])->GetPath();
2579 CStackDirectory dir;
2580 stackPath = dir.ConstructStackPath(*this, stack);
2582 item1->SetPath(stackPath);
2584 for (unsigned k = 1; k < stack.size(); k++)
2586 // item->m_bIsFolder = true; // don't treat stacked files as folders
2587 // the label may be in a different char set from the filename (eg over smb
2588 // the label is converted from utf8, but the filename is not)
2589 if (!CSettings::Get().GetBool("filelists.showextensions"))
2590 URIUtils::RemoveExtension(stackName);
2592 item1->SetLabel(stackName);
2593 item1->m_dwSize = size;
2601 bool CFileItemList::Load(int windowID)
2604 if (file.Open(GetDiscFileCache(windowID)))
2606 CArchive ar(&file, CArchive::load);
2608 CLog::Log(LOGDEBUG,"Loading items: %i, directory: %s sort method: %i, ascending: %s", Size(), CURL::GetRedacted(GetPath()).c_str(), m_sortDescription.sortBy,
2609 m_sortDescription.sortOrder == SortOrderAscending ? "true" : "false");
2618 bool CFileItemList::Save(int windowID)
2624 CLog::Log(LOGDEBUG,"Saving fileitems [%s]", CURL::GetRedacted(GetPath()).c_str());
2627 if (file.OpenForWrite(GetDiscFileCache(windowID), true)) // overwrite always
2629 CArchive ar(&file, CArchive::store);
2631 CLog::Log(LOGDEBUG," -- items: %i, sort method: %i, ascending: %s", iSize, m_sortDescription.sortBy, m_sortDescription.sortOrder == SortOrderAscending ? "true" : "false");
2640 void CFileItemList::RemoveDiscCache(int windowID) const
2642 CStdString cacheFile(GetDiscFileCache(windowID));
2643 if (CFile::Exists(cacheFile))
2645 CLog::Log(LOGDEBUG,"Clearing cached fileitems [%s]",GetPath().c_str());
2646 CFile::Delete(cacheFile);
2650 CStdString CFileItemList::GetDiscFileCache(int windowID) const
2652 CStdString strPath(GetPath());
2653 URIUtils::RemoveSlashAtEnd(strPath);
2656 crc.ComputeFromLowerCase(strPath);
2658 CStdString cacheFile;
2659 if (IsCDDA() || IsOnDVD())
2660 cacheFile = StringUtils::Format("special://temp/r-%08x.fi", (unsigned __int32)crc);
2661 else if (IsMusicDb())
2662 cacheFile = StringUtils::Format("special://temp/mdb-%08x.fi", (unsigned __int32)crc);
2663 else if (IsVideoDb())
2664 cacheFile = StringUtils::Format("special://temp/vdb-%08x.fi", (unsigned __int32)crc);
2665 else if (IsSmartPlayList())
2666 cacheFile = StringUtils::Format("special://temp/sp-%08x.fi", (unsigned __int32)crc);
2668 cacheFile = StringUtils::Format("special://temp/%i-%08x.fi", windowID, (unsigned __int32)crc);
2670 cacheFile = StringUtils::Format("special://temp/%08x.fi", (unsigned __int32)crc);
2674 bool CFileItemList::AlwaysCache() const
2676 // some database folders are always cached
2678 return CMusicDatabaseDirectory::CanCache(GetPath());
2680 return CVideoDatabaseDirectory::CanCache(GetPath());
2682 return true; // always cache
2686 CStdString CFileItem::GetUserMusicThumb(bool alwaysCheckRemote /* = false */, bool fallbackToFolder /* = false */) const
2688 if (m_strPath.empty()
2689 || StringUtils::StartsWithNoCase(m_strPath, "newsmartplaylist://")
2690 || StringUtils::StartsWithNoCase(m_strPath, "newplaylist://")
2691 || m_bIsShareOrDrive
2692 || IsInternetStream()
2693 || URIUtils::IsUPnP(m_strPath)
2694 || (URIUtils::IsFTP(m_strPath) && !g_advancedSettings.m_bFTPThumbs)
2701 // we first check for <filename>.tbn or <foldername>.tbn
2702 CStdString fileThumb(GetTBNFile());
2703 if (CFile::Exists(fileThumb))
2706 // Fall back to folder thumb, if requested
2707 if (!m_bIsFolder && fallbackToFolder)
2709 CFileItem item(URIUtils::GetDirectory(m_strPath), true);
2710 return item.GetUserMusicThumb(alwaysCheckRemote);
2713 // if a folder, check for folder.jpg
2714 if (m_bIsFolder && !IsFileFolder() && (!IsRemote() || alwaysCheckRemote || CSettings::Get().GetBool("musicfiles.findremotethumbs")))
2716 CStdStringArray thumbs;
2717 StringUtils::SplitString(g_advancedSettings.m_musicThumbs, "|", thumbs);
2718 for (unsigned int i = 0; i < thumbs.size(); ++i)
2720 CStdString folderThumb(GetFolderThumb(thumbs[i]));
2721 if (CFile::Exists(folderThumb))
2731 // Gets the .tbn filename from a file or folder name.
2732 // <filename>.ext -> <filename>.tbn
2733 // <foldername>/ -> <foldername>.tbn
2734 CStdString CFileItem::GetTBNFile() const
2736 CStdString thumbFile;
2737 CStdString strFile = m_strPath;
2741 CStdString strPath, strReturn;
2742 URIUtils::GetParentPath(m_strPath,strPath);
2743 CFileItem item(CStackDirectory::GetFirstStackedFile(strFile),false);
2744 CStdString strTBNFile = item.GetTBNFile();
2745 strReturn = URIUtils::AddFileToFolder(strPath, URIUtils::GetFileName(strTBNFile));
2746 if (CFile::Exists(strReturn))
2749 strFile = URIUtils::AddFileToFolder(strPath,URIUtils::GetFileName(CStackDirectory::GetStackedTitlePath(strFile)));
2752 if (URIUtils::IsInRAR(strFile) || URIUtils::IsInZIP(strFile))
2754 CStdString strPath = URIUtils::GetDirectory(strFile);
2755 CStdString strParent;
2756 URIUtils::GetParentPath(strPath,strParent);
2757 strFile = URIUtils::AddFileToFolder(strParent, URIUtils::GetFileName(m_strPath));
2761 strFile = url.GetFileName();
2763 if (m_bIsFolder && !IsFileFolder())
2764 URIUtils::RemoveSlashAtEnd(strFile);
2766 if (!strFile.empty())
2768 if (m_bIsFolder && !IsFileFolder())
2769 thumbFile = strFile + ".tbn"; // folder, so just add ".tbn"
2771 thumbFile = URIUtils::ReplaceExtension(strFile, ".tbn");
2772 url.SetFileName(thumbFile);
2773 thumbFile = url.Get();
2778 bool CFileItem::SkipLocalArt() const
2780 return (m_strPath.empty()
2781 || StringUtils::StartsWithNoCase(m_strPath, "newsmartplaylist://")
2782 || StringUtils::StartsWithNoCase(m_strPath, "newplaylist://")
2783 || m_bIsShareOrDrive
2784 || IsInternetStream()
2785 || URIUtils::IsUPnP(m_strPath)
2786 || (URIUtils::IsFTP(m_strPath) && !g_advancedSettings.m_bFTPThumbs)
2794 CStdString CFileItem::FindLocalArt(const std::string &artFile, bool useFolder) const
2802 thumb = GetLocalArt(artFile, false);
2803 if (!thumb.empty() && CFile::Exists(thumb))
2806 if ((useFolder || (m_bIsFolder && !IsFileFolder())) && !artFile.empty())
2808 CStdString thumb2 = GetLocalArt(artFile, true);
2809 if (!thumb2.empty() && thumb2 != thumb && CFile::Exists(thumb2))
2815 CStdString CFileItem::GetLocalArt(const std::string &artFile, bool useFolder) const
2817 // no retrieving of empty art files from folders
2818 if (useFolder && artFile.empty())
2821 CStdString strFile = m_strPath;
2824 /* CFileItem item(CStackDirectory::GetFirstStackedFile(strFile),false);
2825 CStdString localArt = item.GetLocalArt(artFile);
2829 URIUtils::GetParentPath(m_strPath,strPath);
2830 strFile = URIUtils::AddFileToFolder(strPath, URIUtils::GetFileName(CStackDirectory::GetStackedTitlePath(strFile)));
2833 if (URIUtils::IsInRAR(strFile) || URIUtils::IsInZIP(strFile))
2835 CStdString strPath = URIUtils::GetDirectory(strFile);
2836 CStdString strParent;
2837 URIUtils::GetParentPath(strPath,strParent);
2838 strFile = URIUtils::AddFileToFolder(strParent, URIUtils::GetFileName(strFile));
2842 strFile = CMultiPathDirectory::GetFirstPath(m_strPath);
2844 if (IsOpticalMediaFile())
2845 { // optical media files should be treated like folders
2847 strFile = GetLocalMetadataPath();
2849 else if (useFolder && !(m_bIsFolder && !IsFileFolder()))
2850 strFile = URIUtils::GetDirectory(strFile);
2852 if (strFile.empty()) // empty filepath -> nothing to find
2857 if (!artFile.empty())
2858 return URIUtils::AddFileToFolder(strFile, artFile);
2862 if (artFile.empty()) // old thumbnail matching
2863 return URIUtils::ReplaceExtension(strFile, ".tbn");
2865 return URIUtils::ReplaceExtension(strFile, "-" + artFile);
2870 CStdString CFileItem::GetFolderThumb(const CStdString &folderJPG /* = "folder.jpg" */) const
2872 CStdString strFolder = m_strPath;
2875 URIUtils::IsInRAR(strFolder) ||
2876 URIUtils::IsInZIP(strFolder))
2878 URIUtils::GetParentPath(m_strPath,strFolder);
2882 strFolder = CMultiPathDirectory::GetFirstPath(m_strPath);
2884 return URIUtils::AddFileToFolder(strFolder, folderJPG);
2887 CStdString CFileItem::GetMovieName(bool bUseFolderNames /* = false */) const
2889 if (IsLabelPreformated())
2892 if (m_pvrRecordingInfoTag)
2893 return m_pvrRecordingInfoTag->m_strTitle;
2894 else if (CUtil::IsTVRecording(m_strPath))
2896 CStdString title = CPVRRecording::GetTitleFromURL(m_strPath);
2901 CStdString strMovieName = GetBaseMoviePath(bUseFolderNames);
2903 if (URIUtils::IsStack(strMovieName))
2904 strMovieName = CStackDirectory::GetStackedTitlePath(strMovieName);
2906 URIUtils::RemoveSlashAtEnd(strMovieName);
2908 return CURL::Decode(URIUtils::GetFileName(strMovieName));
2911 CStdString CFileItem::GetBaseMoviePath(bool bUseFolderNames) const
2913 CStdString strMovieName = m_strPath;
2916 strMovieName = CMultiPathDirectory::GetFirstPath(m_strPath);
2918 if (IsOpticalMediaFile())
2919 return GetLocalMetadataPath();
2921 if ((!m_bIsFolder || URIUtils::IsInArchive(m_strPath)) && bUseFolderNames)
2923 CStdString name2(strMovieName);
2924 URIUtils::GetParentPath(name2,strMovieName);
2925 if (URIUtils::IsInArchive(m_strPath))
2927 CStdString strArchivePath;
2928 URIUtils::GetParentPath(strMovieName, strArchivePath);
2929 strMovieName = strArchivePath;
2933 return strMovieName;
2936 CStdString CFileItem::GetLocalFanart() const
2940 if (!HasVideoInfoTag())
2941 return ""; // nothing can be done
2942 CFileItem dbItem(m_bIsFolder ? GetVideoInfoTag()->m_strPath : GetVideoInfoTag()->m_strFileNameAndPath, m_bIsFolder);
2943 return dbItem.GetLocalFanart();
2946 CStdString strFile2;
2947 CStdString strFile = m_strPath;
2951 URIUtils::GetParentPath(m_strPath,strPath);
2952 CStackDirectory dir;
2953 CStdString strPath2;
2954 strPath2 = dir.GetStackedTitlePath(strFile);
2955 strFile = URIUtils::AddFileToFolder(strPath, URIUtils::GetFileName(strPath2));
2956 CFileItem item(dir.GetFirstStackedFile(m_strPath),false);
2957 CStdString strTBNFile(URIUtils::ReplaceExtension(item.GetTBNFile(), "-fanart"));
2958 strFile2 = URIUtils::AddFileToFolder(strPath, URIUtils::GetFileName(strTBNFile));
2960 if (URIUtils::IsInRAR(strFile) || URIUtils::IsInZIP(strFile))
2962 CStdString strPath = URIUtils::GetDirectory(strFile);
2963 CStdString strParent;
2964 URIUtils::GetParentPath(strPath,strParent);
2965 strFile = URIUtils::AddFileToFolder(strParent, URIUtils::GetFileName(m_strPath));
2968 // no local fanart available for these
2969 if (IsInternetStream()
2970 || URIUtils::IsUPnP(strFile)
2971 || URIUtils::IsBluray(strFile)
2976 || (URIUtils::IsFTP(strFile) && !g_advancedSettings.m_bFTPThumbs)
2977 || m_strPath.empty())
2980 CStdString strDir = URIUtils::GetDirectory(strFile);
2985 CFileItemList items;
2986 CDirectory::GetDirectory(strDir, items, g_advancedSettings.m_pictureExtensions, DIR_FLAG_NO_FILE_DIRS | DIR_FLAG_READ_CACHE | DIR_FLAG_NO_FILE_INFO);
2987 if (IsOpticalMediaFile())
2988 { // grab from the optical media parent folder as well
2989 CFileItemList moreItems;
2990 CDirectory::GetDirectory(GetLocalMetadataPath(), moreItems, g_advancedSettings.m_pictureExtensions, DIR_FLAG_NO_FILE_DIRS | DIR_FLAG_READ_CACHE | DIR_FLAG_NO_FILE_INFO);
2991 items.Append(moreItems);
2994 CStdStringArray fanarts;
2995 StringUtils::SplitString(g_advancedSettings.m_fanartImages, "|", fanarts);
2997 strFile = URIUtils::ReplaceExtension(strFile, "-fanart");
2998 fanarts.insert(m_bIsFolder ? fanarts.end() : fanarts.begin(), URIUtils::GetFileName(strFile));
3000 if (!strFile2.empty())
3001 fanarts.insert(m_bIsFolder ? fanarts.end() : fanarts.begin(), URIUtils::GetFileName(strFile2));
3003 for (unsigned int i = 0; i < fanarts.size(); ++i)
3005 for (int j = 0; j < items.Size(); j++)
3007 CStdString strCandidate = URIUtils::GetFileName(items[j]->m_strPath);
3008 URIUtils::RemoveExtension(strCandidate);
3009 CStdString strFanart = fanarts[i];
3010 URIUtils::RemoveExtension(strFanart);
3011 if (StringUtils::EqualsNoCase(strCandidate, strFanart))
3012 return items[j]->m_strPath;
3019 CStdString CFileItem::GetLocalMetadataPath() const
3021 if (m_bIsFolder && !IsFileFolder())
3024 CStdString parent(URIUtils::GetParentPath(m_strPath));
3025 CStdString parentFolder(parent);
3026 URIUtils::RemoveSlashAtEnd(parentFolder);
3027 parentFolder = URIUtils::GetFileName(parentFolder);
3028 if (StringUtils::EqualsNoCase(parentFolder, "VIDEO_TS") || StringUtils::EqualsNoCase(parentFolder, "BDMV"))
3029 { // go back up another one
3030 parent = URIUtils::GetParentPath(parent);
3035 bool CFileItem::LoadMusicTag()
3041 if (HasMusicInfoTag() && m_musicInfoTag->Loaded())
3044 CMusicDatabase musicDatabase;
3045 if (musicDatabase.Open())
3048 if (musicDatabase.GetSongByFileName(m_strPath, song))
3050 GetMusicInfoTag()->SetSong(song);
3051 SetArt("thumb", song.strThumb);
3054 musicDatabase.Close();
3056 // load tag from file
3057 CLog::Log(LOGDEBUG, "%s: loading tag information for file: %s", __FUNCTION__, m_strPath.c_str());
3058 CMusicInfoTagLoaderFactory factory;
3059 auto_ptr<IMusicInfoTagLoader> pLoader (factory.CreateLoader(m_strPath));
3060 if (NULL != pLoader.get())
3062 if (pLoader->Load(m_strPath, *GetMusicInfoTag()))
3065 // no tag - try some other things
3068 // we have the tracknumber...
3069 int iTrack = GetMusicInfoTag()->GetTrackNumber();
3072 CStdString strText = g_localizeStrings.Get(554); // "Track"
3073 if (!strText.empty() && strText[strText.size() - 1] != ' ')
3075 CStdString strTrack = StringUtils::Format(strText + "%i", iTrack);
3076 GetMusicInfoTag()->SetTitle(strTrack);
3077 GetMusicInfoTag()->SetLoaded(true);
3083 CStdString fileName = URIUtils::GetFileName(m_strPath);
3084 URIUtils::RemoveExtension(fileName);
3085 for (unsigned int i = 0; i < g_advancedSettings.m_musicTagsFromFileFilters.size(); i++)
3087 CLabelFormatter formatter(g_advancedSettings.m_musicTagsFromFileFilters[i], "");
3088 if (formatter.FillMusicTag(fileName, GetMusicInfoTag()))
3090 GetMusicInfoTag()->SetLoaded(true);
3098 void CFileItemList::Swap(unsigned int item1, unsigned int item2)
3100 if (item1 != item2 && item1 < m_items.size() && item2 < m_items.size())
3101 std::swap(m_items[item1], m_items[item2]);
3104 bool CFileItemList::UpdateItem(const CFileItem *item)
3106 if (!item) return false;
3108 CSingleLock lock(m_lock);
3109 for (unsigned int i = 0; i < m_items.size(); i++)
3111 CFileItemPtr pItem = m_items[i];
3112 if (pItem->IsSamePath(item))
3114 pItem->UpdateInfo(*item);
3121 void CFileItemList::AddSortMethod(SortBy sortBy, int buttonLabel, const LABEL_MASKS &labelMasks, SortAttribute sortAttributes /* = SortAttributeNone */)
3123 AddSortMethod(sortBy, sortAttributes, buttonLabel, labelMasks);
3126 void CFileItemList::AddSortMethod(SortBy sortBy, SortAttribute sortAttributes, int buttonLabel, const LABEL_MASKS &labelMasks)
3128 SortDescription sorting;
3129 sorting.sortBy = sortBy;
3130 sorting.sortAttributes = sortAttributes;
3132 AddSortMethod(sorting, buttonLabel, labelMasks);
3135 void CFileItemList::AddSortMethod(SortDescription sortDescription, int buttonLabel, const LABEL_MASKS &labelMasks)
3137 SORT_METHOD_DETAILS sort;
3138 sort.m_sortDescription = sortDescription;
3139 sort.m_buttonLabel = buttonLabel;
3140 sort.m_labelMasks = labelMasks;
3142 m_sortDetails.push_back(sort);
3145 void CFileItemList::SetReplaceListing(bool replace)
3147 m_replaceListing = replace;
3150 void CFileItemList::ClearSortState()
3152 m_sortDescription.sortBy = SortByNone;
3153 m_sortDescription.sortOrder = SortOrderNone;
3154 m_sortDescription.sortAttributes = SortAttributeNone;
3157 CVideoInfoTag* CFileItem::GetVideoInfoTag()
3159 if (!m_videoInfoTag)
3160 m_videoInfoTag = new CVideoInfoTag;
3162 return m_videoInfoTag;
3165 CEpgInfoTag* CFileItem::GetEPGInfoTag()
3168 m_epgInfoTag = new CEpgInfoTag;
3170 return m_epgInfoTag;
3173 CPVRChannel* CFileItem::GetPVRChannelInfoTag()
3175 if (!m_pvrChannelInfoTag)
3176 m_pvrChannelInfoTag = new CPVRChannel;
3178 return m_pvrChannelInfoTag;
3181 CPVRRecording* CFileItem::GetPVRRecordingInfoTag()
3183 if (!m_pvrRecordingInfoTag)
3184 m_pvrRecordingInfoTag = new CPVRRecording;
3186 return m_pvrRecordingInfoTag;
3189 CPVRTimerInfoTag* CFileItem::GetPVRTimerInfoTag()
3191 if (!m_pvrTimerInfoTag)
3192 m_pvrTimerInfoTag = new CPVRTimerInfoTag;
3194 return m_pvrTimerInfoTag;
3197 CPictureInfoTag* CFileItem::GetPictureInfoTag()
3199 if (!m_pictureInfoTag)
3200 m_pictureInfoTag = new CPictureInfoTag;
3202 return m_pictureInfoTag;
3205 MUSIC_INFO::CMusicInfoTag* CFileItem::GetMusicInfoTag()
3207 if (!m_musicInfoTag)
3208 m_musicInfoTag = new MUSIC_INFO::CMusicInfoTag;
3210 return m_musicInfoTag;
3213 CStdString CFileItem::FindTrailer() const
3215 CStdString strFile2;
3216 CStdString strFile = m_strPath;
3220 URIUtils::GetParentPath(m_strPath,strPath);
3221 CStackDirectory dir;
3222 CStdString strPath2;
3223 strPath2 = dir.GetStackedTitlePath(strFile);
3224 strFile = URIUtils::AddFileToFolder(strPath,URIUtils::GetFileName(strPath2));
3225 CFileItem item(dir.GetFirstStackedFile(m_strPath),false);
3226 CStdString strTBNFile(URIUtils::ReplaceExtension(item.GetTBNFile(), "-trailer"));
3227 strFile2 = URIUtils::AddFileToFolder(strPath,URIUtils::GetFileName(strTBNFile));
3229 if (URIUtils::IsInRAR(strFile) || URIUtils::IsInZIP(strFile))
3231 CStdString strPath = URIUtils::GetDirectory(strFile);
3232 CStdString strParent;
3233 URIUtils::GetParentPath(strPath,strParent);
3234 strFile = URIUtils::AddFileToFolder(strParent,URIUtils::GetFileName(m_strPath));
3237 // no local trailer available for these
3238 if (IsInternetStream()
3239 || URIUtils::IsUPnP(strFile)
3240 || URIUtils::IsBluray(strFile)
3246 CStdString strDir = URIUtils::GetDirectory(strFile);
3247 CFileItemList items;
3248 CDirectory::GetDirectory(strDir, items, g_advancedSettings.m_videoExtensions, DIR_FLAG_READ_CACHE | DIR_FLAG_NO_FILE_INFO | DIR_FLAG_NO_FILE_DIRS);
3249 URIUtils::RemoveExtension(strFile);
3250 strFile += "-trailer";
3251 CStdString strFile3 = URIUtils::AddFileToFolder(strDir, "movie-trailer");
3253 // Precompile our REs
3254 VECCREGEXP matchRegExps;
3255 CRegExp tmpRegExp(true, CRegExp::autoUtf8);
3256 const CStdStringArray& strMatchRegExps = g_advancedSettings.m_trailerMatchRegExps;
3258 CStdStringArray::const_iterator strRegExp = strMatchRegExps.begin();
3259 while (strRegExp != strMatchRegExps.end())
3261 if (tmpRegExp.RegComp(*strRegExp))
3263 matchRegExps.push_back(tmpRegExp);
3268 CStdString strTrailer;
3269 for (int i = 0; i < items.Size(); i++)
3271 CStdString strCandidate = items[i]->m_strPath;
3272 URIUtils::RemoveExtension(strCandidate);
3273 if (StringUtils::EqualsNoCase(strCandidate, strFile) ||
3274 StringUtils::EqualsNoCase(strCandidate, strFile2) ||
3275 StringUtils::EqualsNoCase(strCandidate, strFile3))
3277 strTrailer = items[i]->m_strPath;
3282 VECCREGEXP::iterator expr = matchRegExps.begin();
3284 while (expr != matchRegExps.end())
3286 if (expr->RegFind(strCandidate) != -1)
3288 strTrailer = items[i]->m_strPath;
3300 int CFileItem::GetVideoContentType() const
3302 VIDEODB_CONTENT_TYPE type = VIDEODB_CONTENT_MOVIES;
3303 if (HasVideoInfoTag() && !GetVideoInfoTag()->m_strShowTitle.empty()) // tvshow
3304 type = VIDEODB_CONTENT_TVSHOWS;
3305 if (HasVideoInfoTag() && GetVideoInfoTag()->m_iSeason > -1 && !m_bIsFolder) // episode
3306 return VIDEODB_CONTENT_EPISODES;
3307 if (HasVideoInfoTag() && !GetVideoInfoTag()->m_artist.empty()) // music video
3308 return VIDEODB_CONTENT_MUSICVIDEOS;
3310 CVideoDatabaseDirectory dir;
3311 VIDEODATABASEDIRECTORY::CQueryParams params;
3312 dir.GetQueryParams(m_strPath, params);
3313 if (params.GetSetId() != -1 && params.GetMovieId() == -1) // movie set
3314 return VIDEODB_CONTENT_MOVIE_SETS;