[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-frameworks-devel
Subject:    D24489: KAutosaveFile not respecting maximum filename length
From:       David Faure <noreply () phabricator ! kde ! org>
Date:       2019-12-05 22:45:33
Message-ID: e154e1ad85fc7e52020dbbdfb686fe5a () localhost ! localdomain
[Download RAW message or body]

[Attachment #2 (text/plain)]

dfaure requested changes to this revision.
dfaure added a comment.
This revision now requires changes to proceed.


  Why is this not in the same commit as the related unittest, as is common practice?

INLINE COMMENTS

> kautosavefile.cpp:70
> const QString protocol(managedFile.scheme());
> -    const QString path(managedFile.adjusted(QUrl::RemoveFilename | \
>                 QUrl::StripTrailingSlash).path());
> -    QString name(managedFile.fileName());
> +    const QString \
> path(QString::fromLatin1(QUrl::toPercentEncoding(managedFile.adjusted(QUrl::RemoveFilename \
> | QUrl::StripTrailingSlash).path()).constData())); +    QString \
> name(QString::fromLatin1(QUrl::toPercentEncoding(managedFile.fileName()).constData()));
> 

That's one long line, hard to read. Extract a `const QByteArray encodedPath = \
QUrl::toPercentEncoding(....)` ?

[pre-existing: I would personally call this `QByteArray encodedDirectory` and \
`QString directory`, to my eyes path is a full path including filename. At least it's \
ambiguous, unlike directory]

Also check if you can remove the .constData(). `QString::fromLatin1(const QByteArray \
&str)` was added in Qt 5.0, this code is probably older than that.

> kautosavefile.cpp:71
> +    const QString \
> path(QString::fromLatin1(QUrl::toPercentEncoding(managedFile.adjusted(QUrl::RemoveFilename \
> | QUrl::StripTrailingSlash).path()).constData())); +    QString \
> name(QString::fromLatin1(QUrl::toPercentEncoding(managedFile.fileName()).constData()));
>  

and a `const QByteArray encodedFileName = ...`, for symmetry.

Simpler than toPercentEncoding: use `QUrl::fileName(QUrl::FullyEncoded)`.
However this wouldn't work for `encodedDirectory` above, because it wouldn't encode \
'/'.

> kautosavefile.cpp:76
> // Subtract 1 for the _ char, 3 for the padding separator, 5 is for the .lock
> -    int pathLengthLimit = FILENAME_MAX - NamePadding - name.size() - \
> protocol.size() - 9; +    int pathLengthLimit = NAME_MAX - NamePadding - \
> name.size() - protocol.size() - 9; 

(while changing this line: prepend `const`)

REPOSITORY
  R244 KCoreAddons

REVISION DETAIL
  https://phabricator.kde.org/D24489

To: mardelle, #frameworks, dfaure, mpyne
Cc: ahmadsamir, kde-frameworks-devel, LeGast00n, GB_2, michaelh, ngraham, bruns


[Attachment #3 (text/html)]

<table><tr><td style="">dfaure requested changes to this revision.<br />dfaure added \
a comment.<br />This revision now requires changes to proceed. </td><a \
style="text-decoration: none; padding: 4px 8px; margin: 0 8px 8px; float: right; \
color: #464C5C; font-weight: bold; border-radius: 3px; background-color: #F7F7F9; \
background-image: linear-gradient(to bottom,#fff,#f1f0f1); display: inline-block; \
border: 1px solid rgba(71,87,120,.2);" href="https://phabricator.kde.org/D24489">View \
Revision</a></tr></table><br /><div><div><p>Why is this not in the same commit as the \
related unittest, as is common practice?</p></div></div><br /><div><strong>INLINE \
COMMENTS</strong><div><div style="margin: 6px 0 12px 0;"><div style="border: 1px \
solid #C7CCD9; border-radius: 3px;"><div style="padding: 0; background: #F7F7F7; \
border-color: #e3e4e8; border-style: solid; border-width: 0 0 1px 0; margin: 0;"><div \
style="color: #74777d; background: #eff2f4; padding: 6px 8px; overflow: hidden;"><a \
style="float: right; text-decoration: none;" \
href="https://phabricator.kde.org/D24489#inline-145312">View Inline</a><span \
style="color: #4b4d51; font-weight: bold;">kautosavefile.cpp:70</span></div> <div \
style="font: 11px/15px &quot;Menlo&quot;, &quot;Consolas&quot;, &quot;Monaco&quot;, \
monospace; white-space: pre-wrap; clear: both; padding: 4px 0; margin: 0;"><div \
style="padding: 0 8px; margin: 0 4px; ">    <span style="color: #aa4000">const</span> \
<span class="n">QString</span> <span class="n">protocol</span><span \
class="p">(</span><span class="n">managedFile</span><span class="p">.</span><span \
class="n">scheme</span><span class="p">());</span> </div><div style="padding: 0 8px; \
margin: 0 4px; background: rgba(251, 175, 175, .7);">    <span style="color: \
#aa4000">const</span> <span class="n">QString</span> <span style="color: \
#004012">path</span><span class="p">(<span class="bright"></span></span><span \
class="bright"></span><span class="n"><span \
class="bright">managedFile</span></span><span class="bright"></span><span \
class="p"><span class="bright">.</span></span><span class="bright"></span><span \
class="n"><span class="bright">adjusted</span></span><span \
class="bright"></span><span class="p"><span class="bright">(</span></span><span \
class="bright"></span><span class="n"><span class="bright">QUrl</span></span><span \
class="bright"></span><span style="color: #aa2211"><span \
class="bright">::</span></span><span class="bright"></span><span class="n"><span \
class="bright">RemoveFilename</span></span><span class="bright"> </span><span \
style="color: #aa2211"><span class="bright">|</span></span><span class="bright"> \
</span><span class="n"><span class="bright">QUrl</span></span><span \
class="bright"></span><span style="color: #aa2211"><span \
class="bright">::</span></span><span class="bright"></span><span class="n"><span \
class="bright">StripTrailingSlash</span></span><span class="bright"></span><span \
class="p"><span class="bright">).</span></span><span class="bright"></span><span \
class="n"><span class="bright">path</span></span><span class="bright"></span><span \
class="p"><span class="bright">(</span>));</span> </div><div style="padding: 0 8px; \
margin: 0 4px; background: rgba(251, 175, 175, .7);">    <span \
class="n">QString</span> <span style="color: #004012">name</span><span \
class="p">(</span><span class="n">managedFile</span><span class="p">.</span><span \
class="n">fileName</span><span class="p">());</span> </div><div style="padding: 0 \
8px; margin: 0 4px; background: rgba(151, 234, 151, .6);">    <span style="color: \
#aa4000">const</span> <span class="n">QString</span> <span style="color: \
#004012">path</span><span class="p">(<span class="bright"></span></span><span \
class="bright"></span><span class="n"><span class="bright">QString</span></span><span \
class="bright"></span><span style="color: #aa2211"><span \
class="bright">::</span></span><span class="bright"></span><span class="n"><span \
class="bright">fromLatin1</span></span><span class="bright"></span><span \
class="p"><span class="bright">(</span></span><span class="bright"></span><span \
class="n"><span class="bright">QUrl</span></span><span class="bright"></span><span \
style="color: #aa2211"><span class="bright">::</span></span><span \
class="bright"></span><span class="n"><span \
class="bright">toPercentEncoding</span></span><span class="bright"></span><span \
class="p"><span class="bright">(</span></span><span class="bright"></span><span \
class="n"><span class="bright">managedFile</span></span><span \
class="bright"></span><span class="p"><span class="bright">.</span></span><span \
class="bright"></span><span class="n"><span \
class="bright">adjusted</span></span><span class="bright"></span><span \
class="p"><span class="bright">(</span></span><span class="bright"></span><span \
class="n"><span class="bright">QUrl</span></span><span class="bright"></span><span \
style="color: #aa2211"><span class="bright">::</span></span><span \
class="bright"></span><span class="n"><span \
class="bright">RemoveFilename</span></span><span class="bright"> </span><span \
style="color: #aa2211"><span class="bright">|</span></span><span class="bright"> \
</span><span class="n"><span class="bright">QUrl</span></span><span \
class="bright"></span><span style="color: #aa2211"><span \
class="bright">::</span></span><span class="bright"></span><span class="n"><span \
class="bright">StripTrailingSlash</span></span><span class="bright"></span><span \
class="p"><span class="bright">).</span></span><span class="bright"></span><span \
class="n"><span class="bright">path</span></span><span class="bright"></span><span \
class="p"><span class="bright">()).</span></span><span class="bright"></span><span \
class="n"><span class="bright">constData</span></span><span \
class="bright"></span><span class="p"><span class="bright">()</span>));</span> \
</div><div style="padding: 0 8px; margin: 0 4px; background: rgba(151, 234, 151, \
.6);">    <span class="n">QString</span> <span style="color: \
#004012">name</span><span class="p">(<span class="bright"></span></span><span \
class="bright"></span><span class="n"><span class="bright">QString</span></span><span \
class="bright"></span><span style="color: #aa2211"><span \
class="bright">::</span></span><span class="bright"></span><span class="n"><span \
class="bright">fromLatin1</span></span><span class="bright"></span><span \
class="p"><span class="bright">(</span></span><span class="bright"></span><span \
class="n"><span class="bright">QUrl</span></span><span class="bright"></span><span \
style="color: #aa2211"><span class="bright">::</span></span><span \
class="bright"></span><span class="n"><span \
class="bright">toPercentEncoding</span></span><span class="bright"></span><span \
class="p"><span class="bright">(</span></span><span class="n">managedFile</span><span \
class="p">.</span><span class="n">fileName</span><span class="p">(<span \
class="bright">)).</span></span><span class="bright"></span><span class="n"><span \
class="bright">constData</span></span><span class="bright"></span><span \
class="p"><span class="bright">()</span>));</span> </div></div></div>
<div style="margin: 8px 0; padding: 0 12px;"><p style="padding: 0; margin: \
8px;">That&#039;s one long line, hard to read. Extract a <tt style="background: \
#ebebeb; font-size: 13px;">const QByteArray encodedPath = \
QUrl::toPercentEncoding(....)</tt> ?</p>

<p style="padding: 0; margin: 8px;">[pre-existing: I would personally call this <tt \
style="background: #ebebeb; font-size: 13px;">QByteArray encodedDirectory</tt> and \
<tt style="background: #ebebeb; font-size: 13px;">QString directory</tt>, to my eyes \
path is a full path including filename. At least it&#039;s ambiguous, unlike \
directory]</p>

<p style="padding: 0; margin: 8px;">Also check if you can remove the .constData(). \
<tt style="background: #ebebeb; font-size: 13px;">QString::fromLatin1(const \
QByteArray &amp;str)</tt> was added in Qt 5.0, this code is probably older than \
that.</p></div></div><br /><div style="border: 1px solid #C7CCD9; border-radius: \
3px;"><div style="padding: 0; background: #F7F7F7; border-color: #e3e4e8; \
border-style: solid; border-width: 0 0 1px 0; margin: 0;"><div style="color: #74777d; \
background: #eff2f4; padding: 6px 8px; overflow: hidden;"><a style="float: right; \
text-decoration: none;" href="https://phabricator.kde.org/D24489#inline-145314">View \
Inline</a><span style="color: #4b4d51; font-weight: \
bold;">kautosavefile.cpp:71</span></div> <div style="font: 11px/15px \
&quot;Menlo&quot;, &quot;Consolas&quot;, &quot;Monaco&quot;, monospace; white-space: \
pre-wrap; clear: both; padding: 4px 0; margin: 0;"><div style="padding: 0 8px; \
margin: 0 4px; background: rgba(251, 175, 175, .7);">    <span style="color: \
#aa4000">const</span> <span class="n">QString</span> <span style="color: \
#004012">path</span><span class="p">(<span class="bright"></span></span><span \
class="bright"></span><span class="n"><span \
class="bright">managedFile</span></span><span class="bright"></span><span \
class="p"><span class="bright">.</span></span><span class="bright"></span><span \
class="n"><span class="bright">adjusted</span></span><span \
class="bright"></span><span class="p"><span class="bright">(</span></span><span \
class="bright"></span><span class="n"><span class="bright">QUrl</span></span><span \
class="bright"></span><span style="color: #aa2211"><span \
class="bright">::</span></span><span class="bright"></span><span class="n"><span \
class="bright">RemoveFilename</span></span><span class="bright"> </span><span \
style="color: #aa2211"><span class="bright">|</span></span><span class="bright"> \
</span><span class="n"><span class="bright">QUrl</span></span><span \
class="bright"></span><span style="color: #aa2211"><span \
class="bright">::</span></span><span class="bright"></span><span class="n"><span \
class="bright">StripTrailingSlash</span></span><span class="bright"></span><span \
class="p"><span class="bright">).</span></span><span class="bright"></span><span \
class="n"><span class="bright">path</span></span><span class="bright"></span><span \
class="p"><span class="bright">(</span>));</span> </div><div style="padding: 0 8px; \
margin: 0 4px; background: rgba(251, 175, 175, .7);">    <span \
class="n">QString</span> <span style="color: #004012">name</span><span \
class="p">(</span><span class="n">managedFile</span><span class="p">.</span><span \
class="n">fileName</span><span class="p">());</span> </div><div style="padding: 0 \
8px; margin: 0 4px; background: rgba(151, 234, 151, .6);">    <span style="color: \
#aa4000">const</span> <span class="n">QString</span> <span style="color: \
#004012">path</span><span class="p">(<span class="bright"></span></span><span \
class="bright"></span><span class="n"><span class="bright">QString</span></span><span \
class="bright"></span><span style="color: #aa2211"><span \
class="bright">::</span></span><span class="bright"></span><span class="n"><span \
class="bright">fromLatin1</span></span><span class="bright"></span><span \
class="p"><span class="bright">(</span></span><span class="bright"></span><span \
class="n"><span class="bright">QUrl</span></span><span class="bright"></span><span \
style="color: #aa2211"><span class="bright">::</span></span><span \
class="bright"></span><span class="n"><span \
class="bright">toPercentEncoding</span></span><span class="bright"></span><span \
class="p"><span class="bright">(</span></span><span class="bright"></span><span \
class="n"><span class="bright">managedFile</span></span><span \
class="bright"></span><span class="p"><span class="bright">.</span></span><span \
class="bright"></span><span class="n"><span \
class="bright">adjusted</span></span><span class="bright"></span><span \
class="p"><span class="bright">(</span></span><span class="bright"></span><span \
class="n"><span class="bright">QUrl</span></span><span class="bright"></span><span \
style="color: #aa2211"><span class="bright">::</span></span><span \
class="bright"></span><span class="n"><span \
class="bright">RemoveFilename</span></span><span class="bright"> </span><span \
style="color: #aa2211"><span class="bright">|</span></span><span class="bright"> \
</span><span class="n"><span class="bright">QUrl</span></span><span \
class="bright"></span><span style="color: #aa2211"><span \
class="bright">::</span></span><span class="bright"></span><span class="n"><span \
class="bright">StripTrailingSlash</span></span><span class="bright"></span><span \
class="p"><span class="bright">).</span></span><span class="bright"></span><span \
class="n"><span class="bright">path</span></span><span class="bright"></span><span \
class="p"><span class="bright">()).</span></span><span class="bright"></span><span \
class="n"><span class="bright">constData</span></span><span \
class="bright"></span><span class="p"><span class="bright">()</span>));</span> \
</div><div style="padding: 0 8px; margin: 0 4px; background: rgba(151, 234, 151, \
.6);">    <span class="n">QString</span> <span style="color: \
#004012">name</span><span class="p">(<span class="bright"></span></span><span \
class="bright"></span><span class="n"><span class="bright">QString</span></span><span \
class="bright"></span><span style="color: #aa2211"><span \
class="bright">::</span></span><span class="bright"></span><span class="n"><span \
class="bright">fromLatin1</span></span><span class="bright"></span><span \
class="p"><span class="bright">(</span></span><span class="bright"></span><span \
class="n"><span class="bright">QUrl</span></span><span class="bright"></span><span \
style="color: #aa2211"><span class="bright">::</span></span><span \
class="bright"></span><span class="n"><span \
class="bright">toPercentEncoding</span></span><span class="bright"></span><span \
class="p"><span class="bright">(</span></span><span class="n">managedFile</span><span \
class="p">.</span><span class="n">fileName</span><span class="p">(<span \
class="bright">)).</span></span><span class="bright"></span><span class="n"><span \
class="bright">constData</span></span><span class="bright"></span><span \
class="p"><span class="bright">()</span>));</span> </div></div></div>
<div style="margin: 8px 0; padding: 0 12px;"><p style="padding: 0; margin: 8px;">and \
a <tt style="background: #ebebeb; font-size: 13px;">const QByteArray encodedFileName \
= ...</tt>, for symmetry.</p>

<p style="padding: 0; margin: 8px;">Simpler than toPercentEncoding: use <tt \
style="background: #ebebeb; font-size: \
13px;">QUrl::fileName(QUrl::FullyEncoded)</tt>.<br /> However this wouldn&#039;t work \
for <tt style="background: #ebebeb; font-size: 13px;">encodedDirectory</tt> above, \
because it wouldn&#039;t encode &#039;/&#039;.</p></div></div><br /><div \
style="border: 1px solid #C7CCD9; border-radius: 3px;"><div style="padding: 0; \
background: #F7F7F7; border-color: #e3e4e8; border-style: solid; border-width: 0 0 \
1px 0; margin: 0;"><div style="color: #74777d; background: #eff2f4; padding: 6px 8px; \
overflow: hidden;"><a style="float: right; text-decoration: none;" \
href="https://phabricator.kde.org/D24489#inline-145315">View Inline</a><span \
style="color: #4b4d51; font-weight: bold;">kautosavefile.cpp:76</span></div> <div \
style="font: 11px/15px &quot;Menlo&quot;, &quot;Consolas&quot;, &quot;Monaco&quot;, \
monospace; white-space: pre-wrap; clear: both; padding: 4px 0; margin: 0;"><div \
style="padding: 0 8px; margin: 0 4px; ">    <span style="color: #74777d">// Subtract \
1 for the _ char, 3 for the padding separator, 5 is for the .lock</span> </div><div \
style="padding: 0 8px; margin: 0 4px; background: rgba(251, 175, 175, .7);">    <span \
style="color: #aa4000">int</span> <span class="n">pathLengthLimit</span> <span \
style="color: #aa2211">=</span> <span class="bright"></span><span class="n"><span \
class="bright">FILE</span>NAME_MAX</span> <span style="color: #aa2211">-</span> <span \
class="n">NamePadding</span> <span style="color: #aa2211">-</span> <span \
class="n">name</span><span class="p">.</span><span class="n">size</span><span \
class="p">()</span> <span style="color: #aa2211">-</span> <span \
class="n">protocol</span><span class="p">.</span><span class="n">size</span><span \
class="p">()</span> <span style="color: #aa2211">-</span> <span style="color: \
#601200">9</span><span class="p">;</span> </div><div style="padding: 0 8px; margin: 0 \
4px; background: rgba(151, 234, 151, .6);">    <span style="color: \
#aa4000">int</span> <span class="n">pathLengthLimit</span> <span style="color: \
#aa2211">=</span> <span class="n">NAME_MAX</span> <span style="color: \
#aa2211">-</span> <span class="n">NamePadding</span> <span style="color: \
#aa2211">-</span> <span class="n">name</span><span class="p">.</span><span \
class="n">size</span><span class="p">()</span> <span style="color: #aa2211">-</span> \
<span class="n">protocol</span><span class="p">.</span><span \
class="n">size</span><span class="p">()</span> <span style="color: #aa2211">-</span> \
<span style="color: #601200">9</span><span class="p">;</span> </div></div></div>
<div style="margin: 8px 0; padding: 0 12px;"><p style="padding: 0; margin: \
8px;">(while changing this line: prepend <tt style="background: #ebebeb; font-size: \
13px;">const</tt>)</p></div></div></div></div></div><br \
/><div><strong>REPOSITORY</strong><div><div>R244 KCoreAddons</div></div></div><br \
/><div><strong>REVISION DETAIL</strong><div><a \
href="https://phabricator.kde.org/D24489">https://phabricator.kde.org/D24489</a></div></div><br \
/><div><strong>To: </strong>mardelle, Frameworks, dfaure, mpyne<br /><strong>Cc: \
</strong>ahmadsamir, kde-frameworks-devel, LeGast00n, GB_2, michaelh, ngraham, \
bruns<br /></div>



[prev in list] [next in list] [prev in thread] [next in thread]