Class MediaService

The media repository: local uploads, and media of other servers fetched once through federation; files under the media directory, rows in the database.

Inheritance
object
MediaService
Inherited Members
Namespace: Uniform.Matrix.Server.Media
Assembly: Uniform.Matrix.Server.dll
Syntax
public sealed class MediaService
Remarks

Files are stored at media/ab/cd/abcd… by media ID, thumbnails at media/thumbnails/abcd…/WxH-method; media of other servers under an ID of this server, see RemoteMediaRow. Thumbnails of remote media are made here from the whole file.

Constructors

| Edit this page View Source

MediaService(IDbContextFactory<ServerDbContext>, IOptions<ServerOptions>, IOptionsMonitor<MediaOptions>, IOptions<ServerStorageOptions>, IHostEnvironment, TimeProvider, FederationClient, ILogger<MediaService>)

Create the service over the media directory under the data directory.

Declaration
public MediaService(IDbContextFactory<ServerDbContext> contexts, IOptions<ServerOptions> server, IOptionsMonitor<MediaOptions> media, IOptions<ServerStorageOptions> storage, IHostEnvironment environment, TimeProvider time, FederationClient federation, ILogger<MediaService> logger)
Parameters
Type Name Description
IDbContextFactory<ServerDbContext> contexts
IOptions<ServerOptions> server
IOptionsMonitor<MediaOptions> media
IOptions<ServerStorageOptions> storage
IHostEnvironment environment
TimeProvider time
FederationClient federation
ILogger<MediaService> logger

Properties

| Edit this page View Source

AllowUnauthenticatedDownloads

Whether the deprecated unauthenticated downloads are served, see AllowUnauthenticatedDownloads.

Declaration
public bool AllowUnauthenticatedDownloads { get; }
Property Value
Type Description
bool
| Edit this page View Source

MaxUploadSize

Largest upload in bytes.

Declaration
public long MaxUploadSize { get; }
Property Value
Type Description
long

Methods

| Edit this page View Source

CreatePendingAsync(string, CancellationToken)

Reserve an mxc:// URI for content userId uploads later with UploadPendingAsync(string, string, string, Stream, string, string?, CancellationToken); return it and when it expires, in milliseconds since 1970. Throws M_LIMIT_EXCEEDED past MaxPendingUploads.

Declaration
public Task<(string ContentUri, long ExpiresAt)> CreatePendingAsync(string userId, CancellationToken cancellationToken)
Parameters
Type Name Description
string userId
CancellationToken cancellationToken
Returns
Type Description
Task<(string ContentUri, long ExpiresAt)>
Remarks

A pending row has an empty content type until its content arrives.

| Edit this page View Source

DeleteLocalAsync(string, CancellationToken)

Delete local media: its file, thumbnails and row; return false when there is no such media.

Declaration
public Task<bool> DeleteLocalAsync(string mediaId, CancellationToken cancellationToken)
Parameters
Type Name Description
string mediaId
CancellationToken cancellationToken
Returns
Type Description
Task<bool>
| Edit this page View Source

GetAsync(string, string, TimeSpan, CancellationToken)

Return a stored file, fetching media of other servers first; throw M_NOT_FOUND for unknown media. Local media whose content is not uploaded yet is waited for up to timeout, then throws M_NOT_YET_UPLOADED.

Declaration
public Task<MediaService.StoredFile> GetAsync(string serverName, string mediaId, TimeSpan timeout, CancellationToken cancellationToken)
Parameters
Type Name Description
string serverName
string mediaId
TimeSpan timeout
CancellationToken cancellationToken
Returns
Type Description
Task<MediaService.StoredFile>
| Edit this page View Source

GetLocalAsync(string, TimeSpan, CancellationToken)

Return a local file for another server, as /_matrix/federation/v1/media/download serves it; throw M_NOT_FOUND for unknown media. Media of other servers is not passed on.

Declaration
public Task<MediaService.StoredFile> GetLocalAsync(string mediaId, TimeSpan timeout, CancellationToken cancellationToken)
Parameters
Type Name Description
string mediaId
TimeSpan timeout
CancellationToken cancellationToken
Returns
Type Description
Task<MediaService.StoredFile>
| Edit this page View Source

GetThumbnailAsync(string, string, int, int, string, TimeSpan, CancellationToken)

Return a thumbnail, making it on first request; throw M_UNKNOWN (400) when the media is not an image that can be thumbnailed.

Declaration
public Task<MediaService.StoredFile> GetThumbnailAsync(string serverName, string mediaId, int width, int height, string method, TimeSpan timeout, CancellationToken cancellationToken)
Parameters
Type Name Description
string serverName
string mediaId
int width
int height
string method
TimeSpan timeout
CancellationToken cancellationToken
Returns
Type Description
Task<MediaService.StoredFile>
| Edit this page View Source

GetUploadsAsync(string, CancellationToken)

Return the local media uploaded by userId, newest first.

Declaration
public Task<IReadOnlyList<MediaRow>> GetUploadsAsync(string userId, CancellationToken cancellationToken)
Parameters
Type Name Description
string userId
CancellationToken cancellationToken
Returns
Type Description
Task<IReadOnlyList<MediaRow>>
| Edit this page View Source

IsLocal(string)

Return whether serverName is this server, whose media is local.

Declaration
public bool IsLocal(string serverName)
Parameters
Type Name Description
string serverName
Returns
Type Description
bool
| Edit this page View Source

UploadAsync(string, Stream, string, string?, CancellationToken)

Store an upload of userId; return its mxc:// URI. Throws M_TOO_LARGE past MaxUploadSize.

Declaration
public Task<string> UploadAsync(string userId, Stream content, string contentType, string? fileName, CancellationToken cancellationToken)
Parameters
Type Name Description
string userId
Stream content
string contentType
string fileName
CancellationToken cancellationToken
Returns
Type Description
Task<string>
| Edit this page View Source

UploadPendingAsync(string, string, string, Stream, string, string?, CancellationToken)

Upload the content of media created with CreatePendingAsync(string, CancellationToken): only by its creator, once, and before it expires.

Declaration
public Task UploadPendingAsync(string userId, string serverName, string mediaId, Stream content, string contentType, string? fileName, CancellationToken cancellationToken)
Parameters
Type Name Description
string userId
string serverName
string mediaId
Stream content
string contentType
string fileName
CancellationToken cancellationToken
Returns
Type Description
Task