tr8n 3.1.1 → 3.1.2

data/app/models/tr8n/numeric_rule.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/app/models/tr8n/sync_log.rb

@@ -0,0 +1,76 @@
+#--
+# Copyright (c) 2010-2011 Michael Berkovich, 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.
+#++
+
+class Tr8n::SyncLog < ActiveRecord::Base
+  
+  def self.sync
+    log = Tr8n::SyncLog.create(:started_at => Time.now)
+    key_count = 0
+    translation_count = 0
+    payload = []
+    Tr8n::TranslationKey.find_each(:batch_size => Tr8n::Config.synchronization_batch_size) do |key|
+      key_count += 1
+      
+      payload << key.to_api_hash
+
+      puts "*"
+      
+      if key_count % Tr8n::Config.synchronization_batch_size == 0
+        exchange(payload)
+      end
+    end
+    log.update_attributes(:finished_at => Time.now)
+  rescue Exception => ex  
+    pp ex.message
+  end
+  
+  def self.access_token
+    @access_token ||= begin
+      uri = URI.parse("#{Tr8n::Config.synchronization_server}/platform/oauth/request_token?client_id=#{Tr8n::Config.synchronization_key}&client_secret=#{Tr8n::Config.synchronization_secret}&grant_type=client_credentials")
+      response = Net::HTTP.get_response(uri)
+      data = JSON.parse(response.body)
+      raise Tr8n::Exception.new("Failed to get access token") unless data["access_toke"]
+      data["access_token"]
+    end
+  end
+  
+  def self.exchange(payload)
+    uri = URI.parse("#{Tr8n::Config.synchronization_server}/api/sync")
+    
+    req = Net::HTTP::Post.new(uri.path)
+    req.body = JSON.generate({:translation_keys => payload})
+    req["Content-Type"] = "application/json"
+    req["Authorization"] = "Bearer #{access_token}"
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    response = http.start {|htt| htt.request(req)}
+    raise Tr8n::Exception.new("Synchronization failed") unless response.status == 200
+    
+    data = JSON.parse(response.body)
+    
+    data[:translation_keys].each do |tkey_hash|
+      Tr8n::TranslationKey.create_from_api_hash(tkey_hash, Tr8n::Config.system_translator)
+    end
+  end
+  
+end

data/app/{controllers/tr8n/application_controller.rb → models/tr8n/sync_log_filter.rb}

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -22,6 +22,7 @@
 #++
 
 module Tr8n
-  class ApplicationController < ActionController::Base
+  class SyncLogFilter < Tr8n::BaseFilter
+  
   end
-end
+end

data/app/models/tr8n/total_language_metric.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -24,11 +24,12 @@
 class Tr8n::TotalLanguageMetric < Tr8n::LanguageMetric
 
   def update_metrics!
-    self.user_count = Tr8n::LanguageUser.count(:conditions => ["language_id = ?", language_id])
-    self.translator_count = Tr8n::LanguageUser.count(:conditions => ["language_id = ? and translator_id is not null", language_id])
-    self.translation_count = Tr8n::Translation.count(:conditions => ["language_id = ?", language_id])
+    self.user_count = Tr8n::LanguageUser.where("language_id = ?", language_id).count
+    self.translator_count = Tr8n::LanguageUser.where("language_id = ? and translator_id is not null", language_id).count
+    self.translation_count = Tr8n::Translation.where("language_id = ?", language_id).count
     self.key_count = Tr8n::TranslationKey.count
     
+    # TODO: switch to the Rails 3.1 way
     self.locked_key_count = Tr8n::TranslationKey.count("distinct tr8n_translation_keys.id",
         :conditions => ["tr8n_translation_key_locks.language_id = ? and tr8n_translation_key_locks.locked = ?", language_id, true],
         :joins => "join tr8n_translation_key_locks on tr8n_translation_keys.id = tr8n_translation_key_locks.translation_key_id") 

data/app/models/tr8n/translation.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -37,14 +37,19 @@ class Tr8n::Translation < ActiveRecord::Base
   alias :key :translation_key
   alias :votes :translation_votes
 
+  # TODO: move this to config file
   VIOLATION_INDICATOR = -10
 
   def vote!(translator, score)
     score = score.to_i
     vote = Tr8n::TranslationVote.find_or_create(self, translator)
     vote.update_attributes(:vote => score.to_i)
+    
     update_rank!
     
+    # update the translation key timestamp
+    key.touch
+
     self.translator.update_rank!(language) if self.translator
     
     # add the translator to the watch list
@@ -55,8 +60,7 @@ class Tr8n::Translation < ActiveRecord::Base
   end
   
   def update_rank!
-    self.rank = Tr8n::TranslationVote.sum("vote", :conditions => ["translation_id = ?", self.id])
-    save
+    update_attributes(:rank => Tr8n::TranslationVote.where(:translation_id => self.id).sum(:vote))
   end
   
   def reset_votes!(translator)
@@ -64,6 +68,7 @@ class Tr8n::Translation < ActiveRecord::Base
     vote!(translator, 1)
   end
   
+  # TODO: move this stuff to decorators
   def rank_style(rank)
     Tr8n::Config.default_rank_styles.each do |range, color|
       return color if range.include?(rank)
@@ -71,6 +76,7 @@ class Tr8n::Translation < ActiveRecord::Base
     "color:grey"
   end
   
+  # TODO: move this stuff to decorators
   def rank_label
     return "<span style='color:grey'>0</span>" if rank.blank?
     
@@ -94,6 +100,9 @@ class Tr8n::Translation < ActiveRecord::Base
     end
   end
 
+  # generates a hash of token => rule_id
+  # TODO: is this still being used? 
+  # Warning: same token can have multiple rules in a single translation
   def rules_hash
     return nil if rules.nil? or rules.empty? 
     
@@ -106,6 +115,44 @@ class Tr8n::Translation < ActiveRecord::Base
     end
   end
 
+  # generates the hash without rule ids, but with full definitions
+  def rules_api_hash
+    @rules_api_hash ||= (rules || []).collect{|rule_hash| rule_hash[:rule].to_api_hash.merge(:token => rule_hash[:token])}
+  end
+
+  # serilaize translation to API hash to be used for synchronization
+  def to_api_hash
+    {:locale => language.locale, :label => label, :rank => rank, :rules => rules_api_hash}
+  end
+
+  # create translation from API hash for a specific key
+  def self.create_from_api_hash(tkey, translator, hash, opts = {})
+    return if hash[:label].blank? # don't add empty translations
+    lang = Tr8n::Language.for(hash[:locale])
+    return unless lang # don't add translations for an unsupported language
+
+    tkey.translations.each do |trn|
+      # if an identical translation exists, don't add it
+      return if trn.to_api_hash == hash
+    end
+    
+    # generate rules for the translation
+    rules = nil
+    
+    if hash[:rules].any?
+      hash[:rules].each do |rule_hash|
+        return unless rule_hash[:token] and rule_hash[:type] and rule_hash[:definition]
+        
+        rule = Tr8n::LanguageRule.for_definition(lang, translator, rule_hash[:type], rule_hash[:definition], opts)
+        return unless rule # if the rule has not been created, we should not even add the translation
+        rules << {:token => rule_hash[:token], :rule_id => rule.id}
+      end
+    end
+    
+    tkey.add_translation(hash[:label], rules, lang, translator)
+  end
+
+  # deprecated - api_hash should be used instead
   def rules_definitions
     return nil if rules.nil? or rules.empty? 
     @rules_definitions ||= begin
@@ -117,6 +164,7 @@ class Tr8n::Translation < ActiveRecord::Base
     end
   end
 
+  # TODO: move to decorators
   def context
     return nil if rules.nil? or rules.empty? 
     
@@ -129,6 +177,7 @@ class Tr8n::Translation < ActiveRecord::Base
     end
   end
 
+  # checks if the translation is valid for the given tokens
   def matches_rules?(token_values)
     return true if rules.nil? # doesn't have any rules
     return false if rules.empty?  # had some rules that have been removed
@@ -143,14 +192,13 @@ class Tr8n::Translation < ActiveRecord::Base
     true
   end
   
+  # used by the permutation generator
   def matches_rule_definitions?(new_rules_hash)
     rules_hash == new_rules_hash
   end
 
   def self.default_translation(translation_key, language, translator)
-    trans = find(:first, 
-      :conditions => ["translation_key_id = ? and language_id = ? and translator_id = ? and rules is null", 
-                       translation_key.id, language.id, translator.id], :order => "rank desc")
+    trans = where("translation_key_id = ? and language_id = ? and translator_id = ? and rules is null", translation_key.id, language.id, translator.id).order("rank desc").first
     trans ||= new(:translation_key => translation_key, :language => language, :translator => translator, :label => translation_key.sanitized_label)
     trans  
   end
@@ -163,13 +211,9 @@ class Tr8n::Translation < ActiveRecord::Base
     # for now, treat all translations as uniq
     return true
     
-    conditions = ["translation_key_id = ? and language_id = ? and label = ?", translation_key.id, language.id, label]
-    if self.id
-      conditions[0] << " and id <> ?"
-      conditions << self.id
-    end
-    
-    self.class.find(:all, :conditions => conditions).empty?
+    trns = self.class.where("translation_key_id = ? and language_id = ? and label = ?", translation_key.id, language.id, label)
+    trns = trns.where("id <> ?", self.id) if self.id
+    trns.count == 0
   end
   
   def clean?
@@ -248,6 +292,10 @@ class Tr8n::Translation < ActiveRecord::Base
   
   def self.for_params(params, language = Tr8n::Config.current_language)
     results = self.where("language_id = ?", language.id)
+    
+    # ensure that only allowed translations are visible
+    results = results.where("translation_key_id in (select id from tr8n_translation_keys where level <= ?)", Tr8n::Config.current_translator.level) 
+    
     results = results.where("label like ?", "%#{params[:search]}%") unless params[:search].blank?
   
     if params[:with_status] == "accepted"

data/app/models/tr8n/translation_domain.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/app/models/tr8n/translation_domain_filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/app/models/tr8n/translation_filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/app/models/tr8n/translation_key.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -218,7 +218,6 @@ class Tr8n::TranslationKey < ActiveRecord::Base
     
   def add_translation(label, rules = nil, language = Tr8n::Config.current_language, translator = Tr8n::Config.current_translator)
     raise Tr8n::Exception.new("The sentence contains dirty words") unless language.clean_sentence?(label)
-    
     translation = Tr8n::Translation.create(:translation_key => self, :language => language, 
                                            :translator => translator, :label => label, :rules => rules)
     translation.vote!(translator, 1)
@@ -226,10 +225,11 @@ class Tr8n::TranslationKey < ActiveRecord::Base
   end
 
   # returns all translations for the key, language and minimal rank
-  def translations_for(language, rank = nil)
-    translations = Tr8n::Translation.where("translation_key_id = ? and language_id = ?", self.id, language.id)
+  def translations_for(language = nil, rank = nil)
+    translations = Tr8n::Translation.where("translation_key_id = ?", self.id)
+    translations = translations.where("language_id = ?", language.id) if language
     translations = translations.where("rank >= ?", rank) if rank
-    translations.order("rank desc")
+    translations.order("rank desc").all
   end
 
   # used by the inline popup dialog, we don't want to show blocked translations
@@ -427,6 +427,7 @@ class Tr8n::TranslationKey < ActiveRecord::Base
     processed_label
   end
   
+  # TODO: move all this stuff out of the model to decorators
   def default_decoration(language = Tr8n::Config.current_language, options = {})
     return label if Tr8n::Config.current_user_is_guest?
     return label unless Tr8n::Config.current_user_is_translator?
@@ -507,6 +508,33 @@ class Tr8n::TranslationKey < ActiveRecord::Base
     Tr8n::Translation.create(:translation_key => self, :label => label, :language => lang, :translator => translator)
   end
 
+  def to_api_hash
+    { 
+      :key => self.key, 
+      :label => self.label, 
+      :description => self.description, 
+      :locale => (locale || Tr8n::Config.default_locale), 
+      :translations => translations_for(nil, Tr8n::Config.translation_threshold).collect{|t| t.to_api_hash}
+    }
+  end
+
+  # create translation key from API hash
+  def self.create_from_api_hash(tkey_hash, translator, opts = {})
+    return if tkey_hash[:key].blank? or tkey_hash[:label].blank? or tkey_hash[:locale].blank?
+     
+    tkey = Tr8n::TranslationKey.find_or_create(tkey_hash[:label], tkey_hash[:description])
+
+    # return unless tkey.key==tkey_hash[:key] # need to warn the user that the key methods don't match
+
+    opts[:force_create] = Tr8n::Config.synchronization_create_rules? if opts[:force_create].nil?
+    
+    (tkey_hash[:translations] || []).each do |trn_hash|
+      Tr8n::Translation.create_from_api_hash(tkey, translator, trn_hash, opts)
+    end
+
+    tkey
+  end
+
   ###############################################################
   ## Feature Related Stuff
   ###############################################################

data/app/models/tr8n/translation_key_comment.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/app/models/tr8n/translation_key_comment_filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/app/models/tr8n/translation_key_filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/app/models/tr8n/translation_key_lock.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -33,7 +33,7 @@ class Tr8n::TranslationKeyLock < ActiveRecord::Base
   alias :key :translation_key
   
   def self.find_or_create(translation_key, language)
-    lock = find(:first, :conditions => ["translation_key_id = ? and language_id = ?", translation_key.id, language.id])
+    lock = where("translation_key_id = ? and language_id = ?", translation_key.id, language.id).first
     lock || create(:translation_key => translation_key, :language => language)
   end
 

data/app/models/tr8n/translation_key_lock_filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the

data/app/models/tr8n/translation_key_source.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -36,7 +36,7 @@ class Tr8n::TranslationKeySource < ActiveRecord::Base
 
   def self.find_or_create(translation_key, translation_source)
     Tr8n::Cache.fetch("translation_key_source_#{translation_key.id}_#{translation_source.id}") do 
-      tks = find(:first, :conditions => ["translation_key_id = ? and translation_source_id = ?", translation_key.id, translation_source.id])
+      tks = where("translation_key_id = ? and translation_source_id = ?", translation_key.id, translation_source.id).first
       tks || create(:translation_key => translation_key, :translation_source => translation_source)
     end  
   end

data/app/models/tr8n/translation_key_source_filter.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2010-2011 Michael Berkovich
+# Copyright (c) 2010-2011 Michael Berkovich, tr8n.net
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the