shell/source/backends/wininetbe/wininetbackend.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 <cppuhelper/supportsservice.hxx>
  21 #include "rtl/ustrbuf.hxx"
  22
  23 #include "wininetbackend.hxx"
  24
  25 #if defined _MSC_VER
  26 #pragma warning(push, 1)
  27 #endif
  28 #include <windows.h>
  29 #include <wininet.h>
  30 #include <sal/alloca.h>
  31 #if defined _MSC_VER
  32 #pragma warning(pop)
  33 #endif
  34
  35 #define WININET_DLL_NAME "wininet.dll"
  36 #define EQUAL_SIGN '='
  37 #define COLON      ':'
  38 #define SPACE      ' '
  39 #define SEMI_COLON ';'
  40
  41 namespace {
  42
  43 struct Library {
  44     HMODULE module;
  45
  46     Library(HMODULE theModule): module(theModule) {}
  47
  48     ~Library() { if (module) FreeLibrary(module); }
  49 };
  50
  51 }
  52
  53 typedef struct
  54 {
  55     OUString Server;
  56     OUString Port;
  57 } ProxyEntry;
  58
  59
  60 // helper functions
  61
  62
  63 namespace // private
  64 {
  65     ProxyEntry ReadProxyEntry(const OUString& aProxy, sal_Int32& i)
  66     {
  67         ProxyEntry aProxyEntry;
  68
  69         aProxyEntry.Server = aProxy.getToken( 0, COLON, i );
  70         if ( i > -1 )
  71             aProxyEntry.Port = aProxy.getToken( 0, COLON, i );
  72
  73         return aProxyEntry;
  74     }
  75
  76     ProxyEntry FindProxyEntry(const OUString& aProxyList, const OUString& aType)
  77     {
  78         sal_Int32 nIndex = 0;
  79
  80         do
  81         {
  82             // get the next token, e.g. ftp=server:port
  83             OUString nextToken = aProxyList.getToken( 0, SPACE, nIndex );
  84
  85             // split the next token again into the parts separated
  86             // through '=', e.g. ftp=server:port -> ftp and server:port
  87             sal_Int32 i = 0;
  88             if( nextToken.indexOf( EQUAL_SIGN ) > -1 )
  89             {
  90                 if( aType.equals( nextToken.getToken( 0, EQUAL_SIGN, i ) ) )
  91                     return ReadProxyEntry(nextToken, i);
  92             }
  93             else if( aType.isEmpty())
  94                 return ReadProxyEntry(nextToken, i);
  95
  96         } while ( nIndex >= 0 );
  97
  98         return ProxyEntry();
  99     }
 100
 101 } // end private namespace
 102
 103
 104
 105 WinInetBackend::WinInetBackend()
 106 {
 107     Library hWinInetDll( LoadLibrary( WININET_DLL_NAME ) );
 108     if( hWinInetDll.module )
 109     {
 110         typedef BOOL ( WINAPI *InternetQueryOption_Proc_T )( HINTERNET, DWORD, LPVOID, LPDWORD );
 111
 112         InternetQueryOption_Proc_T lpfnInternetQueryOption =
 113             reinterpret_cast< InternetQueryOption_Proc_T >(
 114                 GetProcAddress( hWinInetDll.module, "InternetQueryOptionA" ) );
 115         if (lpfnInternetQueryOption)
 116         {
 117             // Some Windows versions would fail the InternetQueryOption call
 118             // with ERROR_OUTOFMEMORY when the initial dwLength were zero (and
 119             // are apparently fine with the initial sizeof (INTERNET_PROXY_INFO)
 120             // and need no reallocation), while other versions fail with
 121             // ERROR_INSUFFICIENT_BUFFER upon that initial dwLength and need a
 122             // reallocation:
 123             INTERNET_PROXY_INFO pi;
 124             LPINTERNET_PROXY_INFO lpi = &pi;
 125             DWORD dwLength = sizeof (INTERNET_PROXY_INFO);
 126             BOOL ok = lpfnInternetQueryOption(
 127                 NULL,
 128                 INTERNET_OPTION_PROXY,
 129                 (LPVOID)lpi,
 130                 &dwLength );
 131             if (!ok)
 132             {
 133                 DWORD err = GetLastError();
 134                 if (err == ERROR_INSUFFICIENT_BUFFER)
 135                 {
 136                     // allocate sufficient space on the heap
 137                     // insufficient space on the heap results
 138                     // in a stack overflow exception, we assume
 139                     // this never happens, because of the relatively
 140                     // small amount of memory we need
 141                     // alloca is nice because it is fast and we don't
 142                     // have to free the allocated memory, it will be
 143                     // automatically done
 144                     lpi = reinterpret_cast< LPINTERNET_PROXY_INFO >(
 145                         alloca( dwLength ) );
 146                     ok = lpfnInternetQueryOption(
 147                         NULL,
 148                         INTERNET_OPTION_PROXY,
 149                         (LPVOID)lpi,
 150                         &dwLength );
 151                     if (!ok)
 152                     {
 153                         err = GetLastError();
 154                     }
 155                 }
 156                 if (!ok)
 157                 {
 158                     SAL_WARN(
 159                         "shell",
 160                         "InternetQueryOption INTERNET_OPTION_PROXY"
 161                             " GetLastError=" << err);
 162                     return;
 163                 }
 164             }
 165
 166             // if a proxy is disabled, InternetQueryOption returns
 167             // an empty proxy list, so we don't have to check if
 168             // proxy is enabled or not
 169
 170             OUString aProxyList       = OUString::createFromAscii( lpi->lpszProxy );
 171             OUString aProxyBypassList = OUString::createFromAscii( lpi->lpszProxyBypass );
 172
 173             // override default for ProxyType, which is "0" meaning "No proxies".
 174             sal_Int32 nProperties = 1;
 175
 176             valueProxyType_.IsPresent = true;
 177             valueProxyType_.Value <<= nProperties;
 178
 179             // fill proxy bypass list
 180             if( aProxyBypassList.getLength() > 0 )
 181             {
 182                 OUStringBuffer aReverseList;
 183                 sal_Int32 nIndex = 0;
 184                 do
 185                 {
 186                     OUString aToken = aProxyBypassList.getToken( 0, SPACE, nIndex );
 187                     if ( aProxyList.indexOf( aToken ) == -1 )
 188                     {
 189                         if ( aReverseList.getLength() )
 190                         {
 191                             aReverseList.insert( 0, sal_Unicode( SEMI_COLON ) );
 192                             aReverseList.insert( 0, aToken );
 193                         }
 194                         else
 195                             aReverseList = aToken;
 196                     }
 197                 }
 198                 while ( nIndex >= 0 );
 199
 200                 aProxyBypassList = aReverseList.makeStringAndClear();
 201
 202                 valueNoProxy_.IsPresent = true;
 203                 valueNoProxy_.Value <<= aProxyBypassList.replace( SPACE, SEMI_COLON );
 204             }
 205
 206             if( aProxyList.getLength() > 0 )
 207             {
 208
 209                 // this implementation follows the algorithm
 210                 // of the internet explorer
 211                 // if there are type-dependent proxy settings
 212                 // and type independent proxy settings in the
 213                 // registry the internet explorer chooses the
 214                 // type independent proxy for all settings
 215                 // e.g. imagine the following registry entry
 216                 // ftp=server:port;http=server:port;server:port
 217                 // the last token server:port is type independent
 218                 // so the ie chooses this proxy server
 219
 220                 // if there is no port specified for a type independent
 221                 // server the ie uses the port of an http server if
 222                 // there is one and it has a port
 223
 224
 225                 ProxyEntry aTypeIndepProxy = FindProxyEntry( aProxyList, OUString());
 226                 ProxyEntry aHttpProxy = FindProxyEntry( aProxyList, OUString(
 227                     "http"  ) );
 228                 ProxyEntry aHttpsProxy  = FindProxyEntry( aProxyList, OUString(
 229                     "https"  ) );
 230
 231                 ProxyEntry aFtpProxy  = FindProxyEntry( aProxyList, OUString(
 232                     "ftp"  ) );
 233
 234                 if( aTypeIndepProxy.Server.getLength() )
 235                 {
 236                     aHttpProxy.Server = aTypeIndepProxy.Server;
 237                     aHttpsProxy.Server  = aTypeIndepProxy.Server;
 238                     aFtpProxy.Server  = aTypeIndepProxy.Server;
 239
 240                     if( aTypeIndepProxy.Port.getLength() )
 241                     {
 242                         aHttpProxy.Port = aTypeIndepProxy.Port;
 243                         aHttpsProxy.Port  = aTypeIndepProxy.Port;
 244                         aFtpProxy.Port  = aTypeIndepProxy.Port;
 245                     }
 246                     else
 247                     {
 248                         aFtpProxy.Port  = aHttpProxy.Port;
 249                         aHttpsProxy.Port  = aHttpProxy.Port;
 250                     }
 251                 }
 252
 253                 // http proxy name
 254                 if( aHttpProxy.Server.getLength() > 0 )
 255                 {
 256                     valueHttpProxyName_.IsPresent = true;
 257                     valueHttpProxyName_.Value <<= aHttpProxy.Server;
 258                 }
 259
 260                 // http proxy port
 261                 if( aHttpProxy.Port.getLength() > 0 )
 262                 {
 263                     valueHttpProxyPort_.IsPresent = true;
 264                     valueHttpProxyPort_.Value <<= aHttpProxy.Port.toInt32();
 265                 }
 266
 267                 // https proxy name
 268                 if( aHttpsProxy.Server.getLength() > 0 )
 269                 {
 270                     valueHttpsProxyName_.IsPresent = true;
 271                     valueHttpsProxyName_.Value <<= aHttpsProxy.Server;
 272                 }
 273
 274                 // https proxy port
 275                 if( aHttpsProxy.Port.getLength() > 0 )
 276                 {
 277                     valueHttpsProxyPort_.IsPresent = true;
 278                     valueHttpsProxyPort_.Value <<= aHttpsProxy.Port.toInt32();
 279                 }
 280
 281                 // ftp proxy name
 282                 if( aFtpProxy.Server.getLength() > 0 )
 283                 {
 284                     valueFtpProxyName_.IsPresent = true;
 285                     valueFtpProxyName_.Value <<= aFtpProxy.Server;
 286                 }
 287
 288                 // ftp proxy port
 289                 if( aFtpProxy.Port.getLength() > 0 )
 290                 {
 291                     valueFtpProxyPort_.IsPresent = true;
 292                     valueFtpProxyPort_.Value <<= aFtpProxy.Port.toInt32();
 293                 }
 294             }
 295         }
 296     }
 297 }
 298
 299
 300
 301 WinInetBackend::~WinInetBackend()
 302 {
 303 }
 304
 305
 306
 307 WinInetBackend* WinInetBackend::createInstance()
 308 {
 309     return new WinInetBackend;
 310 }
 311
 312
 313
 314 void WinInetBackend::setPropertyValue(
 315     OUString const &, css::uno::Any const &)
 316     throw (
 317         css::beans::UnknownPropertyException, css::beans::PropertyVetoException,
 318         css::lang::IllegalArgumentException, css::lang::WrappedTargetException,
 319         css::uno::RuntimeException)
 320 {
 321     throw css::lang::IllegalArgumentException(
 322         OUString(
 323             "setPropertyValue not supported"),
 324         static_cast< cppu::OWeakObject * >(this), -1);
 325 }
 326
 327 css::uno::Any WinInetBackend::getPropertyValue(
 328     OUString const & PropertyName)
 329     throw (
 330         css::beans::UnknownPropertyException, css::lang::WrappedTargetException,
 331         css::uno::RuntimeException)
 332 {
 333     if ( PropertyName == "ooInetFTPProxyName" )
 334     {
 335         return css::uno::makeAny(valueFtpProxyName_);
 336     } else if ( PropertyName == "ooInetFTPProxyPort" )
 337     {
 338         return css::uno::makeAny(valueFtpProxyPort_);
 339     } else if ( PropertyName == "ooInetHTTPProxyName" )
 340     {
 341         return css::uno::makeAny(valueHttpProxyName_);
 342     } else if ( PropertyName == "ooInetHTTPProxyPort" )
 343     {
 344         return css::uno::makeAny(valueHttpProxyPort_);
 345     } else if ( PropertyName == "ooInetHTTPSProxyName" )
 346     {
 347         return css::uno::makeAny(valueHttpsProxyName_);
 348     } else if ( PropertyName == "ooInetHTTPSProxyPort" )
 349     {
 350         return css::uno::makeAny(valueHttpsProxyPort_);
 351     } else if ( PropertyName == "ooInetNoProxy" )
 352     {
 353         return css::uno::makeAny(valueNoProxy_);
 354     } else if ( PropertyName == "ooInetProxyType" )
 355     {
 356         return css::uno::makeAny(valueProxyType_);
 357     } else {
 358         throw css::beans::UnknownPropertyException(
 359             PropertyName, static_cast< cppu::OWeakObject * >(this));
 360     }
 361 }
 362
 363
 364
 365 OUString SAL_CALL WinInetBackend::getBackendName() {
 366     return OUString("com.sun.star.comp.configuration.backend.WinInetBackend") ;
 367 }
 368
 369
 370
 371 OUString SAL_CALL WinInetBackend::getImplementationName()
 372     throw (uno::RuntimeException)
 373 {
 374     return getBackendName() ;
 375 }
 376
 377 uno::Sequence<OUString> SAL_CALL WinInetBackend::getBackendServiceNames()
 378 {
 379     uno::Sequence<OUString> aServiceNameList(1);
 380     aServiceNameList[0] = "com.sun.star.configuration.backend.WinInetBackend";
 381
 382     return aServiceNameList ;
 383 }
 384
 385 sal_Bool SAL_CALL WinInetBackend::supportsService(const OUString& aServiceName)
 386     throw (uno::RuntimeException)
 387 {
 388     return cppu::supportsService(this, aServiceName);
 389 }
 390
 391 uno::Sequence<OUString> SAL_CALL WinInetBackend::getSupportedServiceNames()
 392     throw (uno::RuntimeException)
 393 {
 394     return getBackendServiceNames() ;
 395 }
 396
 397 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */