xmlhelp/source/cxxhelp/provider/databases.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include "db.hxx"
  21 #include <osl/diagnose.h>
  22 #include <osl/thread.h>
  23 #include <osl/process.h>
  24 #include <rtl/uri.hxx>
  25 #include <osl/file.hxx>
  26 #include <com/sun/star/lang/Locale.hpp>
  27 #include <com/sun/star/awt/Toolkit.hpp>
  28 #include <com/sun/star/i18n/Collator.hpp>
  29 #include <rtl/ustrbuf.hxx>
  30 #include "inputstream.hxx"
  31 #include <algorithm>
  32 #include <cassert>
  33 #include <string.h>
  34
  35 #include <helpcompiler/HelpIndexer.hxx>
  36
  37 // Extensible help
  38 #include "com/sun/star/deployment/ExtensionManager.hpp"
  39 #include "com/sun/star/deployment/thePackageManagerFactory.hpp"
  40 #include <comphelper/processfactory.hxx>
  41 #include <com/sun/star/uno/XComponentContext.hpp>
  42 #include <com/sun/star/ucb/XCommandEnvironment.hpp>
  43 #include <com/sun/star/beans/Optional.hpp>
  44 #include <com/sun/star/beans/PropertyValue.hpp>
  45 #include <com/sun/star/beans/NamedValue.hpp>
  46 #include <com/sun/star/configuration/theDefaultProvider.hpp>
  47 #include <com/sun/star/frame/XConfigManager.hpp>
  48 #include <com/sun/star/ucb/SimpleFileAccess.hpp>
  49 #include <com/sun/star/util/theMacroExpander.hpp>
  50 #include <com/sun/star/uri/UriReferenceFactory.hpp>
  51 #include <com/sun/star/uri/XVndSunStarExpandUrl.hpp>
  52 #include <com/sun/star/script/XInvocation.hpp>
  53 #include <i18nlangtag/languagetag.hxx>
  54
  55 #include <com/sun/star/awt/XToolkit.hpp>
  56 #include <com/sun/star/awt/XExtendedToolkit.hpp>
  57 #include <com/sun/star/awt/XWindowPeer.hpp>
  58 #include <com/sun/star/awt/XVclWindowPeer.hpp>
  59 #include <com/sun/star/awt/XTopWindow.hpp>
  60
  61 #include <comphelper/storagehelper.hxx>
  62 #include <comphelper/string.hxx>
  63
  64 #include <vcl/svapp.hxx>
  65
  66 #include "databases.hxx"
  67 #include "urlparameter.hxx"
  68
  69 #ifdef WNT
  70 #include <windows.h>
  71 #endif
  72
  73 using namespace chelp;
  74 using namespace com::sun::star;
  75 using namespace com::sun::star::uno;
  76 using namespace com::sun::star::io;
  77 using namespace com::sun::star::container;
  78 using namespace com::sun::star::i18n;
  79 using namespace com::sun::star::lang;
  80 using namespace com::sun::star::deployment;
  81 using namespace com::sun::star::beans;
  82
  83
  84 OUString Databases::expandURL( const OUString& aURL )
  85 {
  86     osl::MutexGuard aGuard( m_aMutex );
  87     OUString aRetURL = expandURL( aURL, m_xContext );
  88     return aRetURL;
  89 }
  90
  91 OUString Databases::expandURL( const OUString& aURL, Reference< uno::XComponentContext > xContext )
  92 {
  93     static Reference< util::XMacroExpander > xMacroExpander;
  94     static Reference< uri::XUriReferenceFactory > xFac;
  95
  96     if( !xMacroExpander.is() || !xFac.is() )
  97     {
  98         xFac = uri::UriReferenceFactory::create( xContext );
  99
 100         xMacroExpander = util::theMacroExpander::get(xContext);
 101      }
 102
 103     OUString aRetURL = aURL;
 104     if( xMacroExpander.is() )
 105     {
 106         Reference< uri::XUriReference > uriRef;
 107         for (;;)
 108         {
 109             uriRef = Reference< uri::XUriReference >( xFac->parse( aRetURL ), UNO_QUERY );
 110             if ( uriRef.is() )
 111             {
 112                 Reference < uri::XVndSunStarExpandUrl > sxUri( uriRef, UNO_QUERY );
 113                 if( !sxUri.is() )
 114                     break;
 115
 116                 aRetURL = sxUri->expand( xMacroExpander );
 117             }
 118         }
 119      }
 120     return aRetURL;
 121 }
 122
 123 Databases::Databases( sal_Bool showBasic,
 124                       const OUString& instPath,
 125                       const com::sun::star::uno::Sequence< OUString >& imagesZipPaths,
 126                       const OUString& productName,
 127                       const OUString& productVersion,
 128                       const OUString& styleSheet,
 129                       Reference< uno::XComponentContext > xContext )
 130     : m_xContext( xContext ),
 131       m_bShowBasic(showBasic),
 132       m_pErrorDoc( 0 ),
 133       m_nCustomCSSDocLength( 0 ),
 134       m_pCustomCSSDoc( 0 ),
 135       m_aCSS(styleSheet.toAsciiLowerCase()),
 136       newProdName(OUString( "$[officename]" ) ),
 137       newProdVersion(OUString( "$[officeversion]" ) ),
 138       prodName( OUString( "%PRODUCTNAME" ) ),
 139       prodVersion( OUString( "%PRODUCTVERSION" ) ),
 140       vendName( OUString( "%VENDORNAME" ) ),
 141       vendVersion( OUString( "%VENDORVERSION" ) ),
 142       vendShort( OUString( "%VENDORSHORT" ) ),
 143       m_aImagesZipPaths( imagesZipPaths ),
 144       m_aSymbolsStyleName( "" )
 145 {
 146     m_xSMgr = Reference< XMultiComponentFactory >( m_xContext->getServiceManager(), UNO_QUERY );
 147
 148     m_vAdd[0] = 12;
 149     m_vAdd[1] = 15;
 150     m_vAdd[2] = 11;
 151     m_vAdd[3] = 14;
 152     m_vAdd[4] = 12;
 153     m_vAdd[5] = 13;
 154     m_vAdd[6] = 16;
 155
 156     m_vReplacement[0] = productName;
 157     m_vReplacement[1] = productVersion;
 158     // m_vReplacement[2...4] (vendorName/-Version/-Short) are empty strings
 159     m_vReplacement[5] = productName;
 160     m_vReplacement[6] = productVersion;
 161
 162     setInstallPath( instPath );
 163
 164     m_xSFA = ucb::SimpleFileAccess::create(m_xContext);
 165 }
 166
 167 Databases::~Databases()
 168 {
 169     // release stylesheet
 170
 171     delete[] m_pCustomCSSDoc;
 172
 173     // release errorDocument
 174
 175     delete[] m_pErrorDoc;
 176
 177     // unload the databases
 178
 179     {
 180         // DatabasesTable
 181         DatabasesTable::iterator it = m_aDatabases.begin();
 182         while( it != m_aDatabases.end() )
 183         {
 184             delete it->second;
 185             ++it;
 186         }
 187     }
 188
 189     {
 190         //  ModInfoTable
 191
 192         ModInfoTable::iterator it = m_aModInfo.begin();
 193         while( it != m_aModInfo.end() )
 194         {
 195             delete it->second;
 196             ++it;
 197         }
 198     }
 199
 200     {
 201         // KeywordInfoTable
 202
 203         KeywordInfoTable::iterator it = m_aKeywordInfo.begin();
 204         while( it != m_aKeywordInfo.end() )
 205         {
 206             delete it->second;
 207             ++it;
 208         }
 209     }
 210 }
 211
 212 static bool impl_getZipFile(
 213         Sequence< OUString > & rImagesZipPaths,
 214         const OUString & rZipName,
 215         OUString & rFileName )
 216 {
 217     OUString aWorkingDir;
 218     osl_getProcessWorkingDir( &aWorkingDir.pData );
 219     const OUString *pPathArray = rImagesZipPaths.getArray();
 220     for ( int i = 0; i < rImagesZipPaths.getLength(); ++i )
 221     {
 222         OUString aFileName = pPathArray[ i ];
 223         if ( !aFileName.isEmpty() )
 224         {
 225             if ( 1 + aFileName.lastIndexOf( '/' ) != aFileName.getLength() )
 226             {
 227                 aFileName += OUString( "/" );
 228             }
 229             aFileName += rZipName;
 230             // the icons are not read when the URL is a symlink
 231             osl::File::getAbsoluteFileURL( aWorkingDir, aFileName, rFileName );
 232
 233             // test existence
 234             osl::DirectoryItem aDirItem;
 235             if ( osl::DirectoryItem::get( rFileName, aDirItem ) == osl::FileBase::E_None )
 236                 return true;
 237         }
 238     }
 239     return false;
 240 }
 241
 242 OString Databases::getImagesZipFileURL()
 243 {
 244     OUString aSymbolsStyleName;
 245     try
 246     {
 247         uno::Reference< lang::XMultiServiceFactory > xConfigProvider =
 248             configuration::theDefaultProvider::get(m_xContext);
 249
 250         // set root path
 251         uno::Sequence < uno::Any > lParams(1);
 252         beans::PropertyValue                       aParam ;
 253         aParam.Name    = OUString("nodepath");
 254         aParam.Value <<= OUString("org.openoffice.Office.Common");
 255         lParams[0] = uno::makeAny(aParam);
 256
 257         // open it
 258         uno::Reference< uno::XInterface > xCFG( xConfigProvider->createInstanceWithArguments(
 259                     OUString("com.sun.star.configuration.ConfigurationAccess"),
 260                     lParams) );
 261
 262         bool bChanged = false;
 263         uno::Reference< container::XHierarchicalNameAccess > xAccess(xCFG, uno::UNO_QUERY_THROW);
 264         uno::Any aResult = xAccess->getByHierarchicalName(OUString("Misc/SymbolStyle"));
 265         if ( (aResult >>= aSymbolsStyleName) && m_aSymbolsStyleName != aSymbolsStyleName )
 266         {
 267             m_aSymbolsStyleName = aSymbolsStyleName;
 268             bChanged = true;
 269         }
 270
 271         if ( m_aImagesZipFileURL.isEmpty() || bChanged )
 272         {
 273             OUString aImageZip;
 274             bool bFound = false;
 275
 276             if ( !aSymbolsStyleName.isEmpty() )
 277             {
 278                 if ( aSymbolsStyleName.equalsAscii("auto") )
 279                 {
 280                     OUString const & env = Application::GetDesktopEnvironment();
 281                     if ( env.equalsIgnoreAsciiCase("tde") ||
 282                          env.equalsIgnoreAsciiCase("kde") )
 283                         aSymbolsStyleName = "crystal";
 284                     else if ( env.equalsIgnoreAsciiCase("kde4") )
 285                         aSymbolsStyleName = "oxygen";
 286                     else
 287                         aSymbolsStyleName = "tango";
 288                 }
 289                 OUString aZipName = OUString( "images_" );
 290                 aZipName += aSymbolsStyleName;
 291                 aZipName += OUString( ".zip" );
 292
 293                 bFound = impl_getZipFile( m_aImagesZipPaths, aZipName, aImageZip );
 294             }
 295
 296             if ( ! bFound )
 297                 bFound = impl_getZipFile( m_aImagesZipPaths, OUString( "images.zip" ), aImageZip );
 298
 299             if ( ! bFound )
 300                 aImageZip = OUString();
 301
 302             m_aImagesZipFileURL = OUStringToOString(
 303                         rtl::Uri::encode(
 304                             aImageZip,
 305                             rtl_UriCharClassPchar,
 306                             rtl_UriEncodeIgnoreEscapes,
 307                             RTL_TEXTENCODING_UTF8 ), RTL_TEXTENCODING_UTF8 );
 308         }
 309     }
 310     catch ( NoSuchElementException const & )
 311     {
 312     }
 313
 314     return m_aImagesZipFileURL;
 315 }
 316
 317 void Databases::replaceName( OUString& oustring ) const
 318 {
 319     sal_Int32 idx = -1,idx1 = -1,idx2 = -1,k = 0,off;
 320     bool cap = false;
 321     OUStringBuffer aStrBuf( 0 );
 322
 323     while( true )
 324     {
 325         ++idx;
 326         idx1 = oustring.indexOf( sal_Unicode('%'),idx);
 327         idx2 = oustring.indexOf( sal_Unicode('$'),idx);
 328
 329         if(idx1 == -1 && idx2 == -1)
 330             break;
 331
 332         if(idx1 == -1)
 333             idx = idx2;
 334         else if(idx2 == -1)
 335             idx = idx1;
 336         else {
 337             // no index is zero
 338             if(idx1 < idx2)
 339                 idx = idx1;
 340             else if(idx2 < idx1 )
 341                 idx = idx2;
 342         }
 343
 344         if( oustring.indexOf( prodName,idx ) == idx )
 345             off = PRODUCTNAME;
 346         else if( oustring.indexOf( prodVersion,idx ) == idx )
 347             off = PRODUCTVERSION;
 348         else if( oustring.indexOf( vendName,idx ) == idx )
 349             off = VENDORNAME;
 350         else if( oustring.indexOf( vendVersion,idx ) == idx )
 351             off = VENDORVERSION;
 352         else if( oustring.indexOf( vendShort,idx ) == idx )
 353             off = VENDORSHORT;
 354         else if( oustring.indexOf( newProdName,idx ) == idx )
 355             off = NEWPRODUCTNAME;
 356         else if( oustring.indexOf( newProdVersion,idx ) == idx )
 357             off = NEWPRODUCTVERSION;
 358         else
 359             off = -1;
 360
 361         if( off != -1 )
 362         {
 363             if( ! cap )
 364             {
 365                 cap = true;
 366                 aStrBuf.ensureCapacity( 256 );
 367             }
 368
 369             aStrBuf.append( &oustring.getStr()[k],idx - k );
 370             aStrBuf.append( m_vReplacement[off] );
 371             k = idx + m_vAdd[off];
 372         }
 373     }
 374
 375     if( cap )
 376     {
 377         if( k < oustring.getLength() )
 378             aStrBuf.append( &oustring.getStr()[k],oustring.getLength()-k );
 379         oustring = aStrBuf.makeStringAndClear();
 380     }
 381 }
 382
 383 OUString Databases::getInstallPathAsURL()
 384 {
 385     osl::MutexGuard aGuard( m_aMutex );
 386
 387     return m_aInstallDirectory;
 388 }
 389
 390 const std::vector< OUString >& Databases::getModuleList( const OUString& Language )
 391 {
 392     if( m_avModules.empty() )
 393     {
 394         OUString  fileName,dirName = getInstallPathAsURL() + processLang( Language );
 395         osl::Directory dirFile( dirName );
 396
 397         osl::DirectoryItem aDirItem;
 398         osl::FileStatus    aStatus( osl_FileStatus_Mask_FileName );
 399
 400         sal_Int32 idx;
 401
 402         if( osl::FileBase::E_None != dirFile.open() )
 403             return m_avModules;
 404
 405         while( dirFile.getNextItem( aDirItem ) == osl::FileBase::E_None &&
 406                aDirItem.getFileStatus( aStatus ) == osl::FileBase::E_None )
 407         {
 408             if( ! aStatus.isValid( osl_FileStatus_Mask_FileName ) )
 409                 continue;
 410
 411             fileName = aStatus.getFileName();
 412
 413             // Check, whether fileName is of the form *.cfg
 414             idx = fileName.lastIndexOf(  sal_Unicode( '.' ) );
 415
 416             if( idx == -1 )
 417                 continue;
 418
 419             const sal_Unicode* str = fileName.getStr();
 420
 421             if( fileName.getLength() == idx + 4                   &&
 422                 ( str[idx + 1] == 'c' || str[idx + 1] == 'C' )    &&
 423                 ( str[idx + 2] == 'f' || str[idx + 2] == 'F' )    &&
 424                 ( str[idx + 3] == 'g' || str[idx + 3] == 'G' )    &&
 425                 ( fileName = fileName.copy(0,idx).toAsciiLowerCase() ).compareToAscii( "picture" ) != 0 ) {
 426               if(! m_bShowBasic && fileName.compareToAscii("sbasic") == 0 )
 427                 continue;
 428               m_avModules.push_back( fileName );
 429             }
 430         }
 431     }
 432     return m_avModules;
 433 }
 434
 435
 436
 437 StaticModuleInformation* Databases::getStaticInformationForModule( const OUString& Module,
 438                                                                    const OUString& Language )
 439 {
 440     osl::MutexGuard aGuard( m_aMutex );
 441
 442     OUString key = processLang(Language) + OUString( "/" ) + Module;
 443
 444     std::pair< ModInfoTable::iterator,bool > aPair =
 445         m_aModInfo.insert( ModInfoTable::value_type( key,(StaticModuleInformation*)0 ) );
 446
 447     ModInfoTable::iterator it = aPair.first;
 448
 449     if( aPair.second && ! it->second )
 450     {
 451         osl::File cfgFile( getInstallPathAsURL() +
 452                            key +
 453                            OUString( ".cfg" ) );
 454
 455         if( osl::FileBase::E_None != cfgFile.open( osl_File_OpenFlag_Read ) )
 456             it->second = 0;
 457         else
 458         {
 459             sal_uInt32 pos = 0;
 460             sal_uInt64 nRead;
 461             sal_Char buffer[2048];
 462             sal_Unicode lineBuffer[1028];
 463             OUString fileContent;
 464
 465             while( osl::FileBase::E_None == cfgFile.read( &buffer,2048,nRead ) && nRead )
 466                 fileContent += OUString( buffer,sal_Int32( nRead ),RTL_TEXTENCODING_UTF8 );
 467
 468             cfgFile.close();
 469
 470             const sal_Unicode* str = fileContent.getStr();
 471             OUString current,lang_,program,startid,title,heading,fulltext;
 472             OUString order( "1" );
 473
 474             for( sal_Int32 i = 0;i < fileContent.getLength();i++ )
 475             {
 476                 sal_Unicode ch = str[ i ];
 477                 if( ch == sal_Unicode( '\n' ) || ch == sal_Unicode( '\r' ) )
 478                 {
 479                     if( pos )
 480                     {
 481                         current = OUString( lineBuffer,pos );
 482
 483                         if( current.startsWith("Title") )
 484                         {
 485                             title = current.copy( current.indexOf(sal_Unicode( '=' ) ) + 1 );
 486                         }
 487                         else if( current.startsWith("Start") )
 488                         {
 489                             startid = current.copy( current.indexOf('=') + 1 );
 490                         }
 491                         else if( current.startsWith("Language") )
 492                         {
 493                             lang_ = current.copy( current.indexOf('=') + 1 );
 494                         }
 495                         else if( current.startsWith("Program") )
 496                         {
 497                             program = current.copy( current.indexOf('=') + 1 );
 498                         }
 499                         else if( current.startsWith("Heading") )
 500                         {
 501                             heading = current.copy( current.indexOf('=') + 1 );
 502                         }
 503                         else if( current.startsWith("FullText") )
 504                         {
 505                             fulltext = current.copy( current.indexOf('=') + 1 );
 506                         }
 507                         else if( current.startsWith("Order") )
 508                         {
 509                             order = current.copy( current.indexOf('=') + 1 );
 510                         }
 511                     }
 512                     pos = 0;
 513                 }
 514                 else
 515                     lineBuffer[ pos++ ] = ch;
 516             }
 517             replaceName( title );
 518             it->second = new StaticModuleInformation( title,
 519                                                       startid,
 520                                                       program,
 521                                                       heading,
 522                                                       fulltext,
 523                                                       order );
 524         }
 525     }
 526
 527     return it->second;
 528 }
 529
 530
 531
 532
 533 OUString Databases::processLang( const OUString& Language )
 534 {
 535     osl::MutexGuard aGuard( m_aMutex );
 536
 537     OUString ret;
 538     LangSetTable::iterator it = m_aLangSet.find( Language );
 539
 540     if( it == m_aLangSet.end() )
 541     {
 542         sal_Int32 idx;
 543         osl::DirectoryItem aDirItem;
 544
 545         if( osl::FileBase::E_None == osl::DirectoryItem::get( getInstallPathAsURL() + Language,aDirItem ) )
 546         {
 547             ret = Language;
 548             m_aLangSet[ Language ] = ret;
 549         }
 550         else if( ( ( idx = Language.indexOf( '-' ) ) != -1 ||
 551                    ( idx = Language.indexOf( '_' ) ) != -1 ) &&
 552                     osl::FileBase::E_None == osl::DirectoryItem::get( getInstallPathAsURL() + Language.copy( 0,idx ),
 553                                                                    aDirItem ) )
 554         {
 555             ret = Language.copy( 0,idx );
 556             m_aLangSet[ Language ] = ret;
 557         }
 558     }
 559     else
 560         ret = it->second;
 561
 562     return ret;
 563 }
 564
 565
 566 OUString Databases::country( const OUString& Language )
 567 {
 568     sal_Int32 idx;
 569     if( ( idx = Language.indexOf( '-' ) ) != -1 ||
 570         ( idx = Language.indexOf( '_' ) ) != -1 )
 571         return Language.copy( 1+idx );
 572
 573     return OUString();
 574 }
 575
 576
 577
 578 helpdatafileproxy::Hdf* Databases::getHelpDataFile( const OUString& Database,
 579                             const OUString& Language, bool helpText,
 580                             const OUString* pExtensionPath )
 581 {
 582     if( Database.isEmpty() || Language.isEmpty() )
 583         return 0;
 584
 585     osl::MutexGuard aGuard( m_aMutex );
 586
 587
 588     OUString aFileExt( helpText ? OUString(".ht") : OUString(".db") );
 589     OUString dbFileName = OUStringBuffer().append('/').append(Database).append(aFileExt).makeStringAndClear();
 590     OUString key;
 591     if( pExtensionPath == NULL )
 592         key = processLang( Language ) + dbFileName;
 593     else
 594         key = *pExtensionPath + Language + dbFileName;      // make unique, don't change language
 595
 596     std::pair< DatabasesTable::iterator,bool > aPair =
 597         m_aDatabases.insert( DatabasesTable::value_type( key, reinterpret_cast<helpdatafileproxy::Hdf *>(0) ) );
 598
 599     DatabasesTable::iterator it = aPair.first;
 600
 601     if( aPair.second && ! it->second )
 602     {
 603         helpdatafileproxy::Hdf* pHdf = 0;
 604
 605         OUString fileURL;
 606         if( pExtensionPath )
 607             fileURL = expandURL(*pExtensionPath) + Language + dbFileName;
 608         else
 609             fileURL = getInstallPathAsURL() + key;
 610
 611         OUString fileNameHDFHelp( fileURL );
 612         //Extensions always use the new format
 613         if( pExtensionPath != NULL )
 614             fileNameHDFHelp += OUString( "_" );
 615         //SimpleFileAccess takes file URLs as arguments!!! Using filenames works accidentally but
 616         //fails for example when using long path names on Windows (starting with \\?\)
 617         if( m_xSFA->exists( fileNameHDFHelp ) )
 618         {
 619             pHdf = new helpdatafileproxy::Hdf( fileNameHDFHelp, m_xSFA );
 620         }
 621
 622         it->second = pHdf;
 623     }
 624
 625     return it->second;
 626 }
 627
 628 Reference< XCollator >
 629 Databases::getCollator( const OUString& Language,
 630                         const OUString& System )
 631 {
 632     (void)System;
 633
 634     OUString key = Language;
 635
 636     osl::MutexGuard aGuard( m_aMutex );
 637
 638     CollatorTable::iterator it =
 639         m_aCollatorTable.insert( CollatorTable::value_type( key,(Reference< XCollator >)0 ) ).first;
 640
 641     if( ! it->second.is() )
 642     {
 643         it->second = Collator::create(m_xContext);
 644         OUString langStr = processLang(Language);
 645         OUString countryStr = country(Language);
 646         if( countryStr.isEmpty() )
 647         {
 648             if( langStr.compareToAscii("de") == 0 )
 649                 countryStr = OUString("DE");
 650             else if( langStr.compareToAscii("en") == 0 )
 651                 countryStr = OUString("US");
 652             else if( langStr.compareToAscii("es") == 0 )
 653                 countryStr = OUString("ES");
 654             else if( langStr.compareToAscii("it") == 0 )
 655                 countryStr = OUString("IT");
 656             else if( langStr.compareToAscii("fr") == 0 )
 657                 countryStr = OUString("FR");
 658             else if( langStr.compareToAscii("sv") == 0 )
 659                 countryStr = OUString("SE");
 660             else if( langStr.compareToAscii("ja") == 0 )
 661                 countryStr = OUString("JP");
 662             else if( langStr.compareToAscii("ko") == 0 )
 663                 countryStr = OUString("KR");
 664         }
 665         /* FIXME-BCP47: all this does not look right for language tag context,
 666          * also check processLang() and country() methods */
 667         it->second->loadDefaultCollator(  Locale( langStr,
 668                                                   countryStr,
 669                                                   OUString() ),
 670                                           0 );
 671     }
 672
 673     return it->second;
 674 }
 675
 676
 677
 678 namespace chelp {
 679
 680     struct KeywordElementComparator
 681     {
 682         KeywordElementComparator( const Reference< XCollator >& xCollator )
 683             : m_xCollator( xCollator )
 684         { }
 685
 686         bool operator()( const KeywordInfo::KeywordElement& la,
 687                          const KeywordInfo::KeywordElement& ra ) const
 688         {
 689             const OUString& l = la.key;
 690             const OUString& r = ra.key;
 691
 692             bool ret;
 693
 694             if( m_xCollator.is() )
 695             {
 696                 sal_Int32 l1 = l.indexOf( sal_Unicode( ';' ) );
 697                 sal_Int32 l3 = ( l1 == -1 ? l.getLength() : l1 );
 698
 699                 sal_Int32 r1 = r.indexOf( sal_Unicode( ';' ) );
 700                 sal_Int32 r3 = ( r1 == -1 ? r.getLength() : r1 );
 701
 702                 sal_Int32 c1 = m_xCollator->compareSubstring( l,0,l3,r,0,r3 );
 703
 704                 if( c1 == +1 )
 705                     ret = false;
 706                 else if( c1 == 0 )
 707                 {
 708                     sal_Int32 l2 = l.getLength() - l1 - 1;
 709                     sal_Int32 r2 = r.getLength() - r1 - 1;
 710                     ret = ( m_xCollator->compareSubstring( l,1+l1,l2,r,1+r1,r2 ) < 0 );
 711                 }
 712                 else
 713                     ret = true;
 714             }
 715             else
 716                 ret = bool( l < r );
 717
 718             return ret;
 719         }
 720
 721         Reference< XCollator > m_xCollator;
 722     }; // end struct KeywordElementComparator
 723
 724 }
 725
 726
 727
 728 KeywordInfo::KeywordElement::KeywordElement( Databases *pDatabases,
 729                                              helpdatafileproxy::Hdf* pHdf,
 730                                              OUString& ky,
 731                                              OUString& data )
 732     : key( ky )
 733 {
 734     pDatabases->replaceName( key );
 735     init( pDatabases,pHdf,data );
 736 }
 737
 738
 739
 740 void KeywordInfo::KeywordElement::init( Databases *pDatabases,helpdatafileproxy::Hdf* pHdf,const OUString& ids )
 741 {
 742     const sal_Unicode* idstr = ids.getStr();
 743     std::vector< OUString > id,anchor;
 744     int idx = -1,k;
 745     while( ( idx = ids.indexOf( ';',k = ++idx ) ) != -1 )
 746     {
 747         int h = ids.indexOf( sal_Unicode( '#' ),k );
 748         if( h < idx )
 749         {
 750             // found an anchor
 751             id.push_back( OUString( &idstr[k],h-k ) );
 752             anchor.push_back( OUString( &idstr[h+1],idx-h-1 ) );
 753         }
 754         else
 755         {
 756             id.push_back( OUString( &idstr[k],idx-k ) );
 757             anchor.push_back( OUString() );
 758         }
 759     }
 760
 761     listId.realloc( id.size() );
 762     listAnchor.realloc( id.size() );
 763     listTitle.realloc( id.size() );
 764
 765     for( sal_uInt32 i = 0; i < id.size(); ++i )
 766     {
 767         listId[i] = id[i];
 768         listAnchor[i] = anchor[i];
 769
 770         helpdatafileproxy::HDFData aHDFData;
 771         const sal_Char* pData = NULL;
 772
 773         if( pHdf )
 774         {
 775             OString idi( id[i].getStr(),id[i].getLength(),RTL_TEXTENCODING_UTF8 );
 776             bool bSuccess = pHdf->getValueForKey( idi, aHDFData );
 777             if( bSuccess )
 778                 pData = aHDFData.getData();
 779         }
 780
 781         DbtToStringConverter converter( pData );
 782
 783         OUString title = converter.getTitle();
 784         pDatabases->replaceName( title );
 785         listTitle[i] = title;
 786     }
 787 }
 788
 789
 790
 791 KeywordInfo::KeywordInfo( const std::vector< KeywordElement >& aVec )
 792     : listKey( aVec.size() ),
 793       listId( aVec.size() ),
 794       listAnchor( aVec.size() ),
 795       listTitle( aVec.size() )
 796 {
 797     for( unsigned int i = 0; i < aVec.size(); ++i )
 798     {
 799         listKey[i] = aVec[i].key;
 800         listId[i] = aVec[i].listId;
 801         listAnchor[i] = aVec[i].listAnchor;
 802         listTitle[i] = aVec[i].listTitle;
 803     }
 804 }
 805
 806 bool Databases::checkModuleMatchForExtension
 807     ( const OUString& Database, const OUString& doclist )
 808 {
 809     bool bBelongsToDatabase = true;
 810
 811     // Analyse doclist string to find module assignments
 812     bool bFoundAtLeastOneModule = false;
 813     bool bModuleMatch = false;
 814     sal_Int32 nLen = doclist.getLength();
 815     sal_Int32 nLastFound = doclist.lastIndexOf( sal_Unicode(';') );
 816     if( nLastFound == -1 )
 817         nLastFound = nLen;
 818     const sal_Unicode* pStr = doclist.getStr();
 819     sal_Int32 nFound = doclist.lastIndexOf( sal_Unicode('_') );
 820     while( nFound != -1 )
 821     {
 822         // Simple optimization, stop if '_' is followed by "id"
 823         if( nLen - nFound > 2 )
 824         {
 825             if( pStr[ nFound + 1 ] == sal_Unicode('i') &&
 826                 pStr[ nFound + 2 ] == sal_Unicode('d') )
 827                     break;
 828         }
 829
 830         OUString aModule = doclist.copy( nFound + 1, nLastFound - nFound - 1 );
 831         std::vector< OUString >::iterator result = std::find( m_avModules.begin(), m_avModules.end(), aModule );
 832         if( result != m_avModules.end() )
 833         {
 834             bFoundAtLeastOneModule = true;
 835             if( Database == aModule )
 836             {
 837                 bModuleMatch = true;
 838                 break;
 839             }
 840         }
 841
 842         nLastFound = nFound;
 843         if( nLastFound == 0 )
 844             break;
 845         nFound = doclist.lastIndexOf( sal_Unicode('_'), nLastFound - 1 );
 846     }
 847
 848     if( bFoundAtLeastOneModule && !bModuleMatch )
 849         bBelongsToDatabase = false;
 850
 851     return bBelongsToDatabase;
 852 }
 853
 854
 855 KeywordInfo* Databases::getKeyword( const OUString& Database,
 856                                     const OUString& Language )
 857 {
 858     osl::MutexGuard aGuard( m_aMutex );
 859
 860     OUString key = processLang(Language) + OUString( "/" ) + Database;
 861
 862     std::pair< KeywordInfoTable::iterator,bool > aPair =
 863         m_aKeywordInfo.insert( KeywordInfoTable::value_type( key,(KeywordInfo*)0 ) );
 864
 865     KeywordInfoTable::iterator it = aPair.first;
 866
 867     if( aPair.second && ! it->second )
 868     {
 869         std::vector<KeywordInfo::KeywordElement> aVector;
 870
 871         KeyDataBaseFileIterator aDbFileIt( m_xContext, *this, Database, Language );
 872         OUString fileURL;
 873         bool bExtension = false;
 874         while( !(fileURL = aDbFileIt.nextDbFile( bExtension )).isEmpty() )
 875         {
 876             OUString fileNameHDFHelp( fileURL );
 877             if( bExtension )
 878                 fileNameHDFHelp += OUString::createFromAscii( "_" );
 879             if( m_xSFA->exists( fileNameHDFHelp ) )
 880             {
 881                 helpdatafileproxy::Hdf aHdf( fileNameHDFHelp, m_xSFA );
 882                 helpdatafileproxy::HDFData aKey;
 883                 helpdatafileproxy::HDFData aValue;
 884                 if( aHdf.startIteration() )
 885                 {
 886                     helpdatafileproxy::Hdf* pHdf = getHelpDataFile( Database,Language );
 887                     if( pHdf != NULL )
 888                     {
 889                         bool bOptimizeForPerformance = true;
 890                         pHdf->releaseHashMap();
 891                         pHdf->createHashMap( bOptimizeForPerformance );
 892                     }
 893
 894                     while( aHdf.getNextKeyAndValue( aKey, aValue ) )
 895                     {
 896                         OUString keyword( aKey.getData(), aKey.getSize(),
 897                                                RTL_TEXTENCODING_UTF8 );
 898                         OUString doclist( aValue.getData(), aValue.getSize(),
 899                                                RTL_TEXTENCODING_UTF8 );
 900
 901                         bool bBelongsToDatabase = true;
 902                         if( bExtension )
 903                             bBelongsToDatabase = checkModuleMatchForExtension( Database, doclist );
 904
 905                         if( !bBelongsToDatabase )
 906                             continue;
 907
 908                         aVector.push_back( KeywordInfo::KeywordElement( this,
 909                                                                         pHdf,
 910                                                                         keyword,
 911                                                                         doclist ) );
 912                     }
 913                     aHdf.stopIteration();
 914
 915                     if( pHdf != NULL )
 916                         pHdf->releaseHashMap();
 917                 }
 918             }
 919         }
 920
 921         // sorting
 922         Reference< XCollator > xCollator = getCollator( Language,OUString());
 923         KeywordElementComparator aComparator( xCollator );
 924         std::sort(aVector.begin(),aVector.end(),aComparator);
 925
 926         KeywordInfo* pInfo = it->second = new KeywordInfo( aVector );
 927         (void)pInfo;
 928     }
 929
 930     return it->second;
 931 }
 932
 933 Reference< XHierarchicalNameAccess > Databases::jarFile( const OUString& jar,
 934                                                          const OUString& Language )
 935 {
 936     if( jar.isEmpty() || Language.isEmpty() )
 937     {
 938         return Reference< XHierarchicalNameAccess >( 0 );
 939     }
 940     OUString key = OUStringBuffer(processLang(Language)).append('/').append(jar).makeStringAndClear();
 941
 942     osl::MutexGuard aGuard( m_aMutex );
 943
 944     ZipFileTable::iterator it =
 945         m_aZipFileTable.insert( ZipFileTable::value_type( key,Reference< XHierarchicalNameAccess >(0) ) ).first;
 946
 947     if( ! it->second.is() )
 948     {
 949         OUString zipFile;
 950         try
 951         {
 952             // Extension jar file? Search for ?
 953             sal_Int32 nQuestionMark1 = jar.indexOf( sal_Unicode('?') );
 954             sal_Int32 nQuestionMark2 = jar.lastIndexOf( sal_Unicode('?') );
 955             if( nQuestionMark1 != -1 && nQuestionMark2 != -1 && nQuestionMark1 != nQuestionMark2 )
 956             {
 957                 OUString aExtensionPath = jar.copy( nQuestionMark1 + 1, nQuestionMark2 - nQuestionMark1 - 1 );
 958                 OUString aPureJar = jar.copy( nQuestionMark2 + 1 );
 959
 960                 OUStringBuffer aStrBuf;
 961                 aStrBuf.append( aExtensionPath );
 962                 aStrBuf.append( '/' );
 963                 aStrBuf.append( aPureJar );
 964
 965                 zipFile = expandURL( aStrBuf.makeStringAndClear() );
 966             }
 967             else
 968             {
 969                 zipFile = getInstallPathAsURL() + key;
 970             }
 971
 972             Sequence< Any > aArguments( 2 );
 973
 974             XInputStream_impl* p = new XInputStream_impl( zipFile );
 975             if( p->CtorSuccess() )
 976             {
 977                 Reference< XInputStream > xInputStream( p );
 978                 aArguments[ 0 ] <<= xInputStream;
 979             }
 980             else
 981             {
 982                 delete p;
 983                 aArguments[ 0 ] <<= zipFile;
 984             }
 985
 986             // let ZipPackage be used ( no manifest.xml is required )
 987             beans::NamedValue aArg;
 988             aArg.Name = OUString( "StorageFormat" );
 989             aArg.Value <<= ZIP_STORAGE_FORMAT_STRING;
 990             aArguments[ 1 ] <<= aArg;
 991
 992             Reference< XInterface > xIfc
 993                 = m_xSMgr->createInstanceWithArgumentsAndContext(
 994                     OUString(
 995                         "com.sun.star.packages.comp.ZipPackage" ),
 996                     aArguments, m_xContext );
 997
 998             if ( xIfc.is() )
 999             {
1000                 it->second = Reference< XHierarchicalNameAccess >( xIfc, UNO_QUERY );
1001
1002                 OSL_ENSURE( it->second.is(),
1003                             "ContentProvider::createPackage - "
1004                             "Got no hierarchical name access!" );
1005
1006             }
1007         }
1008         catch ( RuntimeException & )
1009         {
1010         }
1011         catch ( Exception & )
1012         {
1013         }
1014     }
1015
1016     return it->second;
1017 }
1018
1019 Reference< XHierarchicalNameAccess > Databases::findJarFileForPath
1020     ( const OUString& jar, const OUString& Language,
1021       const OUString& path, OUString* o_pExtensionPath,
1022       OUString* o_pExtensionRegistryPath )
1023 {
1024     Reference< XHierarchicalNameAccess > xNA;
1025     if( jar.isEmpty() || Language.isEmpty() )
1026     {
1027         return xNA;
1028     }
1029
1030     JarFileIterator aJarFileIt( m_xContext, *this, jar, Language );
1031     Reference< XHierarchicalNameAccess > xTestNA;
1032     Reference< deployment::XPackage > xParentPackageBundle;
1033     while( (xTestNA = aJarFileIt.nextJarFile( xParentPackageBundle, o_pExtensionPath, o_pExtensionRegistryPath )).is() )
1034     {
1035         if( xTestNA.is() && xTestNA->hasByHierarchicalName( path ) )
1036         {
1037             bool bSuccess = true;
1038             if( xParentPackageBundle.is() )
1039             {
1040                 OUString aIdentifierInPath;
1041                 sal_Int32 nFindSlash = path.indexOf( '/' );
1042                 if( nFindSlash != -1 )
1043                     aIdentifierInPath = path.copy( 0, nFindSlash );
1044
1045                 beans::Optional<OUString> aIdentifierOptional = xParentPackageBundle->getIdentifier();
1046                 if( !aIdentifierInPath.isEmpty() && aIdentifierOptional.IsPresent )
1047                 {
1048                     OUString aUnencodedIdentifier = aIdentifierOptional.Value;
1049                     OUString aIdentifier = rtl::Uri::encode( aUnencodedIdentifier,
1050                         rtl_UriCharClassPchar, rtl_UriEncodeIgnoreEscapes, RTL_TEXTENCODING_UTF8 );
1051
1052                     if( !aIdentifierInPath.equals( aIdentifier ) )
1053                     {
1054                         // path does not start with extension identifier -> ignore
1055                         bSuccess = false;
1056                     }
1057                 }
1058                 else
1059                 {
1060                     // No identifier -> ignore
1061                     bSuccess = false;
1062                 }
1063             }
1064
1065             if( bSuccess )
1066             {
1067                 xNA = xTestNA;
1068                 break;
1069             }
1070         }
1071     }
1072
1073     return xNA;
1074 }
1075
1076 void Databases::popupDocument( URLParameter* urlPar,char **buffer,int *byteCount )
1077 {
1078     const char* pop1 =
1079         " <html>                                                                "
1080         " <head>                                                                "
1081         " <help:css-file-link xmlns:help=\"http://openoffice.org/2000/help\"/>  "
1082         " </head>                                                               "
1083         " <body>                                                                "
1084         " <help:popup-cut Id=\"";
1085     const sal_Int32 l1 = strlen( pop1 );
1086
1087     const char* pop3 = "\" Eid=\"";
1088     const sal_Int32 l3 = strlen( pop3 );
1089
1090     const char* pop5 =
1091         "\" xmlns:help=\"http://openoffice.org/2000/help\"></help:popup-cut>  "
1092         " </body>                                                             "
1093         " </html>";
1094     const sal_Int32 l5 = strlen( pop5 );
1095     sal_Int32 l2,l4;
1096
1097     OUString val = urlPar->get_id();
1098     OString pop2O( val.getStr(),l2 = val.getLength(),RTL_TEXTENCODING_UTF8 );
1099     const char* pop2 = pop2O.getStr();
1100
1101     val = urlPar->get_eid();
1102     OString pop4O( val.getStr(),l4 = val.getLength(),RTL_TEXTENCODING_UTF8 );
1103     const char* pop4 = pop4O.getStr();
1104
1105     (*byteCount) = l1 + l2 + l3 + l4 + l5;
1106
1107     *buffer = new char[ 1+*byteCount ];
1108
1109     memcpy( *buffer,pop1,l1 );
1110     memcpy( *buffer+l1,pop2,l2 );
1111     memcpy( *buffer+(l1+l2),pop3,l3 );
1112     memcpy( *buffer+(l1+l2+l3),pop4,l4 );
1113     memcpy( *buffer+(l1+l2+l3+l4),pop5,l5 );
1114     (*buffer)[*byteCount] = 0;
1115 }
1116
1117
1118 void Databases::changeCSS(const OUString& newStyleSheet)
1119 {
1120     m_aCSS = newStyleSheet.toAsciiLowerCase();
1121     delete[] m_pCustomCSSDoc, m_pCustomCSSDoc = 0,m_nCustomCSSDocLength = 0;
1122 }
1123
1124
1125
1126 void Databases::cascadingStylesheet( const OUString& Language,
1127                                      char** buffer,
1128                                      int* byteCount )
1129 {
1130     if( ! m_pCustomCSSDoc )
1131     {
1132         int retry = 2;
1133         bool error = true;
1134         OUString fileURL;
1135
1136         sal_Bool bHighContrastMode = sal_False;
1137         OUString aCSS( m_aCSS );
1138         if ( aCSS.compareToAscii( "default" ) == 0 )
1139         {
1140             // #i50760: "default" needs to adapt HC mode
1141             uno::Reference< awt::XToolkit2 > xToolkit =
1142                    awt::Toolkit::create( ::comphelper::getProcessComponentContext() );
1143             uno::Reference< awt::XTopWindow > xTopWindow = xToolkit->getActiveTopWindow();
1144             if ( xTopWindow.is() )
1145             {
1146                 uno::Reference< awt::XVclWindowPeer > xVclWindowPeer( xTopWindow, uno::UNO_QUERY );
1147                 if ( xVclWindowPeer.is() )
1148                 {
1149                     uno::Any aHCMode = xVclWindowPeer->getProperty( OUString( "HighContrastMode" ) );
1150                     if ( ( aHCMode >>= bHighContrastMode ) && bHighContrastMode )
1151                     {
1152                         aCSS = OUString( "highcontrastblack" );
1153                         #ifdef WNT
1154                         HKEY hKey = NULL;
1155                         LONG lResult = RegOpenKeyExA( HKEY_CURRENT_USER, "Control Panel\\Accessibility\\HighContrast", 0, KEY_QUERY_VALUE, &hKey );
1156                         if ( ERROR_SUCCESS == lResult )
1157                         {
1158                             CHAR szBuffer[1024];
1159                             DWORD nSize = sizeof( szBuffer );
1160                             lResult = RegQueryValueExA( hKey, "High Contrast Scheme", NULL, NULL, (LPBYTE)szBuffer, &nSize );
1161                             if ( ERROR_SUCCESS == lResult && nSize > 0 )
1162                             {
1163                                 szBuffer[nSize] = '\0';
1164                                 if ( strncmp( szBuffer, "High Contrast #1", strlen("High Contrast #1") ) == 0 )
1165                                     aCSS = OUString( "highcontrast1" );
1166                                 if ( strncmp( szBuffer, "High Contrast #2", strlen("High Contrast #2") ) == 0 )
1167                                     aCSS = OUString( "highcontrast2" );
1168                                 if ( strncmp( szBuffer, "High Contrast White", strlen("High Contrast White") ) == 0 )
1169                                     aCSS = OUString( "highcontrastwhite" );
1170                             }
1171                             RegCloseKey( hKey );
1172                         }
1173                         #endif
1174                     }
1175                 }
1176             }
1177         }
1178
1179         while( error && retry )
1180         {
1181
1182             if( retry == 2 )
1183                 fileURL =
1184                     getInstallPathAsURL()  +
1185                     processLang( Language )       +
1186                     OUString( "/" ) +
1187                     aCSS +
1188                     OUString( ".css" );
1189             else if( retry == 1 )
1190                 fileURL =
1191                     getInstallPathAsURL()  +
1192                     aCSS +
1193                     OUString( ".css" );
1194
1195             osl::DirectoryItem aDirItem;
1196             osl::File aFile( fileURL );
1197             osl::FileStatus aStatus( osl_FileStatus_Mask_FileSize );
1198
1199             if( osl::FileBase::E_None == osl::DirectoryItem::get( fileURL,aDirItem ) &&
1200                 osl::FileBase::E_None == aFile.open( osl_File_OpenFlag_Read )        &&
1201                 osl::FileBase::E_None == aDirItem.getFileStatus( aStatus ) )
1202             {
1203                 sal_uInt64 nSize;
1204                 aFile.getSize( nSize );
1205                 m_nCustomCSSDocLength = (int)nSize;
1206                 m_pCustomCSSDoc = new char[ 1 + m_nCustomCSSDocLength ];
1207                 m_pCustomCSSDoc[ m_nCustomCSSDocLength ] = 0;
1208                 sal_uInt64 a = m_nCustomCSSDocLength,b = m_nCustomCSSDocLength;
1209                 aFile.read( m_pCustomCSSDoc,a,b );
1210                 aFile.close();
1211                 error = false;
1212             }
1213
1214             --retry;
1215             if ( !retry && error && bHighContrastMode )
1216             {
1217                 // fall back to default css
1218                 aCSS = OUString( "default" );
1219                 retry = 2;
1220                 bHighContrastMode = sal_False;
1221             }
1222         }
1223
1224         if( error )
1225         {
1226             m_nCustomCSSDocLength = 0;
1227             m_pCustomCSSDoc = new char[ 1 ]; // Initialize with 1 to avoid gcc compiler warning
1228         }
1229     }
1230
1231     *byteCount = m_nCustomCSSDocLength;
1232     *buffer = new char[ 1 + *byteCount ];
1233     (*buffer)[*byteCount] = 0;
1234     memcpy( *buffer,m_pCustomCSSDoc,m_nCustomCSSDocLength );
1235
1236 }
1237
1238
1239 void Databases::setActiveText( const OUString& Module,
1240                                const OUString& Language,
1241                                const OUString& Id,
1242                                char** buffer,
1243                                int* byteCount )
1244 {
1245     DataBaseIterator aDbIt( m_xContext, *this, Module, Language, true );
1246
1247     // #i84550 Cache information about failed ids
1248     OString id( Id.getStr(),Id.getLength(),RTL_TEXTENCODING_UTF8 );
1249     EmptyActiveTextSet::iterator it = m_aEmptyActiveTextSet.find( id );
1250     bool bFoundAsEmpty = ( it != m_aEmptyActiveTextSet.end() );
1251     helpdatafileproxy::HDFData aHDFData;
1252
1253     int nSize = 0;
1254     const sal_Char* pData = NULL;
1255
1256     bool bSuccess = false;
1257     if( !bFoundAsEmpty )
1258     {
1259         helpdatafileproxy::Hdf* pHdf = 0;
1260         while( !bSuccess && (pHdf = aDbIt.nextHdf()) != NULL )
1261         {
1262             bSuccess = pHdf->getValueForKey( id, aHDFData );
1263             nSize = aHDFData.getSize();
1264             pData = aHDFData.getData();
1265         }
1266     }
1267
1268     if( bSuccess )
1269     {
1270         // ensure existence of tmp after for
1271         OString tmp;
1272         for( int i = 0; i < nSize; ++i )
1273             if( pData[i] == '%' || pData[i] == '$' )
1274             {
1275                 // need of replacement
1276                 OUString temp = OUString( pData, nSize, RTL_TEXTENCODING_UTF8 );
1277                 replaceName( temp );
1278                 tmp = OString( temp.getStr(),
1279                                     temp.getLength(),
1280                                     RTL_TEXTENCODING_UTF8 );
1281                 nSize = tmp.getLength();
1282                 pData = tmp.getStr();
1283                 break;
1284             }
1285
1286         *byteCount = nSize;
1287         *buffer = new char[ 1 + nSize ];
1288         (*buffer)[nSize] = 0;
1289         memcpy( *buffer, pData, nSize );
1290     }
1291     else
1292     {
1293         *byteCount = 0;
1294         *buffer = new char[1]; // Initialize with 1 to avoid compiler warnings
1295         if( !bFoundAsEmpty )
1296             m_aEmptyActiveTextSet.insert( id );
1297     }
1298 }
1299
1300
1301 void Databases::setInstallPath( const OUString& aInstDir )
1302 {
1303     osl::MutexGuard aGuard( m_aMutex );
1304
1305     osl::FileBase::getFileURLFromSystemPath( aInstDir,m_aInstallDirectory );
1306         //TODO: check returned error code
1307
1308     if( m_aInstallDirectory.lastIndexOf( sal_Unicode( '/' ) ) != m_aInstallDirectory.getLength() - 1 )
1309         m_aInstallDirectory += OUString( "/" );
1310 }
1311
1312
1313 //===================================================================
1314 // class ExtensionIteratorBase
1315
1316 ExtensionHelpExistanceMap ExtensionIteratorBase::aHelpExistanceMap;
1317
1318 ExtensionIteratorBase::ExtensionIteratorBase( Reference< XComponentContext > xContext,
1319     Databases& rDatabases, const OUString& aInitialModule, const OUString& aLanguage )
1320         : m_xContext( xContext )
1321         , m_rDatabases( rDatabases )
1322         , m_eState( INITIAL_MODULE )
1323         , m_aInitialModule( aInitialModule )
1324         , m_aLanguage( aLanguage )
1325 {
1326     assert( m_xContext.is() );
1327     init();
1328 }
1329
1330 ExtensionIteratorBase::ExtensionIteratorBase( Databases& rDatabases,
1331     const OUString& aInitialModule, const OUString& aLanguage )
1332         : m_xContext( comphelper::getProcessComponentContext() )
1333         , m_rDatabases( rDatabases )
1334         , m_eState( INITIAL_MODULE )
1335         , m_aInitialModule( aInitialModule )
1336         , m_aLanguage( aLanguage )
1337 {
1338     init();
1339 }
1340
1341 void ExtensionIteratorBase::init()
1342 {
1343     m_xSFA = ucb::SimpleFileAccess::create(m_xContext);
1344
1345     m_bUserPackagesLoaded = false;
1346     m_bSharedPackagesLoaded = false;
1347     m_bBundledPackagesLoaded = false;
1348     m_iUserPackage = 0;
1349     m_iSharedPackage = 0;
1350     m_iBundledPackage = 0;
1351 }
1352
1353 Reference< deployment::XPackage > ExtensionIteratorBase::implGetHelpPackageFromPackage
1354     ( Reference< deployment::XPackage > xPackage, Reference< deployment::XPackage >& o_xParentPackageBundle )
1355 {
1356     o_xParentPackageBundle.clear();
1357
1358     Reference< deployment::XPackage > xHelpPackage;
1359     if( !xPackage.is() )
1360         return xHelpPackage;
1361
1362     // #i84550 Cache information about help content in extension
1363     OUString aExtensionPath = xPackage->getURL();
1364     ExtensionHelpExistanceMap::iterator it = aHelpExistanceMap.find( aExtensionPath );
1365     bool bFound = ( it != aHelpExistanceMap.end() );
1366     bool bHasHelp = bFound ? it->second : false;
1367     if( bFound && !bHasHelp )
1368         return xHelpPackage;
1369
1370     // Check if parent package is registered
1371     beans::Optional< beans::Ambiguous<sal_Bool> > option( xPackage->isRegistered
1372         ( Reference<task::XAbortChannel>(), Reference<ucb::XCommandEnvironment>() ) );
1373     bool bRegistered = false;
1374     if( option.IsPresent )
1375     {
1376         beans::Ambiguous<sal_Bool> const & reg = option.Value;
1377         if( !reg.IsAmbiguous && reg.Value )
1378             bRegistered = true;
1379     }
1380     if( bRegistered )
1381     {
1382         OUString aHelpMediaType( "application/vnd.sun.star.help" );
1383         if( xPackage->isBundle() )
1384         {
1385             Sequence< Reference< deployment::XPackage > > aPkgSeq = xPackage->getBundle
1386                 ( Reference<task::XAbortChannel>(), Reference<ucb::XCommandEnvironment>() );
1387             sal_Int32 nPkgCount = aPkgSeq.getLength();
1388             const Reference< deployment::XPackage >* pSeq = aPkgSeq.getConstArray();
1389             for( sal_Int32 iPkg = 0 ; iPkg < nPkgCount ; ++iPkg )
1390             {
1391                 const Reference< deployment::XPackage > xSubPkg = pSeq[ iPkg ];
1392                 const Reference< deployment::XPackageTypeInfo > xPackageTypeInfo = xSubPkg->getPackageType();
1393                 OUString aMediaType = xPackageTypeInfo->getMediaType();
1394                 if( aMediaType.equals( aHelpMediaType ) )
1395                 {
1396                     xHelpPackage = xSubPkg;
1397                     o_xParentPackageBundle = xPackage;
1398                     break;
1399                 }
1400             }
1401         }
1402         else
1403         {
1404             const Reference< deployment::XPackageTypeInfo > xPackageTypeInfo = xPackage->getPackageType();
1405             OUString aMediaType = xPackageTypeInfo->getMediaType();
1406             if( aMediaType.equals( aHelpMediaType ) )
1407                 xHelpPackage = xPackage;
1408         }
1409     }
1410
1411     if( !bFound )
1412         aHelpExistanceMap[ aExtensionPath ] = xHelpPackage.is();
1413
1414     return xHelpPackage;
1415 }
1416
1417 Reference< deployment::XPackage > ExtensionIteratorBase::implGetNextUserHelpPackage
1418     ( Reference< deployment::XPackage >& o_xParentPackageBundle )
1419 {
1420     Reference< deployment::XPackage > xHelpPackage;
1421
1422     if( !m_bUserPackagesLoaded )
1423     {
1424         Reference< XExtensionManager > xExtensionManager = ExtensionManager::get(m_xContext);
1425         m_aUserPackagesSeq = xExtensionManager->getDeployedExtensions
1426             ( OUString("user"), Reference< task::XAbortChannel >(), Reference< ucb::XCommandEnvironment >() );
1427         m_bUserPackagesLoaded = true;
1428     }
1429
1430     if( m_iUserPackage == m_aUserPackagesSeq.getLength() )
1431     {
1432         m_eState = SHARED_EXTENSIONS;       // Later: SHARED_MODULE
1433     }
1434     else
1435     {
1436         const Reference< deployment::XPackage >* pUserPackages = m_aUserPackagesSeq.getConstArray();
1437         Reference< deployment::XPackage > xPackage = pUserPackages[ m_iUserPackage++ ];
1438         OSL_ENSURE( xPackage.is(), "ExtensionIteratorBase::implGetNextUserHelpPackage(): Invalid package" );
1439         xHelpPackage = implGetHelpPackageFromPackage( xPackage, o_xParentPackageBundle );
1440     }
1441
1442     return xHelpPackage;
1443 }
1444
1445 Reference< deployment::XPackage > ExtensionIteratorBase::implGetNextSharedHelpPackage
1446     ( Reference< deployment::XPackage >& o_xParentPackageBundle )
1447 {
1448     Reference< deployment::XPackage > xHelpPackage;
1449
1450     if( !m_bSharedPackagesLoaded )
1451     {
1452         Reference< XExtensionManager > xExtensionManager = ExtensionManager::get(m_xContext);
1453         m_aSharedPackagesSeq = xExtensionManager->getDeployedExtensions
1454             ( OUString("shared"), Reference< task::XAbortChannel >(), Reference< ucb::XCommandEnvironment >() );
1455         m_bSharedPackagesLoaded = true;
1456     }
1457
1458     if( m_iSharedPackage == m_aSharedPackagesSeq.getLength() )
1459     {
1460         m_eState = BUNDLED_EXTENSIONS;
1461     }
1462     else
1463     {
1464         const Reference< deployment::XPackage >* pSharedPackages = m_aSharedPackagesSeq.getConstArray();
1465         Reference< deployment::XPackage > xPackage = pSharedPackages[ m_iSharedPackage++ ];
1466         OSL_ENSURE( xPackage.is(), "ExtensionIteratorBase::implGetNextSharedHelpPackage(): Invalid package" );
1467         xHelpPackage = implGetHelpPackageFromPackage( xPackage, o_xParentPackageBundle );
1468     }
1469
1470     return xHelpPackage;
1471 }
1472
1473 Reference< deployment::XPackage > ExtensionIteratorBase::implGetNextBundledHelpPackage
1474     ( Reference< deployment::XPackage >& o_xParentPackageBundle )
1475 {
1476     Reference< deployment::XPackage > xHelpPackage;
1477
1478     if( !m_bBundledPackagesLoaded )
1479     {
1480         Reference< XExtensionManager > xExtensionManager = ExtensionManager::get(m_xContext);
1481         m_aBundledPackagesSeq = xExtensionManager->getDeployedExtensions
1482             ( OUString("bundled"), Reference< task::XAbortChannel >(), Reference< ucb::XCommandEnvironment >() );
1483         m_bBundledPackagesLoaded = true;
1484     }
1485
1486     if( m_iBundledPackage == m_aBundledPackagesSeq.getLength() )
1487     {
1488         m_eState = END_REACHED;
1489     }
1490     else
1491     {
1492         const Reference< deployment::XPackage >* pBundledPackages =
1493             m_aBundledPackagesSeq.getConstArray();
1494         Reference< deployment::XPackage > xPackage = pBundledPackages[ m_iBundledPackage++ ];
1495         OSL_ENSURE( xPackage.is(), "ExtensionIteratorBase::implGetNextBundledHelpPackage(): Invalid package" );
1496         xHelpPackage = implGetHelpPackageFromPackage( xPackage, o_xParentPackageBundle );
1497     }
1498
1499     return xHelpPackage;
1500 }
1501
1502 OUString ExtensionIteratorBase::implGetFileFromPackage(
1503     const OUString& rFileExtension, Reference< deployment::XPackage > xPackage )
1504 {
1505     // No extension -> search for pure language folder
1506     bool bLangFolderOnly = rFileExtension.isEmpty();
1507
1508     OUString aFile;
1509     OUString aLanguage = m_aLanguage;
1510     for( sal_Int32 iPass = 0 ; iPass < 2 ; ++iPass )
1511     {
1512         OUStringBuffer aStrBuf;
1513         aStrBuf.append( xPackage->getRegistrationDataURL().Value);
1514         aStrBuf.append( '/' );
1515         aStrBuf.append( aLanguage );
1516         if( !bLangFolderOnly )
1517         {
1518             aStrBuf.append( '/' );
1519             aStrBuf.append( "help" );
1520             aStrBuf.append( rFileExtension );
1521         }
1522
1523         aFile = m_rDatabases.expandURL( aStrBuf.makeStringAndClear() );
1524         if( iPass == 0 )
1525         {
1526             if( m_xSFA->exists( aFile ) )
1527                 break;
1528
1529             ::std::vector< OUString > av;
1530             implGetLanguageVectorFromPackage( av, xPackage );
1531             ::std::vector< OUString >::const_iterator pFound = LanguageTag::getFallback( av, m_aLanguage );
1532             if( pFound != av.end() )
1533                 aLanguage = *pFound;
1534         }
1535     }
1536     return aFile;
1537 }
1538
1539 inline bool isLetter( sal_Unicode c )
1540 {
1541     return comphelper::string::isalphaAscii(c);
1542 }
1543
1544 void ExtensionIteratorBase::implGetLanguageVectorFromPackage( ::std::vector< OUString > &rv,
1545     com::sun::star::uno::Reference< com::sun::star::deployment::XPackage > xPackage )
1546 {
1547     rv.clear();
1548     OUString aExtensionPath = xPackage->getURL();
1549     Sequence< OUString > aEntrySeq = m_xSFA->getFolderContents( aExtensionPath, true );
1550
1551     const OUString* pSeq = aEntrySeq.getConstArray();
1552     sal_Int32 nCount = aEntrySeq.getLength();
1553     for( sal_Int32 i = 0 ; i < nCount ; ++i )
1554     {
1555         OUString aEntry = pSeq[i];
1556         if( m_xSFA->isFolder( aEntry ) )
1557         {
1558             sal_Int32 nLastSlash = aEntry.lastIndexOf( '/' );
1559             if( nLastSlash != -1 )
1560             {
1561                 OUString aPureEntry = aEntry.copy( nLastSlash + 1 );
1562
1563                 // Check language scheme
1564                 int nLen = aPureEntry.getLength();
1565                 const sal_Unicode* pc = aPureEntry.getStr();
1566                 bool bStartCanBeLanguage = ( nLen >= 2 && isLetter( pc[0] ) && isLetter( pc[1] ) );
1567                 bool bIsLanguage = bStartCanBeLanguage &&
1568                     ( nLen == 2 || (nLen == 5 && pc[2] == '-' && isLetter( pc[3] ) && isLetter( pc[4] )) );
1569                 if( bIsLanguage )
1570                     rv.push_back( aPureEntry );
1571             }
1572         }
1573     }
1574 }
1575
1576
1577 //===================================================================
1578 // class DataBaseIterator
1579
1580 helpdatafileproxy::Hdf* DataBaseIterator::nextHdf( OUString* o_pExtensionPath, OUString* o_pExtensionRegistryPath )
1581 {
1582     helpdatafileproxy::Hdf* pRetHdf = NULL;
1583
1584     while( !pRetHdf && m_eState != END_REACHED )
1585     {
1586         switch( m_eState )
1587         {
1588             case INITIAL_MODULE:
1589                 pRetHdf = m_rDatabases.getHelpDataFile( m_aInitialModule, m_aLanguage, m_bHelpText );
1590                 m_eState = USER_EXTENSIONS;     // Later: SHARED_MODULE
1591                 break;
1592
1593             // Later:
1594             //case SHARED_MODULE
1595                 //...
1596
1597             case USER_EXTENSIONS:
1598             {
1599                 Reference< deployment::XPackage > xParentPackageBundle;
1600                 Reference< deployment::XPackage > xHelpPackage = implGetNextUserHelpPackage( xParentPackageBundle );
1601                 if( !xHelpPackage.is() )
1602                     break;
1603                 pRetHdf = implGetHdfFromPackage( xHelpPackage, o_pExtensionPath, o_pExtensionRegistryPath );
1604                 break;
1605             }
1606
1607             case SHARED_EXTENSIONS:
1608             {
1609                 Reference< deployment::XPackage > xParentPackageBundle;
1610                 Reference< deployment::XPackage > xHelpPackage = implGetNextSharedHelpPackage( xParentPackageBundle );
1611                 if( !xHelpPackage.is() )
1612                     break;
1613
1614                 pRetHdf = implGetHdfFromPackage( xHelpPackage, o_pExtensionPath, o_pExtensionRegistryPath );
1615                 break;
1616             }
1617
1618                case BUNDLED_EXTENSIONS:
1619             {
1620                 Reference< deployment::XPackage > xParentPackageBundle;
1621                 Reference< deployment::XPackage > xHelpPackage = implGetNextBundledHelpPackage( xParentPackageBundle );
1622                 if( !xHelpPackage.is() )
1623                     break;
1624
1625                 pRetHdf = implGetHdfFromPackage( xHelpPackage, o_pExtensionPath, o_pExtensionRegistryPath );
1626                 break;
1627             }
1628
1629             case END_REACHED:
1630                 OSL_FAIL( "DataBaseIterator::nextDb(): Invalid case END_REACHED" );
1631                 break;
1632         }
1633     }
1634
1635     return pRetHdf;
1636 }
1637
1638 helpdatafileproxy::Hdf* DataBaseIterator::implGetHdfFromPackage( Reference< deployment::XPackage > xPackage,
1639             OUString* o_pExtensionPath, OUString* o_pExtensionRegistryPath )
1640 {
1641
1642     beans::Optional< OUString> optRegData;
1643     try
1644     {
1645         optRegData = xPackage->getRegistrationDataURL();
1646     }
1647     catch ( deployment::ExtensionRemovedException&)
1648     {
1649         return NULL;
1650     }
1651
1652     helpdatafileproxy::Hdf* pRetHdf = NULL;
1653     if (optRegData.IsPresent && !optRegData.Value.isEmpty())
1654     {
1655         OUString aRegDataUrl = OUStringBuffer(optRegData.Value).append('/').makeStringAndClear();
1656
1657         OUString aHelpFilesBaseName("help");
1658
1659         OUString aUsedLanguage = m_aLanguage;
1660         pRetHdf = m_rDatabases.getHelpDataFile(
1661             aHelpFilesBaseName, aUsedLanguage, m_bHelpText, &aRegDataUrl);
1662
1663         // Language fallback
1664         if( !pRetHdf )
1665         {
1666             ::std::vector< OUString > av;
1667             implGetLanguageVectorFromPackage( av, xPackage );
1668             ::std::vector< OUString >::const_iterator pFound = LanguageTag::getFallback( av, m_aLanguage );
1669             if( pFound != av.end() )
1670             {
1671                 aUsedLanguage = *pFound;
1672                 pRetHdf = m_rDatabases.getHelpDataFile(
1673                     aHelpFilesBaseName, aUsedLanguage, m_bHelpText, &aRegDataUrl);
1674             }
1675         }
1676
1677         if( o_pExtensionPath )
1678             *o_pExtensionPath = aRegDataUrl + aUsedLanguage;
1679
1680         if( o_pExtensionRegistryPath )
1681             *o_pExtensionRegistryPath = OUStringBuffer(xPackage->getURL()).append('/').append(aUsedLanguage).makeStringAndClear();
1682     }
1683
1684     return pRetHdf;
1685 }
1686
1687
1688 //===================================================================
1689 // class KeyDataBaseFileIterator
1690
1691 //returns a file URL
1692 OUString KeyDataBaseFileIterator::nextDbFile( bool& o_rbExtension )
1693 {
1694     OUString aRetFile;
1695
1696     while( aRetFile.isEmpty() && m_eState != END_REACHED )
1697     {
1698         switch( m_eState )
1699         {
1700             case INITIAL_MODULE:
1701                 aRetFile = OUStringBuffer(m_rDatabases.getInstallPathAsURL()).
1702                     append(m_rDatabases.processLang(m_aLanguage)).append('/').
1703                     append(m_aInitialModule).append(".key").makeStringAndClear();
1704
1705                 o_rbExtension = false;
1706
1707                 m_eState = USER_EXTENSIONS;     // Later: SHARED_MODULE
1708                 break;
1709
1710             // Later:
1711             //case SHARED_MODULE
1712                 //...
1713
1714             case USER_EXTENSIONS:
1715             {
1716                 Reference< deployment::XPackage > xParentPackageBundle;
1717                 Reference< deployment::XPackage > xHelpPackage = implGetNextUserHelpPackage( xParentPackageBundle );
1718                 if( !xHelpPackage.is() )
1719                     break;
1720
1721                 aRetFile = implGetDbFileFromPackage( xHelpPackage );
1722                 o_rbExtension = true;
1723                 break;
1724             }
1725
1726             case SHARED_EXTENSIONS:
1727             {
1728                 Reference< deployment::XPackage > xParentPackageBundle;
1729                 Reference< deployment::XPackage > xHelpPackage = implGetNextSharedHelpPackage( xParentPackageBundle );
1730                 if( !xHelpPackage.is() )
1731                     break;
1732
1733                 aRetFile = implGetDbFileFromPackage( xHelpPackage );
1734                 o_rbExtension = true;
1735                 break;
1736             }
1737
1738             case BUNDLED_EXTENSIONS:
1739             {
1740                 Reference< deployment::XPackage > xParentPackageBundle;
1741                 Reference< deployment::XPackage > xHelpPackage = implGetNextBundledHelpPackage( xParentPackageBundle );
1742                 if( !xHelpPackage.is() )
1743                     break;
1744
1745                 aRetFile = implGetDbFileFromPackage( xHelpPackage );
1746                 o_rbExtension = true;
1747                 break;
1748             }
1749
1750             case END_REACHED:
1751                 OSL_FAIL( "DataBaseIterator::nextDbFile(): Invalid case END_REACHED" );
1752                 break;
1753         }
1754     }
1755
1756     return aRetFile;
1757 }
1758
1759 //Returns a file URL, that does not contain macros
1760 OUString KeyDataBaseFileIterator::implGetDbFileFromPackage
1761     ( Reference< deployment::XPackage > xPackage )
1762 {
1763     OUString aExpandedURL =
1764         implGetFileFromPackage( OUString( ".key" ), xPackage );
1765
1766     return aExpandedURL;
1767 }
1768
1769
1770 //===================================================================
1771 // class JarFileIterator
1772
1773 Reference< XHierarchicalNameAccess > JarFileIterator::nextJarFile
1774     ( Reference< deployment::XPackage >& o_xParentPackageBundle,
1775         OUString* o_pExtensionPath, OUString* o_pExtensionRegistryPath )
1776 {
1777     Reference< XHierarchicalNameAccess > xNA;
1778
1779     while( !xNA.is() && m_eState != END_REACHED )
1780     {
1781         switch( m_eState )
1782         {
1783             case INITIAL_MODULE:
1784                 xNA = m_rDatabases.jarFile( m_aInitialModule, m_aLanguage );
1785                 m_eState = USER_EXTENSIONS;     // Later: SHARED_MODULE
1786                 break;
1787
1788             // Later:
1789             //case SHARED_MODULE
1790                 //...
1791
1792             case USER_EXTENSIONS:
1793             {
1794                 Reference< deployment::XPackage > xHelpPackage = implGetNextUserHelpPackage( o_xParentPackageBundle );
1795                 if( !xHelpPackage.is() )
1796                     break;
1797
1798                 xNA = implGetJarFromPackage( xHelpPackage, o_pExtensionPath, o_pExtensionRegistryPath );
1799                 break;
1800             }
1801
1802             case SHARED_EXTENSIONS:
1803             {
1804                 Reference< deployment::XPackage > xHelpPackage = implGetNextSharedHelpPackage( o_xParentPackageBundle );
1805                 if( !xHelpPackage.is() )
1806                     break;
1807
1808                 xNA = implGetJarFromPackage( xHelpPackage, o_pExtensionPath, o_pExtensionRegistryPath );
1809                 break;
1810             }
1811
1812             case BUNDLED_EXTENSIONS:
1813             {
1814                 Reference< deployment::XPackage > xHelpPackage = implGetNextBundledHelpPackage( o_xParentPackageBundle );
1815                 if( !xHelpPackage.is() )
1816                     break;
1817
1818                 xNA = implGetJarFromPackage( xHelpPackage, o_pExtensionPath, o_pExtensionRegistryPath );
1819                 break;
1820             }
1821
1822             case END_REACHED:
1823                 OSL_FAIL( "JarFileIterator::nextJarFile(): Invalid case END_REACHED" );
1824                 break;
1825         }
1826     }
1827
1828     return xNA;
1829 }
1830
1831 Reference< XHierarchicalNameAccess > JarFileIterator::implGetJarFromPackage
1832 ( Reference< deployment::XPackage > xPackage, OUString* o_pExtensionPath, OUString* o_pExtensionRegistryPath )
1833 {
1834     Reference< XHierarchicalNameAccess > xNA;
1835
1836     OUString zipFile =
1837         implGetFileFromPackage( OUString( ".jar" ), xPackage );
1838
1839     try
1840     {
1841         Sequence< Any > aArguments( 2 );
1842         aArguments[ 0 ] <<= zipFile;
1843
1844         // let ZipPackage be used ( no manifest.xml is required )
1845         beans::NamedValue aArg;
1846         aArg.Name = OUString( "StorageFormat" );
1847         aArg.Value <<= ZIP_STORAGE_FORMAT_STRING;
1848         aArguments[ 1 ] <<= aArg;
1849
1850         Reference< XMultiComponentFactory >xSMgr( m_xContext->getServiceManager(), UNO_QUERY );
1851         Reference< XInterface > xIfc
1852             = xSMgr->createInstanceWithArgumentsAndContext(
1853                 OUString(
1854                     "com.sun.star.packages.comp.ZipPackage" ),
1855                 aArguments, m_xContext );
1856
1857         if ( xIfc.is() )
1858         {
1859             xNA = Reference< XHierarchicalNameAccess >( xIfc, UNO_QUERY );
1860
1861             OSL_ENSURE( xNA.is(),
1862                 "JarFileIterator::implGetJarFromPackage() - "
1863                 "Got no hierarchical name access!" );
1864         }
1865     }
1866     catch ( RuntimeException & )
1867     {}
1868     catch ( Exception & )
1869     {}
1870
1871     if( xNA.is() && o_pExtensionPath != NULL )
1872     {
1873         // Extract path including language from file name
1874         sal_Int32 nLastSlash = zipFile.lastIndexOf( '/' );
1875         if( nLastSlash != -1 )
1876             *o_pExtensionPath = zipFile.copy( 0, nLastSlash );
1877
1878         if( o_pExtensionRegistryPath != NULL )
1879         {
1880             OUString& rPath = *o_pExtensionPath;
1881             sal_Int32 nLastSlashInPath = rPath.lastIndexOf( '/', rPath.getLength() - 1 );
1882
1883             *o_pExtensionRegistryPath = xPackage->getURL();
1884             *o_pExtensionRegistryPath += rPath.copy( nLastSlashInPath);
1885         }
1886     }
1887
1888     return xNA;
1889 }
1890
1891
1892 //===================================================================
1893 // class IndexFolderIterator
1894
1895 OUString IndexFolderIterator::nextIndexFolder( bool& o_rbExtension, bool& o_rbTemporary )
1896 {
1897     OUString aIndexFolder;
1898
1899     while( aIndexFolder.isEmpty() && m_eState != END_REACHED )
1900     {
1901         switch( m_eState )
1902         {
1903             case INITIAL_MODULE:
1904                 aIndexFolder = OUStringBuffer(m_rDatabases.getInstallPathAsURL()).
1905                     append(m_rDatabases.processLang(m_aLanguage)).append('/').
1906                     append(m_aInitialModule).append(".idxl").makeStringAndClear();
1907
1908                 o_rbTemporary = false;
1909                 o_rbExtension = false;
1910
1911                 m_eState = USER_EXTENSIONS;     // Later: SHARED_MODULE
1912                 break;
1913
1914             // Later:
1915             //case SHARED_MODULE
1916                 //...
1917
1918             case USER_EXTENSIONS:
1919             {
1920                 Reference< deployment::XPackage > xParentPackageBundle;
1921                 Reference< deployment::XPackage > xHelpPackage = implGetNextUserHelpPackage( xParentPackageBundle );
1922                 if( !xHelpPackage.is() )
1923                     break;
1924
1925                 aIndexFolder = implGetIndexFolderFromPackage( o_rbTemporary, xHelpPackage );
1926                 o_rbExtension = true;
1927                 break;
1928             }
1929
1930             case SHARED_EXTENSIONS:
1931             {
1932                 Reference< deployment::XPackage > xParentPackageBundle;
1933                 Reference< deployment::XPackage > xHelpPackage = implGetNextSharedHelpPackage( xParentPackageBundle );
1934                 if( !xHelpPackage.is() )
1935                     break;
1936
1937                 aIndexFolder = implGetIndexFolderFromPackage( o_rbTemporary, xHelpPackage );
1938                 o_rbExtension = true;
1939                 break;
1940             }
1941
1942             case BUNDLED_EXTENSIONS:
1943             {
1944                 Reference< deployment::XPackage > xParentPackageBundle;
1945                 Reference< deployment::XPackage > xHelpPackage = implGetNextBundledHelpPackage( xParentPackageBundle );
1946                 if( !xHelpPackage.is() )
1947                     break;
1948
1949                 aIndexFolder = implGetIndexFolderFromPackage( o_rbTemporary, xHelpPackage );
1950                 o_rbExtension = true;
1951                 break;
1952             }
1953
1954             case END_REACHED:
1955                 OSL_FAIL( "IndexFolderIterator::nextIndexFolder(): Invalid case END_REACHED" );
1956                 break;
1957         }
1958     }
1959
1960     return aIndexFolder;
1961 }
1962
1963 OUString IndexFolderIterator::implGetIndexFolderFromPackage( bool& o_rbTemporary, Reference< deployment::XPackage > xPackage )
1964 {
1965     OUString aIndexFolder =
1966         implGetFileFromPackage( OUString( ".idxl" ), xPackage );
1967
1968     o_rbTemporary = false;
1969     if( !m_xSFA->isFolder( aIndexFolder ) )
1970     {
1971         // i98680: Missing index? Try to generate now
1972         OUString aLangURL = implGetFileFromPackage( OUString(), xPackage );
1973         if( m_xSFA->isFolder( aLangURL ) )
1974         {
1975             // Test write access (shared extension may be read only)
1976             bool bIsWriteAccess = false;
1977             try
1978             {
1979                 OUString aCreateTestFolder = aLangURL + OUString( "CreateTestFolder" );
1980                 m_xSFA->createFolder( aCreateTestFolder );
1981                 if( m_xSFA->isFolder( aCreateTestFolder  ) )
1982                     bIsWriteAccess = true;
1983
1984                 m_xSFA->kill( aCreateTestFolder );
1985             }
1986             catch (const Exception &)
1987             {
1988             }
1989
1990             // TEST
1991             //bIsWriteAccess = false;
1992
1993             try
1994             {
1995                 OUString aLang;
1996                 sal_Int32 nLastSlash = aLangURL.lastIndexOf( '/' );
1997                 if( nLastSlash != -1 )
1998                     aLang = aLangURL.copy( nLastSlash + 1 );
1999                 else
2000                     aLang = OUString( "en" );
2001
2002                 OUString aMod("help");
2003
2004                 OUString aZipDir = aLangURL;
2005                 if( !bIsWriteAccess )
2006                 {
2007                     OUString aTempFileURL;
2008                     ::osl::FileBase::RC eErr = ::osl::File::createTempFile( 0, 0, &aTempFileURL );
2009                     if( eErr == ::osl::FileBase::E_None )
2010                     {
2011                         OUString aTempDirURL = aTempFileURL;
2012                         try
2013                         {
2014                             m_xSFA->kill( aTempDirURL );
2015                         }
2016                         catch (const Exception &)
2017                         {
2018                         }
2019                         m_xSFA->createFolder( aTempDirURL );
2020
2021                         aZipDir = aTempDirURL;
2022                         o_rbTemporary = true;
2023                     }
2024                 }
2025
2026         HelpIndexer aIndexer(aLang, aMod, aLangURL, aZipDir);
2027         aIndexer.indexDocuments();
2028
2029                 if( bIsWriteAccess )
2030                     aIndexFolder = implGetFileFromPackage( OUString( ".idxl" ), xPackage );
2031                 else
2032                     aIndexFolder = aZipDir + OUString( "/help.idxl" );
2033             }
2034             catch (const Exception &)
2035             {
2036             }
2037         }
2038     }
2039
2040     return aIndexFolder;
2041 }
2042
2043 void IndexFolderIterator::deleteTempIndexFolder( const OUString& aIndexFolder )
2044 {
2045     sal_Int32 nLastSlash = aIndexFolder.lastIndexOf( '/' );
2046     if( nLastSlash != -1 )
2047     {
2048         OUString aTmpFolder = aIndexFolder.copy( 0, nLastSlash );
2049         try
2050         {
2051             m_xSFA->kill( aTmpFolder );
2052         }
2053         catch (const Exception &)
2054         {
2055         }
2056     }
2057 }
2058
2059 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */