diff --git a/addons/calendar_sms/views/calendar_views.xml b/addons/calendar_sms/views/calendar_views.xml index 84d07165dcf..37d20181e9a 100644 --- a/addons/calendar_sms/views/calendar_views.xml +++ b/addons/calendar_sms/views/calendar_views.xml @@ -5,7 +5,7 @@ diff --git a/addons/hr_presence/models/hr_employee.py b/addons/hr_presence/models/hr_employee.py index 6347555aaa9..a40dfd256eb 100644 --- a/addons/hr_presence/models/hr_employee.py +++ b/addons/hr_presence/models/hr_employee.py @@ -133,7 +133,7 @@ Please, take appropriate measures in order to carry out this work absence. Do not hesitate to contact your manager or the human resource department.""") return { "type": "ir.actions.act_window", - "res_model": "sms.send_sms", + "res_model": "sms.composer", "view_mode": 'form', "context": { 'active_id': self.id, diff --git a/addons/mail/__manifest__.py b/addons/mail/__manifest__.py index 80e5f0fff28..4fece68c14b 100644 --- a/addons/mail/__manifest__.py +++ b/addons/mail/__manifest__.py @@ -11,6 +11,7 @@ 'data': [ 'wizard/invite_view.xml', 'wizard/mail_compose_message_view.xml', + 'wizard/mail_resend_cancel_views.xml', 'wizard/mail_resend_message_views.xml', 'views/mail_message_subtype_views.xml', 'views/mail_tracking_views.xml', diff --git a/addons/mail/wizard/__init__.py b/addons/mail/wizard/__init__.py index e6ba124f4ae..7e0df4a2d19 100644 --- a/addons/mail/wizard/__init__.py +++ b/addons/mail/wizard/__init__.py @@ -3,6 +3,7 @@ from . import invite from . import mail_compose_message +from . import mail_resend_cancel from . import mail_resend_message from . import email_template_preview from . import base_module_uninstall diff --git a/addons/mail/wizard/mail_resend_cancel.py b/addons/mail/wizard/mail_resend_cancel.py new file mode 100644 index 00000000000..277ed8b96db --- /dev/null +++ b/addons/mail/wizard/mail_resend_cancel.py @@ -0,0 +1,39 @@ +# -*- coding: utf-8 -*- +# Part of Odoo. See LICENSE file for full copyright and licensing details. + +from odoo import _, api, fields, models + + +class MailCancelResend(models.TransientModel): + _name = 'mail.resend.cancel' + _description = 'Dismiss notification for resend by model' + + model = fields.Char(string='Model') + help_message = fields.Char(string='Help message', compute='_compute_help_message') + + @api.multi + @api.depends('model') + def _compute_help_message(self): + for wizard in self: + wizard.help_message = _("Are you sure you want to discard %s mail delivery failures. You won't be able to re-send these mails later!") % (wizard._context.get('unread_counter')) + + @api.multi + def cancel_resend_action(self): + author_id = self.env.user.partner_id.id + for wizard in self: + self._cr.execute(""" + SELECT notif.id, mes.id + FROM mail_message_res_partner_needaction_rel notif + JOIN mail_message mes + ON notif.mail_message_id = mes.id + WHERE notif.email_status IN ('bounce', 'exception') + AND mes.model = %s + AND mes.author_id = %s + """, (wizard.model, author_id)) + res = self._cr.fetchall() + notif_ids = [row[0] for row in res] + messages_ids = list(set([row[1] for row in res])) + if notif_ids: + self.env["mail.notification"].browse(notif_ids).sudo().write({'email_status': 'canceled'}) + self.env["mail.message"].browse(messages_ids)._notify_failure_update() + return {'type': 'ir.actions.act_window_close'} diff --git a/addons/mail/wizard/mail_resend_cancel_views.xml b/addons/mail/wizard/mail_resend_cancel_views.xml new file mode 100644 index 00000000000..c8cc6632c75 --- /dev/null +++ b/addons/mail/wizard/mail_resend_cancel_views.xml @@ -0,0 +1,27 @@ + + + + mail.resend.cancel.view.form + mail.resend.cancel + + +
+ + +

If you want to re-send them, click Cancel now, then click on the notification and review them one by one by clicking on the red envelope next to each message.

+ Envelope Example +
+
+ + +
+ + Discard mail delivery failures + mail.resend.cancel + ir.actions.act_window + form + new + + diff --git a/addons/mail/wizard/mail_resend_message.py b/addons/mail/wizard/mail_resend_message.py index bcff9dc9840..e5e4c069df1 100644 --- a/addons/mail/wizard/mail_resend_message.py +++ b/addons/mail/wizard/mail_resend_message.py @@ -1,10 +1,10 @@ # -*- coding: utf-8 -*- # Part of Odoo. See LICENSE file for full copyright and licensing details. -from odoo import _, api, fields, models -from ast import literal_eval +from odoo import api, fields, models from odoo.exceptions import UserError + class MailResendMessage(models.TransientModel): _name = 'mail.resend.message' _description = 'Email resend wizard' @@ -100,38 +100,3 @@ class PartnerResend(models.TransientModel): resend = fields.Boolean(string="Send Again", default=True) resend_wizard_id = fields.Many2one('mail.resend.message', string="Resend wizard") message = fields.Char(string="Help message") - - -class MailCancelResend(models.TransientModel): - _name = 'mail.resend.cancel' - _description = 'Dismiss notification for resend by model' - - model = fields.Char(string='Model') - help_message = fields.Char(string='Help message', compute='_compute_help_message') - - @api.multi - @api.depends('model') - def _compute_help_message(self): - for wizard in self: - wizard.help_message = _("Are you sure you want to discard %s mail delivery failures. You won't be able to re-send these mails later!") % (wizard._context.get('unread_counter')) - - @api.multi - def cancel_resend_action(self): - author_id = self.env.user.partner_id.id - for wizard in self: - self._cr.execute(""" - SELECT notif.id, mes.id - FROM mail_message_res_partner_needaction_rel notif - JOIN mail_message mes - ON notif.mail_message_id = mes.id - WHERE notif.email_status IN ('bounce', 'exception') - AND mes.model = %s - AND mes.author_id = %s - """, (wizard.model, author_id)) - res = self._cr.fetchall() - notif_ids = [row[0] for row in res] - messages_ids = list(set([row[1] for row in res])) - if notif_ids: - self.env["mail.notification"].browse(notif_ids).sudo().write({'email_status': 'canceled'}) - self.env["mail.message"].browse(messages_ids)._notify_failure_update() - return {'type': 'ir.actions.act_window_close'} diff --git a/addons/mail/wizard/mail_resend_message_views.xml b/addons/mail/wizard/mail_resend_message_views.xml index 1ab5ea047f7..118660e232e 100644 --- a/addons/mail/wizard/mail_resend_message_views.xml +++ b/addons/mail/wizard/mail_resend_message_views.xml @@ -2,7 +2,7 @@ - mail.resend.message.form + mail.resend.message.view.form mail.resend.message @@ -31,23 +31,6 @@ - - mail.resend.cancel.form - mail.resend.cancel - - -
- - -

If you want to re-send them, click Cancel now, then click on the notification and review them one by one by clicking on the red envelope next to each message.

- Envelope Example -
-
- - -
Resend mail mail.resend.message @@ -55,13 +38,5 @@ form new - - Discard mail delivery failures - mail.resend.cancel - ir.actions.act_window - form - new - - diff --git a/addons/phone_validation/models/phone_validation_mixin.py b/addons/phone_validation/models/phone_validation_mixin.py index f378387fc41..f062586c7c3 100644 --- a/addons/phone_validation/models/phone_validation_mixin.py +++ b/addons/phone_validation/models/phone_validation_mixin.py @@ -28,6 +28,6 @@ class PhoneValidationMixin(models.AbstractModel): number, country.code if country else None, country.phone_code if country else None, - always_international=always_international, + force_format='INTERNATIONAL' if always_international else 'NATIONAL', raise_exception=False ) diff --git a/addons/phone_validation/tools/phone_validation.py b/addons/phone_validation/tools/phone_validation.py index 7ca7bed6ea8..29828ffd739 100644 --- a/addons/phone_validation/tools/phone_validation.py +++ b/addons/phone_validation/tools/phone_validation.py @@ -26,14 +26,21 @@ try: return phone_nbr - def phone_format(number, country_code, country_phone_code, always_international=True, raise_exception=True): + def phone_format(number, country_code, country_phone_code, force_format='INTERNATIONAL', raise_exception=True): """ Format the given phone number according to the localisation and international options. - :param number: number to convert - :param country_code: the ISO country code in two chars - :type country_code: str - :param country_phone_code: country dial in codes, defined by the ITU-T (Ex: 32 for Belgium) - :type country_phone_code: int - :rtype: str + :param number: number to convert + :param country_code: the ISO country code in two chars + :type country_code: str + :param country_phone_code: country dial in codes, defined by the ITU-T (Ex: 32 for Belgium) + :type country_phone_code: int + :param force_format: stringified version of format globals (see + https://github.com/daviddrysdale/python-phonenumbers/blob/dev/python/phonenumbers/phonenumberutil.py) + 'E164' = 0 + 'INTERNATIONAL' = 1 + 'NATIONAL' = 2 + 'RFC3966' = 3 + :type force_format: str + :rtype: str """ try: phone_nbr = phone_parse(number, country_code) @@ -43,7 +50,11 @@ try: else: _logger.warning(_('Unable to format %s:\n%s'), number, e) return number - if always_international or phone_nbr.country_code != country_phone_code: + if force_format == 'E164': + phone_fmt = phonenumbers.PhoneNumberFormat.E164 + elif force_format == 'RFC3966': + phone_fmt = phonenumbers.PhoneNumberFormat.RFC3966 + elif force_format == 'INTERNATIONAL' or phone_nbr.country_code != country_phone_code: phone_fmt = phonenumbers.PhoneNumberFormat.INTERNATIONAL else: phone_fmt = phonenumbers.PhoneNumberFormat.NATIONAL @@ -54,7 +65,7 @@ except ImportError: def phone_parse(number, country_code): return False - def phone_format(number, country_code, country_phone_code, always_international=True, raise_exception=True): + def phone_format(number, country_code, country_phone_code, force_format='INTERNATIONAL', raise_exception=True): global _phonenumbers_lib_warning if not _phonenumbers_lib_warning: _logger.warning( @@ -63,3 +74,56 @@ except ImportError: ) _phonenumbers_lib_warning = True return number + + +def phone_sanitize_numbers(numbers, country_code, country_phone_code, force_format='E164'): + valid, invalid, void_count = [], [], 0 + for number in numbers: + if not number: + void_count += 1 + continue + try: + sanitized = phone_format( + number, country_code, country_phone_code, + force_format=force_format, raise_exception=True) + except Exception as e: + invalid.append(number) + else: + valid.append(sanitized) + return valid, invalid, void_count + + +def phone_sanitize_numbers_w_record(numbers, country_code, country_phone_code, record, record_country_fname='country_id', force_format='E164'): + if not country_code or not country_phone_code: + country = False + if record and record_country_fname in record and record[record_country_fname]: + country = record[record_country_fname] + elif record: + country = record.env.company.country_id + if country: + country_code = country_code if country_code else country.code + country_phone_code = country_phone_code if country_phone_code else country.phone_code + return phone_sanitize_numbers(numbers, country_code, country_phone_code, force_format=force_format) + + +def phone_sanitize_numbers_string_w_record(numbers_str, country_code, country_phone_code, record, record_country_fname='country_id', force_format='E164'): + found_numbers = [number.strip() for number in numbers_str.split(',')] + return phone_sanitize_numbers_w_record(found_numbers, country_code, country_phone_code, record, record_country_fname, force_format=force_format) + + +def phone_get_sanitized_records_number(records, number_fname='mobile', country_fname='country_id', force_format='E164'): + res = dict.fromkeys(records.ids, False) + for record in records: + number = record[number_fname] + valid, invalid, void_count = phone_sanitize_numbers_w_record([number], None, None, records, country_fname,force_format=force_format) + if valid: + res[record.id] = valid[0] + elif void_count: + res[record.id] = False + else: + res[record.id] = False + return res + + +def phone_get_sanitized_record_number(record, number_fname='mobile', country_fname='country_id', force_format='E164'): + return phone_get_sanitized_records_number(record, number_fname, country_fname, force_format=force_format)[record.id] diff --git a/addons/sms/__init__.py b/addons/sms/__init__.py index 2ae6446f9dc..f7a591caed7 100644 --- a/addons/sms/__init__.py +++ b/addons/sms/__init__.py @@ -2,4 +2,5 @@ # Part of Odoo. See LICENSE file for full copyright and licensing details. from . import models +from . import tests from . import wizard diff --git a/addons/sms/__manifest__.py b/addons/sms/__manifest__.py index 574a13810d3..4ef5721be8f 100644 --- a/addons/sms/__manifest__.py +++ b/addons/sms/__manifest__.py @@ -10,12 +10,12 @@ This module gives a framework for SMS text messaging The service is provided by the In App Purchase Odoo platform. """, - 'depends': ['base', 'iap', 'mail'], + 'depends': ['base', 'iap', 'mail', 'phone_validation'], 'data': [ - 'wizard/send_sms_views.xml', + 'wizard/sms_composer_views.xml', 'views/res_config_settings_views.xml', 'views/res_partner_views.xml', - 'views/templates.xml', + 'views/assets.xml', ], 'qweb': [ 'static/src/xml/sms_widget.xml', diff --git a/addons/sms/models/sms_api.py b/addons/sms/models/sms_api.py index f770676d0ca..1b6be2607fc 100644 --- a/addons/sms/models/sms_api.py +++ b/addons/sms/models/sms_api.py @@ -1,8 +1,7 @@ # -*- coding: utf-8 -*- # Part of Odoo. See LICENSE file for full copyright and licensing details. -from odoo import api, fields, models -from odoo.exceptions import UserError +from odoo import api, models from odoo.addons.iap.models import iap DEFAULT_ENDPOINT = 'https://iap-sms.odoo.com' @@ -13,15 +12,47 @@ class SmsApi(models.AbstractModel): _description = 'SMS API' @api.model - def _send_sms(self, numbers, message): - """ Send sms - """ + def _contact_iap(self, local_endpoint, params): account = self.env['iap.account'].get('sms') + params['account_token'] = account.account_token + endpoint = self.env['ir.config_parameter'].sudo().get_param('sms.endpoint', DEFAULT_ENDPOINT) + # TODO PRO, the default timeout is 15, do we have to increase it ? + return iap.jsonrpc(endpoint + local_endpoint, params=params) + + @api.model + def _send_sms(self, numbers, message): + """ Send a single message to several numbers + + :param numbers: list of E164 formatted phone numbers + :param message: content to send + + :raises ? TDE FIXME + """ params = { - 'account_token': account.account_token, 'numbers': numbers, 'message': message, } - endpoint = self.env['ir.config_parameter'].sudo().get_param('sms.endpoint', DEFAULT_ENDPOINT) - r = iap.jsonrpc(endpoint + '/iap/message_send', params=params) - return True + return self._contact_iap('/iap/message_send', params) + + @api.model + def _send_sms_batch(self, messages): + """ Send SMS using IAP in batch mode + + :param messages: list of SMS to send, structured as dict [{ + 'res_id': integer: ID of sms.sms, + 'number': string: E164 formatted phone number, + 'content': string: content to send + }] + + :return: return of /iap/sms/1/send controller which is a list of dict [{ + 'res_id': integer: ID of sms.sms, + 'state': string: 'insufficient_credit' or 'wrong_format_number' or 'success', + 'credit': integer: number of credits spent to send this SMS, + }] + + :raises: normally none + """ + params = { + 'messages': messages + } + return self._contact_iap('/iap/sms/1/send', params) diff --git a/addons/sms/tests/__init__.py b/addons/sms/tests/__init__.py new file mode 100644 index 00000000000..511e649c9e2 --- /dev/null +++ b/addons/sms/tests/__init__.py @@ -0,0 +1,4 @@ +# -*- coding: utf-8 -*- +# Part of Odoo. See LICENSE file for full copyright and licensing details. + +from . import common diff --git a/addons/sms/tests/common.py b/addons/sms/tests/common.py new file mode 100644 index 00000000000..25ca2dfdf7f --- /dev/null +++ b/addons/sms/tests/common.py @@ -0,0 +1,71 @@ +# -*- coding: utf-8 -*- + +from contextlib import contextmanager +from unittest.mock import patch + +from odoo import exceptions +from odoo.tests import common +from odoo.addons.sms.models.sms_api import SmsApi + + +class MockSMS(common.BaseCase): + + def tearDown(self): + super(MockSMS, self).tearDown() + self._clear_sms_sent + + @contextmanager + def mockSMSGateway(self, sim_error=None, nbr_t_error=None): + self._sms = [] + + def _contact_iap(local_endpoint, params): + # mock single sms sending + if local_endpoint == '/iap/message_send': + self._sms += [{ + 'number': number, + 'body': params['message'], + } for number in params['numbers']] + return True # send_message v0 API returns always True + # mock batch sending + if local_endpoint == '/iap/sms/1/send': + result = [] + for to_send in params['messages']: + res = {'res_id': to_send['res_id'], 'state': 'success', 'credit': 1} + error = sim_error or (nbr_t_error and nbr_t_error.get(to_send['number'])) + if error and error == 'credit': + res.update(credit=0, state='insufficient_credit') + elif error and error == 'wrong_format_number': + res.update(state='wrong_format_number') + elif error and error == 'jsonrpc_exception': + raise exceptions.AccessError( + 'The url that this service requested returned an error. Please contact the author of the app. The url it tried to contact was ' + local_endpoint + ) + result.append(res) + if res['state'] == 'success': + self._sms.append({ + 'number': to_send['number'], + 'body': to_send['content'], + }) + return result + + try: + with patch.object(SmsApi, '_contact_iap', side_effect=_contact_iap) as contact_iap_mock: + yield + finally: + pass + + def assertSMSSent(self, numbers, content): + """ Check sent SMS. Order is not checked. Each number should have received + the same content. Usefull to check batch sending. + + :param numbers: list of numbers; + :param content: content to check for each number; + """ + self.assertEqual(len(self._sms), len(numbers)) + for number in numbers: + sent_sms = next((sms for sms in self._sms if sms['number'] == number), None) + self.assertTrue(bool(sent_sms), 'Number %s not found in %s' % (number, repr([s['number'] for s in self._sms]))) + self.assertEqual(sent_sms['body'], content) + + def _clear_sms_sent(self): + self._sms = [] diff --git a/addons/sms/views/templates.xml b/addons/sms/views/assets.xml similarity index 100% rename from addons/sms/views/templates.xml rename to addons/sms/views/assets.xml diff --git a/addons/sms/views/res_partner_views.xml b/addons/sms/views/res_partner_views.xml index 1773c31a30c..1a483568178 100644 --- a/addons/sms/views/res_partner_views.xml +++ b/addons/sms/views/res_partner_views.xml @@ -2,8 +2,8 @@ - - res.partner.form.send.sms + + res.partner.view.form.inherit.sms res.partner 10 @@ -14,7 +14,7 @@