nettika/geary
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Don't display warnings about unknown IMAP response codes: Closes #7179

Browse source 
Since IMAP's response codes are open-ended and subject to further
additions, this also reworks the ResponseCodeType to be more
flexible in what it represents (any atom rather than a fixed enum
of values).
This commit is contained in:
Jim Nelson 2013-07-08 14:54:53 -07:00
parent ffa642f458
commit fe98878a67
4 changed files with 86 additions and 165 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/engine/imap/api/imap-folder.vala
View file

@ -207,7 +207,10 @@ private class Geary.Imap.Folder : BaseObject {
return;
try {
switch (response_code.get_response_code_type()) {
// Have to take a copy of the string property before evaluation due to this bug:
// https://bugzilla.gnome.org/show_bug.cgi?id=703818
string value = response_code.get_response_code_type().value;
switch (value) {
case ResponseCodeType.READONLY:
readonly = Trillian.TRUE;
break;
@ -237,8 +240,7 @@ private class Geary.Imap.Folder : BaseObject {
break;
default:
debug("%s: Ignoring response code %s", to_string(),
response_code.to_string());
// ignored
break;
}
} catch (ImapError ierr) {

229
src/engine/imap/response/imap-response-code-type.vala
View file

@ -7,171 +7,90 @@
/**
* An optional response code accompanying a {@link ServerResponse}.
*
* See [[http://tools.ietf.org/html/rfc3501#section-7.1]] for more information.
* See
* [[http://tools.ietf.org/html/rfc3501#section-7.1]],
* [[http://tools.ietf.org/html/rfc5530]], and
* [[http://tools.ietf.org/html/rfc4315]]
* for more information.
*/
public enum Geary.Imap.ResponseCodeType {
ALERT,
AUTHENTICATIONFAILED,
AUTHORIZATIONFAILED,
BADCHARSET,
CAPABILITY,
NEWNAME,
PARSE,
PERMANENT_FLAGS,
READONLY,
READWRITE,
TRY_CREATE,
UIDVALIDITY,
UIDNEXT,
UNSEEN,
MYRIGHTS,
UNAVAILABLE,
SERVERBUG,
CLIENTBUG,
ALREADYEXISTS,
NONEXISTANT;
public class Geary.Imap.ResponseCodeType : BaseObject, Gee.Hashable<ResponseCodeType> {
public const string ALERT = "alert";
public const string ALREADYEXISTS = "alreadyexists";
public const string AUTHENTICATIONFAILED = "authenticationfailed";
public const string AUTHORIZATIONFAILED = "authorizationfailed";
public const string BADCHARSET = "badcharset";
public const string CAPABILITY = "capability";
public const string CLIENTBUG = "clientbug";
public const string MYRIGHTS = "myrights";
public const string NEWNAME = "newname";
public const string NONEXISTANT = "nonexistant";
public const string PARSE = "parse";
public const string PERMANENT_FLAGS = "permanentflags";
public const string READONLY = "read-only";
public const string READWRITE = "read-write";
public const string SERVERBUG = "serverbug";
public const string TRY_CREATE = "trycreate";
public const string UIDVALIDITY = "uidvalidity";
public const string UIDNEXT = "uidnext";
public const string UNAVAILABLE = "unavailable";
public const string UNSEEN = "unseen";
public string to_string() {
switch (this) {
case ALERT:
return "alert";
case AUTHENTICATIONFAILED:
return "authenticationfailed";
case AUTHORIZATIONFAILED:
return "authorizationfailed";
case BADCHARSET:
return "badcharset";
case CAPABILITY:
return "capability";
case NEWNAME:
return "newname";
case PARSE:
return "parse";
case PERMANENT_FLAGS:
return "permanentflags";
case READONLY:
return "read-only";
case READWRITE:
return "read-write";
case TRY_CREATE:
return "trycreate";
case UIDVALIDITY:
return "uidvalidity";
case UIDNEXT:
return "uidnext";
case UNSEEN:
return "unseen";
case MYRIGHTS:
return "myrights";
case UNAVAILABLE:
return "unavailable";
case SERVERBUG:
return "serverbug";
case CLIENTBUG:
return "clientbug";
case ALREADYEXISTS:
return "alreadyexists";
case NONEXISTANT:
return "nonexistant";
default:
assert_not_reached();
}
/**
* The original response code value submitted to the object (possibly off-the-wire).
*/
public string original { get; private set; }
/**
* The response code value set to lowercase, making it easy to compare to constant strings
* in a uniform way.
*/
public string value { get; private set; }
/**
* Throws an {@link ImapError.INVALID} if the string cannot be represented as an
* {link ResponseCodeType}.
*/
public ResponseCodeType(string value) throws ImapError {
init(value);
}
public static ResponseCodeType decode(string value) throws ImapError {
switch (value.down()) {
case "alert":
return ALERT;
case "authenticationfailed":
return AUTHENTICATIONFAILED;
case "authorizationfailed":
return AUTHORIZATIONFAILED;
case "badcharset":
return BADCHARSET;
case "capability":
return CAPABILITY;
case "newname":
return NEWNAME;
case "parse":
return PARSE;
case "permanentflags":
return PERMANENT_FLAGS;
case "read-only":
return READONLY;
case "read-write":
return READWRITE;
case "trycreate":
return TRY_CREATE;
case "uidvalidity":
return UIDVALIDITY;
case "uidnext":
return UIDNEXT;
case "unseen":
return UNSEEN;
case "myrights":
return MYRIGHTS;
case "unavailable":
return UNAVAILABLE;
case "serverbug":
return SERVERBUG;
case "clientbug":
return CLIENTBUG;
case "alreadyexists":
return ALREADYEXISTS;
case "nonexistant":
return NONEXISTANT;
default:
throw new ImapError.PARSE_ERROR("Unknown response code \"%s\"", value);
}
/**
* Throws an {@link ImapError.INVALID} if the {@link StringParameter} cannot be represented as
* an {link ResponseCodeType}.
*/
public ResponseCodeType.from_parameter(StringParameter stringp) throws ImapError {
init(stringp.value);
}
public static ResponseCodeType from_parameter(StringParameter stringp) throws ImapError {
return decode(stringp.value);
private void init(string str) throws ImapError {
// note that is_quoting_required() also catches empty strings (as they require quoting)
if (DataFormat.is_quoting_required(str) != DataFormat.Quoting.OPTIONAL)
throw new ImapError.INVALID("\"%s\" cannot be represented as a ResponseCodeType", str);
// store lowercased so it's easily compared with const strings above
original = str;
value = str.down();
}
public bool is_value(string str) {
return String.stri_equal(value, str);
}
public StringParameter to_parameter() {
return new AtomParameter(to_string());
return new AtomParameter(original);
}
public bool equal_to(ResponseCodeType other) {
return (this == other) ? true : String.stri_equal(value, other.value);
}
public uint hash() {
return String.stri_hash(value);
}
public string to_string() {
return value;
}
}

12
src/engine/imap/response/imap-response-code.vala
View file

@ -15,7 +15,7 @@ public class Geary.Imap.ResponseCode : Geary.Imap.ListParameter {
}
public ResponseCodeType get_response_code_type() throws ImapError {
return ResponseCodeType.from_parameter(get_as_string(0));
return new ResponseCodeType.from_parameter(get_as_string(0));
}
/**
@ -24,7 +24,7 @@ public class Geary.Imap.ResponseCode : Geary.Imap.ListParameter {
* @throws ImapError.INVALID if not UIDNEXT.
*/
public UID get_uid_next() throws ImapError {
if (get_response_code_type() != ResponseCodeType.UIDNEXT)
if (!get_response_code_type().is_value(ResponseCodeType.UIDNEXT))
throw new ImapError.INVALID("Not UIDNEXT: %s", to_string());
return new UID(get_as_string(1).as_int());
@ -36,7 +36,7 @@ public class Geary.Imap.ResponseCode : Geary.Imap.ListParameter {
* @throws ImapError.INVALID if not UIDVALIDITY.
*/
public UIDValidity get_uid_validity() throws ImapError {
if (get_response_code_type() != ResponseCodeType.UIDVALIDITY)
if (!get_response_code_type().is_value(ResponseCodeType.UIDVALIDITY))
throw new ImapError.INVALID("Not UIDVALIDITY: %s", to_string());
return new UIDValidity(get_as_string(1).as_int());
@ -48,7 +48,7 @@ public class Geary.Imap.ResponseCode : Geary.Imap.ListParameter {
* @throws ImapError.INVALID if not UNSEEN.
*/
public int get_unseen() throws ImapError {
if (get_response_code_type() != ResponseCodeType.UNSEEN)
if (!get_response_code_type().is_value(ResponseCodeType.UNSEEN))
throw new ImapError.INVALID("Not UNSEEN: %s", to_string());
return get_as_string(1).as_int(0, int.MAX);
@ -60,7 +60,7 @@ public class Geary.Imap.ResponseCode : Geary.Imap.ListParameter {
* @throws ImapError.INVALID if not PERMANENTFLAGS.
*/
public MessageFlags get_permanent_flags() throws ImapError {
if (get_response_code_type() != ResponseCodeType.PERMANENT_FLAGS)
if (!get_response_code_type().is_value(ResponseCodeType.PERMANENT_FLAGS))
throw new ImapError.INVALID("Not PERMANENTFLAGS: %s", to_string());
return MessageFlags.from_list(get_as_list(1));
@ -76,7 +76,7 @@ public class Geary.Imap.ResponseCode : Geary.Imap.ListParameter {
* @throws ImapError.INVALID if Capability was not specified.
*/
public Capabilities get_capabilities(ref int next_revision) throws ImapError {
if (get_response_code_type() != ResponseCodeType.CAPABILITY)
if (!get_response_code_type().is_value(ResponseCodeType.CAPABILITY))
throw new ImapError.INVALID("Not CAPABILITY response code: %s", to_string());
Capabilities capabilities = new Capabilities(next_revision++);

2
src/engine/imap/transport/imap-client-session.vala
View file

@ -1460,7 +1460,7 @@ public class Geary.Imap.ClientSession : BaseObject {
ResponseCode? response_code = status_response.response_code;
if (response_code != null) {
try {
if (response_code.get_response_code_type() == ResponseCodeType.CAPABILITY) {
if (response_code.get_response_code_type().is_value(ResponseCodeType.CAPABILITY)) {
capabilities = response_code.get_capabilities(ref next_capabilities_revision);
debug("[%s] %s %s", to_string(), status_response.status.to_string(),
capabilities.to_string());