/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * Contributor(s):
 *
 * The Original Software is NetBeans. The Initial Developer of the Original
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
 * Microsystems, Inc. All Rights Reserved.
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 */

package org.netbeans.lib.cvsclient.response;

import java.io.*;
import java.util.*;

import org.netbeans.lib.cvsclient.util.*;
import org.netbeans.lib.cvsclient.util.SimpleStringPattern;
import org.netbeans.lib.cvsclient.command.KeywordSubstitutionOptions;

/**
 * This class handles the response from the server to a wrapper-sendme-rcsOptions
 * request
 * @author  Sriram Seshan
 */
public class WrapperSendResponse implements Response {

    public static Map parseWrappers(String line) {
        StringTokenizer tokenizer = new StringTokenizer(line);

        // the first token is the pattern
        SimpleStringPattern pattern = new SimpleStringPattern(tokenizer.nextToken());

        // it is followed by option value pairs
        String option, value;
        
        Map wrappersMap = null;

        while (tokenizer.hasMoreTokens()) {
            option = tokenizer.nextToken();
            value = tokenizer.nextToken();

            // do not bother with the -m Options now
            if (option.equals("-k")) { //NOI18N

                // This is a keyword substitution option
                // strip the quotes
                int first = value.indexOf('\'');
                int last = value.lastIndexOf('\'');
                if (first >=0 && last >= 0) {
                    value = value.substring(first+1, last);
                }

                KeywordSubstitutionOptions keywordOption = KeywordSubstitutionOptions.findKeywordSubstOption(value);
                if (wrappersMap == null) {
                    if (!tokenizer.hasMoreTokens()) {
                        wrappersMap = Collections.singletonMap(pattern, keywordOption);
                    } else {
                        wrappersMap = new LinkedHashMap();
                        wrappersMap.put(pattern, keywordOption);
                    }
                } else {
                    wrappersMap.put(pattern, keywordOption);
                }
            }
        }
        return wrappersMap;
    }
    
    /**
     * Process the data for the response.
     * @param dis the data inputstream allowing the client to read the server's
     * response. Note that the actual response name has already been read
     * and the input stream is positioned just before the first argument, if
     * any.
     */
    public void process(LoggedDataInputStream dis, ResponseServices services)
            throws ResponseException {
        try {
            
            String wrapperSettings = dis.readLine();
            Map wrappers = parseWrappers(wrapperSettings);
            for (Iterator it = wrappers.keySet().iterator(); it.hasNext(); ) {
                StringPattern pattern = (StringPattern) it.next();
                KeywordSubstitutionOptions keywordOption = (KeywordSubstitutionOptions) wrappers.get(pattern);
                services.addWrapper(pattern, keywordOption);
            }
        }
        catch (EOFException ex) {
            throw new ResponseException(ex, ResponseException.getLocalMessage("CommandException.EndOfFile", null)); //NOI18N
        }
        catch (IOException ex) {
            throw new ResponseException(ex);
        }
        catch (NoSuchElementException nse) {
            throw new ResponseException(nse);            
        }
    }

    /**
     * Is this a terminal response, i.e. should reading of responses stop
     * after this response. This is true for responses such as OK or
     * an error response
     */
    public boolean isTerminalResponse() {
        return false;
    }
    
}
