681 Commits

Author SHA1 Message Date
25e4978583 Update README.md 2023-12-11 01:57:06 +01:00
457a3c6709 Format the code 2023-12-09 19:02:15 +01:00
Arthur Jamet
ddb9b2926d Front: Recommended Component: fix align to position of play button 2023-12-09 19:02:15 +01:00
Arthur Jamet
1e5ef4003a Front: Constats: use camelCase 2023-12-09 19:02:15 +01:00
Arthur Jamet
f246b6ce32 Front: Constants: Move to single file 2023-12-09 19:02:15 +01:00
Arthur Jamet
b246f43c70 Front: Recommended: Use CSS calc to compute border radius of frame 2023-12-09 19:02:15 +01:00
Arthur Jamet
fbf660d532 Front: Recommended: Use theme for color 2023-12-09 19:02:15 +01:00
Arthur Jamet
db3f03dc6c Front: Prettier 2023-12-09 19:02:15 +01:00
Arthur Jamet
ba16d7873f Front: Recommended: Set color to white, for better contrast 2023-12-09 19:02:15 +01:00
Arthur Jamet
ee33c71dfe Front: Recommended: Add some padding around genre list and play button 2023-12-09 19:02:15 +01:00
Arthur Jamet
1eadcb6521 Front: Recommended: Fix position of play button when empty list of genres 2023-12-09 19:02:15 +01:00
Arthur Jamet
b3a9c9dae8 Front: Grid: If no subtitle, allow 2 lines for name 2023-12-09 19:02:15 +01:00
Arthur Jamet
c475691939 Front: Define and apply Image's border radius constant 2023-12-09 19:02:15 +01:00
Arthur Jamet
e6ac7e502c Front: 'Recommended' component: remove border radius on the right side 2023-12-09 19:02:15 +01:00
Arthur Jamet
30581a4ee1 Front: Fix chip text color on hover 2023-12-08 11:09:25 +01:00
a54311c53f Fix next episodes on continue watching 2023-12-08 03:09:45 +01:00
0c9711baea Create .git-blame-ignore-revs 2023-12-08 02:44:05 +01:00
bffd71fea5 Use csharpier in the ci 2023-12-08 02:42:46 +01:00
7e6e56a366 Add csharpier as a code formatter 2023-12-08 02:42:46 +01:00
baa78b9417 Add a healthcheck for meilisearch 2023-12-08 02:42:46 +01:00
b28bf5803d Add meilisearch to the back dependencies 2023-12-08 02:42:46 +01:00
Arthur Jamet
ee3eed6c23 Front: Better padding + text color for chips 2023-12-07 19:34:04 +01:00
bf831dba45 Fix previous episode when an absolute number is null 2023-12-07 00:42:15 +01:00
a43d54ee1d Fix tests 2023-12-07 00:03:13 +01:00
f536713f04 Format front 2023-12-07 00:03:13 +01:00
f438e80d3a Add login button instead of watchlist when user is not login 2023-12-07 00:03:13 +01:00
38cb4c4f28 Tranform completed shows in watching state when a new item is added 2023-12-07 00:03:13 +01:00
1178e8fd6c Hide completed items from the watchlist 2023-12-07 00:03:13 +01:00
e2414f94f3 Add movie watch percent progress bar 2023-12-07 00:03:13 +01:00
c87001d91e Create watchlist on the homepage 2023-12-07 00:03:13 +01:00
4cf9609153 Return next episode on /watchlist 2023-12-07 00:03:13 +01:00
83877d8dab Make infinite scroll fetch earlier 2023-12-07 00:03:13 +01:00
bab97fba5f Add watchlist filters and fix after id 2023-12-07 00:03:13 +01:00
c289161400 Create get all in watch status repository 2023-12-07 00:03:13 +01:00
7810f626c6 Add watchlist api 2023-12-07 00:03:13 +01:00
0294f538eb Create a component for watch status overlay 2023-12-07 00:03:13 +01:00
ce07cece06 Clean up 204 handling on the front 2023-12-07 00:03:13 +01:00
74013cf113 Rework the watch status observer to update every 10s 2023-12-07 00:03:13 +01:00
1eb7198e6f Set react query stale time to 5min 2023-12-07 00:03:13 +01:00
c24c8914bf Add watch status indicator on items list and recommanded card 2023-12-07 00:03:13 +01:00
e5dde472c9 Fix projected relations mixed with normal relations 2023-12-07 00:03:13 +01:00
7ccfab4d8b Add watch status indicator on items grid 2023-12-07 00:03:13 +01:00
0bc6512bcc Fix episodes count calculation on dapper 2023-12-07 00:03:13 +01:00
e70174cb24 Add watch percent display on episodes 2023-12-07 00:03:13 +01:00
fe155898bb Add show next up episode 2023-12-07 00:03:13 +01:00
bd48032a50 Handle next episode position/percent in show watch status 2023-12-07 00:03:13 +01:00
e124113d41 Add a watch observer to register watch status when playing 2023-12-07 00:03:13 +01:00
6974ef0163 Add watchlist menu to set status in details page 2023-12-07 00:03:13 +01:00
015bfe983c Push fix next episode id nullability 2023-12-07 00:03:13 +01:00
275a892ee1 Add react query devtools 2023-12-07 00:03:13 +01:00
0ac4a1daa0 Fix watch status upsert 2023-12-07 00:03:13 +01:00
7bf3ba2443 Disable watchlist button for unlogged users 2023-12-07 00:03:13 +01:00
cfa12b0fed Add basic watch status button on details page 2023-12-07 00:03:13 +01:00
2f309440cc Fix error messages for unlogged users on the watch status api 2023-12-07 00:03:13 +01:00
db3d7f1f2e Parse watch status on the front 2023-12-07 00:03:13 +01:00
d1febd13fd Standardize multiline raw strings indent 2023-12-07 00:03:13 +01:00
6fbd00a38f Add watchlists on news and library items 2023-12-07 00:03:13 +01:00
948c98f95b Add watchlist migration 2023-12-07 00:03:13 +01:00
4139362677 Update watch list code to use guids 2023-12-07 00:03:13 +01:00
b9932383c6 Nit picks files names 2023-12-07 00:03:13 +01:00
aa4ea2134a Add played date on watch status 2023-12-07 00:03:13 +01:00
48f77c2f7a Add watch apis 2023-12-07 00:03:13 +01:00
6567e78c8c Add percent, unseen episodes count and show completions handling 2023-12-07 00:03:13 +01:00
32050bcdcd Add episodes and shows watch status apis 2023-12-07 00:03:13 +01:00
2aa10c9b1f Add movie's watch status api 2023-12-07 00:03:13 +01:00
4f9c06c7bd Rename watch info to watch status 2023-12-07 00:03:13 +01:00
b6bb190e69 Add every tables for watchlists 2023-12-07 00:03:13 +01:00
4135fc5703 Start watchlist implementations 2023-12-07 00:03:13 +01:00
c1ba51b903 Run prettier 2023-12-05 23:56:14 +01:00
a218271001 Add guid parsing in filters 2023-12-05 23:56:14 +01:00
f4442fad0c Unselect account during refresh errors (could happen if server db was cleared) 2023-12-05 23:56:14 +01:00
87fdc1a444 Fix refresh token 403 first time 2023-12-05 23:56:14 +01:00
eed764c6e0 Use a promise cache to only refresh tokens one time on client side navigation 2023-12-05 23:56:14 +01:00
f9a2185748 Fix ssr issue with jwts 2023-12-05 23:56:14 +01:00
4f7c449ea7 Fix externalids error with null 2023-12-05 23:56:14 +01:00
7dab3fd094 Format front 2023-12-02 01:11:04 +01:00
49d225532c Various account fixes 2023-12-02 01:11:04 +01:00
b2c67e7df4 Fix yoshiki insert bug in input 2023-12-02 01:11:04 +01:00
07259a7635 Fix accounts under ssr 2023-12-02 01:11:04 +01:00
d63c601812 Fix some themes issues 2023-12-02 01:11:04 +01:00
ecd1b55fc6 Upgrade packages 2023-12-02 01:11:04 +01:00
4c955e4115 Add auth guard and connection check on mobile 2023-12-02 01:11:04 +01:00
14319a5c89 Rework account system 2023-12-02 01:11:04 +01:00
0ac388f3eb Rework login and navbar account display 2023-12-02 01:11:04 +01:00
fbf43fb10f Rework account storage system 2023-12-02 01:11:04 +01:00
e0f41be887 Expose more react query options to useFetch 2023-12-02 01:11:04 +01:00
bd84989454 Fix episodes comparison 2023-11-29 16:16:10 +01:00
e0b2e8e937 Lint code 2023-11-29 02:21:21 +01:00
f2ebc5659e Only list collections if more than 1 item is contained 2023-11-29 02:21:21 +01:00
b72553aa11 Restore incremental search 2023-11-29 02:21:21 +01:00
0ed35e0354 Fix random sort after id and implement dapper from ids 2023-11-29 02:21:21 +01:00
29d846a944 Allow kind to be used as a filter 2023-11-29 02:21:21 +01:00
9609fb150a Reduce the number of placeholder 2023-11-29 02:21:21 +01:00
9a5c4ab087 Improve duplicated error handling 2023-11-29 02:21:21 +01:00
f59f9a7ba0 Handle movies with the same slug but not the same date 2023-11-29 02:21:21 +01:00
8a925b35dd Fix duplicated episodes error 2023-11-29 02:21:21 +01:00
3e31c51f65 Fix news sort order 2023-11-29 02:21:21 +01:00
3c959ff532 Fix player poster always errored 2023-11-29 02:21:21 +01:00
fa6deb7f82 Fix guid test initialization 2023-11-28 23:27:50 +01:00
b7f5ede7cd Fix guid type issue on front 2023-11-28 23:27:50 +01:00
b2e0363594 Update tests with guids 2023-11-28 23:27:50 +01:00
73f4187087 Create new migration 2023-11-28 23:27:50 +01:00
1f63991ca0 Remove all migrations 2023-11-28 23:27:50 +01:00
8ea8d3ff57 Remove old watched episode and comment out usless people implementation 2023-11-28 23:27:50 +01:00
070a94d87d Switch from int ids to guid 2023-11-28 23:27:50 +01:00
22348e1554 Fix ci 2023-11-27 15:13:08 +01:00
0e2950ab69 Use entrypoint in dockerfiles 2023-11-27 15:13:08 +01:00
2b0f6837a8 Fix tests 2023-11-27 15:13:08 +01:00
ee4cc6706e Convert news items to dapper implementation 2023-11-27 15:13:08 +01:00
948f8694f2 Update front for new filter api and use includes when useful 2023-11-27 15:13:08 +01:00
29314d473f Support collections/id/items via dapper 2023-11-27 15:13:08 +01:00
5f177e9338 Fix count method of dapper 2023-11-27 15:13:08 +01:00
d7dd2bd138 Fix by after Id with random sorting in dapper 2023-11-27 15:13:08 +01:00
ba37786038 Implement a base repository for dapper 2023-11-27 15:13:08 +01:00
179b79c926 Handle images via dapper 2023-11-27 15:13:08 +01:00
411054afe9 Create a helper class to make queries eaiser 2023-11-27 15:13:08 +01:00
067eafbbe4 Fix reverse sorting 2023-11-27 15:13:08 +01:00
253e256458 Add keyset pagination support via generic filters 2023-11-27 15:13:08 +01:00
238fdf5d40 Delete in filter 2023-11-27 15:13:08 +01:00
13ddeaaf0a Add has and enums support 2023-11-27 15:13:08 +01:00
07afbdaa4b Add support for datetimes 2023-11-27 15:13:08 +01:00
0ff74d331f Use new filter on ef 2023-11-27 15:13:08 +01:00
3eff6228be Use new filter in dapper 2023-11-27 15:13:08 +01:00
edc6d11824 Parse new filters 2023-11-27 15:13:08 +01:00
e9aaa184cf Rework filters completly 2023-11-27 15:13:08 +01:00
e8351e960d Add projected relations 2023-11-27 15:13:08 +01:00
0ff03fb413 Support lateral queries on dapper 2023-11-27 15:13:08 +01:00
ba83edd26c Add custom relations on library items (first pass) 2023-11-27 15:13:08 +01:00
eed058c891 Disables many to many eager includes 2023-11-27 15:13:08 +01:00
48f82a6f13 Add include handling for one to one relations for library items 2023-11-27 15:13:08 +01:00
177391a74c Rework default sort and make it work with dapper 2023-11-27 15:13:08 +01:00
9ea177e2f6 Add kind attribute to json serializer 2023-11-27 15:13:08 +01:00
ca6a4d8ab5 Convert library items to an interface 2023-11-27 15:13:08 +01:00
c5a2a05af6 POC for library items includes 2023-11-27 15:13:08 +01:00
0034f93caa Add sort by and try includes for library items 2023-11-27 15:13:08 +01:00
d01ef02389 Fix StudioId casing on the movie 2023-11-27 15:13:08 +01:00
e8f2a72516 Install dapper and use it for library items 2023-11-27 15:13:08 +01:00
bc66d35497 Format front 2023-11-09 22:40:25 +01:00
e1d0d2c186 Cache identify request of the transcoder 2023-11-09 22:40:25 +01:00
e7c878b30a Fix some deprecation warnings 2023-11-09 22:40:25 +01:00
8fb46099d4 Split search sync and search manager to split lifetimes 2023-11-09 22:40:25 +01:00
72628519a5 Fix player hover overflow on really small phones 2023-11-09 22:40:25 +01:00
f7375428b6 Enable strict mode 2023-11-09 22:40:25 +01:00
ead8a44fe0 Differenciate metadata and info skeletons of the player 2023-11-09 22:40:25 +01:00
a1aa71e271 Fix search bar focus state 2023-11-09 22:40:25 +01:00
a72691a81f Add placeholders for the homepage 2023-11-09 22:40:25 +01:00
3be409ec70 Lazy load genre lists on the home page 2023-11-09 22:40:25 +01:00
9409197766 Use a canvas on the front to draw blurhash 2023-11-09 22:40:25 +01:00
1a92094eaf Fix images by updating ef projectables 2023-11-06 14:40:50 +01:00
fa47ccfd85 Fix slow queries by updating ef projectable 2023-11-06 13:59:42 +01:00
6b4468bf7d Format code 2023-11-06 01:24:55 +01:00
b0927b8388 Update and fix jassub 2023-11-06 01:24:55 +01:00
593dc3ca55 Reload subtitles on player ref change 2023-11-06 01:24:55 +01:00
a124a1a71f Disable hls ready callback to play 2023-11-06 01:24:55 +01:00
0e71242fd3 Limit cpu usage 2023-11-06 01:24:55 +01:00
556b2a2317 Cleanup focus reset 2023-11-06 01:24:55 +01:00
4bfd7c348d Unfocus control elements when controls hides 2023-11-06 01:24:55 +01:00
972007f9e5 Fix ratings and durations colors 2023-11-06 01:24:55 +01:00
9bfd1a78bd Use A instead of a Link component for external links 2023-11-06 01:24:55 +01:00
05d8332358 Use smallers chips 2023-11-06 01:24:55 +01:00
dd62611588 Fix no runtime info 2023-11-06 01:24:55 +01:00
f0d6402529 Fix infinite fetch 2023-11-06 01:24:55 +01:00
d73a37fbed Add head details for collections 2023-11-06 01:24:55 +01:00
9084a78420 Update node packages 2023-11-06 01:24:55 +01:00
1769aa45c9 Fix ratings migration default value 2023-11-03 21:13:43 +01:00
3386263fbe Fix metadata link contrast color 2023-11-03 18:12:45 +01:00
0eb7a58494 Limit the number of threads of the api 2023-11-03 18:12:45 +01:00
b995b86cee Add external links on show/movie page 2023-11-03 16:07:19 +01:00
a825912ad3 Add part of collection card on details page 2023-11-03 16:07:19 +01:00
e788dea8a4 Update ef projections 2023-11-03 16:07:19 +01:00
7622420f06 Create a collection page 2023-11-03 16:07:19 +01:00
66fff153e1 Format code 2023-11-03 16:07:19 +01:00
a33171ba87 Add rating and runtime to shows/movies pages 2023-11-03 16:07:19 +01:00
4bb7b4b6c4 Use harcoded s1e1 for items since relations dont work on them 2023-11-03 16:07:19 +01:00
f8e887c1f2 Fix some sizing issues of some scrollbars 2023-11-03 16:07:19 +01:00
47dc244a15 Use react tooltips instead of custom css 2023-11-03 16:07:19 +01:00
f872deffb8 Parse new fields in the front 2023-11-03 16:07:19 +01:00
5489f601d2 Fix items view for collections (sql) 2023-11-03 16:07:19 +01:00
d77813d82f Better healthcheck 2023-11-03 16:07:19 +01:00
b0f9d7906a Relax the fragment failure check of hls 2023-11-03 16:07:19 +01:00
eec08d4a3e Remove useless status check of the seach manager 2023-11-03 16:07:19 +01:00
320c45096b Add collections/id/items, movies and shows 2023-11-03 16:07:19 +01:00
68a83c31be Identify collections from themoviedb 2023-11-03 16:07:19 +01:00
88eb325079 Add PUT /collections/id/movie/id route to link movies/shows to colletions 2023-11-03 16:07:19 +01:00
b2f4933a5f Fix missing name errors 500 2023-11-03 16:07:19 +01:00
e12a1d369d Add a firstEpisode field on the backend 2023-11-03 16:07:19 +01:00
c4f1e420f8 Add runtime on the back 2023-11-03 16:07:19 +01:00
15a4280a36 Add ratings 2023-11-03 16:07:19 +01:00
3e39ef1705 Use a greater healthcheck timer 2023-11-01 21:18:43 +01:00
0dd3a6190e Fix meilisearch init 2023-11-01 21:14:29 +01:00
f03fbd42df Upgrade restart policy of the docker compose 2023-11-01 17:40:41 +01:00
dfc86e4b96 Fix tests 2023-11-01 17:36:11 +01:00
167e2853f0 Load every items from postgres on meilisearch creation 2023-11-01 17:36:11 +01:00
1698de332c Add href to news episode items 2023-11-01 17:36:11 +01:00
377d85c7f1 Add sorts to search items 2023-11-01 17:36:11 +01:00
68a3af0b52 Fix meilisearch indexes setup 2023-11-01 17:36:11 +01:00
5b7bfa79f9 Fix repositories create/edit/delete events 2023-11-01 17:36:11 +01:00
d7dee62e97 Add items index on meilisearch 2023-11-01 17:36:11 +01:00
4368f0cbe5 Setup meilsearch (part 1) 2023-11-01 17:36:11 +01:00
12f35fefc4 Add from id in repository 2023-11-01 17:36:11 +01:00
49a1dad51e wip 2023-11-01 17:36:11 +01:00
40c0403962 Add show thumbnail as backup for new episodes 2023-10-30 15:25:19 +01:00
068e153ae9 Use bigger episodes size in the news list 2023-10-30 15:25:19 +01:00
42869cb28f Style episodes in the news list 2023-10-30 15:25:19 +01:00
56a96540b4 Add show info on news episode, Add news on the front 2023-10-30 15:25:19 +01:00
5a6bb57fd5 Add news view in the db 2023-10-30 15:25:19 +01:00
44521d0d5f Add news repository and api 2023-10-30 15:25:19 +01:00
43a4a0e6ee Fix seasons list when there is no items 2023-10-29 21:37:53 +01:00
1373d0ce26 Add images links on the front instead of the back 2023-10-29 21:37:53 +01:00
c9c1ac5126 Cleanup hotfix thanks to the new option in Projectable 2023-10-29 00:58:56 +02:00
d136b98411 Update ef projectables 2023-10-28 23:27:57 +02:00
7e0e359f46 Hotfix next/previous episodes causing a 500 2023-10-28 22:32:42 +02:00
86427cf6ef Fix fields serialization 2023-10-27 22:44:45 +02:00
c7db07f7ba Add fields bindings 2023-10-27 22:44:45 +02:00
d3fbec1a9d Add include as a first class param and remove library manager thing 2023-10-27 22:44:45 +02:00
c621c45695 Add episodes count on the front 2023-10-27 02:46:31 +02:00
bb456738f0 Use privat prerelease version of ef.projectable 2023-10-27 02:46:31 +02:00
0112acdd2f wip update things 2023-10-27 02:46:31 +02:00
ae6121f3aa Fix seasons add 2023-10-27 02:46:31 +02:00
9b606cf9ac Add episode count in season 2023-10-27 02:46:31 +02:00
234d3c9c7c Fix ci 2023-10-27 00:47:57 +02:00
ce4663d512 Fix some aria items 2023-10-27 00:47:57 +02:00
97de98b89a Add seed in random queries next url 2023-10-27 00:47:57 +02:00
76d0c53cc1 Disable infinite fetch on some elements of the home 2023-10-27 00:47:57 +02:00
8b102b083f Use null safety 2023-10-27 00:47:57 +02:00
e13f9c6aa8 Allow random queries to be paginated 2023-10-27 00:47:57 +02:00
e8b929d4ca Clean up fetch story by allowing hook fetch 2023-10-27 00:47:57 +02:00
034f048883 Add browse link on home page 2023-10-22 01:00:34 +02:00
aceb6ee14c Fix home page for small screens 2023-10-22 01:00:34 +02:00
7698a1490e Format code 2023-10-22 01:00:34 +02:00
59a25fbee9 Clean up home page margins 2023-10-22 01:00:34 +02:00
fc598838c4 Disable empty genre list during ssr 2023-10-22 01:00:34 +02:00
11712b5b13 Add recommanded list 2023-10-22 01:00:34 +02:00
d2799adad0 Add recommanded card hover 2023-10-22 01:00:34 +02:00
872639dab9 Add play button on the recommanded card 2023-10-22 01:00:34 +02:00
e4562648ba Finish a basic recommanded card 2023-10-22 01:00:34 +02:00
941137ff51 Make images quality higher 2023-10-22 01:00:34 +02:00
eaec736676 Remove invalid next/prev in pages sorted by random 2023-10-22 01:00:34 +02:00
9ba7cb1ba5 Add darkOverlay in theme 2023-10-22 01:00:34 +02:00
2ce8e7f866 wip Add recommanded cards 2023-10-22 01:00:34 +02:00
5a618a8db2 Add random genres list to the home page 2023-10-22 01:00:34 +02:00
d21e4ffba2 Add a basic home page header 2023-10-22 01:00:34 +02:00
28855046b8 Fix ci 2023-10-18 00:09:06 +02:00
eb351f9bed Use css grid for infinite lists 2023-10-18 00:09:06 +02:00
0e0bb17ad9 Disable low value trancodes 2023-10-15 15:52:58 +02:00
e95f001dd2 Switch to jassub 2023-10-15 15:49:50 +02:00
0d4b9fe488 Use a better display name for audios 2023-10-12 00:14:40 +02:00
4be4fa2c4f Fix audio identify on some cases 2023-10-12 00:14:40 +02:00
8d4da63855 Fix obfuscated unique ID handling 2023-09-18 00:07:17 +02:00
3a9941f69f Format code 2023-09-16 16:07:30 +02:00
01486dfbec Use better error message for invalid video files 2023-09-15 00:21:33 +02:00
fb2280798a Fix invalid state after cache clear 2023-09-15 00:21:33 +02:00
29f874e390 Fix font detections when there is none 2023-09-15 00:21:33 +02:00
dc6bdf7715 Fix dead links 2023-09-15 00:21:33 +02:00
6022f5b9d2 Disable cursor on player's hover 2023-09-15 00:21:33 +02:00
30b6d4791f Add audio cache audio clear 2023-09-15 00:21:33 +02:00
e5c185627d Clear video cache on new transcode 2023-09-15 00:21:33 +02:00
573852d852 Update README.md 2023-09-13 00:12:29 +02:00
385c580358 Fix safari issue 2023-09-12 18:03:56 +02:00
ec2b0e0f78 Fix eslint warnings 2023-09-11 13:27:04 +02:00
c3816b709c Return more items by default in the api 2023-09-11 13:27:04 +02:00
4b8528af65 Fix show's 404 page 2023-09-11 13:27:04 +02:00
69ba636d74 Update cargo dependancies 2023-09-11 13:27:04 +02:00
1b035035ce Fix pull request docker build 2023-09-11 13:27:04 +02:00
4dc0d6a97c Fix ultrawide infinite scroll 2023-09-11 13:27:04 +02:00
34e4036f66 Fallback to path and modified date if there is no unique id 2023-09-11 01:00:00 +02:00
1dd3e37a37 Use a longer hls timeout delay 2023-09-11 01:00:00 +02:00
e79e568a4c Fix slow transcoder (use mediainfo id instead of sha1) 2023-09-11 01:00:00 +02:00
1641ba2898 Fix item types for android 2023-09-09 22:07:55 +02:00
31d9507033 Fix type issues 2023-09-09 21:47:49 +02:00
67deef897f Add season header 2023-09-09 21:47:49 +02:00
3b84161ec5 Fix some components style 2023-09-09 21:47:49 +02:00
a04bffbec9 Add blurhash container component 2023-09-09 21:47:49 +02:00
7ad1383acb Fix back tests 2023-09-07 22:55:41 +02:00
4217d471c4 Use random image and added date sort on the front 2023-09-07 22:55:41 +02:00
5f6e96333c Add creation date on the db 2023-09-07 22:55:41 +02:00
7962d3a16f Fix library item get all 2023-09-07 22:55:41 +02:00
de6d831498 Prevent resources to use the slug 'random' 2023-09-07 22:55:41 +02:00
be076616cc Add cache policy to images 2023-09-07 22:55:41 +02:00
0a38fdd8d3 Add random sort 2023-09-07 22:55:41 +02:00
2fa5587fbf Fix python version in dockerfile 2023-09-07 22:55:41 +02:00
4bfffa579f Fix contain query param of the api 2023-09-07 22:55:41 +02:00
010fab93d7 Fix player api mismatch bug 2023-09-06 22:01:54 +02:00
6f3eefb611 Improve image finder 2023-09-06 21:06:56 +02:00
328b378978 Filter out unpopular shows 2023-09-06 20:44:51 +02:00
1f518c2d33 Fix missing imdb/tvdb id 2023-09-06 20:44:51 +02:00
a1a5e665fb Fix special season handling 2023-09-06 20:44:51 +02:00
70afa7cc9b Add a space in the tabname (head) 2023-09-06 20:44:51 +02:00
5f1ea76cad Include images without languages in tmdb 2023-09-06 20:44:51 +02:00
462aa44473 Remove language parsing from guessit (fix issues with shows like tenki no ko) 2023-09-06 20:44:51 +02:00
dc0f0df92f Lint the scanner 2023-09-06 00:09:37 +02:00
0ec22766ba Handle series that only have absolte numbering 2023-09-06 00:09:37 +02:00
3549f8b2d2 Handle exact match differently in the scanner 2023-09-06 00:09:37 +02:00
8a3a2fecf5 Improve image selection and prefer original language one 2023-09-06 00:09:37 +02:00
5c8c7b8804 Handle absolute ordering 2023-09-06 00:09:37 +02:00
e88d4c2ca7 Enhance tmdb search ordering 2023-09-06 00:09:37 +02:00
83a91eea97 Use year to filter tv series 2023-09-06 00:09:37 +02:00
13ef0ba14a Fix empty blurhash 2023-09-05 14:18:09 +02:00
938ccd9215 Fix library item issue 2023-09-05 00:36:36 +02:00
d394c390f7 Fix broken next version 2023-09-04 23:54:19 +02:00
4c705a4605 Fix searchbar on web 2023-09-04 18:26:38 +02:00
105aa7874f Feat rework images, delete providers (#191) 2023-09-04 18:24:40 +02:00
27ab3b0b21 Fix mobile compilation 2023-09-04 17:35:24 +02:00
03af604e94 Fix tests 2023-09-04 17:34:34 +02:00
05b8f5b400 Lint code 2023-09-04 00:33:33 +02:00
e8654ca181 Fix front compilation issues 2023-09-04 00:28:18 +02:00
68b4e71281 Lint code 2023-09-02 17:47:43 +02:00
b89617d125 Use posters instead of thumbnails when no thumbnails exist 2023-09-02 17:20:34 +02:00
70466aba7e Fix thumbnails for episodse 2023-09-02 16:31:39 +02:00
5ddfe1ddb2 Update player to use new api 2023-09-01 17:55:18 +02:00
25418071fe Fix splashscreen breaking change 2023-08-31 23:28:32 +02:00
a9d4fb769d Fix show header colors and poster 2023-08-31 21:13:32 +02:00
1faf234255 Use react-native fast images and blurhash on mobile 2023-08-31 16:06:57 +02:00
c06afcd56d Fix thumbnails quality 2023-08-31 16:06:49 +02:00
607b973dbd Rework images to support lazy loading and blurhash (web only) 2023-08-31 11:42:24 +02:00
22e136d9fd Remove expo-image 2023-08-31 01:50:44 +02:00
7b2f44d19a Switch to webp 2023-08-31 01:49:28 +02:00
74c31a0f18 Add taglines on the front 2023-08-12 01:36:26 +09:00
fd3c2e5f9b Add tags on shows and movies 2023-08-12 01:21:17 +09:00
be3724c6b1 Fix some issues 2023-08-11 22:43:05 +09:00
b8e6c21538 Fix type errors 2023-08-09 12:52:27 +09:00
60afaf6211 Add low/medium/high image link on every images 2023-08-09 12:52:06 +09:00
090f305f02 Regenerate lock file 2023-08-09 02:13:54 +09:00
0a30e5022b Fix web error 2023-08-09 02:11:35 +09:00
6733fe9c40 wip Update packages 2023-08-09 00:35:49 +09:00
76ce4b8058 Update expo 2023-08-08 14:57:08 +09:00
36f4bbc7e7 wip front blurhash 2023-08-08 13:31:11 +09:00
30d52c6061 Fix tests 2023-08-08 12:08:51 +09:00
7018915686 Format the scanner 2023-08-07 15:30:47 +09:00
a1fb4ce8eb Fix warnings 2023-08-07 15:29:31 +09:00
5446dbce83 Fix tests compilation errors 2023-08-07 14:50:12 +09:00
93b36f1bd4 Fix image resize not working 2023-08-07 14:50:12 +09:00
ab12de8287 Add next/previous episode field. Add movie load 2023-08-07 14:50:12 +09:00
3cdfc91c93 Implement blurhash 2023-08-07 14:50:12 +09:00
a6c8105d8c Parse images from the scanner 2023-08-07 14:50:12 +09:00
ca99421624 Update library items for new movies 2023-08-07 14:50:12 +09:00
5c270a0362 Handle external ids 2023-08-07 14:50:12 +09:00
19ae15f53f Split movies and shows, enable nullable handling (wip) 2023-08-07 14:50:12 +09:00
386c6bf268 Feat rework images, delete providers 2023-08-07 14:50:12 +09:00
e075306363 Coding style 2023-08-02 00:57:27 +09:00
9591350c3e Allow subtitles menu to be scrolled on android 2023-08-02 00:57:27 +09:00
45b18eb8e6 Display when subtitles are invalid on the web app 2023-08-02 00:57:27 +09:00
0f59798e73 Fix subrip extraction 2023-08-02 00:57:27 +09:00
7b56924466 Fix type issues 2023-08-02 00:57:27 +09:00
3d30d65184 Fix tests 2023-08-02 00:57:27 +09:00
9bb896e84b Format the code 2023-08-02 00:57:27 +09:00
e0ee364929 Add srt support on the web 2023-08-02 00:57:27 +09:00
8e9cd2d2f3 Delete files via the scanner/monitor. Add an ignore folder 2023-08-02 00:57:27 +09:00
f58597379b Fix remaining issues with new track implementation 2023-08-02 00:57:27 +09:00
e6f263b6de Remove track table 2023-08-02 00:57:27 +09:00
c69864d0f5 Delete dotnet file system abstraction 2023-08-02 00:57:27 +09:00
ae901b257b Remove the C transcoder 2023-08-02 00:57:27 +09:00
fdc537d69a Add sub and metadata extraction on the new transcoder 2023-08-02 00:57:27 +09:00
f12c1053ca Try to fix the ci 2023-07-30 23:26:03 +09:00
6435114384 Fix json date serialization settings 2023-07-30 19:25:06 +09:00
c55c3bca72 Fix back arm build 2023-07-30 19:25:06 +09:00
83b8627717 Fix timestamps format 2023-07-30 19:25:06 +09:00
95ccceb259 Fix warnings 2023-07-30 19:25:06 +09:00
31d8f5f7b9 Update all dotnet libraries 2023-07-30 19:25:06 +09:00
Zoe Roux
f1660bbc74 Update the ci for dotnet 7 2023-07-30 19:25:06 +09:00
Zoe Roux
5d72fe44ab Update to dotnet 7 2023-07-30 19:25:06 +09:00
714b7d845a Fix slug creations 2023-07-25 15:01:23 +09:00
066229eb0e Fix tracks slugs 2023-07-25 15:01:23 +09:00
0f96f02df5 Fix event issue 2023-07-25 15:01:23 +09:00
b753fdd2b0 Fix database migration issue 2023-07-25 15:01:23 +09:00
f9df0b8a12 Fix web menu alligment 2023-07-25 15:01:23 +09:00
db41c55230 Remove database triggers 2023-07-25 15:01:23 +09:00
58b799edb4 Add events when resources are changed 2023-07-25 15:01:23 +09:00
94d3b8676f Persist subtitles 2023-07-20 23:27:52 +09:00
de7aa58195 Fix subtitles on android with transcode 2023-07-20 23:27:52 +09:00
5d4e251251 Allow user to change account when one server does not answer 2023-07-20 23:27:52 +09:00
45baa804e6 Add login timeout 2023-07-20 23:27:52 +09:00
2c49848dd7 Make video touch nicer to use on mobile 2023-07-20 23:27:52 +09:00
be499b3085 Replace episodes in history instead of pushing them 2023-07-20 23:27:52 +09:00
4fde5fb65f Fix hydratation error 2023-07-20 23:27:52 +09:00
4c84f857e7 Use different caches for differents servers 2023-07-20 23:27:52 +09:00
1e55b7bf50 Move android specific code to android specific file 2023-07-20 23:27:52 +09:00
479d3e9f07 Handle automatic store publish 2023-07-15 23:59:04 +09:00
dcf14c6e6f Fix web issue 2023-07-15 22:32:50 +09:00
96d5ca0f3c Fix web build 2023-07-15 20:57:50 +09:00
32fa639d4a Add token and client id on the android player 2023-07-15 20:57:50 +09:00
69760dd5f8 Finish multi accounts 2023-07-15 20:57:50 +09:00
1237a9157c wip: Replace the secure store 2023-07-15 20:57:50 +09:00
fee59833f2 Add a multiaccount menu on mobile 2023-07-15 20:57:50 +09:00
12f685010b Add icons for logout and delete account 2023-07-15 20:57:50 +09:00
6ac8af9946 Fix the connection error retry button 2023-07-15 20:57:50 +09:00
e8d4c128da Fix error page style 2023-07-15 20:57:50 +09:00
d2a5d4b3ec Fix account verification error not showing 2023-07-15 20:57:50 +09:00
7797a7bf53 Fix video fit 2023-07-15 20:57:50 +09:00
e5430a7aed Fix master m3u8 audio comma 2023-07-05 22:29:43 +09:00
88cd4a3ec2 Cargo fmt 2023-07-04 11:57:56 +09:00
8650c2d4c8 Fix media session duration issues 2023-07-04 11:57:56 +09:00
1734e57d43 Add error handling in the transcoder 2023-07-04 11:57:56 +09:00
28d0fc161b Fix web player episode name overflow 2023-07-04 11:57:56 +09:00
8ebc767b76 Automatically clear the transcoder cache 2023-06-20 14:13:57 +09:00
bbe8a19189 Use another watchfile library 2023-06-20 11:35:48 +09:00
4bffd359b9 Rework the scanner register check
Store all paths already registered in memory instead of asking kyoo for
each path individually. This should help reduce high response time of
kyoo on startup.
2023-06-20 11:35:48 +09:00
08bbfd91fe Add a privacy policy 2023-06-15 11:17:16 +09:00
1e3cd64ec9 Update the readme for google play 2023-06-14 22:25:07 +09:00
663de0e720 Add a delete account button 2023-06-14 16:56:55 +09:00
7cffd75749 Create an alert method 2023-06-14 16:56:55 +09:00
327ea4912a Use aab for android production builds 2023-06-14 11:47:07 +09:00
efa743a714 Fix web compilation 2023-06-14 11:20:44 +09:00
cd44e8e4c3 Fix account menu on android 2023-06-14 11:20:44 +09:00
e185625f4a Fix account button size 2023-06-14 11:20:44 +09:00
3e140e4f43 Fix incremental queries 2023-06-14 11:20:44 +09:00
47a22b6540 Always name audio tracks 2023-06-14 11:20:44 +09:00
72e74cea32 Fix hover issues on android 2023-06-14 11:20:44 +09:00
4993ae50fe Cleanup the etails page 2023-06-14 11:20:44 +09:00
eeb111dd9e Fix details page issue 2023-06-14 11:20:44 +09:00
4bb992fc67 Add header props on infinite lists 2023-06-14 11:20:44 +09:00
58040f8f49 Fix expo router 2023-06-14 11:20:44 +09:00
4f2cefb1be Implement quality and audio picker on android 2023-06-14 11:20:44 +09:00
2b33191db7 Fix browse page 2023-06-14 11:20:44 +09:00
0969d68adc Rework login guard on android 2023-06-14 11:20:44 +09:00
86533153bf Allow the login page to be scrolled 2023-06-14 11:20:44 +09:00
6349763abc Automatically load the login page on mobile 2023-06-14 11:20:44 +09:00
67693d6c31 Fix yarn packages mismatches 2023-06-14 11:20:44 +09:00
31a757a5cd Fix expo doctor 2023-06-14 11:20:44 +09:00
2c59dddca0 Add apk to releases 2023-06-14 11:20:44 +09:00
206466f9cc Fix variable bitrate videos 2023-06-14 11:20:44 +09:00
039c644453 Fix infinite scroll behavior of details page 2023-06-10 01:36:36 +09:00
5d377654aa Update master to the nex transcoder (#176) 2023-06-06 03:01:43 +09:00
ff163026c7 Disable sonarcloud 2023-06-05 23:25:29 +09:00
1d431ecad6 Add error logs for fullscreen change on the front 2023-06-05 23:08:47 +09:00
6a4c2c6aea Switch to the pointer event api instead of the pressable api on the player to support firefox android 2023-06-05 23:08:47 +09:00
3f928ad507 Fix firefox play/pause loop 2023-06-04 15:14:19 +09:00
735edf1529 Fix multi channels audio issues 2023-06-04 15:14:19 +09:00
f49882fb0d Fix live hls issues 2023-06-04 15:14:19 +09:00
6f4936f6be Fix transcoder docker 2023-06-01 14:59:48 +09:00
e8eb36284b Fix transcoder ci build 2023-06-01 04:03:30 +09:00
cec8400145 Disable the transcode with the same quality as the original tramsux 2023-06-01 04:03:30 +09:00
22d8ea8215 Fix audio index 2023-06-01 04:03:30 +09:00
e6a6131a14 Fix time update on the web player 2023-06-01 04:03:30 +09:00
92b5e33940 Fix ctranscoder dockerfiles 2023-06-01 04:03:30 +09:00
63f7a75394 Add transmux to the hls playlist 2023-06-01 04:03:30 +09:00
dbe85322ea Fix mediainfo number parsing 2023-06-01 04:03:30 +09:00
64d4ee9168 Implement chapter detection 2023-06-01 04:03:30 +09:00
f7f40be956 Implement a naive identify invoking mediainfo 2023-06-01 04:03:30 +09:00
f42eaeb953 Fix duplicated code issue 2023-05-05 14:14:04 +09:00
954909fecd Format code 2023-05-05 14:14:04 +09:00
95133deeb0 Add audio menu and rework qualities menu 2023-05-05 14:14:04 +09:00
8ba80e93e3 Add audio transcoding 2023-05-05 14:14:04 +09:00
47c7617d24 Split transcode commands and state 2023-05-05 14:14:04 +09:00
a5fc5b3753 Add audio transcode functions 2023-05-05 14:14:04 +09:00
0b2d8a7e2e Add routes for audio streams 2023-05-05 14:14:04 +09:00
5ee0a0044a Add all metadata to quality variants in the master playlist 2023-05-05 14:14:04 +09:00
6e39690d7a Create a master playlist 2023-05-05 14:14:04 +09:00
ca4e9e0052 Add bandwidth flags to ffmpeg transcodes 2023-05-05 14:14:04 +09:00
f76ce5dae1 Fix transcode upscale 2023-05-05 14:14:04 +09:00
4e4a90b2d2 Switch to the hls encoder instead of segments 2023-05-05 14:14:04 +09:00
98f6fda99f Add a video field to the identify 2023-05-05 14:14:04 +09:00
9a125e0359 Add transcode quality on the front 2023-05-05 14:14:04 +09:00
3778b2148c Lint rust files 2023-05-05 14:14:04 +09:00
3ab76006af Create a proxy for the trasncoder 2023-05-05 14:14:04 +09:00
c96db3a3dc Add openapi spec for the transcoder 2023-05-05 14:14:04 +09:00
ea52ce1c65 Add identify types 2023-05-05 14:14:04 +09:00
f80289aef1 Add identify route 2023-05-05 14:14:04 +09:00
5cdcff0cd0 Add episodes to the transcoder 2023-05-05 14:14:04 +09:00
4c523d56f5 Fetch paths from the api 2023-05-05 14:14:03 +09:00
67e4764a72 Wait for the first segment to exist before sending the m3u8 2023-05-05 14:14:03 +09:00
e7ace4d497 Add errors messages and fix segments 2023-05-05 14:14:03 +09:00
c6edf4e2cb Add segments route 2023-05-05 14:14:03 +09:00
2939ea0787 Allow the transcoder to be run 2023-05-05 14:14:03 +09:00
64adc63920 Make a clean transcoder state 2023-05-05 14:14:03 +09:00
33d212bd84 Add transcode cmd paramters 2023-05-05 14:14:03 +09:00
5543bc4c9d Migrate to actix 2023-05-05 14:14:03 +09:00
d106988fd7 Add transcoder's dockerfile 2023-05-05 14:14:03 +09:00
bc6fdec360 Create a transcoder crate 2023-05-05 14:14:03 +09:00
a7d8863998 Fix identify when the path has a column in it 2023-04-28 16:16:12 +09:00
a3b2b80c1e Add an error message if the moviedb api key is not set 2023-04-05 16:13:36 +09:00
0b614ec4b6 Add a tldr in the installation readme 2023-04-05 16:13:36 +09:00
0e2c029249 Fix docker's CI for tags 2023-04-05 16:13:36 +09:00
deade0010b Add support for arm builds 2023-04-05 02:23:51 +09:00
e94fae1d85 Update screenshots in readme 2023-04-05 02:15:42 +09:00
259ca2e14e Swap the scanner batch size to 20 2023-04-05 02:15:42 +09:00
e9f9ae5154 Update readme 2023-04-05 02:15:42 +09:00
3b98263fbc Show list headers on error 2023-04-05 02:15:42 +09:00
ca1d2dd16f Up the number of items per batch (scanner) 2023-04-05 02:15:42 +09:00
9e254e6813 Fix episodes duplicate check 2023-04-05 02:15:42 +09:00
9e250e6129 Fix docker compose postgres healthcheck 2023-04-05 02:15:42 +09:00
8f22785d2f Batch scans to prevent auto DDOS 2023-04-05 01:06:55 +09:00
bb716ab6b6 Prevent the scanner from running on non-video files 2023-04-05 00:06:21 +09:00
5acd231292 Make play button for series work 2023-04-04 20:41:25 +09:00
7ebe0adace Disable deferred queries for the search as it does not work 2023-04-04 20:41:25 +09:00
9e3337e9c5 Hide the cursor when playing a video 2023-04-04 20:41:25 +09:00
298dc9af27 Add trailler button 2023-04-04 20:41:25 +09:00
840b0c07ff Fix icon buttons not working 2023-04-04 20:41:25 +09:00
592c92785f Automatically download/extract info on API creation (dirtyfix) (#161
* Download thumbnails automatically

* Automatically extract tracks
2023-04-03 20:03:11 +09:00
d0db4815f1 Use json in healthcheck 2023-04-03 20:03:11 +09:00
8cf105a550 Fix coding style 2023-04-03 20:03:11 +09:00
9c6055a52e Add healthchecks on docker 2023-04-03 20:03:11 +09:00
a554b7681f Add healthchecks to the api 2023-04-03 20:03:11 +09:00
cbcc2f30b7 Dockerise the scanner 2023-04-03 20:03:11 +09:00
565125da67 Add a file monitor in the scanner 2023-04-03 20:03:11 +09:00
ec8782ad81 Clean up the scanner 2023-04-03 20:03:11 +09:00
7388719cad Add seasons metadata 2023-04-03 20:03:11 +09:00
75fb4b5809 Add seasons 2023-04-03 20:03:11 +09:00
408873b844 Add a cache for shows 2023-04-03 20:03:11 +09:00
31a349704b Use jsons for serialization 2023-04-03 20:03:11 +09:00
c3b8595cd7 Add kyoo requests for episodes 2023-04-03 20:03:11 +09:00
2334afb3eb Add episodes for themoviedb 2023-04-03 20:03:11 +09:00
ce9dc48d81 Merge translations for seasons 2023-04-03 20:03:11 +09:00
20f7f87072 Add show and seasons for themoviedatabase 2023-04-03 20:03:11 +09:00
a9ce596381 Add episode and show types 2023-04-03 20:03:11 +09:00
8ac5f02d93 Fix a test 2023-04-03 20:03:11 +09:00
10b291b4aa Add genres and studio objects for the scanner 2023-04-03 20:03:11 +09:00
c894f33c11 Add metadataid, original language metadata and genres 2023-04-03 20:03:11 +09:00
1167cfa3a4 Add most metadata information from themoviedb 2023-04-03 20:03:11 +09:00
541a7c9e2b Making the scanner send data to the back 2023-04-03 20:03:11 +09:00
8b2dd048d3 Fix shell.nix 2023-04-03 20:03:11 +09:00
d4d223dbf0 Cleanup error handling 2023-04-03 20:03:11 +09:00
6b9842c9d3 Fix import issue 2023-04-03 20:03:11 +09:00
e2387158dc Add black to lint the scannre 2023-04-03 20:03:11 +09:00
89fbb3a3cf Sending items to the kyoo api 2023-04-03 20:03:11 +09:00
55da64a702 Add the movie database as a provider 2023-04-03 20:03:11 +09:00
edff93917e Create python types 2023-04-03 20:03:11 +09:00
424390417a Make the scanner async 2023-04-03 20:03:11 +09:00
7427de1bb4 Add guessit 2023-04-03 20:03:11 +09:00
42adf023d9 Create a scanner python module 2023-04-03 20:03:11 +09:00
02214a127c Fix ApiKey configuration options 2023-04-03 20:03:11 +09:00
9e98bf3532 Cleanup JWT error messages 2023-04-03 20:03:11 +09:00
86955cf0cb Add ApiKeys authentication 2023-04-03 20:03:11 +09:00
bf281820b9 Remove the weird configuration options, add ApiKeys configuration 2023-04-03 20:03:11 +09:00
4d0dd674ad Fix provider doc 2023-04-03 20:03:11 +09:00
973f9cfdc2 Still apply postgres migration on startuo 2023-04-03 20:03:11 +09:00
13d79c5338 Delete the task system 2023-04-03 20:03:11 +09:00
dca91feff8 Delete tvdb and tmdb providers 2023-04-03 20:03:11 +09:00
505ebb48bc Delete env var 2023-03-19 00:59:51 +09:00
eaa4060f2a Fix transcoder in dockerfile 2023-03-17 02:36:31 +09:00
5e87a669de Add healthcheck for postgres 2023-03-17 02:36:31 +09:00
9ce8043667 Return empty lists for people instead of throwing 2023-03-17 01:30:18 +09:00
edf2941e01 Cleanups 2023-03-17 01:30:18 +09:00
da0c1087e9 Fix library creator task 2023-03-17 01:30:18 +09:00
a4f9d5b461 Trying to fix eas 2023-03-17 01:30:18 +09:00
ebb3b962a8 Fix eas build 2023-03-17 01:30:18 +09:00
38040ba1d3 Fix robot tests 2023-03-17 01:30:18 +09:00
e17b4c6e23 Cleanup config options 2023-03-17 01:30:18 +09:00
03bd5b4c78 Removing config things 2023-03-17 01:30:18 +09:00
ebe2da0309 Delete SQLite tests 2023-03-17 01:30:18 +09:00
201892ea7f Delete SQlite 2023-03-17 01:30:18 +09:00
e12ac9b3a4 Fix build errors 2023-03-16 02:34:28 +09:00
2b86a469a9 Disable moti on the web 2023-03-16 02:34:28 +09:00
dae11994c2 Update lockfile 2023-03-16 02:34:28 +09:00
3e53b28a10 Update packages 2023-03-16 02:34:28 +09:00
4c4e22a0e0 Update expo 2023-03-16 02:34:28 +09:00
b5f8799d0a Automatically sync readme to dockerhub 2023-03-16 02:34:28 +09:00
875c6eaa5e Use dockerhub instead of ghcr 2023-03-15 16:18:49 +09:00
a56af56009 Create a chip component for filters 2023-03-15 15:06:00 +09:00
eee51216b9 Fix icon button hover 2023-03-15 15:06:00 +09:00
73578736bc Update RNW to beta to make search work 2023-03-15 15:06:00 +09:00
33db01cbbf Finish sort menu 2023-03-15 15:06:00 +09:00
a716fd1e22 Add sort by button (v1) 2023-03-15 15:06:00 +09:00
19c3f44d9a Header 2023-03-15 15:06:00 +09:00
ae095b3e2c Fix build errors 2023-03-15 01:22:21 +09:00
eb92eed532 Generate avatar color based on placeholder 2023-03-15 01:22:21 +09:00
2652e558d2 Add focus handling for the details page 2023-03-15 01:22:21 +09:00
262a26e3df Add focus handling for the grid 2023-03-15 01:22:21 +09:00
Zoe Roux
4af4119561 Fix for body scroll bars on the web on some browsers 2023-03-15 01:22:21 +09:00
Zoe Roux
04eae360a7 Rework Pressable to handle ripple on android 2023-03-15 01:22:21 +09:00
Zoe Roux
a6c645c33f Small cleanups 2023-03-15 01:22:21 +09:00
4b7f59e2e9 Fix tests 2023-03-14 03:04:29 +09:00
da17fc3e6d Fix warnings 2023-03-14 03:04:29 +09:00
b62af8d2ae Handle mixed nulls for sorts and pagination 2023-03-14 03:04:29 +09:00
ef3e4dc39b Fix limit reverse issue 2023-03-14 03:04:29 +09:00
fbe624ca6d Add previous page support 2023-03-14 03:04:29 +09:00
67112a37da Rework exception handling 2023-03-14 03:04:29 +09:00
c0c263c4d7 Rework sort system to allow multiples keys 2023-03-14 03:04:29 +09:00
e32c09f48f Fix studio error in the movie header 2023-03-14 03:04:29 +09:00
91aa673dcb Fix navbar zindex 2023-03-14 03:04:29 +09:00
95257771a5 Automatically create libraries 2023-03-14 03:04:29 +09:00
fa6bb695f3 Update master to the next front. (#145) 2023-03-11 13:19:58 +09:00
9f5b5282b1 Fix build error 2023-03-11 12:54:21 +09:00
ea53eb9b24 Add logout button for logged in users 2023-03-11 12:54:21 +09:00
98a0466761 Display a login button when the user is loggedout 2023-03-11 12:54:21 +09:00
e3be74d519 Handle token refresh on SSR 2023-03-11 12:54:21 +09:00
fdc6a88317 Add login indicator 2023-03-11 12:54:21 +09:00
d67bd62393 Create shell.nix 2023-03-11 12:54:21 +09:00
Zoe Roux
ea986917af Add login and register calls in the front 2023-03-11 12:54:21 +09:00
Zoe Roux
ffbf4be19e Create login and register function 2023-03-11 12:54:21 +09:00
Zoe Roux
2b87aacc58 Add a register page 2023-03-11 12:54:21 +09:00
Zoe Roux
b62b272492 Adding login errors 2023-03-11 12:54:21 +09:00
Zoe Roux
e5027cf00d Add server address on the login page 2023-03-11 12:54:21 +09:00
Zoe Roux
e7b4c01f93 Use an svg blob for the login page 2023-03-11 12:54:21 +09:00
Zoe Roux
304951e463 Create a simple login page 2023-03-11 12:54:21 +09:00
Zoe Roux
e9622edee9 Add more features om the input primitive 2023-03-11 12:54:21 +09:00
Zoe Roux
80be960f29 Update pressable's feedback ripple 2023-03-11 12:54:21 +09:00
Zoe Roux
d2d736a7ec Create a button component 2023-03-11 12:54:21 +09:00
Zoe Roux
341d799207 Bootstrap login page 2023-03-11 12:54:21 +09:00
Zoe Roux
91289c8588 Fix Yoshiki ssr mismatch 2023-03-11 12:54:21 +09:00
Zoe Roux
bc878a2e90 Fix keyboard bindings 2023-03-11 12:54:21 +09:00
Zoe Roux
bb4e7b7712 Fix episode name without metadata 2023-01-08 01:52:11 +09:00
Zoe Roux
dad0a7d30a Fix web issues 2023-01-08 01:38:54 +09:00
Zoe Roux
b0ea38b047 Merge pull request #139 from AnonymusRaccoon/native 2023-01-07 23:47:28 +09:00
Zoe Roux
9c35801196 Update yoshiki 2023-01-07 23:30:49 +09:00
Zoe Roux
f5338fc8a8 Fix CI 2023-01-07 21:08:10 +09:00
Zoe Roux
aa38b34191 Fix typescript errors 2023-01-07 21:01:40 +09:00
Zoe Roux
01eae3f680 Create a ci for the front 2023-01-07 21:01:40 +09:00
Zoe Roux
6a098b6317 Fix alpha handling 2023-01-07 14:22:29 +09:00
Zoe Roux
e242867ddb Fix coding style 2023-01-07 14:22:29 +09:00
Zoe Roux
e11af205f8 Add automatic theme on the web 2023-01-07 14:22:29 +09:00
Zoe Roux
9dc9431170 Add a (rudimentary) splash screen 2023-01-07 14:22:29 +09:00
Zoe Roux
1e182e0d75 Install poppins as a font 2023-01-07 14:22:29 +09:00
Zoe Roux
a501c8e571 Add mobile support for the search bar 2023-01-07 14:22:29 +09:00
Zoe Roux
95eb703788 Make search bar collapse on small screen 2023-01-07 14:22:29 +09:00
Zoe Roux
942f4f1c75 Create a search page 2023-01-07 14:22:29 +09:00
Zoe Roux
8ca120aa6f Add items search support 2023-01-07 14:22:29 +09:00
Zoe Roux
1f33d52429 Remove unused files and packages 2023-01-07 14:22:29 +09:00
Zoe Roux
257e78dcaa Fix production build 2023-01-07 14:22:29 +09:00
Zoe Roux
b88cd583d3 Player cleanups 2022-12-31 01:01:38 +09:00
Zoe Roux
67da1563be Add hls support on the web 2022-12-31 01:01:38 +09:00
Zoe Roux
4b92b8a38e Add subtitles support for the web 2022-12-31 01:01:38 +09:00
Zoe Roux
39ae631cf1 Adding a web compatibility layer 2022-12-31 01:01:38 +09:00
Zoe Roux
84b4c998a7 Use react-native-video instead of expo-av and add subtitle support 2022-12-31 01:01:38 +09:00
Zoe Roux
e741b5aa6d Fix eas build and add expo dev client 2022-12-31 01:01:38 +09:00
Zoe Roux
162891ba1d Create the subtitle menu for the web 2022-12-31 01:01:38 +09:00
Zoe Roux
1139a726c9 Create menu (bottom sheet or side sheet) 2022-12-31 01:01:38 +09:00
Zoe Roux
b0eb8c3b42 Fix fullscreen handling 2022-12-31 01:01:38 +09:00
Zoe Roux
7315d5f5a1 Add keyboard input for the player on the web 2022-12-31 01:01:38 +09:00
Zoe Roux
7a1bde1b73 Add volume slider (keyboard accessible)
Fix tooltip position on the bottom of the screen.
Add fullscreen support on the web
2022-12-31 01:01:38 +09:00
Zoe Roux
b1b8772717 Add progress change listneer to update the video 2022-12-31 01:01:38 +09:00
Zoe Roux
856eaffda6 Add slider touch handlers 2022-12-31 01:01:38 +09:00
Zoe Roux
2c16fdad19 Add load and error state 2022-12-31 01:01:38 +09:00
Zoe Roux
c79a991024 Rewrite progress slider (part 1) 2022-12-31 01:01:38 +09:00
Zoe Roux
7b8d916685 Fix layout handling on the web via hoc 2022-12-31 01:01:38 +09:00
Zoe Roux
3c447f5708 Rework of the hover 2022-12-31 01:01:38 +09:00
Zoe Roux
4f5023f745 Add a circular progress component 2022-12-31 01:01:38 +09:00
Zoe Roux
2c5d37083b Add types for subtitles octopus 2022-12-31 01:01:38 +09:00
Zoe Roux
4f6024a473 Move the player to the ui package 2022-12-31 01:01:38 +09:00
Zoe Roux
2ac4c434f5 Make episode list work on mobile 2022-12-18 12:07:19 +09:00
Zoe Roux
eabf5e1faf Clean up episode list skeleton 2022-12-18 12:07:19 +09:00
Zoe Roux
1ee955fbfe Add an episode list for shows 2022-12-18 12:07:19 +09:00
Zoe Roux
de06c7f81f Movie cleanup 2022-12-18 12:07:19 +09:00
Zoe Roux
4347df0b9b Use svg icons instead of a font 2022-12-18 12:07:19 +09:00
Zoe Roux
b951ef5ce4 Fix staff list scroll behaviors 2022-12-18 12:07:19 +09:00
Zoe Roux
a12f78761d Cleanup layout and expo's withRoute 2022-12-18 12:07:19 +09:00
Zoe Roux
894cbb3c9d Rewrite infinite lists to support horizontal 2022-12-18 12:07:19 +09:00
Zoe Roux
26f9cf646b Adapt staff list to react native (first pass) 2022-12-18 12:07:19 +09:00
Zoe Roux
8c28df9517 Clean up movie's skeleton 2022-12-18 12:07:19 +09:00
Zoe Roux
1b76bbf6c2 Finish movie's header rework 2022-12-18 12:07:19 +09:00
Zoe Roux
e5b236f51c Rewrite the movie header 2022-12-18 12:07:19 +09:00
Zoe Roux
a213c39445 Clean up to prepare headers 2022-12-11 21:54:39 +09:00
Zoe Roux
be6551888e Add list view on browse 2022-12-11 21:54:39 +09:00
Zoe Roux
3b29e1a87a Make the main scroll instead of the body. Support other layouts 2022-12-11 21:54:39 +09:00
Zoe Roux
bb63340555 Create a link component with native feedback 2022-12-11 21:54:39 +09:00
Zoe Roux
24dddc3075 Finalize browse's grid layout 2022-12-11 21:54:39 +09:00
Zoe Roux
47ca25fe1c Add an infinite scroll on web and native 2022-12-11 21:54:39 +09:00
Zoe Roux
1cd418991c Allow kyoo url to be configured on docker 2022-12-11 21:54:39 +09:00
Zoe Roux
d15c3ed047 Add a poster component for react-native 2022-12-11 21:54:39 +09:00
Zoe Roux
26e5ce6852 Add skeleton hide animation.
Also hide the skeleton when the user has disabled js.
2022-12-11 21:54:39 +09:00
Zoe Roux
f834e08273 Create a homemade skeleton
with moti and css animations
2022-12-11 21:54:39 +09:00
Zoe Roux
26e40adb21 Make queries work on mobile 2022-12-11 21:54:39 +09:00
Zoe Roux
43ed65bc76 Rewrite the browse page (part 1) 2022-12-11 21:54:39 +09:00
Zoe Roux
1f049952cc Theme the focus ring 2022-12-06 15:17:55 +09:00
Zoe Roux
869c1fbe51 Add react native translation 2022-12-06 15:17:55 +09:00
Zoe Roux
5b78146db9 Add nextjs translations (via i18next) 2022-12-06 15:17:55 +09:00
Zoe Roux
fff73ed2b8 Add a tooltip function 2022-12-06 15:17:55 +09:00
Zoe Roux
71a506443f Add a skeleton component 2022-12-05 12:21:04 +09:00
Zoe Roux
2e50be6254 Install moti 2022-12-05 12:21:04 +09:00
Zoe Roux
ceaafc495d Merge pull request #129 from AnonymusRaccoon/feat/models
Add a model package and a fetch component
2022-12-03 22:57:06 +09:00
Zoe Roux
67de27578e Add error handling in the fetch component 2022-12-03 22:34:50 +09:00
Zoe Roux
e82e515a23 Fix zod utils import 2022-12-03 19:15:15 +09:00
Zoe Roux
20c740ce07 Add a fetch component 2022-12-03 11:33:58 +09:00
Zoe Roux
9a9538d14d Remake the appbar 2022-12-01 16:37:31 +09:00
Zoe Roux
ca50b53bae Merge branch 'feat/native-navbar' into feat/style 2022-11-30 14:43:26 +09:00
Zoe Roux
d420c7d0a9 Install react navigation 2022-11-30 14:03:38 +09:00
Zoe Roux
4195371efb Update expo version 2022-11-30 11:19:39 +09:00
Zoe Roux
27e309f04d wip 2022-11-29 21:04:14 +09:00
Zoe Roux
b20a4fa149 Add yoshiki 2022-11-23 00:02:34 +09:00
Zoe Roux
2c4bcb9c39 Create CssObject type 2022-11-04 02:45:34 +09:00
Zoe Roux
07b41716e8 wip Native navbar 2022-11-04 01:08:03 +09:00
Zoe Roux
e92e7758e7 Add a primitive package 2022-11-04 01:05:34 +09:00
Zoe Roux
c64c34a9fb Fix dockerfile 2022-11-02 22:57:31 +09:00
Zoe Roux
a221e6358e Make the ui package work for expo and next 2022-11-02 16:52:57 +09:00
Zoe Roux
f40122d5b2 Add ui package that work with next 2022-11-02 14:29:02 +09:00
Zoe Roux
a065205ea0 Add native dockerfile 2022-11-01 01:54:22 +09:00
Zoe Roux
856f42ce27 Add expo 2022-10-31 23:43:52 +09:00
Zoe Roux
016d50e383 Fix dev dockerfile 2022-10-31 04:30:52 +09:00
Zoe Roux
1507b279f7 Move next to start a monorepo 2022-10-31 04:15:39 +09:00
Zoe Roux
000f7cbfe1 Add theme utils 2022-10-30 02:25:24 +09:00
Zoe Roux
cbbd04efb6 Add catppuccin theme 2022-10-28 02:02:09 +09:00
584 changed files with 50066 additions and 36276 deletions

View File

@@ -9,6 +9,6 @@ indent_style = tab
indent_size = tab
smart_tab = true
[{*.yaml,*.yml}]
[{*.yaml,*.yml,*.nix}]
indent_style = space
indent_size = 2

View File

@@ -1,6 +1,40 @@
TVDB__APIKEY=
THEMOVIEDB__APIKEY=
AUTHENTICATION_SECRET=
POSTGRES_USER=kyoousername
POSTGRES_PASSWORD=kyoopassword
# Useful config options
LIBRARY_ROOT=./video
CACHE_ROOT=/tmp/kyoo_cache
LIBRARY_LANGUAGES=en
# A pattern (regex) to ignore video files.
LIBRARY_IGNORE_PATTERN=.*/[dD]ownloads?/.*
# The following two values should be set to a random sequence of characters.
# You MUST change thoses when installing kyoo (for security)
AUTHENTICATION_SECRET=4c@mraGB!KRfF@kpS8739y9FcHemKxBsqqxLbdR?
# You can input multiple api keys separated by a ,
KYOO_APIKEYS=t7H5!@4iMNsAaSJQ49pat4jprJgTcF656if#J3
DEFAULT_PERMISSIONS=overall.read
UNLOGGED_PERMISSIONS=overall.read
THEMOVIEDB_APIKEY=
PUBLIC_BACK_URL=http://localhost:5000
# Following options are optional and only useful for debugging.
# To debug the front end, you can set the following to an external backend
KYOO_URL=
# The library root inside the container.
KYOO_LIBRARY_ROOT=/video
# Database things
POSTGRES_USER=KyooUser
POSTGRES_PASSWORD=KyooPassword
POSTGRES_DB=kyooDB
POSTGRES_SERVER=postgres
POSTGRES_PORT=5432
MEILI_HOST="http://meilisearch:7700"
MEILI_MASTER_KEY="ghvjkgisbgkbgskegblfqbgjkebbhgwkjfb"
# vi: ft=sh

1
.git-blame-ignore-revs Normal file
View File

@@ -0,0 +1 @@
7e6e56a366babe17e7891a5897180efbf93c00c5

View File

@@ -1,89 +0,0 @@
name: Analysis
on:
push:
branches:
- master
- next
pull_request:
jobs:
analysis:
name: Static Analysis
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
- name: Cache SonarCloud packages
uses: actions/cache@v1
with:
path: ~/sonar/cache
key: ${{ runner.os }}-sonar
restore-keys: ${{ runner.os }}-sonar
- name: Cache SonarCloud scanner
id: cache-sonar-scanner
uses: actions/cache@v1
with:
path: ~/.sonar/scanner
key: ${{ runner.os }}-sonar-scanner
restore-keys: ${{ runner.os }}-sonar-scanner
- name: Install SonarCloud scanner
if: steps.cache-sonar-scanner.outputs.cache-hit != 'true'
shell: bash
run: |
cd back
mkdir -p ~/.sonar/scanner
dotnet tool update dotnet-sonarscanner --tool-path ~/.sonar/scanner
- name: Wait for tests to run (Push)
uses: lewagon/wait-on-check-action@master
if: github.event_name != 'pull_request'
with:
ref: ${{github.ref}}
check-name: tests
repo-token: ${{secrets.GITHUB_TOKEN}}
running-workflow-name: analysis
allowed-conclusions: success,skipped,cancelled,neutral,failure
- name: Wait for tests to run (PR)
uses: lewagon/wait-on-check-action@master
if: github.event_name == 'pull_request'
with:
ref: ${{github.event.pull_request.head.sha}}
check-name: tests
repo-token: ${{secrets.GITHUB_TOKEN}}
running-workflow-name: analysis
allowed-conclusions: success,skipped,cancelled,neutral,failure
- name: Download coverage report
uses: dawidd6/action-download-artifact@v2
with:
commit: ${{env.COMMIT_SHA}}
workflow: tests.yml
github_token: ${{secrets.GITHUB_TOKEN}}
- name: Build and analyze
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Needed to get PR information, if any
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
shell: bash
run: |
cp -r results.xml/ coverage.xml/ back/
cd back
find . -name 'coverage.opencover.xml'
dotnet build-server shutdown
~/.sonar/scanner/dotnet-sonarscanner begin \
-k:"AnonymusRaccoon_Kyoo" \
-o:"anonymus-raccoon" \
-d:sonar.login="${{ secrets.SONAR_TOKEN }}" \
-d:sonar.host.url="https://sonarcloud.io" \
-d:sonar.cs.opencover.reportsPaths="**/coverage.opencover.xml" \
-d:sonar.cs.vstest.reportsPaths="**/TestOutputResults.xml"
dotnet build --no-incremental '-p:SkipTranscoder=true'
~/.sonar/scanner/dotnet-sonarscanner end -d:sonar.login="${{ secrets.SONAR_TOKEN }}"

View File

@@ -1,15 +1,72 @@
name: CodingStyle
name: Coding Style
on: [pull_request, workflow_dispatch]
jobs:
build:
name: "Coding style check"
back:
name: "Lint Back"
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./back
steps:
- uses: actions/checkout@v2
- name: Check coding style
run: |
dotnet tool restore
dotnet csharpier . --check
front:
name: "Lint Front"
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./front
steps:
- uses: actions/checkout@v1
- name: Setup .NET
uses: actions/setup-dotnet@v1
- name: Find yarn cache
id: yarn-cache-path
run: echo "::set-output name=dir::$(yarn cache dir)"
- name: Restore cache
uses: actions/cache@v2
with:
dotnet-version: 6.0.x
- name: Build the app
run: cd back && dotnet build -p:CheckCodingStyle=true -p:TreatWarningsAsErrors=true '-p:SkipTranscoder=true'
path: ${{ steps.yarn-cache-path.outputs.dir }}
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
restore-keys: ${{ runner.os }}-yarn-
- name: Install dependencies
run: yarn install --immutable
- name: Lint
run: yarn lint && yarn format
scanner:
name: "Lint scanner"
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./scanner
steps:
- uses: actions/checkout@v1
- name: Run black
run: |
pip install black-with-tabs
black . --check
transcoder:
name: "Lint transcoder"
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./transcoder
steps:
- uses: actions/checkout@v1
- uses: dtolnay/rust-toolchain@stable
- name: Run cargo fmt
run: |
cargo fmt --check

View File

@@ -4,6 +4,8 @@ on:
branches:
- master
- next
tags:
- v*
pull_request:
jobs:
@@ -15,11 +17,17 @@ jobs:
include:
- context: ./back
label: back
image: ghcr.io/${{github.repository_owner}}/kyoo_back
image: zoriya/kyoo_back
- context: ./front
label: front
image: ghcr.io/${{github.repository_owner}}/kyoo_front
name: Docker build ${{matrix.label}}
image: zoriya/kyoo_front
- context: ./scanner
label: scanner
image: zoriya/kyoo_scanner
- context: ./transcoder
label: transcoder
image: zoriya/kyoo_transcoder
name: Build ${{matrix.label}}
steps:
- uses: actions/checkout@v2
with:
@@ -48,18 +56,28 @@ jobs:
uses: docker/setup-buildx-action@v1
- name: Login to DockerHub
uses: docker/login-action@v1
if: ${{env.SHOULD_PUSH}}
uses: docker/login-action@v1
with:
registry: ghcr.io
username: ${{github.repository_owner}}
password: ${{secrets.GITHUB_TOKEN}}
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
- name: Build and push
id: docker_build
uses: docker/build-push-action@v2
with:
context: ${{matrix.context}}
platforms: linux/amd64,linux/arm64
build-args: |
VERSION=0.0.0
push: ${{env.SHOULD_PUSH}}
tags: ${{steps.meta.outputs.tags}}
- name: Sync README.MD
if: ${{env.SHOULD_PUSH}}
uses: ms-jpq/sync-dockerhub-readme@v1
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}
repository: ${{ matrix.image }}
readme: "./README.md"

View File

@@ -1,32 +0,0 @@
name: Update the documentation
on:
push:
branches:
- master
jobs:
Building:
runs-on: [ubuntu-latest]
steps:
- uses: actions/checkout@v1
- uses: nikeee/docfx-action@v1.0.0
name: Build Documentation
with:
args: docs/docfx.json
- name: Update the docs
run: |
cd docs/_site
sudo chown $(whoami):$(whoami) . -R
echo -n docs.kyoo.moe > CNAME
git config --global user.email "${GITHUB_ACTOR}@github.com"
git config --global user.name "${GITHUB_ACTOR}"
git init
git add -A
git commit -m "Deploying the documentation"
git remote add origin https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@${GITHUB_REPO}
git checkout -b gh-pages
git push --force origin gh-pages
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_REPO: "github.com/${{github.repository_owner}}/Kyoo"

69
.github/workflows/native-build.yml vendored Normal file
View File

@@ -0,0 +1,69 @@
name: Native build
on:
push:
branches:
- master
- next
tags:
- v*
jobs:
update:
name: Expo Build
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./front
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Check for EXPO_TOKEN
run: |
if [ -z "${{ secrets.EXPO_TOKEN }}" ]; then
echo "You must provide an EXPO_TOKEN secret linked to this project's Expo account in this repo's secrets. Learn more: https://docs.expo.dev/eas-update/github-actions"
exit 1
fi
- name: Setup Node
uses: actions/setup-node@v2
with:
node-version: 16.x
cache: yarn
cache-dependency-path: front/yarn.lock
- name: Setup Expo
uses: expo/expo-github-action@v7
with:
expo-version: latest
eas-version: latest
token: ${{ secrets.EXPO_TOKEN }}
- name: Install dependencies
run: yarn install --immutable
- name: Build Mobile Release
run: yarn build:mobile | tee log.txt
- name: Parse Asset URL
id: url
run: |
ASSET_URL=$(grep -oe 'https://expo.dev/artifacts/eas/.*' log.txt)
echo The android url is $ASSET_URL
echo "assetUrl=$ASSET_URL" >> $GITHUB_OUTPUT
- name: Download APK Asset
run: wget -O kyoo.apk ${{ steps.url.outputs.assetUrl }}
- uses: actions/upload-artifact@v2
with:
name: kyoo.apk
path: ./front/kyoo.apk
- name: Upload release artifacts
uses: Roang-zero1/github-upload-release-artifacts-action@v2
if: startsWith(github.ref, 'refs/tags/')
with:
args: ./front/kyoo.apk
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

43
.github/workflows/native-update.yml vendored Normal file
View File

@@ -0,0 +1,43 @@
name: Native update
on:
push:
tags:
- v*
jobs:
update:
name: Expo Update
runs-on: ubuntu-latest
defaults:
run:
working-directory: ./front
steps:
- name: Checkout repository
uses: actions/checkout@v2
- name: Check for EXPO_TOKEN
run: |
if [ -z "${{ secrets.EXPO_TOKEN }}" ]; then
echo "You must provide an EXPO_TOKEN secret linked to this project's Expo account in this repo's secrets. Learn more: https://docs.expo.dev/eas-update/github-actions"
exit 1
fi
- name: Setup Node
uses: actions/setup-node@v2
with:
node-version: 16.x
cache: yarn
cache-dependency-path: front/yarn.lock
- name: Setup Expo
uses: expo/expo-github-action@v7
with:
expo-version: latest
eas-version: latest
token: ${{ secrets.EXPO_TOKEN }}
- name: Install dependencies
run: yarn install --immutable
- name: Publish update
run: yarn update

View File

@@ -1,36 +0,0 @@
name: Release
on:
push:
tags:
- v*
workflow_dispatch:
jobs:
release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set commit environment
run: echo "COMMIT_SHA=$(git rev-list -n 1 ${{github.ref}})" >> $GITHUB_ENV
- name: Wait for builds & tests to finish
uses: lewagon/wait-on-check-action@master
with:
ref: ${{github.ref}}
repo-token: ${{secrets.GITHUB_TOKEN}}
running-workflow-name: release
allowed-conclusions: success,skipped,cancelled,neutral
# - name: Public the abstractions to nuget
# id: publish_nuget
# uses: rohith/publish-nuget@v2
# with:
# PROJECT_FILE_PATH: Kyoo.Abstractions/Kyoo.Abstractions.csproj
# PACKAGE_NAME: Kyoo.Abstractions
# VERSION_REGEX: ^\s*<PackageVersion>(.*)<\/PackageVersion>\s*$
# NUGET_KEY: ${{secrets.NUGET_API_KEY}}
# INCLUDE_SYMBOLS: true
- name: Create Release
uses: ncipollo/release-action@v1
with:
generateReleaseNotes: true
token: ${{secrets.GITHUB_TOKEN}}

View File

@@ -8,7 +8,8 @@ on:
jobs:
build:
test:
name: Run Robot Tests
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
@@ -16,24 +17,24 @@ jobs:
submodules: recursive
fetch-depth: 0
- name: Pull images
run: docker-compose pull
run: |
cp .env.example .env
docker compose version
docker compose pull
- name: Docker cache
uses: satackey/action-docker-layer-caching@v0.0.11
continue-on-error: true
- name: Build the app
run: docker-compose build
- name: Start the service
run: |
cp .env.example .env
docker-compose up -d
docker compose up -d back postgres ingress meilisearch # --wait Wait is not available on gha
- name: Perform healthchecks
run: |
docker-compose ps -a
wget --retry-connrefused --retry-on-http-error=502 http://localhost:8901 #/api/healthcheck
docker compose ps -a
docker compose logs
wget --retry-connrefused --retry-on-http-error=502 http://localhost:8901/api/health || (docker compose logs && exit 1)
- name: Run robot tests
run: |
@@ -42,7 +43,7 @@ jobs:
- name: Show logs
if: failure()
run: docker-compose logs
run: docker compose logs
- uses: actions/upload-artifact@v2
with:

View File

@@ -8,8 +8,9 @@ on:
jobs:
tests:
name: Back tests
runs-on: ubuntu-latest
container: mcr.microsoft.com/dotnet/sdk:6.0
container: mcr.microsoft.com/dotnet/sdk:7.0
services:
postgres:
image: postgres
@@ -29,7 +30,7 @@ jobs:
run: |
cd back
dotnet build '-p:SkipTranscoder=true' -p:CopyLocalLockFileAssemblies=true
cp ./out/bin/Kyoo.Abstractions/Debug/net6.0/Microsoft.Extensions.DependencyInjection.Abstractions.dll ./tests/Kyoo.Tests/bin/Debug/net6.0/
cp ./out/bin/Kyoo.Abstractions/Debug/net7.0/Microsoft.Extensions.DependencyInjection.Abstractions.dll ./tests/Kyoo.Tests/bin/Debug/net7.0/
- name: Test
run: |
@@ -37,7 +38,7 @@ jobs:
dotnet test --no-build '-p:CollectCoverage=true;CoverletOutputFormat=opencover' --logger "trx;LogFileName=TestOutputResults.xml"
env:
POSTGRES_HOST: postgres
POSTGRES_USERNAME: postgres
POSTGRES_USER: postgres
POSTGRES_PASSWORD: postgres
- name: Sanitize coverage output

1
.gitignore vendored
View File

@@ -1,5 +1,6 @@
/video
.env
.venv
.idea
.vscode
log.html

5
.pg_format Normal file
View File

@@ -0,0 +1,5 @@
tabs=1
function-case=1 #lowercase
keyword-case=1
type-case=1
no-space-function=1

View File

@@ -1,4 +1,4 @@
# Authors
Ordered by the date of the first commit.
* Zoe Roux ([@AnonymusRaccoon](http://github.com/AnonymusRaccoon))
* Zoe Roux ([@zoriya](http://github.com/zoriya))

View File

@@ -3,21 +3,19 @@
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Contributions to this project are [released](https://docs.github.com/en/github/site-policy/github-terms-of-service#6-contributions-under-repository-license)
to the public under the [GPL-3.0 License](https://github.com/AnonymusRaccoon/Kyoo/blob/master/LICENSE).
to the public under the [GPL-3.0 License](https://github.com/zoriya/Kyoo/blob/master/LICENSE).
## Submitting a pull request
1. [Fork](https://github.com/AnonymusRaccoon/Kyoo/fork) and clone the repository
2. Install the toolstack and/or download precompiled binaries for the transcoder (see [Development & Build](https://github.com/AnonymusRaccoon/Kyoo#development--build))
3. Create a new branch: `git checkout -b my-branch-name`
4. Make your changes (Please try to follow the same coding style as what has already been made - indent with tabs, align with spaces etc)
5. Make sure the tests pass: `dotnet tests`
6. Push to your fork and [submit a pull request](https://github.com/AnonymusRaccoon/Kyoo/compare)
7. Pat your self on the back and wait for your pull request to be reviewed and merged.
1. [Fork](https://github.com/zoriya/Kyoo/fork) and clone the repository
2. Create a new branch: `git checkout -b my-branch-name`
3. Make your changes (Please try to follow the same coding style as what has already been made - indent with tabs, align with spaces etc).
Don't forget to run the auto-formatter.
4. Push to your fork and [submit a pull request](https://github.com/zoriya/Kyoo/compare)
5. Pat your self on the back and wait for your pull request to be reviewed and merged.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Write tests.
- Make sure the `README.md` and any other relevant **documentation are kept up-to-date**.
- We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as **separate pull requests**.

56
INSTALLING.md Normal file
View File

@@ -0,0 +1,56 @@
# Installing
To install Kyoo, you need docker and docker-compose. Those can be installed from here for
[Linux](https://docs.docker.com/engine/install/)
[Mac](https://docs.docker.com/desktop/install/mac-install/)
or [Windows](https://docs.docker.com/desktop/install/windows-install/). Docker is used to run each services of Kyoo in
an isolated environment with all the dependencies they need.
Kyoo also needs 3 files to work properly. Two of them can simply be copy-pasted from this repository, the other needs to be filled in with your configurations.
Those files can be put in any directory of your choice.
Those 3 files are:
- A `docker-compose.yml` (simply copy docker-compose.prod.yml from [here](https://raw.githubusercontent.com/zoriya/Kyoo/master/docker-compose.prod.yml)).
- A `nginx.conf.template` copied from [here](https://raw.githubusercontent.com/zoriya/Kyoo/master/nginx.conf.template).
- A `.env` file that you will need to **fill**. Look at the example [.env.example](https://raw.githubusercontent.com/zoriya/Kyoo/master/.env.example)
> If you want an explanation of what are those files, you can read the following:
> The `docker-compose.yml` file describes the different services of Kyoo, where they should be downloaded and their start order. \
> The `nignx.conf.template` file describes which service will be called when accessing the URL of Kyoo. \
> The `.env` file contains all the configuration options that the services in `docker-compose.yml` will read.
To retrieve metadata, Kyoo will need to communicate with an external service. For now, that is `the movie database`.
For this purpose, you will need to get an API Key. For that, go to [themoviedb.org](https://www.themoviedb.org/) and create an account, then
go [here](https://www.themoviedb.org/settings/api) and copy the `API Key (v3 auth)`, paste it after the `THEMOVIEDB_APIKEY=` on the `.env` file.
The next and last step is actually starting Kyoo. To do that, open a terminal in the same directory as the 3 configurations files
and run `docker-compose up -d`.
Congratulation, everything is now ready to use Kyoo. You can navigate to `http://localhost:8901` on a web browser to see your instance of Kyoo.
# Installing TLDR
1. Install docker & docker-compose
2. Download the
[`docker-compose.yml`](https://raw.githubusercontent.com/zoriya/Kyoo/master/docker-compose.prod.yml),
[`nginx.conf.template`](https://raw.githubusercontent.com/zoriya/Kyoo/master/nginx.conf.template) and
[`.env`](https://raw.githubusercontent.com/zoriya/Kyoo/master/.env.example) files
3. Fill the `.env` file with your configuration options (and an API Key from [themoviedb.org](https://www.themoviedb.org/))
4. Run `docker-compose up -d`
# Updating
Updating Kyoo is exactly the same as installing it. Get an updated version of the `docker-compose.yml` and `nginx.conf.template` files and
unsure that your `.env` contains all the options specified in the updated `.env.example` file.
After that, you will need to update Kyoo's services. For that, open a terminal in the configuration's directory and run
the command `docker-compose pull`. You are now ready to restart Kyoo, you can run `docker-compose up -d`.
You can also enable automatic updates via an external tool like [watchtower](https://containrrr.dev/watchtower/).
TLDR: `docker run -d --name watchtower -e WATCHTOWER_CLEANUP=true -e WATCHTOWER_POLL_INTERVAL=86400 -v /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower`
# Uninstalling
To uninstall Kyoo, you need to open a terminal in the configuration's directory and run `docker-compose down`. This will
stop Kyoo's services. You can then remove the configuration files.

44
PRIVACY.md Normal file
View File

@@ -0,0 +1,44 @@
# Privacy Policy for Kyoo
Effective Date: 2023-06-15
Thank you for using Kyoo. This Privacy Policy outlines how we collect, use, and protect your personal information when you use our service. We are committed to ensuring the privacy and security of your data. Please read this policy carefully to understand our practices regarding your information.
### 1. Information We Collect:
We collect and store only the email addresses you provide during the registration process. No other personal information is requested or stored.
### 2. Use of Personal Information:
We use your email address solely for the purpose of user authentication and login. We do not use, access, or share your email address with any third parties.
### 3. Data Storage and Security:
All personal information, limited to email addresses, is stored securely on our self-hosted servers. We take appropriate technical and organizational measures to protect against unauthorized access, alteration, disclosure, or destruction of your personal information.
### 4. Data Sharing:
We do not share any personal information, including email addresses, with any third parties. Your data remains confidential and is used only for the purposes stated in this Privacy Policy.
### 5. Account Deletion:
You have the right to delete your Kyoo account at any time. To do so, please click on the `Delete your account` button on the account's menu of the app/website. Upon account deletion, all associated personal information, including your email address, will be permanently and irreversibly removed from our servers.
### 6. Cookies and Tracking Technologies:
Kyoo does not use any cookies or tracking technologies to collect or store user information.
### 7. Legal Basis for Processing:
Our collection and processing of your email address is based on your consent, as it is necessary for the performance of the contract between you and Kyoo.
### 8. Changes to this Privacy Policy:
We may update this Privacy Policy from time to time. Any changes will be posted on this page, and the effective date will be indicated at the top of the policy. Please review this policy periodically for any updates.
### 9. Contact Us:
If you have any questions, concerns, or requests regarding this Privacy Policy or the processing of your personal information, please contact us at https://github.com/zoriya/kyoo/issues.
By using Kyoo, you acknowledge and agree to the practices described in this Privacy Policy.

View File

@@ -1,12 +1,4 @@
# <img width="24px" src="./icons/icon-256x256.png" alt="Kyoo"> Kyoo
<p>
<a href="https://github.com/AnonymusRaccoon/Kyoo/actions/workflows/build.yml"><img src="https://img.shields.io/github/workflow/status/AnonymusRaccoon/Kyoo/Build?style=flat-square" alt="Build status"></a>
<a href="https://github.com/AnonymusRaccoon/Kyoo/actions/workflows/tests.yml"><img src="https://img.shields.io/github/workflow/status/AnonymusRaccoon/Kyoo/Testing?label=tests&style=flat-square" alt="Tests status"></a>
<a href="https://github.com/users/AnonymusRaccoon/packages/container/package/kyoo"><img src="https://img.shields.io/github/workflow/status/AnonymusRaccoon/Kyoo/Docker?label=docker&style=flat-square" alt="Docker status"/></a>
<a href="https://sonarcloud.io/dashboard?id=AnonymusRaccoon_Kyoo"><img src="https://img.shields.io/sonar/tests/AnonymusRaccoon_Kyoo?compact_message&server=https%3A%2F%2Fsonarcloud.io&style=flat-square" alt="Test report"></a>
<a href="https://sonarcloud.io/dashboard?id=AnonymusRaccoon_Kyoo"><img src="https://img.shields.io/sonar/coverage/AnonymusRaccoon_Kyoo?server=https%3A%2F%2Fsonarcloud.io&style=flat-square" alt="Coverage"></a>
<a href="./LICENSE"><img src="https://img.shields.io/github/license/AnonymusRaccoon/Kyoo?style=flat-square" alt="License"></a>
</p>
Kyoo is an open-source media browser which allow you to stream your movies, tv-shows or anime.
It is an alternative to Plex, Emby or Jellyfin.
@@ -17,78 +9,28 @@ Feel free to open issues or pull requests, all contribution are welcomed.
## Getting started
- [Installation](https://docs.kyoo.moe/start/install.html)
- [Setting Up](https://docs.kyoo.moe/start/setting_up.html)
- [Api Documentation](https://demo.kyoo.moe/redoc)
- [Documentation (work in progress)](https://docs.kyoo.moe)
- [Installation](./INSTALLING.md)
- [Api Documentation](https://kyoo.zoriya.dev/api/doc)
- [Contributing](./CONTRIBUTING.md)
## Features
- Manage your movies, tv-series & anime
- Transmux/Transcode files to make them available on every platform
- Create smart watchlists that will automatically update when you watch movies/episodes
- Search your collection via names, tags or descriptions
- Download metadata automatically
- Transmux files to make them available on every platform (Transcode coming soon)
- Account system with a permission system
- Handle subtitles natively with embedded fonts (ass, subrip or vtt)
- Entirely free and works without internet (when metadata have already been downloaded)
- Works on Linux, Windows, Docker and probably Mac
- A powerful plugin system
## Live Demo
You can see a live demo with copyright-free movies here: [demo.kyoo.moe](https://demo.kyoo.moe).
You can see a live demo with copyright-free movies here: [kyoo.zoriya.dev](https://kyoo.zoriya.dev).
Thanks to the [blender studio](https://www.blender.org/about/studio/) for providing open-source movies available for all.
The demo server is simply created using the following docker compose:
```yml
version: "3.8"
services:
kyoo:
image: ghcr.io/anonymusraccoon/kyoo:master
restart: on-failure
environment:
- KYOO_DATADIR=/var/lib/kyoo
- DATABASE__ENABLED=postgres
- DATABASE__CONFIGURATIONS__POSTGRES__SERVER=postgres
- DATABASE__CONFIGURATIONS__POSTGRES__USER ID=kyoo
- DATABASE__CONFIGURATIONS__POSTGRES__PASSWORD=kyooPassword
- TVDB__APIKEY=TheTvDbApiKey
- THE-MOVIEDB__APIKEY=TheMovieDbApiKey
ports:
- "80:5000"
depends_on:
- postgres
volumes:
- kyoo:/var/lib/kyoo
- video:/video
postgres:
image: "postgres"
restart: on-failure
environment:
- POSTGRES_USER=kyoo
- POSTGRES_PASSWORD=kyooPassword
volumes:
- db:/var/lib/postgresql/data
volumes:
kyoo:
video:
db:
```
## Screens
![Show](../screens/show.png?raw=true)
![Movie](https://raw.githubusercontent.com/zoriya/kyoo/screens/movie.png)
- - -
![Show Dropdown](../screens/show_dropdown.png?raw=true)
![Show](https://raw.githubusercontent.com/zoriya/kyoo/screens/show.png)
- - -
![Browse](../screens/browse.png?raw=true)
- - -
![Filters](../screens/filters.png?raw=true)
- - -
![People](../screens/people.png?raw=true)
- - -
![Player](../screens/player.png?raw=true)
- - -
![Search](../screens/search.png?raw=true)
![Player](https://raw.githubusercontent.com/zoriya/kyoo/screens/player.png)

View File

@@ -0,0 +1,18 @@
{
"version": 1,
"isRoot": true,
"tools": {
"dotnet-ef": {
"version": "7.0.9",
"commands": [
"dotnet-ef"
]
},
"csharpier": {
"version": "0.26.4",
"commands": [
"dotnet-csharpier"
]
}
}
}

View File

@@ -11,11 +11,11 @@ smart_tab = true
[*.cs]
csharp_prefer_braces = false
dotnet_diagnostic.IDE0130.severity = none
dotnet_diagnostic.IDE0058.severity = none
dotnet_diagnostic.IDE0046.severity = none
dotnet_diagnostic.CA1848.severity = none
dotnet_diagnostic.CA2007.severity = none
dotnet_diagnostic.IDE0055.severity = none
dotnet_diagnostic.IDE0058.severity = none
dotnet_diagnostic.IDE0130.severity = none
# Sort using and Import directives with System.* appearing first
dotnet_sort_system_directives_first = true
csharp_using_directive_placement = outside_namespace:warning
@@ -43,9 +43,9 @@ dotnet_style_prefer_conditional_expression_over_return = true
# Disable strange throw.
csharp_style_throw_expression = false:suggestion
# Forbid "var" everywhere
csharp_style_var_for_built_in_types = false:warning
csharp_style_var_when_type_is_apparent = false:warning
csharp_style_var_elsewhere = false:warning
csharp_style_var_for_built_in_types = false:suggestion
csharp_style_var_when_type_is_apparent = false:suggestion
csharp_style_var_elsewhere = false:suggestion
# Prefer method-like constructs to have a block body
csharp_style_expression_bodied_methods = false:none
csharp_style_expression_bodied_constructors = false:none
@@ -89,6 +89,9 @@ resharper_wrap_before_arrow_with_expressions = true
resharper_xmldoc_attribute_indent = align_by_first_attribute
resharper_xmldoc_indent_child_elements = RemoveIndent
resharper_xmldoc_indent_text = RemoveIndent
# Switch on enum
dotnet_diagnostic.CS8509.severity=error # missing switch case for named enum value
dotnet_diagnostic.CS8524.severity=none # missing switch case for unnamed enum value
# Waiting for https://github.com/dotnet/roslyn/issues/44596 to get fixed.
# file_header_template = Kyoo - A portable and vast media library solution.\nCopyright (c) Kyoo.\n\nSee AUTHORS.md and LICENSE file in the project root for full license information.\n\nKyoo is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\nany later version.\n\nKyoo is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with Kyoo. If not, see <https://www.gnu.org/licenses/>.

2
back/.gitignore vendored
View File

@@ -2,6 +2,7 @@ out
libtranscoder.so
libtranscoder.dylib
transcoder.dll
kyoo_datadir
video
.env
@@ -80,7 +81,6 @@ StyleCopReport.xml
*.ipdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli

View File

@@ -1,37 +1,30 @@
FROM gcc:latest as transcoder
RUN apt-get update && apt-get install -y cmake make libavutil-dev libavcodec-dev libavformat-dev
WORKDIR /transcoder
COPY src/Kyoo.Transcoder .
RUN cmake . && make -j
FROM mcr.microsoft.com/dotnet/sdk:6.0 as builder
FROM --platform=$BUILDPLATFORM mcr.microsoft.com/dotnet/sdk:7.0 as builder
ARG TARGETARCH
WORKDIR /kyoo
COPY Kyoo.sln ./Kyoo.sln
COPY nuget.config ./nuget.config
COPY src/Directory.Build.props src/Directory.Build.props
COPY src/Kyoo.Authentication/Kyoo.Authentication.csproj src/Kyoo.Authentication/Kyoo.Authentication.csproj
COPY src/Kyoo.Database/Kyoo.Database.csproj src/Kyoo.Database/Kyoo.Database.csproj
COPY src/Kyoo.Host.Generic/Kyoo.Host.Generic.csproj src/Kyoo.Host.Generic/Kyoo.Host.Generic.csproj
COPY src/Kyoo.SqLite/Kyoo.SqLite.csproj src/Kyoo.SqLite/Kyoo.SqLite.csproj
COPY src/Kyoo.TheMovieDb/Kyoo.TheMovieDb.csproj src/Kyoo.TheMovieDb/Kyoo.TheMovieDb.csproj
COPY src/Kyoo.Abstractions/Kyoo.Abstractions.csproj src/Kyoo.Abstractions/Kyoo.Abstractions.csproj
COPY src/Kyoo.Core/Kyoo.Core.csproj src/Kyoo.Core/Kyoo.Core.csproj
COPY src/Kyoo.Host.Console/Kyoo.Host.Console.csproj src/Kyoo.Host.Console/Kyoo.Host.Console.csproj
COPY src/Kyoo.Host/Kyoo.Host.csproj src/Kyoo.Host/Kyoo.Host.csproj
COPY src/Kyoo.Postgresql/Kyoo.Postgresql.csproj src/Kyoo.Postgresql/Kyoo.Postgresql.csproj
COPY src/Kyoo.Meilisearch/Kyoo.Meilisearch.csproj src/Kyoo.Meilisearch/Kyoo.Meilisearch.csproj
COPY src/Kyoo.Swagger/Kyoo.Swagger.csproj src/Kyoo.Swagger/Kyoo.Swagger.csproj
COPY src/Kyoo.TheTvdb/Kyoo.TheTvdb.csproj src/Kyoo.TheTvdb/Kyoo.TheTvdb.csproj
COPY tests/Kyoo.Tests/Kyoo.Tests.csproj tests/Kyoo.Tests/Kyoo.Tests.csproj
RUN dotnet restore
RUN dotnet restore -a $TARGETARCH
COPY . .
ARG VERSION
RUN dotnet publish --no-restore -c Release -o /opt/kyoo "-p:Version=${VERSION:-"0.0.0-dev"};SkipTranscoder=true" src/Kyoo.Host.Console
RUN dotnet publish -a $TARGETARCH --no-restore -c Release -o /app "-p:Version=${VERSION:-"0.0.0-dev"}" src/Kyoo.Host
FROM mcr.microsoft.com/dotnet/aspnet:6.0
RUN apt-get update && apt-get install -y libavutil-dev libavcodec-dev libavformat-dev
FROM mcr.microsoft.com/dotnet/aspnet:7.0
RUN apt-get update && apt-get install -y curl
COPY --from=builder /app /app
WORKDIR /kyoo
EXPOSE 5000
COPY --from=builder /opt/kyoo /usr/lib/kyoo
COPY --from=transcoder /transcoder/libtranscoder.so /usr/lib/kyoo
CMD ["/usr/lib/kyoo/Kyoo.Host.Console"]
# The back can take a long time to start if meilisearch is initializing
HEALTHCHECK --interval=5s --retries=15 CMD curl --fail http://localhost:5000/health || exit
ENTRYPOINT ["/app/Kyoo.Host"]

View File

@@ -1,35 +1,23 @@
FROM gcc:latest as transcoder
RUN apt-get update && apt-get install -y cmake make libavutil-dev libavcodec-dev libavformat-dev
WORKDIR /transcoder
COPY src/Kyoo.Transcoder .
RUN cmake . && make -j
FROM mcr.microsoft.com/dotnet/sdk:6.0
RUN apt-get update && apt-get install -y libavutil-dev libavcodec-dev libavformat-dev
FROM mcr.microsoft.com/dotnet/sdk:7.0
RUN apt-get update && apt-get install -y curl
WORKDIR /app
COPY Kyoo.sln ./Kyoo.sln
COPY nuget.config ./nuget.config
COPY src/Directory.Build.props src/Directory.Build.props
COPY src/Kyoo.Authentication/Kyoo.Authentication.csproj src/Kyoo.Authentication/Kyoo.Authentication.csproj
COPY src/Kyoo.Database/Kyoo.Database.csproj src/Kyoo.Database/Kyoo.Database.csproj
COPY src/Kyoo.Host.Generic/Kyoo.Host.Generic.csproj src/Kyoo.Host.Generic/Kyoo.Host.Generic.csproj
COPY src/Kyoo.SqLite/Kyoo.SqLite.csproj src/Kyoo.SqLite/Kyoo.SqLite.csproj
COPY src/Kyoo.TheMovieDb/Kyoo.TheMovieDb.csproj src/Kyoo.TheMovieDb/Kyoo.TheMovieDb.csproj
COPY src/Kyoo.Abstractions/Kyoo.Abstractions.csproj src/Kyoo.Abstractions/Kyoo.Abstractions.csproj
COPY src/Kyoo.Core/Kyoo.Core.csproj src/Kyoo.Core/Kyoo.Core.csproj
COPY src/Kyoo.Host.Console/Kyoo.Host.Console.csproj src/Kyoo.Host.Console/Kyoo.Host.Console.csproj
COPY src/Kyoo.Host/Kyoo.Host.csproj src/Kyoo.Host/Kyoo.Host.csproj
COPY src/Kyoo.Postgresql/Kyoo.Postgresql.csproj src/Kyoo.Postgresql/Kyoo.Postgresql.csproj
COPY src/Kyoo.Meilisearch/Kyoo.Meilisearch.csproj src/Kyoo.Meilisearch/Kyoo.Meilisearch.csproj
COPY src/Kyoo.Swagger/Kyoo.Swagger.csproj src/Kyoo.Swagger/Kyoo.Swagger.csproj
COPY src/Kyoo.TheTvdb/Kyoo.TheTvdb.csproj src/Kyoo.TheTvdb/Kyoo.TheTvdb.csproj
COPY tests/Kyoo.Tests/Kyoo.Tests.csproj tests/Kyoo.Tests/Kyoo.Tests.csproj
RUN dotnet restore
COPY --from=transcoder /transcoder/libtranscoder.so /usr/lib/
WORKDIR /kyoo
EXPOSE 5000
ENV DOTNET_USE_POLLING_FILE_WATCHER 1
CMD ["dotnet", "watch", "run", "--no-restore", "--project", "src/Kyoo.Host.Console"]
# HEALTHCHECK --interval=5s CMD curl --fail http://localhost:5000/health || exit
HEALTHCHECK CMD true
ENTRYPOINT ["dotnet", "watch", "run", "--no-restore", "--project", "/app/src/Kyoo.Host"]

View File

@@ -2,6 +2,7 @@
<Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.CSharp.MaintainabilityRules">
<Rule Id="SA1413" Action="None" /> <!-- UseTrailingCommasInMultiLineInitializers -->
<Rule Id="SA1414" Action="None" /> <!-- UseTrailingCommasInMultiLineInitializers -->
<Rule Id="SA1114" Action="None" /> <!-- UseTrailingCommasInMultiLineInitializers -->
</Rules>
<Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.CSharp.OrderingRules">
<Rule Id="SA1201" Action="None" /> <!-- ElementsMustAppearInTheCorrectOrder -->
@@ -27,18 +28,20 @@
<Rule Id="SA1027" Action="None"/> <!-- UseTabsCorrectly (smarts tabs are broken). TODO find a way to enable smart tabs -->
</Rules>
<Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.CSharp.LayoutRules">
<Rule Id="SA1402" Action="None"/> <!-- SingleClassPerFile -->
<Rule Id="SA1649" Action="None"/> <!-- Class name must be filename -->
<Rule Id="SA1503" Action="None"/> <!-- BracesMustNotBeOmitted -->
<Rule Id="SA1512" Action="None"/> <!-- Let me comment -->
<Rule Id="SA1520" Action="None"/> <!-- UseBracesConsistently -->
<Rule Id="SA1515" Action="None"/> <!-- SingleLineCommentMustBePrecededByBlankLine -->
<Rule Id="SA1513" Action="None"/> <!-- ClosingBraceMustBeFollowedByBlankLine -->
</Rules>
<Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.CSharp.DocumentationRules">
<Rule Id="SA1600" Action="None" /> <!-- Elements Shuld be Documented -->
<Rule Id="SA1602" Action="None" /> <!-- Enums should be documented -->
<Rule Id="SA1642" Action="None" /> <!-- ConstructorSummaryDocumentationMustBeginWithStandardText -->
<Rule Id="SA1643" Action="None" /> <!-- DestructorSummaryDocumentationMustBeginWithStandardText -->
<Rule Id="SA1623" Action="None" /> <!-- PropertySummaryDocumentationMustMatchAccessors -->
<Rule Id="SA1629" Action="None" /> <!-- DocumentationTextMustEndWithAPeriod TODO remove this, this is only temporary -->
<Rule Id="SA1629" Action="None" /> <!-- DocumentationTextMustEndWithAPeriod -->
</Rules>
</RuleSet>

View File

@@ -3,33 +3,19 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Kyoo.Core", "src\Kyoo.Core\
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kyoo.Abstractions", "src\Kyoo.Abstractions\Kyoo.Abstractions.csproj", "{BAB2CAE1-AC28-4509-AA3E-8DC75BD59220}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kyoo.Database", "src\Kyoo.Database\Kyoo.Database.csproj", "{6F91B645-F785-46BB-9C4F-1EFC83E489B6}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kyoo.Postgresql", "src\Kyoo.Postgresql\Kyoo.Postgresql.csproj", "{3213C96D-0BF3-460B-A8B5-B9977229408A}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kyoo.Authentication", "src\Kyoo.Authentication\Kyoo.Authentication.csproj", "{7A841335-6523-47DB-9717-80AA7BD943FD}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kyoo.SqLite", "src\Kyoo.SqLite\Kyoo.SqLite.csproj", "{6515380E-1E57-42DA-B6E3-E1C8A848818A}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kyoo.TheTvdb", "src\Kyoo.TheTvdb\Kyoo.TheTvdb.csproj", "{D06BF829-23F5-40F3-A62D-627D9F4B4D6C}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kyoo.TheMovieDb", "src\Kyoo.TheMovieDb\Kyoo.TheMovieDb.csproj", "{BAB270D4-E0EA-4329-BA65-512FDAB01001}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kyoo.Tests", "tests\Kyoo.Tests\Kyoo.Tests.csproj", "{0C8AA7EA-E723-4532-852F-35AA4E8AFED5}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kyoo.Host.Console", "src\Kyoo.Host.Console\Kyoo.Host.Console.csproj", "{D8658BEA-8949-45AC-BEBB-A4FFC4F800F5}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kyoo.Swagger", "src\Kyoo.Swagger\Kyoo.Swagger.csproj", "{7D1A7596-73F6-4D35-842E-A5AD9C620596}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Tests", "Tests", "{FEAE1B0E-D797-470F-9030-0EF743575ECC}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Providers", "Providers", "{8D28F5EF-0CD7-4697-A2A7-24EC31A48F21}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kyoo.Host", "src\Kyoo.Host\Kyoo.Host.csproj", "{0938459E-2E2B-457F-8120-7D8CA93866A6}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Databases", "Databases", "{865461CA-EC06-4B42-91CF-8723B0A9BB67}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Hosts", "Hosts", "{C569FF25-7E01-484C-9F72-5B99845AD94B}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kyoo.Host.Generic", "src\Kyoo.Host.Generic\Kyoo.Host.Generic.csproj", "{0938459E-2E2B-457F-8120-7D8CA93866A6}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kyoo.Meilisearch", "src\Kyoo.Meilisearch\Kyoo.Meilisearch.csproj", "{F8E6018A-FD51-40EB-99FF-A26BA59F2762}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -45,10 +31,6 @@ Global
{BAB2CAE1-AC28-4509-AA3E-8DC75BD59220}.Debug|Any CPU.Build.0 = Debug|Any CPU
{BAB2CAE1-AC28-4509-AA3E-8DC75BD59220}.Release|Any CPU.ActiveCfg = Release|Any CPU
{BAB2CAE1-AC28-4509-AA3E-8DC75BD59220}.Release|Any CPU.Build.0 = Release|Any CPU
{6F91B645-F785-46BB-9C4F-1EFC83E489B6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{6F91B645-F785-46BB-9C4F-1EFC83E489B6}.Debug|Any CPU.Build.0 = Debug|Any CPU
{6F91B645-F785-46BB-9C4F-1EFC83E489B6}.Release|Any CPU.ActiveCfg = Release|Any CPU
{6F91B645-F785-46BB-9C4F-1EFC83E489B6}.Release|Any CPU.Build.0 = Release|Any CPU
{3213C96D-0BF3-460B-A8B5-B9977229408A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{3213C96D-0BF3-460B-A8B5-B9977229408A}.Debug|Any CPU.Build.0 = Debug|Any CPU
{3213C96D-0BF3-460B-A8B5-B9977229408A}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -61,14 +43,6 @@ Global
{6515380E-1E57-42DA-B6E3-E1C8A848818A}.Debug|Any CPU.Build.0 = Debug|Any CPU
{6515380E-1E57-42DA-B6E3-E1C8A848818A}.Release|Any CPU.ActiveCfg = Release|Any CPU
{6515380E-1E57-42DA-B6E3-E1C8A848818A}.Release|Any CPU.Build.0 = Release|Any CPU
{D06BF829-23F5-40F3-A62D-627D9F4B4D6C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{D06BF829-23F5-40F3-A62D-627D9F4B4D6C}.Debug|Any CPU.Build.0 = Debug|Any CPU
{D06BF829-23F5-40F3-A62D-627D9F4B4D6C}.Release|Any CPU.ActiveCfg = Release|Any CPU
{D06BF829-23F5-40F3-A62D-627D9F4B4D6C}.Release|Any CPU.Build.0 = Release|Any CPU
{BAB270D4-E0EA-4329-BA65-512FDAB01001}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{BAB270D4-E0EA-4329-BA65-512FDAB01001}.Debug|Any CPU.Build.0 = Debug|Any CPU
{BAB270D4-E0EA-4329-BA65-512FDAB01001}.Release|Any CPU.ActiveCfg = Release|Any CPU
{BAB270D4-E0EA-4329-BA65-512FDAB01001}.Release|Any CPU.Build.0 = Release|Any CPU
{0C8AA7EA-E723-4532-852F-35AA4E8AFED5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{0C8AA7EA-E723-4532-852F-35AA4E8AFED5}.Debug|Any CPU.Build.0 = Debug|Any CPU
{0C8AA7EA-E723-4532-852F-35AA4E8AFED5}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -81,10 +55,6 @@ Global
{4FF1ECD9-6EEF-4440-B037-A661D78FB04D}.Debug|Any CPU.Build.0 = Debug|Any CPU
{4FF1ECD9-6EEF-4440-B037-A661D78FB04D}.Release|Any CPU.ActiveCfg = Release|Any CPU
{4FF1ECD9-6EEF-4440-B037-A661D78FB04D}.Release|Any CPU.Build.0 = Release|Any CPU
{D8658BEA-8949-45AC-BEBB-A4FFC4F800F5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{D8658BEA-8949-45AC-BEBB-A4FFC4F800F5}.Debug|Any CPU.Build.0 = Debug|Any CPU
{D8658BEA-8949-45AC-BEBB-A4FFC4F800F5}.Release|Any CPU.ActiveCfg = Release|Any CPU
{D8658BEA-8949-45AC-BEBB-A4FFC4F800F5}.Release|Any CPU.Build.0 = Release|Any CPU
{7D1A7596-73F6-4D35-842E-A5AD9C620596}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{7D1A7596-73F6-4D35-842E-A5AD9C620596}.Debug|Any CPU.Build.0 = Debug|Any CPU
{7D1A7596-73F6-4D35-842E-A5AD9C620596}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -93,15 +63,12 @@ Global
{0938459E-2E2B-457F-8120-7D8CA93866A6}.Debug|Any CPU.Build.0 = Debug|Any CPU
{0938459E-2E2B-457F-8120-7D8CA93866A6}.Release|Any CPU.ActiveCfg = Release|Any CPU
{0938459E-2E2B-457F-8120-7D8CA93866A6}.Release|Any CPU.Build.0 = Release|Any CPU
{F8E6018A-FD51-40EB-99FF-A26BA59F2762}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{F8E6018A-FD51-40EB-99FF-A26BA59F2762}.Debug|Any CPU.Build.0 = Debug|Any CPU
{F8E6018A-FD51-40EB-99FF-A26BA59F2762}.Release|Any CPU.ActiveCfg = Release|Any CPU
{F8E6018A-FD51-40EB-99FF-A26BA59F2762}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(NestedProjects) = preSolution
{0C8AA7EA-E723-4532-852F-35AA4E8AFED5} = {FEAE1B0E-D797-470F-9030-0EF743575ECC}
{BAB270D4-E0EA-4329-BA65-512FDAB01001} = {8D28F5EF-0CD7-4697-A2A7-24EC31A48F21}
{D06BF829-23F5-40F3-A62D-627D9F4B4D6C} = {8D28F5EF-0CD7-4697-A2A7-24EC31A48F21}
{6F91B645-F785-46BB-9C4F-1EFC83E489B6} = {865461CA-EC06-4B42-91CF-8723B0A9BB67}
{3213C96D-0BF3-460B-A8B5-B9977229408A} = {865461CA-EC06-4B42-91CF-8723B0A9BB67}
{6515380E-1E57-42DA-B6E3-E1C8A848818A} = {865461CA-EC06-4B42-91CF-8723B0A9BB67}
{D8658BEA-8949-45AC-BEBB-A4FFC4F800F5} = {C569FF25-7E01-484C-9F72-5B99845AD94B}
{0938459E-2E2B-457F-8120-7D8CA93866A6} = {C569FF25-7E01-484C-9F72-5B99845AD94B}
EndGlobalSection
EndGlobal

4
back/ef.rsp Normal file
View File

@@ -0,0 +1,4 @@
--project
src/Kyoo.Postgresql/Kyoo.Postgresql.csproj
--msbuildprojectextensionspath
out/obj/Kyoo.Postgresql

View File

@@ -1,13 +1,14 @@
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
<clear/>
<add key="nuget" value="https://api.nuget.org/v3/index.json"/>
</packageSources>
<disabledPackageSources>
<clear/>
</disabledPackageSources>
<fallbackPackageFolders>
<clear/>
</fallbackPackageFolders>
<packageSources>
<clear/>
<add key="feedz" value="https://f.feedz.io/zoriya/entityframeworkcore-projectables/nuget/index.json"/>
<add key="nuget" value="https://api.nuget.org/v3/index.json"/>
</packageSources>
<disabledPackageSources>
<clear/>
</disabledPackageSources>
<fallbackPackageFolders>
<clear/>
</fallbackPackageFolders>
</configuration>

View File

@@ -1,6 +1,6 @@
<Project>
<PropertyGroup>
<TargetFramework>net6.0</TargetFramework>
<TargetFramework>net7.0</TargetFramework>
<LangVersion>default</LangVersion>
<Company>Kyoo</Company>
<Authors>Kyoo</Authors>
@@ -9,10 +9,10 @@
<PackageLicenseExpression>GPL-3.0-or-later</PackageLicenseExpression>
<RequireLicenseAcceptance>true</RequireLicenseAcceptance>
<RepositoryUrl>https://github.com/AnonymusRaccoon/Kyoo</RepositoryUrl>
<RepositoryUrl>https://github.com/zoriya/Kyoo</RepositoryUrl>
<RepositoryType>git</RepositoryType>
<PublishRepositoryUrl>true</PublishRepositoryUrl>
<PackageProjectUrl>https://github.com/AnonymusRaccoon/Kyoo</PackageProjectUrl>
<PackageProjectUrl>https://github.com/zoriya/Kyoo</PackageProjectUrl>
<PackageVersion>1.0.0</PackageVersion>
<IncludeSymbols>true</IncludeSymbols>
@@ -29,13 +29,6 @@
</PropertyGroup>
<PropertyGroup>
<IsWindows Condition="$([MSBuild]::IsOSPlatform('Windows'))">true</IsWindows>
<IsOSX Condition="$([MSBuild]::IsOSPlatform('OSX'))">true</IsOSX>
<IsLinux Condition="$([MSBuild]::IsOSPlatform('Linux'))">true</IsLinux>
<!-- This is horrible but the only workarround I found to disable the transcoder copy on the dev dockerfile -->
<SkipTranscoder Condition="$(MsBuildThisFileDirectory) == '/app/src/'">true</SkipTranscoder>
<CheckCodingStyle Condition="$(CheckCodingStyle) == ''">true</CheckCodingStyle>
</PropertyGroup>
@@ -44,15 +37,14 @@
</ItemGroup>
<ItemGroup Condition="$(CheckCodingStyle) == true">
<PackageReference Include="SerilogAnalyzer" Version="0.15.0" PrivateAssets="All" />
<PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.354" PrivateAssets="All" />
<AdditionalFiles Include="$(MSBuildThisFileDirectory)../stylecop.json" Link="stylecop.json" Visible="false" />
<None Include="$(MSBuildThisFileDirectory)../.editorconfig" Link=".editorconfig" Visible="false" />
</ItemGroup>
<PropertyGroup Condition="$(CheckCodingStyle) == true">
<CodeAnalysisRuleSet>$(MSBuildThisFileDirectory)../Kyoo.ruleset</CodeAnalysisRuleSet>
<NoWarn>1591;1305;8618;SYSLIB1045;CS1573</NoWarn>
<!-- <AnalysisMode>All</AnalysisMode> -->
</PropertyGroup>
<!-- vim: ft=xml -->
</Project>

View File

@@ -1,49 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
namespace Kyoo.Abstractions.Controllers
{
/// <summary>
/// An interface that allow one to interact with the host and shutdown or restart the app.
/// </summary>
public interface IApplication
{
/// <summary>
/// Shutdown the process and stop gracefully.
/// </summary>
void Shutdown();
/// <summary>
/// Restart Kyoo from scratch, reload plugins, configurations and restart the web server.
/// </summary>
void Restart();
/// <summary>
/// Get the data directory.
/// </summary>
/// <returns>Retrieve the data directory where runtime data should be stored.</returns>
string GetDataDirectory();
/// <summary>
/// Retrieve the path of the json configuration file
/// (relative to the data directory, see <see cref="GetDataDirectory"/>).
/// </summary>
/// <returns>The configuration file name.</returns>
string GetConfigFile();
}
}

View File

@@ -1,86 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Threading.Tasks;
using JetBrains.Annotations;
using Kyoo.Abstractions.Models;
using Kyoo.Abstractions.Models.Exceptions;
namespace Kyoo.Abstractions.Controllers
{
/// <summary>
/// A class to ease configuration management. This work WITH Microsoft's package, you can still use IOptions patterns
/// to access your options, this manager ease dynamic work and editing.
/// It works with <see cref="ConfigurationReference"/>.
/// </summary>
public interface IConfigurationManager
{
/// <summary>
/// Add an editable configuration to the editable configuration list.
/// </summary>
/// <param name="path">The root path of the editable configuration. It should not be a nested type.</param>
/// <typeparam name="T">The type of the configuration.</typeparam>
void AddTyped<T>(string path);
/// <summary>
/// Add an editable configuration to the editable configuration list.
/// WARNING: this method allow you to add an unmanaged type. This type won't be editable. This can be used
/// for external libraries or variable arguments.
/// </summary>
/// <param name="path">The root path of the editable configuration. It should not be a nested type.</param>
void AddUntyped(string path);
/// <summary>
/// An helper method of <see cref="AddTyped{T}"/> and <see cref="AddUntyped"/>.
/// This register a typed value if <paramref name="type"/> is not <c>null</c> and registers an untyped type
/// if <paramref name="type"/> is <c>null</c>.
/// </summary>
/// <param name="path">The root path of the editable configuration. It should not be a nested type.</param>
/// <param name="type">The type of the configuration or null.</param>
void Register(string path, [CanBeNull] Type type);
/// <summary>
/// Get the value of a setting using it's path.
/// </summary>
/// <param name="path">The path of the resource (can be separated by ':' or '__').</param>
/// <exception cref="ItemNotFoundException">No setting found at the given path.</exception>
/// <returns>The value of the settings (if it's a strongly typed one, the given type is instantiated.</returns>
object GetValue(string path);
/// <summary>
/// Get the value of a setting using it's path.
/// If your don't need a strongly typed value, see <see cref="GetValue"/>.
/// </summary>
/// <param name="path">The path of the resource (can be separated by ':' or '__').</param>
/// <typeparam name="T">A type to strongly type your option.</typeparam>
/// <exception cref="InvalidCastException">If your type is not the same as the registered type.</exception>
/// <exception cref="ItemNotFoundException">No setting found at the given path.</exception>
/// <returns>The value of the settings (if it's a strongly typed one, the given type is instantiated.</returns>
T GetValue<T>(string path);
/// <summary>
/// Edit the value of a setting using it's path. Save it to the json file.
/// </summary>
/// <param name="path">The path of the resource (can be separated by ':' or '__').</param>
/// <param name="value">The new value of the resource.</param>
/// <exception cref="ItemNotFoundException">No setting found at the given path.</exception>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
Task EditValue(string path, object value);
}
}

View File

@@ -1,139 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
using JetBrains.Annotations;
using Kyoo.Abstractions.Models;
using Microsoft.AspNetCore.Mvc;
namespace Kyoo.Abstractions.Controllers
{
/// <summary>
/// A service to abstract the file system to allow custom file systems
/// (like distant file systems or external providers).
/// </summary>
public interface IFileSystem
{
/// <summary>
/// Used for http queries returning a file. This should be used to return local files
/// or proxy them from a distant server.
/// </summary>
/// <remarks>
/// If no file exists at the given path or if the path is null, a NotFoundResult is returned
/// to handle it gracefully.
/// </remarks>
/// <param name="path">The path of the file.</param>
/// <param name="rangeSupport">
/// Should the file be downloaded at once or is the client allowed to request only part of the file
/// </param>
/// <param name="type">
/// You can manually specify the content type of your file.
/// For example you can force a file to be returned as plain text using <c>text/plain</c>.
/// If the type is not specified, it will be deduced automatically (from the extension or by sniffing the file).
/// </param>
/// <returns>An <see cref="IActionResult"/> representing the file returned.</returns>
IActionResult FileResult([CanBeNull] string path, bool rangeSupport = false, string type = null);
/// <summary>
/// Read a file present at <paramref name="path"/>. The reader can be used in an arbitrary context.
/// To return files from an http endpoint, use <see cref="FileResult"/>.
/// </summary>
/// <param name="path">The path of the file</param>
/// <exception cref="FileNotFoundException">If the file could not be found.</exception>
/// <returns>A reader to read the file.</returns>
Task<Stream> GetReader([NotNull] string path);
/// <summary>
/// Read a file present at <paramref name="path"/>. The reader can be used in an arbitrary context.
/// To return files from an http endpoint, use <see cref="FileResult"/>.
/// </summary>
/// <param name="path">The path of the file</param>
/// <param name="mime">The mime type of the opened file.</param>
/// <exception cref="FileNotFoundException">If the file could not be found.</exception>
/// <returns>A reader to read the file.</returns>
Task<Stream> GetReader([NotNull] string path, AsyncRef<string> mime);
/// <summary>
/// Create a new file at <paramref name="path"></paramref>.
/// </summary>
/// <param name="path">The path of the new file.</param>
/// <returns>A writer to write to the new file.</returns>
Task<Stream> NewFile([NotNull] string path);
/// <summary>
/// Create a new directory at the given path
/// </summary>
/// <param name="path">The path of the directory</param>
/// <returns>The path of the newly created directory is returned.</returns>
Task<string> CreateDirectory([NotNull] string path);
/// <summary>
/// Combine multiple paths.
/// </summary>
/// <param name="paths">The paths to combine</param>
/// <returns>The combined path.</returns>
string Combine(params string[] paths);
/// <summary>
/// List files in a directory.
/// </summary>
/// <param name="path">The path of the directory</param>
/// <param name="options">Should the search be recursive or not.</param>
/// <returns>A list of files's path.</returns>
Task<ICollection<string>> ListFiles([NotNull] string path,
SearchOption options = SearchOption.TopDirectoryOnly);
/// <summary>
/// Check if a file exists at the given path.
/// </summary>
/// <param name="path">The path to check</param>
/// <returns>True if the path exists, false otherwise</returns>
Task<bool> Exists([NotNull] string path);
/// <summary>
/// Get the extra directory of a resource <typeparamref name="T"/>.
/// This method is in this system to allow a filesystem to use a different metadata policy for one.
/// It can be useful if the filesystem is readonly.
/// </summary>
/// <param name="resource">The resource to proceed</param>
/// <typeparam name="T">The type of the resource.</typeparam>
/// <returns>The extra directory of the resource.</returns>
Task<string> GetExtraDirectory<T>([NotNull] T resource);
/// <summary>
/// Retrieve tracks for a specific episode.
/// Subtitles, chapters and fonts should also be extracted and cached when calling this method.
/// </summary>
/// <param name="episode">The episode to retrieve tracks for.</param>
/// <param name="reExtract">Should the cache be invalidated and subtitles and others be re-extracted?</param>
/// <returns>The list of tracks available for this episode.</returns>
Task<ICollection<Track>> ExtractInfos([NotNull] Episode episode, bool reExtract);
/// <summary>
/// Transmux the selected episode to hls.
/// </summary>
/// <param name="episode">The episode to transmux.</param>
/// <returns>The master file (m3u8) of the transmuxed hls file.</returns>
IActionResult Transmux([NotNull] Episode episode);
// Maybe add options for to select the codec.
// IActionResult Transcode(Episode episode);
}
}

View File

@@ -1,55 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System.Threading.Tasks;
using Kyoo.Abstractions.Models;
using Kyoo.Abstractions.Models.Exceptions;
namespace Kyoo.Abstractions.Controllers
{
/// <summary>
/// An interface to identify episodes, shows and metadata based on the episode file.
/// </summary>
public interface IIdentifier
{
/// <summary>
/// Identify a path and return the parsed metadata.
/// </summary>
/// <param name="path">The path of the episode file to parse.</param>
/// <exception cref="IdentificationFailedException">
/// The identifier could not work for the given path.
/// </exception>
/// <returns>
/// A tuple of models representing parsed metadata.
/// If no metadata could be parsed for a type, null can be returned.
/// </returns>
Task<(Collection, Show, Season, Episode)> Identify(string path);
/// <summary>
/// Identify an external subtitle or track file from it's path and return the parsed metadata.
/// </summary>
/// <param name="path">The path of the external track file to parse.</param>
/// <exception cref="IdentificationFailedException">
/// The identifier could not work for the given path.
/// </exception>
/// <returns>
/// The metadata of the track identified.
/// </returns>
Task<Track> IdentifyTrack(string path);
}
}

View File

@@ -16,14 +16,7 @@
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Collections.Generic;
using System.Linq.Expressions;
using System.Runtime.InteropServices;
using System.Threading.Tasks;
using JetBrains.Annotations;
using Kyoo.Abstractions.Models;
using Kyoo.Abstractions.Models.Exceptions;
namespace Kyoo.Abstractions.Controllers
{
@@ -32,581 +25,62 @@ namespace Kyoo.Abstractions.Controllers
/// </summary>
public interface ILibraryManager
{
/// <summary>
/// Get the repository corresponding to the T item.
/// </summary>
/// <typeparam name="T">The type you want</typeparam>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>The repository corresponding</returns>
IRepository<T> GetRepository<T>()
where T : class, IResource;
/// <summary>
/// The repository that handle libraries.
/// </summary>
ILibraryRepository LibraryRepository { get; }
IRepository<T> Repository<T>()
where T : IResource, IQuery;
/// <summary>
/// The repository that handle libraries items (a wrapper around shows and collections).
/// </summary>
ILibraryItemRepository LibraryItemRepository { get; }
IRepository<ILibraryItem> LibraryItems { get; }
/// <summary>
/// The repository that handle new items.
/// </summary>
IRepository<INews> News { get; }
/// <summary>
/// The repository that handle watched items.
/// </summary>
IWatchStatusRepository WatchStatus { get; }
/// <summary>
/// The repository that handle collections.
/// </summary>
ICollectionRepository CollectionRepository { get; }
IRepository<Collection> Collections { get; }
/// <summary>
/// The repository that handle shows.
/// </summary>
IShowRepository ShowRepository { get; }
IRepository<Movie> Movies { get; }
/// <summary>
/// The repository that handle shows.
/// </summary>
IRepository<Show> Shows { get; }
/// <summary>
/// The repository that handle seasons.
/// </summary>
ISeasonRepository SeasonRepository { get; }
IRepository<Season> Seasons { get; }
/// <summary>
/// The repository that handle episodes.
/// </summary>
IEpisodeRepository EpisodeRepository { get; }
/// <summary>
/// The repository that handle tracks.
/// </summary>
ITrackRepository TrackRepository { get; }
IRepository<Episode> Episodes { get; }
/// <summary>
/// The repository that handle people.
/// </summary>
IPeopleRepository PeopleRepository { get; }
IRepository<People> People { get; }
/// <summary>
/// The repository that handle studios.
/// </summary>
IStudioRepository StudioRepository { get; }
/// <summary>
/// The repository that handle genres.
/// </summary>
IGenreRepository GenreRepository { get; }
/// <summary>
/// The repository that handle providers.
/// </summary>
IProviderRepository ProviderRepository { get; }
IRepository<Studio> Studios { get; }
/// <summary>
/// The repository that handle users.
/// </summary>
IUserRepository UserRepository { get; }
/// <summary>
/// Get the resource by it's ID
/// </summary>
/// <param name="id">The id of the resource</param>
/// <typeparam name="T">The type of the resource</typeparam>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>The resource found</returns>
[ItemNotNull]
Task<T> Get<T>(int id)
where T : class, IResource;
/// <summary>
/// Get the resource by it's slug
/// </summary>
/// <param name="slug">The slug of the resource</param>
/// <typeparam name="T">The type of the resource</typeparam>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>The resource found</returns>
[ItemNotNull]
Task<T> Get<T>(string slug)
where T : class, IResource;
/// <summary>
/// Get the resource by a filter function.
/// </summary>
/// <param name="where">The filter function.</param>
/// <typeparam name="T">The type of the resource</typeparam>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>The first resource found that match the where function</returns>
[ItemNotNull]
Task<T> Get<T>(Expression<Func<T, bool>> where)
where T : class, IResource;
/// <summary>
/// Get a season from it's showID and it's seasonNumber
/// </summary>
/// <param name="showID">The id of the show</param>
/// <param name="seasonNumber">The season's number</param>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>The season found</returns>
[ItemNotNull]
Task<Season> Get(int showID, int seasonNumber);
/// <summary>
/// Get a season from it's show slug and it's seasonNumber
/// </summary>
/// <param name="showSlug">The slug of the show</param>
/// <param name="seasonNumber">The season's number</param>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>The season found</returns>
[ItemNotNull]
Task<Season> Get(string showSlug, int seasonNumber);
/// <summary>
/// Get a episode from it's showID, it's seasonNumber and it's episode number.
/// </summary>
/// <param name="showID">The id of the show</param>
/// <param name="seasonNumber">The season's number</param>
/// <param name="episodeNumber">The episode's number</param>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>The episode found</returns>
[ItemNotNull]
Task<Episode> Get(int showID, int seasonNumber, int episodeNumber);
/// <summary>
/// Get a episode from it's show slug, it's seasonNumber and it's episode number.
/// </summary>
/// <param name="showSlug">The slug of the show</param>
/// <param name="seasonNumber">The season's number</param>
/// <param name="episodeNumber">The episode's number</param>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>The episode found</returns>
[ItemNotNull]
Task<Episode> Get(string showSlug, int seasonNumber, int episodeNumber);
/// <summary>
/// Get the resource by it's ID or null if it is not found.
/// </summary>
/// <param name="id">The id of the resource</param>
/// <typeparam name="T">The type of the resource</typeparam>
/// <returns>The resource found</returns>
[ItemCanBeNull]
Task<T> GetOrDefault<T>(int id)
where T : class, IResource;
/// <summary>
/// Get the resource by it's slug or null if it is not found.
/// </summary>
/// <param name="slug">The slug of the resource</param>
/// <typeparam name="T">The type of the resource</typeparam>
/// <returns>The resource found</returns>
[ItemCanBeNull]
Task<T> GetOrDefault<T>(string slug)
where T : class, IResource;
/// <summary>
/// Get the resource by a filter function or null if it is not found.
/// </summary>
/// <param name="where">The filter function.</param>
/// <param name="sortBy">A custom sort method to handle cases where multiples items match the filters.</param>
/// <typeparam name="T">The type of the resource</typeparam>
/// <returns>The first resource found that match the where function</returns>
[ItemCanBeNull]
Task<T> GetOrDefault<T>(Expression<Func<T, bool>> where, Sort<T> sortBy = default)
where T : class, IResource;
/// <summary>
/// Get a season from it's showID and it's seasonNumber or null if it is not found.
/// </summary>
/// <param name="showID">The id of the show</param>
/// <param name="seasonNumber">The season's number</param>
/// <returns>The season found</returns>
[ItemCanBeNull]
Task<Season> GetOrDefault(int showID, int seasonNumber);
/// <summary>
/// Get a season from it's show slug and it's seasonNumber or null if it is not found.
/// </summary>
/// <param name="showSlug">The slug of the show</param>
/// <param name="seasonNumber">The season's number</param>
/// <returns>The season found</returns>
[ItemCanBeNull]
Task<Season> GetOrDefault(string showSlug, int seasonNumber);
/// <summary>
/// Get a episode from it's showID, it's seasonNumber and it's episode number or null if it is not found.
/// </summary>
/// <param name="showID">The id of the show</param>
/// <param name="seasonNumber">The season's number</param>
/// <param name="episodeNumber">The episode's number</param>
/// <returns>The episode found</returns>
[ItemCanBeNull]
Task<Episode> GetOrDefault(int showID, int seasonNumber, int episodeNumber);
/// <summary>
/// Get a episode from it's show slug, it's seasonNumber and it's episode number or null if it is not found.
/// </summary>
/// <param name="showSlug">The slug of the show</param>
/// <param name="seasonNumber">The season's number</param>
/// <param name="episodeNumber">The episode's number</param>
/// <returns>The episode found</returns>
[ItemCanBeNull]
Task<Episode> GetOrDefault(string showSlug, int seasonNumber, int episodeNumber);
/// <summary>
/// Load a related resource
/// </summary>
/// <param name="obj">The source object.</param>
/// <param name="member">A getter function for the member to load</param>
/// <param name="force">
/// <c>true</c> if you want to load the relation even if it is not null, <c>false</c> otherwise.
/// </param>
/// <typeparam name="T">The type of the source object</typeparam>
/// <typeparam name="T2">The related resource's type</typeparam>
/// <returns>The param <paramref name="obj"/></returns>
/// <seealso cref="Load{T,T2}(T, System.Linq.Expressions.Expression{System.Func{T,System.Collections.Generic.ICollection{T2}}}, bool)"/>
/// <seealso cref="Load{T}(T, string, bool)"/>
/// <seealso cref="Load(IResource, string, bool)"/>
Task<T> Load<T, T2>([NotNull] T obj, Expression<Func<T, T2>> member, bool force = false)
where T : class, IResource
where T2 : class, IResource;
/// <summary>
/// Load a collection of related resource
/// </summary>
/// <param name="obj">The source object.</param>
/// <param name="member">A getter function for the member to load</param>
/// <param name="force">
/// <c>true</c> if you want to load the relation even if it is not null, <c>false</c> otherwise.
/// </param>
/// <typeparam name="T">The type of the source object</typeparam>
/// <typeparam name="T2">The related resource's type</typeparam>
/// <returns>The param <paramref name="obj"/></returns>
/// <seealso cref="Load{T,T2}(T, System.Linq.Expressions.Expression{System.Func{T,T2}}, bool)"/>
/// <seealso cref="Load{T}(T, string, bool)"/>
/// <seealso cref="Load(IResource, string, bool)"/>
Task<T> Load<T, T2>([NotNull] T obj, Expression<Func<T, ICollection<T2>>> member, bool force = false)
where T : class, IResource
where T2 : class;
/// <summary>
/// Load a related resource by it's name
/// </summary>
/// <param name="obj">The source object.</param>
/// <param name="memberName">The name of the resource to load (case sensitive)</param>
/// <param name="force">
/// <c>true</c> if you want to load the relation even if it is not null, <c>false</c> otherwise.
/// </param>
/// <typeparam name="T">The type of the source object</typeparam>
/// <returns>The param <paramref name="obj"/></returns>
/// <seealso cref="Load{T,T2}(T, System.Linq.Expressions.Expression{System.Func{T,T2}}, bool)"/>
/// <seealso cref="Load{T,T2}(T, System.Linq.Expressions.Expression{System.Func{T,System.Collections.Generic.ICollection{T2}}}, bool)"/>
/// <seealso cref="Load(IResource, string, bool)"/>
Task<T> Load<T>([NotNull] T obj, string memberName, bool force = false)
where T : class, IResource;
/// <summary>
/// Load a related resource without specifying it's type.
/// </summary>
/// <param name="obj">The source object.</param>
/// <param name="memberName">The name of the resource to load (case sensitive)</param>
/// <param name="force">
/// <c>true</c> if you want to load the relation even if it is not null, <c>false</c> otherwise.
/// </param>
/// <seealso cref="Load{T,T2}(T, System.Linq.Expressions.Expression{System.Func{T,T2}}, bool)"/>
/// <seealso cref="Load{T,T2}(T, System.Linq.Expressions.Expression{System.Func{T,System.Collections.Generic.ICollection{T2}}}, bool)"/>
/// <seealso cref="Load{T}(T, string, bool)"/>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
Task Load([NotNull] IResource obj, string memberName, bool force = false);
/// <summary>
/// Get items (A wrapper around shows or collections) from a library.
/// </summary>
/// <param name="id">The ID of the library</param>
/// <param name="where">A filter function</param>
/// <param name="sort">Sort information (sort order and sort by)</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No library exist with the given ID.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<LibraryItem>> GetItemsFromLibrary(int id,
Expression<Func<LibraryItem, bool>> where = null,
Sort<LibraryItem> sort = default,
Pagination limit = default);
/// <summary>
/// Get items (A wrapper around shows or collections) from a library.
/// </summary>
/// <param name="id">The ID of the library</param>
/// <param name="where">A filter function</param>
/// <param name="sort">A sort by method</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No library exist with the given ID.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<LibraryItem>> GetItemsFromLibrary(int id,
[Optional] Expression<Func<LibraryItem, bool>> where,
Expression<Func<LibraryItem, object>> sort,
Pagination limit = default
) => GetItemsFromLibrary(id, where, new Sort<LibraryItem>(sort), limit);
/// <summary>
/// Get items (A wrapper around shows or collections) from a library.
/// </summary>
/// <param name="slug">The slug of the library</param>
/// <param name="where">A filter function</param>
/// <param name="sort">Sort information (sort order and sort by)</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No library exist with the given slug.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<LibraryItem>> GetItemsFromLibrary(string slug,
Expression<Func<LibraryItem, bool>> where = null,
Sort<LibraryItem> sort = default,
Pagination limit = default);
/// <summary>
/// Get items (A wrapper around shows or collections) from a library.
/// </summary>
/// <param name="slug">The slug of the library</param>
/// <param name="where">A filter function</param>
/// <param name="sort">A sort by method</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No library exist with the given slug.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<LibraryItem>> GetItemsFromLibrary(string slug,
[Optional] Expression<Func<LibraryItem, bool>> where,
Expression<Func<LibraryItem, object>> sort,
Pagination limit = default
) => GetItemsFromLibrary(slug, where, new Sort<LibraryItem>(sort), limit);
/// <summary>
/// Get people's roles from a show.
/// </summary>
/// <param name="showID">The ID of the show</param>
/// <param name="where">A filter function</param>
/// <param name="sort">Sort information (sort order and sort by)</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No <see cref="Show"/> exist with the given ID.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<PeopleRole>> GetPeopleFromShow(int showID,
Expression<Func<PeopleRole, bool>> where = null,
Sort<PeopleRole> sort = default,
Pagination limit = default);
/// <summary>
/// Get people's roles from a show.
/// </summary>
/// <param name="showID">The ID of the show</param>
/// <param name="where">A filter function</param>
/// <param name="sort">A sort by method</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No <see cref="Show"/> exist with the given ID.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<PeopleRole>> GetPeopleFromShow(int showID,
[Optional] Expression<Func<PeopleRole, bool>> where,
Expression<Func<PeopleRole, object>> sort,
Pagination limit = default
) => GetPeopleFromShow(showID, where, new Sort<PeopleRole>(sort), limit);
/// <summary>
/// Get people's roles from a show.
/// </summary>
/// <param name="showSlug">The slug of the show</param>
/// <param name="where">A filter function</param>
/// <param name="sort">Sort information (sort order and sort by)</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No <see cref="Show"/> exist with the given slug.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<PeopleRole>> GetPeopleFromShow(string showSlug,
Expression<Func<PeopleRole, bool>> where = null,
Sort<PeopleRole> sort = default,
Pagination limit = default);
/// <summary>
/// Get people's roles from a show.
/// </summary>
/// <param name="showSlug">The slug of the show</param>
/// <param name="where">A filter function</param>
/// <param name="sort">A sort by method</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No <see cref="Show"/> exist with the given slug.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<PeopleRole>> GetPeopleFromShow(string showSlug,
[Optional] Expression<Func<PeopleRole, bool>> where,
Expression<Func<PeopleRole, object>> sort,
Pagination limit = default
) => GetPeopleFromShow(showSlug, where, new Sort<PeopleRole>(sort), limit);
/// <summary>
/// Get people's roles from a person.
/// </summary>
/// <param name="id">The id of the person</param>
/// <param name="where">A filter function</param>
/// <param name="sort">Sort information (sort order and sort by)</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No <see cref="People"/> exist with the given ID.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<PeopleRole>> GetRolesFromPeople(int id,
Expression<Func<PeopleRole, bool>> where = null,
Sort<PeopleRole> sort = default,
Pagination limit = default);
/// <summary>
/// Get people's roles from a person.
/// </summary>
/// <param name="id">The id of the person</param>
/// <param name="where">A filter function</param>
/// <param name="sort">A sort by method</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No <see cref="People"/> exist with the given ID.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<PeopleRole>> GetRolesFromPeople(int id,
[Optional] Expression<Func<PeopleRole, bool>> where,
Expression<Func<PeopleRole, object>> sort,
Pagination limit = default
) => GetRolesFromPeople(id, where, new Sort<PeopleRole>(sort), limit);
/// <summary>
/// Get people's roles from a person.
/// </summary>
/// <param name="slug">The slug of the person</param>
/// <param name="where">A filter function</param>
/// <param name="sort">Sort information (sort order and sort by)</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No <see cref="People"/> exist with the given slug.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<PeopleRole>> GetRolesFromPeople(string slug,
Expression<Func<PeopleRole, bool>> where = null,
Sort<PeopleRole> sort = default,
Pagination limit = default);
/// <summary>
/// Get people's roles from a person.
/// </summary>
/// <param name="slug">The slug of the person</param>
/// <param name="where">A filter function</param>
/// <param name="sort">A sort by method</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No <see cref="People"/> exist with the given slug.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<PeopleRole>> GetRolesFromPeople(string slug,
[Optional] Expression<Func<PeopleRole, bool>> where,
Expression<Func<PeopleRole, object>> sort,
Pagination limit = default
) => GetRolesFromPeople(slug, where, new Sort<PeopleRole>(sort), limit);
/// <summary>
/// Setup relations between a show, a library and a collection
/// </summary>
/// <param name="showID">The show's ID to setup relations with</param>
/// <param name="libraryID">The library's ID to setup relations with (optional)</param>
/// <param name="collectionID">The collection's ID to setup relations with (optional)</param>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
Task AddShowLink(int showID, int? libraryID, int? collectionID);
/// <summary>
/// Setup relations between a show, a library and a collection
/// </summary>
/// <param name="show">The show to setup relations with</param>
/// <param name="library">The library to setup relations with (optional)</param>
/// <param name="collection">The collection to setup relations with (optional)</param>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
Task AddShowLink([NotNull] Show show, Library library, Collection collection);
/// <summary>
/// Get all resources with filters
/// </summary>
/// <param name="where">A filter function</param>
/// <param name="sort">Sort information (sort order and sort by)</param>
/// <param name="limit">How many items to return and where to start</param>
/// <typeparam name="T">The type of resources to load</typeparam>
/// <returns>A list of resources that match every filters</returns>
Task<ICollection<T>> GetAll<T>(Expression<Func<T, bool>> where = null,
Sort<T> sort = default,
Pagination limit = default)
where T : class, IResource;
/// <summary>
/// Get all resources with filters
/// </summary>
/// <param name="where">A filter function</param>
/// <param name="sort">A sort by function</param>
/// <param name="limit">How many items to return and where to start</param>
/// <typeparam name="T">The type of resources to load</typeparam>
/// <returns>A list of resources that match every filters</returns>
Task<ICollection<T>> GetAll<T>([Optional] Expression<Func<T, bool>> where,
Expression<Func<T, object>> sort,
Pagination limit = default)
where T : class, IResource
{
return GetAll(where, new Sort<T>(sort), limit);
}
/// <summary>
/// Get the count of resources that match the filter
/// </summary>
/// <param name="where">A filter function</param>
/// <typeparam name="T">The type of resources to load</typeparam>
/// <returns>A list of resources that match every filters</returns>
Task<int> GetCount<T>(Expression<Func<T, bool>> where = null)
where T : class, IResource;
/// <summary>
/// Search for a resource
/// </summary>
/// <param name="query">The search query</param>
/// <typeparam name="T">The type of resources</typeparam>
/// <returns>A list of 20 items that match the search query</returns>
Task<ICollection<T>> Search<T>(string query)
where T : class, IResource;
/// <summary>
/// Create a new resource.
/// </summary>
/// <param name="item">The item to register</param>
/// <typeparam name="T">The type of resource</typeparam>
/// <returns>The resource registers and completed by database's information (related items and so on)</returns>
Task<T> Create<T>([NotNull] T item)
where T : class, IResource;
/// <summary>
/// Create a new resource if it does not exist already. If it does, the existing value is returned instead.
/// </summary>
/// <param name="item">The item to register</param>
/// <typeparam name="T">The type of resource</typeparam>
/// <returns>The newly created item or the existing value if it existed.</returns>
Task<T> CreateIfNotExists<T>([NotNull] T item)
where T : class, IResource;
/// <summary>
/// Edit a resource
/// </summary>
/// <param name="item">The resource to edit, it's ID can't change.</param>
/// <param name="resetOld">Should old properties of the resource be discarded or should null values considered as not changed?</param>
/// <typeparam name="T">The type of resources</typeparam>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>The resource edited and completed by database's information (related items and so on)</returns>
Task<T> Edit<T>(T item, bool resetOld)
where T : class, IResource;
/// <summary>
/// Delete a resource.
/// </summary>
/// <param name="item">The resource to delete</param>
/// <typeparam name="T">The type of resource to delete</typeparam>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
Task Delete<T>(T item)
where T : class, IResource;
/// <summary>
/// Delete a resource by it's ID.
/// </summary>
/// <param name="id">The id of the resource to delete</param>
/// <typeparam name="T">The type of resource to delete</typeparam>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
Task Delete<T>(int id)
where T : class, IResource;
/// <summary>
/// Delete a resource by it's slug.
/// </summary>
/// <param name="slug">The slug of the resource to delete</param>
/// <typeparam name="T">The type of resource to delete</typeparam>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
Task Delete<T>(string slug)
where T : class, IResource;
IRepository<User> Users { get; }
}
}

View File

@@ -1,96 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System.Collections.Generic;
using System.Threading.Tasks;
using JetBrains.Annotations;
using Kyoo.Abstractions.Models;
namespace Kyoo.Abstractions.Controllers
{
/// <summary>
/// An interface to automatically retrieve metadata from external providers.
/// </summary>
public interface IMetadataProvider
{
/// <summary>
/// The <see cref="Provider"/> corresponding to this provider.
/// This allow to map metadata to a provider, keep metadata links and
/// know witch <see cref="IMetadataProvider"/> is used for a specific <see cref="Library"/>.
/// </summary>
Provider Provider { get; }
/// <summary>
/// Return a new item with metadata from your provider.
/// </summary>
/// <param name="item">
/// The item to retrieve metadata from. Most of the time, only the name will be available but other
/// properties may be filed by other providers before a call to this method. This can allow you to identify
/// the collection on your provider.
/// </param>
/// <remarks>
/// You must not use metadata from the given <paramref name="item"/>.
/// Merging metadata is the job of Kyoo, a complex <typeparamref name="T"/> is given
/// to make a precise search and give you every available properties, not to discard properties.
/// </remarks>
/// <typeparam name="T">The type of resource to retrieve metadata for.</typeparam>
/// <returns>A new <typeparamref name="T"/> containing metadata from your provider or null</returns>
[ItemCanBeNull]
Task<T> Get<T>([NotNull] T item)
where T : class, IResource;
/// <summary>
/// Search for a specific type of items with a given query.
/// </summary>
/// <param name="query">The search query to use.</param>
/// <typeparam name="T">The type of resource to search metadata for.</typeparam>
/// <returns>The list of items that could be found on this specific provider.</returns>
[ItemNotNull]
Task<ICollection<T>> Search<T>(string query)
where T : class, IResource;
}
/// <summary>
/// A special <see cref="IMetadataProvider"/> that merge results.
/// This interface exists to specify witch provider to use but it can be used like any other metadata provider.
/// </summary>
public abstract class AProviderComposite : IMetadataProvider
{
/// <inheritdoc />
[ItemNotNull]
public abstract Task<T> Get<T>(T item)
where T : class, IResource;
/// <inheritdoc />
public abstract Task<ICollection<T>> Search<T>(string query)
where T : class, IResource;
/// <summary>
/// Since this is a composite and not a real provider, no metadata is available.
/// It is not meant to be stored or selected. This class will handle merge based on what is required.
/// </summary>
public Provider Provider => null;
/// <summary>
/// Select witch providers to use.
/// The <see cref="IMetadataProvider"/> associated with the given <see cref="Provider"/> will be used.
/// </summary>
/// <param name="providers">The list of providers to use</param>
public abstract void UseProviders(IEnumerable<Provider> providers);
}
}

View File

@@ -34,53 +34,16 @@ namespace Kyoo.Abstractions.Controllers
[UsedImplicitly(ImplicitUseTargetFlags.WithInheritors)]
public interface IPlugin
{
/// <summary>
/// A slug to identify this plugin in queries.
/// </summary>
string Slug { get; }
/// <summary>
/// The name of the plugin
/// </summary>
string Name { get; }
/// <summary>
/// The description of this plugin. This will be displayed on the "installed plugins" page.
/// </summary>
string Description { get; }
/// <summary>
/// <c>true</c> if the plugin should be enabled, <c>false</c> otherwise.
/// If a plugin is not enabled, no configure method will be called.
/// This allow one to enable a plugin if a specific configuration value is set or if the environment contains
/// the right settings.
/// </summary>
/// <remarks>
/// By default, a plugin is always enabled. This method can be overriden to change this behavior.
/// </remarks>
virtual bool Enabled => true;
/// <summary>
/// A list of types that will be available via the IOptions interfaces and will be listed inside
/// an IConfiguration.
///
/// If a field should be loosely typed, <see cref="Dictionary{TKey,TValue}"/> or <c>null</c>
/// can be specified.
/// WARNING: null means an unmanaged type that won't be editable. This can be used
/// for external libraries or variable arguments.
/// </summary>
/// <remarks>
/// All use of the configuration must be specified here and not registered elsewhere, if a type is registered
/// elsewhere the configuration won't be editable via the <see cref="IConfigurationManager"/> and all values
/// will be discarded on edit.
/// </remarks>
Dictionary<string, Type> Configuration { get; }
/// <summary>
/// An optional configuration step to allow a plugin to change asp net configurations.
/// </summary>
/// <seealso cref="SA"/>
virtual IEnumerable<IStartupAction> ConfigureSteps => ArraySegment<IStartupAction>.Empty;
IEnumerable<IStartupAction> ConfigureSteps => ArraySegment<IStartupAction>.Empty;
/// <summary>
/// A configure method that will be run on plugin's startup.
@@ -101,15 +64,5 @@ namespace Kyoo.Abstractions.Controllers
{
// Skipped
}
/// <summary>
/// An optional function to execute and initialize your plugin.
/// It can be used to initialize a database connection, fill initial data or anything.
/// </summary>
/// <param name="provider">A service provider to request services</param>
void Initialize(IServiceProvider provider)
{
// Skipped
}
}
}

View File

@@ -18,12 +18,10 @@
using System;
using System.Collections.Generic;
using System.Linq.Expressions;
using System.Runtime.InteropServices;
using System.Threading.Tasks;
using JetBrains.Annotations;
using Kyoo.Abstractions.Models;
using Kyoo.Abstractions.Models.Exceptions;
using Kyoo.Abstractions.Models.Utils;
namespace Kyoo.Abstractions.Controllers
{
@@ -32,125 +30,181 @@ namespace Kyoo.Abstractions.Controllers
/// </summary>
/// <typeparam name="T">The resource's type that this repository manage.</typeparam>
public interface IRepository<T> : IBaseRepository
where T : class, IResource
where T : IResource, IQuery
{
/// <summary>
/// The event handler type for all events of this repository.
/// </summary>
/// <param name="resource">The resource created/modified/deleted</param>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
public delegate Task ResourceEventHandler(T resource);
/// <summary>
/// Get a resource from it's ID.
/// </summary>
/// <param name="id">The id of the resource</param>
/// <param name="include">The related fields to include.</param>
/// <exception cref="ItemNotFoundException">If the item could not be found.</exception>
/// <returns>The resource found</returns>
[ItemNotNull]
Task<T> Get(int id);
Task<T> Get(Guid id, Include<T>? include = default);
/// <summary>
/// Get a resource from it's slug.
/// </summary>
/// <param name="slug">The slug of the resource</param>
/// <param name="include">The related fields to include.</param>
/// <exception cref="ItemNotFoundException">If the item could not be found.</exception>
/// <returns>The resource found</returns>
[ItemNotNull]
Task<T> Get(string slug);
Task<T> Get(string slug, Include<T>? include = default);
/// <summary>
/// Get the first resource that match the predicate.
/// </summary>
/// <param name="where">A predicate to filter the resource.</param>
/// <param name="filter">A predicate to filter the resource.</param>
/// <param name="include">The related fields to include.</param>
/// <param name="sortBy">A custom sort method to handle cases where multiples items match the filters.</param>
/// <param name="reverse">Reverse the sort.</param>
/// <param name="afterId">Select the first element after this id if it was in a list.</param>
/// <exception cref="ItemNotFoundException">If the item could not be found.</exception>
/// <returns>The resource found</returns>
[ItemNotNull]
Task<T> Get(Expression<Func<T, bool>> where);
Task<T> Get(
Filter<T> filter,
Include<T>? include = default,
Sort<T>? sortBy = default,
bool reverse = false,
Guid? afterId = default
);
/// <summary>
/// Get a resource from it's ID or null if it is not found.
/// </summary>
/// <param name="id">The id of the resource</param>
/// <param name="include">The related fields to include.</param>
/// <returns>The resource found</returns>
[ItemCanBeNull]
Task<T> GetOrDefault(int id);
Task<T?> GetOrDefault(Guid id, Include<T>? include = default);
/// <summary>
/// Get a resource from it's slug or null if it is not found.
/// </summary>
/// <param name="slug">The slug of the resource</param>
/// <param name="include">The related fields to include.</param>
/// <returns>The resource found</returns>
[ItemCanBeNull]
Task<T> GetOrDefault(string slug);
Task<T?> GetOrDefault(string slug, Include<T>? include = default);
/// <summary>
/// Get the first resource that match the predicate or null if it is not found.
/// </summary>
/// <param name="where">A predicate to filter the resource.</param>
/// <param name="filter">A predicate to filter the resource.</param>
/// <param name="include">The related fields to include.</param>
/// <param name="sortBy">A custom sort method to handle cases where multiples items match the filters.</param>
/// <param name="reverse">Reverse the sort.</param>
/// <param name="afterId">Select the first element after this id if it was in a list.</param>
/// <returns>The resource found</returns>
[ItemCanBeNull]
Task<T> GetOrDefault(Expression<Func<T, bool>> where, Sort<T> sortBy = default);
Task<T?> GetOrDefault(
Filter<T>? filter,
Include<T>? include = default,
Sort<T>? sortBy = default,
bool reverse = false,
Guid? afterId = default
);
/// <summary>
/// Search for resources.
/// Search for resources with the database.
/// </summary>
/// <param name="query">The query string.</param>
/// <param name="include">The related fields to include.</param>
/// <returns>A list of resources found</returns>
[ItemNotNull]
Task<ICollection<T>> Search(string query);
Task<ICollection<T>> Search(string query, Include<T>? include = default);
/// <summary>
/// Get every resources that match all filters
/// </summary>
/// <param name="where">A filter predicate</param>
/// <param name="filter">A filter predicate</param>
/// <param name="sort">Sort information about the query (sort by, sort order)</param>
/// <param name="include">The related fields to include.</param>
/// <param name="limit">How pagination should be done (where to start and how many to return)</param>
/// <returns>A list of resources that match every filters</returns>
[ItemNotNull]
Task<ICollection<T>> GetAll(Expression<Func<T, bool>> where = null,
Sort<T> sort = default,
Pagination limit = default);
/// <summary>
/// Get every resources that match all filters
/// </summary>
/// <param name="where">A filter predicate</param>
/// <param name="sort">A sort by predicate. The order is ascending.</param>
/// <param name="limit">How pagination should be done (where to start and how many to return)</param>
/// <returns>A list of resources that match every filters</returns>
[ItemNotNull]
Task<ICollection<T>> GetAll([Optional] Expression<Func<T, bool>> where,
Expression<Func<T, object>> sort,
Pagination limit = default
) => GetAll(where, new Sort<T>(sort), limit);
Task<ICollection<T>> GetAll(
Filter<T>? filter = null,
Sort<T>? sort = default,
Include<T>? include = default,
Pagination? limit = default
);
/// <summary>
/// Get the number of resources that match the filter's predicate.
/// </summary>
/// <param name="where">A filter predicate</param>
/// <param name="filter">A filter predicate</param>
/// <returns>How many resources matched that filter</returns>
Task<int> GetCount(Expression<Func<T, bool>> where = null);
Task<int> GetCount(Filter<T>? filter = null);
/// <summary>
/// Map a list of ids to a list of items (keep the order).
/// </summary>
/// <param name="ids">The list of items id.</param>
/// <param name="include">The related fields to include.</param>
/// <returns>A list of resources mapped from ids.</returns>
Task<ICollection<T>> FromIds(IList<Guid> ids, Include<T>? include = default);
/// <summary>
/// Create a new resource.
/// </summary>
/// <param name="obj">The item to register</param>
/// <returns>The resource registers and completed by database's information (related items and so on)</returns>
[ItemNotNull]
Task<T> Create([NotNull] T obj);
Task<T> Create(T obj);
/// <summary>
/// Create a new resource if it does not exist already. If it does, the existing value is returned instead.
/// </summary>
/// <param name="obj">The object to create</param>
/// <returns>The newly created item or the existing value if it existed.</returns>
[ItemNotNull]
Task<T> CreateIfNotExists([NotNull] T obj);
Task<T> CreateIfNotExists(T obj);
/// <summary>
/// Edit a resource
/// Called when a resource has been created.
/// </summary>
static event ResourceEventHandler OnCreated;
/// <summary>
/// Callback that should be called after a resource has been created.
/// </summary>
/// <param name="obj">The resource newly created.</param>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
protected static Task OnResourceCreated(T obj) =>
OnCreated?.Invoke(obj) ?? Task.CompletedTask;
/// <summary>
/// Edit a resource and replace every property
/// </summary>
/// <param name="edited">The resource to edit, it's ID can't change.</param>
/// <param name="resetOld">Should old properties of the resource be discarded or should null values considered as not changed?</param>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>The resource edited and completed by database's information (related items and so on)</returns>
[ItemNotNull]
Task<T> Edit([NotNull] T edited, bool resetOld);
Task<T> Edit(T edited);
/// <summary>
/// Edit only specific properties of a resource
/// </summary>
/// <param name="id">The id of the resource to edit</param>
/// <param name="patch">
/// A method that will be called when you need to update every properties that you want to
/// persist. It can return false to abort the process via an ArgumentException
/// </param>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>The resource edited and completed by database's information (related items and so on)</returns>
Task<T> Patch(Guid id, Func<T, Task<bool>> patch);
/// <summary>
/// Called when a resource has been edited.
/// </summary>
static event ResourceEventHandler OnEdited;
/// <summary>
/// Callback that should be called after a resource has been edited.
/// </summary>
/// <param name="obj">The resource newly edited.</param>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
protected static Task OnResourceEdited(T obj) =>
OnEdited?.Invoke(obj) ?? Task.CompletedTask;
/// <summary>
/// Delete a resource by it's ID
@@ -158,7 +212,7 @@ namespace Kyoo.Abstractions.Controllers
/// <param name="id">The ID of the resource</param>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
Task Delete(int id);
Task Delete(Guid id);
/// <summary>
/// Delete a resource by it's slug
@@ -174,14 +228,27 @@ namespace Kyoo.Abstractions.Controllers
/// <param name="obj">The resource to delete</param>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
Task Delete([NotNull] T obj);
Task Delete(T obj);
/// <summary>
/// Delete all resources that match the predicate.
/// </summary>
/// <param name="where">A predicate to filter resources to delete. Every resource that match this will be deleted.</param>
/// <param name="filter">A predicate to filter resources to delete. Every resource that match this will be deleted.</param>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
Task DeleteAll([NotNull] Expression<Func<T, bool>> where);
Task DeleteAll(Filter<T> filter);
/// <summary>
/// Called when a resource has been edited.
/// </summary>
static event ResourceEventHandler OnDeleted;
/// <summary>
/// Callback that should be called after a resource has been deleted.
/// </summary>
/// <param name="obj">The resource newly deleted.</param>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
protected static Task OnResourceDeleted(T obj) =>
OnDeleted?.Invoke(obj) ?? Task.CompletedTask;
}
/// <summary>
@@ -194,382 +261,4 @@ namespace Kyoo.Abstractions.Controllers
/// </summary>
Type RepositoryType { get; }
}
/// <summary>
/// A repository to handle shows.
/// </summary>
public interface IShowRepository : IRepository<Show>
{
/// <summary>
/// Link a show to a collection and/or a library. The given show is now part of those containers.
/// If both a library and a collection are given, the collection is added to the library too.
/// </summary>
/// <param name="showID">The ID of the show</param>
/// <param name="libraryID">The ID of the library (optional)</param>
/// <param name="collectionID">The ID of the collection (optional)</param>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
Task AddShowLink(int showID, int? libraryID, int? collectionID);
/// <summary>
/// Get a show's slug from it's ID.
/// </summary>
/// <param name="showID">The ID of the show</param>
/// <exception cref="ItemNotFoundException">If a show with the given ID is not found.</exception>
/// <returns>The show's slug</returns>
Task<string> GetSlug(int showID);
}
/// <summary>
/// A repository to handle seasons.
/// </summary>
public interface ISeasonRepository : IRepository<Season>
{
/// <summary>
/// Get a season from it's showID and it's seasonNumber
/// </summary>
/// <param name="showID">The id of the show</param>
/// <param name="seasonNumber">The season's number</param>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>The season found</returns>
Task<Season> Get(int showID, int seasonNumber);
/// <summary>
/// Get a season from it's show slug and it's seasonNumber
/// </summary>
/// <param name="showSlug">The slug of the show</param>
/// <param name="seasonNumber">The season's number</param>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>The season found</returns>
Task<Season> Get(string showSlug, int seasonNumber);
/// <summary>
/// Get a season from it's showID and it's seasonNumber or null if it is not found.
/// </summary>
/// <param name="showID">The id of the show</param>
/// <param name="seasonNumber">The season's number</param>
/// <returns>The season found</returns>
Task<Season> GetOrDefault(int showID, int seasonNumber);
/// <summary>
/// Get a season from it's show slug and it's seasonNumber or null if it is not found.
/// </summary>
/// <param name="showSlug">The slug of the show</param>
/// <param name="seasonNumber">The season's number</param>
/// <returns>The season found</returns>
Task<Season> GetOrDefault(string showSlug, int seasonNumber);
}
/// <summary>
/// The repository to handle episodes
/// </summary>
public interface IEpisodeRepository : IRepository<Episode>
{
// TODO replace the next methods with extension methods.
/// <summary>
/// Get a episode from it's showID, it's seasonNumber and it's episode number.
/// </summary>
/// <param name="showID">The id of the show</param>
/// <param name="seasonNumber">The season's number</param>
/// <param name="episodeNumber">The episode's number</param>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>The episode found</returns>
Task<Episode> Get(int showID, int seasonNumber, int episodeNumber);
/// <summary>
/// Get a episode from it's show slug, it's seasonNumber and it's episode number.
/// </summary>
/// <param name="showSlug">The slug of the show</param>
/// <param name="seasonNumber">The season's number</param>
/// <param name="episodeNumber">The episode's number</param>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>The episode found</returns>
Task<Episode> Get(string showSlug, int seasonNumber, int episodeNumber);
/// <summary>
/// Get a episode from it's showID, it's seasonNumber and it's episode number or null if it is not found.
/// </summary>
/// <param name="showID">The id of the show</param>
/// <param name="seasonNumber">The season's number</param>
/// <param name="episodeNumber">The episode's number</param>
/// <returns>The episode found</returns>
Task<Episode> GetOrDefault(int showID, int seasonNumber, int episodeNumber);
/// <summary>
/// Get a episode from it's show slug, it's seasonNumber and it's episode number or null if it is not found.
/// </summary>
/// <param name="showSlug">The slug of the show</param>
/// <param name="seasonNumber">The season's number</param>
/// <param name="episodeNumber">The episode's number</param>
/// <returns>The episode found</returns>
Task<Episode> GetOrDefault(string showSlug, int seasonNumber, int episodeNumber);
/// <summary>
/// Get a episode from it's showID and it's absolute number.
/// </summary>
/// <param name="showID">The id of the show</param>
/// <param name="absoluteNumber">The episode's absolute number (The episode number does not reset to 1 after the end of a season.</param>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>The episode found</returns>
Task<Episode> GetAbsolute(int showID, int absoluteNumber);
/// <summary>
/// Get a episode from it's showID and it's absolute number.
/// </summary>
/// <param name="showSlug">The slug of the show</param>
/// <param name="absoluteNumber">The episode's absolute number (The episode number does not reset to 1 after the end of a season.</param>
/// <exception cref="ItemNotFoundException">If the item is not found</exception>
/// <returns>The episode found</returns>
Task<Episode> GetAbsolute(string showSlug, int absoluteNumber);
}
/// <summary>
/// A repository to handle tracks
/// </summary>
public interface ITrackRepository : IRepository<Track> { }
/// <summary>
/// A repository to handle libraries.
/// </summary>
public interface ILibraryRepository : IRepository<Library> { }
/// <summary>
/// A repository to handle library items (A wrapper around shows and collections).
/// </summary>
public interface ILibraryItemRepository : IRepository<LibraryItem>
{
/// <summary>
/// Get items (A wrapper around shows or collections) from a library.
/// </summary>
/// <param name="id">The ID of the library</param>
/// <param name="where">A filter function</param>
/// <param name="sort">Sort information (sort order and sort by)</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No library exist with the given ID.</exception>
/// <returns>A list of items that match every filters</returns>
public Task<ICollection<LibraryItem>> GetFromLibrary(int id,
Expression<Func<LibraryItem, bool>> where = null,
Sort<LibraryItem> sort = default,
Pagination limit = default);
/// <summary>
/// Get items (A wrapper around shows or collections) from a library.
/// </summary>
/// <param name="id">The ID of the library</param>
/// <param name="where">A filter function</param>
/// <param name="sort">A sort by method</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No library exist with the given ID.</exception>
/// <returns>A list of items that match every filters</returns>
public Task<ICollection<LibraryItem>> GetFromLibrary(int id,
[Optional] Expression<Func<LibraryItem, bool>> where,
Expression<Func<LibraryItem, object>> sort,
Pagination limit = default
) => GetFromLibrary(id, where, new Sort<LibraryItem>(sort), limit);
/// <summary>
/// Get items (A wrapper around shows or collections) from a library.
/// </summary>
/// <param name="slug">The slug of the library</param>
/// <param name="where">A filter function</param>
/// <param name="sort">Sort information (sort order and sort by)</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No library exist with the given slug.</exception>
/// <returns>A list of items that match every filters</returns>
public Task<ICollection<LibraryItem>> GetFromLibrary(string slug,
Expression<Func<LibraryItem, bool>> where = null,
Sort<LibraryItem> sort = default,
Pagination limit = default);
/// <summary>
/// Get items (A wrapper around shows or collections) from a library.
/// </summary>
/// <param name="slug">The slug of the library</param>
/// <param name="where">A filter function</param>
/// <param name="sort">A sort by method</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No library exist with the given slug.</exception>
/// <returns>A list of items that match every filters</returns>
public Task<ICollection<LibraryItem>> GetFromLibrary(string slug,
[Optional] Expression<Func<LibraryItem, bool>> where,
Expression<Func<LibraryItem, object>> sort,
Pagination limit = default
) => GetFromLibrary(slug, where, new Sort<LibraryItem>(sort), limit);
}
/// <summary>
/// A repository for collections
/// </summary>
public interface ICollectionRepository : IRepository<Collection> { }
/// <summary>
/// A repository for genres.
/// </summary>
public interface IGenreRepository : IRepository<Genre> { }
/// <summary>
/// A repository for studios.
/// </summary>
public interface IStudioRepository : IRepository<Studio> { }
/// <summary>
/// A repository for people.
/// </summary>
public interface IPeopleRepository : IRepository<People>
{
/// <summary>
/// Get people's roles from a show.
/// </summary>
/// <param name="showID">The ID of the show</param>
/// <param name="where">A filter function</param>
/// <param name="sort">Sort information (sort order and sort by)</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No <see cref="Show"/> exist with the given ID.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<PeopleRole>> GetFromShow(int showID,
Expression<Func<PeopleRole, bool>> where = null,
Sort<PeopleRole> sort = default,
Pagination limit = default);
/// <summary>
/// Get people's roles from a show.
/// </summary>
/// <param name="showID">The ID of the show</param>
/// <param name="where">A filter function</param>
/// <param name="sort">A sort by method</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No <see cref="Show"/> exist with the given ID.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<PeopleRole>> GetFromShow(int showID,
[Optional] Expression<Func<PeopleRole, bool>> where,
Expression<Func<PeopleRole, object>> sort,
Pagination limit = default
) => GetFromShow(showID, where, new Sort<PeopleRole>(sort), limit);
/// <summary>
/// Get people's roles from a show.
/// </summary>
/// <param name="showSlug">The slug of the show</param>
/// <param name="where">A filter function</param>
/// <param name="sort">Sort information (sort order and sort by)</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No <see cref="Show"/> exist with the given slug.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<PeopleRole>> GetFromShow(string showSlug,
Expression<Func<PeopleRole, bool>> where = null,
Sort<PeopleRole> sort = default,
Pagination limit = default);
/// <summary>
/// Get people's roles from a show.
/// </summary>
/// <param name="showSlug">The slug of the show</param>
/// <param name="where">A filter function</param>
/// <param name="sort">A sort by method</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No <see cref="Show"/> exist with the given slug.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<PeopleRole>> GetFromShow(string showSlug,
[Optional] Expression<Func<PeopleRole, bool>> where,
Expression<Func<PeopleRole, object>> sort,
Pagination limit = default
) => GetFromShow(showSlug, where, new Sort<PeopleRole>(sort), limit);
/// <summary>
/// Get people's roles from a person.
/// </summary>
/// <param name="id">The id of the person</param>
/// <param name="where">A filter function</param>
/// <param name="sort">Sort information (sort order and sort by)</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No <see cref="People"/> exist with the given ID.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<PeopleRole>> GetFromPeople(int id,
Expression<Func<PeopleRole, bool>> where = null,
Sort<PeopleRole> sort = default,
Pagination limit = default);
/// <summary>
/// Get people's roles from a person.
/// </summary>
/// <param name="id">The id of the person</param>
/// <param name="where">A filter function</param>
/// <param name="sort">A sort by method</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No <see cref="People"/> exist with the given ID.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<PeopleRole>> GetFromPeople(int id,
[Optional] Expression<Func<PeopleRole, bool>> where,
Expression<Func<PeopleRole, object>> sort,
Pagination limit = default
) => GetFromPeople(id, where, new Sort<PeopleRole>(sort), limit);
/// <summary>
/// Get people's roles from a person.
/// </summary>
/// <param name="slug">The slug of the person</param>
/// <param name="where">A filter function</param>
/// <param name="sort">Sort information (sort order and sort by)</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No <see cref="People"/> exist with the given slug.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<PeopleRole>> GetFromPeople(string slug,
Expression<Func<PeopleRole, bool>> where = null,
Sort<PeopleRole> sort = default,
Pagination limit = default);
/// <summary>
/// Get people's roles from a person.
/// </summary>
/// <param name="slug">The slug of the person</param>
/// <param name="where">A filter function</param>
/// <param name="sort">A sort by method</param>
/// <param name="limit">How many items to return and where to start</param>
/// <exception cref="ItemNotFoundException">No <see cref="People"/> exist with the given slug.</exception>
/// <returns>A list of items that match every filters</returns>
Task<ICollection<PeopleRole>> GetFromPeople(string slug,
[Optional] Expression<Func<PeopleRole, bool>> where,
Expression<Func<PeopleRole, object>> sort,
Pagination limit = default
) => GetFromPeople(slug, where, new Sort<PeopleRole>(sort), limit);
}
/// <summary>
/// A repository to handle providers.
/// </summary>
public interface IProviderRepository : IRepository<Provider>
{
/// <summary>
/// Get a list of external ids that match all filters
/// </summary>
/// <param name="where">A predicate to add arbitrary filter</param>
/// <param name="sort">Sort information (sort order and sort by)</param>
/// <param name="limit">Pagination information (where to start and how many to get)</param>
/// <typeparam name="T">The type of metadata to retrieve</typeparam>
/// <returns>A filtered list of external ids.</returns>
Task<ICollection<MetadataID>> GetMetadataID<T>(Expression<Func<MetadataID, bool>> where = null,
Sort<MetadataID> sort = default,
Pagination limit = default)
where T : class, IMetadata;
/// <summary>
/// Get a list of external ids that match all filters
/// </summary>
/// <param name="where">A predicate to add arbitrary filter</param>
/// <param name="sort">A sort by expression</param>
/// <param name="limit">Pagination information (where to start and how many to get)</param>
/// <typeparam name="T">The type of metadata to retrieve</typeparam>
/// <returns>A filtered list of external ids.</returns>
Task<ICollection<MetadataID>> GetMetadataID<T>([Optional] Expression<Func<MetadataID, bool>> where,
Expression<Func<MetadataID, object>> sort,
Pagination limit = default
)
where T : class, IMetadata
=> GetMetadataID<T>(where, new Sort<MetadataID>(sort), limit);
}
/// <summary>
/// A repository to handle users.
/// </summary>
public interface IUserRepository : IRepository<User> { }
}

View File

@@ -0,0 +1,119 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System.Threading.Tasks;
using Kyoo.Abstractions.Models;
using Kyoo.Abstractions.Models.Utils;
namespace Kyoo.Abstractions.Controllers;
/// <summary>
/// The service to search items.
/// </summary>
public interface ISearchManager
{
/// <summary>
/// Search for items.
/// </summary>
/// <param name="query">The seach query.</param>
/// <param name="sortBy">Sort information about the query (sort by, sort order)</param>
/// <param name="pagination">How pagination should be done (where to start and how many to return)</param>
/// <param name="include">The related fields to include.</param>
/// <returns>A list of resources that match every filters</returns>
public Task<SearchPage<ILibraryItem>.SearchResult> SearchItems(
string? query,
Sort<ILibraryItem> sortBy,
SearchPagination pagination,
Include<ILibraryItem>? include = default
);
/// <summary>
/// Search for movies.
/// </summary>
/// <param name="query">The seach query.</param>
/// <param name="sortBy">Sort information about the query (sort by, sort order)</param>
/// <param name="pagination">How pagination should be done (where to start and how many to return)</param>
/// <param name="include">The related fields to include.</param>
/// <returns>A list of resources that match every filters</returns>
public Task<SearchPage<Movie>.SearchResult> SearchMovies(
string? query,
Sort<Movie> sortBy,
SearchPagination pagination,
Include<Movie>? include = default
);
/// <summary>
/// Search for shows.
/// </summary>
/// <param name="query">The seach query.</param>
/// <param name="sortBy">Sort information about the query (sort by, sort order)</param>
/// <param name="pagination">How pagination should be done (where to start and how many to return)</param>
/// <param name="include">The related fields to include.</param>
/// <returns>A list of resources that match every filters</returns>
public Task<SearchPage<Show>.SearchResult> SearchShows(
string? query,
Sort<Show> sortBy,
SearchPagination pagination,
Include<Show>? include = default
);
/// <summary>
/// Search for collections.
/// </summary>
/// <param name="query">The seach query.</param>
/// <param name="sortBy">Sort information about the query (sort by, sort order)</param>
/// <param name="pagination">How pagination should be done (where to start and how many to return)</param>
/// <param name="include">The related fields to include.</param>
/// <returns>A list of resources that match every filters</returns>
public Task<SearchPage<Collection>.SearchResult> SearchCollections(
string? query,
Sort<Collection> sortBy,
SearchPagination pagination,
Include<Collection>? include = default
);
/// <summary>
/// Search for episodes.
/// </summary>
/// <param name="query">The seach query.</param>
/// <param name="sortBy">Sort information about the query (sort by, sort order)</param>
/// <param name="pagination">How pagination should be done (where to start and how many to return)</param>
/// <param name="include">The related fields to include.</param>
/// <returns>A list of resources that match every filters</returns>
public Task<SearchPage<Episode>.SearchResult> SearchEpisodes(
string? query,
Sort<Episode> sortBy,
SearchPagination pagination,
Include<Episode>? include = default
);
/// <summary>
/// Search for studios.
/// </summary>
/// <param name="query">The seach query.</param>
/// <param name="sortBy">Sort information about the query (sort by, sort order)</param>
/// <param name="pagination">How pagination should be done (where to start and how many to return)</param>
/// <param name="include">The related fields to include.</param>
/// <returns>A list of resources that match every filters</returns>
public Task<SearchPage<Studio>.SearchResult> SearchStudios(
string? query,
Sort<Studio> sortBy,
SearchPagination pagination,
Include<Studio>? include = default
);
}

View File

@@ -1,212 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using JetBrains.Annotations;
using Kyoo.Abstractions.Models;
using Kyoo.Abstractions.Models.Exceptions;
namespace Kyoo.Abstractions.Controllers
{
/// <summary>
/// A common interface that tasks should implement.
/// </summary>
public interface ITask
{
/// <summary>
/// The list of parameters
/// </summary>
/// <returns>
/// All parameters that this task as. Every one of them will be given to the run function with a value.
/// </returns>
public TaskParameters GetParameters();
/// <summary>
/// Start this task.
/// </summary>
/// <param name="arguments">
/// The list of parameters.
/// </param>
/// <param name="progress">
/// The progress reporter. Used to inform the sender the percentage of completion of this task
/// .</param>
/// <param name="cancellationToken">A token to request the task's cancellation.
/// If this task is not cancelled quickly, it might be killed by the runner.
/// </param>
/// <exception cref="TaskFailedException">
/// An exception meaning that the task has failed for handled reasons like invalid arguments,
/// invalid environment, missing plugins or failures not related to a default in the code.
/// This exception allow the task to display a failure message to the end user while others exceptions
/// will be displayed as unhandled exceptions and display a stack trace.
/// </exception>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
public Task Run([NotNull] TaskParameters arguments,
[NotNull] IProgress<float> progress,
CancellationToken cancellationToken);
}
/// <summary>
/// A single task parameter. This struct contains metadata to display and utility functions to get them in the task.
/// </summary>
/// <remarks>This struct will be used to generate the swagger documentation of the task.</remarks>
public record TaskParameter
{
/// <summary>
/// The name of this parameter.
/// </summary>
public string Name { get; init; }
/// <summary>
/// The description of this parameter.
/// </summary>
public string Description { get; init; }
/// <summary>
/// The type of this parameter.
/// </summary>
public Type Type { get; init; }
/// <summary>
/// Is this parameter required or can it be ignored?
/// </summary>
public bool IsRequired { get; init; }
/// <summary>
/// The default value of this object.
/// </summary>
public object DefaultValue { get; init; }
/// <summary>
/// The value of the parameter.
/// </summary>
private object _Value { get; init; }
/// <summary>
/// Create a new task parameter.
/// </summary>
/// <param name="name">The name of the parameter</param>
/// <param name="description">The description of the parameter</param>
/// <typeparam name="T">The type of the parameter.</typeparam>
/// <returns>A new task parameter.</returns>
public static TaskParameter Create<T>(string name, string description)
{
return new TaskParameter
{
Name = name,
Description = description,
Type = typeof(T)
};
}
/// <summary>
/// Create a new required task parameter.
/// </summary>
/// <param name="name">The name of the parameter</param>
/// <param name="description">The description of the parameter</param>
/// <typeparam name="T">The type of the parameter.</typeparam>
/// <returns>A new task parameter.</returns>
public static TaskParameter CreateRequired<T>(string name, string description)
{
return new TaskParameter
{
Name = name,
Description = description,
Type = typeof(T),
IsRequired = true
};
}
/// <summary>
/// Create a parameter's value to give to a task.
/// </summary>
/// <param name="name">The name of the parameter</param>
/// <param name="value">The value of the parameter. It's type will be used as parameter's type.</param>
/// <typeparam name="T">The type of the parameter</typeparam>
/// <returns>A TaskParameter that can be used as value.</returns>
public static TaskParameter CreateValue<T>(string name, T value)
{
return new()
{
Name = name,
Type = typeof(T),
_Value = value
};
}
/// <summary>
/// Create a parameter's value for the current parameter.
/// </summary>
/// <param name="value">The value to use</param>
/// <returns>A new parameter's value for this current parameter</returns>
public TaskParameter CreateValue(object value)
{
return this with { _Value = value };
}
/// <summary>
/// Get the value of this parameter. If the value is of the wrong type, it will be converted.
/// </summary>
/// <typeparam name="T">The type of this parameter</typeparam>
/// <returns>The value of this parameter.</returns>
public T As<T>()
{
if (typeof(T) == typeof(object))
return (T)_Value;
if (_Value is IResource resource)
{
if (typeof(T) == typeof(string))
return (T)(object)resource.Slug;
if (typeof(T) == typeof(int))
return (T)(object)resource.ID;
}
return (T)Convert.ChangeType(_Value, typeof(T));
}
}
/// <summary>
/// A parameters container implementing an indexer to allow simple usage of parameters.
/// </summary>
public class TaskParameters : List<TaskParameter>
{
/// <summary>
/// An indexer that return the parameter with the specified name.
/// </summary>
/// <param name="name">The name of the task (case sensitive)</param>
public TaskParameter this[string name] => this.FirstOrDefault(x => x.Name == name);
/// <summary>
/// Create a new, empty, <see cref="TaskParameters"/>
/// </summary>
public TaskParameters() { }
/// <summary>
/// Create a <see cref="TaskParameters"/> with an initial parameters content.
/// </summary>
/// <param name="parameters">The list of parameters</param>
public TaskParameters(IEnumerable<TaskParameter> parameters)
{
AddRange(parameters);
}
}
}

View File

@@ -1,100 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Threading;
using Kyoo.Abstractions.Models.Attributes;
using Kyoo.Abstractions.Models.Exceptions;
namespace Kyoo.Abstractions.Controllers
{
/// <summary>
/// A service to handle long running tasks.
/// </summary>
/// <remarks>The concurrent number of running tasks is implementation dependent.</remarks>
public interface ITaskManager
{
/// <summary>
/// Start a new task (or queue it).
/// </summary>
/// <param name="taskSlug">
/// The slug of the task to run.
/// </param>
/// <param name="progress">
/// A progress reporter to know the percentage of completion of the task.
/// </param>
/// <param name="arguments">
/// A list of arguments to pass to the task. An automatic conversion will be made if arguments to not fit.
/// </param>
/// <param name="cancellationToken">
/// A custom cancellation token for the task.
/// </param>
/// <exception cref="ArgumentException">
/// If the number of arguments is invalid, if an argument can't be converted or if the task finds the argument
/// invalid.
/// </exception>
/// <exception cref="ItemNotFoundException">
/// The task could not be found.
/// </exception>
void StartTask(string taskSlug,
[NotNull] IProgress<float> progress,
Dictionary<string, object> arguments = null,
CancellationToken? cancellationToken = null);
/// <summary>
/// Start a new task (or queue it).
/// </summary>
/// <param name="progress">
/// A progress reporter to know the percentage of completion of the task.
/// </param>
/// <param name="arguments">
/// A list of arguments to pass to the task. An automatic conversion will be made if arguments to not fit.
/// </param>
/// <typeparam name="T">
/// The type of the task to start.
/// </typeparam>
/// <param name="cancellationToken">
/// A custom cancellation token for the task.
/// </param>
/// <exception cref="ArgumentException">
/// If the number of arguments is invalid, if an argument can't be converted or if the task finds the argument
/// invalid.
/// </exception>
/// <exception cref="ItemNotFoundException">
/// The task could not be found.
/// </exception>
void StartTask<T>([NotNull] IProgress<float> progress,
Dictionary<string, object> arguments = null,
CancellationToken? cancellationToken = null)
where T : ITask;
/// <summary>
/// Get all currently running tasks
/// </summary>
/// <returns>A list of currently running tasks.</returns>
ICollection<(TaskMetadataAttribute, ITask)> GetRunningTasks();
/// <summary>
/// Get all available tasks
/// </summary>
/// <returns>A list of every tasks that this instance know.</returns>
ICollection<TaskMetadataAttribute> GetAllTasks();
}
}

View File

@@ -17,9 +17,10 @@
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System.Threading.Tasks;
using JetBrains.Annotations;
using Kyoo.Abstractions.Models;
#nullable enable
namespace Kyoo.Abstractions.Controllers
{
/// <summary>
@@ -34,22 +35,31 @@ namespace Kyoo.Abstractions.Controllers
/// <param name="item">
/// The item to cache images.
/// </param>
/// <param name="alwaysDownload">
/// <c>true</c> if images should be downloaded even if they already exists locally, <c>false</c> otherwise.
/// </param>
/// <typeparam name="T">The type of the item</typeparam>
/// <returns><c>true</c> if an image has been downloaded, <c>false</c> otherwise.</returns>
Task<bool> DownloadImages<T>([NotNull] T item, bool alwaysDownload = false)
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
Task DownloadImages<T>(T item)
where T : IThumbnails;
/// <summary>
/// Retrieve the local path of an image of the given item.
/// </summary>
/// <param name="item">The item to retrieve the poster from.</param>
/// <param name="imageID">The ID of the image. See <see cref="Images"/> for values.</param>
/// <param name="image">The ID of the image.</param>
/// <param name="quality">The quality of the image</param>
/// <typeparam name="T">The type of the item</typeparam>
/// <returns>The path of the image for the given resource or null if it does not exists.</returns>
Task<string> GetImagePath<T>([NotNull] T item, int imageID)
string GetImagePath<T>(T item, string image, ImageQuality quality)
where T : IThumbnails;
/// <summary>
/// Delete images associated with the item.
/// </summary>
/// <param name="item">
/// The item with cached images.
/// </param>
/// <typeparam name="T">The type of the item</typeparam>
/// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
Task DeleteImages<T>(T item)
where T : IThumbnails;
}
}

View File

@@ -1,63 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System.Collections.Generic;
using System.Threading.Tasks;
using JetBrains.Annotations;
using Kyoo.Abstractions.Models;
using Microsoft.AspNetCore.Mvc;
namespace Kyoo.Abstractions.Controllers
{
/// <summary>
/// Transcoder responsible of handling low level video details.
/// </summary>
public interface ITranscoder
{
/// <summary>
/// Retrieve tracks for a specific episode.
/// Subtitles, chapters and fonts should also be extracted and cached when calling this method.
/// </summary>
/// <param name="episode">The episode to retrieve tracks for.</param>
/// <param name="reExtract">Should the cache be invalidated and subtitles and others be re-extracted?</param>
/// <returns>The list of tracks available for this episode.</returns>
Task<ICollection<Track>> ExtractInfos(Episode episode, bool reExtract);
/// <summary>
/// List fonts assosiated with this episode.
/// </summary>
/// <param name="episode">Th episode to list fonts for.</param>
/// <returns>The list of attachements for this epiosode.</returns>
Task<ICollection<Font>> ListFonts(Episode episode);
/// <summary>
/// Get the specified font for this episode.
/// </summary>
/// <param name="episode">The episode to list fonts for.</param>
/// <param name="slug">The slug of the specific font to retrive.</param>
/// <returns>The <see cref="Font"/> with the given slug or null.</returns>
[ItemCanBeNull] Task<Font> GetFont(Episode episode, string slug);
/// <summary>
/// Transmux the selected episode to hls.
/// </summary>
/// <param name="episode">The episode to transmux.</param>
/// <returns>The master file (m3u8) of the transmuxed hls file.</returns>
IActionResult Transmux(Episode episode);
}
}

View File

@@ -0,0 +1,74 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Kyoo.Abstractions.Models;
using Kyoo.Abstractions.Models.Utils;
namespace Kyoo.Abstractions.Controllers;
/// <summary>
/// A local repository to handle watched items
/// </summary>
public interface IWatchStatusRepository
{
// /// <summary>
// /// The event handler type for all events of this repository.
// /// </summary>
// /// <param name="resource">The resource created/modified/deleted</param>
// /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
// public delegate Task ResourceEventHandler(T resource);
Task<ICollection<IWatchlist>> GetAll(
Filter<IWatchlist>? filter = default,
Include<IWatchlist>? include = default,
Pagination? limit = default
);
Task<MovieWatchStatus?> GetMovieStatus(Guid movieId, Guid userId);
Task<MovieWatchStatus?> SetMovieStatus(
Guid movieId,
Guid userId,
WatchStatus status,
int? watchedTime
);
Task DeleteMovieStatus(Guid movieId, Guid userId);
Task<ShowWatchStatus?> GetShowStatus(Guid showId, Guid userId);
Task<ShowWatchStatus?> SetShowStatus(Guid showId, Guid userId, WatchStatus status);
Task DeleteShowStatus(Guid showId, Guid userId);
Task<EpisodeWatchStatus?> GetEpisodeStatus(Guid episodeId, Guid userId);
/// <param name="watchedTime">Where the user has stopped watching. Only usable if Status
/// is <see cref="WatchStatus.Watching"/></param>
Task<EpisodeWatchStatus?> SetEpisodeStatus(
Guid episodeId,
Guid userId,
WatchStatus status,
int? watchedTime
);
Task DeleteEpisodeStatus(Guid episodeId, Guid userId);
}

View File

@@ -17,7 +17,6 @@
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Diagnostics.CodeAnalysis;
using Microsoft.Extensions.DependencyInjection;
namespace Kyoo.Abstractions.Controllers
@@ -26,8 +25,6 @@ namespace Kyoo.Abstractions.Controllers
/// A list of constant priorities used for <see cref="IStartupAction"/>'s <see cref="IStartupAction.Priority"/>.
/// It also contains helper methods for creating new <see cref="StartupAction"/>.
/// </summary>
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1649:File name should match first type name",
Justification = "StartupAction is nested and the name SA is short to improve readability in plugin's startup.")]
public static class SA
{
/// <summary>
@@ -72,8 +69,7 @@ namespace Kyoo.Abstractions.Controllers
/// <param name="action">The action to run</param>
/// <param name="priority">The priority of the new action</param>
/// <returns>A new <see cref="StartupAction"/></returns>
public static StartupAction New(Action action, int priority)
=> new(action, priority);
public static StartupAction New(Action action, int priority) => new(action, priority);
/// <summary>
/// Create a new <see cref="StartupAction"/>.
@@ -83,7 +79,7 @@ namespace Kyoo.Abstractions.Controllers
/// <typeparam name="T">A dependency that this action will use.</typeparam>
/// <returns>A new <see cref="StartupAction"/></returns>
public static StartupAction<T> New<T>(Action<T> action, int priority)
=> new(action, priority);
where T : notnull => new(action, priority);
/// <summary>
/// Create a new <see cref="StartupAction"/>.
@@ -94,7 +90,8 @@ namespace Kyoo.Abstractions.Controllers
/// <typeparam name="T2">A second dependency that this action will use.</typeparam>
/// <returns>A new <see cref="StartupAction"/></returns>
public static StartupAction<T, T2> New<T, T2>(Action<T, T2> action, int priority)
=> new(action, priority);
where T : notnull
where T2 : notnull => new(action, priority);
/// <summary>
/// Create a new <see cref="StartupAction"/>.
@@ -105,8 +102,13 @@ namespace Kyoo.Abstractions.Controllers
/// <typeparam name="T2">A second dependency that this action will use.</typeparam>
/// <typeparam name="T3">A third dependency that this action will use.</typeparam>
/// <returns>A new <see cref="StartupAction"/></returns>
public static StartupAction<T, T2, T3> New<T, T2, T3>(Action<T, T2, T3> action, int priority)
=> new(action, priority);
public static StartupAction<T, T2, T3> New<T, T2, T3>(
Action<T, T2, T3> action,
int priority
)
where T : notnull
where T2 : notnull
where T3 : notnull => new(action, priority);
/// <summary>
/// A <see cref="IStartupAction"/> with no dependencies.
@@ -144,6 +146,7 @@ namespace Kyoo.Abstractions.Controllers
/// </summary>
/// <typeparam name="T">The dependency to use.</typeparam>
public class StartupAction<T> : IStartupAction
where T : notnull
{
/// <summary>
/// The action to execute at startup.
@@ -177,6 +180,8 @@ namespace Kyoo.Abstractions.Controllers
/// <typeparam name="T">The dependency to use.</typeparam>
/// <typeparam name="T2">The second dependency to use.</typeparam>
public class StartupAction<T, T2> : IStartupAction
where T : notnull
where T2 : notnull
{
/// <summary>
/// The action to execute at startup.
@@ -200,10 +205,7 @@ namespace Kyoo.Abstractions.Controllers
/// <inheritdoc />
public void Run(IServiceProvider provider)
{
_action.Invoke(
provider.GetRequiredService<T>(),
provider.GetRequiredService<T2>()
);
_action.Invoke(provider.GetRequiredService<T>(), provider.GetRequiredService<T2>());
}
}
@@ -214,6 +216,9 @@ namespace Kyoo.Abstractions.Controllers
/// <typeparam name="T2">The second dependency to use.</typeparam>
/// <typeparam name="T3">The third dependency to use.</typeparam>
public class StartupAction<T, T2, T3> : IStartupAction
where T : notnull
where T2 : notnull
where T3 : notnull
{
/// <summary>
/// The action to execute at startup.

View File

@@ -20,6 +20,7 @@ using System;
using System.Collections.Generic;
using System.Linq;
using System.Security.Claims;
using Kyoo.Abstractions.Models.Exceptions;
using Kyoo.Authentication.Models;
namespace Kyoo.Authentication
@@ -39,5 +40,26 @@ namespace Kyoo.Authentication
return user.Claims.FirstOrDefault(x => x.Type == Claims.Permissions)?.Value.Split(',')
?? Array.Empty<string>();
}
/// <summary>
/// Get the id of the current user or null if unlogged or invalid.
/// </summary>
/// <param name="user">The user.</param>
/// <returns>The id of the user or null.</returns>
public static Guid? GetId(this ClaimsPrincipal user)
{
Claim? value = user.FindFirst(Claims.Id);
if (Guid.TryParse(value?.Value, out Guid id))
return id;
return null;
}
public static Guid GetIdOrThrow(this ClaimsPrincipal user)
{
Guid? ret = user.GetId();
if (ret == null)
throw new UnauthorizedException();
return ret.Value;
}
}
}

View File

@@ -3,14 +3,19 @@
<Title>Kyoo.Abstractions</Title>
<Description>Base package to create plugins for Kyoo.</Description>
<RootNamespace>Kyoo.Abstractions</RootNamespace>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Autofac" Version="6.2.0" />
<PackageReference Include="JetBrains.Annotations" Version="2021.2.0" />
<PackageReference Include="Autofac" Version="7.1.0" />
<PackageReference Include="Dapper" Version="2.1.24" />
<PackageReference Include="EntityFrameworkCore.Projectables" Version="4.1.4-prebeta" />
<PackageReference Include="JetBrains.Annotations" Version="2023.2.0" />
<PackageReference Include="Microsoft.AspNetCore.Mvc.Abstractions" Version="2.2.0" />
<PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="5.0.0" />
<PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="5.0.0" />
<PackageReference Include="System.ComponentModel.Composition" Version="5.0.0" />
<PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="7.0.0" />
<PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="7.0.0" />
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
<PackageReference Include="Sprache" Version="2.3.1" />
<PackageReference Include="System.ComponentModel.Composition" Version="7.0.0" />
</ItemGroup>
</Project>

View File

@@ -17,7 +17,6 @@
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using JetBrains.Annotations;
namespace Kyoo.Abstractions.Models.Attributes
{
@@ -32,23 +31,21 @@ namespace Kyoo.Abstractions.Models.Attributes
/// <summary>
/// The public name of this api.
/// </summary>
[NotNull] public string Name { get; }
public string Name { get; }
/// <summary>
/// The name of the group in witch this API is. You can also specify a custom sort order using the following
/// format: <code>order:name</code>. Everything before the first <c>:</c> will be removed but kept for
/// th alphabetical ordering.
/// </summary>
public string Group { get; set; }
public string? Group { get; set; }
/// <summary>
/// Create a new <see cref="ApiDefinitionAttribute"/>.
/// </summary>
/// <param name="name">The name of the api that will be used on the documentation page.</param>
public ApiDefinitionAttribute([NotNull] string name)
public ApiDefinitionAttribute(string name)
{
if (name == null)
throw new ArgumentNullException(nameof(name));
Name = name;
}
}

View File

@@ -1,70 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Collections.Generic;
using System.ComponentModel.Composition;
using Kyoo.Abstractions.Controllers;
namespace Kyoo.Abstractions.Models.Attributes
{
/// <summary>
/// An attribute to inform how a <see cref="IFileSystem"/> works.
/// </summary>
[MetadataAttribute]
[AttributeUsage(AttributeTargets.Class)]
public class FileSystemMetadataAttribute : Attribute
{
/// <summary>
/// The scheme(s) used to identify this path.
/// It can be something like http, https, ftp, file and so on.
/// </summary>
/// <remarks>
/// If multiples files with the same schemes exists, an exception will be thrown.
/// </remarks>
public string[] Scheme { get; }
/// <summary>
/// <c>true</c> if the scheme should be removed from the path before calling
/// methods of this <see cref="IFileSystem"/>, <c>false</c> otherwise.
/// </summary>
public bool StripScheme { get; set; }
/// <summary>
/// Create a new <see cref="FileSystemMetadataAttribute"/> using the specified schemes.
/// </summary>
/// <param name="schemes">The schemes to use.</param>
public FileSystemMetadataAttribute(string[] schemes)
{
Scheme = schemes;
}
/// <summary>
/// Create a new <see cref="FileSystemMetadataAttribute"/> using a dictionary of metadata.
/// </summary>
/// <param name="metadata">
/// The dictionary of metadata. This method expect the dictionary to contain a field
/// per property in this attribute, with the same types as the properties of this attribute.
/// </param>
public FileSystemMetadataAttribute(IDictionary<string, object> metadata)
{
Scheme = (string[])metadata[nameof(Scheme)];
StripScheme = (bool)metadata[nameof(StripScheme)];
}
}
}

View File

@@ -17,12 +17,11 @@
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using Kyoo.Abstractions.Controllers;
namespace Kyoo.Abstractions.Models.Attributes
{
/// <summary>
/// The targeted relation can be loaded via a call to <see cref="ILibraryManager.Load"/>.
/// The targeted relation can be loaded.
/// </summary>
[AttributeUsage(AttributeTargets.Property)]
public class LoadableRelationAttribute : Attribute
@@ -30,7 +29,13 @@ namespace Kyoo.Abstractions.Models.Attributes
/// <summary>
/// The name of the field containing the related resource's ID.
/// </summary>
public string RelationID { get; }
public string? RelationID { get; }
public string? Sql { get; set; }
public string? On { get; set; }
public string? Projected { get; set; }
/// <summary>
/// Create a new <see cref="LoadableRelationAttribute"/>.

View File

@@ -0,0 +1,33 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
namespace Kyoo.Abstractions.Models.Attributes;
/// <summary>
/// An attribute to inform that this interface is a type union
/// </summary>
[AttributeUsage(AttributeTargets.Interface)]
public class OneOfAttribute : Attribute
{
/// <summary>
/// The types this union concist of.
/// </summary>
public Type[] Types { get; set; }
}

View File

@@ -32,17 +32,17 @@ namespace Kyoo.Abstractions.Models.Permissions
/// <summary>
/// The needed permission type.
/// </summary>
public string Type { get; }
public string? Type { get; }
/// <summary>
/// The needed permission kind.
/// </summary>
public Kind Kind { get; }
public Kind? Kind { get; }
/// <summary>
/// The group of this permission.
/// </summary>
public Group Group { get; set; }
public Group? Group { get; set; }
/// <summary>
/// Ask a permission to run an action.

View File

@@ -16,26 +16,22 @@
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
namespace Kyoo.Core.Models.Options
using System;
using Kyoo.Utils;
namespace Kyoo.Abstractions.Models.Attributes;
[AttributeUsage(AttributeTargets.Class)]
public class SqlFirstColumnAttribute : Attribute
{
/// <summary>
/// Options for media registering.
/// The name of the first column of the element. Used to split multiples
/// items on a single sql query. If not specified, it defaults to "Id".
/// </summary>
public class MediaOptions
public string Name { get; set; }
public SqlFirstColumnAttribute(string name)
{
/// <summary>
/// The path of this options
/// </summary>
public const string Path = "Media";
/// <summary>
/// A regex for episodes
/// </summary>
public string[] Regex { get; set; }
/// <summary>
/// A regex for subtitles
/// </summary>
public string[] SubtitleRegex { get; set; }
Name = name.ToSnakeCase();
}
}

View File

@@ -1,94 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Collections.Generic;
using System.ComponentModel.Composition;
using Kyoo.Abstractions.Controllers;
namespace Kyoo.Abstractions.Models.Attributes
{
/// <summary>
/// An attribute to inform how a <see cref="IFileSystem"/> works.
/// </summary>
[MetadataAttribute]
[AttributeUsage(AttributeTargets.Class)]
public class TaskMetadataAttribute : Attribute
{
/// <summary>
/// The slug of the task, used to start it.
/// </summary>
public string Slug { get; }
/// <summary>
/// The name of the task that will be displayed to the user.
/// </summary>
public string Name { get; }
/// <summary>
/// A quick description of what this task will do.
/// </summary>
public string Description { get; }
/// <summary>
/// Should this task be automatically run at app startup?
/// </summary>
public bool RunOnStartup { get; set; }
/// <summary>
/// The priority of this task. Only used if <see cref="RunOnStartup"/> is true.
/// It allow one to specify witch task will be started first as tasked are run on a Priority's descending order.
/// </summary>
public int Priority { get; set; }
/// <summary>
/// <c>true</c> if this task should not be displayed to the user, <c>false</c> otherwise.
/// </summary>
public bool IsHidden { get; set; }
/// <summary>
/// Create a new <see cref="TaskMetadataAttribute"/> with the given slug, name and description.
/// </summary>
/// <param name="slug">The slug of the task, used to start it.</param>
/// <param name="name">The name of the task that will be displayed to the user.</param>
/// <param name="description">A quick description of what this task will do.</param>
public TaskMetadataAttribute(string slug, string name, string description)
{
Slug = slug;
Name = name;
Description = description;
}
/// <summary>
/// Create a new <see cref="TaskMetadataAttribute"/> using a dictionary of metadata.
/// </summary>
/// <param name="metadata">
/// The dictionary of metadata. This method expect the dictionary to contain a field
/// per property in this attribute, with the same types as the properties of this attribute.
/// </param>
public TaskMetadataAttribute(IDictionary<string, object> metadata)
{
Slug = (string)metadata[nameof(Slug)];
Name = (string)metadata[nameof(Name)];
Description = (string)metadata[nameof(Description)];
RunOnStartup = (bool)metadata[nameof(RunOnStartup)];
Priority = (int)metadata[nameof(Priority)];
IsHidden = (bool)metadata[nameof(IsHidden)];
}
}
}

View File

@@ -1,56 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// A chapter to split an episode in multiple parts.
/// </summary>
public class Chapter
{
/// <summary>
/// The start time of the chapter (in second from the start of the episode).
/// </summary>
public float StartTime { get; set; }
/// <summary>
/// The end time of the chapter (in second from the start of the episode).
/// </summary>
public float EndTime { get; set; }
/// <summary>
/// The name of this chapter. This should be a human-readable name that could be presented to the user.
/// There should be well-known chapters name for commonly used chapters.
/// For example, use "Opening" for the introduction-song and "Credits" for the end chapter with credits.
/// </summary>
public string Name { get; set; }
/// <summary>
/// Create a new <see cref="Chapter"/>.
/// </summary>
/// <param name="startTime">The start time of the chapter (in second)</param>
/// <param name="endTime">The end time of the chapter (in second)</param>
/// <param name="name">The name of this chapter</param>
public Chapter(float startTime, float endTime, string name)
{
StartTime = startTime;
EndTime = endTime;
Name = name;
}
}
}

View File

@@ -1,121 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Collections.Generic;
using System.Reflection;
using JetBrains.Annotations;
using Kyoo.Utils;
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// A class given information about a strongly typed configuration.
/// </summary>
public class ConfigurationReference
{
/// <summary>
/// The path of the resource (separated by ':')
/// </summary>
public string Path { get; }
/// <summary>
/// The type of the resource.
/// </summary>
public Type Type { get; }
/// <summary>
/// Create a new <see cref="ConfigurationReference"/> using a given path and type.
/// This method does not create sub configuration resources. Please see <see cref="CreateReference"/>
/// </summary>
/// <param name="path">The path of the resource (separated by ':' or "__")</param>
/// <param name="type">The type of the resource</param>
/// <seealso cref="CreateReference"/>
public ConfigurationReference(string path, Type type)
{
Path = path;
Type = type;
}
/// <summary>
/// Return the list of configuration reference a type has.
/// </summary>
/// <param name="path">
/// The base path of the type (separated by ':' or "__". If empty, it will start at root)
/// </param>
/// <param name="type">The type of the object</param>
/// <returns>The list of configuration reference a type has.</returns>
public static IEnumerable<ConfigurationReference> CreateReference(string path, [NotNull] Type type)
{
if (type == null)
throw new ArgumentNullException(nameof(type));
List<ConfigurationReference> ret = new()
{
new ConfigurationReference(path, type)
};
if (!type.IsClass || type.AssemblyQualifiedName?.StartsWith("System") == true)
return ret;
Type enumerable = Utility.GetGenericDefinition(type, typeof(IEnumerable<>));
Type dictionary = Utility.GetGenericDefinition(type, typeof(IDictionary<,>));
Type dictionaryKey = dictionary?.GetGenericArguments()[0];
if (dictionary != null && dictionaryKey == typeof(string))
ret.AddRange(CreateReference($"{path}:{type.Name}:*", dictionary.GetGenericArguments()[1]));
else if (dictionary != null && dictionaryKey == typeof(int))
ret.AddRange(CreateReference($"{path}:{type.Name}:", dictionary.GetGenericArguments()[1]));
else if (enumerable != null)
ret.AddRange(CreateReference($"{path}:{type.Name}:", enumerable.GetGenericArguments()[0]));
else
{
foreach (PropertyInfo child in type.GetProperties())
ret.AddRange(CreateReference($"{path}:{child.Name}", child.PropertyType));
}
return ret;
}
/// <summary>
/// Return the list of configuration reference a type has.
/// </summary>
/// <param name="path">
/// The base path of the type (separated by ':' or "__". If empty, it will start at root)
/// </param>
/// <typeparam name="T">The type of the object</typeparam>
/// <returns>The list of configuration reference a type has.</returns>
public static IEnumerable<ConfigurationReference> CreateReference<T>(string path)
{
return CreateReference(path, typeof(T));
}
/// <summary>
/// Return a <see cref="ConfigurationReference"/> meaning that the given path is of any type.
/// It means that the type can't be edited.
/// </summary>
/// <param name="path">
/// The path that will be untyped (separated by ':' or "__". If empty, it will start at root).
/// </param>
/// <returns>A configuration reference representing a path of any type.</returns>
public static ConfigurationReference CreateUntyped(string path)
{
return new ConfigurationReference(path, null);
}
}
}

View File

@@ -28,19 +28,19 @@ namespace Kyoo.Abstractions.Models.Exceptions
public class DuplicatedItemException : Exception
{
/// <summary>
/// Create a new <see cref="DuplicatedItemException"/> with the default message.
/// The existing object.
/// </summary>
public DuplicatedItemException()
: base("Already exists in the database.")
{ }
public object? Existing { get; }
/// <summary>
/// Create a new <see cref="DuplicatedItemException"/> with a custom message.
/// Create a new <see cref="DuplicatedItemException"/> with the default message.
/// </summary>
/// <param name="message">The message to use</param>
public DuplicatedItemException(string message)
: base(message)
{ }
/// <param name="existing">The existing object.</param>
public DuplicatedItemException(object? existing = null)
: base("Already exists in the database.")
{
Existing = existing;
}
/// <summary>
/// The serialization constructor.
@@ -48,7 +48,6 @@ namespace Kyoo.Abstractions.Models.Exceptions
/// <param name="info">Serialization infos</param>
/// <param name="context">The serialization context</param>
protected DuplicatedItemException(SerializationInfo info, StreamingContext context)
: base(info, context)
{ }
: base(info, context) { }
}
}

View File

@@ -1,47 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Runtime.Serialization;
namespace Kyoo.Abstractions.Models.Exceptions
{
/// <summary>
/// An exception thrown when a part of the app has a fatal issue.
/// </summary>
[Serializable]
public class HealthException : Exception
{
/// <summary>
/// Create a new <see cref="HealthException"/> with a custom message.
/// </summary>
/// <param name="message">The message to use.</param>
public HealthException(string message)
: base(message)
{ }
/// <summary>
/// The serialization constructor
/// </summary>
/// <param name="info">Serialization infos</param>
/// <param name="context">The serialization context</param>
protected HealthException(SerializationInfo info, StreamingContext context)
: base(info, context)
{ }
}
}

View File

@@ -1,55 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Runtime.Serialization;
using Kyoo.Abstractions.Controllers;
namespace Kyoo.Abstractions.Models.Exceptions
{
/// <summary>
/// An exception raised when an <see cref="IIdentifier"/> failed.
/// </summary>
[Serializable]
public class IdentificationFailedException : Exception
{
/// <summary>
/// Create a new <see cref="IdentificationFailedException"/> with a default message.
/// </summary>
public IdentificationFailedException()
: base("An identification failed.")
{ }
/// <summary>
/// Create a new <see cref="IdentificationFailedException"/> with a custom message.
/// </summary>
/// <param name="message">The message to use.</param>
public IdentificationFailedException(string message)
: base(message)
{ }
/// <summary>
/// The serialization constructor
/// </summary>
/// <param name="info">Serialization infos</param>
/// <param name="context">The serialization context</param>
protected IdentificationFailedException(SerializationInfo info, StreamingContext context)
: base(info, context)
{ }
}
}

View File

@@ -37,8 +37,7 @@ namespace Kyoo.Abstractions.Models.Exceptions
/// </summary>
/// <param name="message">The message of the exception</param>
public ItemNotFoundException(string message)
: base(message)
{ }
: base(message) { }
/// <summary>
/// The serialization constructor
@@ -46,7 +45,6 @@ namespace Kyoo.Abstractions.Models.Exceptions
/// <param name="info">Serialization infos</param>
/// <param name="context">The serialization context</param>
protected ItemNotFoundException(SerializationInfo info, StreamingContext context)
: base(info, context)
{ }
: base(info, context) { }
}
}

View File

@@ -1,63 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Runtime.Serialization;
using Kyoo.Abstractions.Controllers;
namespace Kyoo.Abstractions.Models.Exceptions
{
/// <summary>
/// An exception raised when an <see cref="ITask"/> failed.
/// </summary>
[Serializable]
public class TaskFailedException : AggregateException
{
/// <summary>
/// Create a new <see cref="TaskFailedException"/> with a default message.
/// </summary>
public TaskFailedException()
: base("A task failed.")
{ }
/// <summary>
/// Create a new <see cref="TaskFailedException"/> with a custom message.
/// </summary>
/// <param name="message">The message to use.</param>
public TaskFailedException(string message)
: base(message)
{ }
/// <summary>
/// Create a new <see cref="TaskFailedException"/> wrapping another exception.
/// </summary>
/// <param name="exception">The exception to wrap.</param>
public TaskFailedException(Exception exception)
: base(exception)
{ }
/// <summary>
/// The serialization constructor
/// </summary>
/// <param name="info">Serialization infos</param>
/// <param name="context">The serialization context</param>
protected TaskFailedException(SerializationInfo info, StreamingContext context)
: base(info, context)
{ }
}
}

View File

@@ -0,0 +1,36 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Runtime.Serialization;
namespace Kyoo.Abstractions.Models.Exceptions
{
[Serializable]
public class UnauthorizedException : Exception
{
public UnauthorizedException()
: base("User not authenticated or token invalid.") { }
public UnauthorizedException(string message)
: base(message) { }
protected UnauthorizedException(SerializationInfo info, StreamingContext context)
: base(info, context) { }
}
}

View File

@@ -1,72 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using Kyoo.Abstractions.Models.Attributes;
using Kyoo.Utils;
using PathIO = System.IO.Path;
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// A font of an <see cref="Episode"/>.
/// </summary>
public class Font : ILink
{
/// <summary>
/// A human-readable identifier, used in the URL.
/// </summary>
public string Slug { get; set; }
/// <summary>
/// The name of the font file (with the extension).
/// </summary>
public string File { get; set; }
/// <summary>
/// The format of this font (the extension).
/// </summary>
public string Format { get; set; }
/// <summary>
/// The path of the font.
/// </summary>
[SerializeIgnore] public string Path { get; set; }
/// <inheritdoc/>
public object Link { get; init; }
/// <summary>
/// Create a new empty <see cref="Font"/>.
/// </summary>
public Font() { }
/// <summary>
/// Create a new <see cref="Font"/> from a path.
/// </summary>
/// <param name="path">The path of the font.</param>
/// <param name="episodeSlug">The slug of the episode that contains this font.</param>
public Font(string path, string episodeSlug)
{
Slug = Utility.ToSlug(PathIO.GetFileNameWithoutExtension(path));
Path = path;
File = PathIO.GetFileName(path);
Format = PathIO.GetExtension(path).Replace(".", string.Empty);
Link = $"/watch/{episodeSlug}/font/{Slug}.{Format}";
}
}
}

View File

@@ -0,0 +1,45 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// A genre that allow one to specify categories for shows.
/// </summary>
public enum Genre
{
Action,
Adventure,
Animation,
Comedy,
Crime,
Documentary,
Drama,
Family,
Fantasy,
History,
Horror,
Music,
Mystery,
Romance,
ScienceFiction,
Thriller,
War,
Western,
}
}

View File

@@ -0,0 +1,31 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using Kyoo.Abstractions.Controllers;
using Kyoo.Abstractions.Models.Attributes;
namespace Kyoo.Abstractions.Models;
/// <summary>
/// A show, a movie or a collection.
/// </summary>
[OneOf(Types = new[] { typeof(Show), typeof(Movie), typeof(Collection) })]
public interface ILibraryItem : IResource, IThumbnails, IMetadata, IAddedDate, IQuery
{
static Sort IQuery.DefaultSort => new Sort<ILibraryItem>.By(nameof(Movie.Name));
}

View File

@@ -0,0 +1,31 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using Kyoo.Abstractions.Controllers;
using Kyoo.Abstractions.Models.Attributes;
namespace Kyoo.Abstractions.Models;
/// <summary>
/// A show, a movie or a collection.
/// </summary>
[OneOf(Types = new[] { typeof(Episode), typeof(Movie) })]
public interface INews : IResource, IThumbnails, IMetadata, IAddedDate, IQuery
{
static Sort IQuery.DefaultSort => new Sort<INews>.By(nameof(AddedDate), true);
}

View File

@@ -0,0 +1,27 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using Kyoo.Abstractions.Models.Attributes;
namespace Kyoo.Abstractions.Models;
/// <summary>
/// A watch list item.
/// </summary>
[OneOf(Types = new[] { typeof(Show), typeof(Movie) })]
public interface IWatchlist : IResource, IThumbnails, IMetadata, IAddedDate { }

View File

@@ -1,172 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Linq.Expressions;
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// The type of item, ether a show, a movie or a collection.
/// </summary>
public enum ItemType
{
/// <summary>
/// The <see cref="LibraryItem"/> is a <see cref="Show"/>.
/// </summary>
Show,
/// <summary>
/// The <see cref="LibraryItem"/> is a Movie (a <see cref="Show"/> with
/// <see cref="Models.Show.IsMovie"/> equals to true).
/// </summary>
Movie,
/// <summary>
/// The <see cref="LibraryItem"/> is a <see cref="Collection"/>.
/// </summary>
Collection
}
/// <summary>
/// A type union between <see cref="Show"/> and <see cref="Collection"/>.
/// This is used to list content put inside a library.
/// </summary>
public class LibraryItem : CustomTypeDescriptor, IResource, IThumbnails
{
/// <inheritdoc />
public int ID { get; set; }
/// <inheritdoc />
public string Slug { get; set; }
/// <summary>
/// The title of the show or collection.
/// </summary>
public string Title { get; set; }
/// <summary>
/// The summary of the show or collection.
/// </summary>
public string Overview { get; set; }
/// <summary>
/// Is this show airing, not aired yet or finished? This is only applicable for shows.
/// </summary>
public Status? Status { get; set; }
/// <summary>
/// The date this show or collection started airing. It can be null if this is unknown.
/// </summary>
public DateTime? StartAir { get; set; }
/// <summary>
/// The date this show or collection finished airing.
/// It must be after the <see cref="StartAir"/> but can be the same (example: for movies).
/// It can also be null if this is unknown.
/// </summary>
public DateTime? EndAir { get; set; }
/// <inheritdoc />
public Dictionary<int, string> Images { get; set; }
/// <summary>
/// The type of this item (ether a collection, a show or a movie).
/// </summary>
public ItemType Type { get; set; }
/// <summary>
/// Create a new, empty <see cref="LibraryItem"/>.
/// </summary>
public LibraryItem() { }
/// <summary>
/// Create a <see cref="LibraryItem"/> from a show.
/// </summary>
/// <param name="show">The show that this library item should represent.</param>
public LibraryItem(Show show)
{
ID = show.ID;
Slug = show.Slug;
Title = show.Title;
Overview = show.Overview;
Status = show.Status;
StartAir = show.StartAir;
EndAir = show.EndAir;
Images = show.Images;
Type = show.IsMovie ? ItemType.Movie : ItemType.Show;
}
/// <summary>
/// Create a <see cref="LibraryItem"/> from a collection
/// </summary>
/// <param name="collection">The collection that this library item should represent.</param>
public LibraryItem(Collection collection)
{
ID = -collection.ID;
Slug = collection.Slug;
Title = collection.Name;
Overview = collection.Overview;
Status = Models.Status.Unknown;
StartAir = null;
EndAir = null;
Images = collection.Images;
Type = ItemType.Collection;
}
/// <summary>
/// An expression to create a <see cref="LibraryItem"/> representing a show.
/// </summary>
public static Expression<Func<Show, LibraryItem>> FromShow => x => new LibraryItem
{
ID = x.ID,
Slug = x.Slug,
Title = x.Title,
Overview = x.Overview,
Status = x.Status,
StartAir = x.StartAir,
EndAir = x.EndAir,
Images = x.Images,
Type = x.IsMovie ? ItemType.Movie : ItemType.Show
};
/// <summary>
/// An expression to create a <see cref="LibraryItem"/> representing a collection.
/// </summary>
public static Expression<Func<Collection, LibraryItem>> FromCollection => x => new LibraryItem
{
ID = -x.ID,
Slug = x.Slug,
Title = x.Name,
Overview = x.Overview,
Status = Models.Status.Unknown,
StartAir = null,
EndAir = null,
Images = x.Images,
Type = ItemType.Collection
};
/// <inheritdoc />
public override string GetClassName()
{
return Type.ToString();
}
}
}

View File

@@ -16,48 +16,21 @@
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Linq.Expressions;
using Kyoo.Abstractions.Models.Attributes;
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// ID and link of an item on an external provider.
/// </summary>
public class MetadataID
public class MetadataId
{
/// <summary>
/// The expression to retrieve the unique ID of a MetadataID. This is an aggregate of the two resources IDs.
/// </summary>
public static Expression<Func<MetadataID, object>> PrimaryKey
{
get { return x => new { First = x.ResourceID, Second = x.ProviderID }; }
}
/// <summary>
/// The ID of the resource which possess the metadata.
/// </summary>
[SerializeIgnore] public int ResourceID { get; set; }
/// <summary>
/// The ID of the provider.
/// </summary>
[SerializeIgnore] public int ProviderID { get; set; }
/// <summary>
/// The provider that can do something with this ID.
/// </summary>
public Provider Provider { get; set; }
/// <summary>
/// The ID of the resource on the external provider.
/// </summary>
public string DataID { get; set; }
public string DataId { get; set; }
/// <summary>
/// The URL of the resource on the external provider.
/// </summary>
public string Link { get; set; }
public string? Link { get; set; }
}
}

View File

@@ -16,7 +16,6 @@
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Collections.Generic;
using System.Linq;
using Kyoo.Utils;
@@ -40,10 +39,15 @@ namespace Kyoo.Abstractions.Models
/// </summary>
public string First { get; }
/// <summary>
/// The link of the previous page.
/// </summary>
public string? Previous { get; }
/// <summary>
/// The link of the next page.
/// </summary>
public string Next { get; }
public string? Next { get; }
/// <summary>
/// The number of items in the current page.
@@ -60,12 +64,20 @@ namespace Kyoo.Abstractions.Models
/// </summary>
/// <param name="items">The list of items in the page.</param>
/// <param name="this">The link of the current page.</param>
/// <param name="previous">The link of the previous page.</param>
/// <param name="next">The link of the next page.</param>
/// <param name="first">The link of the first page.</param>
public Page(ICollection<T> items, string @this, string next, string first)
public Page(
ICollection<T> items,
string @this,
string? previous,
string? next,
string first
)
{
Items = items;
This = @this;
Previous = previous;
Next = next;
First = first;
}
@@ -77,20 +89,22 @@ namespace Kyoo.Abstractions.Models
/// <param name="url">The base url of the resources available from this page.</param>
/// <param name="query">The list of query strings of the current page</param>
/// <param name="limit">The number of items requested for the current page.</param>
public Page(ICollection<T> items,
string url,
Dictionary<string, string> query,
int limit)
public Page(ICollection<T> items, string url, Dictionary<string, string> query, int limit)
{
Items = items;
This = url + query.ToQueryString();
if (items.Count > 0 && query.ContainsKey("afterID"))
{
query["afterID"] = items.First().Id.ToString();
query["reverse"] = "true";
Previous = url + query.ToQueryString();
}
query.Remove("reverse");
if (items.Count == limit && limit > 0)
{
query["afterID"] = items.Last().ID.ToString();
query["afterID"] = items.Last().Id.ToString();
Next = url + query.ToQueryString();
}
query.Remove("afterID");
First = url + query.ToQueryString();
}

View File

@@ -0,0 +1,28 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
namespace Kyoo.Models;
public class PartialResource
{
public Guid? Id { get; set; }
public string? Slug { get; set; }
}

View File

@@ -16,6 +16,8 @@
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
namespace Kyoo.Abstractions.Models
{
/// <summary>
@@ -29,10 +31,10 @@ namespace Kyoo.Abstractions.Models
public class PeopleRole : IResource
{
/// <inheritdoc />
public int ID { get; set; }
public Guid Id { get; set; }
/// <inheritdoc />
public string Slug => ForPeople ? Show.Slug : People.Slug;
public string Slug => ForPeople ? Show!.Slug : People.Slug;
/// <summary>
/// Should this role be used as a Show substitute (the value is <c>true</c>) or
@@ -43,7 +45,7 @@ namespace Kyoo.Abstractions.Models
/// <summary>
/// The ID of the People playing the role.
/// </summary>
public int PeopleID { get; set; }
public Guid PeopleID { get; set; }
/// <summary>
/// The people that played this role.
@@ -53,12 +55,16 @@ namespace Kyoo.Abstractions.Models
/// <summary>
/// The ID of the Show where the People playing in.
/// </summary>
public int ShowID { get; set; }
public Guid? ShowID { get; set; }
/// <summary>
/// The show where the People played in.
/// </summary>
public Show Show { get; set; }
public Show? Show { get; set; }
public Guid? MovieID { get; set; }
public Movie? Movie { get; set; }
/// <summary>
/// The type of work the person has done for the show.

View File

@@ -16,21 +16,28 @@
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using Kyoo.Abstractions.Controllers;
using Kyoo.Abstractions.Models.Attributes;
using Kyoo.Utils;
using Newtonsoft.Json;
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// A class representing collections of <see cref="Show"/>.
/// A collection can also be stored in a <see cref="Library"/>.
/// </summary>
public class Collection : IResource, IMetadata, IThumbnails
public class Collection : IQuery, IResource, IMetadata, IThumbnails, IAddedDate, ILibraryItem
{
/// <inheritdoc />
public int ID { get; set; }
public static Sort DefaultSort => new Sort<Collection>.By(nameof(Collection.Name));
/// <inheritdoc />
public Guid Id { get; set; }
/// <inheritdoc />
[MaxLength(256)]
public string Slug { get; set; }
/// <summary>
@@ -38,25 +45,48 @@ namespace Kyoo.Abstractions.Models
/// </summary>
public string Name { get; set; }
/// <inheritdoc />
public Dictionary<int, string> Images { get; set; }
/// <summary>
/// The description of this collection.
/// </summary>
public string Overview { get; set; }
public string? Overview { get; set; }
/// <inheritdoc />
public DateTime AddedDate { get; set; }
/// <inheritdoc />
public Image? Poster { get; set; }
/// <inheritdoc />
public Image? Thumbnail { get; set; }
/// <inheritdoc />
public Image? Logo { get; set; }
/// <summary>
/// The list of movies contained in this collection.
/// </summary>
[SerializeIgnore]
public ICollection<Movie>? Movies { get; set; }
/// <summary>
/// The list of shows contained in this collection.
/// </summary>
[LoadableRelation] public ICollection<Show> Shows { get; set; }
/// <summary>
/// The list of libraries that contains this collection.
/// </summary>
[LoadableRelation] public ICollection<Library> Libraries { get; set; }
[SerializeIgnore]
public ICollection<Show>? Shows { get; set; }
/// <inheritdoc />
[EditableRelation] [LoadableRelation] public ICollection<MetadataID> ExternalIDs { get; set; }
public Dictionary<string, MetadataId> ExternalId { get; set; } = new();
public Collection() { }
[JsonConstructor]
public Collection(string name)
{
if (name != null)
{
Slug = Utility.ToSlug(name);
Name = name;
}
}
}
}

View File

@@ -18,7 +18,10 @@
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Text.RegularExpressions;
using EntityFrameworkCore.Projectables;
using JetBrains.Annotations;
using Kyoo.Abstractions.Controllers;
using Kyoo.Abstractions.Models.Attributes;
@@ -28,31 +31,38 @@ namespace Kyoo.Abstractions.Models
/// <summary>
/// A class to represent a single show's episode.
/// </summary>
public class Episode : IResource, IMetadata, IThumbnails
public class Episode : IQuery, IResource, IMetadata, IThumbnails, IAddedDate, INews
{
// Use absolute numbers by default and fallback to season/episodes if it does not exists.
public static Sort DefaultSort =>
new Sort<Episode>.Conglomerate(
new Sort<Episode>.By(x => x.AbsoluteNumber),
new Sort<Episode>.By(x => x.SeasonNumber),
new Sort<Episode>.By(x => x.EpisodeNumber)
);
/// <inheritdoc />
public int ID { get; set; }
public Guid Id { get; set; }
/// <inheritdoc />
[Computed]
[MaxLength(256)]
public string Slug
{
get
{
if (ShowSlug != null || Show != null)
return GetSlug(ShowSlug ?? Show.Slug, SeasonNumber, EpisodeNumber, AbsoluteNumber);
return ShowID != 0
? GetSlug(ShowID.ToString(), SeasonNumber, EpisodeNumber, AbsoluteNumber)
: null;
if (ShowSlug != null || Show?.Slug != null)
return GetSlug(
ShowSlug ?? Show!.Slug,
SeasonNumber,
EpisodeNumber,
AbsoluteNumber
);
return GetSlug(ShowId.ToString(), SeasonNumber, EpisodeNumber, AbsoluteNumber);
}
[UsedImplicitly]
[NotNull]
private set
{
if (value == null)
throw new ArgumentNullException(nameof(value));
Match match = Regex.Match(value, @"(?<show>.+)-s(?<season>\d+)e(?<episode>\d+)");
if (match.Success)
@@ -80,32 +90,34 @@ namespace Kyoo.Abstractions.Models
/// <summary>
/// The slug of the Show that contain this episode. If this is not set, this episode is ill-formed.
/// </summary>
[SerializeIgnore] public string ShowSlug { private get; set; }
[SerializeIgnore]
public string? ShowSlug { private get; set; }
/// <summary>
/// The ID of the Show containing this episode.
/// </summary>
[SerializeIgnore] public int ShowID { get; set; }
public Guid ShowId { get; set; }
/// <summary>
/// The show that contains this episode. This must be explicitly loaded via a call to <see cref="ILibraryManager.Load"/>.
/// The show that contains this episode.
/// </summary>
[LoadableRelation(nameof(ShowID))] public Show Show { get; set; }
[LoadableRelation(nameof(ShowId))]
public Show? Show { get; set; }
/// <summary>
/// The ID of the Season containing this episode.
/// </summary>
[SerializeIgnore] public int? SeasonID { get; set; }
public Guid? SeasonId { get; set; }
/// <summary>
/// The season that contains this episode.
/// This must be explicitly loaded via a call to <see cref="ILibraryManager.Load"/>.
/// </summary>
/// <remarks>
/// This can be null if the season is unknown and the episode is only identified
/// by it's <see cref="AbsoluteNumber"/>.
/// </remarks>
[LoadableRelation(nameof(SeasonID))] public Season Season { get; set; }
[LoadableRelation(nameof(SeasonId))]
public Season? Season { get; set; }
/// <summary>
/// The season in witch this episode is in.
@@ -123,22 +135,24 @@ namespace Kyoo.Abstractions.Models
public int? AbsoluteNumber { get; set; }
/// <summary>
/// The path of the video file for this episode. Any format supported by a <see cref="IFileSystem"/> is allowed.
/// The path of the video file for this episode.
/// </summary>
[SerializeIgnore] public string Path { get; set; }
/// <inheritdoc />
public Dictionary<int, string> Images { get; set; }
public string Path { get; set; }
/// <summary>
/// The title of this episode.
/// </summary>
public string Title { get; set; }
public string? Name { get; set; }
/// <summary>
/// The overview of this episode.
/// </summary>
public string Overview { get; set; }
public string? Overview { get; set; }
/// <summary>
/// How long is this episode? (in minutes)
/// </summary>
public int Runtime { get; set; }
/// <summary>
/// The release date of this episode. It can be null if unknown.
@@ -146,12 +160,124 @@ namespace Kyoo.Abstractions.Models
public DateTime? ReleaseDate { get; set; }
/// <inheritdoc />
[EditableRelation] [LoadableRelation] public ICollection<MetadataID> ExternalIDs { get; set; }
public DateTime AddedDate { get; set; }
/// <inheritdoc />
public Image? Poster { get; set; }
/// <inheritdoc />
public Image? Thumbnail { get; set; }
/// <inheritdoc />
public Image? Logo { get; set; }
/// <inheritdoc />
public Dictionary<string, MetadataId> ExternalId { get; set; } = new();
/// <summary>
/// The list of tracks this episode has. This lists video, audio and subtitles available.
/// The previous episode that should be seen before viewing this one.
/// </summary>
[EditableRelation] [LoadableRelation] public ICollection<Track> Tracks { get; set; }
[Projectable(UseMemberBody = nameof(_PreviousEpisode), OnlyOnInclude = true)]
[LoadableRelation(
// language=PostgreSQL
Sql = """
select
pe.* -- Episode as pe
from
episodes as "pe"
where
pe.show_id = "this".show_id
and (pe.absolute_number < "this".absolute_number
or pe.season_number < "this".season_number
or (pe.season_number = "this".season_number
and e.episode_number < "this".episode_number))
order by
pe.absolute_number desc nulls last,
pe.season_number desc,
pe.episode_number desc
limit 1
"""
)]
public Episode? PreviousEpisode { get; set; }
private Episode? _PreviousEpisode =>
Show!
.Episodes!
.OrderBy(x => x.AbsoluteNumber == null)
.ThenByDescending(x => x.AbsoluteNumber)
.ThenByDescending(x => x.SeasonNumber)
.ThenByDescending(x => x.EpisodeNumber)
.FirstOrDefault(
x =>
x.AbsoluteNumber < AbsoluteNumber
|| x.SeasonNumber < SeasonNumber
|| (x.SeasonNumber == SeasonNumber && x.EpisodeNumber < EpisodeNumber)
);
/// <summary>
/// The next episode to watch after this one.
/// </summary>
[Projectable(UseMemberBody = nameof(_NextEpisode), OnlyOnInclude = true)]
[LoadableRelation(
// language=PostgreSQL
Sql = """
select
ne.* -- Episode as ne
from
episodes as "ne"
where
ne.show_id = "this".show_id
and (ne.absolute_number > "this".absolute_number
or ne.season_number > "this".season_number
or (ne.season_number = "this".season_number
and e.episode_number > "this".episode_number))
order by
ne.absolute_number,
ne.season_number,
ne.episode_number
limit 1
"""
)]
public Episode? NextEpisode { get; set; }
private Episode? _NextEpisode =>
Show!
.Episodes!
.OrderBy(x => x.AbsoluteNumber)
.ThenBy(x => x.SeasonNumber)
.ThenBy(x => x.EpisodeNumber)
.FirstOrDefault(
x =>
x.AbsoluteNumber > AbsoluteNumber
|| x.SeasonNumber > SeasonNumber
|| (x.SeasonNumber == SeasonNumber && x.EpisodeNumber > EpisodeNumber)
);
[SerializeIgnore]
public ICollection<EpisodeWatchStatus>? Watched { get; set; }
/// <summary>
/// Metadata of what an user as started/planned to watch.
/// </summary>
[Projectable(UseMemberBody = nameof(_WatchStatus), OnlyOnInclude = true)]
[LoadableRelation(
Sql = "episode_watch_status",
On = "episode_id = \"this\".id and \"relation\".user_id = [current_user]"
)]
public EpisodeWatchStatus? WatchStatus { get; set; }
// There is a global query filter to filter by user so we just need to do single.
private EpisodeWatchStatus? _WatchStatus => Watched!.FirstOrDefault();
/// <summary>
/// Links to watch this episode.
/// </summary>
public VideoLinks Links =>
new()
{
Direct = $"/video/episode/{Slug}/direct",
Hls = $"/video/episode/{Slug}/master.m3u8",
};
/// <summary>
/// Get the slug of an episode.
@@ -170,14 +296,13 @@ namespace Kyoo.Abstractions.Models
/// If you don't know it or this is a movie, use null
/// </param>
/// <returns>The slug corresponding to the given arguments</returns>
/// <exception cref="ArgumentNullException">The given show slug was null.</exception>
public static string GetSlug([NotNull] string showSlug,
public static string GetSlug(
string showSlug,
int? seasonNumber,
int? episodeNumber,
int? absoluteNumber = null)
int? absoluteNumber = null
)
{
if (showSlug == null)
throw new ArgumentNullException(nameof(showSlug));
return seasonNumber switch
{
null when absoluteNumber == null => showSlug,

View File

@@ -1,62 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System.Collections.Generic;
using Kyoo.Abstractions.Models.Attributes;
using Kyoo.Utils;
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// A genre that allow one to specify categories for shows.
/// </summary>
public class Genre : IResource
{
/// <inheritdoc />
public int ID { get; set; }
/// <inheritdoc />
public string Slug { get; set; }
/// <summary>
/// The name of this genre.
/// </summary>
public string Name { get; set; }
/// <summary>
/// The list of shows that have this genre.
/// </summary>
[LoadableRelation] public ICollection<Show> Shows { get; set; }
/// <summary>
/// Create a new, empty <see cref="Genre"/>.
/// </summary>
public Genre() { }
/// <summary>
/// Create a new <see cref="Genre"/> and specify it's <see cref="Name"/>.
/// The <see cref="Slug"/> is automatically calculated from it's name.
/// </summary>
/// <param name="name">The name of this genre.</param>
public Genre(string name)
{
Slug = Utility.ToSlug(name);
Name = name;
}
}
}

View File

@@ -16,16 +16,18 @@
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// An interface to represent resources that should have a link field in their return values (like videos).
/// An interface applied to resources.
/// </summary>
public interface ILink
public interface IAddedDate
{
/// <summary>
/// The link to return, in most cases this should be a string.
/// The date at which this resource was added to kyoo.
/// </summary>
public object Link { get; }
public DateTime AddedDate { get; set; }
}
}

View File

@@ -16,11 +16,7 @@
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Collections.Generic;
using System.Linq;
using JetBrains.Annotations;
using Kyoo.Abstractions.Models.Attributes;
namespace Kyoo.Abstractions.Models
{
@@ -30,69 +26,8 @@ namespace Kyoo.Abstractions.Models
public interface IMetadata
{
/// <summary>
/// The link to metadata providers that this show has. See <see cref="MetadataID"/> for more information.
/// The link to metadata providers that this show has. See <see cref="MetadataId"/> for more information.
/// </summary>
[EditableRelation]
[LoadableRelation]
public ICollection<MetadataID> ExternalIDs { get; set; }
}
/// <summary>
/// A static class containing extensions method for every <see cref="IMetadata"/> class.
/// This allow one to use metadata more easily.
/// </summary>
public static class MetadataExtension
{
/// <summary>
/// Retrieve the internal provider's ID of an item using it's provider slug.
/// </summary>
/// <remarks>
/// This method will never return anything if the <see cref="IMetadata.ExternalIDs"/> are not loaded.
/// </remarks>
/// <param name="self">An instance of <see cref="IMetadata"/> to retrieve the ID from.</param>
/// <param name="provider">The slug of the provider</param>
/// <returns>The <see cref="MetadataID.DataID"/> field of the asked provider.</returns>
[CanBeNull]
public static string GetID(this IMetadata self, string provider)
{
return self.ExternalIDs?.FirstOrDefault(x => x.Provider.Slug == provider)?.DataID;
}
/// <summary>
/// Retrieve the internal provider's ID of an item using it's provider slug.
/// If the ID could be found, it is converted to the <typeparamref name="T"/> type and <c>true</c> is returned.
/// </summary>
/// <remarks>
/// This method will never succeed if the <see cref="IMetadata.ExternalIDs"/> are not loaded.
/// </remarks>
/// <param name="self">An instance of <see cref="IMetadata"/> to retrieve the ID from.</param>
/// <param name="provider">The slug of the provider</param>
/// <param name="id">
/// The <see cref="MetadataID.DataID"/> field of the asked provider parsed
/// and converted to the <typeparamref name="T"/> type.
/// It is only relevant if this method returns <c>true</c>.
/// </param>
/// <typeparam name="T">The type to convert the <see cref="MetadataID.DataID"/> to.</typeparam>
/// <returns><c>true</c> if this method succeeded, <c>false</c> otherwise.</returns>
public static bool TryGetID<T>(this IMetadata self, string provider, out T id)
{
string dataID = self.ExternalIDs?.FirstOrDefault(x => x.Provider.Slug == provider)?.DataID;
if (dataID == null)
{
id = default;
return false;
}
try
{
id = (T)Convert.ChangeType(dataID, typeof(T));
}
catch
{
id = default;
return false;
}
return true;
}
public Dictionary<string, MetadataId> ExternalId { get; set; }
}
}

View File

@@ -19,11 +19,12 @@
using System;
using Kyoo.Abstractions.Controllers;
namespace Kyoo.Abstractions.Models.Attributes
namespace Kyoo.Abstractions.Models;
public interface IQuery
{
/// <summary>
/// The targeted relation can be edited via calls to the repository's <see cref="IRepository{T}.Edit"/> method.
/// The sorting that will be used when no user defined one is present.
/// </summary>
[AttributeUsage(AttributeTargets.Property)]
public class EditableRelationAttribute : Attribute { }
public static virtual Sort DefaultSort => throw new NotImplementedException();
}

View File

@@ -16,6 +16,8 @@
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.ComponentModel.DataAnnotations;
using Kyoo.Abstractions.Controllers;
namespace Kyoo.Abstractions.Models
@@ -23,7 +25,7 @@ namespace Kyoo.Abstractions.Models
/// <summary>
/// An interface to represent a resource that can be retrieved from the database.
/// </summary>
public interface IResource
public interface IResource : IQuery
{
/// <summary>
/// A unique ID for this type of resource. This can't be changed and duplicates are not allowed.
@@ -32,7 +34,7 @@ namespace Kyoo.Abstractions.Models
/// You don't need to specify an ID manually when creating a new resource,
/// this field is automatically assigned by the <see cref="IRepository{T}"/>.
/// </remarks>
public int ID { get; set; }
public Guid Id { get; set; }
/// <summary>
/// A human-readable identifier that can be used instead of an ID.
@@ -42,6 +44,7 @@ namespace Kyoo.Abstractions.Models
/// There is no setter for a slug since it can be computed from other fields.
/// For example, a season slug is {ShowSlug}-s{SeasonNumber}.
/// </remarks>
[MaxLength(256)]
public string Slug { get; }
}
}

View File

@@ -16,8 +16,12 @@
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System.Collections.Generic;
using Kyoo.Abstractions.Controllers;
using System;
using System.ComponentModel;
using System.ComponentModel.DataAnnotations;
using System.Globalization;
using Kyoo.Abstractions.Models.Attributes;
using Newtonsoft.Json;
namespace Kyoo.Abstractions.Models
{
@@ -27,52 +31,97 @@ namespace Kyoo.Abstractions.Models
public interface IThumbnails
{
/// <summary>
/// The list of images mapped to a certain index.
/// The string value should be a path supported by the <see cref="IFileSystem"/>.
/// A poster is a 2/3 format image with the cover of the resource.
/// </summary>
/// <remarks>
/// An arbitrary index should not be used, instead use indexes from <see cref="Models.Images"/>
/// </remarks>
/// <example>{"0": "example.com/dune/poster"}</example>
public Dictionary<int, string> Images { get; set; }
}
/// <summary>
/// A class containing constant values for images. To be used as index of a <see cref="IThumbnails.Images"/>.
/// </summary>
public static class Images
{
/// <summary>
/// A poster is a 9/16 format image with the cover of the resource.
/// </summary>
public const int Poster = 0;
public Image? Poster { get; set; }
/// <summary>
/// A thumbnail is a 16/9 format image, it could ether be used as a background or as a preview but it usually
/// is not an official image.
/// </summary>
public const int Thumbnail = 1;
public Image? Thumbnail { get; set; }
/// <summary>
/// A logo is a small image representing the resource.
/// </summary>
public const int Logo = 2;
public Image? Logo { get; set; }
}
[TypeConverter(typeof(ImageConvertor))]
[SqlFirstColumn(nameof(Source))]
public class Image
{
/// <summary>
/// The original image from another server.
/// </summary>
public string Source { get; set; }
/// <summary>
/// A video of a few minutes that tease the content.
/// A hash to display as placeholder while the image is loading.
/// </summary>
public const int Trailer = 3;
[MaxLength(32)]
public string Blurhash { get; set; }
/// <summary>
/// Retrieve the name of an image using it's ID. It is also used by the serializer to retrieve all named images.
/// If a plugin adds a new image type, it should add it's value and name here to allow the serializer to add it.
/// </summary>
public static Dictionary<int, string> ImageName { get; } = new()
public Image() { }
[JsonConstructor]
public Image(string source, string? blurhash = null)
{
[Poster] = nameof(Poster),
[Thumbnail] = nameof(Thumbnail),
[Logo] = nameof(Logo),
[Trailer] = nameof(Trailer)
};
Source = source;
Blurhash = blurhash ?? "000000";
}
public class ImageConvertor : TypeConverter
{
/// <inheritdoc />
public override bool CanConvertFrom(ITypeDescriptorContext? context, Type sourceType)
{
if (sourceType == typeof(string))
return true;
return base.CanConvertFrom(context, sourceType);
}
/// <inheritdoc />
public override object ConvertFrom(
ITypeDescriptorContext? context,
CultureInfo? culture,
object value
)
{
if (value is not string source)
return base.ConvertFrom(context, culture, value)!;
return new Image(source);
}
/// <inheritdoc />
public override bool CanConvertTo(
ITypeDescriptorContext? context,
Type? destinationType
)
{
return false;
}
}
}
/// <summary>
/// The quality of an image
/// </summary>
public enum ImageQuality
{
/// <summary>
/// Small
/// </summary>
Low,
/// <summary>
/// Medium
/// </summary>
Medium,
/// <summary>
/// Large
/// </summary>
High,
}
}

View File

@@ -1,60 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System.Collections.Generic;
using Kyoo.Abstractions.Models.Attributes;
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// A library containing <see cref="Show"/> and <see cref="Collection"/>.
/// </summary>
public class Library : IResource
{
/// <inheritdoc />
public int ID { get; set; }
/// <inheritdoc />
public string Slug { get; set; }
/// <summary>
/// The name of this library.
/// </summary>
public string Name { get; set; }
/// <summary>
/// The list of paths that this library is responsible for. This is mainly used by the Scan task.
/// </summary>
public string[] Paths { get; set; }
/// <summary>
/// The list of <see cref="Provider"/> used for items in this library.
/// </summary>
[EditableRelation] [LoadableRelation] public ICollection<Provider> Providers { get; set; }
/// <summary>
/// The list of shows in this library.
/// </summary>
[LoadableRelation] public ICollection<Show> Shows { get; set; }
/// <summary>
/// The list of collections in this library.
/// </summary>
[LoadableRelation] public ICollection<Collection> Collections { get; set; }
}
}

View File

@@ -0,0 +1,200 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using EntityFrameworkCore.Projectables;
using Kyoo.Abstractions.Controllers;
using Kyoo.Abstractions.Models.Attributes;
using Kyoo.Utils;
using Newtonsoft.Json;
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// A series or a movie.
/// </summary>
public class Movie
: IQuery,
IResource,
IMetadata,
IOnMerge,
IThumbnails,
IAddedDate,
ILibraryItem,
INews,
IWatchlist
{
public static Sort DefaultSort => new Sort<Movie>.By(x => x.Name);
/// <inheritdoc />
public Guid Id { get; set; }
/// <inheritdoc />
[MaxLength(256)]
public string Slug { get; set; }
/// <summary>
/// The title of this show.
/// </summary>
public string Name { get; set; }
/// <summary>
/// A catchphrase for this movie.
/// </summary>
public string? Tagline { get; set; }
/// <summary>
/// The list of alternative titles of this show.
/// </summary>
public string[] Aliases { get; set; } = Array.Empty<string>();
/// <summary>
/// The path of the movie video file.
/// </summary>
public string Path { get; set; }
/// <summary>
/// The summary of this show.
/// </summary>
public string? Overview { get; set; }
/// <summary>
/// A list of tags that match this movie.
/// </summary>
public string[] Tags { get; set; } = Array.Empty<string>();
/// <summary>
/// The list of genres (themes) this show has.
/// </summary>
public Genre[] Genres { get; set; } = Array.Empty<Genre>();
/// <summary>
/// Is this show airing, not aired yet or finished?
/// </summary>
public Status Status { get; set; }
/// <summary>
/// How well this item is rated? (from 0 to 100).
/// </summary>
public int Rating { get; set; }
/// <summary>
/// How long is this movie? (in minutes)
/// </summary>
public int Runtime { get; set; }
/// <summary>
/// The date this movie aired.
/// </summary>
public DateTime? AirDate { get; set; }
/// <inheritdoc />
public DateTime AddedDate { get; set; }
/// <inheritdoc />
public Image? Poster { get; set; }
/// <inheritdoc />
public Image? Thumbnail { get; set; }
/// <inheritdoc />
public Image? Logo { get; set; }
/// <summary>
/// A video of a few minutes that tease the content.
/// </summary>
public string? Trailer { get; set; }
/// <inheritdoc />
public Dictionary<string, MetadataId> ExternalId { get; set; } = new();
/// <summary>
/// The ID of the Studio that made this show.
/// </summary>
[SerializeIgnore]
public Guid? StudioId { get; set; }
/// <summary>
/// The Studio that made this show.
/// </summary>
[LoadableRelation(nameof(StudioId))]
public Studio? Studio { get; set; }
// /// <summary>
// /// The list of people that made this show.
// /// </summary>
// [SerializeIgnore] public ICollection<PeopleRole>? People { get; set; }
/// <summary>
/// The list of collections that contains this show.
/// </summary>
[SerializeIgnore]
public ICollection<Collection>? Collections { get; set; }
/// <summary>
/// Links to watch this movie.
/// </summary>
public VideoLinks Links =>
new()
{
Direct = $"/video/movie/{Slug}/direct",
Hls = $"/video/movie/{Slug}/master.m3u8",
};
[SerializeIgnore]
public ICollection<MovieWatchStatus>? Watched { get; set; }
/// <summary>
/// Metadata of what an user as started/planned to watch.
/// </summary>
[Projectable(UseMemberBody = nameof(_WatchStatus), OnlyOnInclude = true)]
[LoadableRelation(
Sql = "movie_watch_status",
On = "movie_id = \"this\".id and \"relation\".user_id = [current_user]"
)]
public MovieWatchStatus? WatchStatus { get; set; }
// There is a global query filter to filter by user so we just need to do single.
private MovieWatchStatus? _WatchStatus => Watched!.FirstOrDefault();
/// <inheritdoc />
public void OnMerge(object merged)
{
// if (People != null)
// {
// foreach (PeopleRole link in People)
// link.Movie = this;
// }
}
public Movie() { }
[JsonConstructor]
public Movie(string name)
{
if (name != null)
{
Slug = Utility.ToSlug(name);
Name = name;
}
}
}
}

View File

@@ -16,20 +16,30 @@
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
using Kyoo.Abstractions.Controllers;
using Kyoo.Abstractions.Models.Attributes;
using Kyoo.Utils;
using Newtonsoft.Json;
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// An actor, voice actor, writer, animator, somebody who worked on a <see cref="Show"/>.
/// </summary>
public class People : IResource, IMetadata, IThumbnails
[Table("people")]
public class People : IQuery, IResource, IMetadata, IThumbnails
{
/// <inheritdoc />
public int ID { get; set; }
public static Sort DefaultSort => new Sort<People>.By(x => x.Name);
/// <inheritdoc />
public Guid Id { get; set; }
/// <inheritdoc />
[MaxLength(256)]
public string Slug { get; set; }
/// <summary>
@@ -38,14 +48,33 @@ namespace Kyoo.Abstractions.Models
public string Name { get; set; }
/// <inheritdoc />
public Dictionary<int, string> Images { get; set; }
public Image? Poster { get; set; }
/// <inheritdoc />
[EditableRelation] [LoadableRelation] public ICollection<MetadataID> ExternalIDs { get; set; }
public Image? Thumbnail { get; set; }
/// <inheritdoc />
public Image? Logo { get; set; }
/// <inheritdoc />
public Dictionary<string, MetadataId> ExternalId { get; set; } = new();
/// <summary>
/// The list of roles this person has played in. See <see cref="PeopleRole"/> for more information.
/// </summary>
[EditableRelation] [LoadableRelation] public ICollection<PeopleRole> Roles { get; set; }
[SerializeIgnore]
public ICollection<PeopleRole>? Roles { get; set; }
public People() { }
[JsonConstructor]
public People(string name)
{
if (name != null)
{
Slug = Utility.ToSlug(name);
Name = name;
}
}
}
}

View File

@@ -1,72 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System.Collections.Generic;
using Kyoo.Abstractions.Controllers;
using Kyoo.Abstractions.Models.Attributes;
using Kyoo.Utils;
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// This class contains metadata about <see cref="IMetadataProvider"/>.
/// You can have providers even if you don't have the corresponding <see cref="IMetadataProvider"/>.
/// </summary>
public class Provider : IResource, IThumbnails
{
/// <inheritdoc />
public int ID { get; set; }
/// <inheritdoc />
public string Slug { get; set; }
/// <summary>
/// The name of this provider.
/// </summary>
public string Name { get; set; }
/// <inheritdoc />
public Dictionary<int, string> Images { get; set; }
/// <summary>
/// The list of libraries that uses this provider.
/// </summary>
[LoadableRelation] public ICollection<Library> Libraries { get; set; }
/// <summary>
/// Create a new, default, <see cref="Provider"/>
/// </summary>
public Provider() { }
/// <summary>
/// Create a new <see cref="Provider"/> and specify it's <see cref="Name"/>.
/// The <see cref="Slug"/> is automatically calculated from it's name.
/// </summary>
/// <param name="name">The name of this provider.</param>
/// <param name="logo">The logo of this provider.</param>
public Provider(string name, string logo)
{
Slug = Utility.ToSlug(name);
Name = name;
Images = new Dictionary<int, string>
{
[Models.Images.Logo] = logo
};
}
}
}

View File

@@ -18,7 +18,10 @@
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
using System.Text.RegularExpressions;
using EntityFrameworkCore.Projectables;
using JetBrains.Annotations;
using Kyoo.Abstractions.Controllers;
using Kyoo.Abstractions.Models.Attributes;
@@ -28,30 +31,34 @@ namespace Kyoo.Abstractions.Models
/// <summary>
/// A season of a <see cref="Show"/>.
/// </summary>
public class Season : IResource, IMetadata, IThumbnails
public class Season : IQuery, IResource, IMetadata, IThumbnails, IAddedDate
{
public static Sort DefaultSort => new Sort<Season>.By(x => x.SeasonNumber);
/// <inheritdoc />
public int ID { get; set; }
public Guid Id { get; set; }
/// <inheritdoc />
[Computed]
[MaxLength(256)]
public string Slug
{
get
{
if (ShowSlug == null && Show == null)
return $"{ShowID}-s{SeasonNumber}";
return $"{ShowId}-s{SeasonNumber}";
return $"{ShowSlug ?? Show?.Slug}-s{SeasonNumber}";
}
[UsedImplicitly]
[NotNull]
private set
{
Match match = Regex.Match(value ?? string.Empty, @"(?<show>.+)-s(?<season>\d+)");
Match match = Regex.Match(value, @"(?<show>.+)-s(?<season>\d+)");
if (!match.Success)
throw new ArgumentException("Invalid season slug. Format: {showSlug}-s{seasonNumber}");
throw new ArgumentException(
"Invalid season slug. Format: {showSlug}-s{seasonNumber}"
);
ShowSlug = match.Groups["show"].Value;
SeasonNumber = int.Parse(match.Groups["season"].Value);
}
@@ -60,18 +67,19 @@ namespace Kyoo.Abstractions.Models
/// <summary>
/// The slug of the Show that contain this episode. If this is not set, this season is ill-formed.
/// </summary>
[SerializeIgnore] public string ShowSlug { private get; set; }
[SerializeIgnore]
public string? ShowSlug { private get; set; }
/// <summary>
/// The ID of the Show containing this season.
/// </summary>
[SerializeIgnore] public int ShowID { get; set; }
public Guid ShowId { get; set; }
/// <summary>
/// The show that contains this season.
/// This must be explicitly loaded via a call to <see cref="ILibraryManager.Load"/>.
/// </summary>
[LoadableRelation(nameof(ShowID))] public Show Show { get; set; }
[LoadableRelation(nameof(ShowId))]
public Show? Show { get; set; }
/// <summary>
/// The number of this season. This can be set to 0 to indicate specials.
@@ -81,32 +89,63 @@ namespace Kyoo.Abstractions.Models
/// <summary>
/// The title of this season.
/// </summary>
public string Title { get; set; }
public string? Name { get; set; }
/// <summary>
/// A quick overview of this season.
/// </summary>
public string Overview { get; set; }
public string? Overview { get; set; }
/// <summary>
/// The starting air date of this season.
/// </summary>
public DateTime? StartDate { get; set; }
/// <inheritdoc />
public DateTime AddedDate { get; set; }
/// <summary>
/// The ending date of this season.
/// </summary>
public DateTime? EndDate { get; set; }
/// <inheritdoc />
public Dictionary<int, string> Images { get; set; }
public Image? Poster { get; set; }
/// <inheritdoc />
[EditableRelation] [LoadableRelation] public ICollection<MetadataID> ExternalIDs { get; set; }
public Image? Thumbnail { get; set; }
/// <inheritdoc />
public Image? Logo { get; set; }
/// <inheritdoc />
public Dictionary<string, MetadataId> ExternalId { get; set; } = new();
/// <summary>
/// The list of episodes that this season contains.
/// </summary>
[LoadableRelation] public ICollection<Episode> Episodes { get; set; }
[SerializeIgnore]
public ICollection<Episode>? Episodes { get; set; }
/// <summary>
/// The number of episodes in this season.
/// </summary>
[Projectable(UseMemberBody = nameof(_EpisodesCount), OnlyOnInclude = true)]
[NotMapped]
[LoadableRelation(
// language=PostgreSQL
Projected = """
(
select
count(*)::int
from
episodes as e
where
e.season_id = id) as episodes_count
"""
)]
public int EpisodesCount { get; set; }
private int _EpisodesCount => Episodes!.Count;
}
}

View File

@@ -18,42 +18,68 @@
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
using System.Linq;
using EntityFrameworkCore.Projectables;
using Kyoo.Abstractions.Controllers;
using Kyoo.Abstractions.Models.Attributes;
using Kyoo.Utils;
using Newtonsoft.Json;
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// A series or a movie.
/// </summary>
public class Show : IResource, IMetadata, IOnMerge, IThumbnails
public class Show
: IQuery,
IResource,
IMetadata,
IOnMerge,
IThumbnails,
IAddedDate,
ILibraryItem,
IWatchlist
{
/// <inheritdoc />
public int ID { get; set; }
public static Sort DefaultSort => new Sort<Show>.By(x => x.Name);
/// <inheritdoc />
public Guid Id { get; set; }
/// <inheritdoc />
[MaxLength(256)]
public string Slug { get; set; }
/// <summary>
/// The title of this show.
/// </summary>
public string Title { get; set; }
public string Name { get; set; }
/// <summary>
/// A catchphrase for this show.
/// </summary>
public string? Tagline { get; set; }
/// <summary>
/// The list of alternative titles of this show.
/// </summary>
[EditableRelation] public string[] Aliases { get; set; }
/// <summary>
/// The path of the root directory of this show.
/// This can be any kind of path supported by <see cref="IFileSystem"/>
/// </summary>
[SerializeIgnore] public string Path { get; set; }
public List<string> Aliases { get; set; } = new();
/// <summary>
/// The summary of this show.
/// </summary>
public string Overview { get; set; }
public string? Overview { get; set; }
/// <summary>
/// A list of tags that match this movie.
/// </summary>
public List<string> Tags { get; set; } = new();
/// <summary>
/// The list of genres (themes) this show has.
/// </summary>
public List<Genre> Genres { get; set; } = new();
/// <summary>
/// Is this show airing, not aired yet or finished?
@@ -61,11 +87,9 @@ namespace Kyoo.Abstractions.Models
public Status Status { get; set; }
/// <summary>
/// An URL to a trailer. This could be any path supported by the <see cref="IFileSystem"/>.
/// How well this item is rated? (from 0 to 100).
/// </summary>
/// TODO for now, this is set to a youtube url. It should be cached and converted to a local file.
[Obsolete("Use Images instead of this, this is only kept for the API response.")]
public string TrailerUrl => Images?.GetValueOrDefault(Models.Images.Trailer);
public int Rating { get; set; }
/// <summary>
/// The date this show started airing. It can be null if this is unknown.
@@ -74,74 +98,145 @@ namespace Kyoo.Abstractions.Models
/// <summary>
/// The date this show finished airing.
/// It must be after the <see cref="StartAir"/> but can be the same (example: for movies).
/// It can also be null if this is unknown.
/// </summary>
public DateTime? EndAir { get; set; }
/// <inheritdoc />
public Dictionary<int, string> Images { get; set; }
/// <summary>
/// True if this show represent a movie, false otherwise.
/// </summary>
public bool IsMovie { get; set; }
public DateTime AddedDate { get; set; }
/// <inheritdoc />
[EditableRelation] [LoadableRelation] public ICollection<MetadataID> ExternalIDs { get; set; }
public Image? Poster { get; set; }
/// <inheritdoc />
public Image? Thumbnail { get; set; }
/// <inheritdoc />
public Image? Logo { get; set; }
/// <summary>
/// A video of a few minutes that tease the content.
/// </summary>
public string? Trailer { get; set; }
[SerializeIgnore]
[Column("start_air")]
public DateTime? AirDate => StartAir;
/// <inheritdoc />
public Dictionary<string, MetadataId> ExternalId { get; set; } = new();
/// <summary>
/// The ID of the Studio that made this show.
/// </summary>
[SerializeIgnore] public int? StudioID { get; set; }
[SerializeIgnore]
public Guid? StudioId { get; set; }
/// <summary>
/// The Studio that made this show.
/// This must be explicitly loaded via a call to <see cref="ILibraryManager.Load"/>.
/// </summary>
[LoadableRelation(nameof(StudioID))] [EditableRelation] public Studio Studio { get; set; }
[LoadableRelation(nameof(StudioId))]
public Studio? Studio { get; set; }
/// <summary>
/// The list of genres (themes) this show has.
/// </summary>
[LoadableRelation] [EditableRelation] public ICollection<Genre> Genres { get; set; }
/// <summary>
/// The list of people that made this show.
/// </summary>
[LoadableRelation] [EditableRelation] public ICollection<PeopleRole> People { get; set; }
// /// <summary>
// /// The list of people that made this show.
// /// </summary>
// [SerializeIgnore] public ICollection<PeopleRole>? People { get; set; }
/// <summary>
/// The different seasons in this show. If this is a movie, this list is always null or empty.
/// </summary>
[LoadableRelation] public ICollection<Season> Seasons { get; set; }
[SerializeIgnore]
public ICollection<Season>? Seasons { get; set; }
/// <summary>
/// The list of episodes in this show.
/// If this is a movie, there will be a unique episode (with the seasonNumber and episodeNumber set to null).
/// Having an episode is necessary to store metadata and tracks.
/// </summary>
[LoadableRelation] public ICollection<Episode> Episodes { get; set; }
/// <summary>
/// The list of libraries that contains this show.
/// </summary>
[LoadableRelation] public ICollection<Library> Libraries { get; set; }
[SerializeIgnore]
public ICollection<Episode>? Episodes { get; set; }
/// <summary>
/// The list of collections that contains this show.
/// </summary>
[LoadableRelation] public ICollection<Collection> Collections { get; set; }
[SerializeIgnore]
public ICollection<Collection>? Collections { get; set; }
/// <summary>
/// The first episode of this show.
/// </summary>
[Projectable(UseMemberBody = nameof(_FirstEpisode), OnlyOnInclude = true)]
[LoadableRelation(
// language=PostgreSQL
Sql = """
select
fe.* -- Episode as fe
from (
select
e.*,
row_number() over (partition by e.show_id order by e.absolute_number, e.season_number, e.episode_number) as number
from
episodes as e) as "fe"
where
fe.number <= 1
""",
On = "show_id = \"this\".id"
)]
public Episode? FirstEpisode { get; set; }
private Episode? _FirstEpisode =>
Episodes!
.OrderBy(x => x.AbsoluteNumber)
.ThenBy(x => x.SeasonNumber)
.ThenBy(x => x.EpisodeNumber)
.FirstOrDefault();
/// <summary>
/// The number of episodes in this show.
/// </summary>
[Projectable(UseMemberBody = nameof(_EpisodesCount), OnlyOnInclude = true)]
[NotMapped]
[LoadableRelation(
// language=PostgreSQL
Projected = """
(
select
count(*)::int
from
episodes as e
where
e.show_id = "this".id) as episodes_count
"""
)]
public int EpisodesCount { get; set; }
private int _EpisodesCount => Episodes!.Count;
[SerializeIgnore]
public ICollection<ShowWatchStatus>? Watched { get; set; }
/// <summary>
/// Metadata of what an user as started/planned to watch.
/// </summary>
[Projectable(UseMemberBody = nameof(_WatchStatus), OnlyOnInclude = true)]
[LoadableRelation(
Sql = "show_watch_status",
On = "show_id = \"this\".id and \"relation\".user_id = [current_user]"
)]
public ShowWatchStatus? WatchStatus { get; set; }
// There is a global query filter to filter by user so we just need to do single.
private ShowWatchStatus? _WatchStatus => Watched!.FirstOrDefault();
/// <inheritdoc />
public void OnMerge(object merged)
{
if (People != null)
{
foreach (PeopleRole link in People)
link.Show = this;
}
// if (People != null)
// {
// foreach (PeopleRole link in People)
// link.Show = this;
// }
if (Seasons != null)
{
foreach (Season season in Seasons)
@@ -154,6 +249,18 @@ namespace Kyoo.Abstractions.Models
episode.Show = this;
}
}
public Show() { }
[JsonConstructor]
public Show(string name)
{
if (name != null)
{
Slug = Utility.ToSlug(name);
Name = name;
}
}
}
/// <summary>

View File

@@ -16,21 +16,28 @@
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using Kyoo.Abstractions.Controllers;
using Kyoo.Abstractions.Models.Attributes;
using Kyoo.Utils;
using Newtonsoft.Json;
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// A studio that make shows.
/// </summary>
public class Studio : IResource, IMetadata
public class Studio : IQuery, IResource, IMetadata
{
/// <inheritdoc />
public int ID { get; set; }
public static Sort DefaultSort => new Sort<Studio>.By(x => x.Name);
/// <inheritdoc />
public Guid Id { get; set; }
/// <inheritdoc />
[MaxLength(256)]
public string Slug { get; set; }
/// <summary>
@@ -41,10 +48,17 @@ namespace Kyoo.Abstractions.Models
/// <summary>
/// The list of shows that are made by this studio.
/// </summary>
[LoadableRelation] public ICollection<Show> Shows { get; set; }
[SerializeIgnore]
public ICollection<Show>? Shows { get; set; }
/// <summary>
/// The list of movies that are made by this studio.
/// </summary>
[SerializeIgnore]
public ICollection<Movie>? Movies { get; set; }
/// <inheritdoc />
[EditableRelation] [LoadableRelation] public ICollection<MetadataID> ExternalIDs { get; set; }
public Dictionary<string, MetadataId> ExternalId { get; set; } = new();
/// <summary>
/// Create a new, empty, <see cref="Studio"/>.
@@ -55,10 +69,14 @@ namespace Kyoo.Abstractions.Models
/// Create a new <see cref="Studio"/> with a specific name, the slug is calculated automatically.
/// </summary>
/// <param name="name">The name of the studio.</param>
[JsonConstructor]
public Studio(string name)
{
Slug = Utility.ToSlug(name);
Name = name;
if (name != null)
{
Slug = Utility.ToSlug(name);
Name = name;
}
}
}
}

View File

@@ -1,229 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Globalization;
using System.Linq;
using System.Text.RegularExpressions;
using JetBrains.Annotations;
using Kyoo.Abstractions.Models.Attributes;
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// The list of available stream types.
/// Attachments are only used temporarily by the transcoder but are not stored in a database.
/// </summary>
public enum StreamType
{
/// <summary>
/// The type of the stream is not known.
/// </summary>
Unknown = 0,
/// <summary>
/// The stream is a video.
/// </summary>
Video = 1,
/// <summary>
/// The stream is an audio.
/// </summary>
Audio = 2,
/// <summary>
/// The stream is a subtitle.
/// </summary>
Subtitle = 3,
}
/// <summary>
/// A video, audio or subtitle track for an episode.
/// </summary>
public class Track : IResource, ILink
{
/// <inheritdoc />
public int ID { get; set; }
/// <inheritdoc />
[Computed]
public string Slug
{
get
{
string type = Type.ToString().ToLowerInvariant();
string index = TrackIndex != 0 ? $"-{TrackIndex}" : string.Empty;
string episode = _episodeSlug ?? Episode?.Slug ?? EpisodeID.ToString(CultureInfo.InvariantCulture);
return $"{episode}.{Language ?? "und"}{index}{(IsForced ? ".forced" : string.Empty)}.{type}";
}
[UsedImplicitly]
private set
{
if (value == null)
throw new ArgumentNullException(nameof(value));
Match match = Regex.Match(value,
@"(?<ep>[^\.]+)\.(?<lang>\w{0,3})(-(?<index>\d+))?(\.(?<forced>forced))?\.(?<type>\w+)(\.\w*)?");
if (!match.Success)
{
throw new ArgumentException(
"Invalid track slug. " +
"Format: {episodeSlug}.{language}[-{index}][.forced].{type}[.{extension}]"
);
}
_episodeSlug = match.Groups["ep"].Value;
Language = match.Groups["lang"].Value;
if (Language == "und")
Language = null;
TrackIndex = match.Groups["index"].Success ? int.Parse(match.Groups["index"].Value, CultureInfo.InvariantCulture) : 0;
IsForced = match.Groups["forced"].Success;
Type = Enum.Parse<StreamType>(match.Groups["type"].Value, true);
}
}
/// <summary>
/// The title of the stream.
/// </summary>
public string Title { get; set; }
/// <summary>
/// The language of this stream (as a ISO-639-2 language code)
/// </summary>
public string Language { get; set; }
/// <summary>
/// The codec of this stream.
/// </summary>
public string Codec { get; set; }
/// <summary>
/// Is this stream the default one of it's type?
/// </summary>
public bool IsDefault { get; set; }
/// <summary>
/// Is this stream tagged as forced?
/// </summary>
public bool IsForced { get; set; }
/// <summary>
/// Is this track extern to the episode's file?
/// </summary>
public bool IsExternal { get; set; }
/// <summary>
/// The path of this track.
/// </summary>
[SerializeIgnore] public string Path { get; set; }
/// <summary>
/// The type of this stream.
/// </summary>
[SerializeIgnore] public StreamType Type { get; set; }
/// <summary>
/// The ID of the episode that uses this track.
/// </summary>
[SerializeIgnore] public int EpisodeID { get; set; }
/// <summary>
/// The episode that uses this track.
/// </summary>
[LoadableRelation(nameof(EpisodeID))]
public Episode Episode
{
get => _episode;
set
{
_episode = value;
if (_episode != null)
_episodeSlug = _episode.Slug;
}
}
/// <summary>
/// The index of this track on the episode.
/// </summary>
public int TrackIndex { get; set; }
/// <summary>
/// A user-friendly name for this track. It does not include the track type.
/// </summary>
public string DisplayName
{
get
{
string language = _GetLanguage(Language);
if (language == null)
return $"Unknown (index: {TrackIndex})";
CultureInfo info = CultureInfo.GetCultures(CultureTypes.NeutralCultures)
.FirstOrDefault(x => x.ThreeLetterISOLanguageName == language);
string name = info?.EnglishName ?? language;
if (IsForced)
name += " Forced";
if (IsExternal)
name += " (External)";
if (Title is { Length: > 1 })
name += " - " + Title;
return name;
}
}
/// <summary>
/// The slug of the episode that contain this track. If this is not set, this track is ill-formed.
/// </summary>
[SerializeIgnore] private string _episodeSlug;
/// <summary>
/// The episode that uses this track.
/// This is the baking field of <see cref="Episode"/>.
/// </summary>
[SerializeIgnore] private Episode _episode;
/// <inheritdoc/>
public object Link => Type == StreamType.Subtitle ? $"/subtitle/{Slug}" : null;
// Converting mkv track language to c# system language tag.
private static string _GetLanguage(string mkvLanguage)
{
// TODO delete this and have a real way to get the language string from the ISO-639-2.
return mkvLanguage switch
{
"fre" => "fra",
null => "und",
_ => mkvLanguage
};
}
/// <summary>
/// Utility method to create a track slug from a incomplete slug (only add the type of the track).
/// </summary>
/// <param name="baseSlug">The slug to edit</param>
/// <param name="type">The new type of this </param>
/// <returns>The completed slug.</returns>
public static string BuildSlug(string baseSlug, StreamType type)
{
return baseSlug.EndsWith($".{type}", StringComparison.InvariantCultureIgnoreCase)
? baseSlug
: $"{baseSlug}.{type.ToString().ToLowerInvariant()}";
}
}
}

View File

@@ -16,20 +16,28 @@
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using Kyoo.Abstractions.Controllers;
using Kyoo.Abstractions.Models.Attributes;
using Kyoo.Utils;
using Newtonsoft.Json;
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// A single user of the app.
/// </summary>
public class User : IResource, IThumbnails
public class User : IQuery, IResource, IAddedDate
{
/// <inheritdoc />
public int ID { get; set; }
public static Sort DefaultSort => new Sort<User>.By(x => x.Username);
/// <inheritdoc />
public Guid Id { get; set; }
/// <inheritdoc />
[MaxLength(256)]
public string Slug { get; set; }
/// <summary>
@@ -51,27 +59,32 @@ namespace Kyoo.Abstractions.Models
/// <summary>
/// The list of permissions of the user. The format of this is implementation dependent.
/// </summary>
public string[] Permissions { get; set; }
/// <summary>
/// Arbitrary extra data that can be used by specific authentication implementations.
/// </summary>
[SerializeIgnore]
public Dictionary<string, string> ExtraData { get; set; }
public string[] Permissions { get; set; } = Array.Empty<string>();
/// <inheritdoc />
public Dictionary<int, string> Images { get; set; }
public DateTime AddedDate { get; set; }
/// <summary>
/// The list of shows the user has finished.
/// A logo is a small image representing the resource.
/// </summary>
[SerializeIgnore]
public ICollection<Show> Watched { get; set; }
public Image? Logo { get; set; }
/// <summary>
/// The list of episodes the user is watching (stopped in progress or the next episode of the show)
/// </summary>
[SerializeIgnore]
public ICollection<WatchedEpisode> CurrentlyWatching { get; set; }
// /// <summary>
// /// The user's watch list.
// /// </summary>
// // [SerializeIgnore]
// // public ICollection<WatchInfo>? Watchlist { get; set; }
public User() { }
[JsonConstructor]
public User(string username)
{
if (username != null)
{
Slug = Utility.ToSlug(username);
Username = username;
}
}
}
}

View File

@@ -0,0 +1,239 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using Kyoo.Abstractions.Models.Attributes;
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// Has the user started watching, is it planned?
/// </summary>
public enum WatchStatus
{
/// <summary>
/// The user has already watched this.
/// </summary>
Completed,
/// <summary>
/// The user started watching this but has not finished.
/// </summary>
Watching,
/// <summary>
/// The user does not plan to continue watching.
/// </summary>
Droped,
/// <summary>
/// The user has not started watching this but plans to.
/// </summary>
Planned,
}
/// <summary>
/// Metadata of what an user as started/planned to watch.
/// </summary>
[SqlFirstColumn(nameof(UserId))]
public class MovieWatchStatus : IAddedDate
{
/// <summary>
/// The ID of the user that started watching this episode.
/// </summary>
[SerializeIgnore]
public Guid UserId { get; set; }
/// <summary>
/// The user that started watching this episode.
/// </summary>
[SerializeIgnore]
public User User { get; set; }
/// <summary>
/// The ID of the movie started.
/// </summary>
[SerializeIgnore]
public Guid MovieId { get; set; }
/// <summary>
/// The <see cref="Movie"/> started.
/// </summary>
[SerializeIgnore]
public Movie Movie { get; set; }
/// <inheritdoc/>
public DateTime AddedDate { get; set; }
/// <summary>
/// The date at which this item was played.
/// </summary>
public DateTime? PlayedDate { get; set; }
/// <summary>
/// Has the user started watching, is it planned?
/// </summary>
public WatchStatus Status { get; set; }
/// <summary>
/// Where the player has stopped watching the movie (in seconds).
/// </summary>
/// <remarks>
/// Null if the status is not Watching.
/// </remarks>
public int? WatchedTime { get; set; }
/// <summary>
/// Where the player has stopped watching the movie (in percentage between 0 and 100).
/// </summary>
/// <remarks>
/// Null if the status is not Watching.
/// </remarks>
public int? WatchedPercent { get; set; }
}
[SqlFirstColumn(nameof(UserId))]
public class EpisodeWatchStatus : IAddedDate
{
/// <summary>
/// The ID of the user that started watching this episode.
/// </summary>
[SerializeIgnore]
public Guid UserId { get; set; }
/// <summary>
/// The user that started watching this episode.
/// </summary>
[SerializeIgnore]
public User User { get; set; }
/// <summary>
/// The ID of the episode started.
/// </summary>
[SerializeIgnore]
public Guid? EpisodeId { get; set; }
/// <summary>
/// The <see cref="Episode"/> started.
/// </summary>
[SerializeIgnore]
public Episode Episode { get; set; }
/// <inheritdoc/>
public DateTime AddedDate { get; set; }
/// <summary>
/// The date at which this item was played.
/// </summary>
public DateTime? PlayedDate { get; set; }
/// <summary>
/// Has the user started watching, is it planned?
/// </summary>
public WatchStatus Status { get; set; }
/// <summary>
/// Where the player has stopped watching the episode (in seconds).
/// </summary>
/// <remarks>
/// Null if the status is not Watching.
/// </remarks>
public int? WatchedTime { get; set; }
/// <summary>
/// Where the player has stopped watching the episode (in percentage between 0 and 100).
/// </summary>
/// <remarks>
/// Null if the status is not Watching or if the next episode is not started.
/// </remarks>
public int? WatchedPercent { get; set; }
}
[SqlFirstColumn(nameof(UserId))]
public class ShowWatchStatus : IAddedDate
{
/// <summary>
/// The ID of the user that started watching this episode.
/// </summary>
[SerializeIgnore]
public Guid UserId { get; set; }
/// <summary>
/// The user that started watching this episode.
/// </summary>
[SerializeIgnore]
public User User { get; set; }
/// <summary>
/// The ID of the show started.
/// </summary>
[SerializeIgnore]
public Guid ShowId { get; set; }
/// <summary>
/// The <see cref="Show"/> started.
/// </summary>
[SerializeIgnore]
public Show Show { get; set; }
/// <inheritdoc/>
public DateTime AddedDate { get; set; }
/// <summary>
/// The date at which this item was played.
/// </summary>
public DateTime? PlayedDate { get; set; }
/// <summary>
/// Has the user started watching, is it planned?
/// </summary>
public WatchStatus Status { get; set; }
/// <summary>
/// The number of episodes the user has not seen.
/// </summary>
public int UnseenEpisodesCount { get; set; }
/// <summary>
/// The ID of the episode started.
/// </summary>
[SerializeIgnore]
public Guid? NextEpisodeId { get; set; }
/// <summary>
/// The next <see cref="Episode"/> to watch.
/// </summary>
public Episode? NextEpisode { get; set; }
/// <summary>
/// Where the player has stopped watching the episode (in seconds).
/// </summary>
/// <remarks>
/// Null if the status is not Watching or if the next episode is not started.
/// </remarks>
public int? WatchedTime { get; set; }
/// <summary>
/// Where the player has stopped watching the episode (in percentage between 0 and 100).
/// </summary>
/// <remarks>
/// Null if the status is not Watching or if the next episode is not started.
/// </remarks>
public int? WatchedPercent { get; set; }
}
}

View File

@@ -16,31 +16,39 @@
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System.Collections.Generic;
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// Metadata of episode currently watching by an user
/// Results of a search request.
/// </summary>
public class WatchedEpisode
/// <typeparam name="T">The search item's type.</typeparam>
public class SearchPage<T> : Page<T>
where T : IResource
{
/// <summary>
/// The ID of the user that started watching this episode.
/// </summary>
public int UserID { get; set; }
public SearchPage(
SearchResult result,
string @this,
string? previous,
string? next,
string first
)
: base(result.Items, @this, previous, next, first)
{
Query = result.Query;
}
/// <summary>
/// The ID of the episode started.
/// The query of the search request.
/// </summary>
public int EpisodeID { get; set; }
public string? Query { get; init; }
/// <summary>
/// The <see cref="Episode"/> started.
/// </summary>
public Episode Episode { get; set; }
public class SearchResult
{
public string? Query { get; set; }
/// <summary>
/// Where the player has stopped watching the episode (between 0 and 100).
/// </summary>
public int WatchedPercentage { get; set; }
public ICollection<T> Items { get; set; }
}
}
}

View File

@@ -1,63 +0,0 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System.Collections.Generic;
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// Results of a search request.
/// </summary>
public class SearchResult
{
/// <summary>
/// The query of the search request.
/// </summary>
public string Query { get; init; }
/// <summary>
/// The collections that matched the search.
/// </summary>
public ICollection<Collection> Collections { get; init; }
/// <summary>
/// The shows that matched the search.
/// </summary>
public ICollection<Show> Shows { get; init; }
/// <summary>
/// The episodes that matched the search.
/// </summary>
public ICollection<Episode> Episodes { get; init; }
/// <summary>
/// The people that matched the search.
/// </summary>
public ICollection<People> People { get; init; }
/// <summary>
/// The genres that matched the search.
/// </summary>
public ICollection<Genre> Genres { get; init; }
/// <summary>
/// The studios that matched the search.
/// </summary>
public ICollection<Studio> Studios { get; init; }
}
}

View File

@@ -0,0 +1,371 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Collections;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Linq.Expressions;
using System.Reflection;
using Kyoo.Abstractions.Models.Attributes;
using Sprache;
namespace Kyoo.Abstractions.Models.Utils;
public static class ParseHelper
{
public static Parser<T> ErrorMessage<T>(this Parser<T> @this, string message) =>
input =>
{
IResult<T> result = @this(input);
return result.WasSuccessful
? result
: Result.Failure<T>(result.Remainder, message, result.Expectations);
};
public static Parser<T> Error<T>(string message) =>
input =>
{
return Result.Failure<T>(input, message, Array.Empty<string>());
};
}
public abstract record Filter
{
public static Filter<T>? And<T>(params Filter<T>?[] filters)
{
return filters
.Where(x => x != null)
.Aggregate(
(Filter<T>?)null,
(acc, filter) =>
{
if (acc == null)
return filter;
return new Filter<T>.And(acc, filter!);
}
);
}
public static Filter<T>? Or<T>(params Filter<T>?[] filters)
{
return filters
.Where(x => x != null)
.Aggregate(
(Filter<T>?)null,
(acc, filter) =>
{
if (acc == null)
return filter;
return new Filter<T>.Or(acc, filter!);
}
);
}
}
public abstract record Filter<T> : Filter
{
public record And(Filter<T> First, Filter<T> Second) : Filter<T>;
public record Or(Filter<T> First, Filter<T> Second) : Filter<T>;
public record Not(Filter<T> Filter) : Filter<T>;
public record Eq(string Property, object? Value) : Filter<T>;
public record Ne(string Property, object? Value) : Filter<T>;
public record Gt(string Property, object Value) : Filter<T>;
public record Ge(string Property, object Value) : Filter<T>;
public record Lt(string Property, object Value) : Filter<T>;
public record Le(string Property, object Value) : Filter<T>;
public record Has(string Property, object Value) : Filter<T>;
/// <summary>
/// Internal filter used for keyset paginations to resume random sorts.
/// The pseudo sql is md5(seed || table.id) = md5(seed || 'hardCodedId')
/// </summary>
public record CmpRandom(string cmp, string Seed, Guid ReferenceId) : Filter<T>;
/// <summary>
/// Internal filter used only in EF with hard coded lamdas (used for relations).
/// </summary>
public record Lambda(Expression<Func<T, bool>> Inner) : Filter<T>;
public static class FilterParsers
{
public static readonly Parser<Filter<T>> Filter = Parse
.Ref(() => Bracket)
.Or(Parse.Ref(() => Not))
.Or(Parse.Ref(() => Eq))
.Or(Parse.Ref(() => Ne))
.Or(Parse.Ref(() => Gt))
.Or(Parse.Ref(() => Ge))
.Or(Parse.Ref(() => Lt))
.Or(Parse.Ref(() => Le))
.Or(Parse.Ref(() => Has));
public static readonly Parser<Filter<T>> CompleteFilter = Parse
.Ref(() => Or)
.Or(Parse.Ref(() => And))
.Or(Filter);
public static readonly Parser<Filter<T>> Bracket =
from open in Parse.Char('(').Token()
from filter in CompleteFilter
from close in Parse.Char(')').Token()
select filter;
public static readonly Parser<IEnumerable<char>> AndOperator = Parse
.IgnoreCase("and")
.Or(Parse.String("&&"))
.Token();
public static readonly Parser<IEnumerable<char>> OrOperator = Parse
.IgnoreCase("or")
.Or(Parse.String("||"))
.Token();
public static readonly Parser<Filter<T>> And = Parse.ChainOperator(
AndOperator,
Filter,
(_, a, b) => new And(a, b)
);
public static readonly Parser<Filter<T>> Or = Parse.ChainOperator(
OrOperator,
And.Or(Filter),
(_, a, b) => new Or(a, b)
);
public static readonly Parser<Filter<T>> Not =
from not in Parse.IgnoreCase("not").Or(Parse.String("!")).Token()
from filter in CompleteFilter
select new Not(filter);
private static Parser<object> _GetValueParser(Type type)
{
Type? nullable = Nullable.GetUnderlyingType(type);
if (nullable != null)
{
return from value in _GetValueParser(nullable) select value;
}
if (type == typeof(int))
return Parse.Number.Select(x => int.Parse(x) as object);
if (type == typeof(float))
{
return from a in Parse.Number
from dot in Parse.Char('.')
from b in Parse.Number
select float.Parse($"{a}.{b}") as object;
}
if (type == typeof(Guid))
{
return from guid in Parse.Regex(
@"[({]?[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}[})]?",
"Guid"
)
select Guid.Parse(guid) as object;
}
if (type == typeof(string))
{
return (
from lq in Parse.Char('"').Or(Parse.Char('\''))
from str in Parse.AnyChar.Where(x => x is not '"' and not '\'').Many().Text()
from rq in Parse.Char('"').Or(Parse.Char('\''))
select str
).Or(Parse.LetterOrDigit.Many().Text());
}
if (type.IsEnum)
{
return Parse
.LetterOrDigit
.Many()
.Text()
.Then(x =>
{
if (Enum.TryParse(type, x, true, out object? value))
return Parse.Return(value);
return ParseHelper.Error<object>($"Invalid enum value. Unexpected {x}");
});
}
if (type == typeof(DateTime))
{
return from year in Parse.Digit.Repeat(4).Text().Select(int.Parse)
from yd in Parse.Char('-')
from mouth in Parse.Digit.Repeat(2).Text().Select(int.Parse)
from md in Parse.Char('-')
from day in Parse.Digit.Repeat(2).Text().Select(int.Parse)
select new DateTime(year, mouth, day) as object;
}
if (typeof(IEnumerable).IsAssignableFrom(type))
return ParseHelper.Error<object>(
"Can't filter a list with a default comparator, use the 'has' filter."
);
return ParseHelper.Error<object>("Unfilterable field found");
}
private static Parser<Filter<T>> _GetOperationParser(
Parser<object> op,
Func<string, object, Filter<T>> apply,
Func<Type, Parser<object?>>? customTypeParser = null
)
{
Parser<string> property = Parse.LetterOrDigit.AtLeastOnce().Text();
return property.Then(prop =>
{
Type[] types =
typeof(T).GetCustomAttribute<OneOfAttribute>()?.Types ?? new[] { typeof(T) };
if (string.Equals(prop, "kind", StringComparison.OrdinalIgnoreCase))
{
return from eq in op
from val in types
.Select(x => Parse.IgnoreCase(x.Name).Text())
.Aggregate(
null as Parser<string>,
(acc, x) => acc == null ? x : Parse.Or(acc, x)
)
select apply("kind", val);
}
PropertyInfo? propInfo = types
.Select(
x =>
x.GetProperty(
prop,
BindingFlags.IgnoreCase
| BindingFlags.Public
| BindingFlags.Instance
)
)
.FirstOrDefault();
if (propInfo == null)
return ParseHelper.Error<Filter<T>>($"The given filter '{prop}' is invalid.");
Parser<object?> value =
customTypeParser != null
? customTypeParser(propInfo.PropertyType)
: _GetValueParser(propInfo.PropertyType);
return from eq in op
from val in value
select apply(propInfo.Name, val);
});
}
public static readonly Parser<Filter<T>> Eq = _GetOperationParser(
Parse.IgnoreCase("eq").Or(Parse.String("=")).Token(),
(property, value) => new Eq(property, value),
(Type type) =>
{
Type? inner = Nullable.GetUnderlyingType(type);
if (inner == null)
return _GetValueParser(type);
return Parse
.String("null")
.Token()
.Return((object?)null)
.Or(_GetValueParser(inner));
}
);
public static readonly Parser<Filter<T>> Ne = _GetOperationParser(
Parse.IgnoreCase("ne").Or(Parse.String("!=")).Token(),
(property, value) => new Ne(property, value),
(Type type) =>
{
Type? inner = Nullable.GetUnderlyingType(type);
if (inner == null)
return _GetValueParser(type);
return Parse
.String("null")
.Token()
.Return((object?)null)
.Or(_GetValueParser(inner));
}
);
public static readonly Parser<Filter<T>> Gt = _GetOperationParser(
Parse.IgnoreCase("gt").Or(Parse.String(">")).Token(),
(property, value) => new Gt(property, value)
);
public static readonly Parser<Filter<T>> Ge = _GetOperationParser(
Parse.IgnoreCase("ge").Or(Parse.String(">=")).Token(),
(property, value) => new Ge(property, value)
);
public static readonly Parser<Filter<T>> Lt = _GetOperationParser(
Parse.IgnoreCase("lt").Or(Parse.String("<")).Token(),
(property, value) => new Lt(property, value)
);
public static readonly Parser<Filter<T>> Le = _GetOperationParser(
Parse.IgnoreCase("le").Or(Parse.String("<=")).Token(),
(property, value) => new Le(property, value)
);
public static readonly Parser<Filter<T>> Has = _GetOperationParser(
Parse.IgnoreCase("has").Token(),
(property, value) => new Has(property, value),
(Type type) =>
{
if (typeof(IEnumerable).IsAssignableFrom(type) && type != typeof(string))
return _GetValueParser(
type.GetElementType() ?? type.GenericTypeArguments.First()
);
return ParseHelper.Error<object>("Can't use 'has' on a non-list.");
}
);
}
public static Filter<T>? From(string? filter)
{
if (filter == null)
return null;
try
{
IResult<Filter<T>> ret = FilterParsers.CompleteFilter.End().TryParse(filter);
if (ret.WasSuccessful)
return ret.Value;
throw new ValidationException(
$"Could not parse filter argument: {ret.Message}. Not parsed: {filter[ret.Remainder.Position..]}"
);
}
catch (ParseException ex)
{
throw new ValidationException($"Could not parse filter argument: {ex.Message}.");
}
}
}

View File

@@ -23,7 +23,6 @@ using System.Globalization;
using System.Linq;
using System.Linq.Expressions;
using System.Reflection;
using JetBrains.Annotations;
namespace Kyoo.Abstractions.Models.Utils
{
@@ -38,18 +37,18 @@ namespace Kyoo.Abstractions.Models.Utils
/// <summary>
/// The ID of the resource or null if the slug is specified.
/// </summary>
private readonly int? _id;
private readonly Guid? _id;
/// <summary>
/// The slug of the resource or null if the id is specified.
/// </summary>
private readonly string _slug;
private readonly string? _slug;
/// <summary>
/// Create a new <see cref="Identifier"/> for the given id.
/// </summary>
/// <param name="id">The id of the resource.</param>
public Identifier(int id)
public Identifier(Guid id)
{
_id = id;
}
@@ -58,10 +57,8 @@ namespace Kyoo.Abstractions.Models.Utils
/// Create a new <see cref="Identifier"/> for the given slug.
/// </summary>
/// <param name="slug">The slug of the resource.</param>
public Identifier([NotNull] string slug)
public Identifier(string slug)
{
if (slug == null)
throw new ArgumentNullException(nameof(slug));
_slug = slug;
}
@@ -83,11 +80,9 @@ namespace Kyoo.Abstractions.Models.Utils
/// );
/// </code>
/// </example>
public T Match<T>(Func<int, T> idFunc, Func<string, T> slugFunc)
public T Match<T>(Func<Guid, T> idFunc, Func<string, T> slugFunc)
{
return _id.HasValue
? idFunc(_id.Value)
: slugFunc(_slug);
return _id.HasValue ? idFunc(_id.Value) : slugFunc(_slug!);
}
/// <summary>
@@ -102,31 +97,47 @@ namespace Kyoo.Abstractions.Models.Utils
/// identifier.Matcher&lt;Season&gt;(x => x.ShowID, x => x.Show.Slug)
/// </code>
/// </example>
public Expression<Func<T, bool>> Matcher<T>(Expression<Func<T, int>> idGetter,
Expression<Func<T, string>> slugGetter)
public Filter<T> Matcher<T>(
Expression<Func<T, Guid>> idGetter,
Expression<Func<T, string>> slugGetter
)
{
ConstantExpression self = Expression.Constant(_id.HasValue ? _id.Value : _slug);
BinaryExpression equal = Expression.Equal(_id.HasValue ? idGetter.Body : slugGetter.Body, self);
ICollection<ParameterExpression> parameters = _id.HasValue ? idGetter.Parameters : slugGetter.Parameters;
return Expression.Lambda<Func<T, bool>>(equal, parameters);
BinaryExpression equal = Expression.Equal(
_id.HasValue ? idGetter.Body : slugGetter.Body,
self
);
ICollection<ParameterExpression> parameters = _id.HasValue
? idGetter.Parameters
: slugGetter.Parameters;
Expression<Func<T, bool>> lambda = Expression.Lambda<Func<T, bool>>(equal, parameters);
return new Filter<T>.Lambda(lambda);
}
/// <summary>
/// A matcher overload for nullable IDs. See
/// <see cref="Matcher{T}(System.Linq.Expressions.Expression{System.Func{T,int}},System.Linq.Expressions.Expression{System.Func{T,string}})"/>
/// <see cref="Matcher{T}(Expression{Func{T,Guid}},Expression{Func{T,string}})"/>
/// for more details.
/// </summary>
/// <param name="idGetter">An expression to retrieve an ID from the type <typeparamref name="T"/>.</param>
/// <param name="slugGetter">An expression to retrieve a slug from the type <typeparamref name="T"/>.</param>
/// <typeparam name="T">The type to match against this identifier.</typeparam>
/// <returns>An expression to match the type <typeparamref name="T"/> to this identifier.</returns>
public Expression<Func<T, bool>> Matcher<T>(Expression<Func<T, int?>> idGetter,
Expression<Func<T, string>> slugGetter)
public Filter<T> Matcher<T>(
Expression<Func<T, Guid?>> idGetter,
Expression<Func<T, string>> slugGetter
)
{
ConstantExpression self = Expression.Constant(_id.HasValue ? _id.Value : _slug);
BinaryExpression equal = Expression.Equal(_id.HasValue ? idGetter.Body : slugGetter.Body, self);
ICollection<ParameterExpression> parameters = _id.HasValue ? idGetter.Parameters : slugGetter.Parameters;
return Expression.Lambda<Func<T, bool>>(equal, parameters);
BinaryExpression equal = Expression.Equal(
_id.HasValue ? idGetter.Body : slugGetter.Body,
self
);
ICollection<ParameterExpression> parameters = _id.HasValue
? idGetter.Parameters
: slugGetter.Parameters;
Expression<Func<T, bool>> lambda = Expression.Lambda<Func<T, bool>>(equal, parameters);
return new Filter<T>.Lambda(lambda);
}
/// <summary>
@@ -138,25 +149,28 @@ namespace Kyoo.Abstractions.Models.Utils
/// </returns>
public bool IsSame(IResource resource)
{
return Match(
id => resource.ID == id,
slug => resource.Slug == slug
);
return Match(id => resource.Id == id, slug => resource.Slug == slug);
}
/// <summary>
/// Return an expression that return true if this <see cref="Identifier"/> match a given resource.
/// Return a filter to get this <see cref="Identifier"/> match a given resource.
/// </summary>
/// <typeparam name="T">The type of resource to match against.</typeparam>
/// <returns>
/// <c>true</c> if the given resource match this identifier, <c>false</c> otherwise.
/// </returns>
public Expression<Func<T, bool>> IsSame<T>()
public Filter<T> IsSame<T>()
where T : IResource
{
return _id.HasValue
? x => x.ID == _id.Value
: x => x.Slug == _slug;
? new Filter<T>.Eq("Id", _id.Value)
: new Filter<T>.Eq("Slug", _slug!);
}
private Expression<Func<T, bool>> _IsSameExpression<T>()
where T : IResource
{
return _id.HasValue ? x => x.Id == _id.Value : x => x.Slug == _slug;
}
/// <summary>
@@ -166,7 +180,7 @@ namespace Kyoo.Abstractions.Models.Utils
/// <typeparam name="T">The type that contain the list to check.</typeparam>
/// <typeparam name="T2">The type of resource to check this identifier against.</typeparam>
/// <returns>An expression to check if this <see cref="Identifier"/> is contained.</returns>
public Expression<Func<T, bool>> IsContainedIn<T, T2>(Expression<Func<T, IEnumerable<T2>>> listGetter)
public Filter<T> IsContainedIn<T, T2>(Expression<Func<T, IEnumerable<T2>?>> listGetter)
where T2 : IResource
{
MethodInfo method = typeof(Enumerable)
@@ -174,16 +188,23 @@ namespace Kyoo.Abstractions.Models.Utils
.Where(x => x.Name == nameof(Enumerable.Any))
.FirstOrDefault(x => x.GetParameters().Length == 2)!
.MakeGenericMethod(typeof(T2));
MethodCallExpression call = Expression.Call(null, method!, listGetter.Body, IsSame<T2>());
return Expression.Lambda<Func<T, bool>>(call, listGetter.Parameters);
MethodCallExpression call = Expression.Call(
null,
method,
listGetter.Body,
_IsSameExpression<T2>()
);
Expression<Func<T, bool>> lambda = Expression.Lambda<Func<T, bool>>(
call,
listGetter.Parameters
);
return new Filter<T>.Lambda(lambda);
}
/// <inheritdoc />
public override string ToString()
{
return _id.HasValue
? _id.Value.ToString()
: _slug;
return _id.HasValue ? _id.Value.ToString() : _slug!;
}
/// <summary>
@@ -192,7 +213,7 @@ namespace Kyoo.Abstractions.Models.Utils
public class IdentifierConvertor : TypeConverter
{
/// <inheritdoc />
public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
public override bool CanConvertFrom(ITypeDescriptorContext? context, Type sourceType)
{
if (sourceType == typeof(int) || sourceType == typeof(string))
return true;
@@ -200,15 +221,17 @@ namespace Kyoo.Abstractions.Models.Utils
}
/// <inheritdoc />
public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
public override object ConvertFrom(
ITypeDescriptorContext? context,
CultureInfo? culture,
object value
)
{
if (value is int id)
if (value is Guid id)
return new Identifier(id);
if (value is not string slug)
return base.ConvertFrom(context, culture, value);
return int.TryParse(slug, out id)
? new Identifier(id)
: new Identifier(slug);
return base.ConvertFrom(context, culture, value)!;
return Guid.TryParse(slug, out id) ? new Identifier(id) : new Identifier(slug);
}
}
}

View File

@@ -0,0 +1,112 @@
// Kyoo - A portable and vast media library solution.
// Copyright (c) Kyoo.
//
// See AUTHORS.md and LICENSE file in the project root for full license information.
//
// Kyoo is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// Kyoo 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Reflection;
using Kyoo.Abstractions.Models.Attributes;
namespace Kyoo.Abstractions.Models.Utils;
public class Include
{
/// <summary>
/// The aditional fields to include in the result.
/// </summary>
public ICollection<Metadata> Metadatas { get; set; } = ArraySegment<Metadata>.Empty;
public abstract record Metadata(string Name);
public record SingleRelation(string Name, Type type, string RelationIdName) : Metadata(Name);
public record CustomRelation(string Name, Type type, string Sql, string? On, Type Declaring)
: Metadata(Name);
public record ProjectedRelation(string Name, string Sql) : Metadata(Name);
}
/// <summary>
/// The aditional fields to include in the result.
/// </summary>
/// <typeparam name="T">The type related to the new fields</typeparam>
public class Include<T> : Include
{
/// <summary>
/// The aditional fields names to include in the result.
/// </summary>
public ICollection<string> Fields => Metadatas.Select(x => x.Name).ToList();
public Include() { }
public Include(params string[] fields)
{
Type[] types = typeof(T).GetCustomAttribute<OneOfAttribute>()?.Types ?? new[] { typeof(T) };
Metadatas = fields
.SelectMany(key =>
{
var relations = types
.Select(
x =>
x.GetProperty(
key,
BindingFlags.IgnoreCase
| BindingFlags.Public
| BindingFlags.Instance
)!
)
.Select(
prop => (prop, attr: prop?.GetCustomAttribute<LoadableRelationAttribute>()!)
)
.Where(x => x.prop != null && x.attr != null)
.ToList();
if (!relations.Any())
throw new ValidationException($"No loadable relation with the name {key}.");
return relations
.Select(x =>
{
(PropertyInfo prop, LoadableRelationAttribute attr) = x;
if (attr.RelationID != null)
return new SingleRelation(prop.Name, prop.PropertyType, attr.RelationID)
as Metadata;
if (attr.Sql != null)
return new CustomRelation(
prop.Name,
prop.PropertyType,
attr.Sql,
attr.On,
prop.DeclaringType!
);
if (attr.Projected != null)
return new ProjectedRelation(prop.Name, attr.Projected);
throw new NotImplementedException();
})
.Distinct();
})
.ToArray();
}
public static Include<T> From(string? fields)
{
if (string.IsNullOrEmpty(fields))
return new Include<T>();
return new Include<T>(fields.Split(','));
}
}

View File

@@ -16,38 +16,57 @@
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
namespace Kyoo.Abstractions.Controllers
{
/// <summary>
/// Information about the pagination. How many items should be displayed and where to start.
/// </summary>
public readonly struct Pagination
public class Pagination
{
/// <summary>
/// The count of items to return.
/// </summary>
public int Count { get; }
public int Limit { get; set; }
/// <summary>
/// Where to start? Using the given sort.
/// </summary>
public int? AfterID { get; }
public Guid? AfterID { get; set; }
/// <summary>
/// Should the previous page be returned instead of the next?
/// </summary>
public bool Reverse { get; set; }
/// <summary>
/// Create a new <see cref="Pagination"/> with default values.
/// </summary>
public Pagination()
{
Limit = 50;
AfterID = null;
Reverse = false;
}
/// <summary>
/// Create a new <see cref="Pagination"/> instance.
/// </summary>
/// <param name="count">Set the <see cref="Count"/> value</param>
/// <param name="count">Set the <see cref="Limit"/> value</param>
/// <param name="afterID">Set the <see cref="AfterID"/> value. If not specified, it will start from the start</param>
public Pagination(int count, int? afterID = null)
/// <param name="reverse">Should the previous page be returned instead of the next?</param>
public Pagination(int count, Guid? afterID = null, bool reverse = false)
{
Count = count;
Limit = count;
AfterID = afterID;
Reverse = reverse;
}
/// <summary>
/// Implicitly create a new pagination from a limit number.
/// </summary>
/// <param name="limit">Set the <see cref="Count"/> value</param>
/// <param name="limit">Set the <see cref="Limit"/> value</param>
/// <returns>A new <see cref="Pagination"/> instance</returns>
public static implicit operator Pagination(int limit) => new(limit);
}

View File

@@ -31,13 +31,13 @@ namespace Kyoo.Abstractions.Models.Utils
/// The list of errors that where made in the request.
/// </summary>
/// <example><c>["InvalidFilter: no field 'startYear' on a collection"]</c></example>
[NotNull] public string[] Errors { get; set; }
public string[] Errors { get; set; }
/// <summary>
/// Create a new <see cref="RequestError"/> with one error.
/// </summary>
/// <param name="error">The error to specify in the response.</param>
public RequestError([NotNull] string error)
public RequestError(string error)
{
if (error == null)
throw new ArgumentNullException(nameof(error));
@@ -48,10 +48,13 @@ namespace Kyoo.Abstractions.Models.Utils
/// Create a new <see cref="RequestError"/> with multiple errors.
/// </summary>
/// <param name="errors">The errors to specify in the response.</param>
public RequestError([NotNull] string[] errors)
public RequestError(string[] errors)
{
if (errors == null || !errors.Any())
throw new ArgumentException("Errors must be non null and not empty", nameof(errors));
throw new ArgumentException(
"Errors must be non null and not empty",
nameof(errors)
);
Errors = errors;
}
}

View File

@@ -16,21 +16,21 @@
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
namespace Kyoo.TheTvdb.Models
namespace Kyoo.Abstractions.Controllers
{
/// <summary>
/// The option containing the api key for the tvdb.
/// Information about the pagination. How many items should be displayed and where to start.
/// </summary>
public class TvdbOption
public class SearchPagination
{
/// <summary>
/// The path to get this option from the root configuration.
/// The count of items to return.
/// </summary>
public const string Path = "tvdb";
public int Limit { get; set; } = 50;
/// <summary>
/// The api key of the tvdb.
/// Where to start? How many items to skip?
/// </summary>
public string ApiKey { get; set; }
public int? Skip { get; set; }
}
}

View File

@@ -17,72 +17,120 @@
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
using System;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Linq.Expressions;
using System.Reflection;
using Kyoo.Abstractions.Models;
using Kyoo.Abstractions.Models.Attributes;
using Kyoo.Utils;
namespace Kyoo.Abstractions.Controllers
{
public record Sort;
/// <summary>
/// Information about how a query should be sorted. What factor should decide the sort and in which order.
/// </summary>
/// <typeparam name="T">For witch type this sort applies</typeparam>
public readonly struct Sort<T>
public record Sort<T> : Sort
where T : IQuery
{
/// <summary>
/// The sort key. This member will be used to sort the results.
/// Sort by a specific key
/// </summary>
public Expression<Func<T, object>> Key { get; }
/// <summary>
/// <param name="Key">The sort keys. This members will be used to sort the results.</param>
/// <param name="Desendant">
/// If this is set to true, items will be sorted in descend order else, they will be sorted in ascendant order.
/// </summary>
public bool Descendant { get; }
/// </param>
public record By(string Key, bool Desendant = false) : Sort<T>
{
/// <summary>
/// Sort by a specific key
/// </summary>
/// <param name="key">The sort keys. This members will be used to sort the results.</param>
/// <param name="desendant">
/// If this is set to true, items will be sorted in descend order else, they will be sorted in ascendant order.
/// </param>
public By(Expression<Func<T, object?>> key, bool desendant = false)
: this(Utility.GetPropertyName(key), desendant) { }
}
/// <summary>
/// Create a new <see cref="Sort{T}"/> instance.
/// Sort by multiple keys.
/// </summary>
/// <param name="key">The sort key given. It is assigned to <see cref="Key"/>.</param>
/// <param name="descendant">Should this be in descendant order? The default is false.</param>
/// <exception cref="ArgumentException">If the given key is not a member.</exception>
public Sort(Expression<Func<T, object>> key, bool descendant = false)
{
Key = key;
Descendant = descendant;
/// <param name="List">The list of keys to sort by.</param>
public record Conglomerate(params Sort<T>[] List) : Sort<T>;
if (!Utility.IsPropertyExpression(Key))
throw new ArgumentException("The given sort key is not valid.");
/// <summary>Sort randomly items</summary>
public record Random(uint Seed) : Sort<T>
{
public Random()
: this(0)
{
uint seed = BitConverter.ToUInt32(
BitConverter.GetBytes(new System.Random().Next(int.MinValue, int.MaxValue)),
0
);
Seed = seed;
}
}
/// <summary>The default sort method for the given type.</summary>
public record Default : Sort<T>
{
public void Deconstruct(out Sort<T> value)
{
value = (Sort<T>)T.DefaultSort;
}
}
/// <summary>
/// Create a new <see cref="Sort{T}"/> instance from a key's name (case insensitive).
/// </summary>
/// <param name="sortBy">A key name with an optional order specifier. Format: "key:asc", "key:desc" or "key".</param>
/// <param name="seed">The random seed.</param>
/// <exception cref="ArgumentException">An invalid key or sort specifier as been given.</exception>
public Sort(string sortBy)
/// <returns>A <see cref="Sort{T}"/> for the given string</returns>
public static Sort<T> From(string? sortBy, uint seed)
{
if (string.IsNullOrEmpty(sortBy))
{
Key = null;
Descendant = false;
return;
}
if (string.IsNullOrEmpty(sortBy) || sortBy == "default")
return new Default();
if (sortBy == "random")
return new Random(seed);
if (sortBy.Contains(','))
return new Conglomerate(sortBy.Split(',').Select(x => From(x, seed)).ToArray());
if (sortBy.StartsWith("random:"))
return new Random(uint.Parse(sortBy["random:".Length..]));
string key = sortBy.Contains(':') ? sortBy[..sortBy.IndexOf(':')] : sortBy;
string order = sortBy.Contains(':') ? sortBy[(sortBy.IndexOf(':') + 1)..] : null;
ParameterExpression param = Expression.Parameter(typeof(T), "x");
MemberExpression property = Expression.Property(param, key);
Key = property.Type.IsValueType
? Expression.Lambda<Func<T, object>>(Expression.Convert(property, typeof(object)), param)
: Expression.Lambda<Func<T, object>>(property, param);
Descendant = order switch
string? order = sortBy.Contains(':') ? sortBy[(sortBy.IndexOf(':') + 1)..] : null;
bool desendant = order switch
{
"desc" => true,
"asc" => false,
null => false,
_ => throw new ArgumentException($"The sort order, if set, should be :asc or :desc but it was :{order}.")
_
=> throw new ValidationException(
$"The sort order, if set, should be :asc or :desc but it was :{order}."
)
};
Type[] types =
typeof(T).GetCustomAttribute<OneOfAttribute>()?.Types ?? new[] { typeof(T) };
PropertyInfo? property = types
.Select(
x =>
x.GetProperty(
key,
BindingFlags.IgnoreCase | BindingFlags.Public | BindingFlags.Instance
)
)
.FirstOrDefault(x => x != null);
if (property == null)
throw new ValidationException("The given sort key is not valid.");
return new By(property.Name, desendant);
}
}
}

View File

@@ -16,21 +16,21 @@
// You should have received a copy of the GNU General Public License
// along with Kyoo. If not, see <https://www.gnu.org/licenses/>.
namespace Kyoo.TheMovieDb.Models
namespace Kyoo.Abstractions.Models
{
/// <summary>
/// The option containing the api key for TheMovieDb.
/// The links to see a movie or an episode.
/// </summary>
public class TheMovieDbOptions
public class VideoLinks
{
/// <summary>
/// The path to get this option from the root configuration.
/// The direct link to the unprocessed video (pristine quality).
/// </summary>
public const string Path = "themoviedb";
public string Direct { get; set; }
/// <summary>
/// The api key of TheMovieDb.
/// The link to an HLS master playlist containing all qualities available for this video.
/// </summary>
public string ApiKey { get; set; }
public string Hls { get; set; }
}
}

Some files were not shown because too many files have changed in this diff Show More