fix: allow occ maintenance:update:htaccess to create .htaccess file in case it doesn't exist yet

[lpcvoid]

Currently, the updateHtaccess() function can't deal with a missing .htaccess file, it assumes at least an empty .htaccess file.

In some cases, the file may be missing though, and this PR adds functionality for creating it when this edgecase occurs.

Before this PR, executing occ maintenance:update:htaccess can fail without the error message being explicit about this edgecase.

• Resolves: # Many issues that complain about occ maintenance:update:htaccess not working.

Summary

occ maintenance:update:htaccess can now also create .htaccess files, instead of relying on them being present.

TODO

• Nothing I can think of

Checklist

• Code is properly formatted
• Sign-off message is added to all commits
• Tests (unit, integration, api and/or acceptance) are included
• Screenshots before/after for front-end changes
• Documentation (manuals or wiki) has been updated or is not required
• Backports requested where applicable (ex: critical bugfixes)
• Labels added where applicable (ex: bug/enhancement, 3. to review, feature component)
• Milestone added for target branch/version (ex: 32.x for stable32)

[szaimen]

I am not sure about this. The file needs to exist beforehand otherwise it might misses the important default config: https://github.com/nextcloud/server/blob/master/.htaccess

[lpcvoid]

I had a situation where I copied over a directory using cp * ../ -R. This doesn't copy dotfiles, which I forgot because I am stupid. Then I was wondering why this command doesn't work, and the error message was not helpful at all. It took me a bit to figure it out.

I am not aware of many of the potential side issues this may cause, but when I tested this locally, it fixed my problem. I also think it's better to have a .htaccess file with some content vs one without any.

It's up to you to do with this what you think is best, of course.

[szaimen]

I had a situation where I copied over a directory using cp * ../ -R. This doesn't copy dotfiles, which I forgot because I am stupid. Then I was wondering why this command doesn't work, and the error message was not helpful at all. It took me a bit to figure it out.

I am not aware of many of the potential side issues this may cause, but when I tested this locally, it fixed my problem. I also think it's better to have a .htaccess file with some content vs one without any.

It's up to you to do with this what you think is best, of course.

In my opinion the command should fail if the file does not exist but maybe we could improve the error message?

[lpcvoid]

That's probably a good idea in any case, yeah :) Shall I remove the commit which adds the creation, and keep the single commit which changes the error message?

[szaimen]

That's probably a good idea in any case, yeah :) Shall I remove the commit which adds the creation, and keep the single commit which changes the error message?

Sounds good to me, yes :)

[github-actions]

Hello there,
Thank you so much for taking the time and effort to create a pull request to our Nextcloud project.

We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process.

Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6

Thank you for contributing to Nextcloud and we hope to hear from you soon!

(If you believe you should not receive this message, you can add yourself to the blocklist.)

Reason explained

[provokateurin]

@lpcvoid you need to run composer cs:fix.

[lpcvoid]

Hey @provokateurin - sorry for my late response. I have manually edited my commit to fix the linter errors, they should pass now. I have squashed the fix commit and force pushed.

[provokateurin]

TBH I'd rather see the instance not allowing any interaction if the file is missing, because it means that your setup is borked and other things could be broken as well.

[lpcvoid]

That's what happened in my case anyhow (I wasn't able to access NC). It was fixable though by re-wrtiting the htaccess file via touch first, and then re-writing the rules via occ maintenence:update:htaccess. All this PR wants to do is add one more "fix" step into the htaccess generation for an edgecase I encountered.

At the very least I'd love to simply change the error message as indicated in the second commit, since that would have saved me a whole lot of debugging :)