iaupdate/IAD/engine/controller/src/iaupdatecontrollerfile.cpp
changeset 0 ba25891c3a9e
equal deleted inserted replaced
-1:000000000000 0:ba25891c3a9e
       
     1 /*
       
     2 * Copyright (c) 2007-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:   This module contains the implementation of CIAUpdateControllerFile 
       
    15 *                class  member functions.
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 #include <bautils.h>
       
    23 #include <s32file.h>
       
    24 #include <sysutil.h>
       
    25 
       
    26 #include "iaupdatecontrollerfile.h"
       
    27 #include "iaupdatectrlfileconsts.h"
       
    28 
       
    29 
       
    30 // This constant will be used to check if the IAD application
       
    31 // and its updates are using the same version of the file. If the versions
       
    32 // differ, then this may require additional checking in the future versions
       
    33 // when data is internalized. For example, previous IAD may give old version data 
       
    34 // into the file during self update.
       
    35 const TInt KVersion( 1 );
       
    36 
       
    37 const TInt KSizeOfFile( 16 );
       
    38     
       
    39 
       
    40 // -----------------------------------------------------------------------------
       
    41 // CIAUpdateControllerFile::NewL
       
    42 //
       
    43 // -----------------------------------------------------------------------------
       
    44 //
       
    45 EXPORT_C CIAUpdateControllerFile* CIAUpdateControllerFile::NewL( 
       
    46     const TDesC& aFile )
       
    47     {
       
    48     CIAUpdateControllerFile* self =
       
    49         CIAUpdateControllerFile::NewLC( aFile );
       
    50     CleanupStack::Pop( self );
       
    51     return self;
       
    52     }
       
    53 
       
    54 
       
    55 // -----------------------------------------------------------------------------
       
    56 // CIAUpdateControllerFile::NewLC
       
    57 //
       
    58 // -----------------------------------------------------------------------------
       
    59 //
       
    60 EXPORT_C CIAUpdateControllerFile* CIAUpdateControllerFile::NewLC( 
       
    61     const TDesC& aFile )
       
    62     {
       
    63     CIAUpdateControllerFile* self =
       
    64         new( ELeave) CIAUpdateControllerFile();
       
    65     CleanupStack::PushL( self );
       
    66     self->ConstructL( aFile );
       
    67     return self;    
       
    68     }
       
    69 
       
    70 
       
    71 // -----------------------------------------------------------------------------
       
    72 // CIAUpdateControllerFile::CIAUpdateControllerFile
       
    73 //
       
    74 // -----------------------------------------------------------------------------
       
    75 //
       
    76 CIAUpdateControllerFile::CIAUpdateControllerFile()
       
    77 : CBase(),
       
    78   iRefreshTime( 0 ),
       
    79   iLanguage( User::Language() )
       
    80     {
       
    81     }
       
    82 
       
    83 
       
    84 // -----------------------------------------------------------------------------
       
    85 // CIAUpdateControllerFile::ConstructL
       
    86 //
       
    87 // -----------------------------------------------------------------------------
       
    88 //
       
    89 void CIAUpdateControllerFile::ConstructL( const TDesC& aFile )
       
    90     {
       
    91     User::LeaveIfError( iFsSession.Connect() );
       
    92     User::LeaveIfError( 
       
    93         iFsSession.SetSessionToPrivate( 
       
    94             IAUpdateCtrlFileConsts::KDrive ) );
       
    95     
       
    96     User::LeaveIfError( iFsSession.SessionPath( iPath ) );
       
    97     BaflUtils::EnsurePathExistsL( iFsSession, iPath );
       
    98     iPath.Append( aFile );
       
    99     
       
   100     // Read data from the file if the file exists.
       
   101     // Otherwise, let default values remain.
       
   102     ReadControllerDataL(); 
       
   103     }
       
   104 
       
   105 
       
   106 // -----------------------------------------------------------------------------
       
   107 // CIAUpdateControllerFile::~CIAUpdateControllerFile
       
   108 //
       
   109 // -----------------------------------------------------------------------------
       
   110 //
       
   111 EXPORT_C CIAUpdateControllerFile::~CIAUpdateControllerFile()
       
   112     {
       
   113     iFsSession.Close();
       
   114     }
       
   115 
       
   116 
       
   117 // -----------------------------------------------------------------------------
       
   118 // CIAUpdateControllerFile::ReadControllerDataL
       
   119 //
       
   120 // -----------------------------------------------------------------------------
       
   121 //
       
   122 EXPORT_C TBool CIAUpdateControllerFile::ReadControllerDataL()
       
   123 	{
       
   124 	RFile file;
       
   125     TInt err = file.Open( iFsSession, iPath, EFileRead|EFileShareAny );
       
   126     if ( err == KErrNotFound )
       
   127     	{
       
   128     	// File did not exist. 
       
   129     	// So, nothing to do here anymore.
       
   130     	return EFalse;
       
   131     	}
       
   132     User::LeaveIfError( err );
       
   133     	
       
   134     CleanupClosePushL( file );
       
   135     
       
   136     RFileReadStream stream( file, 0 );
       
   137     CleanupClosePushL( stream );
       
   138 
       
   139     InternalizeL( stream );
       
   140 
       
   141     CleanupStack::PopAndDestroy( &stream );
       
   142     CleanupStack::PopAndDestroy( &file );
       
   143 
       
   144     return ETrue;
       
   145 	}
       
   146 
       
   147 
       
   148 // -----------------------------------------------------------------------------
       
   149 // CIAUpdateControllerFile::WriteControllerDataL
       
   150 //
       
   151 // -----------------------------------------------------------------------------
       
   152 //
       
   153 EXPORT_C void CIAUpdateControllerFile::WriteControllerDataL()
       
   154 	{
       
   155 	TDriveUnit driveUnit( IAUpdateCtrlFileConsts::KDrive );
       
   156 	if ( SysUtil::DiskSpaceBelowCriticalLevelL( 
       
   157 	        &iFsSession, KSizeOfFile, driveUnit ) )
       
   158 	    {
       
   159 		User::Leave( KErrDiskFull );
       
   160 	    }
       
   161 	
       
   162 	RFile file;
       
   163     User::LeaveIfError( 
       
   164         file.Replace( iFsSession, iPath, EFileWrite|EFileShareAny ) );
       
   165     CleanupClosePushL( file );
       
   166     
       
   167     RFileWriteStream stream( file, 0 );
       
   168     CleanupClosePushL( stream );
       
   169 
       
   170     ExternalizeL( stream );
       
   171     
       
   172     stream.CommitL();
       
   173     
       
   174     CleanupStack::PopAndDestroy( &stream );
       
   175     CleanupStack::PopAndDestroy( &file );
       
   176 	}
       
   177 
       
   178 
       
   179 // -----------------------------------------------------------------------------
       
   180 // CIAUpdateControllerFile::SetCurrentData
       
   181 //
       
   182 // -----------------------------------------------------------------------------
       
   183 //
       
   184 EXPORT_C void CIAUpdateControllerFile::SetCurrentData()
       
   185     {
       
   186     SetCurrentRefreshTime();
       
   187     SetCurrentLanguage();
       
   188     }
       
   189 
       
   190 
       
   191 // -----------------------------------------------------------------------------
       
   192 // CIAUpdateControllerFile::RefreshTime
       
   193 //
       
   194 // -----------------------------------------------------------------------------
       
   195 //
       
   196 EXPORT_C const TTime& CIAUpdateControllerFile::RefreshTime() const
       
   197     {
       
   198     return iRefreshTime;
       
   199     }
       
   200     
       
   201 
       
   202 // -----------------------------------------------------------------------------
       
   203 // CIAUpdateControllerFile::SetRefreshTime
       
   204 //
       
   205 // -----------------------------------------------------------------------------
       
   206 //
       
   207 EXPORT_C void CIAUpdateControllerFile::SetRefreshTime( const TTime& aTime )
       
   208     {
       
   209     iRefreshTime = aTime;
       
   210     }
       
   211 
       
   212 
       
   213 // -----------------------------------------------------------------------------
       
   214 // CIAUpdateControllerFile::SetRefreshTime
       
   215 //
       
   216 // -----------------------------------------------------------------------------
       
   217 //
       
   218 EXPORT_C void CIAUpdateControllerFile::SetRefreshTime( TInt64 aTime )
       
   219     {
       
   220     iRefreshTime = aTime;
       
   221     }
       
   222 
       
   223 
       
   224 // -----------------------------------------------------------------------------
       
   225 // CIAUpdateControllerFile::SetCurrentRefreshTime
       
   226 //
       
   227 // -----------------------------------------------------------------------------
       
   228 //
       
   229 EXPORT_C void CIAUpdateControllerFile::SetCurrentRefreshTime()
       
   230     {
       
   231     TTime universalTime;
       
   232     universalTime.UniversalTime();
       
   233     iRefreshTime = universalTime;
       
   234     }
       
   235 
       
   236 
       
   237 // -----------------------------------------------------------------------------
       
   238 // CIAUpdateControllerFile::Language
       
   239 //
       
   240 // -----------------------------------------------------------------------------
       
   241 //
       
   242 EXPORT_C TLanguage CIAUpdateControllerFile::Language() const
       
   243     {
       
   244     return iLanguage;
       
   245     }
       
   246 
       
   247 
       
   248 // -----------------------------------------------------------------------------
       
   249 // CIAUpdateControllerFile::SetLanguage
       
   250 //
       
   251 // -----------------------------------------------------------------------------
       
   252 //
       
   253 EXPORT_C void CIAUpdateControllerFile::SetLanguage( TLanguage aLanguage )
       
   254     {
       
   255     iLanguage = aLanguage;
       
   256     }
       
   257 
       
   258 
       
   259 // -----------------------------------------------------------------------------
       
   260 // CIAUpdateControllerFile::SetCurrentLanguage
       
   261 //
       
   262 // -----------------------------------------------------------------------------
       
   263 //
       
   264 EXPORT_C void CIAUpdateControllerFile::SetCurrentLanguage()
       
   265     {
       
   266     SetLanguage( User::Language() );
       
   267     }
       
   268 
       
   269 
       
   270 // -----------------------------------------------------------------------------
       
   271 // CIAUpdateControllerFile::InternalizeL
       
   272 //
       
   273 // -----------------------------------------------------------------------------
       
   274 //
       
   275 void CIAUpdateControllerFile::InternalizeL( RReadStream& aStream )
       
   276 	{
       
   277 	// If you make changes here, 
       
   278 	// remember to update ExternalizeL accordingly!!!
       
   279 
       
   280     TInt version( aStream.ReadInt32L() );
       
   281 
       
   282     // Notice! In the future, some checking maybe required here
       
   283     // to be sure that file version is correct and the data can be
       
   284     // internalized correctly between different versions.
       
   285     if ( version != KVersion )
       
   286         {
       
   287         // For now, just leave with the corrupt error.
       
   288         User::Leave( KErrCorrupt );
       
   289         }
       
   290 	
       
   291 	TInt64 refreshTime( 0 );
       
   292 	aStream >> refreshTime;
       
   293     SetRefreshTime( refreshTime );
       
   294     
       
   295     TInt language( aStream.ReadInt32L() );
       
   296     // Static casting is safe to do here because enum and TInt are the same.
       
   297     SetLanguage( static_cast< TLanguage >( language ) );
       
   298 	}
       
   299 
       
   300 
       
   301 // -----------------------------------------------------------------------------
       
   302 // CIAUpdateControllerFile::ExternalizeL
       
   303 //
       
   304 // -----------------------------------------------------------------------------
       
   305 //
       
   306 void CIAUpdateControllerFile::ExternalizeL( RWriteStream& aStream )
       
   307 	{
       
   308 	// If you make changes here, 
       
   309 	// remember to update InternalizeL accordingly!!!
       
   310 
       
   311     aStream.WriteInt32L( KVersion );
       
   312 	
       
   313 	TInt64 refreshTime( RefreshTime().Int64() );
       
   314 	aStream << refreshTime;
       
   315 
       
   316     TInt language( Language() );
       
   317     aStream.WriteInt32L( language );
       
   318 	}