summaryrefslogtreecommitdiffstats
path: root/xbmc/video/jobs/VideoLibraryRefreshingJob.h
blob: e98f4c06489bb19d948446892b4556b4aeeb5a27 (plain)
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
/*
 *  Copyright (C) 2014-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 "video/jobs/VideoLibraryProgressJob.h"

#include <memory>
#include <string>

class CFileItem;

/*!
 \brief Video library job implementation for refreshing a single item.
*/
class CVideoLibraryRefreshingJob : public CVideoLibraryProgressJob
{
public:
  /*!
   \brief Creates a new video library cleaning job for the given paths.

   \param[inout] item Video item to be refreshed
   \param[in] forceRefresh Whether to force a complete refresh (including NFO or internet lookup)
   \param[in] refreshAll Whether to refresh all sub-items (in case of a tvshow)
   \param[in] ignoreNfo Whether or not to ignore local NFO files
   \param[in] searchTitle Title to use for the search (instead of determining it from the item's filename/path)
  */
  CVideoLibraryRefreshingJob(std::shared_ptr<CFileItem> item,
                             bool forceRefresh,
                             bool refreshAll,
                             bool ignoreNfo = false,
                             const std::string& searchTitle = "");

  ~CVideoLibraryRefreshingJob() override;

  // specialization of CJob
  const char *GetType() const override { return "VideoLibraryRefreshingJob"; }
  bool operator==(const CJob* job) const override;

protected:
  // implementation of CVideoLibraryJob
  bool Work(CVideoDatabase &db) override;

private:
  std::shared_ptr<CFileItem> m_item;
  bool m_forceRefresh;
  bool m_refreshAll;
  bool m_ignoreNfo;
  std::string m_searchTitle;
};