xbmc/pvr/timers/PVRTimerRuleMatcher.cpp

   1 /*
   2  *  Copyright (C) 2012-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 #include "PVRTimerRuleMatcher.h"
  10
  11 #include "XBDateTime.h"
  12 #include "addons/kodi-dev-kit/include/kodi/c-api/addon-instance/pvr/pvr_channels.h" // PVR_CHANNEL_INVALID_UID
  13 #include "pvr/epg/EpgInfoTag.h"
  14 #include "pvr/timers/PVRTimerInfoTag.h"
  15 #include "utils/RegExp.h"
  16
  17 #include <memory>
  18
  19 using namespace PVR;
  20
  21 CPVRTimerRuleMatcher::CPVRTimerRuleMatcher(const std::shared_ptr<CPVRTimerInfoTag>& timerRule,
  22                                            const CDateTime& start)
  23   : m_timerRule(timerRule), m_start(CPVRTimerInfoTag::ConvertUTCToLocalTime(start))
  24 {
  25 }
  26
  27 CPVRTimerRuleMatcher::~CPVRTimerRuleMatcher() = default;
  28
  29 std::shared_ptr<const CPVRChannel> CPVRTimerRuleMatcher::GetChannel() const
  30 {
  31   if (m_timerRule->GetTimerType()->SupportsChannels())
  32     return m_timerRule->Channel();
  33
  34   return {};
  35 }
  36
  37 CDateTime CPVRTimerRuleMatcher::GetNextTimerStart() const
  38 {
  39   if (!m_timerRule->GetTimerType()->SupportsStartTime())
  40     return CDateTime(); // invalid datetime
  41
  42   const CDateTime startDateLocal = m_timerRule->GetTimerType()->SupportsFirstDay()
  43                                        ? m_timerRule->FirstDayAsLocalTime()
  44                                        : m_start;
  45   const CDateTime startTimeLocal = m_timerRule->StartAsLocalTime();
  46   CDateTime nextStart(startDateLocal.GetYear(), startDateLocal.GetMonth(), startDateLocal.GetDay(),
  47                       startTimeLocal.GetHour(), startTimeLocal.GetMinute(), 0);
  48
  49   const CDateTimeSpan oneDay(1, 0, 0, 0);
  50   while (nextStart < m_start)
  51   {
  52     nextStart += oneDay;
  53   }
  54
  55   if (m_timerRule->GetTimerType()->SupportsWeekdays() &&
  56       m_timerRule->WeekDays() != PVR_WEEKDAY_ALLDAYS)
  57   {
  58     bool bMatch = false;
  59     while (!bMatch)
  60     {
  61       int startWeekday = nextStart.GetDayOfWeek();
  62       if (startWeekday == 0)
  63         startWeekday = 7;
  64
  65       bMatch = ((1 << (startWeekday - 1)) & m_timerRule->WeekDays());
  66       if (!bMatch)
  67         nextStart += oneDay;
  68     }
  69   }
  70
  71   return nextStart.GetAsUTCDateTime();
  72 }
  73
  74 bool CPVRTimerRuleMatcher::Matches(const std::shared_ptr<const CPVREpgInfoTag>& epgTag) const
  75 {
  76   return epgTag && CPVRTimerInfoTag::ConvertUTCToLocalTime(epgTag->EndAsUTC()) > m_start &&
  77          MatchSeriesLink(epgTag) && MatchChannel(epgTag) && MatchStart(epgTag) &&
  78          MatchEnd(epgTag) && MatchDayOfWeek(epgTag) && MatchSearchText(epgTag);
  79 }
  80
  81 bool CPVRTimerRuleMatcher::MatchSeriesLink(
  82     const std::shared_ptr<const CPVREpgInfoTag>& epgTag) const
  83 {
  84   if (m_timerRule->GetTimerType()->RequiresEpgSeriesLinkOnCreate())
  85     return epgTag->SeriesLink() == m_timerRule->SeriesLink();
  86   else
  87     return true;
  88 }
  89
  90 bool CPVRTimerRuleMatcher::MatchChannel(const std::shared_ptr<const CPVREpgInfoTag>& epgTag) const
  91 {
  92   if (m_timerRule->GetTimerType()->SupportsAnyChannel() &&
  93       m_timerRule->ClientChannelUID() == PVR_CHANNEL_INVALID_UID)
  94     return true; // matches any channel
  95
  96   if (m_timerRule->GetTimerType()->SupportsChannels())
  97     return m_timerRule->ClientChannelUID() != PVR_CHANNEL_INVALID_UID &&
  98            epgTag->ClientID() == m_timerRule->ClientID() &&
  99            epgTag->UniqueChannelID() == m_timerRule->ClientChannelUID();
 100   else
 101     return true;
 102 }
 103
 104 bool CPVRTimerRuleMatcher::MatchStart(const std::shared_ptr<const CPVREpgInfoTag>& epgTag) const
 105 {
 106   if (m_timerRule->GetTimerType()->SupportsFirstDay())
 107   {
 108     // only year, month and day do matter here...
 109     const CDateTime startEpgLocal = CPVRTimerInfoTag::ConvertUTCToLocalTime(epgTag->StartAsUTC());
 110     const CDateTime startEpg(startEpgLocal.GetYear(), startEpgLocal.GetMonth(),
 111                              startEpgLocal.GetDay(), 0, 0, 0);
 112     const CDateTime firstDayLocal = m_timerRule->FirstDayAsLocalTime();
 113     const CDateTime startTimer(firstDayLocal.GetYear(), firstDayLocal.GetMonth(),
 114                                firstDayLocal.GetDay(), 0, 0, 0);
 115     if (startEpg < startTimer)
 116       return false;
 117   }
 118
 119   if (m_timerRule->GetTimerType()->SupportsStartAnyTime() && m_timerRule->IsStartAnyTime())
 120     return true; // matches any start time
 121
 122   if (m_timerRule->GetTimerType()->SupportsStartTime())
 123   {
 124     // only hours and minutes do matter here...
 125     const CDateTime startEpgLocal = CPVRTimerInfoTag::ConvertUTCToLocalTime(epgTag->StartAsUTC());
 126     const CDateTime startEpg(2000, 1, 1, startEpgLocal.GetHour(), startEpgLocal.GetMinute(), 0);
 127     const CDateTime startTimerLocal = m_timerRule->StartAsLocalTime();
 128     const CDateTime startTimer(2000, 1, 1, startTimerLocal.GetHour(), startTimerLocal.GetMinute(),
 129                                0);
 130     return startEpg >= startTimer;
 131   }
 132   else
 133     return true;
 134 }
 135
 136 bool CPVRTimerRuleMatcher::MatchEnd(const std::shared_ptr<const CPVREpgInfoTag>& epgTag) const
 137 {
 138   if (m_timerRule->GetTimerType()->SupportsEndAnyTime() && m_timerRule->IsEndAnyTime())
 139     return true; // matches any end time
 140
 141   if (m_timerRule->GetTimerType()->SupportsEndTime())
 142   {
 143     // only hours and minutes do matter here...
 144     const CDateTime endEpgLocal = CPVRTimerInfoTag::ConvertUTCToLocalTime(epgTag->EndAsUTC());
 145     const CDateTime endEpg(2000, 1, 1, endEpgLocal.GetHour(), endEpgLocal.GetMinute(), 0);
 146     const CDateTime endTimerLocal = m_timerRule->EndAsLocalTime();
 147     const CDateTime endTimer(2000, 1, 1, endTimerLocal.GetHour(), endTimerLocal.GetMinute(), 0);
 148     return endEpg <= endTimer;
 149   }
 150   else
 151     return true;
 152 }
 153
 154 bool CPVRTimerRuleMatcher::MatchDayOfWeek(const std::shared_ptr<const CPVREpgInfoTag>& epgTag) const
 155 {
 156   if (m_timerRule->GetTimerType()->SupportsWeekdays())
 157   {
 158     if (m_timerRule->WeekDays() != PVR_WEEKDAY_ALLDAYS)
 159     {
 160       const CDateTime startEpgLocal = CPVRTimerInfoTag::ConvertUTCToLocalTime(epgTag->StartAsUTC());
 161       int startWeekday = startEpgLocal.GetDayOfWeek();
 162       if (startWeekday == 0)
 163         startWeekday = 7;
 164
 165       return ((1 << (startWeekday - 1)) & m_timerRule->WeekDays());
 166     }
 167   }
 168   return true;
 169 }
 170
 171 bool CPVRTimerRuleMatcher::MatchSearchText(
 172     const std::shared_ptr<const CPVREpgInfoTag>& epgTag) const
 173 {
 174   if (m_timerRule->GetTimerType()->SupportsEpgFulltextMatch() && m_timerRule->IsFullTextEpgSearch())
 175   {
 176     if (!m_textSearch)
 177     {
 178       m_textSearch = std::make_unique<CRegExp>(true /* case insensitive */);
 179       m_textSearch->RegComp(m_timerRule->EpgSearchString());
 180     }
 181     return m_textSearch->RegFind(epgTag->Title()) >= 0 ||
 182            m_textSearch->RegFind(epgTag->EpisodeName()) >= 0 ||
 183            m_textSearch->RegFind(epgTag->PlotOutline()) >= 0 ||
 184            m_textSearch->RegFind(epgTag->Plot()) >= 0;
 185   }
 186   else if (m_timerRule->GetTimerType()->SupportsEpgTitleMatch())
 187   {
 188     if (!m_textSearch)
 189     {
 190       m_textSearch = std::make_unique<CRegExp>(true /* case insensitive */);
 191       m_textSearch->RegComp(m_timerRule->EpgSearchString());
 192     }
 193     return m_textSearch->RegFind(epgTag->Title()) >= 0;
 194   }
 195   else
 196     return true;
 197 }