app/src/main/java/org/apache/roller/weblogger/pojos/MediaFile.java - roller - Git at Google

 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  *  contributor license agreements.  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.  For additional information regarding
  * copyright in this work, please see the NOTICE file in the top level
  * directory of this distribution.
  */
 package org.apache.roller.weblogger.pojos;

 import java.io.InputStream;
 import java.io.Serializable;
 import java.sql.Timestamp;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Locale;
 import java.util.Set;

 import org.apache.commons.lang3.builder.EqualsBuilder;
 import org.apache.commons.lang3.builder.HashCodeBuilder;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.apache.roller.util.UUIDGenerator;
 import org.apache.roller.weblogger.WebloggerException;
 import org.apache.roller.weblogger.business.MediaFileManager;
 import org.apache.roller.weblogger.business.WebloggerFactory;
 import org.apache.roller.weblogger.util.Utilities;

 /**
  * Represents a media file
  *
  */
 public class MediaFile implements Serializable {

     private static final long serialVersionUID = -6704258422169734004L;

     private static Log log = LogFactory.getFactory().getInstance(
             MediaFile.class);

     private String id = UUIDGenerator.generateUUID();

     private String name;
     private String description;
     private String copyrightText;
     private Boolean isSharedForGallery = Boolean.FALSE;
     private long length;
     private int width = -1;
     private int height = -1;
     private int thumbnailHeight = -1;
     private int thumbnailWidth = -1;
     private String contentType;
     private String originalPath;
     private Timestamp dateUploaded = new Timestamp(System.currentTimeMillis());
     private Timestamp lastUpdated = new Timestamp(System.currentTimeMillis());
     private String creatorUserName;
     private Weblog weblog;

     private InputStream is;

     private MediaFileDirectory directory;

     private FileContent content;
     private FileContent thumbnail;

     // TODO: anchor to be populated
     // private String anchor;

     private Set<MediaFileTag> tagSet = new HashSet<>();
     private Set<String> removedTags = new HashSet<>();
     private Set<String> addedTags = new HashSet<>();

     public MediaFile() {
     }

     /**
      * Database surrogate key.
      */
     public String getId() {
         return id;
     }

     /**
      * @param id
      *            the id to set
      */
     public void setId(String id) {
         this.id = id;
     }

     /**
      * Name for the media file
      *
      */
     public String getName() {
         return name;
     }

     public void setName(String name) {
         this.name = name;
     }

     /**
      * Description for media file
      *
      */
     public String getDescription() {
         return description;
     }

     public void setDescription(String description) {
         this.description = description;
     }

     /**
      * Copyright text for media file
      *
      */
     public String getCopyrightText() {
         return copyrightText;
     }

     public void setCopyrightText(String copyrightText) {
         this.copyrightText = copyrightText;
     }

     /**
      * Is media file shared for gallery
      *
      */
     public Boolean getSharedForGallery() {
         return isSharedForGallery;
     }

     public void setSharedForGallery(Boolean isSharedForGallery) {
         this.isSharedForGallery = isSharedForGallery;
     }

     /**
      * Size of the media file
      *
      */
     public long getLength() {
         return length;
     }

     public void setLength(long length) {
         this.length = length;
     }

     /**
      * Date uploaded
      *
      */
     public Timestamp getDateUploaded() {
         return dateUploaded;
     }

     public void setDateUploaded(Timestamp dateUploaded) {
         this.dateUploaded = dateUploaded;
     }

     public long getLastModified() {
         return getLastUpdated().getTime();
     }

     /**
      * Last updated timestamp
      *
      */
     public Timestamp getLastUpdated() {
         return lastUpdated;
     }

     public void setLastUpdated(Timestamp time) {
         this.lastUpdated = time;
     }

     public MediaFileDirectory getDirectory() {
         return directory;
     }

     public void setDirectory(MediaFileDirectory dir) {
         this.directory = dir;
     }

     /**
      * Set of tags for this media file
      */
     public Set<MediaFileTag> getTags() {
         return tagSet;
     }

     private void setTags(Set<MediaFileTag> tagSet) throws WebloggerException {
         this.tagSet = tagSet;
         this.removedTags = new HashSet<>();
         this.addedTags = new HashSet<>();
     }

     /**
      * Roller lowercases all tags based on locale because there's not a 1:1
      * mapping between uppercase/lowercase characters across all languages.
      *
      * @param name
      * @throws WebloggerException
      */
     public void addTag(String name) throws WebloggerException {
         Locale localeObject = getWeblog() != null ? getWeblog()
                 .getLocaleInstance() : Locale.getDefault();
         name = Utilities.normalizeTag(name, localeObject);
         if (name.length() == 0) {
             return;
         }

         for (MediaFileTag tag : getTags()) {
             if (tag.getName().equals(name)) {
                 return;
             }
         }

         MediaFileTag tag = new MediaFileTag();
         tag.setName(name);
         tag.setMediaFile(this);

         tagSet.add(tag);

         addedTags.add(name);
     }

     public void onRemoveTag(String name) throws WebloggerException {
         removedTags.add(name);
     }

     public Set getAddedTags() {
         return addedTags;
     }

     public Set getRemovedTags() {
         return removedTags;
     }

     public void updateTags(List<String> updatedTags) throws WebloggerException {

         if (updatedTags == null) {
             return;
         }

         HashSet<String> newTags = new HashSet<>(updatedTags.size());
         Locale localeObject = getWeblog() != null ? getWeblog()
                 .getLocaleInstance() : Locale.getDefault();

         for (String inName : updatedTags) {
             newTags.add(Utilities.normalizeTag(inName, localeObject));
         }

         HashSet<String> removeTags = new HashSet<>();

         // remove old ones no longer passed.
         for (MediaFileTag tag : getTags()) {
             if (!newTags.contains(tag.getName())) {
                 removeTags.add(tag.getName());
             } else {
                 newTags.remove(tag.getName());
             }
         }

         MediaFileManager mediaManager = WebloggerFactory.getWeblogger()
                 .getMediaFileManager();

         for (String tag : removeTags) {
             mediaManager.removeMediaFileTag(tag, this);
         }

         for (String tag : newTags) {
             addTag(tag);
         }
     }

     public String getTagsAsString() {
         StringBuilder sb = new StringBuilder();
         for (MediaFileTag tag : getTags()) {
             sb.append(tag.getName()).append(" ");
         }
         if (sb.length() > 0) {
             sb.deleteCharAt(sb.length() - 1);
         }

         return sb.toString();
     }

     public void setTagsAsString(String tags) throws WebloggerException {
         if (tags == null) {
             tagSet.clear();
             return;
         }

         updateTags(Utilities.splitStringAsTags(tags));
     }

     /**
      * Content type of the media file
      *
      */
     public String getContentType() {
         return contentType;
     }

     public void setContentType(String contentType) {
         this.contentType = contentType;
     }

     public String getPath() {
         return getDirectory().getName();
     }

     /**
      * Returns input stream for the underlying file in the file system.
      *
      * @return
      */
     public InputStream getInputStream() {
         if (is != null) {
             return is;
         } else if (content != null) {
             return content.getInputStream();
         }
         return null;
     }

     public void setInputStream(InputStream is) {
         this.is = is;
     }

     public void setContent(FileContent content) {
         this.content = content;
     }

     /**
      * Indicates whether this is an image file.
      *
      */
     public boolean isImageFile() {
         if (getContentType() == null) {
             return false;
         }
         return (getContentType().toLowerCase().startsWith(MediaFileType.IMAGE
                 .getContentTypePrefix().toLowerCase()));
     }

     /**
      * Returns permalink URL for this media file resource.
      */
     public String getPermalink() {
         return WebloggerFactory.getWeblogger().getUrlStrategy()
                 .getMediaFileURL(getWeblog(), this.getId(), true);
     }

     /**
      * Returns thumbnail URL for this media file resource. Resulting URL will be
      * a 404 if media file is not an image.
      */
     public String getThumbnailURL() {
         return WebloggerFactory.getWeblogger().getUrlStrategy()
                 .getMediaFileThumbnailURL(getWeblog(), this.getId(), true);
     }

     public String getCreatorUserName() {
         return creatorUserName;
     }

     public void setCreatorUserName(String creatorUserName) {
         this.creatorUserName = creatorUserName;
     }

     public User getCreator() {
         try {
             return WebloggerFactory.getWeblogger().getUserManager()
                     .getUserByUserName(getCreatorUserName());
         } catch (Exception e) {
             log.error("ERROR fetching user object for username: "
                     + getCreatorUserName(), e);
         }
         return null;
     }

     /**
      * For old migrated files and theme resource files, orignal path of file can
      * never change.
      *
      * @return the originalPath
      */
     public String getOriginalPath() {
         return originalPath;
     }

     /**
      * For old migrated files and theme resource files, orignal path of file can
      * never change.
      *
      * @param originalPath
      *            the originalPath to set
      */
     public void setOriginalPath(String originalPath) {
         this.originalPath = originalPath;
     }

     /**
      * @return the weblog
      */
     public Weblog getWeblog() {
         return weblog;
     }

     /**
      * @param weblog
      *            the weblog to set
      */
     public void setWeblog(Weblog weblog) {
         this.weblog = weblog;
     }

     /**
      * @return the width
      */
     public int getWidth() {
         return width;
     }

     /**
      * @param width
      *            the width to set
      */
     public void setWidth(int width) {
         this.width = width;
     }

     /**
      * @return the height
      */
     public int getHeight() {
         return height;
     }

     /**
      * @param height
      *            the height to set
      */
     public void setHeight(int height) {
         this.height = height;
     }

     /**
      * Returns input stream for the underlying thumbnail file in the file
      * system.
      *
      * @return
      */
     public InputStream getThumbnailInputStream() {
         if (thumbnail != null) {
             return thumbnail.getInputStream();
         }
         return null;
     }

     public void setThumbnailContent(FileContent thumbnail) {
         this.thumbnail = thumbnail;
     }

     /**
      * @return the thumbnailHeight
      */
     public int getThumbnailHeight() {
         if (isImageFile() && (thumbnailWidth == -1 || thumbnailHeight == -1)) {
             figureThumbnailSize();
         }
         return thumbnailHeight;
     }

     /**
      * @return the thumbnailWidth
      */
     public int getThumbnailWidth() {
         if (isImageFile() && (thumbnailWidth == -1 || thumbnailHeight == -1)) {
             figureThumbnailSize();
         }
         return thumbnailWidth;
     }

     private void figureThumbnailSize() {
         // image determine thumbnail size
         int newWidth = getWidth();
         int newHeight = getHeight();

         if (getWidth() > getHeight()) {
             if (getWidth() > MediaFileManager.MAX_WIDTH) {
                 newHeight = (int) ((float) getHeight() * ((float) MediaFileManager.MAX_WIDTH / (float) getWidth()));
                 newWidth = MediaFileManager.MAX_WIDTH;
             }

         } else {
             if (getHeight() > MediaFileManager.MAX_HEIGHT) {
                 newWidth = (int) ((float) getWidth() * ((float) MediaFileManager.MAX_HEIGHT / (float) getHeight()));
                 newHeight = MediaFileManager.MAX_HEIGHT;
             }
         }
         thumbnailHeight = newHeight;
         thumbnailWidth = newWidth;
     }

     // ------------------------------------------------------- Good citizenship

     @Override
     public String toString() {
         return "MediaFile [name=" + getName() + ", directory=" + getDirectory()
                 + ", weblog=" + getWeblog() + "]";
     }

     @Override
     public boolean equals(Object other) {
         if (other == this) {
             return true;
         }
         if (!(other instanceof MediaFile)) {
             return false;
         }
         MediaFile o = (MediaFile) other;
         return new EqualsBuilder().append(getId(), o.getId()).isEquals();
     }

     @Override
     public int hashCode() {
         return new HashCodeBuilder().append(getId()).toHashCode();
     }

 }
	/*
	* Licensed to the Apache Software Foundation (ASF) under one or more
	* contributor license agreements. 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. For additional information regarding
	* copyright in this work, please see the NOTICE file in the top level
	* directory of this distribution.
	*/
	package org.apache.roller.weblogger.pojos;

	import java.io.InputStream;
	import java.io.Serializable;
	import java.sql.Timestamp;
	import java.util.HashSet;
	import java.util.List;
	import java.util.Locale;
	import java.util.Set;

	import org.apache.commons.lang3.builder.EqualsBuilder;
	import org.apache.commons.lang3.builder.HashCodeBuilder;
	import org.apache.commons.logging.Log;
	import org.apache.commons.logging.LogFactory;
	import org.apache.roller.util.UUIDGenerator;
	import org.apache.roller.weblogger.WebloggerException;
	import org.apache.roller.weblogger.business.MediaFileManager;
	import org.apache.roller.weblogger.business.WebloggerFactory;
	import org.apache.roller.weblogger.util.Utilities;

	/**
	* Represents a media file
	*
	*/
	public class MediaFile implements Serializable {

	private static final long serialVersionUID = -6704258422169734004L;

	private static Log log = LogFactory.getFactory().getInstance(
	MediaFile.class);

	private String id = UUIDGenerator.generateUUID();

	private String name;
	private String description;
	private String copyrightText;
	private Boolean isSharedForGallery = Boolean.FALSE;
	private long length;
	private int width = -1;
	private int height = -1;
	private int thumbnailHeight = -1;
	private int thumbnailWidth = -1;
	private String contentType;
	private String originalPath;
	private Timestamp dateUploaded = new Timestamp(System.currentTimeMillis());
	private Timestamp lastUpdated = new Timestamp(System.currentTimeMillis());
	private String creatorUserName;
	private Weblog weblog;

	private InputStream is;

	private MediaFileDirectory directory;

	private FileContent content;
	private FileContent thumbnail;

	// TODO: anchor to be populated
	// private String anchor;

	private Set<MediaFileTag> tagSet = new HashSet<>();
	private Set<String> removedTags = new HashSet<>();
	private Set<String> addedTags = new HashSet<>();

	public MediaFile() {
	}

	/**
	* Database surrogate key.
	*/
	public String getId() {
	return id;
	}

	/**
	* @param id
	* the id to set
	*/
	public void setId(String id) {
	this.id = id;
	}

	/**
	* Name for the media file
	*
	*/
	public String getName() {
	return name;
	}

	public void setName(String name) {
	this.name = name;
	}

	/**
	* Description for media file
	*
	*/
	public String getDescription() {
	return description;
	}

	public void setDescription(String description) {
	this.description = description;
	}

	/**
	* Copyright text for media file
	*
	*/
	public String getCopyrightText() {
	return copyrightText;
	}

	public void setCopyrightText(String copyrightText) {
	this.copyrightText = copyrightText;
	}

	/**
	* Is media file shared for gallery
	*
	*/
	public Boolean getSharedForGallery() {
	return isSharedForGallery;
	}

	public void setSharedForGallery(Boolean isSharedForGallery) {
	this.isSharedForGallery = isSharedForGallery;
	}

	/**
	* Size of the media file
	*
	*/
	public long getLength() {
	return length;
	}

	public void setLength(long length) {
	this.length = length;
	}

	/**
	* Date uploaded
	*
	*/
	public Timestamp getDateUploaded() {
	return dateUploaded;
	}

	public void setDateUploaded(Timestamp dateUploaded) {
	this.dateUploaded = dateUploaded;
	}

	public long getLastModified() {
	return getLastUpdated().getTime();
	}

	/**
	* Last updated timestamp
	*
	*/
	public Timestamp getLastUpdated() {
	return lastUpdated;
	}

	public void setLastUpdated(Timestamp time) {
	this.lastUpdated = time;
	}

	public MediaFileDirectory getDirectory() {
	return directory;
	}

	public void setDirectory(MediaFileDirectory dir) {
	this.directory = dir;
	}

	/**
	* Set of tags for this media file
	*/
	public Set<MediaFileTag> getTags() {
	return tagSet;
	}

	private void setTags(Set<MediaFileTag> tagSet) throws WebloggerException {
	this.tagSet = tagSet;
	this.removedTags = new HashSet<>();
	this.addedTags = new HashSet<>();
	}

	/**
	* Roller lowercases all tags based on locale because there's not a 1:1
	* mapping between uppercase/lowercase characters across all languages.
	*
	* @param name
	* @throws WebloggerException
	*/
	public void addTag(String name) throws WebloggerException {
	Locale localeObject = getWeblog() != null ? getWeblog()
	.getLocaleInstance() : Locale.getDefault();
	name = Utilities.normalizeTag(name, localeObject);
	if (name.length() == 0) {
	return;
	}

	for (MediaFileTag tag : getTags()) {
	if (tag.getName().equals(name)) {
	return;
	}
	}

	MediaFileTag tag = new MediaFileTag();
	tag.setName(name);
	tag.setMediaFile(this);

	tagSet.add(tag);

	addedTags.add(name);
	}

	public void onRemoveTag(String name) throws WebloggerException {
	removedTags.add(name);
	}

	public Set getAddedTags() {
	return addedTags;
	}

	public Set getRemovedTags() {
	return removedTags;
	}

	public void updateTags(List<String> updatedTags) throws WebloggerException {

	if (updatedTags == null) {
	return;
	}

	HashSet<String> newTags = new HashSet<>(updatedTags.size());
	Locale localeObject = getWeblog() != null ? getWeblog()
	.getLocaleInstance() : Locale.getDefault();

	for (String inName : updatedTags) {
	newTags.add(Utilities.normalizeTag(inName, localeObject));
	}

	HashSet<String> removeTags = new HashSet<>();

	// remove old ones no longer passed.
	for (MediaFileTag tag : getTags()) {
	if (!newTags.contains(tag.getName())) {
	removeTags.add(tag.getName());
	} else {
	newTags.remove(tag.getName());
	}
	}

	MediaFileManager mediaManager = WebloggerFactory.getWeblogger()
	.getMediaFileManager();

	for (String tag : removeTags) {
	mediaManager.removeMediaFileTag(tag, this);
	}

	for (String tag : newTags) {
	addTag(tag);
	}
	}

	public String getTagsAsString() {
	StringBuilder sb = new StringBuilder();
	for (MediaFileTag tag : getTags()) {
	sb.append(tag.getName()).append(" ");
	}
	if (sb.length() > 0) {
	sb.deleteCharAt(sb.length() - 1);
	}

	return sb.toString();
	}

	public void setTagsAsString(String tags) throws WebloggerException {
	if (tags == null) {
	tagSet.clear();
	return;
	}

	updateTags(Utilities.splitStringAsTags(tags));
	}

	/**
	* Content type of the media file
	*
	*/
	public String getContentType() {
	return contentType;
	}

	public void setContentType(String contentType) {
	this.contentType = contentType;
	}

	public String getPath() {
	return getDirectory().getName();
	}

	/**
	* Returns input stream for the underlying file in the file system.
	*
	* @return
	*/
	public InputStream getInputStream() {
	if (is != null) {
	return is;
	} else if (content != null) {
	return content.getInputStream();
	}
	return null;
	}

	public void setInputStream(InputStream is) {
	this.is = is;
	}

	public void setContent(FileContent content) {
	this.content = content;
	}

	/**
	* Indicates whether this is an image file.
	*
	*/
	public boolean isImageFile() {
	if (getContentType() == null) {
	return false;
	}
	return (getContentType().toLowerCase().startsWith(MediaFileType.IMAGE
	.getContentTypePrefix().toLowerCase()));
	}

	/**
	* Returns permalink URL for this media file resource.
	*/
	public String getPermalink() {
	return WebloggerFactory.getWeblogger().getUrlStrategy()
	.getMediaFileURL(getWeblog(), this.getId(), true);
	}

	/**
	* Returns thumbnail URL for this media file resource. Resulting URL will be
	* a 404 if media file is not an image.
	*/
	public String getThumbnailURL() {
	return WebloggerFactory.getWeblogger().getUrlStrategy()
	.getMediaFileThumbnailURL(getWeblog(), this.getId(), true);
	}

	public String getCreatorUserName() {
	return creatorUserName;
	}

	public void setCreatorUserName(String creatorUserName) {
	this.creatorUserName = creatorUserName;
	}

	public User getCreator() {
	try {
	return WebloggerFactory.getWeblogger().getUserManager()
	.getUserByUserName(getCreatorUserName());
	} catch (Exception e) {
	log.error("ERROR fetching user object for username: "
	+ getCreatorUserName(), e);
	}
	return null;
	}

	/**
	* For old migrated files and theme resource files, orignal path of file can
	* never change.
	*
	* @return the originalPath
	*/
	public String getOriginalPath() {
	return originalPath;
	}

	/**
	* For old migrated files and theme resource files, orignal path of file can
	* never change.
	*
	* @param originalPath
	* the originalPath to set
	*/
	public void setOriginalPath(String originalPath) {
	this.originalPath = originalPath;
	}

	/**
	* @return the weblog
	*/
	public Weblog getWeblog() {
	return weblog;
	}

	/**
	* @param weblog
	* the weblog to set
	*/
	public void setWeblog(Weblog weblog) {
	this.weblog = weblog;
	}

	/**
	* @return the width
	*/
	public int getWidth() {
	return width;
	}

	/**
	* @param width
	* the width to set
	*/
	public void setWidth(int width) {
	this.width = width;
	}

	/**
	* @return the height
	*/
	public int getHeight() {
	return height;
	}

	/**
	* @param height
	* the height to set
	*/
	public void setHeight(int height) {
	this.height = height;
	}

	/**
	* Returns input stream for the underlying thumbnail file in the file
	* system.
	*
	* @return
	*/
	public InputStream getThumbnailInputStream() {
	if (thumbnail != null) {
	return thumbnail.getInputStream();
	}
	return null;
	}

	public void setThumbnailContent(FileContent thumbnail) {
	this.thumbnail = thumbnail;
	}

	/**
	* @return the thumbnailHeight
	*/
	public int getThumbnailHeight() {
	if (isImageFile() && (thumbnailWidth == -1 \|\| thumbnailHeight == -1)) {
	figureThumbnailSize();
	}
	return thumbnailHeight;
	}

	/**
	* @return the thumbnailWidth
	*/
	public int getThumbnailWidth() {
	if (isImageFile() && (thumbnailWidth == -1 \|\| thumbnailHeight == -1)) {
	figureThumbnailSize();
	}
	return thumbnailWidth;
	}

	private void figureThumbnailSize() {
	// image determine thumbnail size
	int newWidth = getWidth();
	int newHeight = getHeight();

	if (getWidth() > getHeight()) {
	if (getWidth() > MediaFileManager.MAX_WIDTH) {
	newHeight = (int) ((float) getHeight() * ((float) MediaFileManager.MAX_WIDTH / (float) getWidth()));
	newWidth = MediaFileManager.MAX_WIDTH;
	}

	} else {
	if (getHeight() > MediaFileManager.MAX_HEIGHT) {
	newWidth = (int) ((float) getWidth() * ((float) MediaFileManager.MAX_HEIGHT / (float) getHeight()));
	newHeight = MediaFileManager.MAX_HEIGHT;
	}
	}
	thumbnailHeight = newHeight;
	thumbnailWidth = newWidth;
	}

	// ------------------------------------------------------- Good citizenship

	@Override
	public String toString() {
	return "MediaFile [name=" + getName() + ", directory=" + getDirectory()
	+ ", weblog=" + getWeblog() + "]";
	}

	@Override
	public boolean equals(Object other) {
	if (other == this) {
	return true;
	}
	if (!(other instanceof MediaFile)) {
	return false;
	}
	MediaFile o = (MediaFile) other;
	return new EqualsBuilder().append(getId(), o.getId()).isEquals();
	}

	@Override
	public int hashCode() {
	return new HashCodeBuilder().append(getId()).toHashCode();
	}

	}