src/eric7/Tasks/TaskFilter.py

# -*- coding: utf-8 -*-

# Copyright (c) 2005 - 2024 Detlev Offenbach <detlev@die-offenbachs.de>
#

"""
Module implementing a class to store task data.
"""

import fnmatch
import re

from .Task import TaskType


class TaskFilter:
    """
    Class implementing a filter for tasks.
    """

    def __init__(self):
        """
        Constructor
        """
        self.active = False

        self.summaryFilter = None
        self.filenameFilter = ""
        self.typeFilter = TaskType.NONE
        # task type

        self.scopeFilter = None
        # - global (False) or project (True)

        self.statusFilter = None
        # - not completed (False) or completed (True)

        self.prioritiesFilter = None
        # - list of priorities

    def setActive(self, enabled):
        """
        Public method to activate the filter.

        @param enabled flag indicating the activation state
        @type bool
        """
        self.active = enabled

    def setSummaryFilter(self, filterStr):
        """
        Public method to set the description filter.

        @param filterStr a regular expression for the description filter to set
        @type str
        """
        if not filterStr:
            self.summaryFilter = None
        else:
            self.summaryFilter = re.compile(filterStr)

    def setFileNameFilter(self, filterStr):
        """
        Public method to set the filename filter.

        @param filterStr a wildcard expression for the filename filter to set
        @type str
        """
        self.filenameFilter = filterStr

    def setTypeFilter(self, taskType):
        """
        Public method to set the type filter.

        @param taskType type of the task
        @type TaskType
        """
        self.typeFilter = taskType

    def setScopeFilter(self, scope):
        """
        Public method to set the scope filter.

        @param scope flag indicating a project task
        @type bool
        """
        self.scopeFilter = scope

    def setStatusFilter(self, status):
        """
        Public method to set the status filter.

        @param status flag indicating a completed task
        @type bool
        """
        self.statusFilter = status

    def setPrioritiesFilter(self, priorities):
        """
        Public method to set the priorities filter.

        @param priorities list of task priorities or None
        @type list of TaskPriority or None
        """
        self.prioritiesFilter = priorities

    def hasActiveFilter(self):
        """
        Public method to check for active filters.

        @return flag indicating an active filter was found
        @rtype bool
        """
        return (
            self.summaryFilter is not None
            or bool(self.filenameFilter)
            or self.typeFilter != TaskType.NONE
            or self.scopeFilter is not None
            or self.statusFilter is not None
            or self.prioritiesFilter is not None
        )

    def showTask(self, task):
        """
        Public method to check, if a task should be shown.

        @param task reference to the task object to check
        @type Task
        @return flag indicating whether the task should be shown
        @rtype bool
        """
        if not self.active:
            return True

        if self.summaryFilter and self.summaryFilter.search(task.summary) is None:
            return False

        if self.filenameFilter and not fnmatch.fnmatch(
            task.filename, self.filenameFilter
        ):
            return False

        if self.typeFilter != TaskType.NONE and self.typeFilter != task.taskType:
            return False

        if self.scopeFilter is not None and self.scopeFilter != task._isProjectTask:
            return False

        if self.statusFilter is not None and self.statusFilter != task.completed:
            return False

        if (
            self.prioritiesFilter is not None
            and task.priority not in self.prioritiesFilter
        ):
            return False

        return True