/ - Diff - D-Net - D-Net project tracking tool

« Previous | Next »

Revision 47819

Added by Alessia Bardi almost 7 years ago

[maven-release-plugin] copy for tag cnr-enabling-inspector-2.0.2

modules/cnr-enabling-inspector/tags/cnr-enabling-inspector-2.0.2/deploy.info

{"type_source": "SVN", "goal": "package -U -T 4C source:jar", "url": "http://svn-public.driver.research-infrastructures.eu/driver/dnet45/modules/cnr-enabling-inspector/trunk/", "deploy_repository": "dnet45-snapshots", "version": "4", "mail": "sandro.labruzzo@isti.cnr.it,michele.artini@isti.cnr.it, claudio.atzori@isti.cnr.it, alessia.bardi@isti.cnr.it", "deploy_repository_url": "http://maven.research-infrastructures.eu/nexus/content/repositories/dnet45-snapshots", "name": "cnr-enabling-inspector"}

     package eu.dnetlib.enabling.inspector;
     import org.junit.Before;
     import org.junit.Test;
     import eu.dnetlib.enabling.tools.CompatResourceIdentifierResolverImpl;
     public class ResourceLinkToolTest {
     	private static String PROFILE =
     		"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"+
     		"<RESOURCE_PROFILE xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n"+
     		    "<HEADER>\n"+
     		        "<RESOURCE_IDENTIFIER value=\"3cdc5e58-24c6-47ac-b678-401c84956e35_VHJhbnNmb3JtYXRpb25EU1Jlc291cmNlcy9UcmFuc2Zvcm1hdGlvbkRTUmVzb3VyY2VUeXBl\"/>\n"+
     		        "<RESOURCE_TYPE value=\"TransformationDSResourceType\"/>\n"+
     		        "<RESOURCE_KIND value=\"TransformationDSResources\"/>\n"+
     		        "<RESOURCE_URI value=\"http://146.48.85.175:8280/efg-is/services/msro\"/>\n"+
     		        "<DATE_OF_CREATION value=\"2010-10-27T10:41:24+02:00\"/>\n"+
     		    "</HEADER>\n"+
     		    "<BODY>\n"+
     		        "<CONFIGURATION>\n"+
     		            "<REPOSITORY_SERVICE_IDENTIFIER>d937bab1-d44c-44aa-bf7d-df5312a3b623_UmVwb3NpdG9yeVNlcnZpY2VSZXNvdXJjZXMvUmVwb3NpdG9yeVNlcnZpY2VSZXNvdXJjZVR5cGU=</REPOSITORY_SERVICE_IDENTIFIER>\n"+
     		            "<TRANSFORMATION_MANAGER_SERVICE_IDENTIFIER/>\n"+
     		            "<TRANSFORMATION_MANAGER_SERVICE_URI/>\n"+
     		            "<SOURCE_METADATA_FORMATS>\n"+
     		                "<SOURCE_METADATA_FORMAT name=\"oai_efg\" layout=\"store\" interpretation=\"native\"/>\n"+
     		            "</SOURCE_METADATA_FORMATS>\n"+
     		            "<SINK_METADATA_FORMAT interpretation=\"cleaned\" name=\"oai_efg\" layout=\"store\"/>\n"+
     		            "<DATA_SOURCES>\n"+
     		                "<DATA_SOURCE>dnet://MDStoreDS/8d1ab5bb-176c-4eef-9ed3-b46a0aa31d09_TURTdG9yZURTUmVzb3VyY2VzL01EU3RvcmVEU1Jlc291cmNlVHlwZQ==</DATA_SOURCE>\n"+
     		            "</DATA_SOURCES>\n"+
     		            "<DATA_SINK>dnet://MDStoreDS/a3a2c757-1726-41b2-9e37-bceb3f8bbd8b_TURTdG9yZURTUmVzb3VyY2VzL01EU3RvcmVEU1Jlc291cmNlVHlwZQ==?type=REFRESH</DATA_SINK>\n"+
     		            "<TRANSFORMATION_RULE_DS_IDENTIFIER/>\n"+
     		            "<SCHEDULING/>\n"+
     		        "</CONFIGURATION>\n"+
     		        "<STATUS>\n"+
     		            "<LAST_UPDATE_DATE>2011-01-24T17:22:09+01:00</LAST_UPDATE_DATE>\n"+
     		            "<LAST_UPDATE_STATUS>LAST_UPDATE_STATUS</LAST_UPDATE_STATUS>\n"+
     		            "<LAST_UPDATE_ERROR_MESSAGE>LAST_UPDATE_ERROR_MESSAGE</LAST_UPDATE_ERROR_MESSAGE>\n"+
     		        "</STATUS>\n"+
     		        "<SECURITY_PARAMETERS>SECURITY_PARAMETERS</SECURITY_PARAMETERS>\n"+
     		    "</BODY>\n"+
     		"</RESOURCE_PROFILE>";
     	private ResourceLinkTool linkTool;
     	@Before
     	public void setUp() throws Exception {
     		linkTool = new ResourceLinkTool();
     		linkTool.setResolver(new CompatResourceIdentifierResolverImpl());
+    	}
     	@Test
     	public void linkfyToHtmlTest() {
     		System.out.println(linkTool.linkfyToHtml(PROFILE));
+    	}
+    }

     package eu.dnetlib.enabling.inspector;
     import static org.junit.Assert.*;
     import org.apache.commons.logging.Log;
     import org.apache.commons.logging.LogFactory;
     import org.dom4j.DocumentException;
     import org.junit.Before;
     import org.junit.Test;
     public class TouchUtilsTest {
     	private static final Log log = LogFactory.getLog(TouchUtilsTest.class); // NOPMD by marko on 11/24/08 5:02 PM
     	private transient TouchUtils touch;
     	@Before
     	public void setUp() throws Exception {
     		touch = new TouchUtils();
+    	}
     	@Test
     	public void testUpdateProfile() throws DocumentException {
     		log.fatal("test");
     		final String res = touch.updateProfile("<a><b/></a>", "/a/b");
     		System.out.println(res);
+    	}
     	@Test(expected = DocumentException.class)
     	public void testUpdateProfile2() throws DocumentException {
     		touch.updateProfile("<a><b/></a>", "/a/x");
+    	}
     	@Test(expected = DocumentException.class)
     	public void testUpdateProfile3() throws DocumentException {
     		touch.updateProfile("<a>xx</a>", "/a/text()");
+    	}
     	@Test
     	public void testVerifyIsDate() {
     		assertTrue(touch.verifyIsDate("2010-04-27T12:04:22+02:00"));
     		assertTrue(touch.verifyIsDate("2010-04-27T12:04:22Z"));
     		assertTrue(touch.verifyIsDate("2010-04-27T12:04:22+00:00"));
     		assertTrue(touch.verifyIsDate("2010-04-27T12:04:22+0000"));
     		assertFalse(touch.verifyIsDate("201asdas"));
+    	}
     	@Test
     	public void testSpanize() {
     		String res = touch.spanize("<a><b/><b><c v='1'/><c v='2'/></b></a>");
     		System.out.println(res);
+    	}
+    }

     log4j.rootLogger=INFO, Console
     log4j.appender.Console=org.apache.log4j.ConsoleAppender
     log4j.appender.Console.layout=org.apache.log4j.PatternLayout
     log4j.appender.Console.layout.ConversionPattern=%-5p [%t] %37c %3x - %m%n
     log4j.logger.eu.dnetlib=INFO
     log4j.logger.eu.dnetlib.enabling.test=DEBUG
     log4j.logger.eu.dnetlib.enabling.is.sn=DEBUG
     log4j.logger.eu.dnetlib.enabling.is.sn.resourcestate=DEBUG
     log4j.logger.org.apache.cxf.interceptor=FATAL
     log4j.logger.org.apache.cxf.ws.addressing.ContextUtils=FATAL
     log4j.logger.eu.dnetlib.enabling.tools.AbstractBaseService=INFO
     log4j.logger.eu.dnetlib.xml.database.LoggingTrigger=FATAL
     log4j.logger.eu.dnetlib.enabling.inspector=WARN

     package eu.dnetlib.enabling.inspector;
     import java.util.List;
     import java.util.regex.Matcher;
     import java.util.regex.Pattern;
     import org.springframework.beans.factory.annotation.Required;
     import com.google.common.collect.Lists;
     import eu.dnetlib.enabling.tools.ResourceIdentifierResolver;
     /**
      * This class allows to create links between profiles.
+     *
      * @author claudio
+     *
      */
     public class ResourceLinkTool {
     	/**
     	 * Regular expression used to match resource ids.
     	 */
     	private static String REGEX = "([a-zA-Z0-9]+\\-)+[a-zA-Z0-9]+_[a-zA-Z0-9]+";
     	/**
     	 * Base url.
     	 */
     	private String serviceBaseUrl;
     	/**
     	 * ResourceIdentifierResolver.
     	 */
     	private ResourceIdentifierResolver resolver;
     	/**
     	 * Method parses a profile and transforms all the ids into an html link
+    	 *
     	 * @param profile
     	 * 			the given profile.
     	 * @return
     	 * 			the linkfied profile
     	 */
     	public String linkfyToHtml(final String profile) {
     		String tmp = new String(profile);
     		for (String id : enumerateIds(profile))
     			tmp = tmp.replaceAll(id, toLink(id));
     		return tmp;
+    	}
     	/**
     	 * Performs the actual transformation.
+    	 *
     	 * @param id
     	 * @return
     	 */
     	protected String toLink(String id) {
     		return "<a href=\"" + serviceBaseUrl +
     					"/inspector/index.do/db/DRIVER/" +
     					getResolver().getCollectionName(id) + "/" +
     					getResolver().getFileName(id) + "/show\">" + id + "</a>";
+    	}
     	/**
     	 * Lists all the ids in the given profile.
+    	 *
     	 * @param profile
     	 * @return
     	 */
     	private List<String> enumerateIds(final String profile) {
     		List<String> ids = Lists.newArrayList();
     		String tmp = new String(profile);
     		Pattern p = Pattern.compile(REGEX);
     		Matcher m = p.matcher(tmp);
     		while(m.find())
     			ids.add(m.group());
     		return ids;
+    	}
     	@Required
     	public void setResolver(ResourceIdentifierResolver resolver) {
     		this.resolver = resolver;
+    	}
     	public ResourceIdentifierResolver getResolver() {
     		return resolver;
+    	}
     	@Required
     	public void setServiceBaseUrl(String serviceBaseUrl) {
     		this.serviceBaseUrl = serviceBaseUrl;
+    	}
     	public String getServiceBaseUrl() {
     		return serviceBaseUrl;
+    	}
+    }

     package eu.dnetlib.enabling.inspector;
     import java.io.StringReader;
     import java.util.List;
     import java.util.Map;
     import java.util.Map.Entry;
     import org.apache.commons.logging.Log;
     import org.apache.commons.logging.LogFactory;
     import org.dom4j.Attribute;
     import org.dom4j.Document;
     import org.dom4j.DocumentException;
     import org.dom4j.Element;
     import org.dom4j.Node;
     import org.dom4j.io.SAXReader;
     import com.google.common.collect.Maps;
     import eu.dnetlib.miscutils.datetime.DateUtils;
     import eu.dnetlib.miscutils.dom4j.XPathHelper;
     /**
      * Utility class that provides the "touch" functionality
+     *
      * @author claudio
+     *
      */
     public class TouchUtils {
     	/**
     	 * logger
     	 */
     	private static final Log log = LogFactory.getLog(TouchUtils.class);
     	/**
     	 * Updates the date value of the given xpath
+    	 *
     	 * @param file
     	 * @param xpath
     	 * @return
     	 * @throws DocumentException
     	 */
     	public String updateProfile(String file, String xpath) throws DocumentException {
     		SAXReader reader = new SAXReader();
     		log.debug("updating XPath: " + xpath);
     		Document document = reader.read(new StringReader(file));
     		Node node = document.selectSingleNode(xpath);
     		if (node == null || (node.getNodeType() != Node.ELEMENT_NODE && node.getNodeType() != Node.ATTRIBUTE_NODE))
     			throw new DocumentException("Invalid xpath: " + xpath + ": " + node);
     		if (verifyIsDate(node.getText()))
     			node.setText(DateUtils.now_ISO8601());
     		return document.asXML();
+    	}
     	/**
+    	 *
     	 * @param text
     	 *            is the value to check
     	 * @return true if text is a well formatted timestamp
     	 */
     	protected boolean verifyIsDate(String text) {
     		try {
     			new DateUtils().parse(text);
     			return true;
     		} catch (IllegalStateException e) {
     			return false;
+    		}
+    	}
     	/**
     	 * Adds "<span id='xpath'>item</span>" where: - item is an element or an attribute name - xpath is the corresponding
     	 * xpath
+    	 *
     	 * @param file
     	 * @return the "spanized" xml file
     	 */
     	protected String spanize(String file) {
     		SAXReader reader = new SAXReader();
     		try {
     			Document document = reader.read(new StringReader(file));
     			traverse(document.getRootElement(), "/*");
     			//TODO find a solution to this crime (damn dom4j!)
     			return document.asXML().replace("&apos;", "'");
     		} catch (DocumentException e) {
     			log.warn(e);
     			return e.getMessage();
+    		}
+    	}
     	private void traverse(Element element, String xpathFather) {
     		int i = 1;
     		for (Element node : XPathHelper.selectElements(element, "./*")) {
     			String xpath = xpathFather + "/*[" + (i++) + "]";
     			Map<Attribute, String> attributeXPaths = Maps.newHashMap();
     			@SuppressWarnings("unchecked")
     			List<Attribute> attributes = (List<Attribute>) node.attributes();
     			for (Attribute attribute : attributes)
     				attributeXPaths.put(attribute, xpath + "/@" + attribute.getName());
     			node.attributes().clear();
     			for (Entry<Attribute, String> entry : attributeXPaths.entrySet()) {
     				Attribute attribute = entry.getKey();
     				String modifiedName = "_|span id='" + entry.getValue() + "'|_" + attribute.getName() + "_|/span|_";
     				node.addAttribute(modifiedName, attribute.getValue());
+    			}
     			if (node.isTextOnly())
     				node.setName("_|span id='" + xpath + "'|_" + node.getName() + "_|/span|_");
     			traverse(node, xpath);
+    		}
+    	}
     	/**
+    	 *
     	 * @param file
     	 * @return
     	 */
     	public String escape(String file) {
     		return file.replace("_|", "<").replace("|_", ">");
+    	}
+    }

     package eu.dnetlib.enabling.inspector;
     import java.util.ArrayList;
     import java.util.HashMap;
     import java.util.List;
     import java.util.Map;
     import javax.annotation.Resource;
     import javax.xml.transform.dom.DOMResult;
     import javax.xml.xpath.XPathExpressionException;
     import javax.xml.xpath.XPathFactory;
     import eu.dnetlib.enabling.is.sn.SubscriptionRegistry;
     import org.apache.commons.logging.Log;
     import org.apache.commons.logging.LogFactory;
     import org.springframework.stereotype.Controller;
     import org.springframework.ui.Model;
     import org.springframework.web.bind.annotation.RequestMapping;
     import org.springframework.web.bind.annotation.RequestParam;
     import eu.dnetlib.enabling.is.sn.NotificationInvocationLogger;
     import eu.dnetlib.enabling.is.sn.resourcestate.ResourceStateSubscription;
     import eu.dnetlib.enabling.is.sn.resourcestate.ResourceStateSubscriptionRegistry;
     import eu.dnetlib.miscutils.coupling.StaticCondition;
     /**
      * Low-level basic interface for managing SN subscriptions.
+     *
      * @author marko
+     *
      */
     @Controller
     public class SubscriptionController extends AbstractInspectorController {
     	/**
     	 * logger.
     	 */
     	private static final Log log = LogFactory.getLog(SubscriptionController.class); // NOPMD by marko on 11/24/08 5:02 PM
     	/**
     	 * is sn subscription registries.
     	 */
     	@Resource(name = "issResourceStateNotificationRegistry")
     	private transient SubscriptionRegistry registry;
     	/**
     	 * allows to control the global enable of issn.
     	 */
     	@Resource(name = "issnInhibitionCondition")
     	private transient StaticCondition inhibitionCondition;
     	/**
     	 * issn invocation logger.
     	 */
     	@Resource
     	private transient NotificationInvocationLogger invocationLogger;
     	/**
     	 * show a list of subscriptions.
+    	 *
     	 * @param model
     	 *            view parameters
     	 * @return view
     	 * @throws XPathExpressionException
     	 *             could happen
     	 */
     	@RequestMapping("/inspector/sn.do")
     	String listSubscriptions(final Model model) throws XPathExpressionException {
     		log.debug("registries: " + registry);
     		final List<Map<String, String>> subscriptions = new ArrayList<Map<String, String>>();
     		for (ResourceStateSubscription sub : registry.listSubscriptions()) {
     			final Map<String, String> attrs = new HashMap<String, String>(); // NOPMD
     			attrs.put("prefix", sub.getPrefix());
     			attrs.put("type", sub.getType());
     			attrs.put("resourceId", sub.getResourceId());
     			attrs.put("xpath", sub.getXpath());
     			attrs.put("id", sub.getSubscriptionId());
     			final DOMResult result = new DOMResult(); // NOPMD
     			sub.getSubscriberAsEpr().writeTo(result);
     			attrs.put("address", XPathFactory.newInstance().newXPath().evaluate("//*[local-name() = 'Address']", result.getNode()));
     			subscriptions.add(attrs);
+    		}
     		model.addAttribute("subscriptions", subscriptions);
     		model.addAttribute("enabled", !inhibitionCondition.isTrue());
     		return "inspector/subscriptions";
+    	}
     	/**
     	 * show a list of subscriptions.
+    	 *
     	 * @param model
     	 *            view parameters
     	  @param address
     	 *            the address prefix used as filter
     	 * @return view
     	 * @throws XPathExpressionException
     	 *             could happen
     	 */
     	@RequestMapping("/inspector/snByAddress.do")
     	String listSubscriptionsByAddress(final Model model, @RequestParam(value="address", required=false) final String address) throws XPathExpressionException {
     		log.debug("registries: " + registry);
     		final List<Map<String, String>> subscriptions = new ArrayList<Map<String, String>>();
     		log.debug("Address is "+address);
     			model.addAttribute("address", address);
     			for (ResourceStateSubscription sub : registry.listSubscriptions()) {
     				final DOMResult result = new DOMResult(); // NOPMD
     				sub.getSubscriberAsEpr().writeTo(result);
     				final String addr = XPathFactory.newInstance().newXPath().evaluate("//*[local-name() = 'Address']", result.getNode());
     				if ( address==null || (addr != null && addr.startsWith(address)) ) {
     					final Map<String, String> attrs = new HashMap<String, String>(); // NOPMD
     					attrs.put("prefix", sub.getPrefix());
     					attrs.put("type", sub.getType());
     					attrs.put("resourceId", sub.getResourceId());
     					attrs.put("xpath", sub.getXpath());
     					attrs.put("id", sub.getSubscriptionId());
                         attrs.put("address", addr);
     					subscriptions.add(attrs);
+    				}
+    			}
     		model.addAttribute("subscriptions", subscriptions);
     		model.addAttribute("enabled", !inhibitionCondition.isTrue());
     		return "inspector/subscriptionsByAddress";
+    	}
     	/**
     	 * toggle global notification inhibit flag.
+    	 *
     	 * @return view name (redirect)
     	 */
     	@RequestMapping("/inspector/toggleNotifications.do")
     	String deleteSubscription() {
     		inhibitionCondition.setCondition(! inhibitionCondition.isTrue());
     		return "redirect:sn.do";
+    	}
     	/**
     	 * delete a issn subscription.
+    	 *
     	 * @param subscriptionId
     	 *            subscription identifier web parameter
     	 * @return view name (redirect)
     	 */
     	@RequestMapping("/inspector/deleteSubscription.do")
     	String deleteSubscription(@RequestParam("id") final String subscriptionId) {
     		registry.removeSubscription(subscriptionId);
     		return "redirect:sn.do";
+    	}
     	/**
     	 * delete issn subscriptions by address prefix.
     	 * @param model
     	 *            view parameters
     	 * @param address
     	 *            address prefix
     	 * @return view name (redirect)
     	 * @throws XPathExpressionException
     	 */
     	@RequestMapping("/inspector/deleteSubscriptionsByAddress.do")
     	String deleteSubscriptionsByAddress(final Model model, @RequestParam("address") final String address) throws XPathExpressionException {
     		final List<String> deleted = new ArrayList<String>();
     		if (address != null && address.length() > "http://".length()) {
     			for (ResourceStateSubscription sub : registry.listSubscriptions()) {
     				final DOMResult result = new DOMResult(); // NOPMD
     				sub.getSubscriberAsEpr().writeTo(result);
     				final String addr = XPathFactory.newInstance().newXPath().evaluate("//*[local-name() = 'Address']", result.getNode());
     				if (addr != null && addr.startsWith(address)) {
     					String id = sub.getSubscriptionId();
     					registry.removeSubscription(id);
     					deleted.add(id + " ("+ addr +")");
+    				}
+    			}
+    		}
     		model.addAttribute("deleted", deleted);
     		return "inspector/deleteSubscriptionsByAddress";
+    	}
     	/**
     	 * Show log of notifications.
+    	 *
     	 * @param model mvc model
     	 */
     	@RequestMapping("/inspector/notificationLog.do")
     	void notificationLog(final Model model) {
     		model.addAttribute("log", invocationLogger.getEntries());
+    	}
+    }

     package eu.dnetlib.enabling.inspector;
     import java.io.File;
     import java.io.FileInputStream;
     import java.io.FileReader;
     import java.io.FilenameFilter;
     import java.io.IOException;
     import java.io.InputStream;
     import java.io.OutputStream;
     import java.io.StringWriter;
     import java.util.Arrays;
     import java.util.Comparator;
     import javax.annotation.Resource;
     import javax.servlet.http.HttpServletResponse;
     import org.apache.commons.logging.Log;
     import org.apache.commons.logging.LogFactory;
     import org.apache.cxf.helpers.IOUtils;
     import org.springframework.stereotype.Controller;
     import org.springframework.ui.Model;
     import org.springframework.web.bind.annotation.RequestMapping;
     import org.springframework.web.bind.annotation.RequestParam;
     import eu.dnetlib.enabling.is.sn.ISSNServiceCore;
     import eu.dnetlib.xml.database.XMLDatabase;
     /**
      * This controller offers a simple way to backup the xmldb.
+     *
      * @author michele
+     *
      */
     @Controller
     public class BackupController extends AbstractInspectorController {
     	/**
     	 * BUFFER size for file copy.
     	 */
     	private static final int BUFFER_SIZE = 4096;
     	/**
     	 * logger.
     	 */
     	private static final Log log = LogFactory.getLog(BackupController.class); // NOPMD by marko on 11/24/08 5:02 PM
     	/**
     	 * xmldb.
     	 */
     	@Resource(name = "existDatabase")
     	private transient XMLDatabase xmlDatabase;
     	/**
     	 * is sn subscription registries.
     	 */
     	@Resource(name = "isSNServiceCore")
     	private transient ISSNServiceCore issnServiceCore;
     	private enum BackupType {
     		profile, subscription
+    	}
     	@RequestMapping(value = "/inspector/backups.do")
     	public void backup(final Model model) {
     		// only view
+    	}
     	@RequestMapping(value = "/inspector/backupProfiles.do")
     	public void backupProfiles(
     			final Model model,
     			@RequestParam(value = "exec", required = false) final String exec,
     			@RequestParam(value = "delete", required = false) final String delete) {
     		if (exec != null && exec.equals("1")) {
     			execProfileBackup(model);
+    		}
     		if (delete != null) {
     			deleteBackup(model, xmlDatabase.getBackupDir(), delete);
+    		}
     		listBackups(model, xmlDatabase.getBackupDir());
+    	}
     	@RequestMapping(value = "/inspector/backupSubscriptions.do")
     	public void backupSubscriptions(
     			final Model model,
     			@RequestParam(value = "exec", required = false) final String exec,
     			@RequestParam(value = "delete", required = false) final String delete) {
     		if (exec != null && exec.equals("1")) {
     			execSubscriptionsBackup(model);
+    		}
     		if (delete != null) {
     			deleteBackup(model, issnServiceCore.getBackupDir(), delete);
+    		}
     		listBackups(model, issnServiceCore.getBackupDir());
+    	}
     	/**
     	 * Executes a backup.
+    	 *
     	 * @param model
     	 *            mvc model
     	 */
     	private void execProfileBackup(final Model model) {
     		try {
     			xmlDatabase.backup();
     			log.info("Backup done");
     		} catch (final Exception e) {
     			model.addAttribute("message", "Backup failed: please retry later");
     			log.fatal("Backup failed", e);
+    		}
+    	}
     	/**
     	 * Executes a backup.
+    	 *
     	 * @param model
     	 *            mvc model
     	 */
     	private void execSubscriptionsBackup(final Model model) {
     		try {
     			issnServiceCore.backup();
     			log.info("Backup done");
     		} catch (final Exception e) {
     			model.addAttribute("message", "Backup failed: please retry later");
     			log.fatal("Backup failed", e);
+    		}
+    	}
     	/**
     	 * Deletes a backup.
+    	 *
     	 * @param model
     	 *            mvc model
     	 * @param backup
     	 *            backup file name
     	 */
     	private void deleteBackup(final Model model, final String backupDir, final String backup) {
     		try {
     			final String logFile = backup.replaceFirst("data-", "report-").replace(".zip", ".log");
     			(new File(backupDir + "/" + backup)).delete();
     			(new File(backupDir + "/" + logFile)).delete();
     			log.info("Backup deleted");
     		} catch (final Exception e) {
     			model.addAttribute("message", "failed: " + e.getMessage());
     			log.info("Backup deletion failed: " + e.getMessage());
+    		}
+    	}
     	/**
     	 * List backups.
+    	 *
     	 * @param model
     	 *            mvc mode
     	 */
     	private void listBackups(final Model model, final String backupDir) {
     		model.addAttribute("size", 0);
     		final File dir = new File(backupDir);
     		if (dir.exists() && dir.isDirectory()) {
     			final FilenameFilter filter = new FilenameFilter() { // NOPMD
     				@Override
     				public boolean accept(final File dir, final String name) {
     					return (name.startsWith("data-") && name.endsWith(".zip"));
+    				}
     			};
     			final File[] list = dir.listFiles(filter);
     			if (list != null) {
     				Arrays.sort(list, new Comparator<File>(){
     				    @Override
     					public int compare(final File f1, final File f2) {
     				        return Long.valueOf(f1.lastModified()).compareTo(f2.lastModified());
     				    } });
     				model.addAttribute("size", list.length);
     				model.addAttribute("backups", list);
+    			}
+    		}
+    	}
     	/**
     	 * get a backup Log.
+    	 *
     	 * @throws IOException
     	 *             could happen
     	 * @param model
     	 *            mvc model
     	 * @param backup
     	 *            the name of backup
     	 * @throws
     	 */
     	@RequestMapping(value = "/inspector/backupLog.do")
     	void backupLog(final Model model,
     			@RequestParam(value = "backup") final String backup,
     			@RequestParam(value = "type") final String type) throws IOException {
     		final String logFile = backup.replaceFirst("data-", "report-").replace(".zip", ".log");
     		final FileReader freader = new FileReader(getBackupDir(type) + "/" + logFile);
     		final StringWriter blog = new StringWriter();
     		try {
     			IOUtils.copy(freader, blog, BUFFER_SIZE);
     		} finally {
     			freader.close();
+    		}
     		model.addAttribute("log", blog);
     		model.addAttribute("backup", backup);
+    	}
     	/**
     	 * Download a backup.
+    	 *
     	 * @param response
     	 *            response
     	 * @param backup
     	 *            the name of backup
     	 * @param out
     	 *            response stream
     	 * @throws IOException
     	 *             could happen
     	 */
     	@RequestMapping(value = "/inspector/backupDownload.do")
     	void downloadBackup(
     			final HttpServletResponse response,
     			@RequestParam(value = "backup", required = true) final String backup,
     			@RequestParam(value = "type", required = true) final String type,
     			final OutputStream out) throws IOException {
     		response.setContentType("application/zip");
     		final String endUserFilename = backup.replaceFirst("data", "dlib-backup-" + type);
     		response.addHeader("Content-disposition", "attachment; filename=" + endUserFilename);
     		final InputStream backupStream = new FileInputStream(getBackupDir(type) + "/" + backup);
     		try {
     			IOUtils.copy(backupStream, out);
     		} finally {
     			backupStream.close();
+    		}
     		out.flush();
     		out.close();
+    	}
     	private String getBackupDir(final String type) {
     		switch(BackupType.valueOf(type)) {
     			case profile:
     				return xmlDatabase.getBackupDir();
     			case subscription:
     				return issnServiceCore.getBackupDir();
     			default:
     				throw new IllegalArgumentException("wrong backup type parameter: " + type);
+    		}
+    	}
+    }

     package eu.dnetlib.enabling.inspector;
     import java.util.*;
     import java.util.stream.Collectors;
     import java.util.stream.StreamSupport;
     import javax.annotation.Resource;
     import com.google.common.base.Function;
     import com.google.common.collect.Iterators;
     import com.google.common.collect.Lists;
     import org.apache.commons.lang.StringEscapeUtils;
     import org.apache.commons.logging.Log;
     import org.apache.commons.logging.LogFactory;
     import org.springframework.stereotype.Controller;
     import org.springframework.ui.Model;
     import org.springframework.web.bind.annotation.RequestMapping;
     import org.springframework.web.bind.annotation.RequestParam;
     import org.xmldb.api.base.XMLDBException;
     import eu.dnetlib.xml.database.XMLDatabase;
     /**
      * This controller offers a simple way to run arbitrary queries on the xmldb.
+     *
      * @author marko
+     *
      */
     @Controller
     public class QueryController extends AbstractInspectorController {
     	/**
     	 * logger.
     	 */
     	private static final Log log = LogFactory.getLog(QueryController.class); // NOPMD by marko on 11/24/08 5:02 PM
     	/**
     	 * xmldb.
     	 */
     	@Resource(name = "existDatabase")
     	private transient XMLDatabase xmlDatabase;
     	/**
     	 * utility to parse resource ids and allows to navigate them.
     	 */
     	@Resource(name = "resourcelinkTool")
     	private ResourceLinkTool linkTool;
     	/**
     	 * run a query.
+    	 *
     	 * @param model
     	 *            mvc model
     	 * @param query
     	 *            query (optional)
     	 * @throws
     	 */
     	@RequestMapping(value = "/inspector/query.do")
     	void query(final Model model, @RequestParam(value = "query", required = false) final String query) {
     		if (query != null) {
     			log.info("running query: " + query);
     			try {
     				final Iterator<String> it = xmlDatabase.xquery(query);
     				final List<String> res = StreamSupport.stream(Spliterators.spliteratorUnknownSize(it, Spliterator.IMMUTABLE), false)
     						.map(StringEscapeUtils::escapeHtml)
     						.map(linkTool::linkfyToHtml)
     						.collect(Collectors.toList());
     				model.addAttribute("size", res.size());
     				model.addAttribute("results", res);
     			} catch (XMLDBException e) {
     				model.addAttribute("message", "failed: " + e.getMessage());
+    			}
+    		}
     		model.addAttribute("query", query);
+    	}
+    }

     package eu.dnetlib.enabling.inspector;
     import java.io.File;
     import java.io.IOException;
     import java.io.StringReader;
     import java.util.ArrayList;
     import java.util.Collection;
     import java.util.Collections;
     import java.util.HashMap;
     import java.util.List;
     import java.util.Map;
     import javax.annotation.Resource;
     import javax.servlet.ServletOutputStream;
     import javax.servlet.http.HttpServletRequest;
     import javax.servlet.http.HttpServletResponse;
     import org.apache.commons.io.IOUtils;
     import org.apache.commons.lang.StringEscapeUtils;
     import org.apache.commons.logging.Log;
     import org.apache.commons.logging.LogFactory;
     import org.dom4j.DocumentException;
     import org.springframework.stereotype.Controller;
     import org.springframework.ui.Model;
     import org.springframework.web.bind.annotation.RequestMapping;
     import org.springframework.web.bind.annotation.RequestParam;
     import org.xmldb.api.base.XMLDBException;
     import com.google.common.collect.Lists;
     import eu.dnetlib.miscutils.collections.MappedCollection;
     import eu.dnetlib.miscutils.functional.UnaryFunction;
     import eu.dnetlib.xml.database.XMLDatabase;
     /**
      * test controller.
+     *
      * @author marko
      */
     @Controller
     public class ResourceTreeController extends AbstractInspectorController { // NOPMD
     	/**
     	 * The list view uses this model to represent a collection
+    	 *
     	 * @author marko
     	 */
     	public class CollectionModel {
     		/**
     		 * absolute path used to query the xmldb.
     		 */
     		private String path;
     		/**
     		 * relative path, used to construct the uri used by the view.
     		 */
     		private String rel;
     		/**
     		 * the collection name.
     		 */
     		private String name;
     		public CollectionModel(final String path, final String rel, final String name) {
     			super();
     			this.path = path;
     			this.rel = rel;
     			this.name = name;
+    		}
     		/**
     		 * We want to be able to skip useless collections which have only one child collection etc etc.
     		 * <p>
     		 * <p>
     		 * This method returns us the deepest path containing only one collection at each level
     		 * </p>
+    		 *
     		 * @return list of collection names to be displayed in one "row"
     		 */
     		public Collection<CollectionModel> getCollectionPath() {
     			final ArrayList<CollectionModel> res = Lists.newArrayList(this);
     			try {
     				List<String> children = xmlDatabase.listChildCollections(path + '/' + name);
     				if (children.size() == 1) {
     					res.addAll(new CollectionModel(path + '/' + name, rel + '/' + name, children.get(0)).getCollectionPath());
+    				}
     				return res;
     			} catch (XMLDBException e) {
     				return res;
+    			}
+    		}
     		/**
     		 * Uri is computed from relative base path.
+    		 *
     		 * @return
     		 */
     		public String getUrl() {
     			return (rel + '/' + getName());
+    		}
     		public String getPath() {
     			return path;
+    		}
     		public void setPath(final String path) {
     			this.path = path;
+    		}
     		public String getName() {
     			return name;
+    		}
     		public void setName(final String name) {
     			this.name = name;
+    		}
+    	}
     	/**
     	 * base index.do path.
     	 */
     	private static final String INDEX_DO = "/inspector/index.do";
     	/**
     	 * logger.
     	 */
     	private static final Log log = LogFactory.getLog(ResourceTreeController.class); // NOPMD by marko on 11/24/08 5:02 PM
     	/**
     	 * xml database.
     	 */
     	@Resource(name = "existDatabase")
     	private transient XMLDatabase xmlDatabase;
     	/**
     	 * utility to parse resource ids and allows to navigate them.
     	 */
     	@Resource(name = "resourcelinkTool")
     	private ResourceLinkTool linkTool;
     	/**
     	 * debug.
     	 */
     	public ResourceTreeController() {
     		super();
     		log.info("ResourceTreeController created");
+    	}
     	/**
     	 * handles relative paths.
+    	 *
     	 * @return redirect
     	 */
     	// @RequestMapping("/inspector/")
     	// String indexSlash() {
     	// return "redirect:index.do/db/list";
     	// }
     	/**
     	 * handles relative paths.
+    	 *
     	 * @return redirect
     	 */
     	@RequestMapping("/inspector/index.do")
     	String indexDo() {
     		return "redirect:index.do/db/list";
+    	}
     	/**
     	 * index.
+    	 *
     	 * @param model   model
     	 * @param request http request
     	 * @throws XMLDBException happens
     	 */
     	@RequestMapping("/inspector/index.do/**/list")
     	String list(final Model model, final HttpServletRequest request) throws XMLDBException {
     		final String path = request.getPathInfo().replace(INDEX_DO, "").replace("/list", "");
     		log.debug("xml db: " + xmlDatabase);
     		final Collection<String> children = xmlDatabase.listChildCollections(path);
     		final Collection<String> files = xmlDatabase.list(path);
     		Collections.sort((List<String>) children);
     		Collections.sort((List<String>) files);
     		UnaryFunction<CollectionModel, String> mapper = new UnaryFunction<CollectionModel, String>() {
     			@Override
     			public CollectionModel evaluate(final String name) {
     				return new CollectionModel(path, ".", name);
+    			}
     		};
     		final Collection<CollectionModel> richChildren = Lists.newArrayList(new MappedCollection<CollectionModel, String>(children, mapper));
     		model.addAttribute("path", path);
     		model.addAttribute("pathComponents", extractPathComponents(path, ""));
     		model.addAttribute("collections", richChildren);
     		model.addAttribute("files", files);
     		model.addAttribute("title", "Title");
     		return "inspector/index";
+    	}
     	/**
     	 * return a list of pairs (name, relative url bases) for each path component.
+    	 *
     	 * @param path slash separated path
     	 * @param base prepend this to all paths
     	 * @return list of path components
     	 */
     	private List<Map<String, String>> extractPathComponents(final String path, final String base) {
     		final String[] rawPathComponents = path.split("/");
     		final List<Map<String, String>> pathComponents = new ArrayList<Map<String, String>>();
     		for (String rawPathComponent : rawPathComponents) {
     			final Map<String, String> pathElement = new HashMap<String, String>(); // NOPMD
     			pathElement.put("name", rawPathComponent);
     			pathComponents.add(pathElement);
+    		}
     		Collections.reverse(pathComponents);
     		final StringBuffer current = new StringBuffer(base); // NOPMD
     		for (Map<String, String> pathComponent : pathComponents) {
     			pathComponent.put("url", current.toString());
     			current.append("../");
+    		}
     		Collections.reverse(pathComponents);
     		return pathComponents;
+    	}
     	/**
     	 * show a file.
+    	 *
     	 * @param model   model
     	 * @param request request
     	 * @return view name
     	 * @throws XMLDBException happens
     	 */
     	@RequestMapping("/inspector/index.do/**/show")
     	String show(final Model model, final HttpServletRequest request) throws XMLDBException {
     		final String path = request.getPathInfo().replace(INDEX_DO, "").replace("/show", "");
     		log.info("index: " + path);
     		final File fileHelper = new File(path);
     		final String collection = fileHelper.getParent();
     		final String fileName = fileHelper.getName();
     		final TouchUtils touch = new TouchUtils();
     		String file = xmlDatabase.read(fileName, collection);
     		if (file == null) {
     			file = "no such file, click on edit to create";
+    		}
     		file = touch.spanize(file);
     		file = StringEscapeUtils.escapeHtml(file);
     		file = touch.escape(file);
     		// log.info("XML ESCAPED:" + file);
     		model.addAttribute("file", linkTool.linkfyToHtml(file));
     		model.addAttribute("pathComponents", extractPathComponents(collection, "../"));
     		return "inspector/show";
+    	}
     	@RequestMapping("/inspector/index.do/**/touch")
     	public void updateDate(@RequestParam(value = "xpath", required = true) final String xpath,
     			final HttpServletRequest request,
     			final HttpServletResponse response) throws XMLDBException {
     		final String path = request.getPathInfo().replace(INDEX_DO, "").replace("/touch", "");
     		final File fileHelper = new File(path);
     		final String collection = fileHelper.getParent();
     		final String fileName = fileHelper.getName();
     		final TouchUtils touch = new TouchUtils();
     		String file = xmlDatabase.read(fileName, collection);
     		if (file != null) {
     			String updatedProfile;
     			try {
     				updatedProfile = touch.updateProfile(file, xpath);
     				xmlDatabase.update(fileName, collection, updatedProfile);
     			} catch (DocumentException e) {
     				log.warn(e);
+    			}
+    		}
+    	}
     	/**
     	 * Show raw profile.
+    	 *
     	 * @param request  servlet request
     	 * @param response servlet response
     	 * @throws XMLDBException could happen
     	 * @throws IOException
     	 */
     	@RequestMapping("/inspector/index.do/**/raw")
     	public void raw(final HttpServletRequest request, final HttpServletResponse response) throws XMLDBException, IOException {
     		final String path = request.getPathInfo().replace(INDEX_DO, "").replace("/raw", "");
     		// log.info("index: " + path);
     		final File fileHelper = new File(path);
     		final String collection = fileHelper.getParent();
     		final String fileName = fileHelper.getName();
     		String file = xmlDatabase.read(fileName, collection);
     		if (file == null) {
     			file = "no such file to show";
+    		}
     		response.setContentType("text/xml");
     		ServletOutputStream out = response.getOutputStream();
     		IOUtils.copy(new StringReader(file), out);
     		out.flush();
     		out.close();
+    	}
     	/**
     	 * show a file editor.
+    	 *
     	 * @param model   model
     	 * @param request request
     	 * @return view name
     	 * @throws XMLDBException happens
     	 */
     	@RequestMapping("/inspector/index.do/**/edit")
     	public String edit(final Model model, final HttpServletRequest request) throws XMLDBException {
     		final String path = request.getPathInfo().replace(INDEX_DO, "").replace("/edit", "");
     		final File fileHelper = new File(path);
     		final String collection = fileHelper.getParent();
     		final String fileName = fileHelper.getName();
     		final String file = xmlDatabase.read(fileName, collection);
     		if (file == null) {
     			model.addAttribute("creating", "true");
+    		}
     		model.addAttribute("file", StringEscapeUtils.escapeHtml(file));
     		model.addAttribute("pathComponents", extractPathComponents(collection, "../"));
     		return "inspector/edit";
+    	}
     	/**
     	 * update or create a file.
+    	 *
     	 * @param model   model
     	 * @param request request
     	 * @return view name
     	 * @throws XMLDBException happens
     	 */
     	@RequestMapping("/inspector/index.do/**/save")
     	public String save(final Model model, final HttpServletRequest request) throws XMLDBException {
     		final String path = request.getPathInfo().replace(INDEX_DO, "").replace("/save", "");
     		final File fileHelper = new File(path);
     		final String collection = fileHelper.getParent();
     		final String fileName = fileHelper.getName();
     		log.info("saving: " + path);
     		final String source = request.getParameter("source");
     		if ("true".equals(request.getParameter("creating"))) {
     			xmlDatabase.create(fileName, collection, source);
     		} else {
     			xmlDatabase.update(fileName, collection, source);
+    		}
     		return "redirect:show";
+    	}
     	/**
     	 * delete a file.
+    	 *
     	 * @param model   model
     	 * @param request request
     	 * @return view name
     	 * @throws XMLDBException happens
     	 */
     	@RequestMapping("/inspector/index.do/**/delete")
     	public String delete(final Model model, final HttpServletRequest request) throws XMLDBException {
     		final String path = request.getPathInfo().replace(INDEX_DO, "").replace("/delete", "");
     		final File fileHelper = new File(path);
     		final String collection = fileHelper.getParent();
     		final String fileName = fileHelper.getName();
     		log.info("deleting: " + path);
     		xmlDatabase.remove(fileName, collection);
     		return "redirect:../list";
+    	}
     	/**
     	 * delete a collection.
+    	 *
     	 * @param model   model
     	 * @param request request
     	 * @return view name
     	 * @throws XMLDBException happens
     	 */
     	@RequestMapping("/inspector/index.do/**/deleteCollection")
     	public String deleteCollection(final Model model, final HttpServletRequest request) throws XMLDBException {
     		final String path = request.getPathInfo().replace(INDEX_DO, "").replace("/deleteCollection", "");
     		xmlDatabase.removeCollection(path);
     		return "redirect:../list";
+    	}
     	/**
     	 * present a create form for new subcollection
+    	 *
     	 * @param model   model
     	 * @param request request
     	 * @return view name
     	 * @throws XMLDBException happens
     	 */
     	@RequestMapping("/inspector/index.do/**/createsubcoll")
     	public String createSubCollection(final Model model, final HttpServletRequest request) throws XMLDBException {
     		return "inspector/createsubcoll";
+    	}
     	/**
     	 * @param request request
     	 * @return view name
     	 * @throws XMLDBException happens
     	 */
     	@RequestMapping("/inspector/index.do/**/savesubcoll")
     	public String saveSubCollection(final HttpServletRequest request, @RequestParam("collectionPath") final String collectionPath)
     			throws XMLDBException {
     		final String path = request.getPathInfo().replace(INDEX_DO, "").replace("/savesubcoll", "");
     		String fullPath = path + "/" + collectionPath;
     		log.info("Creating subcollection: " + fullPath);
     		if (!xmlDatabase.collectionExists(fullPath)) {
     			xmlDatabase.createCollection(fullPath);
     		} else {
     			log.info("Subcollection: " + fullPath + " already exists");
+    		}
     		return "redirect:../list";
+    	}
     	/**
     	 * present a create form which will redirect to the edit form.
+    	 *
     	 * @param model   model
     	 * @param request request
     	 * @return view name
     	 * @throws XMLDBException happens
     	 */
     	@RequestMapping("/inspector/index.do/**/create")
     	public String create(final Model model, final HttpServletRequest request) throws XMLDBException {
     		return "inspector/create";
+    	}
     	/**
     	 * sample controller.
+    	 *
     	 * @param model model
     	 */
     	@RequestMapping("/inspector/gadget.do")
     	public void gadget(final Model model) {
     		log.info("GADGED CALLED");
     		model.addAttribute("items", new String[] { "one", "two", "three" });
+    	}
+    }

     package eu.dnetlib.enabling.inspector;
     import java.lang.management.ManagementFactory;
     import java.lang.management.RuntimeMXBean;
     import java.util.LinkedHashMap;
     import java.util.Map;
     import javax.annotation.Resource;
     import org.springframework.stereotype.Controller;
     import org.springframework.ui.Model;
     import org.springframework.web.bind.annotation.RequestMapping;
     import eu.dnetlib.miscutils.datetime.DateUtils;
     import eu.dnetlib.miscutils.datetime.HumanTime;
     /**
      * This controller offers generic info about current node (ip, uptime, ...)
+     *
      * @author michele
+     *
      */
     @Controller
     public class GenericInfoController extends AbstractInspectorController {
     	@Resource(name="containerInfo")
     	Map<String,String> containerInfo;
     	@RequestMapping(value = "/inspector/info.do")
     	void query(final Model model) {
     		RuntimeMXBean mxbean = ManagementFactory.getRuntimeMXBean();
     		Map<String,String> sysinfo = new LinkedHashMap<String, String>();
     		sysinfo.put("Uptime", HumanTime.exactly(mxbean.getUptime()));
     		sysinfo.put("Start Time", DateUtils.calculate_ISO8601(mxbean.getStartTime()));
     		sysinfo.put("JVM Name", mxbean.getVmName());
     		sysinfo.put("JVM Vendor", mxbean.getVmVendor());
     		sysinfo.put("JVM Version", mxbean.getVmVersion());
     		sysinfo.put("JVM Spec Name", mxbean.getSpecName());
     		sysinfo.put("JVM Spec Vendor", mxbean.getSpecVendor());
     		sysinfo.put("JVM Spec Version", mxbean.getSpecVersion());
     		sysinfo.put("Running JVM Name", mxbean.getName());
     		sysinfo.put("Management Spec Version", mxbean.getManagementSpecVersion());
     		sysinfo.put("Classpath", mxbean.getClassPath().replaceAll(":", " : "));
     		sysinfo.put("Boot ClassPath", mxbean.getBootClassPath().replaceAll(":", " : "));
     		sysinfo.put("Input arguments", mxbean.getInputArguments().toString());
     		sysinfo.put("Library Path", mxbean.getLibraryPath().replaceAll(":", " : "));
     		sysinfo.put("SystemProperties", mxbean.getSystemProperties().toString());
     		model.addAttribute("containerInfo", containerInfo);
     		model.addAttribute("sysInfo", sysinfo);
+    	}
+    }

... This diff was truncated because it exceeds the maximum size that can be displayed.

Also available in: Unified diff

Project

General

Profile

D-Net

Revision 47819

Added by Alessia Bardi almost 7 years ago