Story/vspc 208

vspace/src/main/java/edu/asu/diging/vspace/core/model/IExhibition.java

@@ -28,6 +28,18 @@ public interface IExhibition extends IVSpaceElement {
 
     void setAboutPageConfigured(boolean aboutPageConfigured);
 
+    IVSImage getSpaceLinkDefaultImage();
+
+    void setSpaceLinkDefaultImage(IVSImage spaceLinkDefaultImage);
+
+    IVSImage getModuleLinkDefaultImage();
+
+    void setModuleLinkDefaultImage(IVSImage moduleLinkDefaultImage);
+
+    IVSImage getExternalLinkDefaultImage();
+
+    void setExternalLinkDefaultImage(IVSImage externalLinkDefaultImage);
+
     List<IExhibitionLanguage> getLanguages();
 
     ExhibitionModes getMode();

vspace/src/main/java/edu/asu/diging/vspace/core/model/impl/Exhibition.java

@@ -1,10 +1,8 @@
 package edu.asu.diging.vspace.core.model.impl;
 
 import java.util.ArrayList;
-import java.util.HashSet;
 import java.util.List;
 import java.util.Objects;
-import java.util.Set;
 
 import javax.persistence.CascadeType;
 import javax.persistence.Entity;
@@ -14,14 +12,17 @@
 import javax.persistence.Id;
 import javax.persistence.OneToMany;
 import javax.persistence.OneToOne;
+
 import org.hibernate.annotations.GenericGenerator;
+import org.hibernate.annotations.NotFound;
+import org.hibernate.annotations.NotFoundAction;
 import org.hibernate.annotations.Parameter;
+
 import edu.asu.diging.vspace.core.model.ExhibitionModes;
-import edu.asu.diging.vspace.core.model.IContentBlock;
 import edu.asu.diging.vspace.core.model.IExhibition;
 import edu.asu.diging.vspace.core.model.IExhibitionLanguage;
-import edu.asu.diging.vspace.core.model.IExternalLink;
 import edu.asu.diging.vspace.core.model.ISpace;
+import edu.asu.diging.vspace.core.model.IVSImage;
 
 /**
  * Represents an exhibition that can have a default start space.
@@ -47,6 +48,18 @@ public class Exhibition extends VSpaceElement implements IExhibition {
 
     private String customMessage;
 
+    @OneToOne(targetEntity = VSImage.class)
+    @NotFound(action = NotFoundAction.IGNORE)
+    private IVSImage spaceLinkDefaultImage;
+
+    @OneToOne(targetEntity = VSImage.class)
+    @NotFound(action = NotFoundAction.IGNORE)
+    private IVSImage moduleLinkDefaultImage;
+
+    @OneToOne(targetEntity = VSImage.class)
+    @NotFound(action = NotFoundAction.IGNORE)
+    private IVSImage externalLinkDefaultImage;
+
     private boolean aboutPageConfigured;
 
     @OneToMany(targetEntity = ExhibitionLanguage.class, mappedBy = "exhibition", cascade = CascadeType.ALL, orphanRemoval=true)
@@ -122,16 +135,39 @@ public void setCustomMessage(String customMessage) {
         this.customMessage = customMessage;
     }
 
+    @Override
+    public IVSImage getSpaceLinkDefaultImage() {
+        return spaceLinkDefaultImage;
+    }
+    @Override
+    public void setSpaceLinkDefaultImage(IVSImage spaceLinkDefaultImage) {
+        this.spaceLinkDefaultImage = spaceLinkDefaultImage;
+    }
+    @Override
+    public IVSImage getModuleLinkDefaultImage() {
+        return moduleLinkDefaultImage;
+    }
+    @Override
+    public void setModuleLinkDefaultImage(IVSImage moduleLinkDefaultImage) {
+        this.moduleLinkDefaultImage = moduleLinkDefaultImage;
+    }
+    @Override
+    public IVSImage getExternalLinkDefaultImage() {
+        return externalLinkDefaultImage;
+    }
+    @Override
+    public void setExternalLinkDefaultImage(IVSImage externalLinkDefaultImage) {
+        this.externalLinkDefaultImage = externalLinkDefaultImage;
+    }
     @Override
     public boolean isAboutPageConfigured() {
         return aboutPageConfigured;
     }
-
     @Override
     public void setAboutPageConfigured(boolean aboutPageConfigured) {
         this.aboutPageConfigured = aboutPageConfigured;
     }
-
+    
     public List<IExhibitionLanguage> getLanguages() {
         return languages;
     }
@@ -152,7 +188,7 @@ public void setPreviewId(String previewId) {
     public int hashCode() {
         return Objects.hash(id);
     }
-
+    
     @Override
     public boolean equals(Object obj) {
         if (this == obj)
@@ -163,4 +199,5 @@ public boolean equals(Object obj) {
             return false;
         return Objects.equals(id, ((Exhibition) obj).id);
     }
+
 }

vspace/src/main/java/edu/asu/diging/vspace/core/services/IImageService.java

@@ -42,4 +42,8 @@ public interface IImageService {
 
     Page<VSImage> getPaginatedImagesBySearchTerm(int pageNo, ImageCategory category, 
             String searchTerm, String sortedBy, String order);
+
+    IVSImage storeImage(byte[] image, String filename);
+
+    byte[] getImageContent(IVSImage image);
 }

vspace/src/main/java/edu/asu/diging/vspace/core/services/impl/ImageService.java

@@ -8,6 +8,7 @@
 import java.util.Optional;
 import javax.imageio.ImageIO;
 
+import org.apache.tika.Tika;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -19,7 +20,10 @@
 import org.springframework.stereotype.Service;
 
 import edu.asu.diging.vspace.core.data.ImageRepository;
+import edu.asu.diging.vspace.core.exception.FileStorageException;
 import edu.asu.diging.vspace.core.exception.ImageDoesNotExistException;
+import edu.asu.diging.vspace.core.factory.IImageFactory;
+import edu.asu.diging.vspace.core.file.IStorageEngine;
 import edu.asu.diging.vspace.core.model.IVSImage;
 import edu.asu.diging.vspace.core.model.ImageCategory;
 import edu.asu.diging.vspace.core.model.SortByField;
@@ -36,9 +40,18 @@ public class ImageService implements IImageService {
     @Autowired
     private ImageRepository imageRepo;
 
+    @Autowired
+    private IImageFactory imageFactory;
+
+    @Autowired
+    private IStorageEngine storage;
+
     @Value("${page_size}")
     private int pageSize;
 
+    private final String DEFAULT_IMAGE_EXCEPTION = "Default image could not be stored: ";
+    private final String NO_IMAGE_EXCEPTION = "Image doesn't exist for image id";
+
     /*
      * (non-Javadoc)
      * 
@@ -218,7 +231,7 @@ public IVSImage getImageById(String imageId) throws ImageDoesNotExistException {
         if(imageOptional.isPresent()) {
             return imageOptional.get();
         } else {
-            throw new ImageDoesNotExistException("Image doesn't exist for image id" + imageId);
+            throw new ImageDoesNotExistException(NO_IMAGE_EXCEPTION + imageId);
         }
     }
 
@@ -247,6 +260,63 @@ public void addCategory(IVSImage image, ImageCategory category) {
     public void removeCategory(IVSImage image, ImageCategory category) {
         image.getCategories().remove(category);
         imageRepo.save((VSImage) image);
+    }   
+
+    /**
+     * Method to store an image in the file location
+     * 
+     *@param image - The image data as a byte array
+     *@param filename - The name of the file to be stored
+     *@return {@link IVSImage} instance
+     */
+    @Override
+    public IVSImage storeImage(byte[] image, String filename) {
+
+        IVSImage storedImage = null;
+        if (image != null && image.length > 0) {
+            Tika tika = new Tika();
+            String contentType = tika.detect(image);
+            storedImage = imageFactory.createImage(filename, contentType);
+            storedImage = imageRepo.save((VSImage) storedImage);
+        }
+
+        CreationReturnValue returnValue = new CreationReturnValue();
+        returnValue.setErrorMsgs(new ArrayList<>());
+
+        if (storedImage != null) {
+            String relativePath = null;
+            try {
+                relativePath = storage.storeFile(image, filename, storedImage.getId());
+            } catch (FileStorageException e) {
+                logger.error(DEFAULT_IMAGE_EXCEPTION,e);
+                returnValue.getErrorMsgs().add(DEFAULT_IMAGE_EXCEPTION + e.getMessage());
+            }
+            storedImage.setParentPath(relativePath);
+            ImageData imageData = getImageData(image);
+
+            if (imageData != null) {
+                storedImage.setHeight(imageData.getHeight());
+                storedImage.setWidth(imageData.getWidth());
+            }
+            imageRepo.save((VSImage) storedImage);
+        }
+        return storedImage;
+    }
+
+    /**
+     *Method to return content of the image
+     *
+     *@param image - {@link IVSImage} instance of the image to be retrieved
+     *@return byte[] - the image content as byte array
+     */
+    @Override
+    public byte[] getImageContent(IVSImage image) {
+        try {
+            return storage.getMediaContent(image.getId(), image.getFilename());
+        } catch (IOException e) {
+            logger.error("Could not retrieve the image",e);  
+        }
+        return null;
     }
 
     /**

vspace/src/main/java/edu/asu/diging/vspace/web/staff/DefaultImageController.java

@@ -0,0 +1,87 @@
+package edu.asu.diging.vspace.web.staff;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.CacheControl;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+
+import com.google.gson.JsonObject;
+
+import edu.asu.diging.vspace.core.model.IExhibition;
+import edu.asu.diging.vspace.core.model.IVSImage;
+import edu.asu.diging.vspace.core.services.IExhibitionManager;
+import edu.asu.diging.vspace.core.services.IImageService;
+
+@Controller
+public class DefaultImageController {
+
+    public static final String API_DEFAULT_SPACE_IMAGE_PATH = "/api/image/default/link/space/";
+    public static final String API_DEFAULT_MODULE_IMAGE_PATH = "/api/image/default/link/module/";
+    public static final String API_DEFAULT_EXTERNAL_IMAGE_PATH = "/api/image/default/link/external/";
+    public static final String API_DEFAULT_SPACE_IMAGE_STATUS = "/api/exhibition/default/link/image/status/";
+
+    @Autowired
+    private IImageService imageService;
+
+    @Autowired
+    private IExhibitionManager exhibitManager;
+
+    @RequestMapping(value = API_DEFAULT_SPACE_IMAGE_PATH, method = RequestMethod.GET)
+    public ResponseEntity<byte[]> getDefaultSpaceImage() {
+        IExhibition exhibition = exhibitManager.getStartExhibition();
+        IVSImage spaceImage = exhibition.getSpaceLinkDefaultImage();
+        return getResponseWithDefaultHeaders(spaceImage);
+    }
+
+    @RequestMapping(value = API_DEFAULT_MODULE_IMAGE_PATH, method = RequestMethod.GET)
+    public ResponseEntity<byte[]> getDefaultModuleImage() {
+        IExhibition exhibition = exhibitManager.getStartExhibition();
+        IVSImage moduleImage = exhibition.getModuleLinkDefaultImage();
+        return getResponseWithDefaultHeaders(moduleImage);
+    }
+
+    @RequestMapping(value = API_DEFAULT_EXTERNAL_IMAGE_PATH, method = RequestMethod.GET)
+    public ResponseEntity<byte[]> getDefaultExternalImage() {
+        IExhibition exhibition = exhibitManager.getStartExhibition();
+        IVSImage externalLinkImage = exhibition.getExternalLinkDefaultImage();
+        return getResponseWithDefaultHeaders(externalLinkImage);
+    }
+
+    /**
+     * Retrieves the status of default images for exhibition links
+     * @return A JSON response containing flags indicating the availability of default images.
+     */
+    @RequestMapping(value = API_DEFAULT_SPACE_IMAGE_STATUS, method = RequestMethod.GET)
+    public ResponseEntity<String> getDefaultImageStatus() {
+        IExhibition exhibition = exhibitManager.getStartExhibition();
+        exhibition.getSpaceLinkDefaultImage();
+
+        JsonObject jsonObj = new JsonObject();
+        jsonObj.addProperty("defaultSpaceImageFlag", exhibition.getSpaceLinkDefaultImage() != null? true : false);
+        jsonObj.addProperty("defaultModuleImageFlag", exhibition.getModuleLinkDefaultImage() != null? true : false);
+        jsonObj.addProperty("defaultExternalLinkImageFlag", exhibition.getExternalLinkDefaultImage() != null? true : false);
+        return new ResponseEntity<>(jsonObj.toString(), HttpStatus.OK);
+    }
+
+    private ResponseEntity<byte[]> getResponseWithDefaultHeaders(IVSImage image) {
+        if(image == null) {
+            return new ResponseEntity<>(HttpStatus.NOT_FOUND);
+        }
+        byte[] imageContent = imageService.getImageContent(image);
+        HttpHeaders headers = new HttpHeaders();
+        headers.setCacheControl(CacheControl.noCache().getHeaderValue());
+        headers.setContentType(MediaType.parseMediaType(image.getFileType()));
+        return new ResponseEntity<>(imageContent, headers, HttpStatus.OK);
+    }
+
+}