qgsserver.h

Go to the documentation of this file.

/***************************************************************************
                          qgsserver.h
  QGIS Server main class.
                        -------------------
  begin                : June 05, 2015
  copyright            : (C) 2015 by Alessandro Pasotti
  email                : a dot pasotti at itopen dot it

  Based on previous work from:

  begin                : July 04, 2006
  copyright            : (C) 2006 by Marco Hugentobler & Ionut Iosifescu Enescu
  email                : marco dot hugentobler at karto dot baug dot ethz dot ch

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

/***************************************************************************
 *                                                                         *
 *   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 QGSSERVER_H
#define QGSSERVER_H

#include <QFileInfo>
#include "qgsrequesthandler.h"
#include "qgsapplication.h"
#include "qgsmaprenderer.h"
#include "qgsconfigcache.h"
#include "qgscapabilitiescache.h"

#ifdef HAVE_SERVER_PYTHON_PLUGINS
#include "qgsserverplugins.h"
#include "qgsserverfilter.h"
#include "qgsserverinterfaceimpl.h"
#endif


class SERVER_EXPORT QgsServer
{
  public:
    QgsServer( int & argc, char ** argv );
    QgsServer();
    ~QgsServer();

    static bool init( int & argc, char ** argv );
    static bool init();

    void putenv( const QString &var, const QString &val );

    QPair<QByteArray, QByteArray> handleRequest( const QString& queryString = QString() );
#if 0
    // The following code was used to test type conversion in python bindings
    QPair<QByteArray, QByteArray> testQPair( QPair<QByteArray, QByteArray> pair );
#endif

#ifdef HAVE_SERVER_PYTHON_PLUGINS
    QgsServerInterfaceImpl* serverInterface() { return sServerInterface; }
#endif

  private:

    void saveEnvVars();

    void saveEnvVar( const QString& variableName );

    // All functions that where previously in the main file are now
    // static methods of this class
    static QString configPath( const QString& defaultConfigPath,
                               const QMap<QString, QString>& parameters );
    // Mainly for debug
    static void dummyMessageHandler( QtMsgType type, const char *msg );
    // Mainly for debug
    static void printRequestInfos();
    // Mainly for debug
    static void printRequestParameters(
      const QMap< QString, QString>& parameterMap,
      int logLevel );
    static QFileInfo defaultProjectFile();
    static QFileInfo defaultAdminSLD();
    static void setupNetworkAccessManager();
    static QgsRequestHandler* createRequestHandler( const bool captureOutput = false );

    // Return the server name
    static QString &serverName();

    // Status
    static QString* sConfigFilePath;
    static QgsCapabilitiesCache* sCapabilitiesCache;
    static QgsMapRenderer* sMapRenderer;
#ifdef HAVE_SERVER_PYTHON_PLUGINS
    static QgsServerInterfaceImpl* sServerInterface;
    static bool sInitPython;
#endif
    static bool sInitialised;
    static char* sArgv[1];
    static int sArgc;
    static QgsApplication* sQgsApplication;
    static bool sCaptureOutput;

    QHash< QString, QString > mEnvironmentVariables;
};
#endif // QGSSERVER_H