sfx2/source/appl/sfxhelp.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 <sfx2/sfxhelp.hxx>
  21
  22 #include <set>
  23 #include <algorithm>
  24 #include <com/sun/star/uno/Reference.h>
  25 #include <com/sun/star/frame/Desktop.hpp>
  26 #include <com/sun/star/frame/XFrame2.hpp>
  27 #include <com/sun/star/frame/XComponentLoader.hpp>
  28 #include <com/sun/star/lang/XComponent.hpp>
  29 #include <comphelper/processfactory.hxx>
  30 #include <com/sun/star/awt/XWindow.hpp>
  31 #include <com/sun/star/awt/XTopWindow.hpp>
  32 #include <com/sun/star/awt/PosSize.hpp>
  33 #include <com/sun/star/frame/XDesktop.hpp>
  34 #include <com/sun/star/util/URLTransformer.hpp>
  35 #include <com/sun/star/util/XURLTransformer.hpp>
  36 #include <com/sun/star/frame/XDispatch.hpp>
  37 #include <com/sun/star/frame/XDispatchProvider.hpp>
  38 #include <com/sun/star/beans/XPropertySet.hpp>
  39 #include <com/sun/star/frame/FrameSearchFlag.hpp>
  40 #include <toolkit/helper/vclunohelper.hxx>
  41 #include <com/sun/star/frame/ModuleManager.hpp>
  42 #include <com/sun/star/system/SystemShellExecute.hpp>
  43 #include <com/sun/star/system/SystemShellExecuteFlags.hpp>
  44 #include <unotools/configmgr.hxx>
  45 #include <unotools/configitem.hxx>
  46 #include <svtools/helpopt.hxx>
  47 #include <unotools/moduleoptions.hxx>
  48 #include <tools/urlobj.hxx>
  49 #include <ucbhelper/content.hxx>
  50 #include <unotools/pathoptions.hxx>
  51 #include <rtl/ustring.hxx>
  52 #include <osl/process.h>
  53 #include <osl/file.hxx>
  54 #include <unotools/bootstrap.hxx>
  55 #include <rtl/uri.hxx>
  56 #include <vcl/msgbox.hxx>
  57 #include <svtools/ehdl.hxx>
  58 #include <svtools/sfxecode.hxx>
  59
  60 #include "newhelp.hxx"
  61 #include <sfx2/objsh.hxx>
  62 #include <sfx2/docfac.hxx>
  63 #include <sfx2/sfxresid.hxx>
  64 #include "helper.hxx"
  65 #include "app.hrc"
  66 #include <sfx2/sfxuno.hxx>
  67 #include <vcl/svapp.hxx>
  68 #include <sfx2/frame.hxx>
  69 #include <rtl/strbuf.hxx>
  70 #include <rtl/string.hxx>
  71
  72 using namespace ::com::sun::star::beans;
  73 using namespace ::com::sun::star::frame;
  74 using namespace ::com::sun::star::uno;
  75 using namespace ::com::sun::star::util;
  76 using namespace ::com::sun::star::lang;
  77 using namespace ::com::sun::star::system;
  78
  79 class NoHelpErrorBox : public ErrorBox
  80 {
  81 public:
  82     NoHelpErrorBox( Window* _pParent );
  83
  84     virtual void    RequestHelp( const HelpEvent& rHEvt );
  85 };
  86
  87 NoHelpErrorBox::NoHelpErrorBox( Window* _pParent ) :
  88
  89     ErrorBox( _pParent, WB_OK, SfxResId( RID_STR_HLPFILENOTEXIST ).toString() )
  90 {
  91     // Error message: "No help available"
  92 }
  93
  94 void NoHelpErrorBox::RequestHelp( const HelpEvent& )
  95 {
  96     // do nothing, because no help available
  97 }
  98
  99 static bool impl_hasHelpInstalled( const OUString &rLang );
 100
 101 /// Return the locale we prefer for displaying help
 102 static OUString HelpLocaleString()
 103 {
 104     static OUString aLocaleStr;
 105     if (aLocaleStr.isEmpty())
 106     {
 107         const OUString aEnglish( "en"  );
 108         // detect installed locale
 109         aLocaleStr = utl::ConfigManager::getLocale();
 110         bool bOk = !aLocaleStr.isEmpty();
 111         if ( !bOk )
 112             aLocaleStr = aEnglish;
 113         else
 114         {
 115             OUString aBaseInstallPath;
 116             utl::Bootstrap::locateBaseInstallation(aBaseInstallPath);
 117             static const char *szHelpPath = "/help/";
 118
 119             OUString sHelpPath = aBaseInstallPath +
 120                 OUString::createFromAscii(szHelpPath) + aLocaleStr;
 121             osl::DirectoryItem aDirItem;
 122
 123             if (osl::DirectoryItem::get(sHelpPath, aDirItem) != osl::FileBase::E_None)
 124             {
 125                 bOk = false;
 126                 OUString sLang(aLocaleStr);
 127                 sal_Int32 nSepPos = sLang.indexOf( '-' );
 128                 if (nSepPos != -1)
 129                 {
 130                     bOk = true;
 131                     sLang = sLang.copy( 0, nSepPos );
 132                     sHelpPath = aBaseInstallPath +
 133                         OUString::createFromAscii(szHelpPath) + sLang;
 134                     if (osl::DirectoryItem::get(sHelpPath, aDirItem) != osl::FileBase::E_None)
 135                         bOk = false;
 136                 }
 137             }
 138         }
 139         // if not OK, and not even English installed, we use online help, and
 140         // have to preserve the full locale name
 141         if ( !bOk && impl_hasHelpInstalled( aEnglish ) )
 142             aLocaleStr = aEnglish;
 143     }
 144     return aLocaleStr;
 145 }
 146
 147 void AppendConfigToken( OUStringBuffer& rURL, sal_Bool bQuestionMark, const OUString &rLang )
 148 {
 149     OUString aLocaleStr( rLang );
 150     if ( aLocaleStr.isEmpty() )
 151         aLocaleStr = HelpLocaleString();
 152
 153     // query part exists?
 154     if ( bQuestionMark )
 155         // no, so start with '?'
 156         rURL.append('?');
 157     else
 158         // yes, so only append with '&'
 159         rURL.append('&');
 160
 161     // set parameters
 162     rURL.append("Language=");
 163     rURL.append(aLocaleStr);
 164     rURL.append("&System=");
 165     rURL.append(SvtHelpOptions().GetSystem());
 166     rURL.append("&Version=");
 167     rURL.append(utl::ConfigManager::getProductVersion());
 168 }
 169
 170 sal_Bool GetHelpAnchor_Impl( const OUString& _rURL, OUString& _rAnchor )
 171 {
 172     sal_Bool bRet = sal_False;
 173     OUString sAnchor;
 174
 175     try
 176     {
 177         ::ucbhelper::Content aCnt( INetURLObject( _rURL ).GetMainURL( INetURLObject::NO_DECODE ),
 178                              Reference< ::com::sun::star::ucb::XCommandEnvironment >(),
 179                              comphelper::getProcessComponentContext() );
 180         if ( ( aCnt.getPropertyValue("AnchorName") >>= sAnchor ) )
 181         {
 182
 183             if ( !sAnchor.isEmpty() )
 184             {
 185                 _rAnchor = sAnchor;
 186                 bRet = sal_True;
 187             }
 188         }
 189         else
 190         {
 191             SAL_WARN( "sfx.appl", "Property 'AnchorName' is missing" );
 192         }
 193     }
 194     catch (const ::com::sun::star::uno::Exception&)
 195     {
 196     }
 197
 198     return bRet;
 199 }
 200
 201 class SfxHelp_Impl
 202 {
 203 public:
 204     static OUString GetHelpText( const OUString& aCommandURL, const OUString& rModule );
 205 };
 206
 207 OUString SfxHelp_Impl::GetHelpText( const OUString& aCommandURL, const OUString& rModule )
 208 {
 209     // create help url
 210     OUStringBuffer aHelpURL( SfxHelp::CreateHelpURL( aCommandURL, rModule ) );
 211     // added 'active' parameter
 212     sal_Int32 nIndex = aHelpURL.lastIndexOf( '#' );
 213     if ( nIndex < 0 )
 214         nIndex = aHelpURL.getLength();
 215     aHelpURL.insert( nIndex, "&Active=true" );
 216     // load help string
 217     return SfxContentHelper::GetActiveHelpString( aHelpURL.makeStringAndClear() );
 218 }
 219
 220 SfxHelp::SfxHelp() :
 221     bIsDebug( sal_False ),
 222     pImp    ( NULL )
 223 {
 224     // read the environment variable "HELP_DEBUG"
 225     // if it's set, you will see debug output on active help
 226     {
 227         OUString sHelpDebug;
 228         OUString sEnvVarName( "HELP_DEBUG"  );
 229         osl_getEnvironment( sEnvVarName.pData, &sHelpDebug.pData );
 230         bIsDebug = !sHelpDebug.isEmpty();
 231     }
 232
 233     pImp = new SfxHelp_Impl();
 234 }
 235
 236 SfxHelp::~SfxHelp()
 237 {
 238     delete pImp;
 239 }
 240
 241 OUString getDefaultModule_Impl()
 242 {
 243     OUString sDefaultModule;
 244     SvtModuleOptions aModOpt;
 245     if ( aModOpt.IsModuleInstalled( SvtModuleOptions::E_SWRITER ) )
 246         sDefaultModule = "swriter";
 247     else if ( aModOpt.IsModuleInstalled( SvtModuleOptions::E_SCALC ) )
 248         sDefaultModule = "scalc";
 249     else if ( aModOpt.IsModuleInstalled( SvtModuleOptions::E_SIMPRESS ) )
 250         sDefaultModule = "simpress";
 251     else if ( aModOpt.IsModuleInstalled( SvtModuleOptions::E_SDRAW ) )
 252         sDefaultModule = "sdraw";
 253     else if ( aModOpt.IsModuleInstalled( SvtModuleOptions::E_SMATH ) )
 254         sDefaultModule = "smath";
 255     else if ( aModOpt.IsModuleInstalled( SvtModuleOptions::E_SCHART ) )
 256         sDefaultModule = "schart";
 257     else if ( aModOpt.IsModuleInstalled( SvtModuleOptions::E_SBASIC ) )
 258         sDefaultModule = "sbasic";
 259     else if ( aModOpt.IsModuleInstalled( SvtModuleOptions::E_SDATABASE ) )
 260         sDefaultModule = "sdatabase";
 261     else
 262     {
 263         SAL_WARN( "sfx.appl", "getDefaultModule_Impl(): no module installed" );
 264     }
 265     return sDefaultModule;
 266 }
 267
 268 OUString getCurrentModuleIdentifier_Impl()
 269 {
 270     OUString sIdentifier;
 271     Reference < XComponentContext > xContext = ::comphelper::getProcessComponentContext();
 272     Reference < XModuleManager2 > xModuleManager = ModuleManager::create(xContext);
 273     Reference < XDesktop2 > xDesktop = Desktop::create(xContext);
 274     Reference < XFrame > xCurrentFrame = xDesktop->getCurrentFrame();
 275
 276     if ( xCurrentFrame.is() )
 277     {
 278         try
 279         {
 280             sIdentifier = xModuleManager->identify( xCurrentFrame );
 281         }
 282         catch (const ::com::sun::star::frame::UnknownModuleException&)
 283         {
 284             DBG_WARNING( "SfxHelp::getCurrentModuleIdentifier_Impl(): unknown module (help in help?)" );
 285         }
 286         catch (const Exception&)
 287         {
 288             SAL_WARN( "sfx.appl", "SfxHelp::getCurrentModuleIdentifier_Impl(): exception of XModuleManager::identify()" );
 289         }
 290     }
 291
 292     return sIdentifier;
 293 }
 294
 295 OUString SfxHelp::GetHelpModuleName_Impl()
 296 {
 297     OUString aFactoryShortName;
 298     OUString aModuleIdentifier = getCurrentModuleIdentifier_Impl();
 299
 300     if ( !aModuleIdentifier.isEmpty() )
 301     {
 302         try
 303         {
 304             Reference < XModuleManager2 > xModuleManager(
 305                 ModuleManager::create(::comphelper::getProcessComponentContext()) );
 306             Sequence< PropertyValue > lProps;
 307             xModuleManager->getByName( aModuleIdentifier ) >>= lProps;
 308             for ( sal_Int32 i = 0; i < lProps.getLength(); ++i )
 309             {
 310                 if ( lProps[i].Name == "ooSetupFactoryShortName" )
 311                 {
 312                     lProps[i].Value >>= aFactoryShortName;
 313                     break;
 314                 }
 315             }
 316         }
 317         catch (const Exception&)
 318         {
 319             SAL_WARN( "sfx.appl", "SfxHelp::GetHelpModuleName_Impl(): exception of XNameAccess::getByName()" );
 320         }
 321     }
 322
 323     OUString sDefaultModule = getDefaultModule_Impl();
 324     if ( !aFactoryShortName.isEmpty() )
 325     {
 326         // Map some module identifiers to their "real" help module string.
 327         if ( aFactoryShortName == "chart2" )
 328             aFactoryShortName = "schart" ;
 329         else if ( aFactoryShortName == "BasicIDE" )
 330             aFactoryShortName = "sbasic";
 331         else if ( aFactoryShortName.startsWith("sweb")
 332                 || aFactoryShortName.startsWith("sglobal")
 333                 || aFactoryShortName.startsWith("swxform") )
 334             aFactoryShortName = "swriter" ;
 335         else if ( aFactoryShortName.startsWith("dbquery")
 336                 || aFactoryShortName.startsWith("dbbrowser")
 337                 || aFactoryShortName.startsWith("dbrelation")
 338                 || aFactoryShortName.startsWith("dbtable")
 339                 || aFactoryShortName.startsWith("dbapp")
 340                 || aFactoryShortName.startsWith("dbreport")
 341                 || aFactoryShortName.startsWith("swreport")
 342                 || aFactoryShortName.startsWith("dbbrowser")
 343                 || aFactoryShortName.startsWith("swform") )
 344             aFactoryShortName = "sdatabase";
 345         else if ( aFactoryShortName.startsWith("sbibliography")
 346                 || aFactoryShortName.startsWith("StartModule") )
 347             aFactoryShortName = sDefaultModule;
 348     }
 349     else
 350         aFactoryShortName = sDefaultModule;
 351
 352     return aFactoryShortName;
 353 }
 354
 355 OUString SfxHelp::CreateHelpURL_Impl( const OUString& aCommandURL, const OUString& rModuleName )
 356 {
 357     // build up the help URL
 358     OUStringBuffer aHelpURL("vnd.sun.star.help://");
 359     sal_Bool bHasAnchor = sal_False;
 360     OUString aAnchor;
 361
 362     OUString aModuleName( rModuleName );
 363     if (aModuleName.isEmpty())
 364         aModuleName = getDefaultModule_Impl();
 365
 366     aHelpURL.append(aModuleName);
 367
 368     if ( aCommandURL.isEmpty() )
 369         aHelpURL.append("/start");
 370     else
 371     {
 372         aHelpURL.append('/');
 373         aHelpURL.append(rtl::Uri::encode(aCommandURL,
 374                                               rtl_UriCharClassRelSegment,
 375                                               rtl_UriEncodeKeepEscapes,
 376                                               RTL_TEXTENCODING_UTF8));
 377
 378         OUStringBuffer aTempURL = aHelpURL;
 379         AppendConfigToken( aTempURL, sal_True );
 380         bHasAnchor = GetHelpAnchor_Impl(aTempURL.makeStringAndClear(), aAnchor);
 381     }
 382
 383     AppendConfigToken( aHelpURL, sal_True );
 384
 385     if ( bHasAnchor )
 386     {
 387         aHelpURL.append('#');
 388         aHelpURL.append(aAnchor);
 389     }
 390
 391     return aHelpURL.makeStringAndClear();
 392 }
 393
 394 SfxHelpWindow_Impl* impl_createHelp(Reference< XFrame2 >& rHelpTask   ,
 395                                     Reference< XFrame >& rHelpContent)
 396 {
 397     Reference < XDesktop2 > xDesktop = Desktop::create( ::comphelper::getProcessComponentContext() );
 398
 399     // otherwise - create new help task
 400     Reference< XFrame2 > xHelpTask(
 401         xDesktop->findFrame(  "OFFICE_HELP_TASK", FrameSearchFlag::TASKS | FrameSearchFlag::CREATE),
 402         UNO_QUERY);
 403     if (!xHelpTask.is())
 404         return 0;
 405
 406     // create all internal windows and sub frames ...
 407     Reference< ::com::sun::star::awt::XWindow > xParentWindow = xHelpTask->getContainerWindow();
 408     Window*                                     pParentWindow = VCLUnoHelper::GetWindow( xParentWindow );
 409     SfxHelpWindow_Impl*                         pHelpWindow   = new SfxHelpWindow_Impl( xHelpTask, pParentWindow, WB_DOCKBORDER );
 410     Reference< ::com::sun::star::awt::XWindow > xHelpWindow   = VCLUnoHelper::GetInterface( pHelpWindow );
 411
 412     Reference< XFrame > xHelpContent;
 413     if (xHelpTask->setComponent( xHelpWindow, Reference< XController >() ))
 414     {
 415         // Customize UI ...
 416         xHelpTask->setName("OFFICE_HELP_TASK");
 417
 418         Reference< XPropertySet > xProps(xHelpTask, UNO_QUERY);
 419         if (xProps.is())
 420             xProps->setPropertyValue(
 421                 "Title",
 422                 makeAny(SfxResId(STR_HELP_WINDOW_TITLE).toString()));
 423
 424         pHelpWindow->setContainerWindow( xParentWindow );
 425         xParentWindow->setVisible(sal_True);
 426         xHelpWindow->setVisible(sal_True);
 427
 428         // This sub frame is created internaly (if we called new SfxHelpWindow_Impl() ...)
 429         // It should exist :-)
 430         xHelpContent = xHelpTask->findFrame(OUString("OFFICE_HELP"), FrameSearchFlag::CHILDREN);
 431     }
 432
 433     if (!xHelpContent.is())
 434     {
 435         delete pHelpWindow;
 436         return NULL;
 437     }
 438
 439     xHelpContent->setName("OFFICE_HELP");
 440
 441     rHelpTask    = xHelpTask;
 442     rHelpContent = xHelpContent;
 443     return pHelpWindow;
 444 }
 445
 446 OUString SfxHelp::GetHelpText( const OUString& aCommandURL, const Window* pWindow )
 447 {
 448     OUString sModuleName = GetHelpModuleName_Impl();
 449     OUString sHelpText = SfxHelp_Impl::GetHelpText( aCommandURL, sModuleName );
 450
 451     OString aNewHelpId;
 452
 453     if (pWindow && sHelpText.isEmpty())
 454     {
 455         // no help text found -> try with parent help id.
 456         Window* pParent = pWindow->GetParent();
 457         while ( pParent )
 458         {
 459             aNewHelpId = pParent->GetHelpId();
 460             sHelpText = SfxHelp_Impl::GetHelpText( OStringToOUString(aNewHelpId, RTL_TEXTENCODING_UTF8), sModuleName );
 461             if (!sHelpText.isEmpty())
 462                 pParent = NULL;
 463             else
 464                 pParent = pParent->GetParent();
 465         }
 466
 467         if (bIsDebug && sHelpText.isEmpty())
 468             aNewHelpId = OString();
 469     }
 470
 471     // add some debug information?
 472     if ( bIsDebug )
 473     {
 474         sHelpText += "\n-------------\n";
 475         sHelpText += sModuleName;
 476         sHelpText += ": ";
 477         sHelpText += aCommandURL;
 478         if ( !aNewHelpId.isEmpty() )
 479         {
 480             sHelpText += " - ";
 481             sHelpText += OStringToOUString(aNewHelpId, RTL_TEXTENCODING_UTF8);
 482         }
 483     }
 484
 485     return sHelpText;
 486 }
 487
 488 /// Check for built-in help
 489 static bool impl_hasHelpInstalled( const OUString &rLang = OUString() )
 490 {
 491     OUStringBuffer aHelpRootURL("vnd.sun.star.help://");
 492     AppendConfigToken(aHelpRootURL, sal_True, rLang);
 493     std::vector< OUString > aFactories = SfxContentHelper::GetResultSet(aHelpRootURL.makeStringAndClear());
 494
 495     return !aFactories.empty();
 496 }
 497
 498 sal_Bool SfxHelp::SearchKeyword( const OUString& rKeyword )
 499 {
 500     return Start_Impl( OUString(), NULL, rKeyword );
 501 }
 502
 503 sal_Bool SfxHelp::Start( const OUString& rURL, const Window* pWindow )
 504 {
 505     return Start_Impl( rURL, pWindow, OUString() );
 506 }
 507
 508 /// Redirect the vnd.sun.star.help:// urls to http://help.libreoffice.org
 509 static bool impl_showOnlineHelp( const OUString& rURL )
 510 {
 511     OUString aInternal( "vnd.sun.star.help://"  );
 512     if ( rURL.getLength() <= aInternal.getLength() || !rURL.startsWith(aInternal) )
 513         return false;
 514
 515     OUString aHelpLink( "http://help.libreoffice.org/"  );
 516     aHelpLink += rURL.copy( aInternal.getLength() );
 517     aHelpLink = aHelpLink.replaceAll("%2F","/");
 518     try
 519     {
 520         Reference< XSystemShellExecute > xSystemShell(
 521                 SystemShellExecute::create(::comphelper::getProcessComponentContext()) );
 522
 523         xSystemShell->execute( aHelpLink, OUString(), SystemShellExecuteFlags::URIS_ONLY );
 524         return true;
 525     }
 526     catch (const Exception&)
 527     {
 528     }
 529     return false;
 530 }
 531
 532 sal_Bool SfxHelp::Start_Impl(const OUString& rURL, const Window* pWindow, const OUString& rKeyword)
 533 {
 534     OUStringBuffer aHelpRootURL("vnd.sun.star.help://");
 535     AppendConfigToken(aHelpRootURL, sal_True);
 536     SfxContentHelper::GetResultSet(aHelpRootURL.makeStringAndClear());
 537
 538     /* rURL may be
 539         - a "real" URL
 540         - a HelpID (formerly a long, now a string)
 541        If rURL is a URL, CreateHelpURL should be called for this URL
 542        If rURL is an arbitrary string, the same should happen, but the URL should be tried out
 543        if it delivers real help content. In case only the Help Error Document is returned, the
 544        parent of the window for that help was called, is asked for its HelpID.
 545        For compatibility reasons this upward search is not implemented for "real" URLs.
 546        Help keyword search now is implemented as own method; in former versions it
 547        was done via Help::Start, but this implementation conflicted with the upward search.
 548     */
 549     OUString aHelpURL;
 550     INetURLObject aParser( rURL );
 551     INetProtocol nProtocol = aParser.GetProtocol();
 552
 553     switch ( nProtocol )
 554     {
 555         case INET_PROT_VND_SUN_STAR_HELP:
 556             // already a vnd.sun.star.help URL -> nothing to do
 557             aHelpURL = rURL;
 558             break;
 559         default:
 560         {
 561             OUString aHelpModuleName( GetHelpModuleName_Impl() );
 562             // no URL, just a HelpID (maybe empty in case of keyword search)
 563             aHelpURL = CreateHelpURL_Impl( rURL, aHelpModuleName );
 564
 565             if ( impl_hasHelpInstalled() && pWindow && SfxContentHelper::IsHelpErrorDocument( aHelpURL ) )
 566             {
 567                 // no help found -> try with parent help id.
 568                 Window* pParent = pWindow->GetParent();
 569                 bool bTriedTabPage = false;
 570                 while ( pParent )
 571                 {
 572                     OString aHelpId = pParent->GetHelpId();
 573                     aHelpURL = CreateHelpURL( OStringToOUString(aHelpId, RTL_TEXTENCODING_UTF8), aHelpModuleName );
 574                     if ( !SfxContentHelper::IsHelpErrorDocument( aHelpURL ) )
 575                     {
 576                         break;
 577                     }
 578                     else
 579                     {
 580                         pParent = pParent->GetParent();
 581                         if (!pParent)
 582                         {
 583                             // create help url of start page ( helpid == 0 -> start page)
 584                             aHelpURL = CreateHelpURL( OUString(), aHelpModuleName );
 585                         }
 586                         else if (pParent->IsDialog() && !bTriedTabPage)
 587                         {
 588                             //During help fallback, before we ask a dialog for its help
 589                             //see if it has a TabControl and ask the active tab of
 590                             //that for help
 591                             bTriedTabPage = true;
 592                             Dialog *pDialog = ((Dialog*)pParent);
 593                             TabControl *pCtrl = pDialog->hasBuilder() ? pDialog->get<TabControl>("tabcontrol") : NULL;
 594                             TabPage* pTabPage = pCtrl ? pCtrl->GetTabPage(pCtrl->GetCurPageId()) : NULL;
 595                             Window *pTabChild = pTabPage ? pTabPage->GetWindow(WINDOW_FIRSTCHILD) : NULL;
 596                             if (pTabChild)
 597                                 pParent = pTabChild;
 598                         }
 599                     }
 600                 }
 601             }
 602             break;
 603         }
 604     }
 605
 606     if ( !impl_hasHelpInstalled() )
 607     {
 608         if ( impl_showOnlineHelp( aHelpURL ) )
 609             return sal_True;
 610         else
 611         {
 612             NoHelpErrorBox aErrBox( const_cast< Window* >( pWindow ) );
 613             aErrBox.Execute();
 614             return sal_False;
 615         }
 616     }
 617
 618     Reference < XDesktop2 > xDesktop = Desktop::create( ::comphelper::getProcessComponentContext() );
 619
 620     // check if help window is still open
 621     // If not, create a new one and return access directly to the internal sub frame showing the help content
 622     // search must be done here; search one desktop level could return an arbitraty frame
 623     Reference< XFrame2 > xHelp(
 624         xDesktop->findFrame( "OFFICE_HELP_TASK", FrameSearchFlag::CHILDREN),
 625         UNO_QUERY);
 626     Reference< XFrame > xHelpContent = xDesktop->findFrame(
 627         OUString("OFFICE_HELP"),
 628         FrameSearchFlag::CHILDREN);
 629
 630     SfxHelpWindow_Impl* pHelpWindow = 0;
 631     if (!xHelp.is())
 632         pHelpWindow = impl_createHelp(xHelp, xHelpContent);
 633     else
 634         pHelpWindow = (SfxHelpWindow_Impl*)VCLUnoHelper::GetWindow(xHelp->getComponentWindow());
 635     if (!xHelp.is() || !xHelpContent.is() || !pHelpWindow)
 636         return sal_False;
 637
 638 #ifdef DBG_UTIL
 639     OStringBuffer aTmp("SfxHelp: HelpId = ");
 640     aTmp.append(OUStringToOString(aHelpURL, RTL_TEXTENCODING_UTF8));
 641     OSL_TRACE( aTmp.getStr() );
 642 #endif
 643
 644     pHelpWindow->SetHelpURL( aHelpURL );
 645     pHelpWindow->loadHelpContent(aHelpURL);
 646     if (!rKeyword.isEmpty())
 647         pHelpWindow->OpenKeyword( rKeyword );
 648
 649     Reference < ::com::sun::star::awt::XTopWindow > xTopWindow( xHelp->getContainerWindow(), UNO_QUERY );
 650     if ( xTopWindow.is() )
 651         xTopWindow->toFront();
 652
 653     return sal_True;
 654 }
 655
 656 OUString SfxHelp::CreateHelpURL(const OUString& aCommandURL, const OUString& rModuleName)
 657 {
 658     SfxHelp* pHelp = static_cast< SfxHelp* >(Application::GetHelp());
 659     return pHelp ? pHelp->CreateHelpURL_Impl( aCommandURL, rModuleName ) : OUString();
 660 }
 661
 662 OUString SfxHelp::GetDefaultHelpModule()
 663 {
 664     return getDefaultModule_Impl();
 665 }
 666
 667 OUString SfxHelp::GetCurrentModuleIdentifier()
 668 {
 669     return getCurrentModuleIdentifier_Impl();
 670 }
 671
 672 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */