sbLibraryUtils.h

Go to the documentation of this file.

/*
 *=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
 */


#ifndef __SBLIBRARYUTILS_H__
#define __SBLIBRARYUTILS_H__

// Mozilla inclues
#include <nsCOMArray.h>
#include <nsCOMPtr.h>
#include <pratom.h>
#include <nsServiceManagerUtils.h>
#include <nsComponentManagerUtils.h>
#include <nsStringAPI.h>

// Mozilla interfaces
#include <nsIMutableArray.h>

// Songbird includes
#include <sbMemoryUtils.h>

// Songbird interfaces
#include <sbILibrary.h>
#include <sbILibraryManager.h>

class sbIMediaItem;
class sbILibrary;
class nsIIOService;
class sbIPropertyOperator;

class sbLibraryBatchHelper
{
public:
  sbLibraryBatchHelper() :
    mDepth(0)
  {
    MOZ_COUNT_CTOR(sbLibraryBatchHelper);
  }

  ~sbLibraryBatchHelper()
  {
    MOZ_COUNT_DTOR(sbLibraryBatchHelper);
  }

  void Begin()
  {
    NS_ASSERTION(mDepth >= 0, "Illegal batch depth, mismatched calls!");
    PR_AtomicIncrement(&mDepth);
  }

  void End()
  {
#ifdef DEBUG
    PRInt32 depth = PR_AtomicDecrement(&mDepth);
    NS_ASSERTION(depth >= 0, "Illegal batch depth, mismatched calls!");
#else
    PR_AtomicDecrement(&mDepth);
#endif
  }

  PRUint32 Depth()
  {
    return (PRUint32) mDepth;
  }

  PRBool IsActive()
  {
    return mDepth > 0;
  }

private:
  PRInt32 mDepth;
};

class sbLibraryUtils
{
public:
  static nsresult GetItemInLibrary(/* in */  sbIMediaItem * aItem,
                                   /* in */  sbILibrary   * aLibrary,
                                   /* out */ sbIMediaItem **_retval);

  static nsresult FindItemsWithSameURL(sbIMediaItem *    aMediaItem,
                                       sbIMediaList *    aMediaList,
                                       nsIMutableArray * aCopies);

  static nsresult FindCopiesByID(sbIMediaItem * aMediaItem,
                                 sbIMediaList * aList,
                                 nsIMutableArray * aCopies);

  static nsresult FindOriginalsByID(sbIMediaItem * aMediaItem,
                                    sbIMediaList * aList,
                                    nsIMutableArray * aCopies);
  static nsresult GetOriginItem(/* in */ sbIMediaItem*   aItem,
                                /* out */ sbIMediaItem** _retval);
  static nsresult GetContentLength(/* in */  sbIMediaItem * aItem,
                                   /* out */ PRInt64      * _retval = nsnull);

  static nsresult SetContentLength(/* in */  sbIMediaItem * aItem,
                                   /* in */  nsIURI       * aURI);

  static nsresult GetContentURI(/* in  */ nsIURI*   aURI,
                                /* out */ nsIURI** _retval,
                                /* in  */ nsIIOService * aIOService = nsnull);

  static nsresult GetMediaListContentType(/* in  */ sbIMediaList *aMediaList,
                                          /* out */ PRUint16 *aListContentType);

  static nsresult GetFileContentURI(/* in  */ nsIFile*  aFile,
                                    /* out */ nsIURI** _retval);

  static nsresult GetItemsByProperty(sbIMediaList * aMediaList,
                                     nsAString const & aPropertyName,
                                     nsAString const & aValue,
                                     nsCOMArray<sbIMediaItem> & aMediaItems);

  static nsresult GetMediaListByContentType(sbILibrary * aLibrary,
                                            PRUint32 aContentType,
                                            nsIArray ** aMediaLists);

  static PRUint32 GetEqualOperator(sbIPropertyOperator ** aOperator);

  static nsresult SuggestUniqueNameForPlaylist(
                    /* in  */ sbILibrary *aLibrary,
                    /* in  */ nsAString const & aListName,
                    /* out */ nsAString & aName);
  static nsresult LinkCopy(sbIMediaItem * aOriginal, sbIMediaItem * aCopy);
};

inline
nsresult GetMainLibrary(sbILibrary ** aMainLibrary) {
  nsresult rv;
  nsCOMPtr<sbILibraryManager> libManager =
      do_GetService("@songbirdnest.com/Songbird/library/Manager;1", &rv);
  NS_ENSURE_SUCCESS(rv, rv);

  nsCOMPtr<sbILibrary> mainLibrary;
  return libManager->GetMainLibrary(aMainLibrary);
}

inline
PRBool sbIsMainLibrary(sbILibrary * aLibrary)
{
  NS_ENSURE_ARG_POINTER(aLibrary);

  nsresult rv;

  nsCOMPtr<sbILibrary> mainLibrary;
  rv = GetMainLibrary(getter_AddRefs(mainLibrary));
  NS_ENSURE_SUCCESS(rv, PR_FALSE);

  PRBool isEqual;
  rv = mainLibrary->Equals(aLibrary, &isEqual);
  NS_ENSURE_SUCCESS(rv, PR_FALSE);

  return isEqual;
}

inline
nsresult GetMainLibraryId(nsAString & aLibraryId) {

  nsCOMPtr<sbILibrary> mainLibrary;
  nsresult rv = GetMainLibrary(getter_AddRefs(mainLibrary));
  NS_ENSURE_SUCCESS(rv, rv);

  return mainLibrary->GetGuid(aLibraryId);
}

//
// Auto-disposal class wrappers.
//
//   sbAutoRemoveMediaItem      Wrapper to auto-remove a media item from its
//                              library.
//

SB_AUTO_NULL_CLASS(sbAutoRemoveMediaItem,
                   nsCOMPtr<sbIMediaItem>,
                   {
                     nsCOMPtr<sbILibrary> library;
                     nsresult rv = mValue->GetLibrary(getter_AddRefs(library));
                     if (NS_SUCCEEDED(rv))
                       library->Remove(mValue);
                   });

#endif // __SBLIBRARYUTILS_H__