xbmc/dialogs/GUIDialogCache.cpp

   1 /*
   2  *  Copyright (C) 2005-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 "GUIDialogCache.h"
  10
  11 #include "ServiceBroker.h"
  12 #include "dialogs/GUIDialogProgress.h"
  13 #include "guilib/GUIComponent.h"
  14 #include "guilib/GUIWindowManager.h"
  15 #include "guilib/LocalizeStrings.h"
  16 #include "messaging/ApplicationMessenger.h"
  17 #include "threads/SystemClock.h"
  18 #include "utils/Variant.h"
  19 #include "utils/log.h"
  20
  21 #include <mutex>
  22
  23 using namespace std::chrono_literals;
  24
  25 CGUIDialogCache::CGUIDialogCache(std::chrono::milliseconds delay,
  26                                  const std::string& strHeader,
  27                                  const std::string& strMsg)
  28   : CThread("GUIDialogCache"), m_strHeader(strHeader), m_strLinePrev(strMsg)
  29 {
  30   bSentCancel = false;
  31
  32   m_pDlg = CServiceBroker::GetGUI()->GetWindowManager().GetWindow<CGUIDialogProgress>(WINDOW_DIALOG_PROGRESS);
  33
  34   if (!m_pDlg)
  35     return;
  36
  37   /* if progress dialog is already running, take it over */
  38   if( m_pDlg->IsDialogRunning() )
  39     delay = 0ms;
  40
  41   if (delay == 0ms)
  42     OpenDialog();
  43   else
  44     m_endtime.Set(delay);
  45
  46   Create(true);
  47 }
  48
  49 void CGUIDialogCache::Close(bool bForceClose)
  50 {
  51   bSentCancel = true;
  52
  53   // we cannot wait for the app thread to process the close message
  54   // as this might happen during player startup which leads to a deadlock
  55   if (m_pDlg && m_pDlg->IsDialogRunning())
  56     CServiceBroker::GetAppMessenger()->PostMsg(TMSG_GUI_WINDOW_CLOSE, -1, bForceClose ? 1 : 0,
  57                                                static_cast<void*>(m_pDlg));
  58
  59   //Set stop, this will kill this object, when thread stops
  60   CThread::m_bStop = true;
  61 }
  62
  63 CGUIDialogCache::~CGUIDialogCache()
  64 {
  65   if(m_pDlg && m_pDlg->IsDialogRunning())
  66     m_pDlg->Close();
  67 }
  68
  69 void CGUIDialogCache::OpenDialog()
  70 {
  71   if (m_pDlg)
  72   {
  73     if (m_strHeader.empty())
  74       m_pDlg->SetHeading(CVariant{438});
  75     else
  76       m_pDlg->SetHeading(CVariant{m_strHeader});
  77
  78     m_pDlg->SetLine(2, CVariant{m_strLinePrev});
  79     m_pDlg->Open();
  80   }
  81   bSentCancel = false;
  82 }
  83
  84 void CGUIDialogCache::SetHeader(const std::string& strHeader)
  85 {
  86   m_strHeader = strHeader;
  87 }
  88
  89 void CGUIDialogCache::SetHeader(int nHeader)
  90 {
  91   SetHeader(g_localizeStrings.Get(nHeader));
  92 }
  93
  94 void CGUIDialogCache::SetMessage(const std::string& strMessage)
  95 {
  96   if (m_pDlg)
  97   {
  98     m_pDlg->SetLine(0, CVariant{m_strLinePrev2});
  99     m_pDlg->SetLine(1, CVariant{m_strLinePrev});
 100     m_pDlg->SetLine(2, CVariant{strMessage});
 101   }
 102   m_strLinePrev2 = m_strLinePrev;
 103   m_strLinePrev = strMessage;
 104 }
 105
 106 bool CGUIDialogCache::OnFileCallback(void* pContext, int ipercent, float avgSpeed)
 107 {
 108   if (m_pDlg)
 109   {
 110     m_pDlg->ShowProgressBar(true);
 111     m_pDlg->SetPercentage(ipercent);
 112   }
 113
 114   if( IsCanceled() )
 115     return false;
 116   else
 117     return true;
 118 }
 119
 120 void CGUIDialogCache::Process()
 121 {
 122   if (!m_pDlg)
 123     return;
 124
 125   while( true )
 126   {
 127
 128     { //Section to make the lock go out of scope before sleep
 129
 130       if( CThread::m_bStop ) break;
 131
 132       try
 133       {
 134         std::unique_lock<CCriticalSection> lock(CServiceBroker::GetWinSystem()->GetGfxContext());
 135         m_pDlg->Progress();
 136         if( bSentCancel )
 137         {
 138           CThread::Sleep(10ms);
 139           continue;
 140         }
 141
 142         if(m_pDlg->IsCanceled())
 143         {
 144           bSentCancel = true;
 145         }
 146         else if( !m_pDlg->IsDialogRunning() && m_endtime.IsTimePast()
 147               && !CServiceBroker::GetGUI()->GetWindowManager().IsWindowActive(WINDOW_DIALOG_YES_NO) )
 148           OpenDialog();
 149       }
 150       catch(...)
 151       {
 152         CLog::Log(LOGERROR, "Exception in CGUIDialogCache::Process()");
 153       }
 154     }
 155
 156     CThread::Sleep(10ms);
 157   }
 158 }
 159
 160 void CGUIDialogCache::ShowProgressBar(bool bOnOff)
 161 {
 162   if (m_pDlg)
 163     m_pDlg->ShowProgressBar(bOnOff);
 164 }
 165
 166 void CGUIDialogCache::SetPercentage(int iPercentage)
 167 {
 168   if (m_pDlg)
 169     m_pDlg->SetPercentage(iPercentage);
 170 }
 171
 172 bool CGUIDialogCache::IsCanceled() const
 173 {
 174   if (m_pDlg && m_pDlg->IsDialogRunning())
 175     return m_pDlg->IsCanceled();
 176   else
 177     return false;
 178 }