/*
 *  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.
 */

#pragma once

#include "BackgroundInfoLoader.h"

#include <string>

class CTextureDatabase;

class CThumbLoader : public CBackgroundInfoLoader
{
public:
  CThumbLoader();
  ~CThumbLoader() override;

  void OnLoaderStart() override;
  void OnLoaderFinish() override;

  /*! \brief helper function to fill the art for a library item
   \param item a CFileItem
   \return true if we fill art, false otherwise
   */
  virtual bool FillLibraryArt(CFileItem &item) { return false; }

  /*! \brief Checks whether the given item has an image listed in the texture database
   \param item CFileItem to check
   \param type the type of image to retrieve
   \return the image associated with this item
   */
  virtual std::string GetCachedImage(const CFileItem &item, const std::string &type);

  /*! \brief Associate an image with the given item in the texture database
   \param item CFileItem to associate the image with
   \param type the type of image
   \param image the URL of the image
   */
  virtual void SetCachedImage(const CFileItem &item, const std::string &type, const std::string &image);

protected:
  CTextureDatabase *m_textureDatabase;
};

class CProgramThumbLoader : public CThumbLoader
{
public:
  CProgramThumbLoader();
  ~CProgramThumbLoader() override;
  bool LoadItem(CFileItem* pItem) override;
  bool LoadItemCached(CFileItem* pItem) override;
  bool LoadItemLookup(CFileItem* pItem) override;

  /*! \brief Fill the thumb of a programs item
   First uses a cached thumb from a previous run, then checks for a local thumb
   and caches it for the next run
   \param item the CFileItem object to fill
   \return true if we fill the thumb, false otherwise
   \sa GetLocalThumb
   */
  virtual bool FillThumb(CFileItem &item);

  /*! \brief Get a local thumb for a programs item
   Shortcuts are checked, then we check for a file or folder thumb
   \param item the CFileItem object to check
   \return the local thumb (if it exists)
   \sa FillThumb
   */
  static std::string GetLocalThumb(const CFileItem &item);
};