Notification framework

graphs/exception.py

@@ -0,0 +1,4 @@
+from django.core.exceptions import ObjectDoesNotExist
+
+class EventNotFound(ObjectDoesNotExist):
+	pass

graphs/models.py

@@ -10,10 +10,10 @@
        ex. 'id' for user table would be 'user_id'
 '''
 
-from sqlalchemy import Column, Integer, String, ForeignKey, Table, Index, ForeignKeyConstraint
+from sqlalchemy import Column, Integer, String, ForeignKey, Table, Index, ForeignKeyConstraint, Boolean, UniqueConstraint
 from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.orm import relationship, backref
-from sqlalchemy.types import TIMESTAMP
+from sqlalchemy.types import TIMESTAMP, Boolean
 from django.db import models
 from django.conf import settings
 from sqlalchemy import create_engine
@@ -310,6 +310,33 @@ class Edge(Base):
             ForeignKeyConstraint([user_id, graph_id, tail_node_id], [Node.user_id, Node.graph_id, Node.node_id], ondelete="CASCADE", onupdate="CASCADE"), {})
     #no relationship specified
 
+class ShareGraphEvent(Base):
+    __tablename__ = 'share_graph_event'
+    # unique id for each share graph event
+    id = Column(Integer, autoincrement=True, primary_key=True)
+    # id of the graph shared
+    graph_id = Column(String, nullable=False)
+    # id of the owner of the graph which is shared
+    owner_id = Column(String, nullable=False)
+    # id of the group the graph is shared in
+    group_id = Column(String, ForeignKey('group.group_id', ondelete="CASCADE", onupdate="CASCADE"), nullable=False)
+    # id of the member of the group.
+    # Hence there can be multiple share graph events if a owner shares a grap
+    # with a group. A share graph event will be created for all the memebers
+    # of the group except the owner of the graph (the one who shared it).
+    member_id = Column(String, ForeignKey('user.user_id', ondelete="CASCADE", onupdate="CASCADE"), nullable=False)
+    # timestamp at which the share graph event occured
+    share_time = Column(TIMESTAMP, nullable = False)
+    # Boolean value to track if notifications is read or not.
+    # if True then the notification is active, i.e not read
+    is_active = Column(Boolean, nullable=False)
+    # We use ForeignKeyConstraint for graph_id and owner_id
+    # because this is the only to define a composite foreign key
+    __table_args__ = (
+        UniqueConstraint('graph_id', 'owner_id', 'group_id', 'member_id'),
+        ForeignKeyConstraint([graph_id, owner_id], [Graph.graph_id, Graph.user_id], ondelete="CASCADE", onupdate="CASCADE"),
+            )
+
 #Create indices
 Index('graph_public_idx', Graph.public)
 Index('graph_owner_idx', Graph.user_id)

graphs/static/graphs/js/notifications.js

@@ -0,0 +1,41 @@
+$(document).ready(function() {
+
+
+   /**
+   * Mark notification as read through the UI.
+   */
+   $(".read_notification").click(function (e) {
+    var uid = $(this).val();
+    var nid = $(this).attr('id');
+
+    $.post('../../../read_notification/', {
+      'uid': uid,
+      'nid': nid
+    }, function (data) {
+      if (data.Error) {
+        return alert(data.Error);
+      }
+      window.location.reload();
+    });
+   });
+
+   /**
+   * Mark all notifications as read in a group
+   */
+   $(".read_all_notifications").click(function (e) {
+    var uid = $(this).val();
+    var nid = $(this).attr('id');
+
+    $.post('../../../read_all_notifications/', {
+      'uid': uid,
+      'nid': nid
+    }, function (data) {
+      if (data.Error) {
+        return alert(data.Error);
+      }
+      window.location.reload();
+    });
+   });
+
+
+});

graphs/templates/base.html

@@ -109,7 +109,10 @@ <h4 class="modal-title" id="myModalLabel">Forgot Information</h4>
                     {% endif %}
                     <li><a href="{% url 'features' %}">Features</a></li>
                     <li><a href="{% url 'help_tutorial' %}">Help</a></li>
-                    <li><a href="{% url 'help_about' %}" style="text-align:center">About Us</a></li>                     
+                    <li><a href="{% url 'help_about' %}" style="text-align:center">About Us</a></li>  
+                    {% if uid != None %}
+                        <li><a href="{% url 'notifications' %}">Notifications</a></li>
+                    {% endif %}                   
                 </ul>
 
                 <!-- display login form if not logged in -->

graphs/templates/graphs/notifications.html

@@ -0,0 +1,67 @@
+{% extends 'base.html' %}
+{% block content %}
+{% load staticfiles %}
+<script type="text/javascript" src="{% static 'graphs/js/notifications.js' %}"></script>
+
+{% if uid != None %}
+
+
+
+<br>
+<div class="row"><button style="position: relative;
+   right: 100px; float: right;" class="btn btn-default read_all_notifications" id="{{ group }}" value="{{ event.member_id }}">Mark all notifications as read</button></div>
+
+<br>
+<div class="row">
+  <div class="col-sm-3">
+    <div class="panel panel-primary">
+  <!-- Default panel contents -->
+  <div class="panel-heading">Groups</div>
+  <div class="panel-body">
+    <p>All the notifications of the Group you are a part of.</p>
+  </div>
+
+  <!-- Table -->
+  <table class="table">
+  {% for group in groups_for_user %}
+    <tr>
+    <td>{{ group.groupId }}</td>
+    </tr>
+  {% endfor %}
+  </table>
+</div>
+  </div>
+<div class="col-sm-8">
+
+
+<!-- <div class="column"> -->
+{% for group, events in notifications.items %}
+{% if events != None %}
+<div class="panel panel-primary">
+  <div class="panel-heading">
+    <h3 class="panel-title">{{ group }}</h3>
+  </div>
+  <table class="table">
+  {% for event in events %}
+  {% if event.owner_id != uid %}
+  {% if event.is_active == 1 %}
+    <tr> 
+    <td> <a href="{% url 'graphs' %}/{{ event.owner_id }}/{{ event.graph_id}}">{{ event.owner_id }} shared {{ event.graph_id }} with {{ event.group_id }}.</td>
+    <td><div class="test"><button class="btn btn-default read_notification" id="{{ event.id }}" value="{{ event.member_id }}">Mark as read</button></div></td>
+    </tr>
+  {% endif %}
+  {% endif %}
+  {% endfor %}
+
+  </table>
+  <div class="panel-footer"><div class="test"><button class="btn btn-default read_all_notifications" id="{{ group }}" value="{{ event.member_id }}">Mark all as read</button></div></div>
+</div>
+{% endif %}
+{% endfor %}
+</div>
+
+</div>
+<!-- </div> -->
+
+{% endif %}
+{% endblock %}

graphs/urls.py

@@ -22,6 +22,9 @@
         url(r'^graphs/public/$', views.public_graphs, name='public_graphs'),
         url(r'^graphs/upload/$', views.upload_graph_through_ui, name='upload_graph_through_ui'),
 
+        # notifications page
+        url(r'^notifications/$', views.notifications, name='notifications'),
+
         # view graph page. This contains regular expression to catch url in the form of the following:
         # /graphs/email_address/graph_id/
         # regex from http://www.regular-expressions.info/email.html
@@ -77,6 +80,8 @@
         url(r'^resetPassword/$', views.resetPassword, name='resetPassword'),
         url(r'^launchTask/$', views.launchTask, name='launchTask'),
         url(r'^retrieveTaskCode/$', views.retrieveTaskCode, name='retrieveTaskCode'),
+        url(r'^read_notification/$', views.read_notification, name='read_notification'),
+        url(r'^read_all_notifications/$', views.read_all_notifications, name='read_all_notifications'),
 
         #REST API
 
@@ -90,6 +95,7 @@
         url(r'^api/users/(?P<user_id>.+)/graph/makeGraphPrivate/(?P<graphname>.+)/$', views.make_graph_private, name='make_graph_private'),
         url(r'^api/users/(?P<user_id>.+)/graphs/$', views.view_all_graphs_for_user, name='view_all_graphs_for_user'),
 
+
         # Group REST API endpoints
         url(r'^api/groups/get/(?P<group_owner>.+)/(?P<groupname>.+)/$', views.get_group, name='get_group'),
         url(r'^api/groups/get/$', views.get_groups, name='get_groups'),

graphs/util/db.py

@@ -21,6 +21,7 @@
 from django.conf import settings
 from django.core.mail import send_mail
 from json_validator import validate_json, assign_edge_ids, convert_json, verify_json
+from graphs.exception import EventNotFound
 
 data_connection = db_init.db
 
@@ -3648,7 +3649,11 @@ def share_graph_with_group(owner, graph, groupId, groupOwner):
 	# If they're an owner or a group member, they can add graph to the group
 	if group_owner != None or group_member != None:
 		new_shared_graph = models.GroupToGraph(group_id = groupId, group_owner = groupOwner, user_id = owner, graph_id = graph, modified = graph_exists.modified)
-
+		members = get_group_members(groupOwner, groupId)
+		for member in members:
+			# TODO: use the current db session instead of creating a new db
+			# session
+			add_share_graph_event(graph, owner, groupId, member.user_id)
 		db_session.add(new_shared_graph)
 		db_session.commit()
 	else:
@@ -4742,3 +4747,155 @@ def constructResponse(statusCode, message, error):
 		response['Error'] = error
 
 	return response
+
+
+def add_share_graph_event(graph_id, owner_id, group_id, member_id):
+	'''
+		Add a new share graph event to the table.
+		After sharing the graph with a group this function will create
+		a share graph event for all the users in that group
+
+		@param graph_id: id of the graph shared
+		@param owner_id: owner of the graph which is shared
+		@param group_id: id of the grop
+		@param member_id: id of the member the graph is shared
+	'''
+	# Create database connection
+	db_session = data_connection.new_session()
+
+	# Get the current time
+	cur_time = datetime.now()
+
+	new_event = models.ShareGraphEvent(graph_id=graph_id, owner_id=owner_id, group_id=group_id, member_id=member_id, share_time=cur_time, is_active=True)
+	db_session.add(new_event)
+	db_session.commit()
+	db_session.close()
+
+
+def update_share_graph_event(event_id, active, member_id):
+	'''
+		Update the share graph event. Change its active state.
+		If active is True then the notification is not read/clicked.
+
+		@param event_id: id of the share graph event
+		@param active: Boolean value, update the state of event
+		@param member_id: id of the user, the logged in user.
+	'''
+	db_session = data_connection.new_session()
+
+	try:
+		event = db_session.query(models.ShareGraphEvent).filter(models.ShareGraphEvent.id == event_id).filter(models.ShareGraphEvent.member_id == member_id).one()
+		event.is_active = active
+		db_session.commit()
+		db_session.close()
+	except NoResultFound:
+		db_session.close()
+		raise EventNotFound
+		# return 'Event not found'
+
+# admin function
+def delete_share_graph_event(event_id, member_id):
+	'''
+		Delete the share graph event from the table for the member
+
+		@param event_id: id of the share graph event
+		@param member_id: id of the member
+
+	'''
+	db_session = data_connection.new_session()
+	try:
+		event = db_session.query(models.ShareGraphEvent).filter(models.ShareGraphEvent.id == event_id).filter(models.ShareGraphEvent.member_id == member_id).one()
+		db_session.delete(event)
+		db_session.commit()
+		db_session.close()
+	except NoResultFound:
+		db_session.close()
+		raise EventNotFound
+		# return 'Event not found'
+
+
+def get_share_graph_event_by_member_id(member_id):
+	'''
+		Return a dictionary of share graph events for a user keyed by group id.
+		If all the share graph events for a particular group are inactive, i.e. read
+		then the group is keyed by None in the dictionary.
+
+		@param member_id: id of the user
+	'''
+	# Create database connection
+	db_session = data_connection.new_session()
+
+	try:
+		events = db_session.query(models.ShareGraphEvent).filter(models.ShareGraphEvent.member_id == member_id).all()
+		db_session.close()
+		return events
+	except NoResultFound:
+		db_session.close()
+		# return None
+		raise EventNotFound
+
+
+def get_share_graph_event_by_id(event_id, member_id):
+	'''
+		Return share graph event notification
+
+		@param event_id: id of the event
+		@param member_id: id of the logged in user
+	'''
+	db_session = data_connection.new_session()
+	try:
+		event = db_session.query(models.ShareGraphEvent).filter(models.ShareGraphEvent.id == event_id).filter(models.ShareGraphEvent.member_id == member_id).one()
+		db_session.close()
+		return event
+	except NoResultFound:
+		db_session.close()
+		raise EventNotFound
+		# return 'Event not found'
+
+
+def get_all_share_graph_event():
+	'''
+		Return all the share graph events.
+	'''
+	db_session = data_connection.new_session()
+	events = db_session.query(models.ShareGraphEvent).all()
+	db_session.close()
+	return events
+
+
+def set_share_graph_events_inactive(event_ids, member_id):
+	'''
+		Set all events in the list event_ids as inactive
+
+		@param events_id: list of event ids
+		@param member_id: id of the logged in user
+	'''
+	db_session = data_connection.new_session()
+	try:
+		for event in events_id: 
+			db_session.query(models.ShareGraphEvent).filter(models.ShareGraphEvent.member_id == member_id).filter(models.ShareGraphEvent.id == event_id).update({"is_active": 0})
+  			db_session.commit()
+		db_session.close()
+	except NoResultFound:
+		db_session.close()
+		raise EventNotFound
+
+def set_share_graph_events_inactive_by_group(group_id, member_id):
+	'''
+		Set all events in a group for a user as inactive
+
+		@param group_id: id of the group
+		@param member_id: id of the logged in user
+	'''
+	db_session = data_connection.new_session()
+	try:
+
+		events = db_session.query(models.ShareGraphEvent).filter(models.ShareGraphEvent.member_id == member_id).filter(models.ShareGraphEvent.group_id == group_id).all()
+  		for event in events:
+  			event.is_active = 0
+  			db_session.commit()
+		db_session.close()
+	except NoResultFound:
+		db_session.close()
+		raise EventNotFound
+

graphs/util/db_test.py

@@ -0,0 +1,12 @@
+from graphs.models import share_graph_event
+from django.test import TestCase
+from db import (get_all_share_graph_event, get_share_graph_event_by_id,
+	            get_share_graph_event_by_member_id, delete_share_graph_event,
+	            update_share_graph_event, add_share_graph_event)
+
+
+class share_graph_event_test(TestCase):
+	def basic_test(self):
+		share_event = add_share_graph_event()
+		# add tests after adding logic
+