synapse-old/synapse/api/events/utils.py

65 lines
2.2 KiB
Python
Raw Normal View History

2014-09-23 08:37:32 -06:00
# -*- coding: utf-8 -*-
# Copyright 2014 OpenMarket Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
2014-09-24 04:37:06 -06:00
from .room import (
RoomMemberEvent, RoomJoinRulesEvent, RoomPowerLevelsEvent,
RoomAddStateLevelEvent, RoomSendEventLevelEvent, RoomOpsPowerLevelsEvent,
RoomAliasesEvent, RoomCreateEvent,
)
2014-09-23 08:37:32 -06:00
def prune_event(event):
""" Prunes the given event of all keys we don't know about or think could
potentially be dodgy.
2014-09-24 08:27:59 -06:00
This is used when we "redact" an event. We want to remove all fields that
2014-09-23 08:37:32 -06:00
the user has specified, but we do want to keep necessary information like
type, state_key etc.
"""
# Remove all extraneous fields.
event.unrecognized_keys = {}
2014-09-24 04:37:06 -06:00
new_content = {}
def add_fields(*fields):
for field in fields:
if field in event.content:
new_content[field] = event.content[field]
2014-09-23 08:37:32 -06:00
if event.type == RoomMemberEvent.TYPE:
2014-09-24 04:37:06 -06:00
add_fields("membership")
elif event.type == RoomCreateEvent.TYPE:
add_fields("creator")
elif event.type == RoomJoinRulesEvent.TYPE:
add_fields("join_rule")
elif event.type == RoomPowerLevelsEvent.TYPE:
# TODO: Actually check these are valid user_ids etc.
add_fields("default")
for k, v in event.content.items():
if k.startswith("@") and isinstance(v, (int, long)):
new_content[k] = v
elif event.type == RoomAddStateLevelEvent.TYPE:
add_fields("level")
elif event.type == RoomSendEventLevelEvent.TYPE:
add_fields("level")
elif event.type == RoomOpsPowerLevelsEvent.TYPE:
2014-09-24 08:27:59 -06:00
add_fields("kick_level", "ban_level", "redact_level")
2014-09-24 04:37:06 -06:00
elif event.type == RoomAliasesEvent.TYPE:
add_fields("aliases")
2014-09-23 08:37:32 -06:00
event.content = new_content
return event