Mercurial > p > roundup > code
view roundup/cgi/TranslationService.py @ 5710:0b79bfcb3312
Add support for making an idempotent POST. This allows retrying a POST
that was interrupted. It involves creating a post once only (poe) url
/rest/data/<class>/@poe/<random_token>. This url acts the same as a
post to /rest/data/<class>. However once the @poe url is used, it
can't be used for a second POST.
To make these changes:
1) Take the body of post_collection into a new post_collection_inner
function. Have post_collection call post_collection_inner.
2) Add a handler for POST to rest/data/class/@poe. This will return a
unique POE url. By default the url expires after 30 minutes. The
POE random token is only good for a specific user and is stored in
the session db.
3) Add a handler for POST to rest/data/<class>/@poe/<random token>.
The random token generated in 2 is validated for proper class (if
token is not generic) and proper user and must not have expired.
If everything is valid, call post_collection_inner to process the
input and generate the new entry.
To make recognition of 2 stable (so it's not confused with
rest/data/<:class_name>/<:item_id>), removed @ from
Routing::url_to_regex.
The current Routing.execute method stops on the first regular
expression to match the URL. Since item_id doesn't accept a POST, I
was getting 405 bad method sometimes. My guess is the order of the
regular expressions is not stable, so sometime I would get the right
regexp for /data/<class>/@poe and sometime I would get the one for
/data/<class>/<item_id>. By removing the @ from the url_to_regexp,
there was no way for the item_id case to match @poe.
There are alternate fixes we may need to look at. If a regexp matches
but the method does not, return to the regexp matching loop in
execute() looking for another match. Only once every possible match
has failed should the code return a 405 method failure.
Another fix is to implement a more sophisticated mechanism so that
@Routing.route("/data/<:class_name>/<:item_id>/<:attr_name>", 'PATCH')
has different regexps for matching <:class_name> <:item_id> and
<:attr_name>. Currently the regexp specified by url_to_regex is used
for every component.
Other fixes:
Made failure to find any props in props_from_args return an empty
dict rather than throwing an unhandled error.
Make __init__ for SimulateFieldStorageFromJson handle an empty json
doc. Useful for POSTing to rest/data/class/@poe with an empty
document.
Testing:
added testPostPOE to test/rest_common.py that I think covers
all the code that was added.
Documentation:
Add doc to rest.txt in the "Client API" section titled: Safely
Re-sending POST". Move existing section "Adding new rest endpoints" in
"Client API" to a new second level section called "Programming the
REST API". Also a minor change to the simple rest client moving the
header setting to continuation lines rather than showing one long
line.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 14 Apr 2019 21:07:11 -0400 |
| parents | b0c2307be3d1 |
| children | 718f205dbe50 |
line wrap: on
line source
# TranslationService for Roundup templates # # This module is free software, you may redistribute it # and/or modify under the same terms as Python. # # This module provides National Language Support # for Roundup templating - much like roundup.i18n # module for Roundup command line interface. # The only difference is that translator objects # returned by get_translation() have one additional # method which is used by TAL engines: # # translate(domain, msgid, mapping, context, target_language, default) # from roundup import i18n from roundup.cgi.PageTemplates import Expressions, PathIterator, TALES from roundup.cgi.TAL import TALInterpreter from roundup.anypy.strings import us2u, u2s ### Translation classes class TranslationServiceMixin: def translate(self, domain, msgid, mapping=None, context=None, target_language=None, default=None ): _msg = self.gettext(msgid) #print ("TRANSLATE", msgid, _msg, mapping, context) _msg = TALInterpreter.interpolate(_msg, mapping) return _msg if hasattr(i18n.RoundupTranslations, 'ugettext'): def gettext(self, msgid): msgid = us2u(msgid) msgtrans=self.ugettext(msgid) return u2s(msgtrans) def ngettext(self, singular, plural, number): singular = us2u(singular) plural = us2u(plural) msgtrans=self.ungettext(singular, plural, number) return u2s(msgtrans) class TranslationService(TranslationServiceMixin, i18n.RoundupTranslations): pass class NullTranslationService(TranslationServiceMixin, i18n.RoundupNullTranslations): if hasattr(i18n.RoundupNullTranslations, 'ugettext'): def ugettext(self, message): if self._fallback: return self._fallback.ugettext(message) # Sometimes the untranslatable message is a UTF-8 encoded string # (thanks to PageTemplate's internals). message = us2u(message) return message ### TAL patching # # Template Attribute Language (TAL) uses only global translation service, # which is not thread-safe. We will use context variable 'i18n' # to access request-dependent transalation service (with domain # and target language set during initializations of the roundup # client interface. # class Context(TALES.Context): def __init__(self, compiler, contexts): TALES.Context.__init__(self, compiler, contexts) if not self.contexts.get('i18n', None): # if the context contains no TranslationService, # create default one self.contexts['i18n'] = get_translation() self.i18n = self.contexts['i18n'] def translate(self, domain, msgid, mapping=None, context=None, target_language=None, default=None): if context is None: context = self.contexts.get('here') return self.i18n.translate(domain, msgid, mapping=mapping, context=context, default=default, target_language=target_language) class Engine(TALES.Engine): def getContext(self, contexts=None, **kwcontexts): if contexts is not None: if kwcontexts: kwcontexts.update(contexts) else: kwcontexts = contexts return Context(self, kwcontexts) # patching TAL like this is a dirty hack, # but i see no other way to specify different Context class Expressions._engine = Engine(PathIterator.Iterator) Expressions.installHandlers(Expressions._engine) ### main API function def get_translation(language=None, tracker_home=None, translation_class=TranslationService, null_translation_class=NullTranslationService ): """Return Translation object for given language and domain Arguments 'translation_class' and 'null_translation_class' specify the classes that are instantiated for existing and non-existing translations, respectively. """ return i18n.get_translation(language=language, tracker_home=tracker_home, translation_class=translation_class, null_translation_class=null_translation_class) # vim: set et sts=4 sw=4 :
