/****************************************************************************

**

** Copyright (C) 2008-2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (developer.feedback@nokia.com)

**

** This file is part of the HbCore module of the UI Extensions for Mobile.

**

** GNU Lesser General Public License Usage

** 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, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at developer.feedback@nokia.com.

**

****************************************************************************/

#include "hbinputsettingproxy.h"

#include "hbinputsettingproxy_p.h"

#include <qbytearray.h>

#include <QFile>

#include <QBuffer>

#include <QDataStream>

#include <QCoreApplication>

#include <QSharedMemory>

#include <QVector>

#include <QDir>

#include "hbinputmodecache_p.h"

#include "hbinputfilter.h"

#ifdef Q_OS_SYMBIAN

#define HBI_BASE_PATH QString("\\resource\\plugins")

#define HBI_BASE_WRITABLE_PATH QString("c:\\data\\hbinputs")

#else

#ifndef Q_OS_UNIX

#define HBI_BASE_WRITABLE_PATH QString("c:\\Hb\\lib")

#endif

#endif

/*!

@alpha

@hbcore

\class HbInputSettingProxy

\brief A singleton class providing access to system wide input related settings.

HbInputSettingProxy provides access to all system wide input settings. It is implemented

as process specific singleton, but it stores the settings to a shared memory chunk

so that all the processes in the system share the same set of settings.

Setting proxy stores its state to disk when the last instance in memory is destroyed

and loads it back again when the first instance is created.

It also knows file system paths to several important input related folders in the

system.

*/

/// @cond

HbSettingProxyInputMethodDescriptor::HbSettingProxyInputMethodDescriptor()

{

    pluginNameAndPathSize = 0;

    keySize = 0;

    displayNameSize = 0;

}

HbSettingProxyInputMethodDescriptor::HbSettingProxyInputMethodDescriptor(const HbInputMethodDescriptor &descriptor)

{

    *this = descriptor;

}

void HbSettingProxyInputMethodDescriptor::operator=(const HbInputMethodDescriptor &descriptor)

{

    pluginNameAndPathSize = 0;

    keySize = 0;

    displayNameSize = 0;

    if (!descriptor.pluginNameAndPath().isEmpty() &&

        (descriptor.pluginNameAndPath().size() * sizeof(QChar) < HbActiveMethodNameMax)) {

        pluginNameAndPathSize = descriptor.pluginNameAndPath().size();

        memcpy((void *)pluginNameAndPath, (void *)descriptor.pluginNameAndPath().unicode(), descriptor.pluginNameAndPath().size() * sizeof(QChar));

    }

    if (!descriptor.key().isEmpty() &&

        (descriptor.key().size() * sizeof(QChar) < HbActiveMethodKeyMax)) {

        memcpy((void *)key, (void *)descriptor.key().unicode(), descriptor.key().size() * sizeof(QChar));

        keySize = descriptor.key().size();

    }

    if (!descriptor.displayName().isEmpty() &&

        (descriptor.displayName().size() * sizeof(QChar) < HbActiveMethodKeyMax)) {

        memcpy((void *)displayName, (void *)descriptor.displayName().unicode(), descriptor.displayName().size() * sizeof(QChar));

        displayNameSize = descriptor.displayName().size();

    }

}

HbInputMethodDescriptor HbSettingProxyInputMethodDescriptor::descriptor() const

{

    HbInputMethodDescriptor result;

    if (pluginNameAndPathSize > 0) {

        result.setPluginNameAndPath(QString(pluginNameAndPath, pluginNameAndPathSize));

    }

    if (keySize > 0) {

        result.setKey(QString(key, keySize));

    }

    if (displayNameSize > 0) {

        result.setDisplayName(QString(displayName, displayNameSize));

    }

    return result;

}

QByteArray HbSettingProxyInputMethodDescriptor::data() const

{

    if (customDataSize > 0) {

        return QByteArray(customData, customDataSize);

    }

    return QByteArray();

}

void HbSettingProxyInputMethodDescriptor::setData(const QByteArray &data)

{

    customDataSize = 0;

    if (data.size() > 0 && data.size() <= (int)HbActiveMethodKeyMax * 2) {

        memcpy(customData, data.data(), data.size());

        customDataSize = data.size();

    }

}

// Special character classifier class for bookkeeping

// of how popular a SC is.

class HbScClassifier

{

public:

    HbScClassifier(QChar aChar = 0, int aCount = 0)

        : mChar(aChar), mCount(aCount) {

    }

    void operator=(const HbScClassifier &aOther) {

        mChar = aOther.mChar;

        mCount = aOther.mCount;

    }

public:

    QChar mChar;

    int mCount;

};

HbInputSettingProxyPrivate::HbInputSettingProxyPrivate()

{

    iSharedMemory = new QSharedMemory(KInputSettingProxyKey);

    if (!iSharedMemory->attach()) {

        if (iSharedMemory->error() != QSharedMemory::NotFound) {

            qDebug("HbInputSettingProxy: QSharedMemory::attached returned error %d", iSharedMemory->error());

            return;

        }

        if (!iSharedMemory->create(sizeof(HbSettingProxyInternalData))) {

            qDebug("HbInputSettingProxy : Unable to create shared memory block!");

            return;

        }

        initializeDataArea();

    }

    lock();

    HbSettingProxyInternalData *prData = proxyData();

    if (prData) {

        ++prData->iReferences;

    }

    unlock();

    // This is needed because qApp doesn't not exist anymore when singleton destructs.

    iSaveFile = dataFileNameAndPath();

}

HbInputSettingProxyPrivate::~HbInputSettingProxyPrivate()

{

    // NOTE: iSharedMemory is not deleted on purpose. See HbInputSettingProxy::shutdown.

}

void HbInputSettingProxyPrivate::shutdownDataArea()

{

    lock();

    HbSettingProxyInternalData *prData = proxyData();

    if (prData) {

        prData->iReferences--;

        if (prData->iReferences <= 0) {

            save();

        }

    }

    unlock();

}

QString HbInputSettingProxyPrivate::dataFilePath()

{

    return HbInputSettingProxy::writablePath() + QDir::separator() + QString("settings");

}

QString HbInputSettingProxyPrivate::dataFileNameAndPath()

{

    return dataFilePath() + QDir::separator() + QString("proxy.dat");

}

void HbInputSettingProxyPrivate::initializeDataArea()

{

    lock();

    bool wasLoaded = load();

    HbSettingProxyInternalData *prData = proxyData();

    if (prData) {

        prData->iReferences = 0;

        prData->iOrientationChangeCompleted = true;

        // Default values, real ones should be set by calling initializeOrientation()

        prData->iScreenOrientation = Qt::Vertical;

        if (!wasLoaded) {

            // There was no permanent storage version, so initialize to defaults.

            prData->iVersion = HbProxyDataRequiredVersion;

            prData->iGlobalPrimaryInputLanguage = HbInputLanguage(QLocale::English, QLocale::UnitedKingdom);

            prData->iGlobalSecondaryInputLanguage = QLocale::Language(0);

            prData->iActiveKeyboard = HbKeyboardVirtual12Key;

            prData->iTouchKeyboard = HbKeyboardVirtual12Key;

            prData->iHwKeyboard = HbKeyboardQwerty;

            prData->iPredictiveInputState = (HbKeyboardSettingFlags)HbKeyboardSetting12key | HbKeyboardSettingQwerty;

            prData->iDigitType = HbDigitTypeLatin;

            prData->iQwertyTextCasing = true;

            prData->iQwertyCharacterPreview = true;

            prData->iRegionalCorrectionStatus = true;

            prData->iKeypressTimeout = 1000;

            prData->iAutocompletion = (HbKeyboardSettingFlags)(HbKeyboardSetting12key | HbKeyboardSettingQwerty);

            prData->iTypingCorrectionLevel = HbTypingCorrectionLevelHigh;

            prData->iPrimaryCandidateMode = HbPrimaryCandidateModeBestPrediction;

            prData->iPreferredMethodHorizontal = HbInputMethodDescriptor();

            prData->iPreferredMethodHorizontal.setData(QByteArray());

            prData->iPreferredMethodVertical = HbInputMethodDescriptor();

            prData->iPreferredMethodVertical.setData(QByteArray());

        }

    }

    unlock();

}

bool HbInputSettingProxyPrivate::load()

{

    QFile file(dataFileNameAndPath());

    if (!file.open(QIODevice::ReadOnly)) {

        return false;

    }

    QByteArray rawData = file.read(sizeof(HbSettingProxyInternalData));

    if (rawData.size() == sizeof(HbSettingProxyInternalData)) {

        HbSettingProxyInternalData *ldData = (HbSettingProxyInternalData *)rawData.constData();

        if (ldData) {

            if (ldData->iVersion == HbProxyDataRequiredVersion) {

                HbSettingProxyInternalData *prData = proxyData();

                memcpy((void *)prData, (void *)ldData, sizeof(HbSettingProxyInternalData));

                prData->iActiveKeyboard = ldData->iActiveKeyboard;

                // Temporarily like this, will be moved as part of shared data later...

                int numItems = 0;

                file.read((char *)&numItems, sizeof(int));

                iTopScs.clear();

                for (int jj = 0; jj < numItems; jj++) {

                    HbScClassifier tmpItem;

                    file.read((char *)&tmpItem, sizeof(HbScClassifier));

                    iTopScs.append(tmpItem);

                }

                file.close();

                return true;

            }

        }

    }

    file.close();

    return false;

}

void HbInputSettingProxyPrivate::save()

{

    // Make sure that the path exists

    QDir settingDir;

    settingDir.mkpath(dataFilePath());

    HbSettingProxyInternalData *prData = proxyData();

    if (prData) {

        QFile file(iSaveFile);

        if (!file.open(QIODevice::WriteOnly)) {

            return;

        }

        file.write((const char *)prData, sizeof(HbSettingProxyInternalData));

        // Temporarily like this, will be moved to shared data later...

        int numItems = iTopScs.count();

        file.write((const char *)&numItems, sizeof(int));

        file.write((const char *)iTopScs.constData(), numItems * sizeof(HbScClassifier));

        file.close();

    }

}

QString HbInputSettingProxyPrivate::stringFromProxyDataElement(QChar *string) const

{

    QString result;

    for (int i = 0; string[i] != 0; i++) {

        result.append(string[i]);

    }

    return QString(result);

}

void HbInputSettingProxyPrivate::stringToProxyDataElement(QChar *string, const QString &source, int maxSize) const

{

    int i = 0;

    for (; i < source.length() && i < maxSize - 1; i++) {

        string[i] = source[i];

    }

    string[i] = 0;

}

HbSettingProxyInternalData *HbInputSettingProxyPrivate::proxyData() const

{

    return static_cast<HbSettingProxyInternalData *>(iSharedMemory->data());

}

void HbInputSettingProxyPrivate::flipToggle()

{

    setFlipStatus(!flipStatus());

}

bool HbInputSettingProxyPrivate::flipStatus()

{

    HbSettingProxyInternalData *prData = proxyData();

    return prData->iFlipStatus;

}

void HbInputSettingProxyPrivate::setFlipStatus(bool flipStatus)

{

    HbSettingProxyInternalData *prData = proxyData();

    prData->iFlipStatus = flipStatus;

    handleDeviceSpecificOriantationAndFlipChange();

}

void HbInputSettingProxyPrivate::handleDeviceSpecificOriantationAndFlipChange()

{

    HbKeyboardType  keyboard = HbKeyboardNone;

    if (HbInputSettingProxy::instance()->screenOrientation() == Qt::Vertical) {

        keyboard = HbKeyboardVirtual12Key;

    } else {

        if (flipStatus()) {

            keyboard = HbKeyboardQwerty;

        } else {

            keyboard = HbKeyboardVirtualQwerty;

        }

    }

    HbInputSettingProxy::instance()->setActiveKeyboard(keyboard);

}

/// @endcond

/*!

Returns pointer to the singleton object.

*/

HbInputSettingProxy *HbInputSettingProxy::instance()

{

    static HbInputSettingProxy theProxy;

    return &theProxy;

}

/*!

Constructs the object.

*/

HbInputSettingProxy::HbInputSettingProxy() : d_ptr(new HbInputSettingProxyPrivate())

{

}

/*!

Destructs the object

*/

HbInputSettingProxy::~HbInputSettingProxy()

{

    delete d_ptr;

}

/*!

Shuts down the object safely. This is needed mainly for singleton object. There has been a lot

of problems related to random singleton destruction order and additional shutdown step is

needed to guarantee that it will be done safely. The slot is connected to

QCoreApplication::aboutToQuit when the framework is initialized.

*/

void HbInputSettingProxy::shutdown()

{

    Q_D(HbInputSettingProxy);

    d->shutdownDataArea();

    delete d->iSharedMemory;

    d->iSharedMemory = 0;

}

/*!

Toggles prediction mode

*/

void HbInputSettingProxy::togglePrediction()

{

    if (activeKeyboard() & HbQwertyKeyboardMask) {

        setPredictiveInputStatus(HbKeyboardSettingQwerty, !predictiveInputStatus(HbKeyboardSettingQwerty));

    } else {

        setPredictiveInputStatus(HbKeyboardSetting12key, !predictiveInputStatus(HbKeyboardSetting12key));

    }

}

/*!

Setting proxy emits a signal when any of the monitored settings changes. This

method connects those signals to given object.

\sa disconnectObservingObject

\sa globalInputLanguageChanged

\sa predictiveInputStateChanged

\sa orientationAboutToChange

\sa orientationChanged

\sa characterPreviewStateForQwertyChanged

\sa keypressTimeoutChanged

\sa autocompletionStateChanged

\sa typingCorrectionLevelChanged

\sa primaryCandidateModeChanged

*/

void HbInputSettingProxy::connectObservingObject(QObject *aObserver)

{

    if (aObserver) {

        connect(this, SIGNAL(globalInputLanguageChanged(const HbInputLanguage &)), aObserver, SLOT(globalInputLanguageChanged(const HbInputLanguage &)));

        connect(this, SIGNAL(globalSecondaryInputLanguageChanged(const HbInputLanguage &)), aObserver, SLOT(globalSecondaryInputLanguageChanged(const HbInputLanguage &)));

        connect(this, SIGNAL(activeKeyboardChanged(HbKeyboardType)), aObserver, SLOT(activeKeyboardChanged(HbKeyboardType)));

        connect(this, SIGNAL(orientationAboutToChange()), aObserver, SLOT(orientationAboutToChange()));

        connect(this, SIGNAL(orientationChanged(Qt::Orientation)), aObserver, SLOT(orientationChanged(Qt::Orientation)));

    }

}

/*!

Disconnects given object from the setting proxy.

\sa connectObservingObject

*/

void HbInputSettingProxy::disconnectObservingObject(QObject *aObserver)

{

    if (aObserver) {

        disconnect(this, SIGNAL(globalInputLanguageChanged(const HbInputLanguage &)), aObserver, SLOT(globalInputLanguageChanged(const HbInputLanguage &)));

        disconnect(this, SIGNAL(globalSecondaryInputLanguageChanged(const HbInputLanguage &)), aObserver, SLOT(globalSecondaryInputLanguageChanged(const HbInputLanguage &)));

        disconnect(this, SIGNAL(activeKeyboardChanged(HbKeyboardType)), aObserver, SLOT(activeKeyboardChanged(HbKeyboardType)));

        disconnect(this, SIGNAL(orientationAboutToChange()), aObserver, SLOT(orientationAboutToChange()));

        disconnect(this, SIGNAL(orientationChanged(Qt::Orientation)), aObserver, SLOT(orientationChanged(Qt::Orientation)));

    }

}

/*!

Returns active input language. This is system wide value, an editor and input state machine may override this by defining

local input language. Use HbInputMethod::ActiveLanguage for input state related situation and

this method for system wide setting.

\sa setGlobalInputLanguage

*/

HbInputLanguage HbInputSettingProxy::globalInputLanguage() const

{

    Q_D(const HbInputSettingProxy);

    HbInputLanguage res;

    d->lock();

    HbSettingProxyInternalData *prData = d->proxyData();

    if (prData) {

        res = prData->iGlobalPrimaryInputLanguage;

    }

    d->unlock();

    return HbInputLanguage(res);

}

/*!

Returns active secondary input language. Secondary input language is often used by the prediction engines for predicting

candidates in both the languages.

\sa setGlobalSecondaryInputLanguage

*/

HbInputLanguage HbInputSettingProxy::globalSecondaryInputLanguage() const

{

    Q_D(const HbInputSettingProxy);

    HbInputLanguage res;

    d->lock();

    HbSettingProxyInternalData *prData = d->proxyData();

    if (prData) {

        res = prData->iGlobalSecondaryInputLanguage;

    }

    d->unlock();

    return HbInputLanguage(res);