[IMP] email.compose.message: useability improvements

bzr revid: rha@tinyerp.com-20110419115850-8vsbd9yv3vhedgss

10 files changed, 90 insertions, 14 deletions

diff --git a/addons/crm/wizard/email_compose_message.py b/addons/crm/wizard/email_compose_message.py
index 576a1181d4e..dacddb45752 100644
--- a/addons/crm/wizard/email_compose_message.py
+++ b/addons/crm/wizard/email_compose_message.py
@@ -31,6 +31,13 @@ class email_compose_message(osv.osv_memory):
     _inherit = 'email.compose.message'
 
     def get_value(self, cr, uid, model, resource_id, context=None):
+        '''
+        To get values of the resource_id for the model
+        @param model: Object
+        @param resource_id: id of a record for which values to be read
+
+        @return: Returns a dictionary
+        '''
         if context is None:
             context = {}
         result = super(email_compose_message, self).get_value(cr, uid,  model, resource_id, context=context)
@@ -43,8 +50,8 @@ class email_compose_message(osv.osv_memory):
                     'email_from' : data.user_id and data.user_id.address_id and data.user_id.address_id.email or tools.config.get('email_from', False),
                     'body' : '\n' + (tools.ustr(data.user_id.signature or '')),
                     'email_cc' : tools.ustr(data.email_cc or ''),
-                    'model': model  or False,
-                    'res_id': resource_id  or False,
+                    'model': model,
+                    'res_id': resource_id,
                 })
             if hasattr(data, 'section_id'):
                 result.update({'reply_to' : data.section_id and data.section_id.reply_to or False})
diff --git a/addons/crm_helpdesk/wizard/email_compose_message.py b/addons/crm_helpdesk/wizard/email_compose_message.py
index 0b04ca0b31c..95961912a6d 100644
--- a/addons/crm_helpdesk/wizard/email_compose_message.py
+++ b/addons/crm_helpdesk/wizard/email_compose_message.py
@@ -27,6 +27,13 @@ class email_compose_message(osv.osv_memory):
     _inherit = 'email.compose.message'
 
     def get_value(self, cr, uid, model, resource_id, context=None):
+        '''
+        To get values of the resource_id for the model
+        @param model: Object
+        @param resource_id: id of a record for which values to be read
+
+        @return: Returns a dictionary
+        '''
         if context is None:
             context = {}
         result = super(email_compose_message, self).get_value(cr, uid,  model, resource_id, context=context)
@@ -39,8 +46,8 @@ class email_compose_message(osv.osv_memory):
                     'email_from' : data.user_id and data.user_id.address_id and data.user_id.address_id.email or False,
                     'body' : '\n' + (tools.ustr(data.user_id.signature or '')),
                     'email_cc' : tools.ustr(data.email_cc or ''),
-                    'model': model  or False,
-                    'res_id': resource_id  or False,
+                    'model': model,
+                    'res_id': resource_id,
                 })
         return result
 
diff --git a/addons/event/wizard/email_compose_message.py b/addons/event/wizard/email_compose_message.py
index 8d949255a3f..94cd650c3f5 100644
--- a/addons/event/wizard/email_compose_message.py
+++ b/addons/event/wizard/email_compose_message.py
@@ -27,6 +27,13 @@ class email_compose_message(osv.osv_memory):
     _inherit = 'email.compose.message'
 
     def get_value(self, cr, uid, model, resource_id, context=None):
+        '''
+        To get values of the resource_id for the model
+        @param model: Object
+        @param resource_id: id of a record for which values to be read
+
+        @return: Returns a dictionary
+        '''
         if context is None:
             context = {}
         result = super(email_compose_message, self).get_value(cr, uid,  model, resource_id, context=context)
@@ -39,8 +46,8 @@ class email_compose_message(osv.osv_memory):
                     'email_from' : data.user_id and data.user_id.address_id and data.user_id.address_id.email or False,
                     'body' : '\n' + (tools.ustr(data.user_id.signature or '')),
                     'email_cc' : tools.ustr(data.email_cc or ''),
-                    'model': model  or False,
-                    'res_id': resource_id  or False,
+                    'model': model,
+                    'res_id': resource_id,
                 })
         return result
 
diff --git a/addons/hr_evaluation/wizard/email_compose_message.py b/addons/hr_evaluation/wizard/email_compose_message.py
index b5c5b9b49dc..c8e055928f6 100644
--- a/addons/hr_evaluation/wizard/email_compose_message.py
+++ b/addons/hr_evaluation/wizard/email_compose_message.py
@@ -28,6 +28,13 @@ class email_compose_message(osv.osv_memory):
     _inherit = 'email.compose.message'
 
     def get_value(self, cr, uid, model, resource_id, context=None):
+        '''
+        To get values of the resource_id for the model
+        @param model: Object
+        @param resource_id: id of a record for which values to be read
+
+        @return: Returns a dictionary
+        '''
         if context is None:
             context = {}
         result = super(email_compose_message, self).get_value(cr, uid,  model, resource_id, context=context)
@@ -42,6 +49,7 @@ class email_compose_message(osv.osv_memory):
                         'subject': _("Reminder to fill up Survey"),
                         'body': msg,
                         'res_id': resource_id,
+                        'model': model,
                         'email_cc': False,
                         'email_bcc': False,
                         'reply_to': False,
diff --git a/addons/hr_recruitment/wizard/email_compose_message.py b/addons/hr_recruitment/wizard/email_compose_message.py
index 9320badb28b..f5cc4883ef3 100644
--- a/addons/hr_recruitment/wizard/email_compose_message.py
+++ b/addons/hr_recruitment/wizard/email_compose_message.py
@@ -28,6 +28,13 @@ class email_compose_message(osv.osv_memory):
     _inherit = 'email.compose.message'
 
     def get_value(self, cr, uid, model, resource_id, context=None):
+        '''
+        To get values of the resource_id for the model
+        @param model: Object
+        @param resource_id: id of a record for which values to be read
+
+        @return: Returns a dictionary
+        '''
         if context is None:
             context = {}
         result = super(email_compose_message, self).get_value(cr, uid,  model, resource_id, context=context)
@@ -40,8 +47,8 @@ class email_compose_message(osv.osv_memory):
                     'email_from' : data.user_id and data.user_id.address_id and data.user_id.address_id.email or False,
                     'body' : '\n' + (tools.ustr(data.user_id.signature or '')),
                     'email_cc' : tools.ustr(data.email_cc or ''),
-                    'model': model  or False,
-                    'res_id': resource_id  or False,
+                    'model': model,
+                    'res_id': resource_id,
                 })
         return result
 
diff --git a/addons/mail/wizard/email_compose_message.py b/addons/mail/wizard/email_compose_message.py
index 3d83848f0ab..a5c77104c37 100644
--- a/addons/mail/wizard/email_compose_message.py
+++ b/addons/mail/wizard/email_compose_message.py
@@ -29,6 +29,13 @@ class email_compose_message(osv.osv_memory):
     _description = 'This is the wizard for Compose E-mail'
 
     def default_get(self, cr, uid, fields, context=None):
+        """
+        Returns default values for fields
+        @param fields: list of fields, for which default values are required to be read
+        @param context: context arguments, like lang, time zone
+
+        @return: Returns a dictionary that contains default values for fields
+        """
         if context is None:
             context = {}
         result = super(email_compose_message, self).default_get(cr, uid, fields, context=context)
@@ -108,6 +115,10 @@ class email_compose_message(osv.osv_memory):
         return {}
 
     def get_message_data(self, cr, uid, message_id, context=None):
+        '''
+        Called by default_get() to get message detail
+        @param message_id: Id of the email message
+        '''
         if context is None:
             context = {}
         result = {}
@@ -116,7 +127,6 @@ class email_compose_message(osv.osv_memory):
             message_data = message_pool.browse(cr, uid, message_id, context)
             subject = tools.ustr(message_data and message_data.subject or '')
             description =  message_data and message_data.body  or ''
-            message_body = False
             if context.get('mail','') == 'reply':
                 header = '-------- Original Message --------'
                 sender = 'From: %s'  % tools.ustr(message_data.email_from or '')
@@ -150,6 +160,9 @@ class email_compose_message(osv.osv_memory):
         return result
 
     def send_mail(self, cr, uid, ids, context=None):
+        '''
+        Sends the email
+        '''
         if context is None:
             context = {}
 
@@ -210,7 +223,6 @@ class email_compose_message(osv.osv_memory):
     def get_template_value(self, cr, uid, message, model, resource_id, context=None):
         return message
 
-
 email_compose_message()
 
 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4:
diff --git a/addons/project/wizard/email_compose_message.py b/addons/project/wizard/email_compose_message.py
index eb52604749e..921cbf1b081 100644
--- a/addons/project/wizard/email_compose_message.py
+++ b/addons/project/wizard/email_compose_message.py
@@ -27,6 +27,13 @@ class email_compose_message(osv.osv_memory):
     _inherit = 'email.compose.message'
 
     def get_value(self, cr, uid, model, resource_id, context=None):
+        '''
+        To get values of the resource_id for the model
+        @param model: Object
+        @param resource_id: id of a record for which values to be read
+
+        @return: Returns a dictionary
+        '''
         if context is None:
             context = {}
         result = super(email_compose_message, self).get_value(cr, uid,  model, resource_id, context=context)
diff --git a/addons/project_issue/wizard/email_compose_message.py b/addons/project_issue/wizard/email_compose_message.py
index 655f04ad72a..df1133245d2 100644
--- a/addons/project_issue/wizard/email_compose_message.py
+++ b/addons/project_issue/wizard/email_compose_message.py
@@ -27,6 +27,13 @@ class email_compose_message(osv.osv_memory):
     _inherit = 'email.compose.message'
 
     def get_value(self, cr, uid, model, resource_id, context=None):
+        '''
+        To get values of the resource_id for the model
+        @param model: Object
+        @param resource_id: id of a record for which values to be read
+
+        @return: Returns a dictionary
+        '''
         if context is None:
             context = {}
         result = super(email_compose_message, self).get_value(cr, uid,  model, resource_id, context=context)
@@ -39,8 +46,8 @@ class email_compose_message(osv.osv_memory):
                     'email_from' : data.user_id and data.user_id.address_id and data.user_id.address_id.email or False,
                     'body' : '\n' + (tools.ustr(data.user_id.signature or '')),
                     'email_cc' : tools.ustr(data.email_cc or ''),
-                    'model': model  or False,
-                    'res_id': resource_id  or False,
+                    'model': model,
+                    'res_id': resource_id,
                 })
         return result
 
diff --git a/addons/project_planning/wizard/email_compose_message.py b/addons/project_planning/wizard/email_compose_message.py
index ed7ffdd0eb9..6fd89bea634 100644
--- a/addons/project_planning/wizard/email_compose_message.py
+++ b/addons/project_planning/wizard/email_compose_message.py
@@ -27,6 +27,13 @@ class email_compose_message(osv.osv_memory):
     _inherit = 'email.compose.message'
 
     def get_value(self, cr, uid, model, resource_id, context=None):
+        '''
+        To get values of the resource_id for the model
+        @param model: Object
+        @param resource_id: id of a record for which values to be read
+
+        @return: Returns a dictionary
+        '''
         if context is None:
             context = {}
         result = super(email_compose_message, self).get_value(cr, uid,  model, resource_id, context=context)
@@ -38,8 +45,8 @@ class email_compose_message(osv.osv_memory):
                     'email_to' : data.user_id.user_email or False,
                     'email_from' : data.user_id and data.user_id.address_id and data.user_id.address_id.email or False,
                     'body' : '\n' + (tools.ustr(data.user_id.signature or '')),
-                    'model': model  or False,
-                    'res_id': resource_id  or False,
+                    'model': model,
+                    'res_id': resource_id,
                 })
         return result
 
diff --git a/addons/project_scrum/wizard/email_compose_message.py b/addons/project_scrum/wizard/email_compose_message.py
index 12e7edb4e27..0eee41ae894 100644
--- a/addons/project_scrum/wizard/email_compose_message.py
+++ b/addons/project_scrum/wizard/email_compose_message.py
@@ -27,6 +27,13 @@ class email_compose_message(osv.osv_memory):
     _inherit = 'email.compose.message'
 
     def get_value(self, cr, uid, model, resource_id, context=None):
+        '''
+        To get values of the resource_id for the model
+        @param model: Object
+        @param resource_id: id of a record for which values to be read
+
+        @return: Returns a dictionary
+        '''
         if context is None:
             context = {}
         result = super(email_compose_message, self).get_value(cr, uid,  model, resource_id, context=context)