-
Notifications
You must be signed in to change notification settings - Fork 0
/
GUIMediaWindow.cpp
2279 lines (1988 loc) · 67.8 KB
/
GUIMediaWindow.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (C) 2005-2018 Team Kodi
* This file is part of Kodi - https://kodi.tv
*
* SPDX-License-Identifier: GPL-2.0-or-later
* See LICENSES/README.md for more information.
*/
#include "GUIMediaWindow.h"
#include "Application.h"
#include "ServiceBroker.h"
#include "messaging/ApplicationMessenger.h"
#include "ContextMenuManager.h"
#include "FileItemListModification.h"
#include "GUIPassword.h"
#include "GUIUserMessages.h"
#include "PartyModeManager.h"
#include "PlayListPlayer.h"
#include "URL.h"
#include "Util.h"
#include "addons/AddonManager.h"
#include "addons/PluginSource.h"
#if defined(TARGET_ANDROID)
#include "platform/android/activity/XBMCApp.h"
#endif
#include "dialogs/GUIDialogBusy.h"
#include "dialogs/GUIDialogKaiToast.h"
#include "dialogs/GUIDialogMediaFilter.h"
#include "dialogs/GUIDialogProgress.h"
#include "dialogs/GUIDialogSmartPlaylistEditor.h"
#include "filesystem/File.h"
#include "filesystem/DirectoryFactory.h"
#include "filesystem/FileDirectoryFactory.h"
#include "filesystem/MultiPathDirectory.h"
#include "filesystem/PluginDirectory.h"
#include "filesystem/SmartPlaylistDirectory.h"
#include "guilib/GUIComponent.h"
#include "guilib/GUIEditControl.h"
#include "guilib/GUIKeyboardFactory.h"
#include "guilib/GUIWindowManager.h"
#include "guilib/LocalizeStrings.h"
#include "interfaces/generic/ScriptInvocationManager.h"
#include "input/Key.h"
#include "messaging/helpers/DialogOKHelper.h"
#include "network/Network.h"
#include "playlists/PlayList.h"
#include "profiles/ProfileManager.h"
#include "settings/AdvancedSettings.h"
#include "settings/Settings.h"
#include "settings/SettingsComponent.h"
#include "storage/MediaManager.h"
#include "threads/IRunnable.h"
#include "threads/SystemClock.h"
#include "utils/FileUtils.h"
#include "utils/LabelFormatter.h"
#include "utils/log.h"
#include "utils/SortUtils.h"
#include "utils/StringUtils.h"
#include "utils/URIUtils.h"
#include "utils/Variant.h"
#include "view/GUIViewState.h"
#include <inttypes.h>
#define CONTROL_BTNVIEWASICONS 2
#define CONTROL_BTNSORTBY 3
#define CONTROL_BTNSORTASC 4
#define CONTROL_BTN_FILTER 19
#define CONTROL_LABELFILES 12
#define PROPERTY_PATH_DB "path.db"
#define PROPERTY_SORT_ORDER "sort.order"
#define PROPERTY_SORT_ASCENDING "sort.ascending"
#define PLUGIN_REFRESH_DELAY 200
using namespace ADDON;
using namespace KODI::MESSAGING;
namespace
{
class CGetDirectoryItems : public IRunnable
{
public:
CGetDirectoryItems(XFILE::CVirtualDirectory &dir, CURL &url, CFileItemList &items, bool useDir)
: m_dir(dir), m_url(url), m_items(items), m_useDir(useDir)
{
}
void Run() override
{
m_result = m_dir.GetDirectory(m_url, m_items, m_useDir, true);
}
void Cancel() override
{
m_dir.CancelDirectory();
}
bool m_result = false;
protected:
XFILE::CVirtualDirectory &m_dir;
CURL m_url;
CFileItemList &m_items;
bool m_useDir;
};
}
CGUIMediaWindow::CGUIMediaWindow(int id, const char *xmlFile)
: CGUIWindow(id, xmlFile)
{
m_loadType = KEEP_IN_MEMORY;
m_vecItems = new CFileItemList;
m_unfilteredItems = new CFileItemList;
m_vecItems->SetPath("?");
m_iLastControl = -1;
m_canFilterAdvanced = false;
m_guiState.reset(CGUIViewState::GetViewState(GetID(), *m_vecItems));
}
CGUIMediaWindow::~CGUIMediaWindow()
{
delete m_vecItems;
delete m_unfilteredItems;
}
bool CGUIMediaWindow::Load(TiXmlElement *pRootElement)
{
bool retVal = CGUIWindow::Load(pRootElement);
if (!retVal)
return false;
// configure our view control
m_viewControl.Reset();
m_viewControl.SetParentWindow(GetID());
TiXmlElement *element = pRootElement->FirstChildElement("views");
if (element && element->FirstChild())
{ // format is <views>50,29,51,95</views>
const std::string &allViews = element->FirstChild()->ValueStr();
std::vector<std::string> views = StringUtils::Split(allViews, ",");
for (std::vector<std::string>::const_iterator i = views.begin(); i != views.end(); ++i)
{
int controlID = atol(i->c_str());
CGUIControl *control = GetControl(controlID);
if (control && control->IsContainer())
m_viewControl.AddView(control);
}
}
m_viewControl.SetViewControlID(CONTROL_BTNVIEWASICONS);
return true;
}
void CGUIMediaWindow::OnWindowLoaded()
{
SendMessage(GUI_MSG_SET_TYPE, CONTROL_BTN_FILTER, CGUIEditControl::INPUT_TYPE_FILTER);
CGUIWindow::OnWindowLoaded();
SetupShares();
}
void CGUIMediaWindow::OnWindowUnload()
{
CGUIWindow::OnWindowUnload();
m_viewControl.Reset();
}
CFileItemPtr CGUIMediaWindow::GetCurrentListItem(int offset)
{
int item = m_viewControl.GetSelectedItem();
if (!m_vecItems->Size() || item < 0)
return CFileItemPtr();
item = (item + offset) % m_vecItems->Size();
if (item < 0) item += m_vecItems->Size();
return m_vecItems->Get(item);
}
bool CGUIMediaWindow::OnAction(const CAction &action)
{
if (action.GetID() == ACTION_PARENT_DIR)
{
GoParentFolder();
return true;
}
// the non-contextual menu can be called at any time
if (action.GetID() == ACTION_CONTEXT_MENU && !m_viewControl.HasControl(GetFocusedControlID()))
{
OnPopupMenu(-1);
return true;
}
if (CGUIWindow::OnAction(action))
return true;
if (action.GetID() == ACTION_FILTER)
return Filter();
// live filtering
if (action.GetID() == ACTION_FILTER_CLEAR)
{
CGUIMessage message(GUI_MSG_NOTIFY_ALL, GetID(), 0, GUI_MSG_FILTER_ITEMS);
message.SetStringParam("");
OnMessage(message);
return true;
}
if (action.GetID() == ACTION_BACKSPACE)
{
CGUIMessage message(GUI_MSG_NOTIFY_ALL, GetID(), 0, GUI_MSG_FILTER_ITEMS, 2); // 2 for delete
OnMessage(message);
return true;
}
if (action.GetID() >= ACTION_FILTER_SMS2 && action.GetID() <= ACTION_FILTER_SMS9)
{
std::string filter = StringUtils::Format("%i", action.GetID() - ACTION_FILTER_SMS2 + 2);
CGUIMessage message(GUI_MSG_NOTIFY_ALL, GetID(), 0, GUI_MSG_FILTER_ITEMS, 1); // 1 for append
message.SetStringParam(filter);
OnMessage(message);
return true;
}
return false;
}
bool CGUIMediaWindow::OnBack(int actionID)
{
CancelUpdateItems();
CURL filterUrl(m_strFilterPath);
if (actionID == ACTION_NAV_BACK &&
!m_vecItems->IsVirtualDirectoryRoot() &&
!URIUtils::PathEquals(m_vecItems->GetPath(), GetRootPath(), true) &&
(!URIUtils::PathEquals(m_vecItems->GetPath(), m_startDirectory, true) || (m_canFilterAdvanced && filterUrl.HasOption("filter"))))
{
if (GoParentFolder())
return true;
}
return CGUIWindow::OnBack(actionID);
}
bool CGUIMediaWindow::OnMessage(CGUIMessage& message)
{
switch ( message.GetMessage() )
{
case GUI_MSG_WINDOW_DEINIT:
{
CancelUpdateItems();
m_iLastControl = GetFocusedControlID();
CGUIWindow::OnMessage(message);
// get rid of any active filtering
if (m_canFilterAdvanced)
{
m_canFilterAdvanced = false;
m_filter.Reset();
}
m_strFilterPath.clear();
// Call ClearFileItems() after our window has finished doing any WindowClose
// animations
ClearFileItems();
return true;
}
break;
case GUI_MSG_CLICKED:
{
int iControl = message.GetSenderId();
if (iControl == CONTROL_BTNVIEWASICONS)
{
// view as control could be a select button
int viewMode = 0;
const CGUIControl *control = GetControl(CONTROL_BTNVIEWASICONS);
if (control && control->GetControlType() != CGUIControl::GUICONTROL_BUTTON)
{
CGUIMessage msg(GUI_MSG_ITEM_SELECTED, GetID(), CONTROL_BTNVIEWASICONS);
OnMessage(msg);
viewMode = m_viewControl.GetViewModeNumber(msg.GetParam1());
}
else
viewMode = m_viewControl.GetNextViewMode();
if (m_guiState)
m_guiState->SaveViewAsControl(viewMode);
UpdateButtons();
return true;
}
else if (iControl == CONTROL_BTNSORTASC) // sort asc
{
if (m_guiState)
m_guiState->SetNextSortOrder();
UpdateFileList();
return true;
}
else if (iControl == CONTROL_BTNSORTBY) // sort by
{
if (m_guiState.get() && m_guiState->ChooseSortMethod())
UpdateFileList();
return true;
}
else if (iControl == CONTROL_BTN_FILTER)
return Filter(false);
else if (m_viewControl.HasControl(iControl)) // list/thumb control
{
int iItem = m_viewControl.GetSelectedItem();
int iAction = message.GetParam1();
if (iItem < 0) break;
if (iAction == ACTION_SELECT_ITEM || iAction == ACTION_MOUSE_LEFT_CLICK)
{
OnSelect(iItem);
}
else if (iAction == ACTION_CONTEXT_MENU || iAction == ACTION_MOUSE_RIGHT_CLICK)
{
OnPopupMenu(iItem);
return true;
}
}
}
break;
case GUI_MSG_SETFOCUS:
{
if (m_viewControl.HasControl(message.GetControlId()) && m_viewControl.GetCurrentControl() != message.GetControlId())
{
m_viewControl.SetFocused();
return true;
}
}
break;
case GUI_MSG_NOTIFY_ALL:
{ // Message is received even if this window is inactive
if (message.GetParam1() == GUI_MSG_WINDOW_RESET)
{
m_vecItems->SetPath("?");
return true;
}
else if ( message.GetParam1() == GUI_MSG_REFRESH_THUMBS )
{
for (int i = 0; i < m_vecItems->Size(); i++)
m_vecItems->Get(i)->FreeMemory(true);
break; // the window will take care of any info images
}
else if (message.GetParam1() == GUI_MSG_REMOVED_MEDIA)
{
if ((m_vecItems->IsVirtualDirectoryRoot() ||
m_vecItems->IsSourcesPath()) && IsActive())
{
int iItem = m_viewControl.GetSelectedItem();
Refresh();
m_viewControl.SetSelectedItem(iItem);
}
else if (m_vecItems->IsRemovable())
{ // check that we have this removable share still
if (!m_rootDir.IsInSource(m_vecItems->GetPath()))
{ // don't have this share any more
if (IsActive()) Update("");
else
{
m_history.ClearPathHistory();
m_vecItems->SetPath("");
}
}
}
return true;
}
else if (message.GetParam1()==GUI_MSG_UPDATE_SOURCES)
{ // State of the sources changed, so update our view
if ((m_vecItems->IsVirtualDirectoryRoot() ||
m_vecItems->IsSourcesPath()) && IsActive())
{
if (m_vecItemsUpdating)
{
CLog::Log(LOGWARNING, "CGUIMediaWindow::OnMessage - updating in progress");
return true;
}
CUpdateGuard ug(m_vecItemsUpdating);
int iItem = m_viewControl.GetSelectedItem();
Refresh(true);
m_viewControl.SetSelectedItem(iItem);
}
return true;
}
else if (message.GetParam1()==GUI_MSG_UPDATE && IsActive())
{
if (m_vecItemsUpdating)
{
CLog::Log(LOGWARNING, "CGUIMediaWindow::OnMessage - updating in progress");
return true;
}
CUpdateGuard ug(m_vecItemsUpdating);
if (message.GetNumStringParams())
{
if (message.GetParam2()) // param2 is used for resetting the history
SetHistoryForPath(message.GetStringParam());
CFileItemList list(message.GetStringParam());
list.RemoveDiscCache(GetID());
Update(message.GetStringParam());
}
else
Refresh(true); // refresh the listing
}
else if (message.GetParam1()==GUI_MSG_UPDATE_ITEM && message.GetItem())
{
int flag = message.GetParam2();
CFileItemPtr newItem = std::static_pointer_cast<CFileItem>(message.GetItem());
if (IsActive() || (flag & GUI_MSG_FLAG_FORCE_UPDATE))
{
m_vecItems->UpdateItem(newItem.get());
if (flag & GUI_MSG_FLAG_UPDATE_LIST)
{ // need the list updated as well
UpdateFileList();
}
}
else if (newItem)
{ // need to remove the disc cache
CFileItemList items;
items.SetPath(URIUtils::GetDirectory(newItem->GetPath()));
if (newItem->HasProperty("cachefilename"))
{
// Use stored cache file name
std::string crcfile = newItem->GetProperty("cachefilename").asString();
items.RemoveDiscCacheCRC(crcfile);
}
else
// No stored cache file name, attempt using truncated item path as list path
items.RemoveDiscCache(GetID());
}
}
else if (message.GetParam1()==GUI_MSG_UPDATE_PATH)
{
if (IsActive())
{
if((message.GetStringParam() == m_vecItems->GetPath()) ||
(m_vecItems->IsMultiPath() && XFILE::CMultiPathDirectory::HasPath(m_vecItems->GetPath(), message.GetStringParam())))
Refresh();
}
}
else if (message.GetParam1() == GUI_MSG_FILTER_ITEMS && IsActive())
{
std::string filter = GetProperty("filter").asString();
// check if this is meant for advanced filtering
if (message.GetParam2() != 10)
{
if (message.GetParam2() == 1) // append
filter += message.GetStringParam();
else if (message.GetParam2() == 2)
{ // delete
if (filter.size())
filter.erase(filter.size() - 1);
}
else
filter = message.GetStringParam();
}
OnFilterItems(filter);
UpdateButtons();
return true;
}
else
return CGUIWindow::OnMessage(message);
return true;
}
break;
case GUI_MSG_PLAYBACK_STARTED:
case GUI_MSG_PLAYBACK_ENDED:
case GUI_MSG_PLAYBACK_STOPPED:
case GUI_MSG_PLAYLIST_CHANGED:
case GUI_MSG_PLAYLISTPLAYER_STOPPED:
case GUI_MSG_PLAYLISTPLAYER_STARTED:
case GUI_MSG_PLAYLISTPLAYER_CHANGED:
{ // send a notify all to all controls on this window
CGUIMessage msg(GUI_MSG_NOTIFY_ALL, GetID(), 0, GUI_MSG_REFRESH_LIST);
OnMessage(msg);
break;
}
case GUI_MSG_CHANGE_VIEW_MODE:
{
int viewMode = 0;
if (message.GetParam1()) // we have an id
viewMode = m_viewControl.GetViewModeByID(message.GetParam1());
else if (message.GetParam2())
viewMode = m_viewControl.GetNextViewMode(message.GetParam2());
if (m_guiState)
m_guiState->SaveViewAsControl(viewMode);
UpdateButtons();
return true;
}
break;
case GUI_MSG_CHANGE_SORT_METHOD:
{
if (m_guiState)
{
if (message.GetParam1())
m_guiState->SetCurrentSortMethod(message.GetParam1());
else if (message.GetParam2())
m_guiState->SetNextSortMethod(message.GetParam2());
}
UpdateFileList();
return true;
}
break;
case GUI_MSG_CHANGE_SORT_DIRECTION:
{
if (m_guiState)
m_guiState->SetNextSortOrder();
UpdateFileList();
return true;
}
break;
case GUI_MSG_WINDOW_INIT:
{
if (m_vecItems->GetPath() == "?")
m_vecItems->SetPath("");
std::string path, fileName;
std::string dir = message.GetStringParam(0);
URIUtils::Split(dir, path, fileName);
URIUtils::RemoveExtension(fileName);
if (StringUtils::IsInteger(fileName))
dir = path;
const std::string &ret = message.GetStringParam(1);
bool returning = StringUtils::EqualsNoCase(ret, "return");
if (!dir.empty())
{
// ensure our directory is valid
dir = GetStartFolder(dir);
bool resetHistory = false;
if (!returning || !URIUtils::PathEquals(dir, m_startDirectory, true))
{ // we're not returning to the same path, so set our directory to the requested path
m_vecItems->SetPath(dir);
resetHistory = true;
}
else if (m_vecItems->GetPath().empty() && URIUtils::PathEquals(dir, m_startDirectory, true))
m_vecItems->SetPath(dir);
// check for network up
if (URIUtils::IsRemote(m_vecItems->GetPath()) && !WaitForNetwork())
{
m_vecItems->SetPath("");
resetHistory = true;
}
if (resetHistory)
{
m_vecItems->RemoveDiscCache(GetID());
// only compute the history for the provided path if "return" is not defined
// (otherwise the root level for the path will be added by default to the path history
// and we won't be able to move back to the path we came from)
if (!returning)
SetHistoryForPath(m_vecItems->GetPath());
}
}
if (message.GetParam1() != WINDOW_INVALID)
{
// if this is the first time to this window - make sure we set the root path
// if "return" is defined make sure we set the startDirectory to the directory we are
// moving to (so that we can move back to where we were onBack). If we are activating
// the same window but with a different path, do nothing - we are simply adding to the
// window history.
if (message.GetParam1() != message.GetParam2())
m_startDirectory = returning ? dir : GetRootPath();
}
if (message.GetParam2() == PLUGIN_REFRESH_DELAY)
{
Refresh();
SetInitialVisibility();
RestoreControlStates();
SetInitialVisibility();
return true;
}
}
break;
}
return CGUIWindow::OnMessage(message);
}
/*!
* \brief Updates the states
*
* This updates the states (enable, disable, visible...) of the controls defined
* by this window.
*
* \note Override this function in a derived class to add new controls
*/
void CGUIMediaWindow::UpdateButtons()
{
if (m_guiState)
{
// Update sorting controls
if (m_guiState->GetSortOrder() == SortOrderNone)
{
CONTROL_DISABLE(CONTROL_BTNSORTASC);
}
else
{
CONTROL_ENABLE(CONTROL_BTNSORTASC);
SET_CONTROL_SELECTED(GetID(), CONTROL_BTNSORTASC, m_guiState->GetSortOrder() != SortOrderAscending);
}
// Update list/thumb control
m_viewControl.SetCurrentView(m_guiState->GetViewAsControl());
// Update sort by button
if (!m_guiState->HasMultipleSortMethods())
CONTROL_DISABLE(CONTROL_BTNSORTBY);
else
CONTROL_ENABLE(CONTROL_BTNSORTBY);
std::string sortLabel = StringUtils::Format(g_localizeStrings.Get(550).c_str(),
g_localizeStrings.Get(m_guiState->GetSortMethodLabel()).c_str());
SET_CONTROL_LABEL(CONTROL_BTNSORTBY, sortLabel);
}
std::string items = StringUtils::Format("%i %s", m_vecItems->GetObjectCount(), g_localizeStrings.Get(127).c_str());
SET_CONTROL_LABEL(CONTROL_LABELFILES, items);
SET_CONTROL_LABEL2(CONTROL_BTN_FILTER, GetProperty("filter").asString());
}
void CGUIMediaWindow::ClearFileItems()
{
m_viewControl.Clear();
m_vecItems->Clear();
m_unfilteredItems->Clear();
}
/*!
* \brief Sort file items
*
* This sorts file items based on the sort method and sort order provided by
* guiViewState.
*/
void CGUIMediaWindow::SortItems(CFileItemList &items)
{
std::unique_ptr<CGUIViewState> guiState(CGUIViewState::GetViewState(GetID(), items));
if (guiState)
{
SortDescription sorting = guiState->GetSortMethod();
sorting.sortOrder = guiState->GetSortOrder();
// If the sort method is "sort by playlist" and we have a specific
// sort order available we can use the specified sort order to do the sorting
// We do this as the new SortBy methods are a superset of the SORT_METHOD methods, thus
// not all are available. This may be removed once SORT_METHOD_* have been replaced by
// SortBy.
if ((sorting.sortBy == SortByPlaylistOrder) && items.HasProperty(PROPERTY_SORT_ORDER))
{
SortBy sortBy = (SortBy)items.GetProperty(PROPERTY_SORT_ORDER).asInteger();
if (sortBy != SortByNone && sortBy != SortByPlaylistOrder && sortBy != SortByProgramCount)
{
sorting.sortBy = sortBy;
sorting.sortOrder = items.GetProperty(PROPERTY_SORT_ASCENDING).asBoolean() ? SortOrderAscending : SortOrderDescending;
sorting.sortAttributes = CServiceBroker::GetSettingsComponent()->GetSettings()->GetBool(CSettings::SETTING_FILELISTS_IGNORETHEWHENSORTING) ? SortAttributeIgnoreArticle : SortAttributeNone;
// if the sort order is descending, we need to switch the original sort order, as we assume
// in CGUIViewState::AddPlaylistOrder that SortByPlaylistOrder is ascending.
if (guiState->GetSortOrder() == SortOrderDescending)
sorting.sortOrder = sorting.sortOrder == SortOrderDescending ? SortOrderAscending : SortOrderDescending;
}
}
items.Sort(sorting);
}
}
/*!
* \brief Formats item labels
*
* This is based on the formatting provided by guiViewState.
*/
void CGUIMediaWindow::FormatItemLabels(CFileItemList &items, const LABEL_MASKS &labelMasks)
{
CLabelFormatter fileFormatter(labelMasks.m_strLabelFile, labelMasks.m_strLabel2File);
CLabelFormatter folderFormatter(labelMasks.m_strLabelFolder, labelMasks.m_strLabel2Folder);
for (int i=0; i<items.Size(); ++i)
{
CFileItemPtr pItem=items[i];
if (pItem->IsLabelPreformatted())
continue;
if (pItem->m_bIsFolder)
folderFormatter.FormatLabels(pItem.get());
else
fileFormatter.FormatLabels(pItem.get());
}
if (items.GetSortMethod() == SortByLabel)
items.ClearSortState();
}
/*!
* \brief Format and sort file items
*
* Prepares and adds the fileitems to list/thumb panel
*/
void CGUIMediaWindow::FormatAndSort(CFileItemList &items)
{
std::unique_ptr<CGUIViewState> viewState(CGUIViewState::GetViewState(GetID(), items));
if (viewState)
{
LABEL_MASKS labelMasks;
viewState->GetSortMethodLabelMasks(labelMasks);
FormatItemLabels(items, labelMasks);
items.Sort(viewState->GetSortMethod().sortBy, viewState->GetSortOrder(), viewState->GetSortMethod().sortAttributes);
}
}
/*!
* \brief Overwrite to fill fileitems from a source
*
* \param[in] strDirectory Path to read
* \param[out] items Fill with items specified in \e strDirectory
* \return false if given directory not present
*/
bool CGUIMediaWindow::GetDirectory(const std::string &strDirectory, CFileItemList &items)
{
CURL pathToUrl(strDirectory);
std::string strParentPath = m_history.GetParentPath();
CLog::Log(LOGDEBUG,"CGUIMediaWindow::GetDirectory (%s)",
CURL::GetRedacted(strDirectory).c_str());
CLog::Log(LOGDEBUG," ParentPath = [%s]", CURL::GetRedacted(strParentPath).c_str());
if (pathToUrl.IsProtocol("plugin") && !pathToUrl.GetHostName().empty())
CServiceBroker::GetAddonMgr().UpdateLastUsed(pathToUrl.GetHostName());
// see if we can load a previously cached folder
CFileItemList cachedItems(strDirectory);
if (!strDirectory.empty() && cachedItems.Load(GetID()))
{
items.Assign(cachedItems);
}
else
{
unsigned int time = XbmcThreads::SystemClockMillis();
if (strDirectory.empty())
SetupShares();
CFileItemList dirItems;
if (!GetDirectoryItems(pathToUrl, dirItems, UseFileDirectories()))
return false;
// assign fetched directory items
items.Assign(dirItems);
// took over a second, and not normally cached, so cache it
if ((XbmcThreads::SystemClockMillis() - time) > 1000 && items.CacheToDiscIfSlow())
items.Save(GetID());
// if these items should replace the current listing, then pop it off the top
if (items.GetReplaceListing())
m_history.RemoveParentPath();
}
// update the view state's reference to the current items
m_guiState.reset(CGUIViewState::GetViewState(GetID(), items));
bool bHideParent = false;
if (m_guiState && m_guiState->HideParentDirItems())
bHideParent = true;
if (items.GetPath() == GetRootPath())
bHideParent = true;
if (!bHideParent)
{
CFileItemPtr pItem(new CFileItem(".."));
pItem->SetPath(strParentPath);
pItem->m_bIsFolder = true;
pItem->m_bIsShareOrDrive = false;
items.AddFront(pItem, 0);
}
int iWindow = GetID();
std::vector<std::string> regexps;
//! @todo Do we want to limit the directories we apply the video ones to?
if (iWindow == WINDOW_VIDEO_NAV)
regexps = CServiceBroker::GetSettingsComponent()->GetAdvancedSettings()->m_videoExcludeFromListingRegExps;
if (iWindow == WINDOW_MUSIC_NAV)
regexps = CServiceBroker::GetSettingsComponent()->GetAdvancedSettings()->m_audioExcludeFromListingRegExps;
if (iWindow == WINDOW_PICTURES)
regexps = CServiceBroker::GetSettingsComponent()->GetAdvancedSettings()->m_pictureExcludeFromListingRegExps;
if (regexps.size())
{
for (int i=0; i < items.Size();)
{
if (CUtil::ExcludeFileOrFolder(items[i]->GetPath(), regexps))
items.Remove(i);
else
i++;
}
}
// clear the filter
SetProperty("filter", "");
m_canFilterAdvanced = false;
m_filter.Reset();
return true;
}
bool CGUIMediaWindow::Update(const std::string &strDirectory, bool updateFilterPath /* = true */)
{
//! @todo OnInitWindow calls Update() before window path has been set properly.
if (strDirectory == "?")
return false;
// The path to load. Empty string is used in various places to denote root, so translate to the
// real root path first
const std::string path = strDirectory.empty() ? GetRootPath() : strDirectory;
// stores the selected item in history
SaveSelectedItemInHistory();
const std::string previousPath = m_vecItems->GetPath();
// check if the path contains a filter and temporarily remove it
// so that the retrieved list of items is unfiltered
std::string pathNoFilter = path;
if (CanContainFilter(pathNoFilter) && CURL(pathNoFilter).HasOption("filter"))
pathNoFilter = RemoveParameterFromPath(pathNoFilter, "filter");
if (!GetDirectory(pathNoFilter, *m_vecItems))
{
CLog::Log(LOGERROR,"CGUIMediaWindow::GetDirectory(%s) failed", CURL(path).GetRedacted().c_str());
if (URIUtils::PathEquals(path, GetRootPath()))
return false; // Nothing to fallback to
// Try to return to the previous directory, if not the same
// else fallback to root
if (URIUtils::PathEquals(path, previousPath) || !Update(m_history.RemoveParentPath()))
Update(""); // Fallback to root
// Return false to be able to eg. show
// an error message.
return false;
}
if (m_vecItems->GetLabel().empty())
{
// Removable sources
VECSOURCES removables;
CServiceBroker::GetMediaManager().GetRemovableDrives(removables);
for (auto s : removables)
{
if (URIUtils::CompareWithoutSlashAtEnd(s.strPath, m_vecItems->GetPath()))
{
m_vecItems->SetLabel(s.strName);
break;
}
}
}
if (m_vecItems->GetLabel().empty())
m_vecItems->SetLabel(CUtil::GetTitleFromPath(m_vecItems->GetPath(), true));
// check the given path for filter data
UpdateFilterPath(path, *m_vecItems, updateFilterPath);
// if we're getting the root source listing
// make sure the path history is clean
if (URIUtils::PathEquals(path, GetRootPath()))
m_history.ClearPathHistory();
int iWindow = GetID();
int showLabel = 0;
if (URIUtils::PathEquals(path, GetRootPath()))
{
if (iWindow == WINDOW_PICTURES)
showLabel = 997;
else if (iWindow == WINDOW_FILES)
showLabel = 1026;
else if (iWindow == WINDOW_GAMES)
showLabel = 35250; // "Add games..."
}
if (m_vecItems->IsPath("sources://video/"))
showLabel = 999;
else if (m_vecItems->IsPath("sources://music/"))
showLabel = 998;
else if (m_vecItems->IsPath("sources://pictures/"))
showLabel = 997;
else if (m_vecItems->IsPath("sources://files/"))
showLabel = 1026;
else if (m_vecItems->IsPath("sources://games/"))
showLabel = 35250; // "Add games..."
if (showLabel && (m_vecItems->Size() == 0 || !m_guiState->DisableAddSourceButtons())) // add 'add source button'
{
std::string strLabel = g_localizeStrings.Get(showLabel);
CFileItemPtr pItem(new CFileItem(strLabel));
pItem->SetPath("add");
pItem->SetArt("icon", "DefaultAddSource.png");
pItem->SetLabel(strLabel);
pItem->SetLabelPreformatted(true);
pItem->m_bIsFolder = true;
pItem->SetSpecialSort(CServiceBroker::GetSettingsComponent()->GetAdvancedSettings()->m_addSourceOnTop ?
SortSpecialOnTop : SortSpecialOnBottom);
m_vecItems->Add(pItem);
}
m_iLastControl = GetFocusedControlID();
// Check whether to enabled advanced filtering based on the content type
m_canFilterAdvanced = CheckFilterAdvanced(*m_vecItems);
if (m_canFilterAdvanced)
m_filter.SetType(m_vecItems->GetContent());
// Ask the derived class if it wants to load additional info
// for the fileitems like media info or additional
// filtering on the items, setting thumbs.
OnPrepareFileItems(*m_vecItems);
m_vecItems->FillInDefaultIcons();
// remember the original (untouched) list of items (for filtering etc)
m_unfilteredItems->Assign(*m_vecItems);
// Cache the list of items if possible
OnCacheFileItems(*m_vecItems);
// Filter and group the items if necessary
OnFilterItems(GetProperty("filter").asString());
UpdateButtons();
// Restore selected item from history
RestoreSelectedItemFromHistory();
m_history.AddPath(m_vecItems->GetPath(), m_strFilterPath);
//m_history.DumpPathHistory();
return true;
}
bool CGUIMediaWindow::Refresh(bool clearCache /* = false */)
{
std::string strCurrentDirectory = m_vecItems->GetPath();
if (strCurrentDirectory == "?")
return false;
if (clearCache)
m_vecItems->RemoveDiscCache(GetID());
bool ret = true;
// get the original number of items
if (!Update(strCurrentDirectory, false))
{
ret = false;
}
return ret;
}
/*!
* \brief On prepare file items
*
* This function will be called by Update() before the labels of the fileitems
* are formatted.
*
* \note Override this function to set custom thumbs or load additional media
* info.
*
* It's used to load tag info for music.
*/
void CGUIMediaWindow::OnPrepareFileItems(CFileItemList &items)
{
CFileItemListModification::GetInstance().Modify(items);
}
/*!
* \brief On cache file items
*
* This function will be called by Update() before
* any additional formatting, filtering or sorting is applied.
*
* \note Override this function to define a custom caching behaviour.
*/
void CGUIMediaWindow::OnCacheFileItems(CFileItemList &items)
{
// Should these items be saved to the hdd
if (items.CacheToDiscAlways() && !IsFiltered())
items.Save(GetID());
}