UpnpUtilities.java

/*
 * *********************************************************************************************************************
 *
 * blueMarine II: Semantic Media Centre
 * http://tidalwave.it/projects/bluemarine2
 *
 * Copyright (C) 2015 - 2021 by Tidalwave s.a.s. (http://tidalwave.it)
 *
 * *********************************************************************************************************************
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations under the License.
 *
 * *********************************************************************************************************************
 *
 * git clone https://bitbucket.org/tidalwave/bluemarine2-src
 * git clone https://github.com/tidalwave-it/bluemarine2-src
 *
 * *********************************************************************************************************************
 */
package it.tidalwave.bluemarine2.upnp.mediaserver.impl;

import javax.annotation.Nonnegative;
import javax.annotation.Nonnull;
import java.nio.file.Path;
import java.nio.file.Paths;
import lombok.NoArgsConstructor;
import static lombok.AccessLevel.PRIVATE;

/***********************************************************************************************************************
 *
 * Holder of miscellaneous utility methods.
 *
 * @author  Fabrizio Giudici
 *
 **********************************************************************************************************************/
@NoArgsConstructor(access = PRIVATE)
public final class UpnpUtilities
  {
    public static final String ID_NONE = "-1";

    private static final String ID_ROOT = "0";

    private static final String PATH_ROOT = "/";

    private static final String REGEXP_ROOT = "^/$";

    /*******************************************************************************************************************
     *
     * A conversion table for shortening external URLs. This unfortunately introduces a dependency on browsers and
     * entity types, but some DLNA cients don't accept long paths. See BMT-62.
     *
     ******************************************************************************************************************/
    private static final String[][] REPLACEMENT_PAIRS = new String[][]
      {
        { "/urn:bluemarine:artist:",              "/a:"    },
        { "/urn:bluemarine:record:",              "/r:"    },
        { "/urn:bluemarine:track:",               "/t:"    },
        { "/RepositoryBrowserByArtistThenRecord", "/a+r+t" },
        { "/RepositoryBrowserByArtistThenTrack",  "/a+t"   },
        { "/RepositoryBrowserByRecordThenTrack",  "/r+t"   },
        { "/RepositoryBrowserByTrack",            "/t"     },
        { "/DefaultMediaFileSystem",              "/fs"    },
      };

    /*******************************************************************************************************************
     *
     * Converts to a {@link Path} to a a DIDL id.
     *
     * @param       path    the path
     * @return              the DIDL id
     *
     ******************************************************************************************************************/
    @Nonnull
    public static String pathToDidlId (@Nonnull final Path path)
      {
        return externalized(path.toString().replaceAll(REGEXP_ROOT, ID_ROOT));
      }

    /*******************************************************************************************************************
     *
     * Converts a DIDL id to a {@link Path}.
     *
     * @param       id      the DIDL id
     * @return              the path
     *
     ******************************************************************************************************************/
    @Nonnull
    public static Path didlIdToPath (@Nonnull final String id)
      {
        return Paths.get(id.equals(ID_ROOT) ? PATH_ROOT : internalized(id));
      }

    /*******************************************************************************************************************
     *
     * See BMT-62.
     *
     ******************************************************************************************************************/
    @Nonnull
    public static String externalized (@Nonnull String string)
      {
        for (final String[] pair : REPLACEMENT_PAIRS)
          {
            string = string.replace(pair[0], pair[1]);
          }

        return string;
      }

    /*******************************************************************************************************************
     *
     * See BMT-62.
     *
     ******************************************************************************************************************/
    @Nonnull
    public static String internalized (@Nonnull String string)
      {
        for (final String[] pair : REPLACEMENT_PAIRS)
          {
            string = string.replace(pair[1], pair[0]);
          }

        return string;
      }

    /*******************************************************************************************************************
     *
     * Fixes the {@code maxCount} parameter of ContentDirectory {@code browse()}.
     *
     * @param   value   the input value
     * @return          the max count
     *
     ******************************************************************************************************************/
    @Nonnegative
    public static int maxCount (@Nonnegative final long value)
      {
        return (value == 0) ? Integer.MAX_VALUE : (int)value;
      }
  }