ZimletUtil.java
| Index Score | ||
|---|---|---|
 |
 |
com.zimbra.cs.zimlet |
 |
 |
Zimbra Collaboration Suite |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| RETURNS | Number of return points from functions |  |
| EXITS | Procedure exits | |
| OPERANDS | Number of operands | |
| LOGICAL_LINES | Number of statements | |
| PROGRAM_LENGTH | Halstead program length | |
| UNIQUE_OPERANDS | Number of unique operands | |
| OPERATORS | Number of operators | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| ELOC | Effective lines of code | |
| CYCLOMATIC | Cyclomatic complexity | |
| LOC | Lines of code | |
| SIZE | Size of the file in bytes | |
| BLOCKS | Number of blocks | |
| COMPARISONS | Number of comparison operators | |
| LINES | Number of lines in the source file | |
| JAVA0266 | JAVA0266 Use of System.out | |
| EXEC_COMMENTS | Comments in executable code | |
| PARAMS | Number of formal parameter declarations | |
| FUNCTIONS | Number of function declarations | |
| JAVA0166 | JAVA0166 Generic exception caught | |
| LOOPS | Number of loops | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| LINE_COMMENT | Number of line comments | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
| JAVA0160 | JAVA0160 Method does not throw specified exception | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0031 | JAVA0031 Case statement not properly closed | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| COMMENTS | Comment lines | |
| DOC_COMMENT | Number of javadoc comment lines | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0128 | JAVA0128 Public constructor in non-public class | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| JAVA0082 | JAVA0082 Unnecessary widening cast | |
| UNIQUE_OPERATORS | Number of unique operators | |
| JAVA0143 | JAVA0143 Synchronized method | |
| JAVA0285 | JAVA0285 Dereference of potentially null variable | |
| JAVA0040 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0116 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0068 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0109 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0064 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0115 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0111 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0032 | JAVA0032 Switch statement missing default | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| WHITESPACE | Number of whitespace lines | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0287 | JAVA0287 Unnecessary null check | |
| NEST_DEPTH | Maximum nesting depth | |
/*
* ***** BEGIN LICENSE BLOCK *****
* Version: ZPL 1.2
*
* The contents of this file are subject to the Zimbra Public License
* Version 1.2 ("License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.zimbra.com/license
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
* the License for the specific language governing rights and limitations
* under the License.
*
* The Original Code is: Zimlets
*
* The Initial Developer of the Original Code is Zimbra, Inc.
* Portions created by Zimbra are Copyright (C) 2005, 2006 Zimbra, Inc.
* All Rights Reserved.
*
* Contributor(s):
*
* ***** END LICENSE BLOCK *****
*/
package com.zimbra.cs.zimlet;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.net.URL;
import java.net.URLClassLoader;
import java.net.URLConnection;
import java.util.Arrays;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.commons.httpclient.Cookie;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.HttpState;
import org.apache.commons.httpclient.cookie.CookiePolicy;
import org.apache.commons.httpclient.methods.PostMethod;
import org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity;
import org.apache.commons.httpclient.methods.multipart.Part;
import org.apache.commons.httpclient.methods.multipart.PartBase;
import com.zimbra.cs.account.AccountServiceException;
import com.zimbra.cs.account.Cos;
import com.zimbra.cs.account.Provisioning;
import com.zimbra.cs.account.NamedEntry;
import com.zimbra.cs.account.Server;
import com.zimbra.cs.account.Zimlet;
import com.zimbra.cs.account.Provisioning.CosBy;
import com.zimbra.cs.account.soap.SoapProvisioning;
import com.zimbra.cs.httpclient.URLUtil;
import com.zimbra.common.localconfig.LC;
import com.zimbra.cs.servlet.ZimbraServlet;
import com.zimbra.common.service.ServiceException;
import com.zimbra.common.util.*;
import com.zimbra.common.soap.*;
import com.zimbra.common.soap.Element;
import com.zimbra.common.soap.SoapHttpTransport;
import com.zimbra.common.soap.Element.XMLElement;
/**
*
* @author jylee
*
*/
public class ZimletUtil {
public static final String ZIMLET_BASE = "/service/zimlet";
public static final String ZIMLET_DEV_DIR = "_dev";
public static final String ZIMLET_ALLOWED_DOMAINS = "allowedDomains";
public static final String ZIMLET_DEFAULT_COS = "default";
private static int P_MAX = Integer.MAX_VALUE;
private static boolean sZimletsLoaded = false;
private static Map<String,ZimletFile> sZimlets = new HashMap<String,ZimletFile>();
private static Map<String,ZimletFile> sDevZimlets = new HashMap<String,ZimletFile>();
private static Map<String,Class> sZimletHandlers = new HashMap<String,Class>();
public static String[] listZimletNames() {
String[] zimlets = sZimlets.keySet().toArray(new String[0]);
Arrays.sort(zimlets);
return zimlets;
}
public static String[] listDevZimletNames() {
String[] zimlets = sDevZimlets.keySet().toArray(new String[0]);
Arrays.sort(zimlets);
return zimlets;
}
public static List<Zimlet> orderZimletsByPriority(List<Zimlet> zimlets) {
// create a sortable collection, sort, then return List<Zimlet> in the
// sorted order. version is not comparable in String format.
List<Pair<Version,Zimlet>> plist = new ArrayList<Pair<Version,Zimlet>>();
for (Zimlet z : zimlets) {
String pstring = z.getPriority();
if (pstring == null) {
// no priority. put it at the end of priority list
pstring = Integer.toString(Integer.MAX_VALUE);
}
Version v = new Version(pstring);
plist.add(new Pair<Version,Zimlet>(v,z));
}
Collections.sort(plist,
new Comparator<Pair<Version,Zimlet>>() {
public int compare(Pair<Version,Zimlet> first,
Pair<Version,Zimlet> second) {
return first.getFirst().compareTo(second.getFirst());
}
}
);
List<Zimlet> ret = new ArrayList<Zimlet>();
for (Pair<Version,Zimlet> p : plist) {
ret.add(p.getSecond());
}
return ret;
}
public static List<Zimlet> orderZimletsByPriority(String[] zimlets) {
Provisioning prov = Provisioning.getInstance();
List<Zimlet> zlist = new ArrayList<Zimlet>();
for (int i = 0; i < zimlets.length; i++) {
try {
Zimlet z = prov.getZimlet(zimlets[i]);
if (z != null)
zlist.add(z);
} catch (ServiceException se) {
// ignore error and continue on
}
}
return orderZimletsByPriority(zlist);
}
public static List<Zimlet> orderZimletsByPriority() throws ServiceException {
Provisioning prov = Provisioning.getInstance();
@SuppressWarnings({"unchecked"})
List<Zimlet> allzimlets = prov.listAllZimlets();
return orderZimletsByPriority(allzimlets);
}
public static void updateZimletConfig(String zimlet, String config) throws ServiceException {
Provisioning prov = Provisioning.getInstance();
Zimlet zim = prov.getZimlet(zimlet);
if (zim == null)
throw AccountServiceException.NO_SUCH_ZIMLET(zimlet);
Map<String, String> map = new HashMap<String, String>();
map.put(Provisioning.A_zimbraZimletHandlerConfig, config);
prov.modifyAttrs(zim, map);
}
public static ZimletConfig getZimletConfig(String zimlet) {
Provisioning prov = Provisioning.getInstance();
try {
Zimlet z = prov.getZimlet(zimlet);
if (z == null)
throw AccountServiceException.NO_SUCH_ZIMLET(zimlet);
String cf = z.getAttr(Provisioning.A_zimbraZimletHandlerConfig);
if (cf == null)
return null;
return new ZimletConfig(cf);
} catch (Exception e) {
ZimbraLog.zimlet.info("error loading zimlet "+zimlet, e);
}
return null;
}
/**
* Loads all the Zimlets, locates the server side ZimletHandler for each Zimlets,
* loads the class and instantiate the object, then returns the instance.
*
* @param name of the Zimlet
* @return ZimletHandler object
*/
public static ZimletHandler getHandler(String name) {
loadZimlets();
Class zh = (Class) sZimletHandlers.get(name);
if (zh == null) {
ZimletFile zf = (ZimletFile) sZimlets.get(name);
if (zf == null) {
return null;
}
try {
String clazz = zf.getZimletDescription().getServerExtensionClass();
if (clazz != null) {
URL[] urls = { zf.toURL() };
URLClassLoader cl = new URLClassLoader(urls, ZimletUtil.class.getClassLoader());
zh = cl.loadClass(clazz);
ZimbraLog.zimlet.info("Loaded class "+zh.getName());
sZimletHandlers.put(name, zh);
}
} catch (Exception e) {
ZimbraLog.zimlet.info("Unable to load zimlet handler: "+e.getMessage());
return null;
}
}
try {
return (ZimletHandler) zh.newInstance();
} catch (Exception e) {
ZimbraLog.zimlet.info("Unable to instantiate zimlet handler: "+e.getMessage());
}
return null;
}
/**
*
* Load all the installed Zimlets.
*
*/
public synchronized static void loadZimlets() {
if (!sZimletsLoaded) {
loadZimletsFromDir(sZimlets, LC.zimlet_directory.value());
sZimletsLoaded = true;
}
}
/**
*
* Load all the Zimlets in the dev test directory.
*
*/
public synchronized static void loadDevZimlets() {
loadZimletsFromDir(sDevZimlets, LC.zimlet_directory.value() + File.separator + ZIMLET_DEV_DIR);
}
/**
*
* Throw away the cached Zimlet, and reloads from the file system.
*
* @param zimlet
* @throws ZimletException
*/
public static void reloadZimlet(String zimlet) throws ZimletException {
ZimletFile zf;
try {
zf = new ZimletFile(LC.zimlet_directory.value() + File.separator + zimlet);
} catch (IOException ioe) {
ZimbraLog.zimlet.info(ioe.getMessage());
return;
}
synchronized (sZimlets) {
sZimlets.remove(zimlet);
sZimlets.put(zimlet, zf);
}
}
/**
*
* Load all the Zimlets found in the directory.
*
* @param zimlets - Zimlet cache
* @param dir - directory
*/
private static void loadZimletsFromDir(Map<String,ZimletFile> zimlets, String dir) {
File zimletRootDir = new File(dir);
if (zimletRootDir == null || !zimletRootDir.exists() || !zimletRootDir.isDirectory()) {
return;
}
ZimbraLog.zimlet.debug("Loading zimlets from " + zimletRootDir.getPath());
synchronized (zimlets) {
zimlets.clear();
String[] zimletNames = zimletRootDir.list();
assert(zimletNames != null);
for (int i = 0; i < zimletNames.length; i++) {
if (zimletNames[i].equals(ZIMLET_DEV_DIR)) {
continue;
}
try {
zimlets.put(zimletNames[i], new ZimletFile(zimletRootDir, zimletNames[i]));
} catch (IOException ioe) {
ZimbraLog.zimlet.info("error loading zimlet "+zimletNames[i]+": "+ioe.getMessage());
} catch (ZimletException ze) {
ZimbraLog.zimlet.info("error loading zimlet "+zimletNames[i]+": "+ze.getMessage());
}
}
}
}
/**
*
* List the Zimlet description as XML or JSON Element.
*
* @param elem - Parent Element node
* @param zimlet
*/
public static void listZimlet(Element elem, String zimlet, int priority) {
loadZimlets();
ZimletFile zim = (ZimletFile) sZimlets.get(zimlet);
if (zim == null) {
ZimbraLog.zimlet.info("cannot find zimlet "+zimlet);
return;
}
try {
String zimletBase = ZIMLET_BASE + "/" + zim.getZimletName() + "/";
Element entry = elem.addElement(AccountConstants.E_ZIMLET);
Element zimletContext = entry.addElement(AccountConstants.E_ZIMLET_CONTEXT);
zimletContext.addAttribute(AccountConstants.A_ZIMLET_BASE_URL, zimletBase);
if (priority >= 0) {
zimletContext.addAttribute(AccountConstants.A_ZIMLET_PRIORITY, priority);
}
zim.getZimletDescription().addToElement(entry);
if (zim.hasZimletConfig()) {
zim.getZimletConfig().addToElement(entry);
}
} catch (ZimletException ze) {
ZimbraLog.zimlet.info("error loading zimlet "+zimlet+": "+ze.getMessage());
} catch (IOException ioe) {
ZimbraLog.zimlet.info("error loading zimlet "+zimlet+": "+ioe.getMessage());
}
}
/**
*
* List the description of all the dev test Zimlets as Element.
*
* @param elem - Parent element node
*/
public static void listDevZimlets(Element elem) {
try {
loadDevZimlets();
synchronized (sDevZimlets) {
Iterator iter = sDevZimlets.values().iterator();
while (iter.hasNext()) {
ZimletFile zim = (ZimletFile) iter.next();
String zimletBase = ZIMLET_BASE + "/" + ZIMLET_DEV_DIR + "/" + zim.getZimletName() + "/";
Element entry = elem.addElement(AccountConstants.E_ZIMLET);
Element zimletContext = entry.addElement(AccountConstants.E_ZIMLET_CONTEXT);
zimletContext.addAttribute(AccountConstants.A_ZIMLET_BASE_URL, zimletBase);
zim.getZimletDescription().addToElement(entry);
if (zim.hasZimletConfig()) {
zim.getZimletConfig().addToElement(entry);
}
}
}
} catch (ZimletException ze) {
ZimbraLog.zimlet.info("error loading dev zimlets: "+ze.getMessage());
} catch (IOException ioe) {
ZimbraLog.zimlet.info("error loading dev zimlets: "+ioe.getMessage());
}
}
private static Map<String,Object> descToMap(ZimletDescription zd) throws ZimletException {
Map<String,Object> attrs = new HashMap<String,Object>();
attrs.put(Provisioning.A_zimbraZimletKeyword, zd.getName());
attrs.put(Provisioning.A_zimbraZimletVersion, zd.getVersion().toString());
attrs.put(Provisioning.A_zimbraZimletDescription, zd.getDescription());
attrs.put(Provisioning.A_zimbraZimletHandlerClass, zd.getServerExtensionClass());
attrs.put(Provisioning.A_zimbraZimletServerIndexRegex, zd.getRegexString());
//attrs.put(Provisioning.A_zimbraZimletContentObject, zd.getContentObjectAsXML());
//attrs.put(Provisioning.A_zimbraZimletPanelItem, zd.getPanelItemAsXML());
//attrs.put(Provisioning.A_zimbraZimletScript, zd.getScripts());
return attrs;
}
private static String getZimletDir() {
return LC.zimlet_directory.value();
}
public static interface DeployListener {
public void markFinished(Server s);
public void markFailed(Server s);
}
/**
* Multinode deploy.
*
* @param zf
* @param listener
* @param auth
* @throws IOException
* @throws ZimletException
* @throws ServiceException
*/
public static void deployZimlet(ZimletFile zf, DeployListener listener, String auth) throws IOException, ZimletException, ServiceException {
Server localServer = Provisioning.getInstance().getLocalServer();
try {
deployZimlet(zf);
if (listener != null)
listener.markFinished(localServer);
} catch (Exception e) {
ZimbraLog.zimlet.info("deploy", e);
if (listener != null)
listener.markFailed(localServer);
}
if (auth == null)
return;
// deploy on the rest of the servers
byte[] data = zf.toByteArray();
ZimletSoapUtil soapUtil = new ZimletSoapUtil(auth);
soapUtil.deployZimlet(zf.getName(), data, listener);
}
enum Action { INSTALL, UPGRADE, REPAIR };
/**
*
* Deploys the specified Zimlets. The following actions are taken.
* 1. Install the Zimlet files on the machine.
* 2. Check the LDAP for the Zimlet entry. If the entry already exists, stop.
* 3. Install the LDAP entry for the Zimlet.
* 4. Install Zimlet config.
* 5. Activate the zimlet on default COS.
* 6. Enable the Zimlet.
*
* @param zimlet
* @throws IOException
* @throws ZimletException
*/
public static void deployZimlet(ZimletFile zf) throws IOException, ZimletException, ServiceException {
Provisioning prov = Provisioning.getInstance();
String zimletName = zf.getZimletName();
ZimletDescription zd = zf.getZimletDescription();
Zimlet z;
Action action = Action.INSTALL;
// check if the zimlet already exists in LDAP.
z = prov.getZimlet(zimletName);
if (z == null) {
// zimlet was not found in LDAP.
z = ldapDeploy(zf);
} else {
// see if this zimlet needs an upgrade.
if (!z.isEnabled()) {
// leave it alone.
ZimbraLog.zimlet.info("Skipping upgrade of disabled Zimlet " + zimletName);
return;
}
Version ver = new Version(z.getAttr(Provisioning.A_zimbraZimletVersion));
if (zd.getVersion().compareTo(ver) < 0) {
ZimbraLog.zimlet.info("Zimlet " + zimletName + " being installed is of an older version.");
return;
}
if (zd.getVersion().compareTo(ver) == 0) {
action = Action.REPAIR;
} else {
action = Action.UPGRADE;
}
}
String priority = null;
String configString = null;
// upgrade
if (action == Action.UPGRADE) {
ZimbraLog.zimlet.info("Upgrading Zimlet " + zimletName + " to " +zd.getVersion().toString());
// save priority and config
priority = z.getPriority();
configString = z.getAttr(Provisioning.A_zimbraZimletHandlerConfig);
prov.deleteZimlet(z.getName());
z = ldapDeploy(zf);
}
// install files
installZimlet(zf);
if (action == Action.REPAIR) {
return;
}
// set the priority
if (priority != null) {
setPriority(z, priority);
} else {
setPriority(zimletName, P_MAX);
}
// install the config
if (configString != null) {
updateZimletConfig(zimletName, configString);
} else if (zf.hasZimletConfig()) {
installConfig(zf.getZimletConfig());
}
// activate
if (!zd.isExtension()) {
activateZimlet(zimletName, ZIMLET_DEFAULT_COS);
}
// enable
enableZimlet(zimletName);
}
/**
*
* Install the Zimlet file on this machine.
*
* @param zimlet
* @return
* @throws IOException
* @throws ZimletException
*/
public static void installZimlet(ZimletFile zf) throws IOException, ZimletException {
ZimletDescription zd = zf.getZimletDescription();
String zimletName = zd.getName();
ZimbraLog.zimlet.info("Installing Zimlet " + zimletName + " on this host.");
String zimletRoot = getZimletDir();
// install the files
File zimletDir = new File(zimletRoot + File.separatorChar + zimletName);
if (!zimletDir.exists()) {
FileUtil.mkdirs(zimletDir);
}
File serviceLibDir = new File(LC.tomcat_directory.value() + File.separator +
"webapps" + File.separator +
"service" + File.separator +
"WEB-INF" + File.separator +
"lib");
File msgPropDir = new File(LC.tomcat_directory.value() + File.separator +
"webapps" + File.separator +
"zimbra" + File.separator +
"WEB-INF" + File.separator +
"classes" + File.separator +
"msgs");
Iterator files = zf.getAllEntries().entrySet().iterator();
while (files.hasNext()) {
Map.Entry f = (Map.Entry) files.next();
ZimletFile.ZimletEntry entry = (ZimletFile.ZimletEntry) f.getValue();
String fname = entry.getName();
File rootDir = zimletDir;
if (fname.endsWith("/") || fname.endsWith("\\")) {
continue;
} else if (fname.endsWith(".jar")) {
rootDir = serviceLibDir;
} else if (fname.endsWith(".properties")) {
rootDir = msgPropDir;
}
File file = new File(rootDir, fname);
file.getParentFile().mkdirs();
writeFile(entry.getContents(), file);
}
}
/**
*
* Deploy the Zimlet to LDAP.
*
* @param zimlet
* @throws IOException
* @throws ZimletException
*/
public static void ldapDeploy(String zimlet) throws IOException, ZimletException {
String zimletRoot = getZimletDir();
ZimletFile zf = new ZimletFile(zimletRoot + File.separator + zimlet);
ldapDeploy(zf);
}
public static Zimlet ldapDeploy(ZimletFile zf) throws IOException, ZimletException {
ZimletDescription zd = zf.getZimletDescription();
String zimletName = zd.getName();
Map<String,Object> attrs = descToMap(zd);
ZimbraLog.zimlet.info("Deploying Zimlet " + zimletName + " in LDAP.");
// add zimlet entry to ldap
Provisioning prov = Provisioning.getInstance();
try {
Zimlet zim = prov.createZimlet(zimletName, attrs);
if (zd.isExtension()) {
Map<String,String> attr = new HashMap<String,String>();
attr.put(Provisioning.A_zimbraZimletIsExtension, Provisioning.TRUE);
prov.modifyAttrs(zim, attr);
}
return zim;
} catch (ServiceException se) {
throw ZimletException.CANNOT_CREATE(zimletName, se);
}
}
private static void writeFile(byte[] src, File dest) throws IOException {
dest.createNewFile();
ByteArrayInputStream bais = new ByteArrayInputStream(src);
FileOutputStream fos = new FileOutputStream(dest);
ByteUtil.copy(bais, true, fos, true);
}
/**
*
* Delete the Zimlet from LDAP.
*
* @param zimlet
* @throws ZimletException
*/
public static void uninstallZimlet(String zimlet, String auth) throws ServiceException, ZimletException {
ZimbraLog.zimlet.info("Uninstalling Zimlet " + zimlet + " from LDAP.");
Provisioning prov = Provisioning.getInstance();
@SuppressWarnings({"unchecked"})
List<Cos> cos = prov.getAllCos();
for (Cos c : cos) {
try {
deactivateZimlet(zimlet, c.getName());
} catch (Exception e) {
ZimbraLog.zimlet.warn("Error deactiving Zimlet " + zimlet + " in LDAP.", e);
}
}
try {
prov.deleteZimlet(zimlet);
} catch (ServiceException se) {
ZimbraLog.zimlet.warn("Error deleting Zimlet " + zimlet + " in LDAP.", se);
}
if (auth == null)
return;
// deploy on the rest of the servers
ZimletSoapUtil soapUtil = new ZimletSoapUtil(auth);
soapUtil.undeployZimlet(zimlet);
}
/**
*
* Add the Zimlet to specified COS.
*
* @param zimlet
* @param cos
* @throws ZimletException
*/
public static void activateZimlet(String zimlet, String cos) throws ZimletException {
ZimbraLog.zimlet.info("Adding Zimlet " + zimlet + " to COS " + cos);
Provisioning prov = Provisioning.getInstance();
try {
Cos c = prov.get(CosBy.name, cos);
if (c == null)
throw ZimletException.CANNOT_ACTIVATE("no such cos " + cos, null);
Map<String,Object> attrs = new HashMap<String, Object>();
attrs.put("+"+Provisioning.A_zimbraZimletAvailableZimlets, zimlet);
prov.modifyAttrs(c, attrs);
ZimletConfig zc = getZimletConfig(zimlet);
if (zc == null)
return;
String allowedDomains = zc.getConfigValue(ZIMLET_ALLOWED_DOMAINS);
if (allowedDomains != null)
addAllowedDomains(allowedDomains, cos);
} catch (ServiceException e) {
throw ZimletException.CANNOT_ACTIVATE(zimlet, e);
}
}
/**
*
* Remove the Zimlet from COS.
*
* @param zimlet
* @param cos
* @throws ZimletException
*/
public static void deactivateZimlet(String zimlet, String cos) throws ZimletException {
ZimbraLog.zimlet.info("Removing Zimlet " + zimlet + " from COS " + cos);
Provisioning prov = Provisioning.getInstance();
try {
Cos c = prov.get(CosBy.name, cos);
if (c == null)
throw ZimletException.CANNOT_ACTIVATE("no such cos " + cos, null);
Map<String,Object> attrs = new HashMap<String, Object>();
attrs.put("-"+Provisioning.A_zimbraZimletAvailableZimlets, zimlet);
prov.modifyAttrs(c, attrs);
ZimletConfig zc = getZimletConfig(zimlet);
if (zc == null)
return;
String domains = zc.getConfigValue(ZIMLET_ALLOWED_DOMAINS);
if (domains == null)
return;
String[] domainArray = domains.toLowerCase().split(",");
Set<String> domainsToRemove = new HashSet<String>();
for (String d : domainArray)
domainsToRemove.add(d);
String[] zimlets = c.getMultiAttr(Provisioning.A_zimbraZimletAvailableZimlets);
for (String z : zimlets) {
if (z.equals(zimlet))
continue;
zc = getZimletConfig(z);
if (zc == null)
continue;
domains = zc.getConfigValue(ZIMLET_ALLOWED_DOMAINS);
if (domains == null)
continue;
domainArray = domains.toLowerCase().split(",");
for (String d : domainArray)
domainsToRemove.remove(d);
}
if (!domainsToRemove.isEmpty())
removeAllowedDomains(domainsToRemove, cos);
} catch (ServiceException e) {
throw ZimletException.CANNOT_DEACTIVATE(zimlet, e);
}
}
/**
*
* Change the enabled status of the Zimlet.
*
* @param zimlet
* @param enabled
* @throws ZimletException
*/
public static void setZimletEnable(String zimlet, boolean enabled) throws ZimletException {
Provisioning prov = Provisioning.getInstance();
try {
Zimlet z = prov.getZimlet(zimlet);
if (z == null)
throw AccountServiceException.NO_SUCH_ZIMLET(zimlet);
Map<String,String> attr = new HashMap<String,String>();
attr.put(Provisioning.A_zimbraZimletEnabled, enabled ? Provisioning.TRUE : Provisioning.FALSE);
prov.modifyAttrs(z, attr);
} catch (Exception e) {
if (enabled)
throw ZimletException.CANNOT_ENABLE(zimlet, e);
else
throw ZimletException.CANNOT_DISABLE(zimlet, e);
}
}
/**
*
* Enable the Zimlet. Only the enabled Zimlets are available to the users.
*
* @param zimlet
* @throws ZimletException
*/
public static void enableZimlet(String zimlet) throws ZimletException {
ZimbraLog.zimlet.info("Enabling Zimlet " + zimlet);
setZimletEnable(zimlet, true);
}
/**
*
* Disable the Zimlet. Disabled Zimlets are not available to the users.
*
* @param zimlet
* @throws ZimletException
*/
public static void disableZimlet(String zimlet) throws ZimletException {
ZimbraLog.zimlet.info("Disabling Zimlet " + zimlet);
setZimletEnable(zimlet, false);
}
/**
*
* Change the Zimlet COS ACL.
*
* @param zimlet
* @param args
* @throws ZimletException
*/
public static void aclZimlet(String zimlet, String[] args) throws ZimletException {
for (int i = 2; i < args.length; i+=2) {
String cos = args[i];
String action = args[i+1].toLowerCase();
if (action.equals("grant")) {
activateZimlet(zimlet, cos);
} else if (action.equals("deny")) {
deactivateZimlet(zimlet, cos);
} else {
throw ZimletException.ZIMLET_HANDLER_ERROR("invalid acl command "+args[i+1]);
}
}
}
/**
*
* List all the COS the Zimlet is available to.
*
* @param zimlet
* @throws ZimletException
*/
public static void listAcls(String zimlet) throws ZimletException {
System.out.println("Listing COS entries for Zimlet "+zimlet+"...");
Provisioning prov = Provisioning.getInstance();
try {
Iterator iter = prov.getAllCos().iterator();
while (iter.hasNext()) {
NamedEntry cos = (NamedEntry) iter.next();
String[] zimlets = cos.getMultiAttr(Provisioning.A_zimbraZimletAvailableZimlets);
for (int i = 0; i < zimlets.length; i++) {
if (zimlets[i].equals(zimlet)) {
System.out.println("\t"+cos.getName());
break;
}
}
}
} catch (Exception e) {
throw ZimletException.ZIMLET_HANDLER_ERROR("cannot list acls "+e.getMessage());
}
}
/**
*
* Print all the Zimlets installed on this host.
*
* @throws ZimletException
*/
public static void listInstalledZimletsOnHost(boolean everything) throws ZimletException {
loadZimlets();
ZimletFile[] zimlets = (ZimletFile[]) sZimlets.values().toArray(new ZimletFile[0]);
Arrays.sort(zimlets);
for (int i = 0; i < zimlets.length; i++) {
ZimletDescription zd;
try {
String extra = "";
zd = zimlets[i].getZimletDescription();
boolean isExtension = (zd != null && zd.isExtension());
if (!everything && isExtension) {
continue;
}
if (isExtension) {
extra += " (ext)";
}
System.out.println("\t"+zimlets[i].getZimletName()+extra);
} catch (IOException ioe) {
ZimbraLog.zimlet.info("error reading zimlet : "+ioe.getMessage());
}
}
}
/**
*
* Print all the Zimlets on LDAP.
*
* @throws ZimletException
*/
public static void listInstalledZimletsInLdap(boolean everything) throws ZimletException {
Provisioning prov = Provisioning.getInstance();
try {
Iterator iter = prov.listAllZimlets().iterator();
while (iter.hasNext()) {
String extra = "";
Zimlet z = (Zimlet) iter.next();
boolean isExtension = z.isExtension();
if (!everything && isExtension) {
continue;
}
if (!z.isEnabled()) {
extra += " (disabled)";
}
if (isExtension) {
extra += " (ext)";
}
System.out.println("\t"+z.getName()+extra);
}
} catch (Exception e) {
throw ZimletException.ZIMLET_HANDLER_ERROR("cannot list installed zimlets in LDAP "+e.getMessage());
}
}
/**
*
* Print the Zimlet COS ACL for all the Zimlets.
*
* @throws ZimletException
*/
public static void listZimletsInCos() throws ZimletException {
Provisioning prov = Provisioning.getInstance();
try {
Iterator iter = prov.getAllCos().iterator();
while (iter.hasNext()) {
NamedEntry cos = (NamedEntry) iter.next();
System.out.println(" "+cos.getName()+":");
String[] zimlets = cos.getMultiAttr(Provisioning.A_zimbraZimletAvailableZimlets);
Arrays.sort(zimlets);
for (int i = 0; i < zimlets.length; i++) {
System.out.println("\t"+zimlets[i]);
}
}
} catch (Exception e) {
throw ZimletException.ZIMLET_HANDLER_ERROR("cannot list zimlets in COS "+e.getMessage());
}
}
/**
*
* Print all the Zimlets installed on the host, on LDAP, and COS ACL.
*
* @throws ZimletException
*/
public static void listAllZimlets(boolean everything) throws ZimletException {
System.out.println("Installed Zimlet files on this host:");
listInstalledZimletsOnHost(everything);
System.out.println("Installed Zimlets in LDAP:");
listInstalledZimletsInLdap(everything);
System.out.println("Available Zimlets in COS:");
listZimletsInCos();
}
/**
*
* Dump the config template for the Zimlet.
*
* @param zimlet
* @throws IOException
* @throws ZimletException
*/
public static void dumpConfig(String zimlet) throws IOException, ZimletException {
ZimletFile zf = new ZimletFile(zimlet);
String config = zf.getZimletConfigString();
System.out.println(config);
}
/**
*
* Install the Zimlet configuration.
*
* @param config
* @throws IOException
* @throws ZimletException
*/
public static void installConfig(ZimletConfig zc) throws IOException, ZimletException {
String zimletName = zc.getName();
ZimbraLog.zimlet.info("Installing Zimlet config for " + zimletName);
String configString = zc.toXMLString();
try {
updateZimletConfig(zimletName, configString);
String allowedDomains = zc.getConfigValue(ZIMLET_ALLOWED_DOMAINS);
if (allowedDomains != null) {
addAllowedDomains(allowedDomains, "default"); // XXX to default cos for now
}
} catch (Exception e) {
throw ZimletException.INVALID_ZIMLET_CONFIG("cannot update Zimlet config for "+zimletName+" : "+e.getMessage());
}
}
public static void addAllowedDomains(String domains, String cosName) throws ServiceException {
Provisioning prov = Provisioning.getInstance();
Cos cos = prov.get(CosBy.name, cosName);
Set<String> domainSet = cos.getMultiAttrSet(Provisioning.A_zimbraProxyAllowedDomains);
String[] domainArray = domains.toLowerCase().split(",");
for (int i = 0; i < domainArray.length; i++) {
domainSet.add(domainArray[i]);
}
Map<String, String[]> newlist = new HashMap<String, String[]>();
newlist.put(Provisioning.A_zimbraProxyAllowedDomains, domainSet.toArray(new String[0]));
prov.modifyAttrs(cos, newlist);
}
public static void removeAllowedDomains(Set<String> domains, String cosName) throws ServiceException {
Provisioning prov = Provisioning.getInstance();
Cos cos = prov.get(CosBy.name, cosName);
Set<String> domainSet = cos.getMultiAttrSet(Provisioning.A_zimbraProxyAllowedDomains);
String[] domainArray = domains.toArray(new String[0]);
for (int i = 0; i < domainArray.length; i++) {
domainSet.remove(domainArray[i]);
}
Map<String, String[]> newlist = new HashMap<String, String[]>();
newlist.put(Provisioning.A_zimbraProxyAllowedDomains, domainSet.toArray(new String[0]));
prov.modifyAttrs(cos, newlist);
}
public static void installConfig(String config) throws IOException, ZimletException {
installConfig(new ZimletConfig(new File(config)));
}
public static void listPriority() throws ServiceException {
List<Zimlet> plist = orderZimletsByPriority();
System.out.println("Pri\tZimlet");
for (int i = 0; i < plist.size(); i++) {
System.out.println(i + "\t" + plist.get(i).getName());
}
}
public static void setPriority(String zimlet, int priority) throws ServiceException {
List<Zimlet> plist = orderZimletsByPriority();
Provisioning prov = Provisioning.getInstance();
Zimlet z = prov.getZimlet(zimlet);
if (z == null)
throw AccountServiceException.NO_SUCH_ZIMLET(zimlet);
setPriority(z, priority, plist);
}
public static void setPriority(Zimlet zimlet, String priority) throws ServiceException {
Provisioning prov = Provisioning.getInstance();
Map<String,String> attr = new HashMap<String,String>();
attr.put(Provisioning.A_zimbraZimletPriority, priority);
prov.modifyAttrs(zimlet, attr);
}
public static void setPriority(Zimlet z, int priority, List<Zimlet> plist) throws ServiceException {
// remove self first
// XXX LdapEntry.equals() is not implemented
for (Zimlet zim : plist) {
if (zim.compareTo(z) == 0) {
plist.remove(zim);
break;
}
}
if (priority == P_MAX) {
priority = plist.size();
}
Version newPriority;
if (priority == 0) {
newPriority = new Version("0");
setPriority(z, newPriority.toString());
plist.add(0, z);
if (plist.size() > 1) {
// make sure the previous p0 zimlet is now p1.
Zimlet p0zimlet = plist.get(1);
setPriority(p0zimlet, 1, plist);
}
} else {
// take the priority of previous zimlet
Zimlet oneAbove = plist.get(priority-1);
String pString = oneAbove.getPriority();
if (pString == null) {
// priority is mandatory now, but it could be from old version
// when we didn't have priorities.
pString = Integer.toString(priority);
}
newPriority = new Version(pString);
if (priority < plist.size()) {
// increment, while staying before the next zimlet
Zimlet oneBelow = plist.get(priority);
pString = oneBelow.getPriority();
if (pString == null) {
pString = Integer.toString(priority+2);
}
Version nextPriority = new Version(pString);
if (newPriority.compareTo(nextPriority) < 0)
newPriority.increment(nextPriority);
else {
// it really is an error because priorities of two zimlets
// shouldn't be the same. bump the next one down
newPriority.increment();
setPriority(z, newPriority.toString());
plist.add(priority, z);
setPriority(oneBelow, priority + 1, plist);
return;
}
} else {
// simply increment from the previous priority
newPriority.increment();
}
setPriority(z, newPriority.toString());
}
}
private static void test() {
String ZIMLET_URL = "^/service/zimlet/([^/\\?]+)[/\\?]?.*$";
String t1 = "/service/zimlet/po";
String t2 = "/service/zimlet/foo?123";
Pattern mPattern = Pattern.compile(ZIMLET_URL);
Matcher matcher = mPattern.matcher(t1);
if (matcher.matches()) {
System.out.println( matcher.group(1) );
}
matcher = mPattern.matcher(t2);
if (matcher.matches()) {
System.out.println( matcher.group(1) );
}
}
private static class ZimletSoapUtil {
private String mUsername;
private String mPassword;
private String mAttachmentId;
private String mAuth;
private SoapHttpTransport mTransport;
private boolean mRunningInServer;
private Provisioning mProv;
public ZimletSoapUtil() throws ServiceException {
mUsername = LC.zimbra_ldap_user.value();
mPassword = LC.zimbra_ldap_password.value();
mAuth = null;
mRunningInServer = false;
SoapProvisioning sp = new SoapProvisioning();
String server = LC.zimbra_zmprov_default_soap_server.value();
sp.soapSetURI(URLUtil.getAdminURL(server));
sp.soapAdminAuthenticate(mUsername, mPassword);
mProv = sp;
}
public ZimletSoapUtil(String auth) {
mAuth = auth;
mRunningInServer = true;
mProv = Provisioning.getInstance();
}
public void deployZimlet(String zimlet, byte[] data, DeployListener listener) throws ServiceException {
List<Server> allServers = mProv.getAllServers();
for (Server server : allServers) {
// localhost is already taken care of.
boolean hasMailboxService = server.getMultiAttrSet(Provisioning.A_zimbraServiceEnabled).contains("mailbox");
if (mRunningInServer && (mProv.getLocalServer().compareTo(server) == 0) ||
!hasMailboxService) {
ZimbraLog.zimlet.info("Skipping on " + server.getName());
continue;
}
ZimbraLog.zimlet.info("Deploying on " + server.getName());
deployZimletOnServer(zimlet, data, server, listener);
}
}
public void undeployZimlet(String zimlet) throws ServiceException {
List<Server> allServers = mProv.getAllServers();
for (Server server : allServers) {
boolean hasMailboxService = server.getMultiAttrSet(Provisioning.A_zimbraServiceEnabled).contains("mailbox");
if (mRunningInServer && (mProv.getLocalServer().compareTo(server) == 0) ||
!hasMailboxService)
continue;
ZimbraLog.zimlet.info("Undeploying on " + server.getName());
undeployZimletOnServer(zimlet, server);
}
}
public void deployZimletOnServer(String zimlet, byte[] data, Server server, DeployListener listener) throws ServiceException {
mTransport = null;
try {
String adminUrl = URLUtil.getAdminURL(server, ZimbraServlet.ADMIN_SERVICE_URI);
mTransport = new SoapHttpTransport(adminUrl);
// auth if necessary
if (mAuth == null)
auth();
mTransport.setAuthToken(mAuth);
// upload
String uploadUrl = URLUtil.getAdminURL(server, "/service/upload");
mAttachmentId = postAttachment(uploadUrl, zimlet, data, server.getName());
// deploy
soapDeployZimlet();
ZimbraLog.zimlet.info("Deploy successful");
if (listener != null)
listener.markFinished(server);
} catch (Exception e) {
if (listener != null)
listener.markFailed(server);
else if (e instanceof ServiceException)
throw (ServiceException)e;
else
throw ServiceException.FAILURE("Unable to deploy Zimlet " + zimlet + " on " + server.getName(), e);
ZimbraLog.zimlet.info("deploy", e);
} finally {
if (mTransport != null)
mTransport.shutdown();
}
}
private void soapDeployZimlet() throws ServiceException, IOException {
XMLElement req = new XMLElement(AdminConstants.DEPLOY_ZIMLET_REQUEST);
req.addAttribute(AdminConstants.A_ACTION, AdminConstants.A_DEPLOYLOCAL);
req.addElement(MailConstants.E_CONTENT).addAttribute(MailConstants.A_ATTACHMENT_ID, mAttachmentId);
mTransport.invoke(req);
}
public void undeployZimletOnServer(String zimlet, Server server) throws ServiceException {
mTransport = null;
try {
String adminUrl = URLUtil.getAdminURL(server, ZimbraServlet.ADMIN_SERVICE_URI);
mTransport = new SoapHttpTransport(adminUrl);
// auth if necessary
if (mAuth == null)
auth();
mTransport.setAuthToken(mAuth);
// undeploy
soapUndeployZimlet(zimlet);
ZimbraLog.zimlet.info("Undeploy successful");
} catch (Exception e) {
if (e instanceof ServiceException)
throw (ServiceException)e;
else
throw ServiceException.FAILURE("Unable to undeploy Zimlet " + zimlet + " on " + server.getName(), e);
} finally {
if (mTransport != null)
mTransport.shutdown();
}
}
private void soapUndeployZimlet(String name) throws ServiceException, IOException {
XMLElement req = new XMLElement(AdminConstants.UNDEPLOY_ZIMLET_REQUEST);
req.addAttribute(AdminConstants.A_ACTION, AdminConstants.A_DEPLOYLOCAL);
req.addAttribute(AdminConstants.A_NAME, name);
mTransport.invoke(req);
}
private String postAttachment(String uploadURL, String name, byte[] data, String domain) throws ZimletException {
String aid = null;
Cookie cookie = new Cookie(domain, ZimbraServlet.COOKIE_ZM_ADMIN_AUTH_TOKEN, mAuth, "/", -1, false);
HttpState initialState = new HttpState();
initialState.addCookie(cookie);
HttpClient client = new HttpClient();
client.setState(initialState);
client.getParams().setCookiePolicy(CookiePolicy.BROWSER_COMPATIBILITY);
PostMethod post = new PostMethod(uploadURL);
client.getHttpConnectionManager().getParams().setConnectionTimeout(10000);
int statusCode = -1;
try {
String contentType = URLConnection.getFileNameMap().getContentTypeFor(name);
Part[] parts = { new ByteArrayPart(data, name, contentType) };
post.setRequestEntity( new MultipartRequestEntity(parts, post.getParams()) );
statusCode = client.executeMethod(post);
if (statusCode == 200) {
String response = post.getResponseBodyAsString();
int lastQuote = response.lastIndexOf("'");
int firstQuote = response.indexOf("','");
if (lastQuote == -1 || firstQuote == -1) {
throw ZimletException.CANNOT_DEPLOY("Attachment post failed, unexpected response: " + response, null);
}
aid = response.substring(firstQuote+3, lastQuote);
} else {
throw ZimletException.CANNOT_DEPLOY("Attachment post failed, status=" + statusCode, null);
}
} catch (IOException e) {
throw ZimletException.CANNOT_DEPLOY("Attachment post failed", e);
} finally {
post.releaseConnection();
}
return aid;
}
private void auth() throws ServiceException, IOException {
XMLElement req = new XMLElement(AdminConstants.AUTH_REQUEST);
req.addElement(AdminConstants.E_NAME).setText(mUsername);
req.addElement(AdminConstants.E_PASSWORD).setText(mPassword);
Element resp = mTransport.invoke(req);
mAuth = resp.getElement(AccountConstants.E_AUTH_TOKEN).getText();
}
private static class ByteArrayPart extends PartBase {
private byte[] mData;
private String mName;
public ByteArrayPart(byte[] data, String name, String type) throws IOException {
super(name, type, "UTF-8", "binary");
mName = name;
mData = data;
}
protected void sendData(OutputStream out) throws IOException {
out.write(mData);
}
protected long lengthOfData() throws IOException {
return mData.length;
}
protected void sendDispositionHeader(OutputStream out) throws IOException {
super.sendDispositionHeader(out);
StringBuilder buf = new StringBuilder();
buf.append("; filename=\"").append(mName).append("\"");
out.write(buf.toString().getBytes());
}
}
}
private static final int INSTALL_ZIMLET = 10;
private static final int UNINSTALL_ZIMLET = 11;
private static final int LIST_ZIMLETS = 12;
private static final int ACL_ZIMLET = 13;
private static final int LIST_ACLS = 14;
private static final int DUMP_CONFIG = 15;
private static final int INSTALL_CONFIG = 16;
private static final int LDAP_DEPLOY = 17;
private static final int DEPLOY_ZIMLET = 18;
private static final int ENABLE_ZIMLET = 19;
private static final int DISABLE_ZIMLET = 20;
private static final int LIST_PRIORITY = 21;
private static final int SET_PRIORITY = 22;
private static final int TEST = 99;
private static final String INSTALL_CMD = "install";
private static final String UNINSTALL_CMD = "uninstall";
private static final String UNDEPLOY_CMD = "undeploy";
private static final String LIST_CMD = "listzimlets";
private static final String ACL_CMD = "acl";
private static final String LIST_ACLS_CMD = "listacls";
private static final String DUMP_CONFIG_CMD = "getconfigtemplate";
private static final String INSTALL_CONFIG_CMD = "configure";
private static final String LDAP_DEPLOY_CMD = "ldapdeploy";
private static final String DEPLOY_CMD = "deploy";
private static final String ENABLE_CMD = "enable";
private static final String DISABLE_CMD = "disable";
private static final String LIST_PRIORITY_CMD = "listpriority";
private static final String SET_PRIORITY_CMD = "setpriority";
private static final String TEST_CMD = "test";
private static Map<String,Integer> mCommands;
private static void addCommand(String cmd, int cmdId) {
mCommands.put(cmd, new Integer(cmdId));
}
private static void setup() {
mCommands = new HashMap<String,Integer>();
addCommand(DEPLOY_CMD, DEPLOY_ZIMLET);
addCommand(UNDEPLOY_CMD, UNINSTALL_ZIMLET);
addCommand(INSTALL_CMD, INSTALL_ZIMLET);
addCommand(UNINSTALL_CMD, UNINSTALL_ZIMLET);
addCommand(LIST_CMD, LIST_ZIMLETS);
addCommand(ACL_CMD, ACL_ZIMLET);
addCommand(LIST_ACLS_CMD, LIST_ACLS);
addCommand(DUMP_CONFIG_CMD, DUMP_CONFIG);
addCommand(INSTALL_CONFIG_CMD, INSTALL_CONFIG);
addCommand(LDAP_DEPLOY_CMD, LDAP_DEPLOY);
addCommand(ENABLE_CMD, ENABLE_ZIMLET);
addCommand(DISABLE_CMD, DISABLE_ZIMLET);
addCommand(LIST_PRIORITY_CMD, LIST_PRIORITY);
addCommand(SET_PRIORITY_CMD, SET_PRIORITY);
addCommand(TEST_CMD, TEST);
}
private static void usage() {
System.out.println("zmzimletctl: [-l] [command] [ zimlet.zip | config.xml | zimlet ]");
System.out.println("\tdeploy {zimlet.zip} - install, ldapDeploy, grant ACL on default COS, then enable Zimlet");
System.out.println("\tundeploy {zimlet} - remove the Zimlet from the system");
System.out.println("\tinstall {zimlet.zip} - installs the Zimlet files on this host");
System.out.println("\tldapDeploy {zimlet} - add the Zimlet entry to the system");
System.out.println("\tenable {zimlet} - enables the Zimlet");
System.out.println("\tdisable {zimlet} - disables the Zimlet");
System.out.println("\tacl {zimlet} {cos1} grant|deny [{cos2} grant|deny...] - change the ACL for the Zimlet on a COS");
System.out.println("\tlistAcls {zimlet} - list ACLs for the Zimlet");
System.out.println("\tlistZimlets - show status of all the Zimlets in the system.");
System.out.println("\tgetConfigTemplate {zimlet.zip} - dumps the configuration");
System.out.println("\tconfigure {config.xml} - installs the configuration");
System.out.println("\tlistPriority - show the current Zimlet priorities (0 high, 9 low)");
System.out.println("\tsetPriority {zimlet} {priority} - set Zimlet priority");
System.exit(1);
}
private static int lookupCmd(String cmd) {
Integer i = (Integer) mCommands.get(cmd.toLowerCase());
if (i == null) {
usage();
}
return i.intValue();
}
private static void dispatch(String[] args) {
boolean localInstall = false;
if (args[argPos].equals("-l")) {
localInstall = true;
argPos++;
}
int cmd = lookupCmd(args[argPos++]);
try {
switch (cmd) {
case LIST_ZIMLETS:
boolean everything = false;
if (args.length > argPos && args[argPos].equals("all")) {
everything = true;
}
listAllZimlets(everything);
System.exit(0);
case LIST_PRIORITY:
listPriority();
System.exit(0);
case TEST:
test();
System.exit(0);
}
if (args.length < argPos+1) {
usage();
}
String zimlet = args[argPos++];
switch (cmd) {
case DEPLOY_ZIMLET:
if (localInstall) {
deployZimlet(new ZimletFile(zimlet));
} else {
ZimletSoapUtil soapUtil = new ZimletSoapUtil();
File zf = new File(zimlet);
soapUtil.deployZimlet(zf.getName(), ByteUtil.getContent(zf), null);
}
break;
case INSTALL_ZIMLET:
installZimlet(new ZimletFile(zimlet));
break;
case UNINSTALL_ZIMLET:
ZimletSoapUtil su = new ZimletSoapUtil();
su.undeployZimlet(zimlet);
break;
case LDAP_DEPLOY:
ldapDeploy(zimlet);
break;
case ACL_ZIMLET:
if (args.length < (argPos+2) || args.length % 2 != 0) {
usage();
}
aclZimlet(zimlet, args);
break;
case SET_PRIORITY:
if (args.length < (argPos+1)) {
usage();
}
setPriority(zimlet, Integer.parseInt(args[argPos]));
listPriority();
break;
case LIST_ACLS:
listAcls(zimlet);
break;
case ENABLE_ZIMLET:
enableZimlet(zimlet);
break;
case DISABLE_ZIMLET:
disableZimlet(zimlet);
break;
case DUMP_CONFIG:
dumpConfig(zimlet);
break;
case INSTALL_CONFIG:
installConfig(zimlet);
break;
default:
usage();
break;
}
} catch (Exception e) {
System.out.println("Error: " + e.getMessage());
System.exit(1);
}
}
private static boolean sQuietMode = false;
private static int argPos = 0;
private static void getOpt(String[] args) {
if (args.length < 1) {
usage();
}
int index = 0;
while (index < args.length) {
if (args[index].equals("-q")) {
sQuietMode = true;
} else {
break;
}
index++;
}
argPos = index;
}
public static void main(String[] args) throws IOException {
getOpt(args);
if (sQuietMode) {
CliUtil.toolSetup("WARN");
} else {
CliUtil.toolSetup();
}
setup();
dispatch(args);
}
}
The table below shows all metrics for ZimletUtil.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 213.00 | Number of blocks | |
| BLOCK_COMMENT | 24.00 | Number of block comment lines | |
| COMMENTS | 252.00 | Comment lines | |
| COMMENT_DENSITY | 0.27 | Comment density | |
| COMPARISONS | 135.00 | Number of comparison operators | |
| CYCLOMATIC | 227.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 27.00 | Comments in declarations | |
| DOC_COMMENT | 190.00 | Number of javadoc comment lines | |
| ELOC | 928.00 | Effective lines of code | |
| EXEC_COMMENTS | 32.00 | Comments in executable code | |
| EXITS | 211.00 | Procedure exits | |
| FUNCTIONS | 68.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 117.93 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 273.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 1.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 3.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 1.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 34.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 1.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 3.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 2.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 0.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 5.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 8.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 3.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 1.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 2.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 4.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 25.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 1.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 3.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 1.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 2.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 2.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 2.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 3053.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 7.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 13.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 4.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 5.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 1.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 29.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 7.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 2.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 1.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 1470.00 | Number of lines in the source file | |
| LINE_COMMENT | 38.00 | Number of line comments | |
| LOC | 1104.00 | Lines of code | |
| LOGICAL_LINES | 660.00 | Number of statements | |
| LOOPS | 15.00 | Number of loops | |
| NEST_DEPTH | 5.00 | Maximum nesting depth | |
| OPERANDS | 3140.00 | Number of operands | |
| OPERATORS | 5417.00 | Number of operators | |
| PARAMS | 84.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 8557.00 | Halstead program length | |
| PROGRAM_VOCAB | 959.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 189.00 | Number of return points from functions | |
| SIZE | 47873.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 892.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 67.00 | Number of unique operators | |
| WHITESPACE | 114.00 | Number of whitespace lines | |