All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.glassfish.grizzly.http.util.UEncoder Maven / Gradle / Ivy

There is a newer version: 4.0.2
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2010-2015 Oracle and/or its affiliates. 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
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  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 packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * 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 don't 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.
 *
 *
 * This file incorporates work covered by the following copyright and
 * permission notice:
 *
 * Copyright 2004 The Apache Software Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.glassfish.grizzly.http.util;

import org.glassfish.grizzly.Grizzly;

import java.io.CharArrayWriter;
import java.io.IOException;
import java.io.Writer;
import java.util.BitSet;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * Efficient implementation for encoders.
 * This class is not thread safe - you need one encoder per thread.
 * The encoder will save and recycle the internal objects, avoiding
 * garbage.
 * 

* You can add extra characters that you want preserved, for example * while encoding a URL you can add "/". * * @author Costin Manolache */ public final class UEncoder { private final static Logger logger = Grizzly.logger(UEncoder.class); private static final BitSet initialSafeChars = new BitSet(128); static { initSafeChars(); } // Not static - the set may differ ( it's better than adding // an extra check for "/", "+", etc private final BitSet safeChars; private C2BConverter c2b; private ByteChunk bb; private String encoding = "UTF8"; private static final int debug = 0; public UEncoder() { safeChars = (BitSet) initialSafeChars.clone(); } public void setEncoding(String s) { encoding = s; } public void addSafeCharacter(char c) { safeChars.set(c); } /** * URL Encode string, using a specified encoding. * * @param buf the {@link Writer} to write the encoded result to. * @param s the String to encode. */ public void urlEncode(Writer buf, String s) throws IOException { urlEncode(buf, s, false); } /** * URL Encode string, using a specified encoding. * * @param buf the {@link Writer} to write the encoded result to. * @param s the String to encode. * @param toHexUpperCase the hex string will be in upper case */ public void urlEncode(Writer buf, String s, boolean toHexUpperCase) throws IOException { if (c2b == null) { bb = new ByteChunk(16); // small enough. c2b = C2BConverter.getInstance(bb, encoding); } for (int i = 0; i < s.length(); i++) { int c = (int) s.charAt(i); if (safeChars.get(c)) { if (debug > 0) { log("Safe: " + (char) c); } buf.write((char) c); } else { if (debug > 0) { log("Unsafe: " + (char) c); } c2b.convert((char) c); // "surrogate" - UTF is _not_ 16 bit, but 21 !!!! // ( while UCS is 31 ). Amazing... if (c >= 0xD800 && c <= 0xDBFF) { if ((i + 1) < s.length()) { int d = (int) s.charAt(i + 1); if (d >= 0xDC00 && d <= 0xDFFF) { if (debug > 0) { log("Unsafe: " + c); } c2b.convert((char) d); i++; } } } urlEncode(buf, bb.getBuffer(), bb.getStart(), bb.getLength(), toHexUpperCase); bb.recycle(); } } } /** */ public void urlEncode(Writer buf, byte bytes[], int off, int len) throws IOException { urlEncode(buf, bytes, off, len, false); } /** */ public void urlEncode(Writer buf, byte bytes[], int off, int len, boolean toHexUpperCase) throws IOException { for (int j = off; j < len; j++) { buf.write('%'); char ch = Character.forDigit((bytes[j] >> 4) & 0xF, 16); if (toHexUpperCase) { ch = Character.toUpperCase(ch); } if (debug > 0) { log("Encode: " + ch); } buf.write(ch); ch = Character.forDigit(bytes[j] & 0xF, 16); if (toHexUpperCase) { ch = Character.toUpperCase(ch); } if (debug > 0) { log("Encode: " + ch); } buf.write(ch); } } /** * Utility funtion to re-encode the URL. * Still has problems with charset, since UEncoder mostly * ignores it. * * @param url */ public String encodeURL(String url) { return encodeURL(url, false); } /** * Utility function to re-encode the URL. * Still has problems with charset, since UEncoder mostly * ignores it. * * @param uri the URI to encode. * @param toHexUpperCase the hex string will be in upper case */ public String encodeURL(String uri, boolean toHexUpperCase) { String outUri = null; try { // XXX optimize - recycle, etc CharArrayWriter out = new CharArrayWriter(); urlEncode(out, uri, toHexUpperCase); outUri = out.toString(); } catch (IOException ignore) { } return outUri; } // -------------------- Internal implementation -------------------- private static void initSafeChars() { int i; for (i = 'a'; i <= 'z'; i++) { initialSafeChars.set(i); } for (i = 'A'; i <= 'Z'; i++) { initialSafeChars.set(i); } for (i = '0'; i <= '9'; i++) { initialSafeChars.set(i); } //safe initialSafeChars.set('$'); initialSafeChars.set('-'); initialSafeChars.set('_'); initialSafeChars.set('.'); // Dangerous: someone may treat this as " " // RFC1738 does allow it, it's not reserved // initialSafeChars.set('+'); //extra initialSafeChars.set('!'); initialSafeChars.set('*'); initialSafeChars.set('\''); initialSafeChars.set('('); initialSafeChars.set(')'); initialSafeChars.set(','); } private static void log(String s) { if (logger.isLoggable(Level.FINE)) { logger.fine(s); } } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy