mirror of
https://github.com/yacy/yacy_search_server.git
synced 2024-09-21 00:00:13 +02:00
8829ec5f18
*) added annotations and made minor changes to serverObjects.java *) set subversion properties for several files git-svn-id: https://svn.berlios.de/svnroot/repos/yacy/trunk@6409 6c8d7289-2bf4-0310-a012-ef5d649a1542
356 lines
12 KiB
Java
356 lines
12 KiB
Java
//serverObjects.java
|
|
//-----------------------
|
|
//(C) by Michael Peter Christen; mc@yacy.net
|
|
//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
|
|
|
|
/*
|
|
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.Map;
|
|
|
|
import net.yacy.kelondro.util.DateFormatter;
|
|
import net.yacy.kelondro.util.Formatter;
|
|
|
|
import de.anomic.document.parser.html.CharacterCoding;
|
|
import de.anomic.search.Switchboard;
|
|
|
|
public class serverObjects extends HashMap<String, String> implements Cloneable {
|
|
|
|
private static final long serialVersionUID = 1L;
|
|
private boolean localized = true;
|
|
|
|
public serverObjects() {
|
|
super();
|
|
}
|
|
|
|
public serverObjects(final int initialCapacity) {
|
|
super(initialCapacity);
|
|
}
|
|
|
|
public serverObjects(final 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)
|
|
*/
|
|
@Override
|
|
public String put(final String key, final 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(final String key, final byte[] value) {
|
|
try {
|
|
return this.put(key, new String(value, "UTF-8"));
|
|
} catch (UnsupportedEncodingException e) {
|
|
e.printStackTrace();
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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(final String key, final double value) {
|
|
if (null == this.put(key, Double.toString(value))) {
|
|
return Double.NaN;
|
|
}
|
|
return value;
|
|
}
|
|
|
|
/**
|
|
* same as {@link #put(String, double)} but for integer types
|
|
* @return Returns 0 for the error case.
|
|
*/
|
|
public long put(final String key, final long value) {
|
|
if (null == this.put(key, Long.toString(value))) {
|
|
return 0;
|
|
}
|
|
return value;
|
|
}
|
|
|
|
public String put(final String key, final java.util.Date value) {
|
|
return this.put(key, value.toString());
|
|
}
|
|
|
|
public String put(final String key, final DateFormatter value) {
|
|
return this.put(key, value.toString());
|
|
}
|
|
|
|
public String put(final String key, final 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 JSON output.
|
|
* @param key key name as String.
|
|
* @param value a String that will be reencoded for JSON output.
|
|
* @return the modified String that was added to the map.
|
|
*/
|
|
public String putJSON(final String key, String value) {
|
|
value = value.replaceAll("\"", "'");
|
|
value = value.replaceAll("/", "\\/");
|
|
// value = value.replaceAll("\\", "\\\\");
|
|
value = value.replaceAll("\b", "\\b");
|
|
value = value.replaceAll("\f", "\\f");
|
|
value = value.replaceAll("\n", "\\r");
|
|
value = value.replaceAll("\r", "\\r");
|
|
value = value.replaceAll("\t", "\\t");
|
|
return put(key, value);
|
|
}
|
|
public String putJSON(final String key, final byte[] value) {
|
|
return putJSON(key, new String(value));
|
|
}
|
|
|
|
/**
|
|
* 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 CharacterCoding#encodeUnicode2html(String, boolean)
|
|
*/
|
|
public String putHTML(final String key, final String value) {
|
|
return put(key, CharacterCoding.unicode2html(value, true));
|
|
}
|
|
public String putHTML(final String key, final byte[] value) {
|
|
return putHTML(key, new String(value));
|
|
}
|
|
|
|
/**
|
|
* 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>& " < ></b> will be
|
|
* replaced in the returned String.
|
|
*/
|
|
public String putXML(final String key, final String value) {
|
|
return put(key, CharacterCoding.unicode2xml(value, true));
|
|
}
|
|
|
|
/**
|
|
* Add a byte/long/integer to the map. The number will be encoded into a String using
|
|
* a localized format specified by {@link Formatter} 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(final String key, final long value) {
|
|
return this.put(key, Formatter.number(value, this.localized));
|
|
}
|
|
|
|
/**
|
|
* Variant for double/float types.
|
|
* @see #putNum(String, long)
|
|
*/
|
|
public String putNum(final String key, final double value) {
|
|
return this.put(key, Formatter.number(value, this.localized));
|
|
}
|
|
|
|
/**
|
|
* Variant for string encoded numbers.
|
|
* @see #putNum(String, long)
|
|
*/
|
|
public String putNum(final String key, final String value) {
|
|
return this.put(key, Formatter.number(value));
|
|
}
|
|
|
|
|
|
public String putWiki(final String key, final String wikiCode){
|
|
return this.put(key, Switchboard.wikiParser.transform(wikiCode));
|
|
}
|
|
public String putWiki(final String key, final byte[] wikiCode) {
|
|
try {
|
|
return this.put(key, Switchboard.wikiParser.transform(wikiCode));
|
|
} catch (final UnsupportedEncodingException e) {
|
|
return this.put(key, "Internal error pasting wiki-code: " + e.getMessage());
|
|
}
|
|
}
|
|
|
|
// inc variant: for counters
|
|
public long inc(final String key) {
|
|
String c = super.get(key);
|
|
if (c == null) c = "0";
|
|
final long l = Long.parseLong(c) + 1;
|
|
super.put(key, Long.toString(l));
|
|
return l;
|
|
}
|
|
|
|
// new get with default objects
|
|
public Object get(final String key, final Object dflt) {
|
|
final Object result = super.get(key);
|
|
if (result == null) return dflt;
|
|
return result;
|
|
}
|
|
|
|
// string variant
|
|
public String get(final String key, final String dflt) {
|
|
final Object result = super.get(key);
|
|
if (result == null) return dflt;
|
|
return (String) result;
|
|
}
|
|
|
|
public int getInt(final String key, final int dflt) {
|
|
final String s = super.get(key);
|
|
if (s == null) return dflt;
|
|
try {
|
|
return Integer.parseInt(s);
|
|
} catch (final NumberFormatException e) {
|
|
return dflt;
|
|
}
|
|
}
|
|
|
|
public long getLong(final String key, final long dflt) {
|
|
final String s = super.get(key);
|
|
if (s == null) return dflt;
|
|
try {
|
|
return Long.parseLong(s);
|
|
} catch (final NumberFormatException e) {
|
|
return dflt;
|
|
}
|
|
}
|
|
|
|
public double getDouble(final String key, final double dflt) {
|
|
final String s = super.get(key);
|
|
if (s == null) return dflt;
|
|
try {
|
|
return Double.parseDouble(s);
|
|
} catch (final NumberFormatException e) {
|
|
return dflt;
|
|
}
|
|
}
|
|
|
|
public boolean hasValue(final String key) {
|
|
final String s = super.get(key);
|
|
if (s == null || s.length() < 1) return false;
|
|
return true;
|
|
}
|
|
|
|
// returns a set of all values where their key mappes the keyMapper
|
|
public String[] getAll(final 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
|
|
final ArrayList<String> v = new ArrayList<String>();
|
|
String key;
|
|
for (Map.Entry<String, String> entry: entrySet()) {
|
|
key = entry.getKey();
|
|
if (key.matches(keyMapper)) v.add(entry.getValue());
|
|
}
|
|
// make a String[]
|
|
final String[] result = new String[v.size()];
|
|
for (int i = 0; i < v.size(); i++) result[i] = v.get(i);
|
|
return result;
|
|
}
|
|
|
|
// put all elements of another hashtable into the own table
|
|
public void putAll(final serverObjects add) {
|
|
for (Map.Entry<String, String> entry: add.entrySet()) {
|
|
put(entry.getKey(), entry.getValue());
|
|
}
|
|
}
|
|
|
|
// convenience methods for storing and loading to a file system
|
|
public void store(final File f) throws IOException {
|
|
BufferedOutputStream fos = null;
|
|
try {
|
|
fos = new BufferedOutputStream(new FileOutputStream(f));
|
|
String key, value;
|
|
for (Map.Entry<String, String> entry: entrySet()) {
|
|
key = entry.getKey();
|
|
value = entry.getValue().replaceAll("\n", "\\\\n");
|
|
fos.write((key + "=" + value + "\r\n").getBytes());
|
|
}
|
|
} finally {
|
|
if (fos != null) {
|
|
try {
|
|
fos.flush();
|
|
fos.close();
|
|
} catch (final 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 Formatter#setLocale(String)
|
|
*/
|
|
public void setLocalized(final boolean loc) {
|
|
this.localized = loc;
|
|
}
|
|
|
|
@Override
|
|
public Object clone() {
|
|
return super.clone();
|
|
}
|
|
|
|
}
|