1 /*

     2 * Copyright (c) 2007-2007 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:   

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef ALARMUTILS_H

    21 #define ALARMUTILS_H

    22 

    23 

    24 // INCLUDES

    25 #include "AlmAlertVariant.hrh"

    26 

    27 #include <e32base.h>

    28 #include <asshdalarm.h>

    29 #include <asclisession.h>

    30 #include <TProfileToneSettings.h>

    31 #include <apgcli.h>

    32 #include <startupdomainpskeys.h>

    33 #include <starterclient.h>

    34 #include <calentry.h>

    35 #include <caltime.h>

    36 #include <calprogresscallback.h>

    37 

    38 // FORWARD DECLARATIONS

    39 

    40 class CCalSession;

    41 class CCalEntryView;

    42 class CAlmAlarmControl;

    43 class CAlmAlarmPlayer;

    44 class CAlmAlarmInfo;

    45 class CAlarmRemConEventsHandler;

    46 #ifdef RD_ALMALERT__SENSOR_SUPPORT

    47 class CAlarmContextFwSupport;

    48 #endif // RD_ALMALERT__SENSOR_SUPPORT

    49 class MProfileEngine;

    50 class CNotifierDialogController;

    51 class CAknAlarmService;

    52 

    53 // CLASS DECLARATION

    54 

    55 /**

    56 *  ?description

    57 *

    58 *  @lib AknAlarmService.lib

    59 *  @since S60 3.2

    60 */

    61 NONSHARABLE_CLASS( CAlarmUtils ) : public CBase, public MCalProgressCallBack

    62     {

    63 public: // data types

    64     /**

    65     * Alarm types.

    66     */

    67     enum TAlarmType

    68         {

    69         EAlarmTypeClock = 0,

    70         EAlarmTypeCalendar,

    71         EAlarmTypeOther

    72         };

    73 

    74 

    75     struct TAlarmData

    76         {

    77         // Alarm snooze time.

    78         TInt iSnoozeTime;

    79 

    80         // Currently active alarm object on the alarm server queue.

    81         TASShdAlarm iAlarm;

    82 

    83         // Name of the alarm tone file.

    84         TFileName iAlarmTone;

    85 

    86         // Name of the default alarm tone file.

    87         TFileName iDefaultAlarmTone;

    88 

    89         // Volume setting.

    90         TInt iVolume;

    91 

    92         // Repeate value for the player.

    93         TInt iRepeatValue;

    94 

    95         // Volume ramp time value for the player.

    96         TInt iVolumeRampTime;

    97 

    98         // Ringing type.

    99         TProfileRingingType iRingType;

   100 

   101         // alarm type.

   102         TAlarmType iAlarmType;

   103 

   104         // instance time (only for calendar alarms)

   105         TCalTime iInstanceTime;

   106 

   107         // local uid (only for calendar alarms)

   108         TCalLocalUid iLocalUid;

   109 		

   110 		TBufC<256> iCalFileName;

   111 

   112         };

   113 

   114 public: // Constructors and destructor

   115     // Constructor

   116     static CAlarmUtils* NewL( CAlmAlarmControl* aAlarmControl,

   117                               CAknAlarmService* aSupervisor );

   118 

   119     // Destructor.

   120     ~CAlarmUtils();

   121 

   122 private:

   123     // C++ default constructor.

   124     CAlarmUtils( CAlmAlarmControl* aAlarmControl,

   125                   CAknAlarmService* aSupervisor );

   126 

   127     // Symbian 2nd phase constructor

   128     void ConstructL();

   129 

   130 public:

   131     /**

   132     * Plays the alarm sound.

   133     * @since S60 3.2

   134     */

   135     void PlayAlarmSound();

   136 

   137     /**

   138     * Stops the alarm sound.

   139     * @since S60 3.2

   140     */

   141     void StopAlarmSound();

   142 

   143     /**

   144     * Activates and deactivates keyguard.

   145     * @since S60 3.2

   146     * @param aActive ETrue, to activate keyguard.

   147     */

   148     void SetKeyGuard(TBool aActive);

   149 

   150     /**

   151     * Checks whether current alarm is a clock alarm.

   152     * @since S60 3.2

   153     * @return True, if alarm is a clock alarm

   154     */

   155     TBool IsClockAlarm() const;

   156 

   157     /**

   158     * Check whether current alarm is a calendar alarm.

   159     * @since S60 3.2

   160     * @return True, if alarm is a calendar alarm

   161     */

   162     TBool IsCalendarAlarm() const;

   163 

   164     /**

   165     * Checks the current ringing type from Profiles.

   166     * @since S60 3.2

   167     * @return True, if current ringing type is set to silent

   168     */

   169     TBool IsRingingTypeSilent() const;

   170 

   171     /**

   172     * Check if using the "Off" tone. (i.e. no_sound.wav or KNullDesC.)

   173     * @since S60 3.2

   174     * @return ETrue, if iAlarmName is an "off" tone.

   175     */

   176     TBool IsOffTone() const;

   177 

   178     /**

   179     * Check if the alarm sound file is a KRngMimeType file.

   180     * @since S60 3.2

   181     * @return ETrue, if the tone is a KRngMimeType file.

   182     */

   183     TBool IsRngTone();

   184 

   185     /**

   186     * @since S60 3.2

   187     * @return The maximum value of profile volume.

   188     */

   189     TInt MaxProfileVolume() const;

   190 

   191     /**

   192     * @since S60 3.2

   193     * @return Reference to the iAlarmData struct.

   194     **/

   195     CAlarmUtils::TAlarmData& AlarmData();

   196 

   197     /**

   198     * Initialise the TAlarmData struct and 

   199     * get alarm informations string(s).

   200     * @since S60 3.2

   201     */

   202     void InitialiseAlarmDataL();

   203 

   204     /**

   205     * Cleanup.

   206     * @since S60 3.2

   207     */

   208     void UninitialiseAlarmData();

   209 

   210     /**

   211     * Checks whether active alarm can be snoozed or not.

   212     * @since S60 3.2

   213     * @return True, if the alarm can be snoozed

   214     */

   215     TBool CanSnooze() const;

   216 

   217     /**

   218     * Check whether we are in restore mode or not.

   219     * @since S60 3.2

   220     * @return ETrue if phone is in restore mode and EFalse if not

   221     **/

   222     TBool IsPhoneInRestoreMode() const;

   223 

   224     /**

   225     * Gets text and time values for an alarm note.

   226     * @since S60 3.2

   227     * @param aText Buffer to receive the text.

   228     **/

   229     void GetAlarmLabelL(HBufC*& aText);

   230 

   231     /**

   232     * Gets the label for wakeup note.

   233     * @since S60 3.2

   234     * @param aLabel Buffer to receive the text.

   235     **/

   236     void GetWakeupLabelL(HBufC*& aLabel);

   237 

   238     /**

   239     * ?description

   240     * @since S60 3.2

   241     * @return Pointer to CNotifierDialogController.

   242     */

   243     CNotifierDialogController* NotifierDialogController();

   244 

   245     /**

   246     * Stop the active alarm and reset the snooze count.

   247     * @since S60 3.2

   248     **/

   249     void DoStopAlarm();

   250 

   251     /**

   252     * Access to iHasExpiredAlarmsWaiting.

   253     * @since S60 3.2

   254     * @return ETrue if there are alarms waiting to be shown.

   255     **/

   256     TBool HasExpiredAlarmsWaiting() const;

   257 

   258     /**

   259     * Snooze the active alarm.

   260     * @since S60 3.2

   261     **/

   262     void DoSnooze();

   263 

   264     /**

   265     * Checks if this alarm can be shown in "alarm" or in "charging" state.

   266     * @since S60 3.2

   267     * @return ETrue, if alarm can be shown.

   268     */

   269     TBool IsWakeupAlarm() const;

   270 

   271     /**

   272     * Checks if the device is in "alarm" or in "charging" state.

   273     * @since S60 3.2

   274     * @return ETrue, if device is in "alarm" or in "charging" state.

   275     */

   276     TBool IsDeviceInAlarmState() const;

   277 

   278     /**

   279     * Checks if the device is in any of the normal states.

   280     * @since S60 3.2

   281     * @return ETrue, if device is in any of the normal states.

   282     */

   283     TBool IsDeviceInNormalState() const;

   284 

   285     /**

   286     * Check that phone is in correct state (startup finished).

   287     * @since S60 3.2

   288     * @return ETrue, if startup state is one of the final states.

   289     */

   290     TBool IsPhoneStartupReady() const;

   291 

   292     /**

   293     * Store current device state.

   294     * @since S60 3.2

   295     * @param aDeviveState Current device state.

   296     */

   297     void SetDeviceState(TPSGlobalSystemState aDeviceState);

   298     

   299     /**

   300     * Boot up the device.

   301     * @since S60 3.2

   302     **/

   303     void DeviceStartup();

   304 

   305     /**

   306     * Starts shutdown timer.

   307     * @since S60 3.2

   308     */

   309     void StartShutdownTimer(TUint aTimeout);

   310 

   311     /**

   312     * Cancel the shutdown timer.

   313     * @since S60 3.2

   314     */

   315     void CancelShutdown();

   316 

   317     /**

   318     * Starts auto-snooze timer.

   319     * @since S60 3.2

   320     */

   321     void StartAutoSnoozeTimer();

   322 

   323     /**

   324     * Cancel the auto snooze timer.

   325     * @since S60 3.2

   326     */

   327     void CancelAutoSnooze();

   328 

   329     /**

   330     * Start observing accessory events.

   331     * @since S60 3.2

   332     */

   333     void StartAccessoryObserver();

   334 

   335     /**

   336     * Stop observing accessory events.

   337     * @since S60 3.2

   338     */

   339     void StopAccessoryObserver();

   340 

   341     /**

   342     * Start observing context framework/sensors.

   343     * @since S60 3.2

   344     */

   345     void StartCFObserverL();

   346 

   347     /**

   348     * Stop observing context framework/sensors.

   349     * @since S60 3.2

   350     */

   351     void StopCFObserverL();

   352 

   353     /**

   354     * Try to snoozes the active alarm. 

   355     * Stop if max snooze count reached.

   356     * @since S60 3.2

   357     */

   358     void TryToSnoozeActiveAlarm();

   359 

   360     /**

   361     * Start the key block timer.

   362     * @since S60 3.2

   363     */

   364     void StartKeyBlocker();

   365 

   366     /**

   367     * Is the kay block timer active.

   368     * @since S60 3.2

   369     */

   370     TBool KeyBlockActive();

   371 

   372     /**

   373     * Show the snooze info note.

   374     * @since S60 3.2

   375     */

   376     void AsyncShowSnoozeInfoNote();

   377 

   378     /**

   379     * Show the wakeup query.

   380     * @since S60 3.2

   381     */

   382     void AsyncShowWakeupQuery();

   383 

   384     /**

   385     * Cancel iAsyncCallBack.

   386     * @since S60 3.2

   387     */

   388     void CancelAsynchRequest();

   389 

   390     /**

   391     * Start alarm delay timer.

   392     * @since S60 3.2

   393     */

   394     void StartAlarmDelayTimer();

   395 

   396     /**

   397     * Is delay timer active.

   398     * @since S60 3.2

   399     * @return ETrue, if delay timer is active.

   400     */

   401     TBool AlarmDelayTimerActive();

   402 

   403     /**

   404     * Reset system inactivity timers periodically.

   405     * @since S60 3.2

   406     */

   407     void StartInactivityResetTimer();

   408 

   409     /**

   410     * Stop the inactivity reset timer.

   411     * @since S60 3.2

   412     */

   413     void StopInactivityResetTimer();

   414 

   415     /**

   416     * Fetch local uid and instance time for the alarmed calendar entry.

   417     * @since S60 3.2

   418     */

   419     void GetCalendarEntryInfoL();

   420 

   421     /**

   422     * Gets the calendar entry we are currently alarming.

   423     * @since 3.2

   424     */

   425     void FetchEntryL(CCalEntry*& aEntry);

   426 

   427  	/**

   428     * From MCalProgressCallBack.Notifies the progress percentage of  completion of 

   429     * calendar entry view creation

   430     * @since 5.0

   431     */

   432 

   433 	void Progress(TInt aPercentageCompleted);

   434 

   435  	/**

   436     * From MCalProgressCallBack . Called  on completion of calendar entry view creation

   437     * @since 5.0

   438     */

   439 

   440 	void Completed(TInt aError);

   441 

   442 	/**

   443     * From MCalProgressCallBack . Called  on compltetion of calendar entry view creation

   444     * @since 5.0

   445     */

   446 	TBool NotifyProgress();

   447 

   448     /**

   449     * Start calendar viewer in alarm mode.

   450     * @since S60 5.0

   451     */

   452     void StartCalendarL();

   453 

   454     /**

   455     * Check the security lock status.

   456     * @since S60 5.0

   457     * @return ETrue if security lock is active.

   458     */

   459     TBool IsSecurityLockActive();

   460 

   461     /**

   462     * Activate and deactivate backlight.

   463     * @since S60 3.2

   464     * @param aActive ETrue, to set background light blinking.

   465     */

   466     void SetBackLight(TBool aActive);

   467     

   468     /**

   469     * Set the flag for calendar viewer is open.

   470 	* @param aCalendaralarmViewer ETrue, for calendar viewer.

   471     */    

   472     void SetCalendarAlarmViewer(TBool aCalendarAlarmViewer);

   473     

   474     /**

   475     * Get the status whether, calendar viewer is open or not

   476 	* @return ETrue if viewer is open.

   477     */

   478     TBool IsCalendarAlarmViewer();

   479 

   480 private:

   481 

   482     /**

   483     * Read alarm sound filenames from CenRep.

   484     * @since S60 3.2

   485     */

   486     void GetAlarmSoundFilenames();

   487 

   488     /**

   489     * Read active profile settings from the profile engine.

   490     * @since S60 3.2

   491     */

   492     void GetProfileSettings();

   493 

   494     /**

   495     * Read the user snooze time setting for the active alarm.

   496     * @since S60 3.2

   497     */

   498     void GetSnoozeTimeSetting();

   499 

   500     /**

   501     * Check if the alarm server has more expired alarms to ready to be shown.

   502     * @since S60 3.2

   503     * @return ETrue, if any alarms in EAlarmStateWaitingToNotify state.

   504     */

   505     TBool CheckHasExpiredAlarmsWaiting();

   506 

   507     /**

   508     * Update alarm snooze counter.

   509     * @since S60 3.2

   510     */

   511     void UpdateAlarmSnoozeCount();

   512 

   513     /**

   514     * request device shutdown.

   515     * @since S60 3.2

   516     */

   517     void DeviceShutdown();

   518 

   519     /**

   520     * Connect to starter client.

   521     * @since S60 3.2

   522     * @return ETrue, if connection was successfull.

   523     **/

   524     TBool StarterConnect();

   525 

   526     /**

   527     * Callback function for the shutdown timer.

   528     * @since S60 3.2

   529     * @param aPtr  Reference to parent object

   530     * @return 0

   531     */

   532     static TInt ShutdownCallBack(TAny* aPtr);

   533 

   534     /**

   535     * Callback function for the auto snooze timer.

   536     * @since S60 3.2

   537     * @param aPtr  Reference to parent object

   538     * @return 0

   539     */

   540     static TInt AutoSnoozeCallBack(TAny* aPtr);

   541 

   542     /**

   543     * Callback function for the inactivity reset timer.

   544     * @since S60 3.2

   545     * @param aPtr  Not used.

   546     * @return 1

   547     */

   548     static TInt InactivityResetTimerCallBack(TAny* aPtr);

   549 

   550     /**

   551     * Call CAlmAlarmControl::DoAutoSnooze to handle the auto snooze.

   552     * @since S60 3.2

   553     */

   554     void AutoSnooze();

   555 

   556     /**

   557     * Stop the key block timer.

   558     * @since S60 3.2

   559     */

   560     void StopKeyBlocker() const;

   561 

   562     /**

   563     * Callback for the key block timer.

   564     * @since S60 3.2

   565     * @param aPtr  Pointer to iKeyBlockTimer

   566     * @return 0

   567     */

   568     static TInt KeyBlockCallBack(TAny* aPtr);

   569 

   570     /**

   571     * Callback for the auto snooze timer.

   572     * @since S60 3.2

   573     * @param aPtr  Pointer to iAlarmControl

   574     * @return 0

   575     */

   576     static TInt SnoozeInfoCallBack(TAny* aPtr);

   577 

   578     /**

   579     * Request wakeup dialog. Shutdown on error.

   580     * @since S60 3.2

   581     */

   582     void DoAskWakeup();

   583 

   584     /**

   585     * ?description

   586     * @since S60 3.2

   587     * @param aPtr  Pointer to this class.

   588     * @return 0

   589     */

   590     static TInt WakeupCallBack(TAny* aPtr);

   591 

   592     /**

   593     * Callback for alarm delay timer.

   594     * @since S60 3.2

   595     */

   596     static TInt DelayTimerCallBack(TAny* aPtr);

   597 

   598  /**

   599     * Sets the Calendar view creation status.

   600     * @since S60 5.0  

   601     */

   602 

   603 	void SetCalendarViewStatus(TInt);

   604 

   605     /**

   606     * Gets the Calendar view creation status.

   607     * @since S60 5.0

   608     */

   609 

   610    TInt CalendarViewStatus();

   611 

   612 private:  // data

   613     /**

   614     * Pointer to the alarm control.

   615     * Not own.

   616     */

   617     CAlmAlarmControl* iAlarmControl;

   618 

   619     /**

   620     * Pointer to our service class to send stop and snooze commands.

   621     * Not own.

   622     */

   623     CAknAlarmService* iSupervisor;

   624 

   625     /**

   626     * Pointer to global note API.

   627     * Not own.

   628     */

   629     CNotifierDialogController* iNotifierDialogController;

   630 

   631     /**

   632     * Plays alarm tones according to user settings.

   633     * Own.

   634     */

   635     CAlmAlarmPlayer* iAlarmPlayer;

   636 

   637     /**

   638     * Pointer to accessory observer.

   639     * Own.

   640     */

   641     CAlarmRemConEventsHandler* iRemConHandler;

   642 

   643     /**

   644     * Pointer to context framework observer.

   645     * Own.

   646     */

   647     #ifdef RD_ALMALERT__SENSOR_SUPPORT

   648     CAlarmContextFwSupport* iCFSupport;

   649     #endif // RD_ALMALERT__SENSOR_SUPPORT

   650 

   651     /**

   652     * Class to fetch the text for alarm UI.

   653     * Own.

   654     */

   655     CAlmAlarmInfo* iAlarmInfo;

   656 

   657     /**

   658     * Alarm server client session.

   659     */

   660     RASCliSession iAlarmServer;

   661 

   662     /**

   663     * Starter client session.

   664     */

   665     RStarterSession iStarter;   

   666 

   667     /**

   668     * For tone MIME -type.

   669     */

   670     RApaLsSession iApaSession;

   671 

   672     /**

   673     * Access to active profile settings.

   674     * Own.

   675     */

   676     MProfileEngine* iProfileEng;

   677 

   678     /**

   679     * Current device state.

   680     */

   681     TPSGlobalSystemState iCurrentDeviceState;   

   682 

   683     /**

   684     * Timer to allow actions to complete before device is shutdown.

   685     * Own.

   686     */

   687     CPeriodic* iShutdownTimer;

   688 

   689     /**

   690     * Timer for auto-snooze.

   691     * Own,

   692     */

   693     CPeriodic* iAutoSnoozeTimer;

   694 

   695     /**

   696     * Timer to ignore all input for 0.5 sec.

   697     * Own.

   698     */

   699     CPeriodic* iKeyBlockTimer;

   700 

   701     /**

   702     * Timer to delay the alarm. Prevents alarm from quickly 

   703     * flashing on the screen on system time change.

   704     * Own.

   705     */

   706     CPeriodic* iAlarmDelayTimer;

   707 

   708     /**

   709     * Timer to keep screen saver, autolock, etc. from 

   710     * activating during an alarm.

   711     * Own.

   712     */

   713     CPeriodic* iInactivityResetTimer;

   714 

   715     /**

   716     * Asynchronous callback to display the wakeup query and snooze info notes.

   717     * (to ease up state handling and to resolve problems when requesting 

   718     * a new note from inside a NoteComplete call...)

   719     * Own.

   720     */

   721     CAsyncCallBack* iAsyncCallBack;

   722 

   723     /**

   724     * Alarm data.

   725     */

   726     CAlarmUtils::TAlarmData iAlarmData;

   727 

   728     /**

   729     * Flag to check whether it's OK to show the wakeup query.

   730     */

   731     TBool iHasExpiredAlarmsWaiting;

   732 

   733     /**

   734     * Flag to prevent unnecessary setting of background lights.

   735     */

   736     TBool iLightsBlinking;

   737 

   738     /**

   739     * Flag to prevent unnecessary setting of keyguard.

   740     */

   741     TBool iKeyGuardActivated;

   742 

   743   /**

   744     * Pointer to calendar session.

   745     * Own. Remember to release after use!

   746     */

   747 

   748 	CCalSession* 		iCalSession;

   749 

   750   /**

   751     * Pointer to calendar entry view.

   752     * Own. Remember to release after use!

   753     */

   754 

   755 	CCalEntryView* 		iCalEntryView;

   756 

   757     /**

   758     * Pointer to CActiveSchedulerWait object which is  entry view.

   759     * Own. Remember to release after use!

   760     */

   761    CActiveSchedulerWait* iEntryAsyncWait;

   762 	

   763     /**

   764     * Pointer to CActiveSchedulerWait object to wait for completion of current view creation request.

   765     * Own. Remember to release after use!

   766     */

   767 

   768    CActiveSchedulerWait* iQueueManagerAsw;

   769   

   770   /**

   771     * Calendar entry view creation status.

   772     */

   773 enum TCalViewCreateStatus

   774 	{

   775 	ECalViewCreateError = -1,

   776 	ECalViewCreateNone = 0,

   777 	ECalViewCreateReqPending,

   778 	ECalViewCreateCompleted

   779   	};

   780   

   781    TInt iCalEntryViewStatus; 

   782    

   783    /**

   784    * Calendar Alarm Viewer flag

   785    */

   786    TBool iCalendarAlarmViewer; 

   787     };

   788 

   789 #endif  // ALARMUTILS_H

   790 

   791 

   792 // End of File