1 /**
2 * This file Copyright (c) 2014-2015 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.config.debug;
35
36 import info.magnolia.cms.util.ExceptionUtil;
37 import info.magnolia.config.registry.DefinitionProvider;
38 import info.magnolia.config.registry.Registry;
39 import info.magnolia.config.registry.RegistryFacade;
40
41 import java.util.Collection;
42 import java.util.Map;
43
44 import org.apache.commons.beanutils.BeanUtils;
45
46 /**
47 * TODO: This class exists only for debug purposes and should be removed as soon as a real ui exist (or turned into a real utility class).
48 * <pre>
49 * import info.magnolia.objectfactory.Components
50 * import info.magnolia.config.registry.RegistryFacade
51 * import info.magnolia.config.debug.ConfigDump
52 * rf = Components.getSingleton(RegistryFacade.class)
53 * println "----------------------------------------"
54 * println "Registries: " + rf.all().collect { it.class.simpleName }
55 * println "----------------------------------------"
56 * println ConfigDump.dump(rf)
57 * println "----------------------------------------"
58 * </pre>
59 */
60 public class ConfigDump {
61
62 public static String dump(RegistryFacade ror) {
63 StringBuilder sb = new StringBuilder();
64
65 for (Registry registry : ror.all()) {
66 dump(sb, registry);
67 }
68
69 return sb.toString();
70 }
71
72 public static String dump(Registry registry) {
73 StringBuilder sb = new StringBuilder();
74 dump(sb, registry);
75 return sb.toString();
76 }
77
78 protected static <T> void dump(StringBuilder sb, Registry<T> registry) {
79 sb.append(registry.type()).append("\n");
80
81 final Collection<DefinitionProvider<T>> all = registry.getAllProviders();
82 for (DefinitionProvider<?> provider : all) {
83 indent(sb, 2).append("Meta:").append(provider.getMetadata()).append("\n");
84 indent(sb, 2).append("Valid: ").append(provider.isValid()).append("\n");
85 indent(sb, 2).append("Errors: ").append(provider.getErrorMessages()).append("\n");
86 indent(sb, 2).append("Raw: ").append(provider.getRaw()).append("\n");
87 indent(sb, 2).append("Bean:").append("\n");
88 printBean(sb, 4, provider.get()).append("\n");
89 }
90 sb.append("\n");
91 }
92
93 private static StringBuilder printBean(StringBuilder sb, int indent, Object configBean) {
94 try {
95 Map<String, String> props = BeanUtils.describe(configBean);
96 for (String propName : props.keySet()) {
97 final String val = props.get(propName);
98 indent(sb, indent).append(propName).append(": ").append(val).append("\n");
99 }
100
101 } catch (Exception e) {
102 sb.append(" --> Could not print bean ").append(configBean).append("\t ").append(ExceptionUtil.exceptionToWords(e)).append('\n');
103 }
104 return sb;
105 }
106
107 private static StringBuilder indent(StringBuilder sb, int i) {
108 for (int j = 0; j < i; j++) {
109 sb.append(" ");
110 }
111 return sb;
112 }
113 }