1    
2    /* ====================================================================
3     * The Apache Software License, Version 1.1
4     *
5     * Copyright (c) 2002 The Apache Software Foundation.  All rights
6     * reserved.
7     *
8     * Redistribution and use in source and binary forms, with or without
9     * modification, are permitted provided that the following conditions
10    * are met:
11    *
12    * 1. Redistributions of source code must retain the above copyright
13    *    notice, this list of conditions and the following disclaimer.
14    *
15    * 2. Redistributions in binary form must reproduce the above copyright
16    *    notice, this list of conditions and the following disclaimer in
17    *    the documentation and/or other materials provided with the
18    *    distribution.
19    *
20    * 3. The end-user documentation included with the redistribution,
21    *    if any, must include the following acknowledgment:
22    *       "This product includes software developed by the
23    *        Apache Software Foundation (http://www.apache.org/)."
24    *    Alternately, this acknowledgment may appear in the software itself,
25    *    if and wherever such third-party acknowledgments normally appear.
26    *
27    * 4. The names "Apache" and "Apache Software Foundation" and
28    *    "Apache POI" must not be used to endorse or promote products
29    *    derived from this software without prior written permission. For
30    *    written permission, please contact apache@apache.org.
31    *
32    * 5. Products derived from this software may not be called "Apache",
33    *    "Apache POI", nor may "Apache" appear in their name, without
34    *    prior written permission of the Apache Software Foundation.
35    *
36    * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37    * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38    * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39    * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40    * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41    * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42    * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43    * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44    * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45    * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46    * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47    * SUCH DAMAGE.
48    * ====================================================================
49    *
50    * This software consists of voluntary contributions made by many
51    * individuals on behalf of the Apache Software Foundation.  For more
52    * information on the Apache Software Foundation, please see
53    * <http://www.apache.org/>.
54    */
55   
56   /*
57    * FormulaViewer.java - finds formulas in a BIFF8 file and attempts to parse them and
58    * display info about them.
59    *
60    * Created on November 18, 2001, 7:58 AM
61    */
62   package org.apache.poi.hssf.dev;
63   
64   import java.io.InputStream;
65   import java.io.IOException;
66   import java.io.ByteArrayInputStream;
67   import java.io.FileInputStream;
68   import java.io.FileOutputStream;
69   
70   //import java.io.*;
71   import java.util.List;
72   
73   import org.apache.poi.poifs.filesystem.POIFSFileSystem;
74   import org.apache.poi.util.LittleEndian;
75   import org.apache.poi.util.HexDump;
76   import org.apache.poi.hssf.record.*;
77   import org.apache.poi.hssf.record.formula.*;
78   import org.apache.poi.hssf.model.*;
79   import org.apache.poi.hssf.usermodel.*;
80   
81   /**
82    * FormulaViewer - finds formulas in a BIFF8 file and attempts to read them/display
83    * data from them. Only works if Formulas are enabled in "RecordFactory"
84    * @author  andy
85    * @author Avik
86    */
87   
88   public class FormulaViewer
89   {
90       private String file;
91   
92       /** Creates new FormulaViewer */
93   
94       public FormulaViewer()
95       {
96       }
97   
98       /**
99        * Method run
100       *
101       *
102       * @exception Exception
103       *
104       */
105  
106      public void run()
107          throws Exception
108      {
109          POIFSFileSystem fs      =
110              new POIFSFileSystem(new FileInputStream(file));
111          List            records =
112              RecordFactory
113                  .createRecords(fs.createDocumentInputStream("Workbook"));
114  
115          for (int k = 0; k < records.size(); k++)
116          {
117              Record record = ( Record ) records.get(k);
118  
119              if (record.getSid() == FormulaRecord.sid)
120              {
121                  parseFormulaRecord(( FormulaRecord ) record);
122              }
123          }
124      }
125  
126      /**
127       * Method parseFormulaRecord
128       *
129       *
130       * @param record
131       *
132       */
133  
134      public void parseFormulaRecord(FormulaRecord record)
135      {
136          System.out.println("==============================");
137          System.out.print("row = " + record.getRow());
138          System.out.println(", col = " + record.getColumn());
139          System.out.println("value = " + record.getValue());
140          System.out.print("xf = " + record.getXFIndex());
141          System.out.print(", number of ptgs = "
142                             + record.getNumberOfExpressionTokens());
143          System.out.println(", options = " + record.getOptions());
144          System.out.println("RPN List = "+formulaString(record));
145          System.out.println("Formula text = "+ composeForumla(record));
146      }
147  
148      private String formulaString(FormulaRecord record) {
149          StringBuffer formula = new StringBuffer("=");
150          int          numptgs = record.getNumberOfExpressionTokens();
151          List         tokens    = record.getParsedExpression();
152          StringBuffer buf = new StringBuffer();
153             for (int i=0;i<numptgs;i++) {
154              buf.append( ( (Ptg)tokens.get(i)).toFormulaString());
155              buf.append(' ');
156          } 
157          return buf.toString();
158      }
159      
160      
161      private String composeForumla(FormulaRecord record)
162      {
163         return  FormulaParser.toFormulaString(record.getParsedExpression());
164      }
165  
166      /**
167       * Method setFile
168       *
169       *
170       * @param file
171       *
172       */
173  
174      public void setFile(String file)
175      {
176          this.file = file;
177      }
178  
179      /**
180       * Method main
181       *
182       * pass me a filename and I'll try and parse the formulas from it
183       *
184       * @param args pass one argument with the filename or --help
185       *
186       */
187  
188      public static void main(String args[])
189      {
190          if ((args == null) || (args.length != 1)
191                  || args[ 0 ].equals("--help"))
192          {
193              System.out.println(
194                  "FormulaViewer .8 proof that the devil lies in the details (or just in BIFF8 files in general)");
195              System.out.println("usage: Give me a big fat file name");
196          }
197          else
198          {
199              try
200              {
201                  FormulaViewer viewer = new FormulaViewer();
202  
203                  viewer.setFile(args[ 0 ]);
204                  viewer.run();
205              }
206              catch (Exception e)
207              {
208                  System.out.println("Whoops!");
209                  e.printStackTrace();
210              }
211          }
212      }
213  }
214  ??????????????????createRecords????????????????????????????????fs???????????????????????????????????createDocumentInputStream?????????????????????????k?????????????????????????????records?????????????????????????????????????????????k?????????????Record???????????????????????????????Record????????????????????????????????????????records????????????????????????????????????????????????????k?????????????????record????????????????????????getSid????????????????????????????????????FormulaRecord??????????????????????????????????????????????????sid?????????????????parseFormulaRecord??????????????????????????????????????FormulaRecord??????????????????????????????????????????????????????record????????????????????????????????????????????????????????????????????????????????????????????????????????????parseFormulaRecord????????????????????????????????????FormulaRecord?????????????????????????????????????record?????????????????????????????????????????record?????????????????????????????????????????record????????????????????????????????????record??????????????????????????????record?????????????????????????????????????????????record??????????????????????????????????????????formulaString????????????????????????????????????????????????????????record???????????????????????????????????????????????composeForumla??????????????????????????????????????????????????????????????record????????????????????formulaString??????????????????????????????????FormulaRecord????????????????????????????????record??????????????????????????????????record?????????????????????????i???????????????????????????numptgs???????????????????????????????????i?????????????buf????????????????????????????Ptg????????????????????????????????tokens???????????????????????????????????????????i?????????????buf????????????????buf????????????????????composeForumla???????????????????????????????????FormulaRecord????????????????FormulaParser??????????????????????????????toFormulaString??????????????????????????????????????????????record???????????????????????????????????????????????????????????????????????????????????????????????setFile?????????????????????file???????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????main??????????????args????????????????????????????????args????????????????????args?????????????????FormulaViewer????????????????????????????????????????????FormulaViewer?????????????????viewer????????????????????????setFile????????????????????????????????args?????????????????viewer????????????????????????run?????????????????e