path: root/ldap/admin/src/java/com/netscape/xmltools/DSMLWriter.java

/** BEGIN COPYRIGHT BLOCK
 * This Program 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; version 2 of the License.
 * 
 * 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * this Program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place, Suite 330, Boston, MA 02111-1307 USA.
 * 
 * In addition, as a special exception, Red Hat, Inc. gives You the additional
 * right to link the code of this Program with code not covered under the GNU
 * General Public License ("Non-GPL Code") and to distribute linked combinations
 * including the two, subject to the limitations in this paragraph. Non-GPL Code
 * permitted under this exception must only link to the code of this Program
 * through those well defined interfaces identified in the file named EXCEPTION
 * found in the source code files (the "Approved Interfaces"). The files of
 * Non-GPL Code may instantiate templates or use macros or inline functions from
 * the Approved Interfaces without causing the resulting work to be covered by
 * the GNU General Public License. Only Red Hat, Inc. may make changes or
 * additions to the list of Approved Interfaces. You must obey the GNU General
 * Public License in all respects for all of the Program code and other code used
 * in conjunction with the Program except the Non-GPL Code covered by this
 * exception. If you modify this file, you may extend this exception to your
 * version of the file, but you are not obligated to do so. If you do not wish to
 * do so, delete this exception statement from your version. 
 * 
 * 
 * Copyright (C) 2001 Sun Microsystems, Inc. Used by permission.
 * Copyright (C) 2005 Red Hat, Inc.
 * All rights reserved.
 * END COPYRIGHT BLOCK **/

package com.netscape.xmltools;

import java.util.*;
import netscape.ldap.*;
import java.io.*;
import netscape.ldap.util.*;

/**
 * Class for outputting LDAP entries to a stream as DSML.
 *
 * @version 1.0
 */
public class DSMLWriter extends LDAPWriter {

//    static final long serialVersionUID = -2710382547996750924L;

    /**
     * Constructs a <CODE>DSMLWriter</CODE> object to output entries
     * to a stream as DSML.
     *
     * @param pw output stream
     */
    public DSMLWriter( PrintWriter pw ) {
        super( pw );
    }

    /**
     * Prints the schema from an entry containing subschema
     *
     * entry entry containing schema definitions
     */
    public void printSchema( LDAPEntry entry ) {
        LDAPSchema schema = new LDAPSchema( entry );
        printString( "  <dsml:directory-schema>" );
        printObjectClassSchema( schema );
        printAttributeSchema( schema );
        printString( "  </dsml:directory-schema>" );
    }


    /**
     * Prints the object class schema from a schema object
     *
     * schema schema elements
     */
    protected void printObjectClassSchema( LDAPSchema schema ) {
        Enumeration en = schema.getObjectClasses();
        while( en.hasMoreElements() ) {
            LDAPObjectClassSchema s = (LDAPObjectClassSchema)en.nextElement();
            printString( "    <dsml:class" );
            printString( "      id=\"" + s.getName() + "\"" );
            printString( "      oid=\"" + s.getID() + "\"" );
            String[] superiors = s.getSuperiors();
            if ( superiors != null ) {
                for( int i = 0; i < superiors.length; i++ ) {
                    printString( "      superior=\"#" + superiors[i] + "\"" );
                }
            }
            String classType = "structural";
            switch( s.getType() ) {
            case LDAPObjectClassSchema.ABSTRACT: classType = "abstract";
                break;
            case LDAPObjectClassSchema.AUXILIARY: classType = "auxiliary";
                break;
            }
            printString( "      type=\"" + classType + "\">" );
            if ( s.isObsolete() ) {
                printString( "      obsolete=true" );
            }
            printString( "      <dsml:name>" + s.getName() + "</dsml:name>" );
            printString( "      <dsml:description>" + s.getDescription() +
                         "</dsml:description>" );
            Enumeration attrs = s.getRequiredAttributes();
            while( attrs.hasMoreElements() ) {
                printString( "      <dsml:attribute ref=\"#" +
                             (String)attrs.nextElement() +
                             "\" required=\"true\"/>" );
            }
            attrs = s.getOptionalAttributes();
            while( attrs.hasMoreElements() ) {
                printString( "      <dsml:attribute ref=\"#" +
                             (String)attrs.nextElement() +
                             "\" required=\"false\"/>" );
            }
            printString( "    </dsml:class>" );
        }
    }


    /**
     * Prints the attribute schema from a schema object
     *
     * schema schema elements
     */
    protected void printAttributeSchema( LDAPSchema schema ) {
        Enumeration en = schema.getAttributes();
        while( en.hasMoreElements() ) {
            LDAPAttributeSchema s = (LDAPAttributeSchema)en.nextElement();
            printString( "    <dsml:attribute-type" );
            printString( "      id=\"" + s.getName() + "\"" );
            printString( "      oid=\"" + s.getID() + "\"" );
            String superior = s.getSuperior();
            if ( superior != null ) {
                printString( "      superior=\"#" + superior + "\"" );
            }
            if ( s.isSingleValued() ) {
                printString( "      single-value=true" );
            }
            if ( s.isObsolete() ) {
                printString( "      obsolete=true" );
            }
            if ( s.getQualifier( s.NO_USER_MODIFICATION ) != null ) {
                printString( "      user-modification=false" );
            }
            String[] vals = s.getQualifier( s.EQUALITY );
            if ( (vals != null) && (vals.length > 0) ) {
                printString( "      equality=" + vals[0] );
            }
            vals = s.getQualifier( s.ORDERING );
            if ( (vals != null) && (vals.length > 0) ) {
                printString( "      ordering=" + vals[0] );
            }
            vals = s.getQualifier( s.SUBSTR );
            if ( (vals != null) && (vals.length > 0) ) {
                printString( "      substring=" + vals[0] );
            }
            printString( "      <dsml:name>" + s.getName() + "</dsml:name>" );
            printString( "      <dsml:description>" + s.getDescription() +
                         "</dsml:description>" );
            printString( "      <dsml:syntax>" + s.getSyntaxString() +
                         "</dsml:syntax>" );
            printString( "    </dsml:attribute-type>" );
        }
    }


    /**
     * Print an attribute of an entry
     *
     * @param attr the attribute to format to the output stream
     */
    protected void printAttribute( LDAPAttribute attr ) {
        String attrName = attr.getName();

        // Object classes are treated differently in DSML. Also, they
        // are always String-valued
        if ( attrName.equalsIgnoreCase( "objectclass" ) ) {
            Enumeration enumVals = attr.getStringValues();
            if ( enumVals != null ) {
                printString( "    <dsml:objectclass>" );
                while ( enumVals.hasMoreElements() ) {
                    String s = (String)enumVals.nextElement();
                    printString( "      <dsml:oc-value>" + s +
                                 "</dsml:oc-value>" );
                }
                printString( "    </dsml:objectclass>" );
            }
            return;
        }

        printString( "    <dsml:attr name=\"" + attrName + "\">" );

        /* Loop on values for this attribute */
        Enumeration enumVals = attr.getByteValues();

        if ( enumVals != null ) {
            while ( enumVals.hasMoreElements() ) {
                byte[] b = (byte[])enumVals.nextElement();
                String s;
                if ( LDIF.isPrintable(b) ) {
                    try {
                        s = new String( b, "UTF8" );
                    } catch ( UnsupportedEncodingException e ) {
                        s = "";
                    }
                    printEscapedValue( "      <dsml:value>", s,
                                       "</dsml:value>" );
                } else {
                    s = getPrintableValue( b );
                    if ( s.length() > 0 ) {
                        printString( "      " +
                                     "<dsml:value encoding=\"base64\">" );
                        printString( "       " + s );
                        printString( "      </dsml:value>" );
                    }
                }
            }
        }
        printString( "    </dsml:attr>" );
    }

    /**
     * Print prologue to entry
     *
     * @param dn the DN of the entry
     */
    protected void printEntryStart( String dn ) {

/*
        if ( dn == null ) {
            dn = "";
        } else {
            byte[] b = null;
            try {
                b = dn.getBytes( "UTF8" );
            } catch ( UnsupportedEncodingException ex ) {
            }

            if ( !LDIF.isPrintable(b) ) {
                dn = getPrintableValue( b );
                printString( "  <dsml:entry dn=\"" + dn + "\" encoding=\"base64\">" );
                return;
            }

        }
        printString( "  <dsml:entry dn=\"" + dn + "\">" );
*/


        if ( dn == null ) {
            dn = "";
        }
        m_pw.print( "  <dsml:entry dn=\"" );
        printEscapedAttribute( dn );
        m_pw.println( "\">" );
    }

    /**
     * Print epilogue to entry
     *
     * @param dn the DN of the entry
     */
    protected void printEntryEnd( String dn ) {
        printString( "  </dsml:entry>" );
    }

    /**
     * Print the element start, the value with escaping of special
     * characters, and the element end
     *
     * @param prolog element start
     * @param value value to be escaped
     * @param epilog element end
     */
    protected void printEscapedValue( String prolog, String value,
                                      String epilog ) {
        m_pw.print( prolog );
        int l = value.length();
        char[] text = new char[l];
        value.getChars( 0, l, text, 0 );
        for ( int i = 0; i < l; i++ ) {
            char c = text[i];
            switch (c) {
            case '<' :
                m_pw.print( "&lt;" );
                break;
            case '&' :
                m_pw.print( "&amp;" );
                break;
            default :
                m_pw.print( c );
            }
        }
        // m_pw.print( epilog);
        // m_pw.print( '\n' );
        m_pw.println( epilog );
    }

    /**
     * Print the element attribute escaping of special
     * characters
     *
     * @param attribute  Attribute value to be escaped
     */
    protected void printEscapedAttribute( String attribute ) {

        int l = attribute.length();
        char[] text = new char[l];
        attribute.getChars( 0, l, text, 0 );
        for ( int i = 0; i < l; i++ ) {
            char c = text[i];
            switch (c) {
            case '<' :
                m_pw.print( "&lt;" );
                break;
            case '>':
                m_pw.print( "&gt;" );
                break;
            case '&' :
                m_pw.print( "&amp;" );
                break;
            case '"':
                m_pw.print( "&quot;" );
                break;
            case '\'':
                m_pw.print( "&apos;" );
                break;
            default :
                m_pw.print( c );
            }
        }
    }

    protected void printString( String value ) {
        // m_pw.print( value );
        // m_pw.print( '\n' );
        m_pw.println( value );
    }
}