connectivity/source/drivers/mozab/mozillasrc/MLdapAttributeMap.cxx

   1 /*************************************************************************
   2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   3 *
   4 * Copyright 2008 by Sun Microsystems, Inc.
   5 *
   6 * OpenOffice.org - a multi-platform office productivity suite
   7 *
   8 * $RCSfile: code,v $
   9 *
  10 * $Revision: 1.3 $
  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 // MARKER(update_precomp.py): autogen include statement, do not remove
  31 #include "precompiled_connectivity.hxx"
  32
  33 #include <rtl/strbuf.hxx>
  34     // keep this include at the beginning. Some of the other includes seems to inject a symbol "l" into the
  35     // global namespace, which leads to a compiler warning in strbuf.hxx, about some parameters named "l"
  36     // hiding objects "in an outer scope".
  37
  38 #include "MLdapAttributeMap.hxx"
  39 #include "MTypeConverter.hxx"
  40 #include "MQueryHelper.hxx"
  41
  42 #include <tools/diagnose_ex.h>
  43
  44 #include <hash_map>
  45
  46 //........................................................................
  47 namespace connectivity { namespace mozab {
  48 //........................................................................
  49
  50     //====================================================================
  51     //= helper
  52     //====================================================================
  53     namespace
  54     {
  55         typedef nsresult (NS_STDCALL nsIAbCard::*CardPropertyGetter)( PRUnichar** aFirstName );
  56         typedef nsresult (NS_STDCALL nsIAbCard::*CardPropertySetter)( const PRUnichar* aFirstName );
  57         struct CardPropertyData
  58         {
  59             const sal_Char*     pLDAPAttributeList;
  60             CardPropertyGetter  PropGetter;
  61             CardPropertySetter  PropSetter;
  62
  63             CardPropertyData()
  64                 :pLDAPAttributeList( NULL )
  65                 ,PropGetter( NULL )
  66                 ,PropSetter( NULL )
  67             {
  68             }
  69             CardPropertyData( const sal_Char* _pLDAPAttributeList, CardPropertyGetter _PropGetter, CardPropertySetter _PropSetter )
  70                 :pLDAPAttributeList( _pLDAPAttributeList )
  71                 ,PropGetter( _PropGetter )
  72                 ,PropSetter( _PropSetter )
  73             {
  74             }
  75         };
  76
  77         typedef ::std::hash_map< ::rtl::OString, CardPropertyData, ::rtl::OStringHash > MapPropertiesToAttributes;
  78
  79         #define DEF_CARD_ACCESS( PropertyName ) \
  80             &nsIAbCard::Get##PropertyName, &nsIAbCard::Set##PropertyName
  81
  82         static const MapPropertiesToAttributes& lcl_getPropertyMap()
  83         {
  84             static MapPropertiesToAttributes aMap;
  85             if ( aMap.empty() )
  86             {
  87                 struct MapEntry
  88                 {
  89                     const sal_Char*     pAsciiPropertyName;
  90                     const sal_Char*     pAsciiAttrributeList;
  91                     CardPropertyGetter  PropGetter;
  92                     CardPropertySetter  PropSetter;
  93                 };
  94                 const MapEntry aEntries[] = {
  95                     { "FirstName",          "givenname",                                    DEF_CARD_ACCESS( FirstName ) },
  96                     { "LastName",           "sn,surnname",                                  DEF_CARD_ACCESS( LastName ) },
  97                     { "DisplayName",        "cn,commonname,displayname",                    DEF_CARD_ACCESS( DisplayName ) },
  98                     { "NickName",           "xmozillanickname",                             DEF_CARD_ACCESS( NickName ) },
  99                     { "PrimaryEmail",       "mail",                                         DEF_CARD_ACCESS( PrimaryEmail ) },
 100                     { "SecondEmail",        "xmozillasecondemail",                          DEF_CARD_ACCESS( SecondEmail ) },
 101                     { "WorkPhone",          "telephonenumber",                              DEF_CARD_ACCESS( WorkPhone ) },
 102                     { "HomePhone",          "homephone",                                    DEF_CARD_ACCESS( HomePhone ) },
 103                     { "FaxNumber",          "fax,facsimiletelephonenumber",                 DEF_CARD_ACCESS( FaxNumber ) },
 104                     { "PagerNumber",        "pager,pagerphone",                             DEF_CARD_ACCESS( PagerNumber ) },
 105                     { "CellularNumber",     "mobile,cellphone,carphone",                    DEF_CARD_ACCESS( CellularNumber ) },
 106                     { "HomeAddress",        "homepostaladdress,mozillaHomeStreet",          DEF_CARD_ACCESS( HomeAddress ) },
 107                     { "HomeAddress2",       "mozillaHomeStreet2",                           DEF_CARD_ACCESS( HomeAddress2 ) },
 108                     { "HomeCity",           "homelocality,mozillaHomeLocalityName",         DEF_CARD_ACCESS( HomeCity ) },
 109                     { "HomeState",          "homeregion,mozillaHomeState",                  DEF_CARD_ACCESS( HomeState ) },
 110                     { "HomeZipCode",        "homepostalcode,mozillaHomePostalCode",         DEF_CARD_ACCESS( HomeZipCode ) },
 111                     { "HomeCountry",        "homecountryname,mozillaHomeCountryName",       DEF_CARD_ACCESS( HomeCountry ) },
 112                     { "WorkAddress",        "postofficebox,streetaddress,streetaddress1",   DEF_CARD_ACCESS( WorkAddress ) },
 113                     { "WorkAddress2",       "streetaddress2",                               DEF_CARD_ACCESS( WorkAddress2 ) },
 114                     { "WorkCity",           "l,locality",                                   DEF_CARD_ACCESS( WorkCity ) },
 115                     { "WorkState",          "st,region",                                    DEF_CARD_ACCESS( WorkState ) },
 116                     { "WorkZipCode",        "postalcode,zip",                               DEF_CARD_ACCESS( WorkZipCode ) },
 117                     { "WorkCountry",        "countryname",                                  DEF_CARD_ACCESS( WorkCountry ) },
 118                     { "JobTitle",           "title",                                        DEF_CARD_ACCESS( JobTitle ) },
 119                     { "Department",         "ou,orgunit,department,departmentnumber",       DEF_CARD_ACCESS( Department ) },
 120                     { "Company",            "o,company",                                    DEF_CARD_ACCESS( Company ) },
 121                     { "WebPage1",           "workurl",                                      DEF_CARD_ACCESS( WebPage1 ) },
 122                     { "WebPage2",           "homeurl",                                      DEF_CARD_ACCESS( WebPage2 ) },
 123                     { "BirthYear",          "birthyear",                                    DEF_CARD_ACCESS( BirthYear ) },
 124                     { "BirthMonth",         "birthmonth",                                   DEF_CARD_ACCESS( BirthMonth ) },
 125                     { "BirthYear",          "birthday",                                     DEF_CARD_ACCESS( BirthDay ) },
 126                     { "Custom1",            "custom1",                                      DEF_CARD_ACCESS( Custom1 ) },
 127                     { "Custom2",            "custom2",                                      DEF_CARD_ACCESS( Custom2 ) },
 128                     { "Custom3",            "custom3",                                      DEF_CARD_ACCESS( Custom3 ) },
 129                     { "Custom4",            "custom4",                                      DEF_CARD_ACCESS( Custom4 ) },
 130                     { "Notes",              "notes,description",                            DEF_CARD_ACCESS( Notes ) },
 131                     { "PreferMailFormat",   "xmozillausehtmlmail",                          NULL, NULL },
 132                     { NULL, NULL, NULL, NULL }
 133                 };
 134                 const MapEntry* loop = aEntries;
 135                 while ( loop->pAsciiPropertyName )
 136                 {
 137                     aMap[ ::rtl::OString( loop->pAsciiPropertyName ) ] =
 138                         CardPropertyData( loop->pAsciiAttrributeList, loop->PropGetter, loop->PropSetter );
 139                     ++loop;
 140                 }
 141             }
 142             return aMap;
 143         }
 144     }
 145
 146     //====================================================================
 147     //= AttributeMap_Data
 148     //====================================================================
 149     struct AttributeMap_Data
 150     {
 151     };
 152
 153     //====================================================================
 154     //= MLdapAttributeMap
 155     //====================================================================
 156     // -------------------------------------------------------------------
 157     MLdapAttributeMap::MLdapAttributeMap()
 158         :m_pData( new AttributeMap_Data )
 159     {
 160     }
 161
 162     // -------------------------------------------------------------------
 163     MLdapAttributeMap::~MLdapAttributeMap()
 164     {
 165     }
 166
 167     // -------------------------------------------------------------------
 168     NS_IMPL_THREADSAFE_ISUPPORTS1( MLdapAttributeMap, nsIAbLDAPAttributeMap )
 169
 170     // -------------------------------------------------------------------
 171     NS_IMETHODIMP MLdapAttributeMap::GetAttributeList(const nsACString & aProperty, nsACString & _retval)
 172     {
 173         ::rtl::OString sProperty( MTypeConverter::nsACStringToOString( aProperty ) );
 174
 175         const MapPropertiesToAttributes& rPropertyMap( lcl_getPropertyMap() );
 176         MapPropertiesToAttributes::const_iterator pos = rPropertyMap.find( sProperty );
 177
 178         if ( pos == rPropertyMap.end() )
 179         {
 180             _retval.SetIsVoid( PR_TRUE );
 181         }
 182         else
 183         {
 184             MTypeConverter::asciiToNsACString( pos->second.pLDAPAttributeList, _retval );
 185         }
 186
 187         return NS_OK;
 188     }
 189
 190     // -------------------------------------------------------------------
 191     NS_IMETHODIMP MLdapAttributeMap::GetAttributes(const nsACString & aProperty, PRUint32* aCount, char*** aAttrs)
 192     {
 193         OSL_ENSURE( false, "MLdapAttributeMap::GetAttributes: not implemented!" );
 194         (void)aProperty;
 195         (void)aCount;
 196         (void)aAttrs;
 197         return NS_ERROR_NOT_IMPLEMENTED;
 198     }
 199
 200     // -------------------------------------------------------------------
 201     NS_IMETHODIMP MLdapAttributeMap::GetFirstAttribute(const nsACString & aProperty, nsACString & _retval)
 202     {
 203         ::rtl::OString sProperty( MTypeConverter::nsACStringToOString( aProperty ) );
 204
 205         const MapPropertiesToAttributes& rPropertyMap( lcl_getPropertyMap() );
 206         MapPropertiesToAttributes::const_iterator pos = rPropertyMap.find( sProperty );
 207
 208         if ( pos == rPropertyMap.end() )
 209         {
 210             _retval.SetIsVoid( PR_TRUE );
 211         }
 212         else
 213         {
 214             sal_Int32 tokenPos(0);
 215             ::rtl::OString sAttributeList( pos->second.pLDAPAttributeList );
 216             MTypeConverter::asciiToNsACString( sAttributeList.getToken( 0, ',', tokenPos ).getStr(), _retval );
 217         }
 218
 219         return NS_OK;
 220     }
 221
 222     // -------------------------------------------------------------------
 223     NS_IMETHODIMP MLdapAttributeMap::SetAttributeList(const nsACString & aProperty, const nsACString & aAttributeList, PRBool allowInconsistencies)
 224     {
 225         OSL_ENSURE( false, "MLdapAttributeMap::SetAttributeList: not implemented!" );
 226         (void)aProperty;
 227         (void)aAttributeList;
 228         (void)allowInconsistencies;
 229         return NS_ERROR_NOT_IMPLEMENTED;
 230     }
 231
 232     // -------------------------------------------------------------------
 233     NS_IMETHODIMP MLdapAttributeMap::GetProperty(const nsACString & aAttribute, nsACString & _retval)
 234     {
 235         OSL_ENSURE( false, "MLdapAttributeMap::GetProperty: not implemented!" );
 236         (void)aAttribute;
 237         (void)_retval;
 238         return NS_ERROR_NOT_IMPLEMENTED;
 239     }
 240
 241     // -------------------------------------------------------------------
 242     NS_IMETHODIMP MLdapAttributeMap::GetAllCardAttributes(nsACString & _retval)
 243     {
 244         const MapPropertiesToAttributes& rPropertyMap( lcl_getPropertyMap() );
 245
 246         ::rtl::OStringBuffer aAllAttributes;
 247         for (   MapPropertiesToAttributes::const_iterator loop = rPropertyMap.begin();
 248                 loop != rPropertyMap.end();
 249                 ++loop
 250             )
 251         {
 252             aAllAttributes.append( loop->second.pLDAPAttributeList );
 253             if ( loop != rPropertyMap.end() )
 254                 aAllAttributes.append( ',' );
 255         }
 256
 257         MTypeConverter::asciiToNsACString( aAllAttributes.getStr(), _retval );
 258         return NS_OK;
 259     }
 260
 261     // -------------------------------------------------------------------
 262     NS_IMETHODIMP MLdapAttributeMap::CheckState(void)
 263     {
 264         // we do not allow modifying the map, so we're always in a valid state
 265         return NS_OK;
 266     }
 267
 268     // -------------------------------------------------------------------
 269     NS_IMETHODIMP MLdapAttributeMap::SetFromPrefs(const nsACString & aPrefBranchName)
 270     {
 271         OSL_ENSURE( false, "MLdapAttributeMap::SetFromPrefs: not implemented!" );
 272         (void)aPrefBranchName;
 273         return NS_ERROR_NOT_IMPLEMENTED;
 274     }
 275
 276     // -------------------------------------------------------------------
 277     NS_IMETHODIMP MLdapAttributeMap::SetCardPropertiesFromLDAPMessage(nsILDAPMessage* aMessage, nsIAbCard* aCard)
 278     {
 279         NS_ENSURE_ARG_POINTER( aMessage );
 280         NS_ENSURE_ARG_POINTER( aCard );
 281
 282         // in case that's not present in the LDAP message: set the "preferred mail format" to "none"
 283         aCard->SetPreferMailFormat( nsIAbPreferMailFormat::unknown );
 284
 285         const MapPropertiesToAttributes& rPropertyMap( lcl_getPropertyMap() );
 286         for (   MapPropertiesToAttributes::const_iterator prop = rPropertyMap.begin();
 287                 prop != rPropertyMap.end();
 288                 ++prop
 289             )
 290         {
 291             // split the list of attributes for the current property
 292             ::rtl::OString sAttributeList( prop->second.pLDAPAttributeList );
 293             ::rtl::OString sAttribute;
 294
 295             sal_Int32 tokenPos = 0;
 296             while ( tokenPos != -1 )
 297             {
 298                 sAttribute = sAttributeList.getToken( 0, ',', tokenPos );
 299
 300                 // retrieve the values for the current attribute
 301                 PRUint32 valueCount = 0;
 302                 PRUnichar** values = NULL;
 303                 nsresult rv = aMessage->GetValues( sAttribute.getStr(), &valueCount, &values );
 304                 if ( NS_FAILED( rv ) )
 305                     // try the next attribute
 306                     continue;
 307
 308                 if ( valueCount )
 309                 {
 310                     CardPropertySetter propSetter = prop->second.PropSetter;
 311                     OSL_ENSURE( propSetter,
 312                         "MLdapAttributeMap::SetCardPropertiesFromLDAPMessage: "
 313                         "unexpected: could retrieve an attribute value, but have no setter for it!" );
 314                     if ( propSetter )
 315                     {
 316                         (aCard->*propSetter)( values[0] );
 317                     }
 318
 319                     // we're done with this property - no need to handle the remaining attributes which
 320                     // map to it
 321                     break;
 322                 }
 323             }
 324         }
 325         return NS_OK;
 326     }
 327
 328     // -------------------------------------------------------------------
 329     namespace
 330     {
 331         struct PreferMailFormatType
 332         {
 333             const sal_Char* description;
 334             PRUint32        formatType;
 335
 336             PreferMailFormatType()
 337                 :description( NULL )
 338                 ,formatType( nsIAbPreferMailFormat::unknown )
 339             {
 340             }
 341
 342             PreferMailFormatType( const sal_Char* _description, PRUint32 _formatType )
 343                 :description( _description )
 344                 ,formatType( _formatType )
 345             {
 346             }
 347         };
 348
 349         static const PreferMailFormatType* lcl_getMailFormatTypes()
 350         {
 351             static const PreferMailFormatType aMailFormatTypes[] =
 352             {
 353                 PreferMailFormatType( "text/plain", nsIAbPreferMailFormat::plaintext ),
 354                 PreferMailFormatType( "text/html",  nsIAbPreferMailFormat::html      ),
 355                 PreferMailFormatType( "unknown",    nsIAbPreferMailFormat::unknown   ),
 356                 PreferMailFormatType()
 357             };
 358             return aMailFormatTypes;
 359         }
 360     }
 361
 362     // -------------------------------------------------------------------
 363     void MLdapAttributeMap::fillCardFromResult( nsIAbCard& _card, const MQueryHelperResultEntry& _result )
 364     {
 365         _card.SetPreferMailFormat( nsIAbPreferMailFormat::unknown );
 366
 367         ::rtl::OUString resultValue;
 368
 369         const MapPropertiesToAttributes& rPropertyMap( lcl_getPropertyMap() );
 370         for (   MapPropertiesToAttributes::const_iterator prop = rPropertyMap.begin();
 371                 prop != rPropertyMap.end();
 372                 ++prop
 373             )
 374         {
 375             resultValue = _result.getValue( prop->first );
 376
 377             CardPropertySetter propSetter = prop->second.PropSetter;
 378             if ( propSetter )
 379             {
 380         // PRUnichar != sal_Unicode in mingw
 381                 (_card.*propSetter)( reinterpret_cast_mingw_only<const PRUnichar *>(resultValue.getStr()) );
 382             }
 383             else
 384             {
 385                 if ( prop->first.equals( "PreferMailFormat" ) )
 386                 {
 387                     unsigned int format = nsIAbPreferMailFormat::unknown;
 388                     const PreferMailFormatType* pMailFormatType = lcl_getMailFormatTypes();
 389                     while ( pMailFormatType->description )
 390                     {
 391                         if ( resultValue.equalsAscii( pMailFormatType->description ) )
 392                         {
 393                             format = pMailFormatType->formatType;
 394                             break;
 395                         }
 396                         ++pMailFormatType;
 397                     }
 398                     _card.SetPreferMailFormat(format);
 399                 }
 400                 else
 401                     OSL_ENSURE( false, "MLdapAttributeMap::fillCardFromResult: unexpected property without default setters!" );
 402             }
 403         }
 404     }
 405
 406     // -------------------------------------------------------------------
 407     void MLdapAttributeMap::fillResultFromCard( MQueryHelperResultEntry& _result, nsIAbCard& _card )
 408     {
 409         nsXPIDLString value;
 410         ::rtl::OUString resultValue;
 411
 412         const MapPropertiesToAttributes& rPropertyMap( lcl_getPropertyMap() );
 413         for (   MapPropertiesToAttributes::const_iterator prop = rPropertyMap.begin();
 414                 prop != rPropertyMap.end();
 415                 ++prop
 416             )
 417         {
 418             CardPropertyGetter propGetter = prop->second.PropGetter;
 419             if ( propGetter )
 420             {
 421                 (_card.*propGetter)( getter_Copies( value ) );
 422
 423                 nsAutoString temp( value );
 424                 MTypeConverter::nsStringToOUString( temp, resultValue );
 425             }
 426             else
 427             {
 428                 if ( prop->first.equals( "PreferMailFormat" ) )
 429                 {
 430                     unsigned int format = nsIAbPreferMailFormat::unknown;
 431                     _card.GetPreferMailFormat( &format );
 432                     const PreferMailFormatType* pMailFormatType = lcl_getMailFormatTypes();
 433                     while ( pMailFormatType->description )
 434                     {
 435                         if ( format == pMailFormatType->formatType )
 436                         {
 437                             resultValue = ::rtl::OUString::createFromAscii( pMailFormatType->description );
 438                             break;
 439                         }
 440                         ++pMailFormatType;
 441                     }
 442                 }
 443                 else
 444                     OSL_ENSURE( false, "MLdapAttributeMap::fillResultFromCard: unexpected property without default getters!" );
 445             }
 446
 447             _result.insert( prop->first, resultValue );
 448         }
 449     }
 450
 451 //........................................................................
 452 } } // namespace connectivity::mozab
 453 //........................................................................