Changes between Version 32 and Version 33 of BluePrint/Chat


Ignore:
Timestamp:
04/24/14 06:58:31 (7 years ago)
Author:
Fran Boon
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • BluePrint/Chat

    v32 v33  
     1[[TOC]]
    12= !BluePrint: Chat  =
    2 [[TOC]]
    33== Introduction ==
    44
     
    3939* Screen Sharing
    4040* File Transfer
     41
    4142== Stake Holders ==
    42 
    4343* The End Users: the group of end users would like to have a communication channel through which they can contact each other.
    4444
     
    4848
    4949== Need ==
    50 
    5150Many organizations and people use Sahana Eden. Eden Chat will be a medium of communication between organizations and users.
    5251It would allow users to remain on a single platform and accomplish the task they want to perform without the need to go over 3rd party software to communicate.The chat would be integrated with Eden features that would help making tasks easier such as customized commands(like in irc) for accomplishing different tasks by different users. It would have the capability of seeing online users and message on mobile incase the user is offline. This would make communication easier since one need not any other information to contact other user.The chat could allow to send map images or map location from Eden Map to other user.
     
    5756
    5857== Examples ==
    59 
    6058Examples of existing chat facilities, pointing out features that may be desirable or difficult to mimic:
    6159
     
    7775* [https://www.hipchat.com/ Atlassian HipChat]
    7876 * This may be the closest parallel to Eden-hosted chat, as it is specifically intended and designed for work teams. It would be worth looking at the features offered and the UI.
     77
    7978== Use Case Diagram ==
    8079[[Image(http://eden.sahanafoundation.org/attachment/wiki/BluePrint/Chat/sahana%20chat%20use%20case.jpg)]]
     80
    8181== Server Design ==
    82 
    83 
    84 
    8582There are several options for implementing the server.
    8683* Implement it within Eden, using the Eden framework, building on existing systems such as the msg module.
     
    8986
    9087=== Internal to Eden ===
    91 
    9288* Use the msg module for processing and storage of messages.
    9389* Represent chat rooms as groups -- the users participating in the chat are members of the group.
     
    10197 * Launch requests to update users' chat windows.
    10298* File transfer could consist of uploading a document via the doc module, and posting out a link to it in the chat.
     99
    103100=== Run a separate chat server ===
    104 
    105101* Run a chat server, preferably an open-source package, and call across to it from Eden.
    106102* Populate its user database as needed.
     
    111107
    112108=== Use an external, existing service ===
    113 
    114109* For preference, provide single-signon by some means.
    115110* If the service is web-hosted, display the UI within an Eden page.
     111
    116112== Client Design ==
    117113
    118114=== For an Eden-based server ===
    119 
    120115* Look for appropriate, existing !JavaScript packages, or at least examples.
    121116* Need only the UI, not any protocol.
     
    124119
    125120=== For a separate chat server ===
    126 
    127121* http://candy-chat.github.io/candy/
    128122 * Needs updating to work with current jQuery/UI
     
    140134 * http://wokkel.ik.nu
    141135* https://github.com/Jajcus/pyxmpp2
     136* http://buddycloud.com
    142137* http://xmpppy.sourceforge.net (unmaintained)
    143138
     
    151146
    152147== Implementation ==
    153 
    154148This is suggested as a GSoC project for 2014. Students can edit this blueprint, and should also link to their proposals, and optionally wiki pages with any additional ideas, investigation, and work.
    155149
    156150* [https://docs.google.com/document/d/1eTm7wFQdqN1alX_aKghbG0oL3LBRPiCFmcWIUC3D6Hg/edit?usp=sharing GSoC 14 - Chat in Sahana Eden] by [https://github.com/arnavkagrawal Arnav Kumar Agrawal(irc nick: knowing42)]
     151
    157152== References ==
    158153<Links to external resources>
    159154
    160155=== Msg module ===
    161 
    162156Code:
    163157* https://github.com/flavour/eden/blob/master/modules/s3/s3msg.py
     
    173167
    174168=== Separate chat server ===
     169''Professional XMPP Programming with !JavaScript and jQuery'': [http://professionalxmpp.com/]
    175170
    176 ''Professional XMPP Programming with !JavaScript and jQuery'': [http://professionalxmpp.com/]
    177171----
    178172[wiki:BluePrint BluePrints]
    179 [wiki:BluePrint BluePrints]
    180 [wiki:BluePrint BluePrints]