fornever / styx

Miranda IM history synchronizer.

Styx

Project status: development.

Protocol

Server and client uses custom protocol based on protobuf. To generate protobuf code for client and server, use styx-messages/Build-Protobuf.ps1 file.

Server

Styx server is written in Scala. It listens on 6060 port (default) for incoming client connections.

Running

To run the server, install sbt and use

$ sbt run

Client

For now, the only client is Miranda NG plugin.

Building

Compiler

Current client code is compatible only with MSVS IDE.

Libraries

You'll need a boost logging library.

Process

First of all, if you not plan to debug your code inside IDE, you're free to disable the post-build action. Then, build projects as always.

Using

Copy *.dll and *.pdb files to folder Miranda/Plugins. Start Miranda and use main menu command Enable Styx.

styx's Issues

HTTP implementation

There should be a simple HTTP service to get all messages and/or their hashcode in time period. Maybe I'll want to use something like Swagger for protocol documenting.

Implement background message passing

Need to implement "Messaging" stage of protocol.

New synchronization protocol

Let's try next approach to message synchronization.

Use server and client-based timestamps for input and output data.

Update documentation

The documentation in this repository should document only server (I could add some notes about possible client implementation though or even link a current "reference" Miranda client).

Integrate rsync algorithm into synchronization

See http://rsync.samba.org/tech_report/tech_report.html for details.
The plan is:

1. Rsync from the server to the client.
2. Rsync from the client to the server.
3. ???
4. PROFIT!

ScalaPB

The project should use http://trueaccord.github.io/ScalaPB/ for protobuf.

Server-side storage

Need to implement some sort of the server-side data storage.

Move code to new package

It should use me.fornever for now.

Database migration

Use something like Flyway or Liquibase for database migration support.

Message saving

Implement server-side message saving (use a database).

Travis integration

According to General Forneverian Specification on Source Template Constructs we should set up open unit testing system.

Move client code to another repository

There should be only server code here.

Rename project

It can now be simply called "Styx".

Implement hashing algorithm

Need to implement initial hashing step of protocol.

Naming convention

Need to set up some naming convention. For example:

• call all client -> server messages as Request;
• call all server -> client messages as Response;
• call all MessageType values appropriately.

MessageType enum should not be placed into same package as defined types.

Update Scala version

The project should use the latest stable Scala version (2.11.5 currently I think).

User management

Need to implement server-side security and user management.

Move license to another file

We don't need all this official crap in our precious readme.

Use `anorm` on the server side

Should not use such a simple JDBC.

Dynamic contact adding and deleting

Need support for dynamic adding and removing of contacts.

Exception handling

Catch exceptions thrown inside the background loop and log them.

Contact handling

Implement contact add and contact delete event handlers.