# Copyright 2013 Sebastian Ramacher <sebastian+dev@ramacher.at>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

""" python-discid compat layer

This module provides a compatible layer so that python-libdiscid can be used as
a replacement for python-discid. It provides an interface compatible with
python-discid version 1.0.2.
"""

import libdiscid
import operator
import functools
import sys

_INVERSE_FEATURES = {
    libdiscid.FEATURES_MAPPING[libdiscid.FEATURE_READ]: libdiscid.FEATURE_READ,
    libdiscid.FEATURES_MAPPING[libdiscid.FEATURE_MCN]: libdiscid.FEATURE_MCN,
    libdiscid.FEATURES_MAPPING[libdiscid.FEATURE_ISRC]: libdiscid.FEATURE_ISRC,
}


class _NoneHelper:
    def __getattr__(self, name):
        if name in (
            "id",
            "freedb_id",
            "submission_url",
            "toc",
            "first_track",
            "last_track",
            "sectors",
            "mcn",
        ):
            return None

        return super().__getattr__(name)


def _decode(string, encoding=None):
    # Let's do the same thing discid is doing. It always accepts both strings and
    # unicode objects and encodes/decodes them as it sees fit. libdiscid always
    # wants unicode objects, so let's decode it here on a best effort basis.
    if not isinstance(string, str):
        if encoding is None:
            encoding = sys.getfilesystemencoding() or "ascii"
        return string.decode(encoding)
    return string


# exceptions defined in discid
DiscError = libdiscid.DiscError


class TOCError(Exception):
    pass


# classes defined in discid
class Track:
    def __init__(self, disc, number):
        self.disc = disc
        self.number = number

    def __str__(self):
        return str(self.number)

    @property
    def offset(self):
        return self.disc.track_offsets[self.number - self.disc.first_track]

    @property
    def sectors(self):
        return self.disc.track_lengths[self.number - self.disc.first_track]

    length = sectors

    @property
    def seconds(self):
        return libdiscid.sectors_to_seconds(self.sectors)

    @property
    def isrc(self):
        try:
            value = self.disc.track_isrcs[self.number - self.disc.first_track]
        except NotImplementedError:
            return None
        return value if value != "" else None


class Disc:
    def __init__(self):
        self.disc = _NoneHelper()
        self.tracks = []

    def read(self, device, features=[]):
        self.disc = libdiscid.read(
            device,
            functools.reduce(
                operator.or_,
                (
                    _INVERSE_FEATURES[feature]
                    for feature in features
                    if feature in FEATURES
                ),
                0,
            ),
        )
        self.tracks = [
            Track(self.disc, numb)
            for numb in range(self.disc.first_track, self.disc.last_track + 1)
        ]
        return True

    def put(self, first, last, disc_sectors, track_offsets):
        try:
            self.disc = libdiscid.put(first, last, disc_sectors, track_offsets)
        except DiscError as disc_error:
            raise TOCError(str(disc_error))

        self.tracks = [
            Track(self.disc, num)
            for num in range(self.disc.first_track, self.disc.last_track + 1)
        ]
        return True

    @property
    def id(self):
        return self.disc.id

    @property
    def freedb_id(self):
        return self.disc.freedb_id

    @property
    def submission_url(self):
        return self.disc.submission_url

    @property
    def toc_string(self):
        return self.disc.toc

    @property
    def first_track_num(self):
        return self.disc.first_track

    @property
    def last_track_num(self):
        return self.disc.last_track

    @property
    def sectors(self):
        return self.disc.sectors

    length = sectors

    @property
    def seconds(self):
        return (
            libdiscid.sectors_to_seconds(self.sectors)
            if self.sectors is not None
            else None
        )

    @property
    def mcn(self):
        try:
            value = self.disc.mcn
        except NotImplementedError:
            return None
        return value if value != "" else None


# functions defined in discid
get_default_device = libdiscid.default_device


def read(device=None, features=[]):
    disc = Disc()
    disc.read(
        _decode(device) if device is not None else None,
        map(lambda feature: _decode(feature, "ascii"), features),
    )
    return disc


def put(first, last, disc_sectors, track_offsets):
    disc = Disc()
    disc.put(first, last, disc_sectors, track_offsets)
    return disc


# constants defined in discid
__version__ = "1.1.0 (compat layer from python-libdiscid %s)" % (libdiscid.__version__,)
""" This is the version of python-discid this layer is compatible with. """

LIBDISCID_VERSION_STRING = libdiscid.__discid_version__
FEATURES = libdiscid.FEATURES
FEATURES_IMPLEMENTED = (
    libdiscid.FEATURE_READ,
    libdiscid.FEATURE_MCN,
    libdiscid.FEATURE_ISRC,
)

__all__ = (
    "read",
    "put",
    "get_default_device",
    "__version__",
    "LIBDISCID_VERSION_STRING",
    "FEATURES",
    "FEATURES_IMPLEMENTED",
    "Disc",
    "DiscError",
    "TOCError",
)

@@ -2124,23 +2124,21 @@
 d%0A    # 
-unicode
+bytes
  objects
@@ -2212,15 +2212,14 @@
 nts 
-unicode
+string
  obj

Update comment wrt to Python 3