openide/source/com/intellij/featureStatistics/ProductivityFeaturesRegistryImpl.java

package com.intellij.featureStatistics;

import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.util.InvalidDataException;
import com.intellij.openapi.util.NamedJDOMExternalizable;
import com.intellij.openapi.util.Pair;
import com.intellij.openapi.util.WriteExternalException;
import org.jdom.Element;

import java.util.*;

public class ProductivityFeaturesRegistryImpl extends ProductivityFeaturesRegistry implements NamedJDOMExternalizable {
  private static final Logger LOG = Logger.getInstance("#com.intellij.featureStatistics.ProductivityFeaturesRegistry");
  private Map<String, FeatureDescriptor> myFeatures = new HashMap<String, FeatureDescriptor>();
  private Map<String, GroupDescriptor> myGroups = new HashMap<String, GroupDescriptor>();
  private List<Pair<String, ApplicabilityFilter>> myApplicabilityFilters = new ArrayList<Pair<String,ApplicabilityFilter>>();

  private boolean myLoadAdditionFeatures = false;
  public static final String WELCOME = "features.welcome";

  public String getComponentName() {
    return "ProductivityFeaturesRegistry";
  }

  public void initComponent() { }

  public void disposeComponent() {
  }

  public String getExternalFileName() {
    return "ProductivityFeaturesRegistry";
  }

  public void readExternal(Element element) throws InvalidDataException {
    readGroups(element);
    readFilters(element);
  }

  private void lazyLoadFromPluginsFeaturesProviders() {
    final ProductivityFeaturesProvider[] providers = ApplicationManager.getApplication().getComponents(ProductivityFeaturesProvider.class);
    for (int i = 0; providers != null && i < providers.length; i++) {
      ProductivityFeaturesProvider provider = providers[i];
      final GroupDescriptor[] groupDescriptors = provider.getGroupDescriptors();
      for (int j = 0; groupDescriptors != null && j < groupDescriptors.length; j++) {
        GroupDescriptor groupDescriptor = groupDescriptors[j];
        myGroups.put(groupDescriptor.getId(), groupDescriptor);
      }
      final FeatureDescriptor[] featureDescriptors = provider.getFeatureDescriptors();
      for (int j = 0; featureDescriptors != null && j < featureDescriptors.length; j++) {
        FeatureDescriptor featureDescriptor = (FeatureDescriptor)featureDescriptors[j];
        final FeatureDescriptor featureLoadedStatistics = myFeatures.get(featureDescriptor.getId());
        if (featureLoadedStatistics != null){
          featureDescriptor.copyStatistics(featureLoadedStatistics);
        }
        myFeatures.put(featureDescriptor.getId(), featureDescriptor);
      }
      final ApplicabilityFilter[] applicabilityFilters = provider.getApplicabilityFilters();
      for (int j = 0; applicabilityFilters != null && j < applicabilityFilters.length; j++) {
        ApplicabilityFilter applicabilityFilter = applicabilityFilters[j];
        myApplicabilityFilters.add(new Pair<String, ApplicabilityFilter>(applicabilityFilter.getPrefix(), applicabilityFilter));
      }
    }
    myLoadAdditionFeatures = true;
  }

  private void readFilters(Element element) {
    List filters = element.getChildren("filter");
    for (int i = 0; i < filters.size(); i++) {
      Element filterElement = (Element)filters.get(i);
      String className = filterElement.getAttributeValue("class");
      try {
        Class klass = Class.forName(className);
        if (!ApplicabilityFilter.class.isAssignableFrom(klass)) {
          LOG.error("filter class must implement com.intellij.featureSatistics.ApplicabilityFilter");
          continue;
        }

        ApplicabilityFilter filter = (ApplicabilityFilter)klass.newInstance();
        myApplicabilityFilters.add(new Pair<String, ApplicabilityFilter>(filterElement.getAttributeValue("prefix"), filter));
      }
      catch (Exception e) {
        LOG.error("Cannot instantiate filter " + className, e);
      }
    }
  }

  private void readGroups(Element element) {
    List groups = element.getChildren("group");
    for (int i = 0; i < groups.size(); i++) {
      Element groupElement = (Element)groups.get(i);
      readGroup(groupElement);
    }
  }

  private void readGroup(Element groupElement) {
    GroupDescriptor groupDescriptor = new GroupDescriptor();
    groupDescriptor.readExternal(groupElement);
    String groupId = groupDescriptor.getId();
    myGroups.put(groupId, groupDescriptor);
    readFeatures(groupElement, groupDescriptor);
  }

  private void readFeatures(Element groupElement, GroupDescriptor groupDescriptor) {
    List features = groupElement.getChildren("feature");
    for (int i = 0; i < features.size(); i++) {
      Element featureElement = (Element)features.get(i);
      FeatureDescriptor featureDescriptor = new FeatureDescriptor(groupDescriptor);
      featureDescriptor.readExternal(featureElement);
      if (!"todo.html".equals(featureDescriptor.getTipFileName())) {
        myFeatures.put(featureDescriptor.getId(), featureDescriptor);
      }
    }
  }

  public Set<String> getFeatureIds() {
    if (!myLoadAdditionFeatures){
      lazyLoadFromPluginsFeaturesProviders();
    }
    return myFeatures.keySet();
  }

  public FeatureDescriptor getFeatureDescriptor(String id) {
    if (WELCOME.equals(id)) {
      FeatureDescriptor descriptor = new FeatureDescriptor(WELCOME, "AdaptiveWelcome.html", "Productivity Features Guide");
      return descriptor;
    }
    if (!myLoadAdditionFeatures){
      lazyLoadFromPluginsFeaturesProviders();
    }
    return myFeatures.get(id);
  }

  public FeatureDescriptor getFeatureDescriptorEx(String id) {
    if (WELCOME.equals(id)) {
      FeatureDescriptor descriptor = new FeatureDescriptor(WELCOME, "AdaptiveWelcome.html", "Productivity Features Guide");
      return descriptor;
    }
    return myFeatures.get(id);
  }

  public GroupDescriptor getGroupDescriptor(String id) {
    return myGroups.get(id);
  }

  public ApplicabilityFilter[] getMatchingFilters(String featureId) {
    if (!myLoadAdditionFeatures){
      lazyLoadFromPluginsFeaturesProviders();
    }
    List<ApplicabilityFilter> filters = new ArrayList<ApplicabilityFilter>();
    for (int i = 0; i < myApplicabilityFilters.size(); i++) {
      Pair<String, ApplicabilityFilter> pair = myApplicabilityFilters.get(i);
      if (featureId.startsWith(pair.getFirst())) {
        filters.add(pair.getSecond());
      }
    }
    return filters.toArray(new ApplicabilityFilter[filters.size()]);
  }

  public void writeExternal(Element element) throws WriteExternalException {
    throw new WriteExternalException();
  }

  public void addFeatureStatistics(final FeatureDescriptor descriptor) {
    myFeatures.put(descriptor.getId(), descriptor);
  }
}