/* This code is part of Freenet. It is distributed under the GNU General
* Public License, version 2 (or at your option any later version). See
* http://www.gnu.org/ for further details of the GPL. */
package freenet.clients.fcp;
import java.io.Serializable;
import freenet.node.Node;
import freenet.support.Logger;
import freenet.support.SimpleFieldSet;
/**
* ProtocolError (some problem parsing the other side's FCP messages, or other
* problem not related to Freenet)
*
* ProtocolError
* Code=1
* CodeDescription=ClientHello must be first message
* ExtraDescription=Duh
* Fatal=false // means the connection stays open
* [Identifier=<ident> if we managed to parse one]
* EndMessage
*/
public class ProtocolErrorMessage extends FCPMessage implements Serializable {
private static final long serialVersionUID = 1L;
static final int CLIENT_HELLO_MUST_BE_FIRST_MESSAGE = 1;
static final int NO_LATE_CLIENT_HELLOS = 2;
static final int MESSAGE_PARSE_ERROR = 3;
static final int FREENET_URI_PARSE_ERROR = 4;
static final int MISSING_FIELD = 5;
static final int ERROR_PARSING_NUMBER = 6;
public static final int INVALID_MESSAGE = 7;
static final int INVALID_FIELD = 8;
static final int FILE_NOT_FOUND = 9;
static final int DISK_TARGET_EXISTS = 10;
//static final int FILENAME_AND_TEMP_FILENAME_MUST_BE_IN_SAME_DIR = 11;
static final int COULD_NOT_CREATE_FILE = 12;
static final int COULD_NOT_WRITE_FILE = 13;
static final int COULD_NOT_RENAME_FILE = 14;
static final int NO_SUCH_IDENTIFIER = 15;
static final int NOT_SUPPORTED = 16;
static final int INTERNAL_ERROR = 17;
static final int SHUTTING_DOWN = 18;
static final int NO_SUCH_NODE_IDENTIFIER = 19; // Unused
static final int URL_PARSE_ERROR = 20;
static final int REF_PARSE_ERROR = 21;
static final int FILE_PARSE_ERROR = 22;
static final int NOT_A_FILE_ERROR = 23;
static final int ACCESS_DENIED = 24;
static final int DIRECT_DISK_ACCESS_DENIED = 25;
static final int COULD_NOT_READ_FILE = 26;
static final int REF_SIGNATURE_INVALID = 27;
static final int CANNOT_PEER_WITH_SELF = 28;
static final int DUPLICATE_PEER_REF = 29;
static final int OPENNET_DISABLED = 30;
static final int DARKNET_ONLY = 31;
static final int NO_SUCH_PLUGIN = 32;
static final int PERSISTENCE_DISABLED = 33;
static final int TOO_MANY_FILES_IN_INSERT = 34;
static final int BAD_MIME_TYPE = 35;
static final int WRONG_RETURN_TYPE = 36;
static final int IO_ERROR = 37;
static final int PLUGINS_DISABLED = 38;
final int code;
final String extra;
final boolean fatal;
final String ident;
final boolean global;
private String codeDescription() {
// FIXME l10n?
switch(code) {
case CLIENT_HELLO_MUST_BE_FIRST_MESSAGE:
return "ClientHello must be first message";
case NO_LATE_CLIENT_HELLOS:
return "No late ClientHello's accepted";
case MESSAGE_PARSE_ERROR:
return "Unknown message parsing error";
case FREENET_URI_PARSE_ERROR:
return "Error parsing freenet URI";
case MISSING_FIELD:
return "Missing field";
case ERROR_PARSING_NUMBER:
return "Error parsing a numeric field";
case INVALID_MESSAGE:
return "Don't know what to do with message";
case INVALID_FIELD:
return "Invalid field value";
case FILE_NOT_FOUND:
return "File not found, not a file or not readable";
case DISK_TARGET_EXISTS:
return "Disk target exists, refusing to overwrite for security reasons";
case COULD_NOT_CREATE_FILE:
return "Could not create file";
case COULD_NOT_WRITE_FILE:
return "Could not write file";
case COULD_NOT_RENAME_FILE:
return "Could not rename file";
case NO_SUCH_IDENTIFIER:
return "No such identifier";
case NOT_SUPPORTED:
return "Not supported";
case INTERNAL_ERROR:
return "Internal error";
case SHUTTING_DOWN:
return "Shutting down";
case NO_SUCH_NODE_IDENTIFIER: // Unused
return "No such nodeIdentifier";
case URL_PARSE_ERROR:
return "Error parsing URL";
case REF_PARSE_ERROR:
return "Reference could not be parsed";
case FILE_PARSE_ERROR:
return "File could not be read";
case NOT_A_FILE_ERROR:
return "Filepath is not a file";
case ACCESS_DENIED:
return "Access denied";
case DIRECT_DISK_ACCESS_DENIED:
return "Direct Disk Access operation denied: did you send a FileHash field ? Did you use TestDDA?";
case COULD_NOT_READ_FILE:
return "Could not read file";
case REF_SIGNATURE_INVALID:
return "Reference signature failed to verify";
case CANNOT_PEER_WITH_SELF:
return "Node cannot peer with itself";
case DUPLICATE_PEER_REF:
return "Node already has a peer with that ref";
case OPENNET_DISABLED:
return "Opennet is currently disabled in the node's configuration";
case DARKNET_ONLY:
return "Operation only available on a darknet peer";
case NO_SUCH_PLUGIN:
return "No such plugin";
case TOO_MANY_FILES_IN_INSERT:
return "Too many files in a single folder on a freesite insert";
case BAD_MIME_TYPE:
return "Bad MIME type";
case WRONG_RETURN_TYPE:
return "Not supported for that return type";
case IO_ERROR:
return "Disk I/O error";
case PERSISTENCE_DISABLED:
return "Persistence disabled (e.g. encrypted queue waiting for password?)";
default:
Logger.error(this, "Unknown error code: "+code, new Exception("debug"));
return "(Unknown)";
}
}
public ProtocolErrorMessage(int code, boolean fatal, String extra, String ident, boolean global) {
this.code = code;
this.extra = extra;
this.fatal = fatal;
this.ident = ident;
this.global = global;
}
public ProtocolErrorMessage(SimpleFieldSet fs) {
ident = fs.get("Identifier");
code = Integer.parseInt(fs.get("Code"));
extra = fs.get("ExtraDescription");
fatal = fs.getBoolean("Fatal", false);
global = fs.getBoolean("Global", false);
}
protected ProtocolErrorMessage() {
// For serialization.
code = 0;
extra = null;
fatal = false;
ident = null;
global = false;
}
@Override
public SimpleFieldSet getFieldSet() {
SimpleFieldSet sfs = new SimpleFieldSet(true);
if(ident != null)
sfs.putSingle("Identifier", ident);
sfs.put("Code", code);
sfs.putSingle("CodeDescription", codeDescription());
if(extra != null)
sfs.putSingle("ExtraDescription", extra);
sfs.put("Fatal", fatal);
sfs.put("Global", global);
return sfs;
}
@Override
public void run(FCPConnectionHandler handler, Node node) {
Logger.error(this, "Client reported protocol error");
}
@Override
public String getName() {
return "ProtocolError";
}
@Override
public String toString() {
return super.toString()+":"+code+":"+extra+":"+fatal+":"+ident+":"+global;
}
}