tor-commits
Threads by month
- ----- 2026 -----
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2025 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2024 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2023 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2022 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2021 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2020 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2019 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2018 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2017 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2016 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2015 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2014 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2013 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2012 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2011 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- 1 participants
- 216132 discussions
commit 4740542f5ac5bec21e3c2790896de880e8796382
Author: Damian Johnson <atagar(a)torproject.org>
Date: Tue Dec 11 20:22:31 2012 -0800
Dropping support for arm's GTK gui
As mentioned in prior commits arm's gui is unmaintained and (as far as I know)
unused. It was an experiment and has been unmaintained for the last year, so
finally dropping it. We can resurrect it later if someone shows interest in
advancing it.
---
src/gui/__init__.py | 6 -
src/gui/arm.xml | 1348 ------------------------------------
src/gui/configPanel.py | 161 -----
src/gui/connections/__init__.py | 6 -
src/gui/connections/circEntry.py | 36 -
src/gui/connections/connEntry.py | 59 --
src/gui/connections/connPanel.py | 92 ---
src/gui/controller.py | 63 --
src/gui/generalPanel.py | 124 ----
src/gui/graphing/__init__.py | 6 -
src/gui/graphing/bandwidthStats.py | 60 --
src/gui/graphing/graphPanel.py | 144 ----
src/gui/logPanel.py | 126 ----
src/prereq.py | 101 +---
src/starter.py | 10 +-
15 files changed, 3 insertions(+), 2339 deletions(-)
diff --git a/src/gui/__init__.py b/src/gui/__init__.py
deleted file mode 100644
index f274d81..0000000
--- a/src/gui/__init__.py
+++ /dev/null
@@ -1,6 +0,0 @@
-"""
-Panels, popups, and handlers comprising the arm user interface.
-"""
-
-__all__ = ["controller", "generalPanel", "logPanel"]
-
diff --git a/src/gui/arm.xml b/src/gui/arm.xml
deleted file mode 100644
index 3b28423..0000000
--- a/src/gui/arm.xml
+++ /dev/null
@@ -1,1348 +0,0 @@
-<?xml version="1.0"?>
-<interface>
- <requires lib="gtk+" version="2.16"/>
- <!-- interface-naming-policy project-wide -->
- <object class="GtkListStore" id="liststore_general">
- <columns>
- <!-- column-name key -->
- <column type="gchararray"/>
- <!-- column-name value -->
- <column type="gchararray"/>
- <!-- column-name foreground -->
- <column type="gchararray"/>
- </columns>
- </object>
- <object class="GtkListStore" id="liststore_log">
- <columns>
- <!-- column-name timestamp_raw -->
- <column type="gulong"/>
- <!-- column-name timestamp -->
- <column type="gchararray"/>
- <!-- column-name type -->
- <column type="gchararray"/>
- <!-- column-name msg -->
- <column type="gchararray"/>
- <!-- column-name foreground -->
- <column type="gchararray"/>
- </columns>
- </object>
- <object class="GtkListStore" id="liststore_config">
- <columns>
- <!-- column-name option -->
- <column type="gchararray"/>
- <!-- column-name value -->
- <column type="gchararray"/>
- <!-- column-name summary -->
- <column type="gchararray"/>
- <!-- column-name foreground -->
- <column type="gchararray"/>
- <!-- column-name desc -->
- <column type="gchararray"/>
- </columns>
- </object>
- <object class="GtkTreeStore" id="treestore_conn">
- <columns>
- <!-- column-name origin -->
- <column type="gchararray"/>
- <!-- column-name dest -->
- <column type="gchararray"/>
- <!-- column-name time -->
- <column type="gchararray"/>
- <!-- column-name type -->
- <column type="gchararray"/>
- <!-- column-name foreground -->
- <column type="gchararray"/>
- <!-- column-name entry_line -->
- <column type="GObject"/>
- </columns>
- </object>
- <object class="GtkWindow" id="window_main">
- <property name="title" translatable="yes">garm</property>
- <property name="default_width">640</property>
- <property name="default_height">480</property>
- <signal name="delete_event" handler="on_window_main_delete_event"/>
- <child>
- <object class="GtkVBox" id="vbox_main">
- <property name="visible">True</property>
- <property name="orientation">vertical</property>
- <property name="spacing">5</property>
- <child>
- <object class="GtkMenuBar" id="menubar_main">
- <property name="visible">True</property>
- <child>
- <object class="GtkMenuItem" id="menuitem_file">
- <property name="visible">True</property>
- <property name="label" translatable="yes">_File</property>
- <property name="use_underline">True</property>
- <child type="submenu">
- <object class="GtkMenu" id="menu_file">
- <property name="visible">True</property>
- <child>
- <object class="GtkImageMenuItem" id="imagemenuitem_quit">
- <property name="label">gtk-quit</property>
- <property name="visible">True</property>
- <property name="related_action">action_quit</property>
- <property name="use_underline">True</property>
- <property name="use_stock">True</property>
- </object>
- </child>
- </object>
- </child>
- </object>
- </child>
- <child>
- <object class="GtkMenuItem" id="menuitem_help">
- <property name="visible">True</property>
- <property name="label" translatable="yes">_Help</property>
- <property name="use_underline">True</property>
- <child type="submenu">
- <object class="GtkMenu" id="menu_help">
- <property name="visible">True</property>
- <child>
- <object class="GtkImageMenuItem" id="imagemenuitem_about">
- <property name="label">gtk-about</property>
- <property name="visible">True</property>
- <property name="related_action">action_about</property>
- <property name="use_underline">True</property>
- <property name="use_stock">True</property>
- </object>
- </child>
- </object>
- </child>
- </object>
- </child>
- </object>
- <packing>
- <property name="expand">False</property>
- <property name="position">0</property>
- </packing>
- </child>
- <child>
- <object class="GtkVPaned" id="vpaned_main">
- <property name="visible">True</property>
- <property name="can_focus">True</property>
- <property name="orientation">vertical</property>
- <child>
- <object class="GtkVBox" id="vbox_notebook">
- <property name="visible">True</property>
- <property name="orientation">vertical</property>
- <child>
- <object class="GtkToolbar" id="toolbar_main">
- <property name="visible">True</property>
- <child>
- <object class="GtkToolButton" id="toolbutton_about">
- <property name="visible">True</property>
- <property name="related_action">action_about</property>
- <property name="use_action_appearance">True</property>
- <property name="label" translatable="yes">About</property>
- <property name="use_underline">True</property>
- <property name="stock_id">gtk-about</property>
- </object>
- <packing>
- <property name="expand">False</property>
- <property name="homogeneous">True</property>
- </packing>
- </child>
- <child>
- <object class="GtkToolButton" id="toolbutton_quit">
- <property name="visible">True</property>
- <property name="related_action">action_quit</property>
- <property name="use_action_appearance">True</property>
- <property name="label" translatable="yes">Quit</property>
- <property name="use_underline">True</property>
- <property name="stock_id">gtk-quit</property>
- </object>
- <packing>
- <property name="expand">False</property>
- <property name="homogeneous">True</property>
- </packing>
- </child>
- </object>
- <packing>
- <property name="expand">False</property>
- <property name="position">0</property>
- </packing>
- </child>
- <child>
- <object class="GtkNotebook" id="notebook_main">
- <property name="visible">True</property>
- <property name="can_focus">True</property>
- <child>
- <object class="GtkVBox" id="vbox_graph">
- <property name="visible">True</property>
- <property name="orientation">vertical</property>
- <child>
- <object class="GtkLabel" id="label_graph_top">
- <property name="visible">True</property>
- <property name="label" translatable="yes">Limit: 0.00 b/s, Burst: 0.00 b/s</property>
- </object>
- <packing>
- <property name="expand">False</property>
- <property name="fill">False</property>
- <property name="position">0</property>
- </packing>
- </child>
- <child>
- <object class="GtkHBox" id="hbox_graph">
- <property name="visible">True</property>
- <child>
- <object class="GtkVBox" id="vbox_graph_primary">
- <property name="visible">True</property>
- <property name="orientation">vertical</property>
- <child>
- <object class="GtkLabel" id="label_graph_primary_top">
- <property name="visible">True</property>
- <property name="label" translatable="yes">Download: 0.00 b/s</property>
- </object>
- <packing>
- <property name="expand">False</property>
- <property name="fill">False</property>
- <property name="position">0</property>
- </packing>
- </child>
- <child>
- <object class="GtkVBox" id="placeholder_graph_primary">
- <property name="visible">True</property>
- <property name="orientation">vertical</property>
- <child>
- <placeholder/>
- </child>
- </object>
- <packing>
- <property name="position">1</property>
- </packing>
- </child>
- <child>
- <object class="GtkLabel" id="label_graph_primary_bottom">
- <property name="visible">True</property>
- <property name="label" translatable="yes">avg: 0.00 b/s, total: 0.00 B</property>
- </object>
- <packing>
- <property name="expand">False</property>
- <property name="fill">False</property>
- <property name="position">2</property>
- </packing>
- </child>
- </object>
- <packing>
- <property name="position">0</property>
- </packing>
- </child>
- <child>
- <object class="GtkVBox" id="vbox_graph_secondary">
- <property name="visible">True</property>
- <property name="orientation">vertical</property>
- <child>
- <object class="GtkLabel" id="label_graph_secondary_top">
- <property name="visible">True</property>
- <property name="label" translatable="yes">Upload: 0.00 b/s</property>
- </object>
- <packing>
- <property name="expand">False</property>
- <property name="fill">False</property>
- <property name="position">0</property>
- </packing>
- </child>
- <child>
- <object class="GtkVBox" id="placeholder_graph_secondary">
- <property name="visible">True</property>
- <property name="orientation">vertical</property>
- <child>
- <placeholder/>
- </child>
- </object>
- <packing>
- <property name="position">1</property>
- </packing>
- </child>
- <child>
- <object class="GtkLabel" id="label_graph_secondary_bottom">
- <property name="visible">True</property>
- <property name="label" translatable="yes">avg: 0.00 b/s, total: 0.00 B</property>
- </object>
- <packing>
- <property name="expand">False</property>
- <property name="fill">False</property>
- <property name="position">2</property>
- </packing>
- </child>
- </object>
- <packing>
- <property name="position">1</property>
- </packing>
- </child>
- </object>
- <packing>
- <property name="position">1</property>
- </packing>
- </child>
- </object>
- </child>
- <child type="tab">
- <object class="GtkLabel" id="label_notebook_graph">
- <property name="visible">True</property>
- <property name="label" translatable="yes">Graphs</property>
- </object>
- <packing>
- <property name="tab_fill">False</property>
- </packing>
- </child>
- <child>
- <object class="GtkVBox" id="vbox_conn">
- <property name="visible">True</property>
- <property name="orientation">vertical</property>
- <child>
- <object class="GtkLabel" id="label_conn_top">
- <property name="visible">True</property>
- <property name="label" translatable="yes">Connections:</property>
- </object>
- <packing>
- <property name="expand">False</property>
- <property name="fill">False</property>
- <property name="position">0</property>
- </packing>
- </child>
- <child>
- <object class="GtkScrolledWindow" id="scrolledwindow_conn">
- <property name="visible">True</property>
- <property name="can_focus">True</property>
- <property name="hscrollbar_policy">automatic</property>
- <property name="vscrollbar_policy">automatic</property>
- <child>
- <object class="GtkTreeView" id="treeview_conn">
- <property name="visible">True</property>
- <property name="can_focus">True</property>
- <property name="model">treestore_conn</property>
- <property name="headers_visible">False</property>
- <property name="headers_clickable">False</property>
- <property name="rules_hint">True</property>
- <property name="search_column">0</property>
- <child>
- <object class="GtkTreeViewColumn" id="treeviewcolumn_conn_origin">
- <property name="title">column</property>
- <child>
- <object class="GtkCellRendererText" id="cellrenderertext_conn_origin"/>
- <attributes>
- <attribute name="foreground">4</attribute>
- <attribute name="markup">0</attribute>
- </attributes>
- </child>
- </object>
- </child>
- <child>
- <object class="GtkTreeViewColumn" id="treeviewcolumn_conn_dest">
- <property name="title">column</property>
- <child>
- <object class="GtkCellRendererText" id="cellrenderertext_conn_dest"/>
- <attributes>
- <attribute name="foreground">4</attribute>
- <attribute name="markup">1</attribute>
- </attributes>
- </child>
- </object>
- </child>
- <child>
- <object class="GtkTreeViewColumn" id="treeviewcolumn_conn_time">
- <property name="title">column</property>
- <child>
- <object class="GtkCellRendererText" id="cellrenderertext_conn_time"/>
- <attributes>
- <attribute name="foreground">4</attribute>
- <attribute name="markup">2</attribute>
- </attributes>
- </child>
- </object>
- </child>
- <child>
- <object class="GtkTreeViewColumn" id="treeviewcolumn_conn_type">
- <property name="title">column</property>
- <child>
- <object class="GtkCellRendererText" id="cellrenderertext_conn_type"/>
- <attributes>
- <attribute name="foreground">4</attribute>
- <attribute name="markup">3</attribute>
- </attributes>
- </child>
- </object>
- </child>
- </object>
- </child>
- </object>
- <packing>
- <property name="position">1</property>
- </packing>
- </child>
- </object>
- <packing>
- <property name="position">1</property>
- </packing>
- </child>
- <child type="tab">
- <object class="GtkLabel" id="label_notebook_conn">
- <property name="visible">True</property>
- <property name="label" translatable="yes">Connections</property>
- </object>
- <packing>
- <property name="position">1</property>
- <property name="tab_fill">False</property>
- </packing>
- </child>
- <child>
- <object class="GtkVPaned" id="vpaned_config">
- <property name="visible">True</property>
- <property name="can_focus">True</property>
- <property name="orientation">vertical</property>
- <child>
- <object class="GtkScrolledWindow" id="scrolledwindow_config_desc">
- <property name="height_request">60</property>
- <property name="visible">True</property>
- <property name="can_focus">True</property>
- <property name="hscrollbar_policy">automatic</property>
- <property name="vscrollbar_policy">automatic</property>
- <child>
- <object class="GtkTextView" id="textview_config_desc">
- <property name="visible">True</property>
- <property name="can_focus">True</property>
- <property name="editable">False</property>
- <property name="wrap_mode">word</property>
- <property name="cursor_visible">False</property>
- <property name="buffer">textbuffer_config_desc</property>
- </object>
- </child>
- </object>
- <packing>
- <property name="resize">False</property>
- <property name="shrink">True</property>
- </packing>
- </child>
- <child>
- <object class="GtkScrolledWindow" id="scrolledwindow_config">
- <property name="visible">True</property>
- <property name="can_focus">True</property>
- <property name="hscrollbar_policy">automatic</property>
- <property name="vscrollbar_policy">automatic</property>
- <child>
- <object class="GtkTreeView" id="treeview_config">
- <property name="visible">True</property>
- <property name="can_focus">True</property>
- <property name="model">liststore_config</property>
- <property name="headers_clickable">False</property>
- <property name="search_column">0</property>
- <child>
- <object class="GtkTreeViewColumn" id="treeviewcolumn_config_option">
- <property name="title">Option</property>
- <child>
- <object class="GtkCellRendererText" id="cellrenderertext_config_option"/>
- <attributes>
- <attribute name="foreground">3</attribute>
- <attribute name="text">0</attribute>
- </attributes>
- </child>
- </object>
- </child>
- <child>
- <object class="GtkTreeViewColumn" id="treeviewcolumn_config_value">
- <property name="title">Value</property>
- <child>
- <object class="GtkCellRendererText" id="cellrenderertext_config_value"/>
- <attributes>
- <attribute name="foreground">3</attribute>
- <attribute name="text">1</attribute>
- </attributes>
- </child>
- </object>
- </child>
- <child>
- <object class="GtkTreeViewColumn" id="treeviewcolumn_config_summary">
- <property name="title">Description</property>
- <child>
- <object class="GtkCellRendererText" id="cellrenderertext_config_summary"/>
- <attributes>
- <attribute name="foreground">3</attribute>
- <attribute name="text">2</attribute>
- </attributes>
- </child>
- </object>
- </child>
- </object>
- </child>
- </object>
- <packing>
- <property name="resize">True</property>
- <property name="shrink">True</property>
- </packing>
- </child>
- </object>
- <packing>
- <property name="position">2</property>
- </packing>
- </child>
- <child type="tab">
- <object class="GtkLabel" id="label_config">
- <property name="visible">True</property>
- <property name="label" translatable="yes">Configuration</property>
- </object>
- <packing>
- <property name="position">3</property>
- <property name="tab_fill">False</property>
- </packing>
- </child>
- <child>
- <object class="GtkScrolledWindow" id="scrolledwindow_general">
- <property name="visible">True</property>
- <property name="can_focus">True</property>
- <property name="hscrollbar_policy">automatic</property>
- <property name="vscrollbar_policy">automatic</property>
- <child>
- <object class="GtkTreeView" id="treeview_general">
- <property name="visible">True</property>
- <property name="can_focus">True</property>
- <property name="model">liststore_general</property>
- <property name="headers_visible">False</property>
- <property name="headers_clickable">False</property>
- <property name="rules_hint">True</property>
- <property name="search_column">0</property>
- <child>
- <object class="GtkTreeViewColumn" id="treeviewcolumn_general_key">
- <property name="title">column</property>
- <child>
- <object class="GtkCellRendererText" id="cellrenderertext_general_key"/>
- <attributes>
- <attribute name="markup">0</attribute>
- </attributes>
- </child>
- </object>
- </child>
- <child>
- <object class="GtkTreeViewColumn" id="treeviewcolumn_general_value">
- <property name="title">column</property>
- <child>
- <object class="GtkCellRendererText" id="cellrenderertext_general_value"/>
- <attributes>
- <attribute name="foreground">2</attribute>
- <attribute name="markup">1</attribute>
- </attributes>
- </child>
- </object>
- </child>
- </object>
- </child>
- </object>
- <packing>
- <property name="position">3</property>
- </packing>
- </child>
- <child type="tab">
- <object class="GtkLabel" id="label_general">
- <property name="visible">True</property>
- <property name="label" translatable="yes">General</property>
- </object>
- <packing>
- <property name="position">3</property>
- <property name="tab_fill">False</property>
- </packing>
- </child>
- </object>
- <packing>
- <property name="position">1</property>
- </packing>
- </child>
- </object>
- <packing>
- <property name="resize">True</property>
- <property name="shrink">False</property>
- </packing>
- </child>
- <child>
- <object class="GtkScrolledWindow" id="scrolledwindow_log">
- <property name="visible">True</property>
- <property name="can_focus">True</property>
- <property name="hscrollbar_policy">automatic</property>
- <property name="vscrollbar_policy">automatic</property>
- <child>
- <object class="GtkTreeView" id="treeview_log">
- <property name="visible">True</property>
- <property name="can_focus">True</property>
- <property name="model">liststore_log</property>
- <property name="headers_clickable">False</property>
- <property name="rules_hint">True</property>
- <property name="search_column">0</property>
- <child>
- <object class="GtkTreeViewColumn" id="treeviewcolumn_log_timestamp">
- <property name="title">Time</property>
- <property name="clickable">True</property>
- <property name="sort_indicator">True</property>
- <property name="sort_order">descending</property>
- <property name="sort_column_id">1</property>
- <child>
- <object class="GtkCellRendererText" id="cellrenderertext_log_timestamp"/>
- <attributes>
- <attribute name="foreground">4</attribute>
- <attribute name="markup">1</attribute>
- </attributes>
- </child>
- </object>
- </child>
- <child>
- <object class="GtkTreeViewColumn" id="treeviewcolumn_log_type">
- <property name="title">Type</property>
- <child>
- <object class="GtkCellRendererText" id="cellrenderertext_log_type"/>
- <attributes>
- <attribute name="foreground">4</attribute>
- <attribute name="markup">2</attribute>
- </attributes>
- </child>
- </object>
- </child>
- <child>
- <object class="GtkTreeViewColumn" id="treeviewcolumn_msg">
- <property name="title">Message</property>
- <child>
- <object class="GtkCellRendererText" id="cellrenderertext_log_msg"/>
- <attributes>
- <attribute name="foreground">4</attribute>
- <attribute name="markup">3</attribute>
- </attributes>
- </child>
- </object>
- </child>
- </object>
- </child>
- </object>
- <packing>
- <property name="resize">False</property>
- <property name="shrink">False</property>
- </packing>
- </child>
- </object>
- <packing>
- <property name="position">1</property>
- </packing>
- </child>
- </object>
- </child>
- </object>
- <object class="GtkAboutDialog" id="aboutdialog">
- <property name="border_width">5</property>
- <property name="type_hint">normal</property>
- <property name="program_name">garm</property>
- <property name="version">0.1</property>
- <property name="copyright" translatable="yes">Copyright (C) 2011 Kamran Riaz Khan</property>
- <property name="website">http://inspirated.com/</property>
- <property name="website_label" translatable="yes">Blog</property>
- <property name="license" translatable="yes"> GNU GENERAL PUBLIC LICENSE
- Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
- Preamble
-
- The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
-
- The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works. By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users. We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors. You can apply it to
-your programs, too.
-
- When we speak of free software, we are referring to freedom, not
-price. Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
- To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights. Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
- For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received. You must make sure that they, too, receive
-or can get the source code. And you must show them these terms so they
-know their rights.
-
- Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
- For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software. For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
- Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so. This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software. The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable. Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products. If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
- Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary. To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
- The precise terms and conditions for copying, distribution and
-modification follow.
-
- TERMS AND CONDITIONS
-
- 0. Definitions.
-
- "This License" refers to version 3 of the GNU General Public License.
-
- "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
- "The Program" refers to any copyrightable work licensed under this
-License. Each licensee is addressed as "you". "Licensees" and
-"recipients" may be individuals or organizations.
-
- To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy. The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
- A "covered work" means either the unmodified Program or a work based
-on the Program.
-
- To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy. Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
- To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies. Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
- An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License. If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
- 1. Source Code.
-
- The "source code" for a work means the preferred form of the work
-for making modifications to it. "Object code" means any non-source
-form of a work.
-
- A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
- The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form. A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
- The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities. However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work. For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
- The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
- The Corresponding Source for a work in source code form is that
-same work.
-
- 2. Basic Permissions.
-
- All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met. This License explicitly affirms your unlimited
-permission to run the unmodified Program. The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work. This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
- You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force. You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright. Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
- Conveying under any other circumstances is permitted solely under
-the conditions stated below. Sublicensing is not allowed; section 10
-makes it unnecessary.
-
- 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
- No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
- When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
- 4. Conveying Verbatim Copies.
-
- You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
- You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
- 5. Conveying Modified Source Versions.
-
- You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
- a) The work must carry prominent notices stating that you modified
- it, and giving a relevant date.
-
- b) The work must carry prominent notices stating that it is
- released under this License and any conditions added under section
- 7. This requirement modifies the requirement in section 4 to
- "keep intact all notices".
-
- c) You must license the entire work, as a whole, under this
- License to anyone who comes into possession of a copy. This
- License will therefore apply, along with any applicable section 7
- additional terms, to the whole of the work, and all its parts,
- regardless of how they are packaged. This License gives no
- permission to license the work in any other way, but it does not
- invalidate such permission if you have separately received it.
-
- d) If the work has interactive user interfaces, each must display
- Appropriate Legal Notices; however, if the Program has interactive
- interfaces that do not display Appropriate Legal Notices, your
- work need not make them do so.
-
- A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit. Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
- 6. Conveying Non-Source Forms.
-
- You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
- a) Convey the object code in, or embodied in, a physical product
- (including a physical distribution medium), accompanied by the
- Corresponding Source fixed on a durable physical medium
- customarily used for software interchange.
-
- b) Convey the object code in, or embodied in, a physical product
- (including a physical distribution medium), accompanied by a
- written offer, valid for at least three years and valid for as
- long as you offer spare parts or customer support for that product
- model, to give anyone who possesses the object code either (1) a
- copy of the Corresponding Source for all the software in the
- product that is covered by this License, on a durable physical
- medium customarily used for software interchange, for a price no
- more than your reasonable cost of physically performing this
- conveying of source, or (2) access to copy the
- Corresponding Source from a network server at no charge.
-
- c) Convey individual copies of the object code with a copy of the
- written offer to provide the Corresponding Source. This
- alternative is allowed only occasionally and noncommercially, and
- only if you received the object code with such an offer, in accord
- with subsection 6b.
-
- d) Convey the object code by offering access from a designated
- place (gratis or for a charge), and offer equivalent access to the
- Corresponding Source in the same way through the same place at no
- further charge. You need not require recipients to copy the
- Corresponding Source along with the object code. If the place to
- copy the object code is a network server, the Corresponding Source
- may be on a different server (operated by you or a third party)
- that supports equivalent copying facilities, provided you maintain
- clear directions next to the object code saying where to find the
- Corresponding Source. Regardless of what server hosts the
- Corresponding Source, you remain obligated to ensure that it is
- available for as long as needed to satisfy these requirements.
-
- e) Convey the object code using peer-to-peer transmission, provided
- you inform other peers where the object code and Corresponding
- Source of the work are being offered to the general public at no
- charge under subsection 6d.
-
- A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
- A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling. In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage. For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product. A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
- "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source. The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
- If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information. But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
- The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed. Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
- Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
- 7. Additional Terms.
-
- "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law. If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
- When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it. (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.) You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
- Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
- a) Disclaiming warranty or limiting liability differently from the
- terms of sections 15 and 16 of this License; or
-
- b) Requiring preservation of specified reasonable legal notices or
- author attributions in that material or in the Appropriate Legal
- Notices displayed by works containing it; or
-
- c) Prohibiting misrepresentation of the origin of that material, or
- requiring that modified versions of such material be marked in
- reasonable ways as different from the original version; or
-
- d) Limiting the use for publicity purposes of names of licensors or
- authors of the material; or
-
- e) Declining to grant rights under trademark law for use of some
- trade names, trademarks, or service marks; or
-
- f) Requiring indemnification of licensors and authors of that
- material by anyone who conveys the material (or modified versions of
- it) with contractual assumptions of liability to the recipient, for
- any liability that these contractual assumptions directly impose on
- those licensors and authors.
-
- All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10. If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term. If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
- If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
- Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
- 8. Termination.
-
- You may not propagate or modify a covered work except as expressly
-provided under this License. Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
- However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
- Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
- Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License. If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
- 9. Acceptance Not Required for Having Copies.
-
- You are not required to accept this License in order to receive or
-run a copy of the Program. Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance. However,
-nothing other than this License grants you permission to propagate or
-modify any covered work. These actions infringe copyright if you do
-not accept this License. Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
- 10. Automatic Licensing of Downstream Recipients.
-
- Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License. You are not responsible
-for enforcing compliance by third parties with this License.
-
- An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations. If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
- You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License. For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
- 11. Patents.
-
- A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based. The
-work thus licensed is called the contributor's "contributor version".
-
- A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version. For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
- Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
- In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement). To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
- If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients. "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
- If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
- A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License. You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
- Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
- 12. No Surrender of Others' Freedom.
-
- If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all. For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
- 13. Use with the GNU Affero General Public License.
-
- Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work. The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
- 14. Revised Versions of this License.
-
- The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time. Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
- Each version is given a distinguishing version number. If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation. If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
- If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
- Later license versions may give you additional or different
-permissions. However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
- 15. Disclaimer of Warranty.
-
- THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
- 16. Limitation of Liability.
-
- IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
- 17. Interpretation of Sections 15 and 16.
-
- If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
- END OF TERMS AND CONDITIONS
-
- How to Apply These Terms to Your New Programs
-
- If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
- To do so, attach the following notices to the program. It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
- <one line to give the program's name and a brief idea of what it does.>
- Copyright (C) <year> <name of author>
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program. If not, see <http://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
- If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
- <program> Copyright (C) <year> <name of author>
- This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
- This is free software, and you are welcome to redistribute it
- under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License. Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
- You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
-
- The GNU General Public License does not permit incorporating your program
-into proprietary programs. If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library. If this is what you want to do, use the GNU Lesser General
-Public License instead of this License. But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.
-</property>
- <property name="authors">Kamran Riaz Khan <krkhan(a)inspirated.com>
-Damian Johnson <atagar1(a)gmail.com></property>
- <signal name="response" handler="on_aboutdialog_response"/>
- <child internal-child="vbox">
- <object class="GtkVBox" id="aboutdialog_vbox">
- <property name="visible">True</property>
- <property name="orientation">vertical</property>
- <property name="spacing">2</property>
- <child internal-child="action_area">
- <object class="GtkHButtonBox" id="aboutdialog_action_area">
- <property name="visible">True</property>
- <property name="layout_style">end</property>
- </object>
- <packing>
- <property name="expand">False</property>
- <property name="pack_type">end</property>
- <property name="position">0</property>
- </packing>
- </child>
- </object>
- </child>
- </object>
- <object class="GtkAction" id="action_quit">
- <property name="label">Quit</property>
- <property name="short_label">Quit</property>
- <property name="tooltip">Quit</property>
- <property name="stock_id">gtk-quit</property>
- <signal name="activate" handler="on_action_quit_activate"/>
- </object>
- <object class="GtkAction" id="action_about">
- <property name="label">About</property>
- <property name="short_label">About</property>
- <property name="tooltip">About</property>
- <property name="stock_id">gtk-about</property>
- <signal name="activate" handler="on_action_about_activate"/>
- </object>
- <object class="GtkTextBuffer" id="textbuffer_config_desc">
- <property name="text" translatable="yes">Select a configuration option to see its description.</property>
- </object>
-</interface>
diff --git a/src/gui/configPanel.py b/src/gui/configPanel.py
deleted file mode 100644
index e7cc692..0000000
--- a/src/gui/configPanel.py
+++ /dev/null
@@ -1,161 +0,0 @@
-"""
-Configuration panel.
-"""
-
-import random
-import sys
-import time
-
-import gobject
-import gtk
-
-from cli.configPanel import (ConfigPanel as CliConfigPanel, Field, State)
-from util import connections, gtkTools, sysTools, torConfig, torTools, uiTools
-from TorCtl import TorCtl
-
-CATEGORY_COLOR = {torConfig.Category.GENERAL: "#307809",
- torConfig.Category.CLIENT: "#2F305C",
- torConfig.Category.RELAY: "#848144",
- torConfig.Category.DIRECTORY: "#9F2254",
- torConfig.Category.AUTHORITY: "#B3141B",
- torConfig.Category.HIDDEN_SERVICE: "#3A8427",
- torConfig.Category.TESTING: "#222222",
- torConfig.Category.UNKNOWN: "#111111"}
-
-def input_conf_value_size(option, oldValue):
- prompt = "Enter value for %s" % option
- return gtkTools.input_size(prompt, oldValue)
-
-def input_conf_value_time(option, oldValue):
- prompt = "Enter value for %s" % option
- return gtkTools.input_time(prompt, oldValue)
-
-def input_conf_value_int(option, oldValue):
- prompt = "Enter value for %s" % option
- return gtkTools.input_int(prompt, oldValue)
-
-def input_conf_value_list(option, oldValue, csv=False):
- prompt = "Enter value for %s" % option
- return gtkTools.input_list(prompt, oldValue, csv)
-
-def input_conf_value_string(option, oldValue):
- prompt = "Enter value for %s" % option
- return gtkTools.input_string(prompt, oldValue)
-
-def input_conf_value_bool(option, oldValue):
- prompt = "Select value for %s" % option
-
- newValue = gtkTools.input_bool(prompt, oldValue)
-
- if newValue == None:
- return
-
- return "1" if newValue else "0"
-
-def input_conf_value_dir(option, oldValue):
- prompt = "Select value for %s" % option
- return gtkTools.input_dir(prompt, oldValue)
-
-def input_conf_value_filename(option, oldValue):
- prompt = "Select value for %s" % option
- return gtkTools.input_filename(prompt, oldValue)
-
-class ConfContents(gtkTools.ListWrapper):
- def _create_row_from_value(self, entry):
- option = entry.get(Field.OPTION)
- isDefault = entry.get(Field.IS_DEFAULT)
- value = entry.get(Field.VALUE)
- configType = entry.get(Field.TYPE)
- summary = entry.get(Field.SUMMARY)
- desc = " ".join(entry.get(Field.DESCRIPTION).split())
- argUsage = entry.get(Field.ARG_USAGE)
- category = entry.get(Field.CATEGORY)
-
- descText = "%s (%s Option)" % (option, category)
- descText += "\nValue: %s (%s%s, usage: %s)" % (value, "default, " if isDefault else "", configType, argUsage)
- descText += "\nDescription: %s" % (desc)
-
- row = (option, value, summary, CATEGORY_COLOR[category], descText)
-
- return row
-
-class ConfigPanel(object, CliConfigPanel):
- def __init__(self, builder):
- CliConfigPanel.__init__(self, None, State.TOR)
-
- self.builder = builder
-
- listStore = self.builder.get_object('liststore_config')
- self._wrappedConfContents = ConfContents(self.confContents, listStore)
-
- @property
- def confContents(self):
- if hasattr(self, '_wrappedConfContents'):
- return self._wrappedConfContents.container
- else:
- return []
-
- @confContents.setter
- def confContents(self, value):
- if hasattr(self, '_wrappedConfContents'):
- self._wrappedConfContents.empty()
- for entry in value:
- self._wrappedConfContents.append(entry)
- else:
- self._wrappedConfContents = ConfContents(value)
-
- def pack_widgets(self):
- treeView = self.builder.get_object('treeview_config')
-
- treeView.connect('cursor-changed', self.on_treeview_config_cursor_changed)
- treeView.connect('row-activated', self.on_treeview_config_row_activated)
-
- def on_treeview_config_cursor_changed(self, treeView, data=None):
- treeSelection = treeView.get_selection()
-
- (model, iter) = treeSelection.get_selected()
- desc = model.get_value(iter, 4)
-
- textBuffer = self.builder.get_object('textbuffer_config_desc')
- textBuffer.set_text(desc)
-
- def on_treeview_config_row_activated(self, treeView, path, column):
- (index,) = path
-
- entry = self._wrappedConfContents[index]
- configOption = entry.get(Field.OPTION)
- configType = entry.get(Field.TYPE)
- argUsage = entry.get(Field.ARG_USAGE)
- oldValue = entry.get(Field.VALUE) if entry.get(Field.VALUE) != '<none>' else None
- newValue = None
-
- if configType == 'DataSize':
- newValue = input_conf_value_size(configOption, oldValue)
- elif configType == 'TimeInterval':
- newValue = input_conf_value_time(configOption, oldValue)
- elif configType == 'Integer':
- newValue = input_conf_value_int(configOption, oldValue)
- elif configType == 'String':
- newValue = input_conf_value_string(configOption, oldValue)
- elif configType == 'LineList':
- newValue = input_conf_value_list(configOption, oldValue, csv=False)
- elif configType == 'RouterList' or configType == 'CommaList':
- newValue = input_conf_value_list(configOption, oldValue, csv=True)
- elif configType == 'Boolean':
- newValue = input_conf_value_bool(configOption, oldValue)
- elif configType == 'Filename':
- if 'DIR' in argUsage:
- newValue = input_conf_value_dir(configOption, oldValue)
- else:
- newValue = input_conf_value_filename(configOption, oldValue)
- else:
- newValue = input_conf_value_string(configOption, oldValue)
-
- if newValue and newValue != oldValue:
- try:
- torTools.getConn().setOption(configOption, newValue)
- except TorCtl.ErrorReply, err:
- gtkTools.showError(str(err))
-
- self._wrappedConfContents[index] = entry
-
diff --git a/src/gui/connections/__init__.py b/src/gui/connections/__init__.py
deleted file mode 100644
index e573074..0000000
--- a/src/gui/connections/__init__.py
+++ /dev/null
@@ -1,6 +0,0 @@
-"""
-Connections.
-"""
-
-__all__ = ["connPanel", "circEntry", "connEntry"]
-
diff --git a/src/gui/connections/circEntry.py b/src/gui/connections/circEntry.py
deleted file mode 100644
index 04d3208..0000000
--- a/src/gui/connections/circEntry.py
+++ /dev/null
@@ -1,36 +0,0 @@
-"""
-Connection panel entries for client circuits.
-"""
-
-import time
-
-from cli.connections import entries
-from gui.connections import connEntry
-from util import gtkTools, uiTools
-
-class CircHeaderLine(connEntry.ConnectionLine):
- def __init__(self, cliLine):
- connEntry.ConnectionLine.__init__(self, cliLine)
-
- def get_listing_row(self, listingType):
- row = connEntry.ConnectionLine.get_listing_row(self, listingType)
- theme = gtkTools.Theme()
- return row[:-2] + (theme.colors['active'], self)
-
-class CircLine(connEntry.ConnectionLine):
- def __init__(self, cliLine):
- connEntry.ConnectionLine.__init__(self, cliLine)
-
- self.parentIter = None
-
- def get_listing_row(self, listingType):
- dst, etc = "", ""
-
- if listingType == entries.ListingType.IP_ADDRESS:
- dst = self.cliLine.getDestinationLabel(100, includeLocale=True)
- etc = self.cliLine.foreign.getNickname()
-
- theme = gtkTools.Theme()
-
- return (dst, etc, self.cliLine.placementLabel, self.cliLine.getType(), theme.colors['insensitive'], self)
-
diff --git a/src/gui/connections/connEntry.py b/src/gui/connections/connEntry.py
deleted file mode 100644
index 6f4baed..0000000
--- a/src/gui/connections/connEntry.py
+++ /dev/null
@@ -1,59 +0,0 @@
-"""
-Connection panel entries related to actual connections to or from the system
-(ie, results seen by netstat, lsof, etc).
-"""
-
-import time
-
-import gobject
-
-from cli.connections import entries
-from cli.connections.connEntry import Category, CONFIG
-from util import gtkTools, torTools, uiTools
-
-class ConnectionLine(gobject.GObject):
- def __init__(self, cliLine):
- gobject.GObject.__init__(self)
-
- self.cliLine = cliLine
-
- def get_listing_row(self, listingType):
- conn = torTools.getConn()
- myType = self.cliLine.getType()
- dstAddress = self.cliLine.getDestinationLabel(26, includeLocale = True)
- localPort = ":%s" % self.cliLine.local.getPort() if self.cliLine.includePort else ""
-
- src, dst, etc = "", "", ""
-
- if listingType == entries.ListingType.IP_ADDRESS:
- myExternalIpAddr = conn.getInfo("address", self.cliLine.local.getIpAddr())
- addrDiffer = myExternalIpAddr != self.cliLine.local.getIpAddr()
-
- isExpansionType = not myType in (Category.SOCKS, Category.HIDDEN, Category.CONTROL)
-
- if isExpansionType: srcAddress = myExternalIpAddr + localPort
- else: srcAddress = self.cliLine.local.getIpAddr() + localPort
-
- if myType in (Category.SOCKS, Category.CONTROL):
- src = dstAddress
- dst = srcAddress
- else:
- src = srcAddress
- dst = dstAddress
-
- if addrDiffer and isExpansionType and self.cliLine.includeExpandedIpAddr and CONFIG["features.connection.showColumn.expandedIp"]:
- internalAddress = self.cliLine.local.getIpAddr() + localPort
-
- if myType == Category.INBOUND: (src, dst) = (src, internalAddress)
- else: (src, dst) = (internalAddress, src)
-
- etc = self.cliLine.getEtcContent(100, listingType)
- else:
- src = "%s:%s" % (self.cliLine.local.ipAddr, self.cliLine.local.port)
- dst = "%s:%s" % (self.cliLine.foreign.ipAddr, self.cliLine.foreign.port)
-
- timeLabel = uiTools.getTimeLabel(time.time() - self.cliLine.startTime)
- theme = gtkTools.Theme()
-
- return (src, dst, timeLabel, self.cliLine.getType(), theme.colors['insensitive'], self)
-
diff --git a/src/gui/connections/connPanel.py b/src/gui/connections/connPanel.py
deleted file mode 100644
index 9476059..0000000
--- a/src/gui/connections/connPanel.py
+++ /dev/null
@@ -1,92 +0,0 @@
-"""
-Connections panel.
-"""
-
-import random
-import sys
-import time
-
-from collections import deque
-
-import gobject
-import gtk
-
-from cli.connections import (circEntry as cliCircEntry, connEntry as cliConnEntry, entries)
-from cli.connections.connPanel import ConnectionPanel as CliConnectionPanel
-from gui.connections import circEntry, connEntry
-from util import connections, gtkTools, sysTools, uiTools, torTools
-from TorCtl import TorCtl
-
-def convert_to_gui(cliInstance):
- cliToGuiMap = [ (cliCircEntry.CircHeaderLine, circEntry.CircHeaderLine),
- (cliCircEntry.CircLine, circEntry.CircLine),
- (cliConnEntry.ConnectionLine, connEntry.ConnectionLine)]
-
- line = None
-
- for (cliClass, guiClass) in cliToGuiMap:
- if isinstance(cliInstance, cliClass):
- line = guiClass(cliInstance)
- break
-
- return line
-
-class EntryLines(gtkTools.TreeWrapper):
- def __init__(self, container, model=None, listingType=None):
- gtkTools.TreeWrapper.__init__(self, container, model)
-
- self._listingType = listingType if listingType else entries.ListingType.IP_ADDRESS
-
- def _model_append(self, cliLine):
- if not self.model:
- return
-
- row = self._create_row_from_value(cliLine)
- line = convert_to_gui(cliLine)
-
- if isinstance(line, circEntry.CircHeaderLine):
- self.headerIter = self.model.append(None, row)
- elif isinstance(line, circEntry.CircLine):
- self.model.append(self.headerIter, row)
- else:
- self.model.append(None, row)
-
- def _create_row_from_value(self, cliLine):
- line = convert_to_gui(cliLine)
- row = line.get_listing_row(self._listingType)
-
- return row
-
-class ConnectionPanel(CliConnectionPanel):
- def __init__(self, builder):
- CliConnectionPanel.__init__(self, None)
-
- self.builder = builder
-
- conn = torTools.getConn()
- torPid = conn.getMyPid()
- torCmdName = sysTools.getProcessName(torPid, 'tor')
- connections.getResolver(torCmdName, torPid, 'tor')
-
- treeStore = self.builder.get_object('treestore_conn')
- self._wrappedEntryLines = EntryLines(self._entryLines, treeStore)
-
- @property
- def _entryLines(self):
- if hasattr(self, '_wrappedEntryLines'):
- return self._wrappedEntryLines.container
- else:
- return []
-
- @_entryLines.setter
- def _entryLines(self, value):
- if hasattr(self, '_wrappedEntryLines'):
- self._wrappedEntryLines.empty()
- for entry in value:
- self._wrappedEntryLines.append(entry)
- else:
- self._wrappedEntryLines = EntryLines(value)
-
- def pack_widgets(self):
- self.start()
-
diff --git a/src/gui/controller.py b/src/gui/controller.py
deleted file mode 100644
index 52bb2c6..0000000
--- a/src/gui/controller.py
+++ /dev/null
@@ -1,63 +0,0 @@
-import thread
-import time
-
-import gobject
-import gtk
-
-from connections import connPanel
-from gui.graphing import bandwidthStats
-from gui import configPanel, generalPanel, logPanel
-from util import log, torTools
-
-gobject.threads_init()
-
-class GuiController:
- def __init__(self):
- self.builder = gtk.Builder()
-
- try:
- self.builder.add_from_file('src/gui/arm.xml')
- except:
- # when installed the above path doesn't work (the 'src' prefix doesn't
- # exist and whichever path it's working off of doens't seem to exist),
- # so using absolute path instead
-
- self.builder.add_from_file('/usr/share/arm/gui/arm.xml')
-
- self.builder.connect_signals(self)
-
- panelClasses = (logPanel.LogPanel,
- bandwidthStats.BandwidthStats,
- connPanel.ConnectionPanel,
- configPanel.ConfigPanel,
- generalPanel.GeneralPanel)
- self.panels = {}
-
- for panelClass in panelClasses:
- self.panels[panelClass] = panelClass(self.builder)
- self.panels[panelClass].pack_widgets()
-
- def run(self):
- window = self.builder.get_object('window_main')
-
- window.show_all()
- gtk.main()
-
- def on_action_about_activate(self, widget, data=None):
- dialog = self.builder.get_object('aboutdialog')
- dialog.run()
-
- def on_aboutdialog_response(self, widget, responseid, data=None):
- dialog = self.builder.get_object('aboutdialog')
- dialog.hide()
-
- def on_action_quit_activate(self, widget, data=None):
- gtk.main_quit()
-
- def on_window_main_delete_event(self, widget, data=None):
- gtk.main_quit()
-
-def start_gui():
- controller = GuiController()
- controller.run()
-
diff --git a/src/gui/generalPanel.py b/src/gui/generalPanel.py
deleted file mode 100644
index be84d65..0000000
--- a/src/gui/generalPanel.py
+++ /dev/null
@@ -1,124 +0,0 @@
-"""
-General panel.
-"""
-
-import random
-import sys
-import time
-
-from collections import deque
-
-import gobject
-import gtk
-
-from cli.headerPanel import (HeaderPanel as CliHeaderPanel, VERSION_STATUS_COLORS)
-from util import connections, gtkTools, sysTools, torTools, uiTools
-from TorCtl import TorCtl
-
-class GeneralPanel(CliHeaderPanel):
- def __init__(self, builder):
- CliHeaderPanel.__init__(self, None, time.time())
-
- self.builder = builder
- self.filled = False
- self._isTorConnected = torTools.getConn().isAlive()
-
- gobject.idle_add(self._fill_entries)
- gobject.timeout_add(3000, self._timeout_fill_entries)
-
- def pack_widgets(self):
- return
-
- def _timeout_fill_entries(self):
- self._fill_entries()
-
- return True
-
- def _fill_entries(self):
- self.valsLock.acquire()
-
- listStore = self.builder.get_object('liststore_general')
- theme = gtkTools.Theme()
-
- listStore.clear()
-
- key = "arm"
- value = "%s (%s %s)" % (self.vals['sys/hostname'], self.vals['sys/os'], self.vals['sys/version'])
- row = (key, value, theme.colors['active'])
- listStore.append(row)
-
- versionColor = VERSION_STATUS_COLORS[self.vals["tor/versionStatus"]] if \
- self.vals["tor/versionStatus"] in VERSION_STATUS_COLORS else "black"
- key = "Tor"
- value = "%s (<span foreground=\"%s\">%s</span>)" % (self.vals['tor/version'], versionColor, self.vals['tor/versionStatus'])
- row = (key, value, theme.colors['active'])
- listStore.append(row)
-
- includeControlPort = True
- key = "Relaying"
- if self.vals["tor/orPort"]:
- myAddress = "Unknown"
- if self.vals["tor/orListenAddr"]: myAddress = self.vals["tor/orListenAddr"]
- elif self.vals["tor/address"]: myAddress = self.vals["tor/address"]
-
- dirPortLabel = ", Dir Port: %s" % self.vals["tor/dirPort"] if self.vals["tor/dirPort"] != "0" else ""
-
- value = "%s%s%s%s" % (self.vals["tor/nickname"], " - " + myAddress, ":" + self.vals["tor/orPort"], dirPortLabel)
- else:
- if self._isTorConnected:
- value = "Disabled"
- else:
- statusTime = torTools.getConn().getStatus()[1]
-
- if statusTime:
- statusTimeLabel = time.strftime("%H:%M %m/%d/%Y, ", time.localtime(statusTime))
- else: statusTimeLabel = ""
-
- value = "%s%s" % ("Tor Disconnected", statusTimeLabel)
- includeControlPort = False
- row = (key, value, theme.colors['active'])
- listStore.append(row)
-
- key = "Control Port"
- if includeControlPort:
- if self.vals["tor/isAuthPassword"]: authType = "password"
- elif self.vals["tor/isAuthCookie"]: authType = "cookie"
- else: authType = "open"
-
- authColor = "red" if authType == "open" else "green"
- value = "%s (<span foreground=\"%s\">%s</span>)" % (self.vals['tor/controlPort'], authColor, authType)
- row = (key, value, theme.colors['active'])
- listStore.append(row)
-
- if self.vals["stat/rss"] != "0": memoryLabel = uiTools.getSizeLabel(int(self.vals["stat/rss"]))
- else: memoryLabel = "0"
-
- uptimeLabel = "N/A"
- if self.vals["tor/startTime"]:
- if self.isPaused() or not self._isTorConnected:
- uptimeLabel = uiTools.getShortTimeLabel(self.getPauseTime() - self.vals["tor/startTime"])
- else:
- uptimeLabel = uiTools.getShortTimeLabel(time.time() - self.vals["tor/startTime"])
-
- key = "CPU"
- value = "%s%% Tor, %s%% arm" % (self.vals["stat/%torCpu"], self.vals["stat/%armCpu"])
- row = (key, value, theme.colors['active'])
- listStore.append(row)
-
- key = "Memory"
- value = "%s (%s%%)" % (memoryLabel, self.vals["stat/%mem"])
- row = (key, value, theme.colors['active'])
- listStore.append(row)
-
- key = "PID"
- value = "%s" % (self.vals["tor/pid"] if self._isTorConnected else "")
- row = (key, value, theme.colors['active'])
- listStore.append(row)
-
- key = "Uptime"
- value = uptimeLabel
- row = (key, value, theme.colors['active'])
- listStore.append(row)
-
- self.valsLock.release()
-
diff --git a/src/gui/graphing/__init__.py b/src/gui/graphing/__init__.py
deleted file mode 100644
index 06d08ea..0000000
--- a/src/gui/graphing/__init__.py
+++ /dev/null
@@ -1,6 +0,0 @@
-"""
-Graphs.
-"""
-
-__all__ = ["graphPanel", "bandwidthStats"]
-
diff --git a/src/gui/graphing/bandwidthStats.py b/src/gui/graphing/bandwidthStats.py
deleted file mode 100644
index 672b98e..0000000
--- a/src/gui/graphing/bandwidthStats.py
+++ /dev/null
@@ -1,60 +0,0 @@
-"""
-Bandwidth monitors.
-"""
-
-import sys
-
-import gobject
-import gtk
-
-from gui.graphing import graphPanel
-from starter import CONFIG
-from util import torTools, uiTools
-from TorCtl import TorCtl
-
-class BandwidthStats(graphPanel.GraphPanel):
- def __init__(self, builder):
- graphPanel.GraphPanel.__init__(self, builder)
-
- conn = torTools.getConn()
- if not conn.isAlive():
- try:
- conn.init()
- except ValueError:
- if CONFIG['features.allowDetachedStartup']:
- return
- else:
- raise
-
- conn.setControllerEvents(["BW", "NEWDESC"])
- conn.addEventListener(self)
-
- self.new_desc_event(None)
-
- def new_desc_event(self, event):
- conn = torTools.getConn()
-
- if not conn.isAlive():
- return
-
- bwRate = conn.getMyBandwidthRate()
- bwBurst = conn.getMyBandwidthBurst()
- bwObserved = conn.getMyBandwidthObserved()
- bwMeasured = conn.getMyBandwidthMeasured()
-
- if bwRate and bwBurst:
- bwRateLabel = uiTools.getSizeLabel(bwRate, 1, False, isBytes=False)
- bwBurstLabel = uiTools.getSizeLabel(bwBurst, 1, False, isBytes=False)
-
- msg = "Limit: %s/s, Burst: %s/s" % (bwRateLabel, bwBurstLabel)
- label = self.builder.get_object('label_graph_top')
- label.set_text(msg)
-
- def bandwidth_event(self, event):
- self._process_event(event.read, event.written)
-
- msg = 'Download: %s/s' % uiTools.getSizeLabel(event.read, 2, isBytes=False)
- self.update_header('primary', msg)
- msg = 'Upload: %s/s' % uiTools.getSizeLabel(event.written, 2, isBytes=False)
- self.update_header('secondary', msg)
-
diff --git a/src/gui/graphing/graphPanel.py b/src/gui/graphing/graphPanel.py
deleted file mode 100644
index b25180e..0000000
--- a/src/gui/graphing/graphPanel.py
+++ /dev/null
@@ -1,144 +0,0 @@
-"""
-Base class for implementing graphing functionality.
-"""
-
-import random
-import sys
-
-from collections import deque
-
-import gobject
-import gtk
-
-from util import gtkTools, torTools, uiTools
-from TorCtl import TorCtl
-
-from cagraph.axis.xaxis import CaGraphXAxis
-from cagraph.axis.yaxis import CaGraphYAxis
-from cagraph.ca_graph_grid import CaGraphGrid
-from cagraph.ca_graph import CaGraph
-from cagraph.series.area import CaGraphSeriesArea
-
-GRAPH_INTERVAL = 30
-
-class GraphPanel(TorCtl.PostEventListener):
- def __init__(self, builder):
- TorCtl.PostEventListener.__init__(self)
-
- self.builder = builder
-
- self.graphs = {
- 'primary' : None,
- 'secondary' : None }
- self.data = {
- 'primary' : deque([0.0] * GRAPH_INTERVAL),
- 'secondary' : deque([0.0] * GRAPH_INTERVAL)}
-
- self.total = {'primary': 0.0, 'secondary' : 0.0}
- self.ticks = {'primary': 0, 'secondary' : 0}
-
- def pack_widgets(self):
- self._pack_graph_widget('primary')
- self._pack_graph_widget('secondary')
-
- gobject.timeout_add(1000, self.draw_graph, 'primary')
- gobject.timeout_add(1000, self.draw_graph, 'secondary')
- gobject.timeout_add(1000, self.update_labels, 'primary')
- gobject.timeout_add(1000, self.update_labels, 'secondary')
-
- def get_graph_data(self, name):
- packedData = []
-
- for (index, value) in enumerate(self.data[name]):
- packedData.append((index, value))
-
- return packedData
-
- def is_graph_data_zero(self, name):
- data = self.data[name]
- return len(data) == map(int, data).count(0)
-
- def draw_graph(self, name):
- graph = self.graphs[name]
- data = self.get_graph_data(name)
-
- graph.seriess[0].data = data
- if not self.is_graph_data_zero(name):
-
- for (index, axis) in enumerate(graph.axiss):
- if axis.type != 'xaxis':
- graph.auto_set_yrange(index)
-
- graph.queue_draw()
-
- return True
-
- def update_labels(self, name):
- avg = 0
-
- try:
- avg = self.total[name] / float(self.ticks[name])
- except ZeroDivisionError:
- pass
-
- msg = "avg: %s/s, total: %s" % (uiTools.getSizeLabel(avg, 2, isBytes=False),
- uiTools.getSizeLabel(self.total[name], 2))
- label = self.builder.get_object('label_graph_%s_bottom' % name)
- label.set_text(msg)
-
- return True
-
- def update_header(self, name, msg):
- label = self.builder.get_object('label_graph_%s_top' % name)
- label.set_text(msg)
-
- def _pack_graph_widget(self, name):
- graph = CaGraph()
- graph.set_size_request(200, 200)
-
- placeholder = self.builder.get_object('placeholder_graph_%s' % name)
- placeholder.pack_start(graph)
-
- xAxis = CaGraphXAxis(graph)
- yAxis = CaGraphYAxis(graph)
-
- xAxis.min = 0
- xAxis.max = GRAPH_INTERVAL - 1
- xAxis.axis_style.draw_labels = False
- yAxis.axis_style.label_color = (0, 0, 0)
-
- graph.axiss.append(xAxis)
- graph.axiss.append(yAxis)
-
- series = CaGraphSeriesArea(graph, 0, 1)
-
- theme = gtkTools.Theme()
- primaryColor = theme.colors['normal']
- secondaryColor = theme.colors['insensitive']
- colors = { 'primary' : (primaryColor.red_float, primaryColor.green_float, primaryColor.blue_float, 0.5),
- 'secondary' : (secondaryColor.red_float, secondaryColor.green_float, secondaryColor.blue_float, 0.5) }
-
- series.style.point_radius = 0.0
- series.style.line_color = colors[name]
- series.style.fill_color = colors[name]
-
- graph.seriess.append(series)
- graph.grid = CaGraphGrid(graph, 0, 1)
-
- self.graphs[name] = graph
-
- return graph
-
- def _process_event(self, primary, secondary):
- values = {'primary' : primary, 'secondary' : secondary}
-
- for name in ('primary', 'secondary'):
- # right shift and store kbytes in left-most location
- self.data[name].rotate(1)
- self.data[name][0] = values[name] / 1024
-
- self.total[name] = self.total[name] + values[name]
-
- if values[name] > 0:
- self.ticks[name] = self.ticks[name] + 1
-
diff --git a/src/gui/logPanel.py b/src/gui/logPanel.py
deleted file mode 100644
index 7714dcd..0000000
--- a/src/gui/logPanel.py
+++ /dev/null
@@ -1,126 +0,0 @@
-"""
-Base class for implementing graphing functionality.
-"""
-
-import random
-import sys
-import time
-
-from collections import deque
-from threading import RLock
-
-import gobject
-import gtk
-
-from cli.logPanel import (expandEvents, setEventListening, getLogFileEntries,
- LogEntry, TorEventObserver,
- DEFAULT_CONFIG)
-from util import gtkTools, log, torTools, uiTools
-from TorCtl import TorCtl
-
-RUNLEVEL_EVENT_COLOR = {log.DEBUG: 'insensitive', log.INFO: 'normal', log.NOTICE: 'normal',
- log.WARN: 'active', log.ERR: 'active'}
-STARTUP_EVENTS = 'N3'
-REFRESH_RATE = 3
-
-class LogPanel:
- def __init__(self, builder):
- self.builder = builder
-
- self._config = dict(DEFAULT_CONFIG)
- self._lastUpdate = 0
-
- self.lock = RLock()
- self.msgLog = deque()
- self.loggedEvents = setEventListening(expandEvents(STARTUP_EVENTS))
-
- torEventBacklog = deque()
- if self._config["features.log.prepopulate"]:
- setRunlevels = list(set.intersection(set(self.loggedEvents), set(log.Runlevel.values())))
- readLimit = self._config["features.log.prepopulateReadLimit"]
- addLimit = self._config["cache.logPanel.size"]
- torEventBacklog = deque(getLogFileEntries(setRunlevels, readLimit, addLimit, self._config))
-
- armRunlevels = [log.DEBUG, log.INFO, log.NOTICE, log.WARN, log.ERR]
- log.addListeners(armRunlevels, self._register_arm_event)
-
- setRunlevels = []
- for i in range(len(armRunlevels)):
- if "ARM_" + log.Runlevel.values()[i] in self.loggedEvents:
- setRunlevels.append(armRunlevels[i])
-
- armEventBacklog = deque()
- for level, msg, eventTime in log._getEntries(setRunlevels):
- theme = gtkTools.Theme()
- armEventEntry = LogEntry(eventTime, "ARM_" + level, msg, theme.colors[RUNLEVEL_EVENT_COLOR[level]])
- armEventBacklog.appendleft(armEventEntry)
-
- while armEventBacklog or torEventBacklog:
- if not armEventBacklog:
- self.msgLog.append(torEventBacklog.popleft())
- elif not torEventBacklog:
- self.msgLog.append(armEventBacklog.popleft())
- elif armEventBacklog[0].timestamp < torEventBacklog[0].timestamp:
- self.msgLog.append(torEventBacklog.popleft())
- else:
- self.msgLog.append(armEventBacklog.popleft())
-
- conn = torTools.getConn()
- conn.addEventListener(TorEventObserver(self.register_event))
- conn.addTorCtlListener(self._register_torctl_event)
-
- gobject.idle_add(self.fill_log)
-
- def pack_widgets(self):
- listStore = self.builder.get_object('liststore_log')
-
- listStore.set_sort_func(1, self._compare_rows)
- listStore.set_sort_column_id(1, gtk.SORT_DESCENDING)
-
- def fill_log(self):
- if time.time() - self._lastUpdate < REFRESH_RATE:
- return
-
- listStore = self.builder.get_object('liststore_log')
- listStore.clear()
-
- self.lock.acquire()
- try:
- for entry in self.msgLog:
- timeLabel = time.strftime('%H:%M:%S', time.localtime(entry.timestamp))
-
- row = (long(entry.timestamp), timeLabel, entry.type, entry.msg, entry.color)
- listStore.append(row)
- finally:
- self.lock.release()
-
- self._lastUpdate = time.time()
-
- def register_event(self, event):
- if not event.type in self.loggedEvents:
- return
-
- self.lock.acquire()
- try:
- self.msgLog.appendleft(event)
- finally:
- self.lock.release()
-
- gobject.idle_add(self.fill_log)
-
- def _register_arm_event(self, level, msg, eventTime):
- theme = gtkTools.Theme()
- eventColor = theme.colors[RUNLEVEL_EVENT_COLOR[level]]
- self.register_event(LogEntry(eventTime, "ARM_%s" % level, msg, eventColor))
-
- def _register_torctl_event(self, level, msg):
- theme = gtkTools.Theme()
- eventColor = theme.colors[RUNLEVEL_EVENT_COLOR[level]]
- self.register_event(LogEntry(time.time(), "TORCTL_%s" % level, msg, eventColor))
-
- def _compare_rows(self, treeModel, iter1, iter2, data=None):
- timestampRaw1 = treeModel.get(iter1, 0)
- timestampRaw2 = treeModel.get(iter2, 0)
-
- return cmp(timestampRaw1, timestampRaw2)
-
diff --git a/src/prereq.py b/src/prereq.py
index c007c8c..f8ab73d 100644
--- a/src/prereq.py
+++ b/src/prereq.py
@@ -14,14 +14,9 @@ import tempfile
# the following mirrors with their sha256 signatures checked.
TORCTL_ARCHIVE = "http://www.atagar.com/arm/resources/deps/11-06-16/torctl.tar.gz"
TORCTL_SIG = "5460adb1394c368ba492cc33d6681618b3d3062b3f5f70b2a87520fc291701c3"
-CAGRAPH_ARCHIVE = "http://www.atagar.com/arm/resources/deps/11-06-10/cagraph.tar.gz"
-CAGRAPH_SIG = "1439acd40ce016f4329deb216d86f36a749e4b8bf73a313a757396af6f95310d"
# optionally we can do an unverified fetch from the library's sources
STEM_REPO = "git://git.torproject.org/stem.git"
-CAGRAPH_TARBALL_URL = "http://cagraph.googlecode.com/files/cagraph-1.2.tar.gz"
-CAGRAPH_TARBALL_NAME = "cagraph-1.2.tar.gz"
-CAGRAPH_TARBALL_ROOT = "cagraph-1.2"
def isTorCtlAvailable():
"""
@@ -45,16 +40,6 @@ def isStemAvailable():
except ImportError:
return False
-def isCagraphAvailable():
- """
- True if cagraph is already available on the platform, false otherwise.
- """
- try:
- import cagraph
- return True
- except ImportError:
- return False
-
def promptTorCtlInstall():
"""
Asks the user to install TorCtl. This returns True if it was installed and
@@ -103,30 +88,6 @@ def promptStemInstall():
print exc
return False
-def promptCagraphInstall():
- """
- Asks the user to install cagraph. This returns True if it was installed and
- False otherwise (if it was either declined or failed to be fetched).
- """
-
- userInput = raw_input("Arm requires cagraph to run, but it's unavailable. Would you like to install it? (y/n): ")
-
- # if user says no then terminate
- if not userInput.lower() in ("y", "yes"): return False
-
- # attempt to install cagraph, printing the issue if unsuccessful
- try:
- fetchLibrary(CAGRAPH_ARCHIVE, CAGRAPH_SIG)
-
- if not isCagraphAvailable():
- raise IOError("Unable to install cagraph, sorry")
-
- print "cagraph successfully installed"
- return True
- except IOError, exc:
- print exc
- return False
-
def fetchLibrary(url, sig):
"""
Downloads the given archive, verifies its signature, then installs the
@@ -191,36 +152,7 @@ def installStem():
# of errors.
shutil.rmtree(tmpFilename, ignore_errors=True)
-def installCagraph():
- """
- Downloads and extracts the cagraph tarball. This raises an IOError if
- unsuccessful.
- """
-
- if isCagraphAvailable(): return
-
- tmpDir = tempfile.mkdtemp()
- tmpFilename = os.path.join(tmpDir, CAGRAPH_TARBALL_NAME)
-
- exitStatus = os.system("wget --quiet -P %s %s" % (tmpDir, CAGRAPH_TARBALL_URL))
- if exitStatus: raise IOError("Unable to fetch cagraph from %s. Is wget installed?" % CAGRAPH_TARBALL_URL)
-
- # the destination for cagraph will be our directory
- ourDir = os.path.dirname(os.path.realpath(__file__))
-
- # exports cagraph to our location
- exitStatus = os.system("(cd %s && tar --strip-components=1 -xzf %s %s/cagraph)" % (ourDir, tmpFilename, CAGRAPH_TARBALL_ROOT))
- if exitStatus: raise IOError("Unable to extract cagraph to %s" % ourDir)
-
- # Clean up the temporary contents. This isn't vital so quietly fails in case
- # of errors.
- shutil.rmtree(tmpDir, ignore_errors=True)
-
-def allPrereq():
- """
- Requrements for both the cli and gui versions of arm.
- """
-
+if __name__ == '__main__':
majorVersion = sys.version_info[0]
minorVersion = sys.version_info[1]
@@ -238,13 +170,6 @@ def allPrereq():
if not isStemAvailable():
isInstalled = promptStemInstall()
if not isInstalled: sys.exit(1)
-
-def cliPrereq():
- """
- Requirements for the cli arm interface.
- """
-
- allPrereq()
try:
import curses
@@ -252,27 +177,3 @@ def cliPrereq():
print("arm requires curses - try installing the python-curses package\n")
sys.exit(1)
-def guiPrereq():
- """
- Requirements for the gui arm interface.
- """
-
- allPrereq()
-
- try:
- import gtk
- except ImportError:
- print("arm requires gtk - try installing the python-gtk2 package\n")
- sys.exit(1)
-
- if not isCagraphAvailable():
- isInstalled = promptCagraphInstall()
- if not isInstalled: sys.exit(1)
-
-if __name__ == '__main__':
- isGui = "-g" in sys.argv or "--gui" in sys.argv
- isBoth = "--both" in sys.argv
-
- if isGui or isBoth: guiPrereq()
- if not isGui or isBoth: cliPrereq()
-
diff --git a/src/starter.py b/src/starter.py
index 1672059..8b2bbb3 100644
--- a/src/starter.py
+++ b/src/starter.py
@@ -58,12 +58,11 @@ CONFIG = {"startup.controlPassword": None,
"log.savingDebugLog": util.log.NOTICE}
OPT = "gpi:s:c:dbe:vh"
-OPT_EXPANDED = ["gui", "prompt", "interface=", "socket=", "config=", "debug", "blind", "event=", "version", "help"]
+OPT_EXPANDED = ["prompt", "interface=", "socket=", "config=", "debug", "blind", "event=", "version", "help"]
HELP_MSG = """Usage arm [OPTION]
Terminal status monitor for Tor relays.
- -g, --gui launch the Gtk+ interface
-p, --prompt only start the control interpretor
-i, --interface [ADDRESS:]PORT change control interface from %s:%i
-s, --socket SOCKET_PATH attach using unix domain socket if present,
@@ -364,7 +363,6 @@ def _dumpConfig():
if __name__ == '__main__':
startTime = time.time()
param = dict([(key, None) for key in CONFIG.keys()])
- launchGui = False
launchPrompt = False
isDebugMode = False
configPath = DEFAULT_CONFIG # path used for customized configuration
@@ -396,7 +394,6 @@ if __name__ == '__main__':
param["startup.interface.port"] = controlPort
elif opt in ("-s", "--socket"):
param["startup.interface.socket"] = arg
- elif opt in ("-g", "--gui"): launchGui = True
elif opt in ("-p", "--prompt"): launchPrompt = True
elif opt in ("-c", "--config"): configPath = arg # sets path of user's config
elif opt in ("-d", "--debug"): isDebugMode = True # dumps all logs
@@ -587,10 +584,7 @@ if __name__ == '__main__':
if util.uiTools.isUnicodeAvailable():
locale.setlocale(locale.LC_ALL, "")
- if launchGui:
- import gui.controller
- gui.controller.start_gui()
- elif launchPrompt:
+ if launchPrompt:
util.torInterpretor.showPrompt()
else:
cli.controller.startTorMonitor(time.time() - initTime)
1
0
commit 626e16ce684814807eb25d418f3eb33e4981e30f
Author: Damian Johnson <atagar(a)torproject.org>
Date: Sat Dec 15 19:59:20 2012 -0800
Missing stem import
We were missing an import for stem. This was fine until we hit an exception
condition...
Traceback (most recent call last):
File "./src/starter.py", line 590, in <module>
cli.controller.startTorMonitor(time.time() - initTime)
File "/home/atagar/Desktop/arm/src/cli/controller.py", line 705, in startTorMonitor
curses.wrapper(drawTorMonitor, startTime)
File "/usr/lib/python2.7/curses/wrapper.py", line 43, in wrapper
return func(stdscr, *args, **kwds)
File "/home/atagar/Desktop/arm/src/cli/controller.py", line 761, in drawTorMonitor
control.redraw(False)
File "/home/atagar/Desktop/arm/src/cli/controller.py", line 351, in redraw
panelImpl.redraw(force)
File "/home/atagar/Desktop/arm/src/util/panel.py", line 408, in redraw
self.draw(self.maxX, self.maxY)
File "/home/atagar/Desktop/arm/src/cli/connections/connPanel.py", line 388, in draw
drawEntry = entryLine.getListingEntry(width - scrollOffset - len(prefix), currentTime, self._listingType)
File "/home/atagar/Desktop/arm/src/cli/connections/connEntry.py", line 290, in getListingEntry
myListing = entries.ConnectionPanelLine.getListingEntry(self, width, currentTime, listingType)
File "/home/atagar/Desktop/arm/src/cli/connections/entries.py", line 136, in getListingEntry
self._listingCache = self._getListingEntry(width, currentTime, listingType)
File "/home/atagar/Desktop/arm/src/cli/connections/connEntry.py", line 324, in _getListingEntry
(self._getListingContent(width - (12 + timeWidth) - 1, listingType), lineFormat),
File "/home/atagar/Desktop/arm/src/cli/connections/connEntry.py", line 608, in _getListingContent
etc = self.getEtcContent(width - usedSpace, listingType)
File "/home/atagar/Desktop/arm/src/cli/connections/connEntry.py", line 482, in getEtcContent
nicknameLabel = uiTools.cropStr(self.foreign.getNickname(), nicknameSpace, 0)
File "/home/atagar/Desktop/arm/src/cli/connections/connEntry.py", line 139, in getNickname
myFingerprint = self.getFingerprint()
File "/home/atagar/Desktop/arm/src/cli/connections/connEntry.py", line 123, in getFingerprint
myFingerprint = conn.getRelayFingerprint(self.ipAddr)
File "/home/atagar/Desktop/arm/src/util/torTools.py", line 1228, in getRelayFingerprint
relayFingerprint = self._getRelayFingerprint(relayAddress, relayPort)
File "/home/atagar/Desktop/arm/src/util/torTools.py", line 1874, in _getRelayFingerprint
if relayAddress == self.getInfo("address", None):
File "/home/atagar/Desktop/arm/src/util/torTools.py", line 727, in getInfo
except stem.SocketClosed, exc:
NameError: global name 'stem' is not defined
---
src/util/torTools.py | 1 +
1 files changed, 1 insertions(+), 0 deletions(-)
diff --git a/src/util/torTools.py b/src/util/torTools.py
index 6d7f4d0..92d2cf0 100644
--- a/src/util/torTools.py
+++ b/src/util/torTools.py
@@ -12,6 +12,7 @@ import thread
import threading
import Queue
+import stem
from TorCtl import TorCtl
from util import connections, enum, log, procTools, sysTools, uiTools
1
0
commit 2744f7559ffc89857cb31bd42b0dfeaaef1331bb
Author: Damian Johnson <atagar(a)torproject.org>
Date: Wed Dec 12 09:18:11 2012 -0800
Dropping arm's getOptionMap method
The only user of arm's getOptionMap method is... well, the controller wrapper
itself. Changed that call to use stem and dropping our method.
---
src/util/torTools.py | 41 +----------------------------------------
1 files changed, 1 insertions(+), 40 deletions(-)
diff --git a/src/util/torTools.py b/src/util/torTools.py
index c380679..4f89b64 100644
--- a/src/util/torTools.py
+++ b/src/util/torTools.py
@@ -762,45 +762,6 @@ class Controller(TorCtl.PostEventListener):
finally:
self.connLock.release()
- def getOptionMap(self, param, default = UNDEFINED):
- """
- Queries the control port for the given configuration option, providing back
- a mapping of config options to a list of the values returned.
-
- There's three use cases for GETCONF:
- - a single value is provided
- - multiple values are provided for the option queried
- - a set of options that weren't necessarily requested are returned (for
- instance querying HiddenServiceOptions gives HiddenServiceDir,
- HiddenServicePort, etc)
-
- The vast majority of the options fall into the first two catagories, in
- which case calling getOption is sufficient. However, for the special
- options that give a set of values this provides back the full response. As
- of tor version 0.2.1.25 HiddenServiceOptions was the only option like this.
-
- The getOption function accounts for these special mappings, and the only
- advantage to this funtion is that it provides all related values in a
- single response.
-
- Arguments:
- param - configuration option to be queried
- default - result if the query fails
- """
-
- self.connLock.acquire()
-
- try:
- if default != UNDEFINED:
- return self.controller.get_conf_map(param, default)
- else:
- return self.controller.get_conf_map(param)
- except stem.SocketClosed, exc:
- self.close()
- raise exc
- finally:
- self.connLock.release()
-
def setOption(self, param, value = None):
"""
Issues a SETCONF to set the given option/value pair. An exeptions raised
@@ -2301,7 +2262,7 @@ class Controller(TorCtl.PostEventListener):
result.append((int(lineComp[0]), lineComp[1], lineComp[3][8:], tuple(path)))
elif key == "hsPorts":
result = []
- hsOptions = self.getOptionMap("HiddenServiceOptions", None)
+ hsOptions = self.controller.get_conf_map("HiddenServiceOptions", None)
if hsOptions and "HiddenServicePort" in hsOptions:
for hsEntry in hsOptions["HiddenServicePort"]:
1
0
commit 9d98824f01547f91abc1e8ededd6a8a927ba533d
Author: Damian Johnson <atagar(a)torproject.org>
Date: Sat Dec 15 19:55:50 2012 -0800
Using stem's set_options()
Dropping our SETCONF implementation in favor of stem's.
---
armrc.sample | 5 ---
src/util/torTools.py | 74 +++++++++-----------------------------------------
2 files changed, 13 insertions(+), 66 deletions(-)
diff --git a/armrc.sample b/armrc.sample
index 8447134..1b264f7 100644
--- a/armrc.sample
+++ b/armrc.sample
@@ -272,11 +272,6 @@ log.configEntryNotFound NONE
log.configEntryUndefined NOTICE
log.configEntryTypeError NOTICE
log.torCtlPortClosed NOTICE
-log.torGetInfo DEBUG
-log.torGetInfoCache NONE
-log.torGetConf DEBUG
-log.torGetConfCache NONE
-log.torSetConf INFO
log.torEventTypeUnrecognized INFO
log.torPrefixPathInvalid NOTICE
log.procCallMade DEBUG
diff --git a/src/util/torTools.py b/src/util/torTools.py
index 4f89b64..6d7f4d0 100644
--- a/src/util/torTools.py
+++ b/src/util/torTools.py
@@ -52,11 +52,6 @@ UNDEFINED = "<Undefined_ >"
UNKNOWN = "UNKNOWN" # value used by cached information if undefined
CONFIG = {"features.pathPrefix": "",
"log.torCtlPortClosed": log.NOTICE,
- "log.torGetInfo": log.DEBUG,
- "log.torGetInfoCache": None,
- "log.torGetConf": log.DEBUG,
- "log.torGetConfCache": None,
- "log.torSetConf": log.INFO,
"log.torPrefixPathInvalid": log.NOTICE,
"log.bsdJailFound": log.INFO,
"log.unknownBsdJailId": log.WARN}
@@ -793,62 +788,19 @@ class Controller(TorCtl.PostEventListener):
self.connLock.acquire()
- # constructs the SETCONF string
- setConfComp = []
-
- for param, value in paramList:
- if isinstance(value, list) or isinstance(value, tuple):
- setConfComp += ["%s=\"%s\"" % (param, val.strip()) for val in value]
- elif value:
- setConfComp.append("%s=\"%s\"" % (param, value.strip()))
- else:
- setConfComp.append(param)
-
- setConfStr = " ".join(setConfComp)
-
- startTime, raisedExc = time.time(), None
- if self.isAlive():
- try:
- if isReset:
- self.conn.sendAndRecv("RESETCONF %s\r\n" % setConfStr)
- else:
- self.conn.sendAndRecv("SETCONF %s\r\n" % setConfStr)
-
- # flushing cached values (needed until we can detect SETCONF calls)
- for param, _ in paramList:
- for fetchType in ("str", "list", "map"):
- entry = (param.lower(), fetchType)
-
- # special caches for the exit policy
- if param.lower() == "exitpolicy":
- self._exitPolicyChecker = self.getExitPolicy()
- self._isExitingAllowed = self._exitPolicyChecker.isExitingAllowed()
- self._exitPolicyLookupCache = {}
- except (socket.error, TorCtl.ErrorReply, TorCtl.TorCtlClosed), exc:
- if type(exc) == TorCtl.TorCtlClosed: self.close()
- elif type(exc) == TorCtl.ErrorReply:
- excStr = str(exc)
- if excStr.startswith("513 Unacceptable option value: "):
- # crops off the common error prefix
- excStr = excStr[31:]
-
- # Truncates messages like:
- # Value 'BandwidthRate la de da' is malformed or out of bounds.
- # to: Value 'la de da' is malformed or out of bounds.
- if excStr.startswith("Value '"):
- excStr = excStr.replace("%s " % param, "", 1)
-
- exc = TorCtl.ErrorReply(excStr)
-
- raisedExc = exc
-
- self.connLock.release()
-
- excLabel = "failed: \"%s\", " % raisedExc if raisedExc else ""
- msg = "SETCONF %s (%sruntime: %0.4f)" % (setConfStr, excLabel, time.time() - startTime)
- log.log(CONFIG["log.torSetConf"], msg)
-
- if raisedExc: raise raisedExc
+ try:
+ # clears our exit policy chache if it's changing
+ if "exitpolicy" in [k.lower() for (k, v) in paramList]:
+ self._exitPolicyChecker = self.getExitPolicy()
+ self._isExitingAllowed = self._exitPolicyChecker.isExitingAllowed()
+ self._exitPolicyLookupCache = {}
+
+ self.controller.set_options(paramList, isReset)
+ except stem.SocketClosed, exc:
+ self.close()
+ raise exc
+ finally:
+ self.connLock.release()
def sendNewnym(self):
"""
1
0
commit 655bb18e2c21ea21c34d2ad444ac2e0e820d9f93
Author: Damian Johnson <atagar(a)torproject.org>
Date: Sun Dec 16 13:29:54 2012 -0800
Calling stem for NEWNYM signals
Replacing the TorCtl NEWNYM call with stem.
---
src/util/torTools.py | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/src/util/torTools.py b/src/util/torTools.py
index 79b4e70..7657dcb 100644
--- a/src/util/torTools.py
+++ b/src/util/torTools.py
@@ -828,7 +828,7 @@ class Controller(TorCtl.PostEventListener):
if self.isAlive():
self._lastNewnym = time.time()
- self.conn.send_signal("NEWNYM")
+ self.controller.signal(stem.Signal.NEWNYM)
self.connLock.release()
1
0
commit edc2447b4b3a2b01ef2b2314edf72478d8f7ac0c
Author: Damian Johnson <atagar(a)torproject.org>
Date: Sun Dec 16 11:32:12 2012 -0800
Stem calls lacked an isAlive() check
When arm's controller is detached its 'conn' and 'controller' attributes are
None. This means that all of our function calls need an isAlive() check before
using them...
atagar@morrigan:~/Desktop/arm$ ./arm
Traceback (most recent call last):
File "./src/starter.py", line 566, in <module>
_loadConfigurationDescriptions(pathPrefix)
File "./src/starter.py", line 162, in _loadConfigurationDescriptions
util.torConfig.loadOptionDescriptions(descriptorPath)
File "/home/atagar/Desktop/arm/src/util/torConfig.py", line 137, in loadOptionDescriptions
torVersion = torTools.getConn().getInfo("version", "")
File "/home/atagar/Desktop/arm/src/util/torTools.py", line 725, in getInfo
return self.controller.get_info(param, default)
AttributeError: 'NoneType' object has no attribute 'get_info'
Ideally we'd just drop arm's controller and use stem's (which has its own
locks and check for this), but that'll need to come later.
---
src/util/torTools.py | 15 +++++++++++++++
1 files changed, 15 insertions(+), 0 deletions(-)
diff --git a/src/util/torTools.py b/src/util/torTools.py
index 92d2cf0..79b4e70 100644
--- a/src/util/torTools.py
+++ b/src/util/torTools.py
@@ -721,6 +721,12 @@ class Controller(TorCtl.PostEventListener):
self.connLock.acquire()
try:
+ if not self.isAlive():
+ if default != UNDEFINED:
+ return default
+ else:
+ raise stem.SocketClosed()
+
if default != UNDEFINED:
return self.controller.get_info(param, default)
else:
@@ -748,6 +754,12 @@ class Controller(TorCtl.PostEventListener):
self.connLock.acquire()
try:
+ if not self.isAlive():
+ if default != UNDEFINED:
+ return default
+ else:
+ raise stem.SocketClosed()
+
if default != UNDEFINED:
return self.controller.get_conf(param, default, multiple)
else:
@@ -790,6 +802,9 @@ class Controller(TorCtl.PostEventListener):
self.connLock.acquire()
try:
+ if not self.isAlive():
+ raise stem.SocketClosed()
+
# clears our exit policy chache if it's changing
if "exitpolicy" in [k.lower() for (k, v) in paramList]:
self._exitPolicyChecker = self.getExitPolicy()
1
0
17 Dec '12
commit a40adf7aabbcd063d5def876ee7c9ea46fb5ae67
Author: Damian Johnson <atagar(a)torproject.org>
Date: Sun Dec 16 13:49:16 2012 -0800
Replacing tor version handling with stem's
Stem has really good support for parsing and comparing tor versions. Using that
instead of our home brewed counterpart.
---
src/cli/wizard.py | 18 ++++-----
src/util/torConfig.py | 11 ++---
src/util/torTools.py | 98 ++++++-------------------------------------------
3 files changed, 24 insertions(+), 103 deletions(-)
diff --git a/src/cli/wizard.py b/src/cli/wizard.py
index 86522d1..02a1f17 100644
--- a/src/cli/wizard.py
+++ b/src/cli/wizard.py
@@ -16,6 +16,8 @@ import curses
import cli.popups
import cli.controller
+import stem.version
+
from util import connections, enum, log, sysTools, torConfig, torTools, uiTools
# template used to generate the torrc
@@ -94,7 +96,9 @@ BRACKETS = ((' ', ' '),
('|', '|'))
# version requirements for options
-VERSION_REQUIREMENTS = {Options.PORTFORWARD: "0.2.3.1-alpha"}
+VERSION_REQUIREMENTS = {
+ Options.PORTFORWARD: stem.version.Requirement.TORRC_PORT_FORWARDING,
+}
# tor's defaults for config options, used to filter unneeded options
TOR_DEFAULTS = {Options.BANDWIDTH: "5 MB",
@@ -245,16 +249,10 @@ def showWizard():
log.log(log.WARN, msg)
return
- # gets tor's version
- torVersion = None
try:
- versionQuery = sysTools.call("tor --version")
-
- for line in versionQuery:
- if line.startswith("Tor version "):
- torVersion = torTools.parseVersion(line.split(" ")[2])
- break
+ torVersion = stem.version.get_system_tor_version()
except IOError, exc:
+ torVersion = None
log.log(log.INFO, "'tor --version' query failed: %s" % exc)
relayType, config = None, {}
@@ -316,7 +314,7 @@ def showWizard():
disabledOpt = list(CONFIG["wizard.disabled"])
for opt, optVersion in VERSION_REQUIREMENTS.items():
- if not torVersion or not torTools.isVersion(torVersion, torTools.parseVersion(optVersion)):
+ if torVersion is None or not torVersion.meets_requirements(optVersion):
disabledOpt.append(opt)
# the port forwarding option would only work if tor-fw-helper is in the path
diff --git a/src/util/torConfig.py b/src/util/torConfig.py
index 783fa84..fc08393 100644
--- a/src/util/torConfig.py
+++ b/src/util/torConfig.py
@@ -7,6 +7,8 @@ import time
import socket
import threading
+import stem.version
+
from util import enum, log, sysTools, torTools, uiTools
CONFIG = {"features.torrc.validate": True,
@@ -791,16 +793,11 @@ class Torrc():
self.valsLock.acquire()
- # The torrc validation relies on 'GETINFO config-text' which was
- # introduced in tor 0.2.2.7-alpha so if we're using an earlier version
- # (or configured to skip torrc validation) then this is a no-op. For more
- # information see:
- # https://trac.torproject.org/projects/tor/ticket/2501
-
if not self.isLoaded(): returnVal = None
else:
+ torVersion = torTools.getConn().getVersion()
skipValidation = not CONFIG["features.torrc.validate"]
- skipValidation |= not torTools.getConn().isVersion("0.2.2.7-alpha")
+ skipValidation |= (torVersion is None or not torVersion.meets_requirements(stem.version.Requirement.GETINFO_CONFIG_TEXT))
if skipValidation:
log.log(log.INFO, "Skipping torrc validation (requires tor 0.2.2.7-alpha)")
diff --git a/src/util/torTools.py b/src/util/torTools.py
index 7657dcb..5eb04ad 100644
--- a/src/util/torTools.py
+++ b/src/util/torTools.py
@@ -256,64 +256,6 @@ def getBsdJailId():
log.log(CONFIG["log.unknownBsdJailId"], "Failed to figure out the FreeBSD jail id. Assuming 0.")
return 0
-def parseVersion(versionStr):
- """
- Parses the given version string into its expected components, for instance...
- '0.2.2.13-alpha (git-feb8c1b5f67f2c6f)'
-
- would provide:
- (0, 2, 2, 13, 'alpha')
-
- If the input isn't recognized then this returns None.
-
- Arguments:
- versionStr - version string to be parsed
- """
-
- # crops off extra arguments, for instance:
- # '0.2.2.13-alpha (git-feb8c1b5f67f2c6f)' -> '0.2.2.13-alpha'
- versionStr = versionStr.split()[0]
-
- result = None
- if versionStr.count(".") in (2, 3):
- # parses the optional suffix ('alpha', 'release', etc)
- if versionStr.count("-") == 1:
- versionStr, versionSuffix = versionStr.split("-")
- else: versionSuffix = ""
-
- # Parses the numeric portion of the version. This can have three or four
- # entries depending on if an optional patch level was provided.
- try:
- versionComp = [int(entry) for entry in versionStr.split(".")]
- if len(versionComp) == 3: versionComp += [0]
- result = tuple(versionComp + [versionSuffix])
- except ValueError: pass
-
- return result
-
-def isVersion(myVersion, minVersion):
- """
- Checks if the given version meets a given minimum. Both arguments are
- expected to be version tuples. To get this from a version string use the
- parseVersion function.
-
- Arguments:
- myVersion - tor version tuple
- minVersion - version tuple to be checked against
- """
-
- if myVersion[:4] == minVersion[:4]:
- return True # versions match
- else:
- # compares each of the numeric portions of the version
- for i in range(4):
- myVal, minVal = myVersion[i], minVersion[i]
-
- if myVal > minVal: return True
- elif myVal < minVal: return False
-
- return True # versions match (should have been caught above...)
-
def isTorRunning():
"""
Simple check for if a tor process is running. If this can't be determined
@@ -959,39 +901,23 @@ class Controller(TorCtl.PostEventListener):
return self._getRelayAttr("flags", default)
- def isVersion(self, minVersionStr):
+ def getVersion(self):
"""
- Checks if we meet the given version. Recognized versions are of the form:
- <major>.<minor>.<micro>[.<patch>][-<status_tag>]
-
- for instance, "0.2.2.13-alpha" or "0.2.1.5". This raises a ValueError if
- the input isn't recognized, and returns False if unable to fetch our
- instance's version.
-
- According to the spec the status_tag is purely informal, so it's ignored
- in comparisons.
-
- Arguments:
- minVersionStr - version to be compared against
+ Provides the version of our tor instance, this is None if we don't have a
+ connection.
"""
- minVersion = parseVersion(minVersionStr)
-
- if minVersion == None:
- raise ValueError("unrecognized version: %s" % minVersionStr)
-
self.connLock.acquire()
- result = False
- if self.isAlive():
- myVersion = parseVersion(self.getInfo("version", ""))
-
- if not myVersion: result = False
- else: result = isVersion(myVersion, minVersion)
-
- self.connLock.release()
-
- return result
+ try:
+ return self.controller.get_version()
+ except stem.SocketClosed, exc:
+ self.close()
+ return None
+ except:
+ return None
+ finally:
+ self.connLock.release()
def isGeoipUnavailable(self):
"""
1
0
commit 7f295fe63f60c221bce6a9fa28ff6b713ea656c7
Author: Damian Johnson <atagar(a)torproject.org>
Date: Sun Dec 16 18:32:15 2012 -0800
Using stem's event handling
Replacing TorCtl event handling with stem's. This includes a few changes...
* Dropped some of the custom messaging for event types. On the down side those
messages might have been a tad more user friendly. On the up side we'll now
provide the full event message content rather than hiding things that we
don't recognize. Personally I consider this to be a net good thing. We can
add a user friendly str() for Events if we want a better rendering.
* We no longer support listener reattachment. This is because stem itself
provides reattachment but we've broken it by misusing the Controller class.
We're constructing fresh Controller instances rather than reusing the one we
made priorly - when this is fixed we'll have reattachment again.
* The interpretor panel no longer supports SETEVENTS nor event listening. It
took some pretty ugly hacks to make it work in the first place, and I'm not
very inclined to redo these hacks with stem. Besides, we'll probably be
splintering the interpretor panel into its own application for ticket #6439.
---
src/cli/graphing/graphPanel.py | 9 +-
src/cli/logPanel.py | 185 ++++++++++++++------------------------
src/util/torInterpretor.py | 17 ++--
src/util/torTools.py | 196 +++++++++-------------------------------
4 files changed, 120 insertions(+), 287 deletions(-)
diff --git a/src/cli/graphing/graphPanel.py b/src/cli/graphing/graphPanel.py
index 76221ff..d03d1bd 100644
--- a/src/cli/graphing/graphPanel.py
+++ b/src/cli/graphing/graphPanel.py
@@ -18,11 +18,12 @@ Downloaded (0.0 B/sec): Uploaded (0.0 B/sec):
import copy
import curses
-from TorCtl import TorCtl
import cli.popups
import cli.controller
+import stem.control
+
from util import enum, panel, torTools, uiTools
# time intervals at which graphs can be updated
@@ -56,7 +57,7 @@ def loadConfig(config):
"features.graph.interval": (0, len(UPDATE_INTERVALS) - 1),
"features.graph.bound": (0, 2)})
-class GraphStats(TorCtl.PostEventListener):
+class GraphStats:
"""
Module that's expected to update dynamically and provide attributes to be
graphed. Up to two graphs (a 'primary' and 'secondary') can be displayed at a
@@ -68,8 +69,6 @@ class GraphStats(TorCtl.PostEventListener):
Initializes parameters needed to present a graph.
"""
- TorCtl.PostEventListener.__init__(self)
-
# panel to be redrawn when updated (set when added to GraphPanel)
self._graphPanel = None
self.isSelected = False
@@ -96,7 +95,7 @@ class GraphStats(TorCtl.PostEventListener):
self.secondaryCounts[i] = (self.maxCol + 1) * [0]
# tracks BW events
- torTools.getConn().addEventListener(self)
+ torTools.getConn().addEventListener(self.bandwidth_event, stem.control.EventType.BW)
def clone(self, newCopy=None):
"""
diff --git a/src/cli/logPanel.py b/src/cli/logPanel.py
index ee7dee1..b866c62 100644
--- a/src/cli/logPanel.py
+++ b/src/cli/logPanel.py
@@ -11,9 +11,8 @@ import curses
import logging
import threading
-from TorCtl import TorCtl
-
import stem.util.log
+from stem.response import events
import popups
from version import VERSION
@@ -35,7 +34,7 @@ EVENT_LISTING = """ d DEBUG a ADDRMAP k DESCCHANGED s ST
j CLIENTS_SEEN q ORCONN
DINWE tor runlevel+ A All Events
12345 arm runlevel+ X No Events
- 67890 torctl runlevel+ U Unknown Events"""
+ U Unknown Events"""
RUNLEVEL_EVENT_COLOR = {log.DEBUG: "magenta", log.INFO: "blue", log.NOTICE: "green",
log.WARN: "yellow", log.ERR: "red"}
@@ -155,7 +154,7 @@ def expandEvents(eventAbbr):
def getMissingEventTypes():
"""
- Provides the event types the current torctl connection supports but arm
+ Provides the event types the current tor connection supports but arm
doesn't. This provides an empty list if no event types are missing, and None
if the GETINFO query fails.
"""
@@ -168,28 +167,6 @@ def getMissingEventTypes():
return [event for event in torEventTypes if not event in armEventTypes]
else: return None # GETINFO call failed
-def setEventListening(events):
- """
- Configures the events Tor listens for, filtering non-tor events from what we
- request from the controller. This returns a sorted list of the events we
- successfully set.
-
- Arguments:
- events - event types to attempt to set
- """
-
- events = set(events) # drops duplicates
- torEvents = events.intersection(set(TOR_EVENT_TYPES.values()))
-
- # adds events unrecognized by arm if we're listening to the 'UNKNOWN' type
- if "UNKNOWN" in events:
- torEvents.update(set(getMissingEventTypes()))
-
- setEvents = torTools.getConn().setControllerEvents(list(torEvents))
-
- # provides back the input set minus events we failed to set
- return sorted(events.difference(torTools.FAILED_EVENTS))
-
def loadLogMessages():
"""
Fetches a mapping of common log messages to their runlevels from the config.
@@ -491,95 +468,9 @@ class LogEntry():
return self._displayMessage
-class TorEventObserver(TorCtl.PostEventListener):
- """
- Listens for all types of events provided by TorCtl, providing an LogEntry
- instance to the given callback function.
- """
-
- def __init__(self, callback):
- """
- Tor event listener with the purpose of translating events to nicely
- formatted calls of a callback function.
-
- Arguments:
- callback - function accepting a LogEntry, called when an event of these
- types occur
- """
-
- TorCtl.PostEventListener.__init__(self)
- self.callback = callback
-
- def circ_status_event(self, event):
- msg = "ID: %-3s STATUS: %-10s PATH: %s" % (event.circ_id, event.status, ", ".join(event.path))
- if event.purpose: msg += " PURPOSE: %s" % event.purpose
- if event.reason: msg += " REASON: %s" % event.reason
- if event.remote_reason: msg += " REMOTE_REASON: %s" % event.remote_reason
- self._notify(event, msg, "yellow")
-
- def buildtimeout_set_event(self, event):
- self._notify(event, "SET_TYPE: %s, TOTAL_TIMES: %s, TIMEOUT_MS: %s, XM: %s, ALPHA: %s, CUTOFF_QUANTILE: %s" % (event.set_type, event.total_times, event.timeout_ms, event.xm, event.alpha, event.cutoff_quantile))
-
- def stream_status_event(self, event):
- self._notify(event, "ID: %s STATUS: %s CIRC_ID: %s TARGET: %s:%s REASON: %s REMOTE_REASON: %s SOURCE: %s SOURCE_ADDR: %s PURPOSE: %s" % (event.strm_id, event.status, event.circ_id, event.target_host, event.target_port, event.reason, event.remote_reason, event.source, event.source_addr, event.purpose))
-
- def or_conn_status_event(self, event):
- msg = "STATUS: %-10s ENDPOINT: %-20s" % (event.status, event.endpoint)
- if event.reason: msg += " REASON: %-6s" % event.reason
- if event.ncircs: msg += " NCIRCS: %i" % event.ncircs
- self._notify(event, msg)
-
- def stream_bw_event(self, event):
- self._notify(event, "ID: %s READ: %s WRITTEN: %s" % (event.strm_id, event.bytes_read, event.bytes_written))
-
- def bandwidth_event(self, event):
- self._notify(event, "READ: %i, WRITTEN: %i" % (event.read, event.written), "cyan")
-
- def msg_event(self, event):
- self._notify(event, event.msg, RUNLEVEL_EVENT_COLOR[event.level])
-
- def new_desc_event(self, event):
- idlistStr = [str(item) for item in event.idlist]
- self._notify(event, ", ".join(idlistStr))
-
- def address_mapped_event(self, event):
- whenLabel, gmtExpiryLabel = "", ""
-
- if event.when:
- whenLabel = time.strftime("%H:%M %m/%d/%Y", event.when)
-
- # TODO: torctl is getting an 'error' and 'gmt_expiry' attribute so display
- # those when they become available
- #
- #if event.gmt_expiry:
- # gmtExpiryLabel = time.strftime("%H:%M %m/%d/%Y", event.gmt_expiry)
-
- self._notify(event, "%s, %s -> %s" % (whenLabel, event.from_addr, event.to_addr))
-
- def ns_event(self, event):
- # NetworkStatus params: nickname, idhash, orhash, ip, orport (int),
- # dirport (int), flags, idhex, bandwidth, updated (datetime)
- msg = ", ".join(["%s (%s)" % (ns.idhex, ns.nickname) for ns in event.nslist])
- self._notify(event, "Listed (%i): %s" % (len(event.nslist), msg), "blue")
-
- def new_consensus_event(self, event):
- msg = ", ".join(["%s (%s)" % (ns.idhex, ns.nickname) for ns in event.nslist])
- self._notify(event, "Listed (%i): %s" % (len(event.nslist), msg), "magenta")
-
- def guard_event(self, event):
- msg = "%s (%s), STATUS: %s" % (event.idhex, event.nick, event.status)
- self._notify(event, msg, "yellow")
-
- def unknown_event(self, event):
- msg = "(%s) %s" % (event.event_name, event.event_string)
- self.callback(LogEntry(event.arrived_at, "UNKNOWN", msg, "red"))
-
- def _notify(self, event, msg, color="white"):
- self.callback(LogEntry(event.arrived_at, event.event_name, msg, color))
-
class LogPanel(panel.Panel, threading.Thread, logging.Handler):
"""
- Listens for and displays tor, arm, and torctl events. This can prepopulate
+ Listens for and displays tor, arm, and stem events. This can prepopulate
from tor's log file if it exists.
"""
@@ -626,13 +517,14 @@ class LogPanel(panel.Panel, threading.Thread, logging.Handler):
# collapses duplicate log entries if false, showing only the most recent
self.showDuplicates = self._config["features.log.showDuplicateEntries"]
+ self.loggedEvents = [] # needs to be set before we receive any events
+
# restricts the input to the set of events we can listen to, and
# configures the controller to liten to them
- loggedEvents = setEventListening(loggedEvents)
+ self.loggedEvents = self.setEventListening(loggedEvents)
self.setPauseAttr("msgLog") # tracks the message log when we're paused
self.msgLog = [] # log entries, sorted by the timestamp
- self.loggedEvents = loggedEvents # events we're listening to
self.regexFilter = None # filter for presented log events (no filtering if None)
self.lastContentHeight = 0 # height of the rendered content when last drawn
self.logFile = None # file log messages are saved to (skipped if None)
@@ -666,9 +558,8 @@ class LogPanel(panel.Panel, threading.Thread, logging.Handler):
# leaving lastContentHeight as being too low causes initialization problems
self.lastContentHeight = len(self.msgLog)
- # adds listeners for tor and torctl events
+ # adds listeners for tor and stem events
conn = torTools.getConn()
- conn.addEventListener(TorEventObserver(self.registerEvent))
conn.addStatusListener(self._resetListener)
# opens log file if we'll be saving entries
@@ -750,6 +641,33 @@ class LogPanel(panel.Panel, threading.Thread, logging.Handler):
self.showDuplicates = isVisible
+ def registerTorEvent(self, event):
+ """
+ Translates a stem.response.event.Event instance into a LogEvent, and calls
+ registerEvent().
+ """
+
+ msg, color = ' '.join(str(event).split(' ')[1:]), "white"
+
+ if isinstance(event, events.CircuitEvent):
+ color = "yellow"
+ elif isinstance(event, events.BandwidthEvent):
+ color = "cyan"
+ msg = "READ: %i, WRITTEN: %i" % (event.read, event.written)
+ elif isinstance(event, events.LogEvent):
+ color = RUNLEVEL_EVENT_COLOR[event.runlevel]
+ msg = event.message
+ elif isinstance(event, events.NetworkStatusEvent):
+ color = "blue"
+ elif isinstance(event, events.NewConsensusEvent):
+ color = "magenta"
+ elif isinstance(event, events.GuardEvent):
+ color = "yellow"
+ elif not event.type in TOR_EVENT_TYPES.values():
+ color = "red" # unknown event type
+
+ self.registerEvent(LogEntry(event.arrived_at, event.type, msg, color))
+
def registerEvent(self, event):
"""
Notes event and redraws log. If paused it's held in a temporary buffer.
@@ -801,7 +719,7 @@ class LogPanel(panel.Panel, threading.Thread, logging.Handler):
# configures the controller to listen for these tor events, and provides
# back a subset without anything we're failing to listen to
- setTypes = setEventListening(eventTypes)
+ setTypes = self.setEventListening(eventTypes)
self.loggedEvents = setTypes
self.redraw(True)
self.valsLock.release()
@@ -1217,6 +1135,35 @@ class LogPanel(panel.Panel, threading.Thread, logging.Handler):
self._cond.notifyAll()
self._cond.release()
+ def setEventListening(self, events):
+ """
+ Configures the events Tor listens for, filtering non-tor events from what we
+ request from the controller. This returns a sorted list of the events we
+ successfully set.
+
+ Arguments:
+ events - event types to attempt to set
+ """
+
+ events = set(events) # drops duplicates
+ torEvents = events.intersection(set(TOR_EVENT_TYPES.values()))
+
+ # adds events unrecognized by arm if we're listening to the 'UNKNOWN' type
+ if "UNKNOWN" in events:
+ torEvents.update(set(getMissingEventTypes()))
+
+ torConn = torTools.getConn()
+ torConn.removeEventListener(self.registerTorEvent)
+
+ for eventType in list(torEvents):
+ try:
+ torConn.addEventListener(self.registerTorEvent, eventType)
+ except stem.ProtocolError:
+ torEvents.remove(eventType)
+
+ # provides back the input set minus events we failed to set
+ return sorted(torEvents)
+
def _resetListener(self, _, eventType):
# if we're attaching to a new tor instance then clears the log and
# prepopulates it with the content belonging to this instance
@@ -1257,7 +1204,7 @@ class LogPanel(panel.Panel, threading.Thread, logging.Handler):
labelPattern = uiTools.cropStr(currentPattern, width - 18)
panelLabel = "Events (filter: %s):" % labelPattern
else:
- # does the following with all runlevel types (tor, arm, and torctl):
+ # does the following with all runlevel types (tor, arm, and stem):
# - pulls to the start of the list
# - condenses range if there's three or more in a row (ex. "ARM_INFO - WARN")
# - condense further if there's identical runlevel ranges for multiple
diff --git a/src/util/torInterpretor.py b/src/util/torInterpretor.py
index 674e5e2..5023045 100644
--- a/src/util/torInterpretor.py
+++ b/src/util/torInterpretor.py
@@ -11,12 +11,6 @@ import version
import stem
-# TODO: util should never import from the cli. This is being done as a hack to
-# simplify event listening, but we should later move the TorEventObserver into
-# the util.
-
-from cli.logPanel import TorEventObserver
-
from util import connections, enum, hostnames, torConfig, torTools, uiTools
COLOR_PROMPT = True # provides a colored interpretor prompt
@@ -445,7 +439,12 @@ class ControlInterpretor:
self.eventBuffer = [] # unread event messages
self.loggedEvents = [] # event types that we're listening for
- torTools.getConn().addEventListener(TorEventObserver(self.registerEvent))
+ # TODO: Dropping event listening since...
+ # a. it was a complete hack
+ # b. said hack isn't worth porting to stem
+ # c. I'm likely about to separate the interpretor from arm anyway
+
+ #torTools.getConn().addEventListener(TorEventObserver(self.registerEvent))
def registerEvent(self, event):
"""
@@ -913,8 +912,10 @@ class ControlInterpretor:
except Exception, exc:
outputEntry.append((str(exc), ERROR_FORMAT))
elif cmd == "SETEVENTS":
+ return ([], []) # dropping support, see the comment for the event listener above for why
+
self.loggedEvents = arg.split()
- allEvents = torTools.getConn().setControllerEvents(self.loggedEvents)
+ #allEvents = torTools.getConn().setControllerEvents(self.loggedEvents)
setEvents = set(self.loggedEvents).intersection(allEvents)
if setEvents:
diff --git a/src/util/torTools.py b/src/util/torTools.py
index 36cb70f..d261bb0 100644
--- a/src/util/torTools.py
+++ b/src/util/torTools.py
@@ -38,14 +38,6 @@ DIR_SERVERS = [("86.59.21.38", "80"), # tor26
# message logged by default when a controller can't set an event type
DEFAULT_FAILED_EVENT_MSG = "Unsupported event type: %s"
-# TODO: check version when reattaching to controller and if version changes, flush?
-# Skips attempting to set events we've failed to set before. This avoids
-# logging duplicate warnings but can be problematic if controllers belonging
-# to multiple versions of tor are attached, making this unreflective of the
-# controller's capabilites. However, this is a pretty bizarre edge case.
-DROP_FAILED_EVENTS = True
-FAILED_EVENTS = set()
-
CONTROLLER = None # singleton Controller instance
UNDEFINED = "<Undefined_ >"
@@ -493,7 +485,6 @@ class Controller(TorCtl.PostEventListener):
self.conn = None # None if uninitialized or controller's been closed
self.controller = None
self.connLock = threading.RLock()
- self.eventListeners = [] # instances listening for tor controller events
self.statusListeners = [] # callback functions for tor's state changes
self.controllerEvents = [] # list of successfully set controller events
self._fingerprintMappings = None # mappings of ip -> [(port, fingerprint), ...]
@@ -541,6 +532,9 @@ class Controller(TorCtl.PostEventListener):
controller - stem based Controller instance
"""
+ # TODO: We should reuse our controller instance so event listeners will be
+ # re-attached. This is a point of regression until we do... :(
+
if conn.is_live() and controller.is_alive() and conn != self.conn:
self.connLock.acquire()
@@ -550,8 +544,11 @@ class Controller(TorCtl.PostEventListener):
self.controller = controller
log.log(log.INFO, "Stem connected to tor version %s" % self.controller.get_version())
- self.conn.add_event_listener(self)
- for listener in self.eventListeners: self.conn.add_event_listener(listener)
+ self.controller.add_event_listener(self.msg_event, stem.control.EventType.NOTICE)
+ self.controller.add_event_listener(self.ns_event, stem.control.EventType.NS)
+ self.controller.add_event_listener(self.new_consensus_event, stem.control.EventType.NEWCONSENSUS)
+ self.controller.add_event_listener(self.new_desc_event, stem.control.EventType.NEWDESC)
+ self.controller.add_event_listener(self.circ_status_event, stem.control.EventType.CIRC)
# registers this as our first heartbeat
self._updateHeartbeat()
@@ -570,10 +567,6 @@ class Controller(TorCtl.PostEventListener):
self._isExitingAllowed = self._exitPolicyChecker.isExitingAllowed()
self._exitPolicyLookupCache = {}
- # sets the events listened for by the new controller (incompatible events
- # are dropped with a logged warning)
- self.setControllerEvents(self.controllerEvents)
-
self._status = State.INIT
self._statusTime = time.time()
@@ -1387,19 +1380,24 @@ class Controller(TorCtl.PostEventListener):
return result
- def addEventListener(self, listener):
+ def addEventListener(self, listener, *eventTypes):
"""
Directs further tor controller events to callback functions of the
listener. If a new control connection is initialized then this listener is
reattached.
+ """
- Arguments:
- listener - TorCtl.PostEventListener instance listening for events
+ self.connLock.acquire()
+ if self.isAlive(): self.controller.add_event_listener(listener, *eventTypes)
+ self.connLock.release()
+
+ def removeEventListener(self, listener):
+ """
+ Stops the given event listener from being notified of further events.
"""
self.connLock.acquire()
- self.eventListeners.append(listener)
- if self.isAlive(): self.conn.add_event_listener(listener)
+ if self.isAlive(): self.controller.remove_event_listener(listener)
self.connLock.release()
def addStatusListener(self, callback):
@@ -1435,92 +1433,6 @@ class Controller(TorCtl.PostEventListener):
return list(self.controllerEvents)
- def setControllerEvents(self, events):
- """
- Sets the events being requested from any attached tor instance, logging
- warnings for event types that aren't supported (possibly due to version
- issues). Events in REQ_EVENTS will also be included, logging at the error
- level with an additional description in case of failure.
-
- This remembers the successfully set events and tries to request them from
- any tor instance it attaches to in the future too (again logging and
- dropping unsuccessful event types).
-
- This returns the listing of event types that were successfully set. If not
- currently attached to a tor instance then all events are assumed to be ok,
- then attempted when next attached to a control port.
-
- Arguments:
- events - listing of events to be set
- """
-
- self.connLock.acquire()
-
- returnVal = []
- if self.isAlive():
- events = set(events)
- events = events.union(set(REQ_EVENTS.keys()))
- unavailableEvents = set()
-
- # removes anything we've already failed to set
- if DROP_FAILED_EVENTS:
- unavailableEvents.update(events.intersection(FAILED_EVENTS))
- events.difference_update(FAILED_EVENTS)
-
- # initial check for event availability, using the 'events/names' GETINFO
- # option to detect invalid events
- validEvents = self.getInfo("events/names", None)
-
- if validEvents:
- validEvents = set(validEvents.split())
- unavailableEvents.update(events.difference(validEvents))
- events.intersection_update(validEvents)
-
- # attempt to set events via trial and error
- isEventsSet, isAbandoned = False, False
-
- while not isEventsSet and not isAbandoned:
- try:
- self.conn.set_events(list(events))
- isEventsSet = True
- except TorCtl.ErrorReply, exc:
- msg = str(exc)
-
- if "Unrecognized event" in msg:
- # figure out type of event we failed to listen for
- start = msg.find("event \"") + 7
- end = msg.rfind("\"")
- failedType = msg[start:end]
-
- unavailableEvents.add(failedType)
- events.discard(failedType)
- else:
- # unexpected error, abandon attempt
- isAbandoned = True
- except TorCtl.TorCtlClosed:
- self.close()
- isAbandoned = True
-
- FAILED_EVENTS.update(unavailableEvents)
- if not isAbandoned:
- # logs warnings or errors for failed events
- for eventType in unavailableEvents:
- defaultMsg = DEFAULT_FAILED_EVENT_MSG % eventType
- if eventType in REQ_EVENTS:
- log.log(log.ERR, defaultMsg + " (%s)" % REQ_EVENTS[eventType])
- else:
- log.log(log.WARN, defaultMsg)
-
- self.controllerEvents = list(events)
- returnVal = list(events)
- else:
- # attempts to set the events when next attached to a control port
- self.controllerEvents = list(events)
- returnVal = list(events)
-
- self.connLock.release()
- return returnVal
-
def reload(self, issueSighup = False):
"""
This resets tor (sending a RELOAD signal to the control port) causing tor's
@@ -1631,7 +1543,7 @@ class Controller(TorCtl.PostEventListener):
causing the torrc and internal state to be reset.
"""
- if event.level == "NOTICE" and event.msg.startswith("Received reload signal (hup)"):
+ if event.runlevel == "NOTICE" and event.message.startswith("Received reload signal (hup)"):
self.connLock.acquire()
if self.isAlive():
@@ -1652,8 +1564,8 @@ class Controller(TorCtl.PostEventListener):
myFingerprint = self.getInfo("fingerprint", None)
if myFingerprint:
- for ns in event.nslist:
- if ns.idhex == myFingerprint:
+ for desc in event.desc:
+ if desc.fingerprint == myFingerprint:
self._cachedParam["nsEntry"] = None
self._cachedParam["flags"] = None
self._cachedParam["bwMeasured"] = None
@@ -1681,7 +1593,7 @@ class Controller(TorCtl.PostEventListener):
self._consensusLookupCache = {}
if self._fingerprintMappings != None:
- self._fingerprintMappings = self._getFingerprintMappings(event.nslist)
+ self._fingerprintMappings = self._getFingerprintMappings(event.desc)
self.connLock.release()
@@ -1691,7 +1603,9 @@ class Controller(TorCtl.PostEventListener):
self.connLock.acquire()
myFingerprint = self.getInfo("fingerprint", None)
- if not myFingerprint or myFingerprint in event.idlist:
+ desc_fingerprints = [fingerprint for (fingerprint, nickname) in event.relays]
+
+ if not myFingerprint or myFingerprint in desc_fingerprints:
self._cachedParam["descEntry"] = None
self._cachedParam["bwObserved"] = None
@@ -1702,32 +1616,26 @@ class Controller(TorCtl.PostEventListener):
self._descriptorLookupCache = {}
if self._fingerprintMappings != None:
- for fingerprint in event.idlist:
+ for fingerprint in desc_fingerprints:
# gets consensus data for the new descriptor
- try: nsLookup = self.conn.get_network_status("id/%s" % fingerprint)
- except (socket.error, TorCtl.ErrorReply, TorCtl.TorCtlClosed): continue
-
- if len(nsLookup) > 1:
- # multiple records for fingerprint (shouldn't happen)
- log.log(log.WARN, "Multiple consensus entries for fingerprint: %s" % fingerprint)
- continue
+ try: desc = self.controller.get_network_status(fingerprint)
+ except stem.ControllerError: continue
# updates fingerprintMappings with new data
- newRelay = nsLookup[0]
- if newRelay.ip in self._fingerprintMappings:
+ if desc.address in self._fingerprintMappings:
# if entry already exists with the same orport, remove it
orportMatch = None
- for entryPort, entryFingerprint in self._fingerprintMappings[newRelay.ip]:
- if entryPort == newRelay.orport:
+ for entryPort, entryFingerprint in self._fingerprintMappings[desc.address]:
+ if entryPort == desc.or_port:
orportMatch = (entryPort, entryFingerprint)
break
- if orportMatch: self._fingerprintMappings[newRelay.ip].remove(orportMatch)
+ if orportMatch: self._fingerprintMappings[desc.address].remove(orportMatch)
# add the new entry
- self._fingerprintMappings[newRelay.ip].append((newRelay.orport, newRelay.idhex))
+ self._fingerprintMappings[desc.address].append((desc.or_port, desc.fingerprint))
else:
- self._fingerprintMappings[newRelay.ip] = [(newRelay.orport, newRelay.idhex)]
+ self._fingerprintMappings[desc.address] = [(desc.or_port, desc.fingerprint)]
self.connLock.release()
@@ -1742,27 +1650,6 @@ class Controller(TorCtl.PostEventListener):
self._cachedParam["circuits"] = None
- def buildtimeout_set_event(self, event):
- self._updateHeartbeat()
-
- def stream_status_event(self, event):
- self._updateHeartbeat()
-
- def or_conn_status_event(self, event):
- self._updateHeartbeat()
-
- def stream_bw_event(self, event):
- self._updateHeartbeat()
-
- def bandwidth_event(self, event):
- self._updateHeartbeat()
-
- def address_mapped_event(self, event):
- self._updateHeartbeat()
-
- def unknown_event(self, event):
- self._updateHeartbeat()
-
def _updateHeartbeat(self):
"""
Called on any event occurance to note the time it occured.
@@ -1771,26 +1658,25 @@ class Controller(TorCtl.PostEventListener):
# alternative is to use the event's timestamp (via event.arrived_at)
self.lastHeartbeat = time.time()
- def _getFingerprintMappings(self, nsList = None):
+ def _getFingerprintMappings(self, descriptors = None):
"""
Provides IP address to (port, fingerprint) tuple mappings for all of the
currently cached relays.
Arguments:
- nsList - network status listing (fetched if not provided)
+ descriptors - router status entries (fetched if not provided)
"""
results = {}
if self.isAlive():
# fetch the current network status if not provided
- if not nsList:
- try: nsList = self.conn.get_network_status(get_iterator=True)
- except (socket.error, TorCtl.TorCtlClosed, TorCtl.ErrorReply): nsList = []
+ if not descriptors:
+ try: descriptors = self.controller.get_network_statuses()
+ except stem.ControllerError: descriptors = []
# construct mappings of ips to relay data
- for relay in nsList:
- if relay.ip in results: results[relay.ip].append((relay.orport, relay.idhex))
- else: results[relay.ip] = [(relay.orport, relay.idhex)]
+ for desc in descriptors:
+ results.setdefault(desc.address, []).append((desc.or_port, desc.fingerprint))
return results
1
0
commit 0c1ee97cd1edeed9141ce9c78c6a5db953bf242e
Author: Damian Johnson <atagar(a)torproject.org>
Date: Sun Dec 16 18:56:31 2012 -0800
Using stem to send remaining signals
On first look this is the last of our TorCtl connection usage. Hazaa!
---
src/util/torTools.py | 10 +++++++---
1 files changed, 7 insertions(+), 3 deletions(-)
diff --git a/src/util/torTools.py b/src/util/torTools.py
index 0875a05..056c454 100644
--- a/src/util/torTools.py
+++ b/src/util/torTools.py
@@ -13,6 +13,7 @@ import threading
import Queue
import stem
+import stem.control
from TorCtl import TorCtl
from util import connections, enum, log, procTools, sysTools, uiTools
@@ -1450,7 +1451,7 @@ class Controller(TorCtl.PostEventListener):
if self.isAlive():
if not issueSighup:
try:
- self.conn.send_signal("RELOAD")
+ self.controller.signal(stem.Signal.RELOAD)
self._cachedParam = {}
except Exception, exc:
# new torrc parameters caused an error (tor's likely shut down)
@@ -1519,8 +1520,11 @@ class Controller(TorCtl.PostEventListener):
if self.isAlive():
try:
isRelay = self.getOption("ORPort", None) != None
- signal = "HALT" if force else "SHUTDOWN"
- self.conn.send_signal(signal)
+
+ if force:
+ stem.controller.signal(stem.Signal.HALT)
+ else:
+ stem.controller.signal(stem.Signal.SHUTDOWN)
# shuts down control connection if we aren't making a delayed shutdown
if force or not isRelay: self.close()
1
0
17 Dec '12
commit 1e16e9cb75846798a864952ff2829f71f65a6d5a
Author: Damian Johnson <atagar(a)torproject.org>
Date: Sun Dec 16 18:54:16 2012 -0800
Using stem to track the connection's heartbeat
Dropping our heartbeat tracking with stem's.
---
src/util/torTools.py | 25 ++-----------------------
1 files changed, 2 insertions(+), 23 deletions(-)
diff --git a/src/util/torTools.py b/src/util/torTools.py
index d261bb0..0875a05 100644
--- a/src/util/torTools.py
+++ b/src/util/torTools.py
@@ -499,7 +499,6 @@ class Controller(TorCtl.PostEventListener):
self._status = State.CLOSED # current status of the attached control port
self._statusTime = 0 # unix time-stamp for the duration of the status
self._lastNewnym = 0 # time we last sent a NEWNYM signal
- self.lastHeartbeat = 0 # time of the last tor event
# Status signaling for when tor starts, stops, or is reset is done via
# enquing the signal then spawning a handler thread. This is to provide
@@ -550,9 +549,6 @@ class Controller(TorCtl.PostEventListener):
self.controller.add_event_listener(self.new_desc_event, stem.control.EventType.NEWDESC)
self.controller.add_event_listener(self.circ_status_event, stem.control.EventType.CIRC)
- # registers this as our first heartbeat
- self._updateHeartbeat()
-
# reset caches for ip -> fingerprint lookups
self._fingerprintMappings = None
self._fingerprintLookupCache = {}
@@ -622,12 +618,10 @@ class Controller(TorCtl.PostEventListener):
def getHeartbeat(self):
"""
- Provides the time of the last registered tor event (if listening for BW
- events then this should occure every second if relay's still responsive).
- This returns zero if this has never received an event.
+ Provides the time of the last registered tor message.
"""
- return self.lastHeartbeat
+ return self.controller.get_latest_heartbeat()
def getInfo(self, param, default = UNDEFINED):
"""
@@ -1559,7 +1553,6 @@ class Controller(TorCtl.PostEventListener):
self.connLock.release()
def ns_event(self, event):
- self._updateHeartbeat()
self._consensusLookupCache = {}
myFingerprint = self.getInfo("fingerprint", None)
@@ -1576,8 +1569,6 @@ class Controller(TorCtl.PostEventListener):
self._cachedParam["bwMeasured"] = None
def new_consensus_event(self, event):
- self._updateHeartbeat()
-
self.connLock.acquire()
self._cachedParam["nsEntry"] = None
@@ -1598,8 +1589,6 @@ class Controller(TorCtl.PostEventListener):
self.connLock.release()
def new_desc_event(self, event):
- self._updateHeartbeat()
-
self.connLock.acquire()
myFingerprint = self.getInfo("fingerprint", None)
@@ -1640,8 +1629,6 @@ class Controller(TorCtl.PostEventListener):
self.connLock.release()
def circ_status_event(self, event):
- self._updateHeartbeat()
-
# CIRC events aren't required, but if one's received then flush this cache
# since it uses circuit-status results.
self.connLock.acquire()
@@ -1650,14 +1637,6 @@ class Controller(TorCtl.PostEventListener):
self._cachedParam["circuits"] = None
- def _updateHeartbeat(self):
- """
- Called on any event occurance to note the time it occured.
- """
-
- # alternative is to use the event's timestamp (via event.arrived_at)
- self.lastHeartbeat = time.time()
-
def _getFingerprintMappings(self, descriptors = None):
"""
Provides IP address to (port, fingerprint) tuple mappings for all of the
1
0