July 2016 - tor-commits - lists.torproject.org

[translation/tor-messenger-authproperties] Update translations for tor-messenger-authproperties
by translation＠torproject.org 14 Jul '16

14 Jul '16

commit b51415fc93d7d8f17a98f53847d706fafa12cf8a Author: Translation commit bot <translation(a)torproject.org> Date: Thu Jul 14 18:47:29 2016 +0000 Update translations for tor-messenger-authproperties --- sk_SK/auth.properties | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sk_SK/auth.properties b/sk_SK/auth.properties index 17410b1..db95874 100644 --- a/sk_SK/auth.properties +++ b/sk_SK/auth.properties @@ -1,7 +1,7 @@ -auth.title=Verify %S's identity +auth.title=Overiť identitu %S auth.yourFingerprint=Fingerprint for you, %S:\n%S auth.theirFingerprint=Purported fingerprint for %S:\n%S auth.help=Verifying a contact's identity helps ensure that the person you are talking to is who they claim to be. auth.helpTitle=Verification help auth.question=This is the question asked by your contact:\n\n%S\n\nEnter secret answer here (case sensitive): -auth.secret=Enter secret here: +auth.secret=Vložte tajomstvo:

1 0

[translation/tor-messenger-authdtd_completed] Update translations for tor-messenger-authdtd_completed
by translation＠torproject.org 14 Jul '16

14 Jul '16

commit 95586e058c10b107a44789b7131e8f35d8933a27 Author: Translation commit bot <translation(a)torproject.org> Date: Thu Jul 14 18:47:26 2016 +0000 Update translations for tor-messenger-authdtd_completed --- sk_SK/auth.dtd | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/sk_SK/auth.dtd b/sk_SK/auth.dtd new file mode 100644 index 0000000..1ae4620 --- /dev/null +++ b/sk_SK/auth.dtd @@ -0,0 +1,21 @@ +<!ENTITY authDialog.title "Overiť identitu kontaktu."> +<!ENTITY authDialog.authenticate "Overiť"> +<!ENTITY authDialog.cancel "Zrušiť"> +<!ENTITY authDialog.help "Pomocník"> +<!ENTITY authDialog.yes "Áno"> +<!ENTITY authDialog.no "Nie"> +<!ENTITY authDialog.verified "Overil som, že sa naozaj jedná o správny odtlačok."> +<!ENTITY authDialog.yourFingerprint "Váš odtlačok"> +<!ENTITY authDialog.theirFingerprint "Ich údajný odtlačok"> +<!ENTITY authDialog.manualVerification "Manuálne overenie odtlačku"> +<!ENTITY authDialog.questionAndAnswer "Otázka a odpoveď"> +<!ENTITY authDialog.sharedSecret "Zdieľané tajomstvo"> +<!ENTITY authDialog.manualInstruction "Na overenie odtlačku, kontaktujte svojho kamaráta cez autorizovaný kanál, napríklad telefónom alebo GPG podpísaným emailom. Vzájomne si vymeníte svoje odtlačky. Ak všetko sedí, mali by v diálogu dole uviesť, že ste odtlačky overili."> +<!ENTITY authDialog.choose "Vyberte"> +<!ENTITY authDialog.how "Ako chcete overiť totožnosť vášho kontaktu?"> +<!ENTITY authDialog.qaInstruction "Pre overenie totožnosti kontaktu, zvoľte otázku, ktorej odpoveď pozná len váš kontakt. Vložte túto otázku a odpoveď a počkajte, kým aj váš kontakt nevloží odpoveď. Ak sa odpovede nezhodujú, možno sa rozprávate s podvodníkom."> +<!ENTITY authDialog.secretInstruction "Pre overenie totožnosti kontaktu, zvoľte tajomstvo, ktoré poznáte len vy a váš kontakt. Vložte tajomstvo a počkate, kým ho vloží aj váš kontakt. Ak sa tajomstvá nezhodujú, možno sa rozprávate s podvodníkom."> +<!ENTITY authDialog.question "Vložte otázku:"> +<!ENTITY authDialog.answer "Vložte tajnú odpoveď (záleží na veľkosti písmen):"> +<!ENTITY authDialog.secret "Vložte tajomstvo:"> +<!ENTITY authDialog.waiting "Čaká sa na kontakt ..."> \ No newline at end of file

1 0

[translation/tor-messenger-authdtd] Update translations for tor-messenger-authdtd
by translation＠torproject.org 14 Jul '16

14 Jul '16

commit 64d25f08f00776827afafe634742d7e158ece135 Author: Translation commit bot <translation(a)torproject.org> Date: Thu Jul 14 18:47:20 2016 +0000 Update translations for tor-messenger-authdtd --- sk_SK/auth.dtd | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/sk_SK/auth.dtd b/sk_SK/auth.dtd index ec74493..1ae4620 100644 --- a/sk_SK/auth.dtd +++ b/sk_SK/auth.dtd @@ -1,4 +1,4 @@ -<!ENTITY authDialog.title "Overiť kontaktnú identitu."> +<!ENTITY authDialog.title "Overiť identitu kontaktu."> <!ENTITY authDialog.authenticate "Overiť"> <!ENTITY authDialog.cancel "Zrušiť"> <!ENTITY authDialog.help "Pomocník"> @@ -10,12 +10,12 @@ <!ENTITY authDialog.manualVerification "Manuálne overenie odtlačku"> <!ENTITY authDialog.questionAndAnswer "Otázka a odpoveď"> <!ENTITY authDialog.sharedSecret "Zdieľané tajomstvo"> -<!ENTITY authDialog.manualInstruction "To verify the fingerprint, contact your buddy via some other authenticated channel, such as the telephone or GPG-signed email. Each of you should tell your fingerprint to the other. If everything matches up, you should indicate in the dialog below that you have verified the fingerprint."> -<!ENTITY authDialog.choose "Choose"> -<!ENTITY authDialog.how "How would you like to verify your contact's identity?"> -<!ENTITY authDialog.qaInstruction "To verify their identity, pick a question whose answer is known only to you and your contact. Enter this question and answer, then wait for your contact to enter the answer as well. If the answers do not match, then you may be talking to an imposter."> -<!ENTITY authDialog.secretInstruction "To verify their identity, pick a secret known only to you and your contact. Enter this secret, then wait for your contact to enter it as well. If the secrets do not match, then you may be talking to an imposter."> -<!ENTITY authDialog.question "Enter question here:"> -<!ENTITY authDialog.answer "Enter secret answer here (case sensitive):"> -<!ENTITY authDialog.secret "Enter secret here:"> -<!ENTITY authDialog.waiting "Waiting for contact ..."> \ No newline at end of file +<!ENTITY authDialog.manualInstruction "Na overenie odtlačku, kontaktujte svojho kamaráta cez autorizovaný kanál, napríklad telefónom alebo GPG podpísaným emailom. Vzájomne si vymeníte svoje odtlačky. Ak všetko sedí, mali by v diálogu dole uviesť, že ste odtlačky overili."> +<!ENTITY authDialog.choose "Vyberte"> +<!ENTITY authDialog.how "Ako chcete overiť totožnosť vášho kontaktu?"> +<!ENTITY authDialog.qaInstruction "Pre overenie totožnosti kontaktu, zvoľte otázku, ktorej odpoveď pozná len váš kontakt. Vložte túto otázku a odpoveď a počkajte, kým aj váš kontakt nevloží odpoveď. Ak sa odpovede nezhodujú, možno sa rozprávate s podvodníkom."> +<!ENTITY authDialog.secretInstruction "Pre overenie totožnosti kontaktu, zvoľte tajomstvo, ktoré poznáte len vy a váš kontakt. Vložte tajomstvo a počkate, kým ho vloží aj váš kontakt. Ak sa tajomstvá nezhodujú, možno sa rozprávate s podvodníkom."> +<!ENTITY authDialog.question "Vložte otázku:"> +<!ENTITY authDialog.answer "Vložte tajnú odpoveď (záleží na veľkosti písmen):"> +<!ENTITY authDialog.secret "Vložte tajomstvo:"> +<!ENTITY authDialog.waiting "Čaká sa na kontakt ..."> \ No newline at end of file

1 0

[translation/tor-messenger-authdtd] Update translations for tor-messenger-authdtd
by translation＠torproject.org 14 Jul '16

14 Jul '16

commit fac6aa4b044c95b94ffc450afb713634852103f4 Author: Translation commit bot <translation(a)torproject.org> Date: Thu Jul 14 18:17:23 2016 +0000 Update translations for tor-messenger-authdtd --- sk_SK/auth.dtd | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/sk_SK/auth.dtd b/sk_SK/auth.dtd index 5c3d019..ec74493 100644 --- a/sk_SK/auth.dtd +++ b/sk_SK/auth.dtd @@ -1,15 +1,15 @@ -<!ENTITY authDialog.title "Verify contact's identity"> +<!ENTITY authDialog.title "Overiť kontaktnú identitu."> <!ENTITY authDialog.authenticate "Overiť"> <!ENTITY authDialog.cancel "Zrušiť"> <!ENTITY authDialog.help "Pomocník"> <!ENTITY authDialog.yes "Áno"> <!ENTITY authDialog.no "Nie"> -<!ENTITY authDialog.verified "I have verified that this is in fact the correct fingerprint."> -<!ENTITY authDialog.yourFingerprint "Your fingerprint"> -<!ENTITY authDialog.theirFingerprint "Their purported fingerprint"> -<!ENTITY authDialog.manualVerification "Manual fingerprint verification"> -<!ENTITY authDialog.questionAndAnswer "Question and answer"> -<!ENTITY authDialog.sharedSecret "Shared secret"> +<!ENTITY authDialog.verified "Overil som, že sa naozaj jedná o správny odtlačok."> +<!ENTITY authDialog.yourFingerprint "Váš odtlačok"> +<!ENTITY authDialog.theirFingerprint "Ich údajný odtlačok"> +<!ENTITY authDialog.manualVerification "Manuálne overenie odtlačku"> +<!ENTITY authDialog.questionAndAnswer "Otázka a odpoveď"> +<!ENTITY authDialog.sharedSecret "Zdieľané tajomstvo"> <!ENTITY authDialog.manualInstruction "To verify the fingerprint, contact your buddy via some other authenticated channel, such as the telephone or GPG-signed email. Each of you should tell your fingerprint to the other. If everything matches up, you should indicate in the dialog below that you have verified the fingerprint."> <!ENTITY authDialog.choose "Choose"> <!ENTITY authDialog.how "How would you like to verify your contact's identity?">

1 0

[tor-commits] [translation/tor-messenger-accountsproperties_completed] Update translations for tor-messenger-accountsproperties_completed
by translation＠torproject.org 14 Jul '16

14 Jul '16

commit f9487580661196ce937d9b640af95b04cf9f19ad Author: Translation commit bot <translation(a)torproject.org> Date: Thu Jul 14 18:17:19 2016 +0000 Update translations for tor-messenger-accountsproperties_completed --- sk_SK/accounts.properties | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/sk_SK/accounts.properties b/sk_SK/accounts.properties new file mode 100644 index 0000000..4f2562d --- /dev/null +++ b/sk_SK/accounts.properties @@ -0,0 +1,9 @@ +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. + +# LOCALIZATION NOTE (passwordPromptTitle, passwordPromptText): +# %S is replaced with the name of the account +passwordPromptTitle=Heslo pre %S +passwordPromptText=Pre prihlásenie zadajte prosím vaše heslo pre %S. +passwordPromptSaveCheckbox=Použite Password Manager na zapamätanie tohto hesla.

1 0

[translation/tor-messenger-accountsproperties] Update translations for tor-messenger-accountsproperties
by translation＠torproject.org 14 Jul '16

14 Jul '16

commit 6c5547e7d6ea81c5b9244a6079c5ee5ba7aa3a74 Author: Translation commit bot <translation(a)torproject.org> Date: Thu Jul 14 18:17:15 2016 +0000 Update translations for tor-messenger-accountsproperties --- sk_SK/accounts.properties | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/sk_SK/accounts.properties b/sk_SK/accounts.properties index 051ba0d..4f2562d 100644 --- a/sk_SK/accounts.properties +++ b/sk_SK/accounts.properties @@ -4,6 +4,6 @@ # LOCALIZATION NOTE (passwordPromptTitle, passwordPromptText): # %S is replaced with the name of the account -passwordPromptTitle=Password for %S -passwordPromptText=Please enter your password for %S in order to connect it. -passwordPromptSaveCheckbox=Use Password Manager to remember this password. +passwordPromptTitle=Heslo pre %S +passwordPromptText=Pre prihlásenie zadajte prosím vaše heslo pre %S. +passwordPromptSaveCheckbox=Použite Password Manager na zapamätanie tohto hesla.

1 0

[stem/master] Add OnionLauncher and TorNova to examples
by atagar＠torproject.org 14 Jul '16

14 Jul '16

commit 2a869fc4987caeaf006673f6686e64ee3374ad22 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Jul 14 09:35:34 2016 -0700 Add OnionLauncher and TorNova to examples Neat Qt and GTK launchers by Neel... https://lists.torproject.org/pipermail/tor-talk/2016-July/041770.html --- docs/tutorials/double_double_toil_and_trouble.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/tutorials/double_double_toil_and_trouble.rst b/docs/tutorials/double_double_toil_and_trouble.rst index 8dfbf4b..d5f7e79 100644 --- a/docs/tutorials/double_double_toil_and_trouble.rst +++ b/docs/tutorials/double_double_toil_and_trouble.rst @@ -57,6 +57,8 @@ Applications research paper. =========================================================================================================== ========== +`OnionLauncher <https://github.com/neelchauhan/OnionLauncher>`_ Qt interface for launching tor. +`TorNova <https://github.com/neelchauhan/TorNova>`_ GTK interface for launching tor. `BeagleBone for Secret Agents <https://github.com/jbdatko/beagle-bone-for-secret-agents>`_ Bridge with a `bandwidth monitor <https://github.com/jbdatko/beagle-bone-for-secret-agents/blob/master/ch2/be…>`_ on a BeagleBoard. `NavigaTor <https://naviga-tor.github.io>`_ Measures round-trip times for Tor circuits. `TorPS <https://www.torproject.org/getinvolved/volunteer.html.en#project-torps>`_ Tor path simulator.

1 0

[tor-browser/tor-browser-45.2.0esr-6.5-1] Bug 18923: Add a script to run all Tor Browser specific tests
by gk＠torproject.org 14 Jul '16

14 Jul '16

commit 1198d77c4ef82db7878e04920523b13ab0e678e6 Author: Nicolas Vigier <boklm(a)torproject.org> Date: Thu Jul 14 17:09:12 2016 +0200 Bug 18923: Add a script to run all Tor Browser specific tests --- run-tbb-tests | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++ tbb-tests-ignore.txt | 4 ++++ 2 files changed, 64 insertions(+) diff --git a/run-tbb-tests b/run-tbb-tests new file mode 100755 index 0000000..5e266f9 --- /dev/null +++ b/run-tbb-tests @@ -0,0 +1,60 @@ +#!/bin/bash + +# This script runs all the Mochitest tests that have been added or +# modified since the last ffxbld commit. +# +# It does not currently run XPCShell tests. We should change this if we +# start using this type or other types of tests. +# +# The logs of the tests are stored in the tbb-tests.log file. +# Ignored tests are listed in the tbb-tests-ignore.txt file. +# +# https://trac.torproject.org/projects/tor/ticket/18923 + +IFS=$'\n' + +if [ -n "$USE_TESTS_LIST" ] && [ -f tbb-tests-list.txt ] +then + echo "Using tests list from file tbb-tests-list.txt" + tests=($(cat tbb-tests-list.txt)) +else + ffxbld_commit=$(git log -500 --format='%an %H' | grep '^ffxbld ' \ + | head -1 | cut -d ' ' -f 2) + + tests=($(git diff --name-status "$ffxbld_commit" HEAD | \ + grep -e '^[AM].*/test_[^/]\+\.$html\|xul$$' \ + -e '^[AM].*/browser_[^/]\+\.js$' \ + | sed 's/^[AM]\s\+//')) +fi + +echo 'The following tests will be run:' +for i in "${!tests[@]}" +do + if [ -z "$USE_TESTS_LIST" ] \ + && grep -q "^${tests[$i]}$" tbb-tests-ignore.txt + then + unset "tests[$i]" + continue + fi + echo "- ${tests[$i]}" +done + +if [ -n "$WRITE_TESTS_LIST" ] +then + rm -f tbb-tests-list.txt + for i in "${!tests[@]}" + do + echo "${tests[$i]}" >> tbb-tests-list.txt + done + exit 0 +fi + +rm -f tbb-tests.log +echo $'\n''Starting tests' +./mach mochitest --log-tbpl tbb-tests.log --setpref security.nocertdb=false \ + "${tests[@]}" + +echo "*************************" +echo "*************************" +echo "Summary of failed tests:" +grep --color=never TEST-UNEXPECTED-FAIL tbb-tests.log diff --git a/tbb-tests-ignore.txt b/tbb-tests-ignore.txt new file mode 100644 index 0000000..00978df --- /dev/null +++ b/tbb-tests-ignore.txt @@ -0,0 +1,4 @@ +# This file contains the list of tests ignored by the run-tbb-tests script + +#19575: Test for privacy.thirdparty.isolate fails with a timeout +dom/tests/mochitest/localstorage/test_localStorageByFirstParty.html

1 0

[collector/master] Enable suppression annotations for checkstyle.
by karsten＠torproject.org 14 Jul '16

14 Jul '16

commit 4383ae9386a0cc41d48885266313eb94253301a8 Author: iwakeh <iwakeh(a)torproject.org> Date: Wed Jul 13 17:54:58 2016 +0200 Enable suppression annotations for checkstyle. --- src/test/resources/metrics_checks.xml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/test/resources/metrics_checks.xml b/src/test/resources/metrics_checks.xml index 0777894..2df2f2a 100644 --- a/src/test/resources/metrics_checks.xml +++ b/src/test/resources/metrics_checks.xml @@ -14,6 +14,8 @@ - Relaxed requirement that catch parameters must be at least two characters long [CatchParameterName]. + - Enabled suppression of warnings using annotations. + Checkstyle is very configurable. Be sure to read the documentation at http://checkstyle.sf.net (or in your downloaded distribution). @@ -34,6 +36,7 @@ <property name="eachLine" value="true"/> </module> + <module name="SuppressWarningsFilter" /> <module name="TreeWalker"> <module name="OuterTypeFilename"/> <module name="IllegalTokenText"> @@ -213,5 +216,6 @@ <property name="exceptionVariableName" value="expected"/> </module> <module name="CommentsIndentation"/> + <module name="SuppressWarningsHolder" /> </module> </module>

1 0

[collector/master] Write Javadocs to appease checkstyle.
by karsten＠torproject.org 14 Jul '16

14 Jul '16

commit 74bae5b448fd8684fcbfe06a409df459d1f539d3 Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Thu Jul 14 14:04:20 2016 +0200 Write Javadocs to appease checkstyle. --- .../bridgedescs/BridgeDescriptorParser.java | 6 +++-- .../bridgedescs/SanitizedBridgesWriter.java | 3 ++- .../collector/exitlists/ExitListDownloader.java | 2 +- .../collector/index/CreateIndexJson.java | 3 ++- .../org/torproject/collector/main/LockFile.java | 6 +++-- .../collector/relaydescs/ArchiveReader.java | 9 ++++++-- .../collector/relaydescs/ArchiveWriter.java | 26 +++++++++++++--------- .../relaydescs/CachedRelayDescriptorReader.java | 3 ++- .../collector/relaydescs/ReferenceChecker.java | 5 +++-- .../relaydescs/RelayDescriptorParser.java | 9 ++++++-- .../collector/torperf/TorperfDownloader.java | 2 +- 11 files changed, 49 insertions(+), 25 deletions(-) diff --git a/src/main/java/org/torproject/collector/bridgedescs/BridgeDescriptorParser.java b/src/main/java/org/torproject/collector/bridgedescs/BridgeDescriptorParser.java index 337c2a3..6dc05b6 100644 --- a/src/main/java/org/torproject/collector/bridgedescs/BridgeDescriptorParser.java +++ b/src/main/java/org/torproject/collector/bridgedescs/BridgeDescriptorParser.java @@ -16,14 +16,16 @@ public class BridgeDescriptorParser { private Logger logger; - @SuppressWarnings("checkstyle:javadocmethod") + /** Initializes a new bridge descriptor parser and links it to a + * sanitized bridges writer to sanitize and store bridge descriptors. */ public BridgeDescriptorParser(SanitizedBridgesWriter sbw) { this.sbw = sbw; this.logger = LoggerFactory.getLogger(BridgeDescriptorParser.class); } - @SuppressWarnings("checkstyle:javadocmethod") + /** Parses the first line of the given descriptor data to determine the + * descriptor type and passes it to the sanitized bridges writer. */ public void parse(byte[] allData, String dateTime) { try { BufferedReader br = new BufferedReader(new StringReader( diff --git a/src/main/java/org/torproject/collector/bridgedescs/SanitizedBridgesWriter.java b/src/main/java/org/torproject/collector/bridgedescs/SanitizedBridgesWriter.java index 1f48fb7..b1b9589 100644 --- a/src/main/java/org/torproject/collector/bridgedescs/SanitizedBridgesWriter.java +++ b/src/main/java/org/torproject/collector/bridgedescs/SanitizedBridgesWriter.java @@ -54,7 +54,8 @@ public class SanitizedBridgesWriter extends Thread { private static Logger logger = LoggerFactory.getLogger(SanitizedBridgesWriter.class); - @SuppressWarnings("checkstyle:javadocmethod") + /** Executes the bridge-descriptors module using the given + * configuration. */ public static void main(Configuration config) throws ConfigurationException { logger.info("Starting bridge-descriptors module of CollecTor."); diff --git a/src/main/java/org/torproject/collector/exitlists/ExitListDownloader.java b/src/main/java/org/torproject/collector/exitlists/ExitListDownloader.java index f54a427..5e17971 100644 --- a/src/main/java/org/torproject/collector/exitlists/ExitListDownloader.java +++ b/src/main/java/org/torproject/collector/exitlists/ExitListDownloader.java @@ -36,7 +36,7 @@ public class ExitListDownloader extends Thread { private static Logger logger = LoggerFactory.getLogger(ExitListDownloader.class); - @SuppressWarnings("checkstyle:javadocmethod") + /** Execute the exit-lists module using the given configuration. */ public static void main(Configuration config) throws ConfigurationException { logger.info("Starting exit-lists module of CollecTor."); diff --git a/src/main/java/org/torproject/collector/index/CreateIndexJson.java b/src/main/java/org/torproject/collector/index/CreateIndexJson.java index 70886bc..a39ef67 100644 --- a/src/main/java/org/torproject/collector/index/CreateIndexJson.java +++ b/src/main/java/org/torproject/collector/index/CreateIndexJson.java @@ -52,7 +52,8 @@ public class CreateIndexJson { static final TimeZone dateTimezone = TimeZone.getTimeZone("UTC"); - @SuppressWarnings("checkstyle:javadocmethod") + /** Creates indexes of directories containing archived and recent + * descriptors and write index files to disk. */ public static void main(Configuration config) throws ConfigurationException, IOException { indexJsonFile = new File(config.getPath(Key.IndexPath).toFile(), "index.json"); diff --git a/src/main/java/org/torproject/collector/main/LockFile.java b/src/main/java/org/torproject/collector/main/LockFile.java index 83cb603..977b0b9 100644 --- a/src/main/java/org/torproject/collector/main/LockFile.java +++ b/src/main/java/org/torproject/collector/main/LockFile.java @@ -28,7 +28,9 @@ public class LockFile { this.moduleName = moduleName; } - @SuppressWarnings("checkstyle:javadocmethod") + /** Acquires the lock by checking whether a lock file already exists, + * and if not, by creating one with the current system time as + * content. */ public boolean acquireLock() { this.logger.debug("Trying to acquire lock..."); try { @@ -54,7 +56,7 @@ public class LockFile { } } - @SuppressWarnings("checkstyle:javadocmethod") + /** Releases the lock by deleting the lock file, if present. */ public void releaseLock() { this.logger.debug("Releasing lock..."); this.lockFile.delete(); diff --git a/src/main/java/org/torproject/collector/relaydescs/ArchiveReader.java b/src/main/java/org/torproject/collector/relaydescs/ArchiveReader.java index 8d82f5c..25f5859 100644 --- a/src/main/java/org/torproject/collector/relaydescs/ArchiveReader.java +++ b/src/main/java/org/torproject/collector/relaydescs/ArchiveReader.java @@ -43,7 +43,9 @@ public class ArchiveReader { private Map<String, Set<String>> microdescriptorValidAfterTimes = new HashMap<String, Set<String>>(); - @SuppressWarnings("checkstyle:javadocmethod") + /** Reads all descriptors from the given directory, possibly using a + * parse history file, and passes them to the given descriptor + * parser. */ public ArchiveReader(RelayDescriptorParser rdp, File archivesDirectory, File statsDirectory, boolean keepImportHistory) { @@ -272,7 +274,10 @@ public class ArchiveReader { + ignoredFiles + " files."); } - @SuppressWarnings("checkstyle:javadocmethod") + /** Stores the valid-after time and microdescriptor digests of a given + * microdesc consensus, so that microdescriptors (which don't contain a + * publication time) can later be sorted into the correct month + * folders. */ public void haveParsedMicrodescConsensus(String validAfterTime, SortedSet<String> microdescriptorDigests) { for (String microdescriptor : microdescriptorDigests) { diff --git a/src/main/java/org/torproject/collector/relaydescs/ArchiveWriter.java b/src/main/java/org/torproject/collector/relaydescs/ArchiveWriter.java index 3c3272c..3715a9f 100644 --- a/src/main/java/org/torproject/collector/relaydescs/ArchiveWriter.java +++ b/src/main/java/org/torproject/collector/relaydescs/ArchiveWriter.java @@ -108,7 +108,8 @@ public class ArchiveWriter extends Thread { private static final String MICRODESC = "microdesc"; private static final String MICRODESCS = "microdescs"; - @SuppressWarnings("checkstyle:javadocmethod") + /** Executes the relay-descriptors module using the given + * configuration. */ public static void main(Configuration config) throws ConfigurationException { logger.info("Starting relay-descriptors module of CollecTor."); @@ -134,7 +135,7 @@ public class ArchiveWriter extends Thread { logger.info("Terminating relay-descriptors module of CollecTor."); } - @SuppressWarnings("checkstyle:javadocmethod") + /** Initialize an archive writer with a given configuration. */ public ArchiveWriter(Configuration config) throws ConfigurationException { this.config = config; storedServerDescriptorsFile = @@ -319,7 +320,8 @@ public class ArchiveWriter extends Thread { } } - @SuppressWarnings("checkstyle:javadocmethod") + /** Compiles a message with statistics on stored descriptors by type for + * later inclusion in the log and resets counters. */ public void intermediateStats(String event) { intermediateStats.append("While " + event + ", we stored " + this.storedConsensusesCounter + " consensus(es), " @@ -649,7 +651,8 @@ public class ArchiveWriter extends Thread { } } - @SuppressWarnings("checkstyle:javadocmethod") + /** Stores a consensus to disk and adds all referenced votes and server + * descriptors to the list of missing descriptors. */ public void storeConsensus(byte[] data, long validAfter, SortedSet<String> dirSources, SortedSet<String> serverDescriptorDigests) { @@ -672,7 +675,8 @@ public class ArchiveWriter extends Thread { } } - @SuppressWarnings("checkstyle:javadocmethod") + /** Stores a microdesc consensus to disk and adds all referenced + * microdescriptors to the list of missing descriptors. */ public void storeMicrodescConsensus(byte[] data, long validAfter, SortedSet<String> microdescriptorDigests) { SimpleDateFormat yearMonthDirectoryFormat = new SimpleDateFormat( @@ -699,7 +703,8 @@ public class ArchiveWriter extends Thread { } } - @SuppressWarnings("checkstyle:javadocmethod") + /** Stores a vote to disk and adds all referenced server descriptors to + * the list of missing descriptors. */ public void storeVote(byte[] data, long validAfter, String fingerprint, String digest, SortedSet<String> serverDescriptorDigests) { @@ -727,7 +732,7 @@ public class ArchiveWriter extends Thread { } } - @SuppressWarnings("checkstyle:javadocmethod") + /** Stores a key certificate to disk. */ public void storeCertificate(byte[] data, String fingerprint, long published) { SimpleDateFormat printFormat = new SimpleDateFormat( @@ -741,7 +746,8 @@ public class ArchiveWriter extends Thread { } } - @SuppressWarnings("checkstyle:javadocmethod") + /** Stores a server descriptor to disk and adds the referenced + * extra-info descriptor to the list of missing descriptors. */ public void storeServerDescriptor(byte[] data, String digest, long published, String extraInfoDigest) { SimpleDateFormat printFormat = new SimpleDateFormat("yyyy/MM/"); @@ -770,7 +776,7 @@ public class ArchiveWriter extends Thread { } } - @SuppressWarnings("checkstyle:javadocmethod") + /** Stores an extra-info descriptor to disk. */ public void storeExtraInfoDescriptor(byte[] data, String extraInfoDigest, long published) { SimpleDateFormat descriptorFormat = new SimpleDateFormat("yyyy/MM/"); @@ -798,7 +804,7 @@ public class ArchiveWriter extends Thread { } } - @SuppressWarnings("checkstyle:javadocmethod") + /** Stores a microdescriptor to disk. */ public void storeMicrodescriptor(byte[] data, String microdescriptorDigest, long validAfter) { /* TODO We could check here whether we already stored the diff --git a/src/main/java/org/torproject/collector/relaydescs/CachedRelayDescriptorReader.java b/src/main/java/org/torproject/collector/relaydescs/CachedRelayDescriptorReader.java index f947895..6c18cdb 100644 --- a/src/main/java/org/torproject/collector/relaydescs/CachedRelayDescriptorReader.java +++ b/src/main/java/org/torproject/collector/relaydescs/CachedRelayDescriptorReader.java @@ -36,7 +36,8 @@ import java.util.TreeSet; */ public class CachedRelayDescriptorReader { - @SuppressWarnings("checkstyle:javadocmethod") + /** Reads cached-descriptor files from one or more directories and + * passes them to the given descriptor parser. */ public CachedRelayDescriptorReader(RelayDescriptorParser rdp, String[] inputDirectories, File statsDirectory) { diff --git a/src/main/java/org/torproject/collector/relaydescs/ReferenceChecker.java b/src/main/java/org/torproject/collector/relaydescs/ReferenceChecker.java index efbcbe0..a749ff5 100644 --- a/src/main/java/org/torproject/collector/relaydescs/ReferenceChecker.java +++ b/src/main/java/org/torproject/collector/relaydescs/ReferenceChecker.java @@ -68,7 +68,7 @@ public class ReferenceChecker { private static final long THIRTY_DAYS = 30L * ONE_DAY; - @SuppressWarnings("checkstyle:javadocmethod") + /** Initializes a reference checker using the given file paths. */ public ReferenceChecker(File descriptorsDir, File referencesFile, File historyFile) { this.descriptorsDir = descriptorsDir; @@ -76,7 +76,8 @@ public class ReferenceChecker { this.historyFile = historyFile; } - @SuppressWarnings("checkstyle:javadocmethod") + /** Checks references between descriptors, and if too many referenced + * descriptors are missing, puts out a warning to the logs. */ public void check() { this.getCurrentTimeMillis(); this.readReferencesFile(); diff --git a/src/main/java/org/torproject/collector/relaydescs/RelayDescriptorParser.java b/src/main/java/org/torproject/collector/relaydescs/RelayDescriptorParser.java index 027237e..946a494 100644 --- a/src/main/java/org/torproject/collector/relaydescs/RelayDescriptorParser.java +++ b/src/main/java/org/torproject/collector/relaydescs/RelayDescriptorParser.java @@ -70,7 +70,10 @@ public class RelayDescriptorParser { this.ar = ar; } - @SuppressWarnings("checkstyle:javadocmethod") + /** Parses the given bytes to find out the contained descriptor type, + * forwards them to the archive writer to store them to disk, and tells + * the relay descriptor downloader and archive reader about the + * contained descriptor and all referenced descriptors. */ public boolean parse(byte[] data) { boolean stored = false; try { @@ -326,7 +329,9 @@ public class RelayDescriptorParser { return stored; } - @SuppressWarnings("checkstyle:javadocmethod") + /** Forwards the given microdescriptor to the archive writer to store + * it to disk and tells the relay descriptor downloader that this + * microdescriptor is not missing anymore. */ public void storeMicrodescriptor(byte[] data, String digest256Hex, String digest256Base64, long validAfter) { if (this.aw != null) { diff --git a/src/main/java/org/torproject/collector/torperf/TorperfDownloader.java b/src/main/java/org/torproject/collector/torperf/TorperfDownloader.java index 02d17ed..25164c9 100644 --- a/src/main/java/org/torproject/collector/torperf/TorperfDownloader.java +++ b/src/main/java/org/torproject/collector/torperf/TorperfDownloader.java @@ -36,7 +36,7 @@ import java.util.TreeMap; public class TorperfDownloader extends Thread { private static Logger logger = LoggerFactory.getLogger(TorperfDownloader.class); - @SuppressWarnings("checkstyle:javadocmethod") + /** Executes the torperf module using the given configuration. */ public static void main(Configuration config) throws ConfigurationException { logger.info("Starting torperf module of CollecTor.");

1 0