Changes between Version 32 and Version 33 of BluePrint/Chat
- Timestamp:
- 04/24/14 06:58:31 (11 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
BluePrint/Chat
v32 v33 1 [[TOC]] 1 2 = !BluePrint: Chat = 2 [[TOC]]3 3 == Introduction == 4 4 … … 39 39 * Screen Sharing 40 40 * File Transfer 41 41 42 == Stake Holders == 42 43 43 * The End Users: the group of end users would like to have a communication channel through which they can contact each other. 44 44 … … 48 48 49 49 == Need == 50 51 50 Many organizations and people use Sahana Eden. Eden Chat will be a medium of communication between organizations and users. 52 51 It 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. … … 57 56 58 57 == Examples == 59 60 58 Examples of existing chat facilities, pointing out features that may be desirable or difficult to mimic: 61 59 … … 77 75 * [https://www.hipchat.com/ Atlassian HipChat] 78 76 * 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 79 78 == Use Case Diagram == 80 79 [[Image(http://eden.sahanafoundation.org/attachment/wiki/BluePrint/Chat/sahana%20chat%20use%20case.jpg)]] 80 81 81 == Server Design == 82 83 84 85 82 There are several options for implementing the server. 86 83 * Implement it within Eden, using the Eden framework, building on existing systems such as the msg module. … … 89 86 90 87 === Internal to Eden === 91 92 88 * Use the msg module for processing and storage of messages. 93 89 * Represent chat rooms as groups -- the users participating in the chat are members of the group. … … 101 97 * Launch requests to update users' chat windows. 102 98 * File transfer could consist of uploading a document via the doc module, and posting out a link to it in the chat. 99 103 100 === Run a separate chat server === 104 105 101 * Run a chat server, preferably an open-source package, and call across to it from Eden. 106 102 * Populate its user database as needed. … … 111 107 112 108 === Use an external, existing service === 113 114 109 * For preference, provide single-signon by some means. 115 110 * If the service is web-hosted, display the UI within an Eden page. 111 116 112 == Client Design == 117 113 118 114 === For an Eden-based server === 119 120 115 * Look for appropriate, existing !JavaScript packages, or at least examples. 121 116 * Need only the UI, not any protocol. … … 124 119 125 120 === For a separate chat server === 126 127 121 * http://candy-chat.github.io/candy/ 128 122 * Needs updating to work with current jQuery/UI … … 140 134 * http://wokkel.ik.nu 141 135 * https://github.com/Jajcus/pyxmpp2 136 * http://buddycloud.com 142 137 * http://xmpppy.sourceforge.net (unmaintained) 143 138 … … 151 146 152 147 == Implementation == 153 154 148 This 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. 155 149 156 150 * [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 157 152 == References == 158 153 <Links to external resources> 159 154 160 155 === Msg module === 161 162 156 Code: 163 157 * https://github.com/flavour/eden/blob/master/modules/s3/s3msg.py … … 173 167 174 168 === Separate chat server === 169 ''Professional XMPP Programming with !JavaScript and jQuery'': [http://professionalxmpp.com/] 175 170 176 ''Professional XMPP Programming with !JavaScript and jQuery'': [http://professionalxmpp.com/]177 171 ---- 178 172 [wiki:BluePrint BluePrints] 179 [wiki:BluePrint BluePrints]180 [wiki:BluePrint BluePrints]