sbMetadataCrashTracker.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 SBMETADATACRASHTRACKER_H_
#define SBMETADATACRASHTRACKER_H_

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

// TODO cleanup
#include <nscore.h>
#include <prlock.h>
#include <prmon.h>
#include <nsAutoLock.h>
#include <nsStringGlue.h>
#include <nsTArray.h>
#include <nsCOMArray.h>
#include <nsCOMPtr.h>
#include <nsAutoPtr.h>
#include <nsISupports.h>
#include <nsIOutputStream.h>
#include <nsIFile.h>
#include <nsDataHashtable.h>



// CLASSES ====================================================================

class sbMetadataCrashTracker : public nsISupports
{  
public:
  NS_DECL_ISUPPORTS

  sbMetadataCrashTracker();
  virtual ~sbMetadataCrashTracker();

  nsresult Init();

  nsresult StartLog();

  nsresult ResetLog();

  nsresult LogURLBegin(const nsACString& aURL);

  nsresult LogURLEnd(const nsACString& aURL);

  nsresult IsURLBlacklisted(const nsACString& aURL,
                            PRBool* aIsBlackListed);

  nsresult AddBlacklistURL(const nsACString& aURL);
  
private:

  nsresult ProcessExistingLog();
  
  static PLDHashOperator PR_CALLBACK
  AddURLsToBlacklist(nsCStringHashKey::KeyType aKey,
                     nsCString aEntry,
                     void* aUserData);

  static PLDHashOperator PR_CALLBACK
  WriteBlacklistURLToFile(nsCStringHashKey::KeyType aKey,
                          PRBool aEntry,
                          void* aUserData);

  nsresult ReadBlacklist();
  
  nsresult WriteBlacklist();
  
  nsresult GetProfileFile(const nsAString& aName, nsIFile** aFile);



  nsCOMPtr<nsIFile>                           mBlacklistFile;
  nsDataHashtable<nsCStringHashKey, PRBool>   mURLBlacklist;

  // Rather than log the URL for both begin and complete we
  // assign each URL a number.  This cuts the log file size in half.
  PRUint32                                    mCounter;
  nsDataHashtable<nsCStringHashKey, PRUint32> mURLToIndexMap;
  
  nsCOMPtr<nsIFile>                           mLogFile;
  nsCOMPtr<nsIOutputStream>                   mOutputStream;
  PRLock*                                     mLock;
  
  // Value of songbird.metadata.simulate.crash.url, if set
  nsCString                                   mSimulateCrashURL;
};

#endif // SBMETADATACRASHTRACKER_H_