home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F277242_apr_user.h < prev    next >
C/C++ Source or Header  |  2004-02-13  |  7KB  |  195 lines
  1. /* Copyright 2000-2004 The Apache Software Foundation
  2.  *
  3.  * Licensed under the Apache License, Version 2.0 (the "License");
  4.  * you may not use this file except in compliance with the License.
  5.  * You may obtain a copy of the License at
  6.  *
  7.  *     http://www.apache.org/licenses/LICENSE-2.0
  8.  *
  9.  * Unless required by applicable law or agreed to in writing, software
  10.  * distributed under the License is distributed on an "AS IS" BASIS,
  11.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12.  * See the License for the specific language governing permissions and
  13.  * limitations under the License.
  14.  */
  15.  
  16. #ifndef APR_USER_H
  17. #define APR_USER_H
  18.  
  19. /**
  20.  * @file apr_user.h
  21.  * @brief APR User ID Services 
  22.  */
  23.  
  24. #include "apr.h"
  25. #include "apr_errno.h"
  26. #include "apr_pools.h"
  27.  
  28. #ifdef __cplusplus
  29. extern "C" {
  30. #endif /* __cplusplus */
  31.  
  32. /**
  33.  * @defgroup apr_user User and Group ID Services
  34.  * @ingroup APR 
  35.  * @{
  36.  */
  37.  
  38. /**
  39.  * Structure for determining user ownership.
  40.  */
  41. #ifdef WIN32
  42. typedef PSID                      apr_uid_t;
  43. #else
  44. typedef uid_t                     apr_uid_t;
  45. #endif
  46.  
  47. /**
  48.  * Structure for determining group ownership.
  49.  */
  50. #ifdef WIN32
  51. typedef PSID                      apr_gid_t;
  52. #else
  53. typedef gid_t                     apr_gid_t;
  54. #endif
  55.  
  56. #if APR_HAS_USER 
  57.  
  58. /**
  59.  * Get the userid (and groupid) of the calling process
  60.  * @param userid   Returns the user id
  61.  * @param groupid  Returns the user's group id
  62.  * @param p The pool from which to allocate working space
  63.  * @remark This function is available only if APR_HAS_USER is defined.
  64.  */
  65. APR_DECLARE(apr_status_t) apr_uid_current(apr_uid_t *userid,
  66.                                           apr_gid_t *groupid,
  67.                                           apr_pool_t *p);
  68.  
  69. /** @deprecated @see apr_uid_current */
  70. APR_DECLARE(apr_status_t) apr_current_userid(apr_uid_t *userid,
  71.                                              apr_gid_t *groupid,
  72.                                              apr_pool_t *p);
  73. /**
  74.  * Get the user name for a specified userid
  75.  * @param username Pointer to new string containing user name (on output)
  76.  * @param userid The userid
  77.  * @param p The pool from which to allocate the string
  78.  * @remark This function is available only if APR_HAS_USER is defined.
  79.  */
  80. APR_DECLARE(apr_status_t) apr_uid_name_get(char **username, apr_uid_t userid,
  81.                                            apr_pool_t *p);
  82.  
  83. /** @deprecated @see apr_uid_name_get */
  84. APR_DECLARE(apr_status_t) apr_get_username(char **username, apr_uid_t userid,
  85.                                            apr_pool_t *p);
  86. /**
  87.  * Get the userid (and groupid) for the specified username
  88.  * @param userid   Returns the user id
  89.  * @param groupid  Returns the user's group id
  90.  * @param username The username to lookup
  91.  * @param p The pool from which to allocate working space
  92.  * @remark This function is available only if APR_HAS_USER is defined.
  93.  */
  94. APR_DECLARE(apr_status_t) apr_uid_get(apr_uid_t *userid, apr_gid_t *groupid,
  95.                                       const char *username, apr_pool_t *p);
  96.  
  97. /** @deprecated @see apr_uid_get */
  98. APR_DECLARE(apr_status_t) apr_get_userid(apr_uid_t *userid, apr_gid_t *groupid,
  99.                                          const char *username, apr_pool_t *p);
  100.  
  101. /**
  102.  * Get the home directory for the named user
  103.  * @param dirname Pointer to new string containing directory name (on output)
  104.  * @param username The named user
  105.  * @param p The pool from which to allocate the string
  106.  * @remark This function is available only if APR_HAS_USER is defined.
  107.  */
  108. APR_DECLARE(apr_status_t) apr_uid_homepath_get(char **dirname, 
  109.                                                const char *username, 
  110.                                                apr_pool_t *p);
  111.  
  112. /** @deprecated @see apr_uid_homepath_get */
  113. APR_DECLARE(apr_status_t) apr_get_home_directory(char **dirname, 
  114.                                                  const char *username, 
  115.                                                  apr_pool_t *p);
  116.  
  117. /**
  118.  * Compare two user identifiers for equality.
  119.  * @param left One uid to test
  120.  * @param right Another uid to test
  121.  * @return APR_SUCCESS if the apr_uid_t strutures identify the same user,
  122.  * APR_EMISMATCH if not, APR_BADARG if an apr_uid_t is invalid.
  123.  * @remark This function is available only if APR_HAS_USER is defined.
  124.  */
  125. #if defined(WIN32)
  126. APR_DECLARE(apr_status_t) apr_uid_compare(apr_uid_t left, apr_uid_t right);
  127.  
  128. /** @deprecated @see apr_uid_compare */
  129. APR_DECLARE(apr_status_t) apr_compare_users(apr_uid_t left, apr_uid_t right);
  130. #else
  131. #define apr_uid_compare(left,right) (((left) == (right)) ? APR_SUCCESS : APR_EMISMATCH)
  132. /** @deprecated @see apr_uid_compare */
  133. #define apr_compare_users(left,right) (((left) == (right)) ? APR_SUCCESS : APR_EMISMATCH)
  134. #endif
  135.  
  136. /**
  137.  * Get the group name for a specified groupid
  138.  * @param groupname Pointer to new string containing group name (on output)
  139.  * @param groupid The groupid
  140.  * @param p The pool from which to allocate the string
  141.  * @remark This function is available only if APR_HAS_USER is defined.
  142.  */
  143. APR_DECLARE(apr_status_t) apr_gid_name_get(char **groupname, 
  144.                                              apr_gid_t groupid, apr_pool_t *p);
  145.  
  146. /** @deprecated @see apr_gid_name_get */
  147. APR_DECLARE(apr_status_t) apr_group_name_get(char **groupname, 
  148.                                              apr_gid_t groupid, apr_pool_t *p);
  149.  
  150. /** @deprecated @see apr_gid_name_get */
  151. APR_DECLARE(apr_status_t) apr_get_groupname(char **groupname, 
  152.                                             apr_gid_t groupid, apr_pool_t *p);
  153.  
  154. /**
  155.  * Get the groupid for a specified group name
  156.  * @param groupid Pointer to the group id (on output)
  157.  * @param groupname The group name to look up
  158.  * @param p The pool from which to allocate the string
  159.  * @remark This function is available only if APR_HAS_USER is defined.
  160.  */
  161. APR_DECLARE(apr_status_t) apr_gid_get(apr_gid_t *groupid, 
  162.                                       const char *groupname, apr_pool_t *p);
  163.  
  164. /** @deprecated @see apr_gid_get */
  165. APR_DECLARE(apr_status_t) apr_get_groupid(apr_gid_t *groupid, 
  166.                                           const char *groupname, apr_pool_t *p);
  167.  
  168. /**
  169.  * Compare two group identifiers for equality.
  170.  * @param left One gid to test
  171.  * @param right Another gid to test
  172.  * @return APR_SUCCESS if the apr_gid_t strutures identify the same group,
  173.  * APR_EMISMATCH if not, APR_BADARG if an apr_gid_t is invalid.
  174.  * @remark This function is available only if APR_HAS_USER is defined.
  175.  */
  176. #if defined(WIN32)
  177. APR_DECLARE(apr_status_t) apr_gid_compare(apr_gid_t left, apr_gid_t right);
  178. /** @deprecated @see apr_gid_compare */
  179. APR_DECLARE(apr_status_t) apr_compare_groups(apr_gid_t left, apr_gid_t right);
  180. #else
  181. #define apr_gid_compare(left,right) (((left) == (right)) ? APR_SUCCESS : APR_EMISMATCH)
  182. /** @deprecated @see apr_gid_compare */
  183. #define apr_compare_groups(left,right) (((left) == (right)) ? APR_SUCCESS : APR_EMISMATCH)
  184. #endif
  185.  
  186. #endif  /* ! APR_HAS_USER */
  187.  
  188. /** @} */
  189.  
  190. #ifdef __cplusplus
  191. }
  192. #endif
  193.  
  194. #endif  /* ! APR_USER_H */
  195.