/FileExtraction/Java_unseen/dlitz_resin/modules/quercus/src/com/caucho/quercus/lib/i18n/UnicodeModule.java
/*
 * Copyright (c) 1998-2011 Caucho Technology -- all rights reserved
 *
 * This file is part of Resin(R) Open Source
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Resin Open Source 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; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Resin Open Source 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, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Resin Open Source; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package com.caucho.quercus.lib.i18n;

import com.caucho.quercus.QuercusException;
import com.caucho.quercus.UnimplementedException;
import com.caucho.quercus.annotation.Optional;
import com.caucho.quercus.env.*;
import com.caucho.quercus.module.AbstractQuercusModule;
import com.caucho.quercus.module.IniDefinition;
import com.caucho.quercus.module.IniDefinitions;
import com.caucho.util.L10N;

import java.io.UnsupportedEncodingException;
import java.nio.ByteBuffer;
import java.nio.CharBuffer;
import java.nio.charset.UnsupportedCharsetException;
import java.util.Locale;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
 * Unicode handling.  Also includes iconv, etc.
 */
public class UnicodeModule extends AbstractQuercusModule {
  private static final Logger log = Logger.getLogger(
      UnicodeModule.class.getName());
  private static final L10N L = new L10N(UnicodeModule.class);

  public static final int U_INVALID_STOP = 0;
  public static final int U_INVALID_SKIP = 1;
  public static final int U_INVALID_SUBSTITUTE = 2;
  public static final int U_INVALID_ESCAPE = 3;

  public static final String ICONV_IMPL = "QuercusIconv";
  public static final String ICONV_VERSION = "1.0";

  public static final int ICONV_MIME_DECODE_STRICT = 1;
  public static final int ICONV_MIME_DECODE_CONTINUE_ON_ERROR = 2;

  private static final IniDefinitions _iniDefinitions = new IniDefinitions();

  /**
   * Returns the extensions implemented by the module.
   */
  public String []getLoadedExtensions()
  {
    return new String[] { "iconv" };
  }

  /**
   * Returns the default quercus.ini values.
   */
  public IniDefinitions getIniDefinitions()
  {
    return _iniDefinitions;
  }

  public static BooleanValue unicode_semantics(Env env)
  {
    return env.isUnicodeSemantics() ? BooleanValue.TRUE : BooleanValue.FALSE;
  }

  public static Value unicode_decode(Env env,
                                     BinaryValue str,
                                     String encoding,
                                     @Optional int errorMode)
  {
    try {
      Decoder decoder = Decoder.create(encoding);

      return decoder.decodeUnicode(env, str);
    } catch (UnsupportedCharsetException e) {
      log.log(Level.FINE, e.getMessage(), e);
      env.warning(L.l("unsupported charset {0}", encoding));

      return BooleanValue.FALSE;
    }
  }

  public static Value unicode_encode(Env env,
                                     UnicodeValue str,
                                     String encoding,
                                     @Optional int errorMode)
  {
    try {
      Encoder encoder = Encoder.create(encoding);

      return encoder.encode(env, str);
    } catch (UnsupportedCharsetException e) {
      log.log(Level.FINE, e.getMessage(), e);
      env.warning(L.l("unsupported charset {0}", encoding));

      return BooleanValue.FALSE;
    }
  }

  /**
   * Returns the first occurence of the substring in the haystack.
   * Uses iconv.internal_encoding.
   *
   * @return first occurence of needle in haystack, FALSE otherwise
   */
  public static Value iconv_strpos(Env env,
                                   StringValue haystack,
                                   StringValue needle,
                                   @Optional("0") int offset,
                                   @Optional("") String charset)
  {
    if (charset.length() == 0)
      charset = env.getIniString("iconv.internal_encoding");

    try {
      Decoder decoder = Decoder.create(charset);

      StringValue haystackUnicode = decoder.decodeUnicode(env, haystack);

      decoder.reset();
      StringValue needleUnicode = decoder.decodeUnicode(env, needle);

      int index = haystackUnicode.indexOf(needleUnicode, offset);

      if (index < 0)
        return BooleanValue.FALSE;

      return LongValue.create(index);
    } catch (UnsupportedCharsetException e) {
      log.log(Level.FINE, e.getMessage(), e);
      env.warning(L.l("unsupported charset {0}", charset));

      return BooleanValue.FALSE;
    }
  }

  /**
   * Returns the last occurence of the substring in the haystack.
   * Uses iconv.internal_encoding.
   *
   * @param charset encoding of StringValue arguments
   *
   * @return last occurence of needle in haystack, FALSE otherwise
   */
  public static Value iconv_strrpos(Env env,
                                    StringValue haystack,
                                    StringValue needle,
                                    @Optional("") String charset)
  {
    if (charset.length() == 0)
      charset = env.getIniString("iconv.internal_encoding");

    try {
      Decoder decoder = Decoder.create(charset);

      StringValue haystackUnicode = decoder.decodeUnicode(env, haystack);

      decoder.reset();
      StringValue needleUnicode = decoder.decodeUnicode(env, needle);

      int index = haystackUnicode.lastIndexOf(needleUnicode);

      if (index < 0)
        return BooleanValue.FALSE;

      return LongValue.create(index);
    } catch (UnsupportedCharsetException e) {
      log.log(Level.FINE, e.getMessage(), e);
      env.warning(L.l("unsupported charset {0}", charset));

      return BooleanValue.FALSE;
    }
  }

  /**
   * Uses iconv.internal_encoding.
   *
   * @param env
   * @param str encoded string
   * @param offset of str after decoding
   * @param length of str after decoding
   * @param charset encoding of StringValue argument
   * @return substring of argument string.
   *
   */
  public static Value iconv_substr(Env env,
                       StringValue str,
                       int offset,
                       @Optional("0x7fffffff") int length,
                       @Optional("") String charset)
  {
    if (charset.length() == 0)
      charset = env.getIniString("iconv.internal_encoding");

    try {
      Decoder decoder = Decoder.create(charset);

      CharSequence unicodeStr = decoder.decode(env, str);

      if (decoder.hasError()) {
        log.log(Level.FINE, L.l("string has invalid {0} encoding", charset));
        env.notice(L.l("string has invalid {0} encoding", charset));

        return BooleanValue.FALSE;
      }

      int tail;
      int strlen = unicodeStr.length();

      int newOffset = offset;

      if (offset < 0)
        newOffset = strlen + offset;

      if (length < 0) {
        if (offset < 0)
          tail = strlen;
        else
          tail = strlen + length;
      }
      else if (length > strlen - newOffset)
        tail = strlen;
      else
        tail = newOffset + length;

      if (newOffset < 0 || tail < newOffset)
        return str.EMPTY;

      unicodeStr = unicodeStr.subSequence(newOffset, tail);

      Encoder encoder = Encoder.create(charset);
      StringValue encodedStr = encoder.encode(env, unicodeStr);

      return encodedStr;
    } catch (UnsupportedCharsetException e) {
      log.log(Level.FINE, e.getMessage(), e);
      env.warning(L.l("unsupported charset {0}", charset));

      return BooleanValue.FALSE;
    }
  }

  /**
   * Returns encoded string from decoded argument string.
   *
   * @param env
   * @param inCharset charset to decode from
   * @param outCharset charset to decode to
   * @param str to decode and encode
   */
  public static Value iconv(Env env,
                            String inCharset,
                            String outCharset,
                            StringValue str)
  {
    boolean isIgnoreErrors = false;

    // options should be on outCharset
    if (inCharset.endsWith("//IGNORE"))
      inCharset = inCharset.substring(0, inCharset.length() - 8);
    else if (inCharset.endsWith("//TRANSLIT"))
      inCharset = inCharset.substring(0, inCharset.length() - 10);

    if (outCharset.endsWith("//IGNORE")) {
      isIgnoreErrors = true;

      outCharset = outCharset.substring(0, outCharset.length() - 8);
    }
    else if (outCharset.endsWith("//TRANSLIT")) {
      env.stub("Iconv TRANSLIT option not supported");

      outCharset = outCharset.substring(0, outCharset.length() - 10);
    }

    boolean isStartUtf8 = false;
    boolean isEndUtf8 = false;

    if (inCharset.equalsIgnoreCase("utf8")
        || inCharset.equalsIgnoreCase("utf-8"))
      isStartUtf8 = true;

    if (outCharset.equalsIgnoreCase("utf8")
        || outCharset.equalsIgnoreCase("utf-8"))
      isEndUtf8 = true;

    if (isStartUtf8 && isEndUtf8)
      return UnicodeUtility.utf8Clean(env, str, null, isIgnoreErrors);

    CharSequence unicodeStr;

    try {
      Decoder decoder;

      if (isStartUtf8)
        decoder = new Utf8Decoder(inCharset);
      else
        decoder = Decoder.create(inCharset);

      decoder.setIgnoreErrors(isIgnoreErrors);

      unicodeStr = decoder.decode(env, str);
    } catch (UnsupportedCharsetException e) {
      log.log(Level.FINE, e.getMessage(), e);
      env.warning(L.l("unsupported input charset {0}", inCharset));

      return BooleanValue.FALSE;
    }

    try {
      Encoder encoder;

      if (isEndUtf8)
        encoder = new Utf8Encoder();
      else
        encoder = Encoder.create(outCharset);

      encoder.setIgnoreErrors(isIgnoreErrors);

      return encoder.encode(env, unicodeStr);
    } catch (UnsupportedCharsetException e) {
      log.log(Level.FINE, e.getMessage(), e);
      env.warning(L.l("unsupported output charset {0}", outCharset));

      return BooleanValue.FALSE;
    }
  }

  public static StringValue ob_iconv_handler(
                       StringValue contents,
                       int status)
  {
    throw new UnimplementedException("ob_iconv_handler");
  }

  /**
   * Returns the current encoding.
   *
   * @param env
   * @param type setting to return
   * @return iconv environment settings
   */
  public static Value iconv_get_encoding(Env env,
                       @Optional("all") String type)
  {
    type = type.toLowerCase(Locale.ENGLISH);

    if ("all".equals(type)) {
      ArrayValue array = new ArrayValueImpl();
      array.put(env, "input_encoding",
        env.getIniString("iconv.input_encoding"));
      array.put(env, "output_encoding",
        env.getIniString("iconv.output_encoding"));
      array.put(env, "internal_encoding",
        env.getIniString("iconv.internal_encoding"));
      return array;
    }

    if ("input_encoding".equals(type))
      return env.createString(env.getIniString("iconv.input_encoding"));
    else if ("output_encoding".equals(type))
      return env.createString(env.getIniString("iconv.output_encoding"));
    else if ("internal_encoding".equals(type))
      return env.createString(env.getIniString("iconv.internal_encoding"));

    return BooleanValue.FALSE;
  }

  /**
   * Sets the current encoding.
   * @param env
   * @param type
   * @param charset
   */
  public static BooleanValue iconv_set_encoding(Env env,
                       String type,
                       StringValue charset)
  {
    type = type.toLowerCase(Locale.ENGLISH);

    if ("input_encoding".equals(type)) {
      env.setIni("iconv.input_encoding", charset);
      return BooleanValue.TRUE;
    }
    else if ("output_encoding".equals(type)) {
      env.setIni("iconv.output_encoding", charset);
      return BooleanValue.TRUE;
    }
    else if ("internal_encoding".equals(type)) {
      env.setIni("iconv.internal_encoding", charset);
      return BooleanValue.TRUE;
    }

    return BooleanValue.FALSE;
  }

  /**
   * Returns the length of the decoded string.
   * Uses iconv.internal_encoding.
   *
   * @param env
   * @param str
   * @param charset
   */
  public static Value iconv_strlen(Env env,
                       StringValue str,
                       @Optional("") String charset)
  {
    if (charset.length() == 0)
      charset = env.getIniString("iconv.internal_encoding");

    try {
      Decoder decoder = Decoder.create(charset);

      CharSequence unicodeStr = decoder.decode(env, str);

      if (decoder.hasError()) {
        log.log(Level.FINE, L.l("string has invalid {0} encoding", charset));
        env.notice(L.l("string has invalid {0} encoding", charset));

        return BooleanValue.FALSE;
      }

      return LongValue.create(unicodeStr.length());
    } catch (UnsupportedCharsetException e) {
      log.log(Level.FINE, e.getMessage(), e);
      env.warning(L.l("unsupported charset {0}", charset));

      return BooleanValue.FALSE;
    }
  }

  /**
   * Encodes a MIME header.
   *
   * XXX: preferences
   *
   * @param fieldName header field name
   * @param fieldValue header field value
   * @param preferences
   */
  public static Value iconv_mime_encode(Env env,
                              StringValue fieldName,
                              StringValue fieldValue,
                              @Optional() ArrayValue preferences)
  {
    try {
      String scheme = "B";
      String lineBreakChars = "\r\n";
      String inCharset = env.getIniString("iconv.internal_encoding");
      String outCharset = inCharset;
      int lineLength = 76;

      if (preferences != null) {
        Value tmp = env.createString("scheme");
        if ((tmp = preferences.get(tmp)).isset())
          scheme = tmp.toString();

        tmp = env.createString("line-break-chars");
        if ((tmp = preferences.get(tmp)).isset())
          lineBreakChars = tmp.toString();

        tmp = env.createString("input-charset");
        if ((tmp = preferences.get(tmp)).isset())
          inCharset = tmp.toString();

        tmp = env.createString("output-charset");
        if ((tmp = preferences.get(tmp)).isset())
          outCharset = tmp.toString();

        tmp = env.createString("line-length");
        if ((tmp = preferences.get(tmp)).isset()) {
        if (tmp.isLongConvertible())
          lineLength = (int)tmp.toLong();
        }
      }

      return QuercusMimeUtility.encodeMime(env,
                                           fieldName,
                                           fieldValue,
                                           inCharset,
                                           outCharset,
                                           scheme,
                                           lineBreakChars,
                                           lineLength);

    }
    catch (UnsupportedEncodingException e) {
      log.log(Level.FINE, e.getMessage(), e);
      env.warning(L.l(e.getMessage()));

      return BooleanValue.FALSE;
    }
  }

  /**
   * Decodes all the headers and place them in an array.
   * Use iconv.internal_encoding.
   * XXX: mode, line-length, line-break-chars
   *
   * @param env
   * @param encoded_headers
   * @param mode controls error recovery
   * @param charset
   */
  public static Value iconv_mime_decode_headers(Env env,
                                                StringValue encoded_headers,
                                                @Optional() int mode,
                                                @Optional() String charset)
  {
    if (charset.length() == 0)
      charset = env.getIniString("iconv.internal_encoding");

    try {
      return QuercusMimeUtility.decodeMimeHeaders(
          env, encoded_headers, charset);
    }
    catch (UnsupportedEncodingException e) {
      log.log(Level.FINE, e.getMessage(), e);
      env.warning(L.l(e.getMessage()));
    }
    catch (NoClassDefFoundError e) {
      throw new QuercusException(L.l("mime_decode requires javamail.jar"));
    }

    return BooleanValue.FALSE;
  }

  /**
   * Uses iconv.internal_encoding.
   *
   * XXX: mode ignored
   *
   * @param env
   * @param encoded_header
   * @param mode controls error recovery
   * @param charset to encode resultant
   */
  public static Value iconv_mime_decode(Env env,
                                        StringValue encodedHeader,
                                        @Optional("1") int mode,
                                        @Optional("") String charset)
  {
    if (charset.length() == 0)
      charset = env.getIniString("iconv.internal_encoding");

    try {
      return QuercusMimeUtility.decodeMime(env, encodedHeader, charset);
    }
    catch (UnsupportedEncodingException e) {
      env.warning(e);
      log.log(Level.FINE, e.getMessage(), e);

      return BooleanValue.FALSE;
    }
  }

  static final IniDefinition INI_ICONV_INPUT_ENCODING
    = _iniDefinitions.add("iconv.input_encoding", "utf-8", PHP_INI_ALL);
  static final IniDefinition INI_ICONV_OUTPUT_ENCODING
    = _iniDefinitions.add("iconv.output_encoding", "utf-8", PHP_INI_ALL);
  static final IniDefinition INI_ICONV_INTERNAL_ENCODING
    = _iniDefinitions.add("iconv.internal_encoding", "utf-8", PHP_INI_ALL);
}
