blob: e7fd1d8b17b9f56cae8ac8524702dc1fea9e8fde [file] [log] [blame]
Bram Moolenaar1ef15e32006-02-01 21:56:25 +00001" Vim script to download a missing spell file
2" Maintainer: Bram Moolenaar <Bram@vim.org>
Bram Moolenaar6ee8d892012-01-10 14:55:01 +01003" Last Change: 2012 Jan 08
Bram Moolenaar1ef15e32006-02-01 21:56:25 +00004
5if !exists('g:spellfile_URL')
Bram Moolenaar4a630f62008-06-27 18:58:11 +00006 " Prefer using http:// when netrw should be able to use it, since
7 " more firewalls let this through.
8 if executable("curl") || executable("wget") || executable("fetch")
9 let g:spellfile_URL = 'http://ftp.vim.org/pub/vim/runtime/spell'
10 else
11 let g:spellfile_URL = 'ftp://ftp.vim.org/pub/vim/runtime/spell'
12 endif
Bram Moolenaar1ef15e32006-02-01 21:56:25 +000013endif
14let s:spellfile_URL = '' " Start with nothing so that s:donedict is reset.
15
16" This function is used for the spellfile plugin.
17function! spellfile#LoadFile(lang)
18 " If the netrw plugin isn't loaded we silently skip everything.
19 if !exists(":Nread")
20 if &verbose
21 echomsg 'spellfile#LoadFile(): Nread command is not available.'
22 endif
23 return
24 endif
25
26 " If the URL changes we try all files again.
27 if s:spellfile_URL != g:spellfile_URL
28 let s:donedict = {}
29 let s:spellfile_URL = g:spellfile_URL
30 endif
31
32 " I will say this only once!
33 if has_key(s:donedict, a:lang . &enc)
34 if &verbose
35 echomsg 'spellfile#LoadFile(): Tried this language/encoding before.'
36 endif
37 return
38 endif
39 let s:donedict[a:lang . &enc] = 1
40
41 " Find spell directories we can write in.
Bram Moolenaar5c736222010-01-06 20:54:52 +010042 let [dirlist, dirchoices] = spellfile#GetDirChoices()
Bram Moolenaar1ef15e32006-02-01 21:56:25 +000043 if len(dirlist) == 0
Bram Moolenaar5c736222010-01-06 20:54:52 +010044 let dir_to_create = spellfile#WritableSpellDir()
45 if &verbose || dir_to_create != ''
Bram Moolenaar1ef15e32006-02-01 21:56:25 +000046 echomsg 'spellfile#LoadFile(): There is no writable spell directory.'
47 endif
Bram Moolenaar5c736222010-01-06 20:54:52 +010048 if dir_to_create != ''
49 if confirm("Shall I create " . dir_to_create, "&Yes\n&No", 2) == 1
50 " After creating the directory it should show up in the list.
51 call mkdir(dir_to_create, "p")
52 let [dirlist, dirchoices] = spellfile#GetDirChoices()
53 endif
54 endif
55 if len(dirlist) == 0
56 return
57 endif
Bram Moolenaar1ef15e32006-02-01 21:56:25 +000058 endif
59
60 let msg = 'Cannot find spell file for "' . a:lang . '" in ' . &enc
61 let msg .= "\nDo you want me to try downloading it?"
62 if confirm(msg, "&Yes\n&No", 2) == 1
63 let enc = &encoding
64 if enc == 'iso-8859-15'
65 let enc = 'latin1'
66 endif
67 let fname = a:lang . '.' . enc . '.spl'
68
69 " Split the window, read the file into a new buffer.
Bram Moolenaar706cdeb2007-05-06 21:55:31 +000070 " Remember the buffer number, we check it below.
Bram Moolenaar1ef15e32006-02-01 21:56:25 +000071 new
Bram Moolenaar706cdeb2007-05-06 21:55:31 +000072 let newbufnr = winbufnr(0)
Bram Moolenaar6ee8d892012-01-10 14:55:01 +010073 setlocal bin fenc=
Bram Moolenaar1ef15e32006-02-01 21:56:25 +000074 echo 'Downloading ' . fname . '...'
Bram Moolenaarc9a99912006-05-13 12:25:55 +000075 call spellfile#Nread(fname)
Bram Moolenaar1ef15e32006-02-01 21:56:25 +000076 if getline(2) !~ 'VIMspell'
77 " Didn't work, perhaps there is an ASCII one.
Bram Moolenaar706cdeb2007-05-06 21:55:31 +000078 " Careful: Nread() may have opened a new window for the error message,
79 " we need to go back to our own buffer and window.
80 if newbufnr != winbufnr(0)
81 let winnr = bufwinnr(newbufnr)
82 if winnr == -1
83 " Our buffer has vanished!? Open a new window.
84 echomsg "download buffer disappeared, opening a new one"
85 new
Bram Moolenaar6ee8d892012-01-10 14:55:01 +010086 setlocal bin fenc=
Bram Moolenaar706cdeb2007-05-06 21:55:31 +000087 else
88 exe winnr . "wincmd w"
89 endif
90 endif
91 if newbufnr == winbufnr(0)
92 " We are back the old buffer, remove any (half-finished) download.
93 g/^/d
94 else
95 let newbufnr = winbufnr(0)
96 endif
97
Bram Moolenaar1ef15e32006-02-01 21:56:25 +000098 let fname = a:lang . '.ascii.spl'
99 echo 'Could not find it, trying ' . fname . '...'
Bram Moolenaarc9a99912006-05-13 12:25:55 +0000100 call spellfile#Nread(fname)
Bram Moolenaar1ef15e32006-02-01 21:56:25 +0000101 if getline(2) !~ 'VIMspell'
102 echo 'Sorry, downloading failed'
Bram Moolenaar706cdeb2007-05-06 21:55:31 +0000103 exe newbufnr . "bwipe!"
Bram Moolenaar1ef15e32006-02-01 21:56:25 +0000104 return
105 endif
106 endif
107
108 " Delete the empty first line and mark the file unmodified.
109 1d
110 set nomod
111
112 let msg = "In which directory do you want to write the file:"
113 for i in range(len(dirlist))
114 let msg .= "\n" . (i + 1) . '. ' . dirlist[i]
115 endfor
116 let dirchoice = confirm(msg, dirchoices) - 2
117 if dirchoice >= 0
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000118 if exists('*fnameescape')
119 let dirname = fnameescape(dirlist[dirchoice])
120 else
121 let dirname = escape(dirlist[dirchoice], ' ')
122 endif
Bram Moolenaar6ee8d892012-01-10 14:55:01 +0100123 setlocal fenc=
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000124 exe "write " . dirname . '/' . fname
Bram Moolenaar1ef15e32006-02-01 21:56:25 +0000125
126 " Also download the .sug file, if the user wants to.
127 let msg = "Do you want me to try getting the .sug file?\n"
128 let msg .= "This will improve making suggestions for spelling mistakes,\n"
129 let msg .= "but it uses quite a bit of memory."
130 if confirm(msg, "&No\n&Yes") == 2
131 g/^/d
132 let fname = substitute(fname, '\.spl$', '.sug', '')
133 echo 'Downloading ' . fname . '...'
Bram Moolenaarc9a99912006-05-13 12:25:55 +0000134 call spellfile#Nread(fname)
Bram Moolenaar706cdeb2007-05-06 21:55:31 +0000135 if getline(2) =~ 'VIMsug'
Bram Moolenaar1ef15e32006-02-01 21:56:25 +0000136 1d
Bram Moolenaar8c8de832008-06-24 22:58:06 +0000137 exe "write " . dirname . '/' . fname
Bram Moolenaar706cdeb2007-05-06 21:55:31 +0000138 set nomod
139 else
140 echo 'Sorry, downloading failed'
141 " Go back to our own buffer/window, Nread() may have taken us to
142 " another window.
143 if newbufnr != winbufnr(0)
144 let winnr = bufwinnr(newbufnr)
145 if winnr != -1
146 exe winnr . "wincmd w"
147 endif
148 endif
149 if newbufnr == winbufnr(0)
150 set nomod
151 endif
Bram Moolenaar1ef15e32006-02-01 21:56:25 +0000152 endif
Bram Moolenaar1ef15e32006-02-01 21:56:25 +0000153 endif
154 endif
155
Bram Moolenaar706cdeb2007-05-06 21:55:31 +0000156 " Wipe out the buffer we used.
157 exe newbufnr . "bwipe"
Bram Moolenaar1ef15e32006-02-01 21:56:25 +0000158 endif
159endfunc
Bram Moolenaarc9a99912006-05-13 12:25:55 +0000160
Bram Moolenaar9526a542006-08-29 20:31:34 +0000161" Read "fname" from the server.
Bram Moolenaarc9a99912006-05-13 12:25:55 +0000162function! spellfile#Nread(fname)
Bram Moolenaar49325942007-05-10 19:19:59 +0000163 " We do our own error handling, don't want a window for it.
164 if exists("g:netrw_use_errorwindow")
165 let save_ew = g:netrw_use_errorwindow
166 endif
167 let g:netrw_use_errorwindow=0
168
Bram Moolenaar9526a542006-08-29 20:31:34 +0000169 if g:spellfile_URL =~ '^ftp://'
170 " for an ftp server use a default login and password to avoid a prompt
171 let machine = substitute(g:spellfile_URL, 'ftp://\([^/]*\).*', '\1', '')
172 let dir = substitute(g:spellfile_URL, 'ftp://[^/]*/\(.*\)', '\1', '')
173 exe 'Nread "' . machine . ' anonymous vim7user ' . dir . '/' . a:fname . '"'
174 else
175 exe 'Nread ' g:spellfile_URL . '/' . a:fname
176 endif
Bram Moolenaar49325942007-05-10 19:19:59 +0000177
178 if exists("save_ew")
179 let g:netrw_use_errorwindow = save_ew
180 else
181 unlet g:netrw_use_errorwindow
182 endif
Bram Moolenaarc9a99912006-05-13 12:25:55 +0000183endfunc
Bram Moolenaar5c736222010-01-06 20:54:52 +0100184
185" Get a list of writable spell directories and choices for confirm().
186function! spellfile#GetDirChoices()
187 let dirlist = []
188 let dirchoices = '&Cancel'
189 for dir in split(globpath(&rtp, 'spell'), "\n")
190 if filewritable(dir) == 2
191 call add(dirlist, dir)
192 let dirchoices .= "\n&" . len(dirlist)
193 endif
194 endfor
195 return [dirlist, dirchoices]
196endfunc
197
198function! spellfile#WritableSpellDir()
199 if has("unix")
200 " For Unix always use the $HOME/.vim directory
201 return $HOME . "/.vim/spell"
202 endif
203 for dir in split(&rtp, ',')
204 if filewritable(dir) == 2
205 return dir . "/spell"
206 endif
207 endfor
208 return ''
209endfunction