view netx/net/sourceforge/jnlp/util/optionparser/OptionParser.java @ 1511:1b6706eb48a3

Added optional windows desktop integration * AUTHORS: added Joel * Makefile: Excluded (WindowsDesktopEntry.java) if mslinks are not included, added mslinks to UNIFIED_CLASSPATH_SEGMENTS included mslinks to windows and linux runtime libs, added MSLINKS_JAR to other composeclasspath calls * NEWS: mentioned windows desktop support, mentioned listing of cache and operations via id. * acinclude.m4: added check (IT_CHECK_FOR_MSLINKS) for optional mslinks.jar, strong warning printed if build is on windows * configure.ac: call (IT_CHECK_FOR_MSLINKS) * netx/net/sourceforge/jnlp/Launcher.java: new variable of (KEY_JAVAWS_LOCATION) to replace hardcoded icedtea-web.bin.location over netx. * netx/net/sourceforge/jnlp/OptionsDefinitions.java: re-declared clear cache to take none or one argument. Added Xcacheids switch for listing the cache (works with verbose) * netx/net/sourceforge/jnlp/cache/CacheDirectory.java: refactored hardcoded ".info" to constant. * netx/net/sourceforge/jnlp/cache/CacheEntry.java: introduced KEY_JNLP_PATH and used to set jnlp-path attribute * netx/net/sourceforge/jnlp/cache/CacheLRUWrapper.java: hide private constructor, declared and provided (windowsShortcutList) * netx/net/sourceforge/jnlp/cache/CacheUtil.java: extracted and used (checkToClearCache). Added second method clearCache with arg to clear only specific part of cache. Clear cache also alerts windows desktop files now via new removeWindowsShortcuts. Added methods to lists ids and details from cache listCacheIds and getCacheIds. Included new inner class CacheId to encapsualte various types of id - CacheJnlpId and CacheDomainId now. * netx/net/sourceforge/jnlp/cache/DirectoryNode.java: only adapted to .info refactoring * netx/net/sourceforge/jnlp/cache/ResourceDownloader.java: Save main argument, or jnlp argument or html argument to jnlp-path .info entry if found. * netx/net/sourceforge/jnlp/controlpanel/CacheAppViewer.java: gui to itweb-settings cache pane to allow comfortable listing of ids and deleting via those grouping. New file. * netx/net/sourceforge/jnlp/controlpanel/CachePane.java: added logic to show .info details for each file shown by cache viewer. (generateData) made jnlp-path aware, made public and reused several times * netx/net/sourceforge/jnlp/controlpanel/TemporaryInternetFilesPanel.java: added button to show dilog which is deleting by id * netx/net/sourceforge/jnlp/resources/Messages.properties: added BXclearcache BXSingleCacheCleared BXSingleCacheClearNotFound BXSingleCacheMoreThenOneId BXSingleCacheFileCount BXcacheids NOAnonorone WinDesktopError. Modified BXclearcache. Improved EXAWdesktopWants EXAWdesktopDontWants EXAWsubmenu EXAWmenuWants EXAWmenuDontWants EXAWrememberByApp EXAWrememberByPage EXAWrememberByAppTooltip EXAWbrowsersTolltip SDesktopShortcut * netx/net/sourceforge/jnlp/runtime/ApplicationInstance.java: added if isWindows reflective calls to WindowsDesktopEntry and original XdesktopEntry work moved to else part. * netx/net/sourceforge/jnlp/runtime/Boot.java: now offer getter for optionParser (so it van be reused in ResourceDownloader) Added understanding to Xcacheids. Understanding to Xclearcache adapted to its new optional argument * netx/net/sourceforge/jnlp/util/GenericDesktopEntry.java: interface for (future) WindowsDesktopEntry and XDesktopEntry unification * netx/net/sourceforge/jnlp/util/WindowsDesktopEntry.java: new file, implementation fo windos desktop integration via lnk files generated by mslinks.jar. Unlike XDesktop integration, it swarms also uninstall shortcuts. * netx/net/sourceforge/jnlp/util/XDesktopEntry.java: Mostly adapted to refactorings. Extracted extraction of favicon to method, reused, and improved to try more locations on server. * netx/net/sourceforge/jnlp/util/optionparser/OptionParser.java: adapted to refactorings * launcher/launchers.bat.in: mslinks included in bootclasspath * tests/netx/unit/net/sourceforge/jnlp/cache/CacheUtilTest.java: addd tests for CacheId * tests/netx/unit/net/sourceforge/jnlp/util/XDesktopEntryTest.java: Added tests for favicon extracti
author Jiri Vanek <jvanek@redhat.com>
date Mon, 25 Feb 2019 13:41:58 +0100
parents 02dd1b796d4b
children
line wrap: on
line source

/*Copyright (C) 2014 Red Hat, Inc.

This file is part of IcedTea.

IcedTea is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as published by
the Free Software Foundation, version 2.

IcedTea is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with IcedTea; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version.
 */

package net.sourceforge.jnlp.util.optionparser;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import net.sourceforge.jnlp.OptionsDefinitions;

import static net.sourceforge.jnlp.runtime.Translator.R;

/** Parses for options (passed in as arguments)
 *  To use add entries to OPTIONS enum in OptionsDefinitions
 *  and make a static method return a list containing
 *  what OPTIONS are to be parsed for.
 */
public class OptionParser {

    private final String[] args;
    private final List<ParsedOption> parsedOptions;
    private final List<OptionsDefinitions.OPTIONS> possibleOptions;
    //List of all possible main arguments
    private final List<String> mainArgumentList = new ArrayList<>();
    private boolean evenNumberFound;

    public OptionParser(String[] args, List<OptionsDefinitions.OPTIONS> options) throws UnevenParameterException {
        this.args = Arrays.copyOf(args, args.length);
        this.possibleOptions = options;

        evenNumberFound = false;
        parsedOptions = new ArrayList<>();
        parseContents();
        if (evenNumberFound) {
            checkOptionHasEvenNumber();
        }

    }

    private void parseContents() {
        ParsedOption lastOption = null;
        for (String arg : args) {
            if (isOption(arg)) {
                lastOption = addOptionToList(arg);
            } else if (shouldAddParam(lastOption)) {
                lastOption.addParam(arg);
            } else if (isEvenNumberSupportingEqualsChars(lastOption)) {
                evenNumberFound = true;
                handleEvenNumberSupportingEqualsChar(lastOption, arg);
            } else {
                mainArgumentList.add(arg);
            }
        }
    }

    private void handleEvenNumberSupportingEqualsChar(final ParsedOption lastOption, String arg) {
        if (arg.contains("=")) {
            lastOption.addParam(arg.split("=")[0]);
            lastOption.addParam(arg.split("=", 2)[1]);
        } else {
            lastOption.addParam(arg);
        }
    }
    private boolean shouldAddParam(final ParsedOption lastOption) {
        return lastOption != null &&
                (oneOrMoreArguments(lastOption) || isOneArgumentNotFull(lastOption));
    }

    private boolean isOneArgumentNotFull(final ParsedOption lastOption) {
        return lastOption.getOption().hasOneArgument() && lastOption.getParams().isEmpty();
    }

    private boolean oneOrMoreArguments(final ParsedOption lastOption) {
        return lastOption.getOption().hasOneOrMoreArguments();
    }

    private boolean isEvenNumberSupportingEqualsChars(final ParsedOption lastOption) {
        return lastOption != null &&
                lastOption.getOption().hasEvenNumberSupportingEqualsChar();
    }

    private ParsedOption addOptionToList(final String arg) {
        ParsedOption option = new ParsedOption(argumentToOption(arg));
        if (arg.contains("=")) {
            option.addParam(arg.split("=", 2)[1]);
        }
        parsedOptions.add(option);
        return option;
    }

    private void checkOptionHasEvenNumber() throws UnevenParameterException {
        for (ParsedOption option : parsedOptions) {
            if (isEvenNumberSupportingEqualsChars(option)) {
                if (option.getParams().size() % 2 != 0){
                    throw new UnevenParameterException(R("OPUnevenParams", option.getOption().option));
                }
            }
        }
    }

    private OptionsDefinitions.OPTIONS argumentToOption(final String arg) {
        for (OptionsDefinitions.OPTIONS opt : possibleOptions) {
            if (stringEqualsOption(arg, opt)) {
                return opt;
            }
        }
        return null;
    }

    private boolean isOption(String input) {
        return argumentToOption(input) != null;
    }

    protected static boolean stringEqualsOption(String input, OptionsDefinitions.OPTIONS opt) {
        String option = removeLeadingHyphens(opt.option);
        input = removeLeadingHyphens(input).split("=")[0];
        return input.equals(option);
    }

    private static String removeLeadingHyphens(final String input) {
        return input.replaceAll("^-*", "");
    }

    public boolean hasOption(OptionsDefinitions.OPTIONS option) {
        for (ParsedOption parsed : parsedOptions) {
            if (option == parsed.getOption()) {
                return true;
            }
        }
        return false;
    }

    public boolean mainArgExists() {
        return mainArgumentList.size() > 0;
    }

    public String getMainArg() {
        if (mainArgExists()) {
            return mainArgumentList.get(0);
        }
        return "";
    }

    public List<String> getMainArgs() {
        return new ArrayList<>(mainArgumentList);
    }

    public String getParam(OptionsDefinitions.OPTIONS option) {
        List<String> params = getParams(option);
        if (params.size() > 0) {
            return getParams(option).get(0);
        }
        return "";
    }

    public List<String> getParams(OptionsDefinitions.OPTIONS option) {
        List<String> result = new ArrayList<>();
        for (ParsedOption parsed : parsedOptions) {
            if (parsed.getOption() == option) {
                for (String param : parsed.getParams()) {
                    result.add(param);
                }
            }
        }
        return result;
    }

    public int getNumberOfOptions() {
        return parsedOptions.size();
    }

    public void addOption(OptionsDefinitions.OPTIONS options, String... params) {
        ParsedOption x = new ParsedOption(options);
        for (String string : params) {
            x.addParam(string);
        }
        parsedOptions.add(x);
    }
}