xbmc/utils/DownloadQueue.cpp

   1 /*
   2  *      Copyright (C) 2005-2008 Team XBMC
   3  *      http://www.xbmc.org
   4  *
   5  *  This Program is free software; you can redistribute it and/or modify
   6  *  it under the terms of the GNU General Public License as published by
   7  *  the Free Software Foundation; either version 2, or (at your option)
   8  *  any later version.
   9  *
  10  *  This Program is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  *  GNU General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU General Public License
  16  *  along with XBMC; see the file COPYING.  If not, write to
  17  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  18  *  http://www.gnu.org/copyleft/gpl.html
  19  *
  20  */
  21
  22 #include "DownloadQueue.h"
  23 #include "Util.h"
  24 #include "log.h"
  25
  26 #include "FileSystem/File.h"
  27 #include "FileSystem/FileCurl.h"
  28
  29 using namespace std;
  30 using namespace XFILE;
  31
  32 WORD CDownloadQueue::m_wNextQueueId = 0;
  33
  34 CDownloadQueue::CDownloadQueue(void) : CThread()
  35 {
  36   InitializeCriticalSection(&m_critical);
  37   m_bStop = false;
  38   m_wQueueId = m_wNextQueueId++;
  39   m_dwNextItemId = 0;
  40   CThread::Create(false);
  41 }
  42
  43 void CDownloadQueue::OnStartup()
  44 {
  45   SetPriority( GetMinPriority() );
  46 }
  47
  48 CDownloadQueue::~CDownloadQueue(void)
  49 {
  50   DeleteCriticalSection(&m_critical);
  51 }
  52
  53
  54 TICKET CDownloadQueue::RequestContent(const CStdString& aUrl, IDownloadQueueObserver* aObserver)
  55 {
  56   EnterCriticalSection(&m_critical);
  57
  58   TICKET ticket(m_wQueueId, m_dwNextItemId++);
  59
  60   Command request = {ticket, aUrl, "", aObserver};
  61   m_queue.push(request);
  62
  63   LeaveCriticalSection(&m_critical);
  64   return request.ticket;
  65 }
  66
  67 TICKET CDownloadQueue::RequestFile(const CStdString& aUrl, const CStdString& aFilePath, IDownloadQueueObserver* aObserver)
  68 {
  69   EnterCriticalSection(&m_critical);
  70
  71   TICKET ticket(m_wQueueId, m_dwNextItemId++);
  72
  73   Command request = {ticket, aUrl, aFilePath, aObserver};
  74   m_queue.push(request);
  75
  76   LeaveCriticalSection(&m_critical);
  77   return request.ticket;
  78 }
  79
  80 void CDownloadQueue::CancelRequests(IDownloadQueueObserver *aObserver)
  81 {
  82   EnterCriticalSection(&m_critical);
  83
  84   CLog::Log(LOGDEBUG, "CancelRequests from observer at %p", aObserver);
  85   // run through our queue, and create a new queue with the requests
  86   // from aObserver NULL'd out.
  87   queue<Command> newQueue;
  88   while (m_queue.size())
  89   {
  90     Command request = m_queue.front();
  91     m_queue.pop();
  92     if (request.observer == aObserver)
  93       request.observer = NULL;
  94     newQueue.push(request);
  95   }
  96   m_queue = newQueue;
  97   LeaveCriticalSection(&m_critical);
  98 }
  99
 100 TICKET CDownloadQueue::RequestFile(const CStdString& aUrl, IDownloadQueueObserver* aObserver)
 101 {
 102   EnterCriticalSection(&m_critical);
 103
 104   CLog::Log(LOGDEBUG, "RequestFile from observer at %p", aObserver);
 105   // create a temporary destination
 106   CStdString strExtension;
 107   CUtil::GetExtension(aUrl, strExtension);
 108
 109   TICKET ticket(m_wQueueId, m_dwNextItemId++);
 110
 111   CStdString strFilePath;
 112   strFilePath.Format("special://temp/q%d-item%u%s", ticket.wQueueId, ticket.dwItemId, strExtension.c_str());
 113
 114   Command request = {ticket, aUrl, strFilePath, aObserver};
 115   m_queue.push(request);
 116
 117   LeaveCriticalSection(&m_critical);
 118   return request.ticket;
 119 }
 120
 121 VOID CDownloadQueue::Flush()
 122 {
 123   EnterCriticalSection(&m_critical);
 124
 125   m_queue.empty();
 126
 127   LeaveCriticalSection(&m_critical);
 128 }
 129
 130 void CDownloadQueue::Process()
 131 {
 132   CLog::Log(LOGNOTICE, "DownloadQueue ready.");
 133
 134   CFileCurl http;
 135   bool bSuccess;
 136
 137   while ( !m_bStop )
 138   {
 139     while ( CDownloadQueue::Size() > 0 )
 140     {
 141       EnterCriticalSection(&m_critical);
 142
 143       // get the first item, but don't pop it from our queue
 144       // so that the download can be interrupted
 145       Command request = m_queue.front();
 146
 147       LeaveCriticalSection(&m_critical);
 148
 149       bool bFileRequest = request.content.length() > 0;
 150       DWORD dwSize = 0;
 151
 152       if (bFileRequest)
 153       {
 154         CFile::Delete(request.content);
 155         bSuccess = http.Download(request.location, request.content, &dwSize);
 156       }
 157       else
 158       {
 159         bSuccess = http.Get(request.location, request.content);
 160       }
 161
 162       // now re-grab the item as we may have cancelled our download
 163       // while we were working
 164       EnterCriticalSection(&m_critical);
 165
 166       request = m_queue.front();
 167       m_queue.pop();
 168
 169       // if the request has been cancelled our observer will be NULL
 170       if (NULL != request.observer)
 171       {
 172         try
 173         {
 174           if (bFileRequest)
 175           {
 176             request.observer->OnFileComplete(request.ticket, request.content, dwSize,
 177                                             bSuccess ? IDownloadQueueObserver::Succeeded : IDownloadQueueObserver::Failed );
 178           }
 179           else
 180           {
 181             request.observer->OnContentComplete(request.ticket, request.content,
 182                                                 bSuccess ? IDownloadQueueObserver::Succeeded : IDownloadQueueObserver::Failed );
 183           }
 184         }
 185         catch (...)
 186         {
 187           CLog::Log(LOGERROR, "exception while updating download observer.");
 188
 189           if (bFileRequest)
 190           {
 191             CFile::Delete(request.content);
 192           }
 193         }
 194       }
 195       LeaveCriticalSection(&m_critical);
 196     }
 197
 198     Sleep(500);
 199   }
 200
 201   CLog::Log(LOGNOTICE, "DownloadQueue terminated.");
 202 }
 203
 204 INT CDownloadQueue::Size()
 205 {
 206   EnterCriticalSection(&m_critical);
 207
 208   int sizeOfQueue = m_queue.size();
 209
 210   LeaveCriticalSection(&m_critical);
 211
 212   return sizeOfQueue;
 213 }
 214