org.tinymediamanager.scraper.MediaScraper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tinyMediaManager Show documentation
The newest version!
/*
 * Copyright 2012 - 2019 Manuel Laggner
 *
 * 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.
 */
package org.tinymediamanager.scraper;

import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import java.util.ResourceBundle;

import org.apache.commons.lang3.StringUtils;
import org.tinymediamanager.scraper.entities.MediaType;
import org.tinymediamanager.scraper.mediaprovider.IKodiMetadataProvider;
import org.tinymediamanager.scraper.mediaprovider.IMediaProvider;
import org.tinymediamanager.scraper.mediaprovider.IMediaSubtitleProvider;
import org.tinymediamanager.scraper.mediaprovider.IMovieArtworkProvider;
import org.tinymediamanager.scraper.mediaprovider.IMovieMetadataProvider;
import org.tinymediamanager.scraper.mediaprovider.IMovieSetMetadataProvider;
import org.tinymediamanager.scraper.mediaprovider.IMovieTrailerProvider;
import org.tinymediamanager.scraper.mediaprovider.ITvShowArtworkProvider;
import org.tinymediamanager.scraper.mediaprovider.ITvShowMetadataProvider;
import org.tinymediamanager.scraper.util.PluginManager;
import org.tinymediamanager.ui.UTF8Control;

/**
 * Class representing a MediaScraper; (type, info, description...)

 * replacement of MovieScrapers /TvShowScrapers ENUM
 * 
 * @author Manuel Laggner
 */
public class MediaScraper {
  private static final ResourceBundle BUNDLE  = ResourceBundle.getBundle("messages", new UTF8Control()); //$NON-NLS-1$
  private String                      id      = "";
  private String                      version = "";
  private String                      name    = "";
  private String                      summary = "";
  private String                      description;
  private URL                         logoUrl;
  private ScraperType                 type;
  private IMediaProvider              mediaProvider;
  private boolean                     enabled = true;

  public MediaScraper(ScraperType type, IMediaProvider mediaProvider) {
    this.mediaProvider = mediaProvider;
    this.type = type;
    MediaProviderInfo mpi = mediaProvider.getProviderInfo();
    this.id = mpi.getId();
    this.name = mpi.getName();
    this.version = mpi.getVersion();
    this.description = mpi.getDescription();
    this.summary = mpi.getDescription();
    this.logoUrl = mpi.getProviderLogo();
  }

  @Override
  public String toString() {
    return name;
  }

  public String getId() {
    return id;
  }

  public void setId(String id) {
    this.id = id;
  }

  public String getVersion() {
    return version;
  }

  public void setVersion(String version) {
    this.version = version;
  }

  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  public String getSummary() {
    return summary;
  }

  public void setSummary(String summary) {
    this.summary = summary;
  }

  public String getDescription() {
    return description;
  }

  public void setDescription(String description) {
    this.description = description;
  }

  public ScraperType getType() {
    return type;
  }

  public void setType(ScraperType type) {
    this.type = type;
  }

  public IMediaProvider getMediaProvider() {
    return this.mediaProvider;
  }

  public URL getLogoURL() {
    return this.logoUrl;
  }

  /**
   * returns a MediaScraper from a given type - found via plugins

   * use .toArray() for putting this in a ComboBox
   * 
   * @param type
   *          Movie or Tv
   * @return a list of all found media scrapers
   */
  public static List getMediaScrapers(ScraperType type) {
    ArrayList scraper = new ArrayList<>();

    ArrayList plugins = new ArrayList<>();
    switch (type) {
      case MOVIE:
        plugins.addAll(PluginManager.getInstance().getPluginsForInterface(IMovieMetadataProvider.class));
        break;
      case TV_SHOW:
        plugins.addAll(PluginManager.getInstance().getPluginsForInterface(ITvShowMetadataProvider.class));
        break;
      case MOVIE_SET:
        plugins.addAll(PluginManager.getInstance().getPluginsForInterface(IMovieSetMetadataProvider.class));
        break;
      case MOVIE_ARTWORK:
        plugins.addAll(PluginManager.getInstance().getPluginsForInterface(IMovieArtworkProvider.class));
        break;
      case TV_SHOW_ARTWORK:
        plugins.addAll(PluginManager.getInstance().getPluginsForInterface(ITvShowArtworkProvider.class));
        break;
      case MOVIE_TRAILER:
        plugins.addAll(PluginManager.getInstance().getPluginsForInterface(IMovieTrailerProvider.class));
        break;
      case SUBTITLE:
        plugins.addAll(PluginManager.getInstance().getPluginsForInterface(IMediaSubtitleProvider.class));
        break;
      default:
        break;
    }

    for (IMediaProvider p : plugins) {
      MediaScraper ms = new MediaScraper(type, p);
      scraper.add(ms);
    }

    // Kodi scrapers
    for (IKodiMetadataProvider kodi : PluginManager.getInstance().getPluginsForInterface(IKodiMetadataProvider.class)) {
      try {
        for (IMediaProvider p : kodi.getPluginsForType(MediaType.toMediaType(type.name()))) {
          MediaScraper ms = new MediaScraper(type, p);
          scraper.add(ms);
        }
      }
      catch (Exception ignored) {
      }
    }

    return scraper;
  }

  public static MediaScraper getMediaScraperById(String id, ScraperType type) {
    if (StringUtils.isBlank(id)) {
      return null;
    }

    List scrapers = getMediaScrapers(type);
    for (MediaScraper scraper : scrapers) {
      if (scraper.id.equals(id)) {
        return scraper;
      }
    }
    return null;
  }

  @Override
  public int hashCode() {
    final int prime = 31;
    int result = 1;
    result = prime * result + ((id == null) ? 0 : id.hashCode());
    result = prime * result + ((type == null) ? 0 : type.hashCode());
    return result;
  }

  @Override
  public boolean equals(Object obj) {
    if (this == obj)
      return true;
    if (obj == null)
      return false;
    if (getClass() != obj.getClass())
      return false;
    MediaScraper other = (MediaScraper) obj;
    if (id == null) {
      if (other.id != null)
        return false;
    }
    else if (!id.equals(other.id))
      return false;
    if (type != other.type)
      return false;
    return true;
  }

  public boolean isEnabled() {
    return enabled;
  }
}