AbstractWebPartHandler.java

/*
 * Copyright (c) 2006-2009 by Dirk Riehle, http://dirkriehle.com
 *
 * This file is part of the Wahlzeit photo rating application.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public
 * License along with this program. If not, see
 * <http://www.gnu.org/licenses/>.
 */

package org.wahlzeit.handlers;

import org.wahlzeit.model.AccessRights;
import org.wahlzeit.model.ModelConfig;
import org.wahlzeit.model.Photo;
import org.wahlzeit.model.PhotoManager;
import org.wahlzeit.model.PhotoSize;
import org.wahlzeit.model.User;
import org.wahlzeit.model.UserSession;
import org.wahlzeit.services.Language;
import org.wahlzeit.services.LogBuilder;
import org.wahlzeit.services.SysConfig;
import org.wahlzeit.utils.HtmlUtil;
import org.wahlzeit.utils.StringUtil;
import org.wahlzeit.webparts.WebPart;
import org.wahlzeit.webparts.WebPartTemplate;
import org.wahlzeit.webparts.WebPartTemplateService;

import java.io.File;
import java.util.Map;
import java.util.logging.Logger;

/**
 * A superclass for handling parts of web pages.
 */
public abstract class AbstractWebPartHandler implements WebPartHandler {

	private static final Logger log = Logger.getLogger(AbstractWebPartHandler.class.getName());
	/**
	 *
	 */
	protected String tmplName;
	/**
	 *
	 */
	protected AccessRights neededRights;

	/**
	 *
	 */
	protected void initialize(String myTmplName, AccessRights myRights) {
		tmplName = myTmplName;
		neededRights = myRights;
	}

	/**
	 * @methodtype factory
	 */
	protected final WebPart createWebPart(UserSession us) {
		return createWebPart(us, tmplName);
	}

	/**
	 * @methodtype factory
	 */
	protected final WebPart createWebPart(UserSession us, String name) {
		WebPartTemplateService wpts = WebPartTemplateService.getInstance();
		WebPartTemplate tmpl = wpts.getTemplate(us.getClient().getLanguageConfiguration().getLanguageCode(), name);
		return new WebPart(tmpl);
	}

	/**
	 *
	 */
	protected String getPhotoThumb(UserSession us, Photo photo) {
		String result = null;
		if (photo != null) {
			String imageLink = getPhotoAsRelativeResourcePathString(photo, PhotoSize.THUMB);
			result = HtmlUtil.asImg(HtmlUtil.asPath(imageLink), photo.getThumbWidth(), photo.getThumbHeight());
		} else {
			Language langValue = us.getClient().getLanguage();
			result = HtmlUtil.asImg(getEmptyImageAsRelativeResourcePathString(langValue));
		}
		return result;
	}

	/**
	 *
	 */
	protected String getPhotoAsRelativeResourcePathString(Photo photo, PhotoSize size) {
		return SysConfig.getPhotosDir().getRelativeDir() + "/?type=image&photoId=" + photo.getId().asString() +
				"&size=" + String.valueOf(size.asInt());
	}

	/**
	 *
	 */
	protected String getEmptyImageAsRelativeResourcePathString(Language lang) {
		String resName = lang.asIsoCode() + File.separator + "empty.png";
		return HtmlUtil.asPath(SysConfig.getStaticDir().getRelativeConfigFileName(resName));
	}

	/**
	 *
	 */
	protected String getPhotoSummary(UserSession us, Photo photo) {
		return photo.getSummary(us.getClient().getLanguageConfiguration());
	}

	/**
	 *
	 */
	protected String getPhotoCaption(UserSession us, Photo photo) {
		return photo.getCaption(us.getClient().getLanguageConfiguration());
	}

	/**
	 *
	 */
	protected final WebFormHandler getFormHandler(String name) {
		return WebPartHandlerManager.getWebFormHandler(name);
	}

	/**
	 *
	 */
	protected boolean hasSavedPhotoId(UserSession us) {
		String id = us.getAsString(us.getSavedArgs(), Photo.ID);
		return !StringUtil.isNullOrEmptyString(id);
	}

	/**
	 *
	 */
	protected boolean isSavedPhotoVisible(UserSession us) {
		String id = us.getAsString(us.getSavedArgs(), Photo.ID);
		Photo photo = PhotoManager.getInstance().getPhoto(id);
		return photo.isVisible();
	}

	/**
	 *
	 */
	protected boolean hasSavedMessage(UserSession us) {
		return !StringUtil.isNullOrEmptyString(us.getMessage());
	}

	/**
	 *
	 */
	public final String handleGet(UserSession us, String link, Map args) {
		if (!hasAccessRights(us, args)) {
			log.warning(LogBuilder.createSystemMessage().
					addMessage("insufficient rights for GET").toString());
			return getIllegalAccessErrorPage(us);
		}

		if (!isWellFormedGet(us, link, args)) {
			log.warning(LogBuilder.createSystemMessage().
					addMessage("received ill-formed GET").toString());
			return getIllegalArgumentErrorPage(us);
		}

		try {
			// may throw Exception
			return doHandleGet(us, link, args);
		} catch (Throwable t) {
			log.warning(LogBuilder.createSystemMessage().addException("Handle get failed", t).toString());
			return getInternalProcessingErrorPage(us);
		}
	}

	/**
	 *
	 */
	protected boolean hasAccessRights(UserSession us, Map args) {
		return us.getClient().hasRights(getNeededRights());
	}

	/**
	 *
	 */
	protected String getIllegalAccessErrorPage(UserSession us) {
		ModelConfig config = us.getClient().getLanguageConfiguration();
		us.setHeading(config.getInformation());

		String msg1 = config.getIllegalAccessError();
		us.setMessage(msg1);

		return PartUtil.SHOW_NOTE_PAGE_NAME;
	}

	/**
	 *
	 */
	protected boolean isWellFormedGet(UserSession us, String link, Map args) {
		return true;
	}

	/**
	 *
	 */
	protected String getIllegalArgumentErrorPage(UserSession us) {
		ModelConfig config = us.getClient().getLanguageConfiguration();
		us.setHeading(config.getInformation());

		String msg1 = config.getIllegalArgumentError();
		String msg2 = config.getContinueWithShowPhoto();
		if (us.getClient() instanceof User) {
			msg2 = config.getContinueWithShowUserHome();
		}

		us.setTwoLineMessage(msg1, msg2);

		return PartUtil.SHOW_NOTE_PAGE_NAME;
	}

	/**
	 * @param args TODO
	 */
	protected String doHandleGet(UserSession us, String link, Map args) {
		return link;
	}

	/**
	 *
	 */
	protected String getInternalProcessingErrorPage(UserSession us) {
		ModelConfig config = us.getClient().getLanguageConfiguration();
		us.setHeading(config.getInformation());

		String msg1 = config.getInternalProcessingError();
		String msg2 = config.getContinueWithShowPhoto();
		if (us.getClient() instanceof User) {
			msg2 = config.getContinueWithShowUserHome();
		}

		us.setTwoLineMessage(msg1, msg2);

		return PartUtil.SHOW_NOTE_PAGE_NAME;
	}

	/**
	 *
	 */
	public final AccessRights getNeededRights() {
		return neededRights;
	}

	/**
	 *
	 */
	protected String getHeadingImageAsRelativeResourcePathString(Language lang) {
		String resName = lang.asIsoCode() + File.separator + "heading.png";
		return HtmlUtil.asPath(SysConfig.getStaticDir().getRelativeConfigFileName(resName));
	}

	/**
	 *
	 */
	protected String getResourceAsRelativeHtmlPathString(String resource) {
		return resource + ".html";
	}

}