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

**

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

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the Qt Assistant of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** 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, 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 qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

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

#include "qhelpenginecore.h"

#include "qhelpengine_p.h"

#include "qhelpdbreader_p.h"

#include "qhelpcollectionhandler_p.h"

#include <QtCore/QDir>

#include <QtCore/QFile>

#include <QtCore/QLibrary>

#include <QtCore/QPluginLoader>

#include <QtCore/QFileInfo>

#include <QtCore/QThread>

#include <QtGui/QApplication>

#include <QtSql/QSqlQuery>

QT_BEGIN_NAMESPACE

QHelpEngineCorePrivate::QHelpEngineCorePrivate()

{

    QHelpGlobal::uniquifyConnectionName(QString(), this);

    autoSaveFilter = true;

}

void QHelpEngineCorePrivate::init(const QString &collectionFile,

                                  QHelpEngineCore *helpEngineCore)

{

    q = helpEngineCore;

    collectionHandler = new QHelpCollectionHandler(collectionFile, helpEngineCore);

    connect(collectionHandler, SIGNAL(error(QString)),

        this, SLOT(errorReceived(QString)));

    needsSetup = true;

}

QHelpEngineCorePrivate::~QHelpEngineCorePrivate()

{

    delete collectionHandler;

    clearMaps();

}

void QHelpEngineCorePrivate::clearMaps()

{

    QMap<QString, QHelpDBReader*>::iterator it = readerMap.begin();

    while (it != readerMap.end()) {

        delete it.value();

        ++it;

    }

    readerMap.clear();

    fileNameReaderMap.clear();

    virtualFolderMap.clear();

    orderedFileNameList.clear();

}

bool QHelpEngineCorePrivate::setup()

{

    error.clear();

    if (!needsSetup)

        return true;

    needsSetup = false;

    emit q->setupStarted();

    clearMaps();

    if (!collectionHandler->openCollectionFile()) {

        emit q->setupFinished();

        return false;

    }

    const QHelpCollectionHandler::DocInfoList docList =

        collectionHandler->registeredDocumentations();

    QFileInfo fi(collectionHandler->collectionFile());

    QString absFileName;

    foreach(const QHelpCollectionHandler::DocInfo &info, docList) {

        if (QDir::isAbsolutePath(info.fileName)) {

            absFileName = info.fileName;

        } else {

            absFileName = QFileInfo(fi.absolutePath() + QDir::separator() + info.fileName)

                .absoluteFilePath();

        }

        QHelpDBReader *reader = new QHelpDBReader(absFileName,

            QHelpGlobal::uniquifyConnectionName(info.fileName, this), this);

        if (!reader->init()) {

            emit q->warning(QHelpEngineCore::tr("Cannot open documentation file %1: %2!")

                .arg(absFileName, reader->errorMessage()));

            continue;

        }

        readerMap.insert(info.namespaceName, reader);

        fileNameReaderMap.insert(absFileName, reader);

        virtualFolderMap.insert(info.folderName, reader);

        orderedFileNameList.append(absFileName);

    }

    q->currentFilter();

    emit q->setupFinished();

    return true;

}

void QHelpEngineCorePrivate::errorReceived(const QString &msg)

{

    error = msg;

}

/*!

    \class QHelpEngineCore

    \since 4.4

    \inmodule QtHelp

    \brief The QHelpEngineCore class provides the core functionality

    of the help system.

    Before the help engine can be used, it must be initialized by

    calling setupData(). At the beginning of the setup process the

    signal setupStarted() is emitted. From this point on until

    the signal setupFinished() is emitted, is the help data in an

    undefined meaning unusable state.

    The core help engine can be used to perform different tasks.

    By calling linksForIdentifier() the engine returns

    urls specifying the file locations inside the help system. The

    actual file data can then be retrived by calling fileData(). In

    contrast to all other functions in this class, linksForIdentifier()

    depends on the currently set custom filter. Depending on the filter,

    the function may return different hits.

    Every help engine can contain any number of custom filters. A custom

    filter is defined by a name and set of filter attributes and can be

    added to the help engine by calling addCustomFilter(). Analogous,

    it is removed by calling removeCustomFilter(). customFilters() returns

    all defined filters.

    The help engine also offers the possibility to set and read values

    in a persistant way comparable to ini files or Windows registry

    entries. For more information see setValue() or value().

    This class does not offer any GUI components or functionality for

    indices or contents. If you need one of those use QHelpEngine

    instead.

    When creating a custom help viewer the viewer can be

    configured by writing a custom collection file which could contain various

    keywords to be used to configure the help engine. These keywords and values

    and their meaning can be found in the help information for

    \l{assistant-custom-help-viewer.html#creating-a-custom-help-collection-file}

    {creating a custom help collection file} for Assistant.

*/

/*!

    \fn void QHelpEngineCore::setupStarted()

    This signal is emitted when setup is started.

*/

/*!

    \fn void QHelpEngineCore::setupFinished()

    This signal is emitted when the setup is complete.

*/

/*!

    \fn void QHelpEngineCore::currentFilterChanged(const QString &newFilter)

    This signal is emitted when the current filter is changed to

    \a newFilter.

*/

/*!

    \fn void QHelpEngineCore::warning(const QString &msg)

    This signal is emitted when a non critical error occurs.

    The warning message is stored in \a msg.

*/

/*!

    Constructs a new core help engine with a \a parent. The help engine

    uses the information stored in the \a collectionFile to provide help.

    If the collection file does not exist yet, it'll be created.

*/

QHelpEngineCore::QHelpEngineCore(const QString &collectionFile, QObject *parent)

    : QObject(parent)

{

    d = new QHelpEngineCorePrivate();

    d->init(collectionFile, this);

}

/*!

    \internal

*/

QHelpEngineCore::QHelpEngineCore(QHelpEngineCorePrivate *helpEngineCorePrivate,

                                 QObject *parent)

    : QObject(parent)

{

    d = helpEngineCorePrivate;

}

/*!

    Destructs the help engine.

*/

QHelpEngineCore::~QHelpEngineCore()

{

    delete d;

}

/*!

    \property QHelpEngineCore::collectionFile

    \brief the absolute file name of the collection file currently used.

    \since 4.5

    Setting this property leaves the help engine in an invalid state. It is

    important to invoke setupData() or any getter function in order to setup

    the help engine again.

*/

QString QHelpEngineCore::collectionFile() const

{

    return d->collectionHandler->collectionFile();

}

void QHelpEngineCore::setCollectionFile(const QString &fileName)

{

    if (fileName == collectionFile())

        return;

    if (d->collectionHandler) {

        delete d->collectionHandler;

        d->collectionHandler = 0;

        d->clearMaps();

    }

    d->init(fileName, this);

    d->needsSetup = true;

}

/*!

    Sets up the help engine by processing the information found

    in the collection file and returns true if successful; otherwise

    returns false.

    By calling the function, the help

    engine is forced to initialize itself immediately. Most of

    the times, this function does not have to be called

    explicitly because getter functions which depend on a correctly

    set up help engine do that themselves.

    \note \c{qsqlite4.dll} needs to be deployed with the application as the

    help system uses the sqlite driver when loading help collections.

*/

bool QHelpEngineCore::setupData()

{

    d->needsSetup = true;

    return d->setup();

}

/*!

    Creates the file \a fileName and copies all contents from

    the current collection file into the newly created file,

    and returns true if successful; otherwise returns false.

    The copying process makes sure that file references to Qt

    Collection files (\c{.qch}) files are updated accordingly.

*/

bool QHelpEngineCore::copyCollectionFile(const QString &fileName)

{

    if (!d->setup())

        return false;

    return d->collectionHandler->copyCollectionFile(fileName);

}

/*!

    Returns the namespace name defined for the Qt compressed help file (.qch)

    specified by its \a documentationFileName. If the file is not valid, an

    empty string is returned.

    \sa documentationFileName()

*/

QString QHelpEngineCore::namespaceName(const QString &documentationFileName)

{

    QHelpDBReader reader(documentationFileName,

        QHelpGlobal::uniquifyConnectionName(QLatin1String("GetNamespaceName"),

        QThread::currentThread()), 0);

    if (reader.init())

        return reader.namespaceName();

    return QString();

}

/*!

    Registers the Qt compressed help file (.qch) contained in the file

    \a documentationFileName. One compressed help file, uniquely

    identified by its namespace can only be registered once.

    True is returned if the registration was successful, otherwise

    false.

    \sa unregisterDocumentation(), error()

*/

bool QHelpEngineCore::registerDocumentation(const QString &documentationFileName)

{

    d->error.clear();

    d->needsSetup = true;

    return d->collectionHandler->registerDocumentation(documentationFileName);

}

/*!

    Unregisters the Qt compressed help file (.qch) identified by its

    \a namespaceName from the help collection. Returns true

    on success, otherwise false.

    \sa registerDocumentation(), error()

*/

bool QHelpEngineCore::unregisterDocumentation(const QString &namespaceName)

{

    d->error.clear();

    d->needsSetup = true;

    return d->collectionHandler->unregisterDocumentation(namespaceName);

}

/*!

    Returns the absolute file name of the Qt compressed help file (.qch)

    identified by the \a namespaceName. If there is no Qt compressed help file

    with the specified namespace registered, an empty string is returned.

    \sa namespaceName()

*/

QString QHelpEngineCore::documentationFileName(const QString &namespaceName)

{

    if (d->setup()) {

        const QHelpCollectionHandler::DocInfoList docList =

            d->collectionHandler->registeredDocumentations();

        foreach(const QHelpCollectionHandler::DocInfo &info, docList) {

            if (info.namespaceName == namespaceName) {

                if (QDir::isAbsolutePath(info.fileName))

                    return QDir::cleanPath(info.fileName);

                QFileInfo fi(d->collectionHandler->collectionFile());

                fi.setFile(fi.absolutePath() + QDir::separator() + info.fileName);

                return QDir::cleanPath(fi.absoluteFilePath());

            }

        }

    }

    return QString();

}

/*!

    Returns a list of all registered Qt compressed help files of the current collection file.

    The returned names are the namespaces of the registered Qt compressed help files (.qch).

*/

QStringList QHelpEngineCore::registeredDocumentations() const

{

    QStringList list;

    if (!d->setup())

        return list;

    const QHelpCollectionHandler::DocInfoList docList = d->collectionHandler->registeredDocumentations();

    foreach(const QHelpCollectionHandler::DocInfo &info, docList) {

        list.append(info.namespaceName);

    }

    return list;

}

/*!

    Returns a list of custom filters.

    \sa addCustomFilter(), removeCustomFilter()

*/

QStringList QHelpEngineCore::customFilters() const

{

    if (!d->setup())

        return QStringList();

    return d->collectionHandler->customFilters();

}

/*!

    Adds the new custom filter \a filterName. The filter attributes

    are specified by \a attributes. If the filter already exists,

    its attribute set is replaced. The function returns true if

    the operation succeeded, otherwise it returns false.

    \sa customFilters(), removeCustomFilter()

*/

bool QHelpEngineCore::addCustomFilter(const QString &filterName,

                                      const QStringList &attributes)

{

    d->error.clear();

    d->needsSetup = true;

    return d->collectionHandler->addCustomFilter(filterName,

        attributes);

}

/*!

    Returns true if the filter \a filterName was removed successfully,

    otherwise false.

    \sa addCustomFilter(), customFilters()

*/

bool QHelpEngineCore::removeCustomFilter(const QString &filterName)

{

    d->error.clear();

    d->needsSetup = true;

    return d->collectionHandler->removeCustomFilter(filterName);

}

/*!

    Returns a list of all defined filter attributes.

*/

QStringList QHelpEngineCore::filterAttributes() const

{

    if (!d->setup())

        return QStringList();

    return d->collectionHandler->filterAttributes();

}

/*!

    Returns a list of filter attributes used by the custom

    filter \a filterName.

*/

QStringList QHelpEngineCore::filterAttributes(const QString &filterName) const

{

    if (!d->setup())

        return QStringList();

    return d->collectionHandler->filterAttributes(filterName);

}

/*!

    \property QHelpEngineCore::currentFilter

    \brief the name of the custom filter currently applied.

    \since 4.5

    Setting this property will save the new custom filter permanently in the

    help collection file. To set a custom filter without saving it

    permanently, disable the auto save filter mode.

    \sa autoSaveFilter()

*/

QString QHelpEngineCore::currentFilter() const

{

    if (!d->setup())

        return QString();

    if (d->currentFilter.isEmpty()) {

        QString filter =

            d->collectionHandler->customValue(QLatin1String("CurrentFilter"),

                QString()).toString();

        if (!filter.isEmpty()

            && d->collectionHandler->customFilters().contains(filter))

            d->currentFilter = filter;

    }

    return d->currentFilter;

}

void QHelpEngineCore::setCurrentFilter(const QString &filterName)

{

    if (!d->setup() || filterName == d->currentFilter)

        return;

    d->currentFilter = filterName;

    if (d->autoSaveFilter) {

        d->collectionHandler->setCustomValue(QLatin1String("CurrentFilter"),

            d->currentFilter);

    }

    emit currentFilterChanged(d->currentFilter);

}

/*!

    Returns a list of filter attributes for the different filter sections

    defined in the Qt compressed help file with the given namespace

    \a namespaceName.

*/

QList<QStringList> QHelpEngineCore::filterAttributeSets(const QString &namespaceName) const

{

    if (d->setup()) {

        QHelpDBReader *reader = d->readerMap.value(namespaceName);

        if (reader)

            return reader->filterAttributeSets();

    }

    return QList<QStringList>();

}

/*!

    Returns a list of files contained in the Qt compressed help file \a

    namespaceName. The files can be filtered by \a filterAttributes as

    well as by their extension \a extensionFilter (e.g. 'html').

*/

QList<QUrl> QHelpEngineCore::files(const QString namespaceName,

                                   const QStringList &filterAttributes,

                                   const QString &extensionFilter)

{

    QList<QUrl> res;

    if (!d->setup())

        return res;

    QHelpDBReader *reader = d->readerMap.value(namespaceName);

    if (!reader) {