/*
* Copyright (c) 1998-2008 Caucho Technology -- all rights reserved
*
* This file is part of Resin(R) Open Source
*
* Each copy or derived work must preserve the copyright notice and this
* notice unmodified.
*
* Resin Open Source is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* Resin Open Source 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, or any warranty
* of NON-INFRINGEMENT. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with Resin Open Source; if not, write to the
*
* Free Software Foundation, Inc.
* 59 Temple Place, Suite 330
* Boston, MA 02111-1307 USA
*
* @author Scott Ferguson
*/
package com.caucho.quercus.lib.file;
import com.caucho.quercus.QuercusModuleException;
import com.caucho.quercus.env.Env;
import com.caucho.quercus.env.EnvCleanup;
import com.caucho.quercus.env.Value;
import com.caucho.vfs.Path;
import com.caucho.vfs.WriteStream;
import com.caucho.vfs.LockableStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* Represents a PHP open file
*/
public class FileOutput extends AbstractBinaryOutput
implements LockableStream, EnvCleanup
{
private static final Logger log
= Logger.getLogger(FileOutput.class.getName());
private Env _env;
private Path _path;
private WriteStream _os;
public FileOutput(Env env, Path path)
throws IOException
{
this(env, path, false);
}
public FileOutput(Env env, Path path, boolean isAppend)
throws IOException
{
_env = env;
env.addCleanup(this);
_path = path;
if (isAppend)
_os = path.openAppend();
else
_os = path.openWrite();
}
/**
* Returns the write stream.
*/
public OutputStream getOutputStream()
{
return _os;
}
/**
* Returns the file's path.
*/
public Path getPath()
{
return _path;
}
/**
* Prints a string to a file.
*/
public void print(char v)
throws IOException
{
if (_os != null)
_os.print(v);
}
/**
* Prints a string to a file.
*/
public void print(String v)
throws IOException
{
if (_os != null)
_os.print(v);
}
/**
* Writes a character
*/
public void write(int ch)
throws IOException
{
if (_os != null)
_os.write(ch);
}
/**
* Writes a buffer to a file.
*/
public void write(byte []buffer, int offset, int length)
throws IOException
{
if (_os != null)
_os.write(buffer, offset, length);
}
/**
* Flushes the output.
*/
public void flush()
throws IOException
{
if (_os != null)
_os.flush();
}
/**
* Closes the file.
*/
public void closeWrite()
{
close();
}
/**
* Closes the file.
*/
public void close()
{
_env.removeCleanup(this);
cleanup();
}
/**
* Implements the EnvCleanup interface.
*/
public void cleanup()
{
try {
WriteStream os = _os;
_os = null;
if (os != null)
os.close();
} catch (IOException e) {
log.log(Level.FINE, e.toString(), e);
}
}
/**
* Lock the shared advisory lock.
*/
public boolean lock(boolean shared, boolean block)
{
return _os.lock(shared, block);
}
/**
* Unlock the advisory lock.
*/
public boolean unlock()
{
return _os.unlock();
}
public Value stat()
{
return FileModule.statImpl(_env, getPath());
}
/**
* Returns the current location in the file.
*/
public long getPosition()
{
if (_os == null)
return -1;
return _os.getPosition();
}
/**
* Sets the current location in the stream
*/
public boolean setPosition(long offset)
{
if (_os == null)
return false;
try {
return _os.setPosition(offset);
} catch (IOException e) {
throw new QuercusModuleException(e);
}
}
/**
* Converts to a string.
* @param env
*/
public String toString()
{
return "FileOutput[" + getPath() + "]";
}
}