Project 2

README.md

@@ -1,3 +1,39 @@
-# Project 2
+# Project 2 README.md file
 
-Web Programming with Python and JavaScript
+ ### Flack Overview:
+Flack is a simple messaging application that allows users to register  with  a display name, create / join channels (chat rooms) and post messages. To post a message, a user simply selects (or creates) a channel and enters text in the message box located at the bottom of the screen. Pressing the "Post" button, adds the message to the active lists and updates anyone else in the channel
+
+##Personal Touch: 
+The personal touch includes the addition of messages badges in the user list that tracks and displays the number of messages posted by each user
+
+## Notes:
+
+1) The application  uses pop-ups to prompt the user for their display name and channel - the browser MUST allow pop-ups for proper functionality of the application.  Here is what the prompt looks like:
+
+<img src="https://user-images.githubusercontent.com/32006324/54920669-2c9f8680-4eda-11e9-9885-10319313668f.jpg" width="500">
+
+2) To add channels select the plus (+) icon next to "Channels" - the "General" channel is provided by default just like Slack
+
+3) New users joining the app are displayed in the left side Users column
+
+<img src="https://user-images.githubusercontent.com/32006324/54931780-0e448580-4ef0-11e9-8f96-62d5c01810b4.jpg" width="900">
+
+4) The application has been tested mostly on Chrome and some on Firefox.
+
+## Key files and resources:
+1) application.py - primary flack application that serves the index.html file, tracks channels / messages  and manages user websocket connections.
+
+2) index.js - client side javascript file which is the core of this  application.  Handles client interactions with the server via websockets  
+
+3) index.html - the single page application screen base on boostrap 
+
+4) static resources - this includes the index.html file (mentioned above), three graphic files (addGraphic.png,
+favicon.ico, and flackUser.png) and the style.css which is mostly used to to properly configure  messages
+
+5) requirements.txt - a list of dependent python modules necessary for running the server
+
+6) README.md - this file 
+
+
+
+

application.py

@@ -1,13 +1,113 @@
 import os
-
-from flask import Flask
+import datetime
+from flask import Flask, render_template
 from flask_socketio import SocketIO, emit
 
 app = Flask(__name__)
+
+# Configure to use filesystem session type
 app.config["SECRET_KEY"] = os.getenv("SECRET_KEY")
+app.config["SESSION_PERMANENT"] = False
+app.config["SESSION_TYPE"] = "filesystem"
+
 socketio = SocketIO(app)
+app.secret_key = os.urandom(32)
 
+# Global lists and dicts
+channels = {}
+message = {}
+messages = []
+users = {}
+
+MESSAGELIMIT = 100
 
 @app.route("/")
+@app.route("/index")
 def index():
-    return "Project 2: TODO"
+    return render_template("index.html")
+
+# set up a user who is connecting to the server
+@socketio.on('user connect')
+def connect(data):
+    global channels
+    messages = []
+
+    # check if channels empty - first time through
+    if not channels:
+        # get server date / time
+        current = datetime.datetime.now()
+
+        displayHeader = " | "+str(current.hour)+":"+str(current.minute)+"    |    "+str(current.month)+" "+str(current.day)+", "+str(current.year)
+
+        # always provide a general channel just like slack
+        messages.insert(0, {'username': "System",
+                         'channel': "General",
+                         'datetime': displayHeader,
+                         'message': "Welcome to Flack!"})
+
+        channels['General'] = messages
+        emit("select channel", channels, broadcast=False)
+    else:
+        # already have some channels so communicate
+        updatedChannels = []
+
+        # extract updated list of channels
+        for key in channels.keys():
+            updatedChannels.append(key)
+
+        # emit current channel list
+        emit("update channels", {'channel': updatedChannels}, broadcast=True)
+
+    # check if user already connected
+    if (data["username"] not in users.values()):
+
+        # if users{} empty - first time through
+        if not users:
+            users.update({0: data["username"]})
+        else:
+            # determine next dict key and increment to add new user
+            dictKeys = list(users.keys())
+            nextKey = max(dictKeys)+1
+            users.update({nextKey: data["username"]})
+
+    # let everyone know a user has joined
+    print(users)
+    emit("add user", users, broadcast=True)
+
+
+@socketio.on('get channel')
+def getChannel(data):
+    global channels
+    updatedChannels = []
+
+    # emit current channel list
+    emit("select channel", channels, broadcast=False)
+
+@socketio.on('new channel')
+def addChannel(data):
+    global channels
+    updatedChannels = []
+
+    # add the new channel to the server channel list
+    channels.update({data['channel']: []})
+
+    # extract updated list of channels
+    for key in channels.keys():
+        updatedChannels.append(key)
+
+    # let everyone know a new channel is available
+    emit("update channels", {'channel': updatedChannels}, broadcast=True)
+
+@socketio.on('post message')
+def addMessage(data):
+    global channels
+
+    # add the message, but keep lists (message queue) to 100
+    if len(channels[data['channel']]) > MESSAGELIMIT:
+        channels.setdefault(data['channel'], []).append(data)
+        channels.setdefault(data['channel'], []).pop(0)
+    else:
+        channels.setdefault(data['channel'], []).append(data)
+
+    # notify everyone of new message
+    emit("add message", data, broadcast=True)

requirements.txt

@@ -1,2 +1,3 @@
 Flask
 Flask-SocketIO
+datetime