2023-03-12 18:00:57 +03:00
|
|
|
// GoToSocial
|
|
|
|
// Copyright (C) GoToSocial Authors admin@gotosocial.org
|
|
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
|
|
//
|
|
|
|
// This program is free software: you can redistribute it and/or modify
|
|
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
|
|
// (at your option) any later version.
|
|
|
|
//
|
|
|
|
// This program is distributed in the hope that it will be useful,
|
|
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
// GNU Affero General Public License for more details.
|
|
|
|
//
|
|
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
|
|
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
2022-11-22 21:38:10 +03:00
|
|
|
|
2021-06-13 19:42:28 +03:00
|
|
|
package id
|
|
|
|
|
|
|
|
import (
|
|
|
|
"crypto/rand"
|
|
|
|
"math/big"
|
|
|
|
"time"
|
|
|
|
|
2024-12-05 16:35:07 +03:00
|
|
|
"codeberg.org/gruf/go-kv"
|
2021-06-13 19:42:28 +03:00
|
|
|
"github.com/oklog/ulid"
|
2024-12-05 16:35:07 +03:00
|
|
|
"github.com/superseriousbusiness/gotosocial/internal/log"
|
2021-06-13 19:42:28 +03:00
|
|
|
)
|
|
|
|
|
2022-11-22 21:38:10 +03:00
|
|
|
const (
|
|
|
|
Highest = "ZZZZZZZZZZZZZZZZZZZZZZZZZZ" // Highest is the highest possible ULID
|
|
|
|
Lowest = "00000000000000000000000000" // Lowest is the lowest possible ULID
|
|
|
|
randomRange = 631152381 // ~20 years in seconds
|
|
|
|
)
|
2021-06-13 19:42:28 +03:00
|
|
|
|
2021-08-31 16:59:12 +03:00
|
|
|
// ULID represents a Universally Unique Lexicographically Sortable Identifier of 26 characters. See https://github.com/oklog/ulid
|
2021-08-29 17:52:23 +03:00
|
|
|
type ULID string
|
|
|
|
|
2023-02-03 23:03:05 +03:00
|
|
|
// NewULID returns a new ULID string using the current time.
|
|
|
|
func NewULID() string {
|
|
|
|
ulid, err := ulid.New(
|
|
|
|
ulid.Timestamp(time.Now()), rand.Reader,
|
|
|
|
)
|
2021-06-13 19:42:28 +03:00
|
|
|
if err != nil {
|
2023-02-03 23:03:05 +03:00
|
|
|
panic(err)
|
2021-06-13 19:42:28 +03:00
|
|
|
}
|
2023-02-03 23:03:05 +03:00
|
|
|
return ulid.String()
|
2021-06-13 19:42:28 +03:00
|
|
|
}
|
|
|
|
|
2024-12-05 16:35:07 +03:00
|
|
|
// NewULIDFromTime returns a new ULID string using
|
|
|
|
// given time, or from current time on any error.
|
|
|
|
func NewULIDFromTime(t time.Time) string {
|
|
|
|
ts := ulid.Timestamp(t)
|
|
|
|
if ts > ulid.MaxTime() {
|
|
|
|
log.WarnKVs(nil, kv.Fields{
|
|
|
|
{K: "caller", V: log.Caller(2)},
|
|
|
|
{K: "value", V: t},
|
|
|
|
{K: "msg", V: "invalid ulid time"},
|
|
|
|
}...)
|
|
|
|
ts = ulid.Now()
|
2021-06-13 19:42:28 +03:00
|
|
|
}
|
2024-12-05 16:35:07 +03:00
|
|
|
return ulid.MustNew(ts, rand.Reader).String()
|
2021-06-13 19:42:28 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
// NewRandomULID returns a new ULID string using a random time in an ~80 year range around the current datetime, or an error if something goes wrong.
|
|
|
|
func NewRandomULID() (string, error) {
|
|
|
|
b1, err := rand.Int(rand.Reader, big.NewInt(randomRange))
|
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
r1 := time.Duration(int(b1.Int64()))
|
|
|
|
|
|
|
|
b2, err := rand.Int(rand.Reader, big.NewInt(randomRange))
|
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
r2 := -time.Duration(int(b2.Int64()))
|
|
|
|
|
|
|
|
arbitraryTime := time.Now().Add(r1 * time.Second).Add(r2 * time.Second)
|
|
|
|
newUlid, err := ulid.New(ulid.Timestamp(arbitraryTime), rand.Reader)
|
|
|
|
if err != nil {
|
|
|
|
return "", err
|
|
|
|
}
|
|
|
|
return newUlid.String(), nil
|
|
|
|
}
|