""" dashboard.py This module is used to register endpoints for dashboard-related requests """ import json from datetime import date, datetime from django.apps import apps from django.http import JsonResponse from django.shortcuts import render from django.utils.translation import gettext_lazy as _ from attendance.filters import ( AttendanceFilters, AttendanceOverTimeFilter, LateComeEarlyOutFilter, ) from attendance.methods.utils import ( get_month_start_end_dates, get_week_start_end_dates, pending_hour_data, worked_hour_data, ) from attendance.models import ( Attendance, AttendanceLateComeEarlyOut, AttendanceValidationCondition, ) from attendance.views.views import strtime_seconds from base.methods import filtersubordinates, paginator_qry from base.models import Department from employee.models import Employee from horilla import settings from horilla.decorators import hx_request_required, login_required from horilla.methods import get_horilla_model_class def find_on_time(request, today, week_day, department=None): """ This method is used to find count for on time attendances """ on_time = 0 attendances = Attendance.objects.filter(attendance_date=today) if department is not None: attendances = attendances.filter( employee_id__employee_work_info__department_id=department ) late_come = AttendanceLateComeEarlyOut.objects.filter( attendance_id__attendance_date=today, type="late_come" ) on_time = len(attendances) - len(late_come) return on_time def find_expected_attendances(week_day): """ This method is used to find count of expected attendances for the week day """ employees = Employee.objects.filter(is_active=True) if apps.is_installed("leave"): LeaveRequest = get_horilla_model_class(app_label="leave", model="leaverequest") on_leave = LeaveRequest.objects.filter(status="Approved") else: on_leave = [] expected_attendances = len(employees) - len(on_leave) return expected_attendances @login_required def dashboard(request): """ This method is used to render individual dashboard for attendance module """ today = datetime.today() week_day = today.strftime("%A").lower() on_time = find_on_time(request, today=today, week_day=week_day) late_come = find_late_come(start_date=today) late_come_obj = len(late_come) marked_attendances = late_come_obj + on_time expected_attendances = find_expected_attendances(week_day=week_day) on_time_ratio = 0 late_come_ratio = 0 marked_attendances_ratio = 0 if expected_attendances != 0: on_time_ratio = f"{(on_time / expected_attendances) * 100:.2f}" late_come_ratio = f"{(late_come_obj / expected_attendances) * 100:.2f}" marked_attendances_ratio = ( f"{(marked_attendances / expected_attendances) * 100:.2f}" ) return render( request, "attendance/dashboard/dashboard.html", { "on_time": on_time, "on_time_ratio": on_time_ratio, "late_come": late_come_obj, "late_come_ratio": late_come_ratio, "expected_attendances": expected_attendances, "marked_attendances": marked_attendances, "marked_attendances_ratio": marked_attendances_ratio, }, ) @login_required @hx_request_required def on_break_employees(request): """ Fetches and displays employees who left early (early outs) for the current day. This view retrieves all records from the `AttendanceLateComeEarlyOut` model where the type is "early_out" and the associated attendance date matches the current date. The results are passed to the template `on_break_employees.html` for rendering """ today = datetime.today() early_outs = AttendanceLateComeEarlyOut.objects.filter( type="early_out", attendance_id__attendance_date=today ) context = { "on_break": early_outs, } return render(request, "attendance/dashboard/on_break_employees.html", context) @login_required @hx_request_required def dashboard_approve_overtimes(request): """ Displays and validates employee overtime records for the dashboard. This view retrieves a paginated list of employee attendance records with overtime that meets or exceeds a specified minimum threshold, which is defined in the `AttendanceValidationCondition` model. Only records that are validated but not yet approved are included, and the results are filtered based on the user's subordinate permissions. """ main_dashboard = None referer = request.META.get("HTTP_REFERER", "/") referer = "/" + "/".join(referer.split("/")[3:]) if referer == "/": main_dashboard = True page_number = request.GET.get("page") condition = AttendanceValidationCondition.objects.first() min_ot = strtime_seconds("00:00") if condition is not None and condition.minimum_overtime_to_approve is not None: min_ot = strtime_seconds(condition.minimum_overtime_to_approve) ot_attendances = Attendance.objects.filter( overtime_second__gte=min_ot, attendance_validated=True, employee_id__is_active=True, attendance_overtime_approve=False, ) ot_attendances = filtersubordinates( request=request, perm="attendance.change_overtime", queryset=ot_attendances, ) id_list = [ot.id for ot in ot_attendances] ot_attendances_ids = json.dumps(list(id_list)) ot_attendances = paginator_qry(ot_attendances, page_number) context = { "overtime_attendances": ot_attendances, "ot_attendances_ids": ot_attendances_ids, "main_dashboard": main_dashboard, } return render(request, "attendance/dashboard/overtime_table.html", context) @login_required @hx_request_required def dashboard_validate_attendances(request): """ Displays and validates employee attendance records for the dashboard. This view retrieves a paginated list of attendance records that have not yet been validated. Only records belonging to active employees and accessible subordinates, as determined by the user's permissions, are included in the results. """ main_dashboard = None referer = request.META.get("HTTP_REFERER", "/") referer = "/" + "/".join(referer.split("/")[3:]) if referer == "/": main_dashboard = True page_number = request.GET.get("page") validate_attendances = Attendance.objects.filter( attendance_validated=False, employee_id__is_active=True ) validate_attendances = filtersubordinates( request=request, perm="attendance.change_overtime", queryset=validate_attendances, ) validate_id_list = [val.id for val in validate_attendances] validate_attendances_ids = json.dumps(list(validate_id_list)) validate_attendances = paginator_qry(validate_attendances, page_number) context = { "validate_attendances": validate_attendances, "validate_attendances_ids": validate_attendances_ids, "main_dashboard": main_dashboard, } return render(request, "attendance/dashboard/to_validate_table.html", context) def total_attendance(start_date, department, end_date=None): """ This method is used to find total attendance """ attendance = AttendanceFilters( { "attendance_date__gte": start_date, "attendance_date__lte": end_date, "department": department, } ).qs return attendance def find_late_come(start_date, department=None, end_date=None): """ This method is used to find late comers """ if department is not None: late_come_obj = LateComeEarlyOutFilter( { "type": "late_come", "department": department, "attendance_date__gte": start_date, "attendance_date__lte": end_date, } ).qs else: late_come_obj = LateComeEarlyOutFilter( { "type": "late_come", "attendance_date__gte": start_date, "attendance_date__lte": end_date, } ).qs return late_come_obj def find_early_out(start_date, end_date=None, department=None): """ This method is used to find early out attendances and it returns query set """ if department is not None: early_out_obj = LateComeEarlyOutFilter( { "type": "early_out", "department": department, "attendance_date__gte": start_date, "attendance_date__lte": end_date, } ).qs else: early_out_obj = LateComeEarlyOutFilter( { "type": "early_out", "attendance_date__gte": start_date, "attendance_date__lte": end_date, } ).qs return early_out_obj def generate_data_set(request, start_date, type, end_date, dept): """ This method is used to generate all the dashboard data """ attendance = [] late_come_obj = [] early_out_obj = [] on_time = 0 if type == "day": start_date = start_date end_date = start_date if type == "weekly": start_date, end_date = get_week_start_end_dates(start_date) if type == "monthly": start_date, end_date = get_month_start_end_dates(start_date) if type == "date_range": start_date = start_date end_date = end_date # below method will find all the on-time attendance corresponding to the # employee shift and shift schedule. attendance = total_attendance( start_date=start_date, department=dept, end_date=end_date ) # below method will find all the late-come attendance corresponding to the # employee shift and schedule. late_come_obj = find_late_come( start_date=start_date, department=dept, end_date=end_date ) # below method will find all the early-out attendance corresponding to the # employee shift and shift schedule early_out_obj = find_early_out( department=dept, start_date=start_date, end_date=end_date ) on_time = len(attendance) - len(late_come_obj) data = {} if on_time or late_come_obj or early_out_obj: data = { "label": dept.department, "data": [on_time, len(late_come_obj), len(early_out_obj)], } return data if data else None @login_required def dashboard_attendance(request): """ This method is used to render json response of dashboard data Returns: JsonResponse: returns data set as json """ labels = [ _("On Time"), _("Late Come"), _("Early Out"), ] # initializing values data_set = [] start_date = date.today() end_date = start_date type = "date" # if there is values in request update the values if request.GET.get("date"): start_date = request.GET.get("date") if request.GET.get("type"): type = request.GET.get("type") if request.GET.get("end_date"): end_date = request.GET.get("end_date") # get all departments for filtration departments = Department.objects.all() for dept in departments: data_set.append(generate_data_set(request, start_date, type, end_date, dept)) message = _("No records available at the moment.") data_set = list(filter(None, data_set)) return JsonResponse({"dataSet": data_set, "labels": labels, "message": message}) def pending_hours(request): """ pending hours chart dashboard view """ records = AttendanceOverTimeFilter(request.GET).qs labels = list(Department.objects.values_list("department", flat=True)) data = { "labels": labels, "datasets": [ pending_hour_data(labels, records), worked_hour_data(labels, records), ], } return JsonResponse({"data": data}) @login_required def department_overtime_chart(request): start_date = request.GET.get("date") if request.GET.get("date") else date.today() chart_type = request.GET.get("type") if request.GET.get("type") else "day" end_date = ( request.GET.get("end_date") if request.GET.get("end_date") else start_date ) if chart_type == "day": start_date = start_date end_date = start_date if chart_type == "weekly": start_date, end_date = get_week_start_end_dates(start_date) if chart_type == "monthly": start_date, end_date = get_month_start_end_dates(start_date) if chart_type == "date_range": start_date = start_date end_date = end_date attendance = total_attendance( start_date=start_date, department=None, end_date=end_date ) condition = AttendanceValidationCondition.objects.first() min_ot = strtime_seconds("00:00") if condition is not None and condition.minimum_overtime_to_approve is not None: min_ot = strtime_seconds(condition.minimum_overtime_to_approve) attendances = attendance.filter( overtime_second__gte=min_ot, attendance_validated=True, employee_id__is_active=True, attendance_overtime_approve=True, ) departments = [] department_total = [] for attendance in attendances: if ( attendance.employee_id and attendance.employee_id.employee_work_info and attendance.employee_id.employee_work_info.department_id ): departments.append( attendance.employee_id.employee_work_info.department_id.department ) departments = list(set(departments)) for depart in departments: department_total.append({"department": depart, "ot_hours": 0}) for attendance in attendances: if attendance.employee_id.employee_work_info.department_id: department = ( attendance.employee_id.employee_work_info.department_id.department ) ot = attendance.approved_overtime_second ot_hrs = ot / 3600 for depart in department_total: if depart["department"] == department: depart["ot_hours"] += ot_hrs dataset = [ { "label": "", "data": [], } ] for depart_total, depart in zip(department_total, departments): if depart == depart_total["department"]: dataset[0]["data"].append(depart_total["ot_hours"]) response = { "dataset": dataset, "labels": departments, "department_total": department_total, "message": _("No validated Overtimes were found"), "emptyImageSrc": f"/{settings.STATIC_URL}images/ui/overtime-icon.png", } return JsonResponse(response)