qgsaccesscontrol.h

Go to the documentation of this file.

/***************************************************************************
                              qgsaccesscontrol.h
                              ------------------
  begin                : 22-05-2015
  copyright            : (C) 2008 by Stéphane Brunner
  email                : stephane dot brunner at camptocamp 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 QGSACCESSCONTROL_H
#define QGSACCESSCONTROL_H

#include "qgsfeaturefilterprovider.h"
#include "qgsaccesscontrolfilter.h"

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

SIP_IF_MODULE( HAVE_SERVER_PYTHON_PLUGINS )

class QgsAccessControlPlugin;


class SERVER_EXPORT QgsAccessControl : public QgsFeatureFilterProvider
{
#ifdef SIP_RUN
#include "qgsaccesscontrolfilter.h"
#endif

  public:
    QgsAccessControl()
    {
      mPluginsAccessControls = new QgsAccessControlFilterMap();
      mResolved = false;
    }

    QgsAccessControl( const QgsAccessControl &copy )
    {
      mPluginsAccessControls = new QgsAccessControlFilterMap( *copy.mPluginsAccessControls );
      mFilterFeaturesExpressions = copy.mFilterFeaturesExpressions;
      mResolved = copy.mResolved;
    }


    ~QgsAccessControl() override
    {
      delete mPluginsAccessControls;
    }

    void resolveFilterFeatures( const QList<QgsMapLayer *> &layers );

    void filterFeatures( const QgsVectorLayer *layer, QgsFeatureRequest &filterFeatures ) const override;

    QgsFeatureFilterProvider *clone() const override SIP_FACTORY;

    QString extraSubsetString( const QgsVectorLayer *layer ) const;

    bool layerReadPermission( const QgsMapLayer *layer ) const;

    bool layerInsertPermission( const QgsVectorLayer *layer ) const;

    bool layerUpdatePermission( const QgsVectorLayer *layer ) const;

    bool layerDeletePermission( const QgsVectorLayer *layer ) const;

    QStringList layerAttributes( const QgsVectorLayer *layer, const QStringList &attributes ) const;

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

    bool fillCacheKey( QStringList &cacheKey ) const;

    void registerAccessControl( QgsAccessControlFilter *accessControl, int priority = 0 );

  private:
    QString resolveFilterFeatures( const QgsVectorLayer *layer ) const;

    QgsAccessControlFilterMap *mPluginsAccessControls = nullptr;

    QMap<QString, QString> mFilterFeaturesExpressions;
    bool mResolved;
};

#endif