Whitespace collapsing, Backslash escaping, Quoted escaping not implemented

未关闭
#51 5 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
停滞
技术栈
android, java
领域
tooling

调研方向

Start by reading the Android string-resource escaping guidance linked in the issue, then reproduce the examples by decompiling and rebuilding the attached APK with the documented APKEditor commands. Trace the string handling in both the decompile and build paths; the issue does not name source files or tests. Done means the examples preserve or interpret whitespace, backslashes, quotes, and escape sequences compatibly with Android resource strings.

由索引模型根据 Issue 内容生成。

描述

good first issue

Describe the bug
Whitespace collapsing, Backslash escaping, Quoted escaping not implemented in APKEditor
See this link for how it should behave: https://developer.android.com/guide/topics/resources/string-resource#escaping_quotes

Build examples:

Input string given to APKEditor to build Expected text displayed in app Current text displayed in app
Whitespace collapsed Whitespace collapsed
Whitespace    collapsed
Unicode: \u00A9 Unicode: © Unicode: \u00A9
"That's cool!" That's cool! "That's cool!"
That's cool! Compile Error That's cool!
Backslash (\\) (\) Backslash (\) () Backslash (\\) (\)

Decompile example: (❌ incorrect, ✅ correct)

String in android studio Expected string extracted from apk (mutiple correct examples) String extracted from apk by APKEditor String Extracted from apk by apktool
"Tab ulated" Tab\u0009ulated
Tab\tulated
"Tab ulated"
❌ Tab ulated ✅ Tab\u0009ulated
\'single\' \'single\'
"'single'"
"\'single\'"
❌ 'single' ✅ "'single'"
"\"double\"" "\"double\""
\"double\"
❌ "double" ✅ \"double\"
(\\) (\) (\\) () ❌ (\) () ✅ (\\) ()
\u00A9 \u00A9
©
©
✅ © ✅ ©

To Reproduce
Steps to reproduce the behavior:

  1. Used version '1.2.6'
  2. Operating system 'Linux 5.15.90.1-microsoft-standard-WSL2 x86_64 GNU/Linux'
  3. Commands java -jar APKEditor-1.2.6.jar d -dex -i app-debug.apk and java -jar APKEditor-1.2.6.jar b -i app-debug_decompile_xml -o packed.apk

See the original strings used to build the apk at strings (original)
See the expected output in image strings (original) built with android studio
I also attached the output produced by apktool for reference strings (apktool decompilation output). The decompiled strings created by apktool are different than strings (original) but that is not a problem, as both XML files produce the same apk as seen on images strings (original) built with android studio and strings (apktool decompilation output) built with android studio

Problem 1: The output produced by unpacking with APKEditor is not compatible with the format that other tools such as android studio expect.

To reproduce unpack the attached apk. The unpacked strings.xml is not compatible with the format that Android Studio accepts. When trying to build my example apk I get an error due to the unescaped single quotes '. After escaping the single quotes with a backslash \ and building the app I get the output seen in the attached image strings (APKEditor decompilation output manually edited to escape single quotes) built with android studio.

Problem 2: The APKEditor packer doesn't recognise backslash \ escape codes and double quoted escapes as its input.

To reproduce unpack the attached apk. Edit the strings.xml to the attached strings (original) then pack/build with APKEditor. The built apk will produce the output shown in the image strings (original) packed with APKEditor with is not correct.

Used apk file
app-debug.apk.zip

Attached XML

strings (original)

    <string name="test_string">Android escape and quotation test
\n"Tab\tulated 1"
\n"Tab	ulated 2"
\nTab\tulated 3
\nTab	ulated 4
\nBackslash (\\) (\)
\nQuestion\?
\n"\"Double\"" \"quotes\"
\n\'Single\' "'quote'" "\'test\'"
\nmail\@example.com
\nUnicode: \u00A9
\n"Whitespace    Preserved"
\nWhitespace    collapsed
\n"Newlines

preserved"
\nNewlines\n\nPreserved
\nNewlines

collapsed
</string>

strings (APKEditor decompilation output)

  <string name="test_string">Android escape and quotation test 
Tab	ulated 1 
Tab	ulated 2 
Tab	ulated 3 
Tab ulated 4 
Backslash (\) () 
Question? 
"Double" "quotes" 
'Single' 'quote' 'test' 
[email protected] 
Unicode: © 
Whitespace    Preserved 
Whitespace collapsed 
Newlines

preserved 
Newlines

Preserved 
Newlines collapsed </string>
</resources>

strings (APKEditor decompilation output manually edited to escape single quotes)

  <string name="test_string">Android escape and quotation test 
Tab	ulated 1 
Tab	ulated 2 
Tab	ulated 3 
Tab ulated 4 
Backslash (\) () 
Question? 
"Double" "quotes" 
\'Single\' \'quote\' \'test\' 
[email protected] 
Unicode: © 
Whitespace    Preserved 
Whitespace collapsed 
Newlines

preserved 
Newlines

Preserved 
Newlines collapsed </string>
</resources>

strings (apktool decompilation output)

    <string name="test_string">"Android escape and quotation test 
Tab\u0009ulated 1 
Tab\u0009ulated 2 
Tab\u0009ulated 3 
Tab ulated 4 
Backslash (\\) () 
Question? 
\"Double\" \"quotes\" 
'Single' 'quote' 'test' 
[email protected] 
Unicode: © 
Whitespace    Preserved 
Whitespace collapsed 
Newlines

preserved 
Newlines

Preserved 
Newlines collapsed "</string>

Attached images

strings (original) built with android studio

image

strings (original) built with APKEditor

image

strings (apktool decompilation output) built with android studio

image

strings (APKEditor decompilation output manually edited to escape single quotes) built with android studio

image

主要语言
Java
星标
2.3k
派生
417
PR 合并指标
30 天内没有已合并 PR

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

REAndroid/APKEditor 的其他 Issue

查看 REAndroid/APKEditor 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。