EiffelStudio: an EiffelSoftware project - User contributions [en]

EMU

2006-05-25T19:44:22Z

Kamala:

[[Category:Projects]]
[[Image:emu_logo_01.png|right|frame| EMUs: Eiffel Multi Users]]

=Overview=
==Name==
EMU stands for '''Eiffel Multi User'''.
==Goal==
The aim of this project is to integrate a simple repository functionality into EiffelStudio.

=Software Requirements Specification=
You can find our SRS [[EMU/SRS|here]]

=Milestones=

==M1: April 25th==
* set up mailinglist es-emu@origo.ethz.ch ([[User:Schoelle|Bernd]])
* wiki page up to date
* everyone managed to compile Eiffelstudio

==M2: May 2nd==
* define EMU-Protocol as completely as possible

==M3: May 23rd==
* emu-server prototype
* server-administration application

==M4: May 30th==
* new EMU project wizard
* project-management tool: EMU Project Settings

=Team=
Everyone interested in this project is welcome to join our mailinglist [http://origo.ethz.ch/cgi-bin/mailman/listinfo/es-emu es-emu@origo.ethz.ch]

* [[User:Barnski| Bernhard Buss]] (project leader)
* [[User:Zandrea| Andrea Zimmermann]]
* [[User:Kamala| Claudia Kuster]]
* [[User:sdomenic| Domenic Schröder]]
* [[User:luc3D| Lucien Hansen]]
* [[User:ramons| Ramon Schwammberger]]
* [[User:Trickli| Tobias Rickli]]
* [[User:classens| Stephan Classen]]

EMU/Protocol

2006-05-25T19:43:36Z

Kamala:

[[Image:emu_logo_03.png|right|frame| EMUs: Eiffel Multi Users]]

===Messages===
Messages are encapsulated within objects that are being transmitted over the network.
All messages inherit from EMU_MESSAGE.

====Client====
* login
version
projectname
username
password

* update_request
wants to receive new files

* unlock_request
wants to edit a code chunk

* upload_chunk
upload an edited chunk

* relock_request
wants to end locking session

* lock_status_request
get information about all classes

* online_status_request
get information about online users

* logout
informs about a logout of the client

====Server====
* login_accepted

* login_denied

* update
class files

* unlock_request_granted
checks status
sets status

* unlock_request_denied
status information

* lock_status
send status information of all classes

* online_status
send status of users online

* server_down
send information about server down

* send_message
send a message to all clients

====Server-Administration====
The administration tool is meant to maintain and control the server.

* admin_login
admin_name
admin_password

* admin_cmd
command to be executed? or attribute indicating which command should be executed?

====Project-Administration====
There are two ways of administrating an emu-project:

1. using the New EMU Project Wizard (create)

2. using the EMU Project Settings dialog (customize)

All messages inherit from EMU_PROJECT_MESSAGE, which has an attribute "project_name".

'''to server'''

* PROJECT_CREATE
project_password

* PROJECT_DELETE
project_password

* PROJECT_ADD_USER
project_password
user_name
user_password

* PROJECT_REMOVE_USER
project_password
user_name

* PROJECT_CLASS_LIST_REQUEST
project_password

* PROJECT_USER_LIST_REQUEST
project_password

* PROJECT_CLASS_UNLOCK_REQUEST
project_password
class_name

'''from server'''

* PROJECT_ERROR
error_code
error_msg

* PROJECT_OK
ok_code
ok_msg

* PROJECT_CLASS_LIST
class_list

* PROJECT_USER_LIST
user_list

File:Emu logo 03.png

2006-05-25T19:43:28Z

Kamala:

EMU/SRS

2006-05-25T19:42:26Z

Kamala:

[[Image:emu_logo_02.png|right|frame| EMUs: Eiffel Multi Users]]

=The Parts=
* EMU-Protocol
* EMU-Server
* EMU-Client
* ES integration

=Developer Requirements=
==EMU-Protocol==
defines Client/Server communication with
* client/server states
* available messages
* client/server actions

You can find our complete Protocol Specification [[EMU/Protocol|here]]

==EMU-Server==
* stores and manages code-repository
* synchronizes code of clients
* manages Locking-System
* Account-System
* project update
* add/create new code (classes)
* change-logging
* optional: Media-upload
* optional: BackUp-System
* optional: Release-versions
* optional: Server-Admin-Tool

===Locking-System===
* list of locked code
* check if code (class) is locked
* lock / unlock code (class)

===Code-Synchronization===
* broadcast code-changes
* bring user code up to date

===Account-System===
The server uses an account-system to organize its projects and users.
Every project has its own users assigned.

====Project-Accounts====
* project name
* project-admin(s)
* user lists
* project status
* editable / creatable with a project-admin-tool

====User-Accounts====
* usernames
* used for logins
* assign locked code & changes to users
* online status

===Change-Log===
The Log helps the users to know what has changed during their last login.
It is also used as a look-up table for synchronisation with the clients.
Every lock/unlock action is logged with following data:
* user name
* date and time
* type of action
* code element (class name)
Additionally, it provides the possibility for the user to add comments (e.g what he changed, what doesn't work yet...).

==EMU-Client==
* interface for IDE and server
* provides features to login and communicate with server on an abstract base
* upload/download code elements to/from server
* notify IDE of server-messages (code-updates)
* modular / independent of IDE-integration
* optional: upload media files

===IDE-Notifications===
The client needs to notify the IDE of the new changes.

==ES integration==
* minimal change to existing ES-classes and features.
* modular integration: activatable and removable / hideable
* only a few GUI changes

===ES-GUI Enhancement===

===Internal Dialogs===

===External Wizards===
====New EMU Project Wizard====
The following states need to be reflected by the wizard:
* emu-server hostname and port
* project-name and project-password
* add ES-libraries used
* add users and user-passwords

=User Requirements=
* easy to use
* target is a small project group of up to 20 developers.
* code synchronisation process mostly hidden from user
* minimal extra work (less total work)
* better efficiency

File:Emu logo 02.png

2006-05-25T19:42:12Z

Kamala:

File:Emu logo 01.png

2006-05-25T18:26:31Z

Kamala: