Internal: Add missing, untreated, plugins from 1.11.x

pull/5309/head
Yannick Warnier 1 year ago
parent edb333e480
commit 5c65d51f4f
  1. 241
      public/plugin/ai_helper/AiHelperPlugin.php
  2. 171
      public/plugin/ai_helper/Entity/Requests.php
  3. 46
      public/plugin/ai_helper/README.md
  4. 16
      public/plugin/ai_helper/install.php
  5. 18
      public/plugin/ai_helper/lang/english.php
  6. 18
      public/plugin/ai_helper/lang/french.php
  7. 18
      public/plugin/ai_helper/lang/spanish.php
  8. 6
      public/plugin/ai_helper/plugin.php
  9. 332
      public/plugin/ai_helper/src/openai/OpenAi.php
  10. 74
      public/plugin/ai_helper/src/openai/OpenAiUrl.php
  11. 57
      public/plugin/ai_helper/tool/answers.php
  12. 216
      public/plugin/ai_helper/tool/learnpath.php
  13. 16
      public/plugin/ai_helper/uninstall.php
  14. 553
      public/plugin/check_extra_field_author_company/CheckExtraFieldAuthorsCompanyPlugin.php
  15. 30
      public/plugin/check_extra_field_author_company/README.md
  16. 5
      public/plugin/check_extra_field_author_company/index.php
  17. 9
      public/plugin/check_extra_field_author_company/install.php
  18. 17
      public/plugin/check_extra_field_author_company/plugin.php
  19. 8
      public/plugin/check_extra_field_author_company/uninstall.php
  20. 6
      public/plugin/cleandeletedfiles/README.md
  21. 192
      public/plugin/cleandeletedfiles/admin.php
  22. 10
      public/plugin/cleandeletedfiles/config.php
  23. 5
      public/plugin/cleandeletedfiles/index.php
  24. 1
      public/plugin/cleandeletedfiles/install.php
  25. 17
      public/plugin/cleandeletedfiles/lang/english.php
  26. 17
      public/plugin/cleandeletedfiles/lang/french.php
  27. 17
      public/plugin/cleandeletedfiles/lang/spanish.php
  28. 11
      public/plugin/cleandeletedfiles/plugin.php
  29. 34
      public/plugin/cleandeletedfiles/src/CleanDeletedFilesPlugin.php
  30. 47
      public/plugin/cleandeletedfiles/src/ajax.php
  31. 202
      public/plugin/coursehomenotify/CourseHomeNotifyPlugin.php
  32. 152
      public/plugin/coursehomenotify/Entity/Notification.php
  33. 99
      public/plugin/coursehomenotify/Entity/NotificationRelUser.php
  34. 17
      public/plugin/coursehomenotify/README.md
  35. 100
      public/plugin/coursehomenotify/configure.php
  36. 52
      public/plugin/coursehomenotify/content.php
  37. 8
      public/plugin/coursehomenotify/install.php
  38. 17
      public/plugin/coursehomenotify/lang/english.php
  39. 17
      public/plugin/coursehomenotify/lang/spanish.php
  40. 4
      public/plugin/coursehomenotify/plugin.php
  41. 8
      public/plugin/coursehomenotify/uninstall.php
  42. 250
      public/plugin/embedregistry/EmbedRegistryPlugin.php
  43. 198
      public/plugin/embedregistry/Entity/Embed.php
  44. 14
      public/plugin/embedregistry/README.md
  45. 2
      public/plugin/embedregistry/install.php
  46. 22
      public/plugin/embedregistry/lang/english.php
  47. 22
      public/plugin/embedregistry/lang/french.php
  48. 22
      public/plugin/embedregistry/lang/spanish.php
  49. 4
      public/plugin/embedregistry/plugin.php
  50. 309
      public/plugin/embedregistry/start.php
  51. 2
      public/plugin/embedregistry/uninstall.php
  52. 72
      public/plugin/embedregistry/view.php
  53. 37
      public/plugin/embedregistry/view/start.tpl
  54. 22
      public/plugin/externalnotificationconnect/README.md
  55. 5
      public/plugin/externalnotificationconnect/install.php
  56. 18
      public/plugin/externalnotificationconnect/lang/english.php
  57. 18
      public/plugin/externalnotificationconnect/lang/french.php
  58. 18
      public/plugin/externalnotificationconnect/lang/spanish.php
  59. 5
      public/plugin/externalnotificationconnect/plugin.php
  60. 71
      public/plugin/externalnotificationconnect/src/Entity/AccessToken.php
  61. 241
      public/plugin/externalnotificationconnect/src/ExternalNotificationConnectPlugin.php
  62. 21
      public/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectHookObserver.php
  63. 56
      public/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectLearningPathCreatedHookObserver.php
  64. 50
      public/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectPortfolioItemAddedHookObserver.php
  65. 33
      public/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectPortfolioItemDeletedHookObserver.php
  66. 50
      public/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectPortfolioItemEditedHookObserver.php
  67. 44
      public/plugin/externalnotificationconnect/src/Hook/ExternalNotificationConnectPortfolioItemVisibilityHookObserver.php
  68. 191
      public/plugin/externalnotificationconnect/src/Traits/RequestTrait.php
  69. 5
      public/plugin/externalnotificationconnect/uninstall.php
  70. 674
      public/plugin/extramenufromwebservice/LICENSE.txt
  71. 10
      public/plugin/extramenufromwebservice/README.md
  72. 4
      public/plugin/extramenufromwebservice/config.php
  73. 114
      public/plugin/extramenufromwebservice/index.php
  74. 7
      public/plugin/extramenufromwebservice/install.php
  75. 15
      public/plugin/extramenufromwebservice/lang/english.php
  76. 15
      public/plugin/extramenufromwebservice/lang/french.php
  77. 15
      public/plugin/extramenufromwebservice/lang/spanish.php
  78. 189
      public/plugin/extramenufromwebservice/lib/extramenufromwebservice_plugin.class.php
  79. 5
      public/plugin/extramenufromwebservice/plugin.php
  80. 108
      public/plugin/extramenufromwebservice/resources/css/extramenufromwebservice.css
  81. 8
      public/plugin/extramenufromwebservice/resources/js/extramenufromwebservice.js
  82. 5
      public/plugin/extramenufromwebservice/uninstall.php
  83. 255
      public/plugin/h5pimport/Entity/H5pImport.php
  84. 383
      public/plugin/h5pimport/Entity/H5pImportLibrary.php
  85. 267
      public/plugin/h5pimport/Entity/H5pImportResults.php
  86. 307
      public/plugin/h5pimport/H5pImportPlugin.php
  87. 674
      public/plugin/h5pimport/LICENSE.txt
  88. 40
      public/plugin/h5pimport/README.md
  89. 5
      public/plugin/h5pimport/config.php
  90. 8
      public/plugin/h5pimport/install.php
  91. 23
      public/plugin/h5pimport/lang/english.php
  92. 23
      public/plugin/h5pimport/lang/french.php
  93. 23
      public/plugin/h5pimport/lang/spanish.php
  94. 5
      public/plugin/h5pimport/plugin.php
  95. 375
      public/plugin/h5pimport/src/H5pImplementation.php
  96. 78
      public/plugin/h5pimport/src/H5pPackageImporter.php
  97. 327
      public/plugin/h5pimport/src/H5pPackageTools.php
  98. 183
      public/plugin/h5pimport/src/ZipPackageImporter.php
  99. 90
      public/plugin/h5pimport/src/ajax.php
  100. 240
      public/plugin/h5pimport/start.php
  101. Some files were not shown because too many files have changed in this diff Show More

@ -0,0 +1,241 @@
<?php
/* For license terms, see /license.txt */
use Chamilo\PluginBundle\Entity\AiHelper\Requests;
use Doctrine\ORM\Tools\SchemaTool;
/**
* Description of AiHelperPlugin.
*
* @author Christian Beeznest <christian.fasanando@beeznest.com>
*/
class AiHelperPlugin extends Plugin
{
public const TABLE_REQUESTS = 'plugin_ai_helper_requests';
public const OPENAI_API = 'openai';
protected function __construct()
{
$version = '1.1';
$author = 'Christian Fasanando';
$message = 'Description';
$settings = [
$message => 'html',
'tool_enable' => 'boolean',
'api_name' => [
'type' => 'select',
'options' => $this->getApiList(),
],
'api_key' => 'text',
'organization_id' => 'text',
'tool_lp_enable' => 'boolean',
'tool_quiz_enable' => 'boolean',
'tokens_limit' => 'text',
];
parent::__construct($version, $author, $settings);
}
/**
* Get the list of apis availables.
*
* @return array
*/
public function getApiList()
{
$list = [
self::OPENAI_API => 'OpenAI',
];
return $list;
}
/**
* Get the completion text from openai.
*
* @return string
*/
public function openAiGetCompletionText(
string $prompt,
string $toolName
) {
if (!$this->validateUserTokensLimit(api_get_user_id())) {
return [
'error' => true,
'message' => $this->get_lang('ErrorTokensLimit'),
];
}
require_once __DIR__.'/src/openai/OpenAi.php';
$apiKey = $this->get('api_key');
$organizationId = $this->get('organization_id');
$ai = new OpenAi($apiKey, $organizationId);
$temperature = 0.2;
$model = 'gpt-3.5-turbo-instruct';
$maxTokens = 2000;
$frequencyPenalty = 0;
$presencePenalty = 0.6;
$topP = 1.0;
$complete = $ai->completion([
'model' => $model,
'prompt' => $prompt,
'temperature' => $temperature,
'max_tokens' => $maxTokens,
'frequency_penalty' => $frequencyPenalty,
'presence_penalty' => $presencePenalty,
'top_p' => $topP,
]);
$result = json_decode($complete, true);
$resultText = '';
if (!empty($result['choices'])) {
$resultText = $result['choices'][0]['text'];
// saves information of user results.
$values = [
'user_id' => api_get_user_id(),
'tool_name' => $toolName,
'prompt' => $prompt,
'prompt_tokens' => (int) $result['usage']['prompt_tokens'],
'completion_tokens' => (int) $result['usage']['completion_tokens'],
'total_tokens' => (int) $result['usage']['total_tokens'],
];
$this->saveRequest($values);
}
return $resultText;
}
/**
* Validates tokens limit of a user per current month.
*/
public function validateUserTokensLimit(int $userId): bool
{
$em = Database::getManager();
$repo = $em->getRepository('ChamiloPluginBundle:AiHelper\Requests');
$startDate = api_get_utc_datetime(
null,
false,
true)
->modify('first day of this month')->setTime(00, 00, 00)
;
$endDate = api_get_utc_datetime(
null,
false,
true)
->modify('last day of this month')->setTime(23, 59, 59)
;
$qb = $repo->createQueryBuilder('e')
->select('sum(e.totalTokens) as total')
->andWhere('e.requestedAt BETWEEN :dateMin AND :dateMax')
->andWhere('e.userId = :user')
->setMaxResults(1)
->setParameters(
[
'dateMin' => $startDate->format('Y-m-d h:i:s'),
'dateMax' => $endDate->format('Y-m-d h:i:s'),
'user' => $userId,
]
);
$result = $qb->getQuery()->getOneOrNullResult();
$totalTokens = !empty($result) ? (int) $result['total'] : 0;
$valid = true;
$tokensLimit = $this->get('tokens_limit');
if (!empty($tokensLimit)) {
$valid = ($totalTokens <= (int) $tokensLimit);
}
return $valid;
}
/**
* Get the plugin directory name.
*/
public function get_name(): string
{
return 'ai_helper';
}
/**
* Get the class instance.
*
* @staticvar AiHelperPlugin $result
*/
public static function create(): AiHelperPlugin
{
static $result = null;
return $result ?: $result = new self();
}
/**
* Save user information of openai request.
*
* @return int
*/
public function saveRequest(array $values)
{
$em = Database::getManager();
$objRequest = new Requests();
$objRequest
->setUserId($values['user_id'])
->setToolName($values['tool_name'])
->setRequestedAt(new DateTime())
->setRequestText($values['prompt'])
->setPromptTokens($values['prompt_tokens'])
->setCompletionTokens($values['completion_tokens'])
->setTotalTokens($values['total_tokens'])
;
$em->persist($objRequest);
$em->flush();
return $objRequest->getId();
}
/**
* Install the plugin. Set the database up.
*/
public function install()
{
$em = Database::getManager();
if ($em->getConnection()->getSchemaManager()->tablesExist([self::TABLE_REQUESTS])) {
return;
}
$schemaTool = new SchemaTool($em);
$schemaTool->createSchema(
[
$em->getClassMetadata(Requests::class),
]
);
}
/**
* Unistall plugin. Clear the database.
*/
public function uninstall()
{
$em = Database::getManager();
if (!$em->getConnection()->getSchemaManager()->tablesExist([self::TABLE_REQUESTS])) {
return;
}
$schemaTool = new SchemaTool($em);
$schemaTool->dropSchema(
[
$em->getClassMetadata(Requests::class),
]
);
}
}

@ -0,0 +1,171 @@
<?php
/* For licensing terms, see /license.txt */
namespace Chamilo\PluginBundle\Entity\AiHelper;
use Doctrine\ORM\Mapping as ORM;
/**
* Class Platform.
*
* @package Chamilo\PluginBundle\Entity\AiHelper
*
* @ORM\Table(name="plugin_ai_helper_requests")
* @ORM\Entity()
*/
class Requests
{
/**
* @var int
*
* @ORM\Column(name="id", type="integer")
* @ORM\Id()
* @ORM\GeneratedValue()
*/
protected $id;
/**
* @var int
*
* @ORM\Column(name="user_id", type="integer")
*/
private $userId;
/**
* @var string
*
* @ORM\Column(name="tool_name", type="string")
*/
private $toolName;
/**
* @var \DateTime
*
* @ORM\Column(name="requested_at", type="datetime", nullable=true)
*/
private $requestedAt;
/**
* @var string
*
* @ORM\Column(name="request_text", type="string")
*/
private $requestText;
/**
* @var int
*
* @ORM\Column(name="prompt_tokens", type="integer")
*/
private $promptTokens;
/**
* @var int
*
* @ORM\Column(name="completion_tokens", type="integer")
*/
private $completionTokens;
/**
* @var int
*
* @ORM\Column(name="total_tokens", type="integer")
*/
private $totalTokens;
public function getUserId(): int
{
return $this->userId;
}
public function setUserId(int $userId): Requests
{
$this->userId = $userId;
return $this;
}
public function getId(): int
{
return $this->id;
}
public function setId(int $id): Requests
{
$this->id = $id;
return $this;
}
public function getRequestedAt(): \DateTime
{
return $this->requestedAt;
}
public function setRequestedAt(\DateTime $requestedAt): Requests
{
$this->requestedAt = $requestedAt;
return $this;
}
public function getRequestText(): string
{
return $this->requestText;
}
public function setRequestText(string $requestText): Requests
{
$this->requestText = $requestText;
return $this;
}
public function getPromptTokens(): int
{
return $this->promptTokens;
}
public function setPromptTokens(int $promptTokens): Requests
{
$this->promptTokens = $promptTokens;
return $this;
}
public function getCompletionTokens(): int
{
return $this->completionTokens;
}
public function setCompletionTokens(int $completionTokens): Requests
{
$this->completionTokens = $completionTokens;
return $this;
}
public function getTotalTokens(): int
{
return $this->totalTokens;
}
public function setTotalTokens(int $totalTokens): Requests
{
$this->totalTokens = $totalTokens;
return $this;
}
public function getToolName(): string
{
return $this->toolName;
}
public function setToolName(string $toolName): Requests
{
$this->toolName = $toolName;
return $this;
}
}

@ -0,0 +1,46 @@
AI Helper plugin
======
Version 1.1
> This plugin is meant to be later integrated into Chamilo (in a major version
release).
The AI helper plugin integrates into parts of the platform that seem the most useful to teachers/trainers or learners.
Because available Artificial Intelligence (to use the broad term) now allows us to ask for meaningful texts to be generated, we can use those systems to pre-generate content, then let the teacher/trainer review the content before publication.
Currently, this plugin is only integrated into:
- exercises: in the Aiken import form, scrolling down
- learnpaths: option to create one with openai
### OpenAI/ChatGPT
The plugin, created in early 2023, currently only supports OpenAI's ChatGPT API.
Create an account at https://platform.openai.com/signup (if you already have an API account, go
to https://platform.openai.com/login), then generate a secret key at https://platform.openai.com/account/api-keys
or click on "Personal" -> "View API keys".
Click the "Create new secret key" button, copy the key and use it to fill the "API key" field on the
plugin configuration page.
# Changelog
## v1.1
Added tracking for requests and differential settings to enable only in exercises, only in learning paths, or both.
To update from v1.0, execute the following queries manually.
```sql
CREATE TABLE plugin_ai_helper_requests (
id int(11) NOT NULL AUTO_INCREMENT,
user_id int(11) NOT NULL,
tool_name varchar(255) COLLATE utf8_unicode_ci NOT NULL,
requested_at datetime DEFAULT NULL,
request_text varchar(255) COLLATE utf8_unicode_ci NOT NULL,
prompt_tokens int(11) NOT NULL,
completion_tokens int(11) NOT NULL,
total_tokens int(11) NOT NULL,
PRIMARY KEY (id)
) DEFAULT CHARACTER SET utf8 COLLATE `utf8_unicode_ci` ENGINE = InnoDB;
```
If you got this update through Git, you will also need to run `composer install` to update the autoload mechanism.

@ -0,0 +1,16 @@
<?php
/* For license terms, see /license.txt */
/**
* Install the Ai Helper Plugin.
*
* @package chamilo.plugin.ai_helper
*/
require_once __DIR__.'/../../main/inc/global.inc.php';
require_once __DIR__.'/AiHelperPlugin.php';
if (!api_is_platform_admin()) {
exit('You must have admin permissions to install plugins');
}
AiHelperPlugin::create()->install();

@ -0,0 +1,18 @@
<?php
/* For license terms, see /license.txt */
$strings['plugin_title'] = 'AI Helper plugin';
$strings['plugin_comment'] = 'Connects to AI services to help teachers and students through the generation of smart content, like creating questions on any given topic.';
$strings['Description'] = 'Artificial Intelligence services (to use the broad term) now allow you to ask for meaningful texts to be generated, we can use those systems to pre-generate content, then let the teacher/trainer review the content before publication. See Aiken import page in the exercises tool once enabled.';
$strings['tool_enable'] = 'Enable plugin';
$strings['api_name'] = 'AI API to use';
$strings['api_key'] = 'Api key';
$strings['api_key_help'] = 'Secret key generated for your Ai api';
$strings['organization_id'] = 'Organization ID';
$strings['organization_id_help'] = 'In case your api account is from an organization.';
$strings['OpenAI'] = 'OpenAI';
$strings['tool_lp_enable'] = 'Enable in learning paths';
$strings['tool_quiz_enable'] = 'Enable in exercises (Aiken section)';
$strings['tokens_limit'] = 'AI tokens limit';
$strings['tokens_limit_help'] = 'Limit the maximum number of tokens each user has available per month, to avoid high costs of service.';
$strings['ErrorTokensLimit'] = 'Sorry, you have reached the maximum number of tokens or requests configured by the platform administrator for the current calendar month. Please contact your support team or wait for next month before you can issue new requests to the AI Helper.';

@ -0,0 +1,18 @@
<?php
/* For license terms, see /license.txt */
$strings['plugin_title'] = 'Assistant IA.';
$strings['plugin_comment'] = "Système d'intelligence artificielle (IA) intégré aux endroits qui semblent les plus utiles aux enseignants pour la génération de contenu d'exemple, comme la création de banques de questions sur n'importe quel sujet.";
$strings['Description'] = "L'intelligence artificielle (pour utiliser le terme large) disponible aujourd'hui vous permet de demander la génération de textes réalistes sur n'importe quel sujet. Vous pouvez utiliser ces systèmes pour pré-générer du contenu, et que l'enseignant/formateur puisse perfectionner le contenu avant sa publication.";
$strings['tool_enable'] = 'Activer le plug-in';
$strings['api_name'] = "API de l'IA pour se connecter";
$strings['api_key'] = "API key";
$strings['api_key_help'] = 'Clé secrète générée pour votre API AI';
$strings['organization_id'] = "ID de l'organisation";
$strings['organization_id_help'] = "Si votre compte api provient d'une organisation.";
$strings['OpenAI'] = 'OpenAI';
$strings['tool_lp_enable'] = "Activer dans les parcours";
$strings['tool_quiz_enable'] = "Activer dans les exercices";
$strings['tokens_limit'] = "Limite de jetons IA";
$strings['tokens_limit_help'] = 'Limiter le nombre maximum de jetons disponibles pour chaque utilisateur, par mois, pour éviter des frais de service surdimensionnés.';
$strings['ErrorTokensLimit'] = 'Désolé, vous avez atteint le nombre maximum de jetons ou de requêtes configurés par l\'administrateur de la plateforme pour le mois civil en cours. Veuillez contacter votre équipe d\'assistance ou attendre le mois prochain avant de pouvoir envoyer de nouvelles demandes à AI Helper.';

@ -0,0 +1,18 @@
<?php
/* For license terms, see /license.txt */
$strings['plugin_title'] = 'Asistente de IA.';
$strings['plugin_comment'] = 'Este plugin se integra en la plataforma para habilitar la generación automatizada de contenido inteligente, como preguntas de elección múltiple.';
$strings['Description'] = 'Debido a que la Inteligencia Artificial (para usar el término amplio) disponible ahora nos permite solicitar que se generen textos significativos, podemos usar esos sistemas para generar contenido previamente y luego dejar que el maestro/entrenador revise el contenido antes de publicarlo..';
$strings['tool_enable'] = 'Habilitar complemento';
$strings['api_name'] = 'API IA para conectar';
$strings['api_key'] = 'Clave API';
$strings['api_key_help'] = 'Clave secreta generada para su API de IA';
$strings['organization_id'] = 'Identificación de la organización';
$strings['organization_id_help'] = 'En caso de que su cuenta API sea de una organización.';
$strings['OpenAI'] = 'OpenAI';
$strings['tool_lp_enable'] = "Activarlo en las lecciones";
$strings['tool_quiz_enable'] = "Activarlo en los ejercicios";
$strings['tokens_limit'] = "Limite de tokens IA";
$strings['tokens_limit_help'] = 'Limitar la cantidad máxima de tokens disponibles por usuario por mes para evitar un alto costo de servicio.';
$strings['ErrorTokensLimit'] = 'Lo sentimos, ha alcanzado la cantidad máxima de tokens o solicitudes configuradas por el administrador de la plataforma para el mes calendario actual. Comuníquese con su equipo de soporte o espere hasta el próximo mes antes de poder enviar nuevas solicitudes a AI Helper.';

@ -0,0 +1,6 @@
<?php
/* For license terms, see /license.txt */
require_once __DIR__.'/AiHelperPlugin.php';
$plugin_info = AiHelperPlugin::create()->get_info();

@ -0,0 +1,332 @@
<?php
/* For licensing terms, see /license.txt */
require_once 'OpenAiUrl.php';
class OpenAi
{
private $model = "gpt-3.5-turbo-instruct"; // See https://platform.openai.com/docs/models for possible models
private $headers;
private $contentTypes;
private $timeout = 0;
private $streamMethod;
public function __construct(
string $apiKey,
string $organizationId = ''
) {
$this->contentTypes = [
"application/json" => "Content-Type: application/json",
"multipart/form-data" => "Content-Type: multipart/form-data",
];
$this->headers = [
$this->contentTypes["application/json"],
"Authorization: Bearer $apiKey",
];
if (!empty($organizationId)) {
$this->headers[] = "OpenAI-Organization: $organizationId";
}
}
/**
* @return bool|string
*/
public function listModels()
{
$url = OpenAiUrl::fineTuneModel();
return $this->sendRequest($url, 'GET');
}
/**
* @param $model
*
* @return bool|string
*/
public function retrieveModel($model)
{
$model = "/$model";
$url = OpenAiUrl::fineTuneModel().$model;
return $this->sendRequest($url, 'GET');
}
/**
* @param $opts
* @param null $stream
*
* @return bool|string
*/
public function completion($opts, $stream = null)
{
if ($stream != null && array_key_exists('stream', $opts)) {
if (!$opts['stream']) {
throw new Exception('Please provide a stream function.');
}
$this->streamMethod = $stream;
}
$opts['model'] = $opts['model'] ?? $this->model;
$url = OpenAiUrl::completionsURL();
return $this->sendRequest($url, 'POST', $opts);
}
/**
* @param $opts
*
* @return bool|string
*/
public function createEdit($opts)
{
$url = OpenAiUrl::editsUrl();
return $this->sendRequest($url, 'POST', $opts);
}
/**
* @param $opts
*
* @return bool|string
*/
public function image($opts)
{
$url = OpenAiUrl::imageUrl()."/generations";
return $this->sendRequest($url, 'POST', $opts);
}
/**
* @param $opts
*
* @return bool|string
*/
public function imageEdit($opts)
{
$url = OpenAiUrl::imageUrl()."/edits";
return $this->sendRequest($url, 'POST', $opts);
}
/**
* @param $opts
*
* @return bool|string
*/
public function createImageVariation($opts)
{
$url = OpenAiUrl::imageUrl()."/variations";
return $this->sendRequest($url, 'POST', $opts);
}
/**
* @param $opts
*
* @return bool|string
*/
public function moderation($opts)
{
$url = OpenAiUrl::moderationUrl();
return $this->sendRequest($url, 'POST', $opts);
}
/**
* @param $opts
*
* @return bool|string
*/
public function uploadFile($opts)
{
$url = OpenAiUrl::filesUrl();
return $this->sendRequest($url, 'POST', $opts);
}
/**
* @return bool|string
*/
public function listFiles()
{
$url = OpenAiUrl::filesUrl();
return $this->sendRequest($url, 'GET');
}
/**
* @param $fileId
*
* @return bool|string
*/
public function retrieveFile($fileId)
{
$fileId = "/$fileId";
$url = OpenAiUrl::filesUrl().$fileId;
return $this->sendRequest($url, 'GET');
}
/**
* @param $fileId
*
* @return bool|string
*/
public function retrieveFileContent($fileId)
{
$fileId = "/$fileId/content";
$url = OpenAiUrl::filesUrl().$fileId;
return $this->sendRequest($url, 'GET');
}
/**
* @param $fileId
*
* @return bool|string
*/
public function deleteFile($fileId)
{
$fileId = "/$fileId";
$url = OpenAiUrl::filesUrl().$fileId;
return $this->sendRequest($url, 'DELETE');
}
/**
* @param $opts
*
* @return bool|string
*/
public function createFineTune($opts)
{
$url = OpenAiUrl::fineTuneUrl();
return $this->sendRequest($url, 'POST', $opts);
}
/**
* @return bool|string
*/
public function listFineTunes()
{
$url = OpenAiUrl::fineTuneUrl();
return $this->sendRequest($url, 'GET');
}
/**
* @param $fineTuneId
*
* @return bool|string
*/
public function retrieveFineTune($fineTuneId)
{
$fineTuneId = "/$fineTuneId";
$url = OpenAiUrl::fineTuneUrl().$fineTuneId;
return $this->sendRequest($url, 'GET');
}
/**
* @param $fineTuneId
*
* @return bool|string
*/
public function cancelFineTune($fineTuneId)
{
$fineTuneId = "/$fineTuneId/cancel";
$url = OpenAiUrl::fineTuneUrl().$fineTuneId;
return $this->sendRequest($url, 'POST');
}
/**
* @param $fineTuneId
*
* @return bool|string
*/
public function listFineTuneEvents($fineTuneId)
{
$fineTuneId = "/$fineTuneId/events";
$url = OpenAiUrl::fineTuneUrl().$fineTuneId;
return $this->sendRequest($url, 'GET');
}
/**
* @param $fineTuneId
*
* @return bool|string
*/
public function deleteFineTune($fineTuneId)
{
$fineTuneId = "/$fineTuneId";
$url = OpenAiUrl::fineTuneModel().$fineTuneId;
return $this->sendRequest($url, 'DELETE');
}
/**
* @param $opts
*
* @return bool|string
*/
public function embeddings($opts)
{
$url = OpenAiUrl::embeddings();
return $this->sendRequest($url, 'POST', $opts);
}
public function setTimeout(int $timeout)
{
$this->timeout = $timeout;
}
private function sendRequest(
string $url,
string $method,
array $opts = []
) {
$post_fields = json_encode($opts);
if (array_key_exists('file', $opts) || array_key_exists('image', $opts)) {
$this->headers[0] = $this->contentTypes["multipart/form-data"];
$post_fields = $opts;
} else {
$this->headers[0] = $this->contentTypes["application/json"];
}
$curl_info = [
CURLOPT_URL => $url,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => $this->timeout,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => $method,
CURLOPT_POSTFIELDS => $post_fields,
CURLOPT_HTTPHEADER => $this->headers,
];
if ($opts == []) {
unset($curl_info[CURLOPT_POSTFIELDS]);
}
if (array_key_exists('stream', $opts) && $opts['stream']) {
$curl_info[CURLOPT_WRITEFUNCTION] = $this->streamMethod;
}
$curl = curl_init();
curl_setopt_array($curl, $curl_info);
$response = curl_exec($curl);
curl_close($curl);
return $response;
}
}

@ -0,0 +1,74 @@
<?php
/* For licensing terms, see /license.txt */
class OpenAiUrl
{
public const ORIGIN = 'https://api.openai.com';
public const API_VERSION = 'v1';
public const OPEN_AI_URL = self::ORIGIN."/".self::API_VERSION;
public static function completionsURL(): string
{
return self::OPEN_AI_URL."/completions";
}
public static function editsUrl(): string
{
return self::OPEN_AI_URL."/edits";
}
public static function searchURL(string $engine): string
{
return self::OPEN_AI_URL."/engines/$engine/search";
}
public static function enginesUrl(): string
{
return self::OPEN_AI_URL."/engines";
}
public static function engineUrl(string $engine): string
{
return self::OPEN_AI_URL."/engines/$engine";
}
public static function classificationsUrl(): string
{
return self::OPEN_AI_URL."/classifications";
}
public static function moderationUrl(): string
{
return self::OPEN_AI_URL."/moderations";
}
public static function filesUrl(): string
{
return self::OPEN_AI_URL."/files";
}
public static function fineTuneUrl(): string
{
return self::OPEN_AI_URL."/fine-tunes";
}
public static function fineTuneModel(): string
{
return self::OPEN_AI_URL."/models";
}
public static function answersUrl(): string
{
return self::OPEN_AI_URL."/answers";
}
public static function imageUrl(): string
{
return self::OPEN_AI_URL."/images";
}
public static function embeddings(): string
{
return self::OPEN_AI_URL."/embeddings";
}
}

@ -0,0 +1,57 @@
<?php
/* For license terms, see /license.txt */
/**
Answer questions based on existing knowledge.
*/
require_once __DIR__.'/../../../main/inc/global.inc.php';
require_once __DIR__.'/../AiHelperPlugin.php';
require_once __DIR__.'/../src/openai/OpenAi.php';
$plugin = AiHelperPlugin::create();
$apiList = $plugin->getApiList();
$apiName = $plugin->get('api_name');
if (!in_array($apiName, array_keys($apiList))) {
throw new Exception("Ai API is not available for this request.");
}
switch ($apiName) {
case AiHelperPlugin::OPENAI_API:
$questionTypes = [
'multiple_choice' => 'multiple choice',
'unique_answer' => 'unique answer',
];
$nQ = (int) $_REQUEST['nro_questions'];
$lang = (string) $_REQUEST['language'];
$topic = (string) $_REQUEST['quiz_name'];
$questionType = $questionTypes[$_REQUEST['question_type']] ?? $questionTypes['multiple_choice'];
$prompt = 'Generate %d "%s" questions in Aiken format in the %s language about "%s", making sure there is a \'ANSWER\' line for each question. \'ANSWER\' lines must only mention the letter of the correct answer, not the full answer text and not a parenthesis. The line starting with \'ANSWER\' must not be separated from the last possible answer by a blank line. Each answer starts with an uppercase letter, a dot, one space and the answer text without quotes. Include an \'ANSWER_EXPLANATION\' line after the \'ANSWER\' line for each question. The terms between single quotes above must not be translated. There must be a blank line between each question.';
$prompt = sprintf($prompt, $nQ, $questionType, $lang, $topic);
$resultText = $plugin->openAiGetCompletionText($prompt, 'quiz');
if (isset($resultText['error']) && true === $resultText['error']) {
echo json_encode([
'success' => false,
'text' => $resultText['message'],
]);
exit;
}
// Returns the text answers generated.
$return = ['success' => false, 'text' => ''];
if (!empty($resultText)) {
$return = [
'success' => true,
'text' => trim($resultText),
];
}
echo json_encode($return);
break;
}

@ -0,0 +1,216 @@
<?php
/* For license terms, see /license.txt */
/**
Create a learnpath with contents based on existing knowledge.
*/
use Chamilo\CoreBundle\Component\Utils\ChamiloApi;
require_once __DIR__.'/../../../main/inc/global.inc.php';
require_once __DIR__.'/../AiHelperPlugin.php';
require_once api_get_path(SYS_CODE_PATH).'exercise/export/aiken/aiken_classes.php';
require_once api_get_path(SYS_CODE_PATH).'exercise/export/aiken/aiken_import.inc.php';
$plugin = AiHelperPlugin::create();
$apiList = $plugin->getApiList();
$apiName = $plugin->get('api_name');
if (!in_array($apiName, array_keys($apiList))) {
throw new Exception("Ai API is not available for this request.");
}
switch ($apiName) {
case AiHelperPlugin::OPENAI_API:
$courseLanguage = (string) $_REQUEST['language'];
$chaptersCount = (int) $_REQUEST['nro_items'];
$topic = (string) $_REQUEST['lp_name'];
$wordsCount = (int) $_REQUEST['words_count'];
$courseCode = (string) $_REQUEST['course_code'];
$sessionId = (int) $_REQUEST['session_id'];
$addTests = ('true' === $_REQUEST['add_tests']);
$nQ = ($addTests ? (int) $_REQUEST['nro_questions'] : 0);
$messageGetItems = 'Generate the table of contents of a course in "%s" in %d or less chapters on the topic of "%s" and return it as a list of items separated by CRLF. Do not provide chapter numbering. Do not include a conclusion chapter.';
$prompt = sprintf($messageGetItems, $courseLanguage, $chaptersCount, $topic);
$resultText = $plugin->openAiGetCompletionText($prompt, 'learnpath');
if (isset($resultText['error']) && true === $resultText['error']) {
echo json_encode([
'success' => false,
'text' => $resultText['message'],
]);
exit;
}
$lpItems = [];
if (!empty($resultText)) {
$style = api_get_css_asset('bootstrap/dist/css/bootstrap.min.css');
$style .= api_get_css_asset('fontawesome/css/font-awesome.min.css');
$style .= api_get_css(ChamiloApi::getEditorDocStylePath());
$style .= api_get_css_asset('ckeditor/plugins/codesnippet/lib/highlight/styles/default.css');
$style .= api_get_asset('ckeditor/plugins/codesnippet/lib/highlight/highlight.pack.js');
$style .= '<script>hljs.initHighlightingOnLoad();</script>';
$items = explode("\n", $resultText);
$position = 1;
foreach ($items as $item) {
if (substr($item, 0, 2) === '- ') {
$item = substr($item, 2);
}
$explodedItem = preg_split('/\d\./', $item);
$title = count($explodedItem) > 1 ? $explodedItem[1] : $explodedItem[0];
if (!empty($title)) {
$lpItems[$position]['title'] = trim($title);
$messageGetItemContent = 'In the context of "%s", generate a document with HTML tags in "%s" with %d words of content or less, about "%s", as to be included as one chapter in a larger document on "%s". Consider the context is established for the reader and you do not need to repeat it.';
$promptItem = sprintf($messageGetItemContent, $topic, $courseLanguage, $wordsCount, $title, $topic);
$resultContentText = $plugin->openAiGetCompletionText($promptItem, 'learnpath');
$lpItemContent = (!empty($resultContentText) ? trim($resultContentText) : '');
if (false !== stripos($lpItemContent, '</head>')) {
$lpItemContent = preg_replace("|</head>|i", "\r\n$style\r\n\\0", $lpItemContent);
} else {
$lpItemContent = '<html><head><title>'.trim($title).'</title>'.$style.'</head><body>'.$lpItemContent.'</body></html>';
}
$lpItems[$position]['content'] = $lpItemContent;
$position++;
}
}
}
// Create the learnpath and return the id generated.
$return = ['success' => false, 'lp_id' => 0];
if (!empty($lpItems)) {
$lpId = learnpath::add_lp(
$courseCode,
$topic,
'',
'chamilo',
'manual'
);
if (!empty($lpId)) {
learnpath::toggle_visibility($lpId, 0);
$courseInfo = api_get_course_info($courseCode);
$lp = new \learnpath(
$courseCode,
$lpId,
api_get_user_id()
);
$lp->generate_lp_folder($courseInfo, $topic);
$order = 1;
$lpItemsIds = [];
foreach ($lpItems as $dspOrder => $item) {
$documentId = $lp->create_document(
$courseInfo,
$item['content'],
$item['title'],
'html'
);
if (!empty($documentId)) {
$prevDocItem = (isset($lpItemsIds[$order - 1]) ? (int) $lpItemsIds[$order - 1]['item_id'] : 0);
$lpItemId = $lp->add_item(
0,
$prevDocItem,
'document',
$documentId,
$item['title'],
'',
0,
0,
api_get_user_id(),
$order
);
$lpItemsIds[$order]['item_id'] = $lpItemId;
$lpItemsIds[$order]['item_type'] = 'document';
if ($addTests && !empty($lpItemId)) {
$promptQuiz = 'Generate %d "%s" questions in Aiken format in the %s language about "%s", making sure there is a \'ANSWER\' line for each question. \'ANSWER\' lines must only mention the letter of the correct answer, not the full answer text and not a parenthesis. The line starting with \'ANSWER\' must not be separated from the last possible answer by a blank line. Each answer starts with an uppercase letter, a dot, one space and the answer text without quotes. Include an \'ANSWER_EXPLANATION\' line after the \'ANSWER\' line for each question. The terms between single quotes above must not be translated. There must be a blank line between each question. Show the question directly without any prefix.';
$promptQuiz = sprintf($promptQuiz, $nQ, $courseLanguage, $item['title'], $topic);
$resultQuizText = $plugin->openAiGetCompletionText($promptQuiz, 'quiz');
if (!empty($resultQuizText)) {
$request = [];
$request['quiz_name'] = get_lang('Exercise').': '.$item['title'];
$request['nro_questions'] = $nQ;
$request['course_id'] = api_get_course_int_id($courseCode);
$request['aiken_format'] = trim($resultQuizText);
$exerciseId = aikenImportExercise(null, $request);
if (!empty($exerciseId)) {
$order++;
$prevQuizItem = (isset($lpItemsIds[$order - 1]) ? (int) $lpItemsIds[$order - 1]['item_id'] : 0);
$lpQuizItemId = $lp->add_item(
0,
$prevQuizItem,
'quiz',
$exerciseId,
$request['quiz_name'],
'',
0,
0,
api_get_user_id(),
$order
);
if (!empty($lpQuizItemId)) {
$maxScore = (float) $nQ;
$minScore = round($nQ / 2, 2);
$lpItemsIds[$order]['item_id'] = $lpQuizItemId;
$lpItemsIds[$order]['item_type'] = 'quiz';
$lpItemsIds[$order]['min_score'] = $minScore;
$lpItemsIds[$order]['max_score'] = $maxScore;
}
}
}
}
}
$order++;
}
// Add the final item
if ($addTests) {
$finalTitle = get_lang('EndOfLearningPath');
$finalContent = file_get_contents(api_get_path(SYS_CODE_PATH).'lp/final_item_template/template.html');
$finalDocId = $lp->create_document(
$courseInfo,
$finalContent,
$finalTitle
);
$prevFinalItem = (isset($lpItemsIds[$order - 1]) ? (int) $lpItemsIds[$order - 1]['item_id'] : 0);
$lpFinalItemId = $lp->add_item(
0,
$prevFinalItem,
TOOL_LP_FINAL_ITEM,
$finalDocId,
$finalTitle,
'',
0,
0,
api_get_user_id(),
$order
);
$lpItemsIds[$order]['item_id'] = $lpFinalItemId;
$lpItemsIds[$order]['item_type'] = TOOL_LP_FINAL_ITEM;
// Set lp items prerequisites
if (count($lpItemsIds) > 0) {
for ($i = 1; $i <= count($lpItemsIds); $i++) {
$prevIndex = ($i - 1);
if (isset($lpItemsIds[$prevIndex])) {
$itemId = $lpItemsIds[$i]['item_id'];
$prerequisite = $lpItemsIds[$prevIndex]['item_id'];
$minScore = ('quiz' === $lpItemsIds[$prevIndex]['item_type'] ? $lpItemsIds[$prevIndex]['min_score'] : 0);
$maxScore = ('quiz' === $lpItemsIds[$prevIndex]['item_type'] ? $lpItemsIds[$prevIndex]['max_score'] : 100);
$lp->edit_item_prereq($itemId, $prerequisite, $minScore, $maxScore);
}
}
}
}
}
$return = [
'success' => true,
'lp_id' => $lpId,
];
}
echo json_encode($return);
break;
}

@ -0,0 +1,16 @@
<?php
/* For license terms, see /license.txt */
/**
* Uninstall the Ai Helper Plugin.
*
* @package chamilo.plugin.ai_helper
*/
require_once __DIR__.'/../../main/inc/global.inc.php';
require_once __DIR__.'/AiHelperPlugin.php';
if (!api_is_platform_admin()) {
exit('You must have admin permissions to install plugins');
}
AiHelperPlugin::create()->uninstall();

@ -0,0 +1,553 @@
<?php
/* For licensing terms, see /license.txt */
class CheckExtraFieldAuthorsCompanyPlugin extends Plugin
{
/**
* @var string
*/
protected $tblExtraFieldOption;
/**
* @var string
*/
protected $tblExtraField;
/**
* @var bool
*/
protected $companyExists;
/**
* @var bool
*/
protected $authorsExists;
/**
* @var bool
*/
protected $priceExists;
/**
* @var bool
*/
protected $authorLpItemExists;
/**
* @var bool
*/
protected $authorLpExists;
/**
* @var array
*/
protected $companyField;
/**
* @var array
*/
protected $authorsField;
/**
* @var array
*/
protected $priceField;
/**
* @var array
*/
protected $authorLpItemField;
/**
* @var array
*/
protected $authorLpField;
public function __construct()
{
parent::__construct(
'1.2',
'Carlos Alvarado, Julio Montoya'
);
$this->tblExtraField = Database::get_main_table(TABLE_EXTRA_FIELD);
$this->tblExtraFieldOption = Database::get_main_table(TABLE_EXTRA_FIELD_OPTIONS);
$field = new ExtraField('user');
$companyField = $field->get_handler_field_info_by_field_variable('company');
$this->companyExists = false;
if (!empty($companyField)) {
$this->companyExists = true;
$this->companyField = $companyField;
} else {
$this->companyField = [
'field_type' => ExtraField::FIELD_TYPE_RADIO,
'variable' => 'company',
'display_text' => 'Company',
'default_value' => '',
'field_order' => 0,
'visible_to_self' => 0,
'visible_to_others' => 0,
'changeable' => 1,
'filter' => 1,
];
}
$field = new ExtraField('lp');
$authorsField = $field->get_handler_field_info_by_field_variable('authors');
$this->authorsExists = false;
if (empty($authorsField)) {
$this->authorsExists = true;
$this->authorsField = $authorsField;
}
}
/**
* Create a new instance of CheckExtraFieldAuthorsCompanyPlugin.
*
* @return CheckExtraFieldAuthorsCompanyPlugin
*/
public static function create()
{
static $result = null;
return $result ? $result : $result = new self();
}
/**
* Perform the plugin installation.
*/
public function install()
{
$this->saveCompanyField();
$this->setCompanyExtrafieldData();
$this->saveAuthorsField();
$this->savePrice();
$this->saveAuthorLPItem();
$this->saveAuthorLp();
}
/**
* Save the arrangement for company, it is adjusted internally so that the values match the necessary ones.
*/
public function saveCompanyField()
{
$data = $this->companyField;
if (!empty($data)) {
$data['field_type'] = (int) $data['field_type'];
$data['field_order'] = (int) $data['field_order'];
$data['visible_to_self'] = (int) $data['visible_to_self'];
$data['visible_to_others'] = (int) $data['visible_to_others'];
$data['changeable'] = (int) $data['changeable'];
$data['filter'] = (int) $data['filter'];
$data['default_value'] = '';
$data['variable'] = 'company';
$data['visible'] = 1;
$data['display_text'] = strtolower(Database::escape_string($data['display_text']));
$schedule = new ExtraField('user');
$this->companyField['id'] = $schedule->save($data);
}
}
/**
* Insert the option fields for company with the generic values Company 1, company 2 and company 3.
*/
public function setCompanyExtrafieldData()
{
$companies = [
0 => 'Company 1',
1 => 'Company 2',
2 => 'Company 3',
];
$companyId = (int) $this->companyField['id'];
if ($companyId != 0) {
for ($i = 0; $i < count($companies); $i++) {
$order = $i + 1;
$extraFieldOptionValue = $companies[$i];
if ($companyId != null) {
$query = "SELECT *
FROM ".$this->tblExtraFieldOption."
WHERE
option_value = '$extraFieldOptionValue' AND
field_id = $companyId";
$extraFieldOption = Database::fetch_assoc(Database::query($query));
if (isset($extraFieldOption['id']) && $extraFieldOption['id'] && $extraFieldOption['field_id'] == $companyId) {
// Update?
} else {
$query = "
INSERT INTO ".$this->tblExtraFieldOption."
(`field_id`, `option_value`, `display_text`, `priority`, `priority_message`, `option_order`) VALUES
( '$companyId', '$extraFieldOptionValue', '$extraFieldOptionValue', NULL, NULL, '$order');
";
Database::query($query);
}
}
}
}
}
/**
* Save the arrangement for authors, it is adjusted internally so that the values match the necessary ones.
*/
public function saveAuthorsField()
{
$data = [
'field_type' => ExtraField::FIELD_TYPE_SELECT_MULTIPLE,
'variable' => 'authors',
'display_text' => 'Authors',
'default_value' => '',
'field_order' => 0,
'visible_to_self' => 1,
'visible_to_others' => 0,
'changeable' => 1,
'filter' => 1,
];
$schedule = new ExtraField('lp');
$schedule->save($data);
}
/**
* Save the arrangement for price, it is adjusted internally so that the values match the necessary ones.
*/
public function savePrice()
{
$schedule = new ExtraField('lp_item');
$data = [];
$data['visible_to_self'] = 1;
$data['visible_to_others'] = 1;
$data['changeable'] = 1;
$data['filter'] = 0;
$data['variable'] = 'price';
$data['display_text'] = 'SalePrice';
$data['field_type'] = ExtraField::FIELD_TYPE_INTEGER;
$schedule->save($data);
}
/**
* Save the arrangement for AuthorLPItem, it is adjusted internally so that the values match the necessary ones.
*/
public function saveAuthorLPItem()
{
$schedule = new ExtraField('lp_item');
$data = [];
$data['visible_to_self'] = 1;
$data['visible_to_others'] = 0;
$data['changeable'] = 1;
$data['filter'] = 0;
$data['variable'] = 'authorlpitem';
$data['display_text'] = 'LearningPathItemByAuthor';
$data['field_type'] = ExtraField::FIELD_TYPE_SELECT_MULTIPLE;
$schedule->save($data);
}
/**
* Save the arrangement for authorlp, it is adjusted internally so that the values match the necessary ones.
*/
public function saveAuthorLp()
{
$schedule = new ExtraField('user');
$data = [];
$data['variable'] = 'authorlp';
$data['display_text'] = 'authors';
$data['changeable'] = 1;
$data['visible_to_self'] = 1;
$data['visible_to_others'] = 0;
$data['filter'] = 0;
$data['field_type'] = ExtraField::FIELD_TYPE_CHECKBOX;
$schedule->save($data);
}
/**
* Remove the extra fields set by the plugin.
*/
public function uninstall()
{
$companyExists = $this->companyFieldExists();
if ($companyExists == true) {
// $this->removeCompanyField();
}
$authorsExists = $this->authorsFieldExists();
if ($authorsExists == true) {
// $this->removeAuthorsField();
}
$priceExists = $this->priceFieldExists();
if ($priceExists == true) {
// $this->>removePriceField();
}
$authorLpItemExists = $this->authorLpItemFieldExists();
if ($authorLpItemExists == true) {
// $this->removeAuthorLpItemField();
}
$authorLpExists = $this->authorLpFieldExists();
if ($authorLpExists == true) {
// $this->removeAuthorLpField();
}
}
/**
* Verify that the "company" field exists in the database.
*/
public function companyFieldExists(): bool
{
$this->getCompanyField();
$this->companyExists = (isset($this->companyField['id'])) ? true : false;
return $this->companyExists;
}
/**
* Returns the content of the extra field "company" if it exists in the database, if not, it returns an arrangement
* with the basic elements for its operation.
*
* @return array
*/
public function getCompanyField()
{
$companyField = $this->getInfoExtrafield('company');
if (count($companyField) > 1) {
$this->companyField = $companyField;
} else {
$companyField = $this->companyField;
}
return $companyField;
}
/**
* Verify that the "authors" field exists in the database.
*/
public function authorsFieldExists(): bool
{
$this->getAuthorsField();
$this->authorsExists = (isset($this->authorsField['id'])) ? true : false;
return $this->authorsExists;
}
/**
* Returns the content of the extra field "authors" if it exists in the database, if not, it returns an arrangement
* with the basic elements for its operation.
*
* @return array
*/
public function getAuthorsField()
{
$schedule = new ExtraField('lp');
$data = $schedule->get_handler_field_info_by_field_variable('authors');
if (empty($data)) {
$this->authorsField = $data;
} else {
$data = $this->authorsField;
}
return $data;
}
/**
* Verify that the "price" field exists in the database.
*/
public function priceFieldExists(): bool
{
$this->getPriceField();
$this->priceExists = (isset($this->priceField['id'])) ? true : false;
return $this->priceExists;
}
/**
* Returns the content of the extra field "price" if it exists in the database, if not, it returns an arrangement
* with the basic elements for its operation.
*
* @return array
*/
public function getPriceField()
{
$schedule = new ExtraField('lp_item');
$data = $schedule->get_handler_field_info_by_field_variable('price');
if (empty($data)) {
$this->priceField = $data;
} else {
$data = $this->priceField;
}
return $data;
}
/**
* Verify that the "authorlpitem" field exists in the database.
*/
public function authorLpItemFieldExists(): bool
{
$this->getAuthorLpItemField();
$this->authorLpItemExists = (isset($this->authorLpItemField['id'])) ? true : false;
return $this->authorLpItemExists;
}
/**
* Returns the content of the extra field "authorlpitem" if it exists in the database, if not, it returns an arrangement
* with the basic elements for its operation.
*
* @return array
*/
public function getAuthorLpItemField()
{
$schedule = new ExtraField('lp_item');
$data = $schedule->get_handler_field_info_by_field_variable('authorlpitem');
if (empty($data)) {
$this->authorLpItemField = $data;
} else {
$data = $this->authorLpItemField;
}
return $data;
}
/**
* Verify that the "authorlp" field exists in the database.
*/
public function authorLpFieldExists(): bool
{
$this->getAuthorLpField();
$this->authorLpExists = (isset($this->authorLpField['id'])) ? true : false;
return $this->authorLpExists;
}
/**
* Returns the content of the extra field "authorlp" if it exists in the database, if not, it returns an arrangement
* with the basic elements for its operation.
*
* @return array
*/
public function getAuthorLpField()
{
$field = new ExtraField('user');
$data = $field->get_handler_field_info_by_field_variable('authorlp');
if (empty($data)) {
$this->authorLpField = $data;
} else {
$data = $this->authorLpField;
}
return $data;
}
/**
* Remove the extra fields "company".
*/
public function removeCompanyField()
{
$data = $this->getCompanyField();
// $this->deleteQuery($data);
}
/**
* Remove the extra fields "authors".
*/
public function removeAuthorsField()
{
$data = $this->getAuthorsField();
// $this->deleteQuery($data);
}
/**
* Remove the extra fields "price".
*/
public function removePriceField()
{
$data = $this->getPriceField();
// $this->deleteQuery($data);
}
/**
* Remove the extra fields "authorlpitem".
*/
public function removeAuthorLpItemField()
{
$data = $this->getAuthorLpItemField();
// $this->deleteQuery($data);
}
/**
* Remove the extra fields "authorlp".
*/
public function removeAuthorLpField()
{
$data = $this->getAuthorLpField();
// $this->deleteQuery($data);
}
/**
* Executes fix removal for authors or company.
*
* @param $data
*/
protected function deleteQuery($data)
{
$validVariable = false;
$variable = $data['variable'];
$extraFieldTypeInt = (int) $data['extra_field_type'];
$FieldType = (int) $data['field_type'];
$id = (int) $data['id'];
$extraFieldType = null;
switch ($variable) {
case 'company':
case 'authorlp':
$validVariable = true;
$extraFieldType = 'user';
break;
case 'authors':
$validVariable = true;
$extraFieldType = 'lp';
break;
case 'price':
case 'authorlpitem':
$validVariable = true;
$extraFieldType = 'lp_item';
break;
}
if ($variable === 'company') {
} elseif ($variable === 'authors') {
}
if ($validVariable == true && $id != 0 && !empty($extraFieldType)) {
$query = "SELECT id
FROM
".$this->tblExtraField."
WHERE
id = $id AND
variable = '$variable' AND
extra_field_type = $extraFieldTypeInt AND
field_type = $FieldType
";
$data = Database::fetch_assoc(Database::query($query));
if (isset($data['id'])) {
$obj = new ExtraField($extraFieldType);
$obj->delete($data['id']);
}
}
}
/**
* Returns the array of an element in the database that matches the variable.
*
* @param string $variableName
*
* @return array
*/
protected function getInfoExtrafield($variableName = null)
{
if ($variableName == null) {
return [];
}
$variableName = strtolower(Database::escape_string($variableName));
$tblExtraField = $this->tblExtraField;
$query = "SELECT * FROM $tblExtraField WHERE variable = '$variableName'";
$data = Database::fetch_assoc(Database::query($query));
if ($data == false || !isset($data['display_text'])) {
return [];
}
return $data;
}
}

@ -0,0 +1,30 @@
Check Extra Fields 'author' and 'company'
======
The "User by organization" report allows the administrator to select a
date range to show the number of users who have been subscribed to a learning
path or a course during this time frame. The number of users are grouped by
entity/company.
The "Learning path by author" report allows the administrator to define, for
each user, if (s)he is an author or not. Then, for each item in a Learning
Path, the administrator can select who is its author from the identified list
and indicate the cost of that item.
Finally, the reports allow the administrator to select a date range to show
for each author how many of his/her content (LP item) users have been given
access to (based on the learning path subscriptions by users) and show the
amount of money they should be paid based on the number of accesses given
during this period.
This plugin adds the extra fields necessary to display the reports:
* The "User by organization" report requires the 'company' extra field to be created on user.
* The "Learning path by author" report requires the 'authors' extra field to be created on lp.
* The "LP Item by author" report additional reports requires the 'authorlpitem' extra field to be created on lp_item and the 'authorlp' extra field to be created on 'user'.
* For prices to be adequately shown, the 'price' extra field needs to be created on 'lp_item'.
## Uninstall
When uninstalling this plugin, the extra fields created will not be removed,
for data persistence reasons.

@ -0,0 +1,5 @@
<?php
/* For licensing terms, see /license.txt */
require_once __DIR__.'/../../main/inc/global.inc.php';

@ -0,0 +1,9 @@
<?php
/* For licensing terms, see /license.txt */
if (!api_is_platform_admin()) {
exit('You must have admin permissions to install plugins');
}
CheckExtraFieldAuthorsCompanyPlugin::create()->install();

@ -0,0 +1,17 @@
<?php
/* For licensing terms, see /license.txt */
/**
* This script is a configuration file for the date plugin. You can use it as a master for other platform plugins
* (course plugins are slightly different).
* These settings will be used in the administration interface for plugins (Chamilo configuration settings->Plugins).
*
* @author Carlos Alvarado <carlos.alvarado@beeznest.com>
*/
$plugin_info['title'] = 'Extra reports: User by organization", "Learning path by author" and "LP item by author"';
$plugin_info['comment'] = 'To enable these reports, enable user subscription to a learning path through the '.
'"Learning path settings" -> "Subscribe users to learning path" <br>'.
'You can then go to /main/mySpace/ (as administrator), then to the "admin" section (star icon) to see the new reports.';
$plugin_info['version'] = '1.2';
$plugin_info['author'] = 'Carlos Alvarado, Julio Montoya';

@ -0,0 +1,8 @@
<?php
/* For license terms, see /license.txt */
if (!api_is_platform_admin()) {
exit('You must have admin permissions to uninstall plugins');
}
CheckExtraFieldAuthorsCompanyPlugin::create()->uninstall();

@ -0,0 +1,6 @@
CleanDeleted Files Maintenance plugin
===
This plugin allows the administrator to permanently delete files marked as deleted.
Enable the plugin, then add it to the menu_administrator region and check back the
'Plugins' box on the administration page to access it.

@ -0,0 +1,192 @@
<?php
/* For licensing terms, see /license.txt */
/**
* Plugin.
*
* @author Jose Angel Ruiz
*/
$cidReset = true;
require_once __DIR__.'/config.php';
api_protect_admin_script();
/** @var \CleanDeletedFilesPlugin $plugin */
$plugin = CleanDeletedFilesPlugin::create();
$plugin_info = $plugin->get_info();
$isPlatformAdmin = api_is_platform_admin();
if ($plugin->isEnabled() && $isPlatformAdmin) {
$htmlHeadXtra[] = '<script>
$(function() {
$(".delete-file").click(function(e) {
e.preventDefault();
var path = $(this).prop("href").substr(7);
if (confirm("'.$plugin->get_lang("ConfirmDelete").'")) {
$.post(
"src/ajax.php",
{a:"delete-file", path:path},
function(data){
if (data.status == "false") {
alert(data.message);
} else {
location.reload();
}
},
"json"
);
}
});
$(".select_all").click(function(e) {
var id = $(this).prop("id").substr(7);
if( $(this).prop("checked") ) {
$(".checkbox-"+id).prop( "checked", true);
} else {
$(".checkbox-"+id).prop( "checked", false);
}
});
$("#delete-selected-files").click(function(e) {
if (confirm("'.$plugin->get_lang("ConfirmDeleteFiles").'")) {
var list = [];
$.each($(".checkbox-item:checked"), function() {
list.push($(this).prop("id"));
});
$.post(
"src/ajax.php",
{a:"delete-files-list", list:list},
function(data){
if (data.status == "false") {
alert(data.message);
} else {
location.reload();
}
},
"json"
);
}
});
});
</script>';
$nameTools = $plugin->get_lang("FileList");
Display::display_header($nameTools);
echo Display::page_header($nameTools);
$pathList = [
"app/courses",
"app/upload",
];
function findDeletedFiles($pathRelative)
{
global $sizePath;
$pathAbsolute = api_get_path(SYS_PATH).$pathRelative;
$result = [];
if (is_dir($pathAbsolute)) {
$dir = dir($pathAbsolute);
while ($file = $dir->read()) {
if (is_file($pathAbsolute.'/'.$file)) {
$filesize = round(filesize($pathAbsolute.'/'.$file) / 1024, 1);
$pos = strpos($file, "DELETED");
if ($pos !== false) {
$result[] = [
'path_complete' => $pathAbsolute.'/'.$file,
'path_relative' => $pathRelative.'/'.$file,
'size' => $filesize,
];
$sizePath += $filesize;
}
} else {
if ($file != '..' && $file != '.') {
$result = array_merge($result, findDeletedFiles($pathRelative.'/'.$file));
}
}
}
}
return $result;
}
$sizeTotal = 0;
$i = 0;
foreach ($pathList as $pathItem) {
$sizePath = 0;
$filesDeletedList = findDeletedFiles($pathItem);
echo Display::page_subheader($plugin->get_lang("path_dir").": ".$pathItem);
if (count($filesDeletedList) > 0) {
echo "<ul>";
echo "<li>".$plugin->get_lang('FilesDeletedMark').": <strong>".count($filesDeletedList)."</strong>";
echo "<li>".$plugin->get_lang('FileDirSize').": ";
if ($sizePath >= 1024) {
echo "<strong>".round($sizePath / 1024, 1)." Mb</strong>";
} else {
echo "<strong>".$sizePath." Kb</strong>";
}
echo "</ul>";
$header = [
[
'<input type="checkbox" id="select_'.$i.'" class="select_all" />',
false,
null,
['style' => 'text-align:center'],
],
[$plugin->get_lang('path_dir'), true],
[$plugin->get_lang('size'), true, null, ['style' => 'min-width:85px']],
[get_lang('Actions'), false],
];
$data = [];
$deleteIcon = Display::return_icon('delete.png', get_lang('Delete'), '', ICON_SIZE_SMALL);
foreach ($filesDeletedList as $value) {
$tools = Display::url(
$deleteIcon,
'file://'.$value['path_complete'],
['class' => 'delete-file']
);
$row = [
'<input type="checkbox"
class="checkbox-'.$i.' checkbox-item"
id="file://'.$value['path_complete'].'" />',
$value['path_relative'],
$value['size'].' '.($value['size'] >= 1024 ? 'Mb' : 'Kb'),
$tools,
];
$data[] = $row;
}
echo Display::return_sortable_table(
$header,
$data,
[],
['per_page' => 100],
[]
);
} else {
$message = $plugin->get_lang('NoFilesDeleted');
echo Display::return_message($message, 'warning', false);
}
$sizeTotal += $sizePath;
echo '<hr>';
$i++;
}
if ($sizeTotal >= 1024) {
echo $plugin->get_lang('SizeTotalAllDir').": <strong>".round($sizeTotal / 1024, 1).' Mb</strong>';
} else {
echo $plugin->get_lang('SizeTotalAllDir').": <strong>".$sizeTotal.' Kb</strong>';
}
echo '<hr>';
echo '<a href="#" id="delete-selected-files" class="btn btn-primary">'.
$plugin->get_lang("DeleteSelectedFiles").
'</a>';
Display::display_footer();
}

@ -0,0 +1,10 @@
<?php
/* For licensing terms, see /license.txt */
/**
* Config the plugin.
*
* @author Jose Angel Ruiz
*/
require_once __DIR__.'/../../main/inc/global.inc.php';

@ -0,0 +1,5 @@
<?php
/* For license terms, see /license.txt */
require_once 'config.php';

@ -0,0 +1,17 @@
<?php
$strings['plugin_title'] = "Clean deleted files";
$strings['plugin_comment'] = "Permanently delete files marked as deleted. Enable it in the menu_administrator region then access it from main admin page.";
$strings['tool_enable'] = "Enable plugin";
$strings['FileList'] = "List of files marked as deleted";
$strings['SizeTotalAllDir'] = "Total size (all directories)";
$strings['NoFilesDeleted'] = "There are no files marked as deleted";
$strings['FilesDeletedMark'] = "Files marked as deleted";
$strings['FileDirSize'] = "Directory files size";
$strings['ConfirmDelete'] = "Are you sure you want to delete the file?";
$strings['ErrorDeleteFile'] = "An error occurred while deleting the file";
$strings['ErrorEmptyPath'] = "There was a problem deleting the file, the path cannot be empty";
$strings['DeleteSelectedFiles'] = "Delete selected files";
$strings['ConfirmDeleteFiles'] = "Are you sure you want to delete all the selected files?";
$strings['DeletedSuccess'] = "The file deletion was successful";
$strings['path_dir'] = "Directory";
$strings['size'] = "Size";

@ -0,0 +1,17 @@
<?php
$strings['plugin_title'] = "Nettoyer les fichiers supprimés";
$strings['plugin_comment'] = "Élimine de manière définitive les fichiers marqués comme éliminés. Activer le plugin dans la région 'menu_administrator' puis y accéder depuis la page d'administration.";
$strings['tool_enable'] = "Activer plugin";
$strings['FileList'] = "Liste des fichiers marqués comme éliminés";
$strings['SizeTotalAllDir'] = "Taille totale (tous les répertoires)";
$strings['NoFilesDeleted'] = "Il n'y a pas de fichiers marqués comme supprimés";
$strings['FilesDeletedMark'] = "Fichiers marqués comme supprimés";
$strings['FileDirSize'] = "Taille des fichiers du répertoire";
$strings['ConfirmDelete'] = "Êtes-vous certain de vouloir supprimer le fichier?";
$strings['ErrorDeleteFile'] = "Une erreur a empêché la suppression du fichier";
$strings['ErrorEmptyPath'] = "Il y a eu un problème au moment de supprimer le fichier. Le chemin ne peut être vide.";
$strings['DeleteSelectedFiles'] = "Supprimer les fichiers sélectionnés";
$strings['ConfirmDeleteFiles'] = "Êtes-vous certain de vouloir supprimer tous les fichiers sélectionnés?";
$strings['DeletedSuccess'] = "La suppression des fichiers s'est bien déroulée.";
$strings['path_dir'] = "Répertoire";
$strings['size'] = "Taille";

@ -0,0 +1,17 @@
<?php
$strings['plugin_title'] = "Limpiar ficheros borrados";
$strings['plugin_comment'] = "Elimina de forma definitiva los ficheros marcados como eliminados. Active el plugin en la región 'menu_administrator' y acceda desde la página principal de administración.";
$strings['tool_enable'] = "Activar plugin";
$strings['FileList'] = "Lista de archivos marcados como eliminados";
$strings['SizeTotalAllDir'] = "Tamaño total (todos los directorios)";
$strings['NoFilesDeleted'] = "No hay ficheros marcados como eliminados";
$strings['FilesDeletedMark'] = "Ficheros marcados como eliminados";
$strings['FileDirSize'] = "Tamaño de los ficheros del directorio";
$strings['ConfirmDelete'] = "¿Está seguro que desea borrar el fichero?";
$strings['ErrorDeleteFile'] = "Se ha producido un error al borrar el fichero";
$strings['ErrorEmptyPath'] = "Ha habido un problema al borrar el fichero, la ruta no puede ser vacía";
$strings['DeleteSelectedFiles'] = "Borrar archivos seleccionados";
$strings['ConfirmDeleteFiles'] = "¿Esta seguro que desea borrar todos los ficheros seleccionados?";
$strings['DeletedSuccess'] = "El borrado de archivos ha sido correcto";
$strings['path_dir'] = "Directorio";
$strings['size'] = "Tamaño";

@ -0,0 +1,11 @@
<?php
/* For licensing terms, see /license.txt */
/**
* Plugin.
*
* @author Jose Angel Ruiz
*/
require_once __DIR__.'/config.php';
$plugin_info = CleanDeletedFilesPlugin::create()->get_info();

@ -0,0 +1,34 @@
<?php
/* For licensing terms, see /license.txt */
/**
* Clean deleted files plugin.
*
* @author Jose Angel Ruiz
*/
class CleanDeletedFilesPlugin extends Plugin
{
public $isAdminPlugin = true;
/**
* Class constructor.
*/
protected function __construct()
{
$version = '1.0';
$author = 'José Angel Ruiz (NOSOLORED)';
parent::__construct($version, $author, ['enabled' => 'boolean']);
$this->isAdminPlugin = true;
}
/**
* @return RedirectionPlugin
*/
public static function create()
{
static $result = null;
return $result ? $result : $result = new self();
}
}

@ -0,0 +1,47 @@
<?php
/* For licensing terms, see /license.txt */
/**
* Responses to AJAX calls.
*/
require_once '../config.php';
api_protect_admin_script();
$plugin = CleanDeletedFilesPlugin::create();
$action = isset($_REQUEST['a']) ? $_REQUEST['a'] : null;
switch ($action) {
case 'delete-file':
$path = isset($_REQUEST['path']) ? $_REQUEST['path'] : null;
if (empty($path)) {
echo json_encode(["status" => "false", "message" => $plugin->get_lang('ErrorEmptyPath')]);
exit;
}
if (unlink($path)) {
Display::addFlash($plugin->get_lang("DeletedSuccess"), 'success');
echo json_encode(["status" => "true"]);
} else {
echo json_encode(["status" => "false", "message" => $plugin->get_lang('ErrorDeleteFile')]);
}
break;
case 'delete-files-list':
$list = isset($_REQUEST['list']) ? $_REQUEST['list'] : [];
if (empty($list)) {
echo json_encode(["status" => "false", "message" => $plugin->get_lang('ErrorEmptyPath')]);
exit;
}
foreach ($list as $value) {
if (empty($value)) {
continue;
}
unlink($value);
}
Display::addFlash($plugin->get_lang("DeletedSuccess"), 'success');
echo json_encode(["status" => "true"]);
break;
}

@ -0,0 +1,202 @@
<?php
/* For licensing terms, see /license.txt */
use Chamilo\PluginBundle\Entity\CourseHomeNotify\Notification;
use Chamilo\PluginBundle\Entity\CourseHomeNotify\NotificationRelUser;
use Doctrine\ORM\Tools\SchemaTool;
/**
* Class CourseHomeNotifyPlugin.
*/
class CourseHomeNotifyPlugin extends Plugin
{
public const SETTING_ENABLED = 'enabled';
/**
* CourseHomeNotifyPlugin constructor.
*/
protected function __construct()
{
$settings = [
self::SETTING_ENABLED => 'boolean',
];
parent::__construct('0.1', 'Angel Fernando Quiroz Campos', $settings);
$this->isCoursePlugin = true;
$this->addCourseTool = false;
$this->setCourseSettings();
}
/**
* @return CourseHomeNotifyPlugin|null
*/
public static function create()
{
static $result = null;
return $result ? $result : $result = new self();
}
/**
* Install process.
* Create table in database. And setup Doctirne entity.
*
* @throws \Doctrine\ORM\Tools\ToolsException
*/
public function install()
{
$em = Database::getManager();
if ($em->getConnection()->getSchemaManager()->tablesExist(['course_home_notify_notification'])) {
return;
}
$schemaTool = new SchemaTool($em);
$schemaTool->createSchema(
[
$em->getClassMetadata(Notification::class),
$em->getClassMetadata(NotificationRelUser::class),
]
);
}
/**
* Uninstall process.
* Remove Doctrine entity. And drop table in database.
*/
public function uninstall()
{
$em = Database::getManager();
if (!$em->getConnection()->getSchemaManager()->tablesExist(['course_home_notify_notification'])) {
return;
}
$schemaTool = new SchemaTool($em);
$schemaTool->dropSchema(
[
$em->getClassMetadata(Notification::class),
$em->getClassMetadata(NotificationRelUser::class),
]
);
}
/**
* @param string $region
*
* @return string
*/
public function renderRegion($region)
{
if (
'main_bottom' !== $region
|| strpos($_SERVER['SCRIPT_NAME'], 'course_home/course_home.php') === false
) {
return '';
}
$courseId = api_get_course_int_id();
$userId = api_get_user_id();
if (empty($courseId) || empty($userId)) {
return '';
}
$course = api_get_course_entity($courseId);
$user = api_get_user_entity($userId);
$em = Database::getManager();
/** @var Notification $notification */
$notification = $em
->getRepository('ChamiloPluginBundle:CourseHomeNotify\Notification')
->findOneBy(['course' => $course]);
if (!$notification) {
return '';
}
$modalFooter = '';
$modalConfig = ['show' => true];
if ($notification->getExpirationLink()) {
/** @var NotificationRelUser $notificationUser */
$notificationUser = $em
->getRepository('ChamiloPluginBundle:CourseHomeNotify\NotificationRelUser')
->findOneBy(['notification' => $notification, 'user' => $user]);
if ($notificationUser) {
return '';
}
$contentUrl = api_get_path(WEB_PLUGIN_PATH).$this->get_name().'/content.php?hash='.$notification->getHash();
$link = Display::toolbarButton(
$this->get_lang('PleaseFollowThisLink'),
$contentUrl,
'external-link',
'link',
['id' => 'course-home-notify-link', 'target' => '_blank']
);
$modalConfig['keyboard'] = false;
$modalConfig['backdrop'] = 'static';
$modalFooter = '<div class="modal-footer">'.$link.'</div>';
}
$modal = '<div id="course-home-notify-modal" class="modal" tabindex="-1" role="dialog">
<div class="modal-dialog" role="document">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="'.get_lang('Close').'">
<span aria-hidden="true">&times;</span>
</button>
<h4 class="modal-title">'.$this->get_lang('CourseNotice').'</h4>
</div>
<div class="modal-body">
'.$notification->getContent().'
</div>
'.$modalFooter.'
</div>
</div>
</div>';
$modal .= "<script>
$(document).ready(function () {
\$('#course-home-notify-modal').modal(".json_encode($modalConfig).");
\$('#course-home-notify-link').on('click', function () {
$('#course-home-notify-modal').modal('hide');
});
});
</script>";
return $modal;
}
/**
* Set the course settings.
*/
private function setCourseSettings()
{
if ('true' !== $this->get(self::SETTING_ENABLED)) {
return;
}
$name = $this->get_name();
$button = Display::toolbarButton(
$this->get_lang('SetNotification'),
api_get_path(WEB_PLUGIN_PATH).$name.'/configure.php?'.api_get_cidreq(),
'cog',
'primary'
);
$this->course_settings = [
[
'name' => '<p>'.$this->get_comment().'</p>'.$button.'<hr>',
'type' => 'html',
],
];
}
}

@ -0,0 +1,152 @@
<?php
/* For licensing terms, see /license.txt */
namespace Chamilo\PluginBundle\Entity\CourseHomeNotify;
use Chamilo\CoreBundle\Entity\Course;
use Doctrine\ORM\Mapping as ORM;
/**
* Class Notification.
*
* @package Chamilo\PluginBundle\Entity\CourseHomeNotify
*
* @ORM\Table(name="course_home_notify_notification")
* @ORM\Entity()
*/
class Notification
{
/**
* @var int
*
* @ORM\Column(name="id", type="integer")
* @ORM\Id()
* @ORM\GeneratedValue()
*/
private $id = 0;
/**
* @var string
*
* @ORM\Column(name="content", type="text")
*/
private $content;
/**
* @var string
*
* @ORM\Column(name="expiration_link", type="string")
*/
private $expirationLink;
/**
* @var string
*
* @ORM\Column(name="hash", type="string")
*/
private $hash;
/**
* @var Course
*
* @ORM\ManyToOne(targetEntity="Chamilo\CoreBundle\Entity\Course")
* @ORM\JoinColumn(name="c_id", referencedColumnName="id", nullable=false, onDelete="CASCADE")
*/
private $course;
/**
* @return int
*/
public function getId()
{
return $this->id;
}
/**
* @param int $id
*
* @return Notification
*/
public function setId($id)
{
$this->id = $id;
return $this;
}
/**
* @return string
*/
public function getContent()
{
return $this->content;
}
/**
* @param string $content
*
* @return Notification
*/
public function setContent($content)
{
$this->content = $content;
return $this;
}
/**
* @return string
*/
public function getExpirationLink()
{
return $this->expirationLink;
}
/**
* @param string $expirationLink
*
* @return Notification
*/
public function setExpirationLink($expirationLink)
{
$this->expirationLink = $expirationLink;
return $this;
}
/**
* @return string
*/
public function getHash()
{
return $this->hash;
}
/**
* @param string $hash
*
* @return Notification
*/
public function setHash($hash)
{
$this->hash = $hash;
return $this;
}
/**
* @return Course
*/
public function getCourse()
{
return $this->course;
}
/**
* @param Course $course
*
* @return Notification
*/
public function setCourse($course)
{
$this->course = $course;
return $this;
}
}

@ -0,0 +1,99 @@
<?php
/* For licensing terms, see /license.txt */
namespace Chamilo\PluginBundle\Entity\CourseHomeNotify;
use Chamilo\UserBundle\Entity\User;
use Doctrine\ORM\Mapping as ORM;
/**
* Class NotificationRelUser.
*
* @package Chamilo\PluginBundle\Entity\CourseHomeNotify
*
* @ORM\Table(name="course_home_notify_notification_rel_user")
* @ORM\Entity()
*/
class NotificationRelUser
{
/**
* @var int
*
* @ORM\Column(name="id", type="integer")
* @ORM\Id()
* @ORM\GeneratedValue()
*/
private $id = 0;
/**
* @var Notification
*
* @ORM\ManyToOne(targetEntity="Chamilo\PluginBundle\Entity\CourseHomeNotify\Notification")
* @ORM\JoinColumn(name="notification_id", referencedColumnName="id", nullable=false, onDelete="CASCADE")
*/
private $notification;
/**
* @var User
*
* @ORM\ManyToOne(targetEntity="Chamilo\UserBundle\Entity\User")
* @ORM\JoinColumn(name="user_id", referencedColumnName="id", nullable=false, onDelete="CASCADE")
*/
private $user;
/**
* @return int
*/
public function getId()
{
return $this->id;
}
/**
* @param int $id
*
* @return NotificationRelUser
*/
public function setId($id)
{
$this->id = $id;
return $this;
}
/**
* @return Notification
*/
public function getNotification()
{
return $this->notification;
}
/**
* @return NotificationRelUser
*/
public function setNotification(Notification $notification)
{
$this->notification = $notification;
return $this;
}
/**
* @return User
*/
public function getUser()
{
return $this->user;
}
/**
* @param User $user
*
* @return NotificationRelUser
*/
public function setUser($user)
{
$this->user = $user;
return $this;
}
}

@ -0,0 +1,17 @@
# Notify in course home
Show notifications when a user enter in course home page.
## Set up
*Prior to installing/uninstalling this plugin, you will need to make sure the src/Chamilo/PluginBundle/Entity folder is
temporarily writeable by the web server.*
* Install the plugin and enable.
* Go to Settings tool in course base.
* Display the _Notify in course home_ section. And set the notification.
## Adding a notification
The notification has a HTML content and an optional _Expiration link_ field.
If this field is set, then the notification will be displayed until the user visualizes it.
Otherwise the notification will be displayed every time the user enter to the course home page.

@ -0,0 +1,100 @@
<?php
/* For licensing terms, see /license.txt */
require_once __DIR__.'/../../main/inc/global.inc.php';
use Chamilo\PluginBundle\Entity\CourseHomeNotify\Notification;
$plugin = CourseHomeNotifyPlugin::create();
$courseId = api_get_course_int_id();
if (
empty($courseId) ||
'true' !== $plugin->get(CourseHomeNotifyPlugin::SETTING_ENABLED)
) {
api_not_allowed(true);
}
$action = isset($_GET['action']) ? $_GET['action'] : '';
$course = api_get_course_entity($courseId);
$em = Database::getManager();
/** @var Notification $notification */
$notification = $em
->getRepository('ChamiloPluginBundle:CourseHomeNotify\Notification')
->findOneBy(['course' => $course]);
$actionLinks = '';
if ($notification) {
$actionLinks = Display::url(
Display::return_icon('delete.png', $plugin->get_lang('DeleteNotification'), [], ICON_SIZE_MEDIUM),
api_get_self().'?'.api_get_cidreq().'&action=delete'
);
if ('delete' === $action) {
$em->remove($notification);
$em->flush();
Display::addFlash(
Display::return_message($plugin->get_lang('NotificationDeleted'), 'success')
);
header('Location: '.api_get_course_url());
exit;
}
} else {
$notification = new Notification();
}
$form = new FormValidator('frm_course_home_notify');
$form->addHeader($plugin->get_lang('AddNotification'));
$form->applyFilter('title', 'trim');
$form->addHtmlEditor('content', get_lang('Content'), true, false, ['ToolbarSet' => 'Minimal']);
$form->addUrl(
'expiration_link',
[$plugin->get_lang('ExpirationLink'), $plugin->get_lang('ExpirationLinkHelp')],
false,
['placeholder' => 'https://']
);
$form->addButtonSave(get_lang('Save'));
if ($form->validate()) {
$values = $form->exportValues();
$notification
->setContent($values['content'])
->setExpirationLink($values['expiration_link'])
->setCourse($course)
->setHash(md5(uniqid()));
$em->persist($notification);
$em->flush();
Display::addFlash(
Display::return_message($plugin->get_lang('NotificationAdded'), 'success')
);
header('Location: '.api_get_course_url());
exit;
}
if ($notification) {
$form->setDefaults(
[
'content' => $notification->getContent(),
'expiration_link' => $notification->getExpirationLink(),
]
);
}
$template = new Template($plugin->get_title());
$template->assign('header', $plugin->get_title());
if ($actionLinks) {
$template->assign('actions', Display::toolbarAction('course-home-notify-actions', ['', $actionLinks]));
}
$template->assign('content', $form->returnForm());
$template->display_one_col_template();

@ -0,0 +1,52 @@
<?php
/* For licensing terms, see /license.txt */
require_once __DIR__.'/../../main/inc/global.inc.php';
use Chamilo\PluginBundle\Entity\CourseHomeNotify\Notification;
use Chamilo\PluginBundle\Entity\CourseHomeNotify\NotificationRelUser;
api_block_anonymous_users(true);
api_protect_course_script(true);
$plugin = CourseHomeNotifyPlugin::create();
$userId = api_get_user_id();
$courseId = api_get_course_int_id();
if (
empty($courseId) ||
empty($userId) ||
'true' !== $plugin->get(CourseHomeNotifyPlugin::SETTING_ENABLED)
) {
api_not_allowed(true);
}
$user = api_get_user_entity($userId);
$course = api_get_course_entity($courseId);
$hash = isset($_GET['hash']) ? Security::remove_XSS($_GET['hash']) : null;
$em = Database::getManager();
/** @var Notification $notification */
$notification = $em
->getRepository('ChamiloPluginBundle:CourseHomeNotify\Notification')
->findOneBy(['course' => $course, 'hash' => $hash]);
if (!$notification) {
api_not_allowed(true);
}
$notificationUser = $em
->getRepository('ChamiloPluginBundle:CourseHomeNotify\NotificationRelUser')
->findOneBy(['notification' => $notification, 'user' => $user]);
if (!$notificationUser) {
$notificationUser = new NotificationRelUser();
$notificationUser
->setUser($user)
->setNotification($notification);
$em->persist($notificationUser);
$em->flush();
}
header('Location: '.$notification->getExpirationLink());

@ -0,0 +1,8 @@
<?php
/* For licensing terms, see /license.txt */
if (!api_is_platform_admin()) {
api_not_allowed(true);
}
CourseHomeNotifyPlugin::create()->install();

@ -0,0 +1,17 @@
<?php
/* For licensing terms, see /license.txt */
$strings['plugin_title'] = "Notify in course home";
$strings['plugin_comment'] = "Show notifications when a user enter in course home page.";
$strings['enabled'] = 'Enabled';
$strings['SetNotification'] = 'Set one notification on home page';
$strings['DeleteNotification'] = 'Delete notification on course home page';
$strings['AddNotification'] = 'Add notification';
$strings['ExpirationLink'] = 'Expiration link';
$strings['CourseNotice'] = 'Course notice';
$strings['PleaseFollowThisLink'] = 'Please, follow this link to continue';
$strings['ExpirationLinkHelp'] = 'The notification will be displayed until the user visualizes it.';
$strings['NotificationAdded'] = 'Course notification added: It will be displayed in course home page.';
$strings['NotificationDeleted'] = 'Course notification deleted';

@ -0,0 +1,17 @@
<?php
/* For licensing terms, see /license.txt */
$strings['plugin_title'] = "Notificar en página de inicio del curso";
$strings['plugin_comment'] = "Mostrar notificaciones cuando un usuario ingresa en la página principal del curso.";
$strings['enabled'] = 'Habilitado';
$strings['SetNotification'] = 'Establecer una notificación en la página de inicio';
$strings['DeleteNotification'] = 'Eliminar notificación en la página de inicio del curso';
$strings['AddNotification'] = 'Añadir notificación';
$strings['ExpirationLink'] = 'Enlace de caducidad';
$strings['CourseNotice'] = 'Aviso del curso';
$strings['PleaseFollowThisLink'] = 'Por favor, siga este enlace para continuar.';
$strings['ExpirationLinkHelp'] = 'La notificación se mostrará hasta que el usuario la visualice.';
$strings['NotificationAdded'] = 'Notificación del curso agregada: se mostrará en la página de inicio del curso.';
$strings['NotificationDeleted'] = 'Notificación del curso borrada';

@ -0,0 +1,4 @@
<?php
/* For licensing terms, see /license.txt */
$plugin_info = CourseHomeNotifyPlugin::create()->get_info();

@ -0,0 +1,8 @@
<?php
/* For licensing terms, see /license.txt */
if (!api_is_platform_admin()) {
api_not_allowed(true);
}
CourseHomeNotifyPlugin::create()->uninstall();

@ -0,0 +1,250 @@
<?php
/* For licensing terms, see /license.txt */
use Chamilo\CoreBundle\Entity\Course;
use Chamilo\CoreBundle\Entity\Session;
use Chamilo\PluginBundle\Entity\EmbedRegistry\Embed;
use Doctrine\ORM\Tools\SchemaTool;
/**
* Class EmbedRegistryPlugin.
*/
class EmbedRegistryPlugin extends Plugin
{
public const SETTING_ENABLED = 'tool_enabled';
public const SETTING_TITLE = 'tool_title';
public const SETTING_EXTERNAL_URL = 'external_url';
public const TBL_EMBED = 'plugin_embed_registry_embed';
/**
* EmbedRegistryPlugin constructor.
*/
protected function __construct()
{
$authors = [
'Angel Fernando Quiroz Campos',
];
parent::__construct(
'1.0',
implode(', ', $authors),
[
self::SETTING_ENABLED => 'boolean',
self::SETTING_TITLE => 'text',
self::SETTING_EXTERNAL_URL => 'text',
]
);
}
/**
* @return string
*/
public function getToolTitle()
{
$title = $this->get(self::SETTING_TITLE);
if (!empty($title)) {
return $title;
}
return $this->get_title();
}
/**
* @return EmbedRegistryPlugin|null
*/
public static function create()
{
static $result = null;
return $result ? $result : $result = new self();
}
/**
* @throws \Doctrine\ORM\Tools\ToolsException
*/
public function install()
{
$em = Database::getManager();
if ($em->getConnection()->getSchemaManager()->tablesExist([self::TBL_EMBED])) {
return;
}
$schemaTool = new SchemaTool($em);
$schemaTool->createSchema(
[
$em->getClassMetadata(Embed::class),
]
);
}
public function uninstall()
{
$em = Database::getManager();
if (!$em->getConnection()->getSchemaManager()->tablesExist([self::TBL_EMBED])) {
return;
}
$schemaTool = new SchemaTool($em);
$schemaTool->dropSchema(
[
$em->getClassMetadata(Embed::class),
]
);
}
/**
* @return EmbedRegistryPlugin
*/
public function performActionsAfterConfigure()
{
$em = Database::getManager();
$this->deleteCourseToolLinks();
if ('true' === $this->get(self::SETTING_ENABLED)) {
$courses = $em->createQuery('SELECT c.id FROM ChamiloCoreBundle:Course c')->getResult();
foreach ($courses as $course) {
$this->createLinkToCourseTool($this->getToolTitle(), $course['id']);
}
}
return $this;
}
/**
* @param int $courseId
*/
public function doWhenDeletingCourse($courseId)
{
Database::getManager()
->createQuery('DELETE FROM ChamiloPluginBundle:EmbedRegistry\Embed e WHERE e.course = :course')
->execute(['course' => (int) $courseId]);
}
/**
* @param int $sessionId
*/
public function doWhenDeletingSession($sessionId)
{
Database::getManager()
->createQuery('DELETE FROM ChamiloPluginBundle:EmbedRegistry\Embed e WHERE e.session = :session')
->execute(['session' => (int) $sessionId]);
}
/**
* @throws \Doctrine\ORM\NonUniqueResultException
*
* @return Embed
*/
public function getCurrentEmbed(Course $course, Session $session = null)
{
$embedRepo = Database::getManager()->getRepository('ChamiloPluginBundle:EmbedRegistry\Embed');
$qb = $embedRepo->createQueryBuilder('e');
$query = $qb
->where('e.displayStartDate <= :now')
->andWhere('e.displayEndDate >= :now')
->andWhere(
$qb->expr()->eq('e.course', $course->getId())
);
$query->andWhere(
$session
? $qb->expr()->eq('e.session', $session->getId())
: $qb->expr()->isNull('e.session')
);
$query = $query
->orderBy('e.displayStartDate', 'DESC')
->setMaxResults(1)
->setParameters(['now' => api_get_utc_datetime(null, false, true)])
->getQuery();
return $query->getOneOrNullResult();
}
/**
* @return string
*/
public function formatDisplayDate(Embed $embed)
{
$startDate = sprintf(
'<time datetime="%s">%s</time>',
$embed->getDisplayStartDate()->format(DateTime::W3C),
api_convert_and_format_date($embed->getDisplayStartDate())
);
$endDate = sprintf(
'<time datetime="%s">%s</time>',
$embed->getDisplayEndDate()->format(DateTime::W3C),
api_convert_and_format_date($embed->getDisplayEndDate())
);
return sprintf(get_lang('FromDateXToDateY'), $startDate, $endDate);
}
/**
* @return string
*/
public function getViewUrl(Embed $embed)
{
return api_get_path(WEB_PLUGIN_PATH).'embedregistry/view.php?id='.$embed->getId().'&'.api_get_cidreq();
}
/**
* @throws \Doctrine\ORM\Query\QueryException
*
* @return int
*/
public function getMembersCount(Embed $embed)
{
$dql = 'SELECT COUNT(DISTINCT tea.accessUserId) FROM ChamiloCoreBundle:TrackEAccess tea
WHERE
tea.accessTool = :tool AND
(tea.accessDate >= :start_date AND tea.accessDate <= :end_date) AND
tea.cId = :course';
$params = [
'tool' => 'plugin_'.$this->get_name(),
'start_date' => $embed->getDisplayStartDate(),
'end_date' => $embed->getDisplayEndDate(),
'course' => $embed->getCourse(),
];
if ($embed->getSession()) {
$dql .= ' AND tea.accessSessionId = :session ';
$params['session'] = $embed->getSession();
}
$count = Database::getManager()
->createQuery($dql)
->setParameters($params)
->getSingleScalarResult();
return $count;
}
public function saveEventAccessTool()
{
$tableAccess = Database::get_main_table(TABLE_STATISTIC_TRACK_E_ACCESS);
$params = [
'access_user_id' => api_get_user_id(),
'c_id' => api_get_course_int_id(),
'access_tool' => 'plugin_'.$this->get_name(),
'access_date' => api_get_utc_datetime(),
'access_session_id' => api_get_session_id(),
'user_ip' => api_get_real_ip(),
];
Database::insert($tableAccess, $params);
}
private function deleteCourseToolLinks()
{
Database::getManager()
->createQuery('DELETE FROM ChamiloCourseBundle:CTool t WHERE t.category = :category AND t.link LIKE :link')
->execute(['category' => 'plugin', 'link' => 'embedregistry/start.php%']);
}
}

@ -0,0 +1,198 @@
<?php
/* For licensing terms, see /license.txt */
namespace Chamilo\PluginBundle\Entity\EmbedRegistry;
use Chamilo\CoreBundle\Entity\Course;
use Chamilo\CoreBundle\Entity\Session;
use Doctrine\ORM\Mapping as ORM;
/**
* Class EmbedRegistry.
*
* @package Chamilo\PluginBundle\Entity\EmbedRegistry
*
* @ORM\Entity()
* @ORM\Table(name="plugin_embed_registry_embed")
*/
class Embed
{
/**
* @var int
*
* @ORM\Column(name="id", type="integer")
* @ORM\Id
* @ORM\GeneratedValue
*/
private $id;
/**
* @var string
*
* @ORM\Column(name="title", type="text")
*/
private $title;
/**
* @var \DateTime
*
* @ORM\Column(name="display_start_date", type="datetime")
*/
private $displayStartDate;
/**
* @var \DateTime
*
* @ORM\Column(name="display_end_date", type="datetime")
*/
private $displayEndDate;
/**
* @var string
*
* @ORM\Column(name="html_code", type="text")
*/
private $htmlCode;
/**
* @var Course
*
* @ORM\ManyToOne(targetEntity="Chamilo\CoreBundle\Entity\Course")
* @ORM\JoinColumn(name="c_id", referencedColumnName="id", nullable=false)
*/
private $course;
/**
* @var Session|null
*
* @ORM\ManyToOne(targetEntity="Chamilo\CoreBundle\Entity\Session")
* @ORM\JoinColumn(name="session_id", referencedColumnName="id")
*/
private $session;
/**
* @return int
*/
public function getId()
{
return $this->id;
}
/**
* @param int $id
*
* @return Embed
*/
public function setId($id)
{
$this->id = $id;
return $this;
}
/**
* @return string
*/
public function getTitle()
{
return $this->title;
}
/**
* @param $title
*
* @return Embed
*/
public function setTitle($title)
{
$this->title = $title;
return $this;
}
/**
* @return \DateTime
*/
public function getDisplayStartDate()
{
return $this->displayStartDate;
}
/**
* @return Embed
*/
public function setDisplayStartDate(\DateTime $displayStartDate)
{
$this->displayStartDate = $displayStartDate;
return $this;
}
/**
* @return \DateTime
*/
public function getDisplayEndDate()
{
return $this->displayEndDate;
}
/**
* @return Embed
*/
public function setDisplayEndDate(\DateTime $displayEndDate)
{
$this->displayEndDate = $displayEndDate;
return $this;
}
/**
* @return string
*/
public function getHtmlCode()
{
return $this->htmlCode;
}
/**
* @param string $htmlCode
*
* @return Embed
*/
public function setHtmlCode($htmlCode)
{
$this->htmlCode = $htmlCode;
return $this;
}
/**
* @return Course
*/
public function getCourse()
{
return $this->course;
}
/**
* @return Embed
*/
public function setCourse(Course $course)
{
$this->course = $course;
return $this;
}
/**
* @return Session|null
*/
public function getSession()
{
return $this->session;
}
/**
* @return Embed
*/
public function setSession(Session $session = null)
{
$this->session = $session;
return $this;
}
}

@ -0,0 +1,14 @@
# Embed Registry
Add a new tool in every course to offer embedded content from external sources
*and* track accesses to the content itself (so you can monitor the interest).
## Set up
Prior to installing/uninstalling this plugin, make sure the src/Chamilo/PluginBundle/Entity folder is
temporarily writeable by the web server.
Enable the plugin. Suggest a default source for all the embedded content, then let teachers define the
content (usually videos) they want to embed into their courses.
Time periods allow teachers to schedule the highlighting of some content above others at specific dates.

@ -1,4 +1,4 @@
<?php
/* For licensing terms, see /license.txt */
WhispeakAuthPlugin::create()->install();
EmbedRegistryPlugin::create()->install();

@ -0,0 +1,22 @@
<?php
/* For licensing terms, see /license.txt */
$strings['plugin_title'] = 'Embed Registry';
$strings['plugin_comment'] = "Add a new course tool to include embedded content in a more structured way and track students' access to it.";
$strings['tool_enabled'] = 'Tool enabled';
$strings['tool_title'] = 'Tool Title';
$strings['tool_title_help'] = 'The title of the tool icon on the course homepage (usually the title of the service being shared).';
$strings['external_url'] = 'External tool';
$strings['external_url_help'] = 'The URL at which the external content is managed. Usually something like https://[provider.com]/my_account. This can be used as a shortcut by the teachers internally, but they can also decide to embed something completely different.';
$strings['YouNeedCreateContent'] = 'First you need to register external (embedded) content, then you will be able to make those embeds available to students into your course (through this tool).';
$strings['CreateContent'] = 'Create external content';
$strings['CreateEmbeddable'] = 'Add embedded content';
$strings['EditEmbeddable'] = 'Edit embedded content';
$strings['ContentNotFound'] = 'Content not found';
$strings['EmbedTitleHelp'] = 'The title you wish to show for this embedded content in particular. If it requires a password to play, include it here to allow your users to unlock it.';
$strings['EmbedDateRangeHelp'] = 'Within those dates, this embedded content will be shown directly in the top part of the page.';
$strings['HtmlCode'] = 'HTML code';
$strings['HtmlCodeHelp'] = 'The shared HTML code, as provided by the external service, when asking to share in Embedded format.';
$strings['LaunchContent'] = 'Launch content';

@ -0,0 +1,22 @@
<?php
/* For licensing terms, see /license.txt */
$strings['plugin_title'] = 'Registre de contenu incrusté (embedded)';
$strings['plugin_comment'] = 'Ajoute un outil à chaque cours pour y afficher une liste de contenus partagés via code Embed depuis un service en ligne (externe). Enregistre les visualisations de ces contenus par vos utilisateurs.';
$strings['tool_enabled'] = 'Outil activé';
$strings['tool_title'] = 'Titre de l\'outil';
$strings['tool_title_help'] = 'Le titre de l\'outil qui apparaîtra sur la page principale du cours (il s\'agit généralement du nom du service externe qui est partagé).';
$strings['external_url'] = 'URL service externe';
$strings['external_url_help'] = 'L\'URL de la page de gestion du contenu extérieur sur le site du fournisseur de service correspondant. Habituellement quelque chose du genre https://[fournisseur.com]/my_account.';
$strings['YouNeedCreateContent'] = 'Vous devez d\'abord créer le contenu externe. Ensuite vous pourrez ajouter ce contenu au format Embed dans votre cours.';
$strings['CreateContent'] = 'Créer contenu externe';
$strings['CreateEmbeddable'] = 'Créer';
$strings['EditEmbeddable'] = 'Éditer';
$strings['ContentNotFound'] = 'Impossible de vérifier le contenu';
$strings['EmbedTitleHelp'] = 'Le titre que vous souhaitez montrer pour ce contenu incrusté. S\'il requiert un mot de passe, ajoutez-le ici pour que vos utilisateurs puissent le débloquer.';
$strings['EmbedDateRangeHelp'] = 'Entre ces dates, le contenu actif sera mis en évidence dans la partie supérieure de cette page.';
$strings['HtmlCode'] = 'Code HTML';
$strings['HtmlCodeHelp'] = 'Le code HTML partagé, tel que fourni par le service externe au moment de le partager au format "Embed".';
$strings['LaunchContent'] = 'Voir le contenu';

@ -0,0 +1,22 @@
<?php
/* For licensing terms, see /license.txt */
$strings['plugin_title'] = 'Registro de contenido Embed';
$strings['plugin_comment'] = 'Agrega una herramienta de curso para llevar un registro del contenido Embed y registrar el acceso de los estudiantes a este.';
$strings['tool_enabled'] = 'Herramienta habilitada';
$strings['tool_title'] = 'Título de la herramienta';
$strings['tool_title_help'] = 'El título del icono de la herramienta en la página principal del curso (usualmente el título del servicio siendo compartido).';
$strings['external_url'] = 'URL externa';
$strings['external_url_help'] = 'La URL en la cual se puede gestionar el contenido que va a ser embedido en esta herramienta. Usualmente algo como https://[proveedor.com]/my_account, por ejemplo.';
$strings['YouNeedCreateContent'] = 'Necesita tener contenido externo para luego pegar su código embed aquí.';
$strings['CreateContent'] = 'Crear contenido externo';
$strings['CreateEmbeddable'] = 'Crear';
$strings['EditEmbeddable'] = 'Editar';
$strings['ContentNotFound'] = 'Contenido no encontrado';
$strings['EmbedTitleHelp'] = 'El título que desea que tenga este contenido incrustado en particular. Si tiene contraseña, incluya la contraseña para que sus usuarios puedan abrirlo.';
$strings['EmbedDateRangeHelp'] = 'Dentro de este rango de fechas, el contenido activo será resaltado en la parte superior de la página.';
$strings['HtmlCode'] = 'Código HTML';
$strings['HtmlCodeHelp'] = 'El código HTML compartido por la herramienta externa, al elegir compartir en formato Embed.';
$strings['LaunchContent'] = 'Ingresar ahora';

@ -0,0 +1,4 @@
<?php
/* For licensing terms, see /license.txt */
$plugin_info = EmbedRegistryPlugin::create()->get_info();

@ -0,0 +1,309 @@
<?php
/* For licensing terms, see /license.txt */
use Chamilo\PluginBundle\Entity\EmbedRegistry\Embed;
require_once __DIR__.'/../../main/inc/global.inc.php';
api_block_anonymous_users();
api_protect_course_script(true);
$plugin = EmbedRegistryPlugin::create();
if ('false' === $plugin->get(EmbedRegistryPlugin::SETTING_ENABLED)) {
api_not_allowed(true);
}
$isAllowedToEdit = api_is_allowed_to_edit(true);
$action = isset($_REQUEST['action']) ? $_REQUEST['action'] : null;
$em = Database::getManager();
$embedRepo = $em->getRepository('ChamiloPluginBundle:EmbedRegistry\Embed');
$course = api_get_course_entity(api_get_course_int_id());
$session = api_get_session_entity(api_get_session_id());
$actions = [];
$view = new Template($plugin->getToolTitle());
$view->assign('is_allowed_to_edit', $isAllowedToEdit);
switch ($action) {
case 'add':
if (!$isAllowedToEdit) {
api_not_allowed(true);
}
$actions[] = Display::url(
Display::return_icon('back.png', get_lang('Back'), [], ICON_SIZE_MEDIUM),
api_get_self()
);
$form = new FormValidator('frm_edit');
$form->addText(
'title',
[get_lang('Title'), $plugin->get_lang('EmbedTitleHelp')],
true
);
$form->addDateRangePicker(
'range',
[get_lang('DateRange'), $plugin->get_lang('EmbedDateRangeHelp')]
);
$form->addTextarea(
'html_code',
[$plugin->get_lang('HtmlCode'), $plugin->get_lang('HtmlCodeHelp')],
['rows' => 5],
true
);
$form->addButtonUpdate(get_lang('Add'));
$form->addHidden('action', 'add');
if ($form->validate()) {
$values = $form->exportValues();
$startDate = api_get_utc_datetime($values['range_start'], false, true);
$endDate = api_get_utc_datetime($values['range_end'], false, true);
$embed = new Embed();
$embed
->setTitle($values['title'])
->setDisplayStartDate($startDate)
->setDisplayEndDate($endDate)
->setHtmlCode($values['html_code'])
->setCourse($course)
->setSession($session);
$em->persist($embed);
$em->flush();
Display::addFlash(
Display::return_message(get_lang('Added'), 'success')
);
header('Location: '.api_get_self());
exit;
}
$view->assign('header', $plugin->get_lang('CreateEmbeddable'));
$view->assign('form', $form->returnForm());
$externalUrl = $plugin->get(EmbedRegistryPlugin::SETTING_EXTERNAL_URL);
if (!empty($externalUrl)) {
$view->assign('external_url', $externalUrl);
}
break;
case 'edit':
if (!$isAllowedToEdit) {
api_not_allowed(true);
}
$actions[] = Display::url(
Display::return_icon('back.png', get_lang('Back'), [], ICON_SIZE_MEDIUM),
api_get_self()
);
$embedId = isset($_REQUEST['id']) ? (int) $_REQUEST['id'] : 0;
if (!$embedId) {
break;
}
/** @var Embed|null $embed */
$embed = $embedRepo->find($embedId);
if (!$embed) {
Display::addFlash(Display::return_message($plugin->get_lang('ContentNotFound'), 'danger'));
break;
}
$form = new FormValidator('frm_edit');
$form->addText('title', get_lang('Title'), true);
$form->addDateRangePicker('range', get_lang('DateRange'));
$form->addTextarea('html_code', $plugin->get_lang('HtmlCode'), ['rows' => 5], true);
$form->addButtonUpdate(get_lang('Edit'));
$form->addHidden('id', $embed->getId());
$form->addHidden('action', 'edit');
if ($form->validate()) {
$values = $form->exportValues();
$startDate = api_get_utc_datetime($values['range_start'], false, true);
$endDate = api_get_utc_datetime($values['range_end'], false, true);
$embed
->setTitle($values['title'])
->setDisplayStartDate($startDate)
->setDisplayEndDate($endDate)
->setHtmlCode($values['html_code']);
$em->persist($embed);
$em->flush();
Display::addFlash(
Display::return_message(get_lang('Updated'), 'success')
);
header('Location: '.api_get_self());
exit;
}
$form->setDefaults(
[
'title' => $embed->getTitle(),
'range' => api_get_local_time($embed->getDisplayStartDate())
.' / '
.api_get_local_time($embed->getDisplayEndDate()),
'html_code' => $embed->getHtmlCode(),
]
);
$view->assign('header', $plugin->get_lang('EditEmbeddable'));
$view->assign('form', $form->returnForm());
break;
case 'delete':
$embedId = isset($_REQUEST['id']) ? (int) $_REQUEST['id'] : 0;
if (!$embedId) {
break;
}
/** @var Embed|null $embed */
$embed = $embedRepo->find($embedId);
if (!$embed) {
Display::addFlash(Display::return_message($plugin->get_lang('ContentNotFound'), 'danger'));
break;
}
$em->remove($embed);
$em->flush();
Display::addFlash(
Display::return_message(get_lang('Deleted'), 'success')
);
header('Location: '.api_get_self());
exit;
default:
$currentEmbed = $plugin->getCurrentEmbed($course, $session);
/** @var array|Embed[] $embeds */
$embeds = $embedRepo->findBy(['course' => $course, 'session' => $session]);
$tableData = [];
foreach ($embeds as $embed) {
$data = [
$embed->getTitle(),
api_convert_and_format_date($embed->getDisplayStartDate()),
api_convert_and_format_date($embed->getDisplayEndDate()),
$embed,
];
if ($isAllowedToEdit) {
$data[] = $embed;
}
$tableData[] = $data;
}
if ($isAllowedToEdit) {
$btnAdd = Display::toolbarButton(
$plugin->get_lang('CreateEmbeddable'),
api_get_self().'?action=add',
'file-code-o',
'primary'
);
$view->assign(
'actions',
Display::toolbarAction($plugin->get_name(), [$btnAdd])
);
if (in_array($action, ['add', 'edit'])) {
$view->assign('form', $form->returnForm());
}
}
if ($currentEmbed) {
$view->assign('current_embed', $currentEmbed);
$view->assign(
'current_link',
Display::toolbarButton(
$plugin->get_lang('LaunchContent'),
$plugin->getViewUrl($embed),
'rocket',
'info'
)
);
}
$table = new SortableTableFromArray($tableData, 1);
$table->set_header(0, get_lang('Title'));
$table->set_header(1, get_lang('AvailableFrom'), true, 'th-header text-center', ['class' => 'text-center']);
$table->set_header(2, get_lang('AvailableTill'), true, 'th-header text-center', ['class' => 'text-center']);
if ($isAllowedToEdit) {
$table->set_header(3, get_lang('Members'), false, 'th-header text-right', ['class' => 'text-right']);
$table->set_column_filter(
3,
function (Embed $value) use ($plugin) {
return $plugin->getMembersCount($value);
}
);
}
$table->set_header(
$isAllowedToEdit ? 4 : 3,
get_lang('Actions'),
false,
'th-header text-right',
['class' => 'text-right']
);
$table->set_column_filter(
$isAllowedToEdit ? 4 : 3,
function (Embed $value) use ($isAllowedToEdit, $plugin) {
$actions = [];
$actions[] = Display::url(
Display::return_icon('external_link.png', get_lang('View')),
$plugin->getViewUrl($value)
);
if ($isAllowedToEdit) {
$actions[] = Display::url(
Display::return_icon('edit.png', get_lang('Edit')),
api_get_self().'?action=edit&id='.$value->getId()
);
$actions[] = Display::url(
Display::return_icon('delete.png', get_lang('Delete')),
api_get_self().'?action=delete&id='.$value->getId()
);
}
return implode(PHP_EOL, $actions);
}
);
$view->assign('embeds', $embeds);
$view->assign('table', $table->return_table());
}
$content = $view->fetch('embedregistry/view/start.tpl');
if ($actions) {
$actions = implode(PHP_EOL, $actions);
$view->assign(
'actions',
Display::toolbarAction($plugin->get_name(), [$actions])
);
}
$view->assign('content', $content);
$view->display_one_col_template();

@ -1,4 +1,4 @@
<?php
/* For licensing terms, see /license.txt */
WhispeakAuthPlugin::create()->uninstall();
EmbedRegistryPlugin::create()->uninstall();

@ -0,0 +1,72 @@
<?php
/* For licensing terms, see /license.txt */
use Chamilo\PluginBundle\Entity\EmbedRegistry\Embed;
require_once __DIR__.'/../../main/inc/global.inc.php';
api_block_anonymous_users();
api_protect_course_script(true);
$plugin = EmbedRegistryPlugin::create();
if ('false' === $plugin->get(EmbedRegistryPlugin::SETTING_ENABLED)) {
api_not_allowed(true);
}
$isAllowedToEdit = api_is_allowed_to_edit(true);
$em = Database::getManager();
$embedRepo = $em->getRepository('ChamiloPluginBundle:EmbedRegistry\Embed');
$course = api_get_course_entity(api_get_course_int_id());
$session = api_get_session_entity(api_get_session_id());
$embedId = isset($_REQUEST['id']) ? (int) $_REQUEST['id'] : 0;
if (!$embedId) {
api_not_allowed(true);
}
/** @var Embed|null $embed */
$embed = $embedRepo->find($embedId);
if (!$embed) {
api_not_allowed(
true,
Display::return_message($plugin->get_lang('ContentNotFound'), 'danger')
);
}
if ($course->getId() !== $embed->getCourse()->getId()) {
api_not_allowed(true);
}
if ($session && $embed->getSession()) {
if ($session->getId() !== $embed->getSession()->getId()) {
api_not_allowed(true);
}
}
$plugin->saveEventAccessTool();
$interbreadcrumb[] = [
'name' => $plugin->getToolTitle(),
'url' => api_get_path(WEB_PLUGIN_PATH).$plugin->get_name().'/start.php',
];
$actions = Display::url(
Display::return_icon('back.png', get_lang('Back'), [], ICON_SIZE_MEDIUM),
api_get_path(WEB_PLUGIN_PATH).$plugin->get_name().'/start.php?'.api_get_cidreq()
);
$view = new Template($embed->getTitle());
$view->assign('header', $embed->getTitle());
$view->assign('actions', Display::toolbarAction($plugin->get_name(), [$actions]));
$view->assign(
'content',
'<p>'.$plugin->formatDisplayDate($embed).'</p>'
.PHP_EOL
.Security::remove_XSS($embed->getHtmlCode(), COURSEMANAGERLOWSECURITY)
);
$view->display_one_col_template();

@ -0,0 +1,37 @@
{% if is_allowed_to_edit %}
{% if external_url is defined %}
<div class="alert alert-info">
<p>
{{ 'YouNeedCreateContent'|get_plugin_lang('EmbedRegistryPlugin') }}
<a href="{{ external_url }}" class="btn btn-info" target="_blank">{{ 'CreateContent'|get_plugin_lang('EmbedRegistryPlugin') }}</a>
</p>
</div>
{% endif %}
{% if form is defined %}
{{ form }}
{% endif %}
{% endif %}
{% if current_embed is defined %}
{% set start_date %}
<time datetime="{{ current_embed.displayStartDate.format(constant('\DateTime::W3C')) }}">
{{ current_embed.displayStartDate|api_convert_and_format_date }}
</time>
{% endset %}
{% set end_date %}
<time datetime="{{ current_embed.displayEndDate.format(constant('\DateTime::W3C')) }}">
{{ current_embed.displayEndDate|api_convert_and_format_date }}
</time>
{% endset %}
<div class="well well-sm text-center">
<p class="lead">{{ current_embed.title }}</p>
<p>
<small>{{ 'FromDateXToDateY'|get_lang|format(start_date, end_date) }}</small>
</p>
<p>{{ current_link }}</p>
</div>
{% endif %}
{{ table }}

@ -0,0 +1,22 @@
# External Notification Connect
Activate external notification system, that will send a notification to an external REST webservice on a specific Chamilo's action trigger.
At the moment it will send notifications on :
* Learning path creation (Chamilo LP or Scorm import)
* Portfolio post creation, deletion or edition
For creation notifications, it will send :
* user_id : id of the user creating the item
* content_id : internal Chamilo id of the item created
* content_url : URL to see the content
* content_title : title of the item
* course_code : code of the course in Chamilo in which the item as been created
* content_type : 'eportfolio' or 'lp'
For editions and deletions, it will send :
* content_id : internal Chamilo id of the item
* content_type : 'eportfolio' or 'lp'

@ -0,0 +1,5 @@
<?php
/* For licensing terms, see /license.txt */
ExternalNotificationConnectPlugin::create()->install();

@ -0,0 +1,18 @@
<?php
/* For licensing terms, see /license.txt */
$strings['plugin_title'] = 'External Notification Connect';
$strings['plugin_comment'] = 'Activate external notification system';
$strings['tool_enable'] = 'Enabled';
$strings['auth_url'] = 'Authentication endpoint';
$strings['auth_url_help'] = 'URL for authentication API';
$strings['auth_username'] = 'Username for authentication';
$strings['auth_password'] = 'Password for authentication';
$strings['notification_url'] = 'Notification endpoint';
$strings['notification_url_help'] = 'URL for notification API';
$strings['notify_portfolio'] = 'Portfolio';
$strings['notify_portfolio_help'] = 'Put it to <i>Yes</i> to activate external notification for Portfolio tool actions';
$strings['notify_learnpath'] = 'Learning path';
$strings['notify_learnpath_help'] = 'Put it to <i>Yes</i> to activate external notification for learning path creation';

@ -0,0 +1,18 @@
<?php
/* For licensing terms, see /license.txt */
$strings['plugin_title'] = 'Envoi de notifications externes';
$strings['plugin_comment'] = 'Activer un système de notification externe';
$strings['tool_enable'] = 'Activer';
$strings['auth_url'] = 'URL d\'authentification';
$strings['auth_url_help'] = 'URL d\'authentication de l\'API';
$strings['auth_username'] = 'Nom d\'utilisateur pour l\'authentication';
$strings['auth_password'] = 'Mot de passe pour l\'authentication';
$strings['notification_url'] = 'URL de Notification';
$strings['notification_url_help'] = 'URL de l\'API pour l\'envoi des notifications';
$strings['notify_portfolio'] = 'Portfolio';
$strings['notify_portfolio_help'] = 'Mettre à <i>Oui</i> pour activer les notifications pour les actions du Portfolio';
$strings['notify_learnpath'] = 'Parcours';
$strings['notify_learnpath_help'] = 'Mettre à <i>Oui</i> pour activer les notifications pour la création de parcours';

@ -0,0 +1,18 @@
<?php
/* For licensing terms, see /license.txt */
$strings['plugin_title'] = 'Conexión de notificación externa';
$strings['plugin_comment'] = 'Activar un sistema de notificaciones externo';
$strings['tool_enable'] = 'Activado';
$strings['auth_url'] = 'Punto de conexión de autenticación';
$strings['auth_url_help'] = 'URL para API de autenticación';
$strings['auth_username'] = 'Nombre de usuario para autenticación';
$strings['auth_password'] = 'Contraseña para autenticación';
$strings['notification_url'] = 'Punto de conexión de la notificación';
$strings['notification_url_help'] = 'URL para la API de notificación';
$strings['notify_portfolio'] = 'Portafolio';
$strings['notify_portfolio_help'] = 'Ponerlo a <i></i> para activar la notificación externa para las acciones de la herramienta Portafolio';
$strings['notify_learnpath'] = 'Lecciones';
$strings['notify_learnpath_help'] = 'Ponerlo a <i></i> para activar la notificación externa para la creación de lecciones';

@ -0,0 +1,5 @@
<?php
/* For licensing terms, see /license.txt */
$plugin_info = ExternalNotificationConnectPlugin::create()->get_info();

@ -0,0 +1,71 @@
<?php
/* For licensing terms, see /license.txt */
namespace Chamilo\PluginBundle\ExternalNotificationConnect\Entity;
use Doctrine\ORM\Mapping as ORM;
/**
* @ORM\Table(name="plugin_ext_notif_conn_access_token")
* @ORM\Entity()
*/
class AccessToken
{
/**
* @var int
*
* @ORM\Id()
* @ORM\GeneratedValue(strategy="IDENTITY")
* @ORM\Column(name="id", type="integer")
*/
private $id;
/**
* @var string
*
* @ORM\Column(name="access_token", type="text")
*/
private $token;
/**
* @var bool
*
* @ORM\Column(name="is_valid", type="boolean")
*/
private $isValid;
public function getId(): int
{
return $this->id;
}
public function setId(int $id): AccessToken
{
$this->id = $id;
return $this;
}
public function getToken(): string
{
return $this->token;
}
public function setToken(string $token): AccessToken
{
$this->token = $token;
return $this;
}
public function isValid(): bool
{
return $this->isValid;
}
public function setIsValid(bool $isValid): AccessToken
{
$this->isValid = $isValid;
return $this;
}
}

@ -0,0 +1,241 @@
<?php
/* For licensing terms, see /license.txt */
use Chamilo\PluginBundle\ExternalNotificationConnect\Entity\AccessToken;
use Doctrine\ORM\Tools\SchemaTool;
use Doctrine\ORM\Tools\ToolsException;
use Firebase\JWT\JWT;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\ClientException;
use GuzzleHttp\Exception\GuzzleException;
use GuzzleHttp\Exception\ServerException;
class ExternalNotificationConnectPlugin extends Plugin implements HookPluginInterface
{
public const SETTING_AUTH_URL = 'auth_url';
public const SETTING_AUTH_USERNAME = 'auth_username';
public const SETTING_AUTH_PASSWORD = 'auth_password';
public const SETTING_NOTIFICATION_URL = 'notification_url';
public const SETTING_NOTIFY_PORTFOLIO = 'notify_portfolio';
public const SETTING_NOTIFY_LEARNPATH = 'notify_learnpath';
protected function __construct()
{
$author = [
'Angel Fernando Quiroz Campos <angel.quiroz@beeznest.com>',
];
$settings = [
'tool_enable' => 'boolean',
self::SETTING_AUTH_URL => 'text',
self::SETTING_AUTH_USERNAME => 'text',
self::SETTING_AUTH_PASSWORD => 'text',
self::SETTING_NOTIFICATION_URL => 'text',
self::SETTING_NOTIFY_PORTFOLIO => 'boolean',
self::SETTING_NOTIFY_LEARNPATH => 'boolean',
];
parent::__construct(
'1.0',
implode('; ', $author),
$settings
);
}
public static function create(): ?ExternalNotificationConnectPlugin
{
static $result = null;
return $result ?: $result = new self();
}
public function performActionsAfterConfigure(): ExternalNotificationConnectPlugin
{
$portfolioItemAddedEvent = HookPortfolioItemAdded::create();
$portfolioItemEditedEvent = HookPortfolioItemEdited::create();
$portfolioItemDeletedEvent = HookPortfolioItemDeleted::create();
$portfolioItemVisibilityEvent = HookPortfolioItemVisibility::create();
$portfolioItemAddedObserver = ExternalNotificationConnectPortfolioItemAddedHookObserver::create();
$portfolioItemEditedObserver = ExternalNotificationConnectPortfolioItemEditedHookObserver::create();
$portfolioItemDeletedObserver = ExternalNotificationConnectPortfolioItemDeletedHookObserver::create();
$portfolioItemVisibilityObserver = ExternalNotificationConnectPortfolioItemVisibilityHookObserver::create();
if ('true' === $this->get(self::SETTING_NOTIFY_PORTFOLIO)) {
$portfolioItemAddedEvent->attach($portfolioItemAddedObserver);
$portfolioItemEditedEvent->attach($portfolioItemEditedObserver);
$portfolioItemDeletedEvent->attach($portfolioItemDeletedObserver);
$portfolioItemVisibilityEvent->attach($portfolioItemVisibilityObserver);
} else {
$portfolioItemAddedEvent->detach($portfolioItemAddedObserver);
$portfolioItemEditedEvent->detach($portfolioItemEditedObserver);
$portfolioItemDeletedEvent->detach($portfolioItemDeletedObserver);
$portfolioItemVisibilityEvent->detach($portfolioItemVisibilityObserver);
}
$lpCreatedEvent = HookLearningPathCreated::create();
$lpCreatedObserver = ExternalNotificationConnectLearningPathCreatedHookObserver::create();
if ('true' === $this->get(self::SETTING_NOTIFY_LEARNPATH)) {
$lpCreatedEvent->attach($lpCreatedObserver);
} else {
$lpCreatedEvent->detach($lpCreatedObserver);
}
return $this;
}
public function installHook()
{
}
public function uninstallHook()
{
$portfolioItemAddedEvent = HookPortfolioItemAdded::create();
$portfolioItemEditedEvent = HookPortfolioItemEdited::create();
$portfolioItemDeletedEvent = HookPortfolioItemDeleted::create();
$portfolioItemVisibilityEvent = HookPortfolioItemVisibility::create();
$lpCreatedEvent = HookLearningPathCreated::create();
$portfolioItemAddedObserver = ExternalNotificationConnectPortfolioItemAddedHookObserver::create();
$portfolioItemEditedObserver = ExternalNotificationConnectPortfolioItemEditedHookObserver::create();
$portfolioItemDeletedObserver = ExternalNotificationConnectPortfolioItemDeletedHookObserver::create();
$portfolioItemVisibilityObserver = ExternalNotificationConnectPortfolioItemVisibilityHookObserver::create();
$lpCreatedObserver = ExternalNotificationConnectLearningPathCreatedHookObserver::create();
$portfolioItemAddedEvent->detach($portfolioItemAddedObserver);
$portfolioItemEditedEvent->detach($portfolioItemEditedObserver);
$portfolioItemDeletedEvent->detach($portfolioItemDeletedObserver);
$portfolioItemVisibilityEvent->detach($portfolioItemVisibilityObserver);
$lpCreatedEvent->detach($lpCreatedObserver);
}
public function install()
{
$em = Database::getManager();
$schemaManager = $em->getConnection()->getSchemaManager();
$tableExists = $schemaManager->tablesExist(['plugin_ext_notif_conn_access_token']);
if ($tableExists) {
return;
}
$this->installDBTables();
$this->installHook();
}
public function uninstall()
{
$this->uninstallHook();
$this->uninstallDBTables();
}
/**
* @throws \Doctrine\ORM\OptimisticLockException
* @throws \Doctrine\ORM\ORMException
* @throws Exception
*/
public function getAccessToken()
{
$em = Database::getManager();
$tokenRepository = $em->getRepository(AccessToken::class);
$accessToken = $tokenRepository->findOneBy(['isValid' => true]);
if (!$accessToken) {
$newToken = $this->requestAuthToken();
$accessToken = (new AccessToken())
->setToken($newToken)
->setIsValid(true);
$em->persist($accessToken);
$em->flush();
} else {
$tks = explode('.', $accessToken->getToken());
$payload = json_decode(JWT::urlsafeB64Decode($tks[1]), true);
if (time() >= $payload['exp']) {
$accessToken->setIsValid(false);
$newToken = $this->requestAuthToken();
$accessToken = (new AccessToken())
->setToken($newToken)
->setIsValid(true);
$em->persist($accessToken);
$em->flush();
}
}
return $accessToken->getToken();
}
private function installDBTables()
{
$em = Database::getManager();
try {
(new SchemaTool($em))
->createSchema([
$em->getClassMetadata(AccessToken::class),
]);
} catch (ToolsException $e) {
return;
}
}
private function uninstallDBTables()
{
$em = Database::getManager();
(new SchemaTool($em))
->dropSchema([
$em->getClassMetadata(AccessToken::class),
]);
}
/**
* @throws Exception
*/
private function requestAuthToken(): string
{
$client = new Client();
try {
$response = $client->request(
'POST',
$this->get(ExternalNotificationConnectPlugin::SETTING_AUTH_URL),
[
'json' => [
'email' => $this->get(ExternalNotificationConnectPlugin::SETTING_AUTH_USERNAME),
'password' => $this->get(ExternalNotificationConnectPlugin::SETTING_AUTH_PASSWORD),
],
]
);
} catch (ClientException|ServerException $e) {
if (!$e->hasResponse()) {
throw new Exception($e->getMessage());
}
$response = $e->getResponse();
} catch (GuzzleException $e) {
throw new Exception($e->getMessage());
}
$json = json_decode((string) $response->getBody(), true);
if (201 !== $json['status']) {
throw new Exception($json['message']);
}
return $json['data']['data']['token'];
}
}

@ -0,0 +1,21 @@
<?php
/* For licensing terms, see /license.txt */
abstract class ExternalNotificationConnectHookObserver extends HookObserver
{
/**
* @var ExternalNotificationConnectPlugin
*/
protected $plugin;
protected function __construct()
{
parent::__construct(
'plugin/externalnotificationconnect/src/ExternalNotificationConnectPlugin.php',
'externalnotificationconnect'
);
$this->plugin = ExternalNotificationConnectPlugin::create();
}
}

@ -0,0 +1,56 @@
<?php
/* For licensing terms, see /license.txt */
use Chamilo\CourseBundle\Entity\CLp;
use Chamilo\PluginBundle\ExternalNotificationConnect\Traits\RequestTrait\RequestTrait;
class ExternalNotificationConnectLearningPathCreatedHookObserver extends ExternalNotificationConnectHookObserver implements HookLearningPathCreatedObserverInterface
{
use RequestTrait;
public function hookCreated(HookLearningPathCreatedEventInterface $hookEvent)
{
/** @var CLp $lp */
$lp = $hookEvent->getEventData()['lp'];
$userId = api_get_user_id();
$courseCode = api_get_course_id();
$cidreq = api_get_cidreq();
$url = api_get_path(WEB_CODE_PATH).'lp/lp_controller.php?';
$url .= ($cidreq ? $cidreq.'&' : '');
$url .= http_build_query(
[
'action' => 'view',
'lp_id' => $lp->getIid(),
'isStudentView' => 'true',
]
);
try {
$json = $this->doCreateRequest(
[
'user_id' => $userId,
'course_code' => $courseCode,
'content_id' => $lp->getIid(),
'content_type' => 'lp',
'content_url' => $url,
'post_title' => $lp->getName(),
]
);
} catch (Exception $e) {
Display::addFlash(
Display::return_message($e->getMessage(), 'error')
);
return;
}
if (empty($json)) {
return;
}
error_log('ExtNotifConn: Learning path created: ID '.$json['data']['notification_id']);
}
}

@ -0,0 +1,50 @@
<?php
/* For licensing terms, see /license.txt */
use Chamilo\CoreBundle\Entity\Portfolio;
use Chamilo\PluginBundle\ExternalNotificationConnect\Traits\RequestTrait\RequestTrait;
class ExternalNotificationConnectPortfolioItemAddedHookObserver extends ExternalNotificationConnectHookObserver implements HookPortfolioItemAddedObserverInterface
{
use RequestTrait;
public function hookItemAdded(HookPortfolioItemAddedEventInterface $hookEvent)
{
/** @var Portfolio $item */
$item = $hookEvent->getEventData()['portfolio'];
$userId = api_get_user_id();
$courseCode = api_get_course_id();
$cidreq = api_get_cidreq();
$url = api_get_path(WEB_CODE_PATH).'portfolio/index.php?';
$url .= ($cidreq ? $cidreq.'&' : '');
$url .= http_build_query(['action' => 'view', 'id' => $item->getId()]);
try {
$json = $this->doCreateRequest(
[
'user_id' => $userId,
'course_code' => $courseCode,
'content_id' => $item->getId(),
'content_type' => 'eportfolio',
'content_url' => $url,
'post_title' => $item->getTitle(),
]
);
} catch (Exception $e) {
Display::addFlash(
Display::return_message($e->getMessage(), 'error')
);
return;
}
if (empty($json)) {
return;
}
error_log('ExtNotifConn: Portfolio item created: ID '.$json['data']['notification_id']);
}
}

@ -0,0 +1,33 @@
<?php
/* For licensing terms, see /license.txt */
use Chamilo\CoreBundle\Entity\Portfolio;
use Chamilo\PluginBundle\ExternalNotificationConnect\Traits\RequestTrait\RequestTrait;
class ExternalNotificationConnectPortfolioItemDeletedHookObserver extends ExternalNotificationConnectHookObserver implements HookPortfolioItemDeletedHookObserverInterface
{
use RequestTrait;
public function hookItemDeleted(HookPortfolioItemDeletedEventInterface $hookEvent)
{
/** @var Portfolio $item */
$item = $hookEvent->getEventData()['item'];
try {
$json = $this->doDeleteRequest($item->getId(), 'eportfolio');
} catch (Exception $e) {
Display::addFlash(
Display::return_message($e->getMessage(), 'error')
);
return;
}
if (empty($json)) {
return;
}
error_log('ExtNotifConn: Portfolio item deleted: Status '.((int) $json['status']));
}
}

@ -0,0 +1,50 @@
<?php
/* For licensing terms, see /license.txt */
use Chamilo\CoreBundle\Entity\Portfolio;
use Chamilo\PluginBundle\ExternalNotificationConnect\Traits\RequestTrait\RequestTrait;
class ExternalNotificationConnectPortfolioItemEditedHookObserver extends ExternalNotificationConnectHookObserver implements HookPortfolioItemEditedObserverInterface
{
use RequestTrait;
public function hookItemEdited(HookPortfolioItemEditedEventInterface $hookEvent)
{
/** @var Portfolio $item */
$item = $hookEvent->getEventData()['item'];
$userId = api_get_user_id();
$courseCode = api_get_course_id();
$cidreq = api_get_cidreq();
$url = api_get_path(WEB_CODE_PATH).'portfolio/index.php?';
$url .= ($cidreq ? $cidreq.'&' : '');
$url .= http_build_query(['action' => 'view', 'id' => $item->getId()]);
try {
$json = $this->doEditRequest(
[
'user_id' => $userId,
'course_code' => $courseCode,
'content_id' => $item->getId(),
'content_type' => 'eportfolio',
'content_url' => $url,
'post_title' => $item->getTitle(),
]
);
} catch (Exception $e) {
Display::addFlash(
Display::return_message($e->getMessage(), 'error')
);
return;
}
if (empty($json)) {
return;
}
error_log('ExtNotifConn: Portfolio item edited. Status'.((int) $json['status']));
}
}

@ -0,0 +1,44 @@
<?php
/* For licensing terms, see /license.txt */
use Chamilo\CoreBundle\Entity\Portfolio;
use Chamilo\PluginBundle\ExternalNotificationConnect\Traits\RequestTrait\RequestTrait;
class ExternalNotificationConnectPortfolioItemVisibilityHookObserver extends ExternalNotificationConnectHookObserver implements HookPortfolioItemVisibilityObserverInterface
{
use RequestTrait;
/**
* {@inheritDoc}
*/
public function hookItemVisibility(HookPortfolioItemVisibilityEventInterface $event)
{
/** @var Portfolio $item */
$item = $event->getEventData()['item'];
$recipients = $event->getEventData()['recipients'];
try {
$json = $this->doVisibilityRequest(
[
'content_id' => $item->getId(),
'content_type' => 'eportfolio',
'visibility' => $item->getVisibility(),
'user_list' => $recipients,
]
);
} catch (Exception $e) {
Display::addFlash(
Display::return_message($e->getMessage(), 'error')
);
return;
}
if (empty($json)) {
return;
}
error_log('ExtNotifConn: Portfolio item visibility: ID '.$json['data']['notification_id']);
}
}

@ -0,0 +1,191 @@
<?php
/* For licensing terms, see /license.txt */
namespace Chamilo\PluginBundle\ExternalNotificationConnect\Traits\RequestTrait;
use Doctrine\ORM\OptimisticLockException;
use Doctrine\ORM\ORMException;
use Exception;
use ExternalNotificationConnectPlugin;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\ClientException;
use GuzzleHttp\Exception\ServerException;
trait RequestTrait
{
/**
* @throws Exception
*/
protected function doCreateRequest($json): ?array
{
try {
$token = $this->plugin->getAccessToken();
} catch (OptimisticLockException|ORMException|Exception $e) {
throw new Exception($e->getMessage());
}
$options = [
'headers' => [
'Authorization' => "Bearer $token",
],
'json' => $json,
];
$client = new Client();
try {
$response = $client->post(
$this->plugin->get(ExternalNotificationConnectPlugin::SETTING_NOTIFICATION_URL),
$options
);
} catch (ClientException|ServerException $e) {
if (!$e->hasResponse()) {
throw new Exception($e->getMessage());
}
$response = $e->getResponse();
}
$json = json_decode((string) $response->getBody(), true);
if (isset($json['status']) && 500 === $json['status']) {
throw new Exception($json['message']);
}
if (isset($json['validation_errors']) && $json['validation_errors']) {
$messageError = implode(
'<br>',
array_column($json['errors'], 'message')
);
throw new Exception($messageError);
}
return $json;
}
/**
* @throws Exception
*/
protected function doEditRequest(array $json): array
{
try {
$token = $this->plugin->getAccessToken();
} catch (OptimisticLockException|ORMException|Exception $e) {
throw new Exception($e->getMessage());
}
$url = $this->plugin->get(ExternalNotificationConnectPlugin::SETTING_NOTIFICATION_URL)
.'/'.$json['content_id'].'/'.$json['content_type'];
$options = [
'headers' => [
'Authorization' => "Bearer $token",
],
'json' => $json,
];
$client = new Client();
try {
$response = $client->post($url, $options);
} catch (ClientException|ServerException $e) {
if (!$e->hasResponse()) {
throw new Exception($e->getMessage());
}
$response = $e->getResponse();
}
$json = json_decode((string) $response->getBody(), true);
if (isset($json['status']) && 500 === $json['status']) {
throw new Exception($json['message']);
}
return $json;
}
/**
* @throws Exception
*/
protected function doVisibilityRequest(array $data)
{
try {
$token = $this->plugin->getAccessToken();
} catch (OptimisticLockException|ORMException|Exception $e) {
throw new Exception($e->getMessage());
}
$options = [
'headers' => [
'Authorization' => "Bearer $token",
],
'json' => $data,
];
$client = new Client();
try {
$response = $client->post(
$this->plugin->get(ExternalNotificationConnectPlugin::SETTING_NOTIFICATION_URL).'/visibility',
$options
);
} catch (ClientException|ServerException $e) {
if (!$e->hasResponse()) {
throw new Exception($e->getMessage());
}
$response = $e->getResponse();
}
$json = json_decode((string) $response->getBody(), true);
if (isset($json['status']) && 500 === $json['status']) {
throw new Exception($json['message']);
}
return $json;
}
/**
* @throws Exception
*/
protected function doDeleteRequest(int $contentId, string $contentType): array
{
try {
$token = $this->plugin->getAccessToken();
} catch (OptimisticLockException|ORMException|Exception $e) {
throw new Exception($e->getMessage());
}
$url = $this->plugin->get(ExternalNotificationConnectPlugin::SETTING_NOTIFICATION_URL)."/$contentId/$contentType";
$options = [
'headers' => [
'Authorization' => "Bearer $token",
],
];
$client = new Client();
try {
$response = $client->delete($url, $options);
} catch (ClientException|ServerException $e) {
if (!$e->hasResponse()) {
throw new Exception($e->getMessage());
}
$response = $e->getResponse();
}
$json = json_decode((string) $response->getBody(), true);
if (isset($json['status']) && 500 === $json['status']) {
throw new Exception($json['message']);
}
return $json;
}
}

@ -0,0 +1,5 @@
<?php
/* For licensing terms, see /license.txt */
ExternalNotificationConnectPlugin::create()->uninstall();

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

@ -0,0 +1,10 @@
Extra menu from webservice plugin
===============================
This plugin adds a little menu with data provided by external webservice.
# Installation
To install, enable the plugin, then go to "Regions" in the administration panel
and add the region "header left logo" to the plugin. Save.
The plugin should appear as a menu in the upper-left side of the Chamilo portal header.
This plugin requires the php-curl extension to be installed and enabled (a standard Chamilo requirement anyway).

@ -0,0 +1,4 @@
<?php
/* For licensing terms, see /license.txt */
require_once __DIR__.'/../../main/inc/global.inc.php';

@ -0,0 +1,114 @@
<?php
/* For license terms, see /license.txt */
use ChamiloSession as Session;
/**
* This is the main script of the extra menu from webservice plugin.
*
* @author Borja Sanchez
*
* @package chamilo.plugin.extramenufromwebservice
*/
// This plugin doesn't work for anonymous users
if (!api_is_anonymous()) {
$extraMenuFromWebservice = ExtraMenuFromWebservicePlugin::create();
$pluginEnabled = $extraMenuFromWebservice->get('tool_enable');
// If the configuration option 'tool_enable' is disabled, doesn't show the menu
if ($pluginEnabled === 'true') {
$menuContent = "";
$userId = api_get_user_id();
$userData = $originalUserInfo = api_get_user_info(
api_get_user_id(),
false,
false,
false,
false,
false,
true
);
$pluginPath = api_get_path(WEB_PLUGIN_PATH).'extramenufromwebservice/resources/';
//Check if the token is in session, if not get a new token and write in session
if (
Session::has('extramenufromwebservice_plugin_token') &&
Session::has('extramenufromwebservice_plugin_token_start')
) {
//if no session lifetime exists, set 1 day
$pluginSessionTimeout = !empty((int) $extraMenuFromWebservice->get('session_timeout')) ?
$extraMenuFromWebservice->get('session_timeout') :
86400;
$tokenStartTime = new DateTime(Session::read('extramenufromwebservice_plugin_token_start'));
// If token is expired, get other new token
if ($extraMenuFromWebservice::tokenIsExpired($tokenStartTime->getTimestamp(), $pluginSessionTimeout)) {
$loginToken = $extraMenuFromWebservice->getToken();
Session::write('extramenufromwebservice_plugin_token', $loginToken);
$now = api_get_utc_datetime();
Session::write('extramenufromwebservice_plugin_token_start', $now);
}
} else {
$loginToken = $extraMenuFromWebservice->getToken();
if (!empty($loginToken)) {
Session::write('extramenufromwebservice_plugin_token', $loginToken);
$now = api_get_utc_datetime();
Session::write('extramenufromwebservice_plugin_token_start', $now);
}
}
$isMobile = api_is_browser_mobile();
$menuResponse = $extraMenuFromWebservice->getMenu(
Session::read('extramenufromwebservice_plugin_token'),
$userData['email'],
$isMobile
);
if (!empty($menuResponse)) {
$menuContent = $menuResponse;
$fh = '<script type="text/javascript" src="'.$pluginPath.'js/extramenufromwebservice.js" ></script>';
$fh .= '<link href="'.$pluginPath.'css/extramenufromwebservice.css" rel="stylesheet" type="text/css">';
if (!empty($extraMenuFromWebservice->get('list_css_imports'))) {
$cssListToImport = $extraMenuFromWebservice->getImports(
$extraMenuFromWebservice->get('list_css_imports')
);
}
if (!empty($extraMenuFromWebservice->get('list_fonts_imports'))) {
$fontListToImport = $extraMenuFromWebservice->getImports(
$extraMenuFromWebservice->get('list_fonts_imports')
);
}
$fh .= '<div class="extra-menu-from-webservice">';
$fh .= '<input id="menu-toggle" type="checkbox" />';
$fh .= '<label class="menu-btn" for="menu-toggle">';
$fh .= '<span></span>';
$fh .= '</label>';
$fh .= '<div class="nav-from-webservice" id="nav-from-webservice">';
if (isset($cssListToImport)) {
foreach ($cssListToImport as $cssUrl) {
$fh .= '<link href="'.$cssUrl.'" rel="stylesheet" type="text/css">';
}
}
$fh .= '<style>';
if (isset($fontListToImport)) {
foreach ($fontListToImport as $fontUrl) {
$fh .= '@import url("'.$fontUrl.'");';
}
}
$fh .= $menuContent['css'];
$fh .= '</style>';
$fh .= $menuContent['html'];
$fh .= '<script>';
$fh .= $menuContent['js'];
$fh .= '</script>';
$fh .= '</div>';
$fh .= '</div>';
echo $fh;
}
}
}

@ -0,0 +1,7 @@
<?php
/* For license terms, see /license.txt */
if (!api_is_platform_admin()) {
exit('You must have admin permissions to install plugins');
}
ExtraMenuFromWebservicePlugin::create()->install();

@ -0,0 +1,15 @@
<?php
$strings['plugin_title'] = "Extra menu from webservice";
$strings['plugin_comment'] = "Add a menu obtained by webservice";
$strings['authentication_url'] = 'Authentication url';
$strings['authentication_email'] = 'Email for authentication.';
$strings['authentication_password'] = 'Password for authentication';
$strings['normal_menu_url'] = 'Url for normal menu webservice';
$strings['mobile_menu_url'] = 'Url for mobile menu webservice';
$strings['tool_enable'] = 'ExtraMenuFromWebservice plugin enabled';
$strings['tool_enable_help'] = "Choose whether you want to enable the ExtraMenuFromWebservice plugin.";
$strings['session_timeout'] = "Token in session timeout, in seconds";
$strings['session_timeout_help'] = "If time is not specified, it will be 86400 seconds.";
$strings['list_css_imports'] = "List of CSS urls to import, separated by ';'";
$strings['list_fonts_imports'] = "List of fonts urls to import, separated by ';'";

@ -0,0 +1,15 @@
<?php
$strings['plugin_title'] = "Menu extra depuis un service web";
$strings['plugin_comment'] = "Ajouter un menu flottant fourni par un service web sur base de l'e-mail utilisateur";
$strings['authentication_url'] = "URL d'authentication";
$strings['authentication_email'] = "Email pour l'authentification.";
$strings['authentication_password'] = "Mot de passe pour l'authentification";
$strings['normal_menu_url'] = "URL pour le web service du menu standard";
$strings['mobile_menu_url'] = "URL pour le web service du menu mobile";
$strings['tool_enable'] = "Plugin ExtraMenuFromWebservice activé";
$strings['tool_enable_help'] = "Activer ou désactiver ce plugin.";
$strings['session_timeout'] = "Durée de vie du token, en secondes";
$strings['session_timeout_help'] = "Évite de recharger le menu de manière répétée. Si aucun temps n'est défini, le plugin utilisera la valeur de 86400 secondes (24h).";
$strings['list_css_imports'] = "Liste des URLs CSS à importer, séparées par des points-virgule (';')";
$strings['list_fonts_imports'] = "Liste des fontes de caractères à importer, séparées par des points-virgule (';')";

@ -0,0 +1,15 @@
<?php
$strings['plugin_title'] = "Extra menu desde webservice";
$strings['plugin_comment'] = "Añade un menú obtenido mediante webservice";
$strings['authentication_url'] = 'Authentication url';
$strings['authentication_email'] = 'Email para autentificación.';
$strings['authentication_password'] = 'Contraseña para authentication';
$strings['normal_menu_url'] = 'Url para el webservice menú normal';
$strings['mobile_menu_url'] = 'Url para el webservice menu mobile';
$strings['tool_enable'] = 'ExtraMenuFromWebservice plugin activo';
$strings['tool_enable_help'] = "Elija si desea habilitar el plugin ExtraMenuFromWebservice";
$strings['session_timeout'] = "Tiempo de vida del token, en segundos";
$strings['session_timeout_help'] = "Si no se especifica tiempo, será de 86400 segundos.";
$strings['list_css_imports'] = "Lista de urls CSS a importar, separadas por ';'";
$strings['list_fonts_imports'] = "Lista de urls de fuentes a importar, separadas por ';'";

@ -0,0 +1,189 @@
<?php
/* For licensing terms, see /license.txt */
/**
* Define the ExtraMenuFromWebservice class as an extension of Plugin
* install/uninstall the plugin.
*/
class ExtraMenuFromWebservicePlugin extends Plugin
{
/**
* ExtraMenuFromWebservice constructor.
*/
protected function __construct()
{
$settings = [
'tool_enable' => 'boolean',
'authentication_url' => 'text',
'authentication_email' => 'text',
'authentication_password' => 'text',
'normal_menu_url' => 'text',
'mobile_menu_url' => 'text',
'session_timeout' => 'text',
'list_css_imports' => 'text',
'list_fonts_imports' => 'text',
];
parent::__construct(
'0.1',
'Borja Sanchez',
$settings
);
}
public static function create()
{
static $result = null;
return $result ? $result : $result = new self();
}
public function install()
{
return true;
}
public function uninstall()
{
$settings = [
'tool_enable',
'authentication_url',
'authentication_email',
'authentication_password',
'normal_menu_url',
'mobile_menu_url',
'username_parameter',
'session_timeout',
'list_css_imports' => 'text',
'list_fonts_imports' => 'text',
];
$tableSettings = Database::get_main_table(TABLE_MAIN_SETTINGS_CURRENT);
$urlId = api_get_current_access_url_id();
foreach ($settings as $variable) {
$sql = "DELETE FROM $tableSettings WHERE variable = '$variable' AND access_url = $urlId";
Database::query($sql);
}
}
/**
* Get a token through the WS indicated in plugin configuration.
*/
public function getToken()
{
$response = [];
$authenticationUrl = (string) $this->get('authentication_url');
$authenticationEmail = (string) $this->get('authentication_email');
$authenticationPassword = (string) $this->get('authentication_password');
if (!empty($authenticationUrl) && !empty($authenticationEmail) && !empty($authenticationPassword)) {
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => $authenticationUrl,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 5,
CURLOPT_NOSIGNAL => 1,
CURLOPT_SSL_VERIFYHOST => 0,
CURLOPT_SSL_VERIFYPEER => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => '{
"email": "'.$authenticationEmail.'",
"password": "'.$authenticationPassword.'"
}',
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
],
]);
$curlResponse = curl_exec($curl);
curl_close($curl);
if (false !== $curlResponse) {
$curlResponse = json_decode($curlResponse, true);
if (isset($curlResponse['data']['data']['token'])) {
$response = $curlResponse['data']['data']['token'];
}
}
}
return $response;
}
/**
* Get the menu from the WS indicated in plugin configuration.
* */
public function getMenu(
string $token,
string $userEmail,
bool $isMobile = false
): array {
$response = [];
$menuUrl = $isMobile ? (string) $this->get('mobile_menu_url') : (string) $this->get('normal_menu_url');
if (!empty($menuUrl) && !empty($token) && !empty($userEmail)) {
$menuUrl = substr($menuUrl, -1) === '/' ? $menuUrl : $menuUrl.'/';
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => $menuUrl.$userEmail,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 5,
CURLOPT_NOSIGNAL => 1,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
"Authorization: Bearer $token",
],
]);
$curlResponse = curl_exec($curl);
if (false !== $curlResponse) {
$curlResponse = json_decode($curlResponse, true);
if (isset($curlResponse['data']['data']['html']['data'])) {
$response['html'] = $curlResponse['data']['data']['html']['data'];
}
if (isset($curlResponse['data']['data']['css']['data'])) {
$response['css'] = $curlResponse['data']['data']['css']['data'];
}
if (isset($curlResponse['data']['data']['js']['data'])) {
$response['js'] = $curlResponse['data']['data']['js']['data'];
}
}
curl_close($curl);
}
return $response;
}
/**
* Checks if the login token is expired.
*/
public static function tokenIsExpired(int $tokenStartTime, int $pluginSessionTimeout): bool
{
$now = api_get_utc_datetime(null, false, true)->getTimestamp();
return ($now - $tokenStartTime) > $pluginSessionTimeout;
}
/**
* Get the list of CSS or fonts indicated in plugin configuration.
*/
public static function getImports(string $list = '')
{
$importsArray = [];
if (!empty($list)) {
$importsArray = explode(";", $list);
}
return $importsArray;
}
}

@ -0,0 +1,5 @@
<?php
/* For license terms, see /license.txt */
require_once __DIR__.'/config.php';
$plugin_info = ExtraMenuFromWebservicePlugin::create()->get_info();

@ -0,0 +1,108 @@
.extra-menu-from-webservice {
position: relative;
}
.nav-from-webservice {
display: none;
position: absolute;
width: 250px;
top: 90px;
z-index: 10;
}
@media (min-width: 176px) {
.nav-from-webservice {
top: 110px;
}
}
@media (min-width: 490px) {
.nav-from-webservice {
top: 131px;
}
}
@media (min-width: 576px) {
.nav-from-webservice {
top: 131px;
}
}
@media (min-width: 768px) {
.nav-from-webservice {
top: 129px;
}
}
@media (min-width: 992px) {
.nav-from-webservice {
top: 82px;
}
}
@media (min-width: 1200px) {
.nav-from-webservice {
top: 89px;
}
}
.menu-btn {
position: sticky;
width: 30px;
height: 26px;
cursor: pointer;
z-index: 12;
margin-top: 45px;
margin-left: 30px;
}
.menu-btn > span,
.menu-btn > span::before,
.menu-btn > span::after {
display: block;
position: absolute;
width: 100%;
height: 3px;
background-color: #252323;
transition-duration: 0.25s;
}
.menu-btn > span::before {
content: "";
top: -8px;
}
.menu-btn > span::after {
content: "";
top: 8px;
}
#menu-toggle {
opacity: 0;
position: fixed;
top: 20px;
left: 345px;
}
#menu-toggle:checked + .menu-btn > span {
transform: rotate(45deg);
}
#menu-toggle:checked + .menu-btn > span::before {
top: 0;
transform: rotate(0deg);
}
#menu-toggle:checked + .menu-btn > span::after {
top: 0;
transform: rotate(90deg);
}
#date_alt_text {
z-index: 0; !important;
}
#frm_tag_list_text {
z-index: 0; !important;
}
.input-group-btn:last-child > .btn, .input-group-btn:last-child > .btn-group {
z-index: 0; !important;
}

@ -0,0 +1,8 @@
$(document).ready(function () {
$('#menu-toggle').click(function() {
$("#nav-from-webservice").toggle("slow");
$("#nav-from-webservice").css("z-index", 15);
});
// Uncomment following line to set the menu open by default
// $('#menu-toggle').click();
});

@ -0,0 +1,5 @@
<?php
/* For license terms, see /license.txt */
require_once __DIR__.'/config.php';
ExtraMenuFromWebservicePlugin::create()->uninstall();

@ -0,0 +1,255 @@
<?php
// For licensing terms, see /license.txt
namespace Chamilo\PluginBundle\Entity\H5pImport;
use Chamilo\CoreBundle\Entity\Course;
use Chamilo\CoreBundle\Entity\Session;
use DateTime;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Gedmo\Mapping\Annotation as Gedmo;
/**
* Class H5pImport.
*
* @ORM\Entity()
*
* @ORM\Table(name="plugin_h5p_import")
*/
class H5pImport
{
/**
* @var string
*
* @ORM\Column(name="path", type="text", nullable=false)
*/
protected $path;
/**
* @var string
*
* @ORM\Column(name="relative_path", type="text", nullable=false)
*/
protected $relativePath;
/**
* @var DateTime
*
* @Gedmo\Timestampable(on="create")
*
* @ORM\Column(name="created_at", type="datetime", nullable=false)
*/
protected $createdAt;
/**
* @var DateTime
*
* @Gedmo\Timestampable(on="update")
*
* @ORM\Column(name="modified_at", type="datetime", nullable=false)
*/
protected $modifiedAt;
/**
* @var int
*
* @ORM\Column(name="iid", type="integer")
*
* @ORM\Id
*
* @ORM\GeneratedValue
*/
private $iid;
/**
* @var Course
*
* @ORM\ManyToOne(targetEntity="Chamilo\CoreBundle\Entity\Course")
*
* @ORM\JoinColumn(name="c_id", referencedColumnName="id", nullable=false)
*/
private $course;
/**
* @var null|Session
*
* @ORM\ManyToOne(targetEntity="Chamilo\CoreBundle\Entity\Session")
*
* @ORM\JoinColumn(name="session_id", referencedColumnName="id")
*/
private $session;
/**
* @var null|string
*
* @ORM\Column(name="name", type="text", nullable=true)
*/
private $name;
/**
* @var null|string
*
* @ORM\Column(name="description", type="text", nullable=true)
*/
private $description;
/**
* @var Collection<int, H5pImportLibrary>
*
* @ORM\ManyToMany(targetEntity="H5pImportLibrary", mappedBy="h5pImports", cascade={"persist"})
*/
private $libraries;
/**
* @var H5pImportLibrary
*
* @ORM\ManyToOne(targetEntity="H5pImportLibrary")
*
* @ORM\JoinColumn(name="main_library_id", referencedColumnName="iid", onDelete="SET NULL")
*/
private $mainLibrary;
public function __construct()
{
$this->libraries = new ArrayCollection();
}
public function getIid(): int
{
return $this->iid;
}
public function setIid(int $iid): void
{
$this->iid = $iid;
}
public function getCourse(): Course
{
return $this->course;
}
public function setCourse(Course $course): H5pImport
{
$this->course = $course;
return $this;
}
public function getSession(): ?Session
{
return $this->session;
}
public function setSession(?Session $session): H5pImport
{
$this->session = $session;
return $this;
}
public function getName(): string
{
return $this->name;
}
public function setName(string $name): H5pImport
{
$this->name = $name;
return $this;
}
public function getPath(): string
{
return $this->path;
}
public function setPath(string $path): H5pImport
{
$this->path = $path;
return $this;
}
public function getDescription(): ?string
{
return $this->description;
}
public function setDescription(?string $description): H5pImport
{
$this->description = $description;
return $this;
}
public function getRelativePath(): string
{
return $this->relativePath;
}
public function setRelativePath(string $relativePath): H5pImport
{
$this->relativePath = $relativePath;
return $this;
}
public function getCreatedAt(): DateTime
{
return $this->createdAt;
}
public function setCreatedAt(DateTime $createdAt): H5pImport
{
$this->createdAt = $createdAt;
return $this;
}
public function getModifiedAt(): DateTime
{
return $this->modifiedAt;
}
public function setModifiedAt(DateTime $modifiedAt): void
{
$this->modifiedAt = $modifiedAt;
}
public function addLibraries(H5pImportLibrary $library): self
{
$library->addH5pImport($this);
$this->libraries[] = $library;
return $this;
}
public function removeLibraries(H5pImportLibrary $library): self
{
$this->libraries->removeElement($library);
return $this;
}
public function getLibraries(): Collection
{
return $this->libraries;
}
public function setMainLibrary(H5pImportLibrary $library): self
{
$this->mainLibrary = $library;
return $this;
}
public function getMainLibrary(): ?H5pImportLibrary
{
return $this->mainLibrary;
}
}

@ -0,0 +1,383 @@
<?php
// For licensing terms, see /license.txt
namespace Chamilo\PluginBundle\Entity\H5pImport;
use Chamilo\CoreBundle\Entity\Course;
use DateTime;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\EntityRepository;
use Doctrine\ORM\Mapping as ORM;
use Gedmo\Mapping\Annotation as Gedmo;
/**
* Class H5pImportLibrary.
*
* @ORM\Entity()
*
* @ORM\Table(name="plugin_h5p_import_library")
*/
class H5pImportLibrary extends EntityRepository
{
/**
* @var \DateTime
*
* @Gedmo\Timestampable(on="create")
*
* @ORM\Column(name="created_at", type="datetime", nullable=false)
*/
protected $createdAt;
/**
* @var \DateTime
*
* @Gedmo\Timestampable(on="update")
*
* @ORM\Column(name="modified_at", type="datetime", nullable=false)
*/
protected $modifiedAt;
/**
* @var int
*
* @ORM\Column(name="iid", type="integer")
*
* @ORM\Id
*
* @ORM\GeneratedValue
*/
private $iid;
/**
* @ORM\Column(name="title", type="string", nullable=true)
*/
private $title;
/**
* @ORM\Column(name="machine_name", type="string")
*/
private $machineName;
/**
* @ORM\Column(name="major_version", type="integer")
*/
private $majorVersion;
/**
* @ORM\Column(name="minor_version", type="integer")
*/
private $minorVersion;
/**
* @ORM\Column(name="patch_version", type="integer")
*/
private $patchVersion;
/**
* @ORM\Column(name="runnable", type="integer", nullable=true)
*/
private $runnable;
/**
* @ORM\Column(name="embed_types", type="array", nullable=true)
*/
private $embedTypes;
/**
* @ORM\Column(name="preloaded_js" , type="array", nullable=true)
*/
private $preloadedJs;
/**
* @ORM\Column(name="preloaded_css", type="array", nullable=true)
*/
private $preloadedCss;
/**
* @ORM\Column(name="library_path", type="string", length=255)
*/
private $libraryPath;
/**
* @var Collection<int, H5pImport>
*
* @ORM\ManyToMany(targetEntity="H5pImport", inversedBy="libraries")
*
* @ORM\JoinTable(
* name="plugin_h5p_import_rel_libraries",
* joinColumns={@ORM\JoinColumn(name="h5p_import_library_id", referencedColumnName="iid", onDelete="CASCADE")},
* inverseJoinColumns={@ORM\JoinColumn(name="h5p_import_id", referencedColumnName="iid", onDelete="CASCADE")}
* )
*/
private $h5pImports;
/**
* @var Course
*
* @ORM\ManyToOne(targetEntity="Chamilo\CoreBundle\Entity\Course")
*
* @ORM\JoinColumn(name="c_id", referencedColumnName="id", nullable=false)
*/
private $course;
public function __construct()
{
$this->h5pImports = new ArrayCollection();
}
public function getIid(): int
{
return $this->iid;
}
public function setIid(int $iid): H5pImportLibrary
{
$this->iid = $iid;
return $this;
}
public function getMachineName(): string
{
return $this->machineName;
}
public function setMachineName(string $machineName): H5pImportLibrary
{
$this->machineName = $machineName;
return $this;
}
public function getTitle(): string
{
return $this->title;
}
public function setTitle(string $title): H5pImportLibrary
{
$this->title = $title;
return $this;
}
public function getMajorVersion(): int
{
return $this->majorVersion;
}
public function setMajorVersion(int $majorVersion): H5pImportLibrary
{
$this->majorVersion = $majorVersion;
return $this;
}
public function getMinorVersion(): int
{
return $this->minorVersion;
}
public function setMinorVersion(int $minorVersion): H5pImportLibrary
{
$this->minorVersion = $minorVersion;
return $this;
}
public function getPatchVersion(): int
{
return $this->patchVersion;
}
public function setPatchVersion(int $patchVersion): H5pImportLibrary
{
$this->patchVersion = $patchVersion;
return $this;
}
public function getRunnable(): int
{
return $this->runnable;
}
public function setRunnable(?int $runnable): H5pImportLibrary
{
$this->runnable = $runnable;
return $this;
}
/**
* @return array
*/
public function getPreloadedJs(): ?array
{
return $this->preloadedJs;
}
public function setPreloadedJs(?array $preloadedJs): H5pImportLibrary
{
$this->preloadedJs = $preloadedJs;
return $this;
}
/**
* @return array
*/
public function getPreloadedCss(): ?array
{
return $this->preloadedCss;
}
public function setPreloadedCss(?array $preloadedCss): H5pImportLibrary
{
$this->preloadedCss = $preloadedCss;
return $this;
}
public function getEmbedTypes(): ?array
{
return $this->embedTypes;
}
public function setEmbedTypes(?array $embedTypes): H5pImportLibrary
{
$this->embedTypes = $embedTypes;
return $this;
}
public function getLibraryPath(): string
{
return $this->libraryPath;
}
public function setLibraryPath(string $libraryPath): H5pImportLibrary
{
$this->libraryPath = $libraryPath;
return $this;
}
public function addH5pImport(H5pImport $h5pImport): self
{
if (!$this->h5pImports->contains($h5pImport)) {
$this->h5pImports[] = $h5pImport;
}
return $this;
}
public function removeH5pImport(H5pImport $h5pImport): self
{
$this->h5pImports->removeElement($h5pImport);
return $this;
}
public function getH5pImports(): Collection
{
return $this->h5pImports;
}
public function getCourse(): Course
{
return $this->course;
}
public function setCourse(Course $course): self
{
$this->course = $course;
return $this;
}
public function getCreatedAt(): \DateTime
{
return $this->createdAt;
}
public function setCreatedAt(\DateTime $createdAt): H5pImportLibrary
{
$this->createdAt = $createdAt;
return $this;
}
public function getModifiedAt(): \DateTime
{
return $this->modifiedAt;
}
public function setModifiedAt(\DateTime $modifiedAt): H5pImportLibrary
{
$this->modifiedAt = $modifiedAt;
return $this;
}
public function getLibraryByMachineNameAndVersions(string $machineName, int $majorVersion, int $minorVersion)
{
if (
$this->machineName === $machineName
&& $this->majorVersion === $majorVersion
&& $this->minorVersion === $minorVersion
) {
return $this;
}
return false;
}
/**
* Get the preloaded JS array of the imported library formatted as a comma-separated string.
*
* @return string the preloaded JS array of the imported library formatted as a comma-separated string
*/
public function getPreloadedJsFormatted(): string
{
$formattedJs = [];
foreach ($this->preloadedJs as $value) {
if (is_string($value->path)) {
$formattedJs[] = $value->path;
}
}
return implode(',', $formattedJs);
}
/**
* Get the preloaded CSS array of the imported library formatted as a comma-separated string.
*
* @return string the preloaded CSS array of the imported library formatted as a comma-separated string
*/
public function getPreloadedCssFormatted(): string
{
$formattedJCss = [];
foreach ($this->preloadedCss as $value) {
if (is_string($value->path)) {
$formattedJCss[] = $value->path;
}
}
return implode(',', $formattedJCss);
}
/**
* Get the embed types array formatted as a comma-separated string.
*
* @return string the embed types array formatted as a comma-separated string
*/
public function getEmbedTypesFormatted(): string
{
return implode(',', $this->getEmbedTypes());
}
}

@ -0,0 +1,267 @@
<?php
namespace Chamilo\PluginBundle\Entity\H5pImport;
use Chamilo\CoreBundle\Entity\Course;
use Chamilo\CoreBundle\Entity\Session;
use Chamilo\CourseBundle\Entity\CLpItemView;
use Chamilo\UserBundle\Entity\User;
use DateTime;
use Doctrine\ORM\Mapping as ORM;
use Gedmo\Mapping\Annotation as Gedmo;
/**
* Class H5pImportResults.
*
* @ORM\Entity()
*
* @ORM\Table(name="plugin_h5p_import_results")
*/
class H5pImportResults
{
/**
* @var int
*
* @ORM\Column(name="start_time", type="integer", nullable=false)
*/
protected $startTime;
/**
* @var int
*
* @ORM\Column(name="total_time", type="integer", nullable=false)
*/
protected $totalTime;
/**
* @var int
*
* @ORM\Column(name="iid", type="integer")
*
* @ORM\Id
*
* @ORM\GeneratedValue
*/
private $iid;
/**
* @var int
*
* @ORM\Column(name="score", type="integer")
*/
private $score;
/**
* @var int
*
* @ORM\Column(name="max_score", type="integer")
*/
private $maxScore;
/**
* @var Course
*
* @ORM\ManyToOne(targetEntity="Chamilo\CoreBundle\Entity\Course")
*
* @ORM\JoinColumn(name="c_id", referencedColumnName="id", nullable=false, onDelete="CASCADE")
*/
private $course;
/**
* @var null|Session
*
* @ORM\ManyToOne(targetEntity="Chamilo\CoreBundle\Entity\Session")
*
* @ORM\JoinColumn(name="session_id", referencedColumnName="id")
*/
private $session;
/**
* @var H5pImport
*
* @ORM\ManyToOne(targetEntity="Chamilo\PluginBundle\Entity\H5pImport\H5pImport")
*
* @ORM\JoinColumn(name="plugin_h5p_import_id", referencedColumnName="iid", nullable=false, onDelete="CASCADE")
*/
private $h5pImport;
/**
* @var User
*
* @ORM\ManyToOne(targetEntity="Chamilo\UserBundle\Entity\User")
*
* @ORM\JoinColumn(name="user_id", referencedColumnName="id", nullable=false, onDelete="CASCADE")
*/
private $user;
/**
* @var CLpItemView
*
* @ORM\ManyToOne(targetEntity="Chamilo\CourseBundle\Entity\CLpItemView")
*
* @ORM\JoinColumn(name="c_lp_item_view_id", referencedColumnName="iid", nullable=true, onDelete="CASCADE")
*/
private $cLpItemView;
/**
* @var \DateTime
*
* @Gedmo\Timestampable(on="create")
*
* @ORM\Column(name="created_at", type="datetime", nullable=false)
*/
private $createdAt;
/**
* @var \DateTime
*
* @Gedmo\Timestampable(on="update")
*
* @ORM\Column(name="modified_at", type="datetime", nullable=false)
*/
private $modifiedAt;
public function getIid(): int
{
return $this->iid;
}
public function setIid(int $iid): H5pImportResults
{
$this->iid = $iid;
return $this;
}
public function getScore(): int
{
return $this->score;
}
public function setScore(int $score): H5pImportResults
{
$this->score = $score;
return $this;
}
public function getMaxScore(): int
{
return $this->maxScore;
}
public function setMaxScore(int $maxScore): H5pImportResults
{
$this->maxScore = $maxScore;
return $this;
}
public function getCourse(): Course
{
return $this->course;
}
public function setCourse(Course $course): H5pImportResults
{
$this->course = $course;
return $this;
}
public function getSession(): ?Session
{
return $this->session;
}
public function setSession(?Session $session): H5pImportResults
{
$this->session = $session;
return $this;
}
public function getH5pImport(): H5pImport
{
return $this->h5pImport;
}
public function setH5pImport(H5pImport $h5pImport): H5pImportResults
{
$this->h5pImport = $h5pImport;
return $this;
}
public function getUser(): User
{
return $this->user;
}
public function setUser(User $user): H5pImportResults
{
$this->user = $user;
return $this;
}
public function getCreatedAt(): \DateTime
{
return $this->createdAt;
}
public function getCLpItemView(): CLpItemView
{
return $this->cLpItemView;
}
public function setCLpItemView(CLpItemView $cLpItemView): H5pImportResults
{
$this->cLpItemView = $cLpItemView;
return $this;
}
public function getStartTime(): int
{
return $this->startTime;
}
public function setStartTime(int $startTime): H5pImportResults
{
$this->startTime = $startTime;
return $this;
}
public function getTotalTime(): int
{
return $this->totalTime;
}
public function setTotalTime(int $totalTime): H5pImportResults
{
$this->totalTime = $totalTime;
return $this;
}
public function setCreatedAt(\DateTime $createdAt): H5pImportResults
{
$this->createdAt = $createdAt;
return $this;
}
public function getModifiedAt(): \DateTime
{
return $this->modifiedAt;
}
public function setModifiedAt(\DateTime $modifiedAt): H5pImportResults
{
$this->modifiedAt = $modifiedAt;
return $this;
}
}

@ -0,0 +1,307 @@
<?php
/* For licensing terms, see /license.txt */
use Chamilo\PluginBundle\Entity\H5pImport\H5pImport;
use Chamilo\PluginBundle\Entity\H5pImport\H5pImportLibrary;
use Chamilo\PluginBundle\Entity\H5pImport\H5pImportResults;
use Doctrine\ORM\Tools\SchemaTool;
use Doctrine\ORM\Tools\ToolsException;
use Symfony\Component\Filesystem\Filesystem;
/**
* Define the H5pImportPlugin class as an extension of Plugin
* install/uninstall the plugin.
*/
class H5pImportPlugin extends Plugin
{
public const TBL_H5P_IMPORT = 'plugin_h5p_import';
public const TBL_H5P_IMPORT_LIBRARY = 'plugin_h5p_import_library';
public const TBL_H5P_IMPORT_RESULTS = 'plugin_h5p_import_results';
protected function __construct()
{
$settings = [
'tool_enable' => 'boolean',
'frame' => 'boolean',
'embed' => 'boolean',
'copyright' => 'boolean',
'icon' => 'boolean',
];
parent::__construct(
'0.1',
'Borja Sanchez',
$settings
);
}
public static function create(): ?H5pImportPlugin
{
static $result = null;
return $result ? $result : $result = new self();
}
/**
* Updates and returns the total duration in the view of an H5P learning path item in a course.
*
* @param int $lpItemId The ID of the learning path item
* @param int $userId The user ID
*
* @return int The updated total duration in the learning path item view
*/
public static function fixTotalTimeInLpItemView(
int $lpItemId,
int $userId
): int {
$lpItemViewTable = Database::get_course_table(TABLE_LP_ITEM_VIEW);
$sql = "SELECT iid, score
FROM $lpItemViewTable
WHERE
iid = $lpItemId
ORDER BY view_count DESC
LIMIT 1";
$responseItemView = Database::query($sql);
$lpItemView = Database::fetch_array($responseItemView);
// Get the total execution duration of the user in the learning path item view
$sql = 'SELECT SUM(total_time) AS exe_duration
FROM plugin_h5p_import_results
WHERE
user_id = '.$userId.' AND
c_lp_item_view_id = '.$lpItemView['iid'].
' ORDER BY total_time DESC';
$sumScoreResult = Database::query($sql);
$durationRow = Database::fetch_array($sumScoreResult, 'ASSOC');
if (!empty($durationRow['exe_duration'])) {
// Update the total duration in the learning path item view
$sqlUpdate = 'UPDATE '.$lpItemViewTable.'
SET total_time = '.$durationRow['exe_duration'].'
WHERE iid = '.$lpItemView['iid'];
Database::query($sqlUpdate);
return (int) $durationRow['exe_duration'];
} else {
// Update c_lp_item_view status
$sqlUpdate = 'UPDATE '.$lpItemViewTable.'
SET status = "not attempted",
total_time = 0
WHERE iid = '.$lpItemView['iid'];
Database::query($sqlUpdate);
return 0;
}
}
public function getToolTitle(): string
{
$title = $this->get_lang('plugin_title');
if (!empty($title)) {
return $title;
}
return $this->get_title();
}
/**
* @throws ToolsException
*/
public function install()
{
$em = Database::getManager();
if ($em->getConnection()
->getSchemaManager()
->tablesExist(
[
self::TBL_H5P_IMPORT,
self::TBL_H5P_IMPORT_LIBRARY,
self::TBL_H5P_IMPORT_RESULTS,
]
)
) {
return;
}
$schemaTool = new SchemaTool($em);
$schemaTool->createSchema(
[
$em->getClassMetadata(H5pImport::class),
$em->getClassMetadata(H5pImportLibrary::class),
$em->getClassMetadata(H5pImportResults::class),
]
);
$this->addCourseTools();
}
public function addCourseTool(int $courseId)
{
// The $link param is set to "../plugin" as a hack to link correctly to the plugin URL in course tool.
// Otherwise, the link en the course tool will link to "/main/" URL.
$this->createLinkToCourseTool(
$this->get_lang('plugin_title'),
$courseId,
'plugin_h5p_import.png',
'../plugin/h5pimport/start.php',
0,
'authoring'
);
}
public function uninstall()
{
$em = Database::getManager();
if (!$em->getConnection()
->getSchemaManager()
->tablesExist(
[
self::TBL_H5P_IMPORT,
self::TBL_H5P_IMPORT_LIBRARY,
self::TBL_H5P_IMPORT_RESULTS,
]
)
) {
return;
}
$schemaTool = new SchemaTool($em);
$schemaTool->dropSchema(
[
$em->getClassMetadata(H5pImport::class),
$em->getClassMetadata(H5pImportLibrary::class),
$em->getClassMetadata(H5pImportResults::class),
]
);
$this->deleteCourseToolLinks();
$this->removeH5pDirectories();
}
/**
* Perform actions after configuring the H5P import plugin.
*
* @return H5pImportPlugin The H5P import plugin instance.
*/
public function performActionsAfterConfigure(): H5pImportPlugin
{
$this->deleteCourseToolLinks();
if ('true' === $this->get('tool_enable')) {
$this->addCourseTools();
}
return $this;
}
/**
* Get the view URL for an H5P import.
*
* @param H5pImport $h5pImport The H5P import object.
*
* @return string The view URL for the H5P import.
*/
public function getViewUrl(H5pImport $h5pImport): string
{
return api_get_path(WEB_PLUGIN_PATH).'h5pimport/view.php?id='.$h5pImport->getIid().'&'.api_get_cidreq();
}
/**
* Generates the LP resource block for H5P imports.
*
* @param int $lpId The LP ID.
*
* @return string The HTML for the LP resource block.
*/
public function getLpResourceBlock(int $lpId): string
{
$cidReq = api_get_cidreq(true, true, 'lp');
$webPath = api_get_path(WEB_PLUGIN_PATH).'h5pimport/';
$course = api_get_course_entity();
$session = api_get_session_entity();
$tools = Database::getManager()
->getRepository(H5pImport::class)
->findBy(['course' => $course, 'session' => $session]);
$importIcon = Display::return_icon('plugin_h5p_import_upload.png');
$moveIcon = Display::url(
Display::return_icon('move_everywhere.png', get_lang('Move'), [], ICON_SIZE_TINY),
'#',
['class' => 'moved']
);
$return = '<ul class="lp_resource">';
$return .= '<li class="lp_resource_element">';
$return .= $importIcon;
$return .= Display::url(
get_lang('Import'),
$webPath."start.php?action=add&$cidReq&".http_build_query(['lp_id' => $lpId])
);
$return .= '</li>';
/** @var H5pImport $tool */
foreach ($tools as $tool) {
$toolAnchor = Display::url(
Security::remove_XSS($tool->getName()),
api_get_self()."?$cidReq&"
.http_build_query(
['action' => 'add_item', 'type' => TOOL_H5P, 'file' => $tool->getIid(), 'lp_id' => $lpId]
),
['class' => 'moved']
);
$return .= Display::tag(
'li',
$moveIcon.$importIcon.$toolAnchor,
[
'class' => 'lp_resource_element',
'data_id' => $tool->getIid(),
'data_type' => TOOL_H5P,
'title' => $tool->getName(),
]
);
}
$return .= '</ul>';
return $return;
}
/**
* Add course tools for all courses.
*/
private function addCourseTools(): void
{
$courses = Database::getManager()
->createQuery('SELECT c.id FROM ChamiloCoreBundle:Course c')
->getResult();
foreach ($courses as $course) {
$this->addCourseTool($course['id']);
}
}
private function deleteCourseToolLinks()
{
Database::getManager()
->createQuery('DELETE FROM ChamiloCourseBundle:CTool t WHERE t.category = :category AND t.link LIKE :link')
->execute(['category' => 'authoring', 'link' => '../plugin/h5pimport/start.php%']);
}
/**
* Removes H5P directories for all courses.
*/
private function removeH5pDirectories(): void
{
$fs = new Filesystem();
$table = Database::get_main_table(TABLE_MAIN_COURSE);
$sql = "SELECT id FROM $table ORDER BY id";
$res = Database::query($sql);
while ($row = Database::fetch_assoc($res)) {
$courseInfo = api_get_course_info_by_id($row['id']);
$fs->remove($courseInfo['course_sys_path'].'/h5p');
}
}
}

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

@ -0,0 +1,40 @@
# H5P Import Plugin for Chamilo
## Overview
This plugin enables the loading and display of H5P packages within the Chamilo Learning Management System (LMS).
With this plugin, users can import and view interactive H5P content seamlessly within Chamilo courses (tool shown as an
H5P icon on the course homepage).
This plugin is currently in beta phase and may have some limitations or bugs. Feedback and bug reports are welcome to help improve the plugin.
Differences with the previous H5P plugin: this plugin allows for the upload of H5P packages in course-specific
environments, avoiding a long list of H5P activities shared between all teachers. It allows for the management of H5P
activities outside and inside of learning paths and tracks progress inside learning paths as if it was a Chamilo test.
H5P activities cannot be edited at this time, they are all visible by the students (cannot be hidden individually
inside the tool, but the tool can be hidden and the H5P activities made visible one by one in a learning path).
Activities do not show in the list of new elements "since your last visit".
## Requirements
- The 'h5p/h5p-php-library' library requirement has been added to Chamilo's composer.json, so no additional steps are needed to install it.
## Installation
If you have updated your Chamilo software from an official package, you don't need to do anything except enabling the plugin from the plugins page.
Otherwise (Git update), you will need to:
1. Update the Chamilo library and namespace by running `composer update` within the Chamilo root directory.
2. Add the plugin to your Chamilo installation's `main/admin/settings.php?category=Plugins` url.
3. If the namespace has not been updated, run`composer dump-autoload`.
## Configuration
1. Activate the plugin in the Chamilo administration panel.
2. Configure the plugin options. The only required setting is to enable the plugin. The remaining settings are optional and can be customized based on your needs.
## Usage
Once the plugin is activated and configured, users will see an H5P tool icon in the course and be able to import and display H5P packages within Chamilo courses.
Inside a course, select the H5P Import tool to upload H5P content to the course.
Users can interact with the H5P content directly within the tool or through a learning path.
## Support and Feedback
For any issues, questions, or feedback, please create an issue on the Chamilo-lms's GitHub repository at https://github.com/chamilo/chamilo-lms/.

@ -0,0 +1,5 @@
<?php
// For licensing terms, see /license.txt
require_once __DIR__.'/../../main/inc/global.inc.php';

@ -0,0 +1,8 @@
<?php
// For license terms, see /license.txt
if (!api_is_platform_admin()) {
exit('You must have admin permissions to install plugins');
}
H5pImportPlugin::create()->install();

@ -0,0 +1,23 @@
<?php
$strings['plugin_title'] = "H5P import";
$strings['plugin_comment'] = "Import H5P contents and use it in learnpaths. Open README.md for installation instructions.";
$strings['tool_enable'] = "Enable plugin";
$strings['frame'] = "Frame";
$strings['frame_help'] = "Show frame and buttons below H5P";
$strings['embed'] = "Embed";
$strings['embed_help'] = "Display embed button";
$strings['copyright'] = "Copyright";
$strings['copyright_help'] = "Display copyright button";
$strings['icon'] = "Icon";
$strings['icon_help'] = "Display H5P icon";
$strings['attempts'] = "Number of attempts";
$strings['upload_h5p'] = "Upload";
$strings['import_h5p_package'] = "Upload H5P package";
$strings['h5p_package'] = "H5P package";
$strings['h5p_error_loading'] = "Error loading the H5P package";
$strings['h5p_error_invalid_token'] = "Invalid security token";
$strings['h5p_error_missing_core_asset'] = "Error loading H5P core assets";
$strings['h5p_save_content_state'] = "Save user results";
$strings['h5p_save_content_freq'] = "Save frequency";
$strings['h5p_save_freq_help'] = "How often current content state should be saved, in seconds";
$strings['start_attempt'] = "Start attempt";

@ -0,0 +1,23 @@
<?php
$strings['plugin_title'] = "H5P import";
$strings['plugin_comment'] = "Ce plugin permet d'importer des contenus H5P. Ouvrez le fichier README.md pour des instructions d'installation.";
$strings['tool_enable'] = "Activer le plugin";
$strings['frame'] = "Frame";
$strings['frame_help'] = "Afficher le cadre et les boutons en dessous de H5P";
$strings['embed'] = "Intégrer";
$strings['embed_help'] = "Afficher le bouton d'intégration (embed)";
$strings['copyright'] = "Droits d'auteur";
$strings['copyright_help'] = "Afficher le bouton de droits d'auteur";
$strings['icon'] = "Icône";
$strings['icon_help'] = "Afficher l'icône H5P";
$strings['attempts'] = "Nombre de tentatives";
$strings['import_h5p_package'] = "Importer un paquet H5P";
$strings['upload_h5p'] = "Importer";
$strings['h5p_package'] = "Paquet H5P";
$strings['h5p_error_loading'] = "Erreur de chargement du paquet H5P";
$strings['h5p_error_missing_core_asset'] = "Erreur de chargement des assets H5P core";
$strings['h5p_error_invalid_token'] = "Token de sécurité invalide";
$strings['h5p_save_content_state'] = "Enregistrer les résultats de l'utilisateur";
$strings['h5p_save_content_freq'] = "Fréquence d'enregistrement";
$strings['h5p_save_freq_help'] = "Fréquence à laquelle l'état actuel du contenu doit être enregistré, en secondes";
$strings['start_attempt'] = "Démarrer la tentative";

@ -0,0 +1,23 @@
<?php
$strings['plugin_title'] = "H5P import";
$strings['plugin_comment'] = "Este plugin permite importar paquetes en formato H5P e insertarlos como elementos en una lección. Abra el README.md para instrucciones de instalación.";
$strings['tool_enable'] = "Activar plugin";
$strings['frame'] = "Frame";
$strings['frame_help'] = "Mostrar marco y botones debajo de H5P";
$strings['embed'] = "Insertar";
$strings['embed_help'] = "Mostrar botón de inserción";
$strings['copyright'] = "Derechos de autor";
$strings['copyright_help'] = "Mostrar botón de derechos de autor";
$strings['icon'] = "Icono";
$strings['icon_help'] = "Mostrar icono de H5P";
$strings['attempts'] = "Número de intentos";
$strings['import_h5p_package'] = "Subir paquete H5P";
$strings['upload_h5p'] = "Subir";
$strings['h5p_package'] = "Paquete H5P";
$strings['h5p_error_loading'] = "Error cargando el paquete H5P";
$strings['h5p_error_missing_core_asset'] = "Error cargando dependencias H5P";
$strings['h5p_error_invalid_token'] = "Token no valido";
$strings['h5p_save_content_state'] = "Guardar resultados del usuario";
$strings['h5p_save_content_freq'] = "Frecuencia guardado";
$strings['h5p_save_freq_help'] = "Con qué frecuencia se debe guardar el estado actual del contenido, en segundos";
$strings['start_attempt'] = "Comenzar intento";

@ -0,0 +1,5 @@
<?php
// For license terms, see /license.txt
$plugin_info = H5pImportPlugin::create()->get_info();

@ -0,0 +1,375 @@
<?php
// For licensing terms, see /license.txt
namespace Chamilo\PluginBundle\H5pImport\H5pImporter;
use Chamilo\PluginBundle\Entity\H5pImport\H5pImport;
use Chamilo\PluginBundle\Entity\H5pImport\H5pImportLibrary;
class H5pImplementation implements \H5PFrameworkInterface
{
private $h5pImport;
private $h5pImportLibraries;
public function __construct(H5pImport $h5pImport)
{
$this->h5pImport = $h5pImport;
$this->h5pImportLibraries = $h5pImport->getLibraries();
}
public function getPlatformInfo()
{
// TODO: Implement getPlatformInfo() method.
}
public function fetchExternalData($url, $data = null, $blocking = true, $stream = null)
{
// TODO: Implement fetchExternalData() method.
}
public function setLibraryTutorialUrl($machineName, $tutorialUrl)
{
// TODO: Implement setLibraryTutorialUrl() method.
}
public function setErrorMessage($message, $code = null)
{
// TODO: Implement setErrorMessage() method.
}
public function setInfoMessage($message)
{
// TODO: Implement setInfoMessage() method.
}
public function getMessages($type)
{
// TODO: Implement getMessages() method.
}
public function t($message, $replacements = [])
{
return get_lang($message);
}
public function getLibraryFileUrl($libraryFolderName, $fileName)
{
// TODO: Implement getLibraryFileUrl() method.
}
public function getUploadedH5pFolderPath()
{
// TODO: Implement getUploadedH5pFolderPath() method.
}
public function getUploadedH5pPath()
{
// TODO: Implement getUploadedH5pPath() method.
}
public function loadAddons()
{
$addons = [];
$sql = "
SELECT l1.machine_name, l1.major_version, l1.minor_version, l1.patch_version,
l1.iid, l1.preloaded_js, l1.preloaded_css
FROM plugin_h5p_import_library AS l1
LEFT JOIN plugin_h5p_import_library AS l2
ON l1.machine_name = l2.machine_name AND
(l1.major_version < l2.major_version OR
(l1.major_version = l2.major_version AND
l1.minor_version < l2.minor_version))
WHERE l2.machine_name IS null
";
$result = \Database::query($sql);
while ($row = \Database::fetch_array($result)) {
$addons[] = \H5PCore::snakeToCamel($row);
}
return $addons;
}
public function getLibraryConfig($libraries = null)
{
// TODO: Implement getLibraryConfig() method.
}
public function loadLibraries()
{
// TODO: Implement loadLibraries() method.
}
public function getAdminUrl()
{
// TODO: Implement getAdminUrl() method.
}
public function getLibraryId($machineName, $majorVersion = null, $minorVersion = null)
{
// TODO: Implement getLibraryId() method.
}
public function getWhitelist($isLibrary, $defaultContentWhitelist, $defaultLibraryWhitelist)
{
// TODO: Implement getWhitelist() method.
}
public function isPatchedLibrary($library)
{
// TODO: Implement isPatchedLibrary() method.
}
public function isInDevMode()
{
// TODO: Implement isInDevMode() method.
}
public function mayUpdateLibraries()
{
// TODO: Implement mayUpdateLibraries() method.
}
public function saveLibraryData(&$libraryData, $new = true)
{
// TODO: Implement saveLibraryData() method.
}
public function insertContent($content, $contentMainId = null)
{
// TODO: Implement insertContent() method.
}
public function updateContent($content, $contentMainId = null)
{
// TODO: Implement updateContent() method.
}
public function resetContentUserData($contentId)
{
// TODO: Implement resetContentUserData() method.
}
public function saveLibraryDependencies($libraryId, $dependencies, $dependency_type)
{
// TODO: Implement saveLibraryDependencies() method.
}
public function copyLibraryUsage($contentId, $copyFromId, $contentMainId = null)
{
// TODO: Implement copyLibraryUsage() method.
}
public function deleteContentData($contentId)
{
// TODO: Implement deleteContentData() method.
}
public function deleteLibraryUsage($contentId)
{
// TODO: Implement deleteLibraryUsage() method.
}
public function saveLibraryUsage($contentId, $librariesInUse)
{
// TODO: Implement saveLibraryUsage() method.
}
public function getLibraryUsage($libraryId, $skipContent = false)
{
// TODO: Implement getLibraryUsage() method.
}
public function loadLibrary($machineName, $majorVersion, $minorVersion)
{
if ($this->h5pImportLibraries) {
$foundLibrary = $this->h5pImportLibraries->filter(
function (H5pImportLibrary $library) use ($machineName, $majorVersion, $minorVersion) {
return $library->getLibraryByMachineNameAndVersions($machineName, $majorVersion, $minorVersion);
}
)->first();
if ($foundLibrary) {
return [
'libraryId' => $foundLibrary->getIid(),
'title' => $foundLibrary->getTitle(),
'machineName' => $foundLibrary->getMachineName(),
'majorVersion' => $foundLibrary->getMajorVersion(),
'minorVersion' => $foundLibrary->getMinorVersion(),
'patchVersion' => $foundLibrary->getPatchVersion(),
'runnable' => $foundLibrary->getRunnable(),
'preloadedJs' => $foundLibrary->getPreloadedJsFormatted(),
'preloadedCss' => $foundLibrary->getPreloadedCssFormatted(),
];
}
}
return false;
}
public function loadLibrarySemantics($machineName, $majorVersion, $minorVersion)
{
// TODO: Implement loadLibrarySemantics() method.
}
public function alterLibrarySemantics(&$semantics, $machineName, $majorVersion, $minorVersion)
{
// TODO: Implement alterLibrarySemantics() method.
}
public function deleteLibraryDependencies($libraryId)
{
// TODO: Implement deleteLibraryDependencies() method.
}
public function lockDependencyStorage()
{
// TODO: Implement lockDependencyStorage() method.
}
public function unlockDependencyStorage()
{
// TODO: Implement unlockDependencyStorage() method.
}
public function deleteLibrary($library)
{
// TODO: Implement deleteLibrary() method.
}
public function loadContent($id): array
{
$contentJson = H5pPackageTools::getJson($this->h5pImport->getPath().'/content.json');
$h5pJson = H5pPackageTools::getJson($this->h5pImport->getPath().'/h5p.json');
if ($contentJson && $h5pJson) {
$params = json_encode($contentJson);
$embedType = implode(',', $h5pJson->embedTypes);
$title = $this->h5pImport->getName();
$language = $h5pJson->language;
$libraryId = $this->h5pImport->getMainLibrary()->getIid();
$libraryName = $this->h5pImport->getMainLibrary()->getMachineName();
$libraryMajorVersion = $this->h5pImport->getMainLibrary()->getMajorVersion();
$libraryMinorVersion = $this->h5pImport->getMainLibrary()->getMinorVersion();
$libraryEmbedTypes = $this->h5pImport->getMainLibrary()->getEmbedTypesFormatted();
// Create the associative array with the loaded content information. Use the unique folder name as id.
return [
'contentId' => basename($this->h5pImport->getPath()),
'params' => $params,
'embedType' => $embedType,
'title' => $title,
'language' => $language,
'libraryId' => $libraryId,
'libraryName' => $libraryName,
'libraryMajorVersion' => $libraryMajorVersion,
'libraryMinorVersion' => $libraryMinorVersion,
'libraryEmbedTypes' => $libraryEmbedTypes,
'libraryFullscreen' => 0,
];
}
return [];
}
public function loadContentDependencies($id, $type = null): array
{
$h5pImportLibraries = $this->h5pImportLibraries;
$dependencies = [];
/** @var H5pImportLibrary|null $library */
foreach ($h5pImportLibraries as $library) {
$dependencies[] = [
'libraryId' => $library->getIid(),
'machineName' => $library->getMachineName(),
'majorVersion' => $library->getMajorVersion(),
'minorVersion' => $library->getMinorVersion(),
'patchVersion' => $library->getPatchVersion(),
'preloadedJs' => $library->getPreloadedJsFormatted(),
'preloadedCss' => $library->getPreloadedCssFormatted(),
];
}
return $dependencies;
}
public function getOption($name, $default = null)
{
return api_get_course_plugin_setting('h5pimport', $name);
}
public function setOption($name, $value)
{
// TODO: Implement setOption() method.
}
public function updateContentFields($id, $fields)
{
// TODO: Implement updateContentFields() method.
}
public function clearFilteredParameters($library_ids)
{
// TODO: Implement clearFilteredParameters() method.
}
public function getNumNotFiltered()
{
// TODO: Implement getNumNotFiltered() method.
}
public function getNumContent($libraryId, $skip = null)
{
// TODO: Implement getNumContent() method.
}
public function isContentSlugAvailable($slug)
{
return true;
}
public function getLibraryStats($type)
{
// TODO: Implement getLibraryStats() method.
}
public function getNumAuthors()
{
// TODO: Implement getNumAuthors() method.
}
public function saveCachedAssets($key, $libraries)
{
// TODO: Implement saveCachedAssets() method.
}
public function deleteCachedAssets($library_id)
{
// TODO: Implement deleteCachedAssets() method.
}
public function getLibraryContentCount()
{
// TODO: Implement getLibraryContentCount() method.
}
public function afterExportCreated($content, $filename)
{
// TODO: Implement afterExportCreated() method.
}
public function hasPermission($permission, $id = null)
{
// TODO: Implement hasPermission() method.
}
public function replaceContentTypeCache($contentTypeCache)
{
// TODO: Implement replaceContentTypeCache() method.
}
public function libraryHasUpgrade($library)
{
// TODO: Implement libraryHasUpgrade() method.
}
}

@ -0,0 +1,78 @@
<?php
// For licensing terms, see /license.txt
namespace Chamilo\PluginBundle\H5pImport\H5pImporter;
use Chamilo\CoreBundle\Entity\Course;
/**
* Class H5pPackageImporter.
*/
abstract class H5pPackageImporter
{
/**
* @var Course
*/
protected $course;
/**
* Path to course directory.
*
* @var string
*/
protected $courseDirectoryPath;
/**
* @var array
*/
protected $packageFileInfo;
/**
* The package type is usually a MIME type.
*
* @var string
*/
protected $packageType;
protected $h5pJsonContent;
/**
* H5pPackageImporter constructor.
*/
protected function __construct(array $fileInfo, Course $course)
{
$this->packageFileInfo = $fileInfo;
$this->course = $course;
$this->courseDirectoryPath = api_get_path(SYS_COURSE_PATH).$this->course->getDirectory();
$this->packageType = $fileInfo['type'];
}
/**
* @throws \Exception
*/
public static function create(array $fileInfo, Course $course): ZipPackageImporter
{
if (
'application/octet-stream' !== $fileInfo['type']
&& 'h5p' !== pathinfo($fileInfo['name'], PATHINFO_EXTENSION)
) {
throw new \Exception('Not a H5P package');
}
return new ZipPackageImporter($fileInfo, $course);
}
/**
* Check the package and unzip it, checking if it has the 'h5p.json' file or some php script.
*
* @return mixed
*
* @throws \Exception
*/
abstract public function import(): string;
public function getPackageType(): string
{
return $this->packageType;
}
}

@ -0,0 +1,327 @@
<?php
// For licensing terms, see /license.txt
namespace Chamilo\PluginBundle\H5pImport\H5pImporter;
use Chamilo\CoreBundle\Entity\Course;
use Chamilo\CoreBundle\Entity\Session;
use Chamilo\PluginBundle\Entity\H5pImport\H5pImport;
use Chamilo\PluginBundle\Entity\H5pImport\H5pImportLibrary;
use Database;
use H5PCore;
use Symfony\Component\Filesystem\Filesystem;
class H5pPackageTools
{
/**
* Help read JSON from the archive.
*
* @return mixed JSON content if valid or FALSE for invalid
*/
public static function getJson(string $file, bool $assoc = false)
{
$fs = new Filesystem();
$json = false;
if ($fs->exists($file)) {
$contents = file_get_contents($file);
// Decode the data
$json = json_decode($contents, $assoc);
if (null === $json) {
// JSON cannot be decoded or the recursion limit has been reached.
return false;
}
}
return $json;
}
/**
* Checks the integrity of an H5P package by verifying the existence of libraries
* and moves them to the "libraries" directory.
*
* @param object $h5pJson the H5P JSON object
* @param string $extractedDir the path to the extracted directory
*
* @return bool true if the package integrity is valid, false otherwise
*/
public static function checkPackageIntegrity(object $h5pJson, string $extractedDir): bool
{
$filesystem = new Filesystem();
$h5pDir = dirname($extractedDir, 2);
$sharedLibrariesDir = $h5pDir.'/libraries';
// Move 'content' directory one level back (H5P specification)
$filesystem->mirror($extractedDir.'/content', $extractedDir, null, ['override' => true]);
$filesystem->remove($extractedDir.'/content');
// Get the list of preloaded dependencies
$preloadedDependencies = $h5pJson->preloadedDependencies;
// Check the existence of each library in the extracted directory
foreach ($preloadedDependencies as $dependency) {
$libraryName = $dependency->machineName;
$majorVersion = $dependency->majorVersion;
$minorVersion = $dependency->minorVersion;
$libraryFolderName = api_replace_dangerous_char($libraryName.'-'.$majorVersion.'.'.$minorVersion);
$libraryPath = $extractedDir.'/'.$libraryFolderName;
// Check if the library folder exists
if (!$filesystem->exists($libraryPath)) {
return false;
}
// Move the entire folder to the "libraries" directory
$targetPath = $sharedLibrariesDir.'/'.$libraryFolderName;
$filesystem->rename($libraryPath, $targetPath, true);
}
return true;
}
/**
* Stores the H5P package information in the database.
*
* @param string $packagePath the path to the H5P package file
* @param object $h5pJson the parsed H5P JSON object
* @param Course $course the course entity related to the package
* @param null|Session $session the session entity related to the package
* @param null|array $values the advance options in upload form
*/
public static function storeH5pPackage(
string $packagePath,
object $h5pJson,
Course $course,
Session $session = null,
array $values = null
) {
$entityManager = \Database::getManager();
// Go back 2 directories
$h5pDir = dirname($packagePath, 2);
$sharedLibrariesDir = $h5pDir.'/libraries';
$mainLibraryName = $h5pJson->mainLibrary;
$relativePath = api_get_path(REL_COURSE_PATH).$course->getDirectory().'/h5p/';
$h5pImport = new H5pImport();
$h5pImport->setName($h5pJson->title);
$h5pImport->setPath($packagePath);
if ($values) {
$h5pImport->setDescription($values['description']);
}
$h5pImport->setRelativePath($relativePath);
$h5pImport->setCourse($course);
$h5pImport->setSession($session);
$entityManager->persist($h5pImport);
$libraries = $h5pJson->preloadedDependencies;
foreach ($libraries as $libraryData) {
$library = $entityManager
->getRepository(H5pImportLibrary::class)
->findOneBy(
[
'machineName' => $libraryData->machineName,
'majorVersion' => $libraryData->majorVersion,
'minorVersion' => $libraryData->minorVersion,
'course' => $course,
]
)
;
if (null === $library) {
$auxFullName = $libraryData->machineName.'-'.$libraryData->majorVersion.'.'.$libraryData->minorVersion;
$libraryOwnJson = self::getJson($sharedLibrariesDir.'/'.$auxFullName.'/library.json');
$library = new H5pImportLibrary();
$library->setMachineName($libraryData->machineName);
$library->setTitle($libraryOwnJson->title);
$library->setMajorVersion($libraryData->majorVersion);
$library->setMinorVersion($libraryData->minorVersion);
$library->setPatchVersion($libraryOwnJson->patchVersion);
$library->setRunnable($libraryOwnJson->runnable);
$library->setEmbedTypes($libraryOwnJson->embedTypes);
$library->setPreloadedJs($libraryOwnJson->preloadedJs);
$library->setPreloadedCss($libraryOwnJson->preloadedCss);
$library->setLibraryPath($sharedLibrariesDir.'/'.$auxFullName);
$library->setCourse($course);
$entityManager->persist($library);
$entityManager->flush();
}
$h5pImport->addLibraries($library);
if ($mainLibraryName === $libraryData->machineName) {
$h5pImport->setMainLibrary($library);
}
$entityManager->persist($h5pImport);
$entityManager->flush();
}
}
/**
* Deletes an H5P package from the database and the disk.
*
* @param H5pImport $h5pImport the H5P import entity representing the package to delete
*
* @return bool true if the package was successfully deleted, false otherwise
*/
public static function deleteH5pPackage(H5pImport $h5pImport): bool
{
$packagePath = $h5pImport->getPath();
$entityManager = \Database::getManager();
$entityManager->remove($h5pImport);
$entityManager->flush();
$filesystem = new Filesystem();
if ($filesystem->exists($packagePath)) {
try {
$filesystem->remove($packagePath);
} catch (\Exception $e) {
return false;
}
}
return true;
}
/**
* Get core settings for H5P content.
*
* @param H5pImport $h5pImport the H5pImport object
* @param \H5PCore $h5pCore the H5PCore object
*
* @return array the core settings for H5P content
*/
public static function getCoreSettings(H5pImport $h5pImport, \H5PCore $h5pCore): array
{
$originIsLearnpath = 'learnpath' === api_get_origin();
$settings = [
'baseUrl' => api_get_path(WEB_PATH),
'url' => $h5pImport->getRelativePath(),
'postUserStatistics' => true,
'ajax' => [
'setFinished' => api_get_path(WEB_PLUGIN_PATH).'h5pimport/src/ajax.php?action=set_finished&h5pId='.$h5pImport->getIid().'&learnpath='.$originIsLearnpath.'&token='.\H5PCore::createToken('result'),
'contentUserData' => api_get_path(WEB_PLUGIN_PATH).'h5pimport/src/ajax.php?action=content_user_data&h5pId='.$h5pImport->getIid().'&token='.\H5PCore::createToken('content'),
],
'saveFreq' => false,
'l10n' => [
'H5P' => $h5pCore->getLocalization(),
],
// 'hubIsEnabled' => variable_get('h5p_hub_is_enabled', TRUE) ? TRUE : FALSE,
'crossorigin' => false,
// 'crossoriginCacheBuster' => variable_get('h5p_crossorigin_cache_buster', NULL),
// 'libraryConfig' => $core->h5pF->getLibraryConfig(),
'pluginCacheBuster' => '?0',
'libraryUrl' => $h5pImport->getMainLibrary()->getLibraryPath().'/js',
];
$loggedUser = api_get_user_info();
if ($loggedUser) {
$settings['user'] = [
'name' => $loggedUser['complete_name'],
'mail' => $loggedUser['email'],
];
}
return $settings;
}
/**
* Get the core assets.
*
* @return array[]|bool an array containing CSS and JS assets or false if some core assets missing
*/
public static function getCoreAssets()
{
$assets = [
'css' => [],
'js' => [],
];
// Add CSS assets
foreach (\H5PCore::$styles as $style) {
$auxAssetPath = 'vendor/h5p/h5p-core/'.$style;
$assets['css'][] = api_get_path(WEB_PATH).$auxAssetPath;
if (!file_exists(api_get_path(SYS_PATH).$auxAssetPath)) {
return false;
}
}
// Add JS assets
foreach (\H5PCore::$scripts as $script) {
$auxAssetPath = 'vendor/h5p/h5p-core/'.$script;
$auxUrl = api_get_path(WEB_PATH).$auxAssetPath;
$assets['js'][] = $auxUrl;
if (!file_exists(api_get_path(SYS_PATH).$auxAssetPath)) {
return false;
}
}
return $assets;
}
/**
* Return the content body for the H5PIntegration javascript object.
*
* @param mixed $h5pNode
*/
public static function getContentSettings($h5pNode, \H5PCore $h5pCore): array
{
$filtered = $h5pCore->filterParameters($h5pNode);
$contentUserData = [
0 => [
'state' => '{}',
],
];
// ToDo Use $h5pCore->getDisplayOptionsForView() function
$displayOptions = [
'frame' => api_get_course_plugin_setting('h5pimport', 'frame'),
'embed' => api_get_course_plugin_setting('h5pimport', 'embed'),
'copyright' => api_get_course_plugin_setting('h5pimport', 'copyright'),
'icon' => api_get_course_plugin_setting('h5pimport', 'icon'),
];
return [
'library' => \H5PCore::libraryToString($h5pNode['library']),
'jsonContent' => $h5pNode['params'],
'fullScreen' => $h5pNode['library']['fullscreen'],
'exportUrl' => '',
'language' => 'en',
'filtered' => $filtered,
'embedCode' => '<iframe src="'.api_get_course_url().'h5p/embed/'.$h5pNode['mainId'].'" width=":w" height=":h" frameborder="0" allowfullscreen="allowfullscreen" allow="geolocation *; microphone *; camera *; midi *; encrypted-media *" title="'.$h5pNode['title'].'"></iframe>',
'resizeCode' => '',
'mainId' => $h5pNode['mainId'],
'url' => $h5pNode['url'],
'contentUserData' => $contentUserData,
'displayOptions' => $displayOptions,
'metadata' => $h5pNode['metadata'],
];
}
/**
* Convert H5P dependencies to a library list.
*
* @param array $dependencies the H5P dependencies
*
* @return array the library list with machine names as keys and version information as values
*/
public static function h5pDependenciesToLibraryList(array $dependencies): array
{
$libraryList = [];
foreach ($dependencies as $dependency) {
$libraryList[$dependency['machineName']] = [
'majorVersion' => $dependency['majorVersion'],
'minorVersion' => $dependency['minorVersion'],
];
}
return $libraryList;
}
}

@ -0,0 +1,183 @@
<?php
// For licensing terms, see /license.txt
namespace Chamilo\PluginBundle\H5pImport\H5pImporter;
use Exception;
use Symfony\Component\Filesystem\Filesystem;
/**
* Class ZipPackageImporter.
*/
class ZipPackageImporter extends H5pPackageImporter
{
/*
* Allowed file extensions
* List obtained from H5P: https://h5p.org/allowed-file-extensions
* */
private const ALLOWED_EXTENSIONS = [
'json',
'png',
'jpg',
'jpeg',
'gif',
'bmp',
'tif',
'tiff',
'svg',
'eot',
'ttf',
'woff',
'woff2',
'otf',
'webm',
'mp4',
'ogg',
'mp3',
'm4a',
'wav',
'txt',
'pdf',
'rtf',
'doc',
'docx',
'xls',
'xlsx',
'ppt',
'pptx',
'odt',
'ods',
'odp',
'xml',
'csv',
'diff',
'patch',
'swf',
'md',
'textile',
'vtt',
'webvtt',
'gltf',
'gl',
'js',
'css',
];
/**
* Import an H5P package. No DB change.
*
* @return string The path to the extracted package directory.
*
* @throws Exception When the H5P package is invalid.
*/
public function import(): string
{
$zipFile = new \PclZip($this->packageFileInfo['tmp_name']);
$zipContent = $zipFile->listContent();
if ($this->validateH5pPackageContent($zipContent)) {
$packageSize = array_reduce(
$zipContent,
function ($accumulator, $zipEntry) {
return $accumulator + $zipEntry['size'];
}
);
$this->validateEnoughSpace($packageSize);
$pathInfo = pathinfo($this->packageFileInfo['name']);
$packageDirectoryPath = $this->generatePackageDirectory($pathInfo['filename']);
$zipFile->extract($packageDirectoryPath);
return "{$packageDirectoryPath}";
}
throw new Exception('Invalid H5P package');
}
/**
* @throws Exception
*/
protected function validateEnoughSpace(int $packageSize)
{
$courseSpaceQuota = \DocumentManager::get_course_quota($this->course->getCode());
if (!enough_size($packageSize, $this->courseDirectoryPath, $courseSpaceQuota)) {
throw new Exception('Not enough space to store package.');
}
}
/**
* Validate an H5P package.
* Check if 'h5p.json' or 'content/content.json' files exist
* and if the files are in a file whitelist (ALLOWED_EXTENSIONS).
*
* @param array $h5pPackageContent the content of the H5P package
*
* @return bool whether the H5P package is valid or not
*/
private function validateH5pPackageContent(array $h5pPackageContent): bool
{
$validPackage = false;
if (!empty($h5pPackageContent)) {
foreach ($h5pPackageContent as $content) {
$filename = $content['filename'];
if (0 !== preg_match('/(^[\._]|\/[\._]|\\\[\._])/', $filename)) {
// Skip any file or folder starting with a . or _
continue;
}
$fileExtension = pathinfo($filename, PATHINFO_EXTENSION);
if (in_array($fileExtension, self::ALLOWED_EXTENSIONS)) {
$validPackage = 'h5p.json' === $filename || 'content/content.json' === $filename;
if ($validPackage) {
break;
}
}
}
}
return $validPackage;
}
private function generatePackageDirectory(string $name): string
{
$baseDirectory = $this->courseDirectoryPath.'/h5p/content/';
$safeName = api_replace_dangerous_char($name);
$directoryPath = $baseDirectory.$safeName;
$fs = new Filesystem();
if ($fs->exists($directoryPath)) {
$counter = 1;
// Add numeric suffix to the name until a unique directory name is found
while ($fs->exists($directoryPath)) {
$modifiedName = $safeName.'_'.$counter;
$directoryPath = $baseDirectory.$modifiedName;
++$counter;
}
}
$fs->mkdir(
$directoryPath,
api_get_permissions_for_new_directories()
);
$sharedLibrariesDir = $this->courseDirectoryPath.'/h5p/libraries';
if (!$fs->exists($sharedLibrariesDir)) {
$fs->mkdir(
$sharedLibrariesDir,
api_get_permissions_for_new_directories()
);
}
return $directoryPath;
}
}

@ -0,0 +1,90 @@
<?php
// For licensing terms, see /license.txt
use Chamilo\CourseBundle\Entity\CLpItem;
use Chamilo\CourseBundle\Entity\CLpItemView;
use Chamilo\PluginBundle\Entity\H5pImport\H5pImport;
use Chamilo\PluginBundle\Entity\H5pImport\H5pImportResults;
use ChamiloSession as Session;
require_once __DIR__.'/../../../main/inc/global.inc.php';
$action = $_REQUEST['action'] ?? null;
$h5pId = isset($_REQUEST['h5pId']) ? intval($_REQUEST['h5pId']) : 0;
$course = api_get_course_entity(api_get_course_int_id());
$session = api_get_session_entity(api_get_session_id());
$plugin = H5pImportPlugin::create();
$em = Database::getManager();
$h5pImportRepo = $em->getRepository('ChamiloPluginBundle:H5pImport\H5pImport');
$user = api_get_user_entity(api_get_user_id());
if ('set_finished' === $action && 0 !== $h5pId) {
if (!H5PCore::validToken('result', filter_input(INPUT_GET, 'token'))) {
H5PCore::ajaxError($plugin->get_lang('h5p_error_invalid_token'));
}
if (is_numeric($_POST['score']) && is_numeric($_POST['maxScore'])) {
/** @var null|H5pImport $h5pImport */
$h5pImport = $h5pImportRepo->find($h5pId);
$entityManager = Database::getManager();
$h5pImportResults = new H5pImportResults();
$h5pImportResults->setH5pImport($h5pImport);
$h5pImportResults->setCourse($course);
$h5pImportResults->setSession($session);
$h5pImportResults->setUser($user);
$h5pImportResults->setScore((int) $_POST['score']);
$h5pImportResults->setMaxScore((int) $_POST['maxScore']);
$h5pImportResults->setStartTime((int) $_POST['opened']);
$h5pImportResults->setTotalTime(time() - $_POST['opened']);
$entityManager->persist($h5pImportResults);
// If it comes from an LP, update in c_lp_item_view
if (1 == $_REQUEST['learnpath'] && Session::has('oLP')) {
$lpObject = Session::read('oLP');
$clpItemViewRepo = $em->getRepository('ChamiloCourseBundle:CLpItemView');
/** @var null|CLpItemView $lpItemView */
$lpItemView = $clpItemViewRepo->findOneBy(
[
'lpViewId' => $lpObject->lp_view_id,
'lpItemId' => $lpObject->current,
]
);
/** @var null|CLpItem $lpItem */
$lpItem = $entityManager->find('ChamiloCourseBundle:CLpItem', $lpItemView->getLpItemId());
if ('h5p' !== $lpItem->getItemType()) {
return null;
}
$lpItemView->setScore($_POST['score']);
$lpItemView->setMaxScore($_POST['maxScore']);
$lpItemView->setStatus('completed');
$lpItemView->setTotalTime($lpItemView->getTotalTime() + $h5pImportResults->getTotalTime());
$lpItem->setMaxScore($_POST['maxScore']);
$h5pImportResults->setCLpItemView($lpItemView);
$entityManager->persist($h5pImportResults);
$entityManager->persist($lpItem);
$entityManager->persist($lpItemView);
}
$entityManager->flush();
H5PCore::ajaxSuccess();
} else {
H5PCore::ajaxError();
}
} elseif ('content_user_data' === $action && 0 !== $h5pId) {
if (!H5PCore::validToken('content', filter_input(INPUT_GET, 'token'))) {
H5PCore::ajaxError($plugin->get_lang('h5p_error_invalid_token'));
}
/** @var null|H5pImport $h5pImport */
$h5pImport = $h5pImportRepo->find($h5pId);
} else {
H5PCore::ajaxError(get_lang('InvalidAction'));
}

@ -0,0 +1,240 @@
<?php
/* For licensing terms, see /license.txt */
use Chamilo\PluginBundle\Entity\H5pImport\H5pImport;
use Chamilo\PluginBundle\H5pImport\H5pImporter\H5pPackageImporter;
use Chamilo\PluginBundle\H5pImport\H5pImporter\H5pPackageTools;
require_once __DIR__.'/../../main/inc/global.inc.php';
api_block_anonymous_users();
api_protect_course_script(true);
$cidReq = api_get_cidreq();
$pluginIndex = "./start.php?$cidReq";
$plugin = H5pImportPlugin::create();
if ('false' === $plugin->get('tool_enable')) {
api_not_allowed(true);
}
$isAllowedToEdit = api_is_allowed_to_edit(true);
$action = $_REQUEST['action'] ?? null;
$em = Database::getManager();
$h5pRepo = $em->getRepository('ChamiloPluginBundle:H5pImport\H5pImport');
$h5pResultsRepo = $em->getRepository('ChamiloPluginBundle:H5pImport\H5pImportResults');
$course = api_get_course_entity(api_get_course_int_id());
$session = api_get_session_entity(api_get_session_id());
$user = api_get_user_entity(api_get_user_id());
$actions = [];
$view = new Template($plugin->getToolTitle());
$view->assign('is_allowed_to_edit', $isAllowedToEdit);
switch ($action) {
case 'add':
if (!$isAllowedToEdit) {
api_not_allowed(true);
}
$actions[] = Display::url(
Display::return_icon('back.png', get_lang('Back'), [], ICON_SIZE_MEDIUM),
api_get_self()
);
// Set the max upload size in php.ini in the file uploader
$maxFileSize = getIniMaxFileSizeInBytes();
$form = new FormValidator('frm_edit');
$form->addFile('file', $plugin->get_lang('h5p_package'), ['accept' => '.h5p']);
$form->addRule(
'file',
'The file size cannot exceed: '.$maxFileSize.' bytes',
'maxfilesize',
$maxFileSize,
'client'
);
$form->addButtonAdvancedSettings('advanced_params');
$form->addHtml('<div id="advanced_params_options" style="display:none">');
$form->addTextarea('description', get_lang('Description'));
$form->applyFilter('description', 'trim');
$form->addHtml('</div>');
$form->addButtonUpdate(get_lang('Add'));
$form->addHidden('action', 'add');
$form->protect();
if ($form->validate()) {
$values = $form->exportValues();
$zipFileInfo = $_FILES['file'];
try {
$importer = H5pPackageImporter::create($zipFileInfo, $course);
$packageFile = $importer->import();
// Get the h5p.json and content.json contents
$h5pJson = H5pPackageTools::getJson($packageFile.DIRECTORY_SEPARATOR.'h5p.json');
$contentJson = H5pPackageTools::getJson(
$packageFile.DIRECTORY_SEPARATOR.'content'.DIRECTORY_SEPARATOR.'content.json'
);
if ($h5pJson && $contentJson) {
if (H5pPackageTools::checkPackageIntegrity($h5pJson, $packageFile)) {
H5pPackageTools::storeH5pPackage($packageFile, $h5pJson, $course, $session, $values);
Display::addFlash(
Display::return_message(get_lang('Added'), 'success')
);
} else {
Display::addFlash(
Display::return_message(get_lang('Error'), 'error')
);
break;
}
header('Location: '.api_get_self());
}
exit;
} catch (Exception $e) {
Display::addFlash(
Display::return_message($e->getMessage(), 'error')
);
header("Location: $pluginIndex");
exit;
}
}
$view->assign('header', $plugin->get_lang('import_h5p_package'));
$view->assign('form', $form->returnForm());
break;
case 'delete':
$h5pImportId = isset($_REQUEST['id']) ? (int) $_REQUEST['id'] : 0;
if (!$h5pImportId && !Security::check_token('get')) {
break;
}
/** @var H5pImport|null $h5pImport */
$h5pImport = $h5pRepo->find($h5pImportId);
if (!$h5pImport) {
Display::addFlash(Display::return_message($plugin->get_lang('ContentNotFound'), 'danger'));
break;
}
if (H5pPackageTools::deleteH5pPackage($h5pImport)) {
Display::addFlash(
Display::return_message(get_lang('Deleted'), 'success')
);
} else {
Display::addFlash(
Display::return_message(get_lang('Error'), 'danger')
);
}
header('Location: '.api_get_self());
exit;
default:
/** @var array|H5pImport[] $h5pImports */
$h5pImports = $h5pRepo->findBy(['course' => $course, 'session' => $session]);
$tableData = [];
/** @var H5pImport $h5pImport */
foreach ($h5pImports as $h5pImport) {
$h5pImportsResults = $h5pResultsRepo->count(
[
'course' => $course,
'session' => $session,
'user' => $user,
'h5pImport' => $h5pImport,
]
);
$data = [
Display::url(
$h5pImport->getName(),
$plugin->getViewUrl($h5pImport)
),
$h5pImport->getDescription(),
$h5pImportsResults,
];
if ($isAllowedToEdit) {
$data[] = $h5pImport;
}
$tableData[] = $data;
}
if ($isAllowedToEdit) {
$btnAdd = Display::toolbarButton(
get_lang('Upload'),
api_get_self().'?action=add',
'file-code-o',
'primary'
);
$view->assign(
'actions',
Display::toolbarAction($plugin->get_name(), [$btnAdd])
);
if (in_array($action, ['add', 'edit'])) {
$view->assign('form', $form->returnForm());
}
}
$table = new SortableTableFromArray($tableData, 0);
$table->set_header(0, get_lang('Title'));
$table->set_header(1, get_lang('Description'));
$table->set_header(2, $plugin->get_lang('attempts'));
if ($isAllowedToEdit) {
$table->set_header(
3,
get_lang('Actions'),
false,
'th-header text-right',
['class' => 'text-right']
);
$table->set_column_filter(
3,
function (H5pImport $value) use ($isAllowedToEdit) {
$actions = [];
if ($isAllowedToEdit) {
$actions[] = Display::url(
Display::return_icon('delete.png', get_lang('Delete')),
api_get_self().'?'.http_build_query([
'action' => 'delete',
'id' => $value->getIid(),
'sec_token' => Security::getTokenFromSession(),
])
);
}
return implode(PHP_EOL, $actions);
}
);
}
$view->assign('h5pImports', $h5pImports);
$view->assign('table', $table->return_table());
}
$content = $view->fetch('h5pimport/view/index.tpl');
if ($actions) {
$actions = implode(PHP_EOL, $actions);
$view->assign(
'actions',
Display::toolbarAction($plugin->get_name(), [$actions])
);
}
$view->assign('content', $content);
$view->display_one_col_template();

Some files were not shown because too many files have changed in this diff Show More

Loading…
Cancel
Save