summaryrefslogtreecommitdiffstats
path: root/ecomp-sdk/epsdk-analytics/src/main/java/org/onap/portalsdk/analytics/model/pdf/PageEvent.java
blob: 5ed8f9f669cf86a7f613ad080c192d233687fbd2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
/*
 * ============LICENSE_START==========================================
 * ONAP Portal SDK
 * ===================================================================
 * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
 * ===================================================================
 *
 * Unless otherwise specified, all software contained herein is licensed
 * under the Apache License, Version 2.0 (the "License");
 * you may not use this software 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.
 *
 * Unless otherwise specified, all documentation contained herein is licensed
 * under the Creative Commons License, Attribution 4.0 Intl. (the "License");
 * you may not use this documentation except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *             https://creativecommons.org/licenses/by/4.0/
 *
 * Unless required by applicable law or agreed to in writing, documentation
 * 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.
 *
 * ============LICENSE_END============================================
 *
 * 
 */
package org.onap.portalsdk.analytics.model.pdf;

import java.awt.Color;
import java.io.File;
import java.io.IOException;
import java.net.MalformedURLException;

import org.onap.portalsdk.analytics.system.AppUtils;
import org.onap.portalsdk.analytics.system.Globals;
import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;

import com.lowagie.text.BadElementException;
import com.lowagie.text.Cell;
import com.lowagie.text.Document;
import com.lowagie.text.ExceptionConverter;
import com.lowagie.text.Font;
import com.lowagie.text.FontFactory;
import com.lowagie.text.Image;
import com.lowagie.text.Paragraph;
import com.lowagie.text.Rectangle;
import com.lowagie.text.pdf.PdfContentByte;
import com.lowagie.text.pdf.PdfDestination;
import com.lowagie.text.pdf.PdfOutline;
import com.lowagie.text.pdf.PdfPCell;
import com.lowagie.text.pdf.PdfPTable;
import com.lowagie.text.pdf.PdfPageEventHelper;
import com.lowagie.text.pdf.PdfWriter;

class PageEvent extends PdfPageEventHelper {
	
	private static final EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(PageEvent.class);
	
	private PdfBean pb;
	private int pageNo = 0;
	private int omit_page_count = 0;
	private int DEFAULT_LOGO_SIZE = 100;

	public PageEvent(PdfBean pb) {
		this.pb = pb;
	}
	
	private int getHowManyLogos(){
		int howManyLogos = 0;
		
		if(AppUtils.isNotEmpty(pb.getLogo1Url()) && !pb.getLogo1Url().equalsIgnoreCase("<no logo>"))
			howManyLogos ++;
		
		if(AppUtils.isNotEmpty(pb.getLogo2Url()) && !pb.getLogo2Url().equalsIgnoreCase("<no logo>"))
			howManyLogos ++;
		
		return howManyLogos;
	}
	
	private float[] fillWidthsArray(int howManyLogos){
		float[] widthsArray = new float[howManyLogos + 1];
		
		//If one logo, we will need two columns in the header[left log, spacer] 
		if(howManyLogos == 1){
			widthsArray = new float[2];
			widthsArray[0] = 0.1f;
			widthsArray[1] = 0.1f;
		}
		//If two logs, we will need three columns in the header [left log, spacer, right log]
		else
		if(howManyLogos == 2){
			widthsArray = new float[3];
			widthsArray[0] = 0.1f;
			widthsArray[1] = 0.5f;
			widthsArray[2] = 0.1f;
		}
		
		return widthsArray;
	}
	public void onStartPage(PdfWriter writer, Document document) {
		
		Font font = FontFactory.getFont(Globals.getFooterFontFamily(), Globals.getFooterFontSize(), Font.NORMAL, Color.BLACK);
		int howManyLogos = getHowManyLogos();
		
		//No need to draw anything in the header if no logo was set in the report.
		if(howManyLogos == 0)
			return;
		
		float[] widths = fillWidthsArray(howManyLogos);
				
		PdfPTable foot = new PdfPTable(widths);
		
		if(AppUtils.isNotEmpty(pb.getLogo1Url()) && !pb.getLogo1Url().equalsIgnoreCase("<no logo>"))
			addLogo(foot, font, pb.getLogo1Url().substring(pb.getLogo1Url().indexOf("|") + 1).trim(), Cell.ALIGN_LEFT, pb.getLogo1Size() == null ? DEFAULT_LOGO_SIZE : pb.getLogo1Size());
		
		PdfPCell spacingCell = new PdfPCell();
		spacingCell.setBorderColor(Color.WHITE);
		foot.addCell(spacingCell);
		
		//Using logo1 size for now - use logo2 size if it is required to deal it separately.
		if(AppUtils.isNotEmpty(pb.getLogo2Url()) && !pb.getLogo2Url().equalsIgnoreCase("<no logo>"))
			addLogo(foot, font, pb.getLogo2Url().substring(pb.getLogo2Url().indexOf("|") + 1).trim(),  Cell.ALIGN_RIGHT, pb.getLogo2Size() == null ? DEFAULT_LOGO_SIZE : pb.getLogo2Size());

		foot.setTotalWidth(getPageWidth(document));
		foot.writeSelectedRows(0, -1, 36, 600, writer.getDirectContent());
	}

	public void onEndPage(PdfWriter writer, Document document) {

		Font font = FontFactory.getFont(Globals.getFooterFontFamily(), Globals.getFooterFontSize(), Font.NORMAL, Color.BLACK);

		try {

			// footer
			float[] f = { 1f, 0.4f, 1f };
			PdfPTable foot = new PdfPTable(f);
			foot.getDefaultCell().setBorderWidth(0);
			foot.getDefaultCell().setHorizontalAlignment(Rectangle.ALIGN_CENTER);
			foot.getDefaultCell().setVerticalAlignment(Rectangle.ALIGN_BOTTOM);

			foot.getDefaultCell().setHorizontalAlignment(Rectangle.ALIGN_LEFT);
			addLeftFooter(foot, font);

			foot.getDefaultCell().setHorizontalAlignment(Rectangle.ALIGN_CENTER);
			addPageNumber(foot, font, pb.isPageNumberAtFooter(), document.getPageNumber());

			foot.getDefaultCell().setHorizontalAlignment(Rectangle.ALIGN_RIGHT);
			foot.getDefaultCell().setNoWrap(true);

			foot.addCell(new Paragraph("                   " + PdfReportHandler.currentTime(pb.getTimestampPattern()), font));

			foot.setTotalWidth(getPageWidth(document));
			foot.writeSelectedRows(0, -1, document.leftMargin(), document.bottomMargin(), writer.getDirectContent());

			// bookmark
			pageNo++;
			PdfContentByte cb = writer.getDirectContent();
			PdfDestination destination = new PdfDestination(PdfDestination.FITH);
			String bookmark = "Data Page " + (pageNo - omit_page_count);
			if (pageNo == 1) {
				if (pb.isCoverPageIncluded()) {
					bookmark = "Cover Page";
					omit_page_count++;
				} else if (pb.isDisplayChart()) {
					bookmark = "Chart";
					omit_page_count++;
				}
			}
			if (pageNo == 2 && pb.isCoverPageIncluded() && pb.isDisplayChart()) {
				bookmark = "Chart";
				omit_page_count++;
			}

			PdfOutline outline = new PdfOutline(cb.getRootOutline(), destination, bookmark);

		} catch (Exception e) {
			throw new ExceptionConverter(e);
		}
	}

	private void addPageNumber(PdfPTable table, Font font, boolean isAdd, int pageNum) {
		if (isAdd)
			table.addCell(new Paragraph(Globals.getWordBeforePageNumber() + " " + pageNum + " " + Globals.getWordAfterPageNumber(), font));
		else
			table.addCell("");
	}

	private void addLeftFooter(PdfPTable table, Font font) {
		Font font1 = new Font(font);
		font1.setSize(Globals.getPDFFooterFontSize());

		if (isEmpty(pb.getLeftFooter()))
			table.addCell(new Paragraph("                 " + Globals.getPDFFooter(), font1));
		else
			table.addCell(new Paragraph(pb.getLeftFooter(), font));
	}

	private void addLogo(PdfPTable table, Font font, String imgSrc, int alignment, int absoluteSize) {

		Image img = null;
		try {
			img = Image.getInstance(pb.getFullWebContextPath() + AppUtils.getImgFolderURL() + File.separator + imgSrc);
		} catch (BadElementException  |  MalformedURLException e) {
			logger.error(EELFLoggerDelegate.errorLogger,"addLogo() failed ", e);
			img = null;
		}  catch (IOException e) {
			logger.error(EELFLoggerDelegate.errorLogger,e.getMessage(), e);
			
		}
		if(img == null){
			//log that the input file couldnt be loaded - 
		}
		else{
			img.scalePercent(absoluteSize, absoluteSize);
			PdfPCell cell = new PdfPCell(img);
			cell.setBorderColor(Color.WHITE);
			cell.setHorizontalAlignment(alignment);
			table.addCell(cell);
		}

	}

	public static float getPageWidth(Document doc) {
		return doc.getPageSize().width() - doc.leftMargin() - doc.rightMargin();
	}

	public static float getPageHeight(Document doc) {
		return doc.getPageSize().height() - doc.topMargin() - doc.bottomMargin();
	}

	private float getHeadTopMargin(Document doc, PdfPTable table) {
		return doc.getPageSize().height() - doc.topMargin() + table.getTotalHeight();
	}

	private boolean isEmpty(String str) {
		return str == null || str.trim().length() == 0;
	}

} // PageEvent