/*
    * This file is part of Waarp Project (named also Waarp or GG).
    *
    *  Copyright (c) 2019, Waarp SAS, and individual contributors by the @author
    *  tags. See the COPYRIGHT.txt in the distribution for a full listing of
    * individual contributors.
    *
    *  All Waarp Project 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 3 of the License, or (at your
   * option) any later version.
   *
   * Waarp 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 General Public License for more details.
   *
   *  You should have received a copy of the GNU General Public License along with
   * Waarp . If not, see <http://www.gnu.org/licenses/>.
   */
  package org.waarp.openr66.protocol.localhandler.packet;
  
  import io.netty.buffer.ByteBuf;
  import io.netty.buffer.ByteBufAllocator;
  import io.netty.buffer.Unpooled;
  import org.waarp.common.utility.WaarpNettyUtil;
  import org.waarp.openr66.protocol.exception.OpenR66ProtocolPacketException;
  import org.waarp.openr66.protocol.localhandler.LocalChannelReference;
  
  /**
   * Block Request Message class
   * <p>
   * 1 code (byte as 0: unblock, 1:block): block, 1 string: spassword(or key)
   */
  public class BlockRequestPacket extends AbstractLocalPacket {
    private final boolean block;
    private final byte[] key;
  
    /**
     * @param headerLength
     * @param middleLength
     * @param endLength
     * @param buf
     *
     * @return the new ValidPacket from buffer
     *
     * @throws OpenR66ProtocolPacketException
     */
    public static BlockRequestPacket createFromBuffer(final int headerLength,
                                                      final int middleLength,
                                                      final int endLength,
                                                      final ByteBuf buf)
        throws OpenR66ProtocolPacketException {
      if (headerLength - 2 <= 0) {
        throw new OpenR66ProtocolPacketException("Not enough data");
      }
      final byte isblock = buf.readByte();
      final byte[] bpassword = new byte[headerLength - 2];
      buf.readBytes(bpassword);
      final boolean block = isblock == 1;
      return new BlockRequestPacket(block, bpassword);
    }
  
    /**
     * @param block
     * @param spassword
     */
    public BlockRequestPacket(final boolean block, final byte[] spassword) {
      this.block = block;
      key = spassword;
    }
  
    @Override
    public final boolean hasGlobalBuffer() {
      return true;
    }
  
    @Override
    public final synchronized void createAllBuffers(
        final LocalChannelReference lcr, final int networkHeader) {
      end = Unpooled.EMPTY_BUFFER;
      middle = Unpooled.EMPTY_BUFFER;
      final int globalSize = networkHeader + LOCAL_HEADER_SIZE + 1 + key.length;
      final int offset = networkHeader + LOCAL_HEADER_SIZE;
      global = ByteBufAllocator.DEFAULT.ioBuffer(globalSize, globalSize);
      header = WaarpNettyUtil.slice(global, offset, 1 + key.length);
      header.writeByte(block? 1 : 0);
      header.writeBytes(key);
    }
  
    @Override
    public final String toString() {
      return "BlockRequestPacket: " + block;
    }
  
    @Override
    public final byte getType() {
      return LocalPacketFactory.BLOCKREQUESTPACKET;
    }
  
   /**
    * @return True if the request is to block new requests, else false
    */
   public final boolean getBlock() {
     return block;
   }
 
   /**
    * @return the key
    */
   public final byte[] getKey() {
     return key;
   }
 }