yacy_search_server/source/de/anomic/server/serverObjects.java

//serverObjects.java 
//-----------------------
//(C) by Michael Peter Christen; mc@anomic.de
//first published on http://www.anomic.de
//Frankfurt, Germany, 2004
//(C) changes by Bjoern 'fuchs' Krombholz
//
// $LastChangedDate:  $
// $LastChangedRevision:  $
// $LastChangedBy:  $
//
//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.

/*
  Why do we need this Class?
  The purpose of this class is to provide a hashtable object to the server
  and implementing interfaces. Values to and from cgi pages are encapsulated in
  this object. The server shall be executable in a Java 1.0 environment,
  so the following other options did not comply:

  Properties - setProperty would be needed, but only available in 1.2
  HashMap, TreeMap - only in 1.2
  Hashtable - available in 1.0, but 'put' does not accept null values

  So this class was created as a convenience.
  It will also contain special methods that read data from internet-resources
  in the background, while data can already be read out of the object.
  This shall speed up usage when a slow internet connection is used (dial-up)
 */

package de.anomic.server;

import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.InetAddress;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;

import de.anomic.data.htmlTools;
import de.anomic.plasma.plasmaSwitchboard;
import de.anomic.tools.yFormatter;

public class serverObjects extends HashMap<String, String> implements Cloneable {

    private static final long serialVersionUID = 1L;
    private boolean localized = true; 

    public serverObjects() {
        super();
    }

    public serverObjects(int initialCapacity) {
        super(initialCapacity);
    }

    public serverObjects(Map<String, String> input) {
        super(input);
    }

    /**
     * Add a key-value pair of Objects to the map.
     * @param key   This method will do nothing if the key is <code>null</code>.
     * @param value The value that should be mapped to the key.
     *              If value is <code>null</code>, then the element at <code>key</code>
     *              is removed from the map.
     * @return The value that was added to the map. 
     * @see java.util.Hashtable#put(K, V)
     */
    public String put(String key, String value) {
        if (key == null) {
            // this does nothing
            return null;
        } else if (value == null) {
            // assigning the null value creates the same effect like removing the element
            return super.remove(key);
        } else {
            return super.put(key, value);
        }
    }

    /**
     * Add byte array to the map, value is kept as it is.
     * @param key   key name as String.
     * @param value mapped value as a byte array.
     * @return      the previous value as String.
     */
    public String put(String key, byte[] value) {
        return this.put(key, new String(value)); //TODO: do we need an encoding method for byte[]?
    }

    /**
     * Add an unformatted String representation of a double/float value
     * to the map.
     * @param key   key name as String.
     * @param value value as double/float.
     * @return value as it was added to the map or <code>NaN</code> if an error occured.
     */
    public double put(String key, double value) {
        if (null == this.put(key, Double.toString(value))) {
            return Double.NaN;
        } else {
            return value;
        }
    }

    /**
     * same as {@link #put(String, double)} but for integer types
     * @return Returns 0 for the error case.
     */
    public long put(String key, long value) {
        if (null == this.put(key, Long.toString(value))) {
            return 0;
        } else {
            return value;
        }
    }

    public String put(String key, java.util.Date value) {
        return this.put(key, value.toString());
    }
    
    public String put(String key, serverDate value) {
        return this.put(key, value.toString());
    }
    
    public String put(String key, InetAddress value) {
        return this.put(key, value.toString());
    }
    
    /**
     * Add a String to the map. The content of the String is escaped to be usable in HTML output.
     * @param key   key name as String.
     * @param value a String that will be reencoded for HTML output.
     * @return      the modified String that was added to the map.
     * @see htmlTools#encodeUnicode2html(String, boolean)
     */
    public String putHTML(String key, String value) {
        return putHTML(key, value, false);
    }

    /**
     * Like {@link #putHTML(String, String)} but takes an extra argument defining, if the returned
     * String should be used in normal HTML: <code>false</code>.
     * If forXML is <code>true</code>, then only the characters <b>&amp; &quot; &lt; &gt;</b> will be
     * replaced in the returned String.
     */
    public String putHTML(String key, String value, boolean forXML) {
        return (String) put(key, htmlTools.encodeUnicode2html(value, true, forXML));
    }

    /**
     * Add a byte/long/integer to the map. The number will be encoded into a String using
     * a localized format specified by {@link yFormatter} and {@link #setLocalized(boolean)}.
     * @param key   key name as String.
     * @param value integer type value to be added to the map in its formatted String 
     *              representation.
     * @return the String value added to the map.
     */
    public String putNum(String key, long value) {
        return (String) this.put(key, yFormatter.number(value, this.localized));
    }

    /**
     * Variant for double/float types.
     * @see #putNum(String, long)
     */
    public String putNum(String key, double value) {
        return (String) this.put(key, yFormatter.number(value, this.localized));
    }

    /**
     * Variant for string encoded numbers.
     * @see #putNum(String, long)
     */
    public String putNum(String key, String value) {
        return (String) this.put(key, yFormatter.number(value));
    }

    
    public String putWiki(String key, String wikiCode){
        return (String) this.put(key, plasmaSwitchboard.wikiParser.transform(wikiCode));
    }
    public String putWiki(String key, byte[] wikiCode) {
        try {
            return (String) this.put(key, plasmaSwitchboard.wikiParser.transform(wikiCode));
        } catch (UnsupportedEncodingException e) {
            return (String) this.put(key, "Internal error pasting wiki-code: " + e.getMessage());
        }
    }
    public String putWiki(String key, String wikiCode, String publicAddress) {
        return (String) this.put(key, plasmaSwitchboard.wikiParser.transform(wikiCode, publicAddress));
    }
    public String putWiki(String key, byte[] wikiCode, String publicAddress) {
        try {
            return (String) this.put(key, plasmaSwitchboard.wikiParser.transform(wikiCode, "UTF-8", publicAddress));
        } catch (UnsupportedEncodingException e) {
            return (String) this.put(key, "Internal error pasting wiki-code: " + e.getMessage());
        }
    }

    // inc variant: for counters
    public long inc(String key) {
        String c = (String) super.get(key);
        if (c == null) c = "0";
        long l = Long.parseLong(c) + 1;
        super.put(key, Long.toString(l));
        return l;
    }

    // new get with default objects
    public Object get(String key, Object dflt) {
        Object result = super.get(key);
        if (result == null) return dflt; else return result;
    }

    // string variant
    public String get(String key, String dflt) {
        Object result = super.get(key);
        if (result == null) return dflt; else return (String) result;
    }

    public int getInt(String key, int dflt) {
        String s = (String) super.get(key);
        if (s == null) return dflt;
        try {
            return Integer.parseInt(s);
        } catch (NumberFormatException e) {
            return dflt;
        }
    }

    public long getLong(String key, long dflt) {
        String s = (String) super.get(key);
        if (s == null) return dflt;
        try {
            return Long.parseLong(s);
        } catch (NumberFormatException e) {
            return dflt;
        }
    }

    // returns a set of all values where their key mappes the keyMapper
    public String[] getAll(String keyMapper) {
        // the keyMapper may contain regular expressions as defined in String.matches
        // this method is particulary useful when parsing the result of checkbox forms
        ArrayList<String> v = new ArrayList<String>();
        Iterator<String> e = keySet().iterator();
        String key;
        while (e.hasNext()) {
            key = e.next();
            if (key.matches(keyMapper)) v.add((String) get(key));
        }
        // make a String[]
        String[] result = new String[v.size()];
        for (int i = 0; i < v.size(); i++) result[i] = (String) v.get(i);
        return result;
    }

    // put all elements of another hashtable into the own table
    public void putAll(serverObjects add) {
        Iterator<String> e = add.keySet().iterator();
        String k;
        while (e.hasNext()) {
            k = e.next();
            put(k, add.get(k));
        }
    }

    // convenience methods for storing and loading to a file system
    public void store(File f) throws IOException {
        BufferedOutputStream fos = null;
        try {
            fos = new BufferedOutputStream(new FileOutputStream(f));
            Iterator<String> e = keySet().iterator();
            String key, value;
            while (e.hasNext()) {
                key = e.next();
                value = get(key).replaceAll("\n", "\\\\n");  
                fos.write((key + "=" + value + "\r\n").getBytes());
            }
        } finally {
            if (fos != null) {
                try {
                    fos.flush();
                    fos.close();
                } catch (Exception e){}
            }
        }
    }

    /**
     * Defines the localization state of this object.
     * Currently it is used for numbers added with the putNum() methods only.
     * @param loc if <code>true</code> store numbers in a localized format, otherwise
     *            use a default english locale without grouping.
     * @see yFormatter#setLocale(String) 
     */
    public void setLocalized(boolean loc) {
        this.localized = loc;
    }

    public Object clone() {
        return super.clone();
    }

}