Link ID refactoring #697
Merged
Link ID refactoring #697
Conversation
This file contains 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
ArthurHoaro
added
cleanup
virtualtam
reviewed
Dec 11, 2016
| * @param DateTime $date Link creation date. | ||
| * @param int $id Link ID. | ||
| * | ||
| * @return string the small hash generating from link data. |
| @@ -31,7 +31,11 @@ function logm($logFile, $clientIp, $message) | |||
| * - are NOT cryptographically secure (they CAN be forged) | |||
| * | |||
| * In Shaarli, they are used as a tinyurl-like link to individual entries, | |||
| * e.g. smallHash('20111006_131924') --> yZH23w | |||
| * build once with the combination of the date and item ID. | |||
| * build once with the combination of the date and item ID. | ||
| * e.g. smallHash('20111006_131924' . 142) --> eaWxtQ | ||
| * | ||
| * Note: before v0.8.1, smallhashes were built only with the date, |
There was a problem hiding this comment.
the @warning and @attention tags can be used for additional/important info:
| $order = $order === 'ASC' ? -1 : 1; | ||
| // Reorder array by dates. | ||
| usort($this->links, function($a, $b) use ($order) { | ||
| return $a['created'] < $b['created'] ? 1 * $order : -1 * $order; |
There was a problem hiding this comment.
cool! this will be easy to modify to add support for the 'updated' link field
| * | ||
| * @param int $id Persistent ID of a link. | ||
| * | ||
| * @return int Real offset in local array, or null if doesn't exists. |
| @@ -1429,6 +1451,8 @@ function renderPage($conf, $pluginManager) | |||
| 'tags' => $tags, | |||
| 'private' => $private | |||
| ); | |||
| } else { | |||
| $link['linkdate'] = $link['created']->format('Ymd_His'); | |||
| } else { | ||
| $link['updated_timestamp'] = ''; | ||
| } | ||
| $taglist = explode(' ', $link['tags']); | ||
| uasort($taglist, 'strcasecmp'); | ||
| $link['taglist'] = $taglist; | ||
| $link['shorturl'] = smallHash($link['linkdate']); | ||
| $link['shorturl'] = smallHash($link['created']->format('Ymd_His')); |
|
|
||
| $isso = sprintf($isso_html, $issoUrl, $issoUrl, $link['linkdate'], $link['linkdate']); | ||
| // FIXME! KO thread unique si même date | ||
| $linkDate = $link['created']->format('Ymd_His'); |
|
|
||
| $isso = sprintf($isso_html, $issoUrl, $issoUrl, $link['linkdate'], $link['linkdate']); | ||
| // FIXME! KO thread unique si même date |
There was a problem hiding this comment.
CORRIGEZ-MOI ! Comment in French 😄
| { | ||
| self::$publicLinkDB->reorder('ASC'); | ||
| $linkIdToTest = 42; | ||
| foreach (self::$publicLinkDB as $key => $value) { |
There was a problem hiding this comment.
is the test loop breaking after iterating over the first element? if so, it'd be more robust to check the order of keys in the sorted array
ArthurHoaro
force-pushed
the
feature/ids-bis
branch
from
76487f7 to
cd484e7
Compare
Links now use an incremental unique numeric identifier.
This ID is persistent and must never change.
ArrayAccess is used to match the link ID with the array keys (see the comment in LinkDB for more details)
Key 'created' added, with creation date as a DateTime object. 'updated' is now also a DateTime.
…ry keys. creation and update dates are now DateTime objects. Since this update is very sensitve (changing the whole database), the datastore will be automatically backed up into the file datastore.<datetime>.php.
All existing link will keep their permalinks. New links will have smallhash generated with date+id. The purpose of this is to avoid collision between links due to their creation date.
ArthurHoaro
force-pushed
the
feature/ids-bis
branch
from
cd484e7 to
d592dae
Compare
|
Thanks for your review! Good advices, as usual. =) Changes rebased. |
|
You're welcome, thanks for releasing |
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.
First of all, it was way harder than what I though, tests appreciated.
Links now use an incremental unique numeric identifier. This ID is persistent and must never change. ArrayAccess is used to match the link ID with the array keys (see the comment at the top of LinkDB for more details).
Key 'created' added for each link, with creation date as a DateTime object. 'updated' is now also a DateTime.
I also added a persistent 'shorturl' key to all links to preserve existing permalinks. "Small hashes" are now generated once using the date (
YYYYMMDD_hhmmss) and the ID to avoid collision.The updater does its work and everything should be transparent to users. Just in case, it makes a backup of the datastore before anything.
Take a look at individual commits for something more readable.
@mro, I've run your tests against this PR, it should be fine.
Fixes #351 and closes v0.8.1.