2 * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
4 * This library is free software; you can redistribute it and/or modify it under
5 * the terms of the GNU Lesser General Public License as published by the Free
6 * Software Foundation; either version 2.1 of the License, or (at your option)
9 * This library is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
15 package com.liferay.portal.image;
17 import com.liferay.portal.kernel.image.ImageBag;
18 import com.liferay.portal.kernel.image.ImageToolUtil;
19 import com.liferay.portal.kernel.image.SpriteProcessor;
20 import com.liferay.portal.kernel.log.Log;
21 import com.liferay.portal.kernel.log.LogFactoryUtil;
22 import com.liferay.portal.kernel.servlet.ServletContextUtil;
23 import com.liferay.portal.kernel.util.ArrayUtil;
24 import com.liferay.portal.kernel.util.CharPool;
25 import com.liferay.portal.kernel.util.ContextPathUtil;
26 import com.liferay.portal.kernel.util.FileUtil;
27 import com.liferay.portal.kernel.util.PropertiesUtil;
28 import com.liferay.portal.kernel.util.SortedProperties;
29 import com.liferay.portal.kernel.util.StringPool;
30 import com.liferay.portal.kernel.util.StringUtil;
31 import com.liferay.portal.kernel.util.Validator;
32 import com.liferay.portal.util.PropsValues;
34 import java.awt.Point;
35 import java.awt.Transparency;
36 import java.awt.image.ColorModel;
37 import java.awt.image.DataBuffer;
38 import java.awt.image.DataBufferByte;
39 import java.awt.image.IndexColorModel;
40 import java.awt.image.Raster;
41 import java.awt.image.RenderedImage;
42 import java.awt.image.SampleModel;
45 import java.io.FileOutputStream;
46 import java.io.IOException;
48 import java.util.ArrayList;
49 import java.util.Collections;
50 import java.util.List;
51 import java.util.Properties;
53 import javax.imageio.ImageIO;
55 import javax.media.jai.LookupTableJAI;
56 import javax.media.jai.PlanarImage;
57 import javax.media.jai.RasterFactory;
58 import javax.media.jai.TiledImage;
59 import javax.media.jai.operator.LookupDescriptor;
60 import javax.media.jai.operator.MosaicDescriptor;
61 import javax.media.jai.operator.TranslateDescriptor;
63 import javax.servlet.ServletContext;
65 import org.geotools.image.ImageWorker;
68 * @author Brian Wing Shun Chan
70 public class SpriteProcessorImpl implements SpriteProcessor {
72 public Properties generate(
73 ServletContext servletContext, List<File> imageFiles,
74 String spriteFileName, String spritePropertiesFileName,
75 String spritePropertiesRootPath, int maxHeight, int maxWidth,
79 if (imageFiles.size() < 1) {
83 if (spritePropertiesRootPath.endsWith(StringPool.BACK_SLASH) ||
84 spritePropertiesRootPath.endsWith(StringPool.SLASH)) {
86 spritePropertiesRootPath = spritePropertiesRootPath.substring(
87 0, spritePropertiesRootPath.length() - 1);
90 Collections.sort(imageFiles);
92 String spriteRootDirName = getSpriteRootDirName(
93 servletContext, imageFiles);
95 File spritePropertiesFile = new File(
96 spriteRootDirName + StringPool.SLASH + spritePropertiesFileName);
98 boolean build = false;
100 long lastModified = 0;
102 if (spritePropertiesFile.exists()) {
103 lastModified = spritePropertiesFile.lastModified();
105 for (File imageFile : imageFiles) {
106 if (imageFile.lastModified() > lastModified) {
118 String spritePropertiesString = FileUtil.read(spritePropertiesFile);
120 if (Validator.isNull(spritePropertiesString)) {
124 return PropertiesUtil.load(spritePropertiesString);
128 List<RenderedImage> renderedImages = new ArrayList<RenderedImage>();
130 Properties spriteProperties = new SortedProperties();
135 for (File imageFile : imageFiles) {
136 if (imageFile.length() > maxSize) {
141 ImageBag imageBag = ImageToolUtil.read(imageFile);
143 RenderedImage renderedImage = imageBag.getRenderedImage();
145 int height = renderedImage.getHeight();
146 int width = renderedImage.getWidth();
148 if ((height <= maxHeight) && (width <= maxWidth)) {
149 renderedImage = convert(renderedImage);
151 renderedImage = TranslateDescriptor.create(
152 renderedImage, x, y, null, null);
154 renderedImages.add(renderedImage);
156 String key = StringUtil.replace(
157 imageFile.toString(), CharPool.BACK_SLASH,
161 spritePropertiesRootPath.toString().length());
163 String value = (int)y + "," + height + "," + width;
165 spriteProperties.setProperty(key, value);
167 y += renderedImage.getHeight();
170 catch (Exception e) {
171 if (_log.isWarnEnabled()) {
172 _log.warn("Unable to process " + imageFile);
175 if (_log.isDebugEnabled()) {
181 if (renderedImages.size() <= 1) {
182 renderedImages.clear();
183 spriteProperties.clear();
189 RenderedImage renderedImage = MosaicDescriptor.create(
190 renderedImages.toArray(
191 new RenderedImage[renderedImages.size()]),
192 MosaicDescriptor.MOSAIC_TYPE_OVERLAY, null, null, null, null,
195 File spriteFile = new File(
196 spriteRootDirName + StringPool.SLASH + spriteFileName);
200 ImageIO.write(renderedImage, "png", spriteFile);
202 if (lastModified > 0) {
203 spriteFile.setLastModified(lastModified);
206 ImageWorker imageWorker = new ImageWorker(renderedImage);
208 imageWorker.forceIndexColorModelForGIF(true);
212 renderedImage = imageWorker.getPlanarImage();
214 spriteFile = new File(
215 spriteRootDirName + StringPool.SLASH +
216 StringUtil.replace(spriteFileName, ".png", ".gif"));
218 FileOutputStream fos = new FileOutputStream(spriteFile);
221 ImageToolUtil.encodeGIF(renderedImage, fos);
227 if (lastModified > 0) {
228 spriteFile.setLastModified(lastModified);
233 spritePropertiesFile, PropertiesUtil.toString(spriteProperties));
235 if (lastModified > 0) {
236 spritePropertiesFile.setLastModified(lastModified);
239 return spriteProperties;
242 protected RenderedImage convert(RenderedImage renderedImage)
245 int height = renderedImage.getHeight();
246 int width = renderedImage.getWidth();
248 SampleModel sampleModel = renderedImage.getSampleModel();
249 ColorModel colorModel = renderedImage.getColorModel();
251 Raster raster = renderedImage.getData();
253 DataBuffer dataBuffer = raster.getDataBuffer();
255 if (colorModel instanceof IndexColorModel) {
256 IndexColorModel indexColorModel = (IndexColorModel)colorModel;
258 int mapSize = indexColorModel.getMapSize();
260 byte[][] data = new byte[4][mapSize];
262 indexColorModel.getReds(data[0]);
263 indexColorModel.getGreens(data[1]);
264 indexColorModel.getBlues(data[2]);
265 indexColorModel.getAlphas(data[3]);
267 LookupTableJAI lookupTableJAI = new LookupTableJAI(data);
269 renderedImage = LookupDescriptor.create(
270 renderedImage, lookupTableJAI, null);
272 else if (sampleModel.getNumBands() == 2) {
273 List<Byte> bytesList = new ArrayList<Byte>(
274 height * width * _NUM_OF_BANDS);
276 List<Byte> tempBytesList = new ArrayList<Byte>(_NUM_OF_BANDS);
278 for (int i = 0; i < dataBuffer.getSize(); i++) {
279 int mod = (i + 1) % 2;
284 tempBytesList.add((byte)dataBuffer.getElem(elemPos - 1));
285 tempBytesList.add((byte)dataBuffer.getElem(elemPos - 1));
288 tempBytesList.add((byte)dataBuffer.getElem(elemPos));
291 Collections.reverse(tempBytesList);
293 bytesList.addAll(tempBytesList);
295 tempBytesList.clear();
299 byte[] data = ArrayUtil.toArray(
300 bytesList.toArray(new Byte[bytesList.size()]));
302 DataBuffer newDataBuffer = new DataBufferByte(data, data.length);
304 renderedImage = createRenderedImage(
305 renderedImage, height, width, newDataBuffer);
307 else if (colorModel.getTransparency() != Transparency.TRANSLUCENT) {
308 List<Byte> bytesList = new ArrayList<Byte>(
309 height * width * _NUM_OF_BANDS);
311 List<Byte> tempBytesList = new ArrayList<Byte>(_NUM_OF_BANDS);
313 for (int i = 0; i < dataBuffer.getSize(); i++) {
314 int mod = (i + 1) % 3;
318 tempBytesList.add((byte)dataBuffer.getElem(elemPos));
321 tempBytesList.add((byte)255);
323 Collections.reverse(tempBytesList);
325 bytesList.addAll(tempBytesList);
327 tempBytesList.clear();
331 byte[] data = ArrayUtil.toArray(
332 bytesList.toArray(new Byte[bytesList.size()]));
334 DataBuffer newDataBuffer = new DataBufferByte(data, data.length);
336 renderedImage = createRenderedImage(
337 renderedImage, height, width, newDataBuffer);
340 return renderedImage;
343 protected RenderedImage createRenderedImage(
344 RenderedImage renderedImage, int height, int width,
345 DataBuffer dataBuffer) {
347 SampleModel sampleModel =
348 RasterFactory.createPixelInterleavedSampleModel(
349 DataBuffer.TYPE_BYTE, width, height, _NUM_OF_BANDS);
350 ColorModel colorModel = PlanarImage.createColorModel(sampleModel);
352 TiledImage tiledImage = new TiledImage(
353 0, 0, width, height, 0, 0, sampleModel, colorModel);
355 Raster raster = RasterFactory.createWritableRaster(
356 sampleModel, dataBuffer, new Point(0, 0));
358 tiledImage.setData(raster);
360 /*javax.media.jai.JAI.create(
361 "filestore", tiledImage, "test.png", "PNG");
363 printImage(renderedImage);
364 printImage(tiledImage);}*/
369 protected String getSpriteRootDirName(
370 ServletContext servletContext, List<File> imageFiles) {
372 String spriteRootDirName = PropsValues.SPRITE_ROOT_DIR;
374 File imageFile = imageFiles.get(0);
376 File imageDir = imageFile.getParentFile();
378 String imageDirName = imageDir.toString();
380 if (Validator.isNull(spriteRootDirName)) {
384 if (!spriteRootDirName.endsWith(StringPool.BACK_SLASH) &&
385 !spriteRootDirName.endsWith(StringPool.SLASH)) {
387 spriteRootDirName += StringPool.SLASH;
390 String portalProxyPath = PropsValues.PORTAL_PROXY_PATH;
392 if (Validator.isNotNull(portalProxyPath)) {
393 spriteRootDirName += portalProxyPath + StringPool.SLASH;
396 String portalContextPath = PropsValues.PORTAL_CTX;
398 if (Validator.isNotNull(portalContextPath) &&
399 !portalContextPath.equals(StringPool.SLASH)) {
401 spriteRootDirName += portalContextPath + StringPool.SLASH;
404 String portletContextPath = ContextPathUtil.getContextPath(
407 if (Validator.isNotNull(portletContextPath)) {
408 spriteRootDirName += portletContextPath + StringPool.SLASH;
411 String rootRealPath = ServletContextUtil.getRealPath(
412 servletContext, StringPool.SLASH);
414 spriteRootDirName = StringUtil.replace(
415 spriteRootDirName + imageDirName.substring(rootRealPath.length()),
416 CharPool.BACK_SLASH, CharPool.SLASH);
418 if (spriteRootDirName.endsWith(StringPool.BACK_SLASH) ||
419 spriteRootDirName.endsWith(StringPool.SLASH)) {
421 spriteRootDirName = spriteRootDirName.substring(
422 0, spriteRootDirName.length() - 1);
425 return spriteRootDirName;
428 protected void printImage(RenderedImage renderedImage) {
429 SampleModel sampleModel = renderedImage.getSampleModel();
431 int height = renderedImage.getHeight();
432 int width = renderedImage.getWidth();
433 int numOfBands = sampleModel.getNumBands();
435 int[] pixels = new int[height * width * numOfBands];
437 Raster raster = renderedImage.getData();
439 raster.getPixels(0, 0, width, height, pixels);
443 for (int h = 0; h < height; h++) {
444 for (int w = 0; w < width; w++) {
445 offset = (h * width * numOfBands) + (w * numOfBands);
447 System.out.print("[" + w + ", " + h + "] = ");
449 for (int b = 0; b < numOfBands; b++) {
450 System.out.print(pixels[offset + b] + " ");
454 System.out.println();
458 private static final int _NUM_OF_BANDS = 4;
460 private static Log _log = LogFactoryUtil.getLog(SpriteProcessorImpl.class);