CMSTheme.java

/**
 * Copyright © 2014 Instituto Superior Técnico
 *
 * This file is part of FenixEdu CMS.
 *
 * FenixEdu CMS is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * FenixEdu CMS 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with FenixEdu CMS.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.fenixedu.cms.domain;

import static java.util.stream.Collectors.toSet;

import java.io.BufferedReader;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.Set;
import java.util.function.Predicate;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import java.util.zip.ZipInputStream;

import org.fenixedu.bennu.core.domain.Bennu;
import org.fenixedu.bennu.core.domain.User;
import org.fenixedu.bennu.core.security.Authenticate;
import org.fenixedu.bennu.core.util.CoreConfiguration;
import org.fenixedu.bennu.io.domain.GroupBasedFile;
import org.fenixedu.bennu.signals.DomainObjectEvent;
import org.fenixedu.bennu.signals.Signal;
import org.fenixedu.cms.CMSConfigurationManager;
import org.joda.time.DateTime;

import com.google.common.collect.Sets;
import com.google.common.io.ByteStreams;
import com.google.gson.JsonObject;
import com.google.gson.JsonParser;

import pt.ist.fenixframework.Atomic;
import pt.ist.fenixframework.Atomic.TxMode;

public class CMSTheme extends CMSTheme_Base {


	public static final String SIGNAL_CREATED = "fenixedu.cms.theme.created";
	public static final String SIGNAL_DELETED = "fenixedu.cms.theme.deleted";
	public static final String SIGNAL_EDITED = "fenixedu.cms.theme.edited";

	/**
	 * The logged {@link User} creates a new instance of a {@link CMSTheme}
	 */
	public CMSTheme() {
		this.setCreatedBy(Authenticate.getUser());
		this.setCreationDate(new DateTime());
		Signal.emit(SIGNAL_CREATED, new DomainObjectEvent<>(this));
	}

	/**
	 * Searches for a {@link CMSTheme} with a given type.
	 * 
	 * @param t
	 *            the type of the wanted {@link CMSTheme}.
	 * @return the {@link CMSTheme} with the given type if it exists, or null
	 *         otherwise.
	 */
	public static CMSTheme forType(String t) {
		for (CMSTheme theme : Bennu.getInstance().getCMSThemesSet()) {
			if (theme.getType().equals(t)) {
				return theme;
			}
		}
		return null;
	}

	public static void loadDefaultTheme() {
		InputStream in = CMSTheme.class
				.getResourceAsStream("/META-INF/resources/WEB-INF/cms-default-theme.zip");
		ZipInputStream zin = new ZipInputStream(in);
		CMSThemeLoader.createFromZipStream(zin);
	}

	public static CMSTheme getDefaultTheme() {
		return Bennu
				.getInstance()
				.getCMSThemesSet()
				.stream()
				.filter(x -> x.isDefault())
				.findAny()
				.orElseThrow(
						() -> new RuntimeException("There is no default theme"));
	}

	/**
	 * Searches for a {@link CMSTemplate} with a given type on this theme.
	 * 
	 * @param type type
	 *            the type of the wanted {@link CMSTemplate}.
	 * @return the {@link CMSTemplate} with the given type if it exists, or null
	 *         otherwise.
	 */
	public CMSTemplate templateForType(String type) {
		CMSTemplate found = getTemplatesSet().stream()
				.filter(template -> template.getType().equals(type))
				.findFirst().orElse(null);
		if (found == null && getExtended() != null) {
			return getExtended().templateForType(type);
		} else {
			return found;
		}
	}

	/**
	 * Searches for a {@link CMSThemeFile} with a given name on this theme.
	 * 
	 * @param path
	 *            the displayName of the wanted {@link CMSThemeFile}.
	 * @return the {@link CMSThemeFile} with the given displayName if it exists,
	 *         or null otherwise.
	 */
	public CMSThemeFile fileForPath(String path) {
		CMSThemeFile file = getFiles().getFileForPath(path);
		if (file == null && getExtended() != null) {
			return getExtended().fileForPath(path);
		} else {
			return file;
		}
	}

	private static String getTypeForThemeFolder(String path) {
		try {
			FileInputStream fin = new FileInputStream(path + "/theme.json");
			JsonObject el = new JsonParser().parse(
					new BufferedReader(new InputStreamReader(fin)))
					.getAsJsonObject();
			return el.get("type").getAsString();
		} catch (FileNotFoundException e) {
			e.printStackTrace();
			return null;
		}
	}

	public byte[] contentForPath(String t) {
		String themeDevelopmentDirectory = CMSConfigurationManager
				.getConfiguration().themeDevelopmentDirectory();
		if (CoreConfiguration.getConfiguration().developmentMode()
				&& CMSConfigurationManager.isInThemeDevelopmentMode()
				&& this.getType().equals(
						getTypeForThemeFolder(themeDevelopmentDirectory))) {
			try {
				return ByteStreams.toByteArray(new FileInputStream(
						themeDevelopmentDirectory + t));
			} catch (FileNotFoundException e) {
				if (this.getExtended() != null) {
					return this.getExtended().contentForPath(t);
				} else {
					return null;
				}
			} catch (IOException e) {
				return null;
			}
		} else {
			CMSThemeFile file = this.fileForPath(t);
			return file == null ? null : file.getContent();
		}
	}

	public boolean definesPath(String string) {
		// FIXME Find a better way to do this!
		return contentForPath(string) != null;
	}

	/**
	 * 
	 * @return true if this is the default theme for the CMS, and false
	 *         otherwise.
	 */
	public boolean isDefault() {
		return Bennu.getInstance().getDefaultCMSTheme() == this;
	}

	@Atomic(mode = TxMode.WRITE)
	public void delete() {
		if (this.getChildrenSet().size() != 0) {
			throw new RuntimeException(
					"Themes depend of this theme. Can't delete");
		}

		Signal.emit(SIGNAL_DELETED, new DomainObjectEvent<>(this));
		this.setPrimaryBennu(null);
		this.setBennu(null);

		for(Site site : getSitesSet()){
			site.setTheme(null);
		}

		if(this.isDefault()) {
			if (Bennu.getInstance().getCMSThemesSet().size() == 0) {
				Bennu.getInstance().setDefaultCMSTheme(null);
			} else {
				Bennu.getInstance().setDefaultCMSTheme(
						Bennu.getInstance().getCMSThemesSet().iterator().next());
			}
		}

		this.setCreatedBy(null);
		this.setExtended(null);

		this.getTemplatesSet().forEach(CMSTemplate::delete);

		if (getPreviewImage() != null){
			GroupBasedFile f = getPreviewImage();
			setPreviewImage(null);
			f.delete();
		}
		
		this.deleteDomainObject();

	}

	public String getAssetsPath() {
		return CoreConfiguration.getConfiguration().applicationUrl()
				+ "/cms/assets/" + getType() + "/" + getFiles().getChecksum();
	}

	@Atomic
	public void changeFiles(CMSThemeFiles files) {
		if (getFiles() == null || !getFiles().checksumMatches(files)) {
			setFiles(files);
		}
	}

	public Set<CMSTemplate> getAllTemplates() {
		return Sets.union(getTemplatesSet(), getExtendedTemplates());
	}

	public Set<CMSTemplate> getExtendedTemplates() {
		if (getExtended() != null) {
			Set<String> myTemplateTypes = getTemplatesSet().stream()
					.map(CMSTemplate::getType).collect(toSet());
			Predicate<CMSTemplate> isInherited = parentTemplate -> myTemplateTypes
					.contains(parentTemplate.getType());
			return getExtended().getAllTemplates().stream()
					.filter(isInherited.negate()).collect(toSet());
		} else {
			return Sets.newHashSet();
		}
	}

	public Stream<Site> getAllSitesStream()  {
		return Bennu.getInstance().getSitesSet().stream()
				.filter(site -> getType().equals(site.getThemeType()));
	}

	@Override
	public Set<Site> getSitesSet() {
		return getAllSitesStream().collect(Collectors.toSet());
	}
}