443880 - incorrect comments in nsILoginInfo IDL regarding usernameField / passwordField

Status: RESOLVED FIXED

(Toolkit :: Password Manager, defect)

Description

[Myk Melez [:myk] [@mykmelez]]

According to nsILoginInfo.idl, the nsILoginInfo::usernameField is null "for logins obtained from a HTTP or FTP authentication," but handing nsILoginManager::addLogin an nsILoginInfo with a null value for that property throws "l.usernameField is null" at storage-Legacy.js (line 504), which is the second to last line of the following block of code:

    /*
     * _checkLoginValues
     *
     * Due to the way the signons2.txt file is formatted, we need to make
     * sure certain field values or characters do not cause the file to
     * be parse incorrectly. Reject logins that we can't store correctly.
     */
    _checkLoginValues : function (aLogin) {
        function badCharacterPresent(l, c) {
            return ((l.formSubmitURL && l.formSubmitURL.indexOf(c) != -1) ||
                    (l.httpRealm     && l.httpRealm.indexOf(c)     != -1) ||
                                        l.hostname.indexOf(c)      != -1  ||
                                        l.usernameField.indexOf(c) != -1  ||
                                        l.passwordField.indexOf(c) != -1);

It's not clear whether the docs are wrong or the code is buggy, but one of them must be errant, since they disagree.

Comment 1

[Myk Melez [:myk] [@mykmelez]]

Note: the same is presumably also true for passwordField.

Comment 2

[Justin Dolske [:Dolske]]

.usernameField and .passwordField should just be empty-string if unused, see bug 413314.

Looks like I missed a spot when fixing docs? *sigh*

Comment 3

[Justin Dolske [:Dolske]]

I updated DevMo (http://developer.mozilla.org/en/NsILoginInfo) when originally fixing bug 413314.

Pushed changeset 6f9506ad113e with the updates to the IDL comments.