Skip to content

Commit

Permalink
[FEATURE] Studio Group, see PR #340
Browse files Browse the repository at this point in the history 
commit 03505c1
Author: ferishili <[email protected]>
Date:   Fri Aug 23 11:04:55 2024 +0200

    according to request

commit 50da049
Author: ferishili <[email protected]>
Date:   Fri Aug 9 12:25:38 2024 +0200

    introducing studio group
    fixes #339
  • Loading branch information
@chfsx
chfsx committed Dec 17, 2024
1 parent 5edb41e commit 2d62afc
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 22 deletions.
58 changes: 39 additions & 19 deletions classes/Event/class.xoctEventGUI.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -855,7 +855,16 @@ public function opencaststudio(): void
$this->main_tpl->setOnScreenMessage('failure', $this->txt('msg_no_access'), true);
$this->cancel();
}
$this->addCurrentUserToProducers();
// Consider studio group as default.
$user_group_name = PluginConfig::F_GROUP_STUDIO;

// Looking for "Edit Video" permission, to add user to producers group.
if (ilObjOpenCastAccess::hasPermission(ilObjOpenCastAccess::PERMISSION_EDIT_VIDEOS)) {
$user_group_name = PluginConfig::F_GROUP_PRODUCERS;
}

$this->addCurrentUserToGroup($user_group_name);

// redirect to oc studio
$base = rtrim(PluginConfig::getConfig(PluginConfig::F_API_BASE), "/");
$base = str_replace('/api', '', $base);
Expand Down Expand Up @@ -889,7 +898,7 @@ public function cut(): void
$this->cancel();
}

$this->addCurrentUserToProducers();
$this->addCurrentUserToGroup();

// redirect
$cutting_link = $event->publications()->getCuttingLink();
Expand Down Expand Up @@ -982,7 +991,7 @@ public function annotate(): void

// check access
if (ilObjOpenCastAccess::hasPermission(ilObjOpenCastAccess::PERMISSION_EDIT_VIDEOS) || ilObjOpenCastAccess::hasWriteAccess()) {
$this->addCurrentUserToProducers();
$this->addCurrentUserToGroup();
}

// redirect
Expand Down Expand Up @@ -1393,30 +1402,41 @@ protected function createHyperlinks(string $intro_text): string
return $intro_text;
}

protected function addCurrentUserToProducers(): void
/**
* Adds the current user to the specified group.
* Producers group is the default selected group. (PluginConfig::F_GROUP_PRODUCERS)
*
* @param string $group_config_name the group config name (default PluginConfig::F_GROUP_PRODUCERS)
*
*/
protected function addCurrentUserToGroup(string $group_config_name = PluginConfig::F_GROUP_PRODUCERS): void
{
$xoctUser = xoctUser::getInstance($this->user);
// add user to ilias producers
// add user to the group
$sleep = false;
try {
if ($group_producers = PluginConfig::getConfig(PluginConfig::F_GROUP_PRODUCERS)) {
$ilias_producers = Group::find($group_producers);
$sleep = $ilias_producers->addMember($xoctUser);
$group_config_value = PluginConfig::getConfig($group_config_name);
if (!empty($group_config_value)) {
$group_obj = Group::find($group_config_value);
$sleep = $group_obj->addMember($xoctUser);
}
} catch (xoctException $e) {
}

// add user to series producers
if ($this->objectSettings->getSeriesIdentifier() !== null) {
$series = $this->seriesRepository->find($this->objectSettings->getSeriesIdentifier());
if ($series->getAccessPolicies()->merge($this->ACLUtils->getUserRolesACL($xoctUser))) {
$this->seriesRepository->updateACL(
new UpdateSeriesACLRequest(
$series->getIdentifier(),
new UpdateSeriesACLRequestPayload($series->getAccessPolicies())
)
);
$sleep = true;
// Extra things to do for producers group.
if ($group_config_name === PluginConfig::F_GROUP_PRODUCERS) {
// add user to series producers
if ($this->objectSettings->getSeriesIdentifier() !== null) {
$series = $this->seriesRepository->find($this->objectSettings->getSeriesIdentifier());
if ($series->getAccessPolicies()->merge($this->ACLUtils->getUserRolesACL($xoctUser))) {
$this->seriesRepository->updateACL(
new UpdateSeriesACLRequest(
$series->getIdentifier(),
new UpdateSeriesACLRequestPayload($series->getAccessPolicies())
)
);
$sleep = true;
}
}
}

Expand Down
4 changes: 4 additions & 0 deletions configuration/default_config.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@
<name>group_producers</name>
<value><![CDATA[ROLE_GROUP_ILIAS]]></value>
</xoct_conf>
<xoct_conf>
<name>group_studio</name>
<value><![CDATA[ROLE_GROUP_STUDIO]]></value>
</xoct_conf>
<xoct_conf>
<name>identifier_to_uppercase</name>
<value><![CDATA[1]]></value>
Expand Down
4 changes: 3 additions & 1 deletion lang/ilias_de.lang
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,9 @@ config_sign_thumbnail_links_time_info#:#Wie lange der Link für Thumbnail gülti
config_sign_thumbnail_links_with_ip#:#Für Client-IP signieren
config_groups#:#Opencast-Gruppen
config_group_producers#:#ILIAS Producers
config_group_producers_info#:#Benutzer mit dem Recht "Videos editieren" werden vom Plugin in der hier angegebenen Opencast-Gruppe eingeschrieben, um dadurch Zugriff auf Opencast zu erhalten.
config_group_studio#:#Opencast Studio
config_group_studio_info#:#Benutzer mit dem Recht "Aufzeichen" werden vom Plugin in der hier angegebenen Opencast-Gruppe eingeschrieben, um dadurch Zugriff auf Opencast Studio zu erhalten.
config_std_roles#:#Standardrollen
config_std_roles_info#:#Die hier angegebenen Rollen erhalten Schreib- und Leserechte beim Erstellen eines Events oder einer Serie.
config_role_user_actions#:#Zusätzliche ACL Aktionen
Expand All @@ -115,7 +118,6 @@ config_use_modals_info#:#Wenn aktiviert: Beim Abspielen von Videos wird kein neu
config_workflow_info#:#ID des Workflows, welcher nach dem Hochladen eines Videos in Opencast angewendet wird.
config_workflow_unpublish_info#:#ID des Workflows, welcher vor dem Löschen eines Videos in Opencast angewendet wird. Benötigt API-Version 1.1.0. Wird bei neueren Opencast-Versionen nicht mehr benötigt, da im Löschvorgang integriert.
config_user_mapping_info#:#Benutzerfeld in ILIAS, welches zur Identifikation eines Benutzers in Opencast verwendet werden soll. <br><b>Achtung: Die E-Mail-Adresse kann je nach ILIAS-Konfiguration durch den Benutzer selbst geändert werden. In diesem Fall sollte die E-Mail-Adresse auf keinen Fall als Mapping verwendet werden.</b>
config_group_producers_info#:#Benutzer mit dem Recht "Videos editieren" werden vom Plugin in der hier angegebenen Opencast-Gruppe eingeschrieben, um dadurch Zugriff auf Opencast zu erhalten.
config_role_user_prefix_info#:#Benutzereigene Rolle in Opencast. Wird auf Serien gesetzt, um dem Benutzer genügend Rechte in Opencast einzuräumen. Bsp: ROLE_USER_&#123IDENTIFIER}
config_role_owner_prefix_info#:#Gibt den Besitzer eines Events an. Diese Rolle muss NICHT in Opencast existieren. Bsp: ROLE_OWNER_&#123IDENTIFIER}. NICHT den gleichen Wert wie für Benutzerrolle wählen.
config_identifier_to_uppercase#:#User-Mapping in Großbuchstaben
Expand Down
4 changes: 3 additions & 1 deletion lang/ilias_en.lang
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,9 @@ config_reset_terms#:#Updated Terms of Use
config_reset_terms_info#:#Request users to (re-)accept the terms of use. This option should only be activated if the term's content has changed.
config_groups#:#Opencast Groups
config_group_producers#:#ILIAS Producers
config_group_producers_info#:#Users with the permission "Edit Videos" will be assigned to this Opencast group to obtain access to Opencast.
config_group_studio#:#Opencast Studio
config_group_studio_info#:#Users with the permission "Record" will be assigned to this Opencast group to obtain access to Opencast Studio.
config_std_roles#:#Standard roles
config_std_roles_info#:#These roles are given read and write permissions when creating a series or an event.
config_role_user_actions#:#Additional ACL actions
Expand All @@ -119,7 +122,6 @@ config_use_modals_info#:#When active: the video player will not be opened in a s
config_workflow_info#:#ID of the workflow which will be executed in Opencast after uploading an event.
config_workflow_unpublish_info#:#ID of the workflow which will be executed in Opencast before deleting an event. Requires API version 1.1.0. Not required in latest Opencast versions, since it's integrated in the delete workflow.
config_user_mapping_info#:#Userfield in ILIAS which will be used to identify the user in Opencast.<br><b>Warning: depending on the ILIAS configuration, users may be able to change their own email address. It is strongly recommended not to use email as mapping in that case.</b>
config_group_producers_info#:#Users with the permission "Edit Videos" will be assigned to this Opencast group to obtain access to Opencast.
config_role_user_prefix_info#:#User specific role in Opencast. Is used to grant the user permission on a series in Opencast. Example: ROLE_USER_&#123IDENTIFIER}
config_role_owner_prefix_info#:#Indicates the owner of an event. This rules doesn't have to exist in Opencast. Example: ROLE_OWNER_&#123IDENTIFIER}. DO NOT use the same value as for the user specific role.
config_identifier_to_uppercase#:#User mapping in uppercase
Expand Down
4 changes: 3 additions & 1 deletion src/Model/Config/PluginConfig.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ class PluginConfig extends ActiveRecord
public const CACHE_DATABASE = 2;
public const F_USER_MAPPING = 'user_mapping';
public const F_GROUP_PRODUCERS = 'group_producers';
public const F_GROUP_STUDIO = 'group_studio';
public const F_STD_ROLES = 'std_roles';
public const F_ROLE_USER_PREFIX = 'role_user_prefix';
public const F_ROLE_USER_ACTIONS = 'role_user_actions';
Expand Down Expand Up @@ -157,8 +158,9 @@ class PluginConfig extends ActiveRecord
/**
* @var array
*/
public static $groups = [
public static array $groups = [
self::F_GROUP_PRODUCERS,
self::F_GROUP_STUDIO,
];

/**
Expand Down

0 comments on commit 2d62afc

Please sign in to comment.