duke@1: /*
duke@1:  * Portions Copyright 1998-2007 Sun Microsystems, Inc.  All Rights Reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
duke@1:  * published by the Free Software Foundation.  Sun designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
duke@1:  * by Sun in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
duke@1:  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1:  * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1:  * have any questions.
duke@1:  */
duke@1: /*
duke@1:  * Licensed Materials - Property of IBM
duke@1:  * RMI-IIOP v1.0
duke@1:  * Copyright IBM Corp. 1998 1999  All Rights Reserved
duke@1:  *
duke@1:  */
duke@1: 
duke@1: package sun.rmi.rmic.iiop;
duke@1: 
duke@1: import java.util.Vector;
duke@1: import sun.tools.java.ClassNotFound;
duke@1: import sun.tools.java.ClassDeclaration;
duke@1: import sun.tools.java.ClassDefinition;
duke@1: import sun.tools.java.MemberDefinition;
duke@1: import java.util.Hashtable;
duke@1: import java.io.ObjectStreamClass;
duke@1: import java.io.ObjectStreamField;
duke@1: 
duke@1: 
duke@1: /**
duke@1:  * ValueType represents any non-special class which does inherit from
duke@1:  * java.io.Serializable and does not inherit from java.rmi.Remote.
duke@1:  * <p>
duke@1:  * The static forValue(...) method must be used to obtain an instance, and
duke@1:  * will return null if the ClassDefinition is non-conforming.
duke@1:  *
duke@1:  * @author      Bryan Atsatt
duke@1:  */
duke@1: public class ValueType extends ClassType {
duke@1: 
duke@1:     private boolean isCustom;
duke@1: 
duke@1:     //_____________________________________________________________________
duke@1:     // Public Interfaces
duke@1:     //_____________________________________________________________________
duke@1: 
duke@1:     /**
duke@1:      * Create an ValueType object for the given class.
duke@1:      *
duke@1:      * If the class is not a properly formed or if some other error occurs, the
duke@1:      * return value will be null, and errors will have been reported to the
duke@1:      * supplied BatchEnvironment.
duke@1:      */
duke@1:     public static ValueType forValue(ClassDefinition classDef,
duke@1:                                      ContextStack stack,
duke@1:                                      boolean quiet) {
duke@1: 
duke@1:         if (stack.anyErrors()) return null;
duke@1: 
duke@1:         // Do we already have it?
duke@1: 
duke@1:         sun.tools.java.Type theType = classDef.getType();
duke@1:         String typeKey = theType.toString();
duke@1:         Type existing = getType(typeKey,stack);
duke@1: 
duke@1:         if (existing != null) {
duke@1: 
duke@1:             if (!(existing instanceof ValueType)) return null; // False hit.
duke@1: 
duke@1:             // Yep, so return it...
duke@1: 
duke@1:             return (ValueType) existing;
duke@1:         }
duke@1: 
duke@1:         // Is this java.lang.Class?
duke@1: 
duke@1:         boolean javaLangClass = false;
duke@1: 
duke@1:         if (classDef.getClassDeclaration().getName() == idJavaLangClass) {
duke@1: 
duke@1:             // Yes, so replace classDef with one for
duke@1:             // javax.rmi.CORBA.ClassDesc...
duke@1: 
duke@1:             javaLangClass = true;
duke@1:             BatchEnvironment env = stack.getEnv();
duke@1:             ClassDeclaration decl = env.getClassDeclaration(idClassDesc);
duke@1:             ClassDefinition def = null;
duke@1: 
duke@1:             try {
duke@1:                 def = decl.getClassDefinition(env);
duke@1:             } catch (ClassNotFound ex) {
duke@1:                 classNotFound(stack,ex);
duke@1:                 return null;
duke@1:             }
duke@1: 
duke@1:             classDef = def;
duke@1:         }
duke@1: 
duke@1:         // Could this be a value?
duke@1: 
duke@1:         if (couldBeValue(stack,classDef)) {
duke@1: 
duke@1:             // Yes, so check it...
duke@1: 
duke@1:             ValueType it = new ValueType(classDef,stack,javaLangClass);
duke@1:             putType(typeKey,it,stack);
duke@1:             stack.push(it);
duke@1: 
duke@1:             if (it.initialize(stack,quiet)) {
duke@1:                 stack.pop(true);
duke@1:                 return it;
duke@1:             } else {
duke@1:                 removeType(typeKey,stack);
duke@1:                 stack.pop(false);
duke@1:                 return null;
duke@1:             }
duke@1:         } else {
duke@1:             return null;
duke@1:         }
duke@1:     }
duke@1: 
duke@1: 
duke@1:     /**
duke@1:      * Return a string describing this type.
duke@1:      */
duke@1:     public String getTypeDescription () {
duke@1:         String result = addExceptionDescription("Value");
duke@1:         if (isCustom) {
duke@1:             result = "Custom " + result;
duke@1:         }
duke@1:         if (isIDLEntity) {
duke@1:             result = result + " [IDLEntity]";
duke@1:         }
duke@1:         return result;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return true if this type is a "custom" type (i.e.
duke@1:      * it implements java.io.Externalizable or has a
duke@1:      * method with the following signature:
duke@1:      *
duke@1:      *  private void writeObject(java.io.ObjectOutputStream out);
duke@1:      *
duke@1:      */
duke@1:     public boolean isCustom () {
duke@1:         return isCustom;
duke@1:     }
duke@1: 
duke@1: 
duke@1:     //_____________________________________________________________________
duke@1:     // Subclass/Internal Interfaces
duke@1:     //_____________________________________________________________________
duke@1: 
duke@1:     /**
duke@1:      * Create a ValueType instance for the given class.  The resulting
duke@1:      * object is not yet completely initialized.
duke@1:      */
duke@1:     private ValueType(ClassDefinition classDef,
duke@1:                       ContextStack stack,
duke@1:                       boolean isMappedJavaLangClass) {
duke@1:         super(stack,classDef,TYPE_VALUE | TM_CLASS | TM_COMPOUND);
duke@1:         isCustom = false;
duke@1: 
duke@1:         // If this is the mapped version of java.lang.Class,
duke@1:         // set the non-IDL names back to java.lang.Class...
duke@1: 
duke@1:         if (isMappedJavaLangClass) {
duke@1:             setNames(idJavaLangClass,IDL_CLASS_MODULE,IDL_CLASS);
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     //_____________________________________________________________________
duke@1:     // Internal Interfaces
duke@1:     //_____________________________________________________________________
duke@1: 
duke@1:     /**
duke@1:      * Initialize this instance.
duke@1:      */
duke@1: 
duke@1:     private static boolean couldBeValue(ContextStack stack, ClassDefinition classDef) {
duke@1: 
duke@1:         boolean result = false;
duke@1:         ClassDeclaration classDecl = classDef.getClassDeclaration();
duke@1:         BatchEnvironment env = stack.getEnv();
duke@1: 
duke@1:         try {
duke@1:             // Make sure it's not remote...
duke@1: 
duke@1:             if (env.defRemote.implementedBy(env, classDecl)) {
duke@1:                 failedConstraint(10,false,stack,classDef.getName());
duke@1:             } else {
duke@1: 
duke@1:                 // Make sure it's Serializable...
duke@1: 
duke@1:                 if (!env.defSerializable.implementedBy(env, classDecl)) {
duke@1:                     failedConstraint(11,false,stack,classDef.getName());
duke@1:                 } else {
duke@1:                     result = true;
duke@1:                 }
duke@1:             }
duke@1:         } catch (ClassNotFound e) {
duke@1:             classNotFound(stack,e);
duke@1:         }
duke@1: 
duke@1:         return result;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Initialize this instance.
duke@1:      */
duke@1:     private boolean initialize (ContextStack stack, boolean quiet) {
duke@1: 
duke@1:         ClassDefinition ourDef = getClassDefinition();
duke@1:         ClassDeclaration ourDecl = getClassDeclaration();
duke@1: 
duke@1:         try {
duke@1: 
duke@1:             // Make sure our parentage is ok...
duke@1: 
duke@1:             if (!initParents(stack)) {
duke@1:                 failedConstraint(12,quiet,stack,getQualifiedName());
duke@1:                 return false;
duke@1:             }
duke@1: 
duke@1: 
duke@1:             // We're ok, so make up our collections...
duke@1: 
duke@1:             Vector directInterfaces = new Vector();
duke@1:             Vector directMethods = new Vector();
duke@1:             Vector directMembers = new Vector();
duke@1: 
duke@1:             // Get interfaces...
duke@1: 
duke@1:             if (addNonRemoteInterfaces(directInterfaces,stack) != null) {
duke@1: 
duke@1:                 // Get methods...
duke@1: 
duke@1:                 if (addAllMethods(ourDef,directMethods,false,false,stack) != null) {
duke@1: 
duke@1:                     // Update parent class methods
duke@1:                     if (updateParentClassMethods(ourDef,directMethods,false,stack) != null) {
duke@1: 
duke@1:                     // Get constants and members...
duke@1: 
duke@1:                     if (addAllMembers(directMembers,false,false,stack)) {
duke@1: 
duke@1:                         // We're ok, so pass 'em up...
duke@1: 
duke@1:                         if (!initialize(directInterfaces,directMethods,directMembers,stack,quiet)) {
duke@1:                             return false;
duke@1:                         }
duke@1: 
duke@1:                         // Is this class Externalizable?
duke@1: 
duke@1:                         boolean externalizable = false;
duke@1:                         if (!env.defExternalizable.implementedBy(env, ourDecl)) {
duke@1: 
duke@1:                             // No, so check to see if we have a serialPersistentField
duke@1:                             // that will modify the members.
duke@1: 
duke@1:                             if (!checkPersistentFields(getClassInstance(),quiet)) {
duke@1:                                 return false;
duke@1:                             }
duke@1:                         } else {
duke@1: 
duke@1:                             // Yes.
duke@1: 
duke@1:                             externalizable = true;
duke@1:                         }
duke@1: 
duke@1:                         // Should this class be considered "custom"? It is if
duke@1:                         // it is Externalizable OR if it has a method with the
duke@1:                         // following signature:
duke@1:                         //
duke@1:                         //  private void writeObject(java.io.ObjectOutputStream out);
duke@1:                         //
duke@1: 
duke@1:                         if (externalizable) {
duke@1:                             isCustom = true;
duke@1:                         } else {
duke@1:                             for (MemberDefinition member = ourDef.getFirstMember();
duke@1:                                  member != null;
duke@1:                                  member = member.getNextMember()) {
duke@1: 
duke@1:                                 if (member.isMethod() &&
duke@1:                                     !member.isInitializer() &&
duke@1:                                     member.isPrivate() &&
duke@1:                                     member.getName().toString().equals("writeObject")) {
duke@1: 
duke@1:                                     // Check return type, arguments and exceptions...
duke@1: 
duke@1:                                     sun.tools.java.Type methodType = member.getType();
duke@1:                                     sun.tools.java.Type rtnType = methodType.getReturnType();
duke@1: 
duke@1:                                     if (rtnType == sun.tools.java.Type.tVoid) {
duke@1: 
duke@1:                                         // Return type is correct. How about arguments?
duke@1: 
duke@1:                                         sun.tools.java.Type[] args = methodType.getArgumentTypes();
duke@1:                                         if (args.length == 1 &&
duke@1:                                             args[0].getTypeSignature().equals("Ljava/io/ObjectOutputStream;")) {
duke@1: 
duke@1:                                             // Arguments are correct, so it is a custom
duke@1:                                             // value type...
duke@1: 
duke@1:                                             isCustom = true;
duke@1:                                         }
duke@1:                                     }
duke@1:                                 }
duke@1:                             }
duke@1:                         }
duke@1:                         }
duke@1: 
duke@1:                         return true;
duke@1:                     }
duke@1:                 }
duke@1:             }
duke@1:         } catch (ClassNotFound e) {
duke@1:             classNotFound(stack,e);
duke@1:         }
duke@1: 
duke@1:         return false;
duke@1:     }
duke@1: 
duke@1: 
duke@1:     private boolean checkPersistentFields (Class clz, boolean quiet) {
duke@1: 
duke@1:         // Do we have a writeObject method?
duke@1: 
duke@1:         for (int i = 0; i < methods.length; i++) {
duke@1:             if (methods[i].getName().equals("writeObject") &&
duke@1:                 methods[i].getArguments().length == 1) {
duke@1: 
duke@1:                 Type returnType = methods[i].getReturnType();
duke@1:                 Type arg = methods[i].getArguments()[0];
duke@1:                 String id = arg.getQualifiedName();
duke@1: 
duke@1:                 if (returnType.isType(TYPE_VOID) &&
duke@1:                     id.equals("java.io.ObjectOutputStream")) {
duke@1: 
duke@1:                     // Got one, so there's nothing to do...
duke@1: 
duke@1:                     return true;
duke@1:                 }
duke@1:             }
duke@1:         }
duke@1: 
duke@1:         // Do we have a valid serialPersistentField array?
duke@1: 
duke@1:         MemberDefinition spfDef = null;
duke@1: 
duke@1:         for (int i = 0; i < members.length; i++) {
duke@1:             if (members[i].getName().equals("serialPersistentFields")) {
duke@1: 
duke@1:                 Member member = members[i];
duke@1:                 Type type = member.getType();
duke@1:                 Type elementType = type.getElementType();
duke@1: 
duke@1:                 // We have a member with the correct name. Make sure
duke@1:                 // we have the correct signature...
duke@1: 
duke@1:                 if (elementType != null &&
duke@1:                     elementType.getQualifiedName().equals(
duke@1:                                                           "java.io.ObjectStreamField")
duke@1:                     ) {
duke@1: 
duke@1:                     if (member.isStatic() &&
duke@1:                         member.isFinal() &&
duke@1:                         member.isPrivate()) {
duke@1: 
duke@1:                         // We have the correct signature
duke@1: 
duke@1:                         spfDef = member.getMemberDefinition();
duke@1: 
duke@1:                     } else {
duke@1: 
duke@1:                         // Bad signature...
duke@1: 
duke@1:                         failedConstraint(4,quiet,stack,getQualifiedName());
duke@1:                         return false;
duke@1:                     }
duke@1:                 }
duke@1:             }
duke@1:         }
duke@1: 
duke@1:         // If we do not have a serialPersistentField,
duke@1:         // there's nothing to do, so return with no error...
duke@1: 
duke@1:         if (spfDef == null) {
duke@1:             return true;
duke@1:         }
duke@1: 
duke@1:         // Ok, now we must examine the contents of the array -
duke@1:         // then validate them...
duke@1: 
duke@1:         Hashtable fields = getPersistentFields(clz);
duke@1:         boolean result = true;
duke@1: 
duke@1:         for (int i = 0; i < members.length; i++) {
duke@1:             String fieldName = members[i].getName();
duke@1:             String fieldType = members[i].getType().getSignature();
duke@1: 
duke@1:             // Is this field present in the array?
duke@1: 
duke@1:             String type = (String) fields.get(fieldName);
duke@1: 
duke@1:             if (type == null) {
duke@1: 
duke@1:                 // No, so mark it transient...
duke@1: 
duke@1:                 members[i].setTransient();
duke@1: 
duke@1:             } else {
duke@1: 
duke@1:                 // Yes, does the type match?
duke@1: 
duke@1:                 if (type.equals(fieldType)) {
duke@1: 
duke@1:                     // Yes, so remove it from the fields table...
duke@1: 
duke@1:                     fields.remove(fieldName);
duke@1: 
duke@1:                 } else {
duke@1: 
duke@1:                     // No, so error...
duke@1: 
duke@1:                     result = false;
duke@1:                     failedConstraint(2,quiet,stack,fieldName,getQualifiedName());
duke@1:                 }
duke@1:             }
duke@1:         }
duke@1: 
duke@1:         // Ok, we've checked all of our fields. Are there any left in the "array"?
duke@1:         // If so, it's an error...
duke@1: 
duke@1:         if (result && fields.size() > 0) {
duke@1: 
duke@1:             result = false;
duke@1:             failedConstraint(9,quiet,stack,getQualifiedName());
duke@1:         }
duke@1: 
duke@1:         // Return result...
duke@1: 
duke@1:         return result;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Get the names and types of all the persistent fields of a Class.
duke@1:      */
duke@1:     private Hashtable getPersistentFields (Class clz) {
duke@1:         Hashtable result = new Hashtable();
duke@1:         ObjectStreamClass osc = ObjectStreamClass.lookup(clz);
duke@1:         if (osc != null) {
duke@1:             ObjectStreamField[] fields = osc.getFields();
duke@1:             for (int i = 0; i < fields.length; i++) {
duke@1:                 String typeSig;
duke@1:                 String typePrefix = String.valueOf(fields[i].getTypeCode());
duke@1:                 if (fields[i].isPrimitive()) {
duke@1:                     typeSig = typePrefix;
duke@1:                 } else {
duke@1:                     if (fields[i].getTypeCode() == '[') {
duke@1:                         typePrefix = "";
duke@1:                     }
duke@1:                     typeSig = typePrefix + fields[i].getType().getName().replace('.','/');
duke@1:                     if (typeSig.endsWith(";")) {
duke@1:                         typeSig = typeSig.substring(0,typeSig.length()-1);
duke@1:                     }
duke@1:                 }
duke@1:                 result.put(fields[i].getName(),typeSig);
duke@1:             }
duke@1:         }
duke@1:         return result;
duke@1:     }
duke@1: }