Comment fonctionne l'astuce «écrire avec sudo» de vim?

Beaucoup d'entre vous ont probablement vu la commande qui vous permet d'écrire sur un fichier nécessitant une autorisation root, même si vous avez oublié d'ouvrir vim avec sudo:

:w !sudo tee %

Le fait est que je ne comprends pas exactement ce qui se passe ici.

Je l'ai déjà compris: wc'est pour ça

                                                        *:w_c* *:write_c*
:[range]w[rite] [++opt] !{cmd}
                        Execute {cmd} with [range] lines as standard input
                        (note the space in front of the '!').  {cmd} is
                        executed like with ":!{cmd}", any '!' is replaced with
                        the previous command |:!|.

il passe donc toutes les lignes en entrée standard.

La !sudo teepartie appelle teeavec des privilèges d'administrateur.

Pour que tout ait un sens, le %devrait afficher le nom de fichier (en tant que paramètre pour tee), mais je ne trouve pas de références dans l'aide pour ce comportement.

tl; dr Quelqu'un pourrait-il m'aider à disséquer cette commande?

Dans :w !sudo tee %...

% signifie "le fichier courant"

Comme l'a souligné eugene y , %cela signifie en effet "le nom du fichier actuel", qui est transmis pour teequ'il sache à quel fichier écraser.

(Dans les commandes de substitution, c'est légèrement différent; comme le :help :%montre, c'est equal to 1,$ (the entire file)(merci à @Orafu d'avoir souligné que cela n'évalue pas le nom du fichier). Par exemple, :%s/foo/barsignifie " dans le fichier actuel , remplacez les occurrences de foopar bar". Si vous mettez en surbrillance du texte avant de taper :s, vous verrez que les lignes en surbrillance %remplacent votre plage de substitution.)

:w ne met pas à jour votre fichier

Une partie déroutante de cette astuce est que vous pensez peut-être :wmodifier votre fichier, mais ce n'est pas le cas. Si vous avez ouvert et modifié file1.txt, puis exécuté :w file2.txt, ce serait un "enregistrer sous"; file1.txtne serait pas modifié, mais le contenu du tampon actuel serait envoyé à file2.txt.

Au lieu de file2.txt, vous pouvez remplacer une commande shell pour recevoir le contenu du tampon . Par exemple, :w !cataffichera simplement le contenu.

Si Vim n'a pas été exécuté avec l'accès sudo, :wil ne peut pas modifier un fichier protégé, mais s'il transmet le contenu du tampon au shell, une commande dans le shell peut être exécutée avec sudo . Dans ce cas, nous utilisons tee.

Comprendre le tee

Quant à tee, imaginez la teecommande comme un tuyau en forme de T dans une situation de tuyauterie bash normale: elle dirige la sortie vers le (s) fichier (s) spécifié (s) et l' envoie également vers la sortie standard , qui peut être capturée par la prochaine commande canalisée.

Par exemple, dans ps -ax | tee processes.txt | grep 'foo', la liste des processus sera écrite dans un fichier texte et transmise à grep.

     +-----------+    tee     +------------+
     |           |  --------  |            |
     | ps -ax    |  --------  | grep 'foo' |
     |           |     ||     |            |
     +-----------+     ||     +------------+
                       ||   
               +---------------+
               |               |
               | processes.txt |
               |               |
               +---------------+

(Diagramme créé avec Asciiflow .)

Voir la teepage de manuel pour plus d'informations.

Tee comme un hack

Dans la situation décrite dans votre question, l' utilisation teeest un hack car nous ignorons la moitié de ce qu'elle fait . sudo teeécrit dans notre fichier et envoie également le contenu du tampon à la sortie standard, mais nous ignorons la sortie standard . Nous n'avons pas besoin de passer quoi que ce soit à une autre commande canalisée dans ce cas; nous utilisons juste teecomme une autre façon d'écrire un fichier et pour que nous puissions l'appeler avec sudo.

Rendre cette astuce facile

Vous pouvez l'ajouter à votre .vimrcpour rendre cette astuce facile à utiliser: il suffit de taper :w!!.

" Allow saving of files as sudo when I forgot to start vim using sudo.
cmap w!! w !sudo tee > /dev/null %

La > /dev/nullpartie jette explicitement la sortie standard, car, comme je l'ai dit, nous n'avons pas besoin de passer quoi que ce soit à une autre commande canalisée.

Dans la ligne de commande exécutée, %représente le nom de fichier actuel . Ceci est documenté dans :help cmdline-special:

In Ex commands, at places where a file name can be used, the following
characters have a special meaning.
        %       Is replaced with the current file name.

Comme vous l'avez déjà découvert, :w !cmdredirige le contenu du tampon actuel vers une autre commande. Qu'est tee- ce que c'est copier l'entrée standard dans un ou plusieurs fichiers, et aussi sur la sortie standard. Par conséquent, :w !sudo tee % > /dev/nullécrit efficacement le contenu du tampon actuel dans le fichier actuel tout en étant root . Une autre commande qui peut être utilisée pour cela est dd:

:w !sudo dd of=% > /dev/null

En tant que raccourci, vous pouvez ajouter ce mappage à votre .vimrc:

" Force saving files that require root permission 
cnoremap w!! w !sudo tee > /dev/null %

Avec ce qui précède, vous pouvez taper :w!!<Enter>pour enregistrer le fichier en tant que root.

Cela fonctionne également bien:

:w !sudo sh -c "cat > %"

Ceci est inspiré par le commentaire de @Nathan Long.

AVIS :

"doit être utilisé à la place de 'car nous voulons %être développés avant de passer au shell.

:w - Écrivez un fichier.

!sudo - Appelez la commande shell sudo.

tee- La sortie de la commande write (vim: w) redirigée à l'aide de tee. Le% n'est rien d'autre que le nom de fichier actuel, c'est-à-dire /etc/apache2/conf.d/mediawiki.conf. En d'autres termes, la commande tee est exécutée en tant que root et prend une entrée standard et l'écrit dans un fichier représenté par%. Cependant, cela vous invitera à recharger à nouveau le fichier (appuyez sur L pour charger les modifications dans vim lui-même):

lien du tutoriel

La réponse acceptée couvre tout, donc je vais donner un autre exemple de raccourci que j'utilise, pour mémoire.

Ajoutez-le à votre etc/vim/vimrc(ou ~/.vimrc):

• cnoremap w!! execute 'silent! write !sudo tee % >/dev/null' <bar> edit!

Où:

• cnoremap: indique à vim que le raccourci suivant doit être associé dans la ligne de commande.
• w!!: le raccourci lui-même.
• execute '...': une commande qui exécute la chaîne suivante.
• silent!: exécutez-le en silence
• write !sudo tee % >/dev/null: la question OP, ajout d'une redirection de messages NULLpour faire une commande propre
• <bar> edit!: cette astuce est la cerise sur le gâteau: elle appelle aussi la editcommande pour recharger le buffer puis éviter les messages tels que le buffer a changé . <bar>est de savoir comment écrire le symbole de tuyau pour séparer deux commandes ici.

J'espère que cela aide. Voir aussi pour d'autres problèmes:

• SuperUser: forcer vim à écrire un fichier

Je voudrais suggérer une autre approche au problème "Oups que j'ai oublié d'écrire sudolors de l'ouverture de mon fichier" :

Au lieu de recevoir un permission denied, et d'avoir à taper :w!!, je trouve plus élégant d'avoir une vimcommande conditionnelle qui fait sudo vimsi le propriétaire du fichier l'est root.

C'est aussi facile à implémenter (il pourrait même y avoir des implémentations plus élégantes, je ne suis clairement pas un bash-gourou):

function vim(){
  OWNER=$(stat -c '%U' $1)
  if [[ "$OWNER" == "root" ]]; then
    sudo /usr/bin/vim $*;
  else
    /usr/bin/vim $*;
  fi
}

Et ça marche vraiment bien.

Il s'agit d'une bashapproche plus centrée qu'une vim- donc tout le monde ne l'aimera peut-être pas.

Bien sûr:

• il y a des cas d'utilisation où il échouera (lorsque le propriétaire du fichier ne l'est pas rootmais l'exige sudo, mais que la fonction peut être modifiée de toute façon)
• cela n'a pas de sens lors de l'utilisation vimen lecture seule d'un fichier (en ce qui me concerne, j'utilise tailou catpour de petits fichiers)

Mais je trouve que cela apporte une bien meilleure expérience utilisateur de développement , ce qui est quelque chose que IMHO a tendance à oublier lors de l'utilisation bash. :-)

POUR NEOVIM

En raison de problèmes avec les appels interactifs ( https://github.com/neovim/neovim/issues/1716 ), je l'utilise pour neovim, sur la base de la réponse du Dr Beco:

cnoremap w!! execute 'silent! write !SUDO_ASKPASS=`which ssh-askpass` sudo tee % >/dev/null' <bar> edit!

Cela ouvrira une boîte de dialogue utilisant la ssh-askpassdemande du mot de passe sudo.