PVRTimerType.cpp

/*
 *  Copyright (C) 2012-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 "PVRTimerType.h"

#include "ServiceBroker.h"
#include "addons/PVRClient.h"
#include "guilib/LocalizeStrings.h"
#include "pvr/PVRManager.h"
#include "pvr/addons/PVRClients.h"
#include "utils/StringUtils.h"
#include "utils/log.h"

#include <memory>
#include <string>
#include <utility>
#include <vector>

using namespace PVR;

const std::vector<std::shared_ptr<CPVRTimerType>> CPVRTimerType::GetAllTypes()
{
  std::vector<std::shared_ptr<CPVRTimerType>> allTypes;
  CServiceBroker::GetPVRManager().Clients()->GetTimerTypes(allTypes);

  // Add local reminder timer types. Local reminders are always available.
  int iTypeId = PVR_TIMER_TYPE_NONE;

  // one time time-based reminder
  allTypes.emplace_back(std::make_shared<CPVRTimerType>(++iTypeId,
                                                        PVR_TIMER_TYPE_IS_MANUAL |
                                                        PVR_TIMER_TYPE_IS_REMINDER |
                                                        PVR_TIMER_TYPE_SUPPORTS_CHANNELS |
                                                        PVR_TIMER_TYPE_SUPPORTS_START_TIME |
                                                        PVR_TIMER_TYPE_SUPPORTS_END_TIME));

  // one time epg-based reminder
  allTypes.emplace_back(std::make_shared<CPVRTimerType>(++iTypeId,
                                                        PVR_TIMER_TYPE_IS_REMINDER |
                                                        PVR_TIMER_TYPE_REQUIRES_EPG_TAG_ON_CREATE |
                                                        PVR_TIMER_TYPE_SUPPORTS_CHANNELS |
                                                        PVR_TIMER_TYPE_SUPPORTS_START_TIME |
                                                        PVR_TIMER_TYPE_SUPPORTS_START_END_MARGIN));

  // time-based reminder rule
  allTypes.emplace_back(std::make_shared<CPVRTimerType>(++iTypeId,
                                                        PVR_TIMER_TYPE_IS_REPEATING |
                                                        PVR_TIMER_TYPE_IS_MANUAL |
                                                        PVR_TIMER_TYPE_IS_REMINDER |
                                                        PVR_TIMER_TYPE_SUPPORTS_ENABLE_DISABLE |
                                                        PVR_TIMER_TYPE_SUPPORTS_CHANNELS |
                                                        PVR_TIMER_TYPE_SUPPORTS_START_TIME |
                                                        PVR_TIMER_TYPE_SUPPORTS_END_TIME |
                                                        PVR_TIMER_TYPE_SUPPORTS_FIRST_DAY |
                                                        PVR_TIMER_TYPE_SUPPORTS_WEEKDAYS));

  // one time read-only time-based reminder (created by timer rule)
  allTypes.emplace_back(std::make_shared<CPVRTimerType>(++iTypeId,
                                                        PVR_TIMER_TYPE_IS_MANUAL |
                                                        PVR_TIMER_TYPE_IS_REMINDER |
                                                        PVR_TIMER_TYPE_IS_READONLY |
                                                        PVR_TIMER_TYPE_SUPPORTS_ENABLE_DISABLE |
                                                        PVR_TIMER_TYPE_SUPPORTS_CHANNELS |
                                                        PVR_TIMER_TYPE_SUPPORTS_START_TIME |
                                                        PVR_TIMER_TYPE_SUPPORTS_END_TIME,
                                                        g_localizeStrings.Get(819))); // One time (Scheduled by timer rule)

  // epg-based reminder rule
  allTypes.emplace_back(std::make_shared<CPVRTimerType>(++iTypeId,
                                                        PVR_TIMER_TYPE_IS_REPEATING |
                                                        PVR_TIMER_TYPE_IS_REMINDER |
                                                        PVR_TIMER_TYPE_SUPPORTS_ENABLE_DISABLE |
                                                        PVR_TIMER_TYPE_SUPPORTS_TITLE_EPG_MATCH |
                                                        PVR_TIMER_TYPE_SUPPORTS_FULLTEXT_EPG_MATCH |
                                                        PVR_TIMER_TYPE_SUPPORTS_CHANNELS |
                                                        PVR_TIMER_TYPE_SUPPORTS_ANY_CHANNEL |
                                                        PVR_TIMER_TYPE_SUPPORTS_START_TIME |
                                                        PVR_TIMER_TYPE_SUPPORTS_START_ANYTIME |
                                                        PVR_TIMER_TYPE_SUPPORTS_END_TIME |
                                                        PVR_TIMER_TYPE_SUPPORTS_END_ANYTIME |
                                                        PVR_TIMER_TYPE_SUPPORTS_FIRST_DAY |
                                                        PVR_TIMER_TYPE_SUPPORTS_WEEKDAYS |
                                                        PVR_TIMER_TYPE_SUPPORTS_START_END_MARGIN));

  // one time read-only epg-based reminder (created by timer rule)
  allTypes.emplace_back(std::make_shared<CPVRTimerType>(++iTypeId,
                                                        PVR_TIMER_TYPE_IS_REMINDER |
                                                        PVR_TIMER_TYPE_IS_READONLY |
                                                        PVR_TIMER_TYPE_REQUIRES_EPG_TAG_ON_CREATE |
                                                        PVR_TIMER_TYPE_SUPPORTS_ENABLE_DISABLE |
                                                        PVR_TIMER_TYPE_SUPPORTS_CHANNELS |
                                                        PVR_TIMER_TYPE_SUPPORTS_START_TIME |
                                                        PVR_TIMER_TYPE_SUPPORTS_START_END_MARGIN,
                                                        g_localizeStrings.Get(819))); // One time (Scheduled by timer rule)

  return allTypes;
}

const std::shared_ptr<CPVRTimerType> CPVRTimerType::GetFirstAvailableType(const std::shared_ptr<CPVRClient>& client)
{
  if (client)
  {
    std::vector<std::shared_ptr<CPVRTimerType>> types;
    if (client->GetTimerTypes(types) == PVR_ERROR_NO_ERROR && !types.empty())
    {
      return *(types.begin());
    }
  }
  return {};
}

std::shared_ptr<CPVRTimerType> CPVRTimerType::CreateFromIds(unsigned int iTypeId, int iClientId)
{
  const std::vector<std::shared_ptr<CPVRTimerType>> types = GetAllTypes();
  for (const auto& type : types)
  {
    if ((type->GetClientId() == iClientId) && (type->GetTypeId() == iTypeId))
      return type;
  }

  if (iClientId != -1)
  {
    // fallback. try to obtain local timer type.
    std::shared_ptr<CPVRTimerType> type = CreateFromIds(iTypeId, -1);
    if (type)
      return type;
  }

  CLog::LogF(LOGERROR, "Unable to resolve numeric timer type (%d, %d)", iTypeId, iClientId);
  return {};
}

std::shared_ptr<CPVRTimerType> CPVRTimerType::CreateFromAttributes(
  unsigned int iMustHaveAttr, unsigned int iMustNotHaveAttr, int iClientId)
{
  const std::vector<std::shared_ptr<CPVRTimerType>> types = GetAllTypes();
  for (const auto& type : types)
  {
    if ((type->GetClientId() == iClientId) &&
        ((type->GetAttributes() & iMustHaveAttr) == iMustHaveAttr) &&
        ((type->GetAttributes() & iMustNotHaveAttr) == 0))
      return type;
  }

  if (iClientId != -1)
  {
    // fallback. try to obtain local timer type.
    std::shared_ptr<CPVRTimerType> type = CreateFromAttributes(iMustHaveAttr, iMustNotHaveAttr, -1);
    if (type)
      return type;
  }

  CLog::LogF(LOGERROR, "Unable to resolve timer type (0x%x, 0x%x, %d)", iMustHaveAttr, iMustNotHaveAttr, iClientId);
  return {};
}

CPVRTimerType::CPVRTimerType() :
  m_iTypeId(PVR_TIMER_TYPE_NONE),
  m_iAttributes(PVR_TIMER_TYPE_ATTRIBUTE_NONE)
{
}

CPVRTimerType::CPVRTimerType(const PVR_TIMER_TYPE& type, int iClientId) :
  m_iClientId(iClientId),
  m_iTypeId(type.iId),
  m_iAttributes(type.iAttributes),
  m_strDescription(type.strDescription)
{
  InitDescription();
  InitAttributeValues(type);
}

CPVRTimerType::CPVRTimerType(unsigned int iTypeId, unsigned int iAttributes, const std::string& strDescription) :
  m_iTypeId(iTypeId),
  m_iAttributes(iAttributes),
  m_strDescription(strDescription)
{
  InitDescription();
}

CPVRTimerType::~CPVRTimerType() = default;

bool CPVRTimerType::operator ==(const CPVRTimerType& right) const
{
  return (m_iClientId                  == right.m_iClientId   &&
          m_iTypeId                    == right.m_iTypeId  &&
          m_iAttributes                == right.m_iAttributes &&
          m_strDescription             == right.m_strDescription &&
          m_priorityValues             == right.m_priorityValues &&
          m_iPriorityDefault           == right.m_iPriorityDefault &&
          m_lifetimeValues             == right.m_lifetimeValues &&
          m_iLifetimeDefault           == right.m_iLifetimeDefault &&
          m_maxRecordingsValues        == right.m_maxRecordingsValues &&
          m_iMaxRecordingsDefault      == right.m_iMaxRecordingsDefault &&
          m_preventDupEpisodesValues   == right.m_preventDupEpisodesValues &&
          m_iPreventDupEpisodesDefault == right.m_iPreventDupEpisodesDefault &&
          m_recordingGroupValues       == right.m_recordingGroupValues &&
          m_iRecordingGroupDefault     == right.m_iRecordingGroupDefault);
}

bool CPVRTimerType::operator !=(const CPVRTimerType& right) const
{
  return !(*this == right);
}

void CPVRTimerType::InitDescription()
{
  // if no description was given, compile it
  if (m_strDescription.empty())
  {
    int id;
    if (m_iAttributes & PVR_TIMER_TYPE_IS_REPEATING)
    {
      id = (m_iAttributes & PVR_TIMER_TYPE_IS_MANUAL)
        ? 822  // "Timer rule"
        : 823; // "Timer rule (guide-based)"
    }
    else
    {
      id = (m_iAttributes & PVR_TIMER_TYPE_IS_MANUAL)
        ? 820  // "One time"
        : 821; // "One time (guide-based)
    }
    m_strDescription = g_localizeStrings.Get(id);
  }

  // add reminder/recording prefix
  int prefixId = (m_iAttributes & PVR_TIMER_TYPE_IS_REMINDER)
    ? 824  // Reminder: ...
    : 825; // Recording: ...

  m_strDescription = StringUtils::Format(g_localizeStrings.Get(prefixId).c_str(), m_strDescription.c_str());
}

void CPVRTimerType::InitAttributeValues(const PVR_TIMER_TYPE& type)
{
  InitPriorityValues(type);
  InitLifetimeValues(type);
  InitMaxRecordingsValues(type);
  InitPreventDuplicateEpisodesValues(type);
  InitRecordingGroupValues(type);
}

void CPVRTimerType::InitPriorityValues(const PVR_TIMER_TYPE& type)
{
  if (type.iPrioritiesSize > 0)
  {
    for (unsigned int i = 0; i < type.iPrioritiesSize; ++i)
    {
      std::string strDescr(type.priorities[i].strDescription);
      if (strDescr.empty())
      {
        // No description given by addon. Create one from value.
        strDescr = StringUtils::Format("%d", type.priorities[i].iValue);
      }
      m_priorityValues.emplace_back(strDescr, type.priorities[i].iValue);
    }

    m_iPriorityDefault = type.iPrioritiesDefault;
  }
  else if (SupportsPriority())
  {
    // No values given by addon, but priority supported. Use default values 1..100
    for (int i = 1; i < 101; ++i)
      m_priorityValues.emplace_back(StringUtils::Format("%d", i), i);

    m_iPriorityDefault = DEFAULT_RECORDING_PRIORITY;
  }
  else
  {
    // No priority supported.
    m_iPriorityDefault = DEFAULT_RECORDING_PRIORITY;
  }
}

void CPVRTimerType::GetPriorityValues(std::vector<std::pair<std::string, int>>& list) const
{
  for (const auto& prio : m_priorityValues)
    list.push_back(prio);
}

void CPVRTimerType::InitLifetimeValues(const PVR_TIMER_TYPE& type)
{
  if (type.iLifetimesSize > 0)
  {
    for (unsigned int i = 0; i < type.iLifetimesSize; ++i)
    {
      int iValue = type.lifetimes[i].iValue;
      std::string strDescr(type.lifetimes[i].strDescription);
      if (strDescr.empty())
      {
        // No description given by addon. Create one from value.
        strDescr = StringUtils::Format("%d", iValue);
      }
      m_lifetimeValues.emplace_back(strDescr, iValue);
    }

    m_iLifetimeDefault = type.iLifetimesDefault;
  }
  else if (SupportsLifetime())
  {
    // No values given by addon, but lifetime supported. Use default values 1..365
    for (int i = 1; i < 366; ++i)
    {
      m_lifetimeValues.emplace_back(StringUtils::Format(g_localizeStrings.Get(17999).c_str(), i), i); // "%s days"
    }
    m_iLifetimeDefault = DEFAULT_RECORDING_LIFETIME;
  }
  else
  {
    // No lifetime supported.
    m_iLifetimeDefault = DEFAULT_RECORDING_LIFETIME;
  }
}

void CPVRTimerType::GetLifetimeValues(std::vector<std::pair<std::string, int>>& list) const
{
  for (const auto& lifetime : m_lifetimeValues)
    list.push_back(lifetime);
}

void CPVRTimerType::InitMaxRecordingsValues(const PVR_TIMER_TYPE& type)
{
  if (type.iMaxRecordingsSize > 0)
  {
    for (unsigned int i = 0; i < type.iMaxRecordingsSize; ++i)
    {
      std::string strDescr(type.maxRecordings[i].strDescription);
      if (strDescr.empty())
      {
        // No description given by addon. Create one from value.
        strDescr = StringUtils::Format("%d", type.maxRecordings[i].iValue);
      }
      m_maxRecordingsValues.emplace_back(strDescr, type.maxRecordings[i].iValue);
    }

    m_iMaxRecordingsDefault = type.iMaxRecordingsDefault;
  }
}

void CPVRTimerType::GetMaxRecordingsValues(std::vector<std::pair<std::string, int>>& list) const
{
  for (const auto& maxRecordings : m_maxRecordingsValues)
    list.push_back(maxRecordings);
}

void CPVRTimerType::InitPreventDuplicateEpisodesValues(const PVR_TIMER_TYPE& type)
{
  if (type.iPreventDuplicateEpisodesSize > 0)
  {
    for (unsigned int i = 0; i < type.iPreventDuplicateEpisodesSize; ++i)
    {
      std::string strDescr(type.preventDuplicateEpisodes[i].strDescription);
      if (strDescr.empty())
      {
        // No description given by addon. Create one from value.
        strDescr = StringUtils::Format("%d", type.preventDuplicateEpisodes[i].iValue);
      }
      m_preventDupEpisodesValues.emplace_back(strDescr, type.preventDuplicateEpisodes[i].iValue);
    }

    m_iPreventDupEpisodesDefault = type.iPreventDuplicateEpisodesDefault;
  }
  else if (SupportsRecordOnlyNewEpisodes())
  {
    // No values given by addon, but prevent duplicate episodes supported. Use default values 0..1
    m_preventDupEpisodesValues.emplace_back(g_localizeStrings.Get(815), 0); // "Record all episodes"
    m_preventDupEpisodesValues.emplace_back(g_localizeStrings.Get(816), 1); // "Record only new episodes"
    m_iPreventDupEpisodesDefault = DEFAULT_RECORDING_DUPLICATEHANDLING;
  }
  else
  {
    // No prevent duplicate episodes supported.
    m_iPreventDupEpisodesDefault = DEFAULT_RECORDING_DUPLICATEHANDLING;
  }
}

void CPVRTimerType::GetPreventDuplicateEpisodesValues(std::vector<std::pair<std::string, int>>& list) const
{
  for (const auto& preventDupEpisodes : m_preventDupEpisodesValues)
    list.push_back(preventDupEpisodes);
}

void CPVRTimerType::InitRecordingGroupValues(const PVR_TIMER_TYPE& type)
{
  if (type.iRecordingGroupSize > 0)
  {
    for (unsigned int i = 0; i < type.iRecordingGroupSize; ++i)
    {
      std::string strDescr(type.recordingGroup[i].strDescription);
      if (strDescr.empty())
      {
        // No description given by addon. Create one from value.
        strDescr = StringUtils::Format("%s %d",
                                       g_localizeStrings.Get(811).c_str(), // Recording group
                                       type.recordingGroup[i].iValue);
      }
      m_recordingGroupValues.emplace_back(strDescr, type.recordingGroup[i].iValue);
    }

    m_iRecordingGroupDefault = type.iRecordingGroupDefault;
  }
}

void CPVRTimerType::GetRecordingGroupValues(std::vector< std::pair<std::string, int>>& list) const
{
  for (const auto& recordingGroup : m_recordingGroupValues)
    list.push_back(recordingGroup);
}