# RedirectStatusFilter.java

    /*
    ** Module   : RedirectStatusFilter.java
    ** Abstract : Implementation of the builtin class.
    **
    ** Copyright (c) 2019-2023, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- -------------------------------Description--------------------------------
    ** 001 CA  20190526 First version, stubs taken by converting the skeleton using FWD.
    ** 002 IAS 20191108 Implemented base logic.
    ** 003 IAS 20191117 Update support levels.
    ** 004 ME  20200410 Added setter method for logger.
    ** 005 CA  20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
    **                  signature.
    ** 006 ME  20210331 Implement as per OE12.2.
    **     VVT 20210917 Javadoc fixed.
    **     ME  20210929 Fix function block for getMessage, getLogger.
    ** 007 CA  20231113 The 'execute' method must be annotated with LegacySignature Type.Execute, and also can be
    **                  dropped if is a no-op.
    */

    /*
    ** 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.status;

    import static com.goldencode.p2j.util.BlockManager.externalProcedure;
    import static com.goldencode.p2j.util.BlockManager.function;
    import static com.goldencode.p2j.report.ReportConstants.*;
    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 com.goldencode.p2j.oo.core.*;
    import com.goldencode.p2j.oo.lang.*;
    import com.goldencode.p2j.oo.logging.*;
    import com.goldencode.p2j.oo.net.*;
    import com.goldencode.p2j.oo.net.http.*;
    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.*;

    /**
     *
     * Processes the 301,302/Redirect status code
     *
     */
    @LegacyResource(resource = "OpenEdge.Net.HTTP.Filter.Status.RedirectStatusFilter")
    @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_PARTIAL)
    public class RedirectStatusFilter
    extends BaseObject
    implements IHttpMessageWriter, ISupportLogging
    {
       /** Logger */
       private final object<? extends IlogWriter> logger = TypeFactory.object(IlogWriter.class);

       /**
        * The message that's being written to. The values passed in to the Write() methods
        * will be parsed/processed and written to this message.
        */
       private final object<? extends IhttpMessage> message = TypeFactory.object(IhttpMessage.class);

       /** Redirect location */
       private final character location = TypeFactory.character();

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

       /**
        * Constructor
        *
        * @param _poMessage - HTTP request
        */
       @LegacySignature(type = Type.CONSTRUCTOR, parameters =
       {
          @LegacyParameter(name = "poMessage", type = "object",
                qualified = "OpenEdge.Net.HTTP.IHttpRequest", mode = "INPUT")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_PARTIAL)
       public void __net_http_filter_status_RedirectStatusFilter_constructor__(
             object<? extends IhttpRequest> _poMessage)
       {
          object<? extends IhttpRequest> poMessage = TypeFactory.initInput(_poMessage);

          internalProcedure(this, "__net_http_filter_status_RedirectStatusFilter_constructor__",
                new Block((Body) () ->
          {
             __lang_BaseObject_constructor__();

             Assert.notNull(poMessage, new character("Http request"));
             this.message.assign(poMessage);
             // TODO: init logger
             logger.assign(ObjectOps.newInstance(VoidLogger.class));

          }));
       }

       /**
        * Opens the writer for output. Open/Close allows us to write the same message multiple
        * times without requiring a new writer each time.
        */
       @LegacySignature(type = Type.METHOD, name = "Open")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       @Override
       public void open()
       {
          internalProcedure(this, "Open", new Block((Body)() -> {
             this.location.assign("");
          }));
       }

       /**
        * Write data to/from the message
        *
        * @param _poData Data to write
        */
       @LegacySignature(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 void write(object<? extends _BaseObject_> _poData)
       {
          object<? extends _BaseObject_> poData = TypeFactory.initInput(_poData);

          internalProcedure(this, "Write", new Block((Body) () -> {
             Assert.isType(poData, ObjectOps.getLegacyClass(IhttpResponse.class));

             object<? extends IhttpResponse> response = ObjectOps.cast(poData, IhttpResponse.class);

             this.location.assign(response.ref().getHeader(new character("Location")).ref().getValue());

             logger.ref().debug(TextOps.substitute("HTTP status &1", response.ref().getStatusCode()));
          }));
       }

       /**
        * Write data to/from the message
        *
        * @param _pcData Data to write
        */
       @LegacySignature(type = Type.METHOD, name = "Write", parameters =
       {
          @LegacyParameter(name = "pcData", type = "LONGCHAR", mode = "INPUT")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       @Override
       public void write(longchar _pcData)
       {
          longchar pcData = TypeFactory.initInput(_pcData);
          internalProcedure(this, "Write", new Block((Body)() ->
          {
             Assert.notNullOrEmpty(pcData, new character("Location"));
             this.location.assign(pcData);
          }));
       }

       /**
        * Write data to/from the message
        *
        * @param phData Data to write
        */
       @LegacySignature(type = Type.METHOD, name = "Write", parameters =
       {
          @LegacyParameter(name = "phData", type = "HANDLE", mode = "INPUT")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       @Override
       public void write(handle phData)
       {
          // No-op

       }

       /**
        * Write data to/from the message
        *
        * @param _pcData Data to write
        */
       @LegacySignature(type = Type.METHOD, name = "Write", parameters =
       {
          @LegacyParameter(name = "pcData", type = "CHARACTER", mode = "INPUT")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       @Override
       public void write(character _pcData)
       {
          character pcData = TypeFactory.initInput(_pcData);
          internalProcedure(this, "Write", new Block((Body)() ->
          {
             Assert.notNullOrEmpty(pcData, new character("Location"));
             this.location.assign(pcData);
          }));
       }

       /**
        * Write data to/from the message
        *
        * @param _poData Data to write
        */
       @LegacySignature(type = Type.METHOD, name = "Write", parameters =
       {
          @LegacyParameter(name = "poData", type = "MEMPTR", mode = "INPUT")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       @Override
       public void write(memptr _poData)
       {
          memptr poData = TypeFactory.initInput(_poData);

          internalProcedure(this, "Write", new Block((Body)() ->
          {
             Assert.isPositive(poData.length(), new character("Data size"));
             this.location.assign(poData.getString(1));
          }));
       }

       /**
        * Flushes data to the output location. What data is flushed depends on the implementation
        */
       @LegacySignature(type = Type.METHOD, name = "Flush")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       @Override
       public void flush()
       {
          object<? extends Uri> redirectUri = TypeFactory.object(Uri.class);

          internalProcedure(this, "Flush", new Block((Body)() -> {

             if (TextOps.isEmpty(this.location))
                return;

             redirectUri.assign(ObjectOps.cast(message, IhttpRequest.class).ref().getUri());

             logger.ref().debug(TextOps.substitute("Redirect from URL \"&1\" to \"&2\"",
                      redirectUri.ref().toLegacyString(),
                      location));

             redirectUri.assign(Uri.resolveRelativeReference(redirectUri, location));
             ObjectOps.cast(message, IhttpRequest.class).ref().setUri(redirectUri);

             logger.ref().debug(TextOps.substitute("Redirect URL: &1",
                      redirectUri.ref().toLegacyString()));

          }));
       }

       /**
        * Get message.
        *
        * @return message.
        */
       @LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Net.HTTP.IHttpMessage", type = Type.GETTER, name = "Message")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       @Override
       public object<? extends IhttpMessage> getMessage()
       {
          return function(this, "Message", object.class, new Block((Body) () ->
          {
             returnNormal(message);
          }));
       }

       /**
        * Closes the output. See Open()
        */
       @LegacySignature(type = Type.METHOD, name = "Close")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_PARTIAL)
       @Override
       public void close()
       {
          internalProcedure(this, "Close", new Block((Body)() -> {
             flush();
             this.location.assign("");
             // TODO: clean cookies
          }));
       }

       /**
        * Get logger.
        *
        * @return logger.
        */
       @LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Logging.ILogWriter", type = Type.GETTER, name = "Logger")
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       @Override
       public object<? extends IlogWriter> getLogger()
       {
          return function(this, "Logger", object.class, new Block((Body) () ->
          {
             returnNormal(logger);
          }));
       }

       /**
        * Set logger.
        *
        * @param _logger
        *        the new logger value
        */
       @LegacySignature(type = Type.SETTER, name = "Logger", parameters =
       {
          @LegacyParameter(name = "logger", type = "OBJECT", mode = "INPUT", qualified = "OpenEdge.Logging.ILogWriter")
       })
       @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
       @Override
       public void setLogger(object<? extends IlogWriter> _logger)
       {
          object<? extends IlogWriter> logger = TypeFactory.initInput(_logger);

          internalProcedure(this, "Logger", new Block((Body) () ->
          {
             this.logger.assign(logger);
          }));

       }
    }