sbLocalDatabaseDiffingService.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 __SB_LOCALDATABASEDIFFINGSERVICE_H__
#define __SB_LOCALDATABASEDIFFINGSERVICE_H__

#include <sbILibraryDiffingService.h>

#include <nsIClassInfo.h>
#include <nsIGenericFactory.h>
#include <nsIThread.h>

#include <sbILibrary.h>
#include <sbILibraryChangeset.h>
#include <sbIMediaItem.h>
#include <sbIMediaList.h>
#include <sbIMediaListListener.h>
#include <sbIPropertyArray.h>
#include <sbIPropertyManager.h>

#include <nsAutoPtr.h>
#include <nsCOMPtr.h>
#include <nsInterfaceHashtable.h>
#include <nsTArray.h>

#include <sbLibraryChangeset.h>

class sbLDBDSEnumerator;

class sbLocalDatabaseDiffingService : public sbILibraryDiffingService,
                                      public nsIClassInfo
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSICLASSINFO
  NS_DECL_SBILIBRARYDIFFINGSERVICE

  sbLocalDatabaseDiffingService();

  static NS_METHOD RegisterSelf(nsIComponentManager* aCompMgr,
                                nsIFile* aPath,
                                const char* aLoaderStr,
                                const char* aType,
                                const nsModuleComponentInfo *aInfo);

  nsresult Init();

protected:
  nsresult GetPropertyIDs(nsIStringEnumerator **aPropertyIDs);

  nsresult CreateLibraryChangeFromItems(sbIMediaItem *aSourceItem,
                                        sbIMediaItem *aDestinationItem,
                                        sbILibraryChange **aLibraryChange);

  nsresult CreateItemAddedLibraryChange(sbIMediaItem *aSourceItem,
                                        sbILibraryChange **aLibraryChange);

  nsresult CreateItemMovedLibraryChange(sbIMediaItem *aSourceItem,
                                        PRUint32 aItemOrdinal,
                                        sbILibraryChange **aLibraryChange);

  nsresult CreateItemDeletedLibraryChange(sbIMediaItem *aDestinationItem,
                                          sbILibraryChange **aLibraryChange);

  nsresult CreatePropertyChangesFromProperties(sbIPropertyArray *aSourceProperties,
                                               sbIPropertyArray *aDestinationProperties,
                                               nsIArray **aPropertyChanges);

  nsresult CreateLibraryChangesetFromLists(sbIMediaList *aSourceList,
                                           sbIMediaList *aDestinationList,
                                           sbILibraryChangeset **aLibraryChangeset);

  nsresult CreateChanges(sbIMediaList * aSrcLibrary,
                         sbIMediaList * aDestLibrary,
                         sbLDBDSEnumerator * aSrcEnum,
                         sbLDBDSEnumerator * aDestEnum,
                         nsIArray ** aChanges);
  nsresult CreateLibraryChangesetFromLibraries(sbILibrary *aSourceLibrary,
                                               sbILibrary *aDestinationLibrary,
                                               sbILibraryChangeset **aLibraryChangeset);

  nsresult CreateLibraryChangesetFromListsToLibrary(nsIArray *aSourceLists,
                                                    sbILibrary *aDestinationLibrary,
                                                    sbILibraryChangeset **aLibraryChangeset);

  nsresult AddToUniqueItemList(
    sbIMediaItem*                                        aSourceItem,
    sbIPropertyArray*                                    aUniquePropSet,
    nsInterfaceHashtable<nsStringHashKey, sbIMediaItem>& aUniqueItemList,
    nsTArray<nsString>&                                  aUniqueItemGUIDList,
    nsTHashtable<nsStringHashKey>&                       aUniqueItemPropTable);

  static PLDHashOperator Enumerator(nsIDHashKey* aEntry, void* userArg);
private:
  ~sbLocalDatabaseDiffingService();

protected:
  nsCOMPtr<nsIThread> mProcessorThread;
  nsCOMPtr<sbIPropertyManager> mPropertyManager;

//  XXXAus: These are placeholders for future implementation.
//  nsInterfaceHashtableMT<> mObservers;
//  nsInterfaceHashtableMT<> mChangesets;
};

#endif /* __SB_LOCALDATABASEDIFFINGSERVICE_H__ */