OCA reporting engine fork for dev and update.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

230 lines
7.8 KiB

  1. # Copyright 2020 Creu Blanca
  2. # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
  3. from odoo import api, fields, models, _
  4. from odoo.exceptions import ValidationError
  5. class KpiDashboard(models.Model):
  6. _name = "kpi.dashboard"
  7. _description = "Dashboard"
  8. name = fields.Char(required=True)
  9. active = fields.Boolean(default=True,)
  10. item_ids = fields.One2many(
  11. "kpi.dashboard.item", inverse_name="dashboard_id", copy=True,
  12. )
  13. number_of_columns = fields.Integer(default=5, required=True)
  14. compute_on_fly_refresh = fields.Integer(
  15. default=0,
  16. help="Seconds to refresh on fly elements"
  17. )
  18. width = fields.Integer(compute="_compute_width")
  19. margin_y = fields.Integer(default=10, required=True)
  20. margin_x = fields.Integer(default=10, required=True)
  21. widget_dimension_x = fields.Integer(default=250, required=True)
  22. widget_dimension_y = fields.Integer(default=250, required=True)
  23. background_color = fields.Char(required=True, default="#f9f9f9")
  24. group_ids = fields.Many2many("res.groups",)
  25. menu_id = fields.Many2one("ir.ui.menu", copy=False)
  26. def write(self, vals):
  27. res = super().write(vals)
  28. if "group_ids" in vals:
  29. for rec in self:
  30. if rec.menu_id:
  31. rec.menu_id.write(
  32. {"groups_id": [(6, 0, rec.group_ids.ids)]}
  33. )
  34. return res
  35. @api.depends("widget_dimension_x", "margin_x", "number_of_columns")
  36. def _compute_width(self):
  37. for rec in self:
  38. rec.width = (
  39. rec.margin_x * (rec.number_of_columns + 1)
  40. + rec.widget_dimension_x * rec.number_of_columns
  41. )
  42. def read_dashboard_on_fly(self):
  43. self.ensure_one()
  44. result = []
  45. for item in self.item_ids:
  46. if not item.kpi_id.compute_on_fly:
  47. continue
  48. result.append(item._read_dashboard())
  49. return result
  50. def read_dashboard(self):
  51. self.ensure_one()
  52. result = {
  53. "name": self.name,
  54. "width": self.width,
  55. "item_ids": self.item_ids.read_dashboard(),
  56. "max_cols": self.number_of_columns,
  57. "margin_x": self.margin_x,
  58. "margin_y": self.margin_y,
  59. "compute_on_fly_refresh": self.compute_on_fly_refresh,
  60. "widget_dimension_x": self.widget_dimension_x,
  61. "widget_dimension_y": self.widget_dimension_y,
  62. "background_color": self.background_color,
  63. }
  64. if self.menu_id:
  65. result["action_id"] = self.menu_id.action.id
  66. return result
  67. def _generate_menu_vals(self, menu, action):
  68. return {
  69. "parent_id": menu.id or False,
  70. "name": self.name,
  71. "action": "%s,%s" % (action._name, action.id),
  72. "groups_id": [(6, 0, self.group_ids.ids)],
  73. }
  74. def _generate_action_vals(self, menu):
  75. return {
  76. "name": self.name,
  77. "res_model": self._name,
  78. "view_mode": "dashboard",
  79. "res_id": self.id,
  80. }
  81. def _generate_menu(self, menu):
  82. action = self.env["ir.actions.act_window"].create(
  83. self._generate_action_vals(menu)
  84. )
  85. self.menu_id = self.env["ir.ui.menu"].create(
  86. self._generate_menu_vals(menu, action)
  87. )
  88. class KpiDashboardItem(models.Model):
  89. _name = "kpi.dashboard.item"
  90. _description = "Dashboard Items"
  91. _order = "row asc, column asc"
  92. name = fields.Char(required=True)
  93. kpi_id = fields.Many2one("kpi.kpi")
  94. dashboard_id = fields.Many2one(
  95. "kpi.dashboard", required=True, ondelete="cascade"
  96. )
  97. column = fields.Integer(required=True, default=1)
  98. row = fields.Integer(required=True, default=1)
  99. end_row = fields.Integer(store=True, compute='_compute_end_row')
  100. end_column = fields.Integer(store=True, compute='_compute_end_column')
  101. size_x = fields.Integer(required=True, default=1)
  102. size_y = fields.Integer(required=True, default=1)
  103. color = fields.Char()
  104. font_color = fields.Char()
  105. modify_context = fields.Boolean()
  106. modify_context_expression = fields.Char()
  107. modify_color = fields.Boolean()
  108. modify_color_expression = fields.Char()
  109. @api.depends('row', 'size_y')
  110. def _compute_end_row(self):
  111. for r in self:
  112. r.end_row = r.row + r.size_y - 1
  113. @api.depends('column', 'size_x')
  114. def _compute_end_column(self):
  115. for r in self:
  116. r.end_column = r.column + r.size_x - 1
  117. @api.constrains('size_y')
  118. def _check_size_y(self):
  119. for rec in self:
  120. if rec.size_y > 10:
  121. raise ValidationError(_(
  122. 'Size Y of the widget cannot be bigger than 10'))
  123. def _check_size_domain(self):
  124. return [
  125. ('dashboard_id', '=', self.dashboard_id.id),
  126. ('id', '!=', self.id),
  127. ('row', '<=', self.end_row),
  128. ('end_row', '>=', self.row),
  129. ('column', '<=', self.end_column),
  130. ('end_column', '>=', self.column),
  131. ]
  132. @api.constrains('end_row', 'end_column', 'row', 'column')
  133. def _check_size(self):
  134. for r in self:
  135. if self.search(r._check_size_domain(), limit=1):
  136. raise ValidationError(_(
  137. 'Widgets cannot be crossed by other widgets'
  138. ))
  139. if r.end_column > r.dashboard_id.number_of_columns:
  140. raise ValidationError(_(
  141. 'Widget %s is bigger than expected'
  142. ) % r.display_name)
  143. @api.onchange("kpi_id")
  144. def _onchange_kpi(self):
  145. for rec in self:
  146. if not rec.name and rec.kpi_id:
  147. rec.name = rec.kpi_id.name
  148. def _read_dashboard(self):
  149. vals = {
  150. "id": self.id,
  151. "name": self.name,
  152. "col": self.column,
  153. "row": self.row,
  154. "sizex": self.size_x,
  155. "sizey": self.size_y,
  156. "color": self.color,
  157. "font_color": self.font_color or "000000",
  158. "modify_context": self.modify_context,
  159. "modify_color": self.modify_color,
  160. }
  161. if self.modify_context:
  162. vals['modify_context_expression'] = self.modify_context_expression
  163. if self.modify_color:
  164. vals['modify_color_expression'] = self.modify_color_expression
  165. if self.kpi_id:
  166. vals.update(
  167. {
  168. "widget": self.kpi_id.widget,
  169. "kpi_id": self.kpi_id.id,
  170. "suffix": self.kpi_id.suffix or "",
  171. "prefix": self.kpi_id.prefix or "",
  172. "compute_on_fly": self.kpi_id.compute_on_fly,
  173. }
  174. )
  175. if self.kpi_id.compute_on_fly:
  176. vals.update({
  177. "value": self.kpi_id._compute_value(),
  178. "value_last_update": fields.Datetime.now(),
  179. })
  180. else:
  181. vals.update({
  182. "value": self.kpi_id.value,
  183. "value_last_update": self.kpi_id.value_last_update,
  184. })
  185. if self.kpi_id.action_ids:
  186. vals["actions"] = self.kpi_id.action_ids.read_dashboard()
  187. else:
  188. vals["widget"] = "base_text"
  189. return vals
  190. def read_dashboard(self):
  191. result = []
  192. for kpi in self:
  193. result.append(kpi._read_dashboard())
  194. return result
  195. def technical_config(self):
  196. self.ensure_one()
  197. return {
  198. 'name': self.display_name,
  199. 'res_model': self._name,
  200. 'res_id': self.id,
  201. 'type': 'ir.actions.act_window',
  202. 'view_mode': 'form',
  203. 'target': 'new',
  204. 'view_id': self.env.ref(
  205. 'kpi_dashboard.kpi_dashboard_item_config_form_view').id,
  206. }