1
0
Fork 0
mirror of https://github.com/vim/vim synced 2025-03-16 14:57:52 +01:00
vim/runtime/autoload/zip.vim

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

430 lines
12 KiB
VimL
Raw Normal View History

2005-09-16 21:55:43 +00:00
" zip.vim: Handles browsing zipfiles
" AUTOLOAD PORTION
" Date: 2024 Aug 21
" Version: 34
" Maintainer: This runtime file is looking for a new maintainer.
" Former Maintainer: Charles E Campbell
" Last Change:
" 2024 Jun 16 by Vim Project: handle whitespace on Windows properly (#14998)
" 2024 Jul 23 by Vim Project: fix 'x' command
" 2024 Jul 24 by Vim Project: use delete() function
" 2024 Jul 30 by Vim Project: fix opening remote zipfile
" 2024 Aug 04 by Vim Project: escape '[' in name of file to be extracted
" 2024 Aug 05 by Vim Project: workaround for the FreeBSD's unzip
" 2024 Aug 05 by Vim Project: clean-up and make it work with shellslash on Windows
" 2024 Aug 18 by Vim Project: correctly handle special globbing chars
" 2024 Aug 21 by Vim Project: simplify condition to detect MS-Windows
2007-05-05 17:54:07 +00:00
" License: Vim License (see vim's :help license)
" Copyright: Copyright (C) 2005-2019 Charles E. Campbell {{{1
" Permission is hereby granted to use and distribute this code,
" with or without modifications, provided that this copyright
" notice is copied with it. Like anything else that's free,
" zip.vim and zipPlugin.vim are provided *as is* and comes with
" no warranty of any kind, either expressed or implied. By using
" this plugin, you agree that in no event will the copyright
" holder be liable for any damages resulting from the use
" of this software.
2005-09-16 21:55:43 +00:00
" ---------------------------------------------------------------------
2007-05-05 17:54:07 +00:00
" Load Once: {{{1
2010-05-14 23:24:24 +02:00
if &cp || exists("g:loaded_zip")
finish
endif
let g:loaded_zip= "v34"
2010-05-14 23:24:24 +02:00
let s:keepcpo= &cpo
set cpo&vim
2005-09-16 21:55:43 +00:00
2006-03-23 22:59:57 +00:00
let s:zipfile_escape = ' ?&;\'
2007-05-05 17:54:07 +00:00
let s:ERROR = 2
let s:WARNING = 1
let s:NOTE = 0
" ---------------------------------------------------------------------
" Global Values: {{{1
if !exists("g:zip_shq")
2008-06-24 21:56:24 +00:00
if &shq != ""
let g:zip_shq= &shq
elseif has("unix")
2007-05-05 17:54:07 +00:00
let g:zip_shq= "'"
else
let g:zip_shq= '"'
endif
endif
2007-05-10 18:25:20 +00:00
if !exists("g:zip_zipcmd")
let g:zip_zipcmd= "zip"
endif
if !exists("g:zip_unzipcmd")
let g:zip_unzipcmd= "unzip"
endif
2016-09-16 20:02:31 +02:00
if !exists("g:zip_extractcmd")
let g:zip_extractcmd= g:zip_unzipcmd
endif
2005-09-16 21:55:43 +00:00
" ---------------------------------------------------------------------
" required early
" s:Mess: {{{2
fun! s:Mess(group, msg)
redraw!
exe "echohl " . a:group
echomsg a:msg
echohl Normal
endfun
if v:version < 901
" required for defer
call s:Mess('WarningMsg', "***warning*** this version of zip needs vim 9.1 or later")
finish
endif
" sanity checks
if !executable(g:zip_unzipcmd)
call s:Mess('Error', "***error*** (zip#Browse) unzip not available on your system")
finish
endif
if !dist#vim#IsSafeExecutable('zip', g:zip_unzipcmd)
call s:Mess('Error', "Warning: NOT executing " .. g:zip_unzipcmd .. " from current directory!")
finish
endif
2005-09-16 21:55:43 +00:00
" ----------------
" Functions: {{{1
" ----------------
" ---------------------------------------------------------------------
" zip#Browse: {{{2
fun! zip#Browse(zipfile)
" sanity check: ensure that the zipfile has "PK" as its first two letters
" (zip files have a leading PK as a "magic cookie")
if filereadable(a:zipfile) && readblob(a:zipfile, 0, 2) != 0z50.4B
exe "noswapfile noautocmd e " .. fnameescape(a:zipfile)
return
endif
let dict = s:SetSaneOpts()
defer s:RestoreOpts(dict)
2005-09-16 21:55:43 +00:00
" sanity checks
2007-05-10 18:25:20 +00:00
if !executable(g:zip_unzipcmd)
call s:Mess('Error', "***error*** (zip#Browse) unzip not available on your system")
2005-09-16 21:55:43 +00:00
return
endif
if !filereadable(a:zipfile)
2005-11-23 21:25:05 +00:00
if a:zipfile !~# '^\a\+://'
2020-01-14 19:29:13 +01:00
" if it's an url, don't complain, let url-handlers such as vim do its thing
call s:Mess('Error', "***error*** (zip#Browse) File not readable <".a:zipfile.">")
2005-11-23 21:25:05 +00:00
endif
2005-09-16 21:55:43 +00:00
return
endif
if &ma != 1
set ma
endif
2007-05-10 18:25:20 +00:00
let b:zipfile= a:zipfile
2005-09-16 21:55:43 +00:00
setlocal noswapfile
setlocal buftype=nofile
setlocal bufhidden=hide
setlocal nobuflisted
setlocal nowrap
2021-11-16 19:18:26 +00:00
" Oct 12, 2021: need to re-use Bram's syntax/tar.vim.
" Setting the filetype to zip doesn't do anything (currently),
" but it is perhaps less confusing to curious perusers who do
" a :echo &ft
setf zip
run! syntax/tar.vim
2005-09-16 21:55:43 +00:00
" give header
2011-06-19 05:09:16 +02:00
call append(0, ['" zip.vim version '.g:loaded_zip,
2012-01-20 21:08:56 +01:00
\ '" Browsing zipfile '.a:zipfile,
\ '" Select a file with cursor and press ENTER'])
2011-06-19 05:09:16 +02:00
keepj $
2005-09-16 21:55:43 +00:00
exe $"keepj sil r! {g:zip_unzipcmd} -Z1 -- {s:Escape(a:zipfile, 1)}"
2006-05-02 22:08:30 +00:00
if v:shell_error != 0
call s:Mess('WarningMsg', "***warning*** (zip#Browse) ".fnameescape(a:zipfile)." is not a zip file")
2011-06-19 05:09:16 +02:00
keepj sil! %d
2006-05-02 22:08:30 +00:00
let eikeep= &ei
set ei=BufReadCmd,FileReadCmd
2011-06-19 05:09:16 +02:00
exe "keepj r ".fnameescape(a:zipfile)
2006-05-02 22:08:30 +00:00
let &ei= eikeep
2011-06-19 05:09:16 +02:00
keepj 1d
2006-05-02 22:08:30 +00:00
return
endif
2005-09-16 21:55:43 +00:00
2016-09-16 20:02:31 +02:00
" Maps associated with zip plugin
2005-09-16 21:55:43 +00:00
setlocal noma nomod ro
2020-01-09 21:46:04 +01:00
noremap <silent> <buffer> <cr> :call <SID>ZipBrowseSelect()<cr>
noremap <silent> <buffer> x :call zip#Extract()<cr>
if &mouse != ""
noremap <silent> <buffer> <leftmouse> <leftmouse>:call <SID>ZipBrowseSelect()<cr>
endif
2005-09-16 21:55:43 +00:00
endfun
" ---------------------------------------------------------------------
" ZipBrowseSelect: {{{2
fun! s:ZipBrowseSelect()
let dict = s:SetSaneOpts()
defer s:RestoreOpts(dict)
2005-09-16 21:55:43 +00:00
let fname= getline(".")
2023-04-22 22:40:14 +01:00
if !exists("b:zipfile")
return
endif
2005-09-16 21:55:43 +00:00
" sanity check
if fname =~ '^"'
return
endif
if fname =~ '/$'
call s:Mess('Error', "***error*** (zip#Browse) Please specify a file, not a directory")
2005-09-16 21:55:43 +00:00
return
endif
" get zipfile to the new-window
2007-05-10 18:25:20 +00:00
let zipfile = b:zipfile
2020-01-09 21:46:04 +01:00
let curfile = expand("%")
2005-09-16 21:55:43 +00:00
2020-01-09 21:46:04 +01:00
noswapfile new
2008-06-24 21:56:24 +00:00
if !exists("g:zip_nomax") || g:zip_nomax == 0
wincmd _
endif
2005-11-23 21:25:05 +00:00
let s:zipfile_{winnr()}= curfile
2021-11-16 19:18:26 +00:00
exe "noswapfile e ".fnameescape("zipfile://".zipfile.'::'.fname)
2005-09-16 21:55:43 +00:00
filetype detect
endfun
" ---------------------------------------------------------------------
" zip#Read: {{{2
fun! zip#Read(fname,mode)
let dict = s:SetSaneOpts()
defer s:RestoreOpts(dict)
2005-11-28 23:01:53 +00:00
2006-05-02 22:08:30 +00:00
if has("unix")
2021-11-16 19:18:26 +00:00
let zipfile = substitute(a:fname,'zipfile://\(.\{-}\)::[^\\].*$','\1','')
let fname = substitute(a:fname,'zipfile://.\{-}::\([^\\].*\)$','\1','')
2006-05-02 22:08:30 +00:00
else
2021-11-16 19:18:26 +00:00
let zipfile = substitute(a:fname,'^.\{-}zipfile://\(.\{-}\)::[^\\].*$','\1','')
let fname = substitute(a:fname,'^.\{-}zipfile://.\{-}::\([^\\].*\)$','\1','')
2006-05-02 22:08:30 +00:00
endif
let fname = fname->substitute('[', '[[]', 'g')->escape('?*\\')
2016-09-16 20:02:31 +02:00
" sanity check
if !executable(substitute(g:zip_unzipcmd,'\s\+.*$','',''))
call s:Mess('Error', "***error*** (zip#Read) sorry, your system doesn't appear to have the ".g:zip_unzipcmd." program")
2016-09-16 20:02:31 +02:00
return
endif
2005-09-16 21:55:43 +00:00
2013-04-24 18:51:19 +02:00
" the following code does much the same thing as
" exe "keepj sil! r! ".g:zip_unzipcmd." -p -- ".s:Escape(zipfile,1)." ".s:Escape(fname,1)
2021-11-16 19:18:26 +00:00
" but allows zipfile://... entries in quickfix lists
2013-04-24 18:51:19 +02:00
let temp = tempname()
let fn = expand('%:p')
exe "sil !".g:zip_unzipcmd." -p -- ".s:Escape(zipfile,1)." ".s:Escape(fname,1).' > '.temp
2013-04-24 18:51:19 +02:00
sil exe 'keepalt file '.temp
sil keepj e!
sil exe 'keepalt file '.fnameescape(fn)
call delete(temp)
2011-06-19 05:09:16 +02:00
filetype detect
2005-09-16 21:55:43 +00:00
" cleanup
set nomod
endfun
" ---------------------------------------------------------------------
" zip#Write: {{{2
fun! zip#Write(fname)
let dict = s:SetSaneOpts()
defer s:RestoreOpts(dict)
2005-09-16 21:55:43 +00:00
" sanity checks
2016-09-16 20:02:31 +02:00
if !executable(substitute(g:zip_zipcmd,'\s\+.*$','',''))
call s:Mess('Error', "***error*** (zip#Write) sorry, your system doesn't appear to have the ".g:zip_zipcmd." program")
2005-09-16 21:55:43 +00:00
return
endif
if !exists("*mkdir")
call s:Mess('Error', "***error*** (zip#Write) sorry, mkdir() doesn't work on your system")
2005-09-16 21:55:43 +00:00
return
endif
let curdir= getcwd()
let tmpdir= tempname()
if tmpdir =~ '\.'
let tmpdir= substitute(tmpdir,'\.[^.]*$','','e')
endif
call mkdir(tmpdir,"p")
" attempt to change to the indicated directory
2007-05-05 17:54:07 +00:00
if s:ChgDir(tmpdir,s:ERROR,"(zip#Write) cannot cd to temporary directory")
2005-09-16 21:55:43 +00:00
return
2007-05-05 17:54:07 +00:00
endif
2005-09-16 21:55:43 +00:00
" place temporary files under .../_ZIPVIM_/
if isdirectory("_ZIPVIM_")
call delete("_ZIPVIM_", "rf")
2005-09-16 21:55:43 +00:00
endif
call mkdir("_ZIPVIM_")
cd _ZIPVIM_
2006-05-02 22:08:30 +00:00
if has("unix")
2021-11-16 19:18:26 +00:00
let zipfile = substitute(a:fname,'zipfile://\(.\{-}\)::[^\\].*$','\1','')
let fname = substitute(a:fname,'zipfile://.\{-}::\([^\\].*\)$','\1','')
2006-05-02 22:08:30 +00:00
else
2021-11-16 19:18:26 +00:00
let zipfile = substitute(a:fname,'^.\{-}zipfile://\(.\{-}\)::[^\\].*$','\1','')
let fname = substitute(a:fname,'^.\{-}zipfile://.\{-}::\([^\\].*\)$','\1','')
2006-05-02 22:08:30 +00:00
endif
2005-12-29 22:48:26 +00:00
if fname =~ '/'
let dirpath = substitute(fname,'/[^/]\+$','','e')
2013-04-24 18:51:19 +02:00
if has("win32unix") && executable("cygpath")
2008-07-13 17:41:49 +00:00
let dirpath = substitute(system("cygpath ".s:Escape(dirpath,0)),'\n','','e')
2005-12-29 22:48:26 +00:00
endif
call mkdir(dirpath,"p")
endif
2005-09-16 21:55:43 +00:00
if zipfile !~ '/'
let zipfile= curdir.'/'.zipfile
endif
2008-07-13 17:41:49 +00:00
exe "w! ".fnameescape(fname)
2013-04-24 18:51:19 +02:00
if has("win32unix") && executable("cygpath")
2008-07-13 17:41:49 +00:00
let zipfile = substitute(system("cygpath ".s:Escape(zipfile,0)),'\n','','e')
2005-09-16 21:55:43 +00:00
endif
2007-05-05 17:54:07 +00:00
if (has("win32") || has("win95") || has("win64") || has("win16")) && &shell !~? 'sh$'
let fname = substitute(fname, '[', '[[]', 'g')
endif
2008-08-06 17:06:04 +00:00
call system(g:zip_zipcmd." -u ".s:Escape(fnamemodify(zipfile,":p"),0)." ".s:Escape(fname,0))
2005-09-16 21:55:43 +00:00
if v:shell_error != 0
call s:Mess('Error', "***error*** (zip#Write) sorry, unable to update ".zipfile." with ".fname)
2005-11-23 21:25:05 +00:00
elseif s:zipfile_{winnr()} =~ '^\a\+://'
" support writing zipfiles across a network
let netzipfile= s:zipfile_{winnr()}
1split|enew
let binkeep= &binary
let eikeep = &ei
set binary ei=all
2020-01-09 21:46:04 +01:00
exe "noswapfile e! ".fnameescape(zipfile)
2005-11-23 21:25:05 +00:00
call netrw#NetWrite(netzipfile)
let &ei = eikeep
let &binary = binkeep
q!
unlet s:zipfile_{winnr()}
2005-09-16 21:55:43 +00:00
endif
2005-09-16 21:55:43 +00:00
" cleanup and restore current directory
cd ..
call delete("_ZIPVIM_", "rf")
2007-05-05 17:54:07 +00:00
call s:ChgDir(curdir,s:WARNING,"(zip#Write) unable to return to ".curdir."!")
call delete(tmpdir, "rf")
2005-09-16 21:55:43 +00:00
setlocal nomod
endfun
2016-09-16 20:02:31 +02:00
" ---------------------------------------------------------------------
" zip#Extract: extract a file from a zip archive {{{2
fun! zip#Extract()
let dict = s:SetSaneOpts()
defer s:RestoreOpts(dict)
2016-09-16 20:02:31 +02:00
let fname= getline(".")
" sanity check
if fname =~ '^"'
return
endif
if fname =~ '/$'
call s:Mess('Error', "***error*** (zip#Extract) Please specify a file, not a directory")
2016-09-16 20:02:31 +02:00
return
endif
if filereadable(fname)
call s:Mess('Error', "***error*** (zip#Extract) <" .. fname .."> already exists in directory, not overwriting!")
return
endif
let target = fname->substitute('\[', '[[]', 'g')
if &shell =~ 'cmd' && has("win32")
let target = target
\ ->substitute('[?*]', '[&]', 'g')
\ ->substitute('[\\]', '?', 'g')
\ ->shellescape()
" there cannot be a file name with '\' in its name, unzip replaces it by _
let fname = fname->substitute('[\\?*]', '_', 'g')
else
let target = target->escape('*?\\')->shellescape()
endif
2016-09-16 20:02:31 +02:00
" extract the file mentioned under the cursor
call system($"{g:zip_extractcmd} -o {shellescape(b:zipfile)} {target}")
2016-09-16 20:02:31 +02:00
if v:shell_error != 0
call s:Mess('Error', "***error*** ".g:zip_extractcmd." ".b:zipfile." ".fname.": failed!")
2016-09-16 20:02:31 +02:00
elseif !filereadable(fname)
call s:Mess('Error', "***error*** attempted to extract ".fname." but it doesn't appear to be present!")
2016-09-16 20:02:31 +02:00
else
echomsg "***note*** successfully extracted ".fname
2016-09-16 20:02:31 +02:00
endif
endfun
2007-05-05 17:54:07 +00:00
" ---------------------------------------------------------------------
2008-07-13 17:41:49 +00:00
" s:Escape: {{{2
fun! s:Escape(fname,isfilt)
if exists("*shellescape")
if a:isfilt
let qnameq= shellescape(a:fname,1)
else
let qnameq= shellescape(a:fname)
endif
2008-06-24 21:56:24 +00:00
else
let qnameq= g:zip_shq.escape(a:fname,g:zip_shq).g:zip_shq
endif
return qnameq
2007-05-05 17:54:07 +00:00
endfun
" ---------------------------------------------------------------------
" s:ChgDir: {{{2
2007-05-05 17:54:07 +00:00
fun! s:ChgDir(newdir,errlvl,errmsg)
try
2008-08-06 17:06:04 +00:00
exe "cd ".fnameescape(a:newdir)
2007-05-05 17:54:07 +00:00
catch /^Vim\%((\a\+)\)\=:E344/
redraw!
if a:errlvl == s:NOTE
echomsg "***note*** ".a:errmsg
2007-05-05 17:54:07 +00:00
elseif a:errlvl == s:WARNING
call s:Mess("WarningMsg", "***warning*** ".a:errmsg)
2007-05-05 17:54:07 +00:00
elseif a:errlvl == s:ERROR
call s:Mess("Error", "***error*** ".a:errmsg)
2007-05-05 17:54:07 +00:00
endif
return 1
endtry
return 0
endfun
" ---------------------------------------------------------------------
" s:SetSaneOpts: {{{2
fun! s:SetSaneOpts()
let dict = {}
let dict.report = &report
let dict.shellslash = &shellslash
let &report = 10
let &shellslash = 0
return dict
endfun
" ---------------------------------------------------------------------
" s:RestoreOpts: {{{2
fun! s:RestoreOpts(dict)
for [key, val] in items(a:dict)
exe $"let &{key} = {val}"
endfor
endfun
2005-09-16 21:55:43 +00:00
" ------------------------------------------------------------------------
" Modelines And Restoration: {{{1
let &cpo= s:keepcpo
unlet s:keepcpo
2007-05-10 18:25:20 +00:00
" vim:ts=8 fdm=marker