123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509 |
- /*
- * Copyright (C) 2010, Mathias Kinzler <mathias.kinzler@sap.com>
- * Copyright (C) 2009, Constantine Plotnikov <constantine.plotnikov@gmail.com>
- * Copyright (C) 2007, Dave Watson <dwatson@mimvista.com>
- * Copyright (C) 2008-2010, Google Inc.
- * Copyright (C) 2009, Google, Inc.
- * Copyright (C) 2009, JetBrains s.r.o.
- * Copyright (C) 2007-2008, Robin Rosenberg <robin.rosenberg@dewire.com>
- * Copyright (C) 2006-2008, Shawn O. Pearce <spearce@spearce.org>
- * Copyright (C) 2008, Thad Hughes <thadh@thad.corp.google.com>
- * and other copyright owners as documented in the project's IP log.
- *
- * This program and the accompanying materials are made available
- * under the terms of the Eclipse Distribution License v1.0 which
- * accompanies this distribution, is reproduced below, and is
- * available at http://www.eclipse.org/org/documents/edl-v10.php
- *
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or
- * without modification, are permitted provided that the following
- * conditions are met:
- *
- * - Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * - Redistributions in binary form must reproduce the above
- * copyright notice, this list of conditions and the following
- * disclaimer in the documentation and/or other materials provided
- * with the distribution.
- *
- * - Neither the name of the Eclipse Foundation, Inc. nor the
- * names of its contributors may be used to endorse or promote
- * products derived from this software without specific prior
- * written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
- * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
- * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
- * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
- * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
- * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
- * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
-
- package org.eclipse.jgit.lib;
-
- import java.text.MessageFormat;
- import java.util.AbstractSet;
- import java.util.ArrayList;
- import java.util.Collections;
- 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.concurrent.ConcurrentHashMap;
- import java.util.concurrent.atomic.AtomicReference;
-
- import org.eclipse.jgit.JGitText;
- import org.eclipse.jgit.errors.ConfigInvalidException;
- import org.eclipse.jgit.events.ConfigChangedEvent;
- import org.eclipse.jgit.events.ConfigChangedListener;
- import org.eclipse.jgit.events.ListenerHandle;
- import org.eclipse.jgit.events.ListenerList;
- import org.eclipse.jgit.util.StringUtils;
-
-
- /**
- * Git style {@code .config}, {@code .gitconfig}, {@code .gitmodules} file.
- */
- public class Config {
- private static final String[] EMPTY_STRING_ARRAY = {};
- private static final long KiB = 1024;
- private static final long MiB = 1024 * KiB;
- private static final long GiB = 1024 * MiB;
-
- /** the change listeners */
- private final ListenerList listeners = new ListenerList();
-
- /**
- * Immutable current state of the configuration data.
- * <p>
- * This state is copy-on-write. It should always contain an immutable list
- * of the configuration keys/values.
- */
- private final AtomicReference<State> state;
-
- private final Config baseConfig;
-
- /**
- * Magic value indicating a missing entry.
- * <p>
- * This value is tested for reference equality in some contexts, so we
- * must ensure it is a special copy of the empty string. It also must
- * be treated like the empty string.
- */
- private static final String MAGIC_EMPTY_VALUE = new String();
-
- /** Create a configuration with no default fallback. */
- public Config() {
- this(null);
- }
-
- /**
- * Create an empty configuration with a fallback for missing keys.
- *
- * @param defaultConfig
- * the base configuration to be consulted when a key is missing
- * from this configuration instance.
- */
- public Config(Config defaultConfig) {
- baseConfig = defaultConfig;
- state = new AtomicReference<State>(newState());
- }
-
- /**
- * Escape the value before saving
- *
- * @param x
- * the value to escape
- * @return the escaped value
- */
- private static String escapeValue(final String x) {
- boolean inquote = false;
- int lineStart = 0;
- final StringBuilder r = new StringBuilder(x.length());
- for (int k = 0; k < x.length(); k++) {
- final char c = x.charAt(k);
- switch (c) {
- case '\n':
- if (inquote) {
- r.append('"');
- inquote = false;
- }
- r.append("\\n\\\n");
- lineStart = r.length();
- break;
-
- case '\t':
- r.append("\\t");
- break;
-
- case '\b':
- r.append("\\b");
- break;
-
- case '\\':
- r.append("\\\\");
- break;
-
- case '"':
- r.append("\\\"");
- break;
-
- case ';':
- case '#':
- if (!inquote) {
- r.insert(lineStart, '"');
- inquote = true;
- }
- r.append(c);
- break;
-
- case ' ':
- if (!inquote && r.length() > 0
- && r.charAt(r.length() - 1) == ' ') {
- r.insert(lineStart, '"');
- inquote = true;
- }
- r.append(' ');
- break;
-
- default:
- r.append(c);
- break;
- }
- }
- if (inquote) {
- r.append('"');
- }
- return r.toString();
- }
-
- /**
- * Obtain an integer value from the configuration.
- *
- * @param section
- * section the key is grouped within.
- * @param name
- * name of the key to get.
- * @param defaultValue
- * default value to return if no value was present.
- * @return an integer value from the configuration, or defaultValue.
- */
- public int getInt(final String section, final String name,
- final int defaultValue) {
- return getInt(section, null, name, defaultValue);
- }
-
- /**
- * Obtain an integer value from the configuration.
- *
- * @param section
- * section the key is grouped within.
- * @param subsection
- * subsection name, such a remote or branch name.
- * @param name
- * name of the key to get.
- * @param defaultValue
- * default value to return if no value was present.
- * @return an integer value from the configuration, or defaultValue.
- */
- public int getInt(final String section, String subsection,
- final String name, final int defaultValue) {
- final long val = getLong(section, subsection, name, defaultValue);
- if (Integer.MIN_VALUE <= val && val <= Integer.MAX_VALUE)
- return (int) val;
- throw new IllegalArgumentException(MessageFormat.format(JGitText.get().integerValueOutOfRange
- , section, name));
- }
-
- /**
- * Obtain an integer value from the configuration.
- *
- * @param section
- * section the key is grouped within.
- * @param name
- * name of the key to get.
- * @param defaultValue
- * default value to return if no value was present.
- * @return an integer value from the configuration, or defaultValue.
- */
- public long getLong(String section, String name, long defaultValue) {
- return getLong(section, null, name, defaultValue);
- }
-
- /**
- * Obtain an integer value from the configuration.
- *
- * @param section
- * section the key is grouped within.
- * @param subsection
- * subsection name, such a remote or branch name.
- * @param name
- * name of the key to get.
- * @param defaultValue
- * default value to return if no value was present.
- * @return an integer value from the configuration, or defaultValue.
- */
- public long getLong(final String section, String subsection,
- final String name, final long defaultValue) {
- final String str = getString(section, subsection, name);
- if (str == null)
- return defaultValue;
-
- String n = str.trim();
- if (n.length() == 0)
- return defaultValue;
-
- long mul = 1;
- switch (StringUtils.toLowerCase(n.charAt(n.length() - 1))) {
- case 'g':
- mul = GiB;
- break;
- case 'm':
- mul = MiB;
- break;
- case 'k':
- mul = KiB;
- break;
- }
- if (mul > 1)
- n = n.substring(0, n.length() - 1).trim();
- if (n.length() == 0)
- return defaultValue;
-
- try {
- return mul * Long.parseLong(n);
- } catch (NumberFormatException nfe) {
- throw new IllegalArgumentException(MessageFormat.format(JGitText.get().invalidIntegerValue
- , section, name, str));
- }
- }
-
- /**
- * Get a boolean value from the git config
- *
- * @param section
- * section the key is grouped within.
- * @param name
- * name of the key to get.
- * @param defaultValue
- * default value to return if no value was present.
- * @return true if any value or defaultValue is true, false for missing or
- * explicit false
- */
- public boolean getBoolean(final String section, final String name,
- final boolean defaultValue) {
- return getBoolean(section, null, name, defaultValue);
- }
-
- /**
- * Get a boolean value from the git config
- *
- * @param section
- * section the key is grouped within.
- * @param subsection
- * subsection name, such a remote or branch name.
- * @param name
- * name of the key to get.
- * @param defaultValue
- * default value to return if no value was present.
- * @return true if any value or defaultValue is true, false for missing or
- * explicit false
- */
- public boolean getBoolean(final String section, String subsection,
- final String name, final boolean defaultValue) {
- String n = getRawString(section, subsection, name);
- if (n == null)
- return defaultValue;
- if (MAGIC_EMPTY_VALUE == n)
- return true;
- try {
- return StringUtils.toBoolean(n);
- } catch (IllegalArgumentException err) {
- throw new IllegalArgumentException(MessageFormat.format(JGitText.get().invalidBooleanValue
- , section, name, n));
- }
- }
-
- /**
- * Parse an enumeration from the configuration.
- *
- * @param <T>
- * type of the enumeration object.
- * @param section
- * section the key is grouped within.
- * @param subsection
- * subsection name, such a remote or branch name.
- * @param name
- * name of the key to get.
- * @param defaultValue
- * default value to return if no value was present.
- * @return the selected enumeration value, or {@code defaultValue}.
- */
- public <T extends Enum<?>> T getEnum(final String section,
- final String subsection, final String name, final T defaultValue) {
- final T[] all = allValuesOf(defaultValue);
- return getEnum(all, section, subsection, name, defaultValue);
- }
-
- @SuppressWarnings("unchecked")
- private static <T> T[] allValuesOf(final T value) {
- try {
- return (T[]) value.getClass().getMethod("values").invoke(null);
- } catch (Exception err) {
- String typeName = value.getClass().getName();
- String msg = MessageFormat.format(
- JGitText.get().enumValuesNotAvailable, typeName);
- throw new IllegalArgumentException(msg, err);
- }
- }
-
- /**
- * Parse an enumeration from the configuration.
- *
- * @param <T>
- * type of the enumeration object.
- * @param all
- * all possible values in the enumeration which should be
- * recognized. Typically {@code EnumType.values()}.
- * @param section
- * section the key is grouped within.
- * @param subsection
- * subsection name, such a remote or branch name.
- * @param name
- * name of the key to get.
- * @param defaultValue
- * default value to return if no value was present.
- * @return the selected enumeration value, or {@code defaultValue}.
- */
- public <T extends Enum<?>> T getEnum(final T[] all, final String section,
- final String subsection, final String name, final T defaultValue) {
- String value = getString(section, subsection, name);
- if (value == null)
- return defaultValue;
-
- String n = value.replace(' ', '_');
- T trueState = null;
- T falseState = null;
- for (T e : all) {
- if (StringUtils.equalsIgnoreCase(e.name(), n))
- return e;
- else if (StringUtils.equalsIgnoreCase(e.name(), "TRUE"))
- trueState = e;
- else if (StringUtils.equalsIgnoreCase(e.name(), "FALSE"))
- falseState = e;
- }
-
- // This is an odd little fallback. C Git sometimes allows boolean
- // values in a tri-state with other things. If we have both a true
- // and a false value in our enumeration, assume its one of those.
- //
- if (trueState != null && falseState != null) {
- try {
- return StringUtils.toBoolean(n) ? trueState : falseState;
- } catch (IllegalArgumentException err) {
- // Fall through and use our custom error below.
- }
- }
-
- if (subsection != null)
- throw new IllegalArgumentException(MessageFormat.format(JGitText
- .get().enumValueNotSupported3, section, name, value));
- else
- throw new IllegalArgumentException(MessageFormat.format(JGitText
- .get().enumValueNotSupported2, section, name, value));
- }
-
- /**
- * Get string value
- *
- * @param section
- * the section
- * @param subsection
- * the subsection for the value
- * @param name
- * the key name
- * @return a String value from git config.
- */
- public String getString(final String section, String subsection,
- final String name) {
- return getRawString(section, subsection, name);
- }
-
- /**
- * Get a list of string values
- * <p>
- * If this instance was created with a base, the base's values are returned
- * first (if any).
- *
- * @param section
- * the section
- * @param subsection
- * the subsection for the value
- * @param name
- * the key name
- * @return array of zero or more values from the configuration.
- */
- public String[] getStringList(final String section, String subsection,
- final String name) {
- final String[] baseList;
- if (baseConfig != null)
- baseList = baseConfig.getStringList(section, subsection, name);
- else
- baseList = EMPTY_STRING_ARRAY;
-
- final List<String> lst = getRawStringList(section, subsection, name);
- if (lst != null) {
- final String[] res = new String[baseList.length + lst.size()];
- int idx = baseList.length;
- System.arraycopy(baseList, 0, res, 0, idx);
- for (final String val : lst)
- res[idx++] = val;
- return res;
- }
- return baseList;
- }
-
- /**
- * @param section
- * section to search for.
- * @return set of all subsections of specified section within this
- * configuration and its base configuration; may be empty if no
- * subsection exists.
- */
- public Set<String> getSubsections(final String section) {
- return get(new SubsectionNames(section));
- }
-
- /**
- * @return the sections defined in this {@link Config}
- */
- public Set<String> getSections() {
- return get(new SectionNames());
- }
-
- /**
- * @param section
- * the section
- * @return the list of names defined for this section
- */
- public Set<String> getNames(String section) {
- return getNames(section, null);
- }
-
- /**
- * @param section
- * the section
- * @param subsection
- * the subsection
- * @return the list of names defined for this subsection
- */
- public Set<String> getNames(String section, String subsection) {
- return get(new NamesInSection(section, subsection));
- }
-
- /**
- * Obtain a handle to a parsed set of configuration values.
- *
- * @param <T>
- * type of configuration model to return.
- * @param parser
- * parser which can create the model if it is not already
- * available in this configuration file. The parser is also used
- * as the key into a cache and must obey the hashCode and equals
- * contract in order to reuse a parsed model.
- * @return the parsed object instance, which is cached inside this config.
- */
- @SuppressWarnings("unchecked")
- public <T> T get(final SectionParser<T> parser) {
- final State myState = getState();
- T obj = (T) myState.cache.get(parser);
- if (obj == null) {
- obj = parser.parse(this);
- myState.cache.put(parser, obj);
- }
- return obj;
- }
-
- /**
- * Remove a cached configuration object.
- * <p>
- * If the associated configuration object has not yet been cached, this
- * method has no effect.
- *
- * @param parser
- * parser used to obtain the configuration object.
- * @see #get(SectionParser)
- */
- public void uncache(final SectionParser<?> parser) {
- state.get().cache.remove(parser);
- }
-
- /**
- * Adds a listener to be notified about changes.
- * <p>
- * Clients are supposed to remove the listeners after they are done with
- * them using the {@link ListenerHandle#remove()} method
- *
- * @param listener
- * the listener
- * @return the handle to the registered listener
- */
- public ListenerHandle addChangeListener(ConfigChangedListener listener) {
- return listeners.addConfigChangedListener(listener);
- }
-
- /**
- * Determine whether to issue change events for transient changes.
- * <p>
- * If <code>true</code> is returned (which is the default behavior),
- * {@link #fireConfigChangedEvent()} will be called upon each change.
- * <p>
- * Subclasses that override this to return <code>false</code> are
- * responsible for issuing {@link #fireConfigChangedEvent()} calls
- * themselves.
- *
- * @return <code></code>
- */
- protected boolean notifyUponTransientChanges() {
- return true;
- }
-
- /**
- * Notifies the listeners
- */
- protected void fireConfigChangedEvent() {
- listeners.dispatch(new ConfigChangedEvent());
- }
-
- private String getRawString(final String section, final String subsection,
- final String name) {
- final List<String> lst = getRawStringList(section, subsection, name);
- if (lst != null)
- return lst.get(0);
- else if (baseConfig != null)
- return baseConfig.getRawString(section, subsection, name);
- else
- return null;
- }
-
- private List<String> getRawStringList(final String section,
- final String subsection, final String name) {
- List<String> r = null;
- for (final Entry e : state.get().entryList) {
- if (e.match(section, subsection, name))
- r = add(r, e.value);
- }
- return r;
- }
-
- private static List<String> add(final List<String> curr, final String value) {
- if (curr == null)
- return Collections.singletonList(value);
- if (curr.size() == 1) {
- final List<String> r = new ArrayList<String>(2);
- r.add(curr.get(0));
- r.add(value);
- return r;
- }
- curr.add(value);
- return curr;
- }
-
- private State getState() {
- State cur, upd;
- do {
- cur = state.get();
- final State base = getBaseState();
- if (cur.baseState == base)
- return cur;
- upd = new State(cur.entryList, base);
- } while (!state.compareAndSet(cur, upd));
- return upd;
- }
-
- private State getBaseState() {
- return baseConfig != null ? baseConfig.getState() : null;
- }
-
- /**
- * Add or modify a configuration value. The parameters will result in a
- * configuration entry like this.
- *
- * <pre>
- * [section "subsection"]
- * name = value
- * </pre>
- *
- * @param section
- * section name, e.g "branch"
- * @param subsection
- * optional subsection value, e.g. a branch name
- * @param name
- * parameter name, e.g. "filemode"
- * @param value
- * parameter value
- */
- public void setInt(final String section, final String subsection,
- final String name, final int value) {
- setLong(section, subsection, name, value);
- }
-
- /**
- * Add or modify a configuration value. The parameters will result in a
- * configuration entry like this.
- *
- * <pre>
- * [section "subsection"]
- * name = value
- * </pre>
- *
- * @param section
- * section name, e.g "branch"
- * @param subsection
- * optional subsection value, e.g. a branch name
- * @param name
- * parameter name, e.g. "filemode"
- * @param value
- * parameter value
- */
- public void setLong(final String section, final String subsection,
- final String name, final long value) {
- final String s;
-
- if (value >= GiB && (value % GiB) == 0)
- s = String.valueOf(value / GiB) + " g";
- else if (value >= MiB && (value % MiB) == 0)
- s = String.valueOf(value / MiB) + " m";
- else if (value >= KiB && (value % KiB) == 0)
- s = String.valueOf(value / KiB) + " k";
- else
- s = String.valueOf(value);
-
- setString(section, subsection, name, s);
- }
-
- /**
- * Add or modify a configuration value. The parameters will result in a
- * configuration entry like this.
- *
- * <pre>
- * [section "subsection"]
- * name = value
- * </pre>
- *
- * @param section
- * section name, e.g "branch"
- * @param subsection
- * optional subsection value, e.g. a branch name
- * @param name
- * parameter name, e.g. "filemode"
- * @param value
- * parameter value
- */
- public void setBoolean(final String section, final String subsection,
- final String name, final boolean value) {
- setString(section, subsection, name, value ? "true" : "false");
- }
-
- /**
- * Add or modify a configuration value. The parameters will result in a
- * configuration entry like this.
- *
- * <pre>
- * [section "subsection"]
- * name = value
- * </pre>
- *
- * @param <T>
- * type of the enumeration object.
- * @param section
- * section name, e.g "branch"
- * @param subsection
- * optional subsection value, e.g. a branch name
- * @param name
- * parameter name, e.g. "filemode"
- * @param value
- * parameter value
- */
- public <T extends Enum<?>> void setEnum(final String section,
- final String subsection, final String name, final T value) {
- String n = value.name().toLowerCase().replace('_', ' ');
- setString(section, subsection, name, n);
- }
-
- /**
- * Add or modify a configuration value. The parameters will result in a
- * configuration entry like this.
- *
- * <pre>
- * [section "subsection"]
- * name = value
- * </pre>
- *
- * @param section
- * section name, e.g "branch"
- * @param subsection
- * optional subsection value, e.g. a branch name
- * @param name
- * parameter name, e.g. "filemode"
- * @param value
- * parameter value, e.g. "true"
- */
- public void setString(final String section, final String subsection,
- final String name, final String value) {
- setStringList(section, subsection, name, Collections
- .singletonList(value));
- }
-
- /**
- * Remove a configuration value.
- *
- * @param section
- * section name, e.g "branch"
- * @param subsection
- * optional subsection value, e.g. a branch name
- * @param name
- * parameter name, e.g. "filemode"
- */
- public void unset(final String section, final String subsection,
- final String name) {
- setStringList(section, subsection, name, Collections
- .<String> emptyList());
- }
-
- /**
- * Remove all configuration values under a single section.
- *
- * @param section
- * section name, e.g "branch"
- * @param subsection
- * optional subsection value, e.g. a branch name
- */
- public void unsetSection(String section, String subsection) {
- State src, res;
- do {
- src = state.get();
- res = unsetSection(src, section, subsection);
- } while (!state.compareAndSet(src, res));
- }
-
- private State unsetSection(final State srcState, final String section,
- final String subsection) {
- final int max = srcState.entryList.size();
- final ArrayList<Entry> r = new ArrayList<Entry>(max);
-
- boolean lastWasMatch = false;
- for (Entry e : srcState.entryList) {
- if (e.match(section, subsection)) {
- // Skip this record, it's for the section we are removing.
- lastWasMatch = true;
- continue;
- }
-
- if (lastWasMatch && e.section == null && e.subsection == null)
- continue; // skip this padding line in the section.
- r.add(e);
- }
-
- return newState(r);
- }
-
- /**
- * Set a configuration value.
- *
- * <pre>
- * [section "subsection"]
- * name = value
- * </pre>
- *
- * @param section
- * section name, e.g "branch"
- * @param subsection
- * optional subsection value, e.g. a branch name
- * @param name
- * parameter name, e.g. "filemode"
- * @param values
- * list of zero or more values for this key.
- */
- public void setStringList(final String section, final String subsection,
- final String name, final List<String> values) {
- State src, res;
- do {
- src = state.get();
- res = replaceStringList(src, section, subsection, name, values);
- } while (!state.compareAndSet(src, res));
- if (notifyUponTransientChanges())
- fireConfigChangedEvent();
- }
-
- private State replaceStringList(final State srcState,
- final String section, final String subsection, final String name,
- final List<String> values) {
- final List<Entry> entries = copy(srcState, values);
- int entryIndex = 0;
- int valueIndex = 0;
- int insertPosition = -1;
-
- // Reset the first n Entry objects that match this input name.
- //
- while (entryIndex < entries.size() && valueIndex < values.size()) {
- final Entry e = entries.get(entryIndex);
- if (e.match(section, subsection, name)) {
- entries.set(entryIndex, e.forValue(values.get(valueIndex++)));
- insertPosition = entryIndex + 1;
- }
- entryIndex++;
- }
-
- // Remove any extra Entry objects that we no longer need.
- //
- if (valueIndex == values.size() && entryIndex < entries.size()) {
- while (entryIndex < entries.size()) {
- final Entry e = entries.get(entryIndex++);
- if (e.match(section, subsection, name))
- entries.remove(--entryIndex);
- }
- }
-
- // Insert new Entry objects for additional/new values.
- //
- if (valueIndex < values.size() && entryIndex == entries.size()) {
- if (insertPosition < 0) {
- // We didn't find a matching key above, but maybe there
- // is already a section available that matches. Insert
- // after the last key of that section.
- //
- insertPosition = findSectionEnd(entries, section, subsection);
- }
- if (insertPosition < 0) {
- // We didn't find any matching section header for this key,
- // so we must create a new section header at the end.
- //
- final Entry e = new Entry();
- e.section = section;
- e.subsection = subsection;
- entries.add(e);
- insertPosition = entries.size();
- }
- while (valueIndex < values.size()) {
- final Entry e = new Entry();
- e.section = section;
- e.subsection = subsection;
- e.name = name;
- e.value = values.get(valueIndex++);
- entries.add(insertPosition++, e);
- }
- }
-
- return newState(entries);
- }
-
- private static List<Entry> copy(final State src, final List<String> values) {
- // At worst we need to insert 1 line for each value, plus 1 line
- // for a new section header. Assume that and allocate the space.
- //
- final int max = src.entryList.size() + values.size() + 1;
- final ArrayList<Entry> r = new ArrayList<Entry>(max);
- r.addAll(src.entryList);
- return r;
- }
-
- private static int findSectionEnd(final List<Entry> entries,
- final String section, final String subsection) {
- for (int i = 0; i < entries.size(); i++) {
- Entry e = entries.get(i);
- if (e.match(section, subsection, null)) {
- i++;
- while (i < entries.size()) {
- e = entries.get(i);
- if (e.match(section, subsection, e.name))
- i++;
- else
- break;
- }
- return i;
- }
- }
- return -1;
- }
-
- /**
- * @return this configuration, formatted as a Git style text file.
- */
- public String toText() {
- final StringBuilder out = new StringBuilder();
- for (final Entry e : state.get().entryList) {
- if (e.prefix != null)
- out.append(e.prefix);
- if (e.section != null && e.name == null) {
- out.append('[');
- out.append(e.section);
- if (e.subsection != null) {
- out.append(' ');
- String escaped = escapeValue(e.subsection);
- // make sure to avoid double quotes here
- boolean quoted = escaped.startsWith("\"")
- && escaped.endsWith("\"");
- if (!quoted)
- out.append('"');
- out.append(escaped);
- if (!quoted)
- out.append('"');
- }
- out.append(']');
- } else if (e.section != null && e.name != null) {
- if (e.prefix == null || "".equals(e.prefix))
- out.append('\t');
- out.append(e.name);
- if (MAGIC_EMPTY_VALUE != e.value) {
- out.append(" =");
- if (e.value != null) {
- out.append(' ');
- out.append(escapeValue(e.value));
- }
- }
- if (e.suffix != null)
- out.append(' ');
- }
- if (e.suffix != null)
- out.append(e.suffix);
- out.append('\n');
- }
- return out.toString();
- }
-
- /**
- * Clear this configuration and reset to the contents of the parsed string.
- *
- * @param text
- * Git style text file listing configuration properties.
- * @throws ConfigInvalidException
- * the text supplied is not formatted correctly. No changes were
- * made to {@code this}.
- */
- public void fromText(final String text) throws ConfigInvalidException {
- final List<Entry> newEntries = new ArrayList<Entry>();
- final StringReader in = new StringReader(text);
- Entry last = null;
- Entry e = new Entry();
- for (;;) {
- int input = in.read();
- if (-1 == input)
- break;
-
- final char c = (char) input;
- if ('\n' == c) {
- // End of this entry.
- newEntries.add(e);
- if (e.section != null)
- last = e;
- e = new Entry();
-
- } else if (e.suffix != null) {
- // Everything up until the end-of-line is in the suffix.
- e.suffix += c;
-
- } else if (';' == c || '#' == c) {
- // The rest of this line is a comment; put into suffix.
- e.suffix = String.valueOf(c);
-
- } else if (e.section == null && Character.isWhitespace(c)) {
- // Save the leading whitespace (if any).
- if (e.prefix == null)
- e.prefix = "";
- e.prefix += c;
-
- } else if ('[' == c) {
- // This is a section header.
- e.section = readSectionName(in);
- input = in.read();
- if ('"' == input) {
- e.subsection = readValue(in, true, '"');
- input = in.read();
- }
- if (']' != input)
- throw new ConfigInvalidException(JGitText.get().badGroupHeader);
- e.suffix = "";
-
- } else if (last != null) {
- // Read a value.
- e.section = last.section;
- e.subsection = last.subsection;
- in.reset();
- e.name = readKeyName(in);
- if (e.name.endsWith("\n")) {
- e.name = e.name.substring(0, e.name.length() - 1);
- e.value = MAGIC_EMPTY_VALUE;
- } else
- e.value = readValue(in, false, -1);
-
- } else
- throw new ConfigInvalidException(JGitText.get().invalidLineInConfigFile);
- }
-
- state.set(newState(newEntries));
- }
-
- private State newState() {
- return new State(Collections.<Entry> emptyList(), getBaseState());
- }
-
- private State newState(final List<Entry> entries) {
- return new State(Collections.unmodifiableList(entries), getBaseState());
- }
-
- /**
- * Clear the configuration file
- */
- protected void clear() {
- state.set(newState());
- }
-
- private static String readSectionName(final StringReader in)
- throws ConfigInvalidException {
- final StringBuilder name = new StringBuilder();
- for (;;) {
- int c = in.read();
- if (c < 0)
- throw new ConfigInvalidException(JGitText.get().unexpectedEndOfConfigFile);
-
- if (']' == c) {
- in.reset();
- break;
- }
-
- if (' ' == c || '\t' == c) {
- for (;;) {
- c = in.read();
- if (c < 0)
- throw new ConfigInvalidException(JGitText.get().unexpectedEndOfConfigFile);
-
- if ('"' == c) {
- in.reset();
- break;
- }
-
- if (' ' == c || '\t' == c)
- continue; // Skipped...
- throw new ConfigInvalidException(MessageFormat.format(JGitText.get().badSectionEntry, name));
- }
- break;
- }
-
- if (Character.isLetterOrDigit((char) c) || '.' == c || '-' == c)
- name.append((char) c);
- else
- throw new ConfigInvalidException(MessageFormat.format(JGitText.get().badSectionEntry, name));
- }
- return name.toString();
- }
-
- private static String readKeyName(final StringReader in)
- throws ConfigInvalidException {
- final StringBuilder name = new StringBuilder();
- for (;;) {
- int c = in.read();
- if (c < 0)
- throw new ConfigInvalidException(JGitText.get().unexpectedEndOfConfigFile);
-
- if ('=' == c)
- break;
-
- if (' ' == c || '\t' == c) {
- for (;;) {
- c = in.read();
- if (c < 0)
- throw new ConfigInvalidException(JGitText.get().unexpectedEndOfConfigFile);
-
- if ('=' == c)
- break;
-
- if (';' == c || '#' == c || '\n' == c) {
- in.reset();
- break;
- }
-
- if (' ' == c || '\t' == c)
- continue; // Skipped...
- throw new ConfigInvalidException(JGitText.get().badEntryDelimiter);
- }
- break;
- }
-
- if (Character.isLetterOrDigit((char) c) || c == '-') {
- // From the git-config man page:
- // The variable names are case-insensitive and only
- // alphanumeric characters and - are allowed.
- name.append((char) c);
- } else if ('\n' == c) {
- in.reset();
- name.append((char) c);
- break;
- } else
- throw new ConfigInvalidException(MessageFormat.format(JGitText.get().badEntryName, name));
- }
- return name.toString();
- }
-
- private static String readValue(final StringReader in, boolean quote,
- final int eol) throws ConfigInvalidException {
- final StringBuilder value = new StringBuilder();
- boolean space = false;
- for (;;) {
- int c = in.read();
- if (c < 0) {
- if (value.length() == 0)
- throw new ConfigInvalidException(JGitText.get().unexpectedEndOfConfigFile);
- break;
- }
-
- if ('\n' == c) {
- if (quote)
- throw new ConfigInvalidException(JGitText.get().newlineInQuotesNotAllowed);
- in.reset();
- break;
- }
-
- if (eol == c)
- break;
-
- if (!quote) {
- if (Character.isWhitespace((char) c)) {
- space = true;
- continue;
- }
- if (';' == c || '#' == c) {
- in.reset();
- break;
- }
- }
-
- if (space) {
- if (value.length() > 0)
- value.append(' ');
- space = false;
- }
-
- if ('\\' == c) {
- c = in.read();
- switch (c) {
- case -1:
- throw new ConfigInvalidException(JGitText.get().endOfFileInEscape);
- case '\n':
- continue;
- case 't':
- value.append('\t');
- continue;
- case 'b':
- value.append('\b');
- continue;
- case 'n':
- value.append('\n');
- continue;
- case '\\':
- value.append('\\');
- continue;
- case '"':
- value.append('"');
- continue;
- default:
- throw new ConfigInvalidException(MessageFormat.format(JGitText.get().badEscape, ((char) c)));
- }
- }
-
- if ('"' == c) {
- quote = !quote;
- continue;
- }
-
- value.append((char) c);
- }
- return value.length() > 0 ? value.toString() : null;
- }
-
- /**
- * Parses a section of the configuration into an application model object.
- * <p>
- * Instances must implement hashCode and equals such that model objects can
- * be cached by using the {@code SectionParser} as a key of a HashMap.
- * <p>
- * As the {@code SectionParser} itself is used as the key of the internal
- * HashMap applications should be careful to ensure the SectionParser key
- * does not retain unnecessary application state which may cause memory to
- * be held longer than expected.
- *
- * @param <T>
- * type of the application model created by the parser.
- */
- public static interface SectionParser<T> {
- /**
- * Create a model object from a configuration.
- *
- * @param cfg
- * the configuration to read values from.
- * @return the application model instance.
- */
- T parse(Config cfg);
- }
-
- private static class SubsectionNames implements SectionParser<Set<String>> {
- private final String section;
-
- SubsectionNames(final String sectionName) {
- section = sectionName;
- }
-
- public int hashCode() {
- return section.hashCode();
- }
-
- public boolean equals(Object other) {
- if (other instanceof SubsectionNames) {
- return section.equals(((SubsectionNames) other).section);
- }
- return false;
- }
-
- public Set<String> parse(Config cfg) {
- final Set<String> result = new HashSet<String>();
- while (cfg != null) {
- for (final Entry e : cfg.state.get().entryList) {
- if (e.subsection != null && e.name == null
- && StringUtils.equalsIgnoreCase(section, e.section))
- result.add(e.subsection);
- }
- cfg = cfg.baseConfig;
- }
- return Collections.unmodifiableSet(result);
- }
- }
-
- private static class NamesInSection implements SectionParser<Set<String>> {
- private final String section;
-
- private final String subsection;
-
- NamesInSection(final String sectionName, final String subSectionName) {
- section = sectionName;
- subsection = subSectionName;
- }
-
- @Override
- public int hashCode() {
- final int prime = 31;
- int result = 1;
- result = prime * result + section.hashCode();
- result = prime * result
- + ((subsection == null) ? 0 : subsection.hashCode());
- return result;
- }
-
- @Override
- public boolean equals(Object obj) {
- if (this == obj)
- return true;
- if (obj == null)
- return false;
- if (getClass() != obj.getClass())
- return false;
- NamesInSection other = (NamesInSection) obj;
- if (!section.equals(other.section))
- return false;
- if (subsection == null) {
- if (other.subsection != null)
- return false;
- } else if (!subsection.equals(other.subsection))
- return false;
- return true;
- }
-
- public Set<String> parse(Config cfg) {
- final Map<String, String> m = new LinkedHashMap<String, String>();
- while (cfg != null) {
- for (final Entry e : cfg.state.get().entryList) {
- if (e.name == null)
- continue;
- if (!StringUtils.equalsIgnoreCase(section, e.section))
- continue;
- if ((subsection == null && e.subsection == null)
- || (subsection != null && subsection
- .equals(e.subsection))) {
- String lc = StringUtils.toLowerCase(e.name);
- if (!m.containsKey(lc))
- m.put(lc, e.name);
- }
- }
- cfg = cfg.baseConfig;
- }
- return new CaseFoldingSet(m);
- }
- }
-
- private static class SectionNames implements SectionParser<Set<String>> {
- public Set<String> parse(Config cfg) {
- final Map<String, String> m = new LinkedHashMap<String, String>();
- while (cfg != null) {
- for (final Entry e : cfg.state.get().entryList) {
- if (e.section != null) {
- String lc = StringUtils.toLowerCase(e.section);
- if (!m.containsKey(lc))
- m.put(lc, e.section);
- }
- }
- cfg = cfg.baseConfig;
- }
- return new CaseFoldingSet(m);
- }
- }
-
- private static class CaseFoldingSet extends AbstractSet<String> {
- private final Map<String, String> names;
-
- CaseFoldingSet(Map<String, String> names) {
- this.names = Collections.unmodifiableMap(names);
- }
-
- @Override
- public boolean contains(Object needle) {
- if (!(needle instanceof String))
- return false;
-
- String n = (String) needle;
- return names.containsKey(n)
- || names.containsKey(StringUtils.toLowerCase(n));
- }
-
- @Override
- public Iterator<String> iterator() {
- return names.values().iterator();
- }
-
- @Override
- public int size() {
- return names.size();
- }
- }
-
- private static class State {
- final List<Entry> entryList;
-
- final Map<Object, Object> cache;
-
- final State baseState;
-
- State(List<Entry> entries, State base) {
- entryList = entries;
- cache = new ConcurrentHashMap<Object, Object>(16, 0.75f, 1);
- baseState = base;
- }
- }
-
- /**
- * The configuration file entry
- */
- private static class Entry {
- /**
- * The text content before entry
- */
- String prefix;
-
- /**
- * The section name for the entry
- */
- String section;
-
- /**
- * Subsection name
- */
- String subsection;
-
- /**
- * The key name
- */
- String name;
-
- /**
- * The value
- */
- String value;
-
- /**
- * The text content after entry
- */
- String suffix;
-
- Entry forValue(final String newValue) {
- final Entry e = new Entry();
- e.prefix = prefix;
- e.section = section;
- e.subsection = subsection;
- e.name = name;
- e.value = newValue;
- e.suffix = suffix;
- return e;
- }
-
- boolean match(final String aSection, final String aSubsection,
- final String aKey) {
- return eqIgnoreCase(section, aSection)
- && eqSameCase(subsection, aSubsection)
- && eqIgnoreCase(name, aKey);
- }
-
- boolean match(final String aSection, final String aSubsection) {
- return eqIgnoreCase(section, aSection)
- && eqSameCase(subsection, aSubsection);
- }
-
- private static boolean eqIgnoreCase(final String a, final String b) {
- if (a == null && b == null)
- return true;
- if (a == null || b == null)
- return false;
- return StringUtils.equalsIgnoreCase(a, b);
- }
-
- private static boolean eqSameCase(final String a, final String b) {
- if (a == null && b == null)
- return true;
- if (a == null || b == null)
- return false;
- return a.equals(b);
- }
- }
-
- private static class StringReader {
- private final char[] buf;
-
- private int pos;
-
- StringReader(final String in) {
- buf = in.toCharArray();
- }
-
- int read() {
- try {
- return buf[pos++];
- } catch (ArrayIndexOutOfBoundsException e) {
- pos = buf.length;
- return -1;
- }
- }
-
- void reset() {
- pos--;
- }
- }
- }
|