diff mbox series

git-p4: fix bug with encoding of p4 client name

Message ID pull.1285.git.git.1657267260405.gitgitgadget@gmail.com (mailing list archive)
State Accepted
Commit 34f67c9619b56ab4718427c1a31071641f0dccdb
Headers show
Series git-p4: fix bug with encoding of p4 client name | expand

Commit Message

Kilian Kilger July 8, 2022, 8:01 a.m. UTC
From: Kilian Kilger <kilian.kilger@sap.com>

The Perforce client name can contain arbitrary characters
which do not decode to UTF-8. Use the fallback strategy
implemented in metadata_stream_to_writable_bytes() also
for the client name.

Signed-off-by: Kilian Kilger <kkilger@gmail.com>
---
    git-p4: Fix bug with encoding of P4 client name

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1285%2Fcohomology%2Fmaint-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1285/cohomology/maint-v1
Pull-Request: https://github.com/git/git/pull/1285

 git-p4.py | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)


base-commit: e4a4b31577c7419497ac30cebe30d755b97752c5

Comments

Tao Klerks July 8, 2022, 11:28 a.m. UTC | #1
This makes sense to me, and I don't see anything wrong with the "form"
(and nor does GitGitGadget).

Not sure whether formal review sign-off is used on this list, I don't
tend to see it, but do I see "Reviewed-by" on patches, so FWIW:

Reviewed-by: Tao Klerks <tao@klerks.biz>


On Fri, Jul 8, 2022 at 10:01 AM Kilian Kilger via GitGitGadget
<gitgitgadget@gmail.com> wrote:
>
> From: Kilian Kilger <kilian.kilger@sap.com>
>
> The Perforce client name can contain arbitrary characters
> which do not decode to UTF-8. Use the fallback strategy
> implemented in metadata_stream_to_writable_bytes() also
> for the client name.
>
> Signed-off-by: Kilian Kilger <kkilger@gmail.com>
> ---
>     git-p4: Fix bug with encoding of P4 client name
>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1285%2Fcohomology%2Fmaint-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1285/cohomology/maint-v1
> Pull-Request: https://github.com/git/git/pull/1285
>
>  git-p4.py | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
>
> diff --git a/git-p4.py b/git-p4.py
> index 8fbf6eb1fe3..e65d6a2b0e1 100755
> --- a/git-p4.py
> +++ b/git-p4.py
> @@ -854,12 +854,12 @@ def p4CmdList(cmd, stdin=None, stdin_mode='w+b', cb=None, skip_info=False,
>              if bytes is not str:
>                  # Decode unmarshalled dict to use str keys and values, except for:
>                  #   - `data` which may contain arbitrary binary data
> -                #   - `desc` or `FullName` which may contain non-UTF8 encoded text handled below, eagerly converted to bytes
> +                #   - `desc` or `client` or `FullName` which may contain non-UTF8 encoded text handled below, eagerly converted to bytes
>                  #   - `depotFile[0-9]*`, `path`, or `clientFile` which may contain non-UTF8 encoded text, handled by decode_path()
>                  decoded_entry = {}
>                  for key, value in entry.items():
>                      key = key.decode()
> -                    if isinstance(value, bytes) and not (key in ('data', 'desc', 'FullName', 'path', 'clientFile') or key.startswith('depotFile')):
> +                    if isinstance(value, bytes) and not (key in ('data', 'desc', 'FullName', 'path', 'clientFile', 'client') or key.startswith('depotFile')):
>                          value = value.decode()
>                      decoded_entry[key] = value
>                  # Parse out data if it's an error response
> @@ -871,6 +871,8 @@ def p4CmdList(cmd, stdin=None, stdin_mode='w+b', cb=None, skip_info=False,
>                      continue
>              if 'desc' in entry:
>                  entry['desc'] = metadata_stream_to_writable_bytes(entry['desc'])
> +            if 'client' in entry:
> +                entry['client'] = metadata_stream_to_writable_bytes(entry['client'])
>              if 'FullName' in entry:
>                  entry['FullName'] = metadata_stream_to_writable_bytes(entry['FullName'])
>              if cb is not None:
>
> base-commit: e4a4b31577c7419497ac30cebe30d755b97752c5
> --
> gitgitgadget
Junio C Hamano July 8, 2022, 3:05 p.m. UTC | #2
Tao Klerks <tao@klerks.biz> writes:

>
>
> On Fri, Jul 8, 2022 at 10:01 AM Kilian Kilger via GitGitGadget
> <gitgitgadget@gmail.com> wrote:
>>
>> From: Kilian Kilger <kilian.kilger@sap.com>
>>
>> The Perforce client name can contain arbitrary characters
>> which do not decode to UTF-8. Use the fallback strategy
>> implemented in metadata_stream_to_writable_bytes() also
>> for the client name.
>>
>> Signed-off-by: Kilian Kilger <kkilger@gmail.com>
>> ---
>> ...
>>
>> @@ -871,6 +871,8 @@ def p4CmdList(cmd, stdin=None, stdin_mode='w+b', cb=None, skip_info=False,
>>                      continue
>>              if 'desc' in entry:
>>                  entry['desc'] = metadata_stream_to_writable_bytes(entry['desc'])
>> +            if 'client' in entry:
>> +                entry['client'] = metadata_stream_to_writable_bytes(entry['client'])
>>              if 'FullName' in entry:
>>                  entry['FullName'] = metadata_stream_to_writable_bytes(entry['FullName']

We had two repetitions and now we have three, which is a good time
to see if it makes sense to reduce the temptation for future
developers to add the fourth repetition in the next round, e.g.

	for e in ["client", "desc", "FullName"]:
		if e in entry:
			entry[e] = metadata_stream_to_writable_bytes(entry[e])

or something like that?

> This makes sense to me, and I don't see anything wrong with the "form"
> (and nor does GitGitGadget).

One thing that is a bit problematic is that in-body From does not
match the sign-off.  Kilian, which identity do you want to use in
your contribution to this project? 

> Not sure whether formal review sign-off is used on this list, I don't
> tend to see it, but do I see "Reviewed-by" on patches, so FWIW:
>
> Reviewed-by: Tao Klerks <tao@klerks.biz>

Thanks.
diff mbox series

Patch

diff --git a/git-p4.py b/git-p4.py
index 8fbf6eb1fe3..e65d6a2b0e1 100755
--- a/git-p4.py
+++ b/git-p4.py
@@ -854,12 +854,12 @@  def p4CmdList(cmd, stdin=None, stdin_mode='w+b', cb=None, skip_info=False,
             if bytes is not str:
                 # Decode unmarshalled dict to use str keys and values, except for:
                 #   - `data` which may contain arbitrary binary data
-                #   - `desc` or `FullName` which may contain non-UTF8 encoded text handled below, eagerly converted to bytes
+                #   - `desc` or `client` or `FullName` which may contain non-UTF8 encoded text handled below, eagerly converted to bytes
                 #   - `depotFile[0-9]*`, `path`, or `clientFile` which may contain non-UTF8 encoded text, handled by decode_path()
                 decoded_entry = {}
                 for key, value in entry.items():
                     key = key.decode()
-                    if isinstance(value, bytes) and not (key in ('data', 'desc', 'FullName', 'path', 'clientFile') or key.startswith('depotFile')):
+                    if isinstance(value, bytes) and not (key in ('data', 'desc', 'FullName', 'path', 'clientFile', 'client') or key.startswith('depotFile')):
                         value = value.decode()
                     decoded_entry[key] = value
                 # Parse out data if it's an error response
@@ -871,6 +871,8 @@  def p4CmdList(cmd, stdin=None, stdin_mode='w+b', cb=None, skip_info=False,
                     continue
             if 'desc' in entry:
                 entry['desc'] = metadata_stream_to_writable_bytes(entry['desc'])
+            if 'client' in entry:
+                entry['client'] = metadata_stream_to_writable_bytes(entry['client'])
             if 'FullName' in entry:
                 entry['FullName'] = metadata_stream_to_writable_bytes(entry['FullName'])
             if cb is not None: