tr8n 3.2.0 → 3.2.1

data/app/javascript/src/tokens/transform_token.js

@@ -0,0 +1,106 @@
+/****************************************************************************
+  Copyright (c) 2010-2012 Michael Berkovich, Ian McDaniel, tr8n.net
+
+  Permission is hereby granted, free of charge, to any person obtaining
+  a copy of this software and associated documentation files (the
+  "Software"), to deal in the Software without restriction, including
+  without limitation the rights to use, copy, modify, merge, publish,
+  distribute, sublicense, and/or sell copies of the Software, and to
+  permit persons to whom the Software is furnished to do so, subject to
+  the following conditions:
+
+  The above copyright notice and this permission notice shall be
+  included in all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+****************************************************************************/
+
+Tr8n.Proxy.TransformToken = function(label, token, options) {
+  this.label = label;
+  this.full_name = token;
+  this.options = options;
+}
+
+Tr8n.Proxy.TransformToken.prototype = new Tr8n.Proxy.Token();
+
+Tr8n.Proxy.TransformToken.parse = function(label, options) {
+  var tokens = label.match(/(\{[^_][\w]+(:[\w]+)?\s*\|\|?[^{^}]+\})/g);
+  if (!tokens) return [];
+  
+  var objects = [];
+  var uniq = {};
+  for(i=0; i<tokens.length; i++) {
+    if (uniq[tokens[i]]) continue;
+    options['proxy'].debug("Registering transform token: " + tokens[i]);
+    objects.push(new Tr8n.Proxy.TransformToken(label, tokens[i], options)); 
+    uniq[tokens[i]] = true;
+  }
+  return objects;
+}
+
+Tr8n.Proxy.TransformToken.prototype.getName = function() {
+  if (!this.name) {
+    this.name = Tr8n.Utils.trim(this.getDeclaredName().split('|')[0].split(':')[0]); 
+  }
+  return this.name;
+}
+
+Tr8n.Proxy.TransformToken.prototype.getPipedParams = function() {
+  if (!this.piped_params) {
+    var temp = this.getDeclaredName().split('|');
+    temp = temp[temp.length - 1].split(",");
+    this.piped_params = [];
+    for (i=0; i<temp.length; i++) {
+      this.piped_params.push(Tr8n.Utils.trim(temp[i]));
+    }
+  }
+  return this.piped_params;
+}
+
+Tr8n.Proxy.TransformToken.prototype.substitute = function(label, token_values) {
+  var object = token_values[this.getName()];
+  if (object == null) {
+    this.getLogger().error("Value for token: " + this.getFullName() + " was not provided");
+    return label;
+  }
+  
+  var token_object = this.getTokenObject(object);
+  this.getLogger().debug("Registered " + this.getPipedParams().length + " piped params");
+  
+  var lang_rule_name = this.getLanguageRule();
+  
+  if (!lang_rule_name) {
+    this.getLogger().error("Rule type cannot be determined for the transform token: " + this.getFullName());
+    return label;
+  } else {
+    this.getLogger().debug("Transform token uses rule: " + lang_rule_name);
+  }
+
+  var transform_value = eval(lang_rule_name).transform(token_object, this.getPipedParams());
+  this.getLogger().debug("Registered transform value: " + transform_value);
+  
+  // for double pipes - show the actual value as well
+  if (this.isAllowedInTranslation()) {
+    var token_value = this.getTokenValue(object);
+    transform_value = token_value + " " + transform_value; 
+  }
+  
+  return Tr8n.Utils.replaceAll(label, this.getFullName(), transform_value);
+}
+
+Tr8n.Proxy.TransformToken.prototype.getPipedSeparator = function() {
+  if (!this.piped_separator) {
+    this.piped_separator = (this.getFullName().indexOf("||") != -1 ? "||" : "|");
+  }
+  return this.piped_separator;
+}
+
+Tr8n.Proxy.TransformToken.prototype.isAllowedInTranslation = function(){
+  return this.getPipedSeparator() == "||";
+}

data/app/javascript/src/translation_key.js

@@ -0,0 +1,183 @@
+/****************************************************************************
+  Copyright (c) 2010-2012 Michael Berkovich, Ian McDaniel, tr8n.net
+
+  Permission is hereby granted, free of charge, to any person obtaining
+  a copy of this software and associated documentation files (the
+  "Software"), to deal in the Software without restriction, including
+  without limitation the rights to use, copy, modify, merge, publish,
+  distribute, sublicense, and/or sell copies of the Software, and to
+  permit persons to whom the Software is furnished to do so, subject to
+  the following conditions:
+
+  The above copyright notice and this permission notice shall be
+  included in all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+****************************************************************************/
+
+Tr8n.Proxy.TranslationKey = function(label, description, options) {
+  this.label = label;
+  this.description = description;
+  this.options = options;
+  this.generateKey();
+}
+
+Tr8n.Proxy.TranslationKey.prototype = {
+  getProxy: function() {
+    return this.options['proxy'];
+  },
+  getLogger: function() {
+    return this.getProxy().logger;
+  },
+  findFirstAcceptableTranslation: function(translations, token_values) {
+    // check for a single translation case - no context rules
+    if (translations['label']!=null) {
+      this.getLogger().debug('Found a single translation: ' + translations['label']);
+      return translations;    
+    }
+  
+    translations = translations['labels'];
+    if (!translations) {
+      this.getLogger().error("Translations are in a weird form...");
+      return null;
+    }
+
+    this.getLogger().debug('Found translations: ' + translations.length);
+    for (var i=0; i<translations.length; i++) {
+      this.getLogger().debug("Checking context rules for:" + translations[i]['label']);
+      
+      if (!translations[i]['context']) {
+        this.getLogger().debug("Translation has no context, using it by default");
+        return translations[i];
+      }
+      var valid_context = true;
+
+      for (var token in translations[i]['context']) {
+        if (!valid_context) continue;
+        var token_context = translations[i]['context'][token];
+        var rule_name = this.getProxy().getLanguageRuleForType(token_context['type']);
+        this.getLogger().debug("Evaluating rule: " + rule_name);
+        var options = {'proxy': this.getProxy()};
+        var rule = eval("new " + rule_name + "()");
+        rule.definition = token_context;
+        rule.options = options;
+        valid_context = valid_context && rule.evaluate(token, token_values);
+      }
+      
+      if (valid_context) {
+        this.getLogger().debug("Found valid translation: " + translations[i].label);
+        return translations[i];
+      } else {
+        this.getLogger().debug("The rules were not matched for: " + translations[i].label);
+      }
+    }
+    
+    this.getLogger().debug('No acceptable ranslations found');
+    return null;        
+  },
+  
+  translate: function(language, token_values, options) {
+    if (!this.label) {
+      this.getLogger().error('Label must always be provided for the translate method');
+      return '';
+    }
+    
+    var translations = this.getProxy().getTranslations();
+    var translation_key = translations[this.key];
+        
+    if (translation_key) {
+      this.getLogger().debug("Found translations, evaluating rules...");      
+      
+      this.id = translation_key.id;
+      this.original = translation_key.original;
+      var translation = this.findFirstAcceptableTranslation(translation_key, token_values);
+
+      if (translation) {
+        this.getLogger().debug("Found a valid match: " + translation.label);      
+        return this.substituteTokens(translation['label'], token_values, options);
+      } else {
+        this.getLogger().debug("No valid match found, using default language");      
+        return this.substituteTokens(this.label, token_values, options);
+      }
+      
+    } else {
+      this.getLogger().debug("Translation not found, using default language");      
+    }
+
+    this.getProxy().registerMissingTranslationKey(this, token_values, options);
+    this.getLogger().debug('No translation found. Using default...');
+    return this.substituteTokens(this.label, token_values, options);    
+  },
+  
+  generateKey: function() {
+    this.key = this.label + ";;;";
+    if (this.description) this.key = this.key + this.description;
+       
+    this.getLogger().debug('Preparing label signature: ' + this.key);
+    this.key = MD5(this.key);
+    this.getLogger().debug('Label signature: ' + this.key);
+  },
+  
+  registerDataTokens: function(label) {
+    this.data_tokens = [];
+    this.data_tokens = this.data_tokens.concat(Tr8n.Proxy.DataToken.parse(label, {'key': this, 'proxy':this.getProxy()}));
+    this.data_tokens = this.data_tokens.concat(Tr8n.Proxy.TransformToken.parse(label, {'key': this, 'proxy':this.getProxy()}));
+  },
+
+  registerDecorationTokens: function(label) {
+    this.decoration_tokens = [];
+    this.decoration_tokens = this.decoration_tokens.concat(Tr8n.Proxy.DecorationToken.parse(label, {'key': this, 'proxy':this.getProxy()}));
+  },
+
+  substituteTokens: function(label, token_values, options) {
+    this.registerDataTokens(label);
+    if (!this.data_tokens) return this.decorateLabel(label, options);
+    for (var i = 0; i < this.data_tokens.length; i++) {
+      label = this.data_tokens[i].substitute(label, token_values || {});
+    }
+    
+    this.registerDecorationTokens(label);
+    if (!this.decoration_tokens) return label;
+    for (var i = 0; i < this.decoration_tokens.length; i++) {
+      label = this.decoration_tokens[i].substitute(label, token_values || {});
+    }
+    
+    return this.decorateLabel(label, options);
+  },
+  
+  decorateLabel: function(label, options){
+    options = options || {};
+    if (options['skip_decorations'])
+      return label;
+      
+    html = [];
+    html.push("<tr8n ");
+    
+    if (this.id) 
+      html.push(" translation_key_id='" + this.id + "' ");
+      
+    if (this.key) 
+      html.push(" id='" + this.key + "' ");
+  
+    var klasses = ['tr8n_translatable'];
+    
+    if (this.original)
+      klasses.push('tr8n_not_translated');
+    else  
+      klasses.push('tr8n_translated');
+
+    if (this.getProxy().inline_translations_enabled && this.id)
+      html.push(" class='" + klasses.join(' ') + "'");
+      
+    html.push(">");
+    html.push(label);
+    html.push("</tr8n>");
+    return html.join("");
+  }
+}

data/app/javascript/src/ui/language_case_manager.js

@@ -0,0 +1,155 @@
+/****************************************************************************
+  Copyright (c) 2010-2012 Michael Berkovich, Ian McDaniel, tr8n.net
+
+  Permission is hereby granted, free of charge, to any person obtaining
+  a copy of this software and associated documentation files (the
+  "Software"), to deal in the Software without restriction, including
+  without limitation the rights to use, copy, modify, merge, publish,
+  distribute, sublicense, and/or sell copies of the Software, and to
+  permit persons to whom the Software is furnished to do so, subject to
+  the following conditions:
+
+  The above copyright notice and this permission notice shall be
+  included in all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+****************************************************************************/
+
+Tr8n.LanguageCaseManager = function(options) {
+  var self = this;
+  this.options = options;
+  this.case_key = null;
+
+  this.container                = document.createElement('div');
+  this.container.className      = 'tr8n_language_case_manager';
+  this.container.id             = 'tr8n_language_case_manager';
+  this.container.style.display  = "none";
+
+  document.body.appendChild(this.container)
+
+  var event_type = Tr8n.Utils.isOpera() ? 'click' : 'contextmenu';
+
+  Tr8n.Utils.addEvent(document, event_type, function(e) {
+    if (Tr8n.Utils.isOpera() && !e.ctrlKey) return;
+
+    var case_node = Tr8n.Utils.findElement(e, ".tr8n_language_case");
+    var link_node = Tr8n.Utils.findElement(e, "a");
+
+    if (case_node == null) return;
+
+    if (link_node) {
+      var temp_href = link_node.href;
+      link_node.href='javascript:void(0);';
+      setTimeout(function() {link_node.href = temp_href;}, 500);
+    }
+
+    if (e.stop) e.stop();
+    if (e.preventDefault) e.preventDefault();
+    if (e.stopPropagation) e.stopPropagation();
+
+    self.show(case_node);
+  });
+}
+
+Tr8n.LanguageCaseManager.prototype = {
+  hide: function() {
+    this.container.style.display = "none";
+    Tr8n.Utils.showFlash();
+  },
+
+  show: function(case_node) {
+    var self = this;
+    if (tr8nLanguageSelector) tr8nLanguageSelector.hide();
+    if (tr8nLightbox) tr8nLightbox.hide();
+    if (tr8nTranslator) tr8nTranslator.hide();
+    Tr8n.Utils.hideFlash();
+
+    var html          = "";
+    var splash_screen = Tr8n.element('tr8n_splash_screen');
+
+    if (splash_screen) {
+      html += splash_screen.innerHTML;
+    } else {
+      html += "<div style='font-size:18px;text-align:center; margin:5px; padding:10px; background-color:black;'>";
+      html += "  <img src='/assets/tr8n/tr8n_logo.jpg' style='width:280px; vertical-align:middle;'>";
+      html += "  <img src='/assets/tr8n/loading3.gif' style='width:200px; height:20px; vertical-align:middle;'>";
+      html += "</div>"
+    }
+    this.container.innerHTML = html;
+    this.container.style.display  = "block";
+
+    var stem                = {v:"top", h:"left",width:10, height:12};
+    var stem_type           = "top_left";
+    var target_dimensions   = {width:case_node.offsetWidth, height:case_node.offsetHeight};
+    var target_position     = Tr8n.Utils.cumulativeOffset(case_node);
+    var container_position  = {
+      left: (target_position[0] + 'px'),
+      top : (target_position[1] + target_dimensions.height + stem.height + 'px')
+    }
+
+    var stem_offset         = target_dimensions.width/2;
+    var scroll_buffer       = 100;
+    var scroll_height       = target_position[1] - scroll_buffer;
+
+    if (window.innerWidth < target_position[0] + target_dimensions.width + window.innerWidth/2) {
+      container_position.left = target_position[0] + target_dimensions.width - this.container.offsetWidth + "px";
+      stem_offset = target_dimensions.width/2;
+      stem.h = "right";
+    }
+
+    window.scrollTo(target_position[0], scroll_height);
+    this.container.style.left     = container_position.left;
+    this.container.style.top      = container_position.top;
+    this.case_id                  = case_node.getAttribute('case_id');
+    this.rule_id                  = case_node.getAttribute('rule_id');
+    this.case_key                 = case_node.getAttribute('case_key');
+
+    window.setTimeout(function() {
+      Tr8n.Utils.update('tr8n_language_case_manager', '/tr8n/language_cases/manager', {
+        evalScripts: true,
+        parameters: {
+            case_id: self.case_id,
+            rule_id: self.rule_id,
+            case_key: self.case_key,
+            stem_type: stem.v + "_" + stem.h,
+            stem_offset: stem_offset
+        }
+      });
+    }, 500);
+  },
+
+  switchToCaseMapMode: function() {
+    Tr8n.Effects.hide('tr8n_language_case_container');
+    Tr8n.Effects.show('tr8n_language_case_exception_container');
+  },
+
+  switchCaseMapMode: function(mode) {
+    var self = this;
+    Tr8n.Utils.update('tr8n_language_cases_form', '/tr8n/language_cases/switch_manager_mode', {
+      evalScripts: true,
+      parameters: {mode: mode, case_key: self.case_key}
+    });
+  },
+
+  reportCaseMap: function(map_id) {
+    var msg = "Reporting these values will remove them from the system and the translator will be put on a watch list. \n\nAre you sure you want to report these values?";
+    if (!confirm(msg)) return;
+
+    Tr8n.element("tr8n_language_case_form").action = "/tr8n/language_cases/report_value_map";
+    Tr8n.Effects.hide('tr8n_language_case_exception_container');
+    Tr8n.Effects.show('tr8n_language_case_report_spinner');
+    Tr8n.Effects.submit('tr8n_language_case_form');
+  },
+
+  submitCaseMap: function() {
+    Tr8n.Effects.hide('tr8n_language_case_exception_container');
+    Tr8n.Effects.show('tr8n_language_case_submit_spinner');
+    Tr8n.Effects.submit('tr8n_language_case_form');
+  }
+}

data/app/javascript/src/ui/language_selector.js

@@ -0,0 +1,126 @@
+/****************************************************************************
+  Copyright (c) 2010-2012 Michael Berkovich, Ian McDaniel, tr8n.net
+
+  Permission is hereby granted, free of charge, to any person obtaining
+  a copy of this software and associated documentation files (the
+  "Software"), to deal in the Software without restriction, including
+  without limitation the rights to use, copy, modify, merge, publish,
+  distribute, sublicense, and/or sell copies of the Software, and to
+  permit persons to whom the Software is furnished to do so, subject to
+  the following conditions:
+
+  The above copyright notice and this permission notice shall be
+  included in all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+****************************************************************************/
+
+Tr8n.LanguageSelector = function(options) {
+  this.options = options || {};
+  this.keyboardMode = false;
+  this.loaded = false;
+
+  this.container                = document.createElement('div');
+  this.container.className      = 'tr8n_language_selector';
+  this.container.id             = 'tr8n_language_selector';
+  this.container.style.display  = "none";
+
+  document.body.appendChild(this.container);
+}
+
+Tr8n.LanguageSelector.prototype = {
+
+  toggle: function() {
+    if (this.container.style.display == "none") {
+      this.show();
+    } else {
+      this.hide();
+    }
+  },
+
+  hide: function() {
+    this.container.style.display = "none";
+    Tr8n.Utils.showFlash();
+  },
+
+  show: function() {
+    var self = this;
+    if (tr8nTranslator) tr8nTranslator.hide();
+    if (tr8nLightbox) tr8nLightbox.hide();
+    if (tr8nLanguageCaseManager) tr8nLanguageCaseManager.hide();
+    Tr8n.Utils.hideFlash();
+
+    var splash_screen = Tr8n.element('tr8n_splash_screen');
+
+    if (!this.loaded) {
+      var html = "";
+      if (splash_screen) {
+        html += splash_screen.innerHTML;
+      } else {
+        html += "<div style='font-size:18px;text-align:center; margin:5px; padding:10px; background-color:black;'>";
+        html += "  <img src='/assets/tr8n/tr8n_logo.jpg' style='width:280px; vertical-align:middle;'>";
+        html += "  <img src='/assets/tr8n/loading3.gif' style='width:200px; height:20px; vertical-align:middle;'>";
+        html += "</div>";
+      }
+      this.container.innerHTML = html;
+    }
+    this.container.style.display  = "block";
+
+    var trigger             = Tr8n.element('tr8n_language_selector_trigger');
+    var trigger_position    = Tr8n.Utils.cumulativeOffset(trigger);
+    var container_position  = {
+      left: trigger_position[0] + trigger.offsetWidth - this.container.offsetWidth + 'px',
+      top: trigger_position[1] + trigger.offsetHeight + 4 + 'px'
+    }
+
+//    if (trigger_position[0] < window.innerWidth/2 ) {
+//      this.container.offsetLeft = trigger_position[0] + 'px';
+//    }
+
+    this.container.style.left     = container_position.left;
+    this.container.style.top      = container_position.top;
+
+    if (!this.loaded) {
+      window.setTimeout(function() {
+        Tr8n.Utils.update('tr8n_language_selector', '/tr8n/language/select', {
+          evalScripts: true
+        })
+      }, 100);
+    }
+
+    this.loaded = true;
+  },
+
+  removeLanguage: function(language_id) {
+    Tr8n.Utils.update('tr8n_language_lists', '/tr8n/language/lists', {
+      parameters: {language_action: "remove", language_id: language_id},
+      method: 'post'
+    });
+  },
+
+  enableInlineTranslations: function() {
+    window.location = "/tr8n/language/switch?language_action=enable_inline_mode&source_url=" + location;
+  },
+
+  disableInlineTranslations: function() {
+    window.location = "/tr8n/language/switch?language_action=disable_inline_mode&source_url=" + location;
+  },
+
+  showDashboard: function() {
+    window.location = "/tr8n/dashboard";
+  },
+
+  manageLanguage: function() {
+    window.location = "/tr8n/language";
+  },
+
+  toggleInlineTranslations: function() {
+    window.location = "/tr8n/language/switch?language_action=toggle_inline_mode&source_url=" + location;
+  }
+}