/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.apache.felix.bundleplugin;
import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import java.util.regex.Pattern;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;
import aQute.bnd.header.Attrs;
import aQute.bnd.service.AnalyzerPlugin;
import aQute.bnd.osgi.Analyzer;
import aQute.bnd.osgi.Descriptors.PackageRef;
import aQute.bnd.osgi.Jar;
import aQute.bnd.osgi.Processor;
import aQute.bnd.osgi.Resource;
import aQute.libg.generics.Create;
import aQute.libg.qtokens.QuotedTokenizer;
import aQute.service.reporter.Reporter;
import org.apache.felix.utils.manifest.Attribute;
import org.apache.felix.utils.manifest.Clause;
import org.apache.felix.utils.manifest.Directive;
import org.osgi.framework.Constants;
import static org.apache.felix.utils.manifest.Parser.parseHeader;
public class BlueprintPlugin implements AnalyzerPlugin
{
static Pattern QN = Pattern.compile( "[_A-Za-z$][_A-Za-z0-9$]*(\\.[_A-Za-z$][_A-Za-z0-9$]*)*" );
static Pattern PATHS = Pattern.compile( ".*\\.xml" );
Transformer transformer;
public BlueprintPlugin() throws Exception
{
transformer = getTransformer( getClass().getResource( "blueprint.xsl" ) );
}
public boolean analyzeJar( Analyzer analyzer ) throws Exception
{
String mode = analyzer.getProperty("service_mode");
if (mode == null) {
mode = "service";
}
transformer.setParameter( "nsh_interface",
analyzer.getProperty( "nsh_interface" ) != null ? analyzer.getProperty( "nsh_interface" ) : "" );
transformer.setParameter( "nsh_namespace",
analyzer.getProperty( "nsh_namespace" ) != null ? analyzer.getProperty( "nsh_namespace" ) : "" );
Set<String> headers = Create.set();
String bpHeader = analyzer.getProperty( "Bundle-Blueprint", "OSGI-INF/blueprint" );
Map<String, ? extends Map<String, String>> map = Processor.parseHeader( bpHeader, null );
bpHeader = "";
for ( String root : map.keySet() )
{
Jar jar = analyzer.getJar();
Map<String, Resource> dir = jar.getDirectories().get( root );
if ( dir == null || dir.isEmpty() )
{
Resource resource = jar.getResource( root );
if ( resource != null )
{
process( analyzer, root, resource, headers );
if (bpHeader.length() > 0) {
bpHeader += ",";
}
bpHeader += root;
}
continue;
}
for ( Map.Entry<String, Resource> entry : dir.entrySet() )
{
String path = entry.getKey();
Resource resource = entry.getValue();
if ( PATHS.matcher( path ).matches() )
{
process( analyzer, path, resource, headers );
if (bpHeader.length() > 0) {
bpHeader += ",";
}
bpHeader += path;
}
}
}
if( !map.isEmpty() )
{
analyzer.setProperty("Bundle-Blueprint", bpHeader);
}
// Group and analyze
Set<String> caps = Create.set();
Set<String> reqs = Create.set();
Map<String, Set<Clause>> hdrs = Create.map();
for ( String str : headers )
{
int idx = str.indexOf( ':' );
if ( idx < 0 )
{
analyzer.warning( ( new StringBuilder( "Error analyzing services in blueprint resource: " ) ).append(
str ).toString() );
continue;
}
String h = str.substring( 0, idx ).trim();
String v = str.substring( idx + 1 ).trim();
Clause[] hc = parseHeader(v);
// Convert generic caps/reqs
if ("Import-Service".equals(h))
{
if (!"service".equals(mode))
{
Clause clause = hc[0];
String multiple = clause.getDirective("multiple");
String avail = clause.getDirective("availability");
String filter = clause.getAttribute("filter");
StringBuilder sb = new StringBuilder();
sb.append("osgi.service;effective:=active;");
if ("optional".equals(avail)) {
sb.append("resolution:=optional;");
}
if ("true".equals(multiple)) {
sb.append("cardinality:=multiple;");
}
if (filter == null) {
filter = "(" + Constants.OBJECTCLASS + "=" + clause.getName() + ")";
} else if (!filter.startsWith("(") && !filter.endsWith(")")) {
filter = "(&(" + Constants.OBJECTCLASS + "=" + clause.getName() + ")(" + filter + "))";
} else {
filter = "(&(" + Constants.OBJECTCLASS + "=" + clause.getName() + ")" + filter + ")";
}
sb.append("filter:=\"").append(filter).append("\"");
reqs.add(sb.toString());
}
else if (!"generic".equals(mode))
{
Set<Clause> clauses = hdrs.get(h);
if (clauses == null) {
clauses = new HashSet<Clause>();
hdrs.put(h, clauses);
}
clauses.addAll(Arrays.asList(hc));
}
}
else if ("Export-Service".equals(h))
{
if (!"service".equals(mode))
{
StringBuilder sb = new StringBuilder();
sb.append("osgi.service;effective:=active;objectClass");
if (hc.length > 1) {
sb.append(":List<String>=\"");
} else {
sb.append("=\"");
}
for (int i = 0; i < hc.length; i++)
{
if (i > 0)
{
sb.append(",");
}
sb.append(hc[i].getName());
}
sb.append("\"");
for (int i = 0; i < hc[0].getAttributes().length; i++)
{
sb.append(";");
sb.append(hc[0].getAttributes()[i].getName());
sb.append("=\"");
sb.append(hc[0].getAttributes()[i].getValue());
sb.append("\"");
}
caps.add(sb.toString());
}
else if (!"generic".equals(mode))
{
Set<Clause> clauses = hdrs.get(h);
if (clauses == null) {
clauses = new HashSet<Clause>();
hdrs.put(h, clauses);
}
clauses.addAll(Arrays.asList(hc));
}
}
else
{
Set<Clause> clauses = hdrs.get(h);
if (clauses == null)
{
clauses = new HashSet<Clause>();
hdrs.put(h, clauses);
}
clauses.addAll(Arrays.asList( hc ) );
}
}
if (!caps.isEmpty())
{
StringBuilder sb = new StringBuilder();
String header = analyzer.getProperty("Provide-Capability");
if (header != null)
{
sb.append(header);
}
for (String cap : caps) {
if (sb.length() > 0) {
sb.append(",");
}
sb.append(cap);
}
analyzer.setProperty("Provide-Capability", sb.toString());
}
if (!reqs.isEmpty())
{
StringBuilder sb = new StringBuilder();
String header = analyzer.getProperty("Require-Capability");
if (header != null)
{
sb.append(header);
}
for (String req : reqs) {
if (sb.length() > 0) {
sb.append(",");
}
sb.append(req);
}
analyzer.setProperty("Require-Capability", sb.toString());
}
// Merge
for ( String header : hdrs.keySet() )
{
if ( "Import-Class".equals( header ) || "Import-Package".equals( header ) )
{
Set<Clause> newAttr = hdrs.get(header);
for ( Clause a : newAttr )
{
String pkg = a.getName();
if ( "Import-Class".equals( header ) )
{
int n = a.getName().lastIndexOf( '.' );
if ( n > 0 )
{
pkg = pkg.subSequence( 0, n ).toString();
}
else
{
continue;
}
}
PackageRef pkgRef = analyzer.getPackageRef( pkg );
if ( !analyzer.getReferred().containsKey( pkgRef ) )
{
Attrs attrs = analyzer.getReferred().put(pkgRef);
for (Attribute attribute : a.getAttributes())
{
attrs.put(attribute.getName(), attribute.getValue());
}
}
}
}
else
{
Set<String> merge = Create.set();
String org = analyzer.getProperty(header);
if (org != null && !org.isEmpty())
{
for (Clause clause : parseHeader(org))
{
merge.add(clause.toString());
}
}
for (Clause clause : hdrs.get(header))
{
merge.add(clause.toString());
}
StringBuilder sb = new StringBuilder();
for (String clause : merge)
{
if ( sb.length() > 0 )
{
sb.append( "," );
}
sb.append(clause);
}
analyzer.setProperty( header, sb.toString() );
}
}
return false;
}
private void process( Analyzer analyzer, String path, Resource resource, Set<String> headers )
{
InputStream in = null;
try
{
in = resource.openInputStream();
// Retrieve headers
Set<String> set = analyze( in );
headers.addAll( set );
}
catch ( Exception e )
{
analyzer.error( ( new StringBuilder( "Unexpected exception in processing spring resources(" ) )
.append( path ).append( "): " ).append( e ).toString() );
}
finally
{
try
{
if ( in != null )
{
in.close();
}
}
catch ( IOException e )
{
}
}
}
public Set<String> analyze( InputStream in ) throws Exception
{
Set<String> refers = new HashSet<String>();
ByteArrayOutputStream bout = new ByteArrayOutputStream();
javax.xml.transform.Result r = new StreamResult( bout );
javax.xml.transform.Source s = new StreamSource( in );
transformer.transform( s, r );
ByteArrayInputStream bin = new ByteArrayInputStream( bout.toByteArray() );
bout.close();
BufferedReader br = new BufferedReader( new InputStreamReader( bin ) );
for ( String line = br.readLine(); line != null; line = br.readLine() )
{
line = line.trim();
line = line.replace( ";availability:=mandatory", "" );
if ( line.length() > 0 )
{
refers.add( line );
}
}
br.close();
return refers;
}
protected Transformer getTransformer( URL url ) throws Exception
{
TransformerFactory tf = TransformerFactory.newInstance();
javax.xml.transform.Source source = new StreamSource( url.openStream() );
return tf.newTransformer( source );
}
}