xbmc/favourites/FavouritesService.h

   1 /*
   2  *  Copyright (C) 2005-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #pragma once
  10
  11 #include "FileItemList.h"
  12 #include "threads/CriticalSection.h"
  13 #include "utils/EventStream.h"
  14
  15 #include <memory>
  16 #include <string>
  17 #include <unordered_map>
  18 #include <vector>
  19
  20 class CFileItem;
  21
  22 class CFavouritesService
  23 {
  24 public:
  25   explicit CFavouritesService(std::string userDataFolder);
  26   virtual ~CFavouritesService() = default;
  27
  28   /** For profiles*/
  29   void ReInit(std::string userDataFolder);
  30
  31   void OnPlaybackStopped(const CFileItem& item);
  32   void OnPlaybackEnded(const CFileItem& item);
  33
  34   bool IsFavourited(const CFileItem& item, int contextWindow) const;
  35   std::shared_ptr<CFileItem> GetFavourite(const CFileItem& item, int contextWindow) const;
  36   std::shared_ptr<CFileItem> ResolveFavourite(const CFileItem& favItem) const;
  37
  38   int Size() const;
  39   void GetAll(CFileItemList& items) const;
  40   bool AddOrRemove(const CFileItem& item, int contextWindow);
  41   bool Save(const CFileItemList& items);
  42
  43   /*! \brief Refresh favourites for directory providers, e.g. the GUI needs to be updated
  44    */
  45   void RefreshFavourites();
  46
  47   struct FavouritesUpdated { };
  48
  49   CEventStream<FavouritesUpdated>& Events() { return m_events; }
  50
  51 private:
  52   CFavouritesService() = delete;
  53   CFavouritesService(const CFavouritesService&) = delete;
  54   CFavouritesService& operator=(const CFavouritesService&) = delete;
  55   CFavouritesService(CFavouritesService&&) = delete;
  56   CFavouritesService& operator=(CFavouritesService&&) = delete;
  57
  58   void OnUpdated();
  59   bool Persist();
  60
  61   void CleanupTargetsCache(const CFileItem& item);
  62
  63   std::string m_userDataFolder;
  64   CFileItemList m_favourites;
  65   mutable std::unordered_map<std::string, std::shared_ptr<CFileItem>> m_targets;
  66   CEventSource<FavouritesUpdated> m_events;
  67   mutable CCriticalSection m_criticalSection;
  68 };