kppp/pppdata.h

   1 /* -*- C++ -*-
   2  *
   3  *            kPPP: A pppd front end for the KDE project
   4  *
   5  * $Id$
   6  *
   7  *            Copyright (C) 1997 Bernd Johannes Wuebben
   8  *                   wuebben@math.cornell.edu
   9  *
  10  * based on EzPPP:
  11  * Copyright (C) 1997  Jay Painter
  12  *
  13  * This program is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU Library General Public
  15  * License as published by the Free Software Foundation; either
  16  * version 2 of the License, or (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21  * Library General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU Library General Public
  24  * License along with this program; if not, write to the Free
  25  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  26  */
  27
  28 #ifndef _PPPDATA_H_
  29 #define _PPPDATA_H_
  30
  31 #include <unistd.h>
  32 #include <sys/types.h>
  33
  34 #include <qstring.h>
  35 #include <qstringlist.h>
  36 #include <qcolor.h>
  37 #include <ksharedconfig.h>
  38
  39 #include "kpppconfig.h"
  40
  41
  42 // string lengths
  43
  44 #define PATH_SIZE 120
  45 #define MODEMSTR_SIZE 80
  46 #define ACCNAME_SIZE 50
  47 #define PHONENUMBER_SIZE 60
  48 #define COMMAND_SIZE 255
  49 #define IPADDR_SIZE 15
  50 #define DOMAIN_SIZE 50
  51 #define TIMEOUT_SIZE 60
  52
  53 //
  54 // keys for config file
  55 //
  56
  57 // groups
  58 #define GENERAL_GRP        "General"
  59 #define MODEM_GRP          "Modem"
  60 #define ACCOUNT_GRP        "Account"
  61 #define GRAPH_GRP          "Graph"
  62 #define WINPOS_GRP         "WindowPosition"
  63
  64 // general
  65 #define DEFAULTACCOUNT_KEY "DefaultAccount"
  66 #define DEFAULTMODEM_KEY   "DefaultModem"
  67 #define PPPDVERSION_KEY    "pppdVersion"
  68 #define PPPDTIMEOUT_KEY    "pppdTimeout"
  69 #define SHOWCLOCK_KEY      "ShowClock"
  70 #define SHOWLOGWIN_KEY     "ShowLogWindow"
  71 #define AUTOREDIAL_KEY     "AutomaticRedial"
  72 #define DISCONNECT_KEY     "DisconnectOnXServerExit"
  73 #define QUITONDISCONNECT_KEY "QuitOnDisconnect"
  74 #define NUMACCOUNTS_KEY    "NumberOfAccounts"
  75 #define NUMMODEMS_KEY      "NumberOfModems"
  76 #define REDIALONNOCARR_KEY "RedialOnNoCarrier"
  77 #define ID_KEY             "ID"
  78
  79 // modem
  80 #define MOD_NAME_KEY       "Name"
  81 #define MODEMDEV_KEY       "Device"
  82 #define LOCKFILE_KEY       "UseLockFile"
  83 #define FLOWCONTROL_KEY    "FlowControl"
  84 #define SPEED_KEY          "Speed"
  85 #define TIMEOUT_KEY        "Timeout"
  86 #define TONEDURATION_KEY   "ToneDuration"
  87 #define BUSYWAIT_KEY       "BusyWait"
  88 #define INITSTR_KEY        "InitString"
  89 #define INITRESP_KEY       "InitResponse"
  90 #define PREINITDELAY_KEY   "PreInitDelay"
  91 #define INITDELAY_KEY      "InitDelay"
  92 #define NODTDETECT_KEY     "NoDialToneDetection"
  93 #define DIALTONEWAIT_KEY   "WaitForDialTone"
  94 #define DIALSTR_KEY        "DialString"
  95 #define CONNECTRESP_KEY    "ConnectResponse"
  96 #define BUSYRESP_KEY       "BusyResponse"
  97 #define NOCARRIERRESP_KEY  "NoCarrierResponse"
  98 #define NODIALTONERESP_KEY "NoDialToneResp"
  99 #define HANGUPSTR_KEY      "HangupString"
 100 #define HANGUPRESP_KEY     "HangUpResponse"
 101 #define DLPRESP_KEY        "DLPResponse"
 102 #define ANSWERSTR_KEY      "AnswerString"
 103 #define RINGRESP_KEY       "RingResponse"
 104 #define ANSWERRESP_KEY     "AnswerResponse"
 105 #define ENTER_KEY          "Enter"
 106 #define ESCAPESTR_KEY      "EscapeString"
 107 #define ESCAPERESP_KEY     "EscapeResponse"
 108 #define ESCAPEGUARDTIME_KEY "EscapeGuardTime"
 109 #define USECDLINE_KEY      "UseCDLine"
 110 #define VOLUME_HIGH        "VolumeHigh"
 111 #define VOLUME_MEDIUM      "VolumeMedium"
 112 #define VOLUME_OFF         "VolumeOff"
 113 #define VOLUME_KEY         "Volume"
 114
 115 // account
 116 #define ACC_NAME_KEY       "Name"
 117 #define PHONENUMBER_KEY    "Phonenumber"
 118 #define DIAL_PREFIX_KEY    "DialPrefix"
 119 #define AUTH_KEY           "Authentication"
 120 #define STORED_PASSWORD_KEY "Password"
 121 #define STORED_USERNAME_KEY "Username"
 122 #define STORE_PASSWORD_KEY "StorePassword"
 123 #define CALLBACK_TYPE_KEY  "CallbackType"
 124 #define CALLBACK_PHONE_KEY "CallbackPhone"
 125 #define BEFORE_CONNECT_KEY  "BeforeConnect"
 126 #define COMMAND_KEY        "Command"
 127 #define DISCONNECT_COMMAND_KEY "DisconnectCommand"
 128 #define BEFORE_DISCONNECT_KEY  "BeforeDisconnect"
 129 #define IPADDR_KEY         "IPAddr"
 130 #define SUBNETMASK_KEY     "SubnetMask"
 131 #define ACCTENABLED_KEY    "AccountingEnabled"
 132 #define VOLACCTENABLED_KEY "VolumeAccountingEnabled"
 133 #define ACCTFILE_KEY       "AccountingFile"
 134 #define AUTONAME_KEY       "AutoName"
 135 #define GATEWAY_KEY        "Gateway"
 136 #define DEFAULTROUTE_KEY   "DefaultRoute"
 137 #define DOMAIN_KEY         "Domain"
 138 #define DNS_KEY            "DNS"
 139 #define AUTODNS_KEY        "AutoDNS"
 140 #define EXDNSDISABLED_KEY  "ExDNSDisabled"
 141 #define SCRIPTCOM_KEY      "ScriptCommands"
 142 #define SCRIPTARG_KEY      "ScriptArguments"
 143 #define PPPDARG_KEY        "pppdArguments"
 144 #define PPP_DEBUG_OPTION   "PPPDebug"
 145 #define ICONIFY_ON_CONNECT_KEY "iconifyOnConnect"
 146 #define DOCKING_KEY        "DockIntoPanel"
 147 #define TOTALCOSTS_KEY     "TotalCosts"
 148 #define TOTALBYTES_KEY     "TotalBytes"
 149
 150 // graph colors
 151 #define GENABLED           "Enabled"
 152 #define GCOLOR_BG          "Background"
 153 #define GCOLOR_TEXT        "Text"
 154 #define GCOLOR_IN          "InBytes"
 155 #define GCOLOR_OUT         "OutBytes"
 156
 157 // pppd errors
 158 #define E_IF_TIMEOUT       1
 159 #define E_PPPD_DIED        2
 160 #define E_CBCP_WAIT       14
 161
 162 // window position
 163 #define WINPOS_CONWIN_X    "WindowPositionConWinX"
 164 #define WINPOS_CONWIN_Y    "WindowPositionConWinY"
 165 #define WINPOS_STATWIN_X   "WindowPositionStatWinX"
 166 #define WINPOS_STATWIN_Y   "WindowPositionStatWinY"
 167
 168 class PPPData {
 169 public:
 170   PPPData();
 171   ~PPPData() {}
 172
 173   enum { NumInitStrings = 2 };
 174
 175   // general functions
 176   bool open();
 177   void save();
 178   void cancel();
 179   int  access() const;       // read/write access
 180
 181   // function to read/write date to configuration file
 182   QString readConfig(const QString &, const QString &, const QString &);
 183   int readNumConfig(const QString &, const QString &, int);
 184   bool readListConfig(const QString &, const QString &,
 185                       QStringList &, char sep = ',');
 186   void writeConfig(const QString &, const QString &, const QString &);
 187   void writeConfig(const QString &, const QString &, int);
 188   void writeListConfig(const QString &, const QString &,
 189                        QStringList &, char sep = ',');
 190
 191   // return the current account group
 192   QString currentAccountGroup() { return caccountgroup; }
 193   // return the current modem group
 194   QString currentModemGroup() { return cmodemgroup; }
 195
 196   // functions to set/get general kppp info
 197   QString password() const;
 198   void setPassword(const QString &);
 199
 200   const QString defaultAccount();
 201   void setDefaultAccount(const QString &);
 202
 203         const QString defaultModem();
 204   void setDefaultModem(const QString &);
 205
 206   void set_xserver_exit_disconnect(bool set);
 207   bool get_xserver_exit_disconnect();
 208
 209   void set_redial_on_nocarrier(bool set);
 210   bool get_redial_on_nocarrier();
 211
 212   void setPPPDebug(bool set);
 213   bool getPPPDebug();
 214
 215   void set_quit_on_disconnect(bool);
 216   bool quit_on_disconnect();
 217
 218   void set_show_clock_on_caption(bool set);
 219   bool get_show_clock_on_caption();
 220
 221   void set_show_log_window(bool set);
 222   bool get_show_log_window();
 223
 224   void set_automatic_redial(bool set);
 225   bool automatic_redial();
 226
 227   void set_iconify_on_connect(bool set);
 228   bool get_iconify_on_connect();
 229
 230   void set_dock_into_panel(bool set);
 231   bool get_dock_into_panel();
 232
 233   const QString enter();
 234   void setEnter(const QString &);
 235
 236   QString pppdVersion();
 237   bool pppdVersionMin(int ver, int mod, int patch);
 238
 239   int pppdTimeout();
 240   void setpppdTimeout(int);
 241
 242         // functions to set/get account information
 243   int modemCount() const;
 244   bool setModem(const QString &);
 245   bool setModemByIndex(int);
 246
 247   bool isUniqueModname(const QString &);
 248
 249   bool deleteModem();
 250   bool deleteModem(const QString &);
 251   int newmodem();
 252   int copymodem(int i);
 253
 254   const QString modname();
 255   void setModname(const QString &);
 256
 257
 258   int busyWait();
 259   void setbusyWait(int);
 260
 261   bool modemLockFile();
 262   void setModemLockFile(bool set);
 263
 264   int modemEscapeGuardTime();
 265   void setModemEscapeGuardTime(int i);
 266
 267   void setModemEscapeStr(const QString &);
 268   const QString modemEscapeStr();
 269
 270   void setModemEscapeResp(const QString &);
 271   const QString modemEscapeResp();
 272
 273   const QString modemDevice();
 274   void setModemDevice(const QString &);
 275
 276   QString flowcontrol();
 277   void setFlowcontrol(const QString &);
 278
 279   int modemTimeout();
 280   void setModemTimeout(int);
 281
 282   int modemToneDuration();
 283   void setModemToneDuration(int);
 284
 285   QString volumeInitString();
 286   int volume();
 287   void setVolume(int);
 288
 289   int waitForDialTone();
 290   void setWaitForDialTone(int i);
 291
 292   // modem command strings/responses
 293   const QString modemInitStr(int i);
 294   void setModemInitStr(int i, const QString &);
 295
 296   const QString modemInitResp();
 297   void setModemInitResp(const QString &);
 298
 299   int modemPreInitDelay();
 300   void setModemPreInitDelay(int);
 301
 302   int modemInitDelay();
 303   void setModemInitDelay(int);
 304
 305   QString modemNoDialToneDetectionStr();
 306   void setModemNoDialToneDetectionStr(const QString &);
 307
 308   const QString modemDialStr();
 309   void setModemDialStr(const QString &);
 310
 311   const QString modemConnectResp();
 312   void setModemConnectResp(const QString &);
 313
 314   const QString modemBusyResp();
 315   void setModemBusyResp(const QString &);
 316
 317   const QString modemNoCarrierResp();
 318   void setModemNoCarrierResp(const QString &);
 319
 320   const QString modemNoDialtoneResp();
 321   void setModemNoDialtoneResp(const QString &);
 322
 323   const QString modemHangupStr();
 324   void setModemHangupStr(const QString &);
 325
 326   const QString modemHangupResp();
 327   void setModemHangupResp(const QString &);
 328
 329   QString modemDLPResp();
 330   void setModemDLPResp(const QString &);
 331
 332   const QString modemAnswerStr();
 333   void setModemAnswerStr(const QString &);
 334
 335   const QString modemRingResp();
 336   void setModemRingResp(const QString &);
 337
 338   const QString modemAnswerResp();
 339   void setModemAnswerResp(const QString &);
 340
 341   QString volumeOff();
 342   void setVolumeOff(const QString &);
 343
 344   QString volumeMedium();
 345   void setVolumeMedium(const QString &);
 346
 347   QString volumeHigh();
 348   void setVolumeHigh(const QString &);
 349
 350 #if 0
 351   void setUseCDLine(const int n);
 352   int  UseCDLine();
 353 #endif
 354
 355   // functions to set/get account information
 356   int accountCount() const;
 357   bool setAccount(const QString &);
 358   bool setAccountByIndex(int);
 359
 360   bool isUniqueAccname(const QString &);
 361
 362   bool deleteAccount();
 363   bool deleteAccount(const QString &);
 364   int newaccount();
 365   int copyaccount(int i);
 366
 367   const QString accname();
 368   void setAccname(const QString &);
 369
 370   QStringList &phonenumbers();
 371   const QString phonenumber();
 372   void setPhonenumber(const QString &);
 373
 374   const QString dialPrefix();
 375   void setDialPrefix(const QString &);
 376
 377   int authMethod();
 378   void setAuthMethod(int);
 379
 380   const QString storedUsername();
 381   void setStoredUsername(const QString &);
 382
 383   const QString storedPassword();
 384   void setStoredPassword(const QString &);
 385
 386   bool storePassword();
 387   void setStorePassword(bool);
 388
 389   int callbackType();
 390   void setCallbackType(int);
 391
 392   QString callbackPhone();
 393   void setCallbackPhone(const QString &);
 394
 395   bool waitCallback();
 396   void setWaitCallback(bool);
 397
 398   const QString speed();
 399   void setSpeed(const QString &);
 400
 401   const QString command_before_connect();
 402   void setCommand_before_connect(const QString &);
 403
 404   const QString command_on_connect();
 405   void setCommand_on_connect(const QString &);
 406
 407   const QString command_on_disconnect();
 408   void setCommand_on_disconnect(const QString &);
 409
 410   const QString command_before_disconnect();
 411   void setCommand_before_disconnect(const QString &);
 412
 413   const QString ipaddr();
 414   void setIpaddr(const QString &);
 415
 416   const QString subnetmask();
 417   void setSubnetmask(const QString &);
 418
 419   bool AcctEnabled();
 420   void setAcctEnabled(bool set);
 421
 422   int VolAcctEnabled();
 423   void setVolAcctEnabled(int set);
 424
 425   bool autoDNS();
 426   void setAutoDNS(bool set);
 427
 428   bool exDNSDisabled();
 429   void setExDNSDisabled(bool set);
 430
 431   bool autoname();
 432   void setAutoname(bool set);
 433
 434   const QString gateway();
 435   void setGateway(const QString &);
 436
 437   bool defaultroute();
 438   void setDefaultroute(bool set);
 439
 440   QStringList &dns();
 441   void setDns(QStringList &);
 442
 443   const QString domain();
 444   void setDomain(const QString &);
 445
 446   QStringList &scriptType();
 447   void setScriptType(QStringList &);
 448
 449   QStringList &script();
 450   void setScript(QStringList &);
 451
 452   QStringList &pppdArgument();
 453   void setpppdArgumentDefaults();
 454   void setpppdArgument(QStringList &);
 455
 456   //functions to change/set the child pppd process info
 457   bool pppdRunning() const;
 458   void setpppdRunning(bool set);
 459
 460   int pppdError() const;
 461   void setpppdError(int err);
 462
 463   // functions to set/query the accounting info
 464   const QString accountingFile();
 465   void setAccountingFile(const QString &);
 466
 467   const QString totalCosts();
 468   void setTotalCosts(const QString &);
 469
 470   int totalBytes();
 471   void  setTotalBytes(int);
 472
 473   // graphing widget
 474   void setGraphingOptions(bool enabled,
 475                           QColor bg,
 476                           QColor text,
 477                           QColor in,
 478                           QColor out);
 479   void graphingOptions(bool &enabled,
 480                        QColor &bg,
 481                        QColor &text,
 482                        QColor &in,
 483                        QColor &out);
 484   bool graphingEnabled();
 485
 486   // window positions
 487   void winPosConWin(int &, int &);
 488   void setWinPosConWin(int, int);
 489   void winPosStatWin(int &, int &);
 490   void setWinPosStatWin(int, int);
 491
 492 private:
 493   QString passwd;
 494   KSharedConfig::Ptr config;                       // configuration object
 495   int accounthighcount;                  // index of highest account
 496   int caccount;                          // index of the current account
 497         int modemhighcount;                    // index of highest modem
 498   int cmodem;                            // index of the current modem
 499   QString cmodemgroup;                   // name of current modem group
 500   QString caccountgroup;                 // name of current account group
 501   pid_t suidprocessid;                   // process ID of setuid child
 502   bool pppdisrunning;                    // pppd process
 503                                          // daemon
 504   int pppderror;                         // error encounterd running pppd
 505   int pppdVer, pppdMod, pppdPatch;       // pppd version
 506   bool waitcallback;                     // callback waiting flag
 507
 508   QStringList phonelist;
 509 };
 510
 511 extern PPPData gpppdata;
 512
 513 #endif