summaryrefslogtreecommitdiffstats
path: root/plugins/versit/symbian/versitplugins/cntversitlandlineplugin/src/cntversitlandlineplugin.cpp
blob: 3b03d5110e0ece5cfee4e179928bdbe3f31a3975 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Mobility Components.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "qtcontacts.h"
#include "qversitproperty.h"
#include "cntversitlandlineplugin.h"


/*!
    \class CntVersitLandlinePlugin
    \brief Implements the QVersitContactHandler interface for custom handling of 
    phone numbers with subtype QContactPhoneNumber::SubTypeLandline during import\export 
    of versit documents like vCards. 
  
    This plugin maps QContactPhoneNumber::SubTypeLandline to vCard type "VOICE". 

    \sa CntVersitLandlinePluginFactory
    
    
    IMPORT:
           Simply replace all subtypes QContactPhoneNumber::SubTypeVoice 
           with QContactPhoneNumber::SubTypeLandline in imported contact details
    
    EXPORT: 
           Append versit type parameter "VOICE" for subtype
           QContactPhoneNumber::SubTypeLandline to exported versit properties
*/





/*!
   Called for each processed versit property from QVersitContactImporter
   during contact import. 
 */
void CntVersitLandlinePlugin::propertyProcessed(
    const QVersitDocument& document,
    const QVersitProperty& property,
    const QContact& contact,
    bool* alreadyProcessed,
    QList<QContactDetail>* updatedDetails)
{
    Q_UNUSED(document);
    Q_UNUSED(contact);
    Q_UNUSED(property);
    Q_UNUSED(alreadyProcessed);
    Q_UNUSED(updatedDetails);
}

/*!
  Called from QVersitContactImporter as a final step during 
  contact import once all the document properties have been processed.
 */
void CntVersitLandlinePlugin::documentProcessed(
        const QVersitDocument& document, 
        QContact* contact)
{
    Q_UNUSED(document);
    
    // QtPhonebook backend doesn't support QContactPhoneNumber::SubTypeVoice.
    // Simply replace all occurrences with QContactPhoneNumber::SubTypeLandline
    // for every imported phone number. 
    
    // go through the list of imported details 
    QList<QContactDetail> details = contact->details();
    for (int i = 0;i < details.count();i++) {
        QContactDetail detail = details.at(i);
        if (detail.definitionName() == QContactPhoneNumber::DefinitionName) {
            QContactPhoneNumber phoneNumber = static_cast<QContactPhoneNumber>(detail);
            // for every phone number, try convert SubTypeVoice to SubTypeLandline
            QStringList newsubtypes = phoneNumber.subTypes().replaceInStrings(
                    QContactPhoneNumber::SubTypeVoice,
                    QContactPhoneNumber::SubTypeLandline,
                    Qt::CaseInsensitive);    
            
            // save the changes if something was actually replaced
            if (newsubtypes != phoneNumber.subTypes()) {
                phoneNumber.setSubTypes(newsubtypes);
                contact->saveDetail(&phoneNumber);
            }
        }
    }
}



/*!
  Called for each processed detail from QVersitContactExporter during 
  contact export. 
  
  If the current detail being exported is a landline phone number, this
  plugin exports it to vCard type "VOICE".
 */
void CntVersitLandlinePlugin::detailProcessed(
    const QContact& contact,
    const QContactDetail& detail,
    const QVersitDocument& document,
    QSet<QString>* processedFields,
    QList<QVersitProperty>* toBeRemoved,
    QList<QVersitProperty>* toBeAdded)
{
    Q_UNUSED(contact);
    Q_UNUSED(processedFields);
    Q_UNUSED(document);
    Q_UNUSED(toBeRemoved);
   
    
    if ( detail.definitionName() == QContactPhoneNumber::DefinitionName ) { 
        QContactPhoneNumber number = static_cast<QContactPhoneNumber> (detail);  
        
        if (number.subTypes().contains(QContactPhoneNumber::SubTypeLandline, 
                Qt::CaseInsensitive)) {       
            exportLandLineToVoice(toBeAdded, number.number());
        }  
    }  
}  

/*!
  Called from QVersitContactExporter as a final step during 
  contact export once all the contact details have been processed 
 */
void CntVersitLandlinePlugin::contactProcessed(const QContact& contact, QVersitDocument* document)
{
    Q_UNUSED(contact);
    Q_UNUSED(document);  
    // no action
}



/*!
   In the list of exported properties, add the type parameter "VOICE" for 
   a property matching number. Called from detailProcessed during contact export.
   
   /sa detailProcessed
 */
void CntVersitLandlinePlugin::exportLandLineToVoice(
        QList<QVersitProperty> *toBeAdded,
        QString number)
{ 
    bool foundmatch = false;   
    
    // find the property matching to given number from 
    // a list of versit properties to be exported
    QMutableListIterator<QVersitProperty> i(*toBeAdded);         
    while (i.hasNext() && !foundmatch) {
        QVersitProperty property = i.next();
        
        // when the matching number is found, append the type parameter "VOICE"
        if (property.value() == number 
                && property.name() == QLatin1String("TEL") ) { 
                 
            // append the type parameter "VOICE" to the list 
            QStringList typeParameters = property.parameters().values(QLatin1String("TYPE"));       
            typeParameters << QLatin1String("VOICE");
            typeParameters.removeDuplicates();
            
            // insertParameter() always inserts to the beginning so to preserve the 
            // ordering, remove first all current "TYPE" parameters and then iterate 
            // the list backwards and insert parameters back again.
            property.removeParameters(QLatin1String("TYPE"));            
            while (!typeParameters.isEmpty()) {
                QString value = typeParameters.takeLast();        
                property.insertParameter(QLatin1String("TYPE"), value);
            }
            // save the changes
            i.setValue(property);      
            foundmatch = true;
        }
    }
}

// End of File