yacy_search_server/source/de/anomic/soap/services/StatusService.java

//StatusService.java 
//------------------------
//part of YaCy
//(C) by Michael Peter Christen; mc@anomic.de
//first published on http://www.anomic.de
//Frankfurt, Germany, 2005
//
//this file was contributed by Martin Thelian
//last major change: $LastChangedDate$ by $LastChangedBy$
//Revision: $LastChangedRevision$
//
//This program is free software; you can redistribute it and/or modify
//it under the terms of the GNU General Public License as published by
//the Free Software Foundation; either version 2 of the License, or
//(at your option) any later version.
//
//This program is distributed in the hope that it will be useful,
//but WITHOUT ANY WARRANTY; without even the implied warranty of
//MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//GNU General Public License for more details.
//
//You should have received a copy of the GNU General Public License
//along with this program; if not, write to the Free Software
//Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//Using this software in any meaning (reading, learning, copying, compiling,
//running) means that you agree that the Author(s) is (are) not responsible
//for cost, loss of data or any harm that may be caused directly or indirectly
//by usage of this softare or this documentation. The usage of this software
//is on your own risk. The installation and usage (starting/running) of this
//software may allow other people or application to access your computer and
//any attached devices and is highly dependent on the configuration of the
//software which must be done by the user of the software; the author(s) is
//(are) also not responsible for proper configuration and usage of the
//software, even if provoked by documentation provided together with
//the software.
//
//Any changes to this file according to the GPL as documented in the file
//gpl.txt aside this file in the shipment you received can be done to the
//lines that follows this copyright notice here, but changes must not be
//done inside the copyright notive above. A re-distribution must contain
//the intact and unchanged copyright notice.
//Contributions and changes to the program code must be marked as such.


package de.anomic.soap.services;

import org.apache.axis.AxisFault;
import org.w3c.dom.Document;

import de.anomic.server.serverObjects;
import de.anomic.soap.AbstractService;
import de.anomic.yacy.yacyCore;

public class StatusService extends AbstractService {
    
	/* =====================================================================
	 * Used XML Templates
	 * ===================================================================== */	
    /**
     * Constant: template for the network status page
     */    
    private static final String TEMPLATE_NETWORK_XML = "Network.xml";    
    private static final String TEMPLATE_QUEUES_XML = "xml/queues_p.xml";
    private static final String TEMPLATE_STATUS_XML = "xml/status_p.xml";
    
	/* =====================================================================
	 * Constants needed to query the network status
	 * ===================================================================== */
    private static final int NETWORK_OVERVIEW = 0;
    private static final int NETWORK_ACTIVE_PEERS = 1;
    private static final int NETWORK_PASSIVE_PEERS = 2;
    private static final int NETWORK_POTENTIAL_PEERS = 3;
    
    /**
     * @return
     * @throws Exception
     * @deprecated kept for backward compatibility 
     */
    public Document network() throws Exception {
    	return this.getNetworkOverview();
    }
    
    public Document getNetworkOverview() throws Exception {
    	// extracting the message context
    	extractMessageContext(NO_AUTHENTICATION);  

    	// return DOM
    	return getNetworkData(NETWORK_OVERVIEW);
    }
    
    public Document getActivePeers() throws Exception {
    	// extracting the message context
    	extractMessageContext(NO_AUTHENTICATION);  

    	// return DOM
    	return getNetworkData(NETWORK_ACTIVE_PEERS);
    }    
    
    public Document getPassivePeers() throws Exception {
    	// extracting the message context
    	extractMessageContext(NO_AUTHENTICATION);  

    	// return DOM
    	return getNetworkData(NETWORK_PASSIVE_PEERS);
    }        
    
    public Document getPotentialPeers() throws Exception {
    	// extracting the message context
    	extractMessageContext(NO_AUTHENTICATION);  

    	// return DOM
    	return getNetworkData(NETWORK_POTENTIAL_PEERS);
    }      
    
    private Document getNetworkData(int page) throws Exception {    
    	if (page < 0 || page > 3) page = 0;
    	
    	serverObjects post = new serverObjects();
    	post.put("page", Integer.toString(page));
    	
    	// generating the template containing the network status information
    	byte[] result = this.serverContext.writeTemplate(TEMPLATE_NETWORK_XML, post, this.requestHeader);
    	
    	// sending back the result to the client
    	return this.convertContentToXML(result);    	
    }
    
    
    /**
     * Returns a list of peers this peer currently knows
     * @param peerType the peer types to query. This could be
     * <ul>
     * <li>active</li>
     * <li>passive</li>
     * <li>potential</li>
     * </ul>
     * @param maxCount the maximum amount of records to return
     * @param details if detailed informations should be returned
     * 
     * @return a XML document of the following format
     * <pre>
     * &lt;?xml version="1.0" encoding="UTF-8"?&gt;
     * &lt;peers&gt;
     *   &lt;peer&gt;
     *     &lt;hash&gt;XXXXXXX&lt;/hash&gt;
     *     &lt;fullname&gt;Peer Name&lt;/fullname&gt;
     *     &lt;version&gt;0.424/01505&lt;/version&gt;
     *     &lt;ppm&gt;0&lt;/ppm&gt;
     *     &lt;uptime&gt;2 days 14:37&lt;/uptime&gt;
     *     &lt;links&gt;-&lt;/links&gt;
     *     &lt;words&gt;-&lt;/words&gt;
     *     &lt;lastseen&gt;48&lt;/lastseen&gt;
     *     &lt;sendWords&gt;-&lt;/sendWords&gt;
     *     &lt;receivedWords&gt;-&lt;/receivedWords&gt;
     *     &lt;sendURLs&gt;-&lt;/sendURLs&gt;
     *     &lt;receivedURLs&gt;-&lt;/receivedURLs&gt;    
     *     &lt;age&gt;369&lt;/age&gt;
     *     &lt;seeds&gt;61&lt;/seeds&gt;
     *     &lt;connects&gt;2&lt;/connects&gt;
     *     &lt;address&gt;127.0.0.1:8080&lt;/address&gt;        
     *   &lt;/peer&gt;
     * &lt;/peers&gt;
     * </pre>
     * @throws Exception
     */
    public Document peerList(String peerType, int maxCount, boolean details) throws Exception {
    	// extracting the message context
    	extractMessageContext(NO_AUTHENTICATION);  
    	
    	if (peerType == null || peerType.length() == 0) throw new IllegalArgumentException("The peer type must not be null or empty.");
    	if (!(peerType.equalsIgnoreCase("active") || peerType.equalsIgnoreCase("passive") || peerType.equalsIgnoreCase("Potential")))
    		throw new IllegalArgumentException("Unknown peer type. Should be (active|passive|potential)");
    	
    	// configuring output mode
    	serverObjects args = new serverObjects();
    	if (peerType.equalsIgnoreCase("active")) args.put("page","1");
    	else if (peerType.equalsIgnoreCase("passive")) args.put("page","2");
    	else if (peerType.equalsIgnoreCase("potential")) args.put("page","3");
    	
    	// specifying if the detailed list should be returned
    	if (details) args.put("ip","1");
    	
    	// generating the template containing the network status information
    	byte[] result = this.serverContext.writeTemplate(TEMPLATE_NETWORK_XML, args, this.requestHeader);
    	
    	// sending back the result to the client
    	return this.convertContentToXML(result);  	
    }
    
    
	/**
	 * Returns the current status of the following queues
	 * <ul>
	 * 	<li>Indexing Queue</li>
	 * 	<li>Loader Queue</li> 
	 * 	<li>Local Crawling Queue </li>
	 *  <li>Remote Triggered Crawling Queue</li> 
	 * </ul>
	 * @param localqueueCount the amount of items that should be returned. If this is <code>null</code> 10 items will be returned
	 * @param loaderqueueCount the amount of items that should be returned. This parameter will be ignored at the moment
	 * @param localcrawlerqueueCount the amount of items that should be returned. This parameter will be ignored at the moment
	 * @param remotecrawlerqueueCount the amount of items that should be returned. This parameter will be ignored at the moment
	 * @return a XML document containing the status information. For the detailed format, take a look into the template file
	 *         <code>htroot/xml/queues_p.xml</code>
	 *         
	 * @throws AxisFault if authentication failed
	 * @throws Exception on other unexpected errors
	 * 
	 * @since 2835
	 */
    public Document getQueueStatus(
    		Integer localqueueCount,
    		Integer loaderqueueCount,
    		Integer localcrawlerqueueCount,
    		Integer remotecrawlerqueueCount    		
    ) throws Exception {
        // extracting the message context
        extractMessageContext(AUTHENTICATION_NEEDED);      
        
        // passing parameters to servlet
        serverObjects input = new serverObjects();        
        if (localqueueCount != null) input.put("num",localqueueCount.toString());
        //if (loaderqueueCount != null) input.put("num",loaderqueueCount.toString());
        //if (localcrawlerqueueCount != null) input.put("num",localcrawlerqueueCount.toString());
        //if (remotecrawlerqueueCount != null) input.put("num",remotecrawlerqueueCount.toString());
        
        
        // generating the template containing the network status information
        byte[] result = this.serverContext.writeTemplate(TEMPLATE_QUEUES_XML, input, this.requestHeader);
        
        // sending back the result to the client
        return this.convertContentToXML(result);        
    }
    
    /**
     * Query status information about this peer
     * @return the <code>status</code>-{@link Document}
     * @throws Exception
     */
    public Document getStatus() throws Exception {
        // extracting the message context
        extractMessageContext(AUTHENTICATION_NEEDED);          	
        
        // generating the template containing the network status information
        byte[] result = this.serverContext.writeTemplate(TEMPLATE_STATUS_XML, new serverObjects(), this.requestHeader);
        
        // sending back the result to the client
        return this.convertContentToXML(result);        
    }       
    
    
    public String getPeerHash() throws AxisFault {
        // extracting the message context
        extractMessageContext(AUTHENTICATION_NEEDED);        	
    	
        // return the peer hash
    	return yacyCore.seedDB.mySeed.hash;
    }
    
}