kuser.h

Go to the documentation of this file.

/*
 *  KUser - represent a user/account
 *  Copyright (C) 2002-2003 Tim Jansen <tim@tjansen.de>
 *  Copyright (C) 2003 Oswald Buddenhagen <ossi@kde.org>
 *  Copyright (C) 2004 Jan Schaefer <j_schaef@informatik.uni-kl.de>
 *
 *  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 KUSER_H
#define KUSER_H

#include <kdecore_export.h>
#include <ksharedptr.h>

#include <QtCore/QVariant>

class KUserGroup;
class QString;
class QStringList;
template <class T> class QList;

#ifdef Q_OS_WIN
typedef void *K_UID;
typedef void *K_GID;
#else
#include <sys/types.h>
typedef uid_t K_UID;
typedef gid_t K_GID;
struct passwd;
struct group;
#endif


class KDECORE_EXPORT KUser {

public:

  enum UIDMode {
    UseEffectiveUID, 
    UseRealUserID    
  };

  explicit KUser(UIDMode mode = UseEffectiveUID);

  explicit KUser(K_UID uid);

  explicit KUser(const QString& name);

  explicit KUser(const char* name);

#ifndef Q_OS_WIN

  explicit KUser(const passwd *p);
#endif

  KUser(const KUser & user);

  KUser& operator =(const KUser& user);

  bool operator ==(const KUser& user) const;

  bool operator !=(const KUser &user) const;

  bool isValid() const;

  K_UID uid() const;

#ifndef Q_OS_WIN

  K_GID gid() const;
#endif

  bool isSuperUser() const;

  QString loginName() const;

#ifndef KDE_NO_DEPRECATED
  KDE_DEPRECATED QString fullName() const;
#endif

  QString homeDir() const;

  QString faceIconPath() const;

  QString shell() const;

  QList<KUserGroup> groups() const;

  QStringList groupNames() const;

  enum UserProperty { FullName, RoomNumber, WorkPhone, HomePhone };

  QVariant property(UserProperty which) const;

  ~KUser();

  static QList<KUser> allUsers();

  static QStringList allUserNames();

private:
  class Private;
  KSharedPtr<Private> d;
};

class KDECORE_EXPORT KUserGroup {

public:

  explicit KUserGroup(const QString& name);

  explicit KUserGroup(const char *name);

#ifndef Q_OS_WIN

  explicit KUserGroup(KUser::UIDMode mode = KUser::UseEffectiveUID);

  explicit KUserGroup(K_GID gid);

  explicit KUserGroup(const group *g);
#endif

  KUserGroup(const KUserGroup & group);

  KUserGroup& operator =(const KUserGroup& group);

  bool operator ==(const KUserGroup& group) const;

  bool operator !=(const KUserGroup& group) const;

  bool isValid() const;

#ifndef Q_OS_WIN

  K_GID gid() const;
#endif

  QString name() const;

  QList<KUser> users() const;

  QStringList userNames() const;

  ~KUserGroup();

  static QList<KUserGroup> allGroups();

  static QStringList allGroupNames();

private:
  class Private;
  KSharedPtr<Private> d;
};

#endif