DownloadDevice.h

Go to the documentation of this file.

/*
//
// BEGIN SONGBIRD GPL
//
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2008 POTI, Inc.
// http://songbirdnest.com
//
// This file may be licensed under the terms of of the
// GNU General Public License Version 2 (the "GPL").
//
// Software distributed under the License is distributed
// on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
// express or implied. See the GPL for the specific language
// governing rights and limitations.
//
// You should have received a copy of the GPL along with this
// program. If not, go to http://www.gnu.org/licenses/gpl.html
// or write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// END SONGBIRD GPL
//
*/

#ifndef __DOWNLOAD_DEVICE_H__
#define __DOWNLOAD_DEVICE_H__

/* *****************************************************************************
 *******************************************************************************
 *
 * Download device.
 *
 *******************************************************************************
 ******************************************************************************/

/* *****************************************************************************
 *
 * Download device configuration.
 *
 ******************************************************************************/

/*
 * Download device XPCOM component definitions.
 */

#define SONGBIRD_DownloadDevice_CONTRACTID                                     \
                    "@songbirdnest.com/Songbird/OldDeviceImpl/DownloadDevice;1"
#define SONGBIRD_DownloadDevice_CLASSNAME "Songbird Download Device"
#define SONGBIRD_DownloadDevice_CID                                            \
{                                                                              \
    0x961DA3F4,                                                                \
    0x5EF1,                                                                    \
    0x4AD0,                                                                    \
    { 0x81, 0x8d, 0x62, 0x2C, 0x7B, 0xD1, 0x74, 0x47}                          \
}


/* *****************************************************************************
 *
 * Download device imported services.
 *
 ******************************************************************************/

/* Local imports. */
#include <DeviceBase.h>
#include <sbIDownloadDevice.h>

/* Mozilla imports. */
#include <nsAutoPtr.h>
#include <nsCOMPtr.h>
#include <nsIDialogParamBlock.h>
#include <nsIFile.h>
#include <nsIIOService.h>
#include <nsIObserverService.h>
#include <nsIPrefService.h>
#include <nsIRunnable.h>
#include <nsIStringBundle.h>
#include <nsIThreadPool.h>
#include <prmon.h>

/* Songbird imports. */
#include <sbDownloadButtonPropertyInfo.h>
#include <sbIDataRemote.h>
#include <sbILibrary.h>
#include <sbILibraryUtils.h>



nsCString GetContentDispositionFilename(const nsACString &contentDisposition);

/* *****************************************************************************
 *
 * Download device classes.
 *
 ******************************************************************************/

/*
 * sbDownloadDevice class.
 */

class sbDownloadSession;

class sbDownloadDevice : public nsIObserver,
                         public sbIDownloadDevice,
                         public sbDeviceBase,
                         public sbIMediaListListener
{
    /* *************************************************************************
     *
     * Friends.
     *
     **************************************************************************/

    friend class sbDownloadSession;


    /* *************************************************************************
     *
     * Public interface.
     *
     **************************************************************************/

    public:

    /*
     * Inherited interfaces.
     */

    NS_DECL_ISUPPORTS
    NS_DECL_NSIOBSERVER
    NS_DECL_SBIDEVICEBASE
    NS_DECL_SBIDOWNLOADDEVICE
    NS_DECL_SBIMEDIALISTLISTENER


    /*
     * Public download device services.
     */

    sbDownloadDevice();

    virtual ~sbDownloadDevice();


    /* *************************************************************************
     *
     * Private interface.
     *
     **************************************************************************/

    private:

    /*
     * mpDownloadMediaList      Download device medialist.
     * mpDeviceLibraryListener  Songbird device library listener.
     * mpMainLibrary            Main library.
     * mpWebLibrary             Web library.
     * mpPrefBranch             Preference branch.
     * mpIOService              I/O service.
     * mpStringBundle           Download device string bundle.
     * mQueuedStr               Download queued string.
     * mpTmpDownloadDir         Temporary download directory.
     * mpDownloadSession        Current download session.
     * mpDeviceLock             Lock for download device access.
     * mDeviceIdentifier        Download device identifier.
     * mFileMoveThreadPool      Thread pool to move files on completion
     */

    nsCOMPtr<sbIMediaList>      mpDownloadMediaList;
    nsRefPtr<sbDeviceBaseLibraryListener>
                                mpDeviceLibraryListener;
    nsCOMPtr<sbILibrary>        mpMainLibrary;
    nsCOMPtr<sbILibrary>        mpWebLibrary;
    nsCOMPtr<nsIPrefBranch>     mpPrefBranch;
    nsCOMPtr<nsIIOService>      mpIOService;
    nsCOMPtr<nsIStringBundle>   mpStringBundle;
    nsString                    mQueuedStr;
    nsCOMPtr<nsIFile>           mpTmpDownloadDir;
    nsRefPtr<sbDownloadSession> mpDownloadSession;
    PRMonitor                   *mpDeviceMonitor;
    nsString                    mDeviceIdentifier;

    nsCOMPtr<nsIThreadPool>     mFileMoveThreadPool;

    /*
     * Private media list services.
     */

    nsresult InitializeDownloadMediaList();

    void FinalizeDownloadMediaList();

    nsresult CreateDownloadMediaList();

    void GetDownloadMediaList();

    nsresult UpdateDownloadMediaList();


    /*
     * Private transfer services.
     */

    nsresult EnqueueItem(
        sbIMediaItem                *apMediaItem);

    nsresult RunTransferQueue();

    PRBool GetNextTransferItem(
        sbIMediaItem                **appMediaItem);

    nsresult ResumeTransfers();

    nsresult SetTransferDestination(
        nsCOMPtr<sbIMediaItem>      pMediaItem);

    nsresult CancelSession();

    void SessionCompleted(
        sbDownloadSession           *apDownloadSession,
        PRInt32                     aStatus);


    /*
     * Private services.
     */

    nsresult GetTmpFile(
        nsIFile                     **ppTmpFile);

    static nsresult MakeFileUnique(
        nsIFile                     *apFile);

    nsresult OpenDialog(
        char                        *aChromeURL,
        nsIDialogParamBlock         *apDialogPB);

    static nsresult GetStatusTarget(
        sbIMediaItem                *apMediaItem,
        sbIMediaItem                **apStatusTarget);
};


/* *****************************************************************************
 *******************************************************************************
 *
 * Download session.
 *
 *******************************************************************************
 ******************************************************************************/

/* *****************************************************************************
 *
 * Download session imported services.
 *
 ******************************************************************************/

/* Mozilla imports. */
#include <nsIFileProtocolHandler.h>
#include <nsIHttpChannel.h>
#include <nsIHttpEventSink.h>
#include <nsIInterfaceRequestor.h>
#include <nsIProgressEventSink.h>
#include <nsIWebBrowserPersist.h>
#include <nsIWebProgressListener.h>
#include <nsITimer.h>


/* *****************************************************************************
 *
 * Download session classes.
 *
 ******************************************************************************/

/*
 * sbDownloadSession class.
 */

class sbDownloadSession : public nsIWebProgressListener, nsITimerCallback
{
    /* *************************************************************************
     *
     * Public interface.
     *
     **************************************************************************/

    public:

    /*
     * mpMediaItem              Media item being downloaded.
     * mSrcURISpec              Source URI spec string.
     * mDstURISpec              Destination URI spec string.
     */

    nsCOMPtr<sbIMediaItem>      mpMediaItem;
    nsString                    mSrcURISpec;
    nsString                    mDstURISpec;


    /*
     * Inherited interfaces.
     */

    NS_DECL_ISUPPORTS
    NS_DECL_NSIWEBPROGRESSLISTENER
    NS_DECL_NSITIMERCALLBACK

    /*
     * Public download session services.
     */

    sbDownloadSession(
        sbDownloadDevice            *pDownloadDevice,
        sbIMediaItem                *pMediaItem);

    virtual ~sbDownloadSession();

    nsresult Initiate();

    nsresult Suspend();

    nsresult Resume();

    void Shutdown();

    PRBool IsSuspended();


    /* *************************************************************************
     *
     * Private interface.
     *
     **************************************************************************/

    private:

    /*
     * mpSessionLock            Lock for session.
     * mpDownloadDevice         Managing download device.
     * mpStringBundle           Download device string bundle.
     * mCompleteStr             Download complete string.
     * mErrorStr                Download error string.
     * mpLibraryUtils           Library utilities service.
     * mpFileProtocolHandler    File protocol handler.
     * mpWebBrowser             Web browser used for download.
     * mpChannel                Download channel.
     * mpTmpFile                Temporary download file.
     * mpSrcURI                 Source download URI.
     * mpDstLibrary             Destination library.
     * mpDstFile                Destination download file.
     * mpDstURI                 Destination download URI.
     * mEntityID                Entity ID of the download (for resuming).
     * mShutdown                True if session has been shut down.
     * mSuspended               True if session is suspended.
     * mLastUpdate              Last time progress was updated.
     * mInitialProgressBytes    Number of bytes already downloaded when a new channel was created.
     * mLastProgressBytes       Number of progress bytes on last update.
     * mRate                    Download rate.
     * mIdleTimer               Idle timer cancels downloads that aren't
     *                          seeing progress.
     */

    PRLock                      *mpSessionLock;
    sbDownloadDevice            *mpDownloadDevice;
    nsCOMPtr<nsIStringBundle>   mpStringBundle;
    nsString                    mCompleteStr;
    nsString                    mErrorStr;
    nsCOMPtr<sbILibraryUtils>   mpLibraryUtils;
    nsCOMPtr<nsIWebBrowserPersist>
                                mpWebBrowser;
    nsCOMPtr<nsIChannel>        mpRequest;
    nsCOMPtr<nsIFile>           mpTmpFile;
    nsCOMPtr<nsIURI>            mpSrcURI;
    nsCOMPtr<sbILibrary>        mpDstLibrary;
    nsCOMPtr<nsIFile>           mpDstFile;
    nsCOMPtr<nsIURI>            mpDstURI;
    nsCOMPtr<sbIMediaItem>      mpStatusTarget;
    nsCString                   mEntityID;
    PRBool                      mShutdown;
    PRBool                      mSuspended;
    PRTime                      mLastUpdate;
    PRInt64                     mInitialProgressBytes;
    PRUint64                    mLastProgressBytes;
    PRUint64                    mLastProgressBytesMax;
    double                      mRate;
    nsCOMPtr<nsITimer>          mIdleTimer;
    nsCOMPtr<nsITimer>          mProgressTimer;


    /*
     * Private download session services.
     */

    nsresult SetUpRequest();

    nsresult CompleteTransfer(nsIRequest* aRequest);

    nsresult UpdateDstLibraryMetadata();

    void UpdateProgress(
        PRUint64                    aProgress,
        PRUint64                    aProgressMax);

    void UpdateDownloadDetails(
        PRUint64                    aProgress,
        PRUint64                    aProgressMax);

    void UpdateDownloadRate(
        PRUint64                    aProgress,
        PRUint64                    aElapsedUSecs);

    nsresult FormatProgress(
        nsString                    &aProgressStr,
        PRUint64                    aProgress,
        PRUint64                    aProgressMax,
        double                      aRate,
        PRUint32                    aRemSeconds);

    nsresult FormatRate(
        nsString                    &aRateStr,
        double                      aRate);

    nsresult FormatByteProgress(
        nsString                    &aByteProgressStr,
        PRUint64                    aBytes,
        PRUint64                    aBytesMax);

    nsresult FormatTime(
        nsString                    &aTimeStr,
        PRUint32                    aSeconds);

    nsresult StartTimers();
    nsresult StopTimers();
    nsresult ResetTimers();


    /* *************************************************************************
     *
     * Library metadata updater class.
     *
     **************************************************************************/

    class LibraryMetadataUpdater : public sbIMediaListEnumerationListener
    {
        /*
         * Public interface.
         */

        public:

        NS_DECL_ISUPPORTS
        NS_DECL_SBIMEDIALISTENUMERATIONLISTENER


        /*
         * Private interface.
         */

        private:

        nsCOMPtr<nsIMutableArray>   mpMediaItemArray;
    };


    /* *************************************************************************
     *
     * Web library updater class.
     *
     **************************************************************************/

    class WebLibraryUpdater : public sbIMediaListEnumerationListener
    {
        /*
         * Public interface.
         */

        public:

        NS_DECL_ISUPPORTS
        NS_DECL_SBIMEDIALISTENUMERATIONLISTENER

        WebLibraryUpdater(
            sbDownloadSession           *pDownloadSession)
        :
            mpDownloadSession(pDownloadSession)
        {
        }


        /*
         * Private interface.
         */

        private:

        sbDownloadSession           *mpDownloadSession;
    };
};

class sbAutoDownloadButtonPropertyValue
{
public:
  sbAutoDownloadButtonPropertyValue(sbIMediaItem* aMediaItem,
                                    sbIMediaItem* aStatusTarget = nsnull,
                                    PRBool aReadOnly = PR_FALSE);
  ~sbAutoDownloadButtonPropertyValue();

  nsAutoPtr<sbDownloadButtonPropertyValue> value;

private:
  nsCOMPtr<sbIMediaItem> mMediaItem;
  nsCOMPtr<sbIMediaItem> mStatusTarget;
  PRBool mReadOnly;
};

class sbDownloadSessionMoveHandler : public nsIRunnable
{
public:
  explicit sbDownloadSessionMoveHandler(nsIFile *aSourceFile,
                                        nsIFile *aDestinationPath,
                                        const nsAString &aDestinationFileName,
                                        sbIMediaItem *aDestinationItem) {
    NS_ASSERTION(aSourceFile, "aSourceFile is null!");
    NS_ASSERTION(aDestinationPath, "aDestinationPath is null!");
    NS_ASSERTION(aDestinationItem, "aDestinationItem is null!");

    mSourceFile = aSourceFile;
    mDestinationPath = aDestinationPath;
    mDestinationFileName = aDestinationFileName;
    mDestinationItem = aDestinationItem;
  }

  NS_DECL_ISUPPORTS
  NS_DECL_NSIRUNNABLE

private:
  nsCOMPtr<nsIFile> mSourceFile;
  nsCOMPtr<nsIFile> mDestinationPath;
  nsString          mDestinationFileName;

  nsCOMPtr<sbIMediaItem> mDestinationItem;
};

#endif // __DOWNLOAD_DEVICE_H__