sfx2/source/appl/sfxhelp.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2  /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #include "sfx2/sfxhelp.hxx"
  30
  31 #include <set>
  32 #include <algorithm>
  33 #include <com/sun/star/uno/Reference.h>
  34 #include <com/sun/star/frame/XFrame.hpp>
  35 #include <com/sun/star/frame/XComponentLoader.hpp>
  36 #include <com/sun/star/lang/XComponent.hpp>
  37 #include <comphelper/processfactory.hxx>
  38 #include <com/sun/star/awt/XWindow.hpp>
  39 #include <com/sun/star/awt/XTopWindow.hpp>
  40 #include <com/sun/star/awt/PosSize.hpp>
  41 #include <com/sun/star/frame/XDesktop.hpp>
  42 #include <com/sun/star/util/XURLTransformer.hpp>
  43 #include <com/sun/star/frame/XDispatch.hpp>
  44 #include <com/sun/star/frame/XDispatchProvider.hpp>
  45 #include <com/sun/star/container/XNameAccess.hpp>
  46 #include <com/sun/star/beans/XPropertySet.hpp>
  47 #include <com/sun/star/frame/FrameSearchFlag.hpp>
  48 #include <toolkit/helper/vclunohelper.hxx>
  49 #include <com/sun/star/frame/XModuleManager.hpp>
  50 #include <com/sun/star/system/XSystemShellExecute.hpp>
  51 #include <com/sun/star/system/SystemShellExecuteFlags.hpp>
  52 #include <unotools/configmgr.hxx>
  53 #include <unotools/configitem.hxx>
  54 #include <svtools/helpopt.hxx>
  55 #include <unotools/moduleoptions.hxx>
  56 #include <tools/urlobj.hxx>
  57 #include <ucbhelper/content.hxx>
  58 #include <unotools/pathoptions.hxx>
  59 #include <rtl/ustring.hxx>
  60 #include <osl/process.h>
  61 #include <osl/file.hxx>
  62 #include <unotools/bootstrap.hxx>
  63 #include <rtl/uri.hxx>
  64 #include <vcl/msgbox.hxx>
  65 #include <svtools/ehdl.hxx>
  66 #include <svtools/sfxecode.hxx>
  67 #include <svl/svstdarr.hxx>
  68
  69 #include "newhelp.hxx"
  70 #include <sfx2/objsh.hxx>
  71 #include <sfx2/docfac.hxx>
  72 #include "sfx2/sfxresid.hxx"
  73 #include "helper.hxx"
  74 #include "app.hrc"
  75 #include <sfx2/sfxuno.hxx>
  76 #include <vcl/svapp.hxx>
  77 #include <sfx2/frame.hxx>
  78 #include <rtl/strbuf.hxx>
  79 #include <rtl/string.hxx>
  80
  81 using namespace ::com::sun::star::beans;
  82 using namespace ::com::sun::star::frame;
  83 using namespace ::com::sun::star::uno;
  84 using namespace ::com::sun::star::util;
  85 using namespace ::com::sun::star::frame;
  86 using namespace ::com::sun::star::lang;
  87 using namespace ::com::sun::star::system;
  88
  89 class NoHelpErrorBox : public ErrorBox
  90 {
  91 public:
  92     NoHelpErrorBox( Window* _pParent );
  93
  94     virtual void    RequestHelp( const HelpEvent& rHEvt );
  95 };
  96
  97 NoHelpErrorBox::NoHelpErrorBox( Window* _pParent ) :
  98
  99     ErrorBox( _pParent, WB_OK, String( SfxResId( RID_STR_HLPFILENOTEXIST ) ) )
 100 {
 101     // Error message: "No help available"
 102 }
 103
 104 void NoHelpErrorBox::RequestHelp( const HelpEvent& )
 105 {
 106     // do nothing, because no help available
 107 }
 108
 109 #define STARTERLIST 0
 110
 111 static bool impl_hasHelpInstalled( const rtl::OUString &rLang );
 112
 113 /// Return the locale we prefer for displaying help
 114 static rtl::OUString HelpLocaleString()
 115 {
 116     static rtl::OUString aLocaleStr;
 117     if (aLocaleStr.isEmpty())
 118     {
 119         const rtl::OUString aEnglish( "en"  );
 120         // detect installed locale
 121         aLocaleStr = utl::ConfigManager::getLocale();
 122         bool bOk = !aLocaleStr.isEmpty();
 123         if ( !bOk )
 124             aLocaleStr = aEnglish;
 125         else
 126         {
 127             rtl::OUString aBaseInstallPath;
 128             utl::Bootstrap::locateBaseInstallation(aBaseInstallPath);
 129             static const char *szHelpPath = "/help/";
 130
 131             rtl::OUString sHelpPath = aBaseInstallPath +
 132                 rtl::OUString::createFromAscii(szHelpPath) + aLocaleStr;
 133             osl::DirectoryItem aDirItem;
 134
 135             if (!osl::DirectoryItem::get(sHelpPath, aDirItem) == osl::FileBase::E_None)
 136             {
 137                 bOk = false;
 138                 String sLang(aLocaleStr);
 139                 xub_StrLen nSepPos = sLang.Search( '-' );
 140                 if (nSepPos != STRING_NOTFOUND)
 141                 {
 142                     bOk = true;
 143                     sLang = sLang.Copy( 0, nSepPos );
 144                     sHelpPath = aBaseInstallPath +
 145                         rtl::OUString::createFromAscii(szHelpPath) + sLang;
 146                     if (!osl::DirectoryItem::get(sHelpPath, aDirItem) == osl::FileBase::E_None)
 147                         bOk = false;
 148                 }
 149             }
 150         }
 151         // if not OK, and not even English installed, we use online help, and
 152         // have to preserve the full locale name
 153         if ( !bOk && impl_hasHelpInstalled( aEnglish ) )
 154             aLocaleStr = aEnglish;
 155     }
 156     return aLocaleStr;
 157 }
 158
 159 void AppendConfigToken( String& rURL, sal_Bool bQuestionMark, const rtl::OUString &rLang )
 160 {
 161     ::rtl::OUString aLocaleStr( rLang );
 162     if ( aLocaleStr.isEmpty() )
 163         aLocaleStr = HelpLocaleString();
 164
 165     // query part exists?
 166     if ( bQuestionMark )
 167         // no, so start with '?'
 168         rURL += '?';
 169     else
 170         // yes, so only append with '&'
 171         rURL += '&';
 172
 173     // set parameters
 174     rURL += DEFINE_CONST_UNICODE("Language=");
 175     rURL += String( aLocaleStr );
 176     rURL += DEFINE_CONST_UNICODE("&System=");
 177     rURL += SvtHelpOptions().GetSystem();
 178     rURL += DEFINE_CONST_UNICODE("&Version=");
 179     rURL += utl::ConfigManager::getProductVersion();
 180 }
 181
 182 sal_Bool GetHelpAnchor_Impl( const String& _rURL, String& _rAnchor )
 183 {
 184     sal_Bool bRet = sal_False;
 185     ::rtl::OUString sAnchor;
 186
 187     try
 188     {
 189         ::ucbhelper::Content aCnt( INetURLObject( _rURL ).GetMainURL( INetURLObject::NO_DECODE ),
 190                              Reference< ::com::sun::star::ucb::XCommandEnvironment > () );
 191         if ( ( aCnt.getPropertyValue( ::rtl::OUString("AnchorName") ) >>= sAnchor ) )
 192         {
 193
 194             if ( !sAnchor.isEmpty() )
 195             {
 196                 _rAnchor = String( sAnchor );
 197                 bRet = sal_True;
 198             }
 199         }
 200         else
 201         {
 202             SAL_WARN( "sfx2.appl", "Property 'AnchorName' is missing" );
 203         }
 204     }
 205     catch (const ::com::sun::star::uno::Exception&)
 206     {
 207     }
 208
 209     return bRet;
 210 }
 211
 212 class SfxHelpOptions_Impl : public utl::ConfigItem
 213 {
 214 private:
 215     std::set < rtl::OString > m_aIds;
 216
 217 public:
 218                     SfxHelpOptions_Impl();
 219                     ~SfxHelpOptions_Impl();
 220
 221     bool            HasId( const rtl::OString& rId ) { return m_aIds.size() ? m_aIds.find( rId ) != m_aIds.end() : false; }
 222     virtual void            Notify( const com::sun::star::uno::Sequence< rtl::OUString >& aPropertyNames );
 223     virtual void            Commit();
 224 };
 225
 226 static Sequence< ::rtl::OUString > GetPropertyNames()
 227 {
 228     static const char* aPropNames[] =
 229     {
 230         "HelpAgentStarterList",
 231     };
 232
 233     const int nCount = sizeof( aPropNames ) / sizeof( const char* );
 234     Sequence< ::rtl::OUString > aNames( nCount );
 235     ::rtl::OUString* pNames = aNames.getArray();
 236     ::rtl::OUString* pEnd   = pNames + aNames.getLength();
 237     int i = 0;
 238     for ( ; pNames != pEnd; ++pNames )
 239         *pNames = ::rtl::OUString::createFromAscii( aPropNames[i++] );
 240
 241     return aNames;
 242 }
 243
 244 SfxHelpOptions_Impl::SfxHelpOptions_Impl()
 245     : ConfigItem( ::rtl::OUString("Office.SFX/Help") )
 246 {
 247     Sequence< ::rtl::OUString > aNames = GetPropertyNames();
 248     Sequence< Any > aValues = GetProperties( aNames );
 249     EnableNotification( aNames );
 250     const Any* pValues = aValues.getConstArray();
 251     DBG_ASSERT( aValues.getLength() == aNames.getLength(), "GetProperties failed" );
 252     if ( aValues.getLength() == aNames.getLength() )
 253     {
 254         for ( int nProp = 0; nProp < aNames.getLength(); nProp++ )
 255         {
 256             DBG_ASSERT( pValues[nProp].hasValue(), "property value missing" );
 257             if ( pValues[nProp].hasValue() )
 258             {
 259                 switch ( nProp )
 260                 {
 261                     case STARTERLIST :
 262                     {
 263                         ::rtl::OUString aCodedList;
 264                         if ( pValues[nProp] >>= aCodedList )
 265                         {
 266                             rtl::OString aTmp(
 267                                 rtl::OUStringToOString(
 268                                     aCodedList, RTL_TEXTENCODING_UTF8 ) );
 269                             sal_Int32 nIndex = 0;
 270                             do
 271                             {
 272                                 rtl::OString aToken = aTmp.getToken( 0, ',', nIndex );
 273                                 if ( !aToken.isEmpty() )
 274                                     m_aIds.insert( aToken );
 275                             }
 276                             while ( nIndex >= 0 );
 277                         }
 278                         else {
 279                             SAL_WARN( "sfx2.appl", "Wrong property type!" );
 280                         }
 281
 282                         break;
 283                     }
 284
 285                     default:
 286                         SAL_WARN( "sfx2.appl", "Wrong property!" );
 287                         break;
 288                 }
 289             }
 290         }
 291     }
 292 }
 293
 294 SfxHelpOptions_Impl::~SfxHelpOptions_Impl()
 295 {
 296 }
 297
 298
 299 void SfxHelpOptions_Impl::Notify( const com::sun::star::uno::Sequence< rtl::OUString >& )
 300 {
 301 }
 302
 303 void SfxHelpOptions_Impl::Commit()
 304 {
 305 }
 306
 307 class SfxHelp_Impl
 308 {
 309 private:
 310     sal_Bool                            m_bIsDebug;     // environment variable "help_debug=1"
 311     SfxHelpOptions_Impl*                m_pOpt;         // the options
 312     ::std::vector< ::rtl::OUString >    m_aModulesList; // list of all installed modules
 313
 314 public:
 315     SfxHelp_Impl( sal_Bool bDebug );
 316     ~SfxHelp_Impl();
 317
 318     SfxHelpOptions_Impl*    GetOptions();
 319     static String           GetHelpText( const rtl::OUString& aCommandURL, const String& rModule );
 320 };
 321
 322 SfxHelp_Impl::SfxHelp_Impl( sal_Bool bDebug ) :
 323
 324     m_bIsDebug      ( bDebug ),
 325     m_pOpt          ( NULL )
 326
 327 {
 328 }
 329
 330 SfxHelp_Impl::~SfxHelp_Impl()
 331 {
 332     delete m_pOpt;
 333 }
 334
 335 String SfxHelp_Impl::GetHelpText( const rtl::OUString& aCommandURL, const String& rModule )
 336 {
 337     // create help url
 338     String aHelpURL = SfxHelp::CreateHelpURL( aCommandURL, rModule );
 339     // added 'active' parameter
 340     aHelpURL.Insert( String( DEFINE_CONST_UNICODE("&Active=true") ), aHelpURL.SearchBackward( '#' ) );
 341     // load help string
 342     return SfxContentHelper::GetActiveHelpString( aHelpURL );
 343 }
 344
 345 SfxHelpOptions_Impl* SfxHelp_Impl::GetOptions()
 346 {
 347     // create if not exists
 348     if ( !m_pOpt )
 349         m_pOpt = new SfxHelpOptions_Impl;
 350     return m_pOpt;
 351 }
 352
 353 SfxHelp::SfxHelp() :
 354
 355     bIsDebug( sal_False ),
 356     pImp    ( NULL )
 357
 358 {
 359     // read the environment variable "HELP_DEBUG"
 360     // if it's set, you will see debug output on active help
 361     {
 362         ::rtl::OUString sHelpDebug;
 363         ::rtl::OUString sEnvVarName( "HELP_DEBUG"  );
 364         osl_getEnvironment( sEnvVarName.pData, &sHelpDebug.pData );
 365         bIsDebug = !sHelpDebug.isEmpty();
 366     }
 367
 368     pImp = new SfxHelp_Impl( bIsDebug );
 369
 370     ::rtl::OUString aLocaleStr = HelpLocaleString();
 371
 372     sal_Int32 nSepPos = aLocaleStr.indexOf( '_' );
 373     if ( nSepPos != -1 )
 374     {
 375         aLanguageStr = aLocaleStr.copy( 0, nSepPos );
 376         aCountryStr = aLocaleStr.copy( nSepPos+1 );
 377     }
 378     else
 379     {
 380         nSepPos = aLocaleStr.indexOf( '-' );
 381         if ( nSepPos != -1 )
 382         {
 383             aLanguageStr = aLocaleStr.copy( 0, nSepPos );
 384             aCountryStr = aLocaleStr.copy( nSepPos+1 );
 385         }
 386         else
 387         {
 388             aLanguageStr = aLocaleStr;
 389         }
 390     }
 391 }
 392
 393 SfxHelp::~SfxHelp()
 394 {
 395     delete pImp;
 396 }
 397
 398 ::rtl::OUString getDefaultModule_Impl()
 399 {
 400     rtl::OUString sDefaultModule;
 401     SvtModuleOptions aModOpt;
 402     if ( aModOpt.IsModuleInstalled( SvtModuleOptions::E_SWRITER ) )
 403         sDefaultModule = DEFINE_CONST_UNICODE("swriter");
 404     else if ( aModOpt.IsModuleInstalled( SvtModuleOptions::E_SCALC ) )
 405         sDefaultModule = DEFINE_CONST_UNICODE("scalc");
 406     else if ( aModOpt.IsModuleInstalled( SvtModuleOptions::E_SIMPRESS ) )
 407         sDefaultModule = DEFINE_CONST_UNICODE("simpress");
 408     else if ( aModOpt.IsModuleInstalled( SvtModuleOptions::E_SDRAW ) )
 409         sDefaultModule = DEFINE_CONST_UNICODE("sdraw");
 410     else if ( aModOpt.IsModuleInstalled( SvtModuleOptions::E_SMATH ) )
 411         sDefaultModule = DEFINE_CONST_UNICODE("smath");
 412     else if ( aModOpt.IsModuleInstalled( SvtModuleOptions::E_SCHART ) )
 413         sDefaultModule = DEFINE_CONST_UNICODE("schart");
 414     else if ( aModOpt.IsModuleInstalled( SvtModuleOptions::E_SBASIC ) )
 415         sDefaultModule = DEFINE_CONST_UNICODE("sbasic");
 416     else if ( aModOpt.IsModuleInstalled( SvtModuleOptions::E_SDATABASE ) )
 417         sDefaultModule = DEFINE_CONST_UNICODE("sdatabase");
 418     else
 419     {
 420         SAL_WARN( "sfx2.appl", "getDefaultModule_Impl(): no module installed" );
 421     }
 422     return sDefaultModule;
 423 }
 424
 425 ::rtl::OUString getCurrentModuleIdentifier_Impl()
 426 {
 427     ::rtl::OUString sIdentifier;
 428     Reference < XFrame > xCurrentFrame;
 429     Reference < XModuleManager > xModuleManager( ::comphelper::getProcessServiceFactory()->createInstance(
 430         DEFINE_CONST_UNICODE("com.sun.star.frame.ModuleManager") ), UNO_QUERY );
 431     Reference < XDesktop > xDesktop( ::comphelper::getProcessServiceFactory()->createInstance(
 432         DEFINE_CONST_UNICODE("com.sun.star.frame.Desktop") ), UNO_QUERY );
 433     if ( xDesktop.is() )
 434         xCurrentFrame = xDesktop->getCurrentFrame();
 435
 436     if ( xCurrentFrame.is() && xModuleManager.is() )
 437     {
 438         try
 439         {
 440             sIdentifier = xModuleManager->identify( xCurrentFrame );
 441         }
 442         catch (const ::com::sun::star::frame::UnknownModuleException&)
 443         {
 444             DBG_WARNING( "SfxHelp::getCurrentModuleIdentifier_Impl(): unknown module (help in help?)" );
 445         }
 446         catch (const Exception&)
 447         {
 448             SAL_WARN( "sfx2.appl", "SfxHelp::getCurrentModuleIdentifier_Impl(): exception of XModuleManager::identify()" );
 449         }
 450     }
 451
 452     return sIdentifier;
 453 }
 454
 455 String SfxHelp::GetHelpModuleName_Impl()
 456 {
 457     String sModuleName;
 458     rtl::OUString aFactoryShortName;
 459     rtl::OUString aModuleIdentifier = getCurrentModuleIdentifier_Impl();
 460
 461     if ( !aModuleIdentifier.isEmpty() )
 462     {
 463         try
 464         {
 465             Reference < XModuleManager > xModuleManager(
 466                 ::comphelper::getProcessServiceFactory()->createInstance(
 467                     DEFINE_CONST_UNICODE("com.sun.star.frame.ModuleManager") ), UNO_QUERY );
 468             Sequence< PropertyValue > lProps;
 469             Reference< ::com::sun::star::container::XNameAccess > xCont( xModuleManager, UNO_QUERY);
 470             if ( xCont.is() )
 471                 xCont->getByName( aModuleIdentifier ) >>= lProps;
 472             for ( sal_Int32 i = 0; i < lProps.getLength(); ++i )
 473             {
 474                 if ( lProps[i].Name == "ooSetupFactoryShortName" )
 475                 {
 476                     lProps[i].Value >>= aFactoryShortName;
 477                     break;
 478                 }
 479             }
 480         }
 481         catch (const Exception&)
 482         {
 483             SAL_WARN( "sfx2.appl", "SfxHelp::GetHelpModuleName_Impl(): exception of XNameAccess::getByName()" );
 484         }
 485     }
 486
 487     rtl::OUString sDefaultModule = getDefaultModule_Impl();
 488     if ( !aFactoryShortName.isEmpty() )
 489     {
 490         // Map some module identifiers to their "real" help module string.
 491         if ( aFactoryShortName == "chart2" )
 492             aFactoryShortName = rtl::OUString( "schart"  );
 493         else if ( aFactoryShortName == "BasicIDE" )
 494             aFactoryShortName = rtl::OUString( "sbasic"  );
 495         else if ( aFactoryShortName.equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("sweb"))
 496                 || aFactoryShortName.equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("sglobal"))
 497                 || aFactoryShortName.equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("swxform")) )
 498             aFactoryShortName = rtl::OUString( "swriter"  );
 499         else if ( aFactoryShortName.equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("dbquery"))
 500                 || aFactoryShortName.equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("dbbrowser"))
 501                 || aFactoryShortName.equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("dbrelation"))
 502                 || aFactoryShortName.equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("dbtable"))
 503                 || aFactoryShortName.equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("dbapp"))
 504                 || aFactoryShortName.equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("dbreport"))
 505                 || aFactoryShortName.equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("swreport"))
 506                 || aFactoryShortName.equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("dbbrowser"))
 507                 || aFactoryShortName.equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("swform")) )
 508             aFactoryShortName = rtl::OUString( "sdatabase"  );
 509         else if ( aFactoryShortName.equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("sbibliography"))
 510                 || aFactoryShortName.equalsAsciiL(RTL_CONSTASCII_STRINGPARAM("StartModule")) )
 511             aFactoryShortName = sDefaultModule;
 512     }
 513     else
 514         aFactoryShortName = sDefaultModule;
 515
 516     sModuleName = String( aFactoryShortName );
 517     return sModuleName;
 518 }
 519
 520 String  SfxHelp::CreateHelpURL_Impl( const String& aCommandURL, const String& rModuleName )
 521 {
 522     // build up the help URL
 523     String aHelpURL;
 524     sal_Bool bHasAnchor = sal_False;
 525     String aAnchor;
 526
 527     String aModuleName( rModuleName );
 528     if ( aModuleName.Len() == 0 )
 529         aModuleName = getDefaultModule_Impl();
 530
 531     aHelpURL = String::CreateFromAscii("vnd.sun.star.help://");
 532     aHelpURL += aModuleName;
 533
 534     if ( !aCommandURL.Len() )
 535         aHelpURL += String::CreateFromAscii("/start");
 536     else
 537     {
 538         aHelpURL += '/';
 539         aHelpURL += String( rtl::Uri::encode( aCommandURL,
 540                                               rtl_UriCharClassRelSegment,
 541                                               rtl_UriEncodeKeepEscapes,
 542                                               RTL_TEXTENCODING_UTF8 ));
 543
 544         String aTempURL = aHelpURL;
 545         AppendConfigToken( aTempURL, sal_True );
 546         bHasAnchor = GetHelpAnchor_Impl( aTempURL, aAnchor );
 547     }
 548
 549     AppendConfigToken( aHelpURL, sal_True );
 550
 551     if ( bHasAnchor )
 552     {
 553         aHelpURL += '#';
 554         aHelpURL += aAnchor;
 555     }
 556
 557     return aHelpURL;
 558 }
 559
 560 SfxHelpWindow_Impl* impl_createHelp(Reference< XFrame >& rHelpTask   ,
 561                                     Reference< XFrame >& rHelpContent)
 562 {
 563     Reference < XFrame > xDesktop( ::comphelper::getProcessServiceFactory()->createInstance(
 564         DEFINE_CONST_UNICODE("com.sun.star.frame.Desktop") ), UNO_QUERY );
 565
 566     // otherwhise - create new help task
 567     Reference< XFrame > xHelpTask = xDesktop->findFrame(
 568         ::rtl::OUString(DEFINE_CONST_UNICODE("OFFICE_HELP_TASK")),
 569         FrameSearchFlag::TASKS | FrameSearchFlag::CREATE);
 570     if (!xHelpTask.is())
 571         return 0;
 572
 573     // create all internal windows and sub frames ...
 574     Reference< ::com::sun::star::awt::XWindow > xParentWindow = xHelpTask->getContainerWindow();
 575     Window*                                     pParentWindow = VCLUnoHelper::GetWindow( xParentWindow );
 576     SfxHelpWindow_Impl*                         pHelpWindow   = new SfxHelpWindow_Impl( xHelpTask, pParentWindow, WB_DOCKBORDER );
 577     Reference< ::com::sun::star::awt::XWindow > xHelpWindow   = VCLUnoHelper::GetInterface( pHelpWindow );
 578
 579     Reference< XFrame > xHelpContent;
 580     if (xHelpTask->setComponent( xHelpWindow, Reference< XController >() ))
 581     {
 582         // Customize UI ...
 583         xHelpTask->setName( ::rtl::OUString(DEFINE_CONST_UNICODE("OFFICE_HELP_TASK")) );
 584
 585         Reference< XPropertySet > xProps(xHelpTask, UNO_QUERY);
 586         if (xProps.is())
 587             xProps->setPropertyValue(
 588                 DEFINE_CONST_UNICODE("Title"),
 589                 makeAny(::rtl::OUString(String(SfxResId(STR_HELP_WINDOW_TITLE)))));
 590
 591         pHelpWindow->setContainerWindow( xParentWindow );
 592         xParentWindow->setVisible(sal_True);
 593         xHelpWindow->setVisible(sal_True);
 594
 595         // This sub frame is created internaly (if we called new SfxHelpWindow_Impl() ...)
 596         // It should exist :-)
 597         xHelpContent = xHelpTask->findFrame(::rtl::OUString(DEFINE_CONST_UNICODE("OFFICE_HELP")), FrameSearchFlag::CHILDREN);
 598     }
 599
 600     if (!xHelpContent.is())
 601         delete pHelpWindow;
 602
 603     xHelpContent->setName(::rtl::OUString(DEFINE_CONST_UNICODE("OFFICE_HELP")));
 604
 605     rHelpTask    = xHelpTask;
 606     rHelpContent = xHelpContent;
 607     return pHelpWindow;
 608 }
 609
 610 XubString SfxHelp::GetHelpText( const String& aCommandURL, const Window* pWindow )
 611 {
 612     String sModuleName = GetHelpModuleName_Impl();
 613     String sHelpText = pImp->GetHelpText( aCommandURL, sModuleName );
 614
 615     rtl::OString aNewHelpId;
 616
 617     if ( pWindow && !sHelpText.Len() )
 618     {
 619         // no help text found -> try with parent help id.
 620         Window* pParent = pWindow->GetParent();
 621         while ( pParent )
 622         {
 623             aNewHelpId = pParent->GetHelpId();
 624             sHelpText = pImp->GetHelpText( rtl::OStringToOUString(aNewHelpId, RTL_TEXTENCODING_UTF8), sModuleName );
 625             if ( sHelpText.Len() > 0 )
 626                 pParent = NULL;
 627             else
 628                 pParent = pParent->GetParent();
 629         }
 630
 631         if ( bIsDebug && !sHelpText.Len() )
 632             aNewHelpId = rtl::OString();
 633     }
 634
 635     // add some debug information?
 636     if ( bIsDebug )
 637     {
 638         sHelpText += DEFINE_CONST_UNICODE("\n-------------\n");
 639         sHelpText += String( sModuleName );
 640         sHelpText += DEFINE_CONST_UNICODE(": ");
 641         sHelpText += aCommandURL;
 642         if ( !aNewHelpId.isEmpty() )
 643         {
 644             sHelpText += DEFINE_CONST_UNICODE(" - ");
 645             sHelpText += String(rtl::OStringToOUString(aNewHelpId, RTL_TEXTENCODING_UTF8));
 646         }
 647     }
 648
 649     return sHelpText;
 650 }
 651
 652 /// Check for built-in help
 653 static bool impl_hasHelpInstalled( const rtl::OUString &rLang = rtl::OUString() )
 654 {
 655     String aHelpRootURL( DEFINE_CONST_OUSTRING("vnd.sun.star.help://") );
 656     AppendConfigToken( aHelpRootURL, sal_True, rLang );
 657     Sequence< ::rtl::OUString > aFactories = SfxContentHelper::GetResultSet( aHelpRootURL );
 658
 659     return ( aFactories.getLength() != 0   );
 660 }
 661
 662 sal_Bool SfxHelp::SearchKeyword( const XubString& rKeyword )
 663 {
 664     return Start_Impl( String(), NULL, rKeyword );
 665 }
 666
 667 sal_Bool SfxHelp::Start( const String& rURL, const Window* pWindow )
 668 {
 669     return Start_Impl( rURL, pWindow, String() );
 670 }
 671
 672 /// Redirect the vnd.sun.star.help:// urls to http://help.libreoffice.org
 673 static bool impl_showOnlineHelp( const String& rURL )
 674 {
 675     String aInternal( "vnd.sun.star.help://"  );
 676     if ( rURL.Len() <= aInternal.Len() || rURL.Copy( 0, aInternal.Len() ) != aInternal )
 677         return false;
 678
 679     rtl::OUString aHelpLink( "http://help.libreoffice.org/"  );
 680     aHelpLink += rURL.Copy( aInternal.Len() );
 681     try
 682     {
 683         Reference< XSystemShellExecute > xSystemShell(
 684                 ::comphelper::getProcessServiceFactory()->createInstance(
 685                     rtl::OUString( "com.sun.star.system.SystemShellExecute"  ) ),
 686                 UNO_QUERY );
 687
 688         if ( xSystemShell.is() )
 689         {
 690             xSystemShell->execute( aHelpLink, rtl::OUString(), SystemShellExecuteFlags::URIS_ONLY );
 691             return true;
 692         }
 693     }
 694     catch (const Exception&)
 695     {
 696     }
 697     return false;
 698 }
 699
 700 sal_Bool SfxHelp::Start_Impl( const String& rURL, const Window* pWindow, const String& rKeyword )
 701 {
 702     String aHelpRootURL( DEFINE_CONST_OUSTRING("vnd.sun.star.help://") );
 703     AppendConfigToken( aHelpRootURL, sal_True);
 704     Sequence< ::rtl::OUString > aFactories = SfxContentHelper::GetResultSet( aHelpRootURL );
 705
 706     /* rURL may be
 707         - a "real" URL
 708         - a HelpID (formerly a long, now a string)
 709        If rURL is a URL, CreateHelpURL should be called for this URL
 710        If rURL is an arbitrary string, the same should happen, but the URL should be tried out
 711        if it delivers real help content. In case only the Help Error Document is returned, the
 712        parent of the window for that help was called, is asked for its HelpID.
 713        For compatibility reasons this upward search is not implemented for "real" URLs.
 714        Help keyword search now is implemented as own method; in former versions it
 715        was done via Help::Start, but this implementation conflicted with the upward search.
 716     */
 717     String aHelpURL;
 718     INetURLObject aParser( rURL );
 719     INetProtocol nProtocol = aParser.GetProtocol();
 720     String aHelpModuleName( GetHelpModuleName_Impl() );
 721
 722     ::rtl::OUString sKeyword;
 723     switch ( nProtocol )
 724     {
 725         case INET_PROT_VND_SUN_STAR_HELP:
 726             // already a vnd.sun.star.help URL -> nothing to do
 727             aHelpURL = rURL;
 728             break;
 729         default:
 730         {
 731             // no URL, just a HelpID (maybe empty in case of keyword search)
 732             aHelpURL = CreateHelpURL_Impl( rURL, aHelpModuleName );
 733
 734             // pb i91715: strings begin with ".HelpId:" are not words of the basic ide
 735             // they are helpid-strings used by the testtool -> so we ignore them
 736             static const String sHelpIdScheme( DEFINE_CONST_OUSTRING(".HelpId:") );
 737             if ( rURL.Search( sHelpIdScheme ) != 0 )
 738                 sKeyword = ::rtl::OUString( rURL );
 739
 740             if ( impl_hasHelpInstalled() && pWindow && SfxContentHelper::IsHelpErrorDocument( aHelpURL ) )
 741             {
 742                 // no help found -> try with parent help id.
 743                 Window* pParent = pWindow->GetParent();
 744                 while ( pParent )
 745                 {
 746                     rtl::OString aHelpId = pParent->GetHelpId();
 747                     aHelpURL = CreateHelpURL( rtl::OStringToOUString(aHelpId, RTL_TEXTENCODING_UTF8), aHelpModuleName );
 748                     if ( !SfxContentHelper::IsHelpErrorDocument( aHelpURL ) )
 749                         break;
 750                     else
 751                     {
 752                         pParent = pParent->GetParent();
 753                         if ( !pParent )
 754                             // create help url of start page ( helpid == 0 -> start page)
 755                             aHelpURL = CreateHelpURL( String(), aHelpModuleName );
 756                     }
 757                 }
 758             }
 759             break;
 760         }
 761     }
 762
 763     if ( !impl_hasHelpInstalled() )
 764     {
 765         if ( impl_showOnlineHelp( aHelpURL ) )
 766             return sal_True;
 767         else
 768         {
 769             NoHelpErrorBox aErrBox( const_cast< Window* >( pWindow ) );
 770             aErrBox.Execute();
 771             return sal_False;
 772         }
 773     }
 774
 775     Reference < XFrame > xDesktop( ::comphelper::getProcessServiceFactory()->createInstance(
 776         DEFINE_CONST_UNICODE("com.sun.star.frame.Desktop") ), UNO_QUERY );
 777
 778     // check if help window is still open
 779     // If not, create a new one and return access directly to the internal sub frame showing the help content
 780     // search must be done here; search one desktop level could return an arbitraty frame
 781     Reference< XFrame > xHelp = xDesktop->findFrame(
 782         ::rtl::OUString(DEFINE_CONST_UNICODE("OFFICE_HELP_TASK")),
 783         FrameSearchFlag::CHILDREN);
 784     Reference< XFrame > xHelpContent = xDesktop->findFrame(
 785         ::rtl::OUString(DEFINE_CONST_UNICODE("OFFICE_HELP")),
 786         FrameSearchFlag::CHILDREN);
 787
 788     SfxHelpWindow_Impl* pHelpWindow = 0;
 789     if (!xHelp.is())
 790         pHelpWindow = impl_createHelp(xHelp, xHelpContent);
 791     else
 792         pHelpWindow = (SfxHelpWindow_Impl*)VCLUnoHelper::GetWindow(xHelp->getComponentWindow());
 793     if (!xHelp.is() || !xHelpContent.is() || !pHelpWindow)
 794         return sal_False;
 795
 796 #ifdef DBG_UTIL
 797     rtl::OStringBuffer aTmp(RTL_CONSTASCII_STRINGPARAM("SfxHelp: HelpId = "));
 798     aTmp.append(rtl::OUStringToOString(aHelpURL, RTL_TEXTENCODING_UTF8));
 799     OSL_TRACE( aTmp.getStr() );
 800 #endif
 801
 802     pHelpWindow->SetHelpURL( aHelpURL );
 803     pHelpWindow->loadHelpContent(aHelpURL);
 804     if ( rKeyword.Len() )
 805         pHelpWindow->OpenKeyword( rKeyword );
 806
 807     Reference < ::com::sun::star::awt::XTopWindow > xTopWindow( xHelp->getContainerWindow(), UNO_QUERY );
 808     if ( xTopWindow.is() )
 809         xTopWindow->toFront();
 810
 811     return sal_True;
 812 }
 813
 814 String SfxHelp::CreateHelpURL( const String& aCommandURL, const String& rModuleName )
 815 {
 816     String aURL;
 817     SfxHelp* pHelp = (static_cast< SfxHelp* >(Application::GetHelp()) );
 818     if ( pHelp )
 819         aURL = pHelp->CreateHelpURL_Impl( aCommandURL, rModuleName );
 820     return aURL;
 821 }
 822
 823 void SfxHelp::OpenHelpAgent( SfxFrame*, const rtl::OString& sHelpId )
 824 {
 825     SfxHelp* pHelp = (static_cast< SfxHelp* >(Application::GetHelp()) );
 826     if ( pHelp )
 827         pHelp->OpenHelpAgent( sHelpId );
 828 }
 829
 830 void SfxHelp::OpenHelpAgent( const rtl::OString& sHelpId )
 831 {
 832     if ( SvtHelpOptions().IsHelpAgentAutoStartMode() )
 833     {
 834             SfxHelpOptions_Impl *pOpt = pImp->GetOptions();
 835             if ( !pOpt->HasId( sHelpId ) )
 836                 return;
 837
 838             try
 839             {
 840                 URL aURL;
 841                 aURL.Complete = CreateHelpURL_Impl( rtl::OStringToOUString(sHelpId, RTL_TEXTENCODING_UTF8), GetHelpModuleName_Impl() );
 842                 Reference < XURLTransformer > xTrans( ::comphelper::getProcessServiceFactory()->createInstance(
 843                     ::rtl::OUString("com.sun.star.util.URLTransformer") ), UNO_QUERY );
 844                 xTrans->parseStrict(aURL);
 845
 846                 Reference < XFrame > xCurrentFrame;
 847                 Reference < XDesktop > xDesktop( ::comphelper::getProcessServiceFactory()->createInstance(
 848                     DEFINE_CONST_UNICODE("com.sun.star.frame.Desktop") ), UNO_QUERY );
 849                 if ( xDesktop.is() )
 850                     xCurrentFrame = xDesktop->getCurrentFrame();
 851
 852                 Reference< XDispatchProvider > xDispProv( xCurrentFrame, UNO_QUERY );
 853                 Reference< XDispatch > xHelpDispatch;
 854                 if ( xDispProv.is() )
 855                     xHelpDispatch = xDispProv->queryDispatch(
 856                         aURL, ::rtl::OUString("_helpagent"),
 857                         FrameSearchFlag::PARENT | FrameSearchFlag::SELF );
 858
 859                 DBG_ASSERT( xHelpDispatch.is(), "OpenHelpAgent: could not get a dispatcher!" );
 860                 if ( xHelpDispatch.is() )
 861                     xHelpDispatch->dispatch( aURL, Sequence< PropertyValue >() );
 862             }
 863             catch (const Exception&)
 864             {
 865                 SAL_WARN( "sfx2.appl", "OpenHelpAgent: caught an exception while executing the dispatch!" );
 866             }
 867     }
 868 }
 869
 870 String SfxHelp::GetDefaultHelpModule()
 871 {
 872     return getDefaultModule_Impl();
 873 }
 874
 875 ::rtl::OUString SfxHelp::GetCurrentModuleIdentifier()
 876 {
 877     return getCurrentModuleIdentifier_Impl();
 878 }
 879
 880 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */