DiPluginTelemetry.java

/*
 * This program is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
 * Foundation.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this
 * program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
 * or from the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * Copyright (c) 2016 Pentaho Corporation. All rights reserved.
 */

package org.pentaho.telemetry;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.osgi.framework.Bundle;
import org.pentaho.di.version.BuildVersion;
import org.pentaho.marketplace.util.XmlParserFactoryProducer;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;


/**
 * Creates a telemetry service for a specific DI plugin (supports both OSGi or non-OSGi plugins).
 */
public class DiPluginTelemetry extends TelemetryService {

  private static Log logger = LogFactory.getLog( DiPluginTelemetry.class );
  private static String UNKNOWN = "unknown";

  public DiPluginTelemetry( String pluginName,
                            String telemetryUrl,
                            boolean telemetryEnabled,
                            ITelemetryHandler telemetryHandler ) {
    super( pluginName, getPluginVersion( pluginName ), getDiVersion(), telemetryUrl, telemetryEnabled,
      telemetryHandler );
  }

  public DiPluginTelemetry( Bundle bundle,
                            String telemetryUrl,
                            boolean telemetryEnabled,
                            ITelemetryHandler telemetryHandler ) {
    super( bundle.getSymbolicName(), getPluginVersion( bundle ), getDiVersion(), telemetryUrl, telemetryEnabled,
      telemetryHandler );
  }

  private static String getPluginVersion( String pluginName ) {
    try {
      String versionPath = "plugins/" + pluginName + "/version.xml";
      InputStream versionFile = new FileInputStream( new File( versionPath ) );
      return parsePluginVersion( versionFile );
    } catch ( FileNotFoundException fnfe ) {
      logger.debug( "Could not find file version.xml", fnfe );
    }
    return UNKNOWN;
  }

  private static String getPluginVersion( Bundle bundle ) {
    try {
      URL versionFileUrl = bundle.getResource( "version.xml" );
      InputStream versionFile = versionFileUrl.openConnection().getInputStream();
      return parsePluginVersion( versionFile );
    } catch ( NullPointerException npe ) {
      logger.debug( "Could not find resource file version.xml", npe );
    } catch ( IOException ioe ) {
      logger.debug( "Could not open file version.xml", ioe );
    }
    return UNKNOWN;
  }

  private static String parsePluginVersion( InputStream versionFile ) {
    try {
      DocumentBuilderFactory dbf = XmlParserFactoryProducer.createSecureDocBuilderFactory();
      DocumentBuilder db = dbf.newDocumentBuilder();
      Document doc = db.parse( versionFile );
      NodeList nodes = doc.getElementsByTagName( "version" );
      if ( nodes.getLength() >= 1 ) {
        Element versionElement = (Element) nodes.item( 0 );
        return versionElement.getAttribute( "branch" ) + "-" + versionElement.getTextContent();
      }
    } catch ( Exception e ) {
      logger.debug( "Could not parse plugin version from version.xml", e );
    }
    return UNKNOWN;
  }

  private static String getDiVersion() {
    return BuildVersion.getInstance().getVersion();
  }
}