From c63f86cf663817345f810f2d8de5f73a97a42f92 Mon Sep 17 00:00:00 2001 From: Nick Burch Date: Fri, 25 Nov 2011 21:56:19 +0000 Subject: [PATCH] Start on a new method for POIFS EntryUtils for checking to see if the two Directories have the same contents, plus stub out some tests for EntryUtils (to follow) git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1206355 13f79535-47bb-0310-9956-ffa450edef68 --- .../poi/poifs/filesystem/EntryUtils.java | 117 ++++++++++++++++++ .../poi/poifs/filesystem/TestEntryUtils.java | 38 ++++++ 2 files changed, 155 insertions(+) create mode 100644 src/testcases/org/apache/poi/poifs/filesystem/TestEntryUtils.java diff --git a/src/java/org/apache/poi/poifs/filesystem/EntryUtils.java b/src/java/org/apache/poi/poifs/filesystem/EntryUtils.java index deb30dae34..c3c5145d0c 100644 --- a/src/java/org/apache/poi/poifs/filesystem/EntryUtils.java +++ b/src/java/org/apache/poi/poifs/filesystem/EntryUtils.java @@ -16,9 +16,12 @@ ==================================================================== */ package org.apache.poi.poifs.filesystem; +import java.io.FileNotFoundException; import java.io.IOException; +import java.util.HashMap; import java.util.Iterator; import java.util.List; +import java.util.Map; import org.apache.poi.util.Internal; @@ -96,4 +99,118 @@ public class EntryUtils // System.err.println("CopyNodes called"); copyNodes( source.getRoot(), target.getRoot(), excepts ); } + + /** + * Checks to see if the two Directories hold the same contents. + * For this to be true, they must have entries with the same names, + * no entries in one but not the other, and the size+contents + * of each entry must match. + * TODO Some sort of excepts support + */ + public static boolean areDirectoriesIdentical(DirectoryNode dirA, DirectoryNode dirB) { + // First up, check they have the same number of children + if (dirA.getEntryCount() != dirB.getEntryCount()) { + return false; + } + + // Next, check entries and their types/sizes + Map aSizes = new HashMap(); + final int isDirectory = -12345; + for (Entry a : dirA) { + String aName = a.getName(); + if (a.isDirectoryEntry()) { + aSizes.put(aName, isDirectory); + } else { + aSizes.put(aName, ((DocumentNode)a).getSize()); + } + } + for (Entry b : dirB) { + String bName = b.getName(); + if (! aSizes.containsKey(bName)) { + // In B but not A + return false; + } + + int size; + if (b.isDirectoryEntry()) { + size = isDirectory; + } else { + size = ((DocumentNode)b).getSize(); + } + if (size != aSizes.get(bName)) { + // Either the wrong type, or they're different sizes + return false; + } + + // Track it as checked + aSizes.remove(bName); + } + if (!aSizes.isEmpty()) { + // Nodes were in A but not B + return false; + } + + // If that passed, check entry contents + for (Entry a : dirA) { + try { + Entry b = dirB.getEntry(a.getName()); + boolean match; + if (a.isDirectoryEntry()) { + match = areDirectoriesIdentical( + (DirectoryNode)a, (DirectoryNode)b); + } else { + match = areDocumentsIdentical( + (DocumentNode)a, (DocumentNode)b); + } + if (!match) return false; + } catch(FileNotFoundException e) { + // Shouldn't really happen... + return false; + } catch(IOException e) { + // Something's messed up with one document, not a match + return false; + } + } + + // If we get here, they match! + return true; + } + + /** + * Checks to see if two Documents have the same name + * and the same contents. (Their parent directories are + * not checked) + */ + public static boolean areDocumentsIdentical(DocumentNode docA, DocumentNode docB) throws IOException { + if (! docA.getName().equals(docB.getName())) { + // Names don't match, not the same + return false; + } + if (docA.getSize() != docB.getSize()) { + // Wrong sizes, can't have the same contents + return false; + } + + boolean matches = true; + DocumentInputStream inpA = null, inpB = null; + try { + inpA = new DocumentInputStream(docA); + inpB = new DocumentInputStream(docB); + + int readA, readB; + do { + readA = inpA.read(); + readB = inpB.read(); + if (readA != readB) { + matches = false; + break; + } + } while(readA != -1 && readB != -1); + } finally { + if (inpA != null) inpA.close(); + if (inpB != null) inpB.close(); + } + + return matches; + } } diff --git a/src/testcases/org/apache/poi/poifs/filesystem/TestEntryUtils.java b/src/testcases/org/apache/poi/poifs/filesystem/TestEntryUtils.java new file mode 100644 index 0000000000..17b16babe2 --- /dev/null +++ b/src/testcases/org/apache/poi/poifs/filesystem/TestEntryUtils.java @@ -0,0 +1,38 @@ +/* ==================================================================== + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You 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. +==================================================================== */ + +package org.apache.poi.poifs.filesystem; + +import junit.framework.TestCase; + +import org.apache.poi.POIDataSamples; + +public class TestEntryUtils extends TestCase { + private static final POIDataSamples dataSamples = POIDataSamples.getPOIFSInstance(); + + public void testCopyRecursively() throws Exception { + // TODO + } + + public void testAreDocumentsIdentical() throws Exception { + // TODO + } + + public void testAreDirectoriesIdentical() throws Exception { + // TODO + } +} -- 2.39.5