sbBaseDeviceFirmwareHandler.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_BASEDEVICEFIRMWAREHANDLER_H__
#define __SB_BASEDEVICEFIRMWAREHANDLER_H__

#include <sbIDeviceFirmwareHandler.h>

#include <nsIMutableArray.h>
#include <nsITimer.h>
#include <nsIURI.h>
#include <nsIXMLHttpRequest.h>

#include <nsCOMPtr.h>
#include <nsStringGlue.h>
#include <prmon.h>

#include <sbIDevice.h>
#include <sbIDeviceEvent.h>
#include <sbIDeviceEventListener.h>
#include <sbIDeviceManager.h>

class sbBaseDeviceFirmwareHandler : public sbIDeviceFirmwareHandler,
                                    public nsITimerCallback
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSITIMERCALLBACK
  NS_DECL_SBIDEVICEFIRMWAREHANDLER

  typedef enum {
    HANDLER_IDLE = 0,
    HANDLER_REFRESHING_INFO,
    HANDLER_UPDATING_DEVICE,
    HANDLER_X
  } handlerstate_t;

  sbBaseDeviceFirmwareHandler();

  nsresult Init();
  
  nsresult AppendSupportedDevice(const nsAString &aDeviceFriendlyName,
                                 const PRUint32 aDeviceVendorID,
                                 const PRUint32 aDeviceProductID);

  nsresult AppendSupportedDeviceProductID(const nsAString &aDeviceFriendlyName,
                                          const PRUint32 aDeviceProductID);

  nsresult CreateProxiedURI(const nsACString &aURISpec, 
                            nsIURI **aURI);

  nsresult SendHttpRequest(const nsACString &aMethod, 
                           const nsACString &aUrl,
                           const nsAString &aUsername = EmptyString(),
                           const nsAString &aPassword = EmptyString(),
                           const nsACString &aContentType = EmptyCString(),
                           nsIVariant *aRequestBody = nsnull);


  nsresult AbortHttpRequest();

  nsresult CreateDeviceEvent(PRUint32 aType, 
                             nsIVariant *aData, 
                             sbIDeviceEvent **aEvent);

  nsresult SendDeviceEvent(sbIDeviceEvent *aEvent, PRBool aAsync = PR_TRUE);

  nsresult SendDeviceEvent(PRUint32 aType,
                           nsIVariant *aData,
                           PRBool aAsync = PR_TRUE);

  handlerstate_t GetState();

  nsresult SetState(handlerstate_t aState);

  nsresult CheckForError(const nsresult &aResult, 
                         PRUint32 aEventType,
                         nsIVariant *aData = nsnull);

  // override me, see cpp file for implementation notes
  virtual nsresult OnInit();

  // override me, see cpp file for implementation notes
  virtual nsresult OnGetCurrentFirmwareVersion(PRUint32 *aCurrentFirmwareVersion);
  // override me, see cpp file for implementation notes
  virtual nsresult OnGetCurrentFirmwareReadableVersion(nsAString &aCurrentFirmwareReadableVersion);
  // override me, see cpp file for implementation notes
  virtual nsresult OnGetRecoveryMode(PRBool *aRecoveryMode);

  // override me, see cpp file for implementation notes
  virtual nsresult OnGetDeviceModelNumber(nsAString &aModelNumber);
  // override me, see cpp file for implementation notes
  virtual nsresult OnGetDeviceModelVersion(nsAString &aModelVersion);
  // override me, see cpp file for implementation notes
  virtual nsresult OnGetDeviceVendor(nsAString &aDeviceVendor);

  // override me, see cpp file for implementation notes
  virtual nsresult OnGetSupportedDevices(nsISimpleEnumerator **aSupportedDevices);

  // override me, see cpp file for implementation notes
  virtual nsresult OnCanUpdate(sbIDevice *aDevice, 
                               PRUint32 aDeviceVendorID,
                               PRUint32 aDeviceProductID,
                               PRBool *_retval);
  // override me, see cpp file for implementation notes
  virtual nsresult OnBeginRecoveryModeSwitch(PRUint32 aDeviceVendorID,
                                             PRUint32 aDeviceProductID);
  // override me, see cpp file for implementation notes
  virtual nsresult OnEndRecoveryModeSwitch();
  // override me, see cpp file for implementation notes
  virtual nsresult OnRebind(sbIDevice *aDevice,
                            sbIDeviceEventListener *aListener,
                            PRBool *_retval);
  // override me, see cpp file for implementation notes
  virtual nsresult OnCancel();
  // override me, see cpp file for implementation notes
  virtual nsresult OnRefreshInfo();
  // override me, see cpp file for implementation notes
  virtual nsresult OnUpdate(sbIDeviceFirmwareUpdate *aFirmwareUpdate);
  // override me, see cpp file for implementation notes
  virtual nsresult OnRecover(sbIDeviceFirmwareUpdate *aFirmwareUpdate);
  // override me, see cpp file for implementation notes
  virtual nsresult OnVerifyDevice();
  // override me, see cpp file for implementation notes
  virtual nsresult OnVerifyUpdate(sbIDeviceFirmwareUpdate *aFirmwareUpdate);
  // override me, see cpp file for implementation notes
  virtual nsresult OnHttpRequestCompleted();

protected:
  virtual ~sbBaseDeviceFirmwareHandler();

  PRMonitor* mMonitor;

  nsCOMPtr<sbIDevice> mDevice;
  nsCOMPtr<sbIDeviceEventListener> mListener;
  nsCOMPtr<sbIDeviceEventListener> mProxiedListener;

  handlerstate_t mHandlerState;
  PRUint32 mFirmwareVersion;
  PRUint32 mDefaultFirmwareVersion;

  nsString mContractId;
  nsString mReadableFirmwareVersion;
  nsString mDefaultReadableFirmwareVersion;

  nsCOMPtr<nsIURI> mDefaultFirmwareLocation;
  nsCOMPtr<nsIURI> mFirmwareLocation;
  nsCOMPtr<nsIURI> mDefaultReleaseNotesLocation;
  nsCOMPtr<nsIURI> mReleaseNotesLocation;
  nsCOMPtr<nsIURI> mResetInstructionsLocation;
  nsString         mRecoveryModeKeyCombination;
  nsCOMPtr<nsIURI> mSupportLocation;
  nsCOMPtr<nsIURI> mRegisterLocation;

  PRPackedBool mNeedsRecoveryMode;
  PRPackedBool mRecoveryMode;

  nsCOMPtr<nsIXMLHttpRequest> mXMLHttpRequest;
  nsCOMPtr<nsITimer>          mXMLHttpRequestTimer;

  nsCOMPtr<nsIMutableArray>   mSupportedDevices;
};

#endif /*__SB_BASEDEVICEFIRMWAREHANDLER_H__*/