src/cds/cds_objects.h

Rama master · réplica de lectura del repositorio original.

/*MT*

    MediaTomb - http://www.mediatomb.cc/

    cds_objects.h - this file is part of MediaTomb.

    Copyright (C) 2005 Gena Batyan <bgeradz@mediatomb.cc>,
                       Sergey 'Jin' Bostandzhyan <jin@mediatomb.cc>

    Copyright (C) 2006-2010 Gena Batyan <bgeradz@mediatomb.cc>,
                            Sergey 'Jin' Bostandzhyan <jin@mediatomb.cc>,
                            Leonhard Wimmer <leo@mediatomb.cc>

    Copyright (C) 2016-2026 Gerbera Contributors

    MediaTomb is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License version 2
    as published by the Free Software Foundation.

    MediaTomb 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    version 2 along with MediaTomb; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.

    $Id$
*/

/// @file cds/cds_objects.h
/// @brief Definition for the CdsObject base class.
#ifndef __CDS_OBJECTS_H__
#define __CDS_OBJECTS_H__

#include "cds_resource.h"
#include "common.h"
#include "metadata/metadata_enums.h"
#include "util/enum_iterator.h"
#include "util/grb_fs.h"

#include <algorithm>
#include <map>
#include <memory>
#include <vector>

/// @brief allow identification of user created objects
enum class ObjectSource : int {
    /// @brief object was automatically created
    Import,
    /// @brief user modified object after import
    ImportModified,
    /// @brief user created object
    User,
};

/// @brief tag the object with its type
enum class CdsEntryType : int {
    /// @brief the object was not yet defined
    Unset = -1,
    /// @brief the root object
    Root,
    /// @brief the object was created from a directory on disk
    Directory,
    /// @brief the object was created from a file on disk
    File,
    /// @brief the container tree was created as part of the virtual layout
    VirtualContainer,
    /// @brief the item was created as part of the virtual layout
    VirtualItem,
    /// @brief Url pointing to some web stream
    ExternalUrl,
    /// @brief Dynamic folder pointing to some search
    DynamicFolder,
    /// @brief the object was created based on a file used in a cuesheet etc
    ExtraFile,
    /// @brief the object was created based on a file used in a cuesheet etc
    ExtraDirectory,
    /// @brief the object was created based on a playlist file
    PlaylistContainer,
    /// @brief last entry for interator
    MAX,
};

/// @brief Artwork sources that can be ordered for containers.
enum class ArtworkSource {
    None,
    Embedded,
    Preview,
    Pattern,
    External,
};

/// @brief Generic object in the Content Directory.
class CdsObject {
protected:
    /// @brief ID of the object in the content directory
    int id { INVALID_OBJECT_ID };

    /// @brief ID of the referenced object
    int refID { INVALID_OBJECT_ID };

    /// @brief ID of the object's parent
    int parentID { INVALID_OBJECT_ID };

    /// @brief dc:title
    std::string title;

    /// @brief upnp:class
    std::string upnpClass;

    /// @brief Physical location of the media.
    fs::path location;

    /// @brief Last modification time in the file system.
    /// In seconds since UNIX epoch.
    std::chrono::seconds mtime = std::chrono::seconds::zero();

    /// @brief Last update time in database
    /// In seconds since UNIX epoch.
    std::chrono::seconds utime = std::chrono::seconds::zero();

    /// @brief File size on disk (in bytes).
    std::uintmax_t sizeOnDisk {};

    /// @brief virtual object flag
    bool virt {};

    /// @brief type of the object: item, container, etc.
    unsigned int objectType { 0 };

    /// @brief field which can hold various flags for the object
    unsigned int objectFlags { getFlag(ObjectFlag::Restricted) };

    /// @brief property that allows to sort objects within a container
    std::string sortKey;

    /// @brief where does the object come from
    ObjectSource source { ObjectSource::Import };

    /// @brief type of database entry
    CdsEntryType entryType { CdsEntryType::Unset };

    /// @brief metadata of object defined by UPnP protocol
    std::vector<std::pair<std::string, std::string>> metaData;

    /// @brief additional metadata with no relation to UPnP
    std::map<std::string, std::string> auxdata;

    /// logical or physical components assigned to object
    std::vector<std::shared_ptr<CdsResource>> resources;

    /// @brief reference to parent, transporting details from import script
    std::shared_ptr<CdsObject> parent;

public:
    explicit CdsObject(CdsEntryType type)
        : entryType(type) {};
    virtual ~CdsObject() = default;

    CdsObject(const CdsObject&) = delete;
    CdsObject& operator=(const CdsObject&) = delete;

    /// @brief Set the object ID.
    ///
    /// ID is the object ID that is used by the UPnP Content Directory service.
    void setID(int id) { this->id = id; }

    /// @brief Retrieve the object ID.
    ///
    /// ID is the object ID that is used by the UPnP Content Directory service.
    int getID() const { return id; }

    /// @brief Set the reference object ID.
    ///
    /// This is the reference ID that is used by the UPnP Content Directory service.
    /// It also links the reference and the original objects in the database.
    void setRefID(int refID) { this->refID = refID; }

    /// @brief Retrieve the reference object ID.
    ///
    /// This is the reference ID that is used by the UPnP Content Directory service.
    /// It also links the reference and the original objects in the database.
    int getRefID() const { return refID; }

    /// @brief Set the parent ID of the object.
    void setParentID(int parentID) { this->parentID = parentID; }
    void setParent(const std::shared_ptr<CdsObject>& parent) { this->parent = parent; }

    /// @brief Retrieve the objects parent ID.
    int getParentID() const { return parentID; }

    /// @brief Set the restricted flag.
    void setRestricted(bool restricted) { changeFlag(ObjectFlag::Restricted, restricted); }
    /// @brief Query the restricted flag.
    bool isRestricted() const { return hasFlag(ObjectFlag::Restricted); }

    /// @brief Set the object title (dc:title)
    void setTitle(const std::string& title)
    {
        this->title = title;
        if (this->sortKey.empty())
            this->sortKey = title;
    }
    /// @brief Retrieve the title.
    std::string getTitle() const { return title; }

    // @brief Set the object sortKey
    void setSortKey(const std::string& sortKey)
    {
        if (!sortKey.empty())
            this->sortKey = sortKey;
    }
    /// @brief Retrieve the sortKey.
    std::string getSortKey() const { return sortKey; }

    /// @brief set the upnp:class
    void setClass(const std::string& upnpClass) { this->upnpClass = upnpClass; }
    /// @brief Retrieve class
    std::string getClass() const { return upnpClass; }
    bool isSubClass(const std::string& cls) const;
    ObjectType getMediaType(const std::string& contentType = "") const;

    /// @brief Returns the media type of a non-external audio or video item, or Unknown.
    ObjectType getArtworkMediaType() const;

    /// @brief Whether this object is an audio, video or image item.
    bool isMediaItem() const;

    /// @brief Set the physical location of the media (usually an absolute path)
    void setLocation(const fs::path& location, CdsEntryType type)
    {
        this->location = location;
        this->entryType = type;
    }
    /// @brief Retrieve media location.
    const fs::path& getLocation() const { return location; }

    /// @brief Set modification time of the media file.
    void setMTime(std::chrono::seconds mtime) { this->mtime = mtime; }
    /// @brief Retrieve the file modification time (in seconds since UNIX epoch).
    std::chrono::seconds getMTime() const { return mtime; }

    /// @brief Set update time of the database entry.
    void setUTime(std::chrono::seconds utime) { this->utime = utime; }
    /// @brief Retrieve the database entry update time (in seconds since UNIX epoch).
    std::chrono::seconds getUTime() const { return utime; }

    /// @brief Set file size.
    void setSizeOnDisk(std::uintmax_t sizeOnDisk) { this->sizeOnDisk = sizeOnDisk; }
    /// @brief Retrieve the file size (in bytes).
    std::uintmax_t getSizeOnDisk() const { return sizeOnDisk; }

    /// @brief Set the virtual flag.
    void setVirtual(bool virt) { this->virt = virt; }
    /// @brief Query the virtual flag.
    bool isVirtual() const { return virt; }

    /// @brief Set the source
    void setSource(ObjectSource source)
    {
        if (source > this->source)
            this->source = source;
    }
    /// @brief Query the source
    ObjectSource getSource() const { return source; }

    /// @brief Set the entry type
    void setEntryType(CdsEntryType type) { this->entryType = type; }
    /// @brief Query the entry type
    CdsEntryType getEntryType() const { return entryType; }

    /// @brief Query information on object type: item, container, etc.
    unsigned int getObjectType() const { return objectType; }
    bool isItem() const { return isPureItem() || isExternalItem(); }
    bool isPureItem() const { return entryType == CdsEntryType::File || entryType == CdsEntryType::VirtualItem || entryType == CdsEntryType::ExtraFile; }
    bool isExternalItem() const { return entryType == CdsEntryType::ExternalUrl; }
    bool isContainer() const { return entryType == CdsEntryType::Directory || entryType == CdsEntryType::VirtualContainer || entryType == CdsEntryType::DynamicFolder || entryType == CdsEntryType::ExtraDirectory || entryType == CdsEntryType::PlaylistContainer; }

    /// @brief Get flags of an object.
    unsigned int getFlags() const { return objectFlags; }

    /// @brief Set flags for the object.
    void setFlags(unsigned int objectFlags) { this->objectFlags = objectFlags; }

    /// @brief Get a flag of an object.
    bool hasFlag(ObjectFlag flag) const { return objectFlags & getFlag(flag); }

    /// @brief Reset flags for the object.
    void resetFlags() { this->objectFlags = 0; }

    /// @brief Set a flag of the object.
    void setFlag(ObjectFlag flag) { objectFlags |= getFlag(flag); }

    /// @brief Set a flag of the object.
    void changeFlag(ObjectFlag flag, bool value)
    {
        if (value)
            setFlag(flag);
        else
            clearFlag(flag);
    }

    /// @brief Clears a flag of the object.
    void clearFlag(ObjectFlag flag) { objectFlags &= ~(getFlag(flag)); }

    /// @brief Query single metadata value.
    std::string getMetaData(MetadataFields key) const
    {
        auto field = MetaEnumMapper::getMetaFieldName(key);
        return this->getMetaData(field);
    }
    /// @brief Query single metadata value.
    std::string getMetaData(const std::string& field) const
    {
        auto it = std::find_if(metaData.begin(), metaData.end(), [=](auto&& md) { return md.first == field; });
        return it != metaData.end() ? it->second : std::string();
    }
    /// @brief Query multivalue metadata.
    std::vector<std::string> getMetaGroup(MetadataFields key) const
    {
        auto field = MetaEnumMapper::getMetaFieldName(key);
        return this->getMetaGroup(field);
    }
    /// @brief Query multivalue metadata.
    std::vector<std::string> getMetaGroup(const std::string& field) const
    {
        std::vector<std::string> metaGroup;
        for (auto&& [mkey, mvalue] : metaData) {
            if (mkey != field)
                continue;
            metaGroup.push_back(mvalue);
        }
        return metaGroup;
    }
    /// @brief Query multivalue metadata groups.
    std::map<std::string, std::vector<std::string>> getMetaGroups() const
    {
        std::map<std::string, std::vector<std::string>> metaGroups;
        for (auto&& [mkey, mvalue] : metaData) {
            auto& vec = metaGroups.try_emplace(mkey).first->second;
            vec.push_back(mvalue);
        }
        return metaGroups;
    }

    /// @brief Query entire metadata dictionary.
    const std::vector<std::pair<std::string, std::string>>& getMetaData() const { return metaData; }
    void clearMetaData() { metaData.clear(); }

    /// @brief Set entire metadata dictionary.
    void setMetaData(std::vector<std::pair<std::string, std::string>> metaData)
    {
        this->metaData = std::move(metaData);
    }

    /// @brief Add a single metadata value.
    void addMetaData(MetadataFields key, const std::string& value)
    {
        if (mt_single.at(key))
            removeMetaData(key);
        metaData.emplace_back(MetaEnumMapper::getMetaFieldName(key), value);
    }
    /// @brief Add a single metadata value.
    void addMetaData(const std::string& key, const std::string& value)
    {
        metaData.emplace_back(key, value);
    }

    /// @brief Removes metadata with the given key
    void removeMetaData(MetadataFields key)
    {
        metaData.erase(std::remove_if(metaData.begin(), metaData.end(), [field = MetaEnumMapper::getMetaFieldName(key)](auto&& md) { return md.first == field; }), metaData.end());
    }

    /// @brief Removes metadata with the given key
    void removeMetaData(const std::string& key)
    {
        metaData.erase(std::remove_if(metaData.begin(), metaData.end(), [field = key](auto&& md) { return md.first == field; }), metaData.end());
    }

    /// @brief Query single auxdata value.
    std::string getAuxData(const std::string& key) const;

    /// @brief Query entire auxdata dictionary.
    const std::map<std::string, std::string>& getAuxData() const { return auxdata; }
    void clearAuxData() { auxdata.clear(); }

    /// @brief Set a single auxdata value.
    void setAuxData(const std::string& key, const std::string& value)
    {
        auxdata[key] = value;
    }

    /// @brief Set entire auxdata dictionary.
    void setAuxData(const std::map<std::string, std::string>& auxdata)
    {
        this->auxdata = auxdata;
    }

    /// @brief Get number of resource tags
    std::size_t getResourceCount() const { return resources.size(); }

    /// @brief Query resources
    const std::vector<std::shared_ptr<CdsResource>>& getResources() const
    {
        return resources;
    }
    void clearResources() { resources.clear(); }

    /// @brief Set resources
    void setResources(std::vector<std::shared_ptr<CdsResource>> res)
    {
        resources = std::move(res);
    }

    /// @brief Search resources for given handler id
    bool hasResource(ContentHandler id) const
    {
        return std::any_of(resources.begin(), resources.end(), [=](auto&& res) { return id == res->getHandlerType(); });
    }

    /// @brief Remove resource with given handler id
    void removeResource(ContentHandler id)
    {
        auto index = std::find_if(resources.begin(), resources.end(), [=](auto&& res) { return id == res->getHandlerType(); });
        if (index != resources.end()) {
            resources.erase(index);
        }
    }

    /// @brief Query resource tag with the given index
    std::shared_ptr<CdsResource> getResource(int index) const
    {
        auto res = std::find_if(resources.begin(), resources.end(), [index](auto&& r) { return r->getResId() == index; });
        return res != resources.end() ? *res : nullptr;
    }

    /// @brief Query resource tag with the given handler id
    std::shared_ptr<CdsResource> getResource(ContentHandler id) const
    {
        auto it = std::find_if(resources.begin(), resources.end(), [=](auto&& res) { return id == res->getHandlerType(); });
        if (it != resources.end()) {
            return *it;
        }
        return {};
    }

    /// @brief Query resource tag with the given purpose
    std::shared_ptr<CdsResource> getResource(ResourcePurpose purpose) const
    {
        auto it = std::find_if(resources.begin(), resources.end(), [=](auto&& res) { return purpose == res->getPurpose(); });
        if (it != resources.end()) {
            return *it;
        }
        return {};
    }

    /// @brief Returns the first embedded cover or generated preview matching the source.
    std::shared_ptr<CdsResource> getArtwork(ArtworkSource source) const;

    /// @brief Query resource attribute with the given value
    std::shared_ptr<CdsResource> getResource(ResourceAttribute attrib, const std::string& value) const
    {
        auto it = std::find_if(resources.begin(), resources.end(), [=](auto&& res) { return value == res->getAttributeValue(attrib); });
        if (it != resources.end()) {
            return *it;
        }
        return {};
    }

    /// @brief Add resource tag
    void addResource(const std::shared_ptr<CdsResource>& resource)
    {
        resource->setResId(resources.size());
        resources.push_back(resource);
    }

    /// @brief Copies all object properties to another object.
    /// @param obj target object (clone)
    virtual void copyTo(const std::shared_ptr<CdsObject>& obj);

    /// @brief Checks if current object is equal to obj.
    /// @param obj object to check against
    /// @param exactly tells to check really everything or only the "public" version
    ///
    /// The difference between setting this flag to true or false is following:
    /// exactly=true checks all fields, also internal ones, exactly=false checks
    /// only the fields that will be visible in DIDL-Lite
    virtual bool equals(const std::shared_ptr<CdsObject>& obj, bool exactly = false) const;

    /// @brief Checks if current object has the same resources as obj
    /// @param obj object to check against
    bool resourcesEqual(const std::shared_ptr<CdsObject>& obj) const;

    /// @brief Checks if the minimum required parameters for the object have been set and are valid.
    virtual void validate() const;

    /// @brief factory method to create correct sub class
    static std::shared_ptr<CdsObject> createObject(unsigned int objectType);
    static std::shared_ptr<CdsObject> createObject(CdsEntryType entryType);

    static std::string mapObjectType(unsigned int type);
    static unsigned int remapObjectType(const std::string& type);

    static std::string mapEntryType(CdsEntryType type);
    static CdsEntryType remapEntryType(const std::string& type);

    static std::string mapFlags(unsigned int flags);
    static std::string mapFlag(ObjectFlag flag);
    static unsigned int remapFlags(const std::string& flag);
    static unsigned int makeFlag(const std::string& optValue);
    static unsigned int getFlag(ObjectFlag flag);

    static std::string mapSource(ObjectSource source);
    static ObjectSource remapSource(const std::string& source);
};

using EntryTypeIterator = EnumIterator<CdsEntryType, CdsEntryType::Root, CdsEntryType::MAX>;

#endif // __CDS_OBJECTS_H__