cdircontent.hxx

/* Copyright (C) 2006-2024 J.F.Dockes
 *
 * 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; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * 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
 */
#ifndef _UPNPDIRCONTENT_H_X_INCLUDED_
#define _UPNPDIRCONTENT_H_X_INCLUDED_
 
#include <map>
#include <memory>
#include <sstream>
#include <string>
#include <utility>
#include <vector>
 
#include "libupnpp/upnpavutils.hxx"
 
namespace UPnPClient {
 
class UPNPP_API UPnPResource {
public:
    std::string m_uri;
 
    std::map<std::string, std::string> m_props;
 
    bool protoInfo(UPnPP::ProtocolinfoEntry& e) const {
        const auto it = m_props.find("protocolInfo");
        if (it == m_props.end()) {
            return false;
        }
        return UPnPP::parseProtoInfEntry(it->second, e);
    }
};
 
class UPNPP_API UPnPDirObject {
public:
 
    //  Types
 
    enum ObjType {objtnone = -1, item, container};
    // There are actually several kinds of containers: object.container.storageFolder,
    // object.container.person, object.container.playlistContainer etc., but they all seem to behave
    // the same as far as we're concerned. Otoh, musicTrack items are special to us, and so should
    // playlists, but I've not seen one of the latter yet (servers seem to use containers for
    // playlists).
    enum ItemClass {ITC_audioItem = 0, ITC_playlist = 1,
                    ITC_unknown = 2,
                    ITC_videoItem = 3,
                    ITC_audioItem_musicTrack = ITC_audioItem, // hist compat
                    ITC_audioItem_playlist = ITC_playlist // hist compat
                   };
 
    // Data fields
    
    std::string m_id;
    std::string m_pid;
    std::string m_title;
    ObjType m_type;
    ItemClass m_iclass;
 
    std::multimap<std::string, std::string> m_props;
 
    std::vector<UPnPResource> m_resources;
 
 
    // Methods
    
    bool getprop(const std::string& name, std::string& value) const;
 
    const std::string getprop(const std::string& name) const;
 
    const std::string& getupropref(const std::string& name) const;
 
    bool getRoledArtists(std::vector<std::pair<std::string, std::string>>& out) const;
    std::string getAlbumArtist() const;
    std::string getArtists() const;
    std::string getAlbumArtistElseArtists() const;
 
    bool getrprop(unsigned int ridx, const std::string& nm, std::string& val) const {
        if (ridx >= m_resources.size())
            return false;
        const auto it = m_resources[ridx].m_props.find(nm);
        if (it == m_resources[ridx].m_props.end())
            return false;
        val = it->second;
        return true;
    }
 
    std::string f2s(const std::string& nm, bool isresfield) {
        std::string val;
        if (isresfield) {
            getrprop(0, nm, val);
        } else {
            getprop(nm, val);
        }
        return val;
    }
 
    int getDurationSeconds(unsigned ridx = 0) const {
        std::string sdur;
        if (!getrprop(ridx, "duration", sdur)) {
            //?? Avoid returning 0, who knows...
            return 1;
        }
        return UPnPP::upnpdurationtos(sdur);
    }
 
    std::string getdidl() const;
 
    void clear() {
        m_id.clear();
        m_pid.clear();
        m_title.clear();
        m_type = objtnone;
        m_iclass = ITC_unknown;
        m_props.clear();
        m_resources.clear();
        m_didlfrag.clear();
    }
 
    std::string dump() const {
        std::ostringstream os;
        os << "UPnPDirObject: " << (m_type == item ? "item" : "container") << " id [" << m_id <<
            "] pid [" << m_pid << "] title [" << m_title << "]" << '\n';
        os << "Properties: " << '\n';
        for (const auto& m_prop : m_props) {
            os << "[" << m_prop.first << "]->[" << m_prop.second << "] " << '\n';
        }
        os << "Resources:" << '\n';
        for (const auto& m_resource : m_resources) {
            os << "  Uri [" << m_resource.m_uri << "]" << '\n';
            os << "  Resource attributes:" << '\n';
            for (const auto& m_prop : m_resource.m_props) {
                os << "    [" << m_prop.first << "]->[" << m_prop.second << "] " << '\n';
            }
        }
        os << '\n';
        return os.str();
    }
 
private:
    friend class UPnPDirParser;
    // DIDL text for element, sans header
    std::string m_didlfrag;
    static std::string nullstr;
};
 
class UPNPP_API UPnPDirContent {
public:
    std::vector<UPnPDirObject> m_containers;
    std::vector<UPnPDirObject> m_items;
 
    void clear() {
        m_containers.clear();
        m_items.clear();
    }
 
    bool parse(const std::string& didltext);
};
 
} // namespace
 
#endif /* _UPNPDIRCONTENT_H_X_INCLUDED_ */