/*
 * The Apache Software License, Version 1.1
 *
 *
 * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Axis" and "Apache Software Foundation" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 *    nor may "Apache" appear in their name, without prior written
 *    permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

/**
 * @author Rick Rineholt 
 */

package org.apache.axis.attachments;


import org.apache.axis.components.logger.LogFactory;
import org.apache.axis.utils.Messages;
import org.apache.commons.logging.Log;

import javax.activation.DataHandler;
import javax.activation.DataSource;
import java.io.IOException;
import java.util.StringTokenizer;


/**
 * This class is a single part for DIME mulitpart message.
 <pre>
 DIME 1.0 format
 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 | VERSION |B|E|C| TYPE_T| OPT_T |         OPTIONS_LENGTH        |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |          ID_LENGTH          |             TYPE_LENGTH         |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                          DATA_LENGTH                          |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                                                               /
 /                       OPTIONS + PADDING                       /
 /                                                               |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                                                               /
 /                        ID + PADDING                           /
 /                                                               |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                                                               /
 /                        TYPE + PADDING                         /
 /                                                               |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                                                               /
 /                        DATA + PADDING                         /
 /                                                               |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 </pre>
 */

/**
 * Holds one attachment DIME part.
 */
public class DimeBodyPart
{
   private static Log log =
           LogFactory.getLog(DimeBodyPart.class.getName());

   protected Object data = null;
   protected DimeTypeNameFormat dtnf = null;
   protected byte[] type = null;
   protected byte[] id = null;
   static final byte POSITION_FIRST = (byte)0x04;
   static final byte POSITION_LAST = (byte)0x02;
   private static final byte CHUNK = 0x01; //Means set the chunk bit
   private static final byte CHUNK_NEXT = 0x2; //Means this was part of a CHUNK
   private static int MAX_TYPE_LENGTH = (1 << 16) - 1;
   private static int MAX_ID_LENGTH = (1 << 16) - 1;

   static final long MAX_DWORD = 0xffffffffL;

   protected DimeBodyPart()
   {
   } //do not use.

   /**
    * Create a DIME Attachment Part.
    *
    * @param data   a byte array containing the data as the attachment.
    * @param format the type format for the data.
    * @param type   the type of the data
    * @param id     the ID for the DIME part.
    */
   public DimeBodyPart(byte[] data, DimeTypeNameFormat format,
                       String type, String id)
   {
      System.arraycopy(data, 0, this.data = new byte[data.length], 0, data.length);
      this.dtnf = format;
      this.type = type.getBytes();
      if (this.type.length > MAX_TYPE_LENGTH)
         throw new IllegalArgumentException(Messages.getMessage
                 ("attach.dimetypeexceedsmax",
                         "" + this.type.length, "" + MAX_TYPE_LENGTH));
      this.id = id.getBytes();
      if (this.id.length > MAX_ID_LENGTH)
         throw new IllegalArgumentException(Messages.getMessage("attach.dimelengthexceedsmax", "" + this.id.length,
                 "" + MAX_ID_LENGTH));
   }

   /**
    * Create a DIME Attachment Part.
    *
    * @param dh     the data for the attachment as a JAF datahadler.
    * @param format the type format for the data.
    * @param type   the type of the data
    * @param id     the ID for the DIME part.
    */
   public DimeBodyPart(DataHandler dh,
                       DimeTypeNameFormat format, String type, String id)
   {
      this.data = dh;
      this.dtnf = format;
      if (type == null || type.length() == 0)
         type = "application/octet-stream";
      this.type = type.getBytes();
      if (this.type.length > MAX_TYPE_LENGTH)
         throw new IllegalArgumentException(Messages.getMessage("attach.dimetypeexceedsmax",
                 "" + this.type.length, "" + MAX_TYPE_LENGTH));
      this.id = id.getBytes();
      if (this.id.length > MAX_ID_LENGTH)
         throw new IllegalArgumentException(Messages.getMessage("attach.dimelengthexceedsmax",
                 "" + this.id.length, "" + MAX_ID_LENGTH));
   }

   /**
    * Create a DIME Attachment Part.
    *
    * @param dh the data for the attachment as a JAF datahadler.
    *           The type and foramt is derived from the DataHandler.
    * @param id the ID for the DIME part.
    */
   public DimeBodyPart(DataHandler dh, String id)
   {
      this(dh, DimeTypeNameFormat.MIME, dh.getContentType(), id);

      String ct = dh.getContentType();

      if (ct != null)
      {
         ct = ct.trim();
         if (ct.toLowerCase().startsWith("application/uri"))
         {
            StringTokenizer st = new StringTokenizer(ct, " \t;");
            String t = st.nextToken(" \t;");

            if (t.equalsIgnoreCase("application/uri"))
            {
               for (; st.hasMoreTokens();)
               {
                  t = st.nextToken(" \t;");
                  if (t.equalsIgnoreCase("uri"))
                  {
                     t = st.nextToken("=");
                     if (t != null)
                     {
                        t = t.trim();
                        if (t.startsWith("\""))
                           t =
                                   t.substring(1);

                        if (t.endsWith("\""))
                           t =
                                   t.substring(0, t.length() - 1);
                        this.type = t.getBytes();
                        this.dtnf = DimeTypeNameFormat.URI;
                     }
                     return;
                  }
                  else if (t.equalsIgnoreCase("uri="))
                  {
                     t = st.nextToken(" \t;");
                     if (null != t && t.length() != 0)
                     {
                        t = t.trim();
                        if (t.startsWith("\""))
                           t =
                                   t.substring(1);
                        if (t.endsWith("\""))
                           t =
                                   t.substring(0, t.length() - 1);
                        this.type = t.getBytes();
                        this.dtnf = DimeTypeNameFormat.URI;
                        return;
                     }
                  }
                  else if (t.toLowerCase().startsWith("uri="))
                  {
                     if (-1 != t.indexOf('='))
                     {
                        t = t.substring(t.indexOf('=')).trim();
                        if (t.length() != 0)
                        {
                           t = t.trim();
                           if (t.startsWith("\""))
                              t =
                                      t.substring(1);

                           if (t.endsWith("\""))
                              t = t.substring(0, t.length() - 1);
                           this.type = t.getBytes();
                           this.dtnf = DimeTypeNameFormat.URI;
                           return;

                        }
                     }
                  }
               }
            }
         }
      }
   }

   /**
    * Write to stream the data using maxchunk for the largest junk.
    */
   void write(java.io.OutputStream os, byte position, long maxchunk)
           throws java.io.IOException
   {
      if (maxchunk < 1)
         throw new IllegalArgumentException(Messages.getMessage("attach.dimeMaxChunkSize0", "" + maxchunk));
      if (maxchunk > MAX_DWORD)
         throw new IllegalArgumentException(Messages.getMessage("attach.dimeMaxChunkSize1", "" + maxchunk));
      if (data instanceof byte[])
         send(os, position, (byte[])data,
                 maxchunk);
      if (data instanceof DataHandler)
         send(os, position,
                 (DataHandler)data, maxchunk);
   }

   /**
    * Write to stream the data.
    */
   void write(java.io.OutputStream os, byte position)
           throws java.io.IOException
   {
      write(os, position, MAX_DWORD);
   }

   private static final byte[] pad = new byte[4];

   void send(java.io.OutputStream os, byte position, byte[] data,
             final long maxchunk) throws java.io.IOException
   {
      send(os, position, data, 0, data.length, maxchunk);
   }

   void send(java.io.OutputStream os, byte position, byte[] data,
             int offset, final int length, final long maxchunk)
           throws java.io.IOException
   {

      byte chunknext = 0;

      do
      {
         int sendlength = (int)Math.min(maxchunk, length - offset);

         sendChunk(os, position, data, offset, sendlength, (byte)
                 ((sendlength < (length - offset) ? CHUNK : 0)
                 | chunknext));
         offset += sendlength;
         chunknext = CHUNK_NEXT;
      }
      while (offset < length);
   }

   void send(java.io.OutputStream os, byte position, DataHandler dh,
             final long maxchunk) throws java.io.IOException
   {
// START FIX: http://nagoya.apache.org/bugzilla/show_bug.cgi?id=17001
      java.io.InputStream in = null;
      try
      {
         byte chunknext = 0;

         long dataSize = getDataSize();
         in = dh.getInputStream();
         byte[] readbuf = new byte[64 * 1024];
         int bytesread;

         sendHeader(os, position, dataSize, (byte)0);
         long totalsent = 0;

         do
         {
            bytesread = in.read(readbuf);
            if (bytesread > 0)
            {
               os.write(readbuf, 0, bytesread);
               totalsent += bytesread;
            }
         }
         while (bytesread > -1);
         os.write(pad, 0, dimePadding(totalsent));
      }
      finally
      {
         if (in != null)
         {
            try
            {
               in.close();
            }
            catch (IOException e)
            {
               // ignore
            }
         }
      }
// END FIX: http://nagoya.apache.org/bugzilla/show_bug.cgi?id=17001
   }

   protected void sendChunk(java.io.OutputStream os,
                            final byte position,
                            byte[] data, byte chunk) throws java.io.IOException
   {

      sendChunk(os, position, data, 0, data.length, chunk);
   }

   protected void sendChunk(java.io.OutputStream os,
                            final byte position, byte[] data, int offset, int length,
                            byte chunk) throws java.io.IOException
   {

      sendHeader(os, position, length, chunk);
      os.write(data, offset, length);
      os.write(pad, 0, dimePadding(length));
   }

   static final byte CURRENT_OPT_T = (byte)0;

   protected void sendHeader(java.io.OutputStream os,
                             final byte position,
                             long length, byte chunk) throws java.io.IOException
   {
      byte[] fixedHeader = new byte[12];

      //VERSION
      fixedHeader[0] = (byte)((DimeMultiPart.CURRENT_VERSION << 3) & 0xf8);

      // B, E, and C
      fixedHeader[0] |= (byte)((position & (byte)0x6)
              & ((chunk & CHUNK) != 0 ? ~POSITION_LAST : ~0) &
              ((chunk & CHUNK_NEXT) != 0 ? ~POSITION_FIRST : ~0));
      fixedHeader[0] |= (chunk & CHUNK);

      //TYPE_T
      if ((chunk & CHUNK_NEXT) == 0) //If this is a follow on chunk dont send id again.
         fixedHeader[1] = (byte)((dtnf.toByte() << 4) & 0xf0);

      //OPT_T
      fixedHeader[1] |= (byte)(CURRENT_OPT_T & 0xf);

      //OPTION_LENGTH
      fixedHeader[2] = (byte)0;
      fixedHeader[3] = (byte)0;

      //ID_LENGTH
      if ((chunk & CHUNK_NEXT) == 0)
      { //If this is a follow on chunk dont send id again.
         fixedHeader[4] = (byte)((id.length >>> 8) & 0xff);
         fixedHeader[5] = (byte)((id.length) & 0xff);
      }

      //TYPE_LENGTH
      if ((chunk & CHUNK_NEXT) == 0)
      {
         fixedHeader[6] = (byte)((type.length >>> 8) & 0xff);
         fixedHeader[7] = (byte)((type.length) & 0xff);
      }

      //DATA_LENGTH
      fixedHeader[8] = (byte)((length >>> 24) & 0xff);
      fixedHeader[9] = (byte)((length >>> 16) & 0xff);
      fixedHeader[10] = (byte)((length >>> 8) & 0xff);
      fixedHeader[11] = (byte)(length & 0xff);

      os.write(fixedHeader);

      //OPTIONS + PADDING
      // (NONE)

      //ID + PADDING
      if ((chunk & CHUNK_NEXT) == 0)
      {
         os.write(id);
         os.write(pad, 0, dimePadding(id.length));
      }

      //TYPE + PADDING
      if ((chunk & CHUNK_NEXT) == 0)
      {
         os.write(type);
         os.write(pad, 0, dimePadding(type.length));
      }
   }

   static final int dimePadding(long l)
   {
      return (int)((4L - (l & 0x3L)) & 0x03L);
   }

   long getTransmissionSize(long chunkSize)
   {
      long size = 0;
      size += id.length;
      size += dimePadding(id.length);
      size += type.length;
      size += dimePadding(type.length);
      //no options.
      long dataSize = getDataSize();

      if (0 == dataSize)
      {
         size += 12; //header size.
      }
      else
      {

         long fullChunks = dataSize / chunkSize;
         long lastChunkSize = dataSize % chunkSize;

         if (0 != lastChunkSize) size += 12; //12 bytes for fixed header
         size += 12 * fullChunks; //add additional header size for each chunk.
         size += fullChunks * dimePadding(chunkSize);
         size += dimePadding(lastChunkSize);
         size += dataSize;
      }
      return size;
   }

   long getTransmissionSize()
   {
      return getTransmissionSize(MAX_DWORD);
   }

   protected long getDataSize()
   {
      if (data instanceof byte[]) return ((byte[])(data)).length;
      if (data instanceof DataHandler)
         return getDataSize((DataHandler)data);
      return -1;
   }

   protected long getDataSize(DataHandler dh)
   {
      long dataSize = -1L;

      try
      {
         DataSource ds = dh.getDataSource();

         //Do files our selfs since this is costly to read in. Ask the file system.
         // This is 90% of the use of attachments.
         if (ds instanceof javax.activation.FileDataSource)
         {
            javax.activation.FileDataSource fdh =
                    (javax.activation.FileDataSource)ds;
            java.io.File df = fdh.getFile();

            if (!df.exists())
            {
               throw new RuntimeException(Messages.getMessage("noFile",
                       df.getAbsolutePath()));
            }
            dataSize = df.length();
         }
         else
         {
            dataSize = 0;
            java.io.InputStream in = ds.getInputStream();
            byte[] readbuf = new byte[64 * 1024];
            int bytesread;

            do
            {
               bytesread = in.read(readbuf);
               if (bytesread > 0) dataSize += bytesread;
            }
            while (bytesread > -1);

            if (in.markSupported())
            {
               //Leave the stream open for future reading
               // and reset the stream pointer to the first byte
               in.reset();
            }
            else
            {
               in.close();
            }
         }
      }
      catch (Exception e)
      {
         log.error(Messages.getMessage("exception00"), e);
      }
      return dataSize;
   }
}
