# MultipartEntityWriter.java

    /*
    ** Module   : MultipartEntityWriter.java
    ** Abstract : Implementation of the builtin class.
    **
    ** Copyright (c) 2019-2024, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
    ** 001 CA  20190526 First version, stubs taken by converting the skeleton using FWD.
    ** 002 IAS 20190527 Added multipart support.
    ** 003 CA  20191024 Added method support levels and updated the class support level.
    ** 004 CA  20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy signature.
    ** 005 ME  20210330 Complete implementation as per OE12.2.
    **     VVT 20210917 Javadoc fixed.
    **     CA  20220120 Do not used TypeFactory.object when the OO reference must not be tracked or registered.
    **                  Do not use TypeFactory.object for internal usages, use ObjectVar if the reference must
    **                  be tracked.
    **                  All TypeFactory.object variable definitions must be done outside of the top-level block.
    **     ME  20210929 Fix function block for getBoundary.
    ** 006 CA  20231113 The 'execute' method must be annotated with LegacySignature Type.Execute, and also can be
    **                  dropped if is a no-op.
    ** 007 AL2 20240930 Deleted temporary ByteBucket and Writer created in the process.
    */

    /*
    ** This program is free software: you can redistribute it and/or modify
    ** it under the terms of the GNU Affero General Public License as
    ** published by the Free Software Foundation, either version 3 of the
    ** License, or (at your option) any later version.
    **
    ** This program 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 Affero General Public License for more details.
    **
    ** You may find a copy of the GNU Affero GPL version 3 at the following
    ** location: https://www.gnu.org/licenses/agpl-3.0.en.html
    **
    ** Additional terms under GNU Affero GPL version 3 section 7:
    **
    **   Under Section 7 of the GNU Affero GPL version 3, the following additional
    **   terms apply to the works covered under the License.  These additional terms
    **   are non-permissive additional terms allowed under Section 7 of the GNU
    **   Affero GPL version 3 and may not be removed by you.
    **
    **   0. Attribution Requirement.
    **
    **     You must preserve all legal notices or author attributions in the covered
    **     work or Appropriate Legal Notices displayed by works containing the covered
    **     work.  You may not remove from the covered work any author or developer
    **     credit already included within the covered work.
    **
    **   1. No License To Use Trademarks.
    **
    **     This license does not grant any license or rights to use the trademarks
    **     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
    **     of Golden Code Development Corporation. You are not authorized to use the
    **     name Golden Code, FWD, or the names of any author or contributor, for
    **     publicity purposes without written authorization.
    **
    **   2. No Misrepresentation of Affiliation.
    **
    **     You may not represent yourself as Golden Code Development Corporation or FWD.
    **
    **     You may not represent yourself for publicity purposes as associated with
    **     Golden Code Development Corporation, FWD, or any author or contributor to
    **     the covered work, without written authorization.
    **
    **   3. No Misrepresentation of Source or Origin.
    **
    **     You may not represent the covered work as solely your work.  All modified
    **     versions of the covered work must be marked in a reasonable way to make it
    **     clear that the modified work is not originating from Golden Code Development
    **     Corporation or FWD.  All modified versions must contain the notices of
    **     attribution required in this license.
    */

    package com.goldencode.p2j.oo.net.http.filter.payload;

    import static com.goldencode.p2j.util.BlockManager.externalProcedure;
    import static com.goldencode.p2j.report.ReportConstants.*;
    import static com.goldencode.p2j.util.BlockManager.function;
    import static com.goldencode.p2j.util.BlockManager.internalProcedure;
    import static com.goldencode.p2j.util.BlockManager.onBlockLevel;
    import static com.goldencode.p2j.util.BlockManager.returnNormal;

    import java.io.*;
    import java.nio.charset.*;

    import org.apache.commons.io.*;
    import org.apache.james.mime4j.*;
    import org.apache.james.mime4j.stream.*;

    import com.goldencode.p2j.oo.common.support.ImemptrHolder;
    import com.goldencode.p2j.oo.core.*;
    import com.goldencode.p2j.oo.lang.*;
    import com.goldencode.p2j.oo.net.*;
    import com.goldencode.p2j.oo.net.http.*;
    import com.goldencode.p2j.oo.net.http.filter.writer.*;
    import com.goldencode.p2j.util.*;
    import com.goldencode.p2j.util.BlockManager.Action;
    import com.goldencode.p2j.util.BlockManager.Condition;
    import com.goldencode.p2j.util.InternalEntry.*;

    /**
     *
     * Parse multipart/* payload
     *
     */
    @LegacyResource(resource = "OpenEdge.Net.HTTP.Filter.Payload.MultipartEntityWriter")
    @LegacyResourceSupport(supportLvl = CVT_LVL_PARTIAL|RT_LVL_PARTIAL)
    public class MultipartEntityWriter
    extends MessageWriter
    implements ISupportMultipartEntity
    {
       private static final String CRLF = "\r\n";
       /** Multipart boundary */
       private character boundary = TypeFactory.character();

       /**
        * Get multipart boundary.
        *
        * @return boundary.
        */
       @LegacySignature(returns = "CHARACTER", type = Type.GETTER, name = "Boundary")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       @Override
       public character getBoundary()
       {
          return function(this, "Boundary", character.class, new Block((Body) () ->
          {
             returnNormal(boundary);
          }));
       }

       /**
        * Set multipart boundary.
        *
        * @param _boundary multipart boundary/
        */
       @LegacySignature(type = Type.SETTER, name = "Boundary", parameters =
       {
             @LegacyParameter(name = "boundary", type = "CHARACTER", mode = "INPUT")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       @Override
       public void setBoundary(character _boundary)
       {
          character boundary = TypeFactory.initInput(_boundary);
          internalProcedure(this, "Boundary", new Block((Body) () ->
          {
             this.boundary.assign(boundary);
          }));
       }

       /**
        * Execute method.
        */
       @LegacySignature(type = Type.EXECUTE)
       public void __net_http_filter_payload_MultipartEntityWriter_execute__()
       {
          onBlockLevel(Condition.ERROR, Action.THROW);
       }

       /**
        * Constructor.
        */
       @LegacySignature(type = Type.CONSTRUCTOR)
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       public void __net_http_filter_payload_MultipartEntityWriter_constructor__()
       {
          internalProcedure(this, "__net_http_filter_payload_MultipartBodyWriter_constructor__",
                new Block((Body) () ->
          {
             __net_http_filter_payload_MessageWriter_constructor__(
                   ObjectOps.getLegacyClass(MultipartEntity.class)
             );

             this.boundary.assign("X-OPENEDGE-BOUNDARY");
          }));
       }

       /**
        * Write data to/from the entity
        *
        * @param _poData data to be written
        *
        * @return number of bytes written
        */
       @LegacySignature(returns = "INT64", type = Type.METHOD, name = "Write", parameters =
       {
          @LegacyParameter(name = "poData", type = "OBJECT",
                qualified = "progress.lang.object", mode = "INPUT")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       @Override
       public int64 write(object<? extends _BaseObject_> _poData)
       {
          object<? extends _BaseObject_> poData = TypeFactory.initInput(_poData);
          object<? extends Memptr> mptr = TypeFactory.object(Memptr.class);

          return function(this, "Write", int64.class, new Block((Body) () ->
          {
             if (!poData._isValid())
             {
                returnNormal(0);
             }
             else if (ObjectOps.typeOf(poData, ImemptrHolder.class).booleanValue())
             {
                returnNormal(write(ObjectOps.cast(poData, ImemptrHolder.class).ref().getValue()));
             }
             else if (ObjectOps.typeOf(poData, ByteBucket.class).booleanValue())
             {
                mptr.assign(ObjectOps.cast(poData, ByteBucket.class).ref().getBytes());
                returnNormal(write(mptr.ref().getValue()));
             }
             else if (ObjectOps.typeOf(poData, MessagePart.class).booleanValue())
             {
                returnNormal(write_1(ObjectOps.cast(poData, MessagePart.class)));
             }
             else
             {
                unsupported(poData);
             }
          }));
       }

       /**
        * Write data to/from the entity
        *
        * @param _ptr data to be written
        *
        * @return number of bytes written
        */
       @LegacySignature(returns = "INT64", type = Type.METHOD, name = "Write", parameters =
       {
          @LegacyParameter(name = "poData", type = "MEMPTR", mode = "INPUT")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       @Override
       public int64 write(memptr _ptr)
       {
          memptr ptr = TypeFactory.initInput(_ptr);

          object<? extends ByteBucket> pd = TypeFactory.object(ByteBucket.class);
          object<? extends MessagePart> mp = TypeFactory.object(MessagePart.class);
          object<? extends MessageWriter> mpw = TypeFactory.object(MessageWriter.class);

          return function(this, "Write", int64.class, new Block((Body) () ->
          {
             Assert.notNull(ptr.length(), new character("Data size"));

             try
             {

                object<? extends MultipartEntity> mpe = ObjectOps.newInstance(MultipartEntity.class);
                mpe.ref().setBoundary(this.boundary);
                this.entity.assign(mpe);

                byte[] bytes = ptr.getByteArray();

                ByteArrayInputStream bais = new ByteArrayInputStream(bytes);
                String contentType =
                      "multipart/form-data; boundary=\"" +
                      this.boundary.getValue() +
                      "\"";
                MimeTokenStream parser = new MimeTokenStream();
                parser.parseHeadless(bais, contentType);

                for (EntityState state = parser.getState(); state != EntityState.T_END_OF_STREAM;
                      state = parser.next())
                {
                   switch(state)
                   {
                   case T_START_MULTIPART:
                      break;
                   case T_PREAMBLE:
                      String preamble = new String(IOUtils.toByteArray(parser.getInputStream()),
                            StandardCharsets.UTF_8);
                      mpe.ref().setPrologue(new character(preamble));
                      break;
                   case T_START_BODYPART:
                      mp.assign(ObjectOps.newInstance(MessagePart.class));
                      break;
                   case T_START_HEADER:
                      break;
                   case T_FIELD:
                      Field f = parser.getField();
                      mp.ref().getHeaders().ref().put(
                            HttpHeaderBuilder.build(new character(f.getName())).ref().
                               value(new character(f.getBody())).ref().getHeader()
                      );
                      break;
                   case T_END_HEADER:
                      break;
                   case T_BODY:
                      String body = new String(IOUtils.toByteArray(parser.getInputStream()),
                            StandardCharsets.UTF_8);
                      mpw.assign(EntityWriterBuilder.build(mp).ref().getWriter());
                      Assert.notNull(mpw, new character("Part writer"));
                      pd.assign(ByteBucket.instance());
                      pd.ref().putString(new longchar(body));
                      mpw.ref().open();
                      mpw.ref().write(pd);
                      mpw.ref().close();
                      mp.ref().setBody(mpw.ref().getEntity());
                      break;
                   case T_END_BODYPART:
                      mpe.ref().addPart(mp);
                      break;
                   case T_EPILOGUE:
                      String epilogue = new String(IOUtils.toByteArray(parser.getInputStream()),
                            StandardCharsets.UTF_8);
                      mpe.ref().setEpilogue(new character(epilogue));
                      break;
                   case T_END_MULTIPART:
                      break;
                   case T_END_MESSAGE:
                      break;
                   }
                }

                returnNormal(new int64(bytes.length));
             }
             catch (IOException | MimeException e)
             {
                // TODO: must be OE error here!!!
                throw new RuntimeException("Failed to parse multipart payload", e);
             }
          },
          (Fini) () ->
          {
             if (pd != null && pd._isValid())
             {
                ObjectOps.delete(pd);
             }
             if (mpw != null && mpw._isValid())
             {
                ObjectOps.delete(mpw);
             }
          }));

       }

       @LegacySignature(type = Type.METHOD, name = "Write", returns = "INT64", parameters =
       {
          @LegacyParameter(name = "pData", type = "OBJECT", qualified = "openedge.net.messagepart", mode = "INPUT")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       public int64 write_1(final object<? extends MessagePart> _pData)
       {
          object<? extends MultipartEntity> mEntity = TypeFactory.object(MultipartEntity.class);
          object<? extends MessagePart> pData = TypeFactory.initInput(_pData);

          return function(MultipartEntityWriter.class, this, "Write", int64.class, new Block((Body) () ->
          {
             if (pData._isValid())
             {
                if (!this.entity._isValid())
                {
                   mEntity.assign(ObjectOps.newInstance(MultipartEntity.class));
                   mEntity.ref().setBoundary(boundary);
                   this.entity.assign(mEntity);
                }
                else
                {
                   mEntity.assign(ObjectOps.cast(this.entity, MultipartEntity.class));
                }

                mEntity.ref().addPart(pData);
             }

             returnNormal(0);
          }));
       }
    }