Cutelyst::StoreHtpasswd Class Reference

Authentication data store using a flat file. More...

#include <Cutelyst/Plugins/Authentication/htpasswd.h>

Inheritance diagram for Cutelyst::StoreHtpasswd:

Public Member Functions
	StoreHtpasswd (const QString &name)
virtual	~StoreHtpasswd () override
void	addUser (const ParamsMultiMap &user)
AuthenticationUser	findUser (Context *c, const ParamsMultiMap &userInfo) override final
QVariant	forSession (Context *c, const AuthenticationUser &user) override final
AuthenticationUser	fromSession (Context *c, const QVariant &frozenUser) override final
Public Member Functions inherited from Cutelyst::AuthenticationStore
	AuthenticationStore ()
virtual	~AuthenticationStore ()
virtual AuthenticationUser	autoCreateUser (Context *c, const ParamsMultiMap &userinfo) const
virtual AuthenticationUser	autoUpdateUser (Context *c, const ParamsMultiMap &userinfo) const
virtual bool	canAutoCreateUser () const
virtual bool	canAutoUpdateUser () const

Detailed Description

This authentication data store stores user data as a combination of username:password in a flat file where each row contains one user. This is like the file created by Apache’s htpasswd command.

Definition at line 20 of file htpasswd.h.

Constructor & Destructor Documentation

StoreHtpasswd()

StoreHtpasswd::StoreHtpasswd ( const QString &  name )

explicit

Constructs a new StoreHtpasswd object with the given file name.

Definition at line 18 of file htpasswd.cpp.

~StoreHtpasswd()

StoreHtpasswd::~StoreHtpasswd ( )

overridevirtual

Destroys the StoreHtpasswd object.

Definition at line 23 of file htpasswd.cpp.

Member Function Documentation

addUser()

void StoreHtpasswd::addUser

(

const ParamsMultiMap &

user

)

Appends the user to htpasswd storage

Definition at line 27 of file htpasswd.cpp.

References QFileDevice::atEnd(), QFileDevice::close(), QFile::exists(), QList::first(), QTemporaryFile::open(), QFile::open(), QIODevice::readLine(), QIODeviceBase::ReadWrite, QFile::remove(), QTemporaryFile::rename(), QTemporaryFile::setAutoRemove(), QList::size(), QByteArray::split(), QIODeviceBase::Text, QString::toLatin1(), QMultiMap::value(), and QIODevice::write().

findUser()

AuthenticationUser StoreHtpasswd::findUser ( Context *  c, const ParamsMultiMap &  userInfo  )

finaloverridevirtual

Reimplemented from AuthenticationStore::findUser().

Implements Cutelyst::AuthenticationStore.

Definition at line 70 of file htpasswd.cpp.

References QList::at(), QFileDevice::atEnd(), QList::first(), QString::fromLatin1(), Cutelyst::AuthenticationUser::insert(), QFile::open(), QIODevice::readLine(), QIODeviceBase::ReadOnly, QByteArray::replace(), Cutelyst::AuthenticationUser::setId(), QList::size(), QByteArray::split(), QIODeviceBase::Text, QString::toLatin1(), QByteArray::trimmed(), and QMultiMap::value().

Referenced by fromSession().

forSession()

QVariant StoreHtpasswd::forSession ( Context *  c, const AuthenticationUser &  user  )

finaloverridevirtual

Reimplemented from AuthenticationStore::forSession().

Reimplemented from Cutelyst::AuthenticationStore.

Definition at line 94 of file htpasswd.cpp.

References Cutelyst::AuthenticationUser::id().

fromSession()

AuthenticationUser StoreHtpasswd::fromSession ( Context *  c, const QVariant &  frozenUser  )

finaloverridevirtual

Reimplemented from AuthenticationStore::fromSession().

Reimplemented from Cutelyst::AuthenticationStore.

Definition at line 100 of file htpasswd.cpp.

References findUser(), and QVariant::toString().