Merged i18n into master

Author: chbeltz

README.md

@@ -80,7 +80,15 @@ For the mediator payment, a mandatory multisig address is created. To spend the
 
 Like with the primary payment, a user is prompted for a signed mediator payment if they are a job creator accepting a delivery or they are the mediator resolving a dispute.
 
-## Development and Testing
+## Developer Notes
+
+We have [a quick Vagrant-based setup](https://github.com/ReinProject/devsetup) that gives you a virtual machine with the python-rein client, Causway server and its Bitcoin Core (testnet) node all configured to work together. Testing usually involves creating users and walking through jobs so a virtual machine that has all components going, even allowing payments to be sent is very helpful.
+
+To generate or update pot files for translation, run the following from the root of the repo:
+
+    xgettext.pl rein/cli.py rein/lib/*.py
+
+## Testing
 
 We have [a quick Vagrant-based setup](https://github.com/ReinProject/devsetup) that gives you a virtual machine with the python-rein client, Causway server and its Bitcoin Core (testnet) node all configured to work together. Testing usually involves creating users and walking through jobs so a virtual machine that has all components going, even allowing payments to be sent is very helpful.
 

rein/cli.py

@@ -26,6 +26,7 @@
 from .lib.util import unique
 from .lib.io import safe_get
 from .lib.script import build_2_of_3, build_mandatory_multisig, check_redeem_scripts
+from .lib.localization import init_localization
 from .lib.transaction import partial_spend_p2sh, spend_p2sh, spend_p2sh_mediator, partial_spend_p2sh_mediator, partial_spend_p2sh_mediator_2
 from .lib.rating import add_rating, get_user_jobs
 
@@ -45,17 +46,20 @@
 from .lib.mediator import Mediator
 
 rein = config.Config()
+init_localization()
+
 import bitcoin
 from bitcoin.wallet import P2PKHBitcoinAddress
 from bitcoin.core import x
 if (rein.testnet): bitcoin.SelectParams('testnet')
+init_localization()
 
 
 @click.group()
 @click.option('--debug/--no-debug', default=False)
 @click.pass_context
 def cli(ctx, debug):
-    """
+    _("""
     Rein is a decentralized professional services market and Python-rein is a client
 that provides a user interface. Use this program from your local browser or command 
 line to create an account, post a job, bid, etc.
@@ -79,7 +83,7 @@ def cli(ctx, debug):
         $ rein resolve          - mediator posts decision
 
     For more info and the setup guide visit: http://reinproject.org
-    """
+    """)
     if debug:
         click.echo("Debuggin'")
     pass
@@ -88,23 +92,24 @@ def cli(ctx, debug):
 @cli.command()
 @click.option('--multi/--no-multi', default=False, help="add even if an identity exists")
 def setup(multi):
-    """
+    _("""
     Setup or import an identity.
 
     You will choose a name or handle for your account, include public contact information, 
     and a delegate Bitcoin address/private key that the program will use to sign documents
     on your behalf. An enrollment document will be created and you will need to sign it
     with your master Bitcoin private key.
-    """
+    """)
     log = rein.get_log()
     if multi:
         rein.set_multiuser()
     log.info('entering setup')
     if multi or rein.has_no_account():
-        click.echo("\n" + highlight("Welcome to Rein.", True, True) + "\n\n"
-                   "Do you want to import a backup or create a new account?\n\n"
-                   "1 - Create new account\n2 - Import backup\n")
+        click.echo("\n" + highlight(_("Welcome to Rein."), True, True) + "\n\n" +
+                   _("Do you want to import a backup or create a new account?\n\n") +
+                   _("1 - Create new account\n2 - Import backup\n"))
         choice = click.prompt(highlight("Choice", True, True), type=int, default=1)
+
         if choice == 1:
             create_account(rein)
             log.info('account created')

rein/lib/forms.py

@@ -16,16 +16,16 @@
 
 def validate_privkey(form, field):
     if not privkey_to_address(field.data):
-        raise ValidationError("Not a valid private key.")
+        raise ValidationError(_("Not a valid private key."))
 
 def validate_address(form, field):
     if not check_bitcoin_address(field.data):
-        raise ValidationError("Invalid address")
+        raise ValidationError(_("Invalid address"))
 
 def validate_en(form, field):
     message = field.data.replace("\r\n","\n")
     if not validate_enrollment(message):
-        raise ValidationError("Invalid signature")
+        raise ValidationError(_("Invalid signature"))
 
 def validate_mediator_fee(form, field):
     try:
@@ -38,55 +38,55 @@ def avoid_self_rating(form, field):
         raise ValidationError('You may not rate yourself!')
 
 class SetupForm(Form):
-    name = TextField('Name / Handle', validators = [Required()])
-    contact = TextField('Email / Bitmessage', validators = [Required()])
-    maddr = TextField('Master Bitcoin address', validators = [Required(), validate_address])
-    daddr = TextField('Delegate Bitcoin address', validators = [Required(), validate_address])
-    dkey = PasswordField('Delegate Bitcoin private Key', validators = [Required(), validate_privkey])
-    will_mediate = RadioField('Register as a mediator?', choices = [('1','Yes'), ('0', 'No')])
-    mediator_fee = TextField('Mediator Fee', validators = [validate_mediator_fee])  # TODO make required only if Yes above
+    name = TextField(_('Name / Handle'), validators = [Required()])
+    contact = TextField(_('Email / Bitmessage'), validators = [Required()])
+    maddr = TextField(_('Master Bitcoin address'), validators = [Required(), validate_address])
+    daddr = TextField(_('Delegate Bitcoin address'), validators = [Required(), validate_address])
+    dkey = PasswordField(_('Delegate Bitcoin private Key'), validators = [Required(), validate_privkey])
+    will_mediate = RadioField(_('Register as a mediator?'), choices = [('1','Yes'), ('0', 'No')])
+    mediator_fee = TextField(_('Mediator Fee'), validators = [validate_mediator_fee])  # TODO make required only if Yes above
 
 class SignForm(Form):
     identity_id = HiddenInput("identity_id")
-    signed = TextAreaField('Signed enrollment', validators = [Required(), validate_en])
+    signed = TextAreaField(_('Signed enrollment'), validators = [Required(), validate_en])
 
 class JobPostForm(Form):
-    job_name = TextField('Job name', validators = [Required()])
-    description = TextAreaField('Description', validators = [Required()])
-    tags = TextField('Tags', validators = [Required()])
-    expire_days = TextField('Expiration (days)', validators = [Required()])
-    mediator_maddr = RadioField('Choose mediator')
+    job_name = TextField(_('Job name'), validators = [Required()])
+    description = TextAreaField(_('Description'), validators = [Required()])
+    tags = TextField(_('Tags'), validators = [Required()])
+    expire_days = TextField(_('Expiration (days)'), validators = [Required()])
+    mediator_maddr = RadioField(_('Choose mediator'))
 
 class BidForm(Form):
-    description = TextAreaField('Description', validators = [Required()])
-    bid_amount = TextAreaField('Bid amount', validators = [Required()])
-    job_id = RadioField('Choose Job to bid on')
+    description = TextAreaField(_('Description'), validators = [Required()])
+    bid_amount = TextAreaField(_('Bid amount'), validators = [Required()])
+    job_id = RadioField(_('Choose Job to bid on'))
 
 class JobOfferForm(Form):
-    bid_id = RadioField('Choose bid')
+    bid_id = RadioField(_('Choose bid'))
 
 class DeliverForm(Form):
-    deliverable = TextAreaField('Deliverables', validators = [Required()])
-    job_id = RadioField('Choose job associated with deliverables')
+    deliverable = TextAreaField(_('Deliverables'), validators = [Required()])
+    job_id = RadioField(_('Choose job associated with deliverables'))
 
 class DisputeForm(Form):
-    dispute_detail = TextAreaField('Dispute detail', validators = [Required()])
-    order_id = RadioField('Choose job')
+    dispute_detail = TextAreaField(_('Dispute detail'), validators = [Required()])
+    order_id = RadioField(_('Choose job'))
 
 class AcceptForm(Form):
-    deliverable_id = RadioField('Deliverables')
+    deliverable_id = RadioField(_('Deliverables'))
 
 class ResolveForm(Form):
-    resolution = TextAreaField('Resolution', validators = [Required()])
-    client_payment_amount = TextField('Client payment amount in BTC (remainder sent to worker)', validators = [Required()])
-    dispute_id = RadioField('Disputes')
+    resolution = TextAreaField(_('Resolution'), validators = [Required()])
+    client_payment_amount = TextField(_('Client payment amount in BTC (remainder sent to worker)'), validators = [Required()])
+    dispute_id = RadioField(_('Disputes'))
 
 class AcceptResolutionForm(Form):
-    resolution_id = RadioField('Resolution')
+    resolution_id = RadioField(_('Resolution'))
 
 class RatingForm(Form):
-    job_id = TextField('Job id', validators = [Required()], default='')
-    user_id = TextField('User SIN', validators = [Required(), avoid_self_rating], default='')
-    rated_by_id = TextField('Rated by SIN', validators = [Required()], default='')
-    rating = TextField('Rating', validators=[Required()], default=0, widget=HiddenInput())
-    comments = TextAreaField('Comments', validators = [], default='')
+    job_id = TextField(_('Job ID'), validators = [Required()], default='')
+    user_id = TextField(_('User SIN'), validators = [Required(), avoid_self_rating], default='')
+    rated_by_id = TextField(_('Rated by SIN'), validators = [Required()], default='')
+    rating = TextField(_('Rating'), validators=[Required()], default=0, widget=HiddenInput())
+    comments = TextAreaField(_('Comments'), validators = [], default='')

rein/lib/io.py

@@ -13,7 +13,7 @@ def safe_get(log, url):
     try:
         answer = requests.get(url=url, proxies=rein.proxies)
     except requests.ConnectionError:
-        click.echo('Error connecting to server.')
+        click.echo(_('Error connecting to server.'))
         log.error('server connect error ' + url)
         return None
 

rein/lib/localization.py

@@ -0,0 +1,26 @@
+import gettext
+import locale
+import logging
+import os
+import rein.locale
+
+def init_localization():
+  '''prepare l10n'''
+  # Extract system locale identifier
+  loc = locale.getdefaultlocale()[0]
+  file_name = "messages-%s.mo" % loc.split('_')[0]
+  file_path = os.path.join(os.path.dirname(os.path.abspath(rein.locale.__file__)), file_name)
+  print(file_path)
+
+  try:
+    logging.debug("Opening message file %s for locale %s", file_name, loc[0])
+    trans = gettext.GNUTranslations(open(file_path, "rb" ))
+
+  except IOError:
+    logging.debug("Locale not found. Using default messages")
+    trans = gettext.NullTranslations()
+
+  trans.install()
+
+if __name__ == '__main__':
+  init_localization()

rein/lib/market.py

@@ -53,7 +53,7 @@ def sign_and_store_document(rein, doc_type, document, signature_address=None, si
         click.echo("\n%s\n" % document)
         done = False
         while not done:
-            filename = click.prompt("File containing signed document", type=str, default=doc_type + '.sig.txt')
+            filename = click.prompt(_("File containing signed document"), type=str, default=doc_type + '.sig.txt')
             if os.path.isfile(filename):
                 done = True
         f = open(filename, 'r')

rein/lib/maybe/dochashcash.py

@@ -0,0 +1,37 @@
+import scrypt
+import time
+from bitcoin.core import x, b2x
+
+if __name__ == '__main__':
+    text = """-----BEGIN BITCOIN SIGNED MESSAGE-----
+- ----BEGIN BITCOIN SIGNED MESSAGE-----
+- ----BEGIN BITCOIN SIGNED MESSAGE-----
+Name/Handle: Knightdk
+Contact: knightdk on Bitcointalk.org
+Master signing address: 16mT7jrpkjnJBD7a3TM2awyxHub58H6r6Z
+Delegate signing address: N/A
+Willing to mediate: Y
+Mediation public key: 04594f2582c859c4f65084ee7fe8e9ec2d695bb988a3f53db48eaaff6ff3a0282b2be0c79"""\
+"""fefca01277404d0fdc3a923e8ed02efd6ab96980f3e229a81fbe032e9
+- ----BEGIN SIGNATURE-----
+16mT7jrpkjnJBD7a3TM2awyxHub58H6r6Z
+GxHE6iJH2aMpsRk7cszvXsLieDawzArpt7XDdOPhVFD5KVqIvKve1fwUKeN6ct4bld41XLdrZ7Dvaj7x1Oiw0uo=
+- ----END BITCOIN SIGNED MESSAGE-----
+- ----BEGIN SIGNATURE-----
+1BbgnPQYeXAt39ifLNUWP1RBktpzGLmRZS
+IGJcg+MoqpBQNtptelyZfC2zBKk5SZQQjtf4pHSxb0yZH6kn/9Dhd1TWFfXUXsWmZq78xYye4lKi1aQUeNQ2ZFs=
+- ----END BITCOIN SIGNED MESSAGE-----
+-----BEGIN SIGNATURE-----
+1DVK9Rdi2wcpcfEkep7FSNUui7fzadmxsW
+IMcU7MvLl7T+hY0mmMw6mblLstnXd9Ly36z7uYMqv7ZZEuZQOvuXN2GjYU0Nq4So9GKQRkQwIis7EiN6luTMcOY=
+-----END BITCOIN SIGNED MESSAGE-----"""
+
+    start = time.time()
+    count = 1
+    
+    h1 = scrypt.hash(text, 'random salt', 32768, 8, 1, 16)
+    while 1:
+        h1 = scrypt.hash(h1, 'random salt', 32768, 8, 1, 16)
+        count += 1
+        if h1 < x('04ffffffffffffffffffffffffffffff'):
+            print(b2x(h1), time.time() - start, count)

rein/lib/order.py

@@ -1,76 +1,78 @@
 from sqlalchemy import Column, Integer, String, Boolean, and_
 from sqlalchemy.ext.declarative import declarative_base
+from localization import init_localization
 try:
     from document import Document
 except:
     pass
 
 Base = declarative_base()
+init_localization()
 
 STATE = {
         'job_posting': {
                     'pre': [],
                     'next': ['bid'],
                     'endpoint': '/post',
-                    'past_tense': 'posted',
-                    'description':  "Funds for each job in Rein are stored in two multisig addresses. One address\n" \
-                                    "is for the primary payment that will go to the worker on completion. The\n" \
-                                    "second address pays the mediator to be available to resolve a dispute\n" \
-                                    "if necessary. The second address should be funded according to the percentage\n" \
-                                    "specified by the mediator and is in addition to the primary payment. The\n" \
-                                    "listing below shows available mediators and the fee they charge. You should\n" \
-                                    "consider the fee as well as any reputational data you are able to find when\n" \
-                                    "choosing a mediator. Your choice may affect the number and quality of bids\n"
+                    'past_tense': _('posted'),
+                    'description': _("""Funds for each job in Rein are stored in two multisig addresses. One address
+is for the primary payment that will go to the worker on completion. The
+second address pays the mediator to be available to resolve a dispute
+if necessary. The second address should be funded according to the percentage
+specified by the mediator and is in addition to the primary payment. The
+listing below shows available mediators and the fee they charge. You should
+consider the fee as well as any reputational data you are able to find when
+choosing a mediator. Your choice may affect the number and quality of bids"""),
                         },
         'bid':          {
                     'pre': ['job_posting'],
                     'next': ['offer'],
                     'endpoint': None,
-                    'past_tense': 'bid submitted'
+                    'past_tense': _('bid submitted'),
                         },
         'offer':        {
                     'pre': ['bid'],
                     'next': ['delivery', 'creatordispute', 'workerdispute'],
                     'endpoint': '/offer',
-                    'past_tense': 'job awarded',
+                    'past_tense': _('job awarded'),
                         },
         'delivery':     {
                     'pre': ['offer'],
                     'next': ['accept', 'creatordispute', 'workerdispute'],
                     'endpoint': '/deliver',
-                    'past_tense':  'deliverables submitted'
+                    'past_tense': _('deliverables submitted'),
                         },
         'creatordispute': {
                     'pre': ['offer', 'delivery'],
                     'next': ['resolve', 'workerdispute'],
                     'endpoint': '/dispute',
-                    'past_tense':'disputed by job creator'
+                    'past_tense': _('disputed by job creator'),
                         },
         'workerdispute': {
                     'pre': ['offer', 'delivery', 'accept'],
                     'next': ['resolve', 'creatordispute'],
                     'endpoint': '/dispute',
-                    'past_tense': 'disputed by worker'
+                    'past_tense': _('disputed by worker'),
                         },
         'accept':       {
                     'pre': ['delivery'],
                     'next': ['workerdispute', 'complete'],
                     'endpoint': '/accept',
-                    'past_tense': 'complete, work accepted',
+                    'past_tense': _('complete, work accepted'),
                         },
         'resolve':   {
                     'pre': ['creatordispute', 'workerdispute'],
                     'next': ['acceptresolution'],
                     'endpoint': '/resolve',
-                    'past_tense': 'dispute resolved'
+                    'past_tense': _('complete, dispute resolved'),
                         },
         'acceptresolution': {
                     'pre': ['resolve'],
                     'next': ['complete'],
                     'endpoint': '/acceptresolution',
-                    'past_tense': 'complete, resolution accepted'
+                    'past_tense': _('complete, resolution accepted'),
                         }
-}
+        }
 
 class Order(Base):
     __tablename__ = 'order'

rein/lib/toolbox.py

@@ -6,4 +6,4 @@ def yes_or_no(question):
     if len(reply) > 0 and reply[0] == 'n':
         return False
     else:
-        return yes_or_no("Please enter ")
+        return yes_or_no(_("Please enter "))

rein/lib/validate.py

@@ -11,7 +11,7 @@
 def filter_out_expired(rein, user, urls, jobs):
     live = []
     times = {}
-    click.echo('Verifying block times...')
+    click.echo(_('Verifying block times...'))
     with click.progressbar(jobs) as bar:
         for j in bar:
             if 'Block hash' not in j:
@@ -165,7 +165,7 @@ def remote_query(rein, user, urls, log, query_type, distinct):
         sel_url = "{0}query?owner={1}&query={2}&testnet={3}"
         data = safe_get(log, sel_url.format(url, user.maddr, query_type, rein.testnet))
         if data is None or query_type not in data or len(data[query_type]) == 0:
-            click.echo('None found')
+            click.echo(_('None found'))
             continue
         res += filter_and_parse_valid_sigs(rein, data[query_type])
     return unique(res, distinct)