org.jrimum.bopepo.view.ViewerPDF Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of bpp-cobranca Show documentation
Show all versions of bpp-cobranca Show documentation
This is a fork and merge from JRimum ( http://www.jrimum.org ),
- Bopepo: https://github.com/jrimum/bopepo
- Texgit: https://github.com/jrimum/texgit
- Valia: https://github.com/jrimum/vallia
- Utilix: https://github.com/jrimum/utilix
- Domkee: https://github.com/jrimum/domkee
For Brazillian Boleto Payment Method. So much thanks for original authors:
Gilmar P. S. L, Misael Barreto and Rômulo Augusto.
The newest version!
/*
* Copyright 2008 JRimum Project
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by
* applicable law or agreed to in writing, software distributed under the
* License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
* OF ANY KIND, either express or implied. See the License for the specific
* language governing permissions and limitations under the License.
*
* Created at: 30/03/2008 - 18:05:16
*
* ================================================================================
*
* Direitos autorais 2008 JRimum Project
*
* Licenciado sob a Licença Apache, Versão 2.0 ("LICENÇA"); você não pode usar
* esse arquivo exceto em conformidade com a esta LICENÇA. Você pode obter uma
* cópia desta LICENÇA em http://www.apache.org/licenses/LICENSE-2.0 A menos que
* haja exigência legal ou acordo por escrito, a distribuição de software sob
* esta LICENÇA se dará “COMO ESTÁ”, SEM GARANTIAS OU CONDIÇÕES DE QUALQUER
* TIPO, sejam expressas ou tácitas. Veja a LICENÇA para a redação específica a
* reger permissões e limitações sob esta LICENÇA.
*
* Criado em: 30/03/2008 - 18:05:16
*
*/
package org.jrimum.bopepo.view;
import com.itextpdf.text.DocumentException;
import com.itextpdf.text.Image;
import com.itextpdf.text.pdf.AcroFields;
import com.itextpdf.text.pdf.BarcodeInter25;
import com.itextpdf.text.pdf.PdfContentByte;
import com.itextpdf.text.pdf.PdfReader;
import com.itextpdf.text.pdf.PdfStamper;
import org.jrimum.bopepo.Guia;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import javax.imageio.ImageIO;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.apache.log4j.Logger;
import org.jrimum.domkee.banco.Convenio;
import org.jrimum.domkee.banco.OrgaoRecebedor;
import org.jrimum.domkee.banco.TipoValorReferencia;
import org.jrimum.bopepo.BancosSuportados;
import org.jrimum.utilix.DateUtil;
import org.jrimum.utilix.FileUtil;
import org.jrimum.utilix.MonetaryUtil;
import static org.jrimum.utilix.Objects.isNotNull;
import static org.jrimum.utilix.Objects.isNull;
import org.jrimum.utilix.PDFUtil;
import org.jrimum.utilix.RectanglePDF;
/**
*
*
* DEFINIÇÃO DA CLASSE
*
*
*
* OBJETIVO/PROPÓSITO
*
*
*
* EXEMPLO:
*
*
* @author misael
*
* @since 0.3
*
* @version 0.3
*/
class ViewerPDF {
// TODO Teste no teste unitário.
/**
*
*/
private static final long serialVersionUID = 1L;
private static Logger log = Logger.getLogger(ViewerPDF.class);
private static URL TEMPLATE_PADRAO = ViewerPDF.class.getResource("/pdf/GuiaTemplate.pdf");
private static URL TEMPLATE_PADRAO_SEM_BANCO = ViewerPDF.class.getResource("/pdf/GuiaTemplateSemBanco.pdf");
private PdfReader reader;
private PdfStamper stamper;
private AcroFields form;
private ByteArrayOutputStream outputStream;
private Guia guia;
private File template;
/**
*
* Para uso interno do componente
*
*/
ViewerPDF() {
}
ViewerPDF(Guia guia) {
this.guia = guia;
}
ViewerPDF(Guia guia, File template) {
this.guia = guia;
setTemplate(template);
}
/**
*
* SOBRE O MÉTODO
*
*
* @param pathName arquivo de destino
* @param guias a serem agrupados
* @param guiaViewer visualizador
*
* @return File contendo guias geradas.
*
* @throws RuntimeException Quando ocorrer um problema na geração do PDF que
* está fora do controle da biblioteca.
*
* @since 0.3
*/
protected static File groupInOnePDF(String pathName, List guias,
GuiaViewer guiaViewer) {
File arq = null;
List guiasEmBytes = new ArrayList(guias.size());
for (Guia guia : guias) {
guiasEmBytes.add(guiaViewer.setGuia(guia).getPdfAsByteArray());
}
try {
arq = FileUtil.bytes2File(pathName, PDFUtil
.mergeFiles(guiasEmBytes));
} catch (FileNotFoundException e) {
log.error("Erro durante geração do PDF." + e.getLocalizedMessage(),
e);
throw new RuntimeException(
"Erro durante geração do PDF. Causado por "
+ e.getLocalizedMessage(), e);
} catch (IOException e) {
log.error("Erro durante geração do PDF." + e.getLocalizedMessage(),
e);
throw new RuntimeException(
"Erro durante geração do PDF. Causado por "
+ e.getLocalizedMessage(), e);
}
return arq;
}
/**
*
* SOBRE O MÉTODO
*
*
* @param path
* @param extensao TODO
* @param guias
* @return List com os boletos gerados.
*
* @since 0.2
*/
protected static List onePerPDF(String path, String extensao,
List guias) {
List arquivos = new ArrayList(guias.size());
int cont = 1;
for (Guia guia : guias) {
arquivos.add(new GuiaViewer(guia).getPdfAsFile(path + "Guia"
+ cont++ + extensao));
}
return arquivos;
}
/**
*
* @param pathName
* @return
* @throws IllegalArgumentException
*/
protected File getFile(String pathName) {
File file = null;
try {
processarPdf();
file = FileUtil.bytes2File(pathName, outputStream.toByteArray());
} catch (FileNotFoundException e) {
log.error("Erro ao tentar acessar arquivo inexistente. "
+ e.getLocalizedMessage(), e);
throw new RuntimeException(
"Erro ao tentar acessar arquivo inexistente: [" + pathName
+ "]. " + "Causado por " + e.getLocalizedMessage(),
e);
} catch (IOException e) {
log.error("Erro durante a criação do arquivo. "
+ e.getLocalizedMessage(), e);
throw new RuntimeException("Erro durante a criação do arquivo: ["
+ pathName + "]. " + "Causado por "
+ e.getLocalizedMessage(), e);
} catch (DocumentException e) {
log.error("Erro durante a criação do arquivo. "
+ e.getLocalizedMessage(), e);
throw new RuntimeException("Erro durante a criação do arquivo: ["
+ pathName + "]. " + "Causado por "
+ e.getLocalizedMessage(), e);
}
return file;
}
/**
* @throws RuntimeException
*
* @return
*/
protected ByteArrayOutputStream getStream() {
ByteArrayOutputStream baos = null;
try {
processarPdf();
baos = FileUtil.bytes2Stream(outputStream.toByteArray());
} catch (IOException e) {
log.error("Erro durante a criação do stream. "
+ e.getLocalizedMessage(), e);
throw new RuntimeException("Erro durante a criação do stream. "
+ "Causado por " + e.getLocalizedMessage(), e);
} catch (DocumentException e) {
log.error("Erro durante a criação do stream. "
+ e.getLocalizedMessage(), e);
throw new RuntimeException("Erro durante a criação do stream. "
+ "Causado por " + e.getLocalizedMessage(), e);
}
return baos;
}
/**
* @throws RuntimeException
*
* @return
*/
protected byte[] getBytes() {
byte[] bytes = null;
try {
processarPdf();
bytes = outputStream.toByteArray();
} catch (IOException e) {
log.error("Erro durante a criação do stream. "
+ e.getLocalizedMessage(), e);
throw new RuntimeException("Erro durante a criação do stream. "
+ "Causado por " + e.getLocalizedMessage(), e);
} catch (DocumentException e) {
log.error("Erro durante a criação do stream. "
+ e.getLocalizedMessage(), e);
throw new RuntimeException("Erro durante a criação do stream. "
+ "Causado por " + e.getLocalizedMessage(), e);
}
return bytes;
}
protected File getTemplate() {
return template;
}
protected void setTemplate(File template) {
this.template = template;
}
protected void setTemplate(String pathname) {
setTemplate(new File(pathname));
}
/**
* @return the boleto
*
* @since 0.2
*/
protected Guia getGuia() {
return this.guia;
}
/**
*
* SOBRE O MÉTODO
*
*
* @throws IOException
* @throws DocumentException
*
* @since
*/
private void processarPdf() throws IOException, DocumentException {
inicializar();
preencher();
finalizar();
}
/**
*
* SOBRE O MÉTODO
*
*
* @return URL template
*
* @since
*/
private URL getTemplateFromResource() {
URL templateFromResource = null;
if (isNotNull(guia.getArrecadacao().getConvenio())
&& isNotNull(guia.getArrecadacao().getConvenio().getBanco())) {
templateFromResource = TEMPLATE_PADRAO;
} else {
templateFromResource = TEMPLATE_PADRAO_SEM_BANCO;
}
return templateFromResource;
}
/**
*
* Verifica se o template que será utilizado virá do resource ou é externo,
* ou seja, se o usuário definiu ou não um template.
*
*
* @return true caso o template que pode ser definido pelo usuário for null;
* false caso o usuário tenha definido um template.
*
* @since
*/
private boolean isTemplateFromResource() {
return isNull(getTemplate());
}
/**
*
* SOBRE O MÉTODO
*
*
* @throws IOException
* @throws DocumentException
*
* @since
*/
private void inicializar() throws IOException, DocumentException {
if (isTemplateFromResource()) {
reader = new PdfReader(getTemplateFromResource());
} else {
reader = new PdfReader(getTemplate().getAbsolutePath());
}
outputStream = new ByteArrayOutputStream();
stamper = new PdfStamper(reader, outputStream);
form = stamper.getAcroFields();
}
/**
*
* SOBRE O MÉTODO
*
*
* @throws DocumentException
* @throws IOException
*
* @since
*/
private void finalizar() throws DocumentException, IOException {
reader.consolidateNamedDestinations();/*
* Replaces all the local named
* links with the actual
* destinations.
*/
stamper.setFormFlattening(true);/*
* Determines if the fields are
* flattened on close.
*/
stamper.setRotateContents(true);/*
* Flags the content to be automatically
* adjusted to compensate the original
* page rotation.
*/
reader.removeFields();/* Removes all the fields from the document. */
stamper.setFullCompression();/*
* Sets the document's compression to the
* new 1.5 mode with object streams and xref
* streams.
*/
reader.eliminateSharedStreams();/*
* Eliminates shared streams if they
* exist.
*/
// Send immediately
outputStream.flush();
// close All in this order
outputStream.close();
reader.close();
stamper.close();
}
/**
*
* SOBRE O MÉTODO
*
*
* @throws MalformedURLException
* @throws IOException
* @throws DocumentException
*
* @since
*/
private void preencher() throws MalformedURLException, IOException,
DocumentException {
setLogoBanco();
setLogoOrgaoRecebedor();
setContribuinteNome();
setContribuinteCPF();
setDescricao();
setTitulo();
setNossoNumero();
setValorDocumento();
setDataDocumento();
setDataVencimeto();
setInstrucaoAoCaixa();
setLinhaDigitavel();
setCodigoBarra();
setCamposExtra();
setImagensNosCampos();
}
private void setCamposExtra() throws IOException, DocumentException {
if (isNotNull(guia.getTextosExtras())) {
for (String campo : guia.getTextosExtras().keySet()) {
form.setField(campo, guia.getTextosExtras().get(campo));
}
}
}
private void setCodigoBarra() throws DocumentException {
// Montando o código de barras.
BarcodeInter25 barCode = new BarcodeInter25();
barCode.setCode(guia.getCodigoDeBarras().write());
barCode.setExtended(true);
barCode.setBarHeight(40);
barCode.setFont(null);
barCode.setN(3);
PdfContentByte cb = null;
// Verifcando se existe o field(campo) da imagem no template do boleto.
List posCampoImgLogo = form.getFieldPositions("txtCodigoBarra");
if (isNotNull(posCampoImgLogo)) {
for (AcroFields.FieldPosition pos : posCampoImgLogo) {
RectanglePDF field = new RectanglePDF(pos.position);
cb = stamper.getOverContent(field.getPage());
Image imgBarCode = barCode.createImageWithBarcode(cb, null, null);
PDFUtil.changeField2Image(stamper, field, imgBarCode);
}
}
}
private void setDataDocumento() throws IOException, DocumentException {
form.setField("txtDataDocumento", DateUtil.FORMAT_DD_MM_YYYY
.format(guia.getArrecadacao().getDataDoDocumento()));
}
private void setInstrucaoAoCaixa() throws IOException, DocumentException {
form.setField("txtInstrucaoAoCaixa1", guia.getInstrucaoAoCaixa1());
form.setField("txtInstrucaoAoCaixa2", guia.getInstrucaoAoCaixa2());
form.setField("txtInstrucaoAoCaixa3", guia.getInstrucaoAoCaixa3());
}
private void setValorDocumento() throws IOException, DocumentException {
String valorStr = null;
if ((guia.getArrecadacao().getTipoValorReferencia() == TipoValorReferencia.VALOR_COBRADO_EM_REAL_COM_DV_MODULO_10)
|| (guia.getArrecadacao().getTipoValorReferencia() == TipoValorReferencia.VALOR_COBRADO_EM_REAL_COM_DV_MODULO_11)) {
valorStr = MonetaryUtil.FORMAT_REAL_COM_PREFIXO.format(guia.getArrecadacao().getValorDocumento());
} else {
valorStr = MonetaryUtil.FORMAT_REAL.format(guia.getArrecadacao().getValorDocumento());
}
form.setField("txtValorDocumento1", valorStr);
form.setField("txtValorDocumento2", valorStr);
form.setField("txtValorDocumento3", valorStr);
}
private void setDataVencimeto() throws IOException, DocumentException {
// Obtendo uma string com a data de vencimento formatada
// no padrão "dd/mm/yyyy".
// Ex: 03/07/2008.
String dataFormatada = DateUtil.FORMAT_DD_MM_YYYY.format(guia
.getArrecadacao().getDataDoVencimento());
form.setField("txtDataVencimento", dataFormatada);
form.setField("txtDataVencimento1", dataFormatada);
form.setField("txtDataVencimento2", dataFormatada);
form.setField("txtDataVencimento3", dataFormatada);
}
private void setContribuinteNome() throws IOException, DocumentException {
form.setField("txtContribuinteNome", guia.getArrecadacao()
.getContribuinte().getNome());
}
private void setContribuinteCPF() throws IOException, DocumentException {
form.setField("txtContribuinteCPF", guia.getArrecadacao()
.getContribuinte().getCPF().getCodigoFormatado());
}
private void setDescricao() throws IOException, DocumentException {
form.setField("txtDescricao", guia.getArrecadacao().getDescricao());
}
private void setTitulo() throws IOException, DocumentException {
form.setField("txtTitulo", guia.getArrecadacao().getTitulo());
}
private void setLinhaDigitavel() throws DocumentException, IOException {
form.setField("txtLinhaDigitavel", guia.getLinhaDigitavel().write());
}
private void setLogoBanco() throws MalformedURLException, IOException,
DocumentException {
// Através da conta bancária será descoberto a imagem que representa o
// banco, com base
// no código do banco.
Convenio convenio = guia.getArrecadacao().getConvenio();
Image imgLogoBanco = null;
// Se há um banco especificado...
if (isNotNull(convenio) && isNotNull(convenio.getBanco())) {
if (isNotNull(convenio.getBanco().getImgLogo())) {
imgLogoBanco = Image.getInstance(convenio.getBanco().getImgLogo(),
null);
setImageLogo(imgLogoBanco);
} else {
if (BancosSuportados.isSuportado(convenio.getBanco()
.getCodigoDeCompensacaoBACEN().getCodigoFormatado())) {
URL url = this.getClass().getResource(
"/img/"
+ convenio.getBanco()
.getCodigoDeCompensacaoBACEN()
.getCodigoFormatado() + ".png");
if (isNotNull(url)) {
imgLogoBanco = Image.getInstance(url);
}
if (isNotNull(imgLogoBanco)) {
// Esta imagem gerada aqui é do tipo java.awt.Image
convenio.getBanco().setImgLogo(ImageIO.read(url));
}
// Se o banco em questão é suportado nativamente pelo
// componente,
// então um alerta será exibido.
if (log.isDebugEnabled()) {
log.debug("Banco sem imagem da logo informada. "
+ "Com base no código do banco, uma imagem foi "
+ "encontrada no resource e está sendo utilizada.");
}
setImageLogo(imgLogoBanco);
} else {
// Sem imagem, um alerta é exibido.
log.warn("Banco sem imagem definida. O nome da instituição será usado como logo.");
form.setField("txtLogoBanco", convenio.getBanco().getNome());
}
}
}
}
private void setLogoOrgaoRecebedor() throws MalformedURLException, IOException,
DocumentException {
Image imgLogoBanco = null;
OrgaoRecebedor orgaoRecebedor = guia.getArrecadacao().getOrgaoRecebedor();
if (isNotNull(orgaoRecebedor.getImgLogo())) {
imgLogoBanco = Image.getInstance(orgaoRecebedor.getImgLogo(), null);
setImagemNoCampo("txtLogoOrgaoRecebedor1", imgLogoBanco);
setImagemNoCampo("txtLogoOrgaoRecebedor2", imgLogoBanco);
}
}
/**
*
* Coloca as imagens dos campos no pdf de acordo com o nome dos campos do
* boleto atribuídos no map e templante.
*
*
* @throws DocumentException
* @throws IOException
*
* @since 0.2
*/
private void setImagensNosCampos() throws DocumentException, IOException {
if (isNotNull(guia.getImagensExtras())) {
for (String campo : guia.getImagensExtras().keySet()) {
setImagemNoCampo(campo, Image.getInstance(guia
.getImagensExtras().get(campo), null));
}
}
}
/**
*
* Coloca uma imagem no pdf de acordo com o nome do field no templante.
*
*
* @param nomeDoCampo
* @param imagem
* @throws DocumentException
*
* @since 0.2
*/
private void setImagemNoCampo(String nomeDoCampo, Image imagem)
throws DocumentException {
if (StringUtils.isNotBlank(nomeDoCampo)) {
List posCampoImgLogo = form.getFieldPositions(nomeDoCampo);
if (isNotNull(posCampoImgLogo)) {
for (AcroFields.FieldPosition fpos : posCampoImgLogo) {
PDFUtil.changeField2Image(stamper, new RectanglePDF(fpos.position), imagem);
}
}
}
}
/**
*
* Coloca a logo do passada na ficha de compensação do boleto e no recibo do
* sacado.
*
*
* @param imgLogoBanco
* @throws DocumentException
*
* @since 0.2
*/
private void setImageLogo(Image imgLogoBanco) throws DocumentException {
setImagemNoCampo("txtLogoBanco", imgLogoBanco);
}
private void setNossoNumero() throws IOException, DocumentException {
form.setField("txtNossoNumero", guia.getArrecadacao().getNossoNumero());
}
/**
* Exibe os valores de instância.
*
* @see br.com.nordestefomento.jrimum.utilix.ObjectUtil#toString()
*/
@Override
public String toString() {
ToStringBuilder tsb = new ToStringBuilder(this);
tsb.append(guia);
return tsb.toString();
}
}