Strip path from root #10

Open
f wants to merge 3 commits from f/twins:path-strip into master
Contributor

If there is a path (the URL path) specified under paths in the
configuration, which points to a root (a physical folder on the
filesystem), this path should not be attached to the root. This fix will
do that. It strips the path from the root.

Example configuration:

hosts:
  localhost:
    paths:
      -
        path: /a/
        root: public/aroot
      -
        path: /
        root: public
Filesystem:
+ public
  + index.gmi
  + aroot
    + index.gmi
If there is a path (the URL path) specified under paths in the configuration, which points to a root (a physical folder on the filesystem), this path should not be attached to the root. This fix will do that. It strips the path from the root. Example configuration: ``` hosts: localhost: paths: - path: /a/ root: public/aroot - path: / root: public ``` ``` Filesystem: + public + index.gmi + aroot + index.gmi ```
f added 1 commit 2021-06-03 22:05:29 +00:00
bd0555069e Strip path from root
If there is a path (the URL path) specified under paths in the
configuration, which points to a root (a physical folder on the
filesystem), this path should not be attached to the root. This fix will
do that. It strips the path from the root.

Example configuration:

hosts:
  localhost:
    paths:
      -
        path: /a
        root: public/aroot
      -
        path: /
        root: public

Filesystem:
+ public
  + index.gmi
  + aroot
    + index.gmi
Owner

Thanks. From CONFIGURATION.md:

Any path not matching a specific page, file name or file extension should end
in a trailing slash, signifying that it is a directory. Visitors are
automatically redirected when accessing a directory path without including a
trailing slash.

Paths which are folders should always be specified with a trailing slash. If you are encountering issues when specifying paths this way, please open an issue.

Thanks. From CONFIGURATION.md: ``` Any path not matching a specific page, file name or file extension should end in a trailing slash, signifying that it is a directory. Visitors are automatically redirected when accessing a directory path without including a trailing slash. ``` Paths which are folders should always be specified with a trailing slash. If you are encountering issues when specifying paths this way, please open an issue.
tslocum closed this pull request 2021-06-04 01:17:40 +00:00
Author
Contributor

I am not sure if I made my point clear. This works partially for the gemini protocol, but not for https. I double checked it with the latest HEAD and the result is the same (with and without the trailing slash). / works, all other paths result in a 404 error.

My commit bd0555069e fixes this by removing the path from the root, because it will added twice.

I am not sure if I made my point clear. This works partially for the ```gemini``` protocol, but not for ```https```. I double checked it with the latest ```HEAD``` and the result is the same (with and without the trailing slash). ```/``` works, all other paths result in a 404 error. My commit bd0555069ede209f482a524a9a18fdc9a3f35183 fixes this by removing the path from the root, because it will added twice.
f reopened this pull request 2021-06-07 21:14:23 +00:00
f added 1 commit 2021-06-07 21:21:13 +00:00
Author
Contributor

@tslocum Can you please verify this?

@tslocum Can you please verify this?
tslocum requested changes 2021-07-09 06:25:55 +00:00
tslocum left a comment
Owner

Thanks for submitting these changes. When using the following path configurations:

hosts: localhost: ... paths: - path: /sitez1 lang: en list: true root: /home/trevor/programming - path: /sitez2
lang: en
list: true
root: /home/trevor/programming/index.gmi
...
`

I encounter a 404 error even though index.gmi exists. This seems to be an issue even before applying your changes. Would you mind reproducing this locally and let me know what you find? If you don't have time to look into this I should be able to at some point over the next few weeks.

Thanks for submitting these changes. When using the following path configurations: ` hosts: localhost: ... paths: - path: /sitez1 lang: en list: true root: /home/trevor/programming - path: /sitez2` lang: en list: true root: /home/trevor/programming/index.gmi ... ` I encounter a 404 error even though `index.gmi` exists. This seems to be an issue even before applying your changes. Would you mind reproducing this locally and let me know what you find? If you don't have time to look into this I should be able to at some point over the next few weeks.
Owner

Not sure why that was formatted as a table, but you get the idea.

Not sure why that was formatted as a table, but you get the idea.
Author
Contributor

I've reproduced your configuration like this:

listen: :443

hosts:
  localhost:
    cert: certs/localhost.crt
    key: certs/localhost.key
    paths:
      -
        path: /sitez1/
        root: public_gmi/a
        lang: en
        list: true
      -
        path: /sitez2/
        root: public_gmi/b
        lang: en
        list: true

With current HEAD, I've got 404 errors for both paths (HTTPS, with and without a trailing slash). Gemini works as expected (with AND without trailing slash).

My PR fixes this, so both paths open the correct index.gmi. See the comment in my PR for the root cause.

One minor problem remains: For gemini, there is a redirect (30) if the trailing slash is missing. This redirect is not executed for HTTPS. But this is a separate issue.

It would be great if you double check my PR in order to solve the problem. ?

I've reproduced your configuration like this: ``` listen: :443 hosts: localhost: cert: certs/localhost.crt key: certs/localhost.key paths: - path: /sitez1/ root: public_gmi/a lang: en list: true - path: /sitez2/ root: public_gmi/b lang: en list: true ``` With current HEAD, I've got 404 errors for both paths (HTTPS, with and without a trailing slash). Gemini works as expected (with AND without trailing slash). My PR fixes this, so both paths open the correct index.gmi. See the comment in my PR for the root cause. One minor problem remains: For gemini, there is a redirect (30) if the trailing slash is missing. This redirect is not executed for HTTPS. But this is a separate issue. It would be great if you double check my PR in order to solve the problem. ?
f added 1 commit 2021-07-09 19:05:40 +00:00
Author
Contributor

To get this working on my side, I've added my PR as a patch to the Dockerfile and is part of this docker image:
https://hub.docker.com/repository/docker/f00860/twins

Sourcecode for this is located here:
https://git.okoyono.de/f/twins-docker

To get this working on my side, I've added my PR as a patch to the ```Dockerfile``` and is part of this docker image: https://hub.docker.com/repository/docker/f00860/twins Sourcecode for this is located here: https://git.okoyono.de/f/twins-docker
This pull request can be merged automatically.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.
You can also view command line instructions.

Step 1:

From your project repository, check out a new branch and test the changes.
git checkout -b f-path-strip master
git pull path-strip

Step 2:

Merge the changes and update on Forgejo.
git checkout master
git merge --no-ff f-path-strip
git push origin master
Sign in to join this conversation.
No reviewers
No Milestone
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: tslocum/twins#10
No description provided.