com.sandpolis.server.vanilla.gen.Generator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sandpolis-server-vanilla Show documentation
The server instance
There is a newer version: 6.1.0
Show newest version
/******************************************************************************
 *                                                                            *
 *                    Copyright 2017 Subterranean Security                    *
 *                                                                            *
 *  Licensed 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.                                            *
 *                                                                            *
 *****************************************************************************/
package com.sandpolis.server.vanilla.gen;

import java.util.Objects;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.sandpolis.core.proto.util.Generator.GenConfig;
import com.sandpolis.core.proto.util.Generator.GenReport;
import com.sandpolis.server.vanilla.gen.packager.BatPackager;
import com.sandpolis.server.vanilla.gen.packager.ElfPackager;
import com.sandpolis.server.vanilla.gen.packager.ExePackager;
import com.sandpolis.server.vanilla.gen.packager.JarPackager;
import com.sandpolis.server.vanilla.gen.packager.PyPackager;
import com.sandpolis.server.vanilla.gen.packager.QrPackager;
import com.sandpolis.server.vanilla.gen.packager.RbPackager;
import com.sandpolis.server.vanilla.gen.packager.ShPackager;
import com.sandpolis.server.vanilla.gen.packager.UrlPackager;

/**
 * The parent class of all output generators.
 * 
 * @author cilki
 * @since 4.0.0
 */
public abstract class Generator {

	private static final Logger log = LoggerFactory.getLogger(Generator.class);

	/**
	 * The generator's configuration.
	 */
	protected GenConfig config;

	/**
	 * The generation report.
	 */
	protected GenReport.Builder report;

	/**
	 * The intermediate result of the generation.
	 */
	protected byte[] result;

	/**
	 * The packager which is responsible for producing the final output.
	 */
	protected Packager packager;

	protected Generator(GenConfig config) {
		this.config = Objects.requireNonNull(config);

		switch (config.getFormat()) {
		case BAT:
			packager = BatPackager.INSTANCE;
			break;
		case ELF:
			packager = ElfPackager.INSTANCE;
			break;
		case EXE:
			packager = ExePackager.INSTANCE;
			break;
		case JAR:
			packager = JarPackager.INSTANCE;
			break;
		case PY:
			packager = PyPackager.INSTANCE;
			break;
		case QR:
			packager = QrPackager.INSTANCE;
			break;
		case RB:
			packager = RbPackager.INSTANCE;
			break;
		case SH:
			packager = ShPackager.INSTANCE;
			break;
		case URL:
			packager = UrlPackager.INSTANCE;
			break;
		default:
			throw new IllegalArgumentException();
		}
	}

	/**
	 * Performs the generation synchronously.
	 */
	protected abstract Object run() throws Exception;

	public void generate() throws Exception {
		if (report != null)
			throw new IllegalStateException("The generator has already been started");

		report = GenReport.newBuilder().setTimestamp(System.currentTimeMillis())
				.setDuration(System.currentTimeMillis());

		try {
			result = packager.process(config, run());
		} finally {
			report.setDuration(System.currentTimeMillis() - report.getDuration());
			log.debug("Generation completed in {} ms", report.getDuration());
		}
	}

	/**
	 * Get the generation report. Each invocation of this method returns a new (yet
	 * equivalent) object.
	 * 
	 * @return The completed generation report
	 */
	public GenReport getReport() {
		if (report == null)
			throw new IllegalStateException("The generator has not been started");

		return report.build();
	}

	/**
	 * Get the generation result.
	 * 
	 * @return The final result
	 */
	public byte[] getResult() {
		return result;
	}

}