xbmc/pvr/dialogs/GUIDialogPVRRecordingSettings.cpp

   1 /*
   2  *  Copyright (C) 2017-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 "GUIDialogPVRRecordingSettings.h"
  10
  11 #include "FileItem.h"
  12 #include "ServiceBroker.h"
  13 #include "guilib/GUIMessage.h"
  14 #include "guilib/LocalizeStrings.h"
  15 #include "messaging/helpers/DialogHelper.h"
  16 #include "pvr/PVRManager.h"
  17 #include "pvr/addons/PVRClient.h"
  18 #include "pvr/recordings/PVRRecording.h"
  19 #include "settings/dialogs/GUIDialogSettingsBase.h"
  20 #include "settings/lib/Setting.h"
  21 #include "utils/StringUtils.h"
  22 #include "utils/Variant.h"
  23 #include "utils/log.h"
  24
  25 #include <algorithm>
  26 #include <iterator>
  27 #include <memory>
  28 #include <string>
  29 #include <utility>
  30 #include <vector>
  31
  32 using namespace PVR;
  33 using namespace KODI::MESSAGING;
  34
  35 #define SETTING_RECORDING_NAME "recording.name"
  36 #define SETTING_RECORDING_PLAYCOUNT "recording.playcount"
  37 #define SETTING_RECORDING_LIFETIME "recording.lifetime"
  38
  39 CGUIDialogPVRRecordingSettings::CGUIDialogPVRRecordingSettings()
  40   : CGUIDialogSettingsManualBase(WINDOW_DIALOG_PVR_RECORDING_SETTING, "DialogSettings.xml")
  41 {
  42   m_loadType = LOAD_EVERY_TIME;
  43 }
  44
  45 void CGUIDialogPVRRecordingSettings::SetRecording(const std::shared_ptr<CPVRRecording>& recording)
  46 {
  47   if (!recording)
  48   {
  49     CLog::LogF(LOGERROR, "No recording given");
  50     return;
  51   }
  52
  53   m_recording = recording;
  54
  55   // Copy data we need from tag. Do not modify the tag itself until Save()!
  56   m_strTitle = m_recording->m_strTitle;
  57   m_iPlayCount = m_recording->GetLocalPlayCount();
  58   m_iLifetime = m_recording->LifeTime();
  59 }
  60
  61 void CGUIDialogPVRRecordingSettings::SetupView()
  62 {
  63   CGUIDialogSettingsManualBase::SetupView();
  64   SetHeading(19068); // Recording settings
  65   SET_CONTROL_HIDDEN(CONTROL_SETTINGS_CUSTOM_BUTTON);
  66   SET_CONTROL_LABEL(CONTROL_SETTINGS_OKAY_BUTTON, 186); // OK
  67   SET_CONTROL_LABEL(CONTROL_SETTINGS_CANCEL_BUTTON, 222); // Cancel
  68 }
  69
  70 void CGUIDialogPVRRecordingSettings::InitializeSettings()
  71 {
  72   CGUIDialogSettingsManualBase::InitializeSettings();
  73
  74   const std::shared_ptr<CSettingCategory> category = AddCategory("pvrrecordingsettings", -1);
  75   if (category == nullptr)
  76   {
  77     CLog::LogF(LOGERROR, "Unable to add settings category");
  78     return;
  79   }
  80
  81   const std::shared_ptr<CSettingGroup> group = AddGroup(category);
  82   if (group == nullptr)
  83   {
  84     CLog::LogF(LOGERROR, "Unable to add settings group");
  85     return;
  86   }
  87
  88   std::shared_ptr<CSetting> setting = nullptr;
  89   const std::shared_ptr<const CPVRClient> client =
  90       CServiceBroker::GetPVRManager().GetClient(m_recording->ClientID());
  91
  92   // Name
  93   setting = AddEdit(group, SETTING_RECORDING_NAME, 19075, SettingLevel::Basic, m_strTitle);
  94   setting->SetEnabled(client && client->GetClientCapabilities().SupportsRecordingsRename());
  95
  96   // Play count
  97   if (client && client->GetClientCapabilities().SupportsRecordingsPlayCount())
  98     setting = AddEdit(group, SETTING_RECORDING_PLAYCOUNT, 567, SettingLevel::Basic,
  99                       m_recording->GetLocalPlayCount());
 100
 101   // Lifetime
 102   if (client && client->GetClientCapabilities().SupportsRecordingsLifetimeChange())
 103     setting = AddList(group, SETTING_RECORDING_LIFETIME, 19083, SettingLevel::Basic, m_iLifetime,
 104                       LifetimesFiller, 19083);
 105 }
 106
 107 bool CGUIDialogPVRRecordingSettings::CanEditRecording(const CFileItem& item)
 108 {
 109   if (!item.HasPVRRecordingInfoTag())
 110     return false;
 111
 112   const std::shared_ptr<const CPVRClient> client =
 113       CServiceBroker::GetPVRManager().GetClient(item.GetPVRRecordingInfoTag()->ClientID());
 114
 115   if (!client)
 116     return false;
 117
 118   const CPVRClientCapabilities& capabilities = client->GetClientCapabilities();
 119
 120   return capabilities.SupportsRecordingsRename() || capabilities.SupportsRecordingsPlayCount() ||
 121          capabilities.SupportsRecordingsLifetimeChange();
 122 }
 123
 124 bool CGUIDialogPVRRecordingSettings::OnSettingChanging(
 125     const std::shared_ptr<const CSetting>& setting)
 126 {
 127   if (setting == nullptr)
 128   {
 129     CLog::LogF(LOGERROR, "No setting");
 130     return false;
 131   }
 132
 133   const std::string& settingId = setting->GetId();
 134
 135   if (settingId == SETTING_RECORDING_LIFETIME)
 136   {
 137     int iNewLifetime = std::static_pointer_cast<const CSettingInt>(setting)->GetValue();
 138     if (m_recording->WillBeExpiredWithNewLifetime(iNewLifetime))
 139     {
 140       if (HELPERS::ShowYesNoDialogText(
 141               CVariant{19068}, // "Recording settings"
 142               StringUtils::Format(g_localizeStrings.Get(19147),
 143                                   iNewLifetime)) // "Setting the lifetime..."
 144           != HELPERS::DialogResponse::CHOICE_YES)
 145         return false;
 146     }
 147   }
 148
 149   return CGUIDialogSettingsManualBase::OnSettingChanging(setting);
 150 }
 151
 152 void CGUIDialogPVRRecordingSettings::OnSettingChanged(
 153     const std::shared_ptr<const CSetting>& setting)
 154 {
 155   if (setting == nullptr)
 156   {
 157     CLog::LogF(LOGERROR, "No setting");
 158     return;
 159   }
 160
 161   CGUIDialogSettingsManualBase::OnSettingChanged(setting);
 162
 163   const std::string& settingId = setting->GetId();
 164
 165   if (settingId == SETTING_RECORDING_NAME)
 166   {
 167     m_strTitle = std::static_pointer_cast<const CSettingString>(setting)->GetValue();
 168   }
 169   else if (settingId == SETTING_RECORDING_PLAYCOUNT)
 170   {
 171     m_iPlayCount = std::static_pointer_cast<const CSettingInt>(setting)->GetValue();
 172   }
 173   else if (settingId == SETTING_RECORDING_LIFETIME)
 174   {
 175     m_iLifetime = std::static_pointer_cast<const CSettingInt>(setting)->GetValue();
 176   }
 177 }
 178
 179 bool CGUIDialogPVRRecordingSettings::Save()
 180 {
 181   // Name
 182   m_recording->m_strTitle = m_strTitle;
 183
 184   // Play count
 185   m_recording->SetLocalPlayCount(m_iPlayCount);
 186
 187   // Lifetime
 188   m_recording->SetLifeTime(m_iLifetime);
 189
 190   return true;
 191 }
 192
 193 void CGUIDialogPVRRecordingSettings::LifetimesFiller(const SettingConstPtr& setting,
 194                                                      std::vector<IntegerSettingOption>& list,
 195                                                      int& current,
 196                                                      void* data)
 197 {
 198   CGUIDialogPVRRecordingSettings* pThis = static_cast<CGUIDialogPVRRecordingSettings*>(data);
 199   if (pThis)
 200   {
 201     list.clear();
 202
 203     const std::shared_ptr<const CPVRClient> client =
 204         CServiceBroker::GetPVRManager().GetClient(pThis->m_recording->ClientID());
 205     if (client)
 206     {
 207       std::vector<std::pair<std::string, int>> values;
 208       client->GetClientCapabilities().GetRecordingsLifetimeValues(values);
 209       std::transform(
 210           values.cbegin(), values.cend(), std::back_inserter(list),
 211           [](const auto& value) { return IntegerSettingOption(value.first, value.second); });
 212     }
 213
 214     current = pThis->m_iLifetime;
 215
 216     auto it = list.begin();
 217     while (it != list.end())
 218     {
 219       if (it->value == current)
 220         break; // value already in list
 221
 222       ++it;
 223     }
 224
 225     if (it == list.end())
 226     {
 227       // PVR backend supplied value is not in the list of predefined values. Insert it.
 228       list.insert(it, IntegerSettingOption(
 229                           StringUtils::Format(g_localizeStrings.Get(17999), current) /* {} days */,
 230                           current));
 231     }
 232   }
 233   else
 234     CLog::LogF(LOGERROR, "No dialog");
 235 }