Skip to content

[Sync-En] exec: document escapeshellarg()/escapeshellcmd() multibyte behavior #1104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
julionc merged 1 commit into from
Aug 26, 2026
+32 −20
Merged

[Sync-En] exec: document escapeshellarg()/escapeshellcmd() multibyte behavior #1104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 15 additions & 9 deletions reference/exec/functions/escapeshellarg.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 60c391265d2a51003e1ed0952e5a2413f81c7fc2 Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: 0600ff7ba94e3f491aeb246d8ddfedd98f0d7276 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.escapeshellarg" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
Expand All @@ -14,7 +14,7 @@
<type>string</type><methodname>escapeshellarg</methodname>
<methodparam><type>string</type><parameter>arg</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>escapeshellarg</function> añade comillas simples
alrededor de las cadenas de caracteres, y añade
comillas y escapa las comillas simples de la
Expand All @@ -25,14 +25,19 @@
a pasar al Shell. Las funciones Shell son <function>exec</function>,
<function>system</function> y los operadores
<link linkend="language.operators.execution">comillas invertidas</link>.
</para>
<para>
</simpara>
<simpara>
En Windows, <function>escapeshellarg</function> reemplaza en su lugar los
signos de porcentaje, los signos de exclamación (sustitución de variables
diferidas) y las comillas dobles con espacios y añade comillas dobles alrededor de la cadena.
Además, cada serie de barras invertidas consecutivas (<literal>\</literal>)
es escapada por una barra invertida adicional.
</para>
</simpara>
<simpara>
El comportamiento de esta función con cadenas multibyte depende de la
configuración regional <constant>LC_CTYPE</constant> actual. Los caracteres
no reconocidos serán descartados. Véase <function>setlocale</function>.
</simpara>
</refsect1>

<refsect1 role="parameters">
Expand All @@ -42,9 +47,9 @@
<varlistentry>
<term><parameter>arg</parameter></term>
<listitem>
<para>
<simpara>
El argumento a escapar.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
Expand All @@ -53,9 +58,9 @@

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
La cadena escapada.
</para>
</simpara>
</refsect1>

<refsect1 role="examples">
Expand All @@ -78,6 +83,7 @@ system('ls '.escapeshellarg($dir));
&reftitle.seealso;
<para>
<simplelist>
<member><function>setlocale</function></member>
<member><function>escapeshellcmd</function></member>
<member><function>exec</function></member>
<member><function>popen</function></member>
Expand Down
28 changes: 17 additions & 11 deletions reference/exec/functions/escapeshellcmd.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 62126c55f1c6ed444043e7272c4f9e233818a44b Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: 0600ff7ba94e3f491aeb246d8ddfedd98f0d7276 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.escapeshellcmd" xmlns="http://docbook.org/ns/docbook">
Expand All @@ -15,23 +15,28 @@
<type>string</type><methodname>escapeshellcmd</methodname>
<methodparam><type>string</type><parameter>command</parameter></methodparam>
</methodsynopsis>
<para>
<simpara>
<function>escapeshellcmd</function> escapa todos los
caracteres de la cadena <parameter>command</parameter>
que podrían tener un significado especial en una
orden Shell. Esta función permite asegurarse de que la orden será
correctamente pasada al ejecutor de órdenes Shell
<function>exec</function> y <function>system</function>, o incluso
a <link linkend="language.operators.execution">comillas invertidas</link>.
</para>
<para>
</simpara>
<simpara>
Los siguientes caracteres serán escapados:
<literal>&amp;#;`|*?~&lt;&gt;^()[]{}$\</literal>, <literal>\x0A</literal>
y <literal>\xFF</literal>. <literal>'</literal> y <literal>"</literal>
son escapados solo si no están en pares. En Windows, todos estos caracteres
así como <literal>%</literal> y <literal>!</literal> son precedidos por
un circunflejo (<literal>^</literal>).
</para>
</simpara>
<simpara>
El comportamiento de esta función con cadenas multibyte depende de la
configuración regional <constant>LC_CTYPE</constant> actual. Los caracteres
no reconocidos serán descartados. Véase <function>setlocale</function>.
</simpara>
</refsect1>

<refsect1 role="parameters">
Expand All @@ -41,9 +46,9 @@
<varlistentry>
<term><parameter>command</parameter></term>
<listitem>
<para>
<simpara>
La orden a escapar.
</para>
</simpara>
</listitem>
</varlistentry>
</variablelist>
Expand All @@ -52,9 +57,9 @@

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<simpara>
La cadena escapada.
</para>
</simpara>
</refsect1>

<refsect1 role="examples">
Expand All @@ -81,14 +86,14 @@ system($escaped_command);
<refsect1 role="notes">
&reftitle.notes;
<warning xmlns="http://docbook.org/ns/docbook">
<para>
<simpara>
La función <function>escapeshellcmd</function> debe ser utilizada
sobre toda la cadena de orden, y permite
a personas malintencionadas pasar un número arbitrario
de argumentos. Para escapar un solo argumento,
la función <function>escapeshellarg</function> debería ser
utilizada en su lugar.
</para>
</simpara>
</warning>
<warning xmlns="http://docbook.org/ns/docbook">
<para>
Expand All @@ -110,6 +115,7 @@ $cmd = preg_replace('`(?<!^) `', '^ ', escapeshellcmd($cmd));
&reftitle.seealso;
<para>
<simplelist>
<member><function>setlocale</function></member>
<member><function>escapeshellarg</function></member>
<member><function>exec</function></member>
<member><function>popen</function></member>
Expand Down