Changeset 90

Timestamp:

01/15/06 17:36:23 (3 years ago)

Author:

edmanm

Message:

Check in a bulk of the asynchronous event handling code. Some work remains.

Location:

trunk/src

Files:

• control/control.pri (modified) (2 diffs)
• control/controlreply.cpp (modified) (1 diff)
• control/controlreply.h (modified) (1 diff)
• control/messagepump.cpp (added)
• control/messagepump.h (added)
• control/torcontrol.cpp (modified) (11 diffs)
• control/torcontrol.h (modified) (8 diffs)
• control/torevents.cpp (added)
• control/torevents.h (added)
• gui/mainwindow.cpp (modified) (4 diffs)

trunk/src/control/control.pri

@@ -27 +27 @@
            $$PWD/controlcommand.h \
            $$PWD/controlreply.h \
-           $$PWD/replyline.h
+           $$PWD/replyline.h \
+           $$PWD/torevents.h \
+           $$PWD/messagepump.h
 
 SOURCES += $$PWD/torcontrol.cpp \
@@ -34 +36 @@
            $$PWD/controlcommand.cpp \
            $$PWD/controlreply.cpp \
-           $$PWD/replyline.cpp
+           $$PWD/replyline.cpp \
+           $$PWD/torevents.cpp \
+           $$PWD/messagepump.cpp

trunk/src/control/controlreply.cpp

@@ -54 +54 @@
 }
 
+/** Returns the status of the first line in the reply */
+QString
+ControlReply::getStatus()
+{
+  return getLine().getStatus();
+}
+

trunk/src/control/controlreply.h

@@ -46 +46 @@
   /** Returns all lines for this reply */
   QList<ReplyLine> getLines();
+
+  /** Returns the status of the first line in the reply */
+  QString getStatus();
   
 private:

trunk/src/control/torcontrol.cpp

@@ -21 +21 @@
  *  Boston, MA  02110-1301, USA.
  ****************************************************************/
-                     
+                   
 #include <QHostAddress>
 
@@ -30 +30 @@
 TorControl::TorControl()
 {
+  /* Construct the message pump and give it a control connection and TorEvents
+   * object, used to translate and dispatch event messages sent by Tor */
+  _messages = new MessagePump(&_controlConn, &_events);
+
+  /* Plumb the signal relays between the TorEvents object and The Outside */
+  QObject::connect(&_events, SIGNAL(bandwidth(quint64, quint64)),
+                   this, SLOT(onBandwidthUpdate(quint64, quit64)),
+                   Qt::DirectConnection);
+  QObject::connect(&_events, SIGNAL(log(TorEvents::LogSeverity, QString)),
+                   this, SLOT(onLogMessage(TorEvents::LogSeverity, QString)),
+                   Qt::DirectConnection);
+  QObject::connect(&_events, SIGNAL(circuit(quint64, TorEvents::CircuitStatus,
+                                            QString)),
+                   this, SLOT(onCircuitStatus(quint64, TorEvents::CircuitStatus,
+                                              QString)),
+                   Qt::DirectConnection);
+  QObject::connect(&_events, SIGNAL(stream(quint64, TorEvents::StreamStatus,
+                                           quint64, QString)),
+                   this, SLOT(onStreamStatus(quint64, TorEvents::StreamStatus,
+                                             quint64, QString)),
+                   Qt::DirectConnection);
+  
   /* Plumb the process signals */
   QObject::connect(&_torProcess, SIGNAL(started()),
@@ -46 +68 @@
 TorControl::~TorControl()
 {
+  if (isConnected()) {
+    disconnect();
+  }
+  if (isRunning()) {
+    stop();
+  }
+  if (_messages) {
+    delete _messages;
+  }
 }
 
@@ -69 +100 @@
 TorControl::stop(QString *errmsg)
 {
+  if (isConnected()) {
+    disconnect();
+  }
   return _torProcess.stop(errmsg);
 }
@@ -92 +126 @@
 {
   VidaliaSettings settings;
-  return _controlConn.connect(settings.getControlAddress(),
-                              settings.getControlPort(), errmsg);
+  if ( _controlConn.connect(settings.getControlAddress(),
+                            settings.getControlPort(), errmsg)
+     ) {
+    _messages->start();
+    return true;
+  }
+  return false;
 }
 
@@ -108 +147 @@
 TorControl::disconnect()
 {
+  _messages->stop();
+  send(ControlCommand("QUIT"), 0);
   _controlConn.disconnect();
 }
@@ -123 +164 @@
 {
   return _controlConn.isValid();
+}
+
+/** Sends a message to Tor and discards the response */
+bool
+TorControl::send(ControlCommand cmd, QString *errmsg)
+{
+  ControlReply reply;
+  return send(cmd, reply, errmsg);
+}
+
+/** Send a message to Tor and read the response */
+bool
+TorControl::send(ControlCommand cmd, ControlReply &reply, QString *errmsg)
+{
+  return _messages->send(cmd, reply, errmsg);
 }
 
@@ -137 +193 @@
   ControlReply reply;
 
-  if (_controlConn.send(cmd, reply, errmsg)) {
+  if (send(cmd, reply, errmsg)) {
     ReplyLine line = reply.getLine();
     if (line.getStatus() != "250") {
@@ -166 +222 @@
  
   /* Ask Tor for the specified info values */
-  if (_controlConn.send(cmd, reply, errmsg)) {
+  if (send(cmd, reply, errmsg)) {
   
     /* Parse the response for the returned values */
@@ -214 +270 @@
   /* Convert the signal to the correct string */
   switch (sig) {
-    case Reload:   sigtype = "RELOAD"; break;
-    case Shutdown: sigtype = "SHUTDOWN"; break;
-    case Dump:     sigtype = "DUMP"; break;
-    case Debug:    sigtype = "DEBUG"; break;
-    case Halt:     sigtype = "HALT"; break;
-    default: return false; break;
+    case SignalReload:   sigtype = "RELOAD"; break;
+    case SignalShutdown: sigtype = "SHUTDOWN"; break;
+    case SignalDump:     sigtype = "DUMP"; break;
+    case SignalDebug:    sigtype = "DEBUG"; break;
+    case SignalHalt:     sigtype = "HALT"; break;
+    default: return false;
   }
   
   /* Send and check the response */
-  if (_controlConn.send(cmd, reply, errmsg)) {
+  if (!send(cmd, reply, errmsg)) {
+    return false;
+  } else {
     ReplyLine line = reply.getLine();
     if (line.getStatus() != "250") {
@@ -246 +304 @@
 }
 
+/** Adds an event to the event list and registers it with Tor. If registration
+ * fails, then the event is NOT added to the event list. */
+bool
+TorControl::addEvent(TorEvents::Event e, QString *errmsg)
+{
+  QString event = TorEvents::toString(e);
+  _eventList << event;
+  if (!registerEvents(errmsg)) {
+    /* Registering the event failed, so remove it from the list */
+    _eventList.removeAt(_eventList.indexOf(event));
+    return false;
+  }
+  return true;
+}
+
+/** Removes an event from the event list and unregisters it from Tor. If
+ * unregistration fails, then the event is NOT removed from the event list. */
+bool
+TorControl::removeEvent(TorEvents::Event e, QString *errmsg)
+{
+  QString event = TorEvents::toString(e);
+  if (_eventList.contains(event)) {
+    _eventList.removeAt(_eventList.indexOf(event));
+    if (!registerEvents(errmsg)) {
+      /* Unregistration failed, so leave it in the list */
+      _eventList << event;
+      return false;
+    }
+  }
+  return true;
+}
+
+/** Register for the events currently in the event list */
+bool
+TorControl::registerEvents(QString *errmsg)
+{
+  ControlCommand cmd("SETEVENTS", _eventList.join(" ")); 
+  ControlReply reply;
+  if (!send(cmd, reply, errmsg)) {
+    return false;
+  } else {
+    ReplyLine line = reply.getLine();
+    if (line.getStatus() != "250") {
+      if (errmsg) {
+        *errmsg = line.getMessage();
+      }
+      return false;
+    }
+  }
+  return true;
+}
+
+/**
+ * The methods below relay the appropriate signals from the TorEvents object.
+ */
+void
+TorControl::onBandwidthUpdate(quint64 bytesIn, quint64 bytesOut)
+{
+  emit bandwidth(bytesIn, bytesOut);
+}
+void
+TorControl::onLogMessage(TorEvents::LogSeverity severity, QString msg)
+{
+  emit log(severity, msg);
+}
+void
+TorControl::onCircuitStatus(quint64 circId, 
+                            TorEvents::CircuitStatus status, QString path)
+{
+  emit circuit(circId, status, path);
+}
+void
+TorControl::onStreamStatus(quint64 streamId, TorEvents::StreamStatus status,
+                           quint64 circId, QString target)
+{
+  emit stream(streamId, status, circId, target);
+}
+

trunk/src/control/torcontrol.h

@@ -30 +30 @@
 #include "controlconnection.h"
 #include "torprocess.h"
+#include "messagepump.h"
+#include "torevents.h"
+
 
 class TorControl : public QObject
@@ -38 +41 @@
   /** Signals that can be sent by the controller */
   enum Signal {
-    Reload,
-    Shutdown,
-    Dump,
-    Debug,
-    Halt
+    SignalReload, SignalShutdown, SignalDump, SignalDebug, SignalHalt
   };
-  
+ 
+
   /** Default constructor */
   TorControl();
-  
   /** Default destructor */
   ~TorControl();
@@ -53 +52 @@
   /** Start the Tor process */
   bool start(QString *errmsg = 0);
-
   /** Stop the Tor process */
   bool stop(QString *errmsg = 0);
-
   /** Detect if the Tor process is running */
   bool isRunning();
@@ -62 +59 @@
   /** Connect to Tor's control socket */
   bool connect(QString *errmsg = 0);
-
   /** Disconnect from Tor's control socket */
   void disconnect();
-
   /** Check if we're connected to Tor's control socket */
   bool isConnected();
@@ -74 +69 @@
   /** Sends a GETINFO message to Tor based on the given keys */
   bool getInfo(QHash<QString,QString> &map, QString *errmsg = 0);
-
   /** Sends a GETINFO message for a single info value to Tor */
   bool getInfo(QString key, QString &val, QString *errmsg = 0);
@@ -84 +78 @@
   QString getTorVersion(QString *errmsg = 0);
 
+  /** Register another event of interest with Tor */
+  bool addEvent(TorEvents::Event e, QString *errmsg = 0);
+  /** Remove a previously registered event */
+  bool removeEvent(TorEvents::Event e, QString *errmsg = 0);
+
 
 signals:
   /** Emitted when the Tor process has started */
   void started();
-  
   /** Emitted when the Tor process has stopped */
   void stopped(int exitCode, QProcess::ExitStatus exitStatus);
-
   /** Emitted when the controller has connected to Tor */
   void connected();
-
   /** Emitted when the controller has disconnected from Tor */
   void disconnected();
+  /** Emitted when a bandwidth update is received from Tor */
+  void bandwidth(quint64 bytesIn, quint64 bytesOut);
+  /** Emitted when a log message is received from Tor */
+  void log(TorEvents::LogSeverity severity, QString msg);
+  /** Emitted when a circuit status event is received from Tor */
+  void circuit(quint64 circId, TorEvents::CircuitStatus status, QString path);
+  /** Emitted when a stream status event is received from Tor */
+  void stream(quint64 streamId, TorEvents::StreamStatus status,
+              quint64 circId, QString target);
 
-
+  
 private:
   /** Instantiates a socket used to connect to Tor's control port */
@@ -104 +109 @@
   /** Manages and monitors the Tor process */
   TorProcess _torProcess;  
+  /** Handles sending and receiving messages from Tor over the control
+   * connection */
+  MessagePump *_messages;
+  /** Dispatches asynchronous events sent by Tor */
+  TorEvents _events;
+  /** Keep track of which events we're interested in */
+  QStringList _eventList;
 
+  /** Register events of interest with Tor */
+  bool registerEvents(QString *errmsg);
+  /** Sends a message to Tor and discards the response */
+  bool send(ControlCommand cmd, QString *errmsg = 0);
+  /** Send a message to Tor and read the response */
+  bool send(ControlCommand cmd, ControlReply &reply, QString *errmsg = 0);
+  
+  
 /* The slots below simply relay signals from the appropriate member objects */
 private slots:
@@ -111 +131 @@
   void onConnected();
   void onDisconnected();
+  void onBandwidthUpdate(quint64 bytesIn, quint64 bytesOut);
+  void onLogMessage(TorEvents::LogSeverity severity, QString msg);
+  void onCircuitStatus(quint64 circId, 
+                       TorEvents::CircuitStatus status, QString path);
+  void onStreamStatus(quint64 streamId, TorEvents::StreamStatus status,
+                      quint64 circId, QString target);
 };
 

trunk/src/gui/mainwindow.cpp

@@ -149 +149 @@
   if (!_torControl->start(&errmsg)) {
     QMessageBox::warning(this, tr("Error Starting Tor"),
-       tr("Vidalia was unable to start Tor.\r\n\r\nError: ") + errmsg,
+       tr("Vidalia was unable to start Tor.\n\nError: ") + errmsg,
        QMessageBox::Ok, QMessageBox::NoButton);
   }
@@ -192 +192 @@
            "\n\nError: ") + errmsg,
         QMessageBox::Ok, QMessageBox::NoButton);
+    } else {
+      if (!_torControl->addEvent(TorEvents::Bandwidth, &errmsg)) {
+      QMessageBox::warning(this, tr("Authentication Error"),
+        tr("Vidalia was unable to authenticate itself to Tor."
+           "Check your authentication information and try again."
+           "\n\nError: ") + errmsg,
+        QMessageBox::Ok, QMessageBox::NoButton);
+      }
     }
   }
@@ -238 +246 @@
     if (!_isIntentionalExit) {
       QMessageBox::warning(this, tr("Tor Crashed"),
-        tr("Vidalia detected that the Tor process crashed.\n"
+        tr("Vidalia detected that the Tor process crashed.\n\n"
             "Please check the message log."),
          QMessageBox::Ok, QMessageBox::NoButton);
@@ -247 +255 @@
      * if this turns out to not be the case. */
     QMessageBox::warning(this, tr("Tor Exited"),
-       tr("Tor exited and returned a non-zero exit code.\n"
+       tr("Tor exited and returned a non-zero exit code.\n\n"
           "Please check the message log."),
        QMessageBox::Ok, QMessageBox::NoButton);