uiservicetab/vimpstdetailsviewplugin/src/cvimpstdetailspresencehandler.cpp
changeset 0 5e5d6b214f4f
child 14 9fdee5e1da30
equal deleted inserted replaced
-1:000000000000 0:5e5d6b214f4f
       
     1 /*
       
     2 * Copyright (c) 2008-2008 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:  Implementation of the presence handler
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #include "cvimpstdetailspresencehandler.h"
       
    20 
       
    21 #include "tvimpstconsts.h"
       
    22 
       
    23 //presence cache header
       
    24 #include <presencecachereader2.h> // cache reader
       
    25 #include <avabilitytext.h>
       
    26 
       
    27 // ximpfw
       
    28 #include <ximpclient.h>
       
    29 #include <ximpcontext.h>
       
    30 #include <StringLoader.h>
       
    31 #include <vimpstdetailsviewpluginrsc.rsg>
       
    32 
       
    33 // ---------------------------------------------------------------------------
       
    34 // NewL, two-phase construction
       
    35 // ---------------------------------------------------------------------------
       
    36 //
       
    37 CVIMPSTDetailsPresenceHandler* CVIMPSTDetailsPresenceHandler::NewL(const TDesC& aServiceName ,
       
    38 																   MVIMPSTDetailsPresenceObserver& aObserver,
       
    39 																   TBool aPresenceSupported )
       
    40     {
       
    41     CVIMPSTDetailsPresenceHandler* self= new (ELeave) CVIMPSTDetailsPresenceHandler( aObserver, aPresenceSupported );
       
    42     CleanupStack::PushL(self);
       
    43     self->ConstructL( aServiceName );
       
    44     CleanupStack::Pop(self);
       
    45     return self;
       
    46     }
       
    47 
       
    48 // ---------------------------------------------------------------------------
       
    49 // C++ (first phase) constructor
       
    50 // ---------------------------------------------------------------------------
       
    51 //
       
    52 CVIMPSTDetailsPresenceHandler::CVIMPSTDetailsPresenceHandler(MVIMPSTDetailsPresenceObserver& aObserver, 
       
    53                                                              TBool aPresenceSupported)
       
    54    : iPresenceObserver( aObserver ),
       
    55    iStatus( TVIMPSTEnums::EOffline ),
       
    56    iPresenceSupported( aPresenceSupported )
       
    57     {
       
    58     // No implementation required
       
    59     }
       
    60 
       
    61 // ---------------------------------------------------------------------------
       
    62 // ConstructL, second phase constructor
       
    63 // ---------------------------------------------------------------------------
       
    64 //
       
    65 void CVIMPSTDetailsPresenceHandler::ConstructL(const TDesC& aServiceName )
       
    66 	{
       
    67  	iServiceName = aServiceName.AllocL();
       
    68  	
       
    69  		
       
    70     iXIMClient = MXIMPClient::NewClientL();        
       
    71     //Create new sink to receive ximp context events
       
    72     iPresenceContext = iXIMClient->NewPresenceContextLC();
       
    73  	CleanupStack::Pop(); //  iPresenceContext
       
    74  	
       
    75     //initialize the presence cache.
       
    76     iPresenceCacheReader = MPresenceCacheReader2::CreateReaderL(); 														 
       
    77     iPresenceCacheReader->SetObserverForSubscribedNotifications(this);
       
    78     iUserId = NULL;
       
    79 	}
       
    80 
       
    81 // ---------------------------------------------------------------------------
       
    82 // Destructor
       
    83 // ---------------------------------------------------------------------------
       
    84 //
       
    85 CVIMPSTDetailsPresenceHandler::~CVIMPSTDetailsPresenceHandler()
       
    86     {
       
    87     delete iStatusMessage;
       
    88     delete iUserId;
       
    89     delete iStatusText;
       
    90     delete iServiceName;
       
    91     delete iPresenceCacheReader;
       
    92     delete iPresenceContext;
       
    93     delete iXIMClient;
       
    94     }
       
    95 
       
    96 // ---------------------------------------------------------------------------
       
    97 // CVIMPSTDetailsPresenceHandler::SubscribePresenceL
       
    98 // ---------------------------------------------------------------------------
       
    99 //  
       
   100 void CVIMPSTDetailsPresenceHandler::SubscribePresenceL(const TDesC& aUserId )
       
   101 	{
       
   102 	if( iUserId )
       
   103 		{
       
   104 		delete iUserId;
       
   105 		iUserId = NULL;	
       
   106 		}
       
   107 	iUserId = aUserId.AllocL();
       
   108 	if( !iPresenceSupported )
       
   109 	    {
       
   110 	    return;
       
   111 	    }
       
   112 	HBufC* name = HBufC::NewLC( aUserId.Length() + iServiceName->Length() + KColon().Length() );
       
   113 	TPtr namePtr( name->Des() );
       
   114 	namePtr.Zero();
       
   115 	
       
   116 	// append the service name followed by user id ,seperated by colon
       
   117 	namePtr.Append(*iServiceName);
       
   118 	namePtr.Append(KColon);
       
   119     namePtr.Append(aUserId);
       
   120 
       
   121     iPresenceCacheReader->SubscribePresenceBuddyChangeL(namePtr);
       
   122     MPresenceBuddyInfo2* presenceBuddyInfo = iPresenceCacheReader->PresenceInfoLC(namePtr);
       
   123    
       
   124     if ( presenceBuddyInfo )
       
   125         {
       
   126         TPtrC buddyXSPId = presenceBuddyInfo->BuddyId(); // read the buddyID : returns in XSP format
       
   127         TPtrC buddyId = buddyXSPId.Right( buddyXSPId.Length() - iServiceName->Length() - KColon().Length());
       
   128         // read the availability /presence state enum value 
       
   129         MPresenceBuddyInfo2::TAvailabilityValues availabilityEnum = presenceBuddyInfo->Availability();
       
   130         TPtrC avablityText = presenceBuddyInfo->AvailabilityText();
       
   131         ConvertPresenceCacheEnums( availabilityEnum ,avablityText ); // convert the presence cache enum value to service tab enum 
       
   132 		if(TVIMPSTEnums::EUnknown ==  iStatus)
       
   133 			{
       
   134 			//get the blocked and pending state
       
   135 			GetKeyFieldsAndValuesL(*presenceBuddyInfo);
       
   136 			}
       
   137         TPtrC statusMsg = presenceBuddyInfo->StatusMessage(); // read the  status message     
       
   138         ProcessStatusMesssageL( statusMsg  );
       
   139         CleanupStack::PopAndDestroy();  // presenceBuddyInfo
       
   140         }
       
   141     CleanupStack::PopAndDestroy(); //  name
       
   142    	}
       
   143 
       
   144 
       
   145 
       
   146 // ---------------------------------------------------------------------------
       
   147 // CVIMPSTDetailsPresenceHandler::HandlePresenceReadL
       
   148 // ---------------------------------------------------------------------------
       
   149 //  
       
   150 void CVIMPSTDetailsPresenceHandler::HandlePresenceReadL(TInt /*aErrorCode*/,
       
   151         RPointerArray<MPresenceBuddyInfo2>& /*aPresenceBuddyInfoList*/)
       
   152         {
       
   153         //Not required as we are not subcribing to all buddies presence
       
   154 
       
   155         }
       
   156 
       
   157 // ---------------------------------------------------------------------------
       
   158 // CVIMPSTDetailsPresenceHandler::HandlePresenceNotificationL
       
   159 // ---------------------------------------------------------------------------
       
   160 //  
       
   161 void CVIMPSTDetailsPresenceHandler::HandlePresenceNotificationL(TInt /*aErrorCode*/,
       
   162         MPresenceBuddyInfo2* aPresenceBuddyInfo)
       
   163     {
       
   164     if ( aPresenceBuddyInfo )
       
   165         {
       
   166         CleanupDeletePushL( aPresenceBuddyInfo );  
       
   167         TPtrC buddyXSPId = aPresenceBuddyInfo->BuddyId(); // read the buddyID : returns in XSP format
       
   168         TPtrC buddyId = buddyXSPId.Right( buddyXSPId.Length() - iServiceName->Length() - KColon().Length());
       
   169         // read the availability /presence state enum value 
       
   170        MPresenceBuddyInfo2::TAvailabilityValues availabilityEnum = aPresenceBuddyInfo->Availability();
       
   171        TPtrC avablityText = aPresenceBuddyInfo->AvailabilityText();
       
   172        // convert the presence cache enum value to service tab enum 
       
   173        ConvertPresenceCacheEnums( availabilityEnum ,avablityText ); 
       
   174        
       
   175        // its either  blocked or pending stats, hence get the corrrect state
       
   176         if(TVIMPSTEnums::EUnknown ==  iStatus)
       
   177             {
       
   178             //get the blocked and pending state
       
   179             GetKeyFieldsAndValuesL(*aPresenceBuddyInfo);
       
   180             }
       
   181        
       
   182         TPtrC statusMsg = aPresenceBuddyInfo->StatusMessage(); // read the  status message     
       
   183         ProcessStatusMesssageL( statusMsg  );
       
   184         CleanupStack::PopAndDestroy();  // aPresenceBuddyInfo
       
   185         }
       
   186     }    
       
   187 
       
   188 // ---------------------------------------------------------------------------
       
   189 // CVIMPSTDetailsPresenceHandler::ConvertPresenceCacheEnums
       
   190 // ---------------------------------------------------------------------------
       
   191 //  
       
   192 void CVIMPSTDetailsPresenceHandler::ConvertPresenceCacheEnums(MPresenceBuddyInfo2::TAvailabilityValues aAvailabilityEnum, TPtrC aAvabilityText)
       
   193     {
       
   194     // convert the presence cache enums to UI enumvalues
       
   195     // by default if the enum doesnot match then its  TVIMPSTEnums::UnKnown
       
   196     switch( aAvailabilityEnum )
       
   197         {
       
   198         case MPresenceBuddyInfo2::EBusy:
       
   199             {
       
   200            if(0==aAvabilityText.Compare(KAwayState))
       
   201                 {
       
   202                 iStatus  = TVIMPSTEnums::EAway;
       
   203                 }
       
   204             else if(0==aAvabilityText.Compare(KOnPhoneState))
       
   205                 {
       
   206                 iStatus  = TVIMPSTEnums::EOnPhone;
       
   207                 }
       
   208             else if(0==aAvabilityText.Compare(KDndState))
       
   209                 {
       
   210                 iStatus  = TVIMPSTEnums::EDoNotDisturb;
       
   211                 }
       
   212             else
       
   213                 {
       
   214                 iStatus  = TVIMPSTEnums::EBusy;
       
   215 			    }
       
   216             break;
       
   217 			}
       
   218         case MPresenceBuddyInfo2::EAvailable:
       
   219             {
       
   220             iStatus  = TVIMPSTEnums::EOnline;
       
   221             break;
       
   222             }
       
   223         case MPresenceBuddyInfo2::ENotAvailable:
       
   224             {
       
   225             iStatus  = TVIMPSTEnums::EOffline;
       
   226             break;
       
   227             }
       
   228         case MPresenceBuddyInfo2::EUnknownAvailability:
       
   229             {
       
   230             iStatus  = TVIMPSTEnums::EUnknown;
       
   231 			if(0==aAvabilityText.Compare(KInvisibleState))
       
   232 			    {
       
   233 			    iStatus  = TVIMPSTEnums::EInvisible;
       
   234 			    }
       
   235 			
       
   236             break;
       
   237             }    
       
   238         default:
       
   239             {
       
   240             iStatus  = TVIMPSTEnums::EOffline;
       
   241             break;
       
   242             }    
       
   243         }
       
   244     }
       
   245 
       
   246 // ---------------------------------------------------------------------------
       
   247 // CVIMPSTDetailsPresenceHandler::ProcessStatusMesssageL
       
   248 // ---------------------------------------------------------------------------
       
   249 //  
       
   250 void CVIMPSTDetailsPresenceHandler::ProcessStatusMesssageL(const TDesC& aStatusMessage  )
       
   251 	{
       
   252 	if( iStatusMessage )
       
   253 		{
       
   254 		delete iStatusMessage ;
       
   255 		iStatusMessage = NULL;	
       
   256 		}
       
   257 	if( aStatusMessage.Length() > 0 )
       
   258 	    {
       
   259 	    // MAx length of KStatusMsgMaxLength is allocated 
       
   260 	    // if status message is longer than KStatusMsgMaxLength
       
   261 	    iStatusMessage = aStatusMessage.Left( KStatusMsgMaxLength ).AllocL(); 
       
   262 	    }
       
   263 	iPresenceObserver.HandlePresenceChangedL();	
       
   264     }
       
   265 
       
   266 // --------------------------------------------------------------------------
       
   267 // CVIMPSTDetailsPresenceHandler::GetPresenceStatus
       
   268 // --------------------------------------------------------------------------
       
   269 //
       
   270 TVIMPSTEnums::TOnlineStatus CVIMPSTDetailsPresenceHandler::GetPresenceStatus()
       
   271 	{
       
   272 	if(!iUserId)
       
   273 	    {
       
   274 	    return TVIMPSTEnums::EUnknown;
       
   275 	    }
       
   276 	return iStatus;
       
   277 	}
       
   278 
       
   279 // --------------------------------------------------------------------------
       
   280 // CVIMPSTDetailsPresenceHandler::GetHeaderLabelDataL
       
   281 // --------------------------------------------------------------------------
       
   282 //
       
   283 const TDesC& CVIMPSTDetailsPresenceHandler::GetHeaderLabelDataL( TInt aIndex )
       
   284 	{
       
   285 	if( aIndex == 0 && iServiceName ) // first label data
       
   286 		{
       
   287 		return *iServiceName;
       
   288 		}
       
   289 	else if( aIndex == 2 && iPresenceSupported ) // second label data
       
   290 		{
       
   291 		return GetStatusTextL();
       
   292 		}
       
   293 	return KNullDesC; // return empty string for index 1 (label 2) for line in between the service name and presence
       
   294 	}
       
   295 
       
   296 // --------------------------------------------------------------------------
       
   297 // CVIMPSTDetailsPresenceHandler::GetStatusMessageL
       
   298 // --------------------------------------------------------------------------
       
   299 //
       
   300 const TDesC& CVIMPSTDetailsPresenceHandler::GetStatusMessageL()
       
   301 	{
       
   302 	if( iStatusMessage && iStatusMessage->Length() )
       
   303 		{
       
   304 		return *iStatusMessage;	
       
   305 		}
       
   306 	return GetStatusTextL();
       
   307 	}
       
   308 
       
   309 
       
   310 // --------------------------------------------------------------------------
       
   311 // CVIMPSTDetailsPresenceHandler::IsSupported
       
   312 // --------------------------------------------------------------------------
       
   313 //
       
   314 TBool CVIMPSTDetailsPresenceHandler::IsSupported() const
       
   315     {
       
   316     return iPresenceSupported;
       
   317     }
       
   318  // --------------------------------------------------------------------------
       
   319 // CVIMPSTDetailsPresenceHandler::GetStatusTextL
       
   320 // --------------------------------------------------------------------------
       
   321 //
       
   322 const TDesC& CVIMPSTDetailsPresenceHandler::GetStatusTextL()
       
   323 	{
       
   324 	TInt resourceId =  R_SERVDETAIL_STATUSTEXT_OFFLINE;
       
   325   
       
   326 	switch( iStatus )
       
   327 		{
       
   328 		case TVIMPSTEnums::EOffline:
       
   329 		    {
       
   330 		  	resourceId = R_SERVDETAIL_STATUSTEXT_OFFLINE;
       
   331 		    break;
       
   332 		    }
       
   333 		case TVIMPSTEnums::EBusy:
       
   334 		    {
       
   335 			resourceId = R_SERVDETAIL_STATUSTEXT_BUSY;
       
   336 		    break;
       
   337 		    }
       
   338 		case TVIMPSTEnums::EOnline:
       
   339 		    {
       
   340 		  	resourceId = R_SERVDETAIL_STATUSTEXT_ONLINE;
       
   341 		    break;
       
   342 		    }
       
   343 		case TVIMPSTEnums::EInvisible:
       
   344 		    {
       
   345 		  	resourceId = R_SERVDETAIL_STATUSTEXT_DND;
       
   346 		    break;
       
   347 		    }
       
   348 		case TVIMPSTEnums::EOnPhone:
       
   349 		    {
       
   350 		  	resourceId = R_SERVDETAIL_STATUSTEXT_ONTHEPHONE;
       
   351 		    break;
       
   352 		    }
       
   353 		case TVIMPSTEnums::EDoNotDisturb:
       
   354 		    {
       
   355 		  	resourceId = R_SERVDETAIL_STATUSTEXT_DND;
       
   356 		    break;
       
   357 		    }
       
   358 		case TVIMPSTEnums::EAway:
       
   359 		    {
       
   360 		   	resourceId = R_SERVDETAIL_STATUSTEXT_AWAY;
       
   361 		    break;
       
   362 		    }
       
   363 		case TVIMPSTEnums::EBlocked:
       
   364 		    {
       
   365 		    resourceId = R_SERVDETAIL_STATUSTEXT_BLOCKED;
       
   366 		    break;
       
   367 		    }
       
   368 	    case TVIMPSTEnums::EPending:
       
   369 	        {
       
   370 	        resourceId = R_SERVDETAIL_STATUSTEXT_PENDING;
       
   371 	        break;
       
   372 	        }
       
   373 	    case TVIMPSTEnums::ECallForward:
       
   374 	        {
       
   375 	        resourceId = R_SERVDETAIL_STATUSTEXT_CALLFORWARD;
       
   376 	        break;
       
   377 	        }	                
       
   378 		case TVIMPSTEnums::EUnknown:
       
   379 		case TVIMPSTEnums::EServiceOut:
       
   380 		default:
       
   381 		    {
       
   382 		    break;
       
   383 		    }
       
   384 		  }	
       
   385 	if( iStatusText )
       
   386 		{
       
   387 		delete iStatusText;
       
   388 		iStatusText = NULL;	
       
   389 		}
       
   390 	
       
   391 	if( CCoeEnv::Static() && TVIMPSTEnums::EServiceOut != iStatus 
       
   392                             && TVIMPSTEnums::EUnknown != iStatus )
       
   393 		{
       
   394 		iStatusText = StringLoader::LoadL( resourceId );	
       
   395 		}
       
   396 	if( iStatusText && iUserId )
       
   397 		{
       
   398 		return *iStatusText;	
       
   399 		}
       
   400 	return KNullDesC;
       
   401 	}
       
   402 
       
   403 // ---------------------------------------------------------------------------
       
   404 // CVIMPSTDetailsPresenceHandler::GetKeyFieldsAndValuesL
       
   405 // ---------------------------------------------------------------------------
       
   406 //
       
   407 void CVIMPSTDetailsPresenceHandler::GetKeyFieldsAndValuesL(MPresenceBuddyInfo2& aPresenceBuddyInfo)
       
   408     {
       
   409     // At any point of time fro remote and blocked contact only one of the keys
       
   410     // KPendingRequestExtensionValue/KBlockedExtensionValue will be assigned, and not both the keys.
       
   411     TPtrC8 value = aPresenceBuddyInfo.GetAnyField( KExtensionKey() ) ;
       
   412     if(value.Compare( KPendingRequestExtensionValue ) == 0)
       
   413         {
       
   414         iStatus = TVIMPSTEnums::EPending;
       
   415         }
       
   416     else if(value.Compare( KBlockedExtensionValue ) == 0)
       
   417         {
       
   418         iStatus  = TVIMPSTEnums::EBlocked;
       
   419         }
       
   420     else if(value.Compare( KServiceExtensionValue ) == 0)
       
   421        {
       
   422        iStatus  = TVIMPSTEnums::EServiceOut;
       
   423        }
       
   424     else if(value.Compare( KCallForwardExtensionValue ) == 0)
       
   425        {
       
   426         iStatus  = TVIMPSTEnums::ECallForward;
       
   427         }
       
   428 	else
       
   429 		{
       
   430 		iStatus  = TVIMPSTEnums::EOffline;
       
   431 		}
       
   432     }
       
   433     
       
   434 // end of file
       
   435 
       
   436 
       
   437