plugins/org.eclipse.objectteams.otequinox.turbo/src/org/eclipse/objectteams/otequinox/turbo/ForcedExportsRegistry.java - objectteams/org.eclipse.objectteams - Gitiles

 /**********************************************************************
  * This file is part of "Object Teams Development Tooling"-Software
  *
  * Copyright 2014 GK Software AG
  *
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  *
  * Please visit http://www.eclipse.org/objectteams for updates and contact.
  *
  * Contributors:
  * 	Stephan Herrmann - Initial API and implementation
  **********************************************************************/
 package org.eclipse.objectteams.otequinox.turbo;

 import java.io.BufferedReader;
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
 import java.io.InputStreamReader;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;

 import org.eclipse.osgi.framework.log.FrameworkLog;
 import org.eclipse.osgi.framework.log.FrameworkLogEntry;

 /**
  * Reads forced exports from various locations (granted/denied).
  *
  * All members are static to facilitate reflexive access from org.eclipse.objectteams.otequinox.
  */
 public class ForcedExportsRegistry {
 	// property names:
 	private static final String FORCED_EXPORTS_DENIED  = "otequinox.forced.exports.denied"; // //$NON-NLS-1$
 	private static final String FORCED_EXPORTS_GRANTED = "otequinox.forced.exports.granted"; // //$NON-NLS-1$

 	// terminal tokens:
 	private static final String XFRIENDS = "x-friends:="; //$NON-NLS-1$

 	private static HashMap<String, String> grantedForcedExports = null;
 	private static HashMap<String, String> deniedForcedExports = null;

 	static FrameworkLog fwLog;

 	public static void install(FrameworkLog log) {
 		fwLog = log;
 		readForcedExports();
 	}

 	static void logError(String message, Throwable e) {
 		fwLog.log(new FrameworkLogEntry(ForcedExportsRegistry.class.getName(),
 									    message,
 									    FrameworkLogEntry.ERROR,
 									    e, null));
 	}

 	static void logError(String message) {
 		fwLog.log(new FrameworkLogEntry(ForcedExportsRegistry.class.getName(),
 									    message,
 									    FrameworkLogEntry.ERROR,
 									    null, null));
 	}

 	private static void readForcedExports() {
 		// read forced exports from config.ini (system properties), or file(s)
 		deniedForcedExports= new HashMap<String, String>();
 		grantedForcedExports= new HashMap<String, String>();
 		readForcedExportsFromProperty(FORCED_EXPORTS_DENIED, AspectPermission.DENY);
 		readForcedExportsFromProperty(FORCED_EXPORTS_GRANTED, AspectPermission.GRANT);
 	}

 	private static void readForcedExportsFromProperty(String propKey, AspectPermission perm) {
 		String value= System.getProperty(propKey);
 		if (value != null) {
 			if (value.length() > 0 && value.charAt(0) == '@') {
 				// follows: comma-separated list for filenames to read from:
 				int pos = 1;
 				while (pos < value.length()) {
 					int comma = value.indexOf(',', pos);
 					String fileName;
 					if (comma > -1) {
 						fileName = value.substring(pos, comma);
 						pos = comma+1;
 					} else {
 						fileName = value.substring(pos);
 						pos = value.length();
 					}
 					parseForcedExportsFile(new File(fileName), perm);
 				}
 			} else {
 				parseForcedExports(value, perm);
 			}
 		}
 	}
 	/**
 	 * API:
 	 * Adds the definitions from a given file to the set of granted forced exports.
 	 * @param file file to read from
 	 * @param perm either ALLOW or DENY (via their ordinal()),
 	 * 	 determines how the found forced export decls are interpreted.
 	 */
 	public static void parseForcedExportsFile(File file, int perm) {
 		parseForcedExportsFile(file, AspectPermission.values()[perm]);
 	}
 	private static synchronized void parseForcedExportsFile(File file, AspectPermission perm) {
 		StringBuffer newVal = new StringBuffer();
 		try {
 			// read content of one file:
 			FileInputStream fis = new FileInputStream(file);
 			try (BufferedReader br = new BufferedReader(new InputStreamReader(fis, "UTF8"))) { //$NON-NLS-1$
 				String line;
 				boolean afterClosingBrace = false;
 				while ((line = br.readLine()) != null) {
 					line = line.trim();
 					if (line.length() > 0) {
 						if (line.charAt(0) == '#') continue;
 						// may need to replace linebreak after ']' with ',' - to match one-line syntax in config.ini
 						char lastReadChar = line.charAt(line.length()-1);
 						if (afterClosingBrace && lastReadChar != ',')
 							newVal.append(',');
 						afterClosingBrace = lastReadChar == ']';

 						newVal.append(line);
 					}
 				}
 				if (newVal.length() > 0)
 					parseForcedExports(newVal.toString(), perm);
 			}
 		} catch (IOException e) {
 			fwLog.log(new FrameworkLogEntry(OTStorageHook.class.getName(),
 						    "failed to read forcedExports file "+file.getName(), //$NON-NLS-1$
 						    FrameworkLogEntry.ERROR, e, null));
 		}
 	}
 	/* Adds the given definitions to the set of granted forced exports. */
 	private static void parseForcedExports(String value, AspectPermission perm) {
 		HashMap<String, String> map = getForcedExportsMap(perm);
 		if (map == null) return; // DONT_CARE
 		int pos = 0;
 		String[] values = new String[2]; // { BaseBundleID , PackageExports }
 		while (true) {
 			pos = getForcedExportForOneBase(value, pos, values);
 			String plugin= values[0];
 			String pack= values[1];
 			if (map.containsKey(plugin)) {
 				String oldPack = map.get(plugin);
 				pack = oldPack+','+pack;  // append to existing definition
 			}
 			map.put(plugin, pack);
 			if (pos >= value.length())
 				break; // eot: done without errors
 			if (value.charAt(pos) != ',')
 				throwSyntaxError(value, pos, "missing ','"); //$NON-NLS-1$
 			pos++; // skip the ','
 		}
 	}
 	/**
 	 * fetch one chunk of forced exports specification from `spec`:
 	 * <ul>
 	 * <li>my.base.plugin[<em>specification-of-force-exported-packages</em>]<em>tail</em></li>
 	 * </ul>
 	 * is split into:
 	 * <ul>
 	 * <li>my.base.plugin</li>
 	 * <li><em>specification-of-force-exported-packages</em></li>
 	 * </ul>
 	 * and return value points to <em>tail</em>
 	 * @param spec where to read from
 	 * @param start where to start reading (within spec)
 	 * @param value store result chunks in this array: [0] = base plugin, [1] = packages specification
 	 * @return position after what has been interpreted so far
 	 */
 	private static int getForcedExportForOneBase(String spec, int start, String[] values) {
 		int open = spec.indexOf('[', start);
 		if (open == -1)
 			throwSyntaxError(spec, start, "missing '['"); //$NON-NLS-1$
 		int close = spec.indexOf(']', start);
 		if (close == -1)
 			throwSyntaxError(spec, open, "missing ']'"); //$NON-NLS-1$
 		values[0] = spec.substring(start, open);
 		values[1] = spec.substring(open+1, close);
 		return close+1;
 	}

 	private static void throwSyntaxError(String spec, int pos, String string) {
 		throw new RuntimeException("Illegal syntax in 'forcedExports' directive at position "+pos+" (not counting whitespace): "+string+"\n value is:\n"+spec); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$
 	}

 	private static HashMap<String, String> getForcedExportsMap(AspectPermission perm) {
 		switch (perm) {
 			case GRANT:     return grantedForcedExports;
 			case DENY:      return deniedForcedExports;
 			case UNDEFINED: return null;
 //			default: // not implementing a default case, want to be warned when new enum-constants are added
 		}
 		// for binary compatibility; see also https://bugs.eclipse.org/bugs/show_bug.cgi?id=265744
 		throw new IncompatibleClassChangeError("enum "+AspectPermission.class.getName()+" has changed unexpectedly."); //$NON-NLS-1$ //$NON-NLS-2$
 	}

 	/**
 	 * API for {@link OTStorageHook.StorageHookImpl}.
 	 * Query whether any forced-exports are declared for the given base bundle.
 	 * @param baseBundleId
 	 * @param the permission we are asking for
 	 * @return comma-separated package names
 	 */
 	public static String getGrantedForcedExportsByBase(String baseBundleId) {

 		// can be queried before we had a chance to initialize our data structures
 		synchronized (OTStorageHook.class) {
 			if (grantedForcedExports == null)
 				readForcedExports();
 		}

 		String exports = grantedForcedExports.get(baseBundleId);
 		if (exports != null) {
 			// yes, we need to add forced exports:
 			if (!exports.contains(XFRIENDS)) { // FIXME: check once for each package?
 				// invalid directive:
 				grantedForcedExports.remove(baseBundleId);
 				logError("config.ini: missing x-friends directive in forced export of "+exports); //$NON-NLS-1$
 				return null; // don't install illegal forced exports
 			}
 		}
 		return exports;
 	}

 	/**
 	 * API for org.eclipse.objectteams.otequinox (as a service and using reflection).
 	 * Query whether any forced-exports are declared in config.ini (or other location)
 	 * for the given aspect bundle.
 	 * @param aspectBundleId
 	 * @param the permission we are asking for
 	 * @return list of pairs (baseBundleId x packageName)
 	 */
 	public static /*@NonNull*/ List<String[]> getForcedExportsByAspect(String aspectBundleId, int perm)
 	{
 		// can be queried before we had a chance to initialize our data structures
 		synchronized (OTStorageHook.class) {
 			if (grantedForcedExports == null)
 				readForcedExports();
 		}

 		ArrayList<String[]> result= new ArrayList<String[]>(5);

 		HashMap<String, String> map = getForcedExportsMap(AspectPermission.values()[perm]);
 		if (map == null)
 			return result; // DONT_CARE: useless query.

 		for (Map.Entry<String,String> entry: map.entrySet()) {
 			String export= entry.getValue();
 			int start = 0;
 			while (start >= 0 && start < export.length()) {
 				if (start > 0) {
 					// skip separator after previous entry
 					if (export.charAt(start) == ',')
 						start++;
 					else
 						logError("Error parsing forced exports: "+export+", comma expected at position "+start); //$NON-NLS-1$ //$NON-NLS-2$
 				}
 				int pos= export.indexOf(';'+XFRIENDS, start);
 				if (pos == -1)
 					break;
 				String packageName = export.substring(start, pos);
 				List<String> aspectBundles = new ArrayList<String>();
 				start = scanAspectBundles(export, pos+XFRIENDS.length()+1, aspectBundles);
 				for (String aspect : aspectBundles) {
 					if (aspect.equals(aspectBundleId)) {
 						result.add(new String[]{entry.getKey(), packageName});
 					}
 				}
 			}
 		}
 		return result;
 	}

 	private static int scanAspectBundles(String export, int pos, List<String> result) {
 		String termChars = ",]"; //$NON-NLS-1$
 		if (export.charAt(pos) == '"') {
 			pos++;
 			termChars = "\""; //$NON-NLS-1$
 		}
 		int start = pos;
 		while (pos < export.length()) {
 			char c = export.charAt(pos);
 			switch (c) {
 			case ',':
 			case ']':
 			case '"':
 				String next = export.substring(start, pos);
 				result.add(next);
 				start = pos+1;
 				if (termChars.indexOf(c) != -1)
 					return start;
 				break;
 			}
 			pos++;
 		}
 		logError("Unterminated forced exports: "+export); //$NON-NLS-1$
 		if (pos > start)
 			result.add(export.substring(start));
 		return export.length();
 	}

 }
	/**********************************************************************
	* This file is part of "Object Teams Development Tooling"-Software
	*
	* Copyright 2014 GK Software AG
	*
	* All rights reserved. This program and the accompanying materials
	* are made available under the terms of the Eclipse Public License v1.0
	* which accompanies this distribution, and is available at
	* http://www.eclipse.org/legal/epl-v10.html
	*
	* Please visit http://www.eclipse.org/objectteams for updates and contact.
	*
	* Contributors:
	* Stephan Herrmann - Initial API and implementation
	**********************************************************************/
	package org.eclipse.objectteams.otequinox.turbo;

	import java.io.BufferedReader;
	import java.io.File;
	import java.io.FileInputStream;
	import java.io.IOException;
	import java.io.InputStreamReader;
	import java.util.ArrayList;
	import java.util.HashMap;
	import java.util.List;
	import java.util.Map;

	import org.eclipse.osgi.framework.log.FrameworkLog;
	import org.eclipse.osgi.framework.log.FrameworkLogEntry;

	/**
	* Reads forced exports from various locations (granted/denied).
	*
	* All members are static to facilitate reflexive access from org.eclipse.objectteams.otequinox.
	*/
	public class ForcedExportsRegistry {
	// property names:
	private static final String FORCED_EXPORTS_DENIED = "otequinox.forced.exports.denied"; // //$NON-NLS-1$
	private static final String FORCED_EXPORTS_GRANTED = "otequinox.forced.exports.granted"; // //$NON-NLS-1$

	// terminal tokens:
	private static final String XFRIENDS = "x-friends:="; //$NON-NLS-1$

	private static HashMap<String, String> grantedForcedExports = null;
	private static HashMap<String, String> deniedForcedExports = null;

	static FrameworkLog fwLog;

	public static void install(FrameworkLog log) {
	fwLog = log;
	readForcedExports();
	}

	static void logError(String message, Throwable e) {
	fwLog.log(new FrameworkLogEntry(ForcedExportsRegistry.class.getName(),
	message,
	FrameworkLogEntry.ERROR,
	e, null));
	}

	static void logError(String message) {
	fwLog.log(new FrameworkLogEntry(ForcedExportsRegistry.class.getName(),
	message,
	FrameworkLogEntry.ERROR,
	null, null));
	}

	private static void readForcedExports() {
	// read forced exports from config.ini (system properties), or file(s)
	deniedForcedExports= new HashMap<String, String>();
	grantedForcedExports= new HashMap<String, String>();
	readForcedExportsFromProperty(FORCED_EXPORTS_DENIED, AspectPermission.DENY);
	readForcedExportsFromProperty(FORCED_EXPORTS_GRANTED, AspectPermission.GRANT);
	}

	private static void readForcedExportsFromProperty(String propKey, AspectPermission perm) {
	String value= System.getProperty(propKey);
	if (value != null) {
	if (value.length() > 0 && value.charAt(0) == '@') {
	// follows: comma-separated list for filenames to read from:
	int pos = 1;
	while (pos < value.length()) {
	int comma = value.indexOf(',', pos);
	String fileName;
	if (comma > -1) {
	fileName = value.substring(pos, comma);
	pos = comma+1;
	} else {
	fileName = value.substring(pos);
	pos = value.length();
	}
	parseForcedExportsFile(new File(fileName), perm);
	}
	} else {
	parseForcedExports(value, perm);
	}
	}
	}
	/**
	* API:
	* Adds the definitions from a given file to the set of granted forced exports.
	* @param file file to read from
	* @param perm either ALLOW or DENY (via their ordinal()),
	* determines how the found forced export decls are interpreted.
	*/
	public static void parseForcedExportsFile(File file, int perm) {
	parseForcedExportsFile(file, AspectPermission.values()[perm]);
	}
	private static synchronized void parseForcedExportsFile(File file, AspectPermission perm) {
	StringBuffer newVal = new StringBuffer();
	try {
	// read content of one file:
	FileInputStream fis = new FileInputStream(file);
	try (BufferedReader br = new BufferedReader(new InputStreamReader(fis, "UTF8"))) { //$NON-NLS-1$
	String line;
	boolean afterClosingBrace = false;
	while ((line = br.readLine()) != null) {
	line = line.trim();
	if (line.length() > 0) {
	if (line.charAt(0) == '#') continue;
	// may need to replace linebreak after ']' with ',' - to match one-line syntax in config.ini
	char lastReadChar = line.charAt(line.length()-1);
	if (afterClosingBrace && lastReadChar != ',')
	newVal.append(',');
	afterClosingBrace = lastReadChar == ']';

	newVal.append(line);
	}
	}
	if (newVal.length() > 0)
	parseForcedExports(newVal.toString(), perm);
	}
	} catch (IOException e) {
	fwLog.log(new FrameworkLogEntry(OTStorageHook.class.getName(),
	"failed to read forcedExports file "+file.getName(), //$NON-NLS-1$
	FrameworkLogEntry.ERROR, e, null));
	}
	}
	/* Adds the given definitions to the set of granted forced exports. */
	private static void parseForcedExports(String value, AspectPermission perm) {
	HashMap<String, String> map = getForcedExportsMap(perm);
	if (map == null) return; // DONT_CARE
	int pos = 0;
	String[] values = new String[2]; // { BaseBundleID , PackageExports }
	while (true) {
	pos = getForcedExportForOneBase(value, pos, values);
	String plugin= values[0];
	String pack= values[1];
	if (map.containsKey(plugin)) {
	String oldPack = map.get(plugin);
	pack = oldPack+','+pack; // append to existing definition
	}
	map.put(plugin, pack);
	if (pos >= value.length())
	break; // eot: done without errors
	if (value.charAt(pos) != ',')
	throwSyntaxError(value, pos, "missing ','"); //$NON-NLS-1$
	pos++; // skip the ','
	}
	}
	/**
	* fetch one chunk of forced exports specification from `spec`:
	* <ul>
	* <li>my.base.plugin[<em>specification-of-force-exported-packages</em>]<em>tail</em></li>
	* </ul>
	* is split into:
	* <ul>
	* <li>my.base.plugin</li>
	* <li><em>specification-of-force-exported-packages</em></li>
	* </ul>
	* and return value points to <em>tail</em>
	* @param spec where to read from
	* @param start where to start reading (within spec)
	* @param value store result chunks in this array: [0] = base plugin, [1] = packages specification
	* @return position after what has been interpreted so far
	*/
	private static int getForcedExportForOneBase(String spec, int start, String[] values) {
	int open = spec.indexOf('[', start);
	if (open == -1)
	throwSyntaxError(spec, start, "missing '['"); //$NON-NLS-1$
	int close = spec.indexOf(']', start);
	if (close == -1)
	throwSyntaxError(spec, open, "missing ']'"); //$NON-NLS-1$
	values[0] = spec.substring(start, open);
	values[1] = spec.substring(open+1, close);
	return close+1;
	}

	private static void throwSyntaxError(String spec, int pos, String string) {
	throw new RuntimeException("Illegal syntax in 'forcedExports' directive at position "+pos+" (not counting whitespace): "+string+"\n value is:\n"+spec); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$
	}

	private static HashMap<String, String> getForcedExportsMap(AspectPermission perm) {
	switch (perm) {
	case GRANT: return grantedForcedExports;
	case DENY: return deniedForcedExports;
	case UNDEFINED: return null;
	// default: // not implementing a default case, want to be warned when new enum-constants are added
	}
	// for binary compatibility; see also https://bugs.eclipse.org/bugs/show_bug.cgi?id=265744
	throw new IncompatibleClassChangeError("enum "+AspectPermission.class.getName()+" has changed unexpectedly."); //$NON-NLS-1$ //$NON-NLS-2$
	}

	/**
	* API for {@link OTStorageHook.StorageHookImpl}.
	* Query whether any forced-exports are declared for the given base bundle.
	* @param baseBundleId
	* @param the permission we are asking for
	* @return comma-separated package names
	*/
	public static String getGrantedForcedExportsByBase(String baseBundleId) {

	// can be queried before we had a chance to initialize our data structures
	synchronized (OTStorageHook.class) {
	if (grantedForcedExports == null)
	readForcedExports();
	}

	String exports = grantedForcedExports.get(baseBundleId);
	if (exports != null) {
	// yes, we need to add forced exports:
	if (!exports.contains(XFRIENDS)) { // FIXME: check once for each package?
	// invalid directive:
	grantedForcedExports.remove(baseBundleId);
	logError("config.ini: missing x-friends directive in forced export of "+exports); //$NON-NLS-1$
	return null; // don't install illegal forced exports
	}
	}
	return exports;
	}

	/**
	* API for org.eclipse.objectteams.otequinox (as a service and using reflection).
	* Query whether any forced-exports are declared in config.ini (or other location)
	* for the given aspect bundle.
	* @param aspectBundleId
	* @param the permission we are asking for
	* @return list of pairs (baseBundleId x packageName)
	*/
	public static /@NonNull/ List<String[]> getForcedExportsByAspect(String aspectBundleId, int perm)
	{
	// can be queried before we had a chance to initialize our data structures
	synchronized (OTStorageHook.class) {
	if (grantedForcedExports == null)
	readForcedExports();
	}

	ArrayList<String[]> result= new ArrayList<String[]>(5);

	HashMap<String, String> map = getForcedExportsMap(AspectPermission.values()[perm]);
	if (map == null)
	return result; // DONT_CARE: useless query.

	for (Map.Entry<String,String> entry: map.entrySet()) {
	String export= entry.getValue();
	int start = 0;
	while (start >= 0 && start < export.length()) {
	if (start > 0) {
	// skip separator after previous entry
	if (export.charAt(start) == ',')
	start++;
	else
	logError("Error parsing forced exports: "+export+", comma expected at position "+start); //$NON-NLS-1$ //$NON-NLS-2$
	}
	int pos= export.indexOf(';'+XFRIENDS, start);
	if (pos == -1)
	break;
	String packageName = export.substring(start, pos);
	List<String> aspectBundles = new ArrayList<String>();
	start = scanAspectBundles(export, pos+XFRIENDS.length()+1, aspectBundles);
	for (String aspect : aspectBundles) {
	if (aspect.equals(aspectBundleId)) {
	result.add(new String[]{entry.getKey(), packageName});
	}
	}
	}
	}
	return result;
	}

	private static int scanAspectBundles(String export, int pos, List<String> result) {
	String termChars = ",]"; //$NON-NLS-1$
	if (export.charAt(pos) == '"') {
	pos++;
	termChars = "\""; //$NON-NLS-1$
	}
	int start = pos;
	while (pos < export.length()) {
	char c = export.charAt(pos);
	switch (c) {
	case ',':
	case ']':
	case '"':
	String next = export.substring(start, pos);
	result.add(next);
	start = pos+1;
	if (termChars.indexOf(c) != -1)
	return start;
	break;
	}
	pos++;
	}
	logError("Unterminated forced exports: "+export); //$NON-NLS-1$
	if (pos > start)
	result.add(export.substring(start));
	return export.length();
	}

	}