1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef __FRAMEWORK_SERVICES_SUBSTPATHVARS_HXX_ 25*b1cdbd2cSJim Jagielski #define __FRAMEWORK_SERVICES_SUBSTPATHVARS_HXX_ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski /** Attention: stl headers must(!) be included at first. Otherwhise it can make trouble 28*b1cdbd2cSJim Jagielski with solaris headers ... 29*b1cdbd2cSJim Jagielski */ 30*b1cdbd2cSJim Jagielski #include <vector> 31*b1cdbd2cSJim Jagielski #include <list> 32*b1cdbd2cSJim Jagielski #include <hash_map> 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski //_________________________________________________________________________________________________________________ 35*b1cdbd2cSJim Jagielski // my own includes 36*b1cdbd2cSJim Jagielski //_________________________________________________________________________________________________________________ 37*b1cdbd2cSJim Jagielski #include <threadhelp/threadhelpbase.hxx> 38*b1cdbd2cSJim Jagielski #include <macros/generic.hxx> 39*b1cdbd2cSJim Jagielski #include <macros/xinterface.hxx> 40*b1cdbd2cSJim Jagielski #include <macros/xtypeprovider.hxx> 41*b1cdbd2cSJim Jagielski #include <macros/xserviceinfo.hxx> 42*b1cdbd2cSJim Jagielski #include <stdtypes.h> 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski //_________________________________________________________________________________________________________________ 45*b1cdbd2cSJim Jagielski // interface includes 46*b1cdbd2cSJim Jagielski //_________________________________________________________________________________________________________________ 47*b1cdbd2cSJim Jagielski #include <com/sun/star/lang/XServiceInfo.hpp> 48*b1cdbd2cSJim Jagielski #include <com/sun/star/lang/XTypeProvider.hpp> 49*b1cdbd2cSJim Jagielski #include <com/sun/star/container/NoSuchElementException.hpp> 50*b1cdbd2cSJim Jagielski #include <com/sun/star/util/XStringSubstitution.hpp> 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski //_________________________________________________________________________________________________________________ 53*b1cdbd2cSJim Jagielski // other includes 54*b1cdbd2cSJim Jagielski //_________________________________________________________________________________________________________________ 55*b1cdbd2cSJim Jagielski #include <cppuhelper/implbase2.hxx> 56*b1cdbd2cSJim Jagielski #include <rtl/ustring.hxx> 57*b1cdbd2cSJim Jagielski #include <unotools/configitem.hxx> 58*b1cdbd2cSJim Jagielski #include <tools/link.hxx> 59*b1cdbd2cSJim Jagielski #include <i18npool/lang.h> 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski namespace framework 62*b1cdbd2cSJim Jagielski { 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski // Must be zero value based 65*b1cdbd2cSJim Jagielski enum EnvironmentType 66*b1cdbd2cSJim Jagielski { 67*b1cdbd2cSJim Jagielski ET_HOST = 0 , 68*b1cdbd2cSJim Jagielski ET_YPDOMAIN , 69*b1cdbd2cSJim Jagielski ET_DNSDOMAIN , 70*b1cdbd2cSJim Jagielski ET_NTDOMAIN , 71*b1cdbd2cSJim Jagielski ET_OS , 72*b1cdbd2cSJim Jagielski ET_UNKNOWN , 73*b1cdbd2cSJim Jagielski ET_COUNT 74*b1cdbd2cSJim Jagielski }; 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski // Must be zero value based 77*b1cdbd2cSJim Jagielski enum OperatingSystem 78*b1cdbd2cSJim Jagielski { 79*b1cdbd2cSJim Jagielski OS_WINDOWS = 0, 80*b1cdbd2cSJim Jagielski OS_UNIX , 81*b1cdbd2cSJim Jagielski OS_SOLARIS , 82*b1cdbd2cSJim Jagielski OS_LINUX , 83*b1cdbd2cSJim Jagielski OS_UNKNOWN , 84*b1cdbd2cSJim Jagielski OS_COUNT 85*b1cdbd2cSJim Jagielski }; 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski struct SubstituteRule 88*b1cdbd2cSJim Jagielski { SubstituteRuleframework::SubstituteRule89*b1cdbd2cSJim Jagielski SubstituteRule() {} SubstituteRuleframework::SubstituteRule90*b1cdbd2cSJim Jagielski SubstituteRule( const rtl::OUString& aVarName, 91*b1cdbd2cSJim Jagielski const rtl::OUString& aValue, 92*b1cdbd2cSJim Jagielski const com::sun::star::uno::Any& aVal, 93*b1cdbd2cSJim Jagielski EnvironmentType aType ) : 94*b1cdbd2cSJim Jagielski aSubstVariable( aVarName ), aSubstValue( aValue ), aEnvValue( aVal ), aEnvType( aType ) {} 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski rtl::OUString aSubstVariable; 97*b1cdbd2cSJim Jagielski rtl::OUString aSubstValue; 98*b1cdbd2cSJim Jagielski com::sun::star::uno::Any aEnvValue; 99*b1cdbd2cSJim Jagielski EnvironmentType aEnvType; 100*b1cdbd2cSJim Jagielski }; 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski struct SubstitutePathNotify 103*b1cdbd2cSJim Jagielski { SubstitutePathNotifyframework::SubstitutePathNotify104*b1cdbd2cSJim Jagielski SubstitutePathNotify() {}; 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski const com::sun::star::uno::Sequence<rtl::OUString> aPropertyNames; 107*b1cdbd2cSJim Jagielski }; 108*b1cdbd2cSJim Jagielski 109*b1cdbd2cSJim Jagielski class SubstituteVariables : public ::std::hash_map< ::rtl::OUString, 110*b1cdbd2cSJim Jagielski SubstituteRule, 111*b1cdbd2cSJim Jagielski rtl::OUStringHash, 112*b1cdbd2cSJim Jagielski ::std::equal_to< ::rtl::OUString > > 113*b1cdbd2cSJim Jagielski { 114*b1cdbd2cSJim Jagielski public: free()115*b1cdbd2cSJim Jagielski inline void free() 116*b1cdbd2cSJim Jagielski { 117*b1cdbd2cSJim Jagielski SubstituteVariables().swap( *this ); 118*b1cdbd2cSJim Jagielski } 119*b1cdbd2cSJim Jagielski }; 120*b1cdbd2cSJim Jagielski 121*b1cdbd2cSJim Jagielski typedef std::vector< SubstituteRule > SubstituteRuleVector; 122*b1cdbd2cSJim Jagielski class SubstitutePathVariables_Impl : public utl::ConfigItem 123*b1cdbd2cSJim Jagielski { 124*b1cdbd2cSJim Jagielski public: 125*b1cdbd2cSJim Jagielski SubstitutePathVariables_Impl( const Link& aNotifyLink ); 126*b1cdbd2cSJim Jagielski virtual ~SubstitutePathVariables_Impl(); 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski static OperatingSystem GetOperatingSystemFromString( const rtl::OUString& ); 129*b1cdbd2cSJim Jagielski static EnvironmentType GetEnvTypeFromString( const rtl::OUString& ); 130*b1cdbd2cSJim Jagielski 131*b1cdbd2cSJim Jagielski void GetSharePointsRules( SubstituteVariables& aSubstVarMap ); 132*b1cdbd2cSJim Jagielski 133*b1cdbd2cSJim Jagielski /** is called from the ConfigManager before application ends or from the 134*b1cdbd2cSJim Jagielski PropertyChangeListener if the sub tree broadcasts changes. */ 135*b1cdbd2cSJim Jagielski virtual void Notify( const com::sun::star::uno::Sequence< rtl::OUString >& aPropertyNames ); 136*b1cdbd2cSJim Jagielski virtual void Commit(); 137*b1cdbd2cSJim Jagielski 138*b1cdbd2cSJim Jagielski private: 139*b1cdbd2cSJim Jagielski // Wrapper methods for low-level functions 140*b1cdbd2cSJim Jagielski OperatingSystem GetOperatingSystem(); 141*b1cdbd2cSJim Jagielski const rtl::OUString& GetYPDomainName(); 142*b1cdbd2cSJim Jagielski const rtl::OUString& GetDNSDomainName(); 143*b1cdbd2cSJim Jagielski const rtl::OUString& GetNTDomainName(); 144*b1cdbd2cSJim Jagielski const rtl::OUString& GetHostName(); 145*b1cdbd2cSJim Jagielski 146*b1cdbd2cSJim Jagielski bool FilterRuleSet( const SubstituteRuleVector& aRuleSet, SubstituteRule& aActiveRule ); 147*b1cdbd2cSJim Jagielski 148*b1cdbd2cSJim Jagielski void ReadSharePointsFromConfiguration( com::sun::star::uno::Sequence< rtl::OUString >& aSharePointsSeq ); 149*b1cdbd2cSJim Jagielski void ReadSharePointRuleSetFromConfiguration( const rtl::OUString& aSharePointName, 150*b1cdbd2cSJim Jagielski const rtl::OUString& aSharePointNodeName, 151*b1cdbd2cSJim Jagielski SubstituteRuleVector& aRuleSet ); 152*b1cdbd2cSJim Jagielski 153*b1cdbd2cSJim Jagielski // Stored values for domains and host 154*b1cdbd2cSJim Jagielski bool m_bYPDomainRetrieved; 155*b1cdbd2cSJim Jagielski rtl::OUString m_aYPDomain; 156*b1cdbd2cSJim Jagielski bool m_bDNSDomainRetrieved; 157*b1cdbd2cSJim Jagielski rtl::OUString m_aDNSDomain; 158*b1cdbd2cSJim Jagielski bool m_bNTDomainRetrieved; 159*b1cdbd2cSJim Jagielski rtl::OUString m_aNTDomain; 160*b1cdbd2cSJim Jagielski bool m_bHostRetrieved; 161*b1cdbd2cSJim Jagielski rtl::OUString m_aHost; 162*b1cdbd2cSJim Jagielski bool m_bOSRetrieved; 163*b1cdbd2cSJim Jagielski OperatingSystem m_eOSType; 164*b1cdbd2cSJim Jagielski 165*b1cdbd2cSJim Jagielski Link m_aListenerNotify; 166*b1cdbd2cSJim Jagielski const rtl::OUString m_aSharePointsNodeName; 167*b1cdbd2cSJim Jagielski const rtl::OUString m_aDirPropertyName; 168*b1cdbd2cSJim Jagielski const rtl::OUString m_aEnvPropertyName; 169*b1cdbd2cSJim Jagielski const rtl::OUString m_aLevelSep; 170*b1cdbd2cSJim Jagielski }; 171*b1cdbd2cSJim Jagielski 172*b1cdbd2cSJim Jagielski enum PreDefVariable 173*b1cdbd2cSJim Jagielski { 174*b1cdbd2cSJim Jagielski PREDEFVAR_INST, 175*b1cdbd2cSJim Jagielski PREDEFVAR_PROG, 176*b1cdbd2cSJim Jagielski PREDEFVAR_USER, 177*b1cdbd2cSJim Jagielski PREDEFVAR_WORK, 178*b1cdbd2cSJim Jagielski PREDEFVAR_HOME, 179*b1cdbd2cSJim Jagielski PREDEFVAR_TEMP, 180*b1cdbd2cSJim Jagielski PREDEFVAR_PATH, 181*b1cdbd2cSJim Jagielski PREDEFVAR_LANG, 182*b1cdbd2cSJim Jagielski PREDEFVAR_LANGID, 183*b1cdbd2cSJim Jagielski PREDEFVAR_VLANG, 184*b1cdbd2cSJim Jagielski PREDEFVAR_INSTPATH, 185*b1cdbd2cSJim Jagielski PREDEFVAR_PROGPATH, 186*b1cdbd2cSJim Jagielski PREDEFVAR_USERPATH, 187*b1cdbd2cSJim Jagielski PREDEFVAR_INSTURL, 188*b1cdbd2cSJim Jagielski PREDEFVAR_PROGURL, 189*b1cdbd2cSJim Jagielski PREDEFVAR_USERURL, 190*b1cdbd2cSJim Jagielski PREDEFVAR_WORKDIRURL, 191*b1cdbd2cSJim Jagielski // --> PB 2004-10-27 #i32656# - new variable of hierachy service 192*b1cdbd2cSJim Jagielski PREDEFVAR_BASEINSTURL, 193*b1cdbd2cSJim Jagielski PREDEFVAR_USERDATAURL, 194*b1cdbd2cSJim Jagielski // <-- 195*b1cdbd2cSJim Jagielski PREDEFVAR_BRANDBASEURL, 196*b1cdbd2cSJim Jagielski PREDEFVAR_COUNT 197*b1cdbd2cSJim Jagielski }; 198*b1cdbd2cSJim Jagielski 199*b1cdbd2cSJim Jagielski struct PredefinedPathVariables 200*b1cdbd2cSJim Jagielski { 201*b1cdbd2cSJim Jagielski // Predefined variables supported by substitute variables 202*b1cdbd2cSJim Jagielski LanguageType m_eLanguageType; // Lanuage type of Office 203*b1cdbd2cSJim Jagielski rtl::OUString m_FixedVar[ PREDEFVAR_COUNT ]; // Variable value access by PreDefVariable 204*b1cdbd2cSJim Jagielski rtl::OUString m_FixedVarNames[ PREDEFVAR_COUNT ]; // Variable name access by PreDefVariable 205*b1cdbd2cSJim Jagielski }; 206*b1cdbd2cSJim Jagielski 207*b1cdbd2cSJim Jagielski struct ReSubstFixedVarOrder 208*b1cdbd2cSJim Jagielski { 209*b1cdbd2cSJim Jagielski sal_Int32 nVarValueLength; 210*b1cdbd2cSJim Jagielski PreDefVariable eVariable; 211*b1cdbd2cSJim Jagielski operator <framework::ReSubstFixedVarOrder212*b1cdbd2cSJim Jagielski bool operator< ( const ReSubstFixedVarOrder& aFixedVarOrder ) const 213*b1cdbd2cSJim Jagielski { 214*b1cdbd2cSJim Jagielski // Reverse operator< to have high to low ordering 215*b1cdbd2cSJim Jagielski return ( nVarValueLength > aFixedVarOrder.nVarValueLength ); 216*b1cdbd2cSJim Jagielski } 217*b1cdbd2cSJim Jagielski }; 218*b1cdbd2cSJim Jagielski 219*b1cdbd2cSJim Jagielski struct ReSubstUserVarOrder 220*b1cdbd2cSJim Jagielski { 221*b1cdbd2cSJim Jagielski sal_Int32 nVarValueLength; 222*b1cdbd2cSJim Jagielski rtl::OUString aVarName; 223*b1cdbd2cSJim Jagielski operator <framework::ReSubstUserVarOrder224*b1cdbd2cSJim Jagielski bool operator< ( const ReSubstUserVarOrder& aUserVarOrder ) const 225*b1cdbd2cSJim Jagielski { 226*b1cdbd2cSJim Jagielski // Reverse operator< to have high to low ordering 227*b1cdbd2cSJim Jagielski return ( nVarValueLength > aUserVarOrder.nVarValueLength ); 228*b1cdbd2cSJim Jagielski } 229*b1cdbd2cSJim Jagielski }; 230*b1cdbd2cSJim Jagielski 231*b1cdbd2cSJim Jagielski typedef std::list< ReSubstFixedVarOrder > ReSubstFixedVarOrderVector; 232*b1cdbd2cSJim Jagielski typedef std::list< ReSubstUserVarOrder > ReSubstUserVarOrderVector; 233*b1cdbd2cSJim Jagielski 234*b1cdbd2cSJim Jagielski class SubstitutePathVariables : private ThreadHelpBase, // Struct for right initalization of mutex member! Must be first of baseclasses. 235*b1cdbd2cSJim Jagielski public ::cppu::WeakImplHelper2< ::com::sun::star::util::XStringSubstitution, css::lang::XServiceInfo > 236*b1cdbd2cSJim Jagielski { 237*b1cdbd2cSJim Jagielski friend class SubstitutePathVariables_Impl; 238*b1cdbd2cSJim Jagielski 239*b1cdbd2cSJim Jagielski public: 240*b1cdbd2cSJim Jagielski SubstitutePathVariables( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& xServiceManager ); 241*b1cdbd2cSJim Jagielski virtual ~SubstitutePathVariables(); 242*b1cdbd2cSJim Jagielski 243*b1cdbd2cSJim Jagielski // XInterface, XTypeProvider, XServiceInfo 244*b1cdbd2cSJim Jagielski DECLARE_XSERVICEINFO 245*b1cdbd2cSJim Jagielski 246*b1cdbd2cSJim Jagielski // XStringSubstitution 247*b1cdbd2cSJim Jagielski virtual rtl::OUString SAL_CALL substituteVariables( const ::rtl::OUString& aText, sal_Bool bSubstRequired ) 248*b1cdbd2cSJim Jagielski throw (::com::sun::star::container::NoSuchElementException, ::com::sun::star::uno::RuntimeException); 249*b1cdbd2cSJim Jagielski virtual rtl::OUString SAL_CALL reSubstituteVariables( const ::rtl::OUString& aText ) 250*b1cdbd2cSJim Jagielski throw (::com::sun::star::uno::RuntimeException); 251*b1cdbd2cSJim Jagielski virtual ::rtl::OUString SAL_CALL getSubstituteVariableValue( const ::rtl::OUString& variable ) 252*b1cdbd2cSJim Jagielski throw (::com::sun::star::container::NoSuchElementException, ::com::sun::star::uno::RuntimeException); 253*b1cdbd2cSJim Jagielski 254*b1cdbd2cSJim Jagielski protected: 255*b1cdbd2cSJim Jagielski DECL_LINK( implts_ConfigurationNotify, SubstitutePathNotify* ); 256*b1cdbd2cSJim Jagielski 257*b1cdbd2cSJim Jagielski void SetPredefinedPathVariables( PredefinedPathVariables& ); 258*b1cdbd2cSJim Jagielski rtl::OUString ConvertOSLtoUCBURL( const rtl::OUString& aOSLCompliantURL ) const; 259*b1cdbd2cSJim Jagielski 260*b1cdbd2cSJim Jagielski // Special case (transient) values can change during runtime! 261*b1cdbd2cSJim Jagielski // Don't store them in the pre defined struct 262*b1cdbd2cSJim Jagielski rtl::OUString GetWorkPath() const; 263*b1cdbd2cSJim Jagielski rtl::OUString GetWorkVariableValue() const; 264*b1cdbd2cSJim Jagielski rtl::OUString GetPathVariableValue() const; 265*b1cdbd2cSJim Jagielski 266*b1cdbd2cSJim Jagielski rtl::OUString GetHomeVariableValue() const; 267*b1cdbd2cSJim Jagielski 268*b1cdbd2cSJim Jagielski // XStringSubstitution implementation methods 269*b1cdbd2cSJim Jagielski rtl::OUString impl_substituteVariable( const ::rtl::OUString& aText, bool bSustRequired ) 270*b1cdbd2cSJim Jagielski throw (::com::sun::star::container::NoSuchElementException, ::com::sun::star::uno::RuntimeException); 271*b1cdbd2cSJim Jagielski rtl::OUString impl_reSubstituteVariables( const ::rtl::OUString& aText ) 272*b1cdbd2cSJim Jagielski throw (::com::sun::star::uno::RuntimeException); 273*b1cdbd2cSJim Jagielski ::rtl::OUString impl_getSubstituteVariableValue( const ::rtl::OUString& variable ) 274*b1cdbd2cSJim Jagielski throw (::com::sun::star::container::NoSuchElementException, ::com::sun::star::uno::RuntimeException); 275*b1cdbd2cSJim Jagielski 276*b1cdbd2cSJim Jagielski private: 277*b1cdbd2cSJim Jagielski class VarNameToIndexMap : public std::hash_map< ::rtl::OUString, 278*b1cdbd2cSJim Jagielski PreDefVariable, 279*b1cdbd2cSJim Jagielski rtl::OUStringHash, 280*b1cdbd2cSJim Jagielski ::std::equal_to< ::rtl::OUString > > 281*b1cdbd2cSJim Jagielski { free()282*b1cdbd2cSJim Jagielski inline void free() 283*b1cdbd2cSJim Jagielski { 284*b1cdbd2cSJim Jagielski VarNameToIndexMap().swap( *this ); 285*b1cdbd2cSJim Jagielski } 286*b1cdbd2cSJim Jagielski }; 287*b1cdbd2cSJim Jagielski 288*b1cdbd2cSJim Jagielski // heavy used string 289*b1cdbd2cSJim Jagielski const rtl::OUString m_aVarStart; 290*b1cdbd2cSJim Jagielski const rtl::OUString m_aVarEnd; 291*b1cdbd2cSJim Jagielski 292*b1cdbd2cSJim Jagielski VarNameToIndexMap m_aPreDefVarMap; // Mapping from pre-def variable names to enum for array access 293*b1cdbd2cSJim Jagielski SubstituteVariables m_aSubstVarMap; // Active rule set map indexed by variable name! 294*b1cdbd2cSJim Jagielski PredefinedPathVariables m_aPreDefVars; // All predefined variables 295*b1cdbd2cSJim Jagielski SubstitutePathVariables_Impl m_aImpl; // Implementation class that access the configuration 296*b1cdbd2cSJim Jagielski ReSubstFixedVarOrderVector m_aReSubstFixedVarOrder; // To speed up resubstitution fixed variables (order for lookup) 297*b1cdbd2cSJim Jagielski ReSubstUserVarOrderVector m_aReSubstUserVarOrder; // To speed up resubstitution user variables 298*b1cdbd2cSJim Jagielski com::sun::star::uno::Reference< com::sun::star::lang::XMultiServiceFactory > m_xServiceManager; 299*b1cdbd2cSJim Jagielski }; 300*b1cdbd2cSJim Jagielski 301*b1cdbd2cSJim Jagielski } 302*b1cdbd2cSJim Jagielski 303*b1cdbd2cSJim Jagielski #endif // __FRAMEWORK_SERVICES_SUBSTPATHVARS_HXX_ 304