kacl.h

/* This file is part of the KDE project
   Copyright (C) 2005 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 <tdeio/global.h>
 
typedef TQPair<TQString, unsigned short> ACLUserPermissions;
typedef TQValueList<ACLUserPermissions> ACLUserPermissionsList;
typedef TQValueListIterator<ACLUserPermissions> ACLUserPermissionsIterator;
typedef TQValueListConstIterator<ACLUserPermissions> ACLUserPermissionsConstIterator;
 
typedef TQPair<TQString, unsigned short> ACLGroupPermissions;
typedef TQValueList<ACLGroupPermissions> ACLGroupPermissionsList;
typedef TQValueListIterator<ACLGroupPermissions> ACLGroupPermissionsIterator;
typedef TQValueListConstIterator<ACLGroupPermissions> ACLGroupPermissionsConstIterator;

class TDEIO_EXPORT KACL
{
public:
  KACL( const TQString & aclString );

  KACL( const KACL& rhs );

  KACL( mode_t basicPermissions );

  KACL();
 
  virtual ~KACL();
 
  KACL& operator=( const KACL& rhs ) { 
    if ( this != &rhs )
      setACL( rhs.asString() );
    return *this;
  }
 
  bool operator==( const KACL& rhs ) const;
 
  bool operator!=( const KACL& rhs ) const {
    return !operator==( rhs );
  }

  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 TQString& name, bool *exists ) const;
 

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

  ACLUserPermissionsList allUserPermissions() const;

  bool setAllUserPermissions( const ACLUserPermissionsList &list );

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

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

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

  bool setACL( const TQString &aclStr );

  TQString asString() const;
 
protected:
  virtual void virtual_hook( int id, void* data );
private:
  class KACLPrivate;
  KACLPrivate * d;
  TDEIO_EXPORT friend TQDataStream & operator<< ( TQDataStream & s, const KACL & a );
  TDEIO_EXPORT friend TQDataStream & operator>> ( TQDataStream & s, KACL & a );
};
 
TDEIO_EXPORT TQDataStream & operator<< ( TQDataStream & s, const KACL & a );
TDEIO_EXPORT TQDataStream & operator>> ( TQDataStream & s, KACL & a );
 
#endif