sbMetadataJob.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 SBMETADATAJOB_H_
#define SBMETADATAJOB_H_

// INCLUDES ===================================================================

#include <nscore.h>
#include <prlock.h>
#include <nsAutoLock.h>
#include <nsStringGlue.h>
#include <nsTArray.h>
#include <nsCOMArray.h>
#include <nsCOMPtr.h>
#include <nsAutoPtr.h>
#include <nsIClassInfo.h>

#include <sbIAlbumArtListener.h>
#include <sbIMediaItem.h>
#include <sbIJobProgress.h>
#include <sbIJobProgressUI.h>
#include <sbIJobCancelable.h>
#include <sbIPropertyManager.h>

#include <sbMediaListBatchCallback.h>

#include <set>

// CLASSES ====================================================================
typedef std::set<nsString> sbStringSet;

class sbMetadataJobItem;
class sbIMutablePropertyArray;
class sbIAlbumArtFetcherSet;

class sbMetadataJob : public nsIClassInfo,
                      public sbIJobProgressUI,
                      public sbIJobCancelable,
                      public sbIAlbumArtListener
{
  friend class sbMediaListBatchCallback;
  
public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSICLASSINFO
  NS_DECL_SBIJOBPROGRESS
  NS_DECL_SBIJOBPROGRESSUI
  NS_DECL_SBIJOBCANCELABLE
  NS_DECL_SBIALBUMARTLISTENER
  
  enum JobType 
  {
    TYPE_READ  = 0,
    TYPE_WRITE = 1
  };

  sbMetadataJob();
  virtual ~sbMetadataJob();

  nsresult Init(nsIArray *aMediaItemsArray,
                nsIStringEnumerator* aRequiredProperties,
                JobType aJobType);

  nsresult AppendMediaItems(nsIArray* aMediaItemsArray);

  nsresult AppendJobItem(sbMetadataJobItem* aJobItem);

  nsresult OnJobProgress();
  
  nsresult GetQueuedItem(PRBool aMainThreadOnly, sbMetadataJobItem** aJobItem);
  
  nsresult PutProcessedItem(sbMetadataJobItem* aJobItem);
  
  nsresult GetType(JobType* aJobType);

  nsresult SetBlocked(PRBool aBlocked);
  
  
private:
  
  nsresult SetUpHandlerForJobItem(sbMetadataJobItem* aJobItem);

  nsresult PrepareWriteItem(sbMetadataJobItem* aJobItem);

  nsresult HandleProcessedItem(sbMetadataJobItem *aJobItem);

  nsresult HandleWrittenItem(sbMetadataJobItem *aJobItem);
  
  nsresult DeferProcessedItemHandling(sbMetadataJobItem *aJobItem);

  nsresult CopyPropertiesToMediaItem(sbMetadataJobItem* aJobItem,
                                     PRBool* aWillRetry);
  
  nsresult ReadAlbumArtwork(sbMetadataJobItem* aJobItem);

  nsresult HandleFailedItem(sbMetadataJobItem* aJobItem, 
                            PRBool aShouldRetry = PR_FALSE, 
                            PRBool *aWillRetry = nsnull);

  nsresult BatchCompleteItems();

  static nsresult RunLibraryBatch(nsISupports* aUserData);
  
  nsresult BatchCompleteItemsCallback();

  nsresult BeginLibraryBatch();
  nsresult EndLibraryBatch();


  nsresult CreateDefaultItemName(sbIMediaItem* aMediaItem,
                                 nsAString& retval);

  nsresult AppendToPropertiesIfValid(sbIPropertyManager* aPropertyManager,
                                     sbIMutablePropertyArray* aProperties, 
                                     const nsAString& aID, 
                                     const nsAString& aValue);
  nsresult GetFileSize(sbIMediaItem* aMediaItem, PRInt64* aFileSize);
  
  nsresult LocalizeString(const nsAString& aName, nsAString& aValue);
  
  
  // sbIJobProgress variables
  PRUint16                                 mStatus;
  PRBool                                   mBlocked;
  PRUint32                                 mCompletedItemCount;
  PRUint32                                 mTotalItemCount;
  nsTArray<nsString>                       mErrorMessages;
  nsString                                 mTitleText;
  nsString                                 mStatusText;
  nsCOMArray<sbIJobProgressListener>       mListeners;
  
  // TYPE_READ or TYPE_WRITE
  JobType                                  mJobType;
  
  // The library to which all items in this job belong 
  // (since batch operations are per-library) 
  nsCOMPtr<sbILibrary>                     mLibrary;
  
  // List of properties we require for this job
  nsStringArray                            mRequiredProperties;

  // List of absolute paths that the watch folder service is ignoring.
  sbStringSet                              mIgnoredContentPaths;
  
  // List of job items that MUST be processed on the 
  // main thread due to sbIMetadataHandler limitations
  nsTArray<nsRefPtr<sbMetadataJobItem> >   mMainThreadJobItems;
  PRUint32                                 mNextMainThreadIndex;
  
  // List of job items that may be processed off of the main thread
  // TODO consider using nsDeque
  nsTArray<nsRefPtr<sbMetadataJobItem> >   mBackgroundThreadJobItems;
  PRUint32                                 mNextBackgroundThreadIndex;
  PRLock*                                  mBackgroundItemsLock;
  
  // Pointer to a list of items that have been returned from processing, but have 
  // not yet had their properties set.
  // Used to perform sbIMediaItem.setProperties() batching.
  nsAutoPtr<nsTArray<nsRefPtr<sbMetadataJobItem> > >  
                                           mProcessedBackgroundThreadItems;
  PRLock*                                  mProcessedBackgroundItemsLock;
  
  // Indicates that we've started a library batch, and need
  // to close it before we complete
  PRBool                                   mInLibraryBatch;

  // Cached art fetcher instance
  nsCOMPtr<sbIAlbumArtFetcherSet>          mArtFetcher;
  
  nsCOMPtr<nsIStringBundle>                mStringBundle;
};

#endif // SBMETADATAJOB_H_