Open Source Projects Europe

/// Service/Environment interface for media server modules

class CDPluginServices {

public:

    /// Returns the plugin to which belongs the parameter path, based

    /// on the path prefix above.

    virtual CDPlugin *getpluginforpath(const std::string& path) = 0;

    /// Retrieve the "friendly name" for the media server, for display purposes

    virtual std::string getfname() = 0;

    /// IP address and port used by the libupnp HTTP server.

    ///

    /// This is the host address / network interface and port used by

    /// libupnp, which can only support one. URLs intended to be

    /// served this way (by adding a vdir) should should use this

    /// address as this is the only one guaranteed to be accessible

    /// from clients (in case this server has several interfaces).

    /// The getupnpport() call is unused at present because no module

    /// uses the internal server (all use the microhttpd started by

    /// plgwithslave).

    /// The getupnpaddr() call is used to determine the host for the

    /// microhttp server (so it works on the same i/f as the upnp one,

    /// always).

    ///

    /// The microhttpd instance uses port 49149 by default. The value

    /// can be changed with the "plgmicrohttpport" configuration

    /// variable. The local mediaserver (uprcl) uses neither the

    /// libupnp HTTP server nor microhttpd, but an internal Python

    /// server instance, on port 9090 by default (can be changed with

    /// the "uprclhostport" configuration variable).

    virtual std::string getupnpaddr(CDPlugin *) = 0;

    virtual int getupnpport(CDPlugin *) = 0;

    /// Add a virtual directory and set file operation interface. path

    /// must be equal or begin with the pathprefix. Not used at all at present.

    virtual bool setfileops(CDPlugin *, const std::string& path,

                            UPnPProvider::VirtualDir::FileOps ops)= 0;

    /// Main configuration file access.

    virtual bool config_get(const std::string& nm, std::string& val) = 0;

    /// Default port to start the server on

    static int default_microhttpport() { return 49149;}

    /// For modules which use the common microhttpd server

    /// (tidal/qobuz/gmusic). Returns something like "/tidal" (no end

    /// slash), which must be inserted at the top of the track URLs

    /// paths so that an HTTP request can be processed-for /

    /// dispatched-to the right plugin.

    static std::string getpathprefix(CDPlugin *plg) {

        return getpathprefix(plg->getname());

    }

    static std::string getpathprefix(const std::string& name) {

        return std::string("/") + name;

    }

};