xbmc/pvr/guilib/PVRGUIActionsRecordings.cpp

   1 /*
   2  *  Copyright (C) 2016-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 "PVRGUIActionsRecordings.h"
  10
  11 #include "FileItem.h"
  12 #include "FileItemList.h"
  13 #include "ServiceBroker.h"
  14 #include "Util.h"
  15 #include "dialogs/GUIDialogBusy.h"
  16 #include "dialogs/GUIDialogYesNo.h"
  17 #include "filesystem/IDirectory.h"
  18 #include "guilib/GUIComponent.h"
  19 #include "guilib/GUIWindowManager.h"
  20 #include "guilib/WindowIDs.h"
  21 #include "messaging/helpers/DialogOKHelper.h"
  22 #include "pvr/PVRItem.h"
  23 #include "pvr/PVRManager.h"
  24 #include "pvr/addons/PVRClient.h"
  25 #include "pvr/addons/PVRClients.h"
  26 #include "pvr/dialogs/GUIDialogPVRRecordingInfo.h"
  27 #include "pvr/dialogs/GUIDialogPVRRecordingSettings.h"
  28 #include "pvr/recordings/PVRRecording.h"
  29 #include "settings/Settings.h"
  30 #include "threads/IRunnable.h"
  31 #include "utils/Variant.h"
  32 #include "utils/log.h"
  33
  34 #include <memory>
  35 #include <numeric>
  36 #include <string>
  37
  38 using namespace PVR;
  39 using namespace KODI::MESSAGING;
  40
  41 namespace
  42 {
  43 class AsyncRecordingAction : private IRunnable
  44 {
  45 public:
  46   bool Execute(const CFileItem& item);
  47
  48 protected:
  49   AsyncRecordingAction() = default;
  50
  51 private:
  52   // IRunnable implementation
  53   void Run() override;
  54
  55   // the worker function
  56   virtual bool DoRun(const std::shared_ptr<CFileItem>& item) = 0;
  57
  58   std::shared_ptr<CFileItem> m_item;
  59   bool m_bSuccess = false;
  60 };
  61
  62 bool AsyncRecordingAction::Execute(const CFileItem& item)
  63 {
  64   m_item = std::make_shared<CFileItem>(item);
  65   CGUIDialogBusy::Wait(this, 100, false);
  66   return m_bSuccess;
  67 }
  68
  69 void AsyncRecordingAction::Run()
  70 {
  71   m_bSuccess = DoRun(m_item);
  72
  73   if (m_bSuccess)
  74     CServiceBroker::GetPVRManager().TriggerRecordingsUpdate();
  75 }
  76
  77 class AsyncRenameRecording : public AsyncRecordingAction
  78 {
  79 public:
  80   explicit AsyncRenameRecording(const std::string& strNewName) : m_strNewName(strNewName) {}
  81
  82 private:
  83   bool DoRun(const std::shared_ptr<CFileItem>& item) override
  84   {
  85     if (item->IsUsablePVRRecording())
  86     {
  87       return item->GetPVRRecordingInfoTag()->Rename(m_strNewName);
  88     }
  89     else
  90     {
  91       CLog::LogF(LOGERROR, "Cannot rename item '{}': no valid recording tag", item->GetPath());
  92       return false;
  93     }
  94   }
  95   std::string m_strNewName;
  96 };
  97
  98 class AsyncDeleteRecording : public AsyncRecordingAction
  99 {
 100 public:
 101   explicit AsyncDeleteRecording(bool bWatchedOnly = false) : m_bWatchedOnly(bWatchedOnly) {}
 102
 103 private:
 104   bool DoRun(const std::shared_ptr<CFileItem>& item) override
 105   {
 106     CFileItemList items;
 107     if (item->m_bIsFolder)
 108     {
 109       CUtil::GetRecursiveListing(item->GetPath(), items, "", XFILE::DIR_FLAG_NO_FILE_INFO);
 110     }
 111     else
 112     {
 113       items.Add(item);
 114     }
 115
 116     return std::accumulate(
 117         items.cbegin(), items.cend(), true, [this](bool success, const auto& itemToDelete) {
 118           return (itemToDelete->IsPVRRecording() &&
 119                   (!m_bWatchedOnly || itemToDelete->GetPVRRecordingInfoTag()->GetPlayCount() > 0) &&
 120                   !itemToDelete->GetPVRRecordingInfoTag()->Delete())
 121                      ? false
 122                      : success;
 123         });
 124   }
 125   bool m_bWatchedOnly = false;
 126 };
 127
 128 class AsyncEmptyRecordingsTrash : public AsyncRecordingAction
 129 {
 130 private:
 131   bool DoRun(const std::shared_ptr<CFileItem>& item) override
 132   {
 133     return CServiceBroker::GetPVRManager().Clients()->DeleteAllRecordingsFromTrash() ==
 134            PVR_ERROR_NO_ERROR;
 135   }
 136 };
 137
 138 class AsyncUndeleteRecording : public AsyncRecordingAction
 139 {
 140 private:
 141   bool DoRun(const std::shared_ptr<CFileItem>& item) override
 142   {
 143     if (item->IsDeletedPVRRecording())
 144     {
 145       return item->GetPVRRecordingInfoTag()->Undelete();
 146     }
 147     else
 148     {
 149       CLog::LogF(LOGERROR, "Cannot undelete item '{}': no valid recording tag", item->GetPath());
 150       return false;
 151     }
 152   }
 153 };
 154
 155 class AsyncSetRecordingPlayCount : public AsyncRecordingAction
 156 {
 157 private:
 158   bool DoRun(const std::shared_ptr<CFileItem>& item) override
 159   {
 160     const std::shared_ptr<CPVRClient> client = CServiceBroker::GetPVRManager().GetClient(*item);
 161     if (client)
 162     {
 163       const std::shared_ptr<const CPVRRecording> recording = item->GetPVRRecordingInfoTag();
 164       return client->SetRecordingPlayCount(*recording, recording->GetLocalPlayCount()) ==
 165              PVR_ERROR_NO_ERROR;
 166     }
 167     return false;
 168   }
 169 };
 170
 171 class AsyncSetRecordingLifetime : public AsyncRecordingAction
 172 {
 173 private:
 174   bool DoRun(const std::shared_ptr<CFileItem>& item) override
 175   {
 176     const std::shared_ptr<CPVRClient> client = CServiceBroker::GetPVRManager().GetClient(*item);
 177     if (client)
 178       return client->SetRecordingLifetime(*item->GetPVRRecordingInfoTag()) == PVR_ERROR_NO_ERROR;
 179     return false;
 180   }
 181 };
 182
 183 } // unnamed namespace
 184
 185 bool CPVRGUIActionsRecordings::ShowRecordingInfo(const CFileItem& item) const
 186 {
 187   if (!item.IsPVRRecording())
 188   {
 189     CLog::LogF(LOGERROR, "No recording!");
 190     return false;
 191   }
 192
 193   CGUIDialogPVRRecordingInfo* pDlgInfo =
 194       CServiceBroker::GetGUI()->GetWindowManager().GetWindow<CGUIDialogPVRRecordingInfo>(
 195           WINDOW_DIALOG_PVR_RECORDING_INFO);
 196   if (!pDlgInfo)
 197   {
 198     CLog::LogF(LOGERROR, "Unable to get WINDOW_DIALOG_PVR_RECORDING_INFO!");
 199     return false;
 200   }
 201
 202   pDlgInfo->SetRecording(item);
 203   pDlgInfo->Open();
 204   return true;
 205 }
 206
 207 bool CPVRGUIActionsRecordings::EditRecording(const CFileItem& item) const
 208 {
 209   const std::shared_ptr<CPVRRecording> recording = CPVRItem(item).GetRecording();
 210   if (!recording)
 211   {
 212     CLog::LogF(LOGERROR, "No recording!");
 213     return false;
 214   }
 215
 216   std::shared_ptr<CPVRRecording> origRecording(new CPVRRecording);
 217   origRecording->Update(*recording,
 218                         *CServiceBroker::GetPVRManager().GetClient(recording->ClientID()));
 219
 220   if (!ShowRecordingSettings(recording))
 221     return false;
 222
 223   if (origRecording->m_strTitle != recording->m_strTitle)
 224   {
 225     if (!AsyncRenameRecording(recording->m_strTitle).Execute(item))
 226       CLog::LogF(LOGERROR, "Renaming recording failed!");
 227   }
 228
 229   if (origRecording->GetLocalPlayCount() != recording->GetLocalPlayCount())
 230   {
 231     if (!AsyncSetRecordingPlayCount().Execute(item))
 232       CLog::LogF(LOGERROR, "Setting recording playcount failed!");
 233   }
 234
 235   if (origRecording->LifeTime() != recording->LifeTime())
 236   {
 237     if (!AsyncSetRecordingLifetime().Execute(item))
 238       CLog::LogF(LOGERROR, "Setting recording lifetime failed!");
 239   }
 240
 241   return true;
 242 }
 243
 244 bool CPVRGUIActionsRecordings::CanEditRecording(const CFileItem& item) const
 245 {
 246   return CGUIDialogPVRRecordingSettings::CanEditRecording(item);
 247 }
 248
 249 bool CPVRGUIActionsRecordings::DeleteRecording(const CFileItem& item) const
 250 {
 251   if ((!item.IsPVRRecording() && !item.m_bIsFolder) || item.IsParentFolder())
 252     return false;
 253
 254   if (!ConfirmDeleteRecording(item))
 255     return false;
 256
 257   if (!AsyncDeleteRecording().Execute(item))
 258   {
 259     HELPERS::ShowOKDialogText(
 260         CVariant{257},
 261         CVariant{
 262             19111}); // "Error", "PVR backend error. Check the log for more information about this message."
 263     return false;
 264   }
 265
 266   return true;
 267 }
 268
 269 bool CPVRGUIActionsRecordings::ConfirmDeleteRecording(const CFileItem& item) const
 270 {
 271   return CGUIDialogYesNo::ShowAndGetInput(
 272       CVariant{122}, // "Confirm delete"
 273       item.m_bIsFolder
 274           ? CVariant{19113} // "Delete all recordings in this folder?"
 275           : item.GetPVRRecordingInfoTag()->IsDeleted()
 276                 ? CVariant{19294}
 277                 // "Remove this deleted recording from trash? This operation cannot be reverted."
 278                 : CVariant{19112}, // "Delete this recording?"
 279       CVariant{""}, CVariant{item.GetLabel()});
 280 }
 281
 282 bool CPVRGUIActionsRecordings::DeleteWatchedRecordings(const CFileItem& item) const
 283 {
 284   if (!item.m_bIsFolder || item.IsParentFolder())
 285     return false;
 286
 287   if (!ConfirmDeleteWatchedRecordings(item))
 288     return false;
 289
 290   if (!AsyncDeleteRecording(true).Execute(item))
 291   {
 292     HELPERS::ShowOKDialogText(
 293         CVariant{257},
 294         CVariant{
 295             19111}); // "Error", "PVR backend error. Check the log for more information about this message."
 296     return false;
 297   }
 298
 299   return true;
 300 }
 301
 302 bool CPVRGUIActionsRecordings::ConfirmDeleteWatchedRecordings(const CFileItem& item) const
 303 {
 304   return CGUIDialogYesNo::ShowAndGetInput(
 305       CVariant{122}, // "Confirm delete"
 306       CVariant{19328}, // "Delete all watched recordings in this folder?"
 307       CVariant{""}, CVariant{item.GetLabel()});
 308 }
 309
 310 bool CPVRGUIActionsRecordings::DeleteAllRecordingsFromTrash() const
 311 {
 312   if (!ConfirmDeleteAllRecordingsFromTrash())
 313     return false;
 314
 315   if (!AsyncEmptyRecordingsTrash().Execute({}))
 316     return false;
 317
 318   return true;
 319 }
 320
 321 bool CPVRGUIActionsRecordings::ConfirmDeleteAllRecordingsFromTrash() const
 322 {
 323   return CGUIDialogYesNo::ShowAndGetInput(
 324       CVariant{19292}, // "Delete all permanently"
 325       CVariant{
 326           19293}); // "Remove all deleted recordings from trash? This operation cannot be reverted."
 327 }
 328
 329 bool CPVRGUIActionsRecordings::UndeleteRecording(const CFileItem& item) const
 330 {
 331   if (!item.IsDeletedPVRRecording())
 332     return false;
 333
 334   if (!AsyncUndeleteRecording().Execute(item))
 335   {
 336     HELPERS::ShowOKDialogText(
 337         CVariant{257},
 338         CVariant{
 339             19111}); // "Error", "PVR backend error. Check the log for more information about this message."
 340     return false;
 341   }
 342
 343   return true;
 344 }
 345
 346 bool CPVRGUIActionsRecordings::ShowRecordingSettings(
 347     const std::shared_ptr<CPVRRecording>& recording) const
 348 {
 349   CGUIDialogPVRRecordingSettings* pDlgInfo =
 350       CServiceBroker::GetGUI()->GetWindowManager().GetWindow<CGUIDialogPVRRecordingSettings>(
 351           WINDOW_DIALOG_PVR_RECORDING_SETTING);
 352   if (!pDlgInfo)
 353   {
 354     CLog::LogF(LOGERROR, "Unable to get WINDOW_DIALOG_PVR_RECORDING_SETTING!");
 355     return false;
 356   }
 357
 358   pDlgInfo->SetRecording(recording);
 359   pDlgInfo->Open();
 360
 361   return pDlgInfo->IsConfirmed();
 362 }