1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/apputils/src/babackup.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,699 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#include <babackup.h>
1.20 +#include <bafl/backup_std.h>
1.21 +#include <e32std.h>
1.22 +#include <e32base.h>
1.23 +#include <baksrv.h>
1.24 +#include "Baksrvs.h"
1.25 +#include <e32math.h>
1.26 +#include <e32svr.h>
1.27 +#include <baflpan.h>
1.28 +
1.29 +#define UNUSED_VAR(a) a = a
1.30 +
1.31 +const TUid KServerUid3={0x10004900};
1.32 +const TInt KBADefaultPriority = CActive::EPriorityUserInput;
1.33 +_LIT(KBackupSrvName,"baksrvs");
1.34 +
1.35 +//
1.36 +// class RBaBackupSession
1.37 +//
1.38 +
1.39 +const TInt KNumConnectRetries =10;
1.40 +
1.41 +
1.42 +class RBaBackupSession : public RSessionBase
1.43 + {
1.44 +public:
1.45 + TInt Connect();
1.46 + void RegisterForNotifications(TRequestStatus& aStatus) const;
1.47 + void DeregisterForNotifications() const;
1.48 + void GetEvent(TDes& aFileName,MBackupObserver::TFileLockFlags& aFileFlag) const;
1.49 + void CloseAllFiles(MBackupObserver::TFileLockFlags aFlags,TRequestStatus& aStatus) const;
1.50 + void RestartApps() const;
1.51 + TInt CloseFile(const TDesC& aFileName,MBackupObserver::TFileLockFlags aFlags) const;
1.52 + void RestartFile(const TDesC& aFileName) const;
1.53 + TInt NotifyChangeFileLock(const TDesC& aFileName) const;
1.54 + void NotifyChangeFileLockCancel(const TDesC& aFileName) const;
1.55 + void CloseServer() const;
1.56 + void NotifyBackupOperation(const TBackupOperationAttributes& aBackupOperationAttributes);
1.57 + TBool IsBackupOperationRunning() const;
1.58 + void BackupOperationEventReady(TRequestStatus& aStatus, TPckgBuf<TBackupOperationAttributes>& aBackupOperationAttributes) const;
1.59 + void CancelOutstandingEventForBackupOperation() const;
1.60 + void GetBackupOperationEvent(TBackupOperationAttributes& aBackupOperationAttributes) const;
1.61 + void SetBackupOperationObserverIsPresent(TBool aObserverIsPresent) const;
1.62 +private:
1.63 + TInt StartServer();
1.64 + };
1.65 +
1.66 +TInt RBaBackupSession::Connect()
1.67 + {
1.68 + TInt err=KErrNone;
1.69 + TInt retry=KNumConnectRetries;
1.70 + FOREVER
1.71 + {
1.72 + err=CreateSession(__BACKUP_SERVER_NAME_V2,TVersion(KBakServMajorVN,KBakServMinorVN,KBakServBuildVN),KBakServMessageSlots);
1.73 + if ((--retry>0) && ((err==KErrNotFound) || (err==KErrServerTerminated)))
1.74 + {
1.75 + err = StartServer();
1.76 + if ((err!=KErrNone) && (err!=KErrAlreadyExists))
1.77 + {
1.78 + break;
1.79 + }
1.80 + }
1.81 + else
1.82 + {
1.83 + break;
1.84 + }
1.85 + }
1.86 + return err;
1.87 + }
1.88 +
1.89 +TInt RBaBackupSession::StartServer()
1.90 + {
1.91 + const TUidType serverUid(KNullUid,KNullUid,KServerUid3);
1.92 + TInt error=KErrNone;
1.93 + RProcess server;
1.94 + error = server.Create(KBackupSrvName,KNullDesC,serverUid);
1.95 + if(error!=KErrNone)
1.96 + return error;
1.97 + TRequestStatus stat;
1.98 + server.Rendezvous(stat);
1.99 + if (stat!=KRequestPending)
1.100 + server.Kill(0); // abort startup
1.101 + else
1.102 + server.Resume(); // logon OK - start the server
1.103 + User::WaitForRequest(stat); // wait for start or death
1.104 + // we can't use the 'exit reason' if the server panicked as this
1.105 + // is the panic 'reason' and may be '0' which cannot be distinguished
1.106 + // from KErrNone
1.107 + error=(server.ExitType()==EExitPanic) ? KErrGeneral : stat.Int();
1.108 + server.Close();
1.109 + return error;
1.110 + }
1.111 +
1.112 +
1.113 +void RBaBackupSession::RegisterForNotifications(TRequestStatus& aStatus) const
1.114 + {
1.115 + SendReceive(EBakOpCodeEventReady,aStatus);
1.116 + }
1.117 +
1.118 +void RBaBackupSession::DeregisterForNotifications() const
1.119 + {
1.120 + SendReceive(EBakOpCodeStopNotifications);
1.121 + }
1.122 +
1.123 +void RBaBackupSession::GetEvent(TDes& aFileName,MBackupObserver::TFileLockFlags& aFileFlag) const
1.124 + {
1.125 + TBuf<KMaxFileName+1> buf;
1.126 + if (SendReceive(EBakOpCodeGetEvent,TIpcArgs(&buf))!=KErrServerTerminated)
1.127 + {
1.128 + TBuf<1> num=buf.Left(1);
1.129 + buf.Delete(0,1);
1.130 + aFileName=buf;
1.131 + aFileFlag=(MBackupObserver::TFileLockFlags)(num[0]-'0');
1.132 + }
1.133 + }
1.134 +
1.135 +void RBaBackupSession::CloseAllFiles(MBackupObserver::TFileLockFlags aFlags,TRequestStatus& aStatus) const
1.136 + {
1.137 + SendReceive(EBakOpCodeCloseAllFiles,TIpcArgs(aFlags),aStatus);
1.138 + }
1.139 +
1.140 +void RBaBackupSession::RestartApps() const
1.141 + {
1.142 + SendReceive(EBakOpCodeRestartAll);
1.143 + }
1.144 +
1.145 +TInt RBaBackupSession::CloseFile(const TDesC& aFileName,MBackupObserver::TFileLockFlags aFlags) const
1.146 + {
1.147 + const TInt err=SendReceive(EBakOpCodeCloseFile,TIpcArgs(aFileName.Length(),&aFileName,aFlags));
1.148 + return err;
1.149 + }
1.150 +
1.151 +void RBaBackupSession::RestartFile(const TDesC& aFileName) const
1.152 + {
1.153 + SendReceive(EBakOpCodeRestartFile,TIpcArgs(aFileName.Length(),&aFileName));
1.154 + }
1.155 +
1.156 +TInt RBaBackupSession::NotifyChangeFileLock(const TDesC& aFileName) const
1.157 + {
1.158 + return SendReceive(EBakOpCodeNotifyLockChange,TIpcArgs(aFileName.Length(),&aFileName));
1.159 + }
1.160 +
1.161 +void RBaBackupSession::NotifyChangeFileLockCancel(const TDesC& aFileName) const
1.162 + {
1.163 + SendReceive(EBakOpCodeNotifyLockChangeCancel,TIpcArgs(aFileName.Length(),&aFileName));
1.164 + }
1.165 +
1.166 +void RBaBackupSession::CloseServer() const
1.167 + {
1.168 + Send(EBakOpCodeCloseServer);
1.169 + }
1.170 +
1.171 +void RBaBackupSession::NotifyBackupOperation(const TBackupOperationAttributes& aBackupOperationAttributes)
1.172 + {
1.173 + TPckgC<TBackupOperationAttributes> backupOpAttPkg(aBackupOperationAttributes);
1.174 + SendReceive(EBakOpCodeNotifyBackupOperation, TIpcArgs(&backupOpAttPkg));
1.175 + }
1.176 +
1.177 +void RBaBackupSession::CancelOutstandingEventForBackupOperation() const
1.178 + {
1.179 + SendReceive(EBakOpCodeCancelOutstandingBackupOperationEvent);
1.180 + }
1.181 +
1.182 +TBool RBaBackupSession::IsBackupOperationRunning() const
1.183 + {
1.184 + TBool isRunning=EFalse;
1.185 + TPckg<TBool> pkg(isRunning);
1.186 + SendReceive(EBakOpCodeGetBackupOperationState, TIpcArgs(&pkg));
1.187 + return pkg();
1.188 + }
1.189 +
1.190 +void RBaBackupSession::BackupOperationEventReady(TRequestStatus& aStatus, TPckgBuf<TBackupOperationAttributes>& aBackupOperationAttributes) const
1.191 + {
1.192 + SendReceive(EBakOpCodeBackupOperationEventReady,TIpcArgs(&aBackupOperationAttributes),aStatus);
1.193 + }
1.194 +
1.195 +void RBaBackupSession::GetBackupOperationEvent(TBackupOperationAttributes& aBackupOperationAttributes) const
1.196 + {
1.197 + TPckg<TBackupOperationAttributes> backupOpAttPkg(aBackupOperationAttributes);
1.198 + SendReceive(EBakOpCodeGetBackupOperationEvent, TIpcArgs(&backupOpAttPkg));
1.199 + }
1.200 +
1.201 +void RBaBackupSession::SetBackupOperationObserverIsPresent(TBool aObserverIsPresent) const
1.202 + {
1.203 + Send(EBakOpCodeSetBackupOperationObserverIsPresent, TIpcArgs(aObserverIsPresent));
1.204 + }
1.205 +
1.206 +//
1.207 +// class CBaLockChangeNotifier
1.208 +//
1.209 +
1.210 +NONSHARABLE_CLASS(CBaLockChangeNotifier) : public CActive
1.211 + {
1.212 +public:
1.213 + static CBaLockChangeNotifier* NewL(RBaBackupSession& aBackupSession);
1.214 + ~CBaLockChangeNotifier();
1.215 + void AddL(const TDesC& aFileName, MBackupObserver& aObserver);
1.216 + void Remove(const TDesC& aFileName);
1.217 +protected:
1.218 + void StartNotifications();
1.219 + void StopNotifications();
1.220 +private: // from CActive
1.221 + void DoCancel();
1.222 + void RunL();
1.223 +private:
1.224 + CBaLockChangeNotifier(RBaBackupSession& aBackupSession);
1.225 + void DoRunL();
1.226 + TInt Find(const TDesC& aFileName) const;
1.227 +private:
1.228 + class TFileItem
1.229 + {
1.230 + public:
1.231 + TFileItem(HBufC* aFile,MBackupObserver& aObserver);
1.232 + public:
1.233 + HBufC* iFile;
1.234 + MBackupObserver& iObserver;
1.235 + };
1.236 +private:
1.237 + RBaBackupSession& iBackupSession;
1.238 + RArray<TFileItem> iFileItems;
1.239 + };
1.240 +
1.241 +CBaLockChangeNotifier::TFileItem::TFileItem(HBufC* aFile,MBackupObserver& aObserver)
1.242 + : iFile(aFile),
1.243 + iObserver(aObserver)
1.244 + {}
1.245 +
1.246 +CBaLockChangeNotifier* CBaLockChangeNotifier::NewL(RBaBackupSession& aBackupSession)
1.247 + { // static
1.248 + CBaLockChangeNotifier* self=new(ELeave) CBaLockChangeNotifier(aBackupSession);
1.249 + CActiveScheduler::Add(self);
1.250 + return self;
1.251 + }
1.252 +
1.253 +CBaLockChangeNotifier::~CBaLockChangeNotifier()
1.254 + {
1.255 + Cancel();
1.256 +
1.257 + const TInt count=iFileItems.Count();
1.258 + for (TInt ii=0;ii<count;ii++)
1.259 + {
1.260 + delete iFileItems[ii].iFile;
1.261 + }
1.262 + iFileItems.Close();
1.263 + }
1.264 +
1.265 +void CBaLockChangeNotifier::StartNotifications()
1.266 + {
1.267 + if(!IsActive())
1.268 + {
1.269 + iBackupSession.RegisterForNotifications(iStatus);
1.270 + SetActive();
1.271 + }
1.272 + }
1.273 +
1.274 +void CBaLockChangeNotifier:: StopNotifications()
1.275 + {
1.276 + const TInt count=iFileItems.Count();
1.277 +
1.278 + if(count==0)
1.279 + {
1.280 + Cancel();
1.281 + }
1.282 + }
1.283 +
1.284 +void CBaLockChangeNotifier::AddL(const TDesC& aFileName, MBackupObserver& aObserver)
1.285 + {
1.286 + StartNotifications();
1.287 +
1.288 + HBufC* file=aFileName.AllocLC();
1.289 + TFileItem fileItem(file,aObserver);
1.290 + User::LeaveIfError(iFileItems.Append(fileItem));
1.291 + CleanupStack::Pop(); // file
1.292 + const TInt err=iBackupSession.NotifyChangeFileLock(aFileName);
1.293 + if (err!=KErrNone)
1.294 + {
1.295 + delete file;
1.296 + iFileItems.Remove(iFileItems.Count()-1);
1.297 + iFileItems.Compress();
1.298 + User::Leave(err);
1.299 + }
1.300 + }
1.301 +
1.302 +void CBaLockChangeNotifier::Remove(const TDesC& aFileName)
1.303 + {
1.304 + const TInt index=Find(aFileName);
1.305 + if (index!=KErrNotFound)
1.306 + {
1.307 + const TFileItem& fileItem=iFileItems[index];
1.308 + iBackupSession.NotifyChangeFileLockCancel(*fileItem.iFile);
1.309 + delete fileItem.iFile;
1.310 + iFileItems.Remove(index);
1.311 + iFileItems.Compress();
1.312 + }
1.313 +
1.314 + StopNotifications();
1.315 + }
1.316 +
1.317 +
1.318 +void CBaLockChangeNotifier::DoCancel()
1.319 + {
1.320 + const TInt count=iFileItems.Count();
1.321 +
1.322 + // release the locks on all outstandng files in this session
1.323 + for (TInt ii=0;ii<count;ii++)
1.324 + {
1.325 + const TFileItem& fileItem=iFileItems[ii];
1.326 + iBackupSession.NotifyChangeFileLockCancel(*fileItem.iFile);
1.327 + }
1.328 + iBackupSession.DeregisterForNotifications();
1.329 + }
1.330 +
1.331 +void CBaLockChangeNotifier::RunL()
1.332 + {
1.333 + TRAPD(err,DoRunL());
1.334 + if (err!=KErrServerTerminated)
1.335 + {
1.336 + StartNotifications();
1.337 + }
1.338 + User::LeaveIfError(err);
1.339 + }
1.340 +
1.341 +CBaLockChangeNotifier::CBaLockChangeNotifier(RBaBackupSession& aBackupSession)
1.342 + : CActive(KBADefaultPriority), iBackupSession(aBackupSession)
1.343 + {}
1.344 +
1.345 +
1.346 +void CBaLockChangeNotifier::DoRunL()
1.347 + {
1.348 + const TInt status=iStatus.Int();
1.349 +
1.350 + if (status<0)
1.351 + {
1.352 + User::Leave(status);
1.353 + }
1.354 + TFileName fileName;
1.355 + MBackupObserver::TFileLockFlags fileFlag;
1.356 + iBackupSession.GetEvent(fileName,fileFlag);
1.357 + TInt err=KErrNone;
1.358 + const TInt count=iFileItems.Count();
1.359 + for (TInt ii=0;ii<count;ii++)
1.360 + {
1.361 + const TFileItem& fileItem=iFileItems[ii];
1.362 + if (fileItem.iFile->MatchF(fileName)==0)
1.363 + {
1.364 + TRAPD(r,fileItem.iObserver.ChangeFileLockL(*fileItem.iFile,fileFlag));
1.365 + if (r!=KErrNone && err==KErrNone)
1.366 + {
1.367 + err=r;
1.368 + }
1.369 + }
1.370 + }
1.371 + User::LeaveIfError(err);
1.372 + }
1.373 +
1.374 +TInt CBaLockChangeNotifier::Find(const TDesC& aFileName) const
1.375 + {
1.376 + TInt index=KErrNotFound;
1.377 + const TInt count=iFileItems.Count();
1.378 + for (TInt ii=0;ii<count;ii++)
1.379 + {
1.380 + const TFileItem& fileItem=iFileItems[ii];
1.381 + if (*fileItem.iFile==aFileName)
1.382 + {
1.383 + index=ii;
1.384 + break;
1.385 + }
1.386 + }
1.387 + return index;
1.388 + }
1.389 +
1.390 +//
1.391 +// class CBaBackupOperationNotifier
1.392 +//
1.393 +
1.394 +NONSHARABLE_CLASS(CBaBackupOperationNotifier) : public CActive
1.395 + {
1.396 +public:
1.397 + static CBaBackupOperationNotifier* NewL(RBaBackupSession& aBackupSession);
1.398 + ~CBaBackupOperationNotifier();
1.399 + void AddBackupOperationObserverL(MBackupOperationObserver& aBackupSession);
1.400 + void RemoveBackupOperationObserver(MBackupOperationObserver& aBackupSession);
1.401 +private: // from CActive
1.402 + void DoCancel();
1.403 + void RunL();
1.404 +private:
1.405 + CBaBackupOperationNotifier(RBaBackupSession& aBackupSession);
1.406 + void Queue();
1.407 + void DoRunL();
1.408 +private:
1.409 + RPointerArray<MBackupOperationObserver> iObservers;
1.410 + RBaBackupSession& iBackupSession;
1.411 + TPckgBuf<TBackupOperationAttributes> iBackupOperationAttributes;
1.412 + };
1.413 +
1.414 +
1.415 +CBaBackupOperationNotifier* CBaBackupOperationNotifier::NewL(RBaBackupSession& aBackupSession)
1.416 + { // static
1.417 + CBaBackupOperationNotifier* self=new(ELeave) CBaBackupOperationNotifier(aBackupSession);
1.418 + CActiveScheduler::Add(self);
1.419 + return self;
1.420 + }
1.421 +
1.422 +CBaBackupOperationNotifier::~CBaBackupOperationNotifier()
1.423 + {
1.424 + Cancel();
1.425 + iObservers.Reset();
1.426 + iObservers.Close();
1.427 + }
1.428 +
1.429 +void CBaBackupOperationNotifier::AddBackupOperationObserverL(MBackupOperationObserver& aBackupOperationObserver)
1.430 + {
1.431 + const TInt index = iObservers.Find(&aBackupOperationObserver);
1.432 + if (index == KErrNotFound)
1.433 + {
1.434 + User::LeaveIfError(iObservers.Append(&aBackupOperationObserver));
1.435 + if (iBackupSession.IsBackupOperationRunning())
1.436 + {
1.437 + TBackupOperationAttributes backupOperationAttributes;
1.438 + iBackupSession.GetBackupOperationEvent(backupOperationAttributes);
1.439 + aBackupOperationObserver.HandleBackupOperationEventL(backupOperationAttributes);
1.440 + }
1.441 + }
1.442 + Queue();
1.443 + }
1.444 +
1.445 +void CBaBackupOperationNotifier::RemoveBackupOperationObserver(MBackupOperationObserver& aBackupOperationObserver)
1.446 + {
1.447 + const TInt index = iObservers.Find(&aBackupOperationObserver);
1.448 + if (index != KErrNotFound)
1.449 + {
1.450 + iObservers.Remove(index);
1.451 + if (iObservers.Count() == 0)
1.452 + {
1.453 + iBackupSession.CancelOutstandingEventForBackupOperation();
1.454 + iBackupSession.SetBackupOperationObserverIsPresent(EFalse);
1.455 + }
1.456 + }
1.457 + }
1.458 +
1.459 +void CBaBackupOperationNotifier::DoCancel()
1.460 + {
1.461 + TBackupOperationAttributes backupOperationAttributes;
1.462 + iBackupSession.GetBackupOperationEvent(backupOperationAttributes);
1.463 + const TInt count = iObservers.Count();
1.464 + for (TInt index=0; index<count; ++index)
1.465 + {
1.466 + // TRAP and ignore the errCode
1.467 + TRAPD(errCode, iObservers[index]->HandleBackupOperationEventL(backupOperationAttributes));
1.468 + UNUSED_VAR(errCode);
1.469 + }
1.470 + iBackupSession.CancelOutstandingEventForBackupOperation();
1.471 + }
1.472 +
1.473 +void CBaBackupOperationNotifier::RunL()
1.474 + {
1.475 + const TInt status=iStatus.Int();
1.476 + if (status!=KErrCancel && iObservers.Count()>0)
1.477 + {
1.478 + TRAPD(err,DoRunL());
1.479 + if (err!=KErrServerTerminated)
1.480 + {
1.481 + Queue();
1.482 + }
1.483 + User::LeaveIfError(err);
1.484 + }
1.485 + }
1.486 +
1.487 +CBaBackupOperationNotifier::CBaBackupOperationNotifier(RBaBackupSession& aBackupSession)
1.488 + : CActive(EPriorityStandard), iBackupSession(aBackupSession)
1.489 + {}
1.490 +
1.491 +void CBaBackupOperationNotifier::Queue()
1.492 + {
1.493 + if (!IsActive())
1.494 + {
1.495 + iStatus=KRequestPending;
1.496 + SetActive();
1.497 + iBackupSession.SetBackupOperationObserverIsPresent(ETrue);
1.498 + iBackupSession.BackupOperationEventReady(iStatus, iBackupOperationAttributes);
1.499 + }
1.500 + }
1.501 +
1.502 +void CBaBackupOperationNotifier::DoRunL()
1.503 + {
1.504 + const TInt status=iStatus.Int();
1.505 + if (status<0)
1.506 + {
1.507 + User::Leave(status);
1.508 + }
1.509 + const TInt count = iObservers.Count();
1.510 + for (TInt index=0; index<count; ++index)
1.511 + {
1.512 + iObservers[index]->HandleBackupOperationEventL(iBackupOperationAttributes());
1.513 + }
1.514 + }
1.515 +
1.516 +//
1.517 +// class CBaBackupSessionWrapper
1.518 +//
1.519 +
1.520 +/**
1.521 + * Returns a newly created CBaBackupSessionWrapper, passing ownership immediately
1.522 + */
1.523 +EXPORT_C CBaBackupSessionWrapper* CBaBackupSessionWrapper::NewL()
1.524 + { // static
1.525 + CBaBackupSessionWrapper* self=new(ELeave) CBaBackupSessionWrapper();
1.526 + CleanupStack::PushL(self);
1.527 + self->ConstructL();
1.528 + CleanupStack::Pop(); // self
1.529 + return self;
1.530 + }
1.531 +
1.532 +/**
1.533 + * D'tor. Any files or apps that have been closed will be restarted
1.534 + */
1.535 +EXPORT_C CBaBackupSessionWrapper::~CBaBackupSessionWrapper()
1.536 + {
1.537 + delete iLockChangeNotifier;
1.538 + delete iBackupOperationNotifier;
1.539 + if (iBackupSession)
1.540 + {
1.541 + iBackupSession->Close();
1.542 + delete iBackupSession;
1.543 + }
1.544 + }
1.545 +
1.546 +/**
1.547 +Register the specified file to the server. The given observer will be called back when
1.548 +the lock state of the file should be modified
1.549 +
1.550 +@param aFileName the name of the file to be observed.
1.551 +@param aObserver the observer which will be called back when the lock state of the file should be modified.
1.552 +
1.553 +@leave KErrServerBusy if the server is busy with the other client or under CloseAll operation. KErrNoMemory
1.554 +if not enough memory to register this file.
1.555 +*/
1.556 +EXPORT_C void CBaBackupSessionWrapper::RegisterFileL(const TDesC& aFileName,MBackupObserver& aObserver)
1.557 + {
1.558 + if (!iLockChangeNotifier)
1.559 + {
1.560 + iLockChangeNotifier=CBaLockChangeNotifier::NewL(*iBackupSession);
1.561 + }
1.562 +
1.563 + __ASSERT_ALWAYS(iLockChangeNotifier, Panic(EBafPanicNullPointer));
1.564 + iLockChangeNotifier->AddL(aFileName,aObserver);
1.565 + }
1.566 +
1.567 +/**
1.568 + * Stop sending this client requests to alter the lock state of aFileName
1.569 + */
1.570 +EXPORT_C void CBaBackupSessionWrapper::DeregisterFile(const TDesC& aFileName)
1.571 + {
1.572 + if(iLockChangeNotifier)
1.573 + iLockChangeNotifier->Remove(aFileName);
1.574 + }
1.575 +
1.576 +/**
1.577 + Closes all non-system apps and signal all registered files to have their locks altered according to aFlags.
1.578 + Returns immediately before having finished all processing. aStatus will be completed when everything is
1.579 + closed or closing has completed. Possible error codes are
1.580 + KErrNoMemory - Not enough memory to signal all apps/files to close
1.581 + KErrServerBusy - Another client has some files closed - No-one else should attempt any backup operation
1.582 + KErrLocked - Not all apps were successfully closed
1.583 + In all cases, an undefined number of apps/files may have been closed and backup may still be possible although
1.584 + install/restore operations should not be attempted.
1.585 +
1.586 + @param aFlags the file lock state to request the other clients with.
1.587 + @param aStatus the request status to be completed when all files have been closed.
1.588 + @publishedPartner
1.589 + @released
1.590 + @capability WriteDeviceData
1.591 + */
1.592 +EXPORT_C void CBaBackupSessionWrapper::CloseAll(MBackupObserver::TFileLockFlags aFlags,TRequestStatus& aStatus)
1.593 + {
1.594 + iBackupSession->CloseAllFiles(aFlags,aStatus);
1.595 + }
1.596 +
1.597 +/**
1.598 + * Opposite of CloseAll. Can safely be called nothing has been closed by this client
1.599 + *
1.600 + * @publishedPartner
1.601 + * @released
1.602 + * @capability WriteDeviceData
1.603 + */
1.604 +EXPORT_C void CBaBackupSessionWrapper::RestartAll()
1.605 + {
1.606 + iBackupSession->RestartApps();
1.607 + }
1.608 +
1.609 +/**
1.610 + Close or reduce use of aFileName depending on the state of aFlags.
1.611 +
1.612 + @param aFileName the name of the file to be closed / changed the file lock state.
1.613 + @param aFlag the file lock state to change to.
1.614 + @leave KErrNoMemory if not enough memory to signal the files to close. KErrServerIsBusy if another client
1.615 + has some files being closed.
1.616 + @publishedPartner
1.617 + @released
1.618 + @capability WriteDeviceData
1.619 + */
1.620 +EXPORT_C void CBaBackupSessionWrapper::CloseFileL(const TDesC& aFileName,MBackupObserver::TFileLockFlags aFlags)
1.621 + {
1.622 + User::LeaveIfError(iBackupSession->CloseFile(aFileName,aFlags));
1.623 + }
1.624 +
1.625 +/**
1.626 + * Opposite of CloseFileL. Can be safely called if CloseFileL hasn't been called before
1.627 + *
1.628 + * @publishedPartner
1.629 + * @released
1.630 + * @capability WriteDeviceData
1.631 + */
1.632 +EXPORT_C void CBaBackupSessionWrapper::RestartFile(const TDesC& aFileName)
1.633 + {
1.634 + iBackupSession->RestartFile(aFileName);
1.635 + }
1.636 +
1.637 +CBaBackupSessionWrapper::CBaBackupSessionWrapper()
1.638 + {}
1.639 +
1.640 +void CBaBackupSessionWrapper::ConstructL()
1.641 + {
1.642 + iBackupSession=new(ELeave) RBaBackupSession();
1.643 + User::LeaveIfError(iBackupSession->Connect());
1.644 + }
1.645 +
1.646 +
1.647 +/**
1.648 + * Registers the observer aBackupOperationObserver for getting notifications whether a backup or
1.649 + * restore operation starts or ends.
1.650 + *
1.651 + * @since App-Framework_6.2
1.652 + */
1.653 +EXPORT_C void CBaBackupSessionWrapper::RegisterBackupOperationObserverL(MBackupOperationObserver& aBackupOperationObserver)
1.654 + {
1.655 + if (!iBackupOperationNotifier)
1.656 + {
1.657 + iBackupOperationNotifier=CBaBackupOperationNotifier::NewL(*iBackupSession);
1.658 + }
1.659 + iBackupOperationNotifier->AddBackupOperationObserverL(aBackupOperationObserver);
1.660 + }
1.661 +
1.662 +/**
1.663 + * De-registers the observer aBackupOperationObserver for getting notifications whether a backup or
1.664 + * restore operation starts or ends.
1.665 + *
1.666 + * @since App-Framework_6.2
1.667 + */
1.668 +EXPORT_C void CBaBackupSessionWrapper::DeRegisterBackupOperationObserver(MBackupOperationObserver& aBackupOperationObserver)
1.669 + {
1.670 + if (iBackupOperationNotifier)
1.671 + {
1.672 + iBackupOperationNotifier->RemoveBackupOperationObserver(aBackupOperationObserver);
1.673 + }
1.674 + }
1.675 +
1.676 +/**
1.677 + * Returns ETrue when either a backup or restore operation is running, otherwise it retunrs EFalse.
1.678 + *
1.679 + * @since App-Framework_6.2
1.680 + */
1.681 +EXPORT_C TBool CBaBackupSessionWrapper::IsBackupOperationRunning() const
1.682 + {
1.683 + return iBackupSession->IsBackupOperationRunning();
1.684 + }
1.685 +
1.686 +/**
1.687 + * Notifies the server that a backup operation is going to happen.
1.688 + *
1.689 + * @since App-Framework_6.2
1.690 + * @publishedPartner
1.691 + * @released
1.692 + * @capability WriteDeviceData
1.693 + */
1.694 +EXPORT_C void CBaBackupSessionWrapper::NotifyBackupOperationL(const TBackupOperationAttributes& aBackupOperationAttributes)
1.695 + {
1.696 + iBackupSession->NotifyBackupOperation(aBackupOperationAttributes);
1.697 + }
1.698 +
1.699 +
1.700 +EXPORT_C void MBackupOperationObserver::Reserved1()
1.701 + {
1.702 + }