OpenSlides/openslides/agenda/projector.py

299 lines
10 KiB
Python
Raw Normal View History

2018-12-23 11:05:38 +01:00
from collections import defaultdict
2019-02-21 17:04:59 +01:00
from typing import Any, Dict, List, Union
2019-02-15 12:17:08 +01:00
from ..users.projector import get_user_name
from ..utils.projector import (
AllData,
ProjectorElementException,
2019-02-15 12:17:08 +01:00
get_config,
register_projector_slide,
)
2015-06-24 23:36:36 +02:00
2018-12-23 11:05:38 +01:00
# Important: All functions have to be prune. This means, that thay can only
# access the data, that they get as argument and do not have any
# side effects.
2018-12-23 11:05:38 +01:00
async def get_sorted_agenda_items(all_data: AllData) -> List[Dict[str, Any]]:
2019-03-08 11:59:07 +01:00
"""
Returns all sorted agenda items by id first and then weight, resulting in
ordered items, if some have the same weight.
"""
return sorted(
sorted(all_data["agenda/item"].values(), key=lambda item: item["id"]),
key=lambda item: item["weight"],
)
async def get_flat_tree(all_data: AllData, parent_id: int = 0) -> List[Dict[str, Any]]:
2018-12-23 11:05:38 +01:00
"""
Build the item tree from all_data.
2018-12-23 11:05:38 +01:00
Only build the tree from elements unterneath parent_id.
2018-12-23 11:05:38 +01:00
Returns a list of two element tuples where the first element is the item title
and the second a List with children as two element tuples.
2015-06-24 23:36:36 +02:00
"""
2019-01-06 16:22:33 +01:00
2018-12-23 11:05:38 +01:00
# Build a dict from an item_id to all its children
children: Dict[int, List[int]] = defaultdict(list)
2019-02-28 09:09:32 +01:00
if "agenda/item" in all_data:
for item in await get_sorted_agenda_items(all_data):
2019-02-28 09:09:32 +01:00
if item["type"] == 1: # only normal items
children[item["parent_id"] or 0].append(item["id"])
2019-02-21 16:15:21 +01:00
tree = []
async def get_children(item_ids: List[int], depth: int) -> None:
2019-02-21 16:15:21 +01:00
for item_id in item_ids:
item = all_data["agenda/item"][item_id]
title_information = item["title_information"]
2019-11-13 14:00:53 +01:00
title_information["_agenda_item_number"] = item["item_number"]
2019-02-21 16:15:21 +01:00
tree.append(
{
"title_information": title_information,
"collection": item["content_object"]["collection"],
2019-02-21 16:15:21 +01:00
"depth": depth,
}
)
await get_children(children[item_id], depth + 1)
2019-02-21 16:15:21 +01:00
await get_children(children[parent_id], 0)
2019-02-21 16:15:21 +01:00
return tree
async def item_list_slide(
2019-02-21 14:40:07 +01:00
all_data: AllData, element: Dict[str, Any], projector_id: int
) -> Dict[str, Any]:
2015-06-24 23:36:36 +02:00
"""
2018-12-23 11:05:38 +01:00
Item list slide.
2019-01-06 16:22:33 +01:00
2018-12-23 11:05:38 +01:00
Returns all root items or all children of an item.
"""
2019-02-21 16:15:21 +01:00
only_main_items = element.get("only_main_items", True)
2015-06-24 23:36:36 +02:00
2019-02-21 16:15:21 +01:00
if only_main_items:
2019-01-12 23:01:42 +01:00
agenda_items = []
for item in await get_sorted_agenda_items(all_data):
2019-02-21 16:15:21 +01:00
if item["parent_id"] is None and item["type"] == 1:
title_information = item["title_information"]
2019-11-13 14:00:53 +01:00
title_information["_agenda_item_number"] = item["item_number"]
2019-02-21 16:15:21 +01:00
agenda_items.append(
{
"title_information": title_information,
2019-02-21 16:15:21 +01:00
"collection": item["content_object"]["collection"],
}
)
else:
agenda_items = await get_flat_tree(all_data)
2015-06-24 23:36:36 +02:00
2019-01-12 23:01:42 +01:00
return {"items": agenda_items}
2016-10-05 18:25:50 +02:00
2016-09-12 11:05:34 +02:00
async def list_of_speakers_slide(
2019-02-21 14:40:07 +01:00
all_data: AllData, element: Dict[str, Any], projector_id: int
) -> Dict[str, Any]:
2016-09-12 11:05:34 +02:00
"""
2018-12-23 11:05:38 +01:00
List of speakers slide.
Returns all usernames, that are on the list of speaker of a slide.
2016-10-05 18:25:50 +02:00
"""
list_of_speakers_id = element.get("id")
2018-12-23 11:05:38 +01:00
if list_of_speakers_id is None:
2019-02-15 12:17:08 +01:00
raise ProjectorElementException("id is required for list of speakers slide")
2018-12-23 11:05:38 +01:00
return await get_list_of_speakers_slide_data(all_data, list_of_speakers_id)
2019-02-21 14:40:07 +01:00
async def get_list_of_speakers_slide_data(
all_data: AllData, list_of_speakers_id: int
) -> Dict[str, Any]:
2018-12-23 11:05:38 +01:00
try:
list_of_speakers = all_data["agenda/list-of-speakers"][list_of_speakers_id]
2018-12-23 11:05:38 +01:00
except KeyError:
raise ProjectorElementException(
f"List of speakers {list_of_speakers_id} does not exist"
)
title_information = list_of_speakers["title_information"]
# try to get the agenda item for the content object (which must not exist)
agenda_item_id = all_data[list_of_speakers["content_object"]["collection"]][
list_of_speakers["content_object"]["id"]
].get("agenda_item_id")
if agenda_item_id:
title_information["agenda_item_number"] = all_data["agenda/item"][
agenda_item_id
]["item_number"]
2019-01-06 16:22:33 +01:00
2019-02-15 12:17:08 +01:00
# Partition speaker objects to waiting, current and finished
speakers_waiting = []
speakers_finished = []
current_speaker = None
for speaker in list_of_speakers["speakers"]:
user = await get_user_name(all_data, speaker["user_id"])
2019-02-15 12:17:08 +01:00
formatted_speaker = {
"user": user,
"marked": speaker["marked"],
"weight": speaker["weight"],
"end_time": speaker["end_time"],
}
if speaker["begin_time"] is None and speaker["end_time"] is None:
speakers_waiting.append(formatted_speaker)
elif speaker["begin_time"] is not None and speaker["end_time"] is None:
current_speaker = formatted_speaker
else:
speakers_finished.append(formatted_speaker)
# sort speakers
speakers_waiting = sorted(speakers_waiting, key=lambda s: s["weight"])
speakers_finished = sorted(speakers_finished, key=lambda s: s["end_time"])
number_of_last_speakers = await get_config(all_data, "agenda_show_last_speakers")
number_of_next_speakers = await get_config(all_data, "agenda_show_next_speakers")
2019-02-15 12:17:08 +01:00
if number_of_last_speakers == 0:
speakers_finished = []
else:
2019-09-02 08:05:45 +02:00
# Take the last speakers
speakers_finished = speakers_finished[-number_of_last_speakers:]
2019-02-15 12:17:08 +01:00
2019-09-02 08:05:45 +02:00
if number_of_next_speakers != -1:
speakers_waiting = speakers_waiting[:number_of_next_speakers]
2019-02-15 12:17:08 +01:00
return {
"waiting": speakers_waiting,
"current": current_speaker,
"finished": speakers_finished,
"content_object_collection": list_of_speakers["content_object"]["collection"],
"title_information": title_information,
2019-02-15 12:17:08 +01:00
}
async def get_current_list_of_speakers_id_for_projector(
2019-02-21 17:04:59 +01:00
all_data: AllData, projector: Dict[str, Any]
) -> Union[int, None]:
"""
Search for elements, that do have a list of speakers:
2019-02-21 17:04:59 +01:00
Try to get a model by the collection and id in the element. This
model needs to have a 'list_of_speakers_id'. This list of speakers
must exist. The first matching element is taken.
"""
2019-02-21 17:04:59 +01:00
elements = projector["elements"]
list_of_speakers_id = None
2019-02-21 14:40:07 +01:00
for element in elements:
if "id" not in element:
continue
collection = element["name"]
id = element["id"]
if collection not in all_data or id not in all_data[collection]:
continue
model = all_data[collection][id]
if "list_of_speakers_id" not in model:
2019-02-21 14:40:07 +01:00
continue
if not model["list_of_speakers_id"] in all_data["agenda/list-of-speakers"]:
2019-02-21 14:40:07 +01:00
continue
list_of_speakers_id = model["list_of_speakers_id"]
2019-02-21 14:40:07 +01:00
break
return list_of_speakers_id
2019-02-21 17:04:59 +01:00
async def get_reference_projector(
all_data: AllData, projector_id: int
) -> Dict[str, Any]:
2019-02-21 17:04:59 +01:00
"""
Returns the reference projector to the given projector (by id)
"""
try:
this_projector = all_data["core/projector"][projector_id]
except KeyError:
raise ProjectorElementException(f"Projector {projector_id} does not exist")
reference_projector_id = this_projector["reference_projector_id"] or projector_id
try:
reference_projector = all_data["core/projector"][reference_projector_id]
except KeyError:
raise ProjectorElementException(
f"Projector {reference_projector_id} does not exist"
)
return reference_projector
async def current_list_of_speakers_slide(
2019-02-21 17:04:59 +01:00
all_data: AllData, element: Dict[str, Any], projector_id: int
) -> Dict[str, Any]:
"""
The current list of speakers slide. Creates the data for the given projector.
"""
reference_projector = await get_reference_projector(all_data, projector_id)
list_of_speakers_id = await get_current_list_of_speakers_id_for_projector(
all_data, reference_projector
)
if list_of_speakers_id is None: # no element found
2019-02-21 14:40:07 +01:00
return {}
return await get_list_of_speakers_slide_data(all_data, list_of_speakers_id)
async def current_speaker_chyron_slide(
2019-02-21 17:04:59 +01:00
all_data: AllData, element: Dict[str, Any], projector_id: int
) -> Dict[str, Any]:
"""
Returns the username for the current speaker.
"""
# get projector for color information
projector = all_data["core/projector"][projector_id]
slide_data = {
"background_color": projector["chyron_background_color"],
"font_color": projector["chyron_font_color"],
}
reference_projector = await get_reference_projector(all_data, projector_id)
list_of_speakers_id = await get_current_list_of_speakers_id_for_projector(
all_data, reference_projector
)
if list_of_speakers_id is None: # no element found
return slide_data
2019-02-21 17:04:59 +01:00
# get list of speakers to search current speaker
2019-02-21 17:04:59 +01:00
try:
list_of_speakers = all_data["agenda/list-of-speakers"][list_of_speakers_id]
2019-02-21 17:04:59 +01:00
except KeyError:
raise ProjectorElementException(
f"List of speakers {list_of_speakers_id} does not exist"
)
2019-02-21 17:04:59 +01:00
# find current speaker
current_speaker = None
for speaker in list_of_speakers["speakers"]:
2019-02-21 17:04:59 +01:00
if speaker["begin_time"] is not None and speaker["end_time"] is None:
current_speaker = await get_user_name(all_data, speaker["user_id"])
break
2019-02-21 17:04:59 +01:00
if current_speaker is not None:
slide_data["current_speaker"] = current_speaker
return slide_data
2019-02-21 17:04:59 +01:00
def register_projector_slides() -> None:
2019-02-21 16:15:21 +01:00
register_projector_slide("agenda/item-list", item_list_slide)
register_projector_slide("agenda/list-of-speakers", list_of_speakers_slide)
register_projector_slide(
"agenda/current-list-of-speakers", current_list_of_speakers_slide
)
register_projector_slide(
"agenda/current-list-of-speakers-overlay", current_list_of_speakers_slide
)
2019-02-21 17:04:59 +01:00
register_projector_slide(
"agenda/current-speaker-chyron", current_speaker_chyron_slide
)