001/*
002 * SonarQube, open source software quality management tool.
003 * Copyright (C) 2008-2013 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * SonarQube is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * SonarQube is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019 */
020package org.sonar.api.config;
021
022import com.google.common.base.Strings;
023import com.google.common.collect.Maps;
024import org.apache.commons.lang.StringUtils;
025import org.sonar.api.*;
026import org.sonar.api.Properties;
027import org.sonar.api.config.internal.Category;
028import org.sonar.api.config.internal.SubCategory;
029import org.sonar.api.utils.AnnotationUtils;
030
031import javax.annotation.Nullable;
032
033import java.util.*;
034
035/**
036 * Metadata of all the properties declared by plugins
037 *
038 * @since 2.12
039 */
040public final class PropertyDefinitions implements BatchComponent, ServerComponent {
041
042  private final Map<String, PropertyDefinition> definitions = Maps.newHashMap();
043  private final Map<String, Category> categories = Maps.newHashMap();
044  private final Map<String, SubCategory> subcategories = Maps.newHashMap();
045
046  // deprecated key -> new key
047  private final Map<String, String> deprecatedKeys = Maps.newHashMap();
048
049  public PropertyDefinitions(Object... components) {
050    if (components != null) {
051      addComponents(Arrays.asList(components));
052    }
053  }
054
055  public PropertyDefinitions(Collection<PropertyDefinition> components) {
056    addComponents(components);
057  }
058
059  public PropertyDefinitions addComponents(Collection components) {
060    return addComponents(components, "");
061  }
062
063  public PropertyDefinitions addComponents(Collection components, String defaultCategory) {
064    for (Object component : components) {
065      addComponent(component, defaultCategory);
066    }
067    return this;
068  }
069
070  public PropertyDefinitions addComponent(Object object) {
071    return addComponent(object, "");
072  }
073
074  public PropertyDefinitions addComponent(Object component, String defaultCategory) {
075    addComponentFromAnnotationProperty(component, defaultCategory);
076    if (component instanceof PropertyDefinition) {
077      PropertyDefinition propertyDefinition = (PropertyDefinition) component;
078      add(propertyDefinition, defaultCategory);
079    }
080    return this;
081  }
082
083  private PropertyDefinitions addComponentFromAnnotationProperty(Object component, String defaultCategory) {
084    Properties annotations = AnnotationUtils.getAnnotation(component, Properties.class);
085    if (annotations != null) {
086      for (Property property : annotations.value()) {
087        addProperty(property, defaultCategory);
088      }
089    }
090    Property annotation = AnnotationUtils.getAnnotation(component, Property.class);
091    if (annotation != null) {
092      addProperty(annotation, defaultCategory);
093    }
094    return this;
095  }
096
097  private PropertyDefinitions addProperty(Property property, String defaultCategory) {
098    PropertyDefinition definition = PropertyDefinition.create(property);
099    return add(definition, defaultCategory);
100  }
101
102  private PropertyDefinitions add(PropertyDefinition definition, String defaultCategory) {
103    if (!definitions.containsKey(definition.key())) {
104      definitions.put(definition.key(), definition);
105      String category = StringUtils.defaultIfBlank(definition.category(), defaultCategory);
106      categories.put(definition.key(), new Category(category));
107      String subcategory = StringUtils.defaultIfBlank(definition.subCategory(), category);
108      subcategories.put(definition.key(), new SubCategory(subcategory));
109      if (!Strings.isNullOrEmpty(definition.deprecatedKey()) && !definition.deprecatedKey().equals(definition.key())) {
110        deprecatedKeys.put(definition.deprecatedKey(), definition.key());
111      }
112    }
113    return this;
114  }
115
116  public PropertyDefinition get(String key) {
117    return definitions.get(validKey(key));
118  }
119
120  public Collection<PropertyDefinition> getAll() {
121    return definitions.values();
122  }
123
124  public String validKey(String key) {
125    return StringUtils.defaultString(deprecatedKeys.get(key), key);
126  }
127
128  /**
129   * @since 3.6
130   * @deprecated since 3.7 use {@link #propertiesByCategory(String)}
131   */
132  @Deprecated
133  public Map<String, Map<String, Collection<PropertyDefinition>>> getPropertiesByCategory(@Nullable String qualifier) {
134    Map<String, Map<String, Collection<PropertyDefinition>>> byCategory = new HashMap<String, Map<String, Collection<PropertyDefinition>>>();
135
136    for (PropertyDefinition definition : getAll()) {
137      if (qualifier == null ? definition.global() : definition.qualifiers().contains(qualifier)) {
138        String category = getCategory(definition.key());
139        if (!byCategory.containsKey(category)) {
140          byCategory.put(category, new HashMap<String, Collection<PropertyDefinition>>());
141        }
142        String subCategory = getSubCategory(definition.key());
143        if (!byCategory.get(category).containsKey(subCategory)) {
144          byCategory.get(category).put(subCategory, new ArrayList<PropertyDefinition>());
145        }
146        byCategory.get(category).get(subCategory).add(definition);
147      }
148    }
149
150    return byCategory;
151  }
152
153  /**
154   * @since 3.6
155   * @deprecated since 3.7 use {@link #propertiesByCategory(String)}
156   */
157  @Deprecated
158  public Map<String, Map<String, Collection<PropertyDefinition>>> getPropertiesByCategory() {
159    return getPropertiesByCategory(null);
160  }
161
162  /**
163   * @since 3.7
164   */
165  public Map<Category, Map<SubCategory, Collection<PropertyDefinition>>> propertiesByCategory(@Nullable String qualifier) {
166    Map<Category, Map<SubCategory, Collection<PropertyDefinition>>> byCategory = new HashMap<Category, Map<SubCategory, Collection<PropertyDefinition>>>();
167    if (qualifier == null) {
168      // Special categories on global page
169      HashMap<SubCategory, Collection<PropertyDefinition>> emailSubCategories = new HashMap<SubCategory, Collection<PropertyDefinition>>();
170      emailSubCategories.put(new SubCategory("email", true), new ArrayList<PropertyDefinition>());
171      byCategory.put(new Category(CoreProperties.CATEGORY_GENERAL, false), emailSubCategories);
172
173      HashMap<SubCategory, Collection<PropertyDefinition>> licenseSubCategories = new HashMap<SubCategory, Collection<PropertyDefinition>>();
174      licenseSubCategories.put(new SubCategory("server_id", true), new ArrayList<PropertyDefinition>());
175      byCategory.put(new Category(CoreProperties.CATEGORY_LICENSES, false), licenseSubCategories);
176
177      HashMap<SubCategory, Collection<PropertyDefinition>> encryptionSubCategories = new HashMap<SubCategory, Collection<PropertyDefinition>>();
178      encryptionSubCategories.put(new SubCategory("encryption", true), new ArrayList<PropertyDefinition>());
179      byCategory.put(new Category(CoreProperties.CATEGORY_SECURITY, false), encryptionSubCategories);
180    }
181    for (PropertyDefinition definition : getAll()) {
182      if (qualifier == null ? definition.global() : definition.qualifiers().contains(qualifier)) {
183        Category category = categories.get(definition.key());
184        if (!byCategory.containsKey(category)) {
185          byCategory.put(category, new HashMap<SubCategory, Collection<PropertyDefinition>>());
186        }
187        SubCategory subCategory = subcategories.get(definition.key());
188        if (!byCategory.get(category).containsKey(subCategory)) {
189          byCategory.get(category).put(subCategory, new ArrayList<PropertyDefinition>());
190        }
191        byCategory.get(category).get(subCategory).add(definition);
192      }
193    }
194    return byCategory;
195  }
196
197  public String getDefaultValue(String key) {
198    PropertyDefinition def = get(key);
199    if (def == null) {
200      return null;
201    }
202    return StringUtils.defaultIfEmpty(def.defaultValue(), null);
203  }
204
205  public String getCategory(String key) {
206    return categories.get(validKey(key)).toString();
207  }
208
209  public String getSubCategory(String key) {
210    return subcategories.get(validKey(key)).toString();
211  }
212
213  public String getCategory(Property prop) {
214    return getCategory(prop.key());
215  }
216
217  public String getNewKey(String deprecatedKey) {
218    return deprecatedKeys.get(deprecatedKey);
219  }
220
221  public String getDeprecatedKey(String key) {
222    PropertyDefinition def = get(key);
223    if (def == null) {
224      return null;
225    }
226    return StringUtils.defaultIfEmpty(def.deprecatedKey(), null);
227  }
228}