From 2b89431cca7369aa8f89276c2ece6edeeb359169 Mon Sep 17 00:00:00 2001
From: Gerhard Jungwirth <gjungwirth@sipwise.com>
Date: Fri, 11 May 2018 17:53:40 +0200
Subject: [PATCH] TT#36404 restructure form-translation

translate forms in NGCP::Panel::Form (the caching module) instead of in the
templates. This gives us better control to avoid translating cached forms
multiple times. Multiple translations lead to errors due to escaping of
special symbols and simply fails from one (non-english) language to another.

Change-Id: I234b22cb70dc068530e4a9f241cb9bb5653e1959
---
 lib/NGCP/Panel/Controller/Root.pm             | 3 +++
 lib/NGCP/Panel/Form.pm                        | 8 ++++++++
 lib/NGCP/Panel/Form/CallforwardSourceSet.pm   | 2 +-
 lib/NGCP/Panel/Utils/Preferences.pm           | 5 +++++
 lib/NGCP/Panel/View/HTML.pm                   | 6 ------
 share/templates/administrator/list.tt         | 2 +-
 share/templates/billing/peaktimes.tt          | 1 -
 share/templates/callrouting/verify.tt         | 4 +---
 share/templates/customer/details.tt           | 6 +++---
 share/templates/helpers/ajax_form_modal.tt    | 2 +-
 share/templates/helpers/datatables.tt         | 1 -
 share/templates/helpers/pref_table.tt         | 3 ---
 share/templates/login/login.tt                | 2 +-
 share/templates/ncos/list.tt                  | 2 +-
 share/templates/peeringoverview/edit.tt       | 2 +-
 share/templates/reseller/branding.tt          | 2 +-
 share/templates/reseller/details.tt           | 2 +-
 share/templates/rewrite/rules_list.tt         | 2 +-
 share/templates/sound/handles_list.tt         | 2 +-
 share/templates/statistics/list.tt            | 2 +-
 share/templates/subscriber/edit_webpass.tt    | 2 +-
 share/templates/subscriber/master.tt          | 2 +-
 share/templates/subscriber/preferences.tt     | 4 ++--
 share/templates/subscriber/recoverpassword.tt | 2 +-
 24 files changed, 36 insertions(+), 33 deletions(-)

diff --git a/lib/NGCP/Panel/Controller/Root.pm b/lib/NGCP/Panel/Controller/Root.pm
index 392fbd51d5..8839b65282 100644
--- a/lib/NGCP/Panel/Controller/Root.pm
+++ b/lib/NGCP/Panel/Controller/Root.pm
@@ -10,6 +10,7 @@ use Scalar::Util qw(blessed);
 use NGCP::Panel::Utils::DateTime qw();
 use NGCP::Panel::Utils::Statistics qw();
 use NGCP::Panel::Utils::Admin;
+use NGCP::Panel::Form qw();
 use DateTime qw();
 use Time::HiRes qw();
 use DateTime::Format::RFC3339 qw();
@@ -38,6 +39,8 @@ sub auto :Private {
             $c->response->cookies->{ngcp_panel_lang} = { value => $c->request->params->{lang}, expires =>  '+3M', };
             $c->log->debug("Setting language to ". $c->request->params->{lang});
         }
+        # clear form cache (they need to be properly re-translated)
+        NGCP::Panel::Form::clear_form_cache();
     }
     if (defined $c->session->{lang}) {
         $c->languages([$c->session->{lang}, "i-default"]);
diff --git a/lib/NGCP/Panel/Form.pm b/lib/NGCP/Panel/Form.pm
index 89a1a926f8..bb51e7e415 100644
--- a/lib/NGCP/Panel/Form.pm
+++ b/lib/NGCP/Panel/Form.pm
@@ -4,6 +4,7 @@ use warnings;
 use strict;
 
 use Module::Load::Conditional qw/can_load/;
+use NGCP::Panel::Utils::I18N qw//;
 
 my %forms = ();
 
@@ -22,8 +23,15 @@ sub get {
             return;
         }
         $form = $forms{$name} = $name->new(ctx => $c);
+        # translate form here to prevent multiple translations which leads to errors and doesn't work since the
+        # source IDs (english) are no longer present
+        NGCP::Panel::Utils::I18N->translate_form($c, $form);
     }
     return $form;
 }
 
+sub clear_form_cache {
+    %forms = ();
+}
+
 1;
diff --git a/lib/NGCP/Panel/Form/CallforwardSourceSet.pm b/lib/NGCP/Panel/Form/CallforwardSourceSet.pm
index 3cbcfbc6cb..49360afae1 100644
--- a/lib/NGCP/Panel/Form/CallforwardSourceSet.pm
+++ b/lib/NGCP/Panel/Form/CallforwardSourceSet.pm
@@ -58,7 +58,7 @@ has_field 'source.source' => (
     wrapper_class => [qw/hfh-rep-field/],
     element_attr => {
         rel => ['tooltip'],
-        title => ['The calling party number in E164 format to match. Shell patterns like 431* or 49123~~~[1-5~~~]67 are possible. ' .
+        title => ['The calling party number in E164 format to match. Shell patterns like 431* or 49123~[1-5~]67 are possible. ' .
             'Use &quot;anonymous&quot; to match suppressed numbers.'],
     },
 );
diff --git a/lib/NGCP/Panel/Utils/Preferences.pm b/lib/NGCP/Panel/Utils/Preferences.pm
index aabad02c41..7fcb207f13 100644
--- a/lib/NGCP/Panel/Utils/Preferences.pm
+++ b/lib/NGCP/Panel/Utils/Preferences.pm
@@ -5,6 +5,7 @@ use Sipwise::Base;
 use Data::Validate::IP qw/is_ipv4 is_ipv6/;
 use NGCP::Panel::Form::Preferences;
 use NGCP::Panel::Utils::Generic qw(:all);
+use NGCP::Panel::Utils::I18N qw//;
 use NGCP::Panel::Utils::Sems;
 
 use constant _DYNAMIC_PREFERENCE_PREFIX => '__';
@@ -354,6 +355,10 @@ sub create_preference_form {
         }],
     });
     $form->create_structure([$c->stash->{preference_meta}->attribute]);
+    # we have to translate this form separately since it bypasses caching in NGCP::Panel::Form
+    if ( $c->stash->{preference_meta}->attribute !~ '(ncos|sound_set|emergency_mapping_container)$' ) {
+        NGCP::Panel::Utils::I18N->translate_form($c, $form);
+    }
 
     my $posted = ($c->request->method eq 'POST');
     $form->process(
diff --git a/lib/NGCP/Panel/View/HTML.pm b/lib/NGCP/Panel/View/HTML.pm
index b676b9ee6c..ecaf3c2273 100644
--- a/lib/NGCP/Panel/View/HTML.pm
+++ b/lib/NGCP/Panel/View/HTML.pm
@@ -17,14 +17,8 @@ __PACKAGE__->config(
             URI::Escape::uri_unescape(@_);
         },
     },
-    expose_methods => [qw/translate_form/],
 );
 
-sub translate_form {
-    my $self = shift;
-    NGCP::Panel::Utils::I18N->translate_form(@_);
-}
-
 =head1 NAME
 
 NGCP::Panel::View::HTML - TT View for NGCP::Panel
diff --git a/share/templates/administrator/list.tt b/share/templates/administrator/list.tt
index 2cc225bd5f..df57517c97 100644
--- a/share/templates/administrator/list.tt
+++ b/share/templates/administrator/list.tt
@@ -35,7 +35,7 @@
     IF api_modal_flag;
         PROCESS "helpers/modal.tt";
         modal_header(m.name = "API key");
-        translate_form(helper.form_object).render;
+        helper.form_object.render;
         modal_footer();
         modal_script(m.close_target = helper.close_target);
     END;
diff --git a/share/templates/billing/peaktimes.tt b/share/templates/billing/peaktimes.tt
index 3b42acc55f..3c37dc6b2d 100644
--- a/share/templates/billing/peaktimes.tt
+++ b/share/templates/billing/peaktimes.tt
@@ -82,7 +82,6 @@
 [% 
     PROCESS "helpers/modal.tt";
     modal_header(m.name = weekday.name);
-    form = translate_form(form);
 -%]
 
 <div class="modal-body">
diff --git a/share/templates/callrouting/verify.tt b/share/templates/callrouting/verify.tt
index 6d1b2c7b94..04e011fe95 100644
--- a/share/templates/callrouting/verify.tt
+++ b/share/templates/callrouting/verify.tt
@@ -23,9 +23,7 @@ $(document).ready(function() {
 });
 </script>
 
-[% site_config.title = c.loc('Call Routing Verification');
-   form = translate_form(form);
--%]
+[% site_config.title = c.loc('Call Routing Verification'); -%]
 
 <div class="row">
     <span>
diff --git a/share/templates/customer/details.tt b/share/templates/customer/details.tt
index 6ff15b416b..3411ab875e 100644
--- a/share/templates/customer/details.tt
+++ b/share/templates/customer/details.tt
@@ -771,7 +771,7 @@ $(function() {
     PROCESS "helpers/modal.tt";
     modal_header(m.create_flag = create_flag,
                  m.name = description.defined ? description : c.loc("Subscriber"));
-    translate_form(form).render;
+    form.render;
     modal_footer();
     modal_script(m.close_target = close_target);
 -%]
@@ -784,7 +784,7 @@ $(function() {
     PROCESS "helpers/modal.tt";
     modal_header(m.create_flag=0,
                  m.name = c.loc("Settings"));
-    translate_form(form).render;
+    form.render;
     modal_footer();
     modal_script(m.close_target = close_target);
 -%]
@@ -793,7 +793,7 @@ $(function() {
     PROCESS "helpers/modal.tt";
     modal_header(m.create_flag=0, m.edit_flag=0,
                  m.name = c.loc("Deployed Device"));
-    translate_form(form).render;
+    form.render;
     modal_footer();
     modal_script(m.close_target = close_target);
 -%]
diff --git a/share/templates/helpers/ajax_form_modal.tt b/share/templates/helpers/ajax_form_modal.tt
index 398c5b2f89..18612c4e3c 100644
--- a/share/templates/helpers/ajax_form_modal.tt
+++ b/share/templates/helpers/ajax_form_modal.tt
@@ -1,6 +1,6 @@
 [%PROCESS 'helpers/modal.tt'-%]
 [%#USE Dumper%]
-[%form=translate_form(form)%]
+[%#form=translate_form(form)%]
 [%modal_header()%]
 [%#Dumper.dump_html(form)%]
 [%form.render()%]
diff --git a/share/templates/helpers/datatables.tt b/share/templates/helpers/datatables.tt
index 5da0bb633d..3fa18f21a8 100644
--- a/share/templates/helpers/datatables.tt
+++ b/share/templates/helpers/datatables.tt
@@ -314,7 +314,6 @@ $(document).ready(function() {
                  m.duplicate_flag=helper.duplicate_flag,
                  m.edit_flag=helper.edit_flag,
                  m.name = helper.name);
-        helper.form_object = translate_form( helper.form_object );
         helper.form_object.render;
     modal_footer();
     modal_script(m.close_target = helper.close_target);
diff --git a/share/templates/helpers/pref_table.tt b/share/templates/helpers/pref_table.tt
index 4b5738cd63..7ffeb39bc7 100644
--- a/share/templates/helpers/pref_table.tt
+++ b/share/templates/helpers/pref_table.tt
@@ -172,9 +172,6 @@
     PROCESS "helpers/modal.tt";
     modal_header(m.create_flag=0,
                  m.name = c.loc("Preference '") _ c.loc(helper.preference_meta.label) _"'");
-    IF ! helper.preference_meta.attribute.match('(ncos|sound_set|emergency_mapping_container)$');
-        helper.form = translate_form(helper.form);
-    END;
 -%]
 
     [% IF helper.preference_meta.attribute == "allowed_ips" %]
diff --git a/share/templates/login/login.tt b/share/templates/login/login.tt
index e5b4dd9668..66c04cccef 100644
--- a/share/templates/login/login.tt
+++ b/share/templates/login/login.tt
@@ -13,7 +13,7 @@
         <div class="content clearfix">
             <h1>[% c.loc('[_1] Sign In', realm.ucfirst) %]</h1>
             <p>[% c.loc('Sign in using your [_1] credentials:', realm.ucfirst) %]</p>
-            [% translate_form(form).render %]
+            [% form.render %]
         </div>
     </div>
     <div class="login-extra">
diff --git a/share/templates/ncos/list.tt b/share/templates/ncos/list.tt
index d00fc13ab9..b15ea34d5a 100644
--- a/share/templates/ncos/list.tt
+++ b/share/templates/ncos/list.tt
@@ -9,7 +9,7 @@
     helper.close_target = close_target;
     helper.create_flag = create_flag;
     helper.edit_flag = edit_flag;
-    helper.form_object = form.defined ? translate_form(form) : undef;
+    helper.form_object = form;
     helper.ajax_uri = c.uri_for_action( "/ncos/ajax" );
 
     UNLESS c.user.read_only;
diff --git a/share/templates/peeringoverview/edit.tt b/share/templates/peeringoverview/edit.tt
index 1d88888701..5bb47a7d30 100644
--- a/share/templates/peeringoverview/edit.tt
+++ b/share/templates/peeringoverview/edit.tt
@@ -33,7 +33,7 @@ $(document).ready(function() {
     modal_header(m.create_flag=0,
                  m.name = c.loc("Peering Overview Columns"));
 
-    helper.form = translate_form(form);
+    helper.form = form;
 -%]
 
 
diff --git a/share/templates/reseller/branding.tt b/share/templates/reseller/branding.tt
index 2d0779aee0..14cfd8db09 100644
--- a/share/templates/reseller/branding.tt
+++ b/share/templates/reseller/branding.tt
@@ -66,7 +66,7 @@
     PROCESS "helpers/modal.tt";
     modal_header(m.edit_flag = branding_edit_flag,
                  m.name = "Reseller Branding");
-    translate_form(branding_form).render;
+    branding_form.render;
     modal_footer();
     modal_script(m.close_target = close_target);
 -%]
diff --git a/share/templates/reseller/details.tt b/share/templates/reseller/details.tt
index a499a9f21e..36ddeb8796 100644
--- a/share/templates/reseller/details.tt
+++ b/share/templates/reseller/details.tt
@@ -454,7 +454,7 @@
     PROCESS "helpers/modal.tt";
     modal_header(m.edit_flag = branding_edit_flag,
                  m.name = "Reseller Branding");
-    translate_form(branding_form).render;
+    branding_form.render;
     modal_footer();
     modal_script(m.close_target = close_target);
 -%]
diff --git a/share/templates/rewrite/rules_list.tt b/share/templates/rewrite/rules_list.tt
index 14a212a931..6932968015 100644
--- a/share/templates/rewrite/rules_list.tt
+++ b/share/templates/rewrite/rules_list.tt
@@ -141,7 +141,7 @@
     PROCESS "helpers/modal.tt";
     modal_header(m.name = c.loc('Rule'),
                  m.create_flag = create_flag);
-    translate_form(form).render();
+    form.render();
     modal_footer();
     modal_script(m.close_target = rules_uri);
 -%]
diff --git a/share/templates/sound/handles_list.tt b/share/templates/sound/handles_list.tt
index 1504722f7c..6427e037d6 100644
--- a/share/templates/sound/handles_list.tt
+++ b/share/templates/sound/handles_list.tt
@@ -81,7 +81,7 @@
     PROCESS "helpers/modal.tt";
     modal_header(m.create_flag=0,
                  m.name = edit_default_flag ? c.loc('Default Files') : file_result.handle.name );
-    translate_form(form).render;
+    form.render;
     modal_footer();
     END;
 -%]
diff --git a/share/templates/statistics/list.tt b/share/templates/statistics/list.tt
index 4fb9d69674..6ef64a3ec8 100644
--- a/share/templates/statistics/list.tt
+++ b/share/templates/statistics/list.tt
@@ -27,7 +27,7 @@
     <div class="ngcp-separator"></div>
 
     <div class="row-fluid">
-        [% translate_form(form).render %]
+        [% form.render %]
     </div>
 
     <div class="ngcp-separator"></div>
diff --git a/share/templates/subscriber/edit_webpass.tt b/share/templates/subscriber/edit_webpass.tt
index 84b43e8d80..551e1f1cc6 100644
--- a/share/templates/subscriber/edit_webpass.tt
+++ b/share/templates/subscriber/edit_webpass.tt
@@ -73,7 +73,7 @@
     PROCESS "helpers/modal.tt";
     modal_header(m.create_flag=0,
                  m.name = description);
-    translate_form(form).render;
+    form.render;
     modal_footer();
     modal_script(m.close_target = close_target);
 -%]
diff --git a/share/templates/subscriber/master.tt b/share/templates/subscriber/master.tt
index bd0cfec37f..e120adfaba 100644
--- a/share/templates/subscriber/master.tt
+++ b/share/templates/subscriber/master.tt
@@ -379,7 +379,7 @@ function process_pbx_items(moveId,direction){
     PROCESS "helpers/modal.tt";
     modal_header(m.create_flag=0,
                  m.name = description);
-    translate_form(form).render;
+    form.render;
     modal_footer();
     modal_script(m.close_target = close_target);
 -%]
diff --git a/share/templates/subscriber/preferences.tt b/share/templates/subscriber/preferences.tt
index 75fd189d7c..a5af424a13 100644
--- a/share/templates/subscriber/preferences.tt
+++ b/share/templates/subscriber/preferences.tt
@@ -866,7 +866,7 @@ $( document ).ready(function() {
 [% IF cf_form.has_for_js -%]
 [% cf_form.render_repeatable_js %]
 [% END -%]
-[% translate_form(cf_form).render %]
+[% cf_form.render %]
 
 [%
     modal_footer();
@@ -1033,7 +1033,7 @@ $( document ).ready(function() {
     [% IF ccmap_form.has_for_js -%]
     [% ccmap_form.render_repeatable_js %]
     [% END -%]
-    [% translate_form(ccmap_form).render %]
+    [% ccmap_form.render %]
 
 [%
     modal_footer();
diff --git a/share/templates/subscriber/recoverpassword.tt b/share/templates/subscriber/recoverpassword.tt
index f7dee33150..385ac1c4e6 100644
--- a/share/templates/subscriber/recoverpassword.tt
+++ b/share/templates/subscriber/recoverpassword.tt
@@ -4,7 +4,7 @@
     PROCESS "helpers/modal.tt";
     modal_header(m.name = c.loc('Web Password'),
                  m.create_flag = create_flag);
-    translate_form(form).render();
+    form.render;
     modal_footer();
     modal_script(m.close_target = close_target);
 -%]