Feat: Implement view sharing in operations with Manage Views widget (#2893)

Adds functionality to share custom views between operation members. Includes a 'Manage Views' widget allowing users to browse and apply shared views, as well as options for renaming views before sharing.  Addresses the need for collaborative view configurations within an operation.

Author: annapurna-gupta

AUTHORS

@@ -8,6 +8,7 @@ in alphabetic order by first name
 - Anveshan Lal <anveshanrx8@gmail.com>
 - Aravind Murali <aravindmurali711@gmail.com>
 - Aryan Gupta <work.aryangupta@gmail.com>
+- Annapurna Gupta <ganu48600@gmail.com>
 - Christian Rolf <c.rolf@fz-juelich.de>
 - Debajyoti Dasgupta <debajyotidasgupta6@gmail.com>
 - Hrithik Kumar Verma <vermahrithik812@gmail.com>

mslib/mscolab/file_manager.py

@@ -39,7 +39,7 @@
 from werkzeug.utils import secure_filename
 from sqlalchemy.exc import IntegrityError
 from mslib.utils.verify_waypoint_data import verify_waypoint_data
-from mslib.mscolab.models import db, Operation, Permission, User, Change, Message, ViewSettings
+from mslib.mscolab.models import db, Operation, Permission, User, Change, Message, ViewSettings, SharedView, ManageViews
 from mslib.mscolab.conf import mscolab_settings
 
 
@@ -780,6 +780,85 @@ def import_permissions(self, import_op_id, current_op_id, u_id):
             db.session.rollback()
             return False, None, "Some error occurred! Could not import permissions. Please try again."
 
+    def list_views(self, op_id, user):
+        if not self.is_member(user.id, op_id):
+            return False, "Access denied", {}
+        views = ManageViews.query.filter_by(op_id=op_id).all()
+        views_data = []
+        for v in views:
+            views_data.append({
+                "id": v.id,
+                "op_id": v.op_id,
+                "u_id": v.u_id,
+                "view_name": v.view_name,
+                "created_at": v.created_at.isoformat() if v.created_at else None,
+                "username": v.user.username if v.user else None,
+            })
+        return True, "Views fetched successfully", views_data
+
+    def check_view_name(self, user, op_id, view_name):
+        if not (self.is_member(user.id, op_id) or self.is_viewer(user.id, op_id)):
+            return False, "Access denied"
+        return ManageViews.query.filter_by(op_id=op_id, view_name=view_name).first() is not None
+
+    def save_manage_view_metadata(self, user, op_id, view_name):
+        if not (self.is_member(user.id, op_id) or self.is_viewer(user.id, op_id)):
+            return False, "Access denied"
+        try:
+            data = ManageViews(
+                op_id=op_id,
+                u_id=user.id,
+                view_name=view_name
+            )
+            db.session.add(data)
+            db.session.commit()
+            return True, "Metadata saved to database"
+        except Exception as e:
+            logging.error("Error saving metadata for user %s: %s", user.id, str(e))
+            return False, f"Error saving metadata: {str(e)}"
+
+    def share_view(self, op_id, view_name, user, settings_data):
+        """Share view settings with other users in the same operation."""
+        if not (self.is_member(user.id, op_id) or self.is_viewer(user.id, op_id)):
+            return False, "Access denied"
+        try:
+            shared_data = json.dumps(settings_data)
+            existing = SharedView.query.filter_by(op_id=op_id, u_id=user.id, view_name=view_name).first()
+            if existing:
+                existing.settings = shared_data
+                existing.updated_at = datetime.datetime.now(tz=datetime.timezone.utc)
+                db.session.commit()
+                return True, "Shared view settings updated successfully"
+            else:
+                view_setting = SharedView(
+                    op_id=op_id,
+                    u_id=user.id,
+                    view_name=view_name,
+                    shared_data=shared_data
+                )
+                db.session.add(view_setting)
+                db.session.commit()
+                return True, "View settings shared successfully"
+        except Exception as e:
+            logging.error("Error sharing view settings for user %s: %s", user.id, str(e))
+            return False, f"Failed to share view settings: {str(e)}"
+
+    def get_shared_views(self, op_id, view_name, user):
+        """Retrieve shared view settings for a user from the database."""
+        if not self.is_member(user.id, op_id):
+            return False, "Access denied", {}
+        if view_name:
+            shared_view = SharedView.query.filter_by(op_id=op_id, view_name=view_name).first()
+            if not shared_view:
+                return False, "No shared view found with that ID", {}
+        try:
+            setting = json.loads(shared_view.shared_data)
+            if not isinstance(setting, dict):
+                return False, f"Invalid settings type after parsing: {type(shared_view).__name__}", {}
+            return True, "View settings shared successfully", setting
+        except Exception as e:
+            return False, f"Error parsing settings: {str(e)}", {}
+
     def save_view_settings(self, op_id, user, view_settings):
         """Save view settings for an operation and user to the database."""
         if not self.is_member(user.id, op_id) and self.is_viewer(user.id, op_id):

mslib/mscolab/migrations/versions/2daa5c5142a1_new_models.py

@@ -0,0 +1,63 @@
+"""new_models
+
+Revision ID: 2daa5c5142a1
+Revises: 922e4d9c94e2
+Create Date: 2025-09-27 16:29:39.069372
+
+"""
+from alembic import op
+import sqlalchemy as sa
+import mslib.mscolab.custom_migration_types as cu
+
+
+# revision identifiers, used by Alembic.
+revision = '2daa5c5142a1'
+down_revision = '922e4d9c94e2'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('manageviews',
+    sa.Column('id', sa.Integer(), autoincrement=True, nullable=False),
+    sa.Column('op_id', sa.Integer(), nullable=False),
+    sa.Column('u_id', sa.Integer(), nullable=False),
+    sa.Column('view_name', sa.String(length=255), nullable=False),
+    sa.Column('created_at', cu.AwareDateTime(), nullable=True),
+    sa.ForeignKeyConstraint(['op_id'], ['operations.id'], name=op.f('fk_manageviews_op_id_operations')),
+    sa.ForeignKeyConstraint(['u_id'], ['users.id'], name=op.f('fk_manageviews_u_id_users')),
+    sa.PrimaryKeyConstraint('id', name=op.f('pk_manageviews'))
+    )
+    op.create_table('sharedviews',
+    sa.Column('id', sa.Integer(), autoincrement=True, nullable=False),
+    sa.Column('op_id', sa.Integer(), nullable=False),
+    sa.Column('u_id', sa.Integer(), nullable=False),
+    sa.Column('view_name', sa.String(length=255), nullable=False),
+    sa.Column('shared_data', sa.JSON(), nullable=False),
+    sa.Column('created_at', cu.AwareDateTime(), nullable=True),
+    sa.ForeignKeyConstraint(['op_id'], ['operations.id'], name=op.f('fk_sharedviews_op_id_operations')),
+    sa.ForeignKeyConstraint(['u_id'], ['users.id'], name=op.f('fk_sharedviews_u_id_users')),
+    sa.PrimaryKeyConstraint('id', name=op.f('pk_sharedviews')),
+    sa.UniqueConstraint('op_id', 'view_name', name='_op_view_uc')
+    )
+    op.create_table('viewsettings',
+    sa.Column('op_id', sa.Integer(), nullable=False),
+    sa.Column('u_id', sa.Integer(), nullable=False),
+    sa.Column('settings', sa.JSON(), nullable=True),
+    sa.Column('created_at', cu.AwareDateTime(), nullable=True),
+    sa.Column('updated_at', cu.AwareDateTime(), nullable=True),
+    sa.ForeignKeyConstraint(['op_id'], ['operations.id'], name=op.f('fk_viewsettings_op_id_operations')),
+    sa.ForeignKeyConstraint(['u_id'], ['users.id'], name=op.f('fk_viewsettings_u_id_users')),
+    sa.PrimaryKeyConstraint('op_id', 'u_id', name=op.f('pk_viewsettings')),
+    sa.UniqueConstraint('u_id', 'op_id', name='u_id_op_id')
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table('viewsettings')
+    op.drop_table('sharedviews')
+    op.drop_table('manageviews')
+    # ### end Alembic commands ###

mslib/mscolab/migrations/versions/4ad0fd989443_viewsettings.py

@@ -242,3 +242,38 @@ def __init__(self, op_id, u_id, settings):
         self.op_id = int(op_id)
         self.u_id = int(u_id)
         self.settings = settings
+
+
+class SharedView(db.Model):
+
+    __tablename__ = "sharedviews"
+    id = db.Column(db.Integer, primary_key=True, autoincrement=True)  # noqa: A003
+    op_id = db.Column(db.Integer, db.ForeignKey('operations.id'), nullable=False)
+    u_id = db.Column(db.Integer, db.ForeignKey('users.id'), nullable=False)
+    view_name = db.Column(db.String(255), nullable=False)
+    shared_data = db.Column(db.JSON, nullable=False)
+    created_at = db.Column(AwareDateTime, default=lambda: datetime.datetime.now(tz=datetime.timezone.utc))
+    user = db.relationship('User', backref='shared_views')
+    __table_args__ = (db.UniqueConstraint('op_id', 'view_name', name='_op_view_uc'),)
+
+    def __init__(self, op_id, view_name, shared_data, u_id):
+        self.op_id = int(op_id)
+        self.u_id = int(u_id)
+        self.view_name = str(view_name)
+        self.shared_data = shared_data
+
+
+class ManageViews(db.Model):
+
+    __tablename__ = "manageviews"
+    id = db.Column(db.Integer, primary_key=True, autoincrement=True)  # noqa: A003
+    op_id = db.Column(db.Integer, db.ForeignKey('operations.id'), nullable=False)
+    u_id = db.Column(db.Integer, db.ForeignKey('users.id'), nullable=False)
+    view_name = db.Column(db.String(255), nullable=False)
+    created_at = db.Column(AwareDateTime, default=lambda: datetime.datetime.now(tz=datetime.timezone.utc))
+    user = db.relationship('User', backref='manage_views')
+
+    def __init__(self, op_id, u_id, view_name):
+        self.op_id = int(op_id)
+        self.u_id = int(u_id)
+        self.view_name = str(view_name)

mslib/mscolab/models.py

@@ -873,6 +873,97 @@ def reset_request():
         return render_template('errors/403.html'), 403
 
 
+@APP.route("/share_view", methods=["POST"])
+@verify_user
+def share_view():
+    try:
+        view_settings = request.form.get('view_settings', False)
+        view_name = request.form.get('view_name', None)
+        op_id = request.form.get('op_id')
+        user = g.user
+        if not all([view_settings, view_name, op_id]):
+            return jsonify({"success": False, "message": "Missing required parameters"}), 400
+        if isinstance(view_settings, str):
+            settings_data = json.loads(view_settings)
+        else:
+            settings_data = view_settings
+        success, message = fm.share_view(op_id, view_name, user, settings_data)
+        if success:
+            return jsonify({"success": True, "message": message}), 200
+        else:
+            return jsonify({"success": False, "message": message}), 400
+    except json.JSONDecodeError as e:
+        logging.error("Invalid view_settings JSON: %s", str(e))
+        return jsonify({"success": False, "message": "Invalid view_settings format"}), 400
+    except Exception as e:
+        logging.error("Error in share_view endpoint: %s", str(e))
+        return jsonify({"success": False, "message": f"Server error: {str(e)}"}), 500
+
+
+@APP.route("/get_shared_view", methods=["GET"])
+@verify_user
+def get_shared_view():
+    op_id = request.form.get('op_id')
+    view_name = request.form.get('view_name')
+    user = g.user
+    try:
+        success, message, settings = fm.get_shared_views(op_id, view_name, user)
+        if success:
+            return jsonify({"success": True, "message": message, "settings": settings}), 200
+        else:
+            return jsonify({"success": False, "message": message, "settings": settings}), 400
+    except Exception as e:
+        logging.error("Error in get_shared_view endpoint: %s", str(e))
+        return jsonify({"success": False, "message": f"Server error: {str(e)}", "settings": {}}), 500
+
+
+@APP.route("/get_views_name", methods=["GET"])
+@verify_user
+def get_views_name():
+    op_id = request.args.get('op_id')
+    user = g.user
+    try:
+        success, message, views = fm.list_views(op_id, user)
+        if success:
+            return jsonify({"success": True, "message": message, "views": views}), 200
+        else:
+            return jsonify({"success": False, "message": message, "views": views}), 400
+    except Exception as e:
+        logging.error("Error listing views: %s", str(e))
+        return jsonify({"success": False, "message": f"Error listing views: {str(e)}", "views": []}), 500
+
+
+@APP.route("/manage_sharedView_metadata", methods=["POST"])
+@verify_user
+def manage_sharedView_metadata():
+    view_name = request.form.get('view_name', None)
+    op_id = request.form.get('op_id', None)
+    user = g.user
+    if not all([view_name, op_id]):
+        return jsonify({"success": False, "message": "Missing required parameters"}), 400
+    success, message = fm.save_manage_view_metadata(user, op_id, view_name)
+    if success:
+        return jsonify({"success": True, "message": message}), 200
+    else:
+        return jsonify({"success": False, "message": message}), 400
+
+
+@APP.route("/check_view_names", methods=["GET"])
+@verify_user
+def check_view_names():
+    op_id = request.form.get('op_id')
+    view_name = request.form.get('view_name')
+    user = g.user
+    if not all([op_id is not None, view_name is not None]):
+        return jsonify({"success": False, "message": "Missing required parameters", "exists": False}), 400
+    try:
+        exists = fm.check_view_name(user, op_id, view_name)
+        return jsonify({"success": True, "exists": exists}), 200
+    except Exception as e:
+        logging.error("Error checking view name: %s", str(e))
+        return jsonify({"success": False, "message": f"Error checking view name: {str(e)}", "exists": False}), 400
+
+
 @APP.route("/save_operation_view_settings", methods=["POST"])
 @verify_user
 def save_operation_view_settings():
@@ -896,7 +987,6 @@ def save_operation_view_settings():
             logging.error("Missing operation ID in payload")
             return jsonify({"success": False, "message": "Missing operation ID"}), 400
 
-        user = g.user
         success, message = fm.save_view_settings(op_id, user, settings_data)
         if success:
             return jsonify({"success": True, "message": message}), 200