"""This module is for parsing and conversion functions that needs
objects from both music library and music service data structures

"""


import logging
from urllib.parse import urlparse

from .xml import XML, ns_tag
from .data_structures import didl_class_to_soco_class
from .exceptions import DIDLMetadataError
from .music_services.data_structures import get_class
from .music_services.music_service import desc_from_uri


_LOG = logging.getLogger(__name__)
_LOG.addHandler(logging.NullHandler())
_LOG.debug("%s imported", __name__)


def from_didl_string(string):
    """Convert a unicode xml string to a list of `DIDLObjects <DidlObject>`.

    Args:
        string (str): A unicode string containing an XML representation of one
            or more DIDL-Lite items (in the form  ``'<DIDL-Lite ...>
            ...</DIDL-Lite>'``)

    Returns:
        list: A list of one or more instances of `DidlObject` or a subclass
    """
    items = []
    root = XML.fromstring(string.encode("utf-8"))
    for elt in root:
        if elt.tag.endswith("item") or elt.tag.endswith("container"):
            item_class = elt.findtext(ns_tag("upnp", "class"))
            cls = didl_class_to_soco_class(item_class)
            item = cls.from_element(elt)
            item = attempt_datastructure_upgrade(item)
            items.append(item)
        else:
            # <desc> elements are allowed as an immediate child of <DIDL-Lite>
            # according to the spec, but I have not seen one there in Sonos, so
            # we treat them as illegal. May need to fix this if this
            # causes problems.
            raise DIDLMetadataError("Illegal child of DIDL element: <%s>" % elt.tag)
    _LOG.debug(
        'Created data structures: %.20s (CUT) from Didl string "%.20s" (CUT)',
        items,
        string,
    )
    return items


# Obviously imcomplete, but missing entries will not result in error, but just
# a logged warning and no upgrade of the data structure
DIDL_NAME_TO_QUALIFIED_MS_NAME = {"DidlMusicTrack": "MediaMetadataTrack"}


def attempt_datastructure_upgrade(didl_item):
    """Attempt to upgrade a didl_item to a music services data structure
    if it originates from a music services

    """
    try:
        resource = didl_item.resources[0]
    except IndexError:
        _LOG.debug("Upgrade not possible, no resources")
        return didl_item

    if resource.uri and resource.uri.startswith("x-sonos-http"):
        # Get data
        uri = resource.uri
        # Now we need to create a DIDL item id. It seems to be based on the uri
        path = urlparse(uri).path
        # Strip any extensions, eg .mp3, from the end of the path
        path = path.rsplit(".", 1)[0]
        # The ID has an 8 (hex) digit prefix. But it doesn't seem to
        # matter what it is!
        item_id = "11111111{}".format(path)

        # Pass over all the available metadata in the metadata dict, in the
        # future ask ms data structure to upgrade metadata from the service
        metadata = {}
        for key, value in didl_item.to_dict().items():
            if key not in metadata:
                metadata[key] = value

        # Get class
        try:
            cls = get_class(
                DIDL_NAME_TO_QUALIFIED_MS_NAME[didl_item.__class__.__name__]
            )
        except KeyError:
            # The data structure should be upgraded, but there is an entry
            # missing from DIDL_NAME_TO_QUALIFIED_MS_NAME. Log this as a
            # warning.
            class_name = didl_item.__class__.__name__
            if class_name not in ["DidlFavorite"]:
                _LOG.warning(
                    "DATA STRUCTURE UPGRADE FAIL. Unable to upgrade music library "
                    "data structure to music service data structure because an "
                    "entry is missing for %s in DIDL_NAME_TO_QUALIFIED_MS_NAME. "
                    "This should be reported as a bug.",
                    class_name,
                )
            return didl_item

        upgraded_item = cls(
            item_id=item_id,
            desc=desc_from_uri(resource.uri),
            resources=didl_item.resources,
            uri=uri,
            metadata_dict=metadata,
        )
        _LOG.debug("Item %s upgraded to %s", didl_item, upgraded_item)
        return upgraded_item

    _LOG.debug("Upgrade not necessary")
    return didl_item

@@ -1850,17 +1850,17 @@
 iously i
-m
+n
 complete
@@ -2046,16 +2046,125 @@
 Track%22%7D%0A
+DIDL_UPGRADE_NAMES_TO_IGNORE = %5B%0A    %22DidlChapter%22,%0A    %22DidlFavorite%22,%0A    %22DidlItem%22,%0A    %22DidlPodcast%22,%0A%5D%0A
 %0A%0Adef at
@@ -3680,81 +3680,20 @@
     
-if class_name not in %5B%22DidlFavorite%22%5D:%0A                _LOG.warning(%0A    
+message = (%0A
     
@@ -3784,20 +3784,16 @@
         
- 
-   
 %22data st
@@ -3845,20 +3845,16 @@
 se an %22%0A
-    
         
@@ -3920,17 +3920,16 @@
 MS_NAME.
- 
 %22%0A      
@@ -3934,24 +3934,26 @@
         
+)%0A
         
 %22This sh
@@ -3948,64 +3948,94 @@
     
-%22This should be reported as a bug.%22,%0A                   
+    if class_name in DIDL_UPGRADE_NAMES_TO_IGNORE:%0A                _LOG.debug(message,
  cla
@@ -4041,18 +4041,19 @@
 ass_name
-,%0A
+)%0A 
         
@@ -4051,29 +4051,78 @@
             
-     
+else:%0A                _LOG.warning(message, class_name
 )%0A          

Improve DIDL datastructure upgrade failure logging (#850)