/**
* @file llinventoryfilter.h
* @brief Support for filtering your inventory to only display a subset of the
* available items.
*
* $LicenseInfo:firstyear=2005&license=viewerlgpl$
* Second Life Viewer Source Code
* Copyright (C) 2010, Linden Research, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License only.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*
* Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
* $/LicenseInfo$
*/
#ifndef LLINVENTORYFILTER_H
#define LLINVENTORYFILTER_H

#include "llinventorytype.h"
#include "llpermissionsflags.h"
#include "llfolderviewmodel.h"

class LLFolderViewItem;
class LLFolderViewFolder;
class LLInventoryItem;

class LLInventoryFilter : public LLFolderViewFilter
{
public:
    enum EFolderShow
    {
        SHOW_ALL_FOLDERS,
        SHOW_NON_EMPTY_FOLDERS,
        SHOW_NO_FOLDERS
    };

    enum EFilterType
    {
        FILTERTYPE_NONE = 0,
        FILTERTYPE_OBJECT = 0x1 << 0,   // normal default search-by-object-type
        FILTERTYPE_CATEGORY = 0x1 << 1, // search by folder type
        FILTERTYPE_UUID = 0x1 << 2,     // find the object with UUID and any links to it
        FILTERTYPE_DATE = 0x1 << 3,     // search by date range
        FILTERTYPE_WEARABLE = 0x1 << 4, // search by wearable type
        FILTERTYPE_EMPTYFOLDERS = 0x1 << 5,     // pass if folder is not a system folder to be hidden if empty
        FILTERTYPE_MARKETPLACE_ACTIVE = 0x1 << 6,       // pass if folder is a marketplace active folder
        FILTERTYPE_MARKETPLACE_INACTIVE = 0x1 << 7,     // pass if folder is a marketplace inactive folder
        FILTERTYPE_MARKETPLACE_UNASSOCIATED = 0x1 << 8, // pass if folder is a marketplace non associated (no market ID) folder
        FILTERTYPE_MARKETPLACE_LISTING_FOLDER = 0x1 << 9,   // pass iff folder is a listing folder
        FILTERTYPE_NO_MARKETPLACE_ITEMS = 0x1 << 10,         // pass iff folder is not under the marketplace
        FILTERTYPE_WORN = 0x1 << 11,     // pass if item is worn
        FILTERTYPE_SETTINGS = 0x1 << 12,    // pass if the item is a settings object
    };

    enum EFilterDateDirection
    {
        FILTERDATEDIRECTION_NEWER,
        FILTERDATEDIRECTION_OLDER
    };

    enum EFilterLink
    {
        FILTERLINK_INCLUDE_LINKS,   // show links too
        FILTERLINK_EXCLUDE_LINKS,   // don't show links
        FILTERLINK_ONLY_LINKS       // only show links
    };

    enum EFilterThumbnail
    {
        FILTER_INCLUDE_THUMBNAILS,
        FILTER_EXCLUDE_THUMBNAILS,
        FILTER_ONLY_THUMBNAILS
    };

    enum ESortOrderType
    {
        SO_NAME = 0,                        // Sort inventory by name
        SO_DATE = 0x1,                      // Sort inventory by date
        SO_FOLDERS_BY_NAME = 0x1 << 1,      // Force folder sort by name
        SO_SYSTEM_FOLDERS_TO_TOP = 0x1 << 2,// Force system folders to be on top
        SO_FOLDERS_BY_WEIGHT = 0x1 << 3,    // Force folder sort by weight, usually, amount of some elements in their descendants
    };

    enum ESearchType
    {
        SEARCHTYPE_NAME,
        SEARCHTYPE_DESCRIPTION,
        SEARCHTYPE_CREATOR,
        SEARCHTYPE_UUID
    };

    enum EFilterCreatorType
    {
        FILTERCREATOR_ALL,
        FILTERCREATOR_SELF,
        FILTERCREATOR_OTHERS
    };

    enum ESearchVisibility
    {
        VISIBILITY_NONE = 0,
        VISIBILITY_TRASH = 0x1 << 0,
        VISIBILITY_LIBRARY = 0x1 << 1,
        VISIBILITY_LINKS    = 0x1 << 2,
        VISIBILITY_OUTFITS    = 0x1 << 3
    };

    struct FilterOps
    {
        struct DateRange : public LLInitParam::Block<DateRange>
        {
            Optional<time_t>    min_date,
                                max_date;

            DateRange()
            :   min_date("min_date", time_min()),
                max_date("max_date", time_max())
            {}

            bool validateBlock(bool emit_errors = true) const;
        };

        struct Params : public LLInitParam::Block<Params>
        {
            Optional<U32>               types,
                                        search_visibility;
            Optional<U64>               object_types,
                                        wearable_types,
                                        settings_types,
                                        category_types;

            Optional<EFilterLink>       links;
            Optional<LLUUID>            uuid;
            Optional<DateRange>         date_range;
            Optional<U32>               hours_ago;
            Optional<U32>               date_search_direction;
            Optional<EFolderShow>       show_folder_state;
            Optional<PermissionMask>    permissions;
            Optional<EFilterCreatorType> creator_type;
            Optional<EFilterThumbnail> thumbnails;

            Params()
            :   types("filter_types", FILTERTYPE_OBJECT),
                object_types("object_types", 0xffffFFFFffffFFFFULL),
                wearable_types("wearable_types", 0xffffFFFFffffFFFFULL),
                settings_types("settings_types", 0xffffFFFFffffFFFFULL),
                thumbnails("thumbnails", FILTER_INCLUDE_THUMBNAILS),
                category_types("category_types", 0xffffFFFFffffFFFFULL),
                links("links", FILTERLINK_INCLUDE_LINKS),
                search_visibility("search_visibility", 0xFFFFFFFF),
                uuid("uuid"),
                date_range("date_range"),
                hours_ago("hours_ago", 0),
                date_search_direction("date_search_direction", FILTERDATEDIRECTION_NEWER),
                show_folder_state("show_folder_state", SHOW_NON_EMPTY_FOLDERS),
                creator_type("creator_type", FILTERCREATOR_ALL),
                permissions("permissions", PERM_NONE)
            {}
        };

        FilterOps(const Params& = Params());

        U32             mFilterTypes,
                        mSearchVisibility;
        U64             mFilterObjectTypes,   // For _OBJECT
                        mFilterWearableTypes,
                        mFilterSettingsTypes, // for _SETTINGS
                        mFilterThumbnails,
                        mFilterLinks,
                        mFilterCategoryTypes; // For _CATEGORY
        LLUUID          mFilterUUID;          // for UUID

        time_t          mMinDate,
                        mMaxDate;
        U32             mHoursAgo;
        U32             mDateSearchDirection;

        EFolderShow     mShowFolderState;
        PermissionMask  mPermissions;
        EFilterCreatorType  mFilterCreatorType;
    };

    struct Params : public LLInitParam::Block<Params>
    {
        Optional<std::string>       name;
        Optional<FilterOps::Params> filter_ops;
        Optional<std::string>       substring;
        Optional<bool>              since_logoff;

        Params()
        :   name("name"),
            filter_ops(""),
            substring("substring"),
            since_logoff("since_logoff")
        {}
    };

    LLInventoryFilter(const Params& p = Params());
    LLInventoryFilter(const LLInventoryFilter& other) { *this = other; }
    virtual ~LLInventoryFilter() {}

    // +-------------------------------------------------------------------+
    // + Parameters
    // +-------------------------------------------------------------------+
    U64                 getFilterTypes() const;
    U64                 getFilterObjectTypes() const;
    U64                 getFilterCategoryTypes() const;
    U64                 getFilterWearableTypes() const;
    U64                 getFilterSettingsTypes() const;
    U64                 getSearchVisibilityTypes() const;
    U64                 getFilterThumbnails() const;

    bool                isFilterObjectTypesWith(LLInventoryType::EType t) const;
    void                setFilterObjectTypes(U64 types);
    void                setFilterCategoryTypes(U64 types);
    void                setFilterUUID(const LLUUID &object_id);
    void                setFilterWearableTypes(U64 types);
    void                setFilterSettingsTypes(U64 types);
    void                setFilterEmptySystemFolders();
    void                setFilterWorn();
    void                setFilterMarketplaceActiveFolders();
    void                setFilterMarketplaceInactiveFolders();
    void                setFilterMarketplaceUnassociatedFolders();
    void                setFilterMarketplaceListingFolders(bool select_only_listing_folders);
    void                setFilterNoMarketplaceFolder();
    void                setFilterThumbnails(U64 filter_thumbnails);
    void                updateFilterTypes(U64 types, U64& current_types);
    void                setSearchType(ESearchType type);
    ESearchType         getSearchType() { return mSearchType; }
    void                setFilterCreator(EFilterCreatorType type);

    void                toggleSearchVisibilityLinks();
    void                toggleSearchVisibilityTrash();
    void                toggleSearchVisibilityOutfits();
    void                toggleSearchVisibilityLibrary();
    void                setSearchVisibilityTypes(U32 types);
    void                setSearchVisibilityTypes(const Params& params);

    void                setFilterSubString(const std::string& string);
    const std::string&  getFilterSubString(bool trim = false) const;
    const std::string&  getFilterSubStringOrig() const { return mFilterSubStringOrig; }
    bool                hasFilterString() const;

    void                setSingleFolderMode(bool is_single_folder) { mSingleFolderMode = is_single_folder; }

    void                setFilterPermissions(PermissionMask perms);
    PermissionMask      getFilterPermissions() const;

    void                setDateRange(time_t min_date, time_t max_date);
    void                setDateRangeLastLogoff(bool sl);
    time_t              getMinDate() const;
    time_t              getMaxDate() const;

    void                setHoursAgo(U32 hours);
    U32                 getHoursAgo() const;
    void                setDateSearchDirection(U32 direction);
    U32                 getDateSearchDirection() const;

    void                setFilterLinks(U64 filter_link);
    U64                 getFilterLinks() const;

    // sets params for Link-only search and backs up search settings for future restoration
    void                setFindAllLinksMode(const std::string &search_name, const LLUUID& search_id);

    // +-------------------------------------------------------------------+
    // + Execution And Results
    // +-------------------------------------------------------------------+
    bool                check(const LLFolderViewModelItem* item);
    bool                check(const LLInventoryItem* item);
    bool                checkFolder(const LLFolderViewModelItem* item) const;
    bool                checkFolder(const LLUUID& folder_id) const;

    bool                showAllResults() const;

    std::string::size_type getStringMatchOffset(LLFolderViewModelItem* item) const;
    std::string::size_type getFilterStringSize() const;
    // +-------------------------------------------------------------------+
    // + Presentation
    // +-------------------------------------------------------------------+
    void                setShowFolderState( EFolderShow state);
    EFolderShow         getShowFolderState() const;
    EFilterCreatorType      getFilterCreatorType() const;

    void                setEmptyLookupMessage(const std::string& message);
    void                setDefaultEmptyLookupMessage(const std::string& message);
    std::string         getEmptyLookupMessage(bool is_empty_folder = false) const;

    // +-------------------------------------------------------------------+
    // + Status
    // +-------------------------------------------------------------------+
    bool                isActive() const;
    bool                isModified() const;
    bool                isSinceLogoff() const;
    void                clearModified();
    const std::string&  getName() const { return mName; }
    const std::string&  getFilterText();
    //RN: this is public to allow system to externally force a global refilter
    void                setModified(EFilterModified behavior = FILTER_RESTART);

    // +-------------------------------------------------------------------+
    // + Time
    // +-------------------------------------------------------------------+
    void                resetTime(S32 timeout);
    bool                isTimedOut();

    // +-------------------------------------------------------------------+
    // + Default
    // +-------------------------------------------------------------------+
    bool                isDefault() const;
    bool                isNotDefault() const;
    void                markDefault();
    void                resetDefault();

    // +-------------------------------------------------------------------+
    // + Generation
    // +-------------------------------------------------------------------+
    S32                 getCurrentGeneration() const;
    S32                 getFirstSuccessGeneration() const;
    S32                 getFirstRequiredGeneration() const;


    // +-------------------------------------------------------------------+
    // + Conversion
    // +-------------------------------------------------------------------+
    void                toParams(Params& params) const;
    void                fromParams(const Params& p);

    LLInventoryFilter& operator =(const LLInventoryFilter& other);

    bool checkAgainstFilterThumbnails(const LLUUID& object_id) const;

private:
    bool                areDateLimitsSet() const;
    bool                checkAgainstFilterSubString(const std::string& desc) const;
    bool                checkAgainstFilterType(const class LLFolderViewModelItemInventory* listener) const;
    bool                checkAgainstFilterType(const LLInventoryItem* item) const;
    bool                checkAgainstPermissions(const class LLFolderViewModelItemInventory* listener) const;
    bool                checkAgainstPermissions(const LLInventoryItem* item) const;
    bool                checkAgainstFilterLinks(const class LLFolderViewModelItemInventory* listener) const;
    bool                checkAgainstCreator(const class LLFolderViewModelItemInventory* listener) const;
    bool                checkAgainstSearchVisibility(const class LLFolderViewModelItemInventory* listener) const;
    bool                checkAgainstClipboard(const LLUUID& object_id) const;

    FilterOps               mFilterOps;
    FilterOps               mDefaultFilterOps;
    FilterOps               mBackupFilterOps; // for backup purposes when leaving 'search link' mode

    std::string             mFilterSubString;
    std::string             mFilterSubStringOrig;
    std::string             mUsername;
    const std::string       mName;

    S32                     mCurrentGeneration;
    // The following makes checking for pass/no pass possible even if the item is not checked against the current generation
    // Any item that *did not pass* the "required generation" will *not pass* the current one
    // Any item that *passes* the "success generation" will *pass* the current one
    S32                     mFirstRequiredGeneration;
    S32                     mFirstSuccessGeneration;

    EFilterModified         mFilterModified;
    LLTimer                 mFilterTime;

    std::string             mFilterText;
    std::string             mEmptyLookupMessage;
    std::string             mDefaultEmptyLookupMessage;

    ESearchType             mSearchType;

    std::vector<std::string> mFilterTokens;
    std::string              mExactToken;

    bool mSingleFolderMode;
};

#endif