/* * ################################################################ * * FenixEdu: The Java(TM) Object-Oriented Framework for University * Academic Applications * * Copyright (C) 2002-2003 IST/Technical University of Lisbon * Contact: suporte@dot.ist.utl.pt * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or any later version. * * This library 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 * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 * USA * * Initial developer(s): The Fenix Team * http://fenix-ashes.ist.utl.pt/ * * Contributor(s): José Pedro Pereira - Educare S.A. - http://www.linkare.com * * ################################################################ */ package net.sourceforge.fenixedu.presentationTier.servlets; import java.io.IOException; import java.io.PrintWriter; import java.lang.reflect.Method; import java.util.ArrayList; import java.util.Collection; import java.util.Collections; import java.util.Comparator; import java.util.HashMap; import java.util.Iterator; import java.util.List; import javax.servlet.ServletConfig; import javax.servlet.ServletException; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import net.sourceforge.fenixedu.domain.RootDomainObject; import pt.ist.fenixframework.DomainObject; import pt.ist.fenixframework.FenixFramework; import pt.ist.fenixframework.pstm.MissingObjectException; import pt.ist.fenixframework.pstm.Transaction; import com.linkare.commons.metainfo.Linkare; import dml.DomainClass; import dml.DomainEntity; import dml.DomainModel; import dml.Role; import dml.Slot; public class DomainBrowserServlet extends HttpServlet { private static final String DESCRIPTION = "Description"; private static DomainModel domainModel; private static HashMap domainClassesDescAttr = new HashMap(); public void init(ServletConfig config) throws ServletException { super.init(config); try { domainModel = FenixFramework.getDomainModel(); } catch (Exception e) { domainModel = null; } } @Linkare(author = "Paulo Zenida", comments = "Included the CSS and Javascript files in the HTML to deal with the sorting in the lists") public void doGet(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException { res.setContentType("text/html"); PrintWriter out = res.getWriter(); out.println("\n"); out.println("\n"); out.println(""); out.println("Fenix Domain Browser"); out.println(""); out.println("\n"); String path = req.getPathInfo(); try { if ("/listAll".equals(path)) { renderListAll(out, RequestParams.parse(req, "domainClass")); } else if ("/showObj".equals(path)) { renderDomainObject(out, RequestParams.parse(req, "OID")); } else if ("/listRole".equals(path)) { renderDomainObjectRole(out, RequestParams.parse(req, "OID", "role")); } else if ("/checkDomain".equals(path)) { checkDomain(out); } else { renderMainIndex(out); } } catch (MissingObjectException moe) { out.println("

No such object

"); } catch (Exception e) { e.printStackTrace(); throw new Error("Error: " + e.getMessage()); } out.println("\n"); out.println("\n"); out.close(); } protected void renderDomainObject(PrintWriter out, RequestParams params) throws IOException, Exception { if (params == null) { renderMainIndex(out); return; } DomainObject domObj = Transaction.getObjectForOID(params.oid); DomainClass domClass = getDomainClass(domObj); out.println("

"); out.println(domObj.getClass().getName()); out.println(" Instance: "); out.println(getObjectDescription(domObj)); out.println("

\n"); out.println("

Attributes

\n"); out.println("\n"); for (String attr : getAllAttrs(domClass)) { if (!isForeignKey(attr, domClass)) { out.println(""); } } out.println("

"); out.println(attr); out.println("

"); out.println(getAttributeValue(domObj, attr)); out.println("

\n"); out.println("

Relations

"); out.println("\n"); for (Role role : getAllRoles(domClass)) { out.println(""); } out.println("

"); out.println(role.getName()); out.println("

"); Object roleValue = getAttributeValue(domObj, role.getName()); if (role.getMultiplicityUpper() == 1) { if (roleValue == null) { out.println("null"); } else { DomainEntity roleType = role.getType(); if (roleType instanceof DomainClass) { renderObjectId(out, getDomainObject(roleValue)); } else { out.println(roleValue); } } } else { if (roleValue == null) { out.println("null collection"); } else { Collection col = (Collection) roleValue; int colSize = -1; if (params.showColSize) { try { colSize = col.size(); } catch (Exception e) { // ignore it } } out.println(""); out.println(role.getType().getFullName()); out.println("["); out.println(colSize == -1 ? "?" : colSize); out.println("]"); } } out.println("

\n"); } private boolean isForeignKey(String attrName, DomainClass domClass) { return (attrName.startsWith("key") && (domClass.findRoleSlot(firstCharToLower(attrName.substring(3))) != null)); } protected void renderDomainObjectRole(PrintWriter out, RequestParams params) throws IOException, Exception { if (params == null) { renderMainIndex(out); return; } DomainObject domObj = Transaction.getObjectForOID(params.oid); out.println("

"); renderObjectId(out, domObj); out.println("'s "); out.println(params.roleName); out.println(":

\n"); Collection insts = (Collection) getAttributeValue(domObj, params.roleName); renderCollection(out, insts, params); } protected void renderListAll(PrintWriter out, RequestParams params) throws IOException, Exception { if (params == null) { renderMainIndex(out); return; } out.println("

"); out.println(params.classFullName); out.println(" Entities

\n"); Collection insts = RootDomainObject.readAllDomainObjects(params.javaClass); renderCollection(out, insts, params); } @Linkare(author = "Paulo Zenida", comments = "Changed the renderization of the collection of objects from

Null collection

Total instances: "); out.println(total); out.println("

Showing from "); out.println(first); out.println(" to "); out.println(last); out.println("

"); params.start = 1; params.max = total; out.println("Show all"); out.println("\t\t

" + DESCRIPTION + "
sort

"); renderObjectId(out, getDomainObject(iter.next())); out.println("

Show next (" + step + ")

"); out.println(getObjectDescription(domObj)); out.println("

All Entities

UML "); out.println(domClass.getName()); out.println("

There are none...

Domain Check

roles = getAllRoles(domClass); if (!roles.isEmpty()) { Collection insts = RootDomainObject.readAllDomainObjects(Class.forName(domClass.getFullName())); if (insts.size() == 0) { out.print("

Can't check "); out.print(domClass.getFullName()); out.println(": there are no instances!

"); } else { for (Role role : roles) { String header = "

Checking role " + role.getName() + " for class " + domClass.getFullName() + "

Summary: "); out.print(insts.size()); out.print("total objects, "); out.print(objsWithRoleNonEmpty); out.print(" relations checked, "); out.print(objsWithInverseOK); out.println(" relations with inverse OK

"); } } } } } } else { out.println("

There are none...

\n"); } } protected void renderWrongRelation(PrintWriter out, DomainObject obj, Role role) throws Exception { System.out.println("wrong relation"); out.println("

"); renderObjectId(out, obj); out.println("

\n"); } private boolean checkInverseRelation(DomainObject source, DomainObject target, Role role) { Role inverseRole = null; for (Role otherRole : (List) role.getRelation().getRoles()) { if (otherRole != role) { inverseRole = otherRole; break; } } Object inverseRoleValue = getAttributeValue(target, inverseRole.getName()); if (inverseRole.getMultiplicityUpper() == 1) { return (source == getDomainObject(inverseRoleValue)); } else { return ((Collection) inverseRoleValue).contains(source); } } private static HashMap> domainClassesAttributes = new HashMap>(); protected synchronized List getAllAttrs(DomainClass domClass) { List attrs = domainClassesAttributes.get(domClass); if (attrs == null) { attrs = new ArrayList(); DomainEntity domEntity = domClass; while (domEntity instanceof DomainClass) { DomainClass dClass = (DomainClass) domEntity; Iterator slots = dClass.getSlots(); while (slots.hasNext()) { attrs.add(((Slot) slots.next()).getName()); } domEntity = dClass.getSuperclass(); } Collections.sort(attrs); domainClassesAttributes.put(domClass, attrs); } return attrs; } private static HashMap> domainClassesRoles = new HashMap>(); private static final Comparator ROLE_COMPARATOR = new Comparator() { public int compare(Role r1, Role r2) { return r1.getName().compareTo(r2.getName()); } }; protected List getAllRoles(DomainClass domClass) { List roles = domainClassesRoles.get(domClass); if (roles == null) { roles = new ArrayList(); DomainEntity domEntity = domClass; while (domEntity instanceof DomainClass) { DomainClass dClass = (DomainClass) domEntity; Iterator roleSlots = dClass.getRoleSlots(); while (roleSlots.hasNext()) { Role role = (Role) roleSlots.next(); if (role.getName() != null) { roles.add(role); } } domEntity = dClass.getSuperclass(); } Collections.sort(roles, ROLE_COMPARATOR); domainClassesRoles.put(domClass, roles); } return roles; } private static List allDomainClasses = null; protected List getAllDomainClasses() { if (allDomainClasses == null) { allDomainClasses = new ArrayList(); for (Iterator iter = domainModel.getClasses(); iter.hasNext();) { allDomainClasses.add((DomainClass) iter.next()); } Collections.sort(allDomainClasses, new Comparator() { public int compare(DomainClass dc1, DomainClass dc2) { return dc1.getName().compareTo(dc2.getName()); } }); } return allDomainClasses; } protected String capitalize(String str) { if ((str == null) || Character.isUpperCase(str.charAt(0))) { return str; } else { return Character.toUpperCase(str.charAt(0)) + str.substring(1); } } protected String firstCharToLower(String str) { return Character.toLowerCase(str.charAt(0)) + str.substring(1); } protected DomainObject getDomainObject(Object obj) { return (DomainObject) obj; } static class RequestParams { private static final String[] OPTIONAL_PARAMS = { "start", "max", "showColSize" }; @Linkare(author = "Paulo Zenida", comments = "Changed the default max value from 100 to 300") public static final int DEFAULT_MAX = 300; String path; String classFullName = null; DomainClass domClass = null; Class javaClass = null; long oid = -1; String roleName = null; Role role = null; int start = 1; int max = DEFAULT_MAX; boolean showColSize = false; String buildURL() { StringBuilder sb = new StringBuilder(); sb.append(path); String sep = "?"; if (classFullName != null) { sb.append(sep); sb.append("domainClass="); sb.append(classFullName); sep = "&"; } if (oid != -1) { sb.append(sep); sb.append("OID="); sb.append(oid); sep = "&"; } if (roleName != null) { sb.append(sep); sb.append("role="); sb.append(roleName); sep = "&"; } if (start > 1) { sb.append(sep); sb.append("start="); sb.append(start); sep = "&"; } if (max != DEFAULT_MAX) { sb.append(sep); sb.append("max="); sb.append(max); sep = "&"; } return sb.toString(); } static RequestParams parse(HttpServletRequest req, String... paramNames) { RequestParams params = new RequestParams(); params.path = req.getPathInfo().substring(1); try { for (String name : paramNames) { String value = req.getParameter(name); if (value == null) { return null; } if (name.equals("domainClass")) { params.classFullName = value; params.javaClass = Class.forName(value); params.domClass = domainModel.findClass(value); if (params.domClass == null) { return null; } } else if (name.equals("OID")) { params.oid = Long.parseLong(value); params.domClass = domainModel.findClass(Transaction.getClassnameForOID(params.oid)); } else if (name.equals("role")) { params.roleName = value; params.role = params.domClass.findRoleSlot(value); if (params.role == null) { return null; } } else { return null; } } } catch (Exception e) { return null; } // parse optional parameters for (String name : OPTIONAL_PARAMS) { String value = req.getParameter(name); if (value != null) { try { if (name.equals("start")) { params.start = Integer.parseInt(value); } else if (name.equals("max")) { params.max = Integer.parseInt(value); } else if (name.equals("showColSize")) { params.showColSize = true; } } catch (Exception e) { // ignore it } } } return params; } } static class SpecializedMethod { Method method = null; } private static HashMap specializedMethods = new HashMap(); protected static String getSpecializedDescription(Object obj) { Method m = findSpecializedMethod(obj.getClass()); if (m != null) { try { return (String) m.invoke(null, obj); } catch (Exception e) { // ignore errors on the method } } return null; } protected synchronized static Method findSpecializedMethod(Class objClass) { SpecializedMethod sm = specializedMethods.get(objClass); if (sm == null) { sm = new SpecializedMethod(); specializedMethods.put(objClass, sm); while (objClass != null) { try { Method m = DomainObjectsExternalDescriptions.class.getMethod("getShortDescription", objClass); sm.method = m; // finish the loop because we found it already... break; } catch (Exception e) { // not found the method, so continue the loop } objClass = objClass.getSuperclass(); } } return sm.method; } }