sale_timesheet/models/sale_order.py

356 lines
18 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
# Part of Odoo. See LICENSE file for full copyright and licensing details.
import math
from collections import defaultdict
from odoo import api, fields, models, _
from odoo.osv import expression
from odoo.tools import float_compare
class SaleOrder(models.Model):
_inherit = 'sale.order'
timesheet_count = fields.Float(string='Timesheet activities', compute='_compute_timesheet_count', groups="hr_timesheet.group_hr_timesheet_user")
# override domain
project_id = fields.Many2one(domain="[('pricing_type', '!=', 'employee_rate'), ('analytic_account_id', '!=', False), ('company_id', '=', company_id)]")
timesheet_encode_uom_id = fields.Many2one('uom.uom', related='company_id.timesheet_encode_uom_id')
timesheet_total_duration = fields.Integer("Timesheet Total Duration", compute='_compute_timesheet_total_duration',
help="Total recorded duration, expressed in the encoding UoM, and rounded to the unit", compute_sudo=True,
groups="hr_timesheet.group_hr_timesheet_user")
show_hours_recorded_button = fields.Boolean(compute="_compute_show_hours_recorded_button", groups="hr_timesheet.group_hr_timesheet_user")
def _compute_timesheet_count(self):
timesheets_per_so = {
order.id: count
for order, count in self.env['account.analytic.line']._read_group(
[('order_id', 'in', self.ids), ('project_id', '!=', False)],
['order_id'],
['__count'],
)
}
for order in self:
order.timesheet_count = timesheets_per_so.get(order.id, 0)
@api.depends('company_id.project_time_mode_id', 'company_id.timesheet_encode_uom_id', 'order_line.timesheet_ids')
def _compute_timesheet_total_duration(self):
group_data = self.env['account.analytic.line']._read_group([
('order_id', 'in', self.ids), ('project_id', '!=', False)
], ['order_id'], ['unit_amount:sum'])
timesheet_unit_amount_dict = defaultdict(float)
timesheet_unit_amount_dict.update({order.id: unit_amount for order, unit_amount in group_data})
for sale_order in self:
total_time = sale_order.company_id.project_time_mode_id._compute_quantity(timesheet_unit_amount_dict[sale_order.id], sale_order.timesheet_encode_uom_id)
sale_order.timesheet_total_duration = round(total_time)
def _compute_field_value(self, field):
if field.name != 'invoice_status' or self.env.context.get('mail_activity_automation_skip'):
return super()._compute_field_value(field)
# Get SOs which their state is not equal to upselling and if at least a SOL has warning prepaid service upsell set to True and the warning has not already been displayed
upsellable_orders = self.filtered(lambda so:
so.state == 'sale'
and so.invoice_status != 'upselling'
and so.id
and (so.user_id or so.partner_id.user_id) # salesperson needed to assign upsell activity
)
super(SaleOrder, upsellable_orders.with_context(mail_activity_automation_skip=True))._compute_field_value(field)
for order in upsellable_orders:
upsellable_lines = order._get_prepaid_service_lines_to_upsell()
if upsellable_lines:
order._create_upsell_activity()
# We want to display only one time the warning for each SOL
upsellable_lines.write({'has_displayed_warning_upsell': True})
super(SaleOrder, self - upsellable_orders)._compute_field_value(field)
def _compute_show_hours_recorded_button(self):
show_button_ids = self._get_order_with_valid_service_product()
for order in self:
order.show_hours_recorded_button = order.timesheet_count or order.project_count and order.id in show_button_ids
def _get_order_with_valid_service_product(self):
return self.env['sale.order.line']._read_group([
('order_id', 'in', self.ids),
('state', '=', 'sale'),
('is_service', '=', True),
'|',
('product_id.service_type', 'not in', ['milestones', 'manual']),
('product_id.invoice_policy', '!=', 'delivery'),
], aggregates=['order_id:array_agg'])[0][0]
def _get_prepaid_service_lines_to_upsell(self):
""" Retrieve all sols which need to display an upsell activity warning in the SO
These SOLs should contain a product which has:
- type="service",
- service_policy="ordered_prepaid",
"""
self.ensure_one()
precision = self.env['decimal.precision'].precision_get('Product Unit of Measure')
return self.order_line.filtered(lambda sol:
sol.is_service
and not sol.has_displayed_warning_upsell # we don't want to display many times the warning each time we timesheet on the SOL
and sol.product_id.service_policy == 'ordered_prepaid'
and float_compare(
sol.qty_delivered,
sol.product_uom_qty * (sol.product_id.service_upsell_threshold or 1.0),
precision_digits=precision
) > 0
)
def action_view_timesheet(self):
self.ensure_one()
if not self.order_line:
return {'type': 'ir.actions.act_window_close'}
action = self.env["ir.actions.actions"]._for_xml_id("sale_timesheet.timesheet_action_from_sales_order")
default_sale_line = next((sale_line for sale_line in self.order_line if sale_line.is_service and sale_line.product_id.service_policy in ['ordered_prepaid', 'delivered_timesheet']), self.env['sale.order.line'])
context = {
'search_default_billable_timesheet': True,
'default_is_so_line_edited': True,
'default_so_line': default_sale_line.id,
} # erase default filters
tasks = self.order_line.task_id._filter_access_rules_python('write')
if tasks:
context['default_task_id'] = tasks[0].id
else:
projects = self.order_line.project_id._filter_access_rules_python('write')
if projects:
context['default_project_id'] = projects[0].id
elif self.project_ids:
context['default_project_id'] = self.project_ids[0].id
action.update({
'context': context,
'domain': [('so_line', 'in', self.order_line.ids), ('project_id', '!=', False)],
'help': _("""
<p class="o_view_nocontent_smiling_face">
No activities found. Let's start a new one!
</p><p>
Track your working hours by projects every day and invoice this time to your customers.
</p>
""")
})
return action
def _create_invoices(self, grouped=False, final=False, date=None):
"""Link timesheets to the created invoices. Date interval is injected in the
context in sale_make_invoice_advance_inv wizard.
"""
moves = super()._create_invoices(grouped=grouped, final=final, date=date)
moves._link_timesheets_to_invoice(self.env.context.get("timesheet_start_date"), self.env.context.get("timesheet_end_date"))
return moves
class SaleOrderLine(models.Model):
_inherit = "sale.order.line"
qty_delivered_method = fields.Selection(selection_add=[('timesheet', 'Timesheets')])
analytic_line_ids = fields.One2many(domain=[('project_id', '=', False)]) # only analytic lines, not timesheets (since this field determine if SO line came from expense)
remaining_hours_available = fields.Boolean(compute='_compute_remaining_hours_available', compute_sudo=True)
remaining_hours = fields.Float('Remaining Hours on SO', compute='_compute_remaining_hours', compute_sudo=True, store=True)
has_displayed_warning_upsell = fields.Boolean('Has Displayed Warning Upsell', copy=False)
timesheet_ids = fields.One2many('account.analytic.line', 'so_line', domain=[('project_id', '!=', False)], string='Timesheets')
@api.depends('remaining_hours_available', 'remaining_hours')
@api.depends_context('with_remaining_hours', 'company')
def _compute_display_name(self):
super()._compute_display_name()
with_remaining_hours = self.env.context.get('with_remaining_hours')
if with_remaining_hours and any(line.remaining_hours_available for line in self):
company = self.env.company
encoding_uom = company.timesheet_encode_uom_id
is_hour = is_day = False
unit_label = ''
if encoding_uom == self.env.ref('uom.product_uom_hour'):
is_hour = True
unit_label = _('remaining')
elif encoding_uom == self.env.ref('uom.product_uom_day'):
is_day = True
unit_label = _('days remaining')
for line in self:
if line.remaining_hours_available:
remaining_time = ''
if is_hour:
hours, minutes = divmod(abs(line.remaining_hours) * 60, 60)
round_minutes = minutes / 30
minutes = math.ceil(round_minutes) if line.remaining_hours >= 0 else math.floor(round_minutes)
if minutes > 1:
minutes = 0
hours += 1
else:
minutes = minutes * 30
remaining_time = ' ({sign}{hours:02.0f}:{minutes:02.0f} {remaining})'.format(
sign='-' if line.remaining_hours < 0 else '',
hours=hours,
minutes=minutes,
remaining=unit_label)
elif is_day:
remaining_days = company.project_time_mode_id._compute_quantity(line.remaining_hours, encoding_uom, round=False)
remaining_time = ' ({qty:.02f} {unit})'.format(
qty=remaining_days,
unit=unit_label
)
name = '{name}{remaining_time}'.format(
name=line.display_name,
remaining_time=remaining_time
)
line.display_name = name
@api.depends('product_id.service_policy')
def _compute_remaining_hours_available(self):
uom_hour = self.env.ref('uom.product_uom_hour')
for line in self:
is_ordered_prepaid = line.product_id.service_policy == 'ordered_prepaid'
is_time_product = line.product_uom.category_id == uom_hour.category_id
line.remaining_hours_available = is_ordered_prepaid and is_time_product
@api.depends('qty_delivered', 'product_uom_qty', 'analytic_line_ids')
def _compute_remaining_hours(self):
uom_hour = self.env.ref('uom.product_uom_hour')
for line in self:
remaining_hours = None
if line.remaining_hours_available:
qty_left = line.product_uom_qty - line.qty_delivered
remaining_hours = line.product_uom._compute_quantity(qty_left, uom_hour)
line.remaining_hours = remaining_hours
@api.depends('product_id')
def _compute_qty_delivered_method(self):
""" Sale Timesheet module compute delivered qty for product [('type', 'in', ['service']), ('service_type', '=', 'timesheet')] """
super(SaleOrderLine, self)._compute_qty_delivered_method()
for line in self:
if not line.is_expense and line.product_id.type == 'service' and line.product_id.service_type == 'timesheet':
line.qty_delivered_method = 'timesheet'
@api.depends('analytic_line_ids.project_id', 'project_id.pricing_type')
def _compute_qty_delivered(self):
super(SaleOrderLine, self)._compute_qty_delivered()
lines_by_timesheet = self.filtered(lambda sol: sol.qty_delivered_method == 'timesheet')
domain = lines_by_timesheet._timesheet_compute_delivered_quantity_domain()
mapping = lines_by_timesheet.sudo()._get_delivered_quantity_by_analytic(domain)
for line in lines_by_timesheet:
line.qty_delivered = mapping.get(line.id or line._origin.id, 0.0)
def _timesheet_compute_delivered_quantity_domain(self):
""" Hook for validated timesheet in addionnal module """
domain = [('project_id', '!=', False)]
if self._context.get('accrual_entry_date'):
domain += [('date', '<=', self._context['accrual_entry_date'])]
return domain
###########################################
# Service : Project and task generation
###########################################
def _convert_qty_company_hours(self, dest_company):
company_time_uom_id = dest_company.project_time_mode_id
allocated_hours = 0.0
product_uom = self.product_uom
if product_uom == self.env.ref('uom.product_uom_unit'):
product_uom = self.env.ref('uom.product_uom_hour')
if product_uom.category_id == company_time_uom_id.category_id:
if product_uom != company_time_uom_id:
allocated_hours = product_uom._compute_quantity(self.product_uom_qty, company_time_uom_id)
else:
allocated_hours = self.product_uom_qty
return allocated_hours
def _timesheet_create_project(self):
project = super()._timesheet_create_project()
project_uom = self.company_id.project_time_mode_id
uom_unit = self.env.ref('uom.product_uom_unit')
uom_hour = self.env.ref('uom.product_uom_hour')
# dict of inverse factors for each relevant UoM found in SO
factor_inv_per_id = {
uom.id: uom.factor_inv
for uom in self.order_id.order_line.product_uom
if uom.category_id == project_uom.category_id
}
# if sold as units, assume hours for time allocation
factor_inv_per_id[uom_unit.id] = uom_hour.factor_inv
allocated_hours = 0.0
# method only called once per project, so also allocate hours for
# all lines in SO that will share the same project
for line in self.order_id.order_line:
if line.is_service \
and line.product_id.service_tracking in ['task_in_project', 'project_only'] \
and line.product_id.project_template_id == self.product_id.project_template_id \
and line.product_uom.id in factor_inv_per_id:
uom_factor = project_uom.factor * factor_inv_per_id[line.product_uom.id]
allocated_hours += line.product_uom_qty * uom_factor
project.write({
'allocated_hours': allocated_hours,
'allow_timesheets': True,
})
return project
def _timesheet_create_project_prepare_values(self):
"""Generate project values"""
values = super()._timesheet_create_project_prepare_values()
values['allow_billable'] = True
return values
def _recompute_qty_to_invoice(self, start_date, end_date):
""" Recompute the qty_to_invoice field for product containing timesheets
Search the existed timesheets between the given period in parameter.
Retrieve the unit_amount of this timesheet and then recompute
the qty_to_invoice for each current product.
:param start_date: the start date of the period
:param end_date: the end date of the period
"""
lines_by_timesheet = self.filtered(lambda sol: sol.product_id and sol.product_id._is_delivered_timesheet())
domain = lines_by_timesheet._timesheet_compute_delivered_quantity_domain()
refund_account_moves = self.order_id.invoice_ids.filtered(lambda am: am.state == 'posted' and am.move_type == 'out_refund').reversed_entry_id
timesheet_domain = [
'|',
('timesheet_invoice_id', '=', False),
('timesheet_invoice_id.state', '=', 'cancel')]
if refund_account_moves:
credited_timesheet_domain = [('timesheet_invoice_id.state', '=', 'posted'), ('timesheet_invoice_id', 'in', refund_account_moves.ids)]
timesheet_domain = expression.OR([timesheet_domain, credited_timesheet_domain])
domain = expression.AND([domain, timesheet_domain])
if start_date:
domain = expression.AND([domain, [('date', '>=', start_date)]])
if end_date:
domain = expression.AND([domain, [('date', '<=', end_date)]])
mapping = lines_by_timesheet.sudo()._get_delivered_quantity_by_analytic(domain)
for line in lines_by_timesheet:
qty_to_invoice = mapping.get(line.id, 0.0)
if qty_to_invoice:
line.qty_to_invoice = qty_to_invoice
else:
prev_inv_status = line.invoice_status
line.qty_to_invoice = qty_to_invoice
line.invoice_status = prev_inv_status
def _get_action_per_item(self):
""" Get action per Sales Order Item
When the Sales Order Item contains a service product then the action will be View Timesheets.
:returns: Dict containing id of SOL as key and the action as value
"""
action_per_sol = super()._get_action_per_item()
timesheet_action = self.env.ref('sale_timesheet.timesheet_action_from_sales_order_item').id
timesheet_ids_per_sol = {}
if self.user_has_groups('hr_timesheet.group_hr_timesheet_user'):
timesheet_read_group = self.env['account.analytic.line']._read_group([('so_line', 'in', self.ids), ('project_id', '!=', False)], ['so_line'], ['id:array_agg'])
timesheet_ids_per_sol = {so_line.id: ids for so_line, ids in timesheet_read_group}
for sol in self:
timesheet_ids = timesheet_ids_per_sol.get(sol.id, [])
if sol.is_service and len(timesheet_ids) > 0:
action_per_sol[sol.id] = timesheet_action, timesheet_ids[0] if len(timesheet_ids) == 1 else False
return action_per_sol