Refactor for Python3 (#28091)

.gitignore

@@ -0,0 +1 @@
+__pycache__

README.md

@@ -82,6 +82,10 @@ with gtalk users.
 *Twitter*: Receive requests via Twitter direct messages, contact the core module
 if necessary and respond to the user in the specified language. Unfinished.
 
+*Github*: Run `torsocks python3 create_gh_mirrors.py` to update the github
+archive at https://github.com/TheTorProject/gettor - it depends on the github3
+and urllib modules.
+
 *DB*: Store anonymous info about the people that interact with GetTor in order
 to keep count of the number of requests per person and avoid malicious users
 that try to collapse the service. It also keeps count of how many requests

core_demo.py

@@ -8,12 +8,12 @@
 try:
     core = gettor.core.Core()
     links = core.get_links('dummy service', 'linux', 'en')
-    print links
+    print(links)
 except gettor.core.ConfigError as e:
-    print "Misconfiguration: " + str(e)
+    print("Misconfiguration: " + str(e))
 except gettor.core.UnsupportedOSError as e:
-    print "Unsupported OS: " + str(e)
+    print("Unsupported OS: " + str(e))
 except gettor.core.UnsupportedLocaleError as e:
-    print "Unsupported Locale: " + str(e)
+    print("Unsupported Locale: " + str(e))
 except gettor.core.InternalError as e:
-    print "Internal error: " + str(e)
+    print("Internal error: " + str(e))

create_gh_mirrors.py

@@ -10,7 +10,7 @@
 """create_gh_mirrors -- Create landing page and readme for Github."""
 
 import os
-import ConfigParser
+import configparser
 
 import github3
 
@@ -78,7 +78,7 @@ def create_readme(tpl_path, md_path, tb_version, links):
         content_md = content_md.replace("%TB_VERSION%", tb_version)
         md_file.write(content_md)
 
-    print "README generated with Tor Browser %s" % tb_version
+    print(("README generated with Tor Browser %s" % tb_version))
 
 
 def create_landing_html(tpl_path, html_path, tb_version, links):
@@ -111,7 +111,7 @@ def create_landing_html(tpl_path, html_path, tb_version, links):
             linux64_pkg, linux64_sig, linux64_sha = [
                 e for e in linux64_link.split("$") if e
             ]
-            
+
             content_html = content_html.replace(
                 "%WINDOWS_{}%".format(lc), win_pkg
             )
@@ -144,13 +144,13 @@ def create_landing_html(tpl_path, html_path, tb_version, links):
                 "%LINUX64_{}_SIG%".format(lc), linux64_sig
             )
             """
-        
+
         content_html = content_html.replace(
             "%TB_VERSION%", tb_version
         )
         html_file.write(content_html)
 
-    print "HTML generated with Tor Browser %s" % tb_version
+    print(("HTML generated with Tor Browser %s" % tb_version))
 
 
 def main():
@@ -163,11 +163,16 @@ def main():
     html_tpl_path = 'upload/landing_gh.tpl'
     github_access_token = ''
 
-    tb_version_config = ConfigParser.ConfigParser()
-    tb_version_config.read(tb_version_path)
-    tb_version = tb_version_config.get('version', 'current')
+    try:
+        tb_version_config = configparser.ConfigParser()
+        tb_version_config.read(tb_version_path)
+        tb_version = tb_version_config['version']['current']
+
+    except:
+        raise SystemExit("Failed to parse %s. Does it exist?" % tb_version_path)
+        # TODO add some hint how to generate it
 
-    links = ConfigParser.ConfigParser()
+    links = configparser.ConfigParser()
     links.read(github_links)
 
     create_landing_html(html_tpl_path, html_path, tb_version, links)
@@ -198,10 +203,10 @@ def main():
     }
 
     file_landing_gh.update(**data_landing)
-    print "Landing page updated in gettor"
+    print ("Landing page updated in gettor")
 
     file_readme_gh.update(**data_readme)
-    print "README updated in gettorbrowser"
+    print ("README updated in gettorbrowser")
 
 if __name__ == "__main__":
     main()

get_mirrors.py

@@ -137,7 +137,7 @@ def handle(failure):
     else:
         logging.error("Couldn't download file.")
 
-    print "Couldn't download file. Check the log."
+    print("Couldn't download file. Check the log.")
     os._exit(-1)
 
 
@@ -153,7 +153,7 @@ def is_json(my_json):
     """Check if json generated is valid."""
     try:
         json_object = json.loads(my_json)
-    except ValueError, e:
+    except ValueError as e:
         return False
     return True
 

gettor/blacklist.py

@@ -15,10 +15,10 @@
 import logging
 import sqlite3
 import datetime
-import ConfigParser
+import configparser
 
-import db
-import utils
+from . import db
+from . import utils
 
 """Blacklist module for managing blacklisting of users."""
 
@@ -57,7 +57,7 @@ def __init__(self, cfg=None):
 
         """
         default_cfg = 'blacklist.cfg'
-        config = ConfigParser.ConfigParser()
+        config = configparser.ConfigParser()
 
         if cfg is None or not os.path.isfile(cfg):
             cfg = default_cfg
@@ -75,7 +75,7 @@ def __init__(self, cfg=None):
             loglevel = config.get('log', 'level')
             self.db = db.DB(dbname)
 
-        except ConfigParser.Error as e:
+        except configparser.Error as e:
             raise ConfigError("%s" % e)
         except db.Exception as e:
             raise ConfigError("%s" % e)

gettor/core.py

@@ -15,10 +15,10 @@
 import logging
 import gettext
 import tempfile
-import ConfigParser
+import configparser
 
-import db
-import utils
+from . import db
+from . import utils
 
 """Core module for getting links from providers."""
 
@@ -65,7 +65,7 @@ class Core(object):
     """
 
     def __init__(self, cfg=None):
-    	"""Create a new core object by reading a configuration file.
+        """Create a new core object by reading a configuration file.
 
         :param: cfg (string) the path of the configuration file.
         :raise: ConfigurationError if the configuration file doesn't exists

gettor/db.py

@@ -39,7 +39,7 @@ class DB(object):
     """
 
     def __init__(self, dbname):
-    	"""Create a new db object.
+        """Create a new db object.
 
         :param: dbname (string) the path of the database.
 

gettor/http.py

@@ -14,13 +14,13 @@
 import re
 import json
 import codecs
-import urllib2
-import ConfigParser
+import urllib.request, urllib.error, urllib.parse
+import configparser
 
 from time import gmtime, strftime
 
-import core
-import utils
+from . import core
+from . import utils
 
 """GetTor RESTful API"""
 
@@ -80,7 +80,7 @@ def __init__(self, cfg=None):
 
         """
         default_cfg = 'http.cfg'
-        config = ConfigParser.ConfigParser()
+        config = configparser.ConfigParser()
 
         if cfg is None or not os.path.isfile(cfg):
             cfg = default_cfg
@@ -93,16 +93,16 @@ def __init__(self, cfg=None):
 
         try:
             # path to static tree of API
-            self.tree = config.get('general', 'tree')
+            self.tree = config['general']['tree']
             # server that provides the RESTful API
-            self.server = config.get('general', 'url')
+            self.server = config['general']['url']
             # path to the links files
-            self.links_path = config.get('general', 'links')
+            self.links_path = config['general']['links']
             # path to mirrors in json
-            self.mirrors_path = config.get('general', 'mirrors')
+            self.mirrors_path = config['general']['mirrors']
 
             # we will ask gettor.core for the links
-            core_cfg = config.get('general', 'core')
+            core_cfg = config['general']['core']
             self.core = core.Core(core_cfg)
 
         except ConfigParser.Error as e:
@@ -120,10 +120,10 @@ def _is_json(self, my_json):
         """
         try:
             json_object = json.loads(my_json)
-        except ValueError, e:
+        except ValueError as e:
             return False
         return True
-    
+
     def _write_json(self, path, content):
         """
         """
@@ -144,8 +144,8 @@ def _write_json(self, path, content):
                 )
         except IOError as e:
             #logging.error("Couldn't write json: %s" % str(e))
-            print "Error building %s: %s" % (path, str(e))
-        print "%s built" % path
+            print(("Error building %s: %s" % (path, str(e))))
+        print(("%s built" % path))
 
     def _get_provider_name(self, p):
         """ Return simplified version of provider's name.
@@ -202,7 +202,7 @@ def _add_links(self, lv, release, version, os):
 
     def _load_latest_version(self):
         """ Load latest version data. """
-        response = urllib2.urlopen(URL['version'])
+        response = urllib.request.urlopen(URL['version'])
         json_response = json.load(response)
 
         lv = {
@@ -377,7 +377,7 @@ def load_data(self):
     def build(self):
         """ Build RESTful API. """
 
-        print "Building API"
+        print ("Building API")
 
         # resources
         self._write_json(

gettor/smtp.py

@@ -20,16 +20,16 @@
 import logging
 import smtplib
 import datetime
-import ConfigParser
+import configparser
 
 from email import Encoders
 from email.MIMEBase import MIMEBase
 from email.mime.text import MIMEText
 from email.MIMEMultipart import MIMEMultipart
 
-import core
-import utils
-import blacklist
+from . import core
+from . import utils
+from . import blacklist
 
 """SMTP module for processing email requests."""
 
@@ -79,7 +79,7 @@ def __init__(self, cfg=None):
 
         """
         default_cfg = 'smtp.cfg'
-        config = ConfigParser.ConfigParser()
+        config = configparser.ConfigParser()
 
         if cfg is None or not os.path.isfile(cfg):
             cfg = default_cfg
@@ -109,7 +109,7 @@ def __init__(self, cfg=None):
             core_cfg = config.get('general', 'core_cfg')
             self.core = core.Core(core_cfg)
 
-        except ConfigParser.Error as e:
+        except configparser.Error as e:
             raise ConfigError("Configuration error: %s" % str(e))
         except blacklist.ConfigError as e:
             raise InternalError("Blacklist error: %s" % str(e))

gettor/twitter.py

@@ -16,11 +16,11 @@
 import tweepy
 import logging
 import gettext
-import ConfigParser
+import configparser
 
-import core
-import utils
-import blacklist
+from . import core
+from . import utils
+from . import blacklist
 
 """Twitter channel for distributing links to download Tor Browser."""
 
@@ -60,7 +60,7 @@ def __init__(self, cfg=None):
         """
 
         default_cfg = 'twitter.cfg'
-        config = ConfigParser.ConfigParser()
+        config = configparser.ConfigParser()
 
         if cfg is None or not os.path.isfile(cfg):
             cfg = default_cfg
@@ -94,7 +94,7 @@ def __init__(self, cfg=None):
             core_cfg = config.get('general', 'core_cfg')
             self.core = core.Core(core_cfg)
 
-        except ConfigParser.Error as e:
+        except configparser.Error as e:
             raise ConfigError("Configuration error: %s" % str(e))
         except blacklist.ConfigError as e:
             raise InternalError("Blacklist error: %s" % str(e))

gettor/xmpp.py

@@ -17,15 +17,15 @@
 import gettext
 import hashlib
 import logging
-import ConfigParser
+import configparser
 
 from sleekxmpp import ClientXMPP
 from sleekxmpp.xmlstream.stanzabase import JID
 from sleekxmpp.exceptions import IqError, IqTimeout
 
-import core
-import utils
-import blacklist
+from . import core
+from . import utils
+from . import blacklist
 
 
 """XMPP module for processing requests."""
@@ -104,7 +104,7 @@ def __init__(self, cfg=None):
         """
         # define a set of default values
         default_cfg = 'xmpp.cfg'
-        config = ConfigParser.ConfigParser()
+        config = configparser.ConfigParser()
 
         if cfg is None or not os.path.isfile(cfg):
             cfg = default_cfg
@@ -137,7 +137,7 @@ def __init__(self, cfg=None):
             logfile = os.path.join(logdir, 'xmpp.log')
             loglevel = config.get('log', 'level')
 
-        except ConfigParser.Error as e:
+        except configparser.Error as e:
             raise ConfigError("Configuration error: %s" % str(e))
         except blacklist.ConfigError as e:
             raise InternalError("Blacklist error: %s" % str(e))