ucb/source/ucp/webdav/ContentProperties.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: ContentProperties.cxx,v $
  10  * $Revision: 1.12.18.1 $
  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_ucb.hxx"
  33
  34 /**************************************************************************
  35                                 TODO
  36  **************************************************************************
  37
  38  *************************************************************************/
  39 #include <osl/diagnose.h>
  40 #include <com/sun/star/util/DateTime.hpp>
  41 #include "NeonUri.hxx"
  42 #include "DAVResource.hxx"
  43 #include "DAVProperties.hxx"
  44 #include "DateTimeHelper.hxx"
  45 #include "webdavprovider.hxx"
  46 #include "ContentProperties.hxx"
  47
  48 using namespace com::sun::star;
  49 using namespace webdav_ucp;
  50
  51 /*
  52 =============================================================================
  53
  54                             Property Mapping
  55
  56 =============================================================================
  57 HTTP (entity header)    WebDAV (property)   UCB (property)
  58 =============================================================================
  59
  60 Allow
  61 Content-Encoding
  62 Content-Language        getcontentlanguage
  63 Content-Length          getcontentlength    Size
  64 Content-Location
  65 Content-MD5
  66 Content-Range
  67 Content-Type            getcontenttype      MediaType
  68 Expires
  69 Last-Modified           getlastmodified     DateModified
  70                         creationdate        DateCreated
  71                         resourcetype        IsFolder,IsDocument,ContentType
  72                         displayname
  73 ETag (actually          getetag
  74 a response header )
  75                         lockdiscovery
  76                         supportedlock
  77                         source
  78                                             Title (always taken from URI)
  79
  80 =============================================================================
  81
  82 Important: HTTP headers will not be mapped to DAV properties; only to UCB
  83            properties. (Content-Length,Content-Type,Last-Modified)
  84 */
  85
  86 //=========================================================================
  87 //=========================================================================
  88 //
  89 // ContentProperties Implementation.
  90 //
  91 //=========================================================================
  92 //=========================================================================
  93
  94 // static member!
  95 uno::Any ContentProperties::m_aEmptyAny;
  96
  97 ContentProperties::ContentProperties( const DAVResource& rResource )
  98 : m_xProps( new PropertyValueMap ),
  99   m_bTrailingSlash( false )
 100 {
 101     OSL_ENSURE( rResource.uri.getLength(),
 102                 "ContentProperties ctor - Empty resource URI!" );
 103
 104     // Title
 105     try
 106     {
 107         NeonUri aURI( rResource.uri );
 108         m_aEscapedTitle = aURI.GetPathBaseName();
 109
 110         (*m_xProps)[ rtl::OUString::createFromAscii( "Title" ) ]
 111             = PropertyValue(
 112                 uno::makeAny( aURI.GetPathBaseNameUnescaped() ), true );
 113     }
 114     catch ( DAVException const & )
 115     {
 116         (*m_xProps)[ rtl::OUString::createFromAscii( "Title" ) ]
 117             = PropertyValue(
 118                 uno::makeAny(
 119                     rtl::OUString(
 120                         RTL_CONSTASCII_USTRINGPARAM( "*** unknown ***" ) ) ),
 121                 true );
 122     }
 123
 124     std::vector< DAVPropertyValue >::const_iterator it
 125         = rResource.properties.begin();
 126       std::vector< DAVPropertyValue >::const_iterator end
 127         = rResource.properties.end();
 128
 129       while ( it != end )
 130       {
 131         addProperty( (*it) );
 132         ++it;
 133       }
 134
 135     if ( rResource.uri.getStr()[ rResource.uri.getLength() - 1 ]
 136         == sal_Unicode( '/' ) )
 137         m_bTrailingSlash = sal_True;
 138 }
 139
 140 //=========================================================================
 141 ContentProperties::ContentProperties(
 142                         const rtl::OUString & rTitle, sal_Bool bFolder )
 143 : m_xProps( new PropertyValueMap ),
 144   m_bTrailingSlash( sal_False )
 145 {
 146     (*m_xProps)[ rtl::OUString::createFromAscii( "Title" ) ]
 147         = PropertyValue( uno::makeAny( rTitle ), true );
 148     (*m_xProps)[ rtl::OUString::createFromAscii( "IsFolder" ) ]
 149         = PropertyValue( uno::makeAny( bFolder ), true );
 150     (*m_xProps)[ rtl::OUString::createFromAscii( "IsDocument" ) ]
 151         = PropertyValue( uno::makeAny( sal_Bool( !bFolder ) ), true );
 152 }
 153
 154 //=========================================================================
 155 ContentProperties::ContentProperties( const rtl::OUString & rTitle )
 156 : m_xProps( new PropertyValueMap ),
 157   m_bTrailingSlash( sal_False )
 158 {
 159     (*m_xProps)[ rtl::OUString::createFromAscii( "Title" ) ]
 160         = PropertyValue( uno::makeAny( rTitle ), true );
 161 }
 162
 163 //=========================================================================
 164 ContentProperties::ContentProperties( const ContentProperties & rOther )
 165 : m_aEscapedTitle( rOther.m_aEscapedTitle ),
 166   m_xProps( rOther.m_xProps.get()
 167             ? new PropertyValueMap( *rOther.m_xProps )
 168             : new PropertyValueMap ),
 169   m_bTrailingSlash( rOther.m_bTrailingSlash )
 170 {
 171 }
 172
 173 //=========================================================================
 174 bool ContentProperties::contains( const rtl::OUString & rName ) const
 175 {
 176     if ( get( rName ) )
 177         return true;
 178     else
 179         return false;
 180 }
 181
 182 //=========================================================================
 183 const uno::Any & ContentProperties::getValue(
 184                                     const rtl::OUString & rName ) const
 185 {
 186     const PropertyValue * pProp = get( rName );
 187     if ( pProp )
 188         return pProp->value();
 189     else
 190         return m_aEmptyAny;
 191 }
 192
 193 //=========================================================================
 194 const PropertyValue * ContentProperties::get(
 195                                     const rtl::OUString & rName ) const
 196 {
 197     PropertyValueMap::const_iterator it = m_xProps->find( rName );
 198     const PropertyValueMap::const_iterator end = m_xProps->end();
 199
 200     if ( it == end )
 201     {
 202         it  = m_xProps->begin();
 203         while ( it != end )
 204         {
 205             if ( (*it).first.equalsIgnoreAsciiCase( rName ) )
 206                 return &(*it).second;
 207
 208             ++it;
 209         }
 210         return 0;
 211     }
 212     else
 213         return &(*it).second;
 214 }
 215
 216 //=========================================================================
 217 // static
 218 void ContentProperties::UCBNamesToDAVNames(
 219                             const uno::Sequence< beans::Property > & rProps,
 220                             std::vector< rtl::OUString > & propertyNames,
 221                             bool bIncludeUnmatched /* = true */ )
 222 {
 223     //////////////////////////////////////////////////////////////
 224     // Assemble list of DAV properties to obtain from server.
 225     // Append DAV properties needed to obtain requested UCB props.
 226     //////////////////////////////////////////////////////////////
 227
 228     //       DAV              UCB
 229     // creationdate     <- DateCreated
 230     // getlastmodified  <- DateModified
 231     // getcontenttype   <- MediaType
 232     // getcontentlength <- Size
 233     // resourcetype     <- IsFolder, IsDocument, ContentType
 234     // (taken from URI) <- Title
 235
 236     sal_Bool bCreationDate  = sal_False;
 237     sal_Bool bLastModified  = sal_False;
 238     sal_Bool bContentType   = sal_False;
 239     sal_Bool bContentLength = sal_False;
 240     sal_Bool bResourceType  = sal_False;
 241
 242     sal_Int32 nCount = rProps.getLength();
 243     for ( sal_Int32 n = 0; n < nCount; ++n )
 244     {
 245         const beans::Property & rProp = rProps[ n ];
 246
 247         if ( rProp.Name.equalsAsciiL(
 248                     RTL_CONSTASCII_STRINGPARAM( "Title" ) ) )
 249         {
 250             // Title is always obtained from resource's URI.
 251             continue;
 252         }
 253         else if ( rProp.Name.equalsAsciiL(
 254                     RTL_CONSTASCII_STRINGPARAM( "DateCreated" ) )
 255                   ||
 256                   ( rProp.Name == DAVProperties::CREATIONDATE ) )
 257         {
 258             if ( !bCreationDate )
 259             {
 260                    propertyNames.push_back( DAVProperties::CREATIONDATE );
 261                 bCreationDate = sal_True;
 262             }
 263         }
 264         else if ( rProp.Name.equalsAsciiL(
 265                     RTL_CONSTASCII_STRINGPARAM( "DateModified" ) )
 266                   ||
 267                   ( rProp.Name == DAVProperties::GETLASTMODIFIED ) )
 268         {
 269             if ( !bLastModified )
 270             {
 271                    propertyNames.push_back(
 272                     DAVProperties::GETLASTMODIFIED );
 273                 bLastModified = sal_True;
 274             }
 275         }
 276         else if ( rProp.Name.equalsAsciiL(
 277                     RTL_CONSTASCII_STRINGPARAM( "MediaType" ) )
 278                   ||
 279                   ( rProp.Name == DAVProperties::GETCONTENTTYPE ) )
 280         {
 281             if ( !bContentType )
 282             {
 283                    propertyNames.push_back(
 284                         DAVProperties::GETCONTENTTYPE );
 285                 bContentType = sal_True;
 286             }
 287         }
 288         else if ( rProp.Name.equalsAsciiL(
 289                     RTL_CONSTASCII_STRINGPARAM( "Size" ) )
 290                   ||
 291                   ( rProp.Name == DAVProperties::GETCONTENTLENGTH ) )
 292         {
 293             if ( !bContentLength )
 294             {
 295                    propertyNames.push_back(
 296                     DAVProperties::GETCONTENTLENGTH );
 297                 bContentLength = sal_True;
 298             }
 299         }
 300         else if ( rProp.Name.equalsAsciiL(
 301                     RTL_CONSTASCII_STRINGPARAM( "ContentType" ) )
 302                   ||
 303                   rProp.Name.equalsAsciiL(
 304                     RTL_CONSTASCII_STRINGPARAM( "IsDocument" ) )
 305                   ||
 306                   rProp.Name.equalsAsciiL(
 307                     RTL_CONSTASCII_STRINGPARAM( "IsFolder" ) )
 308                   ||
 309                   ( rProp.Name == DAVProperties::RESOURCETYPE ) )
 310         {
 311             if ( !bResourceType )
 312             {
 313                    propertyNames.push_back( DAVProperties::RESOURCETYPE );
 314                 bResourceType = sal_True;
 315             }
 316         }
 317         else
 318         {
 319             if ( bIncludeUnmatched )
 320                 propertyNames.push_back( rProp.Name );
 321         }
 322     }
 323 }
 324
 325 //=========================================================================
 326 // static
 327 void ContentProperties::UCBNamesToHTTPNames(
 328                             const uno::Sequence< beans::Property > & rProps,
 329                             std::vector< rtl::OUString > & propertyNames,
 330                             bool bIncludeUnmatched /* = true */ )
 331 {
 332     //////////////////////////////////////////////////////////////
 333     // Assemble list of HTTP header names to obtain from server.
 334     // Append HTTP headers needed to obtain requested UCB props.
 335     //////////////////////////////////////////////////////////////
 336
 337     //       HTTP              UCB
 338     // Last-Modified  <- DateModified
 339     // Content-Type   <- MediaType
 340     // Content-Length <- Size
 341
 342     sal_Int32 nCount = rProps.getLength();
 343     for ( sal_Int32 n = 0; n < nCount; ++n )
 344     {
 345         const beans::Property & rProp = rProps[ n ];
 346
 347         if ( rProp.Name.equalsAsciiL(
 348                     RTL_CONSTASCII_STRINGPARAM( "DateModified" ) ) )
 349         {
 350             propertyNames.push_back(
 351                 rtl::OUString::createFromAscii( "Last-Modified" ) );
 352         }
 353         else if ( rProp.Name.equalsAsciiL(
 354                     RTL_CONSTASCII_STRINGPARAM( "MediaType" ) ) )
 355         {
 356             propertyNames.push_back(
 357                 rtl::OUString::createFromAscii( "Content-Type" ) );
 358         }
 359         else if ( rProp.Name.equalsAsciiL(
 360                     RTL_CONSTASCII_STRINGPARAM( "Size" ) ) )
 361         {
 362             propertyNames.push_back(
 363                 rtl::OUString::createFromAscii( "Content-Length" ) );
 364         }
 365         else
 366         {
 367             if ( bIncludeUnmatched )
 368                 propertyNames.push_back( rProp.Name );
 369         }
 370     }
 371 }
 372
 373 //=========================================================================
 374 bool ContentProperties::containsAllNames(
 375                     const uno::Sequence< beans::Property >& rProps,
 376                     std::vector< rtl::OUString > & rNamesNotContained ) const
 377 {
 378     rNamesNotContained.clear();
 379
 380     sal_Int32 nCount = rProps.getLength();
 381     for ( sal_Int32 n = 0; n < nCount; ++n )
 382     {
 383         const rtl::OUString & rName = rProps[ n ].Name;
 384         if ( !contains( rName ) )
 385         {
 386             // Not found.
 387             rNamesNotContained.push_back( rName );
 388         }
 389     }
 390
 391     return ( rNamesNotContained.size() == 0 );
 392 }
 393
 394 //=========================================================================
 395 void ContentProperties::addProperties(
 396                                 const std::vector< rtl::OUString > & rProps,
 397                                 const ContentProperties & rContentProps )
 398 {
 399     std::vector< rtl::OUString >::const_iterator it  = rProps.begin();
 400     std::vector< rtl::OUString >::const_iterator end = rProps.end();
 401
 402     while ( it != end )
 403     {
 404         const rtl::OUString & rName = (*it);
 405
 406         if ( !contains( rName ) ) // ignore duplicates
 407         {
 408             const PropertyValue * pProp = rContentProps.get( rName );
 409             if ( pProp )
 410             {
 411                 // Add it.
 412                 addProperty( rName, pProp->value(), pProp->isCaseSensitive() );
 413             }
 414             else
 415             {
 416                 addProperty( rName, uno::Any(), false );
 417             }
 418         }
 419         ++it;
 420     }
 421 }
 422
 423 //=========================================================================
 424 void ContentProperties::addProperties( const ContentProperties & rProps )
 425 {
 426     PropertyValueMap::const_iterator it = rProps.m_xProps->begin();
 427     const PropertyValueMap::const_iterator end = rProps.m_xProps->end();
 428
 429     while ( it != end )
 430     {
 431         addProperty(
 432             (*it).first, (*it).second.value(), (*it).second.isCaseSensitive() );
 433         ++it;
 434     }
 435 }
 436
 437 //=========================================================================
 438 void ContentProperties::addProperties(
 439     const std::vector< DAVPropertyValue > & rProps )
 440 {
 441     std::vector< DAVPropertyValue >::const_iterator it  = rProps.begin();
 442     std::vector< DAVPropertyValue >::const_iterator end = rProps.end();
 443
 444     while ( it != end )
 445     {
 446         addProperty( (*it) );
 447         ++it;
 448     }
 449 }
 450
 451 //=========================================================================
 452 void ContentProperties::addProperty( const DAVPropertyValue & rProp )
 453 {
 454     addProperty( rProp.Name, rProp.Value, rProp.IsCaseSensitive );
 455 }
 456
 457 //=========================================================================
 458 void ContentProperties::addProperty( const rtl::OUString & rName,
 459                                      const com::sun::star::uno::Any & rValue,
 460                                      bool bIsCaseSensitive )
 461 {
 462     if ( rName.equals( DAVProperties::CREATIONDATE ) )
 463     {
 464         // Map DAV:creationdate to UCP:DateCreated
 465         rtl::OUString aValue;
 466         rValue >>= aValue;
 467         util::DateTime aDate;
 468         DateTimeHelper::convert( aValue, aDate );
 469
 470         (*m_xProps)[ rtl::OUString::createFromAscii( "DateCreated" ) ]
 471             = PropertyValue( uno::makeAny( aDate ), true );
 472     }
 473     //  else if ( rName.equals( DAVProperties::DISPLAYNAME ) )
 474     //  {
 475     //  }
 476     //  else if ( rName.equals( DAVProperties::GETCONTENTLANGUAGE ) )
 477     //  {
 478     //  }
 479     else if ( rName.equals( DAVProperties::GETCONTENTLENGTH ) )
 480     {
 481         // Map DAV:getcontentlength to UCP:Size
 482         rtl::OUString aValue;
 483         rValue >>= aValue;
 484
 485         (*m_xProps)[ rtl::OUString::createFromAscii( "Size" ) ]
 486             = PropertyValue( uno::makeAny( aValue.toInt64() ), true );
 487     }
 488     else if ( rName.equalsAsciiL(
 489                 RTL_CONSTASCII_STRINGPARAM( "Content-Length" ) ) )
 490     {
 491         // Do NOT map Content-Lenght entity header to DAV:getcontentlength!
 492         // Only DAV resources have this property.
 493
 494         // Map Content-Length entity header to UCP:Size
 495         rtl::OUString aValue;
 496         rValue >>= aValue;
 497
 498         (*m_xProps)[ rtl::OUString::createFromAscii( "Size" ) ]
 499             = PropertyValue( uno::makeAny( aValue.toInt64() ), true );
 500     }
 501     else if ( rName.equals( DAVProperties::GETCONTENTTYPE ) )
 502     {
 503         // Map DAV:getcontenttype to UCP:MediaType (1:1)
 504         (*m_xProps)[ rtl::OUString::createFromAscii( "MediaType" ) ]
 505             = PropertyValue( rValue, true );
 506     }
 507     else if ( rName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( "Content-Type" ) ) )
 508     {
 509         // Do NOT map Content-Type entity header to DAV:getcontenttype!
 510         // Only DAV resources have this property.
 511
 512         // Map DAV:getcontenttype to UCP:MediaType (1:1)
 513         (*m_xProps)[ rtl::OUString::createFromAscii( "MediaType" ) ]
 514             = PropertyValue( rValue, true );
 515     }
 516     //  else if ( rName.equals( DAVProperties::GETETAG ) )
 517     //  {
 518     //  }
 519     else if ( rName.equals( DAVProperties::GETLASTMODIFIED ) )
 520     {
 521         // Map the DAV:getlastmodified entity header to UCP:DateModified
 522         rtl::OUString aValue;
 523         rValue >>= aValue;
 524         util::DateTime aDate;
 525         DateTimeHelper::convert( aValue, aDate );
 526
 527         (*m_xProps)[ rtl::OUString::createFromAscii( "DateModified" ) ]
 528             = PropertyValue( uno::makeAny( aDate ), true );
 529     }
 530     else if ( rName.equalsAsciiL(
 531                 RTL_CONSTASCII_STRINGPARAM( "Last-Modified" ) ) )
 532     {
 533         // Do not map Last-Modified entity header to DAV:getlastmodified!
 534         // Only DAV resources have this property.
 535
 536         // Map the Last-Modified entity header to UCP:DateModified
 537         rtl::OUString aValue;
 538         rValue >>= aValue;
 539         util::DateTime aDate;
 540         DateTimeHelper::convert( aValue, aDate );
 541
 542         (*m_xProps)[ rtl::OUString::createFromAscii( "DateModified" ) ]
 543             = PropertyValue( uno::makeAny( aDate ), true );
 544     }
 545     //  else if ( rName.equals( DAVProperties::LOCKDISCOVERY ) )
 546     //  {
 547     //  }
 548     else if ( rName.equals( DAVProperties::RESOURCETYPE ) )
 549     {
 550         rtl::OUString aValue;
 551         rValue >>= aValue;
 552
 553         // Map DAV:resourceype to UCP:IsFolder, UCP:IsDocument, UCP:ContentType
 554         sal_Bool bFolder =
 555             aValue.equalsIgnoreAsciiCaseAsciiL(
 556                 RTL_CONSTASCII_STRINGPARAM( "collection" ) );
 557
 558         (*m_xProps)[ rtl::OUString::createFromAscii( "IsFolder" ) ]
 559             = PropertyValue( uno::makeAny( bFolder ), true );
 560         (*m_xProps)[ rtl::OUString::createFromAscii( "IsDocument" ) ]
 561             = PropertyValue( uno::makeAny( sal_Bool( !bFolder ) ), true );
 562         (*m_xProps)[ rtl::OUString::createFromAscii( "ContentType" ) ]
 563             = PropertyValue( uno::makeAny( bFolder
 564                 ? rtl::OUString::createFromAscii( WEBDAV_COLLECTION_TYPE )
 565                 : rtl::OUString::createFromAscii( WEBDAV_CONTENT_TYPE ) ), true );
 566     }
 567     //  else if ( rName.equals( DAVProperties::SOURCE ) )
 568     //  {
 569     //  }
 570     //  else if ( rName.equals( DAVProperties::SUPPORTEDLOCK ) )
 571     //  {
 572     //  }
 573
 574     // Save property.
 575     (*m_xProps)[ rName ] = PropertyValue( rValue, bIsCaseSensitive );
 576 }