/*

 * Copyright (c) 1997, 2017, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code 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

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.tools.internal.xjc;

import com.sun.codemodel.internal.CodeWriter;

import com.sun.codemodel.internal.JPackage;

import com.sun.codemodel.internal.JResourceFile;

import com.sun.codemodel.internal.writer.FileCodeWriter;

import com.sun.codemodel.internal.writer.PrologCodeWriter;

import com.sun.istack.internal.tools.DefaultAuthenticator;

import com.sun.tools.internal.xjc.api.ClassNameAllocator;

import com.sun.tools.internal.xjc.api.SpecVersion;

import com.sun.tools.internal.xjc.generator.bean.field.FieldRendererFactory;

import com.sun.tools.internal.xjc.model.Model;

import com.sun.tools.internal.xjc.reader.Util;

import com.sun.xml.internal.bind.api.impl.NameConverter;

import java.net.URI;

import java.net.URISyntaxException;

import java.nio.charset.Charset;

import java.nio.charset.IllegalCharsetNameException;

import java.util.Locale;

import java.util.logging.Level;

import java.util.logging.Logger;

/**

 * Global options.

 *

 * <p>

 * This class stores invocation configuration for XJC.

 * The configuration in this class should be abstract enough so that

 * it could be parsed from both command-line or Ant.

 */

public class Options

{

    /** If "-debug" is specified. */

    public boolean debugMode;

    /** If the "-verbose" option is specified. */

    public boolean verbose;

    /** If the "-quiet" option is specified. */

    public boolean quiet;

    /** If the -readOnly option is specified. */

    public boolean readOnly;

    /** No file header comment (to be more friendly with diff.) */

    public boolean noFileHeader;

    /** When on, fixes getter/setter generation to match the Bean Introspection API */

    public boolean enableIntrospection;

    /** When on, generates content property for types with multiple xs:any derived elements (which is supposed to be correct behaviour) */

    public boolean contentForWildcard;

    /** Encoding to be used by generated java sources, null for platform default. */

    public String encoding;

    /**

     * If true XML security features when parsing XML documents will be disabled.

     * The default value is false.

     *

     * Boolean

     * @since 2.2.6

     */

    public boolean disableXmlSecurity;

    /**

     * Check the source schemas with extra scrutiny.

     * The exact meaning depends on the schema language.

     */

    public boolean strictCheck =true;

    /**

     * If -explicit-annotation option is specified.

     * <p>

     * This generates code that works around issues specific to 1.4 runtime.

     */

    public boolean runtime14 = false;

    /**

     * If true, try to resolve name conflicts automatically by assigning mechanical numbers.

     */

    public boolean automaticNameConflictResolution = false;

    /**

     * strictly follow the compatibility rules and reject schemas that

     * contain features from App. E.2, use vendor binding extensions

     */

    public static final int STRICT = 1;

    /**

     * loosely follow the compatibility rules and allow the use of vendor

     * binding extensions

     */

    public static final int EXTENSION = 2;

    /**

     * this switch determines how carefully the compiler will follow

     * the compatibility rules in the spec. Either {@code STRICT}

     * or {@code EXTENSION}.

     */

    public int compatibilityMode = STRICT;

    public boolean isExtensionMode() {

        return compatibilityMode==EXTENSION;

    }

    private static final Logger logger = com.sun.xml.internal.bind.Util.getClassLogger();

    /**

     * Generates output for the specified version of the runtime.

     */

    public SpecVersion target = SpecVersion.LATEST;

    public Options() {

        try {

            Class.forName("javax.xml.bind.JAXBPermission");

        } catch (ClassNotFoundException cnfe) {

            target = SpecVersion.V2_1;

        }

    }

    /**

     * Target directory when producing files.

     * <p>

     * This field is not used when XJC is driven through the XJC API.

     * Plugins that need to generate extra files should do so by using

     * {@link JPackage#addResourceFile(JResourceFile)}.

     */

    public File targetDir = new File(".");

    /**

     * type is made to {@link EntityResolver} so that XJC can be

     * used even if resolver.jar is not available in the classpath.

     */

    public EntityResolver entityResolver = null;

    /**

     * Type of input schema language. One of the {@code SCHEMA_XXX}

     * constants.

     */

    private Language schemaLanguage = null;

    /**

     * The -p option that should control the default Java package that

     * will contain the generated code. Null if unspecified.

     */

    public String defaultPackage = null;

    /**

     * Similar to the -p option, but this one works with a lower priority,

     * and customizations overrides this. Used by JAX-RPC.

     */

    public String defaultPackage2 = null;

    /**

     * Input schema files as a list of {@link InputSource}s.

     */

    // Proxy setting.

    private String proxyHost = null;

    private String proxyPort = null;

    public String proxyAuth = null;

    /**

     * {@link Plugin}s that are enabled in this compilation.

     */

    /**

     * All discovered {@link Plugin}s.

     * This is lazily parsed, so that we can take '-cp' option into account.

     *

     * @see #getAllPlugins()

     */

    private List<Plugin> allPlugins;

    /**

     * Set of URIs that plug-ins recognize as extension bindings.

     */

    /**

     * This allocator has the final say on deciding the class name.

     */

    public ClassNameAllocator classNameAllocator;

    /**

     * This switch controls whether or not xjc will generate package level annotations

     */

    public boolean packageLevelAnnotations = true;

    /**

     * This {@link FieldRendererFactory} determines how the fields are generated.

     */

    private FieldRendererFactory fieldRendererFactory = new FieldRendererFactory();

    /**

     * Used to detect if two {@link Plugin}s try to overwrite {@link #fieldRendererFactory}.

     */

    private Plugin fieldRendererFactoryOwner = null;

    /**

     * If this is non-null, we use this {@link NameConverter} over the one

     * given in the schema/binding.

     */

    private NameConverter nameConverter = null;

    /**

     * Used to detect if two {@link Plugin}s try to overwrite {@link #nameConverter}.

     */

    private Plugin nameConverterOwner = null;

    /**

     * Java module name in {@code module-info.java}.

     */

    private String javaModule = null;

    /**

     * Gets the active {@link FieldRendererFactory} that shall be used to build {@link Model}.

     *

     * @return always non-null.

     */

    public FieldRendererFactory getFieldRendererFactory() {

        return fieldRendererFactory;

    }

    /**

     * Sets the {@link FieldRendererFactory}.

     *

     * <p>

     * This method is for plugins to call to set a custom {@link FieldRendererFactory}.

     *

     * @param frf

     *      The {@link FieldRendererFactory} to be installed. Must not be null.

     * @param owner

     *      Identifies the plugin that owns this {@link FieldRendererFactory}.

     *      When two {@link Plugin}s try to call this method, this allows XJC

     *      to report it as a user-friendly error message.

     *

     * @throws BadCommandLineException

     *      If a conflit happens, this exception carries a user-friendly error

     *      message, indicating a conflict.

     */

    public void setFieldRendererFactory(FieldRendererFactory frf, Plugin owner) throws BadCommandLineException {

        // since this method is for plugins, make it bit more fool-proof than usual

        if(frf==null)

            throw new IllegalArgumentException();

        if(fieldRendererFactoryOwner!=null) {

            throw new BadCommandLineException(

                Messages.format(Messages.FIELD_RENDERER_CONFLICT,

                    fieldRendererFactoryOwner.getOptionName(),

                    owner.getOptionName() ));

        }

        this.fieldRendererFactoryOwner = owner;

        this.fieldRendererFactory = frf;

    }

    /**

     * Gets the active {@link NameConverter} that shall be used to build {@link Model}.

     *

     * @return can be null, in which case it's up to the binding.

     */

    public NameConverter getNameConverter() {

        return nameConverter;

    }

    /**

     * Sets the {@link NameConverter}.

     *

     * <p>

     * This method is for plugins to call to set a custom {@link NameConverter}.

     *

     * @param nc

     *      The {@link NameConverter} to be installed. Must not be null.

     * @param owner

     *      Identifies the plugin that owns this {@link NameConverter}.

     *      When two {@link Plugin}s try to call this method, this allows XJC

     *      to report it as a user-friendly error message.

     *

     * @throws BadCommandLineException

     *      If a conflit happens, this exception carries a user-friendly error

     *      message, indicating a conflict.

     */

    public void setNameConverter(NameConverter nc, Plugin owner) throws BadCommandLineException {

        // since this method is for plugins, make it bit more fool-proof than usual

        if(nc==null)

            throw new IllegalArgumentException();

        if(nameConverter!=null) {

            throw new BadCommandLineException(

                Messages.format(Messages.NAME_CONVERTER_CONFLICT,

                    nameConverterOwner.getOptionName(),

                    owner.getOptionName() ));

        }

        this.nameConverterOwner = owner;

        this.nameConverter = nc;

    }

    /**

     * Gets all the {@link Plugin}s discovered so far.

     *

     * <p>

     * A plugins are enumerated when this method is called for the first time,

     * by taking {@link #classpaths} into account. That means

     * "-cp plugin.jar" has to come before you specify options to enable it.

     */

    public List<Plugin> getAllPlugins() {

        if(allPlugins==null) {

            allPlugins = findServices(Plugin.class);

        }

        return allPlugins;

    }

    public Language getSchemaLanguage() {

        if( schemaLanguage==null)

            schemaLanguage = guessSchemaLanguage();

        return schemaLanguage;

    }

    public void setSchemaLanguage(Language _schemaLanguage) {

        this.schemaLanguage = _schemaLanguage;

    }

    public InputSource[] getGrammars() {

        return grammars.toArray(new InputSource[grammars.size()]);

    }

    /**

     * Adds a new input schema.

     */

    public void addGrammar( InputSource is ) {

        grammars.add(absolutize(is));

    }

    private InputSource fileToInputSource( File source ) {

        try {

            String url = source.toURL().toExternalForm();

            return new InputSource(Util.escapeSpace(url));

        } catch (MalformedURLException e) {

            return new InputSource(source.getPath());

        }

    }

    public void addGrammar( File source ) {

        addGrammar(fileToInputSource(source));

    }

    /**

     * Recursively scan directories and add all XSD files in it.

     */

    public void addGrammarRecursive( File dir ) {

        addRecursive(dir,".xsd",grammars);

    }

    private  void addRecursive( File dir, String suffix, List<InputSource> result ) {

        File[] files = dir.listFiles();

        if(files==null)     return; // work defensively

        for( File f : files ) {

            if(f.isDirectory())

                addRecursive(f,suffix,result);

            else

            if(f.getPath().endsWith(suffix))

                result.add(absolutize(fileToInputSource(f)));

        }

    }

    private InputSource absolutize(InputSource is) {

        // absolutize all the system IDs in the input, so that we can map system IDs to DOM trees.

        try {

            URL baseURL = new File(".").getCanonicalFile().toURL();

            is.setSystemId( new URL(baseURL,is.getSystemId()).toExternalForm() );

        } catch( IOException e ) {

            logger.log(Level.FINE, "{0}, {1}", new Object[]{is.getSystemId(), e.getLocalizedMessage()});

        }

        return is;

    }

    public InputSource[] getBindFiles() {

        return bindFiles.toArray(new InputSource[bindFiles.size()]);

    }

    /**

     * Adds a new binding file.

     */

    public void addBindFile( InputSource is ) {

        bindFiles.add(absolutize(is));

    }

    /**

     * Adds a new binding file.

     */

    public void addBindFile( File bindFile ) {

        bindFiles.add(fileToInputSource(bindFile));

    }

    /**

     * Recursively scan directories and add all ".xjb" files in it.

     */

    public void addBindFileRecursive( File dir ) {

        addRecursive(dir,".xjb",bindFiles);

    }

    /**

     * Gets a classLoader that can load classes specified via the

     * -classpath option.

     */

    public ClassLoader getUserClassLoader( ClassLoader parent ) {

        if (classpaths.isEmpty())

            return parent;

        return new URLClassLoader(

                classpaths.toArray(new URL[classpaths.size()]),parent);

    }

    /**

     * Gets Java module name option.

     * @return Java module name option or {@code null} if this option was not set.

     */

    public String getModuleName() {

        return javaModule;

    }

    /**

     * Parses an option {@code args[i]} and return

     * the number of tokens consumed.

     *

     * @return

     *      0 if the argument is not understood. Returning 0

     *      will let the caller report an error.

     * @exception BadCommandLineException

     *      If the callee wants to provide a custom message for an error.

     */

    public int parseArgument( String[] args, int i ) throws BadCommandLineException {

        if (args[i].equals("-classpath") || args[i].equals("-cp")) {

            String a = requireArgument(args[i], args, ++i);

            for (String p : a.split(File.pathSeparator)) {

                File file = new File(p);

                try {

                    classpaths.add(file.toURL());

                } catch (MalformedURLException e) {

                    throw new BadCommandLineException(

                        Messages.format(Messages.NOT_A_VALID_FILENAME,file),e);

                }

            }

            return 2;

        }

        if (args[i].equals("-d")) {

            targetDir = new File(requireArgument("-d",args,++i));

            if( !targetDir.exists() )

                throw new BadCommandLineException(

                    Messages.format(Messages.NON_EXISTENT_DIR,targetDir));