isoutil.java

POS is a Java&#174 platform-based, mission-critical, ISO-8583 based financial transaction library/fr

/*
 * jPOS Project [http://jpos.org]
 * Copyright (C) 2000-2008 Alejandro P. Revilla
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program 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.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.jpos.iso;

import java.io.UnsupportedEncodingException;
import java.util.Arrays;
import java.util.BitSet;
import java.util.StringTokenizer;

/**
 * varios functions needed to pack/unpack ISO-8583 fields
 *
 * @author [e-mail]
 * @author Hani S. Kirollos
 * @author Alwyn Schoeman
 * @version $Id: ISOUtil.java 2606 2008-02-12 22:47:26Z apr $
 * @see ISOComponent
 */

public class ISOUtil {
    public static final byte[] EBCDIC2ASCII = new byte[] {
        (byte)0x0,  (byte)0x1,  (byte)0x2,  (byte)0x3, 
        (byte)0x9C, (byte)0x9,  (byte)0x86, (byte)0x7F, 
        (byte)0x97, (byte)0x8D, (byte)0x8E, (byte)0xB, 
        (byte)0xC,  (byte)0xD,  (byte)0xE,  (byte)0xF, 
        (byte)0x10, (byte)0x11, (byte)0x12, (byte)0x13, 
        (byte)0x9D, (byte)0xA,  (byte)0x8,  (byte)0x87, 
        (byte)0x18, (byte)0x19, (byte)0x92, (byte)0x8F, 
        (byte)0x1C, (byte)0x1D, (byte)0x1E, (byte)0x1F, 
        (byte)0x80, (byte)0x81, (byte)0x82, (byte)0x83, 
        (byte)0x84, (byte)0x85, (byte)0x17, (byte)0x1B, 
        (byte)0x88, (byte)0x89, (byte)0x8A, (byte)0x8B, 
        (byte)0x8C, (byte)0x5,  (byte)0x6,  (byte)0x7, 
        (byte)0x90, (byte)0x91, (byte)0x16, (byte)0x93, 
        (byte)0x94, (byte)0x95, (byte)0x96, (byte)0x4, 
        (byte)0x98, (byte)0x99, (byte)0x9A, (byte)0x9B, 
        (byte)0x14, (byte)0x15, (byte)0x9E, (byte)0x1A, 
        (byte)0x20, (byte)0xA0, (byte)0xE2, (byte)0xE4, 
        (byte)0xE0, (byte)0xE1, (byte)0xE3, (byte)0xE5, 
        (byte)0xE7, (byte)0xF1, (byte)0xA2, (byte)0x2E, 
        (byte)0x3C, (byte)0x28, (byte)0x2B, (byte)0x7C, 
        (byte)0x26, (byte)0xE9, (byte)0xEA, (byte)0xEB, 
        (byte)0xE8, (byte)0xED, (byte)0xEE, (byte)0xEF, 
        (byte)0xEC, (byte)0xDF, (byte)0x21, (byte)0x24, 
        (byte)0x2A, (byte)0x29, (byte)0x3B, (byte)0x5E, 
        (byte)0x2D, (byte)0x2F, (byte)0xC2, (byte)0xC4, 
        (byte)0xC0, (byte)0xC1, (byte)0xC3, (byte)0xC5, 
        (byte)0xC7, (byte)0xD1, (byte)0xA6, (byte)0x2C, 
        (byte)0x25, (byte)0x5F, (byte)0x3E, (byte)0x3F, 
        (byte)0xF8, (byte)0xC9, (byte)0xCA, (byte)0xCB, 
        (byte)0xC8, (byte)0xCD, (byte)0xCE, (byte)0xCF, 
        (byte)0xCC, (byte)0x60, (byte)0x3A, (byte)0x23, 
        (byte)0x40, (byte)0x27, (byte)0x3D, (byte)0x22, 
        (byte)0xD8, (byte)0x61, (byte)0x62, (byte)0x63, 
        (byte)0x64, (byte)0x65, (byte)0x66, (byte)0x67, 
        (byte)0x68, (byte)0x69, (byte)0xAB, (byte)0xBB, 
        (byte)0xF0, (byte)0xFD, (byte)0xFE, (byte)0xB1, 
        (byte)0xB0, (byte)0x6A, (byte)0x6B, (byte)0x6C, 
        (byte)0x6D, (byte)0x6E, (byte)0x6F, (byte)0x70, 
        (byte)0x71, (byte)0x72, (byte)0xAA, (byte)0xBA, 
        (byte)0xE6, (byte)0xB8, (byte)0xC6, (byte)0xA4, 
        (byte)0xB5, (byte)0x7E, (byte)0x73, (byte)0x74, 
        (byte)0x75, (byte)0x76, (byte)0x77, (byte)0x78, 
        (byte)0x79, (byte)0x7A, (byte)0xA1, (byte)0xBF, 
        (byte)0xD0, (byte)0x5B, (byte)0xDE, (byte)0xAE, 
        (byte)0xAC, (byte)0xA3, (byte)0xA5, (byte)0xB7, 
        (byte)0xA9, (byte)0xA7, (byte)0xB6, (byte)0xBC, 
        (byte)0xBD, (byte)0xBE, (byte)0xDD, (byte)0xA8, 
        (byte)0xAF, (byte)0x5D, (byte)0xB4, (byte)0xD7, 
        (byte)0x7B, (byte)0x41, (byte)0x42, (byte)0x43, 
        (byte)0x44, (byte)0x45, (byte)0x46, (byte)0x47, 
        (byte)0x48, (byte)0x49, (byte)0xAD, (byte)0xF4, 
        (byte)0xF6, (byte)0xF2, (byte)0xF3, (byte)0xF5, 
        (byte)0x7D, (byte)0x4A, (byte)0x4B, (byte)0x4C, 
        (byte)0x4D, (byte)0x4E, (byte)0x4F, (byte)0x50, 
        (byte)0x51, (byte)0x52, (byte)0xB9, (byte)0xFB, 
        (byte)0xFC, (byte)0xF9, (byte)0xFA, (byte)0xFF, 
        (byte)0x5C, (byte)0xF7, (byte)0x53, (byte)0x54, 
        (byte)0x55, (byte)0x56, (byte)0x57, (byte)0x58, 
        (byte)0x59, (byte)0x5A, (byte)0xB2, (byte)0xD4, 
        (byte)0xD6, (byte)0xD2, (byte)0xD3, (byte)0xD5, 
        (byte)0x30, (byte)0x31, (byte)0x32, (byte)0x33, 
        (byte)0x34, (byte)0x35, (byte)0x36, (byte)0x37, 
        (byte)0x38, (byte)0x39, (byte)0xB3, (byte)0xDB, 
        (byte)0xDC, (byte)0xD9, (byte)0xDA, (byte)0x9F
    };
    public static final byte[] ASCII2EBCDIC = new byte[] {
        (byte)0x0,  (byte)0x1,  (byte)0x2,  (byte)0x3, 
        (byte)0x37, (byte)0x2D, (byte)0x2E, (byte)0x2F, 
        (byte)0x16, (byte)0x5,  (byte)0x15, (byte)0xB, 
        (byte)0xC,  (byte)0xD,  (byte)0xE,  (byte)0xF, 
        (byte)0x10, (byte)0x11, (byte)0x12, (byte)0x13, 
        (byte)0x3C, (byte)0x3D, (byte)0x32, (byte)0x26, 
        (byte)0x18, (byte)0x19, (byte)0x3F, (byte)0x27, 
        (byte)0x1C, (byte)0x1D, (byte)0x1E, (byte)0x1F, 
        (byte)0x40, (byte)0x5A, (byte)0x7F, (byte)0x7B, 
        (byte)0x5B, (byte)0x6C, (byte)0x50, (byte)0x7D, 
        (byte)0x4D, (byte)0x5D, (byte)0x5C, (byte)0x4E, 
        (byte)0x6B, (byte)0x60, (byte)0x4B, (byte)0x61, 
        (byte)0xF0, (byte)0xF1, (byte)0xF2, (byte)0xF3, 
        (byte)0xF4, (byte)0xF5, (byte)0xF6, (byte)0xF7, 
        (byte)0xF8, (byte)0xF9, (byte)0x7A, (byte)0x5E, 
        (byte)0x4C, (byte)0x7E, (byte)0x6E, (byte)0x6F, 
        (byte)0x7C, (byte)0xC1, (byte)0xC2, (byte)0xC3, 
        (byte)0xC4, (byte)0xC5, (byte)0xC6, (byte)0xC7, 
        (byte)0xC8, (byte)0xC9, (byte)0xD1, (byte)0xD2, 
        (byte)0xD3, (byte)0xD4, (byte)0xD5, (byte)0xD6, 
        (byte)0xD7, (byte)0xD8, (byte)0xD9, (byte)0xE2, 
        (byte)0xE3, (byte)0xE4, (byte)0xE5, (byte)0xE6, 
        (byte)0xE7, (byte)0xE8, (byte)0xE9, (byte)0xAD, 
        (byte)0xE0, (byte)0xBD, (byte)0x5F, (byte)0x6D, 
        (byte)0x79, (byte)0x81, (byte)0x82, (byte)0x83, 
        (byte)0x84, (byte)0x85, (byte)0x86, (byte)0x87, 
        (byte)0x88, (byte)0x89, (byte)0x91, (byte)0x92, 
        (byte)0x93, (byte)0x94, (byte)0x95, (byte)0x96, 
        (byte)0x97, (byte)0x98, (byte)0x99, (byte)0xA2, 
        (byte)0xA3, (byte)0xA4, (byte)0xA5, (byte)0xA6, 
        (byte)0xA7, (byte)0xA8, (byte)0xA9, (byte)0xC0, 
        (byte)0x4F, (byte)0xD0, (byte)0xA1, (byte)0x7, 
        (byte)0x20, (byte)0x21, (byte)0x22, (byte)0x23, 
        (byte)0x24, (byte)0x25, (byte)0x6,  (byte)0x17, 
        (byte)0x28, (byte)0x29, (byte)0x2A, (byte)0x2B, 
        (byte)0x2C, (byte)0x9,  (byte)0xA,  (byte)0x1B, 
        (byte)0x30, (byte)0x31, (byte)0x1A, (byte)0x33, 
        (byte)0x34, (byte)0x35, (byte)0x36, (byte)0x8, 
        (byte)0x38, (byte)0x39, (byte)0x3A, (byte)0x3B, 
        (byte)0x4,  (byte)0x14, (byte)0x3E, (byte)0xFF, 
        (byte)0x41, (byte)0xAA, (byte)0x4A, (byte)0xB1, 
        (byte)0x9F, (byte)0xB2, (byte)0x6A, (byte)0xB5, 
        (byte)0xBB, (byte)0xB4, (byte)0x9A, (byte)0x8A, 
        (byte)0xB0, (byte)0xCA, (byte)0xAF, (byte)0xBC, 
        (byte)0x90, (byte)0x8F, (byte)0xEA, (byte)0xFA, 
        (byte)0xBE, (byte)0xA0, (byte)0xB6, (byte)0xB3, 
        (byte)0x9D, (byte)0xDA, (byte)0x9B, (byte)0x8B, 
        (byte)0xB7, (byte)0xB8, (byte)0xB9, (byte)0xAB, 
        (byte)0x64, (byte)0x65, (byte)0x62, (byte)0x66, 
        (byte)0x63, (byte)0x67, (byte)0x9E, (byte)0x68, 
        (byte)0x74, (byte)0x71, (byte)0x72, (byte)0x73, 
        (byte)0x78, (byte)0x75, (byte)0x76, (byte)0x77, 
        (byte)0xAC, (byte)0x69, (byte)0xED, (byte)0xEE, 
        (byte)0xEB, (byte)0xEF, (byte)0xEC, (byte)0xBF, 
        (byte)0x80, (byte)0xFD, (byte)0xFE, (byte)0xFB, 
        (byte)0xFC, (byte)0xBA, (byte)0xAE, (byte)0x59, 
        (byte)0x44, (byte)0x45, (byte)0x42, (byte)0x46, 
        (byte)0x43, (byte)0x47, (byte)0x9C, (byte)0x48, 
        (byte)0x54, (byte)0x51, (byte)0x52, (byte)0x53, 
        (byte)0x58, (byte)0x55, (byte)0x56, (byte)0x57, 
        (byte)0x8C, (byte)0x49, (byte)0xCD, (byte)0xCE, 
        (byte)0xCB, (byte)0xCF, (byte)0xCC, (byte)0xE1, 
        (byte)0x70, (byte)0xDD, (byte)0xDE, (byte)0xDB, 
        (byte)0xDC, (byte)0x8D, (byte)0x8E, (byte)0xDF
    };
    public static final byte STX = 0x02;
    public static final byte FS  = 0x1C;
    public static final byte US  = 0x1F;
    public static final byte RS  = 0x1D;
    public static final byte GS  = 0x1E;
    public static final byte ETX = 0x03;

    public static String ebcdicToAscii(byte[] e) {
        try {
            return new String (
                ebcdicToAsciiBytes (e, 0, e.length), "ISO8859_1"
            );
        } catch (UnsupportedEncodingException ex) {
            return ex.toString(); // should never happen
        }
    }
    public static String ebcdicToAscii(byte[] e, int offset, int len) {
        try {
            return new String (
                ebcdicToAsciiBytes (e, offset, len), "ISO8859_1"
            );
        } catch (UnsupportedEncodingException ex) {
            return ex.toString(); // should never happen
        }
    }
    public static byte[] ebcdicToAsciiBytes (byte[] e) {
        return ebcdicToAsciiBytes (e, 0, e.length);
    }
    public static byte[] ebcdicToAsciiBytes(byte[] e, int offset, int len) {
        byte[] a = new byte[len];
        for (int i=0; i<len; i++)
            a[i] = EBCDIC2ASCII[e[offset+i]&0xFF];
        return a;
    }
    public static byte[] asciiToEbcdic(String s) {
        return asciiToEbcdic (s.getBytes());
    }
    public static byte[] asciiToEbcdic(byte[] a) {
        byte[] e = new byte[a.length];
        for (int i=0; i<a.length; i++) 
            e[i] = ASCII2EBCDIC[a[i]&0xFF];
        return e;
    }
    public static void asciiToEbcdic(String s, byte[] e, int offset) {
        int len = s.length();
        for (int i=0; i<len; i++)
            e[offset + i] = ASCII2EBCDIC[s.charAt(i)&0xFF];
    }

    /**
     * pad to the left
     * @param s - original string
     * @param len - desired len
     * @param c - padding char
     * @return padded string
     */
    public static String padleft(String s, int len, char c)
        throws ISOException 
    {
        s = s.trim();
        if (s.length() > len)
            throw new ISOException("invalid len " +s.length() + "/" +len);
        StringBuffer d = new StringBuffer (len);
        int fill = len - s.length();
        while (fill-- > 0)
            d.append (c);
        d.append(s);
        return d.toString();
    }

   /**
    * trim String (if not null)
    * @param s String to trim
    * @return String (may be null)
    */
    public static String trim (String s) {
        return s != null ? s.trim() : null;
    }

    /**
     * left pad with '0'
     * @param s - original string
     * @param len - desired len
     * @return zero padded string
     */
    public static String zeropad(String s, int len) throws ISOException {
        return padleft(s, len, '0');
    }

    /**
     * pads to the right
     * @param s - original string
     * @param len - desired len
     * @return space padded string
     */
    public static String strpad(String s, int len) {
        StringBuffer d = new StringBuffer(s);
        while (d.length() < len)
            d.append(' ');
        return d.toString();
    }
    public static String zeropadRight (String s, int len) {
        StringBuffer d = new StringBuffer(s);
        while (d.length() < len)
            d.append('0');
        return d.toString();
    }
    /**
     * converts to BCD
     * @param s - the number
     * @param padLeft - flag indicating left/right padding
     * @param d The byte array to copy into.
     * @param offset Where to start copying into.
     * @return BCD representation of the number
     */
    public static byte[] str2bcd(String s, boolean padLeft, byte[] d, int offset) {
        int len = s.length();
        int start = (((len & 1) == 1) && padLeft) ? 1 : 0;
        for (int i=start; i < len+start; i++) 
            d [offset + (i >> 1)] |= (s.charAt(i-start)-'0') << ((i & 1) == 1 ? 0 : 4);
        return d;
    }
    /**
     * converts to BCD
     * @param s - the number
     * @param padLeft - flag indicating left/right padding
     * @return BCD representation of the number
     */
    public static byte[] str2bcd(String s, boolean padLeft) {
        int len = s.length();
        byte[] d = new byte[ (len+1) >> 1 ];
        return str2bcd(s, padLeft, d, 0);
    }
    /**
     * converts to BCD
     * @param s - the number
     * @param padLeft - flag indicating left/right padding
     * @param fill - fill value
     * @return BCD representation of the number
     */
    public static byte[] str2bcd(String s, boolean padLeft, byte fill) {
        int len = s.length();
        byte[] d = new byte[ (len+1) >> 1 ];
        Arrays.fill (d, fill);
        int start = (((len & 1) == 1) && padLeft) ? 1 : 0;
        for (int i=start; i < len+start; i++) 
            d [i >> 1] |= (s.charAt(i-start)-'0') << ((i & 1) == 1 ? 0 : 4);
        return d;
    }
    /**
     * converts a BCD representation of a number to a String
     * @param b - BCD representation
     * @param offset - starting offset
     * @param len - BCD field len
     * @param padLeft - was padLeft packed?
     * @return the String representation of the number
     */
    public static String bcd2str(byte[] b, int offset,
                        int len, boolean padLeft)
    {
        StringBuffer d = new StringBuffer(len);
        int start = (((len & 1) == 1) && padLeft) ? 1 : 0;
        for (int i=start; i < len+start; i++) {
            int shift = ((i & 1) == 1 ? 0 : 4);
            char c = Character.forDigit (
                ((b[offset+(i>>1)] >> shift) & 0x0F), 16);
            if (c == 'd')
                c = '=';
            d.append (Character.toUpperCase (c));
        }
        return d.toString();
    }
    /**
     * converts a byte array to hex string 
     * (suitable for dumps and ASCII packaging of Binary fields
     * @param b - byte array
     * @return String representation
     */
    public static String hexString(byte[] b) {
        StringBuffer d = new StringBuffer(b.length * 2);
        for (int i=0; i<b.length; i++) {
            char hi = Character.forDigit ((b[i] >> 4) & 0x0F, 16);
            char lo = Character.forDigit (b[i] & 0x0F, 16);
            d.append(Character.toUpperCase(hi));
            d.append(Character.toUpperCase(lo));
        }
        return d.toString();
    }
    /**
     * converts a byte array to printable characters
     * @param b - byte array
     * @return String representation
     */
    public static String dumpString(byte[] b) {
        StringBuffer d = new StringBuffer(b.length * 2);
        for (int i=0; i<b.length; i++) {
            char c = (char) b[i];
            if (Character.isISOControl (c)) {
                // TODO: complete list of control characters,
                // use a String[] instead of this weird switch
                switch (c) {
                    case '\r'  : d.append ("{CR}");   break;
                    case '\n'  : d.append ("{LF}");   break;
                    case '\000': d.append ("{NULL}"); break;
                    case '\001': d.append ("{SOH}");  break;
                    case '\002': d.append ("{STX}");  break;
                    case '\003': d.append ("{ETX}");  break;
                    case '\004': d.append ("{EOT}");  break;
                    case '\005': d.append ("{ENQ}");  break;
                    case '\006': d.append ("{ACK}");  break;
                    case '\007': d.append ("{BEL}");  break;
                    case '\020': d.append ("{DLE}");  break;
                    case '\025': d.append ("{NAK}");  break;
                    case '\026': d.append ("{SYN}");  break;
                    case '\034': d.append ("{FS}");  break;
                    case '\036': d.append ("{RS}");  break;
                    default:
                        char hi = Character.forDigit ((b[i] >> 4) & 0x0F, 16);
                        char lo = Character.forDigit (b[i] & 0x0F, 16);
                        d.append('[');
                        d.append(Character.toUpperCase(hi));
                        d.append(Character.toUpperCase(lo));
                        d.append(']');
                        break;
                }
            }
            else
                d.append (c);

        }
        return d.toString();
    }
    /**
     * converts a byte array to hex string 
     * (suitable for dumps and ASCII packaging of Binary fields