/**
 * <copyright> Copyright 2006 by Know-Center, Graz, Austria </copyright>
 * PDF-AS has been contracted by the E-Government Innovation Center EGIZ, a
 * joint initiative of the Federal Chancellery Austria and Graz University of
 * Technology.
 *
 * Licensed under the EUPL, Version 1.1 or - as soon they will be approved by
 * the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 * http://www.osor.eu/eupl/
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and
 * limitations under the Licence.
 *
 * This product combines work with different licenses. See the "NOTICE" text
 * file for details on the various modules and licenses.
 * The "NOTICE" text file is part of the distribution. Any derivative works
 * that you distribute must include a readable copy of the "NOTICE" text file.
 *
 * $Id: TextualSignator_1_0_0.java,v 1.3 2006/10/31 08:07:50 wprinz Exp $
 */
package at.knowcenter.wag.egov.egiz.framework.signators;

import java.util.ArrayList;

import at.gv.egiz.pdfas.framework.input.DataSource;
import at.gv.egiz.pdfas.framework.input.PdfDataSource;
import at.gv.egiz.pdfas.impl.input.TextDataSourceImpl;
import at.gv.egiz.pdfas.impl.signator.IncrementalUpdateHelper;
import at.knowcenter.wag.egov.egiz.PdfAS;
import at.knowcenter.wag.egov.egiz.PdfASID;
import at.knowcenter.wag.egov.egiz.exceptions.PresentableException;
import at.knowcenter.wag.egov.egiz.framework.SignResult;
import at.knowcenter.wag.egov.egiz.framework.Signator;
import at.knowcenter.wag.egov.egiz.framework.SignatorFactory;
import at.knowcenter.wag.egov.egiz.pdf.IncrementalUpdateInformation;
import at.knowcenter.wag.egov.egiz.pdf.PositioningInstruction;
import at.knowcenter.wag.egov.egiz.pdf.TablePos;
import at.knowcenter.wag.egov.egiz.pdf.TextualSignature;
import at.knowcenter.wag.egov.egiz.sig.SignatureDataImpl;
import at.knowcenter.wag.egov.egiz.sig.SignatureObject;
import at.knowcenter.wag.egov.egiz.sig.signatureobject.SignatureObjectHelper;

import com.lowagie.text.pdf.PdfPTable;

/**
 * Signs a document textually.
 * 
 * <p>
 * In prepareSign, the document text is extracted and normalized.
 * </p>
 * <p>
 * In finishSign, the signed SignatureObject is transformed into a Signature
 * block, which is then written as an Incremental Update.
 * </p>
 * 
 * @deprecated moved to new-framework
 *
 * @author wprinz
 */
public class TextualSignator_1_0_0 implements Signator
{
  /**
   * The Pdf-AS ID of this Signator.
   */
  public static final PdfASID MY_ID = new PdfASID(SignatorFactory.VENDOR, SignatorFactory.TYPE_TEXTUAL, SignatorFactory.VERSION_1_0_0);

  /**
   * @see at.knowcenter.wag.egov.egiz.framework.Signator#getMyId()
   */
  public PdfASID getMyId()
  {
    return MY_ID;
  }

  /**
   * Default constructor.
   */
  public TextualSignator_1_0_0()
  {
    // Default constructor.
  }

  /**
   * <p>
   * The parameter has_SIG_ID is not used by this Signator because it doesn't
   * pre-format the signature block.
   * </p>
   * 
   * @see at.knowcenter.wag.egov.egiz.framework.Signator#prepareSign(byte[],
   *      String, TablePos, boolean)
   */
  public IncrementalUpdateInformation prepareSign(PdfDataSource pdf,
      String signature_type, TablePos pos, boolean has_SIG_ID) throws PresentableException
  {
    IncrementalUpdateInformation iui = new IncrementalUpdateInformation();
    iui.original_document = pdf;
    iui.signature_type = signature_type;
    iui.pos = pos;

    String document_text = PdfAS.extractNormalizedTextTextual(pdf);
    iui.nonTextObjectInfos = PdfAS.extractNonTextualObjects(pdf);
    // logger_.debug("signed_text = " + document_text);
    
    DataSource ds = new TextDataSourceImpl(document_text);
    iui.signature_data = new SignatureDataImpl(ds, "text/plain", "UTF-8");

    return iui;
  }

  /**
   * @see at.knowcenter.wag.egov.egiz.framework.Signator#finishSign(at.knowcenter.wag.egov.egiz.pdf.IncrementalUpdateInformation)
   */
  public SignResult finishSign(IncrementalUpdateInformation iui) throws PresentableException
  {
    // PdfAS.prefixID(iui.signed_signature_object, PdfAS.TEXT_ID);

    iui.signed_signature_object.kz = getMyId().toString();

    SignatureObject so = SignatureObjectHelper.convertSignSignatureObjectToSignatureObject(iui.signed_signature_object, iui.signature_type);
    
    PdfPTable pdf_table = PdfAS.createPdfPTableFromSignatureObject(so);

    PositioningInstruction pi = PdfAS.determineTablePositioning(iui.pos, iui.signature_type, iui.original_document, pdf_table);

    IncrementalUpdateInformation signed_iui = IncrementalUpdateHelper.writeIncrementalUpdate(iui.original_document, pdf_table, iui.signature_type, pi, null, null, null, null, null);

    SignResult sign_result = new SignResult(PdfAS.PDF_MIME_TYPE, signed_iui.signed_pdf);
    return sign_result;
  }

}