AbstractWebPageHandler.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.Client;
import org.wahlzeit.model.ModelConfig;
import org.wahlzeit.model.UserSession;
import org.wahlzeit.services.ConfigDir;
import org.wahlzeit.services.Language;
import org.wahlzeit.services.SysConfig;
import org.wahlzeit.utils.HtmlUtil;
import org.wahlzeit.webparts.WebPart;

/**
 * A superclass for handling web pages.
 */
public abstract class AbstractWebPageHandler extends AbstractWebPartHandler implements WebPageHandler {

	/**
	 *
	 */
	public WebPart makeWebPart(UserSession us) {
		return makeWebPage(us);
	}

	/**
	 *
	 */
	public WebPart makeWebPage(UserSession us) {
		WebPart result = createWebPart(us);

		ConfigDir staticDir = SysConfig.getStaticDir();
		String stylesheetUrl = HtmlUtil.asPath(staticDir.getRelativeConfigFileName("wahlzeit.css"));
		result.addString("stylesheet", stylesheetUrl);
		String javascriptUrl = HtmlUtil.asPath(staticDir.getRelativeConfigFileName("wahlzeit.js"));
		result.addString("javascript", javascriptUrl);

		makeWebPageFrame(us, result);
		makeWebPageMenu(us, result);
		makeWebPageBody(us, result);

		return result;
	}

	/**
	 *
	 */
	protected void makeWebPageFrame(UserSession us, WebPart page) {
		Client client = us.getClient();
		page.addString("title", client.getLanguageConfiguration().getPageTitle());

		makeWebPageHeading(us, page);

		page.addString("footer", client.getLanguageConfiguration().getPageFooter(client.getPhotoSize()));
		page.addString("mission", client.getLanguageConfiguration().getPageMission());
	}

	/**
	 *
	 */
	protected void makeWebPageHeading(UserSession us, WebPart page) {
		Language langValue = us.getClient().getLanguage();
		String heading = HtmlUtil.asImg(getHeadingImageAsRelativeResourcePathString(langValue));
		heading = HtmlUtil.asHref(us.getSiteUrl(), heading);
		page.addString("heading", heading);
	}

	/**
	 * @methodtype boolean-query
	 */
	protected boolean isToShowAds(UserSession us) {
		return false;
	}

	/**
	 *
	 */
	protected void makeWebPageMenu(UserSession us, WebPart page) {
		Client client = us.getClient();
		String menu = "";
		ModelConfig config = client.getLanguageConfiguration();

		if (client.hasAdministratorRights()) {
			menu = config.getAdministratorMenu();
		} else if (client.hasModeratorRights()) {
			menu = config.getModeratorMenu();
		} else if (client.hasUserRights()) {
			menu = config.getUserMenu();
		} else {
			menu = config.getGuestMenu();
		}

		page.addString("menu", menu.toString());
	}

	/**
	 *
	 */
	protected void makeWebPageBody(UserSession us, WebPart page) {
		// do nothing by default
	}

}