utils and libraries: Replace deprecated Boost Filesystem functions #15880

hebasto · 2019-04-23T18:26:22Z

Boost Filesystem basename() and extension() functions are deprecated since v1.36.0.

See more: https://lists.boost.org/Archives/boost/2010/01/160905.php

Also this PR prevents further use of deprecated Boost Filesystem functions.
Ref: https://www.boost.org/doc/libs/1_64_0/libs/filesystem/doc/index.htm#Coding-guidelines

Note: On my Linux system Boost 1.65.1 header /usr/include/boost/filesystem/convenience.hpp contains:

# ifndef BOOST_FILESYSTEM_NO_DEPRECATED

    inline std::string extension(const path & p)
    {
      return p.extension().string();
    }

    inline std::string basename(const path & p)
    {
      return p.stem().string();
    }

    inline path change_extension( const path & p, const path & new_extension )
    { 
      path new_p( p );
      new_p.replace_extension( new_extension );
      return new_p;
    }

# endif

UPDATE:
Also removed unused code as noted by ryanofsky.

src/wallet/db.cpp

ryanofsky

utACK 8823a11

src/wallet/db.cpp

hebasto · 2019-04-29T18:53:12Z

@ryanofsky
Thank you for your review. Your comment has been addressed.
Would you mind re-reviewing?

ryanofsky

utACK 276a674. Only change is replacing impossible to reach condition with an assert.

promag

utACK 276a674.

Shouldn't 3edc716 be after 276a674?

promag · 2019-04-29T21:18:48Z

src/wallet/db.cpp

-        errorStr = strprintf(_("Wallet %s resides outside wallet directory %s"), walletFile, walletDir.string());
-        return false;
-    }
+    assert(walletFile == fs::path(walletFile).filename().string());


Suggestion, either drop the assertion (GetWalletEnv always returns a plain filename) or make it complete because:

std::cout << path("/").filename(); // outputs "/" std::cout << path(".").filename(); // outputs "." std::cout << path("..").filename(); // outputs ".."

so for these cases the assertion passes.

SplitWalletPath() garanties the walletFile is a plain filename without a directory.

hebasto · 2019-04-29T21:58:37Z

@promag thank you for your review.

Your comments have been addressed:

the assertion has been dropped
commits have been rearranged

promag · 2019-04-29T22:45:26Z

utACK 8d0add4.

Empact · 2019-04-30T06:35:28Z

utACK 8d0add4 could squash the latter two

The test was introduced in #7691 fyi, seems fine to remove.

Boost Filesystem basename() function is deprecated since v1.36.0. Also, defining BOOST_FILESYSTEM_NO_DEPRECATED before including filesystem headers is strongly recommended. This prevents inadvertent use of old features, particularly legacy function names, that have been replaced and are going to go away in the future.

hebasto · 2019-04-30T07:11:38Z

@Empact

utACK 8d0add4 could squash the latter two

Done.

The test was introduced in #7691 fyi, seems fine to remove.

I guess it was earlier in #1889 ;)

Empact · 2019-04-30T07:43:00Z

utACK a0a222e

I guess it was earlier in #1889 ;)

Indeed! :P

ryanofsky

utACK a0a222e. Only change is dropping assert and squashing first two commits.

practicalswift · 2019-05-07T16:28:19Z

utACK a0a222e

fanquake · 2019-05-08T00:57:18Z

utACK a0a222e

meshcollider · 2019-05-08T12:01:47Z

utACK a0a222e

…m functions a0a222e Replace deprecated Boost Filesystem function (Hennadii Stepanov) 4f65af9 Remove dead code for walletFile check (Hennadii Stepanov) Pull request description: Boost Filesystem `basename()` and `extension()` functions are [deprecated since v1.36.0](https://www.boost.org/doc/libs/1_36_0/libs/filesystem/doc/reference.html#Convenience-functions). See more: https://lists.boost.org/Archives/boost/2010/01/160905.php Also this PR prevents further use of deprecated Boost Filesystem functions. Ref: https://www.boost.org/doc/libs/1_64_0/libs/filesystem/doc/index.htm#Coding-guidelines Note: On my Linux system Boost 1.65.1 header `/usr/include/boost/filesystem/convenience.hpp` contains: ```c++ # ifndef BOOST_FILESYSTEM_NO_DEPRECATED inline std::string extension(const path & p) { return p.extension().string(); } inline std::string basename(const path & p) { return p.stem().string(); } inline path change_extension( const path & p, const path & new_extension ) { path new_p( p ); new_p.replace_extension( new_extension ); return new_p; } # endif ``` UPDATE: Also removed unused code as [noted](#15880 (comment)) by **ryanofsky**. ACKs for commit a0a222: Empact: utACK a0a222e practicalswift: utACK a0a222e fanquake: utACK a0a222e ryanofsky: utACK a0a222e. Only change is dropping assert and squashing first two commits. Tree-SHA512: bc54355441c49957507eb8d3a5782b92d65674504d69779bc16b1b997b2e7424d5665eb6bfb6e10b430a6cacd2aca70af2f94e5f7f10bea24624202834ad35c7

…lesystem functions a0a222e Replace deprecated Boost Filesystem function (Hennadii Stepanov) 4f65af9 Remove dead code for walletFile check (Hennadii Stepanov) Pull request description: Boost Filesystem `basename()` and `extension()` functions are [deprecated since v1.36.0](https://www.boost.org/doc/libs/1_36_0/libs/filesystem/doc/reference.html#Convenience-functions). See more: https://lists.boost.org/Archives/boost/2010/01/160905.php Also this PR prevents further use of deprecated Boost Filesystem functions. Ref: https://www.boost.org/doc/libs/1_64_0/libs/filesystem/doc/index.htm#Coding-guidelines Note: On my Linux system Boost 1.65.1 header `/usr/include/boost/filesystem/convenience.hpp` contains: ```c++ # ifndef BOOST_FILESYSTEM_NO_DEPRECATED inline std::string extension(const path & p) { return p.extension().string(); } inline std::string basename(const path & p) { return p.stem().string(); } inline path change_extension( const path & p, const path & new_extension ) { path new_p( p ); new_p.replace_extension( new_extension ); return new_p; } # endif ``` UPDATE: Also removed unused code as [noted](bitcoin#15880 (comment)) by **ryanofsky**. ACKs for commit a0a222: Empact: utACK bitcoin@a0a222e practicalswift: utACK a0a222e fanquake: utACK a0a222e ryanofsky: utACK a0a222e. Only change is dropping assert and squashing first two commits. Tree-SHA512: bc54355441c49957507eb8d3a5782b92d65674504d69779bc16b1b997b2e7424d5665eb6bfb6e10b430a6cacd2aca70af2f94e5f7f10bea24624202834ad35c7

…stem functions Summary: Replace deprecated Boost Filesystem function (Hennadii Stepanov) Remove dead code for walletFile check (Hennadii Stepanov) Pull request description: Boost Filesystem `basename()` and `extension()` functions are [deprecated since v1.36.0](https://www.boost.org/doc/libs/1_36_0/libs/filesystem/doc/reference.html#Convenience-functions). See more: https://lists.boost.org/Archives/boost/2010/01/160905.php Also this PR prevents further use of deprecated Boost Filesystem functions. Ref: https://www.boost.org/doc/libs/1_64_0/libs/filesystem/doc/index.htm#Coding-guidelines Note: On my Linux system Boost 1.65.1 header `/usr/include/boost/filesystem/convenience.hpp` contains: ```c++ # ifndef BOOST_FILESYSTEM_NO_DEPRECATED inline std::string extension(const path & p) { return p.extension().string(); } inline std::string basename(const path & p) { return p.stem().string(); } inline path change_extension( const path & p, const path & new_extension ) { path new_p( p ); new_p.replace_extension( new_extension ); return new_p; } # endif ``` UPDATE: Also removed unused code as [noted](bitcoin/bitcoin#15880 (comment)) by **ryanofsky**. --- Backport of Core [[bitcoin/bitcoin#15880 | PR15880]] and [[bitcoin/bitcoin#17654 | PR17654]] (to unbreak PR15880) Test Plan: ninja check check-functional Reviewers: #bitcoin_abc, Fabien Reviewed By: #bitcoin_abc, Fabien Differential Revision: https://reviews.bitcoinabc.org/D7362

…lesystem functions a0a222e Replace deprecated Boost Filesystem function (Hennadii Stepanov) 4f65af9 Remove dead code for walletFile check (Hennadii Stepanov) Pull request description: Boost Filesystem `basename()` and `extension()` functions are [deprecated since v1.36.0](https://www.boost.org/doc/libs/1_36_0/libs/filesystem/doc/reference.html#Convenience-functions). See more: https://lists.boost.org/Archives/boost/2010/01/160905.php Also this PR prevents further use of deprecated Boost Filesystem functions. Ref: https://www.boost.org/doc/libs/1_64_0/libs/filesystem/doc/index.htm#Coding-guidelines Note: On my Linux system Boost 1.65.1 header `/usr/include/boost/filesystem/convenience.hpp` contains: ```c++ # ifndef BOOST_FILESYSTEM_NO_DEPRECATED inline std::string extension(const path & p) { return p.extension().string(); } inline std::string basename(const path & p) { return p.stem().string(); } inline path change_extension( const path & p, const path & new_extension ) { path new_p( p ); new_p.replace_extension( new_extension ); return new_p; } # endif ``` UPDATE: Also removed unused code as [noted](bitcoin#15880 (comment)) by **ryanofsky**. ACKs for commit a0a222: Empact: utACK bitcoin@a0a222e practicalswift: utACK a0a222e fanquake: utACK a0a222e ryanofsky: utACK a0a222e. Only change is dropping assert and squashing first two commits. Tree-SHA512: bc54355441c49957507eb8d3a5782b92d65674504d69779bc16b1b997b2e7424d5665eb6bfb6e10b430a6cacd2aca70af2f94e5f7f10bea24624202834ad35c7

DrahtBot added UTXO Db and Indexes Wallet labels Apr 23, 2019

Empact reviewed Apr 28, 2019

View reviewed changes

src/wallet/db.cpp Outdated Show resolved Hide resolved

hebasto force-pushed the 20190423-boost-coding-guidelines branch from e5ce5a1 to 8823a11 Compare April 29, 2019 08:56

ryanofsky approved these changes Apr 29, 2019

View reviewed changes

src/wallet/db.cpp Outdated Show resolved Hide resolved

hebasto force-pushed the 20190423-boost-coding-guidelines branch from 8823a11 to 276a674 Compare April 29, 2019 18:49

ryanofsky approved these changes Apr 29, 2019

View reviewed changes

promag reviewed Apr 29, 2019

View reviewed changes

Remove dead code for walletFile check

4f65af9

SplitWalletPath() garanties the walletFile is a plain filename without a directory.

hebasto force-pushed the 20190423-boost-coding-guidelines branch from 276a674 to 8d0add4 Compare April 29, 2019 21:55

hebasto force-pushed the 20190423-boost-coding-guidelines branch from 8d0add4 to a0a222e Compare April 30, 2019 07:07

ryanofsky approved these changes May 7, 2019

View reviewed changes

meshcollider merged commit a0a222e into bitcoin:master May 8, 2019

hebasto deleted the 20190423-boost-coding-guidelines branch May 9, 2019 07:13

str4d mentioned this pull request Dec 6, 2021

Backport changes to src/fs.{cpp,h} zcash/zcash#5406

Open

bitcoin locked as resolved and limited conversation to collaborators Dec 16, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

utils and libraries: Replace deprecated Boost Filesystem functions #15880

utils and libraries: Replace deprecated Boost Filesystem functions #15880

Uh oh!

hebasto commented Apr 23, 2019 •

edited

Loading

Uh oh!

Uh oh!

ryanofsky left a comment

Uh oh!

Uh oh!

hebasto commented Apr 29, 2019

Uh oh!

ryanofsky left a comment

Uh oh!

promag left a comment

Uh oh!

promag Apr 29, 2019

Uh oh!

hebasto commented Apr 29, 2019

Uh oh!

promag commented Apr 29, 2019

Uh oh!

Empact commented Apr 30, 2019

Uh oh!

hebasto commented Apr 30, 2019

Uh oh!

Empact commented Apr 30, 2019

Uh oh!

ryanofsky left a comment

Uh oh!

practicalswift commented May 7, 2019

Uh oh!

fanquake commented May 8, 2019

Uh oh!

meshcollider commented May 8, 2019

Uh oh!

Uh oh!

utils and libraries: Replace deprecated Boost Filesystem functions #15880

utils and libraries: Replace deprecated Boost Filesystem functions #15880

Uh oh!

Conversation

hebasto commented Apr 23, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

ryanofsky left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hebasto commented Apr 29, 2019

Uh oh!

ryanofsky left a comment

Choose a reason for hiding this comment

Uh oh!

promag left a comment

Choose a reason for hiding this comment

Uh oh!

promag Apr 29, 2019

Choose a reason for hiding this comment

Uh oh!

hebasto commented Apr 29, 2019

Uh oh!

promag commented Apr 29, 2019

Uh oh!

Empact commented Apr 30, 2019

Uh oh!

hebasto commented Apr 30, 2019

Uh oh!

Empact commented Apr 30, 2019

Uh oh!

ryanofsky left a comment

Choose a reason for hiding this comment

Uh oh!

practicalswift commented May 7, 2019

Uh oh!

fanquake commented May 8, 2019

Uh oh!

meshcollider commented May 8, 2019

Uh oh!

Uh oh!

hebasto commented Apr 23, 2019 •

edited

Loading