[IMP] project,*: added project templates mechanism

* = hr_timesheet, sale_project, project_purchase, project_mrp, project_stock,
sale_timesheet, website_project, analytic, project_timesheet_holidays

In this PR we add Project templates which will contribute towards template
system in the Project app. Reusable project templates to work.

task-4700744

Author: kthe-odoo

addons/hr_timesheet/models/hr_timesheet.py

@@ -45,7 +45,7 @@ def default_get(self, field_list):
         return result
 
     def _domain_project_id(self):
-        domain = [('allow_timesheets', '=', True)]
+        domain = [('allow_timesheets', '=', True), ('is_template', '=', False)]
         if not self.env.user.has_group('hr_timesheet.group_timesheet_manager'):
             return expression.AND([domain,
                 ['|', ('privacy_visibility', '!=', 'followers'), ('message_partner_ids', 'in', [self.env.user.partner_id.id])]

addons/hr_timesheet/models/res_company.py

@@ -24,8 +24,10 @@ def _default_timesheet_encode_uom_id(self):
     timesheet_encode_uom_id = fields.Many2one('uom.uom', string="Timesheet Encoding Unit",
         default=_default_timesheet_encode_uom_id)
     internal_project_id = fields.Many2one(
-        'project.project', string="Internal Project",
-        help="Default project value for timesheet generated from time off type.")
+        "project.project", string="Internal Project",
+        domain=[("is_template", "=", False)],
+        help="Default project value for timesheet generated from time off type.",
+    )
 
     @api.constrains('internal_project_id')
     def _check_internal_project_id_company(self):

addons/hr_timesheet/views/project_project_views.xml

@@ -23,7 +23,7 @@
             <field name="arch" type="xml">
                 <xpath expr="//header" position="after">
                     <field name="analytic_account_active" invisible="1"/>
-                    <t name="timesheet_error" invisible="not allow_timesheets">
+                    <t name="timesheet_error" invisible="not allow_timesheets or is_template">
                         <div class="alert alert-warning mb-1 text-center" role="alert" colspan="2" invisible="not account_id or analytic_account_active">
                             You cannot log timesheets on this project since it is linked to an inactive analytic account.<br/>
                             Please switch to another account, or reactivate the current one to timesheet on the project.
@@ -77,7 +77,7 @@
                     <field name="allocated_hours"/>
                 </xpath>
                 <xpath expr="//div[@name='card_menu_view']" position="inside">
-                    <div role="menuitem" t-if="record.allow_timesheets.raw_value" groups="hr_timesheet.group_hr_timesheet_user">
+                    <div role="menuitem" t-if="record.allow_timesheets.raw_value and !record.is_template.raw_value" groups="hr_timesheet.group_hr_timesheet_user">
                         <a name="action_project_timesheets" type="object">Timesheets</a>
                     </div>
                 </xpath>
@@ -100,17 +100,17 @@
             <field name="inherit_id" ref="project.view_project_project_filter"/>
             <field name="arch" type="xml">
                 <filter name="late_milestones" position="before">
-                    <filter string="Timesheets &gt;100%" name="projects_in_overtime" domain="[('is_project_overtime', '=', True)]" groups="project.group_project_manager"/>
+                    <filter string="Timesheets &gt;100%" name="projects_in_overtime" domain="[('is_project_overtime', '=', True)]" groups="project.group_project_manager" invisible="context.get('default_is_template')"/>
                 </filter>
             </field>
         </record>
 
         <record id="project.open_view_project_all" model="ir.actions.act_window">
-            <field name="domain">[('is_internal_project', '=', False)]</field>
+            <field name="domain">[('is_internal_project', '=', False), ("is_template", "=", False)]</field>
         </record>
 
         <record id="project.open_view_project_all_group_stage" model="ir.actions.act_window">
-            <field name="domain">[('is_internal_project', '=', False)]</field>
+            <field name="domain">[('is_internal_project', '=', False), ("is_template", "=", False)]</field>
         </record>
     </data>
 </odoo>

addons/hr_timesheet/views/project_task_views.xml

@@ -28,7 +28,7 @@
                     </div>
                 </xpath>
                 <xpath expr="//t[@name='warning_section']" position="inside">
-                    <div class="alert alert-warning text-center mb-2" role="alert" invisible="analytic_account_active or not allow_timesheets" groups="hr_timesheet.group_hr_timesheet_user">
+                    <div class="alert alert-warning text-center mb-2" role="alert" invisible="analytic_account_active or not allow_timesheets or is_template" groups="hr_timesheet.group_hr_timesheet_user">
                         You cannot log timesheets on this project since it is linked to an inactive analytic account.<br/> Please change this account, or reactivate the current one to timesheet on the project.
                     </div>
                 </xpath>

addons/project/__manifest__.py

@@ -54,6 +54,7 @@
         'data/project_tour.xml',
         'wizard/project_task_type_delete_views.xml',
         'wizard/project_project_stage_delete_views.xml',
+        'wizard/project_template_create_wizard.xml',
         'views/project_menus.xml',
     ],
     'demo': [

addons/project/controllers/portal.py

@@ -59,7 +59,7 @@ def _project_get_page_view_values(self, project, access_token, page=1, date_begi
         return self._get_page_view_values(project, access_token, values, 'my_projects_history', False, **kwargs)
 
     def _prepare_project_domain(self):
-        return []
+        return [('is_template', '=', False)]
 
     def _prepare_searchbar_sortings(self):
         return {
@@ -112,6 +112,8 @@ def portal_my_projects(self, page=1, date_begin=None, date_end=None, sortby=None
     def portal_my_project(self, project_id=None, access_token=None, page=1, date_begin=None, date_end=None, sortby=None, search=None, search_in='content', groupby=None, task_id=None, **kw):
         try:
             project_sudo = self._document_check_access('project.project', project_id, access_token)
+            if project_sudo.is_template:
+                return request.redirect('/my')
         except (AccessError, MissingError):
             return request.redirect('/my')
         if project_sudo.collaborator_count and project_sudo.with_user(request.env.user)._check_project_sharing_access():

addons/project/models/project_collaborator.py

@@ -7,7 +7,7 @@ class ProjectCollaborator(models.Model):
     _name = 'project.collaborator'
     _description = 'Collaborators in project shared'
 
-    project_id = fields.Many2one('project.project', 'Project Shared', domain=[('privacy_visibility', '=', 'portal')], required=True, readonly=True, export_string_translation=False, index=True)
+    project_id = fields.Many2one('project.project', 'Project Shared', domain=[('privacy_visibility', '=', 'portal'), ('is_template', '=', False)], required=True, readonly=True, export_string_translation=False, index=True)
     partner_id = fields.Many2one('res.partner', 'Collaborator', required=True, readonly=True, export_string_translation=False)
     partner_email = fields.Char(related='partner_id.email', export_string_translation=False)
     limited_access = fields.Boolean('Limited Access', default=False, export_string_translation=False)

addons/project/models/project_milestone.py

@@ -20,7 +20,7 @@ def _get_default_project_id(self):
 
     name = fields.Char(required=True)
     sequence = fields.Integer('Sequence', default=10)
-    project_id = fields.Many2one('project.project', required=True, default=_get_default_project_id, index=True, ondelete='cascade')
+    project_id = fields.Many2one('project.project', required=True, default=_get_default_project_id, domain=[('is_template', '=', False)], index=True, ondelete='cascade')
     deadline = fields.Date(tracking=True, copy=False)
     is_reached = fields.Boolean(string="Reached", default=False, copy=False)
     reached_date = fields.Date(compute='_compute_reached_date', store=True, export_string_translation=False)

addons/project/models/project_project.py

@@ -194,6 +194,7 @@ def _set_favorite_user_ids(self, is_favorite):
     next_milestone_id = fields.Many2one('project.milestone', compute='_compute_next_milestone_id', groups="project.group_project_milestone", export_string_translation=False)
     can_mark_milestone_as_done = fields.Boolean(compute='_compute_next_milestone_id', groups="project.group_project_milestone", export_string_translation=False)
     is_milestone_deadline_exceeded = fields.Boolean(compute='_compute_next_milestone_id', groups="project.group_project_milestone", export_string_translation=False)
+    is_template = fields.Boolean(copy=False, export_string_translation=False)
 
     _project_date_greater = models.Constraint(
         'check(date >= date_start)',
@@ -472,7 +473,17 @@ def copy_data(self, default=None):
         vals_list = super().copy_data(default=default)
         if default and 'name' in default:
             return vals_list
-        return [dict(vals, name=self.env._("%s (copy)", project.name)) for project, vals in zip(self, vals_list)]
+        copy_from_template = self.env.context.get('copy_from_template')
+        for project, vals in zip(self, vals_list):
+            if project.is_template and not copy_from_template:
+                vals['is_template'] = True
+            if copy_from_template:
+                # We can make last_update_status as None because it is a required field
+                vals.pop("last_update_status", None)
+                for field in set(self._get_template_field_blacklist()) & set(vals.keys()):
+                    del vals[field]
+            vals["name"] = project.name if copy_from_template or vals.get("is_template") else self.env._("%s (copy)", project.name)
+        return vals_list
 
     def copy(self, default=None):
         default = dict(default or {})
@@ -807,9 +818,15 @@ def action_view_tasks(self):
         context = ast.literal_eval(context)
         context.update({
             'create': self.active,
-            'active_test': self.active
+            'active_test': self.active,
+            'active_id': self.id,
             })
         action['context'] = context
+        if self.is_template:
+            action['context'].update({'default_is_template': True})
+            domain = ast.literal_eval(action['domain'].replace('active_id', str(self.id)))
+            domain.remove(('has_template_ancestor', '=', False))
+            action['domain'] = domain
         return action
 
     def action_view_all_rating(self):
@@ -1140,3 +1157,130 @@ def _thread_to_store(self, store: Store, fields, *, request_list=None):
     def _compute_task_completion_percentage(self):
         for task in self:
             task.task_completion_percentage = task.task_count and 1 - task.open_task_count / task.task_count
+
+    # ---------------------------------------------------
+    #  Project Template Methods
+    # ---------------------------------------------------
+
+    def _get_project_to_template_warnings(self):
+        self.ensure_one()
+        warnings = []
+        if self.collaborator_ids:
+            warnings.append(self.env._("This project has collaborators linked to it."))
+        if self.account_id:
+            warnings.append(self.env._("This project is linked to an analytic plan."))
+        return warnings
+
+    def _get_template_to_project_warnings(self):
+        self.ensure_one()
+        return []
+
+    def _get_template_notification_action(self, tag, params):
+        return {
+            'type': 'ir.actions.client',
+            'tag': tag,
+            'params': params,
+        }
+
+    def action_convert_project_to_template(self):
+        self.ensure_one()
+        if self.is_template:
+            return self._get_template_notification_action(
+                "project_template_show_undo_confirmation_dialog",
+                {
+                    "project_id": self.id,
+                    "message": self._get_template_to_project_warnings(),
+                },
+            )
+        linked_warning = self._get_project_to_template_warnings()
+        if linked_warning:
+            return self._get_template_notification_action(
+                "project_template_create_show_confirmation",
+                {
+                    "project_id": self.id,
+                    "next": {
+                        "type": "ir.actions.client",
+                        "tag": "soft_reload",
+                    },
+                    "message": linked_warning,
+                },
+            )
+        return self._convert_project_to_template()
+
+    def create_template_from_project(self):
+        self.ensure_one()
+        template = self.copy(default={"is_template": True})
+        template._toggle_template_mode(True)
+        template.message_post(body=self.env._("Template created from %s.", self.name))
+        return template._get_template_notification_action(
+            "project_template_show_notification",
+            {
+                "project_id": template.id,
+                "undo_method": "unlink",
+            },
+        )
+
+    def _convert_project_to_template(self):
+        self.ensure_one()
+        self.collaborator_ids.unlink()
+        self._toggle_template_mode(True)
+        self.message_post(body=self.env._("Project converted to template."))
+        return self._get_template_notification_action(
+            "project_template_show_notification",
+            {
+                "project_id": self.id,
+                "next": {
+                    "type": "ir.actions.client",
+                    "tag": "soft_reload",
+                },
+            },
+        )
+
+    def action_undo_convert_to_template(self):
+        self.ensure_one()
+        self._toggle_template_mode(False)
+        self.message_post(body=self.env._("Template converted back to regular project."))
+        return self._get_template_notification_action(
+            "display_notification",
+            {
+                "message": self.env._("Template converted back to regular project."),
+                "next": {
+                    "type": "ir.actions.client",
+                    "tag": "soft_reload",
+                },
+            },
+        )
+
+    def _toggle_template_mode(self, is_template):
+        self.ensure_one()
+        self.is_template = is_template
+        self.task_ids.write({"is_template": is_template})
+
+    @api.model
+    def _get_template_default_context_whitelist(self):
+        """
+        Whitelist of fields that can be set through the `default_` context keys when creating a project from a template.
+        """
+        return []
+
+    @api.model
+    def _get_template_field_blacklist(self):
+        """
+        Blacklist of fields to not copy when creating a project from a template.
+        """
+        return [
+            "partner_id",
+        ]
+
+    def action_create_from_template(self, values=None):
+        self.ensure_one()
+        values = values or {}
+        default = {
+            key.removeprefix('default_'): value
+            for key, value in self.env.context.items()
+            if key.startswith('default_') and key.removeprefix('default_') in self._get_template_default_context_whitelist()
+        } | values | {
+            field: False
+            for field in self._get_template_field_blacklist()
+        }
+        return self.with_context(copy_from_template=True).copy(default=default)

addons/project/models/project_task.py

@@ -179,7 +179,7 @@ def _read_group_personal_stage_type_ids(self, stages, domain):
         help="Date on which the state of your task has last been modified.\n"
             "Based on this information you can identify tasks that are stalling and get statistics on the time it usually takes to move tasks from one stage/state to another.")
 
-    project_id = fields.Many2one('project.project', string='Project', domain="['|', ('company_id', '=', False), ('company_id', '=?',  company_id)]",
+    project_id = fields.Many2one('project.project', string='Project', domain="['|', ('company_id', '=', False), ('company_id', '=?',  company_id), ('is_template', '=', False)]",
                                  compute="_compute_project_id", store=True, precompute=True, recursive=True, readonly=False, index=True, tracking=True, change_default=True, falsy_value_label=_lt("🔒 Private"))
     display_in_project = fields.Boolean(compute='_compute_display_in_project', store=True, export_string_translation=False)
     task_properties = fields.Properties('Properties', definition='project_id.task_properties_definition', copy=True)

addons/project/models/project_update.py

@@ -57,7 +57,7 @@ def default_get(self, fields):
     user_id = fields.Many2one('res.users', string='Author', required=True, default=lambda self: self.env.user)
     description = fields.Html()
     date = fields.Date(default=fields.Date.context_today, tracking=True)
-    project_id = fields.Many2one('project.project', required=True, index=True, export_string_translation=False)
+    project_id = fields.Many2one('project.project', required=True, domain=[('is_template', '=', False)], index=True, export_string_translation=False)
     name_cropped = fields.Char(compute="_compute_name_cropped", export_string_translation=False)
     task_count = fields.Integer("Task Count", readonly=True, export_string_translation=False)
     closed_task_count = fields.Integer("Closed Task Count", readonly=True, export_string_translation=False)

addons/project/report/project_report.py

@@ -139,12 +139,14 @@ def _from(self):
                           AND pm.is_reached = False
                           AND pm.deadline <= CAST(now() AS DATE)
                     LEFT JOIN task_dependencies_rel td ON td.depends_on_id = t.id
+                    LEFT JOIN project_project p ON p.id = t.project_id
         """
 
     def _where(self):
         return """
                 t.project_id IS NOT NULL
                 AND t.is_template IS NOT TRUE
+                AND p.is_template IS NOT TRUE
         """
 
     def init(self):

addons/project/security/ir.model.access.csv

@@ -46,3 +46,5 @@ access_project_share_collaborator_manager,project.share.collaborator.wizard.mana
 access_project_personal_stage,project.personal.stage.user,model_project_task_stage_personal,base.group_user,1,1,1,1
 access_mail_activity_plan_project_manager,mail.activity.plan.project.manager,mail.model_mail_activity_plan,project.group_project_manager,1,1,1,1
 access_mail_activity_plan_template_project_manager,mail.activity.plan.template.project.manager,mail.model_mail_activity_plan_template,project.group_project_manager,1,1,1,1
+access_project_template_create_wizard_user,project.template.create.wizard.user,project.model_project_template_create_wizard,project.group_project_user,1,1,0,0
+access_project_template_create_wizard_manager,project.template.create.wizard.manager,project.model_project_template_create_wizard,project.group_project_manager,1,1,1,1