Added support for transferring incoming file shares.

[ipasanec]

Fix#21856

@PVince81

• new option --transfer-incoming-shares=1 | 0
• new config.php option 'transfer-incoming-shares' => true | false'transferIncomingShares' => true | false

The command line option overrules the config.php option.

[PVince81]

Had a deeper look at the logic and added some comments

[PVince81]

• BUG: must not transfer incoming share if not in the requested path:

  • user2 shares "test" with user1
  • user1 creates dir "sub"
  • occ files:transfer-ownership user1 user2 --path=sub -vvv --transfer-incoming-shares=1
  • expected: "test" stays
  • actual: "test" was transferred even though it was not in "sub"

• BUG: transferred incoming share doesn't stay in folder

  • user2 shares "test" with user1
  • user1 creates dir "sub"
  • user1 moves "test" into "sub"
  • occ files:transfer-ownership user1 user2 --path=sub -vvv --transfer-incoming-shares=1
  • expected: "test" is inside "sub" for user2
  • actual: "test" is outside of "sub" and even outside the transferred folder

[PVince81]

Thanks for the changes so far.
I had a few more comments after doing some tests.

See test results above.
I also took the liberty to push an integration test to your branch for the reported cases 😄

[ipasanec]

Originally the customer only required the share transferring to the users root directory,
I now added the behaviour to take in account the original share path and path restriction.

[PVince81]

@ipasanec I have rebased the PR. You might need to delete your local branch and check it out again.

I've also pushed a fix for the path matching, but for some reason the new integration test fails and I'm trying to debug it.

[PVince81]

@ipasanec seems we had a collision and pushed something at the same time

I've resolved the conflicts.

I think for now it looks good, I'll check why the integration test isn't passing despite representing the scenarios I manually tested.

[PVince81]

I've fixed the tests, there was a regexp mismatch and I used the wrong wording.
They should pass now.

[PVince81]

👍 I hereby approve the code from @ipasanec

second reviewer should also check my commits

[PVince81]

I've rebased and squashed to reduce the number of commits and remove the merge commits.

Done

[welcome]

Thanks for your first pull request and welcome to the community! Feel free to keep them coming! If you are looking for issues to tackle then have a look at this selection: https://github.com/nextcloud/server/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22

[PVince81]

/backport to stable22

[solracsf]

Shouldn't be this documented too? 🤔

[PVince81]

I'll take care:

• update admin_docs for occ command + backport to stable22: Add option for incoming shares for transfer ownership documentation#7134
• add new setting in config.sample.php + backport to stable22: TODO: Add config.php option for transfer ownership #28847

[PVince81]

docs done!

[Vilasamuni]

I've been looking for documentation about how to use this flag and it's not clear to me what the values mean. I've seen --transfer-incoming-shares=1 and --transfer-incoming-shares=2 but I haven't found any explanation of what 1 and 2 actually do.

I've got backups, but I'm wary about running commands on real-world data with flags that I don't understand.

Short term request: please explain to me what they do.
Medium term suggestion: update the documentation to make this clearer.

[ChristophWurst]

Short term request: please explain to me what they do.

https://github.com/nextcloud/server/pull/28118/files#diff-e299680f9e139f82c630e100e9a4750851e51598a493f185ce8fc7baf2544ea3R127-R147

Medium term suggestion: update the documentation to make this clearer.

Please open a ticket at https://github.com/nextcloud/documentation/issues/new

For any further questions please use https://help.nextcloud.com/c/support/7. Github is not a support forum.

[ipasanec]

The basic usage is:
--transfer-incoming-shares=1 for transferring incoming shares explicitly and 0 for not transferring them explicitly.
This command line option overwrites the value of 'transferIncomingShares' in the config.php if set.
If nothing is set, neither in command line nor in config.php, incoming shares are not transferred.

The default value of '2' for an unset option is necessary to detect a missing value in the command line and give an error message to notify the user.
The only valid values for --transfer-incoming-shares are 0 or 1.

btw. there is no --include-incoming-shares option. (It was changed in the original project, hence some variables use 'include' in the name)