kio Library API Documentation

kprotocolmanager.cpp

00001 /* This file is part of the KDE libraries
00002    Copyright (C) 1999 Torben Weis <weis@kde.org>
00003    Copyright (C) 2000- Waldo Bastain <bastain@kde.org>
00004    Copyright (C) 2000- Dawit Alemayehu <adawit@kde.org>
00005 
00006    This library is free software; you can redistribute it and/or
00007    modify it under the terms of the GNU Library General Public
00008    License version 2 as published by the Free Software Foundation.
00009 
00010    This library is distributed in the hope that it will be useful,
00011    but WITHOUT ANY WARRANTY; without even the implied warranty of
00012    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013    Library General Public License for more details.
00014 
00015    You should have received a copy of the GNU Library General Public License
00016    along with this library; see the file COPYING.LIB.  If not, write to
00017    the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00018    Boston, MA 02111-1307, USA.
00019 */
00020 
00021 #include <string.h>
00022 #include <sys/utsname.h>
00023 
00024 #include <dcopref.h>
00025 #include <kdebug.h>
00026 #include <kglobal.h>
00027 #include <klocale.h>
00028 #include <kconfig.h>
00029 #include <kstandarddirs.h>
00030 #include <klibloader.h>
00031 #include <kstringhandler.h>
00032 #include <kstaticdeleter.h>
00033 #include <kio/slaveconfig.h>
00034 #include <kio/ioslave_defaults.h>
00035 #include <kio/http_slave_defaults.h>
00036 
00037 #include "kprotocolmanager.h"
00038 
00039 class
00040 KProtocolManagerPrivate
00041 {
00042 public:
00043    KProtocolManagerPrivate();
00044 
00045    ~KProtocolManagerPrivate();
00046 
00047    KConfig *config;
00048    KConfig *http_config;
00049    bool init_busy;
00050    KURL url;
00051    QString protocol;
00052    QString proxy;
00053    QString modifiers;
00054    QString useragent;
00055 };
00056 
00057 static KProtocolManagerPrivate* d = 0;
00058 static KStaticDeleter<KProtocolManagerPrivate> kpmpksd;
00059 
00060 KProtocolManagerPrivate::KProtocolManagerPrivate()
00061                         :config(0), http_config(0), init_busy(false)
00062 {
00063    kpmpksd.setObject(d, this);
00064 }
00065 
00066 KProtocolManagerPrivate::~KProtocolManagerPrivate()
00067 {
00068    delete config;
00069    delete http_config;
00070 }
00071 
00072 
00073 // DEFAULT USERAGENT STRING
00074 #define CFG_DEFAULT_UAGENT(X) \
00075 QString("Mozilla/5.0 (compatible; Konqueror/%1.%2%3) KHTML/%4.%5.%6 (like Gecko)") \
00076         .arg(KDE_VERSION_MAJOR).arg(KDE_VERSION_MINOR).arg(X).arg(KDE_VERSION_MAJOR).arg(KDE_VERSION_MINOR).arg(KDE_VERSION_RELEASE)
00077 
00078 void KProtocolManager::reparseConfiguration()
00079 {
00080   kpmpksd.destructObject();
00081 
00082   // Force the slave config to re-read its config...
00083   KIO::SlaveConfig::self()->reset ();
00084 }
00085 
00086 KConfig *KProtocolManager::config()
00087 {
00088   if (!d)
00089      d = new KProtocolManagerPrivate;
00090 
00091   if (!d->config)
00092   {
00093      d->config = new KConfig("kioslaverc", true, false);
00094   }
00095   return d->config;
00096 }
00097 
00098 KConfig *KProtocolManager::http_config()
00099 {
00100   if (!d)
00101      d = new KProtocolManagerPrivate;
00102 
00103   if (!d->http_config)
00104   {
00105      d->http_config = new KConfig("kio_httprc", false, false);
00106   }
00107   return d->http_config;
00108 }
00109 
00110 /*=============================== TIMEOUT SETTINGS ==========================*/
00111 
00112 int KProtocolManager::readTimeout()
00113 {
00114   KConfig *cfg = config();
00115   cfg->setGroup( QString::null );
00116   int val = cfg->readNumEntry( "ReadTimeout", DEFAULT_READ_TIMEOUT );
00117   return QMAX(MIN_TIMEOUT_VALUE, val);
00118 }
00119 
00120 int KProtocolManager::connectTimeout()
00121 {
00122   KConfig *cfg = config();
00123   cfg->setGroup( QString::null );
00124   int val = cfg->readNumEntry( "ConnectTimeout", DEFAULT_CONNECT_TIMEOUT );
00125   return QMAX(MIN_TIMEOUT_VALUE, val);
00126 }
00127 
00128 int KProtocolManager::proxyConnectTimeout()
00129 {
00130   KConfig *cfg = config();
00131   cfg->setGroup( QString::null );
00132   int val = cfg->readNumEntry( "ProxyConnectTimeout", DEFAULT_PROXY_CONNECT_TIMEOUT );
00133   return QMAX(MIN_TIMEOUT_VALUE, val);
00134 }
00135 
00136 int KProtocolManager::responseTimeout()
00137 {
00138   KConfig *cfg = config();
00139   cfg->setGroup( QString::null );
00140   int val = cfg->readNumEntry( "ResponseTimeout", DEFAULT_RESPONSE_TIMEOUT );
00141   return QMAX(MIN_TIMEOUT_VALUE, val);
00142 }
00143 
00144 /*========================== PROXY SETTINGS =================================*/
00145 
00146 bool KProtocolManager::useProxy()
00147 {
00148   return proxyType() != NoProxy;
00149 }
00150 
00151 bool KProtocolManager::useReverseProxy()
00152 {
00153   KConfig *cfg = config();
00154   cfg->setGroup( "Proxy Settings" );
00155   return cfg->readBoolEntry("ReversedException", false);
00156 }
00157 
00158 KProtocolManager::ProxyType KProtocolManager::proxyType()
00159 {
00160   KConfig *cfg = config();
00161   cfg->setGroup( "Proxy Settings" );
00162   return static_cast<ProxyType>(cfg->readNumEntry( "ProxyType" ));
00163 }
00164 
00165 KProtocolManager::ProxyAuthMode KProtocolManager::proxyAuthMode()
00166 {
00167   KConfig *cfg = config();
00168   cfg->setGroup( "Proxy Settings" );
00169   return static_cast<ProxyAuthMode>(cfg->readNumEntry( "AuthMode" ));
00170 }
00171 
00172 /*========================== CACHING =====================================*/
00173 
00174 bool KProtocolManager::useCache()
00175 {
00176   KConfig *cfg = http_config();
00177   return cfg->readBoolEntry( "UseCache", true );
00178 }
00179 
00180 KIO::CacheControl KProtocolManager::cacheControl()
00181 {
00182   KConfig *cfg = http_config();
00183   QString tmp = cfg->readEntry("cache");
00184   if (tmp.isEmpty())
00185     return DEFAULT_CACHE_CONTROL;
00186   return KIO::parseCacheControl(tmp);
00187 }
00188 
00189 QString KProtocolManager::cacheDir()
00190 {
00191   KConfig *cfg = http_config();
00192   return cfg->readPathEntry("CacheDir", KGlobal::dirs()->saveLocation("cache","http"));
00193 }
00194 
00195 int KProtocolManager::maxCacheAge()
00196 {
00197   KConfig *cfg = http_config();
00198   return cfg->readNumEntry( "MaxCacheAge", DEFAULT_MAX_CACHE_AGE ); // 14 days
00199 }
00200 
00201 int KProtocolManager::maxCacheSize()
00202 {
00203   KConfig *cfg = http_config();
00204   return cfg->readNumEntry( "MaxCacheSize", DEFAULT_MAX_CACHE_SIZE ); // 5 MB
00205 }
00206 
00207 QString KProtocolManager::noProxyFor()
00208 {
00209   KProtocolManager::ProxyType type = proxyType();
00210 
00211   if ( (type != ManualProxy) && (type != EnvVarProxy) )
00212     return QString::null;
00213 
00214   KConfig *cfg = config();
00215   cfg->setGroup( "Proxy Settings" );
00216 
00217   QString noProxy = cfg->readEntry( "NoProxyFor" );
00218   if (type == EnvVarProxy)
00219     noProxy = QString::fromLocal8Bit(getenv(noProxy.local8Bit()));
00220 
00221   return noProxy;
00222 }
00223 
00224 QString KProtocolManager::proxyFor( const QString& protocol )
00225 {
00226   QString scheme = protocol.lower();
00227 
00228   if (scheme == "webdav")
00229     scheme = "http";
00230   else if (scheme == "webdavs")
00231     scheme = "https";
00232 
00233   KConfig *cfg = config();
00234   cfg->setGroup( "Proxy Settings" );
00235   return cfg->readEntry( scheme + "Proxy" );
00236 }
00237 
00238 QString KProtocolManager::proxyForURL( const KURL &url )
00239 {
00240   QString proxy;
00241   ProxyType pt = proxyType();
00242 
00243   switch (pt)
00244   {
00245       case PACProxy:
00246       case WPADProxy:
00247           if (!url.host().isEmpty())
00248           {
00249             QString p = url.protocol();
00250             if ( p.startsWith( "http" ) || p == "ftp" || p == "gopher" )
00251               DCOPRef( "kded", "proxyscout" ).call( "proxyForURL", url ).get( proxy );
00252           }
00253           break;
00254       case EnvVarProxy:
00255           proxy = QString::fromLocal8Bit(getenv(proxyFor(url.protocol()).local8Bit())).stripWhiteSpace();
00256           break;
00257       case ManualProxy:
00258           proxy = proxyFor( url.protocol() );
00259           break;
00260       case NoProxy:
00261       default:
00262           break;
00263   }
00264 
00265   return (proxy.isEmpty() ? QString::fromLatin1("DIRECT") : proxy);
00266 }
00267 
00268 void KProtocolManager::badProxy( const QString &proxy )
00269 {
00270     DCOPRef( "kded", "proxyscout" ).send( "blackListProxy", proxy );
00271 }
00272 
00273 /*
00274     Domain suffix match. E.g. return true if host is "cuzco.inka.de" and
00275     nplist is "inka.de,hadiko.de" or if host is "localhost" and nplist is
00276     "localhost".
00277 */
00278 static bool revmatch(const char *host, const char *nplist)
00279 {
00280   if (host == 0)
00281     return false;
00282 
00283   const char *hptr = host + strlen( host ) - 1;
00284   const char *nptr = nplist + strlen( nplist ) - 1;
00285   const char *shptr = hptr;
00286 
00287   while ( nptr >= nplist )
00288   {
00289     if ( *hptr != *nptr )
00290     {
00291       hptr = shptr;
00292 
00293       // Try to find another domain or host in the list
00294       while(--nptr>=nplist && *nptr!=',' && *nptr!=' ') ;
00295 
00296       // Strip out multiple spaces and commas
00297       while(--nptr>=nplist && (*nptr==',' || *nptr==' ')) ;
00298     }
00299     else
00300     {
00301       if ( nptr==nplist || nptr[-1]==',' || nptr[-1]==' ')
00302         return true;
00303       if ( hptr == host ) // e.g. revmatch("bugs.kde.org","mybugs.kde.org")
00304         return false;
00305 
00306       hptr--;
00307       nptr--;
00308     }
00309   }
00310 
00311   return false;
00312 }
00313 
00314 QString KProtocolManager::slaveProtocol(const KURL &url, QString &proxy)
00315 {
00316   if (url.hasSubURL()) // We don't want the suburl's protocol
00317   {
00318      KURL::List list = KURL::split(url);
00319      KURL::List::Iterator it = list.fromLast();
00320      return slaveProtocol(*it, proxy);
00321   }
00322 
00323   if (!d)
00324     d = new KProtocolManagerPrivate;
00325 
00326   if (d->url == url)
00327   {
00328      proxy = d->proxy;
00329      return d->protocol;
00330   }
00331 
00332   if (useProxy())
00333   {
00334      proxy = proxyForURL(url);
00335      if ((proxy != "DIRECT") && (!proxy.isEmpty()))
00336      {
00337         bool isRevMatch = false;
00338         bool useRevProxy = ((proxyType() == ManualProxy) && useReverseProxy());
00339 
00340         QString noProxy = noProxyFor();
00341 
00342         if (!noProxy.isEmpty())
00343         {
00344            QString qhost = url.host().lower();
00345            const char *host = qhost.latin1();
00346            QString qno_proxy = noProxy.stripWhiteSpace().lower();
00347            const char *no_proxy = qno_proxy.latin1();
00348            isRevMatch = revmatch(host, no_proxy);
00349 
00350            // If no match is found and the request url has a port
00351            // number, try the combination of "host:port". This allows
00352            // users to enter host:port in the No-proxy-For list.
00353            if (!isRevMatch && url.port() > 0)
00354            {
00355               qhost += ':' + QString::number (url.port());
00356               host = qhost.latin1();
00357               isRevMatch = revmatch (host, no_proxy);
00358            }
00359 
00360            // If the hostname does not contain a dot, check if
00361            // <local> is part of noProxy.
00362            if (!isRevMatch && host && (strchr(host, '.') == NULL))
00363               isRevMatch = revmatch("<local>", no_proxy);
00364         }
00365 
00366         if ( (!useRevProxy && !isRevMatch) || (useRevProxy && isRevMatch) )
00367         {
00368            d->url = proxy;
00369            if ( d->url.isValid() )
00370            {
00371               // The idea behind slave protocols is not applicable to http
00372               // and webdav protocols.
00373               QString protocol = url.protocol().lower();
00374               if (protocol.startsWith("http") || protocol.startsWith("webdav"))
00375                 d->protocol = protocol;
00376               else
00377               {
00378                 d->protocol = d->url.protocol();
00379                 kdDebug () << "slaveProtocol: " << d->protocol << endl;
00380               }
00381 
00382               d->url = url;
00383               d->proxy = proxy;
00384               return d->protocol;
00385            }
00386         }
00387      }
00388   }
00389 
00390   d->url = url;
00391   d->proxy = proxy = QString::null;
00392   d->protocol = url.protocol();
00393   return d->protocol;
00394 }
00395 
00396 /*================================= USER-AGENT SETTINGS =====================*/
00397 
00398 QString KProtocolManager::userAgentForHost( const QString& hostname )
00399 {
00400   QString sendUserAgent = KIO::SlaveConfig::self()->configData("http", hostname.lower(), "SendUserAgent").lower();
00401   if (sendUserAgent == "false")
00402      return QString::null;
00403 
00404   QString useragent = KIO::SlaveConfig::self()->configData("http", hostname.lower(), "UserAgent");
00405 
00406   // Return the default user-agent if none is specified
00407   // for the requested host.
00408   if (useragent.isEmpty())
00409     return defaultUserAgent();
00410 
00411   return useragent;
00412 }
00413 
00414 QString KProtocolManager::defaultUserAgent( )
00415 {
00416   QString modifiers = KIO::SlaveConfig::self()->configData("http", QString::null, "UserAgentKeys");
00417   return defaultUserAgent(modifiers);
00418 }
00419 
00420 QString KProtocolManager::defaultUserAgent( const QString &_modifiers )
00421 {
00422   if (!d)
00423      d = new KProtocolManagerPrivate;
00424 
00425   QString modifiers = _modifiers.lower();
00426   if (modifiers.isEmpty())
00427      modifiers = DEFAULT_USER_AGENT_KEYS;
00428 
00429   if (d->modifiers == modifiers)
00430      return d->useragent;
00431 
00432   QString supp;
00433   struct utsname nam;
00434   if( uname(&nam) >= 0 )
00435   {
00436     if( modifiers.contains('o') )
00437     {
00438       supp += QString("; %1").arg(nam.sysname);
00439       if ( modifiers.contains('v') )
00440         supp += QString(" %1").arg(nam.release);
00441     }
00442     if( modifiers.contains('p') )
00443     {
00444       supp += QString::fromLatin1("; X11");  // TODO: determine this valye instead of hardcoding...
00445     }
00446     if( modifiers.contains('m') )
00447     {
00448       supp += QString("; %1").arg(nam.machine);
00449     }
00450     if( modifiers.contains('l') )
00451     {
00452       QStringList languageList = KGlobal::locale()->languageList();
00453       QStringList::Iterator it = languageList.find( QString::fromLatin1("C") );
00454       if( it != languageList.end() )
00455       {
00456         if( languageList.contains( QString::fromLatin1("en") ) > 0 )
00457           languageList.remove( it );
00458         else
00459           (*it) = QString::fromLatin1("en");
00460       }
00461       if( languageList.count() )
00462         supp += QString("; %1").arg(languageList.join(", "));
00463     }
00464   }
00465   d->modifiers = modifiers;
00466   d->useragent = CFG_DEFAULT_UAGENT(supp);
00467   return d->useragent;
00468 }
00469 
00470 /*==================================== OTHERS ===============================*/
00471 
00472 bool KProtocolManager::markPartial()
00473 {
00474   KConfig *cfg = config();
00475   cfg->setGroup( QString::null );
00476   return cfg->readBoolEntry( "MarkPartial", true );
00477 }
00478 
00479 int KProtocolManager::minimumKeepSize()
00480 {
00481   KConfig *cfg = config();
00482   cfg->setGroup( QString::null );
00483   return cfg->readNumEntry( "MinimumKeepSize",
00484                             DEFAULT_MINIMUM_KEEP_SIZE ); // 5000 byte
00485 }
00486 
00487 bool KProtocolManager::autoResume()
00488 {
00489   KConfig *cfg = config();
00490   cfg->setGroup( QString::null );
00491   return cfg->readBoolEntry( "AutoResume", false );
00492 }
00493 
00494 bool KProtocolManager::persistentConnections()
00495 {
00496   KConfig *cfg = config();
00497   cfg->setGroup( QString::null );
00498   return cfg->readBoolEntry( "PersistentConnections", true );
00499 }
00500 
00501 bool KProtocolManager::persistentProxyConnection()
00502 {
00503   KConfig *cfg = config();
00504   cfg->setGroup( QString::null );
00505   return cfg->readBoolEntry( "PersistentProxyConnection", false );
00506 }
00507 
00508 QString KProtocolManager::proxyConfigScript()
00509 {
00510   KConfig *cfg = config();
00511   cfg->setGroup( "Proxy Settings" );
00512   return cfg->readEntry( "Proxy Config Script" );
00513 }
KDE Logo
This file is part of the documentation for kio Library Version 3.4.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Fri Jul 21 13:14:27 2006 by doxygen 1.4.0 written by Dimitri van Heesch, © 1997-2003