Open Source Repository

Home /mail/mail-1.4.1 | Repository Home


com/sun/mail/util/UUEncoderStream.java
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 *
 * Contributor(s):
 *
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

/*
 * @(#)UUEncoderStream.java  1.5 07/05/04
 */

package com.sun.mail.util;

import java.io.*;

/**
 * This class implements a UUEncoder. It is implemented as
 * a FilterOutputStream, so one can just wrap this class around
 * any output stream and write bytes into this filter. The Encoding
 * is done as the bytes are written out.
 
 @author John Mani
 */

public class UUEncoderStream extends FilterOutputStream {
    private byte[] buffer;   // cache of bytes that are yet to be encoded
    private int bufsize = 0;  // size of the cache
    private boolean wrotePrefix = false;

    protected String name;   // name of file
    protected int mode;    // permissions mode

    /**
     * Create a UUencoder that encodes the specified input stream
     @param out        the output stream
     */
    public UUEncoderStream(OutputStream out) {
  this(out, "encoder.buf"644);
    }

    /**
     * Create a UUencoder that encodes the specified input stream
     @param out        the output stream
     @param name   Specifies a name for the encoded buffer
     */
    public UUEncoderStream(OutputStream out, String name) {
  this(out, name, 644);  
    }

    /**
     * Create a UUencoder that encodes the specified input stream
     @param out        the output stream
     @param name       Specifies a name for the encoded buffer
     @param mode   Specifies permission mode for the encoded buffer
     */
    public UUEncoderStream(OutputStream out, String name, int mode) {
  super(out);
  this.name = name;
  this.mode = mode;
  buffer = new byte[45];
    }

    /**
     * Set up the buffer name and permission mode.
     * This method has any effect only if it is invoked before
     * you start writing into the output stream
     */
    public void setNameMode(String name, int mode) {
  this.name = name;
  this.mode = mode;
    }

    public void write(byte[] b, int off, int lenthrows IOException {
  for (int i = 0; i < len; i++)
      write(b[off + i]);
    }

    public void write(byte[] datathrows IOException {
  write(data, 0, data.length);
    }

    public void write(int cthrows IOException {
  /* buffer up characters till we get a line's worth, then encode
   * and write them out. Max number of characters allowed per 
   * line is 45.
   */
  buffer[bufsize++(byte)c;
  if (bufsize == 45) {
      writePrefix();
      encode();
      bufsize = 0;
  }
    }

    public void flush() throws IOException {
  if (bufsize > 0) { // If there's unencoded characters in the buffer
      writePrefix();
      encode();      // .. encode them
  }
  writeSuffix();
  out.flush();
    }

    public void close() throws IOException {
  flush();
  out.close();
    }

    /**
     * Write out the prefix: "begin <mode> <name>"
     */
    private void writePrefix() throws IOException {
  if (!wrotePrefix) {
      PrintStream ps = new PrintStream(out);
      ps.println("begin " + mode + " " + name);
      ps.flush();
      wrotePrefix = true;
  }
    }

    /**
     * Write a single line containing space and the suffix line
     * containing the single word "end" (terminated by a newline)
     */
    private void writeSuffix() throws IOException {
  PrintStream ps = new PrintStream(out);
  ps.println(" \nend");
  ps.flush();
    }

    /**
     * Encode a line. 
     * Start off with the character count, followed by the encoded atoms
     * and terminate with LF. (or is it CRLF or the local line-terminator ?)
     * Take three bytes and encodes them into 4 characters
     * If bufsize if not a multiple of 3, the remaining bytes are filled 
     * with '1'. This insures that the last line won't end in spaces 
     * and potentiallly be truncated.
     */
    private void encode() throws IOException {
  byte a, b, c;
  int c1, c2, c3, c4;
  int i = 0;

  // Start off with the count of characters in the line
  out.write((bufsize & 0x3f' ');

  while (i < bufsize) {
      a = buffer[i++];
      if (i < bufsize) {
    b = buffer[i++];
    if (i < bufsize)
        c = buffer[i++];
    else // default c to 1
        c = 1;
      }
      else // default b & c to 1
    b = 1;
    c = 1;
      }

      c1 = (a >>> 20x3f;
      c2 = ((a << 40x30((b >>> 40xf);
      c3 = ((b << 20x3c((c >>> 60x3);
      c4 = c & 0x3f;
      out.write(c1 + ' ');
      out.write(c2 + ' ');
      out.write(c3 + ' ');
      out.write(c4 + ' ');
  }
  // Terminate with LF. (should it be CRLF or local line-terminator ?)
  out.write('\n');
    }

    /**** begin TEST program *****
    public static void main(String argv[]) throws Exception {
  FileInputStream infile = new FileInputStream(argv[0]);
  UUEncoderStream encoder = new UUEncoderStream(System.out);
  int c;

  while ((c = infile.read()) != -1)
      encoder.write(c);
  encoder.close();
    }
    **** end TEST program *****/
}