New controller event "clients_seen" to report a geoip-based summary

Changes in version 0.2.1.10-alpha - 2009-??-??

  o Minor bugfixes

Changes in version 0.2.1.10-alpha - 2009-01-??

  o Minor features:

    - New controller event "clients_seen" to report a geoip-based summary

      of which countries we've seen clients from recently. Now controllers

      like Vidalia can show bridge operators that they're actually making

      a difference.

  o Minor bugfixes:

    - Make get_interface_address() function work properly again; stop

      guessing the wrong parts of our address as our address.

      - Figure out a plan for presenting other Tor status warning events.

      - Move Polipo into the main Vidalia -dev bundle.

      - Vidalia displays by-country user summary for bridge operators

R       * Tor sends a status event or something so Vidalia knows what

          to display

        o Tor sends a status event or something so Vidalia knows what

          to display: "clients_seen"

M   - Network scanning and network health

      - Implement some initial automated scans.

       {Controllers may want to warn the user if this event occurs; further

       action is generally not possible.}

     COSENSUS_ARRIVED

     CONSENSUS_ARRIVED

        Tor has received and validated a new consensus networkstatus.

        (This event can be delayed a little while after the consensus

        is received, if Tor needs to fetch certificates.)

  These events apply only to streams entering Tor (such as on a SOCKSPort,

  TransPort, or so on).  They are not generated for exiting streams.

4.1.14. Per-country client stats

  The syntax is:

     "650" SP "CLIENTS_SEEN" SP TimeStarted SP CountrySummary CRLF

  We just generated a new summary of which countries we've seen clients

  from recently. The controller could display this for the user, e.g.

  in their "relay" configuration window, to give them a sense that they

  are actually being useful.

  Currently only bridge relays will receive this event, but once we figure

  out how to sufficiently aggregate and sanitize the client counts on

  main relays, we might start sending these events in other cases too.

  TimeStarted is a quoted string indicating when the reported summary

  counts from (in GMT).

  The CountrySummary keyword has as its argument a comma-separated

  set of "countrycode=count" pairs. For example,

  650-CLIENTS_SEEN TimeStarted="Thu Dec 25 23:50:43 EST 2008"

  650 CountrySummary=us=16,de=8,uk=8

5. Implementation notes

5.1. Authentication

#define EVENT_STATUS_GENERAL   0x0012

#define EVENT_GUARD            0x0013

#define EVENT_STREAM_BANDWIDTH_USED   0x0014

#define _EVENT_MAX             0x0014

#define EVENT_CLIENTS_SEEN     0x0015

#define _EVENT_MAX             0x0015

/* If _EVENT_MAX ever hits 0x0020, we need to make the mask wider. */

/** Bitfield: The bit 1&lt;&lt;e is set if <b>any</b> open control

  control_event_client_status(LOG_WARN, "%s", buf);

}

/** We just generated a new summary of which countries we've seen clients

 * from recently. Send a copy to the controller in case it wants to

 * display it for the user. */

void

control_event_clients_seen(const char *timestarted, const char *countries)

{

  send_control_event(EVENT_CLIENTS_SEEN, 0,

    "650 CLIENTS_SEEN Timestarted=\"%s\" CountrySummary=%s\r\n",

    timestarted, countries);

}

void control_event_bootstrap(bootstrap_status_t status, int progress);

void control_event_bootstrap_problem(const char *warn, int reason);

void control_event_clients_seen(const char *timestarted,

                                const char *countries);

#ifdef CONTROL_PRIVATE

/* Used only by control.c and test.c */

size_t write_escaped_data(const char *data, size_t len, char **out);