May 2012 - tor-commits - lists.torproject.org

r25644: {website} remove iOS link since it's dead, ticket 5814 (website/trunk/download/en)
by Andrew Lewman 10 May '12

10 May '12

Author: phobos Date: 2012-05-10 03:34:17 +0000 (Thu, 10 May 2012) New Revision: 25644 Modified: website/trunk/download/en/download.wml Log: remove iOS link since it's dead, ticket 5814 Modified: website/trunk/download/en/download.wml =================================================================== --- website/trunk/download/en/download.wml 2012-05-09 13:58:35 UTC (rev 25643) +++ website/trunk/download/en/download.wml 2012-05-10 03:34:17 UTC (rev 25644) @@ -234,15 +234,6 @@ <h2&… [View More]

1 0

[vidalia/master] Add changes file for remove-polipo branch
by chiiph＠torproject.org 09 May '12

09 May '12

commit 7ff5e520046fe1e35dd3e38e4dd219ce1b760dc1 Author: Tomás Touceda <chiiph(a)torproject.org> Date: Wed May 9 20:07:12 2012 -0300 Add changes file for remove-polipo branch --- changes/bug5769 | 2 ++ 1 files changed, 2 insertions(+), 0 deletions(-) diff --git a/changes/bug5769 b/changes/bug5769 new file mode 100644 index 0000000..13c2553 --- /dev/null +++ b/changes/bug5769 @@ -0,0 +1,2 @@ + o Remove Polipo and Torbutton from Vidalia's build scripts. Resolves + ticket … [View More]

1 0

[vidalia/master] remove polipo from vidalia.conf
by chiiph＠torproject.org 09 May '12

09 May '12

commit 0fd5460c8b8b05cf8abd3e4b4e33a5884f216483 Author: Erinn Clark <erinn(a)torproject.org> Date: Fri May 4 19:23:19 2012 -0300 remove polipo from vidalia.conf --- pkg/osx/vidalia.conf.sample | 3 --- 1 files changed, 0 insertions(+), 3 deletions(-) diff --git a/pkg/osx/vidalia.conf.sample b/pkg/osx/vidalia.conf.sample index 7dac486..ba2ed73 100644 --- a/pkg/osx/vidalia.conf.sample +++ b/pkg/osx/vidalia.conf.sample @@ -1,7 +1,4 @@ [General] -ProxyExecutable=/Applications/… [View More]

1 0

[vidalia/master] remove polipo and torbutton from OS X bundle script
by chiiph＠torproject.org 09 May '12

09 May '12

commit 58b5d6309727f1d20d794a5f1ca1f4bb992a201d Author: Erinn Clark <erinn(a)torproject.org> Date: Fri May 4 19:23:01 2012 -0300 remove polipo and torbutton from OS X bundle script --- pkg/osx/CMakeLists.txt | 28 +++++----------------------- 1 files changed, 5 insertions(+), 23 deletions(-) diff --git a/pkg/osx/CMakeLists.txt b/pkg/osx/CMakeLists.txt index e757864..dfe6347 100644 --- a/pkg/osx/CMakeLists.txt +++ b/pkg/osx/CMakeLists.txt @@ -118,10 +118,8 @@ add_custom_target(… [View More]dist-osx ) add_dependencies(dist-osx dist-osx-libraries) -if (TOR_SOURCE_DIR AND POLIPO_SOURCE_DIR AND TORBUTTON_XPI) +if (TOR_SOURCE_DIR) get_filename_component(TOR_SOURCE_DIR ${TOR_SOURCE_DIR} ABSOLUTE) - get_filename_component(POLIPO_SOURCE_DIR ${POLIPO_SOURCE_DIR} ABSOLUTE) - get_filename_component(TORBUTTON_XPI ${TORBUTTON_XPI} ABSOLUTE) ## Determine Tor's version string used to build the .dmg filename vidalia_get_tor_version(TOR_VERSION "${TOR_SOURCE_DIR}/src/or/tor") @@ -131,21 +129,8 @@ if (TOR_SOURCE_DIR AND POLIPO_SOURCE_DIR AND TORBUTTON_XPI) message(FATAL_ERROR "Unable to determine version of ${TOR_SOURCE_DIR}/src/or/tor") endif(TOR_VERSION) - ## Configure the Torbutton installation script file - get_filename_component(TORBUTTON_XPI_FILENAME ${TORBUTTON_XPI} NAME) - configure_file( - ${CMAKE_CURRENT_SOURCE_DIR}/InstallTorbutton.scpt.in - ${CMAKE_CURRENT_BINARY_DIR}/InstallTorbutton.scpt - ) - set(bundle_DMG "vidalia-bundle-${TOR_VERSION}-${VERSION}-${DMG_ARCH}.dmg") add_custom_target(dist-osx-bundle - COMMAND osacompile - -o "${CMAKE_CURRENT_BINARY_DIR}/Install Torbutton for Firefox.app" - ${CMAKE_CURRENT_BINARY_DIR}/InstallTorbutton.scpt - COMMAND ${CMAKE_COMMAND} -E copy - ${TORBUTTON_XPI} - "${CMAKE_CURRENT_BINARY_DIR}/Install Torbutton for Firefox.app/" COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/pkg-dmg --source ${VIDALIA_APP_BUNDLE_ROOT} --target ${Vidalia_BINARY_DIR}/${bundle_DMG} @@ -169,9 +154,6 @@ if (TOR_SOURCE_DIR AND POLIPO_SOURCE_DIR AND TORBUTTON_XPI) --copy ${TOR_SOURCE_DIR}/src/tools/tor-resolve:/Vidalia.app/Contents/MacOS/ --copy ${TOR_SOURCE_DIR}/src/config/geoip:/Vidalia.app/share/tor/ --copy ${TOR_SOURCE_DIR}/src/config/torrc.sample:/Vidalia.app/Contents/Resources/ - --copy ${POLIPO_SOURCE_DIR}/polipo:/Vidalia.app/Contents/MacOS/ - --copy ${CMAKE_CURRENT_SOURCE_DIR}/polipo.conf:/Vidalia.app/Contents/Resources/ - --copy "${CMAKE_CURRENT_BINARY_DIR}/Install Torbutton for Firefox.app:/" COMMENT "Creating ${bundle_DMG}" VERBATIM ) @@ -184,21 +166,21 @@ if (TOR_SOURCE_DIR AND POLIPO_SOURCE_DIR AND TORBUTTON_XPI) VERBATIM ) add_dependencies(dist-osx-split-bundle dist-osx-bundle) -else(TOR_SOURCE_DIR AND POLIPO_SOURCE_DIR AND TORBUTTON_XPI) +else(TOR_SOURCE_DIR) message("-- Skipping dist-osx-bundle build target") add_custom_target(dist-osx-bundle COMMAND ${CMAKE_COMMAND} -E echo "!! The dist-osx-bundle target is not configured." COMMAND ${CMAKE_COMMAND} -E echo - "!! You must set the -DTOR_SOURCE_DIR,-DPOLIPO_SOURCE_DIR and -DTORBUTTON_XPI CMake variables." + "!! You must set the -DTOR_SOURCE_DIR CMake variable." COMMAND ${CMAKE_COMMAND} -E echo "!! Quitting." ) add_custom_target(dist-osx-split-bundle COMMAND ${CMAKE_COMMAND} -E echo "!! The dist-osx-split-bundle target is not configured. Quitting." COMMAND ${CMAKE_COMMAND} -E echo - "!! You must set the -DTOR_SOURCE_DIR, -DPOLIPO_SOURCE_DIR and -DTORBUTTON_XPI CMake variables." + "!! You must set the -DTOR_SOURCE_DIR CMake variable." COMMAND ${CMAKE_COMMAND} -E echo "!! Quitting." ) -endif(TOR_SOURCE_DIR AND POLIPO_SOURCE_DIR AND TORBUTTON_XPI) +endif(TOR_SOURCE_DIR) [View Less]

1 0

[vidalia/alpha] fix possible crash in MessageLog widget at Vidalia exit
by chiiph＠torproject.org 09 May '12

09 May '12

commit e07c8f3d866cf52f259b6693224cf61dc4047296 Author: Sebastian Baginski <sebthestampede(a)gmail.com> Date: Sun Apr 29 11:20:06 2012 +0200 fix possible crash in MessageLog widget at Vidalia exit --- changes/bug5690 | 3 +++ src/vidalia/log/MessageLog.h | 2 +- 2 files changed, 4 insertions(+), 1 deletions(-) diff --git a/changes/bug5690 b/changes/bug5690 new file mode 100644 index 0000000..a958e6b --- /dev/null +++ b/changes/bug5690 @@ -0,0 +1,3 @@ + … [View More]

1 0

[vidalia/alpha] Write plugin tutorial
by chiiph＠torproject.org 09 May '12

09 May '12

commit f10a3d04859a1aed9d6b5e1c7bbad7b2fc29adf5 Author: Tomás Touceda <chiiph(a)torproject.org> Date: Sat Apr 14 14:39:15 2012 -0300 Write plugin tutorial --- changes/pluginTutorial | 2 + doc/plugin-tutorial.txt | 544 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 546 insertions(+), 0 deletions(-) diff --git a/changes/pluginTutorial b/changes/pluginTutorial new file mode 100644 index 0000000..5babab3 --- /dev/null +++ b/changes/pluginTutorial @@ -0,0 +1,2 … [View More]@@ + Internal cleanups and improvements: + o Document how to write plugins in a tutorial fashion. \ No newline at end of file diff --git a/doc/plugin-tutorial.txt b/doc/plugin-tutorial.txt new file mode 100644 index 0000000..4d4fb11 --- /dev/null +++ b/doc/plugin-tutorial.txt @@ -0,0 +1,544 @@ +== How to write Vidalia Plugins === + +=== Sections == + + * Foreword + * Directory structure for plugins + * How Vidalia executes the plugin + * GUI handling + * Settings handling + * Simple example + * I know Qt, how do I use signals and slots? + * I made a plugin, what now? + +=== Foreword === + +This document intends to be a simple tutorial that will help you write +Vidalia plugins. It is not intended to be an exhaustive plugin API +reference, there will be another document for that. This is also not a +Javascript reference nor a Qt one, although you will need knowledge of +both in order to write a plugin. + +This is not also a complete plugin engine specification, for that +there is already a doc named plugin-framework.txt inside Vidalia's doc +directory. + +We assume in this document that you have basic Qt and Javascript +knowledge, and that you have Vidalia with the qtscriptgenerator libs +available. + +To check this last point, you can open Vidalia, go to Plugins->Debug +output and you should be able to see the following: + +{{{ + +Available extensions: + qt + qt.core + qt.dbus + qt.gui + qt.network + qt.uitools + qt.xml + +}}} + +The actual important extensions are: qt, qt.core, qt.gui and qt.uitool +(only if it's a GUI plugin). Depending on the functionality you intend +your plugin to have, you can ignore the rest. + +=== Directory structure for plugins === + +If you open vidalia.conf for Vidalia >= 0.3.1, you will notice a +variable named "PluginPath" in the [General] section. This variable +points to the root of where all the plugins are placed. So, the plugin +root will look something like this: + +{{{ + +pluginRoot/ + \_ plugin1/ + |_ plugin2/ + |_ plugin3/ + +}}} + +Vidalia expects every installed plugin to be a directory inside the +plugins root. + +For every plugin, the directory structure should have at least the +following files: + +{{{ + +plugin1/ + \_ info.xml + |_ plugin1.js + +}}} + +You can distribute any files other than these, may be as a dependency +for your plugin (icons, another complete application that is executed +by your plugin, .ui files, etc). + +==== The info.xml file ==== + +The most important file (besides the actual plugin code) is the +info.xml one. This contains the basic information that Vidalia needs +to understand what to do with this plugin, how to execute it, how to +and if it should display it in the Plugins menu, and what files to +load. + +Lets take a look at the info.xml file from the Tor Browser Bundle +plugin: + +{{{ + +<VidaliaPlugin> + <name>Browser Bundle Configuration</name> + <date>15/06/2011</date> + <author>chiiph</author> + <type persistent="true" gui="true" /> + <files> + <file>tbb.js</file> + </files> + <namespace>tbb</namespace> +</VidaliaPlugin> + +}}} + +For a complete description of each tag, please read secrion 2 of the +plugin-framework.txt doc. + +In practise, the name tag will be used as the menu entry for this +plugin if it is of type gui="true". Vidalia will load every file +descripted in the files tag, so they should all be valid Javascript +files. And the namespace should be unique (i.e. do not create a plugin +with tbb as its namespace, unless you want to have one of the two +overriden by the other). This namespace should be the same as the name +of the main variable you will use inside the javascript files, as we +will see later on. + +=== How Vidalia executes the plugin === + +As a quick reference for how plugins are executed, there are three +main functions: start(), stop(), and buildGUI(). The functions that +must be implemented are start and stop, since they will always be +executed one way or the other. buildGUI depends on whether your plugin +is of type gui="true" or not. + +Here's a basic skeleton for a plugin's main Javascript file: + +{{{ + +importExtension("qt"); +importExtension("qt.core"); +importExtension("qt.gui"); // optional +importExtension("qt.uitools"); // optional + +var tbb = { + someStaticVariable: 1, + someOtherStaticVar: "Some string", + + start: function() { + // Start code here... + }, + + buildGUI: function() { + // GUI creation here... + }, + + stop: function() { + // Stop function in here... + }, +}; + +}}} + +The start function is executed when Vidalia starts if type +persistent="true", or before the GUI is created when type gui="true". + +If a plugin is not of type persistent or gui, it will never be started +in any way. + +The idea behind persistent is that you can run things in background, +like a UNIX daemon (sort of). As an example, you could start a QTimer +in your start() function and check something periodically. We use this +in the Thandy plugin, if you want to read a "real world" example. + +=== GUI handling === + +If you want your plugin to have a GUI, we have made kind of a template +that you can follow: + +(This is a part of the Tor Browser Bundles complete buildGUI +implementation, you can see it in tbb.js in the plugins official +repository.) + +{{{ + buildGUI: function() { + this.tab = new VidaliaTab("Browser Bundle Settings", "TBB"); + + var file = new QFile(pluginPath+"/tbb/tbb.ui"); + var loader = new QUiLoader(this.tab); + file.open(QIODevice.ReadOnly); + this.widget = loader.load(file); + var layout = new QVBoxLayout(); + layout.addWidget(this.widget, 0, Qt.AlignCenter); + this.tab.setLayout(layout); + file.close(); + + var portInfo = this.widget.children()[findWidget(this.widget, "portInfo")]; + if(portInfo == null) { + return this.tab; + } + + var groupBox = this.widget.children()[findWidget(this.widget, "browserBox")]; + if(groupBox == null) { + return this.tab; + } + + this.btnLaunch = groupBox.children()[findWidget(groupBox, "btnLaunch")]; + if(this.btnLaunch != null) { + this.btnLaunch["clicked()"].connect(this, this.startSubProcess); + } + + return this.tab; + }, +}}} + +If you read Qt's documentation, what this function does is quite +straight forward, but I will give you a quick summarization: + +{{{ + buildGUI: function() { + this.tab = new VidaliaTab("Browser Bundle Settings", "TBB"); +}}} + +First, we need to create a new VidaliaTab. The first parameter is its +name, which can be an arbitrary string. The second one is important, +because Vidalia will use it as its section inside the vidalia.conf +file, if you want to store some kind of settings (we will get to this +in the next section). + +{{{ + var file = new QFile(pluginPath+"/tbb/tbb.ui"); + var loader = new QUiLoader(this.tab); + file.open(QIODevice.ReadOnly); + this.widget = loader.load(file); +}}} + +We encourage you to build your GUIs with Qt Designer, but you are free +to craft them in the code. In this example we use a .ui Designer file. + +So we first load the file as a regular one. The pluginPath variable is +a variable provided by Vidalia for you to know the location of the +plugin's root directory. From that point, you should know where your +files are supposed to be located, in this case it is +pluginsPath+"/tbb/tbb.ui". + +We then create the QUiLoader object, open the file and ask the loader +to do its magic. + +{{{ + var layout = new QVBoxLayout(); + layout.addWidget(this.widget, 0, Qt.AlignCenter); + this.tab.setLayout(layout); + file.close(); +}}} + +The QUiLoader creates a QWidget derived object in this.widget and now +we need to put it somewhere the user can see. We could just display +the widget, but we encourage you to try to integrate your plugin to +Vidalia as much as possible, so we will add it to a vertical layout, +and set it as the tab's main layout. + +{{{ + var portInfo = this.widget.children()[findWidget(this.widget, "portInfo")]; + if(portInfo == null) { + return this.tab; + } + + var groupBox = this.widget.children()[findWidget(this.widget, "browserBox")]; + if(groupBox == null) { + return this.tab; + } + + this.btnLaunch = groupBox.children()[findWidget(groupBox, "btnLaunch")]; + if(this.btnLaunch != null) { + this.btnLaunch["clicked()"].connect(this, this.startSubProcess); + } +}}} + +We can access each widget from this.widget, but it is recommended to +create variables for each component that you'd like to access. + +To make that job easier, Vidalia provides a findWidget function that +takes a widget and finds the one with the provided name inside the +first one's children. + +For example, in this.btnLaunch, we want to find the widget called +btnLaunch inside the groupBox widget. + +{{{ + return this.tab; + }, +}}} + +As the last step, we return the tab for Vidalia to display. Depending +on how you code your buildGUI function, you may want to check if +this.tab is already created and return it instead of executing the +whole function every time Vidalia wants to display the plugins GUI. + +Keep in mind that Vidalia deletes the returned tab when the user +closes it, that's why we create the tab every time buildGUI is +executed.. + +=== Settings handling === + +For settings handling, Vidalia provides two methods that belong to the +VidaliaTab class: saveSetting and getSetting. These methods will get +and set values inside the plugin's section, in the case of the Tor +Browser Bundle plugin, it will be the TBB section, as we described +before. + +As an example, we will look at an extract of the saveSettings function +from tbb.js: + +{{{ +this.tab.saveSetting(this.BrowserExecutable, this.lineExecutable.text); +this.tab.saveSetting(this.BrowserDirectory, this.lineDirectory.text); +}}} + +this.BrowserExecutable is a variable defined before, which is +"BrowserExecutable". this.lineExecutable is a QLineEdit from the GUI. + +This first call, assuming the content of this.lineExecutable is +"/some/path", will lead to the following text in vidalia.conf: + +{{{ + +[TBB] +BrowserExecutable=/some/path + +}}} + +Note that there might be other values before and after +"BrowserExecutable". + +For retrieving settings from the plugins own section you can use the +method getSetting, which receives the name of the setting and the +default value as parameters. + +Here's an example from the buildGUI() method in tbb.js: + +{{{ +if(this.lineExecutable != null) { + this.lineExecutable.text = this.tab.getSetting(this.BrowserExecutable, ""); +} +}}} + +=== I know Qt, how do I use signals and slots? === + +Signals and slots are available inside the plugins environment. the +only restriction is that you can't emit signals properly (there are +some hacks to get around this though). + +As an example, lets look at a part of the start() function of tbb.js: + +{{{ +torControl["authenticated()"].connect(this, this.showWaitDialog); +}}} + +The torControl variable is one that Vidalia provides to interact with +the code that is able to talk to Tor inside Vidalia. This object emits +a signal called "authenticated()" at some point. + +So the syntax to use for connecting a certain signal to a certain slot +is the following: + +{{{ +<object that emits the signal>["<signal name>"].connect(<receiver>, <slot>); +}}} + +It is not a complicated issue, but it may not be intuitive at first if +you are familliar with Qt's way of doing this in C++. + +=== Simple example === + +We have been through the most important parts of a plugin, you can +always look at how the Tor Browser Bundle plugin works and learn from +it, but if you are going to start a plugin from scratch, it may not be +the best option since it a bit big. So in this section I will give you +a really simple plugin that uses everything we've been talking about +and it is still clear enough for you to have it as a quick reference +for your own plugin. + +The plugin we are going to be implementing for this section is a +simple bandwidth history recorder. This means that every certain +amount of bytes tor sends or receives, it notifies the controllers +through an event how many have been sent or received since the last +time it notified. + +Looking at how Vidalia TorControl class works, we notice a signal +called: + +{{{ + /** Emitted when Tor sends a bandwidth usage update (roughly once every + * second). <b>bytesReceived</b> is the number of bytes read by Tor over + * the previous second and <b>bytesWritten</b> is the number of bytes + * sent over the same interval. + */ + void bandwidthUpdate(quint64 bytesReceived, quint64 bytesSent); +}}} + +(This is from src/vidalia/plugin/prototypes/TorControlPrototype.h) + +What we need to do is connect this signal with a slot that records +these bytes, and we have half of our work done. + +Once we have that, we can create a simple GUI to display this as a tab +inside Vidalia. For added fun, we added a button to reset the counter +and the start date. + +Here's the complete Javascript source code for this: + +{{{ +importExtension("qt"); +importExtension("qt.core"); +importExtension("qt.gui"); +importExtension("qt.uitools"); + +var tutorial = { + From: "From", + Sent: "Sent", + Recv: "Recv", + + start: function() { + vdebug("Tutorial@start"); + torControl["bandwidthUpdate(quint64, quint64)"].connect(this, this.saveBandwidth); + this.tab = new VidaliaTab("Display bandwidth history", "BandwidthHistory"); + + this.recv = parseInt(this.tab.getSetting(this.Sent, 0)); + this.sent = parseInt(this.tab.getSetting(this.Recv, 0)); + this.from = this.tab.getSetting(this.From, ""); + + if(this.from.length == 0) + this.from = QDateTime.currentDateTime().toString(); + + // null labels so that we don't update them until the GUI is created + this.lblFrom = null; + this.lblSent = null; + this.lblRecv = null; + }, + + saveBandwidth: function(recv, sent) { + vdebug("Tutorial::Recv", recv); + vdebug("Totorial::Sent", sent); + + this.recv += recv; + this.sent += sent; + this.tab.saveSetting(this.Recv, this.recv); + this.tab.saveSetting(this.Sent, this.sent); + this.tab.saveSetting(this.From, this.from); + + if(this.lblFrom) + this.lblFrom.text = this.from; + if(this.lblSent) + this.lblSent.text = this.sent.toString(); + if(this.lblRecv) + this.lblRecv.text = this.recv.toString(); + }, + + resetCounters: function() { + this.recv = 0; + this.sent = 0; + this.from = QDateTime.currentDateTime().toString(); + this.saveBandwidth(0,0); + }, + + buildGUI: function() { + vdebug("Tutorial@buildGUI"); + // Load the GUI file + + if(this.tab) + delete this.tab; + + this.tab = new VidaliaTab("Display bandwidth history", "BandwidthHistory"); + + var file = new QFile(pluginPath+"/tutorial/tutorial.ui"); + var loader = new QUiLoader(this.tab); + file.open(QIODevice.ReadOnly); + this.widget = loader.load(file); + var layout = new QVBoxLayout(); + layout.addWidget(this.widget, 0, Qt.AlignCenter); + this.tab.setLayout(layout); + file.close(); + + var grpBandwidth = this.widget.children()[findWidget(this.widget, "grpBandwidth")]; + if(grpBandwidth == null) + return this.tab; + + this.lblFrom = grpBandwidth.children()[findWidget(grpBandwidth, "lblFrom")]; + if(this.lblFrom == null) + return this.tab; + + this.lblSent = grpBandwidth.children()[findWidget(grpBandwidth, "lblSent")]; + if(this.lblSent == null) + return this.tab; + + this.lblRecv = grpBandwidth.children()[findWidget(grpBandwidth, "lblRecv")]; + if(this.lblRecv == null) + return this.tab; + + this.btnReset = grpBandwidth.children()[findWidget(grpBandwidth, "btnReset")]; + if(this.btnReset == null) + return this.tab; + + this.lblFrom.text = this.from; + this.lblSent.text = this.sent.toString(); + this.lblRecv.text = this.recv.toString(); + + this.btnReset["clicked()"].connect(this, this.resetCounters); + + return this.tab; + }, + + stop: function() { + vdebug("Tutorial@stop"); + this.saveBandwidth(0,0); + }, +}; +}}} + +With just 105 lines we have a nice byte history recorder. You can find +the tutorial.ui and info.xml files in our repository: + +https://gitweb.torproject.org/vidalia-plugins.git + +=== I made a plugin, what now? === + +So you have your cool plugin with a crazy new idea and it works great, +what is the next step? We have a repository for official plugins +(official as in "some folk from Tor made it"), and you can give us +your plugin to put it there and may be convince us why we should +distribute your plugin along with the rest. + +The idea to have plugins though is to let people develop functionality +in one of the main Tor controllers, and not depend on us to merge new +stuff into the main line of distribution. + +In the (near) future, we will have a Vidalia Plugins web section where +plugins that we think are good and won't compromise the users privacy +will be listed. + +Right now the plugin distribution and installation is not something +that any user might be able to do, so the other future plan is to +create a distribution file format (probably just a zip file with +certain internal structure) and a graphical way of installing plugins. + +If you are interested in helping with the infrastructure for plugins, +please don't hesitate to join us on IRC at OFTC #vidalia. + +If you find any bugs, do not hesitate to report them in +https://trac.torproject.org with Vidalia as the component. [View Less]

1 0

[vidalia/alpha] Write Getting Started tutorial
by chiiph＠torproject.org 09 May '12

09 May '12

commit d1faa8aecb7693dd5d8d560adeb1c8930523835d Author: Tomás Touceda <chiiph(a)torproject.org> Date: Mon Apr 9 21:59:56 2012 -0300 Write Getting Started tutorial --- changes/bug2925 | 3 + doc/getting-started.txt | 397 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 400 insertions(+), 0 deletions(-) diff --git a/changes/bug2925 b/changes/bug2925 new file mode 100644 index 0000000..350b802 --- /dev/null +++ b/changes/bug2925 @@ -0,0 +1,3 @@ + … [View More]Internal cleanups and improvements: + o Document how to get started with Vidalia development in a tutorial + fashion. Fixes bug 2925. \ No newline at end of file diff --git a/doc/getting-started.txt b/doc/getting-started.txt new file mode 100644 index 0000000..26889b8 --- /dev/null +++ b/doc/getting-started.txt @@ -0,0 +1,397 @@ +== Getting started with coding for Vidalia == + +=== Sections === + * Foreword + * Dependencies + * Building plain Vidalia + * How to build some of its optional features: + * Building with Marble + * Enabling plugin support + * Code structure + * Contributing workflow + +=== Foreword === + +Vidalia has a stable and an alpha branch. The stable branch is +actually called master in the source code repository. The stable +branch will have bugfixes and new features when these demand being +released as stable for the sake of the users. Most of the information +in this document applies to all Vidalia branches and released +versions, in case there is a specific issue that applies from a +specific version or on a specific branch, it will be specified +explicitly. + +This is not a Git tutorial, for that there are really good references +already online. I particularly recommend the online (and paperback) +book ProGit. + +Vidalia can be built for most flavors of BSDs too. They should be +similar to the references to Linux, but we do not support actively any +of them. That being said, if you find a bug. that does not mean we +won't fix it. It means that we are not building Vidalia on, say, +FreeBSD every day. + +=== Dependencies === + +The most important (and the basic) dependencies to build Vidalia are: +Qt >= 4.7.4 and CMake. +CMake should be installed as a regular application for every OS. Qt on +the other hand can be used in several ways, the most important thing +to understand is that you need to let CMake know the path to the tool +named qmake from the Qt toolkit, and based on that it should be able +to figure out the rest of the paths. If that fails, we will explain +how to solve it later on. We will use the terminal to build Vidalia +and explain how to do the different things we are going to cover in +this document. + +If you use Linux you will have easy access to a terminal. If you use +Windows, on the other hand, what I use is msysGit[1] (especially since +we will use Git for a lot of things explained later on this document). +If you are an OSX user, you should use Terminal.app. + +To manage the source code, Vidalia (and all the Tor Project projects) +use Git[2]. You should install it with your preferred package manager +if on Linux, use msysGit on Windows, or use MacPort or Homebrew on +OSX. + +Vidalia has a lot of optional features that can be enabled or disabled +in the configure stage (see section Building plain Vidalia). Among +these possibilities, Vidalia can use Marble widget[3], which is a map +widget to display nodes around the world in the Network Map. You +should clone Marble's repository (which also uses git) if you want to +build with Marble support (see section Building with Marble), but it +is not mandatory. + +Another optional feature is Google Breakpad, which we won't get into +details here, but you should be able to enable it based on how you +enabled Marble, and the README.breakpad guide. + +If you are running the alpha branch (or release >=0.3.1), another +dependency will be qtscriptgenerator. We will get into details for +this in the section Enabling plugin support. + +=== Building plain Vidalia === + +Building Vidalia is quite simple if you know the few steps you should follow. +Assuming you have installed Qt, locate the qmake binary. We will +denote this path as $QMAKE_BIN. + +After that, you should clone Vidalia's source code repository: + +{{{ +$ git clone https://git.torproject.org/vidalia.git +}}} + +This will create a directory called vidalia. If you want to use the +alpha branch, you should do the following: + +{{{ +$ cd vidalia +$ git fetch origin +$ git checkout alpha +}}} + +From this point we will start using CMake. This tool has the +peculiarity that you can have a separate directory to build your code, +so that all the object code and other auxiliary files do not get in +the way of your implementation. So we will use a directory named +"build" inside Vidalia's root: + +{{{ +$ mkdir build +$ cd build +$ cmake .. -DQT_QMAKE_EXECUTABLE="${QMAKE_BIN}" +}}} + +The cmake .. command directs cmake to where the code repository is, +and also sets the variable QT_QMAKE_EXECUTABLE. If CMake complains +about other variables not being set, you should set them similarly to +the one we are already setting. +This last step is called the configuration step (or phase). + +After this, we start the actual building phase: + +{{{ +$ make -j4 +}}} + +The number you would use for the -j parameter should be number of +cores +1 (unless you want to wait longer for the build, in which case +you can just ignore the parameter completely). + +If everything goes alright, you should have the Vidalia binary inside +the path: build/src/vidalia/. If you are on Linux it will be called +vidalia, vidalia.exe on Windows, and Vidalia.app on OSX. You can run +Vidalia with the following parameters (assuming you are on Linux, it +will be similar in the rest of the OSs): + +{{{ +$ ./src/vidalia/vidalia --loglevel info --logfile /dev/stdout +}}} + +=== How to build some of its optional features === + +==== Building with Marble ==== + +To build Vidalia with Marble support, you should clone and build +Marble from git[5] with Qt-only support. + +We will assume that your marble clone is located in ~/marble, your +build directory is located in ~/marble/build. + +Once we reach this point, we can configure Vidalia to use Marble with +the following command (from Vidalia's root): + +{{{ +$ cmake -DUSE_MARBLE=1 \ + -DMARBLE_INCLUDE_DIR=~/marble/src/lib \ + -DMARBLE_DATA_DIR=~/marble/data \ + -DMARBLE_LIBRARY_DIR=~/marble/build/src/lib \ + -DMARBLE_PLUGIN_DIR=~/marble/build/src/plugins .. +}}} + +When the configuration has finished, you can compile Vidalia as usual: + +{{{ +$ make -j4 +}}} + +Remember that the -j parameter is something you should figure out for +your system or just leave it out completely if in doubt. + +==== Enabling plugin support ==== + +Vidalia >= 0.3.1 has support for plugins. How plugins are structured +and how they work will be covered on another document, but to actually +work with plugins we need to be able to build qtscriptgenerator[4]. + +To build it, you should follow its README, but the following hints +might come handy if you get stuck: + + * On Windows, you may need to execute the following to get the +generator to locate Qt's headers: + +{{{ + setx QTDIR /c/QtSDK/Desktop/Qt/4.7.4/mingw/ +}}} + +Note that the path may change depending on your Qt installation. + + * On OSX we build this the following way: + +In the file qtbindings/qtscript_uitools/qtscript_uitools.pro, change this: + +{{{ +CONFIG += uitools +}}} + +to this: + +{{{ +CONFIG += uitools plugin link_prl +}}} + +And then follow these steps: + +{{{ +$ cd path/to/generator/ +$ qmake -spec macx-g++ +$ make +$ ./generator +$ cd ../qtbindings/ +$ qmake -spec macx-g++ -recursive +$ make release +}}} + +=== Code structure === + +Vidalia is separated in several modules, here is a brief explanation +of each directory: + +{{{ +src/ + All the source code is located in this directory. + +src/vidalia/ + Main module, this is where Vidalia's GUI files are located, the main +window classes are right there, other parts of Vidalia that take +several files are located in their own submodule inside this one. + +src/vidalia/about/ + The About and the License dialogs are located here. + +src/vidalia/bwgraph/ + The Bandwidth Graph classes are here. + +src/vidalia/config/ + In this directory all the configuration classes are located. + +src/vidalia/help/ + The help browser and the actual help content is located in here. + +src/vidalia/i18n/ + Here we have all the files used for translations. + +src/vidalia/log/ + The Message Log code is located in this directory. + +src/vidalia/network/ + Here you can find the Network Map code. Here lives the code that +also handles Marble. + +src/vidalia/res/ + All the different resources like icons or certificates are in this directory. + +src/common/ + The common module has somwhat generic classes and functions used in +other modules. + +src/crashreporter/ + Here you can find the code that interacts with Google BreakPad. + +src/miniupnpc/ + Miniupnpc is a UPNPC library that Vidalia bundles in its code to +build it with CMake, but it is not an code that is maintained by us. + +src/tools/ + Inside this directory you can find self contained simple +applications that are used for different purposes, like translating +from different translation file types. + +src/torcontrol/ + This is the most important module that handles the interaction +between Tor and Vidalia. + +changes/ + In this directory live the different changes introduced by a branch +that has been merged, its contents will go to the CHANGELOG file. See +the Contributing workflow section for more information. + +cmake/ + This directory contains the CMake macros used by Vidalia's build scripts. + +contrib/ + In here you can find some GeoIP scripts. + +debian/ + This directory contains some Debian specific information. + +doc/ + This one contains some documentation regarding Vidalia's design and +Doxygen configuration. + +pkg/ + This directory contains the scripts used for packaging on different +formats, like app for OSX, rpm for Linux and a Windows installer. +}}} + +=== Contributing workflow === + +There are at least two different ways to contribute to Vidalia in +terms of how you submit your changes. The first approach might be +simpler than the second, but the one you choose depends on how you +will get involved. + +NOTE: There are several ways of doing what is proposed, we will not +get into details, each person should adopt the way suits them best. + +==== Submit a patch ==== + +Vidalia uses git to manage its source code, as we explained before. +Git has a nice feature called format-patch. Here's how it works: + + * Update the repository to its latest version. You should replace +master with the current branch you are working on + +{{{ + $ git pull origin master +}}} + + * Edit the code as you see fit + + * Add the files you want to be in the patch you will submit + +{{{ + $ git add file1 file2 +}}} + + * Create a commit + +{{{ + $ git commit -m "Some commit message that represents the changes" +}}} + + * And then we create the patch: + +{{{ + $ git format-patch HEAD..HEAD~1 +}}} + +Why not just create the patch with diff? This way you will be in +charge of the actual commit (you will be the committer). Another added +value is that you can make several commits, if it makes more sense for +your code. Otherwise, the person that will push the new code has to +handle all themselves, and it may not be what you'd have done (even +though the final code will be the same). + +==== Create a branch ==== + +The ideal way to contribute is to have a remote somewhere (github, +gitorious, etc), and point us to a branch in that remote. The branch +should be named bugXXXX_sometext, where XXXX is the ticket number, and +sometext is a representative text for the code in that branch. + +When the branch is reviewed, it will be merged to its base branch and +pushed to the official Vidalia repository. + +The review process varies with each fix or person that is involved, +but there are some basic guidelines that you should follow to make the +procedure as fast as possible. + +===== Changes file ===== + +Each Vidalia release has its own portion of the CHANGELOG. This +CHANGELOG is built from a series of changes files. These files are +located in the "changes" directory. Their basic structure is the +following: + +{{{ + <Category>: + o <Text that describes the change>. [Fixes bug | Resolves ticket] +<ticket number>. +}}} + +The valid categories are: + + * New features + * Bugfixes relative to Vidalia 0.2.x + * Bugfixes relative to Vidalia 0.3.x + * Internal cleanups and improvements + +The decision whether to use "Fixes bug" or "Resolves ticket" should be +determined by the nature of the issue. If it was a bug, it should say +"Fixes bug", and if it's a ticket for a new feature, it should say +"Resolves ticket". + +Each branch must have their own changes file, this way when it is +merged it will add the file to the changes directory in the base +branch. + +===== Commit structure and code guidelines ===== + +A fix branch (or format-patch) should separate a fix into several +relevant commits, especially if the fix is a big one and can be +devided (there are exceptions to this rule). + +In terms of coding guidelines, code that does not follow the +guidelines specified in the HACKING document won't be merged. You can +find this document in the root directory of your cloned Vidalia +repository. + +-- + +[1] http://msysgit.github.com/ +[2] http://git-scm.com +[3] http://edu.kde.org/marble/ +[4] https://qt.gitorious.org/qt-labs/qtscriptgenerator +[5] http://edu.kde.org/marble/obtain.php [View Less]

1 0

r25643: {} Add Trondheim presos for Runa. (projects/presentations)
by Linus Nordberg 09 May '12

09 May '12

Author: linus Date: 2012-05-09 13:58:35 +0000 (Wed, 09 May 2012) New Revision: 25643 Added: projects/presentations/2012-05-09-Trondheim.odp projects/presentations/2012-05-09-Trondheim.pdf Log: Add Trondheim presos for Runa. Added: projects/presentations/2012-05-09-Trondheim.odp =================================================================== (Binary files differ) Property changes on: projects/presentations/2012-05-09-Trondheim.odp … [View More]

1 0

[atlas/master] Update links to Onionoo
by art＠torproject.org 09 May '12

09 May '12

commit 35bee7256b38f8f6d56e2a327fc6f07443a8450f Author: Arturo Filastò <hellais(a)torproject.org> Date: Wed May 9 15:08:12 2012 +0200 Update links to Onionoo --- templates/about.html | 5 +++-- 1 files changed, 3 insertions(+), 2 deletions(-) diff --git a/templates/about.html b/templates/about.html index 7297a33..214cc98 100644 --- a/templates/about.html +++ b/templates/about.html @@ -42,8 +42,9 @@ This application is built in a way that all the logic is delegated to the … [View More]

1 0

[translation/vidalia_alpha] Update translations for vidalia_alpha
by translation＠torproject.org 09 May '12

09 May '12

commit 9a9ccf040c3627f744799c0eab0b3e2120cd05cf Author: Translation commit bot <translation(a)torproject.org> Date: Wed May 9 11:45:11 2012 +0000 Update translations for vidalia_alpha --- hr_HR/vidalia_hr_HR.po | 36 ++++++++++++++++++------------------ 1 files changed, 18 insertions(+), 18 deletions(-) diff --git a/hr_HR/vidalia_hr_HR.po b/hr_HR/vidalia_hr_HR.po index f1cd22b..2b6262d 100644 --- a/hr_HR/vidalia_hr_HR.po +++ b/hr_HR/vidalia_hr_HR.po @@ -6,7 +6,7 @@ msgstr "" "… [View More]Project-Id-Version: The Tor Project\n" "Report-Msgid-Bugs-To: https://trac.torproject.org/projects/tor\n" "POT-Creation-Date: 2012-03-21 17:46+0000\n" -"PO-Revision-Date: 2012-05-09 11:15+0000\n" +"PO-Revision-Date: 2012-05-09 11:33+0000\n" "Last-Translator: gogo <trebelnik2(a)gmail.com>\n" "Language-Team: translations(a)vidalia-project.net\n" "MIME-Version: 1.0\n" @@ -151,47 +151,47 @@ msgstr "Putanja:" msgctxt "AdvancedPage" msgid "Use Unix domain socket (ControlSocket)" -msgstr "Use Unix domain socket (ControlSocket)" +msgstr "Koristi priključak Unix domene (Kontrolni priključak)" msgctxt "AdvancedPage" msgid "Edit current torrc" -msgstr "" +msgstr "Uredi trenutni torrc" msgctxt "AdvancedPage" msgid "NOTE: this will edit the currently loaded torrc" -msgstr "" +msgstr "NAPOMENA: ovo će urediti trenutno učitani torrc" msgctxt "AdvancedPage" msgid "ControlSocket path doesn't exist." -msgstr "" +msgstr "Putanja Kontrolnog priključka ne postoji" msgctxt "AdvancedPage" msgid "" "The specified Tor configuration file location contains characters that " "cannot be represented in your system's current 8-bit character encoding." -msgstr "" +msgstr "Određena Tor lokacija datoteke podešavanja sadrži znakove koji ne mogu biti prikazani u vašem trenutnom 8-bitnom kodiranju znakova." msgctxt "AdvancedPage" msgid "" "The specified Tor data directory location contains characters that cannot be" " represented in your system's current 8-bit character encoding." -msgstr "" +msgstr "Određena Tor lokacija direktorija podataka sadrži znakove koji ne mogu biti prikazani u vašem trenutnom 8-bitnom kodiranju znakova." msgctxt "AdvancedPage" msgid "Warning" -msgstr "" +msgstr "Upozorenje" msgctxt "AdvancedPage" msgid "You changed torrc path, would you like to restart Tor?" -msgstr "" +msgstr "Promijenili ste torrc putanju, želite li ponovno pokrenuti tor Tor?" msgctxt "AdvancedPage" msgid "Tor Configuration File (torrc);;All Files (*)" -msgstr "" +msgstr "Tor datoteka podešavanja (torrc);;Sve datoteke (*)" msgctxt "AdvancedPage" msgid "Select a file to use for Tor socket path" -msgstr "" +msgstr "Odaberite datoteku za korištenje putanje Tor priključka" msgctxt "AdvancedPage" msgid "Configure ControlPort automatically" @@ -232,7 +232,7 @@ msgid "" "Vidalia was unable to remove the Tor service.\n" "\n" "You may need to remove it manually." -msgstr "" +msgstr "Vidalia ne može ukloniti Tor uslugu.\n\nMožda ju trebate ručno ukloniti" msgctxt "AdvancedPage" msgid "Select a Directory to Use for Panic" @@ -240,23 +240,23 @@ msgstr "" msgctxt "AppearancePage" msgid "Language" -msgstr "" +msgstr "Jezik" msgctxt "AppearancePage" msgid "Choose the language used in Vidalia" -msgstr "" +msgstr "Odaberite jezik koji će koristiti Vidalia" msgctxt "AppearancePage" msgid "Style" -msgstr "" +msgstr "Stil" msgctxt "AppearancePage" msgid "Choose Vidalia's interface style" -msgstr "" +msgstr "Oaberite Vidalia-in stil sučelja" msgctxt "AppearancePage" msgid "Vidalia was unable to load the selected language translation." -msgstr "" +msgstr "Vidalia ne može učitati odabrani prijevod jezika." msgctxt "AppearancePage" msgid "" @@ -277,7 +277,7 @@ msgstr "" msgctxt "BandwidthGraph" msgid "Since:" -msgstr "" +msgstr "Od:" msgctxt "BandwidthGraph" msgid "Hide Settings" [View Less]

1 0