extensions/source/config/ldap/ldapuserprofilelayer.cxx

   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: ldapuserprofilelayer.cxx,v $
  10  * $Revision: 1.8 $
  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 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_extensions.hxx"
  33 #include "ldapuserprofilelayer.hxx"
  34 #include <com/sun/star/configuration/backend/PropertyInfo.hpp>
  35 #include <com/sun/star/configuration/backend/ConnectionLostException.hpp>
  36 #ifndef _COM_SUN_STAR_BEANS_PROPERTYATTRIBUTE_HPP_
  37 // on windows this is defined indirectly by <ldap.h>
  38 #undef OPTIONAL
  39 #include <com/sun/star/beans/PropertyAttribute.hpp>
  40 #endif
  41 #include <rtl/ustrbuf.hxx>
  42 #include <com/sun/star/uno/Sequence.hxx>
  43
  44 //==============================================================================
  45 namespace extensions { namespace config { namespace ldap {
  46
  47 static const sal_Unicode kPathSeparator = '/' ;
  48
  49 static
  50 uno::Reference<backend::XLayerContentDescriber>
  51     newLayerDescriber(const uno::Reference<lang::XMultiServiceFactory>& xFactory)
  52 {
  53     typedef uno::Reference<backend::XLayerContentDescriber> LayerDescriber;
  54
  55     rtl::OUString const k_sLayerDescriberService (
  56         RTL_CONSTASCII_USTRINGPARAM("com.sun.star.comp.configuration.backend.LayerDescriber"));
  57
  58     LayerDescriber xResult(xFactory->createInstance(k_sLayerDescriberService), uno::UNO_QUERY_THROW);
  59     return xResult;
  60 }
  61 //------------------------------------------------------------------------------
  62
  63 void LdapUserProfileSource::getUserProfile(const rtl::OUString & aUser, LdapUserProfile & aProfile)
  64 {
  65     mConnection.getUserProfile(aUser,
  66                                mProfileMap,
  67                                aProfile);
  68 }
  69
  70 rtl::OUString LdapUserProfileSource::getComponentName() const
  71 {
  72     return mProfileMap.getComponentName();
  73 }
  74
  75 rtl::OUString LdapUserProfileSource::getConfigurationBasePath() const
  76 {
  77     rtl::OUStringBuffer sComponentNameBuffer(mProfileMap.getComponentName());
  78     sComponentNameBuffer.append(kPathSeparator);
  79     sComponentNameBuffer.append (mProfileMap.getGroupName());
  80     sComponentNameBuffer.append(kPathSeparator);
  81
  82     return sComponentNameBuffer.makeStringAndClear();
  83 }
  84 //------------------------------------------------------------------------------
  85
  86 struct LdapUserProfileLayer::ProfileData
  87 {
  88     LdapUserProfile mProfile;
  89     rtl::OUString mBasePath;
  90
  91     explicit ProfileData(LdapUserProfileSource & aSource, const rtl::OUString & aUser)
  92     {
  93         aSource.getUserProfile(aUser, mProfile);
  94         mBasePath = aSource.getConfigurationBasePath();
  95     }
  96 };
  97 //------------------------------------------------------------------------------
  98
  99 LdapUserProfileLayer::LdapUserProfileLayer(
 100     const uno::Reference<lang::XMultiServiceFactory>& xFactory,
 101     const rtl::OUString& aUser,
 102     const LdapUserProfileSourceRef & aUserProfileSource,
 103     const rtl::OUString& aTimestamp)
 104 : mLayerDescriber( newLayerDescriber(xFactory) )
 105 , mSource( aUserProfileSource )
 106 , mUser(aUser)
 107 , mTimestamp(aTimestamp)
 108 , mProfile( 0 )
 109 {
 110     OSL_ASSERT(mSource.is());
 111 }
 112
 113 //------------------------------------------------------------------------------
 114 LdapUserProfileLayer::~LdapUserProfileLayer()
 115 {
 116     delete mProfile;
 117 }
 118 //------------------------------------------------------------------------------
 119
 120 #define PROPNAME( name ) rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( name ) )
 121 #define PROPTYPE( type ) getCppuType( static_cast< type const *>( 0 ) )
 122
 123 const sal_Int32 LAYER_PROPERTY_URL = 1;
 124
 125 cppu::IPropertyArrayHelper * SAL_CALL LdapUserProfileLayer::newInfoHelper()
 126 {
 127     using com::sun::star::beans::Property;
 128     using namespace com::sun::star::beans::PropertyAttribute;
 129
 130     Property properties[] =
 131     {
 132         Property(PROPNAME("URL"), LAYER_PROPERTY_URL, PROPTYPE(rtl::OUString), READONLY)
 133     };
 134
 135     return new cppu::OPropertyArrayHelper(properties, sizeof(properties)/sizeof(properties[0]));
 136 }
 137 //------------------------------------------------------------------------------
 138
 139 void SAL_CALL LdapUserProfileLayer::getFastPropertyValue( uno::Any& rValue, sal_Int32 nHandle ) const
 140 {
 141     switch (nHandle)
 142     {
 143     case LAYER_PROPERTY_URL:
 144         {
 145             rtl::OUStringBuffer aURL;
 146             aURL.appendAscii("ldap-user-profile:");
 147             aURL.append(mUser);
 148             aURL.append(sal_Unicode('@'));
 149             if (mSource.is())
 150                 aURL.append(mSource->getComponentName());
 151             else
 152                 aURL.appendAscii("<NULL>");
 153
 154             rValue <<= aURL.makeStringAndClear();
 155         }
 156         break;
 157
 158     default:
 159         OSL_ENSURE(false, "Error: trying to get an UNKNOWN property");
 160         break;
 161     }
 162 }
 163 //------------------------------------------------------------------------------
 164
 165 bool LdapUserProfileLayer::readProfile()
 166 {
 167     if (mSource.is())
 168     try
 169     {
 170         OSL_ASSERT(!mProfile);
 171         mProfile = new ProfileData(*mSource,mUser);
 172
 173         mSource.clear();
 174     }
 175     catch (ldap::LdapConnectionException & e)
 176     {
 177         // without existing Ldap Connection we should never have gotten a timestamp
 178         OSL_ENSURE(false, "Unexpected: Have Ldap Backedn Layer but no vaild LDAP connection ?!");
 179         throw backend::ConnectionLostException(e.Message, *this, uno::makeAny(e) );
 180     }
 181     catch (ldap::LdapGenericException & e)
 182     {
 183         throw backend::BackendAccessException(e.Message, *this, uno::makeAny(e) );
 184     }
 185     OSL_ASSERT( !mSource.is() );
 186     OSL_ASSERT( mProfile != 0 );
 187     return mProfile != 0;
 188 }
 189 //------------------------------------------------------------------------------
 190
 191 void SAL_CALL LdapUserProfileLayer::readData(
 192     const uno::Reference<backend::XLayerHandler>& xHandler)
 193     throw ( backend::MalformedDataException,
 194             lang::NullPointerException,
 195             lang::WrappedTargetException,
 196             uno::RuntimeException)
 197 {
 198     std::vector<backend::PropertyInfo> aPropList;
 199 #ifdef SUPPRESS_BACKEND_ERRORS
 200     try
 201 #endif
 202     if ( readProfile() )
 203     {
 204         // initialize PropInfo members that are the same for all settings
 205         const rtl::OUString k_sTypeString(RTL_CONSTASCII_USTRINGPARAM("string"));
 206
 207         backend::PropertyInfo aPropInfo;
 208         aPropInfo.Type = k_sTypeString;
 209         aPropInfo.Protected = sal_False;
 210
 211         LdapUserProfile * pProfile = &mProfile->mProfile;
 212         aPropList.reserve(pProfile->mProfile.size());
 213
 214         for (LdapUserProfile::Iterator entry = pProfile->mProfile.begin() ;
 215              entry != pProfile->mProfile.end() ; ++ entry)
 216         {
 217             if (entry->mAttribute.getLength()==0) { continue ; }
 218             if (entry->mValue.getLength()==0) { continue ; }
 219
 220             aPropInfo.Name = mProfile->mBasePath + entry->mAttribute;
 221             aPropInfo.Value <<= entry->mValue;
 222
 223             aPropList.push_back(aPropInfo);
 224         }
 225     }
 226 #ifdef SUPPRESS_BACKEND_ERRORS
 227     catch (uno::Exception & e)
 228     {
 229         OSL_TRACE("LDAP Backend - Reading data from LDAP failed: %s\n",
 230                   rtl::OUStringToOString( e.Message, RTL_TEXTENCODING_ASCII_US ).getStr() );
 231     }
 232 #endif
 233
 234     if ( !aPropList.empty())
 235     {
 236         //Describe UserProfileLayer (the list of properties) to the XHandler
 237         //Object using com.sun.star.comp.backend.LayerContentDescriber Service
 238         uno::Sequence<backend::PropertyInfo> aPropInfoList(&aPropList.front(),aPropList.size());
 239
 240         mLayerDescriber->describeLayer(xHandler, aPropInfoList);
 241     }
 242     // else { check handler not NULL; xHandler->startLayer(); xHandler->endLayer(); }
 243 }
 244 //------------------------------------------------------------------------------
 245 }}}
 246 //------------------------------------------------------------------------------
 247