diff --git a/web_translate_dialog_page/__init__.py b/web_translate_dialog_page/__init__.py new file mode 100644 index 00000000..f1454453 --- /dev/null +++ b/web_translate_dialog_page/__init__.py @@ -0,0 +1,23 @@ +# -*- coding: utf-8 -*- +############################################################################## +# +# Author: Guewen Baconnier +# Copyright 2012 Camptocamp SA +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +############################################################################## + +import orm + diff --git a/web_translate_dialog_page/__openerp__.py b/web_translate_dialog_page/__openerp__.py new file mode 100644 index 00000000..01fa58ee --- /dev/null +++ b/web_translate_dialog_page/__openerp__.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +############################################################################## +# +# Author: Guewen Baconnier +# Copyright 2012 Camptocamp SA +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +############################################################################## + +{ + "name": "Web Translate Dialog in Page view", + "category": "Hidden", + "description": + """ +Replace the standard translation dialog by an alternative one: + + * Hide the buttons at right of the fields and instead + * Add a "Translate" button in page view, next to "Edit" + * The translation dialog displays empty fields for the untranslated fields, + instead of the source values. + * Autosize the text boxes + + """, + "version": "1.0", + "depends": [ + 'web', + 'web_textarea_autosize', + ], + 'js': [ + 'static/src/js/web_translate_dialog_page.js', + ], + 'css' : [ + 'static/src/css/base.css', + ], + 'qweb' : [ + "static/src/xml/base.xml", + ], + 'auto_install': False, +} + + diff --git a/web_translate_dialog_page/orm.py b/web_translate_dialog_page/orm.py new file mode 100644 index 00000000..03b1f742 --- /dev/null +++ b/web_translate_dialog_page/orm.py @@ -0,0 +1,173 @@ +# -*- coding: utf-8 -*- +############################################################################## +# +# Author: Guewen Baconnier +# Copyright 2012 Camptocamp SA +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as +# published by the Free Software Foundation, either version 3 of the +# License, or (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +############################################################################## + +import openerp.osv.orm + + +# Check if we can remove the monkey-patching once the bug: +# https://bugs.launchpad.net/bugs/1053970 +# is resolved. +original_create = openerp.osv.orm.BaseModel.create +def create(self, cr, uid, vals, context=None): + """ + Monkey-patch the create of BaseModel in order to create translation lines + on translatable fields. + + Actually, the original behavior is quite strange. Here it is: + I'm logged in with en_US language. + I create a record, with a (translatable) title 'My title' + I check the source in database (table of the object), that's 'My title' + I check the translation lines for the en_US language, no line + I write on my record the title 'My title updated' + I check the source in database, that's 'My title updated' + I check the translation lines for the en_US language, no line + + I'm logged in with fr_FR language + I create a record, with a (translatable) title 'Mon titre' + I check the source in database (table of the object), that's 'Mon titre' + I check the translation lines for the fr_FR language, no line + I write on my record the title 'Mon titre mis à jour' + I check the source in database, that's 'Mon titre' (unchanged) + I check the translation lines for the fr_FR language, I have a line with 'Mon titre mis à jour' + + As you can see, the write method create translation lines for other + languages than en_US, that's correct. The create method does not, + and it has to do it. + + OpenERP seems to assume that the en_US should be the reference + language, so lets assume it completely, and generate the french + translation line directly when we enter the value. + + That's weird, because, if I create a record in french, the source + will be the french value (of course), but programmatically, I do not + have any means to know that someone entered a french translation. + + A simple scenario where the bug will occurs: + + User A is logged in with fr_FR + User A creates a product with a name 'Marteau' + User B is logged in with en_US + User B modifies the product 'Marteau' to be 'Hammer' + => The french translation is lost. + + It won't occurs in this slightly modified scenario: + + User A is logged in with fr_FR + User A creates a product with a name 'Martea' (typo) + User A modifies the product 'Martea' to be 'Marteau' + User B is logged in with en_US + User B modifies the product 'Marteau' to be 'Hammer' + => The french translation isn't lost, because the write has + correctly generated the french translation line + + + Bug reported : https://bugs.launchpad.net/bugs/1053970 + + """ + if context is None: + context = {} + + record_id = original_create(self, cr, uid, vals, context=context) + + if context.get('lang') and context['lang'] != 'en_US': + translate_fields = [field for field in vals if + field in self._columns and + self._columns[field].translate and + self._columns[field]._classic_write and + not hasattr(self._columns[field], '_fnct_inv')] + + for field in translate_fields: + src_trans = self.read(cr, uid, record_id, [field])[field] + if not src_trans: + src_trans = vals[field] + # Inserting value to DB + self.write(cr, uid, record_id, {field: vals[field]}) + self.pool.get('ir.translation')._set_ids( + cr, uid, + self._name + ',' + field, + 'model', + context['lang'], + [record_id], + vals[field], + src_trans) + + return record_id + +openerp.osv.orm.BaseModel.create = create + + +# add the method in the orm so we can use it from the TranslateDialog of the +# webclient +def read_translations(self, cr, user, ids, fields=None, context=None, load='_classic_read'): + """ Read records with given ids with the given fields, if a field is not + translated, its value will be False instead of the source language's value. + + :param fields: optional list of field names to return (default: all fields would be returned) + :type fields: list (example ['field_name_1', ...]) + :return: list of dictionaries((dictionary per record asked)) with requested field values + :rtype: [{‘name_of_the_field’: value, ...}, ...] + :raise AccessError: * if user has no read rights on the requested object + * if user tries to bypass access rules for read on the requested object + + """ + + if context is None: + context = {} + self.check_read(cr, user) + if not fields: + fields = list(set(self._columns.keys() + self._inherit_fields.keys())) + if isinstance(ids, (int, long)): + select = [ids] + else: + select = ids + select = map(lambda x: isinstance(x, dict) and x['id'] or x, select) + result = self._read_flat(cr, user, select, fields, context, load) + + fields_pre = [f for f in fields if + (f in self._columns and + getattr(self._columns[f], '_classic_write'))] + \ + self._inherits.values() + + if context.get('lang') and context['lang'] != 'en_US': + for f in fields_pre: + if self._columns[f].translate: + res_ids = [x['id'] for x in result] + res_trans = self.pool.get('ir.translation')._get_ids( + cr, user, + self._name + ',' + f, + 'model', + context['lang'], + res_ids) + for r in result: + if not res_trans.get(r['id']): + r[f] = None + + for r in result: + for key, v in r.iteritems(): + if v is None: + r[key] = False + + if isinstance(ids, (int, long, dict)): + return result and result[0] or False + return result + +openerp.osv.orm.BaseModel.read_translations = read_translations + diff --git a/web_translate_dialog_page/static/src/css/base.css b/web_translate_dialog_page/static/src/css/base.css new file mode 100644 index 00000000..8f0eaeca --- /dev/null +++ b/web_translate_dialog_page/static/src/css/base.css @@ -0,0 +1,4 @@ +.oe_field_translate { + visibility: hidden; +} + diff --git a/web_translate_dialog_page/static/src/js/web_translate_dialog_page.js b/web_translate_dialog_page/static/src/js/web_translate_dialog_page.js new file mode 100644 index 00000000..3dd918a8 --- /dev/null +++ b/web_translate_dialog_page/static/src/js/web_translate_dialog_page.js @@ -0,0 +1,141 @@ +openerp.web_translate_dialog_page = function (openerp) { + + var _t = openerp.web._t; + + openerp.web.PageView.include({ + on_loaded: function(data) { + this._super(data); + this.$form_header.find('button.oe_form_button_translate').click(this.on_button_translate); + }, + on_button_translate: function() { + var self = this; + $.when(this.has_been_loaded).then(function() { + self.open_translate_dialog(this); + }); + } + }); + + openerp.web.View.include({ + // Replace the translation dialog by the new one + open_translate_dialog: function(field) { + if (!this.translate_dialog) { + this.translate_dialog = new openerp.web_translate_dialog_page.TranslateDialogPage(this).start(); + } + this.translate_dialog.open(field); + } + }); + + // completely redefine the translation dialog because we can + // not completely tie the standard one to our needs by sub-classing + openerp.web_translate_dialog_page.TranslateDialogPage = openerp.web.Dialog.extend({ + dialog_title: {toString: function () { return _t("Translations"); }}, + init: function(view) { + this.view_language = view.session.user_context.lang; + this['on_button_' + _t("Save")] = this.on_btn_save; + this['on_button_' + _t("Close")] = this.on_btn_close; + this._super(view, { + width: '80%', + height: '90%' + }); + this.view = view; + this.view_type = view.fields_view.type || ''; + this.$fields_form = null; + this.$view_form = null; + this.$sidebar_form = null; + this.translatable_fields_keys = _.map(this.view.translatable_fields || [], function(i) { return i.name;}); + this.languages = null; + this.languages_loaded = $.Deferred(); + (new openerp.web.DataSetSearch(this, 'res.lang', this.view.dataset.get_context(), + [['translatable', '=', '1']])).read_slice(['code', 'name'], { sort: 'id' }).then(this.on_languages_loaded); + }, + on_languages_loaded: function(langs) { + this.languages = langs; + this.languages_loaded.resolve(); + }, + start: function() { + var self = this; + this._super(); + $.when(this.languages_loaded).then(function() { + self.$element.html(QWeb.render('TranslateDialogPage', { widget: self })); + self.$fields_form = self.$element.find('.oe_translation_form'); + self.$fields_form.find('.oe_trad_field').change(function() { + $(this).toggleClass('touched', ($(this).val() != $(this).attr('data-value'))); + }); + var $textarea = self.$fields_form.find('textarea.oe_trad_field'); + $textarea.autosize(); + $textarea.css({minHeight:'100px'}); + }); + return this; + }, + + // use a `read_translations` method instead of a `read` + // this latter leave the fields empty if there is no + // translation for a field instead of taking the src field + do_load_fields_values: function(callback) { + var self = this, + deffered = []; + + this.$fields_form.find('.oe_trad_field').val('').removeClass('touched'); + _.each(self.languages, function(lg) { + var deff = $.Deferred(); + deffered.push(deff); + var callback = function(values) { + _.each(self.translatable_fields_keys, function(f) { + self.$fields_form.find('.oe_trad_field[name="' + lg.code + '-' + f + '"]').val(values[0][f] || '').attr('data-value', values[0][f] || ''); + }); + deff.resolve(); + }; + self.view.dataset.call( + 'read_translations', + [[self.view.datarecord.id], + self.translatable_fields_keys, + self.view.dataset.get_context({ + 'lang': lg.code + })], callback); + }); + $.when.apply(null, deffered).then(callback); + }, + open: function(field) { + var self = this, + sup = this._super; + $.when(this.languages_loaded).then(function() { + if (self.view.translatable_fields && self.view.translatable_fields.length) { + self.do_load_fields_values(function() { + sup.call(self); + $(window).resize(); + }); + } else { + sup.call(self); + } + }); + }, + on_btn_save: function() { + var trads = {}, + self = this, + trads_mutex = new $.Mutex(); + self.$fields_form.find('.oe_trad_field.touched').each(function() { + var field = $(this).attr('name').split('-'); + if (!trads[field[0]]) { + trads[field[0]] = {}; + } + trads[field[0]][field[1]] = $(this).val(); + }); + _.each(trads, function(data, code) { + if (code === self.view_language) { + _.each(data, function(value, field) { + self.view.fields[field].set_value(value); + }); + } + trads_mutex.exec(function() { + return new openerp.web.DataSet(self, self.view.dataset.model, self.view.dataset.get_context()).write(self.view.datarecord.id, data, { context : { 'lang': code }}); + }); + }); + this.close(); + }, + on_btn_close: function() { + this.close(); + } + + }); +}; + diff --git a/web_translate_dialog_page/static/src/xml/base.xml b/web_translate_dialog_page/static/src/xml/base.xml new file mode 100644 index 00000000..c834bd10 --- /dev/null +++ b/web_translate_dialog_page/static/src/xml/base.xml @@ -0,0 +1,32 @@ + + + + + + + + + + + + +
+
Field
+
+
+
+ + + + +
+
+ + + + + + + +
+