Files
Vocaluxe/VocaluxeWeb/Api/SongsController.cs
McSchneidarandFlorian Ostertag 336d08040e New Webserver and WebApp (#942)
* Replace the WCF webserver with an ASP.NET Core webserver (VocaluxeWeb)

- New project VocaluxeWeb: ASP.NET Core 2.3 (Kestrel) on .NET Framework 4.8.1, HTTP or HTTPS
  with a self-signed certificate, REST API (/api/v1) with Swagger, live events (Server-Sent Events)
- Access to the game only through IVocaluxeRemote; requests run on the main thread once per frame
- Sessions with roles (guest, player, admin) and configurable permissions, PINs hashed with PBKDF2
- Queue as a playlist with requesters and singers, fair order (one song per person and round)
- Admin: settings, server status, logged-in devices, activate/deactivate and delete profiles
- Profile pictures: own photo or one of the Vocaluxe avatars
- Game: WebApp queue screen (song options, playlist group) to start the next song with the chosen
  singers, return to it after singing, warning when the webserver is off, remote keyboard
- Old WCF server, WebserverInitalConfig and URL reservations removed; libraries moved to libs/managed
- Unit tests for PIN hashing, settings and permissions, queue order and device names
- AppVeyor: Visual Studio 2022 image and Node.js 24 (the build compiles the WebApp)
- Documentation in VocaluxeWeb/README.md

* New WebApp (Vue 3, TypeScript, Vite) replacing the old jQuery Mobile website

- Login with profile and PIN, create profiles
- Songs with search, filters, sorting and 30 second previews
- Queue: add songs with game mode, audio and singers, edit, reorder, start in the game
- Playlists: create, edit, add to the queue
- Now playing with live updates, remote control and keyboard
- Players: own profile with picture (photo or Vocaluxe avatar), roles for admins
- Admin settings: permissions, server status, devices, profiles
- Help page, responsive layout for phones, tablets and desktops, light and dark mode
- Texts in WebApp/src/locales/en.json, translated with Transifex
- Old website and PhoneGap config removed

---------

Co-authored-by: Florian Ostertag <flokuep@users.noreply.github.com>
2026-10-26 05:40:11 +01:00

131 lines
4.5 KiB
C#

#region license
// This file is part of Vocaluxe.
//
// Vocaluxe 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
// (at your option) any later version.
//
// Vocaluxe 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 Vocaluxe. If not, see <http://www.gnu.org/licenses/>.
#endregion
using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using VocaluxeWeb.Contracts;
using VocaluxeWeb.Services;
namespace VocaluxeWeb.Api
{
[Route("api/v1/songs")]
[RequireSession]
public sealed class SongsController : ApiControllerBase
{
private readonly CSongLibrary _Songs;
private readonly CImageService _Images;
public SongsController(CSongLibrary songs, CImageService images)
{
_Songs = songs;
_Images = images;
}
/// Searches the song library. All words of the query must appear in artist, title or edition.
[HttpGet]
public async Task<ActionResult<SongPageDto>> Search([FromQuery] SongSearchDto request)
{
return await _Songs.SearchAsync(new CSongQuery
{
Text = request.Query,
Language = request.Language,
Genre = request.Genre,
Decade = request.Decade,
Duet = request.Duet,
Sort = request.Sort,
Page = request.Page,
PageSize = request.PageSize
});
}
/// Available languages, genres and decades with the number of songs, for filters.
[HttpGet("facets")]
public async Task<ActionResult<SongFacetsDto>> GetFacets()
{
return await _Songs.GetFacetsAsync();
}
[HttpGet("{id}")]
public async Task<ActionResult<SongDto>> Get(int id)
{
var song = await _Songs.GetAsync(id);
if (song == null)
{
return Problem(StatusCodes.Status404NotFound, "Song not found.");
}
return CSongLibrary.ToDto(song);
}
/// The audio file of the song, for previews. Supports range requests, so the browser can jump to the preview start.
[HttpGet("{id}/audio")]
[Produces("audio/mpeg", "audio/ogg", "audio/mp4", "audio/wav", "audio/flac")]
[ProducesResponseType(typeof(FileResult), StatusCodes.Status200OK)]
public async Task<IActionResult> GetAudio(int id)
{
var song = await _Songs.GetAsync(id);
if (string.IsNullOrEmpty(song?.AudioPath) || !System.IO.File.Exists(song.AudioPath))
{
return NotFound();
}
Response.Headers["Cache-Control"] = "private, max-age=3600";
return PhysicalFile(song.AudioPath, _GetAudioType(song.AudioPath), true);
}
private static string _GetAudioType(string path)
{
switch (System.IO.Path.GetExtension(path).ToLowerInvariant())
{
case ".ogg":
case ".oga":
case ".opus":
return "audio/ogg";
case ".m4a":
case ".mp4":
case ".aac":
return "audio/mp4";
case ".wav":
return "audio/wav";
case ".flac":
return "audio/flac";
case ".webm":
return "audio/webm";
default:
return "audio/mpeg";
}
}
/// The cover as JPEG, scaled to fit the given size (96, 200 or 400).
[HttpGet("{id}/cover")]
[Produces("image/jpeg")]
[ProducesResponseType(typeof(FileResult), StatusCodes.Status200OK)]
public async Task<IActionResult> GetCover(int id, [FromQuery] int size = 200)
{
var song = await _Songs.GetAsync(id);
var file = _Images.GetScaled(song?.CoverPath, size, out var etag);
if (file == null)
{
return NotFound();
}
return CImageResult.Create(this, file, etag);
}
}
}