Changeset 1679 for trunk/docx4j/src/main

Timestamp:

10/07/11 00:09:49 (8 months ago)

Author:

jharrop

Message:

createImagePart from FilePath? - y.rolland's patch of Thu Oct 06, 2011. Interim commit.

File:

• trunk/docx4j/src/main/java/org/docx4j/openpackaging/parts/WordprocessingML/BinaryPartAbstractImage.java (modified) (43 diffs)

trunk/docx4j/src/main/java/org/docx4j/openpackaging/parts/WordprocessingML/BinaryPartAbstractImage.java

@@ -18 +18 @@
 
  */
-
 package org.docx4j.openpackaging.parts.WordprocessingML;
 
@@ -67 +66 @@
 import org.docx4j.wml.SectPr.PgSz;
 
-
 public abstract class BinaryPartAbstractImage extends BinaryPart {
         
         protected static Logger log = Logger.getLogger(BinaryPartAbstractImage.class);
-        
         final static String IMAGE_DIR_PREFIX = "/word/media/";
         final static String IMAGE_NAME_PREFIX = "image";
@@ -90 +87 @@
                 super(externalTarget);
         }
-        
-        
         ImageInfo imageInfo;
 
         public ImageInfo getImageInfo() {
                 
-                if (imageInfo==null) {
-                        
+        if (imageInfo == null) {
                         // TODO - create it
-                        
                         // Save byte buffer as a tmp file
-                        
                         // Generate ImageInfo
-                        
                         // Delete tmp file
-                        
                 }
                 
@@ -114 +104 @@
                 this.imageInfo = imageInfo;
         }
-        
         // TODO, instead of Part.getOwningRelationshipPart(),
         // it would be better to have getOwningRelationship(),
@@ -120 +109 @@
         // This is a temp workaround    
         Relationship rel;
-                
         static int density = 150;       
+
         /**
          * Set the resolution at which a PDF or EPS is converted
@@ -139 +128 @@
                 
         }
-
         static ImageManager imageManager;
 
@@ -160 +148 @@
         }
         
+    /*
+     * Possibility to put directly an image filePath instead of giving an image byte array
+     * @param wordMLPackage
+     * @param filePath
+     * 
+     */
+    public static BinaryPartAbstractImage createImagePart(WordprocessingMLPackage wordMLPackage,
+            String filePath) throws Exception {
+
+        return createImagePartFromFilePath(wordMLPackage,
+                wordMLPackage.getMainDocumentPart(), filePath);
+
+    }
+
         /**
          * This method assumes your package is a docx (not a pptx or xlsx).
@@ -169 +171 @@
          */
         @Deprecated
-        public static String createImageName(Base sourcePart, String proposedRelId, String ext ) {
+    public static String createImageName(Base sourcePart, String proposedRelId, String ext) {
                 
                 return PartName.generateUniqueName(sourcePart, proposedRelId, 
@@ -175 +177 @@
         }
 
-        public static String createImageName(OpcPackage opcPackage, Base sourcePart, String proposedRelId, String ext ) {
+    public static String createImageName(OpcPackage opcPackage, Base sourcePart, String proposedRelId, String ext) {
                 
                 if (opcPackage instanceof WordprocessingMLPackage) {            
@@ -193 +195 @@
         }
         
-        
-        
         /**
          * Create an image part from the provided byte array, attach it to the source part
@@ -222 +222 @@
                 fos.write(bytes);
                 fos.close();
-                log.debug("created tmp file: " +  tmpImageFile.getAbsolutePath() );
+        log.debug("created tmp file: " + tmpImageFile.getAbsolutePath());
                                 
                 ImageInfo info = ensureFormatIsSupported(tmpImageFile.getAbsolutePath(), tmpImageFile, bytes);
@@ -232 +232 @@
                 
                 // Ensure the relationships part exists
-                if (sourcePart.getRelationshipsPart()==null) 
+        if (sourcePart.getRelationshipsPart() == null) {
                         RelationshipsPart.createRelationshipsPartForPart(sourcePart);
+        }
 
                 String proposedRelId = sourcePart.getRelationshipsPart().getNextId();
                                 
-                String ext = info.getMimeType().substring( info.getMimeType().indexOf("/")+1);
+        String ext = info.getMimeType().substring(info.getMimeType().indexOf("/") + 1);
                 
 //              System.out.println(ext);
                 
                 BinaryPartAbstractImage imagePart = 
-                        (BinaryPartAbstractImage)ctm.newPartForContentType(
+                (BinaryPartAbstractImage) ctm.newPartForContentType(
                                 info.getMimeType(), 
-                                createImageName(opcPackage, sourcePart, proposedRelId, ext), null
-                                 );
-                                
-                log.debug("created part " + imagePart.getClass().getName() +
-                                " with name " + imagePart.getPartName().toString() );           
+                createImageName(opcPackage, sourcePart, proposedRelId, ext), null);
+                                
+        log.debug("created part " + imagePart.getClass().getName()
+                + " with name " + imagePart.getPartName().toString());
                 
                 FileInputStream fis = new FileInputStream(tmpImageFile);                
-                imagePart.setBinaryData( fis );
-                                
-                imagePart.rel =  sourcePart.addTargetPart(imagePart, proposedRelId);
+        imagePart.setBinaryData(fis);
+                                
+        imagePart.rel = sourcePart.addTargetPart(imagePart, proposedRelId);
                 
                 imagePart.setImageInfo(info);
@@ -264 +264 @@
                 fis = null;
                 System.gc();            
-                if (tmpImageFile.delete() ) {
-                        log.debug(".. deleted " +  tmpImageFile.getAbsolutePath() );                    
+        if (tmpImageFile.delete()) {
+            log.debug(".. deleted " + tmpImageFile.getAbsolutePath());
                 } else {
                         log.warn("Couldn't delete tmp file " + tmpImageFile.getAbsolutePath());
@@ -277 +277 @@
         }
 
-        /**
+    /*
+     * Default, we suppose that image is load in a Byte Array (using function createImagePart) so isLoad is true.
+     * If we use createImagePartFromFilePath, then isLoad is false
+     */
+    static boolean isLoad = true;
+
+        /**
+     * Create an image part from the provided filePath image, attach it to the source part
+     * (eg the main document part, a header part etc), and return it.
+     * 
+     * Works for both docx and pptx.
+     * 
+     * @param opcPackage
+     * @param sourcePart
+     * @param filePath
+     * @return
+     * @throws Exception
+     */
+    public static BinaryPartAbstractImage createImagePartFromFilePath(
+            OpcPackage opcPackage,
+            Part sourcePart, String filePath) throws Exception {
+
+        final File locFile = new File(filePath);
+        final byte[] locByte = new byte[1];
+        //We are in the case that image is not load (no byte Array) so isLoad is false
+        isLoad = false;
+        //Here, filePath doesn't represent the tmpFile but the path of the image to load
+        ImageInfo info = ensureFormatIsSupported(filePath, locFile, locByte);
+
+        ContentTypeManager ctm = opcPackage.getContentTypeManager();
+
+        // Ensure the relationships part exists
+        if (sourcePart.getRelationshipsPart() == null) {
+            RelationshipsPart.createRelationshipsPartForPart(sourcePart);
+        }
+
+        String proposedRelId = sourcePart.getRelationshipsPart().getNextId();
+
+        String ext = info.getMimeType().substring(info.getMimeType().indexOf("/") + 1);
+
+        BinaryPartAbstractImage imagePart =
+                (BinaryPartAbstractImage) ctm.newPartForContentType(
+                info.getMimeType(),
+                createImageName(opcPackage, sourcePart, proposedRelId, ext), null);
+
+        log.debug("created part " + imagePart.getClass().getName()
+                + " with name " + imagePart.getPartName().toString());
+
+        FileInputStream fis = new FileInputStream(locFile);
+        imagePart.setBinaryData(fis);
+
+        imagePart.rel = sourcePart.addTargetPart(imagePart, proposedRelId);
+
+        imagePart.setImageInfo(info);
+
+        return imagePart;
+
+    }
+
+    /**
          * @param bytes
          * @param imageFile
@@ -306 +365 @@
                                 // (To use an image natively, we do need a preloader)
                                 imagePreloaderFound = false;
-                                log.warn(e.getMessage() );
+                log.warn(e.getMessage());
                         }
                         
-                        if ( imagePreloaderFound &&
-                                        (info.getMimeType().equals(ContentTypes.IMAGE_TIFF)
+            if (imagePreloaderFound
+                    && (info.getMimeType().equals(ContentTypes.IMAGE_TIFF)
                                         || info.getMimeType().equals(ContentTypes.IMAGE_EMF2) // ImageInfo 
                                         || info.getMimeType().equals(ContentTypes.IMAGE_WMF) 
@@ -317 +376 @@
                                         || info.getMimeType().equals(ContentTypes.IMAGE_GIF) 
 //                                       || info.getMimeType().equals(ContentTypes.IMAGE_EPS)
-                                        || info.getMimeType().equals(ContentTypes.IMAGE_BMP) 
-                                        )) {
+                    || info.getMimeType().equals(ContentTypes.IMAGE_BMP))) {
                                         // TODO: add other supported formats
                                 
@@ -325 +383 @@
                                 log.debug(".. supported natively by Word");                                     
                                 
-                        } else if ( imageFile!=null && bytes!=null ) {
+            } else if (imageFile != null && bytes != null) {
                                 
                                 // otherwise (eg if its an EPS or PDF), try to convert it
@@ -337 +395 @@
                                 log.debug(".. attempting to convert to PNG");           
                                 
-                                ByteArrayInputStream bais = new ByteArrayInputStream(bytes);                    
-                                fos = new FileOutputStream(imageFile); 
-                                                        
-                                convertToPNG(bais, fos, density);
+                //If image haven't been load (using function createImagePartFromFilePath), we load it
+                if (isLoad == false) {
+
+                    // So first, we create tmpFile      
+                    File tmpImageFile = File.createTempFile("img", ".img");
+                    fos = new FileOutputStream(tmpImageFile);
+
+                    //Now we get the inputStream, which is represented by imageFile in this case
+                    FileInputStream bais = new FileInputStream(imageFile);
+
+                    //We convert
+                    convertToPNG(bais, fos, density);
+
+                    //We don't forget to change locFile because the new image file is the converted image file!!
+                    imageFile = tmpImageFile;
+                    
+                } //Else image has been load in an array (using function cretaImagePart)
+                else {
+                                        ByteArrayInputStream bais = new ByteArrayInputStream(bytes);                    
+                                        fos = new FileOutputStream(imageFile); 
+                                        convertToPNG(bais, fos, density);
+                }
+
                                 fos.close();
                                 fos = null;
@@ -346 +423 @@
                                 // We need to refresh image info 
                                 imageManager.getCache().clearCache();
-                                info = getImageInfo(imageFile.getAbsolutePath() );
+                info = getImageInfo(imageFile.getAbsolutePath());
                                 
                                 // Debug ...
@@ -359 +436 @@
         }
         
-
         /**
          * Create a linked image part, and attach it as a rel of the docx main document part
@@ -387 +463 @@
                         Part sourcePart, String fileurl) throws Exception {
                 
-                ImageInfo info = ensureFormatIsSupported(fileurl, null,null);
+        ImageInfo info = ensureFormatIsSupported(fileurl, null, null);
 
                 ContentTypeManager ctm = opcPackage.getContentTypeManager();
@@ -393 +469 @@
                 // In order to ensure unique part name,
                 // idea is to use the relId, which ought to be unique
-                String ext = info.getMimeType().substring( info.getMimeType().indexOf("/")+1);
+        String ext = info.getMimeType().substring(info.getMimeType().indexOf("/") + 1);
                 
                 BinaryPartAbstractImage imagePart = 
-                        (BinaryPartAbstractImage)ctm.newPartForContentType(
+                (BinaryPartAbstractImage) ctm.newPartForContentType(
                                 info.getMimeType(), 
-                                createImageName(opcPackage, sourcePart, proposedRelId, ext ), null );
+                createImageName(opcPackage, sourcePart, proposedRelId, ext), null);
                                 
                 log.debug("created part " + imagePart.getClass().getName()
@@ -419 +495 @@
         }       
 
-        
         /**
          * Create a <wp:inline> element suitable for this image,
@@ -439 +514 @@
                         int id1, int id2) throws Exception {
                 
-                return createImageInline( filenameHint,  altText, 
-                                 id1,  id2, false);
+        return createImageInline(filenameHint, altText,
+                id1, id2, false);
 
         }
@@ -462 +537 @@
                         int id1, int id2, boolean link) throws Exception {
                                 
-                WordprocessingMLPackage wmlPackage = ((WordprocessingMLPackage)this.getPackage());
+        WordprocessingMLPackage wmlPackage = ((WordprocessingMLPackage) this.getPackage());
                 
                 List<SectionWrapper> sections = wmlPackage.getDocumentModel().getSections();
-                PageDimensions page = sections.get(sections.size()-1).getPageDimensions();
+        PageDimensions page = sections.get(sections.size() - 1).getPageDimensions();
                 
                 CxCy cxcy = CxCy.scale(imageInfo, page);
  
-                return createImageInline( filenameHint,  altText, 
-                                 id1,  id2,  cxcy.getCx(),  cxcy.getCy(), link );               
-        }
-        
+        return createImageInline(filenameHint, altText,
+                id1, id2, cxcy.getCx(), cxcy.getCy(), link);
+        }
         
         /**
@@ -492 +566 @@
                         int id1, int id2, long cx) throws Exception {
                 
-                return createImageInline( filenameHint,  altText, 
-                                 id1,  id2, cx, false);
+        return createImageInline(filenameHint, altText,
+                id1, id2, cx, false);
 
         }
@@ -559 +633 @@
                         int id1, int id2, long cx, long cy, boolean link) throws Exception {
                 
-                if (filenameHint==null) {
+        if (filenameHint == null) {
                         filenameHint = "";
                 }
-                if (altText==null) {
+        if (altText == null) {
                         altText = "";
                 }
@@ -576 +650 @@
 //              "<w:p ><w:r>" +
 //        "<w:drawing>" +
-        "<wp:inline distT=\"0\" distB=\"0\" distL=\"0\" distR=\"0\"" + namespaces + ">" +
-        "<wp:extent cx=\"${cx}\" cy=\"${cy}\"/>" +
-        "<wp:effectExtent l=\"0\" t=\"0\" r=\"0\" b=\"0\"/>" +  //l=\"19050\"
-        "<wp:docPr id=\"${id1}\" name=\"${filenameHint}\" descr=\"${altText}\"/><wp:cNvGraphicFramePr><a:graphicFrameLocks xmlns:a=\"http://schemas.openxmlformats.org/drawingml/2006/main\" noChangeAspect=\"1\"/></wp:cNvGraphicFramePr><a:graphic xmlns:a=\"http://schemas.openxmlformats.org/drawingml/2006/main\">" +
-        "<a:graphicData uri=\"http://schemas.openxmlformats.org/drawingml/2006/picture\">" +
-        "<pic:pic xmlns:pic=\"http://schemas.openxmlformats.org/drawingml/2006/picture\"><pic:nvPicPr><pic:cNvPr id=\"${id2}\" name=\"${filenameHint}\"/><pic:cNvPicPr/></pic:nvPicPr><pic:blipFill>" +
-        "<a:blip " + type +"=\"${rEmbedId}\"/><a:stretch><a:fillRect/></a:stretch></pic:blipFill>" +
-        "<pic:spPr><a:xfrm><a:off x=\"0\" y=\"0\"/><a:ext cx=\"${cx}\" cy=\"${cy}\"/></a:xfrm><a:prstGeom prst=\"rect\"><a:avLst/></a:prstGeom></pic:spPr></pic:pic></a:graphicData></a:graphic>" +
-        "</wp:inline>"; // +
+                "<wp:inline distT=\"0\" distB=\"0\" distL=\"0\" distR=\"0\"" + namespaces + ">"
+                + "<wp:extent cx=\"${cx}\" cy=\"${cy}\"/>"
+                + "<wp:effectExtent l=\"0\" t=\"0\" r=\"0\" b=\"0\"/>" + //l=\"19050\"
+                "<wp:docPr id=\"${id1}\" name=\"${filenameHint}\" descr=\"${altText}\"/><wp:cNvGraphicFramePr><a:graphicFrameLocks xmlns:a=\"http://schemas.openxmlformats.org/drawingml/2006/main\" noChangeAspect=\"1\"/></wp:cNvGraphicFramePr><a:graphic xmlns:a=\"http://schemas.openxmlformats.org/drawingml/2006/main\">"
+                + "<a:graphicData uri=\"http://schemas.openxmlformats.org/drawingml/2006/picture\">"
+                + "<pic:pic xmlns:pic=\"http://schemas.openxmlformats.org/drawingml/2006/picture\"><pic:nvPicPr><pic:cNvPr id=\"${id2}\" name=\"${filenameHint}\"/><pic:cNvPicPr/></pic:nvPicPr><pic:blipFill>"
+                + "<a:blip " + type + "=\"${rEmbedId}\"/><a:stretch><a:fillRect/></a:stretch></pic:blipFill>"
+                + "<pic:spPr><a:xfrm><a:off x=\"0\" y=\"0\"/><a:ext cx=\"${cx}\" cy=\"${cy}\"/></a:xfrm><a:prstGeom prst=\"rect\"><a:avLst/></a:prstGeom></pic:spPr></pic:pic></a:graphicData></a:graphic>"
+                + "</wp:inline>"; // +
 //        "</w:drawing>" +
 //        "</w:r></w:p>";
-        java.util.HashMap<String, String>mappings = new java.util.HashMap<String, String>();
+        java.util.HashMap<String, String> mappings = new java.util.HashMap<String, String>();
         
         mappings.put("cx", Long.toString(cx));
@@ -593 +667 @@
         mappings.put("filenameHint", filenameHint);
         mappings.put("altText", altText);
-        mappings.put("rEmbedId", rel.getId()  );
+        mappings.put("rEmbedId", rel.getId());
         mappings.put("id1", Integer.toString(id1));
         mappings.put("id2", Integer.toString(id2));
 
-        Object o = org.docx4j.XmlUtils.unmarshallFromTemplate(ml, mappings ) ;        
-        Inline inline = (Inline)((JAXBElement)o).getValue();
+        Object o = org.docx4j.XmlUtils.unmarshallFromTemplate(ml, mappings);
+        Inline inline = (Inline) ((JAXBElement) o).getValue();
         
                 return inline;          
         }
-        
-        final static String namespaces = " xmlns:w=\"http://schemas.openxmlformats.org/wordprocessingml/2006/main\" " +
-                        "xmlns:r=\"http://schemas.openxmlformats.org/officeDocument/2006/relationships\" " +
-                        "xmlns:wp=\"http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing\"";
-        
+    final static String namespaces = " xmlns:w=\"http://schemas.openxmlformats.org/wordprocessingml/2006/main\" "
+            + "xmlns:r=\"http://schemas.openxmlformats.org/officeDocument/2006/relationships\" "
+            + "xmlns:wp=\"http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing\"";
         
         public static ImageInfo getImageInfo(String uri) throws Exception {
@@ -662 +734 @@
         }
         
-        
-        public static void displayImageInfo(ImageInfo info ) {
-                
+    public static void displayImageInfo(ImageInfo info) {
+        
                   ImageSize size = info.getSize();
                   
@@ -671 +742 @@
 
                   log.debug(info.getOriginalURI() + " " + info.getMimeType() 
-                                  + " " + Math.round(dPx.getWidth()) +"x" + Math.round(dPx.getHeight()));
+                + " " + Math.round(dPx.getWidth()) + "x" + Math.round(dPx.getHeight()));
                                   
-                  log.debug("Resolution:" + Math.round(size.getDpiHorizontal()) + "x" + Math.round(size.getDpiVertical()) );
-                  log.debug("Print size: " + Math.round(dPt.getWidth()/72) + "\" x" + Math.round(dPt.getHeight()/72)+"\"" ); 
+        log.debug("Resolution:" + Math.round(size.getDpiHorizontal()) + "x" + Math.round(size.getDpiVertical()));
+        log.debug("Print size: " + Math.round(dPt.getWidth() / 72) + "\" x" + Math.round(dPt.getHeight() / 72) + "\"");
                 
         }
@@ -720 +791 @@
                                 return bytes;
                         } else {                                
-                                log.error("Part was a " + part.getClass().getName() );
+                log.error("Part was a " + part.getClass().getName());
                         }
                 } else {
@@ -732 +803 @@
                 
                 long cx;
+
                 /**
                  * @return the resulting cx
@@ -738 +810 @@
                         return cx;
                 }
-
                 long cy;
+
                 /**
                  * @return the resulting cy
@@ -747 +819 @@
                 }
                 boolean scaled;
+
                 /**
                  * @return whether it was necessary to scale
@@ -777 +850 @@
                         long cy;
                         boolean scaled = false;
-                        if (imageWidthTwips>writableWidthTwips) {
+            if (imageWidthTwips > writableWidthTwips) {
                                 
                                 log.debug("Scaling image to fit page width");
@@ -783 +856 @@
                                 
                                 cx = UnitsOfMeasurement.twipToEMU(writableWidthTwips);
-                                cy = UnitsOfMeasurement.twipToEMU(dPt.getHeight() * 20 * writableWidthTwips/imageWidthTwips);
+                cy = UnitsOfMeasurement.twipToEMU(dPt.getHeight() * 20 * writableWidthTwips / imageWidthTwips);
                                 
                         } else {
@@ -800 +873 @@
                         
                 }
-                
         }
 
@@ -814 +886 @@
          * @throws InterruptedException
          */
-        public static void convertToPNG(InputStream is, OutputStream os, int density) throws IOException, InterruptedException{
+    public static void convertToPNG(InputStream is, OutputStream os, int density) throws IOException, InterruptedException {
                 
         /*
@@ -863 +935 @@
          }
          
-         if (p.waitFor()!=0) {
+        if (p.waitFor() != 0) {
           log.error("Error");
          }
@@ -873 +945 @@
             while (true) {
              int bytesRead = is.read(buffer);
-             if ( bytesRead == -1 ) break;
+            if (bytesRead == -1) {
+                break;
+            }
              os.write(buffer, 0, bytesRead);
             }
@@ -880 +954 @@
         }//class
 
-
-        class StreamGobbler extends Thread
-        {
+class StreamGobbler extends Thread {
                 // The term "StreamGobbler" was taken from an article called "When Runtime.exec() won't", 
                 // see http://www.javaworld.com/javaworld/jw-12-2000/jw-1229-traps.html.
@@ -889 +961 @@
           OutputStream os;
 
-
-          StreamGobbler(InputStream is, OutputStream redirect)
-          {
-              this.is =  new BufferedInputStream(is);
+    StreamGobbler(InputStream is, OutputStream redirect) {
+        this.is = new BufferedInputStream(is);
               this.os = redirect;
           }
 
-          public void run()
-          {
-              try
-              {  
+    public void run() {
+        try {
                   BinaryPartAbstractImage.copy2(is, os);
-              } catch (IOException ioe)
-                  {
+        } catch (IOException ioe) {
                   ioe.printStackTrace();
                   }
           }
-          
-        }
-                
+        }