io.odysz.common.EnvPath Maven / Gradle / Ivy

Go to download
package io.odysz.common;

import static io.odysz.common.LangExt.isNull;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.apache.commons.io_odysz.FilenameUtils;

import io.odysz.semantics.ISemantext;

/**
 * A helper to handler environment variable affecting file path.
 * Suppose $VOLUME_HOME = "/home/ody/volume"
 *  args: $VOLUME_HOME/shares,uri,userId,cate,docName
 encoded: $VOLUME_HOME/shares/ody/000001 f.txt:
 decoded: /home/ody/volume/shares/000001 f.txt
 * relative upload folder: args: upload,uri,userId,cate,docName
 encoded: upload/admin/000002 f.txt
 decoded: src/test/res/upload/admin/000002 f.txt
 * absoluted upload folder: args: /home/ody/upload,uri,userId,cate,docName
 encoded: /home/ody/upload/admin/000003 f.txt
 decoded: /home/ody/upload/admin/000003 f.txt

 * Since v1.4.2, system property has higher priority than environment variable.
 * @author Odys Zhou
 *
 */
public class EnvPath {
	static String regSrc = "\\$(\\w+)";
	static Regex reg = new Regex(regSrc);

	static Map sysenv;

	static { sysenv = System.getenv(); }
	
	/**
	 * Extend system variables.
	 * @param k
	 * @param v
	 * @since 1.4.45
	 */
	public static void extendEnv(String k, String v) {
		Map env2 = new HashMap(sysenv.size() + 1);
		for (String sk : sysenv.keySet())
			env2.put(sk, sysenv.get(sk));
		env2.put(k, v);
		sysenv = env2;
	}

	/**
	 * Format a replaced string with the configured map of environment variables.
	 * @see #replaceEnv(String, Map)
	 * @see #extendEnv(String, String)
	 * @since 1.5.0
	 * @param src
	 * @return string replaced with environment variables
	 */
	public static String replaceEnv(String src) {
		return replaceEnv(src, sysenv);
	}
	
	/**
	 * Replace environment variable, e.g. used for setting up file paths.
	 * 
	 * FYI.
	 * 
	 * Semantic-* will be used in the future mainly in docker container.
	 * In docker, volume can not be mounted to tomcat/webapp's sub folder - will prevent war unpacking.
	 * See this problem.
	 * 
	 * So it's necessary have file paths not only relative, but also can be
	 * parsed for replacing environment variables.
	 * 
	 * @param src string have bash style variable to be replaced, e.g. $HOME/volume.sqlite
	 * @return string replaced with environment variables
	 * @since 1.5.0
	 */
	public static String replaceEnv(String src, Map sysenvs) {
		List envs = reg.findGroups(src);
		if (envs != null) {
			// Map sysenvs = System.getenv();

			for (String env : envs) {
				String v = System.getProperty(env);
				v = v == null ? sysenvs.get(env) : v;
				if (v != null) // still can be null
					src = src.replaceAll("\\$" + env, FilenameUtils.winpath2unix(v));
				else
					src = src.replaceAll("\\$" + env, "");
			}
		}
		if (src.startsWith("\\$"))
			Utils.warn("Requried env variable may not parsed correctly: %s", src);
		return src;
	
	}

	/**Decode URI - convert file records' uri into absolute path, according to env.
	 *
	 * @see FilenameUtils#concat(String, String)
	 *
	 * @param root (optinal) runtiem root path
	 * @param uri, the saved path with env variables. Make sure are ":" are cleaned.
	 * @return decode then concatenated absolute path, for file accessing.
	 */
	public static String decodeUri(String root, String uri) {
		root = root == null ? "" : root;
		return FilenameUtils.concat(replaceEnv(root), replaceEnv(uri));
	}

	public static String decodeUri(ISemantext stx, String uri) {
		return decodeUri(stx.containerRoot(), uri);
	}

	/**
	 * Replace env token in {@code root} and concat the path.
	 * 
	 * @param root
	 * @param subpath
	 * @param filename
	 * @return return of {@link FilenameUtils#concat(String, String...)}
	 */
	public static String decodeUri(String root, String subpath, String filename) {
		root = root == null ? "" : root;
		return FilenameUtils.concat(replaceEnv(root), replaceEnv(subpath), filename);
	}

	public static String decodeUri(String root, String subpath, String folder2, String filename) {
		root = root == null ? "" : root;
		return FilenameUtils.concat(replaceEnv(root), replaceEnv(subpath), replaceEnv(folder2), filename);
	}

	/**
Convert raw uri to saving uri for DB persisting - can be decoded according to env.
	 * E.g.

	 * configRoot: $VOLUME_HOME/shares, uri: f.jpg 

	 * --> /home/ody/volume/shares/f.jpg 

	 * configRoot: upload/a_users, uri: f.jpg 

	 * --> [webroot/]upload/a_users/f.jpg
	 * @param configRoot relative/absolute path with env variables
	 * @param uri sub-path(s), file path, in concatenating order
	 * @return encoded uri (with env variable) for DB persisting
	 */
	public static String encodeUri(String configRoot, String... uri) {
		return FilenameUtils.concat(configRoot, uri);
	}

	//// task 1.5.0
	static String workdir = "";
	static String web_inf = "WEB-INF";

	/**
	 * Set working dir.
	 * Must be called before initialize singleton or any configurations.
	 *
	 * @since 1.4.25
	 * @param absWorkDir
	 */
	public static void workDir(String absWorkDir) {
	}

	/**
	 * Get absolute dir to WEB-INF.
	 *
	 * @since 1.4.25
	 * @param webInf
	 * @return abs path
	 */
	public static String webINF(String... webInf) {
		web_inf = isNull(webInf) ? "WEB-INF" : webInf[0];
		return FilenameUtils.concat(workdir, web_inf);
	}

	public static String xml(String xml) {
		return FilenameUtils.concat(workdir, webINF(), xml);
	}
}