extensions/source/config/ldap/ldapuserprof.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ldapuserprof.hxx,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef EXTENSIONS_CONFIG_LDAP_LDAPUSERPROF_HXX_
  32 #define EXTENSIONS_CONFIG_LDAP_LDAPUSERPROF_HXX_
  33
  34 #include "wrapldapinclude.hxx"
  35 #include <rtl/ustring.hxx>
  36 #include <rtl/string.hxx>
  37
  38 #ifndef VECTOR_INCLUDED
  39 #define VECTOR_INCLUDED
  40 #include <vector>
  41 #endif // VECTOR_INCLUDED
  42
  43 #ifndef SET_INCLUDED
  44 #define SET_INCLUDED
  45 #include <set>
  46 #endif // SET_INCLUDED
  47
  48
  49 namespace extensions { namespace config { namespace ldap {
  50
  51 /** Struct containing the data associated to a UserProfile */
  52 struct LdapUserProfile {
  53     /** Struct defining an entry in the profile */
  54     struct ProfileEntry {
  55         rtl::OUString mAttribute ;
  56         rtl::OUString mValue ;
  57     } ;
  58     /** List of attribute/value pairs */
  59     std::vector<ProfileEntry> mProfile ;
  60
  61     typedef std::vector<ProfileEntry>::const_iterator Iterator;
  62 } ;
  63
  64 /** Provider of UserProfile mapping services */
  65 class LdapUserProfileMap
  66 {
  67     public :
  68         /** Default constructor, doesn't do much. */
  69         LdapUserProfileMap() : mAttributes(NULL) {}
  70         /** Destructor */
  71         ~LdapUserProfileMap() ;
  72
  73         /**
  74           Fills the map using a string description of the mapping.
  75           Each possible UserProfile attribute is mapped to a list
  76           of LDAP attributes, in order of priority.
  77           The entry is formatted as:
  78           <UP Attribute>=<LDAP Attr1>,...,<LDAP AttrN>
  79
  80           @param aMap   string description of the mapping
  81           */
  82         void source(const rtl::OString& aMap) ;
  83         /**
  84           Returns an array of all the LDAP attribute names that may
  85           be relevant for UserProfile mapping.
  86
  87           @return   array of LDAP attribute names
  88           */
  89         const sal_Char **getLdapAttributes(void) const { return mAttributes ; }
  90           /**
  91           Returns the component name that holds the data
  92           when presented to the outside.
  93
  94           @return component name
  95           */
  96         const rtl::OUString& getComponentName(void) const {
  97             return mComponentName ;
  98         }
  99         /**
 100           Returns the group name that holds the data when
 101           presented to the outside world.
 102
 103           @return   group name
 104           */
 105         const rtl::OUString& getGroupName(void) const {
 106             return mGroupName ;
 107         }
 108         /**
 109           Struct defining the mapping between UserProfile attributes
 110           and LDAP ones. It also serves as a crude "schema" of the
 111           UserProfile component, as the list of profile elements
 112           is the list of properties in the component and the presence
 113           or absence of LDAP mapping indicates whether the property
 114           should be made writable or kept read-only.
 115           */
 116         struct Mapping {
 117             /** Name of the UserProfile element */
 118             rtl::OString mProfileElement ;
 119             /** Corresponding LDAP attributes in order of priority */
 120             std::vector<rtl::OString> mLdapAttributes ;
 121
 122             /** Utility to fill the mapping from a <Prof>=<Ldap1>;...;<LdapN>
 123                 description */
 124             sal_Bool parse(const rtl::OString& aDescription) ;
 125         } ;
 126
 127
 128         /**
 129           Maps an LDAP entry to a UserProfile.
 130
 131           @param aConnection    LDAP connection to the repository
 132           @param aEntry         entry containing the data
 133           @param aProfile       user profile struct to fill up
 134           */
 135         void ldapToUserProfile(LDAP *aConnection,
 136                                LDAPMessage *aEntry,
 137                                LdapUserProfile& aProfile) const ;
 138
 139     private :
 140         /** Contains the mapping entries */
 141         std::vector<Mapping> mMapping ;
 142         /** Contains the LDAP attributes used in a NULL terminated array */
 143         const sal_Char **mAttributes ;
 144         /** User profile component name */
 145         rtl::OUString mComponentName ;
 146         /** User profile storage group name */
 147         rtl::OUString mGroupName ;
 148
 149         /**
 150           Adds a new mapping entry to the list, and collects the
 151           LDAP attributes involved in the mapping.
 152
 153           @param aMappingDescription    string describing the mapping
 154           @param aLdapAttributes        collection of LDAP attributes
 155           @param aPrefix                common prefix to the attributes
 156                                         containing the component and group
 157                                         name, used for validation
 158          */
 159         void addNewMapping(const rtl::OString& aMappingDescription,
 160                            std::set<rtl::OString>& aLdapAttributes,
 161                            rtl::OString& aPrefix) ;
 162 } ;
 163
 164 } } } // extensions.config.ldap
 165
 166 #endif // EXTENSIONS_CONFIG_LDAP_LDAPUSERPROF_HXX_