org.opencastproject.composer.impl.EncodingProfileScanner Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opencast-composer-ffmpeg Show documentation
The newest version!
/*
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you under the Educational
 * Community 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://opensource.org/licenses/ecl2.txt
 *
 * 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.opencastproject.composer.impl;

import static org.opencastproject.util.ReadinessIndicator.ARTIFACT;

import org.opencastproject.composer.api.EncodingProfile;
import org.opencastproject.composer.api.EncodingProfile.MediaType;
import org.opencastproject.composer.api.EncodingProfileImpl;
import org.opencastproject.util.ConfigurationException;
import org.opencastproject.util.ReadinessIndicator;

import org.apache.commons.lang3.StringUtils;
import org.apache.felix.fileinstall.ArtifactInstaller;
import org.osgi.framework.BundleContext;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.io.FileInputStream;
import java.io.FilenameFilter;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Dictionary;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;

/**
 * This manager class tries to read encoding profiles from the classpath.
 */
@Component(
  property = {
    "service.description=Encoding Profile Scanner"
  },
  immediate = true,
  service = { EncodingProfileScanner.class, ArtifactInstaller.class }
)
public class EncodingProfileScanner implements ArtifactInstaller {

  /** Prefix for encoding profile property keys **/
  private static final String PROP_PREFIX = "profile.";

  /* Property names */
  private static final String PROP_NAME = ".name";
  private static final String PROP_APPLICABLE = ".input";
  private static final String PROP_OUTPUT = ".output";
  private static final String PROP_SUFFIX = ".suffix";
  private static final String PROP_JOBLOAD = ".jobload";

  /** OSGi bundle context */
  private BundleContext bundleCtx = null;

  /** Sum of profiles files currently installed */
  private int sumInstalledFiles = 0;

  /** Sum of profiles files that could not be parsed */
  private int sumUnparsableFiles = 0;

  /** The profiles map */
  private Map profiles = new HashMap();

  /** The logging instance */
  private static final Logger logger = LoggerFactory.getLogger(EncodingProfileScanner.class);

  /**
   * Returns the list of profiles.
   *
   * @return the profile definitions
   */
  public Map getProfiles() {
    return profiles;
  }

  /**
   * OSGi callback on component activation.
   *
   * @param ctx
   *          the bundle context
   */
  @Activate
  void activate(BundleContext ctx) {
    this.bundleCtx = ctx;
  }

  /**
   * Returns the encoding profile for the given identifier or null if no such profile has been configured.
   *
   * @param id
   *          the profile identifier
   * @return the profile
   */
  public EncodingProfile getProfile(String id) {
    return profiles.get(id);
  }

  /**
   * Reads the profiles from the given set of properties.
   *
   * @param artifact
   *          the properties file
   * @return the profiles found in the properties
   */
  Map loadFromProperties(File artifact) throws IOException {
    // Format name
    Properties properties = new Properties();
    try (InputStreamReader reader = new InputStreamReader(new FileInputStream(artifact), StandardCharsets.UTF_8)) {
      properties.load(reader);
    }

    // Find list of formats in properties
    List profileNames = new ArrayList<>();
    for (Object fullKey : properties.keySet()) {
      String key = fullKey.toString();
      if (key.startsWith(PROP_PREFIX) && key.endsWith(PROP_NAME)) {
        int separatorLocation = fullKey.toString().lastIndexOf('.');
        key = key.substring(PROP_PREFIX.length(), separatorLocation);
        if (!profileNames.contains(key)) {
          profileNames.add(key);
        } else {
          throw new ConfigurationException("Found duplicate definition for encoding profile '" + key + "'");
        }
      }
    }

    // Load the formats
    Map profiles = new HashMap<>();
    for (String profileId : profileNames) {
      logger.debug("Enabling media format " + profileId);
      EncodingProfile profile = loadProfile(profileId, properties, artifact);
      profiles.put(profileId, profile);
    }

    return profiles;
  }

  /**
   * Reads the profile from the given properties
   *
   * @param profile
   * @param properties
   * @param artifact
   * @return the loaded profile or null if profile
   * @throws RuntimeException
   */
  private EncodingProfile loadProfile(String profile, Properties properties, File artifact)
          throws ConfigurationException {
    List defaultProperties = new ArrayList<>(10);

    String name = getDefaultProperty(profile, PROP_NAME, properties, defaultProperties);
    if (StringUtils.isBlank(name)) {
      throw new ConfigurationException("Distribution profile '" + profile + "' is missing a name (" + PROP_NAME + ").");
    }

    EncodingProfileImpl df = new EncodingProfileImpl(profile, name, artifact);

    // Output Type
    String type = getDefaultProperty(profile, PROP_OUTPUT, properties, defaultProperties);
    if (StringUtils.isBlank(type))
      throw new ConfigurationException("Output type (" + PROP_OUTPUT + ") of profile '" + profile + "' is missing");
    try {
      df.setOutputType(MediaType.parseString(StringUtils.trimToEmpty(type)));
    } catch (IllegalArgumentException e) {
      throw new ConfigurationException("Output type (" + PROP_OUTPUT + ") '" + type + "' of profile '" + profile
              + "' is unknown");
    }

    //Suffixes with tags?
    List tags = getTags(profile, properties, defaultProperties);
    if (tags.size() > 0) {
      for (String tag : tags) {
        String prop = PROP_SUFFIX + "." + tag;
        String suffixObj = getDefaultProperty(profile, prop, properties, defaultProperties);
        df.setSuffix(tag, StringUtils.trim(suffixObj));
      }
    } else {
      // Suffix old stile, without tags
      String suffixObj = getDefaultProperty(profile, PROP_SUFFIX, properties, defaultProperties);
      if (StringUtils.isBlank(suffixObj))
        throw new ConfigurationException("Suffix (" + PROP_SUFFIX + ") of profile '" + profile + "' is missing");
      df.setSuffix(StringUtils.trim(suffixObj));
    }

    // Applicable to the following track categories
    String applicableObj = getDefaultProperty(profile, PROP_APPLICABLE, properties, defaultProperties);
    if (StringUtils.isBlank(applicableObj))
      throw new ConfigurationException("Input type (" + PROP_APPLICABLE + ") of profile '" + profile + "' is missing");
    df.setApplicableType(MediaType.parseString(StringUtils.trimToEmpty(applicableObj)));

    String jobLoad = getDefaultProperty(profile, PROP_JOBLOAD, properties, defaultProperties);
    if (!StringUtils.isBlank(jobLoad)) {
      df.setJobLoad(Float.valueOf(jobLoad));
      logger.debug("Setting job load for profile {} to {}", profile, jobLoad);
    }

    // Look for extensions
    String extensionKey = PROP_PREFIX + profile + ".";
    for (Map.Entry entry : properties.entrySet()) {
      String key = entry.getKey().toString();
      if (key.startsWith(extensionKey) && !defaultProperties.contains(key)) {
        String k = key.substring(extensionKey.length());
        String v = StringUtils.trimToEmpty(entry.getValue().toString());
        df.addExtension(k, v);
      }
    }

    return df;
  }

  /**
   * Returns the default property and registers the property key in the list.
   *
   * @param profile
   *          the profile identifier
   * @param keySuffix
   *          the key suffix, like ".name"
   * @param properties
   *          the properties
   * @param list
   *          the list of default property keys
   * @return the property value or null
   */
  private static String getDefaultProperty(String profile, String keySuffix, Properties properties, List list) {
    String key = PROP_PREFIX + profile + keySuffix;
    list.add(key);
    return StringUtils.trimToNull(properties.getProperty(key));
  }

  /**
   * Get any tags that might follow the PROP_SUFFIX
   * @param profile
   *          the profile identifier
   * @param properties
   *          the properties
   * @param list
   *          the list of default property keys
   * @return A list of tags for output files
   */

  private static List getTags(String profile, Properties properties, List list) {
    Set