qofonosimmanager.h 6.71 KB
Newer Older
Jenkins's avatar
Jenkins committed
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
/****************************************************************************
**
** Copyright (C) 2013-2016 Jolla Ltd.
** Contact: lorn.potter@jollamobile.com
**
** 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.
**
****************************************************************************/

#ifndef QOFONOSimManager_H
#define QOFONOSimManager_H

#include "qofonomodeminterface.h"
#include "qofono_global.h"

//! This class is used to access ofono SIM API
/*!
 * The API is documented in
 * http://git.kernel.org/?p=network/ofono/ofono.git;a=blob_plain;f=doc/sim-api.txt
 */
class QOFONOSHARED_EXPORT QOfonoSimManager : public QOfonoModemInterface
{
    Q_OBJECT
    Q_ENUMS(Error)
    Q_ENUMS(PinType)
    Q_PROPERTY(bool present READ present NOTIFY presenceChanged)
    Q_PROPERTY(QString subscriberIdentity READ subscriberIdentity NOTIFY subscriberIdentityChanged)
    Q_PROPERTY(QString mobileCountryCode READ mobileCountryCode NOTIFY mobileCountryCodeChanged)
    Q_PROPERTY(QString mobileNetworkCode READ mobileNetworkCode NOTIFY mobileNetworkCodeChanged)
    Q_PROPERTY(QString serviceProviderName READ serviceProviderName NOTIFY serviceProviderNameChanged)
    Q_PROPERTY(QStringList subscriberNumbers READ subscriberNumbers WRITE setSubscriberNumbers NOTIFY subscriberNumbersChanged)
    Q_PROPERTY(QVariantMap serviceNumbers READ serviceNumbers NOTIFY serviceNumbersChanged)
    Q_PROPERTY(PinType pinRequired READ pinRequired NOTIFY pinRequiredChanged)
    Q_PROPERTY(QVariantList lockedPins READ lockedPins NOTIFY lockedPinsChanged)
    Q_PROPERTY(QString cardIdentifier READ cardIdentifier NOTIFY cardIdentifierChanged)
    Q_PROPERTY(QStringList preferredLanguages READ preferredLanguages NOTIFY preferredLanguagesChanged)
    Q_PROPERTY(QVariantMap pinRetries READ pinRetries NOTIFY pinRetriesChanged)
    Q_PROPERTY(bool fixedDialing READ fixedDialing NOTIFY fixedDialingChanged)
    Q_PROPERTY(bool barredDialing READ barredDialing NOTIFY barredDialingChanged)

public:
    class SharedPointer;

    enum Error {
        NoError,
        NotImplementedError,
        InProgressError,
        InvalidArgumentsError,
        InvalidFormatError,
        FailedError,
        UnknownError
    };

    enum PinType {
        NoPin,
        SimPin,
        SimPin2,
        PhoneToSimPin,
        PhoneToFirstSimPin,
        NetworkPersonalizationPin,
        NetworkSubsetPersonalizationPin,
        ServiceProviderPersonalizationPin,
        CorporatePersonalizationPin,
        SimPuk,
        SimPuk2,
        PhoneToFirstSimPuk,
        NetworkPersonalizationPuk,
        NetworkSubsetPersonalizationPuk,
        CorporatePersonalizationPuk
    };

    explicit QOfonoSimManager(QObject *parent = 0);
    ~QOfonoSimManager();

    QString modemPath() const;
    void setModemPath(const QString &path);

    bool present() const;
    QString subscriberIdentity() const;
    QString mobileCountryCode() const;
    QString mobileNetworkCode() const;
    QString serviceProviderName() const;
    QStringList subscriberNumbers() const;
    QVariantMap serviceNumbers() const; //
    PinType pinRequired() const;
    QVariantList lockedPins() const;
    QString cardIdentifier() const;
    QStringList preferredLanguages() const;
    QVariantMap pinRetries() const; //
    bool fixedDialing() const;
    bool barredDialing() const;
    bool isValid() const;

Q_SIGNALS:
    void presenceChanged(bool ispresent);
    void subscriberIdentityChanged(const QString &imsi);
    void mobileCountryCodeChanged(const QString &mcc);
    void mobileNetworkCodeChanged(const QString &mnc);
    void serviceProviderNameChanged(const QString &spn);
    void subscriberNumbersChanged(const QStringList &msisdns);
    void serviceNumbersChanged(const QVariantMap &sdns);
    void pinRequiredChanged(int pinType);
    void lockedPinsChanged(const QVariantList &pins);
    void cardIdentifierChanged(const QString &iccid);
    void preferredLanguagesChanged(const QStringList &languages);
    void pinRetriesChanged(const QVariantMap &pinRetries);
    void fixedDialingChanged(bool fixedDialing);
    void barredDialingChanged(bool barredDialing);

    void enterPinComplete(QOfonoSimManager::Error error, const QString &errorString);
    void resetPinComplete(QOfonoSimManager::Error error, const QString &errorString);
    void changePinComplete(QOfonoSimManager::Error error, const QString &errorString);
    void lockPinComplete(QOfonoSimManager::Error error, const QString &errorString);
    void unlockPinComplete(QOfonoSimManager::Error error, const QString &errorString);

public slots:
    void changePin(QOfonoSimManager::PinType pinType, const QString &oldpin, const QString &newpin);
    void enterPin(QOfonoSimManager::PinType pinType, const QString &pin);
    void resetPin(QOfonoSimManager::PinType pinType, const QString &puk, const QString &newpin);
    void lockPin(QOfonoSimManager::PinType pinType, const QString &pin);
    void unlockPin(QOfonoSimManager::PinType pinType, const QString &pin);
    QByteArray getIcon(quint8 id);

    void setSubscriberNumbers(const QStringList &numbers);

    static int minimumPinLength(QOfonoSimManager::PinType pinType);
    static int maximumPinLength(QOfonoSimManager::PinType pinType);
    static QString pinTypeToString(QOfonoSimManager::PinType pinType);
    static int pinTypeFromString(const QString &s);
    static bool isPukType(QOfonoSimManager::PinType pinType);
    static int pukToPin(QOfonoSimManager::PinType puk);

private:
    Error errorNameToEnum(const QString &errorName);

protected:
    QDBusAbstractInterface *createDbusInterface(const QString &path);
    QVariant convertProperty(const QString &property, const QVariant &value);
    void propertyChanged(const QString &property, const QVariant &value);

private slots:
    void changePinCallFinished(QDBusPendingCallWatcher *call);
    void enterPinCallFinished(QDBusPendingCallWatcher *call);
    void resetPinCallFinished(QDBusPendingCallWatcher *call);
    void lockPinCallFinished(QDBusPendingCallWatcher *call);
    void unlockPinCallFinished(QDBusPendingCallWatcher *call);
};

// Unlike the default QSharedPointer, deletes QOfonoSimManager with deleteLater
class QOFONOSHARED_EXPORT QOfonoSimManager::SharedPointer : public QSharedPointer<QOfonoSimManager> {
public:
    SharedPointer(QOfonoSimManager * ptr = NULL) : QSharedPointer<QOfonoSimManager>(ptr, &QObject::deleteLater) {}
};

#endif // QOFONOSimManager_H