[Babeldoc-devel] babeldoc/modules/core/src/com/babeldoc/core/pipeline/stage VFSReaderPipelineStage

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/pipeline/stage
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv14140/modules/core/src/com/babeldoc/core/pipeline/stage

Added Files:
	VFSReaderPipelineStage.java 
Log Message:
Add VFS Pipeline Stage

--- NEW FILE: VFSReaderPipelineStage.java ---
/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2000 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact ap...@ap....
 *
 * 5. Products derived from this software may not be called "Apache",
 *    nor may "Apache" appear in their name, without prior written
 *    permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 * Portions of this software are based upon public domain software
 * originally written at the National Center for Supercomputing Applications,
 * University of Illinois, Urbana-Champaign.
 * ====================================================================
 *
 * Babeldoc:  The Universal Document Processor
 *
 * $Header: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/pipeline/stage/VFSReaderPipelineStage.java,v 1.1 2008/01/11 12:03:46 paspes Exp $
 * $DateTime$
 * $Author: paspes $
 *
 */
package com.babeldoc.core.pipeline.stage;

import com.babeldoc.core.LogService;
import com.babeldoc.core.ResourceLoader;
import com.babeldoc.core.I18n;
import com.babeldoc.core.option.ConfigOption;
import com.babeldoc.core.option.IConfigOptionType;
import com.babeldoc.core.pipeline.*;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;

import org.apache.commons.vfs.FileContent;
import org.apache.commons.vfs.FileObject;
import org.apache.commons.vfs.FileSystemException;
import org.apache.commons.vfs.FileSystemManager;
import org.apache.commons.vfs.FileSystemOptions;
import org.apache.commons.vfs.FileType;
import org.apache.commons.vfs.VFS;
import org.apache.commons.vfs.auth.StaticUserAuthenticator;
import org.apache.commons.vfs.impl.DefaultFileSystemConfigBuilder;

/**
 * The reader pipeline stage loads the file (or object) from the filename (could also
 * be a URL) into the current document, completely overwriting it.
 *
 * @author bmcdonald
 * @version 1.1
 */
public class VFSReaderPipelineStage extends PipelineStage {

	private LogService log = LogService.getInstance(this.getClass().getName());

  /** file configuration option. */
  public static final String FILE = "file";

  public static final String DOMAIN = "domain";
  public static final String USERNAME = "username";
  public static final String PASSWORD = "password";

  /** construct with this stages info. */
  public VFSReaderPipelineStage() {
    super(new PipelineStageInfo() {
        public String getName() {
          return "VFSReader";
        }

        public String getDescription() {
          return I18n.get("core.pipeline.stage.vfsreader.description");
        }

        public Collection getTypeSpecificOptions() {
          Collection options = new ArrayList();

          options.add(new ConfigOption(FILE, IConfigOptionType.URL, null, true,
              I18n.get("core.pipeline.stage.vfsreader.opt.file")));

          options.add(new ConfigOption(DOMAIN, IConfigOptionType.STRING, null, false,
                  I18n.get("core.pipeline.stage.vfsreader.opt.domain")));

          options.add(new ConfigOption(USERNAME, IConfigOptionType.STRING, null, false,
                  I18n.get("core.pipeline.stage.vfsreader.opt.username")));

          options.add(new ConfigOption(PASSWORD, IConfigOptionType.STRING, null, false,
                  I18n.get("core.pipeline.stage.vfsreader.opt.password")));

          return options;
        }
      });
  }

  /**
   * Method that access to file 
   * @return fileobject
   * @throws PipelineException
   */
  private FileObject getFileObject(String filename) throws PipelineException {

	  	try{
			  //Acces to file
			  FileSystemManager fsManager = VFS.getManager();
			  if(log.isDebugEnabled()){
				  log.logDebug("Authentication info, domain:" + this.getOptions(DOMAIN)
						  + " username:" + this.getOptions(USERNAME)
						  + " password:" + this.getOptions(PASSWORD));
			  }
			  StaticUserAuthenticator auth = new StaticUserAuthenticator(
					  this.getOptions(DOMAIN), this.getOptions(USERNAME), this.getOptions(PASSWORD));
			  FileSystemOptions opts  = new FileSystemOptions();
			  DefaultFileSystemConfigBuilder.getInstance().setUserAuthenticator(opts, auth);

			  FileObject file = fsManager.resolveFile(filename,opts);
			  if (!file.exists() || !file.isReadable() || file.getType() != FileType.FILE) {
				  throw new PipelineException("File not accesible:" + filename);
			  }
			  return file;
		  } catch (FileSystemException fse) {
		        throw new PipelineException("", fse);  
		  }
  }

  /**
   * pipeline stage.
   *
   * @return array of results
   * @throws PipelineException 
   */
  public PipelineStageResult[] process() throws PipelineException {

	  String filename = this.getOptions(FILE);
	  if(log.isDebugEnabled()) 
		  log.logDebug("Loading filename: "+filename);

	  if(filename!=null) {
		  try {
			  FileObject file = getFileObject(filename);

			  //Read file (getting message from file)
			  FileContent fileContent = file.getContent();

			  byte[] data = new byte[1024];
			  InputStream fis = fileContent.getInputStream();
			  ByteArrayOutputStream baos = new ByteArrayOutputStream((int) fileContent.getSize());

			  int charsRead = 0;
              while ((charsRead = fis.read(data)) != -1) {
					baos.write(data, 0, charsRead);
			  }

              //creat new pipeline document
              PipelineDocument newDoc = new PipelineDocument(this.getDocument(), baos.toByteArray());
    	      newDoc.setMimeType(PipelineDocument.getMimeTypeForFile(filename));
    	      newDoc.put(PipelineDocument.NAME, filename);
    	      return super.processHelper(newDoc);

		  } catch (FileSystemException fse) {
		        throw new PipelineException("", fse);
		  } catch (IOException ioe) {
		        throw new PipelineException("", ioe);
		  }
    }

    return super.processHelper();
  }
}

[Babeldoc-devel] babeldoc/modules/core/src/com/babeldoc/core/pipeline/stage VFSReaderPipelineStage

[Babeldoc-devel] babeldoc/modules/core/src/com/babeldoc/core/pipeline/stage VFSReaderPipelineStage.java, NONE, 1.1