Skip to content

Latest commit

 

History

History
637 lines (460 loc) · 13.1 KB

README.md

File metadata and controls

637 lines (460 loc) · 13.1 KB

DirectFile Logo

DIRECT/FILE CLIENT

Your computer, connected.

Cliente responsável por conectar seu computador ao ecossistema DirectFile e sincronizar arquivos automaticamente.




YOUR COMPUTER. YOUR FILES. ANYWHERE.



Made by Diogo Teodoro Dias Lamas


⚡ Sobre o projeto

O DirectFile.Client é o aplicativo responsável por rodar no computador do usuário.

Ele se conecta ao DirectFile.Server, autentica o usuário e mantém uma conexão em tempo real utilizando SignalR.

Sempre que um arquivo é enviado para a conta do usuário, o cliente conectado pode recebê-lo automaticamente.


                 🌐 INTERNET
                       │
                       ▼
        ┌─────────────────────────┐
        │                         │
        │   DIRECTFILE.SERVER     │
        │                         │
        └────────────┬────────────┘
                     │
                     │
                 SIGNALR
                     │
                     ▼
        ┌─────────────────────────┐
        │                         │
        │   DIRECTFILE.CLIENT     │
        │                         │
        │    YOUR COMPUTER        │
        │                         │
        └────────────┬────────────┘
                     │
                     ▼
                 📁 D:\DirectFile

🔥 Como funciona

O fluxo de funcionamento do cliente acontece automaticamente.

01

CLIENT STARTS

O DirectFile.Client é iniciado no computador do usuário.

Ele carrega as configurações presentes no arquivo:

client-config.json

02

LOGIN

O cliente envia as credenciais para o servidor:

POST /api/auth/login

O servidor retorna um token JWT utilizado nas próximas requisições.

03

SYNC FILES

Antes de conectar ao sistema em tempo real, o cliente verifica se existem arquivos pendentes no servidor.

Arquivos ainda não sincronizados são baixados automaticamente.

04

CONNECT SIGNALR

O cliente estabelece uma conexão persistente com:

/hubs/sync

O nome do computador também é enviado durante a conexão.

05

WAIT FOR FILES

Depois de conectado, o cliente permanece aguardando novos arquivos.

Quando o servidor envia um evento FileReceived, o arquivo é baixado automaticamente.


✨ Funcionalidades

🔐 Login automático

O cliente utiliza as credenciais configuradas em:

client-config.json

Após o login, recebe um token JWT utilizado para acessar a API e o SignalR Hub.

⚡ Conexão em tempo real

O cliente mantém uma conexão utilizando SignalR.

Server
   │
   ▼
SignalR
   │
   ▼
Client
   │
   ▼
Download

🔄 Sincronização automática

Quando o cliente inicia, ele consulta os arquivos disponíveis no servidor.

Arquivos que ainda não foram sincronizados são baixados automaticamente.

📁 Download automático

Os arquivos são baixados para a pasta configurada pelo usuário.

Exemplo:

D:\DirectFile

🛡️ Proteção contra sobrescrita

Caso um arquivo com o mesmo nome já exista, o DirectFile evita sobrescrever o arquivo.

arquivo.pdf

arquivo (1).pdf

arquivo (2).pdf

🔁 Reconexão automática

Caso a conexão seja perdida, o cliente tenta se conectar novamente.

Após reconectar, ele executa uma nova sincronização para buscar possíveis arquivos pendentes.


🧠 Arquitetura

┌──────────────────────────────────────────────┐
│                                              │
│              DIRECTFILE.CLIENT               │
│                                              │
├──────────────────────────────────────────────┤
│                                              │
│                  Program.cs                  │
│                                              │
├──────────────────────────────────────────────┤
│                                              │
│                  LoginAsync()                │
│                                              │
│            POST /api/auth/login              │
│                                              │
├──────────────────────────────────────────────┤
│                                              │
│            SyncMissingFilesAsync()           │
│                                              │
│              GET /api/files                  │
│                                              │
├──────────────────────────────────────────────┤
│                                              │
│              SignalR Connection              │
│                                              │
│                /hubs/sync                    │
│                                              │
├──────────────────────────────────────────────┤
│                                              │
│              FileReceived Event              │
│                                              │
│              DownloadFileAsync()             │
│                                              │
├──────────────────────────────────────────────┤
│                                              │
│                Local Storage                 │
│                                              │
│              synced-files.json               │
│                                              │
└──────────────────────────────────────────────┘

📂 Estrutura do projeto

DirectFile.Client
│
├── Program.cs
│
├── ClientConfig.cs
│
├── client-config.json
│
├── synced-files.json
│
└── DirectFile.Client.csproj

⚙️ Configuração

O cliente utiliza um arquivo chamado: client-config.json

Exemplo:

{
    "ServerUrl": "https://localhost:7078",
    "Email": "seu@email.com",
    "Password": "sua-senha",
    "DownloadFolder": "D:\\DirectFile"
}
ServerUrl Define o endereço do DirectFile.Server.

Exemplo local:
https://localhost:7078
Exemplo em produção:
https://seu-servidor.com
Email E-mail utilizado para autenticação no servidor.
Password Senha utilizada para autenticação.
DownloadFolder Define a pasta onde os arquivos recebidos serão salvos.

D:\DirectFile

🚀 Executando o projeto

1. Clone o repositório

git clone https://github.com/TheTekig/DirectFile.Client.git

2. Entre na pasta

cd DirectFile.Client

3. Restaure as dependências

dotnet restore

4. Configure o cliente Edite o arquivo client-config.json para configurar o endereço do servidor, e-mail, senha e pasta de download.

5. Execute

dotnet run

Resultado esperado:

=== Direct File - Cliente ===

Login ok.

Pasta de destino:
D:\DirectFile

[i] Sincronizando arquivos pendentes...

Conectado!

Esperando arquivos...

🔄 Sincronização de arquivos

O DirectFile.Client mantém um arquivo local chamado synced-files.json. Esse arquivo armazena os IDs dos arquivos que já foram sincronizados naquele computador.

Exemplo:

[
    1,
    2,
    5,
    8
]

Exemplo de sincronização

Servidor Cliente Pendentes
1
2
3
4
5
1
2
5
3
4

Quando o cliente inicia, ele compara os arquivos disponíveis no servidor com os IDs presentes em synced-files.json. Os arquivos pendentes são baixados automaticamente.


📡 Conexão SignalR

O cliente se conecta ao Hub: /hubs/sync

Durante a conexão são enviados: JWT Token + Device Name

Exemplo conceitual:

/hubs/sync?deviceName=DESKTOP-DIOGO&access_token=JWT_TOKEN

Isso permite que o servidor identifique:

  • O usuário conectado
  • O computador conectado
  • O momento da conexão

🔁 Reconexão automática

O cliente utiliza o método .WithAutomaticReconnect(). Caso a conexão seja perdida:

┌──────────────────────┐
│                      │
│   CONNECTION LOST    │
│                      │
└───────────┬──────────┘
            │
            ▼
┌──────────────────────┐
│                      │
│   RECONNECTING...    │
│                      │
└───────────┬──────────┘
            │
            ▼
┌──────────────────────┐
│                      │
│   CONNECTED AGAIN    │
│                      │
└───────────┬──────────┘
            │
            ▼
┌──────────────────────┐
│                      │
│   SYNC MISSING FILES │
│                      │
└──────────────────────┘

Isso garante que, caso arquivos sejam enviados enquanto o computador estiver desconectado, eles possam ser sincronizados quando o cliente voltar a ficar online.


🛣️ Roadmap

✔ Implementado

  • Configuração via JSON
  • Login automático
  • JWT Authentication
  • Conexão SignalR
  • Identificação do computador
  • Download automático
  • Sincronização de arquivos pendentes
  • Reconexão automática
  • Proteção contra sobrescrita

🚧 Próximas etapas

  • Cliente iniciar automaticamente com o Windows
  • Rodar como Windows Service
  • Interface gráfica
  • Configuração sem editar JSON manualmente
  • Sistema de dispositivos persistentes
  • Status online/offline
  • Selecionar computador de destino
  • Fila individual de transferências
  • Histórico de sincronização
  • Atualização automática do cliente

🔗 Projeto relacionado

DIRECTFILE.SERVER

Responsável pelo núcleo do ecossistema DirectFile.

Principais responsabilidades:

  • Authentication
  • JWT Tokens
  • File Management
  • SignalR Hub
  • Connected Devices
  • File Distribution
  • API REST

DIRECT/FILE

YOUR COMPUTER. YOUR FILES. ANYWHERE.


Made by Diogo Teodoro Dias Lamas