src/UserInfo.hpp

   1 /*
   2     suPHP - (c)2002-2008 Sebastian Marsching <sebastian@marsching.com>
   3
   4     This file is part of suPHP.
   5
   6     suPHP is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     suPHP is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with suPHP; if not, write to the Free Software
  18     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19 */
  20
  21 #ifndef SUPHP_USERINFO_H
  22
  23 namespace suPHP {
  24     class UserInfo;
  25 };
  26
  27 #define SUPHP_USERINFO_H
  28
  29 #include <string>
  30 #include <vector>
  31
  32 #include "LookupException.hpp"
  33 #include "GroupInfo.hpp"
  34
  35 namespace suPHP {
  36     /**
  37      * Class encapsulating user information.
  38      */
  39     class UserInfo {
  40     private:
  41         int uid;
  42     public:
  43         /**
  44          * Constructor without arguments.
  45          * Does not create a "valid" object, since it has no well defined UID
  46          */
  47         UserInfo();
  48
  49         /**
  50          * Constructor (takes UID)
  51          */
  52         UserInfo(int uid);
  53
  54         /**
  55          * Returns username
  56          */
  57         std::string getUsername() const throw (LookupException);
  58
  59         /**
  60          * Returns UID
  61          */
  62         int getUid() const;
  63
  64         /**
  65          * Returns primary group
  66          */
  67         GroupInfo getGroupInfo() const throw (LookupException);
  68
  69         /**
  70          * Returns home directory
  71          */
  72         std::string getHomeDirectory() const throw (LookupException);
  73
  74         /**
  75          * Checks wheter user is super-user
  76          */
  77         bool isSuperUser();
  78
  79         /**
  80          * Compares to UserInfo objects for equality (same UID)
  81          */
  82         bool operator==(const UserInfo& uinfo) const;
  83
  84         /**
  85          * Overloaded operator
  86          */
  87         bool operator!=(const UserInfo& uinfo) const;
  88
  89     };
  90 };
  91
  92 #endif // SUPHP_USERINFO_H