qgsaccesscontrolfilter.h

Go to the documentation of this file.

/***************************************************************************
                          qgsaccesscontrolfilter.h
                          ------------------------
 Access control interface for Qgis Server plugins

  begin                : 2015-05-19
  copyright            : (C) 2015 by Stéphane Brunner
  email                : stephane dot brunner at camptocamp dot org
 ***************************************************************************/

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

#include <QMultiMap>
#include <QString>
#include "qgis_server.h"
#include "qgis_sip.h"

SIP_IF_MODULE( HAVE_SERVER_PYTHON_PLUGINS )

class QgsServerInterface;
class QgsMapLayer;
class QgsVectorLayer;
class QgsFeature;


class SERVER_EXPORT QgsAccessControlFilter
{

  public:

    QgsAccessControlFilter( const QgsServerInterface *serverInterface );

    virtual ~QgsAccessControlFilter() = default;

    struct LayerPermissions
    {
      bool canRead;
      bool canUpdate;
      bool canInsert;
      bool canDelete;
    };

    const QgsServerInterface *serverInterface() const { return mServerInterface; }

    virtual QString layerFilterExpression( const QgsVectorLayer *layer ) const;

    virtual QString layerFilterSubsetString( const QgsVectorLayer *layer ) const;

    virtual LayerPermissions layerPermissions( const QgsMapLayer *layer ) const;

    virtual QStringList authorizedLayerAttributes( const QgsVectorLayer *layer, const QStringList &attributes ) const;

    virtual bool allowToEdit( const QgsVectorLayer *layer, const QgsFeature &feature ) const;

    virtual QString cacheKey() const;

  private:

    const QgsServerInterface *mServerInterface = nullptr;

};

typedef QMultiMap<int, QgsAccessControlFilter *> QgsAccessControlFilterMap;


#endif // QGSSERVERSECURITY_H