sbIMediaItemDownloader.idl

Go to the documentation of this file.

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 :miv */
/*
 *=BEGIN SONGBIRD GPL
 *
 * This file is part of the Songbird web player.
 *
 * Copyright(c) 2005-2010 POTI, Inc.
 * http://www.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
 */

// Mozilla imports.
#include "nsISupports.idl"

// Interface declarations.
interface sbILibrary;
interface sbIMediaItem;
interface sbIMediaItemDownloadJob;

[scriptable, uuid(65b0423e-1dd2-11b2-8f1d-8a6e9596b52a)]
interface sbIMediaItemDownloader : nsISupports
{
  //
  // Downloader vote defs.
  //
  //   When voting to download a media item, downloaders may use one of these
  // downloader vote constants.  Downloaders may return whatever vote value they
  // deem appropriate.  These constants are provided as a guideline.
  //

  const unsigned long VOTE_NONE = 0;

  const unsigned long VOTE_SCHEME = 100;

  const unsigned long VOTE_HOST = 200;

  const unsigned long VOTE_WHOLE_URL = 300;

  const unsigned long VOTE_MEDIA_ITEM_PROPERTIES = 400;

  const unsigned long VOTE_TARGET_LIBRARY = 500;


  unsigned long vote(in sbIMediaItem aMediaItem,
                     in sbILibrary   aTargetLibrary);

  unsigned long long getDownloadSize(in sbIMediaItem aMediaItem,
                                     in sbILibrary   aTargetLibrary);

  sbIMediaItemDownloadJob createDownloadJob(in sbIMediaItem aMediaItem,
                                            in sbILibrary   aTargetLibrary);
};


//
// C++ defs.
//

%{C++

#include <nsIComponentManager.h>
#include <nsICategoryManager.h>
#include <nsIGenericFactory.h>
#include <nsIServiceManager.h>

#include <nsCOMPtr.h>
#include <nsServiceManagerUtils.h>
#include <nsStringGlue.h>
#include <nsXPCOMCID.h>

class nsIFile;
struct nsModuleComponentInfo;

#define SB_MEDIA_ITEM_DOWNLOADER_CATEGORY "songbird-media-item-downloader"

#define SB_MEDIA_ITEM_DOWNLOADER_REGISTERSELF(_name)                           \
                                                                               \
  NS_METHOD _name##RegisterSelf(nsIComponentManager* aCompMgr,                 \
                                nsIFile* aPath,                                \
                                const char* registryLocation,                  \
                                const char* componentType,                     \
                                const nsModuleComponentInfo* info);            \
                                                                               \
  NS_METHOD _name##UnregisterSelf(nsIComponentManager* aCompMgr,               \
                                  nsIFile* aPath,                              \
                                  const char* registryLocation,                \
                                  const nsModuleComponentInfo* info);

#define SB_MEDIA_ITEM_DOWNLOADER_REGISTERSELF_IMPL(_name)                      \
                                                                               \
  NS_METHOD                                                                    \
  _name##RegisterSelf(nsIComponentManager* aCompMgr,                           \
                      nsIFile* aPath,                                          \
                      const char* registryLocation,                            \
                      const char* componentType,                               \
                      const nsModuleComponentInfo* info)                       \
  {                                                                            \
    nsresult rv;                                                               \
    nsCOMPtr<nsICategoryManager> catMan =                                      \
      do_GetService(NS_CATEGORYMANAGER_CONTRACTID, &rv);                       \
    NS_ENSURE_SUCCESS(rv, rv);                                                 \
    nsCAutoString prevEntry;                                                   \
    rv = catMan->AddCategoryEntry(SB_MEDIA_ITEM_DOWNLOADER_CATEGORY,           \
                                  info->mContractID,                           \
                                  info->mContractID,                           \
                                  PR_TRUE, PR_TRUE,                            \
                                  getter_Copies(prevEntry));                   \
    NS_ENSURE_SUCCESS(rv, rv);                                                 \
    NS_WARN_IF_FALSE(prevEntry.IsEmpty(),                                      \
                     "Another downloader was registered with that id!");       \
    return NS_OK;                                                              \
  }                                                                            \
                                                                               \
  NS_METHOD                                                                    \
  _name##UnregisterSelf(nsIComponentManager* aCompMgr,                         \
                        nsIFile* aPath,                                        \
                        const char* registryLocation,                          \
                        const nsModuleComponentInfo* info)                     \
  {                                                                            \
    nsresult rv;                                                               \
    nsCOMPtr<nsICategoryManager> catMan =                                      \
      do_GetService(NS_CATEGORYMANAGER_CONTRACTID, &rv);                       \
    NS_ENSURE_SUCCESS(rv, rv);                                                 \
    rv = catMan->DeleteCategoryEntry(SB_MEDIA_ITEM_DOWNLOADER_CATEGORY,        \
                                     info->mContractID,                        \
                                     PR_TRUE);                                 \
    NS_ENSURE_SUCCESS(rv, rv);                                                 \
    return NS_OK;                                                              \
  }
%}