ac_app_context_epoc.cpp

Go to the documentation of this file.

// Not a standalone file. It exists as a separate file only to avoid
// platform-specific clutter in the primary implementation file.

#include "epoc-s60-version.hpp"
#include "sa_sensor_list_log_db.h"
#include "ut_telephony_epoc.h"
#include "utils_cl2.h" // DEF_SESSION

#include <f32file.h> // RFs

#include <etel3rdparty.h> // CTelephony

#if __NEED_CONTACT_DATABASE__
#include <cntdb.h> // CContactDatabase
#endif

// --------------------------------------------------
// battery status observing
// --------------------------------------------------

/*
The primary function of this AO is to exit the process if battery is running low. We do not want to be the ones to consume the last bit of battery.

As a secondary task, the battery level is also logged, if the required resources have been initialized.

It is worth noting that there also is the hwrmpowerstatesdkpskeys.h API, which it seems we might likewise use. Do not know if one is "better" than the other.
http://www.forum.nokia.com/document/Cpp_Developers_Library/GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6/html/hwrmpowerstatesdkpskeys_8h.html
*/

/***koog 
(require codegen/symbian-cxx)
(ctor-defines/spec
 "CBatteryObserver" ;; name
 "CTelephony& tel, MGetterObs_BatteryInfo& obs" ;; args
 "iObserver(obs)" ;; inits
 "" ;; ctor
 #t ;; ConstructL
 '(args-to-constructl)
)
 ***/
#define CTOR_DECL_CBatteryObserver  \
public: static CBatteryObserver* NewLC(CTelephony& tel, MGetterObs_BatteryInfo& obs); \
public: static CBatteryObserver* NewL(CTelephony& tel, MGetterObs_BatteryInfo& obs); \
private: CBatteryObserver(CTelephony& tel, MGetterObs_BatteryInfo& obs); \
private: void ConstructL(CTelephony& tel, MGetterObs_BatteryInfo& obs);

#define CTOR_IMPL_CBatteryObserver  \
CBatteryObserver* CBatteryObserver::NewLC(CTelephony& tel, MGetterObs_BatteryInfo& obs) \
{ \
  CBatteryObserver* obj = new (ELeave) CBatteryObserver(tel, obs); \
  CleanupStack::PushL(obj); \
  obj->ConstructL(tel, obs); \
  return obj; \
} \
 \
CBatteryObserver* CBatteryObserver::NewL(CTelephony& tel, MGetterObs_BatteryInfo& obs) \
{ \
  CBatteryObserver* obj = CBatteryObserver::NewLC(tel, obs); \
  CleanupStack::Pop(obj); \
  return obj; \
} \
 \
CBatteryObserver::CBatteryObserver(CTelephony& tel, MGetterObs_BatteryInfo& obs) : iObserver(obs) \
{}
/***end***/
NONSHARABLE_CLASS(CBatteryObserver) : 
  public CBase, 
  public MGetterObs_BatteryInfo,
  public MNotifyObs_BatteryInfo
{
  CTOR_DECL_CBatteryObserver;

 public:
  ~CBatteryObserver();

 private:
  virtual void GotData_BatteryInfo(TInt aError);
  virtual void ChangedData_BatteryInfo(TInt aError);
  void HandleBattery(TInt aError, CTelephony::TBatteryInfoV1 const & aData);

 private:
  CGetterAo_BatteryInfo* iBatteryInfoGetter;
  CNotifyAo_BatteryInfo* iBatteryInfoNotifier;

 private:
  MGetterObs_BatteryInfo& iObserver;
};

CTOR_IMPL_CBatteryObserver;

void CBatteryObserver::ConstructL(CTelephony& tel, MGetterObs_BatteryInfo& obs)
{
  iBatteryInfoGetter = new (ELeave) CGetterAo_BatteryInfo(tel, *this);
  iBatteryInfoNotifier = new (ELeave) CNotifyAo_BatteryInfo(tel, *this);

  iBatteryInfoGetter->MakeRequest();
}

CBatteryObserver::~CBatteryObserver()
{
  delete iBatteryInfoGetter;
  delete iBatteryInfoNotifier;
}

void CBatteryObserver::GotData_BatteryInfo(TInt aError)
{
  HandleBattery(aError, iBatteryInfoGetter->Data());
  iObserver.GotData_BatteryInfo(aError); // forward
}

void CBatteryObserver::ChangedData_BatteryInfo(TInt aError)
{
  HandleBattery(aError, iBatteryInfoNotifier->Data());
}

void CBatteryObserver::HandleBattery(TInt aError, 
             CTelephony::TBatteryInfoV1 const & aData)
{
  if (aError) {
    // This is unexpected, but if we cannot query it, then we shall
    // live without this feature for the rest of the runtime.
    er_log_symbian(0, aError, "battery info status query failure");
  } else {
    int status = aData.iStatus;
    int level = aData.iChargeLevel;
    logg("battery status: %d (%d%%)", status, level);

    LogDb* logDb = ac_global_LogDb;
    if (logDb) {
      log_db_log_battery(logDb, status, level, NULL);
    }

#if __QUIT_ON_LOW_BATTERY__
    // If no external power and battery low.
    if ((aData.iStatus != CTelephony::EBatteryConnectedButExternallyPowered) &&
  (aData.iStatus != CTelephony::ENoBatteryConnected) &&
  (aData.iChargeLevel < 20))
      {
  er_log_none(0, "battery running low (at %d%%): exiting", level);
  if (logDb) {
    er_fatal_battery_low;
  } else {
    // This is to avoid repeated error dialogs when the logger
    // does not get as far as properly running due to low battery.
    er_fatal_quiet();
  }
      } 
    else 
#endif
      {
  iBatteryInfoNotifier->MakeRequest();
      }
  }
}

// --------------------------------------------------
// flightmode observing
// --------------------------------------------------

/***koog 
(require codegen/symbian-cxx)
(ctor-defines/spec
 "CFlightModeObserver" ;; name
 "CTelephony& tel, MGetterObs_FlightMode& obs" ;; args
 "iObserver(obs)" ;; inits
 "" ;; ctor
 #t ;; ConstructL
 '(args-to-constructl)
)
 ***/
#define CTOR_DECL_CFlightModeObserver  \
public: static CFlightModeObserver* NewLC(CTelephony& tel, MGetterObs_FlightMode& obs); \
public: static CFlightModeObserver* NewL(CTelephony& tel, MGetterObs_FlightMode& obs); \
private: CFlightModeObserver(CTelephony& tel, MGetterObs_FlightMode& obs); \
private: void ConstructL(CTelephony& tel, MGetterObs_FlightMode& obs);

#define CTOR_IMPL_CFlightModeObserver  \
CFlightModeObserver* CFlightModeObserver::NewLC(CTelephony& tel, MGetterObs_FlightMode& obs) \
{ \
  CFlightModeObserver* obj = new (ELeave) CFlightModeObserver(tel, obs); \
  CleanupStack::PushL(obj); \
  obj->ConstructL(tel, obs); \
  return obj; \
} \
 \
CFlightModeObserver* CFlightModeObserver::NewL(CTelephony& tel, MGetterObs_FlightMode& obs) \
{ \
  CFlightModeObserver* obj = CFlightModeObserver::NewLC(tel, obs); \
  CleanupStack::Pop(obj); \
  return obj; \
} \
 \
CFlightModeObserver::CFlightModeObserver(CTelephony& tel, MGetterObs_FlightMode& obs) : iObserver(obs) \
{}
/***end***/
NONSHARABLE_CLASS(CFlightModeObserver) : 
  public CBase, 
  public MGetterObs_FlightMode,
  public MNotifyObs_FlightMode
{
  CTOR_DECL_CFlightModeObserver;

 public:
  ~CFlightModeObserver();

 private: // MGetterObs_FlightMode
  virtual void GotData_FlightMode(TInt aError);
 private: // MNotifyObs_FlightMode
  virtual void ChangedData_FlightMode(TInt aError);
 private:
  void HandleFlightMode(TInt aError, CTelephony::TFlightModeV1 const & aData);

 private:
  CGetterAo_FlightMode* iGetter;
  CNotifyAo_FlightMode* iNotifier;

 private:
  MGetterObs_FlightMode& iObserver;
};

CTOR_IMPL_CFlightModeObserver;

void CFlightModeObserver::ConstructL(CTelephony& tel, MGetterObs_FlightMode& obs)
{
  iGetter = new (ELeave) CGetterAo_FlightMode(tel, *this);
  iNotifier = new (ELeave) CNotifyAo_FlightMode(tel, *this);

  iGetter->MakeRequest();
}

CFlightModeObserver::~CFlightModeObserver()
{
  delete iGetter;
  delete iNotifier;
}

void CFlightModeObserver::GotData_FlightMode(TInt aError)
{
  HandleFlightMode(aError, iGetter->Data());
  iObserver.GotData_FlightMode(aError); // forward
}

void CFlightModeObserver::ChangedData_FlightMode(TInt aError)
{
  HandleFlightMode(aError, iNotifier->Data());
}

static gboolean TFlightModeV1ToBoolean(const CTelephony::TFlightModeV1& data)
{
  if (data.iFlightModeStatus == CTelephony::EFlightModeOn)
    return ETrue;
  else if (data.iFlightModeStatus == CTelephony::EFlightModeOff)
    return EFalse;
  else
    assert(0 && "unexpected TFlightModeStatus value");
  return EFalse;
}

void CFlightModeObserver::HandleFlightMode(TInt aError, 
             CTelephony::TFlightModeV1 const & aData)
{
  if (aError) {
    // This is unexpected. No matter the network state, surely we
    // should at least be able to determine whether the network is
    // unavailable.
    er_log_symbian(er_FATAL, aError, "flightmode info status query failure");
  } else {
    gboolean on = TFlightModeV1ToBoolean(aData);

    logg("flightmode: %s", boolstr_on(on));

#if __FLIGHTMODE_ENABLED__
    LogDb* logDb = ac_global_LogDb;
    if (logDb) {
      log_db_log_flightmode(logDb, on, NULL);
    }
#endif

    // Post to blackboard if changed (compare against blackboard).
    {
      bb_Blackboard* bb = ac_global_Blackboard;
      bb_Board* bd = bb_Blackboard_board(bb);
      if (bd->flightmode != on) {
  bd->flightmode = on;
  bb_Blackboard_notify(bb, bb_dt_flightmode,
           (gpointer)&(bd->flightmode), 0);
      }
    }

    iNotifier->MakeRequest();
  }
}

// --------------------------------------------------
// plat app context implementation
// --------------------------------------------------

/***koog 
(require codegen/symbian-cxx)
(ctor-defines/spec
 "CAppContextImpl" ;; name
 "ac_AppContext* ac, MAppContextInitObserver& obs" ;; args
 "iCtx(ac), iObs(obs)" ;; inits
 "" ;; ctor
 #t ;; ConstructL
)
 ***/
#define CTOR_DECL_CAppContextImpl  \
public: static CAppContextImpl* NewLC(ac_AppContext* ac, MAppContextInitObserver& obs); \
public: static CAppContextImpl* NewL(ac_AppContext* ac, MAppContextInitObserver& obs); \
private: CAppContextImpl(ac_AppContext* ac, MAppContextInitObserver& obs); \
private: void ConstructL();

#define CTOR_IMPL_CAppContextImpl  \
CAppContextImpl* CAppContextImpl::NewLC(ac_AppContext* ac, MAppContextInitObserver& obs) \
{ \
  CAppContextImpl* obj = new (ELeave) CAppContextImpl(ac, obs); \
  CleanupStack::PushL(obj); \
  obj->ConstructL(); \
  return obj; \
} \
 \
CAppContextImpl* CAppContextImpl::NewL(ac_AppContext* ac, MAppContextInitObserver& obs) \
{ \
  CAppContextImpl* obj = CAppContextImpl::NewLC(ac, obs); \
  CleanupStack::Pop(obj); \
  return obj; \
} \
 \
CAppContextImpl::CAppContextImpl(ac_AppContext* ac, MAppContextInitObserver& obs) : iCtx(ac), iObs(obs) \
{}
/***end***/

NONSHARABLE_CLASS(CAppContextImpl) : 
  public CBase,
  public MGetterObs_BatteryInfo,
  public MGetterObs_FlightMode
{
  CTOR_DECL_CAppContextImpl;

 public:
  ~CAppContextImpl();

 public:
  ac_AppContext* iCtx;

  // The observer is notified of the completion of any asynchronous
  // initialization.
  MAppContextInitObserver& iObs;

 public: // internally public
  DEF_SESSION(RFs, iFs);

  CTelephony* iTelephony;

#if __NEED_CONTACT_DATABASE__
  CContactDatabase* iContactDatabase;
#endif

  TPlatformVersion iPlatformVersion;

 private:
  CBatteryObserver* iBatteryObserver;
  CFlightModeObserver* iFlightModeObserver;

 private: // MGetterObs_BatteryInfo
  virtual void GotData_BatteryInfo(TInt aError);
 private: // MGetterObs_FlightMode
  virtual void GotData_FlightMode(TInt aError);

 private:
  TBool iHaveBattery;
  TBool iHaveFlightMode;
  void GotMoreInfo();
};

CTOR_IMPL_CAppContextImpl;

void CAppContextImpl::GotMoreInfo()
{
  if (iHaveBattery && iHaveFlightMode) {
    // We need no bookkeeping for as long as we are only waiting for
    // this one reading before we are ready.
    iObs.AppContextReady(0);
  }
}

void CAppContextImpl::GotData_BatteryInfo(TInt aError)
{
  (void)aError; // do not care
  iHaveBattery = ETrue;
  GotMoreInfo();
}

void CAppContextImpl::GotData_FlightMode(TInt aError)
{
  (void)aError; // no error, would have exited
  iHaveFlightMode = ETrue;
  GotMoreInfo();
}

void CAppContextImpl::ConstructL()
{
  iTelephony = CTelephony::NewL();

  iBatteryObserver = CBatteryObserver::NewL(*iTelephony, *this);

  iFlightModeObserver = CFlightModeObserver::NewL(*iTelephony, *this);

  LEAVE_IF_ERROR_OR_SET_SESSION_OPEN(iFs, iFs.Connect());

  GetS60PlatformVersionL(iFs, iPlatformVersion);

#if __NEED_CONTACT_DATABASE__
  iContactDatabase = CContactDatabase::OpenL();
#endif
}

CAppContextImpl::~CAppContextImpl()
{
  delete iFlightModeObserver;
  delete iBatteryObserver;
#if __NEED_CONTACT_DATABASE__
  delete iContactDatabase;
#endif
  delete iTelephony;
  SESSION_CLOSE_IF_OPEN(iFs);
}

// --------------------------------------------------
// interface
// --------------------------------------------------

CAppContext* CAppContext::NewL(ac_AppContext* ac,
             MAppContextInitObserver& obs)
{
  CAppContextImpl* impl = CAppContextImpl::NewL(ac, obs);
  CleanupStack::PushL(impl);
  CAppContext* obj = new (ELeave) CAppContext;
  obj->iImpl = impl;
  CleanupStack::Pop();
  return obj;
}

CAppContext::~CAppContext()
{
  delete iImpl;
}

/**

Copyright 2010 Helsinki Institute for Information Technology (HIIT)
and the authors. All rights reserved.

Authors: Tero Hasu <tero.hasu@hut.fi>

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation files
(the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

 **/