qgsserversettings.h

Go to the documentation of this file.

/***************************************************************************
                    qgsserversettings.h
                    -------------------
  begin                : December 19, 2016
  copyright            : (C) 2016 by Paul Blottiere
  email                : paul dot blottiere at oslandia dot com

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

/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/


#ifndef QGSSERVERSETTINGS_H
#define QGSSERVERSETTINGS_H

#include <QObject>
#include <QMetaEnum>

#include "qgsmessagelog.h"
#include "qgis_server.h"
#include "qgis_sip.h"

#ifndef SIP_RUN
class SERVER_EXPORT QgsServerSettingsEnv : public QObject
{
    Q_OBJECT

  public:
    enum Source
    {
      DEFAULT_VALUE,
      ENVIRONMENT_VARIABLE,
      INI_FILE
    };
    Q_ENUM( Source )

    
    enum EnvVar
    {
      QGIS_OPTIONS_PATH,
      QGIS_SERVER_PARALLEL_RENDERING,
      QGIS_SERVER_MAX_THREADS,
      QGIS_SERVER_LOG_LEVEL,
      QGIS_SERVER_LOG_FILE,
      QGIS_SERVER_LOG_STDERR,
      QGIS_PROJECT_FILE,
      MAX_CACHE_LAYERS,
      QGIS_SERVER_CACHE_DIRECTORY,
      QGIS_SERVER_CACHE_SIZE,
      QGIS_SERVER_SHOW_GROUP_SEPARATOR,  
      QGIS_SERVER_OVERRIDE_SYSTEM_LOCALE,  
      QGIS_SERVER_WMS_MAX_HEIGHT, 
      QGIS_SERVER_WMS_MAX_WIDTH, 
      QGIS_SERVER_API_RESOURCES_DIRECTORY, 
      QGIS_SERVER_API_WFS3_MAX_LIMIT 
    };
    Q_ENUM( EnvVar )
};
#endif

class SERVER_EXPORT QgsServerSettings
{
  public:
    struct Setting SIP_SKIP
    {
      QgsServerSettingsEnv::EnvVar envVar;
      QgsServerSettingsEnv::Source src;
      QString descr;
      QString iniKey;
      QVariant::Type type;
      QVariant defaultVal;
      QVariant val;
    };

    QgsServerSettings();

    void load();

    bool load( const QString &envVarName );

    void logSummary() const;

    QString iniFile() const;

    bool parallelRendering() const;

    int maxThreads() const;

    int maxCacheLayers() const;

    Qgis::MessageLevel logLevel() const;

    QString projectFile() const;

    QString logFile() const;

    bool logStderr() const;

    qint64 cacheSize() const;

    QString cacheDirectory() const;

    QString overrideSystemLocale() const;

    bool showGroupSeparator() const;

    int wmsMaxHeight() const;

    int wmsMaxWidth() const;

    QString apiResourcesDirectory() const;

    qlonglong apiWfs3MaxLimit() const;

  private:
    void initSettings();
    QVariant value( QgsServerSettingsEnv::EnvVar envVar ) const;
    QMap<QgsServerSettingsEnv::EnvVar, QString> getEnv() const;
    void loadQSettings( const QString &envOptPath ) const;
    void prioritize( const QMap<QgsServerSettingsEnv::EnvVar, QString> &env );

    QMap< QgsServerSettingsEnv::EnvVar, Setting > mSettings;
};

#endif