556729 - [autoconfig] Update ISP configs to v1.1 file format

Status: RESOLVED FIXED

(Webtools :: ISPDB Server, defect)

Description

[Ben Bucksch (:BenB)]

We need to add POP3 servers, update the autoconfig files to new format, and generally clean them up.

1. Add POP3 config, where available
2. Add <clientConfig version="1.1">
3. Remove <addThisServer>true</> and <useGlobalPreferredServer>false</>
   It's the default, and also a client/user decision.
   (BTW: Maybe we should handle the case of no SMTP server and then default
   to useGlobalPreferredServer=true? Different bug.)
4. Turn ISP help page URLs in XML comment into <instructionsURL>
5. Change <authentication>plain</> to password-cleartext and
   <authentication>secure</> to password-encrypted (from bug 525238).

Comment 1

[Ben Bucksch (:BenB)]

Attachment: Fix, v1

Comment 2

[Ben Bucksch (:BenB)]

Patch is huge, but the majority is just a global search/replace.
Some of it is substantial and general cleanup, though.

Comment 3

[Ben Bucksch (:BenB)]

Attachment: Fix. v2

Include bug 556760.

Comment 4

[Ben Bucksch (:BenB)]

Attachment: Fix, v3

Comment 5

[Ben Bucksch (:BenB)]

Attachment: Fix, v3, grepped

This is without the global search&replace

cat 556729-3-no-white.diff |grep -v "^- *<authentication>plain</authentication>$"|grep -v "^+ *<authentication>password-cleartext</authentication>$"|grep -v  "^- *<addThisServer>true</addThisServer>$"|grep -v  "^- *<useGlobalPreferredServer>false</useGlobalPreferredServer>$"|grep -v "^+<clientConfig version=\"1.1\">$"|grep -v  "^-<clientConfig>$"|grep -v "^ "|grep -v "^@"|grep -v "^+ *$"|grep -v "^======="|grep -v "^+++"|grep -v "^---" > 556729-3-grepped.diff

Comment 6

[Ben Bucksch (:BenB)]

Attachment: Fix, v3, grepped

Grepped more

Comment 8

[Blake Winton (:bwinton) (:☕️)]

Comment on attachment 436971 [details]
Fix, v3, grepped

Okay, I think I like this.

My only thought is that I think the descr-en attribute should turn into <descr lang="en">text goes here</descr>.  The default language can just use <descr> without a lang attribute.

And, since we're doing these huge changes, please run the files through "xmllint --format" so that everything has nice, consistent formatting.

(I noticed a few files had a couple of blank lines before the closing outgoingServer tag, but instead of just fixing those, we might as well run everything through since this patch is touching most everything anyways.)

So, other than that, r=me.

Comment 9

[Blake Winton (:bwinton) (:☕️)]

Comment on attachment 436968 [details] [diff] [review]
Fix, v3

(I reviewed the grepped version instead.)

Comment 10

[Ben Bucksch (:BenB)]

me to gozer:
<BenB> let's assume [the script is ready]... would you use it in the short term?
<gozer> yes, that's the plan
<gozer> then I'd only keep v1.1 stuff in svn
<gozer> and run it to produce the v1.0 stuff right after svn up changes something
<bwinton> Sweet, it's a plan!
<BenB> yes. whenever you do the svn->live sync, you use the script as step in the middle between svn and live.
<gozer> precisely
<BenB> ok, suggestion: for the v1.1 dir, I assume that we do that, and already commit the corresponding changes there, including deleteing duplicated files.
<BenB> and we no longer commit to v1.0, effective now. and once the script is working and have it working, we delete the v1.0 files, too.
<BenB> does that sound good?
<gozer> yup

Comment 11

[Ben Bucksch (:BenB)]

Attachment: Fix, v4

1. Changed <instructionsURL url="" descr-en="foo">bar</> to
   <documentation url=""><descr lang="en">foo</descr><descr>bar</descr>
   </documentation>
   (Note that <documentation> is basically just for our own reference.)
2. Changed <enableURL url=""> to
   <enable visiturl="">
     <instruction lang="en">foo</instruction>
     <instruction>bar</instruction>
   </documentation>
   whereby the element without "lang" is the default in the language
   of the ISP.
   (Note that visiturl are pages you *must* have visited after creation
   of the account at the ISP before IMAP/POP3 works. It's for the app UI.)

I have not done the xmllint yet, will do that as followup commit.

Comment 12

[Ben Bucksch (:BenB)]

Commited Fix v4 as SVN revision 66643

Comment 13

[Ben Bucksch (:BenB)]

Found 2 files with & instead of & and fixed and commited that.

Ran xmllint --format and commited as revision 66646.

FIXED