app/src/main/java/org/apache/roller/weblogger/pojos/wrapper/WeblogWrapper.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.wrapper;

 import org.apache.commons.lang3.StringEscapeUtils;
 import org.apache.roller.weblogger.WebloggerException;
 import org.apache.roller.weblogger.business.URLStrategy;
 import org.apache.roller.weblogger.pojos.TagStat;
 import org.apache.roller.weblogger.util.HTMLSanitizer;

 import java.util.*;
 import org.apache.roller.weblogger.pojos.ThemeTemplate;
 import org.apache.roller.weblogger.pojos.ThemeTemplate.ComponentType;
 import org.apache.roller.weblogger.pojos.Weblog;
 import org.apache.roller.weblogger.pojos.WeblogCategory;
 import org.apache.roller.weblogger.pojos.WeblogEntry;
 import org.apache.roller.weblogger.pojos.WeblogEntryComment;


 /**
  * Pojo safety wrapper for Weblog objects.
  */
 public final class WeblogWrapper {

     // keep a reference to the wrapped pojo
     private final Weblog pojo;

     // url strategy to use for any url building
     private final URLStrategy urlStrategy;

     // this is private so that we can force the use of the .wrap(pojo) method
     private WeblogWrapper(Weblog toWrap, URLStrategy strat) {
         this.pojo = toWrap;
         this.urlStrategy = strat;
     }


     // wrap the given pojo if it is not null with detected type
     public static WeblogWrapper wrap(Weblog toWrap, URLStrategy strat) {
         if (toWrap != null) {
             return new WeblogWrapper(toWrap, strat);
         }
         return null;
     }


     public ThemeTemplateWrapper getTemplateByAction(ComponentType action)
             throws WebloggerException {
         ThemeTemplate templateToWrap = this.pojo.getTheme().getTemplateByAction(action);
         return ThemeTemplateWrapper.wrap(templateToWrap);
     }


     public ThemeTemplateWrapper getTemplateByName(String name)
             throws WebloggerException {
        ThemeTemplate templateToWrap = this.pojo.getTheme().getTemplateByName(name);
         return ThemeTemplateWrapper.wrap(templateToWrap);
     }


     public ThemeTemplateWrapper getTemplateByLink(String link)
             throws WebloggerException {
         ThemeTemplate templateToWrap = this.pojo.getTheme().getTemplateByLink(link);
         return ThemeTemplateWrapper.wrap(templateToWrap);
     }


     public List<ThemeTemplateWrapper> getTemplates() throws WebloggerException {
         List<? extends ThemeTemplate> unwrapped = this.pojo.getTheme().getTemplates();
         List<ThemeTemplateWrapper> wrapped = new ArrayList<ThemeTemplateWrapper>(unwrapped.size());

         int i = 0;
         for (ThemeTemplate template : unwrapped) {
             wrapped.add(i,ThemeTemplateWrapper.wrap(template));
             i++;
         }
         return wrapped;
     }


     public String getId() {
         return this.pojo.getId();
     }


     public String getHandle() {
         return this.pojo.getHandle();
     }


     public String getName() {
         return StringEscapeUtils.escapeHtml4(this.pojo.getName());
     }

     public String getTagline() {
         return HTMLSanitizer.conditionallySanitize(this.pojo.getTagline());
     }

     public UserWrapper getCreator() {
         return UserWrapper.wrap(this.pojo.getCreator());
     }

     public Boolean getEnableBloggerApi() {
         return this.pojo.getEnableBloggerApi();
     }

     public WeblogCategoryWrapper getBloggerCategory() {
         return WeblogCategoryWrapper.wrap(this.pojo.getBloggerCategory(), urlStrategy);
     }

     public String getEditorPage() {
         return this.pojo.getEditorPage();
     }

     public String getBlacklist() {
         return this.pojo.getBlacklist();
     }


     public Boolean getAllowComments() {
         return this.pojo.getAllowComments();
     }


     public Boolean getDefaultAllowComments() {
         return this.pojo.getDefaultAllowComments();
     }


     public int getDefaultCommentDays() {
         return this.pojo.getDefaultCommentDays();
     }


     public Boolean getModerateComments() {
         return this.pojo.getModerateComments();
     }

     public String getAnalyticsCode() {
         return this.pojo.getAnalyticsCode();
     }


     public Boolean getEmailComments() {
         return this.pojo.getEmailComments();
     }

     public String getEmailAddress() {
         return this.pojo.getEmailAddress();
     }


     public String getEditorTheme() {
         return this.pojo.getEditorTheme();
     }


     public String getLocale() {
         return this.pojo.getLocale();
     }


     public String getTimeZone() {
         return this.pojo.getTimeZone();
     }


     public Date getDateCreated() {
         return this.pojo.getDateCreated();
     }


     public String getDefaultPlugins() {
         return this.pojo.getDefaultPlugins();
     }

     public Locale getLocaleInstance() {
         return this.pojo.getLocaleInstance();
     }


     public TimeZone getTimeZoneInstance() {
         return this.pojo.getTimeZoneInstance();
     }


     public int getEntryDisplayCount() {
         return this.pojo.getEntryDisplayCount();
     }


     public Boolean getVisible() {
         return this.pojo.getVisible();
     }

     /* deprecated in Roller 5.1 */
     public Boolean getEnabled() {
         return getVisible();
     }

     public Boolean getActive() {
         return this.pojo.getActive();
     }


     public Date getLastModified() {
         return this.pojo.getLastModified();
     }


     public boolean isEnableMultiLang() {
         return this.pojo.isEnableMultiLang();
     }


     public boolean isShowAllLangs() {
         return this.pojo.isShowAllLangs();
     }


     public String getStylesheet() throws WebloggerException {
         // custom stylesheet comes from the weblog theme
         if(this.pojo.getTheme().getStylesheet() != null) {
             return urlStrategy.getWeblogPageURL(this.pojo, null, this.pojo.getTheme().getStylesheet().getLink(), null, null, null, null, 0, false);
         }
         return null;
     }


     /**
      * Get path to weblog icon image if defined.
      *
      * This method is somewhat smart in the sense that it will check the entered
      * icon value and if it is a full url then it will be left alone, but if it
      * is a relative path to a file in the weblog's uploads section then it will
      * build the full url to that resource and return it.
      */
     public String getIcon() {

         String iconPath = this.pojo.getIconPath();
         if(iconPath == null) {
             return null;
         }

         if(iconPath.startsWith("http") || iconPath.startsWith("/")) {
             // if icon path is a relative path then assume it's a weblog resource
             return iconPath;
         } else {
             // otherwise it's just a plain old url
             return urlStrategy.getWeblogResourceURL(this.pojo, iconPath, false);
         }

     }


     public String getAbout() {
         return HTMLSanitizer.conditionallySanitize(this.pojo.getAbout());
     }


     public String getURL() {
         return this.pojo.getURL();
     }


     public String getAbsoluteURL() {
         return this.pojo.getAbsoluteURL();
     }


     public WeblogEntryWrapper getWeblogEntry(String anchor) {
         return WeblogEntryWrapper.wrap(this.pojo.getWeblogEntry(anchor), urlStrategy);
     }


     public List<WeblogCategoryWrapper> getWeblogCategories() {
         List<WeblogCategory> unwrapped = this.pojo.getWeblogCategories();
         List<WeblogCategoryWrapper> wrapped = new ArrayList<WeblogCategoryWrapper>(unwrapped.size());

         int i = 0;
         for (WeblogCategory category : unwrapped) {
             wrapped.add(i,WeblogCategoryWrapper.wrap(category, urlStrategy));
             i++;
         }
         return wrapped;
     }

     public WeblogCategoryWrapper getWeblogCategory(String categoryName) {
         return WeblogCategoryWrapper.wrap(this.pojo.getWeblogCategory(categoryName), urlStrategy);
     }


     public List<WeblogEntryWrapper> getRecentWeblogEntries(String cat,int length) {
         List<WeblogEntry> unwrapped = this.pojo.getRecentWeblogEntries(cat, length);
         List<WeblogEntryWrapper> wrapped = new ArrayList<WeblogEntryWrapper>(unwrapped.size());

         int i = 0;
         for (WeblogEntry we : unwrapped) {
             wrapped.add(i,WeblogEntryWrapper.wrap(we, urlStrategy));
             i++;
         }
         return wrapped;
     }


     public List<WeblogEntryWrapper> getRecentWeblogEntriesByTag(String tag,int length) {
         List<WeblogEntry> unwrapped = pojo.getRecentWeblogEntriesByTag(tag,length);
         List<WeblogEntryWrapper> wrapped = new ArrayList<WeblogEntryWrapper>(unwrapped.size());

         int i = 0;
         for (WeblogEntry we : unwrapped) {
             wrapped.add(i,WeblogEntryWrapper.wrap(we, urlStrategy));
             i++;
         }
         return wrapped;
     }


     public List<WeblogEntryCommentWrapper> getRecentComments(int length) {
         List<WeblogEntryComment> unwrapped = this.pojo.getRecentComments(length);
         List<WeblogEntryCommentWrapper> wrapped = new ArrayList<WeblogEntryCommentWrapper>(unwrapped.size());

         int i = 0;
         for (WeblogEntryComment wec : unwrapped) {
             wrapped.add(i, WeblogEntryCommentWrapper.wrap(wec, urlStrategy));
             i++;
         }
         return wrapped;
     }


     public WeblogBookmarkFolderWrapper getBookmarkFolder(String folderName) {
         return WeblogBookmarkFolderWrapper.wrap(this.pojo.getBookmarkFolder(folderName));
     }

     public int getTodaysHits() {
         return this.pojo.getTodaysHits();
     }

     public List<TagStat> getPopularTags(int sinceDays,int length) {
         return this.pojo.getPopularTags(sinceDays,length);
     }


     public long getCommentCount() {
         return this.pojo.getCommentCount();
     }


     public long getEntryCount() {
         return this.pojo.getEntryCount();
     }


     /**
      * this is a special method to access the original pojo
      * we don't really want to do this, but it's necessary
      * because some parts of the rendering process still need the
      * original pojo object
      */
     public Weblog getPojo() {
         return this.pojo;
     }
 }
	/*
	* 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.wrapper;

	import org.apache.commons.lang3.StringEscapeUtils;
	import org.apache.roller.weblogger.WebloggerException;
	import org.apache.roller.weblogger.business.URLStrategy;
	import org.apache.roller.weblogger.pojos.TagStat;
	import org.apache.roller.weblogger.util.HTMLSanitizer;

	import java.util.*;
	import org.apache.roller.weblogger.pojos.ThemeTemplate;
	import org.apache.roller.weblogger.pojos.ThemeTemplate.ComponentType;
	import org.apache.roller.weblogger.pojos.Weblog;
	import org.apache.roller.weblogger.pojos.WeblogCategory;
	import org.apache.roller.weblogger.pojos.WeblogEntry;
	import org.apache.roller.weblogger.pojos.WeblogEntryComment;


	/**
	* Pojo safety wrapper for Weblog objects.
	*/
	public final class WeblogWrapper {

	// keep a reference to the wrapped pojo
	private final Weblog pojo;

	// url strategy to use for any url building
	private final URLStrategy urlStrategy;

	// this is private so that we can force the use of the .wrap(pojo) method
	private WeblogWrapper(Weblog toWrap, URLStrategy strat) {
	this.pojo = toWrap;
	this.urlStrategy = strat;
	}


	// wrap the given pojo if it is not null with detected type
	public static WeblogWrapper wrap(Weblog toWrap, URLStrategy strat) {
	if (toWrap != null) {
	return new WeblogWrapper(toWrap, strat);
	}
	return null;
	}


	public ThemeTemplateWrapper getTemplateByAction(ComponentType action)
	throws WebloggerException {
	ThemeTemplate templateToWrap = this.pojo.getTheme().getTemplateByAction(action);
	return ThemeTemplateWrapper.wrap(templateToWrap);
	}


	public ThemeTemplateWrapper getTemplateByName(String name)
	throws WebloggerException {
	ThemeTemplate templateToWrap = this.pojo.getTheme().getTemplateByName(name);
	return ThemeTemplateWrapper.wrap(templateToWrap);
	}


	public ThemeTemplateWrapper getTemplateByLink(String link)
	throws WebloggerException {
	ThemeTemplate templateToWrap = this.pojo.getTheme().getTemplateByLink(link);
	return ThemeTemplateWrapper.wrap(templateToWrap);
	}


	public List<ThemeTemplateWrapper> getTemplates() throws WebloggerException {
	List<? extends ThemeTemplate> unwrapped = this.pojo.getTheme().getTemplates();
	List<ThemeTemplateWrapper> wrapped = new ArrayList<ThemeTemplateWrapper>(unwrapped.size());

	int i = 0;
	for (ThemeTemplate template : unwrapped) {
	wrapped.add(i,ThemeTemplateWrapper.wrap(template));
	i++;
	}
	return wrapped;
	}


	public String getId() {
	return this.pojo.getId();
	}


	public String getHandle() {
	return this.pojo.getHandle();
	}


	public String getName() {
	return StringEscapeUtils.escapeHtml4(this.pojo.getName());
	}

	public String getTagline() {
	return HTMLSanitizer.conditionallySanitize(this.pojo.getTagline());
	}

	public UserWrapper getCreator() {
	return UserWrapper.wrap(this.pojo.getCreator());
	}

	public Boolean getEnableBloggerApi() {
	return this.pojo.getEnableBloggerApi();
	}

	public WeblogCategoryWrapper getBloggerCategory() {
	return WeblogCategoryWrapper.wrap(this.pojo.getBloggerCategory(), urlStrategy);
	}

	public String getEditorPage() {
	return this.pojo.getEditorPage();
	}

	public String getBlacklist() {
	return this.pojo.getBlacklist();
	}


	public Boolean getAllowComments() {
	return this.pojo.getAllowComments();
	}


	public Boolean getDefaultAllowComments() {
	return this.pojo.getDefaultAllowComments();
	}


	public int getDefaultCommentDays() {
	return this.pojo.getDefaultCommentDays();
	}


	public Boolean getModerateComments() {
	return this.pojo.getModerateComments();
	}

	public String getAnalyticsCode() {
	return this.pojo.getAnalyticsCode();
	}


	public Boolean getEmailComments() {
	return this.pojo.getEmailComments();
	}

	public String getEmailAddress() {
	return this.pojo.getEmailAddress();
	}


	public String getEditorTheme() {
	return this.pojo.getEditorTheme();
	}


	public String getLocale() {
	return this.pojo.getLocale();
	}


	public String getTimeZone() {
	return this.pojo.getTimeZone();
	}


	public Date getDateCreated() {
	return this.pojo.getDateCreated();
	}


	public String getDefaultPlugins() {
	return this.pojo.getDefaultPlugins();
	}

	public Locale getLocaleInstance() {
	return this.pojo.getLocaleInstance();
	}


	public TimeZone getTimeZoneInstance() {
	return this.pojo.getTimeZoneInstance();
	}


	public int getEntryDisplayCount() {
	return this.pojo.getEntryDisplayCount();
	}


	public Boolean getVisible() {
	return this.pojo.getVisible();
	}

	/* deprecated in Roller 5.1 */
	public Boolean getEnabled() {
	return getVisible();
	}

	public Boolean getActive() {
	return this.pojo.getActive();
	}


	public Date getLastModified() {
	return this.pojo.getLastModified();
	}


	public boolean isEnableMultiLang() {
	return this.pojo.isEnableMultiLang();
	}


	public boolean isShowAllLangs() {
	return this.pojo.isShowAllLangs();
	}


	public String getStylesheet() throws WebloggerException {
	// custom stylesheet comes from the weblog theme
	if(this.pojo.getTheme().getStylesheet() != null) {
	return urlStrategy.getWeblogPageURL(this.pojo, null, this.pojo.getTheme().getStylesheet().getLink(), null, null, null, null, 0, false);
	}
	return null;
	}


	/**
	* Get path to weblog icon image if defined.
	*
	* This method is somewhat smart in the sense that it will check the entered
	* icon value and if it is a full url then it will be left alone, but if it
	* is a relative path to a file in the weblog's uploads section then it will
	* build the full url to that resource and return it.
	*/
	public String getIcon() {

	String iconPath = this.pojo.getIconPath();
	if(iconPath == null) {
	return null;
	}

	if(iconPath.startsWith("http") \|\| iconPath.startsWith("/")) {
	// if icon path is a relative path then assume it's a weblog resource
	return iconPath;
	} else {
	// otherwise it's just a plain old url
	return urlStrategy.getWeblogResourceURL(this.pojo, iconPath, false);
	}

	}


	public String getAbout() {
	return HTMLSanitizer.conditionallySanitize(this.pojo.getAbout());
	}



	public String getURL() {
	return this.pojo.getURL();
	}


	public String getAbsoluteURL() {
	return this.pojo.getAbsoluteURL();
	}


	public WeblogEntryWrapper getWeblogEntry(String anchor) {
	return WeblogEntryWrapper.wrap(this.pojo.getWeblogEntry(anchor), urlStrategy);
	}


	public List<WeblogCategoryWrapper> getWeblogCategories() {
	List<WeblogCategory> unwrapped = this.pojo.getWeblogCategories();
	List<WeblogCategoryWrapper> wrapped = new ArrayList<WeblogCategoryWrapper>(unwrapped.size());

	int i = 0;
	for (WeblogCategory category : unwrapped) {
	wrapped.add(i,WeblogCategoryWrapper.wrap(category, urlStrategy));
	i++;
	}
	return wrapped;
	}

	public WeblogCategoryWrapper getWeblogCategory(String categoryName) {
	return WeblogCategoryWrapper.wrap(this.pojo.getWeblogCategory(categoryName), urlStrategy);
	}


	public List<WeblogEntryWrapper> getRecentWeblogEntries(String cat,int length) {
	List<WeblogEntry> unwrapped = this.pojo.getRecentWeblogEntries(cat, length);
	List<WeblogEntryWrapper> wrapped = new ArrayList<WeblogEntryWrapper>(unwrapped.size());

	int i = 0;
	for (WeblogEntry we : unwrapped) {
	wrapped.add(i,WeblogEntryWrapper.wrap(we, urlStrategy));
	i++;
	}
	return wrapped;
	}


	public List<WeblogEntryWrapper> getRecentWeblogEntriesByTag(String tag,int length) {
	List<WeblogEntry> unwrapped = pojo.getRecentWeblogEntriesByTag(tag,length);
	List<WeblogEntryWrapper> wrapped = new ArrayList<WeblogEntryWrapper>(unwrapped.size());

	int i = 0;
	for (WeblogEntry we : unwrapped) {
	wrapped.add(i,WeblogEntryWrapper.wrap(we, urlStrategy));
	i++;
	}
	return wrapped;
	}


	public List<WeblogEntryCommentWrapper> getRecentComments(int length) {
	List<WeblogEntryComment> unwrapped = this.pojo.getRecentComments(length);
	List<WeblogEntryCommentWrapper> wrapped = new ArrayList<WeblogEntryCommentWrapper>(unwrapped.size());

	int i = 0;
	for (WeblogEntryComment wec : unwrapped) {
	wrapped.add(i, WeblogEntryCommentWrapper.wrap(wec, urlStrategy));
	i++;
	}
	return wrapped;
	}


	public WeblogBookmarkFolderWrapper getBookmarkFolder(String folderName) {
	return WeblogBookmarkFolderWrapper.wrap(this.pojo.getBookmarkFolder(folderName));
	}

	public int getTodaysHits() {
	return this.pojo.getTodaysHits();
	}

	public List<TagStat> getPopularTags(int sinceDays,int length) {
	return this.pojo.getPopularTags(sinceDays,length);
	}


	public long getCommentCount() {
	return this.pojo.getCommentCount();
	}


	public long getEntryCount() {
	return this.pojo.getEntryCount();
	}


	/**
	* this is a special method to access the original pojo
	* we don't really want to do this, but it's necessary
	* because some parts of the rendering process still need the
	* original pojo object
	*/
	public Weblog getPojo() {
	return this.pojo;
	}
	}