gabehf/Koito
1
0
Fork 0
mirror of https://github.com/gabehf/Koito.git synced 2026-03-14 09:55:55 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: config to gate all statistics behind login (#99)

Browse source 
* feat: gate all stats behind login

* docs: add config reference for login gate
This commit is contained in:
Gabe Farrell 2025-11-20 22:50:15 -05:00 • committed by GitHub
parent c77481fd59
commit daa1bb2456
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 192 additions and 128 deletions
Download patch file Download diff file Expand all files Collapse all files

2
client/app/components/LastPlays.tsx
View file

@ -72,6 +72,8 @@ export default function LastPlays(props: Props) {
return <p className="error">Error: {error.message}</p>; return <p className="error">Error: {error.message}</p>;
} }
if (!data.items) return;
const listens = items ?? data.items; const listens = items ?? data.items;
let params = ""; let params = "";

93
client/app/components/TopAlbums.tsx
View file

@ -1,42 +1,63 @@
import { useQuery } from "@tanstack/react-query" import { useQuery } from "@tanstack/react-query";
import ArtistLinks from "./ArtistLinks" import ArtistLinks from "./ArtistLinks";
import { getTopAlbums, getTopTracks, imageUrl, type getItemsArgs } from "api/api" import {
import { Link } from "react-router" getTopAlbums,
import TopListSkeleton from "./skeletons/TopListSkeleton" getTopTracks,
import TopItemList from "./TopItemList" imageUrl,
type getItemsArgs,
} from "api/api";
import { Link } from "react-router";
import TopListSkeleton from "./skeletons/TopListSkeleton";
import TopItemList from "./TopItemList";
interface Props { interface Props {
limit: number, limit: number;
period: string, period: string;
artistId?: Number artistId?: Number;
} }
export default function TopAlbums (props: Props) { export default function TopAlbums(props: Props) {
const { isPending, isError, data, error } = useQuery({
const { isPending, isError, data, error } = useQuery({ queryKey: [
queryKey: ['top-albums', {limit: props.limit, period: props.period, artistId: props.artistId, page: 0 }], "top-albums",
queryFn: ({ queryKey }) => getTopAlbums(queryKey[1] as getItemsArgs), {
}) limit: props.limit,
period: props.period,
if (isPending) { artistId: props.artistId,
return ( page: 0,
<div className="w-[300px]"> },
<h2>Top Albums</h2> ],
<p>Loading...</p> queryFn: ({ queryKey }) => getTopAlbums(queryKey[1] as getItemsArgs),
</div> });
)
}
if (isError) {
return <p className="error">Error:{error.message}</p>
}
if (isPending) {
return ( return (
<div> <div className="w-[300px]">
<h2 className="hover:underline"><Link to={`/chart/top-albums?period=${props.period}${props.artistId ? `&artist_id=${props.artistId}` : ''}`}>Top Albums</Link></h2> <h2>Top Albums</h2>
<div className="max-w-[300px]"> <p>Loading...</p>
<TopItemList type="album" data={data} /> </div>
{data.items.length < 1 ? 'Nothing to show' : ''} );
</div> }
</div> if (isError) {
) return <p className="error">Error:{error.message}</p>;
} }
if (!data.items) return;
return (
<div>
<h2 className="hover:underline">
<Link
to={`/chart/top-albums?period=${props.period}${
props.artistId ? `&artist_id=${props.artistId}` : ""
}`}
>
Top Albums
</Link>
</h2>
<div className="max-w-[300px]">
<TopItemList type="album" data={data} />
{data.items.length < 1 ? "Nothing to show" : ""}
</div>
</div>
);
}

81
client/app/components/TopArtists.tsx
View file

@ -1,43 +1,50 @@
import { useQuery } from "@tanstack/react-query" import { useQuery } from "@tanstack/react-query";
import ArtistLinks from "./ArtistLinks" import ArtistLinks from "./ArtistLinks";
import { getTopArtists, imageUrl, type getItemsArgs } from "api/api" import { getTopArtists, imageUrl, type getItemsArgs } from "api/api";
import { Link } from "react-router" import { Link } from "react-router";
import TopListSkeleton from "./skeletons/TopListSkeleton" import TopListSkeleton from "./skeletons/TopListSkeleton";
import TopItemList from "./TopItemList" import TopItemList from "./TopItemList";
interface Props { interface Props {
limit: number, limit: number;
period: string, period: string;
artistId?: Number artistId?: Number;
albumId?: Number albumId?: Number;
} }
export default function TopArtists (props: Props) { export default function TopArtists(props: Props) {
const { isPending, isError, data, error } = useQuery({
const { isPending, isError, data, error } = useQuery({ queryKey: [
queryKey: ['top-artists', {limit: props.limit, period: props.period, page: 0 }], "top-artists",
queryFn: ({ queryKey }) => getTopArtists(queryKey[1] as getItemsArgs), { limit: props.limit, period: props.period, page: 0 },
}) ],
queryFn: ({ queryKey }) => getTopArtists(queryKey[1] as getItemsArgs),
if (isPending) { });
return (
<div className="w-[300px]">
<h2>Top Artists</h2>
<p>Loading...</p>
</div>
)
}
if (isError) {
return <p className="error">Error:{error.message}</p>
}
if (isPending) {
return ( return (
<div> <div className="w-[300px]">
<h2 className="hover:underline"><Link to={`/chart/top-artists?period=${props.period}`}>Top Artists</Link></h2> <h2>Top Artists</h2>
<div className="max-w-[300px]"> <p>Loading...</p>
<TopItemList type="artist" data={data} /> </div>
{data.items.length < 1 ? 'Nothing to show' : ''} );
</div> }
</div> if (isError) {
) return <p className="error">Error:{error.message}</p>;
} }
if (!data.items) return;
return (
<div>
<h2 className="hover:underline">
<Link to={`/chart/top-artists?period=${props.period}`}>
Top Artists
</Link>
</h2>
<div className="max-w-[300px]">
<TopItemList type="artist" data={data} />
{data.items.length < 1 ? "Nothing to show" : ""}
</div>
</div>
);
}

97
client/app/components/TopTracks.tsx
View file

@ -1,50 +1,63 @@
import { useQuery } from "@tanstack/react-query" import { useQuery } from "@tanstack/react-query";
import ArtistLinks from "./ArtistLinks" import ArtistLinks from "./ArtistLinks";
import { getTopTracks, imageUrl, type getItemsArgs } from "api/api" import { getTopTracks, imageUrl, type getItemsArgs } from "api/api";
import { Link } from "react-router" import { Link } from "react-router";
import TopListSkeleton from "./skeletons/TopListSkeleton" import TopListSkeleton from "./skeletons/TopListSkeleton";
import { useEffect } from "react" import { useEffect } from "react";
import TopItemList from "./TopItemList" import TopItemList from "./TopItemList";
interface Props { interface Props {
limit: number, limit: number;
period: string, period: string;
artistId?: Number artistId?: Number;
albumId?: Number albumId?: Number;
} }
const TopTracks = (props: Props) => { const TopTracks = (props: Props) => {
const { isPending, isError, data, error } = useQuery({
queryKey: [
"top-tracks",
{
limit: props.limit,
period: props.period,
artist_id: props.artistId,
album_id: props.albumId,
page: 0,
},
],
queryFn: ({ queryKey }) => getTopTracks(queryKey[1] as getItemsArgs),
});
const { isPending, isError, data, error } = useQuery({ if (isPending) {
queryKey: ['top-tracks', {limit: props.limit, period: props.period, artist_id: props.artistId, album_id: props.albumId, page: 0}],
queryFn: ({ queryKey }) => getTopTracks(queryKey[1] as getItemsArgs),
})
if (isPending) {
return (
<div className="w-[300px]">
<h2>Top Tracks</h2>
<p>Loading...</p>
</div>
)
}
if (isError) {
return <p className="error">Error:{error.message}</p>
}
let params = ''
params += props.artistId ? `&artist_id=${props.artistId}` : ''
params += props.albumId ? `&album_id=${props.albumId}` : ''
return ( return (
<div> <div className="w-[300px]">
<h2 className="hover:underline"><Link to={`/chart/top-tracks?period=${props.period}${params}`}>Top Tracks</Link></h2> <h2>Top Tracks</h2>
<div className="max-w-[300px]"> <p>Loading...</p>
<TopItemList type="track" data={data}/> </div>
{data.items.length < 1 ? 'Nothing to show' : ''} );
</div> }
</div> if (isError) {
) return <p className="error">Error:{error.message}</p>;
} }
if (!data.items) return;
export default TopTracks let params = "";
params += props.artistId ? `&artist_id=${props.artistId}` : "";
params += props.albumId ? `&album_id=${props.albumId}` : "";
return (
<div>
<h2 className="hover:underline">
<Link to={`/chart/top-tracks?period=${props.period}${params}`}>
Top Tracks
</Link>
</h2>
<div className="max-w-[300px]">
<TopItemList type="track" data={data} />
{data.items.length < 1 ? "Nothing to show" : ""}
</div>
</div>
);
};
export default TopTracks;

3
docs/src/content/docs/reference/configuration.md
View file

@ -26,6 +26,9 @@ If the environment variable is defined without **and** with the suffix at the sa
##### KOITO_DEFAULT_THEME ##### KOITO_DEFAULT_THEME
- Default: `yuu` - Default: `yuu`
- Description: The lowercase name of the default theme to be used by the client. Overridden if a user picks a theme in the theme switcher. - Description: The lowercase name of the default theme to be used by the client. Overridden if a user picks a theme in the theme switcher.
##### KOITO_LOGIN_GATE
- Default: `false`
- Description: When `true`, Koito will not show any statistics unless the user is logged in.
##### KOITO_BIND_ADDR ##### KOITO_BIND_ADDR
- Description: The address to bind to. The default blank value is equivalent to `0.0.0.0`. - Description: The address to bind to. The default blank value is equivalent to `0.0.0.0`.
##### KOITO_LISTEN_PORT ##### KOITO_LISTEN_PORT

32
engine/routes.go
View file

@ -36,19 +36,25 @@ func bindRoutes(
r.Route("/apis/web/v1", func(r chi.Router) { r.Route("/apis/web/v1", func(r chi.Router) {
r.Get("/config", handlers.GetCfgHandler()) r.Get("/config", handlers.GetCfgHandler())
r.Get("/artist", handlers.GetArtistHandler(db))
r.Get("/artists", handlers.GetArtistsForItemHandler(db)) r.Group(func(r chi.Router) {
r.Get("/album", handlers.GetAlbumHandler(db)) if cfg.LoginGate() {
r.Get("/track", handlers.GetTrackHandler(db)) r.Use(middleware.ValidateSession(db))
r.Get("/top-tracks", handlers.GetTopTracksHandler(db)) }
r.Get("/top-albums", handlers.GetTopAlbumsHandler(db)) r.Get("/artist", handlers.GetArtistHandler(db))
r.Get("/top-artists", handlers.GetTopArtistsHandler(db)) r.Get("/artists", handlers.GetArtistsForItemHandler(db))
r.Get("/listens", handlers.GetListensHandler(db)) r.Get("/album", handlers.GetAlbumHandler(db))
r.Get("/listen-activity", handlers.GetListenActivityHandler(db)) r.Get("/track", handlers.GetTrackHandler(db))
r.Get("/now-playing", handlers.NowPlayingHandler(db)) r.Get("/top-tracks", handlers.GetTopTracksHandler(db))
r.Get("/stats", handlers.StatsHandler(db)) r.Get("/top-albums", handlers.GetTopAlbumsHandler(db))
r.Get("/search", handlers.SearchHandler(db)) r.Get("/top-artists", handlers.GetTopArtistsHandler(db))
r.Get("/aliases", handlers.GetAliasesHandler(db)) r.Get("/listens", handlers.GetListensHandler(db))
r.Get("/listen-activity", handlers.GetListenActivityHandler(db))
r.Get("/now-playing", handlers.NowPlayingHandler(db))
r.Get("/stats", handlers.StatsHandler(db))
r.Get("/search", handlers.SearchHandler(db))
r.Get("/aliases", handlers.GetAliasesHandler(db))
})
r.Post("/logout", handlers.LogoutHandler(db)) r.Post("/logout", handlers.LogoutHandler(db))
if !cfg.RateLimitDisabled() { if !cfg.RateLimitDisabled() {
r.With(httprate.Limit( r.With(httprate.Limit(

12
internal/cfg/cfg.go
View file

@ -47,6 +47,7 @@ const (
IMPORT_AFTER_UNIX_ENV = "KOITO_IMPORT_AFTER_UNIX" IMPORT_AFTER_UNIX_ENV = "KOITO_IMPORT_AFTER_UNIX"
FETCH_IMAGES_DURING_IMPORT_ENV = "KOITO_FETCH_IMAGES_DURING_IMPORT" FETCH_IMAGES_DURING_IMPORT_ENV = "KOITO_FETCH_IMAGES_DURING_IMPORT"
ARTIST_SEPARATORS_ENV = "KOITO_ARTIST_SEPARATORS_REGEX" ARTIST_SEPARATORS_ENV = "KOITO_ARTIST_SEPARATORS_REGEX"
LOGIN_GATE_ENV = "KOITO_LOGIN_GATE"
) )
type config struct { type config struct {
@ -83,6 +84,7 @@ type config struct {
importBefore time.Time importBefore time.Time
importAfter time.Time importAfter time.Time
artistSeparators []*regexp.Regexp artistSeparators []*regexp.Regexp
loginGate bool
} }
var ( var (
@ -204,6 +206,10 @@ func loadConfig(getenv func(string) string, version string) (*config, error) {
cfg.artistSeparators = []*regexp.Regexp{regexp.MustCompile(`\s+·\s+`)} cfg.artistSeparators = []*regexp.Regexp{regexp.MustCompile(`\s+·\s+`)}
} }
if strings.ToLower(getenv(LOGIN_GATE_ENV)) == "true" {
cfg.loginGate = true
}
switch strings.ToLower(getenv(LOG_LEVEL_ENV)) { switch strings.ToLower(getenv(LOG_LEVEL_ENV)) {
case "debug": case "debug":
cfg.logLevel = 0 cfg.logLevel = 0
@ -409,3 +415,9 @@ func ArtistSeparators() []*regexp.Regexp {
defer lock.RUnlock() defer lock.RUnlock()
return globalConfig.artistSeparators return globalConfig.artistSeparators
} }
func LoginGate() bool {
lock.RLock()
defer lock.RUnlock()
return globalConfig.loginGate
}