org.eclipse.tips.ide/src/org/eclipse/tips/ide/internal/IDETipManager.java - platform/eclipse.platform.ua - Git at Google

 /*******************************************************************************
  * Copyright (c) 2018 Remain Software
  * 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
  *
  * Contributors:
  *     wim.jongman@remainsoftware.com - initial API and implementation
  *******************************************************************************/
 package org.eclipse.tips.ide.internal;

 import java.io.ByteArrayInputStream;
 import java.io.File;
 import java.io.IOException;
 import java.text.MessageFormat;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;

 import javax.xml.parsers.DocumentBuilderFactory;

 import org.eclipse.core.expressions.EvaluationResult;
 import org.eclipse.core.expressions.Expression;
 import org.eclipse.core.expressions.ExpressionConverter;
 import org.eclipse.core.expressions.IEvaluationContext;
 import org.eclipse.core.runtime.IProgressMonitor;
 import org.eclipse.core.runtime.IStatus;
 import org.eclipse.core.runtime.Status;
 import org.eclipse.core.runtime.SubMonitor;
 import org.eclipse.core.runtime.jobs.Job;
 import org.eclipse.tips.core.ITipManager;
 import org.eclipse.tips.core.Tip;
 import org.eclipse.tips.core.TipProvider;
 import org.eclipse.tips.core.internal.LogUtil;
 import org.eclipse.tips.core.internal.TipManager;
 import org.eclipse.tips.ui.internal.DefaultTipManager;
 import org.eclipse.ui.PlatformUI;
 import org.eclipse.ui.services.IEvaluationService;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;

 /**
  * Class to manage the tip providers and start the tip of the day UI.
  */
 @SuppressWarnings("restriction")
 public class IDETipManager extends DefaultTipManager {

 	private static final String EMPTY = ""; //$NON-NLS-1$

 	private TipSourceProvider fSourceProvider = new TipSourceProvider(this);

 	private Map<String, List<Integer>> fReadTips = TipsPreferences.getReadState();

 	private boolean fNewTips;

 	private boolean fSourceProviderAdded;

 	private static IDETipManager instance = new IDETipManager();

 	/**
 	 * @return the tip manager instance.
 	 */
 	public static synchronized ITipManager getInstance() {
 		if (instance.isDisposed()) {
 			instance = new IDETipManager();
 		}
 		return instance;
 	}

 	private IDETipManager() {
 	}

 	@Override
 	public ITipManager register(TipProvider provider) {
 		log(LogUtil.info(Messages.IDETipManager_0 + provider.getID()));
 		super.register(provider);
 		load(provider);
 		return this;
 	}

 	private void load(TipProvider provider) {
 		Job job = new Job(MessageFormat.format(Messages.IDETipManager_1, provider.getID())) {
 			@Override
 			protected IStatus run(IProgressMonitor monitor) {
 				return provider.loadNewTips(monitor);
 			}
 		};
 		job.addJobChangeListener(new ProviderLoadJobChangeListener(this, provider));
 		job.schedule();
 		provider.getManager().log(LogUtil.info(MessageFormat.format(Messages.IDETipManager_2, provider.getID())));
 	}

 	@Override
 	public ITipManager open(boolean startUp) {
 		if (isOpen()) {
 			super.open(startUp);
 			return this;
 		}
 		if (!fSourceProviderAdded) {
 			IEvaluationService evaluationService = PlatformUI.getWorkbench().getService(IEvaluationService.class);
 			evaluationService.addSourceProvider(fSourceProvider);
 			fSourceProviderAdded = true;
 		}
 		return super.open(startUp, Plugin.getInstance().getDialogSettings());
 	}

 	/**
 	 * Saves the tip read status to disk.
 	 *
 	 * @param pReadTips the tips to save
 	 *
 	 */
 	private void saveReadState(Map<String, List<Integer>> pReadTips) {
 		Job job = new Job(Messages.IDETipManager_3) {
 			@Override
 			protected IStatus run(IProgressMonitor monitor) {
 				SubMonitor subMonitor = SubMonitor.convert(monitor, IProgressMonitor.UNKNOWN);
 				subMonitor.setTaskName(Messages.IDETipManager_4);
 				IStatus status = TipsPreferences.saveReadState(pReadTips);
 				subMonitor.done();
 				return status;
 			}
 		};
 		job.schedule();
 	}

 	/**
 	 * Calculates the new tip count to find if we need to expose the status trim
 	 * tool item.
 	 *
 	 * @param newTips
 	 */
 	private void refreshUI() {
 		boolean newTips = hasNewTips();
 		Job job = new Job(Messages.IDETipManager_5) {
 			@Override
 			protected IStatus run(IProgressMonitor monitor) {
 				setNewTips(newTips);
 				return Status.OK_STATUS;
 			}
 		};
 		job.setSystem(true);
 		job.schedule();
 	}

 	private boolean hasNewTips() {
 		log(LogUtil.info("START: Query all providers for new tips."));//$NON-NLS-1$
 		int newTipCount = 0;
 		for (TipProvider provider : getProviders()) {
 			newTipCount += provider.getTips(tip -> !isRead(tip)).size();
 		}
 		log(LogUtil.info("END:   Query all providers for new tips: " + (newTipCount > 0)));//$NON-NLS-1$
 		return newTipCount > 0;
 	}

 	@Override
 	public int getStartupBehavior() {
 		return TipsPreferences.getStartupBehavior();
 	}

 	@Override
 	public TipManager setStartupBehavior(int startupBehavior) {
 		TipsPreferences.setStartupBehavior(startupBehavior);
 		return this;
 	}

 	@Override
 	public boolean mustServeReadTips() {
 		return TipsPreferences.isServeReadTips();
 	}

 	@Override
 	public TipManager setServeReadTips(boolean serveRead) {
 		TipsPreferences.setServeReadTips(serveRead);
 		return this;
 	}

 	@Override
 	public ITipManager log(IStatus status) {
 		TipsPreferences.log(status);
 		return this;
 	}

 	@Override
 	public boolean isRead(Tip tip) {
 		if (fReadTips.containsKey(tip.getProviderId())
 				&& fReadTips.get(tip.getProviderId()).contains(Integer.valueOf(tip.hashCode()))) {
 			return true;
 		}
 		return false;
 	}

 	@Override
 	public synchronized TipManager setAsRead(Tip tip) {
 		if (!isRead(tip)) {
 			List<Integer> readTips = fReadTips.get(tip.getProviderId());
 			if (readTips == null) {
 				readTips = new ArrayList<>();
 				fReadTips.put(tip.getProviderId(), readTips);
 			}
 			readTips.add(Integer.valueOf(tip.hashCode()));
 		}
 		return this;
 	}

 	protected synchronized IDETipManager setNewTips(boolean newTips) {
 		log(LogUtil.info(MessageFormat.format(Messages.IDETipManager_6, newTips + EMPTY)));
 		boolean newValue = newTips && getStartupBehavior() != START_DISABLE;
 		if (fNewTips != newValue) {
 			fNewTips = newValue;
 			fSourceProvider.setStatus(fNewTips);
 		}
 		return this;
 	}

 	@Override
 	public void dispose() {
 		try {
 			refreshUI();
 			saveReadState(Collections.unmodifiableMap(fReadTips));
 		} finally {
 			super.dispose();
 		}
 	}

 	/**
 	 * {@inheritDoc}
 	 * <p>
 	 * The weight is determined by the enablement expression. If there is no
 	 * enablement expression then the weight is 20. If there is a non matching
 	 * enablement then the weight is 30. If there is a matching enablement then the
 	 * weight is 10.
 	 *
 	 * @param provider the provider
 	 *
 	 * @return the weight
 	 */
 	@Override
 	public int getPriority(TipProvider provider) {
 		log(LogUtil.info(MessageFormat.format(Messages.IDETipManager_8, provider.getExpression())));
 		int priority = doGetPriority(provider.getExpression());
 		log(LogUtil.info(MessageFormat.format(Messages.IDETipManager_9, Integer.valueOf(priority))));
 		return priority;
 	}

 	private int doGetPriority(String expression) {
 		if (expression == null) {
 			return 20;
 		}
 		try {
 			String myExpression = "<enablement>" + expression + "</enablement>"; //$NON-NLS-1$ //$NON-NLS-2$
 			myExpression = "<?xml version=\"1.0\"?>" + myExpression; //$NON-NLS-1$
 			DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
 			Document doc = factory.newDocumentBuilder().parse(new ByteArrayInputStream(myExpression.getBytes()));
 			Element element = (Element) doc.getElementsByTagName("enablement").item(0); //$NON-NLS-1$
 			Expression expressionObj = ExpressionConverter.getDefault().perform(element);
 			final EvaluationResult result = expressionObj.evaluate(getEvaluationContext());
 			if (result == EvaluationResult.TRUE) {
 				return 10;
 			} else {
 				return 30;
 			}
 		} catch (Exception e) {
 			log(LogUtil.error(e));
 			return 20;
 		}
 	}

 	/**
 	 *
 	 * @return Evaluation Context to evaluate core expression
 	 */
 	private static IEvaluationContext getEvaluationContext() {
 		IEvaluationService evalService = PlatformUI.getWorkbench().getService(IEvaluationService.class);
 		IEvaluationContext currentState = evalService.getCurrentState();
 		return currentState;
 	}

 	/**
 	 * Returns the state location of the IDE tips. First the property
 	 * "org.eclipse.tips.statelocation" is read. If it does not exist then the state
 	 * location will be <b>${user.home}/.eclipse/org.eclipse.tips.state</b>
 	 *
 	 * @return the state location file
 	 * @throws Exception if something went wrong
 	 */
 	public static File getStateLocation() throws Exception {
 		String stateLocation = System.getProperty("org.eclipse.tips.statelocation"); //$NON-NLS-1$
 		if (stateLocation == null) {
 			stateLocation = System.getProperty("user.home") + File.separator + ".eclipse" + File.separator //$NON-NLS-1$ //$NON-NLS-2$
 					+ "org.eclipse.tips.state"; //$NON-NLS-1$
 		}
 		File locationDir = new File(stateLocation);
 		if (!locationDir.exists()) {
 			locationDir.mkdirs();
 		}

 		if (!locationDir.canRead() || !locationDir.canWrite()) {
 			throw new IOException(MessageFormat.format(Messages.IDETipManager_18, locationDir.getAbsolutePath()));
 		}
 		return locationDir;
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2018 Remain Software
	* 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
	*
	* Contributors:
	* wim.jongman@remainsoftware.com - initial API and implementation
	*******************************************************************************/
	package org.eclipse.tips.ide.internal;

	import java.io.ByteArrayInputStream;
	import java.io.File;
	import java.io.IOException;
	import java.text.MessageFormat;
	import java.util.ArrayList;
	import java.util.Collections;
	import java.util.List;
	import java.util.Map;

	import javax.xml.parsers.DocumentBuilderFactory;

	import org.eclipse.core.expressions.EvaluationResult;
	import org.eclipse.core.expressions.Expression;
	import org.eclipse.core.expressions.ExpressionConverter;
	import org.eclipse.core.expressions.IEvaluationContext;
	import org.eclipse.core.runtime.IProgressMonitor;
	import org.eclipse.core.runtime.IStatus;
	import org.eclipse.core.runtime.Status;
	import org.eclipse.core.runtime.SubMonitor;
	import org.eclipse.core.runtime.jobs.Job;
	import org.eclipse.tips.core.ITipManager;
	import org.eclipse.tips.core.Tip;
	import org.eclipse.tips.core.TipProvider;
	import org.eclipse.tips.core.internal.LogUtil;
	import org.eclipse.tips.core.internal.TipManager;
	import org.eclipse.tips.ui.internal.DefaultTipManager;
	import org.eclipse.ui.PlatformUI;
	import org.eclipse.ui.services.IEvaluationService;
	import org.w3c.dom.Document;
	import org.w3c.dom.Element;

	/**
	* Class to manage the tip providers and start the tip of the day UI.
	*/
	@SuppressWarnings("restriction")
	public class IDETipManager extends DefaultTipManager {

	private static final String EMPTY = ""; //$NON-NLS-1$

	private TipSourceProvider fSourceProvider = new TipSourceProvider(this);

	private Map<String, List<Integer>> fReadTips = TipsPreferences.getReadState();

	private boolean fNewTips;

	private boolean fSourceProviderAdded;

	private static IDETipManager instance = new IDETipManager();

	/**
	* @return the tip manager instance.
	*/
	public static synchronized ITipManager getInstance() {
	if (instance.isDisposed()) {
	instance = new IDETipManager();
	}
	return instance;
	}

	private IDETipManager() {
	}

	@Override
	public ITipManager register(TipProvider provider) {
	log(LogUtil.info(Messages.IDETipManager_0 + provider.getID()));
	super.register(provider);
	load(provider);
	return this;
	}

	private void load(TipProvider provider) {
	Job job = new Job(MessageFormat.format(Messages.IDETipManager_1, provider.getID())) {
	@Override
	protected IStatus run(IProgressMonitor monitor) {
	return provider.loadNewTips(monitor);
	}
	};
	job.addJobChangeListener(new ProviderLoadJobChangeListener(this, provider));
	job.schedule();
	provider.getManager().log(LogUtil.info(MessageFormat.format(Messages.IDETipManager_2, provider.getID())));
	}

	@Override
	public ITipManager open(boolean startUp) {
	if (isOpen()) {
	super.open(startUp);
	return this;
	}
	if (!fSourceProviderAdded) {
	IEvaluationService evaluationService = PlatformUI.getWorkbench().getService(IEvaluationService.class);
	evaluationService.addSourceProvider(fSourceProvider);
	fSourceProviderAdded = true;
	}
	return super.open(startUp, Plugin.getInstance().getDialogSettings());
	}

	/**
	* Saves the tip read status to disk.
	*
	* @param pReadTips the tips to save
	*
	*/
	private void saveReadState(Map<String, List<Integer>> pReadTips) {
	Job job = new Job(Messages.IDETipManager_3) {
	@Override
	protected IStatus run(IProgressMonitor monitor) {
	SubMonitor subMonitor = SubMonitor.convert(monitor, IProgressMonitor.UNKNOWN);
	subMonitor.setTaskName(Messages.IDETipManager_4);
	IStatus status = TipsPreferences.saveReadState(pReadTips);
	subMonitor.done();
	return status;
	}
	};
	job.schedule();
	}

	/**
	* Calculates the new tip count to find if we need to expose the status trim
	* tool item.
	*
	* @param newTips
	*/
	private void refreshUI() {
	boolean newTips = hasNewTips();
	Job job = new Job(Messages.IDETipManager_5) {
	@Override
	protected IStatus run(IProgressMonitor monitor) {
	setNewTips(newTips);
	return Status.OK_STATUS;
	}
	};
	job.setSystem(true);
	job.schedule();
	}

	private boolean hasNewTips() {
	log(LogUtil.info("START: Query all providers for new tips."));//$NON-NLS-1$
	int newTipCount = 0;
	for (TipProvider provider : getProviders()) {
	newTipCount += provider.getTips(tip -> !isRead(tip)).size();
	}
	log(LogUtil.info("END: Query all providers for new tips: " + (newTipCount > 0)));//$NON-NLS-1$
	return newTipCount > 0;
	}

	@Override
	public int getStartupBehavior() {
	return TipsPreferences.getStartupBehavior();
	}

	@Override
	public TipManager setStartupBehavior(int startupBehavior) {
	TipsPreferences.setStartupBehavior(startupBehavior);
	return this;
	}

	@Override
	public boolean mustServeReadTips() {
	return TipsPreferences.isServeReadTips();
	}

	@Override
	public TipManager setServeReadTips(boolean serveRead) {
	TipsPreferences.setServeReadTips(serveRead);
	return this;
	}

	@Override
	public ITipManager log(IStatus status) {
	TipsPreferences.log(status);
	return this;
	}

	@Override
	public boolean isRead(Tip tip) {
	if (fReadTips.containsKey(tip.getProviderId())
	&& fReadTips.get(tip.getProviderId()).contains(Integer.valueOf(tip.hashCode()))) {
	return true;
	}
	return false;
	}

	@Override
	public synchronized TipManager setAsRead(Tip tip) {
	if (!isRead(tip)) {
	List<Integer> readTips = fReadTips.get(tip.getProviderId());
	if (readTips == null) {
	readTips = new ArrayList<>();
	fReadTips.put(tip.getProviderId(), readTips);
	}
	readTips.add(Integer.valueOf(tip.hashCode()));
	}
	return this;
	}

	protected synchronized IDETipManager setNewTips(boolean newTips) {
	log(LogUtil.info(MessageFormat.format(Messages.IDETipManager_6, newTips + EMPTY)));
	boolean newValue = newTips && getStartupBehavior() != START_DISABLE;
	if (fNewTips != newValue) {
	fNewTips = newValue;
	fSourceProvider.setStatus(fNewTips);
	}
	return this;
	}

	@Override
	public void dispose() {
	try {
	refreshUI();
	saveReadState(Collections.unmodifiableMap(fReadTips));
	} finally {
	super.dispose();
	}
	}

	/**
	* {@inheritDoc}
	* <p>
	* The weight is determined by the enablement expression. If there is no
	* enablement expression then the weight is 20. If there is a non matching
	* enablement then the weight is 30. If there is a matching enablement then the
	* weight is 10.
	*
	* @param provider the provider
	*
	* @return the weight
	*/
	@Override
	public int getPriority(TipProvider provider) {
	log(LogUtil.info(MessageFormat.format(Messages.IDETipManager_8, provider.getExpression())));
	int priority = doGetPriority(provider.getExpression());
	log(LogUtil.info(MessageFormat.format(Messages.IDETipManager_9, Integer.valueOf(priority))));
	return priority;
	}

	private int doGetPriority(String expression) {
	if (expression == null) {
	return 20;
	}
	try {
	String myExpression = "<enablement>" + expression + "</enablement>"; //$NON-NLS-1$ //$NON-NLS-2$
	myExpression = "<?xml version=\"1.0\"?>" + myExpression; //$NON-NLS-1$
	DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
	Document doc = factory.newDocumentBuilder().parse(new ByteArrayInputStream(myExpression.getBytes()));
	Element element = (Element) doc.getElementsByTagName("enablement").item(0); //$NON-NLS-1$
	Expression expressionObj = ExpressionConverter.getDefault().perform(element);
	final EvaluationResult result = expressionObj.evaluate(getEvaluationContext());
	if (result == EvaluationResult.TRUE) {
	return 10;
	} else {
	return 30;
	}
	} catch (Exception e) {
	log(LogUtil.error(e));
	return 20;
	}
	}

	/**
	*
	* @return Evaluation Context to evaluate core expression
	*/
	private static IEvaluationContext getEvaluationContext() {
	IEvaluationService evalService = PlatformUI.getWorkbench().getService(IEvaluationService.class);
	IEvaluationContext currentState = evalService.getCurrentState();
	return currentState;
	}

	/**
	* Returns the state location of the IDE tips. First the property
	* "org.eclipse.tips.statelocation" is read. If it does not exist then the state
	* location will be <b>${user.home}/.eclipse/org.eclipse.tips.state</b>
	*
	* @return the state location file
	* @throws Exception if something went wrong
	*/
	public static File getStateLocation() throws Exception {
	String stateLocation = System.getProperty("org.eclipse.tips.statelocation"); //$NON-NLS-1$
	if (stateLocation == null) {
	stateLocation = System.getProperty("user.home") + File.separator + ".eclipse" + File.separator //$NON-NLS-1$ //$NON-NLS-2$
	+ "org.eclipse.tips.state"; //$NON-NLS-1$
	}
	File locationDir = new File(stateLocation);
	if (!locationDir.exists()) {
	locationDir.mkdirs();
	}

	if (!locationDir.canRead() \|\| !locationDir.canWrite()) {
	throw new IOException(MessageFormat.format(Messages.IDETipManager_18, locationDir.getAbsolutePath()));
	}
	return locationDir;
	}
	}