CloudCord Setup

CloudCord is a project that provides a set of APIs for managing files. It allows you to upload, download, and delete files. It also supports chunked file upload.

Patch Notes

Current Problems:

too many requests without caching get ratelimited by discord

every CCU loads the file from dc (if multiple people are reading the same file they will all use the full bandwidth they provide)

Speeds

Well, depend on your Internet speeds

Setup Instructions

Prerequisites

.NET 8.0 or higher
IDE that supports .NET development

Clone the Repository

First, clone the repository to your local machine using the following command:

git clone https://github.com/SymoHTL/CloudCord.git

Configure `appsettings.json`

Navigate to the CloudCord directory and open the appsettings.json file. This file contains various configuration options for the application.

Here is a brief explanation of each configuration option:

Logging: This section is used to configure the logging level.
AllowedHosts: This option is used to specify which hosts are allowed to connect to the application.
ConnectionStrings: This section is used to configure the database connection string.
KeyPath: Path to the DataProtection Keys of this app, if run in a docker environment they must be stored in a persistent volume.
Tokens: List of DiscordBot tokens which are used to upload/download your files, using multiple bots can prevent ratelimiting if you have heavy usage.
GuildId: Id of your Discord server, (Settings -> Advanced -> Developer Mode -> rightclick on your server -> Copy Server ID).
ChannelId: Channel where your files will be stored.

Please replace the placeholders with your actual data.

Setup discord bot: https://discordpy.readthedocs.io/en/stable/discord.html

recommended => botamount = CCU (if multiple user read different files the bot's will get ratelimited)

You need to enable the Message Content Intent

Build and Run the Project

Open the project in your IDE. Build and run the project.

CloudCord

CloudCord is a project that provides a set of APIs for managing files. It allows you to upload, download, and delete files. It also supports chunked file upload.

How to Use

Upload a File

To upload a file, make a POST request to the /api/files endpoint. The file to be uploaded should be included in the request body as form data.

curl -X POST -H "Content-Type: multipart/form-data" -F "file=@path_to_your_file" http://localhost:5000/api/files

Upload a File in Chunks

To upload a file in chunks, make a POST request to the /api/files/chunked endpoint. The chunk of the file to be uploaded should be included in the request body as form data. You also need to provide the start byte of the chunk.

curl -X POST -H "Content-Type: multipart/form-data" -F "file=@path_to_your_chunk" -F "startByte=0" http://localhost:5000/api/files/chunked

Download a File

To download a file, make a GET request to the /api/files/{fileId} endpoint. Replace {fileId} with the ID of the file you want to download.

curl -X GET http://localhost:5000/api/files/{fileId}

Delete a File

To delete a file, make a DELETE request to the /api/files/{fileId} endpoint. Replace {fileId} with the ID of the file you want to delete.

curl -X DELETE http://localhost:5000/api/files/{fileId}

Running the Project Locally

Clone the repository to your local machine.
Open the project in your IDE.
Build and run the project.

Please note that you need to have .NET 8.0 or higher installed on your machine to run this project.

CloudCordClient

CloudCordClient is a C# library for interacting with the CloudCord backend. It provides functionalities for uploading, downloading, and deleting files.

Usage

Initialization

First, you need to initialize the CloudCordService:

IHttpClientFactory factory = ...; // Get your IHttpClientFactory
ILogger<CloudCordService> logger = ...; // Get your ILogger
IOptions<CloudCordClientSettings> settings = ...; // Get your IOptions

CloudCordService service = new CloudCordService(factory, logger, settings);

or with Dependency Injection: Here's how you can set up the CloudCordService in an ASP.NET Core application:

builder.Services.AddHttpClient("CloudCord", c =>
{
    c.BaseAddress = new Uri(builder.Configuration["CloudCord:BaseAddress"]);
});

builder.Services.Configure<CloudCordClientSettings>(builder.Configuration.GetSection("CloudCord"));

builder.Services.AddScoped<CloudCordService>();

In the appsettings.json file, you would have something like:

{
  "CloudCord": {
    "BaseAddress": "https://your-cloudcord-api-url",
    "ChunkSize": 26214400
  }
}

In this setup, the CloudCordService will be properly initialized with the IHttpClientFactory, ILogger<CloudCordService>, and IOptions<CloudCordClientSettings> instances whenever it's injected into a controller or another service.

Uploading a File

To upload a file, you can use the Upload method:

Stream stream = ...; // Your file stream
string downloadFileName = ...; // The name of the file to upload
CancellationToken ct = ...; // Your cancellation token

string fileId = await service.Upload(stream, downloadFileName, ct);

Uploading a File in Chunks

To upload a file in chunks, you can use the UploadChunked method:

Stream stream = ...; // Your file stream
string downloadFileName = ...; // The name of the file to upload
CancellationToken ct = ...; // Your cancellation token
Func<string, long, Task> onChunkUploaded = ...; // Your callback function

string fileId = await service.UploadChunked(stream, downloadFileName, ct, onChunkUploaded);

Downloading a File

To download a file, you can use the Download method:

string fileId = ...; // The ID of the file to download
CancellationToken ct = ...; // Your cancellation token

Stream fileStream = await service.Download(fileId, ct);

Deleting a File

To delete a file, you can use the Delete method:

string fileId = ...; // The ID of the file to delete
CancellationToken ct = ...; // Your cancellation token

await service.Delete(fileId, ct);

Exceptions

The library can throw UploadChunkException if there is an error during the chunk upload process. It also throws any Http Error that occurs

Contributing

We welcome contributions! Please create a new branch for your feature or bug fix, then submit a pull request.

SymoHTL/CloudCord