FCL/sf/mw/qtextensions: comparison qtmobility/plugins/contacts/symbiansim/src/cntsimstoreprivate.cpp

equal deleted inserted replaced

-:06b8e2af4411
+:6fbed849b4f4
 CntSimStorePrivate::CntSimStorePrivate(CntSymbianSimEngine &engine, CntSimStore &simStore, const QString &storeName)
 :CActive(CActive::EPriorityStandard),
 m_state(InactiveState),
 m_engine(engine),
 m_simStore(simStore),
-m_storeName(storeName),
+m_listener(0),
-m_readOnlyAccess(false),
+m_extraDetailsChecked(false)
-m_storeInfoPckg(m_storeInfo),
-m_listener(0)
 {
 CActiveScheduler::Add(this);
 m_managerUri = engine.managerUri();
+// Initialize store info
+m_storeInfo.m_storeName                 = storeName;
+m_storeInfo.m_totalEntries              = -1;
+m_storeInfo.m_usedEntries               = -1;
+m_storeInfo.m_readOnlyAccess            = false;
+m_storeInfo.m_numberSupported           = true; // allways supported
+m_storeInfo.m_nameSupported             = true; // allways supported
+m_storeInfo.m_secondNameSupported       = false;
+m_storeInfo.m_additionalNumberSupported = false;
+m_storeInfo.m_emailSupported            = false;
+// SDN store is allways read only
+if (m_storeInfo.m_storeName == KParameterValueSimStoreNameSdn)
+m_storeInfo.m_readOnlyAccess = true;
 }
 void CntSimStorePrivate::ConstructL()
 {
 TBuf<RMobilePhoneBookStore::KMaxPBIDSize> storeName;
 convertStoreNameL(storeName);
-// SDN store is always read only
-if (m_storeName == KParameterValueSimStoreNameSdn)
-m_readOnlyAccess = true;
 // Open etel server
 User::LeaveIfError(m_etelServer.Connect());
 User::LeaveIfError(m_etelServer.LoadPhoneModule(KMmTsyModuleName));
 // Open etel phone
 RTelServer::TPhoneInfo info;
 User::LeaveIfError(m_etelServer.GetPhoneInfo(0, info));
 User::LeaveIfError(m_etelPhone.Open(m_etelServer, info.iName));
-// open Etel store
+// Open Etel store
 User::LeaveIfError(m_etelStore.Open(m_etelPhone, storeName));
-//check what information can be saved to the Etel store
+// Update store info
-TRequestStatus requestStatus;
+updateStoreInfoL();
-m_etelStore.GetInfo(requestStatus, (TDes8&)m_storeInfoPckg);
-User::WaitForRequest(requestStatus);
+// Start listening for events
-PbkPrintToLog(_L("CntSymbianSimEngine::getEtelStoreInfoL() - GetInfo err = %d"),
-requestStatus.Int());
-User::LeaveIfError(requestStatus.Int());
-PbkPrintToLog(_L("CntSymbianSimEngine::getEtelStoreInfoL() - TotalEntries = %d"),
-m_storeInfo.iTotalEntries);
-PbkPrintToLog(_L("CntSymbianSimEngine::getEtelStoreInfoL() - UsedEntries = %d"),
-m_storeInfo.iUsedEntries);
-PbkPrintToLog(_L("CntSymbianSimEngine::getEtelStoreInfoL() - MaxNumLength = %d"),
-m_storeInfo.iMaxNumLength);
-PbkPrintToLog(_L("CntSymbianSimEngine::getEtelStoreInfoL() - MaxTextLength = %d"),
-m_storeInfo.iMaxTextLength);
 m_listener = new (ELeave) CntSimStoreEventListener(m_engine, m_etelStore);
 m_listener->start();
 }
 CntSimStorePrivate::~CntSimStorePrivate()
 {
 if(storeName.MaxLength() < RMobilePhoneBookStore::KMaxPBIDSize) {
 User::Leave(KErrArgument);
 }
-if (m_storeName.isEmpty()) {
+if (m_storeInfo.m_storeName.isEmpty()) {
 // Default to ADN store
-m_storeName = (QLatin1String) KParameterValueSimStoreNameAdn;
+m_storeInfo.m_storeName = (QLatin1String) KParameterValueSimStoreNameAdn;
 storeName.Copy(KETelIccAdnPhoneBook);
-} else if (m_storeName == KParameterValueSimStoreNameFdn) {
+} else if (m_storeInfo.m_storeName == KParameterValueSimStoreNameFdn) {
 storeName.Copy(KETelIccFdnPhoneBook);
-} else if (m_storeName == KParameterValueSimStoreNameAdn) {
+} else if (m_storeInfo.m_storeName == KParameterValueSimStoreNameAdn) {
 storeName.Copy(KETelIccAdnPhoneBook);
-} else if (m_storeName == KParameterValueSimStoreNameSdn) {
+} else if (m_storeInfo.m_storeName == KParameterValueSimStoreNameSdn) {
 storeName.Copy(KETelIccSdnPhoneBook);
 }
 // Check that we got a valid store name
 if(storeName.Length() == 0) {
 return false;
 }
 // start reading
 m_buffer.Zero();
-m_buffer.ReAlloc(KOneSimContactBufferSize*m_storeInfo.iTotalEntries);
+m_buffer.ReAlloc(KOneSimContactBufferSize*m_storeInfo.m_totalEntries);
-m_etelStore.Read(iStatus, 1, m_storeInfo.iTotalEntries, m_buffer);
+m_etelStore.Read(iStatus, 1, m_storeInfo.m_totalEntries, m_buffer);
 SetActive();
 m_state = ReadReservedSlotsState;
 *error = QContactManager::NoError;
 return true;
 {
 case ReadState:
 {
 QList<QContact> contacts = decodeSimContactsL(m_buffer);
-// set sync target and set type as read only
+// set sync target and read only access constraint and display label
 QList<QContact>::iterator i;
 for (i = contacts.begin(); i != contacts.end(); ++i) {
 QContactSyncTarget syncTarget;
 syncTarget.setSyncTarget(KSimSyncTarget);
 m_engine.setReadOnlyAccessConstraint(&syncTarget);
 i->saveDetail(&syncTarget);
 QContactType contactType = i->detail(QContactType::DefinitionName);
 m_engine.setReadOnlyAccessConstraint(&contactType);
 i->saveDetail(&contactType);
+m_engine.updateDisplayLabel(*i);
 }
 emit m_simStore.readComplete(contacts, QContactManager::NoError);
 }
 break;
 QContactPhoneNumber lastNumber = static_cast<QContactPhoneNumber>(
 phoneNumbers.at(phoneNumbers.count() - 1));
 QString number = lastNumber.number();
 number.insert(0, "+");
 lastNumber.setNumber(number);
-if (m_readOnlyAccess)
+if (m_storeInfo.m_readOnlyAccess)
 m_engine.setReadOnlyAccessConstraint(&lastNumber);
 currentContact.saveDetail(&lastNumber);
 }
 }
 }
 else {
 // Contact name otherwise
 QContactName name;
 QString nameString = QString::fromUtf16(bufPtr.Ptr(), bufPtr.Length());
 name.setCustomLabel(nameString);
-if (m_readOnlyAccess)
+if (m_storeInfo.m_readOnlyAccess)
 m_engine.setReadOnlyAccessConstraint(&name);
 currentContact.saveDetail(&name);
 QContactManager::Error error(QContactManager::NoError);
 m_engine.setContactDisplayLabel(&currentContact, m_engine.synthesizedDisplayLabel(currentContact, &error));
 }
 {
 if (pbBuffer->GetValue(bufPtr) == KErrNone) {
 QContactNickname nickName;
 QString name = QString::fromUtf16(bufPtr.Ptr(), bufPtr.Length());
 nickName.setNickname(name);
-if (m_readOnlyAccess)
+if (m_storeInfo.m_readOnlyAccess)
 m_engine.setReadOnlyAccessConstraint(&nickName);
 currentContact.saveDetail(&nickName);
 }
 break;
 }
 {
 if (pbBuffer->GetValue(bufPtr) == KErrNone) {
 QContactPhoneNumber phoneNumber;
 QString number = QString::fromUtf16(bufPtr.Ptr(), bufPtr.Length());
 phoneNumber.setNumber(number);
-if (m_readOnlyAccess)
+if (m_storeInfo.m_readOnlyAccess)
 m_engine.setReadOnlyAccessConstraint(&phoneNumber);
 currentContact.saveDetail(&phoneNumber);
 }
 break;
 }
 {
 if (pbBuffer->GetValue(bufPtr) == KErrNone) {
 QContactEmailAddress email;
 QString emailAddress = QString::fromUtf16(bufPtr.Ptr(), bufPtr.Length());
 email.setEmailAddress(emailAddress);
-if (m_readOnlyAccess)
+if (m_storeInfo.m_readOnlyAccess)
 m_engine.setReadOnlyAccessConstraint(&email);
 currentContact.saveDetail(&email);
 }
 break;
 }
 * \param contact QContact to be converted
 * \param rawData Contact in TLV format on return.
 */
 void CntSimStorePrivate::encodeSimContactL(QContact* contact, TDes8& rawData) const
 {
-// TODO: get detail definition schema and verify (unique)
 // Keep track of the count of phone numbers added
 int phoneNumberCount(0);
-int emailCount(0);
+// Create buffer
 CPhoneBookBuffer* pbBuffer = new(ELeave) CPhoneBookBuffer();
 CleanupStack::PushL(pbBuffer);
 pbBuffer->Set(&rawData);
 User::LeaveIfError(pbBuffer->AddNewEntryTag());
-foreach(QContactDetail detail, contact->details()) {
+// Loop through details
+foreach(QContactDetail detail, contact->details())
+{
 QString definitionName = detail.definitionName();
-if (definitionName == QContactName::DefinitionName) {
+// NOTE: If the detail is too long let the etel store return
-// Name
+// an error about it. We could check the maximum lenghts for each
+// detail but then we would need to read it before every write operation
+// bacause it seems to change depending on how full the sim card is.
+// Name
+if (definitionName == QContactName::DefinitionName)
+{
 QContactName nameDetail = static_cast<QContactName>(detail);
-// Trim to the max possible length
+QString name = nameDetail.customLabel();
-QString name = nameDetail.customLabel().left(m_storeInfo.iMaxTextLength);
+putTagAndValueL(pbBuffer, RMobilePhoneBookStore::ETagPBText, name);
-if (name.isEmpty()) {
+}
-name = "Unnamed";
+// Phone number
-}
+else if (definitionName == QContactPhoneNumber::DefinitionName)
-putTagAndValueL(
+{
-pbBuffer,
+if (m_storeInfo.m_additionalNumberSupported == false && phoneNumberCount>0)
-RMobilePhoneBookStore::ETagPBText,
+User::Leave(KErrNotSupported);
-name);
-// Replace detail value with the trimmed one
-nameDetail.setCustomLabel(name);
-contact->saveDetail(&nameDetail);
-} else if (definitionName == QContactPhoneNumber::DefinitionName
-#ifndef SYMBIANSIM_BACKEND_PHONEBOOKINFOV1
-&& (phoneNumberCount == 0
-|| phoneNumberCount <= m_storeInfo.iMaxAdditionalNumbers)) {
-#else
-&& phoneNumberCount == 0) {
-#endif
-// Phone number
 phoneNumberCount++;
-QContactPhoneNumber numberDetail = static_cast<QContactPhoneNumber>(detail);
+QString number = static_cast<QContactPhoneNumber>(detail).number();
-QString number = numberDetail.number();
+if (number.isEmpty())
+continue;
 // Verify the number only contains legal digits
 foreach (const QChar character, number) {
 if(!character.isDigit()) {
 if(character != QChar('+')
 User::Leave(KErrArgument);
 }
 }
 }
-// TODO: check if the number is empty (do we have a test case for that?)
-// Verify the number length
-PbkPrintToLog(_L("CntSymbianSimEngine::encodeSimContactL() - phone number length = %d"),
-numberDetail.number().length());
-if (numberDetail.number().length() > m_storeInfo.iMaxNumLength) {
-User::Leave(KErrTooBig);
-}
 if (phoneNumberCount > 1) {
 // Mark the beginning of an additional number
 User::LeaveIfError(pbBuffer->AddNewNumberTag());
 }
 // The number itself
-putTagAndValueL(
+putTagAndValueL(pbBuffer, RMobilePhoneBookStore::ETagPBNumber, number);
-pbBuffer,
+}
-RMobilePhoneBookStore::ETagPBNumber,
+// Nickname
-number);
+else if (definitionName == QContactNickname::DefinitionName)
-#ifndef SYMBIANSIM_BACKEND_PHONEBOOKINFOV1
+{
-// Phonebook info version 1 does not support nick name or e-mail
+if (m_storeInfo.m_secondNameSupported == false)
-} else if (definitionName == QContactNickname::DefinitionName
+User::Leave(KErrNotSupported);
-&& m_storeInfo.iMaxSecondNames > 0) {
-// nickname
+QString nickname = static_cast<QContactNickname>(detail).nickname();
-QContactNickname nicknameDetail = static_cast<QContactNickname>(detail);
+if (nickname.isEmpty())
-// Trim to the max possible length;
+continue;
-QString nickname = nicknameDetail.nickname().left(m_storeInfo.iMaxTextLengthSecondName);
-putTagAndValueL(
+putTagAndValueL(pbBuffer, RMobilePhoneBookStore::ETagPBSecondName, nickname);
-pbBuffer,
+}
-RMobilePhoneBookStore::ETagPBSecondName,
+// email
-nickname);
+else if (definitionName == QContactEmailAddress::DefinitionName)
-// Replace detail value with the trimmed one
+{
-nicknameDetail.setNickname(nickname);
+if (m_storeInfo.m_emailSupported == false)
-contact->saveDetail(&nicknameDetail);
+User::Leave(KErrNotSupported);
-} else if (definitionName == QContactEmailAddress::DefinitionName
-&& emailCount < m_storeInfo.iMaxEmailAddr) {
+QString email = static_cast<QContactEmailAddress>(detail).emailAddress();
-emailCount++;
+if (email.isEmpty())
-QContactEmailAddress emailDetail = static_cast<QContactEmailAddress>(detail);
+continue;
-if (emailDetail.emailAddress().length() > m_storeInfo.iMaxTextLengthEmailAddr) {
-User::Leave(KErrTooBig);
+putTagAndValueL(pbBuffer, RMobilePhoneBookStore::ETagPBEmailAddress, email);
 }
-putTagAndValueL(
-pbBuffer,
-RMobilePhoneBookStore::ETagPBEmailAddress,
-emailDetail.emailAddress());
-#endif
 // These are ignored in the conversion
-} else if (definitionName == QContactSyncTarget::DefinitionName
+else if (definitionName == QContactSyncTarget::DefinitionName
 || definitionName == QContactDisplayLabel::DefinitionName
-|| definitionName == QContactType::DefinitionName) {
+|| definitionName == QContactType::DefinitionName)
+{
 // Do nothing
-} else {
+}
+else
+{
+// Unknown detail
 User::Leave(KErrArgument);
 }
 }
 CleanupStack::PopAndDestroy(pbBuffer);
 }
 } //while
 CleanupStack::PopAndDestroy(pbBuffer);
 return reservedSlots;
 }
+void CntSimStorePrivate::writeL(QContact *contact)
+{
+if (IsActive())
+User::Leave(KErrLocked);
+// get index
+int index = KErrNotFound;
+if (contact->id().managerUri() == m_managerUri &&
+contact->localId() > 0) {
+index = contact->localId();
+}
+// encode
+m_buffer.Zero();
+m_buffer.ReAlloc(KOneSimContactBufferSize);
+encodeSimContactL(contact, m_buffer);
+// write
+TRequestStatus status;
+m_etelStore.Write(status, m_buffer, index);
+User::WaitForRequest(status);
+User::LeaveIfError(status.Int());
+// update id
+QContactId id;
+id.setLocalId(index);
+id.setManagerUri(m_managerUri);
+contact->setId(id);
+}
+void CntSimStorePrivate::removeL(int index)
+{
+if (IsActive())
+User::Leave(KErrLocked);
+// NOTE:
+// If index points to an empty slot and running in hardware the
+// delete operation will not return any error.
+TRequestStatus status;
+m_etelStore.Delete(status, index);
+User::WaitForRequest(status);
+User::LeaveIfError(status.Int());
+}
+void CntSimStorePrivate::updateStoreInfoL()
+{
+#ifdef SYMBIANSIM_BACKEND_PHONEBOOKINFOV1
+RMobilePhoneBookStore::TMobilePhoneBookInfoV1 info;
+RMobilePhoneBookStore::TMobilePhoneBookInfoV1Pckg infoPckg(info);
+#else
+RMobilePhoneBookStore::TMobilePhoneBookInfoV5 info;
+RMobilePhoneBookStore::TMobilePhoneBookInfoV5Pckg infoPckg(info);
+#endif
+// Get info
+TRequestStatus status;
+m_etelStore.GetInfo(status, infoPckg);
+User::WaitForRequest(status);
+User::LeaveIfError(status.Int());
+// Update entry counts
+m_storeInfo.m_totalEntries = info.iTotalEntries;
+m_storeInfo.m_usedEntries  = info.iUsedEntries;
+#ifdef SYMBIANSIM_BACKEND_TEST_EXTRADETAILS
+// Check if store supports the extra details
+//
+// NOTE:
+// We cannot rely on TMobilePhoneBookInfoV5 to check if we support
+// these details. For example iMaxSecondNames is allways -1 even if the sim
+// card supports a second name.
+//
+// There is an API for checking these but it's Nokia internal so we must
+// do it this way - by checking if saving these details is possible.
+// Have we checked these already?
+if (m_extraDetailsChecked == false)
+{
+// Cannot test extra details if sim card is full
+if (m_storeInfo.m_usedEntries == m_storeInfo.m_totalEntries)
+return;
+// Cancel store event listener temporarily
+if (m_listener)
+m_listener->Cancel();
+// Test writing nickname
+QContact contact;
+QContactNickname nick;
+nick.setNickname("simbackend test");
+contact.saveDetail(&nick);
+TRAPD(err, {
+m_storeInfo.m_secondNameSupported = true; // enable to pass encodeSimContactL()
+writeL(&contact);
+removeL(contact.localId());
+} );
+if (err)
+m_storeInfo.m_secondNameSupported = false;
+// Test writing additional number
+contact = QContact();
+QContactPhoneNumber num1;
+num1.setNumber("1111111111");
+contact.saveDetail(&num1);
+QContactPhoneNumber num2;
+num2.setNumber("2222222222");
+contact.saveDetail(&num2);
+TRAP(err, {
+m_storeInfo.m_additionalNumberSupported = true; // enable to pass encodeSimContactL()
+writeL(&contact);
+removeL(contact.localId());
+} );
+if (err)
+m_storeInfo.m_additionalNumberSupported = false;
+// Test writing email
+contact = QContact();
+QContactEmailAddress email;
+email.setEmailAddress("simbackend@test.com");
+contact.saveDetail(&email);
+TRAP(err, {
+m_storeInfo.m_emailSupported = true; // enable to pass encodeSimContactL()
+writeL(&contact);
+removeL(contact.localId());
+} );
+if (err)
+m_storeInfo.m_emailSupported = false;
+// Start store event listener again
+if (m_listener)
+m_listener->start();
+m_extraDetailsChecked = true;
+}
+#endif
+/*
+qDebug() << "Store info:"
+<< "\nStore name                :" << m_storeInfo.m_storeName
+<< "\nTotal entries             :" << m_storeInfo.m_totalEntries
+<< "\nUsed entries              :" << m_storeInfo.m_usedEntries
+<< "\nRead only access          :" << m_storeInfo.m_readOnlyAccess
+<< "\nNumber supported          :" << m_storeInfo.m_numberSupported
+<< "\nName supported            :" << m_storeInfo.m_nameSupported
+<< "\nSecond name supported     :" << m_storeInfo.m_secondNameSupported
+<< "\nAdditional name supported :" << m_storeInfo.m_additionalNumberSupported
+<< "\nEmail supported           :" << m_storeInfo.m_emailSupported;
+*/
+}

changeset 14	6fbed849b4f4
parent 5	453da2cfceef