Open
Conversation
ofaurax
requested changes
Mar 30, 2024
ofaurax
requested changes
Apr 9, 2024
ofaurax
reviewed
Apr 10, 2024
ofaurax
requested changes
Jun 18, 2024
Owner
ofaurax
left a comment
There was a problem hiding this comment.
Have look to my proposal edits, then resubmit review, thanks!
|
|
||
| ## Document access token | ||
|
|
||
| Tokens are used to regulate access to scores. Nobody can access to scores without it, and it has an expiration date. |
Owner
There was a problem hiding this comment.
Suggested change
| Tokens are used to regulate access to scores. Nobody can access to scores without it, and it has an expiration date. | |
| Tokens are used to regulate access to scores. Nobody can access scores without one, and they have an expiration date. |
|
|
||
| Tokens are used to regulate access to scores. Nobody can access to scores without it, and it has an expiration date. | ||
|
|
||
| If the used link to the scores is used for malicious purpose, it can be quickly deactivated to stop access from the leaked link. Then a new one can be created to provide a new access to target users. |
Owner
There was a problem hiding this comment.
Suggested change
| If the used link to the scores is used for malicious purpose, it can be quickly deactivated to stop access from the leaked link. Then a new one can be created to provide a new access to target users. | |
| If the used link to the scores is used for malicious purpose, it can be quickly deactivated to stop access from the leaked link, by simply removing the token. Then, a new one can be created to provide a new access to target users. |
|
|
||
| If the used link to the scores is used for malicious purpose, it can be quickly deactivated to stop access from the leaked link. Then a new one can be created to provide a new access to target users. | ||
|
|
||
| To create a new token, create a file in repository `private/tokens/` in the format `YYYYMMDD-KEY.txt`, by replacing `YYYYMMDD` by a given date (in format year-month-day) which is the limit of activation of the token (passed this date, the token is disabled) and `KEY` by any alphanumeric string of characters (preferably randomly generated). |
Owner
There was a problem hiding this comment.
Suggested change
| To create a new token, create a file in repository `private/tokens/` in the format `YYYYMMDD-KEY.txt`, by replacing `YYYYMMDD` by a given date (in format year-month-day) which is the limit of activation of the token (passed this date, the token is disabled) and `KEY` by any alphanumeric string of characters (preferably randomly generated). | |
| To create a new token, create a file in repository `private/tokens/` in the format `YYYYMMDD-KEY.txt`, by replacing `YYYYMMDD` by a given date (in format year-month-day) which is the date after which the token is disabled, and `KEY` by any alphanumeric string of characters. `KEY` *must be* randomly generated, because anyone that knows can access all scores. All this process can be handled by `/admin/token.php`. This script *MUST* be protected from public access. |
| If the used link to the scores is used for malicious purpose, it can be quickly deactivated to stop access from the leaked link. Then a new one can be created to provide a new access to target users. | ||
|
|
||
| To create a new token, create a file in repository `private/tokens/` in the format `YYYYMMDD-KEY.txt`, by replacing `YYYYMMDD` by a given date (in format year-month-day) which is the limit of activation of the token (passed this date, the token is disabled) and `KEY` by any alphanumeric string of characters (preferably randomly generated). | ||
| The content of this file is ignored. |
Owner
There was a problem hiding this comment.
Suggested change
| The content of this file is ignored. | |
| The content of token files is ignored. |
| To create a new token, create a file in repository `private/tokens/` in the format `YYYYMMDD-KEY.txt`, by replacing `YYYYMMDD` by a given date (in format year-month-day) which is the limit of activation of the token (passed this date, the token is disabled) and `KEY` by any alphanumeric string of characters (preferably randomly generated). | ||
| The content of this file is ignored. | ||
|
|
||
| To access to the website with the token, the URL shall be: *www.mywebsite.com/?token=KEY* with *KEY* the actual `KEY` used at the end of the created file name. |
Owner
There was a problem hiding this comment.
Suggested change
| To access to the website with the token, the URL shall be: *www.mywebsite.com/?token=KEY* with *KEY* the actual `KEY` used at the end of the created file name. | |
| To access to the website with the token, the URL shall be: *www.example.com/?token=KEY* with *KEY* the actual `KEY` used at the end of the created file name. |
|
|
||
| Scores are stored in subdirectories of `private/docs`. | ||
|
|
||
| To add a new set of music scores here, create a new directory with the code of the score in csv (ex: "F058" for "1ere Symphonie en Ut Majeur" described in `Archives_HMAP_140126.csv`. |
Owner
There was a problem hiding this comment.
Suggested change
| To add a new set of music scores here, create a new directory with the code of the score in csv (ex: "F058" for "1ere Symphonie en Ut Majeur" described in `Archives_HMAP_140126.csv`. | |
| To add a new set of music scores here, create a new directory with the score reference in csv (ex: "F058" for "1ere Symphonie en Ut Majeur" described in `Archives_HMAP_140126.csv`. |
|
|
||
| To add a new set of music scores here, create a new directory with the code of the score in csv (ex: "F058" for "1ere Symphonie en Ut Majeur" described in `Archives_HMAP_140126.csv`. | ||
|
|
||
| Then in that directory, add all scores. |
Owner
There was a problem hiding this comment.
Suggested change
| Then in that directory, add all scores. | |
| Then in that directory (e.g. `private/docs/F058`), add all scores. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fill README.md with informations about tokens and scores.
Documentation about csv format used to classify scores shall also be added.