mirror of
https://github.com/lrnselfreliance/wrolpi.git
synced 2026-11-19 22:46:20 -05:00
Video page: Edit > Edit to change a video's title
PUT /api/videos/<file_group_id> writes the title (and fulltitle) into the Video's info json, creating the file when the video has none, then validates the Video again so its title and search text follow. Files stay the source of truth: the edit survives a refresh, and a re-download of the metadata replaces it (the modal says so). Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This commit is contained in:
parent
712d89c424
commit
cc25e342d4
8 changed files with 282 additions and 6 deletions
|
|
@ -186,6 +186,11 @@ class VideoSearchRequest:
|
|||
deep: bool = False # When True, search all text including captions (d_text)
|
||||
|
||||
|
||||
@dataclass
|
||||
class VideoUpdateRequest:
|
||||
title: str
|
||||
|
||||
|
||||
@dataclass
|
||||
class VideoTranscodeRequest:
|
||||
video_codec: Optional[str] = None # A key of TRANSCODE_VIDEO_TARGETS, or None to copy the stream.
|
||||
|
|
|
|||
77
modules/videos/test/test_video_edit.py
Normal file
77
modules/videos/test/test_video_edit.py
Normal file
|
|
@ -0,0 +1,77 @@
|
|||
"""Editing a Video's details from the video page."""
|
||||
import json
|
||||
|
||||
import pytest
|
||||
|
||||
from modules.videos.models import Video
|
||||
from modules.videos.video.lib import update_video
|
||||
from wrolpi.errors import ValidationError
|
||||
|
||||
|
||||
def test_update_video_title(test_session, test_directory, video_factory):
|
||||
"""The new title is written to the info json (title and fulltitle) and the Video re-validated,
|
||||
so its title and search text change too. Other info json keys are kept."""
|
||||
video = video_factory(with_info_json={'title': 'Old Title', 'fulltitle': 'Old Title', 'duration': 7,
|
||||
'formats': ['kept, not cleaned']})
|
||||
test_session.commit()
|
||||
assert video.file_group.title == 'Old Title'
|
||||
|
||||
update_video(video.file_group_id, ' New Title ')
|
||||
|
||||
test_session.expire_all()
|
||||
video = Video.find_by_file_group_id(test_session, video.file_group_id)
|
||||
assert video.file_group.title == 'New Title'
|
||||
assert video.file_group.a_text == 'New Title'
|
||||
assert video.file_group.length == 7, 'Other details from the info json are unchanged'
|
||||
info_json = json.loads(video.info_json_path.read_text())
|
||||
assert info_json['title'] == 'New Title' and info_json['fulltitle'] == 'New Title'
|
||||
assert info_json['formats'] == ['kept, not cleaned']
|
||||
|
||||
|
||||
def test_update_video_title_creates_info_json(test_session, test_directory, video_factory):
|
||||
"""A Video without an info json gets one holding the title."""
|
||||
video = video_factory()
|
||||
test_session.commit()
|
||||
assert video.info_json_path is None
|
||||
|
||||
update_video(video.file_group_id, 'Brand New')
|
||||
|
||||
test_session.expire_all()
|
||||
video = Video.find_by_file_group_id(test_session, video.file_group_id)
|
||||
assert video.file_group.title == 'Brand New'
|
||||
assert video.info_json_path and video.info_json_path.is_file()
|
||||
assert json.loads(video.info_json_path.read_text())['title'] == 'Brand New'
|
||||
assert video.info_json_path.name in [i['path'] for i in video.file_group.files], 'The new file is tracked'
|
||||
|
||||
|
||||
def test_update_video_title_empty(test_session, video_factory):
|
||||
video = video_factory(with_info_json={'title': 'Old'})
|
||||
test_session.commit()
|
||||
with pytest.raises(ValidationError):
|
||||
update_video(video.file_group_id, ' ')
|
||||
test_session.expire_all()
|
||||
assert Video.find_by_file_group_id(test_session, video.file_group_id).file_group.title == 'Old'
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_video_update_api(async_client, test_session, video_factory, wrol_mode_fixture):
|
||||
video = video_factory(with_info_json={'title': 'Old'})
|
||||
test_session.commit()
|
||||
|
||||
request, response = await async_client.put(f'/api/videos/{video.file_group_id}',
|
||||
content=json.dumps({'title': 'Edited'}))
|
||||
assert response.status == 200, response.json
|
||||
assert response.json['file_group']['title'] == 'Edited'
|
||||
assert response.json['file_group']['id'] == video.file_group_id
|
||||
|
||||
request, response = await async_client.put(f'/api/videos/{video.file_group_id}', content=json.dumps({'title': ''}))
|
||||
assert response.status == 400
|
||||
|
||||
request, response = await async_client.put('/api/videos/999999', content=json.dumps({'title': 'x'}))
|
||||
assert response.status == 404
|
||||
|
||||
await wrol_mode_fixture(True)
|
||||
request, response = await async_client.put(f'/api/videos/{video.file_group_id}',
|
||||
content=json.dumps({'title': 'Nope'}))
|
||||
assert response.status == 403
|
||||
await wrol_mode_fixture(False)
|
||||
|
|
@ -29,6 +29,20 @@ def video_get(request: Request, file_group_id: int):
|
|||
return json_response({'file_group': video, 'prev': previous_video, 'next': next_video})
|
||||
|
||||
|
||||
@video_bp.put('/<file_group_id:int>')
|
||||
@openapi.description('Edit a Video\'s details. Written to its info json; the Video is validated again.')
|
||||
@openapi.body({'application/json': schema.VideoUpdateRequest})
|
||||
@openapi.response(HTTPStatus.OK, schema.VideoResponse)
|
||||
@openapi.response(HTTPStatus.BAD_REQUEST, JSONErrorResponse)
|
||||
@openapi.response(HTTPStatus.NOT_FOUND, JSONErrorResponse)
|
||||
@validate(schema.VideoUpdateRequest)
|
||||
@wrol_mode_check
|
||||
async def video_update(_: Request, file_group_id: int, body: schema.VideoUpdateRequest):
|
||||
lib.update_video(file_group_id, body.title)
|
||||
video, previous_video, next_video = lib.get_video_for_app(file_group_id)
|
||||
return json_response({'file_group': video, 'prev': previous_video, 'next': next_video})
|
||||
|
||||
|
||||
@video_bp.get('/<file_group_id:int>/comments')
|
||||
@openapi.description('Get Video comments')
|
||||
@openapi.response(HTTPStatus.OK, schema.VideoCommentsResponse)
|
||||
|
|
|
|||
|
|
@ -50,6 +50,35 @@ def get_video(file_group_id: int) -> Video:
|
|||
return video
|
||||
|
||||
|
||||
def update_video(file_group_id: int, title: str) -> Video:
|
||||
"""Edit a Video's details. The files are the source of truth, so the change is written to the
|
||||
Video's .info.json (created if missing) and the Video is validated again from it.
|
||||
|
||||
A later re-download of the Video's metadata will overwrite the info json, and this edit with
|
||||
it.
|
||||
|
||||
@raise UnknownVideo: if the Video can not be found
|
||||
@raise ValidationError: when the title is empty
|
||||
"""
|
||||
from wrolpi.errors import ValidationError
|
||||
title = (title or '').strip()
|
||||
if not title:
|
||||
raise ValidationError('Video title cannot be empty')
|
||||
|
||||
with get_db_session(commit=True) as session:
|
||||
video = Video.find_by_file_group_id(session, file_group_id)
|
||||
info_json = video.get_info_json() or dict()
|
||||
# `extract_video_info_json` prefers fulltitle over title; keep the two in agreement.
|
||||
info_json['title'] = title
|
||||
info_json['fulltitle'] = title
|
||||
# Keep the file as it was, other than the title.
|
||||
video.replace_info_json(info_json, clean=False)
|
||||
# Re-derive the title (and search text) from the file just written.
|
||||
video.validate(session)
|
||||
video.flush()
|
||||
return video
|
||||
|
||||
|
||||
VIDEO_ORDERS = {
|
||||
# fg.id (the rowid) is the pagination tiebreaker: it is present in every index, so these
|
||||
# orders stay index-only. LOWER(fg.primary_path) forced SQLite to read every (large) row.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue