org.tinymediamanager.scraper.util.PluginManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-scraper Show documentation
API for tinyMediaManager scrapers
There is a newer version: 3.0.5
/*
 * 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.util;

import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.List;

import org.apache.commons.lang3.time.StopWatch;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.tinymediamanager.scraper.mediaprovider.IMediaProvider;

import net.xeoh.plugins.base.impl.PluginManagerFactory;
import net.xeoh.plugins.base.util.JSPFProperties;
import net.xeoh.plugins.base.util.PluginManagerUtil;
import net.xeoh.plugins.base.util.uri.ClassURI;

/**
 * This class manages loading of external plugins. It is intended to be accessed via TmmModuleManager to ensure controlled access (i.e. caching)
 * 
 * @author Manuel Laggner
 */
public class PluginManager {
  private final static Logger                        LOGGER = LoggerFactory.getLogger(PluginManager.class);
  private static net.xeoh.plugins.base.PluginManager pm;
  private static PluginManagerUtil                   pmu;
  private static PluginManager                       instance;

  public synchronized static PluginManager getInstance() {
    if (instance == null) {
      JSPFProperties props = new JSPFProperties();
      props.setProperty(net.xeoh.plugins.base.PluginManager.class, "cache.enabled", "true");
      props.setProperty(net.xeoh.plugins.base.PluginManager.class, "cache.mode", "weak"); // optional
      props.setProperty(net.xeoh.plugins.base.PluginManager.class, "cache.file", "jspf.cache");

      instance = new PluginManager();
      pm = PluginManagerFactory.createPluginManager(props);
      pmu = new PluginManagerUtil(pm);

      StopWatch stopWatch = new StopWatch();
      stopWatch.start();
      // dedicated folder just for plugins
      LOGGER.debug("loading external plugins...");
      // Use NIO2 Paths instead of file - not correctly generating scheme!!!
      // file:/C:/tmm instead of file:///C:/tmm
      // to load plugins from a path containing a + we've overridden the class FileLoader in the tmm classpath
      pm.addPluginsFrom(Paths.get("plugins/").toUri());
      stopWatch.stop();
      LOGGER.debug("Done loading external plugins - took " + stopWatch);
    }
    return instance;
  }

  /**
   * loads plugins from classpath - needed for in-IDE development
   */
  public void loadClasspathPlugins() {
    StopWatch stopWatch = new StopWatch();
    stopWatch.start();
    LOGGER.debug("loading classpath plugins...");
    // pm.addPluginsFrom(ClassURI.CLASSPATH); // sloooow
    pm.addPluginsFrom(ClassURI.CLASSPATH("org.tinymediamanager.scraper.**")); // 4 secs
    stopWatch.stop();
    LOGGER.debug("Done loading classpath plugins - took " + stopWatch);
  }

  /**
   * Method should be called, after ALL plugins have been loaded

   * This comes handy, when you need to initialize something depending on other plugins.
   */
  public void afterInitialization() {
    for (IMediaProvider p : getPluginsForInterface(IMediaProvider.class)) {
      p.afterInitialization();
      LOGGER.trace("loaded plugin: {}", p.getClass().getName());
    }
  }

  /**
   * get all plugins for the desired interface
   * 
   * @param iface
   *          the interface to search for plugins
   * @return all found plugins
   */
  public  List getPluginsForInterface(Class iface) {
    List plugins = new ArrayList<>();

    // get the right plugins
    for (T mp : pmu.getPlugins(iface)) {
      plugins.add(mp);
    }

    return plugins;
  }
}