Struct Service 

pub struct Service {
    pub(crate) db: Data,
    services: Arc<OnceServices>,
    url_preview_mutex: MutexMap<String, ()>,
    federation_mutex: MutexMap<String, ()>,
    mxc_state: MXCState,
}

Fields

db: Data

services: Arc<OnceServices>

url_preview_mutex: MutexMap<String, ()>

federation_mutex: MutexMap<String, ()>

mxc_state: MXCState

Implementations

impl Service

pub fn create_blurhash( &self, file: &[u8], content_type: Option<&str>, file_name: Option<&str>, ) -> Result<Option<String>>

impl Service

pub fn remove_url_preview(&self, url: &str) -> Result

impl Service

pub fn set_url_preview(&self, url: &str, data: &UrlPreviewData) -> Result

impl Service

pub async fn get_url_preview(&self, url: &Url) -> Result<UrlPreviewData>

impl Service

async fn request_url_preview(&self, url: &Url) -> Result<UrlPreviewData>

impl Service

pub async fn download_image(&self, response: Response) -> Result<UrlPreviewData>

impl Service

async fn download_html( &self, url: &Url, response: Response, ) -> Result<UrlPreviewData>

impl Service

pub fn url_preview_allowed(&self, url: &Url) -> bool

impl Service

pub async fn fetch_remote_thumbnail( &self, mxc: &Mxc<'_>, server: Option<&ServerName>, timeout_ms: Duration, dim: &Dim, ) -> Result<Media>

impl Service

pub async fn fetch_remote_content( &self, mxc: &Mxc<'_>, server: Option<&ServerName>, timeout_ms: Duration, ) -> Result<Media>

impl Service

async fn fetch_thumbnail_authenticated( &self, mxc: &Mxc<'_>, server: Option<&ServerName>, timeout_ms: Duration, dim: &Dim, ) -> Result<Media>

impl Service

async fn fetch_content_authenticated( &self, mxc: &Mxc<'_>, server: Option<&ServerName>, timeout_ms: Duration, ) -> Result<Media>

impl Service

async fn fetch_thumbnail_unauthenticated( &self, mxc: &Mxc<'_>, server: Option<&ServerName>, timeout_ms: Duration, dim: &Dim, ) -> Result<Media>

impl Service

async fn fetch_content_unauthenticated( &self, mxc: &Mxc<'_>, server: Option<&ServerName>, timeout_ms: Duration, ) -> Result<Media>

impl Service

async fn handle_thumbnail_file( &self, mxc: &Mxc<'_>, dim: &Dim, content: Content, ) -> Result<Media>

impl Service

async fn handle_content_file( &self, mxc: &Mxc<'_>, content: Content, ) -> Result<Media>

impl Service

async fn handle_location(&self, mxc: &Mxc<'_>, location: &str) -> Result<Media>

impl Service

async fn location_request(&self, location: &str) -> Result<Media>

impl Service

async fn federation_request<Request>( &self, mxc: &Mxc<'_>, server: Option<&ServerName>, request: Request, ) -> Result<Request::IncomingResponse>

where Request: OutgoingRequest + Send + Debug, Request::Authentication: FedAuth, Request::PathBuilder: FedPath,

impl Service

pub async fn fetch_remote_thumbnail_legacy( &self, body: &Request, ) -> Result<Response>

impl Service

pub async fn fetch_remote_content_legacy( &self, mxc: &Mxc<'_>, allow_redirect: bool, timeout_ms: Duration, ) -> Result<Response, Error>

impl Service

fn check_fetch_authorized(&self, mxc: &Mxc<'_>) -> Result

impl Service

fn check_legacy_freeze(&self) -> Result

impl Service

pub async fn upload_thumbnail( &self, mxc: &Mxc<'_>, content_disposition: Option<&ContentDisposition>, content_type: Option<&str>, dim: &Dim, file: &[u8], ) -> Result

Uploads or replaces a file thumbnail.

pub async fn get_or_fetch_thumbnail( &self, mxc: &Mxc<'_>, dim: &Dim, timeout_ms: Duration, user: &UserId, ) -> Result<Media>

pub async fn get_thumbnail( &self, mxc: &Mxc<'_>, dim: &Dim, timeout_duration: Option<Duration>, ) -> Result<Media>

Download a thumbnail and wait up to a timeout_ms if it is pending.

pub async fn get_stored_thumbnail( &self, mxc: &Mxc<'_>, dim: &Dim, ) -> Result<Media>

Downloads a file’s thumbnail.

Here’s an example on how it works:

• Client requests an image with width=567, height=567
• Server rounds that up to (800, 600), so it doesn’t have to save too many thumbnails
• Server rounds that up again to (958, 600) to fix the aspect ratio (only for width,height>96)
• Server creates the thumbnail and sends it to the user

For width,height <= 96 the server uses another thumbnailing algorithm which crops the image afterwards.

impl Service

async fn get_thumbnail_saved(&self, data: Metadata) -> Result<Media>

Using saved thumbnail

impl Service

async fn get_thumbnail_generate( &self, mxc: &Mxc<'_>, dim: &Dim, data: Metadata, ) -> Result<Media>

Generate a thumbnail

impl Service

pub async fn create_pending( &self, mxc: &Mxc<'_>, user: &UserId, unused_expires_at: u64, ) -> Result

Create a pending media upload ID.

pub async fn upload_pending( &self, mxc: &Mxc<'_>, user: &UserId, content_disposition: Option<&ContentDisposition>, content_type: Option<&str>, file: &[u8], ) -> Result

Uploads content to a pending media ID.

pub async fn create( &self, mxc: &Mxc<'_>, user: Option<&UserId>, content_disposition: Option<&ContentDisposition>, content_type: Option<&str>, file: &[u8], ) -> Result

Uploads a file.

pub async fn delete(&self, mxc: &Mxc<'_>) -> Result

Deletes a file in the database and from the media directory via an MXC

pub async fn delete_from_user(&self, user: &UserId) -> Result<usize>

Deletes all media by the specified user

currently, this is only practical for local users

pub async fn get_or_fetch( &self, mxc: &Mxc<'_>, timeout_ms: Duration, ) -> Result<Media>

Get file from local storage or make a federation request if it originates remotely.

pub async fn get( &self, mxc: &Mxc<'_>, timeout: Option<Duration>, ) -> Result<Media>

Get file from local storage while waiting up to a timeout_ms if it is pending.

pub async fn get_stored(&self, mxc: &Mxc<'_>) -> Result<Media>

Get file from local storage.

pub async fn get_all_mxcs(&self) -> Result<Vec<OwnedMxcUri>>

Gets all the MXC URIs in our media database

pub async fn delete_range( &self, time: SystemTime, older_than: bool, newer_than: bool, yes_i_want_to_delete_local_media: bool, ) -> Result<usize>

Deletes all media files before or after the given time. Returns a usize with the number of media files deleted.

pub async fn create_media_dir(&self) -> Result

async fn remove_media_file(&self, key: &[u8]) -> Result

async fn create_media_file(&self, key: &[u8], file: &[u8]) -> Result

fn storage_providers(&self) -> impl Iterator<Item = &Arc<Provider>> + Send + '_

pub async fn get_metadata(&self, mxc: &Mxc<'_>) -> Option<Metadata>

pub fn get_media_path_sha256(&self, key: &[u8]) -> PathBuf

pub fn get_media_name_sha256(&self, key: &[u8]) -> String

new SHA256 file name media function. requires database migrated. uses SHA256 hash of the base64 key as the file name

pub fn get_media_path_b64(&self, key: &[u8]) -> PathBuf

old base64 file name media function This is the old version of get_media_path_sha256 that uses the full base64 key as the filename.

pub fn get_media_dir(&self) -> PathBuf

Trait Implementations

impl Service for Service

fn build(args: &Args<'_>) -> Result<Arc<Self>>

Implement the construction of the service instance. Services are generally singletons so expect this to only be called once for a service type. Note that it may be called again after a server reload, but the prior instance will have been dropped first. Failure will shutdown the server with an error.

fn name(&self) -> &str

Return the name of the service. i.e. crate::service::make_name(std::module_path!())

fn worker<'async_trait>( self: Arc<Self>, ) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>>

where Self: 'async_trait,

Implement the service’s worker loop. The service manager spawns a task and calls this function after all services have been built.

fn interrupt<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Interrupt the service. This is sent to initiate a graceful shutdown. The service worker should return from its work loop.

fn clear_cache<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Clear any caches or similar runtime state.

fn memory_usage<'life0, 'life1, 'async_trait>( &'life0 self, _out: &'life1 mut (dyn Write + Send), ) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Memory usage report in a markdown string.

fn unconstrained(&self) -> bool

Return true if the service worker opts out of the tokio cooperative budgeting. This can reduce tail latency at the risk of event loop starvation.