Changeset 2977

Timestamp:

08/16/08 21:28:25 (3 months ago)

Author:

edmanm

Message:

Create CircuitId? and StreamId? typedefs with QString as their underlying type,
and switch all circuit and stream function calls to use these new types. Fixes
ticket #400.

Location:

vidalia/trunk/src

Files:

• torcontrol/circuit.cpp (modified) (5 diffs)
• torcontrol/circuit.h (modified) (4 diffs)
• torcontrol/circuitevent.h (modified) (2 diffs)
• torcontrol/stream.cpp (modified) (6 diffs)
• torcontrol/stream.h (modified) (4 diffs)
• torcontrol/streamevent.h (modified) (1 diff)
• torcontrol/torcontrol.cpp (modified) (3 diffs)
• torcontrol/torcontrol.h (modified) (1 diff)
• vidalia/network/circuititem.cpp (modified) (1 diff)
• vidalia/network/circuititem.h (modified) (1 diff)
• vidalia/network/circuitlistwidget.cpp (modified) (2 diffs)
• vidalia/network/circuitlistwidget.h (modified) (2 diffs)
• vidalia/network/netviewer.cpp (modified) (5 diffs)
• vidalia/network/netviewer.h (modified) (2 diffs)
• vidalia/network/streamitem.h (modified) (1 diff)
• vidalia/network/tormapwidget.cpp (modified) (11 diffs)
• vidalia/network/tormapwidget.h (modified) (5 diffs)

vidalia/trunk/src/torcontrol/circuit.cpp

@@ -18 +18 @@
 #include <QRegExp>
 
+#include "tcglobal.h"
 #include "circuit.h"
 
@@ -24 +25 @@
 Circuit::Circuit()
 {
-  _circId  = 0;
   _status  = Unknown;
   _isValid = false;
@@ -39 +39 @@
 Circuit::Circuit(const QString &circuit)
 {
-  _isValid = false;
-
-  QStringList parts = circuit.split(" ");
+  QStringList parts = circuit.split(" ", QString::SkipEmptyParts);
   if (parts.size() >= 2) {
     /* Get the circuit ID */
-    _circId = (quint64)parts.at(0).toULongLong();
+    _circId = parts.at(0);
+    if (! isValidCircuitId(_circId))
+      goto err;
+
     /* Get the circuit status value */
     _status = Circuit::toStatus(parts.at(1));
@@ -53 +54 @@
         QStringList parts = hop.split(QRegExp("[=~]"));
         if (parts.size() != 2)
-          return;
+          goto err;
 
         _ids   << parts.at(0).mid(1);
@@ -62 +63 @@
     _isValid = true;
   }
+  return;
+  
+err:
+  tc::warn("Improperly formatted circuit: '%1'").arg(circuit);
+  _isValid = false;
+}
+
+/** Returns true iff <b>circId</b> consists of only between 1 and 16
+ * (inclusive) ASCII-encoded letters and numbers. */
+bool
+Circuit::isValidCircuitId(const CircuitId &circId)
+{
+  int length = circId.length();
+  if (length < 1 || length > 16)
+    return false;
+
+  for (int i = 0; i < length; i++) {
+    char c = circId[i].toAscii();
+    if (c < '0' && c > '9' && c < 'A' && c > 'Z' && c < 'a' && c > 'z')
+      return false;
+  }
+  return true;
 }
 

vidalia/trunk/src/torcontrol/circuit.h

@@ -21 +21 @@
 #include <QStringList>
 
+/** Circuit IDs contains 1-16 alphanumeric ASCII characters. */
+typedef QString CircuitId;
+
 
 class Circuit
@@ -40 +43 @@
   Circuit();
   /** Constructor. */  
-  Circuit(const QString &circuit);
+  Circuit(const CircuitId &circuit);
   
   /** Returns true if this circuit is valid. */
@@ -46 +49 @@
   
   /** Returns the ID for this circuit */
-  quint64 id() const { return _circId; }
+  CircuitId id() const { return _circId; }
   /** Returns the status of this circuit */
   Status status() const { return _status; }
@@ -61 +64 @@
   static Status toStatus(const QString &strStatus);
 
+  /** Returns true iff <b>circId</b> consists of only between 1 and 16
+   * (inclusive) ASCII-encoded letters and numbers. */
+  static bool isValidCircuitId(const CircuitId &circId);
+
 private:
-  quint64 _circId; /**< Circuit ID. */
+  CircuitId _circId; /**< Circuit ID. */
   Status _status;  /**< Circuit status. */
   QStringList _names;  /**< Nicknames of the routers in the circuit. */

vidalia/trunk/src/torcontrol/circuitevent.h

@@ -19 +19 @@
 
 #include <QEvent>
+#include <QString>
 
 #include "eventtype.h"
@@ -35 +36 @@
   Circuit circuit() const { return _circuit; }
   /** Returns the ID for this circuit event. */
-  quint64 id() const { return _circuit.id(); }
+  CircuitId id() const { return _circuit.id(); }
   /** Returns the status of this circuit event. */
   Circuit::Status status() const { return _circuit.status(); }

vidalia/trunk/src/torcontrol/stream.cpp

@@ -16 +16 @@
 
 #include <QStringList>
- 
+
+#include "circuit.h" 
 #include "stream.h"
 
@@ -23 +24 @@
 Stream::Stream()
 {
-  _streamId  = 0;
   _status    = Unknown;
-  _circuitId = 0;
   _port      = 0;
 }
 
 /** Constructor */
-Stream::Stream(quint64 streamId, Status status, quint64 circuitId, 
-               QString address, quint16 port)
+Stream::Stream(const StreamId &streamId, Status status,
+               const CircuitId &circuitId, const QString &address,
+               quint16 port)
 {
   _streamId  = streamId;
@@ -41 +41 @@
 
 /** Constructor */
-Stream::Stream(quint64 streamId, Status status, quint64 circuitId, QString target)
+Stream::Stream(const StreamId &streamId, Status status,
+               const CircuitId &circuitId, const QString &target)
 {
   _streamId  = streamId;
@@ -61 +62 @@
  */
 Stream
-Stream::fromString(QString stream)
+Stream::fromString(const QString &stream)
 {
-  QStringList parts = stream.split(" ");
+  QStringList parts = stream.split(" ", QString::SkipEmptyParts);
   if (parts.size() >= 4) { 
     /* Get the stream ID */
-    quint64 streamId = (quint64)parts.at(0).toULongLong();
+    StreamId streamId = parts.at(0);
     /* Get the stream status value */
     Stream::Status status = Stream::toStatus(parts.at(1));
     /* Get the ID of the circuit on which this stream travels */
-    quint64 circId = (quint64)parts.at(2).toULongLong();
+    CircuitId circId = parts.at(2);
     /* Get the target address for this stream */
     QString target = parts.at(3);
@@ -79 +80 @@
 }
 
+/** Returns true iff <b>streamId</b> consists of only between 1 and 16
+ * (inclusive) ASCII-encoded letters and numbers. */
+bool
+Stream::isValidStreamId(const StreamId &streamId)
+{
+  int length = streamId.length();
+  if (length < 1 || length > 16)
+    return false;
+
+  for (int i = 0; i < length; i++) {
+    char c = streamId[i].toAscii();
+    if (c < '0' && c > '9' && c < 'A' && c > 'Z' && c < 'a' && c > 'z')
+      return false;
+  }
+  return true;
+}
+
 /** Converts a string description of a stream's status to its enum value */
 Stream::Status
-Stream::toStatus(QString strStatus)
+Stream::toStatus(const QString &strStatus)
 {
-  Status status;
-  strStatus = strStatus.toUpper();
-  if (strStatus == "NEW") {
-    status = New;
-  } else if (strStatus == "NEWRESOLVE") {
-    status = NewResolve;
-  } else if (strStatus == "SENTCONNECT") {
-    status = SentConnect;
-  } else if (strStatus == "SENTRESOLVE") {
-    status = SentResolve;
-  } else if (strStatus == "SUCCEEDED") {
-    status = Succeeded;
-  } else if (strStatus == "FAILED") {
-    status = Failed;
-  } else if (strStatus == "CLOSED") {
-    status = Closed;
-  } else if (strStatus == "DETACHED") {
-    status = Detached; 
-  } else if (strStatus == "REMAP") {
-    status = Remap;
-  } else {
-    status = Unknown;
-  }
-  return status;
+  if (!strStatus.compare("NEW", Qt::CaseInsensitive))
+    return New;
+  if (!strStatus.compare("NEWRESOLVE", Qt::CaseInsensitive))
+    return NewResolve;
+  if (!strStatus.compare("SENTCONNECT", Qt::CaseInsensitive))
+    return SentConnect;
+  if (!strStatus.compare("SENTRESOLVE", Qt::CaseInsensitive))
+    return SentResolve;
+  if (!strStatus.compare("SUCCEEDED", Qt::CaseInsensitive))
+    return Succeeded;
+  if (!strStatus.compare("FAILED", Qt::CaseInsensitive))
+    return Failed;
+  if (!strStatus.compare("CLOSED", Qt::CaseInsensitive))
+    return Closed;
+  if (!strStatus.compare("DETACHED", Qt::CaseInsensitive))
+    return Detached;
+  if (!strStatus.compare("REMAP", Qt::CaseInsensitive))
+    return Remap;
+  return Unknown;
 }
 
@@ -130 +143 @@
 }
 
-/** Returns true if all fields in this Stream object are empty. */
+/** Returns true if all fields in this Stream object are valid. */
 bool
-Stream::isEmpty() const
+Stream::isValid() const
 {
-  return (!_streamId && !_circuitId && 
-          (_status == Unknown) && _address.isEmpty() && !_port);
+  return (isValidStreamId(_streamId)
+            && Circuit::isValidCircuitId(_circuitId)
+            && (_status != Unknown) 
+            && !_address.isEmpty());
 }
 

vidalia/trunk/src/torcontrol/stream.h

@@ -23 +23 @@
 #include <QList>
 
+#include "circuit.h"
+
+/** Stream IDs contains 1-16 alphanumeric ASCII characters. */
+typedef QString StreamId;
+
 
 class Stream
@@ -46 +51 @@
   Stream();
   /** Constructor */
-  Stream(quint64 streamId, Status status, quint64 circuitId, QString target);
+  Stream(const StreamId &streamId, Status status, const CircuitId &circuitId,
+         const QString &target);
   /** Constructor */
-  Stream(quint64 streamId, Status status, quint64 circuitId,
-         QString address, quint16 port);
+  Stream(const StreamId &streamId, Status status, const CircuitId &circuitId,
+         const QString &address, quint16 port);
 
   /** Parses the given string for a stream, in Tor control protocol format. */
-  static Stream fromString(QString stream);
+  static Stream fromString(const QString &stream);
   /** Converts a string description of a stream's status to its enum value */
-  static Status toStatus(QString strStatus);
+  static Status toStatus(const QString &strStatus);
 
-  /** Returns true if the Stream object's fields are all empty. */
-  bool isEmpty() const;
+  /** Returns true iff the Stream object's fields are all valid. */
+  bool isValid() const;
   
   /** Returns the ID for this stream. */
-  quint64 id() const { return _streamId; }
+  StreamId id() const { return _streamId; }
   /** Returns the status for this stream. */
   Status status() const { return _status; }
@@ -66 +72 @@
   QString statusString() const;
   /** Returns the ID of the circuit to which this stream is assigned. */
-  quint64 circuitId() const { return _circuitId; }
+  CircuitId circuitId() const { return _circuitId; }
   /** Returns the target address and port for this stream. */
   QString target() const { return (_address + ":" + QString::number(_port)); }
@@ -74 +80 @@
   quint16 targetPort() const { return _port; }
 
+  /** Returns true iff <b>streamId</b> consists of only between 1 and 16
+   * (inclusive) ASCII-encoded letters and numbers. */
+   static bool isValidStreamId(const StreamId &streamId);
+
 private:
-  quint64 _streamId;   /**< Unique ID associated with this stream. */
+  StreamId _streamId;   /**< Unique ID associated with this stream. */
+  CircuitId _circuitId; /**< ID of the circuit carrying this stream. */
+  QString _address;    /**< Stream target address. */
   Status  _status;     /**< Stream status value. */
-  quint64 _circuitId;  /**< ID of the circuit carrying this stream. */
-  QString _address;    /**< Stream target address. */
   quint16 _port;       /**< Stream target port. */
 };

vidalia/trunk/src/torcontrol/streamevent.h

@@ -35 +35 @@
   Stream stream() const { return _stream; }
   /** Returns the ID for this stream event. */
-  quint64 id() const { return _stream.id(); }
+  StreamId id() const { return _stream.id(); }
   /** Returns the status for this stream event. */
   Stream::Status status() const { return _stream.status(); }
   /** Returns the ID of the circuit to which this stream is assigned */
-  quint64 circuitId() const { return _stream.circuitId(); }
+  CircuitId circuitId() const { return _stream.circuitId(); }
   /** Returns the target for this stream event. */
   QString target() const { return _stream.target(); }

vidalia/trunk/src/torcontrol/torcontrol.cpp

@@ -975 +975 @@
 }
 
-/** Closes the circuit specified by <b>circid</b>. If <b>ifUnused</b> is
+/** Closes the circuit specified by <b>circId</b>. If <b>ifUnused</b> is
  * true, then the circuit will not be closed unless it is unused. */
 bool
-TorControl::closeCircuit(quint64 circid, bool ifUnused, QString *errmsg)
-{
-  ControlCommand cmd("CLOSECIRCUIT", QString::number(circid));
+TorControl::closeCircuit(const CircuitId &circId, bool ifUnused, QString *errmsg)
+{
+  ControlCommand cmd("CLOSECIRCUIT", circId);
   if (ifUnused) {
     cmd.addArgument("IfUnused");
@@ -1000 +1000 @@
     QString msg = reply.getMessage();
     s = Stream::fromString(msg.mid(msg.indexOf("=")+1));
-    if (!s.isEmpty()) {
+    if (s.isValid())
       streams << s;
-    }
     
-    /* The rest of the streams jsut come as data, one per line */
+    /* The rest of the streams just come as data, one per line */
     foreach (QString line, reply.getData()) {
       s = Stream::fromString(line);
-      if (!s.isEmpty()) {
+      if (s.isValid())
         streams << s;
-      }
     }
   }
@@ -1015 +1013 @@
 }
 
-/** Closes the stream specified by <b>streamid</b>. */
-bool
-TorControl::closeStream(quint64 streamid, QString *errmsg)
-{
-  ControlCommand cmd("CLOSESTREAM", QString::number(streamid));
+/** Closes the stream specified by <b>streamId</b>. */
+bool
+TorControl::closeStream(const StreamId &streamId, QString *errmsg)
+{
+  ControlCommand cmd("CLOSESTREAM", streamId);
   cmd.addArgument("1"); /* 1 == REASON_MISC (tor-spec.txt) */
   return send(cmd, errmsg);

vidalia/trunk/src/torcontrol/torcontrol.h

@@ -197 +197 @@
 
 public slots:
-  /** Closes the circuit specified by <b>circid</b>. If <b>ifUnused</b> is
+  /** Closes the circuit specified by <b>circId</b>. If <b>ifUnused</b> is
    * true, then the circuit will not be closed unless it is unused. */
-  bool closeCircuit(quint64 circid, bool ifUnused = false, QString *errmsg = 0);
-  /** Closes the stream specified by <b>streamid</b>. */
-  bool closeStream(quint64 streamid, QString *errmsg = 0);
+  bool closeCircuit(const CircuitId &circId, bool ifUnused = false,
+                    QString *errmsg = 0);
+  /** Closes the stream specified by <b>streamId</b>. */
+  bool closeStream(const StreamId &streamId, QString *errmsg = 0);
 
 signals:

vidalia/trunk/src/vidalia/network/circuititem.cpp

@@ -65 +65 @@
 /** Returns a list of all stream items on this circuit. */
 QList<StreamItem *>
-CircuitItem::streams()
+CircuitItem::streams() const
 {
   QList<StreamItem *> streams;

vidalia/trunk/src/vidalia/network/circuititem.h

@@ -41 +41 @@
   void update(const Circuit &circuit);
   /** Returns the ID for this circuit. */
-  quint64 id() { return _circuit.id(); }
+  CircuitId id() const { return _circuit.id(); }
   /** Returns the Circuit object for this item. */
-  Circuit circuit() { return _circuit; }
+  Circuit circuit() const { return _circuit; }
   /** Returns a list of all stream items on this circuit. */
-  QList<StreamItem *> streams();
+  QList<StreamItem *> streams() const;
   
 private:

vidalia/trunk/src/vidalia/network/circuitlistwidget.cpp

@@ -272 +272 @@
  * circuit's item in the list. */
 CircuitItem*
-CircuitListWidget::findCircuitItem(quint64 circid)
+CircuitListWidget::findCircuitItem(const CircuitId &circid)
 {
   int numCircs = topLevelItemCount();
@@ -287 +287 @@
  * item in the list. */
 StreamItem*
-CircuitListWidget::findStreamItem(quint64 streamid)
+CircuitListWidget::findStreamItem(const StreamId &streamid)
 {
   int numCircs = topLevelItemCount();

vidalia/trunk/src/vidalia/network/circuitlistwidget.h

@@ -55 +55 @@
   void circuitSelected(Circuit circuit);
   /** Emitted when a circuit is removed from the list. */
-  void circuitRemoved(quint64 circid);
+  void circuitRemoved(CircuitId circid);
   /** Emitted when the user selects a circuit to be closed. */
-  void closeCircuit(quint64 circid);
+  void closeCircuit(CircuitId circid);
   /** Emitted when the user selects a stream to be closed. */
-  void closeStream(quint64 streamid);
+  void closeStream(StreamId streamid);
   /** Emitted when the user selects a circuit to zoom to. */
-  void zoomToCircuit(quint64 circid);
+  void zoomToCircuit(CircuitId circid);
   
 public slots:
@@ -87 +87 @@
   void removeStream(StreamItem *stream);
   /** Finds the circuit with the given ID. */
-  CircuitItem* findCircuitItem(quint64 circid);
+  CircuitItem* findCircuitItem(const CircuitId &circid);
   /** Finds the stream with the given ID. */
-  StreamItem* findStreamItem(quint64 streamid);
+  StreamItem* findStreamItem(const StreamId &streamid);
   /** Schedules the given circuit item to be removed after the given timeout. */
   void scheduleCircuitRemoval(CircuitItem *circuit, int delay);

vidalia/trunk/src/vidalia/network/netviewer.cpp

@@ -96 +96 @@
   connect(ui.treeCircuitList, SIGNAL(circuitSelected(Circuit)),
           this, SLOT(circuitSelected(Circuit)));
-  connect(ui.treeCircuitList, SIGNAL(circuitRemoved(quint64)),
-          _map, SLOT(removeCircuit(quint64)));
-  connect(ui.treeCircuitList, SIGNAL(zoomToCircuit(quint64)),
-          _map, SLOT(zoomToCircuit(quint64)));
-  connect(ui.treeCircuitList, SIGNAL(closeCircuit(quint64)),
-          _torControl, SLOT(closeCircuit(quint64)));
-  connect(ui.treeCircuitList, SIGNAL(closeStream(quint64)),
-          _torControl, SLOT(closeStream(quint64)));
+  connect(ui.treeCircuitList, SIGNAL(circuitRemoved(CircuitId)),
+          _map, SLOT(removeCircuit(CircuitId)));
+  connect(ui.treeCircuitList, SIGNAL(zoomToCircuit(CircuitId)),
+          _map, SLOT(zoomToCircuit(CircuitId)));
+  connect(ui.treeCircuitList, SIGNAL(closeCircuit(CircuitId)),
+          _torControl, SLOT(closeCircuit(CircuitId)));
+  connect(ui.treeCircuitList, SIGNAL(closeStream(StreamId)),
+          _torControl, SLOT(closeStream(StreamId)));
 
   /* Respond to changes in the status of the control connection */
@@ -331 +331 @@
 /** Adds an IP address to the resolve queue and updates the queue timers. */
 void
-NetViewer::addToResolveQueue(QHostAddress ip, QString id)
+NetViewer::addToResolveQueue(const QHostAddress &ip, const QString &id)
 {
   QString ipstr = ip.toString();
@@ -359 +359 @@
  * list. */
 void
-NetViewer::circuitSelected(Circuit circuit)
+NetViewer::circuitSelected(const Circuit &circuit)
 {
   /* Clear any selected items. */
@@ -383 +383 @@
 /** Called when the user selects a router from the router list. */
 void
-NetViewer::routerSelected(RouterDescriptor router)
+NetViewer::routerSelected(const RouterDescriptor &router)
 {
   _map->deselectAll();
@@ -415 +415 @@
 /** Called when a list of GeoIp information has been resolved. */
 void
-NetViewer::resolved(int id, QList<GeoIp> geoips)
+NetViewer::resolved(int id, const QList<GeoIp> &geoips)
 {
   Q_UNUSED(id);

vidalia/trunk/src/vidalia/network/netviewer.h

@@ -62 +62 @@
   void refresh();
   /** Called when the user selects a circuit on the circuit list */
-  void circuitSelected(Circuit circuit);
+  void circuitSelected(const Circuit &circuit);
   /** Called when an IP has been resolved to geographic information. */
-  void resolved(int id, QList<GeoIp> geoips);
+  void resolved(int id, const QList<GeoIp> &geoips);
   /** Called when the user selects a router in the list. */
-  void routerSelected(RouterDescriptor router);
+  void routerSelected(const RouterDescriptor &router);
   /** Handles when we get connected to Tor network */
   void onAuthenticated();
@@ -76 +76 @@
 private:
   /** Adds an IP address to the resolve queue and updates the queue timers. */
-  void addToResolveQueue(QHostAddress ip, QString id);
+  void addToResolveQueue(const QHostAddress &ip, const QString &id);
   /** Retrieves a list of all running routers from Tor and their descriptors,
    * and adds them to the RouterListWidget. */

vidalia/trunk/src/vidalia/network/streamitem.h

@@ -31 +31 @@
   void update(const Stream &stream);
   /** Returns the ID of the stream associated with this tree item. */
-  quint64 id() const { return _id; }
+  StreamId id() const { return _id; }
   
 private:
-  quint64 _id; /**< ID for this stream. */
+  StreamId _id; /**< ID for this stream. */
 };