1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/dbms/SPConv/cn_util.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,318 @@
1.4 +// Copyright (c) 2004-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 +// TSPConvUtil class
1.18 +//
1.19 +//
1.20 +
1.21 +#include <f32file.h>
1.22 +#include <e32cons.h>
1.23 +#include "D32Assert.h"
1.24 +#include "cn_util.h"
1.25 +#include "cn_main.h"
1.26 +#include "cn_cmdparse.h"
1.27 +
1.28 +TBool TSPConvUtil::iPromptOnError = ETrue;
1.29 +
1.30 +_LIT(KTxt0, "Program information");
1.31 +_LIT(KTxt1, "EDbSpConv version 1.0\n");
1.32 +_LIT(KTxt2, "Symbian OS text policy file/binary policy file converter\n");
1.33 +_LIT(KTxt3, "Copyright (c) 2004 Symbian Software Ltd. All rights reserved.\n");
1.34 +_LIT(KTxt4, "\nUsage:\n");
1.35 +_LIT(KTxt5, "EDbSpConv /h\n");
1.36 +_LIT(KTxt6, "EDbSpConv /f=<text file> /b=[path]\\<uid>[.spd] [/s]\n");
1.37 +_LIT(KTxt7, "\nWhere:\n");
1.38 +_LIT(KTxt8, "/h - displays program information\n");
1.39 +_LIT(KTxt9, "<text file> - security policy text file, including path\n");
1.40 +_LIT(KTxt10,"<uid>[.spd] - security policy binary file\n");
1.41 +_LIT(KTxt11,"[path] - optional - binary policy file path.\n");
1.42 +_LIT(KTxt12," By default the file will be placed in the current directory.\n");
1.43 +_LIT(KTxt13,"<uid> - database format uid - hex\n");
1.44 +_LIT(KTxt14,"[/s] - optional - does not wait for a button pressing in case\n");
1.45 +_LIT(KTxt15," of an error (when an error message is displayed).\n");
1.46 +
1.47 +/**
1.48 +Prints program information.
1.49 +*/
1.50 +static void PrintInfoL()
1.51 + {
1.52 + CConsoleBase* con = Console::NewL(KTxt0, TSize(KConsFullScreen, KConsFullScreen));
1.53 + CleanupStack::PushL(con);
1.54 + con->Printf(KTxt1);
1.55 + con->Printf(KTxt2);
1.56 + con->Printf(KTxt3);
1.57 + con->Printf(KTxt4);
1.58 + con->Printf(KTxt5);
1.59 + con->Printf(KTxt6);
1.60 + con->Printf(KTxt7);
1.61 + con->Printf(KTxt8);
1.62 + con->Printf(KTxt9);
1.63 + con->Printf(KTxt10);
1.64 + con->Printf(KTxt11);
1.65 + con->Printf(KTxt12);
1.66 + con->Printf(KTxt13);
1.67 + con->Printf(KTxt14);
1.68 + con->Printf(KTxt15);
1.69 + con->Getch();
1.70 + CleanupStack::PopAndDestroy(con);
1.71 + }
1.72 +
1.73 +/**
1.74 +Parses command line arguments and fills TCmdLinePrm structure with the parsed data.
1.75 +A a result of method's execution, the following items will be stored in aCmdLinePrm:
1.76 +requested action: (BIN->TXT) or (TXT->BIN), text policy file path and
1.77 +binary policy file path.
1.78 +If there is a "/s" command line argument and there are parsing errors, the error message
1.79 +will be stored in epocwind.out file only. By default (no "/s" command) the error messages
1.80 +will be displayed on the screen and stored in epocwind.out file.
1.81 +@param aCmdLineParser A reference to a command line argument parser instance.
1.82 +@param aCmdLinePrm A reference to a TCmdLinePrm instance. Output parameter. The parsed
1.83 + command line arguments will be stored there.
1.84 +@leave KErrArgument Not enough command line arguments, bad argument, non-recognizable argument.
1.85 +@leave KErrNotFound Missing command line argument.
1.86 +*/
1.87 +void TSPConvUtil::ParseL(const CCommandLineArguments& aCmdLineParser,
1.88 + TCmdLinePrm& aCmdLinePrm)
1.89 + {
1.90 + aCmdLinePrm.Zero();
1.91 + TInt prmCnt = aCmdLineParser.Count();
1.92 + if(prmCnt < 2)
1.93 + {//Print program information and exit
1.94 + ::PrintInfoL();
1.95 + User::Exit(KErrNone);
1.96 + }
1.97 + else
1.98 + {
1.99 + //The comand is fixed explicitly, because now there is only one conversion:
1.100 + //from text policy file to binary policy file.
1.101 + aCmdLinePrm.iAction = TCmdLinePrm::ETxt2Bin;
1.102 + for(TInt i=0;i<prmCnt;++i)
1.103 + {
1.104 + TPtrC arg = aCmdLineParser.Arg(i);
1.105 + _LIT(KPrintInfoCmd, "/H");
1.106 + _LIT(KSuppressPromptCmd, "/S");
1.107 + _LIT(KTextFilePrm, "/F=");
1.108 + _LIT(KBinFilePrm, "/B=");
1.109 + TInt pos;
1.110 + if(arg == KPrintInfoCmd)
1.111 + {//Print program information and exit
1.112 + ::PrintInfoL();
1.113 + User::Exit(KErrNone);
1.114 + }
1.115 + else if(arg == KSuppressPromptCmd)
1.116 + {
1.117 + TSPConvUtil::iPromptOnError = EFalse;
1.118 + }
1.119 + if((pos = arg.Find(KTextFilePrm)) != KErrNotFound)
1.120 + {
1.121 + if(pos != 0)
1.122 + {
1.123 + __LEAVE(KErrArgument);
1.124 + }
1.125 + aCmdLinePrm.iTxtFile.Copy(arg.Right(arg.Length() - KTextFilePrm().Length()));
1.126 + }
1.127 + else if((pos = arg.Find(KBinFilePrm)) != KErrNotFound)
1.128 + {
1.129 + if(pos != 0)
1.130 + {
1.131 + __LEAVE(KErrArgument);
1.132 + }
1.133 + aCmdLinePrm.iBinFile.Copy(arg.Right(arg.Length() - KBinFilePrm().Length()));
1.134 + }
1.135 + }//end of - for(TInt i=0;i<prmCnt;++i)
1.136 + }//end of else - if(prmCnt < 2)
1.137 + if(aCmdLinePrm.iAction == TCmdLinePrm::ENone)
1.138 + {
1.139 + _LIT(KText, "Invalid command line arguments, use \"/h\" option for help\n");
1.140 + TSPConvUtil::Print(KText);
1.141 + __LEAVE(KErrArgument);
1.142 + }
1.143 + if(aCmdLinePrm.iTxtFile.Length() == 0)
1.144 + {
1.145 + _LIT(KText, "No text file, use \"/h\" option for help\n");
1.146 + TSPConvUtil::Print(KText);
1.147 + __LEAVE(KErrArgument);
1.148 + }
1.149 + if(aCmdLinePrm.iBinFile.Length() == 0)
1.150 + {
1.151 + _LIT(KText, "No UID, use \"/h\" option for help\n");
1.152 + TSPConvUtil::Print(KText);
1.153 + __LEAVE(KErrArgument);
1.154 + }
1.155 + }
1.156 +
1.157 +/**
1.158 +The method checks if the file path (aFile parameter) exists.
1.159 +@param aFs File server session.
1.160 +@param aFile File path.
1.161 +@return ETrue - file exists, EFalse - file not found. EFalse may also reflect some kind of
1.162 + file system error.
1.163 +*/
1.164 +TBool TSPConvUtil::FileExists(RFs& aFs, const TDesC& aFile)
1.165 + {
1.166 + TEntry fileEntry;
1.167 + return aFs.Entry(aFile, fileEntry) == KErrNone;
1.168 + }
1.169 +
1.170 +/**
1.171 +The method checks and constructs full binary policy file path from aFile parameter.
1.172 +@param aFile The expected format is:
1.173 + 1) <drive:>\<path>\<UID string>
1.174 + 2) <drive:>\<path>\<UID string>.spd
1.175 + 3) <UID string>
1.176 + 4) <UID string>.spd
1.177 + '/' symbol might be used as a directory separator as well.
1.178 + Output parameter - the created binary policy file path will be stored there.
1.179 +@leave KErrArgument Bad format of aFile input parameter.
1.180 +*/
1.181 +void TSPConvUtil::ConstructBinFileNameL(TDes& aFile)
1.182 + {
1.183 + //Replace all '/' in aFile with '\', otherwise TParse won't work properly.
1.184 + TInt pos;
1.185 + while((pos = aFile.Locate('/')) != KErrNotFound)
1.186 + {
1.187 + aFile[pos] = '\\';
1.188 + }
1.189 + TParse fileNameParser;
1.190 + __LEAVE_IF_ERROR(fileNameParser.Set(aFile, NULL, NULL));
1.191 + TPtrC fileName = fileNameParser.Name();
1.192 + TUid dbUid;
1.193 + TLex lex(fileName);
1.194 + if(lex.Val(*(TUint32*)&dbUid, EHex) == KErrNone && lex.Eos())
1.195 + {
1.196 + if(dbUid != KNullUid)
1.197 + {
1.198 + _LIT(KExt, ".SPD");
1.199 + TPtrC fileExt = fileNameParser.Ext();
1.200 + if(fileExt.Length() == 0)
1.201 + {
1.202 + aFile.Append(KExt);
1.203 + }
1.204 + else if(fileExt != KExt)
1.205 + {
1.206 + _LIT(KText, "Invalid \"UID\" file extension: \"%S\"\n");
1.207 + TSPConvUtil::Print(KText, fileExt);
1.208 + __LEAVE(KErrArgument);
1.209 + }
1.210 + return;
1.211 + }
1.212 + }
1.213 + _LIT(KText, "Invalid \"UID\" file: \"%S\"\n");
1.214 + TSPConvUtil::Print(KText, aFile);
1.215 + __LEAVE(KErrArgument);
1.216 + }
1.217 +
1.218 +/**
1.219 +The method extracts the UID from aFile parameter, which is expected to represent
1.220 +binary security policy file path.
1.221 +The method asserts that the extracted UID is not KNullUid.
1.222 +@param aFile Binary policy file path
1.223 +@leave System-wide error codes from file name parsing or KErrNoMemory (from the parser creation).
1.224 +*/
1.225 +TUid TSPConvUtil::UidFromFileNameL(const TDesC& aFile)
1.226 + {
1.227 + TParse* parser = new (ELeave) TParse;
1.228 + CleanupStack::PushL(parser);
1.229 + __LEAVE_IF_ERROR(parser->Set(aFile, NULL, NULL));
1.230 + TPtrC fileName = parser->Name();
1.231 + TUid domainUid;
1.232 + TLex lex(fileName);
1.233 + if(lex.Val(*(TUint32*)&domainUid, EHex) == KErrNone && lex.Eos() && domainUid != KNullUid)
1.234 + {
1.235 + }
1.236 + CleanupStack::PopAndDestroy(parser);
1.237 + __ASSERT(domainUid != KNullUid);
1.238 + return domainUid;
1.239 + }
1.240 +
1.241 +/**
1.242 +The method prints aText string to epocwnd.out file and on the screen and waits for
1.243 +a button pressing.
1.244 +If "/s" command line argument is presented, the method won't wait for a button pressing.
1.245 +@param aText The text which has to be printed.
1.246 +*/
1.247 +void TSPConvUtil::Print(const TDesC& aText)
1.248 + {
1.249 + RDebug::Print(aText);
1.250 + if(TSPConvUtil::iPromptOnError)
1.251 + {
1.252 + RNotifier notify;
1.253 + TInt err = notify.Connect();
1.254 + if(err == KErrNone)
1.255 + {
1.256 + TRequestStatus stat;
1.257 + TInt but;
1.258 + _LIT(KNotify,"EDBSPConv");
1.259 + _LIT(KContinue,"Continue");
1.260 + notify.Notify(KNotify, aText, KContinue, KNullDesC, but, stat);
1.261 + User::WaitForRequest(stat);
1.262 + notify.Close();
1.263 + }
1.264 + else
1.265 + {
1.266 + RDebug::Print(_L("Error=%d connecting notifier session!\n"), err);
1.267 + }
1.268 + }
1.269 + User::InfoPrint(aText);
1.270 + }
1.271 +
1.272 +/**
1.273 +The method outputs a formatted text to epocwnd.out file and on the screen using aFormat
1.274 +parameter as a format string and aNumber as a number which has to be printed out with
1.275 +the supplied format string.
1.276 +If "/s" command line argument is presented, the method won't wait for a button pressing.
1.277 +@param aFormat The number format string.
1.278 +@param aNumber The number, which has to be printed together with the text. There must be a "%d"
1.279 + format specification somewhere in aFormat parameter.
1.280 +*/
1.281 +void TSPConvUtil::Print(const TDesC& aFormat, TInt aNumber)
1.282 + {
1.283 + TBuf<300> buf;
1.284 + buf.Format(aFormat, aNumber);
1.285 + TSPConvUtil::Print(buf);
1.286 + }
1.287 +
1.288 +/**
1.289 +The method outputs a formatted text to epocwnd.out file and on the screen using aFormat
1.290 +parameter as a format string and aText as a text which has to be printed out with the
1.291 +supplied format string.
1.292 +If "/s" command line argument is presented, the method won't wait for a button pressing.
1.293 +@param aFormat The number format string.
1.294 +@param aText The text, which has to be formatted. There must be a "%S"
1.295 + format specification somewhere in aFormat parameter.
1.296 +*/
1.297 +void TSPConvUtil::Print(const TDesC& aFormat, const TDesC& aText)
1.298 + {
1.299 + TBuf<300> buf;
1.300 + buf.Format(aFormat, &aText);
1.301 + TSPConvUtil::Print(buf);
1.302 + }
1.303 +
1.304 +/**
1.305 +The method outputs a formatted text to epocwnd.out file and on the screen using aFormat
1.306 +parameter as a format string and aText1 and aText2 as texts which have to be printed
1.307 +out with the supplied format string.
1.308 +If "/s" command line argument is presented, the method won't wait for a button pressing.
1.309 +@param aFormat The number format string.
1.310 +@param aText1 The text, which has to be printed out. There must be a "%S"
1.311 + format specification somewhere in aFormat parameter.
1.312 +@param aText2 The text, which has to be printed out. There must be a "%S"
1.313 + format specification somewhere in aFormat parameter.
1.314 +*/
1.315 +void TSPConvUtil::Print(const TDesC& aFormat, const TDesC& aText1, const TDesC& aText2)
1.316 + {
1.317 + TBuf<500> buf;
1.318 + buf.Format(aFormat, &aText1, &aText2);
1.319 + TSPConvUtil::Print(buf);
1.320 + }
1.321 +