Changeset 8792

Timestamp:

03/10/10 20:51:09 (6 months ago)

Author:

meddle

Message:

#2352 : Working persistence on embedded books

Location:

branches/private/meddle/linkable/modules

Files:

• org.sophie2.base.model.book/src/main/java/org/sophie2/base/model/book/interfaces/ResourceFrame.java (modified) (2 diffs)
• org.sophie2.base.model.book/src/main/java/org/sophie2/base/model/book/resource/ResourceDataPersistType.java (modified) (2 diffs)
• org.sophie2.base.model.book/src/main/java/org/sophie2/base/model/book/resource/ResourceFilesUtil.java (modified) (9 diffs)
• org.sophie2.base.model.book/src/test/java/org/sophie2/base/model/book/resource/r4/ResourceFilesUtilTest.java (modified) (2 diffs)
• org.sophie2.base.model.resources.r4/src/main/java/org/sophie2/base/model/resources/r4/file/FileAccessUtil.java (modified) (1 diff)
• org.sophie2.base.persistence/src/main/java/org/sophie2/base/persistence/commons/PersistenceUtil.java (modified) (1 diff)
• org.sophie2.extra.func.annotations/src/main/java/org/sophie2/extra/func/annotations/logic/AnnotationsLogic.java (modified) (1 diff)
• org.sophie2.main.func.resources/src/main/java/org/sophie2/main/func/resources/imports/ResourceImportInfo.java (modified) (1 diff)

branches/private/meddle/linkable/modules/org.sophie2.base.model.book/src/main/java/org/sophie2/base/model/book/interfaces/ResourceFrame.java

@@ -1 +1 @@
 package org.sophie2.base.model.book.interfaces;
 
+import java.io.File;
 import java.io.IOException;
 
+import org.sophie2.base.model.book.resource.ResourceDataPersistType;
+import org.sophie2.base.model.book.resource.ResourceFilesUtil;
+import org.sophie2.base.model.resources.r4.LocationPrefix;
 import org.sophie2.base.model.resources.r4.ResourceRefR4;
 import org.sophie2.base.model.resources.r4.keys.DeeplyCopied;
 import org.sophie2.base.model.resources.r4.keys.TemplatedResourceRefKey;
 import org.sophie2.base.persistence.commons.PersistenceOptions;
+import org.sophie2.base.persistence.commons.PersistenceUtil;
 import org.sophie2.base.persistence.ref.ValueRef;
 import org.sophie2.base.persistence.storage.Storage;
@@ -33 +38 @@
                                 res = destination.getChild("content");
                         }
+                        
+                        String parentLocation = options.get(PersistenceUtil.LOCATION);
+                        
+                        if (options.isSaveMode()) {
+                                ResourceRefR4 original = ref.get();
+                                
+                                ResourceDataPersistType type = 
+                                        ResourceDataPersistType.getPersistType(original, parentLocation);
+                                if (type == ResourceDataPersistType.LINKED_RELATIVE) {
+                                        ref.set(ResourceFilesUtil.getSaveableRef(parentLocation, ref.get()));
+                                        ResourceFilesUtil.saveLoadableResource(parentLocation,
+                                                        ref.get().getLocation(), 
+                                                        new File(original.getLocation().substring(LocationPrefix.FILE.length())));
+                                } 
+                                
+                        }
+                        
                         super.persistR3(ref, res, options, format);
+                        
+                        if (options.isLoadMode()) {
+                                ResourceDataPersistType type = 
+                                        ResourceDataPersistType.getPersistType(ref.get(), parentLocation);
+                                if (type == ResourceDataPersistType.LINKED_RELATIVE) {
+                                        ref.set(ResourceFilesUtil.getLoadableRef(parentLocation, ref.get()));
+                                }
+                        }
                 }
         };

branches/private/meddle/linkable/modules/org.sophie2.base.model.book/src/main/java/org/sophie2/base/model/book/resource/ResourceDataPersistType.java

@@ -87 +87 @@
                 
                 if (ref.isRelative()) {
+                        if (ref.getLocation().contains(ResourceFilesUtil.SAVEABLE_TEMPLATE)) {
+                                return LINKED_RELATIVE;
+                        }
+                        
                         return EMBEDDED;
                 }
@@ -92 +96 @@
                 if (ref.isAbsolute()) {
                         if (parentLocation != null) {
-                                if (ResourceFilesUtil.isRelativeToParent(ref, parentLocation)) {
+                                if (ResourceFilesUtil.isRelativeToParent(ref, parentLocation)
+                                                || ref.getLocation().contains(ResourceFilesUtil.FILES_DIRECTORY)) {
                                         return LINKED_RELATIVE;
                                 }

branches/private/meddle/linkable/modules/org.sophie2.base.model.book/src/main/java/org/sophie2/base/model/book/resource/ResourceFilesUtil.java

@@ -31 +31 @@
         public static final String FILES_DIRECTORY = "_files";
 
-        private static final String SAVEABLE_TEMPLATE = "${files_dir}";
+        public static final String SAVEABLE_TEMPLATE = "${files_dir}";
 
         /**
@@ -113 +113 @@
         }
 
+        /**
+         * Checks if the passed {@link ResourceRefR4} points to a resource in the directory,
+         * relative to the passed <var>parentLocation</var>
+         * 
+         * @param ref
+         *                      The ref to check.
+         * @param parentLocation
+         *                      The parent location to check.
+         * @return
+         *                      True if the ref is relative.
+         */
         public static boolean isRelativeToParent(ResourceRefR4 ref, String parentLocation) {
                 File parentDir = ResourceFilesUtil.getDir(parentLocation);
@@ -214 +225 @@
                 return relative.getLocation().replace(dirName, SAVEABLE_TEMPLATE);
         }
+        
+        public static ResourceRefR4 getSaveableRef(String parentPath, ResourceRefR4 ref) {
+                if (parentPath == null) {
+                        return ref;
+                }
+
+                int lastSeparator = parentPath.lastIndexOf(ResourceRefR4.SEPARATOR);
+                String dirName = getDirName(parentPath, lastSeparator); 
+
+                ResourceRefR4 targetRef = ref;
+                if (!targetRef.getLocation().contains(dirName)) {
+                        targetRef = ResourceRefR4.make(new File(getDir(parentPath), ref.getName())); 
+                }
+
+                ResourceRefR4 relative = ResourceRefR4.getRelativeRef(
+                                ResourceRefR4.make(parentPath), targetRef);
+
+
+                return ResourceRefR4.make(
+                                relative.getLocation().replace(dirName, SAVEABLE_TEMPLATE));
+        }
 
         /**
@@ -240 +272 @@
         }
 
+        public static ResourceRefR4 getLoadableRef(String parentPath, ResourceRefR4 loadedRef) {
+                if (parentPath == null || !loadedRef.getLocation().contains(SAVEABLE_TEMPLATE)) {
+                        return loadedRef;
+                }
+
+                ResourceRefR4 absolute = ResourceRefR4.make(
+                                parentPath).append(loadedRef);
+
+                int lastSeparator = parentPath.lastIndexOf(ResourceRefR4.SEPARATOR);
+
+                return ResourceRefR4.make(absolute.getLocation().replace(
+                                SAVEABLE_TEMPLATE, getDirName(parentPath, lastSeparator)));
+        }
+        
         /**
          * Saves a resource file in such a way it can be loaded in the even
@@ -268 +314 @@
                         }
 
-                        copy(original, target);
+                        copy(original, target, false);
                 }
         }
@@ -290 +336 @@
                 assert original != null && target != null;
 
-                copy(original, target);
-        }
-
-
-        private static void copy(File original, File target) {
+                String tmpDir = System.getProperty("java.io.tmpdir");
+                boolean delOnExit = target.getAbsolutePath().startsWith(tmpDir);
+                copy(original, target, delOnExit);
+        }
+
+
+        private static void copy(File original, File target, boolean deleteOnExit) {
                 if (!original.exists()) {
                         return;
@@ -305 +353 @@
 
                         for (File file : original.listFiles()) {
-                                copy(file, new File(target, file.getName()));
+                                copy(file, new File(target, file.getName()), deleteOnExit);
                         }
                 } else {
@@ -317 +365 @@
                         try {
                                 BinData.transport(new FileInputStream(original), new FileOutputStream(target));
+                                if (deleteOnExit) {
+                                        target.deleteOnExit();
+                                }
                         } catch (FileNotFoundException e) {
                                 throw new RuntimeException(e);
@@ -412 +463 @@
         }
 
-        public static void persistRefData(final ValueRef<ResourceRefR4> ref, Storage storage,
-                        final PersistenceOptions options, String format) throws IOException {
-                if (options.isSaveMode() && ref.get() == null) {
-                        return;
-                }
-
-                String parentLocation = options.get(PersistenceUtil.LOCATION);
-
-                ValueRef<ResourceDataPersistType> enumRef = new ValueRef<ResourceDataPersistType>();
-                if (options.isSaveMode()) {
-                        enumRef.set(ResourceDataPersistType.getPersistType(ref.get(), parentLocation));
-                }
-
-                if (options.isLoadMode() && storage.getChild("dataType") == null) {
-                        storage.child("dataType").setTextContent(
-                                        ResourceDataPersistType.getPersistType(ref.get(), parentLocation).name());
-                }
-
-                MasterPersister.persist(enumRef, storage.child("dataType"),
-                                options, PersistenceUtil.getStorageR3Schema(ResourceDataPersistType.class));
-
+        public static boolean isInSaveableFormat(String location) {
+                return location.startsWith(SAVEABLE_TEMPLATE);
         }
 

branches/private/meddle/linkable/modules/org.sophie2.base.model.book/src/test/java/org/sophie2/base/model/book/resource/r4/ResourceFilesUtilTest.java

@@ -79 +79 @@
          * @throws Exception
          */
+        @Test
         public void testIsRelativeToParent() throws Exception {
                 String parentLocation = "file:///home/meddle/stuff.book.s2";
@@ -90 +91 @@
         }
         
+        /**
+         * Tests the {@link ResourceFilesUtil#getSaveableRef(String, ResourceRefR4)}
+         * method.
+         * 
+         * @throws Exception
+         */
+        @Test
+        public void testGetSaveableRef() throws Exception {
+                String parentLocation = "file:///home/meddle/stuff.book.s2";
+                ResourceRefR4 ref = ResourceRefR4.make(new File("/home/meddle/stuff_book_s2_files/stuff.dat"));
+                
+                ResourceRefR4 target = 
+                        ResourceFilesUtil.getSaveableRef(parentLocation, ref);
+                
+                assertEquals(ResourceRefR4.make(
+                                ResourceRefR4.PARENT +
+                                ResourceRefR4.SEPARATOR +
+                                ResourceFilesUtil.SAVEABLE_TEMPLATE +
+                                ResourceRefR4.SEPARATOR +
+                                "stuff.dat"), target);
+        }
+        
+        /**
+         * Tests the {@link ResourceFilesUtil#getLoadableRef(String, ResourceRefR4)}
+         * method.
+         * 
+         * @throws Exception
+         */
+        @Test
+        public void testGetLoadableRef() throws Exception {
+                String parentLocation = "file:///home/meddle/stuff.book.s2";
+                ResourceRefR4 ref = ResourceRefR4.make(ResourceRefR4.PARENT +
+                                ResourceRefR4.SEPARATOR +
+                                ResourceFilesUtil.SAVEABLE_TEMPLATE +
+                                ResourceRefR4.SEPARATOR + "stuff.dat");
+                
+                ResourceRefR4 target = 
+                        ResourceFilesUtil.getLoadableRef(parentLocation, ref);
+                
+                assertEquals(ResourceRefR4.make(
+                                new File("/home/meddle/stuff_book_s2_files/stuff.dat")), target);
+        }
+        
 }

branches/private/meddle/linkable/modules/org.sophie2.base.model.resources.r4/src/main/java/org/sophie2/base/model/resources/r4/file/FileAccessUtil.java

@@ -3 +3 @@
 import java.io.ByteArrayInputStream;
 import java.io.File;
-import java.io.FileNotFoundException;
 import java.io.FileOutputStream;
 import java.io.IOException;

branches/private/meddle/linkable/modules/org.sophie2.base.persistence/src/main/java/org/sophie2/base/persistence/commons/PersistenceUtil.java

@@ -41 +41 @@
                         String.class, null);
 
+        /**
+         * Key that provides the previous location of the persistence.
+         */
+        public static final PersistKey<String> OLD_LOCATION = new PersistKey<String>("old-location",
+                        String.class, null);
+        
         /**
          * Gets the string identifier of the kind for persistence of the given

branches/private/meddle/linkable/modules/org.sophie2.extra.func.annotations/src/main/java/org/sophie2/extra/func/annotations/logic/AnnotationsLogic.java

@@ -151 +151 @@
                         } catch (IOException e) {
                                 DialogUtils.showExceptionDialog(source.swingComponent().get(),
-                                                                                        e, "Couldn`t Export Anotation Set");
+                                                                                        e, "Couldn't Export Anotation Set");
                                 fileAccess.close();
                                 return false;

branches/private/meddle/linkable/modules/org.sophie2.main.func.resources/src/main/java/org/sophie2/main/func/resources/imports/ResourceImportInfo.java

@@ -87 +87 @@
         }
         
+        /**
+         * Getter of the model {@link ResourceImportType}.
+         * 
+         * @return
+         *                      The <var>modelImportType</var>.
+         */
         public ResourceImportType getModelImportType() {
                 return this.modelImportType;
         }
         
+        /**
+         * Returns true if the model is {@link ResourceImportType#LINK}ed
+         * or {@link ResourceImportType#COPY_AND_LINK}ed.
+         * 
+         * @see ResourceImportInfo#getModelImportType()
+         * 
+         * @return
+         *                      True if the model is linked.
+         */
         public boolean isModelLinked() {
                 return this.modelImportType == ResourceImportType.LINK