nestict/ihrm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
2c84ca9db7de868e6f4417be76937e9a0aab7239
ihrm/base/models.py
Horilla 2c84ca9db7 Merge 1.0 and dev/v2.0
2025-09-16 10:30:40 +05:30

2946 lines
88 KiB
Python
Raw Blame History

"""
This module is used to register django models
"""
import ipaddress
from datetime import date, datetime
import django
from django.apps import apps
from django.contrib import messages
from django.contrib.auth.models import User
from django.core.exceptions import ValidationError
from django.db import models
from django.db.models.signals import post_delete, post_save
from django.dispatch import receiver
from django.urls import reverse, reverse_lazy
from django.utils.html import format_html
from django.utils.safestring import mark_safe
from django.utils.translation import gettext_lazy as _
from base.horilla_company_manager import HorillaCompanyManager
from horilla import horilla_middlewares
from horilla.horilla_middlewares import _thread_locals
from horilla.models import HorillaModel, upload_path
from horilla_audit.models import HorillaAuditInfo, HorillaAuditLog
from horilla_views.cbv_methods import render_template
# Create your models here.
WEEKS = [
("0", _("First Week")),
("1", _("Second Week")),
("2", _("Third Week")),
("3", _("Fourth Week")),
("4", _("Fifth Week")),
]
WEEK_DAYS = [
("0", _("Monday")),
("1", _("Tuesday")),
("2", _("Wednesday")),
("3", _("Thursday")),
("4", _("Friday")),
("5", _("Saturday")),
("6", _("Sunday")),
]
def validate_time_format(value):
"""
this method is used to validate the format of duration like fields.
"""
if len(value) > 6:
raise ValidationError(_("Invalid format, it should be HH:MM format"))
try:
hour, minute = value.split(":")
hour = int(hour)
minute = int(minute)
if len(str(hour)) > 3 or minute not in range(60):
raise ValidationError(_("Invalid time, excepted HH:MM"))
except ValueError as e:
raise ValidationError(_("Invalid format, excepted HH:MM")) from e
def clear_messages(request):
"""
clear messages
"""
storage = messages.get_messages(request)
for message in storage:
pass
class Company(HorillaModel):
"""
Company model
"""
company = models.CharField(max_length=50, verbose_name=_("Name"))
hq = models.BooleanField(default=False)
address = models.TextField(max_length=255)
country = models.CharField(max_length=50)
state = models.CharField(max_length=50)
city = models.CharField(max_length=50)
zip = models.CharField(max_length=20)
icon = models.FileField(
upload_to=upload_path,
null=True,
)
objects = models.Manager()
date_format = models.CharField(max_length=30, blank=True, null=True)
time_format = models.CharField(max_length=20, blank=True, null=True)
class Meta:
"""
Meta class to add additional options
"""
verbose_name = _("Company")
verbose_name_plural = _("Companies")
unique_together = ["company", "address"]
app_label = "base"
def __str__(self) -> str:
return str(self.company)
def company_icon_with_name(self):
return format_html(
'<img src="{}" style="width: 30px; border-radius: 100%; display:inline;" class="oh-profile__image" alt="" /> {}',
self.icon.url,
self.company,
)
def get_update_url(self):
"""
This method to get update url
"""
url = reverse_lazy("company-update-form", kwargs={"pk": self.pk})
return url
def get_delete_url(self):
"""
This method to get delete url
"""
url = reverse_lazy("generic-delete")
return url
def get_delete_instance(self):
"""
to get instance for delete
"""
return self.pk
class Department(HorillaModel):
"""
Department model
"""
department = models.CharField(
max_length=50, blank=False, verbose_name=_("Department")
)
company_id = models.ManyToManyField(Company, blank=True, verbose_name=_("Company"))
objects = HorillaCompanyManager()
class Meta:
"""
meta
"""
verbose_name = _("Department")
verbose_name_plural = _("Departments")
def clean(self, *args, **kwargs):
super().clean(*args, **kwargs)
request = getattr(_thread_locals, "request", None)
if request and request.POST:
company = request.POST.getlist("company_id", None)
department = request.POST.get("department", None)
if (
Department.objects.filter(
company_id__id__in=company, department=department
)
.exclude(id=self.id)
.exists()
):
raise ValidationError("This department already exists in this company")
return
def toggle_count(self):
return self.job_position.all().count()
def get_department_col(self):
"""
this method is to get custom department col in job position
"""
return render_template(
path="cbv/settings/job_position_dpt.html",
context={"instance": self},
)
def get_update_url(self):
"""
This method to get update url
"""
url = reverse_lazy("settings-department-update", kwargs={"pk": self.pk})
return url
def get_delete_url(self):
"""
This method to get delete url
"""
url = reverse_lazy("generic-delete")
return url
def get_delete_instance(self):
"""
to get instance for delete
"""
return self.pk
def get_job_position_col(self):
"""
this method is to get custom job position col in job position
"""
return render_template(
path="cbv/settings/position_in_job_position.html",
context={"instance": self},
)
def save(self, *args, **kwargs):
super().save(*args, **kwargs)
self.clean(*args, **kwargs)
return self
def __str__(self):
return str(self.department)
class JobPosition(HorillaModel):
"""
JobPosition model
"""
job_position = models.CharField(
max_length=50, blank=False, null=False, verbose_name=_("Job Position")
)
department_id = models.ForeignKey(
Department,
on_delete=models.PROTECT,
related_name="job_position",
verbose_name=_("Department"),
)
company_id = models.ManyToManyField(Company, blank=True, verbose_name=_("Company"))
objects = HorillaCompanyManager("department_id__company_id")
class Meta:
"""
Meta class to add additional options
"""
verbose_name = _("Job Position")
verbose_name_plural = _("Job Positions")
def __str__(self):
return str(self.job_position + " - (" + self.department_id.department) + ")"
def job_position_col(self):
"""
This method for get custom column .
"""
return render_template(
path="cbv/settings/job_position_col_in_job_role.html",
context={"instance": self},
)
def get_data_count(self):
return self.jobrole_set.all().count()
def job_role_col(self):
"""
This method for get custom column .
"""
return render_template(
path="cbv/settings/job_role.html",
context={"instance": self},
)
class JobRole(HorillaModel):
"""JobRole model"""
job_position_id = models.ForeignKey(
JobPosition, on_delete=models.PROTECT, verbose_name=_("Job Position")
)
job_role = models.CharField(
max_length=50, blank=False, null=True, verbose_name=_("Job Role")
)
company_id = models.ManyToManyField(Company, blank=True, verbose_name=_("Company"))
objects = HorillaCompanyManager("job_position_id__department_id__company_id")
class Meta:
"""
Meta class to add additional options
"""
verbose_name = _("Job Role")
verbose_name_plural = _("Job Roles")
unique_together = ("job_position_id", "job_role")
def __str__(self):
return f"{self.job_role} - {self.job_position_id.job_position}"
class WorkType(HorillaModel):
"""
WorkType model
"""
work_type = models.CharField(max_length=50, verbose_name=_("Work Type"))
company_id = models.ManyToManyField(Company, blank=True, verbose_name=_("Company"))
objects = HorillaCompanyManager()
class Meta:
"""
Meta class to add additional options
"""
verbose_name = _("Work Type")
verbose_name_plural = _("Work Types")
def __str__(self) -> str:
return str(self.work_type)
def clean(self, *args, **kwargs):
super().clean(*args, **kwargs)
request = getattr(_thread_locals, "request", None)
if request and request.POST:
company = request.POST.getlist("company_id", None)
work_type = request.POST.get("work_type", None)
if (
WorkType.objects.filter(company_id__id__in=company, work_type=work_type)
.exclude(id=self.id)
.exists()
):
raise ValidationError("This work type already exists in this company")
return
def get_update_url(self):
"""
This method to get update url
"""
url = reverse_lazy("work-type-update-form", kwargs={"pk": self.pk})
return url
def get_delete_url(self):
"""
This method to get delete url
"""
url = reverse_lazy("generic-delete")
return url
def get_delete_instance(self):
"""
to get instance for delete
"""
return self.pk
def save(self, *args, **kwargs):
super().save(*args, **kwargs)
self.clean(*args, **kwargs)
return self
class RotatingWorkType(HorillaModel):
"""
RotatingWorkType model
"""
name = models.CharField(max_length=50)
work_type1 = models.ForeignKey(
WorkType,
on_delete=models.PROTECT,
related_name="work_type1",
verbose_name=_("Work Type 1"),
)
work_type2 = models.ForeignKey(
WorkType,
on_delete=models.PROTECT,
related_name="work_type2",
verbose_name=_("Work Type 2"),
)
employee_id = models.ManyToManyField(
"employee.Employee",
through="RotatingWorkTypeAssign",
verbose_name=_("Employee"),
)
additional_data = models.JSONField(
default=dict,
blank=True,
null=True,
)
objects = HorillaCompanyManager("employee_id__employee_work_info__company_id")
class Meta:
"""
Meta class to add additional options
"""
verbose_name = _("Rotating Work Type")
verbose_name_plural = _("Rotating Work Types")
def __str__(self) -> str:
return str(self.name)
def get_update_url(self):
"""
This method to get update url
"""
url = reverse_lazy("rotating-work-type-update-form", kwargs={"pk": self.pk})
return url
def get_delete_url(self):
"""
This method to get delete url
"""
url = reverse_lazy("generic-delete")
return url
def get_delete_instance(self):
"""
to get instance for delete
"""
return self.pk
def get_additional_worktytpes(self):
"""
this method is to get additional work types if exists
"""
additional_work = self.additional_work_types()
if additional_work:
additional = "<br>".join([str(work) for work in additional_work])
return additional
return "None"
def clean(self):
if self.work_type1 == self.work_type2:
raise ValidationError(_("Select different work type continuously"))
additional_work_types = (
self.additional_data.get("additional_work_types", [])
if self.additional_data
else []
)
if (
additional_work_types
and str(self.work_type2.id) == additional_work_types[0]
):
raise ValidationError(_("Select different work type continuously"))
if (
additional_work_types
and str(self.work_type1.id) == additional_work_types[-1]
):
raise ValidationError(_("Select different work type continuously"))
for i in range(len(additional_work_types) - 1):
if additional_work_types[i] and additional_work_types[i + 1]:
if additional_work_types[i] == additional_work_types[i + 1]:
raise ValidationError(_("Select different work type continuously"))
def additional_work_types(self):
rotating_work_type = RotatingWorkType.objects.get(id=self.pk)
additional_data = rotating_work_type.additional_data
if additional_data:
additional_work_type_ids = additional_data.get("additional_work_types")
if additional_work_type_ids:
additional_work_types = WorkType.objects.filter(
id__in=additional_work_type_ids
)
else:
additional_work_types = None
else:
additional_work_types = None
return additional_work_types
DAY_DATE = [(str(i), str(i)) for i in range(1, 32)]
DAY_DATE.append(("last", _("Last Day")))
DAY = [
("monday", _("Monday")),
("tuesday", _("Tuesday")),
("wednesday", _("Wednesday")),
("thursday", _("Thursday")),
("friday", _("Friday")),
("saturday", _("Saturday")),
("sunday", _("Sunday")),
]
BASED_ON = [
("after", _("After")),
("weekly", _("Weekend")),
("monthly", _("Monthly")),
]
class RotatingWorkTypeAssign(HorillaModel):
"""
RotatingWorkTypeAssign model
"""
employee_id = models.ForeignKey(
"employee.Employee",
on_delete=models.PROTECT,
null=True,
verbose_name=_("Employee"),
)
rotating_work_type_id = models.ForeignKey(
RotatingWorkType, on_delete=models.PROTECT, verbose_name=_("Rotating Work Type")
)
start_date = models.DateField(
default=django.utils.timezone.now, verbose_name=_("Start Date")
)
next_change_date = models.DateField(null=True, verbose_name=_("Next Switch"))
current_work_type = models.ForeignKey(
WorkType,
null=True,
on_delete=models.PROTECT,
related_name="current_work_type",
verbose_name=_("Current Work Type"),
)
next_work_type = models.ForeignKey(
WorkType,
null=True,
on_delete=models.PROTECT,
related_name="next_work_type",
verbose_name=_("Next Work Type"),
)
based_on = models.CharField(
max_length=10,
choices=BASED_ON,
null=False,
blank=False,
verbose_name=_("Based On"),
)
rotate_after_day = models.IntegerField(
default=7, verbose_name=_("Rotate After Day")
)
rotate_every_weekend = models.CharField(
max_length=10,
default="monday",
choices=DAY,
blank=True,
null=True,
verbose_name=_("Rotate Every Weekend"),
)
rotate_every = models.CharField(
max_length=10,
default="1",
choices=DAY_DATE,
verbose_name=_("Rotate Every Month"),
)
additional_data = models.JSONField(
default=dict,
blank=True,
null=True,
)
history = HorillaAuditLog(
related_name="history_set",
bases=[
HorillaAuditInfo,
],
)
objects = HorillaCompanyManager("employee_id__employee_work_info__company_id")
class Meta:
"""
Meta class to add additional options
"""
verbose_name = _("Rotating Work Type Assign")
verbose_name_plural = _("Rotating Work Type Assigns")
ordering = ["-next_change_date", "-employee_id__employee_first_name"]
def clean(self):
if self.start_date < django.utils.timezone.now().date():
raise ValidationError(_("Date must be greater than or equal to today"))
if self.is_active and self.employee_id is not None:
# Check if any other active record with the same parent already exists
siblings = RotatingWorkTypeAssign.objects.filter(
is_active=True, employee_id=self.employee_id
)
if siblings.exists() and siblings.first().id != self.id:
raise ValidationError(_("Only one active record allowed per employee"))
def rotate_data(self):
"""
method for rotate col
"""
return render_template(
path="cbv/rotating_work_type/rotation_col.html",
context={"instance": self},
)
def get_based_on_display(self):
"""
Display work type
"""
return dict(BASED_ON).get(self.based_on)
def get_actions(self):
"""
get different actions
"""
return render_template(
path="cbv/rotating_work_type/work_rotate_actions.html",
context={"instance": self},
)
def work_rotate_detail_subtitle(self):
"""
Return subtitle containing both department and job position information.
"""
try:
return f"""{self.employee_id.employee_work_info.department_id } /
{ self.employee_id.employee_work_info.job_position_id}"""
except:
return None
def work_rotate_detail_view(self):
"""
for detail view of page
"""
url = reverse("work-rotating-detail-view", kwargs={"pk": self.pk})
return url
def individual_tab_work_rotate_detail_view(self):
"""
for detail view of page in employee profile
"""
url = reverse("individual-work-rotating-detail-view", kwargs={"pk": self.pk})
return url
def detail_is_active(self):
"""
return active or not
"""
if self.is_active:
return "Is Active"
else:
return "Archived"
def get_detail_view_actions(self):
"""
get detail view actions
"""
return render_template(
path="cbv/rotating_work_type/rotate_detail_view_actions.html",
context={"instance": self},
)
class EmployeeType(HorillaModel):
"""
EmployeeType model
"""
employee_type = models.CharField(max_length=50)
company_id = models.ManyToManyField(Company, blank=True, verbose_name=_("Company"))
objects = HorillaCompanyManager("employee_id__employee_work_info__company_id")
class Meta:
"""
Meta class to add additional options
"""
verbose_name = _("Employee Type")
verbose_name_plural = _("Employee Types")
def __str__(self) -> str:
return str(self.employee_type)
def get_update_url(self):
"""
This method to get update url
"""
url = reverse_lazy("employee-type-update-view", kwargs={"pk": self.pk})
return url
def get_delete_url(self):
"""
This method to get delete url
"""
url = reverse_lazy("generic-delete")
return url
def get_instance_id(self):
return self.id
def clean(self, *args, **kwargs):
super().clean(*args, **kwargs)
request = getattr(_thread_locals, "request", None)
if request and request.POST:
company = request.POST.getlist("company_id", None)
employee_type = request.POST.get("employee_type", None)
if (
EmployeeType.objects.filter(
company_id__id__in=company, employee_type=employee_type
)
.exclude(id=self.id)
.exists()
):
raise ValidationError(
"This employee type already exists in this company"
)
return
def save(self, *args, **kwargs):
super().save(*args, **kwargs)
self.clean(*args, **kwargs)
return self
class EmployeeShiftDay(models.Model):
"""
EmployeeShiftDay model
"""
day = models.CharField(max_length=20, choices=DAY)
company_id = models.ManyToManyField(Company, blank=True, verbose_name=_("Company"))
objects = HorillaCompanyManager()
class Meta:
"""
Meta class to add additional options
"""
verbose_name = _("Employee Shift Day")
verbose_name_plural = _("Employee Shift Days")
def __str__(self) -> str:
return str(_(self.day).capitalize())
class EmployeeShift(HorillaModel):
"""
EmployeeShift model
"""
employee_shift = models.CharField(
max_length=50,
null=False,
blank=False,
)
days = models.ManyToManyField(EmployeeShiftDay, through="EmployeeShiftSchedule")
weekly_full_time = models.CharField(
max_length=6,
default="40:00",
null=True,
blank=True,
validators=[validate_time_format],
)
full_time = models.CharField(
max_length=6, default="200:00", validators=[validate_time_format]
)
company_id = models.ManyToManyField(Company, blank=True, verbose_name=_("Company"))
if apps.is_installed("attendance"):
grace_time_id = models.ForeignKey(
"attendance.GraceTime",
null=True,
blank=True,
related_name="employee_shift",
on_delete=models.PROTECT,
verbose_name=_("Grace Time"),
)
objects = HorillaCompanyManager("employee_shift__company_id")
class Meta:
"""
Meta class to add additional options
"""
verbose_name = _("Employee Shift")
verbose_name_plural = _("Employee Shifts")
def __str__(self) -> str:
return str(self.employee_shift)
def get_grace_time(self):
if self.grace_time_id:
return self.grace_time_id
else:
return "Nil"
def get_instance_id(self):
return self.id
def get_update_url(self):
"""
This method to get update url
"""
url = reverse_lazy("employee-shift-update-view", kwargs={"pk": self.pk})
return url
def get_delete_url(self):
"""
This method to get delete url
"""
url = reverse_lazy("generic-delete")
return url
def clean(self, *args, **kwargs):
super().clean(*args, **kwargs)
request = getattr(_thread_locals, "request", None)
if request and request.POST:
company = request.POST.getlist("company_id", None)
employee_shift = request.POST.get("employee_shift", None)
if (
EmployeeShift.objects.filter(
company_id__id__in=company, employee_shift=employee_shift
)
.exclude(id=self.id)
.exists()
):
raise ValidationError(
"This employee shift already exists in this company"
)
return
def save(self, *args, **kwargs):
super().save(*args, **kwargs)
self.clean(*args, **kwargs)
return self
from django.db.models import Case, When
class EmployeeShiftSchedule(HorillaModel):
"""
EmployeeShiftSchedule model
"""
day = models.ForeignKey(
EmployeeShiftDay, on_delete=models.PROTECT, related_name="day_schedule"
)
shift_id = models.ForeignKey(
EmployeeShift, on_delete=models.PROTECT, verbose_name=_("Shift")
)
minimum_working_hour = models.CharField(
default="08:15",
max_length=5,
validators=[validate_time_format],
verbose_name=_("Minimum Working Hours"),
)
start_time = models.TimeField(null=True, verbose_name=_("Start Time"))
end_time = models.TimeField(null=True, verbose_name=_("End Time"))
is_night_shift = models.BooleanField(default=False, verbose_name=_("Night Shift"))
is_auto_punch_out_enabled = models.BooleanField(
default=False,
verbose_name=_("Enable Automatic Check Out"),
help_text=_("Enable this to trigger automatic check out."),
)
auto_punch_out_time = models.TimeField(
null=True,
blank=True,
verbose_name=_("Automatic Check Out Time"),
help_text=_(
"Time at which the horilla will automatically check out the employee attendance if they forget."
),
)
company_id = models.ManyToManyField(Company, blank=True, verbose_name=_("Company"))
objects = HorillaCompanyManager("shift_id__employee_shift__company_id")
class Meta:
"""
Meta class to add additional options
"""
verbose_name = _("Employee Shift Schedule")
verbose_name_plural = _("Employee Shift Schedules")
unique_together = [["shift_id", "day"]]
ordering = [
Case(
When(day__day="monday", then=0),
When(day__day="tuesday", then=1),
When(day__day="wednesday", then=2),
When(day__day="thursday", then=3),
When(day__day="friday", then=4),
When(day__day="saturday", then=5),
When(day__day="sunday", then=6),
default=7,
)
]
def __str__(self) -> str:
return f"{self.shift_id.employee_shift} {self.day}"
def get_detail_url(self):
"""
Detail view url
"""
url = reverse_lazy("employee-shift-shedule-detail-view", kwargs={"pk": self.pk})
return url
def get_instance_id(self):
return self.id
def get_automatic_check_out_time(self):
"""
Custome column for automatic checkout time
"""
return (
f"<div class='oh-timeoff-modal__stat-title'>Automatic Check Out Time</div><div>{self.auto_punch_out_time}</div>"
if self.is_auto_punch_out_enabled
else ""
)
def get_avatar(self):
"""
Method will retun the api to the avatar or path to the profile image
"""
url = f"https://ui-avatars.com/api/?name={self.day.day}&background=random"
return url
def actions_col(self):
"""
This for actions column in employee shift schedule
"""
return render_template(
path="cbv/settings/employee_shift_schedule_action.html",
context={"instance": self},
)
def detail_actions_col(self):
"""
This for detail actions column in employee shift schedule
"""
return render_template(
path="cbv/settings/employee_shift_schedule_detail_action.html",
context={"instance": self},
)
def auto_punch_out_col(self):
return "Yes" if self.is_auto_punch_out_enabled else "No"
def save(self, *args, **kwargs):
if self.start_time and self.end_time:
self.is_night_shift = self.start_time > self.end_time
super().save(*args, **kwargs)
def day_col(self):
"""
Custom column for day in employee shift schedule
"""
return dict(DAY).get(self.day.day)
class RotatingShift(HorillaModel):
"""
RotatingShift model
"""
name = models.CharField(max_length=50)
employee_id = models.ManyToManyField(
"employee.Employee", through="RotatingShiftAssign", verbose_name=_("Employee")
)
shift1 = models.ForeignKey(
EmployeeShift,
related_name="shift1",
on_delete=models.PROTECT,
verbose_name=_("Shift 1"),
blank=True,
null=True,
)
shift2 = models.ForeignKey(
EmployeeShift,
related_name="shift2",
on_delete=models.PROTECT,
verbose_name=_("Shift 2"),
blank=True,
null=True,
)
additional_data = models.JSONField(
default=dict,
blank=True,
null=True,
)
objects = HorillaCompanyManager("employee_id__employee_work_info__company_id")
class Meta:
"""
Meta class to add additional options
"""
verbose_name = _("Rotating Shift")
verbose_name_plural = _("Rotating Shifts")
def __str__(self) -> str:
return str(self.name)
def get_additional_shifts(self):
"""
Returns a list of additional shifts or a message if no additional shifts are available.
"""
additional_shifts = self.additional_shifts()
if additional_shifts:
additional_shift = "<br>".join([str(shift) for shift in additional_shifts])
return additional_shift
return "None"
def get_update_url(self):
"""
This method to get update url
"""
url = reverse_lazy("rotating-shift-update", kwargs={"pk": self.pk})
return url
def get_delete_url(self):
"""
This method to get delete url
"""
url = reverse_lazy("generic-delete")
return url
def get_instance_id(self):
return self.id
def clean(self):
additional_shifts = (
self.additional_data.get("additional_shifts", [])
if self.additional_data
else []
)
if additional_shifts and self.shift1 == self.shift2:
raise ValidationError(_("Select different shift continuously"))
# ---------------- Removed the validation for same shifts to be continously added ----------------
# if additional_shifts and str(self.shift2.id) == additional_shifts[0]:
# raise ValidationError(_("Select different shift continuously"))
# if additional_shifts and str(self.shift1.id) == additional_shifts[-1]:
# raise ValidationError(_("Select different shift continuously"))
# for i in range(len(additional_shifts) - 1):
# if additional_shifts[i] and additional_shifts[i + 1]:
# if additional_shifts[i] == additional_shifts[i + 1]:
# raise ValidationError(_("Select different shift continuously"))
def additional_shifts(self):
additional_data = self.additional_data
if additional_data:
additional_shift_ids = additional_data.get("additional_shifts")
if additional_shift_ids:
unique_ids = set(additional_shift_ids)
shifts_dict = {
shift.id: shift
for shift in EmployeeShift.objects.filter(id__in=unique_ids)
}
additional_shifts = []
for shift_id in additional_shift_ids:
if shift_id:
additional_shifts.append(shifts_dict[int(shift_id)])
else:
additional_shifts.append(None)
else:
additional_shifts = None
else:
additional_shifts = None
return additional_shifts
def total_shifts(self):
total_shifts = []
total_shifts += [self.shift1, self.shift2]
if self.additional_shifts():
total_shifts += list(self.additional_shifts())
return total_shifts
class RotatingShiftAssign(HorillaModel):
"""
RotatingShiftAssign model
"""
employee_id = models.ForeignKey(
"employee.Employee", on_delete=models.PROTECT, verbose_name=_("Employee")
)
rotating_shift_id = models.ForeignKey(
RotatingShift, on_delete=models.PROTECT, verbose_name=_("Rotating Shift")
)
start_date = models.DateField(
default=django.utils.timezone.now, verbose_name=_("Start Date")
)
next_change_date = models.DateField(null=True, verbose_name=_("Next Switch"))
current_shift = models.ForeignKey(
EmployeeShift,
on_delete=models.PROTECT,
null=True,
related_name="current_shift",
verbose_name=_("Current Shift"),
)
next_shift = models.ForeignKey(
EmployeeShift,
on_delete=models.PROTECT,
null=True,
related_name="next_shift",
verbose_name=_("Next Shift"),
)
based_on = models.CharField(
max_length=10,
choices=BASED_ON,
null=False,
blank=False,
verbose_name=_("Based On"),
)
rotate_after_day = models.IntegerField(
null=True, blank=True, default=7, verbose_name=_("Rotate After Day")
)
rotate_every_weekend = models.CharField(
max_length=10,
default="monday",
choices=DAY,
blank=True,
null=True,
verbose_name=_("Rotate Every Weekend"),
)
rotate_every = models.CharField(
max_length=10,
blank=True,
null=True,
default="1",
choices=DAY_DATE,
verbose_name=_("Rotate Every Month"),
)
additional_data = models.JSONField(
default=dict,
blank=True,
null=True,
)
history = HorillaAuditLog(
related_name="history_set",
bases=[
HorillaAuditInfo,
],
)
objects = HorillaCompanyManager("employee_id__employee_work_info__company_id")
def rotating_column(self):
"""
This method for get custome coloumn .
"""
return render_template(
path="cbv/rotating_shift/rotating_column.html",
context={"instance": self},
)
def actions(self):
"""
This method for get custome coloumn .
"""
return render_template(
path="cbv/rotating_shift/actions_rotaing_shift.html",
context={"instance": self},
)
def rotating_detail_actions(self):
"""
This method for get custome coloumn .
"""
return render_template(
path="cbv/rotating_shift/rotating_shift_detail_actions.html",
context={"instance": self},
)
def get_based_on_display(self):
"""
Display work type
"""
return dict(BASED_ON).get(self.based_on)
def rotating_shift_detail(self):
"""
detail view
"""
url = reverse("rotating-shift-detail-view", kwargs={"pk": self.pk})
return url
def rotating_shift_individual_detail(self):
"""
individual detail view
"""
url = reverse("rotating-shift-individual-detail-view", kwargs={"pk": self.pk})
return url
def rotating_subtitle(self):
"""
Detail view subtitle
"""
return f"""{self.employee_id.employee_work_info.department_id } /
{ self.employee_id.employee_work_info.job_position_id}"""
def check_active(self):
"""
Check active
"""
if self.is_active:
return "Is Active"
else:
return "Archived"
def detail_edit_url(self):
"""
Detail view edit
"""
url = reverse("rotating-shift-assign-update", kwargs={"id": self.pk})
return url
def detail_archive_url(self):
"""
Detail view edit
"""
url = reverse("rotating-shift-assign-archive", kwargs={"obj_id": self.pk})
return url
class Meta:
"""
Meta class to add additional options
"""
verbose_name = _("Rotating Shift Assign")
verbose_name_plural = _("Rotating Shift Assigns")
ordering = ["-next_change_date", "-employee_id__employee_first_name"]
def clean(self):
if self.is_active and self.employee_id_id is not None:
# Check if any other active record with the same parent already exists
siblings = RotatingShiftAssign.objects.filter(
is_active=True, employee_id__id=self.employee_id_id
)
if siblings.exists() and siblings.first().id != self.id:
raise ValidationError(_("Only one active record allowed per employee"))
if self.start_date < django.utils.timezone.now().date():
raise ValidationError(_("Date must be greater than or equal to today"))
class BaserequestFile(models.Model):
file = models.FileField(upload_to=upload_path)
objects = models.Manager()
class WorkTypeRequest(HorillaModel):
"""
WorkTypeRequest model
"""
employee_id = models.ForeignKey(
"employee.Employee",
on_delete=models.PROTECT,
null=True,
related_name="work_type_request",
verbose_name=_("Employee"),
)
work_type_id = models.ForeignKey(
WorkType,
on_delete=models.PROTECT,
related_name="requested_work_type",
verbose_name=_("Requesting Work Type"),
)
previous_work_type_id = models.ForeignKey(
WorkType,
on_delete=models.PROTECT,
null=True,
blank=True,
related_name="previous_work_type",
verbose_name=_("Previous Work Type"),
)
requested_date = models.DateField(
null=True, default=django.utils.timezone.now, verbose_name=_("Requested Date")
)
requested_till = models.DateField(
null=True, blank=True, verbose_name=_("Requested Till")
)
description = models.TextField(null=True, verbose_name=_("Description"))
is_permanent_work_type = models.BooleanField(
default=False, verbose_name=_("Permanent Request")
)
approved = models.BooleanField(default=False, verbose_name=_("Approved"))
canceled = models.BooleanField(default=False, verbose_name=_("Canceled"))
work_type_changed = models.BooleanField(default=False)
history = HorillaAuditLog(
related_name="history_set",
bases=[
HorillaAuditInfo,
],
)
objects = HorillaCompanyManager("employee_id__employee_work_info__company_id")
class Meta:
"""
Meta class to add additional options
"""
verbose_name = _("Work Type Request")
verbose_name_plural = _("Work Type Requests")
permissions = (
("approve_worktyperequest", "Approve Work Type Request"),
("cancel_worktyperequest", "Cancel Work Type Request"),
)
ordering = [
"-id",
]
def comment_note(self):
"""
method used for comment note col in the page
"""
return render_template(
path="cbv/work_type_request/note.html",
context={"instance": self},
)
def work_actions(self):
"""
method for rendering actions(edit,duplicate,delete)
"""
return render_template(
path="cbv/work_type_request/actions.html",
context={"instance": self},
)
def confirmation(self):
"""
method for rendering options(approve,reject)
"""
return render_template(
path="cbv/work_type_request/confirmation.html",
context={"instance": self},
)
def detail_view(self):
"""
for detail view of page
"""
url = reverse("work-detail-view", kwargs={"pk": self.pk})
return url
def is_permanent_work_type_display(self):
"""
Method to display "Yes" or "No" based on is_permanent_work_type value
"""
return "Yes" if self.is_permanent_work_type else "No"
def detail_view_actions(self):
"""
method for rendering different options
convert,skillzone,reject,mail
"""
return render_template(
path="cbv/work_type_request/detail_view_actions.html",
context={"instance": self},
)
def detail_subtitle(self):
"""
Return subtitle containing both department and job position information.
"""
return f"{self.employee_id.employee_work_info.department_id} / {self.employee_id.employee_work_info.job_position_id}"
def delete(self, *args, **kwargs):
request = getattr(_thread_locals, "request", None)
if not self.approved:
super().delete(*args, **kwargs)
else:
if request:
clear_messages(request)
messages.warning(request, "The request entry cannot be deleted.")
def is_any_work_type_request_exists(self):
approved_work_type_requests_range = WorkTypeRequest.objects.filter(
employee_id=self.employee_id,
approved=True,
canceled=False,
requested_date__range=[self.requested_date, self.requested_till],
requested_till__range=[self.requested_date, self.requested_till],
).exclude(id=self.id)
if approved_work_type_requests_range:
return True
approved_work_type_requests = WorkTypeRequest.objects.filter(
employee_id=self.employee_id,
approved=True,
canceled=False,
requested_date__lte=self.requested_date,
requested_till__gte=self.requested_date,
).exclude(id=self.id)
if approved_work_type_requests:
return True
if self.requested_till:
approved_work_type_requests_2 = WorkTypeRequest.objects.filter(
employee_id=self.employee_id,
approved=True,
canceled=False,
requested_date__lte=self.requested_till,
requested_till__gte=self.requested_till,
).exclude(id=self.id)
if approved_work_type_requests_2:
return True
approved_permanent_req = WorkTypeRequest.objects.filter(
employee_id=self.employee_id,
approved=True,
canceled=False,
requested_date__exact=self.requested_date,
)
if approved_permanent_req:
return True
return False
def clean(self):
request = getattr(horilla_middlewares._thread_locals, "request", None)
if not request.user.is_superuser:
if self.requested_date < django.utils.timezone.now().date():
raise ValidationError(_("Date must be greater than or equal to today"))
if self.requested_till and self.requested_till < self.requested_date:
raise ValidationError(
_("End date must be greater than or equal to start date")
)
if self.is_any_work_type_request_exists():
raise ValidationError(
_("A work type request already exists during this time period.")
)
if not self.is_permanent_work_type:
if not self.requested_till:
raise ValidationError(_("Requested till field is required."))
def request_status(self):
return (
_("Rejected")
if self.canceled
else (_("Approved") if self.approved else _("Requested"))
)
def __str__(self) -> str:
return f"{self.employee_id.employee_first_name} \
{self.employee_id.employee_last_name} - {self.requested_date}"
class WorkTypeRequestComment(HorillaModel):
"""
WorkTypeRequestComment Model
"""
from employee.models import Employee
request_id = models.ForeignKey(WorkTypeRequest, on_delete=models.CASCADE)
employee_id = models.ForeignKey(Employee, on_delete=models.CASCADE)
comment = models.TextField(null=True, verbose_name=_("Comment"))
files = models.ManyToManyField(BaserequestFile, blank=True)
objects = models.Manager()
def __str__(self) -> str:
return f"{self.comment}"
class ShiftRequest(HorillaModel):
"""
ShiftRequest model
"""
employee_id = models.ForeignKey(
"employee.Employee",
on_delete=models.PROTECT,
null=True,
related_name="shift_request",
verbose_name=_("Employee"),
)
shift_id = models.ForeignKey(
EmployeeShift,
on_delete=models.PROTECT,
related_name="requested_shift",
verbose_name=_("Requesting Shift"),
)
previous_shift_id = models.ForeignKey(
EmployeeShift,
on_delete=models.PROTECT,
null=True,
blank=True,
related_name="previous_shift",
verbose_name=_("Previous Shift"),
)
requested_date = models.DateField(
null=True, default=django.utils.timezone.now, verbose_name=_("Requested Date")
)
reallocate_to = models.ForeignKey(
"employee.Employee",
on_delete=models.PROTECT,
null=True,
blank=True,
related_name="reallocate_shift_request",
verbose_name=_("Reallocate Employee"),
)
reallocate_approved = models.BooleanField(default=False, verbose_name=_("Approved"))
reallocate_canceled = models.BooleanField(default=False, verbose_name=_("Canceled"))
requested_till = models.DateField(
null=True, blank=True, verbose_name=_("Requested Till")
)
description = models.TextField(null=True, verbose_name=_("Description"))
is_permanent_shift = models.BooleanField(
default=False, verbose_name=_("Permanent Request")
)
approved = models.BooleanField(default=False, verbose_name=_("Approved"))
canceled = models.BooleanField(default=False, verbose_name=_("Canceled"))
shift_changed = models.BooleanField(default=False)
history = HorillaAuditLog(
related_name="history_set",
bases=[
HorillaAuditInfo,
],
)
objects = HorillaCompanyManager("employee_id__employee_work_info__company_id")
class Meta:
"""
Meta class to add additional options
"""
verbose_name = _("Shift Request")
verbose_name_plural = _("Shift Requests")
permissions = (
("approve_shiftrequest", "Approve Shift Request"),
("cancel_shiftrequest", "Cancel Shift Request"),
)
ordering = [
"-id",
]
def comment(self):
"""
This method for get custome coloumn for comment.
"""
return render_template(
path="cbv/shift_request/comment.html",
context={"instance": self},
)
# def shift_allocate_actions(self):
# """
# This method for get custome coloumn for allocated actions.
# """
# return render_template(
# path="cbv/shift_request/allocated_shift_actions.html",
# context={"instance": self},
# )
def allocated_confirm_action_col(self):
"""
This method for get custome coloumn for allocated actions.
"""
return render_template(
path="cbv/shift_request/allocated_confirm_action.html",
context={"instance": self},
)
def user_availability(self):
"""
This method for get custome coloumn for User availability.
"""
return render_template(
path="cbv/shift_request/user_availability.html",
context={"instance": self},
)
def shift_details(self):
"""
Detail view
"""
url = reverse("shift-detail-view", kwargs={"pk": self.pk})
return url
def allocate_shift_details(self):
"""
Allocate detail view
"""
url = reverse("allocate-detail-view", kwargs={"pk": self.pk})
return url
def is_permanent(self):
"""
Permanent shift
"""
return "Yes" if self.is_permanent_shift else "No"
def shift_actions(self):
"""
This method for get custome coloumn for actions.
"""
return render_template(
path="cbv/shift_request/actions_shift_requst.html",
context={"instance": self},
)
def confirmations(self):
"""
This method for get custome coloumn for confirmations.
"""
return render_template(
path="cbv/shift_request/confirmations.html",
context={"instance": self},
)
def allocate_confirmations(self):
"""
This method for get custome coloumn for confirmations.
"""
return render_template(
path="cbv/shift_request/confirm_allocated.html",
context={"instance": self},
)
def detail_actions(self):
"""
This method for get custome coloumn for comment.
"""
return render_template(
path="cbv/shift_request/shift_deatil_actions.html",
context={"instance": self},
)
def request_status(self):
return (
_("Rejected")
if self.canceled
else (_("Approved") if self.approved else _("Requested"))
)
def details_subtitle(self):
"""
Detail view subtitle
"""
try:
return f"""{self.employee_id.employee_work_info.department_id } /
{ self.employee_id.employee_work_info.job_position_id}"""
except:
return None
def clean(self):
request = getattr(horilla_middlewares._thread_locals, "request", None)
if not request.user.is_superuser:
if not self.pk and self.requested_date < django.utils.timezone.now().date():
raise ValidationError(_("Date must be greater than or equal to today"))
if self.requested_till and self.requested_till < self.requested_date:
raise ValidationError(
_("End date must be greater than or equal to start date")
)
if self.is_any_request_exists():
raise ValidationError(
_("An approved shift request already exists during this time period.")
)
if not self.is_permanent_shift:
if not self.requested_till:
raise ValidationError(_("Requested till field is required."))
def is_any_request_exists(self):
approved_shift_requests_range = ShiftRequest.objects.filter(
employee_id=self.employee_id,
approved=True,
canceled=False,
requested_date__range=[self.requested_date, self.requested_till],
requested_till__range=[self.requested_date, self.requested_till],
).exclude(id=self.id)
if approved_shift_requests_range:
return True
approved_shift_requests = ShiftRequest.objects.filter(
employee_id=self.employee_id,
approved=True,
canceled=False,
requested_date__lte=self.requested_date,
requested_till__gte=self.requested_date,
).exclude(id=self.id)
if approved_shift_requests:
return True
if self.requested_till:
approved_shift_requests_2 = ShiftRequest.objects.filter(
employee_id=self.employee_id,
approved=True,
canceled=False,
requested_date__lte=self.requested_till,
requested_till__gte=self.requested_till,
).exclude(id=self.id)
if approved_shift_requests_2:
return True
approved_permanent_req = ShiftRequest.objects.filter(
employee_id=self.employee_id,
approved=True,
canceled=False,
requested_date__exact=self.requested_date,
)
if approved_permanent_req:
return True
return False
def save(self, *args, **kwargs):
super().save(*args, **kwargs)
def delete(self, *args, **kwargs):
request = getattr(_thread_locals, "request", None)
if not self.approved:
super().delete(*args, **kwargs)
else:
if request:
clear_messages(request)
messages.warning(request, "The request entry cannot be deleted.")
def __str__(self) -> str:
return f"{self.employee_id.employee_first_name} \
{self.employee_id.employee_last_name} - {self.requested_date}"
class ShiftRequestComment(HorillaModel):
"""
ShiftRequestComment Model
"""
from employee.models import Employee
request_id = models.ForeignKey(ShiftRequest, on_delete=models.CASCADE)
employee_id = models.ForeignKey(Employee, on_delete=models.CASCADE)
files = models.ManyToManyField(BaserequestFile, blank=True)
comment = models.TextField(null=True, verbose_name=_("Comment"))
objects = models.Manager()
def __str__(self) -> str:
return f"{self.comment}"
class Tags(HorillaModel):
title = models.CharField(max_length=30)
color = models.CharField(max_length=30)
company_id = models.ForeignKey(
Company, null=True, editable=False, on_delete=models.PROTECT
)
objects = HorillaCompanyManager(related_company_field="company_id")
class Meta:
verbose_name = _("Tag")
verbose_name_plural = _("Tags")
def __str__(self):
return self.title
def get_color(self):
"""
This method returns the style string with the tag's color
"""
color = (
f"<span style='height: 25px; "
f"width: 25px; "
f"background-color: {self.color}; "
f"border-radius: 50%; "
f"display: inline-block;'></span>"
)
return color
def get_instance_id(self):
"""
To get instance
"""
return self.id
def get_update_url(self):
"""
This method to get update url
"""
url = reverse_lazy("update-helpdesk-tag", kwargs={"pk": self.pk})
return url
def get_delete_url(self):
"""
This method to get delete url
"""
url = reverse_lazy("tag-delete", kwargs={"obj_id": self.pk})
# message = "Are you sure you want to delete this tag ?"
# return f"'{url}'" + "," + f"'{message}'"
return url
class HorillaMailTemplate(HorillaModel):
title = models.CharField(max_length=100, unique=True)
body = models.TextField()
company_id = models.ForeignKey(
Company,
null=True,
blank=True,
on_delete=models.CASCADE,
verbose_name=_("Company"),
)
objects = HorillaCompanyManager(related_company_field="company_id")
def __str__(self) -> str:
return f"{self.title}"
class DynamicEmailConfiguration(HorillaModel):
"""
SingletonModel to keep the mail server configurations
"""
host = models.CharField(null=True, max_length=256, verbose_name=_("Email Host"))
port = models.SmallIntegerField(null=True, verbose_name=_("Email Port"))
from_email = models.EmailField(
null=True, max_length=256, verbose_name=_("Default From Email")
)
username = models.CharField(
null=True,
max_length=256,
verbose_name=_("Email Host Username"),
)
display_name = models.CharField(
null=True,
max_length=256,
verbose_name=_("Display Name"),
)
password = models.CharField(
null=True,
max_length=256,
verbose_name=_("Email Authentication Password"),
)
use_tls = models.BooleanField(default=True, verbose_name=_("Use TLS"))
use_ssl = models.BooleanField(default=False, verbose_name=_("Use SSL"))
fail_silently = models.BooleanField(default=False, verbose_name=_("Fail Silently"))
is_primary = models.BooleanField(
default=False, verbose_name=_("Primary Mail Server")
)
use_dynamic_display_name = models.BooleanField(
default=True,
help_text=_(
"By enabling this the display name will take from who triggered the mail"
),
)
timeout = models.SmallIntegerField(
null=True, verbose_name=_("Email Send Timeout (seconds)")
)
company_id = models.OneToOneField(
Company, on_delete=models.CASCADE, null=True, blank=True
)
def highlight_cell(self):
if self.is_primary:
return f'style="background-color: rgba(255, 68, 0, 0.134);" '
def action_col(self):
"""
This method for get custome coloumn .
"""
return render_template(
path="cbv/settings/mail_server_action.html",
context={"instance": self},
)
def clean(self):
if self.use_ssl and self.use_tls:
raise ValidationError(
_(
'"Use TLS" and "Use SSL" are mutually exclusive, '
"so only set one of those settings to True."
)
)
if not self.company_id and not self.is_primary:
raise ValidationError({"company_id": _("This field is required")})
def __str__(self):
return self.username
def save(self, *args, **kwargs) -> None:
if self.is_primary:
DynamicEmailConfiguration.objects.filter(is_primary=True).update(
is_primary=False
)
if not DynamicEmailConfiguration.objects.exists():
self.is_primary = True
super().save(*args, **kwargs)
servers_same_company = DynamicEmailConfiguration.objects.filter(
company_id=self.company_id
).exclude(id=self.id)
if servers_same_company.exists():
self.delete()
return
class Meta:
verbose_name = _("Email Configuration")
FIELD_CHOICE = [
("", "---------"),
("requested_days", _("Leave Requested Days")),
]
CONDITION_CHOICE = [
("equal", _("Equal (==)")),
("notequal", _("Not Equal (!=)")),
("range", _("Range")),
("lt", _("Less Than (<)")),
("gt", _("Greater Than (>)")),
("le", _("Less Than or Equal To (<=)")),
("ge", _("Greater Than or Equal To (>=)")),
("icontains", _("Contains")),
]
class MultipleApprovalCondition(HorillaModel):
"""
Multiple approve conditions
"""
department = models.ForeignKey(Department, on_delete=models.CASCADE)
condition_field = models.CharField(
max_length=255,
choices=FIELD_CHOICE,
)
condition_operator = models.CharField(
max_length=255, choices=CONDITION_CHOICE, null=True, blank=True
)
condition_value = models.CharField(
max_length=100,
null=True,
blank=True,
verbose_name=_("Condition Value"),
)
condition_start_value = models.CharField(
max_length=100,
null=True,
blank=True,
verbose_name=_("Starting Value"),
)
condition_end_value = models.CharField(
max_length=100,
null=True,
blank=True,
verbose_name=_("Ending Value"),
)
company_id = models.ForeignKey(
Company,
null=True,
blank=True,
on_delete=models.CASCADE,
verbose_name=_("Company"),
)
objects = HorillaCompanyManager()
def __str__(self) -> str:
return f"{self.condition_field} {self.condition_operator}"
def get_condition_field(self):
"""
Display condition field
"""
return dict(FIELD_CHOICE).get(self.condition_field)
def get_condition_operator(self):
"""
Display condition operator
"""
return dict(CONDITION_CHOICE).get(self.condition_operator)
def get_condition_value(self):
"""
Condition value column
"""
if self.condition_operator == "range":
start_value = self.condition_start_value
end_value = self.condition_end_value
return start_value + " - " + end_value
else:
return self.condition_value
def approval_managers_col(self):
"""
For approval managers column
"""
return render_template(
path="cbv/multiple_approval_condition/approval_managers.html",
context={"instance": self},
)
def detail_actions(self):
"""
For detail action column
"""
return render_template(
path="cbv/multiple_approval_condition/detail_action.html",
context={"instance": self},
)
def actions_col(self):
"""
For actions column
"""
return render_template(
path="cbv/multiple_approval_condition/actions.html",
context={"instance": self},
)
def get_avatar(self):
"""
Method will retun the api to the avatar or path to the profile image
"""
url = f"https://ui-avatars.com/api/?name={self.department}&background=random"
return url
def detail_view(self):
"""
detail view
"""
url = reverse("detail-view-multiple-approval-condition", kwargs={"pk": self.pk})
return url
def clean(self, *args, **kwargs):
if self.condition_value:
instance = MultipleApprovalCondition.objects.filter(
department=self.department,
condition_field=self.condition_field,
condition_operator=self.condition_operator,
condition_value=self.condition_value,
company_id=self.company_id,
).exclude(id=self.pk)
if instance:
raise ValidationError(
_("A condition with the provided fields already exists")
)
if self.condition_field == "requested_days":
if self.condition_operator != "range":
if not self.condition_value:
raise ValidationError(
{
"condition_operator": _(
"Please enter a numeric value for condition value"
)
}
)
try:
float_value = float(self.condition_value)
except ValueError as e:
raise ValidationError(
{
"condition_operator": _(
"Please enter a valid numeric value for the condition value when the condition field is Leave Requested Days."
)
}
)
else:
if not self.condition_start_value or not self.condition_end_value:
raise ValidationError(
{
"condition_operator": _(
"Please specify condition value range"
)
}
)
try:
start_value = float(self.condition_start_value)
except ValueError as e:
raise ValidationError(
{
"condition_operator": _(
"Please enter a valid numeric value for the starting value when the condition field is Leave Requested Days."
)
}
)
try:
end_value = float(self.condition_end_value)
except ValueError as e:
raise ValidationError(
{
"condition_operator": _(
"Please enter a valid numeric value for the ending value when the condition field is Leave Requested Days."
)
}
)
if start_value == end_value:
raise ValidationError(
{
"condition_operator": _(
"End value must be different from the start value in a range."
)
}
)
if end_value <= start_value:
raise ValidationError(
{
"condition_operator": _(
"End value must be greater than the start value in a range."
)
}
)
super().clean(*args, **kwargs)
def save(self, *args, **kwargs):
if self.condition_operator != "range":
self.condition_start_value = None
self.condition_end_value = None
else:
self.condition_value = None
super().save(*args, **kwargs)
def approval_managers(self, *args, **kwargs):
"""
approved managers
"""
managers = []
from employee.models import Employee
queryset = MultipleApprovalManagers.objects.filter(
condition_id=self.pk
).order_by("sequence")
for query in queryset:
emp_id = query.employee_id
employee = (
query.reporting_manager
if not emp_id
else Employee.objects.get(id=emp_id)
)
managers.append(employee)
return managers
class MultipleApprovalManagers(models.Model):
"""
Multiple approve
"""
condition_id = models.ForeignKey(
MultipleApprovalCondition, on_delete=models.CASCADE
)
sequence = models.IntegerField(null=False, blank=False)
employee_id = models.IntegerField(null=True, blank=True)
reporting_manager = models.CharField(max_length=100, null=True, blank=True)
objects = HorillaCompanyManager(related_company_field="condition_id__company_id")
class Meta:
verbose_name = _("Multiple Approval Managers")
verbose_name_plural = _("Multiple Approval Managers")
def get_manager(self):
manager = self.employee_id
if manager:
manager = self.reporting_manager.replace("_", " ").title()
return manager
class DynamicPagination(models.Model):
"""
model for storing pagination for employees
"""
from django.contrib.auth.models import User
from django.core.validators import MinValueValidator
user_id = models.OneToOneField(
User,
on_delete=models.CASCADE,
blank=True,
null=True,
related_name="dynamic_pagination",
verbose_name=_("User"),
)
pagination = models.IntegerField(default=50, validators=[MinValueValidator(1)])
objects = models.Manager()
def save(self, *args, **kwargs):
request = getattr(_thread_locals, "request", None)
user = request.user
self.user_id = user
super().save(*args, **kwargs)
def __str__(self):
return f"{self.user_id}|{self.pagination}"
class Attachment(models.Model):
"""
Attachment model for multiple attachments in announcements.
"""
file = models.FileField(upload_to=upload_path)
def __str__(self):
return self.file.name
class AnnouncementExpire(models.Model):
"""
This model for setting a expire days for announcement if no expire date for announcement
"""
days = models.IntegerField(null=True, blank=True, default=30)
objects = models.Manager()
class Announcement(HorillaModel):
"""
Announcement Model for storing all announcements.
"""
from employee.models import Employee
model_employee = Employee
title = models.CharField(max_length=100)
description = models.TextField(null=True)
attachments = models.ManyToManyField(
Attachment, related_name="announcement_attachments", blank=True
)
expire_date = models.DateField(null=True, blank=True)
employees = models.ManyToManyField(
Employee, related_name="announcement_employees", blank=True
)
department = models.ManyToManyField(Department, blank=True)
job_position = models.ManyToManyField(
JobPosition, blank=True, verbose_name=_("Job Position")
)
company_id = models.ManyToManyField(
Company, blank=True, related_name="announcement", verbose_name=_("Company")
)
disable_comments = models.BooleanField(
default=False, verbose_name=_("Disable Comments")
)
public_comments = models.BooleanField(
default=True,
verbose_name=_("Show Comments to All"),
help_text=_("If enabled, all employees can view each other's comments."),
)
filtered_employees = models.ManyToManyField(
Employee, related_name="announcement_filtered_employees", editable=False
)
objects = HorillaCompanyManager(related_company_field="company_id")
class Meta:
verbose_name = _("Announcement")
verbose_name_plural = _("Announcements")
def get_views(self):
"""
This method is used to get the view count of the announcement
"""
return self.announcementview_set.filter(viewed=True)
def viewed_by(self):
"""
Announcement view
"""
viewed_by = AnnouncementView.objects.filter(
announcement_id__id=self.id, viewed=True
)
viewed_emp = []
for i in viewed_by:
viewed_emp.append(i.user)
return viewed_emp
def save(self, *args, **kwargs):
"""
if comments are disabled, force public comments to be false
"""
if self.disable_comments:
self.public_comments = False
super().save(*args, **kwargs)
def __str__(self):
return self.title
def announcement_custom_col(self):
"""
custom col for announcement list col
"""
current_date = datetime.now().strftime("%Y-%m-%d")
return render_template(
path="cbv/dashboard/announcement_title.html",
context={"instance": self, "current_date": current_date},
)
class AnnouncementComment(HorillaModel):
"""
AnnouncementComment Model
"""
from employee.models import Employee
announcement_id = models.ForeignKey(Announcement, on_delete=models.CASCADE)
employee_id = models.ForeignKey(Employee, on_delete=models.CASCADE)
comment = models.TextField(null=True, verbose_name=_("Comment"), max_length=255)
objects = models.Manager()
class AnnouncementView(models.Model):
"""
Announcement View Model
"""
user = models.ForeignKey(User, on_delete=models.CASCADE)
announcement = models.ForeignKey(Announcement, on_delete=models.CASCADE)
viewed = models.BooleanField(default=False)
created_at = models.DateTimeField(auto_now_add=True, null=True)
objects = models.Manager()
def announcement_viewed_by_col(self):
"""
custom col for announcement list col
"""
return render_template(
path="cbv/dashboard/announcement_viewed_by.html",
context={
"instance": self,
},
)
class EmailLog(models.Model):
"""
EmailLog Keeping model
"""
statuses = [("sent", "Sent"), ("failed", "Failed")]
subject = models.CharField(max_length=255)
body = models.TextField(max_length=255)
from_email = models.EmailField()
to = models.EmailField()
status = models.CharField(max_length=6, choices=statuses)
created_at = models.DateTimeField(auto_now_add=True)
objects = models.Manager()
company_id = models.ForeignKey(
Company, on_delete=models.CASCADE, null=True, editable=False
)
def __str__(self) -> str:
return f"{self.subject} {self.to}"
def status_display(self):
status = dict(self.statuses).get(self.status)
if self.status == "sent":
color_class = "oh-dot--success"
link_class = "link-success"
elif self.status == "failed":
color_class = "oh-dot--danger"
link_class = "link-danger"
return format_html(
'<span class="oh-dot oh-dot--small me-1 oh-dot--color {color_class}"></span>'
'<span class="{link_class}">{status}</span>',
color_class=color_class,
status=status,
link_class=link_class,
)
def mail_log_detail_view(self):
"""
for detail view of page
"""
url = reverse("individual-mail-log-detail", kwargs={"pk": self.pk})
return url
class DriverViewed(models.Model):
"""
Model to store driver viewed status
"""
choices = [
("dashboard", "dashboard"),
("pipeline", "pipeline"),
("settings", "settings"),
]
user = models.ForeignKey(User, on_delete=models.CASCADE)
viewed = models.CharField(max_length=10, choices=choices)
def user_viewed(self):
"""
This method is used to access all the viewd driver
"""
return self.user.driverviewed_set.values_list("viewed", flat=True)
class DashboardEmployeeCharts(HorillaModel):
"""
dashboard employee chart
"""
from employee.models import Employee
employee = models.ForeignKey(Employee, on_delete=models.CASCADE)
charts = models.JSONField(
verbose_name=_("Excluded Charts"), default=list, blank=True, null=True
)
class Meta:
verbose_name = _("Dashboard Employee Charts")
verbose_name_plural = _("Dashboard Employee Charts")
def __str__(self):
return f"{self.employee} - charts"
class BiometricAttendance(models.Model):
"""
Biometric attendance
"""
is_installed = models.BooleanField(default=False)
company_id = models.ForeignKey(
Company,
null=True,
editable=False,
on_delete=models.PROTECT,
related_name="biometric_enabled_company",
)
objects = models.Manager()
def __str__(self):
return f"{self.is_installed}"
def default_additional_data():
return {"allowed_ips": []}
class AttendanceAllowedIP(models.Model):
"""
Represents client IP addresses that are allowed to mark attendance.
Usage:
- This model is used to store IP addresses that are permitted to access the attendance system.
- It ensures that only authorized IP addresses can mark attendance.
"""
is_enabled = models.BooleanField(default=False)
additional_data = models.JSONField(
null=True, blank=True, default=default_additional_data
)
def clean(self):
"""
Validate that all entries in `allowed_ips` are either valid IP addresses or network prefixes.
"""
allowed_ips = self.additional_data.get("allowed_ips", [])
for ip in allowed_ips:
try:
ipaddress.ip_network(ip)
except ValueError:
raise ValidationError(f"Invalid IP address or network prefix: {ip}")
def __str__(self):
return f"AttendanceAllowedIP - {self.is_enabled}"
class TrackLateComeEarlyOut(HorillaModel):
is_enable = models.BooleanField(
default=True,
verbose_name=_("Enable"),
help_text=_(
"By enabling this, you track the late comes and early outs of employees in their attendance."
),
)
class Meta:
verbose_name = _("Track Late Come Early Out")
verbose_name_plural = _("Track Late Come Early Outs")
def __str__(self):
tracking = _("enabled") if self.is_enable else _("disabled")
return f"Tracking late come early out {tracking}"
def save(self, *args, **kwargs):
if not self.pk and TrackLateComeEarlyOut.objects.exists():
raise ValidationError(
_("Only one TrackLateComeEarlyOut instance is allowed.")
)
return super().save(*args, **kwargs)
class Holidays(HorillaModel):
name = models.CharField(max_length=30, null=False, verbose_name=_("Name"))
start_date = models.DateField(verbose_name=_("Start Date"))
end_date = models.DateField(null=True, blank=True, verbose_name=_("End Date"))
recurring = models.BooleanField(default=False, verbose_name=_("Recurring"))
company_id = models.ForeignKey(
Company,
null=True,
on_delete=models.PROTECT,
verbose_name=_("Company"),
)
objects = HorillaCompanyManager(related_company_field="company_id")
class Meta:
verbose_name = _("Holiday")
verbose_name_plural = _("Holidays")
def __str__(self):
return self.name
def detail_view(self):
"""
detail view
"""
url = reverse("holiday-detail-view", kwargs={"pk": self.pk})
return url
def detail_view_actions(self):
"""
detail view actions
"""
return render_template(
path="cbv/holidays/detail_view_actions.html",
context={"instance": self},
)
def get_recurring_status(self):
"""
recurring data
"""
return "Yes" if self.recurring else "No"
def holidays_actions(self):
"""
method for rendering actions(edit,delete)
"""
return render_template(
path="cbv/holidays/holidays_actions.html",
context={"instance": self},
)
def get_avatar(self):
"""
Method will retun the api to the avatar or path to the profile image
"""
url = f"https://ui-avatars.com/api/?name={self.name}&background=random"
return url
def today_holidays(today=None) -> models.QuerySet:
"""
Retrieve holidays that overlap with the given date (default is today).
Args:
today (date, optional): The date to check for holidays. Defaults to the current date.
Returns:
QuerySet: A queryset of `Holidays` instances where the given date falls between
`start_date` and `end_date` (inclusive).
"""
today = today or date.today()
return Holidays.objects.filter(start_date__lte=today, end_date__gte=today)
class CompanyLeaves(HorillaModel):
based_on_week = models.CharField(
max_length=100,
choices=WEEKS,
blank=True,
null=True,
verbose_name=_("Based On Week"),
)
based_on_week_day = models.CharField(
max_length=100, choices=WEEK_DAYS, verbose_name=_("Based On Week Day")
)
company_id = models.ForeignKey(
Company, null=True, on_delete=models.PROTECT, verbose_name=_("Company")
)
objects = HorillaCompanyManager()
class Meta:
unique_together = ("based_on_week", "based_on_week_day")
verbose_name = _("Company Leave")
verbose_name_plural = _("Company Leaves")
def __str__(self):
return f"{dict(WEEK_DAYS).get(self.based_on_week_day)} | {dict(WEEKS).get(self.based_on_week)}"
def custom_based_on_week(self):
"""
custom based on col
"""
return render_template(
path="cbv/company_leaves/on_week.html",
context={"instance": self, "weeks": WEEKS},
)
def get_detail_title(self):
"""
for return title
"""
title = "Company Leaves"
return title
def detail_view_actions(self):
"""
detail view actions
"""
return render_template(
path="cbv/company_leaves/detail_view_actions.html",
context={"instance": self},
)
def based_on_week_day_col(self):
"""
custom based on week day col
"""
return render_template(
path="cbv/company_leaves/on_week_day.html",
context={"instance": self, "week_days": WEEK_DAYS},
)
def company_leave_actions(self):
"""
custom actions col
"""
return render_template(
path="cbv/company_leaves/company_leave_actions.html",
context={"instance": self, "weeks": WEEKS},
)
def detail_view(self):
"""
detail view
"""
url = reverse("company-leave-detail-view", kwargs={"pk": self.pk})
return url
def get_avatar(self):
"""
Method will retun the api to the avatar or path to the profile image
"""
if self.based_on_week is not None:
url = f"https://ui-avatars.com/api/?name={dict(WEEKS).get(self.based_on_week)}&background=random"
else:
data = "All"
url = f"https://ui-avatars.com/api/?name={data}&background=random"
return url
class PenaltyAccounts(HorillaModel):
"""
LateComeEarlyOutPenaltyAccount
"""
employee_id = models.ForeignKey(
"employee.Employee",
on_delete=models.PROTECT,
related_name="penalty_accounts",
editable=False,
verbose_name="Employee",
null=True,
)
if apps.is_installed("attendance"):
late_early_id = models.ForeignKey(
"attendance.AttendanceLateComeEarlyOut",
on_delete=models.CASCADE,
null=True,
editable=False,
)
if apps.is_installed("leave"):
leave_request_id = models.ForeignKey(
"leave.LeaveRequest", null=True, on_delete=models.CASCADE, editable=False
)
leave_type_id = models.ForeignKey(
"leave.LeaveType",
on_delete=models.DO_NOTHING,
blank=True,
null=True,
verbose_name="Leave type",
)
minus_leaves = models.FloatField(default=0.0, null=True)
deduct_from_carry_forward = models.BooleanField(default=False)
def get_deduct_from_carry_forward(self):
if self.deduct_from_carry_forward:
return "Yes"
return "No"
penalty_amount = models.FloatField(default=0.0, null=True)
def get_delete_url(self):
"""
To get delete url
"""
url = reverse("delete-penalties", kwargs={"penalty_id": self.pk})
return url
def get_delete_instance(self):
"""
To get instance for delete
"""
return self.pk
def penalty_type_col(self):
if apps.is_installed("attendance"):
if self.late_early_id:
return "Late come or Early out Penalty"
return "Leave Penalty"
def clean(self) -> None:
super().clean()
if apps.is_installed("leave") and not self.leave_type_id and self.minus_leaves:
raise ValidationError(
{"leave_type_id": _("Specify the leave type to deduct the leave.")}
)
if apps.is_installed("leave") and self.leave_type_id and not self.minus_leaves:
raise ValidationError(
{
"minus_leaves": _(
"If a leave type is chosen for a penalty, minus leaves are required."
)
}
)
if (
apps.is_installed("leave")
and not self.minus_leaves
and not self.penalty_amount
):
raise ValidationError(
{
"leave_type_id": _(
"Either minus leaves or a penalty amount is required"
)
}
)
if (
apps.is_installed("leave")
and (self.minus_leaves or self.deduct_from_carry_forward)
and not self.leave_type_id
):
raise ValidationError({"leave_type_id": _("Leave type is required")})
return
class Meta:
ordering = ["-created_at"]
verbose_name = _("Penalty Account")
verbose_name_plural = _("Penalty Accounts")
class NotificationSound(models.Model):
from employee.models import Employee
employee = models.OneToOneField(
Employee, on_delete=models.CASCADE, related_name="notification_sound"
)
sound_enabled = models.BooleanField(default=False)
@receiver(post_save, sender=PenaltyAccounts)
def create_deduction_cutleave_from_penalty(sender, instance, created, **kwargs):
"""
This is post save method, used to create deduction and cut availabl leave days"""
# only work when creating
if created:
penalty_amount = instance.penalty_amount
if apps.is_installed("payroll") and penalty_amount:
Deduction = get_horilla_model_class(app_label="payroll", model="deduction")
penalty = Deduction()
if instance.late_early_id:
penalty.title = f"{instance.late_early_id.get_type_display()} penalty"
penalty.one_time_date = (
instance.late_early_id.attendance_id.attendance_date
)
elif instance.leave_request_id:
penalty.title = f"Leave penalty {instance.leave_request_id.end_date}"
penalty.one_time_date = instance.leave_request_id.end_date
else:
penalty.title = f"Penalty on {datetime.today()}"
penalty.one_time_date = datetime.today()
penalty.include_active_employees = False
penalty.is_fixed = True
penalty.amount = instance.penalty_amount
penalty.only_show_under_employee = True
penalty.save()
penalty.include_active_employees = False
penalty.specific_employees.add(instance.employee_id)
penalty.save()
if (
apps.is_installed("leave")
and instance.leave_type_id
and instance.minus_leaves
):
available = instance.employee_id.available_leave.filter(
leave_type_id=instance.leave_type_id
).first()
unit = round(instance.minus_leaves * 2) / 2
if not instance.deduct_from_carry_forward:
available.available_days = max(0, (available.available_days - unit))
else:
available.carryforward_days = max(
0, (available.carryforward_days - unit)
)
available.save()
# @receiver(post_delete, sender=PenaltyAccounts)
# def delete_deduction_cutleave_from_penalty(sender, instance, **kwargs):
# """
# This is a post delete method, used to delete deduction and update available leave days."""
# # Check if the deduction model is installed
# if apps.is_installed("payroll"):
# Deduction = get_horilla_model_class(app_label="payroll", model="deduction")
# # Assuming deductions are related to PenaltyAccounts by a foreign key or similar
# deductions = Deduction.objects.filter(specific_employees=instance.employee_id, amount=instance.penalty_amount)
# for deduction in deductions:
# deduction.delete()
# if apps.is_installed("leave") and instance.leave_type_id and instance.minus_leaves:
# available = instance.employee_id.available_leave.filter(
# leave_type_id=instance.leave_type_id
# ).first()
# if available:
# unit = round(instance.minus_leaves * 2) / 2
# if not instance.deduct_from_carry_forward:
# available.available_days += unit # Restore the deducted days
# else:
# available.carryforward_days += unit # Restore the deducted carryforward days
# available.save()
@receiver(post_delete, sender=PenaltyAccounts)
def delete_deduction_cutleave_from_penalty(sender, instance, **kwargs):
"""
This is a post delete method, used to delete the deduction and update available leave days.
"""
# Check if the deduction model is installed
if apps.is_installed("payroll"):
Deduction = get_horilla_model_class(app_label="payroll", model="deduction")
if instance.late_early_id:
title = f"{instance.late_early_id.get_type_display()} penalty"
elif instance.leave_request_id:
title = f"Leave penalty {instance.leave_request_id.end_date}"
else:
title = f"Penalty on {datetime.today()}"
# Attempt to retrieve the deduction specifically associated with the penalty account
deductions = Deduction.objects.filter(
specific_employees=instance.employee_id,
amount=instance.penalty_amount,
title=title,
)
# If you have a date or other unique field, add it to the filter
if instance.late_early_id:
deductions = deductions.filter(
one_time_date=instance.late_early_id.attendance_id.attendance_date
)
elif instance.leave_request_id:
deductions = deductions.filter(
one_time_date=instance.leave_request_id.end_date
)
else:
deductions = deductions.filter(one_time_date=datetime.today())
for deduction in deductions:
deduction.delete()
if apps.is_installed("leave") and instance.leave_type_id and instance.minus_leaves:
available = instance.employee_id.available_leave.filter(
leave_type_id=instance.leave_type_id
).first()
if available:
unit = round(instance.minus_leaves * 2) / 2
if not instance.deduct_from_carry_forward:
available.available_days += unit # Restore the deducted days
else:
available.carryforward_days += (
unit # Restore the deducted carryforward days
)
available.save()
User.add_to_class("is_new_employee", models.BooleanField(default=False))
Reference in New Issue View Git Blame Copy Permalink