File.java

/**
 * Copyright (c) 2005-2006 Aptana, Inc.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html. If redistributing this code,
 * this entire header must remain intact.
 */
package org.eclipse.eclipsemonkey.lang.javascript.doms.io;

import java.io.BufferedReader;
import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.util.ArrayList;

import org.mozilla.javascript.Context;
import org.mozilla.javascript.Function;
import org.mozilla.javascript.FunctionObject;
import org.mozilla.javascript.Scriptable;
import org.mozilla.javascript.ScriptableObject;

/**
 * Simple File wrapper.
 * 
 * @author Kevin Lindsey
 */
public class File extends ScriptableObject
{
	private static final long serialVersionUID = 622033917776635991L;
	private java.io.File file;

	/**
	 * Create a new instance of File From Norris Boyd's sample: When Context.defineClass is called with this class, it
	 * will construct File.prototype using this constructor.
	 */
	public File()
	{
	}

	/**
	 * finishInit
	 * 
	 * @param scope
	 * @param constructor
	 * @param prototype
	 */
	public static void finishInit(Scriptable scope, FunctionObject constructor, Scriptable prototype)
	{
		constructor.defineProperty("separator", java.io.File.separator, READONLY | PERMANENT); //$NON-NLS-1$
	}

	/**
	 * Returns the name of this JavaScript class, "File".
	 * 
	 * @return String
	 */
	public String getClassName()
	{
		return "File"; //$NON-NLS-1$
	}

	/**
	 * Construct a new JS File object
	 * 
	 * @param cx
	 * @param args
	 * @param ctorObj
	 * @param inNewExpr
	 * @return Scriptable
	 */
	public static Scriptable jsConstructor(Context cx, Object[] args, Function ctorObj, boolean inNewExpr)
	{
		File result = new File();
		Object arg = args[0];

		if (arg instanceof java.io.File)
		{
			// we use this to create File instances internally directly from java.io.File instances
			// this probably won't ever be used from script
			result.file = (java.io.File) arg;
		}
		else
		{
			String name = Context.toString(arg);

			result.file = new java.io.File(name);
		}

		return result;
	}

	/**
	 * Create a new text file for this File
	 * 
	 * @return boolean
	 */
	public boolean jsFunction_createNewFile()
	{
		boolean result = false;

		try
		{
			result = this.file.createNewFile();
		}
		catch (IOException e)
		{
			System.err.println("Error: " + e); //$NON-NLS-1$
		}

		return result;
	}

	/**
	 * Create a new directory for this File
	 * 
	 * @param recursive
	 * @return boolean
	 */
	public boolean jsFunction_createDirectory(boolean recursive)
	{
		boolean result = false;

		if (recursive)
		{
			result = this.file.mkdirs();
		}
		else
		{
			result = this.file.mkdir();
		}

		return result;
	}

	/**
	 * jsFunction_delete
	 * 
	 * @return true on successful deletion, false on failure
	 */
	public boolean jsFunction_deleteFile()
	{
		boolean result = false;
		
		if (this.file != null)
		{
			result = this.file.delete();
		}
		
		return result;
	}
	
	/**
	 * jsFunction_deleteOnExit
	 */
	public void jsFunction_deleteOnExit()
	{
		if (this.file != null)
		{
			this.file.deleteOnExit();
		}
	}

	/**
	 * readLines
	 * 
	 * @return A string array of all lines in the file
	 */
	public Scriptable jsFunction_readLines()
	{
		Context cx = Context.getCurrentContext();
		ArrayList lines = new ArrayList();
		BufferedReader br = null;

		try
		{
			FileReader fr = new FileReader(this.file);

			br = new BufferedReader(fr);

			String line = br.readLine();

			while (line != null)
			{
				lines.add(line);
				line = br.readLine();
			}
		}
		catch (FileNotFoundException e)
		{
			System.err.println("Error: " + e); //$NON-NLS-1$
		}
		catch (IOException e)
		{
			System.err.println("Error: " + e); //$NON-NLS-1$
		}
		finally
		{
			if (br != null)
			{
				try
				{
					br.close();
				}
				catch (IOException e)
				{
					System.err.println("Error: " + e); //$NON-NLS-1$
				}
			}
		}

		return cx.newArray(this.getParentScope(), lines.toArray());
	}

	/**
	 * write
	 * 
	 * @param text
	 * @return boolean
	 */
	public boolean jsFunction_write(String text)
	{
		try
		{
			FileWriter fw = new FileWriter(this.file);
			fw.write(text);
			fw.close();
		}
		catch (IOException e)
		{
			System.err.println("Error: " + e); //$NON-NLS-1$
			return false;
		}

		return true;
	}

	/**
	 * @return String
	 */
	public String jsGet_absolutePath()
	{
		return this.file.getAbsolutePath();
	}

	/**
	 * @return String
	 */
	public String jsGet_baseName()
	{
		String name = this.file.getName();
		int index = name.lastIndexOf('.');
		String result = name;

		if (index != -1)
		{
			result = name.substring(0, index);
		}

		return result;
	}

	/**
	 * @return boolean
	 */
	public boolean jsGet_canRead()
	{
		return this.file.canRead();
	}

	/**
	 * @return boolean
	 */
	public boolean jsGet_canWrite()
	{
		return this.file.canWrite();
	}

	/**
	 * @return boolean
	 */
	public boolean jsGet_exists()
	{
		return this.file.exists();
	}

	/**
	 * @return String
	 */
	public String jsGet_extension()
	{
		String name = this.file.getName();
		int index = name.lastIndexOf('.');
		String result = ""; //$NON-NLS-1$

		if (index != -1)
		{
			result = name.substring(index);
		}

		return result;
	}

	/**
	 * @return boolean
	 */
	public boolean jsGet_isFile()
	{
		return this.file.isFile();
	}

	/**
	 * @return boolean
	 */
	public boolean jsGet_isDirectory()
	{
		return this.file.isDirectory();
	}

	/**
	 * @return Scriptable
	 */
	public Scriptable jsGet_list()
	{
		Context cx = Context.getCurrentContext();
		Scriptable scope = this.getParentScope();
		String baseName = this.file.getAbsolutePath() + java.io.File.separator;
		String[] names = this.file.list();
		int length = names.length;
		Object[] result = new Object[length];

		for (int i = 0; i < length; i++)
		{
			String name = baseName + names[i];
			result[i] = cx.newObject(scope, "File", new Object[] { name }); //$NON-NLS-1$
		}

		return cx.newArray(scope, result);
	}

	/**
	 * Get the name of the file.
	 * 
	 * @return String
	 */
	public String jsGet_name()
	{
		return this.file.getName();
	}

	/**
	 * Get the parent directory for this file
	 * 
	 * @return Returns a new File object or undefined
	 */
	public Scriptable jsGet_parentFile()
	{
		Context cx = Context.getCurrentContext();
		Scriptable scope = this.getParentScope();
		String parent = this.file.getParent();

		return cx.newObject(scope, "File", new Object[] { parent }); //$NON-NLS-1$
	}
}