apps/konqueror/settings/kio/kenvvarproxydlg.cpp

   1 /*
   2    kenvvarproxydlg.cpp - Proxy configuration dialog
   3
   4    Copyright (C) 2001- Dawit Alemayehu <adawit@kde.org>
   5
   6    This library is free software; you can redistribute it and/or
   7    modify it under the terms of the GNU General Public
   8    License (GPL) version 2 as published by the Free Software
   9    Foundation.
  10
  11    This library is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    Library General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this library; see the file COPYING.LIB.  If not, write to
  18    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  19    Boston, MA 02110-1301, USA.
  20 */
  21
  22 // Local
  23 #include "kenvvarproxydlg.h"
  24
  25 // std
  26 #include <stdlib.h>
  27
  28 // Qt
  29 #include <QtGui/QLabel>
  30 #include <QtGui/QLayout>
  31 #include <QtGui/QCheckBox>
  32 #include <QtGui/QPushButton>
  33
  34 // KDE
  35 #include <kdebug.h>
  36 #include <klocale.h>
  37 #include <klineedit.h>
  38 #include <kmessagebox.h>
  39 #include <kurl.h>
  40
  41 #define ENV_FTP_PROXY     "FTP_PROXY,ftp_proxy,FTPPROXY,ftpproxy,PROXY,proxy"
  42 #define ENV_HTTP_PROXY    "HTTP_PROXY,http_proxy,HTTPPROXY,httpproxy,PROXY,proxy"
  43 #define ENV_HTTPS_PROXY   "HTTPS_PROXY,https_proxy,HTTPSPROXY,httpsproxy,PROXY,proxy"
  44 #define NO_PROXY          "NO_PROXY,no_proxy"
  45
  46
  47 KEnvVarProxyDlg::KEnvVarProxyDlg( QWidget* parent, const char* name )
  48                 :KProxyDialogBase( parent, name, true,
  49                                    i18n( "Variable Proxy Configuration" ) )
  50 {
  51   mDlg = new EnvVarProxyDlgUI( this );
  52   setMainWidget( mDlg );
  53   mDlg->leHttp->setMinimumWidth( mDlg->leHttp->fontMetrics().maxWidth() * 20 );
  54   init();
  55 }
  56
  57 KEnvVarProxyDlg::~KEnvVarProxyDlg ()
  58 {
  59 }
  60
  61 void KEnvVarProxyDlg::init()
  62 {
  63   m_bHasValidData = false;
  64
  65   connect( mDlg->cbShowValue, SIGNAL( clicked() ), SLOT( showValue() ) );
  66   connect( mDlg->pbVerify, SIGNAL( clicked() ), SLOT( verifyPressed() ) );
  67   connect( mDlg->pbDetect, SIGNAL( clicked() ), SLOT( autoDetectPressed() ) );
  68 }
  69
  70 void KEnvVarProxyDlg::setProxyData( const KProxyData& data )
  71 {
  72   // Setup HTTP Proxy...
  73   KUrl u ( data.proxyList["http"] );
  74   if (!u.isEmpty() && !u.isValid())
  75   {
  76     mEnvVarsMap["http"].name = data.proxyList["http"];
  77     mEnvVarsMap["http"].value = QString::fromLocal8Bit( getenv(data.proxyList["http"].toLocal8Bit()) );
  78   }
  79
  80   // Setup HTTPS Proxy...
  81   u = data.proxyList["https"];
  82   if (!u.isEmpty() && !u.isValid())
  83   {
  84     mEnvVarsMap["https"].name = data.proxyList["https"];
  85     mEnvVarsMap["https"].value = QString::fromLocal8Bit( getenv(data.proxyList["https"].toLocal8Bit()) );
  86   }
  87
  88   // Setup FTP Proxy...
  89   u = data.proxyList["ftp"];
  90   if (!u.isEmpty() && !u.isValid())
  91   {
  92     mEnvVarsMap["ftp"].name = data.proxyList["ftp"];
  93     mEnvVarsMap["ftp"].value = QString::fromLocal8Bit( getenv(data.proxyList["ftp"].toLocal8Bit()) );
  94   }
  95
  96   u = data.noProxyFor.join(",");
  97   if (!u.isEmpty() && !u.isValid())
  98   {
  99     QString noProxy = u.url();
 100     mEnvVarsMap["noProxy"].name = noProxy;
 101     mEnvVarsMap["noProxy"].value = QString::fromLocal8Bit( getenv(noProxy.toLocal8Bit()) );
 102   }
 103
 104   mDlg->cbShowValue->setChecked( data.showEnvVarValue );
 105   showValue();
 106 }
 107
 108 const KProxyData KEnvVarProxyDlg::data() const
 109 {
 110   KProxyData data;
 111
 112   if (m_bHasValidData)
 113   {
 114     data.proxyList["http"] = mEnvVarsMap["http"].name;
 115     data.proxyList["https"] = mEnvVarsMap["https"].name;
 116     data.proxyList["ftp"] = mEnvVarsMap["ftp"].name;
 117     data.noProxyFor = QStringList(mEnvVarsMap["noProxy"].name);
 118     data.type = KProtocolManager::EnvVarProxy;
 119     data.showEnvVarValue = mDlg->cbShowValue->isChecked();
 120   }
 121
 122   return data;
 123 }
 124
 125
 126 void KEnvVarProxyDlg::verifyPressed()
 127 {
 128   if ( !validate() )
 129   {
 130     QString msg = i18n("You must specify at least one valid proxy "
 131                        "environment variable.");
 132
 133     QString details = i18n("<qt>Make sure you entered the actual environment "
 134                            "variable name rather than its value. For "
 135                            "example, if the environment variable is <br /><b>"
 136                            "HTTP_PROXY=http://localhost:3128</b><br /> you need "
 137                            "to enter <b>HTTP_PROXY</b> here instead of the "
 138                            "actual value http://localhost:3128.</qt>");
 139
 140     KMessageBox::detailedSorry( this, msg, details,
 141                                 i18n("Invalid Proxy Setup") );
 142   }
 143   else
 144   {
 145     KMessageBox::information( this, i18n("Successfully verified."),
 146                                     i18n("Proxy Setup") );
 147   }
 148 }
 149
 150 void KEnvVarProxyDlg::autoDetectPressed()
 151 {
 152   QString env;
 153   QStringList::ConstIterator it;
 154
 155   bool found = false;
 156
 157   setHighLight (mDlg->lbHttp, false);
 158   setHighLight (mDlg->lbHttps, false);
 159   setHighLight (mDlg->lbFtp, false);
 160
 161   // Detect HTTP proxy settings...
 162   QStringList list = QString::fromLatin1(ENV_HTTP_PROXY).split( ',', QString::SkipEmptyParts );
 163   for( it = list.constBegin(); it != list.constEnd(); ++it )
 164   {
 165     env = QString::fromLocal8Bit( getenv( (*it).toLocal8Bit() ) );
 166     if ( !env.isEmpty() )
 167     {
 168       mEnvVarsMap ["http"].name = *it;
 169       mEnvVarsMap ["http"].value = env;
 170       mDlg->leHttp->setText( (mDlg->cbShowValue->isChecked() ? env : *it) );
 171       found = true;
 172       break;
 173     }
 174   }
 175
 176   // Detect HTTPS proxy settings...
 177   list = QString::fromLatin1(ENV_HTTPS_PROXY).split( ',', QString::SkipEmptyParts );
 178   for( it = list.constBegin(); it != list.constEnd(); ++it )
 179   {
 180     env = QString::fromLocal8Bit( getenv( (*it).toLocal8Bit() ) );
 181     if ( !env.isEmpty() )
 182     {
 183       mEnvVarsMap ["https"].name = *it;
 184       mEnvVarsMap ["https"].value = env;
 185       mDlg->leHttps->setText( (mDlg->cbShowValue->isChecked() ? env : *it) );
 186       found = true;
 187       break;
 188     }
 189   }
 190
 191   // Detect FTP proxy settings...
 192   list = QString::fromLatin1(ENV_FTP_PROXY).split( ',', QString::SkipEmptyParts );
 193   for(it = list.constBegin(); it != list.constEnd(); ++it )
 194   {
 195     env = QString::fromLocal8Bit( getenv( (*it).toLocal8Bit() ) );
 196     if ( !env.isEmpty() )
 197     {
 198       mEnvVarsMap ["ftp"].name = *it;
 199       mEnvVarsMap ["ftp"].value = env;
 200       mDlg->leFtp->setText( (mDlg->cbShowValue->isChecked() ? env : *it) );
 201       found = true;
 202       break;
 203     }
 204   }
 205
 206   // Detect the NO_PROXY settings...
 207   list = QString::fromLatin1(NO_PROXY).split (',', QString::SkipEmptyParts );
 208   for(it = list.constBegin(); it != list.constEnd(); ++it )
 209   {
 210     env = QString::fromLocal8Bit( getenv( (*it).toLocal8Bit() ) );
 211     if ( !env.isEmpty() )
 212     {
 213       mEnvVarsMap ["noProxy"].name = *it;
 214       mEnvVarsMap ["noProxy"].value = env;
 215       mDlg->leNoProxy->setText( (mDlg->cbShowValue->isChecked() ? env : *it) );
 216       break;
 217     }
 218   }
 219
 220   if ( !found )
 221   {
 222     QString msg = i18n("Did not detect any environment variables "
 223                        "commonly used to set system wide proxy "
 224                        "information.");
 225
 226     QString details = i18n("<qt>To learn about the variable names the "
 227                            "automatic detection process searches for, "
 228                            "press OK, click on the quick help button "
 229                            "on the window title bar of the "
 230                            "previous dialog and then click on the "
 231                            "\"<b>Auto Detect</b>\" button.</qt>");
 232
 233     KMessageBox::detailedSorry( this, msg, details,
 234                                 i18n("Automatic Proxy Variable Detection") );
 235   }
 236 }
 237
 238 void KEnvVarProxyDlg::showValue()
 239 {
 240   bool enable = mDlg->cbShowValue->isChecked();
 241
 242   mDlg->leHttp->setReadOnly (enable);
 243   mDlg->leHttps->setReadOnly (enable);
 244   mDlg->leFtp->setReadOnly (enable);
 245   mDlg->leNoProxy->setReadOnly (enable);
 246
 247   if (enable)
 248   {
 249     mDlg->leHttp->setText( mEnvVarsMap["http"].value );
 250     mDlg->leHttps->setText( mEnvVarsMap["https"].value );
 251     mDlg->leFtp->setText( mEnvVarsMap["ftp"].value );
 252     mDlg->leNoProxy->setText( mEnvVarsMap["noProxy"].value );
 253   }
 254   else
 255   {
 256     mDlg->leHttp->setText( mEnvVarsMap["http"].name );
 257     mDlg->leHttps->setText( mEnvVarsMap["https"].name );
 258     mDlg->leFtp->setText( mEnvVarsMap["ftp"].name );
 259     mDlg->leNoProxy->setText( mEnvVarsMap["noProxy"].name );
 260   }
 261 }
 262
 263 bool KEnvVarProxyDlg::validate()
 264 {
 265   int count = 0;
 266
 267   QString value = mEnvVarsMap["http"].value;
 268   if ( !value.isEmpty() )
 269     count++;
 270
 271   value = mEnvVarsMap["https"].value;
 272   if ( !value.isEmpty() )
 273     count++;
 274
 275   value = mEnvVarsMap["ftp"].value;
 276   if ( !value.isEmpty() )
 277     count++;
 278
 279   m_bHasValidData = (count > 0);
 280
 281   return m_bHasValidData;
 282 }
 283
 284 void KEnvVarProxyDlg::accept()
 285 {
 286   if ( !validate() )
 287   {
 288     setHighLight (mDlg->lbHttp, true);
 289     setHighLight (mDlg->lbHttps, true);
 290     setHighLight (mDlg->lbFtp, true);
 291
 292     QString msg = i18n("You must specify at least one valid proxy "
 293                        "environment variable.");
 294
 295     QString details = i18n("<qt>Make sure you entered the actual environment "
 296                            "variable name rather than its value. For "
 297                            "example, if the environment variable is <br /><b>"
 298                            "HTTP_PROXY=http://localhost:3128</b><br /> you need "
 299                            "to enter <b>HTTP_PROXY</b> here instead of the "
 300                            "actual value http://localhost:3128.</qt>");
 301
 302     KMessageBox::detailedError( this, msg, details,
 303                                  i18n("Invalid Proxy Setup") );
 304     return;
 305   }
 306
 307   KDialog::accept();
 308 }
 309
 310 #include "kenvvarproxydlg.moc"