added some handy Tools methods for handling VCards and also impl support

for adding own VCard to imported archives [see #110]

Author: FreakyBytes

src/main/java/de/unirostock/sems/cbarchive/web/Tools.java

@@ -26,6 +26,7 @@
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;
 import java.text.SimpleDateFormat;
+import java.util.Collection;
 import java.util.Date;
 
 import javax.servlet.http.Cookie;
@@ -39,6 +40,11 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 
 import de.binfalse.bflog.LOGGER;
+import de.unirostock.sems.cbarchive.meta.MetaDataHolder;
+import de.unirostock.sems.cbarchive.meta.MetaDataObject;
+import de.unirostock.sems.cbarchive.meta.OmexMetaDataObject;
+import de.unirostock.sems.cbarchive.meta.omex.OmexDescription;
+import de.unirostock.sems.cbarchive.meta.omex.VCard;
 import de.unirostock.sems.cbarchive.web.dataholder.UserData;
 import de.unirostock.sems.cbarchive.web.exception.CombineArchiveWebCriticalException;
 import de.unirostock.sems.cbarchive.web.exception.CombineArchiveWebException;
@@ -277,4 +283,86 @@ public static boolean isFilenameBlacklisted( String filename ) {
 
 		return false;
 	}
+	
+	/**
+	 * Adds current date as modification and adds the creator if not done yet, to every Omex description
+	 * Also creates new Omex description, if create is set to true and only if necessary
+	 * 
+	 * @param entity
+	 * @param creator
+	 * @param create
+	 */
+	public static void addOmexMetaData(MetaDataHolder entity, VCard creator, boolean create) {
+		
+		int added = 0;
+		// save some checks
+		if( creator != null && creator.isEmpty() )
+			creator = null;
+		
+		// add modified date and own VCard to all omex descriptions for the root element
+		for( MetaDataObject metaObject : entity.getDescriptions() ) {
+			if( metaObject instanceof OmexMetaDataObject ) {
+				OmexDescription meta = ((OmexMetaDataObject) metaObject).getOmexDescription();
+				
+				meta.getModified().add( new Date() );
+				if( creator != null && !containsVCard(meta.getCreators(), creator) )
+					// creator is set and not in Omex right now
+					meta.getCreators().add(creator);
+				added++;
+			}
+		}
+		
+		if( added == 0 && create == true ) {
+			// meta was added to non entry -> create
+			OmexDescription meta = new OmexDescription();
+			meta.getModified().add( meta.getCreated() );
+			if( creator != null )
+				meta.getCreators().add( creator );
+			
+			// attach to entity
+			entity.addDescription( new OmexMetaDataObject(meta) );
+		}
+		
+	}
+	
+	/**
+	 * Checks if the given VCard exists already in the Collection
+	 * 
+	 * @param collection
+	 * @param vcard
+	 * @return
+	 */
+	public static boolean containsVCard( Collection<VCard> collection, VCard vcard ) {
+		
+		if( collection == null )
+			return vcard == null;
+		else if( vcard == null )
+			return false;
+			
+		for( VCard current : collection )
+			if( areVCardEqual(current, vcard) )
+				return true;
+		
+		return false;
+	}
+	
+	/**
+	 * Compares 2 VCards and returns true if both are identical in means of String.equal() or if both are null
+	 * 
+	 * @param vcard1
+	 * @param vcard2
+	 * @return
+	 */
+	public static boolean areVCardEqual( VCard vcard1, VCard vcard2 ) {
+		
+		if( vcard1 == vcard2 || (vcard1 == null && vcard2 == null) )
+			return true;
+		else if( vcard1 == null || vcard2 == null )
+			return false;
+		return	(vcard1.getGivenName() == null ? vcard2.getGivenName() == null : vcard1.getGivenName().equals( vcard2.getGivenName() )) &&
+				(vcard1.getFamilyName() == null ? vcard2.getFamilyName() == null : vcard1.getFamilyName().equals( vcard2.getFamilyName() )) &&
+				(vcard1.getEmail() == null ? vcard2.getEmail() == null : vcard1.getEmail().equals( vcard2.getEmail() )) &&
+				(vcard1.getOrganization() == null ? vcard2.getOrganization() == null : vcard1.getOrganization().equals( vcard2.getOrganization() ));
+	}
+
 }

src/main/java/de/unirostock/sems/cbarchive/web/UserManager.java

@@ -41,7 +41,6 @@
 import de.unirostock.sems.cbarchive.ArchiveEntry;
 import de.unirostock.sems.cbarchive.CombineArchive;
 import de.unirostock.sems.cbarchive.CombineArchiveException;
-import de.unirostock.sems.cbarchive.meta.MetaDataObject;
 import de.unirostock.sems.cbarchive.meta.OmexMetaDataObject;
 import de.unirostock.sems.cbarchive.meta.omex.OmexDescription;
 import de.unirostock.sems.cbarchive.meta.omex.VCard;
@@ -253,6 +252,12 @@ private String createArchive( String name, File existingArchive, VCard creator )
 			// an archive already exists
 			// check if combineArchive is valid
 			CombineArchive combineArchive = new CombineArchive( existingArchive );
+			
+			// adds the creator and the current date, if provided and archive is valid
+			if( combineArchive != null && creator != null && !creator.isEmpty() ) {
+				// add modified date and own VCard to all omex descriptions for the root element
+				Tools.addOmexMetaData(combineArchive, creator, true);
+			}
 			combineArchive.close();
 
 			// copy files
@@ -407,10 +412,8 @@ else if( strategy == ReplaceStrategy.RENAME ) {
 			}
 
 			// add modified date to all omex descriptions for the root element
-			for( MetaDataObject metaObject : combineArchive.getDescriptions() ) {
-				if( metaObject instanceof OmexMetaDataObject )
-					((OmexMetaDataObject) metaObject).getOmexDescription().getModified().add( new Date() );
-			}
+			Tools.addOmexMetaData(combineArchive, null, false);
+			
 		}
 
 		// format changed

src/main/java/de/unirostock/sems/cbarchive/web/dataholder/UserData.java

@@ -32,6 +32,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 import de.unirostock.sems.cbarchive.meta.omex.VCard;
+import de.unirostock.sems.cbarchive.web.Tools;
 
 @XmlAccessorType(XmlAccessType.FIELD)
 public class UserData {
@@ -102,14 +103,8 @@ public VCard getVCard() {
 	 */
 	@JsonIgnore
 	public boolean isContained( List<VCard> list ) {
-
-		for( VCard user : list ) {
-			if( user.getFamilyName().equals(familyName) && user.getGivenName().equals(givenName)
-					&& user.getEmail().equals(email) && user.getOrganization().equals(organization) )
-				return true;
-		}
 
-		return false;
+		return Tools.containsVCard(list, getVCard());
 	}
 
 	@JsonIgnore

src/main/java/de/unirostock/sems/cbarchive/web/rest/RestApi.java

@@ -825,7 +825,6 @@ public Response updateArchiveEntry( @PathParam("archive_id") String archiveId, @
 		}
 
 		try {
-			// TODO parse option filed
 			user.updateArchiveEntry(archiveId, newEntry);
 
 			Archive archive = user.getArchive(archiveId);
@@ -844,6 +843,7 @@ public Response updateArchiveEntry( @PathParam("archive_id") String archiveId, @
 		}
 	}
 
+	@SuppressWarnings("resource")
 	@POST
 	@Path( "/archives/{archive_id}/entries" )
 	@Produces( MediaType.APPLICATION_JSON )