Implement a comment/discussion system in GraphSpace

Dockerfile

@@ -0,0 +1,64 @@
+FROM ubuntu:16.04
+MAINTAINER Subramanyam Makam (makam.subramanyam.code@gmail.com)
+
+RUN apt-get update -y && \
+	apt-get install -y aptitude && \
+	aptitude install -y build-essential checkinstall software-properties-common python-software-properties && \
+	aptitude install -y wget git libreadline-gplv2-dev libncursesw5-dev libssl-dev libsqlite3-dev tk-dev libgdbm-dev libc6-dev && \
+	mkdir ~/Downloads && \
+	cd ~/Downloads/ && \
+	wget https://www.python.org/ftp/python/2.7.13/Python-2.7.13.tgz && \
+	tar -xvf Python-2.7.13.tgz && \
+	cd Python-2.7.13 && \
+	./configure && \
+	make && \
+	make install && \
+	aptitude install -y nodejs nodejs-legacy npm && \
+	npm install -g bower && \
+	cd && \
+	git config --global user.email "makam.subramanyam.code@gmail.com" && \
+	git config --global user.name "bruce-wayne99" && \
+	aptitude update && \
+	aptitude install -y postgresql postgresql-contrib && \
+	aptitude install -y python2.7-dev python-pip && \
+	pip install virtualenv && \
+	aptitude install -y openjdk-8-jre openjdk-8-jdk && \
+	echo oracle-java8-installer shared/accepted-oracle-license-v1-1 select true | debconf-set-selections && \
+	add-apt-repository -y ppa:webupd8team/java && \
+	aptitude update && \
+	aptitude install -y oracle-java8-installer && \
+	cd ~/Downloads && \
+	wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-5.5.1.tar.gz && \
+	tar xvzf elasticsearch-5.5.1.tar.gz && \
+	rm -f elasticsearch-5.5.1.tar.gz && \
+	mv elasticsearch-5.5.1 /elasticsearch && \
+	aptitude install tcl && \
+	wget http://download.redis.io/redis-stable.tar.gz && \
+	tar xzvf redis-stable.tar.gz && \
+	cd redis-stable && \
+	make && \
+	make install && \
+	mkdir /redis && \
+	cp redis.conf /redis/ && \
+	aptitude update && \
+	aptitude install -y zookeeperd && \
+	cd / && \ 
+	git clone -b comment-system https://github.com/bruce-wayne99/GraphSpace.git && \
+	aptitude install -y python-psycopg2 libpq-dev && \
+	chmod -R 777 /GraphSpace && \
+	rm -r /var/cache/
+
+USER postgres
+
+RUN	/etc/init.d/postgresql start && \
+	psql -c "CREATE DATABASE test;" && \
+	psql -c "ALTER USER postgres with PASSWORD '987654321';" && \
+	psql -d test -c "CREATE EXTENSION pg_trgm;" && \
+	psql -d test -c "CREATE EXTENSION btree_gin;"
+
+USER root
+
+RUN useradd -ms /bin/bash elasticsearch && \
+	chmod -R 777 /elasticsearch
+
+ENV JAVA_HOME /usr/lib/jvm/java-8-oracle

applications/comments/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

applications/comments/apps.py

@@ -0,0 +1,5 @@
+from django.apps import AppConfig
+
+
+class CommentsConfig(AppConfig):
+    name = 'comments'

applications/comments/controllers.py

@@ -0,0 +1,272 @@
+from sqlalchemy.exc import IntegrityError
+import applications.comments.dal as db
+import applications.graphs.dal as graphs_db
+from graphspace.exceptions import ErrorCodes, BadRequest
+from graphspace.wrappers import atomic_transaction
+
+
+@atomic_transaction
+def add_comment(request, text=None, graph_id=None, edges=None, nodes=None, is_closed=0, owner_email=None,
+                parent_comment_id=None, layout_id=None):
+    """
+
+	Parameters
+	----------
+	request: object
+		HTTP Request.
+	text: string
+		Comment message.
+	graph_id: Integer
+		Unique ID of each graph.
+	edges: List
+		List of edge names on associated with the comment.
+	nodes: List
+		List of node names on associated with the comment.
+	is_closed: Integer
+		Integer indicating if the comment is closed or not.
+	owner_email: string
+		Email ID of user who comment on the graph.
+	parent_comment_id: Integer
+		Unique ID of parent comment.
+	layout_id: Integer
+		Unique ID of layout.
+
+	Returns
+	-------
+	comment: Object
+		Comment Object.
+
+	"""
+    # Construct new comment to add to database
+    comment = db.add_comment(request.db_session, text=text, owner_email=owner_email,
+                             is_closed=is_closed, parent_comment_id=parent_comment_id)
+    comment_to_graph = db.add_comment_to_graph(request.db_session, comment_id=comment.id, graph_id=graph_id,
+                                               layout_id=layout_id)
+    # Add comment edges
+    if edges != None:
+        for edge_id in edges:
+            db.add_comment_to_edge(request.db_session, comment_id=comment.id, edge_id=edge_id)
+
+    # Add comment nodes
+    if nodes != None:
+        for node_id in nodes:
+            db.add_comment_to_node(request.db_session, comment_id=comment.id, node_id=node_id)
+
+    db.send_comment(comment, comment_to_graph, event="insert")
+    return comment
+
+
+def get_comment_by_graph_id(request, graph_id):
+
+    """
+	Parameters
+	----------
+	request: object
+		HTTP request.
+	graph_id: Integer
+		Unique ID of graph.
+
+	Returns
+	-------
+	return value: Object.
+		Comment Object.
+
+	"""
+    return db.get_comment_by_graph_id(request.db_session, graph_id=graph_id)
+
+
+def get_nodes_by_comment_id(request, comment_id):
+    """
+
+	Parameters
+	----------
+	request: object
+		HTTP request.
+	comment_id: Integer
+		Unique ID of comment.
+
+	Returns
+	-------
+	return value: List.
+		List of Node Objects.
+
+	"""
+    return db.get_nodes_by_comment_id(request.db_session, comment_id=comment_id)
+
+
+def get_edges_by_comment_id(request, comment_id):
+    """
+
+	Parameters
+	----------
+	request: object
+		HTTP request.
+	comment_id: Integer
+		Unique ID of comment.
+
+	Returns
+	-------
+	return value: List.
+		List of Edge Objects.
+
+	"""
+    return db.get_edges_by_comment_id(request.db_session, comment_id=comment_id)
+
+
+def get_comment_by_id(request, comment_id):
+    """
+
+	Parameters
+	----------
+	request: object
+		HTTP request.
+	comment_id: Integer
+		Unique ID of comment.
+
+	Returns
+	-------
+	return value: object.
+		Comment Object.
+
+	"""
+    return db.get_comment_by_id(request.db_session, id=comment_id)
+
+
+def get_comment_to_graph(request, comment_id):
+    """
+
+	Parameters
+	----------
+	request: object
+		HTTP request.
+	comment_id: Integer
+		Unique ID of comment.
+
+	Returns
+	-------
+	return value: object.
+		Comment Object.
+
+	"""
+    return db.get_comment_to_graph(request.db_session, id=comment_id)
+
+
+@atomic_transaction
+def edit_comment(request, comment_id=None, text=None, is_closed=None):
+    """
+
+	Parameters
+	----------
+	request: object
+		HTTP request.
+	comment_id: Integer
+		Unique ID of comment.
+	text: String
+		New comment message.
+	is_closed: Integer
+		Indicates if the comment is closed or not.
+
+	Returns
+	-------
+	return value: object
+		Edited Comment Object.
+
+	"""
+    updated_comment = {}
+
+    # Check if field is present or not.
+    if is_closed != None:
+        updated_comment['is_closed'] = is_closed
+    if text != None:
+        updated_comment['text'] = text
+        return db.edit_comment(request.db_session, id=comment_id, updated_comment=updated_comment)
+
+    # # Only top comment in a comment thread can be resolved.
+    comment = db.get_comment_by_id(request.db_session, id=comment_id)
+    if comment.serialize()['is_closed'] == 0 and is_closed == 1 and comment.serialize()[
+        'parent_comment_id'] != None:
+        raise Exception('Reply comments can not be resolved')
+
+    return db.update_comment(request.db_session, id=comment_id, updated_comment=updated_comment)
+
+
+@atomic_transaction
+def delete_comment(request, id=None):
+    """
+
+	Parameters
+	----------
+	request: object
+		HTTP request.
+	id: Integer
+		Unique ID of comment.
+
+	Returns
+	-------
+	return value: object
+		Deleted Comment Object.
+
+	"""
+    return db.delete_comment(request.db_session, id=id)
+
+
+def is_user_authorized_to_update_comment(request, username, comment_id):
+    """
+
+	Parameters
+	----------
+	request: object
+		HTTP request.
+	username: string
+		Email ID of user.
+	comment_id: integer
+		Unique ID of comment.
+
+	Returns
+	-------
+	is_authorized: bool
+		Returns True if the user is authorized to update comment else False.
+
+	"""
+    is_authorized = False
+    comment = db.get_comment_by_id(request.db_session, comment_id)
+
+    if comment is not None:  # Comment exists
+        if comment.owner_email == username:
+            is_authorized = True
+
+    return is_authorized
+
+
+def is_user_authorized_to_delete_comment(request, username, comment_id):
+    """
+
+	Parameters
+	----------
+	request: object
+		HTTP request.
+	username: string
+		Email ID of user.
+	comment_id: integer
+		Unique ID of comment.
+
+	Returns
+	-------
+	is_authorized: bool
+		Returns True if the user is authorized to delete comment else False.
+
+	"""
+    is_authorized = False
+
+    comment = db.get_comment_by_id(request.db_session, comment_id)
+    if comment is not None:
+        comment_to_graph = db.get_comment_to_graph(request.db_session, comment_id)
+        graph = graphs_db.get_graph_by_id(request.db_session, comment_to_graph.graph_id)
+
+    if comment is not None:  # Comment exists
+        if comment.owner_email == username:
+            is_authorized = True
+        elif graph.owner_email == username:
+            is_authorized = True
+
+    return is_authorized