AdminConsole.java 14.2 KB
Newer Older
Bill Lynch's avatar
Bill Lynch committed
1 2
/**
 * $RCSfile$
Bill Lynch's avatar
Bill Lynch committed
3
 * $Revision$
Bill Lynch's avatar
Bill Lynch committed
4 5
 * $Date$
 *
Bill Lynch's avatar
Bill Lynch committed
6
 * Copyright (C) 2004 Jive Software. All rights reserved.
Bill Lynch's avatar
Bill Lynch committed
7
 *
Bill Lynch's avatar
Bill Lynch committed
8 9
 * This software is published under the terms of the GNU Public License (GPL),
 * a copy of which is included in this distribution.
Bill Lynch's avatar
Bill Lynch committed
10 11 12 13 14 15
 */

package org.jivesoftware.admin;

import org.jivesoftware.util.ClassUtils;
import org.jivesoftware.util.Log;
Matt Tucker's avatar
Matt Tucker committed
16
import org.jivesoftware.messenger.XMPPServer;
17 18
import org.dom4j.Document;
import org.dom4j.Element;
19
import org.dom4j.DocumentFactory;
Matt Tucker's avatar
Matt Tucker committed
20
import org.dom4j.io.SAXReader;
Bill Lynch's avatar
Bill Lynch committed
21 22 23 24 25 26

import java.util.*;
import java.io.InputStream;
import java.net.URL;

/**
27 28
 * A model for admin tab and sidebar info. This class loads in xml definitions of the
 * data and produces an in-memory model.<p>
Bill Lynch's avatar
Bill Lynch committed
29
 *
30 31 32 33 34
 * This class loads its data from the <tt>admin-sidebar.xml</tt> file which is assumed
 * to be in the main application jar file. In addition, it will load files from
 * <tt>META-INF/admin-sidebar.xml</tt> if they're found. This allows developers to
 * extend the functionality of the admin console to provide more options. See the main
 * <tt>admin-sidebar.xml</tt> file for documentation of its format.
Bill Lynch's avatar
Bill Lynch committed
35 36 37
 */
public class AdminConsole {

38
    private static Element coreModel;
39
    private static Map<String,Element> overrideModels;
40
    private static Element generatedModel;
Bill Lynch's avatar
Bill Lynch committed
41 42

    static {
43 44 45 46
        init();
    }

    private static void init() {
Matt Tucker's avatar
Matt Tucker committed
47
        overrideModels = new LinkedHashMap<String,Element>();
Bill Lynch's avatar
Bill Lynch committed
48 49 50 51 52 53 54
        load();
    }

    /** Not instantiatable */
    private AdminConsole() {
    }

Bill Lynch's avatar
Bill Lynch committed
55 56 57
    /**
     * Adds XML stream to the tabs/sidebar model.
     *
58
     * @param name the name.
Bill Lynch's avatar
Bill Lynch committed
59 60 61
     * @param in the XML input stream.
     * @throws Exception if an error occurs when parsing the XML or adding it to the model.
     */
62
    public static void addModel(String name, InputStream in) throws Exception {
Matt Tucker's avatar
Matt Tucker committed
63 64
        SAXReader saxReader = new SAXReader();
        Document doc = saxReader.read(in);
65
        addModel(name, (Element)doc.selectSingleNode("/adminconsole"));
Matt Tucker's avatar
Matt Tucker committed
66 67 68 69 70
    }

    /**
     * Adds an &lt;adminconsole&gt; Element to the tabs/sidebar model.
     *
71
     * @param name the name.
Matt Tucker's avatar
Matt Tucker committed
72 73 74
     * @param element the Element
     * @throws Exception if an error occurs.
     */
75 76 77 78 79 80 81 82 83 84 85 86
    public static void addModel(String name, Element element) throws Exception {
        overrideModels.put(name, element);
        rebuildModel();
    }

    /**
     * Removes an &lt;adminconsole&gt; Element from the tabs/sidebar model.
     *
     * @param name the name.
     */
    public static void removeModel(String name) {
        overrideModels.remove(name);
87
        rebuildModel();
Bill Lynch's avatar
Bill Lynch committed
88 89
    }

Bill Lynch's avatar
Bill Lynch committed
90 91 92 93
    /**
     * Returns the name of the application.
     */
    public static String getAppName() {
Matt Tucker's avatar
Matt Tucker committed
94
        Element appName = (Element)generatedModel.selectSingleNode("//adminconsole/global/appname");
95 96 97 98 99 100
        if (appName != null) {
            return appName.getText();
        }
        else {
            return null;
        }
Bill Lynch's avatar
Bill Lynch committed
101 102 103
    }

    /**
104 105 106
     * Returns the URL of the main logo image for the admin console.
     *
     * @return the logo image.
Bill Lynch's avatar
Bill Lynch committed
107 108
     */
    public static String getLogoImage() {
109
        Element globalLogoImage = (Element)generatedModel.selectSingleNode(
Matt Tucker's avatar
Matt Tucker committed
110
                "//adminconsole/global/logo-image");
111 112
        if (globalLogoImage != null) {
            return globalLogoImage.getText();
113
        }
114
        else {
Bill Lynch's avatar
Bill Lynch committed
115 116 117 118
            return null;
        }
    }

119 120 121 122 123 124 125
    /**
     * Returns the URL of the login image for the admin console.
     *
     * @return the login image.
     */
    public static String getLoginLogoImage() {
        Element globalLoginLogoImage = (Element)generatedModel.selectSingleNode(
Matt Tucker's avatar
Matt Tucker committed
126
                "//adminconsole/global/login-image");
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
        if (globalLoginLogoImage != null) {
            return globalLoginLogoImage.getText();
        }
        else {
            return null;
        }
    }

    /**
     * Returns the version string displayed in the admin console.
     *
     * @return the version string.
     */
    public static String getVersionString() {
        Element globalVersion = (Element)generatedModel.selectSingleNode(
Matt Tucker's avatar
Matt Tucker committed
142
                "//adminconsole/global/version");
143 144 145 146
        if (globalVersion != null) {
            return globalVersion.getText();
        }
        else {
Matt Tucker's avatar
Matt Tucker committed
147
            // Default to the Jive Messenger version if none has been provided via XML.
148
            XMPPServer xmppServer = XMPPServer.getInstance();
149
            return xmppServer.getServerInfo().getVersion().getVersionString();
150 151 152
        }
    }

Bill Lynch's avatar
Bill Lynch committed
153
    /**
154
     * Returns the model. The model should be considered read-only.
Bill Lynch's avatar
Bill Lynch committed
155
     *
156
     * @return the model.
Bill Lynch's avatar
Bill Lynch committed
157
     */
158 159
    public static Element getModel() {
        return generatedModel;
Bill Lynch's avatar
Bill Lynch committed
160 161 162
    }

    /**
163 164 165 166 167
     * Convenience method to select an element from the model by its ID. If an
     * element with a matching ID is not found, <tt>null</tt> will be returned.
     *
     * @param id the ID.
     * @return the element.
Bill Lynch's avatar
Bill Lynch committed
168
     */
169
    public static Element getElemnetByID(String id) {
Matt Tucker's avatar
Matt Tucker committed
170
        return (Element)generatedModel.selectSingleNode("//*[@id='" + id + "']");
Bill Lynch's avatar
Bill Lynch committed
171 172 173
    }

    private static void load() {
174
        // Load the core model as the admin-sidebar.xml file from the classpath.
Bill Lynch's avatar
Bill Lynch committed
175 176
        InputStream in = ClassUtils.getResourceAsStream("/admin-sidebar.xml");
        if (in == null) {
177
            Log.error("Failed to load admin-sidebar.xml file from Jive Messenger classes - admin "
Bill Lynch's avatar
Bill Lynch committed
178 179 180 181
                    + "console will not work correctly.");
            return;
        }
        try {
182 183 184
            SAXReader saxReader = new SAXReader();
            Document doc = saxReader.read(in);
            coreModel = (Element)doc.selectSingleNode("/adminconsole");
Bill Lynch's avatar
Bill Lynch committed
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
        }
        catch (Exception e) {
            Log.error("Failure when parsing main admin-sidebar.xml file", e);
        }
        try {
            in.close();
        }
        catch (Exception ignored) {}

        // Load other admin-sidebar.xml files from the classpath
        ClassLoader[] classLoaders = getClassLoaders();
        for (int i=0; i<classLoaders.length; i++) {
            URL url = null;
            try {
                if (classLoaders[i] != null) {
Bill Lynch's avatar
Bill Lynch committed
200
                    Enumeration e = classLoaders[i].getResources("/META-INF/admin-sidebar.xml");
Bill Lynch's avatar
Bill Lynch committed
201 202 203
                    while (e.hasMoreElements()) {
                        url = (URL)e.nextElement();
                        try {
204
                            in = url.openStream();
205
                            addModel("admin", in);
206 207 208 209
                        }
                        finally {
                            try { if (in != null) { in.close(); } }
                            catch (Exception ignored) {}
Bill Lynch's avatar
Bill Lynch committed
210 211 212 213 214 215 216 217 218 219 220 221
                        }
                    }
                }
            }
            catch (Exception e) {
                String msg = "Failed to load admin-sidebar.xml";
                if (url != null) {
                    msg += " from resource: " + url.toString();
                }
                Log.warn(msg, e);
            }
        }
222
        rebuildModel();
Bill Lynch's avatar
Bill Lynch committed
223 224
    }

225 226 227 228 229 230 231 232 233
    /**
     * Rebuilds the generated model.
     */
    private static void rebuildModel() {
        Document doc = DocumentFactory.getInstance().createDocument();
        generatedModel = coreModel.createCopy();
        doc.add(generatedModel);

        // Add in all overrides.
234
        for (Element element : overrideModels.values()) {
235
            // See if global settings are overriden.
Matt Tucker's avatar
Matt Tucker committed
236
            Element appName = (Element)element.selectSingleNode("//adminconsole/global/appname");
237 238
            if (appName != null) {
                Element existingAppName = (Element)generatedModel.selectSingleNode(
Matt Tucker's avatar
Matt Tucker committed
239
                        "//adminconsole/global/appname");
240 241
                existingAppName.setText(appName.getText());
            }
Matt Tucker's avatar
Matt Tucker committed
242
            Element appLogoImage = (Element)element.selectSingleNode("//adminconsole/global/logo-image");
243 244
            if (appLogoImage != null) {
                Element existingLogoImage = (Element)generatedModel.selectSingleNode(
Matt Tucker's avatar
Matt Tucker committed
245
                        "//adminconsole/global/logo-image");
246 247
                existingLogoImage.setText(appLogoImage.getText());
            }
Matt Tucker's avatar
Matt Tucker committed
248 249
            Element appLoginImage = (Element)element.selectSingleNode("//adminconsole/global/login-image");
            if (appLoginImage != null) {
250
                Element existingLoginImage = (Element)generatedModel.selectSingleNode(
Matt Tucker's avatar
Matt Tucker committed
251
                        "//adminconsole/global/login-image");
252 253
                existingLoginImage.setText(appLoginImage.getText());
            }
Matt Tucker's avatar
Matt Tucker committed
254 255
            Element appVersion = (Element)element.selectSingleNode("//adminconsole/global/version");
            if (appVersion != null) {
256
                Element existingVersion = (Element)generatedModel.selectSingleNode(
Matt Tucker's avatar
Matt Tucker committed
257
                        "//adminconsole/global/version");
Matt Tucker's avatar
Matt Tucker committed
258 259 260 261 262 263 264
                if (existingVersion != null) {
                    existingVersion.setText(appVersion.getText());
                }
                else {
                    ((Element)generatedModel.selectSingleNode(
                            "//adminconsole/global")).add(appVersion.createCopy());
                }
265
            }
266 267 268 269 270 271 272
            // Tabs
            for (Iterator i=element.selectNodes("//tab").iterator(); i.hasNext(); ) {
                Element tab = (Element)i.next();
                String id = tab.attributeValue("id");
                Element existingTab = getElemnetByID(id);
                // Simple case, there is no existing tab with the same id.
                if (existingTab == null) {
273 274 275
                    // Make sure that the URL on the tab is set. If not, default to the
                    // url of the first item.
                    if (tab.attributeValue("url") == null) {
Matt Tucker's avatar
Matt Tucker committed
276 277 278 279 280
                        Element firstItem = (Element)tab.selectSingleNode(
                                "//item[@url]");
                        if (firstItem != null) {
                            tab.addAttribute("url", firstItem.attributeValue("url"));
                        }
281
                    }
282 283 284 285 286 287 288 289 290
                    generatedModel.add(tab.createCopy());
                }
                // More complex case -- a tab with the same id already exists.
                // In this case, we have to overrite only the difference between
                // the two elements.
                else {
                    overrideTab(existingTab, tab);
                }
            }
Bill Lynch's avatar
Bill Lynch committed
291
        }
292
    }
293

294 295
    private static void overrideTab(Element tab, Element overrideTab) {
        // Override name, url, description.
Matt Tucker's avatar
Matt Tucker committed
296 297 298 299 300 301 302 303 304
        if (overrideTab.attributeValue("name") != null) {
            tab.addAttribute("name", overrideTab.attributeValue("name"));
        }
        if (overrideTab.attributeValue("url") != null) {
            tab.addAttribute("url", overrideTab.attributeValue("url"));
        }
        if (overrideTab.attributeValue("description") != null) {
            tab.addAttribute("description", overrideTab.attributeValue("description"));
        }
305 306 307 308 309 310 311 312 313 314 315 316 317 318
        // Override sidebar items.
        for (Iterator i=overrideTab.elementIterator(); i.hasNext(); ) {
            Element sidebar = (Element)i.next();
            String id = sidebar.attributeValue("id");
            Element existingSidebar = getElemnetByID(id);
            // Simple case, there is no existing sidebar with the same id.
            if (existingSidebar == null) {
                tab.add(sidebar.createCopy());
            }
            // More complex case -- a sidebar with the same id already exists.
            // In this case, we have to overrite only the difference between
            // the two elements.
            else {
                overrideSidebar(existingSidebar, sidebar);
Bill Lynch's avatar
Bill Lynch committed
319 320 321 322
            }
        }
    }

323 324
    private static void overrideSidebar(Element sidebar, Element overrideSidebar) {
        // Override name.
Matt Tucker's avatar
Matt Tucker committed
325 326 327
        if (overrideSidebar.attributeValue("name") != null) {
            sidebar.addAttribute("name", overrideSidebar.attributeValue("name"));
        }
328 329 330
        // Override entries.
        for (Iterator i=overrideSidebar.elementIterator(); i.hasNext(); ) {
            Element entry = (Element)i.next();
331
            String id = entry.attributeValue("id");
332 333 334 335 336
            Element existingEntry = getElemnetByID(id);
            // Simple case, there is no existing sidebar with the same id.
            if (existingEntry == null) {
                sidebar.add(entry.createCopy());
            }
Matt Tucker's avatar
Matt Tucker committed
337
            // More complex case -- an entry with the same id already exists.
338 339 340 341 342 343 344
            // In this case, we have to overrite only the difference between
            // the two elements.
            else {
                overrideEntry(existingEntry, entry);
            }
        }
    }
345

346 347
    private static void overrideEntry(Element entry, Element overrideEntry) {
        // Override name.
Matt Tucker's avatar
Matt Tucker committed
348 349 350 351 352 353 354 355 356
        if (overrideEntry.attributeValue("name") != null) {
            entry.addAttribute("name", overrideEntry.attributeValue("name"));
        }
        if (overrideEntry.attributeValue("url") != null) {
            entry.addAttribute("url", overrideEntry.attributeValue("url"));
        }
        if (overrideEntry.attributeValue("description") != null) {
            entry.addAttribute("description", overrideEntry.attributeValue("description"));
        }
357 358 359 360 361 362 363 364 365 366 367 368 369 370
        // Override any sidebars contained in the entry.
        for (Iterator i=overrideEntry.elementIterator(); i.hasNext(); ) {
            Element sidebar = (Element)i.next();
            String id = sidebar.attributeValue("id");
            Element existingSidebar = getElemnetByID(id);
            // Simple case, there is no existing sidebar with the same id.
            if (existingSidebar == null) {
                entry.add(sidebar.createCopy());
            }
            // More complex case -- a sidebar with the same id already exists.
            // In this case, we have to overrite only the difference between
            // the two elements.
            else {
                overrideSidebar(existingSidebar, sidebar);
371 372
            }
        }
Bill Lynch's avatar
Bill Lynch committed
373 374 375 376 377 378 379 380 381 382 383 384
    }

    /**
     * Returns an array of class loaders to load resources from.
     */
    private static ClassLoader[] getClassLoaders() {
        ClassLoader[] classLoaders = new ClassLoader[3];
        classLoaders[0] = AdminConsole.class.getClass().getClassLoader();
        classLoaders[1] = Thread.currentThread().getContextClassLoader();
        classLoaders[2] = ClassLoader.getSystemClassLoader();
        return classLoaders;
    }
385
}