Chamilo is a learning management system focused on ease of use and accessibility
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
chamilo-lms/src/CoreBundle/Entity/AbstractResource.php

448 lines
13 KiB

<?php
declare(strict_types=1);
/* For licensing terms, see /license.txt */
namespace Chamilo\CoreBundle\Entity;
use ApiPlatform\Core\Annotation\ApiProperty;
use ApiPlatform\Core\Annotation\ApiSubresource;
use Chamilo\CoreBundle\Security\Authorization\Voter\ResourceNodeVoter;
use Chamilo\CourseBundle\Entity\CGroup;
use Doctrine\Common\Collections\Criteria;
use Doctrine\ORM\Mapping as ORM;
use Exception;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\HttpFoundation\File\UploadedFile;
use Symfony\Component\Serializer\Annotation\Groups;
use Symfony\Component\Validator\Constraints as Assert;
/**
* @ORM\MappedSuperclass
* @ORM\HasLifecycleCallbacks
* @ORM\EntityListeners({"Chamilo\CoreBundle\Entity\Listener\ResourceListener"})
*/
abstract class AbstractResource
{
/**
* @ApiProperty(iri="http://schema.org/contentUrl")
* @Groups({"resource_file:read", "resource_node:read", "document:read", "media_object_read"})
*/
public ?string $contentUrl = null;
/**
* @ApiProperty(iri="http://schema.org/contentUrl")
* @Groups({"resource_file:read", "resource_node:read", "document:read", "media_object_read"})
*/
public ?string $downloadUrl = null;
/**
* @Groups({"resource_file:read", "resource_node:read", "document:read", "document:write", "media_object_read"})
*/
public ?string $contentFile = null;
/**
* @Assert\Valid()
* @ApiSubresource()
* @Groups({"resource_node:read", "resource_node:write", "document:write" })
* @ORM\OneToOne(
* targetEntity="Chamilo\CoreBundle\Entity\ResourceNode",
* cascade={"persist", "remove"},
* orphanRemoval=true
* )AbstractResource
* @ORM\JoinColumn(name="resource_node_id", referencedColumnName="id", onDelete="CASCADE")
*/
public ?ResourceNode $resourceNode = null;
/**
* @Groups({"resource_node:read", "resource_node:write", "document:read", "document:write"})
*/
public ?int $parentResourceNode = 0;
/**
* @ApiProperty(iri="http://schema.org/image")
*/
public ?UploadedFile $uploadFile = null;
/**
* @var AbstractResource|ResourceInterface
*/
public $parentResource;
/**
* @Groups({"resource_node:read", "document:read"})
*
* @var null|array<int, array<string, null|\Chamilo\CoreBundle\Entity\Course|\Chamilo\CoreBundle\Entity\Session|\Chamilo\CoreBundle\Entity\Usergroup|\Chamilo\CourseBundle\Entity\CGroup|int|string>>
*/
public ?array $resourceLinkListFromEntity = null;
/**
* Use when sending a request to Api platform.
* Temporal array that saves the resource link list that will be filled by CreateResourceNodeFileAction.php.
*/
public array $resourceLinkList = [];
/**
* Use when sending request to Chamilo.
* Temporal array of objects locates the resource link list that will be filled by CreateResourceNodeFileAction.php.
*
* @var ResourceLink[]
*/
public array $resourceLinkEntityList = [];
abstract public function getResourceName(): string;
abstract public function setResourceName(string $name);
//abstract public function setResourceProperties(FormInterface $form, $course, $session, $fileType);
public function getResourceLinkEntityList()
{
return $this->resourceLinkEntityList;
}
public function addLink(ResourceLink $link)
{
$this->resourceLinkEntityList[] = $link;
return $this;
}
public function addCourseLink(Course $course, Session $session = null, CGroup $group = null, int $visibility = ResourceLink::VISIBILITY_PUBLISHED)
{
if (null === $this->getParent()) {
throw new Exception('addCourseLink requires to set the parent first.');
}
$resourceLink = new ResourceLink();
$resourceLink
->setVisibility($visibility)
->setCourse($course)
->setSession($session)
->setGroup($group)
;
$rights = [];
switch ($visibility) {
case ResourceLink::VISIBILITY_PENDING:
case ResourceLink::VISIBILITY_DRAFT:
$editorMask = ResourceNodeVoter::getEditorMask();
$resourceRight = new ResourceRight();
$resourceRight
->setMask($editorMask)
->setRole(ResourceNodeVoter::ROLE_CURRENT_COURSE_TEACHER)
;
$rights[] = $resourceRight;
break;
}
if (!empty($rights)) {
foreach ($rights as $right) {
//$resourceLink->addResourceRights($right);
$resourceLink->addResourceRight($right);
}
}
if ($this->hasResourceNode()) {
$resourceNode = $this->getResourceNode();
$exists = $resourceNode->getResourceLinks()->exists(
function ($key, $element) use ($course, $session, $group) {
return
$course === $element->getCourse() &&
$session === $element->getSession() &&
$group === $element->getGroup();
}
);
if ($exists) {
return $this;
}
$resourceNode->addResourceLink($resourceLink);
} else {
$this->addLink($resourceLink);
}
return $this;
}
public function addGroupLink(Course $course, Session $session = null, CGroup $group = null)
{
$resourceLink = new ResourceLink();
$resourceLink
->setCourse($course)
->setSession($session)
->setGroup($group)
->setVisibility(ResourceLink::VISIBILITY_PUBLISHED)
;
if ($this->hasResourceNode()) {
$resourceNode = $this->getResourceNode();
$exists = $resourceNode->getResourceLinks()->exists(
function ($key, $element) use ($group) {
if ($element->getGroup()) {
return $group->getIid() === $element->getGroup()->getIid();
}
}
);
if ($exists) {
return $this;
}
$resourceNode->addResourceLink($resourceLink);
} else {
$this->addLink($resourceLink);
}
return $this;
}
public function addUserLink(User $user, Course $course = null, Session $session = null, CGroup $group = null)
{
$resourceLink = new ResourceLink();
$resourceLink
->setVisibility(ResourceLink::VISIBILITY_PUBLISHED)
->setUser($user)
->setCourse($course)
->setSession($session)
->setGroup($group)
;
if ($this->hasResourceNode()) {
$resourceNode = $this->getResourceNode();
$exists = $resourceNode->getResourceLinks()->exists(
function ($key, $element) use ($user) {
if ($element->hasUser()) {
return $user->getId() === $element->getUser()->getId();
}
}
);
if ($exists) {
error_log('Link already exist for user: '.$user->getUsername().', skipping');
return $this;
}
error_log('New link can be added for user: '.$user->getUsername());
$resourceNode->addResourceLink($resourceLink);
} else {
$this->addLink($resourceLink);
}
return $this;
}
public function setParent(ResourceInterface $parent)
{
$this->parentResource = $parent;
return $this;
}
public function getParent()
{
return $this->parentResource;
}
/**
* @param array $userList User id list
*/
public function addResourceToUserList(
array $userList,
Course $course = null,
Session $session = null,
CGroup $group = null
) {
if (!empty($userList)) {
foreach ($userList as $user) {
$this->addUserLink($user, $course, $session, $group);
}
}
return $this;
}
public function setResourceLinkArray(array $links)
{
$this->resourceLinkList = $links;
return $this;
}
public function getResourceLinkArray()
{
return $this->resourceLinkList;
}
public function getResourceLinkListFromEntity()
{
return $this->resourceLinkListFromEntity;
}
public function setResourceLinkListFromEntity(): void
{
$resourceNode = $this->getResourceNode();
$links = $resourceNode->getResourceLinks();
$resourceLinkList = [];
foreach ($links as $link) {
$resourceLinkList[] = [
'id' => $link->getId(),
'session' => $link->getSession(),
'course' => $link->getCourse(),
'visibility' => $link->getVisibility(),
'visibilityName' => $link->getVisibilityName(),
'group' => $link->getGroup(),
'userGroup' => $link->getUserGroup(),
];
}
$this->resourceLinkListFromEntity = $resourceLinkList;
}
public function hasParentResourceNode(): bool
{
return null !== $this->parentResourceNode && 0 !== $this->parentResourceNode;
}
public function setParentResourceNode(?int $resourceNode): self
{
$this->parentResourceNode = $resourceNode;
return $this;
}
public function getParentResourceNode()
{
return $this->parentResourceNode;
}
public function hasUploadFile(): bool
{
return null !== $this->uploadFile;
}
public function getUploadFile()
{
return $this->uploadFile;
}
public function setUploadFile(?UploadedFile $file): self
{
$this->uploadFile = $file;
return $this;
}
public function setResourceNode(ResourceNode $resourceNode): self
{
$this->resourceNode = $resourceNode;
return $this;
}
public function hasResourceNode(): bool
{
return $this->resourceNode instanceof ResourceNode;
}
public function getResourceNode(): ?ResourceNode
{
return $this->resourceNode;
}
public function getFirstResourceLink(): ?ResourceLink
{
$resourceNode = $this->getResourceNode();
if ($resourceNode && $resourceNode->getResourceLinks()->count()) {
$result = $resourceNode->getResourceLinks()->first();
if ($result) {
return $result;
}
}
return null;
}
/**
* See ResourceLink to see the visibility constants. Example: ResourceLink::VISIBILITY_DELETED.
*/
/*public function getLinkVisibility(Course $course, Session $session = null): ?ResourceLink
{
return $this->getFirstResourceLinkFromCourseSession($course, $session)->getVisibility();
}*/
public function isVisible(Course $course, Session $session = null): bool
{
$link = $this->getFirstResourceLinkFromCourseSession($course, $session);
if (null === $link) {
return false;
}
return ResourceLink::VISIBILITY_PUBLISHED === $link->getVisibility();
}
public function getFirstResourceLinkFromCourseSession(Course $course, Session $session = null): ?ResourceLink
{
/*$criteria = Criteria::create();
$criteria
->where(Criteria::expr()->eq('course', $course->getId()))
->andWhere(
Criteria::expr()->eq('session', $session)
)
->setFirstResult(0)
->setMaxResults(1)
;*/
$resourceNode = $this->getResourceNode();
$result = null;
if ($resourceNode && $resourceNode->getResourceLinks()->count() > 0) {
$links = $resourceNode->getResourceLinks();
$found = false;
$link = null;
foreach ($links as $link) {
if ($link->getCourse() === $course && $link->getSession() === $session) {
$found = true;
break;
}
}
//$result = $links->matching($criteria)->count();
//var_dump($result);
if ($found) {
return $link;
}
}
return null;
}
public function getUsersAndGroupSubscribedToResource(): array
{
$users = [];
$groups = [];
$everyone = false;
$links = $this->getResourceNode()->getResourceLinks();
foreach ($links as $link) {
if ($link->hasUser()) {
$users[] = $link->getUser()->getId();
continue;
}
if ($link->hasGroup()) {
$groups[] = $link->getGroup()->getIid();
}
}
if (empty($users) && empty($groups)) {
$everyone = true;
}
return [
'everyone' => $everyone,
'users' => $users,
'groups' => $groups,
];
}
}