kacl.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 2005 - 2007 Till Adam <adam@kde.org>

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

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef KACL_H
#define KACL_H


#include <sys/types.h>
#include <kio/global.h>

#include <QtCore/QPair>
#include <QtCore/QList>


typedef QPair<QString, unsigned short> ACLUserPermissions;
typedef QList<ACLUserPermissions> ACLUserPermissionsList;
typedef QList<ACLUserPermissions>::iterator ACLUserPermissionsIterator;
typedef QList<ACLUserPermissions>::const_iterator ACLUserPermissionsConstIterator;

typedef QPair<QString, unsigned short> ACLGroupPermissions;
typedef QList<ACLGroupPermissions> ACLGroupPermissionsList;
typedef QList<ACLGroupPermissions>::iterator ACLGroupPermissionsIterator;
typedef QList<ACLGroupPermissions>::const_iterator ACLGroupPermissionsConstIterator;

class KIO_EXPORT KACL
{
public:
  KACL( const QString & aclString );

  KACL( const KACL& rhs );

  KACL( mode_t basicPermissions );

  KACL();

  virtual ~KACL();

  KACL& operator=( const KACL& rhs );

  bool operator==( const KACL& rhs ) const;

  bool operator!=( const KACL& rhs ) const;

  bool isValid() const;

  unsigned short ownerPermissions() const;

  bool setOwnerPermissions( unsigned short );

  unsigned short owningGroupPermissions() const;

  bool setOwningGroupPermissions( unsigned short );

  unsigned short othersPermissions() const;

  bool setOthersPermissions( unsigned short );

  mode_t basePermissions() const;

  bool isExtended() const;

  unsigned short maskPermissions( bool &exists ) const;

  bool setMaskPermissions( unsigned short );

  unsigned short namedUserPermissions( const QString& name, bool *exists ) const;

  bool setNamedUserPermissions( const QString& name, unsigned short );

  ACLUserPermissionsList allUserPermissions() const;

  bool setAllUserPermissions( const ACLUserPermissionsList &list );

  unsigned short namedGroupPermissions( const QString& name, bool *exists ) const;

  bool setNamedGroupPermissions( const QString& name, unsigned short );

  ACLGroupPermissionsList allGroupPermissions() const;
  bool setAllGroupPermissions( const ACLGroupPermissionsList & );

  bool setACL( const QString &aclStr );

  QString asString() const;

protected:
  virtual void virtual_hook( int id, void* data );
private:
  class KACLPrivate;
  KACLPrivate* const d;
  KIO_EXPORT friend QDataStream & operator<< ( QDataStream & s, const KACL & a );
  KIO_EXPORT friend QDataStream & operator>> ( QDataStream & s, KACL & a );
};

KIO_EXPORT QDataStream & operator<< ( QDataStream & s, const KACL & a );
KIO_EXPORT QDataStream & operator>> ( QDataStream & s, KACL & a );

#endif